"info lines" filters by name now

Add RsT documentation for "info lines"

Blacken some buffers

Author: rocky

docs/commands/info.rst

@@ -23,6 +23,7 @@ Type `info` for a list of info subcommands and what they do. Type help
    info/frame
    info/globals
    info/line
+   info/lines
    info/locals
    info/macro
    info/pc

docs/commands/info/lines.rst

@@ -0,0 +1,40 @@
+.. index:: info; lines
+.. _info_lines:
+
+Info Lines
+-----------
+
+**info lines** [**-n** *function-or-module*]
+
+Show line - function/offset information.
+Use **-n** *function-or-module* to filter results.
+
+
+Examples
+++++++++
+
+::
+
+    (trepan3k) info lines
+    Line - (fn, start offset) table for test/example/gcd.py
+      10: <module> @0         21: check_args() @84     36: gcd() @30
+      11: <module> @4         22: check_args() @106    37: gcd() @50
+      13: <module> @12        23: check_args() @116    38: gcd() @54
+      14: check_args() @0     24: check_args() @122    40: <module> @28
+      16: check_args() @14    26: <module> @20         41: <module> @36
+      17: check_args() @22    30: gcd() @0             43: <module> @42
+      18: check_args() @36    31: gcd() @8             44: <module> @60
+      19: check_args() @38    34: gcd() @18            45: <module> @84
+      20: check_args() @70    35: gcd() @26
+    (trepan3k) info lines -n <module>
+      10: <module> @0    11: <module> @4   13: <module> @12
+      40: <module> @28   26: <module> @20  41: <module> @36
+      43: <module> @42   44: <module> @60  45: <module> @84
+    (trepan3k) info lines -n gcd
+      30: gcd() @0   31: gcd() @8   34: gcd() @18
+      35: gcd() @26  36: gcd() @30  37: gcd() @50
+      38: gcd() @54
+
+.. seealso::
+
+   :ref:`info program <info_line>`, :ref:`info program <info_program>`, :ref:`info pc <info_pc>`, :ref:`info frame <info_frame>`

trepan/lib/format.py

@@ -229,57 +229,51 @@ def reflow_text(self, text, ttype, color):
             self.write_nl()
             self.last_was_nl = True
             return
-        elif self.verbatim == "colon-verbatim" and ttype == Token.Text and text == "\n":
+        elif self.verbatim == 'colon-verbatim' and ttype == Token.Text and text == '\n':
             self.write_nl()
             self.last_was_nl = False
             return
         last_last_nl = self.last_was_nl
-        if text == "":
+        if text == '':
             pass
-        elif text[-1] == "\n":
+        elif text[-1] == '\n':
             if self.last_was_nl:
                 self.write_nl()
                 self.write_nl()
                 text = text[:-1]
             elif self.verbatim:
                 self.write_verbatim(text)
                 self.column = 0
-                self.verbatim = len(text) >= 2 and text[-2] == "\n"
+                self.verbatim = len(text) >=2 and text[-2] == '\n'
                 self.last_was_nl = True
                 return
             else:
-                self.write(" ", color)
+                self.write(' ', color)
                 text = text[:-1]
                 pass
             self.last_was_nl = True
-            if "" == text:
-                return
-            while text[-1] == "\n":
+            if '' == text: return
+            while text[-1] == '\n':
                 self.write_nl()
                 text = text[:-1]
-                if "" == text:
-                    return
+                if '' == text: return
                 pass
             pass
         else:
             self.last_was_nl = False
             pass
         self.in_list = False
         if last_last_nl:
-            if " * " == text[0:3]:
-                self.in_list = True
-            elif "  " == text[0:2]:
-                self.verbatim = self.verbatim or True
+            if ' * ' == text[0:3]: self.in_list = True
+            elif '  ' == text[0:2]: self.verbatim = self.verbatim or True
             pass
 
         # FIXME: there may be nested lists, tables and so on.
         if self.verbatim:
             self.write_verbatim(text)
         elif self.in_list:
             # FIXME:
-            self.write(
-                text, color,
-            )
+            self.write(text, color,)
         else:
             words = re.compile("[ \t]+").split(text)
             for word in words[:-1]:

