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, byte const* s, int ls);
  53 extern int mathed_string_height(short, int, byte const*, int, 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 int MathMacro::GetColumns()
 137 {
 138     return tmplate->getMacroPar(idx)->GetColumns();
 139 }
 140
 141
 142 void MathMacro::GetXY(int & x, int & y) const
 143 {
 144     x = args[idx].x;  y = args[idx].y;
 145 }
 146
 147
 148 bool MathMacro::Permit(short f)
 149 {
 150     return (nargs > 0) ?
 151             tmplate->getMacroPar(idx)->Permit(f) : MathParInset::Permit(f);
 152 }
 153
 154
 155 void MathMacro::SetFocus(int x, int y)
 156 {
 157     tmplate->update(this);
 158     tmplate->SetMacroFocus(idx, x, y);
 159 }
 160
 161
 162 void MathMacro::Write(ostream & os, bool fragile)
 163 {
 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);
 169     } else {
 170         if (tmplate->flags & MMF_Env) {
 171                 os << "\\begin{"
 172                    << name
 173                    << "} ";
 174         } else {
 175                 os << '\\' << name;
 176         }
 177 //      if (options) {
 178 //        file += '[';
 179 //        file += options;
 180 //        file += ']';
 181 //      }
 182
 183         if (!(tmplate->flags & MMF_Env) && nargs > 0)
 184                 os << '{';
 185
 186         for (int i = 0; i < nargs; ++i) {
 187             array = args[i].array;
 188             MathParInset::Write(os, fragile);
 189             if (i < nargs - 1)
 190                     os << "}{";
 191         }
 192         if (tmplate->flags & MMF_Env) {
 193                 os << "\\end{"
 194                    << name
 195                    << '}';
 196         } else {
 197             if (nargs > 0)
 198                     os << '}';
 199             else
 200                     os << ' ';
 201         }
 202     }
 203 }
 204
 205
 206 /*---------------  Macro argument -----------------------------------*/
 207
 208 MathMacroArgument::MathMacroArgument(int n)
 209 {
 210     number = n;
 211     expnd_mode = false;
 212     SetType(LM_OT_MACRO_ARG);
 213 }
 214
 215
 216 void MathMacroArgument::draw(Painter & pain, int x, int baseline)
 217 {
 218     if (expnd_mode) {
 219         MathParInset::draw(pain, x, baseline);
 220     } else {
 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);
 225     }
 226 }
 227
 228
 229 void MathMacroArgument::Metrics()
 230 {
 231     if (expnd_mode) {
 232         MathParInset::Metrics();
 233     } else {
 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()),
 240                                  2, ascent, descent);
 241     }
 242 }
 243
 244
 245 void MathMacroArgument::Write(ostream & os, bool fragile)
 246 {
 247     if (expnd_mode) {
 248         MathParInset::Write(os, fragile);
 249     } else {
 250             os << '#' << number << ' ';
 251     }
 252 }
 253
 254
 255 /* --------------------- MathMacroTemplate ---------------------------*/
 256
 257 MathMacroTemplate::MathMacroTemplate(string const & nm, int na, int flg):
 258     MathParInset(LM_ST_TEXT, nm, LM_OT_MACRO),
 259     flags(flg), nargs(na)
 260 {
 261     if (nargs > 0) {
 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);
 266         }
 267     } else
 268       tcode = LM_TC_INSET;
 269 }
 270
 271
 272 MathMacroTemplate::~MathMacroTemplate()
 273 {
 274     // prevent to delete already deleted objects
 275     for (int i = 0; i < nargs; ++i) {
 276         args[i].SetData(0);
 277     }
 278     delete[] args;
 279 }
 280
 281
 282 void MathMacroTemplate::setEditMode(bool ed)
 283 {
 284     if (ed) {
 285         flags |= MMF_Edit;
 286         for (int i = 0; i < nargs; ++i) {
 287             args[i].setExpand(false);
 288         }
 289     } else {
 290         flags &= ~MMF_Edit;
 291         for (int i = 0; i < nargs; ++i) {
 292             args[i].setExpand(true);
 293         }
 294     }
 295 }
 296
 297
 298 void MathMacroTemplate::draw(Painter & pain, int x, int y)
 299 {
 300     int x2, y2;
 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);
 305         }
 306       x2 = x; y2 = y;
 307     } else {
 308         for (int i = 0; i < nargs; ++i) {
 309             args[i].setExpand(true);
 310         }
 311       x2 = xo; y2 = yo;
 312     }
 313     MathParInset::draw(pain, x, y);
 314     xo = x2; yo = y2;
 315
 316     for (int i = 0; i < nargs; ++i) {
 317         args[i].setExpand(expnd);
 318     }
 319 }
 320
 321
 322 void MathMacroTemplate::Metrics()
 323 {
 324     bool expnd = (nargs>0) ? args[0].getExpand(): false;
 325
 326     if (flags & MMF_Edit) {
 327         for (int i = 0; i < nargs; ++i) {
 328             args[i].setExpand(false);
 329         }
 330     } else {
 331         for (int i = 0; i < nargs; ++i) {
 332             args[i].setExpand(true);
 333         }
 334     }
 335     MathParInset::Metrics();
 336
 337     for (int i = 0; i < nargs; ++i) {
 338         args[i].setExpand(expnd);
 339     }
 340 }
 341
 342
 343 void MathMacroTemplate::update(MathMacro * macro)
 344 {
 345     int idx = (macro) ? macro->getArgumentIdx(): 0;
 346     for (int i = 0; i < nargs; ++i) {
 347         if (macro) {
 348             macro->setArgumentIdx(i);
 349             args[i].SetData(macro->GetData());
 350             MathedRowSt *row = macro->getRowSt();
 351             args[i].setRowSt(row);
 352         }
 353     }
 354     if (macro)
 355       macro->setArgumentIdx(idx);
 356 }
 357
 358
 359 void MathMacroTemplate::WriteDef(ostream & os, bool fragile)
 360 {
 361         os << "\n\\newcommand{\\" << name << "}";
 362
 363     if (nargs > 0 )
 364             os << "[" << nargs << "]";
 365
 366     os << "{";
 367
 368     for (int i = 0; i < nargs; ++i) {
 369         args[i].setExpand(false);
 370     }
 371     Write(os, fragile);
 372     os << "}\n";
 373 }
 374
 375
 376 void MathMacroTemplate::setArgument(LyxArrayBase * a, int i)
 377 {
 378     args[i].SetData(a);
 379 }
 380
 381
 382 void MathMacroTemplate::GetMacroXY(int i, int & x, int & y) const
 383 {
 384     args[i].GetXY(x, y);
 385 }
 386
 387
 388 MathParInset * MathMacroTemplate::getMacroPar(int i) const
 389 {
 390     return (i >= 0 && i < nargs) ? static_cast<MathParInset*>(&args[i]) : 0;
 391 }
 392
 393
 394 void MathMacroTemplate::SetMacroFocus(int &idx, int x, int y)
 395 {
 396     for (int i = 0; i < nargs; ++i) {
 397         if (args[i].Inside(x, y)) {
 398             idx = i;
 399             break;
 400         }
 401     }
 402 }
 403
 404
 405 /* -------------------------- MathMacroTable -----------------------*/
 406
 407 MathMacroTable::MathMacroTable(int n) : max_macros(n)
 408 {
 409     macro_table = new MathMacroTemplateP[max_macros];
 410     num_macros = 0;
 411 }
 412
 413
 414 MathMacroTable::~MathMacroTable()
 415 {
 416     delete[] macro_table;
 417 }
 418
 419
 420 // The search is currently linear but will be binary or hash, later.
 421 MathMacroTemplate * MathMacroTable::getTemplate(string const & name) const
 422 {
 423     for (int i = 0; i < num_macros; ++i) {
 424       if (name == macro_table[i]->GetName())
 425         return macro_table[i];
 426     }
 427
 428     return 0;
 429 }
 430
 431 void MathMacroTable::addTemplate(MathMacroTemplate * m)
 432 {
 433     if (num_macros < max_macros)
 434       macro_table[num_macros++] = m;
 435     else
 436             lyxerr << "Error (MathMacroTable::addTemplate): "
 437                     "Macro table exhausted!" << endl;
 438 }
 439
 440
 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.   ;-)
 445
 446 void MathMacroTable::builtinMacros()
 447 {
 448     MathedIter iter;
 449     MathParInset * inset;// *arg;
 450     LyxArrayBase * array2;
 451
 452     built = true;
 453
 454     lyxerr[Debug::MATHED] << "Building macros" << endl;
 455
 456     // This macro doesn't have arguments
 457     MathMacroTemplate * m = new MathMacroTemplate("notin");  // this leaks
 458     addTemplate(m);
 459     LyxArrayBase * array = new LyxArrayBase; // this leaks
 460     iter.SetData(array);
 461     iter.Insert(new MathAccentInset(LM_in, LM_TC_BOPS, LM_not)); // this leaks
 462     m->SetData(array);
 463
 464     // These two are only while we are still with LyX 2.x
 465     m = new MathMacroTemplate("emptyset"); // this leaks
 466     addTemplate(m);
 467     array = new LyxArrayBase; // this leaks
 468     iter.SetData(array);
 469     iter.Insert(new MathAccentInset('O', LM_TC_RM, LM_not)); // this leaks
 470     m->SetData(array);
 471
 472     m = new MathMacroTemplate("perp"); // this leaks
 473     addTemplate(m);
 474     array = new LyxArrayBase; // this leaks
 475     iter.SetData(array);
 476     iter.Insert(LM_bot, LM_TC_BOP);
 477     m->SetData(array);
 478
 479     // binom has two arguments
 480     m = new MathMacroTemplate("binom", 2);
 481     addTemplate(m);
 482     array = new LyxArrayBase;
 483     m->SetData(array);
 484     iter.SetData(array);
 485     inset = new MathDelimInset('(', ')');
 486     iter.Insert(inset, LM_TC_ACTIVE_INSET);
 487     array = new LyxArrayBase;
 488     iter.SetData(array);
 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;
 494     iter.SetData(array);
 495     iter.Insert(m->getMacroPar(0));
 496     iter.SetData(array2);
 497     iter.Insert(m->getMacroPar(1));
 498     frac->SetData(array, array2);
 499
 500 /*
 501     // Cases has 1 argument
 502     m = new MathMacroTemplate("cases", 1, MMF_Env); // this leaks
 503     addTemplate(m);
 504     array = new LyxArrayBase; // this leaks
 505     iter.SetData(array);
 506     arg = new MathMatrixInset(2, 1); // this leaks
 507
 508     m->setArgument(arg);
 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
 514     iter.SetData(array);
 515     iter.Insert(inset, LM_TC_ACTIVE_INSET);
 516     m->SetData(array);
 517
 518
 519     // the environment substack has 1 argument
 520     m = new MathMacroTemplate("substack", 1, MMF_Env); // this leaks
 521     addTemplate(m);
 522     arg = new MathMatrixInset(1, 1); // this leaks
 523     m->setArgument(arg);
 524     arg->SetType(LM_OT_MACRO);
 525     array = new LyxArrayBase; // this leaks
 526     iter.SetData(array);
 527     iter.Insert(arg, LM_TC_ACTIVE_INSET);
 528     m->SetData(array);*/
 529 }
 530
 531
 532 MathMacroTable MathMacroTable::mathMTable(255);
 533 bool MathMacroTable::built = false;