]> git.lyx.org Git - lyx.git/blobdiff - src/LyXRC.h
Disable CheckTeX while buffer is processed
[lyx.git] / src / LyXRC.h
index 96623b6ad55284c8deb4b5424b81ce6ec2203161..f2b0ab73e6eb6588724cddd4d349b201df8d2545 100644 (file)
@@ -4,11 +4,11 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
  * \author Angus Leeming
  * \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
  * \author Allan Rae
  * \author Dekel Tsur
  *
 #ifndef LYXRC_H
 #define LYXRC_H
 
-#include "paper.h"
+#include "Length.h"
 
 #include "support/strfwd.h"
 
+#include <map>
+#include <set>
 #include <string>
 
 
@@ -38,21 +40,23 @@ public:
        enum LyXRCTags {
                RC_ACCEPT_COMPOUND = 1,
                RC_ALT_LANG,
-               RC_PLAINTEXT_ROFF_COMMAND,
-               RC_PLAINTEXT_LINELEN,
+               RC_AUTOCORRECTION_MATH,
                RC_AUTOREGIONDELETE,
                RC_AUTORESET_OPTIONS,
                RC_AUTOSAVE,
                RC_AUTO_NUMBER,
                RC_BACKUPDIR_PATH,
+               RC_BIBTEX_ALTERNATIVES,
                RC_BIBTEX_COMMAND,
                RC_BINDFILE,
                RC_CHECKLASTFILES,
                RC_CHKTEX_COMMAND,
+               RC_COMPLETION_CURSOR_TEXT,
                RC_COMPLETION_INLINE_DELAY,
                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,
@@ -61,70 +65,78 @@ public:
                RC_CONVERTER_CACHE_MAXAGE,
                RC_COPIER,
                RC_CURSOR_FOLLOWS_SCROLLBAR,
-               RC_CUSTOM_EXPORT_COMMAND,
-               RC_CUSTOM_EXPORT_FORMAT,
+               RC_CURSOR_WIDTH,
                RC_DATE_INSERT_FORMAT,
+               RC_DEFAULT_DECIMAL_POINT,
+               RC_DEFAULT_LENGTH_UNIT,
+               RC_DEFAULT_OTF_VIEW_FORMAT,
+               RC_DEFAULT_PLATEX_VIEW_FORMAT,
+               RC_DEFAULT_VIEW_FORMAT,
                RC_DEFFILE,
-               RC_DEFAULT_LANGUAGE,
-               RC_DEFAULT_PAPERSIZE,
                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_FILEFORMAT,
+               RC_FORWARD_SEARCH_DVI,
+               RC_FORWARD_SEARCH_PDF,
                RC_FULL_SCREEN_LIMIT,
                RC_FULL_SCREEN_SCROLLBAR,
+               RC_FULL_SCREEN_STATUSBAR,
                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_ALTERNATIVES,
+               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_CURSOR_MOVEMENT,
                RC_MAKE_BACKUP,
                RC_MARK_FOREIGN_LANGUAGE,
                RC_MOUSE_WHEEL_SPEED,
+               RC_MOUSE_MIDDLEBUTTON_PASTE,
+               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,
-               RC_PRINTCOLLCOPIESFLAG,
-               RC_PRINTCOPIESFLAG,
-               RC_PRINTER,
-               RC_PRINTEVENPAGEFLAG,
-               RC_PRINTEXSTRAOPTIONS,
-               RC_PRINTFILEEXTENSION,
                RC_PRINTLANDSCAPEFLAG,
-               RC_PRINTODDPAGEFLAG,
-               RC_PRINTPAGERANGEFLAG,
                RC_PRINTPAPERDIMENSIONFLAG,
                RC_PRINTPAPERFLAG,
-               RC_PRINTREVERSEFLAG,
-               RC_PRINTSPOOL_COMMAND,
-               RC_PRINTSPOOL_PRINTERPREFIX,
-               RC_PRINTTOFILE,
-               RC_PRINTTOPRINTER,
-               RC_PRINT_ADAPTOUTPUT,
-               RC_PRINT_COMMAND,
-               RC_RTL_SUPPORT,
+               RC_PYGMENTIZE_COMMAND,
+               RC_SAVE_COMPRESSED,
+               RC_SAVE_ORIGIN,
                RC_SCREEN_DPI,
                RC_SCREEN_FONT_ROMAN,
                RC_SCREEN_FONT_ROMAN_FOUNDRY,
@@ -135,32 +147,41 @@ public:
                RC_SCREEN_FONT_TYPEWRITER,
                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_SINGLE_WINDOW,
+               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_CONVERTER_NEEDAUTH_FORBIDDEN,
+               RC_USE_CONVERTER_NEEDAUTH,
+               RC_USE_SYSTEM_COLORS,
                RC_USE_TOOLTIP,
                RC_USE_PIXMAP_CACHE,
-               RC_USE_SPELL_LIB,
+               RC_USE_QIMAGE,
+               RC_USE_SYSTEM_THEME_ICONS,
                RC_VIEWDVI_PAPEROPTION,
                RC_VIEWER,
+               RC_VIEWER_ALTERNATIVES,
                RC_VISUAL_CURSOR,
+               RC_CLOSE_BUFFER_WITH_LAST_VIEW,
                RC_LAST
        };
 
