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