_app_ff_chrome_opera.py

"""A command module for Dragonfly, for controlling the browsers
Firefox, Chrome (and Chromium), and Opera.

-----------------------------------------------------------------------------
Licensed under the LGPL3.

"""
from dragonfly import (
    MappingRule,
    AppContext,
    IntegerRef,
    Grammar,
)

from lib.dynamic_aenea import (
    DynamicAction,
    DynamicContext,
    Key,
)

from aenea.proxy_contexts import ProxyAppContext as NixAppContext


mapping = {
   "go back [<n>]": Key("a-left/15:%(n)d"),
   "go forward [<n>]": Key("a-right/15:%(n)d"),
   "[open] new window": Key("c-n"),
   "close window": Key("cs-w"),
   "undo close window": Key("cs-n"),
   "[open] new tab": Key("c-t"),
   "close tab": Key("c-w"),
   "close <n> tabs": Key("c-w/20:%(n)d"),
   "[go to] next tab [<n>]": Key("c-tab:%(n)d"),
   "[go to] previous tab [<n>]": Key("cs-tab:%(n)d"),
   "(restore|undo close) tab": Key("cs-t"),
   "go to search [bar]": Key("c-k"),
   "go to address [bar]": Key("a-d"),
   "go to top": Key("home"),
   "go to bottom": Key("end"),
   "copy address": Key("a-d/10, c-c/10"),
   "paste address": Key("a-d/10, c-v/10"),
   "go home": Key("a-home"),
   "stop loading": Key("escape"),
   "reload [page]": Key("f5"),

   "bookmark [this] page": Key("c-d"),

   "normal text size": Key("c-0"),
   "decrease text size [<n>]": Key("c-minus:%(n)d"),
   "increase text size [<n>]": Key("cs-plus:%(n)d"),

   "find in page": Key("c-f"),
   "close find": Key("escape"),
   "find previous [<n>]": Key("s-f3/10:%(n)d"),
   "find next [<n>]": Key("f3/10:%(n)d"),

   "go to tab [<n>]": DynamicAction(Key("c-%(n)d"), Key("a-%(n)d")) # Not supported by Opera.
}

nixContext1 = NixAppContext(executable="firefox", title="Firefox")
nixContext2 = NixAppContext(executable="chrome", title="Chrome")
nixContext3 = NixAppContext(executable="chrome", title="Chromium")
nixContext4 = NixAppContext(executable="opera", title="Opera")
nixContext = nixContext1 | nixContext2 | nixContext3 | nixContext4

winContext1 = AppContext(executable="firefox", title="Firefox")
winContext2 = AppContext(executable="chrome", title="Chrome")
winContext3 = AppContext(executable="chrome", title="Chromium")
winContext4 = AppContext(executable="opera", title="Opera")
winContext = winContext1 | winContext2 | winContext3 | winContext4


rules = MappingRule(
    mapping=mapping,
    extras=[
        IntegerRef("n", 1, 100),
    ],
    defaults={
        "n": 1
    }
)


grammar = Grammar("FF, Chrome, and Opera", context=DynamicContext(winContext, nixContext))
grammar.add_rule(rules)
grammar.load()


def unload():
    """Unload function which will be called at unload time."""
    global grammar
    if grammar:
        grammar.unload()
    grammar = None