]> git.lyx.org Git - lyx.git/blobdiff - src/KeyMap.cpp
Added Liviu Andronic, and modified generate_contributions.py to match what was in...
[lyx.git] / src / KeyMap.cpp
index e923abd63ee1f12c8215c36e6235d5cf62154218..a5e83b356bed7e497f19011a28ccef8e6ddd4cc6 100644 (file)
 
 #include "KeyMap.h"
 
-#include "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 <fstream>
 #include <sstream>
 #include <utility>
 
-using std::endl;
-using std::string;
-using std::make_pair;
-
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::FileName;
-using support::i18nLibFileSearch;
-
 
 string const KeyMap::printKeySym(KeySymbol const & key, KeyModifier mod)
 {
@@ -42,12 +40,12 @@ string const KeyMap::printKeySym(KeySymbol const & key, KeyModifier mod)
 
        string const s = key.getSymbolName();
 
-       if (mod & ShiftModifier)
-               buf += "S-";
        if (mod & ControlModifier)
                buf += "C-";
        if (mod & AltModifier)
                buf += "M-";
+       if (mod & ShiftModifier)
+               buf += "S-";
 
        buf += s;
        return buf;
@@ -56,91 +54,126 @@ string const KeyMap::printKeySym(KeySymbol const & key, KeyModifier mod)
 
 size_t KeyMap::bind(string const & seq, FuncRequest const & func)
 {
-       LYXERR(Debug::KBMAP) << "BIND: Sequence `"
-              << seq << "' Action `"
-              << func.action << '\'' << endl;
+       LYXERR(Debug::KBMAP, "BIND: Sequence `" << seq << "' Action `"
+              << func.action << '\'');
 
        KeySequence k(0, 0);
 
        string::size_type const res = k.parse(seq);
        if (res == string::npos) {
-               defkey(&k, func);
+               bind(&k, func);
        } else {
-               LYXERR(Debug::KBMAP) << "Parse error at position " << res
-                                    << " in key sequence '" << seq << "'."
-                                    << endl;
+               LYXERR(Debug::KBMAP, "Parse error at position " << res
+                                    << " in key sequence '" << seq << "'.");
        }
 
-       return res;
+       return res == string::npos ? 0 : res;
 }
 
 
-namespace {
+size_t KeyMap::unbind(string const & seq, FuncRequest const & func)
+{
+       KeySequence k(0, 0);
 
-enum BindTags {
-       BN_BIND,
-       BN_BINDFILE
-};
+       string::size_type const res = k.parse(seq);
+       if (res == string::npos)
+               unbind(&k, func);
+       else
+               LYXERR(Debug::KBMAP, "Parse error at position " << res
+                                    << " in key sequence '" << seq << "'.");
+       return res == string::npos ? 0 : res;
+}
 
-keyword_item bindTags[] = {
-       { "\\bind", BN_BIND },
-       { "\\bind_file", BN_BINDFILE }
-};
 
+bool KeyMap::hasBinding(KeySequence const & seq, FuncRequest const & func,
+               unsigned int r)
+{
+       KeySymbol code = seq.sequence[r];
+       if (!code.isOK())
+               return false;
+
+       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) {
+                       if (r + 1 == seq.length())
+                               return it->func == func;
+                       else if (it->table.get())
+                               return it->table->hasBinding(seq, func, r + 1);
+               }
+       }
+       return false;
 }
 
 
-bool KeyMap::read(string const & bind_file)
+void KeyMap::clear()
 {
-       const int bindCount = sizeof(bindTags) / sizeof(keyword_item);
+       table.clear();
+}
+
 
-       Lexer lexrc(bindTags, bindCount);
+bool KeyMap::read(string const & bind_file, KeyMap * unbind_map)
+{
+       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"));
+       FileName const tmp = i18nLibFileSearch("bind", bind_file, "bind");
        lexrc.setFile(tmp);
        if (!lexrc.isOK()) {
-               lyxerr << "KeyMap::read: cannot open bind file:"
-                      << tmp << endl;
+               LYXERR0("KeyMap::read: cannot open bind file:" << tmp);
                return false;
        }
 
-       LYXERR(Debug::KBMAP) << "Reading bind file:" << tmp << endl;
+       LYXERR(Debug::KBMAP, "Reading bind file:" << tmp);
 
        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;
                        }
