src/LyXRC.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXRC.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Allan Rae
  13  * \author Dekel Tsur
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #ifndef LYXRC_H
  19 #define LYXRC_H
  20
  21 #include "paper.h"
  22
  23 #include "support/strfwd.h"
  24
  25 #include <string>
  26
  27
  28 namespace lyx {
  29
  30 namespace support { class FileName; }
  31
  32 class Lexer;
  33
  34 /// This contains the runtime configuration of LyX
  35 class LyXRC
  36 {
  37 public:
  38         enum LyXRCTags {
  39                 RC_ACCEPT_COMPOUND = 1,
  40                 RC_ALT_LANG,
  41                 RC_PLAINTEXT_ROFF_COMMAND,
  42                 RC_PLAINTEXT_LINELEN,
  43                 RC_AUTOREGIONDELETE,
  44                 RC_AUTORESET_OPTIONS,
  45                 RC_AUTOSAVE,
  46                 RC_AUTO_NUMBER,
  47                 RC_BACKUPDIR_PATH,
  48                 RC_BIBTEX_COMMAND,
  49                 RC_BINDFILE,
  50                 RC_CHECKLASTFILES,
  51                 RC_CHKTEX_COMMAND,
  52                 RC_CONVERTER,
  53                 RC_CONVERTER_CACHE_MAXAGE,
  54                 RC_COPIER,
  55                 RC_CURSOR_FOLLOWS_SCROLLBAR,
  56                 RC_CUSTOM_EXPORT_COMMAND,
  57                 RC_CUSTOM_EXPORT_FORMAT,
  58                 RC_DATE_INSERT_FORMAT,
  59                 RC_DEFFILE,
  60                 RC_DEFAULT_LANGUAGE,
  61                 RC_DEFAULT_PAPERSIZE,
  62                 RC_DIALOGS_ICONIFY_WITH_MAIN,
  63                 RC_DISPLAY_GRAPHICS,
  64                 RC_DOCUMENTPATH,
  65                 RC_ESC_CHARS,
  66                 RC_EXAMPLEPATH,
  67                 RC_FONT_ENCODING,
  68                 RC_FORMAT,
  69                 RC_INDEX_COMMAND,
  70                 RC_INPUT,
  71                 RC_KBMAP,
  72                 RC_KBMAP_PRIMARY,
  73                 RC_KBMAP_SECONDARY,
  74                 RC_LABEL_INIT_LENGTH,
  75                 RC_LANGUAGE_AUTO_BEGIN,
  76                 RC_LANGUAGE_AUTO_END,
  77                 RC_LANGUAGE_COMMAND_BEGIN,
  78                 RC_LANGUAGE_COMMAND_END,
  79                 RC_LANGUAGE_COMMAND_LOCAL,
  80                 RC_LANGUAGE_GLOBAL_OPTIONS,
  81                 RC_LANGUAGE_PACKAGE,
  82                 RC_LANGUAGE_USE_BABEL,
  83                 RC_SORT_LAYOUTS,
  84                 RC_USELASTFILEPOS,
  85                 RC_LOADSESSION,
  86                 RC_MACRO_EDIT_STYLE,
  87                 RC_MAKE_BACKUP,
  88                 RC_MARK_FOREIGN_LANGUAGE,
  89                 RC_MOUSE_WHEEL_SPEED,
  90                 RC_NUMLASTFILES,
  91                 RC_PATH_PREFIX,
  92                 RC_PERS_DICT,
  93                 RC_PREVIEW,
  94                 RC_PREVIEW_HASHED_LABELS,
  95                 RC_PREVIEW_SCALE_FACTOR,
  96                 RC_PRINTCOLLCOPIESFLAG,
  97                 RC_PRINTCOPIESFLAG,
  98                 RC_PRINTER,
  99                 RC_PRINTEVENPAGEFLAG,
 100                 RC_PRINTEXSTRAOPTIONS,
 101                 RC_PRINTFILEEXTENSION,
 102                 RC_PRINTLANDSCAPEFLAG,
 103                 RC_PRINTODDPAGEFLAG,
 104                 RC_PRINTPAGERANGEFLAG,
 105                 RC_PRINTPAPERDIMENSIONFLAG,
 106                 RC_PRINTPAPERFLAG,
 107                 RC_PRINTREVERSEFLAG,
 108                 RC_PRINTSPOOL_COMMAND,
 109                 RC_PRINTSPOOL_PRINTERPREFIX,
 110                 RC_PRINTTOFILE,
 111                 RC_PRINTTOPRINTER,
 112                 RC_PRINT_ADAPTOUTPUT,
 113                 RC_PRINT_COMMAND,
 114                 RC_RTL_SUPPORT,
 115                 RC_SCREEN_DPI,
 116                 RC_SCREEN_FONT_ROMAN,
 117                 RC_SCREEN_FONT_ROMAN_FOUNDRY,
 118                 RC_SCREEN_FONT_SANS,
 119                 RC_SCREEN_FONT_SANS_FOUNDRY,
 120                 RC_SCREEN_FONT_SCALABLE,
 121                 RC_SCREEN_FONT_SIZES,
 122                 RC_SCREEN_FONT_TYPEWRITER,
 123                 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
 124                 RC_GEOMETRY_SESSION,
 125                 RC_SCREEN_ZOOM,
 126                 RC_SERVERPIPE,
 127                 RC_SET_COLOR,
 128                 RC_SHOW_BANNER,
 129                 RC_SPELL_COMMAND,
 130                 RC_TEMPDIRPATH,
 131                 RC_TEMPLATEPATH,
 132                 RC_TEX_ALLOWS_SPACES,
 133                 RC_TEX_EXPECTS_WINDOWS_PATHS,
 134                 RC_UIFILE,
 135                 RC_USER_EMAIL,
 136                 RC_USER_NAME,
 137                 RC_USETEMPDIR,
 138                 RC_USE_ALT_LANG,
 139                 RC_USE_CONVERTER_CACHE,
 140                 RC_USE_ESC_CHARS,
 141                 RC_USE_INP_ENC,
 142                 RC_USE_PERS_DICT,
 143                 RC_USE_TOOLTIP,
 144                 RC_USE_PIXMAP_CACHE,
 145                 RC_USE_SPELL_LIB,
 146                 RC_VIEWDVI_PAPEROPTION,
 147                 RC_VIEWER,
 148                 RC_LAST
 149         };
 150
 151         ///
 152         LyXRC();
 153         ///
 154         void setDefaults();
 155         ///
 156         int read(support::FileName const & filename);
 157         ///
 158         int read(std::istream &);
 159 private:
 160         ///
 161         int read(Lexer &);
 162 public:
 163         ///
 164         void write(support::FileName const & filename,
 165                    bool ignore_system_lyxrc) const;
 166         /// write rc. If a specific tag is given, only output that one.
 167         void write(std::ostream & os,
 168                    bool ignore_system_lyxrc,
 169                    std::string const & tag = std::string()) const;
 170         ///
 171         void print() const;
 172         // FIXME unused (was used for xforms. Do we still need this?)
 173         //static docstring const getDescription(LyXRCTags);
 174         ///
 175         std::string bind_file;
 176         ///
 177         std::string def_file;
 178         ///
 179         std::string ui_file;
 180         ///
 181         std::string printer;
 182         ///
 183         std::string print_command;
 184         ///
 185         std::string print_evenpage_flag;
 186         ///
 187         std::string print_oddpage_flag;
 188         ///
 189         std::string print_pagerange_flag;
 190         ///
 191         std::string print_copies_flag;
 192         ///
 193         std::string print_collcopies_flag;
 194         ///
 195         std::string print_reverse_flag;
 196         ///
 197         std::string print_landscape_flag;
 198         ///
 199         std::string print_to_printer;
 200         ///
 201         bool print_adapt_output;
 202         ///
 203         std::string print_to_file;
 204         ///
 205         std::string print_file_extension;
 206         ///
 207         std::string print_extra_options;
 208         ///
 209         std::string print_spool_command;
 210         ///
 211         std::string print_spool_printerprefix;
 212         ///
 213         std::string print_paper_flag;
 214         ///
 215         std::string print_paper_dimension_flag;
 216         ///
 217         std::string custom_export_command;
 218         ///
 219         std::string custom_export_format;
 220         /// option for telling the dvi viewer about the paper size
 221         std::string view_dvi_paper_option;
 222         /// default paper size for local xdvi/dvips/ghostview/whatever
 223         PAPER_SIZE default_papersize;
 224         /// command to run chktex incl. options
 225         std::string chktex_command;
 226         /// command to run bibtex incl. options
 227         std::string bibtex_command;
 228         /// command to run makeindex incl. options or other index programs
 229         std::string index_command;
 230         ///
 231         std::string document_path;
 232         ///
 233         std::string example_path;
 234         ///
 235         std::string template_path;
 236         ///
 237         std::string tempdir_path;
 238         ///
 239         bool auto_region_delete;
 240         /// flag telling whether lastfiles should be checked for existance
 241         bool auto_reset_options;
 242         ///
 243         bool check_lastfiles;
 244         /// maximal number of lastfiles
 245         unsigned int num_lastfiles;
 246         /// whether or not go to saved position when opening a file
 247         bool use_lastfilepos;
 248         /// load files from last session automatically
 249         bool load_session;
 250         /// shall a backup file be created
 251         bool make_backup;
 252         /// A directory for storing backup files
 253         std::string backupdir_path;
 254         /// Whether or not save/restore session information
 255         /// like windows position and geometry.
 256         bool allow_geometry_session;
 257         /// Scrolling speed of the mouse wheel
 258         double mouse_wheel_speed;
 259         /// Zoom factor for screen fonts
 260         unsigned int zoom;
 261         /// Screen font sizes in points for each font size
 262         std::string font_sizes[10];
 263         /// Allow the use of scalable fonts? Default is yes.
 264         bool use_scalable_fonts;
 265         /// DPI of monitor
 266         unsigned int dpi;
 267         ///
 268         std::string fontenc;
 269         ///
 270         std::string roman_font_name;
 271         ///
 272         std::string sans_font_name;
 273         ///
 274         std::string typewriter_font_name;
 275         ///
 276         std::string roman_font_foundry;
 277         ///
 278         std::string sans_font_foundry;
 279         ///
 280         std::string typewriter_font_foundry;
 281         ///
 282         unsigned int autosave;
 283         ///
 284         std::string plaintext_roff_command;
 285         ///
 286         unsigned int plaintext_linelen;
 287         /// use library instead of process
 288         bool use_spell_lib;
 289         /// Ispell command
 290         std::string isp_command;
 291         /// Accept compound words in spellchecker?
 292         bool isp_accept_compound;
 293         /// Pass input encoding switch to ispell?
 294         bool isp_use_input_encoding;
 295         /// Use alternate language?
 296         bool isp_use_alt_lang;
 297         /// Use personal dictionary?
 298         bool isp_use_pers_dict;
 299         /// Use tooltips?
 300         bool use_tooltip;
 301         /// Use pixmap cache?
 302         bool use_pixmap_cache;
 303         /// Use escape chars?
 304         bool isp_use_esc_chars;
 305         /// Alternate language for ispell
 306         std::string isp_alt_lang;
 307         /// Alternate personal dictionary file for ispell
 308         std::string isp_pers_dict;
 309         /// Escape characters
 310         std::string isp_esc_chars;
 311         ///
 312         bool use_kbmap;
 313         ///
 314         std::string primary_kbmap;
 315         ///
 316         std::string secondary_kbmap;
 317         ///
 318         std::string lyxpipes;
 319         ///
 320         std::string date_insert_format;
 321         ///
 322         std::string language_package;
 323         ///
 324         bool language_auto_begin;
 325         ///
 326         bool language_auto_end;
 327         ///
 328         std::string language_command_begin;
 329         ///
 330         std::string language_command_end;
 331         ///
 332         std::string language_command_local;
 333         ///
 334         bool language_global_options;
 335         ///
 336         bool language_use_babel;
 337         ///
 338         bool rtl_support;
 339         ///
 340         bool auto_number;
 341         ///
 342         bool mark_foreign_language;
 343         ///
 344         std::string default_language;
 345         ///
 346         bool cursor_follows_scrollbar;
 347         ///
 348         enum MacroEditStyle {
 349                 MACRO_EDIT_INLINE_BOX = 0,
 350                 MACRO_EDIT_INLINE,
 351                 MACRO_EDIT_LIST
 352         };
 353         ///
 354         MacroEditStyle macro_edit_style;
 355         ///
 356         bool dialogs_iconify_with_main;
 357         ///
 358         int label_init_length;
 359         ///
 360         ///graphics::DisplayType
 361         int display_graphics;
 362         ///
 363         bool show_banner;
 364         ///
 365         enum PreviewStatus {
 366                 PREVIEW_OFF,
 367                 PREVIEW_NO_MATH,
 368                 PREVIEW_ON
 369         };
 370         ///
 371         PreviewStatus preview;
 372         ///
 373         bool preview_hashed_labels;
 374         ///
 375         std::string preview_scale_factor;
 376         /// user name
 377         std::string user_name;
 378         /// user email
 379         std::string user_email;
 380         /// True if the TeX engine cannot handle posix paths
 381         bool windows_style_tex_paths;
 382         /// True if the TeX engine can handle file names containing spaces
 383         bool tex_allows_spaces;
 384         /** Prepend paths to the PATH environment variable.
 385          *  The string is input, stored and output in native format.
 386          */
 387         std::string path_prefix;
 388         /// Use the cache for file converters?
 389         bool use_converter_cache;
 390         /// The maximum age of cache files in seconds
 391         unsigned int converter_cache_maxage;
 392         /// Sort layouts alphabetically
 393         bool sort_layouts;
 394 };
 395
 396
 397 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 398  *  It can be forward-declared and passed as a function argument without
 399  *  having to expose LyXRC.h.
 400  */
 401 class LyXRC_PreviewStatus {
 402         LyXRC::PreviewStatus val_;
 403 public:
 404         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 405         operator LyXRC::PreviewStatus() const { return val_; }
 406 };
 407
 408
 409 ///
 410 extern LyXRC lyxrc;
 411 ///
 412 extern LyXRC system_lyxrc;
 413
 414 } // namespace lyx
 415
 416 #endif