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"
21 #include "OutputEnums.h"
23 #include "support/strfwd.h"
24 #include "support/types.h"
40 class InsetCollapsable;
54 class ParConstIterator;
60 namespace graphics { class PreviewLoader; }
63 /// returns the InsetCode corresponding to the \c name.
64 /// Eg, insetCode("branch") == BRANCH_CODE
65 InsetCode insetCode(std::string const & name);
66 /// returns the Inset name corresponding to the \c InsetCode.
67 /// Eg, insetName(BRANCH_CODE) == "branch"
68 std::string insetName(InsetCode);
69 /// returns the Inset name corresponding to the \c InsetCode.
70 /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
71 docstring insetDisplayName(InsetCode);
73 /// Common base class to all insets
75 // Do not add _any_ (non-static) data members as this would inflate
76 // everything storing large quantities of insets. Mathed e.g. would
83 ENTRY_DIRECTION_IGNORE,
84 ENTRY_DIRECTION_RIGHT,
88 typedef ptrdiff_t difference_type;
89 /// short of anything else reasonable
90 typedef size_t size_type;
91 /// type for cell indices
92 typedef size_t idx_type;
93 /// type for cursor positions
94 typedef ptrdiff_t pos_type;
95 /// type for row numbers
96 typedef size_t row_type;
97 /// type for column numbers
98 typedef size_t col_type;
100 /// virtual base class destructor
103 /// change associated Buffer
104 virtual void setBuffer(Buffer & buffer);
105 /// remove the buffer reference
106 void resetBuffer() { setBuffer( *static_cast<Buffer *>(0)); }
107 /// retrieve associated Buffer
108 virtual Buffer & buffer();
109 virtual Buffer const & buffer() const;
110 /// Returns true if buffer_ actually points to a Buffer that has
111 /// been loaded into LyX and is still open. Note that this will
112 /// always return false for cloned Buffers. If you want to allow
113 /// for the case of cloned Buffers, use isBufferValid().
114 bool isBufferLoaded() const;
115 /// Returns true if this is a loaded buffer or a cloned buffer.
116 bool isBufferValid() const;
118 /// initialize view for this inset.
120 * This is typically used after this inset is created interactively.
121 * Intented purpose is to sanitize internal state with regard to current
122 * Buffer. The default implementation calls buffer().updateBuffer() if
123 * the inset is labeled.
127 virtual void initView();
128 /// \return true if this inset is labeled.
129 virtual bool isLabeled() const { return false; }
131 /// identification as math inset
132 virtual InsetMath * asInsetMath() { return 0; }
133 /// identification as math inset
134 virtual InsetMath const * asInsetMath() const { return 0; }
135 /// true for 'math' math inset, but not for e.g. mbox
136 virtual bool inMathed() const { return false; }
137 /// is this inset based on the InsetText class?
138 virtual InsetText * asInsetText() { return 0; }
139 /// is this inset based on the InsetText class?
140 virtual InsetText const * asInsetText() const { return 0; }
141 /// is this inset based on the InsetCollapsable class?
142 virtual InsetCollapsable * asInsetCollapsable() { return 0; }
143 /// is this inset based on the InsetCollapsable class?
144 virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
145 /// is this inset based on the InsetTabular class?
146 virtual InsetTabular * asInsetTabular() { return 0; }
147 /// is this inset based on the InsetTabular class?
148 virtual InsetTabular const * asInsetTabular() const { return 0; }
149 /// is this inset based on the InsetCommand class?
150 virtual InsetCommand * asInsetCommand() { return 0; }
151 /// is this inset based on the InsetCommand class?
152 virtual InsetCommand const * asInsetCommand() const { return 0; }
154 /// the real dispatcher
155 void dispatch(Cursor & cur, FuncRequest & cmd);
157 * \returns true if this function made a definitive decision on
158 * whether the inset wants to handle the request \p cmd or not.
159 * The result of this decision is put into \p status.
161 * Every request that is enabled in this method needs to be handled
162 * in doDispatch(). Normally we have a 1:1 relationship between the
163 * requests handled in getStatus() and doDispatch(), but there are
165 * - A request that is disabled in getStatus() does not need to
166 * appear in doDispatch(). It is guaranteed that doDispatch()
167 * is never called with this request.
168 * - A few requests are en- or disabled in Inset::getStatus().
169 * These need to be handled in the doDispatch() methods of the
170 * derived insets, since Inset::doDispatch() has not enough
171 * information to handle them.
172 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
173 * are dispatched directly
175 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
176 FuncStatus & status) const;
179 virtual void edit(Cursor & cur, bool front,
180 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
182 virtual Inset * editXY(Cursor & cur, int x, int y);
184 /// compute the size of the object returned in dim
185 /// \retval true if metrics changed.
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;
231 /// Where should we go when we press the up or down cursor key?
232 virtual bool idxUpDown(Cursor & cur, bool up) const;
233 /// Move one cell backwards
234 virtual bool idxBackward(Cursor &) const { return false; }
235 /// Move one cell forward
236 virtual bool idxForward(Cursor &) const { return false; }
238 /// Move to the next cell
239 virtual bool idxNext(Cursor &) const { return false; }
240 /// Move to the previous cell
241 virtual bool idxPrev(Cursor &) const { return false; }
243 /// Target pos when we enter the inset while moving forward
244 virtual bool idxFirst(Cursor &) const { return false; }
245 /// Target pos when we enter the inset while moving backwards
246 virtual bool idxLast(Cursor &) const { return false; }
248 /// Delete a cell and move cursor
249 virtual bool idxDelete(idx_type &) { return false; }
250 /// pulls cell after pressing erase
251 virtual void idxGlue(idx_type) {}
252 /// returns list of cell indices that are "between" from and to for
253 /// selection purposes
254 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
256 /// to which column belongs a cell with a given index?
257 virtual col_type col(idx_type) const { return 0; }
258 /// to which row belongs a cell with a given index?
259 virtual row_type row(idx_type) const { return 0; }
260 /// cell index corresponding to row and column;
261 virtual idx_type index(row_type row, col_type col) const;
262 /// any additional x-offset when drawing a cell?
263 virtual int cellXOffset(idx_type) const { return 0; }
264 /// any additional y-offset when drawing a cell?
265 virtual int cellYOffset(idx_type) const { return 0; }
266 /// number of embedded cells
267 virtual size_t nargs() const { return 0; }
268 /// number of rows in gridlike structures
269 virtual size_t nrows() const { return 0; }
270 /// number of columns in gridlike structures
271 virtual size_t ncols() const { return 0; }
272 /// Is called when the cursor leaves this inset.
273 /// Returns true if cursor is now invalid, e.g. if former
274 /// insets in higher cursor slices of \c old do not exist
276 /// \c old is the old cursor, the last slice points to this.
277 /// \c cur is the new cursor. Use the update flags to cause a redraw.
278 virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
280 /// Is called when the cursor enters this inset.
281 /// Returns true if cursor is now invalid, e.g. if former
282 /// insets in higher cursor slices of \c old do not exist
284 /// \c cur is the new cursor, some slice points to this. Use the update flags to cause a redraw.
285 virtual bool notifyCursorEnters(Cursor & /*cur*/)
287 /// is called when the mouse enters or leaves this inset
288 /// return true if this inset needs a repaint
289 virtual bool setMouseHover(BufferView const *, bool) { return false; }
290 /// return true if this inset is hovered (under mouse)
291 /// This is by now only used by mathed to draw corners
292 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
293 /// Other insets do not have to redefine this function to
294 /// return the correct status of mouseHovered.
295 virtual bool mouseHovered(BufferView const *) const { return false; }
297 /// request "external features"
298 virtual void validate(LaTeXFeatures &) const {}
300 /// Validate LFUN_INSET_MODIFY argument.
301 virtual bool validateModifyArgument(docstring const &) const { return true; }
303 /// describe content if cursor inside
304 virtual void infoize(odocstream &) const {}
305 /// describe content if cursor behind
306 virtual void infoize2(odocstream &) const {}
308 enum { PLAINTEXT_NEWLINE = 10000 };
310 /// plain text output in ucs4 encoding
311 /// return the number of characters; in case of multiple lines of
312 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
313 virtual int plaintext(odocstream &, OutputParams const &) const = 0;
315 virtual int docbook(odocstream & os, OutputParams const &) const;
317 /// the inset is expected to write XHTML to the XHTMLStream
318 /// \return any "deferred" material that should be written outside the
319 /// normal stream, and which will in fact be written after the current
320 /// paragraph closes. this is appropriate e.g. for floats.
321 virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
322 /// the string that is passed to the TOC
323 virtual void tocString(odocstream &) const {}
325 /// can the contents of the inset be edited on screen ?
326 // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
327 virtual bool editable() const;
328 /// has the Inset settings that can be modified in a dialog ?
329 virtual bool hasSettings() const;
330 /// can we go further down on mouse click?
331 // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
332 virtual bool descendable(BufferView const &) const { return false; }
333 /// is this an inset that can be moved into?
334 /// FIXME: merge with editable()
335 // true for InsetTabular & InsetText
336 virtual bool isActive() const { return nargs() > 0; }
338 /// does this contain text that can be change track marked in DVI?
339 virtual bool canTrackChanges() const { return false; }
340 /// return true if the inset should be removed automatically
341 virtual bool autoDelete() const;
343 /// Returns true if the inset supports completions.
344 virtual bool completionSupported(Cursor const &) const { return false; }
345 /// Returns true if the inset supports inline completions at the
346 /// cursor position. In this case the completion might be stored
347 /// in the BufferView's inlineCompletion property.
348 virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
350 /// Return true if the inline completion should be automatic.
351 virtual bool automaticInlineCompletion() const { return true; }
352 /// Return true if the popup completion should be automatic.
353 virtual bool automaticPopupCompletion() const { return true; }
354 /// Return true if the cursor should indicate a completion.
355 virtual bool showCompletionCursor() const { return true; }
356 /// Returns completion suggestions at cursor position. Return an
357 /// null pointer if no completion is a available or possible.
358 /// The caller is responsible to free the returned object!
359 virtual CompletionList const * createCompletionList(Cursor const &) const
361 /// Returns the completion prefix to filter the suggestions for completion.
362 /// This is only called if completionList returned a non-null list.
363 virtual docstring completionPrefix(Cursor const &) const;
364 /// Do a completion at the cursor position. Return true on success.
365 /// The completion does not contain the prefix. If finished is true, the
366 /// completion is final. If finished is false, completion might only be
367 /// a partial completion.
368 virtual bool insertCompletion(Cursor & /*cur*/,
369 docstring const & /*completion*/, bool /*finished*/)
371 /// Get the completion inset position and size
372 virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
373 Dimension & /*dim*/) const {}
375 /// returns true if the inset can hold an inset of given type
376 virtual bool insetAllowed(InsetCode) const { return false; }
377 /// should this inset use the empty layout by default rather than
378 /// the standard layout? (default: only if that is forced.)
379 virtual bool usePlainLayout() const { return forcePlainLayout(); }
380 /// if this inset has paragraphs should they be forced to use the
382 virtual bool forcePlainLayout(idx_type = 0) const { return false; }
383 /// if this inset has paragraphs should the user be allowed to
384 /// customize alignment, etc?
385 virtual bool allowParagraphCustomization(idx_type = 0) const { return true; }
386 /// Is the width forced to some value?
387 virtual bool hasFixedWidth() const { return false; }
389 /// Is the content of this inset part of the output document?
390 virtual bool producesOutput() const { return true; }
392 /// \return Tool tip for this inset.
393 /// This default implementation returns an empty string.
394 virtual docstring toolTip(BufferView const & bv, int x, int y) const;
396 /// \return Context menu identifier for this inset.
397 /// This default implementation returns an empty string.
398 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
400 // FIXME This should really disappear in favor of
401 // docstring name() const { return from_ascii(insetName(lyxCode()))); }
402 // There's no reason to be using different names in different places.
403 // But to do this we would need to change the file format, since the names
404 // used there don't correspond to what is used here.
406 virtual docstring name() const;
408 virtual InsetLayout const & getLayout() const;
409 /// Is this inset's layout defined in the document's textclass?
410 bool undefined() const;
411 /// used to toggle insets
412 /// is the inset open?
413 /// should this inset be handled like a normal charater
414 virtual bool isChar() const { return false; }
415 /// is this equivalent to a letter?
416 virtual bool isLetter() const { return false; }
417 /// is this equivalent to a space (which is BTW different from
418 /// a line separator)?
419 virtual bool isSpace() const { return false; }
420 /// is this an expandible space (rubber length)?
421 virtual bool isStretchableSpace() const { return false; }
430 /// should we have a non-filled line before this inset?
431 virtual DisplayType display() const { return Inline; }
433 virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
434 /// should we break lines after this inset?
435 virtual bool isLineSeparator() const { return false; }
436 /// should paragraph indendation be ommitted in any case?
437 virtual bool neverIndent() const { return false; }
438 /// dumps content to lyxerr
439 virtual void dump() const;
440 /// write inset in .lyx format
441 virtual void write(std::ostream &) const {}
442 /// read inset in .lyx format
443 virtual void read(Lexer &) {}
444 /** Export the inset to LaTeX.
445 * Don't use a temporary stringstream if the final output is
446 * supposed to go to a file.
447 * \sa Buffer::writeLaTeXSource for the reason.
448 * \return the number of rows (\n's) of generated LaTeX code.
450 virtual int latex(odocstream &, OutputParams const &) const { return 0; }
451 /// returns true to override begin and end inset in file
452 virtual bool directWrite() const;
454 virtual bool allowSpellCheck() const { return false; }
456 /// if this insets owns text cells (e.g. InsetText) return cell num
457 virtual Text * getText(int /*num*/) const { return 0; }
459 /** Adds a LaTeX snippet to the Preview Loader for transformation
460 * into a bitmap image. Does not start the laoding process.
462 * Most insets have no interest in this capability, so the method
465 virtual void addPreview(DocIterator const &,
466 graphics::PreviewLoader &) const {}
468 /** Classifies the unicode characters appearing in a math inset
469 * depending on whether they are to be translated as latex
470 * math/text commands or used as math symbols without translation.
472 * Only math insets have interest in this classification, so the
473 * method defaults to empty.
475 virtual void initUnicodeMath() const {}
477 /// Add an entry to the TocList
478 /// pit is the ParConstIterator of the paragraph containing the inset
479 virtual void addToToc(DocIterator const &) {}
480 /// Fill keys with BibTeX information
481 virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
482 /// Update the counters of this inset and of its contents.
483 /// The boolean indicates whether we are preparing for output, e.g.,
485 virtual void updateBuffer(ParIterator const &, UpdateType) {}
487 /// Updates the inset's dialog
488 virtual Buffer const * updateFrontend() const;
491 /// returns LyX code associated with the inset. Used for TOC, ...)
492 virtual InsetCode lyxCode() const { return NO_CODE; }
494 /// -1: text mode, 1: math mode, 0 undecided
495 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
496 /// return text or mathmode if that is possible to determine
497 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
498 /// returns whether changing mode during latex export is forbidden
499 virtual bool lockedMode() const { return false; }
500 /// returns whether only ascii chars are allowed during latex export
501 virtual bool asciiOnly() const { return false; }
502 /// returns whether this inset is allowed in other insets of given mode
503 virtual bool allowedIn(mode_type) const { return true; }
505 * Is this inset allowed within a font change?
507 * FIXME: noFontChange means currently that the font change is closed
508 * in LaTeX before the inset, and that the contents of the inset
509 * will be in default font. This should be changed so that the inset
510 * changes the font again.
512 virtual bool noFontChange() const { return false; }
514 /// set the change for the entire inset
515 virtual void setChange(Change const &) {}
516 /// accept the changes within the inset
517 virtual void acceptChanges() {}
518 /// reject the changes within the inset
519 virtual void rejectChanges() {}
522 virtual Dimension const dimension(BufferView const &) const;
524 int scroll() const { return 0; }
526 virtual ColorCode backgroundColor(PainterInfo const &) const;
528 virtual ColorCode labelColor() const;
530 enum { TEXT_TO_INSET_OFFSET = 4 };
534 Inset(Buffer * buf) : buffer_(buf) {}
535 Inset(Inset const &) : buffer_(0) {}
537 /// replicate ourselves
538 friend class InsetList;
539 friend class MathAtom;
540 virtual Inset * clone() const = 0;
542 /** The real dispatcher.
543 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
544 * assumes the common case of 'LFUN handled, need update'.
545 * This has to be overriden by calling Cursor::undispatched() or
546 * Cursor::noUpdate() if appropriate.
547 * If you need to call the dispatch method of some inset directly
548 * you may have to explicitly request an update at that place. Don't
549 * do it in doDispatch(), since that causes nested updates when
550 * called from Cursor::dispatch(), and these can lead to crashes.
553 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);