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 MathedArray;
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().c_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().c_str());
239 mathed_string_height(LM_TC_TEX, size, ost.str().c_str(),
245 void MathMacroArgument::Write(ostream & os, bool fragile)
248 MathParInset::Write(os, fragile);
250 os << '#' << number << ' ';
255 /* --------------------- MathMacroTemplate ---------------------------*/
257 MathMacroTemplate::MathMacroTemplate(string const & nm, int na, int flg):
258 MathParInset(LM_ST_TEXT, nm, LM_OT_MACRO),
259 flags(flg), nargs(na)
262 tcode = LM_TC_ACTIVE_INSET;
263 args = new MathMacroArgument[nargs];
264 for (int i = 0; i < nargs; ++i) {
265 args[i].setNumber(i + 1);
274 MathMacroTemplate::~MathMacroTemplate()
276 // prevent to delete already deleted objects
277 for (int i = 0; i < nargs; ++i) {
284 void MathMacroTemplate::setEditMode(bool ed)
288 for (int i = 0; i < nargs; ++i) {
289 args[i].setExpand(false);
293 for (int i = 0; i < nargs; ++i) {
294 args[i].setExpand(true);
300 void MathMacroTemplate::draw(Painter & pain, int x, int y)
303 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
304 if (flags & MMF_Edit) {
305 for (int i = 0; i < nargs; ++i) {
306 args[i].setExpand(false);
310 for (int i = 0; i < nargs; ++i) {
311 args[i].setExpand(true);
315 MathParInset::draw(pain, x, y);
318 for (int i = 0; i < nargs; ++i) {
319 args[i].setExpand(expnd);
324 void MathMacroTemplate::Metrics()
326 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
328 if (flags & MMF_Edit) {
329 for (int i = 0; i < nargs; ++i) {
330 args[i].setExpand(false);
333 for (int i = 0; i < nargs; ++i) {
334 args[i].setExpand(true);
337 MathParInset::Metrics();
339 for (int i = 0; i < nargs; ++i) {
340 args[i].setExpand(expnd);
345 void MathMacroTemplate::update(MathMacro * macro)
347 int idx = (macro) ? macro->getArgumentIdx() : 0;
348 for (int i = 0; i < nargs; ++i) {
350 macro->setArgumentIdx(i);
351 args[i].SetData(macro->GetData());
352 MathedRowSt * row = macro->getRowSt();
353 args[i].setRowSt(row);
357 macro->setArgumentIdx(idx);
361 void MathMacroTemplate::WriteDef(ostream & os, bool fragile)
363 os << "\n\\newcommand{\\" << name << "}";
366 os << "[" << nargs << "]";
370 for (int i = 0; i < nargs; ++i) {
371 args[i].setExpand(false);
378 void MathMacroTemplate::setArgument(MathedArray * a, int i)
384 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
390 MathParInset * MathMacroTemplate::getMacroPar(int i) const
392 return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
396 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
398 for (int i = 0; i < nargs; ++i) {
399 if (args[i].Inside(x, y)) {
407 /* -------------------------- MathMacroTable -----------------------*/
409 MathMacroTable::MathMacroTable(int n) : max_macros(n)
411 macro_table = new MathMacroTemplateP[max_macros];
416 MathMacroTable::~MathMacroTable()
418 delete[] macro_table;
422 // The search is currently linear but will be binary or hash, later.
423 MathMacroTemplate * MathMacroTable::getTemplate(string const & name) const
425 for (int i = 0; i < num_macros; ++i) {
426 if (name == macro_table[i]->GetName())
427 return macro_table[i];
433 void MathMacroTable::addTemplate(MathMacroTemplate * m)
435 if (num_macros < max_macros)
436 macro_table[num_macros++] = m;
438 lyxerr << "Error (MathMacroTable::addTemplate): "
439 "Macro table exhausted!" << endl;
443 // All this stuff aparently leaks because it's created here and is not
444 // deleted never, but it have to live all the LyX sesion. OK, would not
445 // so hard to do it in the MacroTable destructor, but this doesn't harm
446 // seriously, so don't bother me with purify results here. ;-)
448 void MathMacroTable::builtinMacros()
451 MathParInset * inset;// *arg;
452 MathedArray * array2;
456 lyxerr[Debug::MATHED] << "Building macros" << endl;
458 // This macro doesn't have arguments
459 MathMacroTemplate * m = new MathMacroTemplate("notin"); // this leaks
461 MathedArray * array = new MathedArray; // this leaks
463 iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
466 // These two are only while we are still with LyX 2.x
467 m = new MathMacroTemplate("emptyset"); // this leaks
469 array = new MathedArray; // this leaks
471 iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
474 m = new MathMacroTemplate("perp"); // this leaks
476 array = new MathedArray; // this leaks
478 iter.Insert(LM_bot, LM_TC_BOP);
481 // binom has two arguments
482 m = new MathMacroTemplate("binom", 2);
484 array = new MathedArray;
487 inset = new MathDelimInset('(', ')');
488 iter.Insert(inset, LM_TC_ACTIVE_INSET);
489 array = new MathedArray;
491 MathFracInset *frac = new MathFracInset(LM_OT_ATOP);
492 iter.Insert(frac, LM_TC_ACTIVE_INSET);
493 inset->SetData(array);
494 array = new MathedArray;
495 array2 = new MathedArray;
497 iter.Insert(m->getMacroPar(0));
498 iter.SetData(array2);
499 iter.Insert(m->getMacroPar(1));
500 frac->SetData(array, array2);
503 // Cases has 1 argument
504 m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
506 array = new MathedArray; // this leaks
508 arg = new MathMatrixInset(2, 1); // this leaks
511 arg->SetAlign('c', "ll");
512 iter.Insert(arg, LM_TC_ACTIVE_INSET);
513 inset = new MathDelimInset('{', '.'); // this leaks
514 inset->SetData(array);
515 array = new MathedArray; // this leaks
517 iter.Insert(inset, LM_TC_ACTIVE_INSET);
521 // the environment substack has 1 argument
522 m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
524 arg = new MathMatrixInset(1, 1); // this leaks
526 arg->SetType(LM_OT_MACRO);
527 array = new MathedArray; // this leaks
529 iter.Insert(arg, LM_TC_ACTIVE_INSET);
534 MathMacroTable MathMacroTable::mathMTable(255);
535 bool MathMacroTable::built = false;