xref: /llvm-project/lldb/source/DataFormatters/FormatManager.cpp (revision c7c30eb52832dc20a7afe6640ac4ab361ff9b9fe)
1 //===-- FormatManager.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/DataFormatters/FormatManager.h"
11 
12 // C Includes
13 // C++ Includes
14 // Other libraries and framework includes
15 // Project includes
16 
17 #include "lldb/Core/Debugger.h"
18 #include "lldb/DataFormatters/CXXFormatterFunctions.h"
19 #include "lldb/Target/ExecutionContext.h"
20 #include "lldb/Target/Platform.h"
21 #include "llvm/ADT/STLExtras.h"
22 
23 using namespace lldb;
24 using namespace lldb_private;
25 
26 
27 struct FormatInfo
28 {
29     Format format;
30     const char format_char; // One or more format characters that can be used for this format.
31     const char *format_name;    // Long format name that can be used to specify the current format
32 };
33 
34 static FormatInfo
35 g_format_infos[] =
36 {
37     { eFormatDefault        , '\0'  , "default"             },
38     { eFormatBoolean        , 'B'   , "boolean"             },
39     { eFormatBinary         , 'b'   , "binary"              },
40     { eFormatBytes          , 'y'   , "bytes"               },
41     { eFormatBytesWithASCII , 'Y'   , "bytes with ASCII"    },
42     { eFormatChar           , 'c'   , "character"           },
43     { eFormatCharPrintable  , 'C'   , "printable character" },
44     { eFormatComplexFloat   , 'F'   , "complex float"       },
45     { eFormatCString        , 's'   , "c-string"            },
46     { eFormatDecimal        , 'd'   , "decimal"             },
47     { eFormatEnum           , 'E'   , "enumeration"         },
48     { eFormatHex            , 'x'   , "hex"                 },
49     { eFormatHexUppercase   , 'X'   , "uppercase hex"       },
50     { eFormatFloat          , 'f'   , "float"               },
51     { eFormatOctal          , 'o'   , "octal"               },
52     { eFormatOSType         , 'O'   , "OSType"              },
53     { eFormatUnicode16      , 'U'   , "unicode16"           },
54     { eFormatUnicode32      , '\0'  , "unicode32"           },
55     { eFormatUnsigned       , 'u'   , "unsigned decimal"    },
56     { eFormatPointer        , 'p'   , "pointer"             },
57     { eFormatVectorOfChar   , '\0'  , "char[]"              },
58     { eFormatVectorOfSInt8  , '\0'  , "int8_t[]"            },
59     { eFormatVectorOfUInt8  , '\0'  , "uint8_t[]"           },
60     { eFormatVectorOfSInt16 , '\0'  , "int16_t[]"           },
61     { eFormatVectorOfUInt16 , '\0'  , "uint16_t[]"          },
62     { eFormatVectorOfSInt32 , '\0'  , "int32_t[]"           },
63     { eFormatVectorOfUInt32 , '\0'  , "uint32_t[]"          },
64     { eFormatVectorOfSInt64 , '\0'  , "int64_t[]"           },
65     { eFormatVectorOfUInt64 , '\0'  , "uint64_t[]"          },
66     { eFormatVectorOfFloat32, '\0'  , "float32[]"           },
67     { eFormatVectorOfFloat64, '\0'  , "float64[]"           },
68     { eFormatVectorOfUInt128, '\0'  , "uint128_t[]"         },
69     { eFormatComplexInteger , 'I'   , "complex integer"     },
70     { eFormatCharArray      , 'a'   , "character array"     },
71     { eFormatAddressInfo    , 'A'   , "address"             },
72     { eFormatHexFloat       , '\0'  , "hex float"           },
73     { eFormatInstruction    , 'i'   , "instruction"         },
74     { eFormatVoid           , 'v'   , "void"                }
75 };
76 
77 static uint32_t g_num_format_infos = llvm::array_lengthof(g_format_infos);
78 
79 static bool
80 GetFormatFromFormatChar (char format_char, Format &format)
81 {
82     for (uint32_t i=0; i<g_num_format_infos; ++i)
83     {
84         if (g_format_infos[i].format_char == format_char)
85         {
86             format = g_format_infos[i].format;
87             return true;
88         }
89     }
90     format = eFormatInvalid;
91     return false;
92 }
93 
94 static bool
95 GetFormatFromFormatName (const char *format_name, bool partial_match_ok, Format &format)
96 {
97     uint32_t i;
98     for (i=0; i<g_num_format_infos; ++i)
99     {
100         if (strcasecmp (g_format_infos[i].format_name, format_name) == 0)
101         {
102             format = g_format_infos[i].format;
103             return true;
104         }
105     }
106 
107     if (partial_match_ok)
108     {
109         for (i=0; i<g_num_format_infos; ++i)
110         {
111             if (strcasestr (g_format_infos[i].format_name, format_name) == g_format_infos[i].format_name)
112             {
113                 format = g_format_infos[i].format;
114                 return true;
115             }
116         }
117     }
118     format = eFormatInvalid;
119     return false;
120 }
121 
122 bool
123 FormatManager::GetFormatFromCString (const char *format_cstr,
124                                      bool partial_match_ok,
125                                      lldb::Format &format)
126 {
127     bool success = false;
128     if (format_cstr && format_cstr[0])
129     {
130         if (format_cstr[1] == '\0')
131         {
132             success = GetFormatFromFormatChar (format_cstr[0], format);
133             if (success)
134                 return true;
135         }
136 
137         success = GetFormatFromFormatName (format_cstr, partial_match_ok, format);
138     }
139     if (!success)
140         format = eFormatInvalid;
141     return success;
142 }
143 
144 char
145 FormatManager::GetFormatAsFormatChar (lldb::Format format)
146 {
147     for (uint32_t i=0; i<g_num_format_infos; ++i)
148     {
149         if (g_format_infos[i].format == format)
150             return g_format_infos[i].format_char;
151     }
152     return '\0';
153 }
154 
155 const char *
156 FormatManager::GetFormatAsCString (Format format)
157 {
158     if (format >= eFormatDefault && format < kNumFormats)
159         return g_format_infos[format].format_name;
160     return NULL;
161 }
162 
163 void
164 FormatManager::GetPossibleMatches (ValueObject& valobj,
165                                    ClangASTType clang_type,
166                                    uint32_t reason,
167                                    lldb::DynamicValueType use_dynamic,
168                                    FormattersMatchVector& entries,
169                                    bool did_strip_ptr,
170                                    bool did_strip_ref,
171                                    bool did_strip_typedef,
172                                    bool root_level)
173 {
174     clang_type = clang_type.RemoveFastQualifiers();
175     ConstString type_name(clang_type.GetConstTypeName());
176     if (valobj.GetBitfieldBitSize() > 0)
177     {
178         StreamString sstring;
179         sstring.Printf("%s:%d",type_name.AsCString(),valobj.GetBitfieldBitSize());
180         ConstString bitfieldname = ConstString(sstring.GetData());
181         entries.push_back({bitfieldname,0,did_strip_ptr,did_strip_ref,did_strip_typedef});
182         reason |= lldb_private::eFormatterChoiceCriterionStrippedBitField;
183     }
184     entries.push_back({type_name,reason,did_strip_ptr,did_strip_ref,did_strip_typedef});
185 
186     ConstString display_type_name(clang_type.GetDisplayTypeName());
187     if (display_type_name != type_name)
188         entries.push_back({display_type_name,reason,did_strip_ptr,did_strip_ref,did_strip_typedef});
189 
190     for (bool is_rvalue_ref = true, j = true; j && clang_type.IsReferenceType(nullptr, &is_rvalue_ref); j = false)
191     {
192         ClangASTType non_ref_type = clang_type.GetNonReferenceType();
193         GetPossibleMatches(valobj,
194                            non_ref_type,
195                            reason | lldb_private::eFormatterChoiceCriterionStrippedPointerReference,
196                            use_dynamic,
197                            entries,
198                            did_strip_ptr,
199                            true,
200                            did_strip_typedef);
201         if (non_ref_type.IsTypedefType())
202         {
203             ClangASTType deffed_referenced_type = non_ref_type.GetTypedefedType();
204             deffed_referenced_type = is_rvalue_ref ? deffed_referenced_type.GetRValueReferenceType() : deffed_referenced_type.GetLValueReferenceType();
205             GetPossibleMatches(valobj,
206                                deffed_referenced_type,
207                                reason | lldb_private::eFormatterChoiceCriterionNavigatedTypedefs,
208                                use_dynamic,
209                                entries,
210                                did_strip_ptr,
211                                did_strip_ref,
212                                true); // this is not exactly the usual meaning of stripping typedefs
213         }
214     }
215 
216     if (clang_type.IsPointerType())
217     {
218         ClangASTType non_ptr_type = clang_type.GetPointeeType();
219         GetPossibleMatches(valobj,
220                            non_ptr_type,
221                            reason | lldb_private::eFormatterChoiceCriterionStrippedPointerReference,
222                            use_dynamic,
223                            entries,
224                            true,
225                            did_strip_ref,
226                            did_strip_typedef);
227         if (non_ptr_type.IsTypedefType())
228         {
229             ClangASTType deffed_pointed_type = non_ptr_type.GetTypedefedType().GetPointerType();
230             GetPossibleMatches(valobj,
231                                deffed_pointed_type,
232                                reason | lldb_private::eFormatterChoiceCriterionNavigatedTypedefs,
233                                use_dynamic,
234                                entries,
235                                did_strip_ptr,
236                                did_strip_ref,
237                                true); // this is not exactly the usual meaning of stripping typedefs
238         }
239     }
240     bool canBeObjCDynamic = clang_type.IsPossibleDynamicType (NULL,
241                                                               false, // no C
242                                                               true);  // yes ObjC
243 
244     if (canBeObjCDynamic)
245     {
246         if (use_dynamic != lldb::eNoDynamicValues)
247         {
248             do
249             {
250                 lldb::ProcessSP process_sp = valobj.GetProcessSP();
251                 if (!process_sp)
252                     break;
253                 ObjCLanguageRuntime* runtime = process_sp->GetObjCLanguageRuntime();
254                 if (runtime == nullptr)
255                     break;
256                 ObjCLanguageRuntime::ClassDescriptorSP objc_class_sp (runtime->GetClassDescriptor(valobj));
257                 if (!objc_class_sp)
258                     break;
259                 ConstString name (objc_class_sp->GetClassName());
260                 entries.push_back({name,reason | lldb_private::eFormatterChoiceCriterionDynamicObjCDiscovery,did_strip_ptr,did_strip_ref,did_strip_typedef});
261             } while (false);
262         }
263 
264         ClangASTType non_ptr_type = clang_type.GetPointeeType();
265         GetPossibleMatches(valobj,
266                            non_ptr_type,
267                            reason | lldb_private::eFormatterChoiceCriterionStrippedPointerReference,
268                            use_dynamic,
269                            entries,
270                            true,
271                            did_strip_ref,
272                            did_strip_typedef);
273     }
274 
275     // try to strip typedef chains
276     if (clang_type.IsTypedefType())
277     {
278         ClangASTType deffed_type = clang_type.GetTypedefedType();
279         GetPossibleMatches(valobj,
280                            deffed_type,
281                            reason | lldb_private::eFormatterChoiceCriterionNavigatedTypedefs,
282                            use_dynamic,
283                            entries,
284                            did_strip_ptr,
285                            did_strip_ref,
286                            true);
287     }
288 
289     if (root_level)
290     {
291         do {
292             if (!clang_type.IsValid())
293                 break;
294 
295             ClangASTType unqual_clang_ast_type = clang_type.GetFullyUnqualifiedType();
296             if (!unqual_clang_ast_type.IsValid())
297                 break;
298             if (unqual_clang_ast_type.GetOpaqueQualType() != clang_type.GetOpaqueQualType())
299                 GetPossibleMatches (valobj,
300                                     unqual_clang_ast_type,
301                                     reason,
302                                     use_dynamic,
303                                     entries,
304                                     did_strip_ptr,
305                                     did_strip_ref,
306                                     did_strip_typedef);
307         } while(false);
308 
309 
310         // if all else fails, go to static type
311         if (valobj.IsDynamic())
312         {
313             lldb::ValueObjectSP static_value_sp(valobj.GetStaticValue());
314             if (static_value_sp)
315                 GetPossibleMatches(*static_value_sp.get(),
316                                    static_value_sp->GetClangType(),
317                                    reason | lldb_private::eFormatterChoiceCriterionWentToStaticValue,
318                                    use_dynamic,
319                                    entries,
320                                    did_strip_ptr,
321                                    did_strip_ref,
322                                    did_strip_typedef,
323                                    true);
324         }
325     }
326 }
327 
328 lldb::TypeFormatImplSP
329 FormatManager::GetFormatForType (lldb::TypeNameSpecifierImplSP type_sp)
330 {
331     if (!type_sp)
332         return lldb::TypeFormatImplSP();
333     lldb::TypeFormatImplSP format_chosen_sp;
334     uint32_t num_categories = m_categories_map.GetCount();
335     lldb::TypeCategoryImplSP category_sp;
336     uint32_t prio_category = UINT32_MAX;
337     for (uint32_t category_id = 0;
338          category_id < num_categories;
339          category_id++)
340     {
341         category_sp = GetCategoryAtIndex(category_id);
342         if (category_sp->IsEnabled() == false)
343             continue;
344         lldb::TypeFormatImplSP format_current_sp = category_sp->GetFormatForType(type_sp);
345         if (format_current_sp && (format_chosen_sp.get() == NULL || (prio_category > category_sp->GetEnabledPosition())))
346         {
347             prio_category = category_sp->GetEnabledPosition();
348             format_chosen_sp = format_current_sp;
349         }
350     }
351     return format_chosen_sp;
352 }
353 
354 lldb::TypeSummaryImplSP
355 FormatManager::GetSummaryForType (lldb::TypeNameSpecifierImplSP type_sp)
356 {
357     if (!type_sp)
358         return lldb::TypeSummaryImplSP();
359     lldb::TypeSummaryImplSP summary_chosen_sp;
360     uint32_t num_categories = m_categories_map.GetCount();
361     lldb::TypeCategoryImplSP category_sp;
362     uint32_t prio_category = UINT32_MAX;
363     for (uint32_t category_id = 0;
364          category_id < num_categories;
365          category_id++)
366     {
367         category_sp = GetCategoryAtIndex(category_id);
368         if (category_sp->IsEnabled() == false)
369             continue;
370         lldb::TypeSummaryImplSP summary_current_sp = category_sp->GetSummaryForType(type_sp);
371         if (summary_current_sp && (summary_chosen_sp.get() == NULL || (prio_category > category_sp->GetEnabledPosition())))
372         {
373             prio_category = category_sp->GetEnabledPosition();
374             summary_chosen_sp = summary_current_sp;
375         }
376     }
377     return summary_chosen_sp;
378 }
379 
380 lldb::TypeFilterImplSP
381 FormatManager::GetFilterForType (lldb::TypeNameSpecifierImplSP type_sp)
382 {
383     if (!type_sp)
384         return lldb::TypeFilterImplSP();
385     lldb::TypeFilterImplSP filter_chosen_sp;
386     uint32_t num_categories = m_categories_map.GetCount();
387     lldb::TypeCategoryImplSP category_sp;
388     uint32_t prio_category = UINT32_MAX;
389     for (uint32_t category_id = 0;
390          category_id < num_categories;
391          category_id++)
392     {
393         category_sp = GetCategoryAtIndex(category_id);
394         if (category_sp->IsEnabled() == false)
395             continue;
396         lldb::TypeFilterImplSP filter_current_sp((TypeFilterImpl*)category_sp->GetFilterForType(type_sp).get());
397         if (filter_current_sp && (filter_chosen_sp.get() == NULL || (prio_category > category_sp->GetEnabledPosition())))
398         {
399             prio_category = category_sp->GetEnabledPosition();
400             filter_chosen_sp = filter_current_sp;
401         }
402     }
403     return filter_chosen_sp;
404 }
405 
406 #ifndef LLDB_DISABLE_PYTHON
407 lldb::ScriptedSyntheticChildrenSP
408 FormatManager::GetSyntheticForType (lldb::TypeNameSpecifierImplSP type_sp)
409 {
410     if (!type_sp)
411         return lldb::ScriptedSyntheticChildrenSP();
412     lldb::ScriptedSyntheticChildrenSP synth_chosen_sp;
413     uint32_t num_categories = m_categories_map.GetCount();
414     lldb::TypeCategoryImplSP category_sp;
415     uint32_t prio_category = UINT32_MAX;
416     for (uint32_t category_id = 0;
417          category_id < num_categories;
418          category_id++)
419     {
420         category_sp = GetCategoryAtIndex(category_id);
421         if (category_sp->IsEnabled() == false)
422             continue;
423         lldb::ScriptedSyntheticChildrenSP synth_current_sp((ScriptedSyntheticChildren*)category_sp->GetSyntheticForType(type_sp).get());
424         if (synth_current_sp && (synth_chosen_sp.get() == NULL || (prio_category > category_sp->GetEnabledPosition())))
425         {
426             prio_category = category_sp->GetEnabledPosition();
427             synth_chosen_sp = synth_current_sp;
428         }
429     }
430     return synth_chosen_sp;
431 }
432 #endif
433 
434 #ifndef LLDB_DISABLE_PYTHON
435 lldb::SyntheticChildrenSP
436 FormatManager::GetSyntheticChildrenForType (lldb::TypeNameSpecifierImplSP type_sp)
437 {
438     if (!type_sp)
439         return lldb::SyntheticChildrenSP();
440     lldb::TypeFilterImplSP filter_sp = GetFilterForType(type_sp);
441     lldb::ScriptedSyntheticChildrenSP synth_sp = GetSyntheticForType(type_sp);
442     if (filter_sp->GetRevision() > synth_sp->GetRevision())
443         return lldb::SyntheticChildrenSP(filter_sp.get());
444     else
445         return lldb::SyntheticChildrenSP(synth_sp.get());
446 }
447 #endif
448 
449 lldb::TypeValidatorImplSP
450 FormatManager::GetValidatorForType (lldb::TypeNameSpecifierImplSP type_sp)
451 {
452     if (!type_sp)
453         return lldb::TypeValidatorImplSP();
454     lldb::TypeValidatorImplSP validator_chosen_sp;
455     uint32_t num_categories = m_categories_map.GetCount();
456     lldb::TypeCategoryImplSP category_sp;
457     uint32_t prio_category = UINT32_MAX;
458     for (uint32_t category_id = 0;
459          category_id < num_categories;
460          category_id++)
461     {
462         category_sp = GetCategoryAtIndex(category_id);
463         if (category_sp->IsEnabled() == false)
464             continue;
465         lldb::TypeValidatorImplSP validator_current_sp(category_sp->GetValidatorForType(type_sp).get());
466         if (validator_current_sp && (validator_chosen_sp.get() == NULL || (prio_category > category_sp->GetEnabledPosition())))
467         {
468             prio_category = category_sp->GetEnabledPosition();
469             validator_chosen_sp = validator_current_sp;
470         }
471     }
472     return validator_chosen_sp;
473 }
474 
475 lldb::TypeCategoryImplSP
476 FormatManager::GetCategory (const ConstString& category_name,
477                             bool can_create)
478 {
479     if (!category_name)
480         return GetCategory(m_default_category_name);
481     lldb::TypeCategoryImplSP category;
482     if (m_categories_map.Get(category_name, category))
483         return category;
484 
485     if (!can_create)
486         return lldb::TypeCategoryImplSP();
487 
488     m_categories_map.Add(category_name,lldb::TypeCategoryImplSP(new TypeCategoryImpl(this, category_name)));
489     return GetCategory(category_name);
490 }
491 
492 lldb::Format
493 FormatManager::GetSingleItemFormat(lldb::Format vector_format)
494 {
495     switch(vector_format)
496     {
497         case eFormatVectorOfChar:
498             return eFormatCharArray;
499 
500         case eFormatVectorOfSInt8:
501         case eFormatVectorOfSInt16:
502         case eFormatVectorOfSInt32:
503         case eFormatVectorOfSInt64:
504             return eFormatDecimal;
505 
506         case eFormatVectorOfUInt8:
507         case eFormatVectorOfUInt16:
508         case eFormatVectorOfUInt32:
509         case eFormatVectorOfUInt64:
510         case eFormatVectorOfUInt128:
511             return eFormatHex;
512 
513         case eFormatVectorOfFloat32:
514         case eFormatVectorOfFloat64:
515             return eFormatFloat;
516 
517         default:
518             return lldb::eFormatInvalid;
519     }
520 }
521 
522 bool
523 FormatManager::ShouldPrintAsOneLiner (ValueObject& valobj)
524 {
525     // if settings say no oneline whatsoever
526     if (valobj.GetTargetSP().get() && valobj.GetTargetSP()->GetDebugger().GetAutoOneLineSummaries() == false)
527         return false; // then don't oneline
528 
529     // if this object has a summary, then ask the summary
530     if (valobj.GetSummaryFormat().get() != nullptr)
531         return valobj.GetSummaryFormat()->IsOneLiner();
532 
533     // no children, no party
534     if (valobj.GetNumChildren() == 0)
535         return false;
536 
537     size_t total_children_name_len = 0;
538 
539     for (size_t idx = 0;
540          idx < valobj.GetNumChildren();
541          idx++)
542     {
543         bool is_synth_val = false;
544         ValueObjectSP child_sp(valobj.GetChildAtIndex(idx, true));
545         // something is wrong here - bail out
546         if (!child_sp)
547             return false;
548         // if we decided to define synthetic children for a type, we probably care enough
549         // to show them, but avoid nesting children in children
550         if (child_sp->GetSyntheticChildren().get() != nullptr)
551         {
552             ValueObjectSP synth_sp(child_sp->GetSyntheticValue());
553             // wait.. wat? just get out of here..
554             if (!synth_sp)
555                 return false;
556             // but if we only have them to provide a value, keep going
557             if (synth_sp->MightHaveChildren() == false && synth_sp->DoesProvideSyntheticValue())
558                 is_synth_val = true;
559             else
560                 return false;
561         }
562 
563         total_children_name_len += child_sp->GetName().GetLength();
564 
565         // 50 itself is a "randomly" chosen number - the idea is that
566         // overly long structs should not get this treatment
567         // FIXME: maybe make this a user-tweakable setting?
568         if (total_children_name_len > 50)
569             return false;
570 
571         // if a summary is there..
572         if (child_sp->GetSummaryFormat())
573         {
574             // and it wants children, then bail out
575             if (child_sp->GetSummaryFormat()->DoesPrintChildren(child_sp.get()))
576                 return false;
577         }
578 
579         // if this child has children..
580         if (child_sp->GetNumChildren())
581         {
582             // ...and no summary...
583             // (if it had a summary and the summary wanted children, we would have bailed out anyway
584             //  so this only makes us bail out if this has no summary and we would then print children)
585             if (!child_sp->GetSummaryFormat() && !is_synth_val) // but again only do that if not a synthetic valued child
586                 return false; // then bail out
587         }
588     }
589     return true;
590 }
591 
592 ConstString
593 FormatManager::GetValidTypeName (const ConstString& type)
594 {
595     return ::GetValidTypeName_Impl(type);
596 }
597 
598 ConstString
599 GetTypeForCache (ValueObject& valobj,
600                  lldb::DynamicValueType use_dynamic)
601 {
602     if (use_dynamic == lldb::eNoDynamicValues)
603     {
604         if (valobj.IsDynamic())
605         {
606             if (valobj.GetStaticValue())
607                 return valobj.GetStaticValue()->GetQualifiedTypeName();
608             else
609                 return ConstString();
610         }
611         else
612             return valobj.GetQualifiedTypeName();
613     }
614     if (valobj.IsDynamic())
615         return valobj.GetQualifiedTypeName();
616     if (valobj.GetDynamicValue(use_dynamic))
617         return valobj.GetDynamicValue(use_dynamic)->GetQualifiedTypeName();
618     return ConstString();
619 }
620 
621 lldb::TypeFormatImplSP
622 FormatManager::GetHardcodedFormat (ValueObject& valobj,
623                                    lldb::DynamicValueType use_dynamic)
624 {
625     for (const auto& candidate: m_hardcoded_formats)
626     {
627         auto result = candidate(valobj,use_dynamic,*this);
628         if (result)
629             return result;
630     }
631     return nullptr;
632 }
633 
634 lldb::TypeFormatImplSP
635 FormatManager::GetFormat (ValueObject& valobj,
636                           lldb::DynamicValueType use_dynamic)
637 {
638     TypeFormatImplSP retval;
639     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TYPES));
640     ConstString valobj_type(GetTypeForCache(valobj, use_dynamic));
641     if (valobj_type)
642     {
643         if (log)
644             log->Printf("\n\n[FormatManager::GetFormat] Looking into cache for type %s", valobj_type.AsCString("<invalid>"));
645         if (m_format_cache.GetFormat(valobj_type,retval))
646         {
647             if (log)
648             {
649                 log->Printf("[FormatManager::GetFormat] Cache search success. Returning.");
650                 if (log->GetDebug())
651                     log->Printf("[FormatManager::GetFormat] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
652             }
653             return retval;
654         }
655         if (log)
656             log->Printf("[FormatManager::GetFormat] Cache search failed. Going normal route");
657     }
658     retval = m_categories_map.GetFormat(valobj, use_dynamic);
659     if (!retval)
660     {
661         if (log)
662             log->Printf("[FormatManager::GetFormat] Search failed. Giving hardcoded a chance.");
663         retval = GetHardcodedFormat(valobj, use_dynamic);
664     }
665     else if (valobj_type)
666     {
667         if (log)
668             log->Printf("[FormatManager::GetFormat] Caching %p for type %s",
669                         static_cast<void*>(retval.get()),
670                         valobj_type.AsCString("<invalid>"));
671         m_format_cache.SetFormat(valobj_type,retval);
672     }
673     if (log && log->GetDebug())
674         log->Printf("[FormatManager::GetFormat] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
675     return retval;
676 }
677 
678 lldb::TypeSummaryImplSP
679 FormatManager::GetHardcodedSummaryFormat (ValueObject& valobj,
680                                           lldb::DynamicValueType use_dynamic)
681 {
682     for (const auto& candidate: m_hardcoded_summaries)
683     {
684         auto result = candidate(valobj,use_dynamic,*this);
685         if (result)
686             return result;
687     }
688     return nullptr;
689 }
690 
691 lldb::TypeSummaryImplSP
692 FormatManager::GetSummaryFormat (ValueObject& valobj,
693                                  lldb::DynamicValueType use_dynamic)
694 {
695     TypeSummaryImplSP retval;
696     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TYPES));
697     ConstString valobj_type(GetTypeForCache(valobj, use_dynamic));
698     if (valobj_type)
699     {
700         if (log)
701             log->Printf("\n\n[FormatManager::GetSummaryFormat] Looking into cache for type %s", valobj_type.AsCString("<invalid>"));
702         if (m_format_cache.GetSummary(valobj_type,retval))
703         {
704             if (log)
705             {
706                 log->Printf("[FormatManager::GetSummaryFormat] Cache search success. Returning.");
707                 if (log->GetDebug())
708                     log->Printf("[FormatManager::GetSummaryFormat] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
709             }
710             return retval;
711         }
712         if (log)
713             log->Printf("[FormatManager::GetSummaryFormat] Cache search failed. Going normal route");
714     }
715     retval = m_categories_map.GetSummaryFormat(valobj, use_dynamic);
716     if (!retval)
717     {
718         if (log)
719             log->Printf("[FormatManager::GetSummaryFormat] Search failed. Giving hardcoded a chance.");
720         retval = GetHardcodedSummaryFormat(valobj, use_dynamic);
721     }
722     else if (valobj_type)
723     {
724         if (log)
725             log->Printf("[FormatManager::GetSummaryFormat] Caching %p for type %s",
726                         static_cast<void*>(retval.get()),
727                         valobj_type.AsCString("<invalid>"));
728         m_format_cache.SetSummary(valobj_type,retval);
729     }
730     if (log && log->GetDebug())
731         log->Printf("[FormatManager::GetSummaryFormat] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
732     return retval;
733 }
734 
735 #ifndef LLDB_DISABLE_PYTHON
736 lldb::SyntheticChildrenSP
737 FormatManager::GetHardcodedSyntheticChildren (ValueObject& valobj,
738                                               lldb::DynamicValueType use_dynamic)
739 {
740     for (const auto& candidate: m_hardcoded_synthetics)
741     {
742         auto result = candidate(valobj,use_dynamic,*this);
743         if (result)
744             return result;
745     }
746     return nullptr;
747 }
748 
749 lldb::SyntheticChildrenSP
750 FormatManager::GetSyntheticChildren (ValueObject& valobj,
751                                      lldb::DynamicValueType use_dynamic)
752 {
753     SyntheticChildrenSP retval;
754     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TYPES));
755     ConstString valobj_type(GetTypeForCache(valobj, use_dynamic));
756     if (valobj_type)
757     {
758         if (log)
759             log->Printf("\n\n[FormatManager::GetSyntheticChildren] Looking into cache for type %s", valobj_type.AsCString("<invalid>"));
760         if (m_format_cache.GetSynthetic(valobj_type,retval))
761         {
762             if (log)
763             {
764                 log->Printf("[FormatManager::GetSyntheticChildren] Cache search success. Returning.");
765                 if (log->GetDebug())
766                     log->Printf("[FormatManager::GetSyntheticChildren] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
767             }
768             return retval;
769         }
770         if (log)
771             log->Printf("[FormatManager::GetSyntheticChildren] Cache search failed. Going normal route");
772     }
773     retval = m_categories_map.GetSyntheticChildren(valobj, use_dynamic);
774     if (!retval)
775     {
776         if (log)
777             log->Printf("[FormatManager::GetSyntheticChildren] Search failed. Giving hardcoded a chance.");
778         retval = GetHardcodedSyntheticChildren(valobj, use_dynamic);
779     }
780     else if (valobj_type)
781     {
782         if (log)
783             log->Printf("[FormatManager::GetSyntheticChildren] Caching %p for type %s",
784                         static_cast<void*>(retval.get()),
785                         valobj_type.AsCString("<invalid>"));
786         m_format_cache.SetSynthetic(valobj_type,retval);
787     }
788     if (log && log->GetDebug())
789         log->Printf("[FormatManager::GetSyntheticChildren] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
790     return retval;
791 }
792 #endif
793 
794 lldb::TypeValidatorImplSP
795 FormatManager::GetValidator (ValueObject& valobj,
796                              lldb::DynamicValueType use_dynamic)
797 {
798     TypeValidatorImplSP retval;
799     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TYPES));
800     ConstString valobj_type(GetTypeForCache(valobj, use_dynamic));
801     if (valobj_type)
802     {
803         if (log)
804             log->Printf("\n\n[FormatManager::GetValidator] Looking into cache for type %s", valobj_type.AsCString("<invalid>"));
805         if (m_format_cache.GetValidator(valobj_type,retval))
806         {
807             if (log)
808             {
809                 log->Printf("[FormatManager::GetValidator] Cache search success. Returning.");
810                 if (log->GetDebug())
811                     log->Printf("[FormatManager::GetValidator] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
812             }
813             return retval;
814         }
815         if (log)
816             log->Printf("[FormatManager::GetValidator] Cache search failed. Going normal route");
817     }
818     retval = m_categories_map.GetValidator(valobj, use_dynamic);
819     if (!retval)
820     {
821         if (log)
822             log->Printf("[FormatManager::GetValidator] Search failed. Giving hardcoded a chance.");
823         retval = GetHardcodedValidator(valobj, use_dynamic);
824     }
825     else if (valobj_type)
826     {
827         if (log)
828             log->Printf("[FormatManager::GetValidator] Caching %p for type %s",
829                         static_cast<void*>(retval.get()),
830                         valobj_type.AsCString("<invalid>"));
831         m_format_cache.SetValidator(valobj_type,retval);
832     }
833     if (log && log->GetDebug())
834         log->Printf("[FormatManager::GetValidator] Cache hits: %" PRIu64 " - Cache Misses: %" PRIu64, m_format_cache.GetCacheHits(), m_format_cache.GetCacheMisses());
835     return retval;
836 }
837 
838 lldb::TypeValidatorImplSP
839 FormatManager::GetHardcodedValidator (ValueObject& valobj,
840                                       lldb::DynamicValueType use_dynamic)
841 {
842     for (const auto& candidate: m_hardcoded_validators)
843     {
844         auto result = candidate(valobj,use_dynamic,*this);
845         if (result)
846             return result;
847     }
848     return nullptr;
849 }
850 
851 FormatManager::FormatManager() :
852     m_format_cache(),
853     m_named_summaries_map(this),
854     m_last_revision(0),
855     m_categories_map(this),
856     m_default_category_name(ConstString("default")),
857     m_system_category_name(ConstString("system")),
858     m_gnu_cpp_category_name(ConstString("gnu-libstdc++")),
859     m_libcxx_category_name(ConstString("libcxx")),
860     m_objc_category_name(ConstString("objc")),
861     m_corefoundation_category_name(ConstString("CoreFoundation")),
862     m_coregraphics_category_name(ConstString("CoreGraphics")),
863     m_coreservices_category_name(ConstString("CoreServices")),
864     m_vectortypes_category_name(ConstString("VectorTypes")),
865     m_appkit_category_name(ConstString("AppKit")),
866     m_coremedia_category_name(ConstString("CoreMedia")),
867     m_hardcoded_formats(),
868     m_hardcoded_summaries(),
869     m_hardcoded_synthetics(),
870     m_hardcoded_validators()
871 
872 {
873     LoadSystemFormatters();
874     LoadLibStdcppFormatters();
875     LoadLibcxxFormatters();
876     LoadObjCFormatters();
877     LoadCoreMediaFormatters();
878     LoadHardcodedFormatters();
879 
880     EnableCategory(m_objc_category_name,TypeCategoryMap::Last);
881     EnableCategory(m_corefoundation_category_name,TypeCategoryMap::Last);
882     EnableCategory(m_appkit_category_name,TypeCategoryMap::Last);
883     EnableCategory(m_coreservices_category_name,TypeCategoryMap::Last);
884     EnableCategory(m_coregraphics_category_name,TypeCategoryMap::Last);
885     EnableCategory(m_coremedia_category_name,TypeCategoryMap::Last);
886     EnableCategory(m_gnu_cpp_category_name,TypeCategoryMap::Last);
887     EnableCategory(m_libcxx_category_name,TypeCategoryMap::Last);
888     EnableCategory(m_vectortypes_category_name,TypeCategoryMap::Last);
889     EnableCategory(m_system_category_name,TypeCategoryMap::Last);
890 }
891 
892 static void
893 AddFormat (TypeCategoryImpl::SharedPointer category_sp,
894            lldb::Format format,
895            ConstString type_name,
896            TypeFormatImpl::Flags flags,
897            bool regex = false)
898 {
899     lldb::TypeFormatImplSP format_sp(new TypeFormatImpl_Format(format, flags));
900 
901     if (regex)
902         category_sp->GetRegexTypeFormatsContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())),format_sp);
903     else
904         category_sp->GetTypeFormatsContainer()->Add(type_name, format_sp);
905 }
906 
907 
908 static void
909 AddStringSummary(TypeCategoryImpl::SharedPointer category_sp,
910                  const char* string,
911                  ConstString type_name,
912                  TypeSummaryImpl::Flags flags,
913                  bool regex = false)
914 {
915     lldb::TypeSummaryImplSP summary_sp(new StringSummaryFormat(flags,
916                                                                string));
917 
918     if (regex)
919         category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())),summary_sp);
920     else
921         category_sp->GetTypeSummariesContainer()->Add(type_name, summary_sp);
922 }
923 
924 static void
925 AddOneLineSummary (TypeCategoryImpl::SharedPointer category_sp,
926                    ConstString type_name,
927                    TypeSummaryImpl::Flags flags,
928                    bool regex = false)
929 {
930     flags.SetShowMembersOneLiner(true);
931     lldb::TypeSummaryImplSP summary_sp(new StringSummaryFormat(flags, ""));
932 
933     if (regex)
934         category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())),summary_sp);
935     else
936         category_sp->GetTypeSummariesContainer()->Add(type_name, summary_sp);
937 }
938 
939 #ifndef LLDB_DISABLE_PYTHON
940 static void
941 AddCXXSummary (TypeCategoryImpl::SharedPointer category_sp,
942                CXXFunctionSummaryFormat::Callback funct,
943                const char* description,
944                ConstString type_name,
945                TypeSummaryImpl::Flags flags,
946                bool regex = false)
947 {
948     lldb::TypeSummaryImplSP summary_sp(new CXXFunctionSummaryFormat(flags,funct,description));
949     if (regex)
950         category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())),summary_sp);
951     else
952         category_sp->GetTypeSummariesContainer()->Add(type_name, summary_sp);
953 }
954 #endif
955 
956 #ifndef LLDB_DISABLE_PYTHON
957 static void AddCXXSynthetic  (TypeCategoryImpl::SharedPointer category_sp,
958                               CXXSyntheticChildren::CreateFrontEndCallback generator,
959                               const char* description,
960                               ConstString type_name,
961                               ScriptedSyntheticChildren::Flags flags,
962                               bool regex = false)
963 {
964     lldb::SyntheticChildrenSP synth_sp(new CXXSyntheticChildren(flags,description,generator));
965     if (regex)
966         category_sp->GetRegexTypeSyntheticsContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())), synth_sp);
967     else
968         category_sp->GetTypeSyntheticsContainer()->Add(type_name,synth_sp);
969 }
970 #endif
971 
972 #ifndef LLDB_DISABLE_PYTHON
973 static void AddFilter  (TypeCategoryImpl::SharedPointer category_sp,
974                         std::vector<std::string> children,
975                         const char* description,
976                         ConstString type_name,
977                         ScriptedSyntheticChildren::Flags flags,
978                         bool regex = false)
979 {
980     TypeFilterImplSP filter_sp(new TypeFilterImpl(flags));
981     for (auto child : children)
982         filter_sp->AddExpressionPath(child);
983     if (regex)
984         category_sp->GetRegexTypeFiltersContainer()->Add(RegularExpressionSP(new RegularExpression(type_name.AsCString())), filter_sp);
985     else
986         category_sp->GetTypeFiltersContainer()->Add(type_name,filter_sp);
987 }
988 #endif
989 
990 void
991 FormatManager::LoadLibStdcppFormatters()
992 {
993     TypeSummaryImpl::Flags stl_summary_flags;
994     stl_summary_flags.SetCascades(true)
995     .SetSkipPointers(false)
996     .SetSkipReferences(false)
997     .SetDontShowChildren(true)
998     .SetDontShowValue(true)
999     .SetShowMembersOneLiner(false)
1000     .SetHideItemNames(false);
1001 
1002     lldb::TypeSummaryImplSP std_string_summary_sp(new StringSummaryFormat(stl_summary_flags,
1003                                                                           "${var._M_dataplus._M_p}"));
1004 
1005     TypeCategoryImpl::SharedPointer gnu_category_sp = GetCategory(m_gnu_cpp_category_name);
1006 
1007     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"),
1008                                                 std_string_summary_sp);
1009     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<char>"),
1010                                                 std_string_summary_sp);
1011     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<char,std::char_traits<char>,std::allocator<char> >"),
1012                                                 std_string_summary_sp);
1013     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<char, std::char_traits<char>, std::allocator<char> >"),
1014                                                 std_string_summary_sp);
1015 
1016     // making sure we force-pick the summary for printing wstring (_M_p is a wchar_t*)
1017     lldb::TypeSummaryImplSP std_wstring_summary_sp(new StringSummaryFormat(stl_summary_flags,
1018                                                                            "${var._M_dataplus._M_p%S}"));
1019 
1020     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"),
1021                                                 std_wstring_summary_sp);
1022     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<wchar_t>"),
1023                                                 std_wstring_summary_sp);
1024     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::allocator<wchar_t> >"),
1025                                                 std_wstring_summary_sp);
1026     gnu_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> >"),
1027                                                 std_wstring_summary_sp);
1028 
1029 
1030 #ifndef LLDB_DISABLE_PYTHON
1031 
1032     SyntheticChildren::Flags stl_synth_flags;
1033     stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(false);
1034 
1035     gnu_category_sp->GetRegexTypeSyntheticsContainer()->Add(RegularExpressionSP(new RegularExpression("^std::vector<.+>(( )?&)?$")),
1036                                                        SyntheticChildrenSP(new ScriptedSyntheticChildren(stl_synth_flags,
1037                                                                                                  "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider")));
1038     gnu_category_sp->GetRegexTypeSyntheticsContainer()->Add(RegularExpressionSP(new RegularExpression("^std::map<.+> >(( )?&)?$")),
1039                                                        SyntheticChildrenSP(new ScriptedSyntheticChildren(stl_synth_flags,
1040                                                                                                  "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider")));
1041     gnu_category_sp->GetRegexTypeSyntheticsContainer()->Add(RegularExpressionSP(new RegularExpression("^std::list<.+>(( )?&)?$")),
1042                                                        SyntheticChildrenSP(new ScriptedSyntheticChildren(stl_synth_flags,
1043                                                                                                  "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider")));
1044 
1045     stl_summary_flags.SetDontShowChildren(false);stl_summary_flags.SetSkipPointers(true);
1046     gnu_category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression("^std::vector<.+>(( )?&)?$")),
1047                                                      TypeSummaryImplSP(new StringSummaryFormat(stl_summary_flags,
1048                                                                                                "size=${svar%#}")));
1049     gnu_category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression("^std::map<.+> >(( )?&)?$")),
1050                                                      TypeSummaryImplSP(new StringSummaryFormat(stl_summary_flags,
1051                                                                                                "size=${svar%#}")));
1052     gnu_category_sp->GetRegexTypeSummariesContainer()->Add(RegularExpressionSP(new RegularExpression("^std::list<.+>(( )?&)?$")),
1053                                                      TypeSummaryImplSP(new StringSummaryFormat(stl_summary_flags,
1054                                                                                                "size=${svar%#}")));
1055 
1056     AddCXXSynthetic(gnu_category_sp, lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, "std::vector iterator synthetic children", ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true);
1057 
1058     AddCXXSynthetic(gnu_category_sp, lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, "std::map iterator synthetic children", ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true);
1059 #endif
1060 }
1061 
1062 void
1063 FormatManager::LoadLibcxxFormatters()
1064 {
1065     TypeSummaryImpl::Flags stl_summary_flags;
1066     stl_summary_flags.SetCascades(true)
1067     .SetSkipPointers(false)
1068     .SetSkipReferences(false)
1069     .SetDontShowChildren(true)
1070     .SetDontShowValue(true)
1071     .SetShowMembersOneLiner(false)
1072     .SetHideItemNames(false);
1073 
1074 #ifndef LLDB_DISABLE_PYTHON
1075     //std::string code("     lldb.formatters.cpp.libcxx.stdstring_SummaryProvider(valobj,internal_dict)");
1076     //lldb::TypeSummaryImplSP std_string_summary_sp(new ScriptSummaryFormat(stl_summary_flags, "lldb.formatters.cpp.libcxx.stdstring_SummaryProvider",code.c_str()));
1077 
1078     lldb::TypeSummaryImplSP std_string_summary_sp(new CXXFunctionSummaryFormat(stl_summary_flags, lldb_private::formatters::LibcxxStringSummaryProvider, "std::string summary provider"));
1079     lldb::TypeSummaryImplSP std_wstring_summary_sp(new CXXFunctionSummaryFormat(stl_summary_flags, lldb_private::formatters::LibcxxWStringSummaryProvider, "std::wstring summary provider"));
1080 
1081     TypeCategoryImpl::SharedPointer libcxx_category_sp = GetCategory(m_libcxx_category_name);
1082 
1083     libcxx_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::__1::string"),
1084                                                    std_string_summary_sp);
1085     libcxx_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >"),
1086                                                    std_string_summary_sp);
1087 
1088     libcxx_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::__1::wstring"),
1089                                                    std_wstring_summary_sp);
1090     libcxx_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >"),
1091                                                    std_wstring_summary_sp);
1092 
1093     SyntheticChildren::Flags stl_synth_flags;
1094     stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(false);
1095 
1096     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator, "libc++ std::vector synthetic children", ConstString("^std::__1::vector<.+>(( )?&)?$"), stl_synth_flags, true);
1097     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator, "libc++ std::list synthetic children", ConstString("^std::__1::list<.+>(( )?&)?$"), stl_synth_flags, true);
1098     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, "libc++ std::map synthetic children", ConstString("^std::__1::map<.+> >(( )?&)?$"), stl_synth_flags, true);
1099     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEndCreator, "libc++ std::vector<bool> synthetic children", ConstString("std::__1::vector<std::__1::allocator<bool> >"), stl_synth_flags);
1100     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEndCreator, "libc++ std::vector<bool> synthetic children", ConstString("std::__1::vector<bool, std::__1::allocator<bool> >"), stl_synth_flags);
1101     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, "libc++ std::set synthetic children", ConstString("^std::__1::set<.+> >(( )?&)?$"), stl_synth_flags, true);
1102     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, "libc++ std::multiset synthetic children", ConstString("^std::__1::multiset<.+> >(( )?&)?$"), stl_synth_flags, true);
1103     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, "libc++ std::multimap synthetic children", ConstString("^std::__1::multimap<.+> >(( )?&)?$"), stl_synth_flags, true);
1104     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator, "libc++ std::unordered containers synthetic children", ConstString("^(std::__1::)unordered_(multi)?(map|set)<.+> >$"), stl_synth_flags, true);
1105     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator, "libc++ std::initializer_list synthetic children", ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags, true);
1106 
1107     libcxx_category_sp->GetRegexTypeSyntheticsContainer()->Add(RegularExpressionSP(new RegularExpression("^(std::__1::)deque<.+>(( )?&)?$")),
1108                                                           SyntheticChildrenSP(new ScriptedSyntheticChildren(stl_synth_flags,
1109                                                                                                     "lldb.formatters.cpp.libcxx.stddeque_SynthProvider")));
1110 
1111     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, "shared_ptr synthetic children", ConstString("^(std::__1::)shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
1112     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, "weak_ptr synthetic children", ConstString("^(std::__1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
1113 
1114     stl_summary_flags.SetDontShowChildren(false);stl_summary_flags.SetSkipPointers(false);
1115     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibcxxVectorBoolSyntheticFrontEndCreator, "libc++ std::vector<bool> synthetic children", ConstString("std::__1::vector<bool, std::__1::allocator<bool> >"), stl_synth_flags);
1116 
1117     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::vector summary provider", ConstString("^std::__1::vector<.+>(( )?&)?$"), stl_summary_flags, true);
1118     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::list summary provider", ConstString("^std::__1::list<.+>(( )?&)?$"), stl_summary_flags, true);
1119     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::map summary provider", ConstString("^std::__1::map<.+>(( )?&)?$"), stl_summary_flags, true);
1120     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::deque summary provider", ConstString("^std::__1::deque<.+>(( )?&)?$"), stl_summary_flags, true);
1121     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::vector<bool> summary provider", ConstString("std::__1::vector<std::__1::allocator<bool> >"), stl_summary_flags);
1122     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::vector<bool> summary provider", ConstString("std::__1::vector<bool, std::__1::allocator<bool> >"), stl_summary_flags);
1123     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::set summary provider", ConstString("^std::__1::set<.+>(( )?&)?$"), stl_summary_flags, true);
1124     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::multiset summary provider", ConstString("^std::__1::multiset<.+>(( )?&)?$"), stl_summary_flags, true);
1125     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::multimap summary provider", ConstString("^std::__1::multimap<.+>(( )?&)?$"), stl_summary_flags, true);
1126     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::unordered containers summary provider", ConstString("^(std::__1::)unordered_(multi)?(map|set)<.+> >$"), stl_summary_flags, true);
1127 
1128     stl_summary_flags.SetSkipPointers(true);
1129 
1130     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxSmartPointerSummaryProvider, "libc++ std::shared_ptr summary provider", ConstString("^std::__1::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, true);
1131     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxSmartPointerSummaryProvider, "libc++ std::weak_ptr summary provider", ConstString("^std::__1::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, true);
1132 
1133     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, "std::vector iterator synthetic children", ConstString("^std::__1::__wrap_iter<.+>$"), stl_synth_flags, true);
1134 
1135     AddCXXSummary(libcxx_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, "libc++ std::vector<bool> summary provider", ConstString("std::__1::vector<bool, std::__1::allocator<bool> >"), stl_summary_flags);
1136     AddCXXSynthetic(libcxx_category_sp, lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, "std::map iterator synthetic children", ConstString("^std::__1::__map_iterator<.+>$"), stl_synth_flags, true);
1137 
1138     AddFilter(libcxx_category_sp, {"__a_"}, "libc++ std::atomic filter", ConstString("^std::__1::atomic<.*>$"), stl_synth_flags, true);
1139 #endif
1140 }
1141 
1142 void
1143 FormatManager::LoadSystemFormatters()
1144 {
1145 
1146     TypeSummaryImpl::Flags string_flags;
1147     string_flags.SetCascades(true)
1148     .SetSkipPointers(true)
1149     .SetSkipReferences(false)
1150     .SetDontShowChildren(true)
1151     .SetDontShowValue(false)
1152     .SetShowMembersOneLiner(false)
1153     .SetHideItemNames(false);
1154 
1155     lldb::TypeSummaryImplSP string_format(new StringSummaryFormat(string_flags, "${var%s}"));
1156 
1157 
1158     lldb::TypeSummaryImplSP string_array_format(new StringSummaryFormat(TypeSummaryImpl::Flags().SetCascades(false)
1159                                                                         .SetSkipPointers(true)
1160                                                                         .SetSkipReferences(false)
1161                                                                         .SetDontShowChildren(true)
1162                                                                         .SetDontShowValue(true)
1163                                                                         .SetShowMembersOneLiner(false)
1164                                                                         .SetHideItemNames(false),
1165                                                                         "${var%s}"));
1166 
1167     lldb::RegularExpressionSP any_size_char_arr(new RegularExpression("char \\[[0-9]+\\]"));
1168 
1169     TypeCategoryImpl::SharedPointer sys_category_sp = GetCategory(m_system_category_name);
1170 
1171     sys_category_sp->GetTypeSummariesContainer()->Add(ConstString("char *"), string_format);
1172     sys_category_sp->GetTypeSummariesContainer()->Add(ConstString("unsigned char *"), string_format);
1173     sys_category_sp->GetRegexTypeSummariesContainer()->Add(any_size_char_arr, string_array_format);
1174 
1175     lldb::TypeSummaryImplSP ostype_summary(new StringSummaryFormat(TypeSummaryImpl::Flags().SetCascades(false)
1176                                                                    .SetSkipPointers(true)
1177                                                                    .SetSkipReferences(true)
1178                                                                    .SetDontShowChildren(true)
1179                                                                    .SetDontShowValue(false)
1180                                                                    .SetShowMembersOneLiner(false)
1181                                                                    .SetHideItemNames(false),
1182                                                                    "${var%O}"));
1183 
1184     sys_category_sp->GetTypeSummariesContainer()->Add(ConstString("OSType"), ostype_summary);
1185 
1186 #ifndef LLDB_DISABLE_PYTHON
1187     // FIXME because of a bug in the FormattersContainer we need to add a summary for both X* and const X* (<rdar://problem/12717717>)
1188     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char16StringSummaryProvider, "char16_t * summary provider", ConstString("char16_t *"), string_flags);
1189 
1190     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char32StringSummaryProvider, "char32_t * summary provider", ConstString("char32_t *"), string_flags);
1191 
1192     AddCXXSummary(sys_category_sp, lldb_private::formatters::WCharStringSummaryProvider, "wchar_t * summary provider", ConstString("wchar_t *"), string_flags);
1193 
1194     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char16StringSummaryProvider, "unichar * summary provider", ConstString("unichar *"), string_flags);
1195 
1196     TypeSummaryImpl::Flags widechar_flags;
1197     widechar_flags.SetDontShowValue(true)
1198     .SetSkipPointers(true)
1199     .SetSkipReferences(false)
1200     .SetCascades(true)
1201     .SetDontShowChildren(true)
1202     .SetHideItemNames(true)
1203     .SetShowMembersOneLiner(false);
1204 
1205     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char16SummaryProvider, "char16_t summary provider", ConstString("char16_t"), widechar_flags);
1206     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char32SummaryProvider, "char32_t summary provider", ConstString("char32_t"), widechar_flags);
1207     AddCXXSummary(sys_category_sp, lldb_private::formatters::WCharSummaryProvider, "wchar_t summary provider", ConstString("wchar_t"), widechar_flags);
1208 
1209     AddCXXSummary(sys_category_sp, lldb_private::formatters::Char16SummaryProvider, "unichar summary provider", ConstString("unichar"), widechar_flags);
1210 
1211     TypeFormatImpl::Flags fourchar_flags;
1212     fourchar_flags.SetCascades(true).SetSkipPointers(true).SetSkipReferences(true);
1213 
1214     AddFormat(sys_category_sp, lldb::eFormatOSType, ConstString("FourCharCode"), fourchar_flags);
1215 #endif
1216 }
1217 
1218 void
1219 FormatManager::LoadObjCFormatters()
1220 {
1221     TypeSummaryImpl::Flags objc_flags;
1222     objc_flags.SetCascades(false)
1223     .SetSkipPointers(true)
1224     .SetSkipReferences(true)
1225     .SetDontShowChildren(true)
1226     .SetDontShowValue(true)
1227     .SetShowMembersOneLiner(false)
1228     .SetHideItemNames(false);
1229 
1230     TypeCategoryImpl::SharedPointer objc_category_sp = GetCategory(m_objc_category_name);
1231     TypeCategoryImpl::SharedPointer appkit_category_sp = GetCategory(m_appkit_category_name);
1232     TypeCategoryImpl::SharedPointer corefoundation_category_sp = GetCategory(m_corefoundation_category_name);
1233     TypeCategoryImpl::SharedPointer coregraphics_category_sp = GetCategory(m_coregraphics_category_name);
1234     TypeCategoryImpl::SharedPointer coreservices_category_sp = GetCategory(m_coreservices_category_name);
1235 
1236     lldb::TypeSummaryImplSP ObjC_BOOL_summary(new CXXFunctionSummaryFormat(objc_flags, lldb_private::formatters::ObjCBOOLSummaryProvider,""));
1237     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL"),
1238                                                  ObjC_BOOL_summary);
1239     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL &"),
1240                                                  ObjC_BOOL_summary);
1241     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL *"),
1242                                                  ObjC_BOOL_summary);
1243 
1244 #ifndef LLDB_DISABLE_PYTHON
1245     // we need to skip pointers here since we are special casing a SEL* when retrieving its value
1246     objc_flags.SetSkipPointers(true);
1247     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("SEL"), objc_flags);
1248     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("struct objc_selector"), objc_flags);
1249     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("objc_selector"), objc_flags);
1250     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<true>, "SEL summary provider", ConstString("objc_selector *"), objc_flags);
1251     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<true>, "SEL summary provider", ConstString("SEL *"), objc_flags);
1252 
1253     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCClassSummaryProvider, "Class summary provider", ConstString("Class"), objc_flags);
1254 
1255     SyntheticChildren::Flags class_synth_flags;
1256     class_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(false);
1257 
1258     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::ObjCClassSyntheticFrontEndCreator, "Class synthetic children", ConstString("Class"), class_synth_flags);
1259 #endif // LLDB_DISABLE_PYTHON
1260 
1261     objc_flags.SetSkipPointers(false);
1262     objc_flags.SetCascades(true);
1263     objc_flags.SetSkipReferences(false);
1264 
1265     AddStringSummary (objc_category_sp,
1266                       "${var.__FuncPtr%A}",
1267                       ConstString("__block_literal_generic"),
1268                       objc_flags);
1269 
1270     AddStringSummary(corefoundation_category_sp,
1271                      "${var.years} years, ${var.months} months, ${var.days} days, ${var.hours} hours, ${var.minutes} minutes ${var.seconds} seconds",
1272                      ConstString("CFGregorianUnits"),
1273                      objc_flags);
1274     AddStringSummary(corefoundation_category_sp,
1275                      "location=${var.location} length=${var.length}",
1276                      ConstString("CFRange"),
1277                      objc_flags);
1278 
1279     AddStringSummary(appkit_category_sp,
1280                      "location=${var.location}, length=${var.length}",
1281                      ConstString("NSRange"),
1282                      objc_flags);
1283     AddStringSummary(appkit_category_sp,
1284                      "(${var.origin}, ${var.size}), ...",
1285                      ConstString("NSRectArray"),
1286                      objc_flags);
1287 
1288     AddOneLineSummary (appkit_category_sp,
1289                        ConstString("NSPoint"),
1290                        objc_flags);
1291     AddOneLineSummary (appkit_category_sp,
1292                        ConstString("NSSize"),
1293                        objc_flags);
1294     AddOneLineSummary (appkit_category_sp,
1295                        ConstString("NSRect"),
1296                        objc_flags);
1297 
1298     AddOneLineSummary (coregraphics_category_sp,
1299                        ConstString("CGSize"),
1300                        objc_flags);
1301     AddOneLineSummary (coregraphics_category_sp,
1302                        ConstString("CGPoint"),
1303                        objc_flags);
1304     AddOneLineSummary (coregraphics_category_sp,
1305                        ConstString("CGRect"),
1306                        objc_flags);
1307 
1308     AddStringSummary(coreservices_category_sp,
1309                      "red=${var.red} green=${var.green} blue=${var.blue}",
1310                      ConstString("RGBColor"),
1311                      objc_flags);
1312     AddStringSummary(coreservices_category_sp,
1313                      "(t=${var.top}, l=${var.left}, b=${var.bottom}, r=${var.right})",
1314                      ConstString("Rect"),
1315                      objc_flags);
1316     AddStringSummary(coreservices_category_sp,
1317                      "(v=${var.v}, h=${var.h})",
1318                      ConstString("Point"),
1319                      objc_flags);
1320     AddStringSummary(coreservices_category_sp,
1321                      "${var.month}/${var.day}/${var.year}  ${var.hour} :${var.minute} :${var.second} dayOfWeek:${var.dayOfWeek}",
1322                      ConstString("DateTimeRect *"),
1323                      objc_flags);
1324     AddStringSummary(coreservices_category_sp,
1325                      "${var.ld.month}/${var.ld.day}/${var.ld.year} ${var.ld.hour} :${var.ld.minute} :${var.ld.second} dayOfWeek:${var.ld.dayOfWeek}",
1326                      ConstString("LongDateRect"),
1327                      objc_flags);
1328     AddStringSummary(coreservices_category_sp,
1329                      "(x=${var.x}, y=${var.y})",
1330                      ConstString("HIPoint"),
1331                      objc_flags);
1332     AddStringSummary(coreservices_category_sp,
1333                      "origin=${var.origin} size=${var.size}",
1334                      ConstString("HIRect"),
1335                      objc_flags);
1336 
1337     TypeSummaryImpl::Flags appkit_flags;
1338     appkit_flags.SetCascades(true)
1339     .SetSkipPointers(false)
1340     .SetSkipReferences(false)
1341     .SetDontShowChildren(true)
1342     .SetDontShowValue(false)
1343     .SetShowMembersOneLiner(false)
1344     .SetHideItemNames(false);
1345 
1346     appkit_flags.SetDontShowChildren(false);
1347 
1348 
1349 #ifndef LLDB_DISABLE_PYTHON
1350     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("NSArray"), appkit_flags);
1351     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("NSMutableArray"), appkit_flags);
1352     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSArrayI"), appkit_flags);
1353     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSArrayM"), appkit_flags);
1354     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSCFArray"), appkit_flags);
1355     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("CFArrayRef"), appkit_flags);
1356     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("CFMutableArrayRef"), appkit_flags);
1357 
1358     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("NSDictionary"), appkit_flags);
1359     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("NSMutableDictionary"), appkit_flags);
1360     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSCFDictionary"), appkit_flags);
1361     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSDictionaryI"), appkit_flags);
1362     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSDictionaryM"), appkit_flags);
1363     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<true>, "NSDictionary summary provider", ConstString("CFDictionaryRef"), appkit_flags);
1364     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<true>, "NSDictionary summary provider", ConstString("CFMutableDictionaryRef"), appkit_flags);
1365 
1366     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSSet summary", ConstString("NSSet"), appkit_flags);
1367     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSMutableSet summary", ConstString("NSMutableSet"), appkit_flags);
1368     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSSetSummaryProvider<true>, "CFSetRef summary", ConstString("CFSetRef"), appkit_flags);
1369     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSSetSummaryProvider<true>, "CFMutableSetRef summary", ConstString("CFMutableSetRef"), appkit_flags);
1370     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSCFSet summary", ConstString("__NSCFSet"), appkit_flags);
1371     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSSetI summary", ConstString("__NSSetI"), appkit_flags);
1372     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSSetM summary", ConstString("__NSSetM"), appkit_flags);
1373     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSCountedSet summary", ConstString("NSCountedSet"), appkit_flags);
1374     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSMutableSet summary", ConstString("NSMutableSet"), appkit_flags);
1375     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSOrderedSet summary", ConstString("NSOrderedSet"), appkit_flags);
1376     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSOrderedSetI summary", ConstString("__NSOrderedSetI"), appkit_flags);
1377     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSOrderedSetM summary", ConstString("__NSOrderedSetM"), appkit_flags);
1378 
1379     // AddSummary(appkit_category_sp, "${var.key%@} -> ${var.value%@}", ConstString("$_lldb_typegen_nspair"), appkit_flags);
1380 
1381     appkit_flags.SetDontShowChildren(true);
1382 
1383     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSArrayM"), ScriptedSyntheticChildren::Flags());
1384     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSArrayI"), ScriptedSyntheticChildren::Flags());
1385     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("NSArray"), ScriptedSyntheticChildren::Flags());
1386     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("NSMutableArray"), ScriptedSyntheticChildren::Flags());
1387     AddCXXSynthetic(corefoundation_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSCFArray"), ScriptedSyntheticChildren::Flags());
1388     AddCXXSynthetic(corefoundation_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("CFMutableArrayRef"), ScriptedSyntheticChildren::Flags());
1389     AddCXXSynthetic(corefoundation_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("CFArrayRef"), ScriptedSyntheticChildren::Flags());
1390 
1391     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSDictionaryM"), ScriptedSyntheticChildren::Flags());
1392     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSDictionaryI"), ScriptedSyntheticChildren::Flags());
1393     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSCFDictionary"), ScriptedSyntheticChildren::Flags());
1394     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("NSDictionary"), ScriptedSyntheticChildren::Flags());
1395     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("NSMutableDictionary"), ScriptedSyntheticChildren::Flags());
1396     AddCXXSynthetic(corefoundation_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("CFDictionaryRef"), ScriptedSyntheticChildren::Flags());
1397     AddCXXSynthetic(corefoundation_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("CFMutableDictionaryRef"), ScriptedSyntheticChildren::Flags());
1398 
1399     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSSet synthetic children", ConstString("NSSet"), ScriptedSyntheticChildren::Flags());
1400     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSSetI synthetic children", ConstString("__NSSetI"), ScriptedSyntheticChildren::Flags());
1401     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSSetM synthetic children", ConstString("__NSSetM"), ScriptedSyntheticChildren::Flags());
1402     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSMutableSet synthetic children", ConstString("NSMutableSet"), ScriptedSyntheticChildren::Flags());
1403     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSOrderedSet synthetic children", ConstString("NSOrderedSet"), ScriptedSyntheticChildren::Flags());
1404     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSOrderedSetI synthetic children", ConstString("__NSOrderedSetI"), ScriptedSyntheticChildren::Flags());
1405     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSOrderedSetM synthetic children", ConstString("__NSOrderedSetM"), ScriptedSyntheticChildren::Flags());
1406 
1407     AddCXXSynthetic(appkit_category_sp, lldb_private::formatters::NSIndexPathSyntheticFrontEndCreator, "NSIndexPath synthetic children", ConstString("NSIndexPath"), ScriptedSyntheticChildren::Flags());
1408 
1409     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("CFBagRef"), appkit_flags);
1410     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("__CFBag"), appkit_flags);
1411     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("const struct __CFBag"), appkit_flags);
1412     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("CFMutableBagRef"), appkit_flags);
1413 
1414     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBinaryHeapSummaryProvider, "CFBinaryHeap summary provider", ConstString("CFBinaryHeapRef"), appkit_flags);
1415     AddCXXSummary(corefoundation_category_sp,lldb_private::formatters::CFBinaryHeapSummaryProvider, "CFBinaryHeap summary provider", ConstString("__CFBinaryHeap"), appkit_flags);
1416 
1417     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSString"), appkit_flags);
1418     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("CFStringRef"), appkit_flags);
1419     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__CFString"), appkit_flags);
1420     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("CFMutableStringRef"), appkit_flags);
1421     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSMutableString"), appkit_flags);
1422     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__NSCFConstantString"), appkit_flags);
1423     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__NSCFString"), appkit_flags);
1424     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSCFConstantString"), appkit_flags);
1425     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSCFString"), appkit_flags);
1426     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSPathStore2"), appkit_flags);
1427 
1428     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSAttributedStringSummaryProvider, "NSAttributedString summary provider", ConstString("NSAttributedString"), appkit_flags);
1429     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSMutableAttributedStringSummaryProvider, "NSMutableAttributedString summary provider", ConstString("NSMutableAttributedString"), appkit_flags);
1430     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSMutableAttributedStringSummaryProvider, "NSMutableAttributedString summary provider", ConstString("NSConcreteMutableAttributedString"), appkit_flags);
1431 
1432     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSBundleSummaryProvider, "NSBundle summary provider", ConstString("NSBundle"), appkit_flags);
1433 
1434     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSData"), appkit_flags);
1435     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSConcreteData"), appkit_flags);
1436     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSConcreteMutableData"), appkit_flags);
1437     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSMutableData"), appkit_flags);
1438     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("__NSCFData"), appkit_flags);
1439     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSDataSummaryProvider<true>, "NSData summary provider", ConstString("CFDataRef"), appkit_flags);
1440     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSDataSummaryProvider<true>, "NSData summary provider", ConstString("CFMutableDataRef"), appkit_flags);
1441 
1442     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSMachPortSummaryProvider, "NSMachPort summary provider", ConstString("NSMachPort"), appkit_flags);
1443 
1444     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSNotificationSummaryProvider, "NSNotification summary provider", ConstString("NSNotification"), appkit_flags);
1445     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSNotificationSummaryProvider, "NSNotification summary provider", ConstString("NSConcreteNotification"), appkit_flags);
1446 
1447     AddStringSummary(appkit_category_sp, "domain: ${var._domain} - code: ${var._code}", ConstString("NSError"), appkit_flags);
1448     AddStringSummary(appkit_category_sp,"name:${var.name%S} reason:${var.reason%S}",ConstString("NSException"),appkit_flags);
1449 
1450     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSNumber"), appkit_flags);
1451     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "CFNumberRef summary provider", ConstString("CFNumberRef"), appkit_flags);
1452     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("__NSCFBoolean"), appkit_flags);
1453     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("__NSCFNumber"), appkit_flags);
1454     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSCFBoolean"), appkit_flags);
1455     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSCFNumber"), appkit_flags);
1456 
1457     AddCXXSummary(appkit_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSDecimalNumber summary provider", ConstString("NSDecimalNumber"), appkit_flags);
1458     AddCXXSummary(appkit_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSHost summary provider", ConstString("NSHost"), appkit_flags);
1459     AddCXXSummary(appkit_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSTask summary provider", ConstString("NSTask"), appkit_flags);
1460     AddCXXSummary(appkit_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSValue summary provider", ConstString("NSValue"), appkit_flags);
1461 
1462     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSURLSummaryProvider, "NSURL summary provider", ConstString("NSURL"), appkit_flags);
1463     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSURLSummaryProvider, "NSURL summary provider", ConstString("CFURLRef"), appkit_flags);
1464 
1465     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("NSDate"), appkit_flags);
1466     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("__NSDate"), appkit_flags);
1467     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("__NSTaggedDate"), appkit_flags);
1468     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("NSCalendarDate"), appkit_flags);
1469 
1470     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("NSTimeZone"), appkit_flags);
1471     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("CFTimeZoneRef"), appkit_flags);
1472     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("__NSTimeZone"), appkit_flags);
1473 
1474     // CFAbsoluteTime is actually a double rather than a pointer to an object
1475     // we do not care about the numeric value, since it is probably meaningless to users
1476     appkit_flags.SetDontShowValue(true);
1477     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::CFAbsoluteTimeSummaryProvider, "CFAbsoluteTime summary provider", ConstString("CFAbsoluteTime"), appkit_flags);
1478     appkit_flags.SetDontShowValue(false);
1479 
1480     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSIndexSetSummaryProvider, "NSIndexSet summary provider", ConstString("NSIndexSet"), appkit_flags);
1481     AddCXXSummary(appkit_category_sp, lldb_private::formatters::NSIndexSetSummaryProvider, "NSIndexSet summary provider", ConstString("NSMutableIndexSet"), appkit_flags);
1482 
1483     AddStringSummary(corefoundation_category_sp,
1484                      "@\"${var.month%d}/${var.day%d}/${var.year%d} ${var.hour%d}:${var.minute%d}:${var.second}\"",
1485                      ConstString("CFGregorianDate"),
1486                      appkit_flags);
1487 
1488     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("CFBitVectorRef"), appkit_flags);
1489     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("CFMutableBitVectorRef"), appkit_flags);
1490     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("__CFBitVector"), appkit_flags);
1491     AddCXXSummary(corefoundation_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("__CFMutableBitVector"), appkit_flags);
1492 #endif // LLDB_DISABLE_PYTHON
1493 
1494     TypeCategoryImpl::SharedPointer vectors_category_sp = GetCategory(m_vectortypes_category_name);
1495 
1496     TypeSummaryImpl::Flags vector_flags;
1497     vector_flags.SetCascades(true)
1498     .SetSkipPointers(true)
1499     .SetSkipReferences(false)
1500     .SetDontShowChildren(true)
1501     .SetDontShowValue(false)
1502     .SetShowMembersOneLiner(true)
1503     .SetHideItemNames(true);
1504 
1505     AddStringSummary(vectors_category_sp,
1506                      "${var.uint128}",
1507                      ConstString("builtin_type_vec128"),
1508                      objc_flags);
1509 
1510     AddStringSummary(vectors_category_sp,
1511                      "",
1512                      ConstString("float [4]"),
1513                      vector_flags);
1514     AddStringSummary(vectors_category_sp,
1515                      "",
1516                      ConstString("int32_t [4]"),
1517                      vector_flags);
1518     AddStringSummary(vectors_category_sp,
1519                      "",
1520                      ConstString("int16_t [8]"),
1521                      vector_flags);
1522     AddStringSummary(vectors_category_sp,
1523                      "",
1524                      ConstString("vDouble"),
1525                      vector_flags);
1526     AddStringSummary(vectors_category_sp,
1527                      "",
1528                      ConstString("vFloat"),
1529                      vector_flags);
1530     AddStringSummary(vectors_category_sp,
1531                      "",
1532                      ConstString("vSInt8"),
1533                      vector_flags);
1534     AddStringSummary(vectors_category_sp,
1535                      "",
1536                      ConstString("vSInt16"),
1537                      vector_flags);
1538     AddStringSummary(vectors_category_sp,
1539                      "",
1540                      ConstString("vSInt32"),
1541                      vector_flags);
1542     AddStringSummary(vectors_category_sp,
1543                      "",
1544                      ConstString("vUInt16"),
1545                      vector_flags);
1546     AddStringSummary(vectors_category_sp,
1547                      "",
1548                      ConstString("vUInt8"),
1549                      vector_flags);
1550     AddStringSummary(vectors_category_sp,
1551                      "",
1552                      ConstString("vUInt16"),
1553                      vector_flags);
1554     AddStringSummary(vectors_category_sp,
1555                      "",
1556                      ConstString("vUInt32"),
1557                      vector_flags);
1558     AddStringSummary(vectors_category_sp,
1559                      "",
1560                      ConstString("vBool32"),
1561                      vector_flags);
1562 }
1563 
1564 void
1565 FormatManager::LoadCoreMediaFormatters()
1566 {
1567     TypeSummaryImpl::Flags cm_flags;
1568     cm_flags.SetCascades(true)
1569     .SetDontShowChildren(false)
1570     .SetDontShowValue(false)
1571     .SetHideItemNames(false)
1572     .SetShowMembersOneLiner(false)
1573     .SetSkipPointers(false)
1574     .SetSkipReferences(false);
1575 
1576     TypeCategoryImpl::SharedPointer cm_category_sp = GetCategory(m_coremedia_category_name);
1577 
1578 #ifndef LLDB_DISABLE_PYTHON
1579     AddCXXSummary(cm_category_sp, lldb_private::formatters::CMTimeSummaryProvider, "CMTime summary provider", ConstString("CMTime"), cm_flags);
1580 #endif // LLDB_DISABLE_PYTHON
1581 }
1582 
1583 void
1584 FormatManager::LoadHardcodedFormatters()
1585 {
1586     {
1587         // insert code to load formats here
1588     }
1589     {
1590         // insert code to load summaries here
1591         m_hardcoded_summaries.push_back(
1592                                         [](lldb_private::ValueObject& valobj,
1593                                             lldb::DynamicValueType,
1594                                             FormatManager&) -> TypeSummaryImpl::SharedPointer {
1595                                             static CXXFunctionSummaryFormat::SharedPointer formatter_sp(new CXXFunctionSummaryFormat(TypeSummaryImpl::Flags(), lldb_private::formatters::FunctionPointerSummaryProvider, "Function pointer summary provider"));
1596                                             if (valobj.GetClangType().IsFunctionPointerType())
1597                                             {
1598                                                 return formatter_sp;
1599                                             }
1600                                             return nullptr;
1601                                         });
1602     }
1603     {
1604         // insert code to load synthetics here
1605         m_hardcoded_synthetics.push_back(
1606                                          [](lldb_private::ValueObject& valobj,
1607                                             lldb::DynamicValueType,
1608                                             FormatManager& fmt_mgr) -> SyntheticChildren::SharedPointer {
1609                                              static CXXSyntheticChildren::SharedPointer formatter_sp(new CXXSyntheticChildren(SyntheticChildren::Flags().SetCascades(true).SetSkipPointers(true).SetSkipReferences(true),
1610                                                                                                                               "vector_type synthetic children",
1611                                                                                                                               lldb_private::formatters::VectorTypeSyntheticFrontEndCreator));
1612                                              if (valobj.GetClangType().IsVectorType(nullptr, nullptr))
1613                                              {
1614                                                  if (fmt_mgr.GetCategory(fmt_mgr.m_vectortypes_category_name)->IsEnabled())
1615                                                      return formatter_sp;
1616                                              }
1617                                              return nullptr;
1618                                          });
1619     }
1620     {
1621         // insert code to load validators here
1622     }
1623 }
1624