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