1 //===-- ObjCLanguage.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 "ObjCLanguage.h"
11 
12 #include <mutex>
13 
14 #include "lldb/Core/ConstString.h"
15 #include "lldb/Core/PluginManager.h"
16 #include "lldb/Core/StreamString.h"
17 #include "lldb/Core/ValueObject.h"
18 #include "lldb/DataFormatters/DataVisualization.h"
19 #include "lldb/DataFormatters/FormattersHelpers.h"
20 #include "lldb/Symbol/CompilerType.h"
21 #include "lldb/Target/ObjCLanguageRuntime.h"
22 
23 #include "CF.h"
24 #include "Cocoa.h"
25 #include "CoreMedia.h"
26 #include "NSDictionary.h"
27 #include "NSSet.h"
28 #include "NSString.h"
29 
30 using namespace lldb;
31 using namespace lldb_private;
32 using namespace lldb_private::formatters;
33 
34 void
35 ObjCLanguage::Initialize()
36 {
37     PluginManager::RegisterPlugin (GetPluginNameStatic(),
38                                    "Objective-C Language",
39                                    CreateInstance);
40 }
41 
42 void
43 ObjCLanguage::Terminate()
44 {
45     PluginManager::UnregisterPlugin (CreateInstance);
46 }
47 
48 lldb_private::ConstString
49 ObjCLanguage::GetPluginNameStatic()
50 {
51     static ConstString g_name("objc");
52     return g_name;
53 }
54 
55 
56 //------------------------------------------------------------------
57 // PluginInterface protocol
58 //------------------------------------------------------------------
59 lldb_private::ConstString
60 ObjCLanguage::GetPluginName()
61 {
62     return GetPluginNameStatic();
63 }
64 
65 uint32_t
66 ObjCLanguage::GetPluginVersion()
67 {
68     return 1;
69 }
70 
71 //------------------------------------------------------------------
72 // Static Functions
73 //------------------------------------------------------------------
74 Language *
75 ObjCLanguage::CreateInstance (lldb::LanguageType language)
76 {
77     switch (language)
78     {
79         case lldb::eLanguageTypeObjC:
80             return new ObjCLanguage();
81         default:
82             return nullptr;
83     }
84 }
85 
86 void
87 ObjCLanguage::MethodName::Clear()
88 {
89     m_full.Clear();
90     m_class.Clear();
91     m_category.Clear();
92     m_selector.Clear();
93     m_type = eTypeUnspecified;
94     m_category_is_valid = false;
95 }
96 
97 bool
98 ObjCLanguage::MethodName::SetName (const char *name, bool strict)
99 {
100     Clear();
101     if (name && name[0])
102     {
103         // If "strict" is true. then the method must be specified with a
104         // '+' or '-' at the beginning. If "strict" is false, then the '+'
105         // or '-' can be omitted
106         bool valid_prefix = false;
107 
108         if (name[0] == '+' || name[0] == '-')
109         {
110             valid_prefix = name[1] == '[';
111             if (name[0] == '+')
112                 m_type = eTypeClassMethod;
113             else
114                 m_type = eTypeInstanceMethod;
115         }
116         else if (!strict)
117         {
118             // "strict" is false, the name just needs to start with '['
119             valid_prefix = name[0] == '[';
120         }
121 
122         if (valid_prefix)
123         {
124             int name_len = strlen (name);
125             // Objective C methods must have at least:
126             //      "-[" or "+[" prefix
127             //      One character for a class name
128             //      One character for the space between the class name
129             //      One character for the method name
130             //      "]" suffix
131             if (name_len >= (5 + (strict ? 1 : 0)) && name[name_len - 1] == ']')
132             {
133                 m_full.SetCStringWithLength(name, name_len);
134             }
135         }
136     }
137     return IsValid(strict);
138 }
139 
140 const ConstString &
141 ObjCLanguage::MethodName::GetClassName ()
142 {
143     if (!m_class)
144     {
145         if (IsValid(false))
146         {
147             const char *full = m_full.GetCString();
148             const char *class_start = (full[0] == '[' ? full + 1 : full + 2);
149             const char *paren_pos = strchr (class_start, '(');
150             if (paren_pos)
151             {
152                 m_class.SetCStringWithLength (class_start, paren_pos - class_start);
153             }
154             else
155             {
156                 // No '(' was found in the full name, we can definitively say
157                 // that our category was valid (and empty).
158                 m_category_is_valid = true;
159                 const char *space_pos = strchr (full, ' ');
160                 if (space_pos)
161                 {
162                     m_class.SetCStringWithLength (class_start, space_pos - class_start);
163                     if (!m_class_category)
164                     {
165                         // No category in name, so we can also fill in the m_class_category
166                         m_class_category = m_class;
167                     }
168                 }
169             }
170         }
171     }
172     return m_class;
173 }
174 
175 const ConstString &
176 ObjCLanguage::MethodName::GetClassNameWithCategory ()
177 {
178     if (!m_class_category)
179     {
180         if (IsValid(false))
181         {
182             const char *full = m_full.GetCString();
183             const char *class_start = (full[0] == '[' ? full + 1 : full + 2);
184             const char *space_pos = strchr (full, ' ');
185             if (space_pos)
186             {
187                 m_class_category.SetCStringWithLength (class_start, space_pos - class_start);
188                 // If m_class hasn't been filled in and the class with category doesn't
189                 // contain a '(', then we can also fill in the m_class
190                 if (!m_class && strchr (m_class_category.GetCString(), '(') == NULL)
191                 {
192                     m_class = m_class_category;
193                     // No '(' was found in the full name, we can definitively say
194                     // that our category was valid (and empty).
195                     m_category_is_valid = true;
196 
197                 }
198             }
199         }
200     }
201     return m_class_category;
202 }
203 
204 const ConstString &
205 ObjCLanguage::MethodName::GetSelector ()
206 {
207     if (!m_selector)
208     {
209         if (IsValid(false))
210         {
211             const char *full = m_full.GetCString();
212             const char *space_pos = strchr (full, ' ');
213             if (space_pos)
214             {
215                 ++space_pos; // skip the space
216                 m_selector.SetCStringWithLength (space_pos, m_full.GetLength() - (space_pos - full) - 1);
217             }
218         }
219     }
220     return m_selector;
221 }
222 
223 const ConstString &
224 ObjCLanguage::MethodName::GetCategory ()
225 {
226     if (!m_category_is_valid && !m_category)
227     {
228         if (IsValid(false))
229         {
230             m_category_is_valid = true;
231             const char *full = m_full.GetCString();
232             const char *class_start = (full[0] == '[' ? full + 1 : full + 2);
233             const char *open_paren_pos = strchr (class_start, '(');
234             if (open_paren_pos)
235             {
236                 ++open_paren_pos; // Skip the open paren
237                 const char *close_paren_pos = strchr (open_paren_pos, ')');
238                 if (close_paren_pos)
239                     m_category.SetCStringWithLength (open_paren_pos, close_paren_pos - open_paren_pos);
240             }
241         }
242     }
243     return m_category;
244 }
245 
246 ConstString
247 ObjCLanguage::MethodName::GetFullNameWithoutCategory (bool empty_if_no_category)
248 {
249     if (IsValid(false))
250     {
251         if (HasCategory())
252         {
253             StreamString strm;
254             if (m_type == eTypeClassMethod)
255                 strm.PutChar('+');
256             else if (m_type == eTypeInstanceMethod)
257                 strm.PutChar('-');
258             strm.Printf("[%s %s]", GetClassName().GetCString(), GetSelector().GetCString());
259             return ConstString(strm.GetString().c_str());
260         }
261 
262         if (!empty_if_no_category)
263         {
264             // Just return the full name since it doesn't have a category
265             return GetFullName();
266         }
267     }
268     return ConstString();
269 }
270 
271 size_t
272 ObjCLanguage::MethodName::GetFullNames (std::vector<ConstString> &names, bool append)
273 {
274     if (!append)
275         names.clear();
276     if (IsValid(false))
277     {
278         StreamString strm;
279         const bool is_class_method = m_type == eTypeClassMethod;
280         const bool is_instance_method = m_type == eTypeInstanceMethod;
281         const ConstString &category = GetCategory();
282         if (is_class_method || is_instance_method)
283         {
284             names.push_back (m_full);
285             if (category)
286             {
287                 strm.Printf("%c[%s %s]",
288                             is_class_method ? '+' : '-',
289                             GetClassName().GetCString(),
290                             GetSelector().GetCString());
291                 names.push_back(ConstString(strm.GetString().c_str()));
292             }
293         }
294         else
295         {
296             const ConstString &class_name = GetClassName();
297             const ConstString &selector = GetSelector();
298             strm.Printf("+[%s %s]", class_name.GetCString(), selector.GetCString());
299             names.push_back(ConstString(strm.GetString().c_str()));
300             strm.Clear();
301             strm.Printf("-[%s %s]", class_name.GetCString(), selector.GetCString());
302             names.push_back(ConstString(strm.GetString().c_str()));
303             strm.Clear();
304             if (category)
305             {
306                 strm.Printf("+[%s(%s) %s]", class_name.GetCString(), category.GetCString(), selector.GetCString());
307                 names.push_back(ConstString(strm.GetString().c_str()));
308                 strm.Clear();
309                 strm.Printf("-[%s(%s) %s]", class_name.GetCString(), category.GetCString(), selector.GetCString());
310                 names.push_back(ConstString(strm.GetString().c_str()));
311             }
312         }
313     }
314     return names.size();
315 }
316 
317 static void
318 LoadObjCFormatters(TypeCategoryImplSP objc_category_sp)
319 {
320     if (!objc_category_sp)
321         return;
322 
323     TypeSummaryImpl::Flags objc_flags;
324     objc_flags.SetCascades(false)
325     .SetSkipPointers(true)
326     .SetSkipReferences(true)
327     .SetDontShowChildren(true)
328     .SetDontShowValue(true)
329     .SetShowMembersOneLiner(false)
330     .SetHideItemNames(false);
331 
332     lldb::TypeSummaryImplSP ObjC_BOOL_summary(new CXXFunctionSummaryFormat(objc_flags, lldb_private::formatters::ObjCBOOLSummaryProvider,""));
333     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL"),
334                                                        ObjC_BOOL_summary);
335     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL &"),
336                                                        ObjC_BOOL_summary);
337     objc_category_sp->GetTypeSummariesContainer()->Add(ConstString("BOOL *"),
338                                                        ObjC_BOOL_summary);
339 
340 #ifndef LLDB_DISABLE_PYTHON
341     // we need to skip pointers here since we are special casing a SEL* when retrieving its value
342     objc_flags.SetSkipPointers(true);
343     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("SEL"), objc_flags);
344     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("struct objc_selector"), objc_flags);
345     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<false>, "SEL summary provider", ConstString("objc_selector"), objc_flags);
346     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<true>, "SEL summary provider", ConstString("objc_selector *"), objc_flags);
347     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCSELSummaryProvider<true>, "SEL summary provider", ConstString("SEL *"), objc_flags);
348 
349     AddCXXSummary(objc_category_sp, lldb_private::formatters::ObjCClassSummaryProvider, "Class summary provider", ConstString("Class"), objc_flags);
350 
351     SyntheticChildren::Flags class_synth_flags;
352     class_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(false);
353 
354     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::ObjCClassSyntheticFrontEndCreator, "Class synthetic children", ConstString("Class"), class_synth_flags);
355 #endif // LLDB_DISABLE_PYTHON
356 
357     objc_flags.SetSkipPointers(false);
358     objc_flags.SetCascades(true);
359     objc_flags.SetSkipReferences(false);
360 
361     AddStringSummary (objc_category_sp,
362                       "${var.__FuncPtr%A}",
363                       ConstString("__block_literal_generic"),
364                       objc_flags);
365 
366     AddStringSummary(objc_category_sp,
367                      "${var.years} years, ${var.months} months, ${var.days} days, ${var.hours} hours, ${var.minutes} minutes ${var.seconds} seconds",
368                      ConstString("CFGregorianUnits"),
369                      objc_flags);
370     AddStringSummary(objc_category_sp,
371                      "location=${var.location} length=${var.length}",
372                      ConstString("CFRange"),
373                      objc_flags);
374 
375     AddStringSummary(objc_category_sp,
376                      "location=${var.location}, length=${var.length}",
377                      ConstString("NSRange"),
378                      objc_flags);
379     AddStringSummary(objc_category_sp,
380                      "(${var.origin}, ${var.size}), ...",
381                      ConstString("NSRectArray"),
382                      objc_flags);
383 
384     AddOneLineSummary (objc_category_sp,
385                        ConstString("NSPoint"),
386                        objc_flags);
387     AddOneLineSummary (objc_category_sp,
388                        ConstString("NSSize"),
389                        objc_flags);
390     AddOneLineSummary (objc_category_sp,
391                        ConstString("NSRect"),
392                        objc_flags);
393 
394     AddOneLineSummary (objc_category_sp,
395                        ConstString("CGSize"),
396                        objc_flags);
397     AddOneLineSummary (objc_category_sp,
398                        ConstString("CGPoint"),
399                        objc_flags);
400     AddOneLineSummary (objc_category_sp,
401                        ConstString("CGRect"),
402                        objc_flags);
403 
404     AddStringSummary(objc_category_sp,
405                      "red=${var.red} green=${var.green} blue=${var.blue}",
406                      ConstString("RGBColor"),
407                      objc_flags);
408     AddStringSummary(objc_category_sp,
409                      "(t=${var.top}, l=${var.left}, b=${var.bottom}, r=${var.right})",
410                      ConstString("Rect"),
411                      objc_flags);
412     AddStringSummary(objc_category_sp,
413                      "(v=${var.v}, h=${var.h})",
414                      ConstString("Point"),
415                      objc_flags);
416     AddStringSummary(objc_category_sp,
417                      "${var.month}/${var.day}/${var.year}  ${var.hour} :${var.minute} :${var.second} dayOfWeek:${var.dayOfWeek}",
418                      ConstString("DateTimeRect *"),
419                      objc_flags);
420     AddStringSummary(objc_category_sp,
421                      "${var.ld.month}/${var.ld.day}/${var.ld.year} ${var.ld.hour} :${var.ld.minute} :${var.ld.second} dayOfWeek:${var.ld.dayOfWeek}",
422                      ConstString("LongDateRect"),
423                      objc_flags);
424     AddStringSummary(objc_category_sp,
425                      "(x=${var.x}, y=${var.y})",
426                      ConstString("HIPoint"),
427                      objc_flags);
428     AddStringSummary(objc_category_sp,
429                      "origin=${var.origin} size=${var.size}",
430                      ConstString("HIRect"),
431                      objc_flags);
432 
433     TypeSummaryImpl::Flags appkit_flags;
434     appkit_flags.SetCascades(true)
435     .SetSkipPointers(false)
436     .SetSkipReferences(false)
437     .SetDontShowChildren(true)
438     .SetDontShowValue(false)
439     .SetShowMembersOneLiner(false)
440     .SetHideItemNames(false);
441 
442     appkit_flags.SetDontShowChildren(false);
443 
444 
445 #ifndef LLDB_DISABLE_PYTHON
446     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("NSArray"), appkit_flags);
447     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("NSMutableArray"), appkit_flags);
448     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSArrayI"), appkit_flags);
449     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSArray0"), appkit_flags);
450     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSArrayM"), appkit_flags);
451     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("__NSCFArray"), appkit_flags);
452     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("CFArrayRef"), appkit_flags);
453     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSArraySummaryProvider, "NSArray summary provider", ConstString("CFMutableArrayRef"), appkit_flags);
454 
455     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("NSDictionary"), appkit_flags);
456     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("NSMutableDictionary"), appkit_flags);
457     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSCFDictionary"), appkit_flags);
458     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSDictionaryI"), appkit_flags);
459     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<false>, "NSDictionary summary provider", ConstString("__NSDictionaryM"), appkit_flags);
460     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<true>, "NSDictionary summary provider", ConstString("CFDictionaryRef"), appkit_flags);
461     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDictionarySummaryProvider<true>, "NSDictionary summary provider", ConstString("CFMutableDictionaryRef"), appkit_flags);
462 
463     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSSet summary", ConstString("NSSet"), appkit_flags);
464     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSMutableSet summary", ConstString("NSMutableSet"), appkit_flags);
465     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<true>, "CFSetRef summary", ConstString("CFSetRef"), appkit_flags);
466     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<true>, "CFMutableSetRef summary", ConstString("CFMutableSetRef"), appkit_flags);
467     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSCFSet summary", ConstString("__NSCFSet"), appkit_flags);
468     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSSetI summary", ConstString("__NSSetI"), appkit_flags);
469     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSSetM summary", ConstString("__NSSetM"), appkit_flags);
470     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSCountedSet summary", ConstString("NSCountedSet"), appkit_flags);
471     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSMutableSet summary", ConstString("NSMutableSet"), appkit_flags);
472     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "NSOrderedSet summary", ConstString("NSOrderedSet"), appkit_flags);
473     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSOrderedSetI summary", ConstString("__NSOrderedSetI"), appkit_flags);
474     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSSetSummaryProvider<false>, "__NSOrderedSetM summary", ConstString("__NSOrderedSetM"), appkit_flags);
475 
476     // AddSummary(appkit_category_sp, "${var.key%@} -> ${var.value%@}", ConstString("$_lldb_typegen_nspair"), appkit_flags);
477 
478     appkit_flags.SetDontShowChildren(true);
479 
480     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSArrayM"), ScriptedSyntheticChildren::Flags());
481     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSArrayI"), ScriptedSyntheticChildren::Flags());
482     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSArray0"), ScriptedSyntheticChildren::Flags());
483     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("NSArray"), ScriptedSyntheticChildren::Flags());
484     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("NSMutableArray"), ScriptedSyntheticChildren::Flags());
485     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("__NSCFArray"), ScriptedSyntheticChildren::Flags());
486     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("CFMutableArrayRef"), ScriptedSyntheticChildren::Flags());
487     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSArraySyntheticFrontEndCreator, "NSArray synthetic children", ConstString("CFArrayRef"), ScriptedSyntheticChildren::Flags());
488 
489     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSDictionaryM"), ScriptedSyntheticChildren::Flags());
490     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSDictionaryI"), ScriptedSyntheticChildren::Flags());
491     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("__NSCFDictionary"), ScriptedSyntheticChildren::Flags());
492     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("NSDictionary"), ScriptedSyntheticChildren::Flags());
493     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("NSMutableDictionary"), ScriptedSyntheticChildren::Flags());
494     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("CFDictionaryRef"), ScriptedSyntheticChildren::Flags());
495     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSDictionarySyntheticFrontEndCreator, "NSDictionary synthetic children", ConstString("CFMutableDictionaryRef"), ScriptedSyntheticChildren::Flags());
496 
497     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSSet synthetic children", ConstString("NSSet"), ScriptedSyntheticChildren::Flags());
498     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSSetI synthetic children", ConstString("__NSSetI"), ScriptedSyntheticChildren::Flags());
499     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSSetM synthetic children", ConstString("__NSSetM"), ScriptedSyntheticChildren::Flags());
500     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSMutableSet synthetic children", ConstString("NSMutableSet"), ScriptedSyntheticChildren::Flags());
501     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "NSOrderedSet synthetic children", ConstString("NSOrderedSet"), ScriptedSyntheticChildren::Flags());
502     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSOrderedSetI synthetic children", ConstString("__NSOrderedSetI"), ScriptedSyntheticChildren::Flags());
503     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSSetSyntheticFrontEndCreator, "__NSOrderedSetM synthetic children", ConstString("__NSOrderedSetM"), ScriptedSyntheticChildren::Flags());
504 
505     AddCXXSynthetic(objc_category_sp, lldb_private::formatters::NSIndexPathSyntheticFrontEndCreator, "NSIndexPath synthetic children", ConstString("NSIndexPath"), ScriptedSyntheticChildren::Flags());
506 
507     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("CFBagRef"), appkit_flags);
508     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("__CFBag"), appkit_flags);
509     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("const struct __CFBag"), appkit_flags);
510     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBagSummaryProvider, "CFBag summary provider", ConstString("CFMutableBagRef"), appkit_flags);
511 
512     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBinaryHeapSummaryProvider, "CFBinaryHeap summary provider", ConstString("CFBinaryHeapRef"), appkit_flags);
513     AddCXXSummary(objc_category_sp,lldb_private::formatters::CFBinaryHeapSummaryProvider, "CFBinaryHeap summary provider", ConstString("__CFBinaryHeap"), appkit_flags);
514 
515     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSString"), appkit_flags);
516     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("CFStringRef"), appkit_flags);
517     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__CFString"), appkit_flags);
518     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("CFMutableStringRef"), appkit_flags);
519     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSMutableString"), appkit_flags);
520     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__NSCFConstantString"), appkit_flags);
521     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("__NSCFString"), appkit_flags);
522     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSCFConstantString"), appkit_flags);
523     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSCFString"), appkit_flags);
524     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSStringSummaryProvider, "NSString summary provider", ConstString("NSPathStore2"), appkit_flags);
525 
526     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSAttributedStringSummaryProvider, "NSAttributedString summary provider", ConstString("NSAttributedString"), appkit_flags);
527     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSMutableAttributedStringSummaryProvider, "NSMutableAttributedString summary provider", ConstString("NSMutableAttributedString"), appkit_flags);
528     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSMutableAttributedStringSummaryProvider, "NSMutableAttributedString summary provider", ConstString("NSConcreteMutableAttributedString"), appkit_flags);
529 
530     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSBundleSummaryProvider, "NSBundle summary provider", ConstString("NSBundle"), appkit_flags);
531 
532     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSData"), appkit_flags);
533     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSConcreteData"), appkit_flags);
534     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSConcreteMutableData"), appkit_flags);
535     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("NSMutableData"), appkit_flags);
536     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<false>, "NSData summary provider", ConstString("__NSCFData"), appkit_flags);
537     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<true>, "NSData summary provider", ConstString("CFDataRef"), appkit_flags);
538     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDataSummaryProvider<true>, "NSData summary provider", ConstString("CFMutableDataRef"), appkit_flags);
539 
540     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSMachPortSummaryProvider, "NSMachPort summary provider", ConstString("NSMachPort"), appkit_flags);
541 
542     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNotificationSummaryProvider, "NSNotification summary provider", ConstString("NSNotification"), appkit_flags);
543     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNotificationSummaryProvider, "NSNotification summary provider", ConstString("NSConcreteNotification"), appkit_flags);
544 
545     AddStringSummary(objc_category_sp, "domain: ${var._domain} - code: ${var._code}", ConstString("NSError"), appkit_flags);
546     AddStringSummary(objc_category_sp,"name:${var.name%S} reason:${var.reason%S}",ConstString("NSException"),appkit_flags);
547 
548     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSNumber"), appkit_flags);
549     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "CFNumberRef summary provider", ConstString("CFNumberRef"), appkit_flags);
550     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("__NSCFBoolean"), appkit_flags);
551     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("__NSCFNumber"), appkit_flags);
552     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSCFBoolean"), appkit_flags);
553     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSNumberSummaryProvider, "NSNumber summary provider", ConstString("NSCFNumber"), appkit_flags);
554 
555     AddCXXSummary(objc_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSDecimalNumber summary provider", ConstString("NSDecimalNumber"), appkit_flags);
556     AddCXXSummary(objc_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSHost summary provider", ConstString("NSHost"), appkit_flags);
557     AddCXXSummary(objc_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSTask summary provider", ConstString("NSTask"), appkit_flags);
558     AddCXXSummary(objc_category_sp, lldb_private::formatters::RuntimeSpecificDescriptionSummaryProvider, "NSValue summary provider", ConstString("NSValue"), appkit_flags);
559 
560     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSURLSummaryProvider, "NSURL summary provider", ConstString("NSURL"), appkit_flags);
561     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSURLSummaryProvider, "NSURL summary provider", ConstString("CFURLRef"), appkit_flags);
562 
563     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("NSDate"), appkit_flags);
564     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("__NSDate"), appkit_flags);
565     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("__NSTaggedDate"), appkit_flags);
566     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSDateSummaryProvider, "NSDate summary provider", ConstString("NSCalendarDate"), appkit_flags);
567 
568     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("NSTimeZone"), appkit_flags);
569     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("CFTimeZoneRef"), appkit_flags);
570     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSTimeZoneSummaryProvider, "NSTimeZone summary provider", ConstString("__NSTimeZone"), appkit_flags);
571 
572     // CFAbsoluteTime is actually a double rather than a pointer to an object
573     // we do not care about the numeric value, since it is probably meaningless to users
574     appkit_flags.SetDontShowValue(true);
575     AddCXXSummary(objc_category_sp, lldb_private::formatters::CFAbsoluteTimeSummaryProvider, "CFAbsoluteTime summary provider", ConstString("CFAbsoluteTime"), appkit_flags);
576     appkit_flags.SetDontShowValue(false);
577 
578     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSIndexSetSummaryProvider, "NSIndexSet summary provider", ConstString("NSIndexSet"), appkit_flags);
579     AddCXXSummary(objc_category_sp, lldb_private::formatters::NSIndexSetSummaryProvider, "NSIndexSet summary provider", ConstString("NSMutableIndexSet"), appkit_flags);
580 
581     AddStringSummary(objc_category_sp,
582                      "@\"${var.month%d}/${var.day%d}/${var.year%d} ${var.hour%d}:${var.minute%d}:${var.second}\"",
583                      ConstString("CFGregorianDate"),
584                      appkit_flags);
585 
586     AddCXXSummary(objc_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("CFBitVectorRef"), appkit_flags);
587     AddCXXSummary(objc_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("CFMutableBitVectorRef"), appkit_flags);
588     AddCXXSummary(objc_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("__CFBitVector"), appkit_flags);
589     AddCXXSummary(objc_category_sp, lldb_private::formatters::CFBitVectorSummaryProvider, "CFBitVector summary provider", ConstString("__CFMutableBitVector"), appkit_flags);
590 #endif // LLDB_DISABLE_PYTHON
591 }
592 
593 static void
594 LoadCoreMediaFormatters(TypeCategoryImplSP objc_category_sp)
595 {
596     if (!objc_category_sp)
597         return;
598 
599     TypeSummaryImpl::Flags cm_flags;
600     cm_flags.SetCascades(true)
601     .SetDontShowChildren(false)
602     .SetDontShowValue(false)
603     .SetHideItemNames(false)
604     .SetShowMembersOneLiner(false)
605     .SetSkipPointers(false)
606     .SetSkipReferences(false);
607 
608 #ifndef LLDB_DISABLE_PYTHON
609     AddCXXSummary(objc_category_sp, lldb_private::formatters::CMTimeSummaryProvider, "CMTime summary provider", ConstString("CMTime"), cm_flags);
610 #endif // LLDB_DISABLE_PYTHON
611 }
612 
613 
614 lldb::TypeCategoryImplSP
615 ObjCLanguage::GetFormatters ()
616 {
617     static std::once_flag g_initialize;
618     static TypeCategoryImplSP g_category;
619 
620     std::call_once(g_initialize, [this] () -> void {
621         DataVisualization::Categories::GetCategory(GetPluginName(), g_category);
622         if (g_category)
623         {
624             LoadCoreMediaFormatters(g_category);
625             LoadObjCFormatters(g_category);
626         }
627     });
628     return g_category;
629 }
630 
631 std::vector<ConstString>
632 ObjCLanguage::GetPossibleFormattersMatches (ValueObject& valobj, lldb::DynamicValueType use_dynamic)
633 {
634     std::vector<ConstString> result;
635 
636     if (use_dynamic == lldb::eNoDynamicValues)
637         return result;
638 
639     CompilerType compiler_type(valobj.GetCompilerType());
640 
641     const bool check_cpp = false;
642     const bool check_objc = true;
643     bool canBeObjCDynamic = compiler_type.IsPossibleDynamicType(nullptr, check_cpp, check_objc);
644 
645     if (canBeObjCDynamic)
646     {
647         do {
648             lldb::ProcessSP process_sp = valobj.GetProcessSP();
649             if (!process_sp)
650                 break;
651             ObjCLanguageRuntime* runtime = process_sp->GetObjCLanguageRuntime();
652             if (runtime == nullptr)
653                 break;
654             ObjCLanguageRuntime::ClassDescriptorSP objc_class_sp (runtime->GetClassDescriptor(valobj));
655             if (!objc_class_sp)
656                 break;
657             if (ConstString name = objc_class_sp->GetClassName())
658                 result.push_back(name);
659         } while (false);
660     }
661 
662     return result;
663 }
664 
665 std::unique_ptr<Language::TypeScavenger>
666 ObjCLanguage::GetTypeScavenger ()
667 {
668     class ObjCTypeScavenger : public Language::TypeScavenger
669     {
670     private:
671         class ObjCScavengerResult : public Language::TypeScavenger::Result
672         {
673         public:
674             ObjCScavengerResult (CompilerType type) :
675                 Language::TypeScavenger::Result(),
676                 m_compiler_type(type)
677             {
678             }
679 
680             bool
681             IsValid () override
682             {
683                 return m_compiler_type.IsValid();
684             }
685 
686             bool
687             DumpToStream (Stream& stream,
688                           bool print_help_if_available) override
689             {
690                 if (IsValid())
691                 {
692                     m_compiler_type.DumpTypeDescription(&stream);
693                     stream.EOL();
694                     return true;
695                 }
696                 return false;
697             }
698 
699             virtual ~ObjCScavengerResult() = default;
700         private:
701             CompilerType m_compiler_type;
702         };
703 
704     protected:
705         ObjCTypeScavenger() = default;
706 
707         virtual ~ObjCTypeScavenger() = default;
708 
709         bool
710         Find_Impl (ExecutionContextScope *exe_scope,
711                    const char *key,
712                    ResultSet &results) override
713         {
714             bool result = false;
715 
716             Target* target = exe_scope->CalculateTarget().get();
717             if (target)
718             {
719                 if (auto clang_modules_decl_vendor = target->GetClangModulesDeclVendor())
720                 {
721                     std::vector <clang::NamedDecl*> decls;
722                     ConstString key_cs(key);
723 
724                     if (clang_modules_decl_vendor->FindDecls(key_cs, false, UINT32_MAX, decls) > 0 &&
725                         decls.size() > 0)
726                     {
727                         CompilerType module_type = ClangASTContext::GetTypeForDecl(decls.front());
728                         result = true;
729                         std::unique_ptr<Language::TypeScavenger::Result> result(new ObjCScavengerResult(module_type));
730                         results.insert(std::move(result));
731                     }
732                 }
733             }
734 
735             if (!result)
736             {
737                 Process* process = exe_scope->CalculateProcess().get();
738                 if (process)
739                 {
740                     const bool create_on_demand = false;
741                     auto objc_runtime = process->GetObjCLanguageRuntime(create_on_demand);
742                     if (objc_runtime)
743                     {
744                         auto decl_vendor = objc_runtime->GetDeclVendor();
745                         if (decl_vendor)
746                         {
747                             std::vector<clang::NamedDecl *> decls;
748                             ConstString name(key);
749                             decl_vendor->FindDecls(name, true, UINT32_MAX, decls);
750                             for (auto decl : decls)
751                             {
752                                 if (decl)
753                                 {
754                                     if (CompilerType candidate = ClangASTContext::GetTypeForDecl(decl))
755                                     {
756                                         result = true;
757                                         std::unique_ptr<Language::TypeScavenger::Result> result(new ObjCScavengerResult(candidate));
758                                         results.insert(std::move(result));
759                                     }
760                                 }
761                             }
762                         }
763                     }
764                 }
765             }
766 
767             return result;
768         }
769 
770         friend class lldb_private::ObjCLanguage;
771     };
772 
773     return std::unique_ptr<TypeScavenger>(new ObjCTypeScavenger());
774 }
775 
776 bool
777 ObjCLanguage::GetFormatterPrefixSuffix (ValueObject& valobj, ConstString type_hint,
778                                         std::string& prefix, std::string& suffix)
779 {
780     static ConstString g_CFBag("CFBag");
781     static ConstString g_CFBinaryHeap("CFBinaryHeap");
782 
783     static ConstString g_NSNumberChar("NSNumber:char");
784     static ConstString g_NSNumberShort("NSNumber:short");
785     static ConstString g_NSNumberInt("NSNumber:int");
786     static ConstString g_NSNumberLong("NSNumber:long");
787     static ConstString g_NSNumberFloat("NSNumber:float");
788     static ConstString g_NSNumberDouble("NSNumber:double");
789 
790     static ConstString g_NSData("NSData");
791     static ConstString g_NSArray("NSArray");
792     static ConstString g_NSString("NSString");
793     static ConstString g_NSStringStar("NSString*");
794 
795     if (type_hint.IsEmpty())
796         return false;
797 
798     prefix.clear();
799     suffix.clear();
800 
801     if (type_hint == g_CFBag ||
802         type_hint == g_CFBinaryHeap)
803     {
804         prefix = "@";
805         return true;
806     }
807 
808     if (type_hint == g_NSNumberChar)
809     {
810         prefix = "(char)";
811         return true;
812     }
813     if (type_hint == g_NSNumberShort)
814     {
815         prefix = "(short)";
816         return true;
817     }
818     if (type_hint == g_NSNumberInt)
819     {
820         prefix = "(int)";
821         return true;
822     }
823     if (type_hint == g_NSNumberLong)
824     {
825         prefix = "(long)";
826         return true;
827     }
828     if (type_hint == g_NSNumberFloat)
829     {
830         prefix = "(float)";
831         return true;
832     }
833     if (type_hint == g_NSNumberDouble)
834     {
835         prefix = "(double)";
836         return true;
837     }
838 
839     if (type_hint == g_NSData ||
840         type_hint == g_NSArray)
841     {
842         prefix = "@\"";
843         suffix = "\"";
844         return true;
845     }
846 
847     if (type_hint == g_NSString ||
848         type_hint == g_NSStringStar)
849     {
850         prefix = "@";
851         return true;
852     }
853 
854     return false;
855 }
856