X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=92279ebfc0963767bb2896f86c5407151c5e11aa;hb=98c966c64594611e469313314abd1e59524adb4a;hp=48c4bc198eba806b0ce737fabcd0189b6b8d5e08;hpb=9e7821d35b62b8b701ef9b561bfe66c2ddf32998;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 48c4bc198e..92279ebfc0 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,11 +1,11 @@ // -*- C++ -*- /* This file is part of -* ====================================================== -* +* ====================================================== +* * LyX, The Document Processor -* +* * Copyright 1995 Matthias Ettrich -* Copyright 1995-2000 the LyX Team. +* Copyright 1995-2001 the LyX Team. * * ====================================================== */ @@ -17,152 +17,98 @@ #pragma interface #endif -#include -#include +#include "support/types.h" #include "LString.h" -class BufferParams; -class LyXTextClass; +#include +#include +#include +#include + +class BufferParams; struct 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 macros definitions needed by the document - string getMacros(); - /// The definitions needed by the document's textclass - string getTClassPreamble(); - /// - string getIncludedFiles(); +/** 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). - /// - void showStruct(); + 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(BufferParams const &); + /// The packages needed by the document + 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; + /// The sgml definitions needed by the document (dobook/linuxdoc) + string const getLyXSGMLEntities() const; + /// The SGML Required to include the files added with includeFile(); + string const getIncludedFiles(string const & fname) const; + /// Include a file for use with the SGML entities + void includeFile(string const & key, string const & name); + /// The float definitions. + void getFloatDefinitions(std::ostream & os) const; + /// Print requirements to lyxerr + void showStruct() const; + /// + void addExternalPreamble(string const &); /// 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 array; - /// - bool color; // color.sty -#ifdef USE_GRAPHICX - /// - bool graphicx; // graphicx.sty -#else - /// - bool graphics; // graphics.sty -#endif - /// - bool setspace; // setspace.sty - /// - bool makeidx; // makeind.sty - /// - bool verbatim; // verbatim.sty - /// - bool longtable; // longtable.sty + /// Is the package required? + bool isRequired(string const & name) const; /// - bool algorithm; // algorithm.sty + void useFloat(string const & name); /// - bool rotating; // rotating.sty + void useLanguage(Language const *); /// - bool amssymb; // amssymb.sty + bool hasLanguages(); /// - bool latexsym; // latexsym.sty + string getLanguages() const; /// - bool pifont; // pifont.sty + std::set getEncodingSet(string const & doc_encoding); /// - bool subfigure; // subfigure.sty + void useLayout(string const & lyt); /// - bool floatflt; // floatflt.sty - /// - bool url; // url.sty - /// - bool varioref; // varioref.sty - /// - bool prettyref; // prettyref.sty + BufferParams const & bufferParams() const; /// - bool chess; // chess.sty - //@} - - //@Man: Commands - //@{ - /// - bool lyx; - /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - //@} - - //@Man: Quotes - //@{ - /// - bool quotesinglbase; - /// - bool quotedblbase; - /// - bool guilsinglleft; - /// - bool guilsinglright; - /// - bool guillemotleft; - /// - bool guillemotright; - //@} - - //@Man: Math mode - //@{ - /// - bool amsstyle; - /// - bool boldsymbol; - /// - bool binom; - //@} - - //@Man: Layouts - //@{ - std::vector layout; - //@} - - //@Man: Special features - //@{ - bool LyXParagraphIndent; - /// - bool NeedLyXFootnoteCode; +private: + string externalPreambles; + + std::set layout; + + /// Static preamble bits from the external material insets + + + typedef std::list FeaturesList; /// - bool NeedLyXMinipageIndent; + FeaturesList features; /// typedef std::set LanguageList; /// LanguageList UsedLanguages; /// - typedef std::set FloatList; + typedef std::set UsedFloats; /// - FloatList usedFloats; + UsedFloats usedFloats; /// typedef std::map FileMap; /// FileMap IncludedFiles; - //@} - BufferParams const & bufferParams() const; -private: + /// + /// BufferParams const & params; };