* \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 "bufferview_funcs.h"
+#include "Bidi.h"
+#include "dispatchresult.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"
+#include "lyxlayout_ptr_fwd.h"
+#include "ParagraphList_fwd.h"
+
+#include <iosfwd>
class Buffer;
class BufferParams;
class BufferView;
-class InsetText;
-class Paragraph;
+class CursorSlice;
+class Dimension;
+class InsetBase;
+class InsetOld_code;
+class FuncRequest;
+class FuncStatus;
+class LColor_color;
+class LCursor;
+class LyXTextClass;
+class MetricsInfo;
+class PainterInfo;
class Row;
+class RowMetrics;
class Spacing;
-class UpdatableInset;
-class VSpace;
-class WordLangTuple;
-class ParagraphList;
-class MetricsInfo;
-class Dimension;
-/**
- 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;
///
- 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 dran area to document start.
- int anchor_y_;
-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);
+ typedef lyx::pos_type pos_type;
///
- InsetText * inset_owner;
+ typedef lyx::par_type par_type;
+
+ /// constructor
+ explicit LyXText(BufferView *);
///
- UpdatableInset * the_locking_inset;
+ void init(BufferView *);
+ /// update y coordinate cache of all paragraphs
+ void updateParPositions();
///
- int getRealCursorX() const;
+ LyXFont getFont(par_type pit, pos_type pos) const;
///
- LyXFont getFont(ParagraphList::iterator pit, lyx::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 <enter> 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,
- string const & layout);
+ /// set layout over selection
+ par_type setLayout(par_type start, par_type end,
+ std::string const & layout);
///
- void setLayout(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.
- 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);
///
- 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();
/// compute text metrics
void metrics(MetricsInfo & mi, Dimension & dim);
-
- ///
- InsetOld::RESULT dispatch(FuncRequest const & cmd);
-
+ /// 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;
+ /// 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;
-
-public:
- /// only the top-level LyXText has this non-zero
- BufferView * bv_owner;
+ /// 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);
-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;
- /**
- * 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,
- 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,
- RowList::iterator rit, int & x, bool & boundary) const;
+ pos_type getColumnNearX(par_type pit,
+ Row const & row, int & x, bool & boundary) const;
- /** returns a pointer to a specified row. y is set to the beginning
- of the row
+ /** 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
*/
- RowList::iterator
- getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) 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);
+ 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();
/// 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(LCursor & cur, par_type par, pos_type pos,
+ bool setfont = true, bool boundary = false);
///
- void setCursor(LyXCursor &, ParagraphList::iterator pit,
- lyx::pos_type pos,
- bool boundary = false);
+ void setCursor(CursorSlice &, par_type par,
+ pos_type pos, bool boundary = false);
///
- void setCursorIntern(ParagraphList::iterator pit,
- 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);
///
- bool isBoundary(Buffer const *, Paragraph const & par,
- lyx::pos_type pos) const;
+ void recUndo(par_type first, par_type last) const;
///
- bool isBoundary(Buffer const *, Paragraph const & par,
- lyx::pos_type pos,
- LyXFont const & font) 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);
///
- void cursorLeft(bool internal = true);
+ void cursorLeft(LCursor & cur);
///
- void 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 {
///
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,
- string const & labelwidthstring,
+ std::string const & labelwidthstring,
bool noindent);
/* 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(string const & str);
-
/// needed to insert the selection
- void insertStringAsLines(string const & str);
+ void insertStringAsLines(LCursor & cur, std::string const & str);
/// needed to insert the selection
- void insertStringAsParagraphs(string const & str);
+ void insertStringAsParagraphs(LCursor & cur, std::string const & str);
/// Find next inset of some specified type.
- bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
- string const & contents = string());
+ bool gotoNextInset(LCursor & cur,
+ std::vector<InsetOld_code> const & codes,
+ std::string const & contents = std::string());
///
- void gotoInset(std::vector<InsetOld::Code> const & codes,
- bool same_content);
+ void gotoInset(LCursor & cur,
+ std::vector<InsetOld_code> const & codes, bool same_content);
///
- void gotoInset(InsetOld::Code code, bool same_content);
-
- ///
- int workWidth() const;
-
- ///
- void computeBidiTables(ParagraphList::iterator pit,
- 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:
- ///
- float getCursorX(ParagraphList::iterator pit,
- RowList::iterator rit, 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, RowList::iterator rit);
+ void gotoInset(LCursor & cur, InsetOld_code code, bool same_content);
- // 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. */
+ /// updates all counters
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);
///
- 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;
-
- ///
- mutable bool bidi_same_direction;
-
- unsigned char transformChar(unsigned char c, Paragraph const & par,
- lyx::pos_type pos) const;
+ LColor_color backgroundColor() const;
/**
* Returns the left beginning of the text.
* 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(par_type pit, pos_type pos) const;
+ int leftMargin(par_type pit) const;
///
- int rightMargin(ParagraphList::iterator pit, 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,
- RowList::iterator row) const;
-
-private:
- ///
- void setCounter(Buffer const *, ParagraphList::iterator pit);
- ///
- void deleteWordForward();
- ///
- void deleteWordBackward();
- ///
- void deleteLineForward();
-
- /*
- * some low level functions
- */
+ RowMetrics computeRowMetrics(par_type pit, Row const & row) const;
+ /// access to our paragraphs
+ ParagraphList & paragraphs() const;
+ /// return true if this is the main text
+ bool isMainText() 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;
+ /// return first row of text
+ Row const & firstRow() const;
- /// returns the minimum space a row needs on the screen in pixel
- int fill(ParagraphList::iterator pit,
- RowList::iterator row, int workwidth) const;
+ /// is this row the last in the text?
+ bool isLastRow(par_type pit, Row const & row) const;
+ /// is this row the first in the text?
+ bool isFirstRow(par_type pit, Row const & row) const;
- /**
- * returns the minimum space a manual label needs on the
- * screen in pixels
- */
- int labelFill(ParagraphList::iterator pit, Row const & row) const;
+ ///
+ 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;
+ ///
+ bool checkAndActivateInset(LCursor & cur, bool front);
- /// FIXME
- int labelEnd(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);
///
- mutable std::vector<lyx::pos_type> log2vis_list;
+ int ascent() const;
///
- mutable std::vector<lyx::pos_type> vis2log_list;
+ int descent() const;
///
- mutable std::vector<lyx::pos_type> bidi_levels;
+ int cursorX(CursorSlice const & cursor) const;
///
- mutable lyx::pos_type bidi_start;
+ int cursorY(CursorSlice const & cursor) const;
+
///
- mutable lyx::pos_type bidi_end;
+ friend class LyXScreen;
+public:
+ ///
+ unsigned int width_;
///
- const bool in_inset_;
+ int maxwidth_;
+ ///
+ int height_;
+ /// the current font settings
+ LyXFont current_font;
+ /// the current font
+ LyXFont real_current_font;
+ /// our buffer's default layout font
+ LyXFont defaultfont_;
///
- ParagraphList & paragraphs_;
+ int background_color_;
+
+ /// only the top-level LyXText has this non-zero
+ BufferView * bv_owner;
///
- void charInserted();
-public:
- //
- // special owner functions
+ mutable Bidi bidi;
///
- ParagraphList & ownerParagraphs() const;
+ ParagraphList pars_;
- /// return true if this is owned by an inset.
- bool isInInset() const;
+ /// absolute document pixel coordinates of this LyXText
+ mutable int xo_;
+ mutable int yo_;
- /// 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;
+ /// our 'outermost' Font
+ LyXFont font_;
+
+private:
+ /// return past-the-last paragraph influenced by a layout
+ /// change on pit
+ par_type undoSpan(par_type pit);
+
+ /// 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(par_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 setCounter(Buffer const &, par_type pit);
+ ///
+ void deleteWordForward(LCursor & cur);
+ ///
+ void deleteWordBackward(LCursor & cur);
///
- bool noRows() const;
+ 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(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(par_type pit) const;
-private:
- /** Cursor related data.
- Later this variable has to be removed. There should be now internal
- cursor in a text */
///
- ///TextCursor cursor_;
+ 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();
+
+///
+std::string expandLabel(LyXTextClass const & textclass,
+ LyXLayout_ptr const & layout, bool appendix);
+
#endif // LYXTEXT_H
projects / lyx.git / blobdiff