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 #include "graphics/GraphicsTypes.h"
  23
  24 #include <iosfwd>
  25 #include <string>
  26
  27 class LyXLex;
  28
  29 /// This contains the runtime configuration of LyX
  30 class LyXRC //: public noncopyable {
  31 // after 1.1.6 I will use a LyXRCStruct here and then this can be made
  32 // noncopyable again.  For now I want to minimise changes.  ARRae 20001010
  33 {
  34 public:
  35 enum LyXRCTags {
  36         RC_FONT_ENCODING = 1,
  37         RC_PRINTER,
  38         RC_PRINT_COMMAND,
  39         RC_PRINTEVENPAGEFLAG,
  40         RC_PRINTODDPAGEFLAG,
  41         RC_PRINTPAGERANGEFLAG,
  42         RC_PRINTCOPIESFLAG,
  43         RC_PRINTCOLLCOPIESFLAG,
  44         RC_PRINTREVERSEFLAG,
  45         RC_PRINTLANDSCAPEFLAG,
  46         RC_PRINTTOPRINTER,
  47         RC_PRINT_ADAPTOUTPUT,
  48         RC_PRINTTOFILE,
  49         RC_PRINTFILEEXTENSION,
  50         RC_PRINTEXSTRAOPTIONS,
  51         RC_PRINTSPOOL_COMMAND,
  52         RC_PRINTSPOOL_PRINTERPREFIX,
  53         RC_PRINTPAPERFLAG,
  54         RC_PRINTPAPERDIMENSIONFLAG,
  55         RC_CUSTOM_EXPORT_COMMAND,
  56         RC_CUSTOM_EXPORT_FORMAT,
  57         RC_SCREEN_DPI,
  58         RC_SCREEN_ZOOM,
  59         RC_SCREEN_FONT_SIZES,
  60         RC_SCREEN_FONT_ROMAN,
  61         RC_SCREEN_FONT_SANS,
  62         RC_SCREEN_FONT_TYPEWRITER,
  63         RC_SCREEN_FONT_ROMAN_FOUNDRY,
  64         RC_SCREEN_FONT_SANS_FOUNDRY,
  65         RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
  66         RC_SCREEN_FONT_ENCODING,
  67         RC_POPUP_BOLD_FONT,
  68         RC_POPUP_NORMAL_FONT,
  69         RC_POPUP_FONT_ENCODING,
  70         RC_SET_COLOR,
  71         RC_AUTOSAVE,
  72         RC_DOCUMENTPATH,
  73         RC_TEMPLATEPATH,
  74         RC_TEMPDIRPATH,
  75         RC_USETEMPDIR,
  76         RC_LASTFILES,
  77         RC_AUTOREGIONDELETE,
  78         RC_AUTORESET_OPTIONS,
  79         RC_SERVERPIPE,
  80         RC_INPUT,
  81         RC_BINDFILE,
  82         RC_UIFILE,
  83         RC_KBMAP,
  84         RC_KBMAP_PRIMARY,
  85         RC_KBMAP_SECONDARY,
  86         RC_ASCIIROFF_COMMAND,
  87         RC_ASCII_LINELEN,
  88         RC_NUMLASTFILES,
  89         RC_CHECKLASTFILES,
  90         RC_VIEWDVI_PAPEROPTION,
  91         RC_DEFAULT_PAPERSIZE,
  92         RC_ACCEPT_COMPOUND,
  93         RC_SPELL_COMMAND,
  94         RC_USE_INP_ENC,
  95         RC_USE_ALT_LANG,
  96         RC_USE_PERS_DICT,
  97         RC_USE_ESC_CHARS,
  98         RC_SCREEN_FONT_SCALABLE,
  99         RC_ALT_LANG,
 100         RC_PERS_DICT,
 101         RC_ESC_CHARS,
 102         RC_CHKTEX_COMMAND,
 103         RC_BIBTEX_COMMAND,
 104         RC_CURSOR_FOLLOWS_SCROLLBAR,
 105         RC_DIALOGS_ICONIFY_WITH_MAIN,
 106         RC_MAKE_BACKUP,
 107         RC_BACKUPDIR_PATH,
 108         RC_RTL_SUPPORT,
 109         RC_AUTO_NUMBER,
 110         RC_MARK_FOREIGN_LANGUAGE,
 111         RC_LANGUAGE_PACKAGE,
 112         RC_LANGUAGE_AUTO_BEGIN,
 113         RC_LANGUAGE_AUTO_END,
 114         RC_LANGUAGE_COMMAND_BEGIN,
 115         RC_LANGUAGE_COMMAND_END,
 116         RC_LANGUAGE_COMMAND_LOCAL,
 117         RC_LANGUAGE_GLOBAL_OPTIONS,
 118         RC_LANGUAGE_USE_BABEL,
 119         RC_DATE_INSERT_FORMAT,
 120         RC_SHOW_BANNER,
 121         RC_WHEEL_JUMP,
 122         RC_CONVERTER,
 123         RC_COPIER,
 124         RC_VIEWER,
 125         RC_FORMAT,
 126         RC_DEFAULT_LANGUAGE,
 127         RC_LABEL_INIT_LENGTH,
 128         RC_DISPLAY_GRAPHICS,
 129         RC_PREVIEW,
 130         RC_PREVIEW_HASHED_LABELS,
 131         RC_PREVIEW_SCALE_FACTOR,
 132         RC_USE_SPELL_LIB,
 133         RC_USER_NAME,
 134         RC_USER_EMAIL,
 135         RC_INDEX_COMMAND,
 136         RC_LAST
 137 };
 138
 139
 140         ///
 141         LyXRC();
 142         ///
 143         void setDefaults();
 144         ///
 145         int read(std::string const & filename);
 146         ///
 147         int read(std::istream &);
 148 private:
 149         ///
 150         int read(LyXLex &);
 151 public:
 152         ///
 153         void write(std::string const & filename,
 154                    bool ignore_system_lyxrc) const;
 155         ///
 156         void write(std::ostream & os,
 157                    bool ignore_system_lyxrc) const;
 158         ///
 159         void print() const;
 160         ///
 161         static std::string const getDescription(LyXRCTags);
 162         ///
 163         std::string bind_file;
 164         ///
 165         std::string ui_file;
 166         ///
 167         std::string printer;
 168         ///
 169         std::string print_command;
 170         ///
 171         std::string print_evenpage_flag;
 172         ///
 173         std::string print_oddpage_flag;
 174         ///
 175         std::string print_pagerange_flag;
 176         ///
 177         std::string print_copies_flag;
 178         ///
 179         std::string print_collcopies_flag;
 180         ///
 181         std::string print_reverse_flag;
 182         ///
 183         std::string print_landscape_flag;
 184         ///
 185         std::string print_to_printer;
 186         ///
 187         bool print_adapt_output;
 188         ///
 189         std::string print_to_file;
 190         ///
 191         std::string print_file_extension;
 192         ///
 193         std::string print_extra_options;
 194         ///
 195         std::string print_spool_command;
 196         ///
 197         std::string print_spool_printerprefix;
 198         ///
 199         std::string print_paper_flag;
 200         ///
 201         std::string print_paper_dimension_flag;
 202         ///
 203         std::string custom_export_command;
 204         ///
 205         std::string custom_export_format;
 206         /// option for telling the dvi viewer about the paper size
 207         std::string view_dvi_paper_option;
 208         /// default paper size for local xdvi/dvips/ghostview/whatever
 209         PAPER_SIZE default_papersize;
 210         /// command to run chktex incl. options
 211         std::string chktex_command;
 212         /// command to run bibtex incl. options
 213         std::string bibtex_command;
 214         /// command to run makeindex incl. options or other index programs
 215         std::string index_command;
 216         ///
 217         std::string document_path;
 218         ///
 219         std::string template_path;
 220         ///
 221         std::string tempdir_path;
 222         ///
 223         bool auto_region_delete;
 224         /// flag telling whether lastfiles should be checked for existance
 225         bool auto_reset_options;
 226         ///
 227         bool check_lastfiles;
 228         /// filename for lastfiles file
 229         std::string lastfiles;
 230         /// maximal number of lastfiles
 231         unsigned int num_lastfiles;
 232         /// shall a backup file be created
 233         bool make_backup;
 234         /// A directory for storing backup files
 235         std::string backupdir_path;
 236         /// Zoom factor for screen fonts
 237         unsigned int zoom;
 238         /// parameter for button_4 and button_5 (scrollwheel)
 239         unsigned int wheel_jump;
 240         /// Screen font sizes in points for each font size
 241         float font_sizes[10];
 242         /// Allow the use of scalable fonts? Default is yes.
 243         bool use_scalable_fonts;
 244         /// DPI of monitor
 245         float dpi;
 246         ///
 247         std::string fontenc;
 248         ///
 249         std::string roman_font_name;
 250         ///
 251         std::string sans_font_name;
 252         ///
 253         std::string typewriter_font_name;
 254         ///
 255         std::string roman_font_foundry;
 256         ///
 257         std::string sans_font_foundry;
 258         ///
 259         std::string typewriter_font_foundry;
 260         ///
 261         std::string popup_bold_font;
 262         ///
 263         std::string popup_normal_font;
 264         ///
 265         std::string font_norm;
 266         ///
 267         enum FontEncoding {
 268                 ///
 269                 ISO_10646_1,
 270                 ///
 271                 ISO_8859_1,
 272                 ///
 273                 ISO_8859_3,
 274                 ///
 275                 ISO_8859_4,
 276                 ///
 277                 ISO_8859_6_8,
 278                 ///
 279                 ISO_8859_9,
 280                 ///
 281                 ISO_8859_15,
 282                 ///
 283                 OTHER_ENCODING
 284         };
 285         ///
 286         FontEncoding font_norm_type;
 287         ///
 288         void set_font_norm_type();
 289         ///
 290         std::string popup_font_encoding;
 291         ///
 292         unsigned int autosave;
 293         ///
 294         std::string ascii_roff_command;
 295         ///
 296         unsigned int ascii_linelen;
 297         /// use library instead of process
 298         bool use_spell_lib;
 299         /// Ispell command
 300         std::string isp_command;
 301         /// Accept compound words in spellchecker?
 302         bool isp_accept_compound;
 303         /// Pass input encoding switch to ispell?
 304         bool isp_use_input_encoding;
 305         /// Use alternate language?
 306         bool isp_use_alt_lang;
 307         /// Use personal dictionary?
 308         bool isp_use_pers_dict;
 309         /// Use escape chars?
 310         bool isp_use_esc_chars;
 311         /// Alternate language for ispell
 312         std::string isp_alt_lang;
 313         /// Alternate personal dictionary file for ispell
 314         std::string isp_pers_dict;
 315         /// Escape characters
 316         std::string isp_esc_chars;
 317         ///
 318         bool use_kbmap;
 319         ///
 320         std::string primary_kbmap;
 321         ///
 322         std::string secondary_kbmap;
 323         ///
 324         std::string lyxpipes;
 325         ///
 326         std::string date_insert_format;
 327         ///
 328         std::string language_package;
 329         ///
 330         bool language_auto_begin;
 331         ///
 332         bool language_auto_end;
 333         ///
 334         std::string language_command_begin;
 335         ///
 336         std::string language_command_end;
 337         ///
 338         std::string language_command_local;
 339         ///
 340         bool language_global_options;
 341         ///
 342         bool language_use_babel;
 343         ///
 344         bool rtl_support;
 345         ///
 346         bool auto_number;
 347         ///
 348         bool mark_foreign_language;
 349         ///
 350         std::string default_language;
 351         ///
 352         bool cursor_follows_scrollbar;
 353         ///
 354         bool dialogs_iconify_with_main;
 355         ///
 356         int label_init_length;
 357         ///
 358         lyx::graphics::DisplayType display_graphics;
 359         ///
 360         bool show_banner;
 361         ///
 362         enum PreviewStatus {
 363                 PREVIEW_OFF,
 364                 PREVIEW_NO_MATH,
 365                 PREVIEW_ON
 366         };
 367         ///
 368         PreviewStatus preview;
 369         ///
 370         bool preview_hashed_labels;
 371         ///
 372         float preview_scale_factor;
 373         /// user name
 374         std::string user_name;
 375         /// user email
 376         std::string user_email;
 377 };
 378
 379
 380 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
 381  *  It can be forward-declared and passed as a function argument without
 382  *  having to expose lyxrc.h.
 383  */
 384 class LyXRC_PreviewStatus {
 385         LyXRC::PreviewStatus val_;
 386 public:
 387         LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
 388         operator LyXRC::PreviewStatus() const{ return val_; }
 389 };
 390
 391
 392 ///
 393 extern LyXRC lyxrc;
 394 ///
 395 extern LyXRC system_lyxrc;
 396 #endif