]> git.lyx.org Git - lyx.git/blobdiff - src/KeyMap.cpp
InsetInfo: enable inset dissolve
[lyx.git] / src / KeyMap.cpp
index c8f15d1cf96534c70b295f16b7defc2bc62be856..af5f5b8223eaf1c685bb7654c6672b606a010123 100644 (file)
@@ -25,6 +25,7 @@
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
+#include "support/TempFile.h"
 
 #include "frontends/alert.h"
 
@@ -37,7 +38,6 @@ using namespace lyx::support;
 
 namespace lyx {
 
-
 string const KeyMap::printKeySym(KeySymbol const & key, KeyModifier mod)
 {
        string buf;
@@ -46,8 +46,15 @@ string const KeyMap::printKeySym(KeySymbol const & key, KeyModifier mod)
 
        if (mod & ControlModifier)
                buf += "C-";
+#if defined(USE_MACOSX_PACKAGING) || defined(USE_META_KEYBINDING)
+       if (mod & MetaModifier)
+               buf += "M-";
+       if (mod & AltModifier)
+               buf += "A-";
+#else
        if (mod & AltModifier)
                buf += "M-";
+#endif
        if (mod & ShiftModifier)
                buf += "S-";
 
@@ -59,7 +66,7 @@ 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 << '\'');
+              << func.action() << '\'');
 
        KeySequence k(0, 0);
 
@@ -99,6 +106,8 @@ void KeyMap::bind(KeySequence * seq, FuncRequest const & func, unsigned int r)
        KeyModifier const mod2 = seq->modifiers[r].second;
 
        // check if key is already there
+       // FIXME perf: Profiling shows that this is responsible of 99% of the
+       // cost of GuiPrefs::applyView()
        Table::iterator end = table.end();
        for (Table::iterator it = table.begin(); it != end; ++it) {
                if (code == it->code
@@ -109,13 +118,12 @@ void KeyMap::bind(KeySequence * seq, FuncRequest const & func, unsigned int r)
                                LYXERR(Debug::KBMAP, "Warning: New binding for '"
                                        << to_utf8(seq->print(KeySequence::Portable))
                                        << "' is overriding old binding...");
-                               if (it->prefixes.get()) {
+                               if (it->prefixes)
                                        it->prefixes.reset();
-                               }
                                it->func = func;
-                               it->func.origin = FuncRequest::KEYBOARD;
+                               it->func.setOrigin(FuncRequest::KEYBOARD);
                                return;
-                       } else if (!it->prefixes.get()) {
+                       } else if (!it->prefixes) {
                                lyxerr << "Error: New binding for '"
                                       << to_utf8(seq->print(KeySequence::Portable))
                                       << "' is overriding old binding..."
@@ -133,7 +141,7 @@ void KeyMap::bind(KeySequence * seq, FuncRequest const & func, unsigned int r)
        newone->mod = seq->modifiers[r];
        if (r + 1 == seq->length()) {
                newone->func = func;
-               newone->func.origin = FuncRequest::KEYBOARD;
+               newone->func.setOrigin(FuncRequest::KEYBOARD);
                newone->prefixes.reset();
        } else {
                newone->prefixes.reset(new KeyMap);
@@ -162,10 +170,10 @@ void KeyMap::unbind(KeySequence * seq, FuncRequest const & func, unsigned int r)
                        if (r + 1 == seq->length()) {
                                if (it->func == func) {
                                        remove = it;
-                                       if (it->prefixes.get())
+                                       if (it->prefixes)
                                                it->prefixes.reset();
                                }
-                       } else if (it->prefixes.get()) {
+                       } else if (it->prefixes) {
                                it->prefixes->unbind(seq, func, r + 1);
                                if (it->prefixes->empty())
                                        remove = it;
@@ -195,7 +203,7 @@ FuncRequest KeyMap::getBinding(KeySequence const & seq, unsigned int r)
                    && mod2 == it->mod.second) {
                        if (r + 1 == seq.length())
                                return it->func;
-                       else if (it->prefixes.get())
+                       else if (it->prefixes)
                                return it->prefixes->getBinding(seq, r + 1);
                }
        }
@@ -215,6 +223,7 @@ bool KeyMap::read(string const & bind_file, KeyMap * unbind_map, BindReadType rt
        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"),
@@ -222,34 +231,59 @@ bool KeyMap::read(string const & bind_file, KeyMap * unbind_map, BindReadType rt
                                                "Please check your installation."), from_utf8(bind_file)));
                        return false;
                }
