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         /** need_maketitle == true means that the last layout was a title layout
 106          * this is to track when \maketitle needs to be output.
 107         */
 108         mutable bool need_maketitle;
 109
 110         /** have_maketitle == true means that \maketitle already hase been output.
 111         */
 112         mutable bool have_maketitle;
 113
 114         /** inbranch == true means that the environment being typeset
 115             is inside an active branch inset.
 116         */
 117         bool inbranch;
 118
 119         /** inulemcmd > 0 means that the environment in which the
 120             inset is typeset is part of a ulem command (\uline, \uuline,
 121             \uwave, \sout  or \xout). Insets that output latex commands relying
 122             on local assignments (such as \cite) should enclose such
 123             commands in \mbox{} in order to avoid breakage.
 124         */
 125         mutable int inulemcmd;
 126
 127         /** the font at the point where the inset is
 128          */
 129         Font const * local_font;
 130
 131         /** Document language babel name
 132          */
 133         std::string document_language;
 134
 135         /** The master language. Non-null only for child documents.
 136             Note that this is not the language of the top level master, but
 137             of the direct parent for nested includes.
 138          */
 139         mutable Language const * master_language;
 140
 141         /** Current stream encoding. Only used for LaTeX.
 142             This must be set to the document encoding (via the constructor)
 143             before output starts. Afterwards it must be kept up to date for
 144             each single character (\sa Paragraph::latex).
 145             This does also mean that you need to set it back if you use a
 146             copy (e.g. in insets): \code
 147             int InsetFoo::latex(..., OutputParams const & runparams_in) const
 148             {
 149                 OutputParams runparams(runparams_in);
 150                 runparams.inComment = true;
 151                 ...
 152                 InsetBla::latex(..., runparams);
 153                 ...
 154                 runparams_in.encoding = runparams.encoding;
 155             }
 156             \endcode
 157          */
 158         mutable Encoding const * encoding;
 159
 160         /** free_spacing == true means that the inset is in a free-spacing
 161             paragraph.
 162         */
 163         bool free_spacing;
 164
 165         /** This var is set by the return value from BufferParams::writeLaTeX
 166         */
 167         bool use_babel;
 168
 169         /** Do we use polyglossia (instead of babel)?
 170         */
 171         bool use_polyglossia;
 172
 173         /** Do we use hyperref?
 174         */
 175         bool use_hyperref;
 176
 177         /** Are we generating multiple indices?
 178         */
 179         bool use_indices;
 180
 181         /** Are we using japanese (pLaTeX)?
 182         */
 183         bool use_japanese;
 184
 185         /** Customized bibtex_command
 186         */
 187         std::string bibtex_command;
 188
 189         /** Customized index_command
 190         */
 191         std::string index_command;
 192
 193         /** Hyperref driver
 194         */
 195         std::string hyperref_driver;
 196
 197         /** Line length to use with plaintext or LaTeX export.
 198         */
 199         size_type linelen;
 200
 201         /** The depth of the current paragraph, set for plaintext
 202          *  export and used by InsetTabular
 203          */
 204         int depth;
 205
 206         /** Export data filled in by the latex(), docbook() etc methods.
 207             This is a hack: Make it possible to add stuff to constant
 208             OutputParams instances.
 209         */
 210         std::shared_ptr<ExportData> exportdata;
 211
 212         /** Whether we are entering a display math inset.
 213          *  Needed to correctly strike out deleted math in change tracking.
 214          */
 215         mutable bool inDisplayMath;
 216
 217         /** Whether we are leaving a display math inset.
 218          *  Needed to correctly track nested ulem commands in change tracking.
 219          */
 220         mutable bool wasDisplayMath;
 221
 222         /** Whether we are inside a comment inset. Insets that are including
 223          *  external files like InsetGraphics, InsetInclude and InsetExternal
 224          *  may only write the usual output and must not attempt to do
 225          *  something with the included files (e.g. copying, converting)
 226          *  if this flag is true, since they may not exist.
 227          */
 228         bool inComment;
 229
 230         /** Whether a btUnit (for multiple biblographies) is open.
 231          */
 232         mutable bool openbtUnit;
 233
 234         /** Process only the children's aux files with BibTeX.
 235          *  This is necessary with chapterbib.
 236          */
 237         bool only_childbibs;
 238
 239         /** Whether we are in a table cell.
 240          *  For newline, it matters whether its content is aligned or not.
 241          */
 242         TableCell inTableCell;
 243
 244         /** Whether we are inside a float or subfloat.
 245          *  Needed for subfloat detection on the command line.
 246          */
 247         Float inFloat;
 248
 249         /** Whether we are inside an index inset.
 250          *  ERT needs to know this, due to the active chars.
 251          */
 252         bool inIndexEntry;
 253
 254         /** Whether we are inside an IPA inset.
 255          *  Needed for proper IPA output.
 256          */
 257         bool inIPA;
 258
 259         /** Whether we are inside an inset that is logically deleted.
 260          *  A value > 0 indicates a deleted inset.
 261          */
 262         int inDeletedInset;
 263
 264         /** The change information of the outermost logically deleted inset.
 265          *  changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
 266          */
 267         Change changeOfDeletedInset;
 268
 269         /** allow output of only part of the top-level paragraphs
 270          *  par_begin: beginning paragraph
 271          */
 272         mutable pit_type par_begin;
 273
 274         /** allow output of only part of the top-level paragraphs
 275          *  par_end: par_end-1 is the ending paragraph
 276          *  if par_begin=par_end, output all paragraphs
 277          */
 278         mutable pit_type par_end;
 279
 280         /// Id of the last paragraph before an inset
 281         mutable int lastid;
 282
 283         /// Last position in the last paragraph before an inset
 284         mutable pos_type lastpos;
 285
 286         /// is this the last paragraph in the current buffer/inset?
 287         bool isLastPar;
 288
 289
 290         /** whether or not to do actual file copying and image conversion
 291          *  This mode will be used to preview the source code
 292          */
 293         bool dryrun;
 294
 295         /// whether to display output errors or not
 296         bool silent;
 297
 298         /// Should we output verbatim or escape LaTeX's special chars?
 299         bool pass_thru;
 300
 301         /// Should we output verbatim specific chars?
 302         docstring pass_thru_chars;
 303
 304         /// Should we output captions?
 305         bool html_disable_captions;
 306
 307         /// Are we already in a paragraph?
 308         bool html_in_par;
 309
 310         /// Does the present context even permit paragraphs?
 311         bool html_make_pars;
 312
 313         /// Are we generating this material for inclusion in a TOC-like entity?
 314         bool for_toc;
 315
 316         /// Are we generating this material for inclusion in a tooltip?
 317         bool for_tooltip;
 318
 319         /// Are we generating this material for use by advanced search?
 320         bool for_search;
 321
 322         /// Are we generating this material for instant preview?
 323         bool for_preview;
 324
 325         /// Include all children notwithstanding the use of \includeonly
 326         bool includeall;
 327
 328         /// Explicit output folder, if any is desired
 329         std::string export_folder;
 330 };
 331
 332
 333 } // namespace lyx
 334
 335 #endif // NOT OUTPUTPARAMS_H