@@ -168,20 +189,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;
@@ -194,55 +227,36 @@ public:
        ///
        std::string ui_file;
        ///
-       std::string printer;
-       ///
-       std::string print_command;
-       ///
-       std::string print_evenpage_flag;
-       ///
-       std::string print_oddpage_flag;
-       ///
-       std::string print_pagerange_flag;
-       ///
-       std::string print_copies_flag;
-       ///
-       std::string print_collcopies_flag;
-       ///
-       std::string print_reverse_flag;
-       ///
        std::string print_landscape_flag;
        ///
-       std::string print_to_printer;
-       ///
-       bool print_adapt_output;
-       ///
-       std::string print_to_file;
-       ///
-       std::string print_file_extension;
-       ///
-       std::string print_extra_options;
-       ///
-       std::string print_spool_command;
-       ///
-       std::string print_spool_printerprefix;
-       ///
        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 commands to run japanese bibtex incl. options
+       CommandSet jbibtex_alternatives;
+       /// 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;
+       /// command to run the python pygments syntax highlighter
+       std::string pygmentize_command;
        ///
        std::string document_path;
        ///
@@ -252,7 +266,13 @@ public:
        ///
        std::string tempdir_path;
        ///
+       std::string thesaurusdir_path;
+       ///
+       std::string hunspelldir_path;
+       ///
        bool auto_region_delete;
+       /// enable middle-mouse-button paste
+       bool mouse_middlebutton_paste;
        /// flag telling whether lastfiles should be checked for existance
        bool auto_reset_options;
        ///
@@ -263,6 +283,10 @@ 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;
+       /// whether or not to save the document dir in the file
+       bool save_origin;
        /// shall a backup file be created
        bool make_backup;
        /// A directory for storing backup files
@@ -272,8 +296,11 @@ public:
        bool allow_geometry_session;
        /// Scrolling speed of the mouse wheel
        double mouse_wheel_speed;
-       /// Zoom factor for screen fonts
-       unsigned int zoom;
+       /// Default zoom factor for screen fonts
+       int defaultZoom;
+       /// Actual zoom factor for screen fonts
+       /// (default zoom plus buffer zoom factor)
+       int currentZoom;
        /// Screen font sizes in points for each font size
        std::string font_sizes[10];
        /// Allow the use of scalable fonts? Default is yes.
@@ -297,33 +324,31 @@ public:
        ///
        unsigned int autosave;
        ///
-       std::string plaintext_roff_command;
-       ///
        unsigned int plaintext_linelen;
-       /// use library instead of process
-       bool use_spell_lib;
-       /// Ispell command
-       std::string isp_command;
        /// Accept compound words in spellchecker?
-       bool isp_accept_compound;
-       /// Pass input encoding switch to ispell?
-       bool isp_use_input_encoding;
-       /// Use alternate language?
-       bool isp_use_alt_lang;
-       /// Use personal dictionary?
-       bool isp_use_pers_dict;
+       bool spellchecker_accept_compound;
+       /// 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 isp_use_esc_chars;
-       /// Alternate language for ispell
-       std::string isp_alt_lang;
-       /// Alternate personal dictionary file for ispell
-       std::string isp_pers_dict;
+       /// Use QImage backend?
+       bool use_qimage;
+       /// Spellchecker engine: aspell, hunspell, etc
+       std::string spellchecker;
+       /// Alternate language for spellchecker
+       std::string spellchecker_alt_lang;
        /// Escape characters
