X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=7f010b33ca94522ba397e4ff098683c600a7df1c;hb=823e44822e6638824900eee2f7e2e7165af97f8d;hp=7926fa206d62a84e21e305f0f4aaa4dd78754156;hpb=e952d33e0b702265cdac14de9871ecbfcf34863d;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 7926fa206d..7f010b33ca 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,157 +1,161 @@ // -*- C++ -*- -/* This file is part of -* ====================================================== -* -* LyX, The Document Processor -* -* Copyright 1995 Matthias Ettrich -* Copyright 1995-2001 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 #include +#include +#include +#include + -#include "LString.h" -#include "layout.h" +namespace lyx { -class BufferParams; -struct Language; +class Buffer; +class BufferParams; +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 &, LyXTextClass::size_type n) ; - /// The packaes needed by the document - string const getPackages() const; +/** The packages and commands that a buffer needs. This class + * contains a list. 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 const getMacros() const; - /// The definitions needed by the document's textclass - string const getTClassPreamble() const; - /// - string const getIncludedFiles(string const & fname) const; + std::string const getMacros() const; /// + std::string const getBabelOptions() 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) 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(std::ostream & os) const; - - /// + /// Print requirements to lyxerr void showStruct() const; - - /// Provide a string name-space to the requirements - void require(string const & name); - - /// Static preamble bits from the external material insets - string externalPreambles; - - /// - bool array; - /// - bool color; // color.sty - /// - bool graphicx; // graphicx.sty - /// - bool graphics; // graphics.sty - /// - bool setspace; // setspace.sty - /// - bool makeidx; // makeind.sty - /// - bool verbatim; // verbatim.sty - /// - bool longtable; // longtable.sty - /// - //bool algorithm; // algorithm.sty - /// - bool rotating; // rotating.sty /// - bool amssymb; // amssymb.sty + void addPreambleSnippet(std::string const &); + /// Add a feature name requirements + void require(std::string const & name); + /// Add a set of feature names requirements + void require(std::set 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 latexsym; // latexsym.sty + void useFloat(std::string const & name, bool subfloat = false); /// - bool pifont; // pifont.sty + void useLanguage(Language const *); /// - bool subfigure; // subfigure.sty + bool hasLanguages() const; /// - bool floatflt; // floatflt.sty + std::string getLanguages() const; /// - bool url; // url.sty + std::set getEncodingSet(std::string const & doc_encoding) const; /// - bool varioref; // varioref.sty + void useLayout(docstring const & lyt); /// - bool prettyref; // prettyref.sty + Buffer const & buffer() const; /// - bool chess; // chess.sty + void setBuffer(Buffer const &); /// - bool natbib; // natbib.sty - /// - bool floats; // float.sty - - /// - bool lyx; - /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - - /// - bool quotesinglbase; - /// - bool quotedblbase; - /// - bool guilsinglleft; - /// - bool guilsinglright; - /// - bool guillemotleft; - /// - bool guillemotright; + 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_; } - /// - bool amsstyle; - /// - bool boldsymbol; - /// - bool binom; - - std::vector layout; +private: + std::list usedLayouts_; + /// The features that are needed by the document + typedef std::set Features; /// - bool ParagraphIndent; + Features features_; + /// Static preamble bits from the external material insets + typedef std::list SnippetList; /// - bool NeedLyXFootnoteCode; + SnippetList preamble_snippets_; + /// The available (required) packages + typedef std::set Packages; /// - bool NeedLyXMinipageIndent; + static Packages packages_; /// typedef std::set LanguageList; + /// used languages (only those that are supported by babel) + LanguageList UsedLanguages_; /// - LanguageList UsedLanguages; + typedef std::map UsedFloats; /// - typedef std::set UsedFloats; + UsedFloats usedFloats_; /// - UsedFloats usedFloats; + typedef std::map FileMap; /// - typedef std::map 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_; /// - FileMap IncludedFiles; + BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; /// - BufferParams const & bufferParams() const; -private: - /// - BufferParams const & params; + bool in_float_; }; + +} // namespace lyx + #endif