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
  16 #include "Changes.h"
  17
  18 #include <memory>
  19
  20
  21 namespace lyx {
  22
  23
  24 class Encoding;
  25 class ExportData;
  26 class Font;
  27 class Language;
  28
  29 class OutputParams {
  30 public:
  31         enum FLAVOR {
  32                 DVILUATEX,
  33                 LATEX,
  34                 LUATEX,
  35                 PDFLATEX,
  36                 XETEX,
  37                 XML,
  38                 HTML,
  39                 TEXT,
  40                 LYX
  41         };
  42
  43         enum MathFlavor {
  44                 NotApplicable,
  45                 MathAsMathML,
  46                 MathAsHTML,
  47                 MathAsImages,
  48                 MathAsLaTeX
  49         };
  50
  51         enum TableCell {
  52                 NO,
  53                 PLAIN,
  54                 ALIGNED
  55         };
  56
  57         enum Float {
  58                 NONFLOAT,
  59                 MAINFLOAT,
  60                 SUBFLOAT
  61         };
  62
  63         OutputParams(Encoding const *);
  64         ~OutputParams();
  65
  66         /** The file that we export depends occasionally on what is to
  67             compile the file.
  68         */
  69         FLAVOR flavor;
  70         /// is it some flavor of LaTeX?
  71         bool isLaTeX() const;
  72         /// does this flavour support full unicode?
  73         bool isFullUnicode() const;
  74
  75         /// Same, but for math output, which only matter is XHTML output.
  76         MathFlavor math_flavor;
  77
  78         /** Are we to write a 'nice' LaTeX file or not.
  79             This esentially seems to mean whether InsetInclude, InsetGraphics
  80             and InsetExternal should add the absolute path to any external
  81             files or not.
  82             Non-nice LaTeX also includes additional safe line breaks in order to
  83             increase the precision of forward/reverse search and error reporting.
  84         */
  85         bool nice;
  86
  87         /** Is this a real child (i.e., compiled as a child)?
  88             This depends on wherefrom we export the buffer. Even children
  89             that have a master can be compiled standalone.
  90         */
  91         mutable bool is_child;
  92
  93         /** moving_arg == true means that the environment in which the inset
  94             is typeset is a moving argument. The inset should take care about
  95             fragile commands by preceding the latex with \\protect.
  96         */
  97         bool moving_arg;
  98
  99         /** intitle == true means that the environment in which the
 100             inset is typeset is part of a title (before a \\maketitle).
 101             Footnotes in such environments have moving arguments.
 102         */
 103         bool intitle;
 104
 105         /** inulemcmd > 0 means that the environment in which the
 106             inset is typeset is part of a ulem command (\uline, \uuline,
 107             \uwave, or \sout). Insets that output latex commands relying
 108             on local assignments (such as \cite) should enclose such
 109             commands in \mbox{} in order to avoid breakage.
 110         */
 111         mutable int inulemcmd;
 112
 113         /** the font at the point where the inset is
 114          */
 115         Font const * local_font;
 116
 117         /** Document language babel name
 118          */
 119         std::string document_language;
 120
 121         /** The master language. Non-null only for child documents.
 122             Note that this is not the language of the top level master, but
 123             of the direct parent for nested includes.
 124          */
 125         mutable Language const * master_language;
 126
 127         /** Current stream encoding. Only used for LaTeX.
 128             This must be set to the document encoding (via the constructor)
 129             before output starts. Afterwards it must be kept up to date for
 130             each single character (\sa Paragraph::latex).
 131             This does also mean that you need to set it back if you use a
 132             copy (e.g. in insets): \code
 133             int InsetFoo::latex(..., OutputParams const & runparams_in) const
 134             {
 135                 OutputParams runparams(runparams_in);
 136                 runparams.inComment = true;
 137                 ...
 138                 InsetBla::latex(..., runparams);
 139                 ...
 140                 runparams_in.encoding = runparams.encoding;
 141             }
 142             \endcode
 143          */
 144         mutable Encoding const * encoding;
 145
 146         /** free_spacing == true means that the inset is in a free-spacing
 147             paragraph.
 148         */
 149         bool free_spacing;
 150
 151         /** This var is set by the return value from BufferParams::writeLaTeX
 152         */
 153         bool use_babel;
 154
 155         /** Do we use polyglossia (instead of babel)?
 156         */
 157         bool use_polyglossia;
 158
 159         /** Are we generating multiple indices?
 160         */
 161         bool use_indices;
 162
 163         /** Are we using japanese (pLaTeX)?
 164         */
 165         bool use_japanese;
 166
 167         /** Customized bibtex_command
 168         */
 169         std::string bibtex_command;
 170
 171         /** Customized index_command
 172         */
 173         std::string index_command;
 174
 175         /** Line length to use with plaintext or LaTeX export.
 176         */
 177         size_type linelen;
 178
 179         /** The depth of the current paragraph, set for plaintext
 180          *  export and used by InsetTabular
 181          */
 182         int depth;
 183
 184         /** Export data filled in by the latex(), docbook() etc methods.
 185             This is a hack: Make it possible to add stuff to constant
 186             OutputParams instances.
 187         */
 188         std::shared_ptr<ExportData> exportdata;
 189
 190         /** Whether we are entering a display math inset.
 191          *  Needed to correctly strike out deleted math in change tracking.
 192          */
 193         mutable bool inDisplayMath;
 194
 195         /** Whether we are leaving a display math inset.
 196          *  Needed to correctly track nested ulem commands in change tracking.
 197          */
 198         mutable bool wasDisplayMath;
 199
 200         /** Whether we are inside a comment inset. Insets that are including
 201          *  external files like InsetGraphics, InsetInclude and InsetExternal
 202          *  may only write the usual output and must not attempt to do
 203          *  something with the included files (e.g. copying, converting)
 204          *  if this flag is true, since they may not exist.
 205          */
 206         bool inComment;
 207
 208         /** Whether a btUnit (for multiple biblographies) is open.
 209          */
 210         bool openbtUnit;
 211
 212         /** Whether we are in a table cell.
 213          *  For newline, it matters whether its content is aligned or not.
 214          */
 215         TableCell inTableCell;
 216
 217         /** Whether we are inside a float or subfloat.
 218          *  Needed for subfloat detection on the command line.
 219          */
 220         Float inFloat;
 221
 222         /** Whether we are inside an index inset.
 223          *  ERT needs to know this, due to the active chars.
 224          */
 225         bool inIndexEntry;
 226
 227         /** Whether we are inside an IPA inset.
 228          *  Needed for proper IPA output.
 229          */
 230         bool inIPA;
 231
 232         /** Whether we are inside an inset that is logically deleted.
 233          *  A value > 0 indicates a deleted inset.
 234          */
 235         int inDeletedInset;
 236
 237         /** The change information of the outermost logically deleted inset.
 238          *  changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
 239          */
 240         Change changeOfDeletedInset;
 241
 242         /** allow output of only part of the top-level paragraphs
 243          *  par_begin: beginning paragraph
 244          */
 245         mutable pit_type par_begin;
 246
 247         /** allow output of only part of the top-level paragraphs
 248          *  par_end: par_end-1 is the ending paragraph
 249          *  if par_begin=par_end, output all paragraphs
 250          */
 251         mutable pit_type par_end;
 252
 253         /// Id of the last paragraph before an inset
 254         mutable int lastid;
 255
 256         /// Last position in the last paragraph before an inset
 257         mutable pos_type lastpos;
 258
 259         /// is this the last paragraph in the current buffer/inset?
 260         bool isLastPar;
 261
 262
 263         /** whether or not do actual file copying and image conversion
 264          *  This mode will be used to preview the source code
 265          */
 266         bool dryrun;
 267
 268         /// whether to display output errors or not
 269         bool silent;
 270
 271         /// Should we output verbatim or escape LaTeX's special chars?
 272         bool pass_thru;
 273
 274         /// Should we output verbatim specific chars?
 275         docstring pass_thru_chars;
 276
 277         /// Should we output captions?
 278         bool html_disable_captions;
 279
 280         /// Are we already in a paragraph?
 281         bool html_in_par;
 282
 283         /// Does the present context even permit paragraphs?
 284         bool html_make_pars;
 285
 286         /// Are we generating this material for inclusion in a TOC-like entity?
 287         bool for_toc;
 288
 289         /// Are we generating this material for inclusion in a tooltip?
 290         bool for_tooltip;
 291
 292         /// Are we generating this material for use by advanced search?
 293         bool for_search;
 294
 295         /// Are we generating this material for instant preview?
 296         bool for_preview;
 297
 298         /// Include all children notwithstanding the use of \includeonly
 299         bool includeall;
 300
 301         /// Explicit output folder, if any is desired
 302         std::string export_folder;
 303 };
 304
 305
 306 } // namespace lyx
 307
 308 #endif // NOT OUTPUTPARAMS_H