3 * @brief ゲーム中に用いる変数型定義 / Basic "types".
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".
35 #ifndef INCLUDED_H_TYPE_H
36 #define INCLUDED_H_TYPE_H
42 /*** Special 4 letter names for some standard types ***/
44 typedef void *vptr; /*!< void型ポインタ定義 / A standard pointer (to "void" because ANSI C says so) */
45 typedef const char *cptr; /*!< 文字列定数用ポインタ定義 / A simple pointer (to unmodifiable strings) */
46 typedef double real; /*!< doubleをreal型として定義 / Since float's are silly, hard code real numbers as doubles */
50 * @brief エラーコードの定義 / Error codes for function return values
52 * 一般に成功時0、失敗時負数、何らかの問題時整数とする。
53 * Success = 0, Failure = -N, Problem = +N
58 #define uint uint_hack /*!< 非マッキントッシュ環境で重複を避けるためのuint_hack型定義 / Hack -- prevent problems with non-MACINTOSH */
61 #define huge huge_hack /*!< WINDOWS環境で重複を避けるためのhuge_hack定義 / Hack -- prevent problems with WINDOWS */
64 #define byte byte_hack /*!< AMIGA環境で重複を避けるためのbyte_hack定義 / Hack -- prevent problems with AMIGA */
67 #define bool bool_hack /*!< C++環境で重複を避けるためのbool_hack定義 Hack -- prevent problems with C++ */
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; */
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) */
81 /* The largest possible signed integer (pre-defined) */
82 /* typedef long long; */
84 /* The largest possible unsigned integer */
85 typedef unsigned long huge;
87 /* Signed/Unsigned 16 bit value */
90 typedef uint16_t u16b;
92 typedef signed short s16b;
93 typedef unsigned short u16b;
96 /* Signed/Unsigned 32 bit value */
99 typedef uint32_t u32b;
101 typedef signed long s32b;
102 typedef unsigned long u32b;
106 typedef s16b IDX; /*!< ゲーム中のID型を定義 */
108 typedef s16b FEAT_IDX; /*!< ゲーム中の地形ID型を定義 */
110 typedef s16b RACE_IDX; /*!< ゲーム中のプレイヤー種族ID型を定義 */
111 typedef s16b CLASS_IDX; /*!< ゲーム中のプレイヤー職業ID型を定義 */
112 typedef s16b MIMIC_RACE_IDX; /*!< ゲーム中のプレイヤー変身種族ID型を定義 */
113 typedef s16b PATRON_IDX; /*!< ゲーム中のプレイヤーパトロンID型を定義 */
115 typedef s16b MONRACE_IDX; /*!< ゲーム中のモンスター種族ID型を定義 */
116 typedef s16b MONSTER_IDX; /*!< ゲーム中のモンスター個体ID型を定義 */
117 typedef s16b DUNGEON_IDX; /*!< ゲーム中のダンジョンID型を定義 */
118 typedef s16b REALM_IDX; /*!< ゲーム中の魔法領域ID型を定義 */
119 typedef s16b ARTIFACT_IDX; /*!< ゲーム中のアーティファクトID型を定義 */
120 typedef s16b VIRTUES_IDX; /*!< ゲーム中の徳ID型を定義 */
121 typedef s16b QUEST_IDX; /*!< ゲーム中のクエストID型を定義 */
122 typedef byte ROOM_IDX; /*!< 部屋のID型を定義 */
124 typedef s16b INVENTORY_IDX; /*!< ゲーム中の所持品ID型を定義 */
125 typedef s16b OBJECT_IDX; /*!< ゲーム中のアイテムID型を定義 */
127 typedef s16b KIND_OBJECT_IDX; /*!< ゲーム中のベースアイテムID型を定義 */
129 typedef s32b POSITION; /*!< ゲーム中の座標型を定義 */
131 typedef s32b ALIGNMENT; /*!< 善悪属性の型定義 */
134 * @var typedef s32b HIT_POINT
135 * @brief HPとその増減量の型定義
137 * HIT_POINTはプレイヤー及びモンスターのHPの各値とその増減量の型である。
139 typedef s32b HIT_POINT;
142 * @var typedef s32b MANA_POINT
143 * @brief MPとその増減量の型定義
145 * MANA_POINTはプレイヤーのMPの各地とその増減量の型である。
147 typedef s32b MANA_POINT; /*!< ゲーム中のMP型を定義 */
149 typedef int ARTIFACT_BIAS_IDX; /*!< ランダムアーティファクトのバイアス型 */
151 typedef s16b HIT_PROB; /*!< ゲーム中の命中修正値を定義 */
152 typedef s16b BASE_STATUS; /*!< ゲーム中の基礎能力値型を定義 */
154 typedef s32b MONSTER_NUMBER; /*!< ゲーム中のモンスター数型を定義 */
155 typedef s32b ITEM_NUMBER; /*!< ゲーム中のアイテム数型を定義 */
157 typedef s16b ACTION_ENERGY; /*!< ゲーム中の行動エネルギー型を定義 */
158 typedef s16b ARMOUR_CLASS; /*!< ゲーム中の行動アーマークラス型を定義 */
159 typedef s16b TIME_EFFECT; /*!< ゲーム中の時限期間の型を定義 */
160 typedef byte CHARACTER_IDX; /*!< ゲーム中のキャラクター特性各種IDの型を定義 */
161 typedef byte DISCOUNT_RATE; /*!< ゲーム中の値引き率の型を定義 */
162 typedef byte SPEED; /*!< ゲーム中の加速値の型定義 */
165 * @var typedef s16b ENEGRY
168 * ENERGYはプレイヤーとモンスターの行動順を定める行動エネルギーを示す型定義である。
170 typedef s16b ENERGY; /*!< ゲーム中の行動エネルギーの型定義 */
173 typedef s16b SLEEP_DEGREE; /*!< モンスターの睡眠度の型定義 */
175 typedef s16b PLAYER_LEVEL; /*!< ゲーム中のプレイヤーレベルの型を定義 */
176 typedef int DIRECTION; /*!< ゲーム中の方角の型定義 */
177 typedef s32b EXP; /*!< ゲーム中の主経験値の型定義 */
178 typedef s16b SUB_EXP; /*!< ゲーム中の副経験値の型定義 */
179 typedef s16b TERM_COLOR; /*!< テキスト表示色の型定義 */
181 typedef s32b OBJECT_TYPE_VALUE; /*!< ゲーム中のアイテム主分類の型定義 */
182 typedef s32b OBJECT_SUBTYPE_VALUE; /*!< ゲーム中のアイテム副分類の型定義 */
183 typedef s16b PARAMETER_VALUE; /*!< ゲーム中のアイテム能力値の型定義 */
184 typedef s32b WEIGHT; /*!< ゲーム中の重量の型定義(ポンド) */
186 typedef int DICE_NUMBER; /*!< ゲーム中のダイス数の型定義 */
187 typedef int DICE_SID; /*!< ゲーム中のダイス面の型定義 */
188 typedef s32b PRICE; /*!< ゲーム中の金額価値の型定義 */
189 typedef s16b FEED; /*!< ゲーム中の滋養度の型定義 */
191 typedef u32b STR_OFFSET; /*!< テキストオフセットの型定義 */
193 typedef s32b DEPTH; /*!< ゲーム中の階層レベルの型定義 */
194 typedef byte RARITY; /*!< ゲーム中の希少度の型定義 */
196 typedef s32b GAME_TURN; /*!< ゲーム中のターンの型定義 */
197 typedef s32b REAL_TIME; /*!< 実時刻の型定義 */
199 typedef s16b PERCENTAGE; /*!< ゲーム中のパーセント表記の型定義(/100倍) */
200 typedef s16b MULTIPLY; /*!< ゲーム中の倍率の型定義(/10倍) */
202 typedef u32b BIT_FLAGS; /*!< 32ビットのフラグ配列の型定義 */
203 typedef u16b BIT_FLAGS16; /*!< 16ビットのフラグ配列の型定義 */
204 typedef byte BIT_FLAGS8; /*!< 8ビットのフラグ配列の型定義 */
206 typedef s16b XTRA16; /*!< 汎用変数16ビットの型定義 */
207 typedef byte XTRA8; /*!< 汎用変数8ビットの型定義 */
209 typedef s16b COMMAND_CODE; /*!< コマンド内容の型定義 */
210 typedef s16b COMMAND_ARG; /*!< コマンド引数の型定義 */
212 typedef int TERM_POSITION; /*!< コンソール表示座標の型定義 */
213 typedef byte SYMBOL_COLOR; /*!< キャラの色の型定義 */
214 typedef byte SYMBOL_CODE; /*!< キャラの文字の型定義 */
216 typedef s32b MAGIC_NUM1; /*!< プレイヤーの汎用魔法情報配列1の型定義*/
217 typedef byte MAGIC_NUM2; /*!< プレイヤーの汎用魔法情報配列2の型定義*/
219 typedef s32b SPELL_IDX; /*!< 各魔法領域/職業能力ごとの呪文ID型定義 */
220 typedef s16b PROB; /*!< 確率の重みの型定義 */
221 typedef byte FEAT_POWER; /*!< 地形強度の型定義 */
223 typedef int QUANTITY; /*!< インターフェース上の指定個数 */
225 typedef byte BLOW_METHOD; /*!< モンスターの打撃手段ID */
226 typedef byte BLOW_EFFECT; /*!< モンスターの打撃効果ID */
228 typedef int EFFECT_ID; /*!< 効果属性ID */
230 typedef s16b QUEST_TYPE; /*!< クエストの種別ID */
231 typedef s16b QUEST_STATUS; /*!< クエストの状態ID */
233 typedef s16b ACTION_SKILL_POWER; /*!< 行動技能値 */
236 /*** Pointers to all the basic types defined above ***/
238 typedef real *real_ptr;
239 typedef errr *errr_ptr;
240 typedef char *char_ptr;
241 typedef byte *byte_ptr;
242 typedef bool *bool_ptr;
243 typedef sint *sint_ptr;
244 typedef uint *uint_ptr;
245 typedef long *long_ptr;
246 typedef huge *huge_ptr;
247 typedef s16b *s16b_ptr;
248 typedef u16b *u16b_ptr;
249 typedef s32b *s32b_ptr;
250 typedef u32b *u32b_ptr;
251 typedef vptr *vptr_ptr;
252 typedef cptr *cptr_ptr;
256 /*** Pointers to Functions of special types (for various purposes) ***/
258 /* A generic function takes a user data and a special data */
259 typedef errr (*func_gen)(vptr, vptr);
261 /* An equality testing function takes two things to compare (bool) */
262 typedef bool (*func_eql)(vptr, vptr);
264 /* A comparison function takes two things and to compare (-1,0,+1) */
265 typedef sint (*func_cmp)(vptr, vptr);
267 /* A hasher takes a thing (and a max hash size) to hash (0 to siz - 1) */
268 typedef uint (*func_hsh)(vptr, uint);
270 /* A key extractor takes a thing and returns (a pointer to) some key */
271 typedef vptr (*func_key)(vptr);