OSDN Git Service

z-config.hの一部プリプロセッサにDoxygen日本語コメントを付加。 / Add Doxygen Japanese comments to preprocess...
[hengband/hengband.git] / src / z-config.h
1 /* File: z-config.h */
2
3 /*
4  * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
5  *
6  * This software may be copied and distributed for educational, research,
7  * and not for profit purposes provided that this copyright and statement
8  * are included in all such copies.  Other copyrights may also apply.
9  */
10
11 /* Purpose: Angband specific configuration stuff */
12
13 /* Allow debug commands */
14 #define USE_DEBUG
15
16 /* Allow various special stuff (sound, graphics, etc.) */
17 #define USE_SPECIAL
18
19 #ifndef HAVE_CONFIG_H
20
21 /*
22  * USE_FONTSET and/or USE_XIM can be commented out
23  * when you don't want to use it.
24  */
25 #define USE_FONTSET
26
27 #ifdef JP
28 #define USE_XIM
29 #endif
30
31 #if defined(USE_FONTSET) || defined(USE_XIM)
32 #define USE_LOCALE
33 #endif
34
35 #if defined(JP) && !defined(USE_FONTSET)
36 #define USE_JP_FONTSTRUCT
37 #endif
38
39 #endif /* HAVE_CONFIG_H */
40
41
42 /*
43  * Look through the following lines, and where a comment includes the
44  * tag "OPTION:", examine the associated "#define" statements, and decide
45  * whether you wish to keep, comment, or uncomment them.  You should not
46  * have to modify any lines not indicated by "OPTION".
47  *
48  * Note: Also examine the "system" configuration file "h-config.h"
49  * and the variable initialization file "variable.c".  If you change
50  * anything in "variable.c", you only need to recompile that file.
51  *
52  * And finally, remember that the "Makefile" will specify some rather
53  * important compile time options, like what visual module to use.
54  */
55
56
57 /*
58  * OPTION: See the Makefile(s), where several options may be declared.
59  *
60  * Some popular options include "USE_GCU" (allow use with Unix "curses"),
61  * "USE_X11" (allow basic use with Unix X11), "USE_XAW" (allow use with
62  * Unix X11 plus the Athena Widget set), and "USE_CAP" (allow use with
63  * the "termcap" library, or with hard-coded vt100 terminals).
64  *
65  * The old "USE_NCU" option has been replaced with "USE_GCU".
66  *
67  * Several other such options are available for non-unix machines,
68  * such as "MACINTOSH", "WINDOWS", "USE_IBM", "USE_EMX".
69  *
70  * You may also need to specify the "system", using defines such as
71  * "SOLARIS" (for Solaris), etc, see "h-config.h" for more info.
72  */
73
74
75 /*
76  * OPTION: define "SPECIAL_BSD" for using certain versions of UNIX
77  * that use the 4.4BSD Lite version of Curses in "main-gcu.c"
78  */
79 /* #define SPECIAL_BSD */
80
81
82 /*
83  * OPTION: Use the POSIX "termios" methods in "main-gcu.c"
84  */
85 /* #define USE_TPOSIX */
86
87 /*
88  * OPTION: Use the "termio" methods in "main-gcu.c"
89  */
90 /* #define USE_TERMIO */
91
92 /*
93  * OPTION: Use the icky BSD "tchars" methods in "main-gcu.c"
94  */
95 /* #define USE_TCHARS */
96
97
98 /*
99  * OPTION: Use "blocking getch() calls" in "main-gcu.c".
100  * Hack -- Note that this option will NOT work on many BSD machines
101  * Currently used whenever available, if you get a warning about
102  * "nodelay()" undefined, then make sure to undefine this.
103  */
104 #if defined(SYS_V)
105 # define USE_GETCH
106 #endif
107
108
109 /*
110  * OPTION: Use the "curs_set()" call in "main-gcu.c".
111  * Hack -- This option will not work on most BSD machines
112  */
113 #ifdef SYS_V
114 # define USE_CURS_SET
115 #endif
116
117
118 /*
119  * OPTION: Include "ncurses.h" instead of "curses.h" in "main-gcu.c"
120  */
121 /* #define USE_NCURSES */
122
123
124 /*
125  * OPTION: for multi-user machines running the game setuid to some other
126  * user (like 'games') this SAFE_SETUID option allows the program to drop
127  * its privileges when saving files that allow for user specified pathnames.
128  * This lets the game be installed system wide without major security
129  * concerns.  There should not be any side effects on any machines.
130  *
131  * This will handle "gids" correctly once the permissions are set right.
132  */
133 #define SAFE_SETUID
134
135
136 /*
137  * This flag enables the "POSIX" methods for "SAFE_SETUID".
138  */
139 #ifdef _POSIX_SAVED_IDS
140 # define SAFE_SETUID_POSIX
141 #endif
142
143
144 /*
145  * Prevent problems on (non-Solaris) Suns using "SAFE_SETUID".
146  * The SAFE_SETUID code is weird, use it at your own risk...
147  */
148 #if defined(SUNOS) && !defined(SOLARIS)
149 # undef SAFE_SETUID_POSIX
150 #endif
151
152
153
154
155 /*
156  * OPTION: for the AFS distributed file system, define this to ensure that
157  * the program is secure with respect to the setuid code.  This option has
158  * not been tested (to the best of my knowledge).  This option may require
159  * some weird tricks with "player_uid" and such involving "defines".
160  * Note that this option used the AFS library routines Authenticate(),
161  * bePlayer(), beGames() to enforce the proper priviledges.
162  * You may need to turn "SAFE_SETUID" off to use this option.
163  */
164 /* #define SECURE */
165
166
167
168
169 /*
170  * OPTION: Verify savefile Checksums (Angband 2.7.0 and up)
171  * This option can help prevent "corruption" of savefiles, and also
172  * stop intentional modification by amateur users.
173  */
174 #define VERIFY_CHECKSUMS
175
176
177 /*
178  * OPTION: Forbid the use of "fiddled" savefiles.  As far as I can tell,
179  * a fiddled savefile is one with an internal timestamp different from
180  * the actual timestamp.  Thus, turning this option on forbids one from
181  * copying a savefile to a different name.  Combined with disabling the
182  * ability to save the game without quitting, and with some method of
183  * stopping the user from killing the process at the tombstone screen,
184  * this should prevent the use of backup savefiles.  It may also stop
185  * the use of savefiles from other platforms, so be careful.
186  */
187 /* #define VERIFY_TIMESTAMP */
188
189
190 /*
191  * OPTION: Forbid the "savefile over-write" cheat, in which you simply
192  * run another copy of the game, loading a previously saved savefile,
193  * and let that copy over-write the "dead" savefile later.  This option
194  * either locks the savefile, or creates a fake "xxx.lok" file to prevent
195  * the use of the savefile until the file is deleted.  Not ready yet.
196  */
197 /* #define VERIFY_SAVEFILE */
198
199
200
201 /*
202  * OPTION: Hack -- Compile in support for "Cyborg" mode
203  */
204 /*#define ALLOW_BORG*/
205
206 #ifdef USE_DEBUG
207
208 /*!
209  * @brief ウィザードモードへの移行を許可する / OPTION: Hack -- Compile in support for "Wizard Commands"
210  */
211 #define ALLOW_WIZARD
212
213 /*!
214  * @brief スポイラー出力を許可する / OPTION: Hack -- Compile in support for "Spoiler Generation"
215  */
216 #define ALLOW_SPOILERS
217
218 #endif /* USE_DEBUG */
219
220 /*!
221  * @brief キャラクターの色変更機能を付加する / OPTION: Allow "do_cmd_colors" at run-time
222  */
223 #define ALLOW_COLORS
224
225 /*!
226  * @brief キャラクターのシンボル変更機能を付加する / OPTION: Allow "do_cmd_visuals" at run-time
227  */
228 #define ALLOW_VISUALS
229
230 /*!
231  * @brief マクロ機能を付加する / OPTION: Allow "do_cmd_macros" at run-time
232  */
233 #define ALLOW_MACROS
234
235 /*!
236  * @brief オートローラー機能を付加する / OPTION: Allow characteres to be "auto-rolled"
237  */
238 #define ALLOW_AUTOROLLER
239
240 /*!
241  * @brief 一定以上のダメージを受けたモンスターが恐怖して逃走する / OPTION: Allow monsters to "flee" when hit hard
242  */
243 #define ALLOW_FEAR
244
245 /*!
246  * @brief 一定以上のレベルを持ったプレイヤーが相手ならば、弱いモンスターは逃げ出す/ OPTION: Allow monsters to "flee" from strong players
247  */
248 #define ALLOW_TERROR
249
250
251 /*
252  * OPTION: Allow parsing of the ascii template files in "init.c".
253  * This must be defined if you do not have valid binary image files.
254  * It should be usually be defined anyway to allow easy "updating".
255  */
256 #define ALLOW_TEMPLATES
257
258 /*
259  * OPTION: Allow loading of pre-2.7.0 savefiles.  Note that it takes
260  * about 15K of code in "save-old.c" to parse the old savefile format.
261  * Angband 2.8.0 will ignore a lot of info from pre-2.7.0 savefiles.
262  */
263 #define ALLOW_OLD_SAVEFILES
264
265
266 /*
267  * OPTION: Handle signals
268  */
269 #define HANDLE_SIGNALS
270
271
272 /*
273  * Allow "Wizards" to yield "high scores"
274  */
275 /* #define SCORE_WIZARDS */
276
277 /*
278  * Allow "Borgs" to yield "high scores"
279  */
280 /*#define SCORE_BORGS*/
281
282 /*
283  * Allow "Cheaters" to yield "high scores"
284  */
285 /* #define SCORE_CHEATERS */
286
287
288
289 /*
290  * OPTION: Maximum flow depth when using "MONSTER_FLOW"
291  */
292 #define MONSTER_FLOW_DEPTH 32
293
294
295 #ifdef USE_SPECIAL
296
297 /*
298  * OPTION: Allow the use of "sound" in various places.
299  */
300 #define USE_SOUND
301
302 /*
303  * OPTION: Allow the use of "graphics" in various places
304  */
305 #define USE_GRAPHICS
306
307 /*
308  * OPTION: Allow the use of "music" in various places
309  */
310 #define USE_MUSIC
311
312 #endif /* USE_SPECIAL */
313
314
315 /*
316  * OPTION: Hack -- EMX stuff
317  */
318 #ifdef USE_EMX
319
320 /* Do not handle signals */
321 # undef HANDLE_SIGNALS
322
323 #endif
324
325
326 /*
327  * OPTION: Set the "default" path to the angband "lib" directory.
328  *
329  * See "main.c" for usage, and note that this value is only used on
330  * certain machines, primarily Unix machines.  If this value is used,
331  * it will be over-ridden by the "ANGBAND_PATH" environment variable,
332  * if that variable is defined and accessable.  The final slash is
333  * optional, but it may eventually be required.
334  *
335  * Using the value "./lib/" below tells Angband that, by default,
336  * the user will run "angband" from the same directory that contains
337  * the "lib" directory.  This is a reasonable (but imperfect) default.
338  *
339  * If at all possible, you should change this value to refer to the
340  * actual location of the "lib" folder, for example, "/tmp/angband/lib/"
341  * or "/usr/games/lib/angband/", or "/pkg/angband/lib".
342  */
343 #ifndef DEFAULT_PATH
344 # define DEFAULT_PATH "./lib/"
345 #endif
346
347
348 /*
349  * OPTION: Create and use a hidden directory in the users home directory
350  * for storing pref-files and character-dumps.
351  */
352 #ifdef SET_UID
353 #define PRIVATE_USER_PATH "~/.angband"
354 #endif /* SET_UID */
355
356
357 /*
358  * On multiuser systems, add the "uid" to savefile names
359  */
360 #ifdef SET_UID
361 # define SAVEFILE_USE_UID
362 #endif
363
364
365 /*
366  * OPTION: Check the "time" against "lib/file/hours.txt"
367  */
368 /* #define CHECK_TIME */
369
370 /*
371  * OPTION: Check the "load" against "lib/file/load.txt"
372  * This may require the 'rpcsvs' library
373  */
374 /* #define CHECK_LOAD */
375
376
377 /*
378  * OPTION: For some brain-dead computers with no command line interface,
379  * namely Macintosh, there has to be some way of "naming" your savefiles.
380  * The current "Macintosh" hack is to make it so whenever the character
381  * name changes, the savefile is renamed accordingly.  But on normal
382  * machines, once you manage to "load" a savefile, it stays that way.
383  * Macintosh is particularly weird because you can load savefiles that
384  * are not contained in the "lib:save:" folder, and if you change the
385  * player's name, it will then save the savefile elsewhere.  Note that
386  * this also gives a method of "bypassing" the "VERIFY_TIMESTAMP" code.
387  */
388 /*
389 #if defined(MACINTOSH) || defined(WINDOWS)
390 # define SAVEFILE_MUTABLE
391 #endif
392 */
393
394 /*
395  * OPTION: Capitalize the "user_name" (for "default" player name)
396  * This option is only relevant on SET_UID machines.
397  */
398 #define CAPITALIZE_USER_NAME
399
400
401
402 /*
403  * OPTION: Person to bother if something goes wrong.
404  */
405 /* #define MAINTAINER   "rr9@angband.org" */
406 #define MAINTAINER      "echizen@users.sourceforge.jp"
407
408
409 #ifdef JP
410 #ifndef USE_FONTSET
411 /*
412  * OPTION: Default font (when using X11).
413  */
414 #define DEFAULT_X11_FONT  "a24"
415 #define DEFAULT_X11_KFONT "kanji24"
416 #define DEFAULT_X11_FONT_SUB  "a16"
417 #define DEFAULT_X11_KFONT_SUB "kanji16"
418
419
420 /*
421  * OPTION: Default fonts (when using X11)
422  */
423 #define DEFAULT_X11_FONT_0  DEFAULT_X11_FONT
424 #define DEFAULT_X11_KFONT_0 DEFAULT_X11_KFONT
425 #define DEFAULT_X11_FONT_1  DEFAULT_X11_FONT_SUB
426 #define DEFAULT_X11_KFONT_1 DEFAULT_X11_KFONT_SUB
427 #define DEFAULT_X11_FONT_2  DEFAULT_X11_FONT_SUB
428 #define DEFAULT_X11_KFONT_2 DEFAULT_X11_KFONT_SUB
429 #define DEFAULT_X11_FONT_3  DEFAULT_X11_FONT_SUB
430 #define DEFAULT_X11_KFONT_3 DEFAULT_X11_KFONT_SUB
431 #define DEFAULT_X11_FONT_4  DEFAULT_X11_FONT_SUB
432 #define DEFAULT_X11_KFONT_4 DEFAULT_X11_KFONT_SUB
433 #define DEFAULT_X11_FONT_5  DEFAULT_X11_FONT_SUB
434 #define DEFAULT_X11_KFONT_5 DEFAULT_X11_KFONT_SUB
435 #define DEFAULT_X11_FONT_6  DEFAULT_X11_FONT_SUB
436 #define DEFAULT_X11_KFONT_6 DEFAULT_X11_KFONT_SUB
437 #define DEFAULT_X11_FONT_7  DEFAULT_X11_FONT_SUB
438 #define DEFAULT_X11_KFONT_7 DEFAULT_X11_KFONT_SUB
439
440 #else
441 /*
442  * OPTION: Default font (when using X11).
443  */
444 #define DEFAULT_X11_FONT \
445         "-*-*-medium-r-normal--24-*-*-*-*-*-iso8859-1" \
446         ",-*-*-medium-r-normal--24-*-*-*-*-*-jisx0208.1983-0"
447 /*      "12x24" \
448         ",kanji24"*/
449 #define DEFAULT_X11_FONT_SUB \
450         "-*-*-medium-r-normal--16-*-*-*-*-*-iso8859-1" \
451         ",-*-*-medium-r-normal--16-*-*-*-*-*-jisx0208.1983-0"
452 /*      "8x16" \
453         ",kanji16"*/
454
455 /*
456  * OPTION: Default fonts (when using X11)
457  */
458 #define DEFAULT_X11_FONT_0              DEFAULT_X11_FONT
459 #define DEFAULT_X11_FONT_1              DEFAULT_X11_FONT_SUB
460 #define DEFAULT_X11_FONT_2              DEFAULT_X11_FONT_SUB
461 #define DEFAULT_X11_FONT_3              DEFAULT_X11_FONT_SUB
462 #define DEFAULT_X11_FONT_4              DEFAULT_X11_FONT_SUB
463 #define DEFAULT_X11_FONT_5              DEFAULT_X11_FONT_SUB
464 #define DEFAULT_X11_FONT_6              DEFAULT_X11_FONT_SUB
465 #define DEFAULT_X11_FONT_7              DEFAULT_X11_FONT_SUB
466 #endif
467
468 #else
469 /*
470  * OPTION: Default font (when using X11).
471  */
472 #define DEFAULT_X11_FONT                "9x15"
473
474 /*
475  * OPTION: Default fonts (when using X11)
476  */
477 #define DEFAULT_X11_FONT_0              "10x20"
478 #define DEFAULT_X11_FONT_1              "9x15"
479 #define DEFAULT_X11_FONT_2              "9x15"
480 #define DEFAULT_X11_FONT_3              "5x8"
481 #define DEFAULT_X11_FONT_4              "5x8"
482 #define DEFAULT_X11_FONT_5              "5x8"
483 #define DEFAULT_X11_FONT_6              "5x8"
484 #define DEFAULT_X11_FONT_7              "5x8"
485 #endif
486
487
488 /*
489  * OPTION: Gamma correct X11 colours.
490  */
491  
492 #define SUPPORT_GAMMA
493
494 /*
495  * Hack -- Mach-O (native binary format of OS X) is basically a Un*x
496  * but has Mac OS/Windows-like user interface
497  */
498 #ifdef MACH_O_CARBON
499 # ifdef PRIVATE_USER_PATH
500 #  undef PRIVATE_USER_PATH
501 # endif
502 # ifdef SAVEFILE_USE_UID
503 #  undef SAVEFILE_USE_UID
504 # endif
505 #endif
506
507 /*
508  * Hack -- Special "ancient machine" versions
509  */
510 #if defined(ANGBAND_LITE_MAC)
511 # ifndef ANGBAND_LITE
512 #  define ANGBAND_LITE
513 # endif
514 #endif
515
516 /*
517  * OPTION: Attempt to minimize the size of the game
518  */
519 #ifndef ANGBAND_LITE
520 /* #define ANGBAND_LITE */
521 #endif
522
523 /*
524  * Hack -- React to the "ANGBAND_LITE" flag
525  */
526 #ifdef ANGBAND_LITE
527 # undef ALLOW_COLORS
528 # undef ALLOW_VISUALS
529 # undef ALLOW_MACROS
530 # undef ALLOW_OLD_SAVEFILES
531 # undef ALLOW_BORG
532 # undef ALLOW_WIZARD
533 # undef ALLOW_SPOILERS
534 # undef ALLOW_TEMPLATES
535 # undef DELAY_LOAD_R_TEXT
536 # define DELAY_LOAD_R_TEXT
537 #endif
538
539
540
541 /*
542  * OPTION: Attempt to prevent all "cheating"
543  */
544 /* #define VERIFY_HONOR */
545
546
547 /*
548  * React to the "VERIFY_HONOR" flag
549  */
550 #ifdef VERIFY_HONOR
551 # define VERIFY_SAVEFILE
552 # define VERIFY_CHECKSUMS
553 # define VERIFY_TIMESTAMPS
554 #endif
555
556 /* Zangband options: */
557
558 /* Allow hordes of 'similar' monsters */
559 #define MONSTER_HORDES
560
561 /*
562  * OPTION: Repeat last command -- TNB
563  */
564 #define ALLOW_REPEAT
565
566 /*
567  * OPTION: Make opening and closing things easy -- TNB
568  */
569 #define ALLOW_EASY_OPEN
570
571 /*
572  * OPTION: Make disarming traps easy -- TNB
573  */
574 #define ALLOW_EASY_DISARM
575
576 /*
577  * OPTION: Make floor stacks easy -- TNB
578  */
579 #define ALLOW_EASY_FLOOR
580
581 /*
582  * Check the modification time of *_info.raw files
583  * (by Keldon Jones)
584  */
585 #ifndef MAC_MPW
586 #define CHECK_MODIFICATION_TIME
587 #endif
588
589 /*
590  * Use the new sorting routines for creation
591  * of the monster allocation table
592  */
593 #define SORT_R_INFO
594
595
596 #ifndef HAVE_CONFIG_H
597 #define WORLD_SCORE
598 #endif /* HAVE_CONFIG_H */