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