src/OutputParams.h

   1 // -*- C++ -*-
   2 /**
   3  * \file OutputParams.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  *  \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef OUTPUTPARAMS_H
  13 #define OUTPUTPARAMS_H
  14
  15 #include <string>
  16
  17 #include "support/types.h"
  18 #include <boost/shared_ptr.hpp>
  19 #include "Changes.h"
  20
  21
  22 namespace lyx {
  23
  24
  25 class Encoding;
  26 class ExportData;
  27 class Font;
  28
  29
  30 class OutputParams {
  31 public:
  32         enum FLAVOR {
  33                 LATEX,
  34                 PDFLATEX,
  35                 XETEX,
  36                 XML
  37         };
  38
  39         enum TableCell {
  40                 NO,
  41                 PLAIN,
  42                 ALIGNED
  43         };
  44
  45         enum Float {
  46                 NONFLOAT,
  47                 MAINFLOAT,
  48                 SUBFLOAT
  49         };
  50
  51         OutputParams(Encoding const *);
  52         ~OutputParams();
  53
  54         /** The latex that we export depends occasionally on what is to
  55             compile the file.
  56         */
  57         FLAVOR flavor;
  58
  59         /** Are we to write a 'nice' LaTeX file or not.
  60             This esentially seems to mean whether InsetInclude, InsetGraphics
  61             and InsetExternal should add the absolute path to any external
  62             files or not.
  63         */
  64         bool nice;
  65
  66         /** moving_arg == true means that the environment in which the inset
  67             is typeset is a moving argument. The inset should take care about
  68             fragile commands by preceding the latex with \\protect.
  69         */
  70         bool moving_arg;
  71
  72         /** intitle == true means that the environment in which the
  73             inset is typeset is part of a title (before a \\maketitle).
  74             Footnotes in such environments have moving arguments.
  75         */
  76         bool intitle;
  77
  78         /** inulemcmd == true means that the environment in which the
  79             inset is typeset is part of a ulem command (\uline, \uuline,
  80             \uwave, or \sout). Insets that output latex commands relying
  81             on local assignments (such as \cite) should enclose such
  82             commands in \mbox{} in order to avoid breakage.
  83         */
  84         mutable bool inulemcmd;
  85
  86         /** the font at the point where the inset is
  87          */
  88         Font const * local_font;
  89
  90         /** Document language babel name
  91          */
  92         mutable std::string document_language;
  93
  94         /** Current stream encoding. Only used for LaTeX.
  95             This must be set to the document encoding (via the constructor)
  96             before output starts. Afterwards it must be kept up to date for
  97             each single character (\sa Paragraph::latex).
  98             This does also mean that you need to set it back if you use a
  99             copy (e.g. in insets): \code
 100             int InsetFoo::latex(..., OutputParams const & runparams_in) const
 101             {
 102                 OutputParams runparams(runparams_in);
 103                 runparams.inComment = true;
 104                 ...
 105                 InsetBla::latex(..., runparams);
 106                 ...
 107                 runparams_in.encoding = runparams.encoding;
 108             }
 109             \endcode
 110          */
 111         mutable Encoding const * encoding;
 112
 113         /** free_spacing == true means that the inset is in a free-spacing
 114             paragraph.
 115         */
 116         bool free_spacing;
 117
 118         /** This var is set by the return value from BufferParams::writeLaTeX
 119         */
 120         bool use_babel;
 121
 122         /** Are we generating multiple indices?
 123         */
 124         bool use_indices;
 125
 126         /** Are we using japanese (pLaTeX)?
 127         */
 128         bool use_japanese;
 129
 130         /** Customized bibtex_command
 131         */
 132         mutable std::string bibtex_command;
 133
 134         /** Customized index_command
 135         */
 136         mutable std::string index_command;
 137
 138         /** Line length to use with plaintext export.
 139         */
 140         size_type linelen;
 141
 142         /** The depth of the current paragraph, set for plaintext
 143          *  export and used by InsetTabular
 144          */
 145         int depth;
 146
 147         /** Export data filled in by the latex(), docbook() etc methods.
 148             This is a hack: Make it possible to add stuff to constant
 149             OutputParams instances.
 150         */
 151         boost::shared_ptr<ExportData> exportdata;
 152
 153         /** Whether we are inside a comment inset. Insets that are including
 154          *  external files like InsetGraphics, InsetInclude and InsetExternal
 155          *  may only write the usual output and must not attempt to do
 156          *  something with the included files (e.g. copying, converting)
 157          *  if this flag is true, since they may not exist.
 158          */
 159         bool inComment;
 160
 161         /** Whether we are in a table cell.
 162          *  For newline, it matters whether its content is aligned or not.
 163          */
 164         TableCell inTableCell;
 165
 166         /** Whether we are inside a float or subfloat.
 167          *  Needed for subfloat detection on the command line.
 168          */
 169         Float inFloat;
 170
 171         /** Whether we are inside an inset that is logically deleted.
 172          *  A value > 0 indicates a deleted inset.
 173          */
 174         int inDeletedInset;
 175
 176         /** The change information of the outermost logically deleted inset.
 177          *  changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
 178          */
 179         Change changeOfDeletedInset;
 180
 181         /** allow output of only part of the top-level paragraphs
 182          *  par_begin: beginning paragraph
 183          */
 184         pit_type par_begin;
 185
 186         /** allow output of only part of the top-level paragraphs
 187          *  par_end: par_end-1 is the ending paragraph
 188          *  if par_begin=par_end, output all paragraphs
 189          */
 190         pit_type par_end;
 191
 192         /// is this the last paragraph in the current buffer/inset?
 193         bool isLastPar;
 194
 195         /** whether or not do actual file copying and image conversion
 196          *  This mode will be used to preview the source code
 197          */
 198         bool dryrun;
 199         /// Should we output verbatim or escape LaTeX's special chars?
 200         bool verbatim;
 201         /// Should we output captions? (Used in HTML output.)
 202         bool disable_captions;
 203 };
 204
 205
 206 } // namespace lyx
 207
 208 #endif // NOT OUTPUTPARAMS_H