diff options
Diffstat (limited to 'include/lldb/Interpreter/CommandObject.h')
| -rw-r--r-- | include/lldb/Interpreter/CommandObject.h | 40 |
1 files changed, 14 insertions, 26 deletions
diff --git a/include/lldb/Interpreter/CommandObject.h b/include/lldb/Interpreter/CommandObject.h index f72628b8a643..31f7f126a9fe 100644 --- a/include/lldb/Interpreter/CommandObject.h +++ b/include/lldb/Interpreter/CommandObject.h @@ -1,9 +1,8 @@ //===-- CommandObject.h -----------------------------------------*- C++ -*-===// // -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. +// 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 // //===----------------------------------------------------------------------===// @@ -122,6 +121,7 @@ public: GetArgumentDescriptionAsCString(const lldb::CommandArgumentType arg_type); CommandInterpreter &GetCommandInterpreter() { return m_interpreter; } + Debugger &GetDebugger(); virtual llvm::StringRef GetHelp(); @@ -221,25 +221,22 @@ public: void SetCommandName(llvm::StringRef name); - //------------------------------------------------------------------ /// This default version handles calling option argument completions and then /// calls HandleArgumentCompletion if the cursor is on an argument, not an /// option. Don't override this method, override HandleArgumentCompletion /// instead unless you have special reasons. /// - /// @param[in/out] request + /// \param[in/out] request /// The completion request that needs to be answered. /// /// FIXME: This is the wrong return value, since we also need to make a /// distinction between /// total number of matches, and the window the user wants returned. /// - /// @return + /// \return /// \btrue if we were in an option, \bfalse otherwise. - //------------------------------------------------------------------ virtual int HandleCompletion(CompletionRequest &request); - //------------------------------------------------------------------ /// The input array contains a parsed version of the line. The insertion /// point is given by cursor_index (the index in input of the word containing /// the cursor) and cursor_char_position (the position of the cursor in that @@ -247,16 +244,15 @@ public: /// We've constructed the map of options and their arguments as well if that /// is helpful for the completion. /// - /// @param[in/out] request + /// \param[in/out] request /// The completion request that needs to be answered. /// /// FIXME: This is the wrong return value, since we also need to make a /// distinction between /// total number of matches, and the window the user wants returned. /// - /// @return + /// \return /// The number of completions. - //------------------------------------------------------------------ virtual int HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) { @@ -269,35 +265,29 @@ public: bool search_syntax = true, bool search_options = true); - //------------------------------------------------------------------ /// The flags accessor. /// - /// @return + /// \return /// A reference to the Flags member variable. - //------------------------------------------------------------------ Flags &GetFlags() { return m_flags; } - //------------------------------------------------------------------ /// The flags const accessor. /// - /// @return + /// \return /// A const reference to the Flags member variable. - //------------------------------------------------------------------ const Flags &GetFlags() const { return m_flags; } - //------------------------------------------------------------------ /// Get the command that appropriate for a "repeat" of the current command. /// - /// @param[in] current_command_line + /// \param[in] current_command_line /// The complete current command line. /// - /// @return + /// \return /// nullptr if there is no special repeat command - it will use the /// current command line. /// Otherwise a pointer to the command to be repeated. /// If the returned string is the empty string, the command won't be /// repeated. - //------------------------------------------------------------------ virtual const char *GetRepeatCommand(Args ¤t_command_args, uint32_t index) { return nullptr; @@ -368,17 +358,15 @@ protected: // insulates you from the details of this calculation. Thread *GetDefaultThread(); - //------------------------------------------------------------------ /// Check the command to make sure anything required by this /// command is available. /// - /// @param[out] result + /// \param[out] result /// A command result object, if it is not okay to run the command /// this will be filled in with a suitable error. /// - /// @return + /// \return /// \b true if it is okay to run this command, \b false otherwise. - //------------------------------------------------------------------ bool CheckRequirements(CommandReturnObject &result); void Cleanup(); |