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.
22 #include "graphics/GraphicsTypes.h"
30 namespace support { class FileName; }
34 /// This contains the runtime configuration of LyX
35 class LyXRC //: public noncopyable
36 // after 1.1.6 I will use a LyXRCStruct here and then this can be made
37 // noncopyable again. For now I want to minimise changes. ARRae 20001010
41 RC_ACCEPT_COMPOUND = 1,
43 RC_PLAINTEXT_ROFF_COMMAND,
55 RC_CONVERTER_CACHE_MAXAGE,
57 RC_CURSOR_FOLLOWS_SCROLLBAR,
58 RC_CUSTOM_EXPORT_COMMAND,
59 RC_CUSTOM_EXPORT_FORMAT,
60 RC_DATE_INSERT_FORMAT,
64 RC_DIALOGS_ICONIFY_WITH_MAIN,
76 RC_LANGUAGE_AUTO_BEGIN,
78 RC_LANGUAGE_COMMAND_BEGIN,
79 RC_LANGUAGE_COMMAND_END,
80 RC_LANGUAGE_COMMAND_LOCAL,
81 RC_LANGUAGE_GLOBAL_OPTIONS,
83 RC_LANGUAGE_USE_BABEL,
87 RC_MARK_FOREIGN_LANGUAGE,
92 RC_PREVIEW_HASHED_LABELS,
93 RC_PREVIEW_SCALE_FACTOR,
94 RC_PRINTCOLLCOPIESFLAG,
98 RC_PRINTEXSTRAOPTIONS,
99 RC_PRINTFILEEXTENSION,
100 RC_PRINTLANDSCAPEFLAG,
102 RC_PRINTPAGERANGEFLAG,
103 RC_PRINTPAPERDIMENSIONFLAG,
106 RC_PRINTSPOOL_COMMAND,
107 RC_PRINTSPOOL_PRINTERPREFIX,
110 RC_PRINT_ADAPTOUTPUT,
114 RC_SCREEN_FONT_ROMAN,
115 RC_SCREEN_FONT_ROMAN_FOUNDRY,
117 RC_SCREEN_FONT_SANS_FOUNDRY,
118 RC_SCREEN_FONT_SCALABLE,
119 RC_SCREEN_FONT_SIZES,
120 RC_SCREEN_FONT_TYPEWRITER,
121 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
122 RC_SCREEN_GEOMETRY_HEIGHT,
123 RC_SCREEN_GEOMETRY_WIDTH,
124 RC_SCREEN_GEOMETRY_XYSAVED,
132 RC_TEX_ALLOWS_SPACES,
133 RC_TEX_EXPECTS_WINDOWS_PATHS,
139 RC_USE_CONVERTER_CACHE,
144 RC_VIEWDVI_PAPEROPTION,
154 int read(support::FileName const & filename);
156 int read(std::istream &);
162 void write(support::FileName const & filename,
163 bool ignore_system_lyxrc) const;
164 /// write rc. If a specific tag is given, only output that one.
165 void write(std::ostream & os,
166 bool ignore_system_lyxrc,
167 std::string const & tag = std::string()) const;
170 // FIXME unused (was used for xforms. Do we still need this?)
171 //static docstring const getDescription(LyXRCTags);
173 std::string bind_file;
175 std::string def_file;
181 std::string print_command;
183 std::string print_evenpage_flag;
185 std::string print_oddpage_flag;
187 std::string print_pagerange_flag;
189 std::string print_copies_flag;
191 std::string print_collcopies_flag;
193 std::string print_reverse_flag;
195 std::string print_landscape_flag;
197 std::string print_to_printer;
199 bool print_adapt_output;
201 std::string print_to_file;
203 std::string print_file_extension;
205 std::string print_extra_options;
207 std::string print_spool_command;
209 std::string print_spool_printerprefix;
211 std::string print_paper_flag;
213 std::string print_paper_dimension_flag;
215 std::string custom_export_command;
217 std::string custom_export_format;
218 /// option for telling the dvi viewer about the paper size
219 std::string view_dvi_paper_option;
220 /// default paper size for local xdvi/dvips/ghostview/whatever
221 PAPER_SIZE default_papersize;
222 /// command to run chktex incl. options
223 std::string chktex_command;
224 /// command to run bibtex incl. options
225 std::string bibtex_command;
226 /// command to run makeindex incl. options or other index programs
227 std::string index_command;
229 std::string document_path;
231 std::string template_path;
233 std::string tempdir_path;
235 bool auto_region_delete;
236 /// flag telling whether lastfiles should be checked for existance
237 bool auto_reset_options;
239 bool check_lastfiles;
240 /// maximal number of lastfiles
241 unsigned int num_lastfiles;
242 /// whether or not go to saved position when opening a file
243 bool use_lastfilepos;
244 /// load files from last session automatically
246 /// shall a backup file be created
248 /// A directory for storing backup files
249 std::string backupdir_path;
250 /// Width of MainWindow. if 0, value from last session will be used
252 /// Height of MainWindow, if 0, value from last session will be used
254 /// Whether or not save/restore windows position as session info
255 bool geometry_xysaved;
256 /// Zoom factor for screen fonts
258 /// Screen font sizes in points for each font size
259 std::string font_sizes[10];
260 /// Allow the use of scalable fonts? Default is yes.
261 bool use_scalable_fonts;
267 std::string roman_font_name;
269 std::string sans_font_name;
271 std::string typewriter_font_name;
273 std::string roman_font_foundry;
275 std::string sans_font_foundry;
277 std::string typewriter_font_foundry;
279 unsigned int autosave;
281 std::string plaintext_roff_command;
283 unsigned int plaintext_linelen;
284 /// use library instead of process
287 std::string isp_command;
288 /// Accept compound words in spellchecker?
289 bool isp_accept_compound;
290 /// Pass input encoding switch to ispell?
291 bool isp_use_input_encoding;
292 /// Use alternate language?
293 bool isp_use_alt_lang;
294 /// Use personal dictionary?
295 bool isp_use_pers_dict;
296 /// Use escape chars?
297 bool isp_use_esc_chars;
298 /// Alternate language for ispell
299 std::string isp_alt_lang;
300 /// Alternate personal dictionary file for ispell
301 std::string isp_pers_dict;
302 /// Escape characters
303 std::string isp_esc_chars;
307 std::string primary_kbmap;
309 std::string secondary_kbmap;
311 std::string lyxpipes;
313 std::string date_insert_format;
315 std::string language_package;
317 bool language_auto_begin;
319 bool language_auto_end;
321 std::string language_command_begin;
323 std::string language_command_end;
325 std::string language_command_local;
327 bool language_global_options;
329 bool language_use_babel;
335 bool mark_foreign_language;
337 std::string default_language;
339 bool cursor_follows_scrollbar;
341 bool dialogs_iconify_with_main;
343 int label_init_length;
345 graphics::DisplayType display_graphics;
355 PreviewStatus preview;
357 bool preview_hashed_labels;
359 std::string preview_scale_factor;
361 std::string user_name;
363 std::string user_email;
364 /// True if the TeX engine cannot handle posix paths
365 bool windows_style_tex_paths;
366 /// True if the TeX engine can handle file names containing spaces
367 bool tex_allows_spaces;
368 /** Prepend paths to the PATH environment variable.
369 * The string is input, stored and output in native format.
371 std::string path_prefix;
372 /// Use the cache for file converters?
373 bool use_converter_cache;
374 /// The maximum age of cache files in seconds
375 unsigned int converter_cache_maxage;
379 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
380 * It can be forward-declared and passed as a function argument without
381 * having to expose LyXRC.h.
383 class LyXRC_PreviewStatus {
384 LyXRC::PreviewStatus val_;
386 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
387 operator LyXRC::PreviewStatus() const{ return val_; }
394 extern LyXRC system_lyxrc;