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.pop(cur.currentDepth());
388 cur.bv().cursor() = cur;
391 case LFUN_FINISHED_RIGHT:
392 cur.pop(cur.currentDepth());
394 cur.bv().cursor() = cur;
397 case LFUN_FINISHED_UP:
398 cur.pop(cur.currentDepth());
399 //idxUpDown(cur, true);
400 cur.bv().cursor() = cur;
403 case LFUN_FINISHED_DOWN:
404 cur.pop(cur.currentDepth());
405 //idxUpDown(cur, false);
406 cur.bv().cursor() = cur;
411 lyxerr << "mathnest RIGHT: from:\n" << cur << endl;
412 cur.selHandle(cmd.action == LFUN_RIGHTSEL);
413 cur.autocorrect() = false;
415 if (cur.inMacroMode())
416 cur.macroModeClose();
417 else if (cur.pos() != cur.lastpos() && cur.openable(cur.nextAtom())) {
418 cur.pushLeft(cur.nextAtom().nucleus());
419 cur.inset()->idxFirst(cur);
420 } else if (cur.posRight() || idxRight(cur)
421 || cur.popRight() || cur.selection())
424 cur.dispatched(FINISHED_RIGHT);
425 lyxerr << "mathnest RIGHT: to:\n" << cur << endl;
430 cur.selHandle(cmd.action == LFUN_LEFTSEL);
431 cur.autocorrect() = false;
433 if (cur.inMacroMode())
434 cur.macroModeClose();
435 else if (cur.pos() != 0 && cur.openable(cur.prevAtom())) {
437 cur.push(cur.nextAtom().nucleus());
438 cur.inset()->idxLast(cur);
439 } else if (cur.posLeft() || idxLeft(cur)
440 || cur.popLeft() || cur.selection())
443 cur.dispatched(FINISHED_LEFT);
448 cur.selHandle(cmd.action == LFUN_UPSEL);
450 cur.dispatched(FINISHED_UP);
455 cur.selHandle(cmd.action == LFUN_DOWNSEL);
457 cur.dispatched(FINISHED_DOWN);
464 cur.selection() = true;
465 cur.pos() = cur.lastpos();
466 cur.idx() = cur.lastidx();
469 case LFUN_UP_PARAGRAPHSEL:
470 case LFUN_UP_PARAGRAPH:
471 case LFUN_DOWN_PARAGRAPHSEL:
472 case LFUN_DOWN_PARAGRAPH:
477 case LFUN_WORDLEFTSEL:
479 cur.selHandle(cmd.action == LFUN_WORDLEFTSEL || cmd.action == LFUN_HOMESEL);
480 cur.macroModeClose();
481 if (cur.pos() != 0) {
483 } else if (cur.col() != 0) {
484 cur.idx() -= cur.col();
486 } else if (cur.idx() != 0) {
490 cur.dispatched(FINISHED_LEFT);
494 case LFUN_WORDRIGHTSEL:
498 cur.selHandle(cmd.action == LFUN_WORDRIGHTSEL || cmd.action == LFUN_ENDSEL);
499 cur.macroModeClose();
501 if (cur.pos() != cur.lastpos()) {
502 cur.pos() = cur.lastpos();
503 } else if (cur.col() != cur.lastcol()) {
504 cur.idx() = cur.idx() - cur.col() + cur.lastcol();
505 cur.pos() = cur.lastpos();
506 } else if (cur.idx() != cur.lastidx()) {
507 cur.idx() = cur.lastidx();
508 cur.pos() = cur.lastpos();
510 cur.dispatched(FINISHED_RIGHT);
516 case LFUN_BEGINNINGBUFSEL:
517 case LFUN_BEGINNINGBUF:
518 cur.dispatched(FINISHED_LEFT);
525 cur.dispatched(FINISHED_RIGHT);
528 case LFUN_CELL_FORWARD:
529 cur.inset()->idxNext(cur);
532 case LFUN_CELL_BACKWARD:
533 cur.inset()->idxPrev(cur);
536 case LFUN_DELETE_WORD_BACKWARD:
538 //recordUndo(cur, Undo::ATOMIC);
542 case LFUN_DELETE_WORD_FORWARD:
544 //recordUndo(cur, Undo::ATOMIC);
546 cur.dispatched(FINISHED_LEFT);
553 cur.dispatched(FINISHED_LEFT);
556 case LFUN_INSET_TOGGLE:
560 case LFUN_SELFINSERT:
561 if (cmd.argument.empty()) {
562 cur.dispatched(FINISHED_RIGHT);
565 //recordUndo(cur, Undo::ATOMIC);
566 if (cmd.argument.size() != 1) {
567 cur.insert(cmd.argument);
570 if (!interpret(cur, cmd.argument[0]))
571 cur.dispatched(FINISHED_RIGHT);
576 // this needs to be incorporated
578 // delete empty mathbox (LFUN_BACKSPACE and LFUN_DELETE)
579 bool remove_inset = false;
581 DispatchResult result(true);
582 bool was_macro = cur.inMacroMode();
589 // sprintf(dispatch_buffer, "%d %d",);
590 // DispatchResult= dispatch_buffer;
593 lyxerr << "LFUN_SETXY broken!" << endl;
596 istringstream is(cmd.argument.c_str());
598 cur.setScreenPos(x, y);
603 //recordUndo(cur, Undo::DELETE);
611 // Special casing for superscript in case of LyX handling
613 case LFUN_CIRCUMFLEX:
614 if (cmd.argument.empty()) {
615 // do superscript if LyX handles
617 //recordUndo(cur, Undo::ATOMIC);
635 case LFUN_HUNG_UMLAUT:
639 case LFUN_FREEFONT_APPLY:
640 case LFUN_FREEFONT_UPDATE:
641 handleFont2(cur, cmd.argument);
645 handleFont(cur, cmd.argument, "mathbf");
648 handleFont(cur, cmd.argument, "mathsf");
651 handleFont(cur, cmd.argument, "mathcal");
654 handleFont(cur, cmd.argument, "mathrm");
657 handleFont(cur, cmd.argument, "texttt");
660 handleFont(cur, cmd.argument, "mathfrak");
663 handleFont(cur, cmd.argument, "mathit");
666 handleFont(cur, cmd.argument, "mathbb");
668 //case LFUN_FREEFONT_APPLY:
669 handleFont(cur, cmd.argument, "textrm");
672 handleFont(cur, cmd.argument, "textnormal");
677 cur.macroModeClose();
679 cur.plainInsert(MathAtom(new MathMBoxInset(cur.bv())));
681 cur.pushLeft(cur.nextInset());
683 if (currentMode() == InsetBase::TEXT_MODE)
684 cur.niceInsert(MathAtom(new MathHullInset("simple")));
686 handleFont(cur, cmd.argument, "textrm");
687 //cur.owner()->message(_("math text mode toggled"));
694 //recordUndo(cur, Undo::ATOMIC);
700 case LFUN_INSERT_MATRIX: {
701 //recordUndo(cur, Undo::ATOMIC);
706 istringstream is(cmd.argument);
707 is >> m >> n >> v_align >> h_align;
714 MathAtom(new MathArrayInset("array", m, n, v_align[0], h_align)));
718 case LFUN_MATH_DELIM: {
719 lyxerr << "MathNestInset::LFUN_MATH_DELIM" << endl;
721 string rs = lyx::support::split(cmd.argument, ls, ' ');
722 // Reasonable default values
727 //recordUndo(cur, Undo::ATOMIC);
728 cur.handleNest(MathAtom(new MathDelimInset(ls, rs)));
732 case LFUN_SPACE_INSERT:
733 case LFUN_MATH_SPACE:
734 //recordUndo(cur, Undo::ATOMIC);
735 cur.insert(MathAtom(new MathSpaceInset(",")));
740 //cur.bv().owner()->message(_("Invalid action in math mode!"));
744 // interpret this as if a backslash was typed
745 //recordUndo(cur, Undo::ATOMIC);
746 interpret(cur, '\\');
749 // FIXME: We probably should swap parts of "math-insert" and "self-insert"
750 // handling such that "self-insert" works on "arbitrary stuff" too, and
751 // math-insert only handles special math things like "matrix".
752 case LFUN_INSERT_MATH:
753 //recordUndo(cur, Undo::ATOMIC);
754 cur.niceInsert(cmd.argument);
757 case LFUN_DIALOG_SHOW_NEW_INSET: {
758 string const & name = cmd.argument;
763 data = tmp.createDialogStr(name);
766 cur.bv().owner()->getDialogs().show(name, data, 0);
770 case LFUN_INSET_APPLY: {
771 string const name = cmd.getArg(0);
772 InsetBase * base = cur.bv().owner()->getDialogs().getOpenInset(name);
775 base->dispatch(cur, FuncRequest(LFUN_INSET_MODIFY, cmd.argument));
779 if (createMathInset_fromDialogStr(cmd.argument, ar)) {
790 case LFUN_WORD_REPLACE:
792 if (!searchForward(&cur.bv(), cmd.getArg(0), false, false))
799 BOOST_ASSERT(cur.inMathed());
801 if (result.dispatched()) {
803 cur.bv().stuffClipboard(cur.grabSelection());
806 cur.bv().owner()->dispatch(FuncRequest(LFUN_DELETE));
812 MathDimInset::priv_dispatch(cur, cmd);
818 void MathNestInset::edit(LCursor & cur, bool left)
821 cur.idx() = left ? 0 : cur.lastidx();
822 cur.pos() = left ? 0 : cur.lastpos();
827 InsetBase * MathNestInset::editXY(LCursor & cur, int x, int y)
830 int dist_min = 1000000;
831 for (idx_type i = 0; i < nargs(); ++i) {
832 int d = cell(i).dist(x, y);
838 MathArray & ar = cell(idx_min);
841 cur.pos() = ar.x2pos(x - ar.xo());
842 lyxerr << "found cell : " << idx_min << " pos: " << cur.pos() << endl;
845 for (pos_type i = 0, n = ar.size(); i < n; ++i)
846 if (ar[i]->covers(x, y))
847 return ar[i].nucleus()->editXY(cur, x, y);
853 void MathNestInset::lfunMouseRelease(LCursor & cur, FuncRequest const & cmd)
855 //lyxerr << "lfunMouseRelease: buttons: " << cmd.button() << endl;
857 if (cmd.button() == mouse_button::button1) {
858 // try to dispatch to enclosed insets first
859 //cur.bv().stuffClipboard(cur.grabSelection());
863 if (cmd.button() == mouse_button::button2) {
865 asArray(cur.bv().getClipboard(), ar);
867 cur.setScreenPos(cmd.x, cmd.y);
873 if (cmd.button() == mouse_button::button3) {
874 // try to dispatch to enclosed insets first
875 cur.bv().owner()->getDialogs().show("mathpanel");
883 void MathNestInset::lfunMousePress(LCursor & cur, FuncRequest const & cmd)
885 lyxerr << "lfunMousePress: buttons: " << cmd.button() << endl;
886 if (cmd.button() == mouse_button::button1) {
890 //cur.setScreenPos(cmd.x + xo_, cmd.y + yo_);
891 lyxerr << "lfunMousePress: setting cursor to: " << cur << endl;
892 cur.bv().cursor() = cur;
895 if (cmd.button() == mouse_button::button2) {
896 priv_dispatch(cur, FuncRequest(LFUN_PASTESELECTION));
901 void MathNestInset::lfunMouseMotion(LCursor & cur, FuncRequest const & cmd)
903 // only select with button 1
904 if (cmd.button() != mouse_button::button1)
907 if (abs(cmd.x - first_x) < 2 && abs(cmd.y - first_y) < 2)
913 if (!cur.selection())
916 //cur.setScreenPos(cmd.x + xo_, cmd.y + yo_);
917 cur.bv().cursor().cursor_ = cur.cursor_;
918 cur.bv().cursor().selection() = true;
923 bool MathNestInset::interpret(LCursor & cur, char c)
925 //lyxerr << "interpret 2: '" << c << "'" << endl;
927 if (cur.inMacroArgMode()) {
933 MathMacroTemplate const * p = formula()->asMacroTemplate();
934 if (p && 1 <= n && n <= p->numargs())
935 cur.insert(MathAtom(new MathMacroArgument(c - '0')));
937 cur.insert(createMathInset("#"));
938 interpret(cur, c); // try again
945 if (cur.inMacroMode()) {
946 string name = cur.macroName();
947 //lyxerr << "interpret name: '" << name << "'" << endl;
950 cur.activeMacro()->setName(cur.activeMacro()->name() + c);
954 // handle 'special char' macros
959 if (currentMode() == MathInset::TEXT_MODE)
960 cur.niceInsert(createMathInset("textbackslash"));
962 cur.niceInsert(createMathInset("backslash"));
963 } else if (c == '{') {
964 cur.niceInsert(MathAtom(new MathBraceInset));
966 cur.niceInsert(createMathInset(string(1, c)));
971 // leave macro mode and try again if necessary
972 cur.macroModeClose();
974 cur.niceInsert(MathAtom(new MathBraceInset));
980 // This is annoying as one has to press <space> far too often.
984 // leave autocorrect mode if necessary
985 if (autocorrect() && c == ' ') {
986 autocorrect() = false;
991 // just clear selection on pressing the space bar
992 if (cur.selection() && c == ' ') {
993 cur.selection() = false;
1000 //lyxerr << "starting with macro" << endl;
1001 cur.insert(MathAtom(new MathUnknownInset("\\", false)));
1006 if (currentMode() == MathInset::TEXT_MODE)
1012 if (currentMode() == MathInset::TEXT_MODE) {
1013 // insert spaces in text mode,
1014 // but suppress direct insertion of two spaces in a row
1015 // the still allows typing '<space>a<space>' and deleting the 'a', but
1016 // it is better than nothing...
1017 if (!cur.pos() != 0 || cur.prevAtom()->getChar() != ' ')
1021 if (cur.pos() != 0 && cur.prevAtom()->asSpaceInset()) {
1022 cur.prevAtom().nucleus()->asSpaceInset()->incSpace();
1027 // if are at the very end, leave the formula
1028 return cur.pos() != cur.lastpos();
1041 if (c == '{' || c == '}' || c == '#' || c == '&' || c == '$') {
1042 cur.niceInsert(createMathInset(string(1, c)));
1047 cur.niceInsert(MathAtom(new MathCommentInset));
1051 // try auto-correction
1052 //if (autocorrect() && hasPrevAtom() && math_autocorrect(prevAtom(), c))
1055 // no special circumstances, so insert the character without any fuss
1057 cur.autocorrect() = true;
1062 bool MathNestInset::script(LCursor & cur, bool up)
1064 // Hack to get \\^ and \\_ working
1065 lyxerr << "handling script: up: " << up << endl;
1066 if (cur.inMacroMode() && cur.macroName() == "\\") {
1068 cur.niceInsert(createMathInset("mathcircumflex"));
1070 interpret(cur, '_');
1074 cur.macroModeClose();
1075 string safe = cur.grabAndEraseSelection();
1076 if (asScriptInset() && cur.idx() == 2) {
1077 // we are in a nucleus of a script inset, move to _our_ script
1078 asScriptInset()->ensure(up);
1081 } else if (cur.pos() != 0 && cur.prevAtom()->asScriptInset()) {
1083 cur.nextAtom().nucleus()->asScriptInset()->ensure(up);
1084 cur.push(cur.nextInset());
1086 cur.pos() = cur.lastpos();
1087 } else if (cur.pos() != 0) {
1089 cur.cell()[cur.pos()] = MathAtom(new MathScriptInset(cur.nextAtom(), up));
1090 cur.push(cur.nextInset());
1094 cur.plainInsert(MathAtom(new MathScriptInset(up)));
1096 cur.nextAtom().nucleus()->asScriptInset()->ensure(up);
1097 cur.push(cur.nextInset());