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