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_MAKE_BACKUP,
  87                 RC_MARK_FOREIGN_LANGUAGE,
  88                 RC_NUMLASTFILES,
  89                 RC_PATH_PREFIX,
  90                 RC_PERS_DICT,
  91                 RC_PREVIEW,
  92                 RC_PREVIEW_HASHED_LABELS,
  93                 RC_PREVIEW_SCALE_FACTOR,
  94                 RC_PRINTCOLLCOPIESFLAG,
  95                 RC_PRINTCOPIESFLAG,
  96                 RC_PRINTER,
  97                 RC_PRINTEVENPAGEFLAG,
  98                 RC_PRINTEXSTRAOPTIONS,
  99                 RC_PRINTFILEEXTENSION,
 100                 RC_PRINTLANDSCAPEFLAG,
 101                 RC_PRINTODDPAGEFLAG,
 102                 RC_PRINTPAGERANGEFLAG,
 103                 RC_PRINTPAPERDIMENSIONFLAG,
 104                 RC_PRINTPAPERFLAG,
 105                 RC_PRINTREVERSEFLAG,
 106                 RC_PRINTSPOOL_COMMAND,
 107                 RC_PRINTSPOOL_PRINTERPREFIX,
 108                 RC_PRINTTOFILE,
 109                 RC_PRINTTOPRINTER,
 110                 RC_PRINT_ADAPTOUTPUT,
 111                 RC_PRINT_COMMAND,
 112                 RC_RTL_SUPPORT,
 113                 RC_SCREEN_DPI,
 114                 RC_SCREEN_FONT_ROMAN,
 115                 RC_SCREEN_FONT_ROMAN_FOUNDRY,
 116                 RC_SCREEN_FONT_SANS,
 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_GEOMETRY_SESSION,
 123                 RC_SCREEN_ZOOM,
 124                 RC_SERVERPIPE,
 125                 RC_SET_COLOR,
 126                 RC_SHOW_BANNER,
 127                 RC_SPELL_COMMAND,
 128                 RC_TEMPDIRPATH,
 129                 RC_TEMPLATEPATH,
 130                 RC_TEX_ALLOWS_SPACES,
 131                 RC_TEX_EXPECTS_WINDOWS_PATHS,
 132                 RC_UIFILE,
 133                 RC_USER_EMAIL,
 134                 RC_USER_NAME,
 135                 RC_USETEMPDIR,
 136                 RC_USE_ALT_LANG,
 137                 RC_USE_CONVERTER_CACHE,
 138                 RC_USE_ESC_CHARS,
 139                 RC_USE_INP_ENC,
 140                 RC_USE_PERS_DICT,
 141                 RC_USE_PIXMAP_CACHE,
 142                 RC_USE_SPELL_LIB,
 143                 RC_VIEWDVI_PAPEROPTION,
 144                 RC_VIEWER,
 145                 RC_LAST
 146         };
 147
 148         ///
 149         LyXRC();
 150         ///
 151         void setDefaults();
 152         ///
 153         int read(support::FileName const & filename);
 154         ///
 155         int read(std::istream &);
 156 private:
 157         ///
 158         int read(Lexer &);
 159 public:
 160         ///
 161         void write(support::FileName const & filename,
 162                    bool ignore_system_lyxrc) const;
 163         /// write rc. If a specific tag is given, only output that one.
 164         void write(std::ostream & os,
 165                    bool ignore_system_lyxrc,
 166                    std::string const & tag = std::string()) const;
 167         ///
 168         void print() const;
 169         // FIXME unused (was used for xforms. Do we still need this?)
 170         //static docstring const getDescription(LyXRCTags);
 171         ///
 172         std::string bind_file;
 173         ///
 174         std::string def_file;
 175         ///
 176         std::string ui_file;
 177         ///
 178         std::string printer;
 179         ///
 180         std::string print_command;
 181         ///
 182         std::string print_evenpage_flag;
 183         ///
 184         std::string print_oddpage_flag;
 185         ///
 186         std::string print_pagerange_flag;
 187         ///
 188         std::string print_copies_flag;
 189         ///
 190         std::string print_collcopies_flag;
 191         ///
 192         std::string print_reverse_flag;
 193         ///
 194         std::string print_landscape_flag;
 195         ///
 196         std::string print_to_printer;
 197         ///
 198         bool print_adapt_output;
 199         ///
 200         std::string print_to_file;
 201         ///
 202         std::string print_file_extension;
 203         ///
 204         std::string print_extra_options;
 205         ///
 206         std::string print_spool_command;
 207         ///
 208         std::string print_spool_printerprefix;
 209         ///
 210         std::string print_paper_flag;
 211         ///
 212         std::string print_paper_dimension_flag;
 213         ///
 214         std::string custom_export_command;
 215         ///
 216         std::string custom_export_format;
 217         /// option for telling the dvi viewer about the paper size
 218         std::string view_dvi_paper_option;
 219         /// default paper size for local xdvi/dvips/ghostview/whatever
 220         PAPER_SIZE default_papersize;
 221         /// command to run chktex incl. options
 222         std::string chktex_command;
 223         /// command to run bibtex incl. options
 224         std::string bibtex_command;
 225         /// command to run makeindex incl. options or other index programs
 226         std::string index_command;
 227         ///
 228         std::string document_path;
 229         ///
 230         std::string example_path;
 231         ///
 232         std::string template_path;
 233         ///
 234         std::string tempdir_path;
 235         ///
 236         bool auto_region_delete;
 237         /// flag telling whether lastfiles should be checked for existance
 238         bool auto_reset_options;
 239         ///
 240         bool check_lastfiles;
 241         /// maximal number of lastfiles
 242         unsigned int num_lastfiles;
 243         /// whether or not go to saved position when opening a file
 244         bool use_lastfilepos;
 245         /// load files from last session automatically
 246         bool load_session;
 247         /// shall a backup file be created
 248         bool make_backup;
 249         /// A directory for storing backup files
 250         std::string backupdir_path;
 251         /// Whether or not save/restore session information
 252         /// like windows position and geometry.
 253         bool allow_geometry_session;
 254         /// Zoom factor for screen fonts
 255         unsigned int zoom;
 256         /// Screen font sizes in points for each font size
 257         std::string font_sizes[10];
 258         /// Allow the use of scalable fonts? Default is yes.
 259         bool use_scalable_fonts;
 260         /// DPI of monitor
 261         unsigned int dpi;
 262         ///
 263         std::string fontenc;
 264         ///
 265         std::string roman_font_name;
 266         ///
 267         std::string sans_font_name;
 268         ///
 269         std::string typewriter_font_name;
 270         ///
 271         std::string roman_font_foundry;
 272         ///
 273         std::string sans_font_foundry;
 274         ///
 275         std::string typewriter_font_foundry;
 276         ///
 277         unsigned int autosave;
 278         ///
 279         std::string plaintext_roff_command;
 280         ///
 281         unsigned int plaintext_linelen;
 282         /// use library instead of process
 283         bool use_spell_lib;
 284         /// Ispell command
 285         std::string isp_command;
 286         /// Accept compound words in spellchecker?
 287         bool isp_accept_compound;
 288         /// Pass input encoding switch to ispell?
 289         bool isp_use_input_encoding;
 290         /// Use alternate language?
 291         bool isp_use_alt_lang;
 292         /// Use personal dictionary?
 293         bool isp_use_pers_dict;
 294         /// Use pixmap cache?
 295         bool use_pixmap_cache;
 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;
 304         ///
 305         bool use_kbmap;
 306         ///
 307         std::string primary_kbmap;
 308         ///
 309         std::string secondary_kbmap;
 310         ///
 311         std::string lyxpipes;
 312         ///
 313         std::string date_insert_format;
 314         ///
 315         std::string language_package;
 316         ///
 317         bool language_auto_begin;
 318         ///
 319         bool language_auto_end;
 320         ///
 321         std::string language_command_begin;
 322         ///
 323         std::string language_command_end;
 324         ///
 325         std::string language_command_local;
 326         ///
 327         bool language_global_options;
 328         ///
 329         bool language_use_babel;
 330         ///
 331         bool rtl_support;
 332         ///
 333         bool auto_number;
 334         ///
 335         bool mark_foreign_language;
 336         ///
 337         std::string default_language;
 338         ///
 339         bool cursor_follows_scrollbar;
 340         ///
 341         bool dialogs_iconify_with_main;
 342         ///
 343         int label_init_length;
 344         ///
 345         ///graphics::DisplayType
 346         int display_graphics;
 347         ///
 348         bool show_banner;
 349         ///
 350         enum PreviewStatus {
 351                 PREVIEW_OFF,
 352                 PREVIEW_NO_MATH,
 353                 PREVIEW_ON
 354         };
 355         ///
 356         PreviewStatus preview;
 357         ///
 358         bool preview_hashed_labels;
 359         ///
 360         std::string preview_scale_factor;
 361         /// user name
 362         std::string user_name;
 363         /// user email
 364         std::string user_email;
 365         /// True if the TeX engine cannot handle posix paths
 366         bool windows_style_tex_paths;
 367         /// True if the TeX engine can handle file names containing spaces
 368         bool tex_allows_spaces;
 369         /** Prepend paths to the PATH environment variable.
 370          *  The string is input, stored and output in native format.
 371          */
 372         std::string path_prefix;
 373         /// Use the cache for file converters?
 374         bool use_converter_cache;
 375         /// The maximum age of cache files in seconds
 376         unsigned int converter_cache_maxage;
 377         /// Sort layouts alphabetically
 378         bool sort_layouts;
 379 };
 380
 381
 382 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 383  *  It can be forward-declared and passed as a function argument without
 384  *  having to expose LyXRC.h.
 385  */
 386 class LyXRC_PreviewStatus {
 387         LyXRC::PreviewStatus val_;
 388 public:
 389         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 390         operator LyXRC::PreviewStatus() const { return val_; }
 391 };
 392
 393
 394 ///
 395 extern LyXRC lyxrc;
 396 ///
 397 extern LyXRC system_lyxrc;
 398
 399 } // namespace lyx
 400
 401 #endif