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
  23 #include "support/strfwd.h"
  24
  25 #include <map>
  26 #include <set>
  27 #include <string>
  28 #include <vector>
  29
  30
  31 namespace lyx {
  32
  33 namespace support { class FileName; }
  34
  35 class Lexer;
  36
  37 /// This contains the runtime configuration of LyX
  38 class LyXRC
  39 {
  40 public:
  41         enum LyXRCTags {
  42                 RC_ACCEPT_COMPOUND = 1,
  43                 RC_ALT_LANG,
  44                 RC_AUTOCORRECTION_MATH,
  45                 RC_AUTOREGIONDELETE,
  46                 RC_AUTORESET_OPTIONS,
  47                 RC_AUTOSAVE,
  48                 RC_AUTO_NUMBER,
  49                 RC_BACKUPDIR_PATH,
  50                 RC_BIBTEX_ALTERNATIVES,
  51                 RC_BIBTEX_COMMAND,
  52                 RC_BINDFILE,
  53                 RC_CHECKLASTFILES,
  54                 RC_CHKTEX_COMMAND,
  55                 RC_COMPLETION_CURSOR_TEXT,
  56                 RC_COMPLETION_INLINE_DELAY,
  57                 RC_COMPLETION_INLINE_MATH,
  58                 RC_COMPLETION_INLINE_TEXT,
  59                 RC_COMPLETION_INLINE_DOTS,
  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_DATE_INSERT_FORMAT,
  69                 RC_DEFAULT_DECIMAL_POINT,
  70                 RC_DEFAULT_LANGUAGE,
  71                 RC_DEFAULT_VIEW_FORMAT,
  72                 RC_DEFAULT_PAPERSIZE,
  73                 RC_DEFFILE,
  74                 RC_DIALOGS_ICONIFY_WITH_MAIN,
  75                 RC_DISPLAY_GRAPHICS,
  76                 RC_DOCUMENTPATH,
  77                 RC_EDITOR_ALTERNATIVES,
  78                 RC_ESC_CHARS,
  79                 RC_EXAMPLEPATH,
  80                 RC_EXPORT_OVERWRITE,
  81                 RC_FONT_ENCODING,
  82                 RC_FORMAT,
  83                 RC_FORWARD_SEARCH_DVI,
  84                 RC_FORWARD_SEARCH_PDF,
  85                 RC_FULL_SCREEN_LIMIT,
  86                 RC_FULL_SCREEN_SCROLLBAR,
  87                 RC_FULL_SCREEN_TABBAR,
  88                 RC_FULL_SCREEN_MENUBAR,
  89                 RC_FULL_SCREEN_TOOLBARS,
  90                 RC_FULL_SCREEN_WIDTH,
  91                 RC_GEOMETRY_SESSION,
  92                 RC_GROUP_LAYOUTS,
  93                 RC_GUI_LANGUAGE,
  94                 RC_HUNSPELLDIR_PATH,
  95                 RC_INDEX_ALTERNATIVES,
  96                 RC_INDEX_COMMAND,
  97                 RC_INPUT,
  98                 RC_JBIBTEX_COMMAND,
  99                 RC_JINDEX_COMMAND,
 100                 RC_KBMAP,
 101                 RC_KBMAP_PRIMARY,
 102                 RC_KBMAP_SECONDARY,
 103                 RC_LANGUAGE_AUTO_BEGIN,
 104                 RC_LANGUAGE_AUTO_END,
 105                 RC_LANGUAGE_COMMAND_BEGIN,
 106                 RC_LANGUAGE_COMMAND_END,
 107                 RC_LANGUAGE_COMMAND_LOCAL,
 108                 RC_LANGUAGE_GLOBAL_OPTIONS,
 109                 RC_LANGUAGE_PACKAGE,
 110                 RC_LANGUAGE_USE_BABEL,
 111                 RC_LOADSESSION,
 112                 RC_MACRO_EDIT_STYLE,
 113                 RC_MAC_LIKE_WORD_MOVEMENT,
 114                 RC_MAKE_BACKUP,
 115                 RC_MARK_FOREIGN_LANGUAGE,
 116                 RC_MOUSE_WHEEL_SPEED,
 117                 RC_NOMENCL_COMMAND,
 118                 RC_NUMLASTFILES,
 119                 RC_OPEN_BUFFERS_IN_TABS,
 120                 RC_PARAGRAPH_MARKERS,
 121                 RC_PATH_PREFIX,
 122                 RC_PERS_DICT,
 123                 RC_PLAINTEXT_LINELEN,
 124                 RC_PLAINTEXT_ROFF_COMMAND,
 125                 RC_PREVIEW,
 126                 RC_PREVIEW_HASHED_LABELS,
 127                 RC_PREVIEW_SCALE_FACTOR,
 128                 RC_PRINTCOLLCOPIESFLAG,
 129                 RC_PRINTCOPIESFLAG,
 130                 RC_PRINTER,
 131                 RC_PRINTEVENPAGEFLAG,
 132                 RC_PRINTEXSTRAOPTIONS,
 133                 RC_PRINTFILEEXTENSION,
 134                 RC_PRINTLANDSCAPEFLAG,
 135                 RC_PRINTODDPAGEFLAG,
 136                 RC_PRINTPAGERANGEFLAG,
 137                 RC_PRINTPAPERDIMENSIONFLAG,
 138                 RC_PRINTPAPERFLAG,
 139                 RC_PRINTREVERSEFLAG,
 140                 RC_PRINTSPOOL_COMMAND,
 141                 RC_PRINTSPOOL_PRINTERPREFIX,
 142                 RC_PRINTTOFILE,
 143                 RC_PRINTTOPRINTER,
 144                 RC_PRINT_ADAPTOUTPUT,
 145                 RC_PRINT_COMMAND,
 146                 RC_RTL_SUPPORT,
 147                 RC_SAVE_COMPRESSED,
 148                 RC_SCREEN_DPI,
 149                 RC_SCREEN_FONT_ROMAN,
 150                 RC_SCREEN_FONT_ROMAN_FOUNDRY,
 151                 RC_SCREEN_FONT_SANS,
 152                 RC_SCREEN_FONT_SANS_FOUNDRY,
 153                 RC_SCREEN_FONT_SCALABLE,
 154                 RC_SCREEN_FONT_SIZES,
 155                 RC_SCREEN_FONT_TYPEWRITER,
 156                 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
 157                 RC_SCREEN_ZOOM,
 158                 RC_SCROLL_BELOW_DOCUMENT,
 159                 RC_SCROLL_WHEEL_ZOOM,
 160                 RC_SERVERPIPE,
 161                 RC_SET_COLOR,
 162                 RC_SHOW_BANNER,
 163                 RC_SINGLE_CLOSE_TAB_BUTTON,
 164                 RC_SORT_LAYOUTS,
 165                 RC_SPELL_COMMAND,
 166                 RC_SPELLCHECK_CONTINUOUSLY,
 167                 RC_SPELLCHECK_NOTES,
 168                 RC_SPELLCHECKER,
 169                 RC_SPLITINDEX_COMMAND,
 170                 RC_TEMPDIRPATH,
 171                 RC_TEMPLATEPATH,
 172                 RC_TEX_ALLOWS_SPACES,
 173                 RC_TEX_EXPECTS_WINDOWS_PATHS,
 174                 RC_THESAURUSDIRPATH,
 175                 RC_UIFILE,
 176                 RC_USELASTFILEPOS,
 177                 RC_USER_EMAIL,
 178                 RC_USER_NAME,
 179                 RC_USETEMPDIR,
 180                 RC_USE_ALT_LANG,
 181                 RC_USE_CONVERTER_CACHE,
 182                 RC_USE_ESC_CHARS,
 183                 RC_USE_INP_ENC,
 184                 RC_USE_PERS_DICT,
 185                 RC_USE_SYSTEM_COLORS,
 186                 RC_USE_TOOLTIP,
 187                 RC_USE_PIXMAP_CACHE,
 188                 RC_USE_SPELL_LIB,
 189                 RC_VIEWDVI_PAPEROPTION,
 190                 RC_VIEWER,
 191                 RC_VIEWER_ALTERNATIVES,
 192                 RC_VISUAL_CURSOR,
 193                 RC_LAST
 194         };
 195
 196         ///
 197         LyXRC();
 198         ///
 199         void setDefaults();
 200         ///
 201         int read(support::FileName const & filename);
 202         ///
 203         int read(std::istream &);
 204 private:
 205         ///
 206         int read(Lexer &);
 207 public:
 208         ///
 209         typedef std::set<std::string> CommandSet;
 210         /// maps a format to a set of commands that can be used to
 211         /// edit or view it.
 212         typedef std::map<std::string, CommandSet> Alternatives;
 213         ///
 214         void write(support::FileName const & filename,
 215                    bool ignore_system_lyxrc) const;
 216         /// write rc. If a specific tag is given, only output that one.
 217         void write(std::ostream & os,
 218                    bool ignore_system_lyxrc,
 219                    std::string const & tag = std::string()) const;
 220         ///
 221         void print() const;
 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 printer;
 232         ///
 233         std::string print_command;
 234         ///
 235         std::string print_evenpage_flag;
 236         ///
 237         std::string print_oddpage_flag;
 238         ///
 239         std::string print_pagerange_flag;
 240         ///
 241         std::string print_copies_flag;
 242         ///
 243         std::string print_collcopies_flag;
 244         ///
 245         std::string print_reverse_flag;
 246         ///
 247         std::string print_landscape_flag;
 248         ///
 249         std::string print_to_printer;
 250         ///
 251         bool print_adapt_output;
 252         ///
 253         std::string print_to_file;
 254         ///
 255         std::string print_file_extension;
 256         ///
 257         std::string print_extra_options;
 258         ///
 259         std::string print_spool_command;
 260         ///
 261         std::string print_spool_printerprefix;
 262         ///
 263         std::string print_paper_flag;
 264         ///
 265         std::string print_paper_dimension_flag;
 266         /// option for telling the dvi viewer about the paper size
 267         std::string view_dvi_paper_option;
 268         /// default paper size for local xdvi/dvips/ghostview/whatever
 269         PAPER_SIZE default_papersize;
 270         /// command to run chktex incl. options
 271         std::string chktex_command;
 272         /// all available commands to run bibtex incl. options
 273         CommandSet bibtex_alternatives;
 274         /// command to run bibtex incl. options
 275         std::string bibtex_command;
 276         /// command to run japanese bibtex incl. options
 277         std::string jbibtex_command;
 278         /// all available index commands incl. options
 279         CommandSet index_alternatives;
 280         /// command to run makeindex incl. options or other index programs
 281         std::string index_command;
 282         /// command to run japanese index program incl. options
 283         std::string jindex_command;
 284         /// command to generate multiple indices
 285         std::string splitindex_command;
 286         /// command to run makeindex incl. options for nomencl
 287         std::string nomencl_command;
 288         ///
 289         std::string document_path;
 290         ///
 291         std::string example_path;
 292         ///
 293         std::string template_path;
 294         ///
 295         std::string tempdir_path;
 296         ///
 297         std::string thesaurusdir_path;
 298         ///
 299         std::string hunspelldir_path;
 300         ///
 301         bool auto_region_delete;
 302         /// flag telling whether lastfiles should be checked for existance
 303         bool auto_reset_options;
 304         ///
 305         bool check_lastfiles;
 306         /// maximal number of lastfiles
 307         unsigned int num_lastfiles;
 308         /// whether or not go to saved position when opening a file
 309         bool use_lastfilepos;
 310         /// load files from last session automatically
 311         bool load_session;
 312         /// do we save new documents as compressed by default
 313         bool save_compressed;
 314         /// shall a backup file be created
 315         bool make_backup;
 316         /// A directory for storing backup files
 317         std::string backupdir_path;
 318         /// Whether or not save/restore session information
 319         /// like windows position and geometry.
 320         bool allow_geometry_session;
 321         /// Scrolling speed of the mouse wheel
 322         double mouse_wheel_speed;
 323         /// Zoom factor for screen fonts
 324         unsigned int zoom;
 325         /// Screen font sizes in points for each font size
 326         std::string font_sizes[10];
 327         /// Allow the use of scalable fonts? Default is yes.
 328         bool use_scalable_fonts;
 329         /// DPI of monitor
 330         unsigned int dpi;
 331         ///
 332         std::string fontenc;
 333         ///
 334         std::string roman_font_name;
 335         ///
 336         std::string sans_font_name;
 337         ///
 338         std::string typewriter_font_name;
 339         ///
 340         std::string roman_font_foundry;
 341         ///
 342         std::string sans_font_foundry;
 343         ///
 344         std::string typewriter_font_foundry;
 345         ///
 346         unsigned int autosave;
 347         ///
 348         unsigned int plaintext_linelen;
 349         /// Accept compound words in spellchecker?
 350         bool spellchecker_accept_compound;
 351         /// End of paragraph markers?
 352         bool paragraph_markers;
 353         /// Use tooltips?
 354         bool use_tooltip;
 355         /// Use the colors from current system theme?
 356         bool use_system_colors;
 357         /// Use pixmap cache?
 358         bool use_pixmap_cache;
 359         /// Spellchecker engine: aspell, hunspell, etc
 360         std::string spellchecker;
 361         /// Alternate language for spellchecker
 362         std::string spellchecker_alt_lang;
 363         /// Escape characters
 364         std::string spellchecker_esc_chars;
 365         /// spellcheck continuously?
 366         bool spellcheck_continuously;
 367         /// spellcheck notes and comments?
 368         bool spellcheck_notes;
 369         ///
 370         bool use_kbmap;
 371         ///
 372         std::string primary_kbmap;
 373         ///
 374         std::string secondary_kbmap;
 375         ///
 376         std::string lyxpipes;
 377         ///
 378         std::string date_insert_format;
 379         ///
 380         std::string language_package;
 381         ///
 382         bool language_auto_begin;
 383         ///
 384         bool language_auto_end;
 385         ///
 386         std::string language_command_begin;
 387         ///
 388         std::string language_command_end;
 389         ///
 390         std::string language_command_local;
 391         ///
 392         bool language_global_options;
 393         ///
 394         bool language_use_babel;
 395         ///
 396         bool rtl_support;
 397         /// bidi cursor movement: true = visual, false = logical
 398         bool visual_cursor;
 399         ///
 400         bool auto_number;
 401         ///
 402         bool mark_foreign_language;
 403         ///
 404         std::string default_language;
 405         ///
 406         std::string gui_language;
 407         ///
 408         std::string default_view_format;
 409         /// all available viewers
 410         Alternatives viewer_alternatives;
 411         /// all available editors
 412         Alternatives editor_alternatives;
 413         ///
 414         bool mac_like_word_movement;
 415         ///
 416         bool cursor_follows_scrollbar;
 417         ///
 418         bool scroll_below_document;
 419         ///
 420         enum MacroEditStyle {
 421                 MACRO_EDIT_INLINE_BOX = 0,
 422                 MACRO_EDIT_INLINE,
 423                 MACRO_EDIT_LIST
 424         };
 425         ///
 426         MacroEditStyle macro_edit_style;
 427         ///
 428         bool dialogs_iconify_with_main;
 429         ///
 430         bool display_graphics;
 431         ///
 432         bool show_banner;
 433         ///
 434         enum PreviewStatus {
 435                 PREVIEW_OFF,
 436                 PREVIEW_NO_MATH,
 437                 PREVIEW_ON
 438         };
 439         ///
 440         PreviewStatus preview;
 441         ///
 442         bool preview_hashed_labels;
 443         ///
 444         double preview_scale_factor;
 445         /// user name
 446         std::string user_name;
 447         /// user email
 448         std::string user_email;
 449         /// True if the TeX engine cannot handle posix paths
 450         bool windows_style_tex_paths;
 451         /// True if the TeX engine can handle file names containing spaces
 452         bool tex_allows_spaces;
 453         /** Prepend paths to the PATH environment variable.
 454          *  The string is input, stored and output in native format.
 455          */
 456         std::string path_prefix;
 457         /// Use the cache for file converters?
 458         bool use_converter_cache;
 459         /// The maximum age of cache files in seconds
 460         unsigned int converter_cache_maxage;
 461         /// Sort layouts alphabetically
 462         bool sort_layouts;
 463         /// Group layout by their category
 464         bool group_layouts;
 465         /// Toggle toolbars in fullscreen mode?
 466         bool full_screen_toolbars;
 467         /// Toggle scrollbar in fullscreen mode?
 468         bool full_screen_scrollbar;
 469         /// Toggle tabbar in fullscreen mode?
 470         bool full_screen_tabbar;
 471         /// Toggle menubar in fullscreen mode?
 472         bool full_screen_menubar;
 473         /// Limit the text width?
 474         bool full_screen_limit;
 475         /// Width of limited screen (in pixels) in fullscreen mode
 476         int full_screen_width;
 477         ///
 478         bool completion_cursor_text;
 479         ///
 480         double completion_inline_delay;
 481         ///
 482         bool completion_inline_math;
 483         ///
 484         bool completion_inline_text;
 485         ///
 486         int completion_inline_dots;
 487         ///
 488         bool autocorrection_math;
 489         ///
 490         double completion_popup_delay;
 491         ///
 492         bool completion_popup_math;
 493         ///
 494         bool completion_popup_text;
 495         ///
 496         bool completion_popup_after_complete;
 497         ///
 498         bool open_buffers_in_tabs;
 499         ///
 500         bool single_close_tab_button;
 501         ///
 502         std::string forward_search_dvi;
 503         ///
 504         std::string forward_search_pdf;
 505         ///
 506         int export_overwrite;
 507         /// Default decimal point when aligning table columns on decimal
 508         std::string default_decimal_point;
 509         ///
 510         enum ScrollWheelZoom {
 511                 SCROLL_WHEEL_ZOOM_OFF,
 512                 SCROLL_WHEEL_ZOOM_CTRL,
 513                 SCROLL_WHEEL_ZOOM_SHIFT,
 514                 SCROLL_WHEEL_ZOOM_ALT
 515         };
 516         ///
 517         ScrollWheelZoom scroll_wheel_zoom;
 518 };
 519
 520
 521 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 522  *  It can be forward-declared and passed as a function argument without
 523  *  having to expose LyXRC.h.
 524  */
 525 class LyXRC_PreviewStatus {
 526         LyXRC::PreviewStatus val_;
 527 public:
 528         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 529         operator LyXRC::PreviewStatus() const { return val_; }
 530 };
 531
 532 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 533
 534 ///
 535 extern LyXRC lyxrc;
 536 ///
 537 extern LyXRC system_lyxrc;
 538
 539 // used by at least frontends/qt4/GuiPref.cpp
 540 const long maxlastfiles = 20;
 541
 542 } // namespace lyx
 543
 544 #endif