b2cli.H

Go to the documentation of this file.

//------------------------------------------------------------------------
// b2cli.H --
//
//      Command Line Interface functions for B2000++.
//
// written by Mathias Doreille
//            Harald Klimach <harald.klimach@dlr.de>
//            Neda Ebrahimi Pour <neda.ebrahimipour@dlr.de>
//
// (c) 2004-2018 SMR Engineering & Development SA
//               2502 Bienne, Switzerland
//
// (c) 2022 Deutsches Zentrum für Luft- und Raumfahrt (DLR) e.V.
//          Linder Höhe, 51147 Köln
//
// All Rights Reserved.  Proprietary source code.  The contents of
// this file may not be disclosed to third parties, copied or
// duplicated in any form, in whole or in part, without the prior
// written permission of SMR or DLR.
//
//------------------------------------------------------------------------
 
#ifndef B2CLI_H_
#define B2CLI_H_
 
#include <iostream>
#include <memory>
 
#include "b2ppconfig.h"
#include "utils/b2cmdline.H"
#include "utils/b2comm.H"
 
namespace b2000 {
 
 
class cli {
public:
    explicit cli(
          std::shared_ptr<Communicator> comm, std::ostream& out = std::cout,
          std::ostream& err = std::cerr)
        : out{out}, err{err}, comm{comm} {}
 
    // Output stream to use for this CLI
    std::ostream& out;
    // Error stream to use for this CLI
    std::ostream& err;
 
    cmdline::CmdOpt<bool> short_help{"h", "", "Print a one-line help message and exit."};
 
    cmdline::CmdOpt<bool> long_help{"help", "", "Print this help message and exit."};
 
    cmdline::CmdOpt<bool> version{"version", "", "Print the program version and exit."};
 
    cmdline::CmdOptRTable var_rtable{
          "define", "", "Define MDL variable=value to be passed to b2ip++."};
 
    cmdline::CmdOptDictionary adir{
          "adir", "",
          "Update or add an analysis directive key/value of the form key=value"
          " or key='value1 value2 ...'."};
 
    cmdline::CmdOptList<> log_dir_list{
          "l", "LOG_DIR",
          "Add a logging directive of the form"
          " '(critical|error|warning|info|data|debug) of <logger>"
          " in (err|cerr|out|cout|file:filename|db|raise)'."
          " The available loggers can be obtained with"
          " the --list-loggers option."};
 
    cmdline::CmdOpt<int> max_cpu_time{
          "max-cpu", "TIME",
          "Set CPU time limit (in seconds)."
          " B2000++ aborts when this limit is reached.",
          -1};
 
    cmdline::CmdOpt<int> max_vmemory_size{
          "max-mem", "SIZE",
          "Set the limit for the virtual memory size (in MBytes)."
          " B2000++ aborts when this limit is reached",
          -1};
 
    cmdline::CmdOpt<bool> get_list_logger{
          "list-loggers", "",
          "At the end of the program execution, print a list of the encountered "
          "loggers."};
 
    cmdline::CmdOpt<> db_type{
          "t", "DATABASE_TYPE", "Specify the database version to process.", "b2dbv3"};
 
#ifdef HAVE_LIB_TBB
    cmdline::CmdOpt<int> nb_threads{
          "nb-threads", "N", "Number of threads to use (default = automatic).", -1};
#endif
 
    cmdline::CmdOpt<bool> get_list_type{
          "list-types", "",
          "Print a list of the available object types at startup and exit "
          "(for developers)."};
 
    cmdline::CmdOpt<bool> nocatch{
          "nocatch", "",
          "Do not catch the exception or the signal in the main function"
          " (for debugging purpose)."};
 
    cmdline::CmdOpt<bool> valgrind{
          "valgrind", "",
          "Start b2000++ in valgrind (for debugging purpose,"
          " must be the first argument)."};
 
    cmdline::CmdOpt<bool> gdb{
          "gdb", "",
          "Start b2000++ in gdb (for debugging purpose,"
          " must be the first argument)."};
 
    cmdline::CmdOpt<bool> backtrace{
          "backtrace", "",
          "Extract backtrace with gdb if unexpected termination"
          " (for debugging purpose, must be the first argument)."};
 
#ifdef HAVE_FEENABLEEXCEPT
    cmdline::CmdOpt<bool> fexp{
          "fexp", "",
          "Enable traps of floating point exceptions FE_DIVBYZERO, FE_INVALID"
          " and FE_OVERFLOW (for debugging purposes only)."};
#endif
 
    cmdline::CmdOpt<int> timer_max_rank{
          "timer-maxrank", "N", "Number of ranks to write timing information (default=1)", 1};
 
    cmdline::CmdArg<> db_name{
          "DBNAME", "The b2000 database to process or an MDL input file to be read."};
 
    void PrintVersion() const;
 
 
    void ProcessCmdOpts(cmdline::CmdLine& cline);
 
    inline void Abort(int use_err = 1) {
        comm->Abort(use_err);
        exit(use_err);
    }
 
private:
    // Pointer to communicator in parallel executions
    std::shared_ptr<Communicator> comm;
 
    void ParseOpts(cmdline::CmdLine& cline, bool opts_only = false);
 
    void ActOnCmd(cmdline::CmdLine& cline);
};  // class cli
 
inline void PrintShortHelp(std::ostream& out, const cmdline::CmdLine& cline) {
    out << "Usage: ";
    cline.print_short_desc(out);
    out << std::endl;
}
 
}  // namespace b2000
 
#endif  // B2CLI_H_