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