* 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
*
* Full author contact details are available in file CREDITS.
#ifndef LATEXFEATURES_H
#define LATEXFEATURES_H
+#include "OutputParams.h"
+#include "support/docstring.h"
#include <set>
#include <list>
#include <map>
-#include <string>
+
+
+namespace lyx {
class Buffer;
class BufferParams;
-struct Language;
+class InsetLayout;
+class Language;
/** 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.C and paragraph.C
- when you do so.
-*/
+ * 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:
///
- LaTeXFeatures(Buffer const &, BufferParams const &);
+ LaTeXFeatures(Buffer const &, BufferParams const &,
+ OutputParams const &);
+ /// The color packages
+ std::string const getColorOptions() const;
/// The packages needed by the document
std::string const getPackages() const;
/// The macros definitions needed by the document
- std::string const getMacros() const;
+ docstring const getMacros() const;
///
std::string const getBabelOptions() const;
/// The definitions needed by the document's textclass
- std::string const getTClassPreamble() const;
- /// The sgml definitions needed by the document (dobook/linuxdoc)
- std::string const getLyXSGMLEntities() const;
+ docstring const getTClassPreamble() const;
+ /// The language dependent definitions needed by the document's textclass
+ docstring const getTClassI18nPreamble(bool use_babel) const;
+ ///
+ docstring const getTClassHTMLStyles() const;
+ ///
+ docstring const getTClassHTMLPreamble() const;
+ /// The sgml definitions needed by the document (docbook)
+ docstring const getLyXSGMLEntities() const;
/// The SGML Required to include the files added with includeFile();
- std::string const getIncludedFiles(std::string const & fname) const;
+ docstring const getIncludedFiles(std::string const & fname) const;
/// Include a file for use with the SGML entities
- void includeFile(std::string const & key, std::string const & name);
+ void includeFile(docstring const & key, std::string const & name);
/// The float definitions.
- void getFloatDefinitions(std::ostream & os) const;
+ void getFloatDefinitions(odocstream & os) const;
/// Print requirements to lyxerr
void showStruct() const;
///
- void addExternalPreamble(std::string const &);
- /// Provide a string name-space to the requirements
+ void addPreambleSnippet(std::string const &);
+ ///
+ std::string getPreambleSnippets() const;
+ /// Add a feature name requirements
void require(std::string const & name);
- /// Is the package required?
+ /// Add a set of feature names requirements
+ void require(std::set<std::string> const & names);
+ /// Which of the required packages are installed?
+ static void getAvailable();
+ /// Is the (required) package available?
+ static bool isAvailable(std::string const & name);
+ /// Has the package been required?
bool isRequired(std::string const & name) const;
+ /* Is it necessary to load the package? This is true if
+ isRequired is true and the feature is not provided by the
+ textclass.
+ */
+ bool mustProvide(std::string const & name) const;
///
- void useFloat(std::string const & name);
+ void useFloat(std::string const & name, bool subfloat = false);
///
void useLanguage(Language const *);
///
///
std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
///
- void useLayout(std::string const & lyt);
+ void useLayout(docstring const & lyt);
+ ///
+ void useInsetLayout(InsetLayout const & lay);
///
Buffer const & buffer() const;
///
+ void setBuffer(Buffer const &);
+ ///
BufferParams const & bufferParams() const;
/// the return value is dependent upon both LyXRC and LaTeXFeatures.
bool useBabel() const;
+ /// are we in a float?
+ bool inFloat() const { return in_float_; }
+ /// are we in a float?
+ void inFloat(bool const b) { in_float_ = b; }
+ /// Runparams that will be used for exporting this file.
+ OutputParams const & runparams() const { return runparams_; }
+ ///
+ void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
+ ///
+ docstring const & htmlTitle() const { return htmltitle_; }
private:
- std::list<std::string> usedLayouts_;
-
- /// Static preamble bits from the external material insets
- typedef std::list<std::string> FeaturesList;
///
- FeaturesList features_;
+ std::list<docstring> usedLayouts_;
///
- FeaturesList preamble_snippets_;
+ std::list<docstring> usedInsetLayouts_;
+ /// The features that are needed by the document
+ typedef std::set<std::string> Features;
///
- typedef std::set<Language const *> LanguageList;
+ Features features_;
+ /// Static preamble bits, from external templates, or anywhere else
+ typedef std::list<std::string> SnippetList;
+ ///
+ SnippetList preamble_snippets_;
+ /// The available (required) packages
+ typedef std::set<std::string> Packages;
+ ///
+ static Packages packages_;
///
+ typedef std::set<Language const *> LanguageList;
+ /// used languages (only those that are supported by babel)
LanguageList UsedLanguages_;
///
- typedef std::set<std::string> UsedFloats;
+ typedef std::map<std::string, bool> UsedFloats;
///
UsedFloats usedFloats_;
///
- typedef std::map<std::string , std::string> FileMap;
+ typedef std::map<docstring, std::string> FileMap;
///
FileMap IncludedFiles_;
- ///
- Buffer const & buffer_;
+ /** 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_;
+ ///
+ docstring htmltitle_;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff