src/mathed/math_macro.C

   1 // -*- C++ -*-
   2 /*
   3  *  File:        math_macro.C
   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
   8  *
   9  *  Dependencies: Mathed
  10  *
  11  *  Copyright: 1996, 1997 Alejandro Aguilar Sierra
  12  *
  13  *  Version: 0.2, Mathed & Lyx project.
  14  *
  15  *  This code is under the GNU General Public Licence version 2 or later.
  16  */
  17
  18 #include <config.h>
  19 #include FORMS_H_LOCATION
  20
  21 #ifdef __GNUG__
  22 #pragma implementation "math_macro.h"
  23 #pragma implementation "math_defs.h"
  24 #endif
  25
  26 #include "LString.h"
  27 #include "math_macro.h"
  28 #include "math_iter.h"
  29 #include "math_inset.h"
  30 #include "support/lstrings.h"
  31 #include "debug.h"
  32
  33 using std::ostream;
  34 using std::endl;
  35
  36 ostream & operator<<(ostream & o, MathedTextCodes mtc)
  37 {
  38         return o << int(mtc);
  39 }
  40
  41 enum MathedMacroFlag {
  42     MMF_Env= 1,
  43     MMF_Exp= 2,
  44     MMF_Edit= 4
  45 };
  46
  47 ostream & operator<<(ostream & o, MathedMacroFlag mmf)
  48 {
  49         return o << int(mmf);
  50 }
  51
  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 &);
  54
  55
  56 MathMacro::MathMacro(MathMacroTemplate* t):
  57     MathParInset(LM_ST_TEXT, "", LM_OT_MACRO), tmplate(t)
  58 {
  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());
  65 //      else
  66           args[i].row = 0;
  67 /*      int k = tmplate->getMacroPar(i)->GetColumns();
  68         if (k>0) {
  69             args[i].array = new LyxArrayBase;
  70             for (int j= 0; j<k-1; ++j) args[i].array->Insert(j, LM_TC_TAB);
  71         }*/
  72     }
  73     idx = 0;
  74     SetName(tmplate->GetName());
  75 }
  76
  77
  78 MathMacro::MathMacro(MathMacro * m):
  79     MathParInset(LM_ST_TEXT, m->GetName(), LM_OT_MACRO)
  80 {
  81     tmplate = m->tmplate;
  82     nargs = tmplate->getNoArgs();
  83     tcode = tmplate->getTCode();
  84     args = new MacroArgumentBase[nargs];
  85     idx = 0;
  86     SetName(tmplate->GetName());
  87     for (int i = 0; i < tmplate->nargs; ++i) {
  88         m->setArgumentIdx(i);
  89         MathedIter it(m->GetData());
  90         args[i].row = m->args[i].row;
  91         args[i].array = it.Copy();
  92     }
  93 }
  94
  95 MathMacro::~MathMacro()
  96 {
  97     for (idx = 0; idx < nargs; ++idx) {
  98         MathedIter it(args[idx].array);
  99         it. Clear();
 100         delete args[idx].row;
 101     }
 102     delete[] args;
 103 }
 104
 105
 106 MathedInset * MathMacro::Clone()
 107 {
 108     return new MathMacro(this);
 109 }
 110
 111
 112 void MathMacro::Metrics()
 113 {
 114     if (nargs > 0)
 115       tmplate->update(this);
 116     tmplate->SetStyle(size);
 117     tmplate->Metrics();
 118     width = tmplate->Width();
 119     ascent = tmplate->Ascent();
 120     descent = tmplate->Descent();
 121 }
 122
 123
 124 void MathMacro::draw(Painter & pain, int x, int y)
 125 {
 126     xo = x;  yo = y;
 127     Metrics();
 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);
 133     }
 134 }
 135
 136
 137 int MathMacro::GetColumns() const
 138 {
 139     return tmplate->getMacroPar(idx)->GetColumns();
 140 }
 141
 142
 143 void MathMacro::GetXY(int & x, int & y) const
 144 {
 145     x = args[idx].x;  y = args[idx].y;
 146 }
 147
 148
 149 bool MathMacro::Permit(short f)
 150 {
 151     return (nargs > 0) ?
 152             tmplate->getMacroPar(idx)->Permit(f) : MathParInset::Permit(f);
 153 }
 154
 155
 156 void MathMacro::SetFocus(int x, int y)
 157 {
 158     tmplate->update(this);
 159     tmplate->SetMacroFocus(idx, x, y);
 160 }
 161
 162
 163 void MathMacro::Write(ostream & os, bool fragile)
 164 {
 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);
 170     } else {
 171         if (tmplate->flags & MMF_Env) {
 172                 os << "\\begin{"
 173                    << name
 174                    << "} ";
 175         } else {
 176                 os << '\\' << name;
 177         }
 178 //      if (options) {
 179 //        file += '[';
 180 //        file += options;
 181 //        file += ']';
 182 //      }
 183
 184         if (!(tmplate->flags & MMF_Env) && nargs > 0)
 185                 os << '{';
 186
 187         for (int i = 0; i < nargs; ++i) {
 188             array = args[i].array;
 189             MathParInset::Write(os, fragile);
 190             if (i < nargs - 1)
 191                     os << "}{";
 192         }
 193         if (tmplate->flags & MMF_Env) {
 194                 os << "\\end{"
 195                    << name
 196                    << '}';
 197         } else {
 198             if (nargs > 0)
 199                     os << '}';
 200             else
 201                     os << ' ';
 202         }
 203     }
 204 }
 205
 206
 207 /*---------------  Macro argument -----------------------------------*/
 208
 209 MathMacroArgument::MathMacroArgument(int n)
 210 {
 211     number = n;
 212     expnd_mode = false;
 213     SetType(LM_OT_MACRO_ARG);
 214 }
 215
 216
 217 void MathMacroArgument::draw(Painter & pain, int x, int baseline)
 218 {
 219         if (expnd_mode) {
 220                 MathParInset::draw(pain, x, baseline);
 221         }
 222         else {
 223                 std::ostringstream ost;
 224                 ost << '#' << number;
 225                 drawStr(pain, LM_TC_TEX, size, x, baseline, ost.str());
 226         }
 227 }
 228
 229
 230 void MathMacroArgument::Metrics()
 231 {
 232         if (expnd_mode) {
 233                 MathParInset::Metrics();
 234         }
 235         else {
 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);
 240         }
 241 }
 242
 243
 244 void MathMacroArgument::Write(ostream & os, bool fragile)
 245 {
 246     if (expnd_mode) {
 247         MathParInset::Write(os, fragile);
 248     } else {
 249             os << '#' << number << ' ';
 250     }
 251 }
 252
 253
 254 /* --------------------- MathMacroTemplate ---------------------------*/
 255
 256 MathMacroTemplate::MathMacroTemplate(string const & nm, int na, int flg):
 257     MathParInset(LM_ST_TEXT, nm, LM_OT_MACRO),
 258     flags(flg), nargs(na)
 259 {
 260     if (nargs > 0) {
 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);
 265         }
 266     } else {
 267         tcode = LM_TC_INSET;
 268         args = 0;
 269     }
 270 }
 271
 272
 273 MathMacroTemplate::~MathMacroTemplate()
 274 {
 275     // prevent to delete already deleted objects
 276     for (int i = 0; i < nargs; ++i) {
 277         args[i].SetData(0);
 278     }
 279     delete[] args;
 280 }
 281
 282
 283 void MathMacroTemplate::setEditMode(bool ed)
 284 {
 285     if (ed) {
 286         flags |= MMF_Edit;
 287         for (int i = 0; i < nargs; ++i) {
 288             args[i].setExpand(false);
 289         }
 290     } else {
 291         flags &= ~MMF_Edit;
 292         for (int i = 0; i < nargs; ++i) {
 293             args[i].setExpand(true);
 294         }
 295     }
 296 }
 297
 298
 299 void MathMacroTemplate::draw(Painter & pain, int x, int y)
 300 {
 301     int x2, y2;
 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);
 306         }
 307       x2 = x; y2 = y;
 308     } else {
 309         for (int i = 0; i < nargs; ++i) {
 310             args[i].setExpand(true);
 311         }
 312       x2 = xo; y2 = yo;
 313     }
 314     MathParInset::draw(pain, x, y);
 315     xo = x2; yo = y2;
 316
 317     for (int i = 0; i < nargs; ++i) {
 318         args[i].setExpand(expnd);
 319     }
 320 }
 321
 322
 323 void MathMacroTemplate::Metrics()
 324 {
 325     bool expnd = (nargs > 0) ? args[0].getExpand(): false;
 326
 327     if (flags & MMF_Edit) {
 328         for (int i = 0; i < nargs; ++i) {
 329             args[i].setExpand(false);
 330         }
 331     } else {
 332         for (int i = 0; i < nargs; ++i) {
 333             args[i].setExpand(true);
 334         }
 335     }
 336     MathParInset::Metrics();
 337
 338     for (int i = 0; i < nargs; ++i) {
 339         args[i].setExpand(expnd);
 340     }
 341 }
 342
 343
 344 void MathMacroTemplate::update(MathMacro * macro)
 345 {
 346     int idx = (macro) ? macro->getArgumentIdx() : 0;
 347     for (int i = 0; i < nargs; ++i) {
 348         if (macro) {
 349             macro->setArgumentIdx(i);
 350             args[i].SetData(macro->GetData());
 351             MathedRowSt * row = macro->getRowSt();
 352             args[i].setRowSt(row);
 353         }
 354     }
 355     if (macro)
 356       macro->setArgumentIdx(idx);
 357 }
 358
 359
 360 void MathMacroTemplate::WriteDef(ostream & os, bool fragile)
 361 {
 362         os << "\n\\newcommand{\\" << name << "}";
 363
 364     if (nargs > 0 )
 365             os << "[" << nargs << "]";
 366
 367     os << "{";
 368
 369     for (int i = 0; i < nargs; ++i) {
 370         args[i].setExpand(false);
 371     }
 372     Write(os, fragile);
 373     os << "}\n";
 374 }
 375
 376
 377 void MathMacroTemplate::setArgument(LyxArrayBase * a, int i)
 378 {
 379     args[i].SetData(a);
 380 }
 381
 382
 383 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
 384 {
 385     args[i].GetXY(x, y);
 386 }
 387
 388
 389 MathParInset * MathMacroTemplate::getMacroPar(int i) const
 390 {
 391     return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
 392 }
 393
 394
 395 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
 396 {
 397     for (int i = 0; i < nargs; ++i) {
 398         if (args[i].Inside(x, y)) {
 399             idx = i;
 400             break;
 401         }
 402     }
 403 }
 404
 405
 406 /* -------------------------- MathMacroTable -----------------------*/
 407
 408 MathMacroTable::MathMacroTable(int n) : max_macros(n)
 409 {
 410     macro_table = new MathMacroTemplateP[max_macros];
 411     num_macros = 0;
 412 }
 413
 414
 415 MathMacroTable::~MathMacroTable()
 416 {
 417     delete[] macro_table;
 418 }
 419
 420
 421 // The search is currently linear but will be binary or hash, later.
 422 MathMacroTemplate * MathMacroTable::getTemplate(string const & name) const
 423 {
 424     for (int i = 0; i < num_macros; ++i) {
 425       if (name == macro_table[i]->GetName())
 426         return macro_table[i];
 427     }
 428
 429     return 0;
 430 }
 431
 432 void MathMacroTable::addTemplate(MathMacroTemplate * m)
 433 {
 434     if (num_macros < max_macros)
 435       macro_table[num_macros++] = m;
 436     else
 437             lyxerr << "Error (MathMacroTable::addTemplate): "
 438                     "Macro table exhausted!" << endl;
 439 }
 440
 441
 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.   ;-)
 446
 447 void MathMacroTable::builtinMacros()
 448 {
 449     MathedIter iter;
 450     MathParInset * inset;// *arg;
 451     LyxArrayBase * array2;
 452
 453     built = true;
 454
 455     lyxerr[Debug::MATHED] << "Building macros" << endl;
 456
 457     // This macro doesn't have arguments
 458     MathMacroTemplate * m = new MathMacroTemplate("notin");  // this leaks
 459     addTemplate(m);
 460     LyxArrayBase * array = new LyxArrayBase; // this leaks
 461     iter.SetData(array);
 462     iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
 463     m->SetData(array);
 464
 465     // These two are only while we are still with LyX 2.x
 466     m = new MathMacroTemplate("emptyset"); // this leaks
 467     addTemplate(m);
 468     array = new LyxArrayBase; // this leaks
 469     iter.SetData(array);
 470     iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
 471     m->SetData(array);
 472
 473     m = new MathMacroTemplate("perp"); // this leaks
 474     addTemplate(m);
 475     array = new LyxArrayBase; // this leaks
 476     iter.SetData(array);
 477     iter.Insert(LM_bot, LM_TC_BOP);
 478     m->SetData(array);
 479
 480     // binom has two arguments
 481     m = new MathMacroTemplate("binom", 2);
 482     addTemplate(m);
 483     array = new LyxArrayBase;
 484     m->SetData(array);
 485     iter.SetData(array);
 486     inset = new MathDelimInset('(', ')');
 487     iter.Insert(inset, LM_TC_ACTIVE_INSET);
 488     array = new LyxArrayBase;
 489     iter.SetData(array);
 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;
 495     iter.SetData(array);
 496     iter.Insert(m->getMacroPar(0));
 497     iter.SetData(array2);
 498     iter.Insert(m->getMacroPar(1));
 499     frac->SetData(array, array2);
 500
 501 /*
 502     // Cases has 1 argument
 503     m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
 504     addTemplate(m);
 505     array = new LyxArrayBase; // this leaks
 506     iter.SetData(array);
 507     arg = new MathMatrixInset(2, 1); // this leaks
 508
 509     m->setArgument(arg);
 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
 515     iter.SetData(array);
 516     iter.Insert(inset, LM_TC_ACTIVE_INSET);
 517     m->SetData(array);
 518
 519
 520     // the environment substack has 1 argument
 521     m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
 522     addTemplate(m);
 523     arg = new MathMatrixInset(1, 1); // this leaks
 524     m->setArgument(arg);
 525     arg->SetType(LM_OT_MACRO);
 526     array = new LyxArrayBase; // this leaks
 527     iter.SetData(array);
 528     iter.Insert(arg, LM_TC_ACTIVE_INSET);
 529     m->SetData(array);*/
 530 }
 531
 532
 533 MathMacroTable MathMacroTable::mathMTable(255);
 534 bool MathMacroTable::built = false;