reference, declarationdefinition
definition → references, declarations, derived classes, virtual overrides
reference to multiple definitions → definitions
unreferenced
    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
"""
Test lldb data formatter subsystem.
"""

from __future__ import print_function


import lldb
from lldbsuite.test.lldbtest import *
import lldbsuite.test.lldbutil as lldbutil


class NamedSummariesDataFormatterTestCase(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.')

    def test_with_run_command(self):
        """Test that that file and class static variables display correctly."""
        self.build()
        self.runCmd("file " + self.getBuildArtifact("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'])

        # 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 summary add --summary-string \"AllUseIt: x=${var.x} {y=${var.y}} {z=${var.z}}\" --name AllUseIt")
        self.runCmd(
            "type summary add --summary-string \"First: x=${var.x} y=${var.y} dummy=${var.dummy}\" First")
        self.runCmd(
            "type summary add --summary-string \"Second: x=${var.x} y=${var.y%hex}\" Second")
        self.runCmd(
            "type summary add --summary-string \"Third: x=${var.x} z=${var.z}\" Third")

        self.expect('type summary list', substrs=['AllUseIt'])

        self.expect("frame variable first",
                    substrs=['First: x=12'])

        self.expect("frame variable first --summary AllUseIt",
                    substrs=['AllUseIt: x=12'])

        # We *DO NOT* remember the summary choice anymore
        self.expect("frame variable first", matching=False,
                    substrs=['AllUseIt: x=12'])
        self.expect("frame variable first",
                    substrs=['First: x=12'])

        self.runCmd("thread step-over")  # 2

        self.expect("frame variable first",
                    substrs=['First: x=12'])

        self.expect("frame variable first --summary AllUseIt",
                    substrs=['AllUseIt: x=12',
                             'y=34'])

        self.expect("frame variable second --summary AllUseIt",
                    substrs=['AllUseIt: x=65',
                             'y=43.25'])

        self.expect("frame variable third --summary AllUseIt",
                    substrs=['AllUseIt: x=96',
                             'z=',
                             'E'])

        self.runCmd("thread step-over")  # 3

        self.expect("frame variable second",
                    substrs=['Second: x=65',
                             'y=0x'])

        # <rdar://problem/11576143> decided that invalid summaries will raise an error
        # instead of just defaulting to the base summary
        self.expect(
            "frame variable second --summary NoSuchSummary",
            error=True,
            substrs=['must specify a valid named summary'])

        self.runCmd("thread step-over")

        self.runCmd(
            "type summary add --summary-string \"FirstAndFriends: x=${var.x} {y=${var.y}} {z=${var.z}}\" First --name FirstAndFriends")

        self.expect("frame variable first",
                    substrs=['FirstAndFriends: x=12',
                             'y=34'])

        self.runCmd("type summary delete First")

        self.expect("frame variable first --summary FirstAndFriends",
                    substrs=['FirstAndFriends: x=12',
                             'y=34'])

        self.expect("frame variable first", matching=True,
                    substrs=['x = 12',
                             'y = 34'])

        self.runCmd("type summary delete FirstAndFriends")
        self.expect("type summary delete NoSuchSummary", error=True)
        self.runCmd("type summary delete AllUseIt")

        self.expect("frame variable first", matching=False,
                    substrs=['FirstAndFriends'])

        self.runCmd("thread step-over")  # 4

        self.expect("frame variable first", matching=False,
                    substrs=['FirstAndFriends: x=12',
                             'y=34'])