qutebrowser/qutebrowser/commands/commands.py

# Copyright 2014 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# This file is part of qutebrowser.
#
# qutebrowser 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.
#
# qutebrowser 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 qutebrowser.  If not, see <http://www.gnu.org/licenses/>.

"""All command classes.

These are automatically propagated from commands.utils
via inspect.

A command class can set the following properties:

    nargs -- Number of arguments. Either a number, '?' (0 or 1), '+' (1 or
             more), or '*' (any). Default: 0
    name -- The name of the command, or a list of aliases.
    split_args -- If arguments should be split or not. Default: True
    count -- If the command supports a count. Default: False
    hide -- If the command should be hidden in tab completion. Default: False

"""

from qutebrowser.commands.template import Command


class Open(Command):

    """Open a page in the current or [count]th tab.

    arg: The URL to open.

    """

    nargs = 1
    split_args = False
    count = True


class OpenCur(Command):

    """Fill the statusbar with :open and the current url."""

    nargs = 0
    hide = True


class TabOpen(Command):

    """Open a page in a new tab.

    arg: The URL to open.

    """

    nargs = 1
    split_args = False


class TabOpenCur(Command):

    """Fill the statusbar with :tabopen and the current url."""

    nargs = 0
    hide = True


class TabClose(Command):

    """Close the current tab, or tab [count]."""

    nargs = 0
    count = True


class TabNext(Command):

    """Switch to the next tab, or skip [count] tabs."""

    nargs = 0
    count = True


class TabPrev(Command):

    """Switch to the previous tab, or skip [count] tabs."""

    nargs = 0
    count = True


class Quit(Command):

    """Quit qutebrowser."""

    name = ['quit', 'q']
    nargs = 0


class Reload(Command):

    """Reload the current page, or the page in tab [count]."""

    nargs = 0
    count = True


class Stop(Command):

    """Stop loading the current page, or the page in tab [count]."""

    nargs = 0
    count = True


class Back(Command):

    """Go back one/[count] page(s) in the history."""

    nargs = 0
    count = True


class Forward(Command):

    """Go forward one/[count] page(s) in the history."""

    nargs = 0
    count = True


class Print(Command):

    """Print the current page, or the page in tab [count]."""

    nargs = 0
    count = True


class Scroll(Command):

    """Scroll in x/y direction by a number of pixels.

    arg 1: delta x
    arg 2: delta y
    count: multiplicator

    """

    nargs = 2
    count = True
    hide = True


class ScrollPage(Command):

    """Scroll N pages up/down.

    arg 1: pages in x-direction
    arg 2: pages in y-direction
    count: multiplicator

    """

    nargs = 2
    count = True
    hide = True
    name = 'scroll_page'


class Undo(Command):

    """Undo closing a tab."""

    nargs = 0


class ScrollPercX(Command):

    """Scroll N percent horizontally.

    optional arg: How many percent to scroll.
    count: How many percent to scroll.

    """

    nargs = '?'
    count = True
    hide = True
    name = 'scroll_perc_x'


class ScrollPercY(Command):

    """Scroll N percent vertically.

    optional arg: How many percent to scroll.
    count: How many percent to scroll.

    """

    nargs = '?'
    count = True
    hide = True
    name = 'scroll_perc_y'


class PyEval(Command):

    """Evaluate python code.

    arg: The python code to evaluate.

    """

    nargs = 1
    split_args = False


class NextSearch(Command):

    """Jump to the next or [count]th next search term."""

    nargs = 0
    hide = True
    count = True


class Yank(Command):

    """Yank the URL of the current tab to the clipboard.

    optional arg: If 'sel', yank to the primary selection.

    """

    nargs = '?'


class YankTitle(Command):

    """Yank the title of the current tab to the clipboard.

    optional arg: If 'sel', yank to the primary selection.

    """

    nargs = '?'


class Paste(Command):

    """Open an URL from the clipboard.

    optional arg: If 'sel', paste from the primary selection.

    """

    nargs = '?'


class TabPaste(Command):

    """Open an URL from the clipboard in a new tab.

    optional arg: If 'sel', paste from the primary selection.

    """

    nargs = '?'


class ZoomIn(Command):

    """Zoom in in the current tab."""

    nargs = 0
    count = True


class ZoomOut(Command):

    """Zoom out in the current tab."""

    nargs = 0
    count = True


class Crash(Command):

    """Simply raise an exception for debugging."""

    nargs = 0
    hide = True