Python summary strings:

 - you can use a Python script to write a summary string for data-types, in one of
   three ways:
    -P option and typing the script a line at a time
    -s option and passing a one-line Python script
    -F option and passing the name of a Python function
   these options all work for the "type summary add" command
   your Python code (if provided through -P or -s) is wrapped in a function
   that accepts two parameters: valobj (a ValueObject) and dict (an LLDB
   internal dictionary object). if you use -F and give a function name,
   you're expected to define the function on your own and with the right
   prototype. your function, however defined, must return a Python string
 - test case for the Python summary feature
 - a few quirks:
  Python summaries cannot have names, and cannot use regex as type names
  both issues will be fixed ASAP
major redesign of type summary code:
 - type summary working with strings and type summary working with Python code
   are two classes, with a common base class SummaryFormat
 - SummaryFormat classes now are able to actively format objects rather than
   just aggregating data
 - cleaner code to print descriptions for summaries
the public API now exports a method to easily navigate a ValueObject hierarchy
New InputReaderEZ and PriorityPointerPair classes
Several minor fixes and improvements

llvm-svn: 135238

3 files changed, 164 insertions, 0 deletions

diff --git a/lldb/test/functionalities/data-formatter/data-formatter-script/Makefile b/lldb/test/functionalities/data-formatter/data-formatter-script/Makefile
new file mode 100644
index 00000000000..314f1cb2f07
--- /dev/null
+++ b/lldb/test/functionalities/data-formatter/data-formatter-script/Makefile
@@ -0,0 +1,5 @@
+LEVEL = ../../../make
+
+CXX_SOURCES := main.cpp
+
+include $(LEVEL)/Makefile.rules
diff --git a/lldb/test/functionalities/data-formatter/data-formatter-script/TestDataFormatterScript.py b/lldb/test/functionalities/data-formatter/data-formatter-script/TestDataFormatterScript.py
new file mode 100644
index 00000000000..77a0368b7d4
--- /dev/null
+++ b/lldb/test/functionalities/data-formatter/data-formatter-script/TestDataFormatterScript.py
@@ -0,0 +1,110 @@
+"""
+Test lldb data formatter subsystem.
+"""
+
+import os, time
+import unittest2
+import lldb
+from lldbtest import *
+
+class DataFormatterTestCase(TestBase):
+
+    mydir = os.path.join("functionalities", "data-formatter", "data-formatter-script")
+
+    @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
+    def test_with_dsym_and_run_command(self):
+        """Test data formatter commands."""
+        self.buildDsym()
+        self.data_formatter_commands()
+
+    def test_with_dwarf_and_run_command(self):
+        """Test data formatter commands."""
+        self.buildDwarf()
+        self.data_formatter_commands()
+
+    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 data_formatter_commands(self):
+        """Test that that file and class static variables display correctly."""
+        self.runCmd("file a.out", CURRENT_EXECUTABLE_SET)
+
+        self.expect("breakpoint set -f main.cpp -l %d" % self.line,
+                    BREAKPOINT_CREATED,
+            startstr = "Breakpoint created: 1: file ='main.cpp', line = %d, locations = 1" %
+                        self.line)
+
+        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)
+
+        # Set the script here to ease the formatting
+        script = 'a = valobj.GetChildMemberWithName(\'integer\'); a_val = a.GetValue(); str = \'Hello from Python, \' + a_val + \' time\'; return str + (\'!\' if a_val == \'1\' else \'s!\');'
+
+        self.runCmd("type summary add add i_am_cool -s \"%s\"" % script)
+
+        self.expect("frame variable one",
+            substrs = ['Hello from Python',
+                       '1 time!'])
+
+        self.expect("frame variable two",
+            substrs = ['Hello from Python',
+                       '4 times!'])
+        
+        self.runCmd("n"); # skip ahead to make values change
+
+        self.expect("frame variable three",
+            substrs = ['Hello from Python, 10 times!',
+                       'Hello from Python, 4 times!'])
+
+        self.runCmd("n"); # skip ahead to make values change
+    
+        self.expect("frame variable two",
+            substrs = ['Hello from Python',
+                       '1 time!'])
+
+        script = 'a = valobj.GetChildMemberWithName(\'integer\'); a_val = a.GetValue(); str = \'int says \' + a_val; return str;'
+
+        # Check that changes in the script are immediately reflected
+        self.runCmd("type summary add i_am_cool -s \"%s\"" % script)
+
+        self.expect("frame variable two",
+                    substrs = ['int says 1'])
+
+        # Change the summary
+        self.runCmd("type summary add -f \"int says ${var.integer}, and float says ${var.floating}\" i_am_cool")
+
+        self.expect("frame variable two",
+                    substrs = ['int says 1',
+                               'and float says 2.71'])
+        # Try it for pointers
+        self.expect("frame variable twoptr",
+                    substrs = ['int says 1',
+                               'and float says 2.71'])
+
+        # Force a failure for pointers
+        self.runCmd("type summary add i_am_cool -p -s \"%s\"" % script)
+
+        self.expect("frame variable twoptr", matching=False,
+                    substrs = ['and float says 2.71'])
+
+if __name__ == '__main__':
+    import atexit
+    lldb.SBDebugger.Initialize()
+    atexit.register(lambda: lldb.SBDebugger.Terminate())
+    unittest2.main()
diff --git a/lldb/test/functionalities/data-formatter/data-formatter-script/main.cpp b/lldb/test/functionalities/data-formatter/data-formatter-script/main.cpp
new file mode 100644
index 00000000000..357062234e1
--- /dev/null
+++ b/lldb/test/functionalities/data-formatter/data-formatter-script/main.cpp
@@ -0,0 +1,49 @@
+//===-- main.cpp ------------------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+
+struct i_am_cool
+{
+	int integer;
+	float floating;
+	char character;
+	i_am_cool(int I, float F, char C) :
+    integer(I), floating(F), character(C) {}
+	i_am_cool() : integer(1), floating(2), character('3') {}
+    
+};
+
+struct i_am_cooler
+{
+	i_am_cool first_cool;
+	i_am_cool second_cool;
+	float floating;
+	
+	i_am_cooler(int I1, int I2, float F1, float F2, char C1, char C2) :
+    first_cool(I1,F1,C1),
+    second_cool(I2,F2,C2),
+    floating((F1 + F2)/2) {}
+};
+
+int main (int argc, const char * argv[])
+{
+    i_am_cool one(1,3.14,'E');
+    i_am_cool two(4,2.71,'G');
+    
+    i_am_cool* twoptr = &two;
+    
+    i_am_cooler three(10,4,1985,1/1/2011,'B','E'); // Set break point at this line.
+    
+    two.integer = 1;
+    
+    return 0;
+}
\ No newline at end of file