src/mathed/MathData.cpp

   1 /**
   2  * \file MathData.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Stefan Schimanski
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "MathData.h"
  15
  16 #include "InsetMathBrace.h"
  17 #include "InsetMathFont.h"
  18 #include "InsetMathScript.h"
  19 #include "MacroTable.h"
  20 #include "MathMacro.h"
  21 #include "MathStream.h"
  22 #include "MathSupport.h"
  23 #include "MetricsInfo.h"
  24 #include "ReplaceData.h"
  25
  26 #include "Buffer.h"
  27 #include "BufferView.h"
  28 #include "CoordCache.h"
  29 #include "Cursor.h"
  30
  31 #include "mathed/InsetMathUnknown.h"
  32
  33 #include "support/debug.h"
  34 #include "support/docstream.h"
  35
  36 #include "frontends/FontMetrics.h"
  37 #include "frontends/Painter.h"
  38
  39 #include "support/gettext.h"
  40 #include "support/lassert.h"
  41 #include "support/lyxalgo.h"
  42
  43 #include <cstdlib>
  44
  45 using namespace std;
  46
  47 namespace lyx {
  48
  49
  50 MathData::MathData(Buffer * buf, const_iterator from, const_iterator to)
  51         : base_type(from, to), minasc_(0), mindes_(0), slevel_(0),
  52           sshift_(0), kerning_(0), buffer_(buf)
  53 {}
  54
  55
  56 MathAtom & MathData::operator[](pos_type pos)
  57 {
  58         LBUFERR(pos < size());
  59         return base_type::operator[](pos);
  60 }
  61
  62
  63 MathAtom const & MathData::operator[](pos_type pos) const
  64 {
  65         LBUFERR(pos < size());
  66         return base_type::operator[](pos);
  67 }
  68
  69
  70 void MathData::insert(size_type pos, MathAtom const & t)
  71 {
  72         LBUFERR(pos <= size());
  73         base_type::insert(begin() + pos, t);
  74 }
  75
  76
  77 void MathData::insert(size_type pos, MathData const & ar)
  78 {
  79         LBUFERR(pos <= size());
  80         base_type::insert(begin() + pos, ar.begin(), ar.end());
  81 }
  82
  83
  84 void MathData::append(MathData const & ar)
  85 {
  86         insert(size(), ar);
  87 }
  88
  89
  90 void MathData::erase(size_type pos)
  91 {
  92         if (pos < size())
  93                 erase(pos, pos + 1);
  94 }
  95
  96
  97 void MathData::erase(iterator pos1, iterator pos2)
  98 {
  99         base_type::erase(pos1, pos2);
 100 }
 101
 102
 103 void MathData::erase(iterator pos)
 104 {
 105         base_type::erase(pos);
 106 }
 107
 108
 109 void MathData::erase(size_type pos1, size_type pos2)
 110 {
 111         base_type::erase(begin() + pos1, begin() + pos2);
 112 }
 113
 114
 115 void MathData::dump2() const
 116 {
 117         odocstringstream os;
 118         NormalStream ns(os);
 119         for (const_iterator it = begin(); it != end(); ++it)
 120                 ns << *it << ' ';
 121         lyxerr << to_utf8(os.str());
 122 }
 123
 124
 125 void MathData::dump() const
 126 {
 127         odocstringstream os;
 128         NormalStream ns(os);
 129         for (const_iterator it = begin(); it != end(); ++it)
 130                 ns << '<' << *it << '>';
 131         lyxerr << to_utf8(os.str());
 132 }
 133
 134
 135 void MathData::validate(LaTeXFeatures & features) const
 136 {
 137         for (const_iterator it = begin(); it != end(); ++it)
 138                 (*it)->validate(features);
 139 }
 140
 141
 142 bool MathData::match(MathData const & ar) const
 143 {
 144         return size() == ar.size() && matchpart(ar, 0);
 145 }
 146
 147
 148 bool MathData::matchpart(MathData const & ar, pos_type pos) const
 149 {
 150         if (size() < ar.size() + pos)
 151                 return false;
 152         const_iterator it = begin() + pos;
 153         for (const_iterator jt = ar.begin(); jt != ar.end(); ++jt, ++it)
 154                 if (asString(*it) != asString(*jt))
 155                         return false;
 156         return true;
 157 }
 158
 159
 160 void MathData::replace(ReplaceData & rep)
 161 {
 162         for (size_type i = 0; i < size(); ++i) {
 163                 if (find1(rep.from, i)) {
 164                         // match found
 165                         lyxerr << "match found!" << endl;
 166                         erase(i, i + rep.from.size());
 167                         insert(i, rep.to);
 168                 }
 169         }
 170
 171         // FIXME: temporarily disabled
 172         // for (const_iterator it = begin(); it != end(); ++it)
 173         //      it->nucleus()->replace(rep);
 174 }
 175
 176
 177 bool MathData::find1(MathData const & ar, size_type pos) const
 178 {
 179         lyxerr << "finding '" << ar << "' in '" << *this << "'" << endl;
 180         for (size_type i = 0, n = ar.size(); i < n; ++i)
 181                 if (asString(operator[](pos + i)) != asString(ar[i]))
 182                         return false;
 183         return true;
 184 }
 185
 186
 187 MathData::size_type MathData::find(MathData const & ar) const
 188 {
 189         for (int i = 0, last = size() - ar.size(); i < last; ++i)
 190                 if (find1(ar, i))
 191                         return i;
 192         return size();
 193 }
 194
 195
 196 MathData::size_type MathData::find_last(MathData const & ar) const
 197 {
 198         for (int i = size() - ar.size(); i >= 0; --i)
 199                 if (find1(ar, i))
 200                         return i;
 201         return size();
 202 }
 203
 204
 205 bool MathData::contains(MathData const & ar) const
 206 {
 207         if (find(ar) != size())
 208                 return true;
 209         for (const_iterator it = begin(); it != end(); ++it)
 210                 if ((*it)->contains(ar))
 211                         return true;
 212         return false;
 213 }
 214
 215
 216 void MathData::touch() const
 217 {
 218 }
 219
 220
 221 #if 0
 222 namespace {
 223
 224 bool isInside(DocIterator const & it, MathData const & ar,
 225         pos_type p1, pos_type p2)
 226 {
 227         for (size_t i = 0; i != it.depth(); ++i) {
 228                 CursorSlice const & sl = it[i];
 229                 if (sl.inset().inMathed() && &sl.cell() == &ar)
 230                         return p1 <= sl.pos() && sl.pos() < p2;
 231         }
 232         return false;
 233 }
 234
 235 }
 236 #endif
 237
 238
 239 void MathData::metrics(MetricsInfo & mi, Dimension & dim) const
 240 {
 241         frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
 242         dim = fm.dimension('I');
 243         int xascent = fm.dimension('x').ascent();
 244         if (xascent >= dim.asc)
 245                 xascent = (2 * dim.asc) / 3;
 246         minasc_ = xascent;
 247         mindes_ = (3 * xascent) / 4;
 248         slevel_ = (4 * xascent) / 5;
 249         sshift_ = xascent / 4;
 250         kerning_ = 0;
 251
 252         if (empty()) {
 253                 // Cache the dimension.
 254                 mi.base.bv->coordCache().arrays().add(this, dim);
 255                 return;
 256         }
 257
 258         Cursor & cur = mi.base.bv->cursor();
 259         const_cast<MathData*>(this)->updateMacros(&cur, mi.macrocontext, InternalUpdate);
 260
 261         DocIterator const & inlineCompletionPos = mi.base.bv->inlineCompletionPos();
 262         MathData const * inlineCompletionData = 0;
 263         if (inlineCompletionPos.inMathed())
 264                 inlineCompletionData = &inlineCompletionPos.cell();
 265
 266         dim.asc = 0;
 267         dim.wid = 0;
 268         Dimension d;
 269         CoordCache::Insets & coords = mi.base.bv->coordCache().insets();
 270         for (pos_type i = 0, n = size(); i != n; ++i) {
 271                 MathAtom const & at = operator[](i);
 272                 at->metrics(mi, d);
 273                 coords.add(at.nucleus(), d);
 274                 dim += d;
 275                 if (i == n - 1)
 276                         kerning_ = at->kerning(mi.base.bv);
 277
 278                 // HACK to draw completion suggestion inline
 279                 if (inlineCompletionData != this
 280                     || size_t(inlineCompletionPos.pos()) != i + 1)
 281                         continue;
 282
 283                 docstring const & completion = mi.base.bv->inlineCompletion();
 284                 if (completion.length() == 0)
 285                         continue;
 286
 287                 FontInfo font = mi.base.font;
 288                 augmentFont(font, from_ascii("mathnormal"));
 289                 dim.wid += mathed_string_width(font, completion);
 290         }
 291         // Cache the dimension.
 292         mi.base.bv->coordCache().arrays().add(this, dim);
 293 }
 294
 295
 296 void MathData::draw(PainterInfo & pi, int x, int y) const
 297 {
 298         //lyxerr << "MathData::draw: x: " << x << " y: " << y << endl;
 299         BufferView & bv  = *pi.base.bv;
 300         setXY(bv, x, y);
 301
 302         Dimension const & dim = bv.coordCache().getArrays().dim(this);
 303
 304         if (empty()) {
 305                 pi.pain.rectangle(x, y - dim.ascent(), dim.width(), dim.height(), Color_mathline);
 306                 return;
 307         }
 308
 309         // don't draw outside the workarea
 310         if (y + dim.descent() <= 0
 311                 || y - dim.ascent() >= bv.workHeight()
 312                 || x + dim.width() <= 0
 313                 || x >= bv. workWidth())
 314                 return;
 315
 316         DocIterator const & inlineCompletionPos = bv.inlineCompletionPos();
 317         MathData const * inlineCompletionData = 0;
 318         if (inlineCompletionPos.inMathed())
 319                 inlineCompletionData = &inlineCompletionPos.cell();
 320
 321         CoordCache::Insets & coords = pi.base.bv->coordCache().insets();
 322         for (size_t i = 0, n = size(); i != n; ++i) {
 323                 MathAtom const & at = operator[](i);
 324                 coords.add(at.nucleus(), x, y);
 325                 at->drawSelection(pi, x, y);
 326                 at->draw(pi, x, y);
 327                 x += coords.dim(at.nucleus()).wid;
 328
 329                 // Is the inline completion here?
 330                 if (inlineCompletionData != this
 331                     || size_t(inlineCompletionPos.pos()) != i + 1)
 332                         continue;
 333                 docstring const & completion = bv.inlineCompletion();
 334                 if (completion.length() == 0)
 335                         continue;
 336                 FontInfo f = pi.base.font;
 337                 augmentFont(f, from_ascii("mathnormal"));
 338
 339                 // draw the unique and the non-unique completion part
 340                 // Note: this is not time-critical as it is
 341                 // only done once per screen.
 342                 size_t uniqueTo = bv.inlineCompletionUniqueChars();
 343                 docstring s1 = completion.substr(0, uniqueTo);
 344                 docstring s2 = completion.substr(uniqueTo);
 345
 346                 if (!s1.empty()) {
 347                         f.setColor(Color_inlinecompletion);
 348                         pi.pain.text(x, y, s1, f);
 349                         x += mathed_string_width(f, s1);
 350                 }
 351
 352                 if (!s2.empty()) {
 353                         f.setColor(Color_nonunique_inlinecompletion);
 354                         pi.pain.text(x, y, s2, f);
 355                         x += mathed_string_width(f, s2);
 356                 }
 357         }
 358 }
 359
 360
 361 void MathData::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
 362 {
 363         dim.clear();
 364         Dimension d;
 365         for (const_iterator it = begin(); it != end(); ++it) {
 366                 (*it)->metricsT(mi, d);
 367                 dim += d;
 368         }
 369 }
 370
 371
 372 void MathData::drawT(TextPainter & pain, int x, int y) const
 373 {
 374         //lyxerr << "x: " << x << " y: " << y << ' ' << pain.workAreaHeight() << endl;
 375
 376         // FIXME: Abdel 16/10/2006
 377         // This drawT() method is never used, this is dead code.
 378
 379         for (const_iterator it = begin(), et = end(); it != et; ++it) {
 380                 (*it)->drawT(pain, x, y);
 381                 //x += (*it)->width_;
 382                 x += 2;
 383         }
 384 }
 385
 386
 387 void MathData::updateBuffer(ParIterator const & it, UpdateType utype)
 388 {
 389         // pass down
 390         for (size_t i = 0, n = size(); i != n; ++i) {
 391                 MathAtom & at = operator[](i);
 392                 at.nucleus()->updateBuffer(it, utype);
 393         }
 394 }
 395
 396
 397 void MathData::updateMacros(Cursor * cur, MacroContext const & mc,
 398                 UpdateType utype)
 399 {
 400         // If we are editing a macro, we cannot update it immediately,
 401         // otherwise wrong undo steps will be recorded (bug 6208).
 402         InsetMath const * inmath = cur ? cur->inset().asInsetMath() : 0;
 403         MathMacro const * inmacro = inmath ? inmath->asMacro() : 0;
 404         docstring const edited_name = inmacro ? inmacro->name() : docstring();
 405
 406         // go over the array and look for macros
 407         for (size_t i = 0; i < size(); ++i) {
 408                 MathMacro * macroInset = operator[](i).nucleus()->asMacro();
 409                 if (!macroInset || macroInset->macroName().empty()
 410                                 || macroInset->macroName()[0] == '^'
 411                                 || macroInset->macroName()[0] == '_'
 412                                 || (macroInset->name() == edited_name
 413                                     && macroInset->displayMode() ==
 414                                                 MathMacro::DISPLAY_UNFOLDED))
 415                         continue;
 416
 417                 // get macro
 418                 macroInset->updateMacro(mc);
 419                 size_t macroNumArgs = 0;
 420                 size_t macroOptionals = 0;
 421                 MacroData const * macro = macroInset->macro();
 422                 if (macro) {
 423                         macroNumArgs = macro->numargs();
 424                         macroOptionals = macro->optionals();
 425                 }
 426
 427                 // store old and compute new display mode
 428                 MathMacro::DisplayMode newDisplayMode;
 429                 MathMacro::DisplayMode oldDisplayMode = macroInset->displayMode();
 430                 newDisplayMode = macroInset->computeDisplayMode();
 431
 432                 // arity changed or other reason to detach?
 433                 if (oldDisplayMode == MathMacro::DISPLAY_NORMAL
 434                     && (macroInset->arity() != macroNumArgs
 435                         || macroInset->optionals() != macroOptionals
 436                         || newDisplayMode == MathMacro::DISPLAY_UNFOLDED))
 437                         detachMacroParameters(cur, i);
 438
 439                 // the macro could have been copied while resizing this
 440                 macroInset = operator[](i).nucleus()->asMacro();
 441
 442                 // Cursor in \label?
 443                 if (newDisplayMode != MathMacro::DISPLAY_UNFOLDED
 444                     && oldDisplayMode == MathMacro::DISPLAY_UNFOLDED) {
 445                         // put cursor in front of macro
 446                         if (cur) {
 447                                 int macroSlice = cur->find(macroInset);
 448                                 if (macroSlice != -1)
 449                                         cur->cutOff(macroSlice - 1);
 450                         }
 451                 }
 452
 453                 // update the display mode
 454                 size_t appetite = macroInset->appetite();
 455                 macroInset->setDisplayMode(newDisplayMode);
 456
 457                 // arity changed?
 458                 if (newDisplayMode == MathMacro::DISPLAY_NORMAL
 459                     && (macroInset->arity() != macroNumArgs
 460                         || macroInset->optionals() != macroOptionals)) {
 461                         // is it a virgin macro which was never attached to parameters?
 462                         bool fromInitToNormalMode
 463                         = (oldDisplayMode == MathMacro::DISPLAY_INIT
 464                            || oldDisplayMode == MathMacro::DISPLAY_INTERACTIVE_INIT)
 465                           && newDisplayMode == MathMacro::DISPLAY_NORMAL;
 466
 467                         // if the macro was entered interactively (i.e. not by paste or during
 468                         // loading), it should not be greedy, but the cursor should
 469                         // automatically jump into the macro when behind
 470                         bool interactive = (oldDisplayMode == MathMacro::DISPLAY_INTERACTIVE_INIT);
 471
 472                         // attach parameters
 473                         attachMacroParameters(cur, i, macroNumArgs, macroOptionals,
 474                                 fromInitToNormalMode, interactive, appetite);
 475
 476                         if (cur)
 477                                 cur->updateInsets(&cur->bottom().inset());
 478                 }
 479
 480                 // Give macro the chance to adapt to new situation.
 481                 // The macroInset could be invalid now because it was put into a script
 482                 // inset and therefore "deep" copied. So get it again from the MathData.
 483                 InsetMath * inset = operator[](i).nucleus();
 484                 if (inset->asScriptInset())
 485                         inset = inset->asScriptInset()->nuc()[0].nucleus();
 486                 LASSERT(inset->asMacro(), continue);
 487                 inset->asMacro()->updateRepresentation(cur, mc, utype);
 488         }
 489 }
 490
 491
 492 void MathData::detachMacroParameters(DocIterator * cur, const size_type macroPos)
 493 {
 494         MathMacro * macroInset = operator[](macroPos).nucleus()->asMacro();
 495         // We store this now, because the inset pointer will be invalidated in the scond loop below
 496         size_t const optionals = macroInset->optionals();
 497
 498         // detach all arguments
 499         vector<MathData> detachedArgs;
 500         if (macroPos + 1 == size())
 501                 // strip arguments if we are at the MathData end
 502                 macroInset->detachArguments(detachedArgs, true);
 503         else
 504                 macroInset->detachArguments(detachedArgs, false);
 505
 506         // find cursor slice
 507         int curMacroSlice = -1;
 508         if (cur)
 509                 curMacroSlice = cur->find(macroInset);
 510         idx_type curMacroIdx = -1;
 511         pos_type curMacroPos = -1;
 512         vector<CursorSlice> argSlices;
 513         if (curMacroSlice != -1) {
 514                 curMacroPos = (*cur)[curMacroSlice].pos();
 515                 curMacroIdx = (*cur)[curMacroSlice].idx();
 516                 cur->cutOff(curMacroSlice, argSlices);
 517                 cur->pop_back();
 518         }
 519
 520         // only [] after the last non-empty argument can be dropped later
 521         size_t lastNonEmptyOptional = 0;
 522         for (size_t l = 0; l < detachedArgs.size() && l < optionals; ++l) {
 523                 if (!detachedArgs[l].empty())
 524                         lastNonEmptyOptional = l;
 525         }
 526
 527         // optional arguments to be put back?
 528         pos_type p = macroPos + 1;
 529         size_t j = 0;
 530         // WARNING: do not use macroInset below, the insert() call in the lopp will invalidate it!
 531         for (; j < detachedArgs.size() && j < optionals; ++j) {
 532                 // another non-empty parameter follows?
 533                 bool canDropEmptyOptional = j >= lastNonEmptyOptional;
 534
 535                 // then we can drop empty optional parameters
 536                 if (detachedArgs[j].empty() && canDropEmptyOptional) {
 537                         if (curMacroIdx == j)
 538                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 1;
 539                         continue;
 540                 }
 541
 542                 // Otherwise we don't drop an empty optional, put it back normally
 543                 MathData optarg;
 544                 asArray(from_ascii("[]"), optarg);
 545                 MathData & arg = detachedArgs[j];
 546
 547                 // look for "]", i.e. put a brace around?
 548                 InsetMathBrace * brace = 0;
 549                 for (size_t q = 0; q < arg.size(); ++q) {
 550                         if (arg[q]->getChar() == ']') {
 551                                 // put brace
 552                                 brace = new InsetMathBrace(buffer_);
 553                                 break;
 554                         }
 555                 }
 556
 557                 // put arg between []
 558                 if (brace) {
 559                         brace->cell(0) = arg;
 560                         optarg.insert(1, MathAtom(brace));
 561                 } else
 562                         optarg.insert(1, arg);
 563
 564                 // insert it into the array
 565                 insert(p, optarg);
 566                 p += optarg.size();
 567
 568                 // cursor in macro?
 569                 if (curMacroSlice == -1)
 570                         continue;
 571
 572                 // cursor in optional argument of macro?
 573                 if (curMacroIdx == j) {
 574                         if (brace) {
 575                                 cur->append(0, curMacroPos);
 576                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 2;
 577                         } else
 578                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 2 + curMacroPos;
 579                         cur->append(argSlices);
 580                 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
 581                         // cursor right of macro
 582                         (*cur)[curMacroSlice - 1].pos() += optarg.size();
 583         }
 584
 585         // put them back into the MathData
 586         for (; j < detachedArgs.size(); ++j, ++p) {
 587                 MathData const & arg = detachedArgs[j];
 588                 if (arg.size() == 1
 589                     && !arg[0]->asScriptInset()
 590                     && !(arg[0]->asMacro() && arg[0]->asMacro()->arity() > 0))
 591                         insert(p, arg[0]);
 592                 else
 593                         insert(p, MathAtom(new InsetMathBrace(arg)));
 594
 595                 // cursor in macro?
 596                 if (curMacroSlice == -1)
 597                         continue;
 598
 599                 // cursor in j-th argument of macro?
 600                 if (curMacroIdx == j) {
 601                         if (operator[](p).nucleus()->asBraceInset()) {
 602                                 (*cur)[curMacroSlice - 1].pos() = p;
 603                                 cur->append(0, curMacroPos);
 604                                 cur->append(argSlices);
 605                         } else {
 606                                 (*cur)[curMacroSlice - 1].pos() = p; // + macroPos;
 607                                 cur->append(argSlices);
 608                         }
 609                 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
 610                         ++(*cur)[curMacroSlice - 1].pos();
 611         }
 612
 613         if (cur)
 614                 cur->updateInsets(&cur->bottom().inset());
 615 }
 616
 617
 618 void MathData::attachMacroParameters(Cursor * cur,
 619         const size_type macroPos, const size_type macroNumArgs,
 620         const int macroOptionals, const bool fromInitToNormalMode,
 621         const bool interactiveInit, const size_t appetite)
 622 {
 623         MathMacro * macroInset = operator[](macroPos).nucleus()->asMacro();
 624
 625         // start at atom behind the macro again, maybe with some new arguments
 626         // from the detach phase above, to add them back into the macro inset
 627         size_t p = macroPos + 1;
 628         vector<MathData> detachedArgs;
 629         MathAtom scriptToPutAround;
 630
 631         // find cursor slice again of this MathData
 632         int thisSlice = -1;
 633         if (cur)
 634                 thisSlice = cur->find(*this);
 635         int thisPos = -1;
 636         if (thisSlice != -1)
 637                 thisPos = (*cur)[thisSlice].pos();
 638
 639         // find arguments behind the macro
 640         if (!interactiveInit) {
 641                 collectOptionalParameters(cur, macroOptionals, detachedArgs, p,
 642                         scriptToPutAround, macroPos, thisPos, thisSlice);
 643         }
 644         collectParameters(cur, macroNumArgs, detachedArgs, p,
 645                 scriptToPutAround, macroPos, thisPos, thisSlice, appetite);
 646
 647         // attach arguments back to macro inset
 648         macroInset->attachArguments(detachedArgs, macroNumArgs, macroOptionals);
 649
 650         // found tail script? E.g. \foo{a}b^x
 651         if (scriptToPutAround.nucleus()) {
 652                 InsetMathScript * scriptInset =
 653                         scriptToPutAround.nucleus()->asScriptInset();
 654                 // In the math parser we remove empty braces in the base
 655                 // of a script inset, but we have to restore them here.
 656                 if (scriptInset->nuc().empty()) {
 657                         MathData ar;
 658                         scriptInset->nuc().push_back(
 659                                         MathAtom(new InsetMathBrace(ar)));
 660                 }
 661                 // put macro into a script inset
 662                 scriptInset->nuc()[0] = operator[](macroPos);
 663                 operator[](macroPos) = scriptToPutAround;
 664
 665                 // go into the script inset nucleus
 666                 if (cur && thisPos == int(macroPos))
 667                         cur->append(0, 0);
 668
 669                 // get pointer to "deep" copied macro inset
 670                 scriptInset = operator[](macroPos).nucleus()->asScriptInset();
 671                 macroInset = scriptInset->nuc()[0].nucleus()->asMacro();
 672         }
 673
 674         // remove them from the MathData
 675         erase(macroPos + 1, p);
 676
 677         // cursor outside this MathData?
 678         if (thisSlice == -1)
 679                 return;
 680
 681         // fix cursor if right of p
 682         if (thisPos >= int(p))
 683                 (*cur)[thisSlice].pos() -= p - (macroPos + 1);
 684
 685         // was the macro inset just inserted interactively and was now folded
 686         // and the cursor is just behind?
 687         if ((*cur)[thisSlice].pos() == int(macroPos + 1)
 688             && interactiveInit
 689             && fromInitToNormalMode
 690             && macroInset->arity() > 0
 691             && thisSlice + 1 == int(cur->depth())) {
 692                 // then enter it if the cursor was just behind
 693                 (*cur)[thisSlice].pos() = macroPos;
 694                 cur->push_back(CursorSlice(*macroInset));
 695                 macroInset->idxFirst(*cur);
 696         }
 697 }
 698
 699
 700 void MathData::collectOptionalParameters(Cursor * cur,
 701         const size_type numOptionalParams, vector<MathData> & params,
 702         size_t & pos, MathAtom & scriptToPutAround,
 703         const pos_type macroPos, const int thisPos, const int thisSlice)
 704 {
 705         Buffer * buf = cur ? cur->buffer() : 0;
 706         // insert optional arguments?
 707         while (params.size() < numOptionalParams
 708                && pos < size()
 709                && !scriptToPutAround.nucleus()) {
 710                 // is a [] block following which could be an optional parameter?
 711                 if (operator[](pos)->getChar() != '[')
 712                         break;
 713
 714                 // found possible optional argument, look for "]"
 715                 size_t right = pos + 1;
 716                 for (; right < size(); ++right) {
 717                         MathAtom & cell = operator[](right);
 718
 719                         if (cell->getChar() == ']')
 720                                 // found right end
 721                                 break;
 722
 723                         // maybe "]" with a script around?
 724                         InsetMathScript * script = cell.nucleus()->asScriptInset();
 725                         if (!script)
 726                                 continue;
 727                         if (script->nuc().size() != 1)
 728                                 continue;
 729                         if (script->nuc()[0]->getChar() == ']') {
 730                                 // script will be put around the macro later
 731                                 scriptToPutAround = cell;
 732                                 break;
 733                         }
 734                 }
 735
 736                 // found?
 737                 if (right >= size()) {
 738                         // no ] found, so it's not an optional argument
 739                         break;
 740                 }
 741
 742                 // add everything between [ and ] as optional argument
 743                 MathData optarg(buf, begin() + pos + 1, begin() + right);
 744
 745                 // a brace?
 746                 bool brace = false;
 747                 if (optarg.size() == 1 && optarg[0]->asBraceInset()) {
 748                         brace = true;
 749                         params.push_back(optarg[0]->asBraceInset()->cell(0));
 750                 } else
 751                         params.push_back(optarg);
 752
 753                 // place cursor in optional argument of macro
 754                 if (thisSlice != -1
 755                     && thisPos >= int(pos) && thisPos <= int(right)) {
 756                         int paramPos = max(0, thisPos - int(pos) - 1);
 757                         vector<CursorSlice> x;
 758                         cur->cutOff(thisSlice, x);
 759                         (*cur)[thisSlice].pos() = macroPos;
 760                         if (brace) {
 761                                 paramPos = x[0].pos();
 762                                 x.erase(x.begin());
 763                         }
 764                         cur->append(0, paramPos);
 765                         cur->append(x);
 766                 }
 767                 pos = right + 1;
 768         }
 769
 770         // fill up empty optional parameters
 771         while (params.size() < numOptionalParams)
 772                 params.push_back(MathData());
 773 }
 774
 775
 776 void MathData::collectParameters(Cursor * cur,
 777         const size_type numParams, vector<MathData> & params,
 778         size_t & pos, MathAtom & scriptToPutAround,
 779         const pos_type macroPos, const int thisPos, const int thisSlice,
 780         const size_t appetite)
 781 {
 782         size_t startSize = params.size();
 783
 784         // insert normal arguments
 785         while (params.size() < numParams
 786                && params.size() - startSize < appetite
 787                && pos < size()
 788                && !scriptToPutAround.nucleus()) {
 789                 MathAtom & cell = operator[](pos);
 790
 791                 // fix cursor
 792                 vector<CursorSlice> argSlices;
 793                 int argPos = 0;
 794                 if (thisSlice != -1 && thisPos == int(pos))
 795                         cur->cutOff(thisSlice, argSlices);
 796
 797                 // which kind of parameter is it? In {}? With index x^n?
 798                 InsetMathBrace const * brace = cell->asBraceInset();
 799                 if (brace) {
 800                         // found brace, convert into argument
 801                         params.push_back(brace->cell(0));
 802
 803                         // cursor inside of the brace or just in front of?
 804                         if (thisPos == int(pos) && !argSlices.empty()) {
 805                                 argPos = argSlices[0].pos();
 806                                 argSlices.erase(argSlices.begin());
 807                         }
 808                 } else if (cell->asScriptInset() && params.size() + 1 == numParams) {
 809                         // last inset with scripts without braces
 810                         // -> they belong to the macro, not the argument
 811                         InsetMathScript * script = cell.nucleus()->asScriptInset();
 812                         if (script->nuc().size() == 1 && script->nuc()[0]->asBraceInset())
 813                                 // nucleus in brace? Unpack!
 814                                 params.push_back(script->nuc()[0]->asBraceInset()->cell(0));
 815                         else
 816                                 params.push_back(script->nuc());
 817
 818                         // script will be put around below
 819                         scriptToPutAround = cell;
 820
 821                         // this should only happen after loading, so make cursor handling simple
 822                         if (thisPos >= int(macroPos) && thisPos <= int(macroPos + numParams)) {
 823                                 argSlices.clear();
 824                                 if (cur)
 825                                         cur->append(0, 0);
 826                         }
 827                 } else {
 828                         // the simplest case: plain inset
 829                         MathData array;
 830                         array.insert(0, cell);
 831                         params.push_back(array);
 832                 }
 833
 834                 // put cursor in argument again
 835                 if (thisSlice != - 1 && thisPos == int(pos)) {
 836                         cur->append(params.size() - 1, argPos);
 837                         cur->append(argSlices);
 838                         (*cur)[thisSlice].pos() = macroPos;
 839                 }
 840
 841                 ++pos;
 842         }
 843 }
 844
 845
 846 int MathData::pos2x(BufferView const * bv, size_type pos) const
 847 {
 848         return pos2x(bv, pos, 0);
 849 }
 850
 851
 852 int MathData::pos2x(BufferView const * bv, size_type pos, int glue) const
 853 {
 854         int x = 0;
 855         size_type target = min(pos, size());
 856         CoordCache::Insets const & coords = bv->coordCache().getInsets();
 857         for (size_type i = 0; i < target; ++i) {
 858                 const_iterator it = begin() + i;
 859                 if ((*it)->getChar() == ' ')
 860                         x += glue;
 861                 //lyxerr << "char: " << (*it)->getChar()
 862                 //      << "width: " << (*it)->width() << endl;
 863                 x += coords.dim((*it).nucleus()).wid;
 864         }
 865         return x;
 866 }
 867
 868
 869 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx) const
 870 {
 871         return x2pos(bv, targetx, 0);
 872 }
 873
 874
 875 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx, int glue) const
 876 {
 877         const_iterator it = begin();
 878         int lastx = 0;
 879         int currx = 0;
 880         CoordCache::Insets const & coords = bv->coordCache().getInsets();
 881         // find first position after targetx
 882         for (; currx < targetx && it != end(); ++it) {
 883                 lastx = currx;
 884                 if ((*it)->getChar() == ' ')
 885                         currx += glue;
 886                 currx += coords.dim((*it).nucleus()).wid;
 887         }
 888
 889         /**
 890          * If we are not at the beginning of the array, go to the left
 891          * of the inset if one of the following two condition holds:
 892          * - the current inset is editable (so that the cursor tip is
 893          *   deeper than us): in this case, we want all intermediate
 894          *   cursor slices to be before insets;
 895          * - the mouse is closer to the left side of the inset than to
 896          *   the right one.
 897          * See bug 1918 for details.
 898          **/
 899         if (it != begin() && currx >= targetx
 900             && ((*prev(it, 1))->asNestInset()
 901                 || abs(lastx - targetx) < abs(currx - targetx))) {
 902                 --it;
 903         }
 904
 905         return it - begin();
 906 }
 907
 908
 909 int MathData::dist(BufferView const & bv, int x, int y) const
 910 {
 911         return bv.coordCache().getArrays().squareDistance(this, x, y);
 912 }
 913
 914
 915 void MathData::setXY(BufferView & bv, int x, int y) const
 916 {
 917         //lyxerr << "setting position cache for MathData " << this << endl;
 918         bv.coordCache().arrays().add(this, x, y);
 919 }
 920
 921
 922 Dimension const & MathData::dimension(BufferView const & bv) const
 923 {
 924         return bv.coordCache().getArrays().dim(this);
 925 }
 926
 927
 928 int MathData::xm(BufferView const & bv) const
 929 {
 930         Geometry const & g = bv.coordCache().getArrays().geometry(this);
 931
 932         return g.pos.x_ + g.dim.wid / 2;
 933 }
 934
 935
 936 int MathData::ym(BufferView const & bv) const
 937 {
 938         Geometry const & g = bv.coordCache().getArrays().geometry(this);
 939
 940         return g.pos.y_ + (g.dim.des - g.dim.asc) / 2;
 941 }
 942
 943
 944 int MathData::xo(BufferView const & bv) const
 945 {
 946         return bv.coordCache().getArrays().x(this);
 947 }
 948
 949
 950 int MathData::yo(BufferView const & bv) const
 951 {
 952         return bv.coordCache().getArrays().y(this);
 953 }
 954
 955
 956 ostream & operator<<(ostream & os, MathData const & ar)
 957 {
 958         odocstringstream oss;
 959         NormalStream ns(oss);
 960         ns << ar;
 961         return os << to_utf8(oss.str());
 962 }
 963
 964
 965 odocstream & operator<<(odocstream & os, MathData const & ar)
 966 {
 967         NormalStream ns(os);
 968         ns << ar;
 969         return os;
 970 }
 971
 972
 973 } // namespace lyx