src/cmd.h

   1 /******************************
   2 ** Tsunagari Tile Engine     **
   3 ** cmd.h                     **
   4 ** Copyright 2011 OmegaSDG   **
   5 ******************************/
   6
   7 #ifndef CMD_H
   8 #define CMD_H
   9
  10 #include <string>
  11 #include <vector>
  12
  13 //! This class handles Tsunagari's command line input.
  14 class CommandLineOptions
  15 {
  16 public:
  17         //! Initialize the parser with argc and argv.
  18         CommandLineOptions(int argc, char** argv);
  19         ~CommandLineOptions();
  20
  21         //! Add an option to the parser.
  22         /*!
  23                 @param shortopt Full short option, ex. "-c", empty string if no
  24                 short option.
  25                 @param longopt Full long option, ex. "--config", required.
  26                 @param argument A short description of the argument expected to
  27                 the option, an empty string if no argument.
  28                 @param description A description of the argument, required.
  29         */
  30         void insert(std::string shortopt, std::string longopt,
  31                 std::string argument, std::string description);
  32
  33         //! Process the command line.
  34         /*!
  35                 Run after all of your inserts.
  36                 @return true if succeeded, false if failed.
  37         */
  38         bool parse();
  39
  40         //! Check if option was used.
  41         /*!
  42                 @return true if option was used, false otherwise.
  43         */
  44         bool check(std::string longopt);
  45
  46         //! Get the string value of an option's argument.
  47         /*!
  48                 @return empty string if failed.
  49         */
  50         std::string get(std::string longopt);
  51
  52         //! Print a pretty usage/help message.
  53         /*!
  54                 automatically formatted from the list of inserted options.
  55         */
  56         void usage();
  57
  58 private:
  59         void usageSize(size_t* optmaxlen, size_t* argmaxlen);
  60         void usagePrintShort();
  61         void usagePrintLong(size_t optmaxlen, size_t argmaxlen);
  62
  63         int argc;
  64         char** argv;
  65
  66         struct Option {
  67                 std::string shortopt;
  68                 std::string longopt;
  69                 std::string argument;
  70                 std::string description;
  71                 bool present;
  72                 std::string value;
  73         };
  74
  75         std::vector<Option*> OptionsList;
  76 };
  77
  78 #endif
  79