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