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_POINT,
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,
141 RC_SCREEN_FONT_ROMAN,
142 RC_SCREEN_FONT_ROMAN_FOUNDRY,
144 RC_SCREEN_FONT_SANS_FOUNDRY,
145 RC_SCREEN_FONT_SCALABLE,
146 RC_SCREEN_FONT_SIZES,
147 RC_SCREEN_FONT_TYPEWRITER,
148 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
150 RC_SCROLL_BELOW_DOCUMENT,
151 RC_SCROLL_WHEEL_ZOOM,
155 RC_SINGLE_CLOSE_TAB_BUTTON,
158 RC_SPELLCHECK_CONTINUOUSLY,
161 RC_SPLITINDEX_COMMAND,
164 RC_TEX_ALLOWS_SPACES,
165 RC_TEX_EXPECTS_WINDOWS_PATHS,
172 RC_USE_CONVERTER_CACHE,
173 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
174 RC_USE_CONVERTER_NEEDAUTH,
175 RC_USE_NATIVE_FILEDIALOG,
176 RC_USE_SYSTEM_COLORS,
178 RC_USE_SYSTEM_THEME_ICONS,
179 RC_VIEWDVI_PAPEROPTION,
181 RC_VIEWER_ALTERNATIVES,
183 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
188 LyXRC() : user_name(support::user_name()),
189 user_email(support::user_email()) // always empty
192 /// \param check_format: whether to try to convert the file format,
193 /// if it is not current. this should only be true, really, for the
194 /// user's own preferences file.
195 bool read(support::FileName const & filename, bool check_format);
197 bool read(std::istream &);
205 ReturnValues read(Lexer &, bool check_format);
208 typedef std::set<std::string> CommandSet;
209 /// maps a format to a set of commands that can be used to
211 typedef std::map<std::string, CommandSet> Alternatives;
213 void write(support::FileName const & filename,
214 bool ignore_system_lyxrc) const;
215 /// write rc. If a specific tag is given, only output that one.
216 void write(std::ostream & os,
217 bool ignore_system_lyxrc,
218 std::string const & tag = std::string()) const;
222 std::set<std::string> getRCs();
223 // FIXME unused (was used for xforms. Do we still need this?)
224 //static docstring const getDescription(LyXRCTags);
226 std::string bind_file = "cua";
228 std::string def_file = "default";
230 std::string ui_file = "default";
232 std::string print_landscape_flag = "-t landscape";
234 std::string print_paper_flag = "-t";
236 std::string print_paper_dimension_flag = "-T";
237 /// option for telling the dvi viewer about the paper size
238 std::string view_dvi_paper_option;
239 /// default paper size for local xdvi/dvips/ghostview/whatever
240 /// command to run chktex incl. options
241 std::string chktex_command = "chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38";
242 /// all available commands to run bibtex incl. options
243 CommandSet bibtex_alternatives;
244 /// command to run bibtex incl. options
245 std::string bibtex_command = "automatic";
246 /// command to run japanese bibtex incl. options
247 std::string jbibtex_command;
248 /// all available commands to run japanese bibtex incl. options
249 CommandSet jbibtex_alternatives;
250 /// all available index commands incl. options
251 CommandSet index_alternatives;
252 /// command to run makeindex incl. options or other index programs
253 std::string index_command = "makeindex -c -q";
254 /// command to run japanese index program incl. options
255 std::string jindex_command;
256 /// command to generate multiple indices
257 std::string splitindex_command;
258 /// command to run makeindex incl. options for nomencl
259 std::string nomencl_command = "makeindex -s nomencl.ist";
260 /// command to run the python pygments syntax highlighter
261 std::string pygmentize_command;
263 std::string document_path;
265 std::string example_path;
267 std::string template_path;
269 std::string tempdir_path;
271 std::string thesaurusdir_path;
273 std::string hunspelldir_path;
275 bool auto_region_delete = true;
276 /// enable middle-mouse-button paste
277 bool mouse_middlebutton_paste = true;
279 bool auto_reset_options = false;
280 /// flag telling whether lastfiles should be checked for existance
281 bool check_lastfiles = true;
282 /// maximal number of lastfiles
283 unsigned int num_lastfiles = 20;
284 /// whether or not go to saved position when opening a file
285 bool use_lastfilepos = true;
286 /// load files from last session automatically
287 bool load_session = false;
288 /// do we save new documents as compressed by default
289 bool save_compressed = false;
290 /// whether or not to save the document dir in the file
291 bool save_origin = false;
292 /// shall a backup file be created
293 bool make_backup = true;
294 /// A directory for storing backup files
295 std::string backupdir_path;
296 /// Whether or not save/restore session information
297 /// like windows position and geometry.
298 bool allow_geometry_session = true;
299 /// Scrolling speed of the mouse wheel
300 double mouse_wheel_speed = 1.0;
301 /// Default zoom factor for screen fonts
302 int defaultZoom = 150;
303 /// Actual zoom factor for screen fonts
304 /// (default zoom plus buffer zoom factor)
305 int currentZoom = 150;
306 /// Screen font sizes in points for each font size
307 std::string font_sizes[10] = { "5.0", "7.0", "8.0", "9.0", "10.0",
308 "12.0", "14.4", "17.26", "20.74", "24.88"};
309 /// Allow the use of scalable fonts? Default is yes.
310 bool use_scalable_fonts = true;
312 unsigned int dpi = 75;
314 std::string roman_font_name;
316 std::string sans_font_name;
318 std::string typewriter_font_name;
320 std::string roman_font_foundry;
322 std::string sans_font_foundry;
324 std::string typewriter_font_foundry;
326 unsigned int autosave = 300;
328 unsigned int plaintext_linelen = 65;
329 /// End of paragraph markers?
330 bool paragraph_markers = false;
332 bool use_tooltip = true;
333 /// Use the colors from current system theme?
334 bool use_system_colors = false;
335 /// use native file dialog or our own ?
336 bool use_native_filedialog = true;
337 /// Spellchecker engine: aspell, hunspell, etc
338 std::string spellchecker
339 #if defined(USE_MACOSX_PACKAGING)
341 #elif defined(USE_ENCHANT)
343 #elif defined(USE_ASPELL)
345 #elif defined(USE_HUNSPELL)
350 /// Alternate language for spellchecker
351 std::string spellchecker_alt_lang;
352 /// Escape characters
353 std::string spellchecker_esc_chars;
354 /// Accept compound words in spellchecker?
355 bool spellchecker_accept_compound = false;
356 /// spellcheck continuously?
357 bool spellcheck_continuously = false;
358 /// spellcheck notes and comments?
359 bool spellcheck_notes = true;
360 /// minimum length of words to complete
361 unsigned int completion_minlength = 6;
363 bool use_kbmap = false;
365 std::string primary_kbmap;
367 std::string secondary_kbmap;
369 std::string lyxpipes;
371 std::string language_custom_package = "\\usepackage{babel}";
373 bool language_auto_begin = true;
375 bool language_auto_end = true;
377 std::string language_command_begin = "\\selectlanguage{$$lang}";
379 std::string language_command_end;
381 std::string language_command_local = "\\foreignlanguage{$$lang}{";
383 bool language_global_options = true;
385 enum LangPackageSelection {
392 LangPackageSelection language_package_selection = LP_AUTO;
393 /// bidi cursor movement: true = visual, false = logical
394 bool visual_cursor = false;
396 bool auto_number = true;
398 bool mark_foreign_language = true;
400 std::string gui_language = "auto";
402 std::string default_otf_view_format = "pdf4";
404 std::string default_platex_view_format = "pdf3";
406 std::string default_view_format = "pdf2";
407 /// all available viewers
408 Alternatives viewer_alternatives;
409 /// all available editors
410 Alternatives editor_alternatives;
412 bool mac_dontswap_ctrl_meta = false;
414 bool mac_like_cursor_movement = false;
416 bool cursor_follows_scrollbar = false;
418 bool scroll_below_document = false;
420 enum MacroEditStyle {
421 MACRO_EDIT_INLINE_BOX = 0,
426 MacroEditStyle macro_edit_style = MACRO_EDIT_INLINE_BOX;
428 bool dialogs_iconify_with_main = false;
430 bool display_graphics = true;
432 bool show_banner = true;
440 PreviewStatus preview = PREVIEW_OFF;
442 bool preview_hashed_labels = false;
444 double preview_scale_factor = 1.0;
446 std::string user_name; // set in constructor
448 std::string user_email; // set in constructor (empty for now)
450 std::string icon_set;
451 /// whether to use the icons from the theme
452 bool use_system_theme_icons = false;
453 /// True if the TeX engine cannot handle posix paths
454 bool windows_style_tex_paths = false;
455 /// True if the TeX engine can handle file names containing spaces
456 bool tex_allows_spaces = false;
457 /** Prepend paths to the PATH environment variable.
458 * The string is input, stored and output in native format.
460 std::string path_prefix;
461 /** Prepend paths to the TEXINPUTS environment variable.
462 * The string is input, stored and output in native format.
463 * A '.' here stands for the current document directory.
465 std::string texinputs_prefix = ".";
466 /// Use the cache for file converters?
467 bool use_converter_cache = true;
468 /// Forbid use of external converters with 'needauth' option
469 bool use_converter_needauth_forbidden = true;
470 /// Ask user before calling external converters with 'needauth' option
471 bool use_converter_needauth = true;
472 /// The maximum age of cache files in seconds
473 unsigned int converter_cache_maxage = 6 * 30 * 24 * 3600; // 6 months;
474 /// Sort layouts alphabetically
475 bool sort_layouts = false;
476 /// Group layout by their category
477 bool group_layouts = true;
478 /// Toggle toolbars in fullscreen mode?
479 bool full_screen_toolbars = true;
480 /// Toggle scrollbar in fullscreen mode?
481 bool full_screen_scrollbar = true;
482 /// Toggle tabbar in fullscreen mode?
483 bool full_screen_tabbar = true;
484 /// Toggle menubar in fullscreen mode?
485 bool full_screen_menubar = true;
486 /// Toggle statusbar in fullscreen mode?
487 bool full_screen_statusbar = true;
488 /// Limit the text width?
489 bool full_screen_limit = false;
490 /// Width of limited screen (in pixels) in fullscreen mode
491 int full_screen_width = 700;
493 bool completion_cursor_text = true;
495 double completion_inline_delay = 0.2;
497 bool completion_inline_math = true;
499 bool completion_inline_text = false;
501 int completion_inline_dots = -1;
503 double completion_popup_delay = 2.0;
505 bool completion_popup_math = true;
507 bool completion_popup_text = false;
509 bool completion_popup_after_complete = true;
511 bool autocorrection_math = false;
513 bool open_buffers_in_tabs = true;
515 bool single_close_tab_button = false;
517 bool single_instance = true;
519 std::string forward_search_dvi;
521 std::string forward_search_pdf;
523 int export_overwrite = NO_FILES;
524 /// Default decimal point when aligning table columns on decimal
525 std::string default_decimal_point = ".";
527 Length::UNIT default_length_unit = Length::CM;
529 enum ScrollWheelZoom {
530 SCROLL_WHEEL_ZOOM_OFF,
531 SCROLL_WHEEL_ZOOM_CTRL,
532 SCROLL_WHEEL_ZOOM_SHIFT,
533 SCROLL_WHEEL_ZOOM_ALT
536 ScrollWheelZoom scroll_wheel_zoom = SCROLL_WHEEL_ZOOM_CTRL;
538 int cursor_width = 1;
539 /// One of: yes, no, ask
540 std::string close_buffer_with_last_view = "yes";
544 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
549 extern LyXRC system_lyxrc;
551 // used by at least frontends/qt4/GuiPref.cpp
552 const long maxlastfiles = 50;