]> git.lyx.org Git - lyx.git/blob - src/mathed/InsetMathNest.cpp
Refactor OutputParams
[lyx.git] / src / mathed / InsetMathNest.cpp
1 /**
2  * \file InsetMathNest.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  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "InsetMathNest.h"
14
15 #include "InsetMathArray.h"
16 #include "InsetMathAMSArray.h"
17 #include "InsetMathBig.h"
18 #include "InsetMathBox.h"
19 #include "InsetMathBrace.h"
20 #include "InsetMathChar.h"
21 #include "InsetMathColor.h"
22 #include "InsetMathComment.h"
23 #include "InsetMathDelim.h"
24 #include "InsetMathEnsureMath.h"
25 #include "InsetMathHull.h"
26 #include "InsetMathRef.h"
27 #include "InsetMathScript.h"
28 #include "InsetMathSpace.h"
29 #include "InsetMathSymbol.h"
30 #include "InsetMathUnknown.h"
31 #include "MathAutoCorrect.h"
32 #include "MathCompletionList.h"
33 #include "MathFactory.h"
34 #include "InsetMathMacro.h"
35 #include "InsetMathMacroArgument.h"
36 #include "MathParser.h"
37 #include "MathStream.h"
38 #include "MathSupport.h"
39
40 #include "Buffer.h"
41 #include "BufferParams.h"
42 #include "BufferView.h"
43 #include "CoordCache.h"
44 #include "Cursor.h"
45 #include "CutAndPaste.h"
46 #include "DispatchResult.h"
47 #include "Encoding.h"
48 #include "FuncRequest.h"
49 #include "FuncStatus.h"
50 #include "LaTeXFeatures.h"
51 #include "LyX.h"
52 #include "LyXRC.h"
53 #include "MetricsInfo.h"
54 #include "TexRow.h"
55 #include "Text.h"
56
57 #include "frontends/Application.h"
58 #include "frontends/Clipboard.h"
59 #include "frontends/Painter.h"
60 #include "frontends/Selection.h"
61
62 #include "support/debug.h"
63 #include "support/docstream.h"
64 #include "support/gettext.h"
65 #include "support/lassert.h"
66 #include "support/lstrings.h"
67 #include "support/textutils.h"
68
69 #include <algorithm>
70 #include <sstream>
71
72 using namespace std;
73 using namespace lyx::support;
74
75 namespace lyx {
76
77 using cap::copySelection;
78 using cap::grabAndEraseSelection;
79 using cap::cutSelection;
80 using cap::replaceSelection;
81 using cap::selClearOrDel;
82
83
84 InsetMathNest::InsetMathNest(Buffer * buf, idx_type nargs)
85         : InsetMath(buf), cells_(nargs), lock_(false)
86 {
87         // FIXME This should not really be necessary, but when we are
88         // initializing the table of global macros, we create macros
89         // with no associated Buffer.
90         if (buf)
91                 setBuffer(*buf);
92 }
93
94
95 InsetMathNest::InsetMathNest(InsetMathNest const & inset)
96         : InsetMath(inset), cells_(inset.cells_), lock_(inset.lock_)
97 {}
98
99
100 InsetMathNest::~InsetMathNest()
101 {
102         map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
103         map<BufferView const *, bool>::iterator end = mouse_hover_.end();
104         for (; it != end; ++it)
105                 if (it->second)
106                         it->first->clearLastInset(this);
107 }
108
109
110 InsetMathNest & InsetMathNest::operator=(InsetMathNest const & inset)
111 {
112         cells_ = inset.cells_;
113         lock_ = inset.lock_;
114         mouse_hover_.clear();
115         InsetMath::operator=(inset);
116         return *this;
117 }
118
119
120 void InsetMathNest::setBuffer(Buffer & buffer)
121 {
122         InsetMath::setBuffer(buffer);
123         for (MathData & data : cells_)
124                 data.setBuffer(buffer);
125 }
126
127
128 idx_type InsetMathNest::nargs() const
129 {
130         return cells_.size();
131 }
132
133
134 void InsetMathNest::cursorPos(BufferView const & bv,
135                 CursorSlice const & sl, bool /*boundary*/,
136                 int & x, int & y) const
137 {
138 // FIXME: This is a hack. Ideally, the coord cache should not store
139 // absolute positions, but relative ones. This would mean to call
140 // setXY() not in MathData::draw(), but in the parent insets' draw()
141 // with the correctly adjusted x,y values. But this means that we'd have
142 // to touch all (math)inset's draw() methods. Right now, we'll store
143 // absolute value, and make them here relative, only to make them
144 // absolute again when actually drawing the cursor. What a mess.
145         LASSERT(&sl.inset() == this, return);
146         MathData const & ar = sl.cell();
147         CoordCache const & coord_cache = bv.coordCache();
148         if (!coord_cache.getArrays().has(&ar)) {
149                 // this can (semi-)legally happen if we just created this cell
150                 // and it never has been drawn before. So don't ASSERT.
151                 //lyxerr << "no cached data for array " << &ar << endl;
152                 x = 0;
153                 y = 0;
154                 return;
155         }
156         Point const pt = coord_cache.getArrays().xy(&ar);
157         if (!coord_cache.getInsets().has(this)) {
158                 // same as above
159                 //lyxerr << "no cached data for inset " << this << endl;
160                 x = 0;
161                 y = 0;
162                 return;
163         }
164         Point const pt2 = coord_cache.getInsets().xy(this);
165         //lyxerr << "retrieving position cache for MathData "
166         //      << pt.x_ << ' ' << pt.y_ << endl;
167         x = pt.x_ - pt2.x_ + ar.pos2x(&bv, sl.pos());
168         y = pt.y_ - pt2.y_;
169 //      lyxerr << "pt.y_ : " << pt.y_ << " pt2_.y_ : " << pt2.y_
170 //              << " asc: " << ascent() << "  des: " << descent()
171 //              << " ar.asc: " << ar.ascent() << " ar.des: " << ar.descent() << endl;
172         // move cursor visually into empty cells ("blue rectangles");
173         if (ar.empty()) {
174                 Dimension const dim = coord_cache.getArrays().dim(&ar);
175                 x += dim.wid / 3;
176         }
177 }
178
179
180 void InsetMathNest::cellsMetrics(MetricsInfo const & mi) const
181 {
182         MetricsInfo m = mi;
183         for (auto const & cell : cells_) {
184                 Dimension dim;
185                 cell.metrics(m, dim);
186         }
187 }
188
189
190 void InsetMathNest::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
191 {
192         for (idx_type i = 0, n = nargs(); i != n; ++i)
193                 cell(i).updateBuffer(it, utype, deleted);
194 }
195
196
197
198 bool InsetMathNest::idxNext(Cursor & cur) const
199 {
200         LASSERT(&cur.inset() == this, return false);
201         if (cur.idx() == cur.lastidx())
202                 return false;
203         ++cur.idx();
204         cur.pos() = 0;
205         return true;
206 }
207
208
209 bool InsetMathNest::idxForward(Cursor & cur) const
210 {
211         return idxNext(cur);
212 }
213
214
215 bool InsetMathNest::idxPrev(Cursor & cur) const
216 {
217         LASSERT(&cur.inset() == this, return false);
218         if (cur.idx() == 0)
219                 return false;
220         --cur.idx();
221         cur.pos() = lyxrc.mac_like_cursor_movement ? cur.lastpos() : 0;
222         return true;
223 }
224
225
226 bool InsetMathNest::idxBackward(Cursor & cur) const
227 {
228         return idxPrev(cur);
229 }
230
231
232 bool InsetMathNest::idxFirst(Cursor & cur) const
233 {
234         LASSERT(&cur.inset() == this, return false);
235         if (nargs() == 0)
236                 return false;
237         cur.idx() = firstIdx();
238         cur.pos() = 0;
239         return true;
240 }
241
242
243 bool InsetMathNest::idxLast(Cursor & cur) const
244 {
245         LASSERT(&cur.inset() == this, return false);
246         if (nargs() == 0)
247                 return false;
248         cur.idx() = lastIdx();
249         cur.pos() = cur.lastpos();
250         return true;
251 }
252
253
254 void InsetMathNest::dump() const
255 {
256         odocstringstream oss;
257         otexrowstream ots(oss);
258         WriteStream os(ots);
259         os << "---------------------------------------------\n";
260         write(os);
261         os << "\n";
262         for (idx_type i = 0, n = nargs(); i != n; ++i)
263                 os << cell(i) << "\n";
264         os << "---------------------------------------------\n";
265         lyxerr << to_utf8(oss.str());
266 }
267
268
269 void InsetMathNest::draw(PainterInfo &, int, int) const
270 {
271 #if 0
272         if (lock_)
273                 pi.pain.fillRectangle(x, y - ascent(), width(), height(),
274                                         Color_mathlockbg);
275 #endif
276 }
277
278
279 void InsetMathNest::validate(LaTeXFeatures & features) const
280 {
281         for (idx_type i = 0; i < nargs(); ++i)
282                 cell(i).validate(features);
283 }
284
285
286 void InsetMathNest::replace(ReplaceData & rep)
287 {
288         for (idx_type i = 0; i < nargs(); ++i)
289                 cell(i).replace(rep);
290 }
291
292
293 bool InsetMathNest::contains(MathData const & ar) const
294 {
295         for (idx_type i = 0; i < nargs(); ++i)
296                 if (cell(i).contains(ar))
297                         return true;
298         return false;
299 }
300
301
302 bool InsetMathNest::lock() const
303 {
304         return lock_;
305 }
306
307
308 void InsetMathNest::lock(bool l)
309 {
310         lock_ = l;
311 }
312
313
314 bool InsetMathNest::isActive() const
315 {
316         return nargs() > 0;
317 }
318
319
320 MathData InsetMathNest::glue() const
321 {
322         MathData ar;
323         for (size_t i = 0; i < nargs(); ++i)
324                 ar.append(cell(i));
325         return ar;
326 }
327
328
329 void InsetMathNest::write(WriteStream & os) const
330 {
331         MathEnsurer ensurer(os, currentMode() == MATH_MODE);
332         ModeSpecifier specifier(os, currentMode(), lockedMode());
333         docstring const latex_name = name();
334         os << '\\' << latex_name;
335         os.inMathClass(asClassInset());
336         for (size_t i = 0; i < nargs(); ++i) {
337                 Changer dummy = os.changeRowEntry(TexRow::mathEntry(id(),i));
338                 os << '{' << cell(i) << '}';
339         }
340         if (nargs() == 0)
341                 os.pendingSpace(true);
342         if (lock_ && !os.latex()) {
343                 os << "\\lyxlock";
344                 os.pendingSpace(true);
345         }
346         os.inMathClass(false);
347 }
348
349
350 void InsetMathNest::normalize(NormalStream & os) const
351 {
352         os << '[' << name();
353         for (size_t i = 0; i < nargs(); ++i)
354                 os << ' ' << cell(i);
355         os << ']';
356 }
357
358
359 void InsetMathNest::latex(otexstream & os, OutputParams const & runparams) const
360 {
361         WriteStream wi(os, runparams.moving_arg, true,
362                         runparams.dryrun ? WriteStream::wsDryrun : WriteStream::wsDefault,
363                         runparams.encoding);
364         wi.strikeoutMath(runparams.inDeletedInset);
365         if (runparams.inulemcmd) {
366                 wi.ulemCmd(WriteStream::UNDERLINE);
367                 if (runparams.local_font) {
368                         FontInfo f = runparams.local_font->fontInfo();
369                         if (f.strikeout() == FONT_ON)
370                                 wi.ulemCmd(WriteStream::STRIKEOUT);
371                 }
372         }
373         wi.canBreakLine(os.canBreakLine());
374         Changer dummy = wi.changeRowEntry(TexRow::textEntry(runparams.lastid,
375                                                             runparams.lastpos));
376         write(wi);
377         // Reset parbreak and command termination status after a math inset.
378         os.lastChar(0);
379         os.canBreakLine(wi.canBreakLine());
380         os.terminateCommand(false);
381 }
382
383
384 bool InsetMathNest::setMouseHover(BufferView const * bv, bool mouse_hover)
385         const
386 {
387         mouse_hover_[bv] = mouse_hover;
388         return true;
389 }
390
391
392 bool InsetMathNest::notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
393 {
394         // FIXME: look here
395 #if 0
396         MathData & ar = cur.cell();
397         // remove base-only "scripts"
398         for (pos_type i = 0; i + 1 < ar.size(); ++i) {
399                 InsetMathScript * p = operator[](i).nucleus()->asScriptInset();
400                 if (p && p->nargs() == 1) {
401                         MathData ar = p->nuc();
402                         erase(i);
403                         insert(i, ar);
404                         cur.adjust(i, ar.size() - 1);
405                 }
406         }
407
408         // glue adjacent font insets of the same kind
409         for (pos_type i = 0; i + 1 < size(); ++i) {
410                 InsetMathFont * p = operator[](i).nucleus()->asFontInset();
411                 InsetMathFont const * q = operator[](i + 1)->asFontInset();
412                 if (p && q && p->name() == q->name()) {
413                         p->cell(0).append(q->cell(0));
414                         erase(i + 1);
415                         cur.adjust(i, -1);
416                 }
417         }
418 #endif
419         return false;
420 }
421
422
423 void InsetMathNest::handleFont
424         (Cursor & cur, docstring const & arg, char const * const font)
425 {
426         handleFont(cur, arg, from_ascii(font));
427 }
428
429
430 void InsetMathNest::handleFont(Cursor & cur, docstring const & arg,
431         docstring const & font)
432 {
433         cur.recordUndoSelection();
434
435         // this whole function is a hack and won't work for incremental font
436         // changes...
437         if (cur.inset().asInsetMath()->name() == font)
438                 cur.handleFont(to_utf8(font));
439         else
440                 handleNest(cur, createInsetMath(font, cur.buffer()), arg);
441 }
442
443
444 void InsetMathNest::handleNest(Cursor & cur, MathAtom const & nest)
445 {
446         handleNest(cur, nest, docstring());
447 }
448
449
450 void InsetMathNest::handleNest(Cursor & cur, MathAtom const & nest,
451         docstring const & arg)
452 {
453         CursorSlice i1 = cur.selBegin();
454         CursorSlice i2 = cur.selEnd();
455         if (!i1.inset().asInsetMath())
456                 return;
457         if (i1.idx() == i2.idx()) {
458                 // the easy case where only one cell is selected
459                 cur.handleNest(nest);
460                 cur.insert(arg);
461                 return;
462         }
463
464         // multiple selected cells in a simple non-grid inset
465         if (i1.asInsetMath()->nrows() == 0 || i1.asInsetMath()->ncols() == 0) {
466                 for (idx_type i = i1.idx(); i <= i2.idx(); ++i) {
467                         // select cell
468                         cur.idx() = i;
469                         cur.pos() = 0;
470                         cur.resetAnchor();
471                         cur.pos() = cur.lastpos();
472                         cur.setSelection();
473
474                         // change font of cell
475                         cur.handleNest(nest);
476                         cur.insert(arg);
477
478                         // cur is in the font inset now. If the loop continues,
479                         // we need to get outside again for the next cell
480                         if (i + 1 <= i2.idx())
481                                 cur.pop_back();
482                 }
483                 return;
484         }
485
486         // the complicated case with multiple selected cells in a grid
487         row_type r1, r2;
488         col_type c1, c2;
489         cap::region(i1, i2, r1, r2, c1, c2);
490         for (row_type row = r1; row <= r2; ++row) {
491                 for (col_type col = c1; col <= c2; ++col) {
492                         // select cell
493                         cur.idx() = i1.asInsetMath()->index(row, col);
494                         cur.pos() = 0;
495                         cur.resetAnchor();
496                         cur.pos() = cur.lastpos();
497                         cur.setSelection();
498
499                         //
500                         cur.handleNest(nest);
501                         cur.insert(arg);
502
503                         // cur is in the font inset now. If the loop continues,
504                         // we need to get outside again for the next cell
505                         if (col + 1 <= c2 || row + 1 <= r2)
506                                 cur.pop_back();
507                 }
508         }
509 }
510
511
512 void InsetMathNest::handleFont2(Cursor & cur, docstring const & arg)
513 {
514         cur.recordUndoSelection();
515         Font font;
516         bool b;
517         font.fromString(to_utf8(arg), b);
518         if (font.fontInfo().color() != Color_inherit &&
519             font.fontInfo().color() != Color_ignore)
520                 handleNest(cur, MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color())));
521
522         // FIXME: support other font changes here as well?
523 }
524
525 void InsetMathNest::doDispatch(Cursor & cur, FuncRequest & cmd)
526 {
527         //LYXERR0("InsetMathNest: request: " << cmd);
528
529         Parse::flags parseflg = Parse::QUIET | Parse::USETEXT;
530
531         FuncCode const act = cmd.action();
532         switch (act) {
533
534         case LFUN_CLIPBOARD_PASTE:
535                 parseflg |= Parse::VERBATIM;
536                 // fall through
537         case LFUN_PASTE: {
538                 if (cur.currentMode() != MATH_MODE)
539                         parseflg |= Parse::TEXTMODE;
540                 cur.recordUndoSelection();
541                 cur.message(_("Paste"));
542                 replaceSelection(cur);
543                 docstring topaste;
544                 if (cmd.argument().empty() && !theClipboard().isInternal())
545                         topaste = theClipboard().getAsText(frontend::Clipboard::PlainTextType);
546                 else {
547                         size_t n = 0;
548                         idocstringstream is(cmd.argument());
549                         is >> n;
550                         topaste = cap::selection(n, buffer().params().documentClassPtr());
551                 }
552                 cur.niceInsert(topaste, parseflg, false);
553                 cur.clearSelection(); // bug 393
554                 cur.forceBufferUpdate();
555                 cur.finishUndo();
556                 break;
557         }
558
559         case LFUN_CUT:
560                 cur.recordUndo();
561                 cutSelection(cur, true);
562                 cur.message(_("Cut"));
563                 // Prevent stale position >= size crash
564                 // Probably not necessary anymore, see eraseSelection (gb 2005-10-09)
565                 cur.normalize();
566                 cur.forceBufferUpdate();
567                 break;
568
569         case LFUN_COPY:
570                 copySelection(cur);
571                 cur.message(_("Copy"));
572                 break;
573
574         case LFUN_MOUSE_PRESS:
575                 lfunMousePress(cur, cmd);
576                 break;
577
578         case LFUN_MOUSE_MOTION:
579                 lfunMouseMotion(cur, cmd);
580                 break;
581
582         case LFUN_MOUSE_RELEASE:
583                 lfunMouseRelease(cur, cmd);
584                 break;
585
586         case LFUN_FINISHED_LEFT: // in math, left is backwards
587         case LFUN_FINISHED_BACKWARD:
588                 cur.bv().cursor() = cur;
589                 break;
590
591         case LFUN_FINISHED_RIGHT: // in math, right is forward
592         case LFUN_FINISHED_FORWARD:
593                 ++cur.pos();
594                 cur.bv().cursor() = cur;
595                 break;
596
597         case LFUN_WORD_RIGHT:
598         case LFUN_WORD_LEFT:
599         case LFUN_WORD_BACKWARD:
600         case LFUN_WORD_FORWARD:
601         case LFUN_CHAR_RIGHT:
602         case LFUN_CHAR_LEFT:
603         case LFUN_CHAR_BACKWARD:
604         case LFUN_CHAR_FORWARD:
605                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
606                 // fall through
607         case LFUN_WORD_RIGHT_SELECT:
608         case LFUN_WORD_LEFT_SELECT:
609         case LFUN_WORD_BACKWARD_SELECT:
610         case LFUN_WORD_FORWARD_SELECT:
611         case LFUN_CHAR_RIGHT_SELECT:
612         case LFUN_CHAR_LEFT_SELECT:
613         case LFUN_CHAR_BACKWARD_SELECT:
614         case LFUN_CHAR_FORWARD_SELECT: {
615                 // are we in a selection?
616                 bool select = (act == LFUN_WORD_RIGHT_SELECT
617                                            || act == LFUN_WORD_LEFT_SELECT
618                                            || act == LFUN_WORD_BACKWARD_SELECT
619                                            || act == LFUN_WORD_FORWARD_SELECT
620                                || act == LFUN_CHAR_RIGHT_SELECT
621                                            || act == LFUN_CHAR_LEFT_SELECT
622                                            || act == LFUN_CHAR_BACKWARD_SELECT
623                                            || act == LFUN_CHAR_FORWARD_SELECT);
624                 // select words
625                 bool word = (act == LFUN_WORD_RIGHT_SELECT
626                              || act == LFUN_WORD_LEFT_SELECT
627                              || act == LFUN_WORD_BACKWARD_SELECT
628                              || act == LFUN_WORD_FORWARD_SELECT
629                              || act == LFUN_WORD_RIGHT
630                              || act == LFUN_WORD_LEFT
631                              || act == LFUN_WORD_BACKWARD
632                              || act == LFUN_WORD_FORWARD);
633                 // are we moving forward or backwards?
634                 // If the command was RIGHT or LEFT, then whether we're moving forward
635                 // or backwards depends on the cursor movement mode (logical or visual):
636                 //  * in visual mode, since math is always LTR, right -> forward,
637                 //    left -> backwards
638                 //  * in logical mode, the mapping is determined by the
639                 //    reverseDirectionNeeded() function
640
641                 bool forward;
642                 FuncCode finish_lfun;
643
644                 if (act == LFUN_CHAR_FORWARD
645                     || act == LFUN_CHAR_FORWARD_SELECT
646                     || act == LFUN_WORD_FORWARD
647                     || act == LFUN_WORD_FORWARD_SELECT) {
648                         forward = true;
649                         finish_lfun = LFUN_FINISHED_FORWARD;
650                 }
651                 else if (act == LFUN_CHAR_BACKWARD
652                          || act == LFUN_CHAR_BACKWARD_SELECT
653                          || act == LFUN_WORD_BACKWARD
654                          || act == LFUN_WORD_BACKWARD_SELECT) {
655                         forward = false;
656                         finish_lfun = LFUN_FINISHED_BACKWARD;
657                 }
658                 else {
659                         bool right = (act == LFUN_CHAR_RIGHT_SELECT
660                                                   || act == LFUN_CHAR_RIGHT
661                                       || act == LFUN_WORD_RIGHT_SELECT
662                                       || act == LFUN_WORD_RIGHT);
663                         if (lyxrc.visual_cursor || !cur.reverseDirectionNeeded())
664                                 forward = right;
665                         else
666                                 forward = !right;
667
668                         if (right)
669                                 finish_lfun = LFUN_FINISHED_RIGHT;
670                         else
671                                 finish_lfun = LFUN_FINISHED_LEFT;
672                 }
673                 // Now that we know exactly what we want to do, let's do it!
674                 cur.selHandle(select);
675                 cur.clearTargetX();
676                 cur.macroModeClose();
677                 // try moving forward or backwards as necessary...
678                 if (!(forward ? cur.mathForward(word) : cur.mathBackward(word))) {
679                         // ... and if movement failed, then finish forward or backwards
680                         // as necessary
681                         cmd = FuncRequest(finish_lfun);
682                         cur.undispatched();
683                 }
684                 break;
685         }
686
687         case LFUN_DOWN:
688         case LFUN_UP:
689         case LFUN_PARAGRAPH_UP:
690         case LFUN_PARAGRAPH_DOWN:
691                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
692                 // fall through
693         case LFUN_DOWN_SELECT:
694         case LFUN_UP_SELECT:
695         case LFUN_PARAGRAPH_UP_SELECT:
696         case LFUN_PARAGRAPH_DOWN_SELECT: {
697                 // close active macro
698                 if (cur.inMacroMode()) {
699                         cur.macroModeClose();
700                         break;
701                 }
702
703                 // stop/start the selection
704                 bool select = act == LFUN_DOWN_SELECT
705                         || act == LFUN_UP_SELECT
706                         || act == LFUN_PARAGRAPH_DOWN_SELECT
707                         || act == LFUN_PARAGRAPH_UP_SELECT;
708                 cur.selHandle(select);
709
710                 // go up/down
711                 bool up = act == LFUN_UP || act == LFUN_UP_SELECT
712                         || act == LFUN_PARAGRAPH_UP || act == LFUN_PARAGRAPH_UP_SELECT;
713                 bool successful = cur.upDownInMath(up);
714                 if (successful)
715                         break;
716
717                 if (cur.fixIfBroken())
718                         // FIXME: Something bad happened. We pass the corrected Cursor
719                         // instead of letting things go worse.
720                         break;
721
722                 // We did not manage to move the cursor.
723                 cur.undispatched();
724                 break;
725         }
726
727         case LFUN_MOUSE_DOUBLE:
728         case LFUN_WORD_SELECT:
729                 cur.pos() = 0;
730                 cur.bv().mouseSetCursor(cur);
731                 cur.pos() = cur.lastpos();
732                 cur.bv().mouseSetCursor(cur, true);
733                 break;
734
735         case LFUN_MOUSE_TRIPLE:
736                 cur.idx() = 0;
737                 cur.pos() = 0;
738                 cur.bv().mouseSetCursor(cur);
739                 cur.idx() = cur.lastidx();
740                 cur.pos() = cur.lastpos();
741                 cur.bv().mouseSetCursor(cur, true);
742                 break;
743
744         case LFUN_LINE_BEGIN:
745                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
746                 // fall through
747         case LFUN_LINE_BEGIN_SELECT:
748                 cur.selHandle(act == LFUN_WORD_BACKWARD_SELECT ||
749                                 act == LFUN_WORD_LEFT_SELECT ||
750                                 act == LFUN_LINE_BEGIN_SELECT);
751                 cur.macroModeClose();
752                 if (cur.pos() != 0) {
753                         cur.pos() = 0;
754                 } else if (cur.col() != 0) {
755                         cur.idx() -= cur.col();
756                         cur.pos() = 0;
757                 } else if (cur.idx() != 0) {
758                         cur.idx() = 0;
759                         cur.pos() = 0;
760                 } else {
761                         cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
762                         cur.undispatched();
763                 }
764                 break;
765
766         case LFUN_LINE_END:
767                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
768                 // fall through
769         case LFUN_LINE_END_SELECT:
770                 cur.selHandle(act == LFUN_WORD_FORWARD_SELECT ||
771                                 act == LFUN_WORD_RIGHT_SELECT ||
772                                 act == LFUN_LINE_END_SELECT);
773                 cur.macroModeClose();
774                 cur.clearTargetX();
775                 if (cur.pos() != cur.lastpos()) {
776                         cur.pos() = cur.lastpos();
777                 } else if (ncols() && (cur.col() != cur.lastcol())) {
778                         cur.idx() = cur.idx() - cur.col() + cur.lastcol();
779                         cur.pos() = cur.lastpos();
780                 } else if (cur.idx() != cur.lastidx()) {
781                         cur.idx() = cur.lastidx();
782                         cur.pos() = cur.lastpos();
783                 } else {
784                         cmd = FuncRequest(LFUN_FINISHED_FORWARD);
785                         cur.undispatched();
786                 }
787                 break;
788
789         case LFUN_CELL_FORWARD:
790                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
791                 cur.selHandle(false);
792                 cur.clearTargetX();
793                 cur.macroModeClose();
794                 if (!cur.inset().idxNext(cur)) {
795                         cur.idx() = firstIdx();
796                         cur.pos() = 0;
797                 }
798                 break;
799
800         case LFUN_CELL_BACKWARD:
801                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
802                 cur.selHandle(false);
803                 cur.clearTargetX();
804                 cur.macroModeClose();
805                 if (!cur.inset().idxPrev(cur)) {
806                         cur.idx() = lastIdx();
807                         cur.pos() = lyxrc.mac_like_cursor_movement ? cur.lastpos() : 0;
808                 }
809                 break;
810
811         case LFUN_WORD_DELETE_BACKWARD:
812         case LFUN_CHAR_DELETE_BACKWARD:
813                 if (cur.pos() == 0)
814                         // May affect external cell:
815                         cur.recordUndoInset();
816                 else if (!cur.inMacroMode())
817                         cur.recordUndoSelection();
818                 // if the inset can not be removed from within, delete it
819                 if (!cur.backspace(cmd.getArg(0) == "force")) {
820                         FuncRequest newcmd = FuncRequest(LFUN_CHAR_DELETE_FORWARD, "force");
821                         cur.innerText()->dispatch(cur, newcmd);
822                 }
823                 break;
824
825         case LFUN_WORD_DELETE_FORWARD:
826         case LFUN_CHAR_DELETE_FORWARD:
827                 if (cur.pos() == cur.lastpos())
828                         // May affect external cell:
829                         cur.recordUndoInset();
830                 else
831                         cur.recordUndoSelection();
832                 // if the inset can not be removed from within, delete it
833                 if (!cur.erase(cmd.getArg(0) == "force")) {
834                         FuncRequest newcmd = FuncRequest(LFUN_CHAR_DELETE_FORWARD, "force");
835                         cur.innerText()->dispatch(cur, newcmd);
836                 }
837                 break;
838
839         case LFUN_ESCAPE:
840                 if (cur.selection())
841                         cur.clearSelection();
842                 else  {
843                         if (cur.inMacroMode())
844                                 cur.macroModeClose(true);
845                         else {
846                                 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
847                                 cur.undispatched();
848                         }
849                 }
850                 break;
851
852         // 'Locks' the math inset. A 'locked' math inset behaves as a unit
853         // that is traversed by a single <CursorLeft>/<CursorRight>.
854         case LFUN_INSET_TOGGLE:
855                 cur.recordUndo();
856                 lock(!lock());
857                 cur.popForward();
858                 break;
859
860         case LFUN_SELF_INSERT:
861                 // special case first for big delimiters
862                 if (cmd.argument().size() != 1 && interpretString(cur, cmd.argument()))
863                         break;
864
865                 for (char_type c : cmd.argument()) {
866                         // Don't record undo steps if we are in macro mode and thus
867                         // cmd.argument is the next character of the macro name.
868                         // Otherwise we'll get an invalid cursor if we undo after
869                         // the macro was finished and the macro is a known command,
870                         // e.g. sqrt. Cursor::macroModeClose replaces in this case
871                         // the InsetMathUnknown with name "frac" by an empty
872                         // InsetMathFrac -> a pos value > 0 is invalid.
873                         // A side effect is that an undo before the macro is finished
874                         // undoes the complete macro, not only the last character.
875                         // At the time we hit '\' we are not in macro mode, still.
876                         if (!cur.inMacroMode())
877                                 cur.recordUndoSelection();
878
879                         // special handling of space. If we insert an inset
880                         // via macro mode, we want to put the cursor inside it
881                         // if relevant. Think typing "\frac<space>".
882                         if (c == ' '
883                             && cur.inMacroMode() && cur.macroName() != "\\"
884                             && cur.macroModeClose() && cur.pos() > 0)
885                                 cur.editInsertedInset();
886                         else if (!interpretChar(cur, c)) {
887                                 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
888                                 cur.undispatched();
889                                 // FIXME: can we avoid skipping the end of the string?
890                                 break;
891                         }
892                 }
893                 break;
894
895         //case LFUN_SERVER_GET_XY:
896         //      break;
897
898         case LFUN_SERVER_SET_XY: {
899                 lyxerr << "LFUN_SERVER_SET_XY broken!" << endl;
900                 int x = 0;
901                 int y = 0;
902                 istringstream is(to_utf8(cmd.argument()));
903                 is >> x >> y;
904                 cur.setTargetX(x);
905                 break;
906         }
907
908         // Special casing for superscript in case of LyX handling
909         // dead-keys:
910         case LFUN_ACCENT_CIRCUMFLEX:
911                 if (cmd.argument().empty()) {
912                         // do superscript if LyX handles
913                         // deadkeys
914                         cur.recordUndoSelection();
915                         script(cur, true, grabAndEraseSelection(cur));
916                 }
917                 break;
918
919         case LFUN_ACCENT_UMLAUT:
920         case LFUN_ACCENT_ACUTE:
921         case LFUN_ACCENT_GRAVE:
922         case LFUN_ACCENT_BREVE:
923         case LFUN_ACCENT_DOT:
924         case LFUN_ACCENT_MACRON:
925         case LFUN_ACCENT_CARON:
926         case LFUN_ACCENT_TILDE:
927         case LFUN_ACCENT_CEDILLA:
928         case LFUN_ACCENT_CIRCLE:
929         case LFUN_ACCENT_UNDERDOT:
930         case LFUN_ACCENT_TIE:
931         case LFUN_ACCENT_OGONEK:
932         case LFUN_ACCENT_HUNGARIAN_UMLAUT:
933                 break;
934
935         //  Math fonts
936         case LFUN_TEXTSTYLE_APPLY:
937         case LFUN_TEXTSTYLE_UPDATE:
938                 handleFont2(cur, cmd.argument());
939                 break;
940
941         case LFUN_FONT_BOLD:
942                 if (currentMode() != MATH_MODE)
943                         handleFont(cur, cmd.argument(), "textbf");
944                 else
945                         handleFont(cur, cmd.argument(), "mathbf");
946                 break;
947         case LFUN_FONT_BOLDSYMBOL:
948                 if (currentMode() != MATH_MODE)
949                         handleFont(cur, cmd.argument(), "textbf");
950                 else
951                         handleFont(cur, cmd.argument(), "boldsymbol");
952                 break;
953         case LFUN_FONT_SANS:
954                 if (currentMode() != MATH_MODE)
955                         handleFont(cur, cmd.argument(), "textsf");
956                 else
957                         handleFont(cur, cmd.argument(), "mathsf");
958                 break;
959         case LFUN_FONT_EMPH:
960                 if (currentMode() != MATH_MODE)
961                         handleFont(cur, cmd.argument(), "emph");
962                 else
963                         handleFont(cur, cmd.argument(), "mathcal");
964                 break;
965         case LFUN_FONT_ROMAN:
966                 if (currentMode() != MATH_MODE)
967                         handleFont(cur, cmd.argument(), "textrm");
968                 else
969                         handleFont(cur, cmd.argument(), "mathrm");
970                 break;
971         case LFUN_FONT_TYPEWRITER:
972                 if (currentMode() != MATH_MODE)
973                         handleFont(cur, cmd.argument(), "texttt");
974                 else
975                         handleFont(cur, cmd.argument(), "mathtt");
976                 break;
977         case LFUN_FONT_FRAK:
978                 handleFont(cur, cmd.argument(), "mathfrak");
979                 break;
980         case LFUN_FONT_ITAL:
981                 if (currentMode() != MATH_MODE)
982                         handleFont(cur, cmd.argument(), "textit");
983                 else
984                         handleFont(cur, cmd.argument(), "mathit");
985                 break;
986         case LFUN_FONT_NOUN:
987                 if (currentMode() != MATH_MODE)
988                         // FIXME: should be "noun"
989                         handleFont(cur, cmd.argument(), "textsc");
990                 else
991                         handleFont(cur, cmd.argument(), "mathbb");
992                 break;
993         case LFUN_FONT_DEFAULT:
994                 handleFont(cur, cmd.argument(), "textnormal");
995                 break;
996         case LFUN_FONT_UNDERLINE:
997                 cur.recordUndo();
998                 cur.handleNest(createInsetMath("underline", cur.buffer()));
999                 break;
1000
1001         case LFUN_MATH_MODE: {
1002 #if 1
1003                 // ignore math-mode on when already in math mode
1004                 if (currentMode() == Inset::MATH_MODE && cmd.argument() == "on")
1005                         break;
1006                 cur.recordUndoSelection();
1007                 cur.macroModeClose();
1008                 docstring const save_selection = grabAndEraseSelection(cur);
1009                 selClearOrDel(cur);
1010                 if (currentMode() != Inset::MATH_MODE)
1011                         cur.plainInsert(MathAtom(new InsetMathEnsureMath(buffer_)));
1012                 else
1013                         cur.plainInsert(createInsetMath("text", buffer_));
1014                 cur.posBackward();
1015                 cur.pushBackward(*cur.nextInset());
1016                 cur.niceInsert(save_selection);
1017                 cur.forceBufferUpdate();
1018 #else
1019                 if (currentMode() == Inset::TEXT_MODE) {
1020                         cur.recordUndoSelection();
1021                         cur.niceInsert(MathAtom(new InsetMathHull("simple", cur.buffer())));
1022                         cur.message(_("create new math text environment ($...$)"));
1023                 } else {
1024                         handleFont(cur, cmd.argument(), "textrm");
1025                         cur.message(_("entered math text mode (textrm)"));
1026                 }
1027 #endif
1028                 break;
1029         }
1030
1031         case LFUN_REGEXP_MODE: {
1032                 InsetMath * im = cur.inset().asInsetMath();
1033                 if (im) {
1034                         InsetMathHull * i = im->asHullInset();
1035                         if (i && i->getType() == hullRegexp) {
1036                                 cur.message(_("Already in regular expression mode"));
1037                                 break;
1038                         }
1039                 }
1040                 cur.macroModeClose();
1041                 docstring const save_selection = grabAndEraseSelection(cur);
1042                 selClearOrDel(cur);
1043                 cur.plainInsert(MathAtom(new InsetMathHull(buffer_, hullRegexp)));
1044                 cur.posBackward();
1045                 cur.pushBackward(*cur.nextInset());
1046                 cur.niceInsert(save_selection);
1047                 cur.message(_("Regular expression editor mode"));
1048                 break;
1049         }
1050
1051         case LFUN_MATH_FONT_STYLE: {
1052                 FuncRequest fr = FuncRequest(LFUN_MATH_INSERT, '\\' + cmd.argument());
1053                 doDispatch(cur, fr);
1054                 break;
1055         }
1056
1057         case LFUN_MATH_SIZE: {
1058                 FuncRequest fr = FuncRequest(LFUN_MATH_INSERT, cmd.argument());
1059                 doDispatch(cur, fr);
1060                 break;
1061         }
1062
1063         case LFUN_MATH_MATRIX: {
1064                 cur.recordUndo();
1065                 unsigned int m = 1;
1066                 unsigned int n = 1;
1067                 docstring v_align;
1068                 docstring h_align;
1069                 idocstringstream is(cmd.argument());
1070                 is >> m >> n >> v_align >> h_align;
1071                 if (m < 1)
1072                         m = 1;
1073                 if (n < 1)
1074                         n = 1;
1075                 v_align += 'c';
1076                 cur.niceInsert(MathAtom(new InsetMathArray(buffer_,
1077                         from_ascii("array"), m, n, (char)v_align[0], h_align)));
1078                 break;
1079         }
1080
1081         case LFUN_MATH_AMS_MATRIX: {
1082                 cur.recordUndo();
1083                 unsigned int m = 1;
1084                 unsigned int n = 1;
1085                 docstring name = from_ascii("matrix");
1086                 idocstringstream is(cmd.argument());
1087                 is >> m >> n >> name;
1088                 if (m < 1)
1089                         m = 1;
1090                 if (n < 1)
1091                         n = 1;
1092                 // check if we have a valid decoration
1093                 if (name != "pmatrix" && name != "bmatrix"
1094                         && name != "Bmatrix" && name != "vmatrix"
1095                         && name != "Vmatrix" && name != "matrix"
1096                         && name != "smallmatrix")
1097                         name = from_ascii("matrix");
1098
1099                 cur.niceInsert(
1100                         MathAtom(new InsetMathAMSArray(buffer_, name, m, n)));
1101                 break;
1102         }
1103
1104         case LFUN_MATH_DELIM: {
1105                 docstring ls;
1106                 docstring rs = split(cmd.argument(), ls, ' ');
1107                 // Reasonable default values
1108                 if (ls.empty())
1109                         ls = '(';
1110                 if (rs.empty())
1111                         rs = ')';
1112                 cur.recordUndo();
1113                 cur.handleNest(MathAtom(new InsetMathDelim(buffer_, ls, rs)));
1114                 break;
1115         }
1116
1117         case LFUN_MATH_BIGDELIM: {
1118                 docstring const lname  = from_utf8(cmd.getArg(0));
1119                 docstring const ldelim = from_utf8(cmd.getArg(1));
1120                 docstring const rname  = from_utf8(cmd.getArg(2));
1121                 docstring const rdelim = from_utf8(cmd.getArg(3));
1122                 latexkeys const * l = in_word_set(lname);
1123                 bool const have_l = l && l->inset == "big" &&
1124                                     InsetMathBig::isBigInsetDelim(ldelim);
1125                 l = in_word_set(rname);
1126                 bool const have_r = l && l->inset == "big" &&
1127                                     InsetMathBig::isBigInsetDelim(rdelim);
1128                 // We mimic LFUN_MATH_DELIM in case we have an empty left
1129                 // or right delimiter.
1130                 if (have_l || have_r) {
1131                         cur.recordUndo();
1132                         docstring const selection = grabAndEraseSelection(cur);
1133                         selClearOrDel(cur);
1134                         if (have_l)
1135                                 cur.insert(MathAtom(new InsetMathBig(lname,
1136                                                                 ldelim)));
1137                         // first insert the right delimiter and then go back
1138                         // and re-insert the selection (bug 7088)
1139                         if (have_r) {
1140                                 cur.insert(MathAtom(new InsetMathBig(rname,
1141                                                                 rdelim)));
1142                                 cur.posBackward();
1143                         }
1144                         cur.niceInsert(selection);
1145                 }
1146                 // Don't call cur.undispatched() if we did nothing, this would
1147                 // lead to infinite recursion via Text::dispatch().
1148                 break;
1149         }
1150
1151         case LFUN_SPACE_INSERT: {
1152                 cur.recordUndoSelection();
1153                 string const name = cmd.getArg(0);
1154                 if (name == "normal")
1155                         cur.insert(MathAtom(new InsetMathSpace(" ", "")));
1156                 else if (name == "protected")
1157                         cur.insert(MathAtom(new InsetMathSpace("~", "")));
1158                 else if (name == "thin" || name == "med" || name == "thick")
1159                         cur.insert(MathAtom(new InsetMathSpace(name + "space", "")));
1160                 else if (name == "hfill*")
1161                         cur.insert(MathAtom(new InsetMathSpace("hspace*{\\fill}", "")));
1162                 else if (name == "quad" || name == "qquad" ||
1163                          name == "enspace" || name == "enskip" ||
1164                          name == "negthinspace" || name == "negmedspace" ||
1165                          name == "negthickspace" || name == "hfill")
1166                         cur.insert(MathAtom(new InsetMathSpace(name, "")));
1167                 else if (name == "hspace" || name == "hspace*") {
1168                         string const len = cmd.getArg(1);
1169                         if (len.empty() || !isValidLength(len)) {
1170                                 lyxerr << "LyX function 'space-insert " << name << "' "
1171                                           "needs a valid length argument." << endl;
1172                                 break;
1173                         }
1174                         cur.insert(MathAtom(new InsetMathSpace(name, len)));
1175                 } else
1176                         cur.insert(MathAtom(new InsetMathSpace));
1177                 break;
1178         }
1179
1180         case LFUN_MATH_SPACE:
1181                 cur.recordUndoSelection();
1182                 if (cmd.argument().empty())
1183                         cur.insert(MathAtom(new InsetMathSpace));
1184                 else {
1185                         string const name = cmd.getArg(0);
1186                         string const len = cmd.getArg(1);
1187                         cur.insert(MathAtom(new InsetMathSpace(name, len)));
1188                 }
1189                 break;
1190
1191         case LFUN_ERT_INSERT:
1192                 // interpret this as if a backslash was typed
1193                 cur.recordUndo();
1194                 interpretChar(cur, '\\');
1195                 break;
1196
1197         case LFUN_MATH_SUBSCRIPT:
1198                 // interpret this as if a _ was typed
1199                 cur.recordUndoSelection();
1200                 interpretChar(cur, '_');
1201                 break;
1202
1203         case LFUN_MATH_SUPERSCRIPT:
1204                 // interpret this as if a ^ was typed
1205                 cur.recordUndoSelection();
1206                 interpretChar(cur, '^');
1207                 break;
1208
1209         case LFUN_MATH_MACRO_FOLD:
1210         case LFUN_MATH_MACRO_UNFOLD: {
1211                 Cursor it = cur;
1212                 bool fold = act == LFUN_MATH_MACRO_FOLD;
1213                 bool found = findMacroToFoldUnfold(it, fold);
1214                 if (found) {
1215                         InsetMathMacro * macro = it.nextInset()->asInsetMath()->asMacro();
1216                         cur.recordUndoInset();
1217                         if (fold)
1218                                 macro->fold(cur);
1219                         else
1220                                 macro->unfold(cur);
1221                 }
1222                 break;
1223         }
1224
1225         case LFUN_QUOTE_INSERT:
1226                 // interpret this as if a straight " was typed
1227                 cur.recordUndoSelection();
1228                 interpretChar(cur, '\"');
1229                 break;
1230
1231 // FIXME: We probably should swap parts of "math-insert" and "self-insert"
1232 // handling such that "self-insert" works on "arbitrary stuff" too, and
1233 // math-insert only handles special math things like "matrix".
1234         case LFUN_MATH_INSERT: {
1235                 cur.recordUndoSelection();
1236                 if (cmd.argument() == "^" || cmd.argument() == "_")
1237                         interpretChar(cur, cmd.argument()[0]);
1238                 else if (!cur.selection())
1239                         cur.niceInsert(cmd.argument());
1240                 else {
1241                         MathData ar(cur.buffer());
1242                         asArray(cmd.argument(), ar);
1243                         if (ar.size() == 1
1244                             && ar[0]->asNestInset()
1245                             && ar[0]->asNestInset()->nargs() > 1)
1246                                 handleNest(cur, ar[0]);
1247                         else
1248                                 cur.niceInsert(cmd.argument());
1249                 }
1250                 break;
1251         }
1252
1253         case LFUN_DIALOG_SHOW_NEW_INSET: {
1254                 docstring const & name = cmd.argument();
1255                 string data;
1256                 if (name == "ref") {
1257                         InsetMathRef tmp(buffer_, name);
1258                         data = tmp.createDialogStr();
1259                         cur.bv().showDialog(to_utf8(name), data);
1260                 } else if (name == "mathspace") {
1261                         cur.bv().showDialog(to_utf8(name));
1262                 }
1263                 break;
1264         }
1265
1266         case LFUN_INSET_INSERT: {
1267                 MathData ar;
1268                 if (createInsetMath_fromDialogStr(cmd.argument(), ar)) {
1269                         cur.recordUndoSelection();
1270                         cur.insert(ar);
1271                         cur.forceBufferUpdate();
1272                 } else
1273                         cur.undispatched();
1274                 break;
1275         }
1276         case LFUN_INSET_DISSOLVE:
1277                 if (!asHullInset()) {
1278                         cur.recordUndoInset();
1279                         cur.pullArg();
1280                 }
1281                 break;
1282
1283         case LFUN_MATH_LIMITS: {
1284                 InsetMath * in = 0;
1285                 if (cur.pos() < cur.lastpos() && cur.nextMath().allowsLimitsChange())
1286                         in = &cur.nextMath();
1287                 else if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange())
1288                         in = &cur.prevMath();
1289                 else if (cur.lastpos() > 0 && cur.cell().back()->allowsLimitsChange())
1290                         in = cur.cell().back().nucleus();
1291                 // only when nucleus allows this
1292                 if (!in)
1293                         return;
1294                 cur.recordUndoInset();
1295                 if (!cmd.argument().empty()) {
1296                         if (cmd.argument() == "limits")
1297                                 in->limits(LIMITS);
1298                         else if (cmd.argument() == "nolimits")
1299                                 in->limits(NO_LIMITS);
1300                         else
1301                                 in->limits(AUTO_LIMITS);
1302                 } else if (in->limits() == AUTO_LIMITS)
1303                         in->limits(in->defaultLimits() == LIMITS ? NO_LIMITS : LIMITS);
1304                 else
1305                         in->limits(AUTO_LIMITS);
1306                 return;
1307         }
1308
1309         default:
1310                 InsetMath::doDispatch(cur, cmd);
1311                 break;
1312         }
1313 }
1314
1315
1316 bool InsetMathNest::findMacroToFoldUnfold(Cursor & it, bool fold) const {
1317         // look for macro to open/close, but stay in mathed
1318         for (; !it.empty(); it.pop_back()) {
1319
1320                 // go backward through the current cell
1321                 Inset * inset = it.nextInset();
1322                 while (inset && inset->asInsetMath()) {
1323                         InsetMathMacro * macro = inset->asInsetMath()->asMacro();
1324                         if (macro) {
1325                                 // found the an macro to open/close?
1326                                 if (macro->folded() != fold)
1327                                         return true;
1328
1329                                 // Wrong folding state.
1330                                 // If this was the first we see in this slice, look further left,
1331                                 // otherwise go up.
1332                                 if (inset != it.nextInset())
1333                                         break;
1334                         }
1335
1336                         // go up if this was the left most position
1337                         if (it.pos() == 0)
1338                                 break;
1339
1340                         // go left
1341                         it.pos()--;
1342                         inset = it.nextInset();
1343                 }
1344         }
1345
1346         return false;
1347 }
1348
1349
1350 bool InsetMathNest::getStatus(Cursor & cur, FuncRequest const & cmd,
1351                 FuncStatus & flag) const
1352 {
1353         // the font related toggles
1354         //string tc = "mathnormal";
1355         bool ret = true;
1356         string const arg = to_utf8(cmd.argument());
1357         switch (cmd.action()) {
1358 #if 0
1359         case LFUN_INSET_MODIFY:
1360                 // FIXME: check temporarily disabled
1361                 // valign code
1362                 char align = mathcursor::valign();
1363                 if (align == '\0') {
1364                         enable = false;
1365                         break;
1366                 }
1367                 if (cmd.argument().empty()) {
1368                         flag.clear();
1369                         break;
1370                 }
1371                 if (!contains("tcb", cmd.argument()[0])) {
1372                         enable = false;
1373                         break;
1374                 }
1375                 flag.setOnOff(cmd.argument()[0] == align);
1376                 break;
1377 #endif
1378         /// We have to handle them since 1.4 blocks all unhandled actions
1379         case LFUN_FONT_ITAL:
1380         case LFUN_FONT_BOLD:
1381         case LFUN_FONT_BOLDSYMBOL:
1382         case LFUN_FONT_SANS:
1383         case LFUN_FONT_EMPH:
1384         case LFUN_FONT_TYPEWRITER:
1385         case LFUN_FONT_NOUN:
1386         case LFUN_FONT_ROMAN:
1387         case LFUN_FONT_DEFAULT:
1388                 flag.setEnabled(true);
1389                 break;
1390
1391         // we just need to be in math mode to enable that
1392         case LFUN_MATH_SIZE:
1393         case LFUN_MATH_SPACE:
1394         case LFUN_MATH_EXTERN:
1395                 flag.setEnabled(true);
1396                 break;
1397
1398         case LFUN_FONT_UNDERLINE:
1399         case LFUN_FONT_FRAK:
1400                 flag.setEnabled(currentMode() != TEXT_MODE);
1401                 break;
1402
1403         case LFUN_MATH_FONT_STYLE: {
1404                 bool const textarg =
1405                         arg == "textbf"   || arg == "textsf" ||
1406                         arg == "textrm"   || arg == "textmd" ||
1407                         arg == "textit"   || arg == "textsc" ||
1408                         arg == "textsl"   || arg == "textup" ||
1409                         arg == "texttt"   || arg == "textbb" ||
1410                         arg == "textnormal";
1411                 flag.setEnabled(currentMode() != TEXT_MODE || textarg);
1412                 break;
1413         }
1414
1415         case LFUN_MATH_MODE:
1416                 // forbid "math-mode on" in math mode to prevent irritating
1417                 // behaviour of menu entries (bug 6709)
1418                 flag.setEnabled(currentMode() == TEXT_MODE || arg != "on");
1419                 break;
1420
1421         case LFUN_MATH_INSERT:
1422                 flag.setEnabled(currentMode() != TEXT_MODE);
1423                 break;
1424
1425         case LFUN_MATH_AMS_MATRIX:
1426         case LFUN_MATH_MATRIX:
1427                 flag.setEnabled(currentMode() == MATH_MODE);
1428                 break;
1429
1430         case LFUN_INSET_INSERT: {
1431                 // Don't test createMathInset_fromDialogStr(), since
1432                 // getStatus is not called with a valid reference and the
1433                 // dialog would not be applicable.
1434                 string const name = cmd.getArg(0);
1435                 flag.setEnabled(name == "ref" || name == "mathspace");
1436                 break;
1437         }
1438
1439         case LFUN_DIALOG_SHOW_NEW_INSET: {
1440                 docstring const & name = cmd.argument();
1441                 if (name == "space")
1442                         flag.setEnabled(false);
1443                 break;
1444         }
1445
1446
1447         case LFUN_MATH_DELIM:
1448         case LFUN_MATH_BIGDELIM:
1449                 // Don't do this with multi-cell selections
1450                 flag.setEnabled(cur.selBegin().idx() == cur.selEnd().idx());
1451                 break;
1452
1453         case LFUN_MATH_MACRO_FOLD:
1454         case LFUN_MATH_MACRO_UNFOLD: {
1455                 Cursor it = cur;
1456                 bool found = findMacroToFoldUnfold(it, cmd.action() == LFUN_MATH_MACRO_FOLD);
1457                 flag.setEnabled(found);
1458                 break;
1459         }
1460
1461         case LFUN_SPECIALCHAR_INSERT:
1462         case LFUN_SCRIPT_INSERT:
1463                 // FIXME: These would probably make sense in math-text mode
1464                 flag.setEnabled(false);
1465                 break;
1466
1467         case LFUN_CAPTION_INSERT:
1468                 flag.setEnabled(false);
1469                 break;
1470
1471         case LFUN_SPACE_INSERT: {
1472                 docstring const & name = cmd.argument();
1473                 if (name == "visible")
1474                         flag.setEnabled(false);
1475                 break;
1476         }
1477
1478         case LFUN_INSET_DISSOLVE:
1479                 flag.setEnabled(!asHullInset());
1480                 break;
1481
1482         case LFUN_PASTE: {
1483                 docstring const & name = cmd.argument();
1484                 if (name == "html" || name == "latex")
1485                         flag.setEnabled(false);
1486                 break;
1487         }
1488
1489         case LFUN_MATH_LIMITS: {
1490                 InsetMath * in = 0;
1491                 if (cur.pos() < cur.lastpos() && cur.nextMath().allowsLimitsChange())
1492                         in = &cur.nextMath();
1493                 else if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange())
1494                         in = &cur.prevMath();
1495                 else if (cur.lastpos() > 0 && cur.cell().back()->allowsLimitsChange())
1496                         in = cur.cell().back().nucleus();
1497                 if (in) {
1498                         if (!cmd.argument().empty()) {
1499                                 if (cmd.argument() == "limits")
1500                                         flag.setOnOff(in->limits() == LIMITS);
1501                                 else if (cmd.argument() == "nolimits")
1502                                         flag.setOnOff(in->limits() == NO_LIMITS);
1503                                 else
1504                                         flag.setOnOff(in->limits() == AUTO_LIMITS);
1505                         }
1506                         flag.setEnabled(true);
1507                 } else
1508                         flag.setEnabled(false);
1509                 return true;
1510         }
1511
1512         default:
1513                 ret = false;
1514                 break;
1515         }
1516         return ret;
1517 }
1518
1519
1520 void InsetMathNest::edit(Cursor & cur, bool front, EntryDirection entry_from)
1521 {
1522         cur.push(*this);
1523         bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
1524                 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
1525         enter_front ? idxFirst(cur) : idxLast(cur);
1526         cur.resetAnchor();
1527         //lyxerr << "InsetMathNest::edit, cur:\n" << cur << endl;
1528 }
1529
1530
1531 Inset * InsetMathNest::editXY(Cursor & cur, int x, int y)
1532 {
1533         int idx_min = -1;
1534         int dist_min = 1000000;
1535         for (idx_type i = 0, n = nargs(); i != n; ++i) {
1536                 int const d = cell(i).dist(cur.bv(), x, y);
1537                 if (d < dist_min) {
1538                         dist_min = d;
1539                         idx_min = i;
1540                 }
1541         }
1542         if (idx_min == -1)
1543                 return this;
1544
1545         MathData & ar = cell(idx_min);
1546         cur.push(*this);
1547         cur.idx() = idx_min;
1548         cur.pos() = ar.x2pos(&cur.bv(), x - ar.xo(cur.bv()));
1549
1550         //lyxerr << "found cell : " << idx_min << " pos: " << cur.pos() << endl;
1551         if (dist_min == 0) {
1552                 // hit inside cell
1553                 for (pos_type i = 0, n = ar.size(); i < n; ++i)
1554                         if (ar[i]->covers(cur.bv(), x, y))
1555                                 return ar[i].nucleus()->editXY(cur, x, y);
1556         }
1557         return this;
1558 }
1559
1560
1561 void InsetMathNest::lfunMousePress(Cursor & cur, FuncRequest & cmd)
1562 {
1563         //lyxerr << "## lfunMousePress: buttons: " << cmd.button() << endl;
1564         BufferView & bv = cur.bv();
1565         if (cmd.button() == mouse_button::button3) {
1566                 // Don't do anything if we right-click a
1567                 // selection, a context menu will popup.
1568                 if (bv.cursor().selection() && cur >= bv.cursor().selectionBegin()
1569                       && cur < bv.cursor().selectionEnd()) {
1570                         cur.noScreenUpdate();
1571                         return;
1572                 }
1573         }
1574
1575         // set cursor after the inset if x is nearer to that position (bug 9748)
1576         cur.moveToClosestEdge(cmd.x(), true);
1577
1578         bool do_selection = cmd.button() == mouse_button::button1
1579                 && cmd.modifier() == ShiftModifier;
1580         bv.mouseSetCursor(cur, do_selection);
1581         if (cmd.button() == mouse_button::button1) {
1582                 //lyxerr << "## lfunMousePress: setting cursor to: " << cur << endl;
1583                 // Update the cursor update flags as needed:
1584                 //
1585                 // Update::Decoration: tells to update the decoration
1586                 //                     (visual box corners that define
1587                 //                     the inset)/
1588                 // Update::FitCursor: adjust the screen to the cursor
1589                 //                    position if needed
1590                 // cur.result().update(): don't overwrite previously set flags.
1591                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor
1592                                 | cur.result().screenUpdate());
1593         } else if (cmd.button() == mouse_button::button2 && lyxrc.mouse_middlebutton_paste) {
1594                 if (cap::selection()) {
1595                         // See comment in Text::dispatch why we do this
1596                         cap::copySelectionToStack();
1597                         cmd = FuncRequest(LFUN_PASTE, "0");
1598                         doDispatch(bv.cursor(), cmd);
1599                 } else {
1600                         MathData ar;
1601                         asArray(theSelection().get(), ar);
1602                         bv.cursor().insert(ar);
1603                 }
1604         }
1605 }
1606
1607
1608 void InsetMathNest::lfunMouseMotion(Cursor & cur, FuncRequest & cmd)
1609 {
1610         // only select with button 1
1611         if (cmd.button() != mouse_button::button1)
1612                 return;
1613
1614         Cursor & bvcur = cur.bv().cursor();
1615
1616         // ignore motions deeper nested than the real anchor
1617         if (!bvcur.realAnchor().hasPart(cur)) {
1618                 cur.undispatched();
1619                 return;
1620         }
1621
1622         // set cursor after the inset if x is nearer to that position (bug 9748)
1623         cur.moveToClosestEdge(cmd.x());
1624
1625         CursorSlice old = bvcur.top();
1626
1627         // We continue with our existing selection or start a new one, so don't
1628         // reset the anchor.
1629         bvcur.setCursor(cur);
1630         // Did we actually move?
1631         if (cur.top() == old)
1632                 // We didn't move one iota, so no need to change selection status
1633                 // or update the screen.
1634                 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1635         else
1636                 bvcur.setSelection();
1637 }
1638
1639
1640 void InsetMathNest::lfunMouseRelease(Cursor & cur, FuncRequest & cmd)
1641 {
1642         //lyxerr << "## lfunMouseRelease: buttons: " << cmd.button() << endl;
1643
1644         if (cmd.button() == mouse_button::button1) {
1645                 if (!cur.selection())
1646                         cur.noScreenUpdate();
1647                 else {
1648                         Cursor & bvcur = cur.bv().cursor();
1649                         bvcur.selection(true);
1650                 }
1651                 return;
1652         }
1653
1654         cur.undispatched();
1655 }
1656
1657
1658 bool InsetMathNest::interpretChar(Cursor & cur, char_type const c)
1659 {
1660         // try auto-correction
1661         if (lyxrc.autocorrection_math && cur.pos() != 0
1662                   && math_autocorrect(cur, c))
1663                 return true;
1664
1665         //lyxerr << "interpret 2: '" << c << "'" << endl;
1666         docstring save_selection;
1667         if (c == '^' || c == '_')
1668                 save_selection = grabAndEraseSelection(cur);
1669
1670         cur.clearTargetX();
1671         Buffer * buf = cur.buffer();
1672
1673         // handle macroMode
1674         if (cur.inMacroMode()) {
1675                 docstring name = cur.macroName();
1676
1677                 /// are we currently typing '#1' or '#2' or...?
1678                 if (name == "\\#") {
1679                         cur.backspace();
1680                         int n = c - '0';
1681                         if (n >= 1 && n <= 9)
1682                                 cur.insert(new InsetMathMacroArgument(n));
1683                         return true;
1684                 }
1685
1686                 // do not finish macro for known * commands
1687                 bool star_macro = c == '*'
1688                         && (in_word_set(name.substr(1) + '*')
1689                             || cur.buffer()->getMacro(name.substr(1) + "*", cur, true));
1690                 if (isAlphaASCII(c) || star_macro) {
1691                         cur.activeMacro()->setName(name + docstring(1, c));
1692                         return true;
1693                 }
1694
1695                 // handle 'special char' macros
1696                 if (name == "\\") {
1697                         // remove the '\\'
1698                         if (c == '\\') {
1699                                 cur.backspace();
1700                                 if (currentMode() != InsetMath::MATH_MODE)
1701                                         cur.niceInsert(createInsetMath("textbackslash", buf));
1702                                 else
1703                                         cur.niceInsert(createInsetMath("backslash", buf));
1704                         } else if (c == '^' && currentMode() == InsetMath::MATH_MODE) {
1705                                 cur.backspace();
1706                                 cur.niceInsert(createInsetMath("mathcircumflex", buf));
1707                         } else if (c == '{' || c == '%') {
1708                                 //using the saved selection as argument
1709                                 InsetMathUnknown * p = cur.activeMacro();
1710                                 p->finalize();
1711                                 MathData sel(cur.buffer());
1712                                 asArray(p->selection(), sel);
1713                                 cur.backspace();
1714                                 if (c == '{')
1715                                         cur.niceInsert(MathAtom(new InsetMathBrace(sel)));
1716                                 else
1717                                         cur.niceInsert(MathAtom(new InsetMathComment(sel)));
1718                         } else if (c == '#') {
1719                                 LASSERT(cur.activeMacro(), return false);
1720                                 cur.activeMacro()->setName(name + docstring(1, c));
1721                         } else {
1722                                 cur.backspace();
1723                                 cur.niceInsert(createInsetMath(docstring(1, c), buf));
1724                         }
1725                         return true;
1726                 }
1727
1728                 // One character big delimiters. The others are handled in
1729                 // interpretString().
1730                 latexkeys const * l = in_word_set(name.substr(1));
1731                 if (name[0] == '\\' && l && l->inset == "big") {
1732                         docstring delim;
1733                         switch (c) {
1734                         case '{':
1735                                 delim = from_ascii("\\{");
1736                                 break;
1737                         case '}':
1738                                 delim = from_ascii("\\}");
1739                                 break;
1740                         default:
1741                                 delim = docstring(1, c);
1742                                 break;
1743                         }
1744                         if (InsetMathBig::isBigInsetDelim(delim)) {
1745                                 // name + delim ared a valid InsetMathBig.
1746                                 // We can't use cur.macroModeClose() because
1747                                 // it does not handle delim.
1748                                 InsetMathUnknown * p = cur.activeMacro();
1749                                 p->finalize();
1750                                 --cur.pos();
1751                                 cur.cell().erase(cur.pos());
1752                                 cur.plainInsert(MathAtom(
1753                                         new InsetMathBig(name.substr(1), delim)));
1754                                 return true;
1755                         }
1756                 } else if (name == "\\smash" && c == '[') {
1757                         // We can't use cur.macroModeClose() because
1758                         // it would create an InsetMathPhantom
1759                         InsetMathUnknown * p = cur.activeMacro();
1760                         p->finalize();
1761                         interpretChar(cur, c);
1762                         return true;
1763                 }
1764
1765                 // leave macro mode and try again if necessary
1766                 if (cur.macroModeClose()) {
1767                         MathAtom const atom = cur.prevAtom();
1768                         if (atom->asNestInset() && atom->isActive()) {
1769                                 cur.posBackward();
1770                                 cur.nextInset()->edit(cur, true);
1771                         }
1772                 }
1773                 if (c == '{')
1774                         cur.niceInsert(MathAtom(new InsetMathBrace(buf)));
1775                 else if (c != ' ')
1776                         interpretChar(cur, c);
1777                 return true;
1778         }
1779
1780
1781         // just clear selection on pressing the space bar
1782         if (cur.selection() && c == ' ') {
1783                 cur.selection(false);
1784                 return true;
1785         }
1786
1787         if (c == '\\') {
1788                 //lyxerr << "starting with macro" << endl;
1789                 bool reduced = cap::reduceSelectionToOneCell(cur);
1790                 if (reduced || !cur.selection()) {
1791                         cur.recordUndoInset();
1792                         docstring const safe = cap::grabAndEraseSelection(cur);
1793                         if (!cur.inRegexped())
1794                                 cur.insert(MathAtom(new InsetMathUnknown(from_ascii("\\"), safe, false)));
1795                         else
1796                                 cur.niceInsert(createInsetMath("backslash", buf));
1797                 }
1798                 return true;
1799         }
1800
1801         selClearOrDel(cur);
1802
1803         if (c == '\n') {
1804                 if (currentMode() != InsetMath::MATH_MODE)
1805                         cur.insert(c);
1806                 return true;
1807         }
1808
1809         if (c == ' ') {
1810                 if (currentMode() != InsetMath::MATH_MODE) {
1811                         // insert spaces in text or undecided mode,
1812                         // but suppress direct insertion of two spaces in a row
1813                         // the still allows typing  '<space>a<space>' and deleting the 'a', but
1814                         // it is better than nothing...
1815                         if (cur.pos() == 0 || cur.prevAtom()->getChar() != ' ') {
1816                                 cur.insert(c);
1817                                 // FIXME: we have to enable full redraw here because of the
1818                                 // visual box corners that define the inset. If we know for
1819                                 // sure that we stay within the same cell we can optimize for
1820                                 // that using:
1821                                 //cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1822                         }
1823                         return true;
1824                 }
1825                 if (cur.pos() != 0 && cur.prevAtom()->asSpaceInset()) {
1826                         cur.prevAtom().nucleus()->asSpaceInset()->incSpace();
1827                         // FIXME: we have to enable full redraw here because of the
1828                         // visual box corners that define the inset. If we know for
1829                         // sure that we stay within the same cell we can optimize for
1830                         // that using:
1831                         //cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1832                         return true;
1833                 }
1834
1835                 if (cur.popForward()) {
1836                         // FIXME: we have to enable full redraw here because of the
1837                         // visual box corners that define the inset. If we know for
1838                         // sure that we stay within the same cell we can optimize for
1839                         // that using:
1840                         //cur.screenUpdateFlags(Update::FitCursor);
1841                         return true;
1842                 }
1843
1844                 // if we are at the very end, leave the formula
1845                 return cur.pos() != cur.lastpos();
1846         }
1847
1848         // These should be treated differently when not in text mode:
1849         if (cur.inRegexped()) {
1850                 switch (c) {
1851                 case '^':
1852                         cur.niceInsert(createInsetMath("mathcircumflex", buf));
1853                         break;
1854                 case '{':
1855                 case '}':
1856                 case '#':
1857                 case '%':
1858                 case '_':
1859                         cur.niceInsert(createInsetMath(docstring(1, c), buf));
1860                         break;
1861                 case '~':
1862                         cur.niceInsert(createInsetMath("sim", buf));
1863                         break;
1864                 default:
1865                         cur.insert(c);
1866                 }
1867                 return true;
1868         } else if (currentMode() != InsetMath::TEXT_MODE) {
1869                 if (c == '_') {
1870                         script(cur, false, save_selection);
1871                         return true;
1872                 }
1873                 if (c == '^') {
1874                         script(cur, true, save_selection);
1875                         return true;
1876                 }
1877                 if (c == '~') {
1878                         cur.niceInsert(createInsetMath("sim", buf));
1879                         return true;
1880                 }
1881                 if (currentMode() == InsetMath::MATH_MODE && Encodings::isUnicodeTextOnly(c)) {
1882                         MathAtom at = createInsetMath("text", buf);
1883                         at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1884                         cur.insert(at);
1885                         cur.posForward();
1886                         return true;
1887                 }
1888         } else {
1889                 if (c == '^') {
1890                         cur.niceInsert(createInsetMath("textasciicircum", buf));
1891                         return true;
1892                 }
1893                 if (c == '~') {
1894                         cur.niceInsert(createInsetMath("textasciitilde", buf));
1895                         return true;
1896                 }
1897         }
1898
1899         if (c == '{' || c == '}' || c == '&' || c == '$' || c == '#' ||
1900             c == '%' || c == '_') {
1901                 cur.niceInsert(createInsetMath(docstring(1, c), buf));
1902                 return true;
1903         }
1904
1905         // no special circumstances, so insert the character without any fuss
1906         cur.insert(c);
1907         return true;
1908 }
1909
1910
1911 bool InsetMathNest::interpretString(Cursor & cur, docstring const & str)
1912 {
1913         if (str == "\\limits" || str == "\\nolimits") {
1914                 if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange()) {
1915                         cur.prevMath().limits(str == "\\limits" ? LIMITS : NO_LIMITS);
1916                         return true;
1917                 } else {
1918                         cur.message(bformat(_("Cannot apply %1$s here."), str));
1919                         return false;
1920                 }
1921         }
1922         // Create a InsetMathBig from cur.cell()[cur.pos() - 1] and t if
1923         // possible
1924         if (!cur.empty() && cur.pos() > 0 &&
1925             cur.cell()[cur.pos() - 1]->asUnknownInset()) {
1926                 if (InsetMathBig::isBigInsetDelim(str)) {
1927                         docstring prev = asString(cur.cell()[cur.pos() - 1]);
1928                         if (prev[0] == '\\') {
1929                                 prev = prev.substr(1);
1930                                 latexkeys const * l = in_word_set(prev);
1931                                 if (l && l->inset == "big") {
1932                                         cur.recordUndoSelection();
1933                                         cur.cell()[cur.pos() - 1] =
1934                                                 MathAtom(new InsetMathBig(prev, str));
1935                                         return true;
1936                                 }
1937                         }
1938                 }
1939         }
1940         return false;
1941 }
1942
1943
1944 bool InsetMathNest::script(Cursor & cur, bool up)
1945 {
1946         return script(cur, up, docstring());
1947 }
1948
1949
1950 bool InsetMathNest::script(Cursor & cur, bool up,
1951                 docstring const & save_selection)
1952 {
1953         // Hack to get \^ and \_ working
1954         //lyxerr << "handling script: up: " << up << endl;
1955         if (cur.inMacroMode() && cur.macroName() == "\\") {
1956                 if (up)
1957                         cur.niceInsert(createInsetMath("mathcircumflex", cur.buffer()));
1958                 else
1959                         interpretChar(cur, '_');
1960                 return true;
1961         }
1962
1963         cur.macroModeClose();
1964         if (asScriptInset() && cur.idx() == 0) {
1965                 // we are in a nucleus of a script inset, move to _our_ script
1966                 InsetMathScript * inset = asScriptInset();
1967                 //lyxerr << " going to cell " << inset->idxOfScript(up) << endl;
1968                 inset->ensure(up);
1969                 cur.idx() = inset->idxOfScript(up);
1970                 cur.pos() = 0;
1971         } else if (cur.pos() != 0 && cur.prevAtom()->asScriptInset()) {
1972                 --cur.pos();
1973                 InsetMathScript * inset = cur.nextAtom().nucleus()->asScriptInset();
1974                 cur.push(*inset);
1975                 inset->ensure(up);
1976                 cur.idx() = inset->idxOfScript(up);
1977                 cur.pos() = cur.lastpos();
1978         } else {
1979                 // convert the thing to our left to a scriptinset or create a new
1980                 // one if in the very first position of the array
1981                 if (cur.pos() == 0) {
1982                         //lyxerr << "new scriptinset" << endl;
1983                         cur.insert(new InsetMathScript(buffer_, up));
1984                 } else {
1985                         //lyxerr << "converting prev atom " << endl;
1986                         cur.prevAtom() = MathAtom(new InsetMathScript(buffer_, cur.prevAtom(), up));
1987                 }
1988                 --cur.pos();
1989                 InsetMathScript * inset = cur.nextAtom().nucleus()->asScriptInset();
1990                 // See comment in MathParser.cpp for special handling of {}-bases
1991
1992                 cur.push(*inset);
1993                 cur.idx() = 1;
1994                 cur.pos() = 0;
1995         }
1996         //lyxerr << "inserting selection 1:\n" << save_selection << endl;
1997         cur.niceInsert(save_selection);
1998         cur.resetAnchor();
1999         //lyxerr << "inserting selection 2:\n" << save_selection << endl;
2000         return true;
2001 }
2002
2003
2004 bool InsetMathNest::completionSupported(Cursor const & cur) const
2005 {
2006         return cur.inMacroMode();
2007 }
2008
2009
2010 bool InsetMathNest::inlineCompletionSupported(Cursor const & cur) const
2011 {
2012         return cur.inMacroMode();
2013 }
2014
2015
2016 bool InsetMathNest::automaticInlineCompletion() const
2017 {
2018         return lyxrc.completion_inline_math;
2019 }
2020
2021
2022 bool InsetMathNest::automaticPopupCompletion() const
2023 {
2024         return lyxrc.completion_popup_math;
2025 }
2026
2027
2028 CompletionList const *
2029 InsetMathNest::createCompletionList(Cursor const & cur) const
2030 {
2031         if (!cur.inMacroMode())
2032                 return nullptr;
2033
2034         return new MathCompletionList(cur);
2035 }
2036
2037
2038 docstring InsetMathNest::completionPrefix(Cursor const & cur) const
2039 {
2040         if (!cur.inMacroMode())
2041                 return docstring();
2042
2043         return cur.activeMacro()->name();
2044 }
2045
2046
2047 bool InsetMathNest::insertCompletion(Cursor & cur, docstring const & s,
2048                                      bool finished)
2049 {
2050         if (!cur.inMacroMode())
2051                 return false;
2052
2053         // append completion to active macro
2054         InsetMathUnknown * inset = cur.activeMacro();
2055         inset->setName(inset->name() + s);
2056
2057         // finish macro
2058         if (finished) {
2059 #if 0
2060                 // FIXME: this creates duplicates in the completion popup
2061                 // which looks ugly. Moreover the changes the list lengths
2062                 // which seems to confuse the popup as well.
2063                 MathCompletionList::addToFavorites(inset->name());
2064 #endif
2065                 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, " "));
2066         }
2067
2068         return true;
2069 }
2070
2071
2072 void InsetMathNest::completionPosAndDim(Cursor const & cur, int & x, int & y,
2073                                         Dimension & dim) const
2074 {
2075         Inset const * inset = cur.activeMacro();
2076         if (!inset)
2077                 return;
2078
2079         // get inset dimensions
2080         dim = cur.bv().coordCache().insets().dim(inset);
2081         // FIXME: these 3 are no accurate, but should depend on the font.
2082         // Now the popup jumps down if you enter a char with descent > 0.
2083         dim.des += 3;
2084         dim.asc += 3;
2085
2086         // and position
2087         Point xy = cur.bv().coordCache().insets().xy(inset);
2088         x = xy.x_;
2089         y = xy.y_;
2090 }
2091
2092
2093 ////////////////////////////////////////////////////////////////////
2094
2095 MathCompletionList::MathCompletionList(Cursor const & cur)
2096 {
2097         // fill it with macros from the buffer
2098         MacroNameSet macros;
2099         cur.buffer()->listMacroNames(macros);
2100         MacroNameSet::const_iterator it;
2101         for (it = macros.begin(); it != macros.end(); ++it) {
2102                 if (cur.buffer()->getMacro(*it, cur, false))
2103                         locals.push_back("\\" + *it);
2104         }
2105         sort(locals.begin(), locals.end());
2106
2107         if (!globals.empty())
2108                 return;
2109
2110         // fill in global macros
2111         macros.clear();
2112         MacroTable::globalMacros().getMacroNames(macros, false);
2113         //lyxerr << "Globals completion macros: ";
2114         for (it = macros.begin(); it != macros.end(); ++it) {
2115                 //lyxerr << "\\" + *it << " ";
2116                 globals.push_back("\\" + *it);
2117         }
2118         //lyxerr << std::endl;
2119
2120         // fill in global commands
2121         globals.push_back(from_ascii("\\boxed"));
2122         globals.push_back(from_ascii("\\fbox"));
2123         globals.push_back(from_ascii("\\framebox"));
2124         globals.push_back(from_ascii("\\makebox"));
2125         globals.push_back(from_ascii("\\kern"));
2126         globals.push_back(from_ascii("\\xhookrightarrow"));
2127         globals.push_back(from_ascii("\\xhookleftarrow"));
2128         globals.push_back(from_ascii("\\xrightarrow"));
2129         globals.push_back(from_ascii("\\xRightarrow"));
2130         globals.push_back(from_ascii("\\xrightharpoondown"));
2131         globals.push_back(from_ascii("\\xrightharpoonup"));
2132         globals.push_back(from_ascii("\\xrightleftharpoons"));
2133         globals.push_back(from_ascii("\\xleftarrow"));
2134         globals.push_back(from_ascii("\\xLeftarrow"));
2135         globals.push_back(from_ascii("\\xleftharpoondown"));
2136         globals.push_back(from_ascii("\\xleftharpoonup"));
2137         globals.push_back(from_ascii("\\xleftrightarrow"));
2138         globals.push_back(from_ascii("\\xLeftrightarrow"));
2139         globals.push_back(from_ascii("\\xleftrightharpoons"));
2140         globals.push_back(from_ascii("\\xmapsto"));
2141         globals.push_back(from_ascii("\\split"));
2142         globals.push_back(from_ascii("\\gathered"));
2143         globals.push_back(from_ascii("\\aligned"));
2144         globals.push_back(from_ascii("\\alignedat"));
2145         globals.push_back(from_ascii("\\cases"));
2146         globals.push_back(from_ascii("\\substack"));
2147         globals.push_back(from_ascii("\\xymatrix"));
2148         globals.push_back(from_ascii("\\Diagram"));
2149         globals.push_back(from_ascii("\\subarray"));
2150         globals.push_back(from_ascii("\\array"));
2151         globals.push_back(from_ascii("\\sqrt"));
2152         globals.push_back(from_ascii("\\root"));
2153         globals.push_back(from_ascii("\\tabular"));
2154         globals.push_back(from_ascii("\\sideset"));
2155         globals.push_back(from_ascii("\\stackrel"));
2156         globals.push_back(from_ascii("\\stackrelthree"));
2157         globals.push_back(from_ascii("\\binom"));
2158         globals.push_back(from_ascii("\\choose"));
2159         globals.push_back(from_ascii("\\brace"));
2160         globals.push_back(from_ascii("\\brack"));
2161         globals.push_back(from_ascii("\\frac"));
2162         globals.push_back(from_ascii("\\over"));
2163         globals.push_back(from_ascii("\\nicefrac"));
2164         globals.push_back(from_ascii("\\unitfrac"));
2165         globals.push_back(from_ascii("\\unitfracthree"));
2166         globals.push_back(from_ascii("\\unitone"));
2167         globals.push_back(from_ascii("\\unittwo"));
2168         globals.push_back(from_ascii("\\infer"));
2169         globals.push_back(from_ascii("\\atop"));
2170         globals.push_back(from_ascii("\\lefteqn"));
2171         globals.push_back(from_ascii("\\boldsymbol"));
2172         globals.push_back(from_ascii("\\bm"));
2173         globals.push_back(from_ascii("\\color"));
2174         globals.push_back(from_ascii("\\normalcolor"));
2175         globals.push_back(from_ascii("\\textcolor"));
2176         globals.push_back(from_ascii("\\cfrac"));
2177         globals.push_back(from_ascii("\\cfracleft"));
2178         globals.push_back(from_ascii("\\cfracright"));
2179         globals.push_back(from_ascii("\\dfrac"));
2180         globals.push_back(from_ascii("\\tfrac"));
2181         globals.push_back(from_ascii("\\dbinom"));
2182         globals.push_back(from_ascii("\\tbinom"));
2183         globals.push_back(from_ascii("\\hphantom"));
2184         globals.push_back(from_ascii("\\phantom"));
2185         globals.push_back(from_ascii("\\vphantom"));
2186         globals.push_back(from_ascii("\\cancel"));
2187         globals.push_back(from_ascii("\\bcancel"));
2188         globals.push_back(from_ascii("\\xcancel"));
2189         globals.push_back(from_ascii("\\cancelto"));
2190         globals.push_back(from_ascii("\\smash"));
2191         globals.push_back(from_ascii("\\mathclap"));
2192         globals.push_back(from_ascii("\\mathllap"));
2193         globals.push_back(from_ascii("\\mathrlap"));
2194         globals.push_back(from_ascii("\\ensuremath"));
2195         MathWordList const & words = mathedWordList();
2196         MathWordList::const_iterator it2;
2197         //lyxerr << "Globals completion commands: ";
2198         for (it2 = words.begin(); it2 != words.end(); ++it2) {
2199                 if (it2->second.inset != "macro" && !it2->second.hidden) {
2200                         // macros are already read from MacroTable::globalMacros()
2201                         globals.push_back('\\' + it2->first);
2202                         //lyxerr << '\\' + it2->first << ' ';
2203                 }
2204         }
2205         //lyxerr << std::endl;
2206         sort(globals.begin(), globals.end());
2207 }
2208
2209
2210 MathCompletionList::~MathCompletionList()
2211 {
2212 }
2213
2214
2215 size_type MathCompletionList::size() const
2216 {
2217         return locals.size() + globals.size();
2218 }
2219
2220
2221 docstring const & MathCompletionList::data(size_t idx) const
2222 {
2223         size_t lsize = locals.size();
2224         if (idx >= lsize)
2225                 return globals[idx - lsize];
2226         else
2227                 return locals[idx];
2228 }
2229
2230
2231 std::string MathCompletionList::icon(size_t idx) const
2232 {
2233         // get the latex command
2234         docstring cmd;
2235         size_t lsize = locals.size();
2236         if (idx >= lsize)
2237                 cmd = globals[idx - lsize];
2238         else
2239                 cmd = locals[idx];
2240
2241         // get the icon name by stripping the backslash
2242         docstring icon_name = frontend::Application::mathIcon(cmd.substr(1));
2243         if (icon_name.empty())
2244                 return std::string();
2245         return "math/" + to_utf8(icon_name);
2246 }
2247
2248 std::vector<docstring> MathCompletionList::globals;
2249
2250 } // namespace lyx