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"
24 #include "support/strfwd.h"
25 #include "support/types.h"
41 class InsetCollapsable;
55 class ParConstIterator;
62 namespace graphics { class PreviewLoader; }
65 /// returns the InsetCode corresponding to the \c name.
66 /// Eg, insetCode("branch") == BRANCH_CODE
67 InsetCode insetCode(std::string const & name);
68 /// returns the Inset name corresponding to the \c InsetCode.
69 /// Eg, insetName(BRANCH_CODE) == "branch"
70 std::string insetName(InsetCode);
71 /// returns the Inset name corresponding to the \c InsetCode.
72 /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
73 docstring insetDisplayName(InsetCode);
75 static int const TOC_ENTRY_LENGTH = 40;
77 /// Common base class to all insets
79 // Do not add _any_ (non-static) data members as this would inflate
80 // everything storing large quantities of insets. Mathed e.g. would
87 ENTRY_DIRECTION_IGNORE,
88 ENTRY_DIRECTION_RIGHT,
92 typedef ptrdiff_t difference_type;
93 /// short of anything else reasonable
94 typedef size_t size_type;
95 /// type for cell indices
96 typedef size_t idx_type;
97 /// type for cursor positions
98 typedef ptrdiff_t pos_type;
99 /// type for row numbers
100 typedef size_t row_type;
101 /// type for column numbers
102 typedef size_t col_type;
104 /// virtual base class destructor
107 /// change associated Buffer
108 virtual void setBuffer(Buffer & buffer);
109 /// remove the buffer reference
110 void resetBuffer() { setBuffer( *static_cast<Buffer *>(0)); }
111 /// retrieve associated Buffer
112 virtual Buffer & buffer();
113 virtual Buffer const & buffer() const;
114 /// Returns true if buffer_ actually points to a Buffer that has
115 /// been loaded into LyX and is still open. Note that this will
116 /// always return false for cloned Buffers. If you want to allow
117 /// for the case of cloned Buffers, use isBufferValid().
118 bool isBufferLoaded() const;
119 /// Returns true if this is a loaded buffer or a cloned buffer.
120 bool isBufferValid() const;
122 /// initialize view for this inset.
124 * This is typically used after this inset is created interactively.
125 * Intented purpose is to sanitize internal state with regard to current
128 virtual void initView() {};
129 /// \return true if this inset is labeled.
130 virtual bool isLabeled() const { return false; }
132 /// identification as math inset
133 virtual InsetMath * asInsetMath() { return 0; }
134 /// identification as math inset
135 virtual InsetMath const * asInsetMath() const { return 0; }
136 /// true for 'math' math inset, but not for e.g. mbox
137 virtual bool inMathed() const { return false; }
138 /// is this inset based on the InsetText class?
139 virtual InsetText * asInsetText() { return 0; }
140 /// is this inset based on the InsetText class?
141 virtual InsetText const * asInsetText() const { return 0; }
142 /// is this inset based on the InsetCollapsable class?
143 virtual InsetCollapsable * asInsetCollapsable() { return 0; }
144 /// is this inset based on the InsetCollapsable class?
145 virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
146 /// is this inset based on the InsetTabular class?
147 virtual InsetTabular * asInsetTabular() { return 0; }
148 /// is this inset based on the InsetTabular class?
149 virtual InsetTabular const * asInsetTabular() const { return 0; }
150 /// is this inset based on the InsetCommand class?
151 virtual InsetCommand * asInsetCommand() { return 0; }
152 /// is this inset based on the InsetCommand class?
153 virtual InsetCommand const * asInsetCommand() const { return 0; }
155 /// the real dispatcher
156 void dispatch(Cursor & cur, FuncRequest & cmd);
158 * \returns true if this function made a definitive decision on
159 * whether the inset wants to handle the request \p cmd or not.
160 * The result of this decision is put into \p status.
162 * Every request that is enabled in this method needs to be handled
163 * in doDispatch(). Normally we have a 1:1 relationship between the
164 * requests handled in getStatus() and doDispatch(), but there are
166 * - A request that is disabled in getStatus() does not need to
167 * appear in doDispatch(). It is guaranteed that doDispatch()
168 * is never called with this request.
169 * - A few requests are en- or disabled in Inset::getStatus().
170 * These need to be handled in the doDispatch() methods of the
171 * derived insets, since Inset::doDispatch() has not enough
172 * information to handle them.
173 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
174 * are dispatched directly
176 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
177 FuncStatus & status) const;
180 virtual void edit(Cursor & cur, bool front,
181 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
183 virtual Inset * editXY(Cursor & cur, int x, int y);
185 /// compute the size of the object returned in dim
186 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
187 /// draw inset and update (xo, yo)-cache
188 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
189 /// draw inset selection if necessary
190 virtual void drawSelection(PainterInfo &, int, int) const {}
191 /// draw inset background if the inset has an own background and a
192 /// selection is drawn by drawSelection.
193 virtual void drawBackground(PainterInfo &, int, int) const {}
195 virtual bool editing(BufferView const * bv) const;
197 virtual bool showInsetDialog(BufferView *) const;
199 /// draw inset decoration if necessary.
200 /// This can use \c drawMarkers() for example.
201 virtual void drawDecoration(PainterInfo &, int, int) const {}
202 /// draw four angular markers
203 void drawMarkers(PainterInfo & pi, int x, int y) const;
204 /// draw two angular markers
205 void drawMarkers2(PainterInfo & pi, int x, int y) const;
206 /// add space for markers
207 void metricsMarkers(Dimension & dim, int framesize = 1) const;
208 /// add space for markers
209 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
210 /// last drawn position for 'important' insets
211 int xo(BufferView const & bv) const;
212 /// last drawn position for 'important' insets
213 int yo(BufferView const & bv) const;
214 /// set x/y drawing position cache if available
215 virtual void setPosCache(PainterInfo const &, int, int) const;
217 void setDimCache(MetricsInfo const &, Dimension const &) const;
218 /// do we cover screen position x/y?
219 virtual bool covers(BufferView const & bv, int x, int y) const;
220 /// get the screen positions of the cursor (see note in Cursor.cpp)
221 virtual void cursorPos(BufferView const & bv,
222 CursorSlice const & sl, bool boundary, int & x, int & y) const;
224 /// Allow multiple blanks
225 virtual bool isFreeSpacing() const;
226 /// Don't eliminate empty paragraphs
227 virtual bool allowEmpty() const;
228 /// Force inset into LTR environment if surroundings are RTL
229 virtual bool forceLTR() const;
230 /// whether to include this inset in the strings generated for the TOC
231 virtual bool isInToc() const;
233 /// Where should we go when we press the up or down cursor key?
234 virtual bool idxUpDown(Cursor & cur, bool up) const;
235 /// Move one cell backwards
236 virtual bool idxBackward(Cursor &) const { return false; }
237 /// Move one cell forward
238 virtual bool idxForward(Cursor &) const { return false; }
240 /// Move to the next cell
241 virtual bool idxNext(Cursor &) const { return false; }
242 /// Move to the previous cell
243 virtual bool idxPrev(Cursor &) const { return false; }
245 /// Target pos when we enter the inset while moving forward
246 virtual bool idxFirst(Cursor &) const { return false; }
247 /// Target pos when we enter the inset while moving backwards
248 virtual bool idxLast(Cursor &) const { return false; }
250 /// Delete a cell and move cursor
251 virtual bool idxDelete(idx_type &) { return false; }
252 /// pulls cell after pressing erase
253 virtual void idxGlue(idx_type) {}
254 /// returns list of cell indices that are "between" from and to for
255 /// selection purposes
256 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
258 /// to which column belongs a cell with a given index?
259 virtual col_type col(idx_type) const { return 0; }
260 /// to which row belongs a cell with a given index?
261 virtual row_type row(idx_type) const { return 0; }
262 /// cell index corresponding to row and column;
263 virtual idx_type index(row_type row, col_type col) const;
264 /// any additional x-offset when drawing a cell?
265 virtual int cellXOffset(idx_type) const { return 0; }
266 /// any additional y-offset when drawing a cell?
267 virtual int cellYOffset(idx_type) const { return 0; }
268 /// number of embedded cells
269 virtual size_t nargs() const { return 0; }
270 /// number of rows in gridlike structures
271 virtual size_t nrows() const { return 0; }
272 /// number of columns in gridlike structures
273 virtual size_t ncols() const { return 0; }
274 /// Is called when the cursor leaves this inset.
275 /// Returns true if cursor is now invalid, e.g. if former
276 /// insets in higher cursor slices of \c old do not exist
278 /// \c old is the old cursor, the last slice points to this.
279 /// \c cur is the new cursor. Use the update flags to cause a redraw.
280 virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
282 /// Is called when the cursor enters this inset.
283 /// Returns true if cursor is now invalid, e.g. if former
284 /// insets in higher cursor slices of \c old do not exist
286 /// \c cur is the new cursor, some slice points to this. Use the update
287 /// flags to cause a redraw.
288 virtual bool notifyCursorEnters(Cursor & /*cur*/)
290 /// is called when the mouse enters or leaves this inset
291 /// return true if this inset needs a repaint
292 virtual bool setMouseHover(BufferView const *, bool) const
294 /// return true if this inset is hovered (under mouse)
295 /// This is by now only used by mathed to draw corners
296 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
297 /// Other insets do not have to redefine this function to
298 /// return the correct status of mouseHovered.
299 virtual bool mouseHovered(BufferView const *) const { return false; }
301 /// request "external features"
302 virtual void validate(LaTeXFeatures &) const {}
304 /// Validate LFUN_INSET_MODIFY argument.
305 virtual bool validateModifyArgument(docstring const &) const { return true; }
307 /// describe content if cursor inside
308 virtual void infoize(odocstream &) const {}
309 /// describe content if cursor behind
310 virtual void infoize2(odocstream &) const {}
312 enum { PLAINTEXT_NEWLINE = 10000 };
314 /// plain text output in ucs4 encoding
315 /// return the number of characters; in case of multiple lines of
316 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
317 virtual int plaintext(odocstream &, OutputParams const &) const = 0;
319 virtual int docbook(odocstream & os, OutputParams const &) const;
321 /// the inset is expected to write XHTML to the XHTMLStream
322 /// \return any "deferred" material that should be written outside the
323 /// normal stream, and which will in fact be written after the current
324 /// paragraph closes. this is appropriate e.g. for floats.
325 virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
327 /// Writes a string representation of the inset to the odocstream.
328 /// This one should be called when you want the whole contents of
330 virtual void toString(odocstream &) const {}
331 /// Appends a potentially abbreviated version of the inset to
332 /// \param str. Intended for use by the TOC.
333 virtual void forToc(docstring & str,
334 size_t maxlen = TOC_ENTRY_LENGTH) const;
336 /// can the contents of the inset be edited on screen ?
337 // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
338 virtual bool editable() const;
339 /// has the Inset settings that can be modified in a dialog ?
340 virtual bool hasSettings() const;
341 /// can we go further down on mouse click?
342 // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
343 virtual bool descendable(BufferView const &) const { return false; }
344 /// is this an inset that can be moved into?
345 /// FIXME: merge with editable()
346 // true for InsetTabular & InsetText
347 virtual bool isActive() const { return nargs() > 0; }
348 /// can we click at the specified position ?
349 virtual bool clickable(int, int) const { return false; }
351 /// does this contain text that can be change track marked in DVI?
352 virtual bool canTrackChanges() const { return false; }
353 /// return true if the inset should be removed automatically
354 virtual bool autoDelete() const;
356 /// Returns true if the inset supports completions.
357 virtual bool completionSupported(Cursor const &) const { return false; }
358 /// Returns true if the inset supports inline completions at the
359 /// cursor position. In this case the completion might be stored
360 /// in the BufferView's inlineCompletion property.
361 virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
363 /// Return true if the inline completion should be automatic.
364 virtual bool automaticInlineCompletion() const { return true; }
365 /// Return true if the popup completion should be automatic.
366 virtual bool automaticPopupCompletion() const { return true; }
367 /// Return true if the cursor should indicate a completion.
368 virtual bool showCompletionCursor() const { return true; }
369 /// Returns completion suggestions at cursor position. Return an
370 /// null pointer if no completion is a available or possible.
371 /// The caller is responsible to free the returned object!
372 virtual CompletionList const * createCompletionList(Cursor const &) const
374 /// Returns the completion prefix to filter the suggestions for completion.
375 /// This is only called if completionList returned a non-null list.
376 virtual docstring completionPrefix(Cursor const &) const;
377 /// Do a completion at the cursor position. Return true on success.
378 /// The completion does not contain the prefix. If finished is true, the
379 /// completion is final. If finished is false, completion might only be
380 /// a partial completion.
381 virtual bool insertCompletion(Cursor & /*cur*/,
382 docstring const & /*completion*/, bool /*finished*/)
384 /// Get the completion inset position and size
385 virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
386 Dimension & /*dim*/) const {}
388 /// returns true if the inset can hold an inset of given type
389 virtual bool insetAllowed(InsetCode) const { return false; }
390 /// should this inset use the empty layout by default rather than
391 /// the standard layout? (default: only if that is forced.)
392 virtual bool usePlainLayout() const { return forcePlainLayout(); }
393 /// if this inset has paragraphs should they be forced to use the
395 virtual bool forcePlainLayout(idx_type = 0) const { return false; }
396 /// if this inset has paragraphs should the user be allowed to
397 /// customize alignment, etc?
398 virtual bool allowParagraphCustomization(idx_type = 0) const
400 /// Is the width forced to some value?
401 virtual bool hasFixedWidth() const { return false; }
403 /// Is the content of this inset part of the output document?
404 virtual bool producesOutput() const { return true; }
406 /// \return Tool tip for this inset.
407 /// This default implementation returns an empty string.
408 virtual docstring toolTip(BufferView const & bv, int x, int y) const;
410 /// \return Context menu identifier. This function determines
411 /// whose Inset's menu should be shown for the given position.
412 virtual std::string contextMenu(BufferView const & bv, int x, int y) const;
414 /// \return Context menu identifier for this inset.
415 /// This default implementation returns an empty string.
416 virtual std::string contextMenuName() const;
419 virtual docstring layoutName() const;
421 virtual InsetLayout const & getLayout() const;
423 virtual bool isPassThru() const { return getLayout().isPassThru(); }
424 /// Is this inset's layout defined in the document's textclass?
425 bool undefined() const;
426 /// should this inset be handled like a normal character?
427 /// (a character can be a letter or punctuation)
428 virtual bool isChar() const { return false; }
429 /// is this equivalent to a letter?
430 /// (a letter is a character that is considered part of a word)
431 virtual bool isLetter() const { return false; }
432 /// is this equivalent to a space (which is BTW different from
433 /// a line separator)?
434 virtual bool isSpace() const { return false; }
435 /// is this an expandible space (rubber length)?
436 virtual bool isStretchableSpace() const { return false; }
445 /// should we have a non-filled line before this inset?
446 virtual DisplayType display() const { return Inline; }
448 virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
449 /// should we break lines after this inset?
450 virtual bool isLineSeparator() const { return false; }
451 /// should paragraph indendation be ommitted in any case?
452 virtual bool neverIndent() const { return false; }
453 /// dumps content to lyxerr
454 virtual void dump() const;
455 /// write inset in .lyx format
456 virtual void write(std::ostream &) const {}
457 /// read inset in .lyx format
458 virtual void read(Lexer &) {}
459 /** Export the inset to LaTeX.
460 * Don't use a temporary stringstream if the final output is
461 * supposed to go to a file.
462 * \sa Buffer::writeLaTeXSource for the reason.
464 virtual void latex(otexstream &, OutputParams const &) const {}
465 /// returns true to override begin and end inset in file
466 virtual bool directWrite() const;
468 virtual bool allowSpellCheck() const { return false; }
470 /// if this insets owns text cells (e.g. InsetText) return cell num
471 virtual Text * getText(int /*num*/) const { return 0; }
473 /** Adds a LaTeX snippet to the Preview Loader for transformation
474 * into a bitmap image. Does not start the laoding process.
476 * Most insets have no interest in this capability, so the method
479 virtual void addPreview(DocIterator const &,
480 graphics::PreviewLoader &) const {}
482 /** Classifies the unicode characters appearing in a math inset
483 * depending on whether they are to be translated as latex
484 * math/text commands or used as math symbols without translation.
486 * Only math insets have interest in this classification, so the
487 * method defaults to empty.
489 virtual void initUnicodeMath() const {}
491 /// Add an entry to the TocList
492 /// Pass a DocIterator that points at the paragraph containing
494 virtual void addToToc(DocIterator const &) const {}
495 /// Collect BibTeX information
496 virtual void collectBibKeys(InsetIterator const &) const {}
497 /// Update the counters of this inset and of its contents.
498 /// The boolean indicates whether we are preparing for output, e.g.,
500 virtual void updateBuffer(ParIterator const &, UpdateType) {}
502 /// Updates the inset's dialog
503 virtual Buffer const * updateFrontend() const;
506 /// returns LyX code associated with the inset. Used for TOC, ...)
507 virtual InsetCode lyxCode() const { return NO_CODE; }
509 /// -1: text mode, 1: math mode, 0 undecided
510 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
511 /// return text or mathmode if that is possible to determine
512 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
513 /// returns whether changing mode during latex export is forbidden
514 virtual bool lockedMode() const { return false; }
515 /// returns whether only ascii chars are allowed during latex export
516 virtual bool asciiOnly() const { return false; }
517 /// returns whether this inset is allowed in other insets of given mode
518 virtual bool allowedIn(mode_type) const { return true; }
520 * The font is inherited from the parent for LaTeX export if this
521 * method returns true. No open font changes are closed in front of
522 * the inset for LaTeX export, and the font is inherited for all other
523 * exports as well as on screen.
524 * If this method returns false all open font changes are closed in
525 * front of the inset for LaTeX export. The default font is used
526 * inside the inset for all exports and on screen.
528 virtual bool inheritFont() const { return true; }
530 * If this method returns true all explicitly set font attributes
531 * are reset during editing operations.
532 * For copy/paste the operations the language is never changed, since
533 * the language of a given text never changes if the text is
534 * formatted differently, while other font attribues like size may
535 * need to change if the text is copied from one environment to
537 * If it returns false no font attribute is reset.
538 * The default implementation returns the negation of inheritFont(),
539 * since inherited inset font attributes do not need to be changed,
540 * and non-inherited ones need to be set explicitly.
542 virtual bool resetFontEdit() const { return !inheritFont(); }
544 /// set the change for the entire inset
545 virtual void setChange(Change const &) {}
546 /// accept the changes within the inset
547 virtual void acceptChanges() {}
548 /// reject the changes within the inset
549 virtual void rejectChanges() {}
552 virtual Dimension const dimension(BufferView const &) const;
554 virtual ColorCode backgroundColor(PainterInfo const &) const;
556 virtual ColorCode labelColor() const;
558 enum { TEXT_TO_INSET_OFFSET = 4 };
562 Inset(Buffer * buf) : buffer_(buf) {}
563 Inset(Inset const &) : buffer_(0) {}
565 /// replicate ourselves
566 friend class InsetList;
567 friend class MathAtom;
568 virtual Inset * clone() const = 0;
570 /** The real dispatcher.
571 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
572 * assumes the common case of 'LFUN handled, need update'.
573 * This has to be overriden by calling Cursor::undispatched() or
574 * Cursor::noScreenUpdate() if appropriate.
575 * If you need to call the dispatch method of some inset directly
576 * you may have to explicitly request an update at that place. Don't
577 * do it in doDispatch(), since that causes nested updates when
578 * called from Cursor::dispatch(), and these can lead to crashes.
581 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);