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