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 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
186 /// draw inset and update (xo, yo)-cache
187 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
188 /// draw inset selection if necessary
189 virtual void drawSelection(PainterInfo &, int, int) const {}
190 /// draw inset background if the inset has an own background and a
191 /// selection is drawn by drawSelection.
192 virtual void drawBackground(PainterInfo &, int, int) const {}
194 virtual bool editing(BufferView const * bv) const;
196 virtual bool showInsetDialog(BufferView *) const;
198 /// draw inset decoration if necessary.
199 /// This can use \c drawMarkers() for example.
200 virtual void drawDecoration(PainterInfo &, int, int) const {}
201 /// draw four angular markers
202 void drawMarkers(PainterInfo & pi, int x, int y) const;
203 /// draw two angular markers
204 void drawMarkers2(PainterInfo & pi, int x, int y) const;
205 /// add space for markers
206 void metricsMarkers(Dimension & dim, int framesize = 1) const;
207 /// add space for markers
208 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
209 /// last drawn position for 'important' insets
210 int xo(BufferView const & bv) const;
211 /// last drawn position for 'important' insets
212 int yo(BufferView const & bv) const;
213 /// set x/y drawing position cache if available
214 virtual void setPosCache(PainterInfo const &, int, int) const;
216 void setDimCache(MetricsInfo const &, Dimension const &) const;
217 /// do we cover screen position x/y?
218 virtual bool covers(BufferView const & bv, int x, int y) const;
219 /// get the screen positions of the cursor (see note in Cursor.cpp)
220 virtual void cursorPos(BufferView const & bv,
221 CursorSlice const & sl, bool boundary, int & x, int & y) const;
223 /// Allow multiple blanks
224 virtual bool isFreeSpacing() const;
225 /// Don't eliminate empty paragraphs
226 virtual bool allowEmpty() const;
227 /// Force inset into LTR environment if surroundings are RTL
228 virtual bool forceLTR() const;
230 /// Where should we go when we press the up or down cursor key?
231 virtual bool idxUpDown(Cursor & cur, bool up) const;
232 /// Move one cell backwards
233 virtual bool idxBackward(Cursor &) const { return false; }
234 /// Move one cell forward
235 virtual bool idxForward(Cursor &) const { return false; }
237 /// Move to the next cell
238 virtual bool idxNext(Cursor &) const { return false; }
239 /// Move to the previous cell
240 virtual bool idxPrev(Cursor &) const { return false; }
242 /// Target pos when we enter the inset while moving forward
243 virtual bool idxFirst(Cursor &) const { return false; }
244 /// Target pos when we enter the inset while moving backwards
245 virtual bool idxLast(Cursor &) const { return false; }
247 /// Delete a cell and move cursor
248 virtual bool idxDelete(idx_type &) { return false; }
249 /// pulls cell after pressing erase
250 virtual void idxGlue(idx_type) {}
251 /// returns list of cell indices that are "between" from and to for
252 /// selection purposes
253 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
255 /// to which column belongs a cell with a given index?
256 virtual col_type col(idx_type) const { return 0; }
257 /// to which row belongs a cell with a given index?
258 virtual row_type row(idx_type) const { return 0; }
259 /// cell index corresponding to row and column;
260 virtual idx_type index(row_type row, col_type col) const;
261 /// any additional x-offset when drawing a cell?
262 virtual int cellXOffset(idx_type) const { return 0; }
263 /// any additional y-offset when drawing a cell?
264 virtual int cellYOffset(idx_type) const { return 0; }
265 /// number of embedded cells
266 virtual size_t nargs() const { return 0; }
267 /// number of rows in gridlike structures
268 virtual size_t nrows() const { return 0; }
269 /// number of columns in gridlike structures
270 virtual size_t ncols() const { return 0; }
271 /// Is called when the cursor leaves this inset.
272 /// Returns true if cursor is now invalid, e.g. if former
273 /// insets in higher cursor slices of \c old do not exist
275 /// \c old is the old cursor, the last slice points to this.
276 /// \c cur is the new cursor. Use the update flags to cause a redraw.
277 virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
279 /// Is called when the cursor enters this inset.
280 /// Returns true if cursor is now invalid, e.g. if former
281 /// insets in higher cursor slices of \c old do not exist
283 /// \c cur is the new cursor, some slice points to this. Use the update
284 /// 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) const
291 /// return true if this inset is hovered (under mouse)
292 /// This is by now only used by mathed to draw corners
293 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
294 /// Other insets do not have to redefine this function to
295 /// return the correct status of mouseHovered.
296 virtual bool mouseHovered(BufferView const *) const { return false; }
298 /// request "external features"
299 virtual void validate(LaTeXFeatures &) const {}
301 /// Validate LFUN_INSET_MODIFY argument.
302 virtual bool validateModifyArgument(docstring const &) const { return true; }
304 /// describe content if cursor inside
305 virtual void infoize(odocstream &) const {}
306 /// describe content if cursor behind
307 virtual void infoize2(odocstream &) const {}
309 enum { PLAINTEXT_NEWLINE = 10000 };
311 /// plain text output in ucs4 encoding
312 /// return the number of characters; in case of multiple lines of
313 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
314 virtual int plaintext(odocstream &, OutputParams const &) const = 0;
316 virtual int docbook(odocstream & os, OutputParams const &) const;
318 /// the inset is expected to write XHTML to the XHTMLStream
319 /// \return any "deferred" material that should be written outside the
320 /// normal stream, and which will in fact be written after the current
321 /// paragraph closes. this is appropriate e.g. for floats.
322 virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
323 /// the string that is passed to the TOC
324 virtual void tocString(odocstream &) const {}
326 /// can the contents of the inset be edited on screen ?
327 // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
328 virtual bool editable() const;
329 /// has the Inset settings that can be modified in a dialog ?
330 virtual bool hasSettings() const;
331 /// can we go further down on mouse click?
332 // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
333 virtual bool descendable(BufferView const &) const { return false; }
334 /// is this an inset that can be moved into?
335 /// FIXME: merge with editable()
336 // true for InsetTabular & InsetText
337 virtual bool isActive() const { return nargs() > 0; }
338 /// can we click at the specified position ?
339 virtual bool clickable(int, int) const { return false; }
341 /// does this contain text that can be change track marked in DVI?
342 virtual bool canTrackChanges() const { return false; }
343 /// return true if the inset should be removed automatically
344 virtual bool autoDelete() const;
346 /// Returns true if the inset supports completions.
347 virtual bool completionSupported(Cursor const &) const { return false; }
348 /// Returns true if the inset supports inline completions at the
349 /// cursor position. In this case the completion might be stored
350 /// in the BufferView's inlineCompletion property.
351 virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
353 /// Return true if the inline completion should be automatic.
354 virtual bool automaticInlineCompletion() const { return true; }
355 /// Return true if the popup completion should be automatic.
356 virtual bool automaticPopupCompletion() const { return true; }
357 /// Return true if the cursor should indicate a completion.
358 virtual bool showCompletionCursor() const { return true; }
359 /// Returns completion suggestions at cursor position. Return an
360 /// null pointer if no completion is a available or possible.
361 /// The caller is responsible to free the returned object!
362 virtual CompletionList const * createCompletionList(Cursor const &) const
364 /// Returns the completion prefix to filter the suggestions for completion.
365 /// This is only called if completionList returned a non-null list.
366 virtual docstring completionPrefix(Cursor const &) const;
367 /// Do a completion at the cursor position. Return true on success.
368 /// The completion does not contain the prefix. If finished is true, the
369 /// completion is final. If finished is false, completion might only be
370 /// a partial completion.
371 virtual bool insertCompletion(Cursor & /*cur*/,
372 docstring const & /*completion*/, bool /*finished*/)
374 /// Get the completion inset position and size
375 virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
376 Dimension & /*dim*/) const {}
378 /// returns true if the inset can hold an inset of given type
379 virtual bool insetAllowed(InsetCode) const { return false; }
380 /// should this inset use the empty layout by default rather than
381 /// the standard layout? (default: only if that is forced.)
382 virtual bool usePlainLayout() const { return forcePlainLayout(); }
383 /// if this inset has paragraphs should they be forced to use the
385 virtual bool forcePlainLayout(idx_type = 0) const { return false; }
386 /// if this inset has paragraphs should the user be allowed to
387 /// customize alignment, etc?
388 virtual bool allowParagraphCustomization(idx_type = 0) const
390 /// Is the width forced to some value?
391 virtual bool hasFixedWidth() const { return false; }
393 /// Is the content of this inset part of the output document?
394 virtual bool producesOutput() const { return true; }
396 /// \return Tool tip for this inset.
397 /// This default implementation returns an empty string.
398 virtual docstring toolTip(BufferView const & bv, int x, int y) const;
400 /// \return Context menu identifier for this inset.
401 /// This default implementation returns an empty string.
402 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
404 // FIXME This should really disappear in favor of
405 // docstring name() const { return from_ascii(insetName(lyxCode()))); }
406 // There's no reason to be using different names in different places.
407 // But to do this we would need to change the file format, since the names
408 // used there don't correspond to what is used here.
410 virtual docstring name() const;
412 virtual InsetLayout const & getLayout() const;
413 /// Is this inset's layout defined in the document's textclass?
414 bool undefined() const;
415 /// used to toggle insets
416 /// is the inset open?
417 /// should this inset be handled like a normal charater
418 virtual bool isChar() const { return false; }
419 /// is this equivalent to a letter?
420 virtual bool isLetter() const { return false; }
421 /// is this equivalent to a space (which is BTW different from
422 /// a line separator)?
423 virtual bool isSpace() const { return false; }
424 /// is this an expandible space (rubber length)?
425 virtual bool isStretchableSpace() const { return false; }
434 /// should we have a non-filled line before this inset?
435 virtual DisplayType display() const { return Inline; }
437 virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
438 /// should we break lines after this inset?
439 virtual bool isLineSeparator() const { return false; }
440 /// should paragraph indendation be ommitted in any case?
441 virtual bool neverIndent() const { return false; }
442 /// dumps content to lyxerr
443 virtual void dump() const;
444 /// write inset in .lyx format
445 virtual void write(std::ostream &) const {}
446 /// read inset in .lyx format
447 virtual void read(Lexer &) {}
448 /** Export the inset to LaTeX.
449 * Don't use a temporary stringstream if the final output is
450 * supposed to go to a file.
451 * \sa Buffer::writeLaTeXSource for the reason.
452 * \return the number of rows (\n's) of generated LaTeX code.
454 virtual int latex(odocstream &, OutputParams const &) const { return 0; }
455 /// returns true to override begin and end inset in file
456 virtual bool directWrite() const;
458 virtual bool allowSpellCheck() const { return false; }
460 /// if this insets owns text cells (e.g. InsetText) return cell num
461 virtual Text * getText(int /*num*/) const { return 0; }
463 /** Adds a LaTeX snippet to the Preview Loader for transformation
464 * into a bitmap image. Does not start the laoding process.
466 * Most insets have no interest in this capability, so the method
469 virtual void addPreview(DocIterator const &,
470 graphics::PreviewLoader &) const {}
472 /** Classifies the unicode characters appearing in a math inset
473 * depending on whether they are to be translated as latex
474 * math/text commands or used as math symbols without translation.
476 * Only math insets have interest in this classification, so the
477 * method defaults to empty.
479 virtual void initUnicodeMath() const {}
481 /// Add an entry to the TocList
482 /// pit is the ParConstIterator of the paragraph containing the inset
483 virtual void addToToc(DocIterator const &) {}
484 /// Fill keys with BibTeX information
485 virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
486 /// Update the counters of this inset and of its contents.
487 /// The boolean indicates whether we are preparing for output, e.g.,
489 virtual void updateBuffer(ParIterator const &, UpdateType) {}
491 /// Updates the inset's dialog
492 virtual Buffer const * updateFrontend() const;
495 /// returns LyX code associated with the inset. Used for TOC, ...)
496 virtual InsetCode lyxCode() const { return NO_CODE; }
498 /// -1: text mode, 1: math mode, 0 undecided
499 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
500 /// return text or mathmode if that is possible to determine
501 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
502 /// returns whether changing mode during latex export is forbidden
503 virtual bool lockedMode() const { return false; }
504 /// returns whether only ascii chars are allowed during latex export
505 virtual bool asciiOnly() const { return false; }
506 /// returns whether this inset is allowed in other insets of given mode
507 virtual bool allowedIn(mode_type) const { return true; }
509 * Is this inset allowed within a font change?
511 * FIXME: noFontChange means currently that the font change is closed
512 * in LaTeX before the inset, and that the contents of the inset
513 * will be in default font. This should be changed so that the inset
514 * changes the font again.
516 virtual bool noFontChange() const { return false; }
518 /// set the change for the entire inset
519 virtual void setChange(Change const &) {}
520 /// accept the changes within the inset
521 virtual void acceptChanges() {}
522 /// reject the changes within the inset
523 virtual void rejectChanges() {}
526 virtual Dimension const dimension(BufferView const &) const;
528 int scroll() const { return 0; }
530 virtual ColorCode backgroundColor(PainterInfo const &) const;
532 virtual ColorCode labelColor() const;
534 enum { TEXT_TO_INSET_OFFSET = 4 };
538 Inset(Buffer * buf) : buffer_(buf) {}
539 Inset(Inset const &) : buffer_(0) {}
541 /// replicate ourselves
542 friend class InsetList;
543 friend class MathAtom;
544 virtual Inset * clone() const = 0;
546 /** The real dispatcher.
547 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
548 * assumes the common case of 'LFUN handled, need update'.
549 * This has to be overriden by calling Cursor::undispatched() or
550 * Cursor::noScreenUpdate() if appropriate.
551 * If you need to call the dispatch method of some inset directly
552 * you may have to explicitly request an update at that place. Don't
553 * do it in doDispatch(), since that causes nested updates when
554 * called from Cursor::dispatch(), and these can lead to crashes.
557 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);