define.h

Go to the documentation of this file.

#ifndef DEFINE_H
#define DEFINE_H

#ifndef WIN32 /* ---win32 exclude unix configuration part */
#include <autoconf.h>
#endif

#define FABS(x) ((x) < 0 ? -(x) : (x))

#ifdef __NetBSD__
#include <sys/param.h>
#endif

#ifndef NAME_MAX
#define NAME_MAX 255
#endif

#define MIN_STAT                1       
#define MAX_BUF                 256     
#define VERY_BIG_BUF            1024
#define HUGE_BUF                4096    
#define MAX_ANIMATIONS          256

#define MAX_NAME 48
#define BIG_NAME 32

enum fatal_error {
    OUT_OF_MEMORY = 0,
    MAP_ERROR = 1,
    ARCHTABLE_TOO_SMALL = 2,
    ARCHETYPE_ISSUE = 3,
    SEE_LAST_ERROR = 4,
};

#define ST_BD_BUILD      1 
#define ST_BD_REMOVE     2 


#define ST_MAT_FLOOR    1 
#define ST_MAT_WALL     2 
#define ST_MAT_ITEM     3 
#define ST_MAT_WINDOW   4 


#define WEAP_HIT        0  
#define WEAP_SLASH      1  
#define WEAP_PIERCE     2  
#define WEAP_CLEAVE     3  
#define WEAP_SLICE      4  
#define WEAP_STAB       5  
#define WEAP_WHIP       6  
#define WEAP_CRUSH      7  
#define WEAP_BLUD       8  


typedef struct typedata {
    int number;         
    const char *name;   
    const char *name_pl;
    int identifyskill;  
    int identifyskill2; 
} typedata;


/* high bit as flag for new pickup options */
#define PU_NOTHING              0x00000000

#define PU_DEBUG                0x10000000
#define PU_INHIBIT              0x20000000
#define PU_STOP                 0x40000000
#define PU_NEWMODE              0x80000000

#define PU_RATIO                0x0000000F

#define PU_FOOD                 0x00000010
#define PU_DRINK                0x00000020
#define PU_VALUABLES            0x00000040
#define PU_BOW                  0x00000080

#define PU_ARROW                0x00000100
#define PU_HELMET               0x00000200
#define PU_SHIELD               0x00000400
#define PU_ARMOUR               0x00000800

#define PU_BOOTS                0x00001000
#define PU_GLOVES               0x00002000
#define PU_CLOAK                0x00004000
#define PU_KEY                  0x00008000

#define PU_MISSILEWEAPON        0x00010000
#define PU_MELEEWEAPON          0x00020000
#define PU_MAGICAL              0x00040000
#define PU_POTION               0x00080000

#define PU_SPELLBOOK            0x00100000
#define PU_SKILLSCROLL          0x00200000
#define PU_READABLES            0x00400000
#define PU_MAGIC_DEVICE         0x00800000

#define PU_NOT_CURSED           0x01000000
#define PU_JEWELS               0x02000000
#define PU_FLESH                0x04000000
#define PU_CONTAINER            0x08000000

/* Instead of using arbitrary constants for indexing the
 * freearr, add these values.  <= SIZEOFFREE1 will get you
 * within 1 space.  <= SIZEOFFREE2 wll get you withing
 * 2 spaces, and the entire array (< SIZEOFFREE) is
 * three spaces
 */
#define SIZEOFFREE1 8
#define SIZEOFFREE2 24
#define SIZEOFFREE 49

#define NROF_SOUNDS (23+NROFREALSPELLS) /* Number of sounds */

#define IS_WEAPON(op) \
        (op->type == ARROW || op->type == BOW || op->type == WEAPON)

#define IS_ARMOR(op) \
        (op->type == ARMOUR || op->type == HELMET || \
         op->type == BOOTS || op->type == GLOVES)

#define IS_SHIELD(op) \
        (op->type == SHIELD)

#define IS_LIVE(op) \
        ((op->type == PLAYER || QUERY_FLAG(op, FLAG_MONSTER) || \
        (QUERY_FLAG(op, FLAG_ALIVE) && !QUERY_FLAG(op, FLAG_GENERATOR) && \
        !(op->type == DOOR))) && (!QUERY_FLAG(op, FLAG_IS_A_TEMPLATE)))

#define IS_ARROW(op) \
        (op->type == ARROW || \
        (op->type == SPELL_EFFECT && (op->subtype == SP_BULLET || op->subtype == SP_MAGIC_MISSILE)))

#define HAS_RANDOM_ITEMS(op) (op->randomitems && (!QUERY_FLAG(op, FLAG_IS_A_TEMPLATE)))

