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