4 * Purpose: Implementation of macro class for mathed
5 * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
6 * Created: November 1996
7 * Description: WYSIWYG math macros
11 * Copyright: 1996, 1997 Alejandro Aguilar Sierra
13 * Version: 0.2, Mathed & Lyx project.
15 * This code is under the GNU General Public Licence version 2 or later.
19 #include FORMS_H_LOCATION
22 #pragma implementation "math_macro.h"
23 #pragma implementation "math_defs.h"
27 #include "math_macro.h"
28 #include "math_iter.h"
29 #include "math_inset.h"
30 #include "support/lstrings.h"
36 ostream & operator<<(ostream & o, MathedTextCodes mtc)
41 enum MathedMacroFlag {
47 ostream & operator<<(ostream & o, MathedMacroFlag mmf)
52 extern int mathed_string_width(short type, int style, string const & s);
53 extern int mathed_string_height(short, int, string const &, int &, int &);
56 MathMacro::MathMacro(MathMacroTemplate* t):
57 MathParInset(LM_ST_TEXT, "", LM_OT_MACRO), tmplate(t)
59 nargs = tmplate->getNoArgs();
60 tcode = tmplate->getTCode();
61 args = new MacroArgumentBase[nargs];
62 for (int i = 0; i < nargs; ++i) {
63 // if (tmplate->getMacroPar(i)->Permit(LMPF_ALLOW_CR))
64 // args[i].row = new MathedRowSt(tmplate->getMacroPar(i)->GetColumns());
67 /* int k = tmplate->getMacroPar(i)->GetColumns();
69 args[i].array = new LyxArrayBase;
70 for (int j= 0; j<k-1; ++j) args[i].array->Insert(j, LM_TC_TAB);
74 SetName(tmplate->GetName());
78 MathMacro::MathMacro(MathMacro * m):
79 MathParInset(LM_ST_TEXT, m->GetName(), LM_OT_MACRO)
82 nargs = tmplate->getNoArgs();
83 tcode = tmplate->getTCode();
84 args = new MacroArgumentBase[nargs];
86 SetName(tmplate->GetName());
87 for (int i = 0; i < tmplate->nargs; ++i) {
89 MathedIter it(m->GetData());
90 args[i].row = m->args[i].row;
91 args[i].array = it.Copy();
95 MathMacro::~MathMacro()
97 for (idx = 0; idx < nargs; ++idx) {
98 MathedIter it(args[idx].array);
100 delete args[idx].row;
106 MathedInset * MathMacro::Clone()
108 return new MathMacro(this);
112 void MathMacro::Metrics()
115 tmplate->update(this);
116 tmplate->SetStyle(size);
118 width = tmplate->Width();
119 ascent = tmplate->Ascent();
120 descent = tmplate->Descent();
124 void MathMacro::draw(Painter & pain, int x, int y)
128 tmplate->update(this);
129 tmplate->SetStyle(size);
130 tmplate->draw(pain, x, y);
131 for (int i = 0; i < nargs; ++i) {
132 tmplate->GetMacroXY(i, args[i].x, args[i].y);
137 int MathMacro::GetColumns() const
139 return tmplate->getMacroPar(idx)->GetColumns();
143 void MathMacro::GetXY(int & x, int & y) const
145 x = args[idx].x; y = args[idx].y;
149 bool MathMacro::Permit(short f)
152 tmplate->getMacroPar(idx)->Permit(f) : MathParInset::Permit(f);
156 void MathMacro::SetFocus(int x, int y)
158 tmplate->update(this);
159 tmplate->SetMacroFocus(idx, x, y);
163 void MathMacro::Write(ostream & os, bool fragile)
165 if (tmplate->flags & MMF_Exp) {
166 lyxerr[Debug::MATHED] << "Expand " << tmplate->flags
167 << ' ' << MMF_Exp << endl;
168 tmplate->update(this);
169 tmplate->Write(os, fragile);
171 if (tmplate->flags & MMF_Env) {
184 if (!(tmplate->flags & MMF_Env) && nargs > 0)
187 for (int i = 0; i < nargs; ++i) {
188 array = args[i].array;
189 MathParInset::Write(os, fragile);
193 if (tmplate->flags & MMF_Env) {
207 /*--------------- Macro argument -----------------------------------*/
209 MathMacroArgument::MathMacroArgument(int n)
213 SetType(LM_OT_MACRO_ARG);
217 void MathMacroArgument::draw(Painter & pain, int x, int baseline)
220 MathParInset::draw(pain, x, baseline);
223 std::ostringstream ost;
224 ost << '#' << number;
225 drawStr(pain, LM_TC_TEX, size, x, baseline, ost.str());
230 void MathMacroArgument::Metrics()
233 MathParInset::Metrics();
236 std::ostringstream ost;
237 ost << '#' << number;
238 width = mathed_string_width(LM_TC_TEX, size, ost.str());
239 mathed_string_height(LM_TC_TEX, size, ost.str(), ascent, descent);
244 void MathMacroArgument::Write(ostream & os, bool fragile)
247 MathParInset::Write(os, fragile);
249 os << '#' << number << ' ';
254 /* --------------------- MathMacroTemplate ---------------------------*/
256 MathMacroTemplate::MathMacroTemplate(string const & nm, int na, int flg):
257 MathParInset(LM_ST_TEXT, nm, LM_OT_MACRO),
258 flags(flg), nargs(na)
261 tcode = LM_TC_ACTIVE_INSET;
262 args = new MathMacroArgument[nargs];
263 for (int i = 0; i < nargs; ++i) {
264 args[i].setNumber(i + 1);
273 MathMacroTemplate::~MathMacroTemplate()
275 // prevent to delete already deleted objects
276 for (int i = 0; i < nargs; ++i) {
283 void MathMacroTemplate::setEditMode(bool ed)
287 for (int i = 0; i < nargs; ++i) {
288 args[i].setExpand(false);
292 for (int i = 0; i < nargs; ++i) {
293 args[i].setExpand(true);
299 void MathMacroTemplate::draw(Painter & pain, int x, int y)
302 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
303 if (flags & MMF_Edit) {
304 for (int i = 0; i < nargs; ++i) {
305 args[i].setExpand(false);
309 for (int i = 0; i < nargs; ++i) {
310 args[i].setExpand(true);
314 MathParInset::draw(pain, x, y);
317 for (int i = 0; i < nargs; ++i) {
318 args[i].setExpand(expnd);
323 void MathMacroTemplate::Metrics()
325 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
327 if (flags & MMF_Edit) {
328 for (int i = 0; i < nargs; ++i) {
329 args[i].setExpand(false);
332 for (int i = 0; i < nargs; ++i) {
333 args[i].setExpand(true);
336 MathParInset::Metrics();
338 for (int i = 0; i < nargs; ++i) {
339 args[i].setExpand(expnd);
344 void MathMacroTemplate::update(MathMacro * macro)
346 int idx = (macro) ? macro->getArgumentIdx() : 0;
347 for (int i = 0; i < nargs; ++i) {
349 macro->setArgumentIdx(i);
350 args[i].SetData(macro->GetData());
351 MathedRowSt * row = macro->getRowSt();
352 args[i].setRowSt(row);
356 macro->setArgumentIdx(idx);
360 void MathMacroTemplate::WriteDef(ostream & os, bool fragile)
362 os << "\n\\newcommand{\\" << name << "}";
365 os << "[" << nargs << "]";
369 for (int i = 0; i < nargs; ++i) {
370 args[i].setExpand(false);
377 void MathMacroTemplate::setArgument(LyxArrayBase * a, int i)
383 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
389 MathParInset * MathMacroTemplate::getMacroPar(int i) const
391 return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
395 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
397 for (int i = 0; i < nargs; ++i) {
398 if (args[i].Inside(x, y)) {
406 /* -------------------------- MathMacroTable -----------------------*/
408 MathMacroTable::MathMacroTable(int n) : max_macros(n)
410 macro_table = new MathMacroTemplateP[max_macros];
415 MathMacroTable::~MathMacroTable()
417 delete[] macro_table;
421 // The search is currently linear but will be binary or hash, later.
422 MathMacroTemplate * MathMacroTable::getTemplate(string const & name) const
424 for (int i = 0; i < num_macros; ++i) {
425 if (name == macro_table[i]->GetName())
426 return macro_table[i];
432 void MathMacroTable::addTemplate(MathMacroTemplate * m)
434 if (num_macros < max_macros)
435 macro_table[num_macros++] = m;
437 lyxerr << "Error (MathMacroTable::addTemplate): "
438 "Macro table exhausted!" << endl;
442 // All this stuff aparently leaks because it's created here and is not
443 // deleted never, but it have to live all the LyX sesion. OK, would not
444 // so hard to do it in the MacroTable destructor, but this doesn't harm
445 // seriously, so don't bother me with purify results here. ;-)
447 void MathMacroTable::builtinMacros()
450 MathParInset * inset;// *arg;
451 LyxArrayBase * array2;
455 lyxerr[Debug::MATHED] << "Building macros" << endl;
457 // This macro doesn't have arguments
458 MathMacroTemplate * m = new MathMacroTemplate("notin"); // this leaks
460 LyxArrayBase * array = new LyxArrayBase; // this leaks
462 iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
465 // These two are only while we are still with LyX 2.x
466 m = new MathMacroTemplate("emptyset"); // this leaks
468 array = new LyxArrayBase; // this leaks
470 iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
473 m = new MathMacroTemplate("perp"); // this leaks
475 array = new LyxArrayBase; // this leaks
477 iter.Insert(LM_bot, LM_TC_BOP);
480 // binom has two arguments
481 m = new MathMacroTemplate("binom", 2);
483 array = new LyxArrayBase;
486 inset = new MathDelimInset('(', ')');
487 iter.Insert(inset, LM_TC_ACTIVE_INSET);
488 array = new LyxArrayBase;
490 MathFracInset *frac = new MathFracInset(LM_OT_ATOP);
491 iter.Insert(frac, LM_TC_ACTIVE_INSET);
492 inset->SetData(array);
493 array = new LyxArrayBase;
494 array2 = new LyxArrayBase;
496 iter.Insert(m->getMacroPar(0));
497 iter.SetData(array2);
498 iter.Insert(m->getMacroPar(1));
499 frac->SetData(array, array2);
502 // Cases has 1 argument
503 m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
505 array = new LyxArrayBase; // this leaks
507 arg = new MathMatrixInset(2, 1); // this leaks
510 arg->SetAlign('c', "ll");
511 iter.Insert(arg, LM_TC_ACTIVE_INSET);
512 inset = new MathDelimInset('{', '.'); // this leaks
513 inset->SetData(array);
514 array = new LyxArrayBase; // this leaks
516 iter.Insert(inset, LM_TC_ACTIVE_INSET);
520 // the environment substack has 1 argument
521 m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
523 arg = new MathMatrixInset(1, 1); // this leaks
525 arg->SetType(LM_OT_MACRO);
526 array = new LyxArrayBase; // this leaks
528 iter.Insert(arg, LM_TC_ACTIVE_INSET);
533 MathMacroTable MathMacroTable::mathMTable(255);
534 bool MathMacroTable::built = false;