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: (c) 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"
34 ostream & operator<<(ostream & o, MathedTextCodes mtc)
39 enum MathedMacroFlag {
45 ostream & operator<<(ostream & o, MathedMacroFlag mmf)
50 extern int mathed_string_width(short type, int style, byte const* s, int ls);
51 extern int mathed_string_height(short, int, byte const*, int, int&, int&);
54 MathMacro::MathMacro(MathMacroTemplate* t):
55 MathParInset(LM_ST_TEXT, "", LM_OT_MACRO), tmplate(t)
57 nargs = tmplate->getNoArgs();
58 tcode = tmplate->getTCode();
59 args = new MacroArgumentBase[nargs];
60 for (int i = 0; i < nargs; ++i) {
61 // if (tmplate->getMacroPar(i)->Permit(LMPF_ALLOW_CR))
62 // args[i].row = new MathedRowSt(tmplate->getMacroPar(i)->GetColumns());
65 /* int k = tmplate->getMacroPar(i)->GetColumns();
67 args[i].array = new LyxArrayBase;
68 for (int j= 0; j<k-1; ++j) args[i].array->Insert(j, LM_TC_TAB);
72 SetName(tmplate->GetName());
76 MathMacro::MathMacro(MathMacro * m):
77 MathParInset(LM_ST_TEXT, m->GetName(), LM_OT_MACRO)
80 nargs = tmplate->getNoArgs();
81 tcode = tmplate->getTCode();
82 args = new MacroArgumentBase[nargs];
84 SetName(tmplate->GetName());
85 for (int i = 0; i < tmplate->nargs; ++i) {
87 MathedIter it(m->GetData());
88 args[i].row = m->args[i].row;
89 args[i].array = it.Copy();
93 MathMacro::~MathMacro()
95 for (idx = 0; idx < nargs; ++idx) {
96 MathedIter it(args[idx].array);
104 MathedInset * MathMacro::Clone()
106 return new MathMacro(this);
110 void MathMacro::Metrics()
113 tmplate->update(this);
115 width = tmplate->Width();
116 ascent = tmplate->Ascent();
117 descent = tmplate->Descent();
121 void MathMacro::draw(Painter & pain, int x, int y)
125 tmplate->update(this);
126 tmplate->SetStyle(size);
127 tmplate->draw(pain, x, y);
128 for (int i = 0; i < nargs; ++i)
129 tmplate->GetMacroXY(i, args[i].x, args[i].y);
133 int MathMacro::GetColumns()
135 return tmplate->getMacroPar(idx)->GetColumns();
139 void MathMacro::GetXY(int & x, int & y) const
141 x = args[idx].x; y = args[idx].y;
145 bool MathMacro::Permit(short f)
148 tmplate->getMacroPar(idx)->Permit(f) : MathParInset::Permit(f);
152 void MathMacro::SetFocus(int x, int y)
154 tmplate->update(this);
155 tmplate->SetMacroFocus(idx, x, y);
159 void MathMacro::Write(ostream & os)
161 #ifdef USE_OSTREAM_ONLY
162 if (tmplate->flags & MMF_Exp) {
163 lyxerr[Debug::MATHED] << "Expand " << tmplate->flags
164 << ' ' << MMF_Exp << endl;
165 tmplate->update(this);
168 if (tmplate->flags & MMF_Env) {
181 if (!(tmplate->flags & MMF_Env) && nargs > 0)
184 for (int i = 0; i < nargs; ++i) {
185 array = args[i].array;
186 MathParInset::Write(os);
190 if (tmplate->flags & MMF_Env) {
203 MathMacro::Write(output);
209 #ifndef USE_OSTREAM_ONLY
210 void MathMacro::Write(string &file)
212 if (tmplate->flags & MMF_Exp) {
213 lyxerr[Debug::MATHED] << "Expand " << tmplate->flags
214 << ' ' << MMF_Exp << endl;
215 tmplate->update(this);
216 tmplate->Write(file);
218 if (tmplate->flags & MMF_Env) {
232 if (!(tmplate->flags & MMF_Env) && nargs > 0)
235 for (int i = 0; i < nargs; ++i) {
236 array = args[i].array;
237 MathParInset::Write(file);
241 if (tmplate->flags & MMF_Env) {
256 /*--------------- Macro argument -----------------------------------*/
258 MathMacroArgument::MathMacroArgument(int n)
262 SetType(LM_OT_MACRO_ARG);
266 void MathMacroArgument::draw(Painter & pain, int x, int baseline)
269 MathParInset::draw(pain, x, baseline);
272 sprintf(reinterpret_cast<char*>(s), "#%d", number);
273 drawStr(pain, LM_TC_TEX, size, x, baseline, &s[0], 2);
278 void MathMacroArgument::Metrics()
281 MathParInset::Metrics();
284 sprintf(reinterpret_cast<char*>(s), "#%d", number);
285 width = mathed_string_width(LM_TC_TEX, size, &s[0], 2);
286 mathed_string_height(LM_TC_TEX, size, &s[0], 2, ascent, descent);
291 void MathMacroArgument::Write(ostream & os)
293 #ifdef USE_OSTREAM_ONLY
295 MathParInset::Write(os);
297 os << '#' << number << ' ';
301 MathMacroArgument::Write(output);
307 #ifndef USE_OSTREAM_ONLY
308 void MathMacroArgument::Write(string & file)
311 MathParInset::Write(file);
314 file += tostr(number);
321 /* --------------------- MathMacroTemplate ---------------------------*/
323 MathMacroTemplate::MathMacroTemplate(char const * nm, int na, int flg):
324 MathParInset(LM_ST_TEXT, nm, LM_OT_MACRO),
325 flags(flg), nargs(na)
328 tcode = LM_TC_ACTIVE_INSET;
329 args = new MathMacroArgument[nargs];
330 for (int i = 0; i < nargs; ++i) {
331 args[i].setNumber(i + 1);
338 MathMacroTemplate::~MathMacroTemplate()
340 // prevent to delete already deleted objects
341 for (int i = 0; i < nargs; ++i) {
348 void MathMacroTemplate::setEditMode(bool ed)
352 for (int i = 0; i < nargs; ++i) {
353 args[i].setExpand(false);
357 for (int i = 0; i < nargs; ++i) {
358 args[i].setExpand(true);
364 void MathMacroTemplate::draw(Painter & pain, int x, int y)
367 bool expnd = (nargs > 0) ? args[0].getExpand(): false;
368 if (flags & MMF_Edit) {
369 for (int i = 0; i < nargs; ++i) {
370 args[i].setExpand(false);
374 for (int i = 0; i < nargs; ++i) {
375 args[i].setExpand(true);
379 MathParInset::draw(pain, x, y);
382 for (int i = 0; i < nargs; ++i) {
383 args[i].setExpand(expnd);
388 void MathMacroTemplate::Metrics()
390 bool expnd = (nargs>0) ? args[0].getExpand(): false;
392 if (flags & MMF_Edit) {
393 for (int i = 0; i < nargs; ++i) {
394 args[i].setExpand(false);
397 for (int i = 0; i < nargs; ++i) {
398 args[i].setExpand(true);
401 MathParInset::Metrics();
403 for (int i = 0; i < nargs; ++i) {
404 args[i].setExpand(expnd);
409 void MathMacroTemplate::update(MathMacro * macro)
411 int idx = (macro) ? macro->getArgumentIdx(): 0;
412 for (int i = 0; i < nargs; ++i) {
414 macro->setArgumentIdx(i);
415 args[i].SetData(macro->GetData());
416 MathedRowSt *row = macro->getRowSt();
417 args[i].setRowSt(row);
421 macro->setArgumentIdx(idx);
425 void MathMacroTemplate::WriteDef(ostream & os)
427 os << "\n\\newcommand{\\" << name << "}";
430 os << "[" << nargs << "]";
434 for (int i = 0; i < nargs; ++i) {
435 args[i].setExpand(false);
442 #ifndef USE_OSTREAM_ONLY
443 void MathMacroTemplate::WriteDef(string & file)
445 file += "\n\\newcommand{\\";
451 file += tostr(nargs);
457 for (int i = 0; i < nargs; ++i) {
458 args[i].setExpand(false);
466 void MathMacroTemplate::setArgument(LyxArrayBase * a, int i)
472 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
478 MathParInset * MathMacroTemplate::getMacroPar(int i) const
480 return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
484 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
486 for (int i = 0; i < nargs; ++i) {
487 if (args[i].Inside(x, y)) {
495 /* -------------------------- MathMacroTable -----------------------*/
497 MathMacroTable::MathMacroTable(int n) : max_macros(n)
499 macro_table = new MathMacroTemplateP[max_macros];
504 MathMacroTable::~MathMacroTable()
506 delete[] macro_table;
510 // The search is currently linear but will be binary or hash, later.
511 MathMacroTemplate * MathMacroTable::getTemplate(char const * name) const
513 for (int i = 0; i < num_macros; ++i) {
514 if (strcmp(name, macro_table[i]->GetName()) == 0)
515 return macro_table[i];
521 void MathMacroTable::addTemplate(MathMacroTemplate * m)
523 if (num_macros < max_macros)
524 macro_table[num_macros++] = m;
526 lyxerr << "Error (MathMacroTable::addTemplate): "
527 "Macro table exhausted!" << endl;
531 // All this stuff aparently leaks because it's created here and is not
532 // deleted never, but it have to live all the LyX sesion. OK, would not
533 // so hard to do it in the MacroTable destructor, but this doesn't harm
534 // seriously, so don't bother me with purify results here. ;-)
536 void MathMacroTable::builtinMacros()
539 MathParInset * inset;// *arg;
540 LyxArrayBase * array2;
544 lyxerr[Debug::MATHED] << "Building macros" << endl;
546 // This macro doesn't have arguments
547 MathMacroTemplate * m = new MathMacroTemplate("notin"); // this leaks
549 LyxArrayBase * array = new LyxArrayBase; // this leaks
551 iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
554 // These two are only while we are still with LyX 2.x
555 m = new MathMacroTemplate("emptyset"); // this leaks
557 array = new LyxArrayBase; // this leaks
559 iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
562 m = new MathMacroTemplate("perp"); // this leaks
564 array = new LyxArrayBase; // this leaks
566 iter.Insert(LM_bot, LM_TC_BOP);
569 // binom has two arguments
570 m = new MathMacroTemplate("binom", 2);
572 array = new LyxArrayBase;
575 inset = new MathDelimInset('(', ')');
576 iter.Insert(inset, LM_TC_ACTIVE_INSET);
577 array = new LyxArrayBase;
579 MathFracInset *frac = new MathFracInset(LM_OT_ATOP);
580 iter.Insert(frac, LM_TC_ACTIVE_INSET);
581 inset->SetData(array);
582 array = new LyxArrayBase;
583 array2 = new LyxArrayBase;
585 iter.Insert(m->getMacroPar(0));
586 iter.SetData(array2);
587 iter.Insert(m->getMacroPar(1));
588 frac->SetData(array, array2);
591 // Cases has 1 argument
592 m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
594 array = new LyxArrayBase; // this leaks
596 arg = new MathMatrixInset(2, 1); // this leaks
599 arg->SetAlign('c', "ll");
600 iter.Insert(arg, LM_TC_ACTIVE_INSET);
601 inset = new MathDelimInset('{', '.'); // this leaks
602 inset->SetData(array);
603 array = new LyxArrayBase; // this leaks
605 iter.Insert(inset, LM_TC_ACTIVE_INSET);
609 // the environment substack has 1 argument
610 m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
612 arg = new MathMatrixInset(1, 1); // this leaks
614 arg->SetType(LM_OT_MACRO);
615 array = new LyxArrayBase; // this leaks
617 iter.Insert(arg, LM_TC_ACTIVE_INSET);
622 MathMacroTable MathMacroTable::mathMTable(255);
623 bool MathMacroTable::built = false;