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,
57 RC_CITATION_SEARCH_PATTERN,
58 RC_CITATION_SEARCH_VIEW,
59 RC_COMPLETION_CURSOR_TEXT,
60 RC_COMPLETION_INLINE_DELAY,
61 RC_COMPLETION_INLINE_MATH,
62 RC_COMPLETION_INLINE_TEXT,
63 RC_COMPLETION_INLINE_DOTS,
64 RC_COMPLETION_MINLENGTH,
65 RC_COMPLETION_POPUP_DELAY,
66 RC_COMPLETION_POPUP_MATH,
67 RC_COMPLETION_POPUP_TEXT,
68 RC_COMPLETION_POPUP_AFTER_COMPLETE,
70 RC_CONVERTER_CACHE_MAXAGE,
72 RC_CT_ADDITIONS_UNDERLINED,
74 RC_CURSOR_FOLLOWS_SCROLLBAR,
76 RC_DEFAULT_DECIMAL_SEP,
77 RC_DEFAULT_LENGTH_UNIT,
78 RC_DEFAULT_OTF_VIEW_FORMAT,
79 RC_DEFAULT_PLATEX_VIEW_FORMAT,
80 RC_DEFAULT_VIEW_FORMAT,
82 RC_DIALOGS_ICONIFY_WITH_MAIN,
85 RC_EDITOR_ALTERNATIVES,
90 RC_FORWARD_SEARCH_DVI,
91 RC_FORWARD_SEARCH_PDF,
93 RC_FULL_SCREEN_SCROLLBAR,
94 RC_FULL_SCREEN_STATUSBAR,
95 RC_FULL_SCREEN_TABBAR,
96 RC_FULL_SCREEN_MENUBAR,
97 RC_FULL_SCREEN_TOOLBARS,
104 RC_INDEX_ALTERNATIVES,
107 RC_JBIBTEX_ALTERNATIVES,
113 RC_LANGUAGE_AUTO_BEGIN,
114 RC_LANGUAGE_AUTO_END,
115 RC_LANGUAGE_COMMAND_BEGIN,
116 RC_LANGUAGE_COMMAND_END,
117 RC_LANGUAGE_COMMAND_LOCAL,
118 RC_LANGUAGE_GLOBAL_OPTIONS,
119 RC_LANGUAGE_CUSTOM_PACKAGE,
120 RC_LANGUAGE_PACKAGE_SELECTION,
124 RC_MAC_DONTSWAP_CTRL_META,
125 RC_MAC_LIKE_CURSOR_MOVEMENT,
127 RC_MARK_FOREIGN_LANGUAGE,
128 RC_MOUSE_WHEEL_SPEED,
129 RC_MOUSE_MIDDLEBUTTON_PASTE,
132 RC_OPEN_BUFFERS_IN_TABS,
133 RC_PARAGRAPH_MARKERS,
135 RC_PLAINTEXT_LINELEN,
137 RC_PREVIEW_HASHED_LABELS,
138 RC_PREVIEW_SCALE_FACTOR,
139 RC_PRINTLANDSCAPEFLAG,
140 RC_PRINTPAPERDIMENSIONFLAG,
142 RC_PYGMENTIZE_COMMAND,
143 RC_RESPECT_OS_KBD_LANGUAGE,
147 RC_SCREEN_FONT_ROMAN,
148 RC_SCREEN_FONT_ROMAN_FOUNDRY,
150 RC_SCREEN_FONT_SANS_FOUNDRY,
151 RC_SCREEN_FONT_SCALABLE,
152 RC_SCREEN_FONT_SIZES,
153 RC_SCREEN_FONT_TYPEWRITER,
154 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
156 RC_SCROLL_BELOW_DOCUMENT,
157 RC_SCROLL_WHEEL_ZOOM,
161 RC_SINGLE_CLOSE_TAB_BUTTON,
164 RC_SPELLCHECK_CONTINUOUSLY,
167 RC_SPLITINDEX_COMMAND,
170 RC_TEX_ALLOWS_SPACES,
171 RC_TEX_EXPECTS_WINDOWS_PATHS,
179 RC_USE_CONVERTER_CACHE,
180 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
181 RC_USE_CONVERTER_NEEDAUTH,
182 RC_USE_NATIVE_FILEDIALOG,
183 RC_USE_SYSTEM_COLORS,
185 RC_USE_SYSTEM_THEME_ICONS,
186 RC_VIEWDVI_PAPEROPTION,
188 RC_VIEWER_ALTERNATIVES,
190 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
195 LyXRC() : user_name(support::user_name()),
196 user_email(support::user_email()) // always empty
199 /// \param check_format: whether to try to convert the file format,
200 /// if it is not current. this should only be true, really, for the
201 /// user's own preferences file.
202 bool read(support::FileName const & filename, bool check_format);
204 bool read(std::istream &);
212 ReturnValues read(Lexer &, bool check_format);
215 typedef std::set<std::string> CommandSet;
216 /// maps a format to a set of commands that can be used to
218 typedef std::map<std::string, CommandSet> Alternatives;
220 void write(support::FileName const & filename,
221 bool ignore_system_lyxrc) const;
222 /// write rc. If a specific tag is given, only output that one.
223 void write(std::ostream & os,
224 bool ignore_system_lyxrc,
225 std::string const & tag = std::string()) const;
229 std::set<std::string> getRCs();
230 // FIXME unused (was used for xforms. Do we still need this?)
231 //static docstring const getDescription(LyXRCTags);
233 std::string bind_file = "cua";
235 std::string def_file = "default";
237 std::string ui_file = "default";
239 std::string print_landscape_flag = "-t landscape";
241 std::string print_paper_flag = "-t";
243 std::string print_paper_dimension_flag = "-T";
244 /// option for telling the dvi viewer about the paper size
245 std::string view_dvi_paper_option;
246 /// default paper size for local xdvi/dvips/ghostview/whatever
247 /// command to run chktex incl. options
248 std::string chktex_command = "chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38";
249 /// Use external script to search for file corresponding to a
251 bool citation_search = false;
252 /// Name of external script which searches for file corresponding to a
253 /// given citation. At this moment only script lyxpaperview.p is supported
254 /// (search for pdf or ps based on specific items)
255 std::string citation_search_view;
256 /// Items to search for in citation_search_view
257 std::string citation_search_pattern = "%year% %abbrvciteauthor%";
258 /// all available commands to run bibtex incl. options
259 CommandSet bibtex_alternatives;
260 /// command to run bibtex incl. options
261 std::string bibtex_command = "automatic";
262 /// command to run japanese bibtex incl. options
263 std::string jbibtex_command;
264 /// all available commands to run japanese bibtex incl. options
265 CommandSet jbibtex_alternatives;
266 /// all available index commands incl. options
267 CommandSet index_alternatives;
268 /// command to run makeindex incl. options or other index programs
269 std::string index_command = "makeindex -c -q";
270 /// command to run japanese index program incl. options
271 std::string jindex_command;
272 /// command to generate multiple indices
273 std::string splitindex_command;
274 /// command to run makeindex incl. options for nomencl
275 std::string nomencl_command = "makeindex -s nomencl.ist";
276 /// command to run the python pygments syntax highlighter
277 std::string pygmentize_command;
279 std::string document_path;
281 std::string example_path;
283 std::string template_path;
285 std::string tempdir_path;
287 std::string thesaurusdir_path;
289 std::string hunspelldir_path;
291 bool auto_region_delete = true;
292 /// enable middle-mouse-button paste
293 bool mouse_middlebutton_paste = true;
295 bool auto_reset_options = false;
296 /// flag telling whether lastfiles should be checked for existance
297 bool check_lastfiles = true;
298 /// maximal number of lastfiles
299 unsigned int num_lastfiles = 20;
300 /// whether or not go to saved position when opening a file
301 bool use_lastfilepos = true;
302 /// load files from last session automatically
303 bool load_session = false;
304 /// do we save new documents as compressed by default
305 bool save_compressed = false;
306 /// whether or not to save the document dir in the file
307 bool save_origin = false;
308 /// shall a backup file be created
309 bool make_backup = true;
310 /// A directory for storing backup files
311 std::string backupdir_path;
312 /// Whether or not save/restore session information
313 /// like windows position and geometry.
314 bool allow_geometry_session = true;
315 /// Scrolling speed of the mouse wheel
316 double mouse_wheel_speed = 1.0;
317 /// Default zoom factor for screen fonts
318 int defaultZoom = 150;
319 /// Actual zoom factor for screen fonts
320 /// (default zoom plus buffer zoom factor)
321 int currentZoom = 150;
322 /// Screen font sizes in points for each font size
323 std::string font_sizes[10] = { "5.0", "7.0", "8.0", "9.0", "10.0",
324 "12.0", "14.4", "17.26", "20.74", "24.88"};
325 /// Allow the use of scalable fonts? Default is yes.
326 bool use_scalable_fonts = true;
328 unsigned int dpi = 75;
330 std::string roman_font_name;
332 std::string sans_font_name;
334 std::string typewriter_font_name;
336 std::string roman_font_foundry;
338 std::string sans_font_foundry;
340 std::string typewriter_font_foundry;
342 unsigned int autosave = 300;
344 unsigned int plaintext_linelen = 65;
345 /// End of paragraph markers?
346 bool paragraph_markers = false;
348 bool use_tooltip = true;
349 /// Use the colors from current system theme?
350 bool use_system_colors = false;
351 /// use native file dialog or our own ?
352 bool use_native_filedialog = true;
353 /// Spellchecker engine: aspell, hunspell, etc
354 std::string spellchecker
355 #if defined(USE_MACOSX_PACKAGING)
357 #elif defined(USE_ENCHANT)
359 #elif defined(USE_ASPELL)
361 #elif defined(USE_HUNSPELL)
366 /// Alternate language for spellchecker
367 std::string spellchecker_alt_lang;
368 /// Escape characters
369 std::string spellchecker_esc_chars;
370 /// Accept compound words in spellchecker?
371 bool spellchecker_accept_compound = false;
372 /// spellcheck continuously?
373 bool spellcheck_continuously = false;
374 /// spellcheck notes and comments?
375 bool spellcheck_notes = true;
377 bool use_kbmap = false;
379 std::string primary_kbmap;
381 std::string secondary_kbmap;
383 std::string lyxpipes;
385 std::string language_custom_package = "\\usepackage{babel}";
387 bool language_auto_begin = true;
389 bool language_auto_end = true;
391 std::string language_command_begin = "\\selectlanguage{$$lang}";
393 std::string language_command_end;
395 std::string language_command_local = "\\foreignlanguage{$$lang}{";
397 bool language_global_options = true;
399 enum LangPackageSelection {
406 LangPackageSelection language_package_selection = LP_AUTO;
407 /// bidi cursor movement: true = visual, false = logical
408 bool visual_cursor = false;
410 bool auto_number = true;
412 bool mark_foreign_language = true;
414 std::string gui_language = "auto";
416 bool respect_os_kbd_language = false;
418 std::string default_otf_view_format = "pdf4";
420 std::string default_platex_view_format = "pdf3";
422 std::string default_view_format = "pdf2";
423 /// all available viewers
424 Alternatives viewer_alternatives;
425 /// all available editors
426 Alternatives editor_alternatives;
428 bool mac_dontswap_ctrl_meta = false;
430 bool mac_like_cursor_movement = false;
432 bool cursor_follows_scrollbar = false;
434 bool ct_additions_underlined = true;
436 bool ct_markup_copied = false;
438 bool scroll_below_document = false;
440 enum MacroEditStyle {
441 MACRO_EDIT_INLINE_BOX = 0,
446 MacroEditStyle macro_edit_style = MACRO_EDIT_INLINE_BOX;
448 bool dialogs_iconify_with_main = false;
450 bool display_graphics = true;
452 bool show_banner = true;
460 PreviewStatus preview = PREVIEW_OFF;
462 bool preview_hashed_labels = false;
464 double preview_scale_factor = 1.0;
466 std::string user_name; // set in constructor
468 std::string user_email; // set in constructor (empty for now)
470 std::string user_initials;
472 std::string icon_set;
473 /// whether to use the icons from the theme
474 bool use_system_theme_icons = false;
475 /// True if the TeX engine cannot handle posix paths
476 bool windows_style_tex_paths = false;
477 /// True if the TeX engine can handle file names containing spaces
478 bool tex_allows_spaces = false;
479 /** Prepend paths to the PATH environment variable.
480 * The string is input, stored and output in native format.
482 std::string path_prefix;
483 /** Prepend paths to the TEXINPUTS environment variable.
484 * The string is input, stored and output in native format.
485 * A '.' here stands for the current document directory.
487 std::string texinputs_prefix = ".";
488 /// Use the cache for file converters?
489 bool use_converter_cache = true;
490 /// Forbid use of external converters with 'needauth' option
491 bool use_converter_needauth_forbidden = true;
492 /// Ask user before calling external converters with 'needauth' option
493 bool use_converter_needauth = true;
494 /// The maximum age of cache files in seconds
495 unsigned int converter_cache_maxage = 6 * 30 * 24 * 3600; // 6 months;
496 /// Sort layouts alphabetically
497 bool sort_layouts = false;
498 /// Group layout by their category
499 bool group_layouts = true;
500 /// Toggle toolbars in fullscreen mode?
501 bool full_screen_toolbars = true;
502 /// Toggle scrollbar in fullscreen mode?
503 bool full_screen_scrollbar = true;
504 /// Toggle tabbar in fullscreen mode?
505 bool full_screen_tabbar = true;
506 /// Toggle menubar in fullscreen mode?
507 bool full_screen_menubar = true;
508 /// Toggle statusbar in fullscreen mode?
509 bool full_screen_statusbar = true;
510 /// Limit the text width?
511 bool full_screen_limit = false;
512 /// Width of limited screen (in pixels) in fullscreen mode
513 int full_screen_width = 700;
515 bool completion_cursor_text = true;
517 double completion_inline_delay = 0.2;
519 bool completion_inline_math = true;
521 bool completion_inline_text = false;
523 int completion_inline_dots = -1;
524 /// minimum length of words to complete
525 unsigned int completion_minlength = 6;
527 double completion_popup_delay = 2.0;
529 bool completion_popup_math = true;
531 bool completion_popup_text = false;
533 bool completion_popup_after_complete = true;
535 bool autocorrection_math = false;
537 bool open_buffers_in_tabs = true;
539 bool single_close_tab_button = false;
541 bool single_instance = true;
543 std::string forward_search_dvi;
545 std::string forward_search_pdf;
547 int export_overwrite = NO_FILES;
548 /// Default decimal point when aligning table columns on decimal
549 std::string default_decimal_sep = "locale";
551 Length::UNIT default_length_unit = Length::CM;
553 enum ScrollWheelZoom {
554 SCROLL_WHEEL_ZOOM_OFF,
555 SCROLL_WHEEL_ZOOM_CTRL,
556 SCROLL_WHEEL_ZOOM_SHIFT,
557 SCROLL_WHEEL_ZOOM_ALT
560 ScrollWheelZoom scroll_wheel_zoom = SCROLL_WHEEL_ZOOM_CTRL;
561 // FIXME: should be caret_width
563 int cursor_width = 0;
564 /// One of: yes, no, ask
565 std::string close_buffer_with_last_view = "yes";
569 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
574 extern LyXRC system_lyxrc;
576 // used by at least frontends/qt/GuiPref.cpp
577 const long maxlastfiles = 50;