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/strfwd.h"
32 namespace support { class FileName; }
36 /// This contains the runtime configuration of LyX
41 RC_ACCEPT_COMPOUND = 1,
43 RC_AUTOCORRECTION_MATH,
49 RC_BIBTEX_ALTERNATIVES,
54 RC_COMPLETION_CURSOR_TEXT,
55 RC_COMPLETION_INLINE_DELAY,
56 RC_COMPLETION_INLINE_MATH,
57 RC_COMPLETION_INLINE_TEXT,
58 RC_COMPLETION_INLINE_DOTS,
59 RC_COMPLETION_MINLENGTH,
60 RC_COMPLETION_POPUP_DELAY,
61 RC_COMPLETION_POPUP_MATH,
62 RC_COMPLETION_POPUP_TEXT,
63 RC_COMPLETION_POPUP_AFTER_COMPLETE,
65 RC_CONVERTER_CACHE_MAXAGE,
67 RC_CURSOR_FOLLOWS_SCROLLBAR,
69 RC_DATE_INSERT_FORMAT,
70 RC_DEFAULT_DECIMAL_POINT,
71 RC_DEFAULT_LENGTH_UNIT,
72 RC_DEFAULT_OTF_VIEW_FORMAT,
73 RC_DEFAULT_PLATEX_VIEW_FORMAT,
74 RC_DEFAULT_VIEW_FORMAT,
76 RC_DIALOGS_ICONIFY_WITH_MAIN,
79 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_SYSTEM_COLORS,
178 RC_USE_SYSTEM_THEME_ICONS,
179 RC_VIEWDVI_PAPEROPTION,
181 RC_VIEWER_ALTERNATIVES,
183 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
191 /// \param check_format: whether to try to convert the file format,
192 /// if it is not current. this should only be true, really, for the
193 /// user's own preferences file.
194 bool read(support::FileName const & filename, bool check_format);
196 bool read(std::istream &);
204 ReturnValues read(Lexer &, bool check_format);
207 typedef std::set<std::string> CommandSet;
208 /// maps a format to a set of commands that can be used to
210 typedef std::map<std::string, CommandSet> Alternatives;
212 void write(support::FileName const & filename,
213 bool ignore_system_lyxrc) const;
214 /// write rc. If a specific tag is given, only output that one.
215 void write(std::ostream & os,
216 bool ignore_system_lyxrc,
217 std::string const & tag = std::string()) const;
220 // FIXME unused (was used for xforms. Do we still need this?)
221 //static docstring const getDescription(LyXRCTags);
223 std::string bind_file;
225 std::string def_file;
229 std::string print_landscape_flag;
231 std::string print_paper_flag;
233 std::string print_paper_dimension_flag;
234 /// option for telling the dvi viewer about the paper size
235 std::string view_dvi_paper_option;
236 /// default paper size for local xdvi/dvips/ghostview/whatever
237 /// command to run chktex incl. options
238 std::string chktex_command;
239 /// all available commands to run bibtex incl. options
240 CommandSet bibtex_alternatives;
241 /// command to run bibtex incl. options
242 std::string bibtex_command;
243 /// command to run japanese bibtex incl. options
244 std::string jbibtex_command;
245 /// all available commands to run japanese bibtex incl. options
246 CommandSet jbibtex_alternatives;
247 /// all available index commands incl. options
248 CommandSet index_alternatives;
249 /// command to run makeindex incl. options or other index programs
250 std::string index_command;
251 /// command to run japanese index program incl. options
252 std::string jindex_command;
253 /// command to generate multiple indices
254 std::string splitindex_command;
255 /// command to run makeindex incl. options for nomencl
256 std::string nomencl_command;
257 /// command to run the python pygments syntax highlighter
258 std::string pygmentize_command;
260 std::string document_path;
262 std::string example_path;
264 std::string template_path;
266 std::string tempdir_path;
268 std::string thesaurusdir_path;
270 std::string hunspelldir_path;
272 bool auto_region_delete;
273 /// enable middle-mouse-button paste
274 bool mouse_middlebutton_paste;
275 /// flag telling whether lastfiles should be checked for existance
276 bool auto_reset_options;
278 bool check_lastfiles;
279 /// maximal number of lastfiles
280 unsigned int num_lastfiles;
281 /// whether or not go to saved position when opening a file
282 bool use_lastfilepos;
283 /// load files from last session automatically
285 /// do we save new documents as compressed by default
286 bool save_compressed;
287 /// whether or not to save the document dir in the file
289 /// shall a backup file be created
291 /// A directory for storing backup files
292 std::string backupdir_path;
293 /// Whether or not save/restore session information
294 /// like windows position and geometry.
295 bool allow_geometry_session;
296 /// Scrolling speed of the mouse wheel
297 double mouse_wheel_speed;
298 /// Default zoom factor for screen fonts
300 /// Actual zoom factor for screen fonts
301 /// (default zoom plus buffer zoom factor)
303 /// Screen font sizes in points for each font size
304 std::string font_sizes[10];
305 /// Allow the use of scalable fonts? Default is yes.
306 bool use_scalable_fonts;
312 std::string roman_font_name;
314 std::string sans_font_name;
316 std::string typewriter_font_name;
318 std::string roman_font_foundry;
320 std::string sans_font_foundry;
322 std::string typewriter_font_foundry;
324 unsigned int autosave;
326 unsigned int plaintext_linelen;
327 /// Accept compound words in spellchecker?
328 bool spellchecker_accept_compound;
329 /// End of paragraph markers?
330 bool paragraph_markers;
333 /// Use the colors from current system theme?
334 bool use_system_colors;
335 /// Use pixmap cache?
336 bool use_pixmap_cache;
337 /// Spellchecker engine: aspell, hunspell, etc
338 std::string spellchecker;
339 /// Alternate language for spellchecker
340 std::string spellchecker_alt_lang;
341 /// Escape characters
342 std::string spellchecker_esc_chars;
343 /// spellcheck continuously?
344 bool spellcheck_continuously;
345 /// spellcheck notes and comments?
346 bool spellcheck_notes;
347 /// minimum length of words to complete
348 unsigned int completion_minlength;
352 std::string primary_kbmap;
354 std::string secondary_kbmap;
356 std::string lyxpipes;
358 std::string date_insert_format;
360 std::string language_custom_package;
362 bool language_auto_begin;
364 bool language_auto_end;
366 std::string language_command_begin;
368 std::string language_command_end;
370 std::string language_command_local;
372 bool language_global_options;
374 enum LangPackageSelection {
381 LangPackageSelection language_package_selection;
382 /// bidi cursor movement: true = visual, false = logical
387 bool mark_foreign_language;
389 std::string gui_language;
391 std::string default_otf_view_format;
393 std::string default_platex_view_format;
395 std::string default_view_format;
396 /// all available viewers
397 Alternatives viewer_alternatives;
398 /// all available editors
399 Alternatives editor_alternatives;
401 bool mac_dontswap_ctrl_meta;
403 bool mac_like_cursor_movement;
405 bool cursor_follows_scrollbar;
407 bool scroll_below_document;
409 enum MacroEditStyle {
410 MACRO_EDIT_INLINE_BOX = 0,
415 MacroEditStyle macro_edit_style;
417 bool dialogs_iconify_with_main;
419 bool display_graphics;
429 PreviewStatus preview;
431 bool preview_hashed_labels;
433 double preview_scale_factor;
435 std::string user_name;
437 std::string user_email;
439 std::string icon_set;
440 /// whether to use the icons from the theme
441 bool use_system_theme_icons;
442 /// True if the TeX engine cannot handle posix paths
443 bool windows_style_tex_paths;
444 /// True if the TeX engine can handle file names containing spaces
445 bool tex_allows_spaces;
446 /** Prepend paths to the PATH environment variable.
447 * The string is input, stored and output in native format.
449 std::string path_prefix;
450 /** Prepend paths to the TEXINPUTS environment variable.
451 * The string is input, stored and output in native format.
452 * A '.' here stands for the current document directory.
454 std::string texinputs_prefix;
455 /// Use the cache for file converters?
456 bool use_converter_cache;
457 /// Forbid use of external converters with 'needauth' option
458 bool use_converter_needauth_forbidden;
459 /// Ask user before calling external converters with 'needauth' option
460 bool use_converter_needauth;
461 /// The maximum age of cache files in seconds
462 unsigned int converter_cache_maxage;
463 /// Sort layouts alphabetically
465 /// Group layout by their category
467 /// Toggle toolbars in fullscreen mode?
468 bool full_screen_toolbars;
469 /// Toggle scrollbar in fullscreen mode?
470 bool full_screen_scrollbar;
471 /// Toggle tabbar in fullscreen mode?
472 bool full_screen_tabbar;
473 /// Toggle menubar in fullscreen mode?
474 bool full_screen_menubar;
475 /// Toggle statusbar in fullscreen mode?
476 bool full_screen_statusbar;
477 /// Limit the text width?
478 bool full_screen_limit;
479 /// Width of limited screen (in pixels) in fullscreen mode
480 int full_screen_width;
482 bool completion_cursor_text;
484 double completion_inline_delay;
486 bool completion_inline_math;
488 bool completion_inline_text;
490 int completion_inline_dots;
492 bool autocorrection_math;
494 double completion_popup_delay;
496 bool completion_popup_math;
498 bool completion_popup_text;
500 bool completion_popup_after_complete;
502 bool open_buffers_in_tabs;
504 bool single_close_tab_button;
506 bool single_instance;
508 std::string forward_search_dvi;
510 std::string forward_search_pdf;
512 int export_overwrite;
513 /// Default decimal point when aligning table columns on decimal
514 std::string default_decimal_point;
516 Length::UNIT default_length_unit;
518 enum ScrollWheelZoom {
519 SCROLL_WHEEL_ZOOM_OFF,
520 SCROLL_WHEEL_ZOOM_CTRL,
521 SCROLL_WHEEL_ZOOM_SHIFT,
522 SCROLL_WHEEL_ZOOM_ALT
525 ScrollWheelZoom scroll_wheel_zoom;
528 /// One of: yes, no, ask
529 std::string close_buffer_with_last_view;
533 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
538 extern LyXRC system_lyxrc;
540 // used by at least frontends/qt4/GuiPref.cpp
541 const long maxlastfiles = 50;