dumper.py 33.9 KB
Newer Older
hjk's avatar
hjk committed
1
2
3
4
5
6
7
8

#Note: Keep name-type-value-numchild-extra order

#return

import sys
import traceback
import gdb
9
import base64
hjk's avatar
hjk committed
10
11
import curses.ascii

12
# only needed for gdb 7.0/7.0.1 that do not implement parse_and_eval
13
14
15
import os
import tempfile

hjk's avatar
hjk committed
16
17
18
verbosity = 0
verbosity = 1

19
20
21
22
23
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

24
25
26
27
28
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
29
def isGoodGdb():
30
31
32
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
    return 'parse_and_eval' in dir(gdb)
hjk's avatar
hjk committed
33

34
def cleanAddress(addr):
35
36
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
37
    return addr.cast(gdb.lookup_type("void").pointer())
38

hjk's avatar
hjk committed
39
40
41
42
43
44
45
46
47
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
    except RuntimeError as error:
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

48
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
49
    if isGoodGdb():
50
51
52
53
        return gdb.parse_and_eval(exp)
    # Work around non-existing gdb.parse_and_eval as in released 7.0
    gdb.execute("set logging redirect on")
    gdb.execute("set logging on")
54
55
56
57
58
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
        return None
59
60
61
    gdb.execute("set logging off")
    return gdb.history(0)

62
def listOfLocals(varList):
63
64
65
66
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
67
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
68
        return []
69

70
71
72
    # gdb-6.8-symbianelf fails here
    hasBlock = 'block' in dir(frame)

73
    items = []
74
75
76
77
78
79
80
81
82
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

83
84
85
86
87
88
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
89

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
                if name == "__in_chrg":
                    continue

                # "NotImplementedError: Symbol type not yet supported in
                # Python scripts."
                #warn("SYMBOL %s: " % symbol.value)
                #warn("SYMBOL %s  (%s): " % (symbol, name))
                item = Item(0, "local", name, name)
                try:
                    item.value = frame.read_var(name)  # this is a gdb value
                except RuntimeError:
                    # happens for  void foo() { std::string s; std::wstring w; }
                    #warn("  FRAME READ VAR ERROR: %s (%s): " % (symbol, name))
                    continue
                #warn("ITEM %s: " % item.value)
                items.append(item)
            # The outermost block in a function has the function member
            # FIXME: check whether this is guaranteed.
            if not block.function is None:
                break

            block = block.superblock
    else:
hjk's avatar
hjk committed
113
        # Assuming gdb 7.0 release or 6.8-symbianelf.
114
115
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
116
117
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
118
119
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
120
121
122
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
        try:
            gdb.execute("info args")
            # We cannot use "info locals" as at least 6.8-symbianelf
            # aborts as soon as we hit unreadable memory.
            # gdb.execute("interpreter mi '-stack-list-locals 0'")
            # results in &"Recursive internal problem.\n", so we have
            # the frontend pass us the list of locals.

            # There are two cases, either varList is empty, so we have
            # to fetch the list here, or it is not empty with the
            # first entry being a dummy.
            if len(varList) == 0:
                gdb.execute("info locals")
            else:
                varList = varList[1:]
        except:
            pass
140
141
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
142

143
144
145
146
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
147
            # The function parameters
148
149
150
            pos = line.find(" = ")
            if pos < 0:
                continue
151
152
153
154
155
156
157
            varList.append(line[0:pos])
        file.close()
        os.remove(filename)

        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
158
159
160
161
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
162
163
                pass
                #continue
164
165
166
167
168
            items.append(item)

    return items


169
def value(expr):
170
    value = parseAndEvaluate(expr)
171
172
173
174
175
    try:
        return int(value)
    except:
        return str(value)

176

hjk's avatar
hjk committed
177
def isSimpleType(typeobj):
178
179
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
180
181
182
183
184
185
186
187
    type = str(typeobj)
    return type == "bool" \
        or type == "char" \
        or type == "double" \
        or type == "float" \
        or type == "int" \
        or type == "long" or type.startswith("long ") \
        or type == "short" or type.startswith("short ") \
188
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
189
190
        or type == "unsigned" or type.startswith("unsigned ")

191

