src/main.cpp

   1 /*
   2  * Copyright (c) 1997 Ben Harrison, and others
   3  *
   4  * This software may be copied and distributed for educational, research,
   5  * and not for profit purposes provided that this copyright and statement
   6  * are included in all such copies.
   7  */
   8
   9 #include "core/asking-player.h"
  10 #include "core/game-play.h"
  11 #include "core/scores.h"
  12 #include "game-option/runtime-arguments.h"
  13 #include "io/files-util.h"
  14 #include "io/inet.h"
  15 #include "io/record-play-movie.h"
  16 #include "io/signal-handlers.h"
  17 #include "io/uid-checker.h"
  18 #include "main/angband-initializer.h"
  19 #include "player/process-name.h"
  20 #include "system/angband-version.h"
  21 #include "system/angband.h"
  22 #include "system/player-type-definition.h"
  23 #include "system/system-variables.h"
  24 #include "term/gameterm.h"
  25 #include "term/term-color-types.h"
  26 #include "util/angband-files.h"
  27 #include "util/string-processor.h"
  28 #include "view/display-scores.h"
  29 #include "wizard/wizard-spoiler.h"
  30 #include <string>
  31
  32 /*
  33  * Available graphic modes
  34  */
  35 #define GRAPHICS_NONE 0
  36 #define GRAPHICS_ORIGINAL 1
  37 #define GRAPHICS_ADAM_BOLT 2
  38 #define GRAPHICS_HENGBAND 3
  39
  40 /*
  41  * Some machines have a "main()" function in their "main-xxx.c" file,
  42  * all the others use this file for their "main()" function.
  43  */
  44
  45 #ifndef WINDOWS
  46 /*
  47  * A hook for "quit()".
  48  *
  49  * Close down, then fall back into "quit()".
  50  */
  51 static void quit_hook(concptr s)
  52 {
  53     int j;
  54
  55     /* Unused */
  56     (void)s;
  57
  58     /* Scan windows */
  59     for (j = 8 - 1; j >= 0; j--) {
  60         /* Unused */
  61         if (!angband_term[j])
  62             continue;
  63
  64         /* Nuke it */
  65         term_nuke(angband_term[j]);
  66     }
  67 }
  68
  69 /*
  70  * Set the stack size and overlay buffer (see main-286.c")
  71  */
  72 #ifdef PRIVATE_USER_PATH
  73
  74 /*
  75  * Create an ".angband/" directory in the users home directory.
  76  *
  77  * ToDo: Add error handling.
  78  * ToDo: Only create the directories when actually writing files.
  79  */
  80 static void create_user_dir(void)
  81 {
  82     char dirpath[1024];
  83     char subdirpath[1024];
  84
  85     /* Get an absolute path from the filename */
  86     path_parse(dirpath, 1024, PRIVATE_USER_PATH);
  87
  88     /* Create the ~/.angband/ directory */
  89     mkdir(dirpath, 0700);
  90
  91     /* Build the path to the variant-specific sub-directory */
  92     path_build(subdirpath, sizeof(subdirpath), dirpath, VARIANT_NAME.data());
  93
  94     /* Create the directory */
  95     mkdir(subdirpath, 0700);
  96 }
  97
  98 #endif /* PRIVATE_USER_PATH */
  99
 100 /*
 101  * Initialize and verify the file paths, and the score file.
 102  *
 103  * Use the ANGBAND_PATH environment var if possible, else use
 104  * DEFAULT_(LIB|VAR)_PATH, and in either case, branch off
 105  * appropriately.
 106  *
 107  * First, we'll look for the ANGBAND_PATH environment variable,
 108  * and then look for the files in there.  If that doesn't work,
 109  * we'll try the DEFAULT_(LIB|VAR)_PATH constants.  So be sure
 110  * that one of these two things works...
 111  *
 112  * We must ensure that the path ends with "PATH_SEP" if needed,
 113  * since the "init_file_paths()" function will simply append the
 114  * relevant "sub-directory names" to the given path.
 115  *
 116  * Make sure that the path doesn't overflow the buffer.  We have
 117  * to leave enough space for the path separator, directory, and
 118  * filenames.
 119  */
 120 static void init_stuff(void)
 121 {
 122     char libpath[1024], varpath[1024];
 123
 124     concptr tail;
 125
 126     /* Get the environment variable */
 127     tail = getenv("ANGBAND_PATH");
 128
 129     /* Use the angband_path, or a default */
 130     strncpy(libpath, tail ? tail : DEFAULT_LIB_PATH, 511);
 131     strncpy(varpath, tail ? tail : DEFAULT_VAR_PATH, 511);
 132
 133     /* Make sure they're terminated */
 134     libpath[511] = '\0';
 135     varpath[511] = '\0';
 136
 137     /* Hack -- Add a path separator (only if needed) */
 138     if (!suffix(libpath, PATH_SEP))
 139         strcat(libpath, PATH_SEP);
 140     if (!suffix(varpath, PATH_SEP))
 141         strcat(varpath, PATH_SEP);
 142
 143     /* Initialize */
 144     init_file_paths(libpath, varpath);
 145 }
 146
 147 /*
 148  * Handle a "-d<what>=<path>" option
 149  *
 150  * The "<what>" can be any string starting with the same letter as the
 151  * name of a subdirectory of the "lib" folder (i.e. "i" or "info").
 152  *
 153  * The "<path>" can be any legal path for the given system, and should
 154  * not end in any special path separator (i.e. "/tmp" or "~/.ang-info").
 155  */
 156 static void change_path(concptr info)
 157 {
 158     concptr s;
 159
 160     /* Find equal sign */
 161     s = angband_strchr(info, '=');
 162
 163     /* Verify equal sign */
 164     if (!s)
 165         quit_fmt("Try '-d<what>=<path>' not '-d%s'", info);
 166
 167     /* Analyze */
 168     switch (tolower(info[0])) {
 169     case 'a': {
 170         string_free(ANGBAND_DIR_APEX);
 171         ANGBAND_DIR_APEX = string_make(s + 1);
 172         break;
 173     }
 174
 175     case 'f': {
 176         string_free(ANGBAND_DIR_FILE);
 177         ANGBAND_DIR_FILE = string_make(s + 1);
 178         break;
 179     }
 180
 181     case 'h': {
 182         string_free(ANGBAND_DIR_HELP);
 183         ANGBAND_DIR_HELP = string_make(s + 1);
 184         break;
 185     }
 186
 187     case 'i': {
 188         string_free(ANGBAND_DIR_INFO);
 189         ANGBAND_DIR_INFO = string_make(s + 1);
 190         break;
 191     }
 192
 193     case 'u': {
 194         string_free(ANGBAND_DIR_USER);
 195         ANGBAND_DIR_USER = string_make(s + 1);
 196         break;
 197     }
 198
 199     case 'x': {
 200         string_free(ANGBAND_DIR_XTRA);
 201         ANGBAND_DIR_XTRA = string_make(s + 1);
 202         break;
 203     }
 204
 205     case 'b': {
 206         string_free(ANGBAND_DIR_BONE);
 207         ANGBAND_DIR_BONE = string_make(s + 1);
 208         break;
 209     }
 210
 211     case 'd': {
 212         string_free(ANGBAND_DIR_DATA);
 213         ANGBAND_DIR_DATA = string_make(s + 1);
 214         break;
 215     }
 216
 217     case 'e': {
 218         string_free(ANGBAND_DIR_EDIT);
 219         ANGBAND_DIR_EDIT = string_make(s + 1);
 220         break;
 221     }
 222
 223     case 's': {
 224         string_free(ANGBAND_DIR_SAVE);
 225         ANGBAND_DIR_SAVE = string_make(s + 1);
 226         break;
 227     }
 228
 229     case 'z': {
 230         string_free(ANGBAND_DIR_SCRIPT);
 231         ANGBAND_DIR_SCRIPT = string_make(s + 1);
 232         break;
 233     }
 234
 235     default: {
 236         quit_fmt("Bad semantics in '-d%s'", info);
 237     }
 238     }
 239 }
 240
 241 static void display_usage(const char *program)
 242 {
 243     /* Dump usage information */
 244     printf("Usage: %s [options] [-- subopts]\n", program);
 245     puts("  -n       Start a new character");
 246     puts("  -f       Request fiddle mode");
 247     puts("  -w       Request wizard mode");
 248     puts("  -b       Request BGM mode");
 249     puts("  -v       Request sound mode");
 250     puts("  -g       Request graphics mode");
 251     puts("  -o       Request original keyset");
 252     puts("  -r       Request rogue-like keyset");
 253     puts("  -M       Request monochrome mode");
 254     puts("  -s<num>  Show <num> high scores");
 255     puts("  -u<who>  Use your <who> savefile");
 256     puts("  -m<sys>  Force 'main-<sys>.c' usage");
 257     puts("  -d<def>  Define a 'lib' dir sub-path");
 258     puts("  --output-spoilers");
 259     puts("           Output auto generated spoilers and exit");
 260     puts("");
 261
 262 #ifdef USE_X11
 263     puts("  -mx11    To use X11");
 264     puts("  --       Sub options");
 265     puts("  -- -d    Set display name");
 266     puts("  -- -o    Request old 8x8 tile graphics");
 267     puts("  -- -a    Request Adam Bolt 16x16 tile graphics");
 268     puts("  -- -b    Request Bigtile graphics mode");
 269     puts("  -- -s    Turn off smoothscaling graphics");
 270     puts("  -- -n#   Number of terms to use");
 271     puts("");
 272 #endif /* USE_X11 */
 273
 274 #ifdef USE_GCU
 275     puts("  -mgcu    To use GCU (GNU Curses)");
 276 #endif /* USE_GCU */
 277
 278 #ifdef USE_CAP
 279     puts("  -mcap    To use CAP (\"Termcap\" calls)");
 280 #endif /* USE_CAP */
 281
 282     /* Actually abort the process */
 283     quit(nullptr);
 284 }
 285
 286 /*
 287  * @brief 2文字以上のコマンドライン引数 (オプション)を実行する
 288  * @param opt コマンドライン引数
 289  * @return Usageを表示する必要があるか否か
 290  * @details v3.0.0 Alpha21時点では、スポイラー出力モードの判定及び実行を行う
 291  */
 292 static bool parse_long_opt(const char *opt)
 293 {
 294     if (strcmp(opt + 2, "output-spoilers") != 0) {
 295         return true;
 296     }
 297
 298     init_stuff();
 299     init_angband(p_ptr, true);
 300     switch (output_all_spoilers()) {
 301     case SpoilerOutputResultType::SPOILER_OUTPUT_SUCCESS:
 302         puts("Successfully created a spoiler file.");
 303         quit(nullptr);
 304         break;
 305     case SpoilerOutputResultType::SPOILER_OUTPUT_FAIL_FOPEN:
 306         quit("Cannot create spoiler file.");
 307         break;
 308     case SpoilerOutputResultType::SPOILER_OUTPUT_FAIL_FCLOSE:
 309         quit("Cannot close spoiler file.");
 310         break;
 311     default:
 312         break;
 313     }
 314
 315     return false;
 316 }
 317
 318 /*
 319  * Simple "main" function for multiple platforms.
 320  *
 321  * Note the special "--" option which terminates the processing of
 322  * standard options.  All non-standard options (if any) are passed
 323  * directly to the "init_xxx()" function.
 324  */
 325 int main(int argc, char *argv[])
 326 {
 327     int i;
 328
 329     bool done = false;
 330     bool new_game = false;
 331     int show_score = 0;
 332     concptr mstr = nullptr;
 333     bool args = true;
 334
 335     /* Save the "program name" XXX XXX XXX */
 336     argv0 = argv[0];
 337
 338 #ifdef SET_UID
 339
 340     /* Default permissions on files */
 341     (void)umask(022);
 342
 343 #endif
 344
 345     /* Get the file paths */
 346     init_stuff();
 347
 348 #ifdef SET_UID
 349
 350     /* Get the user id (?) */
 351     p_ptr->player_uid = getuid();
 352
 353 #ifdef VMS
 354     /* Mega-Hack -- Factor group id */
 355     p_ptr->player_uid += (getgid() * 1000);
 356 #endif
 357
 358 #ifdef SAFE_SETUID
 359
 360 #ifdef _POSIX_SAVED_IDS
 361
 362     /* Save some info for later */
 363     p_ptr->player_euid = geteuid();
 364     p_ptr->player_egid = getegid();
 365
 366 #endif
 367
 368 #endif
 369
 370 #endif
 371
 372     /* Drop permissions */
 373     safe_setuid_drop();
 374
 375 #ifdef SET_UID
 376
 377     /* Acquire the "user name" as a default player name */
 378     user_name(p_ptr->name, p_ptr->player_uid);
 379
 380 #ifdef PRIVATE_USER_PATH
 381
 382     /* Create a directory for the users files. */
 383     create_user_dir();
 384
 385 #endif /* PRIVATE_USER_PATH */
 386
 387 #endif /* SET_UID */
 388
 389     /* Process the command line arguments */
 390     bool browsing_movie = false;
 391     for (i = 1; args && (i < argc); i++) {
 392         /* Require proper options */
 393         if (argv[i][0] != '-') {
 394             display_usage(argv[0]);
 395             continue;
 396         }
 397
 398         /* Analyze option */
 399         bool is_usage_needed = false;
 400         switch (argv[i][1]) {
 401         case 'N':
 402         case 'n': {
 403             new_game = true;
 404             break;
 405         }
 406         case 'B':
 407         case 'b': {
 408             arg_music = true;
 409             break;
 410         }
 411         case 'V':
 412         case 'v': {
 413             arg_sound = true;
 414             break;
 415         }
 416         case 'G':
 417         case 'g': {
 418             /* HACK - Graphics mode switches on the original tiles */
 419             arg_graphics = GRAPHICS_ORIGINAL;
 420             break;
 421         }
 422         case 'R':
 423         case 'r': {
 424             arg_force_roguelike = true;
 425             break;
 426         }
 427         case 'O':
 428         case 'o': {
 429             arg_force_original = true;
 430             break;
 431         }
 432         case 'S':
 433         case 's': {
 434             show_score = atoi(&argv[i][2]);
 435             if (show_score <= 0)
 436                 show_score = 10;
 437             break;
 438         }
 439         case 'u':
 440         case 'U': {
 441             if (!argv[i][2]) {
 442                 is_usage_needed = true;
 443                 break;
 444             }
 445
 446             strcpy(p_ptr->name, &argv[i][2]);
 447             break;
 448         }
 449         case 'm': {
 450             if (!argv[i][2]) {
 451                 is_usage_needed = true;
 452                 break;
 453             }
 454
 455             mstr = &argv[i][2];
 456             break;
 457         }
 458         case 'M': {
 459             arg_monochrome = true;
 460             break;
 461         }
 462         case 'd':
 463         case 'D': {
 464             change_path(&argv[i][2]);
 465             break;
 466         }
 467         case 'x': {
 468             if (!argv[i][2]) {
 469                 is_usage_needed = true;
 470                 break;
 471             }
 472
 473             prepare_browse_movie_with_path_build(&argv[i][2]);
 474             browsing_movie = true;
 475             break;
 476         }
 477         case '-': {
 478             if (argv[i][2] == '\0') {
 479                 argv[i] = argv[0];
 480                 argc = argc - i;
 481                 argv = argv + i;
 482                 args = false;
 483             } else {
 484                 is_usage_needed = parse_long_opt(argv[i]);
 485             }
 486             break;
 487         }
 488         default: {
 489             is_usage_needed = true;
 490             break;
 491         }
 492         }
 493
 494         if (!is_usage_needed)
 495             continue;
 496
 497         display_usage(argv[0]);
 498     }
 499
 500     /* Hack -- Forget standard args */
 501     if (args) {
 502         argc = 1;
 503         argv[1] = nullptr;
 504     }
 505
 506     /* Process the player name */
 507     process_player_name(p_ptr, true);
 508
 509     /* Install "quit" hook */
 510     quit_aux = quit_hook;
 511
 512 #ifdef USE_XAW
 513     /* Attempt to use the "main-xaw.c" support */
 514     if (!done && (!mstr || (streq(mstr, "xaw")))) {
 515         extern errr init_xaw(int, char **);
 516         if (0 == init_xaw(argc, argv)) {
 517             ANGBAND_SYS = "xaw";
 518             done = true;
 519         }
 520     }
 521 #endif
 522
 523 #ifdef USE_X11
 524     /* Attempt to use the "main-x11.c" support */
 525     if (!done && (!mstr || (streq(mstr, "x11")))) {
 526         extern errr init_x11(int, char **);
 527         if (0 == init_x11(argc, argv)) {
 528             ANGBAND_SYS = "x11";
 529             done = true;
 530         }
 531     }
 532 #endif
 533
 534 #ifdef USE_GCU
 535     /* Attempt to use the "main-gcu.c" support */
 536     if (!done && (!mstr || (streq(mstr, "gcu")))) {
 537         extern errr init_gcu(int, char **);
 538         if (0 == init_gcu(argc, argv)) {
 539             ANGBAND_SYS = "gcu";
 540             done = true;
 541         }
 542     }
 543 #endif
 544
 545 #ifdef USE_CAP
 546     /* Attempt to use the "main-cap.c" support */
 547     if (!done && (!mstr || (streq(mstr, "cap")))) {
 548         extern errr init_cap(int, char **);
 549         if (0 == init_cap(argc, argv)) {
 550             ANGBAND_SYS = "cap";
 551             done = true;
 552         }
 553     }
 554 #endif
 555
 556     /* Make sure we have a display! */
 557     if (!done)
 558         quit("Unable to prepare any 'display module'!");
 559
 560     /* Hack -- If requested, display scores and quit */
 561     if (show_score > 0)
 562         display_scores(0, show_score);
 563
 564     /* Catch nasty signals */
 565     signals_init();
 566
 567     /* Initialize */
 568     init_angband(p_ptr, false);
 569
 570     /* Wait for response */
 571     pause_line(23);
 572
 573     /* Play the game */
 574     play_game(p_ptr, new_game, browsing_movie);
 575
 576     /* Quit */
 577     quit(nullptr);
 578
 579     /* Exit */
 580     return (0);
 581 }
 582
 583 #endif