ruledit.cpp

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
// ANSI
#include <stdlib.h>
 
#include <signal.h>
 
// utility
#include "executable.h"
#include "fc_cmdline.h"
#include "fciconv.h"
#include "fcintl.h"
#include "log.h"
#include "registry.h"
 
// common
#include "fc_cmdhelp.h"
#include "fc_interface.h"
#include "version.h"
 
// server
#include "sernet.h"
#include "settings.h"
 
// tools/shared
#include "tools_fc_interface.h"
 
// ruledit
#include "comments.h"
 
#include "ruledit.h"
 
static int re_parse_cmdline(int argc, char *argv[]);
 
struct ruledit_arguments reargs;
 
static int fatal_assertions = -1;
 
/**********************************************************************/
int main(int argc, char **argv)
{
  int ui_options;
  int exit_status = EXIT_SUCCESS;
 
  executable_init();
 
  /* Initialize the fc_interface functions needed to understand rules.
   * fc_interface_init_tool() includes low level support like
   * guaranteeing that fc_vsnprintf() will work after it,
   * so this need to be early. */
  fc_interface_init_tool();
 
#ifdef ENABLE_NLS
  (void) bindtextdomain("freeciv-ruledit", get_locale_dir());
#endif
 
  init_character_encodings(FC_DEFAULT_DATA_ENCODING, FALSE);
#ifdef ENABLE_NLS
  bind_textdomain_codeset("freeciv-ruledit", get_internal_encoding());
#endif
 
  registry_module_init();
 
  // Initialize command line arguments.
  reargs.ruleset = nullptr;
 
  ui_options = re_parse_cmdline(argc, argv);
 
  if (ui_options != -1) {
    init_connections();
 
    settings_init(FALSE);
 
    // Reset aifill to zero
    game.info.aifill = 0;
 
    game_init(FALSE);
 
    i_am_tool();
 
    if (comments_load()) {
      ruledit_qt_run(ui_options, argv);
 
      comments_free();
    } else {
      /* TRANS: 'Failed to load comments-x.y.txt' where x.y is
       * freeciv version */
      log_error(R__("Failed to load %s."), COMMENTS_FILE_NAME);
 
      exit_status = EXIT_FAILURE;
    }
  }
 
  registry_module_close();
  log_close();
  libfreeciv_free();
 
  // Clean up command line arguments.
  cmdline_option_values_free();
 
  return exit_status;
}
 
/**********************************************************************/
static int re_parse_cmdline(int argc, char *argv[])
{
  enum log_level loglevel = LOG_NORMAL;
  int i = 1;
  bool ui_separator = FALSE;
  int ui_options = 0;
 
  while (i < argc) {
    char *option;
 
    if (ui_separator) {
      argv[1 + ui_options] = argv[i];
      ui_options++;
    } else if (is_option("--help", argv[i])) {
      struct cmdhelp *help = cmdhelp_new(argv[0]);
 
      cmdhelp_add(help, "h", "help",
                  R__("Print a summary of the options"));
#ifdef FREECIV_DEBUG
      cmdhelp_add(help, "d",
                  // TRANS: "debug" is exactly what user must type, do not translate.
                  R__("debug LEVEL"),
                  R__("Set debug log level (one of f,e,w,n,v,d, or "
                      "d:file1,min,max:...)"));
#else  /* FREECIV_DEBUG */
      cmdhelp_add(help, "d",
                  // TRANS: "debug" is exactly what user must type, do not translate.
                  R__("debug LEVEL"),
                  R__("Set debug log level (one of f,e,w,n,v)"));
#endif /* FREECIV_DEBUG */
      cmdhelp_add(help, "v", "version",
                  R__("Print the version number"));
      cmdhelp_add(help, "r",
                  // TRANS: argument (don't translate) VALUE (translate)
                  R__("ruleset RULESET"),
                  R__("Ruleset to use as the starting point."));
#ifndef FREECIV_NDEBUG
      cmdhelp_add(help, "F",
                  // TRANS: "Fatal" is exactly what user must type, do not translate.
                  R__("Fatal [SIGNAL]"),
                  R__("Raise a signal on failed assertion"));
#endif // FREECIV_NDEBUG
      /* The function below prints a header and footer for the options.
       * Furthermore, the options are sorted. */
      cmdhelp_display(help, TRUE, TRUE, TRUE);
      cmdhelp_destroy(help);
 
      exit(EXIT_SUCCESS);
    } else if (is_option("--version", argv[i])) {
      fc_fprintf(stderr, "%s \n", freeciv_name_version());
 
      exit(EXIT_SUCCESS);
    } else if ((option = get_option_malloc("--ruleset", argv, &i, argc, true))) {
      if (reargs.ruleset) {
        fc_fprintf(stderr, R__("Can only edit one ruleset at a time.\n"));
      } else {
        reargs.ruleset = option;
      }
    } else if ((option = get_option_malloc("--debug", argv, &i, argc, FALSE))) {
      if (!log_parse_level_str(option, &loglevel)) {
        fc_fprintf(stderr,
                   R__("Invalid debug level \"%s\" specified with --debug "
                       "option.\n"), option);
        fc_fprintf(stderr, R__("Try using --help.\n"));
        exit(EXIT_FAILURE);
      }
      free(option);
#ifndef FREECIV_NDEBUG
    } else if (is_option("--Fatal", argv[i])) {
      if (i + 1 >= argc || '-' == argv[i + 1][0]) {
        fatal_assertions = SIGABRT;
      } else if (str_to_int(argv[i + 1], &fatal_assertions)) {
        i++;
      } else {
        fc_fprintf(stderr, R__("Invalid signal number \"%s\".\n"),
                   argv[i + 1]);
        fc_fprintf(stderr, R__("Try using --help.\n"));
        exit(EXIT_FAILURE);
      }
#endif // FREECIV_NDEBUG
    } else if (is_option("--", argv[i])) {
      ui_separator = TRUE;
    } else {
      fc_fprintf(stderr, R__("Unrecognized option: \"%s\"\n"), argv[i]);
      exit(EXIT_FAILURE);
    }
 
    i++;
  }
 
  log_init(nullptr, loglevel, nullptr, nullptr, fatal_assertions);
 
  return ui_options;
}