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/Length.h"
24 #include "support/strfwd.h"
25 #include "support/userinfo.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,
54 RC_BOOKMARKS_VISIBILITY,
58 RC_CITATION_SEARCH_PATTERN,
59 RC_CITATION_SEARCH_VIEW,
60 RC_COMPLETION_CURSOR_TEXT,
61 RC_COMPLETION_INLINE_DELAY,
62 RC_COMPLETION_INLINE_MATH,
63 RC_COMPLETION_INLINE_TEXT,
64 RC_COMPLETION_INLINE_DOTS,
65 RC_COMPLETION_MINLENGTH,
66 RC_COMPLETION_POPUP_DELAY,
67 RC_COMPLETION_POPUP_MATH,
68 RC_COMPLETION_POPUP_TEXT,
69 RC_COMPLETION_POPUP_AFTER_COMPLETE,
71 RC_CONVERTER_CACHE_MAXAGE,
73 RC_CT_ADDITIONS_UNDERLINED,
75 RC_CURSOR_FOLLOWS_SCROLLBAR,
77 RC_DEFAULT_DECIMAL_SEP,
78 RC_DEFAULT_LENGTH_UNIT,
79 RC_DEFAULT_OTF_VIEW_FORMAT,
80 RC_DEFAULT_PLATEX_VIEW_FORMAT,
81 RC_DEFAULT_VIEW_FORMAT,
83 RC_DIALOGS_ICONIFY_WITH_MAIN,
86 RC_EDITOR_ALTERNATIVES,
91 RC_FORWARD_SEARCH_DVI,
92 RC_FORWARD_SEARCH_PDF,
94 RC_FULL_SCREEN_SCROLLBAR,
95 RC_FULL_SCREEN_STATUSBAR,
96 RC_FULL_SCREEN_TABBAR,
97 RC_FULL_SCREEN_MENUBAR,
98 RC_FULL_SCREEN_TOOLBARS,
105 RC_INDEX_ALTERNATIVES,
108 RC_JBIBTEX_ALTERNATIVES,
114 RC_LANGUAGE_AUTO_BEGIN,
115 RC_LANGUAGE_AUTO_END,
116 RC_LANGUAGE_COMMAND_BEGIN,
117 RC_LANGUAGE_COMMAND_END,
118 RC_LANGUAGE_COMMAND_LOCAL,
119 RC_LANGUAGE_GLOBAL_OPTIONS,
120 RC_LANGUAGE_CUSTOM_PACKAGE,
121 RC_LANGUAGE_PACKAGE_SELECTION,
125 RC_MAC_DONTSWAP_CTRL_META,
126 RC_MAC_LIKE_CURSOR_MOVEMENT,
128 RC_MARK_FOREIGN_LANGUAGE,
129 RC_MOUSE_WHEEL_SPEED,
130 RC_MOUSE_MIDDLEBUTTON_PASTE,
133 RC_OPEN_BUFFERS_IN_TABS,
134 RC_PARAGRAPH_MARKERS,
136 RC_PLAINTEXT_LINELEN,
138 RC_PREVIEW_HASHED_LABELS,
139 RC_PREVIEW_SCALE_FACTOR,
140 RC_PRINTLANDSCAPEFLAG,
141 RC_PRINTPAPERDIMENSIONFLAG,
143 RC_PYGMENTIZE_COMMAND,
144 RC_RESPECT_OS_KBD_LANGUAGE,
148 RC_SCREEN_FONT_ROMAN,
149 RC_SCREEN_FONT_ROMAN_FOUNDRY,
151 RC_SCREEN_FONT_SANS_FOUNDRY,
152 RC_SCREEN_FONT_SCALABLE,
153 RC_SCREEN_FONT_SIZES,
154 RC_SCREEN_FONT_TYPEWRITER,
155 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
157 RC_SCROLL_BELOW_DOCUMENT,
158 RC_SCROLL_WHEEL_ZOOM,
162 RC_SINGLE_CLOSE_TAB_BUTTON,
165 RC_SPELLCHECK_CONTINUOUSLY,
168 RC_SPLITINDEX_COMMAND,
171 RC_TEX_ALLOWS_SPACES,
172 RC_TEX_EXPECTS_WINDOWS_PATHS,
180 RC_USE_CONVERTER_CACHE,
181 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
182 RC_USE_CONVERTER_NEEDAUTH,
183 RC_USE_NATIVE_FILEDIALOG,
184 RC_USE_SYSTEM_COLORS,
186 RC_USE_SYSTEM_THEME_ICONS,
187 RC_VIEWDVI_PAPEROPTION,
189 RC_VIEWER_ALTERNATIVES,
191 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
197 LyXRC() : user_name(support::user_name()),
198 user_email(support::user_email()) // always empty
201 /// \param check_format: whether to try to convert the file format,
202 /// if it is not current. this should only be true, really, for the
203 /// user's own preferences file.
204 bool read(support::FileName const & filename, bool check_format);
206 bool read(std::istream &);
214 ReturnValues read(Lexer &, bool check_format);
217 typedef std::set<std::string> CommandSet;
218 /// maps a format to a set of commands that can be used to
220 typedef std::map<std::string, CommandSet> Alternatives;
222 void write(support::FileName const & filename,
223 bool ignore_system_lyxrc) const;
224 /// write rc. If a specific tag is given, only output that one.
225 void write(std::ostream & os,
226 bool ignore_system_lyxrc,
227 std::string const & tag = std::string()) const;
231 std::set<std::string> getRCs();
232 // FIXME unused (was used for xforms. Do we still need this?)
233 //static docstring const getDescription(LyXRCTags);
235 std::string bind_file = "cua";
237 std::string def_file = "default";
239 std::string ui_file = "default";
241 std::string print_landscape_flag = "-t landscape";
243 std::string print_paper_flag = "-t";
245 std::string print_paper_dimension_flag = "-T";
246 /// option for telling the dvi viewer about the paper size
247 std::string view_dvi_paper_option;
248 /// default paper size for local xdvi/dvips/ghostview/whatever
249 /// command to run chktex incl. options
250 std::string chktex_command = "chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38";
251 /// Use external script to search for file corresponding to a
253 bool citation_search = false;
254 /// Name of external script which searches for file corresponding to a
255 /// given citation. At this moment only script lyxpaperview.p is supported
256 /// (search for pdf or ps based on specific items)
257 std::string citation_search_view;
258 /// Items to search for in citation_search_view
259 std::string citation_search_pattern = "%year% %abbrvciteauthor%";
260 /// all available commands to run bibtex incl. options
261 CommandSet bibtex_alternatives;
262 /// command to run bibtex incl. options
263 std::string bibtex_command = "automatic";
264 /// command to run japanese bibtex incl. options
265 std::string jbibtex_command;
266 /// all available commands to run japanese bibtex incl. options
267 CommandSet jbibtex_alternatives;
268 /// all available index commands incl. options
269 CommandSet index_alternatives;
270 /// command to run makeindex incl. options or other index programs
271 std::string index_command = "makeindex -c -q";
272 /// command to run japanese index program incl. options
273 std::string jindex_command;
274 /// command to generate multiple indices
275 std::string splitindex_command;
276 /// command to run makeindex incl. options for nomencl
277 std::string nomencl_command = "makeindex -s nomencl.ist";
278 /// command to run the python pygments syntax highlighter
279 std::string pygmentize_command;
281 std::string document_path;
283 std::string example_path;
285 std::string template_path;
287 std::string tempdir_path;
289 std::string thesaurusdir_path;
291 std::string hunspelldir_path;
293 bool auto_region_delete = true;
294 /// enable middle-mouse-button paste
295 bool mouse_middlebutton_paste = true;
297 bool auto_reset_options = false;
298 /// flag telling whether lastfiles should be checked for existance
299 bool check_lastfiles = true;
300 /// maximal number of lastfiles
301 unsigned int num_lastfiles = 20;
302 /// whether or not go to saved position when opening a file
303 bool use_lastfilepos = true;
304 /// load files from last session automatically
305 bool load_session = false;
306 /// do we save new documents as compressed by default
307 bool save_compressed = false;
308 /// whether or not to save the document dir in the file
309 bool save_origin = false;
310 /// shall a backup file be created
311 bool make_backup = true;
312 /// A directory for storing backup files
313 std::string backupdir_path;
314 /// Whether or not save/restore session information
315 /// like windows position and geometry.
316 bool allow_geometry_session = true;
317 /// Scrolling speed of the mouse wheel
318 double mouse_wheel_speed = 1.0;
319 /// Default zoom factor for screen fonts
320 int defaultZoom = 150;
321 /// Actual zoom factor for screen fonts
322 /// (default zoom plus buffer zoom factor)
323 /// Do not set directly. Use GuiView::setCurrentZoom()
324 int currentZoom = 150;
325 /// Screen font sizes in points for each font size
326 std::string font_sizes[10] = { "5.0", "7.0", "8.0", "9.0", "10.0",
327 "12.0", "14.4", "17.26", "20.74", "24.88"};
328 /// Allow the use of scalable fonts? Default is yes.
329 bool use_scalable_fonts = true;
331 unsigned int dpi = 75;
333 std::string roman_font_name;
335 std::string sans_font_name;
337 std::string typewriter_font_name;
339 std::string roman_font_foundry;
341 std::string sans_font_foundry;
343 std::string typewriter_font_foundry;
345 unsigned int autosave = 300;
347 unsigned int plaintext_linelen = 65;
348 /// End of paragraph markers?
349 bool paragraph_markers = false;
351 bool use_tooltip = true;
352 /// Use the colors from current system theme?
353 bool use_system_colors = false;
354 /// use native file dialog or our own ?
355 bool use_native_filedialog = true;
356 /// Spellchecker engine: aspell, hunspell, etc
357 std::string spellchecker
358 #if defined(USE_MACOSX_PACKAGING)
360 #elif defined(USE_ENCHANT)
362 #elif defined(USE_ASPELL)
364 #elif defined(USE_HUNSPELL)
369 /// Alternate language for spellchecker
370 std::string spellchecker_alt_lang;
371 /// Escape characters
372 std::string spellchecker_esc_chars;
373 /// Accept compound words in spellchecker?
374 bool spellchecker_accept_compound = false;
375 /// spellcheck continuously?
376 bool spellcheck_continuously = true;
377 /// spellcheck notes and comments?
378 bool spellcheck_notes = true;
380 bool use_kbmap = false;
382 std::string primary_kbmap;
384 std::string secondary_kbmap;
386 std::string lyxpipes;
388 std::string language_custom_package = "\\usepackage{babel}";
390 bool language_auto_begin = true;
392 bool language_auto_end = true;
394 std::string language_command_begin = "\\selectlanguage{$$lang}";
396 std::string language_command_end;
398 std::string language_command_local = "\\foreignlanguage{$$lang}{";
400 bool language_global_options = true;
402 enum LangPackageSelection {
409 LangPackageSelection language_package_selection = LP_AUTO;
410 /// bidi cursor movement: true = visual, false = logical
411 bool visual_cursor = false;
413 bool auto_number = true;
415 bool mark_foreign_language = true;
417 std::string gui_language = "auto";
419 bool respect_os_kbd_language = false;
421 std::string default_otf_view_format = "pdf4";
423 std::string default_platex_view_format = "pdf3";
425 std::string default_view_format = "pdf2";
426 /// all available viewers
427 Alternatives viewer_alternatives;
428 /// all available editors
429 Alternatives editor_alternatives;
431 bool mac_dontswap_ctrl_meta = false;
433 bool mac_like_cursor_movement = false;
435 bool cursor_follows_scrollbar = false;
437 bool ct_additions_underlined = true;
439 bool ct_markup_copied = false;
441 bool scroll_below_document = false;
443 enum MacroEditStyle {
444 MACRO_EDIT_INLINE_BOX = 0,
449 MacroEditStyle macro_edit_style = MACRO_EDIT_INLINE_BOX;
451 bool dialogs_iconify_with_main = false;
453 bool display_graphics = true;
455 bool show_banner = true;
463 PreviewStatus preview = PREVIEW_OFF;
465 bool preview_hashed_labels = false;
467 double preview_scale_factor = 1.0;
469 std::string user_name; // set in constructor
471 std::string user_email; // set in constructor (empty for now)
473 std::string user_initials;
475 std::string icon_set;
476 /// whether to use the icons from the theme
477 bool use_system_theme_icons = false;
478 /// True if the TeX engine cannot handle posix paths
479 bool windows_style_tex_paths = false;
480 /// True if the TeX engine can handle file names containing spaces
481 bool tex_allows_spaces = false;
482 /** Prepend paths to the PATH environment variable.
483 * The string is input, stored and output in native format.
485 std::string path_prefix;
486 /** Prepend paths to the TEXINPUTS environment variable.
487 * The string is input, stored and output in native format.
488 * A '.' here stands for the current document directory.
490 std::string texinputs_prefix = ".";
491 /// Use the cache for file converters?
492 bool use_converter_cache = true;
493 /// Forbid use of external converters with 'needauth' option
494 bool use_converter_needauth_forbidden = true;
495 /// Ask user before calling external converters with 'needauth' option
496 bool use_converter_needauth = true;
497 /// The maximum age of cache files in seconds
498 unsigned int converter_cache_maxage = 6 * 30 * 24 * 3600; // 6 months;
499 /// Sort layouts alphabetically
500 bool sort_layouts = false;
501 /// Group layout by their category
502 bool group_layouts = true;
503 /// Toggle toolbars in fullscreen mode?
504 bool full_screen_toolbars = true;
505 /// Toggle scrollbar in fullscreen mode?
506 bool full_screen_scrollbar = true;
507 /// Toggle tabbar in fullscreen mode?
508 bool full_screen_tabbar = true;
509 /// Toggle menubar in fullscreen mode?
510 bool full_screen_menubar = true;
511 /// Toggle statusbar in fullscreen mode?
512 bool full_screen_statusbar = true;
513 /// Limit the text width?
514 bool full_screen_limit = false;
515 /// Width of limited screen (in pixels) in fullscreen mode
516 int full_screen_width = 700;
518 bool completion_cursor_text = true;
520 double completion_inline_delay = 0.2;
522 bool completion_inline_math = true;
524 bool completion_inline_text = false;
526 int completion_inline_dots = -1;
527 /// minimum length of words to complete
528 unsigned int completion_minlength = 6;
530 double completion_popup_delay = 2.0;
532 bool completion_popup_math = true;
534 bool completion_popup_text = false;
536 bool completion_popup_after_complete = true;
538 bool autocorrection_math = false;
540 bool open_buffers_in_tabs = true;
542 bool single_close_tab_button = false;
544 bool single_instance = true;
546 std::string forward_search_dvi;
548 std::string forward_search_pdf;
550 int export_overwrite = NO_FILES;
551 /// Default decimal point when aligning table columns on decimal
552 std::string default_decimal_sep = "locale";
554 Length::UNIT default_length_unit = Length::CM;
556 enum ScrollWheelZoom {
557 SCROLL_WHEEL_ZOOM_OFF,
558 SCROLL_WHEEL_ZOOM_CTRL,
559 SCROLL_WHEEL_ZOOM_SHIFT,
560 SCROLL_WHEEL_ZOOM_ALT
563 ScrollWheelZoom scroll_wheel_zoom = SCROLL_WHEEL_ZOOM_CTRL;
564 // FIXME: should be caret_width
566 int cursor_width = 0;
567 /// One of: yes, no, ask
568 std::string close_buffer_with_last_view = "yes";
569 enum BookmarksVisibility {
576 BookmarksVisibility bookmarks_visibility = BMK_NONE;
579 // draw all (not implemented yet)
581 // draw only what has changed
583 // draw in backing store (only what has changed)
587 DrawStrategy draw_strategy = DS_PARTIAL;
591 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
596 extern LyXRC system_lyxrc;
598 // used by at least frontends/qt/GuiPref.cpp
599 const long maxlastfiles = 50;