2 * \file MathFactory.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "MathFactory.h"
15 #include "InsetMathAMSArray.h"
16 #include "InsetMathArray.h"
17 #include "InsetMathBoldSymbol.h"
18 #include "InsetMathBox.h"
19 #include "InsetMathCases.h"
20 #include "InsetMathColor.h"
21 #include "InsetMathDecoration.h"
22 #include "InsetMathDots.h"
23 #include "InsetMathFont.h"
24 #include "InsetMathFontOld.h"
25 #include "InsetMathFrac.h"
26 #include "InsetMathKern.h"
27 #include "InsetMathLefteqn.h"
28 #include "InsetMathOverset.h"
29 #include "InsetMathPhantom.h"
30 #include "InsetMathRef.h"
31 #include "InsetMathRoot.h"
32 #include "InsetMathSize.h"
33 #include "InsetMathSpace.h"
34 #include "InsetMathSplit.h"
35 #include "InsetMathSqrt.h"
36 #include "InsetMathStackrel.h"
37 #include "InsetMathSubstack.h"
38 #include "InsetMathSymbol.h"
39 #include "InsetMathTabular.h"
40 #include "InsetMathUnderset.h"
41 #include "InsetMathUnknown.h"
42 #include "InsetMathXArrow.h"
43 #include "InsetMathXYMatrix.h"
44 #include "MacroTable.h"
45 #include "MathMacro.h"
46 #include "MathMacroArgument.h"
47 #include "MathParser.h"
48 #include "MathSupport.h"
52 #include "insets/InsetCommand.h"
54 #include "support/docstream.h"
55 #include "support/filetools.h" // LibFileSearch
56 #include "support/lstrings.h"
58 #include "frontends/FontLoader.h"
63 using support::libFileSearch;
68 using std::istringstream;
77 typedef std::map<docstring, latexkeys> WordList;
82 bool math_font_available(docstring & name)
87 // Do we have the font proper?
88 if (theFontLoader().available(f))
92 if (name == "eufrak") {
93 name = from_ascii("lyxfakefrak");
98 << "font " << to_utf8(name) << " not available and I can't fake it"
106 support::FileName const filename = libFileSearch(string(), "symbols");
107 LYXERR(Debug::MATHED) << "read symbols from " << filename << endl;
108 if (filename.empty()) {
109 lyxerr << "Could not find symbols file" << endl;
113 std::ifstream fs(filename.toFilesystemEncoding().c_str());
116 while (getline(fs, line)) {
119 if (line.empty() || line[0] == '#')
122 // special case of iffont/else/endif
123 if (line.size() >= 7 && line.substr(0, 6) == "iffont") {
124 istringstream is(line);
128 docstring t = from_utf8(tmp);
129 skip = !math_font_available(t);
131 } else if (line.size() >= 4 && line.substr(0, 4) == "else") {
133 } else if (line.size() >= 5 && line.substr(0, 5) == "endif") {
139 // special case of pre-defined macros
140 if (line.size() > 8 && line.substr(0, 5) == "\\def\\") {
141 //lyxerr << "macro definition: '" << line << '\'' << endl;
142 istringstream is(line);
145 is >> macro >> requires;
146 MacroTable::globalMacros().insert(from_utf8(macro), requires);
150 idocstringstream is(from_utf8(line));
152 is >> tmp.name >> tmp.inset;
153 if (isFontName(tmp.inset))
154 is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
157 // requires is optional
161 LYXERR(Debug::MATHED) << "skipping line '" << line << '\'' << endl;
162 LYXERR(Debug::MATHED)
163 << to_utf8(tmp.name) << ' ' << to_utf8(tmp.inset) << ' ' << to_utf8(tmp.extra) << endl;
167 if (isFontName(tmp.inset)) {
168 // tmp.inset _is_ the fontname here.
169 // create fallbacks if necessary
171 // store requirements as long as we can
172 if (tmp.requires.empty()) {
173 if (tmp.inset == "msa" || tmp.inset == "msb")
174 tmp.requires = from_ascii("amssymb");
175 else if (tmp.inset == "wasy")
176 tmp.requires = from_ascii("wasysym");
179 // symbol font is not available sometimes
180 docstring symbol_font = from_ascii("lyxsymbol");
182 if (tmp.extra == "func" || tmp.extra == "funclim" || tmp.extra == "special") {
183 LYXERR(Debug::MATHED) << "symbol abuse for " << to_utf8(tmp.name) << endl;
185 } else if (math_font_available(tmp.inset)) {
186 LYXERR(Debug::MATHED) << "symbol available for " << to_utf8(tmp.name) << endl;
187 tmp.draw.push_back(char_type(charid));
188 } else if (fallbackid && math_font_available(symbol_font)) {
189 if (tmp.inset == "cmex")
190 tmp.inset = from_ascii("lyxsymbol");
192 tmp.inset = from_ascii("lyxboldsymbol");
193 LYXERR(Debug::MATHED) << "symbol fallback for " << to_utf8(tmp.name) << endl;
194 tmp.draw.push_back(char_type(fallbackid));
196 LYXERR(Debug::MATHED) << "faking " << to_utf8(tmp.name) << endl;
198 tmp.inset = from_ascii("lyxtex");
201 // it's a proper inset
202 LYXERR(Debug::MATHED) << "inset " << to_utf8(tmp.inset)
203 << " used for " << to_utf8(tmp.name)
207 if (theWordList.find(tmp.name) != theWordList.end())
208 LYXERR(Debug::MATHED)
209 << "readSymbols: inset " << to_utf8(tmp.name)
210 << " already exists." << endl;
212 theWordList[tmp.name] = tmp;
214 LYXERR(Debug::MATHED)
215 << "read symbol '" << to_utf8(tmp.name)
216 << " inset: " << to_utf8(tmp.inset)
217 << " draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
218 << " extra: " << to_utf8(tmp.extra)
219 << " requires: " << to_utf8(tmp.requires)
222 docstring tmp = from_ascii("cmm");
223 docstring tmp2 = from_ascii("cmsy");
224 has_math_fonts = math_font_available(tmp) && math_font_available(tmp2);
233 static bool initialized = false;
242 latexkeys const * in_word_set(docstring const & str)
244 WordList::iterator it = theWordList.find(str);
245 return it != theWordList.end() ? &(it->second) : 0;
249 MathAtom createInsetMath(char const * const s)
251 return createInsetMath(from_utf8(s));
255 MathAtom createInsetMath(docstring const & s)
257 //lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
258 latexkeys const * l = in_word_set(s);
260 docstring const & inset = l->inset;
261 //lyxerr << " found inset: '" << inset << '\'' << endl;
263 return MathAtom(new InsetMathRef(l->name));
264 if (inset == "overset")
265 return MathAtom(new InsetMathOverset);
266 if (inset == "underset")
267 return MathAtom(new InsetMathUnderset);
268 if (inset == "decoration")
269 return MathAtom(new InsetMathDecoration(l));
270 if (inset == "space")
271 return MathAtom(new InsetMathSpace(l->name));
273 return MathAtom(new InsetMathDots(l));
275 // return MathAtom(new InsetMathMBox);
276 // InsetMathMBox is proposed to replace InsetMathBox,
277 // but is not ready yet (it needs a BufferView for
279 return MathAtom(new InsetMathBox(l->name));
280 // if (inset == "fbox")
281 // return MathAtom(new InsetMathFBox(l));
282 if (inset == "style")
283 return MathAtom(new InsetMathSize(l));
285 return MathAtom(new InsetMathFont(l));
286 if (inset == "oldfont")
287 return MathAtom(new InsetMathFontOld(l));
288 if (inset == "matrix")
289 return MathAtom(new InsetMathAMSArray(s));
290 if (inset == "split")
291 return MathAtom(new InsetMathSplit(s));
293 // we can't create a InsetMathBig, since the argument
295 return MathAtom(new InsetMathUnknown(s));
296 return MathAtom(new InsetMathSymbol(l));
299 if (s.size() == 2 && s[0] == '#' && s[1] >= '1' && s[1] <= '9')
300 return MathAtom(new MathMacroArgument(s[1] - '0'));
301 if (s.size() == 3 && s[0] == '\\' && s[1] == '#'
302 && s[2] >= '1' && s[2] <= '9')
303 return MathAtom(new MathMacroArgument(s[2] - '0'));
305 return MathAtom(new InsetMathBoxed());
307 return MathAtom(new InsetMathFBox());
309 return MathAtom(new InsetMathFrameBox);
311 return MathAtom(new InsetMathMakebox);
313 return MathAtom(new InsetMathKern);
314 if (s.substr(0, 8) == "xymatrix") {
315 char spacing_code = '\0';
317 size_t const len = s.length();
319 if (i < len && s[i] == '@') {
329 spacing_code = static_cast<char>(s[i]);
334 if (i < len && s[i] == '=') {
336 spacing = Length(to_ascii(s.substr(i)));
339 return MathAtom(new InsetMathXYMatrix(spacing, spacing_code));
341 if (s == "xrightarrow" || s == "xleftarrow")
342 return MathAtom(new InsetMathXArrow(s));
343 if (s == "split" || s == "gathered" || s == "aligned" || s == "alignedat")
344 return MathAtom(new InsetMathSplit(s));
346 return MathAtom(new InsetMathCases);
348 return MathAtom(new InsetMathSubstack);
349 if (s == "subarray" || s == "array")
350 return MathAtom(new InsetMathArray(s, 1, 1));
352 return MathAtom(new InsetMathSqrt);
354 return MathAtom(new InsetMathRoot);
356 return MathAtom(new InsetMathTabular(s, 1, 1));
358 return MathAtom(new InsetMathStackrel);
359 if (s == "binom" || s == "choose")
360 return MathAtom(new InsetMathBinom(s == "choose"));
362 return MathAtom(new InsetMathFrac);
364 return MathAtom(new InsetMathFrac(InsetMathFrac::OVER));
366 return MathAtom(new InsetMathFrac(InsetMathFrac::NICEFRAC));
368 return MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC));
369 // This string value is only for math toolbar use. Not a LaTeX name
370 if (s == "unitfracthree")
371 return MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC, 3));
373 return MathAtom(new InsetMathFrac(InsetMathFrac::UNIT, 1));
375 return MathAtom(new InsetMathFrac(InsetMathFrac::UNIT));
377 // return MathAtom(new MathInferInset);
379 return MathAtom(new InsetMathFrac(InsetMathFrac::ATOP));
381 return MathAtom(new InsetMathLefteqn);
382 if (s == "boldsymbol")
383 return MathAtom(new InsetMathBoldSymbol);
384 if (s == "color" || s == "normalcolor")
385 return MathAtom(new InsetMathColor(true));
386 if (s == "textcolor")
387 return MathAtom(new InsetMathColor(false));
389 return MathAtom(new InsetMathDFrac);
391 return MathAtom(new InsetMathTFrac);
393 return MathAtom(new InsetMathDBinom);
395 return MathAtom(new InsetMathTBinom);
397 return MathAtom(new InsetMathPhantom(InsetMathPhantom::hphantom));
399 return MathAtom(new InsetMathPhantom(InsetMathPhantom::phantom));
401 return MathAtom(new InsetMathPhantom(InsetMathPhantom::vphantom));
403 return MathAtom(new MathMacro(s));
407 bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
410 // "ref LatexCommand ref\nreference \"sec:Title\"\n\\end_inset\n\n";
412 docstring body = split(str, name, ' ');
417 InsetCommandParams icp(REF_CODE);
419 InsetCommandMailer::string2params("ref", to_utf8(str), icp);
420 mathed_parse_cell(ar, icp.getCommand());
424 return ar[0].nucleus();