src/LyXRC.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXRC.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Allan Rae
  13  * \author Dekel Tsur
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #ifndef LYXRC_H
  19 #define LYXRC_H
  20
  21 #include "Length.h"
  22
  23 #include "support/strfwd.h"
  24
  25 #include <map>
  26 #include <set>
  27 #include <string>
  28
  29
  30 namespace lyx {
  31
  32 namespace support { class FileName; }
  33
  34 class Lexer;
  35
  36 /// This contains the runtime configuration of LyX
  37 class LyXRC
  38 {
  39 public:
  40         enum LyXRCTags {
  41                 RC_ACCEPT_COMPOUND = 1,
  42                 RC_ALT_LANG,
  43                 RC_AUTOCORRECTION_MATH,
  44                 RC_AUTOREGIONDELETE,
  45                 RC_AUTORESET_OPTIONS,
  46                 RC_AUTOSAVE,
  47                 RC_AUTO_NUMBER,
  48                 RC_BACKUPDIR_PATH,
  49                 RC_BIBTEX_ALTERNATIVES,
  50                 RC_BIBTEX_COMMAND,
  51                 RC_BINDFILE,
  52                 RC_CHECKLASTFILES,
  53                 RC_CHKTEX_COMMAND,
  54                 RC_COMPLETION_CURSOR_TEXT,
  55                 RC_COMPLETION_INLINE_DELAY,
  56                 RC_COMPLETION_INLINE_MATH,
  57                 RC_COMPLETION_INLINE_TEXT,
  58                 RC_COMPLETION_INLINE_DOTS,
  59                 RC_COMPLETION_MINLENGTH,
  60                 RC_COMPLETION_POPUP_DELAY,
  61                 RC_COMPLETION_POPUP_MATH,
  62                 RC_COMPLETION_POPUP_TEXT,
  63                 RC_COMPLETION_POPUP_AFTER_COMPLETE,
  64                 RC_CONVERTER,
  65                 RC_CONVERTER_CACHE_MAXAGE,
  66                 RC_COPIER,
  67                 RC_CURSOR_FOLLOWS_SCROLLBAR,
  68                 RC_CURSOR_WIDTH,
  69                 RC_DATE_INSERT_FORMAT,
  70                 RC_DEFAULT_DECIMAL_POINT,
  71                 RC_DEFAULT_LENGTH_UNIT,
  72                 RC_DEFAULT_OTF_VIEW_FORMAT,
  73                 RC_DEFAULT_PLATEX_VIEW_FORMAT,
  74                 RC_DEFAULT_VIEW_FORMAT,
  75                 RC_DEFFILE,
  76                 RC_DIALOGS_ICONIFY_WITH_MAIN,
  77                 RC_DISPLAY_GRAPHICS,
  78                 RC_DOCUMENTPATH,
  79                 RC_EDITOR_ALTERNATIVES,
  80                 RC_ESC_CHARS,
  81                 RC_EXAMPLEPATH,
  82                 RC_EXPORT_OVERWRITE,
  83                 RC_FILEFORMAT,
  84                 RC_FORWARD_SEARCH_DVI,
  85                 RC_FORWARD_SEARCH_PDF,
  86                 RC_FULL_SCREEN_LIMIT,
  87                 RC_FULL_SCREEN_SCROLLBAR,
  88                 RC_FULL_SCREEN_STATUSBAR,
  89                 RC_FULL_SCREEN_TABBAR,
  90                 RC_FULL_SCREEN_MENUBAR,
  91                 RC_FULL_SCREEN_TOOLBARS,
  92                 RC_FULL_SCREEN_WIDTH,
  93                 RC_GEOMETRY_SESSION,
  94                 RC_GROUP_LAYOUTS,
  95                 RC_GUI_LANGUAGE,
  96                 RC_HUNSPELLDIR_PATH,
  97                 RC_ICON_SET,
  98                 RC_INDEX_ALTERNATIVES,
  99                 RC_INDEX_COMMAND,
 100                 RC_INPUT,
 101                 RC_JBIBTEX_ALTERNATIVES,
 102                 RC_JBIBTEX_COMMAND,
 103                 RC_JINDEX_COMMAND,
 104                 RC_KBMAP,
 105                 RC_KBMAP_PRIMARY,
 106                 RC_KBMAP_SECONDARY,
 107                 RC_LANGUAGE_AUTO_BEGIN,
 108                 RC_LANGUAGE_AUTO_END,
 109                 RC_LANGUAGE_COMMAND_BEGIN,
 110                 RC_LANGUAGE_COMMAND_END,
 111                 RC_LANGUAGE_COMMAND_LOCAL,
 112                 RC_LANGUAGE_GLOBAL_OPTIONS,
 113                 RC_LANGUAGE_CUSTOM_PACKAGE,
 114                 RC_LANGUAGE_PACKAGE_SELECTION,
 115                 RC_LOADSESSION,
 116                 RC_LYXRCFORMAT,
 117                 RC_MACRO_EDIT_STYLE,
 118                 RC_MAC_DONTSWAP_CTRL_META,
 119                 RC_MAC_LIKE_CURSOR_MOVEMENT,
 120                 RC_MAKE_BACKUP,
 121                 RC_MARK_FOREIGN_LANGUAGE,
 122                 RC_MOUSE_WHEEL_SPEED,
 123                 RC_MOUSE_MIDDLEBUTTON_PASTE,
 124                 RC_NOMENCL_COMMAND,
 125                 RC_NUMLASTFILES,
 126                 RC_OPEN_BUFFERS_IN_TABS,
 127                 RC_PARAGRAPH_MARKERS,
 128                 RC_PATH_PREFIX,
 129                 RC_PLAINTEXT_LINELEN,
 130                 RC_PREVIEW,
 131                 RC_PREVIEW_HASHED_LABELS,
 132                 RC_PREVIEW_SCALE_FACTOR,
 133                 RC_PRINTLANDSCAPEFLAG,
 134                 RC_PRINTPAPERDIMENSIONFLAG,
 135                 RC_PRINTPAPERFLAG,
 136                 RC_PYGMENTIZE_COMMAND,
 137                 RC_SAVE_COMPRESSED,
 138                 RC_SAVE_ORIGIN,
 139                 RC_SCREEN_DPI,
 140                 RC_SCREEN_FONT_ROMAN,
 141                 RC_SCREEN_FONT_ROMAN_FOUNDRY,
 142                 RC_SCREEN_FONT_SANS,
 143                 RC_SCREEN_FONT_SANS_FOUNDRY,
 144                 RC_SCREEN_FONT_SCALABLE,
 145                 RC_SCREEN_FONT_SIZES,
 146                 RC_SCREEN_FONT_TYPEWRITER,
 147                 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
 148                 RC_SCREEN_ZOOM,
 149                 RC_SCROLL_BELOW_DOCUMENT,
 150                 RC_SCROLL_WHEEL_ZOOM,
 151                 RC_SERVERPIPE,
 152                 RC_SET_COLOR,
 153                 RC_SHOW_BANNER,
 154                 RC_SINGLE_CLOSE_TAB_BUTTON,
 155                 RC_SINGLE_INSTANCE,
 156                 RC_SORT_LAYOUTS,
 157                 RC_SPELLCHECK_CONTINUOUSLY,
 158                 RC_SPELLCHECK_NOTES,
 159                 RC_SPELLCHECKER,
 160                 RC_SPLITINDEX_COMMAND,
 161                 RC_TEMPDIRPATH,
 162                 RC_TEMPLATEPATH,
 163                 RC_TEX_ALLOWS_SPACES,
 164                 RC_TEX_EXPECTS_WINDOWS_PATHS,
 165                 RC_TEXINPUTS_PREFIX,
 166                 RC_THESAURUSDIRPATH,
 167                 RC_UIFILE,
 168                 RC_USELASTFILEPOS,
 169                 RC_USER_EMAIL,
 170                 RC_USER_NAME,
 171                 RC_USE_CONVERTER_CACHE,
 172                 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
 173                 RC_USE_CONVERTER_NEEDAUTH,
 174                 RC_USE_NATIVE_FILEDIALOG,
 175                 RC_USE_SYSTEM_COLORS,
 176                 RC_USE_TOOLTIP,
 177                 RC_USE_PIXMAP_CACHE,
 178                 RC_USE_SYSTEM_THEME_ICONS,
 179                 RC_VIEWDVI_PAPEROPTION,
 180                 RC_VIEWER,
 181                 RC_VIEWER_ALTERNATIVES,
 182                 RC_VISUAL_CURSOR,
 183                 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
 184                 RC_LAST
 185         };
 186
 187         ///
 188         LyXRC();
 189         ///
 190         void setDefaults();
 191         /// \param check_format: whether to try to convert the file format,
 192         /// if it is not current. this should only be true, really, for the
 193         /// user's own preferences file.
 194         bool read(support::FileName const & filename, bool check_format);
 195         ///
 196         bool read(std::istream &);
 197 private:
 198         enum ReturnValues {
 199                 ReadOK,
 200                 ReadError,
 201                 FormatMismatch
 202         };
 203         ///
 204         ReturnValues read(Lexer &, bool check_format);
 205 public:
 206         ///
 207         typedef std::set<std::string> CommandSet;
 208         /// maps a format to a set of commands that can be used to
 209         /// edit or view it.
 210         typedef std::map<std::string, CommandSet> Alternatives;
 211         ///
 212         void write(support::FileName const & filename,
 213                    bool ignore_system_lyxrc) const;
 214         /// write rc. If a specific tag is given, only output that one.
 215         void write(std::ostream & os,
 216                    bool ignore_system_lyxrc,
 217                    std::string const & tag = std::string()) const;
 218         ///
 219         void print() const;
 220         ///
 221         std::set<std::string> getRCs();
 222         // FIXME unused (was used for xforms. Do we still need this?)
 223         //static docstring const getDescription(LyXRCTags);
 224         ///
 225         std::string bind_file;
 226         ///
 227         std::string def_file;
 228         ///
 229         std::string ui_file;
 230         ///
 231         std::string print_landscape_flag;
 232         ///
 233         std::string print_paper_flag;
 234         ///
 235         std::string print_paper_dimension_flag;
 236         /// option for telling the dvi viewer about the paper size
 237         std::string view_dvi_paper_option;
 238         /// default paper size for local xdvi/dvips/ghostview/whatever
 239         /// command to run chktex incl. options
 240         std::string chktex_command;
 241         /// all available commands to run bibtex incl. options
 242         CommandSet bibtex_alternatives;
 243         /// command to run bibtex incl. options
 244         std::string bibtex_command;
 245         /// command to run japanese bibtex incl. options
 246         std::string jbibtex_command;
 247         /// all available commands to run japanese bibtex incl. options
 248         CommandSet jbibtex_alternatives;
 249         /// all available index commands incl. options
 250         CommandSet index_alternatives;
 251         /// command to run makeindex incl. options or other index programs
 252         std::string index_command;
 253         /// command to run japanese index program incl. options
 254         std::string jindex_command;
 255         /// command to generate multiple indices
 256         std::string splitindex_command;
 257         /// command to run makeindex incl. options for nomencl
 258         std::string nomencl_command;
 259         /// command to run the python pygments syntax highlighter
 260         std::string pygmentize_command;
 261         ///
 262         std::string document_path;
 263         ///
 264         std::string example_path;
 265         ///
 266         std::string template_path;
 267         ///
 268         std::string tempdir_path;
 269         ///
 270         std::string thesaurusdir_path;
 271         ///
 272         std::string hunspelldir_path;
 273         ///
 274         bool auto_region_delete;
 275         /// enable middle-mouse-button paste
 276         bool mouse_middlebutton_paste;
 277         /// flag telling whether lastfiles should be checked for existance
 278         bool auto_reset_options;
 279         ///
 280         bool check_lastfiles;
 281         /// maximal number of lastfiles
 282         unsigned int num_lastfiles;
 283         /// whether or not go to saved position when opening a file
 284         bool use_lastfilepos;
 285         /// load files from last session automatically
 286         bool load_session;
 287         /// do we save new documents as compressed by default
 288         bool save_compressed;
 289         /// whether or not to save the document dir in the file
 290         bool save_origin;
 291         /// shall a backup file be created
 292         bool make_backup;
 293         /// A directory for storing backup files
 294         std::string backupdir_path;
 295         /// Whether or not save/restore session information
 296         /// like windows position and geometry.
 297         bool allow_geometry_session;
 298         /// Scrolling speed of the mouse wheel
 299         double mouse_wheel_speed;
 300         /// Default zoom factor for screen fonts
 301         int defaultZoom;
 302         /// Actual zoom factor for screen fonts
 303         /// (default zoom plus buffer zoom factor)
 304         int currentZoom;
 305         /// Screen font sizes in points for each font size
 306         std::string font_sizes[10];
 307         /// Allow the use of scalable fonts? Default is yes.
 308         bool use_scalable_fonts;
 309         /// DPI of monitor
 310         unsigned int dpi;
 311         ///
 312         std::string roman_font_name;
 313         ///
 314         std::string sans_font_name;
 315         ///
 316         std::string typewriter_font_name;
 317         ///
 318         std::string roman_font_foundry;
 319         ///
 320         std::string sans_font_foundry;
 321         ///
 322         std::string typewriter_font_foundry;
 323         ///
 324         unsigned int autosave;
 325         ///
 326         unsigned int plaintext_linelen;
 327         /// Accept compound words in spellchecker?
 328         bool spellchecker_accept_compound;
 329         /// End of paragraph markers?
 330         bool paragraph_markers;
 331         /// Use tooltips?
 332         bool use_tooltip;
 333         /// Use the colors from current system theme?
 334         bool use_system_colors;
 335         /// use native file dialog or our own ?
 336         bool use_native_filedialog;
 337         /// Use pixmap cache?
 338         bool use_pixmap_cache;
 339         /// Spellchecker engine: aspell, hunspell, etc
 340         std::string spellchecker;
 341         /// Alternate language for spellchecker
 342         std::string spellchecker_alt_lang;
 343         /// Escape characters
 344         std::string spellchecker_esc_chars;
 345         /// spellcheck continuously?
 346         bool spellcheck_continuously;
 347         /// spellcheck notes and comments?
 348         bool spellcheck_notes;
 349         /// minimum length of words to complete
 350         unsigned int completion_minlength;
 351         ///
 352         bool use_kbmap;
 353         ///
 354         std::string primary_kbmap;
 355         ///
 356         std::string secondary_kbmap;
 357         ///
 358         std::string lyxpipes;
 359         ///
 360         std::string date_insert_format;
 361         ///
 362         std::string language_custom_package;
 363         ///
 364         bool language_auto_begin;
 365         ///
 366         bool language_auto_end;
 367         ///
 368         std::string language_command_begin;
 369         ///
 370         std::string language_command_end;
 371         ///
 372         std::string language_command_local;
 373         ///
 374         bool language_global_options;
 375         ///
 376         enum LangPackageSelection {
 377                 LP_AUTO = 0,
 378                 LP_BABEL,
 379                 LP_CUSTOM,
 380                 LP_NONE
 381         };
 382         ///
 383         LangPackageSelection language_package_selection;
 384         /// bidi cursor movement: true = visual, false = logical
 385         bool visual_cursor;
 386         ///
 387         bool auto_number;
 388         ///
 389         bool mark_foreign_language;
 390         ///
 391         std::string gui_language;
 392         ///
 393         std::string default_otf_view_format;
 394         ///
 395         std::string default_platex_view_format;
 396         ///
 397         std::string default_view_format;
 398         /// all available viewers
 399         Alternatives viewer_alternatives;
 400         /// all available editors
 401         Alternatives editor_alternatives;
 402         ///
 403         bool mac_dontswap_ctrl_meta;
 404         ///
 405         bool mac_like_cursor_movement;
 406         ///
 407         bool cursor_follows_scrollbar;
 408         ///
 409         bool scroll_below_document;
 410         ///
 411         enum MacroEditStyle {
 412                 MACRO_EDIT_INLINE_BOX = 0,
 413                 MACRO_EDIT_INLINE,
 414                 MACRO_EDIT_LIST
 415         };
 416         ///
 417         MacroEditStyle macro_edit_style;
 418         ///
 419         bool dialogs_iconify_with_main;
 420         ///
 421         bool display_graphics;
 422         ///
 423         bool show_banner;
 424         ///
 425         enum PreviewStatus {
 426                 PREVIEW_OFF,
 427                 PREVIEW_NO_MATH,
 428                 PREVIEW_ON
 429         };
 430         ///
 431         PreviewStatus preview;
 432         ///
 433         bool preview_hashed_labels;
 434         ///
 435         double preview_scale_factor;
 436         /// user name
 437         std::string user_name;
 438         /// user email
 439         std::string user_email;
 440         /// icon set name
 441         std::string icon_set;
 442         /// whether to use the icons from the theme
 443         bool use_system_theme_icons;
 444         /// True if the TeX engine cannot handle posix paths
 445         bool windows_style_tex_paths;
 446         /// True if the TeX engine can handle file names containing spaces
 447         bool tex_allows_spaces;
 448         /** Prepend paths to the PATH environment variable.
 449          *  The string is input, stored and output in native format.
 450          */
 451         std::string path_prefix;
 452         /** Prepend paths to the TEXINPUTS environment variable.
 453          *  The string is input, stored and output in native format.
 454          *  A '.' here stands for the current document directory.
 455          */
 456         std::string texinputs_prefix;
 457         /// Use the cache for file converters?
 458         bool use_converter_cache;
 459         /// Forbid use of external converters with 'needauth' option
 460         bool use_converter_needauth_forbidden;
 461         /// Ask user before calling external converters with 'needauth' option
 462         bool use_converter_needauth;
 463         /// The maximum age of cache files in seconds
 464         unsigned int converter_cache_maxage;
 465         /// Sort layouts alphabetically
 466         bool sort_layouts;
 467         /// Group layout by their category
 468         bool group_layouts;
 469         /// Toggle toolbars in fullscreen mode?
 470         bool full_screen_toolbars;
 471         /// Toggle scrollbar in fullscreen mode?
 472         bool full_screen_scrollbar;
 473         /// Toggle tabbar in fullscreen mode?
 474         bool full_screen_tabbar;
 475         /// Toggle menubar in fullscreen mode?
 476         bool full_screen_menubar;
 477         /// Toggle statusbar in fullscreen mode?
 478         bool full_screen_statusbar;
 479         /// Limit the text width?
 480         bool full_screen_limit;
 481         /// Width of limited screen (in pixels) in fullscreen mode
 482         int full_screen_width;
 483         ///
 484         bool completion_cursor_text;
 485         ///
 486         double completion_inline_delay;
 487         ///
 488         bool completion_inline_math;
 489         ///
 490         bool completion_inline_text;
 491         ///
 492         int completion_inline_dots;
 493         ///
 494         bool autocorrection_math;
 495         ///
 496         double completion_popup_delay;
 497         ///
 498         bool completion_popup_math;
 499         ///
 500         bool completion_popup_text;
 501         ///
 502         bool completion_popup_after_complete;
 503         ///
 504         bool open_buffers_in_tabs;
 505         ///
 506         bool single_close_tab_button;
 507         ///
 508         bool single_instance;
 509         ///
 510         std::string forward_search_dvi;
 511         ///
 512         std::string forward_search_pdf;
 513         ///
 514         int export_overwrite;
 515         /// Default decimal point when aligning table columns on decimal
 516         std::string default_decimal_point;
 517         ///
 518         Length::UNIT default_length_unit;
 519         ///
 520         enum ScrollWheelZoom {
 521                 SCROLL_WHEEL_ZOOM_OFF,
 522                 SCROLL_WHEEL_ZOOM_CTRL,
 523                 SCROLL_WHEEL_ZOOM_SHIFT,
 524                 SCROLL_WHEEL_ZOOM_ALT
 525         };
 526         ///
 527         ScrollWheelZoom scroll_wheel_zoom;
 528         ///
 529         int cursor_width;
 530         /// One of: yes, no, ask
 531         std::string close_buffer_with_last_view;
 532 };
 533
 534
 535 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 536
 537 ///
 538 extern LyXRC lyxrc;
 539 ///
 540 extern LyXRC system_lyxrc;
 541
 542 // used by at least frontends/qt4/GuiPref.cpp
 543 const long maxlastfiles = 50;
 544
 545 } // namespace lyx
 546
 547 #endif