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"
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_MINLENGTH,
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,
73 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,
183 RC_USE_CONVERTER_CACHE,
184 RC_USE_SYSTEM_COLORS,
188 RC_VIEWDVI_PAPEROPTION,
190 RC_VIEWER_ALTERNATIVES,
192 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
200 /// \param check_format: whether to try to convert the file format,
201 /// if it is not current. this should only be true, really, for the
202 /// user's own preferences file.
203 bool read(support::FileName const & filename, bool check_format);
205 bool read(std::istream &);
213 ReturnValues read(Lexer &, bool check_format);
216 typedef std::set<std::string> CommandSet;
217 /// maps a format to a set of commands that can be used to
219 typedef std::map<std::string, CommandSet> Alternatives;
221 void write(support::FileName const & filename,
222 bool ignore_system_lyxrc) const;
223 /// write rc. If a specific tag is given, only output that one.
224 void write(std::ostream & os,
225 bool ignore_system_lyxrc,
226 std::string const & tag = std::string()) const;
229 // FIXME unused (was used for xforms. Do we still need this?)
230 //static docstring const getDescription(LyXRCTags);
232 std::string bind_file;
234 std::string def_file;
240 std::string print_command;
242 std::string print_evenpage_flag;
244 std::string print_oddpage_flag;
246 std::string print_pagerange_flag;
248 std::string print_copies_flag;
250 std::string print_collcopies_flag;
252 std::string print_reverse_flag;
254 std::string print_landscape_flag;
256 std::string print_to_printer;
258 bool print_adapt_output;
260 std::string print_to_file;
262 std::string print_file_extension;
264 std::string print_extra_options;
266 std::string print_spool_command;
268 std::string print_spool_printerprefix;
270 std::string print_paper_flag;
272 std::string print_paper_dimension_flag;
273 /// option for telling the dvi viewer about the paper size
274 std::string view_dvi_paper_option;
275 /// default paper size for local xdvi/dvips/ghostview/whatever
276 /// command to run chktex incl. options
277 std::string chktex_command;
278 /// all available commands to run bibtex incl. options
279 CommandSet bibtex_alternatives;
280 /// command to run bibtex incl. options
281 std::string bibtex_command;
282 /// command to run japanese bibtex incl. options
283 std::string jbibtex_command;
284 /// all available index commands incl. options
285 CommandSet index_alternatives;
286 /// command to run makeindex incl. options or other index programs
287 std::string index_command;
288 /// command to run japanese index program incl. options
289 std::string jindex_command;
290 /// command to generate multiple indices
291 std::string splitindex_command;
292 /// command to run makeindex incl. options for nomencl
293 std::string nomencl_command;
295 std::string document_path;
297 std::string example_path;
299 std::string template_path;
301 std::string tempdir_path;
303 std::string thesaurusdir_path;
305 std::string hunspelldir_path;
307 bool auto_region_delete;
308 /// flag telling whether lastfiles should be checked for existance
309 bool auto_reset_options;
311 bool check_lastfiles;
312 /// maximal number of lastfiles
313 unsigned int num_lastfiles;
314 /// whether or not go to saved position when opening a file
315 bool use_lastfilepos;
316 /// load files from last session automatically
318 /// do we save new documents as compressed by default
319 bool save_compressed;
320 /// shall a backup file be created
322 /// A directory for storing backup files
323 std::string backupdir_path;
324 /// Whether or not save/restore session information
325 /// like windows position and geometry.
326 bool allow_geometry_session;
327 /// Scrolling speed of the mouse wheel
328 double mouse_wheel_speed;
329 /// Zoom factor for screen fonts
331 /// Screen font sizes in points for each font size
332 std::string font_sizes[10];
333 /// Allow the use of scalable fonts? Default is yes.
334 bool use_scalable_fonts;
340 std::string roman_font_name;
342 std::string sans_font_name;
344 std::string typewriter_font_name;
346 std::string roman_font_foundry;
348 std::string sans_font_foundry;
350 std::string typewriter_font_foundry;
352 unsigned int autosave;
354 unsigned int plaintext_linelen;
355 /// Accept compound words in spellchecker?
356 bool spellchecker_accept_compound;
357 /// End of paragraph markers?
358 bool paragraph_markers;
361 /// Use the colors from current system theme?
362 bool use_system_colors;
363 /// Use pixmap cache?
364 bool use_pixmap_cache;
365 /// Use QImage backend?
367 /// Spellchecker engine: aspell, hunspell, etc
368 std::string spellchecker;
369 /// Alternate language for spellchecker
370 std::string spellchecker_alt_lang;
371 /// Escape characters
372 std::string spellchecker_esc_chars;
373 /// spellcheck continuously?
374 bool spellcheck_continuously;
375 /// spellcheck notes and comments?
376 bool spellcheck_notes;
377 /// minimum length of words to complete
378 unsigned int completion_minlength;
382 std::string primary_kbmap;
384 std::string secondary_kbmap;
386 std::string lyxpipes;
388 std::string date_insert_format;
390 std::string language_custom_package;
392 bool language_auto_begin;
394 bool language_auto_end;
396 std::string language_command_begin;
398 std::string language_command_end;
400 std::string language_command_local;
402 bool language_global_options;
404 enum LangPackageSelection {
411 LangPackageSelection language_package_selection;
414 /// bidi cursor movement: true = visual, false = logical
419 bool mark_foreign_language;
421 std::string gui_language;
423 std::string default_view_format;
424 /// all available viewers
425 Alternatives viewer_alternatives;
426 /// all available editors
427 Alternatives editor_alternatives;
429 bool mac_dontswap_ctrl_meta;
431 bool mac_like_word_movement;
433 bool cursor_follows_scrollbar;
435 bool scroll_below_document;
437 enum MacroEditStyle {
438 MACRO_EDIT_INLINE_BOX = 0,
443 MacroEditStyle macro_edit_style;
445 bool dialogs_iconify_with_main;
447 bool display_graphics;
457 PreviewStatus preview;
459 bool preview_hashed_labels;
461 double preview_scale_factor;
463 std::string user_name;
465 std::string user_email;
467 std::string icon_set;
468 /// True if the TeX engine cannot handle posix paths
469 bool windows_style_tex_paths;
470 /// True if the TeX engine can handle file names containing spaces
471 bool tex_allows_spaces;
472 /** Prepend paths to the PATH environment variable.
473 * The string is input, stored and output in native format.
475 std::string path_prefix;
476 /** Prepend paths to the TEXINPUTS environment variable.
477 * The string is input, stored and output in native format.
478 * A '.' here stands for the current document directory.
480 std::string texinputs_prefix;
481 /// Use the cache for file converters?
482 bool use_converter_cache;
483 /// The maximum age of cache files in seconds
484 unsigned int converter_cache_maxage;
485 /// Sort layouts alphabetically
487 /// Group layout by their category
489 /// Toggle toolbars in fullscreen mode?
490 bool full_screen_toolbars;
491 /// Toggle scrollbar in fullscreen mode?
492 bool full_screen_scrollbar;
493 /// Toggle tabbar in fullscreen mode?
494 bool full_screen_tabbar;
495 /// Toggle menubar in fullscreen mode?
496 bool full_screen_menubar;
497 /// Limit the text width?
498 bool full_screen_limit;
499 /// Width of limited screen (in pixels) in fullscreen mode
500 int full_screen_width;
502 bool completion_cursor_text;
504 double completion_inline_delay;
506 bool completion_inline_math;
508 bool completion_inline_text;
510 int completion_inline_dots;
512 bool autocorrection_math;
514 double completion_popup_delay;
516 bool completion_popup_math;
518 bool completion_popup_text;
520 bool completion_popup_after_complete;
522 bool open_buffers_in_tabs;
524 bool single_close_tab_button;
526 bool single_instance;
528 std::string forward_search_dvi;
530 std::string forward_search_pdf;
532 int export_overwrite;
533 /// Default decimal point when aligning table columns on decimal
534 std::string default_decimal_point;
536 Length::UNIT default_length_unit;
538 enum ScrollWheelZoom {
539 SCROLL_WHEEL_ZOOM_OFF,
540 SCROLL_WHEEL_ZOOM_CTRL,
541 SCROLL_WHEEL_ZOOM_SHIFT,
542 SCROLL_WHEEL_ZOOM_ALT
545 ScrollWheelZoom scroll_wheel_zoom;
547 bool force_paint_single_char;
550 /// One of: yes, no, ask
551 std::string close_buffer_with_last_view;
555 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
556 * It can be forward-declared and passed as a function argument without
557 * having to expose LyXRC.h.
559 class LyXRC_PreviewStatus {
560 LyXRC::PreviewStatus val_;
562 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
563 operator LyXRC::PreviewStatus() const { return val_; }
566 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
571 extern LyXRC system_lyxrc;
573 // used by at least frontends/qt4/GuiPref.cpp
574 const long maxlastfiles = 20;