#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
-#include "Author.h"
#include "Citation.h"
+#include "ColorCode.h"
+#include "ColorSet.h"
#include "DocumentClassPtr.h"
-#include "Format.h"
#include "LayoutModuleList.h"
-#include "OutputParams.h"
#include "paper.h"
-
-#include "insets/InsetQuotes.h"
+#include "WordLangTuple.h"
#include "support/copied_ptr.h"
+#include "support/types.h"
#include <map>
#include <vector>
namespace support { class FileName; }
+class Author;
+class AuthorList;
class BranchList;
class Bullet;
+class Buffer;
class DocumentClass;
class Encoding;
class Font;
+class Format;
class IndicesList;
class Language;
+class LaTeXFeatures;
class LayoutFile;
class LayoutFileIndex;
class Length;
class Lexer;
+class otexstream;
class PDFOptions;
class Spacing;
class VSpace;
+enum class Flavor : int;
+enum class QuoteStyle : int;
+
/** Buffer parameters.
* This class contains all the parameters for this buffer's use. Some
* work needs to be done on this class to make it nice. Now everything
/// read a header token, if unrecognised, return it or an unknown class name
std::string readToken(Lexer & lex,
std::string const & token, ///< token to read.
- support::FileName const & filepath);
+ support::FileName const & filename);
///
void writeFile(std::ostream &, Buffer const *) const;
*/
ParagraphSeparation paragraph_separation;
///
- InsetQuotesParams::QuoteStyle quotes_style;
+ QuoteStyle quotes_style;
///
bool dynamic_quotes;
///
/// 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);
+ void makeDocumentClass(bool clone = false, bool internal = false);
/// Returns the DocumentClass currently in use: the BaseClass as modified
/// by modules.
DocumentClass const & documentClass() const;
/// 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 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;
+ Flavor getOutputFlavor(std::string const & format = std::string()) const;
///
bool isExportable(std::string const & format, bool need_viewable) const;
///
void clearIncludedChildren() { included_children_.clear(); }
/// update aux files of unincluded children (with \includeonly)
- bool maintain_unincluded_children;
+ enum ChildrenMaintenance {
+ CM_None,
+ CM_Mostly,
+ CM_Strict
+ };
+ ChildrenMaintenance maintain_unincluded_children;
/// returns the main font for the buffer (document)
Font const getFont() const;
/// translate quote style string to enum value
- InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
+ QuoteStyle getQuoteStyle(std::string const & qs) const;
/* these are for the PaperLayout */
/// the papersize
/// IndicesList:
IndicesList & indiceslist();
IndicesList const & indiceslist() const;
+ ///
+ WordLangTable & spellignore();
+ WordLangTable const & spellignore() const;
+ bool spellignored(WordLangTuple const & wl) const;
/**
* 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
std::string origin;
///
docstring preamble;
+ /// DocumentMetadata as introduced by LaTeX 2022/06
+ docstring document_metadata;
///
std::string options;
/// use the class options defined in the layout?
///
RGBColor notefontcolor;
///
+ bool isnotefontcolor;
+ ///
RGBColor boxbgcolor;
+ ///
+ bool isboxbgcolor;
/// \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;
*/
bool output_changes;
///
+ bool change_bars;
+ ///
bool compressed;
+ ///
+ bool postpone_fragile_content;
/// the author list for the document
AuthorList & authors();
AuthorList const & authors() const;
- void addAuthor(Author a);
+ void addAuthor(Author const & a);
/// map of the file's author IDs to AuthorList indexes
typedef std::map<int, int> AuthorMap;
};
///
std::string paperSizeName(PapersizePurpose purpose,
- std::string const psize = std::string()) const;
+ std::string const & psize = std::string()) const;
/// set up if and how babel is called
std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
/// return supported drivers for specific packages
std::vector<CitationStyle> citeStyles() const;
/// Return the actual bibtex command (lyxrc or buffer param)
- std::string const bibtexCommand() const;
+ std::string const bibtexCommand(bool const warn = false) const;
/// Are we using biblatex?
bool useBiblatex() const;
/// 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;
+ bool fullAuthorList() const;
/// Check if a citation style is an alias to another style
std::string getCiteAlias(std::string const & s) const;
std::string html_latex_end;
///
bool html_css_as_file;
+
+ // do not change these values. we rely upon them.
+ enum TableOutput {
+ HTMLTable = 0,
+ CALSTable = 1
+ };
+ /// what format to use for table output in DocBook. present choices are above
+ TableOutput docbook_table_output;
+
+ // do not change these values. we rely upon them.
+ enum MathMLNameSpacePrefix {
+ NoPrefix = 0,
+ MPrefix = 1,
+ MMLPrefix = 2
+ };
+ /// what prefix to use when outputting MathML. present choices are above
+ MathMLNameSpacePrefix docbook_mathml_prefix;
+
/// allow the LaTeX backend to run external programs
bool shell_escape;
/// generate output usable for reverse/forward search
///
void readPreamble(Lexer &);
///
+ void readDocumentMetadata(Lexer &);
+ ///
void readLocalLayout(Lexer &, bool);
///
void readLanguage(Lexer &);
///
void readIncludeonly(Lexer &);
/// A cache for the default flavors
- typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
+ typedef std::map<std::string, Flavor> DefaultFlavorCache;
///
mutable DefaultFlavorCache default_flavors_;
/// the cite engine
std::map<std::string, std::string> bib_encodings;
/// Split bibliography?
bool use_bibtopic;
+ /// Return the actual or an appropriate fallback bibtex command
+ std::string const getBibtexCommand(std::string const cmd,
+ bool const warn) const;
///
DocumentClassPtr doc_class_;
///
support::copied_ptr<Impl, MemoryTraits> pimpl_;
};
+
+///
+BufferParams const & defaultBufferParams();
+
} // namespace lyx
#endif
projects / lyx.git / blobdiff