#define SET_FLAG(xyz, p) set_flag(xyz, p)
#define CLEAR_FLAG(xyz, p) clear_flag(xyz, p)
#define QUERY_FLAG(xyz, p) query_flag(xyz, p)
#define COMPARE_FLAGS(p, q) compare_flags(p, q)

/* the flags themselves. */

#define FLAG_ALIVE              0  
#define FLAG_WIZ                1  
#define FLAG_REMOVED            2  
#define FLAG_FREED              3  
#define FLAG_WAS_WIZ            4  
#define FLAG_APPLIED            5  
#define FLAG_UNPAID             6  
#define FLAG_USE_SHIELD         7  
#define FLAG_NO_PICK            8  
#define FLAG_CLIENT_ANIM_SYNC   9  
#define FLAG_CLIENT_ANIM_RANDOM 10 
#define FLAG_ANIMATE            11 
#define FLAG_DIALOG_PARSED      12 
#define FLAG_NO_SAVE            13 
#define FLAG_MONSTER            14 
#define FLAG_FRIENDLY           15 
#define FLAG_GENERATOR          16 
#define FLAG_IS_THROWN          17 
#define FLAG_AUTO_APPLY         18 
#define FLAG_TREASURE           19 
#define FLAG_PLAYER_SOLD        20 
#define FLAG_SEE_INVISIBLE      21 
#define FLAG_CAN_ROLL           22 
#define FLAG_OVERLAY_FLOOR      23 
#define FLAG_IS_TURNABLE        24 
#define FLAG_PROBE              25 
/*#define FLAG_FLY_ON           26*//* As WALK_ON, but only with FLAG_FLYING */
/*#define FLAG_FLY_OFF          27*//* As WALK_OFF, but only with FLAG_FLYING */
#define FLAG_IS_USED_UP         28 
#define FLAG_IDENTIFIED         29 
#define FLAG_REFLECTING         30 
#define FLAG_CHANGING           31 
/* Start of values in flags[1] */
#define FLAG_SPLITTING          32 
#define FLAG_HITBACK            33 
#define FLAG_STARTEQUIP         34 
#define FLAG_BLOCKSVIEW         35 
#define FLAG_UNDEAD             36 
#define FLAG_SCARED             37 
#define FLAG_UNAGGRESSIVE       38 
#define FLAG_REFL_MISSILE       39 
#define FLAG_REFL_SPELL         40 
#define FLAG_NO_MAGIC           41 
#define FLAG_NO_FIX_PLAYER      42 
#define FLAG_IS_LIGHTABLE       43 
#define FLAG_TEAR_DOWN          44 
#define FLAG_RUN_AWAY           45 
/*#define FLAG_PASS_THRU        46*/ /* Objects with can_pass_thru can pass \
                                      thru this object as if it wasn't there */
/*#define FLAG_CAN_PASS_THRU    47*/ /* Can pass thru... */

/*#define FLAG_PICK_UP          48*/ /* Can pick up */
#define FLAG_UNIQUE             49 
#define FLAG_NO_DROP            50 
#define FLAG_WIZCAST            51 
#define FLAG_CAST_SPELL         52 
#define FLAG_USE_SCROLL         53 
#define FLAG_USE_RANGE          54 
#define FLAG_USE_BOW            55 
#define FLAG_USE_ARMOUR         56 
#define FLAG_USE_WEAPON         57 
#define FLAG_USE_RING           58 
#define FLAG_READY_RANGE        59 
#define FLAG_READY_BOW          60 
#define FLAG_XRAYS              61 
#define FLAG_NO_APPLY           62 
#define FLAG_IS_FLOOR           63 
/* Start of values in flags[2] */
#define FLAG_LIFESAVE           64 
#define FLAG_NO_STRENGTH        65 
#define FLAG_SLEEP              66 
#define FLAG_STAND_STILL        67 
#define FLAG_RANDOM_MOVE        68 
#define FLAG_ONLY_ATTACK        69 
#define FLAG_CONFUSED           70 
#define FLAG_STEALTH            71 
#define FLAG_WIZPASS            72 
#define FLAG_IS_LINKED          73 
#define FLAG_CURSED             74 
#define FLAG_DAMNED             75 
#define FLAG_SEE_ANYWHERE       76 
#define FLAG_KNOWN_MAGICAL      77 
#define FLAG_KNOWN_CURSED       78 
#define FLAG_CAN_USE_SKILL      79 
#define FLAG_BEEN_APPLIED       80 
#define FLAG_READY_SCROLL       81 
/*#define FLAG_USE_ROD          82 unused (Monster) can apply and use rods */
/*#define FLAG_READY_HORN       83 unused (Monster) has a horn readied */
/*#define FLAG_USE_HORN         84 unused (Monster) can apply and use horns */
#define FLAG_MAKE_INVIS         85 
#define FLAG_INV_LOCKED         86 
#define FLAG_IS_WOODED          87 
#define FLAG_IS_HILLY           88 
#define FLAG_READY_SKILL        89 
#define FLAG_READY_WEAPON       90 
#define FLAG_NO_SKILL_IDENT     91 
#define FLAG_BLIND              92 
#define FLAG_SEE_IN_DARK        93 
#define FLAG_IS_CAULDRON        94 
/*#define FLAG_DUST             95 *//* item is a 'powder', effects throwing */