hjk's avatar
hjk committed
192
193
194
195
196
197
198
199
200
def isStringType(d, typeobj):
    type = str(typeobj)
    return type == d.ns + "QString" \
        or type == d.ns + "QByteArray" \
        or type == "std::string" \
        or type == "std::wstring" \
        or type == "wstring"

def warn(message):
201
202
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
203
204
205
206
207
208
    pass

def check(exp):
    if not exp:
        raise RuntimeError("Check failed")

209
210
211
212
213
def checkRef(ref):
    count = ref["_q_value"]
    check(count > 0)
    check(count < 1000000) # assume there aren't a million references to any object

hjk's avatar
hjk committed
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#def couldBePointer(p, align):
#    type = gdb.lookup_type("unsigned int")
#    ptr = gdb.Value(p).cast(type)
#    d = int(str(ptr))
#    warn("CHECKING : %s %d " % (p, ((d & 3) == 0 and (d > 1000 or d == 0))))
#    return (d & (align - 1)) and (d > 1000 or d == 0)


def checkAccess(p, align = 1):
    return p.dereference()

def checkContents(p, expected, align = 1):
    if int(p.dereference()) != expected:
        raise RuntimeError("Contents check failed")

def checkPointer(p, align = 1):
    if not isNull(p):
        p.dereference()


def isNull(p):
235
236
237
238
    # The following can cause evaluation to abort with "UnicodeEncodeError"
    # for invalid char *, as their "contents" is being examined
    #s = str(p)
    #return s == "0x0" or s.startswith("0x0 ")
239
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
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

movableTypes = set([
    "QBrush", "QBitArray", "QByteArray",
    "QCustomTypeInfo", "QChar",
    "QDate", "QDateTime",
    "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue",
    "QIcon", "QImage",
    "QLine", "QLineF", "QLatin1Char", "QLocal",
    "QMatrix", "QModelIndex",
    "QPoint", "QPointF", "QPen", "QPersistentModelIndex",
    "QResourceRoot", "QRect", "QRectF", "QRegExp",
    "QSize", "QSizeF", "QString",
    "QTime", "QTextBlock",
    "QUrl",
    "QVariant",
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
    "QXmlStreamNotationDeclaration", "QXmlStreamEntityDeclaration"])


def stripClassTag(type):
    if type.startswith("class "):
        return type[6:]
    return type

def checkPointerRange(p, n):
266
    for i in xrange(n):
hjk's avatar
hjk committed
267
268
269
270
271
272
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
273
    if type.find(":") >= 0:
hjk's avatar
hjk committed
274
275
276
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
277
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
278
279
280
    #warn("  -> %s" % result)
    return result

281
282
def qtNamespace():
    try:
283
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
284
285
286
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
287
288
289
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
290

291
292
def encodeCharArray(p, size):
    s = ""
293
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
294
    for i in xrange(size):
295
296
297
298
        s += "%02x" % int(p.dereference())
        p += 1
    return s

