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