[Lldb-commits] [PATCH] D70137: [lldb][Editline] Support ctrl+left/right arrow word navigation.

[Jordan Rupprecht via Phabricator via lldb-commits]

rupprecht updated this revision to Diff 228972.
rupprecht added a comment.

- Add a pexpect test


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D70137/new/

https://reviews.llvm.org/D70137

Files:
  lldb/packages/Python/lldbsuite/test/terminal/TestEditline.py
  lldb/source/Host/common/Editline.cpp


Index: lldb/source/Host/common/Editline.cpp
===================================================================
--- lldb/source/Host/common/Editline.cpp
+++ lldb/source/Host/common/Editline.cpp
@@ -1105,6 +1105,15 @@
   el_set(m_editline, EL_BIND, "\t", "lldb-complete",
          NULL); // Bind TAB to auto complete
 
+  // Allow ctrl-left-arrow and ctrl-right-arrow for navigation, behave like
+  // bash in emacs mode.
+  el_set(m_editline, EL_BIND, ESCAPE "[1;5C", "em-next-word", NULL);
+  el_set(m_editline, EL_BIND, ESCAPE "[1;5D", "ed-prev-word", NULL);
+  el_set(m_editline, EL_BIND, ESCAPE "[5C", "em-next-word", NULL);
+  el_set(m_editline, EL_BIND, ESCAPE "[5D", "ed-prev-word", NULL);
+  el_set(m_editline, EL_BIND, ESCAPE ESCAPE "[C", "em-next-word", NULL);
+  el_set(m_editline, EL_BIND, ESCAPE ESCAPE "[D", "ed-prev-word", NULL);
+
   // Allow user-specific customization prior to registering bindings we
   // absolutely require
   el_source(m_editline, nullptr);
Index: lldb/packages/Python/lldbsuite/test/terminal/TestEditline.py
===================================================================
--- /dev/null
+++ lldb/packages/Python/lldbsuite/test/terminal/TestEditline.py
@@ -0,0 +1,49 @@
+"""
+Test that the lldb editline handling is configured correctly.
+"""
+
+from __future__ import print_function
+
+
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+from lldbsuite.test.lldbpexpect import PExpectTest
+
+
+class EditlineTest(PExpectTest):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    def test_left_right_arrow(self):
+        """Test that ctrl+left/right arrow navigates words correctly.
+
+        Note: just sending escape characters to pexpect and checking the buffer
+        doesn't work well, so we run real commands. We want to type
+        "help command" while exercising word-navigation, so type it as below,
+        where [] indicates cursor position.
+
+        1. Send "el ommand" -> "el command[]"
+        2. Ctrl+left once   -> "el []command"
+        3. Send "c"         -> "el c[]ommand"
+        4. Ctrl+left twice  -> "[]el command"
+        5. Send "h"         -> "h[]el command"
+        6. Ctrl+right       -> "hel[] command"
+        7. Send "p"         -> "help command"
+        """
+        self.launch()
+
+        # Run help for different commands for escape variants to make sure each
+        # one matches uniquely (the buffer isn't cleared in between matches).
+        cases = [
+            ("print", "\x1b[1;5D", "\x1b[1;5C"),
+            ("step", "\x1b[5D", "\x1b[5C"),
+            ("exit", "\x1b\x1b[D", "\x1b\x1b[C"),
+        ]
+        for (cmd, l_escape, r_escape) in cases:
+            self.child.send("el {cmd_tail}{L}{cmd_head}{L}{L}h{R}p\n".format(
+                cmd_head=cmd[0], cmd_tail=cmd[1:], L=l_escape, R=r_escape))
+            self.child.expect_exact("Syntax: %s" % cmd)
+
+        self.quit()


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D70137.228972.patch
Type: text/x-patch
Size: 2978 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20191112/362a6290/attachment.bin>