1 //===-- CommandObjectApropos.cpp ---------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 // C Includes
11 // C++ Includes
12 // Other libraries and framework includes
13 // Project includes
14 #include "CommandObjectApropos.h"
15 #include "lldb/Interpreter/Args.h"
16 #include "lldb/Interpreter/Options.h"
17 #include "lldb/Interpreter/Property.h"
18 #include "lldb/Interpreter/CommandInterpreter.h"
19 #include "lldb/Interpreter/CommandReturnObject.h"
20 
21 using namespace lldb;
22 using namespace lldb_private;
23 
24 //-------------------------------------------------------------------------
25 // CommandObjectApropos
26 //-------------------------------------------------------------------------
27 
28 CommandObjectApropos::CommandObjectApropos (CommandInterpreter &interpreter) :
29     CommandObjectParsed(interpreter,
30                         "apropos",
31                         "Find a list of debugger commands related to a particular word/subject.",
32                         nullptr)
33 {
34     CommandArgumentEntry arg;
35     CommandArgumentData search_word_arg;
36 
37     // Define the first (and only) variant of this arg.
38     search_word_arg.arg_type = eArgTypeSearchWord;
39     search_word_arg.arg_repetition = eArgRepeatPlain;
40 
41     // There is only one variant this argument could be; put it into the argument entry.
42     arg.push_back (search_word_arg);
43 
44     // Push the data for the first argument into the m_arguments vector.
45     m_arguments.push_back (arg);
46 }
47 
48 CommandObjectApropos::~CommandObjectApropos() = default;
49 
50 bool
51 CommandObjectApropos::DoExecute (Args& args, CommandReturnObject &result)
52 {
53     const size_t argc = args.GetArgumentCount ();
54 
55     if (argc == 1)
56     {
57         const char *search_word = args.GetArgumentAtIndex(0);
58         if ((search_word != nullptr)
59             && (strlen (search_word) > 0))
60         {
61             // The bulk of the work must be done inside the Command Interpreter, since the command dictionary
62             // is private.
63             StringList commands_found;
64             StringList commands_help;
65 
66             m_interpreter.FindCommandsForApropos (search_word, commands_found, commands_help, true, true, true);
67 
68             if (commands_found.GetSize() == 0)
69             {
70                 result.AppendMessageWithFormat ("No commands found pertaining to '%s'. Try 'help' to see a complete list of debugger commands.\n", search_word);
71             }
72             else
73             {
74                 if (commands_found.GetSize() > 0)
75                 {
76                     result.AppendMessageWithFormat ("The following commands may relate to '%s':\n", search_word);
77                     size_t max_len = 0;
78 
79                     for (size_t i = 0; i < commands_found.GetSize(); ++i)
80                     {
81                         size_t len = strlen (commands_found.GetStringAtIndex (i));
82                         if (len > max_len)
83                             max_len = len;
84                     }
85 
86                     for (size_t i = 0; i < commands_found.GetSize(); ++i)
87                         m_interpreter.OutputFormattedHelpText (result.GetOutputStream(),
88                                                                commands_found.GetStringAtIndex(i),
89                                                                "--",
90                                                                commands_help.GetStringAtIndex(i),
91                                                                max_len);
92                 }
93             }
94 
95             std::vector<const Property *> properties;
96             const size_t num_properties = m_interpreter.GetDebugger().Apropos(search_word, properties);
97             if (num_properties)
98             {
99                 const bool dump_qualified_name = true;
100                 result.AppendMessageWithFormat ("\nThe following settings variables may relate to '%s': \n\n", search_word);
101                 for (size_t i=0; i<num_properties; ++i)
102                     properties[i]->DumpDescription (m_interpreter, result.GetOutputStream(), 0, dump_qualified_name);
103 
104             }
105 
106             result.SetStatus (eReturnStatusSuccessFinishNoResult);
107         }
108         else
109         {
110             result.AppendError ("'' is not a valid search word.\n");
111             result.SetStatus (eReturnStatusFailed);
112         }
113     }
114     else
115     {
116         result.AppendError ("'apropos' must be called with exactly one argument.\n");
117         result.SetStatus (eReturnStatusFailed);
118     }
119 
120     return result.Succeeded();
121 }
122