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
8 * \author Lars Gullik Bjønnes
9 * \author Matthias Ettrich
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
19 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
24 #include "CoordCache.h"
26 #include "Dimension.h"
27 #include "DispatchResult.h"
28 #include "FuncRequest.h"
29 #include "FuncStatus.h"
30 #include "InsetLayout.h"
31 #include "MetricsInfo.h"
32 #include "output_xhtml.h"
35 #include "TextClass.h"
36 #include "TocBackend.h"
38 #include "frontends/Application.h"
39 #include "frontends/Painter.h"
41 #include "support/debug.h"
42 #include "support/docstream.h"
43 #include "support/ExceptionMessage.h"
44 #include "support/gettext.h"
45 #include "support/lassert.h"
50 using namespace lyx::support;
56 InsetName(string const & n = string(), docstring const & dn = docstring())
57 : name(n), display_name(dn) {}
59 docstring display_name;
63 static InsetName insetnames[INSET_CODE_SIZE];
66 // This list should be kept in sync with the list of dialogs in
67 // src/frontends/qt/GuiView.cpp, I.e., if a dialog goes with an
68 // inset, the dialog should have the same name as the inset.
69 // Changes should be also recorded in LFUN_DIALOG_SHOW doxygen
70 // docs in LyXAction.cpp.
71 static void build_translator()
73 static bool passed = false;
76 insetnames[TOC_CODE] = InsetName("toc");
77 insetnames[QUOTE_CODE] = InsetName("quote");
78 insetnames[REF_CODE] = InsetName("ref");
79 insetnames[COUNTER_CODE] = InsetName("counter");
80 insetnames[HYPERLINK_CODE] = InsetName("href");
81 insetnames[SEPARATOR_CODE] = InsetName("separator");
82 insetnames[ENDING_CODE] = InsetName("ending");
83 insetnames[LABEL_CODE] = InsetName("label");
84 insetnames[NOTE_CODE] = InsetName("note");
85 insetnames[PHANTOM_CODE] = InsetName("phantom");
86 insetnames[ACCENT_CODE] = InsetName("accent");
87 insetnames[MATH_CODE] = InsetName("math");
88 insetnames[INDEX_CODE] = InsetName("index");
89 insetnames[NOMENCL_CODE] = InsetName("nomenclature");
90 insetnames[INCLUDE_CODE] = InsetName("include");
91 insetnames[GRAPHICS_CODE] = InsetName("graphics");
92 insetnames[BIBITEM_CODE] = InsetName("bibitem", _("Bibliography Entry"));
93 insetnames[BIBTEX_CODE] = InsetName("bibtex");
94 insetnames[TEXT_CODE] = InsetName("text");
95 insetnames[ERT_CODE] = InsetName("ert", _("TeX Code"));
96 insetnames[FOOT_CODE] = InsetName("foot");
97 insetnames[MARGIN_CODE] = InsetName("margin");
98 insetnames[FLOAT_CODE] = InsetName("float", _("Float"));
99 insetnames[WRAP_CODE] = InsetName("wrap");
100 insetnames[SPECIALCHAR_CODE] = InsetName("specialchar");
101 insetnames[IPA_CODE] = InsetName("ipa");
102 insetnames[IPACHAR_CODE] = InsetName("ipachar");
103 insetnames[IPADECO_CODE] = InsetName("ipadeco");
104 insetnames[TABULAR_CODE] = InsetName("tabular", _("Table"));
105 insetnames[EXTERNAL_CODE] = InsetName("external");
106 insetnames[CAPTION_CODE] = InsetName("caption");
107 insetnames[MATHMACRO_CODE] = InsetName("mathmacro");
108 insetnames[CITE_CODE] = InsetName("citation");
109 insetnames[FLOAT_LIST_CODE] = InsetName("floatlist");
110 insetnames[INDEX_PRINT_CODE] = InsetName("index_print");
111 insetnames[NOMENCL_PRINT_CODE] = InsetName("nomencl_print");
112 insetnames[ARG_CODE] = InsetName("optarg");
113 insetnames[NEWLINE_CODE] = InsetName("newline");
114 insetnames[LINE_CODE] = InsetName("line");
115 insetnames[BRANCH_CODE] = InsetName("branch", _("Branch"));
116 insetnames[BOX_CODE] = InsetName("box", _("Box"));
117 insetnames[FLEX_CODE] = InsetName("flex");
118 insetnames[SPACE_CODE] = InsetName("space", _("Horizontal Space"));
119 insetnames[VSPACE_CODE] = InsetName("vspace", _("Vertical Space"));
120 insetnames[MATH_MACROARG_CODE] = InsetName("mathmacroarg");
121 insetnames[LISTINGS_CODE] = InsetName("listings");
122 insetnames[INFO_CODE] = InsetName("info", _("Info"));
123 insetnames[COLLAPSIBLE_CODE] = InsetName("collapsible");
124 insetnames[NEWPAGE_CODE] = InsetName("newpage");
125 insetnames[SCRIPT_CODE] = InsetName("script");
126 insetnames[CELL_CODE] = InsetName("tablecell");
127 insetnames[MATH_AMSARRAY_CODE] = InsetName("mathamsarray");
128 insetnames[MATH_ARRAY_CODE] = InsetName("matharray");
129 insetnames[MATH_BIG_CODE] = InsetName("mathbig");
130 insetnames[MATH_BOLDSYMBOL_CODE] = InsetName("mathboldsymbol");
131 insetnames[MATH_BOX_CODE] = InsetName("mathbox");
132 insetnames[MATH_BRACE_CODE] = InsetName("mathbrace");
133 insetnames[MATH_CANCEL_CODE] = InsetName("mathcancel");
134 insetnames[MATH_CANCELTO_CODE] = InsetName("mathcancelto");
135 insetnames[MATH_CASES_CODE] = InsetName("mathcases");
136 insetnames[MATH_CHAR_CODE] = InsetName("mathchar");
137 insetnames[MATH_COLOR_CODE] = InsetName("mathcolor");
138 insetnames[MATH_COMMENT_CODE] = InsetName("mathcomment");
139 insetnames[MATH_DECORATION_CODE] = InsetName("mathdecoration");
140 insetnames[MATH_DELIM_CODE] = InsetName("mathdelim");
141 insetnames[MATH_DIFF_CODE] = InsetName("mathdiff");
142 insetnames[MATH_DOTS_CODE] = InsetName("mathdots");
143 insetnames[MATH_ENSUREMATH_CODE] = InsetName("mathensuremath");
144 insetnames[MATH_ENV_CODE] = InsetName("mathenv");
145 insetnames[MATH_EXFUNC_CODE] = InsetName("mathexfunc");
146 insetnames[MATH_EXINT_CODE] = InsetName("mathexint");
147 insetnames[MATH_FONT_CODE] = InsetName("mathfont");
148 insetnames[MATH_FONTOLD_CODE] = InsetName("mathfontold");
149 insetnames[MATH_FRAC_CODE] = InsetName("mathfrac");
150 insetnames[MATH_GRID_CODE] = InsetName("mathgrid");
151 insetnames[MATH_CODE] = InsetName("math");
152 insetnames[MATH_HULL_CODE] = InsetName("mathhull");
153 insetnames[MATH_KERN_CODE] = InsetName("mathkern");
154 insetnames[MATH_LEFTEQN_CODE] = InsetName("mathlefteqn");
155 insetnames[MATH_LIM_CODE] = InsetName("mathlim");
156 insetnames[MATH_MATRIX_CODE] = InsetName("mathmatrix");
157 insetnames[MATH_MBOX_CODE] = InsetName("mathmbox");
158 insetnames[MATH_NEST_CODE] = InsetName("mathnest");
159 insetnames[MATH_NUMBER_CODE] = InsetName("mathnumber");
160 insetnames[MATH_OVERSET_CODE] = InsetName("mathoverset");
161 insetnames[MATH_PAR_CODE] = InsetName("mathpar");
162 insetnames[MATH_PHANTOM_CODE] = InsetName("mathphantom");
163 insetnames[MATH_REF_CODE] = InsetName("mathref");
164 insetnames[MATH_ROOT_CODE] = InsetName("mathroot");
165 insetnames[MATH_SCRIPT_CODE] = InsetName("mathscript");
166 insetnames[MATH_SIZE_CODE] = InsetName("mathsize");
167 insetnames[MATH_SPACE_CODE] = InsetName("mathspace", _("Horizontal Math Space"));
168 insetnames[MATH_SPECIALCHAR_CODE] = InsetName("mathspecialchar");
169 insetnames[MATH_SPLIT_CODE] = InsetName("mathsplit");
170 insetnames[MATH_SQRT_CODE] = InsetName("mathsqrt");
171 insetnames[MATH_STACKREL_CODE] = InsetName("mathstackrel");
172 insetnames[MATH_STRING_CODE] = InsetName("mathstring");
173 insetnames[MATH_SUBSTACK_CODE] = InsetName("mathsubstack");
174 insetnames[MATH_SYMBOL_CODE] = InsetName("mathsymbol");
175 insetnames[MATH_TABULAR_CODE] = InsetName("mathtabular");
176 insetnames[MATH_UNDERSET_CODE] = InsetName("mathunderset");
177 insetnames[MATH_UNKNOWN_CODE] = InsetName("mathunknown");
178 insetnames[MATH_XARROW_CODE] = InsetName("mathxarrow");
179 insetnames[MATH_XYMATRIX_CODE] = InsetName("mathxymatrix");
180 insetnames[MATH_DIAGRAM_CODE] = InsetName("mathdiagram");
181 insetnames[MATH_MACRO_CODE] = InsetName("mathmacro");
187 void Inset::setBuffer(Buffer & buffer)
193 void Inset::resetBuffer()
199 Buffer & Inset::buffer()
203 string const iname = insetName(lyxCode());
204 LYXERR0("Inset: " << this << " LyX Code: " << lyxCode()
205 << " name: " << iname);
206 s << "LyX Code: " << lyxCode() << " name: " << from_ascii(iname);
208 throw ExceptionMessage(BufferException,
209 from_ascii("Inset::buffer_ member not initialized!"), s.str());
215 Buffer const & Inset::buffer() const
217 return const_cast<Inset *>(this)->buffer();
221 bool Inset::isBufferLoaded() const
223 return buffer_ && theBufferList().isLoaded(buffer_);
227 bool Inset::isBufferValid() const
230 && (isBufferLoaded() || buffer_->isInternal() || buffer_->isClone());
234 docstring Inset::layoutName() const
236 return from_ascii("unknown");
240 InsetLayout const & Inset::getLayout() const
243 return DocumentClass::plainInsetLayout();
244 return buffer().params().documentClass().insetLayout(layoutName());
248 bool Inset::isPassThru() const
250 return getLayout().isPassThru();
254 bool Inset::isFreeSpacing() const
256 return getLayout().isFreeSpacing();
260 bool Inset::allowEmpty() const
262 return getLayout().isKeepEmpty();
266 bool Inset::forceLTR(OutputParams const &) const
268 return getLayout().forceLTR();
272 bool Inset::isInToc() const
274 return getLayout().isInToc();
278 FontInfo Inset::getFont() const
280 return getLayout().font();
284 FontInfo Inset::getLabelfont() const
286 return getLayout().labelfont();
290 docstring Inset::toolTip(BufferView const &, int, int) const
296 void Inset::forOutliner(docstring &, size_t const, bool const) const
301 string Inset::contextMenu(BufferView const &, int, int) const
303 return contextMenuName();
307 string Inset::contextMenuName() const
313 Dimension const Inset::dimension(BufferView const & bv) const
315 return bv.coordCache().getInsets().dim(this);
319 InsetCode insetCode(string const & name)
322 for (int i = 1; i != int(INSET_CODE_SIZE); ++i) {
323 if (insetnames[i].name == name)
330 string insetName(InsetCode c)
333 return insetnames[c].name;
337 docstring insetDisplayName(InsetCode c)
340 return insetnames[c].display_name;
344 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
346 if (buffer_ == nullptr) {
347 lyxerr << "Unassigned buffer_ member in Inset::dispatch()" << std::endl;
348 lyxerr << "LyX Code: " << lyxCode() << " name: "
349 << insetName(lyxCode()) << std::endl;
350 } else if (cur.buffer() != buffer_)
351 lyxerr << "cur.buffer() != buffer_ in Inset::dispatch()" << std::endl;
352 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
354 doDispatch(cur, cmd);
358 bool Inset::showInsetDialog(BufferView * bv) const
360 InsetCode const code = lyxCode();
368 case MATH_SPACE_CODE:
372 bv->showDialog(insetName(code));
381 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
383 switch (cmd.action()) {
384 case LFUN_MOUSE_RELEASE:
385 // if the derived inset did not explicitly handle mouse_release,
386 // we assume we request the settings dialog
387 if (!cur.selection() && cmd.button() == mouse_button::button1
388 && clickable(cur.bv(), cmd.x(), cmd.y()) && hasSettings()) {
389 FuncRequest tmpcmd(LFUN_INSET_SETTINGS);
390 dispatch(cur, tmpcmd);
394 case LFUN_INSET_SETTINGS:
395 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
396 showInsetDialog(&cur.bv());
403 cur.noScreenUpdate();
410 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
411 FuncStatus & status) const
413 // LFUN_INSET_APPLY is sent from the dialogs when the data should
414 // be applied. This is either changed to LFUN_INSET_MODIFY (if the
415 // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
416 // not belong to us, i. e. the dialog was open, and the user moved
417 // the cursor in our inset) in lyx::getStatus().
418 // Dialogs::checkStatus() ensures that the dialog is deactivated if
419 // LFUN_INSET_APPLY is disabled.
421 switch (cmd.action()) {
422 case LFUN_INSET_MODIFY:
423 // Allow modification of our data.
424 // This needs to be handled in the doDispatch method of our
425 // instantiatable children.
426 status.setEnabled(true);
429 case LFUN_INSET_INSERT:
430 // Don't allow insertion of new insets.
431 // Every inset that wants to allow new insets from open
432 // dialogs needs to override this.
433 status.setEnabled(false);
436 case LFUN_INSET_SETTINGS:
437 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
438 bool const enable = hasSettings();
439 status.setEnabled(enable);
445 case LFUN_IN_MATHMACROTEMPLATE:
446 // By default we're not in a InsetMathMacroTemplate inset
447 status.setEnabled(false);
451 // By default we're not in an IPA inset
452 status.setEnabled(false);
462 void Inset::edit(Cursor &, bool, EntryDirection)
464 LYXERR(Debug::INSETS, "edit left/right");
468 Inset * Inset::editXY(Cursor &, int x, int y)
470 LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
475 idx_type Inset::index(row_type row, col_type col) const
478 LYXERR0("illegal row: " << row);
480 LYXERR0("illegal col: " << col);
485 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
487 return from <= idx && idx <= to;
491 bool Inset::idxUpDown(Cursor &, bool) const
497 void Inset::docbook(XMLStream & xs, OutputParams const &) const
499 xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
503 docstring Inset::xhtml(XMLStream & xs, OutputParams const &) const
505 xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
510 bool Inset::directWrite() const
516 bool Inset::editable() const
522 bool Inset::hasSettings() const
529 bool Inset::autoDelete() const
535 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
536 bool, int & x, int & y) const
538 LYXERR0("Inset::cursorPos called directly");
544 void Inset::metricsMarkers(Dimension & dim, int framesize) const
546 dim.wid += 2 * framesize;
547 dim.des += framesize;
551 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
553 dim.wid += 2 * framesize;
554 dim.asc += framesize;
555 dim.des += framesize;
559 void Inset::drawBackground(PainterInfo & pi, int x, int y) const
561 if (pi.full_repaint && backgroundColor(pi) == Color_none)
563 Dimension const dim = dimension(*pi.base.bv);
564 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, dim.asc + dim.des,
565 pi.backgroundColor(this));
569 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
571 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
572 Color_mathframe : Color_mathcorners;
574 Dimension const dim = dimension(*pi.base.bv);
576 int const t = x + dim.width() - 1;
577 int const d = y + dim.descent();
578 pi.pain.line(x, d - 3, x, d, pen_color);
579 pi.pain.line(t, d - 3, t, d, pen_color);
580 pi.pain.line(x, d, x + 3, d, pen_color);
581 pi.pain.line(t - 3, d, t, d, pen_color);
585 bool Inset::editing(BufferView const * bv) const
587 if (bv->mouseSelecting())
588 // Avoid flicker when selecting with the mouse: when so, do not make
589 // decisions about metrics based on the mouse location.
590 return bv->cursor().realAnchor().isInside(this);
592 return bv->cursor().isInside(this);
596 int Inset::xo(BufferView const & bv) const
598 return bv.coordCache().getInsets().x(this);
602 int Inset::yo(BufferView const & bv) const
604 return bv.coordCache().getInsets().y(this);
608 bool Inset::covers(BufferView const & bv, int x, int y) const
610 return bv.coordCache().getInsets().covers(this, x, y);
614 bool Inset::undefined() const
616 docstring const & n = getLayout().name();
617 return n.empty() || n == DocumentClass::plainInsetLayout().name();
621 CtObject Inset::getCtObject(OutputParams const &) const
623 return CtObject::Normal;
627 void Inset::dump() const
633 ColorCode Inset::backgroundColor(PainterInfo const & /*pi*/) const
639 ColorCode Inset::labelColor() const
641 return Color_foreground;
645 Buffer const * Inset::updateFrontend() const
647 //FIXME (Abdel 03/12/10): see bugs #6814 and #6949
648 // If the Buffer is null and we end up here this is most probably because we
649 // are in the CutAndPaste stack. See InsetGraphics, RenderGraphics and
653 return theApp() ? theApp()->updateInset(this) : nullptr;
657 bool Inset::resetFontEdit() const
659 return getLayout().resetsFont() || !inheritFont();
663 docstring Inset::completionPrefix(Cursor const &) const