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"
32 namespace support { class FileName; }
36 /// This contains the runtime configuration of LyX
41 RC_ACCEPT_COMPOUND = 1,
43 RC_AUTOCORRECTION_MATH,
49 RC_BIBTEX_ALTERNATIVES,
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,
65 RC_CONVERTER_CACHE_MAXAGE,
67 RC_CURSOR_FOLLOWS_SCROLLBAR,
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,
75 RC_DIALOGS_ICONIFY_WITH_MAIN,
78 RC_EDITOR_ALTERNATIVES,
84 RC_FORWARD_SEARCH_DVI,
85 RC_FORWARD_SEARCH_PDF,
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,
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_CURSOR_MOVEMENT,
120 RC_MARK_FOREIGN_LANGUAGE,
121 RC_MOUSE_WHEEL_SPEED,
122 RC_MOUSE_MIDDLEBUTTON_PASTE,
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,
189 RC_USE_SYSTEM_THEME_ICONS,
190 RC_VIEWDVI_PAPEROPTION,
192 RC_VIEWER_ALTERNATIVES,
194 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
202 /// \param check_format: whether to try to convert the file format,
203 /// if it is not current. this should only be true, really, for the
204 /// user's own preferences file.
205 bool read(support::FileName const & filename, bool check_format);
207 bool read(std::istream &);
215 ReturnValues read(Lexer &, bool check_format);
218 typedef std::set<std::string> CommandSet;
219 /// maps a format to a set of commands that can be used to
221 typedef std::map<std::string, CommandSet> Alternatives;
223 void write(support::FileName const & filename,
224 bool ignore_system_lyxrc) const;
225 /// write rc. If a specific tag is given, only output that one.
226 void write(std::ostream & os,
227 bool ignore_system_lyxrc,
228 std::string const & tag = std::string()) const;
231 // FIXME unused (was used for xforms. Do we still need this?)
232 //static docstring const getDescription(LyXRCTags);
234 std::string bind_file;
236 std::string def_file;
242 std::string print_command;
244 std::string print_evenpage_flag;
246 std::string print_oddpage_flag;
248 std::string print_pagerange_flag;
250 std::string print_copies_flag;
252 std::string print_collcopies_flag;
254 std::string print_reverse_flag;
256 std::string print_landscape_flag;
258 std::string print_to_printer;
260 bool print_adapt_output;
262 std::string print_to_file;
264 std::string print_file_extension;
266 std::string print_extra_options;
268 std::string print_spool_command;
270 std::string print_spool_printerprefix;
272 std::string print_paper_flag;
274 std::string print_paper_dimension_flag;
275 /// option for telling the dvi viewer about the paper size
276 std::string view_dvi_paper_option;
277 /// default paper size for local xdvi/dvips/ghostview/whatever
278 /// command to run chktex incl. options
279 std::string chktex_command;
280 /// all available commands to run bibtex incl. options
281 CommandSet bibtex_alternatives;
282 /// command to run bibtex incl. options
283 std::string bibtex_command;
284 /// command to run japanese bibtex incl. options
285 std::string jbibtex_command;
286 /// all available index commands incl. options
287 CommandSet index_alternatives;
288 /// command to run makeindex incl. options or other index programs
289 std::string index_command;
290 /// command to run japanese index program incl. options
291 std::string jindex_command;
292 /// command to generate multiple indices
293 std::string splitindex_command;
294 /// command to run makeindex incl. options for nomencl
295 std::string nomencl_command;
297 std::string document_path;
299 std::string example_path;
301 std::string template_path;
303 std::string tempdir_path;
305 std::string thesaurusdir_path;
307 std::string hunspelldir_path;
309 bool auto_region_delete;
310 /// enable middle-mouse-button paste
311 bool mouse_middlebutton_paste;
312 /// flag telling whether lastfiles should be checked for existance
313 bool auto_reset_options;
315 bool check_lastfiles;
316 /// maximal number of lastfiles
317 unsigned int num_lastfiles;
318 /// whether or not go to saved position when opening a file
319 bool use_lastfilepos;
320 /// load files from last session automatically
322 /// do we save new documents as compressed by default
323 bool save_compressed;
324 /// whether or not to save the document dir in the file
326 /// shall a backup file be created
328 /// A directory for storing backup files
329 std::string backupdir_path;
330 /// Whether or not save/restore session information
331 /// like windows position and geometry.
332 bool allow_geometry_session;
333 /// Scrolling speed of the mouse wheel
334 double mouse_wheel_speed;
335 /// Zoom factor for screen fonts
337 /// Screen font sizes in points for each font size
338 std::string font_sizes[10];
339 /// Allow the use of scalable fonts? Default is yes.
340 bool use_scalable_fonts;
346 std::string roman_font_name;
348 std::string sans_font_name;
350 std::string typewriter_font_name;
352 std::string roman_font_foundry;
354 std::string sans_font_foundry;
356 std::string typewriter_font_foundry;
358 unsigned int autosave;
360 unsigned int plaintext_linelen;
361 /// Accept compound words in spellchecker?
362 bool spellchecker_accept_compound;
363 /// End of paragraph markers?
364 bool paragraph_markers;
367 /// Use the colors from current system theme?
368 bool use_system_colors;
369 /// Use pixmap cache?
370 bool use_pixmap_cache;
371 /// Use QImage backend?
373 /// Spellchecker engine: aspell, hunspell, etc
374 std::string spellchecker;
375 /// Alternate language for spellchecker
376 std::string spellchecker_alt_lang;
377 /// Escape characters
378 std::string spellchecker_esc_chars;
379 /// spellcheck continuously?
380 bool spellcheck_continuously;
381 /// spellcheck notes and comments?
382 bool spellcheck_notes;
383 /// minimum length of words to complete
384 unsigned int completion_minlength;
388 std::string primary_kbmap;
390 std::string secondary_kbmap;
392 std::string lyxpipes;
394 std::string date_insert_format;
396 std::string language_custom_package;
398 bool language_auto_begin;
400 bool language_auto_end;
402 std::string language_command_begin;
404 std::string language_command_end;
406 std::string language_command_local;
408 bool language_global_options;
410 enum LangPackageSelection {
417 LangPackageSelection language_package_selection;
418 /// bidi cursor movement: true = visual, false = logical
423 bool mark_foreign_language;
425 std::string gui_language;
427 std::string default_otf_view_format;
429 std::string default_view_format;
430 /// all available viewers
431 Alternatives viewer_alternatives;
432 /// all available editors
433 Alternatives editor_alternatives;
435 bool mac_dontswap_ctrl_meta;
437 bool mac_like_cursor_movement;
439 bool cursor_follows_scrollbar;
441 bool scroll_below_document;
443 enum MacroEditStyle {
444 MACRO_EDIT_INLINE_BOX = 0,
449 MacroEditStyle macro_edit_style;
451 bool dialogs_iconify_with_main;
453 bool display_graphics;
463 PreviewStatus preview;
465 bool preview_hashed_labels;
467 double preview_scale_factor;
469 std::string user_name;
471 std::string user_email;
473 std::string icon_set;
474 /// whether to use the icons from the theme
475 bool use_system_theme_icons;
476 /// True if the TeX engine cannot handle posix paths
477 bool windows_style_tex_paths;
478 /// True if the TeX engine can handle file names containing spaces
479 bool tex_allows_spaces;
480 /** Prepend paths to the PATH environment variable.
481 * The string is input, stored and output in native format.
483 std::string path_prefix;
484 /** Prepend paths to the TEXINPUTS environment variable.
485 * The string is input, stored and output in native format.
486 * A '.' here stands for the current document directory.
488 std::string texinputs_prefix;
489 /// Use the cache for file converters?
490 bool use_converter_cache;
491 /// The maximum age of cache files in seconds
492 unsigned int converter_cache_maxage;
493 /// Sort layouts alphabetically
495 /// Group layout by their category
497 /// Toggle toolbars in fullscreen mode?
498 bool full_screen_toolbars;
499 /// Toggle scrollbar in fullscreen mode?
500 bool full_screen_scrollbar;
501 /// Toggle tabbar in fullscreen mode?
502 bool full_screen_tabbar;
503 /// Toggle menubar in fullscreen mode?
504 bool full_screen_menubar;
505 /// Toggle statusbar in fullscreen mode?
506 bool full_screen_statusbar;
507 /// Limit the text width?
508 bool full_screen_limit;
509 /// Width of limited screen (in pixels) in fullscreen mode
510 int full_screen_width;
512 bool completion_cursor_text;
514 double completion_inline_delay;
516 bool completion_inline_math;
518 bool completion_inline_text;
520 int completion_inline_dots;
522 bool autocorrection_math;
524 double completion_popup_delay;
526 bool completion_popup_math;
528 bool completion_popup_text;
530 bool completion_popup_after_complete;
532 bool open_buffers_in_tabs;
534 bool single_close_tab_button;
536 bool single_instance;
538 std::string forward_search_dvi;
540 std::string forward_search_pdf;
542 int export_overwrite;
543 /// Default decimal point when aligning table columns on decimal
544 std::string default_decimal_point;
546 Length::UNIT default_length_unit;
548 enum ScrollWheelZoom {
549 SCROLL_WHEEL_ZOOM_OFF,
550 SCROLL_WHEEL_ZOOM_CTRL,
551 SCROLL_WHEEL_ZOOM_SHIFT,
552 SCROLL_WHEEL_ZOOM_ALT
555 ScrollWheelZoom scroll_wheel_zoom;
558 /// One of: yes, no, ask
559 std::string close_buffer_with_last_view;
563 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
568 extern LyXRC system_lyxrc;
570 // used by at least frontends/qt4/GuiPref.cpp
571 const long maxlastfiles = 20;