299
300
301
302
303
304
def encodeByteArray(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
305
    checkRef(d_ptr["ref"])
306
307
308
309
310
311
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
312
    return encodeCharArray(p, size)
313
314
315
316
317
318
319
320
321
322

def encodeString(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size * 2) == 0
323
    checkRef(d_ptr["ref"])
324
325
    p = gdb.Value(d_ptr["data"])
    s = ""
326
    for i in xrange(size):
327
328
329
330
331
332
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
333
334
335
336
337
338
339
#######################################################################
#
# Item
#
#######################################################################

class Item:
340
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
341
        self.value = value
342
343
344
345
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        self.name = name


#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
    """Do fancy stuff. Usage bb --verbose expandedINames"""

    def __init__(self):
        super(FrameCommand, self).__init__("bb", gdb.COMMAND_OBSCURE)

    def invoke(self, arg, from_tty):
        args = arg.split(' ')
363

hjk's avatar
hjk committed
364
365
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
366
        options = args[0].split(",")
367
368
369
370
371
372
373
374
375
376
377
        varList = args[1][1:]
        if len(varList) == 0:
            varList = []
        else:
            varList = varList.split(",")
        expandedINames = set(args[2].split(","))
        watchers = ""
        if len(args) > 3:
            watchers = base64.b16decode(args[3], True)
        #warn("WATCHERS: %s" % watchers)

378
        useFancy = "fancy" in options
379
380

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
381
382
383
384
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
385
386
387
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
388
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
389
390
                    if output != "dumpers=[":
                        output += ","
391
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
392
393
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
394
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
395
396
397
398
399
400
401
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
402

403

hjk's avatar
hjk committed
404
405
        if useFancy:
            for key, value in module.__dict__.items():
406
407
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
408
409
410

        d = Dumper()
        d.dumpers = self.dumpers
411
412
413
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
414
        d.ns = qtNamespace()
415
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
416
417
        #warn(" NAMESPACE IS: '%s'" % d.ns)

418
419
420
        #
        # Locals
        #
421
        for item in listOfLocals(varList):
422
            #warn("ITEM NAME %s: " % item.name)
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
                dummy = str(item.value)
            except:
                # Locals with failing memory access.
                d.beginHash()
                d.put('iname="%s",' % item.iname)
                d.put('name="%s",' % item.name)
                d.put('addr="<not accessible>",')
                d.put('value="<not accessible>",')
                d.put('type="%s",' % item.value.type)
                d.put('numchild="0"');
                d.endHash()
                continue
438
439
440
441

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
442
                # Special handling for char** argv.
443
444
445
446
447
448
449
450
451
452
453
454
455
                n = 0
                p = item.value
                while not isNull(p.dereference()) and n <= 100:
                    p += 1
                    n += 1

                d.beginHash()
                d.put('iname="%s",' % item.iname)
                d.putName(item.name)
                d.putItemCount(select(n <= 100, n, "> 100"))
                d.putType(type)
                d.putNumChild(n)
                if d.isExpanded(item):
456
                    p = item.value
457
                    d.beginChildren(n)
458
                    for i in xrange(n):
459
460
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
461
                        p += 1
462
463
464
465
466
467
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
468
                # A "normal" local variable or parameter.
469
470
471
472
473
474
475
476
                try:
                    addr = cleanAddress(item.value.address)
                    d.beginHash()
                    d.put('iname="%s",' % item.iname)
                    d.put('addr="%s",' % addr)
                    d.safePutItemHelper(item)
                    d.endHash()
                except AttributeError:
477
478
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
479
480
481
482
483
484
485
                    d.beginHash()
                    d.put('iname="%s",' % item.iname)
                    d.put('name="%s",' % item.name)
                    d.put('addr="<optimized out>",')
                    d.put('value="<optimized out>",')
                    d.put('type="%s"' % item.value.type)
                    d.endHash()
hjk's avatar
hjk committed
486

487
488
489
490
        d.pushOutput()
        locals = d.safeoutput


491
492
493
        #
        # Watchers
        #
494
        d.safeoutput = ""
495
        if len(watchers) > 0:
496
            for watcher in watchers.split("##"):
497
498
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
499
500
501
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
502
503
504
505
506
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

        print('data=[' + locals + sep + watchers + ']\n')
507

508

509
510
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
511
        if exp.startswith("["):
512
            warn("EVAL: EXP: %s" % exp)
513
            d.beginHash()
514
            d.put('iname="%s",' % iname)
515
            d.put('name="%s",' % exp)
516
            d.put('exp="%s",' % exp)
517
518
            try:
                list = eval(exp)
519
                #warn("EVAL: LIST: %s" % list)
520
521
522
523
524
525
526
                d.put('value=" "')
                d.put('type=" "')
                d.put('numchild="%d"' % len(list))
                # This is a list of expressions to evaluate
                d.beginChildren(len(list))
                itemNumber = 0
                for item in list:
527
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
528
529
530
531
532
533
534
535
536
537
538
539
540
                    itemNumber += 1
                d.endChildren()
            except:
                warn("EVAL: ERROR CAUGHT")
                d.put('value="<syntax error>"')
                d.put('type=" "')
                d.put('numchild="0"')
                d.beginChildren(0)
                d.endChildren()
            d.endHash()
            return

        d.beginHash()
541
        d.put('iname="%s",' % iname)
542
        d.put('name="%s",' % exp)
543
        d.put('exp="%s",' % exp)
544
545
546
547
548
        handled = False
        if exp == "<Edit>":
            d.put(',value=" ",')
            d.put('type=" ",numchild="0"')
        else:
549
            try:
550
                value = parseAndEvaluate(exp)
551
                item = Item(value, iname, None, None)
552
                d.putItemHelper(item)
553
            except RuntimeError:
554
555
556
                d.put(',value="<invalid>",')
                d.put('type="<unknown>",numchild="0"')
        d.endHash()
557

hjk's avatar
hjk committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574

FrameCommand()



#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
575
576
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606

    def put(self, value):
        self.output += value

    def putCommaIfNeeded(self):
        c = self.output[-1:]
        if c == '}' or c == '"' or c == ']' or c == '\n':
            self.put(',')
        #warn("C:'%s' COND:'%d' OUT:'%s'" %
        #    (c, c == '}' or c == '"' or c == ']' or c == '\n', self.output))

    def putField(self, name, value):
        self.putCommaIfNeeded()
        self.put('%s="%s"' % (name, value))

    def beginHash(self):
        self.putCommaIfNeeded()
        self.put('{')

    def endHash(self):
        self.put('}')

    def beginItem(self, name):
        self.putCommaIfNeeded()
        self.put(name)
        self.put('="')

    def endItem(self):
        self.put('"')

607
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
608
609
        childType = ""
        childNumChild = -1
610
611
612
613
614
615
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
616
        if numChild == 0:
617
            childType_ = None
618
        self.putCommaIfNeeded()
619
620
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
621
            self.put('childtype="%s",' % childType)
622
            if isSimpleType(childType_) or isStringType(self, childType_):
623
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
624
                childNumChild = 0
625
            elif childType_.code == gdb.TYPE_CODE_PTR:
626
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
627
                childNumChild = 1
628
629
630
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
631
632
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
633
634
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
635
636
637
638
639
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
640
641
642
643
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
644
645
646
647
        self.childTypes.pop()
        self.childNumChilds.pop()
        self.put(']')

648
649
650
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    # convenience
    def putItemCount(self, count):
        self.putCommaIfNeeded()
        self.put('value="<%s items>"' % count)

    def putEllipsis(self):
        self.putCommaIfNeeded()
        self.put('{name="<incomplete>",value="",type="",numchild="0"}')

    def putType(self, type):
        #warn("TYPES: '%s' '%s'" % (type, self.childTypes))
        #warn("  EQUAL 2: %s " % (str(type) == self.childTypes[-1]))
        type = stripClassTag(str(type))
        if len(type) > 0 and type != self.childTypes[-1]:
665
666
            self.putCommaIfNeeded()
            self.put('type="%s"' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
667
668
669

    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.childNumChilds[-1]))
