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 "MetricsInfo.h"
31 #include "output_xhtml.h"
33 #include "TextClass.h"
35 #include "frontends/Application.h"
36 #include "frontends/Painter.h"
38 #include "support/debug.h"
39 #include "support/docstream.h"
40 #include "support/ExceptionMessage.h"
41 #include "support/gettext.h"
42 #include "support/lassert.h"
47 using namespace lyx::support;
53 InsetName(string const & n = string(), docstring const & dn = docstring())
54 : name(n), display_name(dn) {}
56 docstring display_name;
60 static InsetName insetnames[INSET_CODE_SIZE];
63 // This list should be kept in sync with the list of dialogs in
64 // src/frontends/qt4/GuiView.cpp, I.e., if a dialog goes with an
65 // inset, the dialog should have the same name as the inset.
66 // Changes should be also recorded in LFUN_DIALOG_SHOW doxygen
67 // docs in LyXAction.cpp.
68 static void build_translator()
70 static bool passed = false;
73 insetnames[TOC_CODE] = InsetName("toc");
74 insetnames[QUOTE_CODE] = InsetName("quote");
75 insetnames[REF_CODE] = InsetName("ref");
76 insetnames[HYPERLINK_CODE] = InsetName("href");
77 insetnames[SEPARATOR_CODE] = InsetName("separator");
78 insetnames[ENDING_CODE] = InsetName("ending");
79 insetnames[LABEL_CODE] = InsetName("label");
80 insetnames[NOTE_CODE] = InsetName("note");
81 insetnames[PHANTOM_CODE] = InsetName("phantom");
82 insetnames[ACCENT_CODE] = InsetName("accent");
83 insetnames[MATH_CODE] = InsetName("math");
84 insetnames[INDEX_CODE] = InsetName("index");
85 insetnames[NOMENCL_CODE] = InsetName("nomenclature");
86 insetnames[INCLUDE_CODE] = InsetName("include");
87 insetnames[GRAPHICS_CODE] = InsetName("graphics");
88 insetnames[BIBITEM_CODE] = InsetName("bibitem", _("Bibliography Entry"));
89 insetnames[BIBTEX_CODE] = InsetName("bibtex");
90 insetnames[TEXT_CODE] = InsetName("text");
91 insetnames[ERT_CODE] = InsetName("ert", _("TeX Code"));
92 insetnames[FOOT_CODE] = InsetName("foot");
93 insetnames[MARGIN_CODE] = InsetName("margin");
94 insetnames[FLOAT_CODE] = InsetName("float", _("Float"));
95 insetnames[WRAP_CODE] = InsetName("wrap");
96 insetnames[SPECIALCHAR_CODE] = InsetName("specialchar");
97 insetnames[IPA_CODE] = InsetName("ipa");
98 insetnames[IPACHAR_CODE] = InsetName("ipachar");
99 insetnames[IPADECO_CODE] = InsetName("ipadeco");
100 insetnames[TABULAR_CODE] = InsetName("tabular", _("Table"));
101 insetnames[EXTERNAL_CODE] = InsetName("external");
102 insetnames[CAPTION_CODE] = InsetName("caption");
103 insetnames[MATHMACRO_CODE] = InsetName("mathmacro");
104 insetnames[CITE_CODE] = InsetName("citation");
105 insetnames[FLOAT_LIST_CODE] = InsetName("floatlist");
106 insetnames[INDEX_PRINT_CODE] = InsetName("index_print");
107 insetnames[NOMENCL_PRINT_CODE] = InsetName("nomencl_print");
108 insetnames[ARG_CODE] = InsetName("optarg");
109 insetnames[NEWLINE_CODE] = InsetName("newline");
110 insetnames[LINE_CODE] = InsetName("line");
111 insetnames[BRANCH_CODE] = InsetName("branch", _("Branch"));
112 insetnames[BOX_CODE] = InsetName("box", _("Box"));
113 insetnames[FLEX_CODE] = InsetName("flex");
114 insetnames[SPACE_CODE] = InsetName("space", _("Horizontal Space"));
115 insetnames[VSPACE_CODE] = InsetName("vspace", _("Vertical Space"));
116 insetnames[MATH_MACROARG_CODE] = InsetName("mathmacroarg");
117 insetnames[LISTINGS_CODE] = InsetName("listings");
118 insetnames[INFO_CODE] = InsetName("info", _("Info"));
119 insetnames[COLLAPSABLE_CODE] = InsetName("collapsable");
120 insetnames[NEWPAGE_CODE] = InsetName("newpage");
121 insetnames[SCRIPT_CODE] = InsetName("script");
122 insetnames[CELL_CODE] = InsetName("tablecell");
123 insetnames[MATH_AMSARRAY_CODE] = InsetName("mathamsarray");
124 insetnames[MATH_ARRAY_CODE] = InsetName("matharray");
125 insetnames[MATH_BIG_CODE] = InsetName("mathbig");
126 insetnames[MATH_BOLDSYMBOL_CODE] = InsetName("mathboldsymbol");
127 insetnames[MATH_BOX_CODE] = InsetName("mathbox");
128 insetnames[MATH_BRACE_CODE] = InsetName("mathbrace");
129 insetnames[MATH_CANCEL_CODE] = InsetName("mathcancel");
130 insetnames[MATH_CANCELTO_CODE] = InsetName("mathcancelto");
131 insetnames[MATH_CASES_CODE] = InsetName("mathcases");
132 insetnames[MATH_CHAR_CODE] = InsetName("mathchar");
133 insetnames[MATH_COLOR_CODE] = InsetName("mathcolor");
134 insetnames[MATH_COMMENT_CODE] = InsetName("mathcomment");
135 insetnames[MATH_DECORATION_CODE] = InsetName("mathdecoration");
136 insetnames[MATH_DELIM_CODE] = InsetName("mathdelim");
137 insetnames[MATH_DIFF_CODE] = InsetName("mathdiff");
138 insetnames[MATH_DOTS_CODE] = InsetName("mathdots");
139 insetnames[MATH_ENSUREMATH_CODE] = InsetName("mathensuremath");
140 insetnames[MATH_ENV_CODE] = InsetName("mathenv");
141 insetnames[MATH_EXFUNC_CODE] = InsetName("mathexfunc");
142 insetnames[MATH_EXINT_CODE] = InsetName("mathexint");
143 insetnames[MATH_FONT_CODE] = InsetName("mathfont");
144 insetnames[MATH_FONTOLD_CODE] = InsetName("mathfontold");
145 insetnames[MATH_FRAC_CODE] = InsetName("mathfrac");
146 insetnames[MATH_GRID_CODE] = InsetName("mathgrid");
147 insetnames[MATH_CODE] = InsetName("math");
148 insetnames[MATH_HULL_CODE] = InsetName("mathhull");
149 insetnames[MATH_KERN_CODE] = InsetName("mathkern");
150 insetnames[MATH_LEFTEQN_CODE] = InsetName("mathlefteqn");
151 insetnames[MATH_LIM_CODE] = InsetName("mathlim");
152 insetnames[MATH_MATRIX_CODE] = InsetName("mathmatrix");
153 insetnames[MATH_MBOX_CODE] = InsetName("mathmbox");
154 insetnames[MATH_NEST_CODE] = InsetName("mathnest");
155 insetnames[MATH_NUMBER_CODE] = InsetName("mathnumber");
156 insetnames[MATH_OVERSET_CODE] = InsetName("mathoverset");
157 insetnames[MATH_PAR_CODE] = InsetName("mathpar");
158 insetnames[MATH_PHANTOM_CODE] = InsetName("mathphantom");
159 insetnames[MATH_REF_CODE] = InsetName("mathref");
160 insetnames[MATH_ROOT_CODE] = InsetName("mathroot");
161 insetnames[MATH_SCRIPT_CODE] = InsetName("mathscript");
162 insetnames[MATH_SIZE_CODE] = InsetName("mathsize");
163 insetnames[MATH_SPACE_CODE] = InsetName("mathspace", _("Horizontal Math Space"));
164 insetnames[MATH_SPECIALCHAR_CODE] = InsetName("mathspecialchar");
165 insetnames[MATH_SPLIT_CODE] = InsetName("mathsplit");
166 insetnames[MATH_SQRT_CODE] = InsetName("mathsqrt");
167 insetnames[MATH_STACKREL_CODE] = InsetName("mathstackrel");
168 insetnames[MATH_STRING_CODE] = InsetName("mathstring");
169 insetnames[MATH_SUBSTACK_CODE] = InsetName("mathsubstack");
170 insetnames[MATH_SYMBOL_CODE] = InsetName("mathsymbol");
171 insetnames[MATH_TABULAR_CODE] = InsetName("mathtabular");
172 insetnames[MATH_UNDERSET_CODE] = InsetName("mathunderset");
173 insetnames[MATH_UNKNOWN_CODE] = InsetName("mathunknown");
174 insetnames[MATH_XARROW_CODE] = InsetName("mathxarrow");
175 insetnames[MATH_XYMATRIX_CODE] = InsetName("mathxymatrix");
176 insetnames[MATH_DIAGRAM_CODE] = InsetName("mathdiagram");
177 insetnames[MATH_MACRO_CODE] = InsetName("mathmacro");
183 void Inset::setBuffer(Buffer & buffer)
189 void Inset::resetBuffer()
195 Buffer & Inset::buffer()
199 string const iname = insetName(lyxCode());
200 LYXERR0("Inset: " << this << " LyX Code: " << lyxCode()
201 << " name: " << iname);
202 s << "LyX Code: " << lyxCode() << " name: " << from_ascii(iname);
204 throw ExceptionMessage(BufferException,
205 from_ascii("Inset::buffer_ member not initialized!"), s.str());
211 Buffer const & Inset::buffer() const
213 return const_cast<Inset *>(this)->buffer();
217 bool Inset::isBufferLoaded() const
219 return buffer_ && theBufferList().isLoaded(buffer_);
223 bool Inset::isBufferValid() const
226 && (isBufferLoaded() || buffer_->isClone());
230 docstring Inset::layoutName() const
232 return from_ascii("unknown");
236 bool Inset::isFreeSpacing() const
238 return getLayout().isFreeSpacing();
242 bool Inset::allowEmpty() const
244 return getLayout().isKeepEmpty();
248 bool Inset::forceLTR() const
250 return getLayout().forceLTR();
254 bool Inset::isInToc() const
256 return getLayout().isInToc();
260 docstring Inset::toolTip(BufferView const &, int, int) const
266 void Inset::forOutliner(docstring &, size_t const, bool const) const
271 string Inset::contextMenu(BufferView const &, int, int) const
273 return contextMenuName();
277 string Inset::contextMenuName() const
283 Dimension const Inset::dimension(BufferView const & bv) const
285 return bv.coordCache().getInsets().dim(this);
289 InsetCode insetCode(string const & name)
292 for (int i = 1; i != int(INSET_CODE_SIZE); ++i) {
293 if (insetnames[i].name == name)
300 string insetName(InsetCode c)
303 return insetnames[c].name;
307 docstring insetDisplayName(InsetCode c)
310 return insetnames[c].display_name;
314 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
317 lyxerr << "Unassigned buffer_ member in Inset::dispatch()" << std::endl;
318 lyxerr << "LyX Code: " << lyxCode() << " name: "
319 << insetName(lyxCode()) << std::endl;
320 } else if (cur.buffer() != buffer_)
321 lyxerr << "cur.buffer() != buffer_ in Inset::dispatch()" << std::endl;
322 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
324 doDispatch(cur, cmd);
328 bool Inset::showInsetDialog(BufferView * bv) const
330 InsetCode const code = lyxCode();
338 case MATH_SPACE_CODE:
342 bv->showDialog(insetName(code));
351 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
353 switch (cmd.action()) {
354 case LFUN_MOUSE_RELEASE:
355 // if the derived inset did not explicitly handle mouse_release,
356 // we assume we request the settings dialog
357 if (!cur.selection() && cmd.button() == mouse_button::button1
358 && clickable(cur.bv(), cmd.x(), cmd.y()) && hasSettings()) {
359 FuncRequest tmpcmd(LFUN_INSET_SETTINGS);
360 dispatch(cur, tmpcmd);
364 case LFUN_INSET_SETTINGS:
365 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
366 showInsetDialog(&cur.bv());
373 cur.noScreenUpdate();
380 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
381 FuncStatus & flag) const
383 // LFUN_INSET_APPLY is sent from the dialogs when the data should
384 // be applied. This is either changed to LFUN_INSET_MODIFY (if the
385 // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
386 // not belong to us, i. e. the dialog was open, and the user moved
387 // the cursor in our inset) in lyx::getStatus().
388 // Dialogs::checkStatus() ensures that the dialog is deactivated if
389 // LFUN_INSET_APPLY is disabled.
391 switch (cmd.action()) {
392 case LFUN_INSET_MODIFY:
393 // Allow modification of our data.
394 // This needs to be handled in the doDispatch method of our
395 // instantiatable children.
396 flag.setEnabled(true);
399 case LFUN_INSET_INSERT:
400 // Don't allow insertion of new insets.
401 // Every inset that wants to allow new insets from open
402 // dialogs needs to override this.
403 flag.setEnabled(false);
406 case LFUN_INSET_SETTINGS:
407 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
408 bool const enable = hasSettings();
409 flag.setEnabled(enable);
415 case LFUN_IN_MATHMACROTEMPLATE:
416 // By default we're not in a MathMacroTemplate inset
417 flag.setEnabled(false);
421 // By default we're not in an IPA inset
422 flag.setEnabled(false);
432 void Inset::edit(Cursor &, bool, EntryDirection)
434 LYXERR(Debug::INSETS, "edit left/right");
438 Inset * Inset::editXY(Cursor &, int x, int y)
440 LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
445 Inset::idx_type Inset::index(row_type row, col_type col) const
448 LYXERR0("illegal row: " << row);
450 LYXERR0("illegal col: " << col);
455 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
457 return from <= idx && idx <= to;
461 bool Inset::idxUpDown(Cursor &, bool) const
467 int Inset::docbook(odocstream &, OutputParams const &) const
473 docstring Inset::xhtml(XHTMLStream & xs, OutputParams const &) const
475 xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
480 bool Inset::directWrite() const
486 bool Inset::editable() const
492 bool Inset::hasSettings() const
499 bool Inset::autoDelete() const
505 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
506 bool, int & x, int & y) const
508 LYXERR0("Inset::cursorPos called directly");
514 void Inset::metricsMarkers(Dimension & dim, int framesize) const
516 dim.wid += 2 * framesize;
517 dim.des += framesize;
521 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
523 dim.wid += 2 * framesize;
524 dim.asc += framesize;
525 dim.des += framesize;
529 void Inset::drawBackground(PainterInfo & pi, int x, int y) const
531 if (pi.full_repaint && backgroundColor(pi) == Color_none)
533 Dimension const dim = dimension(*pi.base.bv);
534 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, dim.asc + dim.des,
535 pi.backgroundColor(this));
539 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
541 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
542 Color_mathframe : Color_mathcorners;
544 Dimension const dim = dimension(*pi.base.bv);
546 int const t = x + dim.width() - 1;
547 int const d = y + dim.descent();
548 pi.pain.line(x, d - 3, x, d, pen_color);
549 pi.pain.line(t, d - 3, t, d, pen_color);
550 pi.pain.line(x, d, x + 3, d, pen_color);
551 pi.pain.line(t - 3, d, t, d, pen_color);
555 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
557 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
558 Color_mathframe : Color_mathcorners;
560 drawMarkers(pi, x, y);
561 Dimension const dim = dimension(*pi.base.bv);
562 int const t = x + dim.width() - 1;
563 int const a = y - dim.ascent();
564 pi.pain.line(x, a + 3, x, a, pen_color);
565 pi.pain.line(t, a + 3, t, a, pen_color);
566 pi.pain.line(x, a, x + 3, a, pen_color);
567 pi.pain.line(t - 3, a, t, a, pen_color);
571 bool Inset::editing(BufferView const * bv) const
573 return bv->cursor().isInside(this);
577 int Inset::xo(BufferView const & bv) const
579 return bv.coordCache().getInsets().x(this);
583 int Inset::yo(BufferView const & bv) const
585 return bv.coordCache().getInsets().y(this);
589 bool Inset::covers(BufferView const & bv, int x, int y) const
591 return bv.coordCache().getInsets().covers(this, x, y);
595 InsetLayout const & Inset::getLayout() const
598 return DocumentClass::plainInsetLayout();
599 return buffer().params().documentClass().insetLayout(layoutName());
603 bool Inset::undefined() const
605 docstring const & n = getLayout().name();
606 return n.empty() || n == DocumentClass::plainInsetLayout().name();
610 void Inset::dump() const
616 ColorCode Inset::backgroundColor(PainterInfo const & /*pi*/) const
622 ColorCode Inset::labelColor() const
624 return Color_foreground;
628 Buffer const * Inset::updateFrontend() const
630 //FIXME (Abdel 03/12/10): see bugs #6814 and #6949
631 // If the Buffer is null and we end up here this is most probably because we
632 // are in the CutAndPaste stack. See InsetGraphics, RenderGraphics and
636 return theApp() ? theApp()->updateInset(this) : 0;
640 bool Inset::resetFontEdit() const
642 return getLayout().resetsFont() || !inheritFont();
646 docstring Inset::completionPrefix(Cursor const &) const