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         ///
  45         void showStruct();
  46
  47         //@Man: Packages
  48         //@{
  49         ///
  50         bool color;     // color.sty
  51 #ifdef USE_GRAPHICX
  52         ///
  53         bool graphicx; // graphicx.sty
  54 #else
  55         ///
  56         bool graphics;  // graphics.sty
  57 #endif
  58         ///
  59         bool setspace;  // setspace.sty
  60         ///
  61         bool makeidx;   // makeind.sty
  62         ///
  63         bool verbatim;  // verbatim.sty
  64         ///
  65         bool longtable; // longtable.sty
  66         ///
  67         bool algorithm; // algorithm.sty
  68         ///
  69         bool rotating;  // rotating.sty
  70         ///
  71         bool amssymb;   // amssymb.sty
  72         ///
  73         bool latexsym;   // latexsym.sty
  74         ///
  75         bool pifont;    // pifont.sty
  76         ///
  77         bool subfigure; // subfigure.sty
  78         ///
  79         bool floatflt;  // floatflt.sty
  80         ///
  81         bool url;       // url.sty
  82         //@}
  83
  84
  85         //@Man: Commands
  86         //@{
  87         ///
  88         bool lyx;
  89         ///
  90         bool lyxline;
  91         /// \noun
  92         bool noun;
  93         /// \lyxarrow
  94         bool lyxarrow;
  95         //@}
  96
  97         //@Man: Quotes
  98         //@{
  99         ///
 100         bool quotesinglbase;
 101         ///
 102         bool quotedblbase;
 103         ///
 104         bool guilsinglleft;
 105         ///
 106         bool guilsinglright;
 107         ///
 108         bool guillemotleft;
 109         ///
 110         bool guillemotright;
 111         //@}
 112
 113         //@Man: Math mode
 114         //@{
 115         ///
 116         bool amsstyle;
 117         ///
 118         bool boldsymbol;
 119         ///
 120         bool binom;
 121         //@}
 122
 123         //@Man: Layouts
 124         //@{
 125         std::vector<bool> layout;
 126         //@}
 127
 128         //@Man: Special features
 129         //@{
 130         bool LyXParagraphIndent;
 131         ///
 132         bool NeedLyXFootnoteCode;
 133         ///
 134         bool NeedLyXMinipageIndent;
 135         ///
 136         typedef std::set<Language const *> LanguageList;
 137         ///
 138         LanguageList UsedLanguages;
 139         //@}
 140         BufferParams const & bufferParams() const;
 141 private:
 142         BufferParams const & params;
 143 };
 144
 145 #endif