-       std::string isp_esc_chars;
+       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;
        ///
@@ -335,7 +360,7 @@ public:
        ///
        std::string date_insert_format;
        ///
-       std::string language_package;
+       std::string language_custom_package;
        ///
        bool language_auto_begin;
        ///
@@ -349,9 +374,14 @@ public:
        ///
        bool language_global_options;
        ///
-       bool language_use_babel;
+       enum LangPackageSelection {
+               LP_AUTO = 0,
+               LP_BABEL,
+               LP_CUSTOM,
+               LP_NONE
+       };
        ///
-       bool rtl_support;
+       LangPackageSelection language_package_selection;
        /// bidi cursor movement: true = visual, false = logical
        bool visual_cursor;
        ///
@@ -359,10 +389,26 @@ public:
        ///
        bool mark_foreign_language;
        ///
-       std::string default_language;
+       std::string gui_language;
+       ///
+       std::string default_otf_view_format;
+       ///
+       std::string default_platex_view_format;
+       ///
+       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_cursor_movement;
        ///
        bool cursor_follows_scrollbar;
        ///
+       bool scroll_below_document;
+       ///
        enum MacroEditStyle {
                MACRO_EDIT_INLINE_BOX = 0,
                MACRO_EDIT_INLINE,
@@ -373,10 +419,7 @@ public:
        ///
        bool dialogs_iconify_with_main;
        ///
-       int label_init_length;
-       ///
-       ///graphics::DisplayType
-       int display_graphics;
+       bool display_graphics;
        ///
        bool show_banner;
        ///
@@ -390,11 +433,15 @@ 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;
+       /// whether to use the icons from the theme
+       bool use_system_theme_icons;
        /// 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
@@ -403,8 +450,17 @@ 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;
+       /// Forbid use of external converters with 'needauth' option
+       bool use_converter_needauth_forbidden;
+       /// Ask user before calling external converters with 'needauth' option
+       bool use_converter_needauth;
        /// The maximum age of cache files in seconds
        unsigned int converter_cache_maxage;
        /// Sort layouts alphabetically
@@ -417,11 +473,17 @@ public:
        bool full_screen_scrollbar;
        /// Toggle tabbar in fullscreen mode?
        bool full_screen_tabbar;
+       /// Toggle menubar in fullscreen mode?
+       bool full_screen_menubar;
+       /// Toggle statusbar in fullscreen mode?
+       bool full_screen_statusbar;
        /// Limit the text width?
        bool full_screen_limit;
        /// Width of limited screen (in pixels) in fullscreen mode
        int full_screen_width;
        ///
+       bool completion_cursor_text;
+       ///
        double completion_inline_delay;
        ///
        bool completion_inline_math;
@@ -430,6 +492,8 @@ public:
        ///
        int completion_inline_dots;
        ///
+       bool autocorrection_math;
+       ///
        double completion_popup_delay;
        ///
        bool completion_popup_math;
@@ -437,28 +501,48 @@ public:
        bool completion_popup_text;
        ///
        bool completion_popup_after_complete;
-       /// Open new buffers in the current window as tab.
-       bool single_window;
+       ///
+       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;
+       ///
+       int cursor_width;
+       /// One of: yes, no, ask
+       std::string close_buffer_with_last_view;
 };
 
 
-/** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
- *  It can be forward-declared and passed as a function argument without
- *  having to expose LyXRC.h.
- */
-class LyXRC_PreviewStatus {
-       LyXRC::PreviewStatus val_;
-public:
-       LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
-       operator LyXRC::PreviewStatus() const { return val_; }
-};
-
+void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 
 ///
 extern LyXRC lyxrc;
 ///
 extern LyXRC system_lyxrc;
 
+// used by at least frontends/qt4/GuiPref.cpp
+const long maxlastfiles = 50;
+
 } // namespace lyx
 
 #endif