art::BasicOptionsHandler Class Reference

#include "BasicOptionsHandler.h"

Inheritance diagram for art::BasicOptionsHandler:

Public Member Functions
	BasicOptionsHandler (bpo::options_description &desc, cet::filepath_maker &maker, bool report_unused)
int	checkOptions (bpo::variables_map const &vm)
int	processOptions (bpo::variables_map const &vm, fhicl::intermediate_table &raw_config)

Private Member Functions
int	doCheckOptions (bpo::variables_map const &vm) override
int	doProcessOptions (bpo::variables_map const &vm, fhicl::intermediate_table &raw_config) override

Private Attributes
bpo::options_description const &	help_desc_
cet::filepath_maker &	maker_

Detailed Description

Definition at line 13 of file BasicOptionsHandler.h.

Constructor & Destructor Documentation

art::BasicOptionsHandler::BasicOptionsHandler	(	bpo::options_description &	desc,
		cet::filepath_maker &	maker,
		bool	report_unused
	)

Definition at line 28 of file BasicOptionsHandler.cc.

References art::getReleaseVersion(), maker_, art::Suffixes::print(), art::to_string(), and value.

  : help_desc_{desc}, maker_{maker}
{
  // clang-format off
  desc.add_options()
    ("help,h", "produce help message")
    ("version", ("Print art version (" + getReleaseVersion() + ")").c_str())
    ("config,c", bpo::value<std::string>(), "Configuration file.")
    ("process-name", bpo::value<std::string>(), "art process name.")
    ("prune-config",
       bpo::value<bool>()->default_value(true, to_string(true)),
       "Remove unused modules and paths from the fully-processed configuration.")
    ("report-unused",
       bpo::value<bool>()->default_value(report_unused, to_string(report_unused)),
       "If 'true', the list of unused modules and paths will be printed to STDERR.")
    ("print-available",
       bpo::value<std::string>(),
       ("List all available plugins with the provided suffix.  Choose from:"s +
        Suffixes::print()).c_str())
    ("print-available-modules",
       "List all available modules that can be invoked in a FHiCL file.")
    ("print-available-services",
       "List all available services that can be invoked in a FHiCL file.")
    ("print-description",
       bpo::value<std::vector<std::string>>()->multitoken(),
       "Print description of specified module, service, source, or other "
       "plugin (multiple OK).  Argument can be a regular expression used "
       "to match the plugin specification.  To narrow the search to "
       "plugins with a particular suffix, preface the regular expression"
       "with the suffix (e.g. service:TFileService).")
    ("status-bar",
       "Provide status bar that reports the progress of retrieving "
       "plugin information for a 'print-available' command.");
  // clang-format on
}

Member Function Documentation

int art::OptionsHandler::checkOptions ( bpo::variables_map const &  vm )

inherited

Definition at line 51 of file OptionsHandler.cc.

References art::OptionsHandler::doCheckOptions().

{
  std::string const thisClass(cet::demangle_symbol(typeid(*this).name()));
  return exceptionCatcher([&vm, this] { return doCheckOptions(vm); },
                          thisClass + "::doCheckOptions()",
                          89);
}

int art::BasicOptionsHandler::doCheckOptions ( bpo::variables_map const &  vm )

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 67 of file BasicOptionsHandler.cc.

References art::errors::Configuration, art::getReleaseVersion(), help_desc_, art::detail::info_success(), art::Suffixes::module(), art::detail::print_available_plugins(), art::detail::print_descriptions(), and art::Suffixes::service().

{
  // Technically the "help" and "print*" options are processing steps,
  // but we want to short-circuit.
  if (vm.count("help")) {
    // Could simply do cout << help_desc_, but the boost-provided
    // printout does not add any left-hand padding.  Will add a
    // 2-space tab by hand.
    std::stringstream ss;
    ss << help_desc_; // Note NOT our own desc_.
    for (std::string s; std::getline(ss, s);)
      std::cout << std::string(2, ' ') << s << '\n';
    std::cout << '\n';
    return detail::info_success();
  }
  bool const status_bar = vm.count("status-bar") > 0;
  if (vm.count("print-available")) {
    detail::print_available_plugins(vm["print-available"].as<std::string>(),
                                    status_bar);
    return detail::info_success();
  }
  if (vm.count("print-available-modules")) {
    detail::print_available_plugins(Suffixes::module(), status_bar);
    return detail::info_success();
  }
  if (vm.count("print-available-services")) {
    detail::print_available_plugins(Suffixes::service(), status_bar);
    return detail::info_success();
  }
  if (status_bar) {
    throw Exception(errors::Configuration)
      << "The '--status-bar' option can be used only with the "
         "'--print-available*' program options.\n";
  }

  if (vm.count("print-description")) {
    detail::print_descriptions(
      vm["print-description"].as<std::vector<std::string>>());
    return detail::info_success();
  }
  if (vm.count("version")) {
    std::cout << "art " << getReleaseVersion() << '\n';
    return detail::info_success();
  }

  if (!vm.count("config")) {
    throw Exception(errors::Configuration) << "No configuration file given.\n";
  }
  return 0;
}

int art::BasicOptionsHandler::doProcessOptions ( bpo::variables_map const &  vm, fhicl::intermediate_table &  raw_config  )

overrideprivatevirtual

Implements art::OptionsHandler.

Definition at line 119 of file BasicOptionsHandler.cc.

References e, fhicl::intermediate_table::empty(), maker_, fhicl::parse_document(), and fhicl::intermediate_table::put().

{
  try {
    raw_config = fhicl::parse_document(vm["config"].as<std::string>(), maker_);
  }
  catch (cet::exception& e) {
    std::cerr << "Failed to parse the configuration file '"
              << vm["config"].as<std::string>() << "' with exception\n"
              << e.what() << '\n';
    return 90;
  }
  if (raw_config.empty()) {
    std::cerr << "INFO: provided configuration file '"
              << vm["config"].as<std::string>() << "' is empty: \n"
              << "using minimal defaults and command-line options.\n";
  }
  if (vm.count("process-name")) {
    raw_config.put("process_name", vm["process-name"].as<std::string>());
  }
  if (vm.count("prune-config")) {
    raw_config.put("services.scheduler.pruneConfig",
                   vm["prune-config"].as<bool>());
  }
  if (vm.count("report-unused")) {
    raw_config.put("services.scheduler.reportUnused",
                   vm["report-unused"].as<bool>());
  }
  return 0;
}

int art::OptionsHandler::processOptions ( bpo::variables_map const &  vm, fhicl::intermediate_table &  raw_config  )

inherited

Definition at line 60 of file OptionsHandler.cc.

References art::OptionsHandler::doProcessOptions().

{
  std::string const thisClass(cet::demangle_symbol(typeid(*this).name()));
  return exceptionCatcher(
    [&, this] { return doProcessOptions(vm, raw_config); },
    thisClass + "::doProcessOptions()",
    90);
}

Member Data Documentation

bpo::options_description const& art::BasicOptionsHandler::help_desc_

private

Definition at line 27 of file BasicOptionsHandler.h.

Referenced by doCheckOptions().

cet::filepath_maker& art::BasicOptionsHandler::maker_

private

Definition at line 28 of file BasicOptionsHandler.h.

Referenced by BasicOptionsHandler(), and doProcessOptions().

---

The documentation for this class was generated from the following files:

• art/Framework/Art/BasicOptionsHandler.h
• art/Framework/Art/BasicOptionsHandler.cc