X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextMetrics.h;h=66d310fcc60ef4164c23152341d88b2385da8f3f;hb=1d6573a330791fb34541f4092cd49e4559972489;hp=61b27c83995eba82ffce5aceb72c9f963b3a6428;hpb=97a59984b15c48db0caae7db1245750a93559984;p=lyx.git diff --git a/src/TextMetrics.h b/src/TextMetrics.h index 61b27c8399..66d310fcc6 100644 --- a/src/TextMetrics.h +++ b/src/TextMetrics.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author John Levon * \author Abdelrazak Younes * @@ -14,40 +14,84 @@ #ifndef TEXT_METRICS_H #define TEXT_METRICS_H +#include "Font.h" #include "ParagraphMetrics.h" #include "support/types.h" -#include - - namespace lyx { class BufferView; -class LyXText; +class Cursor; +class CursorSlice; +class DocIterator; class MetricsInfo; +class Text; -/// A map from a LyXText to the map of paragraphs metrics +/// A map from a Text to the map of paragraphs metrics class TextMetrics { public: /// Default constructor (only here for STL containers). - TextMetrics(): text_(0) {} + TextMetrics() : text_(0) {} /// The only useful constructor. - TextMetrics(BufferView *, LyXText *); + TextMetrics(BufferView *, Text *); + + /// + bool contains(pit_type pit) const; /// ParagraphMetrics const & parMetrics(pit_type) const; /// - Dimension const & dimension() const; - Dimension const & dimension(); + std::pair first() const; + /// + std::pair last() const; + + /// + Dimension const & dimension() const { return dim_; } + /// + Point const & origin() const { return origin_; } + /// compute text metrics. - bool metrics(MetricsInfo & mi, Dimension & dim); + bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0); + + /// + void newParMetricsDown(); + /// + void newParMetricsUp(); + + /// Gets the fully instantiated font at a given position in a paragraph + /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp. + /// The difference is that this one is used for displaying, and thus we + /// are allowed to make cosmetic improvements. For instance make footnotes + /// smaller. (Asger) + Font displayFont(pit_type pit, pos_type pos) const; + + /// There are currently two font mechanisms in LyX: + /// 1. The font attributes in a lyxtext, and + /// 2. The inset-specific font properties, defined in an inset's + /// metrics() and draw() methods and handed down the inset chain through + /// the pi/mi parameters, and stored locally in a lyxtext in font_. + /// This is where the two are integrated in the final fully realized + /// font. + void applyOuterFont(Font &) const; + + /// is this position in the paragraph right-to-left? + bool isRTL(CursorSlice const & sl, bool boundary) const; + /// is between pos-1 and pos an RTL<->LTR boundary? + bool isRTLBoundary(pit_type pit, + pos_type pos) const; + /// would be a RTL<->LTR boundary between pos and the given font? + bool isRTLBoundary(pit_type pit, + pos_type pos, Font const & font) const; + /// Rebreaks the given paragraph. /// \retval true if a full screen redraw is needed. /// \retval false if a single paragraph redraw is enough. bool redoParagraph(pit_type const pit); + /// Clear cache of paragraph metrics + void clear() { par_metrics_.clear(); } /// int ascent() const { return dim_.asc; } @@ -55,11 +99,13 @@ public: int descent() const { return dim_.des; } /// current text width. int width() const { return dim_.wid; } - /// current text heigth. + /// current text height. int height() const { return dim_.height(); } /// int maxWidth() const { return max_width_; } + /// + int singleWidth(pit_type const pit, pos_type pos) const; /// int rightMargin(ParagraphMetrics const & pm) const; @@ -67,35 +113,141 @@ public: /** 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; + void computeRowMetrics(pit_type pit, Row & row, int width) const; + /// + void draw(PainterInfo & pi, int x, int y) const; + + void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const; + + /// Returns the height of the row (width member is set to 0). + /// If \c topBottomSpace is true, extra space is added for the + /// top and bottom row. + Dimension rowHeight( + pit_type const pit, + pos_type const first, + pos_type const end, + bool topBottomSpace = true) const; private: - /// + /// ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph); /// the minimum space a manual label needs on the screen in pixels - int labelFill(Paragraph const & par, Row const & row) const; + int labelFill(pit_type const pit, Row const & row) const; /// FIXME?? int labelEnd(pit_type const pit) 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(int width, pit_type const pit, Row & row) const; + pos_type rowBreakPoint( + int width, + pit_type const pit, + pos_type first + ) const; + + /// returns the minimum space a row needs on the screen in pixel + int rowWidth( + int right_margin, + pit_type const pit, + pos_type const first, + pos_type const end + ) const; + +// Temporary public: +public: + /// returns the column near the specified x-coordinate of the row. + /// x is an absolute screen coord, it is set to the real beginning + /// of this column. + pos_type getColumnNearX(pit_type pit, Row const & row, int & x, + bool & boundary) const; + + /// returns pos in given par at given x coord. + pos_type x2pos(pit_type pit, int row, int x) const; + + // FIXME: is there a need for this? + //int pos2x(pit_type pit, pos_type pos) const; - /// sets row.width to the minimum space a row needs on the screen in pixel - void setRowWidth(int right_margin, pit_type const pit, Row & row) const; + /// returns the row near the specified y-coordinate in a given paragraph + /// (relative to the screen). If assert_in_view is true, it is made sure + /// that the row is on screen completely; this might change the given pit. + Row const & getPitAndRowNearY(int & y, pit_type & pit, + bool assert_in_view, bool up); + + /// returns the paragraph number closest to screen y-coordinate. + /// This method uses the BufferView CoordCache to locate the + /// paragraph. The y-coodinate is allowed to be off-screen and + /// the CoordCache will be automatically updated if needed. This is + /// the reason why we need a non const BufferView. + pit_type getPitNearY(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. + \param assert_in_view if true the cursor will be set on a row + that is completely visible + \param up whether we are going up or down (only used when + assert_in_view is true + \retval inset is non-null if the cursor is positionned inside + */ + /// FIXME: cleanup to use BufferView::getCoveringInset() and + /// setCursorFromCoordinates() instead of checkInsetHit(). + Inset * editXY(Cursor & cur, int x, int y, + bool assert_in_view = false, bool up = true); - /// Calculate and set the height of the row - void setHeightOfRow(pit_type, Row & row); + /// sets cursor only within this Text. + /// x,y are screen coordinates + void setCursorFromCoordinates(Cursor & cur, int x, int y); + + /// + int cursorX(CursorSlice const & cursor, + bool boundary) const; + /// + int cursorY(CursorSlice const & cursor, + bool boundary) const; + + /// + bool cursorHome(Cursor & cur); + /// + bool cursorEnd(Cursor & cur); + /// + void deleteLineForward(Cursor & cur); + + /// 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; + + /// Returns an inset if inset was hit, or 0 if not. + /// \warning This method is not recursive! It will return the + /// outermost inset within this Text. + /// \sa BufferView::getCoveringInset() to get the innermost inset. + Inset * checkInsetHit(int x, int y); + + /** + * 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(int max_width, pit_type pit, pos_type pos) const; + int leftMargin(int max_width, pit_type pit) const; + + /// calculates the position of a completion popup + void completionPosAndDim(Cursor const & cur, int & x, int & y, + Dimension & dim) const; + +private: + friend class BufferView; /// The BufferView owner. BufferView * bv_; /// The text contents (the model). /// \todo FIXME: this should be const. - LyXText * text_; + Text * text_; bool main_text_; /// A map from paragraph index number to paragraph metrics @@ -104,16 +256,17 @@ private: mutable ParMetricsCache par_metrics_; Dimension dim_; int max_width_; + mutable Point origin_; - /// FIXME: transfer this code in CoordCache here. - /* - /// A map from paragraph index number to screen point - typedef std::map InnerParPosCache; - /// A map from a LyXText to the map of paragraphs to screen points - typedef std::map ParPosCache; - /// Paragraph grouped by owning text - ParPosCache pars_; - */ +// temporary public: +public: + /// our 'outermost' font. + /// This is handed down from the surrounding + /// inset through the pi/mi parameter (pi.base.font) + /// It is used in applyOuterFont() and setCharFont() for reasons + /// that are not clear... to hand hand the outermost language and + /// also for char style apparently. + Font font_; }; /// return the default height of a row in pixels, considering font zoom