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 "TocBackend.h"
  38
  39 #include "frontends/Painter.h"
  40
  41 #include "insets/RenderPreview.h"
  42
  43 #include "support/lassert.h"
  44 #include "support/convert.h"
  45 #include "support/debug.h"
  46 #include "support/gettext.h"
  47 #include "support/docstream.h"
  48 #include "support/lstrings.h"
  49
  50 #include <set>
  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), redefinition_(false), lookOutdated_(true),
 400           premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 401 {
 402         initMath();
 403 }
 404
 405
 406 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
 407         int optionals, MacroType type, vector<MathData> const & optionalValues,
 408         MathData const & def, MathData const & display)
 409         : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
 410           optionals_(optionals), optionalValues_(optionalValues),
 411           type_(type), redefinition_(false), lookOutdated_(true),
 412           premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 413 {
 414         initMath();
 415
 416         if (numargs_ > 9)
 417                 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
 418                         << numargs_ << endl;
 419
 420         asArray(name, cell(0));
 421         optionalValues_.resize(9);
 422         for (int i = 0; i < optionals_; ++i)
 423                 cell(optIdx(i)) = optionalValues_[i];
 424         cell(defIdx()) = def;
 425         cell(displayIdx()) = display;
 426
 427         updateLook();
 428 }
 429
 430
 431 bool MathMacroTemplate::fromString(docstring const & str)
 432 {
 433         MathData ar(buffer_);
 434         mathed_parse_cell(ar, str, Parse::NORMAL);
 435         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
 436                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
 437                 asArray(from_ascii("invalidmacro"), cell(0));
 438                 // The macro template does not make sense after this.
 439                 return false;
 440         }
 441         operator=( *(ar[0]->asMacroTemplate()) );
 442
 443         updateLook();
 444         return true;
 445 }
 446
 447
 448 Inset * MathMacroTemplate::clone() const
 449 {
 450         MathMacroTemplate * inset = new MathMacroTemplate(*this);
 451         // the parent pointers of the proxy insets above will point to
 452         // to the old template. Hence, the look must be updated.
 453         inset->updateLook();
 454         return inset;
 455 }
 456
 457
 458 docstring MathMacroTemplate::name() const
 459 {
 460         return asString(cell(0));
 461 }
 462
 463
 464 void MathMacroTemplate::updateToContext(MacroContext const & mc)
 465 {
 466         redefinition_ = mc.get(name()) != 0;
 467 }
 468
 469
 470 void MathMacroTemplate::updateLook() const
 471 {
 472         lookOutdated_ = true;
 473 }
 474
 475
 476 void MathMacroTemplate::createLook(int args) const
 477 {
 478         look_.clear();
 479         argsInLook_ = args;
 480
 481         // \foo
 482         look_.push_back(MathAtom(
 483                 new InsetLabelBox(buffer_, _("Name"), *this, false)));
 484         MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
 485         nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
 486
 487         // [#1][#2]
 488         int i = 0;
 489         if (optionals_ > 0) {
 490                 look_.push_back(MathAtom(
 491                         new InsetLabelBox(buffer_, _("optional"), *this, false)));
 492
 493                 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
 494                 for (; i < optionals_; ++i) {
 495                         // color it light grey, if it is to be removed when the cursor leaves
 496                         if (i == argsInLook_) {
 497                                 optData->push_back(MathAtom(
 498                                         new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
 499                                 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
 500                         }
 501
 502                         optData->push_back(MathAtom(new InsetMathChar('[')));
 503                         optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
 504                         optData->push_back(MathAtom(new InsetMathChar(']')));
 505                 }
 506         }
 507
 508         // {#3}{#4}
 509         for (; i < numargs_; ++i) {
 510                 MathData arg;
 511                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 512                 if (i >= argsInLook_) {
 513                         look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 514                                 Color_mathbg, Color_mathmacrooldarg,
 515                                 MathAtom(new InsetMathBrace(arg)))));
 516                 } else
 517                         look_.push_back(MathAtom(new InsetMathBrace(arg)));
 518         }
 519         for (; i < argsInLook_; ++i) {
 520                 MathData arg;
 521                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 522                 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 523                         Color_mathbg, Color_mathmacronewarg,
 524                         MathAtom(new InsetMathBrace(arg)))));
 525         }
 526
 527         // :=
 528         look_.push_back(MathAtom(new InsetMathChar(':')));
 529         look_.push_back(MathAtom(new InsetMathChar('=')));
 530
 531         // definition
 532         look_.push_back(MathAtom(
 533                 new InsetLabelBox(buffer_, MathAtom(
 534                         new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this,        true)));
 535
 536         // display
 537         look_.push_back(MathAtom(
 538                 new DisplayLabelBox(buffer_, MathAtom(
 539                         new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
 540 }
 541
 542
 543 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 544 {
 545         Changer dummy1 = mi.base.changeFontSet(from_ascii("mathnormal"));
 546         Changer dummy2 = mi.base.changeStyle(LM_ST_TEXT);
 547
 548         // valid macro?
 549         MacroData const * macro = 0;
 550         if (validName())
 551                 macro = mi.macrocontext.get(name());
 552
 553         // update look?
 554         int argsInDef = maxArgumentInDefinition();
 555         if (lookOutdated_ || argsInDef != argsInLook_) {
 556                 lookOutdated_ = false;
 557                 createLook(argsInDef);
 558         }
 559
 560         /// metrics for inset contents
 561         if (macro)
 562                 macro->lock();
 563
 564         // first phase, premetric:
 565         premetrics_ = true;
 566         look_.metrics(mi, dim);
 567         labelBoxAscent_ = dim.asc;
 568         labelBoxDescent_ = dim.des;
 569
 570         // second phase, main metric:
 571         premetrics_ = false;
 572         look_.metrics(mi, dim);
 573
 574         if (macro)
 575                 macro->unlock();
 576
 577         dim.wid += 6;
 578         dim.des += 2;
 579         dim.asc += 2;
 580
 581         setDimCache(mi, dim);
 582 }
 583
 584
 585 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 586 {
 587         // FIXME: Calling Changer on the same object repeatedly is inefficient.
 588         Changer dummy0 = pi.base.font.changeColor(Color_math);
 589         Changer dummy1 = pi.base.changeFontSet(from_ascii("mathnormal"));
 590         Changer dummy2 = pi.base.changeStyle(LM_ST_TEXT);
 591
 592         setPosCache(pi, x, y);
 593         Dimension const dim = dimension(*pi.base.bv);
 594
 595         // draw outer frame
 596         int const a = y - dim.asc + 1;
 597         int const w = dim.wid - 2;
 598         int const h = dim.height() - 2;
 599         pi.pain.rectangle(x, a, w, h, Color_mathframe);
 600
 601         // just to be sure: set some dummy values for coord cache
 602         for (idx_type i = 0; i < nargs(); ++i)
 603                 cell(i).setXY(*pi.base.bv, x, y);
 604
 605         // draw contents
 606         look_.draw(pi, x + 3, y);
 607 }
 608
 609
 610 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
 611 {
 612         updateLook();
 613         cur.screenUpdateFlags(Update::SinglePar);
 614         InsetMathNest::edit(cur, front, entry_from);
 615 }
 616
 617
 618 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 619 {
 620         unsigned int const nargs_before = nargs();
 621         commitEditChanges(cur, old);
 622         updateLook();
 623         cur.screenUpdateFlags(Update::Force);
 624         // If we have removed a cell, we might have invalidated the cursor
 625         return InsetMathNest::notifyCursorLeaves(old, cur)
 626                 || nargs() < nargs_before;
 627 }
 628
 629
 630 void MathMacroTemplate::removeArguments(Cursor & cur,
 631         DocIterator const & /*inset_pos*/, int from, int to)
 632 {
 633         DocIterator it = doc_iterator_begin(&buffer(), this);
 634         for (; it; it.forwardChar()) {
 635                 if (!it.nextInset())
 636                         continue;
 637                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 638                         continue;
 639                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 640                 int n = arg->number() - 1;
 641                 if (from <= n && n <= to) {
 642                         int cellSlice = cur.find(it.cell());
 643                         if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
 644                                 --cur[cellSlice].pos();
 645
 646                         it.cell().erase(it.pos());
 647                 }
 648         }
 649
 650         updateLook();
 651 }
 652
 653
 654 void MathMacroTemplate::shiftArguments(size_t from, int by)
 655 {
 656         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 657                 if (!it.nextInset())
 658                         continue;
 659                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 660                         continue;
 661                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 662                 if (arg->number() >= int(from) + 1)
 663                         arg->setNumber(arg->number() + by);
 664         }
 665
 666         updateLook();
 667 }
 668
 669
 670 int MathMacroTemplate::maxArgumentInDefinition() const
 671 {
 672         // We don't have a buffer when pasting from the clipboard (bug 6014).
 673         Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
 674         int maxArg = 0;
 675         DocIterator it = doc_iterator_begin(macro_buffer, this);
 676         it.idx() = defIdx();
 677         for (; it; it.forwardChar()) {
 678                 if (!it.nextInset())
 679                         continue;
 680                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 681                         continue;
 682                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 683                 maxArg = std::max(int(arg->number()), maxArg);
 684         }
 685         return maxArg;
 686 }
 687
 688
 689 void MathMacroTemplate::insertMissingArguments(int maxArg)
 690 {
 691         bool found[9] = { false, false, false, false, false, false, false, false, false };
 692         idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
 693
 694         // search for #n macros arguments
 695         DocIterator it = doc_iterator_begin(&buffer(), this);
 696         it.idx() = idx;
 697         for (; it && it[0].idx() == idx; it.forwardChar()) {
 698                 if (!it.nextInset())
 699                         continue;
 700                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 701                         continue;
 702                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 703                 found[arg->number() - 1] = true;
 704         }
 705
 706         // add missing ones
 707         for (int i = 0; i < maxArg; ++i) {
 708                 if (found[i])
 709                         continue;
 710
 711                 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
 712         }
 713 }
 714
 715
 716 void MathMacroTemplate::changeArity(Cursor & cur,
 717         DocIterator const & inset_pos, int newNumArg)
 718 {
 719         // remove parameter which do not appear anymore in the definition
 720         for (int i = numargs_; i > newNumArg; --i)
 721                 removeParameter(cur, inset_pos, numargs_ - 1, true);
 722
 723         // add missing parameter
 724         for (int i = numargs_; i < newNumArg; ++i)
 725                 insertParameter(cur, inset_pos, numargs_, true, false);
 726 }
 727
 728
 729 ///
 730 class AddRemoveMacroInstanceFix
 731 {
 732 public:
 733         ///
 734         AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
 735         ///
 736         void operator()(MathMacro * macro)
 737         {
 738                 if (macro->folded()) {
 739                         if (insert_)
 740                                 macro->insertArgument(n_);
 741                         else
 742                                 macro->removeArgument(n_);
 743                 }
 744         }
 745
 746 private:
 747         ///
 748         int n_;
 749         ///
 750         bool insert_;
 751 };
 752
 753
 754 ///
 755 class OptionalsMacroInstanceFix
 756 {
 757 public:
 758         ///
 759         OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
 760         ///
 761         void operator()(MathMacro * macro)
 762         {
 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 * ) {}
 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         set<DocIterator> preview_hulls;
 794
 795         // iterate over all positions until macro is redefined
 796         for (; dit; dit.forwardPos()) {
 797                 // left the outer hull?
 798                 if (!hull.empty() && dit.depth() == hull.depth()) {
 799                         // schedule reload of the preview if necessary
 800                         if (preview_reload_needed) {
 801                                 preview_hulls.insert(hull);
 802                                 preview_reload_needed = false;
 803                         }
 804                         hull.clear();
 805                 }
 806
 807                 // only until a macro is redefined
 808                 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
 809                         MathMacroTemplate const & macroTemplate
 810                         = static_cast<MathMacroTemplate const &>(dit.inset());
 811                         if (macroTemplate.name() == name)
 812                                 break;
 813                 }
 814
 815                 // in front of macro instance?
 816                 Inset * inset = dit.nextInset();
 817                 if (!inset)
 818                         continue;
 819                 InsetMath * insetMath = inset->asInsetMath();
 820                 if (!insetMath)
 821                         continue;
 822
 823                 // in front of outer hull?
 824                 InsetMathHull * inset_hull = insetMath->asHullInset();
 825                 if (inset_hull && hull.empty()) {
 826                         // remember this for later preview reload
 827                         hull = dit;
 828                 }
 829
 830                 MathMacro * macro = insetMath->asMacro();
 831                 if (macro && macro->name() == name && macro->folded()) {
 832                         fix(macro);
 833                         if (RenderPreview::previewMath())
 834                                 preview_reload_needed = true;
 835                 }
 836         }
 837
 838         if (!preview_hulls.empty()) {
 839                 // reload the scheduled previews
 840                 set<DocIterator>::const_iterator sit = preview_hulls.begin();
 841                 set<DocIterator>::const_iterator end = preview_hulls.end();
 842                 for (; sit != end; ++sit) {
 843                         InsetMathHull * inset_hull =
 844                                 sit->nextInset()->asInsetMath()->asHullInset();
 845                         LBUFERR(inset_hull);
 846                         inset_hull->reloadPreview(*sit);
 847                 }
 848                 cur.screenUpdateFlags(Update::Force);
 849         }
 850 }
 851
 852
 853 void MathMacroTemplate::commitEditChanges(Cursor & cur,
 854         DocIterator const & inset_pos)
 855 {
 856         int args_in_def = maxArgumentInDefinition();
 857         if (args_in_def != numargs_) {
 858                 // FIXME: implement precise undo handling (only a few places
 859                 //   need undo)
 860                 cur.recordUndoFullBuffer();
 861                 changeArity(cur, inset_pos, args_in_def);
 862         }
 863         insertMissingArguments(args_in_def);
 864
 865         // make sure the preview are up to date
 866         NullMacroInstanceFix fix;
 867         fixMacroInstances(cur, inset_pos, name(), fix);
 868 }
 869
 870
 871 void MathMacroTemplate::insertParameter(Cursor & cur,
 872         DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
 873 {
 874         if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
 875                 ++numargs_;
 876
 877                 // append example #n
 878                 if (addarg) {
 879                         shiftArguments(pos, 1);
 880
 881                         cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 882                         if (!cell(displayIdx()).empty())
 883                                 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 884                 }
 885
 886                 if (!greedy) {
 887                         // fix macro instances
 888                         AddRemoveMacroInstanceFix fix(pos, true);
 889                         fixMacroInstances(cur, inset_pos, name(), fix);
 890                 }
 891         }
 892
 893         updateLook();
 894 }
 895
 896
 897 void MathMacroTemplate::removeParameter(Cursor & cur,
 898         DocIterator const & inset_pos, int pos, bool greedy)
 899 {
 900         if (pos < numargs_ && pos >= 0) {
 901                 --numargs_;
 902                 removeArguments(cur, inset_pos, pos, pos);
 903                 shiftArguments(pos + 1, -1);
 904
 905                 // removed optional parameter?
 906                 if (pos < optionals_) {
 907                         --optionals_;
 908                         optionalValues_[pos] = cell(optIdx(pos));
 909                         cells_.erase(cells_.begin() + optIdx(pos));
 910
 911                         // fix cursor
 912                         int macroSlice = cur.find(this);
 913                         if (macroSlice != -1) {
 914                                 if (cur[macroSlice].idx() == optIdx(pos)) {
 915                                         cur.cutOff(macroSlice);
 916                                         cur[macroSlice].idx() = 1;
 917                                         cur[macroSlice].pos() = 0;
 918                                 } else if (cur[macroSlice].idx() > optIdx(pos))
 919                                         --cur[macroSlice].idx();
 920                         }
 921                 }
 922
 923                 if (!greedy) {
 924                         // fix macro instances
 925                         AddRemoveMacroInstanceFix fix(pos, false);
 926                         fixMacroInstances(cur, inset_pos, name(), fix);
 927                 }
 928         }
 929
 930         updateLook();
 931 }
 932
 933
 934 void MathMacroTemplate::makeOptional(Cursor & cur,
 935         DocIterator const & inset_pos)
 936 {
 937         if (numargs_ > 0 && optionals_ < numargs_) {
 938                 ++optionals_;
 939                 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
 940                 // fix cursor
 941                 int macroSlice = cur.find(this);
 942                 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
 943                         ++cur[macroSlice].idx();
 944
 945                 // fix macro instances
 946                 OptionalsMacroInstanceFix fix(optionals_);
 947                 fixMacroInstances(cur, inset_pos, name(), fix);
 948         }
 949
 950         updateLook();
 951 }
 952
 953
 954 void MathMacroTemplate::makeNonOptional(Cursor & cur,
 955         DocIterator const & inset_pos)
 956 {
 957         if (numargs_ > 0 && optionals_ > 0) {
 958                 --optionals_;
 959
 960                 // store default value for later if the user changes his mind
 961                 optionalValues_[optionals_] = cell(optIdx(optionals_));
 962                 cells_.erase(cells_.begin() + optIdx(optionals_));
 963
 964                 // fix cursor
 965                 int macroSlice = cur.find(this);
 966                 if (macroSlice != -1) {
 967                         if (cur[macroSlice].idx() > optIdx(optionals_))
 968                                 --cur[macroSlice].idx();
 969                         else if (cur[macroSlice].idx() == optIdx(optionals_)) {
 970                                 cur.cutOff(macroSlice);
 971                                 cur[macroSlice].idx() = optIdx(optionals_);
 972                                 cur[macroSlice].pos() = 0;
 973                         }
 974                 }
 975
 976                 // fix macro instances
 977                 OptionalsMacroInstanceFix fix(optionals_);
 978                 fixMacroInstances(cur, inset_pos, name(), fix);
 979         }
 980
 981         updateLook();
 982 }
 983
 984
 985 void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
 986 {
 987         string const arg = to_utf8(cmd.argument());
 988         switch (cmd.action()) {
 989
 990         case LFUN_MATH_MACRO_ADD_PARAM:
 991                 if (numargs_ < 9) {
 992                         commitEditChanges(cur, cur);
 993                         // FIXME: implement precise undo handling (only a few places
 994                         //   need undo)
 995                         cur.recordUndoFullBuffer();
 996                         size_t pos = numargs_;
 997                         if (!arg.empty())
 998                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
 999                         insertParameter(cur, cur, pos);
1000                 }
1001                 break;
1002
1003
1004         case LFUN_MATH_MACRO_REMOVE_PARAM:
1005                 if (numargs_ > 0) {
1006                         commitEditChanges(cur, cur);
1007                         // FIXME: implement precise undo handling (only a few places
1008                         //   need undo)
1009                         cur.recordUndoFullBuffer();
1010                         size_t pos = numargs_ - 1;
1011                         if (!arg.empty())
1012                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1013                         removeParameter(cur, cur, pos);
1014                 }
1015                 break;
1016
1017         case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1018                 if (numargs_ < 9) {
1019                         commitEditChanges(cur, cur);
1020                         // FIXME: implement precise undo handling (only a few places
1021                         //   need undo)
1022                         cur.recordUndoFullBuffer();
1023                         insertParameter(cur, cur, numargs_, true);
1024                 }
1025                 break;
1026
1027         case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1028                 if (numargs_ > 0) {
1029                         commitEditChanges(cur, cur);
1030                         // FIXME: implement precise undo handling (only a few places
1031                         //   need undo)
1032                         cur.recordUndoFullBuffer();
1033                         removeParameter(cur, cur, numargs_ - 1, true);
1034                 }
1035                 break;
1036
1037         case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1038                 commitEditChanges(cur, cur);
1039                 // FIXME: implement precise undo handling (only a few places
1040                 //   need undo)
1041                 cur.recordUndoFullBuffer();
1042                 makeOptional(cur, cur);
1043                 break;
1044
1045         case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1046                 commitEditChanges(cur, cur);
1047                 // FIXME: implement precise undo handling (only a few places
1048                 //   need undo)
1049                 cur.recordUndoFullBuffer();
1050                 makeNonOptional(cur, cur);
1051                 break;
1052
1053         case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1054                 if (numargs_ < 9) {
1055                         commitEditChanges(cur, cur);
1056                         // FIXME: implement precise undo handling (only a few places
1057                         //   need undo)
1058                         cur.recordUndoFullBuffer();
1059                         insertParameter(cur, cur, optionals_);
1060                         makeOptional(cur, cur);
1061                 }
1062                 break;
1063
1064         case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1065                 if (optionals_ > 0) {
1066                         commitEditChanges(cur, cur);
1067                         // FIXME: implement precise undo handling (only a few places
1068                         //   need undo)
1069                         cur.recordUndoFullBuffer();
1070                         removeParameter(cur, cur, optionals_ - 1);
1071                 } break;
1072
1073         case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1074                 if (numargs_ == optionals_) {
1075                         commitEditChanges(cur, cur);
1076                         // FIXME: implement precise undo handling (only a few places
1077                         //   need undo)
1078                         cur.recordUndoFullBuffer();
1079                         insertParameter(cur, cur, 0, true);
1080                         makeOptional(cur, cur);
1081                 }
1082                 break;
1083
1084         default:
1085                 InsetMathNest::doDispatch(cur, cmd);
1086                 break;
1087         }
1088 }
1089
1090
1091 bool MathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
1092         FuncStatus & flag) const
1093 {
1094         bool ret = true;
1095         string const arg = to_utf8(cmd.argument());
1096         switch (cmd.action()) {
1097                 case LFUN_MATH_MACRO_ADD_PARAM: {
1098                         int num = numargs_ + 1;
1099                         if (!arg.empty())
1100                                 num = convert<int>(arg);
1101                         bool on = (num >= optionals_
1102                                    && numargs_ < 9 && num <= numargs_ + 1);
1103                         flag.setEnabled(on);
1104                         break;
1105                 }
1106
1107                 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1108                         flag.setEnabled(numargs_ < 9);
1109                         break;
1110
1111                 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1112                 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1113                         int num = numargs_;
1114                         if (!arg.empty())
1115                                 num = convert<int>(arg);
1116                         flag.setEnabled(num >= 1 && num <= numargs_);
1117                         break;
1118                 }
1119
1120                 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1121                         flag.setEnabled(numargs_ > 0
1122                                      && optionals_ < numargs_
1123                                      && type_ != MacroTypeDef);
1124                         break;
1125
1126                 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1127                         flag.setEnabled(optionals_ > 0
1128                                      && type_ != MacroTypeDef);
1129                         break;
1130
1131                 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1132                         flag.setEnabled(numargs_ < 9);
1133                         break;
1134
1135                 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1136                         flag.setEnabled(optionals_ > 0);
1137                         break;
1138
1139                 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1140                         flag.setEnabled(numargs_ == 0
1141                                      && type_ != MacroTypeDef);
1142                         break;
1143
1144                 case LFUN_IN_MATHMACROTEMPLATE:
1145                         flag.setEnabled(true);
1146                         break;
1147
1148                 default:
1149                         ret = InsetMathNest::getStatus(cur, cmd, flag);
1150                         break;
1151         }
1152         return ret;
1153 }
1154
1155
1156 void MathMacroTemplate::read(Lexer & lex)
1157 {
1158         MathData ar(buffer_);
1159         mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1160         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1161                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1162                 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1163                 return;
1164         }
1165         operator=( *(ar[0]->asMacroTemplate()) );
1166
1167         updateLook();
1168 }
1169
1170
1171 void MathMacroTemplate::write(ostream & os) const
1172 {
1173         odocstringstream oss;
1174         TexRow texrow(false);
1175         otexrowstream ots(oss,texrow);
1176         WriteStream wi(ots, false, false, WriteStream::wsDefault);
1177         oss << "FormulaMacro\n";
1178         write(wi);
1179         os << to_utf8(oss.str());
1180 }
1181
1182
1183 void MathMacroTemplate::write(WriteStream & os) const
1184 {
1185         write(os, false);
1186 }
1187
1188
1189 int MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
1190 {
1191         int num_lines = 0;
1192
1193         if (os.latex()) {
1194                 if (optionals_ > 0) {
1195                         // macros with optionals use the xargs package, e.g.:
1196                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1197                         // \long is implicit by xargs
1198                         if (redefinition_ && !overwriteRedefinition)
1199                                 os << "\\renewcommandx";
1200                         else
1201                                 os << "\\newcommandx";
1202
1203                         os << "\\" << name()
1204                            << "[" << numargs_ << "]"
1205                            << "[usedefault, addprefix=\\global";
1206                         for (int i = 0; i < optionals_; ++i) {
1207                                 docstring optValue = asString(cell(optIdx(i)));
1208                                 if (optValue.find(']') != docstring::npos
1209                                     || optValue.find(',') != docstring::npos)
1210                                         os << ", " << i + 1 << "="
1211                                         << "{" << cell(optIdx(i)) << "}";
1212                                 else
1213                                         os << ", " << i + 1 << "="
1214                                         << cell(optIdx(i));
1215                         }
1216                         os << "]";
1217                 } else {
1218                         // Macros without optionals use standard _global_ \def macros:
1219                         //   \global\def\long\foo#1#2{#1,#2}
1220                         // We use the \long prefix as this is the equivalent to \newcommand.
1221                         // We cannot use \newcommand directly because \global does not work with it.
1222                         os << "\\global\\long\\def\\" << name();
1223                         docstring param = from_ascii("#0");
1224                         for (int i = 1; i <= numargs_; ++i) {
1225                                 param[1] = '0' + i;
1226                                 os << param;
1227                         }
1228                 }
1229         } else {
1230                 // in LyX output we use some pseudo syntax which is implementation
1231                 // independent, e.g.
1232                 // \newcommand{\foo}[2][default]{#1,#2}
1233                 if (redefinition_ && !overwriteRedefinition)
1234                         os << "\\renewcommand";
1235                 else
1236                         os << "\\newcommand";
1237                 os << "{\\" << name() << '}';
1238                 if (numargs_ > 0)
1239                         os << '[' << numargs_ << ']';
1240
1241                 for (int i = 0; i < optionals_; ++i) {
1242                         docstring optValue = asString(cell(optIdx(i)));
1243                         if (optValue.find(']') != docstring::npos)
1244                                 os << "[{" << cell(optIdx(i)) << "}]";
1245                         else
1246                                 os << "[" << cell(optIdx(i)) << "]";
1247                 }
1248         }
1249
1250         os << "{" << cell(defIdx()) << "}";
1251
1252         if (os.latex()) {
1253                 // writing .tex. done.
1254                 os << "\n";
1255                 ++num_lines;
1256         } else {
1257                 // writing .lyx, write special .tex export only if necessary
1258                 if (!cell(displayIdx()).empty()) {
1259                         os << "\n{" << cell(displayIdx()) << '}';
1260                         ++num_lines;
1261                 }
1262         }
1263
1264         return num_lines;
1265 }
1266
1267
1268 docstring MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
1269 {
1270         return docstring();
1271 }
1272
1273 int MathMacroTemplate::plaintext(odocstringstream & os,
1274                                  OutputParams const &, size_t) const
1275 {
1276         docstring const str = '[' + buffer().B_("math macro") + ']';
1277
1278         os << str;
1279         return str.size();
1280 }
1281
1282
1283 bool MathMacroTemplate::validName() const
1284 {
1285         docstring n = name();
1286
1287         if (n.empty())
1288                 return false;
1289
1290         // converting back and force doesn't swallow anything?
1291         /*MathData ma;
1292         asArray(n, ma);
1293         if (asString(ma) != n)
1294                 return false;*/
1295
1296         // valid characters?
1297         for (size_t i = 0; i < n.size(); ++i) {
1298                 if (!(n[i] >= 'a' && n[i] <= 'z')
1299                     && !(n[i] >= 'A' && n[i] <= 'Z')
1300                     && n[i] != '*')
1301                         return false;
1302         }
1303
1304         return true;
1305 }
1306
1307
1308 bool MathMacroTemplate::validMacro() const
1309 {
1310         return validName();
1311 }
1312
1313
1314 bool MathMacroTemplate::fixNameAndCheckIfValid()
1315 {
1316         // check all the characters/insets in the name cell
1317         size_t i = 0;
1318         MathData & data = cell(0);
1319         while (i < data.size()) {
1320                 InsetMathChar const * cinset = data[i]->asCharInset();
1321                 if (cinset) {
1322                         // valid character in [a-zA-Z]?
1323                         char_type c = cinset->getChar();
1324                         if ((c >= 'a' && c <= 'z')
1325                             || (c >= 'A' && c <= 'Z')) {
1326                                 ++i;
1327                                 continue;
1328                         }
1329                 }
1330
1331                 // throw cell away
1332                 data.erase(i);
1333         }
1334
1335         // now it should be valid if anything in the name survived
1336         return !data.empty();
1337 }
1338
1339
1340 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1341 {
1342         // we need global optional macro arguments. They are not available
1343         // with \def, and \newcommand does not support global macros. So we
1344         // are bound to xargs also for the single-optional-parameter case.
1345         if (optionals_ > 0)
1346                 features.require("xargs");
1347 }
1348
1349 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1350 {
1351         defaults.resize(numargs_);
1352         for (int i = 0; i < optionals_; ++i)
1353                 defaults[i] = asString(cell(optIdx(i)));
1354 }
1355
1356
1357 docstring MathMacroTemplate::definition() const
1358 {
1359         return asString(cell(defIdx()));
1360 }
1361
1362
1363 docstring MathMacroTemplate::displayDefinition() const
1364 {
1365         return asString(cell(displayIdx()));
1366 }
1367
1368
1369 size_t MathMacroTemplate::numArgs() const
1370 {
1371         return numargs_;
1372 }
1373
1374
1375 size_t MathMacroTemplate::numOptionals() const
1376 {
1377         return optionals_;
1378 }
1379
1380
1381 void MathMacroTemplate::infoize(odocstream & os) const
1382 {
1383         os << bformat(_("Math Macro: \\%1$s"), name());
1384 }
1385
1386
1387 string MathMacroTemplate::contextMenuName() const
1388 {
1389         return "context-math-macro-definition";
1390 }
1391
1392 void MathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
1393                                                                  UpdateType) const
1394 {
1395         shared_ptr<Toc> toc = buffer().tocBackend().toc("math-macro");
1396         docstring str;
1397         if (!validMacro())
1398                 str = bformat(_("Invalid macro! \\%1$s"), name());
1399         else
1400                 str = "\\" + name();
1401         toc->push_back(TocItem(pit, 0, str, output_active));
1402 }
1403
1404
1405 } // namespace lyx