/* Start of values in flags[3] */
#define FLAG_NO_STEAL           96 
#define FLAG_ONE_HIT            97 
#define FLAG_CLIENT_SENT        98 
#define FLAG_BERSERK            99  
#define FLAG_NEUTRAL            100 
#define FLAG_NO_ATTACK          101 
#define FLAG_NO_DAMAGE          102 
#define FLAG_OBJ_ORIGINAL       103 
/*#define FLAG_OBJ_SAVE_ON_OVL    104 *//* this object should be saved on
                                     * the overlay, and is not subject to
                                     * decay. */
#define FLAG_ACTIVATE_ON_PUSH    105 
#define FLAG_ACTIVATE_ON_RELEASE 106 
#define FLAG_IS_WATER            107
#define FLAG_CONTENT_ON_GEN      108
#define FLAG_IS_A_TEMPLATE       109 
#define FLAG_IS_BUILDABLE        110 
#define FLAG_AFK                 111 
#define FLAG_BLESSED             112 
#define FLAG_KNOWN_BLESSED       113 
#define FLAG_PARALYZED           114 
#define NUM_FLAGS                114 


#define MOVE_WALK       0x1     
#define MOVE_FLY_LOW    0x2     
#define MOVE_FLY_HIGH   0x4     
#define MOVE_FLYING     0x6     
#define MOVE_SWIM       0x8     
#define MOVE_BOAT       0x10    
#define MOVE_ALL        0x1f    
#define MOVE_BLOCK_DEFAULT MOVE_SWIM

typedef unsigned char MoveType;

#define OB_MOVE_BLOCK(ob1, ob2) \
    ((ob1->move_type&ob2->move_block) == ob1->move_type)

#define OB_TYPE_MOVE_BLOCK(ob1, type) \
    ((type != 0) && (ob1->move_type&type) == ob1->move_type)

#define GENERATE_TYPE(xyz)      ((xyz)->stats.sp)
#define GENERATE_SPEED(xyz)     ((xyz)->stats.maxsp) /* if(!RANDOM()%<speed>) */

#define EXIT_PATH(xyz)          (xyz)->slaying
#define EXIT_LEVEL(xyz)         (xyz)->stats.food
#define EXIT_X(xyz)             (xyz)->stats.hp
#define EXIT_Y(xyz)             (xyz)->stats.sp
#define EXIT_ALT_X(xyz)         (xyz)->stats.maxhp
#define EXIT_ALT_Y(xyz)         (xyz)->stats.maxsp

#define MAX_LIGHT_RADII         4

#define MAX_DARKNESS            5

#define MAX_WEAPON_ITEM_POWER   100

static const int32_t MAX_FOOD = 999;

#define DIRX(xyz)       freearr_x[(xyz)->direction]
#define DIRY(xyz)       freearr_y[(xyz)->direction]

#define ARMOUR_SPEED(xyz)       (xyz)->last_sp
#define ARMOUR_SPELLS(xyz)      (xyz)->gen_sp_armour
#define WEAPON_SPEED(xyz)       (xyz)->last_sp

/*
 * The following definitions are for the attack_movement variable in monsters.
 * If the attack_variable movement is left out of the monster archetype, or is
 * set to zero, the standard mode of movement from previous versions of
 * Crossfire will be used. The upper four bits of movement data are not in
 * effect when the monster has an enemy. These should only be used for non
 * agressive monsters. To program a monsters movement add the attack movement
 * numbers to the movement numbers example a monster that moves in a circle
 * until attacked and then attacks from a distance:
 *                                                      CIRCLE1 = 32
 *                                              +       DISTATT = 1
 *                                      -------------------
 *                      attack_movement = 33
 */
#define DISTATT  1 
#define RUNATT   2 
#define HITRUN   3 
#define WAITATT  4 
#define RUSH     5 
#define ALLRUN   6 
#define DISTHIT  7 
#define WAIT2    8 
#define PETMOVE 16 
#define CIRCLE1 32 
#define CIRCLE2 48 
#define PACEH   64 
#define PACEH2  80 
#define RANDO   96 
#define RANDO2 112 
#define PACEV  128 
#define PACEV2 144 
#define LO4     15 
#define HI4    240

