LLDB mainline
CommandObjectHelp.h
Go to the documentation of this file.
1//===-- CommandObjectHelp.h -------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
10#define LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
11
15
16namespace lldb_private {
17
18// CommandObjectHelp
19
21public:
23
25
26 void HandleCompletion(CompletionRequest &request) override;
27
29 Stream *s, llvm::StringRef command, llvm::StringRef prefix,
30 llvm::StringRef subcommand, bool include_upropos = true,
31 bool include_type_lookup = true);
32
33 class CommandOptions : public Options {
34 public:
35 CommandOptions() = default;
36
37 ~CommandOptions() override = default;
38
39 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
40 ExecutionContext *execution_context) override {
42 const int short_option = m_getopt_table[option_idx].val;
43
44 switch (short_option) {
45 case 'a':
46 m_show_aliases = false;
47 break;
48 case 'u':
49 m_show_user_defined = false;
50 break;
51 case 'h':
52 m_show_hidden = true;
53 break;
54 default:
55 llvm_unreachable("Unimplemented option");
56 }
57
58 return error;
59 }
60
61 void OptionParsingStarting(ExecutionContext *execution_context) override {
62 m_show_aliases = true;
64 m_show_hidden = false;
65 }
66
67 llvm::ArrayRef<OptionDefinition> GetDefinitions() override;
68
69 // Instance variables to hold the values for command options.
70
74 };
75
76 Options *GetOptions() override { return &m_options; }
77
78protected:
79 void DoExecute(Args &command, CommandReturnObject &result) override;
80
81private:
83};
84
85} // namespace lldb_private
86
87#endif // LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
static llvm::raw_ostream & error(Stream &strm)
A command line argument class.
Definition: Args.h:33
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
Set the value of an option.
void OptionParsingStarting(ExecutionContext *execution_context) override
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
static void GenerateAdditionalHelpAvenuesMessage(Stream *s, llvm::StringRef command, llvm::StringRef prefix, llvm::StringRef subcommand, bool include_upropos=true, bool include_type_lookup=true)
void HandleCompletion(CompletionRequest &request) override
This default version handles calling option argument completions and then calls HandleArgumentComplet...
void DoExecute(Args &command, CommandReturnObject &result) override
"lldb/Utility/ArgCompletionRequest.h"
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
A command line option parsing protocol class.
Definition: Options.h:58
std::vector< Option > m_getopt_table
Definition: Options.h:198
An error handling class.
Definition: Status.h:44
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
A class that represents a running process on the host machine.