3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
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"
27 #include "BufferView.h"
28 #include "CoordCache.h"
31 #include "mathed/InsetMathUnknown.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
36 #include "frontends/FontMetrics.h"
37 #include "frontends/Painter.h"
39 #include <boost/assert.hpp>
40 #include <boost/next_prior.hpp>
49 MathData::MathData(const_iterator from, const_iterator to)
54 MathAtom & MathData::operator[](pos_type pos)
56 BOOST_ASSERT(pos < size());
57 return base_type::operator[](pos);
61 MathAtom const & MathData::operator[](pos_type pos) const
63 BOOST_ASSERT(pos < size());
64 return base_type::operator[](pos);
68 void MathData::insert(size_type pos, MathAtom const & t)
70 base_type::insert(begin() + pos, t);
74 void MathData::insert(size_type pos, MathData const & ar)
76 BOOST_ASSERT(pos <= size());
77 base_type::insert(begin() + pos, ar.begin(), ar.end());
81 void MathData::append(MathData const & ar)
87 void MathData::erase(size_type pos)
94 void MathData::erase(iterator pos1, iterator pos2)
96 base_type::erase(pos1, pos2);
100 void MathData::erase(iterator pos)
102 base_type::erase(pos);
106 void MathData::erase(size_type pos1, size_type pos2)
108 base_type::erase(begin() + pos1, begin() + pos2);
112 void MathData::dump2() const
116 for (const_iterator it = begin(); it != end(); ++it)
118 lyxerr << to_utf8(os.str());
122 void MathData::dump() const
126 for (const_iterator it = begin(); it != end(); ++it)
127 ns << '<' << *it << '>';
128 lyxerr << to_utf8(os.str());
132 void MathData::validate(LaTeXFeatures & features) const
134 for (const_iterator it = begin(); it != end(); ++it)
135 (*it)->validate(features);
139 bool MathData::match(MathData const & ar) const
141 return size() == ar.size() && matchpart(ar, 0);
145 bool MathData::matchpart(MathData const & ar, pos_type pos) const
147 if (size() < ar.size() + pos)
149 const_iterator it = begin() + pos;
150 for (const_iterator jt = ar.begin(); jt != ar.end(); ++jt, ++it)
151 if (asString(*it) != asString(*jt))
157 void MathData::replace(ReplaceData & rep)
159 for (size_type i = 0; i < size(); ++i) {
160 if (find1(rep.from, i)) {
162 lyxerr << "match found!" << endl;
163 erase(i, i + rep.from.size());
168 // FIXME: temporarily disabled
169 // for (const_iterator it = begin(); it != end(); ++it)
170 // it->nucleus()->replace(rep);
174 bool MathData::find1(MathData const & ar, size_type pos) const
176 lyxerr << "finding '" << ar << "' in '" << *this << "'" << endl;
177 for (size_type i = 0, n = ar.size(); i < n; ++i)
178 if (asString(operator[](pos + i)) != asString(ar[i]))
184 MathData::size_type MathData::find(MathData const & ar) const
186 for (int i = 0, last = size() - ar.size(); i < last; ++i)
193 MathData::size_type MathData::find_last(MathData const & ar) const
195 for (int i = size() - ar.size(); i >= 0; --i)
202 bool MathData::contains(MathData const & ar) const
204 if (find(ar) != size())
206 for (const_iterator it = begin(); it != end(); ++it)
207 if ((*it)->contains(ar))
213 void MathData::touch() const
220 bool isInside(DocIterator const & it, MathData const & ar,
221 pos_type p1, pos_type p2)
223 for (size_t i = 0; i != it.depth(); ++i) {
224 CursorSlice const & sl = it[i];
225 if (sl.inset().inMathed() && &sl.cell() == &ar)
226 return p1 <= sl.pos() && sl.pos() < p2;
235 void MathData::metrics(MetricsInfo & mi, Dimension & dim) const
237 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
238 dim = fm.dimension('I');
239 int xascent = fm.dimension('x').ascent();
240 if (xascent >= dim.asc)
241 xascent = (2 * dim.asc) / 3;
243 mindes_ = (3 * xascent) / 4;
244 slevel_ = (4 * xascent) / 5;
245 sshift_ = xascent / 4;
249 // Cache the dimension.
250 mi.base.bv->coordCache().arrays().add(this, dim);
254 Cursor & cur = mi.base.bv->cursor();
255 const_cast<MathData*>(this)->updateMacros(&cur, mi.macrocontext);
257 DocIterator const & inlineCompletionPos = mi.base.bv->inlineCompletionPos();
258 MathData const * inlineCompletionData = 0;
259 if (inlineCompletionPos.inMathed())
260 inlineCompletionData = &inlineCompletionPos.cell();
265 CoordCacheBase<Inset> & coords = mi.base.bv->coordCache().insets();
266 for (pos_type i = 0, n = size(); i != n; ++i) {
267 MathAtom const & at = operator[](i);
269 coords.add(at.nucleus(), d);
272 kerning_ = at->kerning(mi.base.bv);
274 // HACK to draw completion suggestion inline
275 if (inlineCompletionData != this
276 || size_t(inlineCompletionPos.pos()) != i + 1)
279 docstring const & completion = mi.base.bv->inlineCompletion();
280 if (completion.length() == 0)
283 dim.wid += mathed_string_width(mi.base.font, completion);
285 // Cache the dimension.
286 mi.base.bv->coordCache().arrays().add(this, dim);
290 void MathData::draw(PainterInfo & pi, int x, int y) const
292 //lyxerr << "MathData::draw: x: " << x << " y: " << y << endl;
293 BufferView & bv = *pi.base.bv;
296 Dimension const & dim = bv.coordCache().getArrays().dim(this);
299 pi.pain.rectangle(x, y - dim.ascent(), dim.width(), dim.height(), Color_mathline);
303 // don't draw outside the workarea
304 if (y + dim.descent() <= 0
305 || y - dim.ascent() >= bv.workHeight()
306 || x + dim.width() <= 0
307 || x >= bv. workWidth())
310 DocIterator const & inlineCompletionPos = bv.inlineCompletionPos();
311 MathData const * inlineCompletionData = 0;
312 if (inlineCompletionPos.inMathed())
313 inlineCompletionData = &inlineCompletionPos.cell();
315 CoordCacheBase<Inset> & coords = pi.base.bv->coordCache().insets();
316 for (size_t i = 0, n = size(); i != n; ++i) {
317 MathAtom const & at = operator[](i);
318 coords.add(at.nucleus(), x, y);
319 at->drawSelection(pi, x, y);
321 x += coords.dim(at.nucleus()).wid;
323 // Is the inline completion here?
324 if (inlineCompletionData != this
325 || size_t(inlineCompletionPos.pos()) != i + 1)
327 docstring const & completion = bv.inlineCompletion();
328 if (completion.length() == 0)
330 FontInfo f = pi.base.font;
332 // draw the unique and the non-unique completion part
333 // Note: this is not time-critical as it is
334 // only done once per screen.
335 size_t uniqueTo = bv.inlineCompletionUniqueChars();
336 docstring s1 = completion.substr(0, uniqueTo);
337 docstring s2 = completion.substr(uniqueTo);
340 f.setColor(Color_inlinecompletion);
341 pi.pain.text(x, y, s1, f);
342 x += mathed_string_width(f, s1);
346 f.setColor(Color_nonunique_inlinecompletion);
347 pi.pain.text(x, y, s2, f);
348 x += mathed_string_width(f, s2);
354 void MathData::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
358 for (const_iterator it = begin(); it != end(); ++it) {
359 (*it)->metricsT(mi, d);
365 void MathData::drawT(TextPainter & pain, int x, int y) const
367 //lyxerr << "x: " << x << " y: " << y << ' ' << pain.workAreaHeight() << endl;
369 // FIXME: Abdel 16/10/2006
370 // This drawT() method is never used, this is dead code.
372 for (const_iterator it = begin(), et = end(); it != et; ++it) {
373 (*it)->drawT(pain, x, y);
374 //x += (*it)->width_;
380 void MathData::updateMacros(Cursor * cur, MacroContext const & mc)
382 // go over the array and look for macros
383 for (size_t i = 0; i < size(); ++i) {
384 MathMacro * macroInset = operator[](i).nucleus()->asMacro();
389 macroInset->updateMacro(mc);
390 size_t macroNumArgs = 0;
391 size_t macroOptionals = 0;
392 MacroData const * macro = macroInset->macro();
394 macroNumArgs = macro->numargs();
395 macroOptionals = macro->optionals();
398 // store old and compute new display mode
399 MathMacro::DisplayMode newDisplayMode;
400 MathMacro::DisplayMode oldDisplayMode = macroInset->displayMode();
401 newDisplayMode = macroInset->computeDisplayMode();
403 // arity changed or other reason to detach?
404 if (oldDisplayMode == MathMacro::DISPLAY_NORMAL
405 && (macroInset->arity() != macroNumArgs
406 || macroInset->optionals() != macroOptionals
407 || newDisplayMode == MathMacro::DISPLAY_UNFOLDED)) {
409 detachMacroParameters(cur, i);
412 // the macro could have been copied while resizing this
413 macroInset = operator[](i).nucleus()->asMacro();
416 if (newDisplayMode != MathMacro::DISPLAY_UNFOLDED
417 && oldDisplayMode == MathMacro::DISPLAY_UNFOLDED) {
418 // put cursor in front of macro
420 int macroSlice = cur->find(macroInset);
421 if (macroSlice != -1)
422 cur->cutOff(macroSlice - 1);
426 // update the display mode
427 size_t appetite = macroInset->appetite();
428 macroInset->setDisplayMode(newDisplayMode);
431 if (newDisplayMode == MathMacro::DISPLAY_NORMAL
432 && (macroInset->arity() != macroNumArgs
433 || macroInset->optionals() != macroOptionals)) {
434 // is it a virgin macro which was never attached to parameters?
435 bool fromInitToNormalMode
436 = (oldDisplayMode == MathMacro::DISPLAY_INIT
437 || oldDisplayMode == MathMacro::DISPLAY_INTERACTIVE_INIT)
438 && newDisplayMode == MathMacro::DISPLAY_NORMAL;
440 // if the macro was entered interactively (i.e. not by paste or during
441 // loading), it should not be greedy, but the cursor should
442 // automatically jump into the macro when behind
443 bool interactive = (oldDisplayMode == MathMacro::DISPLAY_INTERACTIVE_INIT);
446 attachMacroParameters(cur, i, macroNumArgs, macroOptionals,
447 fromInitToNormalMode, interactive, appetite);
450 // FIXME: proper anchor handling, this removes the selection
451 cur->updateInsets(&cur->bottom().inset());
452 cur->clearSelection();
456 // Give macro the chance to adapt to new situation.
457 // The macroInset could be invalid now because it was put into a script
458 // inset and therefore "deep" copied. So get it again from the MathData.
459 InsetMath * inset = operator[](i).nucleus();
460 if (inset->asScriptInset())
461 inset = inset->asScriptInset()->nuc()[0].nucleus();
462 BOOST_ASSERT(inset->asMacro());
463 inset->asMacro()->updateRepresentation(cur);
468 void MathData::detachMacroParameters(Cursor * cur, const size_type macroPos)
470 MathMacro * macroInset = operator[](macroPos).nucleus()->asMacro();
472 // detach all arguments
473 vector<MathData> detachedArgs;
474 if (macroPos + 1 == size())
475 // strip arguments if we are at the MathData end
476 macroInset->detachArguments(detachedArgs, true);
478 macroInset->detachArguments(detachedArgs, false);
481 int curMacroSlice = -1;
483 curMacroSlice = cur->find(macroInset);
484 idx_type curMacroIdx = -1;
485 pos_type curMacroPos = -1;
486 vector<CursorSlice> argSlices;
487 if (curMacroSlice != -1) {
488 curMacroPos = (*cur)[curMacroSlice].pos();
489 curMacroIdx = (*cur)[curMacroSlice].idx();
490 cur->cutOff(curMacroSlice, argSlices);
494 // only [] after the last non-empty argument can be dropped later
495 size_t lastNonEmptyOptional = 0;
496 for (size_t l = 0; l < detachedArgs.size() && l < macroInset->optionals(); ++l) {
497 if (!detachedArgs[l].empty())
498 lastNonEmptyOptional = l;
501 // optional arguments to be put back?
502 pos_type p = macroPos + 1;
504 for (; j < detachedArgs.size() && j < macroInset->optionals(); ++j) {
505 // another non-empty parameter follows?
506 bool canDropEmptyOptional = j >= lastNonEmptyOptional;
508 // then we can drop empty optional parameters
509 if (detachedArgs[j].empty() && canDropEmptyOptional) {
510 if (curMacroIdx == j)
511 (*cur)[curMacroSlice - 1].pos() = macroPos + 1;
515 // Otherwise we don't drop an empty optional, put it back normally
517 asArray(from_ascii("[]"), optarg);
518 MathData & arg = detachedArgs[j];
520 // look for "]", i.e. put a brace around?
521 InsetMathBrace * brace = 0;
522 for (size_t q = 0; q < arg.size(); ++q) {
523 if (arg[q]->getChar() == ']') {
525 brace = new InsetMathBrace();
530 // put arg between []
532 brace->cell(0) = arg;
533 optarg.insert(1, MathAtom(brace));
535 optarg.insert(1, arg);
537 // insert it into the array
542 if (curMacroSlice == -1)
545 // cursor in optional argument of macro?
546 if (curMacroIdx == j) {
548 cur->append(0, curMacroPos);
549 (*cur)[curMacroSlice - 1].pos() = macroPos + 2;
551 (*cur)[curMacroSlice - 1].pos() = macroPos + 2 + curMacroPos;
552 cur->append(argSlices);
553 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
554 // cursor right of macro
555 (*cur)[curMacroSlice - 1].pos() += optarg.size();
558 // put them back into the MathData
559 for (; j < detachedArgs.size(); ++j, ++p) {
560 MathData const & arg = detachedArgs[j];
562 && !arg[0]->asScriptInset()
563 && !(arg[0]->asMacro() && arg[0]->asMacro()->arity() > 0))
566 insert(p, MathAtom(new InsetMathBrace(arg)));
569 if (curMacroSlice == -1)
572 // cursor in j-th argument of macro?
573 if (curMacroIdx == j) {
574 if (operator[](p).nucleus()->asBraceInset()) {
575 (*cur)[curMacroSlice - 1].pos() = p;
576 cur->append(0, curMacroPos);
577 cur->append(argSlices);
579 (*cur)[curMacroSlice - 1].pos() = p; // + macroPos;
580 cur->append(argSlices);
582 } else if ((*cur)[curMacroSlice - 1].pos() >= int(p))
583 ++(*cur)[curMacroSlice - 1].pos();
587 // FIXME: proper anchor handling, this removes the selection
588 cur->clearSelection();
589 cur->updateInsets(&cur->bottom().inset());
594 void MathData::attachMacroParameters(Cursor * cur,
595 const size_type macroPos, const size_type macroNumArgs,
596 const int macroOptionals, const bool fromInitToNormalMode,
597 const bool interactiveInit, const size_t appetite)
599 MathMacro * macroInset = operator[](macroPos).nucleus()->asMacro();
601 // start at atom behind the macro again, maybe with some new arguments
602 // from the detach phase above, to add them back into the macro inset
603 size_t p = macroPos + 1;
604 vector<MathData> detachedArgs;
605 MathAtom scriptToPutAround;
607 // find cursor slice again of this MathData
610 thisSlice = cur->find(*this);
613 thisPos = (*cur)[thisSlice].pos();
615 // find arguments behind the macro
616 if (!interactiveInit) {
617 collectOptionalParameters(cur, macroOptionals, detachedArgs, p,
618 scriptToPutAround, macroPos, thisPos, thisSlice);
620 collectParameters(cur, macroNumArgs, detachedArgs, p,
621 scriptToPutAround, macroPos, thisPos, thisSlice, appetite);
623 // attach arguments back to macro inset
624 macroInset->attachArguments(detachedArgs, macroNumArgs, macroOptionals);
626 // found tail script? E.g. \foo{a}b^x
627 if (scriptToPutAround.nucleus()) {
628 // put macro into a script inset
629 scriptToPutAround.nucleus()->asScriptInset()->nuc()[0]
630 = operator[](macroPos);
631 operator[](macroPos) = scriptToPutAround;
633 // go into the script inset nucleus
634 if (cur && thisPos == int(macroPos))
637 // get pointer to "deep" copied macro inset
638 InsetMathScript * scriptInset
639 = operator[](macroPos).nucleus()->asScriptInset();
640 macroInset = scriptInset->nuc()[0].nucleus()->asMacro();
643 // remove them from the MathData
644 erase(begin() + macroPos + 1, begin() + p);
646 // cursor outside this MathData?
650 // fix cursor if right of p
651 if (thisPos >= int(p))
652 (*cur)[thisSlice].pos() -= p - (macroPos + 1);
654 // was the macro inset just inserted interactively and was now folded
655 // and the cursor is just behind?
656 if ((*cur)[thisSlice].pos() == int(macroPos + 1)
658 && fromInitToNormalMode
659 && macroInset->arity() > 0
660 && thisSlice + 1 == int(cur->depth())) {
661 // then enter it if the cursor was just behind
662 (*cur)[thisSlice].pos() = macroPos;
663 cur->push_back(CursorSlice(*macroInset));
664 macroInset->idxFirst(*cur);
669 void MathData::collectOptionalParameters(Cursor * cur,
670 const size_type numOptionalParams, vector<MathData> & params,
671 size_t & pos, MathAtom & scriptToPutAround,
672 const pos_type macroPos, const int thisPos, const int thisSlice)
674 // insert optional arguments?
675 while (params.size() < numOptionalParams
677 && !scriptToPutAround.nucleus()) {
678 // is a [] block following which could be an optional parameter?
679 if (operator[](pos)->getChar() != '[')
682 // found possible optional argument, look for "]"
683 size_t right = pos + 1;
684 for (; right < size(); ++right) {
685 MathAtom & cell = operator[](right);
687 if (cell->getChar() == ']')
691 // maybe "]" with a script around?
692 InsetMathScript * script = cell.nucleus()->asScriptInset();
695 if (script->nuc().size() != 1)
697 if (script->nuc()[0]->getChar() == ']') {
698 // script will be put around the macro later
699 scriptToPutAround = cell;
705 if (right >= size()) {
706 // no ] found, so it's not an optional argument
710 // add everything between [ and ] as optional argument
711 MathData optarg(begin() + pos + 1, begin() + right);
715 if (optarg.size() == 1 && optarg[0]->asBraceInset()) {
717 params.push_back(optarg[0]->asBraceInset()->cell(0));
719 params.push_back(optarg);
721 // place cursor in optional argument of macro
723 && thisPos >= int(pos) && thisPos <= int(right)) {
724 int paramPos = max(0, thisPos - int(pos) - 1);
725 vector<CursorSlice> x;
726 cur->cutOff(thisSlice, x);
727 (*cur)[thisSlice].pos() = macroPos;
729 paramPos = x[0].pos();
732 cur->append(0, paramPos);
738 // fill up empty optional parameters
739 while (params.size() < numOptionalParams)
740 params.push_back(MathData());
744 void MathData::collectParameters(Cursor * cur,
745 const size_type numParams, vector<MathData> & params,
746 size_t & pos, MathAtom & scriptToPutAround,
747 const pos_type macroPos, const int thisPos, const int thisSlice,
748 const size_t appetite)
750 size_t startSize = params.size();
752 // insert normal arguments
753 while (params.size() < numParams
754 && params.size() - startSize < appetite
756 && !scriptToPutAround.nucleus()) {
757 MathAtom & cell = operator[](pos);
760 vector<CursorSlice> argSlices;
762 if (thisSlice != -1 && thisPos == int(pos))
763 cur->cutOff(thisSlice, argSlices);
765 // which kind of parameter is it? In {}? With index x^n?
766 InsetMathBrace const * brace = cell->asBraceInset();
768 // found brace, convert into argument
769 params.push_back(brace->cell(0));
771 // cursor inside of the brace or just in front of?
772 if (thisPos == int(pos) && !argSlices.empty()) {
773 argPos = argSlices[0].pos();
774 argSlices.erase(argSlices.begin());
776 } else if (cell->asScriptInset() && params.size() + 1 == numParams) {
777 // last inset with scripts without braces
778 // -> they belong to the macro, not the argument
779 InsetMathScript * script = cell.nucleus()->asScriptInset();
780 if (script->nuc().size() == 1 && script->nuc()[0]->asBraceInset())
781 // nucleus in brace? Unpack!
782 params.push_back(script->nuc()[0]->asBraceInset()->cell(0));
784 params.push_back(script->nuc());
786 // script will be put around below
787 scriptToPutAround = cell;
789 // this should only happen after loading, so make cursor handling simple
790 if (thisPos >= int(macroPos) && thisPos <= int(macroPos + numParams)) {
796 // the simplest case: plain inset
798 array.insert(0, cell);
799 params.push_back(array);
802 // put cursor in argument again
803 if (thisSlice != - 1 && thisPos == int(pos)) {
804 cur->append(params.size() - 1, argPos);
805 cur->append(argSlices);
806 (*cur)[thisSlice].pos() = macroPos;
814 int MathData::pos2x(BufferView const * bv, size_type pos) const
816 return pos2x(bv, pos, 0);
820 int MathData::pos2x(BufferView const * bv, size_type pos, int glue) const
823 size_type target = min(pos, size());
824 CoordCacheBase<Inset> const & coords = bv->coordCache().getInsets();
825 for (size_type i = 0; i < target; ++i) {
826 const_iterator it = begin() + i;
827 if ((*it)->getChar() == ' ')
829 //lyxerr << "char: " << (*it)->getChar()
830 // << "width: " << (*it)->width() << endl;
831 x += coords.dim((*it).nucleus()).wid;
837 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx) const
839 return x2pos(bv, targetx, 0);
843 MathData::size_type MathData::x2pos(BufferView const * bv, int targetx, int glue) const
845 const_iterator it = begin();
848 CoordCacheBase<Inset> const & coords = bv->coordCache().getInsets();
849 // find first position after targetx
850 for (; currx < targetx && it < end(); ++it) {
852 if ((*it)->getChar() == ' ')
854 currx += coords.dim((*it).nucleus()).wid;
858 * If we are not at the beginning of the array, go to the left
859 * of the inset if one of the following two condition holds:
860 * - the current inset is editable (so that the cursor tip is
861 * deeper than us): in this case, we want all intermediate
862 * cursor slices to be before insets;
863 * - the mouse is closer to the left side of the inset than to
865 * See bug 1918 for details.
867 if (it != begin() && currx >= targetx
868 && ((*boost::prior(it))->asNestInset()
869 || abs(lastx - targetx) < abs(currx - targetx))) {
877 int MathData::dist(BufferView const & bv, int x, int y) const
879 return bv.coordCache().getArrays().squareDistance(this, x, y);
883 void MathData::setXY(BufferView & bv, int x, int y) const
885 //lyxerr << "setting position cache for MathData " << this << endl;
886 bv.coordCache().arrays().add(this, x, y);
890 Dimension const & MathData::dimension(BufferView const & bv) const
892 return bv.coordCache().getArrays().dim(this);
896 int MathData::xm(BufferView const & bv) const
898 Geometry const & g = bv.coordCache().getArrays().geometry(this);
900 return g.pos.x_ + g.dim.wid / 2;
904 int MathData::ym(BufferView const & bv) const
906 Geometry const & g = bv.coordCache().getArrays().geometry(this);
908 return g.pos.y_ + (g.dim.des - g.dim.asc) / 2;
912 int MathData::xo(BufferView const & bv) const
914 return bv.coordCache().getArrays().x(this);
918 int MathData::yo(BufferView const & bv) const
920 return bv.coordCache().getArrays().y(this);
924 ostream & operator<<(ostream & os, MathData const & ar)
926 odocstringstream oss;
927 NormalStream ns(oss);
929 return os << to_utf8(oss.str());
933 odocstream & operator<<(odocstream & os, MathData const & ar)