]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.cpp
More requires --> required, for C++2a.
[lyx.git] / src / TextMetrics.cpp
index 2b0903c750d23f1398d462db0ddb8e8956300eb5..796e1bd25ec949f3c50a229f8ae33b93d5f75c8a 100644 (file)
@@ -48,6 +48,8 @@
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/lassert.h"
+#include "support/lyxlib.h"
+#include "support/RefChanger.h"
 
 #include <stdlib.h>
 #include <cmath>
@@ -125,13 +127,6 @@ bool TextMetrics::contains(pit_type pit) const
 }
 
 
-ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
-{
-       return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
-}
-
-
-
 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
 {
        ParMetricsCache::const_iterator it = par_metrics_.begin();
@@ -147,6 +142,30 @@ pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
 }
 
 
+bool TextMetrics::isLastRow(Row const & row) const
+{
+       ParagraphList const & pars = text_->paragraphs();
+       return row.endpos() >= pars[row.pit()].size()
+               && row.pit() + 1 == pit_type(pars.size());
+}
+
+
+bool TextMetrics::isFirstRow(Row const & row) const
+{
+       return row.pos() == 0 && row.pit() == 0;
+}
+
+
+void TextMetrics::setRowChanged(pit_type pit, pos_type pos)
+{
+       for (auto & pm_pair : par_metrics_)
+               if (pm_pair.first == pit)
+                       for (Row & row : pm_pair.second.rows())
+                               if (row.pos() == pos)
+                                       row.changed(true);
+}
+
+
 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
 {
        ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
@@ -160,6 +179,42 @@ ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
 }
 
 
+ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
+{
+       return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
+}
+
+
+void TextMetrics::newParMetricsDown()
+{
+       pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
+       pit_type const pit = last.first + 1;
+       if (pit == int(text_->paragraphs().size()))
+               return;
+
+       // do it and update its position.
+       redoParagraph(pit);
+       par_metrics_[pit].setPosition(last.second.position()
+               + last.second.descent() + par_metrics_[pit].ascent());
+       updatePosCache(pit);
+}
+
+
+void TextMetrics::newParMetricsUp()
+{
+       pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
+       if (first.first == 0)
+               return;
+
+       pit_type const pit = first.first - 1;
+       // do it and update its position.
+       redoParagraph(pit);
+       par_metrics_[pit].setPosition(first.second.position()
+               - first.second.ascent() - par_metrics_[pit].descent());
+       updatePosCache(pit);
+}
+
+
 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width,
                          bool const expand_on_multipars)
 {
@@ -182,13 +237,21 @@ bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width,
        bool changed = false;
        unsigned int h = 0;
        for (pit_type pit = 0; pit != npar; ++pit) {
-               changed |= redoParagraph(pit);
+               // create rows, but do not set alignment yet
+               changed |= redoParagraph(pit, false);
                ParagraphMetrics const & pm = par_metrics_[pit];
                h += pm.height();
                if (dim_.wid < pm.width())
                        dim_.wid = pm.width();
        }
 
+       // Now set alignment for all rows (the width might not have been known before).
+       for (pit_type pit = 0; pit != npar; ++pit) {
+               ParagraphMetrics & pm = par_metrics_[pit];
+               for (Row & row : pm.rows())
+                       setRowAlignment(row, dim_.wid);
+       }
+
        dim_.asc = par_metrics_[0].ascent();
        dim_.des = h - dim_.asc;
        //lyxerr << "dim_.wid " << dim_.wid << endl;
@@ -354,7 +417,7 @@ bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
 }
 
 
