3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
9 * Full author contact details are available in file CREDITS.
15 #include "formulabase.h"
17 #include "formulamacro.h"
18 #include "math_support.h"
19 #include "math_arrayinset.h"
20 #include "math_deliminset.h"
21 #include "math_cursor.h"
22 #include "math_factory.h"
23 #include "math_hullinset.h"
24 #include "math_parser.h"
25 #include "math_spaceinset.h"
26 #include "ref_inset.h"
28 #include "BufferView.h"
29 #include "bufferview_funcs.h"
30 #include "dispatchresult.h"
32 #include "funcrequest.h"
38 #include "frontends/LyXView.h"
39 #include "frontends/Dialogs.h"
41 #include "support/std_sstream.h"
42 #include "support/lstrings.h"
43 #include "support/lyxlib.h"
45 using lyx::support::atoi;
46 using lyx::support::split;
47 using lyx::support::token;
53 using std::istringstream;
54 using std::ostringstream;
57 MathCursor * mathcursor = 0;
65 bool openNewInset(BufferView & bv, UpdatableInset * inset)
67 if (!bv.insertInset(inset)) {
71 inset->edit(&bv, true);
80 InsetFormulaBase::InsetFormulaBase()
82 // This is needed as long the math parser is not re-entrant
84 //lyxerr << "sizeof MathInset: " << sizeof(MathInset) << endl;
85 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
86 //lyxerr << "sizeof MathCharInset: " << sizeof(MathCharInset) << endl;
87 //lyxerr << "sizeof LyXFont: " << sizeof(LyXFont) << endl;
91 // simply scrap this function if you want
92 void InsetFormulaBase::mutateToText()
97 latex(NULL, os, false, false);
98 string str = os.str();
101 LyXText * lt = view_->getLyXText();
102 string::const_iterator cit = str.begin();
103 string::const_iterator end = str.end();
104 for (; cit != end; ++cit)
105 view_->owner()->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
108 //view_->owner()->dispatch(LFUN_ESCAPE);
113 void InsetFormulaBase::handleFont
114 (BufferView & bv, string const & arg, string const & font)
116 // this whole function is a hack and won't work for incremental font
118 recordUndo(bv, Undo::ATOMIC);
120 if (bv.cursor().inset()->asMathInset()->name() == font)
121 mathcursor->handleFont(bv, font);
123 mathcursor->handleNest(bv, createMathInset(font));
124 mathcursor->insert(bv, arg);
129 void InsetFormulaBase::handleFont2(BufferView & bv, string const & arg)
131 recordUndo(bv, Undo::ATOMIC);
134 bv_funcs::string2font(arg, font, b);
135 if (font.color() != LColor::inherit) {
136 MathAtom at = createMathInset("color");
137 asArray(lcolor.getGUIName(font.color()), at.nucleus()->cell(0));
138 mathcursor->handleNest(bv, at, 1);
144 void InsetFormulaBase::validate(LaTeXFeatures &) const
148 string const InsetFormulaBase::editMessage() const
150 return _("Math editor mode");
154 void InsetFormulaBase::insetUnlock(BufferView & bv)
157 if (mathcursor->inMacroMode(bv))
158 mathcursor->macroModeClose(bv);
159 releaseMathCursor(bv);
162 generatePreview(*bv.buffer());
167 void InsetFormulaBase::getCursor(BufferView & bv, int & x, int & y) const
169 mathcursor->getScreenPos(bv, x, y);
173 void InsetFormulaBase::getCursorPos(BufferView & bv, int & x, int & y) const
176 mathcursor->getScreenPos(bv, x, y);
177 x = mathcursor->targetX(bv);
180 lyxerr << "InsetFormulaBase::getCursorPos: " << x << ' ' << y << endl;
184 lyxerr << "getCursorPos - should not happen";
189 void InsetFormulaBase::getCursorDim(int & asc, int & desc) const
194 //math_font_max_dim(font_, asc, des);
199 void InsetFormulaBase::toggleInsetSelection(BufferView * bv)
207 InsetFormulaBase::lfunMouseRelease(BufferView & bv, FuncRequest const & cmd)
210 return DispatchResult(false);
212 //lyxerr << "lfunMouseRelease: buttons: " << cmd.button() << endl;
214 if (cmd.button() == mouse_button::button3) {
215 // try to dispatch to enclosed insets first
216 if (!mathcursor->dispatch(bv, cmd).dispatched()) {
217 // launch math panel for right mouse button
218 lyxerr << "lfunMouseRelease: undispatched: " << cmd.button() << endl;
219 bv.owner()->getDialogs().show("mathpanel");
221 return DispatchResult(true, true);
224 if (cmd.button() == mouse_button::button2) {
226 asArray(bv.getClipboard(), ar);
227 mathcursor->selClear(bv);
228 mathcursor->setScreenPos(bv, cmd.x + xo_, cmd.y + yo_);
229 mathcursor->insert(bv, ar);
231 return DispatchResult(true, true);
234 if (cmd.button() == mouse_button::button1) {
235 // try to dispatch to enclosed insets first
236 mathcursor->dispatch(bv, cmd);
237 bv.stuffClipboard(mathcursor->grabSelection(bv));
238 // try to set the cursor
240 //mathcursor = new MathCursor(bv, this, x == 0);
242 //mathcursor->setScreenPos(x + xo_, y + yo_);
243 return DispatchResult(true, true);
246 return DispatchResult(false);
251 InsetFormulaBase::lfunMousePress(BufferView & bv, FuncRequest const & cmd)
253 //lyxerr << "lfunMousePress: buttons: " << cmd.button() << endl;
255 if (!mathcursor || mathcursor->formula() != this) {
256 lyxerr[Debug::MATHED] << "re-create cursor" << endl;
257 releaseMathCursor(bv);
258 mathcursor = new MathCursor(&bv, this, cmd.x == 0);
260 mathcursor->setScreenPos(bv, cmd.x + xo_, cmd.y + yo_);
263 if (cmd.button() == mouse_button::button3) {
264 mathcursor->dispatch(bv, cmd);
265 return DispatchResult(true, true);
268 if (cmd.button() == mouse_button::button1) {
271 mathcursor->selClear(bv);
272 mathcursor->setScreenPos(bv, cmd.x + xo_, cmd.y + yo_);
273 mathcursor->dispatch(bv, cmd);
274 return DispatchResult(true, true);
278 return DispatchResult(true, true);
283 InsetFormulaBase::lfunMouseMotion(BufferView & bv, FuncRequest const & cmd)
286 return DispatchResult(true, true);
288 if (mathcursor->dispatch(bv, FuncRequest(cmd)).dispatched())
289 return DispatchResult(true, true);
291 // only select with button 1
292 if (cmd.button() != mouse_button::button1)
293 return DispatchResult(true, true);
295 if (abs(cmd.x - first_x) < 2 && abs(cmd.y - first_y) < 2)
296 return DispatchResult(true, true);
301 if (!mathcursor->selection())
302 mathcursor->selStart(bv);
304 mathcursor->setScreenPos(bv, cmd.x + xo_, cmd.y + yo_);
306 return DispatchResult(true, true);
310 void InsetFormulaBase::edit(BufferView * bv, bool left)
312 lyxerr << "Called FormulaBase::edit" << endl;
313 releaseMathCursor(*bv);
314 mathcursor = new MathCursor(bv, this, left);
315 bv->fullCursor().push(this);
316 // if that is removed, we won't get the magenta box when entering an
317 // inset for the first time
322 void InsetFormulaBase::edit(BufferView * bv, int x, int y)
324 lyxerr << "Called FormulaBase::EDIT with '" << x << ' ' << y << "'" << endl;
325 releaseMathCursor(*bv);
326 mathcursor = new MathCursor(bv, this, true);
328 mathcursor->setScreenPos(*bv, x + xo_, y + yo_);
329 bv->fullCursor().push(this);
330 // if that is removed, we won't get the magenta box when entering an
331 // inset for the first time
337 InsetFormulaBase::priv_dispatch(BufferView & bv, FuncRequest const & cmd)
339 //lyxerr << "InsetFormulaBase::localDispatch: act: " << cmd.action
340 // << " arg: '" << cmd.argument
341 // << "' x: '" << cmd.x
342 // << " y: '" << cmd.y
343 // << "' button: " << cmd.button() << endl;
345 // delete empty mathbox (LFUN_BACKSPACE and LFUN_DELETE)
346 bool remove_inset = false;
348 switch (cmd.action) {
349 case LFUN_MOUSE_PRESS:
350 //lyxerr << "Mouse single press" << endl;
351 return lfunMousePress(bv, cmd);
352 case LFUN_MOUSE_MOTION:
353 //lyxerr << "Mouse motion" << endl;
354 return lfunMouseMotion(bv, cmd);
355 case LFUN_MOUSE_RELEASE:
356 //lyxerr << "Mouse single release" << endl;
357 return lfunMouseRelease(bv, cmd);
358 case LFUN_MOUSE_DOUBLE:
359 //lyxerr << "Mouse double" << endl;
360 return dispatch(bv, FuncRequest(LFUN_WORDSEL));
366 return DispatchResult(false);
368 DispatchResult result(true);
369 string argument = cmd.argument;
371 bool was_macro = mathcursor->inMacroMode(bv);
372 bool was_selection = mathcursor->selection();
374 mathcursor->normalize(bv);
377 switch (cmd.action) {
379 case LFUN_MATH_MUTATE:
380 case LFUN_MATH_DISPLAY:
381 case LFUN_MATH_NUMBER:
382 case LFUN_MATH_NONUMBER:
383 case LFUN_CELL_SPLIT:
385 case LFUN_DELETE_LINE_FORWARD:
386 case LFUN_INSERT_LABEL:
387 case LFUN_MATH_EXTERN:
388 case LFUN_TABULAR_FEATURE:
389 case LFUN_PASTESELECTION:
390 case LFUN_MATH_LIMITS:
391 recordUndo(bv, Undo::ATOMIC);
392 mathcursor->dispatch(bv, cmd);
396 sel = true; // fall through...
398 result = mathcursor->right(bv, sel) ?
399 DispatchResult(true, true) : DispatchResult(false, FINISHED_RIGHT);
400 //lyxerr << "calling scroll 20" << endl;
402 // write something to the minibuffer
403 //bv.owner()->message(mathcursor->info());
407 sel = true; // fall through
409 result = mathcursor->left(bv, sel) ?
410 DispatchResult(true, true) : DispatchResult(false, FINISHED);
414 sel = true; // fall through
416 result = mathcursor->up(bv, sel) ?
417 DispatchResult(true, true) : DispatchResult(false, FINISHED_UP);
421 sel = true; // fall through
423 result = mathcursor->down(bv, sel) ?
424 DispatchResult(true, true) : DispatchResult(false, FINISHED_DOWN);
428 mathcursor->home(bv, false);
429 mathcursor->end(bv, true);
432 case LFUN_UP_PARAGRAPHSEL:
433 case LFUN_UP_PARAGRAPH:
434 case LFUN_DOWN_PARAGRAPHSEL:
435 case LFUN_DOWN_PARAGRAPH:
436 result = DispatchResult(true, FINISHED);
440 case LFUN_WORDLEFTSEL:
441 sel = true; // fall through
444 result = mathcursor->home(bv, sel)
445 ? DispatchResult(true, true) : DispatchResult(true, FINISHED);
449 case LFUN_WORDRIGHTSEL:
450 sel = true; // fall through
453 result = mathcursor->end(bv, sel)
454 ? DispatchResult(true, true) : DispatchResult(false, FINISHED_RIGHT);
459 case LFUN_BEGINNINGBUFSEL:
460 case LFUN_BEGINNINGBUF:
461 result = DispatchResult(true, FINISHED);
468 result = DispatchResult(false, FINISHED_RIGHT);
471 case LFUN_CELL_FORWARD:
472 mathcursor->idxNext(bv);
475 case LFUN_CELL_BACKWARD:
476 mathcursor->idxPrev(bv);
479 case LFUN_DELETE_WORD_BACKWARD:
481 recordUndo(bv, Undo::ATOMIC);
482 if (!mathcursor->backspace(bv)) {
483 result = DispatchResult(true, FINISHED);
488 case LFUN_DELETE_WORD_FORWARD:
490 recordUndo(bv, Undo::ATOMIC);
491 if (!mathcursor->erase(bv)) {
492 result = DispatchResult(true, FINISHED);
498 // sprintf(dispatch_buffer, "%d %d",);
499 // DispatchResult= dispatch_buffer;
502 lyxerr << "LFUN_SETXY broken!" << endl;
505 istringstream is(cmd.argument.c_str());
507 mathcursor->setScreenPos(bv, x, y);
513 istringstream is(cmd.argument.c_str());
516 mathcursor->macroModeClose(bv);
517 recordUndo(bv, Undo::ATOMIC);
518 mathcursor->selPaste(bv, n);
523 recordUndo(bv, Undo::DELETE);
524 mathcursor->selCut(bv);
528 mathcursor->selCopy(bv);
532 // Special casing for superscript in case of LyX handling
534 case LFUN_CIRCUMFLEX:
535 if (cmd.argument.empty()) {
536 // do superscript if LyX handles
538 recordUndo(bv, Undo::ATOMIC);
539 mathcursor->script(bv, true);
556 case LFUN_HUNG_UMLAUT:
560 case LFUN_FREEFONT_APPLY:
561 case LFUN_FREEFONT_UPDATE:
562 handleFont2(bv, cmd.argument);
565 case LFUN_BOLD: handleFont(bv, cmd.argument, "mathbf"); break;
566 case LFUN_SANS: handleFont(bv, cmd.argument, "mathsf"); break;
567 case LFUN_EMPH: handleFont(bv, cmd.argument, "mathcal"); break;
568 case LFUN_ROMAN: handleFont(bv, cmd.argument, "mathrm"); break;
569 case LFUN_CODE: handleFont(bv, cmd.argument, "texttt"); break;
570 case LFUN_FRAK: handleFont(bv, cmd.argument, "mathfrak"); break;
571 case LFUN_ITAL: handleFont(bv, cmd.argument, "mathit"); break;
572 case LFUN_NOUN: handleFont(bv, cmd.argument, "mathbb"); break;
573 //case LFUN_FREEFONT_APPLY: handleFont(bv, cmd.argument, "textrm"); break;
574 case LFUN_DEFAULT: handleFont(bv, cmd.argument, "textnormal"); break;
577 if (mathcursor->currentMode(bv) == MathInset::TEXT_MODE)
578 mathcursor->niceInsert(bv, MathAtom(new MathHullInset("simple")));
580 handleFont(bv, cmd.argument, "textrm");
581 //bv.owner()->message(_("math text mode toggled"));
587 recordUndo(bv, Undo::ATOMIC);
588 mathcursor->setSize(arg);
593 case LFUN_INSERT_MATRIX: {
594 recordUndo(bv, Undo::ATOMIC);
599 istringstream is(argument);
600 is >> m >> n >> v_align >> h_align;
604 mathcursor->niceInsert(bv,
605 MathAtom(new MathArrayInset("array", m, n, v_align[0], h_align)));
609 case LFUN_MATH_DELIM: {
610 //lyxerr << "formulabase::LFUN_MATH_DELIM, arg: '" << arg << "'" << endl;
612 string rs = split(cmd.argument, ls, ' ');
613 // Reasonable default values
618 recordUndo(bv, Undo::ATOMIC);
619 mathcursor->handleNest(bv, MathAtom(new MathDelimInset(ls, rs)));
623 case LFUN_SPACE_INSERT:
624 case LFUN_MATH_SPACE:
625 recordUndo(bv, Undo::ATOMIC);
626 mathcursor->insert(bv, MathAtom(new MathSpaceInset(",")));
630 bv.owner()->message(_("Invalid action in math mode!"));
634 case LFUN_EXEC_COMMAND:
635 result = DispatchResult(false);
639 // interpret this as if a backslash was typed
640 recordUndo(bv, Undo::ATOMIC);
641 mathcursor->interpret(bv, '\\');
644 case LFUN_BREAKPARAGRAPH:
645 case LFUN_BREAKPARAGRAPHKEEPLAYOUT:
646 case LFUN_BREAKPARAGRAPH_SKIP:
650 // FIXME: We probably should swap parts of "math-insert" and "self-insert"
651 // handling such that "self-insert" works on "arbitrary stuff" too, and
652 // math-insert only handles special math things like "matrix".
653 case LFUN_INSERT_MATH:
654 recordUndo(bv, Undo::ATOMIC);
655 mathcursor->niceInsert(bv, argument);
659 case LFUN_SELFINSERT:
660 if (!argument.empty()) {
661 recordUndo(bv, Undo::ATOMIC);
662 if (argument.size() == 1)
663 result = mathcursor->interpret(bv, argument[0])
664 ? DispatchResult(true, true) : DispatchResult(false, FINISHED_RIGHT);
666 mathcursor->insert(bv, argument);
671 if (mathcursor->selection())
672 mathcursor->selClear(bv);
674 result = DispatchResult(false);
677 case LFUN_INSET_TOGGLE:
678 mathcursor->insetToggle(bv);
681 case LFUN_DIALOG_SHOW:
682 result = DispatchResult(false);
685 case LFUN_DIALOG_SHOW_NEW_INSET: {
686 string const & name = argument;
690 data = tmp.createDialogStr(name);
694 result = DispatchResult(false);
696 bv.owner()->getDialogs().show(name, data, 0);
700 case LFUN_INSET_APPLY: {
701 string const name = cmd.getArg(0);
702 InsetBase * base = bv.owner()->getDialogs().getOpenInset(name);
705 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument);
706 result = base->dispatch(bv, fr);
709 if (createMathInset_fromDialogStr(cmd.argument, ar)) {
710 mathcursor->insert(bv, ar);
711 result = DispatchResult(true, true);
713 result = DispatchResult(false);
719 case LFUN_WORD_REPLACE:
720 case LFUN_WORD_FIND: {
722 searchForward(&bv, cmd.getArg(0), false, false)
723 ? DispatchResult(true, true) : DispatchResult(false);
728 result = DispatchResult(false);
731 if (result == DispatchResult(true, true))
734 mathcursor->normalize(bv);
737 BOOST_ASSERT(mathcursor);
739 if (mathcursor->selection() || was_selection)
740 toggleInsetSelection(&bv);
742 if (result.dispatched()) {
744 bv.stuffClipboard(mathcursor->grabSelection(bv));
746 releaseMathCursor(bv);
748 bv.owner()->dispatch(FuncRequest(LFUN_DELETE));
751 return result; // original version
755 void InsetFormulaBase::revealCodes(BufferView & bv) const
759 bv.owner()->message(mathcursor->info(bv));
761 // write something to the minibuffer
762 // translate to latex
763 mathcursor->markInsert(bv);
766 string str = os.str();
767 mathcursor->markErase(bv);
768 string::size_type pos = 0;
770 for (string::iterator it = str.begin(); it != str.end(); ++it) {
773 else if (*it == '\0') {
775 pos = it - str.begin();
781 res = res.substr(pos - 30);
783 res = res.substr(0, 60);
784 bv.owner()->message(res);
789 InsetOld::Code InsetFormulaBase::lyxCode() const
791 return InsetOld::MATH_CODE;
795 int InsetFormulaBase::ylow() const
797 return yo_ - dim_.asc;
801 int InsetFormulaBase::yhigh() const
803 return yo_ + dim_.des;
807 int InsetFormulaBase::xlow() const
813 int InsetFormulaBase::xhigh() const
815 return xo_ + dim_.wid;
819 /////////////////////////////////////////////////////////////////////
822 bool InsetFormulaBase::searchForward(BufferView * bv, string const & str,
828 static InsetFormulaBase * lastformula = 0;
829 static CursorBase current = CursorBase(ibegin(par().nucleus()));
831 static string laststr;
833 if (lastformula != this || laststr != str) {
834 //lyxerr << "reset lastformula to " << this << endl;
837 current = ibegin(par().nucleus());
839 mathed_parse_cell(ar, str);
843 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
845 for (CursorBase it = current; it != iend(par().nucleus()); increment(it)) {
846 CursorSlice & top = it.back();
847 MathArray const & a = top.asMathInset()->cell(top.idx_);
848 if (a.matchpart(ar, top.pos_)) {
850 mathcursor = new MathCursor(bv, this, true);
852 mathcursor->setSelection(*bv, it, ar.size());
854 top.pos_ += ar.size();
860 //lyxerr << "not found!" << endl;
866 bool InsetFormulaBase::searchBackward(BufferView * bv, string const & what,
869 lyxerr[Debug::MATHED] << "searching backward not implemented in mathed" << endl;
870 return searchForward(bv, what, a, b);
874 bool InsetFormulaBase::display() const
876 return par()->asHullInset() && par()->asHullInset()->display();
880 string InsetFormulaBase::selectionAsString(BufferView & bv) const
882 return mathcursor ? mathcursor->grabSelection(bv) : string();
885 /////////////////////////////////////////////////////////////////////
888 void mathDispatchCreation(BufferView & bv, FuncRequest const & cmd,
891 // use selection if available..
893 //if (action == LFUN_MATH_IMPORT_SELECTION)
897 string sel = bv.getLyXText()->selectionAsString(*bv.buffer(), false);
900 InsetFormula * f = new InsetFormula(&bv);
901 if (openNewInset(bv, f)) {
902 bv.fullCursor().innerInset()->
903 dispatch(bv, FuncRequest(LFUN_MATH_MUTATE, "simple"));
904 // don't do that also for LFUN_MATH_MODE unless you want end up with
905 // always changing to mathrm when opening an inlined inset
906 // -- I really hate "LyXfunc overloading"...
908 f->dispatch(bv, FuncRequest(LFUN_MATH_DISPLAY));
909 f->dispatch(bv, FuncRequest(LFUN_INSERT_MATH, cmd.argument));
912 // create a macro if we see "\\newcommand" somewhere, and an ordinary
914 InsetFormulaBase * f;
915 if (sel.find("\\newcommand") == string::npos &&
916 sel.find("\\def") == string::npos)
917 f = new InsetFormula(sel);
919 f = new InsetFormulaMacro(sel);
920 bv.getLyXText()->cutSelection(true, false);
923 cmd.message(N_("Math editor mode"));
927 void mathDispatch(BufferView & bv, FuncRequest const & cmd)
932 switch (cmd.action) {
934 case LFUN_MATH_DISPLAY:
935 mathDispatchCreation(bv, cmd, true);
939 mathDispatchCreation(bv, cmd, false);
942 case LFUN_MATH_IMPORT_SELECTION:
943 mathDispatchCreation(bv, cmd, false);
946 case LFUN_MATH_MACRO:
947 if (cmd.argument.empty())
948 cmd.errorMessage(N_("Missing argument"));
950 string s = cmd.argument;
951 string const s1 = token(s, ' ', 1);
952 int const nargs = s1.empty() ? 0 : atoi(s1);
953 string const s2 = token(s, ' ', 2);
954 string const type = s2.empty() ? "newcommand" : s2;
955 openNewInset(bv, new InsetFormulaMacro(token(s, ' ', 0), nargs, s2));
959 case LFUN_INSERT_MATH:
960 case LFUN_INSERT_MATRIX:
961 case LFUN_MATH_DELIM: {
962 InsetFormula * f = new InsetFormula(&bv);
963 if (openNewInset(bv, f)) {
964 UpdatableInset * inset = bv.fullCursor().innerInset();
965 inset->dispatch(bv, FuncRequest(LFUN_MATH_MUTATE, "simple"));
966 inset->dispatch(bv, cmd);