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/docstream.h"
23 #include "support/FileName.h"
24 #include "support/filetools.h"
25 #include "support/gettext.h"
26 #include "support/lstrings.h"
30 using namespace lyx::support;
35 LaTeXFonts latexfonts;
38 LaTeXFont LaTeXFont::altFont(docstring const & name)
40 return theLaTeXFonts().getAltFont(name);
44 bool LaTeXFont::available(bool ot1, bool nomath)
46 if (nomath && !nomathfont_.empty())
47 return altFont(nomathfont_).available(ot1, nomath);
48 else if (ot1 && !ot1font_.empty())
49 return (ot1font_ == "none") ?
50 true : altFont(ot1font_).available(ot1, nomath);
51 else if (requires_.empty() && package_.empty())
53 else if (!requires_.empty()
54 && LaTeXFeatures::isAvailable(to_ascii(requires_)))
56 else if (requires_.empty() && !package_.empty()
57 && LaTeXFeatures::isAvailable(to_ascii(package_)))
59 else if (!altfonts_.empty()) {
60 for (size_t i = 0; i < altfonts_.size(); ++i) {
61 if (altFont(altfonts_[i]).available(ot1, nomath))
69 bool LaTeXFont::providesNoMath(bool ot1, bool complete)
71 docstring const usedfont = getUsedFont(ot1, complete, false);
75 else if (usedfont != name_)
76 return altFont(usedfont).providesNoMath(ot1, complete);
78 return (!nomathfont_.empty() && available(ot1, true));
82 bool LaTeXFont::providesOSF(bool ot1, bool complete, bool nomath)
84 docstring const usedfont = getUsedFont(ot1, complete, nomath);
88 else if (usedfont != name_)
89 return altFont(usedfont).providesOSF(ot1, complete, nomath);
90 else if (!osffont_.empty())
91 return altFont(osffont_).available(ot1, nomath);
92 else if (!available(ot1, nomath))
95 return (!osfoption_.empty() || !osfscoption_.empty());
99 bool LaTeXFont::providesSC(bool ot1, bool complete, bool nomath)
101 docstring const usedfont = getUsedFont(ot1, complete, nomath);
103 if (usedfont.empty())
105 else if (usedfont != name_)
106 return altFont(usedfont).providesSC(ot1, complete, nomath);
107 else if (!available(ot1, nomath))
110 return (!scoption_.empty() || !osfscoption_.empty());
114 bool LaTeXFont::hasMonolithicExpertSet(bool ot1, bool complete, bool nomath)
116 docstring const usedfont = getUsedFont(ot1, complete, nomath);
118 if (usedfont.empty())
120 else if (usedfont != name_)
121 return altFont(usedfont).hasMonolithicExpertSet(ot1, complete, nomath);
122 return (!osfoption_.empty() && !scoption_.empty() && osfoption_ == scoption_)
123 || (osfoption_.empty() && scoption_.empty() && !osfscoption_.empty());
127 bool LaTeXFont::providesScale(bool ot1, bool complete, bool nomath)
129 docstring const usedfont = getUsedFont(ot1, complete, nomath);
131 if (usedfont.empty())
133 else if (usedfont != name_)
134 return altFont(usedfont).providesScale(ot1, complete, nomath);
135 else if (!available(ot1, nomath))
137 return (!scaleoption_.empty());
140 bool LaTeXFont::provides(std::string const & name, bool ot1, bool complete, bool nomath)
142 docstring const usedfont = getUsedFont(ot1, complete, nomath);
144 if (usedfont.empty())
146 else if (usedfont != name_)
147 return altFont(usedfont).provides(name, ot1, complete, nomath);
148 else if (provides_.empty())
151 for (size_t i = 0; i < provides_.size(); ++i) {
152 if (provides_[i] == name)
159 docstring const LaTeXFont::getUsedFont(bool ot1, bool complete, bool nomath)
161 if (nomath && !nomathfont_.empty() && available(ot1, true))
163 else if (ot1 && !ot1font_.empty())
164 return (ot1font_ == "none") ? docstring() : ot1font_;
165 else if (family_ == "rm" && complete && !completefont_.empty()
166 && altFont(completefont_).available(ot1, nomath))
167 return completefont_;
168 else if (switchdefault_) {
169 if (requires_.empty()
170 || (!requires_.empty()
171 && LaTeXFeatures::isAvailable(to_ascii(requires_))))
174 else if (!requires_.empty()
175 && LaTeXFeatures::isAvailable(to_ascii(requires_)))
177 else if (!package_.empty()
178 && LaTeXFeatures::isAvailable(to_ascii(package_)))
180 else if (!preamble_.empty() && package_.empty()
181 && requires_.empty() && !switchdefault_
182 && altfonts_.empty()) {
185 else if (!altfonts_.empty()) {
186 for (size_t i = 0; i < altfonts_.size(); ++i) {
187 LaTeXFont altf = altFont(altfonts_[i]);
188 if (altf.available(ot1, nomath))
189 return altf.getUsedFont(ot1, complete, nomath);
197 docstring const LaTeXFont::getUsedPackage(bool ot1, bool complete, bool nomath)
199 docstring const usedfont = getUsedFont(ot1, complete, nomath);
200 if (usedfont.empty())
202 return theLaTeXFonts().getLaTeXFont(usedfont).package();
206 string const LaTeXFont::getAvailablePackage(bool dryrun)
208 if (package_.empty())
211 string const package = to_ascii(package_);
212 if (!requires_.empty() && LaTeXFeatures::isAvailable(to_ascii(requires_)))
214 else if (LaTeXFeatures::isAvailable(package))
216 // Output unavailable packages in source preview
220 docstring const req = requires_.empty() ? package_ : requires_;
221 frontend::Alert::warning(_("Font not available"),
222 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
223 "is not available on your system. LyX will fall back to the default font."),
224 req, guiname_), true);
230 string const LaTeXFont::getPackageOptions(bool ot1, bool complete, bool sc, bool osf,
231 int scale, string const extraopts, bool nomath)
234 bool const needosfopt = (osf != osfdefault_);
235 bool const has_osf = providesOSF(ot1, complete, nomath);
236 bool const has_sc = providesSC(ot1, complete, nomath);
238 if (!packageoption_.empty())
239 os << to_ascii(packageoption_);
241 if (sc && needosfopt && has_osf && has_sc) {
242 if (!os.str().empty())
244 if (!osfscoption_.empty())
245 os << to_ascii(osfscoption_);
247 os << to_ascii(osfoption_)
248 << ',' << to_ascii(scoption_);
249 } else if (needosfopt && has_osf) {
250 if (!os.str().empty())
252 os << to_ascii(osfoption_);
253 } else if (sc && has_sc) {
254 if (!os.str().empty())
256 os << to_ascii(scoption_);
259 if (scale != 100 && !scaleoption_.empty()
260 && providesScale(ot1, complete, nomath)) {
261 if (!os.str().empty())
263 os << subst(to_ascii(scaleoption_), "$$val",
264 convert<std::string>(float(scale) / 100));
267 if (moreopts_ && !extraopts.empty()) {
268 if (!os.str().empty())
276 string const LaTeXFont::getLaTeXCode(bool dryrun, bool ot1, bool complete, bool sc,
277 bool osf, bool nomath, string const extraopts,
282 docstring const usedfont = getUsedFont(ot1, complete, nomath);
283 if (usedfont.empty())
285 else if (usedfont != name_)
286 return altFont(usedfont).getLaTeXCode(dryrun, ot1, complete, sc,
287 osf, nomath, extraopts, scale);
289 if (switchdefault_) {
290 if (family_.empty()) {
291 LYXERR0("Error: Font `" << name_ << "' has no family defined!");
294 if (available(ot1, nomath) || dryrun)
295 os << "\\renewcommand{\\" << to_ascii(family_) << "default}{"
296 << to_ascii(name_) << "}\n";
298 frontend::Alert::warning(_("Font not available"),
299 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
300 "is not available on your system. LyX will fall back to the default font."),
301 requires_, guiname_), true);
303 string const package =
304 getAvailablePackage(dryrun);
305 string const packageopts = getPackageOptions(ot1, complete, sc, osf, scale, extraopts, nomath);
306 if (packageopts.empty() && !package.empty())
307 os << "\\usepackage{" << package << "}\n";
308 else if (!packageopts.empty() && !package.empty())
309 os << "\\usepackage[" << packageopts << "]{" << package << "}\n";
311 if (osf && providesOSF(ot1, complete, nomath) && !osffont_.empty())
312 os << altFont(osffont_).getLaTeXCode(dryrun, ot1, complete, sc, osf,
313 nomath, extraopts, scale);
315 if (!preamble_.empty())
316 os << to_utf8(preamble_);
322 bool LaTeXFont::hasFontenc(string const & name) const
324 for (auto const & fe : fontenc_) {
332 bool LaTeXFont::readFont(Lexer & lex)
358 // Keep these sorted alphabetically!
359 LexerKeyword latexFontTags[] = {
360 { "altfonts", LF_ALT_FONTS },
361 { "completefont", LF_COMPLETE_FONT },
362 { "endfont", LF_END },
363 { "family", LF_FAMILY },
364 { "fontencoding", LF_FONTENC },
365 { "guiname", LF_GUINAME },
366 { "moreoptions", LF_MOREOPTS },
367 { "nomathfont", LF_NOMATHFONT },
368 { "osfdefault", LF_OSFDEFAULT },
369 { "osffont", LF_OSFFONT },
370 { "osfoption", LF_OSFOPTION },
371 { "osfscoption", LF_OSFSCOPTION },
372 { "ot1font", LF_OT1_FONT },
373 { "package", LF_PACKAGE },
374 { "packageoption", LF_PACKAGEOPTION },
375 { "preamble", LF_PREAMBLE },
376 { "provides", LF_PROVIDES },
377 { "requires", LF_REQUIRES },
378 { "scaleoption", LF_SCALEOPTION },
379 { "scoption", LF_SCOPTION },
380 { "switchdefault", LF_SWITCHDEFAULT }
384 bool finished = false;
385 lex.pushTable(latexFontTags);
386 // parse style section
387 while (!finished && lex.isOK() && !error) {
389 // See comment in LyXRC.cpp.
391 case Lexer::LEX_FEOF:
394 case Lexer::LEX_UNDEF: // parse error
395 lex.printError("Unknown LaTeXFont tag `$$Token'");
402 switch (static_cast<LaTeXFontTags>(le)) {
403 case LF_END: // end of structure
408 docstring altp = lex.getDocString();
409 altfonts_ = getVectorFromString(altp);
412 case LF_COMPLETE_FONT:
413 lex >> completefont_;
423 string fe = lex.getString();
424 fontenc_ = getVectorFromString(fe);
448 case LF_PACKAGEOPTION:
449 lex >> packageoption_;
452 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
456 string features = lex.getString();
457 provides_ = getVectorFromString(features);
472 case LF_SWITCHDEFAULT:
473 lex >> switchdefault_;
478 lex.printError("No End tag found for LaTeXFont tag `$$Token'");
482 return finished && !error;
486 bool LaTeXFont::read(Lexer & lex)
493 lex.printError("No name given for LaTeX font: `$$Token'.");
497 name_ = lex.getDocString();
498 LYXERR(Debug::INFO, "Reading LaTeX font " << name_);
499 if (!readFont(lex)) {
500 LYXERR0("Error parsing LaTeX font `" << name_ << '\'');
504 if (fontenc_.empty())
505 fontenc_.push_back("T1");
511 void LaTeXFonts::readLaTeXFonts()
513 // Read latexfonts file
514 FileName filename = libFileSearch(string(), "latexfonts");
515 if (filename.empty()) {
516 LYXERR0("Error: latexfonts file not found!");
520 lex.setFile(filename);
521 lex.setContext("LaTeXFeatures::readLaTeXFonts");
525 case Lexer::LEX_FEOF:
531 string const type = lex.getString();
532 if (type != "Font" && type != "AltFont") {
533 lex.printError("Unknown LaTeXFont tag `$$Token'");
541 if (type == "AltFont")
542 texaltfontmap_[f.name()] = f;
544 texfontmap_[f.name()] = f;
549 LaTeXFonts::TexFontMap LaTeXFonts::getLaTeXFonts()
551 if (texfontmap_.empty())
557 LaTeXFont LaTeXFonts::getLaTeXFont(docstring const & name)
559 if (name == "default" || name == "auto")
561 if (texfontmap_.empty())
563 if (texfontmap_.find(name) == texfontmap_.end()) {
564 LYXERR0("LaTeXFonts::getLaTeXFont: font '" << name << "' not found!");
567 return texfontmap_[name];
571 LaTeXFont LaTeXFonts::getAltFont(docstring const & name)
573 if (name == "default" || name == "auto")
575 if (texaltfontmap_.empty())
577 if (texaltfontmap_.find(name) == texaltfontmap_.end()) {
578 LYXERR0("LaTeXFonts::getAltFont: alternative font '" << name << "' not found!");
581 return texaltfontmap_[name];