src/mathed/MathMacro.cpp

   1 /**
   2  * \file MathMacro.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author André Pönitz
   8  * \author Stefan Schimanski
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "MathMacro.h"
  16
  17 #include "InsetMathChar.h"
  18 #include "MathCompletionList.h"
  19 #include "MathExtern.h"
  20 #include "MathFactory.h"
  21 #include "MathStream.h"
  22 #include "MathSupport.h"
  23
  24 #include "Buffer.h"
  25 #include "BufferView.h"
  26 #include "CoordCache.h"
  27 #include "Cursor.h"
  28 #include "FuncStatus.h"
  29 #include "FuncRequest.h"
  30 #include "LaTeXFeatures.h"
  31 #include "LyX.h"
  32 #include "LyXRC.h"
  33 #include "MetricsInfo.h"
  34
  35 #include "frontends/Painter.h"
  36
  37 #include "support/debug.h"
  38 #include "support/gettext.h"
  39 #include "support/lassert.h"
  40 #include "support/lstrings.h"
  41 #include "support/RefChanger.h"
  42 #include "support/textutils.h"
  43
  44 #include <ostream>
  45 #include <vector>
  46
  47 using namespace lyx::support;
  48 using namespace std;
  49
  50 namespace lyx {
  51
  52
  53 /// A proxy for the macro values
  54 class ArgumentProxy : public InsetMath {
  55 public:
  56         ///
  57         ArgumentProxy(MathMacro * mathMacro, size_t idx)
  58                 : mathMacro_(mathMacro), idx_(idx) {}
  59         ///
  60         ArgumentProxy(MathMacro * mathMacro, size_t idx, docstring const & def)
  61                 : mathMacro_(mathMacro), idx_(idx)
  62         {
  63                         asArray(def, def_);
  64         }
  65         ///
  66         void setOwner(MathMacro * mathMacro) { mathMacro_ = mathMacro; }
  67         ///
  68         MathMacro const * owner() { return mathMacro_; }
  69         ///
  70         marker_type marker() const { return NO_MARKER; }
  71         ///
  72         InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
  73         /// The math data to use for display
  74         MathData const & displayCell(BufferView const * bv) const
  75         {
  76                 // handle default macro arguments
  77                 bool use_def_arg = !mathMacro_->editMetrics(bv)
  78                         && mathMacro_->cell(idx_).empty();
  79                 return use_def_arg ? def_ : mathMacro_->cell(idx_);
  80         }
  81         ///
  82         bool addToMathRow(MathRow & mrow, MetricsInfo & mi) const
  83         {
  84                 // macro arguments are in macros
  85                 LATTEST(mathMacro_->nesting() > 0);
  86                 /// The macro nesting can change display of insets. Change it locally.
  87                 Changer chg = make_change(mi.base.macro_nesting,
  88                                           mathMacro_->nesting() == 1 ? 0 : mathMacro_->nesting());
  89
  90                 MathRow::Element e_beg(mi, MathRow::BEGIN);
  91                 e_beg.inset = this;
  92                 e_beg.ar = &mathMacro_->cell(idx_);
  93                 mrow.push_back(e_beg);
  94
  95                 mathMacro_->macro()->unlock();
  96                 bool has_contents = displayCell(mi.base.bv).addToMathRow(mrow, mi);
  97                 mathMacro_->macro()->lock();
  98
  99                 // if there was no contents, and the contents is editable,
 100                 // then we insert a box instead.
 101                 if (!has_contents && mathMacro_->nesting() == 1) {
 102                         // mathclass is ord because it should be spaced as a normal atom
 103                         MathRow::Element e(mi, MathRow::BOX, MC_ORD);
 104                         e.color = Color_mathline;
 105                         mrow.push_back(e);
 106                         has_contents = true;
 107                 }
 108
 109                 MathRow::Element e_end(mi, MathRow::END);
 110                 e_end.inset = this;
 111                 e_end.ar = &mathMacro_->cell(idx_);
 112                 mrow.push_back(e_end);
 113
 114                 return has_contents;
 115         }
 116         ///
 117         void beforeMetrics() const
 118         {
 119                 mathMacro_->macro()->unlock();
 120         }
 121         ///
 122         void afterMetrics() const
 123         {
 124                 mathMacro_->macro()->lock();
 125         }
 126         ///
 127         void beforeDraw(PainterInfo const & pi) const
 128         {
 129                 // if the macro is being edited, then the painter is in
 130                 // monochrome mode.
 131                 if (mathMacro_->editMetrics(pi.base.bv))
 132                         pi.pain.leaveMonochromeMode();
 133         }
 134         ///
 135         void afterDraw(PainterInfo const & pi) const
 136         {
 137                 if (mathMacro_->editMetrics(pi.base.bv))
 138                         pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
 139         }
 140         ///
 141         void metrics(MetricsInfo &, Dimension &) const {
 142                 // This should never be invoked, since ArgumentProxy insets are linearized
 143                 LATTEST(false);
 144         }
 145         ///
 146         void draw(PainterInfo &, int, int) const {
 147                 // This should never be invoked, since ArgumentProxy insets are linearized
 148                 LATTEST(false);
 149         }
 150         ///
 151         int kerning(BufferView const * bv) const
 152         {
 153                 return displayCell(bv).kerning(bv);
 154         }
 155         // write(), normalize(), infoize() and infoize2() are not needed since
 156         // MathMacro uses the definition and not the expanded cells.
 157         ///
 158         void maple(MapleStream & ms) const { ms << mathMacro_->cell(idx_); }
 159         ///
 160         void maxima(MaximaStream & ms) const { ms << mathMacro_->cell(idx_); }
 161         ///
 162         void mathematica(MathematicaStream & ms) const { ms << mathMacro_->cell(idx_); }
 163         ///
 164         void mathmlize(MathStream & ms) const { ms << mathMacro_->cell(idx_); }
 165         ///
 166         void htmlize(HtmlStream & ms) const { ms << mathMacro_->cell(idx_); }
 167         ///
 168         void octave(OctaveStream & os) const { os << mathMacro_->cell(idx_); }
 169         ///
 170         MathClass mathClass() const
 171         {
 172                 return MC_UNKNOWN;
 173                 // This can be refined once the pointer issues are fixed. I did not
 174                 // notice any immediate crash with the following code, but it is risky
 175                 // nevertheless:
 176                 //return mathMacro_->cell(idx_).mathClass();
 177         }
 178
 179 private:
 180         ///
 181         Inset * clone() const
 182         {
 183                 return new ArgumentProxy(*this);
 184         }
 185         ///
 186         MathMacro * mathMacro_;
 187         ///
 188         size_t idx_;
 189         ///
 190         MathData def_;
 191 };
 192
 193
 194 /// Private implementation of MathMacro
 195 class MathMacro::Private {
 196 public:
 197         Private(Buffer * buf, docstring const & name)
 198                 : name_(name), displayMode_(DISPLAY_INIT),
 199                   expanded_(buf), definition_(buf), attachedArgsNum_(0),
 200                   optionals_(0), nextFoldMode_(true), macroBackup_(buf),
 201                   macro_(0), needsUpdate_(false), isUpdating_(false),
 202                   appetite_(9), nesting_(0)
 203         {
 204         }
 205         /// Update the pointers to our owner of all expanded macros.
 206         /// This needs to be called every time a copy of the owner is created
 207         /// (bug 9418).
 208         void updateChildren(MathMacro * owner);
 209         /// Recursively update the pointers of all expanded macros
 210         /// appearing in the arguments of the current macro
 211         void updateNestedChildren(MathMacro * owner, InsetMathNest * ni);
 212         /// name of macro
 213         docstring name_;
 214         /// current display mode
 215         DisplayMode displayMode_;
 216         /// expanded macro with ArgumentProxies
 217         MathData expanded_;
 218         /// macro definition with #1,#2,.. insets
 219         MathData definition_;
 220         /// number of arguments that were really attached
 221         size_t attachedArgsNum_;
 222         /// optional argument attached? (only in DISPLAY_NORMAL mode)
 223         size_t optionals_;
 224         /// fold mode to be set in next metrics call?
 225         bool nextFoldMode_;
 226         /// if macro_ == true, then here is a copy of the macro
 227         /// don't use it for locking
 228         MacroData macroBackup_;
 229         /// if macroNotFound_ == false, then here is a reference to the macro
 230         /// this might invalidate after metrics was called
 231         MacroData const * macro_;
 232         ///
 233         mutable std::map<BufferView const *, bool> editing_;
 234         ///
 235         std::string requires_;
 236         /// update macro representation
 237         bool needsUpdate_;
 238         ///
 239         bool isUpdating_;
 240         /// maximal number of arguments the macro is greedy for
 241         size_t appetite_;
 242         /// Level of nesting in macros (including this one)
 243         int nesting_;
 244 };
 245
 246
 247 void MathMacro::Private::updateChildren(MathMacro * owner)
 248 {
 249         for (size_t i = 0; i < expanded_.size(); ++i) {
 250                 ArgumentProxy * p = dynamic_cast<ArgumentProxy *>(expanded_[i].nucleus());
 251                 if (p)
 252                         p->setOwner(owner);
 253
 254                 InsetMathNest * ni = expanded_[i].nucleus()->asNestInset();
 255                 if (ni)
 256                         updateNestedChildren(owner, ni);
 257         }
 258
 259         if (macro_) {
 260                 // The macro_ pointer is updated when MathData::metrics() is
 261                 // called. However, when instant preview is on or the macro is
 262                 // not on screen, MathData::metrics() is not called and we may
 263                 // have a dangling pointer. As a safety measure, when a macro
 264                 // is copied, always let macro_ point to the backup copy of the
 265                 // MacroData structure. This backup is updated every time the
 266                 // macro is changed, so it will not become stale.
 267                 macro_ = &macroBackup_;
 268         }
 269 }
 270
 271
 272 void MathMacro::Private::updateNestedChildren(MathMacro * owner, InsetMathNest * ni)
 273 {
 274         for (size_t i = 0; i < ni->nargs(); ++i) {
 275                 MathData & ar = ni->cell(i);
 276                 for (size_t j = 0; j < ar.size(); ++j) {
 277                         ArgumentProxy * ap = dynamic_cast
 278                                 <ArgumentProxy *>(ar[j].nucleus());
 279                         if (ap) {
 280                                 MathMacro::Private * md = ap->owner()->d;
 281                                 if (md->macro_)
 282                                         md->macro_ = &md->macroBackup_;
 283                                 ap->setOwner(owner);
 284                         }
 285                         InsetMathNest * imn = ar[j].nucleus()->asNestInset();
 286                         if (imn)
 287                                 updateNestedChildren(owner, imn);
 288                 }
 289         }
 290 }
 291
 292
 293 MathMacro::MathMacro(Buffer * buf, docstring const & name)
 294         : InsetMathNest(buf, 0), d(new Private(buf, name))
 295 {}
 296
 297
 298 MathMacro::MathMacro(MathMacro const & that)
 299         : InsetMathNest(that), d(new Private(*that.d))
 300 {
 301         setBuffer(*that.buffer_);
 302         d->updateChildren(this);
 303 }
 304
 305
 306 MathMacro & MathMacro::operator=(MathMacro const & that)
 307 {
 308         if (&that == this)
 309                 return *this;
 310         InsetMathNest::operator=(that);
 311         *d = *that.d;
 312         d->updateChildren(this);
 313         return *this;
 314 }
 315
 316
 317 MathMacro::~MathMacro()
 318 {
 319         delete d;
 320 }
 321
 322
 323 bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
 324 {
 325         // set edit mode for which we will have calculated row.
 326         // This is the same as what is done in metrics().
 327         d->editing_[mi.base.bv] = editMode(mi.base.bv);
 328
 329         // For now we do not linearize in the following cases (can be improved)
 330         // - display mode different from normal
 331         // - editing with parameter list
 332         // - editing with box around macro
 333         if (displayMode() != MathMacro::DISPLAY_NORMAL
 334                 || (d->editing_[mi.base.bv] && lyxrc.macro_edit_style != LyXRC::MACRO_EDIT_INLINE))
 335                 return InsetMath::addToMathRow(mrow, mi);
 336
 337         /// The macro nesting can change display of insets. Change it locally.
 338         Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
 339
 340         MathRow::Element e_beg(mi, MathRow::BEGIN);
 341         e_beg.inset = this;
 342         e_beg.marker = (d->nesting_ == 1 && nargs()) ? marker() : NO_MARKER;
 343         mrow.push_back(e_beg);
 344
 345         d->macro_->lock();
 346         bool has_contents = d->expanded_.addToMathRow(mrow, mi);
 347         d->macro_->unlock();
 348
 349         // if there was no contents and the array is editable, then we
 350         // insert a grey box instead.
 351         if (!has_contents && mi.base.macro_nesting == 1) {
 352                 // mathclass is unknown because it is irrelevant for spacing
 353                 MathRow::Element e(mi, MathRow::BOX);
 354                 e.color = Color_mathmacroblend;
 355                 mrow.push_back(e);
 356                 has_contents = true;
 357         }
 358
 359         MathRow::Element e_end(mi, MathRow::END);
 360         e_end.inset = this;
 361         mrow.push_back(e_end);
 362
 363         return has_contents;
 364 }
 365
 366 void MathMacro::beforeMetrics() const
 367 {
 368         d->macro_->lock();
 369 }
 370
 371
 372 void MathMacro::afterMetrics() const
 373 {
 374         d->macro_->unlock();
 375 }
 376
 377
 378 void MathMacro::beforeDraw(PainterInfo const & pi) const
 379 {
 380         if (d->editing_[pi.base.bv])
 381                 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
 382 }
 383
 384
 385 void MathMacro::afterDraw(PainterInfo const & pi) const
 386 {
 387         if (d->editing_[pi.base.bv])
 388                 pi.pain.leaveMonochromeMode();
 389 }
 390
 391
 392 Inset * MathMacro::clone() const
 393 {
 394         MathMacro * copy = new MathMacro(*this);
 395         copy->d->needsUpdate_ = true;
 396         //copy->d->expanded_.clear();
 397         return copy;
 398 }
 399
 400
 401 void MathMacro::normalize(NormalStream & os) const
 402 {
 403         os << "[macro " << name();
 404         for (size_t i = 0; i < nargs(); ++i)
 405                 os << ' ' << cell(i);
 406         os << ']';
 407 }
 408
 409
 410 MathMacro::DisplayMode MathMacro::displayMode() const
 411 {
 412         return d->displayMode_;
 413 }
 414
 415
 416 bool MathMacro::extraBraces() const
 417 {
 418         return d->displayMode_ == DISPLAY_NORMAL && arity() > 0;
 419 }
 420
 421
 422 docstring MathMacro::name() const
 423 {
 424         if (d->displayMode_ == DISPLAY_UNFOLDED)
 425                 return asString(cell(0));
 426
 427         return d->name_;
 428 }
 429
 430
 431 docstring MathMacro::macroName() const
 432 {
 433         return d->name_;
 434 }
 435
 436
 437 int MathMacro::nesting() const
 438 {
 439         return d->nesting_;
 440 }
 441
 442
 443 void MathMacro::cursorPos(BufferView const & bv,
 444                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 445 {
 446         // We may have 0 arguments, but InsetMathNest requires at least one.
 447         if (nargs() > 0)
 448                 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
 449 }
 450
 451
 452 bool MathMacro::editMode(BufferView const * bv) const {
 453         // find this in cursor trace
 454         Cursor const & cur = bv->cursor();
 455         for (size_t i = 0; i != cur.depth(); ++i)
 456                 if (&cur[i].inset() == this) {
 457                         // look if there is no other macro in edit mode above
 458                         ++i;
 459                         for (; i != cur.depth(); ++i) {
 460                                 InsetMath * im = cur[i].asInsetMath();
 461                                 if (im) {
 462                                         MathMacro const * macro = im->asMacro();
 463                                         if (macro && macro->displayMode() == DISPLAY_NORMAL)
 464                                                 return false;
 465                                 }
 466                         }
 467
 468                         // ok, none found, I am the highest one
 469                         return true;
 470                 }
 471
 472         return false;
 473 }
 474
 475
 476 MacroData const * MathMacro::macro() const
 477 {
 478         return d->macro_;
 479 }
 480
 481
 482 bool MathMacro::editMetrics(BufferView const * bv) const
 483 {
 484         return d->editing_[bv];
 485 }
 486
 487
 488 Inset::marker_type MathMacro::marker() const
 489 {
 490         switch (d->displayMode_) {
 491         case DISPLAY_INIT:
 492         case DISPLAY_INTERACTIVE_INIT:
 493                 return NO_MARKER;
 494         case DISPLAY_UNFOLDED:
 495                 return MARKER;
 496         default:
 497                 switch (lyxrc.macro_edit_style) {
 498                 case LyXRC::MACRO_EDIT_LIST:
 499                         return MARKER2;
 500                 case LyXRC::MACRO_EDIT_INLINE_BOX:
 501                         return NO_MARKER;
 502                 default:
 503                         return MARKER;
 504                 }
 505         }
 506 }
 507
 508
 509 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 510 {
 511         /// The macro nesting can change display of insets. Change it locally.
 512         Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
 513
 514         // set edit mode for which we will have calculated metrics. But only
 515         d->editing_[mi.base.bv] = editMode(mi.base.bv);
 516
 517         // calculate new metrics according to display mode
 518         if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
 519                 Changer dummy = mi.base.changeFontSet("lyxtex");
 520                 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
 521         } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
 522                 Changer dummy = mi.base.changeFontSet("lyxtex");
 523                 cell(0).metrics(mi, dim);
 524                 Dimension bsdim;
 525                 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
 526                 dim.wid += bsdim.width() + 1;
 527                 dim.asc = max(bsdim.ascent(), dim.ascent());
 528                 dim.des = max(bsdim.descent(), dim.descent());
 529         } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
 530                    && d->editing_[mi.base.bv]) {
 531                 // Macro will be edited in a old-style list mode here:
 532
 533                 LBUFERR(d->macro_);
 534                 Dimension fontDim;
 535                 FontInfo labelFont = sane_font;
 536                 math_font_max_dim(labelFont, fontDim.asc, fontDim.des);
 537
 538                 // get dimension of components of list view
 539                 Dimension nameDim;
 540                 nameDim.wid = mathed_string_width(mi.base.font, from_ascii("Macro \\") + name() + ": ");
 541                 nameDim.asc = fontDim.asc;
 542                 nameDim.des = fontDim.des;
 543
 544                 Dimension argDim;
 545                 argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
 546                 argDim.asc = fontDim.asc;
 547                 argDim.des = fontDim.des;
 548
 549                 Dimension defDim;
 550                 d->definition_.metrics(mi, defDim);
 551
 552                 // add them up
 553                 dim.wid = nameDim.wid + defDim.wid;
 554                 dim.asc = max(nameDim.asc, defDim.asc);
 555                 dim.des = max(nameDim.des, defDim.des);
 556
 557                 for (idx_type i = 0; i < nargs(); ++i) {
 558                         Dimension cdim;
 559                         cell(i).metrics(mi, cdim);
 560                         dim.des += max(argDim.height(), cdim.height()) + 1;
 561                         dim.wid = max(dim.wid, argDim.wid + cdim.wid);
 562                 }
 563
 564                 // make space for box and markers, 2 pixels
 565                 dim.asc += 1;
 566                 dim.des += 1;
 567                 dim.wid += 2;
 568         } else {
 569                 LBUFERR(d->macro_);
 570
 571                 // calculate metrics, hoping that all cells are seen
 572                 d->macro_->lock();
 573                 d->expanded_.metrics(mi, dim);
 574
 575                 // otherwise do a manual metrics call
 576                 CoordCache & coords = mi.base.bv->coordCache();
 577                 for (idx_type i = 0; i < nargs(); ++i) {
 578                         if (!coords.getArrays().hasDim(&cell(i))) {
 579                                 Dimension tdim;
 580                                 cell(i).metrics(mi, tdim);
 581                         }
 582                 }
 583                 d->macro_->unlock();
 584
 585                 // calculate dimension with label while editing
 586                 if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
 587                     && d->editing_[mi.base.bv]) {
 588                         FontInfo font;
 589                         font.setSize(FONT_SIZE_TINY);
 590                         Dimension namedim;
 591                         mathed_string_dim(font, name(), namedim);
 592 #if 0
 593                         dim.wid += 2 + namedim.wid + 2 + 2;
 594                         dim.asc = max(dim.asc, namedim.asc) + 2;
 595                         dim.des = max(dim.des, namedim.des) + 2;
 596 #endif
 597                         dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
 598                         dim.asc += 1 + namedim.height() + 1;
 599                         dim.des += 2;
 600                 }
 601         }
 602 }
 603
 604
 605 int MathMacro::kerning(BufferView const * bv) const {
 606         if (d->displayMode_ == DISPLAY_NORMAL && !d->editing_[bv])
 607                 return d->expanded_.kerning(bv);
 608         else
 609                 return 0;
 610 }
 611
 612
 613 void MathMacro::updateMacro(MacroContext const & mc)
 614 {
 615         if (validName()) {
 616                 d->macro_ = mc.get(name());
 617                 if (d->macro_ && d->macroBackup_ != *d->macro_) {
 618                         d->macroBackup_ = *d->macro_;
 619                         d->needsUpdate_ = true;
 620                 }
 621         } else {
 622                 d->macro_ = 0;
 623         }
 624 }
 625
 626
 627 class MathMacro::UpdateLocker
 628 {
 629 public:
 630         explicit UpdateLocker(MathMacro & mm) : mac(mm)
 631         {
 632                 mac.d->isUpdating_ = true;
 633         }
 634         ~UpdateLocker() { mac.d->isUpdating_ = false; }
 635 private:
 636         MathMacro & mac;
 637 };
 638 /** Avoid wrong usage of UpdateLocker.
 639     To avoid wrong usage:
 640     UpdateLocker(...); // wrong
 641     UpdateLocker locker(...); // right
 642 */
 643 #define UpdateLocker(x) unnamed_UpdateLocker;
 644 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
 645
 646
 647 void MathMacro::updateRepresentation(Cursor * cur, MacroContext const & mc,
 648         UpdateType utype, int nesting)
 649 {
 650         // block recursive calls (bug 8999)
 651         if (d->isUpdating_)
 652                 return;
 653
 654         UpdateLocker locker(*this);
 655
 656         // known macro?
 657         if (d->macro_ == 0)
 658                 return;
 659
 660         // remember nesting level of this macro
 661         d->nesting_ = nesting;
 662
 663         // update requires
 664         d->requires_ = d->macro_->requires();
 665
 666         if (!d->needsUpdate_
 667                 // non-normal mode? We are done!
 668                 || (d->displayMode_ != DISPLAY_NORMAL))
 669                 return;
 670
 671         d->needsUpdate_ = false;
 672
 673         // get default values of macro
 674         vector<docstring> const & defaults = d->macro_->defaults();
 675
 676         // create MathMacroArgumentValue objects pointing to the cells of the macro
 677         vector<MathData> values(nargs());
 678         for (size_t i = 0; i < nargs(); ++i) {
 679                 ArgumentProxy * proxy;
 680                 if (i < defaults.size())
 681                         proxy = new ArgumentProxy(this, i, defaults[i]);
 682                 else
 683                         proxy = new ArgumentProxy(this, i);
 684                 values[i].insert(0, MathAtom(proxy));
 685         }
 686         // expanding macro with the values
 687         // Only update the argument macros if anything was expanded, otherwise
 688         // we would get an endless loop (bug 9140). UpdateLocker does not work
 689         // in this case, since MacroData::expand() creates new MathMacro
 690         // objects, so this would be a different recursion path than the one
 691         // protected by UpdateLocker.
 692         if (d->macro_->expand(values, d->expanded_)) {
 693                 if (utype == OutputUpdate && !d->expanded_.empty())
 694                         d->expanded_.updateMacros(cur, mc, utype, nesting);
 695         }
 696         // get definition for list edit mode
 697         docstring const & display = d->macro_->display();
 698         asArray(display.empty() ? d->macro_->definition() : display,
 699                 d->definition_, Parse::QUIET);
 700 }
 701
 702
 703 void MathMacro::draw(PainterInfo & pi, int x, int y) const
 704 {
 705         Dimension const dim = dimension(*pi.base.bv);
 706
 707         int expx = x;
 708         int expy = y;
 709
 710         if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
 711                 Changer dummy = pi.base.changeFontSet("lyxtex");
 712                 pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
 713         } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
 714                 Changer dummy = pi.base.changeFontSet("lyxtex");
 715                 pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
 716                 x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
 717                 cell(0).draw(pi, x, y);
 718         } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
 719                    && d->editing_[pi.base.bv]) {
 720                 // Macro will be edited in a old-style list mode here:
 721
 722                 CoordCache const & coords = pi.base.bv->coordCache();
 723                 FontInfo const & labelFont = sane_font;
 724
 725                 // box needs one pixel
 726                 x += 1;
 727
 728                 // get maximal font height
 729                 Dimension fontDim;
 730                 math_font_max_dim(pi.base.font, fontDim.asc, fontDim.des);
 731
 732                 // draw label
 733                 docstring label = from_ascii("Macro \\") + name() + from_ascii(": ");
 734                 pi.pain.text(x, y, label, labelFont);
 735                 x += mathed_string_width(labelFont, label);
 736
 737                 // draw definition
 738                 d->definition_.draw(pi, x, y);
 739                 Dimension const & defDim = coords.getArrays().dim(&d->definition_);
 740                 y += max(fontDim.des, defDim.des);
 741
 742                 // draw parameters
 743                 docstring str = from_ascii("#9");
 744                 int strw1 = mathed_string_width(labelFont, from_ascii("#9"));
 745                 int strw2 = mathed_string_width(labelFont, from_ascii(": "));
 746
 747                 for (idx_type i = 0; i < nargs(); ++i) {
 748                         // position of label
 749                         Dimension const & cdim = coords.getArrays().dim(&cell(i));
 750                         x = expx + 1;
 751                         y += max(fontDim.asc, cdim.asc) + 1;
 752
 753                         // draw label
 754                         str[1] = '1' + i;
 755                         pi.pain.text(x, y, str, labelFont);
 756                         x += strw1;
 757                         pi.pain.text(x, y, from_ascii(":"), labelFont);
 758                         x += strw2;
 759
 760                         // draw paramter
 761                         cell(i).draw(pi, x, y);
 762
 763                         // next line
 764                         y += max(fontDim.des, cdim.des);
 765                 }
 766
 767                 pi.pain.rectangle(expx, expy - dim.asc + 1, dim.wid - 1,
 768                                   dim.height() - 2, Color_mathmacroframe);
 769         } else {
 770                 bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
 771                         && d->editing_[pi.base.bv];
 772
 773                 // warm up cells
 774                 for (size_t i = 0; i < nargs(); ++i)
 775                         cell(i).setXY(*pi.base.bv, x, y);
 776
 777                 if (drawBox) {
 778                         // draw header and rectangle around
 779                         FontInfo font;
 780                         font.setSize(FONT_SIZE_TINY);
 781                         font.setColor(Color_mathmacrolabel);
 782                         Dimension namedim;
 783                         mathed_string_dim(font, name(), namedim);
 784
 785                         pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
 786                         pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
 787                         expx += (dim.wid - d->expanded_.dimension(*pi.base.bv).width()) / 2;
 788                 }
 789
 790                 beforeDraw(pi);
 791                 d->expanded_.draw(pi, expx, expy);
 792                 afterDraw(pi);
 793
 794                 if (drawBox)
 795                         pi.pain.rectangle(x, y - dim.asc, dim.wid,
 796                                           dim.height(), Color_mathmacroframe);
 797         }
 798
 799         // edit mode changed?
 800         if (d->editing_[pi.base.bv] != editMode(pi.base.bv))
 801                 pi.base.bv->cursor().screenUpdateFlags(Update::SinglePar);
 802 }
 803
 804
 805 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
 806 {
 807         if (d->displayMode_ != mode) {
 808                 // transfer name if changing from or to DISPLAY_UNFOLDED
 809                 if (mode == DISPLAY_UNFOLDED) {
 810                         cells_.resize(1);
 811                         asArray(d->name_, cell(0));
 812                 } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
 813                         d->name_ = asString(cell(0));
 814                         cells_.resize(0);
 815                 }
 816
 817                 d->displayMode_ = mode;
 818                 d->needsUpdate_ = true;
 819         }
 820
 821         // the interactive init mode is non-greedy by default
 822         if (appetite == -1)
 823                 d->appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
 824         else
 825                 d->appetite_ = size_t(appetite);
 826 }
 827
 828
 829 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
 830 {
 831         if (d->nextFoldMode_ == true && d->macro_ && !d->macro_->locked())
 832                 return DISPLAY_NORMAL;
 833         else
 834                 return DISPLAY_UNFOLDED;
 835 }
 836
 837
 838 bool MathMacro::validName() const
 839 {
 840         docstring n = name();
 841
 842         if (n.empty())
 843                 return false;
 844
 845         // converting back and force doesn't swallow anything?
 846         /*MathData ma;
 847         asArray(n, ma);
 848         if (asString(ma) != n)
 849                 return false;*/
 850
 851         // valid characters?
 852         for (size_t i = 0; i<n.size(); ++i) {
 853                 if (!(n[i] >= 'a' && n[i] <= 'z')
 854                     && !(n[i] >= 'A' && n[i] <= 'Z')
 855                     && n[i] != '*')
 856                         return false;
 857         }
 858
 859         return true;
 860 }
 861
 862
 863 size_t MathMacro::arity() const
 864 {
 865         if (d->displayMode_ == DISPLAY_NORMAL )
 866                 return cells_.size();
 867         else
 868                 return 0;
 869 }
 870
 871
 872 size_t MathMacro::optionals() const
 873 {
 874         return d->optionals_;
 875 }
 876
 877
 878 void MathMacro::setOptionals(int n)
 879 {
 880         if (n <= int(nargs()))
 881                 d->optionals_ = n;
 882 }
 883
 884
 885 size_t MathMacro::appetite() const
 886 {
 887         return d->appetite_;
 888 }
 889
 890
 891 MathClass MathMacro::mathClass() const
 892 {
 893         // This can be just a heuristic, since it is only considered for display
 894         // when the macro is not linearised. Therefore it affects:
 895         // * The spacing of the inset while being edited,
 896         // * Intelligent splitting
 897         // * Cursor word movement (Ctrl-Arrow).
 898         if (MacroData const * m = macroBackup()) {
 899                 // If it is a global macro and is defined explicitly
 900                 if (m->symbol()) {
 901                         MathClass mc = string_to_class(m->symbol()->extra);
 902                         if (mc != MC_UNKNOWN)
 903                                 return mc;
 904                 }
 905         }
 906         // Otherwise guess from the expanded macro
 907         return d->expanded_.mathClass();
 908 }
 909
 910
 911 InsetMath::mode_type MathMacro::currentMode() const
 912 {
 913         // There is no way to guess the mode of user defined macros, so they are
 914         // always assumed to be mathmode.  Only the global macros defined in
 915         // lib/symbols may be textmode.
 916         mode_type mode = modeToEnsure();
 917         return (mode == UNDECIDED_MODE) ? MATH_MODE : mode;
 918 }
 919
 920
 921 InsetMath::mode_type MathMacro::modeToEnsure() const
 922 {
 923         // User defined macros can be either text mode or math mode for output and
 924         // display. There is no way to guess. For global macros defined in
 925         // lib/symbols, we ensure textmode if flagged as such, otherwise we ensure
 926         // math mode.
 927         if (MacroData const * m = macroBackup())
 928                 if (m->symbol())
 929                         return (m->symbol()->extra == "textmode") ? TEXT_MODE : MATH_MODE;
 930         return UNDECIDED_MODE;
 931 }
 932
 933
 934 MacroData const * MathMacro::macroBackup() const
 935 {
 936         if (macro())
 937                 return &d->macroBackup_;
 938         if (MacroData const * data = MacroTable::globalMacros().get(name()))
 939                 return data;
 940         return nullptr;
 941 }
 942
 943
 944 void MathMacro::validate(LaTeXFeatures & features) const
 945 {
 946         // Immediately after a document is loaded, in some cases the MacroData
 947         // of the global macros defined in the lib/symbols file may still not
 948         // be known to the macro machinery because it will be set only after
 949         // the first call to updateMacros(). This is not a problem unless
 950         // instant preview is on for math, in which case we will be missing
 951         // the corresponding requirements.
 952         // In this case, we get the required info from the global macro table.
 953         if (!d->requires_.empty())
 954                 features.require(d->requires_);
 955         else if (!d->macro_) {
 956                 // Update requires for known global macros.
 957                 MacroData const * data = MacroTable::globalMacros().get(name());
 958                 if (data && !data->requires().empty())
 959                         features.require(data->requires());
 960         }
 961
 962         if (name() == "binom")
 963                 features.require("binom");
 964
 965         // validate the cells and the definition
 966         if (displayMode() == DISPLAY_NORMAL) {
 967                 d->definition_.validate(features);
 968                 InsetMathNest::validate(features);
 969         }
 970 }
 971
 972
 973 void MathMacro::edit(Cursor & cur, bool front, EntryDirection entry_from)
 974 {
 975         cur.screenUpdateFlags(Update::SinglePar);
 976         InsetMathNest::edit(cur, front, entry_from);
 977 }
 978
 979
 980 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
 981 {
 982         // We may have 0 arguments, but InsetMathNest requires at least one.
 983         if (nargs() > 0) {
 984                 cur.screenUpdateFlags(Update::SinglePar);
 985                 return InsetMathNest::editXY(cur, x, y);
 986         } else
 987                 return this;
 988 }
 989
 990
 991 void MathMacro::removeArgument(Inset::pos_type pos) {
 992         if (d->displayMode_ == DISPLAY_NORMAL) {
 993                 LASSERT(size_t(pos) < cells_.size(), return);
 994                 cells_.erase(cells_.begin() + pos);
 995                 if (size_t(pos) < d->attachedArgsNum_)
 996                         --d->attachedArgsNum_;
 997                 if (size_t(pos) < d->optionals_) {
 998                         --d->optionals_;
 999                 }
1000
1001                 d->needsUpdate_ = true;
1002         }
1003 }
1004
1005
1006 void MathMacro::insertArgument(Inset::pos_type pos) {
1007         if (d->displayMode_ == DISPLAY_NORMAL) {
1008                 LASSERT(size_t(pos) <= cells_.size(), return);
1009                 cells_.insert(cells_.begin() + pos, MathData());
1010                 if (size_t(pos) < d->attachedArgsNum_)
1011                         ++d->attachedArgsNum_;
1012                 if (size_t(pos) < d->optionals_)
1013                         ++d->optionals_;
1014
1015                 d->needsUpdate_ = true;
1016         }
1017 }
1018
1019
1020 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
1021 {
1022         LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
1023         args = cells_;
1024
1025         // strip off empty cells, but not more than arity-attachedArgsNum_
1026         if (strip) {
1027                 size_t i;
1028                 for (i = cells_.size(); i > d->attachedArgsNum_; --i)
1029                         if (!cell(i - 1).empty()) break;
1030                 args.resize(i);
1031         }
1032
1033         d->attachedArgsNum_ = 0;
1034         d->expanded_ = MathData();
1035         cells_.resize(0);
1036
1037         d->needsUpdate_ = true;
1038 }
1039
1040
1041 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
1042 {
1043         LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
1044         cells_ = args;
1045         d->attachedArgsNum_ = args.size();
1046         cells_.resize(arity);
1047         d->expanded_ = MathData();
1048         d->optionals_ = optionals;
1049
1050         d->needsUpdate_ = true;
1051 }
1052
1053
1054 bool MathMacro::idxFirst(Cursor & cur) const
1055 {
1056         cur.screenUpdateFlags(Update::SinglePar);
1057         return InsetMathNest::idxFirst(cur);
1058 }
1059
1060
1061 bool MathMacro::idxLast(Cursor & cur) const
1062 {
1063         cur.screenUpdateFlags(Update::SinglePar);
1064         return InsetMathNest::idxLast(cur);
1065 }
1066
1067
1068 bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
1069 {
1070         if (d->displayMode_ == DISPLAY_UNFOLDED) {
1071                 docstring const & unfolded_name = name();
1072                 if (unfolded_name != d->name_) {
1073                         // The macro name was changed
1074                         Cursor inset_cursor = old;
1075                         int macroSlice = inset_cursor.find(this);
1076                         // returning true means the cursor is "now" invalid,
1077                         // which it was.
1078                         LASSERT(macroSlice != -1, return true);
1079                         inset_cursor.cutOff(macroSlice);
1080                         inset_cursor.recordUndoInset();
1081                         inset_cursor.pop();
1082                         inset_cursor.cell().erase(inset_cursor.pos());
1083                         inset_cursor.cell().insert(inset_cursor.pos(),
1084                                 createInsetMath(unfolded_name, cur.buffer()));
1085                         cur.resetAnchor();
1086                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
1087                         return true;
1088                 }
1089         }
1090         cur.screenUpdateFlags(Update::Force);
1091         return InsetMathNest::notifyCursorLeaves(old, cur);
1092 }
1093
1094
1095 void MathMacro::fold(Cursor & cur)
1096 {
1097         if (!d->nextFoldMode_) {
1098                 d->nextFoldMode_ = true;
1099                 cur.screenUpdateFlags(Update::SinglePar);
1100         }
1101 }
1102
1103
1104 void MathMacro::unfold(Cursor & cur)
1105 {
1106         if (d->nextFoldMode_) {
1107                 d->nextFoldMode_ = false;
1108                 cur.screenUpdateFlags(Update::SinglePar);
1109         }
1110 }
1111
1112
1113 bool MathMacro::folded() const
1114 {
1115         return d->nextFoldMode_;
1116 }
1117
1118
1119 void MathMacro::write(WriteStream & os) const
1120 {
1121         mode_type mode = modeToEnsure();
1122         bool textmode_macro = mode == TEXT_MODE;
1123         bool needs_mathmode = mode == MATH_MODE;
1124         MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
1125
1126         // non-normal mode
1127         if (d->displayMode_ != DISPLAY_NORMAL) {
1128                 os << "\\" << name();
1129                 if (name().size() != 1 || isAlphaASCII(name()[0]))
1130                         os.pendingSpace(true);
1131                 return;
1132         }
1133
1134         // normal mode
1135         // we should be ok to continue even if this fails.
1136         LATTEST(d->macro_);
1137
1138         // We may already be in the argument of a macro
1139         bool const inside_macro = os.insideMacro();
1140         os.insideMacro(true);
1141
1142         // Enclose in braces to avoid latex errors with xargs if we have
1143         // optional arguments and are in the optional argument of a macro
1144         if (d->optionals_ && inside_macro)
1145                 os << '{';
1146
1147         // Always protect macros in a fragile environment
1148         if (os.fragile())
1149                 os << "\\protect";
1150
1151         os << "\\" << name();
1152         bool first = true;
1153
1154         // Optional arguments:
1155         // First find last non-empty optional argument
1156         idx_type emptyOptFrom = 0;
1157         idx_type i = 0;
1158         for (; i < cells_.size() && i < d->optionals_; ++i) {
1159                 if (!cell(i).empty())
1160                         emptyOptFrom = i + 1;
1161         }
1162
1163         // print out optionals
1164         for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
1165                 first = false;
1166                 os << "[" << cell(i) << "]";
1167         }
1168
1169         // skip the tailing empty optionals
1170         i = d->optionals_;
1171
1172         // Print remaining arguments
1173         for (; i < cells_.size(); ++i) {
1174                 if (cell(i).size() == 1
1175                         && cell(i)[0].nucleus()->asCharInset()
1176                         && isASCII(cell(i)[0].nucleus()->asCharInset()->getChar())) {
1177                         if (first)
1178                                 os << " ";
1179                         os << cell(i);
1180                 } else
1181                         os << "{" << cell(i) << "}";
1182                 first = false;
1183         }
1184
1185         // Close the opened brace or add space if there was no argument
1186         if (d->optionals_ && inside_macro)
1187                 os << '}';
1188         else if (first)
1189                 os.pendingSpace(true);
1190
1191         os.insideMacro(inside_macro);
1192 }
1193
1194
1195 void MathMacro::maple(MapleStream & os) const
1196 {
1197         lyx::maple(d->expanded_, os);
1198 }
1199
1200
1201 void MathMacro::maxima(MaximaStream & os) const
1202 {
1203         lyx::maxima(d->expanded_, os);
1204 }
1205
1206
1207 void MathMacro::mathematica(MathematicaStream & os) const
1208 {
1209         lyx::mathematica(d->expanded_, os);
1210 }
1211
1212
1213 void MathMacro::mathmlize(MathStream & os) const
1214 {
1215         // macro_ is 0 if this is an unknown macro
1216         LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
1217         if (d->macro_) {
1218                 docstring const xmlname = d->macro_->xmlname();
1219                 if (!xmlname.empty()) {
1220                         char const * type = d->macro_->MathMLtype();
1221                         os << '<' << type << "> " << xmlname << " </"
1222                            << type << '>';
1223                         return;
1224                 }
1225         }
1226         if (d->expanded_.empty()) {
1227                 // this means that we do not recognize the macro
1228                 throw MathExportException();
1229         }
1230         os << d->expanded_;
1231 }
1232
1233
1234 void MathMacro::htmlize(HtmlStream & os) const
1235 {
1236         // macro_ is 0 if this is an unknown macro
1237         LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
1238         if (d->macro_) {
1239                 docstring const xmlname = d->macro_->xmlname();
1240                 if (!xmlname.empty()) {
1241                         os << ' ' << xmlname << ' ';
1242                         return;
1243                 }
1244         }
1245         if (d->expanded_.empty()) {
1246                 // this means that we do not recognize the macro
1247                 throw MathExportException();
1248         }
1249         os << d->expanded_;
1250 }
1251
1252
1253 void MathMacro::octave(OctaveStream & os) const
1254 {
1255         lyx::octave(d->expanded_, os);
1256 }
1257
1258
1259 void MathMacro::infoize(odocstream & os) const
1260 {
1261         os << bformat(_("Macro: %1$s"), name());
1262 }
1263
1264
1265 void MathMacro::infoize2(odocstream & os) const
1266 {
1267         os << bformat(_("Macro: %1$s"), name());
1268 }
1269
1270
1271 bool MathMacro::completionSupported(Cursor const & cur) const
1272 {
1273         if (displayMode() != DISPLAY_UNFOLDED)
1274                 return InsetMathNest::completionSupported(cur);
1275
1276         return lyxrc.completion_popup_math
1277                 && displayMode() == DISPLAY_UNFOLDED
1278                 && cur.bv().cursor().pos() == int(name().size());
1279 }
1280
1281
1282 bool MathMacro::inlineCompletionSupported(Cursor const & cur) const
1283 {
1284         if (displayMode() != DISPLAY_UNFOLDED)
1285                 return InsetMathNest::inlineCompletionSupported(cur);
1286
1287         return lyxrc.completion_inline_math
1288                 && displayMode() == DISPLAY_UNFOLDED
1289                 && cur.bv().cursor().pos() == int(name().size());
1290 }
1291
1292
1293 bool MathMacro::automaticInlineCompletion() const
1294 {
1295         if (displayMode() != DISPLAY_UNFOLDED)
1296                 return InsetMathNest::automaticInlineCompletion();
1297
1298         return lyxrc.completion_inline_math;
1299 }
1300
1301
1302 bool MathMacro::automaticPopupCompletion() const
1303 {
1304         if (displayMode() != DISPLAY_UNFOLDED)
1305                 return InsetMathNest::automaticPopupCompletion();
1306
1307         return lyxrc.completion_popup_math;
1308 }
1309
1310
1311 CompletionList const *
1312 MathMacro::createCompletionList(Cursor const & cur) const
1313 {
1314         if (displayMode() != DISPLAY_UNFOLDED)
1315                 return InsetMathNest::createCompletionList(cur);
1316
1317         return new MathCompletionList(cur.bv().cursor());
1318 }
1319
1320
1321 docstring MathMacro::completionPrefix(Cursor const & cur) const
1322 {
1323         if (displayMode() != DISPLAY_UNFOLDED)
1324                 return InsetMathNest::completionPrefix(cur);
1325
1326         if (!completionSupported(cur))
1327                 return docstring();
1328
1329         return "\\" + name();
1330 }
1331
1332
1333 bool MathMacro::insertCompletion(Cursor & cur, docstring const & s,
1334                                         bool finished)
1335 {
1336         if (displayMode() != DISPLAY_UNFOLDED)
1337                 return InsetMathNest::insertCompletion(cur, s, finished);
1338
1339         if (!completionSupported(cur))
1340                 return false;
1341
1342         // append completion
1343         docstring newName = name() + s;
1344         asArray(newName, cell(0));
1345         cur.bv().cursor().pos() = name().size();
1346         cur.screenUpdateFlags(Update::SinglePar);
1347
1348         // finish macro
1349         if (finished) {
1350                 cur.bv().cursor().pop();
1351                 ++cur.bv().cursor().pos();
1352                 cur.screenUpdateFlags(Update::SinglePar);
1353         }
1354
1355         return true;
1356 }
1357
1358
1359 void MathMacro::completionPosAndDim(Cursor const & cur, int & x, int & y,
1360         Dimension & dim) const
1361 {
1362         if (displayMode() != DISPLAY_UNFOLDED)
1363                 InsetMathNest::completionPosAndDim(cur, x, y, dim);
1364
1365         // get inset dimensions
1366         dim = cur.bv().coordCache().insets().dim(this);
1367         // FIXME: these 3 are no accurate, but should depend on the font.
1368         // Now the popup jumps down if you enter a char with descent > 0.
1369         dim.des += 3;
1370         dim.asc += 3;
1371
1372         // and position
1373         Point xy
1374         = cur.bv().coordCache().insets().xy(this);
1375         x = xy.x_;
1376         y = xy.y_;
1377 }
1378
1379
1380 } // namespace lyx