4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
12 #ifndef OUTPUTPARAMS_H
13 #define OUTPUTPARAMS_H
32 enum class Flavor : int {
44 enum class CtObject : int {
75 OutputParams(Encoding const *);
78 /** The file that we export depends occasionally on what is to
81 Flavor flavor = Flavor::LaTeX;
82 /// is it some flavor of LaTeX?
84 /// does this flavour support full unicode?
85 bool isFullUnicode() const;
86 /// Do we use the bidi package (which does some reordering and stuff)?
87 bool useBidiPackage() const;
89 /// Same, but for math output, which only matter is XHTML output.
90 MathFlavor math_flavor = NotApplicable;
92 /** Are we to write a 'nice' LaTeX file or not.
93 This essentially seems to mean whether InsetInclude, InsetGraphics
94 and InsetExternal should add the absolute path to any external
96 Non-nice LaTeX also includes additional safe line breaks in order to
97 increase the precision of forward/reverse search and error reporting.
101 /** Is this a real child (i.e., compiled as a child)?
102 This depends on wherefrom we export the buffer. Even children
103 that have a master can be compiled standalone.
105 mutable bool is_child = false;
107 /** moving_arg == true means that the environment in which the inset
108 is typeset is a moving argument. The inset should take care about
109 fragile commands by preceding the latex with \\protect.
111 bool moving_arg = false;
113 /** intitle == true means that the environment in which the
114 inset is typeset is part of a title (before a \\maketitle).
115 Footnotes in such environments have moving arguments.
117 bool intitle = false;
119 /** need_maketitle == true means that the last layout was a title layout
120 * this is to track when \maketitle needs to be output.
122 mutable bool need_maketitle = false;
124 /** have_maketitle == true means that \maketitle already hase been output.
126 mutable bool have_maketitle = false;
128 /** inbranch == true means that the environment being typeset
129 is inside an active branch inset.
131 bool inbranch = false;
133 /** inulemcmd > 0 means that the environment in which the
134 inset is typeset is part of a ulem or soul command (e.g., \uline,
135 \uuline, \uwave, \sout or \xout). Insets that output latex commands
136 relying on local assignments (such as \cite) should enclose such
137 commands in \mbox{} in order to avoid breakage.
139 mutable int inulemcmd = 0;
141 /** the font at the point where the inset is
143 Font const * local_font = nullptr;
145 /** Document language lyx name
147 std::string document_language;
149 /// main font encoding of the document
150 std::string main_fontenc;
152 /** The master language. Non-null only for child documents.
153 Note that this is not the language of the top level master, but
154 of the direct parent for nested includes.
156 mutable Language const * master_language = nullptr;
158 /// Active characters
159 std::string active_chars;
161 /** Current stream encoding. Only used for LaTeX.
162 This must be set to the document encoding (via the constructor)
163 before output starts. Afterwards it must be kept up to date for
164 each single character (\sa Paragraph::latex).
165 This does also mean that you need to set it back if you use a
166 copy (e.g. in insets): \code
167 int InsetFoo::latex(..., OutputParams const & runparams_in) const
169 OutputParams runparams(runparams_in);
170 runparams.inComment = true;
172 InsetBla::latex(..., runparams);
174 runparams_in.encoding = runparams.encoding;
178 mutable Encoding const * encoding;
180 /** free_spacing == true means that the inset is in a free-spacing
183 bool free_spacing = false;
185 /** This var is set by the return value from BufferParams::writeLaTeX
187 bool use_babel = false;
189 /** Do we use polyglossia (instead of babel)?
191 bool use_polyglossia = false;
193 /** Do we use hyperref?
195 bool use_hyperref = false;
197 /// Do we use the CJK package?
198 bool use_CJK = false;
200 /** Are we generating multiple indices?
202 bool use_indices = false;
204 /** Are we using japanese (pLaTeX)?
206 bool use_japanese = false;
208 /** Customized bibtex_command
210 std::string bibtex_command;
212 /** Customized index_command
214 std::string index_command;
218 std::string hyperref_driver;
220 /** Line length to use with plaintext or LaTeX export.
222 size_type linelen = 0;
224 /** The depth of the current paragraph, set for plaintext
225 * export and used by InsetTabular
229 /** Export data filled in by the latex(), docbook(), etc. methods.
230 This is a hack: Make it possible to add stuff to constant
231 OutputParams instances.
233 std::shared_ptr<ExportData> exportdata;
235 /** Store labels, index entries, etc. (in \ref post_macro)
236 * and output them later. This is used in particular to get
237 * labels and index entries (and potentially other fragile commands)
238 * outside of moving arguments (bug 2154)
240 bool postpone_fragile_stuff = false;
242 /** Stuff to be postponed and output after the current macro
243 * (if \ref postpone_fragile_stuff is true). Used for labels and index
244 * entries in commands with moving arguments (\\section, \\caption etc.)
246 mutable docstring post_macro;
248 /** Whether we are entering a display math inset.
249 * Needed to correctly strike out deleted math in change tracking.
251 mutable bool inDisplayMath = false;
253 /** Whether we are leaving a display math inset.
254 * Needed to correctly track nested ulem commands in change tracking.
256 mutable bool wasDisplayMath = false;
258 /** Whether we are inside a comment inset. Insets that are including
259 * external files like InsetGraphics, InsetInclude and InsetExternal
260 * may only write the usual output and must not attempt to do
261 * something with the included files (e.g. copying, converting)
262 * if this flag is true, since they may not exist.
264 bool inComment = false;
266 /** Whether we are inside an include inset.
268 bool inInclude = false;
270 /** Whether a btUnit (for multiple biblographies) is open.
272 mutable bool openbtUnit = false;
274 /** Process only the children's aux files with BibTeX.
275 * This is necessary with chapterbib.
277 bool only_childbibs = false;
279 /** Whether we are in a table cell.
280 * For newline, it matters whether its content is aligned or not.
282 TableCell inTableCell = NO;
284 /** Whether we are inside a float or subfloat.
285 * Needed for subfloat detection on the command line.
287 Float inFloat = NONFLOAT;
289 /** Whether we are inside an index inset.
290 * ERT needs to know this, due to the active chars.
292 bool inIndexEntry = false;
294 /** Whether we are inside an IPA inset.
295 * Needed for proper IPA output.
299 /** Whether we are inside an inset that is logically deleted.
300 * A value > 0 indicates a deleted inset.
302 int inDeletedInset = 0;
304 /** The change information of the outermost logically deleted inset.
305 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
307 Change changeOfDeletedInset {Change::UNCHANGED};
309 /** What kind of change tracking object is this?
310 * Relevant for strikeout method in output
312 mutable CtObject ctObject = CtObject::Normal;
314 /** allow output of only part of the top-level paragraphs
315 * par_begin: beginning paragraph
317 mutable pit_type par_begin = 0;
319 /** allow output of only part of the top-level paragraphs
320 * par_end: par_end-1 is the ending paragraph
321 * if par_begin=par_end, output all paragraphs
323 mutable pit_type par_end = 0;
325 /// Id of the last paragraph before an inset
326 mutable int lastid = -1;
328 /// Last position in the last paragraph before an inset
329 mutable pos_type lastpos = 0;
331 /// is this the last paragraph in the current buffer/inset?
332 bool isLastPar = false;
335 /** whether or not to do actual file copying and image conversion
336 * This mode will be used to preview the source code
340 /// whether to display output errors or not
343 /// Should we output verbatim or escape LaTeX's special chars?
344 bool pass_thru = false;
346 /// Should we output verbatim specific chars?
347 docstring pass_thru_chars;
349 /// A specific newline macro
350 std::string newlinecmd;
352 /// Should we output captions?
353 bool html_disable_captions = false;
355 /// Are we already in a paragraph?
356 bool html_in_par = false;
358 /// Does the present context even permit paragraphs?
359 bool html_make_pars = true;
361 /// Are we already in a paragraph?
362 bool docbook_in_par = false;
364 /// Does the present context even permit paragraphs?
365 bool docbook_make_pars = true;
367 /// Are paragraphs mandatory in this context?
368 bool docbook_force_pars = false;
370 /// Anchors that should not be output (LyX-side identifier, not DocBook-side).
371 std::set<docstring> docbook_anchors_to_ignore;
373 /// Is the current context a float (such as a table or a figure)?
374 bool docbook_in_float = false;
376 /// Is the current context a listing?
377 bool docbook_in_listing = false;
379 /// Is the current context a table?
380 bool docbook_in_table = false;
382 /// Should the layouts that should/must go into <info> be generated?
383 bool docbook_generate_info = true;
385 /// Should wrappers be ignored? Mostly useful to avoid generation of <abstract>.
386 bool docbook_ignore_wrapper = false;
388 /// Some parameters are output before the rest of the paragraph, they should not be generated a second time.
389 std::set<InsetArgument const *> docbook_prepended_arguments = {};
391 /// Are we generating this material for inclusion in a TOC-like entity?
392 bool for_toc = false;
394 /// Are we generating this material for inclusion in a tooltip?
395 bool for_tooltip = false;
397 /// Are we generating this material for use by advanced search?
398 bool for_search = false;
400 /// Are we generating this material for instant preview?
401 bool for_preview = false;
403 /// Include all children notwithstanding the use of \includeonly
404 bool includeall = false;
406 /// Explicit output folder, if any is desired
407 std::string export_folder;
413 #endif // NOT OUTPUTPARAMS_H