]> git.lyx.org Git - lyx.git/blobdiff - src/Row.cpp
Revert part of 47973dc2b, which was causing bug #11873.
[lyx.git] / src / Row.cpp
index 5bdcbe004bbb46f7443a30e1b05c6e3e7160bf31..1e9e3eca2bc7fc74a0af3fcf5bc740d00441352b 100644 (file)
@@ -19,6 +19,7 @@
 #include "Row.h"
 
 #include "DocIterator.h"
+#include "Language.h"
 
 #include "frontends/FontMetrics.h"
 
@@ -37,6 +38,10 @@ using support::rtrim;
 using frontend::FontMetrics;
 
 
+// Maximum length that a space can be stretched when justifying text
+static double const MAX_SPACE_STRETCH = 1.5; //em
+
+
 int Row::Element::countSeparators() const
 {
        if (type != STRING)
@@ -45,6 +50,30 @@ int Row::Element::countSeparators() const
 }
 
 
+int Row::Element::countExpanders() const
+{
+       if (type != STRING)
+               return 0;
+       return theFontMetrics(font).countExpanders(str);
+}
+
+
+int Row::Element::expansionAmount() const
+{
+       if (type != STRING)
+               return 0;
+       return countExpanders() * theFontMetrics(font).em();
+}
+
+
+void Row::Element::setExtra(double extra_per_em)
+{
+       if (type != STRING)
+               return;
+       extra = extra_per_em * theFontMetrics(font).em();
+}
+
+
 double Row::Element::pos2x(pos_type const i) const
 {
        // This can happen with inline completion when clicking on the
@@ -54,8 +83,7 @@ double Row::Element::pos2x(pos_type const i) const
 
        double w = 0;
        //handle first the two bounds of the element
-       if (i == endpos && type != VIRTUAL
-               && !(inset && inset->lyxCode() == SEPARATOR_CODE))
+       if (i == endpos && type != VIRTUAL)
                w = isRTL() ? 0 : full_width();
        else if (i == pos || type != STRING)
                w = isRTL() ? full_width() : 0;
@@ -88,18 +116,16 @@ pos_type Row::Element::x2pos(int &x) const
        case SPACE:
                // those elements contain only one position. Round to
                // the closest side.
-               if (x > full_width()) {
+               if (x > (full_width() + 1) / 2) {
                        x = int(full_width());
                        i = !isRTL();
                } else {
                        x = 0;
                        i = isRTL();
                }
-
        }
        //lyxerr << "=> p=" << pos + i << " x=" << x << endl;
        return pos + i;
-
 }
 
 
@@ -116,6 +142,7 @@ bool Row::Element::breakAt(int w, bool force)
                //lyxerr << "breakAt(" << w << ")  Row element Broken at " << x << "(w(str)=" << fm.width(str) << "): e=" << *this << endl;
                return true;
        }
+
        return false;
 }
 
@@ -136,42 +163,37 @@ Row::Row()
        : separator(0), label_hfill(0), left_margin(0), right_margin(0),
          sel_beg(-1), sel_end(-1),
          begin_margin_sel(false), end_margin_sel(false),
-         changed_(false), crc_(0), pos_(0), end_(0), right_boundary_(false)
+         changed_(true),
+         pit_(0), pos_(0), end_(0),
+         right_boundary_(false), flushed_(false), rtl_(false),
+         changebar_(false)
 {}
 
 