-bool TextMetrics::redoParagraph(pit_type const pit)
+bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
 {
        Paragraph & par = text_->getPar(pit);
        // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
@@ -370,8 +433,9 @@ bool TextMetrics::redoParagraph(pit_type const pit)
        // FIXME: This check ought to be done somewhere else. It is the reason
        // why text_ is not const. But then, where else to do it?
        // Well, how can you end up with either (a) a biblio environment that
-       // has no InsetBibitem or (b) a biblio environment with more than one
-       // InsetBibitem? I think the answer is: when paragraphs are merged;
+       // has no InsetBibitem, (b) a biblio environment with more than one
+       // InsetBibitem or (c) a paragraph that has a bib item but is no biblio
+       // environment? I think the answer is: when paragraphs are merged;
        // when layout is set; when material is pasted.
        if (par.brokenBiblio()) {
                Cursor & cur = const_cast<Cursor &>(bv_->cursor());
@@ -462,10 +526,11 @@ bool TextMetrics::redoParagraph(pit_type const pit)
        do {
                if (row_index == pm.rows().size())
                        pm.rows().push_back(Row());
+               else
+                       pm.rows()[row_index] = Row();
                Row & row = pm.rows()[row_index];
                row.pit(pit);
                row.pos(first);
-               row.pit(pit);
                need_new_row = breakRow(row, right_margin);
                setRowHeight(row);
                row.changed(true);
@@ -474,14 +539,14 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                        /* If there is more than one row or the row has been
                         * broken by a display inset or a newline, expand the text
                         * to the full allowable width. This setting here is
-                        * needed for the computeRowMetrics() below.
+                        * needed for the setRowAlignment() below.
                         * We do nothing when inside a table cell.
                         */
                        if (dim_.wid < max_width_)
                                dim_.wid = max_width_;
                }
-               int const max_row_width = max(dim_.wid, row.width());
-               computeRowMetrics(row, max_row_width);
+               if (align_rows)
+                       setRowAlignment(row, max(dim_.wid, row.width()));
                first = row.endpos();
                ++row_index;
 
@@ -499,7 +564,7 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                // original value was 20px, which is 0.2in at 100dpi
                int const margin = bv_->zoomedPixels(20);
                if (pit == 0) {
-                       pm.rows().front().dimension().asc += margin;
+                       pm.rows().front().dim().asc += margin;
                        /* coverity thinks that we should update pm.dim().asc
                         * below, but all the rows heights are actually counted as
                         * part of the paragraph metric descent see loop above).
@@ -509,16 +574,16 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                }
                ParagraphList const & pars = text_->paragraphs();
                if (pit + 1 == pit_type(pars.size())) {
-                       pm.rows().back().dimension().des += margin;
+                       pm.rows().back().dim().des += margin;
                        pm.dim().des += margin;
                }
        }
 
        // The space above and below the paragraph.
        int const top = parTopSpacing(pit);
-       pm.rows().front().dimension().asc += top;
+       pm.rows().front().dim().asc += top;
        int const bottom = parBottomSpacing(pit);
-       pm.rows().back().dimension().des += bottom;
+       pm.rows().back().dim().des += bottom;
        pm.dim().des += top + bottom;
 
        pm.dim().asc += pm.rows()[0].ascent();
@@ -532,7 +597,7 @@ bool TextMetrics::redoParagraph(pit_type const pit)
 
 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 {
-       LyXAlignment align = par.getAlign();
+       LyXAlignment align = par.getAlign(bv_->buffer().params());
 
        // handle alignment inside tabular cells
        Inset const & owner = text_->inset();
@@ -588,7 +653,7 @@ LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 }
 
 
-void TextMetrics::computeRowMetrics(Row & row, int width) const
+void TextMetrics::setRowAlignment(Row & row, int width) const
 {
        row.label_hfill = 0;
        row.separator = 0;
@@ -641,28 +706,28 @@ void TextMetrics::computeRowMetrics(Row & row, int width) const
                        if (!row.setExtraWidth(w) && row.isRTL()) {
                                // Justification failed and the text is RTL: align to the right
                                row.left_margin += w;
-                               row.dimension().wid += w;
+                               row.dim().wid += w;
                        }
                        break;
                case LYX_ALIGN_LEFT:
                        // a displayed inset that is flushed
                        if (Inset const * inset = par.getInset(row.pos())) {
                                row.left_margin += inset->indent(*bv_);
-                               row.dimension().wid += inset->indent(*bv_);
+                               row.dim().wid += inset->indent(*bv_);
                        }
                        break;
                case LYX_ALIGN_RIGHT:
                        if (Inset const * inset = par.getInset(row.pos())) {
                                int const new_w = max(w - inset->indent(*bv_), 0);
                                row.left_margin += new_w;
-                               row.dimension().wid += new_w;
+                               row.dim().wid += new_w;
                        } else {
                                row.left_margin += w;
-                               row.dimension().wid += w;
+                               row.dim().wid += w;
                        }
                        break;
                case LYX_ALIGN_CENTER:
-                       row.dimension().wid += w / 2;
+                       row.dim().wid += w / 2;
                        row.left_margin += w / 2;
                        break;
                case LYX_ALIGN_NONE:
@@ -677,7 +742,7 @@ void TextMetrics::computeRowMetrics(Row & row, int width) const
        // Case nh > 0. There are hfill separators.
        hfill = w / nh;
        hfill_rem = w % nh;
-       row.dimension().wid += w;
+       row.dim().wid += w;
        // Set size of hfill insets
        pos_type const endpos = row.endpos();
        pos_type body_pos = par.beginOfBody();
@@ -819,21 +884,21 @@ private:
  */
 bool TextMetrics::breakRow(Row & row, int const right_margin) const
 {
+       LATTEST(row.empty());
        Paragraph const & par = text_->getPar(row.pit());
        pos_type const end = par.size();
        pos_type const pos = row.pos();
        pos_type const body_pos = par.beginOfBody();
-       bool const is_rtl = text_->isRTL(par);
+       bool const is_rtl = text_->isRTL(row.pit());
        bool need_new_row = false;
 
-       row.clear();
        row.left_margin = leftMargin(row.pit(), pos);
        row.right_margin = right_margin;
        if (is_rtl)
                swap(row.left_margin, row.right_margin);
        // Remember that the row width takes into account the left_margin
        // but not the right_margin.
-       row.dimension().wid = row.left_margin;
+       row.dim().wid = row.left_margin;
        // the width available for the row.
        int const width = max_width_ - row.right_margin;
 
@@ -892,17 +957,8 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                        // ¶ U+00B6 PILCROW SIGN
                        char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
                        row.add(i, screen_char, *fi, par.lookupChange(i));
-               } else {
-                       // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
-                       // see also Paragraph::getUChar.
-                       if (fi->language()->lang() == "hebrew") {
-                               if (c == '(')
-                                       c = ')';
-                               else if (c == ')')
-                                       c = '(';
-                       }
+               } else
                        row.add(i, c, *fi, par.lookupChange(i));
-               }
 
                // add inline completion width
                // draw logically behind the previous character
@@ -926,11 +982,17 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                Inset const * inset = 0;
                if (par.isNewline(i) || par.isEnvSeparator(i)
                    || (i + 1 < end && (inset = par.getInset(i + 1))
-                       && inset->display())
+                       && inset->display())
                    || (!row.empty() && row.back().inset
-                       && row.back().inset->display())) {
+                       && row.back().inset->display())) {
                        row.flushed(true);
-                       need_new_row = par.isNewline(i);
+                       // We will force a row creation after either
+                       // - a newline;
+                       // - a display inset followed by a end label.
+                       need_new_row =
+                               par.isNewline(i)
+                               || (inset && inset->display() && i + 1 == end
+                                   && text_->getEndLabel(row.pit()) != END_LABEL_NO_LABEL);
                        ++i;
                        break;
                }
