src/LaTeXFeatures.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3 * ======================================================
   4 *
   5 *           LyX, The Document Processor
   6 *
   7 *           Copyright 1995 Matthias Ettrich
   8 *           Copyright 1995-2000 the LyX Team.
   9 *
  10 * ====================================================== */
  11
  12 #ifndef LATEXFEATURES_H
  13 #define LATEXFEATURES_H
  14
  15
  16 #ifdef __GNUG__
  17 #pragma interface
  18 #endif
  19
  20 #include <vector>
  21 #include <set>
  22
  23 #include "LString.h"
  24
  25 class BufferParams;
  26 class LyXTextClass;
  27 struct Language;
  28
  29 /** The packages and commands that a buffer needs. This struct
  30   contains an entry for each of the latex packages and
  31   commands that a buffer might need. This struct is supposed to be
  32   extended as the need arises. Remember to update the validate function
  33   in buffer.C and paragraph.C when you do so. */
  34 struct LaTeXFeatures {
  35         ///
  36         LaTeXFeatures(BufferParams const &, int n) ;
  37         /// The packaes needed by the document
  38         string getPackages();
  39         /// The macros definitions needed by the document
  40         string getMacros();
  41         /// The definitions needed by the document's textclass
  42         string getTClassPreamble();
  43         ///
  44         string getIncludedFiles();
  45
  46         ///
  47         void showStruct();
  48
  49         /// Provide a string name-space to the requirements
  50         void require(string const & name);
  51
  52         /// Static preamble bits from the external material insets
  53         string externalPreambles;
  54
  55         //@Man: Packages
  56         //@{
  57         ///
  58         bool array;
  59         ///
  60         bool color;     // color.sty
  61 #ifdef USE_GRAPHICX
  62         ///
  63         bool graphicx; // graphicx.sty
  64 #else
  65         ///
  66         bool graphics;  // graphics.sty
  67 #endif
  68         ///
  69         bool setspace;  // setspace.sty
  70         ///
  71         bool makeidx;   // makeind.sty
  72         ///
  73         bool verbatim;  // verbatim.sty
  74         ///
  75         bool longtable; // longtable.sty
  76         ///
  77         bool algorithm; // algorithm.sty
  78         ///
  79         bool rotating;  // rotating.sty
  80         ///
  81         bool amssymb;   // amssymb.sty
  82         ///
  83         bool latexsym;   // latexsym.sty
  84         ///
  85         bool pifont;    // pifont.sty
  86         ///
  87         bool subfigure; // subfigure.sty
  88         ///
  89         bool floatflt;  // floatflt.sty
  90         ///
  91         bool url;       // url.sty
  92         ///
  93         bool varioref;  // varioref.sty
  94         ///
  95         bool prettyref; // prettyref.sty
  96         ///
  97         bool chess;     // chess.sty
  98         //@}
  99
 100
 101         //@Man: Commands
 102         //@{
 103         ///
 104         bool lyx;
 105         ///
 106         bool lyxline;
 107         /// \noun
 108         bool noun;
 109         /// \lyxarrow
 110         bool lyxarrow;
 111         //@}
 112
 113         //@Man: Quotes
 114         //@{
 115         ///
 116         bool quotesinglbase;
 117         ///
 118         bool quotedblbase;
 119         ///
 120         bool guilsinglleft;
 121         ///
 122         bool guilsinglright;
 123         ///
 124         bool guillemotleft;
 125         ///
 126         bool guillemotright;
 127         //@}
 128
 129         //@Man: Math mode
 130         //@{
 131         ///
 132         bool amsstyle;
 133         ///
 134         bool boldsymbol;
 135         ///
 136         bool binom;
 137         //@}
 138
 139         //@Man: Layouts
 140         //@{
 141         std::vector<bool> layout;
 142         //@}
 143
 144         //@Man: Special features
 145         //@{
 146         bool LyXParagraphIndent;
 147         ///
 148         bool NeedLyXFootnoteCode;
 149         ///
 150         bool NeedLyXMinipageIndent;
 151         ///
 152         typedef std::set<Language const *> LanguageList;
 153         ///
 154         LanguageList UsedLanguages;
 155         ///
 156         typedef std::set<string> FloatList;
 157         ///
 158         FloatList usedFloats;
 159         ///
 160         typedef std::map<string , string> FileMap;
 161         ///
 162         FileMap IncludedFiles;
 163         //@}
 164         BufferParams const & bufferParams() const;
 165 private:
 166         BufferParams const & params;
 167 };
 168
 169 #endif