670
671
        if numchild != self.childNumChilds[-1]:
            self.put(',numchild="%s"' % numchild)
hjk's avatar
hjk committed
672

673
674
675
676
677
678
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
679
680
681
682
683
684
685
        if value is None:
            self.putCommaIfNeeded()
            self.put('value="<not available>"')
        else:
            str = encodeString(value)
            self.putCommaIfNeeded()
            self.put('valueencoded="%d",value="%s"' % (7, str))
686
687
688
689
690

    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
        self.putCommaIfNeeded()
        self.put('valueencoded="%d",value="%s"' % (6, str))
691

692
693
694
695
    def putName(self, name):
        self.putCommaIfNeeded()
        self.put('name="%s"' % name)

hjk's avatar
hjk committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
    def isExpanded(self, item):
        #warn("IS EXPANDED: %s in %s" % (item.iname, self.expandedINames))
        if item.iname is None:
            raise "Illegal iname 'None'"
        if item.iname.startswith("None"):
            raise "Illegal iname '%s'" % item.iname
        #warn("   --> %s" % (item.iname in self.expandedINames))
        return item.iname in self.expandedINames

    def isExpandedIName(self, iname):
        return iname in self.expandedINames

    def unputField(self, name):
        pos = self.output.rfind(",")
        if self.output[pos + 1:].startswith(name):
            self.output = self.output[0:pos]

    def stripNamespaceFromType(self, typeobj):
714
715
716
717
718
        # This breaks for dumpers type names containing '__star'.
        # But this should not happen as identifiers containing two
        # subsequent underscores are reserved for the implemention.
        if typeobj.code == gdb.TYPE_CODE_PTR:
            return self.stripNamespaceFromType(typeobj.target()) + "__star"
hjk's avatar
hjk committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
        # FIXME: pass ns from plugin
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
        if pos != -1:
            type = type[0:pos]
        return type

    def isMovableType(self, type):
        if type.code == gdb.TYPE_CODE_PTR:
            return True
        if isSimpleType(type):
            return True
        return self.stripNamespaceFromType(type) in movableTypes

    def putIntItem(self, name, value):
        self.beginHash()
