dumper.py 33.6 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

39
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
40
    if isGoodGdb():
41 42 43 44
        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")
45 46 47 48 49
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
        return None
50 51 52
    gdb.execute("set logging off")
    return gdb.history(0)

53
def listOfLocals(varList):
54 55 56 57
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
58
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
59
        return []
60

61 62 63
    # gdb-6.8-symbianelf fails here
    hasBlock = 'block' in dir(frame)

64
    items = []
65 66 67 68 69 70 71 72 73
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

74 75 76 77 78 79
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
                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
104
        # Assuming gdb 7.0 release or 6.8-symbianelf.
105 106
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
107 108
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
109 110
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
111 112 113
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
        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
131 132
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
133

134 135 136 137
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
138
            # The function parameters
139 140 141
            pos = line.find(" = ")
            if pos < 0:
                continue
142 143 144 145 146 147 148
            varList.append(line[0:pos])
        file.close()
        os.remove(filename)

        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
149 150 151 152
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
153 154
                pass
                #continue
155 156 157 158 159
            items.append(item)

    return items


160
def value(expr):
161
    value = parseAndEvaluate(expr)
162 163 164 165 166
    try:
        return int(value)
    except:
        return str(value)

167

hjk's avatar
hjk committed
168
def isSimpleType(typeobj):
169 170
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
171 172 173 174 175 176 177 178
    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 ") \
179
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
180 181
        or type == "unsigned" or type.startswith("unsigned ")

182

hjk's avatar
hjk committed
183 184 185 186 187 188 189 190 191
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):
192 193
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
194 195 196 197 198 199
    pass

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

200 201 202 203 204
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
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
#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):
226 227 228 229
    # 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 ")
230
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
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

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):
257
    for i in xrange(n):
hjk's avatar
hjk committed
258 259 260 261 262 263
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
264
    if type.find(":") >= 0:
hjk's avatar
hjk committed
265 266 267
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
268
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
269 270 271
    #warn("  -> %s" % result)
    return result

272 273
def qtNamespace():
    try:
274
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
275 276 277
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
278 279 280
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
281

282 283
def encodeCharArray(p, size):
    s = ""
284
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
285
    for i in xrange(size):
286 287 288 289
        s += "%02x" % int(p.dereference())
        p += 1
    return s

290 291 292 293 294 295
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)
296
    checkRef(d_ptr["ref"])
297 298 299 300 301 302
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
303
    return encodeCharArray(p, size)
304 305 306 307 308 309 310 311 312 313

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
314
    checkRef(d_ptr["ref"])
315 316
    p = gdb.Value(d_ptr["data"])
    s = ""
317
    for i in xrange(size):
318 319 320 321 322 323
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
324 325 326 327 328 329 330
#######################################################################
#
# Item
#
#######################################################################

class Item:
331
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
332
        self.value = value
333 334 335 336
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
        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(' ')
354

hjk's avatar
hjk committed
355 356
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
357
        options = args[0].split(",")
358 359 360 361 362 363 364 365 366 367 368
        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)

369
        useFancy = "fancy" in options
370 371

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
372 373 374 375
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
376 377 378
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
379
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
380 381
                    if output != "dumpers=[":
                        output += ","
382
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
383 384
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
385
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
386 387 388 389 390 391 392
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
393

394

hjk's avatar
hjk committed
395 396
        if useFancy:
            for key, value in module.__dict__.items():
397 398
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
399 400 401

        d = Dumper()
        d.dumpers = self.dumpers
402 403 404
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
405
        d.ns = qtNamespace()
406
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
407 408
        #warn(" NAMESPACE IS: '%s'" % d.ns)

409 410 411
        #
        # Locals
        #
412
        for item in listOfLocals(varList):
413
            #warn("ITEM NAME %s: " % item.name)
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
            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
429 430 431 432

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
433
                # Special handling for char** argv.
434 435 436 437 438 439 440 441 442 443 444 445 446
                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):
447
                    p = item.value
448
                    d.beginChildren(n)
449
                    for i in xrange(n):
450 451
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
452
                        p += 1
453 454 455 456 457 458
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
459
                # A "normal" local variable or parameter.
460 461 462 463 464 465 466 467
                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:
468 469
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
470 471 472 473 474 475 476
                    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
477

478 479 480 481
        d.pushOutput()
        locals = d.safeoutput


482 483 484
        #
        # Watchers
        #
485
        d.safeoutput = ""
486
        if len(watchers) > 0:
487
            for watcher in watchers.split("##"):
488 489
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
490 491 492
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
493 494 495 496 497
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

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

499

500 501
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
502
        if exp.startswith("["):
503
            warn("EVAL: EXP: %s" % exp)
504
            d.beginHash()
505
            d.put('iname="%s",' % iname)
506
            d.put('name="%s",' % exp)
507
            d.put('exp="%s",' % exp)
