util/m5/src/call_type.hh

   1 /*
   2  * Copyright 2020 Google Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met: redistributions of source code must retain the above copyright
   7  * notice, this list of conditions and the following disclaimer;
   8  * redistributions in binary form must reproduce the above copyright
   9  * notice, this list of conditions and the following disclaimer in the
  10  * documentation and/or other materials provided with the distribution;
  11  * neither the name of the copyright holders nor the names of its
  12  * contributors may be used to endorse or promote products derived from
  13  * this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef __CALL_TYPE_HH__
  29 #define __CALL_TYPE_HH__
  30
  31 #include <iostream>
  32 #include <map>
  33 #include <string>
  34 #include <utility>
  35
  36 class Args;
  37 class DispatchTable;
  38
  39 class CallType
  40 {
  41   public:
  42     enum class CheckArgsResult {
  43         Match,
  44         NoMatch,
  45         Usage
  46     };
  47
  48   protected:
  49     const std::string name;
  50
  51     virtual bool isDefault() const = 0;
  52     virtual CheckArgsResult checkArgs(Args &args);
  53     virtual void init() {}
  54
  55     static std::map<std::string, CallType &> &map();
  56
  57     virtual void printBrief(std::ostream &os) const { os << "--" << name; }
  58     virtual void printDesc(std::ostream &os) const = 0;
  59     std::string formattedUsage() const;
  60
  61   public:
  62     CallType(const std::string &_name) : name(_name)
  63     {
  64         map().emplace(std::piecewise_construct,
  65             std::forward_as_tuple(std::string(_name)),
  66             std::forward_as_tuple(*this));
  67     }
  68
  69     ~CallType()
  70     {
  71         map().erase(name);
  72     }
  73
  74     static CallType *detect(Args &args);
  75     static std::string usageSummary();
  76
  77     virtual const DispatchTable &getDispatch() const = 0;
  78 };
  79
  80
  81 #endif // __CALL_TYPE_HH__