X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=2a669d0ac167b8b8867a318789389363bdb533d6;hb=3d4076b598deb18660e50ec9c327efc3b15f15d0;hp=dae8c4e3b2a086149e513f1cdef6bfd13685d69b;hpb=3e28f0fc57ebd067c514f4d82fc8e1530ecc6424;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index dae8c4e3b2..2a669d0ac1 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,14 +15,18 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "Font.h" #include "Citation.h" +#include "DocumentClassPtr.h" +#include "Format.h" +#include "LayoutModuleList.h" +#include "OutputParams.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" +#include #include namespace lyx { @@ -34,6 +38,9 @@ class BranchList; class Bullet; class DocumentClass; class Encoding; +class Font; +class HSpace; +class IndicesList; class Language; class LatexFeatures; class LayoutFile; @@ -76,16 +83,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(otexstream &, LaTeXFeatures &, + support::FileName const &) const; /// void useClassDefaults(); /// bool hasClassDefaults() const; + /// + HSpace const & getIndentation() const; + /// + void setIndentation(HSpace const & indent); /// VSpace const & getDefSkip() const; /// @@ -101,44 +113,99 @@ 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; /// Set the LyX layout file this document is using. - /// NOTE: This does not call makeDocumentClass() to update the local + /// 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. + /// NOTE: This should NEVER be called externally unless one immediately goes + /// on to class BufferView::updateDocumentClass(). The exception, of course, + /// is in GuiDocument, where we use a BufferParams simply to hold a copy of + /// the parameters from the active Buffer. 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; + /// \return A pointer to the DocumentClass currently in use: the BaseClass + /// as modified by modules. + DocumentClassConstPtr 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); + void setDocumentClass(DocumentClassConstPtr); /// 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 layout_modules_; } + /// List of default modules the user has removed + std::list const & getRemovedModules() const + { return removed_modules_; } + /// + /// Add a module to the list of modules in use. This checks only that the + /// module is not already in the list, so use layoutModuleCanBeAdeed 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 layoutModuleCanBeAdded(std::string const & modName) const; + /// same, but for citaton modules. + bool citationModuleCanBeAdded(std::string const & modName) const; + /// + void addRemovedModule(std::string const & modName) + { removed_modules_.push_back(modName); } /// Clear the list - void clearLayoutModules(); + void clearLayoutModules() { layout_modules_.clear(); } + /// Clear the removed module list + void clearRemovedModules() { removed_modules_.clear(); } + + /// returns \c true if the buffer contains a LaTeX document + bool isLatex() const; + /// returns \c true if the buffer contains a DocBook document + bool isDocBook() const; + /// returns \c true if the buffer contains a Wed document + bool isLiterate() const; + + /// return the format of the buffer on a string + std::string bufferFormat() const; + /// return the default output format of the current backend + std::string getDefaultOutputFormat() const; + /// return the output flavor of \p format or the default + OutputParams::FLAVOR getOutputFlavor( + std::string const format = std::string()) const; + /// + bool isExportable(std::string const & format) const; + /// + std::vector exportableFormats(bool only_viewable) const; + /// + bool isExportableFormat(std::string const & format) const; + /// the backends appropriate for use with this document. + /// so, e.g., latex is excluded , if we're using non-TeX fonts + std::vector backends() const; + + /// List of included children (for includeonly) + std::list const & getIncludedChildren() const + { return included_children_; } + /// + void addIncludedChildren(std::string const & child) + { included_children_.push_back(child); } + /// Clear the list of included children + void clearIncludedChildren() { included_children_.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 */ + /// translate quote style string to enum value + InsetQuotes::QuoteLanguage getQuoteStyle(std::string const qs) const; + + /* these are for the PaperLayout */ /// the papersize PAPER_SIZE papersize; /// @@ -168,23 +235,37 @@ public: /* some LaTeX options */ /// The graphics driver - std::string graphicsDriver; + std::string graphics_driver; + /// The default output format + std::string default_output_format; + /// 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; + std::string fonts_roman; /// the sf font - std::string fontsSans; + std::string fonts_sans; /// the tt font - std::string fontsTypewriter; + std::string fonts_typewriter; + /// the math font + std::string fonts_math; /// the default family (rm, sf, tt) - std::string fontsDefaultFamily; + std::string fonts_default_family; + /// use the fonts of the OS (OpenType, True Type) directly + bool useNonTeXFonts; /// use expert Small Caps - bool fontsSC; + bool fonts_expert_sc; /// use Old Style Figures - bool fontsOSF; + bool fonts_old_figures; /// the scale factor of the sf font - int fontsSansScale; + int fonts_sans_scale; /// the scale factor of the tt font - int fontsTypewriterScale; + int fonts_typewriter_scale; + /// the font used by the CJK command + std::string fonts_cjk; /// Spacing & spacing(); Spacing const & spacing() const; @@ -194,14 +275,19 @@ public: int tocdepth; /// Language const * language; + /// language package + std::string lang_package; /// BranchList: BranchList & branchlist(); BranchList const & branchlist() const; + /// IndicesList: + IndicesList & indiceslist(); + IndicesList const & indiceslist() const; /** - * The input encoding for LaTeX. This can be one of + * The LyX name of the input encoding for LaTeX. This can be one of * - \c auto: find out the input encoding from the used languages * - \c default: ditto - * - any encoding supported by the inputenc package + * - any encoding defined in the file lib/encodings * The encoding of the LyX file is always utf8 and has nothing to * do with this setting. * The difference between \c auto and \c default is that \c auto also @@ -222,18 +308,36 @@ 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; + /// + bool justification; /// parameters for the listings package std::string listings_params; /// 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; @@ -252,12 +356,16 @@ public: /// some ERT that needs the package) package_on = 2 }; - /// Whether and how to load amsmath - Package use_amsmath; - /// Whether and how to load esint - Package use_esint; - /// + /// Whether to load a package such as amsmath or esint. + Package use_package(std::string const & p) const; + /// Set whether to load a package such as amsmath or esint. + void use_package(std::string const & p, Package u); + /// All packages that can be switched on or off + static std::map const & auto_packages(); + /// 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 @@ -272,8 +380,11 @@ 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 + typedef std::map AuthorMap; + AuthorMap 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 @@ -291,25 +402,83 @@ public: /// std::string paperSizeName(PapersizePurpose purpose) const; /// set up if and how babel is called - std::string babelCall(std::string const & lang_opts) const; + std::string babelCall(std::string const & lang_opts, bool const langoptions) 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; + void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) 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; + std::string const loadFonts(LaTeXFeatures & features) const; - /// get the appropriate cite engine (natbib handling) - CiteEngine citeEngine() const; - /// - void setCiteEngine(CiteEngine const); + /// the cite engine modules + LayoutModuleList const & citeEngine() const + { return cite_engine_; } + /// the type of cite engine (authoryear or numerical) + CiteEngineType const & citeEngineType() const + { return cite_engine_type_; } + /// add the module to the cite engine modules + bool addCiteEngine(std::string const &); + /// add the modules to the cite engine modules + bool addCiteEngine(std::vector const &); + /// clear the list of cite engine modules + void clearCiteEngine() { cite_engine_.clear(); } + /// set the cite engine module + void setCiteEngine(std::string const &); + /// set the cite engine modules + void setCiteEngine(std::vector const &); + /// set the cite engine type + void setCiteEngineType(CiteEngineType const & engine_type) + { cite_engine_type_ = engine_type; } + + /// the available citation commands + std::vector citeCommands() const; + /// the available citation styles + std::vector citeStyles() const; + + /// the default BibTeX style file for the document + std::string biblio_style; + /// the default BibTeX style file from the TextClass + std::string const & defaultBiblioStyle() const; + /// whether the BibTeX style supports full author lists + bool const & fullAuthorList() const; /// options for pdf output PDFOptions & pdfoptions(); PDFOptions const & pdfoptions() const; + // do not change these values. we rely upon them. + enum MathOutput { + MathML = 0, + HTML = 1, + Images = 2, + LaTeX = 3 + }; + /// 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; + /// + bool html_css_as_file; + /// 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; + + /// Return true if language could be set to lang, + /// otherwise return false and do not change language + bool setLanguage(std::string const & lang); + private: /// void readPreamble(Lexer &); @@ -325,15 +494,34 @@ private: void readBulletsLaTeX(Lexer &); /// void readModules(Lexer &); - - /// for use with natbib - CiteEngine cite_engine_; /// - DocumentClass * doc_class_; + void readRemovedModules(Lexer &); + /// + void readIncludeonly(Lexer &); + /// A cache for the default flavors + typedef std::map DefaultFlavorCache; + /// + mutable DefaultFlavorCache default_flavors_; + /// the cite engine modules + LayoutModuleList cite_engine_; + /// the type of cite engine (authoryear or numerical) + CiteEngineType cite_engine_type_; /// - typedef std::vector LayoutModuleList; - /// - LayoutModuleList layoutModules_; + DocumentClassPtr doc_class_; + /// + LayoutModuleList layout_modules_; + /// this is for modules that are required by the document class but that + /// the user has chosen not to use + std::list removed_modules_; + + /// the list of included children (for includeonly) + std::list included_children_; + + typedef std::map PackageMap; + /** Whether and how to load packages like amsmath, esint, mhchem, + * mathdots, stackrel, stmaryrd and undertilde. + */ + PackageMap use_packages; /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files.