1368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton//===-- OptionGroupVariable.cpp -----------------------*- C++ -*-===// 2368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// 3368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// The LLVM Compiler Infrastructure 4368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// 5368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// This file is distributed under the University of Illinois Open Source 6368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// License. See LICENSE.TXT for details. 7368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// 8368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton//===----------------------------------------------------------------------===// 9368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 10d891f9b872103235cfd2ed452c6f14a4394d9b3aDaniel Malea#include "lldb/lldb-python.h" 11d891f9b872103235cfd2ed452c6f14a4394d9b3aDaniel Malea 12368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton#include "lldb/Interpreter/OptionGroupVariable.h" 13368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 14368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// C Includes 15368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// C++ Includes 16368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// Other libraries and framework includes 17368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton// Project includes 18729e99e4623c57c9adba85ae2e4372f1dd4bd1c3Enrico Granata#include "lldb/Core/Error.h" 19f509c5ec066599a3399fced39ea36996184939e8Enrico Granata#include "lldb/DataFormatters/DataVisualization.h" 20368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton#include "lldb/Interpreter/CommandInterpreter.h" 21f509c5ec066599a3399fced39ea36996184939e8Enrico Granata#include "lldb/Target/Target.h" 22cfbf7fefda349bccf3eda8d56579cd261c9c8b89Johnny Chen#include "lldb/Utility/Utils.h" 23368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 24368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonusing namespace lldb; 25368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonusing namespace lldb_private; 26368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 271a102087f54079c25c8827afac6153a44ca535daEnrico Granata// if you add any options here, remember to update the counters in OptionGroupVariable::GetNumDefinitions() 28368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonstatic OptionDefinition 29368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytong_option_table[] = 30368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 316475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-args", 'a', no_argument, NULL, 0, eArgTypeNone, "Omit function arguments."}, 326475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-locals", 'l', no_argument, NULL, 0, eArgTypeNone, "Omit local variables."}, 336475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { 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."}, 346475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { 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)."}, 356475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { 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."}, 366475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "scope", 's', no_argument, NULL, 0, eArgTypeNone, "Show variable scope (argument, local, global, static)."}, 376475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { LLDB_OPT_SET_1, false, "summary", 'y', required_argument, NULL, 0, eArgTypeName, "Specify the summary that the variable output should use."}, 386475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton { LLDB_OPT_SET_2, false, "summary-string", 'z', required_argument, NULL, 0, eArgTypeName, "Specify a summary string to use to format the variable output."}, 39368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton}; 40368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 41c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granatastatic Error 42c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico GranataValidateNamedSummary (const char* str, void*) 43c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata{ 44c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata if (!str || !str[0]) 45c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata return Error("must specify a valid named summary"); 46c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata TypeSummaryImplSP summary_sp; 47c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata if (DataVisualization::NamedSummaryFormats::GetSummaryFormat(ConstString(str), summary_sp) == false) 48c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata return Error("must specify a valid named summary"); 49c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata return Error(); 50c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata} 51c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata 52c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granatastatic Error 53c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico GranataValidateSummaryString (const char* str, void*) 54c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata{ 55c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata if (!str || !str[0]) 56c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata return Error("must specify a non-empty summary string"); 57c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata return Error(); 58c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata} 59368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 60368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::OptionGroupVariable (bool show_frame_options) : 61368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton OptionGroup(), 62729e99e4623c57c9adba85ae2e4372f1dd4bd1c3Enrico Granata include_frame_options (show_frame_options), 63c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata summary(ValidateNamedSummary), 64c4f42014c7ae1a704bffb19d917f92d7e3a18052Enrico Granata summary_string(ValidateSummaryString) 65368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 66368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 67368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 68368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::~OptionGroupVariable () 69368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 70368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 71368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 72368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonError 73368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::SetOptionValue (CommandInterpreter &interpreter, 74368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton uint32_t option_idx, 75368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton const char *option_arg) 76368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 77368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton Error error; 78368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton if (!include_frame_options) 79368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton option_idx += 3; 806475c42148a8ea1ca86e5db465db7eca742d897dGreg Clayton const int short_option = g_option_table[option_idx].short_option; 81368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton switch (short_option) 82368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton { 83368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 'r': use_regex = true; break; 84368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 'a': show_args = false; break; 85368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 'l': show_locals = false; break; 86368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 'g': show_globals = true; break; 87368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 'c': show_decl = true; break; 88368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton case 's': 89368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_scope = true; 90368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton break; 911a102087f54079c25c8827afac6153a44ca535daEnrico Granata case 'y': 92729e99e4623c57c9adba85ae2e4372f1dd4bd1c3Enrico Granata error = summary.SetCurrentValue(option_arg); 93879de484c7ef1d0971ac6c007b319b8285723e69Enrico Granata break; 94879de484c7ef1d0971ac6c007b319b8285723e69Enrico Granata case 'z': 95729e99e4623c57c9adba85ae2e4372f1dd4bd1c3Enrico Granata error = summary_string.SetCurrentValue(option_arg); 961a102087f54079c25c8827afac6153a44ca535daEnrico Granata break; 97368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton default: 989c236733d43e6250c8a5671a438f4a2afeb9c0b2Greg Clayton error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option); 99368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton break; 100368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton } 101368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 102368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton return error; 103368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 104368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 105368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonvoid 106368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::OptionParsingStarting (CommandInterpreter &interpreter) 107368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 108368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_args = true; // Frame option only 109368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_locals = true; // Frame option only 110368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_globals = false; // Frame option only 111368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_decl = false; 112368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton use_regex = false; 113368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton show_scope = false; 114879de484c7ef1d0971ac6c007b319b8285723e69Enrico Granata summary.Clear(); 115879de484c7ef1d0971ac6c007b319b8285723e69Enrico Granata summary_string.Clear(); 116368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 117368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 118cfbf7fefda349bccf3eda8d56579cd261c9c8b89Johnny Chen#define NUM_FRAME_OPTS 3 119368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 120368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonconst OptionDefinition* 121368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::GetDefinitions () 122368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 123368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton // Show the "--no-args", "--no-locals" and "--show-globals" 124368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton // options if we are showing frame specific options 125368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton if (include_frame_options) 126368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton return g_option_table; 127368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 128368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton // Skip the "--no-args", "--no-locals" and "--show-globals" 129368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton // options if we are not showing frame specific options (globals only) 130cfbf7fefda349bccf3eda8d56579cd261c9c8b89Johnny Chen return &g_option_table[NUM_FRAME_OPTS]; 131368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 132368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 133368f8226b1f75fbb4758748fafcee70f18fc248eGreg Claytonuint32_t 134368f8226b1f75fbb4758748fafcee70f18fc248eGreg ClaytonOptionGroupVariable::GetNumDefinitions () 135368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton{ 136cfbf7fefda349bccf3eda8d56579cd261c9c8b89Johnny Chen // Count the "--no-args", "--no-locals" and "--show-globals" 137cfbf7fefda349bccf3eda8d56579cd261c9c8b89Johnny Chen // options if we are showing frame specific options. 138368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton if (include_frame_options) 13908af5983cb349e7167f3832d00d36ca611bfa2f1Johnny Chen return llvm::array_lengthof(g_option_table); 140368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton else 14108af5983cb349e7167f3832d00d36ca611bfa2f1Johnny Chen return llvm::array_lengthof(g_option_table) - NUM_FRAME_OPTS; 142368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton} 143368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 144368f8226b1f75fbb4758748fafcee70f18fc248eGreg Clayton 145