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;
87 /// Same, but for math output, which only matter is XHTML output.
88 MathFlavor math_flavor = NotApplicable;
90 /** Are we to write a 'nice' LaTeX file or not.
91 This essentially seems to mean whether InsetInclude, InsetGraphics
92 and InsetExternal should add the absolute path to any external
94 Non-nice LaTeX also includes additional safe line breaks in order to
95 increase the precision of forward/reverse search and error reporting.
99 /** Is this a real child (i.e., compiled as a child)?
100 This depends on wherefrom we export the buffer. Even children
101 that have a master can be compiled standalone.
103 mutable bool is_child = false;
105 /** moving_arg == true means that the environment in which the inset
106 is typeset is a moving argument. The inset should take care about
107 fragile commands by preceding the latex with \\protect.
109 bool moving_arg = false;
111 /** intitle == true means that the environment in which the
112 inset is typeset is part of a title (before a \\maketitle).
113 Footnotes in such environments have moving arguments.
115 bool intitle = false;
117 /** need_maketitle == true means that the last layout was a title layout
118 * this is to track when \maketitle needs to be output.
120 mutable bool need_maketitle = false;
122 /** have_maketitle == true means that \maketitle already has been output.
124 mutable bool have_maketitle = false;
126 /** inbranch == true means that the environment being typeset
127 is inside an active branch inset.
129 bool inbranch = false;
131 /** inulemcmd > 0 means that the environment in which the
132 inset is typeset is part of a ulem or soul command (e.g., \uline,
133 \uuline, \uwave, \sout or \xout). Insets that output latex commands
134 relying on local assignments (such as \cite) should enclose such
135 commands in \mbox{} in order to avoid breakage.
137 mutable int inulemcmd = 0;
139 /** the font at the point where the inset is
141 * Note from lasgouttes: I have doubts on the semantics of this
142 * variable. Until this is sorted out, here are some notes on the
143 * history of local_font.
145 * A research that excludes test and assignment [*] shows that
146 * this is only used to remember language, which is a different
147 * story (and not changed by this patch). The only exception being
148 * in InsetMathHull::getCtObject and InsetMathNest::latex to
149 * support change tracking in insets, but I am not 100% sure that
150 * this is required. And historically [**] local_font used to be
151 * local_lang; it may be good to return to this simpler variable
154 * [*] git grep local_font src|grep -v 'local_font [!=]*='
156 * [**] before afed118a, which improved support for InsetLine;
157 * however, since 0e7ab29f, InsetLine does not depend on the
158 * current font anymore.
160 Font const * local_font = nullptr;
162 /** Document language lyx name
164 std::string document_language;
166 /// main font encoding of the document
167 std::string main_fontenc;
169 /** The master language. Non-null only for child documents.
170 Note that this is not the language of the top level master, but
171 of the direct parent for nested includes.
173 mutable Language const * master_language = nullptr;
175 /// Active characters
176 std::string active_chars;
178 /** Current stream encoding. Only used for LaTeX.
179 This must be set to the document encoding (via the constructor)
180 before output starts. Afterwards it must be kept up to date for
181 each single character (\sa Paragraph::latex).
182 This does also mean that you need to set it back if you use a
183 copy (e.g. in insets): \code
184 int InsetFoo::latex(..., OutputParams const & runparams_in) const
186 OutputParams runparams(runparams_in);
187 runparams.inComment = true;
189 InsetBla::latex(..., runparams);
191 runparams_in.encoding = runparams.encoding;
195 mutable Encoding const * encoding;
197 /** free_spacing == true means that the inset is in a free-spacing
200 bool free_spacing = false;
202 /** This var is set by the return value from BufferParams::writeLaTeX
204 bool use_babel = false;
206 /** Do we use polyglossia (instead of babel)?
208 bool use_polyglossia = false;
210 /** Do we use hyperref?
212 bool use_hyperref = false;
214 /// Do we use the CJK package?
215 bool use_CJK = false;
217 /** Are we generating multiple indices?
219 bool use_indices = false;
221 /** Are we using japanese (pLaTeX)?
223 bool use_japanese = false;
225 /** Customized bibtex_command
227 std::string bibtex_command;
229 /** Customized index_command
231 std::string index_command;
235 std::string hyperref_driver;
237 /** Line length to use with plaintext or LaTeX export.
239 size_type linelen = 0;
241 /** The depth of the current paragraph, set for plaintext
242 * export and used by InsetTabular
246 /** Export data filled in by the latex(), docbook(), etc. methods.
247 This is a hack: Make it possible to add stuff to constant
248 OutputParams instances.
250 std::shared_ptr<ExportData> exportdata;
252 /** Store labels, index entries, etc. (in \ref post_macro)
253 * and output them later. This is used in particular to get
254 * labels and index entries (and potentially other fragile commands)
255 * outside of moving arguments (bug 2154)
257 bool postpone_fragile_stuff = false;
259 /** Stuff to be postponed and output after the current macro
260 * (if \ref postpone_fragile_stuff is true). Used for labels and index
261 * entries in commands with moving arguments (\\section, \\caption etc.)
263 mutable docstring post_macro;
265 /** Whether we in a command that is not \\long (i.e. cannot have multiple
268 mutable bool isNonLong = false;
270 /** Whether we are entering a display math inset.
271 * Needed to correctly strike out deleted math in change tracking.
273 mutable bool inDisplayMath = false;
275 /** Whether we are leaving a display math inset.
276 * Needed to correctly track nested ulem commands in change tracking.
278 mutable bool wasDisplayMath = false;
280 /** Whether we are inside a comment inset. Insets that are including
281 * external files like InsetGraphics, InsetInclude and InsetExternal
282 * may only write the usual output and must not attempt to do
283 * something with the included files (e.g. copying, converting)
284 * if this flag is true, since they may not exist.
286 bool inComment = false;
288 /** Whether we are inside an include inset.
290 bool inInclude = false;
292 /** Whether we are inside a footnote.
294 mutable bool inFootnote = false;
296 /** Whether a btUnit (for multiple biblographies) is open.
298 mutable bool openbtUnit = false;
300 /** Process only the children's aux files with BibTeX.
301 * This is necessary with chapterbib.
303 bool only_childbibs = false;
305 /** Whether we are in a table cell.
306 * For newline, it matters whether its content is aligned or not.
308 TableCell inTableCell = NO;
310 /** Whether we are inside a float or subfloat.
311 * Needed for subfloat detection on the command line.
313 Float inFloat = NONFLOAT;
315 /** Whether we are inside an index inset.
316 * ERT needs to know this, due to the active chars.
318 bool inIndexEntry = false;
320 /** Whether we are inside an IPA inset.
321 * Needed for proper IPA output.
325 /** Whether we are inside an inset that is logically deleted.
326 * A value > 0 indicates a deleted inset.
328 int inDeletedInset = 0;
330 /** The change information of the outermost logically deleted inset.
331 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
333 Change changeOfDeletedInset {Change::UNCHANGED};
335 /** What kind of change tracking object is this?
336 * Relevant for strikeout method in output
338 mutable CtObject ctObject = CtObject::Normal;
340 /** allow output of only part of the top-level paragraphs
341 * par_begin: beginning paragraph
343 mutable pit_type par_begin = 0;
345 /** allow output of only part of the top-level paragraphs
346 * par_end: par_end-1 is the ending paragraph
347 * if par_begin=par_end, output all paragraphs
349 mutable pit_type par_end = 0;
351 /// Id of the last paragraph before an inset
352 mutable int lastid = -1;
354 /// Last position in the last paragraph before an inset
355 mutable pos_type lastpos = 0;
357 /// is this the last paragraph in the current buffer/inset?
358 bool isLastPar = false;
361 /** whether or not to do actual file copying and image conversion
362 * This mode will be used to preview the source code
366 /// whether to display output errors or not
369 /// Should we output verbatim or escape LaTeX's special chars?
370 bool pass_thru = false;
372 /// Should we output verbatim specific chars?
373 docstring pass_thru_chars;
375 /// A specific newline macro
376 std::string newlinecmd;
378 /// Should we output captions?
379 bool html_disable_captions = false;
381 /// Are we already in a paragraph?
382 bool html_in_par = false;
384 /// Does the present context even permit paragraphs?
385 bool html_make_pars = true;
387 /// Are we already in a paragraph?
388 bool docbook_in_par = false;
390 /// Is this element's allowMultiPar useable or not?
391 bool docbook_consider_allow_multi_par = true;
393 /// Does the present context even permit paragraphs?
394 bool docbook_make_pars = true;
396 /// Are paragraphs mandatory in this context?
397 bool docbook_force_pars = false;
399 /// Anchors that should not be output (LyX-side identifier, not DocBook-side).
400 std::set<docstring> docbook_anchors_to_ignore;
402 /// Is the current context a float (such as a table or a figure)?
403 bool docbook_in_float = false;
405 /// Is the current context a listing?
406 bool docbook_in_listing = false;
408 /// Is the current context a table?
409 bool docbook_in_table = false;
411 /// Should the layouts that should/must go into <info> be generated?
412 bool docbook_generate_info = true;
414 /// Should wrappers be ignored? Mostly useful to avoid generation of <abstract>.
415 bool docbook_ignore_wrapper = false;
417 /// Some parameters are output before the rest of the paragraph, they should not be generated a second time.
418 std::set<InsetArgument const *> docbook_prepended_arguments = {};
420 /// Some parameters are output after the rest of the paragraph, they should not be generated a second time.
421 std::set<InsetArgument const *> docbook_appended_arguments = {};
423 /// Are we generating this material for inclusion in a TOC-like entity?
424 bool for_toc = false;
426 /// Are we generating this material for inclusion in a tooltip?
427 bool for_tooltip = false;
429 /// Are we generating this material for use by advanced search?
432 SearchWithDeleted = 1,
433 SearchWithoutDeleted = 2,
438 inline bool find_effective(void) const { return (for_search != OutputParams::NoSearch); }
439 inline bool find_with_non_output() const { return ((for_search & OutputParams::SearchNonOutput) != 0); }
440 inline bool find_with_deleted() const { return ((for_search & OutputParams::SearchWithDeleted) != 0); }
441 inline void find_set_feature(enum Search set_) { for_search = set_; }
442 inline void find_add_feature(enum Search add_) { for_search |= add_; }
443 inline void find_clean_features(void) { for_search = OutputParams::NoSearch; }
445 /// Are we generating this material for instant preview?
446 bool for_preview = false;
448 /// Include all children notwithstanding the use of \includeonly
449 bool includeall = false;
451 /// Explicit output folder, if any is desired
452 std::string export_folder;
454 /// A postponed \\noindent (after VSpace)
455 mutable bool need_noindent = false;
457 int for_search = NoSearch;
463 #endif // NOT OUTPUTPARAMS_H