X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=61c8612fae4b29b631833f0786d231da6ac87687;hb=3256dbc78a76f947080dc8e3414abc60e4b5c5af;hp=c24017483dc9ee40afc649728bbec7b786dc5f76;hpb=6904f34e48a7f5a5f7490b1d61c59f7fa6f89e84;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index c24017483d..61c8612fae 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -23,13 +23,16 @@ #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" -#include "support/FileName.h" #include "support/types.h" #include namespace lyx { +namespace support { +class FileName; +} + class AuthorList; class BranchList; class Bullet; @@ -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,24 +108,19 @@ 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. + /// 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); - ///Returns the TextClass currently in use: the BaseClass as modified - ///by modules. + /// 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 TextClassPtr.h for the typedef.) + /// 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; - ///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); /// 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(). @@ -126,10 +129,11 @@ public: 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 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(); @@ -257,8 +261,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 +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. @@ -284,8 +298,7 @@ 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; @@ -309,11 +322,7 @@ 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