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