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 "InsetList.h"
  19 #include "LayoutEnums.h"
  20 #include "ParagraphMetrics.h"
  21
  22 #include "support/types.h"
  23
  24 #include <map>
  25
  26 namespace lyx {
  27
  28 class BufferView;
  29 class Cursor;
  30 class CursorSlice;
  31 class MetricsInfo;
  32 class Text;
  33
  34 /// A map from a Text to the map of paragraphs metrics
  35 class TextMetrics
  36 {
  37         /// noncopyable
  38         TextMetrics(TextMetrics const &);
  39         void operator=(TextMetrics const &);
  40 public:
  41         /// Default constructor (only here for STL containers).
  42         TextMetrics() : bv_(0), text_(0), max_width_(0) {}
  43         /// The only useful constructor.
  44         TextMetrics(BufferView *, Text *);
  45
  46         ///
  47         bool contains(pit_type pit) const;
  48         ///
  49         std::pair<pit_type, ParagraphMetrics const *> first() const;
  50         ///
  51         std::pair<pit_type, ParagraphMetrics const *> last() const;
  52         /// is this row the last in the text?
  53         bool isLastRow(Row const & row) const;
  54         /// is this row the first in the text?
  55         bool isFirstRow(Row const & row) const;
  56         ///
  57         void setRowChanged(pit_type pit, pos_type pos);
  58
  59         ///
  60         Dimension const & dim() const { return dim_; }
  61         ///
  62         Point const & origin() const { return origin_; }
  63
  64         ///
  65         ParagraphMetrics const & parMetrics(pit_type) const;
  66         ///
  67         ParagraphMetrics & parMetrics(pit_type);
  68
  69         ///
  70         void newParMetricsDown();
  71         ///
  72         void newParMetricsUp();
  73
  74         /// compute text metrics.
  75         bool metrics(MetricsInfo const & mi, Dimension & dim, int min_width = 0,
  76                      bool const expand_on_multipars = true);
  77
  78         /// The "nodraw" drawing stage for one single paragraph: set the
  79         /// positions of the insets contained in this paragraph in metrics
  80         /// cache. Related to BufferView::updatePosCache.
  81         void updatePosCache(pit_type pit) const;
  82
  83         /// Gets the fully instantiated font at a given position in a paragraph
  84         /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
  85         /// The difference is that this one is used for displaying, and thus we
  86         /// are allowed to make cosmetic improvements. For instance make footnotes
  87         /// smaller. (Asger)
  88         Font displayFont(pit_type pit, pos_type pos) const;
  89
  90         /// There are currently two font mechanisms in LyX:
  91         /// 1. The font attributes in a lyxtext, and
  92         /// 2. The inset-specific font properties, defined in an inset's
  93         /// metrics() and draw() methods and handed down the inset chain through
  94         /// the pi/mi parameters, and stored locally in a lyxtext in font_.
  95         /// This is where the two are integrated in the final fully realized
  96         /// font.
  97         void applyOuterFont(Font &) const;
  98
  99         /// is this position in the paragraph right-to-left?
 100         bool isRTL(CursorSlice const & sl, bool boundary) const;
 101         /// is between pos-1 and pos an RTL<->LTR boundary?
 102         bool isRTLBoundary(pit_type pit, pos_type pos) const;
 103         /// would be a RTL<->LTR boundary between pos and the given font?
 104         bool isRTLBoundary(pit_type pit, pos_type pos, Font const & font) const;
 105
 106
 107         /// Rebreaks the given paragraph.
 108         /// \retval true if a full screen redraw is needed.
 109         /// \retval false if a single paragraph redraw is enough.
 110         bool redoParagraph(pit_type const pit, bool align_rows = true);
 111         /// Clear cache of paragraph metrics
 112         void clear() { par_metrics_.clear(); }
 113         /// Is cache of paragraph metrics empty ?
 114         bool empty() const { return par_metrics_.empty(); }
 115
 116         ///
 117         int ascent() const { return dim_.asc; }
 118         ///
 119         int descent() const { return dim_.des; }
 120         /// current text width.
 121         int width() const { return dim_.wid; }
 122         /// current text height.
 123         int height() const { return dim_.height(); }
 124
 125         /**
 126          * Returns the left beginning of the text.
 127          * This information cannot be taken from the layout object, because
 128          * in LaTeX the beginning of the text fits in some cases
 129          * (for example sections) exactly the label-width.
 130          */
 131         int leftMargin(pit_type pit, pos_type pos) const;
 132         int leftMargin(pit_type pit) const;
 133
 134         ///
 135         int rightMargin(ParagraphMetrics const & pm) const;
 136         int rightMargin(pit_type const pit) const;
 137
 138         ///
 139         void draw(PainterInfo & pi, int x, int y) const;
 140
 141         void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
 142
 143 private:
 144         ///
 145         ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
 146
 147         /// the minimum space a manual label needs on the screen in pixels
 148         int labelFill(Row const & row) const;
 149
 150         /// FIXME??
 151         int labelEnd(pit_type const pit) const;
 152
 153         /// sets row.end to the pos value *after* which a row should break.
 154         /// for example, the pos after which isNewLine(pos) == true
 155         /// \return true when another row is required (after a newline)
 156         bool breakRow(Row & row, int right_margin) const;
 157
 158         // Expands the alignment of row \param row in paragraph \param par
 159         LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
 160         /// Aligns properly the row contents (computes spaces and fills)
 161         void setRowAlignment(Row & row, int width) const;
 162
 163         /// Set the height of the row (without space above/below paragraph)
 164         void setRowHeight(Row & row) const;
 165         // Compute the space on top of a paragraph
 166         int parTopSpacing(pit_type pit) const;
 167         // Compute the space below a a paragraph
 168         int parBottomSpacing(pit_type pit) const;
 169
 170         // Helper function for the other checkInsetHit method.
 171         InsetList::Element * checkInsetHit(pit_type pit, int x, int y);
 172
 173
 174 // Temporary public:
 175 public:
 176         /// returns the position near the specified x-coordinate of the row.
 177         /// x is an absolute screen coord, it is set to the real beginning
 178         /// of this column. This takes in account horizontal cursor row scrolling.
 179         pos_type getPosNearX(Row const & row, int & x, bool & boundary) const;
 180
 181         /// returns pos in given par at given x coord.
 182         pos_type x2pos(pit_type pit, int row, int x) const;
 183
 184         // FIXME: is there a need for this?
 185         //int pos2x(pit_type pit, pos_type pos) const;
 186
 187         /// returns the row near the specified y-coordinate in a given paragraph
 188         /// (relative to the screen). If assert_in_view is true, it is made sure
 189         /// that the row is on screen completely; this might change the given pit.
 190         Row const & getPitAndRowNearY(int & y, pit_type & pit,
 191                 bool assert_in_view, bool up);
 192
 193         /// returns the paragraph number closest to screen y-coordinate.
 194         /// This method uses the BufferView CoordCache to locate the
 195         /// paragraph. The y-coodinate is allowed to be off-screen and
 196         /// the CoordCache will be automatically updated if needed. This is
 197         /// the reason why we need a non const BufferView.
 198         pit_type getPitNearY(int y);
 199
 200         /// sets cursor recursively descending into nested editable insets
 201         /**
 202         \return the inset pointer if x,y is covering that inset
 203         \param x,y are absolute screen coordinates.
 204         \param assert_in_view if true the cursor will be set on a row
 205            that is completely visible
 206         \param up whether we are going up or down (only used when
 207            assert_in_view is true
 208         \retval inset is null if the cursor is positioned over normal
 209                text in the current Text object. Otherwise it is the inset
 210                that the cursor points to, like for Inset::editXY.
 211         */
 212         /// FIXME: cleanup to use BufferView::getCoveringInset() and
 213         /// setCursorFromCoordinates() instead of checkInsetHit().
 214         Inset * editXY(Cursor & cur, int x, int y,
 215                 bool assert_in_view = false, bool up = true);
 216
 217         /// sets cursor only within this Text.
 218         /// x,y are screen coordinates
 219         void setCursorFromCoordinates(Cursor & cur, int x, int y);
 220
 221         ///
 222         int cursorX(CursorSlice const & sl, bool boundary) const;
 223         ///
 224         int cursorY(CursorSlice const & sl, bool boundary) const;
 225
 226         ///
 227         bool cursorHome(Cursor & cur);
 228         ///
 229         bool cursorEnd(Cursor & cur);
 230         ///
 231         void deleteLineForward(Cursor & cur);
 232
 233         /// Returns an inset if inset was hit, or 0 if not.
 234         /// \warning This method is not recursive! It will return the
 235         /// outermost inset within this Text.
 236         /// \sa BufferView::getCoveringInset() to get the innermost inset.
 237         Inset * checkInsetHit(int x, int y);
 238
 239         /// calculates the position of a completion popup
 240         void completionPosAndDim(Cursor const & cur, int & x, int & y,
 241                 Dimension & dim) const;
 242
 243 private:
 244
 245         /// The BufferView owner.
 246         BufferView * bv_;
 247
 248         /// The text contents (the model).
 249         /// \todo FIXME: this should be const.
 250         Text * text_;
 251
 252         /// A map from paragraph index number to paragraph metrics
 253         typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
 254         ///
 255         mutable ParMetricsCache par_metrics_;
 256         Dimension dim_;
 257         int max_width_;
 258         mutable Point origin_;
 259
 260 // temporary public:
 261 public:
 262         /// our 'outermost' font.
 263         /// This is handed down from the surrounding
 264         /// inset through the pi/mi parameter (pi.base.font)
 265         /// It is used in applyOuterFont() and setCharFont() for reasons
 266         /// that are not clear... to hand hand the outermost language and
 267         /// also for char style apparently.
 268         Font font_;
 269 };
 270
 271 /// return the default height of a row in pixels, considering font zoom
 272 int defaultRowHeight();
 273
 274 } // namespace lyx
 275
 276 #endif // TEXT_METRICS_H