2 * \file math_nestinset.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "math_nestinset.h"
15 #include "math_arrayinset.h"
16 #include "math_braceinset.h"
17 #include "math_commentinset.h"
18 #include "math_data.h"
19 #include "math_deliminset.h"
20 #include "math_factory.h"
21 #include "math_hullinset.h"
22 #include "math_mathmlstream.h"
23 #include "math_parser.h"
24 #include "math_scriptinset.h"
25 #include "math_spaceinset.h"
26 #include "math_support.h"
27 #include "math_mboxinset.h"
28 #include "math_unknowninset.h"
30 #include "BufferView.h"
31 #include "bufferview_funcs.h"
34 #include "dispatchresult.h"
35 #include "funcrequest.h"
40 #include "support/std_sstream.h"
41 #include "support/lstrings.h"
43 #include "frontends/Dialogs.h"
44 #include "frontends/LyXView.h"
45 #include "frontends/Painter.h"
50 using std::istringstream;
64 MathNestInset::MathNestInset(idx_type nargs)
65 : cells_(nargs), lock_(false)
69 MathInset::idx_type MathNestInset::nargs() const
75 MathArray & MathNestInset::cell(idx_type i)
81 MathArray const & MathNestInset::cell(idx_type i) const
87 void MathNestInset::getCursorPos(CursorSlice const & cur,
88 int & x, int & y) const
90 BOOST_ASSERT(ptr_cmp(cur.inset(), this));
91 MathArray const & ar = cur.cell();
92 x = ar.xo() + ar.pos2x(cur.pos());
94 // move cursor visually into empty cells ("blue rectangles");
95 if (cur.cell().empty())
100 void MathNestInset::substitute(MathMacro const & m)
102 for (idx_type i = 0; i < nargs(); ++i)
103 cell(i).substitute(m);
107 void MathNestInset::metrics(MetricsInfo const & mi) const
110 for (idx_type i = 0; i < nargs(); ++i)
115 bool MathNestInset::idxNext(LCursor & cur) const
117 BOOST_ASSERT(ptr_cmp(cur.inset(), this));
118 if (cur.idx() == cur.lastidx())
126 bool MathNestInset::idxRight(LCursor & cur) const
132 bool MathNestInset::idxPrev(LCursor & cur) const
134 BOOST_ASSERT(ptr_cmp(cur.inset(), this));
138 cur.pos() = cur.lastpos();
143 bool MathNestInset::idxLeft(LCursor & cur) const
149 bool MathNestInset::idxFirst(LCursor & cur) const
151 BOOST_ASSERT(ptr_cmp(cur.inset(), this));
160 bool MathNestInset::idxLast(LCursor & cur) const
162 BOOST_ASSERT(ptr_cmp(cur.inset(), this));
165 cur.idx() = cur.lastidx();
166 cur.pos() = cur.lastpos();
171 void MathNestInset::dump() const
173 WriteStream os(lyxerr);
174 os << "---------------------------------------------\n";
177 for (idx_type i = 0; i < nargs(); ++i)
178 os << cell(i) << "\n";
179 os << "---------------------------------------------\n";
183 //void MathNestInset::draw(PainterInfo & pi, int x, int y) const
184 void MathNestInset::draw(PainterInfo &, int, int) const
188 pi.pain.fillRectangle(x, y - ascent(), width(), height(),
194 void MathNestInset::drawSelection(PainterInfo & pi, int, int) const
196 // this should use the x/y values given, not the cached values
197 LCursor & cur = pi.base.bv->cursor();
198 if (!cur.selection())
200 if (!ptr_cmp(cur.inset(), this))
202 CursorSlice & s1 = cur.selBegin();
203 CursorSlice & s2 = cur.selEnd();
204 if (s1.idx() == s2.idx()) {
205 MathArray const & c = cell(s1.idx());
206 int x1 = c.xo() + c.pos2x(s1.pos());
207 int y1 = c.yo() - c.ascent();
208 int x2 = c.xo() + c.pos2x(s2.pos());
209 int y2 = c.yo() + c.descent();
210 pi.pain.fillRectangle(x1, y1, x2 - x1, y2 - y1, LColor::selection);
212 for (idx_type i = 0; i < nargs(); ++i) {
213 if (idxBetween(i, s1.idx(), s2.idx())) {
214 MathArray const & c = cell(i);
216 int y1 = c.yo() - c.ascent();
217 int x2 = c.xo() + c.width();
218 int y2 = c.yo() + c.descent();
219 pi.pain.fillRectangle(x1, y1, x2 - x1, y2 - y1, LColor::selection);
226 void MathNestInset::validate(LaTeXFeatures & features) const
228 for (idx_type i = 0; i < nargs(); ++i)
229 cell(i).validate(features);
233 void MathNestInset::replace(ReplaceData & rep)
235 for (idx_type i = 0; i < nargs(); ++i)
236 cell(i).replace(rep);
240 bool MathNestInset::contains(MathArray const & ar) const
242 for (idx_type i = 0; i < nargs(); ++i)
243 if (cell(i).contains(ar))
249 bool MathNestInset::lock() const
255 void MathNestInset::lock(bool l)
261 bool MathNestInset::isActive() const
267 MathArray MathNestInset::glue() const
270 for (size_t i = 0; i < nargs(); ++i)
276 void MathNestInset::write(WriteStream & os) const
278 os << '\\' << name().c_str();
279 for (size_t i = 0; i < nargs(); ++i)
280 os << '{' << cell(i) << '}';
282 os.pendingSpace(true);
283 if (lock_ && !os.latex()) {
285 os.pendingSpace(true);
290 void MathNestInset::normalize(NormalStream & os) const
292 os << '[' << name().c_str();
293 for (size_t i = 0; i < nargs(); ++i)
294 os << ' ' << cell(i);
299 void MathNestInset::notifyCursorLeaves(idx_type idx)
301 cell(idx).notifyCursorLeaves();
305 void MathNestInset::handleFont
306 (LCursor & cur, string const & arg, string const & font)
308 // this whole function is a hack and won't work for incremental font
310 recordUndo(cur, Undo::ATOMIC);
312 if (cur.inset()->asMathInset()->name() == font)
313 cur.handleFont(font);
315 cur.handleNest(createMathInset(font));
321 void MathNestInset::handleFont2(LCursor & cur, string const & arg)
323 recordUndo(cur, Undo::ATOMIC);
326 bv_funcs::string2font(arg, font, b);
327 if (font.color() != LColor::inherit) {
328 MathAtom at = createMathInset("color");
329 asArray(lcolor.getGUIName(font.color()), at.nucleus()->cell(0));
330 cur.handleNest(at, 1);
335 void MathNestInset::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
337 lyxerr << "MathNestInset: request: " << cmd << std::endl;
338 //CursorSlice sl = cur.current();
340 switch (cmd.action) {
343 if (!cmd.argument.empty()) {
345 mathed_parse_cell(ar, cmd.argument);
346 cur.cell().insert(cur.pos(), ar);
347 cur.pos() += ar.size();
353 istringstream is(cmd.argument.c_str());
356 cur.macroModeClose();
357 recordUndo(cur, Undo::ATOMIC);
363 case LFUN_PASTESELECTION:
364 dispatch(cur, FuncRequest(LFUN_PASTE, cur.bv().getClipboard()));
367 case LFUN_MOUSE_PRESS:
368 lfunMousePress(cur, cmd);
371 case LFUN_MOUSE_MOTION:
372 lfunMouseMotion(cur, cmd);
375 case LFUN_MOUSE_RELEASE:
376 lfunMouseRelease(cur, cmd);
379 case LFUN_MOUSE_DOUBLE:
380 case LFUN_MOUSE_TRIPLE:
381 //lyxerr << "Mouse double" << endl;
382 //lyxerr << "Mouse triple" << endl;
383 dispatch(cur, FuncRequest(LFUN_WORDSEL));
386 case LFUN_FINISHED_LEFT:
387 cur.bv().cursor() = cur;
390 case LFUN_FINISHED_RIGHT:
392 cur.bv().cursor() = cur;
395 case LFUN_FINISHED_UP:
396 //idxUpDown(cur, true);
397 cur.bv().cursor() = cur;
400 case LFUN_FINISHED_DOWN:
401 //idxUpDown(cur, false);
402 cur.bv().cursor() = cur;
407 lyxerr << "mathnest RIGHT: from:\n" << cur << endl;
408 cur.selHandle(cmd.action == LFUN_RIGHTSEL);
409 cur.autocorrect() = false;
411 if (cur.inMacroMode())
412 cur.macroModeClose();
413 else if (cur.pos() != cur.lastpos() && cur.openable(cur.nextAtom())) {
414 cur.pushLeft(cur.nextAtom().nucleus());
415 cur.inset()->idxFirst(cur);
416 } else if (cur.posRight() || idxRight(cur)
417 || cur.popRight() || cur.selection())
420 cur.dispatched(FINISHED_RIGHT);
421 lyxerr << "mathnest RIGHT: to:\n" << cur << endl;
426 cur.selHandle(cmd.action == LFUN_LEFTSEL);
427 cur.autocorrect() = false;
429 if (cur.inMacroMode())
430 cur.macroModeClose();
431 else if (cur.pos() != 0 && cur.openable(cur.prevAtom())) {
433 cur.push(cur.nextAtom().nucleus());
434 cur.inset()->idxLast(cur);
435 } else if (cur.posLeft() || idxLeft(cur)
436 || cur.popLeft() || cur.selection())
439 cur.dispatched(FINISHED_LEFT);
444 cur.selHandle(cmd.action == LFUN_UPSEL);
446 cur.dispatched(FINISHED_UP);
451 cur.selHandle(cmd.action == LFUN_DOWNSEL);
453 cur.dispatched(FINISHED_DOWN);
460 cur.selection() = true;
461 cur.pos() = cur.lastpos();
462 cur.idx() = cur.lastidx();
465 case LFUN_UP_PARAGRAPHSEL:
466 case LFUN_UP_PARAGRAPH:
467 case LFUN_DOWN_PARAGRAPHSEL:
468 case LFUN_DOWN_PARAGRAPH:
473 case LFUN_WORDLEFTSEL:
475 cur.selHandle(cmd.action == LFUN_WORDLEFTSEL || cmd.action == LFUN_HOMESEL);
476 cur.macroModeClose();
477 if (cur.pos() != 0) {
479 } else if (cur.col() != 0) {
480 cur.idx() -= cur.col();
482 } else if (cur.idx() != 0) {
486 cur.dispatched(FINISHED_LEFT);
490 case LFUN_WORDRIGHTSEL:
494 cur.selHandle(cmd.action == LFUN_WORDRIGHTSEL || cmd.action == LFUN_ENDSEL);
495 cur.macroModeClose();
497 if (cur.pos() != cur.lastpos()) {
498 cur.pos() = cur.lastpos();
499 } else if (cur.col() != cur.lastcol()) {
500 cur.idx() = cur.idx() - cur.col() + cur.lastcol();
501 cur.pos() = cur.lastpos();
502 } else if (cur.idx() != cur.lastidx()) {
503 cur.idx() = cur.lastidx();
504 cur.pos() = cur.lastpos();
506 cur.dispatched(FINISHED_RIGHT);
512 case LFUN_BEGINNINGBUFSEL:
513 case LFUN_BEGINNINGBUF:
514 cur.dispatched(FINISHED_LEFT);
521 cur.dispatched(FINISHED_RIGHT);
524 case LFUN_CELL_FORWARD:
525 cur.inset()->idxNext(cur);
528 case LFUN_CELL_BACKWARD:
529 cur.inset()->idxPrev(cur);
532 case LFUN_DELETE_WORD_BACKWARD:
534 recordUndo(cur, Undo::ATOMIC);
538 case LFUN_DELETE_WORD_FORWARD:
540 recordUndo(cur, Undo::ATOMIC);
542 cur.dispatched(FINISHED_LEFT);
549 cur.dispatched(FINISHED_LEFT);
552 case LFUN_INSET_TOGGLE:
554 if (cur.pos() != cur.lastpos()) {
555 // toggle previous inset ...
556 cur.nextAtom().nucleus()->lock(!cur.nextAtom()->lock());
557 } else if (cur.popLeft() && cur.pos() != cur.lastpos()) {
558 // ... or enclosing inset if we are in the last inset position
559 cur.nextAtom().nucleus()->lock(!cur.nextAtom()->lock());
564 case LFUN_SELFINSERT:
565 if (cmd.argument.empty()) {
566 cur.dispatched(FINISHED_RIGHT);
569 recordUndo(cur, Undo::ATOMIC);
570 if (cmd.argument.size() != 1) {
571 cur.insert(cmd.argument);
574 if (!interpret(cur, cmd.argument[0]))
575 cur.dispatched(FINISHED_RIGHT);
580 // this needs to be incorporated
582 // delete empty mathbox (LFUN_BACKSPACE and LFUN_DELETE)
583 bool remove_inset = false;
585 DispatchResult result(true);
586 bool was_macro = cur.inMacroMode();
593 // sprintf(dispatch_buffer, "%d %d",);
594 // DispatchResult= dispatch_buffer;
597 lyxerr << "LFUN_SETXY broken!" << endl;
600 istringstream is(cmd.argument.c_str());
602 cur.setScreenPos(x, y);
607 recordUndo(cur, Undo::DELETE);
615 // Special casing for superscript in case of LyX handling
617 case LFUN_CIRCUMFLEX:
618 if (cmd.argument.empty()) {
619 // do superscript if LyX handles
621 recordUndo(cur, Undo::ATOMIC);
639 case LFUN_HUNG_UMLAUT:
643 case LFUN_FREEFONT_APPLY:
644 case LFUN_FREEFONT_UPDATE:
645 handleFont2(cur, cmd.argument);
649 handleFont(cur, cmd.argument, "mathbf");
652 handleFont(cur, cmd.argument, "mathsf");
655 handleFont(cur, cmd.argument, "mathcal");
658 handleFont(cur, cmd.argument, "mathrm");
661 handleFont(cur, cmd.argument, "texttt");
664 handleFont(cur, cmd.argument, "mathfrak");
667 handleFont(cur, cmd.argument, "mathit");
670 handleFont(cur, cmd.argument, "mathbb");
672 //case LFUN_FREEFONT_APPLY:
673 handleFont(cur, cmd.argument, "textrm");
676 handleFont(cur, cmd.argument, "textnormal");
681 cur.macroModeClose();
683 cur.plainInsert(MathAtom(new MathMBoxInset(cur.bv())));
685 cur.pushLeft(cur.nextInset());
687 if (currentMode() == InsetBase::TEXT_MODE)
688 cur.niceInsert(MathAtom(new MathHullInset("simple")));
690 handleFont(cur, cmd.argument, "textrm");
691 //cur.owner()->message(_("math text mode toggled"));
698 recordUndo(cur, Undo::ATOMIC);
704 case LFUN_INSERT_MATRIX: {
705 recordUndo(cur, Undo::ATOMIC);
710 istringstream is(cmd.argument);
711 is >> m >> n >> v_align >> h_align;
718 MathAtom(new MathArrayInset("array", m, n, v_align[0], h_align)));
722 case LFUN_MATH_DELIM: {
723 lyxerr << "MathNestInset::LFUN_MATH_DELIM" << endl;
725 string rs = lyx::support::split(cmd.argument, ls, ' ');
726 // Reasonable default values
731 recordUndo(cur, Undo::ATOMIC);
732 cur.handleNest(MathAtom(new MathDelimInset(ls, rs)));
736 case LFUN_SPACE_INSERT:
737 case LFUN_MATH_SPACE:
738 recordUndo(cur, Undo::ATOMIC);
739 cur.insert(MathAtom(new MathSpaceInset(",")));
744 //cur.bv().owner()->message(_("Invalid action in math mode!"));
748 // interpret this as if a backslash was typed
749 recordUndo(cur, Undo::ATOMIC);
750 interpret(cur, '\\');
753 // FIXME: We probably should swap parts of "math-insert" and "self-insert"
754 // handling such that "self-insert" works on "arbitrary stuff" too, and
755 // math-insert only handles special math things like "matrix".
756 case LFUN_INSERT_MATH:
757 recordUndo(cur, Undo::ATOMIC);
758 cur.niceInsert(cmd.argument);
761 case LFUN_DIALOG_SHOW_NEW_INSET: {
762 string const & name = cmd.argument;
767 data = tmp.createDialogStr(name);
770 cur.bv().owner()->getDialogs().show(name, data, 0);
774 case LFUN_INSET_APPLY: {
775 string const name = cmd.getArg(0);
776 InsetBase * base = cur.bv().owner()->getDialogs().getOpenInset(name);
779 base->dispatch(cur, FuncRequest(LFUN_INSET_MODIFY, cmd.argument));
783 if (createMathInset_fromDialogStr(cmd.argument, ar)) {
794 case LFUN_WORD_REPLACE:
796 if (!searchForward(&cur.bv(), cmd.getArg(0), false, false))
803 BOOST_ASSERT(cur.inMathed());
805 if (result.dispatched()) {
807 cur.bv().stuffClipboard(cur.grabSelection());
810 cur.bv().owner()->dispatch(FuncRequest(LFUN_DELETE));
816 MathDimInset::priv_dispatch(cur, cmd);
822 void MathNestInset::edit(LCursor & cur, bool left)
825 cur.idx() = left ? 0 : cur.lastidx();
826 cur.pos() = left ? 0 : cur.lastpos();
831 InsetBase * MathNestInset::editXY(LCursor & cur, int x, int y)
834 int dist_min = 1000000;
835 for (idx_type i = 0; i < nargs(); ++i) {
836 int d = cell(i).dist(x, y);
842 MathArray & ar = cell(idx_min);
845 cur.pos() = ar.x2pos(x - ar.xo());
846 lyxerr << "found cell : " << idx_min << " pos: " << cur.pos() << endl;
849 for (pos_type i = 0, n = ar.size(); i < n; ++i)
850 if (ar[i]->covers(x, y))
851 return ar[i].nucleus()->editXY(cur, x, y);
857 void MathNestInset::lfunMouseRelease(LCursor & cur, FuncRequest const & cmd)
859 //lyxerr << "lfunMouseRelease: buttons: " << cmd.button() << endl;
861 if (cmd.button() == mouse_button::button1) {
862 // try to dispatch to enclosed insets first
863 //cur.bv().stuffClipboard(cur.grabSelection());
867 if (cmd.button() == mouse_button::button2) {
869 asArray(cur.bv().getClipboard(), ar);
871 cur.setScreenPos(cmd.x, cmd.y);
877 if (cmd.button() == mouse_button::button3) {
878 // try to dispatch to enclosed insets first
879 cur.bv().owner()->getDialogs().show("mathpanel");
887 void MathNestInset::lfunMousePress(LCursor & cur, FuncRequest const & cmd)
889 lyxerr << "lfunMousePress: buttons: " << cmd.button() << endl;
890 if (cmd.button() == mouse_button::button1) {
894 //cur.setScreenPos(cmd.x + xo_, cmd.y + yo_);
895 lyxerr << "lfunMousePress: setting cursor to: " << cur << endl;
896 cur.bv().cursor() = cur;
899 if (cmd.button() == mouse_button::button2) {
900 priv_dispatch(cur, FuncRequest(LFUN_PASTESELECTION));
905 void MathNestInset::lfunMouseMotion(LCursor & cur, FuncRequest const & cmd)
907 // only select with button 1
908 if (cmd.button() != mouse_button::button1)
911 if (abs(cmd.x - first_x) < 2 && abs(cmd.y - first_y) < 2)
917 if (!cur.selection())
920 //cur.setScreenPos(cmd.x + xo_, cmd.y + yo_);
921 cur.bv().cursor().setCursor(cur, true);
925 bool MathNestInset::interpret(LCursor & cur, char c)
927 //lyxerr << "interpret 2: '" << c << "'" << endl;
929 if (cur.inMacroArgMode()) {
935 MathMacroTemplate const * p = formula()->asMacroTemplate();
936 if (p && 1 <= n && n <= p->numargs())
937 cur.insert(MathAtom(new MathMacroArgument(c - '0')));
939 cur.insert(createMathInset("#"));
940 interpret(cur, c); // try again
947 if (cur.inMacroMode()) {
948 string name = cur.macroName();
949 //lyxerr << "interpret name: '" << name << "'" << endl;
952 cur.activeMacro()->setName(cur.activeMacro()->name() + c);
956 // handle 'special char' macros
961 if (currentMode() == MathInset::TEXT_MODE)
962 cur.niceInsert(createMathInset("textbackslash"));
964 cur.niceInsert(createMathInset("backslash"));
965 } else if (c == '{') {
966 cur.niceInsert(MathAtom(new MathBraceInset));
968 cur.niceInsert(createMathInset(string(1, c)));
973 // leave macro mode and try again if necessary
974 cur.macroModeClose();
976 cur.niceInsert(MathAtom(new MathBraceInset));
982 // This is annoying as one has to press <space> far too often.
986 // leave autocorrect mode if necessary
987 if (autocorrect() && c == ' ') {
988 autocorrect() = false;
993 // just clear selection on pressing the space bar
994 if (cur.selection() && c == ' ') {
995 cur.selection() = false;
1002 //lyxerr << "starting with macro" << endl;
1003 cur.insert(MathAtom(new MathUnknownInset("\\", false)));
1008 if (currentMode() == MathInset::TEXT_MODE)
1014 if (currentMode() == MathInset::TEXT_MODE) {
1015 // insert spaces in text mode,
1016 // but suppress direct insertion of two spaces in a row
1017 // the still allows typing '<space>a<space>' and deleting the 'a', but
1018 // it is better than nothing...
1019 if (!cur.pos() != 0 || cur.prevAtom()->getChar() != ' ')
1023 if (cur.pos() != 0 && cur.prevAtom()->asSpaceInset()) {
1024 cur.prevAtom().nucleus()->asSpaceInset()->incSpace();
1029 // if are at the very end, leave the formula
1030 return cur.pos() != cur.lastpos();
1043 if (c == '{' || c == '}' || c == '#' || c == '&' || c == '$') {
1044 cur.niceInsert(createMathInset(string(1, c)));
1049 cur.niceInsert(MathAtom(new MathCommentInset));
1053 // try auto-correction
1054 //if (autocorrect() && hasPrevAtom() && math_autocorrect(prevAtom(), c))
1057 // no special circumstances, so insert the character without any fuss
1059 cur.autocorrect() = true;
1064 bool MathNestInset::script(LCursor & cur, bool up)
1066 // Hack to get \\^ and \\_ working
1067 lyxerr << "handling script: up: " << up << endl;
1068 if (cur.inMacroMode() && cur.macroName() == "\\") {
1070 cur.niceInsert(createMathInset("mathcircumflex"));
1072 interpret(cur, '_');
1076 cur.macroModeClose();
1077 string safe = cur.grabAndEraseSelection();
1078 if (asScriptInset() && cur.idx() == 2) {
1079 // we are in a nucleus of a script inset, move to _our_ script
1080 asScriptInset()->ensure(up);
1083 } else if (cur.pos() != 0 && cur.prevAtom()->asScriptInset()) {
1085 cur.nextAtom().nucleus()->asScriptInset()->ensure(up);
1086 cur.push(cur.nextInset());
1088 cur.pos() = cur.lastpos();
1089 } else if (cur.pos() != 0) {
1091 cur.cell()[cur.pos()] = MathAtom(new MathScriptInset(cur.nextAtom(), up));
1092 cur.push(cur.nextInset());
1096 cur.plainInsert(MathAtom(new MathScriptInset(up)));
1098 cur.nextAtom().nucleus()->asScriptInset()->ensure(up);
1099 cur.push(cur.nextInset());