src/h-type.h

   1 /*!
   2  * @file h-type.h
   3  * @brief ゲーム中に用いる変数型定義 / Basic "types".
   4  * @date 2017/12/03
   5  * @author
   6  * 不明(変愚蛮怒スタッフ？)
   7  * @details
   8  * <pre>
   9  * Note the attempt to make all basic types have 4 letters.
  10  * This improves readibility and standardizes the code.
  11  * Likewise, all complex types are at least 4 letters.
  12  * Thus, almost every three letter word is a legal variable.
  13  * But beware of certain reserved words ('for' and 'if' and 'do').
  14  * Note that the type used in structures for bit flags should be uint.
  15  * As long as these bit flags are sequential, they will be space smart.
  16  * Note that on some machines, apparently "signed char" is illegal.
  17  * It must be true that char/byte takes exactly 1 byte
  18  * It must be true that sind/uind takes exactly 2 bytes
  19  * It must be true that sbig/ubig takes exactly 4 bytes
  20  * On Sparc's, a sint takes 4 bytes (2 is legal)
  21  * On Sparc's, a uint takes 4 bytes (2 is legal)
  22  * On Sparc's, a long takes 4 bytes (8 is legal)
  23  * On Sparc's, a huge takes 4 bytes (8 is legal)
  24  * On Sparc's, a vptr takes 4 bytes (8 is legal)
  25  * On Sparc's, a real takes 8 bytes (4 is legal)
  26  * Note that some files have already been included by "h-include.h"
  27  * These include <stdio.h> and <sys/types>, which define some types
  28  * In particular, uint is defined so we do not have to define it
  29  * Also, see <limits.h> for min/max values for sind, uind, long, huge
  30  * (SHRT_MIN, SHRT_MAX, USHRT_MAX, LONG_MIN, LONG_MAX, ULONG_MAX)
  31  * These limits should be verified and coded into "h-constant.h".
  32  * </pre>
  33  */
  34
  35 #ifndef INCLUDED_H_TYPE_H
  36 #define INCLUDED_H_TYPE_H
  37
  38 #ifdef HAVE_STDINT_H
  39 #include <stdint.h>
  40 #endif
  41
  42 /*** Special 4 letter names for some standard types ***/
  43
  44 typedef void *vptr;       /*!< void型ポインタ定義 / A standard pointer (to "void" because ANSI C says so) */
  45 typedef const char *concptr; /*!< 文字列定数用ポインタ定義 / A simple pointer (to unmodifiable strings) */
  46 typedef double real;      /*!< doubleをreal型として定義 / Since float's are silly, hard code real numbers as doubles */
  47
  48
  49 /*!
  50  * @brief エラーコードの定義 / Error codes for function return values
  51  * @details
  52  * 一般に成功時0、失敗時負数、何らかの問題時整数とする。
  53  * Success = 0, Failure = -N, Problem = +N
  54  */
  55 typedef int errr;
  56
  57 #undef uint
  58 #define uint uint_hack /*!< 非マッキントッシュ環境で重複を避けるためのuint_hack型定義 / Hack -- prevent problems with non-MACINTOSH */
  59
  60 #undef huge
  61 #define huge huge_hack /*!< WINDOWS環境で重複を避けるためのhuge_hack定義 / Hack -- prevent problems with WINDOWS */
  62
  63 #undef byte
  64 #define byte byte_hack /*!< AMIGA環境で重複を避けるためのbyte_hack定義 / Hack -- prevent problems with AMIGA */
  65
  66 #undef bool
  67 #define bool bool_hack /*!< C++環境で重複を避けるためのbool_hack定義 Hack -- prevent problems with C++ */
  68
  69
  70 /* Note that "signed char" is not always "defined" */
  71 /* So always use "s16b" to hold small signed values */
  72 /* A signed byte of memory */
  73 /* typedef signed char syte; */
  74
  75 typedef unsigned char byte; /*!< byte型をunsighned charとして定義 / Note that unsigned values can cause math problems / An unsigned byte of memory */
  76 typedef char bool; /*!< bool型をcharとして定義 / Note that a bool is smaller than a full "int" / Simple True/False type */
  77 typedef int sint; /*!< sint型をintとして定義 / A signed, standard integer (at least 2 bytes) */
  78 typedef unsigned int uint; /* uint型をintとして定義 /  An unsigned, "standard" integer (often pre-defined) */
  79
  80
  81 /* The largest possible signed integer (pre-defined) */
  82 /* typedef long long; */
  83
  84 /* The largest possible unsigned integer */
  85 typedef unsigned long huge;
  86
  87 /* Signed/Unsigned 16 bit value */
  88 #ifdef HAVE_STDINT_H
  89 typedef int16_t s16b;
  90 typedef uint16_t u16b;
  91 #else
  92 typedef signed short s16b;
  93 typedef unsigned short u16b;
  94 #endif
  95
  96 /* Signed/Unsigned 32 bit value */
  97 #ifdef HAVE_STDINT_H
  98 typedef int32_t s32b;
  99 typedef uint32_t u32b;
 100 #else
 101 typedef signed long s32b;
 102 typedef unsigned long u32b;
 103 #endif
 104
 105
 106 typedef s16b IDX;                               /*!< ゲーム中のID型を定義 */
 107
 108 typedef s16b TOWN_IDX;                  /*!< ゲーム中の町ID型を定義 */
 109 typedef s16b FEAT_IDX;                  /*!< ゲーム中の地形ID型を定義 */
 110 typedef s16b FLOOR_IDX;                 /*!< ゲーム中のフロアID型を定義 */
 111
 112 typedef byte SEX_IDX;                   /*!< ゲーム中のプレイヤー性別ID型を定義 */
 113 typedef s16b RACE_IDX;                  /*!< ゲーム中のプレイヤー種族ID型を定義 */
 114 typedef s16b CLASS_IDX;                 /*!< ゲーム中のプレイヤー職業ID型を定義 */
 115 typedef s16b CHARACTER_IDX;             /*!< ゲーム中のプレイヤー性格ID型を定義 */
 116 typedef s16b MIMIC_RACE_IDX;    /*!< ゲーム中のプレイヤー変身種族ID型を定義 */
 117 typedef s16b PATRON_IDX;                /*!< ゲーム中のプレイヤーパトロンID型を定義 */
 118 typedef s32b ACTION_IDX;                /*!< プレイヤーが現在取っている常時行動のID定義 */
 119 typedef s16b BACT_IDX;                  /*!< 町の施設処理のID定義 */
 120 typedef s16b BACT_RESTRICT_IDX; /*!< 町の施設処理の規制処理ID定義 */
 121
 122 typedef s16b MONRACE_IDX;               /*!< ゲーム中のモンスター種族ID型を定義 */
 123 typedef s16b MONSTER_IDX;               /*!< ゲーム中のモンスター個体ID型を定義 */
 124 typedef s16b DUNGEON_IDX;               /*!< ゲーム中のダンジョンID型を定義 */
 125 typedef s16b REALM_IDX;                 /*!< ゲーム中の魔法領域ID型を定義 */
 126 typedef s16b ARTIFACT_IDX;              /*!< ゲーム中のアーティファクトID型を定義 */
 127 typedef s16b EGO_IDX;                   /*!< アイテムエゴのID型を定義 */
 128 typedef s16b ACTIVATION_IDX;    /*!< アイテムの発動効果ID型を定義 */
 129 typedef s16b VIRTUES_IDX;               /*!< ゲーム中の徳ID型を定義 */
 130 typedef s16b QUEST_IDX;                 /*!< ゲーム中のクエストID型を定義 */
 131 typedef byte ROOM_IDX;                  /*!< 部屋のID型を定義 */
 132
 133 typedef s16b INVENTORY_IDX;             /*!< ゲーム中の所持品ID型を定義 */
 134 typedef s16b OBJECT_IDX;                /*!< ゲーム中のアイテムID型を定義 */
 135 typedef s32b ESSENCE_IDX;               /*!< 鍛冶エッセンスのID型 */
 136 typedef s16b KIND_OBJECT_IDX;   /*!< ゲーム中のベースアイテムID型を定義 */
 137 typedef s16b VAULT_IDX;                 /*!< 固定部屋のID型を定義 */
 138
 139 typedef s32b POSITION;                  /*!< ゲーム中の座標型を定義 */
 140 typedef s16b POSITION_IDX;              /*!< ゲーム中の座標リストID型 */
 141
 142 typedef s32b ALIGNMENT;         /*!< 善悪属性の型定義 */
 143 typedef byte FEAT_SUBTYPE;      /*!< 地形情報の副値 (トラップ種別/パターン種別/店舗種別)*/
 144
 145 typedef char GAME_TEXT;         /*!< ゲーム中のテキスト型定義 */
 146
 147
 148 /*!
 149  * @var typedef s32b HIT_POINT
 150  * @brief HPとその増減量の型定義
 151  * @details
 152  * HIT_POINTはプレイヤー及びモンスターのHPの各値とその増減量の型である。
 153  */
 154 typedef s32b HIT_POINT;
 155
 156 /*!
 157  * @var typedef s32b MANA_POINT
 158  * @brief MPとその増減量の型定義
 159  * @details
 160  * MANA_POINTはプレイヤーのMPの各地とその増減量の型である。
 161  */
 162 typedef s32b MANA_POINT;                /*!< ゲーム中のMP型を定義 */
 163
 164 typedef int ARTIFACT_BIAS_IDX;  /*!< ランダムアーティファクトのバイアス型 */
 165
 166 typedef s16b HIT_PROB;                  /*!< ゲーム中の装備命中修正値を定義 */
 167 typedef int HIT_RELIABILITY;    /*!< 最終算出命中力を定義 */
 168 typedef s16b BASE_STATUS;               /*!< ゲーム中の基礎能力値型を定義 */
 169
 170 typedef s32b MONSTER_NUMBER;    /*!< ゲーム中のモンスター数型を定義 */
 171 typedef s32b ITEM_NUMBER;               /*!< ゲーム中のアイテム数型を定義 */
 172
 173 typedef s16b ACTION_ENERGY;             /*!< ゲーム中の行動エネルギー型を定義 */
 174 typedef s16b ARMOUR_CLASS;              /*!< ゲーム中の行動アーマークラス型を定義 */
 175 typedef s16b TIME_EFFECT;               /*!< ゲーム中の時限期間の型を定義 */
 176 typedef byte DISCOUNT_RATE;             /*!< ゲーム中の値引き率の型を定義 */
 177 typedef s16b SPEED;                             /*!< ゲーム中の加速値の型定義 */
 178
 179 /*!
 180  * @var typedef s16b ENEGRY
 181  * @brief 行動エネルギーの型定義
 182  * @details
 183  * ENERGYはプレイヤーとモンスターの行動順を定める行動エネルギーを示す型定義である。
 184  */
 185 typedef s16b ENERGY;                    /*!< ゲーム中の行動エネルギーの型定義 */
 186
 187
 188 typedef s16b SLEEP_DEGREE;              /*!< モンスターの睡眠度の型定義 */
 189
 190 typedef s16b PLAYER_LEVEL;              /*!< ゲーム中のプレイヤーレベルの型を定義 */
 191 typedef int DIRECTION;                  /*!< ゲーム中の方角の型定義 */
 192 typedef s32b EXP;                               /*!< ゲーム中の主経験値の型定義 */
 193 typedef s16b SUB_EXP;                   /*!< ゲーム中の副経験値の型定義 */
 194
 195 typedef s32b OBJECT_TYPE_VALUE;    /*!< ゲーム中のアイテム主分類の型定義 */
 196 typedef s32b OBJECT_SUBTYPE_VALUE; /*!< ゲーム中のアイテム副分類の型定義 */
 197 typedef s16b PARAMETER_VALUE;      /*!< ゲーム中のアイテム能力値の型定義 */
 198 typedef s32b WEIGHT;               /*!< ゲーム中の重量の型定義(ポンド) */
 199
 200 typedef int DICE_NUMBER; /*!< ゲーム中のダイス数の型定義 */
 201 typedef int DICE_SID;    /*!< ゲーム中のダイス面の型定義 */
 202 typedef s32b PRICE;      /*!< ゲーム中の金額価値の型定義 */
 203 typedef s16b FEED;       /*!< ゲーム中の滋養度の型定義 */
 204
 205 typedef u32b STR_OFFSET;      /*!< テキストオフセットの型定義 */
 206
 207 typedef int POWER;              /*!< 魔法の効力定義*/
 208
 209 typedef s32b DEPTH;     /*!< ゲーム中の階層レベルの型定義 */
 210 typedef byte RARITY;    /*!< ゲーム中の希少度の型定義 */
 211
 212 typedef s32b GAME_TURN;     /*!< ゲーム中のターンの型定義 */
 213 typedef u32b REAL_TIME;     /*!< 実時刻の型定義 */
 214
 215 typedef s32b PERCENTAGE;    /*!< ゲーム中のパーセント表記の型定義(/100倍) */
 216 typedef s16b MULTIPLY;      /*!< ゲーム中の倍率の型定義(/10倍) */
 217
 218 typedef u32b BIT_FLAGS;     /*!< 32ビットのフラグ配列の型定義 */
 219 typedef u16b BIT_FLAGS16;   /*!< 16ビットのフラグ配列の型定義 */
 220 typedef byte BIT_FLAGS8;    /*!< 8ビットのフラグ配列の型定義 */
 221
 222 typedef s16b XTRA16;     /*!< 汎用変数16ビットの型定義 */
 223 typedef byte XTRA8;      /*!< 汎用変数8ビットの型定義 */
 224
 225 typedef s16b COMMAND_CODE;   /*!< コマンド内容の型定義 */
 226 typedef s16b COMMAND_ARG;        /*!< コマンド引数の型定義 */
 227 typedef s16b COMMAND_NUM;        /*!< コマンド数の型定義 */
 228
 229 typedef int TERM_LEN;     /*!< コンソール表示座標の型定義 */
 230 typedef byte TERM_COLOR;  /*!< テキスト表示色の型定義 */
 231 typedef char SYMBOL_CODE; /*!< キャラの文字の型定義 */
 232
 233 typedef s32b MAGIC_NUM1;   /*!< プレイヤーの汎用魔法情報配列1の型定義*/
 234 typedef byte MAGIC_NUM2;   /*!< プレイヤーの汎用魔法情報配列2の型定義*/
 235
 236 typedef s32b SPELL_IDX;    /*!< 各魔法領域/職業能力ごとの呪文ID型定義 */
 237 typedef s16b PROB;         /*!< 確率の重みの型定義 */
 238 typedef byte FEAT_POWER;   /*!< 地形強度の型定義 */
 239
 240 typedef int QUANTITY; /*!< インターフェース上の指定個数 */
 241
 242 typedef byte BLOW_METHOD; /*!< モンスターの打撃手段ID */
 243 typedef byte BLOW_EFFECT; /*!< モンスターの打撃効果ID */
 244
 245 typedef int EFFECT_ID; /*!< 効果属性ID */
 246
 247 typedef s16b QUEST_TYPE;   /*!< クエストの種別ID */
 248 typedef s16b QUEST_STATUS; /*!< クエストの状態ID */
 249
 250 typedef s16b ACTION_SKILL_POWER; /*!< 行動技能値 */
 251
 252 typedef int PET_COMMAND_IDX; /*!< ペットへの指示ID */
 253 typedef byte FF_FLAGS_IDX;   /*!< 地形特性ID */
 254
 255 typedef s16b FEAT_PRIORITY; /*!< 地形の縮小表示優先順位 */
 256
 257 /*** Pointers to all the basic types defined above ***/
 258
 259 typedef real *real_ptr;
 260 typedef errr *errr_ptr;
 261 typedef char *char_ptr;
 262 typedef byte *byte_ptr;
 263 typedef bool *bool_ptr;
 264 typedef sint *sint_ptr;
 265 typedef uint *uint_ptr;
 266 typedef long *long_ptr;
 267 typedef huge *huge_ptr;
 268 typedef s16b *s16b_ptr;
 269 typedef u16b *u16b_ptr;
 270 typedef s32b *s32b_ptr;
 271 typedef u32b *u32b_ptr;
 272 typedef vptr *vptr_ptr;
 273 typedef concptr *cptr_ptr;
 274
 275
 276
 277 /*** Pointers to Functions of special types (for various purposes) ***/
 278
 279 /* A generic function takes a user data and a special data */
 280 typedef errr    (*func_gen)(vptr, vptr);
 281
 282 /* An equality testing function takes two things to compare (bool) */
 283 typedef bool    (*func_eql)(vptr, vptr);
 284
 285 /* A comparison function takes two things and to compare (-1,0,+1) */
 286 typedef sint    (*func_cmp)(vptr, vptr);
 287
 288 /* A hasher takes a thing (and a max hash size) to hash (0 to siz - 1) */
 289 typedef uint    (*func_hsh)(vptr, uint);
 290
 291 /* A key extractor takes a thing and returns (a pointer to) some key */
 292 typedef vptr    (*func_key)(vptr);
 293
 294
 295
 296 #endif
 297