Update Win installer for new dictionary links. Untested.

[lyx.git] / src / KeyMap.h

diff --git a/src/KeyMap.h b/src/KeyMap.h
index 0dac18a6dfda705676c2369e453473b0ac1bd108..ac9de6298bf8f99db9f315246bedc7a344c1879e 100644 (file)
--- a/src/KeyMap.h
+++ b/src/KeyMap.h
@@ -19,12 +19,16 @@
 
 #include "support/strfwd.h"
 
-#include <tr1/memory>
+#include <memory>
 #include <vector>
 
 
 namespace lyx {
 
+namespace support {
+       class FileName;
+}
+
 /// Defines key maps and actions for key sequences
 class KeyMap {
 public:
@@ -36,6 +40,12 @@ public:
                UserExtraUnbind //< \unbind loaded from user.bind, without
                                //<    corresponding entry in system bind file.
        };
+       enum BindReadType {
+               MissingOK,      //< It's OK if this file is missing.
+               Fallback,       //< If missing, fallback to default "cua". This should only
+                               //< be used when attempting to read the user-secified bind file.
+               Default         //< Report error and return.
+       };
        /**
         * Bind/Unbind a key sequence to an action.
         * @return 0 on success, or position in string seq where error
@@ -55,8 +65,9 @@ public:
                    unsigned int r = 0);
 
 
-       /// returns the function bound to this key sequence, or 
-       /// FuncRequest::unknown if no binding exists for it.
+       /// returns the function bound to this key sequence, or:
+       /// * FuncRequest::unknown if no binding exists for it;
+       /// * FuncRequest::prefix if this is the start of longer keysequences
        /// @param r an internal recursion counter
        // FIXME Surely there's a better way to do that?
        FuncRequest getBinding(KeySequence const & seq, unsigned int r = 0);
@@ -64,15 +75,18 @@ public:
        /// clear all bindings
        void clear();
 
-       /** Parse a bind file. If a valid unbind_map is given, put \unbind 
+       /** Parse a bind file. If a valid unbind_map is given, put \unbind
         * bindings to a separate KeyMap. This is used in the Shortcut preference
         * dialog where main and user bind files are loaded separately so \unbind
         * in user.bind can not nullify \bind in the master bind file.
         *
         * @param bind_file bind file
         * @param unbind_map pointer to a KeyMap that holds \unbind bindings
+        * @param rt how to respond if the file can't be found
+        * @param i18n whether to search in localized folders
         */
-       bool read(std::string const & bind_file, KeyMap * unbind_map = 0);
+       bool read(std::string const & bind_file, KeyMap * unbind_map = 0,
+                       BindReadType rt = Default, bool i18n = true);
 
        /** write to a bind file.
         * @param append append to the bind_file instead of overwrite it
@@ -106,7 +120,8 @@ public:
 
        /// Given an action, print the keybindings.
        docstring printBindings(FuncRequest const & func,
-                               KeySequence::outputFormat format) const;
+                               KeySequence::outputFormat format,
+                               bool const untranslated = false) const;
 
        struct Binding {
                Binding(FuncRequest const & r, KeySequence const & s, ItemType t)
@@ -114,7 +129,7 @@ public:
                FuncRequest request;
                KeySequence sequence;
                KeyMap::ItemType tag;
-       }; 
+       };
        typedef std::vector<Binding> BindingList;
        /**
         * Return all lfun and their associated bindings.
@@ -150,11 +165,22 @@ private:
                /// Modifier masks
                ModifierPair mod;
                /// Keymap for prefix keys
-               std::tr1::shared_ptr<KeyMap> table;
+               std::shared_ptr<KeyMap> prefixes;
                /// Action for !prefix keys
                FuncRequest func;
        };
 
+       enum ReturnValues {
+               ReadOK,
+               ReadError,
+               FileError,
+               FormatMismatch
+       };
+       ///
+       bool read(support::FileName const & bind_file, KeyMap * unbind_map = 0);
+       ///
+       ReturnValues readWithoutConv(support::FileName const & bind_file, KeyMap * unbind_map = 0);
+
        /**
         * Given an action, find all keybindings
         * @param func the action
@@ -162,7 +188,7 @@ private:
         */
        Bindings findBindings(FuncRequest const & func,
                              KeySequence const & prefix) const;
-       
+
        void listBindings(BindingList & list, KeySequence const & prefix,
                          ItemType tag) const;