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"
39 #include "math_cursor.h"
40 #include "math_arrayinset.h"
41 #include "math_spaceinset.h"
42 #include "math_macrotable.h"
43 #include "math_factory.h"
44 #include "math_parser.h"
45 #include "undo_funcs.h"
51 MathCursor * mathcursor = 0;
65 void handleFont(BufferView * bv, MathTextCodes t)
67 if (mathcursor->selection())
68 bv->lockedInsetStoreUndo(Undo::EDIT);
69 mathcursor->handleFont(t);
73 void handleAccent(BufferView * bv, string const & name)
75 bv->lockedInsetStoreUndo(Undo::EDIT);
76 mathcursor->insert(createMathInset(name));
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";
104 // Check if uses AMS macros
105 void InsetFormulaBase::validate(LaTeXFeatures &) const
109 void InsetFormulaBase::metrics(BufferView * bv, LyXFont const & f) const
115 void InsetFormulaBase::metrics(BufferView * bv) const
119 MathMetricsInfo mi(view_, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
124 string const InsetFormulaBase::editMessage() const
126 return _("Math editor mode");
130 void InsetFormulaBase::edit(BufferView * bv, int x, int /*y*/, unsigned int)
132 if (!bv->lockInset(this))
133 lyxerr[Debug::MATHED] << "Cannot lock inset!!!" << endl;
135 //lyxerr << "edit: " << x << " " << y << " button: " << button << "\n";
137 mathcursor = new MathCursor(this, x == 0);
139 // handle ignored click
140 if (hack_x || hack_y) {
141 insetButtonPress(bv, hack_x, hack_y, hack_button);
146 // if that is removed, we won't get the magenta box when entering an
147 // inset for the first time
148 bv->updateInset(this, false);
152 void InsetFormulaBase::edit(BufferView * bv, bool front)
154 // looks hackish but seems to work
155 edit(bv, front ? 0 : 1, 0, 0);
159 void InsetFormulaBase::insetUnlock(BufferView * bv)
162 if (mathcursor->inMacroMode()) {
163 mathcursor->macroModeClose();
164 updateLocal(bv, true);
169 bv->updateInset(this, false);
173 void InsetFormulaBase::getCursorPos(BufferView *, int & x, int & y) const
175 mathcursor->getPos(x, y);
178 //lyxerr << "getCursorPos: " << x << " " << y << "\n";
182 void InsetFormulaBase::toggleInsetCursor(BufferView * bv)
187 if (isCursorVisible())
188 bv->hideLockedInsetCursor();
193 mathcursor->getPos(x, y);
197 MathMetricsInfo mi(bv, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
198 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
199 bv->showLockedInsetCursor(x, y, asc, des);
200 //lyxerr << "toggleInsetCursor: " << x << " " << y << "\n";
203 toggleCursorVisible();
207 void InsetFormulaBase::showInsetCursor(BufferView * bv, bool)
209 if (isCursorVisible())
215 mathcursor->getPos(x, y);
219 MathMetricsInfo mi(bv, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
220 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
221 bv->fitLockedInsetCursor(x, y, asc, des);
222 //lyxerr << "showInsetCursor: x: " << x << " y: " << y << "\n";
224 toggleInsetCursor(bv);
228 void InsetFormulaBase::hideInsetCursor(BufferView * bv)
230 if (isCursorVisible())
231 toggleInsetCursor(bv);
235 void InsetFormulaBase::toggleInsetSelection(BufferView * bv)
238 bv->updateInset(this, false);
242 vector<string> const InsetFormulaBase::getLabelList() const
244 return std::vector<string>();
248 void InsetFormulaBase::updateLocal(BufferView * bv, bool dirty)
251 bv->updateInset(this, dirty);
255 bool InsetFormulaBase::insetButtonRelease(BufferView * bv,
256 int /*x*/, int /*y*/, int /*button*/)
260 //lyxerr << "insetButtonRelease: " << x << " " << y << "\n";
263 bv->updateInset(this, false);
268 void InsetFormulaBase::insetButtonPress(BufferView * bv,
269 int x, int y, int button)
271 // hack to cope with mouseclick that comes before the call to edit()
275 hack_button = button;
279 //lyxerr << "insetButtonPress: " << x + xo_ << " " << y + yo_
280 // << " but: " << button << "\n";
288 mathcursor->selClear();
289 mathcursor->setPos(x + xo_, y + yo_);
294 lyxerr << "insetButtonPress: 2\n";
297 bv->lockedInsetStoreUndo(Undo::EDIT);
299 mathcursor->selGet(ar);
300 mathcursor->setPos(x + xo_, y + yo_);
302 bv->getLyXText()->selectionAsString(bv->buffer(), false);
303 mathed_parse_cell(ar, sel);
304 mathcursor->insert(ar);
309 bv->updateInset(this, false);
313 void InsetFormulaBase::insetMotionNotify(BufferView * bv,
314 int x, int y, int /*button*/)
319 if (abs(x - first_x) < 2 && abs(y - first_y) < 2) {
320 //lyxerr << "insetMotionNotify: ignored\n";
326 if (!mathcursor->selection())
327 mathcursor->selStart();
329 //lyxerr << "insetMotionNotify: " << x + xo_ << ' ' << y + yo_
330 // << ' ' << button << "\n";
332 mathcursor->setPos(x + xo_, y + yo_);
334 bv->updateInset(this, false);
338 void InsetFormulaBase::insetKeyPress(XKeyEvent *)
340 lyxerr[Debug::MATHED] << "Used InsetFormulaBase::InsetKeyPress." << endl;
344 UpdatableInset::RESULT
345 InsetFormulaBase::localDispatch(BufferView * bv, kb_action action,
348 //lyxerr << "InsetFormulaBase::localDispatch: act: " << action
349 // << " arg: '" << arg << "' cursor: " << mathcursor << "\n";
354 if (mathcursor->asHyperActiveInset()) {
355 lyxerr << " uurr.... getting dificult now\n";
356 return mathcursor->asHyperActiveInset()->localDispatch(bv, action, arg);
359 RESULT result = DISPATCHED;
361 bool was_macro = mathcursor->inMacroMode();
362 bool was_selection = mathcursor->selection();
366 mathcursor->normalize();
370 // --- Cursor Movements ---------------------------------------------
373 sel = true; // fall through...
376 result = mathcursor->right(sel) ? DISPATCHED : FINISHED_RIGHT;
377 updateLocal(bv, false);
382 sel = true; // fall through
385 result = mathcursor->left(sel) ? DISPATCHED : FINISHED;
386 updateLocal(bv, false);
394 result = mathcursor->up(sel) ? DISPATCHED : FINISHED_UP;
395 updateLocal(bv, false);
403 result = mathcursor->down(sel) ? DISPATCHED : FINISHED_DOWN;
404 updateLocal(bv, false);
411 mathcursor->home(sel);
412 updateLocal(bv, false);
419 mathcursor->end(sel);
420 updateLocal(bv, false);
423 case LFUN_DELETE_LINE_FORWARD:
424 bv->lockedInsetStoreUndo(Undo::DELETE);
425 mathcursor->delLine();
426 updateLocal(bv, true);
430 mathcursor->idxNext();
431 updateLocal(bv, false);
435 mathcursor->idxPrev();
436 updateLocal(bv, false);
440 bv->lockedInsetStoreUndo(Undo::EDIT);
441 mathcursor->splitCell();
442 updateLocal(bv, true);
445 case LFUN_DELETE_WORD_BACKWARD:
447 bv->lockedInsetStoreUndo(Undo::DELETE);
448 mathcursor->backspace();
449 bv->updateInset(this, true);
452 case LFUN_DELETE_WORD_FORWARD:
454 bv->lockedInsetStoreUndo(Undo::DELETE);
456 bv->updateInset(this, true);
460 // sprintf(dispatch_buffer, "%d %d",);
461 // dispatch_result = dispatch_buffer;
464 lyxerr << "LFUN_SETXY broken!\n";
467 istringstream is(arg.c_str());
469 mathcursor->setPos(x, y);
470 updateLocal(bv, false);
476 mathcursor->macroModeClose();
477 bv->lockedInsetStoreUndo(Undo::EDIT);
478 mathcursor->selPaste();
479 updateLocal(bv, true);
483 bv->lockedInsetStoreUndo(Undo::DELETE);
484 mathcursor->selCut();
485 updateLocal(bv, true);
489 mathcursor->selCopy();
492 case LFUN_WORDRIGHTSEL:
493 case LFUN_WORDLEFTSEL:
496 // --- accented characters ------------------------------
498 case LFUN_UMLAUT: handleAccent(bv, "ddot"); break;
499 case LFUN_CIRCUMFLEX: handleAccent(bv, "hat"); break;
500 case LFUN_GRAVE: handleAccent(bv, "grave"); break;
501 case LFUN_ACUTE: handleAccent(bv, "acute"); break;
502 case LFUN_TILDE: handleAccent(bv, "tilde"); break;
503 case LFUN_MACRON: handleAccent(bv, "bar"); break;
504 case LFUN_DOT: handleAccent(bv, "dot"); break;
505 case LFUN_CARON: handleAccent(bv, "check"); break;
506 case LFUN_BREVE: handleAccent(bv, "breve"); break;
507 case LFUN_VECTOR: handleAccent(bv, "vec"); break;
510 case LFUN_GREEK_TOGGLE: handleFont(bv, LM_TC_GREEK); break;
511 case LFUN_BOLD: handleFont(bv, LM_TC_BF); break;
512 case LFUN_SANS: handleFont(bv, LM_TC_SF); break;
513 case LFUN_EMPH: handleFont(bv, LM_TC_CAL); break;
514 case LFUN_ROMAN: handleFont(bv, LM_TC_RM); break;
515 case LFUN_CODE: handleFont(bv, LM_TC_TT); break;
516 case LFUN_NOUN: handleFont(bv, LM_TC_BB); break;
517 case LFUN_DEFAULT: handleFont(bv, LM_TC_VAR); break;
520 handleFont(bv, LM_TC_GREEK1);
522 mathcursor->interpret(arg);
526 handleFont(bv, LM_TC_TEXTRM);
527 //bv->owner()->message(_("math text mode toggled"));
530 case LFUN_MATH_LIMITS:
531 bv->lockedInsetStoreUndo(Undo::EDIT);
532 if (mathcursor->toggleLimits())
533 updateLocal(bv, true);
539 bv->lockedInsetStoreUndo(Undo::EDIT);
540 mathcursor->setSize(arg);
541 updateLocal(bv, true);
546 case LFUN_INSERT_MATRIX:
548 bv->lockedInsetStoreUndo(Undo::EDIT);
549 mathcursor->interpret("matrix " + arg);
550 updateLocal(bv, true);
554 case LFUN_MATH_SPACE:
556 bv->lockedInsetStoreUndo(Undo::EDIT);
557 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
558 updateLocal(bv, true);
562 case LFUN_SUPERSCRIPT:
565 bv->lockedInsetStoreUndo(Undo::EDIT);
566 mathcursor->script((action == LFUN_SUPERSCRIPT));
567 updateLocal(bv, true);
571 case LFUN_MATH_DELIM:
573 lyxerr << "formulabase::LFUN_MATH_DELIM, arg: '" << arg << "'\n";
576 istringstream is(arg.c_str());
579 lyxerr << "can't parse delimeters from '" << arg << "'\n";
582 bv->lockedInsetStoreUndo(Undo::EDIT);
583 mathcursor->handleDelim(ls, rs);
584 updateLocal(bv, true);
588 case LFUN_PROTECTEDSPACE:
589 //lyxerr << " called LFUN_PROTECTEDSPACE\n";
590 bv->lockedInsetStoreUndo(Undo::EDIT);
591 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
592 updateLocal(bv, true);
596 bv->owner()->message(_("Invalid action in math mode!"));
600 case LFUN_MATH_HALIGN:
601 case LFUN_MATH_VALIGN:
602 case LFUN_MATH_ROW_INSERT:
603 case LFUN_MATH_ROW_DELETE:
604 case LFUN_MATH_COLUMN_INSERT:
605 case LFUN_MATH_COLUMN_DELETE:
607 MathInset::idx_type idx = 0;
608 MathGridInset * p = mathcursor ? mathcursor->enclosingGrid(idx) : 0;
610 bv->lockedInsetStoreUndo(Undo::EDIT);
611 char al = arg.size() ? arg[0] : 'c';
613 case LFUN_MATH_HALIGN: p->halign(al, p->col(idx)); break;
614 case LFUN_MATH_VALIGN: p->valign(al); break;
615 case LFUN_MATH_ROW_INSERT: p->addRow(p->row(idx)); break;
616 case LFUN_MATH_ROW_DELETE: p->delRow(p->row(idx)); break;
617 case LFUN_MATH_COLUMN_INSERT: p->addCol(p->col(idx)); break;
618 case LFUN_MATH_COLUMN_DELETE: p->delCol(p->col(idx)); break;
621 updateLocal(bv, true);
626 case LFUN_EXEC_COMMAND:
627 result = UNDISPATCHED;
630 case LFUN_BREAKPARAGRAPH:
631 case LFUN_BREAKPARAGRAPHKEEPLAYOUT:
632 //lyxerr << "LFUN ignored\n";
636 // interpret this as if a backslash was typed
637 bv->lockedInsetStoreUndo(Undo::EDIT);
638 mathcursor->interpret("\\");
639 updateLocal(bv, true);
643 case LFUN_INSERT_MATH:
644 case LFUN_SELFINSERT:
646 bv->lockedInsetStoreUndo(Undo::EDIT);
647 result = mathcursor->interpret(arg) ? DISPATCHED : FINISHED_RIGHT;
648 updateLocal(bv, true);
652 case LFUN_MATH_PANEL:
653 result = UNDISPATCHED;
657 if (mathcursor->selection())
658 mathcursor->selClear();
660 result = UNDISPATCHED;
664 result = UNDISPATCHED;
667 mathcursor->normalize();
669 lyx::Assert(mathcursor);
671 if (mathcursor->selection() || was_selection)
672 toggleInsetSelection(bv);
674 if (result == DISPATCHED || result == DISPATCHED_NOUPDATE ||
675 result == UNDISPATCHED)
678 bv->unlockInset(this);
680 return result; // original version
684 Inset::Code InsetFormulaBase::lyxCode() const
686 return Inset::MATH_CODE;
690 int InsetFormulaBase::ylow() const
692 return yo_ - ascent(view_, font_);
696 int InsetFormulaBase::yhigh() const
698 return yo_ + descent(view_, font_);
702 int InsetFormulaBase::xlow() const
708 int InsetFormulaBase::xhigh() const
710 return xo_ + width(view_, font_);
714 /////////////////////////////////////////////////////////////////////
717 void mathDispatchCreation(BufferView * bv, string const & arg, bool display)
719 if (bv->available()) {
720 // use selection if available..
722 //if (action == LFUN_MATH_IMPORT_SELECTION)
726 string sel = bv->getLyXText()->selectionAsString(bv->buffer(), false);
728 InsetFormulaBase * f;
730 f = new InsetFormula;
731 if (openNewInset(bv, f)) {
732 // don't do that also for LFUN_MATH_MODE unless you want end up with
733 // always changing to mathrm when opening an inlined inset
734 // -- I really hate "LyXfunc overloading"...
736 f->localDispatch(bv, LFUN_MATH_DISPLAY, string());
737 f->localDispatch(bv, LFUN_INSERT_MATH, arg);
740 // create a macro if we see "\\newcommand" somewhere, and an ordinary
742 if (sel.find("\\newcommand") == string::npos)
743 f = new InsetFormula(sel);
745 f = new InsetFormulaMacro(sel);
746 bv->getLyXText()->cutSelection(bv);
750 bv->owner()->getLyXFunc()->setMessage(N_("Math editor mode"));
754 void mathDispatchMathDisplay(BufferView * bv, string const & arg)
756 mathDispatchCreation(bv, arg, true);
760 void mathDispatchMathMode(BufferView * bv, string const & arg)
762 mathDispatchCreation(bv, arg, false);
766 void mathDispatchMathImportSelection(BufferView * bv, string const & arg)
768 mathDispatchCreation(bv, arg, true);
772 void mathDispatchMathMacro(BufferView * bv, string const & arg)
774 if (bv->available()) {
776 bv->owner()->getLyXFunc()->setErrorMessage(N_("Missing argument"));
779 string const s1 = token(s, ' ', 1);
780 int const na = s1.empty() ? 0 : lyx::atoi(s1);
781 openNewInset(bv, new InsetFormulaMacro(token(s, ' ', 0), na));
787 void mathDispatchMathDelim(BufferView * bv, string const & arg)
789 if (bv->available()) {
790 if (openNewInset(bv, new InsetFormula))
791 bv->theLockingInset()->localDispatch(bv, LFUN_MATH_DELIM, arg);
796 void mathDispatchInsertMatrix(BufferView * bv, string const & arg)
798 if (bv->available()) {
799 if (openNewInset(bv, new InsetFormula))
800 bv->theLockingInset()->localDispatch(bv, LFUN_INSERT_MATRIX, arg);
805 void mathDispatchInsertMath(BufferView * bv, string const & arg)
807 if (bv->available()) {
808 if (arg.size() && arg[0] == '\\') {
809 InsetFormula * f = new InsetFormula(arg);
810 if (!bv->insertInset(f))
813 mathDispatchMathMode(bv, arg);
818 void mathDispatchGreek(BufferView * bv, string const & arg)
820 if (bv->available()) {
821 InsetFormula * f = new InsetFormula;
822 if (openNewInset(bv, f)) {
823 bv->theLockingInset()->localDispatch(bv, LFUN_GREEK, arg);
830 void mathDispatch(BufferView *, kb_action, string const &)