X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxtext.h;h=897808cca860789ac90c57995140309b4efb7b67;hb=80328d2053869dc089c23c25adbed4167d7bf0b1;hp=07b4765bd077b3a047ffca18a0b34969a8c472fc;hpb=70bcd97d455a510aa465058a86239e0d99ff66d0;p=lyx.git diff --git a/src/lyxtext.h b/src/lyxtext.h index 07b4765bd0..897808cca8 100644 --- a/src/lyxtext.h +++ b/src/lyxtext.h @@ -14,30 +14,30 @@ #ifndef LYXTEXT_H #define LYXTEXT_H -#include "bufferview_funcs.h" #include "Bidi.h" #include "dispatchresult.h" -#include "dimension.h" #include "lyxfont.h" #include "layout.h" #include "lyxlayout_ptr_fwd.h" -#include "ParagraphList_fwd.h" +#include "ParagraphList.h" #include + +namespace lyx { + class Buffer; class BufferParams; class BufferView; class CursorSlice; -class Dimension; -class InsetBase; -class InsetBase_code; +class DocIterator; +class ErrorList; class FuncRequest; class FuncStatus; +class InsetBase; class LColor_color; class LCursor; class LyXTextClass; -class MetricsInfo; class PainterInfo; class Row; class RowMetrics; @@ -47,35 +47,34 @@ class Spacing; /// This class encapsulates the main text data and operations in LyX class LyXText { public: - /// - typedef lyx::pos_type pos_type; - /// - typedef lyx::pit_type pit_type; - /// constructor - explicit LyXText(BufferView *); - /// - void init(BufferView *); + explicit LyXText(); /// - LyXFont getFont(Paragraph const & par, pos_type pos) const; + LyXFont getFont(Buffer const & buffer, Paragraph const & par, + pos_type pos) const; /// - LyXFont getLayoutFont(pit_type pit) const; + void applyOuterFont(Buffer const & buffer, LyXFont &) const; /// - LyXFont getLabelFont(Paragraph const & par) const; + LyXFont getLayoutFont(Buffer const & buffer, pit_type pit) const; /// - void setCharFont(pit_type pit, pos_type pos, LyXFont const & font); + LyXFont getLabelFont(Buffer const & buffer, + Paragraph const & par) const; /// - void setCharFont(pit_type pit, pos_type pos, LyXFont const & font, - bool toggleall); + void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos, + LyXFont const & font); + /// + void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos, + LyXFont const & font, bool toggleall); /// what you expect when pressing at cursor position - void breakParagraph(LCursor & cur, char keep_layout = 0); + void breakParagraph(LCursor & cur, bool keep_layout = false); /// set layout over selection - pit_type setLayout(pit_type start, pit_type end, + void setLayout(Buffer const & buffer, pit_type start, pit_type end, std::string const & layout); - /// + /// Set given layout to current cursor position. + /// FIXME: replace LCursor with DocIterator. void setLayout(LCursor & cur, std::string const & layout); /// what type of depth change to make @@ -84,135 +83,172 @@ public: DEC_DEPTH }; /// Increase or decrease the nesting depth of the selected paragraph(s) + /// FIXME: replace LCursor with DocIterator. void changeDepth(LCursor & cur, DEPTH_CHANGE type); /// Returns whether something would be changed by changeDepth + /// FIXME: replace LCursor with DocIterator. bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const; /// Set font over selection paragraphs and rebreak. + /// FIXME: replace LCursor with DocIterator. void setFont(LCursor & cur, LyXFont const &, bool toggleall = false); - /// rebreaks the given par - void redoParagraph(pit_type pit); - - /// returns pos in given par at given x coord - pos_type x2pos(pit_type pit, int row, int x) const; - int pos2x(pit_type pit, pos_type pos) const; - /// void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false); - /// - std::string getStringToIndex(LCursor & cur); + /// ??? + /// FIXME: replace LCursor with DocIterator. + docstring getStringToIndex(LCursor const & cur); /// insert a character at cursor position - void insertChar(LCursor & cur, char c); + /// FIXME: replace LCursor with DocIterator. + void insertChar(LCursor & cur, char_type c); /// insert an inset at cursor position + /// FIXME: replace LCursor with DocIterator. void insertInset(LCursor & cur, InsetBase * inset); - /// compute text metrics - void metrics(MetricsInfo & mi, Dimension & dim); /// 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 LCursor with DocIterator. void dispatch(LCursor & cur, FuncRequest & cmd); /// do we want to handle this event? bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus & status) const; - /// access to out BufferView. This should go... - BufferView * bv(); - /// access to out BufferView. This should go... - BufferView * bv() const; - - /// access to individual paragraphs - Paragraph & getPar(pit_type par) const; + /// read-only access to individual paragraph + Paragraph const & getPar(pit_type pit) const { return pars_[pit]; } + /// read-write access to individual paragraph + Paragraph & getPar(pit_type pit) { return pars_[pit]; } // Returns the current font and depth as a message. - std::string LyXText::currentState(LCursor & cur); + /// FIXME: replace LCursor with DocIterator. + docstring currentState(LCursor & cur); /** returns row near the specified * y-coordinate in given paragraph (relative to the screen). */ - Row const & getRowNearY(int y, pit_type pit) const; - pit_type getPitNearY(int y) const; - - /** returns the column near the specified x-coordinate of the row - x is set to the real beginning of this column - */ - pos_type getColumnNearX(pit_type pit, - Row const & row, int & x, bool & boundary) const; + /// 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 and why this + /// method is non-const. + /// FIXME: move to TextMetrics. + pit_type getPitNearY(BufferView & bv, int y); /** 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, lyx::word_location const); + void getWord(CursorSlice & from, CursorSlice & to, word_location const); /// just selects the word the cursor is in - void selectWord(LCursor & cur, lyx::word_location loc); + void selectWord(LCursor & cur, word_location loc); - /// accept selected change - void acceptChange(LCursor & cur); - /// reject selected change - void rejectChange(LCursor & cur); + /// what type of change operation to make + enum ChangeOp { + ACCEPT, + REJECT + }; + /// accept or reject the selected change + void acceptOrRejectChanges(LCursor & cur, ChangeOp op); + /// accept the changes within the complete LyXText + void acceptChanges(BufferParams const & bparams); + /// reject the changes within the complete LyXText + void rejectChanges(BufferParams const & bparams); /// returns true if par was empty and was removed bool setCursor(LCursor & cur, pit_type par, pos_type pos, bool setfont = true, bool boundary = false); /// - void setCursor(CursorSlice &, pit_type par, - pos_type pos, bool boundary = false); + void setCursor(CursorSlice &, pit_type par, pos_type pos); /// void setCursorIntern(LCursor & cur, pit_type par, - pos_type pos, bool setfont = true, bool boundary = false); + pos_type pos, bool setfont = true, bool boundary = false); /// void setCurrentFont(LCursor & cur); /// - void recUndo(pit_type first, pit_type last) const; - /// - void recUndo(pit_type first) const; + void recUndo(LCursor & cur, pit_type first, pit_type last) const; /// + void recUndo(LCursor & cur, pit_type first) const; + + /// sets cursor only within this LyXText. + /// x,y are screen coordinates void setCursorFromCoordinates(LCursor & cur, int x, int y); + + /// sets cursor recursively descending into nested editable insets + /** + \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. + InsetBase * editXY(LCursor & cur, int x, int y); + + /// Move cursor one line up. + /** + * Returns true if an update is needed after the move. + */ + /// FIXME: move to TextMetrics. + bool cursorUp(LCursor & cur); + /// Move cursor one line down. + /** + * Returns true if an update is needed after the move. + */ + /// FIXME: move to TextMetrics. + bool cursorDown(LCursor & cur); + /// Move cursor one position left + /** + * Returns true if an update is needed after the move. + */ + bool cursorLeft(LCursor & cur); + /// Move cursor one position right + /** + * Returns true if an update is needed after the move. + */ + bool cursorRight(LCursor & cur); /// - InsetBase * editXY(LCursor & cur, int x, int y) const; - /// - void cursorUp(LCursor & cur); - /// - void cursorDown(LCursor & cur); - /// - void cursorLeft(LCursor & cur); - /// - void cursorRight(LCursor & cur); - /// - void cursorLeftOneWord(LCursor & cur); + bool cursorLeftOneWord(LCursor & cur); /// - void cursorRightOneWord(LCursor & cur); + bool cursorRightOneWord(LCursor & cur); /// - void cursorUpParagraph(LCursor & cur); + bool cursorUpParagraph(LCursor & cur); /// - void cursorDownParagraph(LCursor & cur); + bool cursorDownParagraph(LCursor & cur); /// - void cursorHome(LCursor & cur); + /// FIXME: move to TextMetrics. + bool cursorHome(LCursor & cur); /// - void cursorEnd(LCursor & cur); + /// FIXME: move to TextMetrics. + bool cursorEnd(LCursor & cur); /// void cursorPrevious(LCursor & cur); /// void cursorNext(LCursor & cur); /// - void cursorTop(LCursor & cur); + bool cursorTop(LCursor & cur); /// - void cursorBottom(LCursor & cur); + bool cursorBottom(LCursor & cur); + /// Erase character at cursor. Honour change tracking + /// FIXME: replace LCursor with DocIterator. + bool erase(LCursor & cur); + /// Delete character before cursor. Honour CT + /// FIXME: replace LCursor with DocIterator. + bool backspace(LCursor & cur); + // Dissolve the inset under cursor + /// FIXME: replace LCursor with DocIterator. + bool dissolveInset(LCursor & cur); /// - void Delete(LCursor & cur); - /// - void backspace(LCursor & cur); - /// - bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location); + bool selectWordWhenUnderCursor(LCursor & cur, word_location); /// enum TextCase { /// @@ -224,6 +260,8 @@ public: }; /// Change the case of the word at cursor position. void changeCase(LCursor & cur, TextCase action); + /// Transposes the character at the cursor with the one before it + void charsTranspose(LCursor & cur); /** the DTP switches for paragraphs. LyX will store the top settings always in the first physical paragraph, the bottom settings in the @@ -233,42 +271,29 @@ public: void setParagraph(LCursor & cur, Spacing const & spacing, LyXAlignment align, - std::string const & labelwidthstring, + docstring const & labelwidthstring, bool noindent); /* these things are for search and replace */ /// needed to insert the selection - void insertStringAsLines(LCursor & cur, std::string const & str); + /// FIXME: replace LCursor with DocIterator. + void insertStringAsLines(LCursor & cur, docstring const & str); /// needed to insert the selection - void insertStringAsParagraphs(LCursor & cur, std::string const & str); + /// FIXME: replace LCursor with DocIterator. + void insertStringAsParagraphs(LCursor & cur, docstring const & str); - /// Find next inset of some specified type. - bool gotoNextInset(LCursor & cur, - std::vector const & codes, - std::string const & contents = std::string()); - /// - void gotoInset(LCursor & cur, - std::vector const & codes, bool same_content); - /// - void gotoInset(LCursor & cur, InsetBase_code code, bool same_content); - - /// current text width - int width() const; - - /// current text heigth - int height() const; - - /// updates all counters - void updateCounters(); /// Returns an inset if inset was hit, or 0 if not. - InsetBase * checkInsetHit(int x, int y) const; + InsetBase * checkInsetHit(BufferView &, int x, int y); /// - int singleWidth(Paragraph const & par, pos_type pos) const; + /// FIXME: move to TextMetrics. + int singleWidth(Buffer const &, Paragraph const & par, + pos_type pos) const; /// - int singleWidth(Paragraph const & par, - pos_type pos, char c, LyXFont const & Font) const; + /// FIXME: move to TextMetrics. + int singleWidth(Paragraph const & par, pos_type pos, char_type c, + LyXFont const & Font) const; /// return the color of the canvas LColor_color backgroundColor() const; @@ -279,77 +304,73 @@ public: * in LaTeX the beginning of the text fits in some cases * (for example sections) exactly the label-width. */ - int leftMargin(pit_type pit, pos_type pos) const; - int leftMargin(pit_type pit) const; - /// - int rightMargin(Paragraph const & par) const; - - /** this calculates the specified parameters. needed when setting - * the cursor and when creating a visible row */ - RowMetrics computeRowMetrics(pit_type pit, Row const & row) const; + /// 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; /// access to our paragraphs - ParagraphList & paragraphs() const; + ParagraphList const & paragraphs() const { return pars_; } + ParagraphList & paragraphs() { return pars_; } /// return true if this is the main text - bool isMainText() const; - - /// return first row of text - Row const & firstRow() const; + 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; /// - double spacing(Paragraph const & par) const; + double spacing(Buffer const & buffer, Paragraph const & par) const; /// make a suggestion for a label - std::string getPossibleLabel(LCursor & cur) const; + /// FIXME: replace LCursor with DocIterator. + docstring getPossibleLabel(LCursor & cur) const; /// is this paragraph right-to-left? - bool isRTL(Paragraph const & par) const; + bool isRTL(Buffer const &, Paragraph const & par) const; /// bool checkAndActivateInset(LCursor & 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, LyXLex & lex); + bool read(Buffer const & buf, LyXLex & lex, ErrorList & errorList); /// - int ascent() const; - /// - int descent() const; + /// FIXME: move to TextMetrics. + int cursorX(BufferView const &, CursorSlice const & cursor, + bool boundary) const; /// - int cursorX(CursorSlice const & cursor) const; - /// - int cursorY(CursorSlice const & cursor) const; + /// FIXME: move to TextMetrics. + int cursorY(BufferView const & bv, CursorSlice const & cursor, + bool boundary) const; - /// - friend class LyXScreen; + /// 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 LCursor with DocIterator. This is not possible right + /// now because recordUndo() is called which needs a LCursor. + static bool deleteEmptyParagraphMechanism(LCursor & cur, + LCursor & old, bool & need_anchor_change); + + /// delete double spaces, leading spaces, and empty paragraphs + /// from \first to \last paragraph + void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges); public: - /// - Dimension dim_; - /// - int maxwidth_; /// the current font settings LyXFont current_font; /// the current font LyXFont real_current_font; - /// our buffer's default layout font - LyXFont defaultfont_; /// int background_color_; - /// only the top-level LyXText has this non-zero - BufferView * bv_owner; - /// mutable Bidi bidi; /// ParagraphList pars_; - /// our 'outermost' Font + /// our 'outermost' font. This is handed down from the surrounding + // inset through the pi/mi parameter (pi.base.font) LyXFont font_; /// @@ -359,50 +380,32 @@ private: /// change on pit pit_type undoSpan(pit_type pit); - /// used in setlayout - void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par); - - /// Calculate and set the height of the row - void setHeightOfRow(pit_type, Row & row); - // fix the cursor `cur' after a characters has been deleted at `where' // position. Called by deleteEmptyParagraphMechanism - void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where); + static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where); - /// delete double space or empty paragraphs around old cursor - bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor const & old); + // 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(LCursor & cur); - /// - void setCounter(Buffer const &, pit_type pit); /// void deleteWordForward(LCursor & cur); /// void deleteWordBackward(LCursor & cur); /// void deleteLineForward(LCursor & cur); - - /// sets row.end to the pos value *after* which a row should break. - /// for example, the pos after which isNewLine(pos) == true - void rowBreakPoint(pit_type pit, Row & row) const; - /// sets row.width to the minimum space a row needs on the screen in pixel - void setRowWidth(pit_type pit, Row & row) const; - /// the minimum space a manual label needs on the screen in pixels - int labelFill(Paragraph const & par, Row const & row) const; - /// FIXME - int labelEnd(pit_type pit) const; - /// void charInserted(); /// set 'number' font property void number(LCursor & cur); -}; - -/// return the default height of a row in pixels, considering font zoom -int defaultRowHeight(); -/// -std::string expandLabel(LyXTextClass const & textclass, - LyXLayout_ptr const & layout, bool appendix); + /// paste plain text at current cursor. + /// \param str string to paste + /// \param asParagraphs whether to paste as paragraphs or as lines + void pasteString(LCursor & cur, docstring const & str, + bool asParagraphs); +}; +} // namespace lyx #endif // LYXTEXT_H