3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #ifndef LYX_PREAMBLE_H
15 #define LYX_PREAMBLE_H
30 class TeX2LyXDocClass;
38 std::string inputencoding() const { return h_inputencoding; }
40 void setInputencoding(std::string const & e) { h_inputencoding = e; }
42 std::string notefontcolor() const { return h_notefontcolor; }
44 bool refstyle() const { return h_use_refstyle; }
46 bool fontCJKSet() const { return h_font_cjk_set; }
48 std::string fontCJK() const { return h_font_cjk; }
50 void fontCJK(std::string const & f) { h_font_cjk_set = true; h_font_cjk = f; }
52 bool minted() const { return h_use_minted; }
53 /// The document language
54 std::string docLanguage() const { return h_language; }
55 /// The language of text which is not explicitly marked
56 std::string defaultLanguage() const { return default_language; }
57 /// The quotation marks style
58 std::string quotesStyle() const { return h_quotes_style; }
60 bool usePolyglossia() const;
62 std::string use_indices() const { return h_use_indices; }
64 std::string polyglossia2lyx(std::string const & language);
66 bool indentParagraphs() const;
68 bool isPackageUsed(std::string const & package) const;
70 std::vector<std::string>
71 getPackageOptions(std::string const & package) const;
72 /// Tell that \p package will be loaded automatically by LyX.
73 /// This has only an effect if \p package is prepared for
74 /// autoloading in parse().
75 void registerAutomaticallyLoadedPackage(std::string const & package);
77 void addModule(std::string const & module);
79 void suppressDate(bool suppress);
81 std::string citeEngine() const { return h_cite_engine; }
83 void citeEngine(std::string const & e) { h_cite_engine = e; }
85 std::string multibib() const { return h_multibib; }
87 void multibib(std::string const & s) { h_multibib = s; }
89 bool titleLayoutFound() const { return title_layout_found; }
91 void titleLayoutFound(bool found) { title_layout_found = found; }
92 /// Register an author named \p name in the author list
93 void registerAuthor(std::string const & name);
94 /// Get author named \p name (must be registered first)
95 Author const & getAuthor(std::string const & name) const;
96 /// Get number of arguments of special table column type \c or -1
97 /// if no column type \p c exists
98 int getSpecialTableColumnArguments(char c) const;
100 /// Parses the LaTeX preamble into internal data
101 void parse(Parser & p, std::string const & forceclass,
102 TeX2LyXDocClass & tc);
103 /// Parse the encoding from a preamble. *this is unusable afterwards.
104 std::string parseEncoding(Parser & p, std::string const & forceclass);
105 /// Writes the LyX file header from internal data
106 bool writeLyXHeader(std::ostream & os, bool subdoc,
107 std::string const & outfiledir);
109 /// known polyglossia language names (including variants)
110 static const char * const polyglossia_languages[];
111 /// the same as polyglossia_languages with .lyx names
112 static const char * const coded_polyglossia_languages[];
114 std::vector<std::string> biblatex_bibliographies;
118 void parse(Parser & p, std::string const & forceclass,
119 bool detectEncoding, TeX2LyXDocClass & tc);
121 std::map<std::string, std::vector<std::string> > used_packages;
122 /// Packages that will be loaded automatically by LyX
123 std::set<std::string> auto_packages;
125 std::vector<std::string> used_modules;
127 /// needed to handle encodings with babel
129 /// the main non-CJK language
130 std::string default_language;
131 /// Was babel called explicitly?
134 /// was at least one title layout found?
135 bool title_layout_found;
137 /// used for the handling of \newindex
140 std::ostringstream h_preamble;
141 std::string h_backgroundcolor;
142 std::string h_multibib;
143 std::string h_biblio_style;
144 std::string h_biblio_options;
145 std::string h_biblatex_bibstyle;
146 std::string h_biblatex_citestyle;
147 std::string h_bibtex_command;
148 std::string h_boxbgcolor;
149 std::string h_cite_engine;
150 std::string h_cite_engine_type;
152 std::string h_defskip;
153 bool h_dynamic_quotes;
154 std::string h_float_placement;
155 std::string h_fontcolor;
156 std::string h_fontencoding;
157 std::string h_font_math[2];
158 std::string h_font_roman[2];
159 std::string h_font_sans[2];
160 std::string h_font_typewriter[2];
161 std::string h_font_default_family;
162 bool h_use_non_tex_fonts;
163 std::string h_font_sc;
164 std::string h_font_osf;
165 std::string h_font_sf_scale[2];
166 std::string h_font_tt_scale[2];
168 std::string h_font_cjk;
169 std::string h_use_microtype;
170 std::string h_is_mathindent;
171 std::string h_math_numbering_side;
172 std::string h_mathindentation;
173 std::string h_graphics;
174 std::string h_default_output_format;
175 std::string h_html_be_strict;
176 std::string h_html_css_as_file;
177 std::string h_html_math_output;
178 std::string h_index[99];
179 std::string h_index_command;
180 std::string h_inputencoding;
181 std::string h_justification;
182 std::string h_language;
183 std::string h_language_package;
184 std::string h_listings_params;
185 std::string h_maintain_unincluded_children;
186 std::string h_margins;
187 std::string h_notefontcolor;
188 std::string h_options;
189 std::string h_output_changes;
190 std::string h_output_sync;
191 std::string h_output_sync_macro;
192 std::string h_papercolumns;
193 std::string h_paperfontsize;
194 std::string h_paperorientation;
195 std::string h_paperpagestyle;
196 std::string h_papersides;
197 std::string h_papersize;
198 std::string h_paragraph_indentation;
199 /// necessary to set the separation when \setlength is parsed
200 std::string h_paragraph_separation;
201 std::string h_pdf_title;
202 std::string h_pdf_author;
203 std::string h_pdf_subject;
204 std::string h_pdf_keywords;
205 std::string h_pdf_bookmarks;
206 std::string h_pdf_bookmarksnumbered;
207 std::string h_pdf_bookmarksopen;
208 std::string h_pdf_bookmarksopenlevel;
209 std::string h_pdf_breaklinks;
210 std::string h_pdf_pdfborder;
211 std::string h_pdf_colorlinks;
212 std::string h_pdf_backref;
213 std::string h_pdf_pdfusetitle;
214 std::string h_pdf_pagemode;
215 std::string h_pdf_quoted_options;
216 std::string h_quotes_style;
217 std::string h_secnumdepth;
218 std::string h_shortcut[99];
219 std::string h_spacing;
220 std::string h_suppress_date;
221 std::string h_save_transient_properties;
222 std::string h_textclass;
223 std::string h_tocdepth;
224 std::string h_tracking_changes;
225 std::string h_use_bibtopic;
226 std::string h_use_dash_ligatures;
227 std::string h_use_indices;
228 std::string h_use_geometry;
229 std::map<std::string, std::string> h_use_packages;
230 std::string h_use_default_options;
231 std::string h_use_hyperref;
232 std::vector<std::string> h_includeonlys;
237 * Add package \p name with options \p options to used_packages.
238 * Remove options from \p options that we don't want to output.
240 void add_package(std::string const & name,
241 std::vector<std::string> & options);
243 void handle_hyperref(std::vector<std::string> & options);
245 void handle_geometry(std::vector<std::string> & options);
247 void handle_package(Parser &p, std::string const & name,
248 std::string const & opts, bool in_lyx_preamble,
249 bool detectEncoding);
251 void handle_if(Parser & p, bool in_lyx_preamble);
255 /// special table column types
256 std::map<char, int> special_columns_;
258 std::map<std::string, std::string> extra_package_options_;
262 extern Preamble preamble;