X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=af7333364b3b1aee59131990541d925acf0bc8b4;hb=5e45cd4c44d0cb122243234d336f478fa2f5b3c1;hp=2aa2ef49a25d95f5432a8ca06f05c8807e400afb;hpb=2b3bd7b5f4a8815427d05c6cc6aaf25b6b8ffba5;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 2aa2ef49a2..af7333364b 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -16,31 +16,31 @@ #define BUFFERPARAMS_H #include "Font.h" -#include "BiblioInfo.h" +#include "Citation.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" +#include +#include #include namespace lyx { -namespace support { -class FileName; -} +namespace support { class FileName; } class AuthorList; -class LayoutFileIndex; class BranchList; class Bullet; class DocumentClass; class Encoding; class Language; -class Lexer; class LatexFeatures; class LayoutFile; +class LayoutFileIndex; +class Lexer; class PDFOptions; class Spacing; class TexRow; @@ -54,23 +54,24 @@ class VSpace; class BufferParams { public: /// - enum PARSEP { + typedef std::list LayoutModuleList; + /// + 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 readToken(Lexer & lex, std::string const & token, ///< token to read. - support::FileName const & filepath); ///< where to look for local layout file. + support::FileName const & filepath); /// void writeFile(std::ostream &) const; @@ -86,24 +87,22 @@ public: /// void useClassDefaults(); - /// bool hasClassDefaults() const; /// VSpace const & getDefSkip() const; - /// void setDefSkip(VSpace const & vs); /** 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; ///Get the LayoutFile this document is using. @@ -123,22 +122,32 @@ public: DocumentClass const & documentClass() const; /// \return A pointer to the DocumentClass currently in use: the BaseClass /// as modified by modules. - DocumentClass * documentClassPtr() const; + 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 - 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 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). + LayoutModuleList const & getModules() const { return layoutModules_; } + /// List of default modules the user has removed + std::set 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_.insert(modName); } /// Clear the list - void clearLayoutModules(); + void clearLayoutModules() { layoutModules_.clear(); } + /// Clear the removed module list + void clearRemovedModules() { removedModules_.clear(); } /// returns the main font for the buffer (document) Font const getFont() const; @@ -190,6 +199,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; @@ -224,7 +235,13 @@ 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; /// std::string float_placement; /// @@ -268,8 +285,6 @@ public: bool outputChanges; /// bool compressed; - /// - bool embedded; /// the author list for the document AuthorList & authors(); @@ -283,7 +298,7 @@ public: * purpose for which the paper size is needed, since they * support different subsets of paper sizes. */ - enum Papersize_Purpose { + enum PapersizePurpose { /// DVIPS, /// @@ -292,9 +307,9 @@ public: XDVI }; /// - std::string const paperSizeName(Papersize_Purpose const & purpose) 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; /// handle inputenc etc. void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features, TexRow & texrow) const; @@ -305,10 +320,9 @@ public: int const & sfscale, int const & ttscale) const; /// get the appropriate cite engine (natbib handling) - biblio::CiteEngine getEngine() const; - + CiteEngine citeEngine() const; /// - void setCiteEngine(biblio::CiteEngine const); + void setCiteEngine(CiteEngine const); /// options for pdf output PDFOptions & pdfoptions(); @@ -318,6 +332,8 @@ private: /// void readPreamble(Lexer &); /// + void readLocalLayout(Lexer &); + /// void readLanguage(Lexer &); /// void readGraphicsDriver(Lexer &); @@ -327,15 +343,26 @@ private: void readBulletsLaTeX(Lexer &); /// void readModules(Lexer &); + /// + void readRemovedModules(Lexer &); + /// + void addDefaultModules(); + /// checks for consistency among modules: makes sure requirements + /// are met, no modules exclude one another, etc, and resolves any + /// such conflicts, leaving us with a consistent collection. + /// \return true if modules were consistent, false if changes had + /// to be made. + bool checkModuleConsistency(); /// for use with natbib - biblio::CiteEngine cite_engine_; + CiteEngine cite_engine_; /// DocumentClass * doc_class_; - /// - typedef std::vector LayoutModuleList; /// LayoutModuleList layoutModules_; + /// this is for modules that are required by the document class but that + /// the user has chosen not to use + std::set removedModules_; /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files.