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"
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,
56 RC_COMPLETION_CURSOR_TEXT,
57 RC_COMPLETION_INLINE_DELAY,
58 RC_COMPLETION_INLINE_MATH,
59 RC_COMPLETION_INLINE_TEXT,
60 RC_COMPLETION_INLINE_DOTS,
61 RC_COMPLETION_MINLENGTH,
62 RC_COMPLETION_POPUP_DELAY,
63 RC_COMPLETION_POPUP_MATH,
64 RC_COMPLETION_POPUP_TEXT,
65 RC_COMPLETION_POPUP_AFTER_COMPLETE,
67 RC_CONVERTER_CACHE_MAXAGE,
69 RC_CURSOR_FOLLOWS_SCROLLBAR,
71 RC_DEFAULT_DECIMAL_SEP,
72 RC_DEFAULT_LENGTH_UNIT,
73 RC_DEFAULT_OTF_VIEW_FORMAT,
74 RC_DEFAULT_PLATEX_VIEW_FORMAT,
75 RC_DEFAULT_VIEW_FORMAT,
77 RC_DIALOGS_ICONIFY_WITH_MAIN,
80 RC_EDITOR_ALTERNATIVES,
85 RC_FORWARD_SEARCH_DVI,
86 RC_FORWARD_SEARCH_PDF,
88 RC_FULL_SCREEN_SCROLLBAR,
89 RC_FULL_SCREEN_STATUSBAR,
90 RC_FULL_SCREEN_TABBAR,
91 RC_FULL_SCREEN_MENUBAR,
92 RC_FULL_SCREEN_TOOLBARS,
99 RC_INDEX_ALTERNATIVES,
102 RC_JBIBTEX_ALTERNATIVES,
108 RC_LANGUAGE_AUTO_BEGIN,
109 RC_LANGUAGE_AUTO_END,
110 RC_LANGUAGE_COMMAND_BEGIN,
111 RC_LANGUAGE_COMMAND_END,
112 RC_LANGUAGE_COMMAND_LOCAL,
113 RC_LANGUAGE_GLOBAL_OPTIONS,
114 RC_LANGUAGE_CUSTOM_PACKAGE,
115 RC_LANGUAGE_PACKAGE_SELECTION,
119 RC_MAC_DONTSWAP_CTRL_META,
120 RC_MAC_LIKE_CURSOR_MOVEMENT,
122 RC_MARK_FOREIGN_LANGUAGE,
123 RC_MOUSE_WHEEL_SPEED,
124 RC_MOUSE_MIDDLEBUTTON_PASTE,
127 RC_OPEN_BUFFERS_IN_TABS,
128 RC_PARAGRAPH_MARKERS,
130 RC_PLAINTEXT_LINELEN,
132 RC_PREVIEW_HASHED_LABELS,
133 RC_PREVIEW_SCALE_FACTOR,
134 RC_PRINTLANDSCAPEFLAG,
135 RC_PRINTPAPERDIMENSIONFLAG,
137 RC_PYGMENTIZE_COMMAND,
138 RC_RESPECT_OS_KBD_LANGUAGE,
142 RC_SCREEN_FONT_ROMAN,
143 RC_SCREEN_FONT_ROMAN_FOUNDRY,
145 RC_SCREEN_FONT_SANS_FOUNDRY,
146 RC_SCREEN_FONT_SCALABLE,
147 RC_SCREEN_FONT_SIZES,
148 RC_SCREEN_FONT_TYPEWRITER,
149 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
151 RC_SCROLL_BELOW_DOCUMENT,
152 RC_SCROLL_WHEEL_ZOOM,
156 RC_SINGLE_CLOSE_TAB_BUTTON,
159 RC_SPELLCHECK_CONTINUOUSLY,
162 RC_SPLITINDEX_COMMAND,
165 RC_TEX_ALLOWS_SPACES,
166 RC_TEX_EXPECTS_WINDOWS_PATHS,
173 RC_USE_CONVERTER_CACHE,
174 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
175 RC_USE_CONVERTER_NEEDAUTH,
176 RC_USE_NATIVE_FILEDIALOG,
177 RC_USE_SYSTEM_COLORS,
179 RC_USE_SYSTEM_THEME_ICONS,
180 RC_VIEWDVI_PAPEROPTION,
182 RC_VIEWER_ALTERNATIVES,
184 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
189 LyXRC() : user_name(support::user_name()),
190 user_email(support::user_email()) // always empty
193 /// \param check_format: whether to try to convert the file format,
194 /// if it is not current. this should only be true, really, for the
195 /// user's own preferences file.
196 bool read(support::FileName const & filename, bool check_format);
198 bool read(std::istream &);
206 ReturnValues read(Lexer &, bool check_format);
209 typedef std::set<std::string> CommandSet;
210 /// maps a format to a set of commands that can be used to
212 typedef std::map<std::string, CommandSet> Alternatives;
214 void write(support::FileName const & filename,
215 bool ignore_system_lyxrc) const;
216 /// write rc. If a specific tag is given, only output that one.
217 void write(std::ostream & os,
218 bool ignore_system_lyxrc,
219 std::string const & tag = std::string()) const;
223 std::set<std::string> getRCs();
224 // FIXME unused (was used for xforms. Do we still need this?)
225 //static docstring const getDescription(LyXRCTags);
227 std::string bind_file = "cua";
229 std::string def_file = "default";
231 std::string ui_file = "default";
233 std::string print_landscape_flag = "-t landscape";
235 std::string print_paper_flag = "-t";
237 std::string print_paper_dimension_flag = "-T";
238 /// option for telling the dvi viewer about the paper size
239 std::string view_dvi_paper_option;
240 /// default paper size for local xdvi/dvips/ghostview/whatever
241 /// command to run chktex incl. options
242 std::string chktex_command = "chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38";
243 /// all available commands to run bibtex incl. options
244 CommandSet bibtex_alternatives;
245 /// command to run bibtex incl. options
246 std::string bibtex_command = "automatic";
247 /// command to run japanese bibtex incl. options
248 std::string jbibtex_command;
249 /// all available commands to run japanese bibtex incl. options
250 CommandSet jbibtex_alternatives;
251 /// all available index commands incl. options
252 CommandSet index_alternatives;
253 /// command to run makeindex incl. options or other index programs
254 std::string index_command = "makeindex -c -q";
255 /// command to run japanese index program incl. options
256 std::string jindex_command;
257 /// command to generate multiple indices
258 std::string splitindex_command;
259 /// command to run makeindex incl. options for nomencl
260 std::string nomencl_command = "makeindex -s nomencl.ist";
261 /// command to run the python pygments syntax highlighter
262 std::string pygmentize_command;
264 std::string document_path;
266 std::string example_path;
268 std::string template_path;
270 std::string tempdir_path;
272 std::string thesaurusdir_path;
274 std::string hunspelldir_path;
276 bool auto_region_delete = true;
277 /// enable middle-mouse-button paste
278 bool mouse_middlebutton_paste = true;
280 bool auto_reset_options = false;
281 /// flag telling whether lastfiles should be checked for existance
282 bool check_lastfiles = true;
283 /// maximal number of lastfiles
284 unsigned int num_lastfiles = 20;
285 /// whether or not go to saved position when opening a file
286 bool use_lastfilepos = true;
287 /// load files from last session automatically
288 bool load_session = false;
289 /// do we save new documents as compressed by default
290 bool save_compressed = false;
291 /// whether or not to save the document dir in the file
292 bool save_origin = false;
293 /// shall a backup file be created
294 bool make_backup = true;
295 /// A directory for storing backup files
296 std::string backupdir_path;
297 /// Whether or not save/restore session information
298 /// like windows position and geometry.
299 bool allow_geometry_session = true;
300 /// Scrolling speed of the mouse wheel
301 double mouse_wheel_speed = 1.0;
302 /// Default zoom factor for screen fonts
303 int defaultZoom = 150;
304 /// Actual zoom factor for screen fonts
305 /// (default zoom plus buffer zoom factor)
306 int currentZoom = 150;
307 /// Screen font sizes in points for each font size
308 std::string font_sizes[10] = { "5.0", "7.0", "8.0", "9.0", "10.0",
309 "12.0", "14.4", "17.26", "20.74", "24.88"};
310 /// Allow the use of scalable fonts? Default is yes.
311 bool use_scalable_fonts = true;
313 unsigned int dpi = 75;
315 std::string roman_font_name;
317 std::string sans_font_name;
319 std::string typewriter_font_name;
321 std::string roman_font_foundry;
323 std::string sans_font_foundry;
325 std::string typewriter_font_foundry;
327 unsigned int autosave = 300;
329 unsigned int plaintext_linelen = 65;
330 /// End of paragraph markers?
331 bool paragraph_markers = false;
333 bool use_tooltip = true;
334 /// Use the colors from current system theme?
335 bool use_system_colors = false;
336 /// use native file dialog or our own ?
337 bool use_native_filedialog = true;
338 /// Spellchecker engine: aspell, hunspell, etc
339 std::string spellchecker
340 #if defined(USE_MACOSX_PACKAGING)
342 #elif defined(USE_ENCHANT)
344 #elif defined(USE_ASPELL)
346 #elif defined(USE_HUNSPELL)
351 /// Alternate language for spellchecker
352 std::string spellchecker_alt_lang;
353 /// Escape characters
354 std::string spellchecker_esc_chars;
355 /// Accept compound words in spellchecker?
356 bool spellchecker_accept_compound = false;
357 /// spellcheck continuously?
358 bool spellcheck_continuously = false;
359 /// spellcheck notes and comments?
360 bool spellcheck_notes = true;
361 /// minimum length of words to complete
362 unsigned int completion_minlength = 6;
364 bool use_kbmap = false;
366 std::string primary_kbmap;
368 std::string secondary_kbmap;
370 std::string lyxpipes;
372 std::string language_custom_package = "\\usepackage{babel}";
374 bool language_auto_begin = true;
376 bool language_auto_end = true;
378 std::string language_command_begin = "\\selectlanguage{$$lang}";
380 std::string language_command_end;
382 std::string language_command_local = "\\foreignlanguage{$$lang}{";
384 bool language_global_options = true;
386 enum LangPackageSelection {
393 LangPackageSelection language_package_selection = LP_AUTO;
394 /// bidi cursor movement: true = visual, false = logical
395 bool visual_cursor = false;
397 bool auto_number = true;
399 bool mark_foreign_language = true;
401 std::string gui_language = "auto";
403 bool respect_os_kbd_language = false;
405 std::string default_otf_view_format = "pdf4";
407 std::string default_platex_view_format = "pdf3";
409 std::string default_view_format = "pdf2";
410 /// all available viewers
411 Alternatives viewer_alternatives;
412 /// all available editors
413 Alternatives editor_alternatives;
415 bool mac_dontswap_ctrl_meta = false;
417 bool mac_like_cursor_movement = false;
419 bool cursor_follows_scrollbar = false;
421 bool scroll_below_document = false;
423 enum MacroEditStyle {
424 MACRO_EDIT_INLINE_BOX = 0,
429 MacroEditStyle macro_edit_style = MACRO_EDIT_INLINE_BOX;
431 bool dialogs_iconify_with_main = false;
433 bool display_graphics = true;
435 bool show_banner = true;
443 PreviewStatus preview = PREVIEW_OFF;
445 bool preview_hashed_labels = false;
447 double preview_scale_factor = 1.0;
449 std::string user_name; // set in constructor
451 std::string user_email; // set in constructor (empty for now)
453 std::string icon_set;
454 /// whether to use the icons from the theme
455 bool use_system_theme_icons = false;
456 /// True if the TeX engine cannot handle posix paths
457 bool windows_style_tex_paths = false;
458 /// True if the TeX engine can handle file names containing spaces
459 bool tex_allows_spaces = false;
460 /** Prepend paths to the PATH environment variable.
461 * The string is input, stored and output in native format.
463 std::string path_prefix;
464 /** Prepend paths to the TEXINPUTS environment variable.
465 * The string is input, stored and output in native format.
466 * A '.' here stands for the current document directory.
468 std::string texinputs_prefix = ".";
469 /// Use the cache for file converters?
470 bool use_converter_cache = true;
471 /// Forbid use of external converters with 'needauth' option
472 bool use_converter_needauth_forbidden = true;
473 /// Ask user before calling external converters with 'needauth' option
474 bool use_converter_needauth = true;
475 /// The maximum age of cache files in seconds
476 unsigned int converter_cache_maxage = 6 * 30 * 24 * 3600; // 6 months;
477 /// Sort layouts alphabetically
478 bool sort_layouts = false;
479 /// Group layout by their category
480 bool group_layouts = true;
481 /// Toggle toolbars in fullscreen mode?
482 bool full_screen_toolbars = true;
483 /// Toggle scrollbar in fullscreen mode?
484 bool full_screen_scrollbar = true;
485 /// Toggle tabbar in fullscreen mode?
486 bool full_screen_tabbar = true;
487 /// Toggle menubar in fullscreen mode?
488 bool full_screen_menubar = true;
489 /// Toggle statusbar in fullscreen mode?
490 bool full_screen_statusbar = true;
491 /// Limit the text width?
492 bool full_screen_limit = false;
493 /// Width of limited screen (in pixels) in fullscreen mode
494 int full_screen_width = 700;
496 bool completion_cursor_text = true;
498 double completion_inline_delay = 0.2;
500 bool completion_inline_math = true;
502 bool completion_inline_text = false;
504 int completion_inline_dots = -1;
506 double completion_popup_delay = 2.0;
508 bool completion_popup_math = true;
510 bool completion_popup_text = false;
512 bool completion_popup_after_complete = true;
514 bool autocorrection_math = false;
516 bool open_buffers_in_tabs = true;
518 bool single_close_tab_button = false;
520 bool single_instance = true;
522 std::string forward_search_dvi;
524 std::string forward_search_pdf;
526 int export_overwrite = NO_FILES;
527 /// Default decimal point when aligning table columns on decimal
528 std::string default_decimal_sep = "locale";
530 Length::UNIT default_length_unit = Length::CM;
532 enum ScrollWheelZoom {
533 SCROLL_WHEEL_ZOOM_OFF,
534 SCROLL_WHEEL_ZOOM_CTRL,
535 SCROLL_WHEEL_ZOOM_SHIFT,
536 SCROLL_WHEEL_ZOOM_ALT
539 ScrollWheelZoom scroll_wheel_zoom = SCROLL_WHEEL_ZOOM_CTRL;
541 int cursor_width = 1;
542 /// One of: yes, no, ask
543 std::string close_buffer_with_last_view = "yes";
547 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
552 extern LyXRC system_lyxrc;
554 // used by at least frontends/qt/GuiPref.cpp
555 const long maxlastfiles = 50;