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());
141 bool LaTeXFont::providesMoreOptions(bool ot1, bool complete, bool nomath)
143 docstring const usedfont = getUsedFont(ot1, complete, nomath);
145 if (usedfont.empty())
147 else if (usedfont != name_)
148 return altFont(usedfont).providesMoreOptions(ot1, complete, nomath);
149 else if (!available(ot1, nomath))
155 bool LaTeXFont::provides(std::string const & name, bool ot1, bool complete, bool nomath)
157 docstring const usedfont = getUsedFont(ot1, complete, nomath);
159 if (usedfont.empty())
161 else if (usedfont != name_)
162 return altFont(usedfont).provides(name, ot1, complete, nomath);
163 else if (provides_.empty())
166 for (size_t i = 0; i < provides_.size(); ++i) {
167 if (provides_[i] == name)
174 docstring const LaTeXFont::getUsedFont(bool ot1, bool complete, bool nomath)
176 if (nomath && !nomathfont_.empty() && available(ot1, true))
178 else if (ot1 && !ot1font_.empty())
179 return (ot1font_ == "none") ? docstring() : ot1font_;
180 else if (family_ == "rm" && complete && !completefont_.empty()
181 && altFont(completefont_).available(ot1, nomath))
182 return completefont_;
183 else if (switchdefault_) {
184 if (requires_.empty()
185 || (!requires_.empty()
186 && LaTeXFeatures::isAvailable(to_ascii(requires_))))
189 else if (!requires_.empty()
190 && LaTeXFeatures::isAvailable(to_ascii(requires_)))
192 else if (!package_.empty()
193 && LaTeXFeatures::isAvailable(to_ascii(package_)))
195 else if (!preamble_.empty() && package_.empty()
196 && requires_.empty() && !switchdefault_
197 && altfonts_.empty()) {
200 else if (!altfonts_.empty()) {
201 for (size_t i = 0; i < altfonts_.size(); ++i) {
202 LaTeXFont altf = altFont(altfonts_[i]);
203 if (altf.available(ot1, nomath))
204 return altf.getUsedFont(ot1, complete, nomath);
212 docstring const LaTeXFont::getUsedPackage(bool ot1, bool complete, bool nomath)
214 docstring const usedfont = getUsedFont(ot1, complete, nomath);
215 if (usedfont.empty())
217 return theLaTeXFonts().getLaTeXFont(usedfont).package();
221 string const LaTeXFont::getAvailablePackage(bool dryrun)
223 if (package_.empty())
226 string const package = to_ascii(package_);
227 if (!requires_.empty() && LaTeXFeatures::isAvailable(to_ascii(requires_)))
229 else if (LaTeXFeatures::isAvailable(package))
231 // Output unavailable packages in source preview
235 docstring const req = requires_.empty() ? package_ : requires_;
236 frontend::Alert::warning(_("Font not available"),
237 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
238 "is not available on your system. LyX will fall back to the default font."),
239 req, guiname_), true);
245 string const LaTeXFont::getPackageOptions(bool ot1, bool complete, bool sc, bool osf,
246 int scale, string const extraopts, bool nomath)
249 bool const needosfopt = (osf != osfdefault_);
250 bool const has_osf = providesOSF(ot1, complete, nomath);
251 bool const has_sc = providesSC(ot1, complete, nomath);
253 if (!packageoption_.empty())
254 os << to_ascii(packageoption_);
256 if (sc && needosfopt && has_osf && has_sc) {
257 if (!os.str().empty())
259 if (!osfscoption_.empty())
260 os << to_ascii(osfscoption_);
262 os << to_ascii(osfoption_)
263 << ',' << to_ascii(scoption_);
264 } else if (needosfopt && has_osf) {
265 if (!os.str().empty())
267 os << to_ascii(osfoption_);
268 } else if (sc && has_sc) {
269 if (!os.str().empty())
271 os << to_ascii(scoption_);
274 if (scale != 100 && !scaleoption_.empty()
275 && providesScale(ot1, complete, nomath)) {
276 if (!os.str().empty())
278 os << subst(to_ascii(scaleoption_), "$$val",
279 convert<std::string>(float(scale) / 100));
282 if (moreopts_ && !extraopts.empty()) {
283 if (!os.str().empty())
291 string const LaTeXFont::getLaTeXCode(bool dryrun, bool ot1, bool complete, bool sc,
292 bool osf, bool nomath, string const extraopts,
297 docstring const usedfont = getUsedFont(ot1, complete, nomath);
298 if (usedfont.empty())
300 else if (usedfont != name_)
301 return altFont(usedfont).getLaTeXCode(dryrun, ot1, complete, sc,
302 osf, nomath, extraopts, scale);
304 if (switchdefault_) {
305 if (family_.empty()) {
306 LYXERR0("Error: Font `" << name_ << "' has no family defined!");
309 if (available(ot1, nomath) || dryrun)
310 os << "\\renewcommand{\\" << to_ascii(family_) << "default}{"
311 << to_ascii(name_) << "}\n";
313 frontend::Alert::warning(_("Font not available"),
314 bformat(_("The LaTeX package `%1$s' needed for the font `%2$s'\n"
315 "is not available on your system. LyX will fall back to the default font."),
316 requires_, guiname_), true);
318 string const package =
319 getAvailablePackage(dryrun);
320 string const packageopts = getPackageOptions(ot1, complete, sc, osf, scale, extraopts, nomath);
321 if (packageopts.empty() && !package.empty())
322 os << "\\usepackage{" << package << "}\n";
323 else if (!packageopts.empty() && !package.empty())
324 os << "\\usepackage[" << packageopts << "]{" << package << "}\n";
326 if (osf && providesOSF(ot1, complete, nomath) && !osffont_.empty())
327 os << altFont(osffont_).getLaTeXCode(dryrun, ot1, complete, sc, osf,
328 nomath, extraopts, scale);
330 if (!preamble_.empty())
331 os << to_utf8(preamble_);
337 bool LaTeXFont::hasFontenc(string const & name) const
339 for (auto const & fe : fontenc_) {
347 bool LaTeXFont::readFont(Lexer & lex)
373 // Keep these sorted alphabetically!
374 LexerKeyword latexFontTags[] = {
375 { "altfonts", LF_ALT_FONTS },
376 { "completefont", LF_COMPLETE_FONT },
377 { "endfont", LF_END },
378 { "family", LF_FAMILY },
379 { "fontencoding", LF_FONTENC },
380 { "guiname", LF_GUINAME },
381 { "moreoptions", LF_MOREOPTS },
382 { "nomathfont", LF_NOMATHFONT },
383 { "osfdefault", LF_OSFDEFAULT },
384 { "osffont", LF_OSFFONT },
385 { "osfoption", LF_OSFOPTION },
386 { "osfscoption", LF_OSFSCOPTION },
387 { "ot1font", LF_OT1_FONT },
388 { "package", LF_PACKAGE },
389 { "packageoption", LF_PACKAGEOPTION },
390 { "preamble", LF_PREAMBLE },
391 { "provides", LF_PROVIDES },
392 { "requires", LF_REQUIRES },
393 { "scaleoption", LF_SCALEOPTION },
394 { "scoption", LF_SCOPTION },
395 { "switchdefault", LF_SWITCHDEFAULT }
399 bool finished = false;
400 lex.pushTable(latexFontTags);
401 // parse style section
402 while (!finished && lex.isOK() && !error) {
404 // See comment in LyXRC.cpp.
406 case Lexer::LEX_FEOF:
409 case Lexer::LEX_UNDEF: // parse error
410 lex.printError("Unknown LaTeXFont tag `$$Token'");
417 switch (static_cast<LaTeXFontTags>(le)) {
418 case LF_END: // end of structure
423 docstring altp = lex.getDocString();
424 altfonts_ = getVectorFromString(altp);
427 case LF_COMPLETE_FONT:
428 lex >> completefont_;
438 string fe = lex.getString();
439 fontenc_ = getVectorFromString(fe);
463 case LF_PACKAGEOPTION:
464 lex >> packageoption_;
467 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
471 string features = lex.getString();
472 provides_ = getVectorFromString(features);
487 case LF_SWITCHDEFAULT:
488 lex >> switchdefault_;
493 lex.printError("No End tag found for LaTeXFont tag `$$Token'");
497 return finished && !error;
501 bool LaTeXFont::read(Lexer & lex)
508 lex.printError("No name given for LaTeX font: `$$Token'.");
512 name_ = lex.getDocString();
513 LYXERR(Debug::INFO, "Reading LaTeX font " << name_);
514 if (!readFont(lex)) {
515 LYXERR0("Error parsing LaTeX font `" << name_ << '\'');
519 if (fontenc_.empty())
520 fontenc_.push_back("T1");
526 void LaTeXFonts::readLaTeXFonts()
528 // Read latexfonts file
529 FileName filename = libFileSearch(string(), "latexfonts");
530 if (filename.empty()) {
531 LYXERR0("Error: latexfonts file not found!");
535 lex.setFile(filename);
536 lex.setContext("LaTeXFeatures::readLaTeXFonts");
540 case Lexer::LEX_FEOF:
546 string const type = lex.getString();
547 if (type != "Font" && type != "AltFont") {
548 lex.printError("Unknown LaTeXFont tag `$$Token'");
556 if (type == "AltFont")
557 texaltfontmap_[f.name()] = f;
559 texfontmap_[f.name()] = f;
564 LaTeXFonts::TexFontMap LaTeXFonts::getLaTeXFonts()
566 if (texfontmap_.empty())
572 LaTeXFont LaTeXFonts::getLaTeXFont(docstring const & name)
574 if (name == "default" || name == "auto")
576 if (texfontmap_.empty())
578 if (texfontmap_.find(name) == texfontmap_.end()) {
579 LYXERR0("LaTeXFonts::getLaTeXFont: font '" << name << "' not found!");
582 return texfontmap_[name];
586 LaTeXFont LaTeXFonts::getAltFont(docstring const & name)
588 if (name == "default" || name == "auto")
590 if (texaltfontmap_.empty())
592 if (texaltfontmap_.find(name) == texaltfontmap_.end()) {
593 LYXERR0("LaTeXFonts::getAltFont: alternative font '" << name << "' not found!");
596 return texaltfontmap_[name];