]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.cpp
GMO for BG
[lyx.git] / src / TextMetrics.cpp
index 29c81da8bd65c09bf5608abb6532d6973a280e14..fc7e09d8628ca79cc4069f4b4f29ff04a97b12ec 100644 (file)
@@ -48,6 +48,7 @@
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/lassert.h"
+#include "support/lyxlib.h"
 
 #include <stdlib.h>
 #include <cmath>
@@ -61,6 +62,10 @@ using frontend::FontMetrics;
 
 namespace {
 
+// the somewhat arbitrary leading added between rows. This is 20% of
+// the characters height, inluding the possible leading of the font.
+// 20% is a standard value used by LaTeX and word processors.
+double const extra_leading = 0.2;
 
 int numberOfLabelHfills(Paragraph const & par, Row const & row)
 {
@@ -125,13 +130,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 +145,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 +182,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)
 {
@@ -378,8 +436,9 @@ bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
        // 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());
@@ -507,7 +566,7 @@ bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
                // 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).
@@ -517,16 +576,16 @@ bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
                }
                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();
@@ -649,28 +708,28 @@ void TextMetrics::setRowAlignment(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:
@@ -685,7 +744,7 @@ void TextMetrics::setRowAlignment(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();
@@ -831,7 +890,7 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
        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();
@@ -841,7 +900,7 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                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;
 
@@ -925,11 +984,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;
                }
@@ -943,7 +1008,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
@@ -954,7 +1021,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?
@@ -1088,27 +1155,19 @@ void TextMetrics::setRowHeight(Row & row) const
        // Initial value for ascent (useful if row is empty).
        Font const font = displayFont(row.pit(), row.pos());
        FontMetrics const & fm = theFontMetrics(font);
-       int maxasc = int(fm.maxAscent() * spacing_val);
-       int maxdes = int(fm.maxDescent() * spacing_val);
+       int maxasc = fm.maxAscent() + fm.leading();
+       int maxdes = fm.maxDescent();
 
        // Find the ascent/descent of the row contents
        for (Row::Element const & e : row) {
-               if (e.inset) {
-                       maxasc = max(maxasc, e.dim.ascent());
-                       maxdes = max(maxdes, e.dim.descent());
-               } else {
-                       FontMetrics const & fm2 = theFontMetrics(e.font);
-                       maxasc = max(maxasc, int(fm2.maxAscent() * spacing_val));
-                       maxdes = max(maxdes, int(fm2.maxDescent() * spacing_val));
-               }
+               maxasc = max(maxasc, e.dim.ascent());
+               maxdes = max(maxdes, e.dim.descent());
        }
 
-       // This is nicer with box insets
-       ++maxasc;
-       ++maxdes;
-
-       row.dimension().asc = maxasc;
-       row.dimension().des = maxdes;
+       // Add some leading (split between before and after)
+       int const leading = support::iround(extra_leading * (maxasc + maxdes));
+       row.dim().asc = int((maxasc + leading - leading / 2) * spacing_val);
+       row.dim().des = int((maxdes + leading / 2) * spacing_val);
 }
 
 
@@ -1207,35 +1266,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)
 {
@@ -1569,20 +1599,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());
@@ -1875,12 +1891,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();
                }
 
@@ -1888,7 +1900,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();
@@ -1899,7 +1911,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());
@@ -1918,13 +1930,13 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                // 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
@@ -1937,15 +1949,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();
@@ -1990,7 +1998,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?
@@ -2009,7 +2017,8 @@ void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
 
 int defaultRowHeight()
 {
-       return int(theFontMetrics(sane_font).maxHeight() *  1.2);
+       FontMetrics const & fm = theFontMetrics(sane_font);
+       return support::iround(fm.maxHeight() * (1 + extra_leading) + fm.leading());
 }
 
 } // namespace lyx