// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file lyxtext.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+ * \author unknown
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
*
- * ====================================================== */
+ * 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 "textcursor.h"
class Buffer;
class BufferParams;
class BufferView;
class InsetText;
+class LyXCursor;
class Paragraph;
class Row;
class Spacing;
class VSpace;
class WordLangTuple;
class ParagraphList;
+class MetricsInfo;
+class Dimension;
/**
- 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.
*/
-class LyXText {
-public:
- /// what repainting is needed
- enum text_status {
- /// no repaint is needed
- UNCHANGED = 0,
- /**
- * A paint has caused a change in some rows
- * and rebreaking is needed.
- */
- CHANGED_IN_DRAW = 1,
- /// the refresh_row needs repainting
- NEED_VERY_LITTLE_REFRESH = 2,
- /// everything from refresh_y downwards needs repainting
- NEED_MORE_REFRESH = 3
- };
-
- ///
- enum word_location {
- // the word around the cursor, only if the cursor is
- //not at a boundary
- WHOLE_WORD_STRICT,
- // the word around the cursor
- WHOLE_WORD,
- /// the word begining from the cursor position
- PARTIAL_WORD,
- /// the word around the cursor or before the cursor
- PREVIOUS_WORD,
- /// the next word (not yet used)
- NEXT_WORD
- };
+// The inheritance from TextCursor should go. It's just there to ease
+// transition...
+class LyXText : public TextCursor {
+public:
/// Constructor
- LyXText(BufferView *);
- /// sets inset as owner
- LyXText(BufferView *, InsetText *);
-
- /// Destructor
- ~LyXText();
+ LyXText(BufferView *, InsetText *, bool ininset,
+ ParagraphList & paragraphs);
- void init(BufferView *, bool reinit = false);
+ void init(BufferView *);
///
int height;
///
LyXFont current_font;
/// the current font
LyXFont real_current_font;
+ /// our buffer's default layout font
+ LyXFont defaultfont_;
private:
- /** the 'anchor' row: the position of this row remains constant
- * with respect to the top of the screen
- */
- Row * anchor_row_;
- /** the pixel offset with respect to this row of top_y
- */
- int anchor_row_offset_;
+ /// offset of dran area to document start.
+ int anchor_y_;
public:
- /// 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(Row * row);
+ /// update all cached row positions
+ void updateRowPositions();
///
InsetText * inset_owner;
///
///
int getRealCursorX() const;
///
- LyXFont const getFont(Buffer const *, Paragraph * par,
- lyx::pos_type pos) const;
+ LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
///
- LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
+ LyXFont getLayoutFont(ParagraphList::iterator pit) const;
///
- LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
+ LyXFont getLabelFont(ParagraphList::iterator pit) const;
///
- void setCharFont(Buffer const *, Paragraph * par,
+ void setCharFont(ParagraphList::iterator pit,
lyx::pos_type pos, LyXFont const & font);
- void setCharFont(Paragraph * par,
- lyx::pos_type pos, LyXFont const & font, bool toggleall);
+ void setCharFont(ParagraphList::iterator pit,
+ lyx::pos_type pos,
+ LyXFont const & font, bool toggleall);
- /// return true if the row changed
- void markChangeInDraw(Row * row, Row * next);
- ///
- void breakAgainOneRow(Row * row);
/// what you expect when pressing <enter> at cursor position
void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
/** set layout over selection and make a total rebreak of
those paragraphs
*/
- Paragraph * setLayout(LyXCursor & actual_cursor,
- LyXCursor & selection_start,
- LyXCursor & selection_end,
- string const & layout);
+ ParagraphList::iterator
+ setLayout(LyXCursor & actual_cursor,
+ LyXCursor & selection_start,
+ LyXCursor & selection_end,
+ string const & layout);
///
void setLayout(string const & layout);
- /** increment depth over selection and make a total rebreak of those
- paragraphs
- */
- void incDepth();
-
- /** decrement depth over selection and make a total rebreak of those
- paragraphs */
- void decDepth();
+ /**
+ * 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);
/// get the depth at current cursor position
int getDepth() const;
*/
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,
- Paragraph const * end_par);
- ///
+ /// rebreaks all paragaphs between the given pars.
+ int redoParagraphs(ParagraphList::iterator begin,
+ ParagraphList::iterator end);
+ /// rebreaks the given par
+ void redoParagraph(ParagraphList::iterator pit);
+
+ /// rebreaks the cursor par
void redoParagraph();
+private:
+ /// rebreaks the given par, return max row width
+ int redoParagraphInternal(ParagraphList::iterator pit);
+public:
///
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();
-
/** 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 full rebreak
+ /// a full rebreak of the whole text
void fullRebreak();
+ /// compute text metrics
+ void metrics(MetricsInfo & mi, Dimension & dim);
///
- Row * need_break_row;
-
- /// clear any pending paints
- void clearPaint();
-
- /// post notice that we changed during a draw
- void postChangedInDraw();
-
- /**
- * Mark position y as the starting point for a repaint
- */
- void postPaint(int start_y);
-
- /**
- * Mark the given row at position y as needing a repaint.
- */
- void postRowPaint(Row * row, int start_y);
-
- ///
- Inset::RESULT dispatch(FuncRequest const & cmd);
+ InsetOld::RESULT dispatch(FuncRequest const & cmd);
BufferView * bv();
friend class LyXScreen;
- /**
- * Return the status. This represents what repaints are
- * pending after some operation (e.g. inserting a char).
- */
- text_status status() const;
+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;
+ /// convenience
+ RowList::iterator cursorRow() const;
/**
- * The pixel y position from which to repaint the screen.
- * The position is absolute along the height of outermost
- * lyxtext (I think). NEED_MORE_REFRESH and NEED_LITTLE_REFRESH
- * repaints both use this as a starting point (if it's within
- * the viewable portion of the lyxtext).
- */
- int refresh_y;
- /**
- * The row from which to repaint the screen, used by screen.c.
- * This must be set if the pending update is NEED_LITTLE_REFRESH.
- * It doesn't make any difference for NEED_MORE_REFRESH.
+ * 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...
*/
- Row * refresh_row;
-
- /// refresh status
- text_status status_;
+ RowList::iterator cursorIRow() const;
- /// only the top-level LyXText has this non-zero
- BufferView * bv_owner;
-
-public:
/** 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
*/
- Row * 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(Row * row,
- int & x, bool & boundary) const;
-
- /** returns a pointer to a specified row. y is set to the beginning
- of the row
- */
- Row * getRow(Paragraph * par, lyx::pos_type pos, int & y) const;
- /** returns the firstrow, this could be done with the above too but
- IMO it's stupid to have to allocate a dummy y all the time I need
- the first row
- */
- Row * firstRow() const { return firstrow; }
-
- /** The cursor.
- Later this variable has to be removed. There should be now internal
- cursor in a text (and thus not in a buffer). By keeping this it is
- (I think) impossible to have several views with the same buffer, but
- the cursor placed at different places.
- [later]
- Since the LyXText now has been moved from Buffer to BufferView
- it should not be absolutely needed to move the cursor...
- */
- LyXCursor cursor; // actual cursor position
-
- /** The structure that keeps track of the selections set. */
- struct Selection {
- Selection()
- : set_(false), mark_(false)
- {}
- bool set() const {
- return set_;
- }
- void set(bool s) {
- set_ = s;
- }
- bool mark() const {
- return mark_;
- }
- void mark(bool m) {
- mark_ = m;
- }
- LyXCursor cursor; // temporary cursor to hold a cursor position
- // until setSelection is called!
- LyXCursor start; // start of a REAL selection
- LyXCursor end; // end of a REAL selection
- private:
- bool set_; // former selection
- bool mark_; // former mark_set
-
- };
- Selection selection;
- // this is used to handle XSelection events in the right manner
- Selection xsel_cache;
-
- /// needed for the toggling (cursor position on last selection made)
- LyXCursor last_sel_cursor;
- /// needed for toggling the selection in screen.C
- LyXCursor toggle_cursor;
- /// needed for toggling the selection in screen.C
- LyXCursor toggle_end_cursor;
+ lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
+ RowList::iterator rit, int & x, bool & boundary) const;
/// need the selection cursor:
void setSelection();
///
void clearSelection();
- ///
- string const selectionAsString(Buffer const *, bool label) const;
/// select the word we need depending on word_location
- void getWord(LyXCursor & from, LyXCursor & to,
- word_location const);
+ void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
/// just selects the word the cursor is in
- void selectWord(word_location const);
+ 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();
WordLangTuple const selectNextWordToSpellcheck(float & value);
///
void selectSelectedWord();
+ /// re-computes the cached coordinates in the cursor
+ void redoCursor();
/// returns true if par was empty and was removed
- bool setCursor(Paragraph * par,
+ bool setCursor(ParagraphList::iterator pit,
lyx::pos_type pos,
bool setfont = true,
bool boundary = false);
///
- void setCursor(LyXCursor &, Paragraph * par,
+ void setCursor(LyXCursor &, ParagraphList::iterator pit,
lyx::pos_type pos,
bool boundary = false);
///
- void setCursorIntern(Paragraph * par,
+ void setCursorIntern(ParagraphList::iterator pit,
lyx::pos_type pos,
bool setfont = true,
bool boundary = false);
void setCurrentFont();
///
- bool isBoundary(Buffer const *, Paragraph * par,
+ bool isBoundary(Buffer const &, Paragraph const & par,
lyx::pos_type pos) const;
///
- bool isBoundary(Buffer const *, Paragraph * par,
+ bool isBoundary(Buffer const &, Paragraph const & par,
lyx::pos_type pos,
LyXFont const & font) const;
///
void cursorNext();
///
- void cursorTab();
- ///
void cursorTop();
///
void cursorBottom();
///
void backspace();
///
- bool selectWordWhenUnderCursor(word_location);
+ bool selectWordWhenUnderCursor(lyx::word_location);
///
enum TextCase {
///
};
/// Change the case of the word at cursor position.
void changeCase(TextCase action);
- ///
- void transposeChars();
///
void toggleInset();
///
void copySelection();
///
- void pasteSelection();
- ///
- void copyEnvironmentType();
- ///
- void pasteEnvironmentType();
+ void pasteSelection(size_t sel_index = 0);
/** the DTP switches for paragraphs. LyX will store the top settings
always in the first physical paragraph, the bottom settings in the
void insertStringAsParagraphs(string const & str);
/// Find next inset of some specified type.
- bool gotoNextInset(std::vector<Inset::Code> const & codes,
+ bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
string const & contents = string());
///
- void gotoInset(std::vector<Inset::Code> const & codes,
+ void gotoInset(std::vector<InsetOld::Code> 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 */
-
- /// returns false if inset wasn't found
- bool updateInset(Inset *);
- ///
- void checkParagraph(Paragraph * par, lyx::pos_type pos);
///
int workWidth() const;
- ///
- int workWidth(Inset * inset) const;
- ///
- void computeBidiTables(Buffer const *, Row * row) const;
+ ///
+ void computeBidiTables(ParagraphList::iterator pit,
+ Buffer const &, RowList::iterator row) const;
/// Maps positions in the visual string to positions in logical string.
- inline
- lyx::pos_type log2vis(lyx::pos_type pos) const {
- if (bidi_start == -1)
- return pos;
- else
- return log2vis_list[pos-bidi_start];
- }
-
+ lyx::pos_type log2vis(lyx::pos_type pos) const;
/// Maps positions in the logical string to positions in visual string.
- inline
- lyx::pos_type vis2log(lyx::pos_type pos) const {
- if (bidi_start == -1)
- return pos;
- else
- return vis2log_list[pos-bidi_start];
- }
- ///
- inline
- lyx::pos_type bidi_level(lyx::pos_type pos) const {
- if (bidi_start == -1)
- return 0;
- else
- return bidi_levels[pos-bidi_start];
- }
- ///
- inline
- bool bidi_InRange(lyx::pos_type pos) const {
- return bidi_start == -1 ||
- (bidi_start <= pos && pos <= bidi_end);
- }
-private:
- ///
- Row * firstrow;
+ lyx::pos_type vis2log(lyx::pos_type pos) const;
///
- Row * lastrow;
-
+ lyx::pos_type bidi_level(lyx::pos_type pos) const;
///
- void cursorLeftOneWord(LyXCursor &);
-
+ bool bidi_InRange(lyx::pos_type pos) const;
+private:
///
- float getCursorX(Row *, lyx::pos_type pos,
+ float getCursorX(ParagraphList::iterator pit,
+ RowList::iterator rit, lyx::pos_type pos,
lyx::pos_type last, bool boundary) const;
/// used in setlayout
- void makeFontEntriesLayoutSpecific(Buffer const &, Paragraph & par);
-
- /** forces the redrawing of a paragraph. Needed when manipulating a
- right address box
- */
- void redoDrawingOfParagraph(LyXCursor const & cursor);
+ void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
- /** Copybuffer for copy environment type.
- Asger has learned that this should be a buffer-property instead
- Lgb has learned that 'char' is a lousy type for non-characters
- */
- string copylayouttype;
-
- /** inserts a new row behind the specified row, increments
- the touched counters */
- void insertRow(Row * row, Paragraph * par, lyx::pos_type pos);
- /// removes the row and reset the touched counters
- void removeRow(Row * row);
-
- /// remove all following rows of the paragraph of the specified row.
- void removeParagraph(Row * row);
-
- /// insert the specified paragraph behind the specified row
- void insertParagraph(Paragraph * par, Row * row);
-
- /** appends the implizit specified paragraph behind the specified row,
- * start at the implizit given position */
- void appendParagraph(Row * row);
-
- ///
- void breakAgain(Row * row);
/// Calculate and set the height of the row
- void setHeightOfRow(Row * row_ptr);
+ void setHeightOfRow(ParagraphList::iterator, RowList::iterator rit);
// 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(LyXCursor & cur, LyXCursor const & where);
/// delete double space (false) or empty paragraphs (true) around old_cursor
bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
/** Updates all counters starting BEHIND the row. Changed paragraphs
* with a dynamic left margin will be rebroken. */
void updateCounters();
- ///
- void update(bool changed = true);
/**
* 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);
+ InsetOld * checkInsetHit(int & x, int & y);
///
- int singleWidth(Paragraph * par,
- lyx::pos_type pos) const;
+ int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
///
- int singleWidth(Paragraph * par,
- lyx::pos_type pos, char c) const;
+ 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;
///
mutable bool bidi_same_direction;
- unsigned char transformChar(unsigned char c, Paragraph * par,
+ unsigned char transformChar(unsigned char c, Paragraph const & par,
lyx::pos_type pos) const;
/**
* 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 leftMargin(ParagraphList::iterator pit, Row const & row) const;
///
- int rightMargin(Buffer const &, Row const & row) const;
+ int rightMargin(ParagraphList::iterator pit, Buffer const &, Row const & row) const;
/** this calculates the specified parameters. needed when setting
* the cursor and when creating a visible row */
- void prepareToPrint(Row * row, float & x,
- float & fill_separator,
- float & fill_hfill,
- float & fill_label_hfill,
- bool bidi = true) const;
+ void prepareToPrint(ParagraphList::iterator pit,
+ RowList::iterator row) const;
private:
///
- void setCounter(Buffer const *, Paragraph * par);
+ void setCounter(Buffer const &, ParagraphList::iterator pit);
///
void deleteWordForward();
///
*/
- /// 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;
+ /// 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;
/// returns the minimum space a row needs on the screen in pixel
- int fill(Row & row, int workwidth) const;
+ int fill(ParagraphList::iterator pit,
+ RowList::iterator 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;
+ int labelEnd(ParagraphList::iterator pit, Row const & row) const;
///
mutable std::vector<lyx::pos_type> log2vis_list;
-
///
mutable std::vector<lyx::pos_type> vis2log_list;
-
///
mutable std::vector<lyx::pos_type> bidi_levels;
-
///
mutable lyx::pos_type bidi_start;
-
///
mutable lyx::pos_type bidi_end;
+ ///
+ const bool in_inset_;
+ ///
+ ParagraphList & paragraphs_;
+
///
void charInserted();
public:
//
// special owner functions
///
- Paragraph * ownerParagraph() const;
- //
- void ownerParagraph(Paragraph *) const;
- // set it searching first for the right owner using the paragraph id
- void ownerParagraph(int id, Paragraph *) const;
+ ParagraphList & ownerParagraphs() const;
/// return true if this is owned by an inset.
bool isInInset() 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;
+
+ ///
+ bool noRows() const;
+
+private:
+ /** Cursor related data.
+ Later this variable has to be removed. There should be now internal
+ cursor in a text */
+ ///
+ ///TextCursor cursor_;
};
/// return the default height of a row in pixels, considering font zoom