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_VIEW_FORMAT,
  74                 RC_DEFFILE,
  75                 RC_DIALOGS_ICONIFY_WITH_MAIN,
  76                 RC_DISPLAY_GRAPHICS,
  77                 RC_DOCUMENTPATH,
  78                 RC_EDITOR_ALTERNATIVES,
  79                 RC_ESC_CHARS,
  80                 RC_EXAMPLEPATH,
  81                 RC_EXPORT_OVERWRITE,
  82                 RC_FONT_ENCODING,
  83                 RC_FORCE_PAINT_SINGLE_CHAR,
  84                 RC_FILEFORMAT,
  85                 RC_FORWARD_SEARCH_DVI,
  86                 RC_FORWARD_SEARCH_PDF,
  87                 RC_FULL_SCREEN_LIMIT,
  88                 RC_FULL_SCREEN_SCROLLBAR,
  89                 RC_FULL_SCREEN_STATUSBAR,
  90                 RC_FULL_SCREEN_TABBAR,
  91                 RC_FULL_SCREEN_MENUBAR,
  92                 RC_FULL_SCREEN_TOOLBARS,
  93                 RC_FULL_SCREEN_WIDTH,
  94                 RC_GEOMETRY_SESSION,
  95                 RC_GROUP_LAYOUTS,
  96                 RC_GUI_LANGUAGE,
  97                 RC_HUNSPELLDIR_PATH,
  98                 RC_ICON_SET,
  99                 RC_INDEX_ALTERNATIVES,
 100                 RC_INDEX_COMMAND,
 101                 RC_INPUT,
 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_NOMENCL_COMMAND,
 124                 RC_NUMLASTFILES,
 125                 RC_OPEN_BUFFERS_IN_TABS,
 126                 RC_PARAGRAPH_MARKERS,
 127                 RC_PATH_PREFIX,
 128                 RC_PLAINTEXT_LINELEN,
 129                 RC_PREVIEW,
 130                 RC_PREVIEW_HASHED_LABELS,
 131                 RC_PREVIEW_SCALE_FACTOR,
 132                 RC_PRINTCOLLCOPIESFLAG,
 133                 RC_PRINTCOPIESFLAG,
 134                 RC_PRINTER,
 135                 RC_PRINTEVENPAGEFLAG,
 136                 RC_PRINTEXSTRAOPTIONS,
 137                 RC_PRINTFILEEXTENSION,
 138                 RC_PRINTLANDSCAPEFLAG,
 139                 RC_PRINTODDPAGEFLAG,
 140                 RC_PRINTPAGERANGEFLAG,
 141                 RC_PRINTPAPERDIMENSIONFLAG,
 142                 RC_PRINTPAPERFLAG,
 143                 RC_PRINTREVERSEFLAG,
 144                 RC_PRINTSPOOL_COMMAND,
 145                 RC_PRINTSPOOL_PRINTERPREFIX,
 146                 RC_PRINTTOFILE,
 147                 RC_PRINTTOPRINTER,
 148                 RC_PRINT_ADAPTOUTPUT,
 149                 RC_PRINT_COMMAND,
 150                 RC_RTL_SUPPORT,
 151                 RC_SAVE_COMPRESSED,
 152                 RC_SCREEN_DPI,
 153                 RC_SCREEN_FONT_ROMAN,
 154                 RC_SCREEN_FONT_ROMAN_FOUNDRY,
 155                 RC_SCREEN_FONT_SANS,
 156                 RC_SCREEN_FONT_SANS_FOUNDRY,
 157                 RC_SCREEN_FONT_SCALABLE,
 158                 RC_SCREEN_FONT_SIZES,
 159                 RC_SCREEN_FONT_TYPEWRITER,
 160                 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
 161                 RC_SCREEN_ZOOM,
 162                 RC_SCROLL_BELOW_DOCUMENT,
 163                 RC_SCROLL_WHEEL_ZOOM,
 164                 RC_SERVERPIPE,
 165                 RC_SET_COLOR,
 166                 RC_SHOW_BANNER,
 167                 RC_SINGLE_CLOSE_TAB_BUTTON,
 168                 RC_SINGLE_INSTANCE,
 169                 RC_SORT_LAYOUTS,
 170                 RC_SPELLCHECK_CONTINUOUSLY,
 171                 RC_SPELLCHECK_NOTES,
 172                 RC_SPELLCHECKER,
 173                 RC_SPLITINDEX_COMMAND,
 174                 RC_TEMPDIRPATH,
 175                 RC_TEMPLATEPATH,
 176                 RC_TEX_ALLOWS_SPACES,
 177                 RC_TEX_EXPECTS_WINDOWS_PATHS,
 178                 RC_TEXINPUTS_PREFIX,
 179                 RC_THESAURUSDIRPATH,
 180                 RC_UIFILE,
 181                 RC_USELASTFILEPOS,
 182                 RC_USER_EMAIL,
 183                 RC_USER_NAME,
 184                 RC_USE_CONVERTER_CACHE,
 185                 RC_USE_SYSTEM_COLORS,
 186                 RC_USE_TOOLTIP,
 187                 RC_USE_PIXMAP_CACHE,
 188                 RC_USE_QIMAGE,
 189                 RC_USE_SYSTEM_THEME_ICONS,
 190                 RC_VIEWDVI_PAPEROPTION,
 191                 RC_VIEWER,
 192                 RC_VIEWER_ALTERNATIVES,
 193                 RC_VISUAL_CURSOR,
 194                 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
 195                 RC_LAST
 196         };
 197
 198         ///
 199         LyXRC();
 200         ///
 201         void setDefaults();
 202         /// \param check_format: whether to try to convert the file format,
 203         /// if it is not current. this should only be true, really, for the
 204         /// user's own preferences file.
 205         bool read(support::FileName const & filename, bool check_format);
 206         ///
 207         bool read(std::istream &);
 208 private:
 209         enum ReturnValues {
 210                 ReadOK,
 211                 ReadError,
 212                 FormatMismatch
 213         };
 214         ///
 215         ReturnValues read(Lexer &, bool check_format);
 216 public:
 217         ///
 218         typedef std::set<std::string> CommandSet;
 219         /// maps a format to a set of commands that can be used to
 220         /// edit or view it.
 221         typedef std::map<std::string, CommandSet> Alternatives;
 222         ///
 223         void write(support::FileName const & filename,
 224                    bool ignore_system_lyxrc) const;
 225         /// write rc. If a specific tag is given, only output that one.
 226         void write(std::ostream & os,
 227                    bool ignore_system_lyxrc,
 228                    std::string const & tag = std::string()) const;
 229         ///
 230         void print() const;
 231         // FIXME unused (was used for xforms. Do we still need this?)
 232         //static docstring const getDescription(LyXRCTags);
 233         ///
 234         std::string bind_file;
 235         ///
 236         std::string def_file;
 237         ///
 238         std::string ui_file;
 239         ///
 240         std::string printer;
 241         ///
 242         std::string print_command;
 243         ///
 244         std::string print_evenpage_flag;
 245         ///
 246         std::string print_oddpage_flag;
 247         ///
 248         std::string print_pagerange_flag;
 249         ///
 250         std::string print_copies_flag;
 251         ///
 252         std::string print_collcopies_flag;
 253         ///
 254         std::string print_reverse_flag;
 255         ///
 256         std::string print_landscape_flag;
 257         ///
 258         std::string print_to_printer;
 259         ///
 260         bool print_adapt_output;
 261         ///
 262         std::string print_to_file;
 263         ///
 264         std::string print_file_extension;
 265         ///
 266         std::string print_extra_options;
 267         ///
 268         std::string print_spool_command;
 269         ///
 270         std::string print_spool_printerprefix;
 271         ///
 272         std::string print_paper_flag;
 273         ///
 274         std::string print_paper_dimension_flag;
 275         /// option for telling the dvi viewer about the paper size
 276         std::string view_dvi_paper_option;
 277         /// default paper size for local xdvi/dvips/ghostview/whatever
 278         /// command to run chktex incl. options
 279         std::string chktex_command;
 280         /// all available commands to run bibtex incl. options
 281         CommandSet bibtex_alternatives;
 282         /// command to run bibtex incl. options
 283         std::string bibtex_command;
 284         /// command to run japanese bibtex incl. options
 285         std::string jbibtex_command;
 286         /// all available index commands incl. options
 287         CommandSet index_alternatives;
 288         /// command to run makeindex incl. options or other index programs
 289         std::string index_command;
 290         /// command to run japanese index program incl. options
 291         std::string jindex_command;
 292         /// command to generate multiple indices
 293         std::string splitindex_command;
 294         /// command to run makeindex incl. options for nomencl
 295         std::string nomencl_command;
 296         ///
 297         std::string document_path;
 298         ///
 299         std::string example_path;
 300         ///
 301         std::string template_path;
 302         ///
 303         std::string tempdir_path;
 304         ///
 305         std::string thesaurusdir_path;
 306         ///
 307         std::string hunspelldir_path;
 308         ///
 309         bool auto_region_delete;
 310         /// flag telling whether lastfiles should be checked for existance
 311         bool auto_reset_options;
 312         ///
 313         bool check_lastfiles;
 314         /// maximal number of lastfiles
 315         unsigned int num_lastfiles;
 316         /// whether or not go to saved position when opening a file
 317         bool use_lastfilepos;
 318         /// load files from last session automatically
 319         bool load_session;
 320         /// do we save new documents as compressed by default
 321         bool save_compressed;
 322         /// shall a backup file be created
 323         bool make_backup;
 324         /// A directory for storing backup files
 325         std::string backupdir_path;
 326         /// Whether or not save/restore session information
 327         /// like windows position and geometry.
 328         bool allow_geometry_session;
 329         /// Scrolling speed of the mouse wheel
 330         double mouse_wheel_speed;
 331         /// Zoom factor for screen fonts
 332         unsigned int zoom;
 333         /// Screen font sizes in points for each font size
 334         std::string font_sizes[10];
 335         /// Allow the use of scalable fonts? Default is yes.
 336         bool use_scalable_fonts;
 337         /// DPI of monitor
 338         unsigned int dpi;
 339         ///
 340         std::string fontenc;
 341         ///
 342         std::string roman_font_name;
 343         ///
 344         std::string sans_font_name;
 345         ///
 346         std::string typewriter_font_name;
 347         ///
 348         std::string roman_font_foundry;
 349         ///
 350         std::string sans_font_foundry;
 351         ///
 352         std::string typewriter_font_foundry;
 353         ///
 354         unsigned int autosave;
 355         ///
 356         unsigned int plaintext_linelen;
 357         /// Accept compound words in spellchecker?
 358         bool spellchecker_accept_compound;
 359         /// End of paragraph markers?
 360         bool paragraph_markers;
 361         /// Use tooltips?
 362         bool use_tooltip;
 363         /// Use the colors from current system theme?
 364         bool use_system_colors;
 365         /// Use pixmap cache?
 366         bool use_pixmap_cache;
 367         /// Use QImage backend?
 368         bool use_qimage;
 369         /// Spellchecker engine: aspell, hunspell, etc
 370         std::string spellchecker;
 371         /// Alternate language for spellchecker
 372         std::string spellchecker_alt_lang;
 373         /// Escape characters
 374         std::string spellchecker_esc_chars;
 375         /// spellcheck continuously?
 376         bool spellcheck_continuously;
 377         /// spellcheck notes and comments?
 378         bool spellcheck_notes;
 379         /// minimum length of words to complete
 380         unsigned int completion_minlength;
 381         ///
 382         bool use_kbmap;
 383         ///
 384         std::string primary_kbmap;
 385         ///
 386         std::string secondary_kbmap;
 387         ///
 388         std::string lyxpipes;
 389         ///
 390         std::string date_insert_format;
 391         ///
 392         std::string language_custom_package;
 393         ///
 394         bool language_auto_begin;
 395         ///
 396         bool language_auto_end;
 397         ///
 398         std::string language_command_begin;
 399         ///
 400         std::string language_command_end;
 401         ///
 402         std::string language_command_local;
 403         ///
 404         bool language_global_options;
 405         ///
 406         enum LangPackageSelection {
 407                 LP_AUTO = 0,
 408                 LP_BABEL,
 409                 LP_CUSTOM,
 410                 LP_NONE
 411         };
 412         ///
 413         LangPackageSelection language_package_selection;
 414         ///
 415         bool rtl_support;
 416         /// bidi cursor movement: true = visual, false = logical
 417         bool visual_cursor;
 418         ///
 419         bool auto_number;
 420         ///
 421         bool mark_foreign_language;
 422         ///
 423         std::string gui_language;
 424         ///
 425         std::string default_otf_view_format;
 426         ///
 427         std::string default_view_format;
 428         /// all available viewers
 429         Alternatives viewer_alternatives;
 430         /// all available editors
 431         Alternatives editor_alternatives;
 432         ///
 433         bool mac_dontswap_ctrl_meta;
 434         ///
 435         bool mac_like_cursor_movement;
 436         ///
 437         bool cursor_follows_scrollbar;
 438         ///
 439         bool scroll_below_document;
 440         ///
 441         enum MacroEditStyle {
 442                 MACRO_EDIT_INLINE_BOX = 0,
 443                 MACRO_EDIT_INLINE,
 444                 MACRO_EDIT_LIST
 445         };
 446         ///
 447         MacroEditStyle macro_edit_style;
 448         ///
 449         bool dialogs_iconify_with_main;
 450         ///
 451         bool display_graphics;
 452         ///
 453         bool show_banner;
 454         ///
 455         enum PreviewStatus {
 456                 PREVIEW_OFF,
 457                 PREVIEW_NO_MATH,
 458                 PREVIEW_ON
 459         };
 460         ///
 461         PreviewStatus preview;
 462         ///
 463         bool preview_hashed_labels;
 464         ///
 465         double preview_scale_factor;
 466         /// user name
 467         std::string user_name;
 468         /// user email
 469         std::string user_email;
 470         /// icon set name
 471         std::string icon_set;
 472         /// whether to use the icons from the theme
 473         bool use_system_theme_icons;
 474         /// True if the TeX engine cannot handle posix paths
 475         bool windows_style_tex_paths;
 476         /// True if the TeX engine can handle file names containing spaces
 477         bool tex_allows_spaces;
 478         /** Prepend paths to the PATH environment variable.
 479          *  The string is input, stored and output in native format.
 480          */
 481         std::string path_prefix;
 482         /** Prepend paths to the TEXINPUTS environment variable.
 483          *  The string is input, stored and output in native format.
 484          *  A '.' here stands for the current document directory.
 485          */
 486         std::string texinputs_prefix;
 487         /// Use the cache for file converters?
 488         bool use_converter_cache;
 489         /// The maximum age of cache files in seconds
 490         unsigned int converter_cache_maxage;
 491         /// Sort layouts alphabetically
 492         bool sort_layouts;
 493         /// Group layout by their category
 494         bool group_layouts;
 495         /// Toggle toolbars in fullscreen mode?
 496         bool full_screen_toolbars;
 497         /// Toggle scrollbar in fullscreen mode?
 498         bool full_screen_scrollbar;
 499         /// Toggle tabbar in fullscreen mode?
 500         bool full_screen_tabbar;
 501         /// Toggle menubar in fullscreen mode?
 502         bool full_screen_menubar;
 503         /// Toggle statusbar in fullscreen mode?
 504         bool full_screen_statusbar;
 505         /// Limit the text width?
 506         bool full_screen_limit;
 507         /// Width of limited screen (in pixels) in fullscreen mode
 508         int full_screen_width;
 509         ///
 510         bool completion_cursor_text;
 511         ///
 512         double completion_inline_delay;
 513         ///
 514         bool completion_inline_math;
 515         ///
 516         bool completion_inline_text;
 517         ///
 518         int completion_inline_dots;
 519         ///
 520         bool autocorrection_math;
 521         ///
 522         double completion_popup_delay;
 523         ///
 524         bool completion_popup_math;
 525         ///
 526         bool completion_popup_text;
 527         ///
 528         bool completion_popup_after_complete;
 529         ///
 530         bool open_buffers_in_tabs;
 531         ///
 532         bool single_close_tab_button;
 533         ///
 534         bool single_instance;
 535         ///
 536         std::string forward_search_dvi;
 537         ///
 538         std::string forward_search_pdf;
 539         ///
 540         int export_overwrite;
 541         /// Default decimal point when aligning table columns on decimal
 542         std::string default_decimal_point;
 543         ///
 544         Length::UNIT default_length_unit;
 545         ///
 546         enum ScrollWheelZoom {
 547                 SCROLL_WHEEL_ZOOM_OFF,
 548                 SCROLL_WHEEL_ZOOM_CTRL,
 549                 SCROLL_WHEEL_ZOOM_SHIFT,
 550                 SCROLL_WHEEL_ZOOM_ALT
 551         };
 552         ///
 553         ScrollWheelZoom scroll_wheel_zoom;
 554         ///
 555         bool force_paint_single_char;
 556         ///
 557         int cursor_width;
 558         /// One of: yes, no, ask
 559         std::string close_buffer_with_last_view;
 560 };
 561
 562
 563 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 564  *  It can be forward-declared and passed as a function argument without
 565  *  having to expose LyXRC.h.
 566  */
 567 class LyXRC_PreviewStatus {
 568         LyXRC::PreviewStatus val_;
 569 public:
 570         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 571         operator LyXRC::PreviewStatus() const { return val_; }
 572 };
 573
 574 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 575
 576 ///
 577 extern LyXRC lyxrc;
 578 ///
 579 extern LyXRC system_lyxrc;
 580
 581 // used by at least frontends/qt4/GuiPref.cpp
 582 const long maxlastfiles = 20;
 583
 584 } // namespace lyx
 585
 586 #endif