lyx_mirror/src/LyXRC.h

508 lines
12 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \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
#include "paper.h"
#include "support/strfwd.h"
#include <set>
#include <string>
#include <vector>
namespace lyx {
namespace support { class FileName; }
class Lexer;
/// This contains the runtime configuration of LyX
class LyXRC
{
public:
enum LyXRCTags {
RC_ACCEPT_COMPOUND = 1,
RC_ALT_LANG,
RC_AUTOCORRECTION_MATH,
RC_AUTOREGIONDELETE,
RC_AUTORESET_OPTIONS,
RC_AUTOSAVE,
RC_AUTO_NUMBER,
RC_BACKUPDIR_PATH,
RC_BIBTEX_ALTERNATIVES,
RC_BIBTEX_COMMAND,
RC_BINDFILE,
RC_CHECKLASTFILES,
RC_CHKTEX_COMMAND,
RC_COMPLETION_CURSOR_TEXT,
RC_COMPLETION_INLINE_DELAY,
RC_COMPLETION_INLINE_MATH,
RC_COMPLETION_INLINE_TEXT,
RC_COMPLETION_INLINE_DOTS,
RC_COMPLETION_POPUP_DELAY,
RC_COMPLETION_POPUP_MATH,
RC_COMPLETION_POPUP_TEXT,
RC_COMPLETION_POPUP_AFTER_COMPLETE,
RC_CONVERTER,
Add a cache for converted image files. This needs to be enabled in the preferences file with \use_converter_cache true. It is disabled by default, and no GUI support for changing the preferences is yet implemented. * src/insets/insetgraphics.C (InsetGraphics::prepareFile): Use image file cache * src/insets/ExternalSupport.C (updateExternal): Use image file cache * src/exporter.C (Exporter::Export): Do not use image file cache * src/graphics/GraphicsCacheItem.C (CacheItem::Impl::imageConverted): Add the converted file to the image file cache (CacheItem::Impl::convertToDisplayFo): Use image file cache * src/converter.C (Converters::convert): Use image file cache if the caller allowed that * src/converter.h (Converters::convert): Adjust arguments * src/Makefile.am: Add new files * src/support/lyxlib.h (chmod): new function (copy): add mode argument * src/support/copy.C (chmod): new function (copy): implement mode argument * src/support/mkdir.C (lyx::support::mkdir): Add warning if permissions are ignored * src/lyxrc.[Ch]: Add new settings \converter_cache_maxage and \use_converter_cache * src/ConverterCache.[Ch]: New image file cache * src/importer.C (Importer::Import): Do nut use the image file cache * src/lyx_main.C (LyX::init): Initialize the image file cache * src/mover.[Ch] (Mover::do_copy): Add mode argument (SpecialisedMover::do_copy): ditto * configure.ac: Check for chmod * development/cmake/ConfigureChecks.cmake: ditto * development/cmake/config.h.cmake: ditto * development/scons/SConstruct: ditto * development/scons/scons_manifest.py: Add new files git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@15897 a592a061-630c-0410-9148-cb99ea01b6c8
2006-11-13 10:27:57 +00:00
RC_CONVERTER_CACHE_MAXAGE,
RC_COPIER,
RC_CURSOR_FOLLOWS_SCROLLBAR,
RC_DATE_INSERT_FORMAT,
RC_DEFAULT_LANGUAGE,
RC_DEFAULT_VIEW_FORMAT,
RC_DEFAULT_PAPERSIZE,
RC_DEFFILE,
RC_DIALOGS_ICONIFY_WITH_MAIN,
RC_DISPLAY_GRAPHICS,
RC_DOCUMENTPATH,
RC_EDITOR_ALTERNATIVES,
RC_ESC_CHARS,
RC_EXAMPLEPATH,
RC_FONT_ENCODING,
RC_FORMAT,
RC_FULL_SCREEN_LIMIT,
RC_FULL_SCREEN_SCROLLBAR,
RC_FULL_SCREEN_TABBAR,
RC_FULL_SCREEN_MENUBAR,
RC_FULL_SCREEN_TOOLBARS,
RC_FULL_SCREEN_WIDTH,
RC_GEOMETRY_SESSION,
RC_GROUP_LAYOUTS,
RC_GUI_LANGUAGE,
RC_HUNSPELLDIR_PATH,
RC_INDEX_ALTERNATIVES,
RC_INDEX_COMMAND,
RC_INPUT,
RC_JBIBTEX_COMMAND,
RC_JINDEX_COMMAND,
RC_KBMAP,
RC_KBMAP_PRIMARY,
RC_KBMAP_SECONDARY,
RC_LABEL_INIT_LENGTH,
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_PACKAGE,
RC_LANGUAGE_USE_BABEL,
RC_LOADSESSION,
RC_MACRO_EDIT_STYLE,
RC_MAC_LIKE_WORD_MOVEMENT,
RC_MAKE_BACKUP,
RC_MARK_FOREIGN_LANGUAGE,
RC_MOUSE_WHEEL_SPEED,
RC_NOMENCL_COMMAND,
RC_NUMLASTFILES,
RC_OPEN_BUFFERS_IN_TABS,
RC_PARAGRAPH_MARKERS,
RC_PATH_PREFIX,
RC_PERS_DICT,
RC_PLAINTEXT_LINELEN,
RC_PLAINTEXT_ROFF_COMMAND,
RC_PREVIEW,
RC_PREVIEW_HASHED_LABELS,
RC_PREVIEW_SCALE_FACTOR,
RC_PRINTCOLLCOPIESFLAG,
RC_PRINTCOPIESFLAG,
RC_PRINTER,
RC_PRINTEVENPAGEFLAG,
RC_PRINTEXSTRAOPTIONS,
RC_PRINTFILEEXTENSION,
RC_PRINTLANDSCAPEFLAG,
RC_PRINTODDPAGEFLAG,
RC_PRINTPAGERANGEFLAG,
RC_PRINTPAPERDIMENSIONFLAG,
RC_PRINTPAPERFLAG,
RC_PRINTREVERSEFLAG,
RC_PRINTSPOOL_COMMAND,
RC_PRINTSPOOL_PRINTERPREFIX,
RC_PRINTTOFILE,
RC_PRINTTOPRINTER,
RC_PRINT_ADAPTOUTPUT,
RC_PRINT_COMMAND,
RC_RTL_SUPPORT,
RC_SCREEN_DPI,
RC_SCREEN_FONT_ROMAN,
RC_SCREEN_FONT_ROMAN_FOUNDRY,
RC_SCREEN_FONT_SANS,
RC_SCREEN_FONT_SANS_FOUNDRY,
RC_SCREEN_FONT_SCALABLE,
RC_SCREEN_FONT_SIZES,
RC_SCREEN_FONT_TYPEWRITER,
RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
RC_SCREEN_ZOOM,
RC_SCROLL_BELOW_DOCUMENT,
RC_SERVERPIPE,
RC_SET_COLOR,
RC_SHOW_BANNER,
RC_SORT_LAYOUTS,
RC_SPELL_COMMAND,
RC_SPELLCHECK_CONTINUOUSLY,
RC_SPELLCHECKER,
RC_SPLITINDEX_COMMAND,
RC_TEMPDIRPATH,
RC_TEMPLATEPATH,
RC_TEX_ALLOWS_SPACES,
Renaming: cygwin_path_fix -> windows_style_tex_paths cygwin_path_fix_needed -> tex_expects_windows_paths check_cygwin_path -> check_windows_style_tex_paths use_cygwin_paths -> use_windows_paths RC_CYGWIN_PATH_FIX -> RC_TEX_EXPECTS_WINDOWS_PATHS * src/frontends/qt4/ui/QPrefCygwinPathUi.ui * src/frontends/qt3/ui/QPrefCygwinPathModule.ui Updated checkbutton label and description * src/frontends/qt4/QPrefsDialog.C (PrefCygwinPath): cygwin_path_fix -> windows_style_tex_paths (QPrefsDialog): Enable checkbutton for native WIN32 builds * src/frontends/xforms/forms/form_preferences.fd Updated label and name of checkbutton * src/frontends/xforms/FormPreferences.C (apply): cygwin_path_fix -> windows_style_tex_paths check_cygwin_path -> check_windows_style_tex_paths (build): Enable checkbutton for native WIN32 builds (update): Ditto (feedback): Updated description * src/frontends/qt3/QPrefs.C * src/frontends/qt3/QPrefsDialog.C * src/frontends/qt3/QPrefsDialog.h Renaming as above, enabled checkbutton for native WIN32 builds * src/support/os_unix.C * src/support/os.h * src/support/os_win32.C Renaming cygwin_path_fix -> windows_style_tex_paths * src/support/os_cygwin.C Ditto (external_path, external_path_list): always return windows style paths, not depending on the checkbutton status * src/lyxrc.C * src/lyxrc.h * src/lyxfunc.C * src/lyx_main.C Renaming * lib/configure.py Renaming, more meaningful diagnostics git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@14242 a592a061-630c-0410-9148-cb99ea01b6c8
2006-06-27 10:51:24 +00:00
RC_TEX_EXPECTS_WINDOWS_PATHS,
RC_THESAURUSDIRPATH,
RC_UIFILE,
RC_USELASTFILEPOS,
RC_USER_EMAIL,
RC_USER_NAME,
RC_USETEMPDIR,
RC_USE_ALT_LANG,
Add a cache for converted image files. This needs to be enabled in the preferences file with \use_converter_cache true. It is disabled by default, and no GUI support for changing the preferences is yet implemented. * src/insets/insetgraphics.C (InsetGraphics::prepareFile): Use image file cache * src/insets/ExternalSupport.C (updateExternal): Use image file cache * src/exporter.C (Exporter::Export): Do not use image file cache * src/graphics/GraphicsCacheItem.C (CacheItem::Impl::imageConverted): Add the converted file to the image file cache (CacheItem::Impl::convertToDisplayFo): Use image file cache * src/converter.C (Converters::convert): Use image file cache if the caller allowed that * src/converter.h (Converters::convert): Adjust arguments * src/Makefile.am: Add new files * src/support/lyxlib.h (chmod): new function (copy): add mode argument * src/support/copy.C (chmod): new function (copy): implement mode argument * src/support/mkdir.C (lyx::support::mkdir): Add warning if permissions are ignored * src/lyxrc.[Ch]: Add new settings \converter_cache_maxage and \use_converter_cache * src/ConverterCache.[Ch]: New image file cache * src/importer.C (Importer::Import): Do nut use the image file cache * src/lyx_main.C (LyX::init): Initialize the image file cache * src/mover.[Ch] (Mover::do_copy): Add mode argument (SpecialisedMover::do_copy): ditto * configure.ac: Check for chmod * development/cmake/ConfigureChecks.cmake: ditto * development/cmake/config.h.cmake: ditto * development/scons/SConstruct: ditto * development/scons/scons_manifest.py: Add new files git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@15897 a592a061-630c-0410-9148-cb99ea01b6c8
2006-11-13 10:27:57 +00:00
RC_USE_CONVERTER_CACHE,
RC_USE_ESC_CHARS,
RC_USE_INP_ENC,
RC_USE_PERS_DICT,
RC_USE_TOOLTIP,
RC_USE_PIXMAP_CACHE,
RC_USE_SPELL_LIB,
RC_VIEWDVI_PAPEROPTION,
RC_VIEWER,
RC_VIEWER_ALTERNATIVES,
RC_VISUAL_CURSOR,
RC_LAST
};
///
LyXRC();
///
void setDefaults();
///
int read(support::FileName const & filename);
///
int read(std::istream &);
private:
///
int read(Lexer &);
public:
///
void write(support::FileName const & filename,
bool ignore_system_lyxrc) const;
/// write rc. If a specific tag is given, only output that one.
void write(std::ostream & os,
bool ignore_system_lyxrc,
std::string const & tag = std::string()) const;
///
void print() const;
// FIXME unused (was used for xforms. Do we still need this?)
//static docstring const getDescription(LyXRCTags);
///
std::string bind_file;
///
std::string def_file;
///
std::string ui_file;
///
std::string printer;
///
std::string print_command;
///
std::string print_evenpage_flag;
///
std::string print_oddpage_flag;
///
std::string print_pagerange_flag;
///
std::string print_copies_flag;
///
std::string print_collcopies_flag;
///
std::string print_reverse_flag;
///
std::string print_landscape_flag;
///
std::string print_to_printer;
///
bool print_adapt_output;
///
std::string print_to_file;
///
std::string print_file_extension;
///
std::string print_extra_options;
///
std::string print_spool_command;
///
std::string print_spool_printerprefix;
///
std::string print_paper_flag;
///
std::string print_paper_dimension_flag;
/// option for telling the dvi viewer about the paper size
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
std::string chktex_command;
/// all available commands to run bibtex incl. options
std::set<std::string> bibtex_alternatives;
/// command to run bibtex incl. options
std::string bibtex_command;
/// command to run japanese bibtex incl. options
std::string jbibtex_command;
/// all available index commands incl. options
std::set<std::string> index_alternatives;
/// command to run makeindex incl. options or other index programs
std::string index_command;
/// command to run japanese index program incl. options
std::string jindex_command;
/// command to generate multiple indices
std::string splitindex_command;
/// command to run makeindex incl. options for nomencl
std::string nomencl_command;
///
std::string document_path;
///
std::string example_path;
///
std::string template_path;
///
std::string tempdir_path;
///
std::string thesaurusdir_path;
///
std::string hunspelldir_path;
///
bool auto_region_delete;
/// flag telling whether lastfiles should be checked for existance
bool auto_reset_options;
///
bool check_lastfiles;
/// maximal number of lastfiles
unsigned int num_lastfiles;
/// whether or not go to saved position when opening a file
bool use_lastfilepos;
/// load files from last session automatically
bool load_session;
/// shall a backup file be created
bool make_backup;
/// A directory for storing backup files
std::string backupdir_path;
/// Whether or not save/restore session information
/// like windows position and geometry.
bool allow_geometry_session;
/// Scrolling speed of the mouse wheel
double mouse_wheel_speed;
/// Zoom factor for screen fonts
unsigned int zoom;
/// Screen font sizes in points for each font size
std::string font_sizes[10];
/// Allow the use of scalable fonts? Default is yes.
bool use_scalable_fonts;
/// DPI of monitor
unsigned int dpi;
///
std::string fontenc;
///
std::string roman_font_name;
///
std::string sans_font_name;
///
std::string typewriter_font_name;
///
std::string roman_font_foundry;
///
std::string sans_font_foundry;
///
std::string typewriter_font_foundry;
///
unsigned int autosave;
///
unsigned int plaintext_linelen;
/// Accept compound words in spellchecker?
bool spellchecker_accept_compound;
/// End of paragraph markers?
bool paragraph_markers;
/// Use tooltips?
bool use_tooltip;
/// Use pixmap cache?
bool use_pixmap_cache;
/// Spellchecker engine: aspell, hunspell, etc
std::string spellchecker;
/// Alternate language for spellchecker
std::string spellchecker_alt_lang;
/// Escape characters
std::string spellchecker_esc_chars;
/// spellcheck continuously?
bool spellcheck_continuously;
///
bool use_kbmap;
///
std::string primary_kbmap;
///
std::string secondary_kbmap;
///
std::string lyxpipes;
///
std::string date_insert_format;
///
std::string language_package;
///
bool language_auto_begin;
///
bool language_auto_end;
///
std::string language_command_begin;
///
std::string language_command_end;
///
std::string language_command_local;
///
bool language_global_options;
///
bool language_use_babel;
///
bool rtl_support;
/// bidi cursor movement: true = visual, false = logical
bool visual_cursor;
///
bool auto_number;
///
bool mark_foreign_language;
///
std::string default_language;
///
std::string gui_language;
///
std::string default_view_format;
/// all available viewers
std::vector<std::pair<std::string, std::string> > viewer_alternatives;
/// all available editors
std::vector<std::pair<std::string, std::string> > editor_alternatives;
///
bool mac_like_word_movement;
///
bool cursor_follows_scrollbar;
///
bool scroll_below_document;
///
enum MacroEditStyle {
MACRO_EDIT_INLINE_BOX = 0,
MACRO_EDIT_INLINE,
MACRO_EDIT_LIST
};
///
MacroEditStyle macro_edit_style;
///
bool dialogs_iconify_with_main;
///
int label_init_length;
///
bool display_graphics;
///
bool show_banner;
///
enum PreviewStatus {
PREVIEW_OFF,
PREVIEW_NO_MATH,
PREVIEW_ON
};
///
PreviewStatus preview;
///
bool preview_hashed_labels;
///
double preview_scale_factor;
/// user name
std::string user_name;
/// user email
std::string user_email;
Renaming: cygwin_path_fix -> windows_style_tex_paths cygwin_path_fix_needed -> tex_expects_windows_paths check_cygwin_path -> check_windows_style_tex_paths use_cygwin_paths -> use_windows_paths RC_CYGWIN_PATH_FIX -> RC_TEX_EXPECTS_WINDOWS_PATHS * src/frontends/qt4/ui/QPrefCygwinPathUi.ui * src/frontends/qt3/ui/QPrefCygwinPathModule.ui Updated checkbutton label and description * src/frontends/qt4/QPrefsDialog.C (PrefCygwinPath): cygwin_path_fix -> windows_style_tex_paths (QPrefsDialog): Enable checkbutton for native WIN32 builds * src/frontends/xforms/forms/form_preferences.fd Updated label and name of checkbutton * src/frontends/xforms/FormPreferences.C (apply): cygwin_path_fix -> windows_style_tex_paths check_cygwin_path -> check_windows_style_tex_paths (build): Enable checkbutton for native WIN32 builds (update): Ditto (feedback): Updated description * src/frontends/qt3/QPrefs.C * src/frontends/qt3/QPrefsDialog.C * src/frontends/qt3/QPrefsDialog.h Renaming as above, enabled checkbutton for native WIN32 builds * src/support/os_unix.C * src/support/os.h * src/support/os_win32.C Renaming cygwin_path_fix -> windows_style_tex_paths * src/support/os_cygwin.C Ditto (external_path, external_path_list): always return windows style paths, not depending on the checkbutton status * src/lyxrc.C * src/lyxrc.h * src/lyxfunc.C * src/lyx_main.C Renaming * lib/configure.py Renaming, more meaningful diagnostics git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@14242 a592a061-630c-0410-9148-cb99ea01b6c8
2006-06-27 10:51:24 +00:00
/// True if the TeX engine cannot handle posix paths
bool windows_style_tex_paths;
/// True if the TeX engine can handle file names containing spaces
bool tex_allows_spaces;
/** Prepend paths to the PATH environment variable.
* The string is input, stored and output in native format.
*/
std::string path_prefix;
Add a cache for converted image files. This needs to be enabled in the preferences file with \use_converter_cache true. It is disabled by default, and no GUI support for changing the preferences is yet implemented. * src/insets/insetgraphics.C (InsetGraphics::prepareFile): Use image file cache * src/insets/ExternalSupport.C (updateExternal): Use image file cache * src/exporter.C (Exporter::Export): Do not use image file cache * src/graphics/GraphicsCacheItem.C (CacheItem::Impl::imageConverted): Add the converted file to the image file cache (CacheItem::Impl::convertToDisplayFo): Use image file cache * src/converter.C (Converters::convert): Use image file cache if the caller allowed that * src/converter.h (Converters::convert): Adjust arguments * src/Makefile.am: Add new files * src/support/lyxlib.h (chmod): new function (copy): add mode argument * src/support/copy.C (chmod): new function (copy): implement mode argument * src/support/mkdir.C (lyx::support::mkdir): Add warning if permissions are ignored * src/lyxrc.[Ch]: Add new settings \converter_cache_maxage and \use_converter_cache * src/ConverterCache.[Ch]: New image file cache * src/importer.C (Importer::Import): Do nut use the image file cache * src/lyx_main.C (LyX::init): Initialize the image file cache * src/mover.[Ch] (Mover::do_copy): Add mode argument (SpecialisedMover::do_copy): ditto * configure.ac: Check for chmod * development/cmake/ConfigureChecks.cmake: ditto * development/cmake/config.h.cmake: ditto * development/scons/SConstruct: ditto * development/scons/scons_manifest.py: Add new files git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@15897 a592a061-630c-0410-9148-cb99ea01b6c8
2006-11-13 10:27:57 +00:00
/// Use the cache for file converters?
bool use_converter_cache;
/// The maximum age of cache files in seconds
unsigned int converter_cache_maxage;
/// Sort layouts alphabetically
bool sort_layouts;
/// Group layout by their category
bool group_layouts;
/// Toggle toolbars in fullscreen mode?
bool full_screen_toolbars;
/// Toggle scrollbar in fullscreen mode?
bool full_screen_scrollbar;
/// Toggle tabbar in fullscreen mode?
bool full_screen_tabbar;
/// Toggle menubar in fullscreen mode?
bool full_screen_menubar;
/// Limit the text width?
bool full_screen_limit;
/// Width of limited screen (in pixels) in fullscreen mode
int full_screen_width;
///
bool completion_cursor_text;
///
double completion_inline_delay;
///
bool completion_inline_math;
///
bool completion_inline_text;
///
int completion_inline_dots;
///
bool autocorrection_math;
///
double completion_popup_delay;
///
bool completion_popup_math;
///
bool completion_popup_text;
///
bool completion_popup_after_complete;
///
bool open_buffers_in_tabs;
};
/** \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_; }
};
void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
///
extern LyXRC lyxrc;
///
extern LyXRC system_lyxrc;
// used by at least frontends/qt4/GuiPref.cpp
const long maxlastfiles = 20;
} // namespace lyx
#endif