xref: /llvm-project/lldb/source/Commands/CommandObjectFrame.cpp (revision a134cc1bf85c7bf3bcc9d04b60d20650ed885c66)
1 //===-- CommandObjectFrame.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 "CommandObjectFrame.h"
11 
12 // C Includes
13 // C++ Includes
14 // Other libraries and framework includes
15 // Project includes
16 #include "lldb/Core/Debugger.h"
17 #include "lldb/Core/Module.h"
18 #include "lldb/Core/StreamFile.h"
19 #include "lldb/Core/Timer.h"
20 #include "lldb/Core/Value.h"
21 #include "lldb/Core/ValueObject.h"
22 #include "lldb/Core/ValueObjectVariable.h"
23 #include "lldb/Interpreter/Args.h"
24 #include "lldb/Interpreter/CommandInterpreter.h"
25 #include "lldb/Interpreter/CommandReturnObject.h"
26 #include "lldb/Interpreter/Options.h"
27 #include "lldb/Symbol/ClangASTType.h"
28 #include "lldb/Symbol/ClangASTContext.h"
29 #include "lldb/Symbol/ObjectFile.h"
30 #include "lldb/Symbol/SymbolContext.h"
31 #include "lldb/Symbol/Type.h"
32 #include "lldb/Symbol/Variable.h"
33 #include "lldb/Symbol/VariableList.h"
34 #include "lldb/Target/Process.h"
35 #include "lldb/Target/StackFrame.h"
36 #include "lldb/Target/Thread.h"
37 #include "lldb/Target/Target.h"
38 
39 #include "CommandObjectThread.h"
40 
41 using namespace lldb;
42 using namespace lldb_private;
43 
44 #pragma mark CommandObjectFrameInfo
45 
46 //-------------------------------------------------------------------------
47 // CommandObjectFrameInfo
48 //-------------------------------------------------------------------------
49 
50 class CommandObjectFrameInfo : public CommandObject
51 {
52 public:
53 
54     CommandObjectFrameInfo () :
55     CommandObject ("frame info",
56                    "List information about the currently selected frame in the current thread.",
57                    "frame info",
58                    eFlagProcessMustBeLaunched | eFlagProcessMustBePaused)
59     {
60     }
61 
62     ~CommandObjectFrameInfo ()
63     {
64     }
65 
66     bool
67     Execute (CommandInterpreter &interpreter,
68              Args& command,
69              CommandReturnObject &result)
70     {
71         ExecutionContext exe_ctx(interpreter.GetDebugger().GetExecutionContext());
72         if (exe_ctx.frame)
73         {
74             exe_ctx.frame->Dump (&result.GetOutputStream(), true, false);
75             result.GetOutputStream().EOL();
76             result.SetStatus (eReturnStatusSuccessFinishResult);
77         }
78         else
79         {
80             result.AppendError ("no current frame");
81             result.SetStatus (eReturnStatusFailed);
82         }
83         return result.Succeeded();
84     }
85 };
86 
87 #pragma mark CommandObjectFrameSelect
88 
89 //-------------------------------------------------------------------------
90 // CommandObjectFrameSelect
91 //-------------------------------------------------------------------------
92 
93 class CommandObjectFrameSelect : public CommandObject
94 {
95 public:
96 
97     CommandObjectFrameSelect () :
98     CommandObject ("frame select",
99                    //"Select the current frame by index in the current thread.",
100                    "Select a frame by index from within the current thread and make it the current frame.",
101                    "frame select <frame-index>",
102                    eFlagProcessMustBeLaunched | eFlagProcessMustBePaused)
103     {
104     }
105 
106     ~CommandObjectFrameSelect ()
107     {
108     }
109 
110     bool
111     Execute (CommandInterpreter &interpreter,
112              Args& command,
113              CommandReturnObject &result)
114     {
115         ExecutionContext exe_ctx (interpreter.GetDebugger().GetExecutionContext());
116         if (exe_ctx.thread)
117         {
118             if (command.GetArgumentCount() == 1)
119             {
120                 const char *frame_idx_cstr = command.GetArgumentAtIndex(0);
121 
122                 const uint32_t num_frames = exe_ctx.thread->GetStackFrameCount();
123                 const uint32_t frame_idx = Args::StringToUInt32 (frame_idx_cstr, UINT32_MAX, 0);
124                 if (frame_idx < num_frames)
125                 {
126                     exe_ctx.thread->SetSelectedFrameByIndex (frame_idx);
127                     exe_ctx.frame = exe_ctx.thread->GetSelectedFrame ().get();
128 
129                     if (exe_ctx.frame)
130                     {
131                         bool already_shown = false;
132                         SymbolContext frame_sc(exe_ctx.frame->GetSymbolContext(eSymbolContextLineEntry));
133                         if (interpreter.GetDebugger().UseExternalEditor() && frame_sc.line_entry.file && frame_sc.line_entry.line != 0)
134                         {
135                             already_shown = Host::OpenFileInExternalEditor (frame_sc.line_entry.file, frame_sc.line_entry.line);
136                         }
137 
138                         if (DisplayFrameForExecutionContext (exe_ctx.thread,
139                                                              exe_ctx.frame,
140                                                              interpreter,
141                                                              result.GetOutputStream(),
142                                                              true,
143                                                              !already_shown,
144                                                              3,
145                                                              3))
146                         {
147                             result.SetStatus (eReturnStatusSuccessFinishResult);
148                             return result.Succeeded();
149                         }
150                     }
151                 }
152                 if (frame_idx == UINT32_MAX)
153                     result.AppendErrorWithFormat ("Invalid frame index: %s.\n", frame_idx_cstr);
154                 else
155                     result.AppendErrorWithFormat ("Frame index (%u) out of range.\n", frame_idx);
156             }
157             else
158             {
159                 result.AppendError ("invalid arguments");
160                 result.AppendErrorWithFormat ("Usage: %s\n", m_cmd_syntax.c_str());
161             }
162         }
163         else
164         {
165             result.AppendError ("no current thread");
166         }
167         result.SetStatus (eReturnStatusFailed);
168         return false;
169     }
170 };
171 
172 #pragma mark CommandObjectFrameVariable
173 //----------------------------------------------------------------------
174 // List images with associated information
175 //----------------------------------------------------------------------
176 class CommandObjectFrameVariable : public CommandObject
177 {
178 public:
179 
180     class CommandOptions : public Options
181     {
182     public:
183 
184         CommandOptions () :
185             Options()
186         {
187             ResetOptionValues ();
188         }
189 
190         virtual
191         ~CommandOptions ()
192         {
193         }
194 
195         virtual Error
196         SetOptionValue (int option_idx, const char *option_arg)
197         {
198             Error error;
199             bool success;
200             char short_option = (char) m_getopt_table[option_idx].val;
201             switch (short_option)
202             {
203             case 'o':   use_objc     = true;  break;
204             case 'n':   name = option_arg;    break;
205             case 'r':   use_regex    = true;  break;
206             case 'a':   show_args    = false; break;
207             case 'l':   show_locals  = false; break;
208             case 'g':   show_globals = true;  break;
209             case 't':   show_types   = false; break;
210             case 'y':   show_summary = false; break;
211             case 'L':   show_location= true;  break;
212             case 'c':   show_decl    = true;  break;
213             case 'D':   debug        = true;  break;
214             case 'd':
215                 max_depth = Args::StringToUInt32 (option_arg, UINT32_MAX, 0, &success);
216                 if (!success)
217                     error.SetErrorStringWithFormat("Invalid max depth '%s'.\n", option_arg);
218                 break;
219 
220             case 'p':
221                 ptr_depth = Args::StringToUInt32 (option_arg, 0, 0, &success);
222                 if (!success)
223                     error.SetErrorStringWithFormat("Invalid pointer depth '%s'.\n", option_arg);
224                 break;
225 
226             case 'G':
227                 globals.push_back(ConstString (option_arg));
228                 break;
229 
230             case 's':
231                 show_scope = true;
232                 break;
233 
234             default:
235                 error.SetErrorStringWithFormat("Invalid short option character '%c'.\n", short_option);
236                 break;
237             }
238 
239             return error;
240         }
241 
242         void
243         ResetOptionValues ()
244         {
245             Options::ResetOptionValues();
246 
247             name.clear();
248             use_objc      = false;
249             use_regex     = false;
250             show_args     = true;
251             show_locals   = true;
252             show_globals  = false;
253             show_types    = true;
254             show_scope    = false;
255             show_summary  = true;
256             show_location = false;
257             show_decl     = false;
258             debug         = false;
259             max_depth     = UINT32_MAX;
260             ptr_depth     = 0;
261             globals.clear();
262         }
263 
264         const lldb::OptionDefinition*
265         GetDefinitions ()
266         {
267             return g_option_table;
268         }
269 
270         // Options table: Required for subclasses of Options.
271 
272         static lldb::OptionDefinition g_option_table[];
273         std::string name;
274         bool use_objc:1,
275              use_regex:1,
276              show_args:1,
277              show_locals:1,
278              show_globals:1,
279              show_types:1,
280              show_scope:1,
281              show_summary:1,
282              show_location:1,
283              show_decl:1,
284              debug:1;
285         uint32_t max_depth; // The depth to print when dumping concrete (not pointers) aggreate values
286         uint32_t ptr_depth; // The default depth that is dumped when we find pointers
287         std::vector<ConstString> globals;
288         // Instance variables to hold the values for command options.
289     };
290 
291     CommandObjectFrameVariable () :
292         CommandObject (
293                 "frame variable",
294                 "Show specified argument, local variable, static variable or global variable for the current frame.  If none specified, list them all.",
295                 "frame variable [<cmd-options>] [<var-name1> [<var-name2>...]]")
296     {
297     }
298 
299     virtual
300     ~CommandObjectFrameVariable ()
301     {
302     }
303 
304     virtual
305     Options *
306     GetOptions ()
307     {
308         return &m_options;
309     }
310 
311     void
312     DumpVariable (CommandReturnObject &result, ExecutionContext *exe_ctx, Variable *variable)
313     {
314         if (variable)
315         {
316             Stream &s = result.GetOutputStream();
317             DWARFExpression &expr = variable->LocationExpression();
318             Value expr_result;
319             Error expr_error;
320             Type *variable_type = variable->GetType();
321             bool expr_success = expr.Evaluate(exe_ctx, NULL, NULL, expr_result, &expr_error);
322 
323             if (m_options.debug)
324                 s.Printf ("Variable{0x%8.8x}: ", variable->GetID());
325 
326             if (!expr_success)
327                 s.Printf ("%s = ERROR: %s\n", variable->GetName().AsCString(NULL), expr_error.AsCString());
328             else
329             {
330                 Value::ValueType expr_value_type = expr_result.GetValueType();
331                 switch (expr_value_type)
332                 {
333                 case Value::eValueTypeScalar:
334                     s.Printf ("%s = ", variable->GetName().AsCString(NULL));
335                     if (variable_type)
336                     {
337                         DataExtractor data;
338                         if (expr_result.ResolveValue (exe_ctx, NULL).GetData (data))
339                             variable_type->DumpValue (exe_ctx, &s, data, 0, m_options.show_types, m_options.show_summary, m_options.debug);
340                     }
341                     break;
342 
343                     case Value::eValueTypeFileAddress:
344                     case Value::eValueTypeLoadAddress:
345                     case Value::eValueTypeHostAddress:
346                     {
347                         s.Printf ("%s = ", variable->GetName().AsCString(NULL));
348                         lldb::addr_t addr = LLDB_INVALID_ADDRESS;
349                         lldb::AddressType addr_type = eAddressTypeLoad;
350 
351                         if (expr_value_type == Value::eValueTypeFileAddress)
352                         {
353                             lldb::addr_t file_addr = expr_result.ResolveValue (exe_ctx, NULL).ULongLong(LLDB_INVALID_ADDRESS);
354                             SymbolContext var_sc;
355                             variable->CalculateSymbolContext(&var_sc);
356                             if (var_sc.module_sp)
357                             {
358                                 ObjectFile *objfile = var_sc.module_sp->GetObjectFile();
359                                 if (objfile)
360                                 {
361                                     Address so_addr(file_addr, objfile->GetSectionList());
362                                     addr = so_addr.GetLoadAddress(exe_ctx->process);
363                                 }
364                                 if (addr == LLDB_INVALID_ADDRESS)
365                                 {
366                                     result.GetErrorStream().Printf ("error: %s is not loaded\n",
367                                                                     var_sc.module_sp->GetFileSpec().GetFilename().AsCString());
368                                 }
369                             }
370                             else
371                             {
372                                 result.GetErrorStream().Printf ("error: unable to resolve the variable address 0x%llx\n", file_addr);
373                             }
374                         }
375                         else
376                         {
377                             if (expr_value_type == Value::eValueTypeHostAddress)
378                                 addr_type = eAddressTypeHost;
379                             addr = expr_result.ResolveValue (exe_ctx, NULL).ULongLong(LLDB_INVALID_ADDRESS);
380                         }
381 
382                         if (addr != LLDB_INVALID_ADDRESS)
383                         {
384                             if (m_options.debug)
385                                 s.Printf("@ 0x%8.8llx, value = ", addr);
386                             variable_type->DumpValueInMemory (exe_ctx, &s, addr, addr_type, m_options.show_types, m_options.show_summary, m_options.debug);
387                         }
388                     }
389                     break;
390                 }
391                 s.EOL();
392             }
393         }
394     }
395 
396     void
397     DumpValueObject (CommandReturnObject &result,
398                      ExecutionContextScope *exe_scope,
399                      ValueObject *valobj,
400                      const char *root_valobj_name,
401                      uint32_t ptr_depth,
402                      uint32_t curr_depth,
403                      uint32_t max_depth,
404                      bool use_objc)
405     {
406         if (valobj)
407         {
408             Stream &s = result.GetOutputStream();
409 
410             //const char *loc_cstr = valobj->GetLocationAsCString();
411             if (m_options.show_location)
412             {
413                 s.Printf("@ %s: ", valobj->GetLocationAsCString(exe_scope));
414             }
415             if (m_options.debug)
416                 s.Printf ("%p ValueObject{%u} ", valobj, valobj->GetID());
417 
418             s.Indent();
419 
420             if (m_options.show_types)
421                 s.Printf("(%s) ", valobj->GetTypeName().AsCString());
422 
423             const char *name_cstr = root_valobj_name ? root_valobj_name : valobj->GetName().AsCString("");
424             s.Printf ("%s = ", name_cstr);
425 
426             const char *val_cstr = valobj->GetValueAsCString(exe_scope);
427             const char *err_cstr = valobj->GetError().AsCString();
428 
429             if (err_cstr)
430             {
431                 s.Printf ("error: %s\n", err_cstr);
432             }
433             else
434             {
435                 const char *sum_cstr = valobj->GetSummaryAsCString(exe_scope);
436 
437                 const bool is_aggregate = ClangASTContext::IsAggregateType (valobj->GetOpaqueClangQualType());
438 
439                 if (val_cstr)
440                     s.PutCString(val_cstr);
441 
442                 if (sum_cstr)
443                     s.Printf(" %s", sum_cstr);
444 
445                 if (use_objc)
446                 {
447                     const char *object_desc = valobj->GetObjectDescription(exe_scope);
448                     if (object_desc)
449                         s.Printf("\n%s\n", object_desc);
450                     else
451                         s.Printf ("No description available.\n");
452                     return;
453                 }
454 
455 
456                 if (curr_depth < max_depth)
457                 {
458                     if (is_aggregate)
459                         s.PutChar('{');
460 
461                     bool is_ptr_or_ref = ClangASTContext::IsPointerOrReferenceType (valobj->GetOpaqueClangQualType());
462 
463                     if (is_ptr_or_ref && ptr_depth == 0)
464                         return;
465 
466                     const uint32_t num_children = valobj->GetNumChildren();
467                     if (num_children)
468                     {
469                         s.IndentMore();
470                         for (uint32_t idx=0; idx<num_children; ++idx)
471                         {
472                             ValueObjectSP child_sp(valobj->GetChildAtIndex(idx, true));
473                             if (child_sp.get())
474                             {
475                                 s.EOL();
476                                 DumpValueObject (result,
477                                                  exe_scope,
478                                                  child_sp.get(),
479                                                  NULL,
480                                                  is_ptr_or_ref ? ptr_depth - 1 : ptr_depth,
481                                                  curr_depth + 1,
482                                                  max_depth,
483                                                  false);
484                                 if (idx + 1 < num_children)
485                                     s.PutChar(',');
486                             }
487                         }
488                         s.IndentLess();
489                     }
490                     if (is_aggregate)
491                     {
492                         s.EOL();
493                         s.Indent("}");
494                     }
495                 }
496                 else
497                 {
498                     if (is_aggregate)
499                     {
500                         s.PutCString("{...}");
501                     }
502                 }
503 
504             }
505         }
506     }
507 
508     virtual bool
509     Execute
510     (
511         CommandInterpreter &interpreter,
512         Args& command,
513         CommandReturnObject &result
514     )
515     {
516         ExecutionContext exe_ctx(interpreter.GetDebugger().GetExecutionContext());
517         if (exe_ctx.frame == NULL)
518         {
519             result.AppendError ("invalid frame");
520             result.SetStatus (eReturnStatusFailed);
521             return false;
522         }
523         else
524         {
525             Stream &s = result.GetOutputStream();
526 
527             bool get_file_globals = true;
528             VariableList *variable_list = exe_ctx.frame->GetVariableList (get_file_globals);
529 
530             VariableSP var_sp;
531             ValueObjectSP valobj_sp;
532             //ValueObjectList &valobj_list = exe_ctx.frame->GetValueObjectList();
533             const char *name_cstr = NULL;
534             bool show_fullpaths = true;
535             size_t idx;
536             if (!m_options.globals.empty())
537             {
538                 uint32_t fail_count = 0;
539                 if (exe_ctx.target)
540                 {
541                     const size_t num_globals = m_options.globals.size();
542                     for (idx = 0; idx < num_globals; ++idx)
543                     {
544                         VariableList global_var_list;
545                         const uint32_t num_matching_globals = exe_ctx.target->GetImages().FindGlobalVariables (m_options.globals[idx], true, UINT32_MAX, global_var_list);
546 
547                         if (num_matching_globals == 0)
548                         {
549                             ++fail_count;
550                             result.GetErrorStream().Printf ("error: can't find global variable '%s'\n", m_options.globals[idx].AsCString());
551                         }
552                         else
553                         {
554                             for (uint32_t global_idx=0; global_idx<num_matching_globals; ++global_idx)
555                             {
556                                 var_sp = global_var_list.GetVariableAtIndex(global_idx);
557                                 if (var_sp)
558                                 {
559                                     valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp);
560                                     if (!valobj_sp)
561                                         valobj_sp = exe_ctx.frame->TrackGlobalVariable (var_sp);
562 
563                                     if (valobj_sp)
564                                     {
565                                         DumpValueObject (result, exe_ctx.frame, valobj_sp.get(), name_cstr, m_options.ptr_depth, 0, m_options.max_depth, false);
566 
567                                         if (m_options.show_decl && var_sp->GetDeclaration ().GetFile())
568                                         {
569                                             var_sp->GetDeclaration ().Dump (&s);
570                                         }
571 
572                                         s.EOL();
573                                     }
574                                 }
575                             }
576                         }
577                     }
578                 }
579                 if (fail_count)
580                     result.SetStatus (eReturnStatusFailed);
581             }
582             else if (command.GetArgumentCount() > 0)
583             {
584                 // If we have any args to the variable command, we will make
585                 // variable objects from them...
586                 for (idx = 0; (name_cstr = command.GetArgumentAtIndex(idx)) != NULL; ++idx)
587                 {
588                     uint32_t ptr_depth = m_options.ptr_depth;
589                     // If first character is a '*', then show pointer contents
590                     if (name_cstr[0] == '*')
591                     {
592                         ++ptr_depth;
593                         name_cstr++; // Skip the '*'
594                     }
595 
596                     std::string var_path (name_cstr);
597                     size_t separator_idx = var_path.find_first_of(".-[");
598 
599                     ConstString name_const_string;
600                     if (separator_idx == std::string::npos)
601                         name_const_string.SetCString (var_path.c_str());
602                     else
603                         name_const_string.SetCStringWithLength (var_path.c_str(), separator_idx);
604 
605                     var_sp = variable_list->FindVariable(name_const_string);
606                     if (var_sp)
607                     {
608                         valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp);
609 
610                         var_path.erase (0, name_const_string.GetLength ());
611                         // We are dumping at least one child
612                         while (separator_idx != std::string::npos)
613                         {
614                             // Calculate the next separator index ahead of time
615                             ValueObjectSP child_valobj_sp;
616                             const char separator_type = var_path[0];
617                             switch (separator_type)
618                             {
619 
620                             case '-':
621                                 if (var_path.size() >= 2 && var_path[1] != '>')
622                                 {
623                                     result.GetErrorStream().Printf ("error: invalid character in variable path starting at '%s'\n",
624                                                                     var_path.c_str());
625                                     var_path.clear();
626                                     valobj_sp.reset();
627                                     break;
628                                 }
629                                 var_path.erase (0, 1); // Remove the '-'
630                                 // Fall through
631                             case '.':
632                                 {
633                                     var_path.erase (0, 1); // Remove the '.' or '>'
634                                     separator_idx = var_path.find_first_of(".-[");
635                                     ConstString child_name;
636                                     if (separator_idx == std::string::npos)
637                                         child_name.SetCString (var_path.c_str());
638                                     else
639                                         child_name.SetCStringWithLength(var_path.c_str(), separator_idx);
640 
641                                     child_valobj_sp = valobj_sp->GetChildMemberWithName (child_name, true);
642                                     if (!child_valobj_sp)
643                                     {
644                                         result.GetErrorStream().Printf ("error: can't find child of '%s' named '%s'\n",
645                                                                         valobj_sp->GetName().AsCString(),
646                                                                         child_name.GetCString());
647                                         var_path.clear();
648                                         valobj_sp.reset();
649                                         break;
650                                     }
651                                     // Remove the child name from the path
652                                     var_path.erase(0, child_name.GetLength());
653                                 }
654                                 break;
655 
656                             case '[':
657                                 // Array member access, or treating pointer as an array
658                                 if (var_path.size() > 2) // Need at least two brackets and a number
659                                 {
660                                     char *end = NULL;
661                                     int32_t child_index = ::strtol (&var_path[1], &end, 0);
662                                     if (end && *end == ']')
663                                     {
664 
665                                         if (valobj_sp->IsPointerType ())
666                                         {
667                                             child_valobj_sp = valobj_sp->GetSyntheticArrayMemberFromPointer (child_index, true);
668                                         }
669                                         else
670                                         {
671                                             child_valobj_sp = valobj_sp->GetChildAtIndex (child_index, true);
672                                         }
673 
674                                         if (!child_valobj_sp)
675                                         {
676                                             result.GetErrorStream().Printf ("error: invalid array index %u in '%s'\n",
677                                                                             child_index,
678                                                                             valobj_sp->GetName().AsCString());
679                                             var_path.clear();
680                                             valobj_sp.reset();
681                                             break;
682                                         }
683 
684                                         // Erase the array member specification '[%i]' where %i is the array index
685                                         var_path.erase(0, (end - var_path.c_str()) + 1);
686                                         separator_idx = var_path.find_first_of(".-[");
687 
688                                         // Break out early from the switch since we were able to find the child member
689                                         break;
690                                     }
691                                 }
692                                 result.GetErrorStream().Printf ("error: invalid array member specification for '%s' starting at '%s'\n",
693                                                                 valobj_sp->GetName().AsCString(),
694                                                                 var_path.c_str());
695                                 var_path.clear();
696                                 valobj_sp.reset();
697                                 break;
698 
699                                 break;
700 
701                             default:
702                                 result.GetErrorStream().Printf ("error: invalid character in variable path starting at '%s'\n",
703                                                                     var_path.c_str());
704                                 var_path.clear();
705                                 valobj_sp.reset();
706                                 separator_idx = std::string::npos;
707                                 break;
708                             }
709 
710                             if (child_valobj_sp)
711                                 valobj_sp = child_valobj_sp;
712 
713                             if (var_path.empty())
714                                 break;
715 
716                         }
717 
718                         if (valobj_sp)
719                         {
720                             if (m_options.show_decl && var_sp->GetDeclaration ().GetFile())
721                             {
722                                 var_sp->GetDeclaration ().DumpStopContext (&s, false);
723                                 s.PutCString (": ");
724                             }
725 
726                             DumpValueObject (result,
727                                              exe_ctx.frame,
728                                              valobj_sp.get(),
729                                              name_cstr,
730                                              ptr_depth,
731                                              0,
732                                              m_options.max_depth,
733                                              m_options.use_objc);
734 
735                             s.EOL();
736                         }
737                     }
738                     else
739                     {
740                         result.GetErrorStream().Printf ("error: unable to find any variables named '%s'\n", name_cstr);
741                         var_path.clear();
742                     }
743                 }
744             }
745             else
746             {
747                 const uint32_t num_variables = variable_list->GetSize();
748 
749                 if (num_variables > 0)
750                 {
751                     for (uint32_t i=0; i<num_variables; i++)
752                     {
753                         VariableSP var_sp (variable_list->GetVariableAtIndex(i));
754                         bool dump_variable = true;
755 
756                         switch (var_sp->GetScope())
757                         {
758                         case eValueTypeVariableGlobal:
759                             dump_variable = m_options.show_globals;
760                             if (dump_variable && m_options.show_scope)
761                                 s.PutCString("GLOBAL: ");
762                             break;
763 
764                         case eValueTypeVariableStatic:
765                             dump_variable = m_options.show_globals;
766                             if (dump_variable && m_options.show_scope)
767                                 s.PutCString("STATIC: ");
768                             break;
769 
770                         case eValueTypeVariableArgument:
771                             dump_variable = m_options.show_args;
772                             if (dump_variable && m_options.show_scope)
773                                 s.PutCString("   ARG: ");
774                             break;
775 
776                         case eValueTypeVariableLocal:
777                             dump_variable = m_options.show_locals;
778                             if (dump_variable && m_options.show_scope)
779                                 s.PutCString(" LOCAL: ");
780                             break;
781 
782                         default:
783                             break;
784                         }
785 
786                         if (dump_variable)
787                         {
788                             //DumpVariable (result, &exe_ctx, var_sp.get());
789 
790                             // Use the variable object code to make sure we are
791                             // using the same APIs as the the public API will be
792                             // using...
793                             valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp);
794                             if (valobj_sp)
795                             {
796 
797                                 if (m_options.show_decl && var_sp->GetDeclaration ().GetFile())
798                                 {
799                                     var_sp->GetDeclaration ().DumpStopContext (&s, false);
800                                     s.PutCString (": ");
801                                 }
802                                 DumpValueObject (result,
803                                                  exe_ctx.frame,
804                                                  valobj_sp.get(),
805                                                  name_cstr,
806                                                  m_options.ptr_depth,
807                                                  0,
808                                                  m_options.max_depth,
809                                                  m_options.use_objc);
810 
811                                 s.EOL();
812                             }
813                         }
814                     }
815                 }
816             }
817             result.SetStatus (eReturnStatusSuccessFinishResult);
818         }
819         return result.Succeeded();
820     }
821 protected:
822 
823     CommandOptions m_options;
824 };
825 
826 lldb::OptionDefinition
827 CommandObjectFrameVariable::CommandOptions::g_option_table[] =
828 {
829 { LLDB_OPT_SET_1, false, "debug",      'D', no_argument,       NULL, 0, NULL,        "Enable verbose debug information."},
830 { LLDB_OPT_SET_1, false, "depth",      'd', required_argument, NULL, 0, "<count>",   "Set the max recurse depth when dumping aggregate types (default is infinity)."},
831 { LLDB_OPT_SET_1, false, "show-globals",'g', no_argument,      NULL, 0, NULL,        "Show the current frame source file global and static variables."},
832 { LLDB_OPT_SET_1, false, "find-global",'G', required_argument, NULL, 0, NULL,        "Find a global variable by name (which might not be in the current stack frame source file)."},
833 { LLDB_OPT_SET_1, false, "location",   'L', no_argument,       NULL, 0, NULL,        "Show variable location information."},
834 { LLDB_OPT_SET_1, false, "show-declaration", 'c', no_argument, NULL, 0, NULL,        "Show variable declaration information (source file and line where the variable was declared)."},
835 { LLDB_OPT_SET_1, false, "name",       'n', required_argument, NULL, 0, "<name>",    "Lookup a variable by name or regex (--regex) for the current execution context."},
836 { LLDB_OPT_SET_1, false, "no-args",    'a', no_argument,       NULL, 0, NULL,        "Omit function arguments."},
837 { LLDB_OPT_SET_1, false, "no-locals",  'l', no_argument,       NULL, 0, NULL,        "Omit local variables."},
838 { LLDB_OPT_SET_1, false, "no-types",   't', no_argument,       NULL, 0, NULL,        "Omit variable type names."},
839 { LLDB_OPT_SET_1, false, "no-summary", 'y', no_argument,       NULL, 0, NULL,        "Omit summary information."},
840 { LLDB_OPT_SET_1, false, "scope",      's', no_argument,       NULL, 0, NULL,        "Show variable scope (argument, local, global, static)."},
841 { LLDB_OPT_SET_1, false, "objc",       'o', no_argument,       NULL, 0, NULL,        "When looking up a variable by name (--name), print as an Objective-C object."},
842 { LLDB_OPT_SET_1, false, "ptr-depth",  'p', required_argument, NULL, 0, "<count>",   "The number of pointers to be traversed when dumping values (default is zero)."},
843 { LLDB_OPT_SET_1, false, "regex",      'r', no_argument,       NULL, 0, NULL,        "The <name> argument for name lookups are regular expressions."},
844 { 0, false, NULL, 0, 0, NULL, NULL, NULL, NULL }
845 };
846 #pragma mark CommandObjectMultiwordFrame
847 
848 //-------------------------------------------------------------------------
849 // CommandObjectMultiwordFrame
850 //-------------------------------------------------------------------------
851 
852 CommandObjectMultiwordFrame::CommandObjectMultiwordFrame (CommandInterpreter &interpreter) :
853     CommandObjectMultiword ("frame",
854                             "A set of commands for operating on the current thread's frames.",
855                             "frame <subcommand> [<subcommand-options>]")
856 {
857     LoadSubCommand (interpreter, "info",   CommandObjectSP (new CommandObjectFrameInfo ()));
858     LoadSubCommand (interpreter, "select", CommandObjectSP (new CommandObjectFrameSelect ()));
859     LoadSubCommand (interpreter, "variable", CommandObjectSP (new CommandObjectFrameVariable ()));
860 }
861 
862 CommandObjectMultiwordFrame::~CommandObjectMultiwordFrame ()
863 {
864 }
865 
866