X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxrc.h;h=e948e6489fcf8ec6ae1b56988da30fe1b677f23b;hb=1fa0fb5c67656cacbe3cfe6e8b08dd98cada1f73;hp=9cab1ff5e0fe04c484f5b8a5a960e445256aa257;hpb=014ebb2efe7082ce0c269198c9dfe8da43296baa;p=lyx.git diff --git a/src/lyxrc.h b/src/lyxrc.h index 9cab1ff5e0..e948e6489f 100644 --- a/src/lyxrc.h +++ b/src/lyxrc.h @@ -1,147 +1,238 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2000 The LyX Team. +/** + * \file lyxrc.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * ====================================================== */ + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author Angus Leeming + * \author John Levon + * \author André Pönitz + * \author Allan Rae + * \author Dekel Tsur + * + * Full author contact details are available in file CREDITS. + */ #ifndef LYXRC_H #define LYXRC_H -#ifdef __GNUG__ -#pragma interface -#endif - -#include +#include "paper.h" +#include "graphics/GraphicsTypes.h" -#include "ToolbarDefaults.h" -#include "bufferparams.h" +#include +#include -using std::map; +class LyXLex; /// This contains the runtime configuration of LyX -class LyXRC { +class LyXRC //: public noncopyable { +// after 1.1.6 I will use a LyXRCStruct here and then this can be made +// noncopyable again. For now I want to minimise changes. ARRae 20001010 +{ public: +enum LyXRCTags { + RC_FONT_ENCODING = 1, + RC_PRINTER, + RC_PRINT_COMMAND, + RC_PRINTEVENPAGEFLAG, + RC_PRINTODDPAGEFLAG, + RC_PRINTPAGERANGEFLAG, + RC_PRINTCOPIESFLAG, + RC_PRINTCOLLCOPIESFLAG, + RC_PRINTREVERSEFLAG, + RC_PRINTLANDSCAPEFLAG, + RC_PRINTTOPRINTER, + RC_PRINT_ADAPTOUTPUT, + RC_PRINTTOFILE, + RC_PRINTFILEEXTENSION, + RC_PRINTEXSTRAOPTIONS, + RC_PRINTSPOOL_COMMAND, + RC_PRINTSPOOL_PRINTERPREFIX, + RC_PRINTPAPERFLAG, + RC_PRINTPAPERDIMENSIONFLAG, + RC_CUSTOM_EXPORT_COMMAND, + RC_CUSTOM_EXPORT_FORMAT, + RC_SCREEN_DPI, + RC_SCREEN_ZOOM, + RC_SCREEN_FONT_SIZES, + RC_SCREEN_FONT_ROMAN, + RC_SCREEN_FONT_SANS, + RC_SCREEN_FONT_TYPEWRITER, + RC_SCREEN_FONT_ROMAN_FOUNDRY, + RC_SCREEN_FONT_SANS_FOUNDRY, + RC_SCREEN_FONT_TYPEWRITER_FOUNDRY, + RC_SCREEN_FONT_ENCODING, + RC_POPUP_BOLD_FONT, + RC_POPUP_NORMAL_FONT, + RC_POPUP_FONT_ENCODING, + RC_SET_COLOR, + RC_AUTOSAVE, + RC_DOCUMENTPATH, + RC_TEMPLATEPATH, + RC_TEMPDIRPATH, + RC_USETEMPDIR, + RC_LASTFILES, + RC_AUTOREGIONDELETE, + RC_AUTORESET_OPTIONS, + RC_SERVERPIPE, + RC_INPUT, + RC_BINDFILE, + RC_UIFILE, + RC_KBMAP, + RC_KBMAP_PRIMARY, + RC_KBMAP_SECONDARY, + RC_ASCIIROFF_COMMAND, + RC_ASCII_LINELEN, + RC_NUMLASTFILES, + RC_CHECKLASTFILES, + RC_VIEWDVI_PAPEROPTION, + RC_DEFAULT_PAPERSIZE, + RC_ACCEPT_COMPOUND, + RC_SPELL_COMMAND, + RC_USE_INP_ENC, + RC_USE_ALT_LANG, + RC_USE_PERS_DICT, + RC_USE_ESC_CHARS, + RC_SCREEN_FONT_SCALABLE, + RC_ALT_LANG, + RC_PERS_DICT, + RC_ESC_CHARS, + RC_CHKTEX_COMMAND, + RC_BIBTEX_COMMAND, + RC_CURSOR_FOLLOWS_SCROLLBAR, + RC_DIALOGS_ICONIFY_WITH_MAIN, + RC_MAKE_BACKUP, + RC_BACKUPDIR_PATH, + RC_RTL_SUPPORT, + RC_AUTO_NUMBER, + RC_MARK_FOREIGN_LANGUAGE, + RC_LANGUAGE_PACKAGE, + RC_LANGUAGE_AUTO_BEGIN, + RC_LANGUAGE_AUTO_END, + RC_LANGUAGE_COMMAND_BEGIN, + RC_LANGUAGE_COMMAND_END, + RC_LANGUAGE_COMMAND_LOCAL, + RC_LANGUAGE_GLOBAL_OPTIONS, + RC_LANGUAGE_USE_BABEL, + RC_DATE_INSERT_FORMAT, + RC_SHOW_BANNER, + RC_WHEEL_JUMP, + RC_CONVERTER, + RC_VIEWER, + RC_FORMAT, + RC_DEFAULT_LANGUAGE, + RC_LABEL_INIT_LENGTH, + RC_DISPLAY_GRAPHICS, + RC_PREVIEW, + RC_PREVIEW_HASHED_LABELS, + RC_PREVIEW_SCALE_FACTOR, + RC_USE_SPELL_LIB, + RC_USER_NAME, + RC_USER_EMAIL, + RC_LAST +}; + + + /// LyXRC(); /// void setDefaults(); /// - int read (string const & filename); + int read(std::string const & filename); /// - void write(string const & filename) const; + int read(std::istream &); +private: /// - void print() const; + int read(LyXLex &); +public: /// - void output(ostream & os) const; - /// Is a bind file already (or currently) read? - bool hasBindFile; + void write(std::string const & filename, + bool ignore_system_lyxrc) const; /// - int ReadBindFile(string const & name = "cua"); + void write(std::ostream & os, + bool ignore_system_lyxrc) const; /// - ToolbarDefaults toolbardefaults; + void print() const; /// - string printer; + static std::string const getDescription(LyXRCTags); /// - string print_command; + std::string bind_file; /// - string print_evenpage_flag; + std::string ui_file; /// - string print_oddpage_flag; + std::string printer; /// - string print_pagerange_flag; + std::string print_command; /// - string print_copies_flag; + std::string print_evenpage_flag; /// - string print_collcopies_flag; + std::string print_oddpage_flag; /// - string print_reverse_flag; + std::string print_pagerange_flag; /// - string print_landscape_flag; + std::string print_copies_flag; /// - string print_to_printer; + std::string print_collcopies_flag; /// - bool print_adapt_output; + std::string print_reverse_flag; /// - string print_to_file; + std::string print_landscape_flag; /// - string print_file_extension; + std::string print_to_printer; /// - string print_extra_options; + bool print_adapt_output; /// - string print_spool_command; - /// - string print_spool_printerprefix; + std::string print_to_file; /// - string print_paper_flag; + std::string print_file_extension; /// - string print_paper_dimension_flag; + std::string print_extra_options; /// - string custom_export_command; + std::string print_spool_command; /// - string custom_export_format; + std::string print_spool_printerprefix; /// - bool pdf_mode; - /// program for running latex - string latex_command; + std::string print_paper_flag; /// - string pdflatex_command; + std::string print_paper_dimension_flag; /// - string pdf_to_ps_command; + std::string custom_export_command; /// - string dvi_to_ps_command; - /// program for performing literate programming - string literate_command; - string literate_extension; - string literate_error_filter; - /// program for compiling - string build_command; - string build_error_filter; - /// program for running relyx - string relyx_command; - /// postscript interpreter (in general "gs", if it is installed) - string ps_command; - /// program for viewing postscript output (default "ghostview -swap") - string view_ps_command; - /// program for viewing postscript pictures (default "ghostview") - string view_pspic_command; - /// program for viewing dvi output (default "xdvi") - string view_dvi_command; + std::string custom_export_format; /// option for telling the dvi viewer about the paper size - string view_dvi_paper_option; - /// program for viewing pdf output (default "xpdf") - string view_pdf_command; - /// default paper size for local xdvi/dvips/ghostview/whatever - BufferParams::PAPER_SIZE default_papersize; + std::string view_dvi_paper_option; + /// default paper size for local xdvi/dvips/ghostview/whatever + PAPER_SIZE default_papersize; /// command to run chktex incl. options - string chktex_command; - /// command to run an html converter incl. options - string html_command; - /// - string sgml_extra_options; + std::string chktex_command; + /// command to run bibtex incl. options + std::string bibtex_command; /// - string document_path; + std::string document_path; /// - string template_path; + std::string template_path; /// - string tempdir_path; - /// - bool use_tempdir; + std::string tempdir_path; /// bool auto_region_delete; /// flag telling whether lastfiles should be checked for existance + bool auto_reset_options; + /// bool check_lastfiles; /// filename for lastfiles file - string lastfiles; + std::string lastfiles; /// maximal number of lastfiles unsigned int num_lastfiles; /// shall a backup file be created bool make_backup; + /// A directory for storing backup files + std::string backupdir_path; /// Zoom factor for screen fonts unsigned int zoom; + /// parameter for button_4 and button_5 (scrollwheel) + unsigned int wheel_jump; /// Screen font sizes in points for each font size float font_sizes[10]; /// Allow the use of scalable fonts? Default is yes. @@ -149,35 +240,60 @@ public: /// DPI of monitor float dpi; /// - string fontenc; + std::string fontenc; /// - string roman_font_name; + std::string roman_font_name; /// - string sans_font_name; + std::string sans_font_name; /// - string typewriter_font_name; + std::string typewriter_font_name; /// - string menu_font_name; + std::string roman_font_foundry; /// - string popup_font_name; + std::string sans_font_foundry; /// - string font_norm; + std::string typewriter_font_foundry; /// - string font_norm_menu; + std::string popup_bold_font; /// - unsigned int autosave; + std::string popup_normal_font; + /// + std::string font_norm; + /// + enum FontEncoding { + /// + ISO_10646_1, + /// + ISO_8859_1, + /// + ISO_8859_3, + /// + ISO_8859_4, + /// + ISO_8859_6_8, + /// + ISO_8859_9, + /// + ISO_8859_15, + /// + OTHER_ENCODING + }; + /// + FontEncoding font_norm_type; /// - string fax_command; + void set_font_norm_type(); /// - string phone_book; + std::string popup_font_encoding; /// - string fax_program; + unsigned int autosave; /// - string ascii_roff_command; + std::string ascii_roff_command; /// unsigned int ascii_linelen; + /// use library instead of process + bool use_spell_lib; /// Ispell command - string isp_command; + std::string isp_command; /// Accept compound words in spellchecker? bool isp_accept_compound; /// Pass input encoding switch to ispell? @@ -189,50 +305,88 @@ public: /// Use escape chars? bool isp_use_esc_chars; /// Alternate language for ispell - string isp_alt_lang; + std::string isp_alt_lang; /// Alternate personal dictionary file for ispell - string isp_pers_dict; + std::string isp_pers_dict; /// Escape characters - string isp_esc_chars; + std::string isp_esc_chars; /// bool use_kbmap; - /// Ask for confirmation of exit when there are unsaved documents? - bool exit_confirmation; - /// Should we display short-cut information in the minibuffer? - bool display_shortcuts; /// - string primary_kbmap; + std::string primary_kbmap; /// - string secondary_kbmap; + std::string secondary_kbmap; /// - string lyxpipes; + std::string lyxpipes; /// - string date_insert_format; + std::string date_insert_format; /// - string language_package; + std::string language_package; /// bool language_auto_begin; /// bool language_auto_end; /// - string language_command_begin; + std::string language_command_begin; + /// + std::string language_command_end; + /// + std::string language_command_local; /// - string language_command_end; + bool language_global_options; + /// + bool language_use_babel; /// bool rtl_support; /// - string auto_mathmode; + bool auto_number; + /// + bool mark_foreign_language; + /// + std::string default_language; + /// + bool cursor_follows_scrollbar; + /// + bool dialogs_iconify_with_main; + /// + int label_init_length; + /// + lyx::graphics::DisplayType display_graphics; /// bool show_banner; /// - typedef map Bindings; + enum PreviewStatus { + PREVIEW_OFF, + PREVIEW_NO_MATH, + PREVIEW_ON + }; /// - Bindings bindings; -private: + PreviewStatus preview; + /// + bool preview_hashed_labels; /// - void defaultKeyBindings(); + float preview_scale_factor; + /// user name + std::string user_name; + /// user email + std::string user_email; }; -extern LyXRC lyxrc; +/** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus. + * It can be forward-declared and passed as a function argument without + * having to expose lyxrc.h. + */ +class LyXRC_PreviewStatus { + LyXRC::PreviewStatus val_; +public: + LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {} + operator LyXRC::PreviewStatus() const{ return val_; } +}; + + +/// +extern LyXRC lyxrc; +/// +extern LyXRC system_lyxrc; #endif