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