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 "math_parser.h"
30 #include "BufferView.h"
34 #include "LaTeXFeatures.h"
37 #include "support/lstrings.h"
41 #include "math_arrayinset.h"
42 #include "math_spaceinset.h"
43 #include "math_macrotable.h"
44 #include "math_factory.h"
45 #include "support/lyxlib.h"
46 #include "undo_funcs.h"
52 extern char const * latex_mathenv[];
53 MathCursor * mathcursor = 0;
64 void handleFont(BufferView * bv, MathTextCodes t)
66 if (mathcursor->selection())
67 bv->lockedInsetStoreUndo(Undo::EDIT);
68 mathcursor->handleFont(t);
72 void handleAccent(BufferView * bv, string const & name)
74 bv->lockedInsetStoreUndo(Undo::EDIT);
75 mathcursor->insert(createMathInset(name));
79 bool openNewInset(BufferView * bv, UpdatableInset * new_inset)
81 LyXText * lt = bv->getLyXText();
85 if (!bv->insertInset(new_inset)) {
89 new_inset->edit(bv, 0, 0, 0);
94 // returns the nearest enclosing grid
95 MathArrayInset * matrixpar(MathInset::idx_type & idx)
98 return mathcursor ? mathcursor->enclosingArray(idx) : 0;
106 InsetFormulaBase::InsetFormulaBase()
109 // This is needed as long the math parser is not re-entrant
110 MathMacroTable::builtinMacros();
111 //lyxerr << "sizeof MathInset: " << sizeof(MathInset) << "\n";
115 // Check if uses AMS macros
116 void InsetFormulaBase::validate(LaTeXFeatures &) const
120 void InsetFormulaBase::metrics(BufferView * bv, LyXFont const & f) const
125 MathMetricsInfo mi(view_, font_, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
130 string const InsetFormulaBase::editMessage() const
132 return _("Math editor mode");
136 void InsetFormulaBase::edit(BufferView * bv, int x, int /*y*/, unsigned int)
138 if (!bv->lockInset(this))
139 lyxerr[Debug::MATHED] << "Cannot lock inset!!!" << endl;
141 mathcursor = new MathCursor(this, x == 0);
143 // if that is removed, we won't get the magenta box when entering an
144 // inset for the first time
145 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);
182 void InsetFormulaBase::toggleInsetCursor(BufferView * bv)
187 if (isCursorVisible())
188 bv->hideLockedInsetCursor();
192 mathcursor->getPos(x, y);
198 MathMetricsInfo mi(bv, font_, LM_ST_TEXT);
199 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
200 bv->showLockedInsetCursor(x, y, asc, des);
203 toggleCursorVisible();
207 void InsetFormulaBase::showInsetCursor(BufferView * bv, bool)
209 if (!isCursorVisible()) {
213 mathcursor->getPos(x, y);
218 MathMetricsInfo mi(bv, font_, LM_ST_TEXT);
219 math_font_max_dim(LM_TC_TEXTRM, mi, asc, des);
220 bv->fitLockedInsetCursor(x, y, asc, des);
222 toggleInsetCursor(bv);
227 void InsetFormulaBase::hideInsetCursor(BufferView * bv)
229 if (isCursorVisible())
230 toggleInsetCursor(bv);
234 void InsetFormulaBase::toggleInsetSelection(BufferView * bv)
237 bv->updateInset(this, false);
241 vector<string> const InsetFormulaBase::getLabelList() const
243 return std::vector<string>();
247 void InsetFormulaBase::updateLocal(BufferView * bv, bool dirty)
250 bv->updateInset(this, dirty);
254 void InsetFormulaBase::insetButtonRelease(BufferView * bv,
255 int x, int y, int /*button*/)
261 mathcursor->setPos(x, y);
268 bv->updateInset(this, false);
273 void InsetFormulaBase::insetButtonPress(BufferView * bv,
274 int x, int y, int /*button*/)
279 if (mathcursor && mathcursor->selection()) {
280 mathcursor->selClear();
281 bv->updateInset(this, false);
286 void InsetFormulaBase::insetMotionNotify(BufferView * bv,
287 int x, int y, int /*button*/)
289 if (sel_x && sel_y && abs(x-sel_x) > 4 && !sel_flag) {
292 mathcursor->setPos(sel_x + par()->xo(), sel_y + par()->yo());
293 mathcursor->selStart();
295 mathcursor->getPos(sel_x, sel_y);
296 } else if (sel_flag) {
300 mathcursor->setPos(x, y);
302 mathcursor->getPos(x, y);
303 if (sel_x != x || sel_y != y)
304 bv->updateInset(this, false);
311 void InsetFormulaBase::insetKeyPress(XKeyEvent *)
313 lyxerr[Debug::MATHED] << "Used InsetFormulaBase::InsetKeyPress." << endl;
317 UpdatableInset::RESULT
318 InsetFormulaBase::localDispatch(BufferView * bv, kb_action action,
321 //lyxerr << "InsetFormulaBase::localDispatch: act: " << action
322 // << " arg: '" << arg << "' cursor: " << mathcursor << "\n";
327 RESULT result = DISPATCHED;
329 bool was_macro = mathcursor->inMacroMode();
330 bool was_selection = mathcursor->selection();
334 mathcursor->normalize();
338 // --- Cursor Movements ---------------------------------------------
341 sel = true; // fall through...
344 result = mathcursor->right(sel) ? DISPATCHED : FINISHED_RIGHT;
345 updateLocal(bv, false);
350 sel = true; // fall through
353 result = mathcursor->left(sel) ? DISPATCHED : FINISHED;
354 updateLocal(bv, false);
362 result = mathcursor->up(sel) ? DISPATCHED : FINISHED_UP;
363 updateLocal(bv, false);
371 result = mathcursor->down(sel) ? DISPATCHED : FINISHED_DOWN;
372 updateLocal(bv, false);
379 mathcursor->home(sel);
380 updateLocal(bv, false);
387 mathcursor->end(sel);
388 updateLocal(bv, false);
391 case LFUN_DELETE_LINE_FORWARD:
392 bv->lockedInsetStoreUndo(Undo::DELETE);
393 mathcursor->delLine();
394 updateLocal(bv, true);
398 mathcursor->idxNext();
399 updateLocal(bv, false);
403 mathcursor->idxPrev();
404 updateLocal(bv, false);
408 bv->lockedInsetStoreUndo(Undo::EDIT);
409 mathcursor->splitCell();
410 updateLocal(bv, true);
414 bv->lockedInsetStoreUndo(Undo::DELETE);
415 mathcursor->backspace();
416 bv->updateInset(this, true);
420 bv->lockedInsetStoreUndo(Undo::DELETE);
422 bv->updateInset(this, true);
426 // sprintf(dispatch_buffer, "%d %d",);
427 // dispatch_result = dispatch_buffer;
430 lyxerr << "LFUN_SETXY broken!\n";
435 istringstream is(arg.c_str());
437 par()->getXY(x1, y1);
438 mathcursor->setPos(x1 + x, y1 + y);
439 updateLocal(bv, false);
445 mathcursor->macroModeClose();
446 bv->lockedInsetStoreUndo(Undo::INSERT);
447 mathcursor->selPaste();
448 updateLocal(bv, true);
452 bv->lockedInsetStoreUndo(Undo::DELETE);
453 mathcursor->selCut();
454 updateLocal(bv, true);
458 mathcursor->selCopy();
461 case LFUN_WORDRIGHTSEL:
462 case LFUN_WORDLEFTSEL:
465 // --- accented characters ------------------------------
467 case LFUN_UMLAUT: handleAccent(bv, "ddot"); break;
468 case LFUN_CIRCUMFLEX: handleAccent(bv, "hat"); break;
469 case LFUN_GRAVE: handleAccent(bv, "grave"); break;
470 case LFUN_ACUTE: handleAccent(bv, "acute"); break;
471 case LFUN_TILDE: handleAccent(bv, "tilde"); break;
472 case LFUN_MACRON: handleAccent(bv, "bar"); break;
473 case LFUN_DOT: handleAccent(bv, "dot"); break;
474 case LFUN_CARON: handleAccent(bv, "check"); break;
475 case LFUN_BREVE: handleAccent(bv, "breve"); break;
476 case LFUN_VECTOR: handleAccent(bv, "vec"); break;
479 case LFUN_GREEK_TOGGLE: handleFont(bv, LM_TC_GREEK); break;
480 case LFUN_BOLD: handleFont(bv, LM_TC_BF); break;
481 case LFUN_SANS: handleFont(bv, LM_TC_SF); break;
482 case LFUN_EMPH: handleFont(bv, LM_TC_CAL); break;
483 case LFUN_ROMAN: handleFont(bv, LM_TC_RM); break;
484 case LFUN_CODE: handleFont(bv, LM_TC_TT); break;
485 case LFUN_NOUN: handleFont(bv, LM_TC_BB); break;
486 case LFUN_DEFAULT: handleFont(bv, LM_TC_VAR); break;
489 handleFont(bv, LM_TC_GREEK1);
491 mathcursor->interpret(arg);
495 handleFont(bv, LM_TC_TEXTRM);
496 //bv->owner()->message(_("math text mode toggled"));
499 case LFUN_MATH_LIMITS:
500 bv->lockedInsetStoreUndo(Undo::INSERT);
501 if (mathcursor->toggleLimits())
502 updateLocal(bv, true);
507 bv->lockedInsetStoreUndo(Undo::INSERT);
508 latexkeys const * l = in_word_set(arg);
509 mathcursor->setSize(MathStyles(l ? l->id : static_cast<unsigned int>(-1)));
510 updateLocal(bv, true);
514 case LFUN_INSERT_MATRIX:
516 bv->lockedInsetStoreUndo(Undo::INSERT);
517 mathcursor->interpret("matrix " + arg);
518 updateLocal(bv, true);
522 case LFUN_MATH_SPACE:
524 bv->lockedInsetStoreUndo(Undo::EDIT);
525 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
526 updateLocal(bv, true);
530 case LFUN_MATH_DELIM:
532 bv->lockedInsetStoreUndo(Undo::INSERT);
533 //lyxerr << "formulabase::LFUN_MATH_DELIM, arg: '" << arg << "'\n";
536 istringstream is(arg.c_str());
539 lyxerr << "can't parse delimeters from '" << arg << "'\n";
542 bv->lockedInsetStoreUndo(Undo::EDIT);
543 mathcursor->handleDelim(ls, rs);
544 updateLocal(bv, true);
548 case LFUN_PROTECTEDSPACE:
549 //lyxerr << " called LFUN_PROTECTEDSPACE\n";
550 bv->lockedInsetStoreUndo(Undo::INSERT);
551 mathcursor->insert(MathAtom(new MathSpaceInset(1)));
552 updateLocal(bv, true);
556 bv->owner()->message(_("Invalid action in math mode!"));
560 case LFUN_MATH_HALIGN:
562 bv->lockedInsetStoreUndo(Undo::INSERT);
563 lyxerr << "handling halign '" << arg << "'\n";
564 MathInset::idx_type idx;
565 MathArrayInset * p = matrixpar(idx);
568 p->halign(arg.size() ? arg[0] : 'c', p->col(idx));
569 updateLocal(bv, true);
573 case LFUN_MATH_VALIGN:
575 bv->lockedInsetStoreUndo(Undo::INSERT);
576 lyxerr << "handling valign '" << arg << "'\n";
577 MathInset::idx_type idx;
578 MathArrayInset * p = matrixpar(idx);
581 p->valign(arg.size() ? arg[0] : 'c');
582 updateLocal(bv, true);
586 case LFUN_MATH_ROW_INSERT:
588 bv->lockedInsetStoreUndo(Undo::INSERT);
589 MathInset::idx_type idx;
590 MathArrayInset * p = matrixpar(idx);
591 lyxerr << " calling LFUN_MATH_ROW_INSERT on " << p << endl;
594 p->addRow(p->row(idx));
595 updateLocal(bv, true);
599 case LFUN_MATH_ROW_DELETE:
601 bv->lockedInsetStoreUndo(Undo::INSERT);
602 MathInset::idx_type idx;
603 MathArrayInset * p = matrixpar(idx);
604 lyxerr << " calling LFUN_MATH_ROW_DELETE on " << p << endl;
607 p->delRow(p->row(idx));
608 updateLocal(bv, true);
612 case LFUN_MATH_COLUMN_INSERT:
614 bv->lockedInsetStoreUndo(Undo::INSERT);
615 MathInset::idx_type idx;
616 MathArrayInset * p = matrixpar(idx);
619 p->addCol(p->col(idx));
620 updateLocal(bv, true);
624 case LFUN_MATH_COLUMN_DELETE:
626 bv->lockedInsetStoreUndo(Undo::INSERT);
627 MathInset::idx_type idx;
628 MathArrayInset * p = matrixpar(idx);
631 p->delCol(p->col(idx));
632 updateLocal(bv, true);
636 case LFUN_EXEC_COMMAND:
637 result = UNDISPATCHED;
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 void mathDispatchCreation(BufferView * bv, string const & arg, bool display)
686 if (bv->available()) {
687 // use selection if available..
689 //if (action == LFUN_MATH_IMPORT_SELECTION)
693 string sel = bv->getLyXText()->selectionAsString(bv->buffer(), false);
695 InsetFormulaBase * f;
697 f = new InsetFormula;
698 if (openNewInset(bv, f)) {
699 // don't do that also for LFUN_MATH_MODE unless you want end up with
700 // always changing to mathrm when opening an inlined inset
701 // -- I really hate "LyXfunc overloading"...
703 f->localDispatch(bv, LFUN_MATH_DISPLAY, string());
704 f->localDispatch(bv, LFUN_INSERT_MATH, arg);
707 // create a macro if we see "\\newcommand" somewhere, and an ordinary
709 if (sel.find("\\newcommand") == string::npos)
710 f = new InsetFormula(sel);
712 f = new InsetFormulaMacro(sel);
713 bv->getLyXText()->cutSelection(bv);
717 bv->owner()->getLyXFunc()->setMessage(N_("Math editor mode"));
721 void mathDispatchMathDisplay(BufferView * bv, string const & arg)
723 mathDispatchCreation(bv, arg, true);
727 void mathDispatchMathMode(BufferView * bv, string const & arg)
729 mathDispatchCreation(bv, arg, false);
733 void mathDispatchMathImportSelection(BufferView * bv, string const & arg)
735 mathDispatchCreation(bv, arg, true);
739 void mathDispatchMathMacro(BufferView * bv, string const & arg)
741 if (bv->available()) {
743 bv->owner()->getLyXFunc()->setErrorMessage(N_("Missing argument"));
746 string const s1 = token(s, ' ', 1);
747 int const na = s1.empty() ? 0 : lyx::atoi(s1);
748 openNewInset(bv, new InsetFormulaMacro(token(s, ' ', 0), na));
754 void mathDispatchMathDelim(BufferView * bv, string const & arg)
756 if (bv->available()) {
757 if (openNewInset(bv, new InsetFormula))
758 bv->theLockingInset()->localDispatch(bv, LFUN_MATH_DELIM, arg);
763 void mathDispatchInsertMatrix(BufferView * bv, string const & arg)
765 if (bv->available()) {
766 if (openNewInset(bv, new InsetFormula))
767 bv->theLockingInset()->localDispatch(bv, LFUN_INSERT_MATRIX, arg);
772 void mathDispatchInsertMath(BufferView * bv, string const & arg)
774 if (bv->available()) {
775 if (arg.size() && arg[0] == '\\') {
776 InsetFormula * f = new InsetFormula(arg);
777 if (!bv->insertInset(f))
780 mathDispatchMathMode(bv, arg);
785 void mathDispatchGreek(BufferView * bv, string const & arg)
787 if (bv->available()) {
788 InsetFormula * f = new InsetFormula;
789 if (openNewInset(bv, f)) {
790 bv->theLockingInset()->localDispatch(bv, LFUN_GREEK, arg);