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, byte const* s, int ls);
53 extern int mathed_string_height(short, int, byte const*, int, 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);
136 int MathMacro::GetColumns()
138 return tmplate->getMacroPar(idx)->GetColumns();
142 void MathMacro::GetXY(int & x, int & y) const
144 x = args[idx].x; y = args[idx].y;
148 bool MathMacro::Permit(short f)
151 tmplate->getMacroPar(idx)->Permit(f) : MathParInset::Permit(f);
155 void MathMacro::SetFocus(int x, int y)
157 tmplate->update(this);
158 tmplate->SetMacroFocus(idx, x, y);
162 void MathMacro::Write(ostream & os, bool fragile)
164 if (tmplate->flags & MMF_Exp) {
165 lyxerr[Debug::MATHED] << "Expand " << tmplate->flags
166 << ' ' << MMF_Exp << endl;
167 tmplate->update(this);
168 tmplate->Write(os, fragile);
170 if (tmplate->flags & MMF_Env) {
183 if (!(tmplate->flags & MMF_Env) && nargs > 0)
186 for (int i = 0; i < nargs; ++i) {
187 array = args[i].array;
188 MathParInset::Write(os, fragile);
192 if (tmplate->flags & MMF_Env) {
206 /*--------------- Macro argument -----------------------------------*/
208 MathMacroArgument::MathMacroArgument(int n)
212 SetType(LM_OT_MACRO_ARG);
216 void MathMacroArgument::draw(Painter & pain, int x, int baseline)
219 MathParInset::draw(pain, x, baseline);
221 std::ostringstream ost;
222 ost << '#' << number;
223 drawStr(pain, LM_TC_TEX, size, x, baseline,
224 reinterpret_cast<byte const *>(ost.str().c_str()), 2);
229 void MathMacroArgument::Metrics()
232 MathParInset::Metrics();
234 std::ostringstream ost;
235 ost << '#' << number;
236 width = mathed_string_width(LM_TC_TEX, size,
237 reinterpret_cast<byte const *>(ost.str().c_str()), 2);
238 mathed_string_height(LM_TC_TEX, size,
239 reinterpret_cast<byte const *>(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(char 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);
272 MathMacroTemplate::~MathMacroTemplate()
274 // prevent to delete already deleted objects
275 for (int i = 0; i < nargs; ++i) {
282 void MathMacroTemplate::setEditMode(bool ed)
286 for (int i = 0; i < nargs; ++i) {
287 args[i].setExpand(false);
291 for (int i = 0; i < nargs; ++i) {
292 args[i].setExpand(true);
298 void MathMacroTemplate::draw(Painter & pain, int x, int y)
301 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
302 if (flags & MMF_Edit) {
303 for (int i = 0; i < nargs; ++i) {
304 args[i].setExpand(false);
308 for (int i = 0; i < nargs; ++i) {
309 args[i].setExpand(true);
313 MathParInset::draw(pain, x, y);
316 for (int i = 0; i < nargs; ++i) {
317 args[i].setExpand(expnd);
322 void MathMacroTemplate::Metrics()
324 bool expnd = (nargs>0) ? args[0].getExpand(): false;
326 if (flags & MMF_Edit) {
327 for (int i = 0; i < nargs; ++i) {
328 args[i].setExpand(false);
331 for (int i = 0; i < nargs; ++i) {
332 args[i].setExpand(true);
335 MathParInset::Metrics();
337 for (int i = 0; i < nargs; ++i) {
338 args[i].setExpand(expnd);
343 void MathMacroTemplate::update(MathMacro * macro)
345 int idx = (macro) ? macro->getArgumentIdx(): 0;
346 for (int i = 0; i < nargs; ++i) {
348 macro->setArgumentIdx(i);
349 args[i].SetData(macro->GetData());
350 MathedRowSt *row = macro->getRowSt();
351 args[i].setRowSt(row);
355 macro->setArgumentIdx(idx);
359 void MathMacroTemplate::WriteDef(ostream & os, bool fragile)
361 os << "\n\\newcommand{\\" << name << "}";
364 os << "[" << nargs << "]";
368 for (int i = 0; i < nargs; ++i) {
369 args[i].setExpand(false);
376 void MathMacroTemplate::setArgument(LyxArrayBase * a, int i)
382 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
388 MathParInset * MathMacroTemplate::getMacroPar(int i) const
390 return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
394 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
396 for (int i = 0; i < nargs; ++i) {
397 if (args[i].Inside(x, y)) {
405 /* -------------------------- MathMacroTable -----------------------*/
407 MathMacroTable::MathMacroTable(int n) : max_macros(n)
409 macro_table = new MathMacroTemplateP[max_macros];
414 MathMacroTable::~MathMacroTable()
416 delete[] macro_table;
420 // The search is currently linear but will be binary or hash, later.
421 MathMacroTemplate * MathMacroTable::getTemplate(string const & name) const
423 for (int i = 0; i < num_macros; ++i) {
424 if (name == macro_table[i]->GetName())
425 return macro_table[i];
431 void MathMacroTable::addTemplate(MathMacroTemplate * m)
433 if (num_macros < max_macros)
434 macro_table[num_macros++] = m;
436 lyxerr << "Error (MathMacroTable::addTemplate): "
437 "Macro table exhausted!" << endl;
441 // All this stuff aparently leaks because it's created here and is not
442 // deleted never, but it have to live all the LyX sesion. OK, would not
443 // so hard to do it in the MacroTable destructor, but this doesn't harm
444 // seriously, so don't bother me with purify results here. ;-)
446 void MathMacroTable::builtinMacros()
449 MathParInset * inset;// *arg;
450 LyxArrayBase * array2;
454 lyxerr[Debug::MATHED] << "Building macros" << endl;
456 // This macro doesn't have arguments
457 MathMacroTemplate * m = new MathMacroTemplate("notin"); // this leaks
459 LyxArrayBase * array = new LyxArrayBase; // this leaks
461 iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
464 // These two are only while we are still with LyX 2.x
465 m = new MathMacroTemplate("emptyset"); // this leaks
467 array = new LyxArrayBase; // this leaks
469 iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
472 m = new MathMacroTemplate("perp"); // this leaks
474 array = new LyxArrayBase; // this leaks
476 iter.Insert(LM_bot, LM_TC_BOP);
479 // binom has two arguments
480 m = new MathMacroTemplate("binom", 2);
482 array = new LyxArrayBase;
485 inset = new MathDelimInset('(', ')');
486 iter.Insert(inset, LM_TC_ACTIVE_INSET);
487 array = new LyxArrayBase;
489 MathFracInset *frac = new MathFracInset(LM_OT_ATOP);
490 iter.Insert(frac, LM_TC_ACTIVE_INSET);
491 inset->SetData(array);
492 array = new LyxArrayBase;
493 array2 = new LyxArrayBase;
495 iter.Insert(m->getMacroPar(0));
496 iter.SetData(array2);
497 iter.Insert(m->getMacroPar(1));
498 frac->SetData(array, array2);
501 // Cases has 1 argument
502 m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
504 array = new LyxArrayBase; // this leaks
506 arg = new MathMatrixInset(2, 1); // this leaks
509 arg->SetAlign('c', "ll");
510 iter.Insert(arg, LM_TC_ACTIVE_INSET);
511 inset = new MathDelimInset('{', '.'); // this leaks
512 inset->SetData(array);
513 array = new LyxArrayBase; // this leaks
515 iter.Insert(inset, LM_TC_ACTIVE_INSET);
519 // the environment substack has 1 argument
520 m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
522 arg = new MathMatrixInset(1, 1); // this leaks
524 arg->SetType(LM_OT_MACRO);
525 array = new LyxArrayBase; // this leaks
527 iter.Insert(arg, LM_TC_ACTIVE_INSET);
532 MathMacroTable MathMacroTable::mathMTable(255);
533 bool MathMacroTable::built = false;