mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-29 13:46:07 +00:00
92d8a28cc6
[lldb] Part 2 of 2 - Refactor `CommandObject::DoExecute(...)` to return `void` instead of ~~`bool`~~ Justifications: - The code doesn't ultimately apply the `true`/`false` return values. - The methods already pass around a `CommandReturnObject`, typically with a `result` parameter. - Each command return object already contains: - A more precise status - The error code(s) that apply to that status Part 1 refactors the `CommandObject::Execute(...)` method. - See [https://github.com/llvm/llvm-project/pull/69989](https://github.com/llvm/llvm-project/pull/69989) rdar://117378957
88 lines
2.4 KiB
C++
88 lines
2.4 KiB
C++
//===-- CommandObjectHelp.h -------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
|
|
#define LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
|
|
|
|
#include "lldb/Host/OptionParser.h"
|
|
#include "lldb/Interpreter/CommandObject.h"
|
|
#include "lldb/Interpreter/Options.h"
|
|
|
|
namespace lldb_private {
|
|
|
|
// CommandObjectHelp
|
|
|
|
class CommandObjectHelp : public CommandObjectParsed {
|
|
public:
|
|
CommandObjectHelp(CommandInterpreter &interpreter);
|
|
|
|
~CommandObjectHelp() override;
|
|
|
|
void HandleCompletion(CompletionRequest &request) override;
|
|
|
|
static void GenerateAdditionalHelpAvenuesMessage(
|
|
Stream *s, llvm::StringRef command, llvm::StringRef prefix,
|
|
llvm::StringRef subcommand, bool include_upropos = true,
|
|
bool include_type_lookup = true);
|
|
|
|
class CommandOptions : public Options {
|
|
public:
|
|
CommandOptions() = default;
|
|
|
|
~CommandOptions() override = default;
|
|
|
|
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
|
|
ExecutionContext *execution_context) override {
|
|
Status error;
|
|
const int short_option = m_getopt_table[option_idx].val;
|
|
|
|
switch (short_option) {
|
|
case 'a':
|
|
m_show_aliases = false;
|
|
break;
|
|
case 'u':
|
|
m_show_user_defined = false;
|
|
break;
|
|
case 'h':
|
|
m_show_hidden = true;
|
|
break;
|
|
default:
|
|
llvm_unreachable("Unimplemented option");
|
|
}
|
|
|
|
return error;
|
|
}
|
|
|
|
void OptionParsingStarting(ExecutionContext *execution_context) override {
|
|
m_show_aliases = true;
|
|
m_show_user_defined = true;
|
|
m_show_hidden = false;
|
|
}
|
|
|
|
llvm::ArrayRef<OptionDefinition> GetDefinitions() override;
|
|
|
|
// Instance variables to hold the values for command options.
|
|
|
|
bool m_show_aliases;
|
|
bool m_show_user_defined;
|
|
bool m_show_hidden;
|
|
};
|
|
|
|
Options *GetOptions() override { return &m_options; }
|
|
|
|
protected:
|
|
void DoExecute(Args &command, CommandReturnObject &result) override;
|
|
|
|
private:
|
|
CommandOptions m_options;
|
|
};
|
|
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_SOURCE_COMMANDS_COMMANDOBJECTHELP_H
|