-void Row::setCrc(size_type crc) const
-{
-       changed_ = crc != crc_;
-       crc_ = crc;
-}
-
-
-bool Row::isMarginSelected(bool left_margin, DocIterator const & beg,
+bool Row::isMarginSelected(bool left, DocIterator const & beg,
                DocIterator const & end) const
 {
-       pos_type const sel_pos = left_margin ? sel_beg : sel_end;
-       pos_type const margin_pos = left_margin ? pos_ : end_;
-
-       // Is the chosen margin selected ?
-       if (sel_pos == margin_pos) {
-               if (beg.pos() == end.pos())
-                       // This is a special case in which the space between after
-                       // pos i-1 and before pos i is selected, i.e. the margins
-                       // (see DocIterator::boundary_).
-                       return beg.boundary() && !end.boundary();
-               else if (end.pos() == margin_pos)
-                       // If the selection ends around the margin, it is only
-                       // drawn if the cursor is after the margin.
-                       return !end.boundary();
-               else if (beg.pos() == margin_pos)
-                       // If the selection begins around the margin, it is
-                       // only drawn if the cursor is before the margin.
-                       return beg.boundary();
-               else
-                       return true;
-       }
-       return false;
+       pos_type const sel_pos = left ? sel_beg : sel_end;
+       pos_type const margin_pos = left ? pos_ : end_;
+
+       // Is there a selection and is the chosen margin selected ?
+       if (!selection() || sel_pos != margin_pos)
+               return false;
+       else if (beg.pos() == end.pos())
+               // This is a special case in which the space between after
+               // pos i-1 and before pos i is selected, i.e. the margins
+               // (see DocIterator::boundary_).
+               return beg.boundary() && !end.boundary();
+       else if (end.pos() == margin_pos)
+               // If the selection ends around the margin, it is only
+               // drawn if the cursor is after the margin.
+               return !end.boundary();
+       else if (beg.pos() == margin_pos)
+               // If the selection begins around the margin, it is
+               // only drawn if the cursor is before the margin.
+               return beg.boundary();
+       else
+               return true;
 }
 
 
@@ -180,28 +202,35 @@ void Row::setSelectionAndMargins(DocIterator const & beg,
 {
        setSelection(beg.pos(), end.pos());
 
-       if (selection()) {
-               end_margin_sel = isMarginSelected(false, beg, end);
-               begin_margin_sel = isMarginSelected(true, beg, end);
-       }
+       change(end_margin_sel, isMarginSelected(false, beg, end));
+       change(begin_margin_sel, isMarginSelected(true, beg, end));
+}
+
+
+void Row::clearSelectionAndMargins() const
+{
+       change(sel_beg, -1);
+       change(sel_end, -1);
+       change(end_margin_sel, false);
+       change(begin_margin_sel, false);
 }
 
 
 void Row::setSelection(pos_type beg, pos_type end) const
 {
        if (pos_ >= beg && pos_ <= end)
-               sel_beg = pos_;
+               change(sel_beg, pos_);
        else if (beg > pos_ && beg <= end_)
-               sel_beg = beg;
+               change(sel_beg, beg);
        else
-               sel_beg = -1;
+               change(sel_beg, -1);
 
        if (end_ >= beg && end_ <= end)
-               sel_end = end_;
+               change(sel_end,end_);
        else if (end < end_ && end >= pos_)
-               sel_end = end;
+               change(sel_end, end);
        else
-               sel_end = -1;
+               change(sel_end, -1);
 }
 
 
@@ -221,7 +250,7 @@ ostream & operator<<(ostream & os, Row::Element const & e)
        switch (e.type) {
        case Row::STRING:
                os << "STRING: `" << to_utf8(e.str) << "' ("
-                  << e.countSeparators() << " sep.), ";
+                  << e.countExpanders() << " expanders.), ";
                break;
        case Row::VIRTUAL:
                os << "VIRTUAL: `" << to_utf8(e.str) << "', ";
@@ -247,7 +276,7 @@ ostream & operator<<(ostream & os, Row const & row)
           << " ascent: " << row.dim_.asc
           << " descent: " << row.dim_.des
           << " separator: " << row.separator
-          << " label_hfill: " << row.label_hfill 
+          << " label_hfill: " << row.label_hfill
           << " row_boundary: " << row.right_boundary() << "\n";
        double x = row.left_margin;
        Row::Elements::const_iterator it = row.elements_.begin();
@@ -298,13 +327,30 @@ int Row::countSeparators() const
 }
 
 
-void Row::setSeparatorExtraWidth(double w)
+bool Row::setExtraWidth(int w)
 {
-       separator = w;
-       iterator const end = elements_.end();
-       for (iterator it = elements_.begin() ; it != end ; ++it)
-               if (it->type == Row::STRING)
-                       it->extra = w;
+       if (w < 0)
+               // this is not expected to happen (but it does)
+               return false;
+       // amount of expansion: number of expanders time the em value for each
+       // string element
+       int exp_amount = 0;
+       for (Row::Element const & e : elements_)
+               exp_amount += e.expansionAmount();
+       if (!exp_amount)
+               return false;
+       // extra length per expander per em
+       double extra_per_em = double(w) / exp_amount;
+       if (extra_per_em > MAX_SPACE_STRETCH)
+               // do not stretch more than MAX_SPACE_STRETCH em per expander
+               return false;
+       // add extra length to each element proportionally to its em.
+       for (Row::Element & e : elements_)
+               if (e.type == Row::STRING)
+                       e.setExtra(extra_per_em);
+       // update row dimension
+       dim_.wid += w;
+       return true;
 }
 
 
@@ -326,6 +372,8 @@ void Row::finalizeLast()
        if (elt.final)
                return;
        elt.final = true;
+       if (elt.change.changed())
+               changebar_ = true;
 
        if (elt.type == STRING) {
                dim_.wid -= elt.dim.wid;
@@ -344,6 +392,7 @@ void Row::add(pos_type const pos, Inset const * ins, Dimension const & dim,
        e.dim = dim;
        elements_.push_back(e);
        dim_.wid += dim.wid;
+       changebar_ |= ins->isChanged();
 }
 
 
@@ -400,10 +449,10 @@ void Row::pop_back()
 }
 
 
-void Row::shortenIfNeeded(pos_type const keep, int const w)
+bool Row::shortenIfNeeded(pos_type const keep, int const w, int const next_width)
 {
        if (empty() || width() <= w)
-               return;
+               return false;
 
        Elements::iterator const beg = elements_.begin();
        Elements::iterator const end = elements_.end();
@@ -420,7 +469,7 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
        if (cit == end) {
                // This should not happen since the row is too long.
                LYXERR0("Something is wrong cannot shorten row: " << *this);
-               return;
+               return false;
        }
 
        // Iterate backwards over breakable elements and try to break them
@@ -432,7 +481,22 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
                // make a copy of the element to work on it.
                Element brk = *cit_brk;
                wid_brk -= brk.dim.wid;
-               if (brk.countSeparators() == 0 || brk.pos < keep)
+               /*
+                * Some Asian languages split lines anywhere (no notion of
+                * word). It seems that QTextLayout is not aware of this fact.
+                * See for reference:
+                *    https://en.wikipedia.org/wiki/Line_breaking_rules_in_East_Asian_languages
+                *
+                * FIXME: Something shall be done about characters which are
+                * not allowed at the beginning or end of line.
+                *
+                * FIXME: hardcoding languages is bad. Put this information in
+                * `languages' file.
+               */
+               bool const word_wrap = brk.font.language()->wordWrap();
+               // When there is text before the body part (think description
+               // environment), do not try to break.
+               if (brk.pos < keep)
                        continue;
                /* We have found a suitable separable element. This is the common case.
                 * Try to break it cleanly (at word boundary) at a length that is both
@@ -440,21 +504,21 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
                 * - shorter than the natural width of the element, in order to enforce
                 *   break-up.
                 */
-               if (brk.breakAt(min(w - wid_brk, brk.dim.wid - 2), false)) {
+               if (brk.breakAt(min(w - wid_brk, brk.dim.wid - 2), !word_wrap)) {
                        /* if this element originally did not cause a row overflow
                         * in itself, and the remainder of the row would still be
                         * too large after breaking, then we will have issues in
                         * next row. Thus breaking does not help.
                         */
                        if (wid_brk + cit_brk->dim.wid < w
-                           && dim_.wid - (wid_brk + brk.dim.wid) >= w) {
+                           && dim_.wid - (wid_brk + brk.dim.wid) >= next_width) {
                                break;
                        }
                        end_ = brk.endpos;
                        /* after breakAt, there may be spaces at the end of the
                         * string, but they are not counted in the string length
                         * (QTextLayout feature, actually). We remove them, but do
-                        * not change the endo of the row, since the spaces at row
+                        * not change the end of the row, since spaces at row
                         * break are invisible.
                         */
                        brk.str = rtrim(brk.str);
@@ -463,7 +527,7 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
                        dim_.wid = wid_brk + brk.dim.wid;
                        // If there are other elements, they should be removed.
                        elements_.erase(cit_brk + 1, end);
-                       return;
+                       return true;
                }
        }
 
@@ -480,7 +544,7 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
                end_ = cit->pos;
                dim_.wid = wid;
                elements_.erase(cit, end);
-               return;
+               return true;
        }
 
        /* If we are here, it means that we have not found a separator to
@@ -495,7 +559,9 @@ void Row::shortenIfNeeded(pos_type const keep, int const w)
                dim_.wid = wid + cit->dim.wid;
                // If there are other elements, they should be removed.
                elements_.erase(next(cit, 1), end);
+               return true;
        }
+       return false;
 }
 
 
@@ -518,6 +584,56 @@ void Row::reverseRTL(bool const rtl_par)
        // If the paragraph itself is RTL, reverse everything
        if (rtl_par)
                reverse(elements_.begin(), elements_.end());
+       rtl_ = rtl_par;
+}
+
+Row::const_iterator const
+Row::findElement(pos_type const pos, bool const boundary, double & x) const
+{
+       /**
+        * When boundary is true, position i is in the row element (pos, endpos)
+        * if
+        *    pos < i <= endpos
+        * whereas, when boundary is false, the test is
+        *    pos <= i < endpos
+        * The correction below allows to handle both cases.
+       */
+       int const boundary_corr = (boundary && pos) ? -1 : 0;
+
+       x = left_margin;
+
+       /** Early return in trivial cases
+        * 1) the row is empty
+        * 2) the position is the left-most position of the row; there
+        * is a quirk here however: if the first element is virtual
+        * (end-of-par marker for example), then we have to look
+        * closer
+        */
+       if (empty()
+           || (pos == begin()->left_pos() && !boundary
+                       && !begin()->isVirtual()))
+               return begin();
+
+       Row::const_iterator cit = begin();
+       for ( ; cit != end() ; ++cit) {
+               /** Look whether the cursor is inside the element's
+                * span. Note that it is necessary to take the
+                * boundary into account, and to accept virtual
+                * elements, which have pos == endpos.
+                */
+               if (pos + boundary_corr >= cit->pos
+                   && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
+                               x += cit->pos2x(pos);
+                               break;
+               }
+               x += cit->full_width();
+       }
+
+       if (cit == end())
+               --cit;
+
+       return cit;
 }
 
+
 } // namespace lyx