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 #include "MathSupport.h"
  17 #include "MathExtern.h"
  18 #include "MathStream.h"
  19
  20 #include "Buffer.h"
  21 #include "BufferView.h"
  22 #include "Cursor.h"
  23 #include "support/debug.h"
  24 #include "LaTeXFeatures.h"
  25 #include "FuncStatus.h"
  26 #include "FuncRequest.h"
  27 #include "Undo.h"
  28
  29 #include "frontends/Painter.h"
  30
  31 #include <ostream>
  32 #include <vector>
  33
  34 using namespace std;
  35
  36 namespace lyx {
  37
  38
  39 /// A proxy for the macro values
  40 class ArgumentProxy : public InsetMath {
  41 public:
  42         ///
  43         ArgumentProxy(MathMacro & mathMacro, size_t idx)
  44                 : mathMacro_(mathMacro), idx_(idx) {}
  45         ///
  46         ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def)
  47                 : mathMacro_(mathMacro), idx_(idx)
  48         {
  49                         asArray(def, def_);
  50         }
  51         ///
  52         void metrics(MetricsInfo & mi, Dimension & dim) const {
  53                 mathMacro_.macro()->unlock();
  54                 mathMacro_.cell(idx_).metrics(mi, dim);
  55                 if (!mathMacro_.editing(mi.base.bv) && !def_.empty())
  56                         def_.metrics(mi, dim);
  57                 mathMacro_.macro()->lock();
  58         }
  59         ///
  60         void draw(PainterInfo & pi, int x, int y) const {
  61                 if (mathMacro_.editing(pi.base.bv)) {
  62                         // The only way a ArgumentProxy can appear is in a cell of the
  63                         // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
  64                         // mode and then, in the case of "editing_ == true" the monochrome
  65                         // mode is entered by the MathMacro before calling the cells' draw
  66                         // method. Then eventually this code is reached and the proxy leaves
  67                         // monochrome mode temporarely. Hence, if it is not in monochrome
  68                         // here (and the assert triggers in pain.leaveMonochromeMode())
  69                         // it's a bug.
  70                         pi.pain.leaveMonochromeMode();
  71                         mathMacro_.cell(idx_).draw(pi, x, y);
  72                         pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
  73                 } else {
  74                         if (def_.empty())
  75                                 mathMacro_.cell(idx_).draw(pi, x, y);
  76                         else {
  77                                 mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
  78                                 def_.draw(pi, x, y);
  79                         }
  80                 }
  81         }
  82         ///
  83         size_t idx() const { return idx_; }
  84         ///
  85         int kerning(BufferView const * bv) const { return mathMacro_.cell(idx_).kerning(bv); }
  86
  87 private:
  88         ///
  89         Inset * clone() const
  90         {
  91                 return new ArgumentProxy(*this);
  92         }
  93         ///
  94         MathMacro & mathMacro_;
  95         ///
  96         size_t idx_;
  97         ///
  98         MathData def_;
  99 };
 100
 101
 102 MathMacro::MathMacro(docstring const & name)
 103         : InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
 104                 attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
 105                 macro_(0), needsUpdate_(false)
 106 {}
 107
 108
 109 Inset * MathMacro::clone() const
 110 {
 111         MathMacro * copy = new MathMacro(*this);
 112         copy->needsUpdate_ = true;
 113         copy->expanded_.cell(0).clear();
 114         return copy;
 115 }
 116
 117
 118 docstring MathMacro::name() const
 119 {
 120         if (displayMode_ == DISPLAY_UNFOLDED)
 121                 return asString(cell(0));
 122         else
 123                 return name_;
 124 }
 125
 126
 127 void MathMacro::cursorPos(BufferView const & bv,
 128                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 129 {
 130         // We may have 0 arguments, but InsetMathNest requires at least one.
 131         if (nargs() > 0)
 132                 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
 133 }
 134
 135
 136 int MathMacro::cursorIdx(Cursor const & cur) const {
 137         for (size_t i = 0; i != cur.depth(); ++i)
 138                         if (&cur[i].inset() == this)
 139                                 return cur[i].idx();
 140         return -1;
 141 }
 142
 143
 144 bool MathMacro::editMode(Cursor const & cur) const {
 145         // find this in cursor trace
 146         for (size_t i = 0; i != cur.depth(); ++i)
 147                 if (&cur[i].inset() == this) {
 148                         // look if there is no other macro in edit mode above
 149                         ++i;
 150                         for (; i != cur.depth(); ++i) {
 151                                 MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
 152                                 if (macro && macro->displayMode() == DISPLAY_NORMAL)
 153                                         return false;
 154                         }
 155
 156                         // ok, none found, I am the highest one
 157                         return true;
 158                 }
 159
 160         return false;
 161 }
 162
 163
 164 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 165 {
 166         // set edit mode for which we will have calculated metrics
 167         editing_[mi.base.bv] = editMode(mi.base.bv->cursor());
 168
 169         // calculate new metrics according to display mode
 170         if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
 171                 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
 172         } else if (displayMode_ == DISPLAY_UNFOLDED) {
 173                 cell(0).metrics(mi, dim);
 174                 Dimension bsdim;
 175                 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
 176                 dim.wid += bsdim.width() + 1;
 177                 dim.asc = max(bsdim.ascent(), dim.ascent());
 178                 dim.des = max(bsdim.descent(), dim.descent());
 179                 metricsMarkers(dim);
 180         } else {
 181                 BOOST_ASSERT(macro_ != 0);
 182
 183                 // calculate metric finally
 184                 macro_->lock();
 185                 expanded_.cell(0).metrics(mi, dim);
 186                 macro_->unlock();
 187
 188                 // calculate dimension with label while editing
 189                 if (editing_[mi.base.bv]) {
 190                         FontInfo font = mi.base.font;
 191                         augmentFont(font, from_ascii("lyxtex"));
 192                         Dimension namedim;
 193                         mathed_string_dim(font, name(), namedim);
 194 #if 0
 195                         dim.wid += 2 + namedim.wid + 2 + 2;
 196                         dim.asc = max(dim.asc, namedim.asc) + 2;
 197                         dim.des = max(dim.des, namedim.des) + 2;
 198 #endif
 199                         dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
 200                         dim.asc += 1 + namedim.height() + 1;
 201                         dim.des += 2;
 202                 }
 203         }
 204 }
 205
 206
 207 int MathMacro::kerning(BufferView const * bv) const {
 208         if (displayMode_ == DISPLAY_NORMAL && !editing(bv))
 209                 return expanded_.kerning(bv);
 210         else
 211                 return 0;
 212 }
 213
 214
 215 void MathMacro::updateMacro(MacroContext const & mc)
 216 {
 217         if (validName()) {
 218                 macro_ = mc.get(name());
 219                 if (macro_ && macroBackup_ != *macro_) {
 220                         macroBackup_ = *macro_;
 221                         needsUpdate_ = true;
 222                 }
 223         } else {
 224                 macro_ = 0;
 225         }
 226 }
 227
 228
 229 void MathMacro::updateRepresentation(Cursor const * bvCur)
 230 {
 231         // index of child where the cursor is (or -1 if none is edited)
 232         int curIdx = -1;
 233         if (bvCur) {
 234                 curIdx = cursorIdx(*bvCur);
 235                 previousCurIdx_[&bvCur->bv()] = curIdx;
 236         }
 237
 238         // known macro?
 239         if (macro_ == 0)
 240                 return;
 241
 242         // update requires
 243         requires_ = macro_->requires();
 244
 245         // non-normal mode? We are done!
 246         if (displayMode_ != DISPLAY_NORMAL)
 247                 return;
 248
 249         // macro changed?
 250         if (needsUpdate_) {
 251                 needsUpdate_ = false;
 252
 253                 // get default values of macro
 254                 vector<docstring> const & defaults = macro_->defaults();
 255
 256                 // create MathMacroArgumentValue objects pointing to the cells of the macro
 257                 vector<MathData> values(nargs());
 258                 for (size_t i = 0; i < nargs(); ++i) {
 259                         ArgumentProxy * proxy;
 260                         if (!cell(i).empty()
 261                             || i >= defaults.size()
 262                             || defaults[i].empty()
 263                             || curIdx == (int)i)
 264                                 proxy = new ArgumentProxy(*this, i);
 265                         else
 266                                 proxy = new ArgumentProxy(*this, i, defaults[i]);
 267                         values[i].insert(0, MathAtom(proxy));
 268                 }
 269
 270                 // expanding macro with the values
 271                 macro_->expand(values, expanded_.cell(0));
 272         }
 273 }
 274
 275
 276 void MathMacro::draw(PainterInfo & pi, int x, int y) const
 277 {
 278         Dimension const dim = dimension(*pi.base.bv);
 279
 280         setPosCache(pi, x, y);
 281         int expx = x;
 282         int expy = y;
 283
 284         if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
 285                 PainterInfo pi2(pi.base.bv, pi.pain);
 286                 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
 287                 //pi2.base.style = LM_ST_TEXT;
 288                 pi2.pain.text(x, y, from_ascii("\\") + name(), pi2.base.font);
 289         } else if (displayMode_ == DISPLAY_UNFOLDED) {
 290                 PainterInfo pi2(pi.base.bv, pi.pain);
 291                 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
 292                 //pi2.base.style = LM_ST_TEXT;
 293                 pi2.pain.text(x, y, from_ascii("\\"), pi2.base.font);
 294                 x += mathed_string_width(pi2.base.font, from_ascii("\\")) + 1;
 295                 cell(0).draw(pi2, x, y);
 296                 drawMarkers(pi2, expx, expy);
 297         } else {
 298                 // warm up cells
 299                 for (size_t i = 0; i < nargs(); ++i)
 300                         cell(i).setXY(*pi.base.bv, x, y);
 301
 302                 if (editing_[pi.base.bv]) {
 303                         // draw header and rectangle around
 304                         FontInfo font = pi.base.font;
 305                         augmentFont(font, from_ascii("lyxtex"));
 306                         font.setSize(FONT_SIZE_TINY);
 307                         font.setColor(Color_mathmacrolabel);
 308                         Dimension namedim;
 309                         mathed_string_dim(font, name(), namedim);
 310 #if 0
 311                         pi.pain.fillRectangle(x, y - dim.asc, 2 + namedim.width() + 2, dim.height(), Color_mathmacrobg);
 312                         pi.pain.text(x + 2, y, name(), font);
 313                         expx += 2 + namew + 2;
 314 #endif
 315                         pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
 316                         pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
 317                         expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
 318
 319                         pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
 320                         expanded_.cell(0).draw(pi, expx, expy);
 321                         pi.pain.leaveMonochromeMode();
 322                 } else
 323                         expanded_.cell(0).draw(pi, expx, expy);
 324
 325                 // draw frame while editing
 326                 if (editing_[pi.base.bv])
 327                         pi.pain.rectangle(x, y - dim.asc, dim.wid, dim.height(), Color_mathmacroframe);
 328         }
 329
 330         // another argument selected or edit mode changed?
 331         idx_type curIdx = cursorIdx(pi.base.bv->cursor());
 332         if (previousCurIdx_[pi.base.bv] != curIdx
 333                         || editing_[pi.base.bv] != editMode(pi.base.bv->cursor()))
 334                 pi.base.bv->cursor().updateFlags(Update::Force);
 335 }
 336
 337
 338 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
 339 {
 340         // We may have 0 arguments, but InsetMathNest requires at least one.
 341         if (cells_.size() > 0)
 342                 InsetMathNest::drawSelection(pi, x, y);
 343 }
 344
 345
 346 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode)
 347 {
 348         if (displayMode_ != mode) {
 349                 // transfer name if changing from or to DISPLAY_UNFOLDED
 350                 if (mode == DISPLAY_UNFOLDED) {
 351                         cells_.resize(1);
 352                         asArray(name_, cell(0));
 353                 } else if (displayMode_ == DISPLAY_UNFOLDED) {
 354                         name_ = asString(cell(0));
 355                         cells_.resize(0);
 356                 }
 357
 358                 displayMode_ = mode;
 359                 needsUpdate_ = true;
 360         }
 361 }
 362
 363
 364 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
 365 {
 366         if (nextFoldMode_ == true && macro_ && !macro_->locked())
 367                 return DISPLAY_NORMAL;
 368         else
 369                 return DISPLAY_UNFOLDED;
 370 }
 371
 372
 373 bool MathMacro::validName() const
 374 {
 375         docstring n = name();
 376
 377         // empty name?
 378         if (n.size() == 0)
 379                 return false;
 380
 381         // converting back and force doesn't swallow anything?
 382         /*MathData ma;
 383         asArray(n, ma);
 384         if (asString(ma) != n)
 385                 return false;*/
 386
 387         // valid characters?
 388         for (size_t i = 0; i<n.size(); ++i) {
 389                 if (!(n[i] >= 'a' && n[i] <= 'z') &&
 390                                 !(n[i] >= 'A' && n[i] <= 'Z'))
 391                         return false;
 392         }
 393
 394         return true;
 395 }
 396
 397
 398 void MathMacro::validate(LaTeXFeatures & features) const
 399 {
 400         if (!requires_.empty())
 401                 features.require(requires_);
 402
 403         if (name() == "binom" || name() == "mathcircumflex")
 404                 features.require(to_utf8(name()));
 405 }
 406
 407
 408 void MathMacro::edit(Cursor & cur, bool left)
 409 {
 410         cur.updateFlags(Update::Force);
 411         InsetMathNest::edit(cur, left);
 412 }
 413
 414
 415 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
 416 {
 417         // We may have 0 arguments, but InsetMathNest requires at least one.
 418         if (nargs() > 0) {
 419                 cur.updateFlags(Update::Force);
 420                 return InsetMathNest::editXY(cur, x, y);
 421         } else
 422                 return this;
 423 }
 424
 425
 426 void MathMacro::removeArgument(Inset::pos_type pos) {
 427         if (displayMode_ == DISPLAY_NORMAL) {
 428                 BOOST_ASSERT(size_t(pos) < cells_.size());
 429                 cells_.erase(cells_.begin() + pos);
 430                 if (size_t(pos) < attachedArgsNum_)
 431                         --attachedArgsNum_;
 432                 if (size_t(pos) < optionals_) {
 433                         --optionals_;
 434                 }
 435
 436                 needsUpdate_ = true;
 437         }
 438 }
 439
 440
 441 void MathMacro::insertArgument(Inset::pos_type pos) {
 442         if (displayMode_ == DISPLAY_NORMAL) {
 443                 BOOST_ASSERT(size_t(pos) <= cells_.size());
 444                 cells_.insert(cells_.begin() + pos, MathData());
 445                 if (size_t(pos) < attachedArgsNum_)
 446                         ++attachedArgsNum_;
 447                 if (size_t(pos) < optionals_)
 448                         ++optionals_;
 449
 450                 needsUpdate_ = true;
 451         }
 452 }
 453
 454
 455 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
 456 {
 457         BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
 458         args = cells_;
 459
 460         // strip off empty cells, but not more than arity-attachedArgsNum_
 461         if (strip) {
 462                 size_t i;
 463                 for (i = cells_.size(); i > attachedArgsNum_; --i)
 464                         if (!cell(i - 1).empty()) break;
 465                 args.resize(i);
 466         }
 467
 468         attachedArgsNum_ = 0;
 469         expanded_.cell(0) = MathData();
 470         cells_.resize(0);
 471
 472         needsUpdate_ = true;
 473 }
 474
 475
 476 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
 477 {
 478         BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
 479         cells_ = args;
 480         attachedArgsNum_ = args.size();
 481         cells_.resize(arity);
 482         expanded_.cell(0) = MathData();
 483         optionals_ = optionals;
 484
 485         needsUpdate_ = true;
 486 }
 487
 488
 489 bool MathMacro::idxFirst(Cursor & cur) const
 490 {
 491         cur.updateFlags(Update::Force);
 492         return InsetMathNest::idxFirst(cur);
 493 }
 494
 495
 496 bool MathMacro::idxLast(Cursor & cur) const
 497 {
 498         cur.updateFlags(Update::Force);
 499         return InsetMathNest::idxLast(cur);
 500 }
 501
 502
 503 bool MathMacro::notifyCursorLeaves(Cursor & cur)
 504 {
 505         cur.updateFlags(Update::Force);
 506         return InsetMathNest::notifyCursorLeaves(cur);
 507 }
 508
 509
 510 void MathMacro::fold(Cursor & cur)
 511 {
 512         if (!nextFoldMode_) {
 513                 nextFoldMode_ = true;
 514                 cur.updateFlags(Update::Force);
 515         }
 516 }
 517
 518
 519 void MathMacro::unfold(Cursor & cur)
 520 {
 521         if (nextFoldMode_) {
 522                 nextFoldMode_ = false;
 523                 cur.updateFlags(Update::Force);
 524         }
 525 }
 526
 527
 528 bool MathMacro::folded() const
 529 {
 530         return nextFoldMode_;
 531 }
 532
 533
 534 void MathMacro::write(WriteStream & os) const
 535 {
 536         // non-normal mode
 537         if (displayMode_ != DISPLAY_NORMAL) {
 538                 os << "\\" << name() << " ";
 539                 os.pendingSpace(true);
 540                 return;
 541         }
 542
 543         // normal mode
 544         BOOST_ASSERT(macro_);
 545
 546         // optional arguments make macros fragile
 547         if (optionals_ > 0 && os.fragile())
 548                 os << "\\protect";
 549
 550         os << "\\" << name();
 551         bool first = true;
 552
 553         // Optional arguments:
 554         // First find last non-empty optional argument
 555         idx_type emptyOptFrom = 0;
 556         idx_type i = 0;
 557         for (; i < cells_.size() && i < optionals_; ++i) {
 558                 if (!cell(i).empty())
 559                         emptyOptFrom = i + 1;
 560         }
 561
 562         // print out optionals
 563         for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
 564                 first = false;
 565                 os << "[" << cell(i) << "]";
 566         }
 567
 568         // skip the tailing empty optionals
 569         i = optionals_;
 570
 571         // Print remaining macros
 572         for (; i < cells_.size(); ++i) {
 573                 if (cell(i).size() == 1
 574                          && cell(i)[0].nucleus()->asCharInset()) {
 575                         if (first)
 576                                 os << " ";
 577                         os << cell(i);
 578                 } else
 579                         os << "{" << cell(i) << "}";
 580                 first = false;
 581         }
 582
 583         // add space if there was no argument
 584         if (first)
 585                 os.pendingSpace(true);
 586 }
 587
 588
 589 void MathMacro::maple(MapleStream & os) const
 590 {
 591         lyx::maple(expanded_.cell(0), os);
 592 }
 593
 594
 595 void MathMacro::mathmlize(MathStream & os) const
 596 {
 597         lyx::mathmlize(expanded_.cell(0), os);
 598 }
 599
 600
 601 void MathMacro::octave(OctaveStream & os) const
 602 {
 603         lyx::octave(expanded_.cell(0), os);
 604 }
 605
 606
 607 void MathMacro::infoize(odocstream & os) const
 608 {
 609         os << "Macro: " << name();
 610 }
 611
 612
 613 void MathMacro::infoize2(odocstream & os) const
 614 {
 615         os << "Macro: " << name();
 616
 617 }
 618
 619
 620 } // namespace lyx