src/TextMetrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TextMetrics.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef TEXT_METRICS_H
  15 #define TEXT_METRICS_H
  16
  17 #include "Font.h"
  18 #include "ParagraphMetrics.h"
  19
  20 #include "support/types.h"
  21
  22 namespace lyx {
  23
  24 class BufferView;
  25 class Cursor;
  26 class CursorSlice;
  27 class DocIterator;
  28 class MetricsInfo;
  29 class Text;
  30
  31 /// A map from a Text to the map of paragraphs metrics
  32 class TextMetrics
  33 {
  34 public:
  35         /// Default constructor (only here for STL containers).
  36         TextMetrics() : text_(0) {}
  37         /// The only useful constructor.
  38         TextMetrics(BufferView *, Text *);
  39
  40         ///
  41         bool has(pit_type pit) const;
  42         ///
  43         ParagraphMetrics const & parMetrics(pit_type) const;
  44         ///
  45         std::pair<pit_type, ParagraphMetrics const *> first() const;
  46         ///
  47         std::pair<pit_type, ParagraphMetrics const *> last() const;
  48
  49         ///
  50         int parPosition(pit_type pit) const;
  51
  52         ///
  53         Dimension const & dimension() const { return dim_; }
  54         ///
  55         Point const & origin() const { return origin_; }
  56
  57
  58         /// compute text metrics.
  59         bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
  60
  61         ///
  62         void newParMetricsDown();
  63         ///
  64         void newParMetricsUp();
  65
  66         /// Gets the fully instantiated font at a given position in a paragraph
  67         /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
  68         /// The difference is that this one is used for displaying, and thus we
  69         /// are allowed to make cosmetic improvements. For instance make footnotes
  70         /// smaller. (Asger)
  71         Font getDisplayFont(pit_type pit,
  72                 pos_type pos) const;
  73
  74         /// There are currently two font mechanisms in LyX:
  75         /// 1. The font attributes in a lyxtext, and
  76         /// 2. The inset-specific font properties, defined in an inset's
  77         /// metrics() and draw() methods and handed down the inset chain through
  78         /// the pi/mi parameters, and stored locally in a lyxtext in font_.
  79         /// This is where the two are integrated in the final fully realized
  80         /// font.
  81         void applyOuterFont(Font &) const;
  82
  83         /// is this position in the paragraph right-to-left?
  84         bool isRTL(CursorSlice const & sl, bool boundary) const;
  85         /// is between pos-1 and pos an RTL<->LTR boundary?
  86         bool isRTLBoundary(pit_type pit,
  87           pos_type pos) const;
  88         /// would be a RTL<->LTR boundary between pos and the given font?
  89         bool isRTLBoundary(pit_type pit,
  90           pos_type pos, Font const & font) const;
  91
  92
  93         /// Rebreaks the given paragraph.
  94         /// \retval true if a full screen redraw is needed.
  95         /// \retval false if a single paragraph redraw is enough.
  96         bool redoParagraph(pit_type const pit);
  97         /// Clear cache of paragraph metrics
  98         void clear() { par_metrics_.clear(); }
  99
 100         ///
 101         int ascent() const { return dim_.asc; }
 102         ///
 103         int descent() const { return dim_.des; }
 104         /// current text width.
 105         int width() const { return dim_.wid; }
 106         /// current text heigth.
 107         int height() const { return dim_.height(); }
 108
 109         ///
 110         int maxWidth() const { return max_width_; }
 111         ///
 112         int singleWidth(pit_type const pit,     pos_type pos) const;
 113
 114         ///
 115         int rightMargin(ParagraphMetrics const & pm) const;
 116         int rightMargin(pit_type const pit) const;
 117
 118         /** this calculates the specified parameters. needed when setting
 119          * the cursor and when creating a visible row */
 120         void computeRowMetrics(pit_type pit, Row & row, int width) const;
 121
 122         ///
 123         void draw(PainterInfo & pi, int x, int y) const;
 124
 125         void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
 126
 127         /// Returns the height of the row (width member is set to 0).
 128         /// If \c topBottomSpace is true, extra space is added for the
 129         /// top and bottom row.
 130         Dimension rowHeight(
 131                 pit_type const pit,
 132                 pos_type const first,
 133                 pos_type const end,
 134                 bool topBottomSpace = true) const;
 135
 136 private:
 137         ///
 138         ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
 139
 140         /// the minimum space a manual label needs on the screen in pixels
 141         int labelFill(pit_type const pit, Row const & row) const;
 142
 143         /// FIXME??
 144         int labelEnd(pit_type const pit) const;
 145
 146         /// sets row.end to the pos value *after* which a row should break.
 147         /// for example, the pos after which isNewLine(pos) == true
 148         pit_type rowBreakPoint(
 149                 int width,
 150                 pit_type const pit,
 151                 pit_type first
 152                 ) const;
 153
 154         /// returns the minimum space a row needs on the screen in pixel
 155         int rowWidth(
 156                 int right_margin,
 157                 pit_type const pit,
 158                 pos_type const first,
 159                 pos_type const end
 160                 ) const;
 161
 162         /// draw selection for a single row
 163         void drawRowSelection(PainterInfo & pi, int x, Row const & row,
 164                 DocIterator const & beg, DocIterator const & end,
 165                 bool drawOnBegMargin, bool drawOnEndMargin) const;
 166
 167 // Temporary public:
 168 public:
 169         /// returns the column near the specified x-coordinate of the row.
 170         /// x is an absolute screen coord, it is set to the real beginning
 171         /// of this column.
 172         pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
 173                 bool & boundary) const;
 174
 175         /// returns pos in given par at given x coord.
 176         pos_type x2pos(pit_type pit, int row, int x) const;
 177
 178         // FIXME: is there a need for this?
 179         //int pos2x(pit_type pit, pos_type pos) const;
 180
 181         /** returns row near the specified
 182           * y-coordinate in given paragraph (relative to the screen).
 183           */
 184         Row const & getRowNearY(int y,
 185                 pit_type pit) const;
 186
 187         /// returns the paragraph number closest to screen y-coordinate.
 188         /// This method uses the BufferView CoordCache to locate the
 189         /// paragraph. The y-coodinate is allowed to be off-screen and
 190         /// the CoordCache will be automatically updated if needed. This is
 191         /// the reason why we need a non const BufferView.
 192         pit_type getPitNearY(int y);
 193
 194         /// sets cursor recursively descending into nested editable insets
 195         /**
 196         \return the inset pointer if x,y is covering that inset
 197         \param x,y are absolute screen coordinates.
 198         \retval inset is non-null if the cursor is positionned inside
 199         */
 200         /// FIXME: cleanup to use BufferView::getCoveringInset() and
 201         /// setCursorFromCoordinates() instead of checkInsetHit().
 202         Inset * editXY(Cursor & cur, int x, int y);
 203
 204         /// sets cursor only within this Text.
 205         /// x,y are screen coordinates
 206         void setCursorFromCoordinates(Cursor & cur, int x, int y);
 207
 208         ///
 209         int cursorX(CursorSlice const & cursor,
 210                 bool boundary) const;
 211         ///
 212         int cursorY(CursorSlice const & cursor,
 213                 bool boundary) const;
 214
 215         ///
 216         void cursorPrevious(Cursor & cur);
 217         ///
 218         void cursorNext(Cursor & cur);
 219         ///
 220         bool cursorHome(Cursor & cur);
 221         ///
 222         bool cursorEnd(Cursor & cur);
 223         ///
 224         void deleteLineForward(Cursor & cur);
 225
 226         /// is this row the last in the text?
 227         bool isLastRow(pit_type pit, Row const & row) const;
 228         /// is this row the first in the text?
 229         bool isFirstRow(pit_type pit, Row const & row) const;
 230
 231         /// Returns an inset if inset was hit, or 0 if not.
 232         /// \warning This method is not recursive! It will return the
 233         /// outermost inset within this Text.
 234         /// \sa BufferView::getCoveringInset() to get the innermost inset.
 235         Inset * checkInsetHit(int x, int y);
 236
 237         /**
 238          * Returns the left beginning of the text.
 239          * This information cannot be taken from the layout object, because
 240          * in LaTeX the beginning of the text fits in some cases
 241          * (for example sections) exactly the label-width.
 242          */
 243         int leftMargin(int max_width, pit_type pit, pos_type pos) const;
 244         int leftMargin(int max_width, pit_type pit) const;
 245
 246 private:
 247         friend class BufferView;
 248
 249         /// The BufferView owner.
 250         BufferView * bv_;
 251
 252         /// The text contents (the model).
 253         /// \todo FIXME: this should be const.
 254         Text * text_;
 255
 256         bool main_text_;
 257         /// A map from paragraph index number to paragraph metrics
 258         typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
 259         ///
 260         mutable ParMetricsCache par_metrics_;
 261         Dimension dim_;
 262         int max_width_;
 263         mutable Point origin_;
 264
 265 // temporary public:
 266 public:
 267         /// our 'outermost' font.
 268         /// This is handed down from the surrounding
 269         /// inset through the pi/mi parameter (pi.base.font)
 270         /// It is used in applyOuterFont() and setCharFont() for reasons
 271         /// that are not clear... to hand hand the outermost language and
 272         /// also for char style apparently.
 273         Font font_;
 274 };
 275
 276 /// return the default height of a row in pixels, considering font zoom
 277 int defaultRowHeight();
 278
 279 } // namespace lyx
 280
 281 #endif // TEXT_METRICS_H