#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
+#include "Author.h"
#include "Citation.h"
#include "DocumentClassPtr.h"
#include "Format.h"
namespace support { class FileName; }
-class AuthorList;
class BranchList;
class Bullet;
class DocumentClass;
class Encoding;
class Font;
-class HSpace;
class IndicesList;
class Language;
-class LatexFeatures;
class LayoutFile;
class LayoutFileIndex;
+class Length;
class Lexer;
class PDFOptions;
class Spacing;
bool hasClassDefaults() const;
///
- HSpace const & getIndentation() const;
+ Length const & getParIndent() const;
///
- void setIndentation(HSpace const & indent);
+ void setParIndent(Length const & indent);
///
VSpace const & getDefSkip() const;
///
void setDefSkip(VSpace const & vs);
+ ///
+ Length const & getMathIndent() const;
+ ///
+ void setMathIndent(Length const & indent);
+
+ /// Whether formulas are indented
+ bool is_math_indent;
+
+
+ enum MathNumber { DEFAULT, LEFT, RIGHT };
+ /// number formulas on left/right/default
+ MathNumber math_numbering_side;
+
+ /// Convenience function for display: like math_number, but
+ /// DEFAULT is replaced by the best guess we have.
+ MathNumber getMathNumber() const;
+
/** Whether paragraphs are separated by using a indent like in
* articles or by using a little skip like in letters.
*/
ParagraphSeparation paragraph_separation;
///
- InsetQuotes::QuoteLanguage quotes_language;
+ InsetQuotesParams::QuoteStyle quotes_style;
+ ///
+ bool dynamic_quotes;
///
std::string fontsize;
/// Get the LayoutFile this document is using.
{ 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
+ /// 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 removed module list
void clearRemovedModules() { removed_modules_.clear(); }
/// Get the local layouts
- std::string getLocalLayout(bool) const;
+ docstring getLocalLayout(bool forced) const;
/// Set the local layouts
- void setLocalLayout(std::string const &, bool);
+ void setLocalLayout(docstring const & layout, bool forced);
/// returns \c true if the buffer contains a LaTeX document
bool isLatex() const;
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 isExportable(std::string const & format, bool need_viewable) const;
///
- bool isExportableFormat(std::string const & format) const;
+ std::vector<const Format *> const & exportableFormats(bool only_viewable) 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;
Font const getFont() const;
/// translate quote style string to enum value
- InsetQuotes::QuoteLanguage getQuoteStyle(std::string const & qs) const;
+ InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
/* these are for the PaperLayout */
/// the papersize
int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
/// the font used by the CJK command
std::string fonts_cjk;
+ /// use LaTeX microtype package
+ bool use_microtype;
+ /// use font ligatures for en- and em-dashes
+ bool use_dash_ligatures;
///
Spacing & spacing();
Spacing const & spacing() const;
///
std::string origin;
///
- std::string preamble;
+ docstring preamble;
///
std::string options;
/// use the class options defined in the layout?
///
std::string float_placement;
///
+ std::string float_alignment;
+ ///
unsigned int columns;
///
bool justification;
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();
+ /// Do we use the bibtopic package?
+ bool useBibtopic() const;
/// Split bibliography?
- bool use_bibtopic;
+ bool splitbib() const { return use_bibtopic; }
+ /// Set split bibliography
+ void splitbib(bool const b) { use_bibtopic = b; }
+ /// Do we have multiple bibliographies (by chapter etc.)?
+ std::string multibib;
/// Split the index?
bool use_indices;
- /// revision tracking for this buffer ?
+ /// Save transient 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 output_changes;
///
/// 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
typedef std::map<int, int> AuthorMap;
- AuthorMap author_map;
+ AuthorMap author_map_;
+
/// the buffer's active font encoding
- std::string const font_encoding() const;
+ std::string const main_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 loadFonts(LaTeXFeatures & features) const;
/// the cite engine modules
- LayoutModuleList const & citeEngine() const
- { return cite_engine_; }
+ std::string 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 &);
+ void setCiteEngine(std::string const & eng) { cite_engine_ = eng; }
/// set the cite engine type
void setCiteEngineType(CiteEngineType const & engine_type)
{ cite_engine_type_ = engine_type; }
/// 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
+ /// Return the actual bibtex command (lyxrc or buffer param)
+ std::string const bibtexCommand() const;
+
+ /// Are we using biblatex?
+ bool useBiblatex() const;
+
+ /// Set the default BibTeX style file for the document
+ void setDefaultBiblioStyle(std::string const & s){ biblio_style = s; }
+ /// Get 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;
+ /// Check if a citation style is an alias to another style
+ std::string getCiteAlias(std::string const & s) const;
+
+ /// Options of the bibiography package
+ std::string biblio_opts;
+ /// The biblatex bibliography style
+ std::string biblatex_bibstyle;
+ /// The biblatex citation style
+ std::string biblatex_citestyle;
+ /// Set the bib file encoding (for biblatex)
+ void setBibEncoding(std::string const & s) { bib_encoding = s; }
+ /// Get the bib file encoding (for biblatex)
+ std::string const & bibEncoding() const { return bib_encoding; }
/// options for pdf output
PDFOptions & pdfoptions();
std::string html_latex_end;
///
bool html_css_as_file;
+ /// allow the LaTeX backend to run external programs
+ bool shell_escape;
/// 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;
+ /// use minted? or listings?
+ bool use_minted;
/// Return true if language could be set to lang,
/// otherwise return false and do not change language
bool setLanguage(std::string const & lang);
+ ///
+ void invalidateConverterCache() const;
private:
///
typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
///
mutable DefaultFlavorCache default_flavors_;
- /// the cite engine modules
- LayoutModuleList cite_engine_;
+ /// the cite engine
+ std::string cite_engine_;
/// the type of cite engine (authoryear or numerical)
CiteEngineType cite_engine_type_;
+ /// the default BibTeX style file for the document
+ std::string biblio_style;
+ /// The encoding of the bib files, for Biblatex
+ /// (only one supported currently)
+ // FIXME: biblatex 3.12 introduces per-file
+ // encoding options. Update once that's spread.
+ std::string bib_encoding;
+ /// Split bibliography?
+ bool use_bibtopic;
///
DocumentClassPtr doc_class_;
///
/// the user has chosen not to use
std::list<std::string> removed_modules_;
/// The local layouts without the forced ones
- std::string local_layout_;
+ docstring local_layout_;
/// Forced local layouts only for reading (use getLocalLayout() instead)
- std::string forced_local_layout_;
+ docstring forced_local_layout_;
/// the list of included children (for includeonly)
std::list<std::string> included_children_;
projects / lyx.git / blobdiff