@@ -944,7 +1006,9 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
        // End of paragraph marker. The logic here is almost the
        // same as in redoParagraph, remember keep them in sync.
        ParagraphList const & pars = text_->paragraphs();
-       if (lyxrc.paragraph_markers && !need_new_row
+       Change const & change = par.lookupChange(i);
+       if ((lyxrc.paragraph_markers || change.changed())
+           && !need_new_row
            && i == end && size_type(row.pit() + 1) < pars.size()) {
                // add a virtual element for the end-of-paragraph
                // marker; it is shown on screen, but does not exist
@@ -955,7 +1019,7 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                        = text_->inset().buffer().params();
                f.setLanguage(par.getParLanguage(bparams));
                // ¶ U+00B6 PILCROW SIGN
-               row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
+               row.addVirtual(end, docstring(1, char_type(0x00B6)), f, change);
        }
 
        // Is there a end-of-paragaph change?
@@ -1108,8 +1172,8 @@ void TextMetrics::setRowHeight(Row & row) const
        ++maxasc;
        ++maxdes;
 
-       row.dimension().asc = maxasc;
-       row.dimension().des = maxdes;
+       row.dim().asc = maxasc;
+       row.dim().des = maxdes;
 }
 
 
@@ -1208,35 +1272,6 @@ pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
 }
 
 
