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