util/m5/src/command.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __COMMAND_HH__
  30 #define __COMMAND_HH__
  31
  32 #include <map>
  33 #include <string>
  34 #include <utility>
  35
  36 class Args;
  37 class DispatchTable;
  38
  39 class Command
  40 {
  41   private:
  42     const std::string name;
  43
  44     // The minimum number of arguments the command expects.
  45     const int minArgs;
  46     // The maximum number of arguments the command can handle.
  47     const int maxArgs;
  48
  49     using FuncType = bool (*)(const DispatchTable &dt, Args &args);
  50     // A function which processes command line arguments and passes them to
  51     // the underlying function through the dispatch table.
  52     FuncType func;
  53
  54     // Help text for this command.
  55     const std::string usageStr;
  56
  57     static std::map<std::string, Command &> &map();
  58
  59   public:
  60
  61     Command(const std::string &_name, int _min, int _max, FuncType _func,
  62             const std::string &_usage) :
  63         name(_name), minArgs(_min), maxArgs(_max), func(_func),
  64         usageStr(_usage)
  65     {
  66         map().emplace(std::piecewise_construct,
  67                     std::forward_as_tuple(std::string(_name)),
  68                     std::forward_as_tuple(*this));
  69     }
  70
  71     ~Command() { map().erase(name); }
  72
  73     static bool run(const DispatchTable &dt, Args &args);
  74
  75     static std::string
  76     usageSummary()
  77     {
  78         std::string summary;
  79         for (auto &p: Command::map())
  80             summary += "    " + p.first + " " + p.second.usageStr + "\n";
  81         return summary;
  82     }
  83 };
  84
  85 #endif // __COMMAND_HH__