]> git.lyx.org Git - lyx.git/blobdiff - src/lyxtext.h
hopefully fix tex2lyx linking.
[lyx.git] / src / lyxtext.h
index 882f340571c7cc1d2e08d6c76ccf265034c92ef7..5bf93d8278def4cd6aa4c2fee3d53d6eeb340f40 100644 (file)
 #include "lyxfont.h"
 #include "layout.h"
 #include "lyxlayout_ptr_fwd.h"
-#include "ParagraphList_fwd.h"
+#include "ParagraphList.h"
 
 #include <iosfwd>
 
+
+namespace lyx {
+
 class Buffer;
 class BufferParams;
 class BufferView;
 class CursorSlice;
 class Dimension;
+class ErrorList;
 class InsetBase;
 class InsetBase_code;
 class FuncRequest;
@@ -47,35 +51,33 @@ 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 *);
+       explicit LyXText(BufferView * bv = 0);
        ///
        void init(BufferView *);
 
        ///
-       LyXFont getFont(Paragraph const & par, pos_type pos) const;
+       LyXFont getFont(Buffer const & buffer, Paragraph const & par,
+               pos_type pos) const;
        ///
-       void applyOuterFont(LyXFont &) const;
+       void applyOuterFont(Buffer const & buffer, LyXFont &) const;
        ///
-       LyXFont getLayoutFont(pit_type pit) const;
+       LyXFont getLayoutFont(Buffer const & buffer, pit_type pit) const;
        ///
-       LyXFont getLabelFont(Paragraph const & par) const;
+       LyXFont getLabelFont(Buffer const & buffer,
+               Paragraph const & par) const;
        ///
-       void setCharFont(pit_type pit, pos_type pos, LyXFont const & font);
+       void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
+               LyXFont const & font);
        ///
-       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, bool toggleall);
 
        /// what you expect when pressing <enter> at cursor position
        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);
        ///
        void setLayout(LCursor & cur, std::string const & layout);
@@ -94,21 +96,23 @@ public:
        /// Set font over selection paragraphs and rebreak.
        void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
 
-       /// rebreaks the given par
-       bool redoParagraph(pit_type pit);
+       /// Rebreaks the given paragraph.
+       /// \retval true if a full screen redraw is needed.
+       /// \retval false if a single paragraph redraw is enough.
+       bool redoParagraph(BufferView &, pit_type pit);
 
        /// returns pos in given par at given x coord
-       pos_type x2pos(pit_type pit, int row, int x) const;
+       pos_type x2pos(BufferView const &, 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 const & cur);
+       docstring getStringToIndex(LCursor const & cur);
 
        /// insert a character at cursor position
-       void insertChar(LCursor & cur, char c);
+       void insertChar(LCursor & cur, char_type c);
        /// insert an inset at cursor position
        void insertInset(LCursor & cur, InsetBase * inset);
 
@@ -125,26 +129,24 @@ public:
        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);
+       std::string 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;
+       Row const & getRowNearY(BufferView const & bv, int y,
+               pit_type pit) const;
+       pit_type getPitNearY(BufferView const & bv, 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,
+       pos_type getColumnNearX(BufferView const & bv, pit_type pit,
                Row const & row, int & x, bool & boundary) const;
 
        /** Find the word under \c from in the relative location
@@ -152,9 +154,9 @@ public:
         *  @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);
@@ -165,22 +167,28 @@ public:
        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 setCursorFromCoordinates(LCursor & cur, int x, int y);
+       void recUndo(LCursor & cur, pit_type first, pit_type last) const;
        ///
+       void recUndo(LCursor & cur, pit_type first) const;
+       /// returns true if par was empty and was removed
+       bool 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
+       */
        InsetBase * editXY(LCursor & cur, int x, int y);
+       
        /// Move cursor one line up.
        /**
         * Returns true if an update is needed after the move.
@@ -210,23 +218,30 @@ public:
        ///
        bool cursorDownParagraph(LCursor & cur);
        ///
-       void cursorHome(LCursor & cur);
+       bool cursorHome(LCursor & cur);
        ///
-       void cursorEnd(LCursor & cur);
+       bool cursorEnd(LCursor & cur);
        ///
        bool cursorPrevious(LCursor & cur);
        ///
        bool cursorNext(LCursor & cur);
        ///
-       void cursorTop(LCursor & cur);
+       bool cursorTop(LCursor & cur);
        ///
-       void cursorBottom(LCursor & cur);
-       ///
-       void Delete(LCursor & cur);
-       ///
-       void backspace(LCursor & cur);
+       bool cursorBottom(LCursor & cur);
+       /// Erase character at cursor. Honour change tracking
+       bool erase(LCursor & cur);
+       /** At cursor position 0, merge paragraph with the one before it.
+        * Ignore CT (this is used in \c acceptChange, \c rejectChange for
+        * physical deletion of paragraph break)
+        */
+       bool backspacePos0(LCursor & cur);
+       /// Delete character before cursor. Honour CT
+       bool backspace(LCursor & cur);
+       // Dissolve the inset under cursor
+       bool dissolveInset(LCursor & cur);
        ///
-       bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location);
+       bool selectWordWhenUnderCursor(LCursor & cur, word_location);
        ///
        enum TextCase {
                ///
@@ -238,6 +253,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
@@ -247,15 +264,15 @@ 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);
+       void insertStringAsLines(LCursor & cur, docstring const & str);
        /// needed to insert the selection
