ConfigurationParser Struct Reference

Classes
struct	opt

Public Types
enum	error {   Success, InvalidNumber, InvalidOption, LogicError,   ExtraArguments, MissingArgument }

Static Public Member Functions
static error	parse (ConfigurationParameters &params, unsigned int argc, char **argv)
static void	printHelp (int exitCode=0, const char *progName="simplifyGDML")

Static Public Attributes
static const unsigned int	DefaultDebugLevel = 1

Detailed Description

Definition at line 90 of file simplifyGDML.cc.

Member Enumeration Documentation

enum ConfigurationParser::error

Enumerator
Success
InvalidNumber
InvalidOption
LogicError
ExtraArguments
MissingArgument

Definition at line 94 of file simplifyGDML.cc.

               {
    Success,
    InvalidNumber,
    InvalidOption,
    LogicError,
    ExtraArguments,
    MissingArgument
  } error;

Member Function Documentation

ConfigurationParser::error ConfigurationParser::parse ( ConfigurationParameters &  params, unsigned int  argc, char **  argv  )

static

Definition at line 175 of file simplifyGDML.cc.

{
  static const option longopts[] = {
    { "validate",  no_argument,       NULL, opt::Validate  },
    { "schema",    required_argument, NULL, opt::Schema    },
    { "setup",     required_argument, NULL, opt::Setup     },
    { "overwrite", no_argument,       NULL, opt::Overwrite },
    { "nowrite",   no_argument,       NULL, opt::NoWrite   },
    { "debug",     optional_argument, NULL, opt::Debug     },
    { "help",      no_argument,       NULL, opt::Help      },
//    { "one",      no_argument,       &value, 1 },
//    { "two",      no_argument,       &value, 2 },
    { NULL,        0,                 NULL, 0 }
  }; // longopts

  // automatically build the short option string from the long one
  std::string shortopts = ":"; // this means no error printout
  for (auto const& longopt: longopts) {
    if (!longopt.name) break;
    if (longopt.val == 0) continue;
    shortopts += (char) longopt.val;
    if (longopt.has_arg != no_argument) shortopts += ':';
    if (longopt.has_arg == optional_argument) shortopts += ':';
  } // for

  // ----------------------------------------------------------------------
  // options
  error res = error::Success;
  char ch;
  optind = 1;
  bool forgiving = false;
  while
    ((ch = getopt_long(argc, argv, shortopts.c_str(), longopts, NULL)) != -1)
  {
    switch (ch) {
      case opt::Validate:
        params.validate = true;
        continue;
      case opt::Setup:
        params.setupName = optarg;
        continue;
      case opt::Schema:
        params.schemaPath = optarg;
        continue;
      case opt::Overwrite:
        params.overwrite = true;
        continue;
      case opt::NoWrite:
        params.dontWrite = true;
        continue;
      case opt::Debug:
        if (optarg) {
          std::istringstream sstr(optarg);
          sstr >> params.debugLevel;
          if (!sstr) {
            std::cerr << "Invalid debug level: '" << optarg << "'" << std::endl;
            res = error::InvalidNumber;
            continue;
          }
        }
        else params.debugLevel = DefaultDebugLevel;
        continue;
      case '?': // this is special since has a specific meaning for getopt()
        if (optopt != '?') {
          if (!forgiving) {
            std::cerr
              << "Invalid option: '" << argv[optind-1] << "'" << std::endl;
          }
          res = error::InvalidOption;
          continue;
        }
        // follow into:
      case opt::Help:
        params.help = true;
        forgiving = true;
        continue;
      default:
        std::cerr << "Internal error: option '" << ch << "' not supported yet."
          << std::endl;
        res = error::LogicError;
        continue;
     } // switch
  } // while

  // ----------------------------------------------------------------------
  // arguments
  if (optind >= (int) argc) {
    if (!forgiving) std::cerr << "Source file name is required!" << std::endl;
    return error::MissingArgument;
  }
  params.sourcePath = argv[optind++];
  if (optind < (int) argc) params.destPath = argv[optind++];

  if (optind < (int) argc) {
    if (!forgiving) {
      std::cerr << "Spurious arguments: '" << argv[optind] << "'";
      if (optind + 1 < (int) argc)
        std::cerr << " and " << (argc - optind - 1) << " more";
      std::cerr << "." << std::endl;
    }
    return error::ExtraArguments;
  }

  // ----------------------------------------------------------------------
  return res;
} // ConfigurationParser::parse()

void ConfigurationParser::printHelp ( int  exitCode = 0, const char *  progName = "simplifyGDML"  )

static

Definition at line 116 of file simplifyGDML.cc.

{
  std::cout <<
      "Asks GEANT4 to process and rewrite a GDML file."
      " This effectively simplifies the complexity of constructs in the GDML"
      " code."
    "\n"
    "\nUsage:  " << progName << "  [options] [--] inputPath [outputPath]"
    "\n"
    "\nThe output file will contain the world volume of the specified setup."
    "\nIt must be different from the input file:"
      " GEANT4 will refuse to overwrite."
    "\n"
    "\nNOTE: the path to the GDML schema in the output may need to be fixed by"
      " hand."
    "\nTo allow validation, the GDML schema must be present as described in the"
      " header of the GDML file."
    "\nLArSoft does not necessarily distributes GDML schema, so these lines"
      " are aimed to load them from network:"
    "\n"
    "\n<gdml xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    "\n      xsi:noNamespaceSchemaLocation=\"http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd\""
    "\n      >"
    "\n"
    "\nOptions:"
    "\n--validate , -V"
    "\n    ask Geant4 to validated the GDML while reading (validation output"
    "\n    will be on screen, with no effect to the rest of the program)"
    "\n--overwrite , -f"
    "\n    not implemented yet"
    "\n--nowrite , -r"
    "\n    only read (and validate as requested), do not write a new GDML file"
    "\n--setup=SETUPNAME , -s SETUPNAME"
    "\n    name of path or URL to the schema to use for writing."
    "\n    By default, the '" << ConfigurationParameters::DefaultSetupName
      << "' setup is chosen."
    "\n--schema=SCHEMAURL , -S SCHEMAURL"
    "\n    path or URL to the schema to use for writing."
    "\n    By default, the '" << ConfigurationParameters::DefaultSchemaURL
      << "' schema is used."
    "\n--help , -h , -?"
    "\n    print these usage instructions and exit"
    "\n"
    << std::endl;
  if (exitCode >= 0) std::exit(exitCode);
} // ConfigurationParser::printHelp()

Member Data Documentation

const unsigned int ConfigurationParser::DefaultDebugLevel = 1

static

Definition at line 92 of file simplifyGDML.cc.

---

The documentation for this struct was generated from the following file:

• larsim/larsim/GDMLUtils/simplifyGDML.cc