#define ST_PLAYING                  0   
#define ST_PLAY_AGAIN               1   
#define ST_ROLL_STAT                2   
#define ST_CHANGE_CLASS             3   
#define ST_CONFIRM_QUIT             4   
#define ST_GET_NAME                 6   
#define ST_GET_PASSWORD             7   
#define ST_CONFIRM_PASSWORD         8   
#define ST_GET_PARTY_PASSWORD       10  
#define ST_CHANGE_PASSWORD_OLD      11  
#define ST_CHANGE_PASSWORD_NEW      12  
#define ST_CHANGE_PASSWORD_CONFIRM  13  

#define BLANK_FACE_NAME "blank.111"
#define EMPTY_FACE_NAME "empty.111"
#define SMOOTH_FACE_NAME "default_smoothed.111"

/*
 * Defines for the luck/random functions to make things more readable
 */

#define PREFER_HIGH     1
#define PREFER_LOW      0

/* Basic flags, always use one of these */
#define AP_NULL         0   
#define AP_APPLY        1   
#define AP_UNAPPLY      2   
#define AP_OPEN         3   
#define AP_BASIC_FLAGS  15

/* Optional flags, for bitwise or with a basic flag */
#define AP_NO_MERGE     16  
#define AP_IGNORE_CURSE 32  
#define AP_PRINT        64  
#define AP_NOPRINT      128 


#define AC_PLAYER_STAT_LIMIT        1   
#define AC_PLAYER_STAT_NO_CHANGE    2   
#define CAN_APPLY_NEVER             0x1
#define CAN_APPLY_RESTRICTION       0x2
#define CAN_APPLY_NOT_MASK          0xf
#define CAN_APPLY_UNAPPLY           0x10
#define CAN_APPLY_UNAPPLY_MULT      0x20
#define CAN_APPLY_UNAPPLY_CHOICE    0x40

#define MIN_ACTIVE_SPEED        0.00001

uint32_t cf_random(void);
void cf_srandom(unsigned long seed);

#define RANDOM()        cf_random()
#define SRANDOM(seed)   cf_srandom(seed)

#define WEIGHT(op) (op->nrof ? op->weight : op->weight+op->carrying)

#define FOR_INV_PREPARE(op_, it_)                               \
    do {                                                        \
        object *it_ = (op_)->inv;                               \
        FOR_OB_AND_BELOW_PREPARE(it_);

#define FOR_INV_FINISH()                                        \
        FOR_OB_AND_BELOW_FINISH();                              \
    } while(0)

#define FOR_ABOVE_PREPARE(op_, it_)                             \
    do {                                                        \
        object *it_ = (op_)->above;                             \
        FOR_OB_AND_ABOVE_PREPARE(it_);

#define FOR_ABOVE_FINISH()                                      \
        FOR_OB_AND_ABOVE_FINISH();                              \
    } while(0)

#define FOR_BELOW_PREPARE(op_, it_)                             \
    do {                                                        \
        object *it_ = (op_)->below;                             \
        FOR_OB_AND_BELOW_PREPARE(it_);

#define FOR_BELOW_FINISH()                                      \
        FOR_OB_AND_BELOW_FINISH();                              \
    } while(0)

#define FOR_MAP_PREPARE(map_, mx_, my_, it_)                    \
    do {                                                        \
        object *it_ = GET_MAP_OB((map_), (mx_), (my_));         \
        FOR_OB_AND_ABOVE_PREPARE(it_);

#define FOR_MAP_FINISH()                                        \
        FOR_OB_AND_ABOVE_FINISH();                              \
    } while(0)

#define FOR_OB_AND_ABOVE_PREPARE(op_) FOR_OB_PREPARE(op_, above, __LINE__)

#define FOR_OB_AND_ABOVE_FINISH() FOR_OB_FINISH()

#define FOR_OB_AND_BELOW_PREPARE(op_) FOR_OB_PREPARE(op_, below, __LINE__)

#define FOR_OB_AND_BELOW_FINISH() FOR_OB_FINISH()

#define FOR_OB_PREPARE(op_, field_, suffix_) FOR_OB_PREPARE2(op_, field_, suffix_)

#define FOR_OB_PREPARE2(op_, field_, suffix_)                     \
    do {                                                        \
        object *next##suffix_ = (op_);                        \
        tag_t next_tag##suffix_ = next##suffix_ == NULL ? 0 : next##suffix_->count;\
        while (((op_) = next##suffix_) != NULL) {              \
            if (object_was_destroyed(next##suffix_, next_tag##suffix_)) {\
                break;                                          \
            }                                                   \
            next##suffix_ = next##suffix_->field_;                               \
            next_tag##suffix_ = next##suffix_ == NULL ? 0 : next##suffix_->count;

#define FOR_OB_FINISH()                                         \
        }                                                       \
    } while(0)

#endif /* DEFINE_H */