// -*- C++ -*-
-/* This file is part of
-* ======================================================
-*
-* LyX, The Document Processor
-*
-* Copyright 1995 Matthias Ettrich
-* Copyright 1995-2000 the LyX Team.
-*
-* ====================================================== */
+/**
+ * \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 "OutputParams.h"
+#include "support/docstring.h"
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include <vector>
#include <set>
+#include <list>
+#include <map>
+
-#include "LString.h"
+namespace lyx {
-class BufferParams;
-class LyXTextClass;
-struct Language;
+class Buffer;
+class BufferParams;
+class InsetLayout;
+class Language;
-/** The packages and commands that a buffer needs. This struct
- contains an entry for each of the latex packages and
- commands that a buffer might need. This struct is supposed to be
- extended as the need arises. Remember to update the validate function
- in buffer.C and paragraph.C when you do so. */
-struct LaTeXFeatures {
- ///
- LaTeXFeatures(BufferParams const &, int n) ;
- /// The packaes needed by the document
- string getPackages();
+/** 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:
+ ///
+ 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
- string getMacros();
+ docstring const getMacros() const;
+ /// Extra preamble code before babel is called
+ std::string const getBabelPresettings() const;
+ /// Extra preamble code after babel is called
+ std::string const getBabelPostsettings() const;
/// The definitions needed by the document's textclass
- string getTClassPreamble();
-
- ///
- void showStruct();
-
- /// Provide a string name-space to the requirements
- void require(string const & name);
-
- /// Static preamble bits from the external material insets
- string externalPreambles;
-
- //@Man: Packages
- //@{
- ///
- bool color; // color.sty
-#ifdef USE_GRAPHICX
- ///
- bool graphicx; // graphicx.sty
-#else
- ///
- bool graphics; // graphics.sty
-#endif
+ docstring const getTClassPreamble() const;
+ /// The language dependent definitions needed by the document's textclass
+ docstring const getTClassI18nPreamble(bool use_babel) const;
///
- bool setspace; // setspace.sty
+ docstring const getTClassHTMLStyles() const;
///
- bool makeidx; // makeind.sty
+ 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();
+ docstring const getIncludedFiles(std::string const & fname) const;
+ /// Include a file for use with the SGML entities
+ void includeFile(docstring const & key, std::string const & name);
+ /// The float definitions.
+ void getFloatDefinitions(odocstream & os) const;
+ /// Print requirements to lyxerr
+ void showStruct() const;
///
- bool verbatim; // verbatim.sty
+ void addPreambleSnippet(std::string const &);
///
- bool longtable; // longtable.sty
+ std::string getPreambleSnippets() 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);
+ /// 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;
///
- bool algorithm; // algorithm.sty
+ void useFloat(std::string const & name, bool subfloat = false);
///
- bool rotating; // rotating.sty
+ void useLanguage(Language const *);
///
- bool amssymb; // amssymb.sty
+ bool hasLanguages() const;
///
- bool latexsym; // latexsym.sty
+ std::string getLanguages() const;
///
- bool pifont; // pifont.sty
+ std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
///
- bool subfigure; // subfigure.sty
+ void useLayout(docstring const & lyt);
///
- bool floatflt; // floatflt.sty
+ void useInsetLayout(InsetLayout const & lay);
///
- bool url; // url.sty
+ Buffer const & buffer() const;
///
- bool varioref; // varioref.sty
+ void setBuffer(Buffer const &);
///
- bool prettyref; // prettyref.sty
- ///
- bool chess; // chess.sty
- //@}
+ 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_; }
-
- //@Man: Commands
- //@{
- ///
- bool lyx;
+private:
///
- bool lyxline;
- /// \noun
- bool noun;
- /// \lyxarrow
- bool lyxarrow;
- //@}
-
- //@Man: Quotes
- //@{
+ std::list<docstring> usedLayouts_;
///
- bool quotesinglbase;
+ std::list<docstring> usedInsetLayouts_;
+ /// The features that are needed by the document
+ typedef std::set<std::string> Features;
///
- bool quotedblbase;
+ Features features_;
+ /// Static preamble bits, from external templates, or anywhere else
+ typedef std::list<std::string> SnippetList;
///
- bool guilsinglleft;
+ SnippetList preamble_snippets_;
+ /// The available (required) packages
+ typedef std::set<std::string> Packages;
///
- bool guilsinglright;
+ static Packages packages_;
///
- bool guillemotleft;
+ typedef std::set<Language const *> LanguageList;
+ /// used languages (only those that are supported by babel)
+ LanguageList UsedLanguages_;
///
- bool guillemotright;
- //@}
-
- //@Man: Math mode
- //@{
+ typedef std::map<std::string, bool> UsedFloats;
///
- bool amsstyle;
+ UsedFloats usedFloats_;
///
- bool boldsymbol;
+ typedef std::map<docstring, std::string> FileMap;
///
- bool binom;
- //@}
-
- //@Man: Layouts
- //@{
- std::vector<bool> layout;
- //@}
-
- //@Man: Special features
- //@{
- bool LyXParagraphIndent;
+ 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_;
///
- bool NeedLyXFootnoteCode;
+ BufferParams const & params_;
+ /** Some insets need to know details about the to-be-produced file
+ * in validate().
+ */
+ OutputParams const & runparams_;
///
- bool NeedLyXMinipageIndent;
+ bool in_float_;
///
- typedef std::set<Language const *> LanguageList;
- ///
- LanguageList UsedLanguages;
- //@}
- BufferParams const & bufferParams() const;
-private:
- BufferParams const & params;
+ docstring htmltitle_;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff