]> git.lyx.org Git - features.git/blobdiff - src/Row.cpp
Break the paragraph's big row according to margins
[features.git] / src / Row.cpp
index cc78cff3390f8e3579164155f98f90b0174b4d07..705a147389eec047f4516a0262e24e2936c3e55e 100644 (file)
 #include "Row.h"
 
 #include "DocIterator.h"
+#include "Language.h"
 
 #include "frontends/FontMetrics.h"
 
 #include "support/debug.h"
 #include "support/lassert.h"
 #include "support/lstrings.h"
-#include "support/lyxalgo.h"
+#include "support/lyxlib.h"
 
+#include <algorithm>
 #include <ostream>
 
 using namespace std;
@@ -95,7 +97,7 @@ double Row::Element::pos2x(pos_type const i) const
 }
 
 
-pos_type Row::Element::x2pos(int &x, bool const select) const
+pos_type Row::Element::x2pos(int &x) const
 {
        //lyxerr << "x2pos: x=" << x << " w=" << width() << " " << *this;
        size_t i = 0;
@@ -112,126 +114,115 @@ pos_type Row::Element::x2pos(int &x, bool const select) const
                x = isRTL() ? int(full_width()) : 0;
                break;
        case INSET:
-       case SPACE: {
-               int const boundary = select ? (full_width() + 1) / 2 : full_width();
+       case SPACE:
                // those elements contain only one position. Round to
                // the closest side.
-               if (x > boundary) {
+               if (x > (full_width() + 1) / 2) {
                        x = int(full_width());
                        i = !isRTL();
                } else {
                        x = 0;
                        i = isRTL();
                }
-       }
+               break;
+       case INVALID:
+               LYXERR0("x2pos: INVALID row element !");
        }
        //lyxerr << "=> p=" << pos + i << " x=" << x << endl;
        return pos + i;
 }
 
 
-bool Row::Element::breakAt(int w, bool force)
+Row::Element Row::Element::splitAt(int w, bool force)
 {
-       if (type != STRING || dim.wid <= w)
-               return false;
+       if (type != STRING || !(row_flags & CanBreakInside))
+               return Element();
 
        FontMetrics const & fm = theFontMetrics(font);
-       int x = w;
-       if(fm.breakAt(str, x, isRTL(), force)) {
-               dim.wid = x;
-               endpos = pos + str.length();
+       dim.wid = w;
+       int const i = fm.breakAt(str, dim.wid, isRTL(), force);
+       if (i != -1) {
+               Element ret(STRING, pos + i, font, change);
+               ret.str = str.substr(i);
+               ret.endpos = ret.pos + ret.str.length();
+               ret.row_flags = row_flags & (CanBreakInside | AfterFlags);
+               str.erase(i);
+               endpos = pos + i;
                //lyxerr << "breakAt(" << w << ")  Row element Broken at " << x << "(w(str)=" << fm.width(str) << "): e=" << *this << endl;
-               return true;
+               return ret;
        }
 
-       return false;
+       return Element();
 }
 
 
-pos_type Row::Element::left_pos() const
+bool Row::Element::breakAt(int w, bool force)
 {
-       return isRTL() ? endpos : pos;
+       return splitAt(w, force).isValid();
 }
 
 
-pos_type Row::Element::right_pos() const
+bool Row::isMarginSelected(bool left, DocIterator const & beg,
+               DocIterator const & end) const
 {
-       return isRTL() ? pos : endpos;
-}
-
-
-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),
-         pit_(0), pos_(0), end_(0),
-         right_boundary_(false), flushed_(false), rtl_(false)
-{}
+       pos_type const sel_pos = left ? sel_beg : sel_end;
+       pos_type const margin_pos = left ? pos_ : end_;
 
-
-void Row::setCrc(size_type crc) const
-{
-       changed_ = crc != crc_;
-       crc_ = crc;
+       // 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;
 }
 
 
-bool Row::isMarginSelected(bool left_margin, DocIterator const & beg,
+void Row::setSelectionAndMargins(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;
+       setSelection(beg.pos(), end.pos());
+
+       change(end_margin_sel, isMarginSelected(false, beg, end));
+       change(begin_margin_sel, isMarginSelected(true, beg, end));
 }
 
 
-void Row::setSelectionAndMargins(DocIterator const & beg,
-               DocIterator const & end) const
+void Row::clearSelectionAndMargins() const
 {
-       setSelection(beg.pos(), end.pos());
-
-       if (selection()) {
-               end_margin_sel = isMarginSelected(false, beg, end);
-               begin_margin_sel = isMarginSelected(true, beg, end);
-       }
+       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);
 }
 
 
@@ -262,6 +253,9 @@ ostream & operator<<(ostream & os, Row::Element const & e)
        case Row::SPACE:
                os << "SPACE: ";
                break;
+       case Row::INVALID:
+               os << "INVALID: ";
+               break;
        }
        os << "width=" << e.full_width();
        return os;
