#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
+#include "Author.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 <map>
+#include <vector>
namespace lyx {
namespace support { class FileName; }
-class AuthorList;
class BranchList;
class Bullet;
class DocumentClass;
class Lexer;
class PDFOptions;
class Spacing;
-class TexRow;
class VSpace;
/** Buffer parameters.
support::FileName const & filepath);
///
- void writeFile(std::ostream &) const;
+ void writeFile(std::ostream &, Buffer const *) 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).
+ /** \returns true if the babel package is used (interrogates
+ * the BufferParams, a LyXRC variable, and the document class).
* This returned value can then be passed to the insets...
*/
- bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &,
+ bool writeLaTeX(otexstream &, LaTeXFeatures &,
support::FileName const &) const;
///
///
InsetQuotes::QuoteLanguage quotes_language;
///
- 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
+ /// \param classname: 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();
+ /// 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(bool const clone = false);
/// 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
- LayoutModuleList const & getModules() const { return layoutModules_; }
+ LayoutModuleList const & getModules() const { return layout_modules_; }
/// List of default modules the user has removed
- std::list<std::string> const & getRemovedModules() const
- { return removedModules_; }
+ std::list<std::string> 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 moduleIsCompatible first if
- /// you want to check for compatibility.
+ /// 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 moduleCanBeAdded(std::string const & modName) const;
+ 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)
- { removedModules_.push_back(modName); }
+ void addRemovedModule(std::string const & modName)
+ { removed_modules_.push_back(modName); }
/// Clear the list
- void clearLayoutModules() { layoutModules_.clear(); }
+ void clearLayoutModules() { layout_modules_.clear(); }
/// Clear the removed module list
- void clearRemovedModules() { removedModules_.clear(); }
+ void clearRemovedModules() { removed_modules_.clear(); }
+ /// Get the local layouts
+ std::string getLocalLayout(bool) const;
+ /// Set the local layouts
+ void setLocalLayout(std::string const &, bool);
+
+ /// 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<Format const *> 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<std::string> backends() const;
/// List of included children (for includeonly)
- std::list<std::string> const & getIncludedChildren() const
- { return includedChildren_; }
+ std::list<std::string> const & getIncludedChildren() const
+ { return included_children_; }
///
- void addIncludedChildren(std::string const & child)
- { includedChildren_.push_back(child); }
+ void addIncludedChildren(std::string const & child)
+ { included_children_.push_back(child); }
/// Clear the list of included children
- void clearIncludedChildren() { includedChildren_.clear(); }
+ 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;
+ /// 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;
/* some LaTeX options */
/// The graphics driver
- std::string graphicsDriver;
+ std::string graphics_driver;
/// The default output format
- std::string defaultOutputFormat;
+ std::string default_output_format;
/// customized bibliography processor
std::string bibtex_command;
/// customized index processor
std::string index_command;
- /// font encoding
+ /// font encoding(s) requested for this document
std::string fontenc;
+ /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_roman[2];
/// the rm font
- std::string fontsRoman;
+ std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
+ /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_sans[2];
/// the sf font
- std::string fontsSans;
+ std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
+ /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_typewriter[2];
/// the tt font
- std::string fontsTypewriter;
+ std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
+ /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_math[2];
+ /// the math font
+ std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
/// the default family (rm, sf, tt)
- std::string fontsDefaultFamily;
- /// use the XeTeX processor
- bool useXetex;
+ 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: [0] for TeX fonts, [1] for non-TeX fonts
+ int fonts_sans_scale[2];
/// the scale factor of the sf font
- int fontsSansScale;
+ int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
+ /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
+ int fonts_typewriter_scale[2];
/// the scale factor of the tt font
- int fontsTypewriterScale;
+ int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
/// the font used by the CJK command
- std::string fontsCJK;
+ std::string fonts_cjk;
///
Spacing & spacing();
Spacing const & spacing() const;
int tocdepth;
///
Language const * language;
+ /// language package
+ std::string lang_package;
/// BranchList:
BranchList & branchlist();
BranchList const & branchlist() const;
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
std::string inputenc;
/// The main encoding used by this buffer for LaTeX output.
/// Individual pieces of text can use different encodings.
+ /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
+ /// instead of the value returned by this function.
Encoding const & encoding() const;
///
- std::string preamble;
+ std::string origin;
///
- std::string local_layout;
+ std::string preamble;
///
std::string options;
/// use the class options defined in the layout?
std::string float_placement;
///
unsigned int columns;
+ ///
+ bool justification;
/// parameters for the listings package
std::string listings_params;
///
/// 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 and how to load mhchem
- Package use_mhchem;
+ /// 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<std::string, std::string> const & auto_packages();
/// Split bibliography?
bool use_bibtopic;
/// Split the index?
bool use_indices;
- /// revision tracking for this buffer ?
- bool trackChanges;
+ /// Save trensient properties?
+ bool save_transient_properties;
+ /// revision tracking for this buffer ? (this is a transient property)
+ bool track_changes;
/** 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)
+ * This is a transient property.
*/
- bool outputChanges;
+ bool output_changes;
///
bool compressed;
/// the author list for the document
AuthorList & authors();
AuthorList const & authors() const;
+ void addAuthor(Author a);
/// map of the file's author IDs to AuthorList indexes
- std::map<unsigned int, int> author_map;
- /// the buffer's font encoding
+ typedef std::map<int, int> AuthorMap;
+ AuthorMap author_map_;
+
+ /// the buffer's active font encoding
std::string const font_encoding() const;
+ /// all font encodings requested by the prefs/document/main language.
+ /// This does NOT include font encodings required by secondary languages
+ std::vector<std::string> const font_encodings() const;
+
///
std::string const dvips_options() const;
/** The return value of paperSizeName() depends on the
///
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,
- bool const & xetex) const;
-
- /// get the appropriate cite engine (natbib handling)
- CiteEngine citeEngine() const;
- ///
- void setCiteEngine(CiteEngine const);
+ std::string const loadFonts(LaTeXFeatures & features) 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<std::string> 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<std::string> const &);
+ /// set the cite engine type
+ void setCiteEngineType(CiteEngineType const & engine_type)
+ { cite_engine_type_ = engine_type; }
+
+ /// the available citation commands
+ std::vector<std::string> citeCommands() const;
+ /// the available citation styles
+ std::vector<CitationStyle> 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,
- HTML,
- Images,
- LaTeX
+ MathML = 0,
+ HTML = 1,
+ Images = 2,
+ LaTeX = 3
};
/// what to use for math output. present choices are above
MathOutput html_math_output;
///
double html_math_img_scale;
///
+ double display_pixel_ratio;
+ ///
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 &);
///
- void readLocalLayout(Lexer &);
+ void readLocalLayout(Lexer &, bool);
///
void readLanguage(Lexer &);
///
void readRemovedModules(Lexer &);
///
void readIncludeonly(Lexer &);
- /// for use with natbib
- CiteEngine cite_engine_;
+ /// A cache for the default flavors
+ typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
///
- DocumentClass * doc_class_;
- ///
- LayoutModuleList layoutModules_;
+ mutable DefaultFlavorCache default_flavors_;
+ /// the cite engine modules
+ LayoutModuleList cite_engine_;
+ /// the type of cite engine (authoryear or numerical)
+ CiteEngineType cite_engine_type_;
+ ///
+ 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<std::string> removedModules_;
+ std::list<std::string> removed_modules_;
+ /// The local layouts without the forced ones
+ std::string local_layout_;
+ /// Forced local layouts only for reading (use getLocalLayout() instead)
+ std::string forced_local_layout_;
/// the list of included children (for includeonly)
- std::list<std::string> includedChildren_;
+ std::list<std::string> included_children_;
+
+ typedef std::map<std::string, Package> 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.
projects / lyx.git / blobdiff