4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
15 * Full author contact details are available in file CREDITS.
24 #include "support/strfwd.h"
34 namespace support { class FileName; }
38 /// This contains the runtime configuration of LyX
43 RC_ACCEPT_COMPOUND = 1,
45 RC_AUTOCORRECTION_MATH,
51 RC_BIBTEX_ALTERNATIVES,
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_POPUP_DELAY,
62 RC_COMPLETION_POPUP_MATH,
63 RC_COMPLETION_POPUP_TEXT,
64 RC_COMPLETION_POPUP_AFTER_COMPLETE,
66 RC_CONVERTER_CACHE_MAXAGE,
68 RC_CURSOR_FOLLOWS_SCROLLBAR,
70 RC_DATE_INSERT_FORMAT,
71 RC_DEFAULT_DECIMAL_POINT,
72 RC_DEFAULT_LENGTH_UNIT,
74 RC_DEFAULT_VIEW_FORMAT,
76 RC_DIALOGS_ICONIFY_WITH_MAIN,
79 RC_EDITOR_ALTERNATIVES,
84 RC_FORCE_PAINT_SINGLE_CHAR,
86 RC_FORWARD_SEARCH_DVI,
87 RC_FORWARD_SEARCH_PDF,
89 RC_FULL_SCREEN_SCROLLBAR,
90 RC_FULL_SCREEN_TABBAR,
91 RC_FULL_SCREEN_MENUBAR,
92 RC_FULL_SCREEN_TOOLBARS,
99 RC_INDEX_ALTERNATIVES,
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,
118 RC_MAC_DONTSWAP_CTRL_META,
119 RC_MAC_LIKE_WORD_MOVEMENT,
121 RC_MARK_FOREIGN_LANGUAGE,
122 RC_MOUSE_WHEEL_SPEED,
125 RC_OPEN_BUFFERS_IN_TABS,
126 RC_PARAGRAPH_MARKERS,
128 RC_PLAINTEXT_LINELEN,
130 RC_PREVIEW_HASHED_LABELS,
131 RC_PREVIEW_SCALE_FACTOR,
132 RC_PRINTCOLLCOPIESFLAG,
135 RC_PRINTEVENPAGEFLAG,
136 RC_PRINTEXSTRAOPTIONS,
137 RC_PRINTFILEEXTENSION,
138 RC_PRINTLANDSCAPEFLAG,
140 RC_PRINTPAGERANGEFLAG,
141 RC_PRINTPAPERDIMENSIONFLAG,
144 RC_PRINTSPOOL_COMMAND,
145 RC_PRINTSPOOL_PRINTERPREFIX,
148 RC_PRINT_ADAPTOUTPUT,
153 RC_SCREEN_FONT_ROMAN,
154 RC_SCREEN_FONT_ROMAN_FOUNDRY,
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,
162 RC_SCROLL_BELOW_DOCUMENT,
163 RC_SCROLL_WHEEL_ZOOM,
167 RC_SINGLE_CLOSE_TAB_BUTTON,
170 RC_SPELLCHECK_CONTINUOUSLY,
173 RC_SPLITINDEX_COMMAND,
176 RC_TEX_ALLOWS_SPACES,
177 RC_TEX_EXPECTS_WINDOWS_PATHS,
184 RC_USE_CONVERTER_CACHE,
185 RC_USE_SYSTEM_COLORS,
188 RC_VIEWDVI_PAPEROPTION,
190 RC_VIEWER_ALTERNATIVES,
199 /// \param check_format: whether to try to convert the file format,
200 /// if it is not current. this should only be true, really, for the
201 /// user's own preferences file.
202 bool read(support::FileName const & filename, bool check_format);
204 bool read(std::istream &);
212 ReturnValues read(Lexer &, bool check_format);
215 typedef std::set<std::string> CommandSet;
216 /// maps a format to a set of commands that can be used to
218 typedef std::map<std::string, CommandSet> Alternatives;
220 void write(support::FileName const & filename,
221 bool ignore_system_lyxrc) const;
222 /// write rc. If a specific tag is given, only output that one.
223 void write(std::ostream & os,
224 bool ignore_system_lyxrc,
225 std::string const & tag = std::string()) const;
228 // FIXME unused (was used for xforms. Do we still need this?)
229 //static docstring const getDescription(LyXRCTags);
231 std::string bind_file;
233 std::string def_file;
239 std::string print_command;
241 std::string print_evenpage_flag;
243 std::string print_oddpage_flag;
245 std::string print_pagerange_flag;
247 std::string print_copies_flag;
249 std::string print_collcopies_flag;
251 std::string print_reverse_flag;
253 std::string print_landscape_flag;
255 std::string print_to_printer;
257 bool print_adapt_output;
259 std::string print_to_file;
261 std::string print_file_extension;
263 std::string print_extra_options;
265 std::string print_spool_command;
267 std::string print_spool_printerprefix;
269 std::string print_paper_flag;
271 std::string print_paper_dimension_flag;
272 /// option for telling the dvi viewer about the paper size
273 std::string view_dvi_paper_option;
274 /// default paper size for local xdvi/dvips/ghostview/whatever
275 /// command to run chktex incl. options
276 std::string chktex_command;
277 /// all available commands to run bibtex incl. options
278 CommandSet bibtex_alternatives;
279 /// command to run bibtex incl. options
280 std::string bibtex_command;
281 /// command to run japanese bibtex incl. options
282 std::string jbibtex_command;
283 /// all available index commands incl. options
284 CommandSet index_alternatives;
285 /// command to run makeindex incl. options or other index programs
286 std::string index_command;
287 /// command to run japanese index program incl. options
288 std::string jindex_command;
289 /// command to generate multiple indices
290 std::string splitindex_command;
291 /// command to run makeindex incl. options for nomencl
292 std::string nomencl_command;
294 std::string document_path;
296 std::string example_path;
298 std::string template_path;
300 std::string tempdir_path;
302 std::string thesaurusdir_path;
304 std::string hunspelldir_path;
306 bool auto_region_delete;
307 /// flag telling whether lastfiles should be checked for existance
308 bool auto_reset_options;
310 bool check_lastfiles;
311 /// maximal number of lastfiles
312 unsigned int num_lastfiles;
313 /// whether or not go to saved position when opening a file
314 bool use_lastfilepos;
315 /// load files from last session automatically
317 /// do we save new documents as compressed by default
318 bool save_compressed;
319 /// shall a backup file be created
321 /// A directory for storing backup files
322 std::string backupdir_path;
323 /// Whether or not save/restore session information
324 /// like windows position and geometry.
325 bool allow_geometry_session;
326 /// Scrolling speed of the mouse wheel
327 double mouse_wheel_speed;
328 /// Zoom factor for screen fonts
330 /// Screen font sizes in points for each font size
331 std::string font_sizes[10];
332 /// Allow the use of scalable fonts? Default is yes.
333 bool use_scalable_fonts;
339 std::string roman_font_name;
341 std::string sans_font_name;
343 std::string typewriter_font_name;
345 std::string roman_font_foundry;
347 std::string sans_font_foundry;
349 std::string typewriter_font_foundry;
351 unsigned int autosave;
353 unsigned int plaintext_linelen;
354 /// Accept compound words in spellchecker?
355 bool spellchecker_accept_compound;
356 /// End of paragraph markers?
357 bool paragraph_markers;
360 /// Use the colors from current system theme?
361 bool use_system_colors;
362 /// Use pixmap cache?
363 bool use_pixmap_cache;
364 /// Spellchecker engine: aspell, hunspell, etc
365 std::string spellchecker;
366 /// Alternate language for spellchecker
367 std::string spellchecker_alt_lang;
368 /// Escape characters
369 std::string spellchecker_esc_chars;
370 /// spellcheck continuously?
371 bool spellcheck_continuously;
372 /// spellcheck notes and comments?
373 bool spellcheck_notes;
377 std::string primary_kbmap;
379 std::string secondary_kbmap;
381 std::string lyxpipes;
383 std::string date_insert_format;
385 std::string language_custom_package;
387 bool language_auto_begin;
389 bool language_auto_end;
391 std::string language_command_begin;
393 std::string language_command_end;
395 std::string language_command_local;
397 bool language_global_options;
399 enum LangPackageSelection {
406 LangPackageSelection language_package_selection;
409 /// bidi cursor movement: true = visual, false = logical
414 bool mark_foreign_language;
416 std::string default_language;
418 std::string gui_language;
420 std::string default_view_format;
421 /// all available viewers
422 Alternatives viewer_alternatives;
423 /// all available editors
424 Alternatives editor_alternatives;
426 bool mac_dontswap_ctrl_meta;
428 bool mac_like_word_movement;
430 bool cursor_follows_scrollbar;
432 bool scroll_below_document;
434 enum MacroEditStyle {
435 MACRO_EDIT_INLINE_BOX = 0,
440 MacroEditStyle macro_edit_style;
442 bool dialogs_iconify_with_main;
444 bool display_graphics;
454 PreviewStatus preview;
456 bool preview_hashed_labels;
458 double preview_scale_factor;
460 std::string user_name;
462 std::string user_email;
464 std::string icon_set;
465 /// True if the TeX engine cannot handle posix paths
466 bool windows_style_tex_paths;
467 /// True if the TeX engine can handle file names containing spaces
468 bool tex_allows_spaces;
469 /** Prepend paths to the PATH environment variable.
470 * The string is input, stored and output in native format.
472 std::string path_prefix;
473 /** Prepend paths to the TEXINPUTS environment variable.
474 * The string is input, stored and output in native format.
475 * A '.' here stands for the current document directory.
477 std::string texinputs_prefix;
478 /// Use the cache for file converters?
479 bool use_converter_cache;
480 /// The maximum age of cache files in seconds
481 unsigned int converter_cache_maxage;
482 /// Sort layouts alphabetically
484 /// Group layout by their category
486 /// Toggle toolbars in fullscreen mode?
487 bool full_screen_toolbars;
488 /// Toggle scrollbar in fullscreen mode?
489 bool full_screen_scrollbar;
490 /// Toggle tabbar in fullscreen mode?
491 bool full_screen_tabbar;
492 /// Toggle menubar in fullscreen mode?
493 bool full_screen_menubar;
494 /// Limit the text width?
495 bool full_screen_limit;
496 /// Width of limited screen (in pixels) in fullscreen mode
497 int full_screen_width;
499 bool completion_cursor_text;
501 double completion_inline_delay;
503 bool completion_inline_math;
505 bool completion_inline_text;
507 int completion_inline_dots;
509 bool autocorrection_math;
511 double completion_popup_delay;
513 bool completion_popup_math;
515 bool completion_popup_text;
517 bool completion_popup_after_complete;
519 bool open_buffers_in_tabs;
521 bool single_close_tab_button;
523 bool single_instance;
525 std::string forward_search_dvi;
527 std::string forward_search_pdf;
529 int export_overwrite;
530 /// Default decimal point when aligning table columns on decimal
531 std::string default_decimal_point;
533 Length::UNIT default_length_unit;
535 enum ScrollWheelZoom {
536 SCROLL_WHEEL_ZOOM_OFF,
537 SCROLL_WHEEL_ZOOM_CTRL,
538 SCROLL_WHEEL_ZOOM_SHIFT,
539 SCROLL_WHEEL_ZOOM_ALT
542 ScrollWheelZoom scroll_wheel_zoom;
544 bool force_paint_single_char;
550 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
551 * It can be forward-declared and passed as a function argument without
552 * having to expose LyXRC.h.
554 class LyXRC_PreviewStatus {
555 LyXRC::PreviewStatus val_;
557 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
558 operator LyXRC::PreviewStatus() const { return val_; }
561 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
566 extern LyXRC system_lyxrc;
568 // used by at least frontends/qt4/GuiPref.cpp
569 const long maxlastfiles = 20;