#include "Changes.h"
#include "Dimension.h"
#include "Font.h"
+#include "RowFlags.h"
#include "support/docstring.h"
#include "support/types.h"
* correspond to any paragraph contents
*/
VIRTUAL,
- // A stretchable space, basically
- SEPARATOR,
// An inset
INSET,
// Some spacing described by its width, not a string
- SPACE
+ SPACE,
+ // Spacing until the left margin, with a minimal value given
+ // by the initial width
+ MARGINSPACE
};
/**
* by other methods that need to parse the Row contents.
*/
struct Element {
+ //
Element(Type const t, pos_type p, Font const & f, Change const & ch)
- : type(t), pos(p), endpos(p + 1), inset(0),
- extra(0), font(f), change(ch), final(false) {}
-
- // returns total width of element, including separator overhead
- double width() const { return dim.wid + extra; };
- // returns position in pixels (from the left) of position
- // \param i in the row element.
+ : type(t), pos(p), endpos(p + 1), font(f), change(ch) {}
+
+
+ // Return total width of element, including separator overhead
+ // FIXME: Cache this value or the number of expanders?
+ double full_width() const { return dim.wid + extra * countExpanders(); }
+ // Return the number of expanding characters in the element (only STRING
+ // type).
+ int countExpanders() const;
+ // Return the amount of expansion: the number of expanding characters
+ // that get stretched during justification, times the em of the font
+ // (only STRING type).
+ int expansionAmount() const;
+ // set extra proportionally to the font em value.
+ void setExtra(double extra_per_em);
+
+ /** Return position in pixels (from the left) of position
+ * \param i in the row element.
+ */
double pos2x(pos_type const i) const;
-
/** Return character position that is the closest to
* pixel position \param x. The value \param x is
- * rounded to the actual pixel position. If \param
- * short is true, the pixel value is rounded by
- * default.
+ * adjusted to the actual pixel position.
*/
- pos_type x2pos(double &x, bool low = false) const;
+ pos_type x2pos(int &x) const;
+ /** Break the element in two if possible, so that its width is less
+ * than the required values.
+ * \return true if something has been done ; false if this is
+ * not needed or not possible.
+ * \param width: maximum width of the row.
+ * \param next_width: available width on next rows.
+ * \param force: if true, cut string at any place, even for
+ * languages that wrap at word delimiters; if false, do not
+ * break at all if first element would larger than \c width.
+ * \param tail: a vector of elements where the remainder of
+ * the text will be appended (empty if nothing happened).
+ */
+ // FIXME: ideally last parameter should be Elements&, but it is not possible.
+ bool splitAt(int width, int next_width, bool force, std::vector<Element> & tail);
+ // remove trailing spaces (useful for end of row)
+ void rtrim();
+
+ //
+ bool isRTL() const { return font.isVisibleRightToLeft(); }
+ // This is true for virtual elements.
+ bool isVirtual() const { return type == VIRTUAL; }
// Returns the position on left side of the element.
- pos_type left_pos() const;
+ pos_type left_pos() const { return isRTL() ? endpos : pos; };
// Returns the position on right side of the element.
- pos_type right_pos() const;
+ pos_type right_pos() const { return isRTL() ? pos : endpos; };
// The kind of row element
Type type;
pos_type pos;
// first position after the element in the paragraph
pos_type endpos;
- // The dimension of the chunk (does not contains the
+ // The dimension of the chunk (does not contain the
// separator correction)
Dimension dim;
+ // The width of the element without trailing spaces
+ int nspc_wid = 0;
// Non-zero only if element is an inset
- Inset const * inset;
+ Inset const * inset = nullptr;
- // Only non-null for separator elements
- double extra;
+ // Only non-null for justified rows
+ double extra = 0;
- // Non-empty if element is a string or separator
+ // Non-empty if element is a string or is virtual
docstring str;
//
Font font;
//
Change change;
// is it possible to add contents to this element?
- bool final;
+ bool final = false;
+ // properties with respect to row breaking (made of RowFlag enumerators)
+ int row_flags = Inline;
friend std::ostream & operator<<(std::ostream & os, Element const & row);
};
+ ///
+ typedef Element value_type;
///
- Row();
+ Row() {}
+
+ /**
+ * Helper function: set variable \c var to value \c val, and mark
+ * row as changed is the values were different. This is intended
+ * for use when changing members of the row object.
+ */
+ template<class T1, class T2>
+ void change(T1 & var, T2 const val) {
+ if (var != val)
+ changed(true);
+ var = val;
+ }
+ /**
+ * Helper function: set variable \c var to value \c val, and mark
+ * row as changed is the values were different. This is intended
+ * for use when changing members of the row object.
+ * This is the const version, useful for mutable members.
+ */
+ template<class T1, class T2>
+ void change(T1 & var, T2 const val) const {
+ if (var != val)
+ changed(true);
+ var = val;
+ }
///
bool changed() const { return changed_; }
///
- void setChanged(bool c) { changed_ = c; }
- ///
- void setCrc(size_type crc) const;
- /// Set the selection begin and end.
- /**
- * This is const because we update the selection status only at draw()
- * time.
- */
- void setSelection(pos_type sel_beg, pos_type sel_end) const;
+ void changed(bool c) const { changed_ = c; }
///
bool selection() const;
- /// Set the selection begin and end and whether the left and/or right
- /// margins are selected.
+ /**
+ * Set the selection begin and end and whether the left and/or
+ * right margins are selected.
+ * This is const because we update the selection status only at
+ * draw() time.
+ */
void setSelectionAndMargins(DocIterator const & beg,
DocIterator const & end) const;
+ /// no selection on this row.
+ void clearSelectionAndMargins() const;
+ ///
+ void pit(pit_type p) { pit_ = p; }
+ ///
+ pit_type pit() const { return pit_; }
///
void pos(pos_type p) { pos_ = p; }
///
///
pos_type endpos() const { return end_; }
///
- void right_boundary(bool b) { right_boundary_ = b; }
+ void end_boundary(bool b) { end_boundary_ = b; }
///
- bool right_boundary() const { return right_boundary_; }
+ bool end_boundary() const { return end_boundary_; }
+ ///
+ void flushed(bool b) { flushed_ = b; }
+ ///
+ bool flushed() const { return flushed_; }
///
- Dimension const & dimension() const { return dim_; }
+ Dimension const & dim() const { return dim_; }
///
- Dimension & dimension() { return dim_; }
+ Dimension & dim() { return dim_; }
///
int height() const { return dim_.height(); }
- ///
+ /// The width of the row, including the left margin, but not the right one.
int width() const { return dim_.wid; }
///
int ascent() const { return dim_.asc; }
///
int descent() const { return dim_.des; }
+ ///
+ Dimension const & contents_dim() const { return contents_dim_; }
+ ///
+ Dimension & contents_dim() { return contents_dim_; }
+
+ /// The offset of the left-most cursor position on the row
+ int left_x() const;
+ /// The offset of the right-most cursor position on the row
+ int right_x() const;
+
+ // Set the extra spacing for every expanding character in STRING-type
+ // elements. \param w is the total amount of extra width for the row to be
+ // distributed among expanders. \return false if the justification fails.
+ bool setExtraWidth(int w);
+
///
void add(pos_type pos, Inset const * ins, Dimension const & dim,
Font const & f, Change const & ch);
///
void add(pos_type pos, char_type const c,
- Font const & f, Change const & ch);
+ Font const & f, Change const & ch);
///
void addVirtual(pos_type pos, docstring const & s,
Font const & f, Change const & ch);
///
- void addSeparator(pos_type pos, char_type const c,
- Font const & f, Change const & ch);
- ///
void addSpace(pos_type pos, int width, Font const & f, Change const & ch);
+ ///
+ void addMarginSpace(pos_type pos, int width, Font const & f, Change const & ch);
///
typedef std::vector<Element> Elements;
Element & back() { return elements_.back(); }
///
Element const & back() const { return elements_.back(); }
- /// remove last element
+ /// add element at the end and update width
+ void push_back(Element const &);
+ /// remove last element and update width
void pop_back();
- /// remove all row elements
- void clear() { elements_.clear(); }
/**
* if row width is too large, remove all elements after last
* separator and update endpos if necessary. If all that
* remains is a large word, cut it to \param width.
- * \param body_pos minimum amount of text to keep.
- * \param width maximum width of the row
+ * \param width maximum width of the row.
+ * \param next_width available width on next row.
+ * \return list of elements remaining after breaking.
*/
- void shorten_if_needed(pos_type const body_pos, int const width);
+ Elements shortenIfNeeded(int const width, int const next_width);
/**
* If last element of the row is a string, compute its width
* Find sequences of right-to-left elements and reverse them.
* This should be called once the row is completely built.
*/
- void reverseRTL(bool rtl_par);
+ void reverseRTL();
+ ///
+ bool isRTL() const { return rtl_; }
+ ///
+ void setRTL(bool rtl) { rtl_ = rtl; }
+ ///
+ bool needsChangeBar() const { return changebar_; }
+ ///
+ void needsChangeBar(bool ncb) { changebar_ = ncb; }
+
+ /// Find row element that contains \c pos, and compute x offset.
+ const_iterator const findElement(pos_type pos, bool boundary, double & x) const;
friend std::ostream & operator<<(std::ostream & os, Row const & row);
- /// width of a separator (i.e. space)
- double separator;
+ /// additional width for separators in justified rows (i.e. space)
+ double separator = 0;
/// width of hfills in the label
- double label_hfill;
- /// the x position of the row (left margin)
- double x;
+ double label_hfill = 0;
+ /// the left margin position of the row
+ int left_margin = 0;
/// the right margin of the row
- int right_margin;
+ int right_margin = 0;
///
- mutable pos_type sel_beg;
+ mutable pos_type sel_beg = -1;
///
- mutable pos_type sel_end;
+ mutable pos_type sel_end = -1;
///
- mutable bool begin_margin_sel;
+ mutable bool begin_margin_sel = false;
///
- mutable bool end_margin_sel;
+ mutable bool end_margin_sel = false;
private:
/// Decides whether the margin is selected.
* \param beg
* \param end
*/
- bool isMarginSelected(bool left_margin, DocIterator const & beg,
+ bool isMarginSelected(bool left, DocIterator const & beg,
DocIterator const & end) const;
+ /// Set the selection begin and end.
+ void setSelection(pos_type sel_beg, pos_type sel_end) const;
/**
* Returns true if a char or string with font \c f and change
Elements elements_;
/// has the Row appearance changed since last drawing?
- mutable bool changed_;
- /// CRC of row contents.
- mutable size_type crc_;
+ mutable bool changed_ = true;
+ /// Index of the paragraph that contains this row
+ pit_type pit_ = 0;
/// first pos covered by this row
- pos_type pos_;
+ pos_type pos_ = 0;
/// one behind last pos covered by this row
- pos_type end_;
- // Is there is a boundary at the end of the row (display inset...)
- bool right_boundary_;
+ pos_type end_ = 0;
+ // Is there a boundary at the end of the row (display inset...)
+ bool end_boundary_ = false;
+ // Shall the row be flushed when it is supposed to be justified?
+ bool flushed_ = false;
/// Row dimension.
Dimension dim_;
+ /// Row contents dimension. Does not contain the space above/below row.
+ Dimension contents_dim_;
+ /// true when this row lives in a right-to-left paragraph
+ bool rtl_ = false;
+ /// true when a changebar should be drawn in the margin
+ bool changebar_ = false;
};
+std::ostream & operator<<(std::ostream & os, Row::Elements const & elts);
+
+
+/**
+ * Each paragraph is broken up into a number of rows on the screen.
+ * This is a list of such on-screen rows, ordered from the top row
+ * downwards.
+ */
+typedef std::vector<Row> RowList;
} // namespace lyx
projects / lyx.git / blobdiff