src/mathed/MathMacroTemplate.cpp

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