-       void insertStringAsParagraphs(LCursor & cur, std::string const & str);
+       void insertStringAsParagraphs(LCursor & cur, docstring const & str);
 
        /// current text width
        int width() const;
@@ -264,13 +281,14 @@ public:
        int height() const;
 
        /// Returns an inset if inset was hit, or 0 if not.
-       InsetBase * checkInsetHit(int x, int y) const;
+       InsetBase * checkInsetHit(BufferView const &, int x, int y) const;
 
        ///
-       int singleWidth(Paragraph const & par, pos_type pos) const;
+       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;
+       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;
@@ -281,19 +299,21 @@ 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 leftMargin(Buffer const &, pit_type pit, pos_type pos) const;
+       int leftMargin(Buffer const &, pit_type pit) const;
        ///
-       int rightMargin(Paragraph const & par) const;
+       int rightMargin(Buffer const &, 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;
+       RowMetrics computeRowMetrics(Buffer const &, pit_type pit,
+               Row const & row) 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;
+       bool isMainText(Buffer const &) const;
 
        /// return first row of text
        Row const & firstRow() const;
@@ -304,30 +324,31 @@ public:
        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;
+       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;
        ///
-       int cursorX(CursorSlice const & cursor) const;
+       int cursorX(Buffer const &, CursorSlice const & cursor,
+               bool boundary) const;
        ///
-       int cursorY(CursorSlice const & cursor) const;
+       int cursorY(CursorSlice const & cursor, bool boundary) const;
 
-       ///
-       friend class LyXScreen;
+       /// delete double space or empty paragraphs around old cursor
+       bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old);
 
 public:
        ///
@@ -338,14 +359,9 @@ public:
        LyXFont current_font;
        /// the current font
        LyXFont real_current_font;
-       /// our buffer's default layout font. This is textclass specific
-       LyXFont defaultfont_;
        ///
        int background_color_;
 
-       /// only the top-level LyXText has this non-zero
-       BufferView * bv_owner;
-
        ///
        mutable Bidi bidi;
        ///
@@ -362,19 +378,13 @@ 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);
+       void setHeightOfRow(BufferView const &, 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);
 
-       /// delete double space or empty paragraphs around old cursor
-       bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor const & old);
-
        ///
        void deleteWordForward(LCursor & cur);
        ///
@@ -384,13 +394,14 @@ private:
 
        /// 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;
+       void rowBreakPoint(Buffer const &, int right_margin, 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;
+       void setRowWidth(Buffer const &, 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;
+       int labelFill(Buffer const &, Paragraph const & par, Row const & row) const;
        /// FIXME
-       int labelEnd(pit_type pit) const;
+       int labelEnd(Buffer const &, pit_type pit) const;
 
        ///
        void charInserted();
@@ -401,4 +412,7 @@ private:
 /// return the default height of a row in pixels, considering font zoom
 int defaultRowHeight();
 
+
+} // namespace lyx
+
 #endif // LYXTEXT_H