* Licence details can be found in the file COPYING.
*
* \author unknown
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author John Levon
*
* Full author contact details are available in file CREDITS.
#ifndef TEXT_H
#define TEXT_H
-#include "Bidi.h"
-#include "DispatchResult.h"
-#include "Font.h"
-#include "Layout.h"
-#include "lyxlayout_ptr_fwd.h"
+#include "DocIterator.h"
#include "ParagraphList.h"
-#include <iosfwd>
-
-
namespace lyx {
-class Buffer;
class BufferParams;
class BufferView;
+class Change;
+class CompletionList;
+class Cursor;
+class CursorData;
class CursorSlice;
-class DocIterator;
class ErrorList;
+class Font;
+class FontInfo;
class FuncRequest;
class FuncStatus;
class Inset;
-class Color_color;
-class Cursor;
-class PainterInfo;
-class Row;
-class RowMetrics;
-class Spacing;
-
+class InsetText;
+class Lexer;
+class Paragraph;
+class ParagraphParameters;
-/// This class encapsulates the main text data and operations in LyX
+/// This class encapsulates the main text data and operations in LyX.
+/// This is more or less the private implementation of InsetText.
class Text {
-public:
- /// constructor
- explicit Text();
+private:
+ /// Default constructor.
+ Text(InsetText * owner, bool use_default_layout);
+
+ /// Copy constructor.
+ Text(InsetText * owner, Text const & text);
+public:
/// \return true if there's no content at all.
/// \warning a non standard layout on an empty paragraph doesn't
- // count as empty.
+ /// count as empty.
bool empty() const;
+ /// Access to owner InsetText.
+ InsetText const & inset() const;
///
- Font getFont(Buffer const & buffer, Paragraph const & par,
- pos_type pos) const;
- ///
- void applyOuterFont(Buffer const & buffer, Font &) const;
+ FontInfo layoutFont(pit_type pit) const;
///
- Font getLayoutFont(Buffer const & buffer, pit_type pit) const;
- ///
- Font getLabelFont(Buffer const & buffer,
- Paragraph const & par) const;
+ FontInfo labelFont(Paragraph const & par) const;
/** Set font of character at position \p pos in paragraph \p pit.
* Must not be called if \p pos denotes an inset with text contents,
* and the inset is not allowed inside a font change (see below).
*/
- void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
- Font const & font);
+ void setCharFont(pit_type pit, pos_type pos,
+ Font const & font, Font const & display_font);
/** Needed to propagate font changes to all text cells of insets
- * that are not allowed inside a font change (bug 1973).
+ * that are not allowed inside a font change (bugs 1973, 6919).
* Must not be called if \p pos denotes an ordinary character or an
* inset that is alowed inside a font change.
- * FIXME: This should be removed, see documentation of noFontChange
- * in insetbase.h
*/
- void setInsetFont(Buffer const & buffer, pit_type pit, pos_type pos,
- Font const & font, bool toggleall = false);
+ void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
+ Font const & font);
/// what you expect when pressing \<enter\> at cursor position
- void breakParagraph(Cursor & cur, bool keep_layout = false);
+ /// \param inverse_logic if false, the same layout is set for the
+ /// new paragraph if the layout is an environment; if true, the
+ /// same layout is set if it is not an environment
+ void breakParagraph(Cursor & cur, bool inverse_logic = false);
/// set layout over selection
- void setLayout(Buffer const & buffer, pit_type start, pit_type end,
+ void setLayout(pit_type start, pit_type end,
docstring const & layout);
- /// Set given layout to current cursor position.
- /// FIXME: replace Cursor with DocIterator.
+ /// Set given layout to current cursor position or selection.
+ /// Handles undo.
void setLayout(Cursor & cur, docstring const & layout);
/// what type of depth change to make
};
/// Increase or decrease the nesting depth of the selected paragraph(s)
/// FIXME: replace Cursor with DocIterator.
- void changeDepth(Cursor & cur, DEPTH_CHANGE type);
+ void changeDepth(Cursor const & cur, DEPTH_CHANGE type);
/// Returns whether something would be changed by changeDepth
/// FIXME: replace Cursor with DocIterator.
- bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
+ bool changeDepthAllowed(Cursor const & cur, DEPTH_CHANGE type) const;
/// Set font over selection paragraphs and rebreak.
/// FIXME: replace Cursor with DocIterator.
void setFont(Cursor & cur, Font const &, bool toggleall = false);
/// Set font from \p begin to \p end and rebreak.
- void setFont(Buffer const & buffer, CursorSlice const & begin,
- CursorSlice const & end, Font const &,
- bool toggleall = false);
+ void setFont(BufferView const & bv, CursorSlice const & begin,
+ CursorSlice const & end, Font const &);
///
void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
+ /// Stack to save recent text propterty applications
+ std::vector<docstring> getFreeFonts() const;
/// ???
/// FIXME: replace Cursor with DocIterator.
- docstring getStringToIndex(Cursor const & cur);
+ docstring getStringForDialog(Cursor & cur);
+
+ /// Convert the paragraphs to a string.
+ /// \param AsStringParameter options. This can contain any combination of
+ /// asStringParameter values. Valid examples:
+ /// asString(AS_STR_LABEL)
+ /// asString(AS_STR_LABEL | AS_STR_INSETS)
+ /// asString(AS_STR_INSETS)
+ docstring asString(int options = AS_STR_NONE) const;
+ ///
+ docstring asString(pit_type beg, pit_type end,
+ int options = AS_STR_NONE) const;
+
+ /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
+ /// and '\t' with spaces
+ static void shortenForOutliner(docstring & str, size_t const maxlen);
+
+ /// Appends a possibly abbreviated representation of our text to \param os,
+ /// where \param maxlen defines the maximum size of \param os. If \param
+ /// shorten is true, then os is shortened as above.
+ void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
+ /// Appends a possibly abbreviated representation of our text, from
+ /// start to end, to \param os, where \param maxlen defines the
+ /// maximum size of \param os. Omits the label of the first paragraph.
+ void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
+ bool shorten = true) const;
/// insert a character at cursor position
/// FIXME: replace Cursor with DocIterator.
/// FIXME: replace Cursor with DocIterator.
void insertInset(Cursor & cur, Inset * inset);
- /// draw text (only used for insets)
- void draw(PainterInfo & pi, int x, int y) const;
- /// draw textselection
- void drawSelection(PainterInfo & pi, int x, int y) const;
-
/// try to handle that request
/// FIXME: replace Cursor with DocIterator.
void dispatch(Cursor & cur, FuncRequest & cmd);
/// read-write access to individual paragraph
Paragraph & getPar(pit_type pit) { return pars_[pit]; }
// Returns the current font and depth as a message.
- /// FIXME: replace Cursor with DocIterator.
- docstring currentState(Cursor & cur);
-
- /** returns row near the specified
- * y-coordinate in given paragraph (relative to the screen).
- */
- /// FIXME: move to TextMetrics.
- Row const & getRowNearY(BufferView const & bv, int y,
- pit_type pit) const;
-
- /// returns the paragraph number closest to screen y-coordinate.
- /// This method uses the BufferView CoordCache to locate the
- /// paragraph. The y-coodinate is allowed to be off-screen and
- /// the CoordCache will be automatically updated if needed. This is
- /// the reason why we need a non const BufferView.
- /// FIXME: move to TextMetrics.
- pit_type getPitNearY(BufferView & bv, int y) const;
+ // When \param devel_mode is true, add more precise information
+ docstring currentState(CursorData const & cur, bool devel_mode) const;
/** Find the word under \c from in the relative location
* defined by \c word_location.
* @param from return here the start of the word
* @param to return here the end of the word
*/
- void getWord(CursorSlice & from, CursorSlice & to, word_location const);
+ void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
/// just selects the word the cursor is in
void selectWord(Cursor & cur, word_location loc);
+ /// expands the selection to the word the cursor is in
+ void expandWordSel(Cursor & cur);
+ /// select all text
+ void selectAll(Cursor & cur);
/// what type of change operation to make
enum ChangeOp {
/// accept or reject the selected change
void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
/// accept the changes within the complete Text
- void acceptChanges(BufferParams const & bparams);
+ void acceptChanges();
/// reject the changes within the complete Text
- void rejectChanges(BufferParams const & bparams);
+ void rejectChanges();
/// returns true if par was empty and was removed
- bool setCursor(Cursor & cur, pit_type par, pos_type pos,
+ bool setCursor(Cursor & cur, pit_type pit, pos_type pos,
bool setfont = true, bool boundary = false);
///
- void setCursor(CursorSlice &, pit_type par, pos_type pos);
- ///
- void setCursorIntern(Cursor & cur, pit_type par,
+ void setCursorIntern(Cursor & cur, pit_type pit,
pos_type pos, bool setfont = true, bool boundary = false);
- ///
- void setCurrentFont(Cursor & cur);
-
- ///
- void recUndo(Cursor & cur, pit_type first, pit_type last) const;
- ///
- void recUndo(Cursor & cur, pit_type first) const;
-
- /// sets cursor only within this Text.
- /// x,y are screen coordinates
- void setCursorFromCoordinates(Cursor & cur, int x, int y);
- /// sets cursor recursively descending into nested editable insets
+ /// Move cursor one position backwards
+ /**
+ * Returns true if an update is needed after the move.
+ */
+ bool cursorBackward(Cursor & cur);
+ /// Move cursor visually one position to the left
/**
- \return the inset pointer if x,y is covering that inset
- \param x,y are absolute screen coordinates.
- \retval inset is non-null if the cursor is positionned inside
- */
- /// FIXME: move to TextMetrics.
- /// FIXME: cleanup to use BufferView::getCoveringInset() and
- /// setCursorFromCoordinates() instead of checkInsetHit().
- Inset * editXY(Cursor & cur, int x, int y);
-
- /// Move cursor one position left
+ * \param skip_inset if true, don't enter insets
+ * Returns true if an update is needed after the move.
+ */
+ bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
+ /// Move cursor one position forward
/**
* Returns true if an update is needed after the move.
*/
- bool cursorLeft(Cursor & cur);
- /// Move cursor one position right
+ bool cursorForward(Cursor & cur);
+ /// Move cursor visually one position to the right
/**
+ * \param skip_inset if true, don't enter insets
* Returns true if an update is needed after the move.
*/
- bool cursorRight(Cursor & cur);
+ bool cursorVisRight(Cursor & cur, bool skip_inset = false);
///
- bool cursorLeftOneWord(Cursor & cur);
+ bool cursorBackwardOneWord(Cursor & cur);
///
- bool cursorRightOneWord(Cursor & cur);
+ bool cursorForwardOneWord(Cursor & cur);
///
- bool cursorUpParagraph(Cursor & cur);
+ bool cursorVisLeftOneWord(Cursor & cur);
///
- bool cursorDownParagraph(Cursor & cur);
+ bool cursorVisRightOneWord(Cursor & cur);
+ /// Delete from cursor up to the end of the current or next word.
+ /// Use force to skip the confirmDeletion check.
+ void deleteWordForward(Cursor & cur, bool force = false);
+ /// Delete from cursor to start of current or prior word.
+ void deleteWordBackward(Cursor & cur, bool force = false);
///
- /// FIXME: move to TextMetrics.
- bool cursorHome(Cursor & cur);
- ///
- /// FIXME: move to TextMetrics.
- bool cursorEnd(Cursor & cur);
- ///
- void cursorPrevious(Cursor & cur);
+ bool cursorUpParagraph(Cursor & cur);
///
- void cursorNext(Cursor & cur);
+ bool cursorDownParagraph(Cursor & cur);
///
bool cursorTop(Cursor & cur);
///
// Dissolve the inset under cursor
/// FIXME: replace Cursor with DocIterator.
bool dissolveInset(Cursor & cur);
+ /// FIXME: replace Cursor with DocIterator.
+ bool splitInset(Cursor & cur);
///
bool selectWordWhenUnderCursor(Cursor & cur, word_location);
- ///
- enum TextCase {
- ///
- text_lowercase = 0,
- ///
- text_capitalization = 1,
- ///
- text_uppercase = 2
- };
/// Change the case of the word at cursor position.
- void changeCase(Cursor & cur, TextCase action);
+ void changeCase(Cursor & cur, TextCase action, bool partial);
/// Transposes the character at the cursor with the one before it
void charsTranspose(Cursor & cur);
settings are given to the new one.
This function will handle a multi-paragraph selection.
*/
- void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
+ void setParagraphs(Cursor const & cur, docstring const & arg, bool merge = false);
/// Sets parameters for current or selected paragraphs
- void setParagraphs(Cursor & cur, ParagraphParameters const & p);
+ void setParagraphs(Cursor const & cur, ParagraphParameters const & p);
/* these things are for search and replace */
/// needed to insert the selection
- /// FIXME: replace Cursor with DocIterator.
- void insertStringAsLines(Cursor & cur, docstring const & str);
+ void insertStringAsLines(Cursor & cur, docstring const & str,
+ Font const & font);
/// needed to insert the selection
- /// FIXME: replace Cursor with DocIterator.
- void insertStringAsParagraphs(Cursor & cur, docstring const & str);
-
- /// Returns an inset if inset was hit, or 0 if not.
- /// \warning This method is not recursive! It will return the
- /// outermost inset within this Text.
- /// \sa BufferView::getCoveringInset() to get the innermost inset.
- Inset * checkInsetHit(BufferView &, int x, int y);
-
- ///
- /// FIXME: move to TextMetrics.
- int singleWidth(Buffer const &, Paragraph const & par,
- pos_type pos) const;
- ///
- /// FIXME: move to TextMetrics.
- int singleWidth(Paragraph const & par, pos_type pos, char_type c,
- Font const & Font) const;
-
- /// return the color of the canvas
- Color_color backgroundColor() const;
-
- /**
- * Returns the left beginning of the text.
- * This information cannot be taken from the layout object, because
- * in LaTeX the beginning of the text fits in some cases
- * (for example sections) exactly the label-width.
- */
- /// FIXME: move to TextMetrics.
- int leftMargin(Buffer const &, int max_width, pit_type pit, pos_type pos) const;
- int leftMargin(Buffer const &, int max_width, pit_type pit) const;
+ void insertStringAsParagraphs(Cursor & cur, docstring const & str,
+ Font const & font);
/// access to our paragraphs
ParagraphList const & paragraphs() const { return pars_; }
ParagraphList & paragraphs() { return pars_; }
/// return true if this is the main text
- bool isMainText(Buffer const &) const;
-
- /// is this row the last in the text?
- /// FIXME: move to TextMetrics.
- bool isLastRow(pit_type pit, Row const & row) const;
- /// is this row the first in the text?
- /// FIXME: move to TextMetrics.
- bool isFirstRow(pit_type pit, Row const & row) const;
+ bool isMainText() const;
///
- double spacing(Buffer const & buffer, Paragraph const & par) const;
+ double spacing(Paragraph const & par) const;
/// make a suggestion for a label
/// FIXME: replace Cursor with DocIterator.
- docstring getPossibleLabel(Cursor & cur) const;
+ docstring getPossibleLabel(DocIterator const & cur) const;
/// is this paragraph right-to-left?
- bool isRTL(Buffer const &, Paragraph const & par) const;
- /// is this position in the paragraph right-to-left?
- bool isRTL(Buffer const & buffer, CursorSlice const & sl, bool boundary) const;
- /// is between pos-1 and pos an RTL<->LTR boundary?
- bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
- pos_type pos) const;
- /// would be a RTL<->LTR boundary between pos and the given font?
- bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
- pos_type pos, Font const & font) const;
+ bool isRTL(pit_type pit) const;
///
bool checkAndActivateInset(Cursor & cur, bool front);
-
///
- void write(Buffer const & buf, std::ostream & os) const;
- /// returns whether we've seen our usual 'end' marker
- bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList);
+ bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
///
- /// FIXME: move to TextMetrics.
- int cursorX(BufferView const &, CursorSlice const & cursor,
- bool boundary) const;
- ///
- /// FIXME: move to TextMetrics.
- int cursorY(BufferView const & bv, CursorSlice const & cursor,
- bool boundary) const;
+ void write(std::ostream & os) const;
+ /// returns true if \end_document has not been read
+ /// insetPtr is the containing Inset
+ bool read(Lexer & lex, ErrorList & errorList,
+ InsetText * insetPtr);
/// delete double spaces, leading spaces, and empty paragraphs around old cursor.
/// \retval true if a change has happened and we need a redraw.
- /// FIXME: replace Cursor with DocIterator. This is not possible right
- /// now because recordUndo() is called which needs a Cursor.
+ /// Handles undo.
static bool deleteEmptyParagraphMechanism(Cursor & cur,
Cursor & old, bool & need_anchor_change);
/// delete double spaces, leading spaces, and empty paragraphs
/// from \first to \last paragraph
+ /// Does NOT handle undo (responsibility of the caller)
void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
-public:
- /// the current font settings
- Font current_font;
- /// the current font
- Font real_current_font;
- ///
- int background_color_;
-
- ///
- ParagraphList pars_;
-
- /// our 'outermost' font. This is handed down from the surrounding
- // inset through the pi/mi parameter (pi.base.font)
- Font font_;
+ /// delete double spaces, leading spaces, and empty paragraphs
+ /// from \first to \last paragraph and \first_pos to \last_pos
+ /// Does NOT handle undo (responsibility of the caller)
+ void deleteEmptyParagraphMechanism(pit_type first, pit_type last,
+ pos_type first_pos, pos_type last_pos,
+ bool trackChanges);
+
+ /// To resolve macros properly the texts get their DocIterator.
+ /// Every macro definition is stored with its DocIterator
+ /// as well. Only those macros with a smaller iterator become
+ /// visible in a paragraph.
+ DocIterator macrocontextPosition() const;
+ ///
+ void setMacrocontextPosition(DocIterator const & pos);
+
+ ///
+ bool completionSupported(Cursor const & cur) const;
+ ///
+ CompletionList const * createCompletionList(Cursor const & cur) const;
+ /// Do a completion at the cursor position. Return true on success.
+ /// The completion does not contain the prefix. Handles undo.
+ bool insertCompletion(Cursor & cur, docstring const & s);
+ ///
+ docstring completionPrefix(Cursor const & cur) const;
+ /// find a paragraph before \p par with the given \p depth, if such
+ /// a paragraph cannot be found, \p par is returned
+ pit_type depthHook(pit_type pit, depth_type depth) const;
+ /// find a paragraph before \p par with depth less than the
+ /// depth of \p par. If such paragraph cannot be found because
+ /// \p par already has depth 0, lastpar + 1 is returned. If
+ /// such paragraph cannot be found because there isn't a par
+ /// with less depth before this one, \p par is returned.
+ pit_type outerHook(pit_type pit) const;
+ /// Is it the first par with same depth and layout?
+ bool isFirstInSequence(pit_type pit) const;
+ /// Return the last paragraph with same depth and layout, or a strictly
+ /// greater depth
+ pit_type lastInSequence(pit_type pit) const;
+ /// Is this paragraph in the table of contents?
+ int getTocLevel(pit_type pit) const;
+ /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
+ /// All font changes of the paragraph are relative to this font.
+ Font const outerFont(pit_type pit_offset) const;
+ /// Return the label type at the end of paragraph \c pit.
+ int getEndLabel(pit_type pit) const;
- ///
- bool autoBreakRows_;
private:
- /// return past-the-last paragraph influenced by a layout
- /// change on pit
- pit_type undoSpan(pit_type pit);
-
- // fix the cursor `cur' after a characters has been deleted at `where'
- // position. Called by deleteEmptyParagraphMechanism
- static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
+ /// The InsetText owner shall have access to everything.
+ friend class InsetText;
// At cursor position 0, try to merge the paragraph with the one before it.
// Ignore change tracking, i.e., physically remove the end-of-par character
bool backspacePos0(Cursor & cur);
/// handle the case where bibitems were deleted
bool handleBibitems(Cursor & cur);
-
- ///
- void deleteWordForward(Cursor & cur);
+ /// are we in a list item (description etc.)?
+ bool inDescriptionItem(Cursor const & cur) const;
///
- void deleteWordBackward(Cursor & cur);
- ///
- void deleteLineForward(Cursor & cur);
- ///
- void charInserted();
+ void charInserted(Cursor & cur);
/// set 'number' font property
void number(Cursor & cur);
- /// draw selection for a single row
- void drawRowSelection(PainterInfo & pi, int x, Row const & row,
- DocIterator const & beg, DocIterator const & end,
- bool drawOnBegMargin, bool drawOnEndMargin) const;
/// paste plain text at current cursor.
/// \param str string to paste
/// \param asParagraphs whether to paste as paragraphs or as lines
void pasteString(Cursor & cur, docstring const & str,
bool asParagraphs);
+ ///
+ void readParToken(Paragraph & par, Lexer & lex, std::string const & token,
+ Font & font, Change & change, ErrorList & errorList);
+ ///
+ void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
+ /// Set Label Width string to all paragraphs of the same layout
+ /// and depth in a sequence.
+ void setLabelWidthStringToSequence(Cursor const & cur, docstring const & s);
+
+ /// Owner Inset.
+ InsetText * owner_;
+ ///
+ ParagraphList pars_;
+ /// position of the text in the buffer.
+ DocIterator macrocontext_position_;
};
+
+///
+void breakParagraphConservative(BufferParams const & bparams,
+ ParagraphList & paragraphs,
+ pit_type pit,
+ pos_type pos);
+
+/**
+ * Append the next paragraph onto the tail of this one.
+ * Be careful, this doesent make any check at all.
+ */
+void mergeParagraph(BufferParams const & bparams,
+ ParagraphList & paragraphs, pit_type pit);
+
+/// accept the changes within the complete ParagraphList
+void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
+
+/// reject the changes within the complete ParagraphList
+void rejectChanges(ParagraphList & pars, BufferParams const & bparams);
+
} // namespace lyx
-#endif // LYXTEXT_H
+#endif // TEXT_H
projects / lyx.git / blobdiff