]> git.lyx.org Git - lyx.git/blobdiff - src/LyXRC.h
Don't show citation engines in the list of modules. They are found under the bibliogr...
[lyx.git] / src / LyXRC.h
index 329c79201c1c3ac06bcfa5f1fa27b67c5410d3e0..0ddc5da51c1c7729a35626683c131c7628613da3 100644 (file)
 #define LYXRC_H
 
 #include "paper.h"
+#include "Length.h"
 
 #include "support/strfwd.h"
 
+#include <map>
+#include <set>
 #include <string>
+#include <vector>
 
 
 namespace lyx {
@@ -39,13 +43,12 @@ public:
                RC_ACCEPT_COMPOUND = 1,
                RC_ALT_LANG,
                RC_AUTOCORRECTION_MATH,
-               RC_PLAINTEXT_LINELEN,
-               RC_PLAINTEXT_ROFF_COMMAND,
                RC_AUTOREGIONDELETE,
                RC_AUTORESET_OPTIONS,
                RC_AUTOSAVE,
                RC_AUTO_NUMBER,
                RC_BACKUPDIR_PATH,
+               RC_BIBTEX_ALTERNATIVES,
                RC_BIBTEX_COMMAND,
                RC_BINDFILE,
                RC_CHECKLASTFILES,
@@ -55,6 +58,7 @@ public:
                RC_COMPLETION_INLINE_MATH,
                RC_COMPLETION_INLINE_TEXT,
                RC_COMPLETION_INLINE_DOTS,
+               RC_COMPLETION_MINLENGTH,
                RC_COMPLETION_POPUP_DELAY,
                RC_COMPLETION_POPUP_MATH,
                RC_COMPLETION_POPUP_TEXT,
@@ -63,52 +67,66 @@ public:
                RC_CONVERTER_CACHE_MAXAGE,
                RC_COPIER,
                RC_CURSOR_FOLLOWS_SCROLLBAR,
-               RC_MAC_LIKE_WORD_MOVEMENT,
-               RC_CUSTOM_EXPORT_COMMAND,
-               RC_CUSTOM_EXPORT_FORMAT,
+               RC_CURSOR_WIDTH,
                RC_DATE_INSERT_FORMAT,
-               RC_DEFFILE,
+               RC_DEFAULT_DECIMAL_POINT,
+               RC_DEFAULT_LENGTH_UNIT,
                RC_DEFAULT_LANGUAGE,
                RC_DEFAULT_VIEW_FORMAT,
-               RC_GUI_LANGUAGE,
-               RC_DEFAULT_PAPERSIZE,
+               RC_DEFFILE,
                RC_DIALOGS_ICONIFY_WITH_MAIN,
                RC_DISPLAY_GRAPHICS,
                RC_DOCUMENTPATH,
+               RC_EDITOR_ALTERNATIVES,
                RC_ESC_CHARS,
                RC_EXAMPLEPATH,
+               RC_EXPORT_OVERWRITE,
                RC_FONT_ENCODING,
-               RC_FORMAT,
+               RC_FORCE_PAINT_SINGLE_CHAR,
+               RC_FILEFORMAT,
+               RC_FORWARD_SEARCH_DVI,
+               RC_FORWARD_SEARCH_PDF,
                RC_FULL_SCREEN_LIMIT,
                RC_FULL_SCREEN_SCROLLBAR,
                RC_FULL_SCREEN_TABBAR,
+               RC_FULL_SCREEN_MENUBAR,
                RC_FULL_SCREEN_TOOLBARS,
                RC_FULL_SCREEN_WIDTH,
                RC_GEOMETRY_SESSION,
                RC_GROUP_LAYOUTS,
+               RC_GUI_LANGUAGE,
+               RC_HUNSPELLDIR_PATH,
+               RC_ICON_SET,
+               RC_INDEX_ALTERNATIVES,
                RC_INDEX_COMMAND,
                RC_INPUT,
+               RC_JBIBTEX_COMMAND,
+               RC_JINDEX_COMMAND,
                RC_KBMAP,
                RC_KBMAP_PRIMARY,
                RC_KBMAP_SECONDARY,
-               RC_LABEL_INIT_LENGTH,
                RC_LANGUAGE_AUTO_BEGIN,
                RC_LANGUAGE_AUTO_END,
                RC_LANGUAGE_COMMAND_BEGIN,
                RC_LANGUAGE_COMMAND_END,
                RC_LANGUAGE_COMMAND_LOCAL,
                RC_LANGUAGE_GLOBAL_OPTIONS,
-               RC_LANGUAGE_PACKAGE,
-               RC_LANGUAGE_USE_BABEL,
+               RC_LANGUAGE_CUSTOM_PACKAGE,
+               RC_LANGUAGE_PACKAGE_SELECTION,
                RC_LOADSESSION,
+               RC_LYXRCFORMAT,
                RC_MACRO_EDIT_STYLE,
+               RC_MAC_DONTSWAP_CTRL_META,
+               RC_MAC_LIKE_WORD_MOVEMENT,
                RC_MAKE_BACKUP,
                RC_MARK_FOREIGN_LANGUAGE,
                RC_MOUSE_WHEEL_SPEED,
                RC_NOMENCL_COMMAND,
                RC_NUMLASTFILES,
+               RC_OPEN_BUFFERS_IN_TABS,
+               RC_PARAGRAPH_MARKERS,
                RC_PATH_PREFIX,
-               RC_PERS_DICT,
+               RC_PLAINTEXT_LINELEN,
                RC_PREVIEW,
                RC_PREVIEW_HASHED_LABELS,
                RC_PREVIEW_SCALE_FACTOR,
@@ -131,6 +149,7 @@ public:
                RC_PRINT_ADAPTOUTPUT,
                RC_PRINT_COMMAND,
                RC_RTL_SUPPORT,
+               RC_SAVE_COMPRESSED,
                RC_SCREEN_DPI,
                RC_SCREEN_FONT_ROMAN,
                RC_SCREEN_FONT_ROMAN_FOUNDRY,
@@ -142,33 +161,35 @@ public:
                RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
                RC_SCREEN_ZOOM,
                RC_SCROLL_BELOW_DOCUMENT,
+               RC_SCROLL_WHEEL_ZOOM,
                RC_SERVERPIPE,
                RC_SET_COLOR,
                RC_SHOW_BANNER,
-               RC_OPEN_BUFFERS_IN_TABS,
+               RC_SINGLE_CLOSE_TAB_BUTTON,
+               RC_SINGLE_INSTANCE,
                RC_SORT_LAYOUTS,
-               RC_SPELL_COMMAND,
                RC_SPELLCHECK_CONTINUOUSLY,
+               RC_SPELLCHECK_NOTES,
+               RC_SPELLCHECKER,
+               RC_SPLITINDEX_COMMAND,
                RC_TEMPDIRPATH,
                RC_TEMPLATEPATH,
                RC_TEX_ALLOWS_SPACES,
                RC_TEX_EXPECTS_WINDOWS_PATHS,
+               RC_TEXINPUTS_PREFIX,
                RC_THESAURUSDIRPATH,
                RC_UIFILE,
                RC_USELASTFILEPOS,
                RC_USER_EMAIL,
                RC_USER_NAME,
-               RC_USETEMPDIR,
-               RC_USE_ALT_LANG,
                RC_USE_CONVERTER_CACHE,
-               RC_USE_ESC_CHARS,
-               RC_USE_INP_ENC,
-               RC_USE_PERS_DICT,
+               RC_USE_SYSTEM_COLORS,
                RC_USE_TOOLTIP,
                RC_USE_PIXMAP_CACHE,
-               RC_USE_SPELL_LIB,
+               RC_USE_QIMAGE,
                RC_VIEWDVI_PAPEROPTION,
                RC_VIEWER,
+               RC_VIEWER_ALTERNATIVES,
                RC_VISUAL_CURSOR,
                RC_LAST
        };
