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
16 #include "support/shared_ptr.h"
62 OutputParams(Encoding const *);
65 /** The file that we export depends occasionally on what is to
69 /// is it some flavor of LaTeX?
71 /// does this flavour support full unicode?
72 bool isFullUnicode() const;
74 /// Same, but for math output, which only matter is XHTML output.
75 MathFlavor math_flavor;
77 /** Are we to write a 'nice' LaTeX file or not.
78 This esentially seems to mean whether InsetInclude, InsetGraphics
79 and InsetExternal should add the absolute path to any external
84 /** Is this a real child (i.e., compiled as a child)?
85 This depends on wherefrom we export the buffer. Even children
86 that have a master can be compiled standalone.
88 mutable bool is_child;
90 /** moving_arg == true means that the environment in which the inset
91 is typeset is a moving argument. The inset should take care about
92 fragile commands by preceding the latex with \\protect.
96 /** intitle == true means that the environment in which the
97 inset is typeset is part of a title (before a \\maketitle).
98 Footnotes in such environments have moving arguments.
102 /** inulemcmd > 0 means that the environment in which the
103 inset is typeset is part of a ulem command (\uline, \uuline,
104 \uwave, or \sout). Insets that output latex commands relying
105 on local assignments (such as \cite) should enclose such
106 commands in \mbox{} in order to avoid breakage.
108 mutable int inulemcmd;
110 /** the font at the point where the inset is
112 Font const * local_font;
114 /** Document language babel name
116 std::string document_language;
118 /** The master language. Non-null only for child documents.
119 Note that this is not the language of the top level master, but
120 of the direct parent for nested includes.
122 mutable Language const * master_language;
124 /** Current stream encoding. Only used for LaTeX.
125 This must be set to the document encoding (via the constructor)
126 before output starts. Afterwards it must be kept up to date for
127 each single character (\sa Paragraph::latex).
128 This does also mean that you need to set it back if you use a
129 copy (e.g. in insets): \code
130 int InsetFoo::latex(..., OutputParams const & runparams_in) const
132 OutputParams runparams(runparams_in);
133 runparams.inComment = true;
135 InsetBla::latex(..., runparams);
137 runparams_in.encoding = runparams.encoding;
141 mutable Encoding const * encoding;
143 /** free_spacing == true means that the inset is in a free-spacing
148 /** This var is set by the return value from BufferParams::writeLaTeX
152 /** Do we use polyglossia (instead of babel)?
154 bool use_polyglossia;
156 /** Are we generating multiple indices?
160 /** Are we using japanese (pLaTeX)?
164 /** Customized bibtex_command
166 std::string bibtex_command;
168 /** Customized index_command
170 std::string index_command;
172 /** Line length to use with plaintext or LaTeX export.
176 /** The depth of the current paragraph, set for plaintext
177 * export and used by InsetTabular
181 /** Export data filled in by the latex(), docbook() etc methods.
182 This is a hack: Make it possible to add stuff to constant
183 OutputParams instances.
185 shared_ptr<ExportData> exportdata;
187 /** Whether we are inside a comment inset. Insets that are including
188 * external files like InsetGraphics, InsetInclude and InsetExternal
189 * may only write the usual output and must not attempt to do
190 * something with the included files (e.g. copying, converting)
191 * if this flag is true, since they may not exist.
195 /** Whether we are in a table cell.
196 * For newline, it matters whether its content is aligned or not.
198 TableCell inTableCell;
200 /** Whether we are inside a float or subfloat.
201 * Needed for subfloat detection on the command line.
205 /** Whether we are inside an index inset.
206 * ERT needs to know this, due to the active chars.
210 /** Whether we are inside an IPA inset.
211 * Needed for proper IPA output.
215 /** Whether we are inside an inset that is logically deleted.
216 * A value > 0 indicates a deleted inset.
220 /** The change information of the outermost logically deleted inset.
221 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
223 Change changeOfDeletedInset;
225 /** allow output of only part of the top-level paragraphs
226 * par_begin: beginning paragraph
228 mutable pit_type par_begin;
230 /** allow output of only part of the top-level paragraphs
231 * par_end: par_end-1 is the ending paragraph
232 * if par_begin=par_end, output all paragraphs
234 mutable pit_type par_end;
236 /// Id of the last paragraph before an inset
239 /// Last position in the last paragraph before an inset
242 /// is this the last paragraph in the current buffer/inset?
246 /** whether or not do actual file copying and image conversion
247 * This mode will be used to preview the source code
251 /// whether to display output errors or not
254 /// Should we output verbatim or escape LaTeX's special chars?
257 /// Should we output captions?
258 bool html_disable_captions;
260 /// Are we already in a paragraph?
263 /// Does the present context even permit paragraphs?
266 /// Are we generating this material for inclusion in a TOC-like entity?
269 /// Are we generating this material for inclusion in a tooltip?
272 /// Are we generating this material for use by advanced search?
275 /// Include all children notwithstanding the use of \includeonly
278 /// Explicit output folder, if any is desired
279 std::string export_folder;
285 #endif // NOT OUTPUTPARAMS_H