mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-23 21:40:19 +00:00
bc73a85778
This is a new take onc8e2c17a
that was reverted atda67bde61a
due to entities no more recognised by the browsers. Corresponding thread on the mailing list: https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg213179.html This patch is a huge cleanup overall, by removing the distinction between HTML and XML entities (the latter arrived due to the DocBook support). In InsetListingParams, I also changed the mechanism that relied on " to use an XML entity to be consistent with the rest of the code, mostly in case someone looks for HTML entities and wonders why they are still there.
246 lines
7.8 KiB
C++
246 lines
7.8 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file LaTeXFeatures.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jean-Marc Lasgouttes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef LATEXFEATURES_H
|
|
#define LATEXFEATURES_H
|
|
|
|
#include "support/docstring.h"
|
|
|
|
#include <set>
|
|
#include <list>
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class Buffer;
|
|
class BufferParams;
|
|
class InsetLayout;
|
|
class Language;
|
|
class otexstream;
|
|
class OutputParams;
|
|
struct TexString;
|
|
|
|
/** The packages and commands that a buffer needs. This class
|
|
* contains a list<string>. Each of the LaTeX packages that a buffer needs
|
|
* should be added with void require(string const & name).
|
|
*
|
|
* i.e require("amssymb")
|
|
*
|
|
* To add support you should only need to require() the package name as
|
|
* packages which don't have special requirements are handled automatically.
|
|
* If your new package does need special consideration you'll need to alter
|
|
* string const getPackages() const;
|
|
* Remember to update the validate function in Buffer.cpp and Paragraph.cpp
|
|
* when you do so.
|
|
*/
|
|
class LaTeXFeatures {
|
|
public:
|
|
/// Which Language package do we use?
|
|
enum LangPackage {
|
|
LANG_PACK_NONE,
|
|
LANG_PACK_BABEL,
|
|
LANG_PACK_POLYGLOSSIA,
|
|
LANG_PACK_CUSTOM
|
|
};
|
|
///
|
|
LaTeXFeatures(Buffer const &, BufferParams const &,
|
|
OutputParams const &);
|
|
/// The color packages
|
|
std::string const getColorOptions() const;
|
|
/// The requested package options
|
|
std::string const getPackageOptions() const;
|
|
/// The packages needed by the document
|
|
std::string const getPackages() const;
|
|
/// The macros definitions needed by the document
|
|
TexString getMacros() const;
|
|
/// Extra preamble code before babel is called
|
|
docstring const getBabelPresettings() const;
|
|
/// Extra preamble code after babel is called
|
|
docstring const getBabelPostsettings() const;
|
|
/// Load AMS packages when appropriate
|
|
std::string const loadAMSPackages() const;
|
|
/// The definitions needed by the document's textclass
|
|
docstring const getTClassPreamble() const;
|
|
/// The language dependent definitions needed by the document's textclass
|
|
docstring const getTClassI18nPreamble(bool use_babel,
|
|
bool use_polyglossia, bool use_minted) const;
|
|
///
|
|
docstring const getTClassHTMLStyles() const;
|
|
///
|
|
docstring const getTClassHTMLPreamble() const;
|
|
/// Include a file for use with the SGML entities
|
|
void includeFile(docstring const & key, std::string const & name);
|
|
/// The float definitions.
|
|
void getFloatDefinitions(otexstream & os) const;
|
|
/// Print requirements to lyxerr
|
|
void showStruct() const;
|
|
/// Add preamble snippet with TexRow information
|
|
void addPreambleSnippet(TexString snippet, bool allowdupes = false);
|
|
/// Add preamble snippet without TexRow information
|
|
void addPreambleSnippet(docstring const & snippet, bool allowdupes = false);
|
|
///
|
|
TexString getPreambleSnippets() const;
|
|
/// Adds CSS information for HTML export.
|
|
/// Note that addPreambleSnippet is for LaTeX-type export
|
|
void addCSSSnippet(std::string const &);
|
|
///
|
|
docstring getCSSSnippets() const;
|
|
/// Add a feature name requirements
|
|
void require(std::string const & name);
|
|
/// Add a set of feature names requirements
|
|
void require(std::set<std::string> const & names);
|
|
/// Add a feature name provision
|
|
void provide(std::string const & name);
|
|
/// Is the (required) package available?
|
|
static bool isAvailable(std::string const & name);
|
|
/// Is the (required) package available at least as of version
|
|
/// y/m/d?
|
|
static bool isAvailableAtLeastFrom(std::string const & name,
|
|
int const y, int const m, int const d = 1);
|
|
/// Has the package been required?
|
|
bool isRequired(std::string const & name) const;
|
|
/** Is this feature already provided
|
|
* e.g. by the document class?
|
|
*/
|
|
bool isProvided(std::string const & name) const;
|
|
/** Is it necessary to load the package? This is true if
|
|
isRequired is true and the feature is not already provided
|
|
*/
|
|
bool mustProvide(std::string const & name) const;
|
|
///
|
|
void useFloat(std::string const & name, bool subfloat = false);
|
|
///
|
|
void useLanguage(Language const *);
|
|
///
|
|
bool hasLanguages() const;
|
|
/// check if all used languages are supported by polyglossia
|
|
bool hasOnlyPolyglossiaLanguages() const;
|
|
/// check if a language is supported only by polyglossia
|
|
bool hasPolyglossiaExclusiveLanguages() const;
|
|
/// A vector of all used languages supported only by polyglossia
|
|
std::vector<std::string> getPolyglossiaExclusiveLanguages() const;
|
|
/// A vector of all used languages supported only by babel
|
|
std::vector<std::string> getBabelExclusiveLanguages() const;
|
|
///
|
|
std::string getBabelLanguages() const;
|
|
///
|
|
std::set<std::string> getPolyglossiaLanguages() const;
|
|
///
|
|
std::string getActiveChars() const;
|
|
///
|
|
std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
|
|
///
|
|
void getFontEncodings(std::vector<std::string> & encodings,
|
|
bool const onlylangs = false) const;
|
|
///
|
|
void useLayout(docstring const & layoutname);
|
|
///
|
|
void useInsetLayout(InsetLayout const & lay);
|
|
///
|
|
Buffer const & buffer() const;
|
|
///
|
|
void setBuffer(Buffer const &);
|
|
///
|
|
BufferParams const & bufferParams() const;
|
|
/** Which language package do we require? \p englishbabel determines
|
|
* if we require babel even if English is the only language.
|
|
*/
|
|
LangPackage langPackage() const;
|
|
/// Convenience function to test if we use babel
|
|
bool useBabel() const { return langPackage() == LANG_PACK_BABEL; }
|
|
/// Convenience function to test if we use polyglossia
|
|
bool usePolyglossia() const { return langPackage() == LANG_PACK_POLYGLOSSIA; }
|
|
/// are we in a float?
|
|
bool inFloat() const { return in_float_; }
|
|
/// are we in a float?
|
|
void inFloat(bool const b) { in_float_ = b; }
|
|
/// are we in a deleted inset?
|
|
bool inDeletedInset() const { return in_deleted_inset_; }
|
|
/// are we in a deleted inset?
|
|
void inDeletedInset(bool const b) { in_deleted_inset_ = b; }
|
|
/// set savenote environment (footnote package)
|
|
std::string saveNoteEnv() const { return savenote_env_; }
|
|
/// return savenote environment
|
|
void saveNoteEnv(std::string const & s) { savenote_env_ = s; }
|
|
/// Runparams that will be used for exporting this file.
|
|
OutputParams const & runparams() const { return runparams_; }
|
|
/// Resolve alternatives like "esint|amsmath|wasysym"
|
|
void resolveAlternatives();
|
|
/// Expand multiple requirements like "textcomp,lyxmathsym,amstext"
|
|
void expandMultiples();
|
|
///
|
|
void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
|
|
///
|
|
docstring const & htmlTitle() const { return htmltitle_; }
|
|
///
|
|
bool hasRTLLanguage() const;
|
|
|
|
private:
|
|
///
|
|
void useLayout(docstring const &, int);
|
|
///
|
|
std::list<docstring> usedLayouts_;
|
|
///
|
|
std::list<docstring> usedInsetLayouts_;
|
|
///
|
|
typedef std::set<std::string> Features;
|
|
/// The features that are needed by the document
|
|
Features features_;
|
|
/// Features that are provided
|
|
Features provides_;
|
|
/// Static preamble bits, from external templates, or anywhere else
|
|
typedef std::list<TexString> SnippetList;
|
|
///
|
|
SnippetList preamble_snippets_;
|
|
///
|
|
SnippetList css_snippets_;
|
|
///
|
|
typedef std::set<Language const *> LanguageList;
|
|
/// used languages (only those that are supported by babel)
|
|
LanguageList UsedLanguages_;
|
|
///
|
|
typedef std::map<std::string, bool> UsedFloats;
|
|
///
|
|
UsedFloats usedFloats_;
|
|
///
|
|
typedef std::map<docstring, std::string> FileMap;
|
|
///
|
|
FileMap IncludedFiles_;
|
|
/** Buffer of the file being processed.
|
|
* This may be a child buffer of the to-be-exported file and
|
|
* therefore may not be the buffer that belongs to params_.
|
|
* Only needed by InsetInclude::validate().
|
|
*/
|
|
Buffer const * buffer_;
|
|
///
|
|
BufferParams const & params_;
|
|
/** Some insets need to know details about the to-be-produced file
|
|
* in validate().
|
|
*/
|
|
OutputParams const & runparams_;
|
|
///
|
|
bool in_float_;
|
|
///
|
|
bool in_deleted_inset_;
|
|
///
|
|
docstring htmltitle_;
|
|
///
|
|
std::string savenote_env_;
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|