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