X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=61c8612fae4b29b631833f0786d231da6ac87687;hb=3256dbc78a76f947080dc8e3414abc60e4b5c5af;hp=fda9403aaaaa0fc2e0d3ffb4a161b9602e97490e;hpb=fc6ce7cd08562fd7bab4427880b46390bb7d2f07;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index fda9403aaa..61c8612fae 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,35 +15,39 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "LyXTextClass.h" +#include "Font.h" +#include "BiblioInfo.h" #include "paper.h" +#include "TextClassPtr.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.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 a buffer uses. Some + * This class contains all the parameters for this buffer's use. Some * work needs to be done on this class to make it nice. Now everything * is in public. */ @@ -60,12 +64,20 @@ public: BufferParams(); ~BufferParams(); + /// get l10n translated to the buffers language + 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... @@ -84,7 +96,7 @@ public: /// void setDefSkip(VSpace const & vs); - /** Wether paragraphs are separated by using a indent like in + /** Whether paragraphs are separated by using a indent like in * articles or by using a little skip like in letters. */ PARSEP paragraph_separation; @@ -94,10 +106,36 @@ public: InsetQuotes::quote_times quotes_times; /// std::string fontsize; - /// - textclass_type textclass; - /// - LyXTextClass const & getLyXTextClass() const; + ///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 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 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(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; @@ -186,8 +224,10 @@ public: std::string float_placement; /// unsigned int columns; + /// parameters for the listings package + std::string listings_params; /// - LyXTextClass::PageSides sides; + PageSides sides; /// std::string pagestyle; /// \param index should lie in the range 0 <= \c index <= 3. @@ -196,16 +236,6 @@ public: /// \param index should lie in the range 0 <= \c index <= 3. Bullet & user_defined_bullet(size_type index); Bullet const & user_defined_bullet(size_type index) const; - /// - void readPreamble(Lexer &); - /// - void readLanguage(Lexer &); - /// - void readGraphicsDriver(Lexer &); - /// - void readBullets(Lexer &); - /// - void readBulletsLaTeX(Lexer &); /// Whether to load a package such as amsmath or esint. /// The enum values must not be changed (file format!) @@ -226,18 +256,15 @@ public: bool use_bibtopic; /// revision tracking for this buffer ? bool trackChanges; - /** This param decides whether change tracking marks should be output - * (using the dvipost package) or if the current "state" of the - * document should be output instead. Since dvipost needs dvi - * specials, it only works with dvi/ps output (the param will be - * ignored with other output flavors and disabled when dvipost is - * not installed). + /** 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) */ 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(); @@ -247,24 +274,66 @@ 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. + void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features, + TexRow & texrow) 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) 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 &); + /// + void readLanguage(Lexer &); + /// + void readGraphicsDriver(Lexer &); + /// + void readBullets(Lexer &); + /// + void readBulletsLaTeX(Lexer &); + /// + 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 + 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. */ @@ -276,8 +345,6 @@ private: }; support::copied_ptr pimpl_; - /// - biblio::CiteEngine cite_engine_; }; } // namespace lyx