trepan/processor/command/base_cmd.py

@@ -27,19 +27,18 @@
 
 from trepan.lib import format as Mformat
 
-__all__ = ['DebuggerCommand']
+__all__ = ["DebuggerCommand"]
 
 
 class DebuggerCommand:
     """Base Class for Debugger commands. We pull in some helper
     functions for command from module cmdfns."""
 
-    category = 'misc'
+    category = "misc"
 
     @staticmethod
-    def setup(l, category="misc", min_args=0, max_args=None,
-              need_stack=False):
-        l["name"] =l["__module__"].split(".")[-1]
+    def setup(l, category="misc", min_args=0, max_args=None, need_stack=False):
+        l["name"] = l["__module__"].split(".")[-1]
         l["category"] = category
         l["min_args"] = min_args
         l["max_args"] = max_args
@@ -57,20 +56,19 @@ def __init__(self, proc):
         # execution like errmsg(), msg(), and msg_nocr() might. (See
         # the note below on these latter 3 methods.)
         #
-        self.core     = proc.core
+        self.core = proc.core
         self.debugger = proc.debugger
         self.settings = self.debugger.settings
         return
 
     aliases = ()
-    name    = 'YourCommandName'
+    name = "YourCommandName"
 
     def columnize_commands(self, commands):
         """List commands arranged in an aligned columns"""
         commands.sort()
-        width = self.debugger.settings['width']
-        return columnize.columnize(commands, displaywidth=width,
-                                   lineprefix='    ')
+        width = self.debugger.settings["width"]
+        return columnize.columnize(commands, displaywidth=width, lineprefix="    ")
 
     def confirm(self, msg, default=False):
         """ Convenience short-hand for self.debugger.intf[-1].confirm """
@@ -85,7 +83,7 @@ def confirm(self, msg, default=False):
     def errmsg(self, msg, opts={}):
         """ Convenience short-hand for self.debugger.intf[-1].errmsg """
         try:
