37844f89b32aa06f67179a5122f6e958455b1cab
[WebKit-https.git] / Tools / lldb / lldb_webkit.py
1 # Copyright (C) 2012 Apple. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
5 # are met:
6 # 1.  Redistributions of source code must retain the above copyright
7 #     notice, this list of conditions and the following disclaimer.
8 # 2.  Redistributions in binary form must reproduce the above copyright
9 #     notice, this list of conditions and the following disclaimer in the
10 #     documentation and/or other materials provided with the distribution.
11 #
12 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
13 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
16 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
19 # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
23 """
24     LLDB Support for WebKit Types
25
26     Add the following to your .lldbinit file to add WebKit Type summaries in LLDB and Xcode:
27
28     command script import {Path to WebKit Root}/Tools/lldb/lldb_webkit.py
29
30 """
31
32 import lldb
33
34
35 def __lldb_init_module(debugger, dict):
36     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFString_SummaryProvider WTF::String')
37     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFStringImpl_SummaryProvider WTF::StringImpl')
38     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFAtomicString_SummaryProvider WTF::AtomicString')
39     debugger.HandleCommand('type summary add --expand -F lldb_webkit.WTFVector_SummaryProvider -x "WTF::Vector<.+>$"')
40     debugger.HandleCommand('type synthetic add -x "WTF::Vector<.+>$" --python-class lldb_webkit.WTFVectorProvider')
41
42
43 def WTFString_SummaryProvider(valobj, dict):
44     provider = WTFStringProvider(valobj, dict)
45     return "{ length = %d, contents = '%s' }" % (provider.get_length(), provider.to_string())
46
47
48 def WTFStringImpl_SummaryProvider(valobj, dict):
49     provider = WTFStringImplProvider(valobj, dict)
50     return "{ length = %d, is8bit = %d, contents = '%s' }" % (provider.get_length(), provider.is_8bit(), provider.to_string())
51
52
53 def WTFAtomicString_SummaryProvider(valobj, dict):
54     return WTFString_SummaryProvider(valobj.GetChildMemberWithName('m_string'), dict)
55
56
57 def WTFVector_SummaryProvider(valobj, dict):
58     provider = WTFVectorProvider(valobj, dict)
59     return "{ size = %d, capacity = %d }" % (provider.size, provider.capacity)
60
61 # FIXME: Provide support for the following types:
62 # def WTFVector_SummaryProvider(valobj, dict):
63 # def WTFCString_SummaryProvider(valobj, dict):
64 # def WebCoreKURLGooglePrivate_SummaryProvider(valobj, dict):
65 # def WebCoreQualifiedName_SummaryProvider(valobj, dict):
66 # def JSCIdentifier_SummaryProvider(valobj, dict):
67 # def JSCJSString_SummaryProvider(valobj, dict):
68
69
70 def guess_string_length(valobj, error):
71     if not valobj.GetValue():
72         return 0
73
74     for i in xrange(0, 2048):
75         if valobj.GetPointeeData(i, 1).GetUnsignedInt16(error, 0) == 0:
76             return i
77
78     return 256
79
80
81 def ustring_to_string(valobj, error, length=None):
82     if length is None:
83         length = guess_string_length(valobj, error)
84     else:
85         length = int(length)
86
87     out_string = u""
88     for i in xrange(0, length):
89         char_value = valobj.GetPointeeData(i, 1).GetUnsignedInt16(error, 0)
90         out_string = out_string + unichr(char_value)
91
92     return out_string.encode('utf-8')
93
94
95 def lstring_to_string(valobj, error, length=None):
96     if length is None:
97         length = guess_string_length(valobj, error)
98     else:
99         length = int(length)
100
101     out_string = u""
102     for i in xrange(0, length):
103         char_value = valobj.GetPointeeData(i, 1).GetUnsignedInt8(error, 0)
104         out_string = out_string + unichr(char_value)
105
106     return out_string.encode('utf-8')
107
108
109 class WTFStringImplProvider:
110     def __init__(self, valobj, dict):
111         self.valobj = valobj
112
113     def get_length(self):
114         return self.valobj.GetChildMemberWithName('m_length').GetValueAsUnsigned(0)
115
116     def get_data8(self):
117         return self.valobj.GetChildAtIndex(2).GetChildMemberWithName('m_data8')
118
119     def get_data16(self):
120         return self.valobj.GetChildAtIndex(2).GetChildMemberWithName('m_data16')
121
122     def to_string(self):
123         error = lldb.SBError()
124         if self.is_8bit():
125             return lstring_to_string(self.get_data8(), error, self.get_length())
126         return ustring_to_string(self.get_data16(), error, self.get_length())
127
128     def is_8bit(self):
129         # FIXME: find a way to access WTF::StringImpl::s_hashFlag8BitBuffer
130         return bool(self.valobj.GetChildMemberWithName('m_hashAndFlags').GetValueAsUnsigned(0) \
131             & 1 << 6)
132
133
134 class WTFStringProvider:
135     def __init__(self, valobj, dict):
136         self.valobj = valobj
137
138     def stringimpl(self):
139         impl_ptr = self.valobj.GetChildMemberWithName('m_impl').GetChildMemberWithName('m_ptr')
140         return WTFStringImplProvider(impl_ptr, dict)
141
142     def get_length(self):
143         impl = self.stringimpl()
144         if not impl:
145             return 0
146         return impl.get_length()
147
148     def to_string(self):
149         impl = self.stringimpl()
150         if not impl:
151             return u""
152         return impl.to_string()
153
154
155 class WTFVectorProvider:
156     def __init__(self, valobj, internal_dict):
157         self.valobj = valobj
158         self.update()
159
160     def num_children(self):
161         return self.size + 2
162
163     def get_child_index(self, name):
164         if name == "m_size":
165             return self.size
166         elif name == "m_buffer":
167             return self.size + 1
168         else:
169             return int(name.lstrip('[').rstrip(']'))
170
171     def get_child_at_index(self, index):
172         if index == self.size:
173             return self.valobj.GetChildMemberWithName("m_size")
174         elif index == self.size + 1:
175             return self.vector_buffer
176         elif index < self.size:
177             offset = index * self.data_size
178             child = self.buffer.CreateChildAtOffset('[' + str(index) + ']', offset, self.data_type)
179             return child
180         else:
181             return None
182
183     def update(self):
184         self.vector_buffer = self.valobj.GetChildMemberWithName('m_buffer')
185         self.buffer = self.vector_buffer.GetChildMemberWithName('m_buffer')
186         self.size = self.valobj.GetChildMemberWithName('m_size').GetValueAsUnsigned(0)
187         self.capacity = self.vector_buffer.GetChildMemberWithName('m_capacity').GetValueAsUnsigned(0)
188         self.data_type = self.buffer.GetType().GetPointeeType()
189         self.data_size = self.data_type.GetByteSize()
190
191     def has_children(self):
192         return True