util/m5/src/call_type.cc

   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 #include <cassert>
  29 #include <sstream>
  30
  31 #include "args.hh"
  32 #include "call_type.hh"
  33
  34 std::map<std::string, CallType &> &
  35 CallType::map()
  36 {
  37     static std::map<std::string, CallType &> all;
  38     return all;
  39 }
  40
  41 CallType::CheckArgsResult
  42 CallType::checkArgs(Args &args)
  43 {
  44     if (args.size() && args[0] == "--" + name) {
  45         args.pop();
  46         return CheckArgsResult::Match;
  47     }
  48     return CheckArgsResult::NoMatch;
  49 }
  50
  51 CallType *
  52 CallType::detect(Args &args)
  53 {
  54     CallType *def = nullptr;
  55
  56     for (auto p: map()) {
  57         auto &ct = p.second;
  58         if (ct.isDefault())
  59             def = &ct;
  60         auto result = ct.checkArgs(args);
  61         switch (result) {
  62           case CheckArgsResult::Match:
  63             ct.init();
  64             return &ct;
  65           case CheckArgsResult::NoMatch:
  66             continue;
  67           case CheckArgsResult::Usage:
  68             return nullptr;
  69           default:
  70             assert(!"Bad checkArgs result");
  71         }
  72     }
  73
  74     assert(def);
  75     def->init();
  76     return def;
  77 }
  78
  79 std::string
  80 CallType::usageSummary()
  81 {
  82     std::string summary = "";
  83     for (auto p: map())
  84         summary += p.second.formattedUsage();
  85     return summary;
  86 }
  87
  88 std::string
  89 CallType::formattedUsage() const
  90 {
  91     std::ostringstream os;
  92     os << "    ";
  93     printBrief(os);
  94     if (isDefault())
  95         os << " (default)";
  96     os << std::endl;
  97
  98     os << "        ";
  99     printDesc(os);
 100     os << std::endl;
 101     return os.str();
 102 }