-            return(self.debugger.intf[-1].errmsg(msg))
+            return self.debugger.intf[-1].errmsg(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
@@ -94,7 +92,7 @@ def errmsg(self, msg, opts={}):
     def msg(self, msg, opts={}):
         """ Convenience short-hand for self.debugger.intf[-1].msg """
         try:
-            return(self.debugger.intf[-1].msg(msg))
+            return self.debugger.intf[-1].msg(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
@@ -103,17 +101,19 @@ def msg(self, msg, opts={}):
     def msg_nocr(self, msg, opts={}):
         """ Convenience short-hand for self.debugger.intf[-1].msg_nocr """
         try:
-            return(self.debugger.intf[-1].msg_nocr(msg))
+            return self.debugger.intf[-1].msg_nocr(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
         return None
 
     def rst_msg(self, text, opts={}):
         """Convert ReStructuredText and run through msg()"""
-        text = Mformat.rst_text(text,
-                                'plain' == self.debugger.settings['highlight'],
-                                self.debugger.settings['width'])
+        text = Mformat.rst_text(
+            text,
+            "plain" == self.debugger.settings["highlight"],
+            self.debugger.settings["width"],
+        )
         return self.msg(text)
 
     def run(self, args):
@@ -125,15 +125,17 @@ def run(self, args):
     pass
 
     def section(self, message, opts={}):
-        if 'plain' != self.settings['highlight']:
-            message = colorize('bold', message)
+        if "plain" != self.settings["highlight"]:
+            message = colorize("bold", message)
         else:
-            message += "\n" + '-' * len(message)
+            message += "\n" + "-" * len(message)
             pass
         self.msg(message)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     from trepan.processor.command import mock
+
     d, cp = mock.dbg_setup()
     dd = DebuggerCommand(cp)
     dd.msg("hi")

trepan/processor/command/condition.py

@@ -14,8 +14,6 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import os
-
 from trepan.processor.command.base_cmd import DebuggerCommand
 from trepan.processor.complete import complete_bpnumber
 

trepan/processor/command/info_subcmd/lines.py

@@ -14,21 +14,23 @@
 #   You should have received a copy of the GNU General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import sys
+from getopt import getopt, GetoptError
+
 # Our local modules
 from trepan.processor.command.base_subcmd import DebuggerSubcommand
 from trepan.misc import pretty_modfunc_name
 from pyficache import cache_code_lines
 
 
 class InfoOffsets(DebuggerSubcommand):
-    """**info lines** [*function-file-or-module*]
-
-Show line - function/offste information for a function, module, or a file.
+    """**info lines** [-n *function-or-module*]
 
-If no location is given, use the the current frame.
+Show line - function/offset information
+Use -n *function-or-module* to filter results.
 
-Example
--------
+Examples
+--------
 
     (trepan3k) info lines
     Line - (fn, start offset) table for test/example/gcd.py
@@ -41,6 +43,14 @@ class InfoOffsets(DebuggerSubcommand):
       18: check_args() @36    31: gcd() @8             44: <module> @60
       19: check_args() @38    34: gcd() @18            45: <module> @84
       20: check_args() @70    35: gcd() @26
+    (trepan3k) info lines -n <module>
+      10: <module> @0    11: <module> @4   13: <module> @12
+      40: <module> @28   26: <module> @20  41: <module> @36
+      43: <module> @42   44: <module> @60  45: <module> @84
+    (trepan3k) info lines -n gcd
+      30: gcd() @0   31: gcd() @8   34: gcd() @18
+      35: gcd() @26  36: gcd() @30  37: gcd() @50
+      38: gcd() @54
 
 See also:
 ---------
@@ -54,42 +64,60 @@ class InfoOffsets(DebuggerSubcommand):
     def run(self, args):
         """Current line number in source file"""
         # info line <loc>
-        if len(args) == 0:
-            curframe = self.proc.curframe
-            if not curframe:
-                self.errmsg("No line number information available.")
+        try:
+            opts, args = getopt(args, "hn:", ["help", "name"],)
+        except GetoptError:
+            # print help information and exit:
+            self.errmsg(
+                str(sys.exc_info()[1])
+            )  # will print something like "option -a not recognized"
+            return
+
+        name = None
+        for o, a in opts:
+            if o in ("-h", "--help"):
+                self.proc.commands["help"].run(["help", "info", "lines"])
                 return
+            elif o in ("-n", "--name"):
+                name = a
+            else:
+                self.errmsg("unhandled option '%s'" % o)
+            pass
+        pass
 
-            # No line number. Use current frame line number
-            filename = curframe.f_code.co_filename
-            file_info = cache_code_lines(
-                filename, toplevel_only=False, include_offsets=True
-            )
-            if file_info:
-                self.section("Line - (fn, start offset) table for %s" % filename)
-                lines = []
-                for line_number, line_info in file_info.line_numbers.items():
+        curframe = self.proc.curframe
+        if not curframe:
+            self.errmsg("No line number information available.")
+            return
+
+        # No line number. Use current frame line number
+        filename = curframe.f_code.co_filename
+        file_info = cache_code_lines(
+            filename, toplevel_only=False, include_offsets=True
+        )
+        if file_info:
+            self.section("Line - (fn, start offset) table for %s" % filename)
+            lines = []
+            for line_number, line_info in file_info.line_numbers.items():
+                if not name or any(li.name == name for li in line_info):
                     lines.append(
                         "%4d: %s"
                         % (
                             line_number,
                             ", ".join(
                                 [
                                     "%s @%d" % (pretty_modfunc_name(li.name), li.offsets[0])
-                                    for li in line_info
+                                    for li in line_info if not name or li.name == name
                                 ]
                             ),
                         )
                     )
-                m = self.columnize_commands(list(sorted(lines)))
-                self.msg(m)
-            else:
-                self.errmsg("haven't recorded info for offset file %s" % filename)
-                pass
-            pass
+            m = self.columnize_commands(list(sorted(lines)))
+            self.msg(m)
         else:
-            self.errmsg("Passing a filename, function, or module not completed yet...")
-        return
+            self.errmsg("haven't recorded info for offset file %s" % filename)
+            pass
+        pass
 
     pass