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"
33 namespace support { class FileName; }
37 /// This contains the runtime configuration of LyX
42 RC_ACCEPT_COMPOUND = 1,
44 RC_AUTOCORRECTION_MATH,
50 RC_BIBTEX_ALTERNATIVES,
55 RC_COMPLETION_CURSOR_TEXT,
56 RC_COMPLETION_INLINE_DELAY,
57 RC_COMPLETION_INLINE_MATH,
58 RC_COMPLETION_INLINE_TEXT,
59 RC_COMPLETION_INLINE_DOTS,
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,
68 RC_DATE_INSERT_FORMAT,
70 RC_DEFAULT_VIEW_FORMAT,
73 RC_DIALOGS_ICONIFY_WITH_MAIN,
76 RC_EDITOR_ALTERNATIVES,
82 RC_FORWARD_SEARCH_DVI,
83 RC_FORWARD_SEARCH_PDF,
85 RC_FULL_SCREEN_SCROLLBAR,
86 RC_FULL_SCREEN_TABBAR,
87 RC_FULL_SCREEN_MENUBAR,
88 RC_FULL_SCREEN_TOOLBARS,
94 RC_INDEX_ALTERNATIVES,
102 RC_LANGUAGE_AUTO_BEGIN,
103 RC_LANGUAGE_AUTO_END,
104 RC_LANGUAGE_COMMAND_BEGIN,
105 RC_LANGUAGE_COMMAND_END,
106 RC_LANGUAGE_COMMAND_LOCAL,
107 RC_LANGUAGE_GLOBAL_OPTIONS,
109 RC_LANGUAGE_USE_BABEL,
112 RC_MAC_LIKE_WORD_MOVEMENT,
114 RC_MARK_FOREIGN_LANGUAGE,
115 RC_MOUSE_WHEEL_SPEED,
118 RC_OPEN_BUFFERS_IN_TABS,
119 RC_PARAGRAPH_MARKERS,
122 RC_PLAINTEXT_LINELEN,
123 RC_PLAINTEXT_ROFF_COMMAND,
125 RC_PREVIEW_HASHED_LABELS,
126 RC_PREVIEW_SCALE_FACTOR,
127 RC_PRINTCOLLCOPIESFLAG,
130 RC_PRINTEVENPAGEFLAG,
131 RC_PRINTEXSTRAOPTIONS,
132 RC_PRINTFILEEXTENSION,
133 RC_PRINTLANDSCAPEFLAG,
135 RC_PRINTPAGERANGEFLAG,
136 RC_PRINTPAPERDIMENSIONFLAG,
139 RC_PRINTSPOOL_COMMAND,
140 RC_PRINTSPOOL_PRINTERPREFIX,
143 RC_PRINT_ADAPTOUTPUT,
148 RC_SCREEN_FONT_ROMAN,
149 RC_SCREEN_FONT_ROMAN_FOUNDRY,
151 RC_SCREEN_FONT_SANS_FOUNDRY,
152 RC_SCREEN_FONT_SCALABLE,
153 RC_SCREEN_FONT_SIZES,
154 RC_SCREEN_FONT_TYPEWRITER,
155 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
157 RC_SCROLL_BELOW_DOCUMENT,
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,
186 RC_VIEWDVI_PAPEROPTION,
188 RC_VIEWER_ALTERNATIVES,
198 int read(support::FileName const & filename);
200 int read(std::istream &);
206 typedef std::set<std::string> CommandSet;
207 /// maps a format to a set of commands that can be used to
209 typedef std::map<std::string, CommandSet> Alternatives;
211 void write(support::FileName const & filename,
212 bool ignore_system_lyxrc) const;
213 /// write rc. If a specific tag is given, only output that one.
214 void write(std::ostream & os,
215 bool ignore_system_lyxrc,
216 std::string const & tag = std::string()) const;
219 // FIXME unused (was used for xforms. Do we still need this?)
220 //static docstring const getDescription(LyXRCTags);
222 std::string bind_file;
224 std::string def_file;
230 std::string print_command;
232 std::string print_evenpage_flag;
234 std::string print_oddpage_flag;
236 std::string print_pagerange_flag;
238 std::string print_copies_flag;
240 std::string print_collcopies_flag;
242 std::string print_reverse_flag;
244 std::string print_landscape_flag;
246 std::string print_to_printer;
248 bool print_adapt_output;
250 std::string print_to_file;
252 std::string print_file_extension;
254 std::string print_extra_options;
256 std::string print_spool_command;
258 std::string print_spool_printerprefix;
260 std::string print_paper_flag;
262 std::string print_paper_dimension_flag;
263 /// option for telling the dvi viewer about the paper size
264 std::string view_dvi_paper_option;
265 /// default paper size for local xdvi/dvips/ghostview/whatever
266 PAPER_SIZE default_papersize;
267 /// command to run chktex incl. options
268 std::string chktex_command;
269 /// all available commands to run bibtex incl. options
270 CommandSet bibtex_alternatives;
271 /// command to run bibtex incl. options
272 std::string bibtex_command;
273 /// command to run japanese bibtex incl. options
274 std::string jbibtex_command;
275 /// all available index commands incl. options
276 CommandSet index_alternatives;
277 /// command to run makeindex incl. options or other index programs
278 std::string index_command;
279 /// command to run japanese index program incl. options
280 std::string jindex_command;
281 /// command to generate multiple indices
282 std::string splitindex_command;
283 /// command to run makeindex incl. options for nomencl
284 std::string nomencl_command;
286 std::string document_path;
288 std::string example_path;
290 std::string template_path;
292 std::string tempdir_path;
294 std::string thesaurusdir_path;
296 std::string hunspelldir_path;
298 bool auto_region_delete;
299 /// flag telling whether lastfiles should be checked for existance
300 bool auto_reset_options;
302 bool check_lastfiles;
303 /// maximal number of lastfiles
304 unsigned int num_lastfiles;
305 /// whether or not go to saved position when opening a file
306 bool use_lastfilepos;
307 /// load files from last session automatically
309 /// do we save new documents as compressed by default
310 bool save_compressed;
311 /// shall a backup file be created
313 /// A directory for storing backup files
314 std::string backupdir_path;
315 /// Whether or not save/restore session information
316 /// like windows position and geometry.
317 bool allow_geometry_session;
318 /// Scrolling speed of the mouse wheel
319 double mouse_wheel_speed;
320 /// Zoom factor for screen fonts
322 /// Screen font sizes in points for each font size
323 std::string font_sizes[10];
324 /// Allow the use of scalable fonts? Default is yes.
325 bool use_scalable_fonts;
331 std::string roman_font_name;
333 std::string sans_font_name;
335 std::string typewriter_font_name;
337 std::string roman_font_foundry;
339 std::string sans_font_foundry;
341 std::string typewriter_font_foundry;
343 unsigned int autosave;
345 unsigned int plaintext_linelen;
346 /// Accept compound words in spellchecker?
347 bool spellchecker_accept_compound;
348 /// End of paragraph markers?
349 bool paragraph_markers;
352 /// Use pixmap cache?
353 bool use_pixmap_cache;
354 /// Spellchecker engine: aspell, hunspell, etc
355 std::string spellchecker;
356 /// Alternate language for spellchecker
357 std::string spellchecker_alt_lang;
358 /// Escape characters
359 std::string spellchecker_esc_chars;
360 /// spellcheck continuously?
361 bool spellcheck_continuously;
362 /// spellcheck notes and comments?
363 bool spellcheck_notes;
367 std::string primary_kbmap;
369 std::string secondary_kbmap;
371 std::string lyxpipes;
373 std::string date_insert_format;
375 std::string language_package;
377 bool language_auto_begin;
379 bool language_auto_end;
381 std::string language_command_begin;
383 std::string language_command_end;
385 std::string language_command_local;
387 bool language_global_options;
389 bool language_use_babel;
392 /// bidi cursor movement: true = visual, false = logical
397 bool mark_foreign_language;
399 std::string default_language;
401 std::string gui_language;
403 std::string default_view_format;
404 /// all available viewers
405 Alternatives viewer_alternatives;
406 /// all available editors
407 Alternatives editor_alternatives;
409 bool mac_like_word_movement;
411 bool cursor_follows_scrollbar;
413 bool scroll_below_document;
415 enum MacroEditStyle {
416 MACRO_EDIT_INLINE_BOX = 0,
421 MacroEditStyle macro_edit_style;
423 bool dialogs_iconify_with_main;
425 bool display_graphics;
435 PreviewStatus preview;
437 bool preview_hashed_labels;
439 double preview_scale_factor;
441 std::string user_name;
443 std::string user_email;
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 /// Use the cache for file converters?
453 bool use_converter_cache;
454 /// The maximum age of cache files in seconds
455 unsigned int converter_cache_maxage;
456 /// Sort layouts alphabetically
458 /// Group layout by their category
460 /// Toggle toolbars in fullscreen mode?
461 bool full_screen_toolbars;
462 /// Toggle scrollbar in fullscreen mode?
463 bool full_screen_scrollbar;
464 /// Toggle tabbar in fullscreen mode?
465 bool full_screen_tabbar;
466 /// Toggle menubar in fullscreen mode?
467 bool full_screen_menubar;
468 /// Limit the text width?
469 bool full_screen_limit;
470 /// Width of limited screen (in pixels) in fullscreen mode
471 int full_screen_width;
473 bool completion_cursor_text;
475 double completion_inline_delay;
477 bool completion_inline_math;
479 bool completion_inline_text;
481 int completion_inline_dots;
483 bool autocorrection_math;
485 double completion_popup_delay;
487 bool completion_popup_math;
489 bool completion_popup_text;
491 bool completion_popup_after_complete;
493 bool open_buffers_in_tabs;
495 bool single_close_tab_button;
497 std::string forward_search_dvi;
499 std::string forward_search_pdf;
501 int export_overwrite;
505 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
506 * It can be forward-declared and passed as a function argument without
507 * having to expose LyXRC.h.
509 class LyXRC_PreviewStatus {
510 LyXRC::PreviewStatus val_;
512 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
513 operator LyXRC::PreviewStatus() const { return val_; }
516 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
521 extern LyXRC system_lyxrc;
523 // used by at least frontends/qt4/GuiPref.cpp
524 const long maxlastfiles = 20;