// -*- C++ -*- /** * \file LyXRC.h * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author Angus Leeming * \author John Levon * \author André Pönitz * \author Allan Rae * \author Dekel Tsur * * Full author contact details are available in file CREDITS. */ #ifndef LYXRC_H #define LYXRC_H #include "Length.h" #include "support/strfwd.h" #include #include #include namespace lyx { namespace support { class FileName; } class Lexer; /// This contains the runtime configuration of LyX class LyXRC { public: enum LyXRCTags { RC_ACCEPT_COMPOUND = 1, RC_ALT_LANG, 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, RC_COMPLETION_POPUP_AFTER_COMPLETE, RC_CONVERTER, RC_CONVERTER_CACHE_MAXAGE, RC_COPIER, RC_CURSOR_FOLLOWS_SCROLLBAR, 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_DIALOGS_ICONIFY_WITH_MAIN, RC_DISPLAY_GRAPHICS, RC_DOCUMENTPATH, RC_EDITOR_ALTERNATIVES, RC_ESC_CHARS, RC_EXAMPLEPATH, RC_EXPORT_OVERWRITE, RC_FONT_ENCODING, 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_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_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_PLAINTEXT_LINELEN, RC_PREVIEW, RC_PREVIEW_HASHED_LABELS, RC_PREVIEW_SCALE_FACTOR, RC_PRINTLANDSCAPEFLAG, RC_PRINTPAPERDIMENSIONFLAG, RC_PRINTPAPERFLAG, RC_PYGMENTIZE_COMMAND, RC_SAVE_COMPRESSED, RC_SAVE_ORIGIN, RC_SCREEN_DPI, RC_SCREEN_FONT_ROMAN, RC_SCREEN_FONT_ROMAN_FOUNDRY, RC_SCREEN_FONT_SANS, RC_SCREEN_FONT_SANS_FOUNDRY, RC_SCREEN_FONT_SCALABLE, RC_SCREEN_FONT_SIZES, 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_CLOSE_TAB_BUTTON, RC_SINGLE_INSTANCE, RC_SORT_LAYOUTS, 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_USE_CONVERTER_CACHE, RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN, RC_USE_CONVERTER_NEEDAUTH, RC_USE_SYSTEM_COLORS, RC_USE_TOOLTIP, RC_USE_PIXMAP_CACHE, RC_USE_SYSTEM_THEME_ICONS, RC_VIEWDVI_PAPEROPTION, RC_VIEWER, RC_VIEWER_ALTERNATIVES, RC_VISUAL_CURSOR, RC_CLOSE_BUFFER_WITH_LAST_VIEW, RC_LAST }; /// 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); /// bool read(std::istream &); private: enum ReturnValues { ReadOK, ReadError, FormatMismatch }; /// ReturnValues read(Lexer &, bool check_format); public: /// typedef std::set CommandSet; /// maps a format to a set of commands that can be used to /// edit or view it. typedef std::map 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, std::string const & tag = std::string()) const; /// void print() const; // FIXME unused (was used for xforms. Do we still need this?) //static docstring const getDescription(LyXRCTags); /// std::string bind_file; /// std::string def_file; /// std::string ui_file; /// std::string print_landscape_flag; /// std::string print_paper_flag; /// std::string print_paper_dimension_flag; /// 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 /// 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; /// std::string example_path; /// std::string template_path; /// 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; /// bool check_lastfiles; /// maximal number of lastfiles unsigned int num_lastfiles; /// whether or not go to saved position when opening a file 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 std::string backupdir_path; /// Whether or not save/restore session information /// like windows position and geometry. bool allow_geometry_session; /// Scrolling speed of the mouse wheel double mouse_wheel_speed; /// 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. bool use_scalable_fonts; /// DPI of monitor unsigned int dpi; /// std::string fontenc; /// std::string roman_font_name; /// std::string sans_font_name; /// std::string typewriter_font_name; /// std::string roman_font_foundry; /// std::string sans_font_foundry; /// std::string typewriter_font_foundry; /// unsigned int autosave; /// unsigned int plaintext_linelen; /// Accept compound words in spellchecker? 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; /// Spellchecker engine: aspell, hunspell, etc std::string spellchecker; /// Alternate language for spellchecker std::string spellchecker_alt_lang; /// 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; /// std::string primary_kbmap; /// std::string secondary_kbmap; /// std::string lyxpipes; /// std::string date_insert_format; /// std::string language_custom_package; /// bool language_auto_begin; /// bool language_auto_end; /// std::string language_command_begin; /// std::string language_command_end; /// std::string language_command_local; /// bool language_global_options; /// enum LangPackageSelection { LP_AUTO = 0, LP_BABEL, LP_CUSTOM, LP_NONE }; /// LangPackageSelection language_package_selection; /// bidi cursor movement: true = visual, false = logical bool visual_cursor; /// bool auto_number; /// bool mark_foreign_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, MACRO_EDIT_LIST }; /// MacroEditStyle macro_edit_style; /// bool dialogs_iconify_with_main; /// bool display_graphics; /// bool show_banner; /// enum PreviewStatus { PREVIEW_OFF, PREVIEW_NO_MATH, PREVIEW_ON }; /// PreviewStatus preview; /// bool preview_hashed_labels; /// 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 bool tex_allows_spaces; /** Prepend paths to the PATH environment variable. * 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 bool sort_layouts; /// Group layout by their category bool group_layouts; /// Toggle toolbars in fullscreen mode? bool full_screen_toolbars; /// Toggle scrollbar in fullscreen mode? 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; /// bool completion_inline_text; /// int completion_inline_dots; /// bool autocorrection_math; /// double completion_popup_delay; /// bool completion_popup_math; /// bool completion_popup_text; /// 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; /// int cursor_width; /// One of: yes, no, ask std::string close_buffer_with_last_view; }; 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