Add "show history" subcommand (#66)

Author: rocky

trepan/api.py

@@ -131,7 +131,7 @@ def run_exec(statement, debug_opts=None, start_opts=None, globals_=None, locals_
 
 
 def debug(
-    dbg_opts=None,
+    dbg_opts={},
     start_opts=None,
     post_mortem: bool = True,
     step_ignore: int = 1,

trepan/inout/input.py

@@ -59,7 +59,7 @@ def close(self):
         return
 
     def use_history(self):
-        return self.use_raw
+        return self.use_raw or self.session
 
     def open(self, inp, opts={}):
         """Use this to set where to read from.

trepan/interfaces/user.py

@@ -31,6 +31,7 @@
 
 DEFAULT_USER_SETTINGS = {
     "histfile": histfile,  # Where do we save the history?
+    "histsize": 50,  # How many history items do we save
     "complete": None,  # Function which handles tab completion, or None
 }
 
@@ -59,6 +60,7 @@ def __init__(self, inp=None, out=None, opts={}):
         self.input = inp or DebuggerUserInput(self.user_opts.get("input", {}), self.user_opts)
         self.output = out or DebuggerUserOutput()
         self.debugger_name = self.user_opts.get("debugger_name", "trepan3k")
+        self.histfile = None
 
         if self.input.use_history():
             self.complete = self.user_opts["complete"]
@@ -76,7 +78,7 @@ def __init__(self, inp=None, out=None, opts={}):
                     # PyPy read_history_file fails
                     return
                 try:
-                    set_history_length(50)
+                    set_history_length(DEFAULT_USER_SETTINGS["histsize"])
                 except Exception:
                     pass
                 atexit.register(self.user_write_history_file)

trepan/processor/command/info_subcmd/break.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2009, 2012-2013, 2015, 2018 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2009, 2012-2013, 2015, 2018, 2024
+#   Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -54,7 +55,7 @@ class InfoBreak(Mbase_subcmd.DebuggerSubcommand):
 
     """
 
-    min_abbrev = 1  # Min is info b
+    min_abbrev = len("b")
     need_stack = False
     short_help = "Status of user-settable breakpoints"
 

trepan/processor/command/mock.py

@@ -41,6 +41,7 @@ def __init__(self):
         self.io = MockIO()
         self.output = MockIO()
         self.debugger_name = "trepan3k"
+        self.histfile = "/tmp/.trepanrc"
         return
 
     def confirm(self, msg, default):

trepan/processor/command/show_subcmd/history.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+#   Copyright (C) 2024 Rocky Bernstein <rocky@gnu.org>
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Our local modules
+from trepan.lib.complete import complete_token
+from trepan.processor.command.base_subcmd import DebuggerSubcommand
+
+from trepan.interfaces.user import DEFAULT_USER_SETTINGS
+
+class ShowHistory(DebuggerSubcommand):
+    """**show history** [ *filename* | *save* | *size* ]
+
+    Show history information
+
+    options include:
+    * size: Show the size of the command history.
+    * filename Show the filename in which to record the command historyh.
+
+    Examples:
+    --------
+        (trepan3k) show history size
+        The size of the command history is 50.
+
+        (trepan3k) show history
+        history filename: The filename in which to record the command history is "/home/joe/.trepan3k_hist".
+        history save: Saving of the history record on exit is on.
+        history size: The size of the command history is 50.
+    """
+
+    min_abbrev = len("his")
+    need_stack = False
+    short_help = "Generic command for showing command history parameters"
+
+    def complete(self, prefix):
+        return complete_token(("filename", "save", "size"))
+
+    def run(self, args):
+        opts = self.debugger.settings
+        show_prefix = False
+        if len(args) == 0:
+            args = ("filename", "save", "size")
+            show_prefix = True
+
+        for arg in args:
+            prefix = f"history {arg}: " if show_prefix else ""
+            if arg == "filename":
+                self.msg(f'{prefix}The filename in which to record the command history is "{self.proc.intf[-1].histfile}".')
+            elif arg == "save":
+                self.msg(f'{prefix}Saving of the history record on exit is {"on" if opts.get("hist_save", False) else "off"}.')
+            elif arg == "size":
+                self.msg(f'{prefix}The size of the command history is {DEFAULT_USER_SETTINGS["histsize"]}.')
+            else:
+                self.errmsg(f"Undefined show history command: {arg}")
+                pass
+        return
+
+    pass
+
+
+if __name__ == "__main__":
+    from trepan.processor.command.set_subcmd.__demo_helper__ import demo_run
+
+    sub = demo_run(ShowHistory, [])
+    d = sub.proc.debugger
+    sub.run([])
+    sub.run(["filename"])
+    sub.run(["save"])
+    sub.run(["size"])
+    sub.run(["foo"])
+    pass

trepan/processor/command/show_subcmd/style.py

@@ -12,10 +12,6 @@
 style_names = sorted(list(STYLE_MAP.keys()))
 
 
-def complete(self, prefix):
-    return complete_token(style_names)
-
-
 class ShowStyle(DebuggerSubcommand):
     """**show style* *pygments-style*
 
@@ -30,6 +26,10 @@ class ShowStyle(DebuggerSubcommand):
     min_abbrev = len("sty")
     short_help = "Set the pygments style"
 
+    def complete(self, prefix):
+        return complete_token(style_names)
+
+
     def run(self, args):
         if len(args) != 0:
             self.errmsg("Expecting no args")