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