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 "support/strfwd.h"
23 #include <boost/shared_ptr.hpp>
40 class InsetCollapsable;
52 class ParConstIterator;
57 class EmbeddedFileList;
60 namespace graphics { class PreviewLoader; }
63 /// Common base class to all insets
65 // Do not add _any_ (non-static) data members as this would inflate
66 // everything storing large quantities of insets. Mathed e.g. would
73 ENTRY_DIRECTION_IGNORE,
74 ENTRY_DIRECTION_RIGHT,
78 typedef ptrdiff_t difference_type;
79 /// short of anything else reasonable
80 typedef size_t size_type;
81 /// type for cell indices
82 typedef size_t idx_type;
83 /// type for cursor positions
84 typedef ptrdiff_t pos_type;
85 /// type for row numbers
86 typedef size_t row_type;
87 /// type for column numbers
88 typedef size_t col_type;
90 /// virtual base class destructor
93 /// change associated Buffer
94 /// FIXME this should go.
95 virtual void setBuffer(Buffer & buffer);
96 /// retrieve associated Buffer
97 virtual Buffer & buffer();
98 virtual Buffer const & buffer() const;
100 /// initialize view for this inset.
102 * This is typically used after this inset is created interactively.
103 * Intented purpose is to sanitize internal state with regard to current
106 virtual void initView() {}
108 /// identification as math inset
109 virtual InsetMath * asInsetMath() { return 0; }
110 /// true for 'math' math inset, but not for e.g. mbox
111 virtual bool inMathed() const { return false; }
112 /// is this inset based on the InsetText class?
113 virtual InsetText * asInsetText() { return 0; }
114 /// is this inset based on the InsetText class?
115 virtual InsetText const * asInsetText() const { return 0; }
116 /// is this inset based on the InsetCollapsable class?
117 virtual InsetCollapsable * asInsetCollapsable() { return 0; }
118 /// is this inset based on the InsetCollapsable class?
119 virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
121 /// the real dispatcher
122 void dispatch(Cursor & cur, FuncRequest & cmd);
124 * \returns true if this function made a definitive decision on
125 * whether the inset wants to handle the request \p cmd or not.
126 * The result of this decision is put into \p status.
128 * Every request that is enabled in this method needs to be handled
129 * in doDispatch(). Normally we have a 1:1 relationship between the
130 * requests handled in getStatus() and doDispatch(), but there are
132 * - A request that is disabled in getStatus() does not need to
133 * appear in doDispatch(). It is guaranteed that doDispatch()
134 * is never called with this request.
135 * - A few requests are en- or disabled in Inset::getStatus().
136 * These need to be handled in the doDispatch() methods of the
137 * derived insets, since Inset::doDispatch() has not enough
138 * information to handle them.
139 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
140 * are dispatched directly
142 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
143 FuncStatus & status) const;
146 virtual void edit(Cursor & cur, bool front,
147 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
149 virtual Inset * editXY(Cursor & cur, int x, int y);
151 /// compute the size of the object returned in dim
152 /// \retval true if metrics changed.
153 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
154 /// draw inset and update (xo, yo)-cache
155 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
156 /// draw inset selection if necessary
157 virtual void drawSelection(PainterInfo &, int, int) const {}
159 virtual bool editing(BufferView const * bv) const;
161 virtual bool showInsetDialog(BufferView *) const { return false; }
163 /// draw inset decoration if necessary.
164 /// This can use \c drawMarkers() for example.
165 virtual void drawDecoration(PainterInfo &, int, int) const {}
166 /// draw four angular markers
167 void drawMarkers(PainterInfo & pi, int x, int y) const;
168 /// draw two angular markers
169 void drawMarkers2(PainterInfo & pi, int x, int y) const;
170 /// add space for markers
171 void metricsMarkers(Dimension & dim, int framesize = 1) const;
172 /// add space for markers
173 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
174 /// last drawn position for 'important' insets
175 int xo(BufferView const & bv) const;
176 /// last drawn position for 'important' insets
177 int yo(BufferView const & bv) const;
178 /// set x/y drawing position cache if available
179 virtual void setPosCache(PainterInfo const &, int, int) const;
181 void setDimCache(MetricsInfo const &, Dimension const &) const;
182 /// do we cover screen position x/y?
183 virtual bool covers(BufferView const & bv, int x, int y) const;
184 /// get the screen positions of the cursor (see note in Cursor.cpp)
185 virtual void cursorPos(BufferView const & bv,
186 CursorSlice const & sl, bool boundary, int & x, int & y) const;
189 virtual bool isFreeSpacing() const { return false; }
191 virtual bool allowEmpty() const { return false; }
192 /// Force inset into LTR environment if surroundings are RTL?
193 virtual bool forceLTR() const { return false; }
195 /// is this an inset that can be moved into?
196 /// FIXME: merge with editable()
197 virtual bool isActive() const { return nargs() > 0; }
198 /// Where should we go when we press the up or down cursor key?
199 virtual bool idxUpDown(Cursor & cur, bool up) const;
200 /// Move one cell backwards
201 virtual bool idxBackward(Cursor &) const { return false; }
202 /// Move one cell forward
203 virtual bool idxForward(Cursor &) const { return false; }
205 /// Move to the next cell
206 virtual bool idxNext(Cursor &) const { return false; }
207 /// Move to the previous cell
208 virtual bool idxPrev(Cursor &) const { return false; }
210 /// Target pos when we enter the inset while moving forward
211 virtual bool idxFirst(Cursor &) const { return false; }
212 /// Target pos when we enter the inset while moving backwards
213 virtual bool idxLast(Cursor &) const { return false; }
215 /// Delete a cell and move cursor
216 virtual bool idxDelete(idx_type &) { return false; }
217 /// pulls cell after pressing erase
218 virtual void idxGlue(idx_type) {}
219 /// returns list of cell indices that are "between" from and to for
220 /// selection purposes
221 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
223 /// to which column belongs a cell with a given index?
224 virtual col_type col(idx_type) const { return 0; }
225 /// to which row belongs a cell with a given index?
226 virtual row_type row(idx_type) const { return 0; }
227 /// cell idex corresponding to row and column;
228 virtual idx_type index(row_type row, col_type col) const;
229 /// any additional x-offset when drawing a cell?
230 virtual int cellXOffset(idx_type) const { return 0; }
231 /// any additional y-offset when drawing a cell?
232 virtual int cellYOffset(idx_type) const { return 0; }
233 /// number of embedded cells
234 virtual size_t nargs() const { return 0; }
235 /// number of rows in gridlike structures
236 virtual size_t nrows() const { return 0; }
237 /// number of columns in gridlike structures
238 virtual size_t ncols() const { return 0; }
239 /// Is called when the cursor leaves this inset.
240 /// Returns true if cursor is now invalid, e.g. if former
241 /// insets in higher cursor slices of \c old do not exist
243 /// \c old is the old cursor, i.e. there is a slice pointing to this.
244 /// \c cur is the new cursor. Use the update flags to cause a redraw.
245 virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
247 /// is called when the mouse enter or leave this inset
248 /// return true if this inset needs repaint
249 virtual bool setMouseHover(bool) { return false; }
250 /// return true if this inset is hovered (under mouse)
251 /// This is by now only used by mathed to draw corners
252 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
253 /// Other insets do not have to redefine this function to
254 /// return the correct status of mouseHovered.
255 virtual bool mouseHovered() const { return false; }
257 /// request "external features"
258 virtual void validate(LaTeXFeatures &) const {}
260 /// describe content if cursor inside
261 virtual void infoize(odocstream &) const {}
262 /// describe content if cursor behind
263 virtual void infoize2(odocstream &) const {}
265 enum { PLAINTEXT_NEWLINE = 10000 };
267 /// plain text output in ucs4 encoding
268 /// return the number of characters; in case of multiple lines of
269 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
270 virtual int plaintext(odocstream &, OutputParams const &) const = 0;
272 virtual int docbook(odocstream & os, OutputParams const &) const;
273 /// the string that is passed to the TOC
274 virtual void textString(odocstream &) const {}
276 /** This enum indicates by which means the inset can be modified:
277 - NOT_EDITABLE: the inset's content cannot be modified at all
278 (e.g. printindex, insetspecialchar)
279 - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, href)
280 - HIGHLY_EDITABLE: content can be edited on screen (normally means that
281 insettext is contained, e.g. collapsables, tabular) */
282 // FIXME: This has not yet been fully implemented to math insets
291 /// what appears in the minibuffer when opening
292 virtual docstring editMessage() const;
294 virtual EDITABLE editable() const;
295 /// can we go further down on mouse click?
296 virtual bool descendable() const { return false; }
297 /// does this contain text that can be change track marked in DVI?
298 virtual bool canTrackChanges() const { return false; }
299 /// return true if the inset should be removed automatically
300 virtual bool autoDelete() const;
302 class CompletionList {
305 virtual ~CompletionList() {}
307 virtual bool sorted() const =0;
309 virtual size_t size() const =0;
310 /// returns the string shown in the gui.
311 virtual docstring const & data(size_t idx) const = 0;
312 /// returns the resource string used to load an icon.
313 virtual std::string icon(size_t /*idx*/) const { return std::string(); }
316 /// Returns true if the inset supports completions.
317 virtual bool completionSupported(Cursor const &) const { return false; }
318 /// Returns true if the inset supports inline completions at the
319 /// cursor position. In this case the completion might be stored
320 /// in the BufferView's inlineCompletion property.
321 virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
323 /// Return true if the inline completion should be automatic.
324 virtual bool automaticInlineCompletion() const { return true; }
325 /// Return true if the popup completion should be automatic.
326 virtual bool automaticPopupCompletion() const { return true; }
327 /// Returns completion suggestions at cursor position. Return an
328 /// null pointer if no completion is a available or possible.
329 /// The caller is responsible to free the returned object!
330 virtual CompletionList const * createCompletionList(Cursor const &) const
332 /// Returns the completion prefix to filter the suggestions for completion.
333 /// This is only called if completionList returned a non-null list.
334 virtual docstring completionPrefix(Cursor const &) const
335 { return docstring(); }
336 /// Do a completion at the cursor position. Return true on success.
337 /// The completion does not contain the prefix. If finished is true, the
338 /// completion is final. If finished is false, completion might only be
339 /// a partial completion.
340 virtual bool insertCompletion(Cursor & /*cur*/,
341 docstring const & /*completion*/, bool /*finished*/)
343 /// Get the completion inset position and size
344 virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
345 Dimension & /*dim*/) const {}
347 /// returns true if the inset can hold an inset of given type
348 virtual bool insetAllowed(InsetCode) const { return false; }
349 /// should this inset use the empty layout by default rather than
350 /// the standard layout? (default: only if that is forced.)
351 virtual bool useEmptyLayout() const { return forceEmptyLayout(); }
352 /// if this inset has paragraphs should they be forced to use the
354 virtual bool forceEmptyLayout() const { return false; }
355 /// if this inset has paragraphs should the user be allowed to
356 /// customize alignment, etc?
357 virtual bool allowParagraphCustomization(idx_type) const { return true; }
358 /// Is the width forced to some value?
359 virtual bool hasFixedWidth() const { return false; }
361 /// \return Tool tip for this inset.
362 /// This default implementation returns an empty string.
363 virtual docstring toolTip(BufferView const & bv, int x, int y) const;
365 /// \return Context menu identifier for this inset.
366 /// This default implementation returns an empty string.
367 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
369 // FIXME This should really disappear in favor of
370 // docstring name() const { return from_ascii(insetName(lyxCode()))); }
371 // There's no reason to be using different names in different places.
372 // But to do this we would need to change the file format, since the names
373 // used there don't correspond to what is used here.
375 virtual docstring name() const;
377 virtual InsetLayout const & getLayout(BufferParams const & bp) const;
378 /// used to toggle insets
379 /// is the inset open?
380 /// should this inset be handled like a normal charater
381 virtual bool isChar() const { return false; }
382 /// is this equivalent to a letter?
383 virtual bool isLetter() const { return false; }
384 /// is this equivalent to a space (which is BTW different from
385 /// a line separator)?
386 virtual bool isSpace() const { return false; }
395 /// should we have a non-filled line before this inset?
396 virtual DisplayType display() const { return Inline; }
397 /// should we break lines after this inset?
398 virtual bool isLineSeparator() const { return false; }
399 /// should paragraph indendation be ommitted in any case?
400 virtual bool neverIndent() const { return false; }
401 /// dumps content to lyxerr
402 virtual void dump() const;
403 /// write inset in .lyx format
404 virtual void write(std::ostream &) const {}
405 /// read inset in .lyx format
406 virtual void read(Lexer &) {}
407 /** Export the inset to LaTeX.
408 * Don't use a temporary stringstream if the final output is
409 * supposed to go to a file.
410 * \sa Buffer::writeLaTeXSource for the reason.
411 * \return the number of rows (\n's) of generated LaTeX code.
413 virtual int latex(odocstream &, OutputParams const &) const { return 0; }
414 /// returns true to override begin and end inset in file
415 virtual bool directWrite() const;
417 virtual bool allowSpellCheck() const { return false; }
419 /// if this insets owns text cells (e.g. InsetText) return cell num
420 virtual Text * getText(int /*num*/) const { return 0; }
422 /** Adds a LaTeX snippet to the Preview Loader for transformation
423 * into a bitmap image. Does not start the laoding process.
425 * Most insets have no interest in this capability, so the method
428 virtual void addPreview(graphics::PreviewLoader &) const {}
429 /// Add an entry to the TocList
430 /// pit is the ParConstIterator of the paragraph containing the inset
431 virtual void addToToc(ParConstIterator const &) const {}
432 /// report files that can be embedded with the lyx file
433 virtual void registerEmbeddedFiles(EmbeddedFileList &) const {}
434 /// update the properties of an embedded file of an inset
435 /// the name of the embedded file should not change.
436 virtual void updateEmbeddedFile(EmbeddedFile const &) {}
437 /// Fill keys with BibTeX information
438 virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
439 /// Update the counters of this inset and of its contents
440 virtual void updateLabels(ParIterator const &) {}
442 /// Updates the inset's dialog
443 virtual Buffer const * updateFrontend() const;
446 /// returns LyX code associated with the inset. Used for TOC, ...)
447 virtual InsetCode lyxCode() const { return NO_CODE; }
449 /// -1: text mode, 1: math mode, 0 undecided
450 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
451 /// return text or mathmode if that is possible to determine
452 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
453 /// returns whether this inset is allowed in other insets of given mode
454 virtual bool allowedIn(mode_type) const { return true; }
456 * Is this inset allowed within a font change?
458 * FIXME: noFontChange means currently that the font change is closed
459 * in LaTeX before the inset, and that the contents of the inset
460 * will be in default font. This should be changed so that the inset
461 * changes the font again.
463 virtual bool noFontChange() const { return false; }
465 /// set the change for the entire inset
466 virtual void setChange(Change const &) {}
467 /// accept the changes within the inset
468 virtual void acceptChanges(BufferParams const &) {};
469 /// reject the changes within the inset
470 virtual void rejectChanges(BufferParams const &) {};
473 virtual Dimension const dimension(BufferView const &) const;
475 int scroll() const { return 0; }
477 virtual ColorCode backgroundColor() const;
479 enum CollapseStatus {
484 virtual void setStatus(Cursor &, CollapseStatus) {}
486 enum { TEXT_TO_INSET_OFFSET = 4 };
490 explicit Inset() : buffer_(0) {}
492 /// replicate ourselves
493 friend class InsetList;
494 friend class MathAtom;
495 virtual Inset * clone() const = 0;
497 /** The real dispatcher.
498 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
499 * assumes the common case of 'LFUN handled, need update'.
500 * This has to be overriden by calling Cursor::undispatched() or
501 * Cursor::noUpdate() if appropriate.
502 * If you need to call the dispatch method of some inset directly
503 * you may have to explicitly request an update at that place. Don't
504 * do it in doDispatch(), since that causes nested updates when
505 * called from Cursor::dispatch(), and these can lead to crashes.
508 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);