X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=9e858275aeaadcf0e0121128f7ad2b930d9e4099;hb=0bd0fbf2e379f5470511028d7d58c07a59e7a2f3;hp=620b78e2a9aacf838dee6c243aef4607ed6a1222;hpb=d7a33bc841e75fb746778f937336bc347fb32d8a;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 620b78e2a9..9e858275ae 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,33 +15,36 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H +#include "Font.h" #include "BiblioInfo.h" -#include "TextClass.h" -#include "TextClass_ptr.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" -#include "support/FileName.h" -#include "support/types.h" - -#include "frontends/controllers/frontend_helpers.h" #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; /** Buffer parameters. * This class contains all the parameters for this buffer's use. Some @@ -65,11 +68,16 @@ public: docstring const 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 const readToken(Lexer & lex, + std::string const & token, ///< token to read. + support::FileName const & filepath); ///< where to look for local layout file. /// 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... @@ -98,38 +106,37 @@ public: InsetQuotes::quote_times 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_ptr.h for the typedef.) - TextClass_ptr getTextClass_ptr() 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 * 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(TextClass_ptr); + void setDocumentClass(DocumentClass const * const); /// List of modules in use std::vector const & getModules() const; /// 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); /// Clear the list void clearLayoutModules(); @@ -161,6 +168,8 @@ public: std::string headsep; /// std::string footskip; + /// + std::string columnsep; /* some LaTeX options */ /// The graphics driver @@ -223,7 +232,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. @@ -257,8 +266,6 @@ 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; /// @@ -272,8 +279,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 Papersize_Purpose { + /// + DVIPS, + /// + DVIPDFM, + /// + XDVI + }; /// - std::string const paperSizeName() const; + std::string const paperSizeName(Papersize_Purpose const & purpose) const; /// set up if and how babel is called std::string const babelCall(std::string const & lang_opts) const; /// handle inputenc etc. @@ -284,14 +303,17 @@ 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; /// void setCiteEngine(biblio::CiteEngine const); + /// options for pdf output + PDFOptions & pdfoptions(); + PDFOptions const & pdfoptions() const; + private: /// void readPreamble(Lexer &); @@ -305,17 +327,11 @@ private: void readBulletsLaTeX(Lexer &); /// void readModules(Lexer &); - /// Adds the module information to the baseClass information to - /// create our local TextClass. - void makeTextClass(); - /// 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 - TextClass_ptr textClass_; + /// + DocumentClass * doc_class_; /// typedef std::vector LayoutModuleList; ///