inc/CommandLineParserBase.h

   1 //! \file CommandLineParserBase.h
   2
   3 #ifndef WIKIWALKER_ACOMMANDLINEPARSER_H
   4 #define WIKIWALKER_ACOMMANDLINEPARSER_H
   5
   6 #include <string>
   7
   8 namespace WikiWalker
   9 {
  10   //! Abstract base class for parsing command line arguments
  11   class CommandLineParserBase
  12   {
  13   public:
  14     //! possible command line flags
  15     enum class CommandLineOptions {
  16       //! version
  17       Version,
  18       //! help
  19       Help,
  20       //! URL argument
  21       URL,
  22       //! cache option
  23       JsonCache,
  24       //! Graphviz output option
  25       DotOut,
  26       //! whether to use "deep mode"
  27       FetchDeep,
  28       //! whether to skip ssl verification
  29       SkipSslVerification
  30     };
  31
  32     //! virtual base class d'tor
  33     virtual ~CommandLineParserBase() = default;
  34
  35     /*! Parses command line args and stores results internally.
  36      * May throw an exception in case of error
  37      * \param argc number of arguments
  38      * \param argv arguments as passed to main
  39      */
  40     virtual void parse(int argc, char** argv) = 0;
  41
  42     /*! Query whether a specific flag was set on command line.
  43      * \param flag Command line switch
  44      * \return whether specified flag was set on command line
  45      */
  46     virtual bool hasSet(CommandLineOptions flag) = 0;
  47
  48     /*! get argument of switch (if available)
  49      * \param option command line options
  50      * \returns value as string
  51      */
  52     virtual std::string getValue(CommandLineOptions option) = 0;
  53
  54     /*! Print usage help
  55      */
  56     virtual void printHelp() = 0;
  57   };
  58 }  // namespace WikiWalker
  59 #endif  // WIKIWALKER_ACOMMANDLINEPARSER_H