-void TextMetrics::newParMetricsDown()
-{
-       pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
-       pit_type const pit = last.first + 1;
-       if (pit == int(text_->paragraphs().size()))
-               return;
-
-       // do it and update its position.
-       redoParagraph(pit);
-       par_metrics_[pit].setPosition(last.second.position()
-               + last.second.descent() + par_metrics_[pit].ascent());
-       updatePosCache(pit);
-}
-
-
-void TextMetrics::newParMetricsUp()
-{
-       pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
-       if (first.first == 0)
-               return;
-
-       pit_type const pit = first.first - 1;
-       // do it and update its position.
-       redoParagraph(pit);
-       par_metrics_[pit].setPosition(first.second.position()
-               - first.second.ascent() - par_metrics_[pit].descent());
-       updatePosCache(pit);
-}
-
 // y is screen coordinate
 pit_type TextMetrics::getPitNearY(int y)
 {
@@ -1570,20 +1605,6 @@ void TextMetrics::deleteLineForward(Cursor & cur)
 }
 
 
-bool TextMetrics::isLastRow(Row const & row) const
-{
-       ParagraphList const & pars = text_->paragraphs();
-       return row.endpos() >= pars[row.pit()].size()
-               && row.pit() + 1 == pit_type(pars.size());
-}
-
-
-bool TextMetrics::isFirstRow(Row const & row) const
-{
-       return row.pos() == 0 && row.pit() == 0;
-}
-
-
 int TextMetrics::leftMargin(pit_type pit) const
 {
        return leftMargin(pit, text_->paragraphs()[pit].size());
@@ -1736,7 +1757,7 @@ int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
        if (!par.params().leftIndent().zero())
                l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
 
-       LyXAlignment align = par.getAlign();
+       LyXAlignment align = par.getAlign(bv_->buffer().params());
 
        // set the correct parindent
        if (pos == 0
@@ -1799,6 +1820,9 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
        if (pm.rows().empty())
                return;
        size_t const nrows = pm.rows().size();
+       // Remember left and right margin for drawing math numbers
+       Changer changeleft = make_change(pi.leftx, x + leftMargin(pit));
+       Changer changeright = make_change(pi.rightx, x + width() - rightMargin(pit));
 
        // Use fast lane in nodraw stage.
        if (pi.pain.isNull()) {
@@ -1845,6 +1869,9 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                }
        }
 
+       if (text_->isRTL(pit))
+               swap(pi.leftx, pi.rightx);
+
        for (size_t i = 0; i != nrows; ++i) {
 
                Row const & row = pm.rows()[i];
@@ -1876,12 +1903,8 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                                row.change(row.end_margin_sel, sel_end.pit() > pit);
                }
 
-               // has row changed since last paint?
-               bool row_has_changed = row.changed()
-                       || bv_->hadHorizScrollOffset(text_, pit, row.pos());
-
                // Take this opportunity to spellcheck the row contents.
-               if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
+               if (row.changed() && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
                        text_->getPar(pit).spellCheck();
                }
 
@@ -1889,7 +1912,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
 
                // Don't paint the row if a full repaint has not been requested
                // and if it has not changed.
-               if (!pi.full_repaint && !row_has_changed) {
+               if (!pi.full_repaint && !row.changed()) {
                        // Paint only the insets if the text itself is
                        // unchanged.
                        rp.paintOnlyInsets();
@@ -1900,7 +1923,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
 
                // Clear background of this row if paragraph background was not
                // already cleared because of a full repaint.
-               if (!pi.full_repaint && row_has_changed) {
+               if (!pi.full_repaint && row.changed()) {
                        LYXERR(Debug::PAINTING, "Clear rect@("
                               << max(row_x, 0) << ", " << y - row.ascent() << ")="
                               << width() << " x " << row.height());
@@ -1910,22 +1933,22 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                        // the begining/end of row. However, it will not work if
                        // the caret has a ridiculous width like 6. (see ticket
                        // #10797)
-                       pi.pain.fillRectangle(max(row_x, 0) - Inset::TEXT_TO_INSET_OFFSET,
+                       pi.pain.fillRectangle(max(row_x, 0) - Inset::textOffset(pi.base.bv),
                                              y - row.ascent(),
-                                             width() + 2 * Inset::TEXT_TO_INSET_OFFSET,
+                                             width() + 2 * Inset::textOffset(pi.base.bv),
                                              row.height(), pi.background_color);
                }
 
                // Instrumentation for testing row cache (see also
                // 12 lines lower):
                if (lyxerr.debugging(Debug::PAINTING)
-                   && (row.selection() || pi.full_repaint || row_has_changed)) {
+                   && (row.selection() || pi.full_repaint || row.changed())) {
                        string const foreword = text_->isMainText() ? "main text redraw "
                                : "inset text redraw: ";
                        LYXERR0(foreword << "pit=" << pit << " row=" << i
                                << (row.selection() ? " row_selection": "")
                                << (pi.full_repaint ? " full_repaint" : "")
-                               << (row_has_changed ? " row_has_changed" : ""));
+                               << (row.changed() ? " row.changed" : ""));
                }
 
                // Backup full_repaint status and force full repaint
@@ -1938,15 +1961,11 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                rp.paintDepthBar();
                if (row.needsChangeBar())
                        rp.paintChangeBar();
-               if (i == 0 && !row.isRTL())
+               if (i == 0)
                        rp.paintFirst();
-               if (i == nrows - 1 && row.isRTL())
+               if (i == nrows - 1)
                        rp.paintLast();
                rp.paintText();
-               if (i == nrows - 1 && !row.isRTL())
-                       rp.paintLast();
-               if (i == 0 && row.isRTL())
-                       rp.paintFirst();
                rp.paintTooLargeMarks(row_x + row.left_x() < 0,
                                      row_x + row.right_x() > bv_->workWidth());
                y += row.descent();
@@ -1960,7 +1979,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                static int count = 0;
                ++count;
                FontInfo fi(sane_font);
-               fi.setSize(FONT_SIZE_TINY);
+               fi.setSize(TINY_SIZE);
                fi.setColor(Color_red);
                pi.pain.text(row_x, y, convert<docstring>(count), fi);
 #endif
@@ -1991,7 +2010,7 @@ void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
        row.pos(wordStart.pos());
        row.endpos(bvcur.pos());
        setRowHeight(row);
-       dim = row.dimension();
+       dim = row.dim();
 
        // get position on screen of the word start and end
        //FIXME: Is it necessary to explicitly set this to false?