wallet_args Namespace Reference

Functions
command_line::arg_descriptor< std::string >	arg_generate_from_json ()
command_line::arg_descriptor< std::string >	arg_wallet_file ()
const char *	tr (const char *str)
std::pair< boost::optional< boost::program_options::variables_map >, bool >	main (int argc, char **argv, const char *const usage, const char *const notice, boost::program_options::options_description desc_params, const boost::program_options::positional_options_description &positional_options, const std::function< void(const std::string &, bool)> &print, const char *default_log_name, bool log_to_console)

Function Documentation

arg_generate_from_json()

command_line::arg_descriptor< std::string > wallet_args::arg_generate_from_json

(

)

Definition at line 72 of file wallet_args.cpp.

  {
    return {"generate-from-json", wallet_args::tr("Generate wallet from JSON format file"), ""};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

arg_wallet_file()

command_line::arg_descriptor< std::string > wallet_args::arg_wallet_file

(

)

Definition at line 76 of file wallet_args.cpp.

  {
    return {"wallet-file", wallet_args::tr("Use wallet <arg>"), ""};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

main()

std::pair< boost::optional< boost::program_options::variables_map >, bool > wallet_args::main	(	int	argc,
		char **	argv,
		const char *const	usage,
		const char *const	notice,
		boost::program_options::options_description	desc_params,
		const boost::program_options::positional_options_description &	positional_options,
		const std::function< void(const std::string &, bool)> &	print,
		const char *	default_log_name,
		bool	log_to_console = false )

Processes command line arguments (argc and argv) using desc_params and positional_options, while adding parameters for log files and concurrency. Log file and concurrency arguments are handled, along with basic global init for the wallet process.

Returns

pair.first: The list of parsed options, iff there are no errors. pair.second: Should the execution terminate succesfully without actually launching the application

Definition at line 86 of file wallet_args.cpp.

  {
    namespace bf = boost::filesystem;
    namespace po = boost::program_options;
#ifdef WIN32
    _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
#endif
 
    const command_line::arg_descriptor<std::string> arg_log_level = {"log-level", "0-4 or categories", ""};
    const command_line::arg_descriptor<std::size_t> arg_max_log_file_size = {"max-log-file-size", "Specify maximum log file size [B]", MAX_LOG_FILE_SIZE};
    const command_line::arg_descriptor<std::size_t> arg_max_log_files = {"max-log-files", "Specify maximum number of rotated log files to be saved (no limit by setting to 0)", MAX_LOG_FILES};
    const command_line::arg_descriptor<uint32_t> arg_max_concurrency = {"max-concurrency", wallet_args::tr("Max number of threads to use for a parallel job"), DEFAULT_MAX_CONCURRENCY};
    const command_line::arg_descriptor<std::string> arg_log_file = {"log-file", wallet_args::tr("Specify log file"), ""};
    const command_line::arg_descriptor<std::string> arg_config_file = {"config-file", wallet_args::tr("Config file"), "", true};
 
 
    std::string lang = i18n_get_language();
    tools::on_startup();
#ifdef NDEBUG
    tools::disable_core_dumps();
#endif
    tools::set_strict_default_file_permissions(true);
 
    epee::string_tools::set_module_name_and_folder(argv[0]);
 
    po::options_description desc_general(wallet_args::tr("General options"));
    command_line::add_arg(desc_general, command_line::arg_help);
    command_line::add_arg(desc_general, command_line::arg_version);
 
    command_line::add_arg(desc_params, arg_log_file);
    command_line::add_arg(desc_params, arg_log_level);
    command_line::add_arg(desc_params, arg_max_log_file_size);
    command_line::add_arg(desc_params, arg_max_log_files);
    command_line::add_arg(desc_params, arg_max_concurrency);
    command_line::add_arg(desc_params, arg_config_file);
 
    i18n_set_language("translations", "electroneum", lang);
 
    po::options_description desc_all;
    desc_all.add(desc_general).add(desc_params);
    po::variables_map vm;
    bool should_terminate = false;
    bool r = command_line::handle_error_helper(desc_all, [&]()
    {
      auto parser = po::command_line_parser(argc, argv).options(desc_all).positional(positional_options);
      po::store(parser.run(), vm);
 
      if (command_line::get_arg(vm, command_line::arg_help))
      {
        Print(print) << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")" << ENDL;
        Print(print) << wallet_args::tr("This is the command line electroneum wallet. It needs to connect to a electroneum\n"
                                                  "daemon to work correctly.") << ENDL;
        Print(print) << wallet_args::tr("Usage:") << ENDL << "  " << usage;
        Print(print) << desc_all;
        should_terminate = true;
        return true;
      }
      else if (command_line::get_arg(vm, command_line::arg_version))
      {
        Print(print) << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")";
        should_terminate = true;
        return true;
      }
 
      if(command_line::has_arg(vm, arg_config_file))
      {
        std::string config = command_line::get_arg(vm, arg_config_file);
        bf::path config_path(config);
        boost::system::error_code ec;
        if (bf::exists(config_path, ec))
        {
          po::store(po::parse_config_file<char>(config_path.string<std::string>().c_str(), desc_params), vm);
        }
        else
        {
          MERROR(wallet_args::tr("Can't find config file ") << config);
          return false;
        }
      }
 
      po::notify(vm);
      return true;
    });
    if (!r)
      return {boost::none, true};
 
    if (should_terminate)
      return {std::move(vm), should_terminate};
 
    std::string log_path;
    if (!command_line::is_arg_defaulted(vm, arg_log_file))
      log_path = command_line::get_arg(vm, arg_log_file);
    else
      log_path = mlog_get_default_log_path(default_log_name);
    mlog_configure(log_path, log_to_console, command_line::get_arg(vm, arg_max_log_file_size), command_line::get_arg(vm, arg_max_log_files));
    if (!command_line::is_arg_defaulted(vm, arg_log_level))
    {
      mlog_set_log(command_line::get_arg(vm, arg_log_level).c_str());
    }
    else if (!log_to_console)
    {
      mlog_set_categories("");
    }
 
    if (command_line::get_arg(vm, command_line::arg_help))
    {
      Print(print) << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")" << ENDL;
      Print(print) << wallet_args::tr("This is the command line electroneum wallet. It needs to connect to a electroneum\n"
                                                "daemon to work correctly.") << ENDL;
      Print(print) << wallet_args::tr("Usage:") << ENDL << "  " << usage;
      Print(print) << desc_all;
      return {boost::none, true};
    }
    else if (command_line::get_arg(vm, command_line::arg_version))
    {
      Print(print) << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")";
      return {boost::none, true};
    }
 
    if (notice)
      Print(print) << notice << ENDL;
 
    if (!command_line::is_arg_defaulted(vm, arg_max_concurrency))
      tools::set_max_concurrency(command_line::get_arg(vm, arg_max_concurrency));
 
    Print(print) << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")";
 
    if (!command_line::is_arg_defaulted(vm, arg_log_level))
      MINFO("Setting log level = " << command_line::get_arg(vm, arg_log_level));
    else
      MINFO("Setting log levels = " << getenv("ELECTRONEUM_LOGS"));
    MINFO(wallet_args::tr("Logging to: ") << log_path);
 
    Print(print) << boost::format(wallet_args::tr("Logging to %s")) % log_path;
 
    const ssize_t lockable_memory = tools::get_lockable_memory();
    if (lockable_memory >= 0 && lockable_memory < 256 * 4096) // 256 pages -> at least 256 secret keys and other such small/medium objects
      Print(print) << tr("WARNING: You may not have a high enough lockable memory limit")
#ifdef ELPP_OS_UNIX
        << ", " << tr("see ulimit -l")
#endif
        ;
 
    return {std::move(vm), should_terminate};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

tr()

const char * wallet_args::tr

(

const char *

str

)

Definition at line 81 of file wallet_args.cpp.

  {
    return i18n_translate(str, "wallet_args");
  }

Here is the call graph for this function:

Here is the caller graph for this function: