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,
84 RC_FORWARD_SEARCH_DVI,
85 RC_FORWARD_SEARCH_PDF,
87 RC_FULL_SCREEN_SCROLLBAR,
88 RC_FULL_SCREEN_STATUSBAR,
89 RC_FULL_SCREEN_TABBAR,
90 RC_FULL_SCREEN_MENUBAR,
91 RC_FULL_SCREEN_TOOLBARS,
98 RC_INDEX_ALTERNATIVES,
101 RC_JBIBTEX_ALTERNATIVES,
107 RC_LANGUAGE_AUTO_BEGIN,
108 RC_LANGUAGE_AUTO_END,
109 RC_LANGUAGE_COMMAND_BEGIN,
110 RC_LANGUAGE_COMMAND_END,
111 RC_LANGUAGE_COMMAND_LOCAL,
112 RC_LANGUAGE_GLOBAL_OPTIONS,
113 RC_LANGUAGE_CUSTOM_PACKAGE,
114 RC_LANGUAGE_PACKAGE_SELECTION,
118 RC_MAC_DONTSWAP_CTRL_META,
119 RC_MAC_LIKE_CURSOR_MOVEMENT,
121 RC_MARK_FOREIGN_LANGUAGE,
122 RC_MOUSE_WHEEL_SPEED,
123 RC_MOUSE_MIDDLEBUTTON_PASTE,
126 RC_OPEN_BUFFERS_IN_TABS,
127 RC_PARAGRAPH_MARKERS,
129 RC_PLAINTEXT_LINELEN,
131 RC_PREVIEW_HASHED_LABELS,
132 RC_PREVIEW_SCALE_FACTOR,
133 RC_PRINTLANDSCAPEFLAG,
134 RC_PRINTPAPERDIMENSIONFLAG,
136 RC_PYGMENTIZE_COMMAND,
140 RC_SCREEN_FONT_ROMAN,
141 RC_SCREEN_FONT_ROMAN_FOUNDRY,
143 RC_SCREEN_FONT_SANS_FOUNDRY,
144 RC_SCREEN_FONT_SCALABLE,
145 RC_SCREEN_FONT_SIZES,
146 RC_SCREEN_FONT_TYPEWRITER,
147 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
149 RC_SCROLL_BELOW_DOCUMENT,
150 RC_SCROLL_WHEEL_ZOOM,
154 RC_SINGLE_CLOSE_TAB_BUTTON,
157 RC_SPELLCHECK_CONTINUOUSLY,
160 RC_SPLITINDEX_COMMAND,
163 RC_TEX_ALLOWS_SPACES,
164 RC_TEX_EXPECTS_WINDOWS_PATHS,
171 RC_USE_CONVERTER_CACHE,
172 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
173 RC_USE_CONVERTER_NEEDAUTH,
174 RC_USE_NATIVE_FILEDIALOG,
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;
221 std::set<std::string> getRCs();
222 // FIXME unused (was used for xforms. Do we still need this?)
223 //static docstring const getDescription(LyXRCTags);
225 std::string bind_file;
227 std::string def_file;
231 std::string print_landscape_flag;
233 std::string print_paper_flag;
235 std::string print_paper_dimension_flag;
236 /// option for telling the dvi viewer about the paper size
237 std::string view_dvi_paper_option;
238 /// default paper size for local xdvi/dvips/ghostview/whatever
239 /// command to run chktex incl. options
240 std::string chktex_command;
241 /// all available commands to run bibtex incl. options
242 CommandSet bibtex_alternatives;
243 /// command to run bibtex incl. options
244 std::string bibtex_command;
245 /// command to run japanese bibtex incl. options
246 std::string jbibtex_command;
247 /// all available commands to run japanese bibtex incl. options
248 CommandSet jbibtex_alternatives;
249 /// all available index commands incl. options
250 CommandSet index_alternatives;
251 /// command to run makeindex incl. options or other index programs
252 std::string index_command;
253 /// command to run japanese index program incl. options
254 std::string jindex_command;
255 /// command to generate multiple indices
256 std::string splitindex_command;
257 /// command to run makeindex incl. options for nomencl
258 std::string nomencl_command;
259 /// command to run the python pygments syntax highlighter
260 std::string pygmentize_command;
262 std::string document_path;
264 std::string example_path;
266 std::string template_path;
268 std::string tempdir_path;
270 std::string thesaurusdir_path;
272 std::string hunspelldir_path;
274 bool auto_region_delete;
275 /// enable middle-mouse-button paste
276 bool mouse_middlebutton_paste;
277 /// flag telling whether lastfiles should be checked for existance
278 bool auto_reset_options;
280 bool check_lastfiles;
281 /// maximal number of lastfiles
282 unsigned int num_lastfiles;
283 /// whether or not go to saved position when opening a file
284 bool use_lastfilepos;
285 /// load files from last session automatically
287 /// do we save new documents as compressed by default
288 bool save_compressed;
289 /// whether or not to save the document dir in the file
291 /// shall a backup file be created
293 /// A directory for storing backup files
294 std::string backupdir_path;
295 /// Whether or not save/restore session information
296 /// like windows position and geometry.
297 bool allow_geometry_session;
298 /// Scrolling speed of the mouse wheel
299 double mouse_wheel_speed;
300 /// Default zoom factor for screen fonts
302 /// Actual zoom factor for screen fonts
303 /// (default zoom plus buffer zoom factor)
305 /// Screen font sizes in points for each font size
306 std::string font_sizes[10];
307 /// Allow the use of scalable fonts? Default is yes.
308 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 native file dialog or our own ?
336 bool use_native_filedialog;
337 /// Use pixmap cache?
338 bool use_pixmap_cache;
339 /// Spellchecker engine: aspell, hunspell, etc
340 std::string spellchecker;
341 /// Alternate language for spellchecker
342 std::string spellchecker_alt_lang;
343 /// Escape characters
344 std::string spellchecker_esc_chars;
345 /// spellcheck continuously?
346 bool spellcheck_continuously;
347 /// spellcheck notes and comments?
348 bool spellcheck_notes;
349 /// minimum length of words to complete
350 unsigned int completion_minlength;
354 std::string primary_kbmap;
356 std::string secondary_kbmap;
358 std::string lyxpipes;
360 std::string date_insert_format;
362 std::string language_custom_package;
364 bool language_auto_begin;
366 bool language_auto_end;
368 std::string language_command_begin;
370 std::string language_command_end;
372 std::string language_command_local;
374 bool language_global_options;
376 enum LangPackageSelection {
383 LangPackageSelection language_package_selection;
384 /// bidi cursor movement: true = visual, false = logical
389 bool mark_foreign_language;
391 std::string gui_language;
393 std::string default_otf_view_format;
395 std::string default_platex_view_format;
397 std::string default_view_format;
398 /// all available viewers
399 Alternatives viewer_alternatives;
400 /// all available editors
401 Alternatives editor_alternatives;
403 bool mac_dontswap_ctrl_meta;
405 bool mac_like_cursor_movement;
407 bool cursor_follows_scrollbar;
409 bool scroll_below_document;
411 enum MacroEditStyle {
412 MACRO_EDIT_INLINE_BOX = 0,
417 MacroEditStyle macro_edit_style;
419 bool dialogs_iconify_with_main;
421 bool display_graphics;
431 PreviewStatus preview;
433 bool preview_hashed_labels;
435 double preview_scale_factor;
437 std::string user_name;
439 std::string user_email;
441 std::string icon_set;
442 /// whether to use the icons from the theme
443 bool use_system_theme_icons;
444 /// True if the TeX engine cannot handle posix paths
445 bool windows_style_tex_paths;
446 /// True if the TeX engine can handle file names containing spaces
447 bool tex_allows_spaces;
448 /** Prepend paths to the PATH environment variable.
449 * The string is input, stored and output in native format.
451 std::string path_prefix;
452 /** Prepend paths to the TEXINPUTS environment variable.
453 * The string is input, stored and output in native format.
454 * A '.' here stands for the current document directory.
456 std::string texinputs_prefix;
457 /// Use the cache for file converters?
458 bool use_converter_cache;
459 /// Forbid use of external converters with 'needauth' option
460 bool use_converter_needauth_forbidden;
461 /// Ask user before calling external converters with 'needauth' option
462 bool use_converter_needauth;
463 /// The maximum age of cache files in seconds
464 unsigned int converter_cache_maxage;
465 /// Sort layouts alphabetically
467 /// Group layout by their category
469 /// Toggle toolbars in fullscreen mode?
470 bool full_screen_toolbars;
471 /// Toggle scrollbar in fullscreen mode?
472 bool full_screen_scrollbar;
473 /// Toggle tabbar in fullscreen mode?
474 bool full_screen_tabbar;
475 /// Toggle menubar in fullscreen mode?
476 bool full_screen_menubar;
477 /// Toggle statusbar in fullscreen mode?
478 bool full_screen_statusbar;
479 /// Limit the text width?
480 bool full_screen_limit;
481 /// Width of limited screen (in pixels) in fullscreen mode
482 int full_screen_width;
484 bool completion_cursor_text;
486 double completion_inline_delay;
488 bool completion_inline_math;
490 bool completion_inline_text;
492 int completion_inline_dots;
494 bool autocorrection_math;
496 double completion_popup_delay;
498 bool completion_popup_math;
500 bool completion_popup_text;
502 bool completion_popup_after_complete;
504 bool open_buffers_in_tabs;
506 bool single_close_tab_button;
508 bool single_instance;
510 std::string forward_search_dvi;
512 std::string forward_search_pdf;
514 int export_overwrite;
515 /// Default decimal point when aligning table columns on decimal
516 std::string default_decimal_point;
518 Length::UNIT default_length_unit;
520 enum ScrollWheelZoom {
521 SCROLL_WHEEL_ZOOM_OFF,
522 SCROLL_WHEEL_ZOOM_CTRL,
523 SCROLL_WHEEL_ZOOM_SHIFT,
524 SCROLL_WHEEL_ZOOM_ALT
527 ScrollWheelZoom scroll_wheel_zoom;
530 /// One of: yes, no, ask
531 std::string close_buffer_with_last_view;
535 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
540 extern LyXRC system_lyxrc;
542 // used by at least frontends/qt4/GuiPref.cpp
543 const long maxlastfiles = 50;