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 "math_cursor.h"
29 #include "BufferView.h"
33 #include "LaTeXFeatures.h"
36 #include "support/lstrings.h"
40 #include "math_arrayinset.h"
41 #include "math_spaceinset.h"
42 #include "math_macrotable.h"
43 #include "math_factory.h"
44 #include "support/lyxlib.h"
45 #include "undo_funcs.h"
51 extern char const * latex_mathenv[];
52 MathCursor * mathcursor = 0;
63 void handleFont(BufferView * bv, MathTextCodes t)
65 if (mathcursor->selection())
66 bv->lockedInsetStoreUndo(Undo::EDIT);
67 mathcursor->handleFont(t);
71 void handleAccent(BufferView * bv, string const & name)
73 bv->lockedInsetStoreUndo(Undo::EDIT);
74 mathcursor->insert(createMathInset(name));
78 bool openNewInset(BufferView * bv, UpdatableInset * new_inset)
80 LyXText * lt = bv->getLyXText();
84 if (!bv->insertInset(new_inset)) {
88 new_inset->edit(bv, 0, 0, 0);
93 // returns the nearest enclosing grid
94 MathArrayInset * matrixpar(MathInset::idx_type & idx)
97 return mathcursor ? mathcursor->enclosingArray(idx) : 0;
105 InsetFormulaBase::InsetFormulaBase()
106 : view_(0), font_(), xo_(0), yo_(0)
108 // This is needed as long the math parser is not re-entrant
109 MathMacroTable::builtinMacros();
110 //lyxerr << "sizeof MathInset: " << sizeof(MathInset) << "\n";
114 // Check if uses AMS macros
115 void InsetFormulaBase::validate(LaTeXFeatures &) const
119 void InsetFormulaBase::metrics(BufferView * bv, LyXFont const & f) const
124 MathMetricsInfo mi(view_, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
129 string const InsetFormulaBase::editMessage() const
131 return _("Math editor mode");
135 void InsetFormulaBase::edit(BufferView * bv, int x, int /*y*/, unsigned int)
137 if (!bv->lockInset(this))
138 lyxerr[Debug::MATHED] << "Cannot lock inset!!!" << endl;
140 mathcursor = new MathCursor(this, x == 0);
142 // if that is removed, we won't get the magenta box when entering an
143 // inset for the first time
144 bv->updateInset(this, false);
151 void InsetFormulaBase::edit(BufferView * bv, bool front)
153 // looks hackish but seems to work
154 edit(bv, front ? 0 : 1, 0, 0);
158 void InsetFormulaBase::insetUnlock(BufferView * bv)
161 if (mathcursor->inMacroMode()) {
162 mathcursor->macroModeClose();
163 updateLocal(bv, true);
168 bv->updateInset(this, false);
172 void InsetFormulaBase::getCursorPos(BufferView *, int & x, int & y) const
174 mathcursor->getPos(x, y);
177 //lyxerr << "getCursorPos: " << x << " " << y << "\n";
181 void InsetFormulaBase::toggleInsetCursor(BufferView * bv)
186 if (isCursorVisible())
187 bv->hideLockedInsetCursor();
191 mathcursor->getPos(x, y);
196 MathMetricsInfo mi(bv, font_, LM_ST_TEXT);
197 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
198 bv->showLockedInsetCursor(x, y, asc, des);
199 //lyxerr << "toggleInsetCursor: " << x << " " << y << "\n";
202 toggleCursorVisible();
206 void InsetFormulaBase::showInsetCursor(BufferView * bv, bool)
208 if (!isCursorVisible()) {
212 mathcursor->getPos(x, y);
215 MathMetricsInfo mi(bv, font_, LM_ST_TEXT);
216 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
217 bv->fitLockedInsetCursor(x, y, asc, des);
218 //lyxerr << "showInsetCursor: " << x << " " << y << "\n";
220 toggleInsetCursor(bv);
225 void InsetFormulaBase::hideInsetCursor(BufferView * bv)
227 if (isCursorVisible())
228 toggleInsetCursor(bv);
232 void InsetFormulaBase::toggleInsetSelection(BufferView * bv)
235 bv->updateInset(this, false);
239 vector<string> const InsetFormulaBase::getLabelList() const
241 return std::vector<string>();
245 void InsetFormulaBase::updateLocal(BufferView * bv, bool dirty)
248 bv->updateInset(this, dirty);
252 void InsetFormulaBase::insetButtonRelease(BufferView * bv,
253 int x, int y, int /*button*/)
257 mathcursor->setPos(x + xo_, y + yo_);
258 //lyxerr << "insetButtonRelease: " << x + xo_ << " " << y + yo_ << "\n";
265 bv->updateInset(this, false);
270 void InsetFormulaBase::insetButtonPress(BufferView * bv,
271 int x, int y, int /*button*/)
276 if (mathcursor && mathcursor->selection()) {
277 mathcursor->selClear();
278 bv->updateInset(this, false);
283 void InsetFormulaBase::insetMotionNotify(BufferView * bv,
284 int x, int y, int /*button*/)
286 if (sel_x && sel_y && abs(x-sel_x) > 4 && !sel_flag) {
289 mathcursor->setPos(sel_x, sel_y);
290 mathcursor->selStart();
292 mathcursor->getPos(sel_x, sel_y);
293 } else if (sel_flag) {
295 mathcursor->setPos(x, y);
297 mathcursor->getPos(x, y);
298 if (sel_x != x || sel_y != y)
299 bv->updateInset(this, false);
306 void InsetFormulaBase::insetKeyPress(XKeyEvent *)
308 lyxerr[Debug::MATHED] << "Used InsetFormulaBase::InsetKeyPress." << endl;
312 UpdatableInset::RESULT
313 InsetFormulaBase::localDispatch(BufferView * bv, kb_action action,
316 //lyxerr << "InsetFormulaBase::localDispatch: act: " << action
317 // << " arg: '" << arg << "' cursor: " << mathcursor << "\n";
322 RESULT result = DISPATCHED;
324 bool was_macro = mathcursor->inMacroMode();
325 bool was_selection = mathcursor->selection();
329 mathcursor->normalize();
333 // --- Cursor Movements ---------------------------------------------
336 sel = true; // fall through...
339 result = mathcursor->right(sel) ? DISPATCHED : FINISHED_RIGHT;
340 updateLocal(bv, false);
345 sel = true; // fall through
348 result = mathcursor->left(sel) ? DISPATCHED : FINISHED;
349 updateLocal(bv, false);
357 result = mathcursor->up(sel) ? DISPATCHED : FINISHED_UP;
358 updateLocal(bv, false);
366 result = mathcursor->down(sel) ? DISPATCHED : FINISHED_DOWN;
367 updateLocal(bv, false);
374 mathcursor->home(sel);
375 updateLocal(bv, false);
382 mathcursor->end(sel);
383 updateLocal(bv, false);
386 case LFUN_DELETE_LINE_FORWARD:
387 bv->lockedInsetStoreUndo(Undo::DELETE);
388 mathcursor->delLine();
389 updateLocal(bv, true);
393 mathcursor->idxNext();
394 updateLocal(bv, false);
398 mathcursor->idxPrev();
399 updateLocal(bv, false);
403 bv->lockedInsetStoreUndo(Undo::EDIT);
404 mathcursor->splitCell();
405 updateLocal(bv, true);
408 case LFUN_DELETE_WORD_BACKWARD:
410 bv->lockedInsetStoreUndo(Undo::DELETE);
411 mathcursor->backspace();
412 bv->updateInset(this, true);
415 case LFUN_DELETE_WORD_FORWARD:
417 bv->lockedInsetStoreUndo(Undo::DELETE);
419 bv->updateInset(this, true);
423 // sprintf(dispatch_buffer, "%d %d",);
424 // dispatch_result = dispatch_buffer;
427 lyxerr << "LFUN_SETXY broken!\n";
430 istringstream is(arg.c_str());
432 mathcursor->setPos(x, y);
433 updateLocal(bv, false);
439 mathcursor->macroModeClose();
440 bv->lockedInsetStoreUndo(Undo::INSERT);
441 mathcursor->selPaste();
442 updateLocal(bv, true);
446 bv->lockedInsetStoreUndo(Undo::DELETE);
447 mathcursor->selCut();
448 updateLocal(bv, true);
452 mathcursor->selCopy();
455 case LFUN_WORDRIGHTSEL:
456 case LFUN_WORDLEFTSEL:
459 // --- accented characters ------------------------------
461 case LFUN_UMLAUT: handleAccent(bv, "ddot"); break;
462 case LFUN_CIRCUMFLEX: handleAccent(bv, "hat"); break;
463 case LFUN_GRAVE: handleAccent(bv, "grave"); break;
464 case LFUN_ACUTE: handleAccent(bv, "acute"); break;
465 case LFUN_TILDE: handleAccent(bv, "tilde"); break;
466 case LFUN_MACRON: handleAccent(bv, "bar"); break;
467 case LFUN_DOT: handleAccent(bv, "dot"); break;
468 case LFUN_CARON: handleAccent(bv, "check"); break;
469 case LFUN_BREVE: handleAccent(bv, "breve"); break;
470 case LFUN_VECTOR: handleAccent(bv, "vec"); break;
473 case LFUN_GREEK_TOGGLE: handleFont(bv, LM_TC_GREEK); break;
474 case LFUN_BOLD: handleFont(bv, LM_TC_BF); break;
475 case LFUN_SANS: handleFont(bv, LM_TC_SF); break;
476 case LFUN_EMPH: handleFont(bv, LM_TC_CAL); break;
477 case LFUN_ROMAN: handleFont(bv, LM_TC_RM); break;
478 case LFUN_CODE: handleFont(bv, LM_TC_TT); break;
479 case LFUN_NOUN: handleFont(bv, LM_TC_BB); break;
480 case LFUN_DEFAULT: handleFont(bv, LM_TC_VAR); break;
483 handleFont(bv, LM_TC_GREEK1);
485 mathcursor->interpret(arg);
489 handleFont(bv, LM_TC_TEXTRM);
490 //bv->owner()->message(_("math text mode toggled"));
493 case LFUN_MATH_LIMITS:
494 bv->lockedInsetStoreUndo(Undo::INSERT);
495 if (mathcursor->toggleLimits())
496 updateLocal(bv, true);
502 bv->lockedInsetStoreUndo(Undo::INSERT);
503 mathcursor->setSize(arg);
504 updateLocal(bv, true);
509 case LFUN_INSERT_MATRIX:
511 bv->lockedInsetStoreUndo(Undo::INSERT);
512 mathcursor->interpret("matrix " + arg);
513 updateLocal(bv, true);
517 case LFUN_MATH_SPACE:
519 bv->lockedInsetStoreUndo(Undo::EDIT);
520 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
521 updateLocal(bv, true);
525 case LFUN_MATH_DELIM:
527 bv->lockedInsetStoreUndo(Undo::INSERT);
528 //lyxerr << "formulabase::LFUN_MATH_DELIM, arg: '" << arg << "'\n";
531 istringstream is(arg.c_str());
534 lyxerr << "can't parse delimeters from '" << arg << "'\n";
537 bv->lockedInsetStoreUndo(Undo::EDIT);
538 mathcursor->handleDelim(ls, rs);
539 updateLocal(bv, true);
543 case LFUN_PROTECTEDSPACE:
544 //lyxerr << " called LFUN_PROTECTEDSPACE\n";
545 bv->lockedInsetStoreUndo(Undo::INSERT);
546 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
547 updateLocal(bv, true);
551 bv->owner()->message(_("Invalid action in math mode!"));
555 case LFUN_MATH_HALIGN:
557 bv->lockedInsetStoreUndo(Undo::INSERT);
558 lyxerr << "handling halign '" << arg << "'\n";
559 MathInset::idx_type idx;
560 MathArrayInset * p = matrixpar(idx);
563 p->halign(arg.size() ? arg[0] : 'c', p->col(idx));
564 updateLocal(bv, true);
568 case LFUN_MATH_VALIGN:
570 bv->lockedInsetStoreUndo(Undo::INSERT);
571 lyxerr << "handling valign '" << arg << "'\n";
572 MathInset::idx_type idx;
573 MathArrayInset * p = matrixpar(idx);
576 p->valign(arg.size() ? arg[0] : 'c');
577 updateLocal(bv, true);
581 case LFUN_MATH_ROW_INSERT:
583 bv->lockedInsetStoreUndo(Undo::INSERT);
584 MathInset::idx_type idx;
585 MathArrayInset * p = matrixpar(idx);
586 lyxerr << " calling LFUN_MATH_ROW_INSERT on " << p << endl;
589 p->addRow(p->row(idx));
590 updateLocal(bv, true);
594 case LFUN_MATH_ROW_DELETE:
596 bv->lockedInsetStoreUndo(Undo::INSERT);
597 MathInset::idx_type idx;
598 MathArrayInset * p = matrixpar(idx);
599 lyxerr << " calling LFUN_MATH_ROW_DELETE on " << p << endl;
602 p->delRow(p->row(idx));
603 updateLocal(bv, true);
607 case LFUN_MATH_COLUMN_INSERT:
609 bv->lockedInsetStoreUndo(Undo::INSERT);
610 MathInset::idx_type idx;
611 MathArrayInset * p = matrixpar(idx);
614 p->addCol(p->col(idx));
615 updateLocal(bv, true);
619 case LFUN_MATH_COLUMN_DELETE:
621 bv->lockedInsetStoreUndo(Undo::INSERT);
622 MathInset::idx_type idx;
623 MathArrayInset * p = matrixpar(idx);
626 p->delCol(p->col(idx));
627 updateLocal(bv, true);
631 case LFUN_EXEC_COMMAND:
632 result = UNDISPATCHED;
635 case LFUN_BREAKPARAGRAPH:
636 case LFUN_BREAKPARAGRAPHKEEPLAYOUT:
637 //lyxerr << "LFUN ignored\n";
641 case LFUN_INSERT_MATH:
642 case LFUN_SELFINSERT:
644 bv->lockedInsetStoreUndo(Undo::INSERT);
645 mathcursor->interpret(arg);
646 updateLocal(bv, true);
650 case LFUN_MATH_PANEL:
651 result = UNDISPATCHED;
655 result = UNDISPATCHED;
658 lyx::Assert(mathcursor);
659 //mathcursor->normalize();
661 if (//was_macro != mathcursor->inMacroMode() &&
662 action >= 0 && action != LFUN_BACKSPACE)
663 updateLocal(bv, true);
665 if (mathcursor->selection() || was_selection)
666 toggleInsetSelection(bv);
668 if (result == DISPATCHED || result == DISPATCHED_NOUPDATE ||
669 result == UNDISPATCHED)
672 bv->unlockInset(this);
674 return result; // original version
678 Inset::Code InsetFormulaBase::lyxCode() const
680 return Inset::MATH_CODE;
684 int InsetFormulaBase::upperY() const
686 return yo_ - ascent(view_, font_);
690 int InsetFormulaBase::lowerY() const
692 return yo_ + descent(view_, font_);
696 /////////////////////////////////////////////////////////////////////
699 void mathDispatchCreation(BufferView * bv, string const & arg, bool display)
701 if (bv->available()) {
702 // use selection if available..
704 //if (action == LFUN_MATH_IMPORT_SELECTION)
708 string sel = bv->getLyXText()->selectionAsString(bv->buffer(), false);
710 InsetFormulaBase * f;
712 f = new InsetFormula;
713 if (openNewInset(bv, f)) {
714 // don't do that also for LFUN_MATH_MODE unless you want end up with
715 // always changing to mathrm when opening an inlined inset
716 // -- I really hate "LyXfunc overloading"...
718 f->localDispatch(bv, LFUN_MATH_DISPLAY, string());
719 f->localDispatch(bv, LFUN_INSERT_MATH, arg);
722 // create a macro if we see "\\newcommand" somewhere, and an ordinary
724 if (sel.find("\\newcommand") == string::npos)
725 f = new InsetFormula(sel);
727 f = new InsetFormulaMacro(sel);
728 bv->getLyXText()->cutSelection(bv);
732 bv->owner()->getLyXFunc()->setMessage(N_("Math editor mode"));
736 void mathDispatchMathDisplay(BufferView * bv, string const & arg)
738 mathDispatchCreation(bv, arg, true);
742 void mathDispatchMathMode(BufferView * bv, string const & arg)
744 mathDispatchCreation(bv, arg, false);
748 void mathDispatchMathImportSelection(BufferView * bv, string const & arg)
750 mathDispatchCreation(bv, arg, true);
754 void mathDispatchMathMacro(BufferView * bv, string const & arg)
756 if (bv->available()) {
758 bv->owner()->getLyXFunc()->setErrorMessage(N_("Missing argument"));
761 string const s1 = token(s, ' ', 1);
762 int const na = s1.empty() ? 0 : lyx::atoi(s1);
763 openNewInset(bv, new InsetFormulaMacro(token(s, ' ', 0), na));
769 void mathDispatchMathDelim(BufferView * bv, string const & arg)
771 if (bv->available()) {
772 if (openNewInset(bv, new InsetFormula))
773 bv->theLockingInset()->localDispatch(bv, LFUN_MATH_DELIM, arg);
778 void mathDispatchInsertMatrix(BufferView * bv, string const & arg)
780 if (bv->available()) {
781 if (openNewInset(bv, new InsetFormula))
782 bv->theLockingInset()->localDispatch(bv, LFUN_INSERT_MATRIX, arg);
787 void mathDispatchInsertMath(BufferView * bv, string const & arg)
789 if (bv->available()) {
790 if (arg.size() && arg[0] == '\\') {
791 InsetFormula * f = new InsetFormula(arg);
792 if (!bv->insertInset(f))
795 mathDispatchMathMode(bv, arg);
800 void mathDispatchGreek(BufferView * bv, string const & arg)
802 if (bv->available()) {
803 InsetFormula * f = new InsetFormula;
804 if (openNewInset(bv, f)) {
805 bv->theLockingInset()->localDispatch(bv, LFUN_GREEK, arg);