1 //===-- Cocoa.cpp -------------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
12 #include "lldb/DataFormatters/CXXFormatterFunctions.h"
14 #include "lldb/Core/DataBufferHeap.h"
15 #include "lldb/Core/Error.h"
16 #include "lldb/Core/Stream.h"
17 #include "lldb/Core/ValueObject.h"
18 #include "lldb/Core/ValueObjectConstResult.h"
19 #include "lldb/Host/Endian.h"
20 #include "lldb/Symbol/ClangASTContext.h"
21 #include "lldb/Target/ObjCLanguageRuntime.h"
22 #include "lldb/Target/Target.h"
25 using namespace lldb_private;
26 using namespace lldb_private::formatters;
29 lldb_private::formatters::NSBundleSummaryProvider (ValueObject& valobj, Stream& stream)
31 ProcessSP process_sp = valobj.GetProcessSP();
35 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
40 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
42 if (!descriptor.get() || !descriptor->IsValid())
45 uint32_t ptr_size = process_sp->GetAddressByteSize();
47 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
52 const char* class_name = descriptor->GetClassName().GetCString();
54 if (!class_name || !*class_name)
57 if (!strcmp(class_name,"NSBundle"))
59 uint64_t offset = 5 * ptr_size;
60 ValueObjectSP text(valobj.GetSyntheticChildAtOffset(offset, valobj.GetClangType().GetBasicTypeFromAST(lldb::eBasicTypeObjCID), true));
62 StreamString summary_stream;
63 bool was_nsstring_ok = NSStringSummaryProvider(*text.get(), summary_stream);
64 if (was_nsstring_ok && summary_stream.GetSize() > 0)
66 stream.Printf("%s",summary_stream.GetData());
70 // this is either an unknown subclass or an NSBundle that comes from [NSBundle mainBundle]
71 // which is encoded differently and needs to be handled by running code
72 return ExtractSummaryFromObjCExpression(valobj, "NSString*", "bundlePath", stream);
76 lldb_private::formatters::NSTimeZoneSummaryProvider (ValueObject& valobj, Stream& stream)
78 ProcessSP process_sp = valobj.GetProcessSP();
82 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
87 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
89 if (!descriptor.get() || !descriptor->IsValid())
92 uint32_t ptr_size = process_sp->GetAddressByteSize();
94 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
99 const char* class_name = descriptor->GetClassName().GetCString();
101 if (!class_name || !*class_name)
104 if (!strcmp(class_name,"__NSTimeZone"))
106 uint64_t offset = ptr_size;
107 ValueObjectSP text(valobj.GetSyntheticChildAtOffset(offset, valobj.GetClangType(), true));
108 StreamString summary_stream;
109 bool was_nsstring_ok = NSStringSummaryProvider(*text.get(), summary_stream);
110 if (was_nsstring_ok && summary_stream.GetSize() > 0)
112 stream.Printf("%s",summary_stream.GetData());
116 return ExtractSummaryFromObjCExpression(valobj, "NSString*", "name", stream);
120 lldb_private::formatters::NSNotificationSummaryProvider (ValueObject& valobj, Stream& stream)
122 ProcessSP process_sp = valobj.GetProcessSP();
126 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
131 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
133 if (!descriptor.get() || !descriptor->IsValid())
136 uint32_t ptr_size = process_sp->GetAddressByteSize();
138 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
143 const char* class_name = descriptor->GetClassName().GetCString();
145 if (!class_name || !*class_name)
148 if (!strcmp(class_name,"NSConcreteNotification"))
150 uint64_t offset = ptr_size;
151 ValueObjectSP text(valobj.GetSyntheticChildAtOffset(offset, valobj.GetClangType(), true));
152 StreamString summary_stream;
153 bool was_nsstring_ok = NSStringSummaryProvider(*text.get(), summary_stream);
154 if (was_nsstring_ok && summary_stream.GetSize() > 0)
156 stream.Printf("%s",summary_stream.GetData());
160 // this is either an unknown subclass or an NSBundle that comes from [NSBundle mainBundle]
161 // which is encoded differently and needs to be handled by running code
162 return ExtractSummaryFromObjCExpression(valobj, "NSString*", "name", stream);
166 lldb_private::formatters::NSMachPortSummaryProvider (ValueObject& valobj, Stream& stream)
168 ProcessSP process_sp = valobj.GetProcessSP();
172 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
177 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
179 if (!descriptor.get() || !descriptor->IsValid())
182 uint32_t ptr_size = process_sp->GetAddressByteSize();
184 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
189 const char* class_name = descriptor->GetClassName().GetCString();
191 if (!class_name || !*class_name)
194 uint64_t port_number = 0;
198 if (!strcmp(class_name,"NSMachPort"))
200 uint64_t offset = (ptr_size == 4 ? 12 : 20);
202 port_number = process_sp->ReadUnsignedIntegerFromMemory(offset+valobj_addr, 4, 0, error);
206 if (!ExtractValueFromObjCExpression(valobj, "int", "machPort", port_number))
210 stream.Printf("mach port: %u",(uint32_t)(port_number & 0x00000000FFFFFFFF));
215 lldb_private::formatters::NSIndexSetSummaryProvider (ValueObject& valobj, Stream& stream)
217 ProcessSP process_sp = valobj.GetProcessSP();
221 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
226 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
228 if (!descriptor.get() || !descriptor->IsValid())
231 uint32_t ptr_size = process_sp->GetAddressByteSize();
233 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
238 const char* class_name = descriptor->GetClassName().GetCString();
240 if (!class_name || !*class_name)
246 if (!strcmp(class_name,"NSIndexSet") || !strcmp(class_name,"NSMutableIndexSet"))
249 uint32_t mode = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr+ptr_size, 4, 0, error);
252 // this means the set is empty - count = 0
259 mode = 1; // this means the set only has one range
261 mode = 2; // this means the set has multiple ranges
264 count = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr+3*ptr_size, ptr_size, 0, error);
270 // read a pointer to the data at 2*ptr_size
271 count = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr+2*ptr_size, ptr_size, 0, error);
274 // read the data at 2*ptr_size from the first location
275 count = process_sp->ReadUnsignedIntegerFromMemory(count+2*ptr_size, ptr_size, 0, error);
282 if (!ExtractValueFromObjCExpression(valobj, "unsigned long long int", "count", count))
286 stream.Printf("%" PRIu64 " index%s",
288 (count == 1 ? "" : "es"));
293 lldb_private::formatters::NSNumberSummaryProvider (ValueObject& valobj, Stream& stream)
295 ProcessSP process_sp = valobj.GetProcessSP();
299 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
304 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
306 if (!descriptor.get() || !descriptor->IsValid())
309 uint32_t ptr_size = process_sp->GetAddressByteSize();
311 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
316 const char* class_name = descriptor->GetClassName().GetCString();
318 if (!class_name || !*class_name)
321 if (!strcmp(class_name,"NSNumber") || !strcmp(class_name,"__NSCFNumber"))
325 if (descriptor->GetTaggedPointerInfo(&i_bits,&value))
330 stream.Printf("(char)%hhd",(char)value);
334 stream.Printf("(short)%hd",(short)value);
338 stream.Printf("(int)%d",(int)value);
342 stream.Printf("(long)%" PRId64,value);
345 stream.Printf("unexpected value:(info=%" PRIu64 ", value=%" PRIu64,i_bits,value);
353 uint8_t data_type = (process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + ptr_size, 1, 0, error) & 0x1F);
354 uint64_t data_location = valobj_addr + 2*ptr_size;
361 value = process_sp->ReadUnsignedIntegerFromMemory(data_location, 1, 0, error);
364 stream.Printf("(char)%hhd",(char)value);
367 value = process_sp->ReadUnsignedIntegerFromMemory(data_location, 2, 0, error);
370 stream.Printf("(short)%hd",(short)value);
373 value = process_sp->ReadUnsignedIntegerFromMemory(data_location, 4, 0, error);
376 stream.Printf("(int)%d",(int)value);
381 value = process_sp->ReadUnsignedIntegerFromMemory(data_location, 8, 0, error);
384 stream.Printf("(long)%" PRId64,value);
388 uint32_t flt_as_int = process_sp->ReadUnsignedIntegerFromMemory(data_location, 4, 0, error);
391 float flt_value = *((float*)&flt_as_int);
392 stream.Printf("(float)%f",flt_value);
397 uint64_t dbl_as_lng = process_sp->ReadUnsignedIntegerFromMemory(data_location, 8, 0, error);
400 double dbl_value = *((double*)&dbl_as_lng);
401 stream.Printf("(double)%g",dbl_value);
405 stream.Printf("unexpected value: dt=%d",data_type);
413 return ExtractSummaryFromObjCExpression(valobj, "NSString*", "stringValue", stream);
418 lldb_private::formatters::NSURLSummaryProvider (ValueObject& valobj, Stream& stream)
420 ProcessSP process_sp = valobj.GetProcessSP();
424 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
429 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
431 if (!descriptor.get() || !descriptor->IsValid())
434 uint32_t ptr_size = process_sp->GetAddressByteSize();
436 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
441 const char* class_name = descriptor->GetClassName().GetCString();
443 if (!class_name || !*class_name)
446 if (strcmp(class_name, "NSURL") == 0)
448 uint64_t offset_text = ptr_size + ptr_size + 8; // ISA + pointer + 8 bytes of data (even on 32bit)
449 uint64_t offset_base = offset_text + ptr_size;
450 ClangASTType type(valobj.GetClangType());
451 ValueObjectSP text(valobj.GetSyntheticChildAtOffset(offset_text, type, true));
452 ValueObjectSP base(valobj.GetSyntheticChildAtOffset(offset_base, type, true));
455 if (text->GetValueAsUnsigned(0) == 0)
457 StreamString summary;
458 if (!NSStringSummaryProvider(*text, summary))
460 if (base && base->GetValueAsUnsigned(0))
462 if (summary.GetSize() > 0)
463 summary.GetString().resize(summary.GetSize()-1);
464 summary.Printf(" -- ");
465 StreamString base_summary;
466 if (NSURLSummaryProvider(*base, base_summary) && base_summary.GetSize() > 0)
467 summary.Printf("%s",base_summary.GetSize() > 2 ? base_summary.GetData() + 2 : base_summary.GetData());
469 if (summary.GetSize())
471 stream.Printf("%s",summary.GetData());
477 return ExtractSummaryFromObjCExpression(valobj, "NSString*", "description", stream);
483 lldb_private::formatters::NSDateSummaryProvider (ValueObject& valobj, Stream& stream)
485 ProcessSP process_sp = valobj.GetProcessSP();
489 ObjCLanguageRuntime* runtime = (ObjCLanguageRuntime*)process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC);
494 ObjCLanguageRuntime::ClassDescriptorSP descriptor(runtime->GetClassDescriptor(valobj));
496 if (!descriptor.get() || !descriptor->IsValid())
499 uint32_t ptr_size = process_sp->GetAddressByteSize();
501 lldb::addr_t valobj_addr = valobj.GetValueAsUnsigned(0);
506 uint64_t date_value_bits = 0;
507 double date_value = 0.0;
509 const char* class_name = descriptor->GetClassName().GetCString();
511 if (!class_name || !*class_name)
514 if (strcmp(class_name,"NSDate") == 0 ||
515 strcmp(class_name,"__NSDate") == 0 ||
516 strcmp(class_name,"__NSTaggedDate") == 0)
518 uint64_t info_bits=0,value_bits = 0;
519 if (descriptor->GetTaggedPointerInfo(&info_bits,&value_bits))
521 date_value_bits = ((value_bits << 8) | (info_bits << 4));
522 date_value = *((double*)&date_value_bits);
527 date_value_bits = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr+ptr_size, 8, 0, error);
528 date_value = *((double*)&date_value_bits);
533 else if (!strcmp(class_name,"NSCalendarDate"))
536 date_value_bits = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr+2*ptr_size, 8, 0, error);
537 date_value = *((double*)&date_value_bits);
543 if (ExtractValueFromObjCExpression(valobj, "NSTimeInterval", "ExtractValueFromObjCExpression", date_value_bits) == false)
545 date_value = *((double*)&date_value_bits);
547 if (date_value == -63114076800)
549 stream.Printf("0001-12-30 00:00:00 +0000");
552 // this snippet of code assumes that time_t == seconds since Jan-1-1970
553 // this is generally true and POSIXly happy, but might break if a library
554 // vendor decides to get creative
555 time_t epoch = GetOSXEpoch();
556 epoch = epoch + (time_t)date_value;
557 tm *tm_date = localtime(&epoch);
560 std::string buffer(1024,0);
561 if (strftime (&buffer[0], 1023, "%Z", tm_date) == 0)
563 stream.Printf("%04d-%02d-%02d %02d:%02d:%02d %s", tm_date->tm_year+1900, tm_date->tm_mon+1, tm_date->tm_mday, tm_date->tm_hour, tm_date->tm_min, tm_date->tm_sec, buffer.c_str());