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