@@ -177,20 +198,32 @@ public:
        LyXRC();
        ///
        void setDefaults();
+       /// \param check_format: whether to try to convert the file format,
+       /// if it is not current. this should only be true, really, for the
+       /// user's own preferences file.
+       bool read(support::FileName const & filename, bool check_format);
        ///
-       int read(support::FileName const & filename);
-       ///
-       int read(std::istream &);
+       bool read(std::istream &);
 private:
+       enum ReturnValues {
+               ReadOK,
+               ReadError,
+               FormatMismatch
+       };
        ///
-       int read(Lexer &);
+       ReturnValues read(Lexer &, bool check_format);
 public:
+       ///
+       typedef std::set<std::string> CommandSet;
+       /// maps a format to a set of commands that can be used to
+       /// edit or view it.
+       typedef std::map<std::string, CommandSet> Alternatives;
        ///
        void write(support::FileName const & filename,
                   bool ignore_system_lyxrc) const;
        /// write rc. If a specific tag is given, only output that one.
        void write(std::ostream & os,
-                  bool ignore_system_lyxrc, 
+                  bool ignore_system_lyxrc,
                   std::string const & tag = std::string()) const;
        ///
        void print() const;
@@ -238,20 +271,25 @@ public:
        std::string print_paper_flag;
        ///
        std::string print_paper_dimension_flag;
