summaryrefslogtreecommitdiff
path: root/lldb/bindings/interface/SBSourceManagerDocstrings.i
diff options
context:
space:
mode:
Diffstat (limited to 'lldb/bindings/interface/SBSourceManagerDocstrings.i')
-rw-r--r--lldb/bindings/interface/SBSourceManagerDocstrings.i26
1 files changed, 26 insertions, 0 deletions
diff --git a/lldb/bindings/interface/SBSourceManagerDocstrings.i b/lldb/bindings/interface/SBSourceManagerDocstrings.i
new file mode 100644
index 000000000000..0f089941787f
--- /dev/null
+++ b/lldb/bindings/interface/SBSourceManagerDocstrings.i
@@ -0,0 +1,26 @@
+%feature("docstring",
+"Represents a central authority for displaying source code.
+
+For example (from test/source-manager/TestSourceManager.py), ::
+
+ # Create the filespec for 'main.c'.
+ filespec = lldb.SBFileSpec('main.c', False)
+ source_mgr = self.dbg.GetSourceManager()
+ # Use a string stream as the destination.
+ stream = lldb.SBStream()
+ source_mgr.DisplaySourceLinesWithLineNumbers(filespec,
+ self.line,
+ 2, # context before
+ 2, # context after
+ '=>', # prefix for current line
+ stream)
+
+ # 2
+ # 3 int main(int argc, char const *argv[]) {
+ # => 4 printf('Hello world.\\n'); // Set break point at this line.
+ # 5 return 0;
+ # 6 }
+ self.expect(stream.GetData(), 'Source code displayed correctly',
+ exe=False,
+ patterns = ['=> %d.*Hello world' % self.line])"
+) lldb::SBSourceManager;