src/Row.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Row.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Matthias Ettrich
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  *
  12  * Metrics for an on-screen text row.
  13  */
  14
  15 #ifndef ROW_H
  16 #define ROW_H
  17
  18 #include "Changes.h"
  19 #include "Dimension.h"
  20 #include "Font.h"
  21 #include "RowFlags.h"
  22
  23 #include "support/docstring.h"
  24 #include "support/types.h"
  25
  26 #include <vector>
  27
  28 namespace lyx {
  29
  30 class DocIterator;
  31 class Inset;
  32
  33 /**
  34  * An on-screen row of text. A paragraph is broken into a RowList for
  35  * display. Each Row contains a tokenized description of the contents
  36  * of the line.
  37  */
  38 class Row {
  39 public:
  40         // Possible types of row elements
  41         enum Type {
  42                 // a string of character
  43                 STRING,
  44                 /**
  45                  * Something (completion, end-of-par marker)
  46                  * that occupies space one screen but does not
  47                  * correspond to any paragraph contents
  48                  */
  49                 VIRTUAL,
  50                 // An inset
  51                 INSET,
  52                 // Some spacing described by its width, not a string
  53                 SPACE,
  54                 // Something that should not happen (for error handling)
  55                 INVALID
  56         };
  57
  58 /**
  59  * One element of a Row. It has a set of attributes that can be used
  60  * by other methods that need to parse the Row contents.
  61  */
  62         struct Element {
  63                 //
  64                 Element() = default;
  65                 //
  66                 Element(Type const t, pos_type p, Font const & f, Change const & ch)
  67                         : type(t), pos(p), endpos(p + 1), font(f), change(ch) {}
  68
  69
  70                 // Return the number of separator in the element (only STRING type)
  71                 int countSeparators() const;
  72
  73                 // Return total width of element, including separator overhead
  74                 // FIXME: Cache this value or the number of expanders?
  75                 double full_width() const { return dim.wid + extra * countExpanders(); }
  76                 // Return the number of expanding characters in the element (only STRING
  77                 // type).
  78                 int countExpanders() const;
  79                 // Return the amount of expansion: the number of expanding characters
  80                 // that get stretched during justification, times the em of the font
  81                 // (only STRING type).
  82                 int expansionAmount() const;
  83                 // set extra proportionally to the font em value.
  84                 void setExtra(double extra_per_em);
  85
  86                 /** Return position in pixels (from the left) of position
  87                  * \param i in the row element.
  88                  */
  89                 double pos2x(pos_type const i) const;
  90                 /** Return character position that is the closest to
  91                  *  pixel position \param x. The value \param x is
  92                  *  adjusted to the actual pixel position.
  93                 */
  94                 pos_type x2pos(int &x) const;
  95                 /** Break the element in two if possible, so that its width is less
  96                  * than \param w.
  97                  * \return an element containing the remainder of the text, or
  98                  *   an invalid element if nothing happened.
  99                  * \param w: the desired maximum width
 100                  * \param force: if true, the string is cut at any place, otherwise it
 101                  *   respects the row breaking rules of characters.
 102                  */
 103                 Element splitAt(int w, bool force);
 104                 /** Break the element if possible, so that its width is less
 105                  * than \param w. Returns true on success. When \param force
 106                  * is true, the string is cut at any place, otherwise it
 107                  * respects the row breaking rules of characters.
 108                  */
 109                 bool breakAt(int w, bool force);
 110
 111                 //
 112                 bool isRTL() const { return font.isVisibleRightToLeft(); }
 113                 // This is true for virtual elements.
 114                 bool isVirtual() const { return type == VIRTUAL; }
 115                 // Invalid element, for error handling
 116                 bool isValid() const { return type !=INVALID; }
 117
 118                 // Returns the position on left side of the element.
 119                 pos_type left_pos() const { return isRTL() ? endpos : pos; };
 120                 // Returns the position on right side of the element.
 121                 pos_type right_pos() const { return isRTL() ? pos : endpos; };
 122
 123                 // The kind of row element
 124                 Type type = INVALID;
 125                 // position of the element in the paragraph
 126                 pos_type pos = 0;
 127                 // first position after the element in the paragraph
 128                 pos_type endpos = 0;
 129                 // The dimension of the chunk (does not contains the
 130                 // separator correction)
 131                 Dimension dim;
 132
 133                 // Non-zero only if element is an inset
 134                 Inset const * inset = nullptr;
 135
 136                 // Only non-null for justified rows
 137                 double extra = 0;
 138
 139                 // Non-empty if element is a string or is virtual
 140                 docstring str;
 141                 //
 142                 Font font;
 143                 //
 144                 Change change;
 145                 // is it possible to add contents to this element?
 146                 bool final = false;
 147                 // properties with respect to row breaking (made of RowFlag enums)
 148                 int row_flags = Inline;
 149
 150                 friend std::ostream & operator<<(std::ostream & os, Element const & row);
 151         };
 152
 153
 154         ///
 155         Row() {}
 156
 157         /**
 158          * Helper function: set variable \c var to value \c val, and mark
 159          * row as changed is the values were different. This is intended
 160          * for use when changing members of the row object.
 161          */
 162         template<class T1, class T2>
 163         void change(T1 & var, T2 const val) {
 164                 if (var != val)
 165                         changed(true);
 166                 var = val;
 167         }
 168         /**
 169          * Helper function: set variable \c var to value \c val, and mark
 170          * row as changed is the values were different. This is intended
 171          * for use when changing members of the row object.
 172          * This is the const version, useful for mutable members.
 173          */
 174         template<class T1, class T2>
 175         void change(T1 & var, T2 const val) const {
 176                 if (var != val)
 177                         changed(true);
 178                 var = val;
 179         }
 180         ///
 181         bool changed() const { return changed_; }
 182         ///
 183         void changed(bool c) const { changed_ = c; }
 184         ///
 185         bool selection() const;
 186         /**
 187          * Set the selection begin and end and whether the left and/or
 188          * right margins are selected.
 189          * This is const because we update the selection status only at
 190          * draw() time.
 191          */
 192         void setSelectionAndMargins(DocIterator const & beg,
 193                 DocIterator const & end) const;
 194         /// no selection on this row.
 195         void clearSelectionAndMargins() const;
 196
 197         ///
 198         void pit(pit_type p) { pit_ = p; }
 199         ///
 200         pit_type pit() const { return pit_; }
 201         ///
 202         void pos(pos_type p) { pos_ = p; }
 203         ///
 204         pos_type pos() const { return pos_; }
 205         ///
 206         void endpos(pos_type p) { end_ = p; }
 207         ///
 208         pos_type endpos() const { return end_; }
 209         ///
 210         void right_boundary(bool b) { right_boundary_ = b; }
 211         ///
 212         bool right_boundary() const { return right_boundary_; }
 213         ///
 214         void flushed(bool b) { flushed_ = b; }
 215         ///
 216         bool flushed() const { return flushed_; }
 217
 218         ///
 219         Dimension const & dim() const { return dim_; }
 220         ///
 221         Dimension & dim() { return dim_; }
 222         ///
 223         int height() const { return dim_.height(); }
 224         /// The width of the row, including the left margin, but not the right one.
 225         int width() const { return dim_.wid; }
 226         ///
 227         int ascent() const { return dim_.asc; }
 228         ///
 229         int descent() const { return dim_.des; }
 230
 231         ///
 232         Dimension const & contents_dim() const { return contents_dim_; }
 233         ///
 234         Dimension & contents_dim() { return contents_dim_; }
 235
 236         /// The offset of the left-most cursor position on the row
 237         int left_x() const;
 238         /// The offset of the right-most cursor position on the row
 239         int right_x() const;
 240
 241         // Return the number of separators in the row
 242         int countSeparators() const;
 243         // Set the extra spacing for every expanding character in STRING-type
 244         // elements.  \param w is the total amount of extra width for the row to be
 245         // distributed among expanders.  \return false if the justification fails.
 246         bool setExtraWidth(int w);
 247
 248         ///
 249         void add(pos_type pos, Inset const * ins, Dimension const & dim,
 250                  Font const & f, Change const & ch);
 251         ///
 252         void add(pos_type pos, char_type const c,
 253                  Font const & f, Change const & ch, bool can_break);
 254         ///
 255         void addVirtual(pos_type pos, docstring const & s,
 256                         Font const & f, Change const & ch);
 257         ///
 258         void addSpace(pos_type pos, int width, Font const & f, Change const & ch);
 259
 260         ///
 261         typedef std::vector<Element> Elements;
 262         ///
 263         typedef Elements::iterator iterator;
 264         ///
 265         typedef Elements::const_iterator const_iterator;
 266         ///
 267         iterator begin() { return elements_.begin(); }
 268         ///
 269         iterator end() { return elements_.end(); }
 270         ///
 271         const_iterator begin() const { return elements_.begin(); }
 272         ///
 273         const_iterator end() const { return elements_.end(); }
 274
 275         ///
 276         bool empty() const { return elements_.empty(); }
 277         ///
 278         Element & front() { return elements_.front(); }
 279         ///
 280         Element const & front() const { return elements_.front(); }
 281         ///
 282         Element & back() { return elements_.back(); }
 283         ///
 284         Element const & back() const { return elements_.back(); }
 285         /// add element at the end and update width
 286         void push_back(Element const &);
 287         /// remove last element and update width
 288         void pop_back();
 289         /**
 290          * if row width is too large, remove all elements after last
 291          * separator and update endpos if necessary. If all that
 292          * remains is a large word, cut it to \param width.
 293          * \param width maximum width of the row.
 294          * \param available width on next row.
 295          * \return true if the row has been shortened.
 296          */
 297         bool shortenIfNeeded(int const width, int const next_width);
 298
 299         /**
 300          * If last element of the row is a string, compute its width
 301          * and mark it final.
 302          */
 303         void finalizeLast();
 304
 305         /**
 306          * Find sequences of right-to-left elements and reverse them.
 307          * This should be called once the row is completely built.
 308          */
 309         void reverseRTL(bool rtl_par);
 310         ///
 311         bool isRTL() const { return rtl_; }
 312         ///
 313         bool needsChangeBar() const { return changebar_; }
 314         ///
 315         void needsChangeBar(bool ncb) { changebar_ = ncb; }
 316
 317         /// Find row element that contains \c pos, and compute x offset.
 318         const_iterator const findElement(pos_type pos, bool boundary, double & x) const;
 319
 320         friend std::ostream & operator<<(std::ostream & os, Row const & row);
 321
 322         /// additional width for separators in justified rows (i.e. space)
 323         double separator = 0;
 324         /// width of hfills in the label
 325         double label_hfill = 0;
 326         /// the left margin position of the row
 327         int left_margin = 0;
 328         /// the right margin of the row
 329         int right_margin = 0;
 330         ///
 331         mutable pos_type sel_beg = -1;
 332         ///
 333         mutable pos_type sel_end = -1;
 334         ///
 335         mutable bool begin_margin_sel = false;
 336         ///
 337         mutable bool end_margin_sel = false;
 338
 339 private:
 340         /// Decides whether the margin is selected.
 341         /**
 342           * \param margin_begin
 343           * \param beg
 344           * \param end
 345           */
 346         bool isMarginSelected(bool left, DocIterator const & beg,
 347                 DocIterator const & end) const;
 348         /// Set the selection begin and end.
 349         void setSelection(pos_type sel_beg, pos_type sel_end) const;
 350
 351         /**
 352          * Returns true if a char or string with font \c f and change
 353          * type \c ch can be added to the current last element of the
 354          * row.
 355          */
 356         bool sameString(Font const & f, Change const & ch) const;
 357
 358         ///
 359         Elements elements_;
 360
 361         /// has the Row appearance changed since last drawing?
 362         mutable bool changed_ = true;
 363         /// Index of the paragraph that contains this row
 364         pit_type pit_ = 0;
 365         /// first pos covered by this row
 366         pos_type pos_ = 0;
 367         /// one behind last pos covered by this row
 368         pos_type end_ = 0;
 369         // Is there a boundary at the end of the row (display inset...)
 370         bool right_boundary_ = false;
 371         // Shall the row be flushed when it is supposed to be justified?
 372         bool flushed_ = false;
 373         /// Row dimension.
 374         Dimension dim_;
 375         /// Row contents dimension. Does not contain the space above/below row.
 376         Dimension contents_dim_;
 377         /// true when this row lives in a right-to-left paragraph
 378         bool rtl_ = false;
 379         /// true when a changebar should be drawn in the margin
 380         bool changebar_ = false;
 381 };
 382
 383
 384 /**
 385  * Each paragraph is broken up into a number of rows on the screen.
 386  * This is a list of such on-screen rows, ordered from the top row
 387  * downwards.
 388  */
 389 typedef std::vector<Row> RowList;
 390
 391 } // namespace lyx
 392
 393 #endif