src/lyxrc.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2001 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef LYXRC_H
  13 #define LYXRC_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "bufferparams.h" // Just to get the enum BufferParams::PAPER_SIZE (sic)
  20
  21 // #include <boost/utility.hpp>
  22
  23 /// This contains the runtime configuration of LyX
  24 class LyXRC //: public noncopyable {
  25 // after 1.1.6 I will use a LyXRCStruct here and then this can be made
  26 // noncopyable again.  For now I want to minimise changes.  ARRae 20001010
  27 {
  28 public:
  29 enum LyXRCTags {
  30         RC_FONT_ENCODING = 1,
  31         RC_PRINTER,
  32         RC_PRINT_COMMAND,
  33         RC_PRINTEVENPAGEFLAG,
  34         RC_PRINTODDPAGEFLAG,
  35         RC_PRINTPAGERANGEFLAG,
  36         RC_PRINTCOPIESFLAG,
  37         RC_PRINTCOLLCOPIESFLAG,
  38         RC_PRINTREVERSEFLAG,
  39         RC_PRINTLANDSCAPEFLAG,
  40         RC_PRINTTOPRINTER,
  41         RC_PRINT_ADAPTOUTPUT,
  42         RC_PRINTTOFILE,
  43         RC_PRINTFILEEXTENSION,
  44         RC_PRINTEXSTRAOPTIONS,
  45         RC_PRINTSPOOL_COMMAND,
  46         RC_PRINTSPOOL_PRINTERPREFIX,
  47         RC_PRINTPAPERFLAG,
  48         RC_PRINTPAPERDIMENSIONFLAG,
  49         RC_CUSTOM_EXPORT_COMMAND,
  50         RC_CUSTOM_EXPORT_FORMAT,
  51         RC_SCREEN_DPI,
  52         RC_SCREEN_ZOOM,
  53         RC_SCREEN_FONT_SIZES,
  54         RC_SCREEN_FONT_ROMAN,
  55         RC_SCREEN_FONT_SANS,
  56         RC_SCREEN_FONT_TYPEWRITER,
  57         RC_SCREEN_FONT_MENU,
  58         RC_SCREEN_FONT_POPUP,
  59         RC_SCREEN_FONT_ENCODING,
  60         RC_SCREEN_FONT_ENCODING_MENU,
  61         RC_SET_COLOR,
  62         RC_AUTOSAVE,
  63         RC_DOCUMENTPATH,
  64         RC_TEMPLATEPATH,
  65         RC_TEMPDIRPATH,
  66         RC_USETEMPDIR,
  67         RC_LASTFILES,
  68         RC_AUTOREGIONDELETE,
  69         RC_BIND,
  70         RC_OVERRIDE_X_DEADKEYS,
  71         RC_SERVERPIPE,
  72         RC_INPUT,
  73         RC_BINDFILE,
  74         RC_UIFILE,
  75         RC_KBMAP,
  76         RC_KBMAP_PRIMARY,
  77         RC_KBMAP_SECONDARY,
  78         RC_ASCIIROFF_COMMAND,
  79         RC_ASCII_LINELEN,
  80         RC_NUMLASTFILES,
  81         RC_CHECKLASTFILES,
  82         RC_VIEWDVI_PAPEROPTION,
  83         RC_DEFAULT_PAPERSIZE,
  84         RC_PS_COMMAND,
  85         RC_ACCEPT_COMPOUND,
  86         RC_SPELL_COMMAND,
  87         RC_USE_INP_ENC,
  88         RC_USE_ALT_LANG,
  89         RC_USE_PERS_DICT,
  90         RC_USE_ESC_CHARS,
  91         RC_SCREEN_FONT_SCALABLE,
  92         RC_ALT_LANG,
  93         RC_PERS_DICT,
  94         RC_ESC_CHARS,
  95         RC_CHKTEX_COMMAND,
  96         RC_CURSOR_FOLLOWS_SCROLLBAR,
  97         RC_EXIT_CONFIRMATION,
  98         RC_DISPLAY_SHORTCUTS,
  99         RC_MAKE_BACKUP,
 100         RC_BACKUPDIR_PATH,
 101         RC_RTL_SUPPORT,
 102         RC_AUTO_NUMBER,
 103         RC_MARK_FOREIGN_LANGUAGE,
 104         RC_LANGUAGE_PACKAGE,
 105         RC_LANGUAGE_AUTO_BEGIN,
 106         RC_LANGUAGE_AUTO_END,
 107         RC_LANGUAGE_COMMAND_BEGIN,
 108         RC_LANGUAGE_COMMAND_END,
 109         RC_LANGUAGE_COMMAND_LOCAL,
 110         RC_LANGUAGE_GLOBAL_OPTIONS,
 111         RC_LANGUAGE_USE_BABEL,
 112         RC_DATE_INSERT_FORMAT,
 113         RC_SHOW_BANNER,
 114         RC_WHEEL_JUMP,
 115         RC_CONVERTER,
 116         RC_VIEWER,
 117         RC_FORMAT,
 118         RC_NEW_ASK_FILENAME,
 119         RC_DEFAULT_LANGUAGE,
 120         RC_LABEL_INIT_LENGTH,
 121 #ifdef USE_PSPELL
 122         RC_USE_PSPELL,
 123 #endif
 124         RC_LAST
 125 };
 126
 127
 128         ///
 129         LyXRC();
 130         ///
 131         void setDefaults();
 132         ///
 133         int read (string const & filename);
 134         ///
 135         void readBindFileIfNeeded();
 136         ///
 137         void write(string const & filename) const;
 138         ///
 139         void print() const;
 140         ///
 141         void output(std::ostream & os) const;
 142         ///
 143         static string const getDescription(LyXRCTags);
 144         ///
 145         string bind_file;
 146         ///
 147         string ui_file;
 148         ///
 149         string printer;
 150         ///
 151         string print_command;
 152         ///
 153         string print_evenpage_flag;
 154         ///
 155         string print_oddpage_flag;
 156         ///
 157         string print_pagerange_flag;
 158         ///
 159         string print_copies_flag;
 160         ///
 161         string print_collcopies_flag;
 162         ///
 163         string print_reverse_flag;
 164         ///
 165         string print_landscape_flag;
 166         ///
 167         string print_to_printer;
 168         ///
 169         bool print_adapt_output;
 170         ///
 171         string print_to_file;
 172         ///
 173         string print_file_extension;
 174         ///
 175         string print_extra_options;
 176         ///
 177         string print_spool_command;
 178         ///
 179         string print_spool_printerprefix;
 180         ///
 181         string print_paper_flag;
 182         ///
 183         string print_paper_dimension_flag;
 184         ///
 185         string custom_export_command;
 186         ///
 187         string custom_export_format;
 188         ///
 189         bool pdf_mode;
 190         /// postscript interpreter (in general "gs", if it is installed)
 191         string ps_command;
 192         /// option for telling the dvi viewer about the paper size
 193         string view_dvi_paper_option;
 194         /// default paper size for local xdvi/dvips/ghostview/whatever
 195         BufferParams::PAPER_SIZE default_papersize;
 196         /// command to run chktex incl. options
 197         string chktex_command;
 198         ///
 199         string document_path;
 200         ///
 201         string template_path;
 202         ///
 203         string tempdir_path;
 204         ///
 205         bool use_tempdir;
 206         ///
 207         bool auto_region_delete;
 208         /// flag telling whether lastfiles should be checked for existance
 209         bool check_lastfiles;
 210         /// filename for lastfiles file
 211         string lastfiles;
 212         /// maximal number of lastfiles
 213         unsigned int num_lastfiles;
 214         /// shall a backup file be created
 215         bool make_backup;
 216         /// A directory for storing backup files
 217         string backupdir_path;
 218         /// Zoom factor for screen fonts
 219         unsigned int zoom;
 220         /// parameter for button_4 and button_5 (scrollwheel)
 221         unsigned int wheel_jump;
 222         /// Screen font sizes in points for each font size
 223         float font_sizes[10];
 224         /// Allow the use of scalable fonts? Default is yes.
 225         bool use_scalable_fonts;
 226         /// DPI of monitor
 227         float dpi;
 228         /// Whether lyx should handle deadkeys by itself
 229         bool override_x_deadkeys;
 230         ///
 231         string fontenc;
 232         ///
 233         string roman_font_name;
 234         ///
 235         string sans_font_name;
 236         ///
 237         string typewriter_font_name;
 238         ///
 239         string menu_font_name;
 240         ///
 241         string popup_font_name;
 242         ///
 243         string font_norm;
 244         ///
 245         enum FontEncoding {
 246                 ///
 247                 ISO_10646_1,
 248                 ///
 249                 ISO_8859_1,
 250                 ///
 251                 ISO_8859_6_8,
 252                 ///
 253                 ISO_8859_9,
 254                 ///
 255                 ISO_8859_15,
 256                 ///
 257                 OTHER_ENCODING
 258         };
 259         ///
 260         FontEncoding font_norm_type;
 261         ///
 262         void set_font_norm_type();
 263         ///
 264         string font_norm_menu;
 265         ///
 266         unsigned int autosave;
 267         ///
 268         string ascii_roff_command;
 269         ///
 270         unsigned int ascii_linelen;
 271         /// Ispell command
 272 #ifdef USE_PSPELL
 273         bool use_pspell;
 274 #endif
 275         string isp_command;
 276         /// Accept compound words in spellchecker?
 277         bool isp_accept_compound;
 278         /// Pass input encoding switch to ispell?
 279         bool isp_use_input_encoding;
 280         /// Use alternate language?
 281         bool isp_use_alt_lang;
 282         /// Use personal dictionary?
 283         bool isp_use_pers_dict;
 284         /// Use escape chars?
 285         bool isp_use_esc_chars;
 286         /// Alternate language for ispell
 287         string isp_alt_lang;
 288         /// Alternate personal dictionary file for ispell
 289         string isp_pers_dict;
 290         /// Escape characters
 291         string isp_esc_chars;
 292         ///
 293         bool use_kbmap;
 294         /// Ask for confirmation of exit when there are unsaved documents?
 295         bool exit_confirmation;
 296         /// Should we display short-cut information in the minibuffer?
 297         bool display_shortcuts;
 298         ///
 299         string primary_kbmap;
 300         ///
 301         string secondary_kbmap;
 302         ///
 303         string lyxpipes;
 304         ///
 305         string date_insert_format;
 306         ///
 307         string language_package;
 308         ///
 309         bool language_auto_begin;
 310         ///
 311         bool language_auto_end;
 312         ///
 313         string language_command_begin;
 314         ///
 315         string language_command_end;
 316         ///
 317         string language_command_local;
 318         ///
 319         bool language_global_options;
 320         ///
 321         bool language_use_babel;
 322         ///
 323         bool rtl_support;
 324         ///
 325         bool auto_number;
 326         ///
 327         bool mark_foreign_language;
 328         ///
 329         bool show_banner;
 330         /// Do we have to use a GUI?
 331         bool use_gui;
 332         ///
 333         bool new_ask_filename;
 334         ///
 335         string default_language;
 336         ///
 337         bool cursor_follows_scrollbar;
 338         ///
 339         int label_init_length;
 340 private:
 341         /// Is a bind file already (or currently) read?
 342         bool hasBindFile;
 343         ///
 344         int ReadBindFile(string const & name);
 345 };
 346
 347 ///
 348 extern LyXRC lyxrc;
 349 ///
 350 extern LyXRC system_lyxrc;
 351 #endif