4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * \author Lars Gullik Bjønnes
10 * \author Matthias Ettrich
12 * Full author contact details are available in file CREDITS.
18 #include "ColorCode.h"
19 #include "InsetCode.h"
20 #include "InsetLayout.h"
21 #include "LayoutEnums.h"
22 #include "OutputEnums.h"
23 #include "OutputParams.h"
25 #include "support/strfwd.h"
26 #include "support/types.h"
27 #include "support/FileNameList.h"
47 class InsetCollapsible;
62 class ParConstIterator;
70 namespace graphics { class PreviewLoader; }
73 /// returns the InsetCode corresponding to the \c name.
74 /// Eg, insetCode("branch") == BRANCH_CODE
75 InsetCode insetCode(std::string const & name);
76 /// returns the Inset name corresponding to the \c InsetCode.
77 /// Eg, insetName(BRANCH_CODE) == "branch"
78 std::string insetName(InsetCode);
79 /// returns the Inset name corresponding to the \c InsetCode.
80 /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
81 docstring insetDisplayName(InsetCode);
83 static int const TOC_ENTRY_LENGTH = 120;
85 /// Common base class to all insets
87 // Do not add _any_ (non-static) data members as this would inflate
88 // everything storing large quantities of insets. Mathed e.g. would
95 ENTRY_DIRECTION_IGNORE,
96 ENTRY_DIRECTION_RIGHT,
100 typedef ptrdiff_t difference_type;
101 /// short of anything else reasonable
102 typedef size_t size_type;
103 /// type for cell indices
104 typedef size_t idx_type;
105 /// type for cursor positions
106 typedef ptrdiff_t pos_type;
107 /// type for row numbers
108 typedef size_t row_type;
109 /// type for column numbers
110 typedef size_t col_type;
112 /// virtual base class destructor
115 /// change associated Buffer
116 virtual void setBuffer(Buffer & buffer);
117 /// reset associated Buffer to null value
118 virtual void resetBuffer();
119 /// retrieve associated Buffer
121 Buffer const & buffer() const;
122 /// Returns true if buffer_ actually points to a Buffer that has
123 /// been loaded into LyX and is still open. Note that this will
124 /// always return false for cloned Buffers. If you want to allow
125 /// for the case of cloned Buffers, use isBufferValid().
126 bool isBufferLoaded() const;
127 /// Returns true if this is a loaded buffer or a cloned buffer.
128 bool isBufferValid() const;
130 /// initialize view for this inset.
132 * This is typically used after this inset is created interactively.
133 * Intented purpose is to sanitize internal state with regard to current
136 virtual void initView() {}
137 /// \return true if this inset is labeled.
138 virtual bool isLabeled() const { return false; }
140 /// identification as math inset
141 virtual InsetMath * asInsetMath() { return 0; }
142 /// identification as math inset
143 virtual InsetMath const * asInsetMath() const { return 0; }
144 /// true for 'math' math inset, but not for e.g. mbox
145 virtual bool inMathed() const { return false; }
146 /// is this inset based on the InsetText class?
147 virtual InsetText * asInsetText() { return 0; }
148 /// is this inset based on the InsetText class?
149 virtual InsetText const * asInsetText() const { return 0; }
150 /// is this inset based on the InsetCollapsible class?
151 virtual InsetCollapsible * asInsetCollapsible() { return 0; }
152 /// is this inset based on the InsetCollapsible class?
153 virtual InsetCollapsible const * asInsetCollapsible() const { return 0; }
154 /// is this inset based on the InsetTabular class?
155 virtual InsetTabular * asInsetTabular() { return 0; }
156 /// is this inset based on the InsetTabular class?
157 virtual InsetTabular const * asInsetTabular() const { return 0; }
158 /// is this inset based on the InsetCommand class?
159 virtual InsetCommand * asInsetCommand() { return 0; }
160 /// is this inset based on the InsetCommand class?
161 virtual InsetCommand const * asInsetCommand() const { return 0; }
162 /// is this inset based on the InsetArgument class?
163 virtual InsetArgument const * asInsetArgument() const { return nullptr; }
164 /// is this inset based on the InsetGraphics class?
165 virtual InsetGraphics * asInsetGraphics() { return 0; }
166 /// is this inset based on the InsetGraphics class?
167 virtual InsetGraphics const * asInsetGraphics() const { return 0; }
169 /// the real dispatcher
170 void dispatch(Cursor & cur, FuncRequest & cmd);
172 * \returns true if this function made a definitive decision on
173 * whether the inset wants to handle the request \p cmd or not.
174 * The result of this decision is put into \p status.
176 * Every request that is enabled in this method needs to be handled
177 * in doDispatch(). Normally we have a 1:1 relationship between the
178 * requests handled in getStatus() and doDispatch(), but there are
180 * - A request that is disabled in getStatus() does not need to
181 * appear in doDispatch(). It is guaranteed that doDispatch()
182 * is never called with this request.
183 * - A few requests are en- or disabled in Inset::getStatus().
184 * These need to be handled in the doDispatch() methods of the
185 * derived insets, since Inset::doDispatch() has not enough
186 * information to handle them.
187 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
188 * are dispatched directly
190 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
191 FuncStatus & status) const;
194 virtual void edit(Cursor & cur, bool front,
195 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
196 /// sets cursor recursively descending into nested editable insets
198 \return the inset pointer if x,y is covering that inset
199 \param x,y are absolute screen coordinates.
201 /// Note: this method must preserve the selection status. See:
202 /// https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg199001.html
203 virtual Inset * editXY(Cursor & cur, int x, int y);
205 /// compute the size of the object returned in dim
206 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
207 /// draw inset and update (xo, yo)-cache
208 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
209 /// draw inset selection if necessary
210 virtual void drawSelection(PainterInfo &, int, int) const {}
211 /// draw inset background if the inset has an own background and a
212 /// selection is drawn by drawSelection.
213 virtual void drawBackground(PainterInfo &, int, int) const;
215 virtual bool editing(BufferView const * bv) const;
217 virtual bool showInsetDialog(BufferView *) const;
219 /// draw two angular markers
220 virtual void drawMarkers(PainterInfo & pi, int x, int y) const;
221 /// add space for markers
222 void metricsMarkers(Dimension & dim, int framesize = 1) const;
223 /// add space for markers
224 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
225 /// draw inset decoration if necessary.
226 /// This can use \c drawMarkers() for example.
227 virtual void drawDecoration(PainterInfo &, int, int) const {}
229 /// last metrics computed for the inset
230 Dimension const dimension(BufferView const &) const;
231 /// last drawn position for 'important' insets
232 int xo(BufferView const & bv) const;
233 /// last drawn position for 'important' insets
234 int yo(BufferView const & bv) const;
235 /// do we cover screen position x/y?
236 bool covers(BufferView const & bv, int x, int y) const;
237 /// get the screen positions of the cursor (see note in Cursor.cpp)
238 virtual void cursorPos(BufferView const & bv,
239 CursorSlice const & sl, bool boundary, int & x, int & y) const;
241 /// Allow multiple blanks
242 virtual bool isFreeSpacing() const;
243 /// Don't eliminate empty paragraphs
244 virtual bool allowEmpty() const;
245 /// Force inset into LTR environment if surroundings are RTL
246 virtual bool forceLTR(OutputParams const &) const;
247 /// whether to include this inset in the strings generated for the TOC
248 virtual bool isInToc() const;
250 /// Where should we go when we press the up or down cursor key?
251 virtual bool idxUpDown(Cursor & cur, bool up) const;
252 /// Move one cell backwards
253 virtual bool idxBackward(Cursor &) const { return false; }
254 /// Move one cell forward
255 virtual bool idxForward(Cursor &) const { return false; }
257 /// Move to the next cell
258 virtual bool idxNext(Cursor &) const { return false; }
259 /// Move to the previous cell
260 virtual bool idxPrev(Cursor &) const { return false; }
262 /// Target pos when we enter the inset while moving forward
263 virtual bool idxFirst(Cursor &) const { return false; }
264 /// Target pos when we enter the inset while moving backwards
265 virtual bool idxLast(Cursor &) const { return false; }
267 /// Delete a cell and move cursor
268 virtual bool idxDelete(idx_type &) { return false; }
269 /// pulls cell after pressing erase
270 virtual void idxGlue(idx_type) {}
271 /// returns list of cell indices that are "between" from and to for
272 /// selection purposes
273 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
275 /// to which column belongs a cell with a given index?
276 virtual col_type col(idx_type) const { return 0; }
277 /// to which row belongs a cell with a given index?
278 virtual row_type row(idx_type) const { return 0; }
279 /// cell index corresponding to row and column;
280 virtual idx_type index(row_type row, col_type col) const;
281 /// number of embedded cells
282 virtual size_t nargs() const { return 0; }
283 /// number of rows in gridlike structures
284 virtual size_t nrows() const { return 0; }
285 /// number of columns in gridlike structures
286 virtual size_t ncols() const { return 0; }
287 /// Is called when the cursor leaves this inset.
288 /// Returns true if cursor is now invalid, e.g. if former
289 /// insets in higher cursor slices of \c old do not exist
291 /// \c old is the old cursor, the last slice points to this.
292 /// \c cur is the new cursor. Use the update flags to cause a redraw.
293 virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
295 /// Is called when the cursor enters this inset.
296 /// Returns true if cursor is now invalid, e.g. if former
297 /// insets in higher cursor slices of \c old do not exist
299 /// \c cur is the new cursor, some slice points to this. Use the update
300 /// flags to cause a redraw.
301 virtual bool notifyCursorEnters(Cursor & /*cur*/)
303 /// is called when the mouse enters or leaves this inset
304 /// return true if this inset needs a repaint
305 virtual bool setMouseHover(BufferView const *, bool) const
307 /// return true if this inset is hovered (under mouse)
308 /// This is by now only used by mathed to draw corners
309 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
310 /// Other insets do not have to redefine this function to
311 /// return the correct status of mouseHovered.
312 virtual bool mouseHovered(BufferView const *) const { return false; }
314 /// request "external features"
315 virtual void validate(LaTeXFeatures &) const {}
317 /// Validate LFUN_INSET_MODIFY argument.
318 virtual bool validateModifyArgument(docstring const &) const { return true; }
320 /// describe content if cursor inside
321 virtual void infoize(odocstream &) const {}
322 /// describe content if cursor behind
323 virtual void infoize2(odocstream &) const {}
325 enum { PLAINTEXT_NEWLINE = 10000 };
327 /// plain text output in ucs4 encoding
328 /// return the number of characters; in case of multiple lines of
329 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
330 virtual int plaintext(odocstringstream &, OutputParams const &,
331 size_t max_length = INT_MAX) const = 0;
333 virtual int docbook(odocstream & os, OutputParams const &) const;
335 /// the inset is expected to write XHTML to the XHTMLStream
336 /// \return any "deferred" material that should be written outside the
337 /// normal stream, and which will in fact be written after the current
338 /// paragraph closes. this is appropriate e.g. for floats.
339 virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
341 /// Writes a string representation of the inset to the odocstream.
342 /// This one should be called when you want the whole contents of
344 virtual void toString(odocstream &) const {}
345 /// Appends a potentially abbreviated version of the inset to
346 /// \param str. Intended for use by the TOC.
347 virtual void forOutliner(docstring & str,
348 size_t const maxlen = TOC_ENTRY_LENGTH,
349 bool const shorten = true) const;
351 /// Can a cursor be put in there ?
352 /// Forced to false for insets that have hidden contents, like
353 /// InsetMathCommand and InsetInfo.
354 virtual bool isActive() const { return nargs() > 0; }
355 /// can the contents of the inset be edited on screen ?
356 // equivalent to isActive except for closed InsetCollapsible
357 virtual bool editable() const;
358 /// has the Inset settings that can be modified in a dialog ?
359 virtual bool hasSettings() const;
360 /// can we go further down on mouse click?
361 /// true for InsetCaption, InsetCollapsibles (not ButtonOnly), InsetTabular
362 virtual bool descendable(BufferView const &) const { return false; }
363 /// can we click at the specified position ?
364 virtual bool clickable(BufferView const &, int, int) const { return false; }
365 /// Move one cell backwards
366 virtual bool allowsCaptionVariation(std::string const &) const { return false; }
367 // true for insets that have a table structure (InsetMathGrid, InsetTabular)
368 virtual bool isTable() const { return false; }
370 /// does this contain text that can be change track marked in DVI?
371 virtual bool canTrackChanges() const { return false; }
372 /// Will this inset paint its own change tracking status (in the parent
373 /// paragraph) or will it let RowPainter handle it?
374 virtual bool canPaintChange(BufferView const &) const { return false; }
375 /// return true if the inset should be removed automatically
376 virtual bool autoDelete() const;
378 /// Returns true if the inset supports completions.
379 virtual bool completionSupported(Cursor const &) const { return false; }
380 /// Returns true if the inset supports inline completions at the
381 /// cursor position. In this case the completion might be stored
382 /// in the BufferView's inlineCompletion property.
383 virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
385 /// Return true if the inline completion should be automatic.
386 virtual bool automaticInlineCompletion() const { return true; }
387 /// Return true if the popup completion should be automatic.
388 virtual bool automaticPopupCompletion() const { return true; }
389 /// Return true if the cursor should indicate a completion.
390 virtual bool showCompletionCursor() const { return true; }
391 /// Returns completion suggestions at cursor position. Return an
392 /// null pointer if no completion is a available or possible.
393 /// The caller is responsible to free the returned object!
394 virtual CompletionList const * createCompletionList(Cursor const &) const
396 /// Returns the completion prefix to filter the suggestions for completion.
397 /// This is only called if completionList returned a non-null list.
398 virtual docstring completionPrefix(Cursor const &) const;
399 /// Do a completion at the cursor position. Return true on success.
400 /// The completion does not contain the prefix. If finished is true, the
401 /// completion is final. If finished is false, completion might only be
402 /// a partial completion.
403 virtual bool insertCompletion(Cursor & /*cur*/,
404 docstring const & /*completion*/, bool /*finished*/)
406 /// Get the completion inset position and size
407 virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
408 Dimension & /*dim*/) const {}
410 /// returns true if the inset can hold an inset of given type
411 virtual bool insetAllowed(InsetCode) const { return false; }
412 /// should this inset use the empty layout by default rather than
413 /// the standard layout? (default: only if that is forced.)
414 virtual bool usePlainLayout() const { return forcePlainLayout(); }
415 /// if this inset has paragraphs should they be forced to use the
417 virtual bool forcePlainLayout(idx_type = 0) const { return false; }
418 /// if this inset has paragraphs should the user be allowed to
419 /// customize alignment, etc?
420 virtual bool allowParagraphCustomization(idx_type = 0) const
422 /// Is the width forced to some value?
423 virtual bool hasFixedWidth() const { return false; }
424 /// if this inset has paragraphs should they be forced to use a
425 /// local font language switch?
426 virtual bool forceLocalFontSwitch() const { return false; }
427 /// if this inset has paragraphs should they be forced to use a
428 /// font language switch that switches paragraph directions
429 /// (relevant with polyglossia only)?
430 virtual bool forceParDirectionSwitch() const { return false; }
431 /// Does the inset force a specific encoding?
432 virtual Encoding const * forcedEncoding(Encoding const *, Encoding const *) const
436 /// Is the content of this inset part of the output document?
437 virtual bool producesOutput() const { return true; }
438 /// Is the content of this inset part of the immediate (visible) text sequence?
439 virtual bool isPartOfTextSequence() const { return producesOutput(); }
441 /// \return Tool tip for this inset.
442 /// This default implementation returns an empty string. This can be
443 /// either plain text or Qt html, and formatToolTip will be called
444 /// on it before display in both cases.
445 virtual docstring toolTip(BufferView const & bv, int x, int y) const;
447 /// \return Context menu identifier. This function determines
448 /// whose Inset's menu should be shown for the given position.
449 virtual std::string contextMenu(BufferView const & bv, int x, int y) const;
451 /// \return Context menu identifier for this inset.
452 /// This default implementation returns an empty string.
453 virtual std::string contextMenuName() const;
456 virtual docstring layoutName() const;
458 virtual InsetLayout const & getLayout() const;
460 virtual bool isPassThru() const { return getLayout().isPassThru(); }
461 /// Is this inset's layout defined in the document's textclass?
462 bool undefined() const;
463 /// should this inset be handled like a normal character?
464 /// (a character can be a letter or punctuation)
465 virtual bool isChar() const { return false; }
466 /// is this equivalent to a letter?
467 /// (a letter is a character that is considered part of a word)
468 virtual bool isLetter() const { return false; }
469 /// is this equivalent to a space (which is BTW different from
470 /// a line separator)?
471 virtual bool isSpace() const { return false; }
472 /// does this inset try to use all available space (like \\hfill does)?
473 virtual bool isHfill() const { return false; }
475 virtual OutputParams::CtObject CtObject(OutputParams const &) const { return OutputParams::CT_NORMAL; }
484 /// should we have a non-filled line before this inset?
485 virtual DisplayType display() const { return Inline; }
486 /// indentation before this inset (only needed for displayed hull insets with fleqn option)
487 virtual int indent(BufferView const &) const { return 0; }
489 virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
490 /// should we break lines after this inset?
491 virtual bool isLineSeparator() const { return false; }
492 /// should paragraph indendation be omitted in any case?
493 virtual bool neverIndent() const { return false; }
494 /// dumps content to lyxerr
495 virtual void dump() const;
496 /// write inset in .lyx format
497 virtual void write(std::ostream &) const {}
498 /// read inset in .lyx format
499 virtual void read(Lexer &) {}
500 /** Export the inset to LaTeX.
501 * Don't use a temporary stringstream if the final output is
502 * supposed to go to a file.
503 * \sa Buffer::writeLaTeXSource for the reason.
505 virtual void latex(otexstream &, OutputParams const &) const {}
506 /// returns true to override begin and end inset in file
507 virtual bool directWrite() const;
509 virtual bool allowSpellCheck() const { return false; }
511 /// if this insets owns text cells (e.g. InsetText) return cell num
512 virtual Text * getText(int /*num*/) const { return 0; }
514 /** Adds a LaTeX snippet to the Preview Loader for transformation
515 * into a bitmap image. Does not start the laoding process.
517 * Most insets have no interest in this capability, so the method
520 virtual void addPreview(DocIterator const &,
521 graphics::PreviewLoader &) const {}
523 /** Classifies the unicode characters appearing in a math inset
524 * depending on whether they are to be translated as latex
525 * math/text commands or used as math symbols without translation.
527 * Only math insets have interest in this classification, so the
528 * method defaults to empty.
530 virtual void initUnicodeMath() const {}
532 /// Add an entry to the TocList
533 /// Pass a DocIterator that points at the paragraph containing
536 /// \param output_active : is the inset active or is it in an inactive
537 /// branch or a note?
539 /// \param utype : is the toc being generated for use by the output
542 /// \param tocbackend : where to add the toc information.
543 virtual void addToToc(DocIterator const & /* di */,
544 bool /* output_active */,
545 UpdateType /* utype*/,
546 TocBackend & /* tocbackend */) const {}
547 /// Collect BibTeX information
548 virtual void collectBibKeys(InsetIterator const &, support::FileNameList &) const {}
549 /// Update the counters of this inset and of its contents.
550 /// The boolean indicates whether we are preparing for output, e.g.,
552 virtual void updateBuffer(ParIterator const &, UpdateType) {}
554 /// Updates the inset's dialog
555 virtual Buffer const * updateFrontend() const;
558 /// returns LyX code associated with the inset. Used for TOC, ...)
559 virtual InsetCode lyxCode() const { return NO_CODE; }
562 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
563 /// return text or mathmode if that is possible to determine
564 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
565 /// returns whether changing mode during latex export is forbidden
566 virtual bool lockedMode() const { return false; }
567 /// returns whether only ascii chars are allowed during latex export
568 virtual bool asciiOnly() const { return false; }
569 /// returns whether this inset is allowed in other insets of given mode
570 virtual bool allowedIn(mode_type) const { return true; }
572 * The font is inherited from the parent for LaTeX export if this
573 * method returns true. No open font changes are closed in front of
574 * the inset for LaTeX export, and the font is inherited for all other
575 * exports as well as on screen.
576 * If this method returns false all open font changes are closed in
577 * front of the inset for LaTeX export. The default font is used
578 * inside the inset for all exports and on screen.
580 virtual bool inheritFont() const { return true; }
582 * If this method returns true all explicitly set font attributes
583 * are reset during editing operations.
584 * For copy/paste operations the language is never changed, since
585 * the language of a given text never changes if the text is
586 * formatted differently, while other font attribues like size may
587 * need to change if the text is copied from one environment to
589 * If this method returns false no font attribute is reset.
590 * The default implementation returns true if the resetFont layout
591 * tag is set and otherwise the negation of inheritFont(),
592 * since inherited inset font attributes do not need to be changed,
593 * and non-inherited ones need to be set explicitly.
595 virtual bool resetFontEdit() const;
597 /// set the change for the entire inset
598 virtual void setChange(Change const &) {}
599 /// accept the changes within the inset
600 virtual void acceptChanges() {}
601 /// reject the changes within the inset
602 virtual void rejectChanges() {}
605 virtual bool needsCProtection(bool const, bool const) const { return false; }
608 virtual ColorCode backgroundColor(PainterInfo const &) const;
610 virtual ColorCode labelColor() const;
612 enum { TEXT_TO_INSET_OFFSET = 4 };
614 /// Determine the action of backspace and delete: do we select instead of
615 /// deleting if not already selected?
616 virtual bool confirmDeletion() const { return false; }
620 Inset(Buffer * buf) : buffer_(buf) {}
621 Inset(Inset const &) : buffer_(0) {}
623 /// replicate ourselves
624 friend class InsetList;
625 friend class MathAtom;
626 virtual Inset * clone() const = 0;
628 /** The real dispatcher.
629 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
630 * assumes the common case of 'LFUN handled, need update'.
631 * This has to be overriden by calling Cursor::undispatched() or
632 * Cursor::noScreenUpdate() if appropriate.
633 * If you need to call the dispatch method of some inset directly
634 * you may have to explicitly request an update at that place. Don't
635 * do it in doDispatch(), since that causes nested updates when
636 * called from Cursor::dispatch(), and these can lead to crashes.
639 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);