hotkeys.py

# -*- coding: utf-8 -*-
"""
Anki Add-on: Hint Hotkeys

Adds two hotkeys to the reviewer: 'H' to reveal hints one by one,
'G' to reveal all hints at once.

Based on "Hint-peeking Keyboard Bindings" by Ben Lickly

Copyright:  (c) Ben Lickly 2012 <blickly at berkeley dot edu>
            (c) Glutanimate 2016-2017 <https://glutanimate.com/>
License: GNU AGPLv3 or later <https://www.gnu.org/licenses/agpl.html>
"""

from __future__ import unicode_literals

############## USER CONFIGURATION START ##############

# Shortcuts need to be single keys on Anki 2.0.x
# Key combinations are supported on Anki 2.1.x

# Shortcut that will reveal the hint fields one by one:
SHORTCUT_INCREMENTAL = "H"
# Shortcut that will reveal all hint fields at once:
SHORTCUT_ALL = "G"
UNDO = "8"
TAG = "7"
PLAY_AUDIO = "5"

TAG_TEXT = "mmk"
##############  USER CONFIGURATION END  ##############

from aqt.qt import *
from aqt import mw
import aqt
from aqt.reviewer import Reviewer

from anki.hooks import wrap, addHook
from anki import version as ankiversion


def _newKeyHandler(self, evt, _old):
    """Add shortcuts on Anki 2.0.x"""
    if evt.key() == QKeySequence(SHORTCUT_INCREMENTAL)[0]:
        _showHint(incremental=True)
    elif evt.key() == QKeySequence(SHORTCUT_ALL)[0]:
        _showHint()
    elif evt.key() == QKeySequence(UNDO)[0]:
        mw.onUndo()
    return _old(self, evt)



def suspend_and_tag():
    mw.checkpoint("Set already known focus morph")
    f = mw.reviewer.card.note()
    f.addTag(TAG_TEXT)
    f.flush()

    # "new counter" might have been decreased (but "new card" was not answered
    # so it shouldn't) -> this function recomputes "new counter"
    mw.col.reset()
    # skip card
    # mw.reviewer.nextCard()
    mw.reviewer.onSuspend()


def replay():
    mw.reviewer.replayAudio()

def _addShortcuts(shortcuts):
    """Add shortcuts on Anki 2.1.x"""
    additions = (
        (SHORTCUT_INCREMENTAL, lambda: _showHint(incremental=True)),
        (SHORTCUT_ALL, _showHint),
        (UNDO, mw.onUndo),
        (PLAY_AUDIO, replay),
        (TAG, suspend_and_tag)
    )
    shortcuts += additions


def _showHint(incremental=False):
    """Show hint by activating corresponding links."""
    mw.web.eval("""
     var customEvent = document.createEvent('MouseEvents');
     customEvent.initEvent('click', false, true);
     var arr = document.getElementsByTagName('a');
     // Cloze Overlapper support
     if (typeof olToggle === "function") { 
         olToggle();
     }
     // Image Occlusion Enhanced support
     var ioBtn = document.getElementById("io-revl-btn");
     if (!(typeof ioBtn === 'undefined' || !ioBtn)) { 
         ioBtn.click();
     }
     for (var i=0; i<arr.length; i++) {
        var l=arr[i];
        if (l.style.display === 'none') {
          continue;
        }
        if (l.href.charAt(l.href.length-1) === '#') {
          l.dispatchEvent(customEvent);
          if ('%s' === 'True') {
            break;
          }
        }
     }
     """ % incremental)


# Hooks and Patches

if ankiversion.startswith("2.0"): # 2.0.x
    Reviewer._keyHandler = wrap(
        Reviewer._keyHandler, _newKeyHandler, "around")
else: # 2.1.x
    addHook("reviewStateShortcuts", _addShortcuts)