X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxtext.h;h=8b0242bb3fb943a66a97e3abeff189192d7a4209;hb=37d42d45f3f4a5d3e916a080af50b37ae4a9d118;hp=66b12c3988b8b6758aaa5d8c5cb9a78f23dedf51;hpb=ce3710cdb58190c523ed23bc6389f5b14064aea6;p=lyx.git diff --git a/src/lyxtext.h b/src/lyxtext.h index 66b12c3988..8b0242bb3f 100644 --- a/src/lyxtext.h +++ b/src/lyxtext.h @@ -15,277 +15,217 @@ #define LYXTEXT_H #include "bufferview_funcs.h" -#include "layout.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 "RowList_fwd.h" -#include "textcursor.h" -#include "insets/inset.h" +#include class Buffer; class BufferParams; class BufferView; +class CursorSlice; class Dimension; +class InsetBase; +class InsetBase_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; -class WordLangTuple; -/** - 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 { +/// This class encapsulates the main text data and operations in LyX +class LyXText { public: - /// Constructor - LyXText(BufferView *, InsetText *, bool ininset, - ParagraphList & paragraphs); - - void init(BufferView *); /// - int height; + typedef lyx::pos_type pos_type; /// - unsigned int width; - /// the current font settings - LyXFont current_font; - /// the current font - LyXFont real_current_font; - /// our buffer's default layout font - LyXFont defaultfont_; -private: - /// offset of drawn area to document start. - int anchor_y_; -public: - /// update all cached row positions - void updateRowPositions(); - /// - InsetText * inset_owner; + typedef lyx::pit_type pit_type; + + /// constructor + explicit LyXText(BufferView *); /// - UpdatableInset * the_locking_inset; + void init(BufferView *); /// - int getRealCursorX() const; + LyXFont getFont(Paragraph const & par, pos_type pos) const; /// - LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const; + void applyOuterFont(LyXFont &) const; /// - LyXFont getLayoutFont(ParagraphList::iterator pit) const; + LyXFont getLayoutFont(pit_type pit) const; /// - LyXFont getLabelFont(ParagraphList::iterator pit) const; + LyXFont getLabelFont(Paragraph const & par) const; /// - 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(pit_type pit, pos_type pos, LyXFont const & font); + /// + void setCharFont(pit_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, bool keep_layout = false); - /** 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 + void setLayout(pit_type start, pit_type end, + std::string const & layout); /// - void setLayout(std::string const & layout); + void setLayout(LCursor & cur, std::string const & layout); - /** - * Increase or decrease the nesting depth of the selected paragraph(s) - * if test_only, don't change any depths. Returns whether something - * (would have) changed - */ - bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only); + /// 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(LCursor & cur, DEPTH_CHANGE type); - /// get the depth at current cursor position - int getDepth() const; + /// Returns whether something would be changed by changeDepth + bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) 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. - int redoParagraphs(ParagraphList::iterator begin, - ParagraphList::iterator end); /// rebreaks the given par - void redoParagraph(ParagraphList::iterator pit); + bool redoParagraph(pit_type pit); - /// rebreaks the cursor par - void redoParagraph(); -private: - /// rebreaks the given par, return max row width - int redoParagraphInternal(ParagraphList::iterator pit); -public: + /// 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(LyXFont const &, bool toggleall = false); + void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false); /// - std::string getStringToIndex(); + std::string getStringToIndex(LCursor const & 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(); /// compute text metrics void metrics(MetricsInfo & mi, Dimension & dim); - - /// - dispatch_result dispatch(FuncRequest const & cmd); - - BufferView * bv(); - + /// 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 + 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() const; - friend class LyXScreen; - -public: - /// only the top-level LyXText has this non-zero - BufferView * bv_owner; + /// 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 currentState(LCursor & cur); -private: - /// returns a pointer to a specified row. - RowList::iterator getRow(Paragraph & par, lyx::pos_type pos) const; -public: - /// returns an iterator pointing to a cursor row - RowList::iterator getRow(LyXCursor const & cursor) const; - /// convenience - RowList::iterator cursorRow() const; - /// 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; - - /** returns a pointer to the row near the specified y-coordinate - (relative to the whole text). y is set to the real beginning - of this row + /** returns row near the specified + * y-coordinate in given paragraph (relative to the screen). */ - RowList::iterator getRowNearY(int y, - ParagraphList::iterator & pit) const; + 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 */ - lyx::pos_type getColumnNearX(ParagraphList::iterator pit, + pos_type getColumnNearX(pit_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); - /** 'selects" the next word, where the cursor is not in - and returns this word as string. THe cursor will be moved - to the beginning of this word. - With SelectSelectedWord can this be highlighted really - */ - WordLangTuple const selectNextWordToSpellcheck(float & value); - /// - void selectSelectedWord(); - /// 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, pit_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 &, pit_type par, pos_type pos); /// - void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos, - bool setfont = true, bool boundary = false); + void setCursorIntern(LCursor & cur, pit_type par, + pos_type pos, bool setfont = true, bool boundary = false); /// - void setCurrentFont(); + void setCurrentFont(LCursor & cur); /// - bool isBoundary(Buffer const &, Paragraph const & par, - lyx::pos_type pos) const; - /// - bool isBoundary(Buffer const &, Paragraph const & par, - lyx::pos_type pos, LyXFont const & font) const; - - /// - void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const; - /// - void recUndo(lyx::paroffset_type first) const; - /// - void setCursorFromCoordinates(int x, int y); - /// - void setCursorFromCoordinates(LyXCursor &, int x, int y); - /// - void cursorUp(bool selecting = false); - /// - void cursorDown(bool selecting = false); + void recUndo(pit_type first, pit_type last) const; /// - void cursorLeft(bool internal = true); + void recUndo(pit_type first) const; + /// returns true if par was empty and was removed + bool setCursorFromCoordinates(LCursor & cur, int x, int y); /// - void cursorRight(bool internal = true); + InsetBase * editXY(LCursor & cur, int x, int y); + /// Move cursor one line up. + /** + * Returns true if an update is needed after the move. + */ + bool cursorUp(LCursor & cur); + /// Move cursor one line down. + /** + * Returns true if an update is needed after the move. + */ + 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); /// - void cursorLeftOneWord(); + bool cursorLeftOneWord(LCursor & cur); /// - void cursorRightOneWord(); + bool cursorRightOneWord(LCursor & cur); /// - void cursorUpParagraph(); + bool cursorUpParagraph(LCursor & cur); /// - void cursorDownParagraph(); + bool cursorDownParagraph(LCursor & cur); /// - void cursorHome(); + void cursorHome(LCursor & cur); /// - void cursorEnd(); + void cursorEnd(LCursor & cur); /// - void cursorPrevious(); + bool cursorPrevious(LCursor & cur); /// - void cursorNext(); + bool cursorNext(LCursor & cur); /// - void cursorTop(); + void cursorTop(LCursor & cur); /// - void cursorBottom(); + void cursorBottom(LCursor & cur); /// - void Delete(); + bool Delete(LCursor & cur); /// - void backspace(); + bool backspace(LCursor & cur); /// - bool selectWordWhenUnderCursor(lyx::word_location); + bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location); /// enum TextCase { /// @@ -296,27 +236,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. So I can make shure, they do not - duplicate themself (and you cannnot make dirty things with them! ) + settings are given to the new one. */ - void setParagraph(bool line_top, bool line_bottom, - bool pagebreak_top, bool pagebreak_bottom, - VSpace const & space_top, - VSpace const & space_bottom, + void setParagraph(LCursor & cur, Spacing const & spacing, LyXAlignment align, std::string const & labelwidthstring, @@ -324,181 +251,153 @@ 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); - - /// Find next inset of some specified type. - bool gotoNextInset(std::vector const & codes, - std::string const & contents = std::string()); - /// - void gotoInset(std::vector const & codes, - bool same_content); - /// - void gotoInset(InsetOld::Code code, bool same_content); + void insertStringAsParagraphs(LCursor & cur, std::string const & str); - /// - int workWidth() const; - - /// - void computeBidiTables(Paragraph const & par, - Buffer const &, Row & row) const; - /// Maps positions in the visual string to positions in logical string. - lyx::pos_type log2vis(lyx::pos_type pos) const; - /// Maps positions in the logical string to positions in visual string. - lyx::pos_type vis2log(lyx::pos_type pos) const; - /// - lyx::pos_type bidi_level(lyx::pos_type pos) const; - /// - bool bidi_InRange(lyx::pos_type pos) const; -private: - /// - float getCursorX(ParagraphList::iterator pit, - Row const & row, lyx::pos_type pos, - lyx::pos_type last, bool boundary) const; - /// used in setlayout - void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par); - - /// Calculate and set the height of the row - void setHeightOfRow(ParagraphList::iterator, 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); + /// current text width + int width() const; - /// delete double space (false) or empty paragraphs (true) around old_cursor - bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor); + /// current text heigth + int height() const; -public: - /** Updates all counters starting BEHIND the row. Changed paragraphs - * with a dynamic left margin will be rebroken. */ - void updateCounters(); - /** - * Returns an inset if inset was hit, or 0 if not. - * If hit, the coordinates are changed relative to the inset. - */ - InsetOld * checkInsetHit(int & x, int & y); + /// Returns an inset if inset was hit, or 0 if not. + InsetBase * checkInsetHit(int x, int y) const; /// - int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const; + int singleWidth(Paragraph const & par, pos_type pos) const; /// - int singleWidth(ParagraphList::iterator pit, - lyx::pos_type pos, char c, LyXFont const & Font) const; + int singleWidth(Paragraph const & par, + pos_type pos, char c, LyXFont const & Font) const; /// return the color of the canvas LColor_color backgroundColor() const; - /// - mutable bool bidi_same_direction; - - unsigned char transformChar(unsigned char c, Paragraph const & par, - lyx::pos_type pos) 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. */ - int leftMargin(ParagraphList::iterator pit, Row const & row) const; + int leftMargin(pit_type pit, pos_type pos) const; + int leftMargin(pit_type pit) const; /// - int rightMargin(Paragraph const & par, Buffer const &, Row const & row) 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; + RowMetrics computeRowMetrics(pit_type pit, Row const & row) const; + + /// access to our paragraphs + 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; + + /// is this row the last in the text? + bool isLastRow(pit_type pit, Row const & row) const; + /// is this row the first in the text? + bool isFirstRow(pit_type pit, Row const & row) const; -private: - /// - void setCounter(Buffer const &, ParagraphList::iterator pit); - /// - void deleteWordForward(); /// - void deleteWordBackward(); + 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 deleteLineForward(); + bool checkAndActivateInset(LCursor & cur, bool front); - /// sets row.end to the pos value *after* which a row should break. - /// for example, the pos after which isNewLine(pos) == true - lyx::pos_type rowBreakPoint(ParagraphList::iterator pit, - Row const & row) const; + /// + 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); - /// returns the minimum space a row needs on the screen in pixel - int fill(ParagraphList::iterator pit, Row & row, int workwidth) const; + /// + int ascent() const; + /// + int descent() const; + /// + int cursorX(CursorSlice const & cursor, bool boundary) const; + /// + int cursorY(CursorSlice const & cursor, bool boundary) const; - /** - * returns the minimum space a manual label needs on the - * screen in pixels - */ - int labelFill(ParagraphList::iterator pit, Row const & row) const; + /// delete double space or empty paragraphs around old cursor + bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old); - /// FIXME - int labelEnd(ParagraphList::iterator pit, Row const & row) const; + /// + friend class LyXScreen; +public: /// - mutable std::vector log2vis_list; + Dimension dim_; /// - mutable std::vector vis2log_list; + int maxwidth_; + /// the current font settings + LyXFont current_font; + /// the current font + LyXFont real_current_font; + /// our buffer's default layout font. This is textclass specific + /* This is actually never initialized! Should be replaced by a + * defaultfont() method that looks at the textclass (easy). [JMarc]*/ + LyXFont defaultfont_; /// - mutable std::vector bidi_levels; + int background_color_; + + /// only the top-level LyXText has this non-zero + BufferView * bv_owner; + /// - mutable lyx::pos_type bidi_start; + mutable Bidi bidi; /// - mutable lyx::pos_type bidi_end; + ParagraphList pars_; + + /// our 'outermost' font. This is handed down from the surrounding + // inset through the pi/mi parameter (pi.base.font) + LyXFont font_; /// - void charInserted(); -public: + bool autoBreakRows_; +private: + /// return past-the-last paragraph influenced by a layout + /// change on pit + pit_type undoSpan(pit_type pit); + + /// 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); + /// - bool in_inset_; + void deleteWordForward(LCursor & cur); /// - ParagraphList * paragraphs_; - // - // special owner functions + void deleteWordBackward(LCursor & cur); /// - ParagraphList & ownerParagraphs() const; + void deleteLineForward(LCursor & cur); - /// return true if this is owned by an inset. - bool isInInset() const; + /// 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; - /// 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; - - /// - std::string selectionAsString(Buffer const & buffer, bool label) const; -private: - /** Cursor related data. - Later this variable has to be removed. There should be now internal - cursor in a text */ /// - ///TextCursor cursor_; - /// prohibit this as long as there are back pointers... - LyXText(LyXText const &); + void charInserted(); + /// set 'number' font property + void number(LCursor & cur); }; /// return the default height of a row in pixels, considering font zoom -extern int defaultRowHeight(); +int defaultRowHeight(); #endif // LYXTEXT_H