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
63 OutputParams(Encoding const *);
66 /** The file that we export depends occasionally on what is to
70 /// is it some flavor of LaTeX?
72 /// does this flavour support full unicode?
73 bool isFullUnicode() const;
75 /// Same, but for math output, which only matter is XHTML output.
76 MathFlavor math_flavor;
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
82 Non-nice LaTeX also includes additional safe line breaks in order to
83 increase the precision of forward/reverse search and error reporting.
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.
91 mutable bool is_child;
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.
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.
105 /** inulemcmd > 0 means that the environment in which the
106 inset is typeset is part of a ulem command (\uline, \uuline,
107 \uwave, or \sout). Insets that output latex commands relying
108 on local assignments (such as \cite) should enclose such
109 commands in \mbox{} in order to avoid breakage.
111 mutable int inulemcmd;
113 /** the font at the point where the inset is
115 Font const * local_font;
117 /** Document language babel name
119 std::string document_language;
121 /** The master language. Non-null only for child documents.
122 Note that this is not the language of the top level master, but
123 of the direct parent for nested includes.
125 mutable Language const * master_language;
127 /** Current stream encoding. Only used for LaTeX.
128 This must be set to the document encoding (via the constructor)
129 before output starts. Afterwards it must be kept up to date for
130 each single character (\sa Paragraph::latex).
131 This does also mean that you need to set it back if you use a
132 copy (e.g. in insets): \code
133 int InsetFoo::latex(..., OutputParams const & runparams_in) const
135 OutputParams runparams(runparams_in);
136 runparams.inComment = true;
138 InsetBla::latex(..., runparams);
140 runparams_in.encoding = runparams.encoding;
144 mutable Encoding const * encoding;
146 /** free_spacing == true means that the inset is in a free-spacing
151 /** This var is set by the return value from BufferParams::writeLaTeX
155 /** Do we use polyglossia (instead of babel)?
157 bool use_polyglossia;
159 /** Are we generating multiple indices?
163 /** Are we using japanese (pLaTeX)?
167 /** Customized bibtex_command
169 std::string bibtex_command;
171 /** Customized index_command
173 std::string index_command;
175 /** Line length to use with plaintext or LaTeX export.
179 /** The depth of the current paragraph, set for plaintext
180 * export and used by InsetTabular
184 /** Export data filled in by the latex(), docbook() etc methods.
185 This is a hack: Make it possible to add stuff to constant
186 OutputParams instances.
188 std::shared_ptr<ExportData> exportdata;
190 /** Whether we are entering a display math inset.
191 * Needed to correctly strike out deleted math in change tracking.
193 mutable bool inDisplayMath;
195 /** Whether we are leaving a display math inset.
196 * Needed to correctly track nested ulem commands in change tracking.
198 mutable bool wasDisplayMath;
200 /** Whether we are inside a comment inset. Insets that are including
201 * external files like InsetGraphics, InsetInclude and InsetExternal
202 * may only write the usual output and must not attempt to do
203 * something with the included files (e.g. copying, converting)
204 * if this flag is true, since they may not exist.
208 /** Whether a btUnit (for multiple biblographies) is open.
210 mutable bool openbtUnit;
212 /** Process only the children's aux files with BibTeX.
213 * This is necessary with chapterbib.
217 /** Whether we are in a table cell.
218 * For newline, it matters whether its content is aligned or not.
220 TableCell inTableCell;
222 /** Whether we are inside a float or subfloat.
223 * Needed for subfloat detection on the command line.
227 /** Whether we are inside an index inset.
228 * ERT needs to know this, due to the active chars.
232 /** Whether we are inside an IPA inset.
233 * Needed for proper IPA output.
237 /** Whether we are inside an inset that is logically deleted.
238 * A value > 0 indicates a deleted inset.
242 /** The change information of the outermost logically deleted inset.
243 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
245 Change changeOfDeletedInset;
247 /** allow output of only part of the top-level paragraphs
248 * par_begin: beginning paragraph
250 mutable pit_type par_begin;
252 /** allow output of only part of the top-level paragraphs
253 * par_end: par_end-1 is the ending paragraph
254 * if par_begin=par_end, output all paragraphs
256 mutable pit_type par_end;
258 /// Id of the last paragraph before an inset
261 /// Last position in the last paragraph before an inset
262 mutable pos_type lastpos;
264 /// is this the last paragraph in the current buffer/inset?
268 /** whether or not do actual file copying and image conversion
269 * This mode will be used to preview the source code
273 /// whether to display output errors or not
276 /// Should we output verbatim or escape LaTeX's special chars?
279 /// Should we output verbatim specific chars?
280 docstring pass_thru_chars;
282 /// Should we output captions?
283 bool html_disable_captions;
285 /// Are we already in a paragraph?
288 /// Does the present context even permit paragraphs?
291 /// Are we generating this material for inclusion in a TOC-like entity?
294 /// Are we generating this material for inclusion in a tooltip?
297 /// Are we generating this material for use by advanced search?
300 /// Are we generating this material for instant preview?
303 /// Include all children notwithstanding the use of \includeonly
306 /// Explicit output folder, if any is desired
307 std::string export_folder;
313 #endif // NOT OUTPUTPARAMS_H