simpleperf/command.h

   1 /*
   2  * Copyright (C) 2015 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef SIMPLE_PERF_COMMAND_H_
  18 #define SIMPLE_PERF_COMMAND_H_
  19
  20 #include <functional>
  21 #include <memory>
  22 #include <string>
  23 #include <vector>
  24
  25 #include <android-base/macros.h>
  26
  27 class Command {
  28  public:
  29   Command(const std::string& name, const std::string& short_help_string,
  30           const std::string& long_help_string)
  31       : name_(name), short_help_string_(short_help_string), long_help_string_(long_help_string) {
  32   }
  33
  34   virtual ~Command() {
  35   }
  36
  37   const std::string& Name() const {
  38     return name_;
  39   }
  40
  41   const std::string& ShortHelpString() const {
  42     return short_help_string_;
  43   }
  44
  45   const std::string LongHelpString() const {
  46     return long_help_string_;
  47   }
  48
  49   virtual bool Run(const std::vector<std::string>& args) = 0;
  50
  51  protected:
  52   bool NextArgumentOrError(const std::vector<std::string>& args, size_t* pi);
  53   void ReportUnknownOption(const std::vector<std::string>& args, size_t i);
  54
  55  private:
  56   const std::string name_;
  57   const std::string short_help_string_;
  58   const std::string long_help_string_;
  59
  60   DISALLOW_COPY_AND_ASSIGN(Command);
  61 };
  62
  63 void RegisterCommand(const std::string& cmd_name,
  64                      std::function<std::unique_ptr<Command>(void)> callback);
  65 void UnRegisterCommand(const std::string& cmd_name);
  66 std::unique_ptr<Command> CreateCommandInstance(const std::string& cmd_name);
  67 const std::vector<std::string> GetAllCommandNames();
  68
  69 #endif  // SIMPLE_PERF_COMMAND_H_