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 "paper.h"
  22 #include "Length.h"
  23
  24 #include "support/strfwd.h"
  25
  26 #include <map>
  27 #include <set>
  28 #include <string>
  29 #include <vector>
  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_CHECKLASTFILES,
  55                 RC_CHKTEX_COMMAND,
  56                 RC_COMPLETION_CURSOR_TEXT,
  57                 RC_COMPLETION_INLINE_DELAY,
  58                 RC_COMPLETION_INLINE_MATH,
  59                 RC_COMPLETION_INLINE_TEXT,
  60                 RC_COMPLETION_INLINE_DOTS,
  61                 RC_COMPLETION_MINLENGTH,
  62                 RC_COMPLETION_POPUP_DELAY,
  63                 RC_COMPLETION_POPUP_MATH,
  64                 RC_COMPLETION_POPUP_TEXT,
  65                 RC_COMPLETION_POPUP_AFTER_COMPLETE,
  66                 RC_CONVERTER,
  67                 RC_CONVERTER_CACHE_MAXAGE,
  68                 RC_COPIER,
  69                 RC_CURSOR_FOLLOWS_SCROLLBAR,
  70                 RC_CURSOR_WIDTH,
  71                 RC_DATE_INSERT_FORMAT,
  72                 RC_DEFAULT_DECIMAL_POINT,
  73                 RC_DEFAULT_LENGTH_UNIT,
  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_FONT_ENCODING,
  84                 RC_FORCE_PAINT_SINGLE_CHAR,
  85                 RC_FILEFORMAT,
  86                 RC_FORWARD_SEARCH_DVI,
  87                 RC_FORWARD_SEARCH_PDF,
  88                 RC_FULL_SCREEN_LIMIT,
  89                 RC_FULL_SCREEN_SCROLLBAR,
  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_WORD_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_VIEWDVI_PAPEROPTION,
 190                 RC_VIEWER,
 191                 RC_VIEWER_ALTERNATIVES,
 192                 RC_VISUAL_CURSOR,
 193                 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
 194                 RC_LAST
 195         };
 196
 197         ///
 198         LyXRC();
 199         ///
 200         void setDefaults();
 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         // FIXME unused (was used for xforms. Do we still need this?)
 231         //static docstring const getDescription(LyXRCTags);
 232         ///
 233         std::string bind_file;
 234         ///
 235         std::string def_file;
 236         ///
 237         std::string ui_file;
 238         ///
 239         std::string printer;
 240         ///
 241         std::string print_command;
 242         ///
 243         std::string print_evenpage_flag;
 244         ///
 245         std::string print_oddpage_flag;
 246         ///
 247         std::string print_pagerange_flag;
 248         ///
 249         std::string print_copies_flag;
 250         ///
 251         std::string print_collcopies_flag;
 252         ///
 253         std::string print_reverse_flag;
 254         ///
 255         std::string print_landscape_flag;
 256         ///
 257         std::string print_to_printer;
 258         ///
 259         bool print_adapt_output;
 260         ///
 261         std::string print_to_file;
 262         ///
 263         std::string print_file_extension;
 264         ///
 265         std::string print_extra_options;
 266         ///
 267         std::string print_spool_command;
 268         ///
 269         std::string print_spool_printerprefix;
 270         ///
 271         std::string print_paper_flag;
 272         ///
 273         std::string print_paper_dimension_flag;
 274         /// option for telling the dvi viewer about the paper size
 275         std::string view_dvi_paper_option;
 276         /// default paper size for local xdvi/dvips/ghostview/whatever
 277         /// command to run chktex incl. options
 278         std::string chktex_command;
 279         /// all available commands to run bibtex incl. options
 280         CommandSet bibtex_alternatives;
 281         /// command to run bibtex incl. options
 282         std::string bibtex_command;
 283         /// command to run japanese bibtex incl. options
 284         std::string jbibtex_command;
 285         /// all available index commands incl. options
 286         CommandSet index_alternatives;
 287         /// command to run makeindex incl. options or other index programs
 288         std::string index_command;
 289         /// command to run japanese index program incl. options
 290         std::string jindex_command;
 291         /// command to generate multiple indices
 292         std::string splitindex_command;
 293         /// command to run makeindex incl. options for nomencl
 294         std::string nomencl_command;
 295         ///
 296         std::string document_path;
 297         ///
 298         std::string example_path;
 299         ///
 300         std::string template_path;
 301         ///
 302         std::string tempdir_path;
 303         ///
 304         std::string thesaurusdir_path;
 305         ///
 306         std::string hunspelldir_path;
 307         ///
 308         bool auto_region_delete;
 309         /// flag telling whether lastfiles should be checked for existance
 310         bool auto_reset_options;
 311         ///
 312         bool check_lastfiles;
 313         /// maximal number of lastfiles
 314         unsigned int num_lastfiles;
 315         /// whether or not go to saved position when opening a file
 316         bool use_lastfilepos;
 317         /// load files from last session automatically
 318         bool load_session;
 319         /// do we save new documents as compressed by default
 320         bool save_compressed;
 321         /// shall a backup file be created
 322         bool make_backup;
 323         /// A directory for storing backup files
 324         std::string backupdir_path;
 325         /// Whether or not save/restore session information
 326         /// like windows position and geometry.
 327         bool allow_geometry_session;
 328         /// Scrolling speed of the mouse wheel
 329         double mouse_wheel_speed;
 330         /// Zoom factor for screen fonts
 331         unsigned int zoom;
 332         /// Screen font sizes in points for each font size
 333         std::string font_sizes[10];
 334         /// Allow the use of scalable fonts? Default is yes.
 335         bool use_scalable_fonts;
 336         /// DPI of monitor
 337         unsigned int dpi;
 338         ///
 339         std::string fontenc;
 340         ///
 341         std::string roman_font_name;
 342         ///
 343         std::string sans_font_name;
 344         ///
 345         std::string typewriter_font_name;
 346         ///
 347         std::string roman_font_foundry;
 348         ///
 349         std::string sans_font_foundry;
 350         ///
 351         std::string typewriter_font_foundry;
 352         ///
 353         unsigned int autosave;
 354         ///
 355         unsigned int plaintext_linelen;
 356         /// Accept compound words in spellchecker?
 357         bool spellchecker_accept_compound;
 358         /// End of paragraph markers?
 359         bool paragraph_markers;
 360         /// Use tooltips?
 361         bool use_tooltip;
 362         /// Use the colors from current system theme?
 363         bool use_system_colors;
 364         /// Use pixmap cache?
 365         bool use_pixmap_cache;
 366         /// Use QImage backend?
 367         bool use_qimage;
 368         /// Spellchecker engine: aspell, hunspell, etc
 369         std::string spellchecker;
 370         /// Alternate language for spellchecker
 371         std::string spellchecker_alt_lang;
 372         /// Escape characters
 373         std::string spellchecker_esc_chars;
 374         /// spellcheck continuously?
 375         bool spellcheck_continuously;
 376         /// spellcheck notes and comments?
 377         bool spellcheck_notes;
 378         /// minimum length of words to complete
 379         unsigned int completion_minlength;
 380         ///
 381         bool use_kbmap;
 382         ///
 383         std::string primary_kbmap;
 384         ///
 385         std::string secondary_kbmap;
 386         ///
 387         std::string lyxpipes;
 388         ///
 389         std::string date_insert_format;
 390         ///
 391         std::string language_custom_package;
 392         ///
 393         bool language_auto_begin;
 394         ///
 395         bool language_auto_end;
 396         ///
 397         std::string language_command_begin;
 398         ///
 399         std::string language_command_end;
 400         ///
 401         std::string language_command_local;
 402         ///
 403         bool language_global_options;
 404         ///
 405         enum LangPackageSelection {
 406                 LP_AUTO = 0,
 407                 LP_BABEL,
 408                 LP_CUSTOM,
 409                 LP_NONE
 410         };
 411         ///
 412         LangPackageSelection language_package_selection;
 413         ///
 414         bool rtl_support;
 415         /// bidi cursor movement: true = visual, false = logical
 416         bool visual_cursor;
 417         ///
 418         bool auto_number;
 419         ///
 420         bool mark_foreign_language;
 421         ///
 422         std::string gui_language;
 423         ///
 424         std::string default_view_format;
 425         /// all available viewers
 426         Alternatives viewer_alternatives;
 427         /// all available editors
 428         Alternatives editor_alternatives;
 429         ///
 430         bool mac_dontswap_ctrl_meta;
 431         ///
 432         bool mac_like_word_movement;
 433         ///
 434         bool cursor_follows_scrollbar;
 435         ///
 436         bool scroll_below_document;
 437         ///
 438         enum MacroEditStyle {
 439                 MACRO_EDIT_INLINE_BOX = 0,
 440                 MACRO_EDIT_INLINE,
 441                 MACRO_EDIT_LIST
 442         };
 443         ///
 444         MacroEditStyle macro_edit_style;
 445         ///
 446         bool dialogs_iconify_with_main;
 447         ///
 448         bool display_graphics;
 449         ///
 450         bool show_banner;
 451         ///
 452         enum PreviewStatus {
 453                 PREVIEW_OFF,
 454                 PREVIEW_NO_MATH,
 455                 PREVIEW_ON
 456         };
 457         ///
 458         PreviewStatus preview;
 459         ///
 460         bool preview_hashed_labels;
 461         ///
 462         double preview_scale_factor;
 463         /// user name
 464         std::string user_name;
 465         /// user email
 466         std::string user_email;
 467         /// icon set name
 468         std::string icon_set;
 469         /// True if the TeX engine cannot handle posix paths
 470         bool windows_style_tex_paths;
 471         /// True if the TeX engine can handle file names containing spaces
 472         bool tex_allows_spaces;
 473         /** Prepend paths to the PATH environment variable.
 474          *  The string is input, stored and output in native format.
 475          */
 476         std::string path_prefix;
 477         /** Prepend paths to the TEXINPUTS environment variable.
 478          *  The string is input, stored and output in native format.
 479          *  A '.' here stands for the current document directory.
 480          */
 481         std::string texinputs_prefix;
 482         /// Use the cache for file converters?
 483         bool use_converter_cache;
 484         /// The maximum age of cache files in seconds
 485         unsigned int converter_cache_maxage;
 486         /// Sort layouts alphabetically
 487         bool sort_layouts;
 488         /// Group layout by their category
 489         bool group_layouts;
 490         /// Toggle toolbars in fullscreen mode?
 491         bool full_screen_toolbars;
 492         /// Toggle scrollbar in fullscreen mode?
 493         bool full_screen_scrollbar;
 494         /// Toggle tabbar in fullscreen mode?
 495         bool full_screen_tabbar;
 496         /// Toggle menubar in fullscreen mode?
 497         bool full_screen_menubar;
 498         /// Limit the text width?
 499         bool full_screen_limit;
 500         /// Width of limited screen (in pixels) in fullscreen mode
 501         int full_screen_width;
 502         ///
 503         bool completion_cursor_text;
 504         ///
 505         double completion_inline_delay;
 506         ///
 507         bool completion_inline_math;
 508         ///
 509         bool completion_inline_text;
 510         ///
 511         int completion_inline_dots;
 512         ///
 513         bool autocorrection_math;
 514         ///
 515         double completion_popup_delay;
 516         ///
 517         bool completion_popup_math;
 518         ///
 519         bool completion_popup_text;
 520         ///
 521         bool completion_popup_after_complete;
 522         ///
 523         bool open_buffers_in_tabs;
 524         ///
 525         bool single_close_tab_button;
 526         ///
 527         bool single_instance;
 528         ///
 529         std::string forward_search_dvi;
 530         ///
 531         std::string forward_search_pdf;
 532         ///
 533         int export_overwrite;
 534         /// Default decimal point when aligning table columns on decimal
 535         std::string default_decimal_point;
 536         ///
 537         Length::UNIT default_length_unit;
 538         ///
 539         enum ScrollWheelZoom {
 540                 SCROLL_WHEEL_ZOOM_OFF,
 541                 SCROLL_WHEEL_ZOOM_CTRL,
 542                 SCROLL_WHEEL_ZOOM_SHIFT,
 543                 SCROLL_WHEEL_ZOOM_ALT
 544         };
 545         ///
 546         ScrollWheelZoom scroll_wheel_zoom;
 547         ///
 548         bool force_paint_single_char;
 549         ///
 550         int cursor_width;
 551         /// One of: yes, no, ask
 552         std::string close_buffer_with_last_view;
 553 };
 554
 555
 556 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 557  *  It can be forward-declared and passed as a function argument without
 558  *  having to expose LyXRC.h.
 559  */
 560 class LyXRC_PreviewStatus {
 561         LyXRC::PreviewStatus val_;
 562 public:
 563         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 564         operator LyXRC::PreviewStatus() const { return val_; }
 565 };
 566
 567 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 568
 569 ///
 570 extern LyXRC lyxrc;
 571 ///
 572 extern LyXRC system_lyxrc;
 573
 574 // used by at least frontends/qt4/GuiPref.cpp
 575 const long maxlastfiles = 20;
 576
 577 } // namespace lyx
 578
 579 #endif