X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=61c8612fae4b29b631833f0786d231da6ac87687;hb=3256dbc78a76f947080dc8e3414abc60e4b5c5af;hp=56fd7249038d13adcdad25bd92838844ac41368d;hpb=6e93e77f229fbda5c6af6c04325c5cd157e15957;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 56fd724903..61c8612fae 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 "TextClassPtr.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 Encoding; +class Language; class Lexer; class LatexFeatures; +class PDFOptions; class Spacing; +class TextClass; 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... @@ -100,28 +108,34 @@ public: 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. - void setBaseClass(textclass_type); - ///Returns the TextClass currently in use: the BaseClass as modified - ///by modules. + /// Set the LyX TextClass (that is, the layout file) this document is using. + /// NOTE: This does not call makeTextClass() to update the local TextClass. + /// That needs to be done manually. + bool setBaseClass(textclass_type); + /// Adds the module information to the baseClass information to + /// create our local TextClass. + void makeTextClass(); + /// 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); + /// Returns a pointer to the TextClass currently in use: the BaseClass + /// as modified by modules. (See \file TextClassPtr.h for the typedef.) + TextClassPtr getTextClassPtr() 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 setTextClass(TextClassPtr); + /// 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. + /// The makeClass variable signals whether to call makeTextClass. 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(); /// returns the main font for the buffer (document) Font const getFont() const; @@ -213,7 +227,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. @@ -247,10 +261,10 @@ 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(); @@ -260,8 +274,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. @@ -272,14 +298,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 &); @@ -291,16 +320,19 @@ private: void readBullets(Lexer &); /// void readBulletsLaTeX(Lexer &); - /// create our local TextClass. - void makeTextClass(); + /// + void readModules(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 - TextClass_ptr textClass_; + TextClassPtr textClass_; + /// + typedef std::vector LayoutModuleList; + /// + LayoutModuleList layoutModules_; /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files.