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.
23 #include "support/strfwd.h"
33 namespace support { class FileName; }
37 /// This contains the runtime configuration of LyX
42 RC_ACCEPT_COMPOUND = 1,
44 RC_AUTOCORRECTION_MATH,
50 RC_BIBTEX_ALTERNATIVES,
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,
65 RC_CONVERTER_CACHE_MAXAGE,
67 RC_CURSOR_FOLLOWS_SCROLLBAR,
69 RC_DATE_INSERT_FORMAT,
70 RC_DEFAULT_DECIMAL_POINT,
72 RC_DEFAULT_VIEW_FORMAT,
75 RC_DIALOGS_ICONIFY_WITH_MAIN,
78 RC_EDITOR_ALTERNATIVES,
83 RC_FORCE_PAINT_SINGLE_CHAR,
85 RC_FORWARD_SEARCH_DVI,
86 RC_FORWARD_SEARCH_PDF,
88 RC_FULL_SCREEN_SCROLLBAR,
89 RC_FULL_SCREEN_TABBAR,
90 RC_FULL_SCREEN_MENUBAR,
91 RC_FULL_SCREEN_TOOLBARS,
98 RC_INDEX_ALTERNATIVES,
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,
117 RC_MAC_DONTSWAP_CTRL_META,
118 RC_MAC_LIKE_WORD_MOVEMENT,
120 RC_MARK_FOREIGN_LANGUAGE,
121 RC_MOUSE_WHEEL_SPEED,
124 RC_OPEN_BUFFERS_IN_TABS,
125 RC_PARAGRAPH_MARKERS,
127 RC_PLAINTEXT_LINELEN,
129 RC_PREVIEW_HASHED_LABELS,
130 RC_PREVIEW_SCALE_FACTOR,
131 RC_PRINTCOLLCOPIESFLAG,
134 RC_PRINTEVENPAGEFLAG,
135 RC_PRINTEXSTRAOPTIONS,
136 RC_PRINTFILEEXTENSION,
137 RC_PRINTLANDSCAPEFLAG,
139 RC_PRINTPAGERANGEFLAG,
140 RC_PRINTPAPERDIMENSIONFLAG,
143 RC_PRINTSPOOL_COMMAND,
144 RC_PRINTSPOOL_PRINTERPREFIX,
147 RC_PRINT_ADAPTOUTPUT,
152 RC_SCREEN_FONT_ROMAN,
153 RC_SCREEN_FONT_ROMAN_FOUNDRY,
155 RC_SCREEN_FONT_SANS_FOUNDRY,
156 RC_SCREEN_FONT_SCALABLE,
157 RC_SCREEN_FONT_SIZES,
158 RC_SCREEN_FONT_TYPEWRITER,
159 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
161 RC_SCROLL_BELOW_DOCUMENT,
162 RC_SCROLL_WHEEL_ZOOM,
166 RC_SINGLE_CLOSE_TAB_BUTTON,
169 RC_SPELLCHECK_CONTINUOUSLY,
172 RC_SPLITINDEX_COMMAND,
175 RC_TEX_ALLOWS_SPACES,
176 RC_TEX_EXPECTS_WINDOWS_PATHS,
182 RC_USE_CONVERTER_CACHE,
183 RC_USE_SYSTEM_COLORS,
186 RC_VIEWDVI_PAPEROPTION,
188 RC_VIEWER_ALTERNATIVES,
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);
202 bool read(std::istream &);
210 ReturnValues read(Lexer &, bool check_format);
213 typedef std::set<std::string> CommandSet;
214 /// maps a format to a set of commands that can be used to
216 typedef std::map<std::string, CommandSet> Alternatives;
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;
226 // FIXME unused (was used for xforms. Do we still need this?)
227 //static docstring const getDescription(LyXRCTags);
229 std::string bind_file;
231 std::string def_file;
237 std::string print_command;
239 std::string print_evenpage_flag;
241 std::string print_oddpage_flag;
243 std::string print_pagerange_flag;
245 std::string print_copies_flag;
247 std::string print_collcopies_flag;
249 std::string print_reverse_flag;
251 std::string print_landscape_flag;
253 std::string print_to_printer;
255 bool print_adapt_output;
257 std::string print_to_file;
259 std::string print_file_extension;
261 std::string print_extra_options;
263 std::string print_spool_command;
265 std::string print_spool_printerprefix;
267 std::string print_paper_flag;
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 PAPER_SIZE default_papersize;
274 /// command to run chktex incl. options
275 std::string chktex_command;
276 /// all available commands to run bibtex incl. options
277 CommandSet bibtex_alternatives;
278 /// command to run bibtex incl. options
279 std::string bibtex_command;
280 /// command to run japanese bibtex incl. options
281 std::string jbibtex_command;
282 /// all available index commands incl. options
283 CommandSet index_alternatives;
284 /// command to run makeindex incl. options or other index programs
285 std::string index_command;
286 /// command to run japanese index program incl. options
287 std::string jindex_command;
288 /// command to generate multiple indices
289 std::string splitindex_command;
290 /// command to run makeindex incl. options for nomencl
291 std::string nomencl_command;
293 std::string document_path;
295 std::string example_path;
297 std::string template_path;
299 std::string tempdir_path;
301 std::string thesaurusdir_path;
303 std::string hunspelldir_path;
305 bool auto_region_delete;
306 /// flag telling whether lastfiles should be checked for existance
307 bool auto_reset_options;
309 bool check_lastfiles;
310 /// maximal number of lastfiles
311 unsigned int num_lastfiles;
312 /// whether or not go to saved position when opening a file
313 bool use_lastfilepos;
314 /// load files from last session automatically
316 /// do we save new documents as compressed by default
317 bool save_compressed;
318 /// shall a backup file be created
320 /// A directory for storing backup files
321 std::string backupdir_path;
322 /// Whether or not save/restore session information
323 /// like windows position and geometry.
324 bool allow_geometry_session;
325 /// Scrolling speed of the mouse wheel
326 double mouse_wheel_speed;
327 /// Zoom factor for screen fonts
329 /// Screen font sizes in points for each font size
330 std::string font_sizes[10];
331 /// Allow the use of scalable fonts? Default is yes.
332 bool use_scalable_fonts;
338 std::string roman_font_name;
340 std::string sans_font_name;
342 std::string typewriter_font_name;
344 std::string roman_font_foundry;
346 std::string sans_font_foundry;
348 std::string typewriter_font_foundry;
350 unsigned int autosave;
352 unsigned int plaintext_linelen;
353 /// Accept compound words in spellchecker?
354 bool spellchecker_accept_compound;
355 /// End of paragraph markers?
356 bool paragraph_markers;
359 /// Use the colors from current system theme?
360 bool use_system_colors;
361 /// Use pixmap cache?
362 bool use_pixmap_cache;
363 /// Spellchecker engine: aspell, hunspell, etc
364 std::string spellchecker;
365 /// Alternate language for spellchecker
366 std::string spellchecker_alt_lang;
367 /// Escape characters
368 std::string spellchecker_esc_chars;
369 /// spellcheck continuously?
370 bool spellcheck_continuously;
371 /// spellcheck notes and comments?
372 bool spellcheck_notes;
376 std::string primary_kbmap;
378 std::string secondary_kbmap;
380 std::string lyxpipes;
382 std::string date_insert_format;
384 std::string language_custom_package;
386 bool language_auto_begin;
388 bool language_auto_end;
390 std::string language_command_begin;
392 std::string language_command_end;
394 std::string language_command_local;
396 bool language_global_options;
398 enum LangPackageSelection {
405 LangPackageSelection language_package_selection;
408 /// bidi cursor movement: true = visual, false = logical
413 bool mark_foreign_language;
415 std::string default_language;
417 std::string gui_language;
419 std::string default_view_format;
420 /// all available viewers
421 Alternatives viewer_alternatives;
422 /// all available editors
423 Alternatives editor_alternatives;
425 bool mac_dontswap_ctrl_meta;
427 bool mac_like_word_movement;
429 bool cursor_follows_scrollbar;
431 bool scroll_below_document;
433 enum MacroEditStyle {
434 MACRO_EDIT_INLINE_BOX = 0,
439 MacroEditStyle macro_edit_style;
441 bool dialogs_iconify_with_main;
443 bool display_graphics;
453 PreviewStatus preview;
455 bool preview_hashed_labels;
457 double preview_scale_factor;
459 std::string user_name;
461 std::string user_email;
463 std::string icon_set;
464 /// True if the TeX engine cannot handle posix paths
465 bool windows_style_tex_paths;
466 /// True if the TeX engine can handle file names containing spaces
467 bool tex_allows_spaces;
468 /** Prepend paths to the PATH environment variable.
469 * The string is input, stored and output in native format.
471 std::string path_prefix;
472 /// Use the cache for file converters?
473 bool use_converter_cache;
474 /// The maximum age of cache files in seconds
475 unsigned int converter_cache_maxage;
476 /// Sort layouts alphabetically
478 /// Group layout by their category
480 /// Toggle toolbars in fullscreen mode?
481 bool full_screen_toolbars;
482 /// Toggle scrollbar in fullscreen mode?
483 bool full_screen_scrollbar;
484 /// Toggle tabbar in fullscreen mode?
485 bool full_screen_tabbar;
486 /// Toggle menubar in fullscreen mode?
487 bool full_screen_menubar;
488 /// Limit the text width?
489 bool full_screen_limit;
490 /// Width of limited screen (in pixels) in fullscreen mode
491 int full_screen_width;
493 bool completion_cursor_text;
495 double completion_inline_delay;
497 bool completion_inline_math;
499 bool completion_inline_text;
501 int completion_inline_dots;
503 bool autocorrection_math;
505 double completion_popup_delay;
507 bool completion_popup_math;
509 bool completion_popup_text;
511 bool completion_popup_after_complete;
513 bool open_buffers_in_tabs;
515 bool single_close_tab_button;
517 bool single_instance;
519 std::string forward_search_dvi;
521 std::string forward_search_pdf;
523 int export_overwrite;
524 /// Default decimal point when aligning table columns on decimal
525 std::string default_decimal_point;
527 enum ScrollWheelZoom {
528 SCROLL_WHEEL_ZOOM_OFF,
529 SCROLL_WHEEL_ZOOM_CTRL,
530 SCROLL_WHEEL_ZOOM_SHIFT,
531 SCROLL_WHEEL_ZOOM_ALT
534 ScrollWheelZoom scroll_wheel_zoom;
536 bool force_paint_single_char;
542 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
543 * It can be forward-declared and passed as a function argument without
544 * having to expose LyXRC.h.
546 class LyXRC_PreviewStatus {
547 LyXRC::PreviewStatus val_;
549 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
550 operator LyXRC::PreviewStatus() const { return val_; }
553 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
558 extern LyXRC system_lyxrc;
560 // used by at least frontends/qt4/GuiPref.cpp
561 const long maxlastfiles = 20;