X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Flyxtext.h;h=7a489ac934bdb36a29690cf38f1f524c702a2055;hb=f67fd3cb29b4e57c4a28ec1e94a47be4799d343c;hp=a32331a35c836f6f7a197e60ba4d6ae64d1920b4;hpb=7de76711b14a4c0bcdf5770885be8efc59cac264;p=lyx.git diff --git a/src/lyxtext.h b/src/lyxtext.h index a32331a35c..7a489ac934 100644 --- a/src/lyxtext.h +++ b/src/lyxtext.h @@ -16,113 +16,100 @@ #include "bufferview_funcs.h" #include "Bidi.h" -#include "layout.h" +#include "dispatchresult.h" #include "lyxfont.h" -#include "lyxtextclass.h" +#include "layout.h" +#include "lyxlayout_ptr_fwd.h" #include "ParagraphList_fwd.h" -#include "RowList_fwd.h" -#include "textcursor.h" -#include "insets/inset.h" +#include class Buffer; class BufferParams; class BufferView; +class CursorSlice; class Dimension; +class InsetBase; +class InsetOld_code; +class FuncRequest; +class FuncStatus; class LColor_color; -class InsetText; -class LyXCursor; +class LCursor; +class LyXTextClass; class MetricsInfo; -class Paragraph; +class PainterInfo; class Row; +class RowMetrics; class Spacing; -class UpdatableInset; -class VSpace; -/** - This class used to hold the mapping between buffer paragraphs and - screen rows. Nowadays, the Paragraphs take care of their rows - themselves and this contains just most of the code for manipulating - them and interaction with the Cursor. - */ - -// The inheritance from TextCursor should go. It's just there to ease -// transition... -class LyXText : public TextCursor { - // Public Functions +/// This class encapsulates the main text data and operations in LyX +class LyXText { public: - /// Constructor - LyXText(BufferView *, InsetText *, bool ininset, ParagraphList & plist); /// - void init(BufferView *); + typedef lyx::pos_type pos_type; + /// + typedef lyx::par_type par_type; + /// constructor + explicit LyXText(BufferView *); + /// + void init(BufferView *); /// update y coordinate cache of all paragraphs void updateParPositions(); /// - LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const; + LyXFont getFont(par_type pit, pos_type pos) const; + /// + LyXFont getLayoutFont(par_type pit) const; /// - LyXFont getLayoutFont(ParagraphList::iterator pit) const; + LyXFont getLabelFont(par_type pit) const; /// - LyXFont getLabelFont(ParagraphList::iterator pit) const; + void setCharFont(par_type pit, pos_type pos, LyXFont const & font); /// - void setCharFont(ParagraphList::iterator pit, - lyx::pos_type pos, LyXFont const & font); - void setCharFont(ParagraphList::iterator pit, - lyx::pos_type pos, - LyXFont const & font, bool toggleall); + void setCharFont(par_type pit, pos_type pos, LyXFont const & font, + bool toggleall); /// what you expect when pressing at cursor position - void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0); + void breakParagraph(LCursor & cur, char keep_layout = 0); - /** set layout over selection and make a total rebreak of - those paragraphs - */ - ParagraphList::iterator - setLayout(LyXCursor & actual_cursor, - LyXCursor & selection_start, - LyXCursor & selection_end, - std::string const & layout); + /// set layout over selection + par_type setLayout(par_type start, par_type end, + std::string const & layout); /// - void setLayout(std::string const & layout); + void setLayout(LCursor & cur, std::string const & layout); + /// what type of depth change to make + enum DEPTH_CHANGE { + INC_DEPTH, + DEC_DEPTH + }; /// Increase or decrease the nesting depth of the selected paragraph(s) - void changeDepth(bv_funcs::DEPTH_CHANGE type); + void changeDepth(LCursor & cur, DEPTH_CHANGE type); /// Returns whether something would be changed by changeDepth - bool changeDepthAllowed(bv_funcs::DEPTH_CHANGE type); + bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const; - /// get the depth at current cursor position - int getDepth() const; - - /** set font over selection and make a total rebreak of those - paragraphs. - toggleall defaults to false. - */ - void setFont(LyXFont const &, bool toggleall = false); + /// Set font over selection paragraphs and rebreak. + void setFont(LCursor & cur, LyXFont const &, bool toggleall = false); /// rebreaks all paragaphs between the given pars. - void redoParagraphs(ParagraphList::iterator begin, - ParagraphList::iterator end); + void redoParagraphs(par_type begin, par_type end); /// rebreaks the given par - void redoParagraph(ParagraphList::iterator pit); - + void redoParagraph(par_type pit); /// rebreaks the cursor par - void redoParagraph(); + void redoParagraph(LCursor & cur); /// - void toggleFree(LyXFont const &, bool toggleall = false); + void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false); /// - std::string getStringToIndex(); + std::string getStringToIndex(LCursor & cur); - /** insert a character, moves all the following breaks in the - same Paragraph one to the right and make a little rebreak - */ - void insertChar(char c); - /// - void insertInset(InsetOld * inset); + /// insert a character at cursor position + void insertChar(LCursor & cur, char c); + /// insert an inset at cursor position + void insertInset(LCursor & cur, InsetBase * inset); /// a full rebreak of the whole text void fullRebreak(); @@ -130,116 +117,108 @@ public: void metrics(MetricsInfo & mi, Dimension & dim); /// draw text (only used for insets) void draw(PainterInfo & pi, int x, int y) const; - - /// - DispatchResult dispatch(FuncRequest const & cmd); - + /// draw textselection + void drawSelection(PainterInfo & pi, int x, int y) const; + /// returns distance of this cell to the point given by x and y + // assumes valid position and size cache + int dist(int x, int y) const; + + /// try to handle that request + 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; - friend class LyXScreen; - - /// returns an iterator pointing to a cursor paragraph - ParagraphList::iterator getPar(LyXCursor const & cursor) const; - /// - ParagraphList::iterator getPar(lyx::paroffset_type par) const; - /// - int parOffset(ParagraphList::iterator pit) const; - /// convenience - ParagraphList::iterator cursorPar() const; - /// - RowList::iterator cursorRow() const; + /// access to individual paragraphs + Paragraph & getPar(par_type par) const; + // Returns the current font and depth as a message. + std::string LyXText::currentState(LCursor & cur); /** returns an iterator pointing to the row near the specified * y-coordinate (relative to the whole text). y is set to the * real beginning of this row */ - RowList::iterator getRowNearY(int y, - ParagraphList::iterator & pit) const; + Row const & getRowNearY(int y, par_type & pit) const; /** returns the column near the specified x-coordinate of the row x is set to the real beginning of this column */ - lyx::pos_type getColumnNearX(ParagraphList::iterator pit, + pos_type getColumnNearX(par_type pit, Row const & row, int & x, bool & boundary) const; - /// need the selection cursor: - void setSelection(); - /// - void clearSelection(); - - /// select the word we need depending on word_location - void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location 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, lyx::word_location const); /// just selects the word the cursor is in - void selectWord(lyx::word_location loc); - /// returns the inset at cursor (if it exists), 0 otherwise - InsetOld * getInset() const; + void selectWord(LCursor & cur, lyx::word_location loc); /// accept selected change - void acceptChange(); - + void acceptChange(LCursor & cur); /// reject selected change - void rejectChange(); + void rejectChange(LCursor & cur); - /// re-computes the cached coordinates in the cursor - void redoCursor(); - /// - void setCursor(ParagraphList::iterator pit, lyx::pos_type pos); /// returns true if par was empty and was removed - bool setCursor(lyx::paroffset_type par, lyx::pos_type pos, + bool setCursor(LCursor & cur, par_type par, pos_type pos, bool setfont = true, bool boundary = false); /// - void setCursor(LyXCursor &, lyx::paroffset_type par, - lyx::pos_type pos, bool boundary = false); + void setCursor(CursorSlice &, par_type par, + pos_type pos, bool boundary = false); /// - void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos, - bool setfont = true, bool boundary = false); + void setCursorIntern(LCursor & cur, par_type par, + pos_type pos, bool setfont = true, bool boundary = false); /// - void setCurrentFont(); + void setCurrentFont(LCursor & cur); /// - void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const; + void recUndo(par_type first, par_type last) const; /// - void recUndo(lyx::paroffset_type first) const; + void recUndo(par_type first) const; /// - void setCursorFromCoordinates(int x, int y); + void setCursorFromCoordinates(LCursor & cur, int x, int y); /// - void setCursorFromCoordinates(LyXCursor &, int x, int y); + InsetBase * editXY(LCursor & cur, int x, int y); /// - void cursorUp(bool selecting = false); + void cursorUp(LCursor & cur); /// - void cursorDown(bool selecting = false); + void cursorDown(LCursor & cur); /// - bool cursorLeft(bool internal = true); + void cursorLeft(LCursor & cur); /// - bool cursorRight(bool internal = true); + void cursorRight(LCursor & cur); /// - void cursorLeftOneWord(); + void cursorLeftOneWord(LCursor & cur); /// - void cursorRightOneWord(); + void cursorRightOneWord(LCursor & cur); /// - void cursorUpParagraph(); + void cursorUpParagraph(LCursor & cur); /// - void cursorDownParagraph(); + void cursorDownParagraph(LCursor & cur); /// - void cursorHome(); + void cursorHome(LCursor & cur); /// - void cursorEnd(); + void cursorEnd(LCursor & cur); /// - void cursorPrevious(); + void cursorPrevious(LCursor & cur); /// - void cursorNext(); + void cursorNext(LCursor & cur); /// - void cursorTop(); + void cursorTop(LCursor & cur); /// - void cursorBottom(); + void cursorBottom(LCursor & cur); /// - void Delete(); + void Delete(LCursor & cur); /// - void backspace(); + void backspace(LCursor & cur); /// - bool selectWordWhenUnderCursor(lyx::word_location); + bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location); /// enum TextCase { /// @@ -250,23 +229,14 @@ public: text_uppercase = 2 }; /// Change the case of the word at cursor position. - void changeCase(TextCase action); - - /// - void toggleInset(); - /// - void cutSelection(bool doclear = true, bool realcut = true); - /// - void copySelection(); - /// - void pasteSelection(size_t sel_index = 0); + void changeCase(LCursor & cur, TextCase action); /** the DTP switches for paragraphs. LyX will store the top settings 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. */ - void setParagraph( + void setParagraph(LCursor & cur, Spacing const & spacing, LyXAlignment align, std::string const & labelwidthstring, @@ -274,44 +244,37 @@ public: /* these things are for search and replace */ - /** - * Sets the selection from the current cursor position to length - * characters to the right. No safety checks. - */ - void setSelectionRange(lyx::pos_type length); - - /** simple replacing. The font of the first selected character - is used - */ - void replaceSelectionWithString(std::string const & str); - /// needed to insert the selection - void insertStringAsLines(std::string const & str); + void insertStringAsLines(LCursor & cur, std::string const & str); /// needed to insert the selection - void insertStringAsParagraphs(std::string const & str); + void insertStringAsParagraphs(LCursor & cur, std::string const & str); /// Find next inset of some specified type. - bool gotoNextInset(std::vector const & codes, - std::string const & contents = std::string()); + bool gotoNextInset(LCursor & cur, + std::vector const & codes, + std::string const & contents = std::string()); /// - void gotoInset(std::vector const & codes, - bool same_content); + void gotoInset(LCursor & cur, + std::vector const & codes, bool same_content); /// - void gotoInset(InsetOld::Code code, bool same_content); + void gotoInset(LCursor & cur, InsetOld_code code, bool same_content); - /// current max text width - int textWidth() const; + /// 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. - InsetOld * checkInsetHit(int x, int y); + InsetBase * checkInsetHit(int x, int y); /// - int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const; + int singleWidth(par_type pit, pos_type pos) const; /// - int singleWidth(ParagraphList::iterator pit, - lyx::pos_type pos, char c, LyXFont const & Font) const; + int singleWidth(par_type pit, + pos_type pos, char c, LyXFont const & Font) const; /// return the color of the canvas LColor_color backgroundColor() const; @@ -322,82 +285,61 @@ public: * in LaTeX the beginning of the text fits in some cases * (for example sections) exactly the label-width. */ - int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const; - int leftMargin(ParagraphList::iterator pit) const; + int leftMargin(par_type pit, pos_type pos) const; + int leftMargin(par_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 */ - void prepareToPrint(ParagraphList::iterator pit, Row & row) const; - - // - // special owner functions - /// - ParagraphList & ownerParagraphs() const; + RowMetrics computeRowMetrics(par_type pit, Row const & row) const; - /// return true if this is owned by an inset. - bool isInInset() const; + /// access to our paragraphs + ParagraphList & paragraphs() const; + /// return true if this is the main text + bool isMainText() const; - /// - ParagraphList::iterator firstPar() const; - /// - ParagraphList::iterator lastPar() const; - /// - ParagraphList::iterator endPar() const; - /// return first row of text - RowList::iterator firstRow() const; - /// return last row of text - RowList::iterator lastRow() const; - /// return row "behind" last row of text - RowList::iterator endRow() const; - /// return next row crossing paragraph boundaries - void nextRow(ParagraphList::iterator & pit, - RowList::iterator & rit) const; - /// return previous row crossing paragraph boundaries - void previousRow(ParagraphList::iterator & pit, - RowList::iterator & rit) const; + Row const & firstRow() const; /// is this row the last in the text? - bool isLastRow(ParagraphList::iterator pit, Row const & row) const; + bool isLastRow(par_type pit, Row const & row) const; /// is this row the first in the text? - bool isFirstRow(ParagraphList::iterator pit, Row const & row) const; + bool isFirstRow(par_type pit, Row const & row) const; /// - std::string selectionAsString(Buffer const & buffer, bool label) const; - /// - double spacing(Paragraph const &) const; - /// - void cursorLeftOneWord(LyXCursor &); + double spacing(Paragraph const & par) const; + /// make a suggestion for a label + std::string getPossibleLabel(LCursor & cur) const; + /// is this paragraph right-to-left? + bool isRTL(Paragraph const & par) const; /// - void cursorRightOneWord(LyXCursor &); + bool checkAndActivateInset(LCursor & cur, bool front); /// - DispatchResult moveRight(); - /// - DispatchResult moveLeft(); - /// - DispatchResult moveRightIntern(bool front, - bool activate_inset, bool selecting); + 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); + /// - DispatchResult moveLeftIntern(bool front, - bool activate_inset, bool selecting); + int ascent() const; /// - DispatchResult moveUp(); + int descent() const; /// - DispatchResult moveDown(); + int cursorX(CursorSlice const & cursor) const; /// - bool checkAndActivateInset(bool front); + int cursorY(CursorSlice const & cursor) const; + /// + friend class LyXScreen; public: /// - int height; + unsigned int width_; /// - unsigned int width; + int maxwidth_; /// - int textwidth_; + int height_; /// the current font settings LyXFont current_font; /// the current font @@ -405,7 +347,7 @@ public: /// our buffer's default layout font LyXFont defaultfont_; /// - InsetText * inset_owner; + int background_color_; /// only the top-level LyXText has this non-zero BufferView * bv_owner; @@ -413,73 +355,66 @@ public: /// mutable Bidi bidi; /// - bool in_inset_; - /// - ParagraphList * paragraphs_; + ParagraphList pars_; /// absolute document pixel coordinates of this LyXText mutable int xo_; mutable int yo_; + /// our 'outermost' Font + LyXFont font_; private: - /// rebreaks the given par - void redoParagraphInternal(ParagraphList::iterator pit); + /// return past-the-last paragraph influenced by a layout + /// change on pit + par_type undoSpan(par_type pit); - /// - float getCursorX(ParagraphList::iterator pit, - Row const & row, lyx::pos_type pos, bool boundary) const; + /// rebreaks the given par + void redoParagraphInternal(par_type pit); /// used in setlayout void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par); /// Calculate and set the height of the row - void setHeightOfRow(ParagraphList::iterator, Row & row); + void setHeightOfRow(par_type, Row & row); // fix the cursor `cur' after a characters has been deleted at `where' // position. Called by deleteEmptyParagraphMechanism - void fixCursorAfterDelete(LyXCursor & cur, LyXCursor const & where); + void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where); - /// delete double space (false) or empty paragraphs (true) around old_cursor - bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor); + /// delete double space or empty paragraphs around old cursor + bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor const & old); /// - void setCounter(Buffer const &, ParagraphList::iterator pit); + void setCounter(Buffer const &, par_type pit); /// - void deleteWordForward(); + void deleteWordForward(LCursor & cur); /// - void deleteWordBackward(); + void deleteWordBackward(LCursor & cur); /// - void deleteLineForward(); + 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(ParagraphList::iterator pit, Row & row) const; - - /// sets row.witdh to the minimum space a row needs on the screen in pixel - void fill(ParagraphList::iterator pit, Row & row, int workwidth) const; - - /** - * returns the minimum space a manual label needs on the - * screen in pixels - */ - int labelFill(ParagraphList::iterator pit, Row const & row) const; - + void rowBreakPoint(par_type pit, Row & row) const; + /// sets row.width to the minimum space a row needs on the screen in pixel + void setRowWidth(par_type pit, Row & row) const; + /// the minimum space a manual label needs on the screen in pixels + int labelFill(par_type pit, Row const & row) const; /// FIXME - int labelEnd(ParagraphList::iterator pit) const; + int labelEnd(par_type pit) const; /// void charInserted(); /// set 'number' font property - void number(); - /// is the cursor paragraph right-to-left? - bool rtl() const; + void number(LCursor & cur); }; /// return the default height of a row in pixels, considering font zoom -extern int defaultRowHeight(); +int defaultRowHeight(); /// std::string expandLabel(LyXTextClass const & textclass, LyXLayout_ptr const & layout, bool appendix); + #endif // LYXTEXT_H