src/mathed/MathMacroTemplate.cpp

   1 /**
   2  * \file MathMacroTemplate.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Stefan Schimanski
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "MathMacroTemplate.h"
  15
  16 #include "DocIterator.h"
  17 #include "LaTeXFeatures.h"
  18 #include "InsetMathBrace.h"
  19 #include "InsetMathChar.h"
  20 #include "InsetMathHull.h"
  21 #include "InsetMathSqrt.h"
  22 #include "MathMacro.h"
  23 #include "MathMacroArgument.h"
  24 #include "MathStream.h"
  25 #include "MathParser.h"
  26 #include "MathSupport.h"
  27 #include "MathMacroArgument.h"
  28
  29 #include "Buffer.h"
  30 #include "BufferView.h"
  31 #include "Color.h"
  32 #include "Cursor.h"
  33 #include "DispatchResult.h"
  34 #include "FuncRequest.h"
  35 #include "FuncStatus.h"
  36 #include "Lexer.h"
  37 #include "LyXRC.h"
  38 #include "Undo.h"
  39
  40 #include "frontends/Painter.h"
  41
  42 #include "insets/RenderPreview.h"
  43
  44 #include "support/lassert.h"
  45 #include "support/convert.h"
  46 #include "support/debug.h"
  47 #include "support/gettext.h"
  48 #include "support/docstream.h"
  49 #include "support/lstrings.h"
  50
  51 #include <sstream>
  52
  53 using namespace std;
  54
  55 namespace lyx {
  56
  57 using support::bformat;
  58
  59 //////////////////////////////////////////////////////////////////////
  60
  61 class InsetLabelBox : public InsetMathNest {
  62 public:
  63         ///
  64         InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
  65                       MathMacroTemplate const & parent, bool frame = false);
  66         InsetLabelBox(Buffer * buf, docstring label, MathMacroTemplate const & parent,
  67                       bool frame = false);
  68         ///
  69         void metrics(MetricsInfo & mi, Dimension & dim) const;
  70         ///
  71         void draw(PainterInfo &, int x, int y) const;
  72
  73 protected:
  74         ///
  75         MathMacroTemplate const & parent_;
  76         ///
  77         Inset * clone() const;
  78         ///
  79         docstring const label_;
  80         ///
  81         bool frame_;
  82 };
  83
  84
  85 InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
  86         MathMacroTemplate const & parent, bool frame)
  87         : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
  88 {
  89         cell(0).insert(0, atom);
  90 }
  91
  92
  93 InsetLabelBox::InsetLabelBox(Buffer * buf, docstring label,
  94                              MathMacroTemplate const & parent, bool frame)
  95         : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
  96 {
  97 }
  98
  99
 100 Inset * InsetLabelBox::clone() const
 101 {
 102         return new InsetLabelBox(*this);
 103 }
 104
 105
 106 void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
 107 {
 108         // kernel
 109         cell(0).metrics(mi, dim);
 110
 111         // frame
 112         if (frame_) {
 113                 dim.wid += 6;
 114                 dim.asc += 5;
 115                 dim.des += 5;
 116         }
 117
 118         // adjust to common height in main metrics phase
 119         if (!parent_.premetrics()) {
 120                 dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
 121                 dim.des = max(dim.des, parent_.commonLabelBoxDescent());
 122         }
 123
 124         // label
 125         if (parent_.editing(mi.base.bv) && label_.length() > 0) {
 126                 // grey
 127                 FontInfo font = sane_font;
 128                 font.setSize(FONT_SIZE_TINY);
 129                 font.setColor(Color_mathmacrolabel);
 130
 131                 // make space for label and box
 132                 int lwid = mathed_string_width(font, label_);
 133                 int maxasc;
 134                 int maxdes;
 135                 math_font_max_dim(font, maxasc, maxdes);
 136
 137                 dim.wid = max(dim.wid, lwid + 2);
 138
 139                 // space for the label
 140                 if (!parent_.premetrics())
 141                         dim.des += maxasc + maxdes + 1;
 142         }
 143 }
 144
 145
 146 void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
 147 {
 148         Dimension const dim = dimension(*pi.base.bv);
 149         Dimension const cdim = cell(0).dimension(*pi.base.bv);
 150
 151         // kernel
 152         cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
 153
 154         // label
 155         if (parent_.editing(pi.base.bv) && label_.length() > 0) {
 156                 // grey
 157                 FontInfo font = sane_font;
 158                 font.setSize(FONT_SIZE_TINY);
 159                 font.setColor(Color_mathmacrolabel);
 160
 161                 // make space for label and box
 162                 int lwid = mathed_string_width(font, label_);
 163                 int maxasc;
 164                 int maxdes;
 165                 math_font_max_dim(font, maxasc, maxdes);
 166
 167                 if (lwid < dim.wid)
 168                         pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
 169                 else
 170                         pi.pain.text(x, y + dim.des - maxdes, label_, font);
 171         }
 172
 173         // draw frame
 174         int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
 175         if (frame_) {
 176                 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
 177                                   dim.wid - 2, boxHeight - 2,
 178                                   Color_mathline);
 179         }
 180 }
 181
 182
 183 //////////////////////////////////////////////////////////////////////
 184
 185 class DisplayLabelBox : public InsetLabelBox {
 186 public:
 187         ///
 188         DisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
 189                         MathMacroTemplate const & parent);
 190
 191         ///
 192         void metrics(MetricsInfo & mi, Dimension & dim) const;
 193         ///
 194         void draw(PainterInfo &, int x, int y) const;
 195
 196 protected:
 197         ///
 198         Inset * clone() const;
 199 };
 200
 201
 202 DisplayLabelBox::DisplayLabelBox(Buffer * buf, MathAtom const & atom,
 203                                  docstring label,
 204                                  MathMacroTemplate const & parent)
 205         : InsetLabelBox(buf, atom, label, parent, true)
 206 {
 207 }
 208
 209
 210
 211 Inset * DisplayLabelBox::clone() const
 212 {
 213         return new DisplayLabelBox(*this);
 214 }
 215
 216
 217 void DisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
 218 {
 219         InsetLabelBox::metrics(mi, dim);
 220         if (!parent_.editing(mi.base.bv)
 221             && parent_.cell(parent_.displayIdx()).empty()) {
 222                 dim.wid = 0;
 223                 dim.asc = 0;
 224                 dim.des = 0;
 225         }
 226 }
 227
 228
 229 void DisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
 230 {
 231         if (parent_.editing(pi.base.bv)
 232             || !parent_.cell(parent_.displayIdx()).empty()) {
 233                 InsetLabelBox::draw(pi, x, y);
 234         } else {
 235                 bool enabled = pi.pain.isDrawingEnabled();
 236                 pi.pain.setDrawingEnabled(false);
 237                 InsetLabelBox::draw(pi, x, y);
 238                 pi.pain.setDrawingEnabled(enabled);
 239         }
 240 }
 241
 242
 243 //////////////////////////////////////////////////////////////////////
 244
 245 class InsetMathWrapper : public InsetMath {
 246 public:
 247         ///
 248         InsetMathWrapper(MathData const * value) : value_(value) {}
 249         ///
 250         void metrics(MetricsInfo & mi, Dimension & dim) const;
 251         ///
 252         void draw(PainterInfo &, int x, int y) const;
 253
 254 private:
 255         ///
 256         Inset * clone() const;
 257         ///
 258         MathData const * value_;
 259 };
 260
 261
 262 Inset * InsetMathWrapper::clone() const
 263 {
 264         return new InsetMathWrapper(*this);
 265 }
 266
 267
 268 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 269 {
 270         value_->metrics(mi, dim);
 271         //metricsMarkers2(dim);
 272 }
 273
 274
 275 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
 276 {
 277         value_->draw(pi, x, y);
 278         //drawMarkers(pi, x, y);
 279 }
 280
 281
 282 ///////////////////////////////////////////////////////////////////////
 283 class InsetColoredCell : public InsetMathNest {
 284 public:
 285         ///
 286         InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max);
 287         ///
 288         InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom);
 289         ///
 290         void draw(PainterInfo &, int x, int y) const;
 291         ///
 292         void metrics(MetricsInfo & mi, Dimension & dim) const;
 293
 294 protected:
 295         ///
 296         Inset * clone() const;
 297         ///
 298         ColorCode min_;
 299         ///
 300         ColorCode max_;
 301 };
 302
 303
 304 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max)
 305         : InsetMathNest(buf, 1), min_(min), max_(max)
 306 {
 307 }
 308
 309
 310 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom)
 311         : InsetMathNest(buf, 1), min_(min), max_(max)
 312 {
 313         cell(0).insert(0, atom);
 314 }
 315
 316
 317 Inset * InsetColoredCell::clone() const
 318 {
 319         return new InsetColoredCell(*this);
 320 }
 321
 322
 323 void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
 324 {
 325         cell(0).metrics(mi, dim);
 326 }
 327
 328
 329 void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
 330 {
 331         pi.pain.enterMonochromeMode(min_, max_);
 332         cell(0).draw(pi, x, y);
 333         pi.pain.leaveMonochromeMode();
 334 }
 335
 336
 337 ///////////////////////////////////////////////////////////////////////
 338
 339 class InsetNameWrapper : public InsetMathWrapper {
 340 public:
 341         ///
 342         InsetNameWrapper(MathData const * value, MathMacroTemplate const & parent);
 343         ///
 344         void metrics(MetricsInfo & mi, Dimension & dim) const;
 345         ///
 346         void draw(PainterInfo &, int x, int y) const;
 347
 348 private:
 349         ///
 350         MathMacroTemplate const & parent_;
 351         ///
 352         Inset * clone() const;
 353 };
 354
 355
 356 InsetNameWrapper::InsetNameWrapper(MathData const * value,
 357                                    MathMacroTemplate const & parent)
 358         : InsetMathWrapper(value), parent_(parent)
 359 {
 360 }
 361
 362
 363 Inset * InsetNameWrapper::clone() const
 364 {
 365         return new InsetNameWrapper(*this);
 366 }
 367
 368
 369 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 370 {
 371         InsetMathWrapper::metrics(mi, dim);
 372         dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
 373 }
 374
 375
 376 void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
 377 {
 378         // create fonts
 379         PainterInfo namepi = pi;
 380         if (parent_.validMacro())
 381                 namepi.base.font.setColor(Color_latex);
 382         else
 383                 namepi.base.font.setColor(Color_error);
 384
 385         // draw backslash
 386         pi.pain.text(x, y, from_ascii("\\"), namepi.base.font);
 387         x += mathed_string_width(namepi.base.font, from_ascii("\\"));
 388
 389         // draw name
 390         InsetMathWrapper::draw(namepi, x, y);
 391 }
 392
 393
 394 ///////////////////////////////////////////////////////////////////////
 395
 396
 397 MathMacroTemplate::MathMacroTemplate(Buffer * buf)
 398         : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
 399           type_(MacroTypeNewcommand), lookOutdated_(true)
 400 {
 401         initMath();
 402 }
 403
 404
 405 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
 406         int optionals, MacroType type, vector<MathData> const & optionalValues,
 407         MathData const & def, MathData const & display)
 408         : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
 409           optionals_(optionals), optionalValues_(optionalValues),
 410           type_(type), lookOutdated_(true)
 411 {
 412         initMath();
 413
 414         if (numargs_ > 9)
 415                 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
 416                         << numargs_ << endl;
 417
 418         asArray(name, cell(0));
 419         optionalValues_.resize(9);
 420         for (int i = 0; i < optionals_; ++i)
 421                 cell(optIdx(i)) = optionalValues_[i];
 422         cell(defIdx()) = def;
 423         cell(displayIdx()) = display;
 424
 425         updateLook();
 426 }
 427
 428
 429 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & str)
 430         : InsetMathNest(buf, 3), numargs_(0), optionals_(0),
 431         type_(MacroTypeNewcommand), lookOutdated_(true)
 432 {
 433         buffer_ = buf;
 434         initMath();
 435
 436         MathData ar(buf);
 437         mathed_parse_cell(ar, str, Parse::NORMAL);
 438         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
 439                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
 440                 asArray(from_ascii("invalidmacro"), cell(0));
 441                 // FIXME: The macro template does not make sense after this.
 442                 // The whole parsing should not be in a constructor which
 443                 // has no chance to report failure.
 444                 return;
 445         }
 446         operator=( *(ar[0]->asMacroTemplate()) );
 447
 448         updateLook();
 449 }
 450
 451
 452 Inset * MathMacroTemplate::clone() const
 453 {
 454         MathMacroTemplate * inset = new MathMacroTemplate(*this);
 455         // the parent pointers of the proxy insets above will point to
 456         // to the old template. Hence, the look must be updated.
 457         inset->updateLook();
 458         return inset;
 459 }
 460
 461
 462 docstring MathMacroTemplate::name() const
 463 {
 464         return asString(cell(0));
 465 }
 466
 467
 468 void MathMacroTemplate::updateToContext(MacroContext const & mc) const
 469 {
 470         redefinition_ = mc.get(name()) != 0;
 471 }
 472
 473
 474 void MathMacroTemplate::updateLook() const
 475 {
 476         lookOutdated_ = true;
 477 }
 478
 479
 480 void MathMacroTemplate::createLook(int args) const
 481 {
 482         look_.clear();
 483         argsInLook_ = args;
 484
 485         // \foo
 486         look_.push_back(MathAtom(
 487                 new InsetLabelBox(buffer_, _("Name"), *this, false)));
 488         MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
 489         nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
 490
 491         // [#1][#2]
 492         int i = 0;
 493         if (optionals_ > 0) {
 494                 look_.push_back(MathAtom(
 495                         new InsetLabelBox(buffer_, _("optional"), *this, false)));
 496
 497                 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
 498                 for (; i < optionals_; ++i) {
 499                         // color it light grey, if it is to be removed when the cursor leaves
 500                         if (i == argsInLook_) {
 501                                 optData->push_back(MathAtom(
 502                                         new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
 503                                 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
 504                         }
 505
 506                         optData->push_back(MathAtom(new InsetMathChar('[')));
 507                         optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
 508                         optData->push_back(MathAtom(new InsetMathChar(']')));
 509                 }
 510         }
 511
 512         // {#3}{#4}
 513         for (; i < numargs_; ++i) {
 514                 MathData arg;
 515                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 516                 if (i >= argsInLook_) {
 517                         look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 518                                 Color_mathbg, Color_mathmacrooldarg,
 519                                 MathAtom(new InsetMathBrace(arg)))));
 520                 } else
 521                         look_.push_back(MathAtom(new InsetMathBrace(arg)));
 522         }
 523         for (; i < argsInLook_; ++i) {
 524                 MathData arg;
 525                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 526                 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 527                         Color_mathbg, Color_mathmacronewarg,
 528                         MathAtom(new InsetMathBrace(arg)))));
 529         }
 530
 531         // :=
 532         look_.push_back(MathAtom(new InsetMathChar(':')));
 533         look_.push_back(MathAtom(new InsetMathChar('=')));
 534
 535         // definition
 536         look_.push_back(MathAtom(
 537                 new InsetLabelBox(buffer_, MathAtom(
 538                         new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this,        true)));
 539
 540         // display
 541         look_.push_back(MathAtom(
 542                 new DisplayLabelBox(buffer_, MathAtom(
 543                         new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
 544 }
 545
 546
 547 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 548 {
 549         FontSetChanger dummy1(mi.base, from_ascii("mathnormal"));
 550         StyleChanger dummy2(mi.base, LM_ST_TEXT);
 551
 552         // valid macro?
 553         MacroData const * macro = 0;
 554         if (validName()) {
 555                 macro = mi.macrocontext.get(name());
 556
 557                 // updateToContext() - avoids another lookup
 558                 redefinition_ = macro != 0;
 559         }
 560
 561         // update look?
 562         int argsInDef = maxArgumentInDefinition();
 563         if (lookOutdated_ || argsInDef != argsInLook_) {
 564                 lookOutdated_ = false;
 565                 createLook(argsInDef);
 566         }
 567
 568         /// metrics for inset contents
 569         if (macro)
 570                 macro->lock();
 571
 572         // first phase, premetric:
 573         premetrics_ = true;
 574         look_.metrics(mi, dim);
 575         labelBoxAscent_ = dim.asc;
 576         labelBoxDescent_ = dim.des;
 577
 578         // second phase, main metric:
 579         premetrics_ = false;
 580         look_.metrics(mi, dim);
 581
 582         if (macro)
 583                 macro->unlock();
 584
 585         dim.wid += 6;
 586         dim.des += 2;
 587         dim.asc += 2;
 588
 589         setDimCache(mi, dim);
 590 }
 591
 592
 593 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 594 {
 595         FontSetChanger dummy1(pi.base, from_ascii("mathnormal"));
 596         StyleChanger dummy2(pi.base, LM_ST_TEXT);
 597
 598         setPosCache(pi, x, y);
 599         Dimension const dim = dimension(*pi.base.bv);
 600
 601         // draw outer frame
 602         int const a = y - dim.asc + 1;
 603         int const w = dim.wid - 2;
 604         int const h = dim.height() - 2;
 605         pi.pain.rectangle(x, a, w, h, Color_mathframe);
 606
 607         // just to be sure: set some dummy values for coord cache
 608         for (idx_type i = 0; i < nargs(); ++i)
 609                 cell(i).setXY(*pi.base.bv, x, y);
 610
 611         // draw contents
 612         look_.draw(pi, x + 3, y);
 613 }
 614
 615
 616 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
 617 {
 618         updateLook();
 619         cur.updateFlags(Update::SinglePar);
 620         InsetMathNest::edit(cur, front, entry_from);
 621 }
 622
 623
 624 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 625 {
 626         commitEditChanges(cur, old);
 627         updateLook();
 628         cur.updateFlags(Update::Force);
 629         return InsetMathNest::notifyCursorLeaves(old, cur);
 630 }
 631
 632
 633 void MathMacroTemplate::removeArguments(Cursor & cur,
 634         DocIterator const & /*insetPos*/, int from, int to)
 635 {
 636         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 637                 if (!it.nextInset())
 638                         continue;
 639                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 640                         continue;
 641                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 642                 int n = arg->number() - 1;
 643                 if (from <= n && n <= to) {
 644                         int cellSlice = cur.find(it.cell());
 645                         if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
 646                                 --cur[cellSlice].pos();
 647
 648                         it.cell().erase(it.pos());
 649                 }
 650         }
 651
 652         updateLook();
 653 }
 654
 655
 656 void MathMacroTemplate::shiftArguments(size_t from, int by)
 657 {
 658         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 659                 if (!it.nextInset())
 660                         continue;
 661                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 662                         continue;
 663                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 664                 if (arg->number() >= int(from) + 1)
 665                         arg->setNumber(arg->number() + by);
 666         }
 667
 668         updateLook();
 669 }
 670
 671
 672 int MathMacroTemplate::maxArgumentInDefinition() const
 673 {
 674         // We don't have a buffer when pasting from the clipboard (bug 6014).
 675         Buffer const * macro_buffer = this->isBufferValid() ? &buffer() : 0;
 676         int maxArg = 0;
 677         DocIterator it = doc_iterator_begin(macro_buffer, this);
 678         it.idx() = defIdx();
 679         for (; it; it.forwardChar()) {
 680                 if (!it.nextInset())
 681                         continue;
 682                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 683                         continue;
 684                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 685                 maxArg = std::max(int(arg->number()), maxArg);
 686         }
 687         return maxArg;
 688 }
 689
 690
 691 void MathMacroTemplate::insertMissingArguments(int maxArg)
 692 {
 693         bool found[9] = { false, false, false, false, false, false, false, false, false };
 694         idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
 695
 696         // search for #n macros arguments
 697         DocIterator it = doc_iterator_begin(&buffer(), this);
 698         it.idx() = idx;
 699         for (; it && it[0].idx() == idx; it.forwardChar()) {
 700                 if (!it.nextInset())
 701                         continue;
 702                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 703                         continue;
 704                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 705                 found[arg->number() - 1] = true;
 706         }
 707
 708         // add missing ones
 709         for (int i = 0; i < maxArg; ++i) {
 710                 if (found[i])
 711                         continue;
 712
 713                 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
 714         }
 715 }
 716
 717
 718 void MathMacroTemplate::changeArity(Cursor & cur,
 719         DocIterator const & insetPos, int newNumArg)
 720 {
 721         // remove parameter which do not appear anymore in the definition
 722         for (int i = numargs_; i > newNumArg; --i)
 723                 removeParameter(cur, insetPos, numargs_ - 1, false);
 724
 725         // add missing parameter
 726         for (int i = numargs_; i < newNumArg; ++i)
 727                 insertParameter(cur, insetPos, numargs_, false, false);
 728 }
 729
 730
 731 ///
 732 class AddRemoveMacroInstanceFix
 733 {
 734 public:
 735         ///
 736         AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
 737         ///
 738         void operator()(MathMacro * macro) {
 739                 if (macro->folded()) {
 740                         if (insert_)
 741                                 macro->insertArgument(n_);
 742                         else
 743                                 macro->removeArgument(n_);
 744                 }
 745         }
 746
 747 private:
 748         ///
 749         int n_;
 750         ///
 751         bool insert_;
 752 };
 753
 754
 755 ///
 756 class OptionalsMacroInstanceFix
 757 {
 758 public:
 759         ///
 760         OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
 761         ///
 762         void operator()(MathMacro * macro) {
 763                 macro->setOptionals(optionals_);
 764         }
 765
 766 private:
 767         ///
 768         int optionals_;
 769 };
 770
 771
 772 ///
 773 class NullMacroInstanceFix
 774 {
 775 public:
 776         ///
 777         void operator()(MathMacro * macro) {}
 778 };
 779
 780
 781 template<class F>
 782 void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
 783         docstring const & name, F & fix)
 784 {
 785         // goto position behind macro template
 786         DocIterator dit = inset_pos;
 787         dit.pop_back();
 788         dit.top().forwardPos();
 789
 790         // remember hull to trigger preview reload
 791         DocIterator hull(dit.buffer());
 792         bool preview_reload_needed = false;
 793
 794         // iterate over all positions until macro is redefined
 795         for (; dit; dit.forwardPos()) {
 796                 // left the outer hull?
 797                 if (!hull.empty() && dit.depth() == hull.depth()) {
 798                         // reload the preview if necessary
 799                         if (preview_reload_needed) {
 800                                 InsetMathHull * inset_hull =
 801                                         hull.nextInset()->asInsetMath()->asHullInset();
 802                                 LASSERT(inset_hull, /**/);
 803                                 inset_hull->reloadPreview(hull);
 804                                 cur.updateFlags(Update::Force);
 805                                 preview_reload_needed = false;
 806                         }
 807                         hull.clear();
 808                 }
 809
 810                 // only until a macro is redefined
 811                 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
 812                         MathMacroTemplate const & macroTemplate
 813                         = static_cast<MathMacroTemplate const &>(dit.inset());
 814                         if (macroTemplate.name() == name)
 815                                 break;
 816                 }
 817
 818                 // in front of macro instance?
 819                 Inset * inset = dit.nextInset();
 820                 if (!inset)
 821                         continue;
 822                 InsetMath * insetMath = inset->asInsetMath();
 823                 if (!insetMath)
 824                         continue;
 825
 826                 // in front of outer hull?
 827                 InsetMathHull * inset_hull = insetMath->asHullInset();
 828                 if (inset_hull && hull.empty()) {
 829                         // remember this for later preview reload
 830                         hull = dit;
 831                 }
 832
 833                 MathMacro * macro = insetMath->asMacro();
 834                 if (macro && macro->name() == name && macro->folded()) {
 835                         fix(macro);
 836                         if (RenderPreview::status() == LyXRC::PREVIEW_ON)
 837                                 preview_reload_needed = true;
 838                 }
 839         }
 840 }
 841
 842
 843 void MathMacroTemplate::commitEditChanges(Cursor & cur,
 844         DocIterator const & inset_pos)
 845 {
 846         int args_in_def = maxArgumentInDefinition();
 847         if (args_in_def != numargs_) {
 848                 cur.recordUndoFullDocument();
 849                 changeArity(cur, inset_pos, args_in_def);
 850         }
 851         insertMissingArguments(args_in_def);
 852
 853         // make sure the preview are up to date
 854         NullMacroInstanceFix fix;
 855         fixMacroInstances(cur, inset_pos, name(), fix);
 856 }
 857
 858
 859 void MathMacroTemplate::insertParameter(Cursor & cur,
 860         DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
 861 {
 862         if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
 863                 ++numargs_;
 864
 865                 // append example #n
 866                 if (addarg) {
 867                         shiftArguments(pos, 1);
 868
 869                         cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 870                         if (!cell(displayIdx()).empty())
 871                                 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 872                 }
 873
 874                 if (!greedy) {
 875                         // fix macro instances
 876                         AddRemoveMacroInstanceFix fix(pos, true);
 877                         fixMacroInstances(cur, inset_pos, name(), fix);
 878                 }
 879         }
 880
 881         updateLook();
 882 }
 883
 884
 885 void MathMacroTemplate::removeParameter(Cursor & cur,
 886         DocIterator const & inset_pos, int pos, bool greedy)
 887 {
 888         if (pos < numargs_ && pos >= 0) {
 889                 --numargs_;
 890                 removeArguments(cur, inset_pos, pos, pos);
 891                 shiftArguments(pos + 1, -1);
 892
 893                 // removed optional parameter?
 894                 if (pos < optionals_) {
 895                         --optionals_;
 896                         optionalValues_[pos] = cell(optIdx(pos));
 897                         cells_.erase(cells_.begin() + optIdx(pos));
 898
 899                         // fix cursor
 900                         int macroSlice = cur.find(this);
 901                         if (macroSlice != -1) {
 902                                 if (cur[macroSlice].idx() == optIdx(pos)) {
 903                                         cur.cutOff(macroSlice);
 904                                         cur[macroSlice].idx() = 1;
 905                                         cur[macroSlice].pos() = 0;
 906                                 } else if (cur[macroSlice].idx() > optIdx(pos))
 907                                         --cur[macroSlice].idx();
 908                         }
 909                 }
 910
 911                 if (!greedy) {
 912                         // fix macro instances
 913                         AddRemoveMacroInstanceFix fix(pos, false);
 914                         fixMacroInstances(cur, inset_pos, name(), fix);
 915                 }
 916         }
 917
 918         updateLook();
 919 }
 920
 921
 922 void MathMacroTemplate::makeOptional(Cursor & cur,
 923         DocIterator const & inset_pos)
 924 {
 925         if (numargs_ > 0 && optionals_ < numargs_) {
 926                 ++optionals_;
 927                 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
 928                 // fix cursor
 929                 int macroSlice = cur.find(this);
 930                 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
 931                         ++cur[macroSlice].idx();
 932
 933                 // fix macro instances
 934                 OptionalsMacroInstanceFix fix(optionals_);
 935                 fixMacroInstances(cur, inset_pos, name(), fix);
 936         }
 937
 938         updateLook();
 939 }
 940
 941
 942 void MathMacroTemplate::makeNonOptional(Cursor & cur,
 943         DocIterator const & inset_pos)
 944 {
 945         if (numargs_ > 0 && optionals_ > 0) {
 946                 --optionals_;
 947
 948                 // store default value for later if the user changes his mind
 949                 optionalValues_[optionals_] = cell(optIdx(optionals_));
 950                 cells_.erase(cells_.begin() + optIdx(optionals_));
 951
 952                 // fix cursor
 953                 int macroSlice = cur.find(this);
 954                 if (macroSlice != -1) {
 955                         if (cur[macroSlice].idx() > optIdx(optionals_))
 956                                 --cur[macroSlice].idx();
 957                         else if (cur[macroSlice].idx() == optIdx(optionals_)) {
 958                                 cur.cutOff(macroSlice);
 959                                 cur[macroSlice].idx() = optIdx(optionals_);
 960                                 cur[macroSlice].pos() = 0;
 961                         }
 962                 }
 963
 964                 // fix macro instances
 965                 OptionalsMacroInstanceFix fix(optionals_);
 966                 fixMacroInstances(cur, inset_pos, name(), fix);
 967         }
 968
 969         updateLook();
 970 }
 971
 972
 973 void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
 974 {
 975         string const arg = to_utf8(cmd.argument());
 976         switch (cmd.action) {
 977
 978         case LFUN_MATH_MACRO_ADD_PARAM:
 979                 if (numargs_ < 9) {
 980                         commitEditChanges(cur, cur);
 981                         cur.recordUndoFullDocument();
 982                         size_t pos = numargs_;
 983                         if (arg.size() != 0)
 984                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
 985                         insertParameter(cur, cur, pos);
 986                 }
 987                 break;
 988
 989
 990         case LFUN_MATH_MACRO_REMOVE_PARAM:
 991                 if (numargs_ > 0) {
 992                         commitEditChanges(cur, cur);
 993                         cur.recordUndoFullDocument();
 994                         size_t pos = numargs_ - 1;
 995                         if (arg.size() != 0)
 996                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
 997                         removeParameter(cur, cur, pos);
 998                 }
 999                 break;
1000
1001         case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1002                 if (numargs_ < 9) {
1003                         commitEditChanges(cur, cur);
1004                         cur.recordUndoFullDocument();
1005                         insertParameter(cur, cur, numargs_, true);
1006                 }
1007                 break;
1008
1009         case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1010                 if (numargs_ > 0) {
1011                         commitEditChanges(cur, cur);
1012                         cur.recordUndoFullDocument();
1013                         removeParameter(cur, cur, numargs_ - 1, true);
1014                 }
1015                 break;
1016
1017         case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1018                 commitEditChanges(cur, cur);
1019                 cur.recordUndoFullDocument();
1020                 makeOptional(cur, cur);
1021                 break;
1022
1023         case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1024                 commitEditChanges(cur, cur);
1025                 cur.recordUndoFullDocument();
1026                 makeNonOptional(cur, cur);
1027                 break;
1028
1029         case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1030                 if (numargs_ < 9) {
1031                         commitEditChanges(cur, cur);
1032                         cur.recordUndoFullDocument();
1033                         insertParameter(cur, cur, optionals_);
1034                         makeOptional(cur, cur);
1035                 }
1036                 break;
1037
1038         case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1039                 if (optionals_ > 0) {
1040                         commitEditChanges(cur, cur);
1041                         cur.recordUndoFullDocument();
1042                         removeParameter(cur, cur, optionals_ - 1);
1043                 } break;
1044
1045         case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1046                 if (numargs_ == optionals_) {
1047                         commitEditChanges(cur, cur);
1048                         cur.recordUndoFullDocument();
1049                         insertParameter(cur, cur, 0, true);
1050                         makeOptional(cur, cur);
1051                 }
1052                 break;
1053
1054         default:
1055                 InsetMathNest::doDispatch(cur, cmd);
1056                 break;
1057         }
1058 }
1059
1060
1061 bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
1062         FuncStatus & flag) const
1063 {
1064         bool ret = true;
1065         string const arg = to_utf8(cmd.argument());
1066         switch (cmd.action) {
1067                 case LFUN_MATH_MACRO_ADD_PARAM: {
1068                         int num = numargs_ + 1;
1069                         if (arg.size() != 0)
1070                                 num = convert<int>(arg);
1071                         bool on = (num >= optionals_
1072                                    && numargs_ < 9 && num <= numargs_ + 1);
1073                         flag.setEnabled(on);
1074                         break;
1075                 }
1076
1077                 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1078                         flag.setEnabled(numargs_ < 9);
1079                         break;
1080
1081                 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1082                         int num = numargs_;
1083                         if (arg.size() != 0)
1084                                 num = convert<int>(arg);
1085                         flag.setEnabled(num >= 1 && num <= numargs_);
1086                         break;
1087                 }
1088
1089                 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1090                         flag.setEnabled(numargs_ > 0
1091                                      && optionals_ < numargs_
1092                                      && type_ != MacroTypeDef);
1093                         break;
1094
1095                 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1096                         flag.setEnabled(optionals_ > 0
1097                                      && type_ != MacroTypeDef);
1098                         break;
1099
1100                 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1101                         flag.setEnabled(numargs_ < 9);
1102                         break;
1103
1104                 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1105                         flag.setEnabled(optionals_ > 0);
1106                         break;
1107
1108                 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1109                         flag.setEnabled(numargs_ == 0
1110                                      && type_ != MacroTypeDef);
1111                         break;
1112
1113                 case LFUN_IN_MATHMACROTEMPLATE:
1114                         flag.setEnabled(true);
1115                         break;
1116
1117                 default:
1118                         ret = false;
1119                         break;
1120         }
1121         return ret;
1122 }
1123
1124
1125 void MathMacroTemplate::read(Lexer & lex)
1126 {
1127         MathData ar(buffer_);
1128         mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1129         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1130                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1131                 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1132                 return;
1133         }
1134         operator=( *(ar[0]->asMacroTemplate()) );
1135
1136         updateLook();
1137 }
1138
1139
1140 void MathMacroTemplate::write(ostream & os) const
1141 {
1142         odocstringstream oss;
1143         WriteStream wi(oss, false, false, WriteStream::wsDefault);
1144         oss << "FormulaMacro\n";
1145         write(wi);
1146         os << to_utf8(oss.str());
1147 }
1148
1149
1150 void MathMacroTemplate::write(WriteStream & os) const
1151 {
1152         write(os, false);
1153 }
1154
1155
1156 void MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
1157 {
1158         if (os.latex()) {
1159                 if (optionals_ > 0) {
1160                         // macros with optionals use the xargs package, e.g.:
1161                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1162                         // \long is implicit by xargs
1163                         if (redefinition_ && !overwriteRedefinition)
1164                                 os << "\\renewcommandx";
1165                         else
1166                                 os << "\\newcommandx";
1167
1168                         os << "\\" << name()
1169                            << "[" << numargs_ << "]"
1170                            << "[usedefault, addprefix=\\global";
1171                         for (int i = 0; i < optionals_; ++i) {
1172                                 docstring optValue = asString(cell(optIdx(i)));
1173                                 if (optValue.find(']') != docstring::npos
1174                                     || optValue.find(',') != docstring::npos)
1175                                         os << ", " << i + 1 << "="
1176                                         << "{" << cell(optIdx(i)) << "}";
1177                                 else
1178                                         os << ", " << i + 1 << "="
1179                                         << cell(optIdx(i));
1180                         }
1181                         os << "]";
1182                 } else {
1183                         // Macros without optionals use standard _global_ \def macros:
1184                         //   \global\def\long\foo#1#2{#1,#2}
1185                         // We use the \long prefix as this is the equivalent to \newcommand.
1186                         // We cannot use \newcommand directly because \global does not work with it.
1187                         os << "\\global\\long\\def\\" << name();
1188                         docstring param = from_ascii("#0");
1189                         for (int i = 1; i <= numargs_; ++i) {
1190                                 param[1] = '0' + i;
1191                                 os << param;
1192                         }
1193                 }
1194         } else {
1195                 // in LyX output we use some pseudo syntax which is implementation
1196                 // independent, e.g.
1197                 // \newcommand{\foo}[2][default]{#1,#2}
1198                 if (redefinition_ && !overwriteRedefinition)
1199                         os << "\\renewcommand";
1200                 else
1201                         os << "\\newcommand";
1202                 os << "{\\" << name() << '}';
1203                 if (numargs_ > 0)
1204                         os << '[' << numargs_ << ']';
1205
1206                 for (int i = 0; i < optionals_; ++i) {
1207                         docstring optValue = asString(cell(optIdx(i)));
1208                         if (optValue.find(']') != docstring::npos)
1209                                 os << "[{" << cell(optIdx(i)) << "}]";
1210                         else
1211                                 os << "[" << cell(optIdx(i)) << "]";
1212                 }
1213         }
1214
1215         os << "{" << cell(defIdx()) << "}";
1216
1217         if (os.latex()) {
1218                 // writing .tex. done.
1219                 os << "\n";
1220         } else {
1221                 // writing .lyx, write special .tex export only if necessary
1222                 if (!cell(displayIdx()).empty())
1223                         os << "\n{" << cell(displayIdx()) << '}';
1224         }
1225 }
1226
1227
1228 int MathMacroTemplate::plaintext(odocstream & os,
1229                                  OutputParams const &) const
1230 {
1231         static docstring const str = '[' + buffer().B_("math macro") + ']';
1232
1233         os << str;
1234         return str.size();
1235 }
1236
1237
1238 bool MathMacroTemplate::validName() const
1239 {
1240         docstring n = name();
1241
1242         // empty name?
1243         if (n.size() == 0)
1244                 return false;
1245
1246         // converting back and force doesn't swallow anything?
1247         /*MathData ma;
1248         asArray(n, ma);
1249         if (asString(ma) != n)
1250                 return false;*/
1251
1252         // valid characters?
1253         for (size_t i = 0; i < n.size(); ++i) {
1254                 if (!(n[i] >= 'a' && n[i] <= 'z')
1255                     && !(n[i] >= 'A' && n[i] <= 'Z')
1256                     && n[i] != '*')
1257                         return false;
1258         }
1259
1260         return true;
1261 }
1262
1263
1264 bool MathMacroTemplate::validMacro() const
1265 {
1266         return validName();
1267 }
1268
1269
1270 bool MathMacroTemplate::fixNameAndCheckIfValid()
1271 {
1272         // check all the characters/insets in the name cell
1273         size_t i = 0;
1274         MathData & data = cell(0);
1275         while (i < data.size()) {
1276                 InsetMathChar const * cinset = data[i]->asCharInset();
1277                 if (cinset) {
1278                         // valid character in [a-zA-Z]?
1279                         char_type c = cinset->getChar();
1280                         if ((c >= 'a' && c <= 'z')
1281                             || (c >= 'A' && c <= 'Z')) {
1282                                 ++i;
1283                                 continue;
1284                         }
1285                 }
1286
1287                 // throw cell away
1288                 data.erase(i);
1289         }
1290
1291         // now it should be valid if anything in the name survived
1292         return data.size() > 0;
1293 }
1294
1295
1296 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1297 {
1298         // we need global optional macro arguments. They are not available
1299         // with \def, and \newcommand does not support global macros. So we
1300         // are bound to xargs also for the single-optional-parameter case.
1301         if (optionals_ > 0)
1302                 features.require("xargs");
1303 }
1304
1305 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1306 {
1307         defaults.resize(numargs_);
1308         for (int i = 0; i < optionals_; ++i)
1309                 defaults[i] = asString(cell(optIdx(i)));
1310 }
1311
1312
1313 docstring MathMacroTemplate::definition() const
1314 {
1315         return asString(cell(defIdx()));
1316 }
1317
1318
1319 docstring MathMacroTemplate::displayDefinition() const
1320 {
1321         return asString(cell(displayIdx()));
1322 }
1323
1324
1325 size_t MathMacroTemplate::numArgs() const
1326 {
1327         return numargs_;
1328 }
1329
1330
1331 size_t MathMacroTemplate::numOptionals() const
1332 {
1333         return optionals_;
1334 }
1335
1336
1337 void MathMacroTemplate::infoize(odocstream & os) const
1338 {
1339         os << "Math Macro: \\" << name();
1340 }
1341
1342
1343 docstring MathMacroTemplate::contextMenu(BufferView const &, int, int) const
1344 {
1345         return from_ascii("context-math-macro-definition");
1346 }
1347
1348 } // namespace lyx