gdb-gui/gui/commands.py

# Copyright (C) 2012, 2013, 2015, 2016 Tom Tromey <tom@tromey.com>

# 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/>.

import gdb
import gui.startup
import gui.source
import gui.stack
import gui.logwindow
import gui.toplevel
import gui.dprintf
import gui.events
import gui.display
import gui.gdbutil
import gui.adapt
import re
from gui.startup import in_gtk_thread


class GuiCommand(gdb.Command):
    def __init__(self):
        super(GuiCommand, self).__init__("gui", gdb.COMMAND_SUPPORT, prefix=True)


class GuiSourceCommand(gdb.Command):
    """Create a new source window.
    Usage: gui source
    This creates a new source window in the GUI.  Any number of source
    windows can be created."""

    def __init__(self):
        super(GuiSourceCommand, self).__init__("gui source", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        gui.source.lru_handler.new_source_window()


class GuiStackCommand(gdb.Command):
    """Create a new stack window.
    Usage: gui stack
    This creates a stack window in the GUI if it does not already exist."""

    def __init__(self):
        super(GuiStackCommand, self).__init__("gui stack", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        # FIXME does it make sense to have more than one?  Maybe if
        # we have thread-locking.
        # FIXME could have arguments to set various stack flags,
        # like whether to show child frames, or just show raw,
        # or maybe even whatever 'bt' takes?
        gui.stack.show_stack()


class GuiListCommand(gdb.Command):
    """List some source code in a source window.
    Usage: gui list LINESPEC
    This command uses LINESPEC to show some source code in a source
    window.  If a source window is already available, the source is
    displayed there.  Otherwise, a new source window is made.
    LINESPEC is a line specification of the form given to 'break'."""

    def __init__(self):
        super(GuiListCommand, self).__init__("gui list", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        (extra, sals) = gdb.decode_line(arg)
        if extra is not None:
            raise gdb.GdbError("unrecognized junk at end of command: " + extra)
        if sals is None:
            raise gdb.GdbError("not found")
        if len(sals) > 1:
            print("Ambiguous linespec, only showing first result")
        sal = sals[0]
        if sal.symtab is None or sal.symtab.filename is None:
            raise gdb.GdbError("could not find file for symbol")
        gui.source.lru_handler.show_source_gdb(
            None, sal.symtab, sal.symtab.fullname(), sal.line
        )


class GuiShowCommand(gdb.Command):
    """Show the source for a symbol in a source window.
    Usage: gui show SYMBOL
    This command looks for the definition of SYMBOL in the program and
    shows its source location in a source window.  If a source window is
    already available, the source is displayed there.  Otherwise, a new
    source window is made."""

    def __init__(self):
        super(GuiShowCommand, self).__init__("gui show", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        try:
            (symbol, ignore) = gdb.lookup_symbol(arg)
        except gdb.error as e:
            if gui.gdbutil.is_running():
                raise
            symbol = gdb.lookup_global_symbol(arg)
        if symbol is None:
            raise gdb.GdbError("symbol " + arg + " not found")
        if symbol.symtab is None or symbol.symtab.filename is None:
            raise gdb.GdbError(
                "symbol " + arg + " does not seem to have an associated file"
            )
        gui.source.lru_handler.show_source_gdb(
            None, symbol.symtab, symbol.symtab.fullname(), symbol.line
        )


class GuiLogWindowCommand(gdb.Command):
    """Create a new log window.
    Usage: gui log
    This creates a new "log" window in the GUI.  A log window is used
    to display output from "gui print", "gui printf", "gui output",
    and "gui dprintf".

    Multiple log windows can be created and output can be directed to
    a given instance using the "@" syntax, like:

    gui print @5 variable"""

    def __init__(self):
        super(GuiLogWindowCommand, self).__init__("gui log", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        window = gui.logwindow.LogWindow()
        print("Created log window %d; now the default" % window.number)


class GuiPrintBase(gdb.Command):
    def __init__(self, command):
        super(GuiPrintBase, self).__init__("gui " + command, gdb.COMMAND_SUPPORT)
        self.command = command

    # Given ARG, return a pair (WINDOW, NEW_ARG).
    def _parse_arg(self, arg, do_default=True):
        arg = arg.strip()
        match = re.match("@(\\d+)\\s+(.*)$", arg)
        if match is not None:
            winno = int(match.group(1))
            arg = match.group(2)
            window = gui.toplevel.state.get(winno)
            if window is None:
                raise gdb.GdbError("could not find window %d" % winno)
            if not isinstance(window, gui.logwindow.LogWindow):
                raise gdb.GdbError("window %d is not a log window" % winno)
        elif do_default:
            window = gui.logwindow.default_log_window
            if window is None:
                raise gdb.GdbError("no default log window")
        else:
            window = None
        return (window, arg)

    def invoke(self, arg, from_tty):
        (window, arg) = self._parse_arg(arg)
        text = gdb.execute(self.command + " " + arg, from_tty, True)
        window.append(text)


class GuiPrintCommand(GuiPrintBase):
    """Print to a gui log window.
    Usage: gui print [@N] ARGS
    This is a wrapper for the "print" command that redirects its output
    to a "gui log" window.  If "@N" is given, then output goes to that
    window; otherwise, output goes to the most recently created log window."""

    def __init__(self):
        super(GuiPrintCommand, self).__init__("print")


class GuiOutputCommand(GuiPrintBase):
    """Output to a gui log window.
    Usage: gui output [@N] ARGS
    This is a wrapper for the "output" command that redirects its output
    to a "gui log" window.  If "@N" is given, then output goes to that
    window; otherwise, output goes to the most recently created log window."""

    def __init__(self):
        super(GuiOutputCommand, self).__init__("output")


class GuiPrintfCommand(GuiPrintBase):
    """printf to a gui log window.
    Usage: gui printf [@N] ARGS
    This is a wrapper for the "printf" command that redirects its output
    to a "gui log" window.  If "@N" is given, then output goes to that
    window; otherwise, output goes to the most recently created log window."""

    def __init__(self):
        super(GuiPrintfCommand, self).__init__("printf")


class GuiDprintfCommand(GuiPrintBase):
    """dprintf to a gui log window.
    Usage: gui dprintf [@N] ARGS
    This is a wrapper for the "dprintf" command that redirects its output
    to a "gui log" window.  If "@N" is given, then output goes to that
    window; otherwise, output goes to the most recently created log window."""

    def __init__(self):
        super(GuiDprintfCommand, self).__init__("dprintf")

    def invoke(self, arg, from_tty):
        (window, arg) = self._parse_arg(arg, False)
        orig_arg = arg
        (ignore, arg) = gdb.decode_line(arg)
        if arg is None:
            raise gdb.GdbError("no printf arguments to 'gui dprintf'")
        arg = arg.strip()
        if not arg.startswith(","):
            raise gdb.GdbError("comma expected after linespec")
        arg = arg[1:]
        spec = arg[0 : -len(arg)]
        DPrintfBreakpoint(spec, window, arg)


class GuiDisplayCommand(gdb.Command):
    """Create a new display window.
    Usage: gui display [-diff] COMMAND

    A display window runs a gdb command after operations that change the
    current frame or that cause the inferior to stop.  If "-diff" is
    given, then every time the display is updated, changed lines are
    highlighted."""

    def __init__(self):
        super(GuiDisplayCommand, self).__init__("gui display", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        diff = False
        if arg.startswith("-diff "):
            diff = True
            arg = arg[6:]
        gui.display.DisplayWindow(arg, diff)

    def complete(self, text, word):
        # FIXME, see
        # https://sourceware.org/bugzilla/show_bug.cgi?id=13077
        return None


class InfoWindowsCommand(gdb.Command):
    """List all the GUI windows.
    Usage: info windows
    This lists all the GUI windows.
    Note that this should not be confused with "info win", which is
    part of the TUI."""

    def __init__(self):
        super(InfoWindowsCommand, self).__init__("info windows", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        gui.toplevel.state.display()


class DeleteWindowsCommand(gdb.Command):
    """Delete a GUI window.
    Usage: delete window N
    Delete GUI window number N.
    A window's number appears in its title bar, and can also be
    found using "info windows"."""

    def __init__(self):
        super(DeleteWindowsCommand, self).__init__("delete window", gdb.COMMAND_SUPPORT)

    def invoke(self, arg, from_tty):
        self.dont_repeat()
        winno = int(arg)
        window = gui.toplevel.state.get(winno)
        if window is not None:
            window.destroy()


GuiCommand()
GuiSourceCommand()
GuiStackCommand()
GuiLogWindowCommand()
GuiPrintCommand()
GuiOutputCommand()
GuiPrintfCommand()
GuiDprintfCommand()
GuiDisplayCommand()
GuiListCommand()
GuiShowCommand()
InfoWindowsCommand()
DeleteWindowsCommand()

_can_override = False

# A temporary test to see if you have a gdb that supports this.
class TestCommand(gdb.Command):
    """A temporary test command created for the GUI.
    This does nothing, the GUI startup code uses it to see if
    your copy of gdb has some command-overriding support."""

    def __init__(self, set_it):
        super(TestCommand, self).__init__("maint gui-test", gdb.COMMAND_DATA)
        self.set_it = set_it

    def invoke(self, arg, from_tty):
        if self.set_it:
            global _can_override
            _can_override = True
        else:
            try:
                super(TestCommand, self).invoke(arg, from_tty)
            except:
                pass


TestCommand(True)
TestCommand(False).invoke("", 0)

# See framecache.py - we prefer the before_prompt event if it exists;
# but otherwise try the overriding approach.  Both of these rely on a
# hacked gdb :-(
if _can_override and not hasattr(gdb.events, "before_prompt"):

    class Overrider(gdb.Command):
        def __init__(self, name, event):
            super(Overrider, self).__init__(name, gdb.COMMAND_DATA)
            self.event = event

        def invoke(self, arg, from_tty):
            super(Overrider, self).invoke(arg, from_tty)
            self.event.post()

    Overrider("up", gui.events.frame_changed)
    Overrider("down", gui.events.frame_changed)
    Overrider("frame", gui.events.frame_changed)