src/mathed/MathMacroTemplate.cpp

   1 /**
   2  * \file MathMacroTemplate.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Stefan Schimanski
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "MathMacroTemplate.h"
  15
  16 #include "DocIterator.h"
  17 #include "LaTeXFeatures.h"
  18 #include "InsetMathBrace.h"
  19 #include "InsetMathChar.h"
  20 #include "InsetMathHull.h"
  21 #include "InsetMathSqrt.h"
  22 #include "MathMacro.h"
  23 #include "MathMacroArgument.h"
  24 #include "MathStream.h"
  25 #include "MathParser.h"
  26 #include "MathSupport.h"
  27 #include "MathMacroArgument.h"
  28
  29 #include "Buffer.h"
  30 #include "BufferView.h"
  31 #include "Color.h"
  32 #include "Cursor.h"
  33 #include "DispatchResult.h"
  34 #include "FuncRequest.h"
  35 #include "FuncStatus.h"
  36 #include "Lexer.h"
  37 #include "LyXRC.h"
  38
  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 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & str)
 430         : InsetMathNest(buf, 3), numargs_(0), optionals_(0),
 431         type_(MacroTypeNewcommand), lookOutdated_(true)
 432 {
 433         buffer_ = buf;
 434         initMath();
 435
 436         MathData ar(buf);
 437         mathed_parse_cell(ar, str, Parse::NORMAL);
 438         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
 439                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
 440                 asArray(from_ascii("invalidmacro"), cell(0));
 441                 // FIXME: The macro template does not make sense after this.
 442                 // The whole parsing should not be in a constructor which
 443                 // has no chance to report failure.
 444                 return;
 445         }
 446         operator=( *(ar[0]->asMacroTemplate()) );
 447
 448         updateLook();
 449 }
 450
 451
 452 Inset * MathMacroTemplate::clone() const
 453 {
 454         MathMacroTemplate * inset = new MathMacroTemplate(*this);
 455         // the parent pointers of the proxy insets above will point to
 456         // to the old template. Hence, the look must be updated.
 457         inset->updateLook();
 458         return inset;
 459 }
 460
 461
 462 docstring MathMacroTemplate::name() const
 463 {
 464         return asString(cell(0));
 465 }
 466
 467
 468 void MathMacroTemplate::updateToContext(MacroContext const & mc)
 469 {
 470         redefinition_ = mc.get(name()) != 0;
 471 }
 472
 473
 474 void MathMacroTemplate::updateLook() const
 475 {
 476         lookOutdated_ = true;
 477 }
 478
 479
 480 void MathMacroTemplate::createLook(int args) const
 481 {
 482         look_.clear();
 483         argsInLook_ = args;
 484
 485         // \foo
 486         look_.push_back(MathAtom(
 487                 new InsetLabelBox(buffer_, _("Name"), *this, false)));
 488         MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
 489         nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
 490
 491         // [#1][#2]
 492         int i = 0;
 493         if (optionals_ > 0) {
 494                 look_.push_back(MathAtom(
 495                         new InsetLabelBox(buffer_, _("optional"), *this, false)));
 496
 497                 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
 498                 for (; i < optionals_; ++i) {
 499                         // color it light grey, if it is to be removed when the cursor leaves
 500                         if (i == argsInLook_) {
 501                                 optData->push_back(MathAtom(
 502                                         new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
 503                                 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
 504                         }
 505
 506                         optData->push_back(MathAtom(new InsetMathChar('[')));
 507                         optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
 508                         optData->push_back(MathAtom(new InsetMathChar(']')));
 509                 }
 510         }
 511
 512         // {#3}{#4}
 513         for (; i < numargs_; ++i) {
 514                 MathData arg;
 515                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 516                 if (i >= argsInLook_) {
 517                         look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 518                                 Color_mathbg, Color_mathmacrooldarg,
 519                                 MathAtom(new InsetMathBrace(arg)))));
 520                 } else
 521                         look_.push_back(MathAtom(new InsetMathBrace(arg)));
 522         }
 523         for (; i < argsInLook_; ++i) {
 524                 MathData arg;
 525                 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
 526                 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
 527                         Color_mathbg, Color_mathmacronewarg,
 528                         MathAtom(new InsetMathBrace(arg)))));
 529         }
 530
 531         // :=
 532         look_.push_back(MathAtom(new InsetMathChar(':')));
 533         look_.push_back(MathAtom(new InsetMathChar('=')));
 534
 535         // definition
 536         look_.push_back(MathAtom(
 537                 new InsetLabelBox(buffer_, MathAtom(
 538                         new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this,        true)));
 539
 540         // display
 541         look_.push_back(MathAtom(
 542                 new DisplayLabelBox(buffer_, MathAtom(
 543                         new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
 544 }
 545
 546
 547 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 548 {
 549         FontSetChanger dummy1(mi.base, from_ascii("mathnormal"));
 550         StyleChanger dummy2(mi.base, LM_ST_TEXT);
 551
 552         // valid macro?
 553         MacroData const * macro = 0;
 554         if (validName())
 555                 macro = mi.macrocontext.get(name());
 556
 557         // update look?
 558         int argsInDef = maxArgumentInDefinition();
 559         if (lookOutdated_ || argsInDef != argsInLook_) {
 560                 lookOutdated_ = false;
 561                 createLook(argsInDef);
 562         }
 563
 564         /// metrics for inset contents
 565         if (macro)
 566                 macro->lock();
 567
 568         // first phase, premetric:
 569         premetrics_ = true;
 570         look_.metrics(mi, dim);
 571         labelBoxAscent_ = dim.asc;
 572         labelBoxDescent_ = dim.des;
 573
 574         // second phase, main metric:
 575         premetrics_ = false;
 576         look_.metrics(mi, dim);
 577
 578         if (macro)
 579                 macro->unlock();
 580
 581         dim.wid += 6;
 582         dim.des += 2;
 583         dim.asc += 2;
 584
 585         setDimCache(mi, dim);
 586 }
 587
 588
 589 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 590 {
 591         ColorChanger dummy0(pi.base.font, Color_math);
 592         FontSetChanger dummy1(pi.base, from_ascii("mathnormal"));
 593         StyleChanger dummy2(pi.base, LM_ST_TEXT);
 594
 595         setPosCache(pi, x, y);
 596         Dimension const dim = dimension(*pi.base.bv);
 597
 598         // draw outer frame
 599         int const a = y - dim.asc + 1;
 600         int const w = dim.wid - 2;
 601         int const h = dim.height() - 2;
 602         pi.pain.rectangle(x, a, w, h, Color_mathframe);
 603
 604         // just to be sure: set some dummy values for coord cache
 605         for (idx_type i = 0; i < nargs(); ++i)
 606                 cell(i).setXY(*pi.base.bv, x, y);
 607
 608         // draw contents
 609         look_.draw(pi, x + 3, y);
 610 }
 611
 612
 613 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
 614 {
 615         updateLook();
 616         cur.screenUpdateFlags(Update::SinglePar);
 617         InsetMathNest::edit(cur, front, entry_from);
 618 }
 619
 620
 621 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 622 {
 623         commitEditChanges(cur, old);
 624         updateLook();
 625         cur.screenUpdateFlags(Update::Force);
 626         return InsetMathNest::notifyCursorLeaves(old, cur);
 627 }
 628
 629
 630 void MathMacroTemplate::removeArguments(Cursor & cur,
 631         DocIterator const & /*inset_pos*/, int from, int to)
 632 {
 633         DocIterator it = doc_iterator_begin(&buffer(), this);
 634         for (; it; it.forwardChar()) {
 635                 if (!it.nextInset())
 636                         continue;
 637                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 638                         continue;
 639                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 640                 int n = arg->number() - 1;
 641                 if (from <= n && n <= to) {
 642                         int cellSlice = cur.find(it.cell());
 643                         if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
 644                                 --cur[cellSlice].pos();
 645
 646                         it.cell().erase(it.pos());
 647                 }
 648         }
 649
 650         updateLook();
 651 }
 652
 653
 654 void MathMacroTemplate::shiftArguments(size_t from, int by)
 655 {
 656         for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
 657                 if (!it.nextInset())
 658                         continue;
 659                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 660                         continue;
 661                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 662                 if (arg->number() >= int(from) + 1)
 663                         arg->setNumber(arg->number() + by);
 664         }
 665
 666         updateLook();
 667 }
 668
 669
 670 int MathMacroTemplate::maxArgumentInDefinition() const
 671 {
 672         // We don't have a buffer when pasting from the clipboard (bug 6014).
 673         Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
 674         int maxArg = 0;
 675         DocIterator it = doc_iterator_begin(macro_buffer, this);
 676         it.idx() = defIdx();
 677         for (; it; it.forwardChar()) {
 678                 if (!it.nextInset())
 679                         continue;
 680                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 681                         continue;
 682                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 683                 maxArg = std::max(int(arg->number()), maxArg);
 684         }
 685         return maxArg;
 686 }
 687
 688
 689 void MathMacroTemplate::insertMissingArguments(int maxArg)
 690 {
 691         bool found[9] = { false, false, false, false, false, false, false, false, false };
 692         idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
 693
 694         // search for #n macros arguments
 695         DocIterator it = doc_iterator_begin(&buffer(), this);
 696         it.idx() = idx;
 697         for (; it && it[0].idx() == idx; it.forwardChar()) {
 698                 if (!it.nextInset())
 699                         continue;
 700                 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
 701                         continue;
 702                 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
 703                 found[arg->number() - 1] = true;
 704         }
 705
 706         // add missing ones
 707         for (int i = 0; i < maxArg; ++i) {
 708                 if (found[i])
 709                         continue;
 710
 711                 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
 712         }
 713 }
 714
 715
 716 void MathMacroTemplate::changeArity(Cursor & cur,
 717         DocIterator const & inset_pos, int newNumArg)
 718 {
 719         // remove parameter which do not appear anymore in the definition
 720         for (int i = numargs_; i > newNumArg; --i)
 721                 removeParameter(cur, inset_pos, numargs_ - 1, true);
 722
 723         // add missing parameter
 724         for (int i = numargs_; i < newNumArg; ++i)
 725                 insertParameter(cur, inset_pos, numargs_, true, false);
 726 }
 727
 728
 729 ///
 730 class AddRemoveMacroInstanceFix
 731 {
 732 public:
 733         ///
 734         AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
 735         ///
 736         void operator()(MathMacro * macro)
 737         {
 738                 if (macro->folded()) {
 739                         if (insert_)
 740                                 macro->insertArgument(n_);
 741                         else
 742                                 macro->removeArgument(n_);
 743                 }
 744         }
 745
 746 private:
 747         ///
 748         int n_;
 749         ///
 750         bool insert_;
 751 };
 752
 753
 754 ///
 755 class OptionalsMacroInstanceFix
 756 {
 757 public:
 758         ///
 759         OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
 760         ///
 761         void operator()(MathMacro * macro)
 762         {
 763                 macro->setOptionals(optionals_);
 764         }
 765
 766 private:
 767         ///
 768         int optionals_;
 769 };
 770
 771
 772 ///
 773 class NullMacroInstanceFix
 774 {
 775 public:
 776         ///
 777         void operator()(MathMacro * ) {}
 778 };
 779
 780
 781 template<class F>
 782 void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
 783         docstring const & name, F & fix)
 784 {
 785         // goto position behind macro template
 786         DocIterator dit = inset_pos;
 787         dit.pop_back();
 788         dit.top().forwardPos();
 789
 790         // remember hull to trigger preview reload
 791         DocIterator hull(dit.buffer());
 792         bool preview_reload_needed = false;
 793         set<DocIterator> preview_hulls;
 794
 795         // iterate over all positions until macro is redefined
 796         for (; dit; dit.forwardPos()) {
 797                 // left the outer hull?
 798                 if (!hull.empty() && dit.depth() == hull.depth()) {
 799                         // schedule reload of the preview if necessary
 800                         if (preview_reload_needed) {
 801                                 preview_hulls.insert(hull);
 802                                 preview_reload_needed = false;
 803                         }
 804                         hull.clear();
 805                 }
 806
 807                 // only until a macro is redefined
 808                 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
 809                         MathMacroTemplate const & macroTemplate
 810                         = static_cast<MathMacroTemplate const &>(dit.inset());
 811                         if (macroTemplate.name() == name)
 812                                 break;
 813                 }
 814
 815                 // in front of macro instance?
 816                 Inset * inset = dit.nextInset();
 817                 if (!inset)
 818                         continue;
 819                 InsetMath * insetMath = inset->asInsetMath();
 820                 if (!insetMath)
 821                         continue;
 822
 823                 // in front of outer hull?
 824                 InsetMathHull * inset_hull = insetMath->asHullInset();
 825                 if (inset_hull && hull.empty()) {
 826                         // remember this for later preview reload
 827                         hull = dit;
 828                 }
 829
 830                 MathMacro * macro = insetMath->asMacro();
 831                 if (macro && macro->name() == name && macro->folded()) {
 832                         fix(macro);
 833                         if (RenderPreview::status() == LyXRC::PREVIEW_ON)
 834                                 preview_reload_needed = true;
 835                 }
 836         }
 837
 838         if (!preview_hulls.empty()) {
 839                 // reload the scheduled previews
 840                 set<DocIterator>::const_iterator sit = preview_hulls.begin();
 841                 set<DocIterator>::const_iterator end = preview_hulls.end();
 842                 for (; sit != end; ++sit) {
 843                         InsetMathHull * inset_hull =
 844                                 sit->nextInset()->asInsetMath()->asHullInset();
 845                         LBUFERR(inset_hull);
 846                         inset_hull->reloadPreview(*sit);
 847                 }
 848                 cur.screenUpdateFlags(Update::Force);
 849         }
 850 }
 851
 852
 853 void MathMacroTemplate::commitEditChanges(Cursor & cur,
 854         DocIterator const & inset_pos)
 855 {
 856         int args_in_def = maxArgumentInDefinition();
 857         if (args_in_def != numargs_) {
 858                 cur.recordUndoFullDocument();
 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                         cur.recordUndoFullDocument();
 992                         size_t pos = numargs_;
 993                         if (!arg.empty())
 994                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
 995                         insertParameter(cur, cur, pos);
 996                 }
 997                 break;
 998
 999
1000         case LFUN_MATH_MACRO_REMOVE_PARAM:
1001                 if (numargs_ > 0) {
1002                         commitEditChanges(cur, cur);
1003                         cur.recordUndoFullDocument();
1004                         size_t pos = numargs_ - 1;
1005                         if (!arg.empty())
1006                                 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1007                         removeParameter(cur, cur, pos);
1008                 }
1009                 break;
1010
1011         case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1012                 if (numargs_ < 9) {
1013                         commitEditChanges(cur, cur);
1014                         cur.recordUndoFullDocument();
1015                         insertParameter(cur, cur, numargs_, true);
1016                 }
1017                 break;
1018
1019         case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1020                 if (numargs_ > 0) {
1021                         commitEditChanges(cur, cur);
1022                         cur.recordUndoFullDocument();
1023                         removeParameter(cur, cur, numargs_ - 1, true);
1024                 }
1025                 break;
1026
1027         case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1028                 commitEditChanges(cur, cur);
1029                 cur.recordUndoFullDocument();
1030                 makeOptional(cur, cur);
1031                 break;
1032
1033         case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1034                 commitEditChanges(cur, cur);
1035                 cur.recordUndoFullDocument();
1036                 makeNonOptional(cur, cur);
1037                 break;
1038
1039         case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1040                 if (numargs_ < 9) {
1041                         commitEditChanges(cur, cur);
1042                         cur.recordUndoFullDocument();
1043                         insertParameter(cur, cur, optionals_);
1044                         makeOptional(cur, cur);
1045                 }
1046                 break;
1047
1048         case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1049                 if (optionals_ > 0) {
1050                         commitEditChanges(cur, cur);
1051                         cur.recordUndoFullDocument();
1052                         removeParameter(cur, cur, optionals_ - 1);
1053                 } break;
1054
1055         case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1056                 if (numargs_ == optionals_) {
1057                         commitEditChanges(cur, cur);
1058                         cur.recordUndoFullDocument();
1059                         insertParameter(cur, cur, 0, true);
1060                         makeOptional(cur, cur);
1061                 }
1062                 break;
1063
1064         default:
1065                 InsetMathNest::doDispatch(cur, cmd);
1066                 break;
1067         }
1068 }
1069
1070
1071 bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
1072         FuncStatus & flag) const
1073 {
1074         bool ret = true;
1075         string const arg = to_utf8(cmd.argument());
1076         switch (cmd.action()) {
1077                 case LFUN_MATH_MACRO_ADD_PARAM: {
1078                         int num = numargs_ + 1;
1079                         if (!arg.empty())
1080                                 num = convert<int>(arg);
1081                         bool on = (num >= optionals_
1082                                    && numargs_ < 9 && num <= numargs_ + 1);
1083                         flag.setEnabled(on);
1084                         break;
1085                 }
1086
1087                 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1088                         flag.setEnabled(numargs_ < 9);
1089                         break;
1090
1091                 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1092                 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1093                         int num = numargs_;
1094                         if (!arg.empty())
1095                                 num = convert<int>(arg);
1096                         flag.setEnabled(num >= 1 && num <= numargs_);
1097                         break;
1098                 }
1099
1100                 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1101                         flag.setEnabled(numargs_ > 0
1102                                      && optionals_ < numargs_
1103                                      && type_ != MacroTypeDef);
1104                         break;
1105
1106                 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1107                         flag.setEnabled(optionals_ > 0
1108                                      && type_ != MacroTypeDef);
1109                         break;
1110
1111                 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1112                         flag.setEnabled(numargs_ < 9);
1113                         break;
1114
1115                 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1116                         flag.setEnabled(optionals_ > 0);
1117                         break;
1118
1119                 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1120                         flag.setEnabled(numargs_ == 0
1121                                      && type_ != MacroTypeDef);
1122                         break;
1123
1124                 case LFUN_IN_MATHMACROTEMPLATE:
1125                         flag.setEnabled(true);
1126                         break;
1127
1128                 default:
1129                         ret = false;
1130                         break;
1131         }
1132         return ret;
1133 }
1134
1135
1136 void MathMacroTemplate::read(Lexer & lex)
1137 {
1138         MathData ar(buffer_);
1139         mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1140         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1141                 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1142                 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1143                 return;
1144         }
1145         operator=( *(ar[0]->asMacroTemplate()) );
1146
1147         updateLook();
1148 }
1149
1150
1151 void MathMacroTemplate::write(ostream & os) const
1152 {
1153         odocstringstream oss;
1154         WriteStream wi(oss, false, false, WriteStream::wsDefault);
1155         oss << "FormulaMacro\n";
1156         write(wi);
1157         os << to_utf8(oss.str());
1158 }
1159
1160
1161 void MathMacroTemplate::write(WriteStream & os) const
1162 {
1163         write(os, false);
1164 }
1165
1166
1167 int MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
1168 {
1169         int num_lines = 0;
1170
1171         if (os.latex()) {
1172                 if (optionals_ > 0) {
1173                         // macros with optionals use the xargs package, e.g.:
1174                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1175                         // \long is implicit by xargs
1176                         if (redefinition_ && !overwriteRedefinition)
1177                                 os << "\\renewcommandx";
1178                         else
1179                                 os << "\\newcommandx";
1180
1181                         os << "\\" << name()
1182                            << "[" << numargs_ << "]"
1183                            << "[usedefault, addprefix=\\global";
1184                         for (int i = 0; i < optionals_; ++i) {
1185                                 docstring optValue = asString(cell(optIdx(i)));
1186                                 if (optValue.find(']') != docstring::npos
1187                                     || optValue.find(',') != docstring::npos)
1188                                         os << ", " << i + 1 << "="
1189                                         << "{" << cell(optIdx(i)) << "}";
1190                                 else
1191                                         os << ", " << i + 1 << "="
1192                                         << cell(optIdx(i));
1193                         }
1194                         os << "]";
1195                 } else {
1196                         // Macros without optionals use standard _global_ \def macros:
1197                         //   \global\def\long\foo#1#2{#1,#2}
1198                         // We use the \long prefix as this is the equivalent to \newcommand.
1199                         // We cannot use \newcommand directly because \global does not work with it.
1200                         os << "\\global\\long\\def\\" << name();
1201                         docstring param = from_ascii("#0");
1202                         for (int i = 1; i <= numargs_; ++i) {
1203                                 param[1] = '0' + i;
1204                                 os << param;
1205                         }
1206                 }
1207         } else {
1208                 // in LyX output we use some pseudo syntax which is implementation
1209                 // independent, e.g.
1210                 // \newcommand{\foo}[2][default]{#1,#2}
1211                 if (redefinition_ && !overwriteRedefinition)
1212                         os << "\\renewcommand";
1213                 else
1214                         os << "\\newcommand";
1215                 os << "{\\" << name() << '}';
1216                 if (numargs_ > 0)
1217                         os << '[' << numargs_ << ']';
1218
1219                 for (int i = 0; i < optionals_; ++i) {
1220                         docstring optValue = asString(cell(optIdx(i)));
1221                         if (optValue.find(']') != docstring::npos)
1222                                 os << "[{" << cell(optIdx(i)) << "}]";
1223                         else
1224                                 os << "[" << cell(optIdx(i)) << "]";
1225                 }
1226         }
1227
1228         os << "{" << cell(defIdx()) << "}";
1229
1230         if (os.latex()) {
1231                 // writing .tex. done.
1232                 os << "\n";
1233                 ++num_lines;
1234         } else {
1235                 // writing .lyx, write special .tex export only if necessary
1236                 if (!cell(displayIdx()).empty()) {
1237                         os << "\n{" << cell(displayIdx()) << '}';
1238                         ++num_lines;
1239                 }
1240         }
1241
1242         return num_lines;
1243 }
1244
1245
1246 docstring MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
1247 {
1248         return docstring();
1249 }
1250
1251 int MathMacroTemplate::plaintext(odocstringstream & os,
1252                                  OutputParams const &, size_t) const
1253 {
1254         static docstring const str = '[' + buffer().B_("math macro") + ']';
1255
1256         os << str;
1257         return str.size();
1258 }
1259
1260
1261 bool MathMacroTemplate::validName() const
1262 {
1263         docstring n = name();
1264
1265         if (n.empty())
1266                 return false;
1267
1268         // converting back and force doesn't swallow anything?
1269         /*MathData ma;
1270         asArray(n, ma);
1271         if (asString(ma) != n)
1272                 return false;*/
1273
1274         // valid characters?
1275         for (size_t i = 0; i < n.size(); ++i) {
1276                 if (!(n[i] >= 'a' && n[i] <= 'z')
1277                     && !(n[i] >= 'A' && n[i] <= 'Z')
1278                     && n[i] != '*')
1279                         return false;
1280         }
1281
1282         return true;
1283 }
1284
1285
1286 bool MathMacroTemplate::validMacro() const
1287 {
1288         return validName();
1289 }
1290
1291
1292 bool MathMacroTemplate::fixNameAndCheckIfValid()
1293 {
1294         // check all the characters/insets in the name cell
1295         size_t i = 0;
1296         MathData & data = cell(0);
1297         while (i < data.size()) {
1298                 InsetMathChar const * cinset = data[i]->asCharInset();
1299                 if (cinset) {
1300                         // valid character in [a-zA-Z]?
1301                         char_type c = cinset->getChar();
1302                         if ((c >= 'a' && c <= 'z')
1303                             || (c >= 'A' && c <= 'Z')) {
1304                                 ++i;
1305                                 continue;
1306                         }
1307                 }
1308
1309                 // throw cell away
1310                 data.erase(i);
1311         }
1312
1313         // now it should be valid if anything in the name survived
1314         return !data.empty();
1315 }
1316
1317
1318 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1319 {
1320         // we need global optional macro arguments. They are not available
1321         // with \def, and \newcommand does not support global macros. So we
1322         // are bound to xargs also for the single-optional-parameter case.
1323         if (optionals_ > 0)
1324                 features.require("xargs");
1325 }
1326
1327 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1328 {
1329         defaults.resize(numargs_);
1330         for (int i = 0; i < optionals_; ++i)
1331                 defaults[i] = asString(cell(optIdx(i)));
1332 }
1333
1334
1335 docstring MathMacroTemplate::definition() const
1336 {
1337         return asString(cell(defIdx()));
1338 }
1339
1340
1341 docstring MathMacroTemplate::displayDefinition() const
1342 {
1343         return asString(cell(displayIdx()));
1344 }
1345
1346
1347 size_t MathMacroTemplate::numArgs() const
1348 {
1349         return numargs_;
1350 }
1351
1352
1353 size_t MathMacroTemplate::numOptionals() const
1354 {
1355         return optionals_;
1356 }
1357
1358
1359 void MathMacroTemplate::infoize(odocstream & os) const
1360 {
1361         os << "Math Macro: \\" << name();
1362 }
1363
1364
1365 string MathMacroTemplate::contextMenuName() const
1366 {
1367         return "context-math-macro-definition";
1368 }
1369
1370 } // namespace lyx