1 //===-- OptionGroupVariable.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 "lldb/lldb-python.h"
11 
12 #include "lldb/Interpreter/OptionGroupVariable.h"
13 
14 // C Includes
15 // C++ Includes
16 // Other libraries and framework includes
17 // Project includes
18 #include "lldb/Target/Target.h"
19 #include "lldb/Interpreter/CommandInterpreter.h"
20 #include "lldb/Utility/Utils.h"
21 
22 using namespace lldb;
23 using namespace lldb_private;
24 
25 // if you add any options here, remember to update the counters in OptionGroupVariable::GetNumDefinitions()
26 static OptionDefinition
27 g_option_table[] =
28 {
29     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-args",         'a', no_argument,       NULL, 0, eArgTypeNone, "Omit function arguments."},
30     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-locals",       'l', no_argument,       NULL, 0, eArgTypeNone, "Omit local variables."},
31     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-globals",    'g', no_argument,       NULL, 0, eArgTypeNone, "Show the current frame source file global and static variables."},
32     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-declaration",'c', no_argument,       NULL, 0, eArgTypeNone, "Show variable declaration information (source file and line where the variable was declared)."},
33     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "regex",           'r', no_argument,       NULL, 0, eArgTypeRegularExpression, "The <variable-name> argument for name lookups are regular expressions."},
34     { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "scope",           's', no_argument,       NULL, 0, eArgTypeNone, "Show variable scope (argument, local, global, static)."},
35     { LLDB_OPT_SET_1,                  false, "summary",         'y', required_argument, NULL, 0, eArgTypeName, "Specify the summary that the variable output should use."},
36     { LLDB_OPT_SET_2,                  false, "summary-string",  'z', required_argument, NULL, 0, eArgTypeName, "Specify a summary string to use to format the variable output."},
37 };
38 
39 
40 OptionGroupVariable::OptionGroupVariable (bool show_frame_options) :
41     OptionGroup(),
42     include_frame_options (show_frame_options)
43 {
44 }
45 
46 OptionGroupVariable::~OptionGroupVariable ()
47 {
48 }
49 
50 Error
51 OptionGroupVariable::SetOptionValue (CommandInterpreter &interpreter,
52                                      uint32_t option_idx,
53                                      const char *option_arg)
54 {
55     Error error;
56     if (!include_frame_options)
57         option_idx += 3;
58     const int short_option = g_option_table[option_idx].short_option;
59     switch (short_option)
60     {
61         case 'r':   use_regex    = true;  break;
62         case 'a':   show_args    = false; break;
63         case 'l':   show_locals  = false; break;
64         case 'g':   show_globals = true;  break;
65         case 'c':   show_decl    = true;  break;
66         case 's':
67             show_scope = true;
68             break;
69         case 'y':
70             summary.SetCurrentValue(option_arg);
71             break;
72         case 'z':
73             summary_string.SetCurrentValue(option_arg);
74             break;
75         default:
76             error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option);
77             break;
78     }
79 
80     return error;
81 }
82 
83 void
84 OptionGroupVariable::OptionParsingStarting (CommandInterpreter &interpreter)
85 {
86     show_args     = true;   // Frame option only
87     show_locals   = true;   // Frame option only
88     show_globals  = false;  // Frame option only
89     show_decl     = false;
90     use_regex     = false;
91     show_scope    = false;
92     summary.Clear();
93     summary_string.Clear();
94 }
95 
96 #define NUM_FRAME_OPTS 3
97 
98 const OptionDefinition*
99 OptionGroupVariable::GetDefinitions ()
100 {
101     // Show the "--no-args", "--no-locals" and "--show-globals"
102     // options if we are showing frame specific options
103     if (include_frame_options)
104         return g_option_table;
105 
106     // Skip the "--no-args", "--no-locals" and "--show-globals"
107     // options if we are not showing frame specific options (globals only)
108     return &g_option_table[NUM_FRAME_OPTS];
109 }
110 
111 uint32_t
112 OptionGroupVariable::GetNumDefinitions ()
113 {
114     // Count the "--no-args", "--no-locals" and "--show-globals"
115     // options if we are showing frame specific options.
116     if (include_frame_options)
117         return llvm::array_lengthof(g_option_table);
118     else
119         return llvm::array_lengthof(g_option_table) - NUM_FRAME_OPTS;
120 }
121 
122 
123