@@ -148,27 +181,84 @@ bool KeyMap::read(string const & bind_file)
                        bind(seq, func);
                        break;
                }
+
+               case BN_UNBIND: {
+                       if (!lexrc.next()) {
+                               lexrc.printError("BN_UNBIND: Missing key sequence");
+                               error = true;
+                               break;
+                       }
+                       string seq = lexrc.getString();
+
+                       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) {
+                               lexrc.printError("BN_UNBIND: Unknown LyX"
+                                                " function `$$Token'");
+                               error = true;
+                               break;
+                       }
+                       
+                       if (unbind_map)
+                               unbind_map->bind(seq, func);
+                       else
+                               unbind(seq, func);
+                       break;
+               }
+
                case BN_BINDFILE:
-                       if (lexrc.next()) {
-                               string const tmp(lexrc.getString());
-                               error |= !read(tmp);
-                       } 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:" << tmp);
        return !error;
 }
 
 
+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);
+
+       if (!append)
+               os << "## This file is automatically generated by lyx\n"
+                  << "## All modifications will be lost\n\n";
+       
+       string tag = unbind ? "\\unbind" : "\\bind";
+       BindingList const list = listBindings(false);
+       BindingList::const_iterator it = list.begin();
+       BindingList::const_iterator it_end = list.end();
+       for (; it != it_end; ++it) {
+               FuncCode action = it->request.action;
+               string arg = to_utf8(it->request.argument());
+
+               os << tag << " \""
+                               << to_utf8(it->sequence.print(KeySequence::BindFile))
+                               << "\" \""
+                               << lyxaction.getActionName(action)
+                               << (arg.empty() ? "" : " ") << arg
+                               << "\"\n";
+       }
+       os << "\n";
+       os.close();
+}
+
+
 FuncRequest const & KeyMap::lookup(KeySymbol const &key,
                  KeyModifier mod, KeySequence * seq) const
 {
@@ -221,7 +311,7 @@ docstring const KeyMap::print(bool forgui) const
 }
 
 
-void KeyMap::defkey(KeySequence * 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())
@@ -238,11 +328,9 @@ void KeyMap::defkey(KeySequence * seq, FuncRequest const & func, unsigned int r)
                    && mod2 == it->mod.second) {
                        // overwrite binding
                        if (r + 1 == seq->length()) {
-                               LYXERR(Debug::KBMAP)
-                                       << "Warning: New binding for '"
-                                       << to_utf8(seq->print(false))
-                                       << "' is overriding old binding..."
-                                       << endl;
+                               LYXERR(Debug::KBMAP, "Warning: New binding for '"
+                                       << to_utf8(seq->print(KeySequence::Portable))
+                                       << "' is overriding old binding...");
                                if (it->table.get()) {
                                        it->table.reset();
                                }
@@ -251,12 +339,12 @@ void KeyMap::defkey(KeySequence * seq, FuncRequest const & func, unsigned int r)
                                return;
                        } else if (!it->table.get()) {
                                lyxerr << "Error: New binding for '"
-                                      << to_utf8(seq->print(false))
+                                      << to_utf8(seq->print(KeySequence::Portable))
                                       << "' is overriding old binding..."
                                               << endl;
                                return;
                        } else {
-                               it->table->defkey(seq, func, r + 1);
+                               it->table->bind(seq, func, r + 1);
                                return;
                        }
                }
@@ -271,14 +359,50 @@ void KeyMap::defkey(KeySequence * seq, FuncRequest const & func, unsigned int r)
                newone->table.reset();
        } else {
                newone->table.reset(new KeyMap);
-               newone->table->defkey(seq, func, r + 1);
+               newone->table->bind(seq, func, r + 1);
        }
 }
 
 
