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