1 //===-- ValueObject.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/Core/ValueObject.h"
13 
14 // C Includes
15 #include <stdlib.h>
16 
17 // C++ Includes
18 // Other libraries and framework includes
19 #include "llvm/Support/raw_ostream.h"
20 #include "clang/AST/Type.h"
21 
22 // Project includes
23 #include "lldb/Core/DataBufferHeap.h"
24 #include "lldb/Core/Debugger.h"
25 #include "lldb/Core/Log.h"
26 #include "lldb/Core/Module.h"
27 #include "lldb/Core/StreamString.h"
28 #include "lldb/Core/ValueObjectCast.h"
29 #include "lldb/Core/ValueObjectChild.h"
30 #include "lldb/Core/ValueObjectConstResult.h"
31 #include "lldb/Core/ValueObjectDynamicValue.h"
32 #include "lldb/Core/ValueObjectList.h"
33 #include "lldb/Core/ValueObjectMemory.h"
34 #include "lldb/Core/ValueObjectSyntheticFilter.h"
35 
36 #include "lldb/DataFormatters/DataVisualization.h"
37 #include "lldb/DataFormatters/StringPrinter.h"
38 #include "lldb/DataFormatters/ValueObjectPrinter.h"
39 
40 #include "lldb/Expression/ClangExpressionVariable.h"
41 #include "lldb/Expression/ClangPersistentVariables.h"
42 
43 #include "lldb/Host/Endian.h"
44 
45 #include "lldb/Interpreter/CommandInterpreter.h"
46 #include "lldb/Interpreter/ScriptInterpreterPython.h"
47 
48 #include "lldb/Symbol/ClangASTType.h"
49 #include "lldb/Symbol/ClangASTContext.h"
50 #include "lldb/Symbol/CompileUnit.h"
51 #include "lldb/Symbol/Type.h"
52 
53 #include "lldb/Target/ExecutionContext.h"
54 #include "lldb/Target/LanguageRuntime.h"
55 #include "lldb/Target/ObjCLanguageRuntime.h"
56 #include "lldb/Target/Process.h"
57 #include "lldb/Target/RegisterContext.h"
58 #include "lldb/Target/SectionLoadList.h"
59 #include "lldb/Target/Target.h"
60 #include "lldb/Target/Thread.h"
61 
62 using namespace lldb;
63 using namespace lldb_private;
64 using namespace lldb_utility;
65 
66 static user_id_t g_value_obj_uid = 0;
67 
68 //----------------------------------------------------------------------
69 // ValueObject constructor
70 //----------------------------------------------------------------------
71 ValueObject::ValueObject (ValueObject &parent) :
72     UserID (++g_value_obj_uid), // Unique identifier for every value object
73     m_parent (&parent),
74     m_root (NULL),
75     m_update_point (parent.GetUpdatePoint ()),
76     m_name (),
77     m_data (),
78     m_value (),
79     m_error (),
80     m_value_str (),
81     m_old_value_str (),
82     m_location_str (),
83     m_summary_str (),
84     m_object_desc_str (),
85     m_validation_result(),
86     m_manager(parent.GetManager()),
87     m_children (),
88     m_synthetic_children (),
89     m_dynamic_value (NULL),
90     m_synthetic_value(NULL),
91     m_deref_valobj(NULL),
92     m_format (eFormatDefault),
93     m_last_format (eFormatDefault),
94     m_last_format_mgr_revision(0),
95     m_type_summary_sp(),
96     m_type_format_sp(),
97     m_synthetic_children_sp(),
98     m_type_validator_sp(),
99     m_user_id_of_forced_summary(),
100     m_address_type_of_ptr_or_ref_children(eAddressTypeInvalid),
101     m_value_checksum(),
102     m_preferred_display_language(lldb::eLanguageTypeUnknown),
103     m_value_is_valid (false),
104     m_value_did_change (false),
105     m_children_count_valid (false),
106     m_old_value_valid (false),
107     m_is_deref_of_parent (false),
108     m_is_array_item_for_pointer(false),
109     m_is_bitfield_for_scalar(false),
110     m_is_child_at_offset(false),
111     m_is_getting_summary(false),
112     m_did_calculate_complete_objc_class_type(false),
113     m_is_synthetic_children_generated(parent.m_is_synthetic_children_generated)
114 {
115     m_manager->ManageObject(this);
116 }
117 
118 //----------------------------------------------------------------------
119 // ValueObject constructor
120 //----------------------------------------------------------------------
121 ValueObject::ValueObject (ExecutionContextScope *exe_scope,
122                           AddressType child_ptr_or_ref_addr_type) :
123     UserID (++g_value_obj_uid), // Unique identifier for every value object
124     m_parent (NULL),
125     m_root (NULL),
126     m_update_point (exe_scope),
127     m_name (),
128     m_data (),
129     m_value (),
130     m_error (),
131     m_value_str (),
132     m_old_value_str (),
133     m_location_str (),
134     m_summary_str (),
135     m_object_desc_str (),
136     m_validation_result(),
137     m_manager(),
138     m_children (),
139     m_synthetic_children (),
140     m_dynamic_value (NULL),
141     m_synthetic_value(NULL),
142     m_deref_valobj(NULL),
143     m_format (eFormatDefault),
144     m_last_format (eFormatDefault),
145     m_last_format_mgr_revision(0),
146     m_type_summary_sp(),
147     m_type_format_sp(),
148     m_synthetic_children_sp(),
149     m_type_validator_sp(),
150     m_user_id_of_forced_summary(),
151     m_address_type_of_ptr_or_ref_children(child_ptr_or_ref_addr_type),
152     m_value_checksum(),
153     m_preferred_display_language(lldb::eLanguageTypeUnknown),
154     m_value_is_valid (false),
155     m_value_did_change (false),
156     m_children_count_valid (false),
157     m_old_value_valid (false),
158     m_is_deref_of_parent (false),
159     m_is_array_item_for_pointer(false),
160     m_is_bitfield_for_scalar(false),
161     m_is_child_at_offset(false),
162     m_is_getting_summary(false),
163     m_did_calculate_complete_objc_class_type(false),
164     m_is_synthetic_children_generated(false)
165 {
166     m_manager = new ValueObjectManager();
167     m_manager->ManageObject (this);
168 }
169 
170 //----------------------------------------------------------------------
171 // Destructor
172 //----------------------------------------------------------------------
173 ValueObject::~ValueObject ()
174 {
175 }
176 
177 bool
178 ValueObject::UpdateValueIfNeeded (bool update_format)
179 {
180 
181     bool did_change_formats = false;
182 
183     if (update_format)
184         did_change_formats = UpdateFormatsIfNeeded();
185 
186     // If this is a constant value, then our success is predicated on whether
187     // we have an error or not
188     if (GetIsConstant())
189     {
190         // if you are constant, things might still have changed behind your back
191         // (e.g. you are a frozen object and things have changed deeper than you cared to freeze-dry yourself)
192         // in this case, your value has not changed, but "computed" entries might have, so you might now have
193         // a different summary, or a different object description. clear these so we will recompute them
194         if (update_format && !did_change_formats)
195             ClearUserVisibleData(eClearUserVisibleDataItemsSummary | eClearUserVisibleDataItemsDescription);
196         return m_error.Success();
197     }
198 
199     bool first_update = IsChecksumEmpty();
200 
201     if (m_update_point.NeedsUpdating())
202     {
203         m_update_point.SetUpdated();
204 
205         // Save the old value using swap to avoid a string copy which
206         // also will clear our m_value_str
207         if (m_value_str.empty())
208         {
209             m_old_value_valid = false;
210         }
211         else
212         {
213             m_old_value_valid = true;
214             m_old_value_str.swap (m_value_str);
215             ClearUserVisibleData(eClearUserVisibleDataItemsValue);
216         }
217 
218         ClearUserVisibleData();
219 
220         if (IsInScope())
221         {
222             const bool value_was_valid = GetValueIsValid();
223             SetValueDidChange (false);
224 
225             m_error.Clear();
226 
227             // Call the pure virtual function to update the value
228 
229             bool need_compare_checksums = false;
230             llvm::SmallVector<uint8_t, 16> old_checksum;
231 
232             if (!first_update && CanProvideValue())
233             {
234                 need_compare_checksums = true;
235                 old_checksum.resize(m_value_checksum.size());
236                 std::copy(m_value_checksum.begin(), m_value_checksum.end(), old_checksum.begin());
237             }
238 
239             bool success = UpdateValue ();
240 
241             SetValueIsValid (success);
242 
243             if (success)
244             {
245                 const uint64_t max_checksum_size = 128;
246                 m_data.Checksum(m_value_checksum,
247                                 max_checksum_size);
248             }
249             else
250             {
251                 need_compare_checksums = false;
252                 m_value_checksum.clear();
253             }
254 
255             assert (!need_compare_checksums || (!old_checksum.empty() && !m_value_checksum.empty()));
256 
257             if (first_update)
258                 SetValueDidChange (false);
259             else if (!m_value_did_change && success == false)
260             {
261                 // The value wasn't gotten successfully, so we mark this
262                 // as changed if the value used to be valid and now isn't
263                 SetValueDidChange (value_was_valid);
264             }
265             else if (need_compare_checksums)
266             {
267                 SetValueDidChange(memcmp(&old_checksum[0], &m_value_checksum[0], m_value_checksum.size()));
268             }
269 
270         }
271         else
272         {
273             m_error.SetErrorString("out of scope");
274         }
275     }
276     return m_error.Success();
277 }
278 
279 bool
280 ValueObject::UpdateFormatsIfNeeded()
281 {
282     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TYPES));
283     if (log)
284         log->Printf("[%s %p] checking for FormatManager revisions. ValueObject rev: %d - Global rev: %d",
285                     GetName().GetCString(), static_cast<void*>(this),
286                     m_last_format_mgr_revision,
287                     DataVisualization::GetCurrentRevision());
288 
289     bool any_change = false;
290 
291     if ( (m_last_format_mgr_revision != DataVisualization::GetCurrentRevision()))
292     {
293         m_last_format_mgr_revision = DataVisualization::GetCurrentRevision();
294         any_change = true;
295 
296         SetValueFormat(DataVisualization::GetFormat (*this, eNoDynamicValues));
297         SetSummaryFormat(DataVisualization::GetSummaryFormat (*this, GetDynamicValueType()));
298 #ifndef LLDB_DISABLE_PYTHON
299         SetSyntheticChildren(DataVisualization::GetSyntheticChildren (*this, GetDynamicValueType()));
300 #endif
301         SetValidator(DataVisualization::GetValidator(*this, GetDynamicValueType()));
302     }
303 
304     return any_change;
305 }
306 
307 void
308 ValueObject::SetNeedsUpdate ()
309 {
310     m_update_point.SetNeedsUpdate();
311     // We have to clear the value string here so ConstResult children will notice if their values are
312     // changed by hand (i.e. with SetValueAsCString).
313     ClearUserVisibleData(eClearUserVisibleDataItemsValue);
314 }
315 
316 void
317 ValueObject::ClearDynamicTypeInformation ()
318 {
319     m_children_count_valid = false;
320     m_did_calculate_complete_objc_class_type = false;
321     m_last_format_mgr_revision = 0;
322     m_override_type = ClangASTType();
323     SetValueFormat(lldb::TypeFormatImplSP());
324     SetSummaryFormat(lldb::TypeSummaryImplSP());
325     SetSyntheticChildren(lldb::SyntheticChildrenSP());
326 }
327 
328 ClangASTType
329 ValueObject::MaybeCalculateCompleteType ()
330 {
331     ClangASTType clang_type(GetClangTypeImpl());
332 
333     if (m_did_calculate_complete_objc_class_type)
334     {
335         if (m_override_type.IsValid())
336             return m_override_type;
337         else
338             return clang_type;
339     }
340 
341     ClangASTType class_type;
342     bool is_pointer_type = false;
343 
344     if (clang_type.IsObjCObjectPointerType(&class_type))
345     {
346         is_pointer_type = true;
347     }
348     else if (clang_type.IsObjCObjectOrInterfaceType())
349     {
350         class_type = clang_type;
351     }
352     else
353     {
354         return clang_type;
355     }
356 
357     m_did_calculate_complete_objc_class_type = true;
358 
359     if (class_type)
360     {
361         ConstString class_name (class_type.GetConstTypeName());
362 
363         if (class_name)
364         {
365             ProcessSP process_sp(GetUpdatePoint().GetExecutionContextRef().GetProcessSP());
366 
367             if (process_sp)
368             {
369                 ObjCLanguageRuntime *objc_language_runtime(process_sp->GetObjCLanguageRuntime());
370 
371                 if (objc_language_runtime)
372                 {
373                     TypeSP complete_objc_class_type_sp = objc_language_runtime->LookupInCompleteClassCache(class_name);
374 
375                     if (complete_objc_class_type_sp)
376                     {
377                         ClangASTType complete_class(complete_objc_class_type_sp->GetClangFullType());
378 
379                         if (complete_class.GetCompleteType())
380                         {
381                             if (is_pointer_type)
382                             {
383                                 m_override_type = complete_class.GetPointerType();
384                             }
385                             else
386                             {
387                                 m_override_type = complete_class;
388                             }
389 
390                             if (m_override_type.IsValid())
391                                 return m_override_type;
392                         }
393                     }
394                 }
395             }
396         }
397     }
398     return clang_type;
399 }
400 
401 ClangASTType
402 ValueObject::GetClangType ()
403 {
404     return MaybeCalculateCompleteType();
405 }
406 
407 TypeImpl
408 ValueObject::GetTypeImpl ()
409 {
410     return TypeImpl(GetClangType());
411 }
412 
413 DataExtractor &
414 ValueObject::GetDataExtractor ()
415 {
416     UpdateValueIfNeeded(false);
417     return m_data;
418 }
419 
420 const Error &
421 ValueObject::GetError()
422 {
423     UpdateValueIfNeeded(false);
424     return m_error;
425 }
426 
427 const ConstString &
428 ValueObject::GetName() const
429 {
430     return m_name;
431 }
432 
433 const char *
434 ValueObject::GetLocationAsCString ()
435 {
436     return GetLocationAsCStringImpl(m_value,
437                                     m_data);
438 }
439 
440 const char *
441 ValueObject::GetLocationAsCStringImpl (const Value& value,
442                                        const DataExtractor& data)
443 {
444     if (UpdateValueIfNeeded(false))
445     {
446         if (m_location_str.empty())
447         {
448             StreamString sstr;
449 
450             Value::ValueType value_type = value.GetValueType();
451 
452             switch (value_type)
453             {
454             case Value::eValueTypeScalar:
455             case Value::eValueTypeVector:
456                 if (value.GetContextType() == Value::eContextTypeRegisterInfo)
457                 {
458                     RegisterInfo *reg_info = value.GetRegisterInfo();
459                     if (reg_info)
460                     {
461                         if (reg_info->name)
462                             m_location_str = reg_info->name;
463                         else if (reg_info->alt_name)
464                             m_location_str = reg_info->alt_name;
465                         if (m_location_str.empty())
466                             m_location_str = (reg_info->encoding == lldb::eEncodingVector) ? "vector" : "scalar";
467                     }
468                 }
469                 if (m_location_str.empty())
470                     m_location_str = (value_type == Value::eValueTypeVector) ? "vector" : "scalar";
471                 break;
472 
473             case Value::eValueTypeLoadAddress:
474             case Value::eValueTypeFileAddress:
475             case Value::eValueTypeHostAddress:
476                 {
477                     uint32_t addr_nibble_size = data.GetAddressByteSize() * 2;
478                     sstr.Printf("0x%*.*llx", addr_nibble_size, addr_nibble_size, value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS));
479                     m_location_str.swap(sstr.GetString());
480                 }
481                 break;
482             }
483         }
484     }
485     return m_location_str.c_str();
486 }
487 
488 Value &
489 ValueObject::GetValue()
490 {
491     return m_value;
492 }
493 
494 const Value &
495 ValueObject::GetValue() const
496 {
497     return m_value;
498 }
499 
500 bool
501 ValueObject::ResolveValue (Scalar &scalar)
502 {
503     if (UpdateValueIfNeeded(false)) // make sure that you are up to date before returning anything
504     {
505         ExecutionContext exe_ctx (GetExecutionContextRef());
506         Value tmp_value(m_value);
507         scalar = tmp_value.ResolveValue(&exe_ctx);
508         if (scalar.IsValid())
509         {
510             const uint32_t bitfield_bit_size = GetBitfieldBitSize();
511             if (bitfield_bit_size)
512                 return scalar.ExtractBitfield (bitfield_bit_size, GetBitfieldBitOffset());
513             return true;
514         }
515     }
516     return false;
517 }
518 
519 bool
520 ValueObject::GetValueIsValid () const
521 {
522     return m_value_is_valid;
523 }
524 
525 
526 void
527 ValueObject::SetValueIsValid (bool b)
528 {
529     m_value_is_valid = b;
530 }
531 
532 bool
533 ValueObject::GetValueDidChange ()
534 {
535     return m_value_did_change;
536 }
537 
538 void
539 ValueObject::SetValueDidChange (bool value_changed)
540 {
541     m_value_did_change = value_changed;
542 }
543 
544 ValueObjectSP
545 ValueObject::GetChildAtIndex (size_t idx, bool can_create)
546 {
547     ValueObjectSP child_sp;
548     // We may need to update our value if we are dynamic
549     if (IsPossibleDynamicType ())
550         UpdateValueIfNeeded(false);
551     if (idx < GetNumChildren())
552     {
553         // Check if we have already made the child value object?
554         if (can_create && !m_children.HasChildAtIndex(idx))
555         {
556             // No we haven't created the child at this index, so lets have our
557             // subclass do it and cache the result for quick future access.
558             m_children.SetChildAtIndex(idx,CreateChildAtIndex (idx, false, 0));
559         }
560 
561         ValueObject* child = m_children.GetChildAtIndex(idx);
562         if (child != NULL)
563             return child->GetSP();
564     }
565     return child_sp;
566 }
567 
568 ValueObjectSP
569 ValueObject::GetChildAtIndexPath (const std::initializer_list<size_t>& idxs,
570                                   size_t* index_of_error)
571 {
572     if (idxs.size() == 0)
573         return GetSP();
574     ValueObjectSP root(GetSP());
575     for (size_t idx : idxs)
576     {
577         root = root->GetChildAtIndex(idx, true);
578         if (!root)
579         {
580             if (index_of_error)
581                 *index_of_error = idx;
582             return root;
583         }
584     }
585     return root;
586 }
587 
588 ValueObjectSP
589 ValueObject::GetChildAtIndexPath (const std::initializer_list< std::pair<size_t, bool> >& idxs,
590                                   size_t* index_of_error)
591 {
592     if (idxs.size() == 0)
593         return GetSP();
594     ValueObjectSP root(GetSP());
595     for (std::pair<size_t, bool> idx : idxs)
596     {
597         root = root->GetChildAtIndex(idx.first, idx.second);
598         if (!root)
599         {
600             if (index_of_error)
601                 *index_of_error = idx.first;
602             return root;
603         }
604     }
605     return root;
606 }
607 
608 lldb::ValueObjectSP
609 ValueObject::GetChildAtIndexPath (const std::vector<size_t> &idxs,
610                                   size_t* index_of_error)
611 {
612     if (idxs.size() == 0)
613         return GetSP();
614     ValueObjectSP root(GetSP());
615     for (size_t idx : idxs)
616     {
617         root = root->GetChildAtIndex(idx, true);
618         if (!root)
619         {
620             if (index_of_error)
621                 *index_of_error = idx;
622             return root;
623         }
624     }
625     return root;
626 }
627 
628 lldb::ValueObjectSP
629 ValueObject::GetChildAtIndexPath (const std::vector< std::pair<size_t, bool> > &idxs,
630                                   size_t* index_of_error)
631 {
632     if (idxs.size() == 0)
633         return GetSP();
634     ValueObjectSP root(GetSP());
635     for (std::pair<size_t, bool> idx : idxs)
636     {
637         root = root->GetChildAtIndex(idx.first, idx.second);
638         if (!root)
639         {
640             if (index_of_error)
641                 *index_of_error = idx.first;
642             return root;
643         }
644     }
645     return root;
646 }
647 
648 lldb::ValueObjectSP
649 ValueObject::GetChildAtNamePath (const std::initializer_list<ConstString> &names,
650                                  ConstString* name_of_error)
651 {
652     if (names.size() == 0)
653         return GetSP();
654     ValueObjectSP root(GetSP());
655     for (ConstString name : names)
656     {
657         root = root->GetChildMemberWithName(name, true);
658         if (!root)
659         {
660             if (name_of_error)
661                 *name_of_error = name;
662             return root;
663         }
664     }
665     return root;
666 }
667 
668 lldb::ValueObjectSP
669 ValueObject::GetChildAtNamePath (const std::vector<ConstString> &names,
670                                  ConstString* name_of_error)
671 {
672     if (names.size() == 0)
673         return GetSP();
674     ValueObjectSP root(GetSP());
675     for (ConstString name : names)
676     {
677         root = root->GetChildMemberWithName(name, true);
678         if (!root)
679         {
680             if (name_of_error)
681                 *name_of_error = name;
682             return root;
683         }
684     }
685     return root;
686 }
687 
688 lldb::ValueObjectSP
689 ValueObject::GetChildAtNamePath (const std::initializer_list< std::pair<ConstString, bool> > &names,
690                                  ConstString* name_of_error)
691 {
692     if (names.size() == 0)
693         return GetSP();
694     ValueObjectSP root(GetSP());
695     for (std::pair<ConstString, bool> name : names)
696     {
697         root = root->GetChildMemberWithName(name.first, name.second);
698         if (!root)
699         {
700             if (name_of_error)
701                 *name_of_error = name.first;
702             return root;
703         }
704     }
705     return root;
706 }
707 
708 lldb::ValueObjectSP
709 ValueObject::GetChildAtNamePath (const std::vector< std::pair<ConstString, bool> > &names,
710                                  ConstString* name_of_error)
711 {
712     if (names.size() == 0)
713         return GetSP();
714         ValueObjectSP root(GetSP());
715         for (std::pair<ConstString, bool> name : names)
716         {
717             root = root->GetChildMemberWithName(name.first, name.second);
718             if (!root)
719             {
720                 if (name_of_error)
721                     *name_of_error = name.first;
722                     return root;
723             }
724         }
725     return root;
726 }
727 
728 size_t
729 ValueObject::GetIndexOfChildWithName (const ConstString &name)
730 {
731     bool omit_empty_base_classes = true;
732     return GetClangType().GetIndexOfChildWithName (name.GetCString(), omit_empty_base_classes);
733 }
734 
735 ValueObjectSP
736 ValueObject::GetChildMemberWithName (const ConstString &name, bool can_create)
737 {
738     // when getting a child by name, it could be buried inside some base
739     // classes (which really aren't part of the expression path), so we
740     // need a vector of indexes that can get us down to the correct child
741     ValueObjectSP child_sp;
742 
743     // We may need to update our value if we are dynamic
744     if (IsPossibleDynamicType ())
745         UpdateValueIfNeeded(false);
746 
747     std::vector<uint32_t> child_indexes;
748     bool omit_empty_base_classes = true;
749     const size_t num_child_indexes =  GetClangType().GetIndexOfChildMemberWithName (name.GetCString(),
750                                                                                     omit_empty_base_classes,
751                                                                                     child_indexes);
752     if (num_child_indexes > 0)
753     {
754         std::vector<uint32_t>::const_iterator pos = child_indexes.begin ();
755         std::vector<uint32_t>::const_iterator end = child_indexes.end ();
756 
757         child_sp = GetChildAtIndex(*pos, can_create);
758         for (++pos; pos != end; ++pos)
759         {
760             if (child_sp)
761             {
762                 ValueObjectSP new_child_sp(child_sp->GetChildAtIndex (*pos, can_create));
763                 child_sp = new_child_sp;
764             }
765             else
766             {
767                 child_sp.reset();
768             }
769 
770         }
771     }
772     return child_sp;
773 }
774 
775 
776 size_t
777 ValueObject::GetNumChildren ()
778 {
779     UpdateValueIfNeeded();
780     if (!m_children_count_valid)
781     {
782         SetNumChildren (CalculateNumChildren());
783     }
784     return m_children.GetChildrenCount();
785 }
786 
787 bool
788 ValueObject::MightHaveChildren()
789 {
790     bool has_children = false;
791     const uint32_t type_info = GetTypeInfo();
792     if (type_info)
793     {
794         if (type_info & (eTypeHasChildren |
795                          eTypeIsPointer |
796                          eTypeIsReference))
797             has_children = true;
798     }
799     else
800     {
801         has_children = GetNumChildren () > 0;
802     }
803     return has_children;
804 }
805 
806 // Should only be called by ValueObject::GetNumChildren()
807 void
808 ValueObject::SetNumChildren (size_t num_children)
809 {
810     m_children_count_valid = true;
811     m_children.SetChildrenCount(num_children);
812 }
813 
814 void
815 ValueObject::SetName (const ConstString &name)
816 {
817     m_name = name;
818 }
819 
820 ValueObject *
821 ValueObject::CreateChildAtIndex (size_t idx, bool synthetic_array_member, int32_t synthetic_index)
822 {
823     ValueObject *valobj = NULL;
824 
825     bool omit_empty_base_classes = true;
826     bool ignore_array_bounds = synthetic_array_member;
827     std::string child_name_str;
828     uint32_t child_byte_size = 0;
829     int32_t child_byte_offset = 0;
830     uint32_t child_bitfield_bit_size = 0;
831     uint32_t child_bitfield_bit_offset = 0;
832     bool child_is_base_class = false;
833     bool child_is_deref_of_parent = false;
834 
835     const bool transparent_pointers = synthetic_array_member == false;
836     ClangASTType child_clang_type;
837 
838     ExecutionContext exe_ctx (GetExecutionContextRef());
839 
840     child_clang_type = GetClangType().GetChildClangTypeAtIndex (&exe_ctx,
841                                                                 idx,
842                                                                 transparent_pointers,
843                                                                 omit_empty_base_classes,
844                                                                 ignore_array_bounds,
845                                                                 child_name_str,
846                                                                 child_byte_size,
847                                                                 child_byte_offset,
848                                                                 child_bitfield_bit_size,
849                                                                 child_bitfield_bit_offset,
850                                                                 child_is_base_class,
851                                                                 child_is_deref_of_parent,
852                                                                 this);
853     if (child_clang_type)
854     {
855         if (synthetic_index)
856             child_byte_offset += child_byte_size * synthetic_index;
857 
858         ConstString child_name;
859         if (!child_name_str.empty())
860             child_name.SetCString (child_name_str.c_str());
861 
862         valobj = new ValueObjectChild (*this,
863                                        child_clang_type,
864                                        child_name,
865                                        child_byte_size,
866                                        child_byte_offset,
867                                        child_bitfield_bit_size,
868                                        child_bitfield_bit_offset,
869                                        child_is_base_class,
870                                        child_is_deref_of_parent,
871                                        eAddressTypeInvalid);
872         //if (valobj)
873         //    valobj->SetAddressTypeOfChildren(eAddressTypeInvalid);
874    }
875 
876     return valobj;
877 }
878 
879 bool
880 ValueObject::GetSummaryAsCString (TypeSummaryImpl* summary_ptr,
881                                   std::string& destination)
882 {
883     return GetSummaryAsCString(summary_ptr, destination, TypeSummaryOptions());
884 }
885 
886 bool
887 ValueObject::GetSummaryAsCString (TypeSummaryImpl* summary_ptr,
888                                   std::string& destination,
889                                   const TypeSummaryOptions& options)
890 {
891     destination.clear();
892 
893     // ideally we would like to bail out if passing NULL, but if we do so
894     // we end up not providing the summary for function pointers anymore
895     if (/*summary_ptr == NULL ||*/ m_is_getting_summary)
896         return false;
897 
898     m_is_getting_summary = true;
899 
900     // this is a hot path in code and we prefer to avoid setting this string all too often also clearing out other
901     // information that we might care to see in a crash log. might be useful in very specific situations though.
902     /*Host::SetCrashDescriptionWithFormat("Trying to fetch a summary for %s %s. Summary provider's description is %s",
903                                         GetTypeName().GetCString(),
904                                         GetName().GetCString(),
905                                         summary_ptr->GetDescription().c_str());*/
906 
907     if (UpdateValueIfNeeded (false) && summary_ptr)
908     {
909         if (HasSyntheticValue())
910             m_synthetic_value->UpdateValueIfNeeded(); // the summary might depend on the synthetic children being up-to-date (e.g. ${svar%#})
911         summary_ptr->FormatObject(this, destination, options);
912     }
913     m_is_getting_summary = false;
914     return !destination.empty();
915 }
916 
917 const char *
918 ValueObject::GetSummaryAsCString ()
919 {
920     if (UpdateValueIfNeeded(true) && m_summary_str.empty())
921     {
922         GetSummaryAsCString(GetSummaryFormat().get(),
923                             m_summary_str,
924                             TypeSummaryOptions());
925     }
926     if (m_summary_str.empty())
927         return NULL;
928     return m_summary_str.c_str();
929 }
930 
931 bool
932 ValueObject::GetSummaryAsCString (std::string& destination,
933                                   const TypeSummaryOptions& options)
934 {
935     return GetSummaryAsCString(GetSummaryFormat().get(),
936                         destination,
937                         options);
938 }
939 
940 bool
941 ValueObject::IsCStringContainer(bool check_pointer)
942 {
943     ClangASTType pointee_or_element_clang_type;
944     const Flags type_flags (GetTypeInfo (&pointee_or_element_clang_type));
945     bool is_char_arr_ptr (type_flags.AnySet (eTypeIsArray | eTypeIsPointer) &&
946                           pointee_or_element_clang_type.IsCharType ());
947     if (!is_char_arr_ptr)
948         return false;
949     if (!check_pointer)
950         return true;
951     if (type_flags.Test(eTypeIsArray))
952         return true;
953     addr_t cstr_address = LLDB_INVALID_ADDRESS;
954     AddressType cstr_address_type = eAddressTypeInvalid;
955     cstr_address = GetAddressOf (true, &cstr_address_type);
956     return (cstr_address != LLDB_INVALID_ADDRESS);
957 }
958 
959 size_t
960 ValueObject::GetPointeeData (DataExtractor& data,
961                              uint32_t item_idx,
962                              uint32_t item_count)
963 {
964     ClangASTType pointee_or_element_clang_type;
965     const uint32_t type_info = GetTypeInfo (&pointee_or_element_clang_type);
966     const bool is_pointer_type = type_info & eTypeIsPointer;
967     const bool is_array_type = type_info & eTypeIsArray;
968     if (!(is_pointer_type || is_array_type))
969         return 0;
970 
971     if (item_count == 0)
972         return 0;
973 
974     ExecutionContext exe_ctx (GetExecutionContextRef());
975 
976     const uint64_t item_type_size = pointee_or_element_clang_type.GetByteSize(exe_ctx.GetBestExecutionContextScope());
977     const uint64_t bytes = item_count * item_type_size;
978     const uint64_t offset = item_idx * item_type_size;
979 
980     if (item_idx == 0 && item_count == 1) // simply a deref
981     {
982         if (is_pointer_type)
983         {
984             Error error;
985             ValueObjectSP pointee_sp = Dereference(error);
986             if (error.Fail() || pointee_sp.get() == NULL)
987                 return 0;
988             return pointee_sp->GetData(data, error);
989         }
990         else
991         {
992             ValueObjectSP child_sp = GetChildAtIndex(0, true);
993             if (child_sp.get() == NULL)
994                 return 0;
995             Error error;
996             return child_sp->GetData(data, error);
997         }
998         return true;
999     }
1000     else /* (items > 1) */
1001     {
1002         Error error;
1003         lldb_private::DataBufferHeap* heap_buf_ptr = NULL;
1004         lldb::DataBufferSP data_sp(heap_buf_ptr = new lldb_private::DataBufferHeap());
1005 
1006         AddressType addr_type;
1007         lldb::addr_t addr = is_pointer_type ? GetPointerValue(&addr_type) : GetAddressOf(true, &addr_type);
1008 
1009         switch (addr_type)
1010         {
1011             case eAddressTypeFile:
1012                 {
1013                     ModuleSP module_sp (GetModule());
1014                     if (module_sp)
1015                     {
1016                         addr = addr + offset;
1017                         Address so_addr;
1018                         module_sp->ResolveFileAddress(addr, so_addr);
1019                         ExecutionContext exe_ctx (GetExecutionContextRef());
1020                         Target* target = exe_ctx.GetTargetPtr();
1021                         if (target)
1022                         {
1023                             heap_buf_ptr->SetByteSize(bytes);
1024                             size_t bytes_read = target->ReadMemory(so_addr, false, heap_buf_ptr->GetBytes(), bytes, error);
1025                             if (error.Success())
1026                             {
1027                                 data.SetData(data_sp);
1028                                 return bytes_read;
1029                             }
1030                         }
1031                     }
1032                 }
1033                 break;
1034             case eAddressTypeLoad:
1035                 {
1036                     ExecutionContext exe_ctx (GetExecutionContextRef());
1037                     Process *process = exe_ctx.GetProcessPtr();
1038                     if (process)
1039                     {
1040                         heap_buf_ptr->SetByteSize(bytes);
1041                         size_t bytes_read = process->ReadMemory(addr + offset, heap_buf_ptr->GetBytes(), bytes, error);
1042                         if (error.Success() || bytes_read > 0)
1043                         {
1044                             data.SetData(data_sp);
1045                             return bytes_read;
1046                         }
1047                     }
1048                 }
1049                 break;
1050             case eAddressTypeHost:
1051                 {
1052                     const uint64_t max_bytes = GetClangType().GetByteSize(exe_ctx.GetBestExecutionContextScope());
1053                     if (max_bytes > offset)
1054                     {
1055                         size_t bytes_read = std::min<uint64_t>(max_bytes - offset, bytes);
1056                         heap_buf_ptr->CopyData((uint8_t*)(addr + offset), bytes_read);
1057                         data.SetData(data_sp);
1058                         return bytes_read;
1059                     }
1060                 }
1061                 break;
1062             case eAddressTypeInvalid:
1063                 break;
1064         }
1065     }
1066     return 0;
1067 }
1068 
1069 uint64_t
1070 ValueObject::GetData (DataExtractor& data, Error &error)
1071 {
1072     UpdateValueIfNeeded(false);
1073     ExecutionContext exe_ctx (GetExecutionContextRef());
1074     error = m_value.GetValueAsData(&exe_ctx, data, 0, GetModule().get());
1075     if (error.Fail())
1076     {
1077         if (m_data.GetByteSize())
1078         {
1079             data = m_data;
1080             return data.GetByteSize();
1081         }
1082         else
1083         {
1084             return 0;
1085         }
1086     }
1087     data.SetAddressByteSize(m_data.GetAddressByteSize());
1088     data.SetByteOrder(m_data.GetByteOrder());
1089     return data.GetByteSize();
1090 }
1091 
1092 bool
1093 ValueObject::SetData (DataExtractor &data, Error &error)
1094 {
1095     error.Clear();
1096     // Make sure our value is up to date first so that our location and location
1097     // type is valid.
1098     if (!UpdateValueIfNeeded(false))
1099     {
1100         error.SetErrorString("unable to read value");
1101         return false;
1102     }
1103 
1104     uint64_t count = 0;
1105     const Encoding encoding = GetClangType().GetEncoding(count);
1106 
1107     const size_t byte_size = GetByteSize();
1108 
1109     Value::ValueType value_type = m_value.GetValueType();
1110 
1111     switch (value_type)
1112     {
1113     case Value::eValueTypeScalar:
1114         {
1115             Error set_error = m_value.GetScalar().SetValueFromData(data, encoding, byte_size);
1116 
1117             if (!set_error.Success())
1118             {
1119                 error.SetErrorStringWithFormat("unable to set scalar value: %s", set_error.AsCString());
1120                 return false;
1121             }
1122         }
1123         break;
1124     case Value::eValueTypeLoadAddress:
1125         {
1126             // If it is a load address, then the scalar value is the storage location
1127             // of the data, and we have to shove this value down to that load location.
1128             ExecutionContext exe_ctx (GetExecutionContextRef());
1129             Process *process = exe_ctx.GetProcessPtr();
1130             if (process)
1131             {
1132                 addr_t target_addr = m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
1133                 size_t bytes_written = process->WriteMemory(target_addr,
1134                                                             data.GetDataStart(),
1135                                                             byte_size,
1136                                                             error);
1137                 if (!error.Success())
1138                     return false;
1139                 if (bytes_written != byte_size)
1140                 {
1141                     error.SetErrorString("unable to write value to memory");
1142                     return false;
1143                 }
1144             }
1145         }
1146         break;
1147     case Value::eValueTypeHostAddress:
1148         {
1149             // If it is a host address, then we stuff the scalar as a DataBuffer into the Value's data.
1150             DataBufferSP buffer_sp (new DataBufferHeap(byte_size, 0));
1151             m_data.SetData(buffer_sp, 0);
1152             data.CopyByteOrderedData (0,
1153                                       byte_size,
1154                                       const_cast<uint8_t *>(m_data.GetDataStart()),
1155                                       byte_size,
1156                                       m_data.GetByteOrder());
1157             m_value.GetScalar() = (uintptr_t)m_data.GetDataStart();
1158         }
1159         break;
1160     case Value::eValueTypeFileAddress:
1161     case Value::eValueTypeVector:
1162         break;
1163     }
1164 
1165     // If we have reached this point, then we have successfully changed the value.
1166     SetNeedsUpdate();
1167     return true;
1168 }
1169 
1170 // will compute strlen(str), but without consuming more than
1171 // maxlen bytes out of str (this serves the purpose of reading
1172 // chunks of a string without having to worry about
1173 // missing NULL terminators in the chunk)
1174 // of course, if strlen(str) > maxlen, the function will return
1175 // maxlen_value (which should be != maxlen, because that allows you
1176 // to know whether strlen(str) == maxlen or strlen(str) > maxlen)
1177 static uint32_t
1178 strlen_or_inf (const char* str,
1179                uint32_t maxlen,
1180                uint32_t maxlen_value)
1181 {
1182     uint32_t len = 0;
1183     if (str)
1184     {
1185         while(*str)
1186         {
1187             len++;str++;
1188             if (len >= maxlen)
1189                 return maxlen_value;
1190         }
1191     }
1192     return len;
1193 }
1194 
1195 static bool
1196 CopyStringDataToBufferSP(const StreamString& source,
1197                          lldb::DataBufferSP& destination)
1198 {
1199     destination.reset(new DataBufferHeap(source.GetSize()+1,0));
1200     memcpy(destination->GetBytes(), source.GetString().c_str(), source.GetSize());
1201     return true;
1202 }
1203 
1204 size_t
1205 ValueObject::ReadPointedString (lldb::DataBufferSP& buffer_sp,
1206                                 Error& error,
1207                                 uint32_t max_length,
1208                                 bool honor_array,
1209                                 Format item_format)
1210 {
1211     StreamString s;
1212     ExecutionContext exe_ctx (GetExecutionContextRef());
1213     Target* target = exe_ctx.GetTargetPtr();
1214 
1215     if (!target)
1216     {
1217         s << "<no target to read from>";
1218         error.SetErrorString("no target to read from");
1219         CopyStringDataToBufferSP(s, buffer_sp);
1220         return 0;
1221     }
1222 
1223     if (max_length == 0)
1224         max_length = target->GetMaximumSizeOfStringSummary();
1225 
1226     size_t bytes_read = 0;
1227     size_t total_bytes_read = 0;
1228 
1229     ClangASTType clang_type = GetClangType();
1230     ClangASTType elem_or_pointee_clang_type;
1231     const Flags type_flags (GetTypeInfo (&elem_or_pointee_clang_type));
1232     if (type_flags.AnySet (eTypeIsArray | eTypeIsPointer) &&
1233         elem_or_pointee_clang_type.IsCharType ())
1234     {
1235         addr_t cstr_address = LLDB_INVALID_ADDRESS;
1236         AddressType cstr_address_type = eAddressTypeInvalid;
1237 
1238         size_t cstr_len = 0;
1239         bool capped_data = false;
1240         if (type_flags.Test (eTypeIsArray))
1241         {
1242             // We have an array
1243             uint64_t array_size = 0;
1244             if (clang_type.IsArrayType(NULL, &array_size, NULL))
1245             {
1246                 cstr_len = array_size;
1247                 if (cstr_len > max_length)
1248                 {
1249                     capped_data = true;
1250                     cstr_len = max_length;
1251                 }
1252             }
1253             cstr_address = GetAddressOf (true, &cstr_address_type);
1254         }
1255         else
1256         {
1257             // We have a pointer
1258             cstr_address = GetPointerValue (&cstr_address_type);
1259         }
1260 
1261         if (cstr_address == 0 || cstr_address == LLDB_INVALID_ADDRESS)
1262         {
1263             s << "<invalid address>";
1264             error.SetErrorString("invalid address");
1265             CopyStringDataToBufferSP(s, buffer_sp);
1266             return 0;
1267         }
1268 
1269         Address cstr_so_addr (cstr_address);
1270         DataExtractor data;
1271         if (cstr_len > 0 && honor_array)
1272         {
1273             // I am using GetPointeeData() here to abstract the fact that some ValueObjects are actually frozen pointers in the host
1274             // but the pointed-to data lives in the debuggee, and GetPointeeData() automatically takes care of this
1275             GetPointeeData(data, 0, cstr_len);
1276 
1277             if ((bytes_read = data.GetByteSize()) > 0)
1278             {
1279                 total_bytes_read = bytes_read;
1280                 for (size_t offset = 0; offset < bytes_read; offset++)
1281                     s.Printf("%c", *data.PeekData(offset, 1));
1282                 if (capped_data)
1283                     s << "...";
1284             }
1285         }
1286         else
1287         {
1288             cstr_len = max_length;
1289             const size_t k_max_buf_size = 64;
1290 
1291             size_t offset = 0;
1292 
1293             int cstr_len_displayed = -1;
1294             bool capped_cstr = false;
1295             // I am using GetPointeeData() here to abstract the fact that some ValueObjects are actually frozen pointers in the host
1296             // but the pointed-to data lives in the debuggee, and GetPointeeData() automatically takes care of this
1297             while ((bytes_read = GetPointeeData(data, offset, k_max_buf_size)) > 0)
1298             {
1299                 total_bytes_read += bytes_read;
1300                 const char *cstr = data.PeekCStr(0);
1301                 size_t len = strlen_or_inf (cstr, k_max_buf_size, k_max_buf_size+1);
1302                 if (len > k_max_buf_size)
1303                     len = k_max_buf_size;
1304 
1305                 if (cstr_len_displayed < 0)
1306                     cstr_len_displayed = len;
1307 
1308                 if (len == 0)
1309                     break;
1310                 cstr_len_displayed += len;
1311                 if (len > bytes_read)
1312                     len = bytes_read;
1313                 if (len > cstr_len)
1314                     len = cstr_len;
1315 
1316                 for (size_t offset = 0; offset < bytes_read; offset++)
1317                     s.Printf("%c", *data.PeekData(offset, 1));
1318 
1319                 if (len < k_max_buf_size)
1320                     break;
1321 
1322                 if (len >= cstr_len)
1323                 {
1324                     capped_cstr = true;
1325                     break;
1326                 }
1327 
1328                 cstr_len -= len;
1329                 offset += len;
1330             }
1331 
1332             if (cstr_len_displayed >= 0)
1333             {
1334                 if (capped_cstr)
1335                     s << "...";
1336             }
1337         }
1338     }
1339     else
1340     {
1341         error.SetErrorString("not a string object");
1342         s << "<not a string object>";
1343     }
1344     CopyStringDataToBufferSP(s, buffer_sp);
1345     return total_bytes_read;
1346 }
1347 
1348 std::pair<TypeValidatorResult, std::string>
1349 ValueObject::GetValidationStatus ()
1350 {
1351     if (!UpdateValueIfNeeded(true))
1352         return {TypeValidatorResult::Success,""}; // not the validator's job to discuss update problems
1353 
1354     if (m_validation_result.hasValue())
1355         return m_validation_result.getValue();
1356 
1357     if (!m_type_validator_sp)
1358         return {TypeValidatorResult::Success,""}; // no validator no failure
1359 
1360     auto outcome = m_type_validator_sp->FormatObject(this);
1361 
1362     return (m_validation_result = {outcome.m_result,outcome.m_message}).getValue();
1363 }
1364 
1365 const char *
1366 ValueObject::GetObjectDescription ()
1367 {
1368 
1369     if (!UpdateValueIfNeeded (true))
1370         return NULL;
1371 
1372     if (!m_object_desc_str.empty())
1373         return m_object_desc_str.c_str();
1374 
1375     ExecutionContext exe_ctx (GetExecutionContextRef());
1376     Process *process = exe_ctx.GetProcessPtr();
1377     if (process == NULL)
1378         return NULL;
1379 
1380     StreamString s;
1381 
1382     LanguageType language = GetObjectRuntimeLanguage();
1383     LanguageRuntime *runtime = process->GetLanguageRuntime(language);
1384 
1385     if (runtime == NULL)
1386     {
1387         // Aw, hell, if the things a pointer, or even just an integer, let's try ObjC anyway...
1388         ClangASTType clang_type = GetClangType();
1389         if (clang_type)
1390         {
1391             bool is_signed;
1392             if (clang_type.IsIntegerType (is_signed) || clang_type.IsPointerType ())
1393             {
1394                 runtime = process->GetLanguageRuntime(eLanguageTypeObjC);
1395             }
1396         }
1397     }
1398 
1399     if (runtime && runtime->GetObjectDescription(s, *this))
1400     {
1401         m_object_desc_str.append (s.GetData());
1402     }
1403 
1404     if (m_object_desc_str.empty())
1405         return NULL;
1406     else
1407         return m_object_desc_str.c_str();
1408 }
1409 
1410 bool
1411 ValueObject::GetValueAsCString (const lldb_private::TypeFormatImpl& format,
1412                                 std::string& destination)
1413 {
1414     if (UpdateValueIfNeeded(false))
1415         return format.FormatObject(this,destination);
1416     else
1417         return false;
1418 }
1419 
1420 bool
1421 ValueObject::GetValueAsCString (lldb::Format format,
1422                                 std::string& destination)
1423 {
1424     return GetValueAsCString(TypeFormatImpl_Format(format),destination);
1425 }
1426 
1427 const char *
1428 ValueObject::GetValueAsCString ()
1429 {
1430     if (UpdateValueIfNeeded(true))
1431     {
1432         lldb::TypeFormatImplSP format_sp;
1433         lldb::Format my_format = GetFormat();
1434         if (my_format == lldb::eFormatDefault)
1435         {
1436             if (m_type_format_sp)
1437                 format_sp = m_type_format_sp;
1438             else
1439             {
1440                 if (m_is_bitfield_for_scalar)
1441                     my_format = eFormatUnsigned;
1442                 else
1443                 {
1444                     if (m_value.GetContextType() == Value::eContextTypeRegisterInfo)
1445                     {
1446                         const RegisterInfo *reg_info = m_value.GetRegisterInfo();
1447                         if (reg_info)
1448                             my_format = reg_info->format;
1449                     }
1450                     else
1451                     {
1452                         my_format = GetValue().GetClangType().GetFormat();
1453                     }
1454                 }
1455             }
1456         }
1457         if (my_format != m_last_format || m_value_str.empty())
1458         {
1459             m_last_format = my_format;
1460             if (!format_sp)
1461                 format_sp.reset(new TypeFormatImpl_Format(my_format));
1462             if (GetValueAsCString(*format_sp.get(), m_value_str))
1463             {
1464                 if (!m_value_did_change && m_old_value_valid)
1465                 {
1466                     // The value was gotten successfully, so we consider the
1467                     // value as changed if the value string differs
1468                     SetValueDidChange (m_old_value_str != m_value_str);
1469                 }
1470             }
1471         }
1472     }
1473     if (m_value_str.empty())
1474         return NULL;
1475     return m_value_str.c_str();
1476 }
1477 
1478 // if > 8bytes, 0 is returned. this method should mostly be used
1479 // to read address values out of pointers
1480 uint64_t
1481 ValueObject::GetValueAsUnsigned (uint64_t fail_value, bool *success)
1482 {
1483     // If our byte size is zero this is an aggregate type that has children
1484     if (CanProvideValue())
1485     {
1486         Scalar scalar;
1487         if (ResolveValue (scalar))
1488         {
1489             if (success)
1490                 *success = true;
1491             return scalar.ULongLong(fail_value);
1492         }
1493         // fallthrough, otherwise...
1494     }
1495 
1496     if (success)
1497         *success = false;
1498     return fail_value;
1499 }
1500 
1501 int64_t
1502 ValueObject::GetValueAsSigned (int64_t fail_value, bool *success)
1503 {
1504     // If our byte size is zero this is an aggregate type that has children
1505     if (CanProvideValue())
1506     {
1507         Scalar scalar;
1508         if (ResolveValue (scalar))
1509         {
1510             if (success)
1511                 *success = true;
1512             return scalar.SLongLong(fail_value);
1513         }
1514         // fallthrough, otherwise...
1515     }
1516 
1517     if (success)
1518         *success = false;
1519     return fail_value;
1520 }
1521 
1522 // if any more "special cases" are added to ValueObject::DumpPrintableRepresentation() please keep
1523 // this call up to date by returning true for your new special cases. We will eventually move
1524 // to checking this call result before trying to display special cases
1525 bool
1526 ValueObject::HasSpecialPrintableRepresentation(ValueObjectRepresentationStyle val_obj_display,
1527                                                Format custom_format)
1528 {
1529     Flags flags(GetTypeInfo());
1530     if (flags.AnySet(eTypeIsArray | eTypeIsPointer)
1531         && val_obj_display == ValueObject::eValueObjectRepresentationStyleValue)
1532     {
1533         if (IsCStringContainer(true) &&
1534             (custom_format == eFormatCString ||
1535              custom_format == eFormatCharArray ||
1536              custom_format == eFormatChar ||
1537              custom_format == eFormatVectorOfChar))
1538             return true;
1539 
1540         if (flags.Test(eTypeIsArray))
1541         {
1542             if ((custom_format == eFormatBytes) ||
1543                 (custom_format == eFormatBytesWithASCII))
1544                 return true;
1545 
1546             if ((custom_format == eFormatVectorOfChar) ||
1547                 (custom_format == eFormatVectorOfFloat32) ||
1548                 (custom_format == eFormatVectorOfFloat64) ||
1549                 (custom_format == eFormatVectorOfSInt16) ||
1550                 (custom_format == eFormatVectorOfSInt32) ||
1551                 (custom_format == eFormatVectorOfSInt64) ||
1552                 (custom_format == eFormatVectorOfSInt8) ||
1553                 (custom_format == eFormatVectorOfUInt128) ||
1554                 (custom_format == eFormatVectorOfUInt16) ||
1555                 (custom_format == eFormatVectorOfUInt32) ||
1556                 (custom_format == eFormatVectorOfUInt64) ||
1557                 (custom_format == eFormatVectorOfUInt8))
1558                 return true;
1559         }
1560     }
1561     return false;
1562 }
1563 
1564 bool
1565 ValueObject::DumpPrintableRepresentation(Stream& s,
1566                                          ValueObjectRepresentationStyle val_obj_display,
1567                                          Format custom_format,
1568                                          PrintableRepresentationSpecialCases special,
1569                                          bool do_dump_error)
1570 {
1571 
1572     Flags flags(GetTypeInfo());
1573 
1574     bool allow_special = ((special & ePrintableRepresentationSpecialCasesAllow) == ePrintableRepresentationSpecialCasesAllow);
1575     bool only_special = ((special & ePrintableRepresentationSpecialCasesOnly) == ePrintableRepresentationSpecialCasesOnly);
1576 
1577     if (allow_special)
1578     {
1579         if (flags.AnySet(eTypeIsArray | eTypeIsPointer)
1580              && val_obj_display == ValueObject::eValueObjectRepresentationStyleValue)
1581         {
1582             // when being asked to get a printable display an array or pointer type directly,
1583             // try to "do the right thing"
1584 
1585             if (IsCStringContainer(true) &&
1586                 (custom_format == eFormatCString ||
1587                  custom_format == eFormatCharArray ||
1588                  custom_format == eFormatChar ||
1589                  custom_format == eFormatVectorOfChar)) // print char[] & char* directly
1590             {
1591                 Error error;
1592                 lldb::DataBufferSP buffer_sp;
1593                 ReadPointedString(buffer_sp,
1594                                   error,
1595                                   0,
1596                                   (custom_format == eFormatVectorOfChar) ||
1597                                   (custom_format == eFormatCharArray));
1598                 lldb_private::formatters::ReadBufferAndDumpToStreamOptions options(*this);
1599                 options.SetData(DataExtractor(buffer_sp, lldb::eByteOrderInvalid, 8)); // none of this matters for a string - pass some defaults
1600                 options.SetStream(&s);
1601                 options.SetPrefixToken(0);
1602                 options.SetQuote('"');
1603                 options.SetSourceSize(buffer_sp->GetByteSize());
1604                 lldb_private::formatters::ReadBufferAndDumpToStream<lldb_private::formatters::StringElementType::ASCII>(options);
1605                 return !error.Fail();
1606             }
1607 
1608             if (custom_format == eFormatEnum)
1609                 return false;
1610 
1611             // this only works for arrays, because I have no way to know when
1612             // the pointed memory ends, and no special \0 end of data marker
1613             if (flags.Test(eTypeIsArray))
1614             {
1615                 if ((custom_format == eFormatBytes) ||
1616                     (custom_format == eFormatBytesWithASCII))
1617                 {
1618                     const size_t count = GetNumChildren();
1619 
1620                     s << '[';
1621                     for (size_t low = 0; low < count; low++)
1622                     {
1623 
1624                         if (low)
1625                             s << ',';
1626 
1627                         ValueObjectSP child = GetChildAtIndex(low,true);
1628                         if (!child.get())
1629                         {
1630                             s << "<invalid child>";
1631                             continue;
1632                         }
1633                         child->DumpPrintableRepresentation(s, ValueObject::eValueObjectRepresentationStyleValue, custom_format);
1634                     }
1635 
1636                     s << ']';
1637 
1638                     return true;
1639                 }
1640 
1641                 if ((custom_format == eFormatVectorOfChar) ||
1642                     (custom_format == eFormatVectorOfFloat32) ||
1643                     (custom_format == eFormatVectorOfFloat64) ||
1644                     (custom_format == eFormatVectorOfSInt16) ||
1645                     (custom_format == eFormatVectorOfSInt32) ||
1646                     (custom_format == eFormatVectorOfSInt64) ||
1647                     (custom_format == eFormatVectorOfSInt8) ||
1648                     (custom_format == eFormatVectorOfUInt128) ||
1649                     (custom_format == eFormatVectorOfUInt16) ||
1650                     (custom_format == eFormatVectorOfUInt32) ||
1651                     (custom_format == eFormatVectorOfUInt64) ||
1652                     (custom_format == eFormatVectorOfUInt8)) // arrays of bytes, bytes with ASCII or any vector format should be printed directly
1653                 {
1654                     const size_t count = GetNumChildren();
1655 
1656                     Format format = FormatManager::GetSingleItemFormat(custom_format);
1657 
1658                     s << '[';
1659                     for (size_t low = 0; low < count; low++)
1660                     {
1661 
1662                         if (low)
1663                             s << ',';
1664 
1665                         ValueObjectSP child = GetChildAtIndex(low,true);
1666                         if (!child.get())
1667                         {
1668                             s << "<invalid child>";
1669                             continue;
1670                         }
1671                         child->DumpPrintableRepresentation(s, ValueObject::eValueObjectRepresentationStyleValue, format);
1672                     }
1673 
1674                     s << ']';
1675 
1676                     return true;
1677                 }
1678             }
1679 
1680             if ((custom_format == eFormatBoolean) ||
1681                 (custom_format == eFormatBinary) ||
1682                 (custom_format == eFormatChar) ||
1683                 (custom_format == eFormatCharPrintable) ||
1684                 (custom_format == eFormatComplexFloat) ||
1685                 (custom_format == eFormatDecimal) ||
1686                 (custom_format == eFormatHex) ||
1687                 (custom_format == eFormatHexUppercase) ||
1688                 (custom_format == eFormatFloat) ||
1689                 (custom_format == eFormatOctal) ||
1690                 (custom_format == eFormatOSType) ||
1691                 (custom_format == eFormatUnicode16) ||
1692                 (custom_format == eFormatUnicode32) ||
1693                 (custom_format == eFormatUnsigned) ||
1694                 (custom_format == eFormatPointer) ||
1695                 (custom_format == eFormatComplexInteger) ||
1696                 (custom_format == eFormatComplex) ||
1697                 (custom_format == eFormatDefault)) // use the [] operator
1698                 return false;
1699         }
1700     }
1701 
1702     if (only_special)
1703         return false;
1704 
1705     bool var_success = false;
1706 
1707     {
1708         const char *cstr = NULL;
1709 
1710          // this is a local stream that we are using to ensure that the data pointed to by cstr survives
1711         // long enough for us to copy it to its destination - it is necessary to have this temporary storage
1712         // area for cases where our desired output is not backed by some other longer-term storage
1713         StreamString strm;
1714 
1715         if (custom_format != eFormatInvalid)
1716             SetFormat(custom_format);
1717 
1718         switch(val_obj_display)
1719         {
1720             case eValueObjectRepresentationStyleValue:
1721                 cstr = GetValueAsCString();
1722                 break;
1723 
1724             case eValueObjectRepresentationStyleSummary:
1725                 cstr = GetSummaryAsCString();
1726                 break;
1727 
1728             case eValueObjectRepresentationStyleLanguageSpecific:
1729                 cstr = GetObjectDescription();
1730                 break;
1731 
1732             case eValueObjectRepresentationStyleLocation:
1733                 cstr = GetLocationAsCString();
1734                 break;
1735 
1736             case eValueObjectRepresentationStyleChildrenCount:
1737                 strm.Printf("%" PRIu64 "", (uint64_t)GetNumChildren());
1738                 cstr = strm.GetString().c_str();
1739                 break;
1740 
1741             case eValueObjectRepresentationStyleType:
1742                 cstr = GetTypeName().AsCString();
1743                 break;
1744 
1745             case eValueObjectRepresentationStyleName:
1746                 cstr = GetName().AsCString();
1747                 break;
1748 
1749             case eValueObjectRepresentationStyleExpressionPath:
1750                 GetExpressionPath(strm, false);
1751                 cstr = strm.GetString().c_str();
1752                 break;
1753         }
1754 
1755         if (!cstr)
1756         {
1757             if (val_obj_display == eValueObjectRepresentationStyleValue)
1758                 cstr = GetSummaryAsCString();
1759             else if (val_obj_display == eValueObjectRepresentationStyleSummary)
1760             {
1761                 if (!CanProvideValue())
1762                 {
1763                     strm.Printf("%s @ %s", GetTypeName().AsCString(), GetLocationAsCString());
1764                     cstr = strm.GetString().c_str();
1765                 }
1766                 else
1767                     cstr = GetValueAsCString();
1768             }
1769         }
1770 
1771         if (cstr)
1772             s.PutCString(cstr);
1773         else
1774         {
1775             if (m_error.Fail())
1776             {
1777                 if (do_dump_error)
1778                     s.Printf("<%s>", m_error.AsCString());
1779                 else
1780                     return false;
1781             }
1782             else if (val_obj_display == eValueObjectRepresentationStyleSummary)
1783                 s.PutCString("<no summary available>");
1784             else if (val_obj_display == eValueObjectRepresentationStyleValue)
1785                 s.PutCString("<no value available>");
1786             else if (val_obj_display == eValueObjectRepresentationStyleLanguageSpecific)
1787                 s.PutCString("<not a valid Objective-C object>"); // edit this if we have other runtimes that support a description
1788             else
1789                 s.PutCString("<no printable representation>");
1790         }
1791 
1792         // we should only return false here if we could not do *anything*
1793         // even if we have an error message as output, that's a success
1794         // from our callers' perspective, so return true
1795         var_success = true;
1796 
1797         if (custom_format != eFormatInvalid)
1798             SetFormat(eFormatDefault);
1799     }
1800 
1801     return var_success;
1802 }
1803 
1804 addr_t
1805 ValueObject::GetAddressOf (bool scalar_is_load_address, AddressType *address_type)
1806 {
1807     if (!UpdateValueIfNeeded(false))
1808         return LLDB_INVALID_ADDRESS;
1809 
1810     switch (m_value.GetValueType())
1811     {
1812     case Value::eValueTypeScalar:
1813     case Value::eValueTypeVector:
1814         if (scalar_is_load_address)
1815         {
1816             if(address_type)
1817                 *address_type = eAddressTypeLoad;
1818             return m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
1819         }
1820         break;
1821 
1822     case Value::eValueTypeLoadAddress:
1823     case Value::eValueTypeFileAddress:
1824     case Value::eValueTypeHostAddress:
1825         {
1826             if(address_type)
1827                 *address_type = m_value.GetValueAddressType ();
1828             return m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
1829         }
1830         break;
1831     }
1832     if (address_type)
1833         *address_type = eAddressTypeInvalid;
1834     return LLDB_INVALID_ADDRESS;
1835 }
1836 
1837 addr_t
1838 ValueObject::GetPointerValue (AddressType *address_type)
1839 {
1840     addr_t address = LLDB_INVALID_ADDRESS;
1841     if(address_type)
1842         *address_type = eAddressTypeInvalid;
1843 
1844     if (!UpdateValueIfNeeded(false))
1845         return address;
1846 
1847     switch (m_value.GetValueType())
1848     {
1849     case Value::eValueTypeScalar:
1850     case Value::eValueTypeVector:
1851         address = m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
1852         break;
1853 
1854     case Value::eValueTypeHostAddress:
1855     case Value::eValueTypeLoadAddress:
1856     case Value::eValueTypeFileAddress:
1857         {
1858             lldb::offset_t data_offset = 0;
1859             address = m_data.GetPointer(&data_offset);
1860         }
1861         break;
1862     }
1863 
1864     if (address_type)
1865         *address_type = GetAddressTypeOfChildren();
1866 
1867     return address;
1868 }
1869 
1870 bool
1871 ValueObject::SetValueFromCString (const char *value_str, Error& error)
1872 {
1873     error.Clear();
1874     // Make sure our value is up to date first so that our location and location
1875     // type is valid.
1876     if (!UpdateValueIfNeeded(false))
1877     {
1878         error.SetErrorString("unable to read value");
1879         return false;
1880     }
1881 
1882     uint64_t count = 0;
1883     const Encoding encoding = GetClangType().GetEncoding (count);
1884 
1885     const size_t byte_size = GetByteSize();
1886 
1887     Value::ValueType value_type = m_value.GetValueType();
1888 
1889     if (value_type == Value::eValueTypeScalar)
1890     {
1891         // If the value is already a scalar, then let the scalar change itself:
1892         m_value.GetScalar().SetValueFromCString (value_str, encoding, byte_size);
1893     }
1894     else if (byte_size <= Scalar::GetMaxByteSize())
1895     {
1896         // If the value fits in a scalar, then make a new scalar and again let the
1897         // scalar code do the conversion, then figure out where to put the new value.
1898         Scalar new_scalar;
1899         error = new_scalar.SetValueFromCString (value_str, encoding, byte_size);
1900         if (error.Success())
1901         {
1902             switch (value_type)
1903             {
1904             case Value::eValueTypeLoadAddress:
1905                 {
1906                     // If it is a load address, then the scalar value is the storage location
1907                     // of the data, and we have to shove this value down to that load location.
1908                     ExecutionContext exe_ctx (GetExecutionContextRef());
1909                     Process *process = exe_ctx.GetProcessPtr();
1910                     if (process)
1911                     {
1912                         addr_t target_addr = m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
1913                         size_t bytes_written = process->WriteScalarToMemory (target_addr,
1914                                                                              new_scalar,
1915                                                                              byte_size,
1916                                                                              error);
1917                         if (!error.Success())
1918                             return false;
1919                         if (bytes_written != byte_size)
1920                         {
1921                             error.SetErrorString("unable to write value to memory");
1922                             return false;
1923                         }
1924                     }
1925                 }
1926                 break;
1927             case Value::eValueTypeHostAddress:
1928                 {
1929                     // If it is a host address, then we stuff the scalar as a DataBuffer into the Value's data.
1930                     DataExtractor new_data;
1931                     new_data.SetByteOrder (m_data.GetByteOrder());
1932 
1933                     DataBufferSP buffer_sp (new DataBufferHeap(byte_size, 0));
1934                     m_data.SetData(buffer_sp, 0);
1935                     bool success = new_scalar.GetData(new_data);
1936                     if (success)
1937                     {
1938                         new_data.CopyByteOrderedData (0,
1939                                                       byte_size,
1940                                                       const_cast<uint8_t *>(m_data.GetDataStart()),
1941                                                       byte_size,
1942                                                       m_data.GetByteOrder());
1943                     }
1944                     m_value.GetScalar() = (uintptr_t)m_data.GetDataStart();
1945 
1946                 }
1947                 break;
1948             case Value::eValueTypeFileAddress:
1949             case Value::eValueTypeScalar:
1950             case Value::eValueTypeVector:
1951                 break;
1952             }
1953         }
1954         else
1955         {
1956             return false;
1957         }
1958     }
1959     else
1960     {
1961         // We don't support setting things bigger than a scalar at present.
1962         error.SetErrorString("unable to write aggregate data type");
1963         return false;
1964     }
1965 
1966     // If we have reached this point, then we have successfully changed the value.
1967     SetNeedsUpdate();
1968     return true;
1969 }
1970 
1971 bool
1972 ValueObject::GetDeclaration (Declaration &decl)
1973 {
1974     decl.Clear();
1975     return false;
1976 }
1977 
1978 ConstString
1979 ValueObject::GetTypeName()
1980 {
1981     return GetClangType().GetConstTypeName();
1982 }
1983 
1984 ConstString
1985 ValueObject::GetDisplayTypeName()
1986 {
1987     return GetTypeName();
1988 }
1989 
1990 ConstString
1991 ValueObject::GetQualifiedTypeName()
1992 {
1993     return GetClangType().GetConstQualifiedTypeName();
1994 }
1995 
1996 
1997 LanguageType
1998 ValueObject::GetObjectRuntimeLanguage ()
1999 {
2000     return GetClangType().GetMinimumLanguage ();
2001 }
2002 
2003 void
2004 ValueObject::AddSyntheticChild (const ConstString &key, ValueObject *valobj)
2005 {
2006     m_synthetic_children[key] = valobj;
2007 }
2008 
2009 ValueObjectSP
2010 ValueObject::GetSyntheticChild (const ConstString &key) const
2011 {
2012     ValueObjectSP synthetic_child_sp;
2013     std::map<ConstString, ValueObject *>::const_iterator pos = m_synthetic_children.find (key);
2014     if (pos != m_synthetic_children.end())
2015         synthetic_child_sp = pos->second->GetSP();
2016     return synthetic_child_sp;
2017 }
2018 
2019 uint32_t
2020 ValueObject::GetTypeInfo (ClangASTType *pointee_or_element_clang_type)
2021 {
2022     return GetClangType().GetTypeInfo (pointee_or_element_clang_type);
2023 }
2024 
2025 bool
2026 ValueObject::IsPointerType ()
2027 {
2028     return GetClangType().IsPointerType();
2029 }
2030 
2031 bool
2032 ValueObject::IsArrayType ()
2033 {
2034     return GetClangType().IsArrayType (NULL, NULL, NULL);
2035 }
2036 
2037 bool
2038 ValueObject::IsScalarType ()
2039 {
2040     return GetClangType().IsScalarType ();
2041 }
2042 
2043 bool
2044 ValueObject::IsIntegerType (bool &is_signed)
2045 {
2046     return GetClangType().IsIntegerType (is_signed);
2047 }
2048 
2049 bool
2050 ValueObject::IsPointerOrReferenceType ()
2051 {
2052     return GetClangType().IsPointerOrReferenceType ();
2053 }
2054 
2055 bool
2056 ValueObject::IsPossibleDynamicType ()
2057 {
2058     ExecutionContext exe_ctx (GetExecutionContextRef());
2059     Process *process = exe_ctx.GetProcessPtr();
2060     if (process)
2061         return process->IsPossibleDynamicValue(*this);
2062     else
2063         return GetClangType().IsPossibleDynamicType (NULL, true, true);
2064 }
2065 
2066 bool
2067 ValueObject::IsRuntimeSupportValue ()
2068 {
2069     Process *process(GetProcessSP().get());
2070     if (process)
2071     {
2072         LanguageRuntime *runtime = process->GetLanguageRuntime(GetObjectRuntimeLanguage());
2073         if (!runtime)
2074             runtime = process->GetObjCLanguageRuntime();
2075         if (runtime)
2076             return runtime->IsRuntimeSupportValue(*this);
2077     }
2078     return false;
2079 }
2080 
2081 bool
2082 ValueObject::IsObjCNil ()
2083 {
2084     const uint32_t mask = eTypeIsObjC | eTypeIsPointer;
2085     bool isObjCpointer = (((GetClangType().GetTypeInfo(NULL)) & mask) == mask);
2086     if (!isObjCpointer)
2087         return false;
2088     bool canReadValue = true;
2089     bool isZero = GetValueAsUnsigned(0,&canReadValue) == 0;
2090     return canReadValue && isZero;
2091 }
2092 
2093 // This allows you to create an array member using and index
2094 // that doesn't not fall in the normal bounds of the array.
2095 // Many times structure can be defined as:
2096 // struct Collection
2097 // {
2098 //     uint32_t item_count;
2099 //     Item item_array[0];
2100 // };
2101 // The size of the "item_array" is 1, but many times in practice
2102 // there are more items in "item_array".
2103 
2104 ValueObjectSP
2105 ValueObject::GetSyntheticArrayMember (size_t index, bool can_create)
2106 {
2107     ValueObjectSP synthetic_child_sp;
2108     if (IsPointerType () || IsArrayType())
2109     {
2110         char index_str[64];
2111         snprintf(index_str, sizeof(index_str), "[%" PRIu64 "]", (uint64_t)index);
2112         ConstString index_const_str(index_str);
2113         // Check if we have already created a synthetic array member in this
2114         // valid object. If we have we will re-use it.
2115         synthetic_child_sp = GetSyntheticChild (index_const_str);
2116         if (!synthetic_child_sp)
2117         {
2118             ValueObject *synthetic_child;
2119             // We haven't made a synthetic array member for INDEX yet, so
2120             // lets make one and cache it for any future reference.
2121             synthetic_child = CreateChildAtIndex(0, true, index);
2122 
2123             // Cache the value if we got one back...
2124             if (synthetic_child)
2125             {
2126                 AddSyntheticChild(index_const_str, synthetic_child);
2127                 synthetic_child_sp = synthetic_child->GetSP();
2128                 synthetic_child_sp->SetName(ConstString(index_str));
2129                 synthetic_child_sp->m_is_array_item_for_pointer = true;
2130             }
2131         }
2132     }
2133     return synthetic_child_sp;
2134 }
2135 
2136 ValueObjectSP
2137 ValueObject::GetSyntheticBitFieldChild (uint32_t from, uint32_t to, bool can_create)
2138 {
2139     ValueObjectSP synthetic_child_sp;
2140     if (IsScalarType ())
2141     {
2142         char index_str[64];
2143         snprintf(index_str, sizeof(index_str), "[%i-%i]", from, to);
2144         ConstString index_const_str(index_str);
2145         // Check if we have already created a synthetic array member in this
2146         // valid object. If we have we will re-use it.
2147         synthetic_child_sp = GetSyntheticChild (index_const_str);
2148         if (!synthetic_child_sp)
2149         {
2150             // We haven't made a synthetic array member for INDEX yet, so
2151             // lets make one and cache it for any future reference.
2152             ValueObjectChild *synthetic_child = new ValueObjectChild (*this,
2153                                                                       GetClangType(),
2154                                                                       index_const_str,
2155                                                                       GetByteSize(),
2156                                                                       0,
2157                                                                       to-from+1,
2158                                                                       from,
2159                                                                       false,
2160                                                                       false,
2161                                                                       eAddressTypeInvalid);
2162 
2163             // Cache the value if we got one back...
2164             if (synthetic_child)
2165             {
2166                 AddSyntheticChild(index_const_str, synthetic_child);
2167                 synthetic_child_sp = synthetic_child->GetSP();
2168                 synthetic_child_sp->SetName(ConstString(index_str));
2169                 synthetic_child_sp->m_is_bitfield_for_scalar = true;
2170             }
2171         }
2172     }
2173     return synthetic_child_sp;
2174 }
2175 
2176 ValueObjectSP
2177 ValueObject::GetSyntheticChildAtOffset(uint32_t offset, const ClangASTType& type, bool can_create)
2178 {
2179 
2180     ValueObjectSP synthetic_child_sp;
2181 
2182     char name_str[64];
2183     snprintf(name_str, sizeof(name_str), "@%i", offset);
2184     ConstString name_const_str(name_str);
2185 
2186     // Check if we have already created a synthetic array member in this
2187     // valid object. If we have we will re-use it.
2188     synthetic_child_sp = GetSyntheticChild (name_const_str);
2189 
2190     if (synthetic_child_sp.get())
2191         return synthetic_child_sp;
2192 
2193     if (!can_create)
2194         return ValueObjectSP();
2195 
2196     ExecutionContext exe_ctx (GetExecutionContextRef());
2197 
2198     ValueObjectChild *synthetic_child = new ValueObjectChild(*this,
2199                                                              type,
2200                                                              name_const_str,
2201                                                              type.GetByteSize(exe_ctx.GetBestExecutionContextScope()),
2202                                                              offset,
2203                                                              0,
2204                                                              0,
2205                                                              false,
2206                                                              false,
2207                                                              eAddressTypeInvalid);
2208     if (synthetic_child)
2209     {
2210         AddSyntheticChild(name_const_str, synthetic_child);
2211         synthetic_child_sp = synthetic_child->GetSP();
2212         synthetic_child_sp->SetName(name_const_str);
2213         synthetic_child_sp->m_is_child_at_offset = true;
2214     }
2215     return synthetic_child_sp;
2216 }
2217 
2218 ValueObjectSP
2219 ValueObject::GetSyntheticBase (uint32_t offset, const ClangASTType& type, bool can_create)
2220 {
2221     ValueObjectSP synthetic_child_sp;
2222 
2223     char name_str[64];
2224     snprintf(name_str, sizeof(name_str), "%s", type.GetTypeName().AsCString("<unknown>"));
2225     ConstString name_const_str(name_str);
2226 
2227     // Check if we have already created a synthetic array member in this
2228     // valid object. If we have we will re-use it.
2229     synthetic_child_sp = GetSyntheticChild (name_const_str);
2230 
2231     if (synthetic_child_sp.get())
2232         return synthetic_child_sp;
2233 
2234     if (!can_create)
2235         return ValueObjectSP();
2236 
2237     const bool is_base_class = true;
2238 
2239     ExecutionContext exe_ctx (GetExecutionContextRef());
2240 
2241     ValueObjectChild *synthetic_child = new ValueObjectChild(*this,
2242                                                              type,
2243                                                              name_const_str,
2244                                                              type.GetByteSize(exe_ctx.GetBestExecutionContextScope()),
2245                                                              offset,
2246                                                              0,
2247                                                              0,
2248                                                              is_base_class,
2249                                                              false,
2250                                                              eAddressTypeInvalid);
2251     if (synthetic_child)
2252     {
2253         AddSyntheticChild(name_const_str, synthetic_child);
2254         synthetic_child_sp = synthetic_child->GetSP();
2255         synthetic_child_sp->SetName(name_const_str);
2256     }
2257     return synthetic_child_sp;
2258 }
2259 
2260 
2261 // your expression path needs to have a leading . or ->
2262 // (unless it somehow "looks like" an array, in which case it has
2263 // a leading [ symbol). while the [ is meaningful and should be shown
2264 // to the user, . and -> are just parser design, but by no means
2265 // added information for the user.. strip them off
2266 static const char*
2267 SkipLeadingExpressionPathSeparators(const char* expression)
2268 {
2269     if (!expression || !expression[0])
2270         return expression;
2271     if (expression[0] == '.')
2272         return expression+1;
2273     if (expression[0] == '-' && expression[1] == '>')
2274         return expression+2;
2275     return expression;
2276 }
2277 
2278 ValueObjectSP
2279 ValueObject::GetSyntheticExpressionPathChild(const char* expression, bool can_create)
2280 {
2281     ValueObjectSP synthetic_child_sp;
2282     ConstString name_const_string(expression);
2283     // Check if we have already created a synthetic array member in this
2284     // valid object. If we have we will re-use it.
2285     synthetic_child_sp = GetSyntheticChild (name_const_string);
2286     if (!synthetic_child_sp)
2287     {
2288         // We haven't made a synthetic array member for expression yet, so
2289         // lets make one and cache it for any future reference.
2290         synthetic_child_sp = GetValueForExpressionPath(expression,
2291                                                        NULL, NULL, NULL,
2292                                                        GetValueForExpressionPathOptions().DontAllowSyntheticChildren());
2293 
2294         // Cache the value if we got one back...
2295         if (synthetic_child_sp.get())
2296         {
2297             // FIXME: this causes a "real" child to end up with its name changed to the contents of expression
2298             AddSyntheticChild(name_const_string, synthetic_child_sp.get());
2299             synthetic_child_sp->SetName(ConstString(SkipLeadingExpressionPathSeparators(expression)));
2300         }
2301     }
2302     return synthetic_child_sp;
2303 }
2304 
2305 void
2306 ValueObject::CalculateSyntheticValue (bool use_synthetic)
2307 {
2308     if (use_synthetic == false)
2309         return;
2310 
2311     TargetSP target_sp(GetTargetSP());
2312     if (target_sp && target_sp->GetEnableSyntheticValue() == false)
2313     {
2314         m_synthetic_value = NULL;
2315         return;
2316     }
2317 
2318     lldb::SyntheticChildrenSP current_synth_sp(m_synthetic_children_sp);
2319 
2320     if (!UpdateFormatsIfNeeded() && m_synthetic_value)
2321         return;
2322 
2323     if (m_synthetic_children_sp.get() == NULL)
2324         return;
2325 
2326     if (current_synth_sp == m_synthetic_children_sp && m_synthetic_value)
2327         return;
2328 
2329     m_synthetic_value = new ValueObjectSynthetic(*this, m_synthetic_children_sp);
2330 }
2331 
2332 void
2333 ValueObject::CalculateDynamicValue (DynamicValueType use_dynamic)
2334 {
2335     if (use_dynamic == eNoDynamicValues)
2336         return;
2337 
2338     if (!m_dynamic_value && !IsDynamic())
2339     {
2340         ExecutionContext exe_ctx (GetExecutionContextRef());
2341         Process *process = exe_ctx.GetProcessPtr();
2342         if (process && process->IsPossibleDynamicValue(*this))
2343         {
2344             ClearDynamicTypeInformation ();
2345             m_dynamic_value = new ValueObjectDynamicValue (*this, use_dynamic);
2346         }
2347     }
2348 }
2349 
2350 ValueObjectSP
2351 ValueObject::GetDynamicValue (DynamicValueType use_dynamic)
2352 {
2353     if (use_dynamic == eNoDynamicValues)
2354         return ValueObjectSP();
2355 
2356     if (!IsDynamic() && m_dynamic_value == NULL)
2357     {
2358         CalculateDynamicValue(use_dynamic);
2359     }
2360     if (m_dynamic_value)
2361         return m_dynamic_value->GetSP();
2362     else
2363         return ValueObjectSP();
2364 }
2365 
2366 ValueObjectSP
2367 ValueObject::GetStaticValue()
2368 {
2369     return GetSP();
2370 }
2371 
2372 lldb::ValueObjectSP
2373 ValueObject::GetNonSyntheticValue ()
2374 {
2375     return GetSP();
2376 }
2377 
2378 ValueObjectSP
2379 ValueObject::GetSyntheticValue (bool use_synthetic)
2380 {
2381     if (use_synthetic == false)
2382         return ValueObjectSP();
2383 
2384     CalculateSyntheticValue(use_synthetic);
2385 
2386     if (m_synthetic_value)
2387         return m_synthetic_value->GetSP();
2388     else
2389         return ValueObjectSP();
2390 }
2391 
2392 bool
2393 ValueObject::HasSyntheticValue()
2394 {
2395     UpdateFormatsIfNeeded();
2396 
2397     if (m_synthetic_children_sp.get() == NULL)
2398         return false;
2399 
2400     CalculateSyntheticValue(true);
2401 
2402     if (m_synthetic_value)
2403         return true;
2404     else
2405         return false;
2406 }
2407 
2408 bool
2409 ValueObject::GetBaseClassPath (Stream &s)
2410 {
2411     if (IsBaseClass())
2412     {
2413         bool parent_had_base_class = GetParent() && GetParent()->GetBaseClassPath (s);
2414         ClangASTType clang_type = GetClangType();
2415         std::string cxx_class_name;
2416         bool this_had_base_class = clang_type.GetCXXClassName (cxx_class_name);
2417         if (this_had_base_class)
2418         {
2419             if (parent_had_base_class)
2420                 s.PutCString("::");
2421             s.PutCString(cxx_class_name.c_str());
2422         }
2423         return parent_had_base_class || this_had_base_class;
2424     }
2425     return false;
2426 }
2427 
2428 
2429 ValueObject *
2430 ValueObject::GetNonBaseClassParent()
2431 {
2432     if (GetParent())
2433     {
2434         if (GetParent()->IsBaseClass())
2435             return GetParent()->GetNonBaseClassParent();
2436         else
2437             return GetParent();
2438     }
2439     return NULL;
2440 }
2441 
2442 
2443 bool
2444 ValueObject::IsBaseClass (uint32_t& depth)
2445 {
2446     if (!IsBaseClass())
2447     {
2448         depth = 0;
2449         return false;
2450     }
2451     if (GetParent())
2452     {
2453         GetParent()->IsBaseClass(depth);
2454         depth = depth + 1;
2455         return true;
2456     }
2457     // TODO: a base of no parent? weird..
2458     depth = 1;
2459     return true;
2460 }
2461 
2462 void
2463 ValueObject::GetExpressionPath (Stream &s, bool qualify_cxx_base_classes, GetExpressionPathFormat epformat)
2464 {
2465     // synthetic children do not actually "exist" as part of the hierarchy, and sometimes they are consed up in ways
2466     // that don't make sense from an underlying language/API standpoint. So, use a special code path here to return
2467     // something that can hopefully be used in expression
2468     if (m_is_synthetic_children_generated)
2469     {
2470         UpdateValueIfNeeded();
2471 
2472         if (m_value.GetValueType() == Value::eValueTypeLoadAddress)
2473         {
2474             if (IsPointerOrReferenceType())
2475             {
2476                 s.Printf("((%s)0x%" PRIx64 ")",
2477                          GetTypeName().AsCString("void"),
2478                          GetValueAsUnsigned(0));
2479                 return;
2480             }
2481             else
2482             {
2483                 uint64_t load_addr = m_value.GetScalar().ULongLong(LLDB_INVALID_ADDRESS);
2484                 if (load_addr != LLDB_INVALID_ADDRESS)
2485                 {
2486                     s.Printf("(*( (%s *)0x%" PRIx64 "))",
2487                              GetTypeName().AsCString("void"),
2488                              load_addr);
2489                     return;
2490                 }
2491             }
2492         }
2493 
2494         if (CanProvideValue())
2495         {
2496             s.Printf("((%s)%s)",
2497                      GetTypeName().AsCString("void"),
2498                      GetValueAsCString());
2499             return;
2500         }
2501 
2502         return;
2503     }
2504 
2505     const bool is_deref_of_parent = IsDereferenceOfParent ();
2506 
2507     if (is_deref_of_parent && epformat == eGetExpressionPathFormatDereferencePointers)
2508     {
2509         // this is the original format of GetExpressionPath() producing code like *(a_ptr).memberName, which is entirely
2510         // fine, until you put this into StackFrame::GetValueForVariableExpressionPath() which prefers to see a_ptr->memberName.
2511         // the eHonorPointers mode is meant to produce strings in this latter format
2512         s.PutCString("*(");
2513     }
2514 
2515     ValueObject* parent = GetParent();
2516 
2517     if (parent)
2518         parent->GetExpressionPath (s, qualify_cxx_base_classes, epformat);
2519 
2520     // if we are a deref_of_parent just because we are synthetic array
2521     // members made up to allow ptr[%d] syntax to work in variable
2522     // printing, then add our name ([%d]) to the expression path
2523     if (m_is_array_item_for_pointer && epformat == eGetExpressionPathFormatHonorPointers)
2524         s.PutCString(m_name.AsCString());
2525 
2526     if (!IsBaseClass())
2527     {
2528         if (!is_deref_of_parent)
2529         {
2530             ValueObject *non_base_class_parent = GetNonBaseClassParent();
2531             if (non_base_class_parent)
2532             {
2533                 ClangASTType non_base_class_parent_clang_type = non_base_class_parent->GetClangType();
2534                 if (non_base_class_parent_clang_type)
2535                 {
2536                     if (parent && parent->IsDereferenceOfParent() && epformat == eGetExpressionPathFormatHonorPointers)
2537                     {
2538                         s.PutCString("->");
2539                     }
2540                     else
2541                     {
2542                         const uint32_t non_base_class_parent_type_info = non_base_class_parent_clang_type.GetTypeInfo();
2543 
2544                         if (non_base_class_parent_type_info & eTypeIsPointer)
2545                         {
2546                             s.PutCString("->");
2547                         }
2548                         else if ((non_base_class_parent_type_info & eTypeHasChildren) &&
2549                                  !(non_base_class_parent_type_info & eTypeIsArray))
2550                         {
2551                             s.PutChar('.');
2552                         }
2553                     }
2554                 }
2555             }
2556 
2557             const char *name = GetName().GetCString();
2558             if (name)
2559             {
2560                 if (qualify_cxx_base_classes)
2561                 {
2562                     if (GetBaseClassPath (s))
2563                         s.PutCString("::");
2564                 }
2565                 s.PutCString(name);
2566             }
2567         }
2568     }
2569 
2570     if (is_deref_of_parent && epformat == eGetExpressionPathFormatDereferencePointers)
2571     {
2572         s.PutChar(')');
2573     }
2574 }
2575 
2576 ValueObjectSP
2577 ValueObject::GetValueForExpressionPath(const char* expression,
2578                                        const char** first_unparsed,
2579                                        ExpressionPathScanEndReason* reason_to_stop,
2580                                        ExpressionPathEndResultType* final_value_type,
2581                                        const GetValueForExpressionPathOptions& options,
2582                                        ExpressionPathAftermath* final_task_on_target)
2583 {
2584 
2585     const char* dummy_first_unparsed;
2586     ExpressionPathScanEndReason dummy_reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnknown;
2587     ExpressionPathEndResultType dummy_final_value_type = ValueObject::eExpressionPathEndResultTypeInvalid;
2588     ExpressionPathAftermath dummy_final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2589 
2590     ValueObjectSP ret_val = GetValueForExpressionPath_Impl(expression,
2591                                                            first_unparsed ? first_unparsed : &dummy_first_unparsed,
2592                                                            reason_to_stop ? reason_to_stop : &dummy_reason_to_stop,
2593                                                            final_value_type ? final_value_type : &dummy_final_value_type,
2594                                                            options,
2595                                                            final_task_on_target ? final_task_on_target : &dummy_final_task_on_target);
2596 
2597     if (!final_task_on_target || *final_task_on_target == ValueObject::eExpressionPathAftermathNothing)
2598         return ret_val;
2599 
2600     if (ret_val.get() && ((final_value_type ? *final_value_type : dummy_final_value_type) == eExpressionPathEndResultTypePlain)) // I can only deref and takeaddress of plain objects
2601     {
2602         if ( (final_task_on_target ? *final_task_on_target : dummy_final_task_on_target) == ValueObject::eExpressionPathAftermathDereference)
2603         {
2604             Error error;
2605             ValueObjectSP final_value = ret_val->Dereference(error);
2606             if (error.Fail() || !final_value.get())
2607             {
2608                 if (reason_to_stop)
2609                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
2610                 if (final_value_type)
2611                     *final_value_type = ValueObject::eExpressionPathEndResultTypeInvalid;
2612                 return ValueObjectSP();
2613             }
2614             else
2615             {
2616                 if (final_task_on_target)
2617                     *final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2618                 return final_value;
2619             }
2620         }
2621         if (*final_task_on_target == ValueObject::eExpressionPathAftermathTakeAddress)
2622         {
2623             Error error;
2624             ValueObjectSP final_value = ret_val->AddressOf(error);
2625             if (error.Fail() || !final_value.get())
2626             {
2627                 if (reason_to_stop)
2628                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonTakingAddressFailed;
2629                 if (final_value_type)
2630                     *final_value_type = ValueObject::eExpressionPathEndResultTypeInvalid;
2631                 return ValueObjectSP();
2632             }
2633             else
2634             {
2635                 if (final_task_on_target)
2636                     *final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2637                 return final_value;
2638             }
2639         }
2640     }
2641     return ret_val; // final_task_on_target will still have its original value, so you know I did not do it
2642 }
2643 
2644 int
2645 ValueObject::GetValuesForExpressionPath(const char* expression,
2646                                         ValueObjectListSP& list,
2647                                         const char** first_unparsed,
2648                                         ExpressionPathScanEndReason* reason_to_stop,
2649                                         ExpressionPathEndResultType* final_value_type,
2650                                         const GetValueForExpressionPathOptions& options,
2651                                         ExpressionPathAftermath* final_task_on_target)
2652 {
2653     const char* dummy_first_unparsed;
2654     ExpressionPathScanEndReason dummy_reason_to_stop;
2655     ExpressionPathEndResultType dummy_final_value_type;
2656     ExpressionPathAftermath dummy_final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2657 
2658     ValueObjectSP ret_val = GetValueForExpressionPath_Impl(expression,
2659                                                            first_unparsed ? first_unparsed : &dummy_first_unparsed,
2660                                                            reason_to_stop ? reason_to_stop : &dummy_reason_to_stop,
2661                                                            final_value_type ? final_value_type : &dummy_final_value_type,
2662                                                            options,
2663                                                            final_task_on_target ? final_task_on_target : &dummy_final_task_on_target);
2664 
2665     if (!ret_val.get()) // if there are errors, I add nothing to the list
2666         return 0;
2667 
2668     if ( (reason_to_stop ? *reason_to_stop : dummy_reason_to_stop) != eExpressionPathScanEndReasonArrayRangeOperatorMet)
2669     {
2670         // I need not expand a range, just post-process the final value and return
2671         if (!final_task_on_target || *final_task_on_target == ValueObject::eExpressionPathAftermathNothing)
2672         {
2673             list->Append(ret_val);
2674             return 1;
2675         }
2676         if (ret_val.get() && (final_value_type ? *final_value_type : dummy_final_value_type) == eExpressionPathEndResultTypePlain) // I can only deref and takeaddress of plain objects
2677         {
2678             if (*final_task_on_target == ValueObject::eExpressionPathAftermathDereference)
2679             {
2680                 Error error;
2681                 ValueObjectSP final_value = ret_val->Dereference(error);
2682                 if (error.Fail() || !final_value.get())
2683                 {
2684                     if (reason_to_stop)
2685                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
2686                     if (final_value_type)
2687                         *final_value_type = ValueObject::eExpressionPathEndResultTypeInvalid;
2688                     return 0;
2689                 }
2690                 else
2691                 {
2692                     *final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2693                     list->Append(final_value);
2694                     return 1;
2695                 }
2696             }
2697             if (*final_task_on_target == ValueObject::eExpressionPathAftermathTakeAddress)
2698             {
2699                 Error error;
2700                 ValueObjectSP final_value = ret_val->AddressOf(error);
2701                 if (error.Fail() || !final_value.get())
2702                 {
2703                     if (reason_to_stop)
2704                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonTakingAddressFailed;
2705                     if (final_value_type)
2706                         *final_value_type = ValueObject::eExpressionPathEndResultTypeInvalid;
2707                     return 0;
2708                 }
2709                 else
2710                 {
2711                     *final_task_on_target = ValueObject::eExpressionPathAftermathNothing;
2712                     list->Append(final_value);
2713                     return 1;
2714                 }
2715             }
2716         }
2717     }
2718     else
2719     {
2720         return ExpandArraySliceExpression(first_unparsed ? *first_unparsed : dummy_first_unparsed,
2721                                           first_unparsed ? first_unparsed : &dummy_first_unparsed,
2722                                           ret_val,
2723                                           list,
2724                                           reason_to_stop ? reason_to_stop : &dummy_reason_to_stop,
2725                                           final_value_type ? final_value_type : &dummy_final_value_type,
2726                                           options,
2727                                           final_task_on_target ? final_task_on_target : &dummy_final_task_on_target);
2728     }
2729     // in any non-covered case, just do the obviously right thing
2730     list->Append(ret_val);
2731     return 1;
2732 }
2733 
2734 ValueObjectSP
2735 ValueObject::GetValueForExpressionPath_Impl(const char* expression_cstr,
2736                                             const char** first_unparsed,
2737                                             ExpressionPathScanEndReason* reason_to_stop,
2738                                             ExpressionPathEndResultType* final_result,
2739                                             const GetValueForExpressionPathOptions& options,
2740                                             ExpressionPathAftermath* what_next)
2741 {
2742     ValueObjectSP root = GetSP();
2743 
2744     if (!root.get())
2745         return ValueObjectSP();
2746 
2747     *first_unparsed = expression_cstr;
2748 
2749     while (true)
2750     {
2751 
2752         const char* expression_cstr = *first_unparsed; // hide the top level expression_cstr
2753 
2754         ClangASTType root_clang_type = root->GetClangType();
2755         ClangASTType pointee_clang_type;
2756         Flags pointee_clang_type_info;
2757 
2758         Flags root_clang_type_info(root_clang_type.GetTypeInfo(&pointee_clang_type));
2759         if (pointee_clang_type)
2760             pointee_clang_type_info.Reset(pointee_clang_type.GetTypeInfo());
2761 
2762         if (!expression_cstr || *expression_cstr == '\0')
2763         {
2764             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEndOfString;
2765             return root;
2766         }
2767 
2768         switch (*expression_cstr)
2769         {
2770             case '-':
2771             {
2772                 if (options.m_check_dot_vs_arrow_syntax &&
2773                     root_clang_type_info.Test(eTypeIsPointer) ) // if you are trying to use -> on a non-pointer and I must catch the error
2774                 {
2775                     *first_unparsed = expression_cstr;
2776                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonArrowInsteadOfDot;
2777                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2778                     return ValueObjectSP();
2779                 }
2780                 if (root_clang_type_info.Test(eTypeIsObjC) &&  // if yo are trying to extract an ObjC IVar when this is forbidden
2781                     root_clang_type_info.Test(eTypeIsPointer) &&
2782                     options.m_no_fragile_ivar)
2783                 {
2784                     *first_unparsed = expression_cstr;
2785                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonFragileIVarNotAllowed;
2786                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2787                     return ValueObjectSP();
2788                 }
2789                 if (expression_cstr[1] != '>')
2790                 {
2791                     *first_unparsed = expression_cstr;
2792                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
2793                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2794                     return ValueObjectSP();
2795                 }
2796                 expression_cstr++; // skip the -
2797             }
2798             case '.': // or fallthrough from ->
2799             {
2800                 if (options.m_check_dot_vs_arrow_syntax && *expression_cstr == '.' &&
2801                     root_clang_type_info.Test(eTypeIsPointer)) // if you are trying to use . on a pointer and I must catch the error
2802                 {
2803                     *first_unparsed = expression_cstr;
2804                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDotInsteadOfArrow;
2805                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2806                     return ValueObjectSP();
2807                 }
2808                 expression_cstr++; // skip .
2809                 const char *next_separator = strpbrk(expression_cstr+1,"-.[");
2810                 ConstString child_name;
2811                 if (!next_separator) // if no other separator just expand this last layer
2812                 {
2813                     child_name.SetCString (expression_cstr);
2814                     ValueObjectSP child_valobj_sp = root->GetChildMemberWithName(child_name, true);
2815 
2816                     if (child_valobj_sp.get()) // we know we are done, so just return
2817                     {
2818                         *first_unparsed = "";
2819                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEndOfString;
2820                         *final_result = ValueObject::eExpressionPathEndResultTypePlain;
2821                         return child_valobj_sp;
2822                     }
2823                     else if (options.m_no_synthetic_children == false) // let's try with synthetic children
2824                     {
2825                         if (root->IsSynthetic())
2826                         {
2827                             *first_unparsed = expression_cstr;
2828                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchSyntheticChild;
2829                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2830                             return ValueObjectSP();
2831                         }
2832 
2833                         child_valobj_sp = root->GetSyntheticValue();
2834                         if (child_valobj_sp.get())
2835                             child_valobj_sp = child_valobj_sp->GetChildMemberWithName(child_name, true);
2836                     }
2837 
2838                     // if we are here and options.m_no_synthetic_children is true, child_valobj_sp is going to be a NULL SP,
2839                     // so we hit the "else" branch, and return an error
2840                     if(child_valobj_sp.get()) // if it worked, just return
2841                     {
2842                         *first_unparsed = "";
2843                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEndOfString;
2844                         *final_result = ValueObject::eExpressionPathEndResultTypePlain;
2845                         return child_valobj_sp;
2846                     }
2847                     else
2848                     {
2849                         *first_unparsed = expression_cstr;
2850                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
2851                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2852                         return ValueObjectSP();
2853                     }
2854                 }
2855                 else // other layers do expand
2856                 {
2857                     child_name.SetCStringWithLength(expression_cstr, next_separator - expression_cstr);
2858                     ValueObjectSP child_valobj_sp = root->GetChildMemberWithName(child_name, true);
2859                     if (child_valobj_sp.get()) // store the new root and move on
2860                     {
2861                         root = child_valobj_sp;
2862                         *first_unparsed = next_separator;
2863                         *final_result = ValueObject::eExpressionPathEndResultTypePlain;
2864                         continue;
2865                     }
2866                     else if (options.m_no_synthetic_children == false) // let's try with synthetic children
2867                     {
2868                         if (root->IsSynthetic())
2869                         {
2870                             *first_unparsed = expression_cstr;
2871                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
2872                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2873                             return ValueObjectSP();
2874                         }
2875 
2876                         child_valobj_sp = root->GetSyntheticValue(true);
2877                         if (child_valobj_sp)
2878                             child_valobj_sp = child_valobj_sp->GetChildMemberWithName(child_name, true);
2879                     }
2880 
2881                     // if we are here and options.m_no_synthetic_children is true, child_valobj_sp is going to be a NULL SP,
2882                     // so we hit the "else" branch, and return an error
2883                     if(child_valobj_sp.get()) // if it worked, move on
2884                     {
2885                         root = child_valobj_sp;
2886                         *first_unparsed = next_separator;
2887                         *final_result = ValueObject::eExpressionPathEndResultTypePlain;
2888                         continue;
2889                     }
2890                     else
2891                     {
2892                         *first_unparsed = expression_cstr;
2893                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
2894                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2895                         return ValueObjectSP();
2896                     }
2897                 }
2898                 break;
2899             }
2900             case '[':
2901             {
2902                 if (!root_clang_type_info.Test(eTypeIsArray) && !root_clang_type_info.Test(eTypeIsPointer) && !root_clang_type_info.Test(eTypeIsVector)) // if this is not a T[] nor a T*
2903                 {
2904                     if (!root_clang_type_info.Test(eTypeIsScalar)) // if this is not even a scalar...
2905                     {
2906                         if (options.m_no_synthetic_children) // ...only chance left is synthetic
2907                         {
2908                             *first_unparsed = expression_cstr;
2909                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorInvalid;
2910                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2911                             return ValueObjectSP();
2912                         }
2913                     }
2914                     else if (!options.m_allow_bitfields_syntax) // if this is a scalar, check that we can expand bitfields
2915                     {
2916                         *first_unparsed = expression_cstr;
2917                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorNotAllowed;
2918                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2919                         return ValueObjectSP();
2920                     }
2921                 }
2922                 if (*(expression_cstr+1) == ']') // if this is an unbounded range it only works for arrays
2923                 {
2924                     if (!root_clang_type_info.Test(eTypeIsArray))
2925                     {
2926                         *first_unparsed = expression_cstr;
2927                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEmptyRangeNotAllowed;
2928                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2929                         return ValueObjectSP();
2930                     }
2931                     else // even if something follows, we cannot expand unbounded ranges, just let the caller do it
2932                     {
2933                         *first_unparsed = expression_cstr+2;
2934                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonArrayRangeOperatorMet;
2935                         *final_result = ValueObject::eExpressionPathEndResultTypeUnboundedRange;
2936                         return root;
2937                     }
2938                 }
2939                 const char *separator_position = ::strchr(expression_cstr+1,'-');
2940                 const char *close_bracket_position = ::strchr(expression_cstr+1,']');
2941                 if (!close_bracket_position) // if there is no ], this is a syntax error
2942                 {
2943                     *first_unparsed = expression_cstr;
2944                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
2945                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2946                     return ValueObjectSP();
2947                 }
2948                 if (!separator_position || separator_position > close_bracket_position) // if no separator, this is either [] or [N]
2949                 {
2950                     char *end = NULL;
2951                     unsigned long index = ::strtoul (expression_cstr+1, &end, 0);
2952                     if (!end || end != close_bracket_position) // if something weird is in our way return an error
2953                     {
2954                         *first_unparsed = expression_cstr;
2955                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
2956                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2957                         return ValueObjectSP();
2958                     }
2959                     if (end - expression_cstr == 1) // if this is [], only return a valid value for arrays
2960                     {
2961                         if (root_clang_type_info.Test(eTypeIsArray))
2962                         {
2963                             *first_unparsed = expression_cstr+2;
2964                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonArrayRangeOperatorMet;
2965                             *final_result = ValueObject::eExpressionPathEndResultTypeUnboundedRange;
2966                             return root;
2967                         }
2968                         else
2969                         {
2970                             *first_unparsed = expression_cstr;
2971                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEmptyRangeNotAllowed;
2972                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2973                             return ValueObjectSP();
2974                         }
2975                     }
2976                     // from here on we do have a valid index
2977                     if (root_clang_type_info.Test(eTypeIsArray))
2978                     {
2979                         ValueObjectSP child_valobj_sp = root->GetChildAtIndex(index, true);
2980                         if (!child_valobj_sp)
2981                             child_valobj_sp = root->GetSyntheticArrayMember(index, true);
2982                         if (!child_valobj_sp)
2983                             if (root->HasSyntheticValue() && root->GetSyntheticValue()->GetNumChildren() > index)
2984                                 child_valobj_sp = root->GetSyntheticValue()->GetChildAtIndex(index, true);
2985                         if (child_valobj_sp)
2986                         {
2987                             root = child_valobj_sp;
2988                             *first_unparsed = end+1; // skip ]
2989                             *final_result = ValueObject::eExpressionPathEndResultTypePlain;
2990                             continue;
2991                         }
2992                         else
2993                         {
2994                             *first_unparsed = expression_cstr;
2995                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
2996                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
2997                             return ValueObjectSP();
2998                         }
2999                     }
3000                     else if (root_clang_type_info.Test(eTypeIsPointer))
3001                     {
3002                         if (*what_next == ValueObject::eExpressionPathAftermathDereference &&  // if this is a ptr-to-scalar, I am accessing it by index and I would have deref'ed anyway, then do it now and use this as a bitfield
3003                             pointee_clang_type_info.Test(eTypeIsScalar))
3004                         {
3005                             Error error;
3006                             root = root->Dereference(error);
3007                             if (error.Fail() || !root.get())
3008                             {
3009                                 *first_unparsed = expression_cstr;
3010                                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
3011                                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3012                                 return ValueObjectSP();
3013                             }
3014                             else
3015                             {
3016                                 *what_next = eExpressionPathAftermathNothing;
3017                                 continue;
3018                             }
3019                         }
3020                         else
3021                         {
3022                             if (root->GetClangType().GetMinimumLanguage() == eLanguageTypeObjC
3023                                 && pointee_clang_type_info.AllClear(eTypeIsPointer)
3024                                 && root->HasSyntheticValue()
3025                                 && options.m_no_synthetic_children == false)
3026                             {
3027                                 root = root->GetSyntheticValue()->GetChildAtIndex(index, true);
3028                             }
3029                             else
3030                                 root = root->GetSyntheticArrayMember(index, true);
3031                             if (!root.get())
3032                             {
3033                                 *first_unparsed = expression_cstr;
3034                                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3035                                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3036                                 return ValueObjectSP();
3037                             }
3038                             else
3039                             {
3040                                 *first_unparsed = end+1; // skip ]
3041                                 *final_result = ValueObject::eExpressionPathEndResultTypePlain;
3042                                 continue;
3043                             }
3044                         }
3045                     }
3046                     else if (root_clang_type_info.Test(eTypeIsScalar))
3047                     {
3048                         root = root->GetSyntheticBitFieldChild(index, index, true);
3049                         if (!root.get())
3050                         {
3051                             *first_unparsed = expression_cstr;
3052                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3053                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3054                             return ValueObjectSP();
3055                         }
3056                         else // we do not know how to expand members of bitfields, so we just return and let the caller do any further processing
3057                         {
3058                             *first_unparsed = end+1; // skip ]
3059                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonBitfieldRangeOperatorMet;
3060                             *final_result = ValueObject::eExpressionPathEndResultTypeBitfield;
3061                             return root;
3062                         }
3063                     }
3064                     else if (root_clang_type_info.Test(eTypeIsVector))
3065                     {
3066                         root = root->GetChildAtIndex(index, true);
3067                         if (!root.get())
3068                         {
3069                             *first_unparsed = expression_cstr;
3070                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3071                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3072                             return ValueObjectSP();
3073                         }
3074                         else
3075                         {
3076                             *first_unparsed = end+1; // skip ]
3077                             *final_result = ValueObject::eExpressionPathEndResultTypePlain;
3078                             continue;
3079                         }
3080                     }
3081                     else if (options.m_no_synthetic_children == false)
3082                     {
3083                         if (root->HasSyntheticValue())
3084                             root = root->GetSyntheticValue();
3085                         else if (!root->IsSynthetic())
3086                         {
3087                             *first_unparsed = expression_cstr;
3088                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonSyntheticValueMissing;
3089                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3090                             return ValueObjectSP();
3091                         }
3092                         // if we are here, then root itself is a synthetic VO.. should be good to go
3093 
3094                         if (!root.get())
3095                         {
3096                             *first_unparsed = expression_cstr;
3097                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonSyntheticValueMissing;
3098                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3099                             return ValueObjectSP();
3100                         }
3101                         root = root->GetChildAtIndex(index, true);
3102                         if (!root.get())
3103                         {
3104                             *first_unparsed = expression_cstr;
3105                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3106                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3107                             return ValueObjectSP();
3108                         }
3109                         else
3110                         {
3111                             *first_unparsed = end+1; // skip ]
3112                             *final_result = ValueObject::eExpressionPathEndResultTypePlain;
3113                             continue;
3114                         }
3115                     }
3116                     else
3117                     {
3118                         *first_unparsed = expression_cstr;
3119                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3120                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3121                         return ValueObjectSP();
3122                     }
3123                 }
3124                 else // we have a low and a high index
3125                 {
3126                     char *end = NULL;
3127                     unsigned long index_lower = ::strtoul (expression_cstr+1, &end, 0);
3128                     if (!end || end != separator_position) // if something weird is in our way return an error
3129                     {
3130                         *first_unparsed = expression_cstr;
3131                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3132                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3133                         return ValueObjectSP();
3134                     }
3135                     unsigned long index_higher = ::strtoul (separator_position+1, &end, 0);
3136                     if (!end || end != close_bracket_position) // if something weird is in our way return an error
3137                     {
3138                         *first_unparsed = expression_cstr;
3139                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3140                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3141                         return ValueObjectSP();
3142                     }
3143                     if (index_lower > index_higher) // swap indices if required
3144                     {
3145                         unsigned long temp = index_lower;
3146                         index_lower = index_higher;
3147                         index_higher = temp;
3148                     }
3149                     if (root_clang_type_info.Test(eTypeIsScalar)) // expansion only works for scalars
3150                     {
3151                         root = root->GetSyntheticBitFieldChild(index_lower, index_higher, true);
3152                         if (!root.get())
3153                         {
3154                             *first_unparsed = expression_cstr;
3155                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3156                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3157                             return ValueObjectSP();
3158                         }
3159                         else
3160                         {
3161                             *first_unparsed = end+1; // skip ]
3162                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonBitfieldRangeOperatorMet;
3163                             *final_result = ValueObject::eExpressionPathEndResultTypeBitfield;
3164                             return root;
3165                         }
3166                     }
3167                     else if (root_clang_type_info.Test(eTypeIsPointer) && // if this is a ptr-to-scalar, I am accessing it by index and I would have deref'ed anyway, then do it now and use this as a bitfield
3168                              *what_next == ValueObject::eExpressionPathAftermathDereference &&
3169                              pointee_clang_type_info.Test(eTypeIsScalar))
3170                     {
3171                         Error error;
3172                         root = root->Dereference(error);
3173                         if (error.Fail() || !root.get())
3174                         {
3175                             *first_unparsed = expression_cstr;
3176                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
3177                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3178                             return ValueObjectSP();
3179                         }
3180                         else
3181                         {
3182                             *what_next = ValueObject::eExpressionPathAftermathNothing;
3183                             continue;
3184                         }
3185                     }
3186                     else
3187                     {
3188                         *first_unparsed = expression_cstr;
3189                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonArrayRangeOperatorMet;
3190                         *final_result = ValueObject::eExpressionPathEndResultTypeBoundedRange;
3191                         return root;
3192                     }
3193                 }
3194                 break;
3195             }
3196             default: // some non-separator is in the way
3197             {
3198                 *first_unparsed = expression_cstr;
3199                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3200                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3201                 return ValueObjectSP();
3202                 break;
3203             }
3204         }
3205     }
3206 }
3207 
3208 int
3209 ValueObject::ExpandArraySliceExpression(const char* expression_cstr,
3210                                         const char** first_unparsed,
3211                                         ValueObjectSP root,
3212                                         ValueObjectListSP& list,
3213                                         ExpressionPathScanEndReason* reason_to_stop,
3214                                         ExpressionPathEndResultType* final_result,
3215                                         const GetValueForExpressionPathOptions& options,
3216                                         ExpressionPathAftermath* what_next)
3217 {
3218     if (!root.get())
3219         return 0;
3220 
3221     *first_unparsed = expression_cstr;
3222 
3223     while (true)
3224     {
3225 
3226         const char* expression_cstr = *first_unparsed; // hide the top level expression_cstr
3227 
3228         ClangASTType root_clang_type = root->GetClangType();
3229         ClangASTType pointee_clang_type;
3230         Flags pointee_clang_type_info;
3231         Flags root_clang_type_info(root_clang_type.GetTypeInfo(&pointee_clang_type));
3232         if (pointee_clang_type)
3233             pointee_clang_type_info.Reset(pointee_clang_type.GetTypeInfo());
3234 
3235         if (!expression_cstr || *expression_cstr == '\0')
3236         {
3237             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEndOfString;
3238             list->Append(root);
3239             return 1;
3240         }
3241 
3242         switch (*expression_cstr)
3243         {
3244             case '[':
3245             {
3246                 if (!root_clang_type_info.Test(eTypeIsArray) && !root_clang_type_info.Test(eTypeIsPointer)) // if this is not a T[] nor a T*
3247                 {
3248                     if (!root_clang_type_info.Test(eTypeIsScalar)) // if this is not even a scalar, this syntax is just plain wrong!
3249                     {
3250                         *first_unparsed = expression_cstr;
3251                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorInvalid;
3252                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3253                         return 0;
3254                     }
3255                     else if (!options.m_allow_bitfields_syntax) // if this is a scalar, check that we can expand bitfields
3256                     {
3257                         *first_unparsed = expression_cstr;
3258                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorNotAllowed;
3259                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3260                         return 0;
3261                     }
3262                 }
3263                 if (*(expression_cstr+1) == ']') // if this is an unbounded range it only works for arrays
3264                 {
3265                     if (!root_clang_type_info.Test(eTypeIsArray))
3266                     {
3267                         *first_unparsed = expression_cstr;
3268                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEmptyRangeNotAllowed;
3269                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3270                         return 0;
3271                     }
3272                     else // expand this into list
3273                     {
3274                         const size_t max_index = root->GetNumChildren() - 1;
3275                         for (size_t index = 0; index < max_index; index++)
3276                         {
3277                             ValueObjectSP child =
3278                                 root->GetChildAtIndex(index, true);
3279                             list->Append(child);
3280                         }
3281                         *first_unparsed = expression_cstr+2;
3282                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3283                         *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3284                         return max_index; // tell me number of items I added to the VOList
3285                     }
3286                 }
3287                 const char *separator_position = ::strchr(expression_cstr+1,'-');
3288                 const char *close_bracket_position = ::strchr(expression_cstr+1,']');
3289                 if (!close_bracket_position) // if there is no ], this is a syntax error
3290                 {
3291                     *first_unparsed = expression_cstr;
3292                     *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3293                     *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3294                     return 0;
3295                 }
3296                 if (!separator_position || separator_position > close_bracket_position) // if no separator, this is either [] or [N]
3297                 {
3298                     char *end = NULL;
3299                     unsigned long index = ::strtoul (expression_cstr+1, &end, 0);
3300                     if (!end || end != close_bracket_position) // if something weird is in our way return an error
3301                     {
3302                         *first_unparsed = expression_cstr;
3303                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3304                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3305                         return 0;
3306                     }
3307                     if (end - expression_cstr == 1) // if this is [], only return a valid value for arrays
3308                     {
3309                         if (root_clang_type_info.Test(eTypeIsArray))
3310                         {
3311                             const size_t max_index = root->GetNumChildren() - 1;
3312                             for (size_t index = 0; index < max_index; index++)
3313                             {
3314                                 ValueObjectSP child =
3315                                 root->GetChildAtIndex(index, true);
3316                                 list->Append(child);
3317                             }
3318                             *first_unparsed = expression_cstr+2;
3319                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3320                             *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3321                             return max_index; // tell me number of items I added to the VOList
3322                         }
3323                         else
3324                         {
3325                             *first_unparsed = expression_cstr;
3326                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonEmptyRangeNotAllowed;
3327                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3328                             return 0;
3329                         }
3330                     }
3331                     // from here on we do have a valid index
3332                     if (root_clang_type_info.Test(eTypeIsArray))
3333                     {
3334                         root = root->GetChildAtIndex(index, true);
3335                         if (!root.get())
3336                         {
3337                             *first_unparsed = expression_cstr;
3338                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3339                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3340                             return 0;
3341                         }
3342                         else
3343                         {
3344                             list->Append(root);
3345                             *first_unparsed = end+1; // skip ]
3346                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3347                             *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3348                             return 1;
3349                         }
3350                     }
3351                     else if (root_clang_type_info.Test(eTypeIsPointer))
3352                     {
3353                         if (*what_next == ValueObject::eExpressionPathAftermathDereference &&  // if this is a ptr-to-scalar, I am accessing it by index and I would have deref'ed anyway, then do it now and use this as a bitfield
3354                             pointee_clang_type_info.Test(eTypeIsScalar))
3355                         {
3356                             Error error;
3357                             root = root->Dereference(error);
3358                             if (error.Fail() || !root.get())
3359                             {
3360                                 *first_unparsed = expression_cstr;
3361                                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
3362                                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3363                                 return 0;
3364                             }
3365                             else
3366                             {
3367                                 *what_next = eExpressionPathAftermathNothing;
3368                                 continue;
3369                             }
3370                         }
3371                         else
3372                         {
3373                             root = root->GetSyntheticArrayMember(index, true);
3374                             if (!root.get())
3375                             {
3376                                 *first_unparsed = expression_cstr;
3377                                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3378                                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3379                                 return 0;
3380                             }
3381                             else
3382                             {
3383                                 list->Append(root);
3384                                 *first_unparsed = end+1; // skip ]
3385                                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3386                                 *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3387                                 return 1;
3388                             }
3389                         }
3390                     }
3391                     else /*if (ClangASTContext::IsScalarType(root_clang_type))*/
3392                     {
3393                         root = root->GetSyntheticBitFieldChild(index, index, true);
3394                         if (!root.get())
3395                         {
3396                             *first_unparsed = expression_cstr;
3397                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3398                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3399                             return 0;
3400                         }
3401                         else // we do not know how to expand members of bitfields, so we just return and let the caller do any further processing
3402                         {
3403                             list->Append(root);
3404                             *first_unparsed = end+1; // skip ]
3405                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3406                             *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3407                             return 1;
3408                         }
3409                     }
3410                 }
3411                 else // we have a low and a high index
3412                 {
3413                     char *end = NULL;
3414                     unsigned long index_lower = ::strtoul (expression_cstr+1, &end, 0);
3415                     if (!end || end != separator_position) // if something weird is in our way return an error
3416                     {
3417                         *first_unparsed = expression_cstr;
3418                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3419                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3420                         return 0;
3421                     }
3422                     unsigned long index_higher = ::strtoul (separator_position+1, &end, 0);
3423                     if (!end || end != close_bracket_position) // if something weird is in our way return an error
3424                     {
3425                         *first_unparsed = expression_cstr;
3426                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3427                         *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3428                         return 0;
3429                     }
3430                     if (index_lower > index_higher) // swap indices if required
3431                     {
3432                         unsigned long temp = index_lower;
3433                         index_lower = index_higher;
3434                         index_higher = temp;
3435                     }
3436                     if (root_clang_type_info.Test(eTypeIsScalar)) // expansion only works for scalars
3437                     {
3438                         root = root->GetSyntheticBitFieldChild(index_lower, index_higher, true);
3439                         if (!root.get())
3440                         {
3441                             *first_unparsed = expression_cstr;
3442                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonNoSuchChild;
3443                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3444                             return 0;
3445                         }
3446                         else
3447                         {
3448                             list->Append(root);
3449                             *first_unparsed = end+1; // skip ]
3450                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3451                             *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3452                             return 1;
3453                         }
3454                     }
3455                     else if (root_clang_type_info.Test(eTypeIsPointer) && // if this is a ptr-to-scalar, I am accessing it by index and I would have deref'ed anyway, then do it now and use this as a bitfield
3456                              *what_next == ValueObject::eExpressionPathAftermathDereference &&
3457                              pointee_clang_type_info.Test(eTypeIsScalar))
3458                     {
3459                         Error error;
3460                         root = root->Dereference(error);
3461                         if (error.Fail() || !root.get())
3462                         {
3463                             *first_unparsed = expression_cstr;
3464                             *reason_to_stop = ValueObject::eExpressionPathScanEndReasonDereferencingFailed;
3465                             *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3466                             return 0;
3467                         }
3468                         else
3469                         {
3470                             *what_next = ValueObject::eExpressionPathAftermathNothing;
3471                             continue;
3472                         }
3473                     }
3474                     else
3475                     {
3476                         for (unsigned long index = index_lower;
3477                              index <= index_higher; index++)
3478                         {
3479                             ValueObjectSP child =
3480                                 root->GetChildAtIndex(index, true);
3481                             list->Append(child);
3482                         }
3483                         *first_unparsed = end+1;
3484                         *reason_to_stop = ValueObject::eExpressionPathScanEndReasonRangeOperatorExpanded;
3485                         *final_result = ValueObject::eExpressionPathEndResultTypeValueObjectList;
3486                         return index_higher-index_lower+1; // tell me number of items I added to the VOList
3487                     }
3488                 }
3489                 break;
3490             }
3491             default: // some non-[ separator, or something entirely wrong, is in the way
3492             {
3493                 *first_unparsed = expression_cstr;
3494                 *reason_to_stop = ValueObject::eExpressionPathScanEndReasonUnexpectedSymbol;
3495                 *final_result = ValueObject::eExpressionPathEndResultTypeInvalid;
3496                 return 0;
3497                 break;
3498             }
3499         }
3500     }
3501 }
3502 
3503 void
3504 ValueObject::LogValueObject (Log *log)
3505 {
3506     if (log)
3507         return LogValueObject (log, DumpValueObjectOptions::DefaultOptions());
3508 }
3509 
3510 void
3511 ValueObject::LogValueObject (Log *log, const DumpValueObjectOptions& options)
3512 {
3513     if (log)
3514     {
3515         StreamString s;
3516         Dump (s, options);
3517         if (s.GetSize())
3518             log->PutCString(s.GetData());
3519     }
3520 }
3521 
3522 void
3523 ValueObject::Dump (Stream &s)
3524 {
3525     Dump (s, DumpValueObjectOptions::DefaultOptions());
3526 }
3527 
3528 void
3529 ValueObject::Dump (Stream &s,
3530                    const DumpValueObjectOptions& options)
3531 {
3532     ValueObjectPrinter printer(this,&s,options);
3533     printer.PrintValueObject();
3534 }
3535 
3536 ValueObjectSP
3537 ValueObject::CreateConstantValue (const ConstString &name)
3538 {
3539     ValueObjectSP valobj_sp;
3540 
3541     if (UpdateValueIfNeeded(false) && m_error.Success())
3542     {
3543         ExecutionContext exe_ctx (GetExecutionContextRef());
3544 
3545         DataExtractor data;
3546         data.SetByteOrder (m_data.GetByteOrder());
3547         data.SetAddressByteSize(m_data.GetAddressByteSize());
3548 
3549         if (IsBitfield())
3550         {
3551             Value v(Scalar(GetValueAsUnsigned(UINT64_MAX)));
3552             m_error = v.GetValueAsData (&exe_ctx, data, 0, GetModule().get());
3553         }
3554         else
3555             m_error = m_value.GetValueAsData (&exe_ctx, data, 0, GetModule().get());
3556 
3557         valobj_sp = ValueObjectConstResult::Create (exe_ctx.GetBestExecutionContextScope(),
3558                                                     GetClangType(),
3559                                                     name,
3560                                                     data,
3561                                                     GetAddressOf());
3562     }
3563 
3564     if (!valobj_sp)
3565     {
3566         ExecutionContext exe_ctx (GetExecutionContextRef());
3567         valobj_sp = ValueObjectConstResult::Create (exe_ctx.GetBestExecutionContextScope(), m_error);
3568     }
3569     return valobj_sp;
3570 }
3571 
3572 ValueObjectSP
3573 ValueObject::GetQualifiedRepresentationIfAvailable (lldb::DynamicValueType dynValue,
3574                                                     bool synthValue)
3575 {
3576     ValueObjectSP result_sp(GetSP());
3577 
3578     switch (dynValue)
3579     {
3580         case lldb::eDynamicCanRunTarget:
3581         case lldb::eDynamicDontRunTarget:
3582         {
3583             if (!result_sp->IsDynamic())
3584             {
3585                 if (result_sp->GetDynamicValue(dynValue))
3586                     result_sp = result_sp->GetDynamicValue(dynValue);
3587             }
3588         }
3589             break;
3590         case lldb::eNoDynamicValues:
3591         {
3592             if (result_sp->IsDynamic())
3593             {
3594                 if (result_sp->GetStaticValue())
3595                     result_sp = result_sp->GetStaticValue();
3596             }
3597         }
3598             break;
3599     }
3600 
3601     if (synthValue)
3602     {
3603         if (!result_sp->IsSynthetic())
3604         {
3605             if (result_sp->GetSyntheticValue())
3606                 result_sp = result_sp->GetSyntheticValue();
3607         }
3608     }
3609     else
3610     {
3611         if (result_sp->IsSynthetic())
3612         {
3613             if (result_sp->GetNonSyntheticValue())
3614                 result_sp = result_sp->GetNonSyntheticValue();
3615         }
3616     }
3617 
3618     return result_sp;
3619 }
3620 
3621 lldb::addr_t
3622 ValueObject::GetCPPVTableAddress (AddressType &address_type)
3623 {
3624     ClangASTType pointee_type;
3625     ClangASTType this_type(GetClangType());
3626     uint32_t type_info = this_type.GetTypeInfo(&pointee_type);
3627     if (type_info)
3628     {
3629         bool ptr_or_ref = false;
3630         if (type_info & (eTypeIsPointer | eTypeIsReference))
3631         {
3632             ptr_or_ref = true;
3633             type_info = pointee_type.GetTypeInfo();
3634         }
3635 
3636         const uint32_t cpp_class = eTypeIsClass | eTypeIsCPlusPlus;
3637         if ((type_info & cpp_class) == cpp_class)
3638         {
3639             if (ptr_or_ref)
3640             {
3641                 address_type = GetAddressTypeOfChildren();
3642                 return GetValueAsUnsigned(LLDB_INVALID_ADDRESS);
3643             }
3644             else
3645                 return GetAddressOf (false, &address_type);
3646         }
3647     }
3648 
3649     address_type = eAddressTypeInvalid;
3650     return LLDB_INVALID_ADDRESS;
3651 }
3652 
3653 ValueObjectSP
3654 ValueObject::Dereference (Error &error)
3655 {
3656     if (m_deref_valobj)
3657         return m_deref_valobj->GetSP();
3658 
3659     const bool is_pointer_type = IsPointerType();
3660     if (is_pointer_type)
3661     {
3662         bool omit_empty_base_classes = true;
3663         bool ignore_array_bounds = false;
3664 
3665         std::string child_name_str;
3666         uint32_t child_byte_size = 0;
3667         int32_t child_byte_offset = 0;
3668         uint32_t child_bitfield_bit_size = 0;
3669         uint32_t child_bitfield_bit_offset = 0;
3670         bool child_is_base_class = false;
3671         bool child_is_deref_of_parent = false;
3672         const bool transparent_pointers = false;
3673         ClangASTType clang_type = GetClangType();
3674         ClangASTType child_clang_type;
3675 
3676         ExecutionContext exe_ctx (GetExecutionContextRef());
3677 
3678         child_clang_type = clang_type.GetChildClangTypeAtIndex (&exe_ctx,
3679                                                                 0,
3680                                                                 transparent_pointers,
3681                                                                 omit_empty_base_classes,
3682                                                                 ignore_array_bounds,
3683                                                                 child_name_str,
3684                                                                 child_byte_size,
3685                                                                 child_byte_offset,
3686                                                                 child_bitfield_bit_size,
3687                                                                 child_bitfield_bit_offset,
3688                                                                 child_is_base_class,
3689                                                                 child_is_deref_of_parent,
3690                                                                 this);
3691         if (child_clang_type && child_byte_size)
3692         {
3693             ConstString child_name;
3694             if (!child_name_str.empty())
3695                 child_name.SetCString (child_name_str.c_str());
3696 
3697             m_deref_valobj = new ValueObjectChild (*this,
3698                                                    child_clang_type,
3699                                                    child_name,
3700                                                    child_byte_size,
3701                                                    child_byte_offset,
3702                                                    child_bitfield_bit_size,
3703                                                    child_bitfield_bit_offset,
3704                                                    child_is_base_class,
3705                                                    child_is_deref_of_parent,
3706                                                    eAddressTypeInvalid);
3707         }
3708     }
3709 
3710     if (m_deref_valobj)
3711     {
3712         error.Clear();
3713         return m_deref_valobj->GetSP();
3714     }
3715     else
3716     {
3717         StreamString strm;
3718         GetExpressionPath(strm, true);
3719 
3720         if (is_pointer_type)
3721             error.SetErrorStringWithFormat("dereference failed: (%s) %s", GetTypeName().AsCString("<invalid type>"), strm.GetString().c_str());
3722         else
3723             error.SetErrorStringWithFormat("not a pointer type: (%s) %s", GetTypeName().AsCString("<invalid type>"), strm.GetString().c_str());
3724         return ValueObjectSP();
3725     }
3726 }
3727 
3728 ValueObjectSP
3729 ValueObject::AddressOf (Error &error)
3730 {
3731     if (m_addr_of_valobj_sp)
3732         return m_addr_of_valobj_sp;
3733 
3734     AddressType address_type = eAddressTypeInvalid;
3735     const bool scalar_is_load_address = false;
3736     addr_t addr = GetAddressOf (scalar_is_load_address, &address_type);
3737     error.Clear();
3738     if (addr != LLDB_INVALID_ADDRESS)
3739     {
3740         switch (address_type)
3741         {
3742         case eAddressTypeInvalid:
3743             {
3744                 StreamString expr_path_strm;
3745                 GetExpressionPath(expr_path_strm, true);
3746                 error.SetErrorStringWithFormat("'%s' is not in memory", expr_path_strm.GetString().c_str());
3747             }
3748             break;
3749 
3750         case eAddressTypeFile:
3751         case eAddressTypeLoad:
3752         case eAddressTypeHost:
3753             {
3754                 ClangASTType clang_type = GetClangType();
3755                 if (clang_type)
3756                 {
3757                     std::string name (1, '&');
3758                     name.append (m_name.AsCString(""));
3759                     ExecutionContext exe_ctx (GetExecutionContextRef());
3760                     m_addr_of_valobj_sp = ValueObjectConstResult::Create (exe_ctx.GetBestExecutionContextScope(),
3761                                                                           clang_type.GetPointerType(),
3762                                                                           ConstString (name.c_str()),
3763                                                                           addr,
3764                                                                           eAddressTypeInvalid,
3765                                                                           m_data.GetAddressByteSize());
3766                 }
3767             }
3768             break;
3769         }
3770     }
3771     else
3772     {
3773         StreamString expr_path_strm;
3774         GetExpressionPath(expr_path_strm, true);
3775         error.SetErrorStringWithFormat("'%s' doesn't have a valid address", expr_path_strm.GetString().c_str());
3776     }
3777 
3778     return m_addr_of_valobj_sp;
3779 }
3780 
3781 ValueObjectSP
3782 ValueObject::Cast (const ClangASTType &clang_ast_type)
3783 {
3784     return ValueObjectCast::Create (*this, GetName(), clang_ast_type);
3785 }
3786 
3787 ValueObjectSP
3788 ValueObject::CastPointerType (const char *name, ClangASTType &clang_ast_type)
3789 {
3790     ValueObjectSP valobj_sp;
3791     AddressType address_type;
3792     addr_t ptr_value = GetPointerValue (&address_type);
3793 
3794     if (ptr_value != LLDB_INVALID_ADDRESS)
3795     {
3796         Address ptr_addr (ptr_value);
3797         ExecutionContext exe_ctx (GetExecutionContextRef());
3798         valobj_sp = ValueObjectMemory::Create (exe_ctx.GetBestExecutionContextScope(),
3799                                                name,
3800                                                ptr_addr,
3801                                                clang_ast_type);
3802     }
3803     return valobj_sp;
3804 }
3805 
3806 ValueObjectSP
3807 ValueObject::CastPointerType (const char *name, TypeSP &type_sp)
3808 {
3809     ValueObjectSP valobj_sp;
3810     AddressType address_type;
3811     addr_t ptr_value = GetPointerValue (&address_type);
3812 
3813     if (ptr_value != LLDB_INVALID_ADDRESS)
3814     {
3815         Address ptr_addr (ptr_value);
3816         ExecutionContext exe_ctx (GetExecutionContextRef());
3817         valobj_sp = ValueObjectMemory::Create (exe_ctx.GetBestExecutionContextScope(),
3818                                                name,
3819                                                ptr_addr,
3820                                                type_sp);
3821     }
3822     return valobj_sp;
3823 }
3824 
3825 ValueObject::EvaluationPoint::EvaluationPoint () :
3826     m_mod_id(),
3827     m_exe_ctx_ref(),
3828     m_needs_update (true)
3829 {
3830 }
3831 
3832 ValueObject::EvaluationPoint::EvaluationPoint (ExecutionContextScope *exe_scope, bool use_selected):
3833     m_mod_id(),
3834     m_exe_ctx_ref(),
3835     m_needs_update (true)
3836 {
3837     ExecutionContext exe_ctx(exe_scope);
3838     TargetSP target_sp (exe_ctx.GetTargetSP());
3839     if (target_sp)
3840     {
3841         m_exe_ctx_ref.SetTargetSP (target_sp);
3842         ProcessSP process_sp (exe_ctx.GetProcessSP());
3843         if (!process_sp)
3844             process_sp = target_sp->GetProcessSP();
3845 
3846         if (process_sp)
3847         {
3848             m_mod_id = process_sp->GetModID();
3849             m_exe_ctx_ref.SetProcessSP (process_sp);
3850 
3851             ThreadSP thread_sp (exe_ctx.GetThreadSP());
3852 
3853             if (!thread_sp)
3854             {
3855                 if (use_selected)
3856                     thread_sp = process_sp->GetThreadList().GetSelectedThread();
3857             }
3858 
3859             if (thread_sp)
3860             {
3861                 m_exe_ctx_ref.SetThreadSP(thread_sp);
3862 
3863                 StackFrameSP frame_sp (exe_ctx.GetFrameSP());
3864                 if (!frame_sp)
3865                 {
3866                     if (use_selected)
3867                         frame_sp = thread_sp->GetSelectedFrame();
3868                 }
3869                 if (frame_sp)
3870                     m_exe_ctx_ref.SetFrameSP(frame_sp);
3871             }
3872         }
3873     }
3874 }
3875 
3876 ValueObject::EvaluationPoint::EvaluationPoint (const ValueObject::EvaluationPoint &rhs) :
3877     m_mod_id(),
3878     m_exe_ctx_ref(rhs.m_exe_ctx_ref),
3879     m_needs_update (true)
3880 {
3881 }
3882 
3883 ValueObject::EvaluationPoint::~EvaluationPoint ()
3884 {
3885 }
3886 
3887 // This function checks the EvaluationPoint against the current process state.  If the current
3888 // state matches the evaluation point, or the evaluation point is already invalid, then we return
3889 // false, meaning "no change".  If the current state is different, we update our state, and return
3890 // true meaning "yes, change".  If we did see a change, we also set m_needs_update to true, so
3891 // future calls to NeedsUpdate will return true.
3892 // exe_scope will be set to the current execution context scope.
3893 
3894 bool
3895 ValueObject::EvaluationPoint::SyncWithProcessState()
3896 {
3897 
3898     // Start with the target, if it is NULL, then we're obviously not going to get any further:
3899     const bool thread_and_frame_only_if_stopped = true;
3900     ExecutionContext exe_ctx(m_exe_ctx_ref.Lock(thread_and_frame_only_if_stopped));
3901 
3902     if (exe_ctx.GetTargetPtr() == NULL)
3903         return false;
3904 
3905     // If we don't have a process nothing can change.
3906     Process *process = exe_ctx.GetProcessPtr();
3907     if (process == NULL)
3908         return false;
3909 
3910     // If our stop id is the current stop ID, nothing has changed:
3911     ProcessModID current_mod_id = process->GetModID();
3912 
3913     // If the current stop id is 0, either we haven't run yet, or the process state has been cleared.
3914     // In either case, we aren't going to be able to sync with the process state.
3915     if (current_mod_id.GetStopID() == 0)
3916         return false;
3917 
3918     bool changed = false;
3919     const bool was_valid = m_mod_id.IsValid();
3920     if (was_valid)
3921     {
3922         if (m_mod_id == current_mod_id)
3923         {
3924             // Everything is already up to date in this object, no need to
3925             // update the execution context scope.
3926             changed = false;
3927         }
3928         else
3929         {
3930             m_mod_id = current_mod_id;
3931             m_needs_update = true;
3932             changed = true;
3933         }
3934     }
3935 
3936     // Now re-look up the thread and frame in case the underlying objects have gone away & been recreated.
3937     // That way we'll be sure to return a valid exe_scope.
3938     // If we used to have a thread or a frame but can't find it anymore, then mark ourselves as invalid.
3939 
3940     if (m_exe_ctx_ref.HasThreadRef())
3941     {
3942         ThreadSP thread_sp (m_exe_ctx_ref.GetThreadSP());
3943         if (thread_sp)
3944         {
3945             if (m_exe_ctx_ref.HasFrameRef())
3946             {
3947                 StackFrameSP frame_sp (m_exe_ctx_ref.GetFrameSP());
3948                 if (!frame_sp)
3949                 {
3950                     // We used to have a frame, but now it is gone
3951                     SetInvalid();
3952                     changed = was_valid;
3953                 }
3954             }
3955         }
3956         else
3957         {
3958             // We used to have a thread, but now it is gone
3959             SetInvalid();
3960             changed = was_valid;
3961         }
3962 
3963     }
3964     return changed;
3965 }
3966 
3967 void
3968 ValueObject::EvaluationPoint::SetUpdated ()
3969 {
3970     ProcessSP process_sp(m_exe_ctx_ref.GetProcessSP());
3971     if (process_sp)
3972         m_mod_id = process_sp->GetModID();
3973     m_needs_update = false;
3974 }
3975 
3976 
3977 
3978 void
3979 ValueObject::ClearUserVisibleData(uint32_t clear_mask)
3980 {
3981     if ((clear_mask & eClearUserVisibleDataItemsValue) == eClearUserVisibleDataItemsValue)
3982         m_value_str.clear();
3983 
3984     if ((clear_mask & eClearUserVisibleDataItemsLocation) == eClearUserVisibleDataItemsLocation)
3985         m_location_str.clear();
3986 
3987     if ((clear_mask & eClearUserVisibleDataItemsSummary) == eClearUserVisibleDataItemsSummary)
3988         m_summary_str.clear();
3989 
3990     if ((clear_mask & eClearUserVisibleDataItemsDescription) == eClearUserVisibleDataItemsDescription)
3991         m_object_desc_str.clear();
3992 
3993     if ((clear_mask & eClearUserVisibleDataItemsSyntheticChildren) == eClearUserVisibleDataItemsSyntheticChildren)
3994     {
3995             if (m_synthetic_value)
3996                 m_synthetic_value = NULL;
3997     }
3998 
3999     if ((clear_mask & eClearUserVisibleDataItemsValidator) == eClearUserVisibleDataItemsValidator)
4000         m_validation_result.reset();
4001 }
4002 
4003 SymbolContextScope *
4004 ValueObject::GetSymbolContextScope()
4005 {
4006     if (m_parent)
4007     {
4008         if (!m_parent->IsPointerOrReferenceType())
4009             return m_parent->GetSymbolContextScope();
4010     }
4011     return NULL;
4012 }
4013 
4014 lldb::ValueObjectSP
4015 ValueObject::CreateValueObjectFromExpression (const char* name,
4016                                               const char* expression,
4017                                               const ExecutionContext& exe_ctx)
4018 {
4019     return CreateValueObjectFromExpression(name, expression, exe_ctx, EvaluateExpressionOptions());
4020 }
4021 
4022 
4023 lldb::ValueObjectSP
4024 ValueObject::CreateValueObjectFromExpression (const char* name,
4025                                               const char* expression,
4026                                               const ExecutionContext& exe_ctx,
4027                                               const EvaluateExpressionOptions& options)
4028 {
4029     lldb::ValueObjectSP retval_sp;
4030     lldb::TargetSP target_sp(exe_ctx.GetTargetSP());
4031     if (!target_sp)
4032         return retval_sp;
4033     if (!expression || !*expression)
4034         return retval_sp;
4035     target_sp->EvaluateExpression (expression,
4036                                    exe_ctx.GetFrameSP().get(),
4037                                    retval_sp,
4038                                    options);
4039     if (retval_sp && name && *name)
4040         retval_sp->SetName(ConstString(name));
4041     return retval_sp;
4042 }
4043 
4044 lldb::ValueObjectSP
4045 ValueObject::CreateValueObjectFromAddress (const char* name,
4046                                            uint64_t address,
4047                                            const ExecutionContext& exe_ctx,
4048                                            ClangASTType type)
4049 {
4050     if (type)
4051     {
4052         ClangASTType pointer_type(type.GetPointerType());
4053         if (pointer_type)
4054         {
4055             lldb::DataBufferSP buffer(new lldb_private::DataBufferHeap(&address,sizeof(lldb::addr_t)));
4056             lldb::ValueObjectSP ptr_result_valobj_sp(ValueObjectConstResult::Create (exe_ctx.GetBestExecutionContextScope(),
4057                                                                                      pointer_type,
4058                                                                                      ConstString(name),
4059                                                                                      buffer,
4060                                                                                      exe_ctx.GetByteOrder(),
4061                                                                                      exe_ctx.GetAddressByteSize()));
4062             if (ptr_result_valobj_sp)
4063             {
4064                 ptr_result_valobj_sp->GetValue().SetValueType(Value::eValueTypeLoadAddress);
4065                 Error err;
4066                 ptr_result_valobj_sp = ptr_result_valobj_sp->Dereference(err);
4067                 if (ptr_result_valobj_sp && name && *name)
4068                     ptr_result_valobj_sp->SetName(ConstString(name));
4069             }
4070             return ptr_result_valobj_sp;
4071         }
4072     }
4073     return lldb::ValueObjectSP();
4074 }
4075 
4076 lldb::ValueObjectSP
4077 ValueObject::CreateValueObjectFromData (const char* name,
4078                                         const DataExtractor& data,
4079                                         const ExecutionContext& exe_ctx,
4080                                         ClangASTType type)
4081 {
4082     lldb::ValueObjectSP new_value_sp;
4083     new_value_sp = ValueObjectConstResult::Create (exe_ctx.GetBestExecutionContextScope(),
4084                                                    type,
4085                                                    ConstString(name),
4086                                                    data,
4087                                                    LLDB_INVALID_ADDRESS);
4088     new_value_sp->SetAddressTypeOfChildren(eAddressTypeLoad);
4089     if (new_value_sp && name && *name)
4090         new_value_sp->SetName(ConstString(name));
4091     return new_value_sp;
4092 }
4093 
4094 ModuleSP
4095 ValueObject::GetModule ()
4096 {
4097     ValueObject* root(GetRoot());
4098     if (root != this)
4099         return root->GetModule();
4100     return lldb::ModuleSP();
4101 }
4102 
4103 ValueObject*
4104 ValueObject::GetRoot ()
4105 {
4106     if (m_root)
4107         return m_root;
4108     return (m_root = FollowParentChain( [] (ValueObject* vo) -> bool {
4109         return (vo->m_parent != nullptr);
4110     }));
4111 }
4112 
4113 ValueObject*
4114 ValueObject::FollowParentChain (std::function<bool(ValueObject*)> f)
4115 {
4116     ValueObject* vo = this;
4117     while (vo)
4118     {
4119         if (f(vo) == false)
4120             break;
4121         vo = vo->m_parent;
4122     }
4123     return vo;
4124 }
4125 
4126 AddressType
4127 ValueObject::GetAddressTypeOfChildren()
4128 {
4129     if (m_address_type_of_ptr_or_ref_children == eAddressTypeInvalid)
4130     {
4131         ValueObject* root(GetRoot());
4132         if (root != this)
4133             return root->GetAddressTypeOfChildren();
4134     }
4135     return m_address_type_of_ptr_or_ref_children;
4136 }
4137 
4138 lldb::DynamicValueType
4139 ValueObject::GetDynamicValueType ()
4140 {
4141     ValueObject* with_dv_info = this;
4142     while (with_dv_info)
4143     {
4144         if (with_dv_info->HasDynamicValueTypeInfo())
4145             return with_dv_info->GetDynamicValueTypeImpl();
4146         with_dv_info = with_dv_info->m_parent;
4147     }
4148     return lldb::eNoDynamicValues;
4149 }
4150 
4151 lldb::Format
4152 ValueObject::GetFormat () const
4153 {
4154     const ValueObject* with_fmt_info = this;
4155     while (with_fmt_info)
4156     {
4157         if (with_fmt_info->m_format != lldb::eFormatDefault)
4158             return with_fmt_info->m_format;
4159         with_fmt_info = with_fmt_info->m_parent;
4160     }
4161     return m_format;
4162 }
4163 
4164 lldb::LanguageType
4165 ValueObject::GetPreferredDisplayLanguage ()
4166 {
4167     lldb::LanguageType type = m_preferred_display_language;
4168     if (m_preferred_display_language == lldb::eLanguageTypeUnknown)
4169     {
4170         if (GetRoot())
4171         {
4172             if (GetRoot() == this)
4173             {
4174                 if (StackFrameSP frame_sp = GetFrameSP())
4175                 {
4176                     const SymbolContext& sc(frame_sp->GetSymbolContext(eSymbolContextCompUnit));
4177                     if (CompileUnit* cu = sc.comp_unit)
4178                         type = cu->GetLanguage();
4179                 }
4180             }
4181             else
4182             {
4183                 type = GetRoot()->GetPreferredDisplayLanguage();
4184             }
4185         }
4186     }
4187     return (m_preferred_display_language = type); // only compute it once
4188 }
4189 
4190 void
4191 ValueObject::SetPreferredDisplayLanguage (lldb::LanguageType lt)
4192 {
4193     m_preferred_display_language = lt;
4194 }
4195 
4196 bool
4197 ValueObject::CanProvideValue ()
4198 {
4199     // we need to support invalid types as providers of values because some bare-board
4200     // debugging scenarios have no notion of types, but still manage to have raw numeric
4201     // values for things like registers. sigh.
4202     const ClangASTType &type(GetClangType());
4203     return (false == type.IsValid()) || (0 != (type.GetTypeInfo() & eTypeHasValue));
4204 }
4205 
4206 bool
4207 ValueObject::IsChecksumEmpty ()
4208 {
4209     return m_value_checksum.empty();
4210 }
4211 
4212 ValueObjectSP
4213 ValueObject::Persist ()
4214 {
4215     if (!UpdateValueIfNeeded())
4216         return nullptr;
4217 
4218     TargetSP target_sp(GetTargetSP());
4219     if (!target_sp)
4220         return nullptr;
4221 
4222     ConstString name(target_sp->GetPersistentVariables().GetNextPersistentVariableName());
4223 
4224     ClangExpressionVariableSP clang_var_sp(new ClangExpressionVariable(target_sp.get(), GetValue(), name));
4225     if (clang_var_sp)
4226     {
4227         clang_var_sp->m_live_sp = clang_var_sp->m_frozen_sp;
4228         clang_var_sp->m_flags |= ClangExpressionVariable::EVIsProgramReference;
4229         target_sp->GetPersistentVariables().AddVariable(clang_var_sp);
4230     }
4231 
4232     return clang_var_sp->GetValueObject();
4233 }
4234 
4235 bool
4236 ValueObject::IsSyntheticChildrenGenerated ()
4237 {
4238     return m_is_synthetic_children_generated;
4239 }
4240 
4241 void
4242 ValueObject::SetSyntheticChildrenGenerated (bool b)
4243 {
4244     m_is_synthetic_children_generated = b;
4245 }
4246