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