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