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 <string>
  33 #include <vector>
  34
  35 #include "args.hh"
  36 #include "dispatch_table.hh"
  37
  38 class CallType
  39 {
  40   protected:
  41     virtual bool isDefault() const = 0;
  42     virtual bool checkArgs(Args &args) = 0;
  43     virtual void init() {}
  44
  45     static std::vector<CallType *> &allTypes();
  46
  47     virtual void printBrief(std::ostream &os) const = 0;
  48     virtual void printDesc(std::ostream &os) const = 0;
  49     std::string formattedUsage() const;
  50
  51   public:
  52     CallType() { allTypes().push_back(this); }
  53
  54     static CallType &detect(Args &args);
  55     static std::string usageSummary();
  56
  57     virtual const DispatchTable &getDispatch() const = 0;
  58 };
  59
  60
  61 #endif // __CALL_TYPE_HH__