X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=927dc312e620b7f450f49931c312b01229e0dcd9;hb=368f6a53a87eb5997433ecd0f51e854c99360d28;hp=9962d17a744d531ed1022ec78ea9958c892e3deb;hpb=3660343dc7da7cb40b93448949dca02a579505d5;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 9962d17a74..927dc312e6 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,132 +1,136 @@ // -*- C++ -*- -/* This file is part of -* ====================================================== -* -* LyX, The Document Processor -* -* Copyright (C) 1995 Matthias Ettrich -* Copyright (C) 1995-1999 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 -#ifdef __GNUG__ -#pragma interface -#endif - -#include +#include "outputparams.h" -#include "LString.h" +#include +#include +#include +#include -class BufferParams; -class LyXTextClass; +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(int n) ; - /// The packaes needed by the document - string getPackages(BufferParams const ¶ms); +/** 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.C and paragraph.C + * when you do so. + */ +class LaTeXFeatures { +public: + /// + LaTeXFeatures(Buffer const &, BufferParams const &, + OutputParams const &); + /// The packages needed by the document + std::string const getPackages() const; /// The macros definitions needed by the document - string getMacros(BufferParams const ¶ms); - /// The definitions needed by the document's textclass - string getTClassPreamble(BufferParams const ¶ms); - - /// - void showStruct(BufferParams ¶ms); - - //@Man: Packages - //@{ - /// - bool color; // color.sty + std::string const getMacros() const; /// - bool graphics; // graphics.sty - /// - bool setspace; // setspace.sty - /// - bool makeidx; // makeind.sty + 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 (docbook) + std::string const getLyXSGMLEntities() const; + /// The SGML Required to include the files added with includeFile(); + std::string 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); + /// The float definitions. + void getFloatDefinitions(std::ostream & os) const; + /// Print requirements to lyxerr + void showStruct() const; /// - bool verbatim; // verbatim.sty + void addExternalPreamble(std::string const &); + /// Provide a string name-space to the requirements + void require(std::string const & name); + /// Which of the required packages are installed? + static void getAvailable(); + /// Is the package required? + bool isRequired(std::string const & name) const; + /// Is the (required) package available? + bool isAvailable(std::string const & name) const; /// - bool longtable; // longtable.sty + void useFloat(std::string const & name); /// - bool algorithm; // algorithm.sty + void useLanguage(Language const *); /// - bool rotating; // rotating.sty + bool hasLanguages() const; /// - bool amssymb; // amssymb.sty + std::string getLanguages() const; /// - bool latexsym; // latexsym.sty + std::set getEncodingSet(std::string const & doc_encoding) const; /// - bool pifont; // pifont.sty + void useLayout(std::string const & lyt); /// - bool subfigure; // subfigure.sty + Buffer const & buffer() const; /// - bool floatflt; // floatflt.sty + void setBuffer(Buffer const &); /// - bool url; // url.sty - //@} + BufferParams const & bufferParams() const; + /// the return value is dependent upon both LyXRC and LaTeXFeatures. + bool useBabel() const; + /// Runparams that will be used for exporting this file. + OutputParams const & runparams() const { return runparams_; } - - //@Man: Commands - //@{ - /// - bool lyx; - /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - //@} - - //@Man: Quotes - //@{ - /// - bool quotesinglbase; +private: + std::list usedLayouts_; + + /// Static preamble bits from the external material insets + typedef std::list FeaturesList; /// - bool quotedblbase; + FeaturesList features_; /// - bool guilsinglleft; + FeaturesList preamble_snippets_; + /// The available (required) packages + typedef std::list PackagesList; /// - bool guilsinglright; + static PackagesList packages_; /// - bool guillemotleft; + typedef std::set LanguageList; /// - bool guillemotright; - //@} - - //@Man: Math mode - //@{ + LanguageList UsedLanguages_; /// - bool amsstyle; + typedef std::set UsedFloats; /// - bool boldsymbol; + UsedFloats usedFloats_; /// - bool binom; - //@} - - //@Man: Layouts - //@{ - vector layout; - //@} - - //@Man: Special features - //@{ - bool LyXParagraphIndent; + typedef std::map FileMap; /// - bool NeedLyXFootnoteCode; + 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 NeedLyXMinipageIndent; - //@} + BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; }; #endif