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
 583
 584 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 585 {
 586         // FIXME: Calling Changer on the same object repeatedly is inefficient.
 587         Changer dummy0 = pi.base.font.changeColor(Color_math);
 588         Changer dummy1 = pi.base.changeFontSet("mathnormal");
 589         Changer dummy2 = pi.base.font.changeStyle(LM_ST_TEXT);
 590
 591         Dimension const dim = dimension(*pi.base.bv);
 592
 593         // draw outer frame
 594         int const a = y - dim.asc + 1;
 595         int const w = dim.wid - 2;
 596         int const h = dim.height() - 2;
 597         pi.pain.rectangle(x + 1, a, w, h, Color_mathframe);
 598
 599         // just to be sure: set some dummy values for coord cache
 600         for (idx_type i = 0; i < nargs(); ++i)
 601                 cell(i).setXY(*pi.base.bv, x, y);
 602
 603         // draw contents
 604         look_.draw(pi, x + 3, y);
 605 }
 606
 607
 608 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
 609 {
 610         updateLook();
 611         cur.screenUpdateFlags(Update::SinglePar);
 612         InsetMathNest::edit(cur, front, entry_from);
 613 }
 614
 615
 616 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 617 {
 618         unsigned int const nargs_before = nargs();
 619         commitEditChanges(cur, old);
 620         updateLook();
 621         cur.screenUpdateFlags(Update::Force);
 622         // If we have removed a cell, we might have invalidated the cursor
 623         return InsetMathNest::notifyCursorLeaves(old, cur)
 624                 || nargs() < nargs_before;
 625 }
 626
 627
 628 void MathMacroTemplate::removeArguments(Cursor & cur,
 629         DocIterator const & /*inset_pos*/, int from, int to)
 630 {
 631         DocIterator it = doc_iterator_begin(&buffer(), this);
 632         for (; it; it.forwardChar()) {
 633                 if (!it.nextInset())
 634                         continue;
 635                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 636                         continue;
 637                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 638                 int n = arg->number() - 1;
 639                 if (from <= n && n <= to) {
 640                         int cellSlice = cur.find(it.cell());
 641                         if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
 642                                 --cur[cellSlice].pos();
 643
 644                         it.cell().erase(it.pos());
 645                 }
 646         }
 647
 648         updateLook();
 649 }
 650
 651
 652 void MathMacroTemplate::shiftArguments(size_t from, int by)
 653 {
 654         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 655                 if (!it.nextInset())
 656                         continue;
 657                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 658                         continue;
 659                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 660                 if (arg->number() >= int(from) + 1)
 661                         arg->setNumber(arg->number() + by);
 662         }
 663
 664         updateLook();
 665 }
 666
 667
 668 int MathMacroTemplate::maxArgumentInDefinition() const
 669 {
 670         // We don't have a buffer when pasting from the clipboard (bug 6014).
 671         Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
 672         int maxArg = 0;
 673         DocIterator it = doc_iterator_begin(macro_buffer, this);
 674         it.idx() = defIdx();
 675         for (; it; it.forwardChar()) {
 676                 if (!it.nextInset())
 677                         continue;
 678                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 679                         continue;
 680                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 681                 maxArg = std::max(int(arg->number()), maxArg);
 682         }
 683         return maxArg;
 684 }
 685
 686
 687 void MathMacroTemplate::insertMissingArguments(int maxArg)
 688 {
 689         bool found[9] = { false, false, false, false, false, false, false, false, false };
 690         idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
 691
 692         // search for #n macros arguments
 693         DocIterator it = doc_iterator_begin(&buffer(), this);
 694         it.idx() = idx;
 695         for (; it && it[0].idx() == idx; it.forwardChar()) {
 696                 if (!it.nextInset())
 697                         continue;
 698                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 699                         continue;
 700                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 701                 found[arg->number() - 1] = true;
 702         }
 703
 704         // add missing ones
 705         for (int i = 0; i < maxArg; ++i) {
 706                 if (found[i])
 707                         continue;
 708
 709                 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
 710         }
 711 }
 712
 713
 714 void MathMacroTemplate::changeArity(Cursor & cur,
 715         DocIterator const & inset_pos, int newNumArg)
 716 {
 717         // remove parameter which do not appear anymore in the definition
 718         for (int i = numargs_; i > newNumArg; --i)
 719                 removeParameter(cur, inset_pos, numargs_ - 1, true);
 720
 721         // add missing parameter
 722         for (int i = numargs_; i < newNumArg; ++i)
 723                 insertParameter(cur, inset_pos, numargs_, true, false);
 724 }
 725
 726
 727 ///
 728 class AddRemoveMacroInstanceFix
 729 {
 730 public:
 731         ///
 732         AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
 733         ///
 734         void operator()(MathMacro * macro)
 735         {
 736                 if (macro->folded()) {
 737                         if (insert_)
 738                                 macro->insertArgument(n_);
 739                         else
 740                                 macro->removeArgument(n_);
 741                 }
 742         }
 743
 744 private:
 745         ///
 746         int n_;
 747         ///
 748         bool insert_;
 749 };
 750
 751
 752 ///
 753 class OptionalsMacroInstanceFix
 754 {
 755 public:
 756         ///
 757         OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
 758         ///
 759         void operator()(MathMacro * macro)
 760         {
 761                 macro->setOptionals(optionals_);
 762         }
 763
 764 private:
 765         ///
 766         int optionals_;
 767 };
 768
 769
 770 ///
 771 class NullMacroInstanceFix
 772 {
 773 public:
 774         ///
 775         void operator()(MathMacro * ) {}
 776 };
 777
 778
 779 template<class F>
 780 void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
 781         docstring const & name, F & fix)
 782 {
 783         // goto position behind macro template
 784         DocIterator dit = inset_pos;
 785         dit.pop_back();
 786         dit.top().forwardPos();
 787
 788         // remember hull to trigger preview reload
 789         DocIterator hull(dit.buffer());
 790         bool preview_reload_needed = false;
 791         set<DocIterator> preview_hulls;
 792
 793         // iterate over all positions until macro is redefined
 794         for (; dit; dit.forwardPos()) {
 795                 // left the outer hull?
 796                 if (!hull.empty() && dit.depth() == hull.depth()) {
 797                         // schedule reload of the preview if necessary
 798                         if (preview_reload_needed) {
 799                                 preview_hulls.insert(hull);
 800                                 preview_reload_needed = false;
 801                         }
 802                         hull.clear();
 803                 }
 804
 805                 // only until a macro is redefined
 806                 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
 807                         MathMacroTemplate const & macroTemplate
 808                         = static_cast<MathMacroTemplate const &>(dit.inset());
 809                         if (macroTemplate.name() == name)
 810                                 break;
 811                 }
 812
 813                 // in front of macro instance?
 814                 Inset * inset = dit.nextInset();
 815                 if (!inset)
 816                         continue;
 817                 InsetMath * insetMath = inset->asInsetMath();
 818                 if (!insetMath)
 819                         continue;
 820
 821                 // in front of outer hull?
 822                 InsetMathHull * inset_hull = insetMath->asHullInset();
 823                 if (inset_hull && hull.empty()) {
 824                         // remember this for later preview reload
 825                         hull = dit;
 826                 }
 827
 828                 MathMacro * macro = insetMath->asMacro();
 829                 if (macro && macro->name() == name && macro->folded()) {
 830                         fix(macro);
 831                         if (RenderPreview::previewMath())
 832                                 preview_reload_needed = true;
 833                 }
 834         }
 835
 836         if (!preview_hulls.empty()) {
 837                 // reload the scheduled previews
 838                 set<DocIterator>::const_iterator sit = preview_hulls.begin();
 839                 set<DocIterator>::const_iterator end = preview_hulls.end();
 840                 for (; sit != end; ++sit) {
 841                         InsetMathHull * inset_hull =
 842                                 sit->nextInset()->asInsetMath()->asHullInset();
 843                         LBUFERR(inset_hull);
 844                         inset_hull->reloadPreview(*sit);
 845                 }
 846                 cur.screenUpdateFlags(Update::Force);
 847         }
 848 }
 849
 850
 851 void MathMacroTemplate::commitEditChanges(Cursor & cur,
 852         DocIterator const & inset_pos)
 853 {
 854         int args_in_def = maxArgumentInDefinition();
 855         if (args_in_def != numargs_) {
 856                 // FIXME: implement precise undo handling (only a few places
 857                 //   need undo)
 858                 cur.recordUndoFullBuffer();
 859                 changeArity(cur, inset_pos, args_in_def);
 860         }
 861         insertMissingArguments(args_in_def);
 862
 863         // make sure the preview are up to date
 864         NullMacroInstanceFix fix;
 865         fixMacroInstances(cur, inset_pos, name(), fix);
 866 }
 867
 868
 869 void MathMacroTemplate::insertParameter(Cursor & cur,
 870         DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
 871 {
 872         if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
 873                 ++numargs_;
 874
 875                 // append example #n
 876                 if (addarg) {
 877                         shiftArguments(pos, 1);
 878
 879                         cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 880                         if (!cell(displayIdx()).empty())
 881                                 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
 882                 }
 883
 884                 if (!greedy) {
 885                         // fix macro instances
 886                         AddRemoveMacroInstanceFix fix(pos, true);
 887                         fixMacroInstances(cur, inset_pos, name(), fix);
 888                 }
 889         }
 890
 891         updateLook();
 892 }
 893
 894
 895 void MathMacroTemplate::removeParameter(Cursor & cur,
 896         DocIterator const & inset_pos, int pos, bool greedy)
 897 {
 898         if (pos < numargs_ && pos >= 0) {
 899                 --numargs_;
 900                 removeArguments(cur, inset_pos, pos, pos);
 901                 shiftArguments(pos + 1, -1);
 902
 903                 // removed optional parameter?
 904                 if (pos < optionals_) {
 905                         --optionals_;
 906                         optionalValues_[pos] = cell(optIdx(pos));
 907                         cells_.erase(cells_.begin() + optIdx(pos));
 908
 909                         // fix cursor
 910                         int macroSlice = cur.find(this);
 911                         if (macroSlice != -1) {
 912                                 if (cur[macroSlice].idx() == optIdx(pos)) {
 913                                         cur.cutOff(macroSlice);
 914                                         cur[macroSlice].idx() = 1;
 915                                         cur[macroSlice].pos() = 0;
 916                                 } else if (cur[macroSlice].idx() > optIdx(pos))
 917                                         --cur[macroSlice].idx();
 918                         }
 919                 }
 920
 921                 if (!greedy) {
 922                         // fix macro instances
 923                         AddRemoveMacroInstanceFix fix(pos, false);
 924                         fixMacroInstances(cur, inset_pos, name(), fix);
 925                 }
 926         }
 927
 928         updateLook();
 929 }
 930
 931
 932 void MathMacroTemplate::makeOptional(Cursor & cur,
 933         DocIterator const & inset_pos)
 934 {
 935         if (numargs_ > 0 && optionals_ < numargs_) {
 936                 ++optionals_;
 937                 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
 938                 // fix cursor
 939                 int macroSlice = cur.find(this);
 940                 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
 941                         ++cur[macroSlice].idx();
 942
 943                 // fix macro instances
 944                 OptionalsMacroInstanceFix fix(optionals_);
 945                 fixMacroInstances(cur, inset_pos, name(), fix);
 946         }
 947
 948         updateLook();
 949 }
 950
 951
 952 void MathMacroTemplate::makeNonOptional(Cursor & cur,
 953         DocIterator const & inset_pos)
 954 {
 955         if (numargs_ > 0 && optionals_ > 0) {
 956                 --optionals_;
 957
 958                 // store default value for later if the user changes his mind
 959                 optionalValues_[optionals_] = cell(optIdx(optionals_));
 960                 cells_.erase(cells_.begin() + optIdx(optionals_));
 961
 962                 // fix cursor
 963                 int macroSlice = cur.find(this);
 964                 if (macroSlice != -1) {
 965                         if (cur[macroSlice].idx() > optIdx(optionals_))
 966                                 --cur[macroSlice].idx();
 967                         else if (cur[macroSlice].idx() == optIdx(optionals_)) {
 968                                 cur.cutOff(macroSlice);
 969                                 cur[macroSlice].idx() = optIdx(optionals_);
 970                                 cur[macroSlice].pos() = 0;
 971                         }
 972                 }
 973
 974                 // fix macro instances
 975                 OptionalsMacroInstanceFix fix(optionals_);
 976                 fixMacroInstances(cur, inset_pos, name(), fix);
 977         }
 978
 979         updateLook();
 980 }
 981
 982
 983 void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
 984 {
 985         string const arg = to_utf8(cmd.argument());
 986         switch (cmd.action()) {
 987
 988         case LFUN_MATH_MACRO_ADD_PARAM:
 989                 if (numargs_ < 9) {
 990                         commitEditChanges(cur, cur);
 991                         // FIXME: implement precise undo handling (only a few places
 992                         //   need undo)
 993                         cur.recordUndoFullBuffer();
 994                         size_t pos = numargs_;
 995                         if (!arg.empty())
 996                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
 997                         insertParameter(cur, cur, pos);
 998                 }
 999                 break;
1000
1001
1002         case LFUN_MATH_MACRO_REMOVE_PARAM:
1003                 if (numargs_ > 0) {
1004                         commitEditChanges(cur, cur);
1005                         // FIXME: implement precise undo handling (only a few places
1006                         //   need undo)
1007                         cur.recordUndoFullBuffer();
1008                         size_t pos = numargs_ - 1;
1009                         if (!arg.empty())
1010                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1011                         removeParameter(cur, cur, pos);
1012                 }
1013                 break;
1014
1015         case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1016                 if (numargs_ < 9) {
1017                         commitEditChanges(cur, cur);
1018                         // FIXME: implement precise undo handling (only a few places
1019                         //   need undo)
1020                         cur.recordUndoFullBuffer();
1021                         insertParameter(cur, cur, numargs_, true);
1022                 }
1023                 break;
1024
1025         case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1026                 if (numargs_ > 0) {
1027                         commitEditChanges(cur, cur);
1028                         // FIXME: implement precise undo handling (only a few places
1029                         //   need undo)
1030                         cur.recordUndoFullBuffer();
1031                         removeParameter(cur, cur, numargs_ - 1, true);
1032                 }
1033                 break;
1034
1035         case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1036                 commitEditChanges(cur, cur);
1037                 // FIXME: implement precise undo handling (only a few places
1038                 //   need undo)
1039                 cur.recordUndoFullBuffer();
1040                 makeOptional(cur, cur);
1041                 break;
1042
1043         case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1044                 commitEditChanges(cur, cur);
1045                 // FIXME: implement precise undo handling (only a few places
1046                 //   need undo)
1047                 cur.recordUndoFullBuffer();
1048                 makeNonOptional(cur, cur);
1049                 break;
1050
1051         case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1052                 if (numargs_ < 9) {
1053                         commitEditChanges(cur, cur);
1054                         // FIXME: implement precise undo handling (only a few places
1055                         //   need undo)
1056                         cur.recordUndoFullBuffer();
1057                         insertParameter(cur, cur, optionals_);
1058                         makeOptional(cur, cur);
1059                 }
1060                 break;
1061
1062         case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1063                 if (optionals_ > 0) {
1064                         commitEditChanges(cur, cur);
1065                         // FIXME: implement precise undo handling (only a few places
1066                         //   need undo)
1067                         cur.recordUndoFullBuffer();
1068                         removeParameter(cur, cur, optionals_ - 1);
1069                 } break;
1070
1071         case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1072                 if (numargs_ == optionals_) {
1073                         commitEditChanges(cur, cur);
1074                         // FIXME: implement precise undo handling (only a few places
1075                         //   need undo)
1076                         cur.recordUndoFullBuffer();
1077                         insertParameter(cur, cur, 0, true);
1078                         makeOptional(cur, cur);
1079                 }
1080                 break;
1081
1082         default:
1083                 InsetMathNest::doDispatch(cur, cmd);
1084                 break;
1085         }
1086 }
1087
1088
1089 bool MathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
1090         FuncStatus & flag) const
1091 {
1092         bool ret = true;
1093         string const arg = to_utf8(cmd.argument());
1094         switch (cmd.action()) {
1095                 case LFUN_MATH_MACRO_ADD_PARAM: {
1096                         int num = numargs_ + 1;
1097                         if (!arg.empty())
1098                                 num = convert<int>(arg);
1099                         bool on = (num >= optionals_
1100                                    && numargs_ < 9 && num <= numargs_ + 1);
1101                         flag.setEnabled(on);
1102                         break;
1103                 }
1104
1105                 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1106                         flag.setEnabled(numargs_ < 9);
1107                         break;
1108
1109                 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1110                 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1111                         int num = numargs_;
1112                         if (!arg.empty())
1113                                 num = convert<int>(arg);
1114                         flag.setEnabled(num >= 1 && num <= numargs_);
1115                         break;
1116                 }
1117
1118                 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1119                         flag.setEnabled(numargs_ > 0
1120                                      && optionals_ < numargs_
1121                                      && type_ != MacroTypeDef);
1122                         break;
1123
1124                 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1125                         flag.setEnabled(optionals_ > 0
1126                                      && type_ != MacroTypeDef);
1127                         break;
1128
1129                 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1130                         flag.setEnabled(numargs_ < 9);
1131                         break;
1132
1133                 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1134                         flag.setEnabled(optionals_ > 0);
1135                         break;
1136
1137                 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1138                         flag.setEnabled(numargs_ == 0
1139                                      && type_ != MacroTypeDef);
1140                         break;
1141
1142                 case LFUN_IN_MATHMACROTEMPLATE:
1143                         flag.setEnabled(true);
1144                         break;
1145
1146                 default:
1147                         ret = InsetMathNest::getStatus(cur, cmd, flag);
1148                         break;
1149         }
1150         return ret;
1151 }
1152
1153
1154 void MathMacroTemplate::read(Lexer & lex)
1155 {
1156         MathData ar(buffer_);
1157         mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1158         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1159                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1160                 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1161                 return;
1162         }
1163         operator=( *(ar[0]->asMacroTemplate()) );
1164
1165         updateLook();
1166 }
1167
1168
1169 void MathMacroTemplate::write(ostream & os) const
1170 {
1171         odocstringstream oss;
1172         otexrowstream ots(oss);
1173         WriteStream wi(ots, false, false, WriteStream::wsDefault);
1174         oss << "FormulaMacro\n";
1175         write(wi);
1176         os << to_utf8(oss.str());
1177 }
1178
1179
1180 void MathMacroTemplate::write(WriteStream & os) const
1181 {
1182         write(os, false);
1183 }
1184
1185
1186 int MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
1187 {
1188         int num_lines = 0;
1189
1190         if (os.latex()) {
1191                 if (optionals_ > 0) {
1192                         // macros with optionals use the xargs package, e.g.:
1193                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1194                         // \long is implicit by xargs
1195                         if (redefinition_ && !overwriteRedefinition)
1196                                 os << "\\renewcommandx";
1197                         else
1198                                 os << "\\newcommandx";
1199
1200                         os << "\\" << name()
1201                            << "[" << numargs_ << "]"
1202                            << "[usedefault, addprefix=\\global";
1203                         for (int i = 0; i < optionals_; ++i) {
1204                                 docstring optValue = asString(cell(optIdx(i)));
1205                                 if (optValue.find(']') != docstring::npos
1206                                     || optValue.find(',') != docstring::npos)
1207                                         os << ", " << i + 1 << "="
1208                                         << "{" << cell(optIdx(i)) << "}";
1209                                 else
1210                                         os << ", " << i + 1 << "="
1211                                         << cell(optIdx(i));
1212                         }
1213                         os << "]";
1214                 } else {
1215                         // Macros without optionals use standard _global_ \def macros:
1216                         //   \global\def\long\foo#1#2{#1,#2}
1217                         // We use the \long prefix as this is the equivalent to \newcommand.
1218                         // We cannot use \newcommand directly because \global does not work with it.
1219                         os << "\\global\\long\\def\\" << name();
1220                         docstring param = from_ascii("#0");
1221                         for (int i = 1; i <= numargs_; ++i) {
1222                                 param[1] = '0' + i;
1223                                 os << param;
1224                         }
1225                 }
1226         } else {
1227                 // in LyX output we use some pseudo syntax which is implementation
1228                 // independent, e.g.
1229                 // \newcommand{\foo}[2][default]{#1,#2}
1230                 if (redefinition_ && !overwriteRedefinition)
1231                         os << "\\renewcommand";
1232                 else
1233                         os << "\\newcommand";
1234                 os << "{\\" << name() << '}';
1235                 if (numargs_ > 0)
1236                         os << '[' << numargs_ << ']';
1237
1238                 for (int i = 0; i < optionals_; ++i) {
1239                         docstring optValue = asString(cell(optIdx(i)));
1240                         if (optValue.find(']') != docstring::npos)
1241                                 os << "[{" << cell(optIdx(i)) << "}]";
1242                         else
1243                                 os << "[" << cell(optIdx(i)) << "]";
1244                 }
1245         }
1246
1247         os << "{" << cell(defIdx()) << "}";
1248
1249         if (os.latex()) {
1250                 // writing .tex. done.
1251                 os << "\n";
1252                 ++num_lines;
1253         } else {
1254                 // writing .lyx, write special .tex export only if necessary
1255                 if (!cell(displayIdx()).empty()) {
1256                         os << "\n{" << cell(displayIdx()) << '}';
1257                         ++num_lines;
1258                 }
1259         }
1260
1261         return num_lines;
1262 }
1263
1264
1265 docstring MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
1266 {
1267         return docstring();
1268 }
1269
1270 int MathMacroTemplate::plaintext(odocstringstream & os,
1271                                  OutputParams const &, size_t) const
1272 {
1273         docstring const str = '[' + buffer().B_("math macro") + ']';
1274
1275         os << str;
1276         return str.size();
1277 }
1278
1279
1280 bool MathMacroTemplate::validName() const
1281 {
1282         docstring n = name();
1283
1284         if (n.empty())
1285                 return false;
1286
1287         // converting back and force doesn't swallow anything?
1288         /*MathData ma;
1289         asArray(n, ma);
1290         if (asString(ma) != n)
1291                 return false;*/
1292
1293         // valid characters?
1294         for (size_t i = 0; i < n.size(); ++i) {
1295                 if (!(n[i] >= 'a' && n[i] <= 'z')
1296                     && !(n[i] >= 'A' && n[i] <= 'Z')
1297                     && n[i] != '*')
1298                         return false;
1299         }
1300
1301         return true;
1302 }
1303
1304
1305 bool MathMacroTemplate::validMacro() const
1306 {
1307         return validName();
1308 }
1309
1310
1311 bool MathMacroTemplate::fixNameAndCheckIfValid()
1312 {
1313         // check all the characters/insets in the name cell
1314         size_t i = 0;
1315         MathData & data = cell(0);
1316         while (i < data.size()) {
1317                 InsetMathChar const * cinset = data[i]->asCharInset();
1318                 if (cinset) {
1319                         // valid character in [a-zA-Z]?
1320                         char_type c = cinset->getChar();
1321                         if ((c >= 'a' && c <= 'z')
1322                             || (c >= 'A' && c <= 'Z')) {
1323                                 ++i;
1324                                 continue;
1325                         }
1326                 }
1327
1328                 // throw cell away
1329                 data.erase(i);
1330         }
1331
1332         // now it should be valid if anything in the name survived
1333         return !data.empty();
1334 }
1335
1336
1337 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1338 {
1339         // we need global optional macro arguments. They are not available
1340         // with \def, and \newcommand does not support global macros. So we
1341         // are bound to xargs also for the single-optional-parameter case.
1342         if (optionals_ > 0)
1343                 features.require("xargs");
1344 }
1345
1346 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1347 {
1348         defaults.resize(numargs_);
1349         for (int i = 0; i < optionals_; ++i)
1350                 defaults[i] = asString(cell(optIdx(i)));
1351 }
1352
1353
1354 docstring MathMacroTemplate::definition() const
1355 {
1356         return asString(cell(defIdx()));
1357 }
1358
1359
1360 docstring MathMacroTemplate::displayDefinition() const
1361 {
1362         return asString(cell(displayIdx()));
1363 }
1364
1365
1366 size_t MathMacroTemplate::numArgs() const
1367 {
1368         return numargs_;
1369 }
1370
1371
1372 size_t MathMacroTemplate::numOptionals() const
1373 {
1374         return optionals_;
1375 }
1376
1377
1378 void MathMacroTemplate::infoize(odocstream & os) const
1379 {
1380         os << bformat(_("Math Macro: \\%1$s"), name());
1381 }
1382
1383
1384 string MathMacroTemplate::contextMenuName() const
1385 {
1386         return "context-math-macro-definition";
1387 }
1388
1389 void MathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
1390                                                                  UpdateType) const
1391 {
1392         docstring str;
1393         if (!validMacro())
1394                 str = bformat(_("Invalid macro! \\%1$s"), name());
1395         else
1396                 str = "\\" + name();
1397         TocBuilder & b = buffer().tocBackend().builder("math-macro");
1398         b.pushItem(pit, str, output_active);
1399         b.pop();
1400 }
1401
1402
1403 } // namespace lyx