@@ -277,7 +271,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,7 +292,7 @@ int Row::left_x() const
                x += cit->full_width();
                ++cit;
        }
-       return int(x + 0.5);
+       return support::iround(x);
 }
 
 
@@ -314,7 +308,7 @@ int Row::right_x() const
                else
                        break;
        }
-       return int(x + 0.5);
+       return support::iround(x);
 }
 
 
@@ -336,7 +330,7 @@ bool Row::setExtraWidth(int w)
        // amount of expansion: number of expanders time the em value for each
        // string element
        int exp_amount = 0;
-       for (Row::Element const & e : elements_)
+       for (Element const & e : elements_)
                exp_amount += e.expansionAmount();
        if (!exp_amount)
                return false;
@@ -346,8 +340,8 @@ bool Row::setExtraWidth(int w)
                // 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)
+       for (Element & e : elements_)
+               if (e.type == STRING)
                        e.setExtra(extra_per_em);
        // update row dimension
        dim_.wid += w;
@@ -373,6 +367,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;
@@ -383,23 +379,26 @@ void Row::finalizeLast()
 
 
 void Row::add(pos_type const pos, Inset const * ins, Dimension const & dim,
-             Font const & f, Change const & ch)
+              Font const & f, Change const & ch)
 {
        finalizeLast();
        Element e(INSET, pos, f, ch);
        e.inset = ins;
        e.dim = dim;
+       e.row_flags = ins->rowFlags();
        elements_.push_back(e);
        dim_.wid += dim.wid;
+       changebar_ |= ins->isChanged();
 }
 
 
 void Row::add(pos_type const pos, char_type const c,
-             Font const & f, Change const & ch)
+              Font const & f, Change const & ch, bool can_break)
 {
        if (!sameString(f, ch)) {
                finalizeLast();
                Element e(STRING, pos, f, ch);
+               e.row_flags = can_break ? CanBreakInside : Inline;
                elements_.push_back(e);
        }
        if (back().str.length() % 30 == 0) {
@@ -424,6 +423,10 @@ void Row::addVirtual(pos_type const pos, docstring const & s,
        e.dim.wid = theFontMetrics(f).width(s);
        dim_.wid += e.dim.wid;
        e.endpos = pos;
+       // Copy after* flags from previous elements, forbid break before element
+       int const prev_row_flags = elements_.empty() ? Inline : elements_.back().row_flags;
+       int const can_inherit = AfterFlags & ~AlwaysBreakAfter;
+       e.row_flags = (prev_row_flags & can_inherit) | NoBreakBefore;
        elements_.push_back(e);
        finalizeLast();
 }
@@ -440,6 +443,13 @@ void Row::addSpace(pos_type const pos, int const width,
 }
 
 
+void Row::push_back(Row::Element const & e)
+{
+       dim_.wid += e.dim.wid;
+       elements_.push_back(e);
+}
+
+
 void Row::pop_back()
 {
        dim_.wid -= elements_.back().dim.wid;
@@ -447,7 +457,7 @@ void Row::pop_back()
 }
 
 
-bool Row::shortenIfNeeded(pos_type const keep, int const w, int const next_width)
+bool Row::shortenIfNeeded(int const w, int const next_width)
 {
        if (empty() || width() <= w)
                return false;
@@ -478,16 +488,35 @@ bool Row::shortenIfNeeded(pos_type const keep, int const w, int const next_width
                --cit_brk;
                // make a copy of the element to work on it.
                Element brk = *cit_brk;
+               /* If the current element is an inset that allows breaking row
+                * after itself, and if the row is already short enough after
+                * this inset, then cut right after this element.
+                */
+               if (wid_brk <= w && brk.row_flags & CanBreakAfter) {
+                       end_ = brk.endpos;
+                       dim_.wid = wid_brk;
+                       elements_.erase(cit_brk + 1, end);
+                       return true;
+               }
+               // assume now that the current element is not there
                wid_brk -= brk.dim.wid;
-               if (brk.countSeparators() == 0 || brk.pos < keep)
-                       continue;
+               /*
+                * 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.
+               */
+               bool const word_wrap = brk.font.language()->wordWrap();
                /* 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
                 * - less than the available space on the row
                 * - 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
@@ -597,17 +626,19 @@ Row::findElement(pos_type const pos, bool const boundary, double & x) const
                        && !begin()->isVirtual()))
                return begin();
 
-       Row::const_iterator cit = begin();
+       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.
+               /** 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, in which case the position
+                * will be before the virtual element.
                 */
-               if (pos + boundary_corr >= cit->pos
-                   && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
-                               x += cit->pos2x(pos);
-                               break;
+               if (cit->isVirtual() && pos + boundary_corr == cit->pos)
+                       break;
+               else if (pos + boundary_corr >= cit->pos
+                        && pos + boundary_corr < cit->endpos) {
+                       x += cit->pos2x(pos);
+                       break;
                }
                x += cit->full_width();
        }