3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Jürgen Spitzmüller
8 * Full author contact details are available in file CREDITS.
13 #include "LaTeXFonts.h"
15 #include "LaTeXFeatures.h"
18 #include "frontends/alert.h"
20 #include "support/convert.h"
21 #include "support/debug.h"
22 #include "support/FileName.h"
23 #include "support/filetools.h"
24 #include "support/gettext.h"
25 #include "support/lstrings.h"
29 using namespace lyx::support;
34 LaTeXFonts latexfonts;
37 LaTeXFont LaTeXFont::altFont(docstring const & name)
39 return theLaTeXFonts().getAltFont(name);
43 bool LaTeXFont::available(bool ot1, bool nomath)
45 if (nomath && !nomathfont_.empty())
46 return altFont(nomathfont_).available(ot1, nomath);
47 else if (ot1 && !ot1font_.empty())
48 return (ot1font_ == "none") ?
49 true : altFont(ot1font_).available(ot1, nomath);
50 else if (requires_.empty() && package_.empty())
52 else if (!requires_.empty()
53 && LaTeXFeatures::isAvailable(to_ascii(requires_)))
55 else if (requires_.empty() && !package_.empty()
56 && LaTeXFeatures::isAvailable(to_ascii(package_)))
58 else if (!altfonts_.empty()) {
59 for (size_t i = 0; i < altfonts_.size(); ++i) {
60 if (altFont(altfonts_[i]).available(ot1, nomath))
68 bool LaTeXFont::providesNoMath(bool ot1, bool complete)
70 docstring const usedfont = getUsedFont(ot1, complete, false);
74 else if (usedfont != name_)
75 return altFont(usedfont).providesNoMath(ot1, complete);
77 return (!nomathfont_.empty() && available(ot1, true));
81 bool LaTeXFont::providesOSF(bool ot1, bool complete, bool nomath)
83 docstring const usedfont = getUsedFont(ot1, complete, nomath);
87 else if (usedfont != name_)
88 return altFont(usedfont).providesOSF(ot1, complete, nomath);
89 else if (!osffont_.empty())
90 return altFont(osffont_).available(ot1, nomath);
91 else if (!available(ot1, nomath))
94 return (!osfoption_.empty() || !osfscoption_.empty());
98 bool LaTeXFont::providesSC(bool ot1, bool complete, bool nomath)
100 docstring const usedfont = getUsedFont(ot1, complete, nomath);
102 if (usedfont.empty())
104 else if (usedfont != name_)
105 return altFont(usedfont).providesSC(ot1, complete, nomath);
106 else if (!available(ot1, nomath))
109 return (!scoption_.empty() || !osfscoption_.empty());
113 bool LaTeXFont::providesScale(bool ot1, bool complete, bool nomath)
115 docstring const usedfont = getUsedFont(ot1, complete, nomath);
117 if (usedfont.empty())
119 else if (usedfont != name_)
120 return altFont(usedfont).providesScale(ot1, complete, nomath);
121 else if (!available(ot1, nomath))
123 return (!scaleoption_.empty());
126 bool LaTeXFont::provides(std::string const & name, bool ot1, bool complete, bool nomath)
128 docstring const usedfont = getUsedFont(ot1, complete, nomath);
130 if (usedfont.empty())
132 else if (usedfont != name_)
133 return altFont(usedfont).provides(name, ot1, complete, nomath);
134 else if (provides_.empty())
137 for (size_t i = 0; i < provides_.size(); ++i) {
138 if (provides_[i] == name)
145 docstring const LaTeXFont::getUsedFont(bool ot1, bool complete, bool nomath)
147 if (nomath && !nomathfont_.empty() && available(ot1, true))
149 else if (ot1 && !ot1font_.empty())
150 return (ot1font_ == "none") ? docstring() : ot1font_;
151 else if (family_ == "rm" && complete && !completefont_.empty()
152 && altFont(completefont_).available(ot1, nomath))
153 return completefont_;
154 else if (switchdefault_) {
155 if (requires_.empty()
156 || (!requires_.empty()
157 && LaTeXFeatures::isAvailable(to_ascii(requires_))))
160 else if (!requires_.empty()
161 && LaTeXFeatures::isAvailable(to_ascii(requires_)))
163 else if (!package_.empty()
164 && LaTeXFeatures::isAvailable(to_ascii(package_)))
166 else if (!altfonts_.empty()) {
167 for (size_t i = 0; i < altfonts_.size(); ++i) {
168 LaTeXFont altf = altFont(altfonts_[i]);
169 if (altf.available(ot1, nomath))
170 return altf.getUsedFont(ot1, complete, nomath);
178 string const LaTeXFont::getAvailablePackage(bool dryrun)
180 if (package_.empty())
183 string const package = to_ascii(package_);
184 if (!requires_.empty() && LaTeXFeatures::isAvailable(to_ascii(requires_)))
186 else if (LaTeXFeatures::isAvailable(package))
188 // Output unavailable packages in source preview
192 docstring const req = requires_.empty() ? package_ : requires_;
193 frontend::Alert::warning(_("Font not available"),
194 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
195 "is not available on your system. LyX will fall back to the default font."),
196 req, guiname_), true);
202 string const LaTeXFont::getPackageOptions(bool ot1, bool complete, bool sc, bool osf,
203 int scale, bool nomath)
206 bool const needosfopt = (osf != osfdefault_);
207 bool const has_osf = providesOSF(ot1, complete, nomath);
208 bool const has_sc = providesSC(ot1, complete, nomath);
210 if (!packageoption_.empty())
211 os << to_ascii(packageoption_);
213 if (sc && needosfopt && has_osf && has_sc) {
214 if (!os.str().empty())
216 if (!osfscoption_.empty())
217 os << to_ascii(osfscoption_);
219 os << to_ascii(osfoption_)
220 << ',' << to_ascii(scoption_);
221 } else if (needosfopt && has_osf) {
222 if (!os.str().empty())
224 os << to_ascii(osfoption_);
225 } else if (sc && has_sc) {
226 if (!os.str().empty())
228 os << to_ascii(scoption_);
231 if (scale != 100 && !scaleoption_.empty()
232 && providesScale(ot1, complete, nomath)) {
233 if (!os.str().empty())
235 os << subst(to_ascii(scaleoption_), "$$val",
236 convert<std::string>(float(scale) / 100));
242 string const LaTeXFont::getLaTeXCode(bool dryrun, bool ot1, bool complete, bool sc,
243 bool osf, bool nomath, int const & scale)
247 docstring const usedfont = getUsedFont(ot1, complete, nomath);
248 if (usedfont.empty())
250 else if (usedfont != name_)
251 return altFont(usedfont).getLaTeXCode(dryrun, ot1, complete, sc, osf, nomath, scale);
253 if (switchdefault_) {
254 if (family_.empty()) {
255 LYXERR0("Error: Font `" << name_ << "' has no family defined!");
258 if (available(ot1, nomath) || dryrun)
259 os << "\\renewcommand{\\" << to_ascii(family_) << "default}{"
260 << to_ascii(name_) << "}\n";
262 frontend::Alert::warning(_("Font not available"),
263 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
264 "is not available on your system. LyX will fall back to the default font."),
265 requires_, guiname_), true);
267 string const package =
268 getAvailablePackage(dryrun);
269 string const packageopts = getPackageOptions(ot1, complete, sc, osf, scale, nomath);
270 if (packageopts.empty() && !package.empty())
271 os << "\\usepackage{" << package << "}\n";
272 else if (!packageopts.empty() && !package.empty())
273 os << "\\usepackage[" << packageopts << "]{" << package << "}\n";
275 if (osf && providesOSF(ot1, complete, nomath) && !osffont_.empty())
276 os << altFont(osffont_).getLaTeXCode(dryrun, ot1, complete, sc, osf, nomath, scale);
282 bool LaTeXFont::readFont(Lexer & lex)
305 // Keep these sorted alphabetically!
306 LexerKeyword latexFontTags[] = {
307 { "altfonts", LF_ALT_FONTS },
308 { "completefont", LF_COMPLETE_FONT },
309 { "endfont", LF_END },
310 { "family", LF_FAMILY },
311 { "guiname", LF_GUINAME },
312 { "nomathfont", LF_NOMATHFONT },
313 { "osfdefault", LF_OSFDEFAULT },
314 { "osffont", LF_OSFFONT },
315 { "osfoption", LF_OSFOPTION },
316 { "osfscoption", LF_OSFSCOPTION },
317 { "ot1font", LF_OT1_FONT },
318 { "package", LF_PACKAGE },
319 { "packageoption", LF_PACKAGEOPTION },
320 { "provides", LF_PROVIDES },
321 { "requires", LF_REQUIRES },
322 { "scaleoption", LF_SCALEOPTION },
323 { "scoption", LF_SCOPTION },
324 { "switchdefault", LF_SWITCHDEFAULT }
328 bool finished = false;
329 lex.pushTable(latexFontTags);
330 // parse style section
331 while (!finished && lex.isOK() && !error) {
333 // See comment in LyXRC.cpp.
335 case Lexer::LEX_FEOF:
338 case Lexer::LEX_UNDEF: // parse error
339 lex.printError("Unknown LaTeXFont tag `$$Token'");
346 switch (static_cast<LaTeXFontTags>(le)) {
347 case LF_END: // end of structure
352 docstring altp = lex.getDocString();
353 altfonts_ = getVectorFromString(altp);
356 case LF_COMPLETE_FONT:
357 lex >> completefont_;
386 case LF_PACKAGEOPTION:
387 lex >> packageoption_;
391 string features = lex.getString();
392 provides_ = getVectorFromString(features);
404 case LF_SWITCHDEFAULT:
405 lex >> switchdefault_;
410 lex.printError("No End tag found for LaTeXFont tag `$$Token'");
414 return finished && !error;
418 bool LaTeXFont::read(Lexer & lex)
424 lex.printError("No name given for LaTeX font: `$$Token'.");
428 name_ = lex.getDocString();
429 LYXERR(Debug::INFO, "Reading LaTeX font " << name_);
430 if (!readFont(lex)) {
431 LYXERR0("Error parsing LaTeX font `" << name_ << '\'');
439 void LaTeXFonts::readLaTeXFonts()
441 // Read latexfonts file
442 FileName filename = libFileSearch(string(), "latexfonts");
443 if (filename.empty()) {
444 LYXERR0("Error: latexfonts file not found!");
448 lex.setFile(filename);
449 lex.setContext("LaTeXFeatures::readLaTeXFonts");
453 case Lexer::LEX_FEOF:
459 string const type = lex.getString();
460 if (type != "Font" && type != "AltFont") {
461 lex.printError("Unknown LaTeXFont tag `$$Token'");
469 if (type == "AltFont")
470 texaltfontmap_[f.name()] = f;
472 texfontmap_[f.name()] = f;
477 LaTeXFonts::TexFontMap LaTeXFonts::getLaTeXFonts()
479 if (texfontmap_.empty())
485 LaTeXFont LaTeXFonts::getLaTeXFont(docstring const & name)
487 if (name == "default" || name == "auto")
489 if (texfontmap_.empty())
491 if (texfontmap_.find(name) == texfontmap_.end()) {
492 LYXERR0("LaTeXFonts::getLaTeXFont: font '" << name << "' not found!");
495 return texfontmap_[name];
499 LaTeXFont LaTeXFonts::getAltFont(docstring const & name)
501 if (name == "default" || name == "auto")
503 if (texaltfontmap_.empty())
505 if (texaltfontmap_.find(name) == texaltfontmap_.end()) {
506 LYXERR0("LaTeXFonts::getAltFont: alternative font '" << name << "' not found!");
509 return texaltfontmap_[name];