summaryrefslogtreecommitdiff
path: root/packages/Python/lldbsuite/test/source-manager/TestSourceManager.py
diff options
context:
space:
mode:
Diffstat (limited to 'packages/Python/lldbsuite/test/source-manager/TestSourceManager.py')
-rw-r--r--packages/Python/lldbsuite/test/source-manager/TestSourceManager.py141
1 files changed, 100 insertions, 41 deletions
diff --git a/packages/Python/lldbsuite/test/source-manager/TestSourceManager.py b/packages/Python/lldbsuite/test/source-manager/TestSourceManager.py
index 93e1789103cee..31fe5437d1d2e 100644
--- a/packages/Python/lldbsuite/test/source-manager/TestSourceManager.py
+++ b/packages/Python/lldbsuite/test/source-manager/TestSourceManager.py
@@ -10,27 +10,45 @@ o test_modify_source_file_while_debugging:
"""
from __future__ import print_function
-
-
+import re
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
+
+def ansi_underline_surround_regex(inner_regex_text):
+ # return re.compile(r"\[4m%s\[0m" % inner_regex_text)
+ return "4.+\033\\[4m%s\033\\[0m" % inner_regex_text
+
+
class SourceManagerTestCase(TestBase):
mydir = TestBase.compute_mydir(__file__)
+ SOURCE_FILE = 'main.c'
+
+ NO_DEBUG_INFO_TESTCASE = True
+
def setUp(self):
# Call super's setUp().
TestBase.setUp(self)
# Find the line number to break inside main().
- self.line = line_number('main.c', '// Set break point at this line.')
-
- @add_test_categories(['pyapi'])
- def test_display_source_python(self):
- """Test display of source using the SBSourceManager API."""
+ self.line = line_number(self.SOURCE_FILE, '// Set break point at this line.')
+
+ def get_expected_stop_column_number(self):
+ """Return the 1-based column number of the first non-whitespace
+ character in the breakpoint source line."""
+ stop_line = get_line(self.SOURCE_FILE, self.line)
+ # The number of spaces that must be skipped to get to the first non-
+ # whitespace character --- where we expect the debugger breakpoint
+ # column to be --- is equal to the number of characters that get
+ # stripped off the front when we lstrip it, plus one to specify
+ # the character column after the initial whitespace.
+ return len(stop_line) - len(stop_line.lstrip()) + 1
+
+ def do_display_source_python_api(self, use_color, column_marker_regex):
self.build()
exe = os.path.join(os.getcwd(), "a.out")
self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
@@ -39,37 +57,62 @@ class SourceManagerTestCase(TestBase):
self.assertTrue(target, VALID_TARGET)
# Launch the process, and do not stop at the entry point.
- process = target.LaunchSimple (None, None, self.get_process_working_directory())
+ args = None
+ envp = None
+ process = target.LaunchSimple(
+ args, envp, self.get_process_working_directory())
+ self.assertIsNotNone(process)
#
# Exercise Python APIs to display source lines.
#
+ # Setup whether we should use ansi escape sequences, including color
+ # and styles such as underline.
+ self.dbg.SetUseColor(use_color)
+
# 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
+ column = self.get_expected_stop_column_number()
+ context_before = 2
+ context_after = 2
+ current_line_prefix = "=>"
+ source_mgr.DisplaySourceLinesWithLineNumbersAndColumn(
+ filespec, self.line, column, context_before, context_after,
+ current_line_prefix, 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])
+ patterns=['=> %d.*Hello world' % self.line,
+ column_marker_regex])
# Boundary condition testings for SBStream(). LLDB should not crash!
stream.Print(None)
stream.RedirectToFile(None, True)
+ @add_test_categories(['pyapi'])
+ def test_display_source_python_dumb_terminal(self):
+ """Test display of source using the SBSourceManager API, using a
+ dumb terminal and thus no color support (the default)."""
+ use_color = False
+ self.do_display_source_python_api(use_color, r"\s+\^")
+
+ @add_test_categories(['pyapi'])
+ def test_display_source_python_ansi_terminal(self):
+ """Test display of source using the SBSourceManager API, using a
+ dumb terminal and thus no color support (the default)."""
+ use_color = True
+ underline_regex = ansi_underline_surround_regex(r".")
+ self.do_display_source_python_api(use_color, underline_regex)
+
def test_move_and_then_display_source(self):
"""Test that target.source-map settings work by moving main.c to hidden/main.c."""
self.build()
@@ -88,19 +131,23 @@ class SourceManagerTestCase(TestBase):
system([["ls"]])
system([["ls", "hidden"]])
- # Set source remapping with invalid replace path and verify we get an error
- self.expect("settings set target.source-map /a/b/c/d/e /q/r/s/t/u", error=True,
- substrs = ['''error: the replacement path doesn't exist: "/q/r/s/t/u"'''])
-
+ # Set source remapping with invalid replace path and verify we get an
+ # error
+ self.expect(
+ "settings set target.source-map /a/b/c/d/e /q/r/s/t/u",
+ error=True,
+ substrs=['''error: the replacement path doesn't exist: "/q/r/s/t/u"'''])
+
# Set target.source-map settings.
- self.runCmd("settings set target.source-map %s %s" % (os.getcwd(), os.path.join(os.getcwd(), "hidden")))
+ self.runCmd("settings set target.source-map %s %s" %
+ (os.getcwd(), os.path.join(os.getcwd(), "hidden")))
# And verify that the settings work.
self.expect("settings show target.source-map",
- substrs = [os.getcwd(), os.path.join(os.getcwd(), "hidden")])
+ substrs=[os.getcwd(), os.path.join(os.getcwd(), "hidden")])
# Display main() and verify that the source mapping has been kicked in.
self.expect("source list -n main", SOURCE_DISPLAYED_CORRECTLY,
- substrs = ['Hello world'])
+ substrs=['Hello world'])
def test_modify_source_file_while_debugging(self):
"""Modify a source file while debugging the executable."""
@@ -108,19 +155,23 @@ class SourceManagerTestCase(TestBase):
exe = os.path.join(os.getcwd(), "a.out")
self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
- lldbutil.run_break_set_by_file_and_line (self, "main.c", self.line, num_expected_locations=1, loc_exact=True)
+ lldbutil.run_break_set_by_file_and_line(
+ self, "main.c", 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',
- 'main.c:%d' % self.line,
- 'stop reason = breakpoint'])
+ substrs=['stopped',
+ 'main.c:%d' % self.line,
+ 'stop reason = breakpoint'])
# Display some source code.
- self.expect("source list -f main.c -l %d" % self.line, SOURCE_DISPLAYED_CORRECTLY,
- substrs = ['Hello world'])
+ self.expect(
+ "source list -f main.c -l %d" %
+ self.line,
+ SOURCE_DISPLAYED_CORRECTLY,
+ substrs=['Hello world'])
# The '-b' option shows the line table locations from the debug information
# that indicates valid places to set source level breakpoints.
@@ -158,8 +209,9 @@ class SourceManagerTestCase(TestBase):
# Touch the file just to be sure.
os.utime('main.c', None)
if self.TraceOn():
- print("os.path.getmtime() after restore:", os.path.getmtime('main.c'))
-
+ print(
+ "os.path.getmtime() after restore:",
+ os.path.getmtime('main.c'))
# Modify the source code file.
with io.open('main.c', 'w', newline='\n') as f:
@@ -167,28 +219,35 @@ class SourceManagerTestCase(TestBase):
f.write(new_content)
if self.TraceOn():
print("new content:", new_content)
- print("os.path.getmtime() after writing new content:", os.path.getmtime('main.c'))
+ print(
+ "os.path.getmtime() after writing new content:",
+ os.path.getmtime('main.c'))
# Add teardown hook to restore the file to the original content.
self.addTearDownHook(restore_file)
# Display the source code again. We should see the updated line.
- self.expect("source list -f main.c -l %d" % self.line, SOURCE_DISPLAYED_CORRECTLY,
- substrs = ['Hello lldb'])
+ self.expect(
+ "source list -f main.c -l %d" %
+ self.line,
+ SOURCE_DISPLAYED_CORRECTLY,
+ substrs=['Hello lldb'])
def test_set_breakpoint_with_absolute_path(self):
self.build()
- self.runCmd("settings set target.source-map %s %s" % (os.getcwd(), os.path.join(os.getcwd(), "hidden")))
+ self.runCmd("settings set target.source-map %s %s" %
+ (os.getcwd(), os.path.join(os.getcwd(), "hidden")))
exe = os.path.join(os.getcwd(), "a.out")
main = os.path.join(os.getcwd(), "hidden", "main.c")
self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
- lldbutil.run_break_set_by_file_and_line (self, main, self.line, num_expected_locations=1, loc_exact=False)
-
+ lldbutil.run_break_set_by_file_and_line(
+ self, main, self.line, num_expected_locations=1, loc_exact=False)
+
self.runCmd("run", RUN_SUCCEEDED)
# The stop reason of the thread should be breakpoint.
self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
- substrs = ['stopped',
- 'main.c:%d' % self.line,
- 'stop reason = breakpoint'])
+ substrs=['stopped',
+ 'main.c:%d' % self.line,
+ 'stop reason = breakpoint'])
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-30 17:59:56 +0000