X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=66e09f907e44b67ed075a12c4843d80bb0add42f;hb=5320ce020673013167a23a4221e2762603889453;hp=e2c97e4235820b4e9c7098e62bb4b2e4c717c7d2;hpb=4d4ee5d7a6e37036a97a2bebb40595f1324edd9c;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index e2c97e4235..66e09f907e 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,16 +15,15 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "Font.h" #include "Citation.h" +#include "LayoutModuleList.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" -#include -#include +#include namespace lyx { @@ -35,6 +34,9 @@ class BranchList; class Bullet; class DocumentClass; class Encoding; +class Font; +class HSpace; +class IndicesList; class Language; class LatexFeatures; class LayoutFile; @@ -52,8 +54,6 @@ class VSpace; */ class BufferParams { public: - /// - typedef std::vector LayoutModuleList; /// enum ParagraphSeparation { /// @@ -79,16 +79,21 @@ public: void validate(LaTeXFeatures &) const; /** \returns true if the babel package is used (interogates - * the BufferParams and a LyXRC variable). + * the BufferParams, a LyXRC variable, and the document class). * 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; /// @@ -104,7 +109,7 @@ public: InsetQuotes::QuoteTimes quotes_times; /// std::string fontsize; - ///Get the LayoutFile this document is using. + /// Get the LayoutFile this document is using. LayoutFile const * baseClass() const; /// LayoutFileIndex const & baseClassID() const; @@ -129,28 +134,41 @@ public: /// List of modules in use LayoutModuleList const & getModules() const { return layoutModules_; } /// List of default modules the user has removed - std::set const & getRemovedModules() const + std::list const & getRemovedModules() const { return removedModules_; } /// - /// 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). + /// 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); } + { 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; /// @@ -181,6 +199,14 @@ public: /* 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 @@ -189,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 @@ -211,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 @@ -236,9 +267,13 @@ public: 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; /// unsigned int columns; @@ -248,6 +283,18 @@ public: 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; @@ -270,8 +317,14 @@ public: Package use_amsmath; /// Whether and how to load esint Package use_esint; - /// + /// Whether and how to load mhchem + Package use_mhchem; + /// Whether and how to load mathdots + Package use_mathdots; + /// 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 @@ -286,8 +339,10 @@ 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 @@ -304,14 +359,21 @@ public: }; /// std::string paperSizeName(PapersizePurpose purpose) const; + /// set up if and how babel is called + 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; + int const & sfscale, int const & ttscale, + bool const & xetex) const; /// get the appropriate cite engine (natbib handling) CiteEngine citeEngine() const; @@ -322,6 +384,30 @@ public: 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; + /// + double html_math_img_scale; + /// + std::string html_latex_start; + /// + std::string html_latex_end; + /// generate output usable for reverse/forward search + bool output_sync; + /// custom LaTeX macro from user instead our own + std::string output_sync_macro; + /// use refstyle? or prettyref? + bool use_refstyle; + private: /// void readPreamble(Lexer &); @@ -339,7 +425,8 @@ private: void readModules(Lexer &); /// void readRemovedModules(Lexer &); - + /// + void readIncludeonly(Lexer &); /// for use with natbib CiteEngine cite_engine_; /// @@ -348,7 +435,10 @@ private: 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_; + 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.