X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FKeyMap.cpp;h=51aefe560e5b29fed2536b11d236c0e24e783c6f;hb=19bec6e8bc13c00c528392cb77826dc7de3f68e8;hp=67384b5adffb43dfa7eef489ad830929fd8852b8;hpb=b89cc942eb458284f40f4d4e7db58890c3288979;p=lyx.git diff --git a/src/KeyMap.cpp b/src/KeyMap.cpp index 67384b5adf..51aefe560e 100644 --- a/src/KeyMap.cpp +++ b/src/KeyMap.cpp @@ -3,10 +3,10 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author John Levon - * \author André Pönitz + * \author André Pönitz * * Full author contact details are available in file CREDITS. */ @@ -15,13 +15,18 @@ #include "KeyMap.h" -#include "support/debug.h" #include "KeySequence.h" #include "LyXAction.h" #include "Lexer.h" +#include "support/debug.h" #include "support/docstream.h" +#include "support/FileName.h" #include "support/filetools.h" +#include "support/gettext.h" +#include "support/lstrings.h" + +#include "frontends/alert.h" #include #include @@ -84,12 +89,100 @@ size_t KeyMap::unbind(string const & seq, FuncRequest const & func) } -bool KeyMap::hasBinding(KeySequence const & seq, FuncRequest const & func, - unsigned int r) +void KeyMap::bind(KeySequence * seq, FuncRequest const & func, unsigned int r) +{ + KeySymbol code = seq->sequence[r]; + if (!code.isOK()) + return; + + KeyModifier const mod1 = seq->modifiers[r].first; + KeyModifier const mod2 = seq->modifiers[r].second; + + // check if key is already there + Table::iterator end = table.end(); + for (Table::iterator it = table.begin(); it != end; ++it) { + if (code == it->code + && mod1 == it->mod.first + && mod2 == it->mod.second) { + // overwrite binding + if (r + 1 == seq->length()) { + LYXERR(Debug::KBMAP, "Warning: New binding for '" + << to_utf8(seq->print(KeySequence::Portable)) + << "' is overriding old binding..."); + if (it->prefixes.get()) { + it->prefixes.reset(); + } + it->func = func; + it->func.origin = FuncRequest::KEYBOARD; + return; + } else if (!it->prefixes.get()) { + lyxerr << "Error: New binding for '" + << to_utf8(seq->print(KeySequence::Portable)) + << "' is overriding old binding..." + << endl; + return; + } else { + it->prefixes->bind(seq, func, r + 1); + return; + } + } + } + + Table::iterator newone = table.insert(table.end(), Key()); + newone->code = code; + newone->mod = seq->modifiers[r]; + if (r + 1 == seq->length()) { + newone->func = func; + newone->func.origin = FuncRequest::KEYBOARD; + newone->prefixes.reset(); + } else { + newone->prefixes.reset(new KeyMap); + newone->prefixes->bind(seq, func, r + 1); + } +} + + +void KeyMap::unbind(KeySequence * seq, FuncRequest const & func, unsigned int r) +{ + KeySymbol code = seq->sequence[r]; + if (!code.isOK()) + return; + + KeyModifier const mod1 = seq->modifiers[r].first; + KeyModifier const mod2 = seq->modifiers[r].second; + + // check if key is already there + Table::iterator end = table.end(); + Table::iterator remove = end; + for (Table::iterator it = table.begin(); it != end; ++it) { + if (code == it->code + && mod1 == it->mod.first + && mod2 == it->mod.second) { + // remove + if (r + 1 == seq->length()) { + if (it->func == func) { + remove = it; + if (it->prefixes.get()) + it->prefixes.reset(); + } + } else if (it->prefixes.get()) { + it->prefixes->unbind(seq, func, r + 1); + if (it->prefixes->empty()) + remove = it; + return; + } + } + } + if (remove != end) + table.erase(remove); +} + + +FuncRequest KeyMap::getBinding(KeySequence const & seq, unsigned int r) { KeySymbol code = seq.sequence[r]; if (!code.isOK()) - return false; + return FuncRequest::unknown; KeyModifier const mod1 = seq.modifiers[r].first; KeyModifier const mod2 = seq.modifiers[r].second; @@ -101,12 +194,12 @@ bool KeyMap::hasBinding(KeySequence const & seq, FuncRequest const & func, && mod1 == it->mod.first && mod2 == it->mod.second) { if (r + 1 == seq.length()) - return it->func == func; - else if (it->table.get()) - return it->table->hasBinding(seq, func, r + 1); + return it->func; + else if (it->prefixes.get()) + return it->prefixes->getBinding(seq, r + 1); } } - return false; + return FuncRequest::unknown; } @@ -116,74 +209,95 @@ void KeyMap::clear() } -namespace { - -enum BindTags { - BN_BIND, - BN_BINDFILE, - BN_UNBIND, -}; +bool KeyMap::read(string const & bind_file, KeyMap * unbind_map, BindReadType rt) +{ + FileName bf = i18nLibFileSearch("bind", bind_file, "bind"); + if (bf.empty()) { + if (rt == MissingOK) + return true; + + lyxerr << "Could not find bind file: " << bind_file; + if (rt == Default) { + frontend::Alert::warning(_("Could not find bind file"), + bformat(_("Unable to find the bind file\n%1$s.\n" + "Please check your installation."), from_utf8(bind_file))); + return false; + } -keyword_item bindTags[] = { - { "\\bind", BN_BIND }, - { "\\bind_file", BN_BINDFILE }, - { "\\unbind", BN_UNBIND }, -}; + static string const defaultBindfile = "cua"; + if (bind_file == defaultBindfile) { + frontend::Alert::warning(_("Could not find `cua.bind' file"), + _("Unable to find the default bind file `cua.bind'.\n" + "Please check your installation.")); + return false; + } + // Try it with the default file. + frontend::Alert::warning(_("Could not find bind file"), + bformat(_("Unable to find the bind file\n%1$s.\n" + "Falling back to default."), from_utf8(bind_file))); + return read(defaultBindfile, unbind_map); + } + return read(bf, unbind_map); } -bool KeyMap::read(string const & bind_file, KeyMap * unbind_map) +bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map) { - const int bindCount = sizeof(bindTags) / sizeof(keyword_item); - - Lexer lexrc(bindTags, bindCount); + enum { + BN_BIND, + BN_BINDFILE, + BN_UNBIND, + }; + + LexerKeyword bindTags[] = { + { "\\bind", BN_BIND }, + { "\\bind_file", BN_BINDFILE }, + { "\\unbind", BN_UNBIND }, + }; + + Lexer lexrc(bindTags); if (lyxerr.debugging(Debug::PARSER)) lexrc.printTable(lyxerr); - FileName const tmp(i18nLibFileSearch("bind", bind_file, "bind")); - lexrc.setFile(tmp); + lexrc.setFile(bind_file); if (!lexrc.isOK()) { - lyxerr << "KeyMap::read: cannot open bind file:" - << tmp << endl; + LYXERR0("KeyMap::read: cannot open bind file:" << bind_file.absFilename()); return false; } - LYXERR(Debug::KBMAP, "Reading bind file:" << tmp); + LYXERR(Debug::KBMAP, "Reading bind file:" << bind_file.absFilename()); bool error = false; while (lexrc.isOK()) { switch (lexrc.lex()) { + case Lexer::LEX_UNDEF: lexrc.printError("Unknown tag `$$Token'"); error = true; continue; + case Lexer::LEX_FEOF: continue; - case BN_BIND: - { - string seq, cmd; - if (lexrc.next()) { - seq = lexrc.getString(); - } else { + case BN_BIND: { + if (!lexrc.next()) { lexrc.printError("BN_BIND: Missing key sequence"); error = true; break; } + string seq = lexrc.getString(); - if (lexrc.next(true)) { - cmd = lexrc.getString(); - } else { + if (!lexrc.next(true)) { lexrc.printError("BN_BIND: missing command"); error = true; break; } + string cmd = lexrc.getString(); FuncRequest func = lyxaction.lookupFunc(cmd); - if (func. action == LFUN_UNKNOWN_ACTION) { - lexrc.printError("BN_BIND: Unknown LyX" - " function `$$Token'"); + if (func.action == LFUN_UNKNOWN_ACTION) { + lexrc.printError("BN_BIND: Unknown LyX function `$$Token'"); error = true; break; } @@ -191,28 +305,24 @@ bool KeyMap::read(string const & bind_file, KeyMap * unbind_map) bind(seq, func); break; } - case BN_UNBIND: - { - string seq, cmd; - if (lexrc.next()) { - seq = lexrc.getString(); - } else { + case BN_UNBIND: { + if (!lexrc.next()) { lexrc.printError("BN_UNBIND: Missing key sequence"); error = true; break; } + string seq = lexrc.getString(); - if (lexrc.next(true)) { - cmd = lexrc.getString(); - } else { + if (!lexrc.next(true)) { lexrc.printError("BN_UNBIND: missing command"); error = true; break; } + string cmd = lexrc.getString(); FuncRequest func = lyxaction.lookupFunc(cmd); - if (func. action == LFUN_UNKNOWN_ACTION) { + if (func.action == LFUN_UNKNOWN_ACTION) { lexrc.printError("BN_UNBIND: Unknown LyX" " function `$$Token'"); error = true; @@ -225,23 +335,21 @@ bool KeyMap::read(string const & bind_file, KeyMap * unbind_map) unbind(seq, func); break; } + case BN_BINDFILE: - if (lexrc.next()) { - string const tmp(lexrc.getString()); - error |= !read(tmp, unbind_map); - } else { + if (!lexrc.next()) { lexrc.printError("BN_BINDFILE: Missing file name"); error = true; break; - } + string const tmp = lexrc.getString(); + error |= !read(tmp, unbind_map); break; } } if (error) - lyxerr << "KeyMap::read: error while reading bind file:" - << tmp << endl; + LYXERR0("KeyMap::read: error while reading bind file:" << bind_file.absFilename()); return !error; } @@ -249,7 +357,7 @@ bool KeyMap::read(string const & bind_file, KeyMap * unbind_map) void KeyMap::write(string const & bind_file, bool append, bool unbind) const { ofstream os(bind_file.c_str(), - append ? (ios::app | ios:: out): ios::out); + append ? (ios::app | ios::out) : ios::out); if (!append) os << "## This file is automatically generated by lyx\n" @@ -260,7 +368,7 @@ void KeyMap::write(string const & bind_file, bool append, bool unbind) const BindingList::const_iterator it = list.begin(); BindingList::const_iterator it_end = list.end(); for (; it != it_end; ++it) { - kb_action action = it->request.action; + FuncCode action = it->request.action; string arg = to_utf8(it->request.argument()); os << tag << " \"" @@ -278,12 +386,9 @@ void KeyMap::write(string const & bind_file, bool append, bool unbind) const FuncRequest const & KeyMap::lookup(KeySymbol const &key, KeyModifier mod, KeySequence * seq) const { - static FuncRequest const unknown(LFUN_UNKNOWN_ACTION); - if (table.empty()) { - seq->curmap = seq->stdmap; - seq->mark_deleted(); - return unknown; + seq->reset(); + return FuncRequest::unknown; } Table::const_iterator end = table.end(); @@ -293,25 +398,23 @@ FuncRequest const & KeyMap::lookup(KeySymbol const &key, if (cit->code == key && cit->mod.first == check) { // match found - if (cit->table.get()) { + if (cit->prefixes.get()) { // this is a prefix key - set new map - seq->curmap = cit->table.get(); + seq->curmap = cit->prefixes.get(); static FuncRequest prefix(LFUN_COMMAND_PREFIX); return prefix; } else { // final key - reset map - seq->curmap = seq->stdmap; - seq->mark_deleted(); + seq->reset(); return cit->func; } } } // error - key not found: - seq->curmap = seq->stdmap; - seq->mark_deleted(); + seq->reset(); - return unknown; + return FuncRequest::unknown; } @@ -327,98 +430,8 @@ docstring const KeyMap::print(bool forgui) const } -void KeyMap::bind(KeySequence * seq, FuncRequest const & func, unsigned int r) -{ - KeySymbol code = seq->sequence[r]; - if (!code.isOK()) - return; - - KeyModifier const mod1 = seq->modifiers[r].first; - KeyModifier const mod2 = seq->modifiers[r].second; - - // check if key is already there - Table::iterator end = table.end(); - for (Table::iterator it = table.begin(); it != end; ++it) { - if (code == it->code - && mod1 == it->mod.first - && mod2 == it->mod.second) { - // overwrite binding - if (r + 1 == seq->length()) { - LYXERR(Debug::KBMAP, "Warning: New binding for '" - << to_utf8(seq->print(KeySequence::Portable)) - << "' is overriding old binding..."); - if (it->table.get()) { - it->table.reset(); - } - it->func = func; - it->func.origin = FuncRequest::KEYBOARD; - return; - } else if (!it->table.get()) { - lyxerr << "Error: New binding for '" - << to_utf8(seq->print(KeySequence::Portable)) - << "' is overriding old binding..." - << endl; - return; - } else { - it->table->bind(seq, func, r + 1); - return; - } - } - } - - Table::iterator newone = table.insert(table.end(), Key()); - newone->code = code; - newone->mod = seq->modifiers[r]; - if (r + 1 == seq->length()) { - newone->func = func; - newone->func.origin = FuncRequest::KEYBOARD; - newone->table.reset(); - } else { - newone->table.reset(new KeyMap); - newone->table->bind(seq, func, r + 1); - } -} - - -void KeyMap::unbind(KeySequence * seq, FuncRequest const & func, unsigned int r) -{ - KeySymbol code = seq->sequence[r]; - if (!code.isOK()) - return; - - KeyModifier const mod1 = seq->modifiers[r].first; - KeyModifier const mod2 = seq->modifiers[r].second; - - // check if key is already there - Table::iterator end = table.end(); - Table::iterator remove = end; - for (Table::iterator it = table.begin(); it != end; ++it) { - if (code == it->code - && mod1 == it->mod.first - && mod2 == it->mod.second) { - // remove - if (r + 1 == seq->length()) { - if (it->func == func) { - remove = it; - if (it->table.get()) - it->table.reset(); - } - } else if (it->table.get()) { - it->table->unbind(seq, func, r + 1); - if (it->table->empty()) - remove = it; - return; - } - } - } - if (remove != end) { - table.erase(remove); - return; - } -} - - -docstring KeyMap::printBindings(FuncRequest const & func) const +docstring KeyMap::printBindings(FuncRequest const & func, + KeySequence::outputFormat format) const { Bindings bindings = findBindings(func); if (bindings.empty()) @@ -427,11 +440,11 @@ docstring KeyMap::printBindings(FuncRequest const & func) const odocstringstream res; Bindings::const_iterator cit = bindings.begin(); Bindings::const_iterator cit_end = bindings.end(); - // prin the first item - res << cit->print(KeySequence::ForGui); + // print the first item + res << cit->print(format); // more than one shortcuts? for (++cit; cit != cit_end; ++cit) - res << ", " << cit->print(KeySequence::ForGui); + res << ", " << cit->print(format); return res.str(); } @@ -451,10 +464,10 @@ KeyMap::Bindings KeyMap::findBindings(FuncRequest const & func, Table::const_iterator end = table.end(); for (Table::const_iterator cit = table.begin(); cit != end; ++cit) { - if (cit->table.get()) { + if (cit->prefixes.get()) { KeySequence seq = prefix; seq.addkey(cit->code, cit->mod.first); - Bindings res2 = cit->table->findBindings(func, seq); + Bindings res2 = cit->prefixes->findBindings(func, seq); res.insert(res.end(), res2.begin(), res2.end()); } else if (cit->func == func) { KeySequence seq = prefix; @@ -467,7 +480,7 @@ KeyMap::Bindings KeyMap::findBindings(FuncRequest const & func, } -KeyMap::BindingList KeyMap::listBindings(bool unbound, int tag) const +KeyMap::BindingList KeyMap::listBindings(bool unbound, KeyMap::ItemType tag) const { BindingList list; listBindings(list, KeySequence(0, 0), tag); @@ -475,7 +488,7 @@ KeyMap::BindingList KeyMap::listBindings(bool unbound, int tag) const LyXAction::const_func_iterator fit = lyxaction.func_begin(); LyXAction::const_func_iterator fit_end = lyxaction.func_end(); for (; fit != fit_end; ++fit) { - kb_action action = fit->second; + FuncCode action = fit->second; bool has_action = false; BindingList::const_iterator it = list.begin(); BindingList::const_iterator it_end = list.end(); @@ -493,16 +506,16 @@ KeyMap::BindingList KeyMap::listBindings(bool unbound, int tag) const void KeyMap::listBindings(BindingList & list, - KeySequence const & prefix, int tag) const + KeySequence const & prefix, KeyMap::ItemType tag) const { Table::const_iterator it = table.begin(); Table::const_iterator it_end = table.end(); for (; it != it_end; ++it) { // a LFUN_COMMAND_PREFIX - if (it->table.get()) { + if (it->prefixes.get()) { KeySequence seq = prefix; seq.addkey(it->code, it->mod.first); - it->table->listBindings(list, seq, tag); + it->prefixes->listBindings(list, seq, tag); } else { KeySequence seq = prefix; seq.addkey(it->code, it->mod.first);