aboutsummaryrefslogtreecommitdiff
path: root/packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-cpp/TestDataFormatterCpp.py
blob: 0518a75051bbd1e104e3d76f814aa56b81d29787 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
"""
Test lldb data formatter subsystem.
"""

from __future__ import print_function


import os
import time
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil


class CppDataFormatterTestCase(TestBase):

    mydir = TestBase.compute_mydir(__file__)

    def setUp(self):
        # Call super's setUp().
        TestBase.setUp(self)
        # Find the line number to break at.
        self.line = line_number('main.cpp', '// Set break point at this line.')

    @expectedFailureAll(
        oslist=["windows"],
        bugnumber="llvm.org/pr24462: Data formatters have problems on Windows")
    def test_with_run_command(self):
        """Test that that file and class static variables display correctly."""
        self.build()
        self.runCmd("file a.out", CURRENT_EXECUTABLE_SET)

        lldbutil.run_break_set_by_file_and_line(
            self, "main.cpp", self.line, num_expected_locations=1, loc_exact=True)

        self.runCmd("run", RUN_SUCCEEDED)

        # The stop reason of the thread should be breakpoint.
        self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
                    substrs=['stopped',
                             'stop reason = breakpoint'])

        self.expect("frame variable",
                    substrs=['(Speed) SPILookHex = 5.55'  # Speed by default is 5.55.
                             ])

        # This is the function to remove the custom formats in order to have a
        # clean slate for the next test case.
        def cleanup():
            self.runCmd('type format clear', check=False)
            self.runCmd('type summary clear', check=False)

        # Execute the cleanup function during test case tear down.
        self.addTearDownHook(cleanup)

        self.runCmd("type format add -C yes -f x Speed BitField")
        self.runCmd("type format add -C no -f c RealNumber")
        self.runCmd("type format add -C no -f x Type2")
        self.runCmd("type format add -C yes -f c Type1")

        # The type format list should show our custom formats.
        self.expect("type format list",
                    substrs=['RealNumber',
                             'Speed',
                             'BitField',
                             'Type1',
                             'Type2'])

        self.expect("frame variable",
                    patterns=['\(Speed\) SPILookHex = 0x[0-9a-f]+'  # Speed should look hex-ish now.
                              ])

        # gcc4.2 on Mac OS X skips typedef chains in the DWARF output
        if self.getCompiler() in ['clang', 'llvm-gcc']:
            self.expect("frame variable",
                        patterns=['\(SignalMask\) SMILookHex = 0x[0-9a-f]+'  # SignalMask should look hex-ish now.
                                  ])
            self.expect("frame variable", matching=False,
                        patterns=['\(Type4\) T4ILookChar = 0x[0-9a-f]+'  # Type4 should NOT look hex-ish now.
                                  ])

        # Now let's delete the 'Speed' custom format.
        self.runCmd("type format delete Speed")

        # The type format list should not show 'Speed' at this point.
        self.expect("type format list", matching=False,
                    substrs=['Speed'])

        # Delete type format for 'Speed', we should expect an error message.
        self.expect("type format delete Speed", error=True,
                    substrs=['no custom formatter for Speed'])

        self.runCmd(
            "type summary add --summary-string \"arr = ${var%s}\" -x \"char \\[[0-9]+\\]\" -v")

        self.expect("frame variable strarr",
                    substrs=['arr = "Hello world!"'])

        self.runCmd("type summary clear")

        self.runCmd(
            "type summary add --summary-string \"ptr = ${var%s}\" \"char *\" -v")

        self.expect("frame variable strptr",
                    substrs=['ptr = "Hello world!"'])

        self.runCmd(
            "type summary add --summary-string \"arr = ${var%s}\" -x \"char \\[[0-9]+\\]\" -v")

        self.expect("frame variable strarr",
                    substrs=['arr = "Hello world!'])

        # check that rdar://problem/10011145 (Standard summary format for
        # char[] doesn't work as the result of "expr".) is solved
        self.expect("p strarr",
                    substrs=['arr = "Hello world!'])

        self.expect("frame variable strptr",
                    substrs=['ptr = "Hello world!"'])

        self.expect("p strptr",
                    substrs=['ptr = "Hello world!"'])

        self.expect(
            "p (char*)\"1234567890123456789012345678901234567890123456789012345678901234ABC\"",
            substrs=[
                '(char *) $',
                ' = ptr = ',
                ' "1234567890123456789012345678901234567890123456789012345678901234ABC"'])

        self.runCmd("type summary add -c Point")

        self.expect("frame variable iAmSomewhere",
                    substrs=['x = 4',
                             'y = 6'])

        self.expect("type summary list",
                    substrs=['Point',
                             'one-line'])

        self.runCmd("type summary add --summary-string \"y=${var.y%x}\" Point")

        self.expect("frame variable iAmSomewhere",
                    substrs=['y=0x'])

        self.runCmd(
            "type summary add --summary-string \"y=${var.y},x=${var.x}\" Point")

        self.expect("frame variable iAmSomewhere",
                    substrs=['y=6',
                             'x=4'])

        self.runCmd("type summary add --summary-string \"hello\" Point -e")

        self.expect("type summary list",
                    substrs=['Point',
                             'show children'])

        self.expect("frame variable iAmSomewhere",
                    substrs=['hello',
                             'x = 4',
                             '}'])

        self.runCmd(
            "type summary add --summary-string \"Sign: ${var[31]%B} Exponent: ${var[23-30]%x} Mantissa: ${var[0-22]%u}\" ShowMyGuts")

        self.expect("frame variable cool_pointer->floating",
                    substrs=['Sign: true',
                             'Exponent: 0x',
                             '80'])

        self.runCmd("type summary add --summary-string \"a test\" i_am_cool")

        self.expect("frame variable cool_pointer",
                    substrs=['a test'])

        self.runCmd(
            "type summary add --summary-string \"a test\" i_am_cool --skip-pointers")

        self.expect("frame variable cool_pointer",
                    substrs=['a test'],
                    matching=False)

        self.runCmd(
            "type summary add --summary-string \"${var[1-3]}\" \"int [5]\"")

        self.expect("frame variable int_array",
                    substrs=['2',
                             '3',
                             '4'])

        self.runCmd("type summary clear")

        self.runCmd(
            "type summary add --summary-string \"${var[0-2].integer}\" \"i_am_cool *\"")
        self.runCmd(
            "type summary add --summary-string \"${var[2-4].integer}\" \"i_am_cool [5]\"")

        self.expect("frame variable cool_array",
                    substrs=['1,1,6'])

        self.expect("frame variable cool_pointer",
                    substrs=['3,0,0'])

        # test special symbols for formatting variables into summaries
        self.runCmd(
            "type summary add --summary-string \"cool object @ ${var%L}\" i_am_cool")
        self.runCmd("type summary delete \"i_am_cool [5]\"")

        # this test might fail if the compiler tries to store
        # these values into registers.. hopefully this is not
        # going to be the case
        self.expect("frame variable cool_array",
                    substrs=['[0] = cool object @ 0x',
                             '[1] = cool object @ 0x',
                             '[2] = cool object @ 0x',
                             '[3] = cool object @ 0x',
                             '[4] = cool object @ 0x'])

        # test getting similar output by exploiting ${var} = 'type @ location'
        # for aggregates
        self.runCmd("type summary add --summary-string \"${var}\" i_am_cool")

        # this test might fail if the compiler tries to store
        # these values into registers.. hopefully this is not
        # going to be the case
        self.expect("frame variable cool_array",
                    substrs=['[0] = i_am_cool @ 0x',
                             '[1] = i_am_cool @ 0x',
                             '[2] = i_am_cool @ 0x',
                             '[3] = i_am_cool @ 0x',
                             '[4] = i_am_cool @ 0x'])

        # test getting same output by exploiting %T and %L together for
        # aggregates
        self.runCmd(
            "type summary add --summary-string \"${var%T} @ ${var%L}\" i_am_cool")

        # this test might fail if the compiler tries to store
        # these values into registers.. hopefully this is not
        # going to be the case
        self.expect("frame variable cool_array",
                    substrs=['[0] = i_am_cool @ 0x',
                             '[1] = i_am_cool @ 0x',
                             '[2] = i_am_cool @ 0x',
                             '[3] = i_am_cool @ 0x',
                             '[4] = i_am_cool @ 0x'])

        self.runCmd("type summary add --summary-string \"goofy\" i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"${var.second_cool%S}\" i_am_cooler")

        self.expect("frame variable the_coolest_guy",
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        # check that unwanted type specifiers are removed
        self.runCmd("type summary delete i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"goofy\" \"class i_am_cool\"")
        self.expect("frame variable the_coolest_guy",
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        self.runCmd("type summary delete i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"goofy\" \"enum i_am_cool\"")
        self.expect("frame variable the_coolest_guy",
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        self.runCmd("type summary delete i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"goofy\" \"struct i_am_cool\"")
        self.expect("frame variable the_coolest_guy",
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        # many spaces, but we still do the right thing
        self.runCmd("type summary delete i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"goofy\" \"union     i_am_cool\"")
        self.expect("frame variable the_coolest_guy",
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        # but that not *every* specifier is removed
        self.runCmd("type summary delete i_am_cool")
        self.runCmd(
            "type summary add --summary-string \"goofy\" \"wrong i_am_cool\"")
        self.expect("frame variable the_coolest_guy", matching=False,
                    substrs=['(i_am_cooler) the_coolest_guy = goofy'])

        # check that formats are not sticking since that is the behavior we
        # want
        self.expect("frame variable iAmInt --format hex",
                    substrs=['(int) iAmInt = 0x00000001'])
        self.expect(
            "frame variable iAmInt",
            matching=False,
            substrs=['(int) iAmInt = 0x00000001'])
        self.expect("frame variable iAmInt", substrs=['(int) iAmInt = 1'])