3 * Purpose: Implementation of common parts of the LyX math insets
4 * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
5 * Created: January 1996
7 * Copyright: 1996-1998 Alejandro Aguilar Sierra
9 * Version: 0.4, Lyx project.
11 * You are free to use and modify this code under the terms of
12 * the GNU General Public Licence version 2 or later.
19 #include "support/LAssert.h"
22 #pragma implementation
26 #include "formulamacro.h"
27 #include "commandtags.h"
28 #include "BufferView.h"
32 #include "LaTeXFeatures.h"
34 #include "math_support.h"
35 #include "support/lstrings.h"
40 #include "math_arrayinset.h"
41 #include "math_charinset.h"
42 #include "math_cursor.h"
43 #include "math_factory.h"
44 #include "math_hullinset.h"
45 #include "math_iterator.h"
46 #include "math_macrotable.h"
47 #include "math_parser.h"
49 #include "math_spaceinset.h"
50 #include "undo_funcs.h"
51 #include "textpainter.h"
52 #include "frontends/Dialogs.h"
59 MathCursor * mathcursor = 0;
70 void handleFont(BufferView * bv, string const & arg, MathTextCodes t)
72 if (mathcursor->selection())
73 bv->lockedInsetStoreUndo(Undo::EDIT);
74 mathcursor->handleFont(t);
75 for (string::const_iterator it = arg.begin(); it != arg.end(); ++it)
76 mathcursor->insert(*it);
80 bool openNewInset(BufferView * bv, UpdatableInset * new_inset)
82 if (!bv->insertInset(new_inset)) {
86 new_inset->edit(bv, 0, 0, 0);
95 InsetFormulaBase::InsetFormulaBase()
96 : view_(0), font_(), xo_(0), yo_(0)
98 // This is needed as long the math parser is not re-entrant
99 MathMacroTable::builtinMacros();
100 //lyxerr << "sizeof MathInset: " << sizeof(MathInset) << "\n";
101 //lyxerr << "sizeof(MathMetricsInfo): " << sizeof(MathMetricsInfo) << "\n";
102 //lyxerr << "sizeof(MathCharInset): " << sizeof(MathCharInset) << "\n";
106 // simply scrap this function if you want
107 void InsetFormulaBase::mutateToText()
110 // translate to latex
112 latex(NULL, os, false, false);
113 string str = os.str();
116 LyXText * lt = view_->getLyXText();
117 string::const_iterator cit = str.begin();
118 string::const_iterator end = str.end();
119 for (; cit != end; ++cit)
120 view_->owner()->getIntl()->getTrans().TranslateAndInsert(*cit, lt);
123 //view_->owner()->getLyXFunc()->dispatch(LFUN_ESCAPE);
128 // Check if uses AMS macros
129 void InsetFormulaBase::validate(LaTeXFeatures &) const
133 void InsetFormulaBase::metrics(BufferView * bv, LyXFont const & f) const
140 void InsetFormulaBase::metrics(BufferView * bv) const
144 MathMetricsInfo mi(view_, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
149 string const InsetFormulaBase::editMessage() const
151 return _("Math editor mode");
155 void InsetFormulaBase::edit(BufferView * bv, int x, int y, unsigned int)
157 if (!bv->lockInset(this))
158 lyxerr[Debug::MATHED] << "Cannot lock inset!!!" << endl;
160 mathcursor = new MathCursor(this, true);
162 mathcursor->setPos(x, y);
163 //lyxerr << "setting pos to " << x << "," << y << "\n";
165 // if that is removed, we won't get the magenta box when entering an
166 // inset for the first time
167 bv->updateInset(this, false);
171 void InsetFormulaBase::edit(BufferView * bv, bool front)
173 if (!bv->lockInset(this))
174 lyxerr[Debug::MATHED] << "Cannot lock inset!!!" << endl;
176 mathcursor = new MathCursor(this, front);
178 bv->updateInset(this, false);
182 void InsetFormulaBase::insetUnlock(BufferView * bv)
185 if (mathcursor->inMacroMode()) {
186 mathcursor->macroModeClose();
187 updateLocal(bv, true);
192 bv->updateInset(this, false);
196 void InsetFormulaBase::getCursorPos(BufferView *, int & x, int & y) const
198 mathcursor->getPos(x, y);
201 //lyxerr << "getCursorPos: " << x << " " << y << "\n";
205 void InsetFormulaBase::toggleInsetCursor(BufferView * bv)
210 if (isCursorVisible())
211 bv->hideLockedInsetCursor();
216 mathcursor->getPos(x, y);
220 math_font_max_dim(font_, asc, des);
221 bv->showLockedInsetCursor(x, y, asc, des);
222 //lyxerr << "toggleInsetCursor: " << x << " " << y << "\n";
225 toggleCursorVisible();
229 void InsetFormulaBase::showInsetCursor(BufferView * bv, bool)
231 if (isCursorVisible())
237 mathcursor->getPos(x, y);
241 math_font_max_dim(font_, asc, des);
242 bv->fitLockedInsetCursor(x, y, asc, des);
243 //lyxerr << "showInsetCursor: x: " << x << " y: " << y << " yo: " << yo_ << "\n";
245 toggleInsetCursor(bv);
249 void InsetFormulaBase::hideInsetCursor(BufferView * bv)
251 if (isCursorVisible())
252 toggleInsetCursor(bv);
256 void InsetFormulaBase::toggleInsetSelection(BufferView * bv)
259 bv->updateInset(this, false);
263 vector<string> const InsetFormulaBase::getLabelList() const
265 return vector<string>();
269 void InsetFormulaBase::updateLocal(BufferView * bv, bool dirty)
272 bv->updateInset(this, dirty);
276 bool InsetFormulaBase::insetButtonRelease(BufferView * bv,
277 int /*x*/, int /*y*/, int button)
279 //lyxerr << "insetButtonRelease: " << x << " " << y << "\n";
285 bv->updateInset(this, false);
288 // launch math panel for right mouse button
289 bv->owner()->getDialogs()->showMathPanel();
296 void InsetFormulaBase::insetButtonPress(BufferView * bv,
297 int x, int y, int button)
299 //lyxerr << "insetButtonPress: "
300 // << x << " " << y << " but: " << button << "\n";
307 mathcursor = new MathCursor(this, x == 0);
311 mathcursor->selClear();
312 mathcursor->setPos(x + xo_, y + yo_);
316 lyxerr << "insetButtonPress: 2\n";
319 bv->lockedInsetStoreUndo(Undo::EDIT);
321 mathcursor->selGet(ar);
322 mathcursor->setPos(x + xo_, y + yo_);
324 bv->getLyXText()->selectionAsString(bv->buffer(), false);
325 mathed_parse_cell(ar, sel);
326 mathcursor->insert(ar);
331 // launch math panel for right mouse button
332 bv->owner()->getDialogs()->showMathPanel();
335 bv->updateInset(this, false);
339 void InsetFormulaBase::insetMotionNotify(BufferView * bv,
340 int x, int y, int /*button*/)
345 if (abs(x - first_x) < 2 && abs(y - first_y) < 2) {
346 //lyxerr << "insetMotionNotify: ignored\n";
352 if (!mathcursor->selection())
353 mathcursor->selStart();
355 //lyxerr << "insetMotionNotify: " << x + xo_ << ' ' << y + yo_
356 // << ' ' << button << "\n";
358 mathcursor->setPos(x + xo_, y + yo_);
360 bv->updateInset(this, false);
364 void InsetFormulaBase::insetKeyPress(XKeyEvent *)
366 lyxerr[Debug::MATHED] << "Used InsetFormulaBase::InsetKeyPress." << endl;
370 UpdatableInset::RESULT
371 InsetFormulaBase::localDispatch(BufferView * bv, kb_action action,
374 //lyxerr << "InsetFormulaBase::localDispatch: act: " << action
375 // << " arg: '" << arg << "' cursor: " << mathcursor << "\n";
380 RESULT result = DISPATCHED;
382 bool was_macro = mathcursor->inMacroMode();
383 bool was_selection = mathcursor->selection();
387 mathcursor->normalize();
392 // --- Cursor Movements ---------------------------------------------
395 sel = true; // fall through...
398 result = mathcursor->right(sel) ? DISPATCHED : FINISHED_RIGHT;
399 //lyxerr << "calling scroll 20\n";
401 updateLocal(bv, false);
402 // write something to the minibuffer
403 //bv->owner()->message(mathcursor->info());
408 sel = true; // fall through
411 result = mathcursor->left(sel) ? DISPATCHED : FINISHED;
412 updateLocal(bv, false);
420 result = mathcursor->up(sel) ? DISPATCHED : FINISHED_UP;
421 updateLocal(bv, false);
429 result = mathcursor->down(sel) ? DISPATCHED : FINISHED_DOWN;
430 updateLocal(bv, false);
437 mathcursor->home(sel);
438 updateLocal(bv, false);
445 mathcursor->end(sel);
446 updateLocal(bv, false);
449 case LFUN_DELETE_LINE_FORWARD:
450 bv->lockedInsetStoreUndo(Undo::DELETE);
451 mathcursor->delLine();
452 updateLocal(bv, true);
456 mathcursor->idxNext();
457 updateLocal(bv, false);
461 mathcursor->idxPrev();
462 updateLocal(bv, false);
466 bv->lockedInsetStoreUndo(Undo::EDIT);
467 mathcursor->splitCell();
468 updateLocal(bv, true);
471 case LFUN_DELETE_WORD_BACKWARD:
473 bv->lockedInsetStoreUndo(Undo::DELETE);
474 mathcursor->backspace();
475 bv->updateInset(this, true);
478 case LFUN_DELETE_WORD_FORWARD:
480 bv->lockedInsetStoreUndo(Undo::DELETE);
482 bv->updateInset(this, true);
486 // sprintf(dispatch_buffer, "%d %d",);
487 // dispatch_result = dispatch_buffer;
490 lyxerr << "LFUN_SETXY broken!\n";
493 istringstream is(arg.c_str());
495 mathcursor->setPos(x, y);
496 updateLocal(bv, false);
502 mathcursor->macroModeClose();
503 bv->lockedInsetStoreUndo(Undo::EDIT);
504 mathcursor->selPaste();
505 updateLocal(bv, true);
509 bv->lockedInsetStoreUndo(Undo::DELETE);
510 mathcursor->selCut();
511 updateLocal(bv, true);
515 mathcursor->selCopy();
518 case LFUN_WORDRIGHTSEL:
519 case LFUN_WORDLEFTSEL:
522 // Special casing for superscript in case of LyX handling
524 case LFUN_CIRCUMFLEX:
526 // do superscript if LyX handles
528 bv->lockedInsetStoreUndo(Undo::EDIT);
529 mathcursor->script(true);
530 updateLocal(bv, true);
546 case LFUN_HUNG_UMLAUT:
550 case LFUN_GREEK_TOGGLE: handleFont(bv, arg, LM_TC_GREEK); break;
551 case LFUN_BOLD: handleFont(bv, arg, LM_TC_BF); break;
552 case LFUN_SANS: handleFont(bv, arg, LM_TC_SF); break;
553 case LFUN_EMPH: handleFont(bv, arg, LM_TC_CAL); break;
554 case LFUN_ROMAN: handleFont(bv, arg, LM_TC_RM); break;
555 case LFUN_CODE: handleFont(bv, arg, LM_TC_TT); break;
556 case LFUN_FRAK: handleFont(bv, arg, LM_TC_EUFRAK); break;
557 case LFUN_ITAL: handleFont(bv, arg, LM_TC_IT); break;
558 case LFUN_NOUN: handleFont(bv, arg, LM_TC_BB); break;
559 case LFUN_DEFAULT: handleFont(bv, arg, LM_TC_VAR); break;
560 case LFUN_FREE: handleFont(bv, arg, LM_TC_TEXTRM); break;
563 handleFont(bv, arg, LM_TC_GREEK1);
565 mathcursor->interpret(arg);
570 handleFont(bv, arg, LM_TC_TEXTRM);
574 mathcursor->niceInsert(MathAtom(new MathHullInset(LM_OT_SIMPLE)));
575 updateLocal(bv, true);
578 //bv->owner()->message(_("math text mode toggled"));
581 case LFUN_MATH_LIMITS:
582 bv->lockedInsetStoreUndo(Undo::EDIT);
583 if (mathcursor->toggleLimits())
584 updateLocal(bv, true);
590 bv->lockedInsetStoreUndo(Undo::EDIT);
591 mathcursor->setSize(arg);
592 updateLocal(bv, true);
597 case LFUN_INSERT_MATRIX:
599 bv->lockedInsetStoreUndo(Undo::EDIT);
600 mathcursor->interpret("matrix " + arg);
601 updateLocal(bv, true);
605 case LFUN_SUPERSCRIPT:
608 bv->lockedInsetStoreUndo(Undo::EDIT);
609 mathcursor->script(action == LFUN_SUPERSCRIPT);
610 updateLocal(bv, true);
614 case LFUN_MATH_DELIM:
616 //lyxerr << "formulabase::LFUN_MATH_DELIM, arg: '" << arg << "'\n";
618 string rs = split(arg, ls, ' ');
619 // Reasonable default values
625 bv->lockedInsetStoreUndo(Undo::EDIT);
626 mathcursor->handleDelim(ls, rs);
627 updateLocal(bv, true);
631 case LFUN_PROTECTEDSPACE:
632 case LFUN_MATH_SPACE:
633 bv->lockedInsetStoreUndo(Undo::EDIT);
634 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
635 updateLocal(bv, true);
639 bv->owner()->message(_("Invalid action in math mode!"));
643 case LFUN_MATH_HALIGN:
644 case LFUN_MATH_VALIGN:
645 case LFUN_MATH_ROW_INSERT:
646 case LFUN_MATH_ROW_DELETE:
647 case LFUN_MATH_COLUMN_INSERT:
648 case LFUN_MATH_COLUMN_DELETE:
650 MathInset::idx_type idx = 0;
651 MathGridInset * p = mathcursor ? mathcursor->enclosingGrid(idx) : 0;
653 mathcursor->popToEnclosingGrid();
654 bv->lockedInsetStoreUndo(Undo::EDIT);
655 char align = arg.size() ? arg[0] : 'c';
657 case LFUN_MATH_HALIGN: p->halign(align, p->col(idx)); break;
658 case LFUN_MATH_VALIGN: p->valign(align); break;
659 case LFUN_MATH_ROW_INSERT: p->addRow(p->row(idx)); break;
660 case LFUN_MATH_ROW_DELETE: p->delRow(p->row(idx)); break;
661 case LFUN_MATH_COLUMN_INSERT: p->addCol(p->col(idx)); break;
662 case LFUN_MATH_COLUMN_DELETE: p->delCol(p->col(idx)); break;
665 updateLocal(bv, true);
670 case LFUN_EXEC_COMMAND:
671 result = UNDISPATCHED;
674 case LFUN_BREAKPARAGRAPH:
675 case LFUN_BREAKPARAGRAPHKEEPLAYOUT:
676 //lyxerr << "LFUN ignored\n";
680 // interpret this as if a backslash was typed
681 bv->lockedInsetStoreUndo(Undo::EDIT);
682 mathcursor->interpret('\\');
683 updateLocal(bv, true);
687 case LFUN_INSERT_MATH:
688 case LFUN_SELFINSERT:
690 bv->lockedInsetStoreUndo(Undo::EDIT);
692 result = mathcursor->interpret(arg[0]) ? DISPATCHED : FINISHED_RIGHT;
694 result = mathcursor->interpret(arg) ? DISPATCHED : FINISHED_RIGHT;
695 updateLocal(bv, true);
699 case LFUN_MATH_PANEL:
700 result = UNDISPATCHED;
704 if (mathcursor->selection())
705 mathcursor->selClear();
707 result = UNDISPATCHED;
711 result = UNDISPATCHED;
714 mathcursor->normalize();
717 lyx::Assert(mathcursor);
719 if (mathcursor->selection() || was_selection)
720 toggleInsetSelection(bv);
722 if (result == DISPATCHED || result == DISPATCHED_NOUPDATE ||
723 result == UNDISPATCHED)
726 bv->unlockInset(this);
730 return result; // original version
734 void InsetFormulaBase::revealCodes(BufferView * /*bv*/) const
739 // write something to the minibuffer
740 // translate to latex
741 mathcursor->markInsert();
744 string str = os.str();
745 mathcursor->markErase();
746 string::size_type pos = 0;
748 for (string::iterator it = str.begin(); it != str.end(); ++it) {
751 else if (*it == '\0') {
753 pos = it - str.begin();
759 res = res.substr(pos - 30);
761 res = res.substr(0, 60);
762 bv->owner()->message(res);
767 Inset::Code InsetFormulaBase::lyxCode() const
769 return Inset::MATH_CODE;
773 int InsetFormulaBase::ylow() const
775 return yo_ - ascent(view_, font_);
779 int InsetFormulaBase::yhigh() const
781 return yo_ + descent(view_, font_);
785 int InsetFormulaBase::xlow() const
791 int InsetFormulaBase::xhigh() const
793 return xo_ + width(view_, font_);
797 /////////////////////////////////////////////////////////////////////
800 bool InsetFormulaBase::searchForward(BufferView * bv, string const & str,
806 static InsetFormulaBase * lastformula = 0;
807 static MathIterator current = MathIterator(ibegin(par().nucleus()));
809 static string laststr;
811 if (lastformula != this || laststr != str) {
812 //lyxerr << "reset lastformula to " << this << "\n";
815 current = ibegin(par().nucleus());
817 mathed_parse_cell(ar, str);
821 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
823 for (MathIterator it = current; it != iend(par().nucleus()); ++it) {
824 if (it.cell().matchpart(ar, it.position().pos_)) {
825 mathcursor->setSelection(it.cursor(), ar.size());
828 // I guess some of the following can go
829 bv->toggleSelection(true);
831 updateLocal(bv, true);
838 //lyxerr << "not found!\n";
840 // we have to unlock ourself in this function by default!
841 // don't ask me why...
842 bv->unlockInset(this);
847 bool InsetFormulaBase::searchBackward(BufferView * bv, string const & what,
850 lyxerr << "searching backward not implemented in mathed" << endl;
851 return searchForward(bv, what, a, b);
855 /////////////////////////////////////////////////////////////////////
858 void mathDispatchCreation(BufferView * bv, string const & arg, bool display)
860 if (bv->available()) {
861 // use selection if available..
863 //if (action == LFUN_MATH_IMPORT_SELECTION)
867 string sel = bv->getLyXText()->selectionAsString(bv->buffer(), false);
869 InsetFormulaBase * f;
871 f = new InsetFormula;
872 if (openNewInset(bv, f)) {
873 // don't do that also for LFUN_MATH_MODE unless you want end up with
874 // always changing to mathrm when opening an inlined inset
875 // -- I really hate "LyXfunc overloading"...
877 f->localDispatch(bv, LFUN_MATH_DISPLAY, string());
878 f->localDispatch(bv, LFUN_INSERT_MATH, arg);
881 // create a macro if we see "\\newcommand" somewhere, and an ordinary
883 if (sel.find("\\newcommand") == string::npos &&
884 sel.find("\\def") == string::npos)
885 f = new InsetFormula(sel);
888 if (!mathed_parse_macro(name, sel))
890 f = new InsetFormulaMacro(sel);
892 bv->getLyXText()->cutSelection(bv);
896 bv->owner()->getLyXFunc()->setMessage(N_("Math editor mode"));
900 void mathDispatchMathDisplay(BufferView * bv, string const & arg)
902 mathDispatchCreation(bv, arg, true);
906 void mathDispatchMathMode(BufferView * bv, string const & arg)
908 mathDispatchCreation(bv, arg, false);
912 void mathDispatchMathImportSelection(BufferView * bv, string const & arg)
914 mathDispatchCreation(bv, arg, true);
918 void mathDispatchMathMacro(BufferView * bv, string const & arg)
920 if (bv->available()) {
922 bv->owner()->getLyXFunc()->setErrorMessage(N_("Missing argument"));
925 string const s1 = token(s, ' ', 1);
926 int const na = s1.empty() ? 0 : lyx::atoi(s1);
927 openNewInset(bv, new InsetFormulaMacro(token(s, ' ', 0), na));
933 void mathDispatchMathDelim(BufferView * bv, string const & arg)
935 if (bv->available()) {
936 if (openNewInset(bv, new InsetFormula))
937 bv->theLockingInset()->localDispatch(bv, LFUN_MATH_DELIM, arg);
942 void mathDispatchInsertMatrix(BufferView * bv, string const & arg)
944 if (bv->available()) {
945 if (openNewInset(bv, new InsetFormula))
946 bv->theLockingInset()->localDispatch(bv, LFUN_INSERT_MATRIX, arg);
951 void mathDispatchInsertMath(BufferView * bv, string const & arg)
953 if (bv->available()) {
954 if (arg.size() && arg[0] == '\\') {
955 InsetFormula * f = new InsetFormula(arg);
956 if (!bv->insertInset(f))
958 else if (!mathcursor) // hotfix
959 bv->getLyXText()->cursorRight(bv);
961 mathDispatchMathMode(bv, arg);
967 void mathDispatchGreek(BufferView * bv, string const & arg)
969 if (bv->available()) {
970 InsetFormula * f = new InsetFormula;
971 if (openNewInset(bv, f)) {
972 bv->theLockingInset()->localDispatch(bv, LFUN_GREEK, arg);
979 void mathDispatch(BufferView *, kb_action, string const &)