X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FText.h;h=2174984b2352fef7f2405786c80dcd3712e6720a;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=f7c9d9d24fe34a89bd339f698eb6036b5fff3ff8;hpb=de15c267e3e5a3ec5e64c4afef50ab9b6fe64cb5;p=lyx.git diff --git a/src/Text.h b/src/Text.h index f7c9d9d24f..2174984b23 100644 --- a/src/Text.h +++ b/src/Text.h @@ -5,7 +5,7 @@ * 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. @@ -14,77 +14,77 @@ #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 - - namespace lyx { class Buffer; class BufferParams; class BufferView; +class CompletionList; +class Cursor; class CursorSlice; class DocIterator; class ErrorList; +class Font; +class FontInfo; class FuncRequest; class FuncStatus; class Inset; -class Color_color; -class Cursor; +class Lexer; class PainterInfo; -class Row; -class RowMetrics; class Spacing; - -/// 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 { +private: + /// Default constructor. + Text(InsetText * owner, bool use_default_layout); + + /// Copy constructor. + Text(InsetText * owner, Text const & text); + public: - /// constructor - explicit Text(); + /// \return true if there's no content at all. + /// \warning a non standard layout on an empty paragraph doesn't + // 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; - /// - Font getLayoutFont(Buffer const & buffer, pit_type pit) const; + FontInfo layoutFont(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 \ 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, - std::string const & layout); - /// Set given layout to current cursor position. - /// FIXME: replace Cursor with DocIterator. - void setLayout(Cursor & cur, std::string const & layout); + void setLayout(pit_type start, pit_type end, + docstring const & layout); + /// 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 enum DEPTH_CHANGE { @@ -103,9 +103,8 @@ public: /// 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, DocIterator const & begin, - DocIterator 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); @@ -114,6 +113,31 @@ public: /// FIXME: replace Cursor with DocIterator. docstring getStringToIndex(Cursor const & 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. void insertChar(Cursor & cur, char_type c); @@ -121,11 +145,6 @@ public: /// 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); @@ -139,32 +158,21 @@ public: 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; + docstring currentState(Cursor const & cur) 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); - + /// select all text + void selectAll(Cursor & cur); + /// convenience function get the previous word or an empty string + docstring previousWord(CursorSlice const & sl) const; + /// what type of change operation to make enum ChangeOp { ACCEPT, @@ -173,69 +181,56 @@ public: /// 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); /// @@ -251,17 +246,8 @@ public: bool dissolveInset(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); @@ -269,88 +255,46 @@ public: always in the first physical paragraph, the bottom settings in the last. When a paragraph is broken, the top settings rest, the bottom settings are given to the new one. + This function will handle a multi-paragraph selection. */ - void setParagraph(Cursor & cur, - Spacing const & spacing, - LyXAlignment align, - docstring const & labelwidthstring, - bool noindent); + void setParagraphs(Cursor & cur, docstring arg, bool modify = false); + /// Sets parameters for current or selected paragraphs + void setParagraphs(Cursor & 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(Cursor 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; + bool isRTL(Paragraph const & par) 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. @@ -363,29 +307,45 @@ public: /// from \first to \last paragraph 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_; - - /// - mutable Bidi bidi; - /// - ParagraphList pars_; + /// 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; + /// + bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/); + /// + 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; - /// our 'outermost' font. This is handed down from the surrounding - // inset through the pi/mi parameter (pi.base.font) - Font font_; - - /// - bool autoBreakRows_; private: - /// return past-the-last paragraph influenced by a layout - /// change on pit - pit_type undoSpan(pit_type pit); + /// The InsetText owner shall have access to everything. + friend class InsetText; // fix the cursor `cur' after a characters has been deleted at `where' // position. Called by deleteEmptyParagraphMechanism @@ -396,15 +356,10 @@ private: bool backspacePos0(Cursor & cur); /// handle the case where bibitems were deleted bool handleBibitems(Cursor & cur); - - /// - void deleteWordForward(Cursor & cur); - /// - void deleteWordBackward(Cursor & cur); + /// are we in a list item (description etc.)? + bool inDescriptionItem(Cursor & cur) const; /// - void deleteLineForward(Cursor & cur); - /// - void charInserted(); + void charInserted(Cursor & cur); /// set 'number' font property void number(Cursor & cur); @@ -413,8 +368,43 @@ private: /// \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