X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=743467a9a6931a527bfd081321aa2d5c4fb16478;hb=d45ca67d1d3e2d4fdc344cd2a1517725bc91723a;hp=bf3968ecb08aa8df15fa261ce99c045d2510fd0e;hpb=3ff14b8300376c531b7f94d4fd1f0730bea9a05e;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index bf3968ecb0..743467a9a6 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,31 +15,35 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "BiblioInfo.h" -#include "TextClass.h" +#include "Font.h" +#include "Citation.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" -#include "support/FileName.h" -#include "support/types.h" +#include #include namespace lyx { +namespace support { class FileName; } + class AuthorList; class BranchList; class Bullet; +class DocumentClass; class Encoding; -class Lexer; +class Language; class LatexFeatures; +class LayoutFile; +class LayoutFileIndex; +class Lexer; +class PDFOptions; class Spacing; class TexRow; class VSpace; -class Language; -class PDFOptions; /** Buffer parameters. * This class contains all the parameters for this buffer's use. Some @@ -49,25 +53,31 @@ class PDFOptions; class BufferParams { public: /// - enum PARSEP { + typedef std::vector LayoutModuleList; + /// + enum ParagraphSeparation { /// - PARSEP_INDENT, + ParagraphIndentSeparation, /// - PARSEP_SKIP + ParagraphSkipSeparation }; /// BufferParams(); - ~BufferParams(); /// get l10n translated to the buffers language - docstring const B_(std::string const & l10n) const; + docstring B_(std::string const & l10n) const; /// read a header token, if unrecognised, return it or an unknown class name - std::string const readToken(Lexer & lex, std::string const & token); + std::string readToken(Lexer & lex, + std::string const & token, ///< token to read. + support::FileName const & filepath); /// void writeFile(std::ostream &) const; + /// check what features are implied by the buffer parameters. + void validate(LaTeXFeatures &) const; + /** \returns true if the babel package is used (interogates * the BufferParams and a LyXRC variable). * This returned value can then be passed to the insets... @@ -76,60 +86,66 @@ public: /// void useClassDefaults(); - /// bool hasClassDefaults() const; /// VSpace const & getDefSkip() const; - /// void setDefSkip(VSpace const & vs); /** Whether paragraphs are separated by using a indent like in * articles or by using a little skip like in letters. */ - PARSEP paragraph_separation; + ParagraphSeparation paragraph_separation; /// - InsetQuotes::quote_language quotes_language; + InsetQuotes::QuoteLanguage quotes_language; /// - InsetQuotes::quote_times quotes_times; + InsetQuotes::QuoteTimes quotes_times; /// std::string fontsize; - ///Get the LyX TextClass (that is, the layout file) this document is using. - textclass_type getBaseClass() const; - ///Set the LyX TextClass (that is, the layout file) this document is using. - ///NOTE This also calls makeTextClass(), to update the local - ///TextClass. - bool setBaseClass(textclass_type); - ///Returns the TextClass currently in use: the BaseClass as modified - ///by modules. - TextClass const & getTextClass() const; - ///Returns a pointer to the TextClass currently in use: the BaseClass - ///as modified by modules. (See \file TextClass.h for the typedef.) - TextClassPtr getTextClassPtr() const; - ///Set the LyX TextClass---layout file---this document is using. - ///This does NOT call makeTextClass() and so should be used with - ///care. This is most likely not what you want if you are operating on - ///BufferParams that are actually associatd with a Buffer. If, on the - ///other hand, you are using a temporary set of BufferParams---say, in - ///a controller, it may well be, since in that case the local TextClass - ///has nothing to do. - void setJustBaseClass(textclass_type); + ///Get the LayoutFile this document is using. + LayoutFile const * baseClass() const; + /// + LayoutFileIndex const & baseClassID() const; + /// 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 + bool setBaseClass(std::string const & classname); + /// Adds the module information to the baseClass information to + /// create our local DocumentClass. + void makeDocumentClass(); + /// 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; /// 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 setTextClass(TextClassPtr); + void setDocumentClass(DocumentClass const * const); /// List of modules in use - std::vector const & getModules() const; + LayoutModuleList const & getModules() const { return layoutModules_; } + /// List of default modules the user has removed + std::set const & getRemovedModules() const + { return removedModules_; } + /// /// Add a module to the list of modules in use. /// Returns true if module was successfully added. - bool addLayoutModule(std::string modName, bool makeClass = true); - /// Add a list of modules. - /// Returns true if all modules were successfully added. - bool addLayoutModules(std::vectormodNames); + /// The makeClass variable signals whether to call makeDocumentClass. This + /// need not be done if we know this isn't the final time through, or if + /// the BufferParams do not represent the parameters for an actual buffer + /// (as in GuiDocument). + bool addLayoutModule(std::string const & modName); + /// + void addRemovedModule(std::string const & modName) + { removedModules_.insert(modName); } /// Clear the list - void clearLayoutModules(); + void clearLayoutModules() { layoutModules_.clear(); } + /// Clear the removed module list + void clearRemovedModules() { removedModules_.clear(); } /// returns the main font for the buffer (document) Font const getFont() const; @@ -159,6 +175,8 @@ public: std::string headsep; /// std::string footskip; + /// + std::string columnsep; /* some LaTeX options */ /// The graphics driver @@ -179,6 +197,8 @@ public: int fontsSansScale; /// the scale factor of the tt font int fontsTypewriterScale; + /// the font used by the CJK command + std::string fontsCJK; /// Spacing & spacing(); Spacing const & spacing() const; @@ -213,7 +233,13 @@ public: /// std::string preamble; /// + std::string local_layout; + /// std::string options; + /// use the class options defined in the layout? + bool use_default_options; + /// + std::string master; /// std::string float_placement; /// @@ -221,7 +247,7 @@ public: /// parameters for the listings package std::string listings_params; /// - TextClass::PageSides sides; + PageSides sides; /// std::string pagestyle; /// \param index should lie in the range 0 <= \c index <= 3. @@ -255,12 +281,8 @@ public: * for instance, they may differ for DVI and PDF generation) */ bool outputChanges; - /// Time ago we agreed that this was a buffer property [ale990407] - std::string parentname; /// bool compressed; - /// - bool embedded; /// the author list for the document AuthorList & authors(); @@ -270,10 +292,20 @@ public: std::vector author_map; /// std::string const dvips_options() const; + /** The return value of paperSizeName() depends on the + * purpose for which the paper size is needed, since they + * support different subsets of paper sizes. + */ + enum PapersizePurpose { + /// + DVIPS, + /// + DVIPDFM, + /// + XDVI + }; /// - std::string const paperSizeName() const; - /// set up if and how babel is called - std::string const babelCall(std::string const & lang_opts) const; + std::string paperSizeName(PapersizePurpose purpose) const; /// handle inputenc etc. void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features, TexRow & texrow) const; @@ -282,13 +314,11 @@ public: std::string const & sf, std::string const & tt, bool const & sc, bool const & osf, int const & sfscale, int const & ttscale) const; - /// path of the current buffer - std::string filepath; - /// get the appropriate cite engine (natbib handling) - biblio::CiteEngine getEngine() const; + /// get the appropriate cite engine (natbib handling) + CiteEngine citeEngine() const; /// - void setCiteEngine(biblio::CiteEngine const); + void setCiteEngine(CiteEngine const); /// options for pdf output PDFOptions & pdfoptions(); @@ -298,6 +328,8 @@ private: /// void readPreamble(Lexer &); /// + void readLocalLayout(Lexer &); + /// void readLanguage(Lexer &); /// void readGraphicsDriver(Lexer &); @@ -307,21 +339,18 @@ private: void readBulletsLaTeX(Lexer &); /// void readModules(Lexer &); - /// Adds the module information to the baseClass information to - /// create our local TextClass. - void makeTextClass(); + /// + void readRemovedModules(Lexer &); - /// for use with natbib - biblio::CiteEngine cite_engine_; - /// the base TextClass associated with the document - textclass_type baseClass_; - /// the possibly modular TextClass actually in use - TextClassPtr textClass_; + CiteEngine cite_engine_; /// - typedef std::vector LayoutModuleList; + DocumentClass * doc_class_; /// LayoutModuleList layoutModules_; + /// this is for modules that are required by the document class but that + /// the user has chosen not to use + std::set removedModules_; /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files.