+
+               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)));
-               // So try it with the default file.
-               if (read("cua", unbind_map))
-                       return true;
-               lyxerr << "Could not find cua bind file!";
-               frontend::Alert::warning(_("Could not find cua bind file"),
-                               _("Unable to find the default bind file `cua'.\n"
-                                 "Please check your installation."));
-               return false;
+               return read(defaultBindfile, unbind_map);
        }
        return read(bf, unbind_map);
 }
 
 
 bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
+{
+       ReturnValues retval = readWithoutConv(bind_file, unbind_map);
+       if (retval != FormatMismatch)
+               return retval == ReadOK;
+
+       LYXERR(Debug::FILES, "Converting bind file to " << LFUN_FORMAT);
+       TempFile tmp("convert_bind");
+       FileName const tempfile = tmp.name();
+       bool const success = prefs2prefs(bind_file, tempfile, true);
+       if (!success) {
+               LYXERR0 ("Unable to convert " << bind_file <<
+                       " to format " << LFUN_FORMAT);
+               return false;
+       }
+       retval = readWithoutConv(tempfile, unbind_map);
+       return retval == ReadOK;
+}
+
+
+KeyMap::ReturnValues KeyMap::readWithoutConv(FileName const & bind_file, KeyMap * unbind_map)
 {
        enum {
                BN_BIND,
                BN_BINDFILE,
-               BN_UNBIND,
+               BN_FORMAT,
+               BN_UNBIND
        };
 
        LexerKeyword bindTags[] = {
                { "\\bind",      BN_BIND },
                { "\\bind_file", BN_BINDFILE },
                { "\\unbind",    BN_UNBIND },
+               { "format",      BN_FORMAT }
        };
 
        Lexer lexrc(bindTags);
@@ -258,12 +292,14 @@ bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
 
        lexrc.setFile(bind_file);
        if (!lexrc.isOK()) {
-               LYXERR0("KeyMap::read: cannot open bind file:" << bind_file.absFilename());
-               return false;
+               LYXERR0("KeyMap::read: cannot open bind file:" << bind_file.absFileName());
+               return FileError;
        }
 
-       LYXERR(Debug::KBMAP, "Reading bind file:" << bind_file.absFilename());
+       LYXERR(Debug::KBMAP, "Reading bind file:" << bind_file.absFileName());
 
+       // format of pre-2.0 bind files, before this tag was introduced.
+       unsigned int format = 0;
        bool error = false;
        while (lexrc.isOK()) {
                switch (lexrc.lex()) {
@@ -276,6 +312,11 @@ bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
                case Lexer::LEX_FEOF:
                        continue;
 
+               case BN_FORMAT:
+                       if (lexrc.next())
+                               format = lexrc.getInteger();
+                       break;
+
                case BN_BIND: {
                        if (!lexrc.next()) {
                                lexrc.printError("BN_BIND: Missing key sequence");
@@ -292,7 +333,7 @@ bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
                        string cmd = lexrc.getString();
 
                        FuncRequest func = lyxaction.lookupFunc(cmd);
-                       if (func.action == LFUN_UNKNOWN_ACTION) {
+                       if (func.action() == LFUN_UNKNOWN_ACTION) {
                                lexrc.printError("BN_BIND: Unknown LyX function `$$Token'");
                                error = true;
                                break;
@@ -318,13 +359,13 @@ bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
                        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;
                                break;
                        }
-                       
+
                        if (unbind_map)
                                unbind_map->bind(seq, func);
                        else
@@ -342,37 +383,45 @@ bool KeyMap::read(FileName const & bind_file, KeyMap * unbind_map)
                        error |= !read(tmp, unbind_map);
                        break;
                }
+
+               // This is triggered the first time through the loop unless
+               // we hit a format tag.
+               if (format != LFUN_FORMAT)
+                       return FormatMismatch;
        }
 
-       if (error)
-               LYXERR0("KeyMap::read: error while reading bind file:" << bind_file.absFilename());
-       return !error;
+       if (error) {
+               LYXERR0("KeyMap::read: error while reading bind file:" << bind_file.absFileName());
+               return ReadError;
+       }
+       return ReadOK;
 }
 
 
 void KeyMap::write(string const & bind_file, bool append, bool unbind) const
 {
-       ofstream os(bind_file.c_str(), 
+       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";
-       
+                  << "## All modifications will be lost\n\n"
+                  << "Format " << LFUN_FORMAT << "\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;
+               FuncCode action = it->request.action();
                string arg = to_utf8(it->request.argument());
 
+               string const cmd = lyxaction.getActionName(action)
+                       + (arg.empty() ? string() : " " + arg) ;
                os << tag << " \""
-                               << to_utf8(it->sequence.print(KeySequence::BindFile))
-                               << "\" \""
-                               << lyxaction.getActionName(action)
-                               << (arg.empty() ? "" : " ") << arg
-                               << "\"\n";
+                  << to_utf8(it->sequence.print(KeySequence::BindFile))
+                  << "\" " << Lexer::quoteString(cmd)
+                  << "\n";
        }
        os << "\n";
        os.close();
@@ -394,10 +443,10 @@ FuncRequest const & KeyMap::lookup(KeySymbol const &key,
 
                if (cit->code == key && cit->mod.first == check) {
                        // match found
-                       if (cit->prefixes.get()) {
+                       if (cit->prefixes) {
                                // this is a prefix key - set new map
                                seq->curmap = cit->prefixes.get();
-                               static FuncRequest prefix(LFUN_COMMAND_PREFIX);
+                               static const FuncRequest prefix(LFUN_COMMAND_PREFIX);
                                return prefix;
                        } else {
                                // final key - reset map
@@ -432,7 +481,7 @@ docstring KeyMap::printBindings(FuncRequest const & func,
        Bindings bindings = findBindings(func);
        if (bindings.empty())
                return docstring();
-       
+
        odocstringstream res;
        Bindings::const_iterator cit = bindings.begin();
        Bindings::const_iterator cit_end = bindings.end();
@@ -460,7 +509,7 @@ 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->prefixes.get()) {
+               if (cit->prefixes) {
                        KeySequence seq = prefix;
                        seq.addkey(cit->code, cit->mod.first);
                        Bindings res2 = cit->prefixes->findBindings(func, seq);
@@ -481,21 +530,21 @@ KeyMap::BindingList KeyMap::listBindings(bool unbound, KeyMap::ItemType tag) con
        BindingList list;
        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) {
+               LyXAction::const_iterator fit = lyxaction.func_begin();
+               LyXAction::const_iterator const fen = lyxaction.func_end();
+               for (; fit != fen; ++fit) {
                        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->request.action == action) {
+                       BindingList::const_iterator bit = list.begin();
+                       BindingList::const_iterator const ben = list.end();
+                       for (; bit != ben; ++bit)
+                               if (bit->request.action() == action) {
                                        has_action = true;
                                        break;
                                }
                        if (!has_action)
                                list.push_back(Binding(FuncRequest(action), KeySequence(0, 0), tag));
-               }       
+               }
        }
        return list;
 }
@@ -508,7 +557,7 @@ void KeyMap::listBindings(BindingList & list,
        Table::const_iterator it_end = table.end();
        for (; it != it_end; ++it) {
                // a LFUN_COMMAND_PREFIX
-               if (it->prefixes.get()) {
+               if (it->prefixes) {
                        KeySequence seq = prefix;
                        seq.addkey(it->code, it->mod.first);
                        it->prefixes->listBindings(list, seq, tag);