737
738
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
739
740
741
742
743
744
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
745
746
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
747
748
749
750
751
752
753
754
755
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

    def pushOutput(self):
        #warn("PUSH OUTPUT: %s " % self.output)
        self.safeoutput += self.output
        self.output = ""

756
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
757
        if isSimpleType(item.value.type):
758
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
759

760
761
762
763
764
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
765
766
767
768
769
770
771
772
773
774
775
776
    def safePutItemHelper(self, item):
        self.pushOutput()
        # This is only used at the top level to ensure continuation
        # after failures due to uninitialized or corrupted data.
        if self.passExceptions:
            # for debugging reasons propagate errors.
            self.putItemHelper(item)

        else:
            try:
                self.putItemHelper(item)

777
            except RuntimeError:
hjk's avatar
hjk committed
778
779
780
781
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
782
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
783
784
785
786
787
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
788
789
790
791
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
792
793
794
795
796
797
798
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
799
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
800
801
802
        self.endHash()

    def putCallItem(self, name, item, func):
803
804
805
806
807
        try:
            result = call(item.value, func)
            self.safePutItem(Item(result, item.iname, name, name))
        except:
            self.safePutItem(Item(None, item.iname))
hjk's avatar
hjk committed
808

809
    def putItemHelper(self, item):
hjk's avatar
hjk committed
810
811
        name = getattr(item, "name", None)
        if not name is None:
812
            self.putName(name)
hjk's avatar
hjk committed
813

814
815
816
817
818
819
820
821
        if item.value is None:
            # Happens for non-available watchers in gdb versions that
            # need to use gdb.execute instead of gdb.parse_and_eval
            self.putValue("<not available>")
            self.putType("<unknown>")
            self.putNumChild(0)
            return

hjk's avatar
hjk committed
822
        # FIXME: Gui shows references stripped?
823
        #warn(" ");
hjk's avatar
hjk committed
824
        #warn("REAL INAME: %s " % item.iname)
825
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
826
        #warn("REAL TYPE: %s " % item.value.type)
827
        #warn("REAL VALUE: %s " % item.value)
828
829
        #try:
        #    warn("REAL VALUE: %s " % item.value)
830
831
        #except:
        #    #UnicodeEncodeError:
832
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
833
834
835
836
837
838
839
840
841
842
843
844
845

        value = item.value
        type = value.type

        if type.code == gdb.TYPE_CODE_REF:
            type = type.target()
            value = value.cast(type)

        if type.code == gdb.TYPE_CODE_TYPEDEF:
            type = type.target()

        strippedType = self.stripNamespaceFromType(
            type.strip_typedefs().unqualified()).replace("::", "__")
846

hjk's avatar
hjk committed
847
848
849
850
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

851
        if isSimpleType(type.unqualified()):
852
853
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
854
855
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
856
857

        elif strippedType in self.dumpers:
858
859
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
860
            self.dumpers[strippedType](self, item)
861
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
862
863

        elif type.code == gdb.TYPE_CODE_ENUM:
864
            #warn("GENERIC ENUM: %s" % value)
865
            self.putType(item.value.type)
866
            self.putValue(value)
hjk's avatar
hjk committed
867
            self.putNumChild(0)
868

hjk's avatar
hjk committed
869
870

        elif type.code == gdb.TYPE_CODE_PTR:
871
            isHandled = False
872
            #warn("A POINTER: %s" % value.type)
873
874
875
876
877
878
879
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

880
881
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
882
883
884
885
886
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

887
                #warn("TARGET: %s " % target) 
888
889
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
890
                    # Display values up to given length directly
891
                    #warn("CHAR AUTODEREF: %s" % value.address)
892
893
894
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
895
                    found = False
896
                    for i in xrange(100):
897
898
                        if p.dereference() == 0:
                            # Found terminating NUL
899
                            found = True
900
901
                            break
                        p += 1
902
903
904
905
906
907
908
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
909

910
911
912
913
914
            #warn("AUTODEREF: %s" % self.autoDerefPointers)
            #warn("IS HANDLED: %s" % isHandled)
            #warn("RES: %s" % (self.autoDerefPointers and not isHandled))
            if self.autoDerefPointers and not isHandled:
                ## Generic pointer type.
