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                 // remove trailing spaces (useful for end of row)
 105                 void rtrim();
 106
 107                 //
 108                 bool isRTL() const { return font.isVisibleRightToLeft(); }
 109                 // This is true for virtual elements.
 110                 bool isVirtual() const { return type == VIRTUAL; }
 111                 // Invalid element, for error handling
 112                 bool isValid() const { return type !=INVALID; }
 113
 114                 // Returns the position on left side of the element.
 115                 pos_type left_pos() const { return isRTL() ? endpos : pos; };
 116                 // Returns the position on right side of the element.
 117                 pos_type right_pos() const { return isRTL() ? pos : endpos; };
 118
 119                 // The kind of row element
 120                 Type type = INVALID;
 121                 // position of the element in the paragraph
 122                 pos_type pos = 0;
 123                 // first position after the element in the paragraph
 124                 pos_type endpos = 0;
 125                 // The dimension of the chunk (does not contains the
 126                 // separator correction)
 127                 Dimension dim;
 128
 129                 // Non-zero only if element is an inset
 130                 Inset const * inset = nullptr;
 131
 132                 // Only non-null for justified rows
 133                 double extra = 0;
 134
 135                 // Non-empty if element is a string or is virtual
 136                 docstring str;
 137                 //
 138                 Font font;
 139                 //
 140                 Change change;
 141                 // is it possible to add contents to this element?
 142                 bool final = false;
 143                 // properties with respect to row breaking (made of RowFlag enums)
 144                 int row_flags = Inline;
 145
 146                 friend std::ostream & operator<<(std::ostream & os, Element const & row);
 147         };
 148
 149         ///
 150         typedef Element value_type;
 151
 152         ///
 153         Row() {}
 154
 155         /**
 156          * Helper function: set variable \c var to value \c val, and mark
 157          * row as changed is the values were different. This is intended
 158          * for use when changing members of the row object.
 159          */
 160         template<class T1, class T2>
 161         void change(T1 & var, T2 const val) {
 162                 if (var != val)
 163                         changed(true);
 164                 var = val;
 165         }
 166         /**
 167          * Helper function: set variable \c var to value \c val, and mark
 168          * row as changed is the values were different. This is intended
 169          * for use when changing members of the row object.
 170          * This is the const version, useful for mutable members.
 171          */
 172         template<class T1, class T2>
 173         void change(T1 & var, T2 const val) const {
 174                 if (var != val)
 175                         changed(true);
 176                 var = val;
 177         }
 178         ///
 179         bool changed() const { return changed_; }
 180         ///
 181         void changed(bool c) const { changed_ = c; }
 182         ///
 183         bool selection() const;
 184         /**
 185          * Set the selection begin and end and whether the left and/or
 186          * right margins are selected.
 187          * This is const because we update the selection status only at
 188          * draw() time.
 189          */
 190         void setSelectionAndMargins(DocIterator const & beg,
 191                 DocIterator const & end) const;
 192         /// no selection on this row.
 193         void clearSelectionAndMargins() const;
 194
 195         ///
 196         void pit(pit_type p) { pit_ = p; }
 197         ///
 198         pit_type pit() const { return pit_; }
 199         ///
 200         void pos(pos_type p) { pos_ = p; }
 201         ///
 202         pos_type pos() const { return pos_; }
 203         ///
 204         void endpos(pos_type p) { end_ = p; }
 205         ///
 206         pos_type endpos() const { return end_; }
 207         ///
 208         void right_boundary(bool b) { right_boundary_ = b; }
 209         ///
 210         bool right_boundary() const { return right_boundary_; }
 211         ///
 212         void flushed(bool b) { flushed_ = b; }
 213         ///
 214         bool flushed() const { return flushed_; }
 215
 216         ///
 217         Dimension const & dim() const { return dim_; }
 218         ///
 219         Dimension & dim() { return dim_; }
 220         ///
 221         int height() const { return dim_.height(); }
 222         /// The width of the row, including the left margin, but not the right one.
 223         int width() const { return dim_.wid; }
 224         ///
 225         int ascent() const { return dim_.asc; }
 226         ///
 227         int descent() const { return dim_.des; }
 228
 229         ///
 230         Dimension const & contents_dim() const { return contents_dim_; }
 231         ///
 232         Dimension & contents_dim() { return contents_dim_; }
 233
 234         /// The offset of the left-most cursor position on the row
 235         int left_x() const;
 236         /// The offset of the right-most cursor position on the row
 237         int right_x() const;
 238
 239         // Return the number of separators in the row
 240         int countSeparators() const;
 241         // Set the extra spacing for every expanding character in STRING-type
 242         // elements.  \param w is the total amount of extra width for the row to be
 243         // distributed among expanders.  \return false if the justification fails.
 244         bool setExtraWidth(int w);
 245
 246         ///
 247         void add(pos_type pos, Inset const * ins, Dimension const & dim,
 248                  Font const & f, Change const & ch);
 249         ///
 250         void add(pos_type pos, char_type const c,
 251                  Font const & f, Change const & ch, bool can_break);
 252         ///
 253         void addVirtual(pos_type pos, docstring const & s,
 254                         Font const & f, Change const & ch);
 255         ///
 256         void addSpace(pos_type pos, int width, Font const & f, Change const & ch);
 257
 258         ///
 259         typedef std::vector<Element> Elements;
 260         ///
 261         typedef Elements::iterator iterator;
 262         ///
 263         typedef Elements::const_iterator const_iterator;
 264         ///
 265         iterator begin() { return elements_.begin(); }
 266         ///
 267         iterator end() { return elements_.end(); }
 268         ///
 269         const_iterator begin() const { return elements_.begin(); }
 270         ///
 271         const_iterator end() const { return elements_.end(); }
 272
 273         ///
 274         bool empty() const { return elements_.empty(); }
 275         ///
 276         Element & front() { return elements_.front(); }
 277         ///
 278         Element const & front() const { return elements_.front(); }
 279         ///
 280         Element & back() { return elements_.back(); }
 281         ///
 282         Element const & back() const { return elements_.back(); }
 283         /// add element at the end and update width
 284         void push_back(Element const &);
 285         /// remove last element and update width
 286         void pop_back();
 287         /**
 288          * if row width is too large, remove all elements after last
 289          * separator and update endpos if necessary. If all that
 290          * remains is a large word, cut it to \param width.
 291          * \param width maximum width of the row.
 292          * \param available width on next row.
 293          * \return true if the row has been shortened.
 294          */
 295         Elements shortenIfNeeded(int const width, int const next_width);
 296
 297         /**
 298          * If last element of the row is a string, compute its width
 299          * and mark it final.
 300          */
 301         void finalizeLast();
 302
 303         /**
 304          * Find sequences of right-to-left elements and reverse them.
 305          * This should be called once the row is completely built.
 306          */
 307         void reverseRTL(bool rtl_par);
 308         ///
 309         bool isRTL() const { return rtl_; }
 310         ///
 311         bool needsChangeBar() const { return changebar_; }
 312         ///
 313         void needsChangeBar(bool ncb) { changebar_ = ncb; }
 314
 315         /// Find row element that contains \c pos, and compute x offset.
 316         const_iterator const findElement(pos_type pos, bool boundary, double & x) const;
 317
 318         friend std::ostream & operator<<(std::ostream & os, Row const & row);
 319
 320         /// additional width for separators in justified rows (i.e. space)
 321         double separator = 0;
 322         /// width of hfills in the label
 323         double label_hfill = 0;
 324         /// the left margin position of the row
 325         int left_margin = 0;
 326         /// the right margin of the row
 327         int right_margin = 0;
 328         ///
 329         mutable pos_type sel_beg = -1;
 330         ///
 331         mutable pos_type sel_end = -1;
 332         ///
 333         mutable bool begin_margin_sel = false;
 334         ///
 335         mutable bool end_margin_sel = false;
 336
 337 private:
 338         /// Decides whether the margin is selected.
 339         /**
 340           * \param margin_begin
 341           * \param beg
 342           * \param end
 343           */
 344         bool isMarginSelected(bool left, DocIterator const & beg,
 345                 DocIterator const & end) const;
 346         /// Set the selection begin and end.
 347         void setSelection(pos_type sel_beg, pos_type sel_end) const;
 348
 349         /**
 350          * Returns true if a char or string with font \c f and change
 351          * type \c ch can be added to the current last element of the
 352          * row.
 353          */
 354         bool sameString(Font const & f, Change const & ch) const;
 355
 356         ///
 357         Elements elements_;
 358
 359         /// has the Row appearance changed since last drawing?
 360         mutable bool changed_ = true;
 361         /// Index of the paragraph that contains this row
 362         pit_type pit_ = 0;
 363         /// first pos covered by this row
 364         pos_type pos_ = 0;
 365         /// one behind last pos covered by this row
 366         pos_type end_ = 0;
 367         // Is there a boundary at the end of the row (display inset...)
 368         bool right_boundary_ = false;
 369         // Shall the row be flushed when it is supposed to be justified?
 370         bool flushed_ = false;
 371         /// Row dimension.
 372         Dimension dim_;
 373         /// Row contents dimension. Does not contain the space above/below row.
 374         Dimension contents_dim_;
 375         /// true when this row lives in a right-to-left paragraph
 376         bool rtl_ = false;
 377         /// true when a changebar should be drawn in the margin
 378         bool changebar_ = false;
 379 };
 380
 381
 382 /**
 383  * Each paragraph is broken up into a number of rows on the screen.
 384  * This is a list of such on-screen rows, ordered from the top row
 385  * downwards.
 386  */
 387 typedef std::vector<Row> RowList;
 388
 389 } // namespace lyx
 390
 391 #endif