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
85 /** Is this a real child (i.e., compiled as a child)?
86 This depends on wherefrom we export the buffer. Even children
87 that have a master can be compiled standalone.
89 mutable bool is_child;
91 /** moving_arg == true means that the environment in which the inset
92 is typeset is a moving argument. The inset should take care about
93 fragile commands by preceding the latex with \\protect.
97 /** intitle == true means that the environment in which the
98 inset is typeset is part of a title (before a \\maketitle).
99 Footnotes in such environments have moving arguments.
103 /** inulemcmd > 0 means that the environment in which the
104 inset is typeset is part of a ulem command (\uline, \uuline,
105 \uwave, or \sout). Insets that output latex commands relying
106 on local assignments (such as \cite) should enclose such
107 commands in \mbox{} in order to avoid breakage.
109 mutable int inulemcmd;
111 /** the font at the point where the inset is
113 Font const * local_font;
115 /** Document language babel name
117 std::string document_language;
119 /** The master language. Non-null only for child documents.
120 Note that this is not the language of the top level master, but
121 of the direct parent for nested includes.
123 mutable Language const * master_language;
125 /** Current stream encoding. Only used for LaTeX.
126 This must be set to the document encoding (via the constructor)
127 before output starts. Afterwards it must be kept up to date for
128 each single character (\sa Paragraph::latex).
129 This does also mean that you need to set it back if you use a
130 copy (e.g. in insets): \code
131 int InsetFoo::latex(..., OutputParams const & runparams_in) const
133 OutputParams runparams(runparams_in);
134 runparams.inComment = true;
136 InsetBla::latex(..., runparams);
138 runparams_in.encoding = runparams.encoding;
142 mutable Encoding const * encoding;
144 /** free_spacing == true means that the inset is in a free-spacing
149 /** This var is set by the return value from BufferParams::writeLaTeX
153 /** Do we use polyglossia (instead of babel)?
155 bool use_polyglossia;
157 /** Are we generating multiple indices?
161 /** Are we using japanese (pLaTeX)?
165 /** Customized bibtex_command
167 std::string bibtex_command;
169 /** Customized index_command
171 std::string index_command;
173 /** Line length to use with plaintext or LaTeX export.
177 /** The depth of the current paragraph, set for plaintext
178 * export and used by InsetTabular
182 /** Export data filled in by the latex(), docbook() etc methods.
183 This is a hack: Make it possible to add stuff to constant
184 OutputParams instances.
186 std::shared_ptr<ExportData> exportdata;
188 /** Whether we are inside a comment inset. Insets that are including
189 * external files like InsetGraphics, InsetInclude and InsetExternal
190 * may only write the usual output and must not attempt to do
191 * something with the included files (e.g. copying, converting)
192 * if this flag is true, since they may not exist.
196 /** Whether we are in a table cell.
197 * For newline, it matters whether its content is aligned or not.
199 TableCell inTableCell;
201 /** Whether we are inside a float or subfloat.
202 * Needed for subfloat detection on the command line.
206 /** Whether we are inside an index inset.
207 * ERT needs to know this, due to the active chars.
211 /** Whether we are inside an IPA inset.
212 * Needed for proper IPA output.
216 /** Whether we are inside an inset that is logically deleted.
217 * A value > 0 indicates a deleted inset.
221 /** The change information of the outermost logically deleted inset.
222 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
224 Change changeOfDeletedInset;
226 /** allow output of only part of the top-level paragraphs
227 * par_begin: beginning paragraph
229 mutable pit_type par_begin;
231 /** allow output of only part of the top-level paragraphs
232 * par_end: par_end-1 is the ending paragraph
233 * if par_begin=par_end, output all paragraphs
235 mutable pit_type par_end;
237 /// Id of the last paragraph before an inset
240 /// Last position in the last paragraph before an inset
243 /// is this the last paragraph in the current buffer/inset?
247 /** whether or not do actual file copying and image conversion
248 * This mode will be used to preview the source code
252 /// whether to display output errors or not
255 /// Should we output verbatim or escape LaTeX's special chars?
258 /// Should we output verbatim specific chars?
259 docstring pass_thru_chars;
261 /// Should we output captions?
262 bool html_disable_captions;
264 /// Are we already in a paragraph?
267 /// Does the present context even permit paragraphs?
270 /// Are we generating this material for inclusion in a TOC-like entity?
273 /// Are we generating this material for inclusion in a tooltip?
276 /// Are we generating this material for use by advanced search?
279 /// Are we generating this material for instant preview?
282 /// Include all children notwithstanding the use of \includeonly
285 /// Explicit output folder, if any is desired
286 std::string export_folder;
292 #endif // NOT OUTPUTPARAMS_H