508 509
            try:
                list = eval(exp)
510
                #warn("EVAL: LIST: %s" % list)
511 512 513 514 515 516 517
                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:
518
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
519 520 521 522 523 524 525 526 527 528 529 530 531
                    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()
532
        d.put('iname="%s",' % iname)
533
        d.put('name="%s",' % exp)
534
        d.put('exp="%s",' % exp)
535 536 537 538 539
        handled = False
        if exp == "<Edit>":
            d.put(',value=" ",')
            d.put('type=" ",numchild="0"')
        else:
540
            try:
541
                value = parseAndEvaluate(exp)
542
                item = Item(value, iname, None, None)
543
                d.putItemHelper(item)
544
            except RuntimeError:
545 546 547
                d.put(',value="<invalid>",')
                d.put('type="<unknown>",numchild="0"')
        d.endHash()
548

hjk's avatar
hjk committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

FrameCommand()



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

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
566 567
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597

    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('"')

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

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
631 632 633 634
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
635 636 637 638
        self.childTypes.pop()
        self.childNumChilds.pop()
        self.put(']')

639 640 641
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655
    # 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]:
656 657
            self.putCommaIfNeeded()
            self.put('type="%s"' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
658 659 660

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

664 665 666 667 668 669
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
670 671 672 673 674 675 676
        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))
677 678 679 680 681

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

683 684 685 686
    def putName(self, name):
        self.putCommaIfNeeded()
        self.put('name="%s"' % name)

hjk's avatar
hjk committed
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
    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):
705 706 707 708 709
        # 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
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
        # 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()
728 729
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
730 731 732 733 734 735
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

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

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

747
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
748
        if isSimpleType(item.value.type):
749
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
750

751 752 753 754 755
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
756 757 758 759 760 761 762 763 764 765 766 767
    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)

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

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
790
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
791 792 793
        self.endHash()

    def putCallItem(self, name, item, func):
794 795 796 797 798
        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
799

800
    def putItemHelper(self, item):
hjk's avatar
hjk committed
801 802
        name = getattr(item, "name", None)
        if not name is None:
803
            self.putName(name)
hjk's avatar
hjk committed
804

805 806 807 808 809 810 811 812
        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
813
        # FIXME: Gui shows references stripped?
814
        #warn(" ");
hjk's avatar
hjk committed
815
        #warn("REAL INAME: %s " % item.iname)
816
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
817
        #warn("REAL TYPE: %s " % item.value.type)
818
        #warn("REAL VALUE: %s " % item.value)
819 820
        #try:
        #    warn("REAL VALUE: %s " % item.value)
821 822
        #except:
        #    #UnicodeEncodeError:
823
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
824 825 826 827 828 829 830 831 832 833 834 835 836

        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("::", "__")
837

hjk's avatar
hjk committed
838 839 840 841
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

842
        if isSimpleType(type.unqualified()):
843 844
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
845 846
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
847 848

        elif strippedType in self.dumpers:
849 850
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
851
            self.dumpers[strippedType](self, item)
852
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
853 854

        elif type.code == gdb.TYPE_CODE_ENUM:
855
            #warn("GENERIC ENUM: %s" % value)
856
            self.putType(item.value.type)
857
            self.putValue(value)
hjk's avatar
hjk committed
858
            self.putNumChild(0)
859

hjk's avatar
hjk committed
860 861

        elif type.code == gdb.TYPE_CODE_PTR:
862
            isHandled = False
863
            #warn("A POINTER: %s" % value.type)
864 865 866 867 868 869 870
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

871 872
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
873 874 875 876 877
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

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

901 902 903 904 905
            #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.
906
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
907 908 909 910 911 912 913 914 915 916 917
                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:
918
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
919 920 921 922 923 924 925 926
                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
927 928

        else:
929
            #warn("GENERIC STRUCT: %s" % value.type)
hjk's avatar
hjk committed
930 931
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
932
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
933 934 935 936 937

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

938
            self.putType(item.value.type)
939
            self.putValue("{...}")
hjk's avatar
hjk committed
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954

            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()
955
                self.beginChildren(1, innerType)
hjk's avatar
hjk committed
956

957
                baseNumber = 0
958
                anonNumber = 0
hjk's avatar
hjk committed
959 960 961 962 963 964 965 966 967 968 969
                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())
970
                        for i in xrange(value.type.sizeof / innerType.sizeof):
hjk's avatar
hjk committed
971 972 973 974 975 976 977 978 979 980 981
                            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)):
982 983 984 985 986 987 988 989 990 991
                        # 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()
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
                    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
1010
                    else:
1011 1012
                        # Named field.
                        self.beginHash()
1013 1014 1015 1016
                        child = Item(value[field.name],
                            item.iname, field.name, field.name)
                        self.safePutItemHelper(child)
                        self.endHash()
1017

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