X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=7314b421b2bc1d9340cbf9944738d4a645497fd7;hb=57b69a5efddf9f3c148007322f00dad6c253a2ed;hp=d551955db85c8d5226abc7e1199867386cab8567;hpb=e3f65fd0883c7706aa08fb72e128e7c32fba11b5;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index d551955db8..7314b421b2 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,7 +15,9 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H +#include "Author.h" #include "Citation.h" +#include "DocumentClassPtr.h" #include "Format.h" #include "LayoutModuleList.h" #include "OutputParams.h" @@ -32,7 +34,6 @@ namespace lyx { namespace support { class FileName; } -class AuthorList; class BranchList; class Bullet; class DocumentClass; @@ -41,13 +42,11 @@ class Font; class HSpace; class IndicesList; class Language; -class LatexFeatures; class LayoutFile; class LayoutFileIndex; class Lexer; class PDFOptions; class Spacing; -class TexRow; class VSpace; /** Buffer parameters. @@ -76,12 +75,12 @@ public: support::FileName const & filepath); /// - void writeFile(std::ostream &) const; + void writeFile(std::ostream &, Buffer const *) const; /// check what features are implied by the buffer parameters. void validate(LaTeXFeatures &) const; - /** \returns true if the babel package is used (interogates + /** \returns true if the babel package is used (interrogates * the BufferParams, a LyXRC variable, and the document class). * This returned value can then be passed to the insets... */ @@ -109,8 +108,6 @@ public: /// InsetQuotes::QuoteLanguage quotes_language; /// - InsetQuotes::QuoteTimes quotes_times; - /// std::string fontsize; /// Get the LayoutFile this document is using. LayoutFile const * baseClass() const; @@ -119,21 +116,25 @@ public: /// Set the LyX layout file this document is using. /// NOTE: This does not call makeDocumentClass() to update the local /// DocumentClass. That needs to be done manually. - /// \param filename the name of the layout file + /// \param classname: the name of the layout file bool setBaseClass(std::string const & classname); /// Adds the module information to the baseClass information to /// create our local DocumentClass. - void makeDocumentClass(); + /// NOTE: This should NEVER be called externally unless one immediately goes + /// on to class BufferView::updateDocumentClass(). The exception, of course, + /// is in GuiDocument, where we use a BufferParams simply to hold a copy of + /// the parameters from the active Buffer. + void makeDocumentClass(bool const clone = false); /// Returns the DocumentClass currently in use: the BaseClass as modified /// by modules. DocumentClass const & documentClass() const; /// \return A pointer to the DocumentClass currently in use: the BaseClass /// as modified by modules. - DocumentClass const * documentClassPtr() const; + DocumentClassConstPtr documentClassPtr() const; /// This bypasses the baseClass and sets the textClass directly. /// Should be called with care and would be better not being here, /// but it seems to be needed by CutAndPaste::putClipboard(). - void setDocumentClass(DocumentClass const * const); + void setDocumentClass(DocumentClassConstPtr); /// List of modules in use LayoutModuleList const & getModules() const { return layout_modules_; } /// List of default modules the user has removed @@ -141,13 +142,15 @@ public: { return removed_modules_; } /// /// Add a module to the list of modules in use. This checks only that the - /// module is not already in the list, so use moduleIsCompatible first if - /// you want to check for compatibility. + /// module is not already in the list, so use layoutModuleCanBeAdeed first + /// if you want to check for compatibility. /// \return true if module was successfully added. bool addLayoutModule(std::string const & modName); /// checks to make sure module's requriements are satisfied, that it does /// not conflict with already-present modules, isn't already loaded, etc. - bool moduleCanBeAdded(std::string const & modName) const; + bool layoutModuleCanBeAdded(std::string const & modName) const; + /// same, but for citaton modules. + bool citationModuleCanBeAdded(std::string const & modName) const; /// void addRemovedModule(std::string const & modName) { removed_modules_.push_back(modName); } @@ -155,6 +158,10 @@ public: void clearLayoutModules() { layout_modules_.clear(); } /// Clear the removed module list void clearRemovedModules() { removed_modules_.clear(); } + /// Get the local layouts + std::string getLocalLayout(bool) const; + /// Set the local layouts + void setLocalLayout(std::string const &, bool); /// returns \c true if the buffer contains a LaTeX document bool isLatex() const; @@ -169,14 +176,15 @@ public: std::string getDefaultOutputFormat() const; /// return the output flavor of \p format or the default OutputParams::FLAVOR getOutputFlavor( - std::string const format = std::string()) const; + std::string const & format = std::string()) const; /// bool isExportable(std::string const & format) const; /// std::vector exportableFormats(bool only_viewable) const; /// bool isExportableFormat(std::string const & format) const; - /// + /// the backends appropriate for use with this document. + /// so, e.g., latex is excluded , if we're using non-TeX fonts std::vector backends() const; /// List of included children (for includeonly) @@ -194,6 +202,9 @@ public: /// returns the main font for the buffer (document) Font const getFont() const; + /// translate quote style string to enum value + InsetQuotes::QuoteLanguage getQuoteStyle(std::string const & qs) const; + /* these are for the PaperLayout */ /// the papersize PAPER_SIZE papersize; @@ -231,14 +242,24 @@ public: std::string bibtex_command; /// customized index processor std::string index_command; - /// font encoding + /// font encoding(s) requested for this document std::string fontenc; + /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts + std::string fonts_roman[2]; /// the rm font - std::string fonts_roman; + std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; } + /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts + std::string fonts_sans[2]; /// the sf font - std::string fonts_sans; + std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; } + /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts + std::string fonts_typewriter[2]; /// the tt font - std::string fonts_typewriter; + std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; } + /// the math font: [0] for TeX fonts, [1] for non-TeX fonts + std::string fonts_math[2]; + /// the math font + std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; } /// the default family (rm, sf, tt) std::string fonts_default_family; /// use the fonts of the OS (OpenType, True Type) directly @@ -247,12 +268,18 @@ public: bool fonts_expert_sc; /// use Old Style Figures bool fonts_old_figures; + /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts + int fonts_sans_scale[2]; /// the scale factor of the sf font - int fonts_sans_scale; + int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; } + /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts + int fonts_typewriter_scale[2]; /// the scale factor of the tt font - int fonts_typewriter_scale; + int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; } /// the font used by the CJK command std::string fonts_cjk; + /// use LaTeX microtype package + bool use_microtype; /// Spacing & spacing(); Spacing const & spacing() const; @@ -271,10 +298,10 @@ public: IndicesList & indiceslist(); IndicesList const & indiceslist() const; /** - * The input encoding for LaTeX. This can be one of + * The LyX name of the input encoding for LaTeX. This can be one of * - \c auto: find out the input encoding from the used languages * - \c default: ditto - * - any encoding supported by the inputenc package + * - any encoding defined in the file lib/encodings * The encoding of the LyX file is always utf8 and has nothing to * do with this setting. * The difference between \c auto and \c default is that \c auto also @@ -288,11 +315,13 @@ public: std::string inputenc; /// The main encoding used by this buffer for LaTeX output. /// Individual pieces of text can use different encodings. + /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime) + /// instead of the value returned by this function. Encoding const & encoding() const; /// - std::string preamble; + std::string origin; /// - std::string local_layout; + std::string preamble; /// std::string options; /// use the class options defined in the layout? @@ -348,30 +377,39 @@ public: /// Set whether to load a package such as amsmath or esint. void use_package(std::string const & p, Package u); /// All packages that can be switched on or off - static std::vector const & auto_packages(); + static std::map const & auto_packages(); /// Split bibliography? bool use_bibtopic; /// Split the index? bool use_indices; - /// revision tracking for this buffer ? - bool trackChanges; + /// Save trensient properties? + bool save_transient_properties; + /// revision tracking for this buffer ? (this is a transient property) + bool track_changes; /** This param decides whether change tracking marks should be used * in output (irrespective of how these marks are actually defined; * for instance, they may differ for DVI and PDF generation) + * This is a transient property. */ - bool outputChanges; + bool output_changes; /// bool compressed; /// the author list for the document AuthorList & authors(); AuthorList const & authors() const; + void addAuthor(Author a); /// map of the file's author IDs to AuthorList indexes typedef std::map AuthorMap; - AuthorMap author_map; - /// the buffer's font encoding + AuthorMap author_map_; + + /// the buffer's active font encoding std::string const font_encoding() const; + /// all font encodings requested by the prefs/document/main language. + /// This does NOT include font encodings required by secondary languages + std::vector const font_encodings() const; + /// std::string const dvips_options() const; /** The return value of paperSizeName() depends on the @@ -397,27 +435,39 @@ public: /// std::string const parseFontName(std::string const & name) const; /// set up the document fonts - std::string const loadFonts(std::string const & rm, - std::string const & sf, std::string const & tt, - bool const & sc, bool const & osf, - int const & sfscale, int const & ttscale, - bool const & use_nonlatexfonts, - LaTeXFeatures & features) const; - - /// get the appropriate cite engine (natbib handling) - CiteEngine citeEngine() const; - /// - void setCiteEngine(CiteEngine const); + std::string const loadFonts(LaTeXFeatures & features) const; + /// the cite engine modules + LayoutModuleList const & citeEngine() const + { return cite_engine_; } /// the type of cite engine (authoryear or numerical) CiteEngineType const & citeEngineType() const { return cite_engine_type_; } + /// add the module to the cite engine modules + bool addCiteEngine(std::string const &); + /// add the modules to the cite engine modules + bool addCiteEngine(std::vector const &); + /// clear the list of cite engine modules + void clearCiteEngine() { cite_engine_.clear(); } + /// set the cite engine module + void setCiteEngine(std::string const &); + /// set the cite engine modules + void setCiteEngine(std::vector const &); /// set the cite engine type void setCiteEngineType(CiteEngineType const & engine_type) { cite_engine_type_ = engine_type; } + /// the available citation commands + std::vector citeCommands() const; + /// the available citation styles + std::vector citeStyles() const; + /// the default BibTeX style file for the document std::string biblio_style; + /// the default BibTeX style file from the TextClass + std::string const & defaultBiblioStyle() const; + /// whether the BibTeX style supports full author lists + bool const & fullAuthorList() const; /// options for pdf output PDFOptions & pdfoptions(); @@ -438,6 +488,8 @@ public: /// double html_math_img_scale; /// + double display_pixel_ratio; + /// std::string html_latex_start; /// std::string html_latex_end; @@ -458,7 +510,7 @@ private: /// void readPreamble(Lexer &); /// - void readLocalLayout(Lexer &); + void readLocalLayout(Lexer &, bool); /// void readLanguage(Lexer &); /// @@ -477,24 +529,28 @@ private: typedef std::map DefaultFlavorCache; /// mutable DefaultFlavorCache default_flavors_; - /// for use with natbib - CiteEngine cite_engine_; + /// the cite engine modules + LayoutModuleList cite_engine_; /// the type of cite engine (authoryear or numerical) CiteEngineType cite_engine_type_; /// - DocumentClass * doc_class_; + DocumentClassPtr doc_class_; /// LayoutModuleList layout_modules_; /// this is for modules that are required by the document class but that /// the user has chosen not to use std::list removed_modules_; + /// The local layouts without the forced ones + std::string local_layout_; + /// Forced local layouts only for reading (use getLocalLayout() instead) + std::string forced_local_layout_; /// the list of included children (for includeonly) std::list included_children_; typedef std::map PackageMap; /** Whether and how to load packages like amsmath, esint, mhchem, - * mathdots and undertilde. + * mathdots, stackrel, stmaryrd and undertilde. */ PackageMap use_packages;