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; }
51 /// The document language
52 std::string docLanguage() const { return h_language; }
53 /// The language of text which is not explicitly marked
54 std::string defaultLanguage() const { return default_language; }
56 bool usePolyglossia() const;
58 std::string use_indices() const { return h_use_indices; }
60 std::string polyglossia2lyx(std::string const & language);
62 bool indentParagraphs() const;
64 bool isPackageUsed(std::string const & package) const;
66 std::vector<std::string>
67 getPackageOptions(std::string const & package) const;
68 /// Tell that \p package will be loaded automatically by LyX.
69 /// This has only an effect if \p package is prepared for
70 /// autoloading in parse().
71 void registerAutomaticallyLoadedPackage(std::string const & package);
73 void addModule(std::string const & module);
75 void suppressDate(bool suppress);
77 std::string citeEngine() const { return h_cite_engine; }
79 void citeEngine(std::string const & e) { h_cite_engine = e; }
81 bool titleLayoutFound() const { return title_layout_found; }
83 void titleLayoutFound(bool found) { title_layout_found = found; }
84 /// Register an author named \p name in the author list
85 void registerAuthor(std::string const & name);
86 /// Get author named \p name (must be registered first)
87 Author const & getAuthor(std::string const & name) const;
88 /// Get number of arguments of special table column type \c or -1
89 /// if no column type \p c exists
90 int getSpecialTableColumnArguments(char c) const;
92 /// Parses the LaTeX preamble into internal data
93 void parse(Parser & p, std::string const & forceclass,
94 TeX2LyXDocClass & tc);
95 /// Parse the encoding from a preamble. *this is unusable afterwards.
96 std::string parseEncoding(Parser & p, std::string const & forceclass);
97 /// Writes the LyX file header from internal data
98 bool writeLyXHeader(std::ostream & os, bool subdoc,
99 std::string const & outfiledir);
101 /// known polyglossia language names (including variants)
102 static const char * const polyglossia_languages[];
103 /// the same as polyglossia_languages with .lyx names
104 static const char * const coded_polyglossia_languages[];
108 void parse(Parser & p, std::string const & forceclass,
109 bool detectEncoding, TeX2LyXDocClass & tc);
111 std::map<std::string, std::vector<std::string> > used_packages;
112 /// Packages that will be loaded automatically by LyX
113 std::set<std::string> auto_packages;
115 std::vector<std::string> used_modules;
117 /// needed to handle encodings with babel
119 /// the main non-CJK language
120 std::string default_language;
121 /// Was babel called explicitly?
124 /// was at least one title layout found?
125 bool title_layout_found;
127 /// used for the handling of \newindex
130 std::ostringstream h_preamble;
131 std::string h_backgroundcolor;
132 std::string h_biblio_style;
133 std::string h_bibtex_command;
134 std::string h_boxbgcolor;
135 std::string h_cite_engine;
136 std::string h_cite_engine_type;
138 std::string h_defskip;
139 std::string h_float_placement;
140 std::string h_fontcolor;
141 std::string h_fontencoding;
142 std::string h_font_math[2];
143 std::string h_font_roman[2];
144 std::string h_font_sans[2];
145 std::string h_font_typewriter[2];
146 std::string h_font_default_family;
147 bool h_use_non_tex_fonts;
148 std::string h_font_sc;
149 std::string h_font_osf;
150 std::string h_font_sf_scale[2];
151 std::string h_font_tt_scale[2];
153 std::string h_font_cjk;
154 bool h_use_microtype;
155 std::string h_graphics;
156 std::string h_default_output_format;
157 std::string h_html_be_strict;
158 std::string h_html_css_as_file;
159 std::string h_html_math_output;
160 std::string h_index[99];
161 std::string h_index_command;
162 std::string h_inputencoding;
163 std::string h_justification;
164 std::string h_language;
165 std::string h_language_package;
166 std::string h_listings_params;
167 std::string h_maintain_unincluded_children;
168 std::string h_margins;
169 std::string h_notefontcolor;
170 std::string h_options;
171 std::string h_output_changes;
172 std::string h_output_sync;
173 std::string h_output_sync_macro;
174 std::string h_papercolumns;
175 std::string h_paperfontsize;
176 std::string h_paperorientation;
177 std::string h_paperpagestyle;
178 std::string h_papersides;
179 std::string h_papersize;
180 std::string h_paragraph_indentation;
181 /// necessary to set the separation when \setlength is parsed
182 std::string h_paragraph_separation;
183 std::string h_pdf_title;
184 std::string h_pdf_author;
185 std::string h_pdf_subject;
186 std::string h_pdf_keywords;
187 std::string h_pdf_bookmarks;
188 std::string h_pdf_bookmarksnumbered;
189 std::string h_pdf_bookmarksopen;
190 std::string h_pdf_bookmarksopenlevel;
191 std::string h_pdf_breaklinks;
192 std::string h_pdf_pdfborder;
193 std::string h_pdf_colorlinks;
194 std::string h_pdf_backref;
195 std::string h_pdf_pdfusetitle;
196 std::string h_pdf_pagemode;
197 std::string h_pdf_quoted_options;
198 std::string h_quotes_language;
199 std::string h_secnumdepth;
200 std::string h_shortcut[99];
201 std::string h_spacing;
202 std::string h_suppress_date;
203 std::string h_save_transient_properties;
204 std::string h_textclass;
205 std::string h_tocdepth;
206 std::string h_tracking_changes;
207 std::string h_use_bibtopic;
208 std::string h_use_indices;
209 std::string h_use_geometry;
210 std::map<std::string, std::string> h_use_packages;
211 std::string h_use_default_options;
212 std::string h_use_hyperref;
216 * Add package \p name with options \p options to used_packages.
217 * Remove options from \p options that we don't want to output.
219 void add_package(std::string const & name,
220 std::vector<std::string> & options);
222 void handle_hyperref(std::vector<std::string> & options);
224 void handle_geometry(std::vector<std::string> & options);
226 void handle_package(Parser &p, std::string const & name,
227 std::string const & opts, bool in_lyx_preamble,
228 bool detectEncoding);
230 void handle_if(Parser & p, bool in_lyx_preamble);
234 /// special table column types
235 std::map<char, int> special_columns_;
239 extern Preamble preamble;