]> git.lyx.org Git - lyx.git/blobdiff - src/kbmap.C
Make the shortcuts work correctly with the mac.
[lyx.git] / src / kbmap.C
index 3d86b2c74c857dc81bbea5a47023f1d66f8f0b2a..b026b8630fee0a19c8565bfd159533b79080bc18 100644 (file)
@@ -1,58 +1,73 @@
 /**
  * \file kbmap.C
- * Copyright 1995-2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author unknown
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "kbmap.h"
-#include "commandtags.h"
-#include "kbsequence.h"
+
 #include "debug.h"
+#include "kbsequence.h"
+#include "LyXAction.h"
+#include "lyxlex.h"
+
+#include "frontends/LyXKeySym.h"
+
+#include "support/filetools.h"
+
+#include <sstream>
+
+
+namespace lyx {
+
+using support::FileName;
+using support::i18nLibFileSearch;
 
 using std::endl;
+using std::string;
+
 
-string const kb_keymap::printKeysym(LyXKeySymPtr key,
+string const kb_keymap::printKeySym(LyXKeySym const & key,
                                    key_modifier::state mod)
 {
        string buf;
 
-       string const s = key->getSymbolName();
+       string const s = key.getSymbolName();
+
+       if (mod & key_modifier::shift)
+               buf += "S-";
+       if (mod & key_modifier::ctrl)
+               buf += "C-";
+       if (mod & key_modifier::alt)
+               buf += "M-";
 
-       if (mod & key_modifier::shift) buf += "S-";
-       if (mod & key_modifier::ctrl) buf += "C-";
-       if (mod & key_modifier::alt) buf += "M-";
        buf += s;
        return buf;
 }
 
-string const kb_keymap::printKey(kb_key const & key) const
-{
-       return printKeysym(key.code, key.mod.first);
-}
-
 
-string::size_type kb_keymap::bind(string const & seq, int action)
+string::size_type kb_keymap::bind(string const & seq, FuncRequest const & func)
 {
        if (lyxerr.debugging(Debug::KBMAP)) {
                lyxerr << "BIND: Sequence `"
                       << seq << "' Action `"
-                      << action << "'" << endl;
+                      << func.action << '\'' << endl;
        }
 
        kb_sequence k(0, 0);
 
        string::size_type const res = k.parse(seq);
        if (res == string::npos) {
-               defkey(&k, action);
+               defkey(&k, func);
        } else {
                lyxerr[Debug::KBMAP] << "Parse error at position " << res
                                     << " in key sequence '" << seq << "'."
@@ -63,32 +78,130 @@ string::size_type kb_keymap::bind(string const & seq, int action)
 }
 
 
-int kb_keymap::lookup(LyXKeySymPtr key,
-                     key_modifier::state mod, kb_sequence * seq) const
+namespace {
+
+enum BindTags {
+       BN_BIND,
+       BN_BINDFILE
+};
+
+keyword_item bindTags[] = {
+       { "\\bind", BN_BIND },
+       { "\\bind_file", BN_BINDFILE }
+};
+
+}
+
+
+bool kb_keymap::read(string const & bind_file)
 {
+       const int bindCount = sizeof(bindTags) / sizeof(keyword_item);
+
+       LyXLex lexrc(bindTags, bindCount);
+       if (lyxerr.debugging(Debug::PARSER))
+               lexrc.printTable(lyxerr);
+
+       FileName const tmp(i18nLibFileSearch("bind", bind_file, "bind"));
+       lexrc.setFile(tmp);
+       if (!lexrc.isOK()) {
+               lyxerr << "kb_keymap::read: cannot open bind file:"
+                      << tmp << endl;
+               return false;
+       }
+
+       lyxerr[Debug::KBMAP] << "Reading bind file:" << tmp << endl;
+
+       bool error = false;
+       while (lexrc.isOK()) {
+               switch (lexrc.lex()) {
+               case LyXLex::LEX_UNDEF:
+                       lexrc.printError("Unknown tag `$$Token'");
+                       error = true;
+                       continue;
+               case LyXLex::LEX_FEOF:
+                       continue;
+               case BN_BIND:
+               {
+                       string seq, cmd;
+
+                       if (lexrc.next()) {
+                               seq = lexrc.getString();
+                       } else {
+                               lexrc.printError("BN_BIND: Missing key sequence");
+                               error = true;
+                               break;
+                       }
+
+                       if (lexrc.next(true)) {
+                               cmd = lexrc.getString();
+                       } else {
+                               lexrc.printError("BN_BIND: missing command");
+                               error = true;
+                               break;
+                       }
+
+                       FuncRequest func = lyxaction.lookupFunc(cmd);
+                       if (func. action == LFUN_UNKNOWN_ACTION) {
+                               lexrc.printError("BN_BIND: Unknown LyX"
+                                                " function `$$Token'");
+                               error = true;
+                               break;
+                       }
+
+                       bind(seq, func);
+                       break;
+               }
+               case BN_BINDFILE:
+                       if (lexrc.next()) {
+                               string const tmp(lexrc.getString());
+                               error |= !read(tmp);
+                       } else {
+                               lexrc.printError("BN_BINDFILE: Missing file name");
+                               error = true;
+                               break;
+
+                       }
+                       break;
+               }
+       }
+
+       if (error)
+               lyxerr << "kb_keymap::read: error while reading bind file:"
+                      << tmp << endl;
+       return !error;
+}
+
+
+FuncRequest const &
+kb_keymap::lookup(LyXKeySymPtr key,
+                 key_modifier::state mod, kb_sequence * seq) const
+{
+       static FuncRequest const unknown(LFUN_UNKNOWN_ACTION);
+
        if (table.empty()) {
                seq->curmap = seq->stdmap;
                seq->mark_deleted();
-               return LFUN_UNKNOWN_ACTION;
+               return unknown;
        }
 
-       for (Table::const_iterator cit = table.begin();
-            cit != table.end(); ++cit) {
+       Table::const_iterator end = table.end();
+       for (Table::const_iterator cit = table.begin(); cit != end; ++cit) {
                key_modifier::state mask(cit->mod.second);
                key_modifier::state check =
                        static_cast<key_modifier::state>(mod & ~mask);
+
                if (*(cit->code) == *key && cit->mod.first == check) {
                        // match found
                        if (cit->table.get()) {
                                // this is a prefix key - set new map
                                seq->curmap = cit->table.get();
-                               return LFUN_PREFIX;
+                               static FuncRequest prefix(LFUN_COMMAND_PREFIX);
+                               return prefix;
                        } else {
                                // final key - reset map
                                seq->curmap = seq->stdmap;
                                seq->mark_deleted();
-                               return cit->action;
+                               return cit->func;
                        }
                }
        }
@@ -96,23 +209,25 @@ int kb_keymap::lookup(LyXKeySymPtr key,
        // error - key not found:
        seq->curmap = seq->stdmap;
        seq->mark_deleted();
-       return LFUN_UNKNOWN_ACTION;
+
+       return unknown;
 }
 
 
-string const kb_keymap::print() const
+docstring const kb_keymap::print(bool forgui) const
 {
-       string buf;
-       for (Table::const_iterator cit = table.begin();
-            cit != table.end(); ++cit) {
-               buf += printKey((*cit));
+       docstring buf;
+       Table::const_iterator end = table.end();
+       for (Table::const_iterator cit = table.begin(); cit != end; ++cit) {
+               buf += cit->code->print(cit->mod.first, forgui);
                buf += ' ';
        }
        return buf;
 }
 
 
-void kb_keymap::defkey(kb_sequence * seq, int action, unsigned int r)
+void kb_keymap::defkey(kb_sequence * seq,
+                      FuncRequest const & func, unsigned int r)
 {
        LyXKeySymPtr code = seq->sequence[r];
        if (!code->isOK())
@@ -122,7 +237,8 @@ void kb_keymap::defkey(kb_sequence * seq, int action, unsigned int r)
        key_modifier::state const mod2 = seq->modifiers[r].second;
 
        // check if key is already there
-       for (Table::iterator it = table.begin(); it != table.end(); ++it) {
+       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) {
@@ -130,21 +246,23 @@ void kb_keymap::defkey(kb_sequence * seq, int action, unsigned int r)
                        if (r + 1 == seq->length()) {
                                lyxerr[Debug::KBMAP]
                                        << "Warning: New binding for '"
-                                       << seq->print()
+                                       << to_utf8(seq->print(false))
                                        << "' is overriding old binding..."
                                        << endl;
                                if (it->table.get()) {
                                        it->table.reset();
                                }
-                               it->action = action;
+                               it->func = func;
+                               it->func.origin = FuncRequest::KEYBOARD;
                                return;
                        } else if (!it->table.get()) {
-                               lyxerr << "Error: New binding for '" << seq->print()
+                               lyxerr << "Error: New binding for '" 
+                                      << to_utf8(seq->print(false))
                                       << "' is overriding old binding..."
                                               << endl;
                                return;
                        } else {
-                               it->table->defkey(seq, action, r + 1);
+                               it->table->defkey(seq, func, r + 1);
                                return;
                        }
                }
@@ -154,35 +272,73 @@ void kb_keymap::defkey(kb_sequence * seq, int action, unsigned int r)
        newone->code = code;
        newone->mod = seq->modifiers[r];
        if (r + 1 == seq->length()) {
-               newone->action = action;
+               newone->func = func;
+               newone->func.origin = FuncRequest::KEYBOARD;
                newone->table.reset();
-               return;
        } else {
                newone->table.reset(new kb_keymap);
-               newone->table->defkey(seq, action, r + 1);
-               return;
+               newone->table->defkey(seq, func, r + 1);
        }
 }
 
 
-string const kb_keymap::findbinding(int act, string const & prefix) const
+docstring const kb_keymap::printbindings(FuncRequest const & func) const
+{
+       odocstringstream res;
+       Bindings bindings = findbindings(func);
+       for (Bindings::const_iterator cit = bindings.begin();
+            cit != bindings.end() ; ++cit)
+               res << '[' << cit->print(true) << ']';
+       return res.str();
+}
+
+
+kb_keymap::Bindings
+kb_keymap::findbindings(FuncRequest const & func) const
+{
+       return findbindings(func, kb_sequence(0, 0));
+}
+
+
+kb_keymap::Bindings
+kb_keymap::findbindings(FuncRequest const & func,
+                       kb_sequence const & prefix) const
 {
-       string res;
+       Bindings res;
        if (table.empty()) return res;
 
        Table::const_iterator end = table.end();
        for (Table::const_iterator cit = table.begin();
            cit != end; ++cit) {
                if (cit->table.get()) {
-                       res += cit->table->findbinding(act,
-                                                      prefix
-                                                      + printKey((*cit))
-                                                      + " ");
-               } else if (cit->action == act) {
-                       res += "[";
-                       res += prefix + printKey((*cit));
-                       res += "] ";
+                       kb_sequence seq = prefix;
+                       seq.addkey(cit->code, cit->mod.first);
+                       Bindings res2 =
+                               cit->table->findbindings(func, seq);
+                       res.insert(res.end(), res2.begin(), res2.end());
+               } else if (cit->func == func) {
+                       kb_sequence seq = prefix;
+                       seq.addkey(cit->code, cit->mod.first);
+                       res.push_back(seq);
                }
        }
+
        return res;
 }
+
+
+std::pair<LyXKeySym const *, key_modifier::state>
+kb_keymap::find1keybinding(FuncRequest const & func) const
+{
+       Table::const_iterator end = table.end();
+       for (Table::const_iterator cit = table.begin();
+           cit != end; ++cit) {
+               if (!cit->table.get() && cit->func == func)
+                       return std::make_pair(cit->code.get(), cit->mod.first);
+       }
+
+       return std::make_pair<LyXKeySym const *, key_modifier::state>(0, key_modifier::none);
+}
+
+
+} // namespace lyx