X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=1e8174d12c33f02d9adc1cf48095b807e3f0d40c;hb=e45427de389bc188f02ebe0de2c052740dcde09c;hp=9b9136ff0e4c99bd43901734464514dbfc68fe14;hpb=bd997f2cb97cab2f2d358db07449be4850fa70a4;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 9b9136ff0e..1e8174d12c 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -4,10 +4,10 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author John Levon - * \author André Pönitz + * \author André Pönitz * * Full author contact details are available in file CREDITS. */ @@ -15,97 +15,160 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "TextClass.h" +#include "Citation.h" +#include "LayoutModuleList.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" -#include "support/types.h" - -#include "frontends/controllers/frontend_helpers.h" - -#include +#include namespace lyx { +namespace support { class FileName; } + class AuthorList; class BranchList; class Bullet; +class DocumentClass; class Encoding; -class Lexer; +class Font; +class HSpace; +class IndicesList; +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 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. */ class BufferParams { public: /// - enum PARSEP { + 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... */ - bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const; + bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &, + support::FileName const &) const; /// void useClassDefaults(); - /// bool hasClassDefaults() const; + /// + HSpace const & getIndentation() const; + /// + void setIndentation(HSpace const & indent); /// VSpace const & getDefSkip() const; - /// 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; + ParagraphSeparation paragraph_separation; /// - InsetQuotes::quote_language quotes_language; + InsetQuotes::QuoteLanguage quotes_language; /// - InsetQuotes::quote_times quotes_times; + InsetQuotes::QuoteTimes quotes_times; /// std::string fontsize; - /// - textclass_type textclass; - /// - TextClass const & getTextClass() const; + ///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 setDocumentClass(DocumentClass const * const); + /// List of modules in use + LayoutModuleList const & getModules() const { return layoutModules_; } + /// List of default modules the user has removed + std::list const & getRemovedModules() const + { return removedModules_; } + /// + /// Add a module to the list of modules in use. This checks only that the + /// module is not already in the list, so use moduleIsCompatible first if + /// you want to check for compatibility. + /// \return true if module was successfully added. + bool addLayoutModule(std::string const & modName); + /// checks to make sure module's requriements are satisfied, that it does + /// not conflict with already-present modules, isn't already loaded, etc. + bool moduleCanBeAdded(std::string const & modName) const; + /// + void addRemovedModule(std::string const & modName) + { removedModules_.push_back(modName); } + /// Clear the list + void clearLayoutModules() { layoutModules_.clear(); } + /// Clear the removed module list + void clearRemovedModules() { removedModules_.clear(); } + + /// List of included children (for includeonly) + std::list const & getIncludedChildren() const + { return includedChildren_; } + /// + void addIncludedChildren(std::string const & child) + { includedChildren_.push_back(child); } + /// Clear the list of included children + void clearIncludedChildren() { includedChildren_.clear(); } + + /// update aux files of unincluded children (with \includeonly) + bool maintain_unincluded_children; /// returns the main font for the buffer (document) Font const getFont() const; - /* this are for the PaperLayout */ + /* these are for the PaperLayout */ /// the papersize PAPER_SIZE papersize; /// @@ -130,10 +193,20 @@ public: std::string headsep; /// std::string footskip; + /// + std::string columnsep; /* some LaTeX options */ /// The graphics driver std::string graphicsDriver; + /// The default output format + std::string defaultOutputFormat; + /// customized bibliography processor + std::string bibtex_command; + /// customized index processor + std::string index_command; + /// font encoding + std::string fontenc; /// the rm font std::string fontsRoman; /// the sf font @@ -142,6 +215,8 @@ public: std::string fontsTypewriter; /// the default family (rm, sf, tt) std::string fontsDefaultFamily; + /// use the XeTeX processor + bool useXetex; /// use expert Small Caps bool fontsSC; /// use Old Style Figures @@ -150,6 +225,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; @@ -162,6 +239,9 @@ public: /// BranchList: BranchList & branchlist(); BranchList const & branchlist() const; + /// IndicesList: + IndicesList & indiceslist(); + IndicesList const & indiceslist() const; /** * The input encoding for LaTeX. This can be one of * - \c auto: find out the input encoding from the used languages @@ -184,7 +264,15 @@ 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; + /// + bool suppress_date; /// std::string float_placement; /// @@ -192,25 +280,27 @@ public: /// parameters for the listings package std::string listings_params; /// - TextClass::PageSides sides; + PageSides sides; /// std::string pagestyle; + /// + RGBColor backgroundcolor; + /// + bool isbackgroundcolor; + /// + RGBColor fontcolor; + /// + bool isfontcolor; + /// + RGBColor notefontcolor; + /// + RGBColor boxbgcolor; /// \param index should lie in the range 0 <= \c index <= 3. Bullet & temp_bullet(size_type index); Bullet const & temp_bullet(size_type index) const; /// \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!) @@ -227,8 +317,12 @@ public: Package use_amsmath; /// Whether and how to load esint Package use_esint; - /// + /// Whether and how to load mhchem + Package use_mhchem; + /// Split bibliography? bool use_bibtopic; + /// Split the index? + bool use_indices; /// revision tracking for this buffer ? bool trackChanges; /** This param decides whether change tracking marks should be used @@ -236,8 +330,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; @@ -245,31 +337,95 @@ public: AuthorList & authors(); AuthorList const & authors() const; - /// map of the file's author IDs to buffer author IDs - std::vector author_map; + /// map of the file's author IDs to AuthorList indexes + std::map author_map; + /// the buffer's font encoding + std::string const font_encoding() const; /// 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; + std::string paperSizeName(PapersizePurpose purpose) const; /// set up if and how babel is called - std::string const babelCall(std::string const & lang_opts) const; + std::string babelCall(std::string const & lang_opts) const; + /// return supported drivers for specific packages + docstring getGraphicsDriver(std::string const & package) const; /// handle inputenc etc. void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features, TexRow & texrow) const; + /// + std::string const parseFontName(std::string const & name) 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; + int const & sfscale, int const & ttscale, + bool const & xetex) 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(); + PDFOptions const & pdfoptions() const; + + enum MathOutput { + MathML, + HTML, + Images, + LaTeX + }; + /// what to use for math output. present choices are above + MathOutput html_math_output; + /// whether to attempt to be XHTML 1.1 compliant or instead be + /// a little more mellow + bool html_be_strict; private: + /// + void readPreamble(Lexer &); + /// + void readLocalLayout(Lexer &); + /// + void readLanguage(Lexer &); + /// + void readGraphicsDriver(Lexer &); + /// + void readBullets(Lexer &); + /// + void readBulletsLaTeX(Lexer &); + /// + void readModules(Lexer &); + /// + void readRemovedModules(Lexer &); + /// + void readIncludeonly(Lexer &); + /// for use with natbib + CiteEngine cite_engine_; + /// + 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::list removedModules_; + + /// the list of included children (for includeonly) + std::list includedChildren_; + /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files. */ @@ -281,8 +437,6 @@ private: }; support::copied_ptr pimpl_; - /// - biblio::CiteEngine cite_engine_; }; } // namespace lyx