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                 // A stretchable space, basically
  50                 SEPARATOR,
  51                 // An inset
  52                 INSET,
  53                 // Some spacing described by its width, not a string
  54                 SPACE
  55         };
  56
  57 /**
  58  * One element of a Row. It has a set of attributes that can be used
  59  * by other methods that need to parse the Row contents.
  60  */
  61         struct Element {
  62                 Element(Type const t, pos_type p, Font const & f, Change const & ch)
  63                         : type(t), pos(p), endpos(p + 1), inset(0),
  64                           extra(0), font(f), change(ch), final(false) {}
  65
  66                 // returns total width of element, including separator overhead
  67                 double width() const { return dim.wid + extra; };
  68                 // returns position in pixels (from the left) of position
  69                 // \param i in the row element.
  70                 double pos2x(pos_type const i) const;
  71
  72                 /** Return character position that is the closest to
  73                  *  pixel position \param x. The value \param x is
  74                  *  adjusted to the actual pixel position.
  75                 */
  76                 pos_type x2pos(double &x) const;
  77
  78                 // Returns the position on left side of the element.
  79                 pos_type left_pos() const;
  80                 // Returns the position on right side of the element.
  81                 pos_type right_pos() const;
  82
  83                 // The kind of row element
  84                 Type type;
  85                 // position of the element in the paragraph
  86                 pos_type pos;
  87                 // first position after the element in the paragraph
  88                 pos_type endpos;
  89                 // The dimension of the chunk (does not contains the
  90                 // separator correction)
  91                 Dimension dim;
  92
  93                 // Non-zero only if element is an inset
  94                 Inset const * inset;
  95
  96                 // Only non-null for separator elements
  97                 double extra;
  98
  99                 // Non-empty if element is a string or separator
 100                 docstring str;
 101                 //
 102                 Font font;
 103                 //
 104                 Change change;
 105                 // is it possible to add contents to this element?
 106                 bool final;
 107
 108                 friend std::ostream & operator<<(std::ostream & os, Element const & row);
 109         };
 110
 111
 112         ///
 113         Row();
 114         ///
 115         bool changed() const { return changed_; }
 116         ///
 117         void setChanged(bool c) { changed_ = c; }
 118         ///
 119         void setCrc(size_type crc) const;
 120         /// Set the selection begin and end.
 121         /**
 122           * This is const because we update the selection status only at draw()
 123           * time.
 124           */
 125         void setSelection(pos_type sel_beg, pos_type sel_end) const;
 126         ///
 127         bool selection() const;
 128         /// Set the selection begin and end and whether the left and/or right
 129         /// margins are selected.
 130         void setSelectionAndMargins(DocIterator const & beg,
 131                 DocIterator const & end) const;
 132
 133         ///
 134         void pos(pos_type p) { pos_ = p; }
 135         ///
 136         pos_type pos() const { return pos_; }
 137         ///
 138         void endpos(pos_type p) { end_ = p; }
 139         ///
 140         pos_type endpos() const { return end_; }
 141         ///
 142         void right_boundary(bool b) { right_boundary_ = b; }
 143         ///
 144         bool right_boundary() const { return right_boundary_; }
 145
 146         ///
 147         Dimension const & dimension() const { return dim_; }
 148         ///
 149         Dimension & dimension() { return dim_; }
 150         ///
 151         int height() const { return dim_.height(); }
 152         ///
 153         int width() const { return dim_.wid; }
 154         ///
 155         int ascent() const { return dim_.asc; }
 156         ///
 157         int descent() const { return dim_.des; }
 158
 159         ///
 160         void add(pos_type pos, Inset const * ins, Dimension const & dim,
 161                  Font const & f, Change const & ch);
 162         ///
 163         void add(pos_type pos, char_type const c,
 164                  Font const & f, Change const & ch);
 165         ///
 166         void addVirtual(pos_type pos, docstring const & s,
 167                         Font const & f, Change const & ch);
 168         ///
 169         void addSeparator(pos_type pos, char_type const c,
 170                           Font const & f, Change const & ch);
 171         ///
 172         void addSpace(pos_type pos, int width, Font const & f, Change const & ch);
 173
 174         ///
 175         typedef std::vector<Element> Elements;
 176         ///
 177         typedef Elements::iterator iterator;
 178         ///
 179         typedef Elements::const_iterator const_iterator;
 180         ///
 181         iterator begin() { return elements_.begin(); }
 182         ///
 183         iterator end() { return elements_.end(); }
 184         ///
 185         const_iterator begin() const { return elements_.begin(); }
 186         ///
 187         const_iterator end() const { return elements_.end(); }
 188
 189         ///
 190         bool empty() const { return elements_.empty(); }
 191         ///
 192         Element & front() { return elements_.front(); }
 193         ///
 194         Element const & front() const { return elements_.front(); }
 195         ///
 196         Element & back() { return elements_.back(); }
 197         ///
 198         Element const & back() const { return elements_.back(); }
 199         /// remove last element
 200         void pop_back();
 201         /// remove all row elements
 202         void clear() { elements_.clear(); }
 203         /**
 204          * if row width is too large, remove all elements after last
 205          * separator and update endpos if necessary. If all that
 206          * remains is a large word, cut it to \param width.
 207          * \param body_pos minimum amount of text to keep.
 208          * \param width maximum width of the row
 209          */
 210         void shorten_if_needed(pos_type const body_pos, int const width);
 211
 212         /**
 213          * If last element of the row is a string, compute its width
 214          * and mark it final.
 215          */
 216         void finalizeLast();
 217
 218         /**
 219          * Find sequences of right-to-left elements and reverse them.
 220          * This should be called once the row is completely built.
 221          */
 222         void reverseRTL(bool rtl_par);
 223
 224         friend std::ostream & operator<<(std::ostream & os, Row const & row);
 225
 226         /// width of a separator (i.e. space)
 227         double separator;
 228         /// width of hfills in the label
 229         double label_hfill;
 230         /// the x position of the row (left margin)
 231         double x;
 232         /// the right margin of the row
 233         int right_margin;
 234         ///
 235         mutable pos_type sel_beg;
 236         ///
 237         mutable pos_type sel_end;
 238         ///
 239         mutable bool begin_margin_sel;
 240         ///
 241         mutable bool end_margin_sel;
 242
 243 private:
 244         /// Decides whether the margin is selected.
 245         /**
 246           * \param margin_begin
 247           * \param beg
 248           * \param end
 249           */
 250         bool isMarginSelected(bool left_margin, DocIterator const & beg,
 251                 DocIterator const & end) const;
 252
 253         /**
 254          * Returns true if a char or string with font \c f and change
 255          * type \c ch can be added to the current last element of the
 256          * row.
 257          */
 258         bool sameString(Font const & f, Change const & ch) const;
 259
 260         ///
 261         Elements elements_;
 262
 263         /// has the Row appearance changed since last drawing?
 264         mutable bool changed_;
 265         /// CRC of row contents.
 266         mutable size_type crc_;
 267         /// first pos covered by this row
 268         pos_type pos_;
 269         /// one behind last pos covered by this row
 270         pos_type end_;
 271         // Is there is a boundary at the end of the row (display inset...)
 272         bool right_boundary_;
 273         /// Row dimension.
 274         Dimension dim_;
 275 };
 276
 277
 278 } // namespace lyx
 279
 280 #endif