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 "InsetMathBrace.h"
  17 #include "InsetMathChar.h"
  18 #include "InsetMathHull.h"
  19 #include "InsetMathSqrt.h"
  20 #include "MathMacro.h"
  21 #include "MathMacroArgument.h"
  22 #include "MathStream.h"
  23 #include "MathParser.h"
  24 #include "MathSupport.h"
  25 #include "MathMacroArgument.h"
  26
  27 #include "Buffer.h"
  28 #include "BufferView.h"
  29 #include "Color.h"
  30 #include "Cursor.h"
  31 #include "DispatchResult.h"
  32 #include "DocIterator.h"
  33 #include "FuncRequest.h"
  34 #include "FuncStatus.h"
  35 #include "LaTeXFeatures.h"
  36 #include "Lexer.h"
  37 #include "MetricsInfo.h"
  38 #include "TocBackend.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 <set>
  52 #include <sstream>
  53
  54 using namespace std;
  55
  56 namespace lyx {
  57
  58 using support::bformat;
  59
  60 //////////////////////////////////////////////////////////////////////
  61
  62 class InsetLabelBox : public InsetMathNest {
  63 public:
  64         ///
  65         InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
  66                       MathMacroTemplate const & parent, bool frame = false);
  67         InsetLabelBox(Buffer * buf, docstring label, MathMacroTemplate const & parent,
  68                       bool frame = false);
  69         ///
  70         void metrics(MetricsInfo & mi, Dimension & dim) const;
  71         ///
  72         void draw(PainterInfo &, int x, int y) const;
  73
  74 protected:
  75         ///
  76         MathMacroTemplate const & parent_;
  77         ///
  78         Inset * clone() const;
  79         ///
  80         docstring const label_;
  81         ///
  82         bool frame_;
  83 };
  84
  85
  86 InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
  87         MathMacroTemplate const & parent, bool frame)
  88         : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
  89 {
  90         cell(0).insert(0, atom);
  91 }
  92
  93
  94 InsetLabelBox::InsetLabelBox(Buffer * buf, docstring label,
  95                              MathMacroTemplate const & parent, bool frame)
  96         : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
  97 {
  98 }
  99
 100
 101 Inset * InsetLabelBox::clone() const
 102 {
 103         return new InsetLabelBox(*this);
 104 }
 105
 106
 107 void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
 108 {
 109         // kernel
 110         cell(0).metrics(mi, dim);
 111
 112         // frame
 113         if (frame_) {
 114                 dim.wid += 6;
 115                 dim.asc += 5;
 116                 dim.des += 5;
 117         }
 118
 119         // adjust to common height in main metrics phase
 120         if (!parent_.premetrics()) {
 121                 dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
 122                 dim.des = max(dim.des, parent_.commonLabelBoxDescent());
 123         }
 124
 125         // label
 126         if (parent_.editing(mi.base.bv) && label_.length() > 0) {
 127                 // grey
 128                 FontInfo font = sane_font;
 129                 font.setSize(FONT_SIZE_TINY);
 130                 font.setColor(Color_mathmacrolabel);
 131
 132                 // make space for label and box
 133                 int lwid = mathed_string_width(font, label_);
 134                 int maxasc;
 135                 int maxdes;
 136                 math_font_max_dim(font, maxasc, maxdes);
 137
 138                 dim.wid = max(dim.wid, lwid + 2);
 139
 140                 // space for the label
 141                 if (!parent_.premetrics())
 142                         dim.des += maxasc + maxdes + 1;
 143         }
 144 }
 145
 146
 147 void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
 148 {
 149         Dimension const dim = dimension(*pi.base.bv);
 150         Dimension const cdim = cell(0).dimension(*pi.base.bv);
 151
 152         // kernel
 153         cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
 154
 155         // label
 156         if (parent_.editing(pi.base.bv) && label_.length() > 0) {
 157                 // grey
 158                 FontInfo font = sane_font;
 159                 font.setSize(FONT_SIZE_TINY);
 160                 font.setColor(Color_mathmacrolabel);
 161
 162                 // make space for label and box
 163                 int lwid = mathed_string_width(font, label_);
 164                 int maxasc;
 165                 int maxdes;
 166                 math_font_max_dim(font, maxasc, maxdes);
 167
 168                 if (lwid < dim.wid)
 169                         pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
 170                 else
 171                         pi.pain.text(x, y + dim.des - maxdes, label_, font);
 172         }
 173
 174         // draw frame
 175         int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
 176         if (frame_) {
 177                 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
 178                                   dim.wid - 2, boxHeight - 2,
 179                                   Color_mathline);
 180         }
 181 }
 182
 183
 184 //////////////////////////////////////////////////////////////////////
 185
 186 class DisplayLabelBox : public InsetLabelBox {
 187 public:
 188         ///
 189         DisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
 190                         MathMacroTemplate const & parent);
 191
 192         ///
 193         void metrics(MetricsInfo & mi, Dimension & dim) const;
 194         ///
 195         void draw(PainterInfo &, int x, int y) const;
 196
 197 protected:
 198         ///
 199         Inset * clone() const;
 200 };
 201
 202
 203 DisplayLabelBox::DisplayLabelBox(Buffer * buf, MathAtom const & atom,
 204                                  docstring label,
 205                                  MathMacroTemplate const & parent)
 206         : InsetLabelBox(buf, atom, label, parent, true)
 207 {
 208 }
 209
 210
 211
 212 Inset * DisplayLabelBox::clone() const
 213 {
 214         return new DisplayLabelBox(*this);
 215 }
 216
 217
 218 void DisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
 219 {
 220         InsetLabelBox::metrics(mi, dim);
 221         if (!parent_.editing(mi.base.bv)
 222             && parent_.cell(parent_.displayIdx()).empty()) {
 223                 dim.wid = 0;
 224                 dim.asc = 0;
 225                 dim.des = 0;
 226         }
 227 }
 228
 229
 230 void DisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
 231 {
 232         if (parent_.editing(pi.base.bv)
 233             || !parent_.cell(parent_.displayIdx()).empty()) {
 234                 InsetLabelBox::draw(pi, x, y);
 235         } else {
 236                 bool enabled = pi.pain.isDrawingEnabled();
 237                 pi.pain.setDrawingEnabled(false);
 238                 InsetLabelBox::draw(pi, x, y);
 239                 pi.pain.setDrawingEnabled(enabled);
 240         }
 241 }
 242
 243
 244 //////////////////////////////////////////////////////////////////////
 245
 246 class InsetMathWrapper : public InsetMath {
 247 public:
 248         ///
 249         InsetMathWrapper(MathData const * value) : value_(value) {}
 250         ///
 251         void metrics(MetricsInfo & mi, Dimension & dim) const;
 252         ///
 253         void draw(PainterInfo &, int x, int y) const;
 254
 255 private:
 256         ///
 257         Inset * clone() const;
 258         ///
 259         MathData const * value_;
 260 };
 261
 262
 263 Inset * InsetMathWrapper::clone() const
 264 {
 265         return new InsetMathWrapper(*this);
 266 }
 267
 268
 269 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 270 {
 271         value_->metrics(mi, dim);
 272         //metricsMarkers2(mi, dim);
 273 }
 274
 275
 276 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
 277 {
 278         value_->draw(pi, x, y);
 279         //drawMarkers(pi, x, y);
 280 }
 281
 282
 283 ///////////////////////////////////////////////////////////////////////
 284 class InsetColoredCell : public InsetMathNest {
 285 public:
 286         ///
 287         InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max);
 288         ///
 289         InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom);
 290         ///
 291         void draw(PainterInfo &, int x, int y) const;
 292         ///
 293         void metrics(MetricsInfo & mi, Dimension & dim) const;
 294
 295 protected:
 296         ///
 297         Inset * clone() const;
 298         ///
 299         ColorCode min_;
 300         ///
 301         ColorCode max_;
 302 };
 303
 304
 305 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max)
 306         : InsetMathNest(buf, 1), min_(min), max_(max)
 307 {
 308 }
 309
 310
 311 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom)
 312         : InsetMathNest(buf, 1), min_(min), max_(max)
 313 {
 314         cell(0).insert(0, atom);
 315 }
 316
 317
 318 Inset * InsetColoredCell::clone() const
 319 {
 320         return new InsetColoredCell(*this);
 321 }
 322
 323
 324 void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
 325 {
 326         cell(0).metrics(mi, dim);
 327 }
 328
 329
 330 void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
 331 {
 332         pi.pain.enterMonochromeMode(min_, max_);
 333         cell(0).draw(pi, x, y);
 334         pi.pain.leaveMonochromeMode();
 335 }
 336
 337
 338 ///////////////////////////////////////////////////////////////////////
 339
 340 class InsetNameWrapper : public InsetMathWrapper {
 341 public:
 342         ///
 343         InsetNameWrapper(MathData const * value, MathMacroTemplate const & parent);
 344         ///
 345         void metrics(MetricsInfo & mi, Dimension & dim) const;
 346         ///
 347         void draw(PainterInfo &, int x, int y) const;
 348
 349 private:
 350         ///
 351         MathMacroTemplate const & parent_;
 352         ///
 353         Inset * clone() const;
 354 };
 355
 356
 357 InsetNameWrapper::InsetNameWrapper(MathData const * value,
 358                                    MathMacroTemplate const & parent)
 359         : InsetMathWrapper(value), parent_(parent)
 360 {
 361 }
 362
 363
 364 Inset * InsetNameWrapper::clone() const
 365 {
 366         return new InsetNameWrapper(*this);
 367 }
 368
 369
 370 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 371 {
 372         InsetMathWrapper::metrics(mi, dim);
 373         dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
 374 }
 375
 376
 377 void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
 378 {
 379         // create fonts
 380         PainterInfo namepi = pi;
 381         if (parent_.validMacro())
 382                 namepi.base.font.setColor(Color_latex);
 383         else
 384                 namepi.base.font.setColor(Color_error);
 385
 386         // draw backslash
 387         pi.pain.text(x, y, from_ascii("\\"), namepi.base.font);
 388         x += mathed_string_width(namepi.base.font, from_ascii("\\"));
 389
 390         // draw name
 391         InsetMathWrapper::draw(namepi, x, y);
 392 }
 393
 394
 395 ///////////////////////////////////////////////////////////////////////
 396
 397
 398 MathMacroTemplate::MathMacroTemplate(Buffer * buf)
 399         : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
 400           type_(MacroTypeNewcommand), redefinition_(false), lookOutdated_(true),
 401           premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 402 {
 403         initMath();
 404 }
 405
 406
 407 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
 408         int optionals, MacroType type, vector<MathData> const & optionalValues,
 409         MathData const & def, MathData const & display)
 410         : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
 411           optionals_(optionals), optionalValues_(optionalValues),
 412           type_(type), redefinition_(false), lookOutdated_(true),
 413           premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 414 {
 415         initMath();
 416
 417         if (numargs_ > 9)
 418                 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
 419                         << numargs_ << endl;
 420
 421         asArray(name, cell(0));
 422         optionalValues_.resize(9);
 423         for (int i = 0; i < optionals_; ++i)
 424                 cell(optIdx(i)) = optionalValues_[i];
 425         cell(defIdx()) = def;
 426         cell(displayIdx()) = display;
 427
 428         updateLook();
 429 }
 430
 431
 432 bool MathMacroTemplate::fromString(docstring const & str)
 433 {
 434         MathData ar(buffer_);
 435         mathed_parse_cell(ar, str, Parse::NORMAL);
 436         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
 437                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
 438                 asArray(from_ascii("invalidmacro"), cell(0));
 439                 // The macro template does not make sense after this.
 440                 return false;
 441         }
 442         operator=( *(ar[0]->asMacroTemplate()) );
 443
 444         updateLook();
 445         return true;
 446 }
 447
 448
 449 Inset * MathMacroTemplate::clone() const
 450 {
 451         MathMacroTemplate * inset = new MathMacroTemplate(*this);
 452         // the parent pointers of the proxy insets above will point to
 453         // to the old template. Hence, the look must be updated.
 454         inset->updateLook();
 455         return inset;
 456 }
 457
 458
 459 docstring MathMacroTemplate::name() const
 460 {
 461         return asString(cell(0));
 462 }
 463
 464
 465 void MathMacroTemplate::updateToContext(MacroContext const & mc)
 466 {
 467         redefinition_ = mc.get(name()) != 0;
 468 }
 469
 470
 471 void MathMacroTemplate::updateLook() const
 472 {
 473         lookOutdated_ = true;
 474 }
 475
 476
 477 void MathMacroTemplate::createLook(int args) const
 478 {
 479         look_.clear();
 480         argsInLook_ = args;
 481
 482         // \foo
 483         look_.push_back(MathAtom(
 484                 new InsetLabelBox(buffer_, _("Name"), *this, false)));
 485         MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
 486         nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
 487
 488         // [#1][#2]
 489         int i = 0;
 490         if (optionals_ > 0) {
 491                 look_.push_back(MathAtom(
 492                         new InsetLabelBox(buffer_, _("optional"), *this, false)));
 493
 494                 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
 495                 for (; i < optionals_; ++i) {
 496                         // color it light grey, if it is to be removed when the cursor leaves
 497                         if (i == argsInLook_) {
 498                                 optData->push_back(MathAtom(
 499                                         new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
 500                                 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
 501                         }
 502
 503                         optData->push_back(MathAtom(new InsetMathChar('[')));
 504                         optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
 505                         optData->push_back(MathAtom(new InsetMathChar(']')));
 506                 }
 507         }
 508
 509         // {#3}{#4}
 510         for (; i < numargs_; ++i) {
 511                 MathData arg;
 512                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 513                 if (i >= argsInLook_) {
 514                         look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 515                                 Color_mathbg, Color_mathmacrooldarg,
 516                                 MathAtom(new InsetMathBrace(arg)))));
 517                 } else
 518                         look_.push_back(MathAtom(new InsetMathBrace(arg)));
 519         }
 520         for (; i < argsInLook_; ++i) {
 521                 MathData arg;
 522                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 523                 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 524                         Color_mathbg, Color_mathmacronewarg,
 525                         MathAtom(new InsetMathBrace(arg)))));
 526         }
 527
 528         // :=
 529         look_.push_back(MathAtom(new InsetMathChar(':')));
 530         look_.push_back(MathAtom(new InsetMathChar('=')));
 531
 532         // definition
 533         look_.push_back(MathAtom(
 534                 new InsetLabelBox(buffer_, MathAtom(
 535                         new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this,        true)));
 536
 537         // display
 538         look_.push_back(MathAtom(
 539                 new DisplayLabelBox(buffer_, MathAtom(
 540                         new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
 541 }
 542
 543
 544 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 545 {
 546         Changer dummy1 = mi.base.changeFontSet("mathnormal");
 547         Changer dummy2 = mi.base.font.changeStyle(LM_ST_TEXT);
 548
 549         // valid macro?
 550         MacroData const * macro = 0;
 551         if (validName())
 552                 macro = mi.macrocontext.get(name());
 553
 554         // update look?
 555         int argsInDef = maxArgumentInDefinition();
 556         if (lookOutdated_ || argsInDef != argsInLook_) {
 557                 lookOutdated_ = false;
 558                 createLook(argsInDef);
 559         }
 560
 561         /// metrics for inset contents
 562         if (macro)
 563                 macro->lock();
 564
 565         // first phase, premetric:
 566         premetrics_ = true;
 567         look_.metrics(mi, dim);
 568         labelBoxAscent_ = dim.asc;
 569         labelBoxDescent_ = dim.des;
 570
 571         // second phase, main metric:
 572         premetrics_ = false;
 573         look_.metrics(mi, dim);
 574
 575         if (macro)
 576                 macro->unlock();
 577
 578         dim.wid += 6;
 579         dim.des += 2;
 580         dim.asc += 2;
 581
 582         setDimCache(mi, dim);
 583 }
 584
 585
 586 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 587 {
 588         // FIXME: Calling Changer on the same object repeatedly is inefficient.
 589         Changer dummy0 = pi.base.font.changeColor(Color_math);
 590         Changer dummy1 = pi.base.changeFontSet("mathnormal");
 591         Changer dummy2 = pi.base.font.changeStyle(LM_ST_TEXT);
 592
 593         setPosCache(pi, x, y);
 594         Dimension const dim = dimension(*pi.base.bv);
 595
 596         // draw outer frame
 597         int const a = y - dim.asc + 1;
 598         int const w = dim.wid - 2;
 599         int const h = dim.height() - 2;
 600         pi.pain.rectangle(x + 1, a, w, h, Color_mathframe);
 601
 602         // just to be sure: set some dummy values for coord cache
 603         for (idx_type i = 0; i < nargs(); ++i)
 604                 cell(i).setXY(*pi.base.bv, x, y);
 605
 606         // draw contents
 607         look_.draw(pi, x + 3, y);
 608 }
 609
 610
 611 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
 612 {
 613         updateLook();
 614         cur.screenUpdateFlags(Update::SinglePar);
 615         InsetMathNest::edit(cur, front, entry_from);
 616 }
 617
 618
 619 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 620 {
 621         unsigned int const nargs_before = nargs();
 622         commitEditChanges(cur, old);
 623         updateLook();
 624         cur.screenUpdateFlags(Update::Force);
 625         // If we have removed a cell, we might have invalidated the cursor
 626         return InsetMathNest::notifyCursorLeaves(old, cur)
 627                 || nargs() < nargs_before;
 628 }
 629
 630
 631 void MathMacroTemplate::removeArguments(Cursor & cur,
 632         DocIterator const & /*inset_pos*/, int from, int to)
 633 {
 634         DocIterator it = doc_iterator_begin(&buffer(), this);
 635         for (; it; it.forwardChar()) {
 636                 if (!it.nextInset())
 637                         continue;
 638                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 639                         continue;
 640                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 641                 int n = arg->number() - 1;
 642                 if (from <= n && n <= to) {
 643                         int cellSlice = cur.find(it.cell());
 644                         if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
 645                                 --cur[cellSlice].pos();
 646
 647                         it.cell().erase(it.pos());
 648                 }
 649         }
 650
 651         updateLook();
 652 }
 653
 654
 655 void MathMacroTemplate::shiftArguments(size_t from, int by)
 656 {
 657         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 658                 if (!it.nextInset())
 659                         continue;
 660                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 661                         continue;
 662                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 663                 if (arg->number() >= int(from) + 1)
 664                         arg->setNumber(arg->number() + by);
 665         }
 666
 667         updateLook();
 668 }
 669
 670
 671 int MathMacroTemplate::maxArgumentInDefinition() const
 672 {
 673         // We don't have a buffer when pasting from the clipboard (bug 6014).
 674         Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
 675         int maxArg = 0;
 676         DocIterator it = doc_iterator_begin(macro_buffer, this);
 677         it.idx() = defIdx();
 678         for (; it; it.forwardChar()) {
 679                 if (!it.nextInset())
 680                         continue;
 681                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 682                         continue;
 683                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 684                 maxArg = std::max(int(arg->number()), maxArg);
 685         }
 686         return maxArg;
 687 }
 688
 689
 690 void MathMacroTemplate::insertMissingArguments(int maxArg)
 691 {
 692         bool found[9] = { false, false, false, false, false, false, false, false, false };
 693         idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
 694
 695         // search for #n macros arguments
 696         DocIterator it = doc_iterator_begin(&buffer(), this);
 697         it.idx() = idx;
 698         for (; it && it[0].idx() == idx; it.forwardChar()) {
 699                 if (!it.nextInset())
 700                         continue;
 701                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 702                         continue;
 703                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 704                 found[arg->number() - 1] = true;
 705         }
 706
 707         // add missing ones
 708         for (int i = 0; i < maxArg; ++i) {
 709                 if (found[i])
 710                         continue;
 711
 712                 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
 713         }
 714 }
 715
 716
 717 void MathMacroTemplate::changeArity(Cursor & cur,
 718         DocIterator const & inset_pos, int newNumArg)
 719 {
 720         // remove parameter which do not appear anymore in the definition
 721         for (int i = numargs_; i > newNumArg; --i)
 722                 removeParameter(cur, inset_pos, numargs_ - 1, true);
 723
 724         // add missing parameter
 725         for (int i = numargs_; i < newNumArg; ++i)
 726                 insertParameter(cur, inset_pos, numargs_, true, false);
 727 }
 728
 729
 730 ///
 731 class AddRemoveMacroInstanceFix
 732 {
 733 public:
 734         ///
 735         AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
 736         ///
 737         void operator()(MathMacro * macro)
 738         {
 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         {
 764                 macro->setOptionals(optionals_);
 765         }
 766
 767 private:
 768         ///
 769         int optionals_;
 770 };
 771
 772
 773 ///
 774 class NullMacroInstanceFix
 775 {
 776 public:
 777         ///
 778         void operator()(MathMacro * ) {}
 779 };
 780
 781
 782 template<class F>
 783 void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
 784         docstring const & name, F & fix)
 785 {
 786         // goto position behind macro template
 787         DocIterator dit = inset_pos;
 788         dit.pop_back();
 789         dit.top().forwardPos();
 790
 791         // remember hull to trigger preview reload
 792         DocIterator hull(dit.buffer());
 793         bool preview_reload_needed = false;
 794         set<DocIterator> preview_hulls;
 795
 796         // iterate over all positions until macro is redefined
 797         for (; dit; dit.forwardPos()) {
 798                 // left the outer hull?
 799                 if (!hull.empty() && dit.depth() == hull.depth()) {
 800                         // schedule reload of the preview if necessary
 801                         if (preview_reload_needed) {
 802                                 preview_hulls.insert(hull);
 803                                 preview_reload_needed = false;
 804                         }
 805                         hull.clear();
 806                 }
 807
 808                 // only until a macro is redefined
 809                 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
 810                         MathMacroTemplate const & macroTemplate
 811                         = static_cast<MathMacroTemplate const &>(dit.inset());
 812                         if (macroTemplate.name() == name)
 813                                 break;
 814                 }
 815
 816                 // in front of macro instance?
 817                 Inset * inset = dit.nextInset();
 818                 if (!inset)
 819                         continue;
 820                 InsetMath * insetMath = inset->asInsetMath();
 821                 if (!insetMath)
 822                         continue;
 823
 824                 // in front of outer hull?
 825                 InsetMathHull * inset_hull = insetMath->asHullInset();
 826                 if (inset_hull && hull.empty()) {
 827                         // remember this for later preview reload
 828                         hull = dit;
 829                 }
 830
 831                 MathMacro * macro = insetMath->asMacro();
 832                 if (macro && macro->name() == name && macro->folded()) {
 833                         fix(macro);
 834                         if (RenderPreview::previewMath())
 835                                 preview_reload_needed = true;
 836                 }
 837         }
 838
 839         if (!preview_hulls.empty()) {
 840                 // reload the scheduled previews
 841                 set<DocIterator>::const_iterator sit = preview_hulls.begin();
 842                 set<DocIterator>::const_iterator end = preview_hulls.end();
 843                 for (; sit != end; ++sit) {
 844                         InsetMathHull * inset_hull =
 845                                 sit->nextInset()->asInsetMath()->asHullInset();
 846                         LBUFERR(inset_hull);
 847                         inset_hull->reloadPreview(*sit);
 848                 }
 849                 cur.screenUpdateFlags(Update::Force);
 850         }
 851 }
 852
 853
 854 void MathMacroTemplate::commitEditChanges(Cursor & cur,
 855         DocIterator const & inset_pos)
 856 {
 857         int args_in_def = maxArgumentInDefinition();
 858         if (args_in_def != numargs_) {
 859                 // FIXME: implement precise undo handling (only a few places
 860                 //   need undo)
 861                 cur.recordUndoFullBuffer();
 862                 changeArity(cur, inset_pos, args_in_def);
 863         }
 864         insertMissingArguments(args_in_def);
 865
 866         // make sure the preview are up to date
 867         NullMacroInstanceFix fix;
 868         fixMacroInstances(cur, inset_pos, name(), fix);
 869 }
 870
 871
 872 void MathMacroTemplate::insertParameter(Cursor & cur,
 873         DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
 874 {
 875         if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
 876                 ++numargs_;
 877
 878                 // append example #n
 879                 if (addarg) {
 880                         shiftArguments(pos, 1);
 881
 882                         cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 883                         if (!cell(displayIdx()).empty())
 884                                 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 885                 }
 886
 887                 if (!greedy) {
 888                         // fix macro instances
 889                         AddRemoveMacroInstanceFix fix(pos, true);
 890                         fixMacroInstances(cur, inset_pos, name(), fix);
 891                 }
 892         }
 893
 894         updateLook();
 895 }
 896
 897
 898 void MathMacroTemplate::removeParameter(Cursor & cur,
 899         DocIterator const & inset_pos, int pos, bool greedy)
 900 {
 901         if (pos < numargs_ && pos >= 0) {
 902                 --numargs_;
 903                 removeArguments(cur, inset_pos, pos, pos);
 904                 shiftArguments(pos + 1, -1);
 905
 906                 // removed optional parameter?
 907                 if (pos < optionals_) {
 908                         --optionals_;
 909                         optionalValues_[pos] = cell(optIdx(pos));
 910                         cells_.erase(cells_.begin() + optIdx(pos));
 911
 912                         // fix cursor
 913                         int macroSlice = cur.find(this);
 914                         if (macroSlice != -1) {
 915                                 if (cur[macroSlice].idx() == optIdx(pos)) {
 916                                         cur.cutOff(macroSlice);
 917                                         cur[macroSlice].idx() = 1;
 918                                         cur[macroSlice].pos() = 0;
 919                                 } else if (cur[macroSlice].idx() > optIdx(pos))
 920                                         --cur[macroSlice].idx();
 921                         }
 922                 }
 923
 924                 if (!greedy) {
 925                         // fix macro instances
 926                         AddRemoveMacroInstanceFix fix(pos, false);
 927                         fixMacroInstances(cur, inset_pos, name(), fix);
 928                 }
 929         }
 930
 931         updateLook();
 932 }
 933
 934
 935 void MathMacroTemplate::makeOptional(Cursor & cur,
 936         DocIterator const & inset_pos)
 937 {
 938         if (numargs_ > 0 && optionals_ < numargs_) {
 939                 ++optionals_;
 940                 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
 941                 // fix cursor
 942                 int macroSlice = cur.find(this);
 943                 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
 944                         ++cur[macroSlice].idx();
 945
 946                 // fix macro instances
 947                 OptionalsMacroInstanceFix fix(optionals_);
 948                 fixMacroInstances(cur, inset_pos, name(), fix);
 949         }
 950
 951         updateLook();
 952 }
 953
 954
 955 void MathMacroTemplate::makeNonOptional(Cursor & cur,
 956         DocIterator const & inset_pos)
 957 {
 958         if (numargs_ > 0 && optionals_ > 0) {
 959                 --optionals_;
 960
 961                 // store default value for later if the user changes his mind
 962                 optionalValues_[optionals_] = cell(optIdx(optionals_));
 963                 cells_.erase(cells_.begin() + optIdx(optionals_));
 964
 965                 // fix cursor
 966                 int macroSlice = cur.find(this);
 967                 if (macroSlice != -1) {
 968                         if (cur[macroSlice].idx() > optIdx(optionals_))
 969                                 --cur[macroSlice].idx();
 970                         else if (cur[macroSlice].idx() == optIdx(optionals_)) {
 971                                 cur.cutOff(macroSlice);
 972                                 cur[macroSlice].idx() = optIdx(optionals_);
 973                                 cur[macroSlice].pos() = 0;
 974                         }
 975                 }
 976
 977                 // fix macro instances
 978                 OptionalsMacroInstanceFix fix(optionals_);
 979                 fixMacroInstances(cur, inset_pos, name(), fix);
 980         }
 981
 982         updateLook();
 983 }
 984
 985
 986 void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
 987 {
 988         string const arg = to_utf8(cmd.argument());
 989         switch (cmd.action()) {
 990
 991         case LFUN_MATH_MACRO_ADD_PARAM:
 992                 if (numargs_ < 9) {
 993                         commitEditChanges(cur, cur);
 994                         // FIXME: implement precise undo handling (only a few places
 995                         //   need undo)
 996                         cur.recordUndoFullBuffer();
 997                         size_t pos = numargs_;
 998                         if (!arg.empty())
 999                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1000                         insertParameter(cur, cur, pos);
1001                 }
1002                 break;
1003
1004
1005         case LFUN_MATH_MACRO_REMOVE_PARAM:
1006                 if (numargs_ > 0) {
1007                         commitEditChanges(cur, cur);
1008                         // FIXME: implement precise undo handling (only a few places
1009                         //   need undo)
1010                         cur.recordUndoFullBuffer();
1011                         size_t pos = numargs_ - 1;
1012                         if (!arg.empty())
1013                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1014                         removeParameter(cur, cur, pos);
1015                 }
1016                 break;
1017
1018         case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1019                 if (numargs_ < 9) {
1020                         commitEditChanges(cur, cur);
1021                         // FIXME: implement precise undo handling (only a few places
1022                         //   need undo)
1023                         cur.recordUndoFullBuffer();
1024                         insertParameter(cur, cur, numargs_, true);
1025                 }
1026                 break;
1027
1028         case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1029                 if (numargs_ > 0) {
1030                         commitEditChanges(cur, cur);
1031                         // FIXME: implement precise undo handling (only a few places
1032                         //   need undo)
1033                         cur.recordUndoFullBuffer();
1034                         removeParameter(cur, cur, numargs_ - 1, true);
1035                 }
1036                 break;
1037
1038         case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1039                 commitEditChanges(cur, cur);
1040                 // FIXME: implement precise undo handling (only a few places
1041                 //   need undo)
1042                 cur.recordUndoFullBuffer();
1043                 makeOptional(cur, cur);
1044                 break;
1045
1046         case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1047                 commitEditChanges(cur, cur);
1048                 // FIXME: implement precise undo handling (only a few places
1049                 //   need undo)
1050                 cur.recordUndoFullBuffer();
1051                 makeNonOptional(cur, cur);
1052                 break;
1053
1054         case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1055                 if (numargs_ < 9) {
1056                         commitEditChanges(cur, cur);
1057                         // FIXME: implement precise undo handling (only a few places
1058                         //   need undo)
1059                         cur.recordUndoFullBuffer();
1060                         insertParameter(cur, cur, optionals_);
1061                         makeOptional(cur, cur);
1062                 }
1063                 break;
1064
1065         case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1066                 if (optionals_ > 0) {
1067                         commitEditChanges(cur, cur);
1068                         // FIXME: implement precise undo handling (only a few places
1069                         //   need undo)
1070                         cur.recordUndoFullBuffer();
1071                         removeParameter(cur, cur, optionals_ - 1);
1072                 } break;
1073
1074         case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1075                 if (numargs_ == optionals_) {
1076                         commitEditChanges(cur, cur);
1077                         // FIXME: implement precise undo handling (only a few places
1078                         //   need undo)
1079                         cur.recordUndoFullBuffer();
1080                         insertParameter(cur, cur, 0, true);
1081                         makeOptional(cur, cur);
1082                 }
1083                 break;
1084
1085         default:
1086                 InsetMathNest::doDispatch(cur, cmd);
1087                 break;
1088         }
1089 }
1090
1091
1092 bool MathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
1093         FuncStatus & flag) const
1094 {
1095         bool ret = true;
1096         string const arg = to_utf8(cmd.argument());
1097         switch (cmd.action()) {
1098                 case LFUN_MATH_MACRO_ADD_PARAM: {
1099                         int num = numargs_ + 1;
1100                         if (!arg.empty())
1101                                 num = convert<int>(arg);
1102                         bool on = (num >= optionals_
1103                                    && numargs_ < 9 && num <= numargs_ + 1);
1104                         flag.setEnabled(on);
1105                         break;
1106                 }
1107
1108                 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1109                         flag.setEnabled(numargs_ < 9);
1110                         break;
1111
1112                 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1113                 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1114                         int num = numargs_;
1115                         if (!arg.empty())
1116                                 num = convert<int>(arg);
1117                         flag.setEnabled(num >= 1 && num <= numargs_);
1118                         break;
1119                 }
1120
1121                 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1122                         flag.setEnabled(numargs_ > 0
1123                                      && optionals_ < numargs_
1124                                      && type_ != MacroTypeDef);
1125                         break;
1126
1127                 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1128                         flag.setEnabled(optionals_ > 0
1129                                      && type_ != MacroTypeDef);
1130                         break;
1131
1132                 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1133                         flag.setEnabled(numargs_ < 9);
1134                         break;
1135
1136                 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1137                         flag.setEnabled(optionals_ > 0);
1138                         break;
1139
1140                 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1141                         flag.setEnabled(numargs_ == 0
1142                                      && type_ != MacroTypeDef);
1143                         break;
1144
1145                 case LFUN_IN_MATHMACROTEMPLATE:
1146                         flag.setEnabled(true);
1147                         break;
1148
1149                 default:
1150                         ret = InsetMathNest::getStatus(cur, cmd, flag);
1151                         break;
1152         }
1153         return ret;
1154 }
1155
1156
1157 void MathMacroTemplate::read(Lexer & lex)
1158 {
1159         MathData ar(buffer_);
1160         mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1161         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1162                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1163                 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1164                 return;
1165         }
1166         operator=( *(ar[0]->asMacroTemplate()) );
1167
1168         updateLook();
1169 }
1170
1171
1172 void MathMacroTemplate::write(ostream & os) const
1173 {
1174         odocstringstream oss;
1175         otexrowstream ots(oss);
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