915
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
916
917
918
919
920
921
922
923
924
925
926
                innerType = item.value.type.target()
                self.putType(innerType)
                self.childTypes.append(
                    stripClassTag(str(innerType)))
                self.putItemHelper(
                    Item(item.value.dereference(), item.iname, None, None))
                self.childTypes.pop()
                isHandled = True

            # Fall back to plain pointer printing
            if not isHandled:
927
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
928
929
930
931
932
933
934
935
                self.putType(item.value.type)
                self.putValue(str(value.address))
                self.putNumChild(1)
                if self.isExpanded(item):
                    self.beginChildren()
                    self.putItem(
                          Item(item.value.dereference(), item.iname, "*", "*"))
                    self.endChildren()
hjk's avatar
hjk committed
936
937

        else:
938
            #warn("GENERIC STRUCT: %s" % value.type)
hjk's avatar
hjk committed
939
940
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
941
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
942
943
944
945
946

            # insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953
            #fields = value.type.fields()
            fields = value.type.strip_typedefs().fields()

947
            self.putType(item.value.type)
948
            self.putValue("{...}")
hjk's avatar
hjk committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963

            if False:
                numfields = 0
                for field in fields:
                    bitpos = getattr(field, "bitpos", None)
                    if not bitpos is None:
                        ++numfields
            else:
                numfields = len(fields)
            self.putNumChild(numfields)

            if self.isExpanded(item):
                innerType = None
                if len(fields) == 1 and fields[0].name is None:
                    innerType = value.type.target()
964
                self.beginChildren(1, innerType)
hjk's avatar
hjk committed
965

966
                baseNumber = 0
967
                anonNumber = 0
hjk's avatar
hjk committed
968
969
970
971
972
973
974
975
976
977
978
                for field in fields:
                    #warn("FIELD: %s" % field)
                    #warn("  BITSIZE: %s" % field.bitsize)
                    #warn("  ARTIFICIAL: %s" % field.artificial)
                    bitpos = getattr(field, "bitpos", None)
                    if bitpos is None: # FIXME: Is check correct?
                        continue  # A static class member(?).

                    if field.name is None:
                        innerType = value.type.target()
                        p = value.cast(innerType.pointer())
979
                        for i in xrange(value.type.sizeof / innerType.sizeof):
hjk's avatar
hjk committed
980
981
982
983
984
985
986
987
988
989
990
                            self.putItem(Item(p.dereference(), item.iname, i, None))
                            p = p + 1
                        continue

                    # ignore vtable pointers for virtual inheritance
                    if field.name.startswith("_vptr."):
                        continue

                    #warn("FIELD NAME: %s" % field.name)
                    #warn("FIELD TYPE: %s" % field.type)
                    if field.name == stripClassTag(str(field.type)):
991
992
993
994
995
996
997
998
999
1000
                        # Field is base type. We cannot use field.name as part
                        # of the iname as it might contain spaces and other
                        # strange characters.
                        child = Item(value.cast(field.type),
                            item.iname, "@%d" % baseNumber, field.name)
                        baseNumber += 1
                        self.beginHash()
                        self.putField("iname", child.iname)
                        self.safePutItemHelper(child)
                        self.endHash()
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
                    elif field.name == "":
                        # Anonymous union. We need a dummy name to distinguish
                        # multiple anonymous unions in the struct.
                        iname = "%s.#%d" % (item.iname, anonNumber)
                        anonNumber += 1
                        self.beginHash()
                        self.putField("iname", iname)
                        self.putField("name", "<n/a>")
                        self.putField("value", " ")
                        self.putField("type", "<anonymous union>")
                        if self.isExpandedIName(iname):
                            self.beginChildren()
                            for f in field.type.fields():
                                child = Item(item.value[f.name],
                                    item.iname, f.name, f.name)
                                self.safePutItem(child)
                            self.endChildren()
                        self.endHash()
hjk's avatar
hjk committed
1019
                    else:
1020
1021
                        # Named field.
                        self.beginHash()
1022
1023
1024
1025
                        child = Item(value[field.name],
                            item.iname, field.name, field.name)
                        self.safePutItemHelper(child)
                        self.endHash()
1026

hjk's avatar
hjk committed
1027
                self.endChildren()