-       ///
-       std::string custom_export_command;
-       ///
-       std::string custom_export_format;
        /// option for telling the dvi viewer about the paper size
        std::string view_dvi_paper_option;
        /// default paper size for local xdvi/dvips/ghostview/whatever
-       PAPER_SIZE default_papersize;
        /// command to run chktex incl. options
        std::string chktex_command;
+       /// all available commands to run bibtex incl. options
+       CommandSet bibtex_alternatives;
        /// command to run bibtex incl. options
        std::string bibtex_command;
+       /// command to run japanese bibtex incl. options
+       std::string jbibtex_command;
+       /// all available index commands incl. options
+       CommandSet index_alternatives;
        /// command to run makeindex incl. options or other index programs
        std::string index_command;
+       /// command to run japanese index program incl. options
+       std::string jindex_command;
+       /// command to generate multiple indices
+       std::string splitindex_command;
        /// command to run makeindex incl. options for nomencl
        std::string nomencl_command;
        ///
@@ -265,6 +303,8 @@ public:
        ///
        std::string thesaurusdir_path;
        ///
+       std::string hunspelldir_path;
+       ///
        bool auto_region_delete;
        /// flag telling whether lastfiles should be checked for existance
        bool auto_reset_options;
@@ -276,6 +316,8 @@ public:
        bool use_lastfilepos;
        /// load files from last session automatically
        bool load_session;
+       /// do we save new documents as compressed by default
+       bool save_compressed;
        /// shall a backup file be created
        bool make_backup;
        /// A directory for storing backup files
@@ -313,26 +355,28 @@ public:
        unsigned int plaintext_linelen;
        /// Accept compound words in spellchecker?
        bool spellchecker_accept_compound;
-       /// Pass input encoding switch to the spellchecker?
-       bool spellchecker_use_input_encoding;
-       /// Use alternate language?
-       bool spellchecker_use_alt_lang;
-       /// Use personal dictionary?
-       bool spellchecker_use_pers_dict;
+       /// End of paragraph markers?
+       bool paragraph_markers;
        /// Use tooltips?
        bool use_tooltip;
+       /// Use the colors from current system theme?
+       bool use_system_colors;
        /// Use pixmap cache?
        bool use_pixmap_cache;
-       /// Use escape chars?
-       bool spellchecker_use_esc_chars;
+       /// Use QImage backend?
+       bool use_qimage;
+       /// Spellchecker engine: aspell, hunspell, etc
+       std::string spellchecker;
        /// Alternate language for spellchecker
        std::string spellchecker_alt_lang;