-docstring const KeyMap::printbindings(FuncRequest const & func) const
+void KeyMap::unbind(KeySequence * seq, FuncRequest const & func, unsigned int r)
 {
-       Bindings bindings = findbindings(func);
+       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);
+}
+
+
+docstring KeyMap::printBindings(FuncRequest const & func) const
+{
+       Bindings bindings = findBindings(func);
        if (bindings.empty())
                return docstring();
        
@@ -286,34 +410,33 @@ docstring const KeyMap::printbindings(FuncRequest const & func) const
        Bindings::const_iterator cit = bindings.begin();
        Bindings::const_iterator cit_end = bindings.end();
        // prin the first item
-       res << cit->print(true);
+       res << cit->print(KeySequence::ForGui);
        // more than one shortcuts?
        for (++cit; cit != cit_end; ++cit)
-               res << ", " << cit->print(true);
+               res << ", " << cit->print(KeySequence::ForGui);
        return res.str();
 }
 
 
-KeyMap::Bindings KeyMap::findbindings(FuncRequest const & func) const
+KeyMap::Bindings KeyMap::findBindings(FuncRequest const & func) const
 {
-       return findbindings(func, KeySequence(0, 0));
+       return findBindings(func, KeySequence(0, 0));
 }
 
 
-KeyMap::Bindings KeyMap::findbindings(FuncRequest const & func,
+KeyMap::Bindings KeyMap::findBindings(FuncRequest const & func,
                        KeySequence const & prefix) const
 {
        Bindings res;
-       if (table.empty()) return res;
+       if (table.empty())
+               return res;
 
        Table::const_iterator end = table.end();
-       for (Table::const_iterator cit = table.begin();
-           cit != end; ++cit) {
+       for (Table::const_iterator cit = table.begin(); cit != end; ++cit) {
                if (cit->table.get()) {
                        KeySequence seq = prefix;
                        seq.addkey(cit->code, cit->mod.first);
-                       Bindings res2 =
-                               cit->table->findbindings(func, seq);
+                       Bindings res2 = cit->table->findBindings(func, seq);
                        res.insert(res.end(), res2.begin(), res2.end());
                } else if (cit->func == func) {
                        KeySequence seq = prefix;
@@ -326,25 +449,25 @@ KeyMap::Bindings KeyMap::findbindings(FuncRequest const & func,
 }
 
 
-KeyMap::BindingList const KeyMap::listBindings(bool unbound) const
+KeyMap::BindingList KeyMap::listBindings(bool unbound, int tag) const
 {
        BindingList list;
-       listBindings(list, KeySequence(0, 0));
+       listBindings(list, KeySequence(0, 0), tag);
        if (unbound) {
                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();
                        for (; it != it_end; ++it)
-                               if (it->first.action == action) {
+                               if (it->request.action == action) {
                                        has_action = true;
                                        break;
                                }
                        if (!has_action)
-                               list.push_back(make_pair(action, KeySequence(0, 0)));
+                               list.push_back(Binding(FuncRequest(action), KeySequence(0, 0), tag));
                }       
        }
        return list;
@@ -352,7 +475,7 @@ KeyMap::BindingList const KeyMap::listBindings(bool unbound) const
 
 
 void KeyMap::listBindings(BindingList & list,
-       KeySequence const & prefix) const
+       KeySequence const & prefix, int tag) const
 {
        Table::const_iterator it = table.begin();
        Table::const_iterator it_end = table.end();
@@ -361,11 +484,11 @@ void KeyMap::listBindings(BindingList & list,
                if (it->table.get()) {
                        KeySequence seq = prefix;
                        seq.addkey(it->code, it->mod.first);
-                       it->table->listBindings(list, seq);
+                       it->table->listBindings(list, seq, tag);
                } else {
                        KeySequence seq = prefix;
                        seq.addkey(it->code, it->mod.first);
-                       list.push_back(make_pair(it->func, seq));
+                       list.push_back(Binding(it->func, seq, tag));
                }
        }
 }