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
 496         // detach all arguments
 497         vector<MathData> detachedArgs;
 498         if (macroPos + 1 == size())
 499                 // strip arguments if we are at the MathData end
 500                 macroInset->detachArguments(detachedArgs, true);
 501         else
 502                 macroInset->detachArguments(detachedArgs, false);
 503
 504         // find cursor slice
 505         int curMacroSlice = -1;
 506         if (cur)
 507                 curMacroSlice = cur->find(macroInset);
 508         idx_type curMacroIdx = -1;
 509         pos_type curMacroPos = -1;
 510         vector<CursorSlice> argSlices;
 511         if (curMacroSlice != -1) {
 512                 curMacroPos = (*cur)[curMacroSlice].pos();
 513                 curMacroIdx = (*cur)[curMacroSlice].idx();
 514                 cur->cutOff(curMacroSlice, argSlices);
 515                 cur->pop_back();
 516         }
 517
 518         // only [] after the last non-empty argument can be dropped later
 519         size_t lastNonEmptyOptional = 0;
 520         for (size_t l = 0; l < detachedArgs.size() && l < macroInset->optionals(); ++l) {
 521                 if (!detachedArgs[l].empty())
 522                         lastNonEmptyOptional = l;
 523         }
 524
 525         // optional arguments to be put back?
 526         pos_type p = macroPos + 1;
 527         size_t j = 0;
 528         for (; j < detachedArgs.size() && j < macroInset->optionals(); ++j) {
 529                 // another non-empty parameter follows?
 530                 bool canDropEmptyOptional = j >= lastNonEmptyOptional;
 531
 532                 // then we can drop empty optional parameters
 533                 if (detachedArgs[j].empty() && canDropEmptyOptional) {
 534                         if (curMacroIdx == j)
 535                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 1;
 536                         continue;
 537                 }
 538
 539                 // Otherwise we don't drop an empty optional, put it back normally
 540                 MathData optarg;
 541                 asArray(from_ascii("[]"), optarg);
 542                 MathData & arg = detachedArgs[j];
 543
 544                 // look for "]", i.e. put a brace around?
 545                 InsetMathBrace * brace = 0;
 546                 for (size_t q = 0; q < arg.size(); ++q) {
 547                         if (arg[q]->getChar() == ']') {
 548                                 // put brace
 549                                 brace = new InsetMathBrace(buffer_);
 550                                 break;
 551                         }
 552                 }
 553
 554                 // put arg between []
 555                 if (brace) {
 556                         brace->cell(0) = arg;
 557                         optarg.insert(1, MathAtom(brace));
 558                 } else
 559                         optarg.insert(1, arg);
 560
 561                 // insert it into the array
 562                 insert(p, optarg);
 563                 p += optarg.size();
 564
 565                 // cursor in macro?
 566                 if (curMacroSlice == -1)
 567                         continue;
 568
 569                 // cursor in optional argument of macro?
 570                 if (curMacroIdx == j) {
 571                         if (brace) {
 572                                 cur->append(0, curMacroPos);
 573                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 2;
 574                         } else
 575                                 (*cur)[curMacroSlice - 1].pos() = macroPos + 2 + curMacroPos;
 576                         cur->append(argSlices);
 577                 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
 578                         // cursor right of macro
 579                         (*cur)[curMacroSlice - 1].pos() += optarg.size();
 580         }
 581
 582         // put them back into the MathData
 583         for (; j < detachedArgs.size(); ++j, ++p) {
 584                 MathData const & arg = detachedArgs[j];
 585                 if (arg.size() == 1
 586                     && !arg[0]->asScriptInset()
 587                     && !(arg[0]->asMacro() && arg[0]->asMacro()->arity() > 0))
 588                         insert(p, arg[0]);
 589                 else
 590                         insert(p, MathAtom(new InsetMathBrace(arg)));
 591
 592                 // cursor in macro?
 593                 if (curMacroSlice == -1)
 594                         continue;
 595
 596                 // cursor in j-th argument of macro?
 597                 if (curMacroIdx == j) {
 598                         if (operator[](p).nucleus()->asBraceInset()) {
 599                                 (*cur)[curMacroSlice - 1].pos() = p;
 600                                 cur->append(0, curMacroPos);
 601                                 cur->append(argSlices);
 602                         } else {
 603                                 (*cur)[curMacroSlice - 1].pos() = p; // + macroPos;
 604                                 cur->append(argSlices);
 605                         }
 606                 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
 607                         ++(*cur)[curMacroSlice - 1].pos();
 608         }
 609
 610         if (cur)
 611                 cur->updateInsets(&cur->bottom().inset());
 612 }
 613
 614
 615 void MathData::attachMacroParameters(Cursor * cur,
 616         const size_type macroPos, const size_type macroNumArgs,
 617         const int macroOptionals, const bool fromInitToNormalMode,
 618         const bool interactiveInit, const size_t appetite)
 619 {
 620         MathMacro * macroInset = operator[](macroPos).nucleus()->asMacro();
 621
 622         // start at atom behind the macro again, maybe with some new arguments
 623         // from the detach phase above, to add them back into the macro inset
 624         size_t p = macroPos + 1;
 625         vector<MathData> detachedArgs;
 626         MathAtom scriptToPutAround;
 627
 628         // find cursor slice again of this MathData
 629         int thisSlice = -1;
 630         if (cur)
 631                 thisSlice = cur->find(*this);
 632         int thisPos = -1;
 633         if (thisSlice != -1)
 634                 thisPos = (*cur)[thisSlice].pos();
 635
 636         // find arguments behind the macro
 637         if (!interactiveInit) {
 638                 collectOptionalParameters(cur, macroOptionals, detachedArgs, p,
 639                         scriptToPutAround, macroPos, thisPos, thisSlice);
 640         }
 641         collectParameters(cur, macroNumArgs, detachedArgs, p,
 642                 scriptToPutAround, macroPos, thisPos, thisSlice, appetite);
 643
 644         // attach arguments back to macro inset
 645         macroInset->attachArguments(detachedArgs, macroNumArgs, macroOptionals);
 646
 647         // found tail script? E.g. \foo{a}b^x
 648         if (scriptToPutAround.nucleus()) {
 649                 InsetMathScript * scriptInset =
 650                         scriptToPutAround.nucleus()->asScriptInset();
 651                 // In the math parser we remove empty braces in the base
 652                 // of a script inset, but we have to restore them here.
 653                 if (scriptInset->nuc().empty()) {
 654                         MathData ar;
 655                         scriptInset->nuc().push_back(
 656                                         MathAtom(new InsetMathBrace(ar)));
 657                 }
 658                 // put macro into a script inset
 659                 scriptInset->nuc()[0] = operator[](macroPos);
 660                 operator[](macroPos) = scriptToPutAround;
 661
 662                 // go into the script inset nucleus
 663                 if (cur && thisPos == int(macroPos))
 664                         cur->append(0, 0);
 665
 666                 // get pointer to "deep" copied macro inset
 667                 scriptInset = operator[](macroPos).nucleus()->asScriptInset();
 668                 macroInset = scriptInset->nuc()[0].nucleus()->asMacro();
 669         }
 670
 671         // remove them from the MathData
 672         erase(macroPos + 1, p);
 673
 674         // cursor outside this MathData?
 675         if (thisSlice == -1)
 676                 return;
 677
 678         // fix cursor if right of p
 679         if (thisPos >= int(p))
 680                 (*cur)[thisSlice].pos() -= p - (macroPos + 1);
 681
 682         // was the macro inset just inserted interactively and was now folded
 683         // and the cursor is just behind?
 684         if ((*cur)[thisSlice].pos() == int(macroPos + 1)
 685             && interactiveInit
 686             && fromInitToNormalMode
 687             && macroInset->arity() > 0
 688             && thisSlice + 1 == int(cur->depth())) {
 689                 // then enter it if the cursor was just behind
 690                 (*cur)[thisSlice].pos() = macroPos;
 691                 cur->push_back(CursorSlice(*macroInset));
 692                 macroInset->idxFirst(*cur);
 693         }
 694 }
 695
 696
 697 void MathData::collectOptionalParameters(Cursor * cur,
 698         const size_type numOptionalParams, vector<MathData> & params,
 699         size_t & pos, MathAtom & scriptToPutAround,
 700         const pos_type macroPos, const int thisPos, const int thisSlice)
 701 {
 702         Buffer * buf = cur ? cur->buffer() : 0;
 703         // insert optional arguments?
 704         while (params.size() < numOptionalParams
 705                && pos < size()
 706                && !scriptToPutAround.nucleus()) {
 707                 // is a [] block following which could be an optional parameter?
 708                 if (operator[](pos)->getChar() != '[')
 709                         break;
 710
 711                 // found possible optional argument, look for "]"
 712                 size_t right = pos + 1;
 713                 for (; right < size(); ++right) {
 714                         MathAtom & cell = operator[](right);
 715
 716                         if (cell->getChar() == ']')
 717                                 // found right end
 718                                 break;
 719
 720                         // maybe "]" with a script around?
 721                         InsetMathScript * script = cell.nucleus()->asScriptInset();
 722                         if (!script)
 723                                 continue;
 724                         if (script->nuc().size() != 1)
 725                                 continue;
 726                         if (script->nuc()[0]->getChar() == ']') {
 727                                 // script will be put around the macro later
 728                                 scriptToPutAround = cell;
 729                                 break;
 730                         }
 731                 }
 732
 733                 // found?
 734                 if (right >= size()) {
 735                         // no ] found, so it's not an optional argument
 736                         break;
 737                 }
 738
 739                 // add everything between [ and ] as optional argument
 740                 MathData optarg(buf, begin() + pos + 1, begin() + right);
 741
 742                 // a brace?
 743                 bool brace = false;
 744                 if (optarg.size() == 1 && optarg[0]->asBraceInset()) {
 745                         brace = true;
 746                         params.push_back(optarg[0]->asBraceInset()->cell(0));
 747                 } else
 748                         params.push_back(optarg);
 749
 750                 // place cursor in optional argument of macro
 751                 if (thisSlice != -1
 752                     && thisPos >= int(pos) && thisPos <= int(right)) {
 753                         int paramPos = max(0, thisPos - int(pos) - 1);
 754                         vector<CursorSlice> x;
 755                         cur->cutOff(thisSlice, x);
 756                         (*cur)[thisSlice].pos() = macroPos;
 757                         if (brace) {
 758                                 paramPos = x[0].pos();
 759                                 x.erase(x.begin());
 760                         }
 761                         cur->append(0, paramPos);
 762                         cur->append(x);
 763                 }
 764                 pos = right + 1;
 765         }
 766
 767         // fill up empty optional parameters
 768         while (params.size() < numOptionalParams)
 769                 params.push_back(MathData());
 770 }
 771
 772
 773 void MathData::collectParameters(Cursor * cur,
 774         const size_type numParams, vector<MathData> & params,
 775         size_t & pos, MathAtom & scriptToPutAround,
 776         const pos_type macroPos, const int thisPos, const int thisSlice,
 777         const size_t appetite)
 778 {
 779         size_t startSize = params.size();
 780
 781         // insert normal arguments
 782         while (params.size() < numParams
 783                && params.size() - startSize < appetite
 784                && pos < size()
 785                && !scriptToPutAround.nucleus()) {
 786                 MathAtom & cell = operator[](pos);
 787
 788                 // fix cursor
 789                 vector<CursorSlice> argSlices;
 790                 int argPos = 0;
 791                 if (thisSlice != -1 && thisPos == int(pos))
 792                         cur->cutOff(thisSlice, argSlices);
 793
 794                 // which kind of parameter is it? In {}? With index x^n?
 795                 InsetMathBrace const * brace = cell->asBraceInset();
 796                 if (brace) {
 797                         // found brace, convert into argument
 798                         params.push_back(brace->cell(0));
 799
 800                         // cursor inside of the brace or just in front of?
 801                         if (thisPos == int(pos) && !argSlices.empty()) {
 802                                 argPos = argSlices[0].pos();
 803                                 argSlices.erase(argSlices.begin());
 804                         }
 805                 } else if (cell->asScriptInset() && params.size() + 1 == numParams) {
 806                         // last inset with scripts without braces
 807                         // -> they belong to the macro, not the argument
 808                         InsetMathScript * script = cell.nucleus()->asScriptInset();
 809                         if (script->nuc().size() == 1 && script->nuc()[0]->asBraceInset())
 810                                 // nucleus in brace? Unpack!
 811                                 params.push_back(script->nuc()[0]->asBraceInset()->cell(0));
 812                         else
 813                                 params.push_back(script->nuc());
 814
 815                         // script will be put around below
 816                         scriptToPutAround = cell;
 817
 818                         // this should only happen after loading, so make cursor handling simple
 819                         if (thisPos >= int(macroPos) && thisPos <= int(macroPos + numParams)) {
 820                                 argSlices.clear();
 821                                 if (cur)
 822                                         cur->append(0, 0);
 823                         }
 824                 } else {
 825                         // the simplest case: plain inset
 826                         MathData array;
 827                         array.insert(0, cell);
 828                         params.push_back(array);
 829                 }
 830
 831                 // put cursor in argument again
 832                 if (thisSlice != - 1 && thisPos == int(pos)) {
 833                         cur->append(params.size() - 1, argPos);
 834                         cur->append(argSlices);
 835                         (*cur)[thisSlice].pos() = macroPos;
 836                 }
 837
 838                 ++pos;
 839         }
 840 }
 841
 842
 843 int MathData::pos2x(BufferView const * bv, size_type pos) const
 844 {
 845         return pos2x(bv, pos, 0);
 846 }
 847
 848
 849 int MathData::pos2x(BufferView const * bv, size_type pos, int glue) const
 850 {
 851         int x = 0;
 852         size_type target = min(pos, size());
 853         CoordCache::Insets const & coords = bv->coordCache().getInsets();
 854         for (size_type i = 0; i < target; ++i) {
 855                 const_iterator it = begin() + i;
 856                 if ((*it)->getChar() == ' ')
 857                         x += glue;
 858                 //lyxerr << "char: " << (*it)->getChar()
 859                 //      << "width: " << (*it)->width() << endl;
 860                 x += coords.dim((*it).nucleus()).wid;
 861         }
 862         return x;
 863 }
 864
 865
 866 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx) const
 867 {
 868         return x2pos(bv, targetx, 0);
 869 }
 870
 871
 872 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx, int glue) const
 873 {
 874         const_iterator it = begin();
 875         int lastx = 0;
 876         int currx = 0;
 877         CoordCache::Insets const & coords = bv->coordCache().getInsets();
 878         // find first position after targetx
 879         for (; currx < targetx && it != end(); ++it) {
 880                 lastx = currx;
 881                 if ((*it)->getChar() == ' ')
 882                         currx += glue;
 883                 currx += coords.dim((*it).nucleus()).wid;
 884         }
 885
 886         /**
 887          * If we are not at the beginning of the array, go to the left
 888          * of the inset if one of the following two condition holds:
 889          * - the current inset is editable (so that the cursor tip is
 890          *   deeper than us): in this case, we want all intermediate
 891          *   cursor slices to be before insets;
 892          * - the mouse is closer to the left side of the inset than to
 893          *   the right one.
 894          * See bug 1918 for details.
 895          **/
 896         if (it != begin() && currx >= targetx
 897             && ((*prev(it, 1))->asNestInset()
 898                 || abs(lastx - targetx) < abs(currx - targetx))) {
 899                 --it;
 900         }
 901
 902         return it - begin();
 903 }
 904
 905
 906 int MathData::dist(BufferView const & bv, int x, int y) const
 907 {
 908         return bv.coordCache().getArrays().squareDistance(this, x, y);
 909 }
 910
 911
 912 void MathData::setXY(BufferView & bv, int x, int y) const
 913 {
 914         //lyxerr << "setting position cache for MathData " << this << endl;
 915         bv.coordCache().arrays().add(this, x, y);
 916 }
 917
 918
 919 Dimension const & MathData::dimension(BufferView const & bv) const
 920 {
 921         return bv.coordCache().getArrays().dim(this);
 922 }
 923
 924
 925 int MathData::xm(BufferView const & bv) const
 926 {
 927         Geometry const & g = bv.coordCache().getArrays().geometry(this);
 928
 929         return g.pos.x_ + g.dim.wid / 2;
 930 }
 931
 932
 933 int MathData::ym(BufferView const & bv) const
 934 {
 935         Geometry const & g = bv.coordCache().getArrays().geometry(this);
 936
 937         return g.pos.y_ + (g.dim.des - g.dim.asc) / 2;
 938 }
 939
 940
 941 int MathData::xo(BufferView const & bv) const
 942 {
 943         return bv.coordCache().getArrays().x(this);
 944 }
 945
 946
 947 int MathData::yo(BufferView const & bv) const
 948 {
 949         return bv.coordCache().getArrays().y(this);
 950 }
 951
 952
 953 ostream & operator<<(ostream & os, MathData const & ar)
 954 {
 955         odocstringstream oss;
 956         NormalStream ns(oss);
 957         ns << ar;
 958         return os << to_utf8(oss.str());
 959 }
 960
 961
 962 odocstream & operator<<(odocstream & os, MathData const & ar)
 963 {
 964         NormalStream ns(os);
 965         ns << ar;
 966         return os;
 967 }
 968
 969
 970 } // namespace lyx