-       /// Alternate personal dictionary file for the spellchecker
-       std::string spellchecker_pers_dict;
        /// Escape characters
        std::string spellchecker_esc_chars;
        /// spellcheck continuously?
        bool spellcheck_continuously;
+       /// spellcheck notes and comments?
+       bool spellcheck_notes;
+       /// minimum length of words to complete
+       unsigned int completion_minlength;
        ///
        bool use_kbmap;
        ///
@@ -344,7 +388,7 @@ public:
        ///
        std::string date_insert_format;
        ///
-       std::string language_package;
+       std::string language_custom_package;
        ///
        bool language_auto_begin;
        ///
@@ -358,7 +402,14 @@ public:
        ///
        bool language_global_options;
        ///
-       bool language_use_babel;
+       enum LangPackageSelection {
+               LP_AUTO = 0,
+               LP_BABEL,
+               LP_CUSTOM,
+               LP_NONE
+       };
+       ///
+       LangPackageSelection language_package_selection;
        ///
        bool rtl_support;
        /// bidi cursor movement: true = visual, false = logical
@@ -373,6 +424,12 @@ public:
        std::string gui_language;
        ///
        std::string default_view_format;
+       /// all available viewers
+       Alternatives viewer_alternatives;
+       /// all available editors
+       Alternatives editor_alternatives;
+       ///
+       bool mac_dontswap_ctrl_meta;
        ///
        bool mac_like_word_movement;
        ///
@@ -390,8 +447,6 @@ public:
        ///
        bool dialogs_iconify_with_main;
        ///
-       int label_init_length;
-       ///
        bool display_graphics;
        ///
        bool show_banner;
@@ -406,11 +461,13 @@ public:
        ///
        bool preview_hashed_labels;
        ///
-       std::string preview_scale_factor;
+       double preview_scale_factor;
        /// user name
        std::string user_name;
        /// user email
        std::string user_email;
+       /// icon set name
+       std::string icon_set;
        /// True if the TeX engine cannot handle posix paths
        bool windows_style_tex_paths;
        /// True if the TeX engine can handle file names containing spaces
@@ -419,6 +476,11 @@ public:
         *  The string is input, stored and output in native format.
         */
        std::string path_prefix;
+       /** Prepend paths to the TEXINPUTS environment variable.
+        *  The string is input, stored and output in native format.
+        *  A '.' here stands for the current document directory.
+        */
+       std::string texinputs_prefix;
        /// Use the cache for file converters?
        bool use_converter_cache;
        /// The maximum age of cache files in seconds
@@ -433,6 +495,8 @@ public:
        bool full_screen_scrollbar;
        /// Toggle tabbar in fullscreen mode?
        bool full_screen_tabbar;
+       /// Toggle menubar in fullscreen mode?
+       bool full_screen_menubar;
        /// Limit the text width?
        bool full_screen_limit;
        /// Width of limited screen (in pixels) in fullscreen mode
@@ -459,6 +523,33 @@ public:
        bool completion_popup_after_complete;
        ///
        bool open_buffers_in_tabs;
+       ///
+       bool single_close_tab_button;
+       ///
+       bool single_instance;
+       ///
+       std::string forward_search_dvi;
+       ///
+       std::string forward_search_pdf;
+       ///
+       int export_overwrite;
+       /// Default decimal point when aligning table columns on decimal
+       std::string default_decimal_point;
+       ///
+       Length::UNIT default_length_unit;
+       ///
+       enum ScrollWheelZoom {
+               SCROLL_WHEEL_ZOOM_OFF,
+               SCROLL_WHEEL_ZOOM_CTRL,
+               SCROLL_WHEEL_ZOOM_SHIFT,
+               SCROLL_WHEEL_ZOOM_ALT
+       };
+       ///
+       ScrollWheelZoom scroll_wheel_zoom;
+       ///
+       bool force_paint_single_char;
+       ///
+       int cursor_width;
 };
 
 
@@ -473,6 +564,7 @@ public:
        operator LyXRC::PreviewStatus() const { return val_; }
 };
 
+void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 
 ///
 extern LyXRC lyxrc;