X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxtext.h;h=949566c3e04f633500e58e9d714c3f08be4ba61c;hb=80296aac5015662a4c23ee7a818d5fde34f363bd;hp=b7249fed6f59f8905036ce54047c2452d76116df;hpb=99b64f351e737f9593e96d247b256377f62ca5a5;p=lyx.git diff --git a/src/lyxtext.h b/src/lyxtext.h index b7249fed6f..949566c3e0 100644 --- a/src/lyxtext.h +++ b/src/lyxtext.h @@ -8,98 +8,72 @@ * \author Lars Gullik Bjønnes * \author John Levon * - * Full author contact details are available in file CREDITS + * Full author contact details are available in file CREDITS. */ #ifndef LYXTEXT_H #define LYXTEXT_H -#include "lyxfont.h" -#include "lyxcursor.h" -#include "layout.h" -#include "LColor.h" -#include "insets/inset.h" -#include "RowList.h" #include "bufferview_funcs.h" +#include "Bidi.h" +#include "layout.h" +#include "lyxfont.h" +#include "lyxtextclass.h" +#include "ParagraphList_fwd.h" +#include "RowList_fwd.h" #include "textcursor.h" +#include "insets/inset.h" + +#include + class Buffer; class BufferParams; class BufferView; -class InsetText; +class Dimension; +class LColor_color; +class LyXCursor; +class MetricsInfo; class Paragraph; class Row; class Spacing; class UpdatableInset; class VSpace; -class WordLangTuple; -class ParagraphList; /** - This class holds the mapping between buffer paragraphs and screen rows. + 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 public: /// Constructor - LyXText(BufferView *); - /// sets inset as owner - LyXText(BufferView *, InsetText *); - - void init(BufferView *); - /// - int height; - /// - unsigned int width; - /// the current font settings - LyXFont current_font; - /// the current font - LyXFont real_current_font; -private: - /** the 'anchor' row: the position of this row remains constant - * with respect to the top of the screen - */ - RowList::iterator anchor_row_; - /** the pixel offset with respect to this row of top_y - */ - int anchor_row_offset_; -public: - /// update all cached row positions - void updateRowPositions(); - /// get the y coord. of the top of the screen (relative to doc start) - int top_y() const; - /// set the y coord. of the top of the screen (relative to doc start) - void top_y(int newy); - /// set the anchoring row. top_y will be computed relative to this - void anchor_row(RowList::iterator rit); + LyXText(BufferView *, bool ininset); /// - InsetText * inset_owner; - /// - UpdatableInset * the_locking_inset; + void init(BufferView *); + + /// update y coordinate cache of all paragraphs + void updateParPositions(); /// - int getRealCursorX() const; - /// - LyXFont const getFont(Buffer const *, ParagraphList::iterator pit, - lyx::pos_type pos) const; + LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const; /// - LyXFont const getLayoutFont(Buffer const *, - ParagraphList::iterator pit) const; + LyXFont getLayoutFont(ParagraphList::iterator pit) const; /// - LyXFont const getLabelFont(Buffer const *, - ParagraphList::iterator pit) const; + LyXFont getLabelFont(ParagraphList::iterator pit) const; /// - void setCharFont(Buffer const *, ParagraphList::iterator pit, + 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 breakAgainOneRow(RowList::iterator rit); /// what you expect when pressing at cursor position void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0); @@ -107,19 +81,17 @@ public: those paragraphs */ ParagraphList::iterator - setLayout(LyXCursor & actual_cursor, - LyXCursor & selection_start, - LyXCursor & selection_end, - string const & layout); + setLayout(ParagraphList::iterator start, + ParagraphList::iterator end, + std::string const & layout); /// - void setLayout(string const & layout); + void setLayout(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); + /// Increase or decrease the nesting depth of the selected paragraph(s) + void changeDepth(bv_funcs::DEPTH_CHANGE type); + + /// Returns whether something would be changed by changeDepth + bool changeDepthAllowed(bv_funcs::DEPTH_CHANGE type); /// get the depth at current cursor position int getDepth() const; @@ -130,53 +102,37 @@ public: */ void setFont(LyXFont const &, bool toggleall = false); - /** deletes and inserts again all paragaphs between the cursor - and the specified par. The Cursor is needed to set the refreshing - parameters. - This function is needed after SetLayout and SetFont etc. - */ - void redoParagraphs(LyXCursor const & cursor, - ParagraphList::iterator endpit); - /// + /// rebreaks all paragaphs between the given pars. + void redoParagraphs(ParagraphList::iterator begin, + ParagraphList::iterator end); + /// rebreaks the given par + void redoParagraph(ParagraphList::iterator pit); + + /// rebreaks the cursor par void redoParagraph(); /// void toggleFree(LyXFont const &, bool toggleall = false); /// - string getStringToIndex(); - - /** recalculates the heights of all previous rows of the - specified paragraph. needed, if the last characters font - has changed. - */ - void redoHeightOfParagraph(); + std::string getStringToIndex(); /** 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(Inset * inset); + void insertInset(InsetOld * inset); - /// Completes the insertion with a rebreak from 'need_break_row' on - void partialRebreak(); /// a full rebreak of the whole text void fullRebreak(); - /// rebuild RowList cache - void rebuild(int maxwidth); - - /// - RowList::iterator need_break_row; - - /// clear any pending paints - void clearPaint(); + /// compute text metrics + void metrics(MetricsInfo & mi, Dimension & dim); + /// draw text (only used for insets) + void draw(PainterInfo & pi, int x, int y) const; - /// submit repaint request - void postPaint(); - - /// - Inset::RESULT dispatch(FuncRequest const & cmd); + /// try to handle that request + DispatchResult dispatch(FuncRequest const & cmd); BufferView * bv(); @@ -184,59 +140,29 @@ public: friend class LyXScreen; - /** - * Return the status. This represents what repaints are - * pending after some operation (e.g. inserting a char). - */ - bool needRefresh() const; - -private: - // do we need a refresh? - bool need_refresh_; - -public: - /// only the top-level LyXText has this non-zero - BufferView * bv_owner; - -private: - /// returns a pointer to a specified row. - RowList::iterator - getRow(ParagraphList::iterator pit, lyx::pos_type pos) const; -public: - /// returns a pointer cursor row - RowList::iterator getRow(LyXCursor const & cursor) 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; + /// RowList::iterator cursorRow() const; - /** - * Return the next row, when cursor is at the end of the - * previous row, for insets that take a full row. - * - * FIXME: explain why we need this ? especially for y... - */ - RowList::iterator cursorIRow() 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 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) const; + RowList::iterator getRowNearY(int y, + ParagraphList::iterator & 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(RowList::iterator rit, - int & x, bool & boundary) const; - - /** returns a pointer to a specified row. y is set to the beginning - of the row - */ - RowList::iterator - getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const; - - RowList & rows() const { - return rowlist_; - } - + lyx::pos_type getColumnNearX(ParagraphList::iterator pit, + Row const & row, int & x, bool & boundary) const; /// need the selection cursor: void setSelection(); @@ -248,7 +174,7 @@ public: /// just selects the word the cursor is in void selectWord(lyx::word_location loc); /// returns the inset at cursor (if it exists), 0 otherwise - Inset * getInset() const; + InsetOld * getInset() const; /// accept selected change void acceptChange(); @@ -256,52 +182,36 @@ public: /// reject selected change void rejectChange(); - /** '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(); + void setCursor(ParagraphList::iterator pit, lyx::pos_type pos); /// returns true if par was empty and was removed - bool setCursor(ParagraphList::iterator pit, - lyx::pos_type pos, - bool setfont = true, - bool boundary = false); + bool setCursor(lyx::paroffset_type par, lyx::pos_type pos, + bool setfont = true, bool boundary = false); /// - void setCursor(LyXCursor &, ParagraphList::iterator pit, - lyx::pos_type pos, - bool boundary = false); + void setCursor(LyXCursor &, lyx::paroffset_type par, + lyx::pos_type pos, bool boundary = false); /// - void setCursorIntern(ParagraphList::iterator pit, - lyx::pos_type pos, - bool setfont = true, - bool boundary = false); + void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos, + bool setfont = true, bool boundary = false); /// void setCurrentFont(); /// - bool isBoundary(Buffer const *, Paragraph const & par, - lyx::pos_type pos) const; + void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const; /// - bool isBoundary(Buffer const *, Paragraph const & par, - lyx::pos_type pos, - LyXFont const & font) const; - + void recUndo(lyx::paroffset_type first) const; /// void setCursorFromCoordinates(int x, int y); /// - void setCursorFromCoordinates(LyXCursor &, - int x, int y); + void setCursorFromCoordinates(LyXCursor &, int x, int y); /// void cursorUp(bool selecting = false); /// void cursorDown(bool selecting = false); /// - void cursorLeft(bool internal = true); + bool cursorLeft(bool internal = true); /// - void cursorRight(bool internal = true); + bool cursorRight(bool internal = true); /// void cursorLeftOneWord(); /// @@ -340,8 +250,8 @@ public: /// Change the case of the word at cursor position. void changeCase(TextCase action); - /// - void toggleInset(); + /// returns success + bool toggleInset(); /// void cutSelection(bool doclear = true, bool realcut = true); /// @@ -352,16 +262,12 @@ public: /** 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( Spacing const & spacing, LyXAlignment align, - string const & labelwidthstring, + std::string const & labelwidthstring, bool noindent); /* these things are for search and replace */ @@ -375,135 +281,187 @@ public: /** simple replacing. The font of the first selected character is used */ - void replaceSelectionWithString(string const & str); + void replaceSelectionWithString(std::string const & str); /// needed to insert the selection - void insertStringAsLines(string const & str); + void insertStringAsLines(std::string const & str); /// needed to insert the selection - void insertStringAsParagraphs(string const & str); + void insertStringAsParagraphs(std::string const & str); /// Find next inset of some specified type. - bool gotoNextInset(std::vector const & codes, - string const & contents = string()); + bool gotoNextInset(std::vector const & codes, + std::string const & contents = std::string()); /// - void gotoInset(std::vector const & codes, + void gotoInset(std::vector const & codes, bool same_content); /// - void gotoInset(Inset::Code code, bool same_content); - /// + void gotoInset(InsetOld::Code code, bool same_content); - /* for the greater insets */ + /// current max text width + int textWidth() const; - /// returns false if inset wasn't found - bool updateInset(Inset *); - /// - void checkParagraph(ParagraphList::iterator pit, lyx::pos_type pos); - /// - int workWidth() const; - /// returns width of row containing inset - int workWidth(Inset const * inset) const; + /// updates all counters + void updateCounters(); + /// Returns an inset if inset was hit, or 0 if not. + InsetOld * checkInsetHit(int x, int y); /// - void computeBidiTables(Buffer const *, RowList::iterator 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: + int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const; /// - mutable RowList rowlist_; + int singleWidth(ParagraphList::iterator pit, + lyx::pos_type pos, char c, LyXFont const & Font) const; + + /// return the color of the canvas + LColor_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. + */ + int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const; + int leftMargin(ParagraphList::iterator pit) const; /// - float getCursorX(RowList::iterator rit, lyx::pos_type pos, - lyx::pos_type last, bool boundary) const; - /// used in setlayout - void makeFontEntriesLayoutSpecific(Buffer const &, Paragraph & par); + int rightMargin(Paragraph const & par) const; - /** forces the redrawing of a paragraph. Needed when manipulating a - right address box - */ - void redoDrawingOfParagraph(LyXCursor const & cursor); + /** this calculates the specified parameters. needed when setting + * the cursor and when creating a visible row */ + void prepareToPrint(ParagraphList::iterator pit, Row & row) const; - /// removes the row and reset the touched counters - void removeRow(RowList::iterator rit); + // + // special owner functions + /// + ParagraphList & paragraphs() const; - /// remove all following rows of the paragraph of the specified row. - void removeParagraph(RowList::iterator rit); + /// return true if this is owned by an inset. + bool isInInset() const; - /// insert the specified paragraph behind the specified row - void insertParagraph(ParagraphList::iterator pit, - RowList::iterator rowit); + /// + 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; - /** appends the implizit specified paragraph behind the specified row, - * start at the implizit given position */ - void appendParagraph(RowList::iterator rowit); + /// is this row the last in the text? + bool isLastRow(ParagraphList::iterator pit, Row const & row) const; + /// is this row the first in the text? + bool isFirstRow(ParagraphList::iterator pit, Row const & row) const; /// - void breakAgain(RowList::iterator rit); - /// Calculate and set the height of the row - void setHeightOfRow(RowList::iterator rit); + std::string selectionAsString(Buffer const & buffer, bool label) const; + /// + double spacing(Paragraph const &) const; + /// + void cursorLeftOneWord(LyXCursor &); + /// + void cursorRightOneWord(LyXCursor &); - // fix the cursor `cur' after a characters has been deleted at `where' - // position. Called by deleteEmptyParagraphMechanism - void fixCursorAfterDelete(LyXCursor & cur, - LyXCursor const & where); + /// + DispatchResult moveRight(); + /// + DispatchResult moveLeft(); + /// + DispatchResult moveRightIntern(bool front, + bool activate_inset, bool selecting); + /// + DispatchResult moveLeftIntern(bool front, + bool activate_inset, bool selecting); + /// + DispatchResult moveUp(); + /// + DispatchResult moveDown(); + /// + bool checkAndActivateInset(bool front); - /// delete double space (false) or empty paragraphs (true) around old_cursor - bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor); + /// + 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); -public: - /** Updates all counters starting BEHIND the row. Changed paragraphs - * with a dynamic left margin will be rebroken. */ - void updateCounters(); /// - void update(); - /** - * Returns an inset if inset was hit, or 0 if not. - * If hit, the coordinates are changed relative to the inset. - */ - Inset * checkInsetHit(int & x, int & y); + int ascent() const; + /// + int descent() const; + /// + int cursorX() const; + /// + int cursorY() const; + /// + int cursorX(LyXCursor const & cursor) const; + /// + int cursorY(LyXCursor const & cursor) const; +public: /// - int singleWidth(ParagraphList::iterator pit, - lyx::pos_type pos) const; + int height; /// - int singleWidth(ParagraphList::iterator pit, - lyx::pos_type pos, char c) const; + unsigned int width; + /// + int textwidth_; + /// 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_; - /// return the color of the canvas - LColor::color backgroundColor() const; + /// only the top-level LyXText has this non-zero + BufferView * bv_owner; /// - mutable bool bidi_same_direction; + mutable Bidi bidi; + /// + bool in_inset_; + /// + ParagraphList paragraphs_; - unsigned char transformChar(unsigned char c, Paragraph const & par, - lyx::pos_type pos) const; + /// absolute document pixel coordinates of this LyXText + mutable int xo_; + mutable int yo_; - /** - * 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(Row const & row) const; - /// - int rightMargin(Buffer const &, Row const & row) const; + /// our 'outermost' Font + LyXFont font_; - /** this calculates the specified parameters. needed when setting - * the cursor and when creating a visible row */ - void prepareToPrint(RowList::iterator row, int & x, - int & fill_separator, - int & fill_hfill, - int & fill_label_hfill, - bool bidi = true) const; private: + /// return past-the-last paragraph influenced by a layout + /// change on pit + ParagraphList::iterator undoSpan(ParagraphList::iterator pit); + + /// rebreaks the given par + void redoParagraphInternal(ParagraphList::iterator pit); + /// 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); + + /// delete double space (false) or empty paragraphs (true) around old_cursor + bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor); + /// - void setCounter(Buffer const *, ParagraphList::iterator pit); + void setCounter(Buffer const &, ParagraphList::iterator pit); /// void deleteWordForward(); /// @@ -511,58 +469,35 @@ private: /// void deleteLineForward(); - /* - * some low level functions - */ - + /// 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; - /// return the pos value *before* which a row should break. - /// for example, the pos at which IsNewLine(pos) == true - lyx::pos_type rowBreakPoint(Row const & row) const; - - /// returns the minimum space a row needs on the screen in pixel - int fill(RowList::iterator row, int workwidth) 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(Row const & row) const; + int labelFill(ParagraphList::iterator pit, Row const & row) const; /// FIXME - int labelEnd(Row const & row) const; - - /// - mutable std::vector log2vis_list; - /// - mutable std::vector vis2log_list; - /// - mutable std::vector bidi_levels; - /// - mutable lyx::pos_type bidi_start; - /// - mutable lyx::pos_type bidi_end; + int labelEnd(ParagraphList::iterator pit) const; /// void charInserted(); -public: - // - // special owner functions - /// - ParagraphList & ownerParagraphs() const; - - /// return true if this is owned by an inset. - bool isInInset() const; - -private: - /** Cursor related data. - Later this variable has to be removed. There should be now internal - cursor in a text */ - /// - ///TextCursor cursor_; + /// set 'number' font property + void number(); + /// is the cursor paragraph right-to-left? + bool rtl() const; }; /// return the default height of a row in pixels, considering font zoom extern int defaultRowHeight(); +/// +std::string expandLabel(LyXTextClass const & textclass, + LyXLayout_ptr const & layout, bool appendix); + #endif // LYXTEXT_H