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 #include <stdio.h>
18 #include <string>
19 #include <vector>
20
21 #include <android-base/logging.h>
22
23 #include "command.h"
24
25 namespace simpleperf {
26 namespace {
27
28 class HelpCommand : public Command {
29 public:
HelpCommand()30 HelpCommand()
31 : Command("help", "print help information for simpleperf",
32 // clang-format off
33 "Usage: simpleperf help [subcommand]\n"
34 " Without subcommand, print short help string for every subcommand.\n"
35 " With subcommand, print long help string for the subcommand.\n\n"
36 // clang-format on
37 ) {}
38
39 bool Run(const std::vector<std::string>& args) override;
40
41 private:
42 void PrintShortHelp();
43 void PrintLongHelpForOneCommand(const Command& cmd);
44 };
45
Run(const std::vector<std::string> & args)46 bool HelpCommand::Run(const std::vector<std::string>& args) {
47 if (args.empty()) {
48 PrintShortHelp();
49 } else {
50 std::unique_ptr<Command> cmd = CreateCommandInstance(args[0]);
51 if (cmd == nullptr) {
52 LOG(ERROR) << "malformed command line: can't find help string for "
53 "unknown command "
54 << args[0];
55 LOG(ERROR) << "try using \"--help\"";
56 return false;
57 } else {
58 PrintLongHelpForOneCommand(*cmd);
59 }
60 }
61 return true;
62 }
63
PrintShortHelp()64 void HelpCommand::PrintShortHelp() {
65 printf(
66 // clang-format off
67 "Usage: simpleperf [common options] subcommand [args_for_subcommand]\n"
68 "common options:\n"
69 " -h/--help Print this help information.\n"
70 " --log <severity> Set the minimum severity of logging. Possible severities\n"
71 " include verbose, debug, warning, info, error, fatal.\n"
72 " Default is info.\n"
73 #if defined(__ANDROID__)
74 " --log-to-android-buffer Write log to android log buffer instead of stderr.\n"
75 #endif
76 " --version Print version of simpleperf.\n"
77 "subcommands:\n"
78 // clang-format on
79 );
80 for (auto& cmd_name : GetAllCommandNames()) {
81 std::unique_ptr<Command> cmd = CreateCommandInstance(cmd_name);
82 printf(" %-20s%s\n", cmd_name.c_str(), cmd->ShortHelpString().c_str());
83 }
84 }
85
PrintLongHelpForOneCommand(const Command & command)86 void HelpCommand::PrintLongHelpForOneCommand(const Command& command) {
87 printf("%s\n", command.LongHelpString().c_str());
88 }
89
90 } // namespace
91
RegisterHelpCommand()92 void RegisterHelpCommand() {
93 RegisterCommand("help", [] { return std::unique_ptr<Command>(new HelpCommand); });
94 }
95
96 } // namespace simpleperf
97