]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.cpp
Remove hardcoded values
[lyx.git] / src / TextMetrics.cpp
index a1f3892a8c67fb4f8ffa09c04e13711bd8fa6acf..17ee2e410afe56b0c3325953cef3a82cb1d251ef 100644 (file)
@@ -48,6 +48,7 @@
 #include "support/debug.h"
 #include "support/lassert.h"
 
+#include <stdlib.h>
 #include <cmath>
 
 using namespace std;
@@ -401,6 +402,7 @@ bool TextMetrics::redoParagraph(pit_type const pit)
        }
 
        // redo insets
+       par.setBeginOfBody();
        Font const bufferfont = buffer.params().getFont();
        CoordCache::Insets & insetCache = bv_->coordCache().insets();
        InsetList::const_iterator ii = par.insetList().begin();
@@ -434,7 +436,6 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                }
        }
 
-       par.setBeginOfBody();
        pos_type first = 0;
        size_t row_index = 0;
        bool need_new_row = false;
@@ -445,8 +446,9 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                Row & row = pm.rows()[row_index];
                row.pit(pit);
                row.pos(first);
-               need_new_row = breakRow(row, right_margin, pit);
-               setRowHeight(row, pit);
+               row.pit(pit);
+               need_new_row = breakRow(row, right_margin);
+               setRowHeight(row);
                row.setChanged(false);
                if (row_index || row.endpos() < par.size()
                    || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
@@ -463,7 +465,7 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                                dim_.wid = max_width_;
                }
                int const max_row_width = max(dim_.wid, row.width());
-               computeRowMetrics(pit, row, max_row_width);
+               computeRowMetrics(row, max_row_width);
                first = row.endpos();
                ++row_index;
 
@@ -471,12 +473,20 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                pm.dim().des += row.height();
        } while (first < par.size() || need_new_row);
 
+       if (row_index < pm.rows().size())
+               pm.rows().resize(row_index);
+
        // FIXME: It might be better to move this in another method
        // specially tailored for the main text.
        // Top and bottom margin of the document (only at top-level)
        if (text_->isMainText()) {
                if (pit == 0) {
                        pm.rows().front().dimension().asc += 20;
+                       /* coverity[copy_paste_error]: 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).
+                        */
                        pm.dim().des += 20;
                }
                ParagraphList const & pars = text_->paragraphs();
@@ -486,8 +496,12 @@ bool TextMetrics::redoParagraph(pit_type const pit)
                }
        }
 
-       if (row_index < pm.rows().size())
-               pm.rows().resize(row_index);
+       // The space above and below the paragraph.
+       int const top = parTopSpacing(pit);
+       pm.rows().front().dimension().asc += top;
+       int const bottom = parBottomSpacing(pit);
+       pm.rows().back().dimension().des += bottom;
+       pm.dim().des += top + bottom;
 
        pm.dim().asc += pm.rows()[0].ascent();
        pm.dim().des -= pm.rows()[0].ascent();
@@ -563,13 +577,12 @@ LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 }
 
 
-void TextMetrics::computeRowMetrics(pit_type const pit,
-               Row & row, int width) const
+void TextMetrics::computeRowMetrics(Row & row, int width) const
 {
        row.label_hfill = 0;
        row.separator = 0;
 
-       Paragraph const & par = text_->getPar(pit);
+       Paragraph const & par = text_->getPar(row.pit());
 
        int const w = width - row.right_margin - row.width();
        // FIXME: put back this assertion when the crash on new doc is solved.
@@ -593,11 +606,11 @@ void TextMetrics::computeRowMetrics(pit_type const pit,
                        ++nlh;
 
                if (nlh && !par.getLabelWidthString().empty())
-                       row.label_hfill = labelFill(pit, row) / double(nlh);
+                       row.label_hfill = labelFill(row) / double(nlh);
        }
 
        // are there any hfills in the row?
-       ParagraphMetrics & pm = par_metrics_[pit];
+       ParagraphMetrics & pm = par_metrics_[row.pit()];
        int nh = numberOfHfills(row, pm, par.beginOfBody());
        int hfill = 0;
        int hfill_rem = 0;
@@ -612,18 +625,14 @@ void TextMetrics::computeRowMetrics(pit_type const pit,
                // Common case : there is no hfill, and the alignment will be
                // meaningful
                switch (getAlign(par, row)) {
-               case LYX_ALIGN_BLOCK: {
-                       int const ns = row.countSeparators();
-                       // If we have separators, then stretch the row
-                       if (ns) {
-                               row.setSeparatorExtraWidth(double(w) / ns);
-                               row.dimension().wid += w;
-                       } else if (text_->isRTL(par)) {
+               case LYX_ALIGN_BLOCK:
+                       // Expand expanding characters by a total of w
+                       if (!row.setExtraWidth(w) && text_->isRTL(par)) {
+                               // Justification failed and the text is RTL: align to the right
                                row.left_margin += w;
                                row.dimension().wid += w;
                        }
                        break;
-               }
                case LYX_ALIGN_RIGHT:
                        row.left_margin += w;
                        row.dimension().wid += w;
@@ -642,6 +651,7 @@ void TextMetrics::computeRowMetrics(pit_type const pit,
                return;
        }
 
+       // Case nh > 0. There are hfill separators.
        hfill = w / nh;
        hfill_rem = w % nh;
        row.dimension().wid += w;
@@ -674,9 +684,9 @@ void TextMetrics::computeRowMetrics(pit_type const pit,
 }
 
 
-int TextMetrics::labelFill(pit_type const pit, Row const & row) const
+int TextMetrics::labelFill(Row const & row) const
 {
-       Paragraph const & par = text_->getPar(pit);
+       Paragraph const & par = text_->getPar(row.pit());
        LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
 
        int w = 0;
@@ -787,9 +797,9 @@ private:
  * very sensitive to small changes :) Note that part of the
  * intelligence is also in Row::shortenIfNeeded.
  */
-bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
+bool TextMetrics::breakRow(Row & row, int const right_margin) const
 {
-       Paragraph const & par = text_->getPar(pit);
+       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();
@@ -797,7 +807,7 @@ bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit
        bool need_new_row = false;
 
        row.clear();
-       row.left_margin = leftMargin(max_width_, pit, pos);
+       row.left_margin = leftMargin(max_width_, row.pit(), pos);
        row.right_margin = right_margin;
        if (is_rtl)
                swap(row.left_margin, row.right_margin);
@@ -823,13 +833,13 @@ bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit
        // check for possible inline completion
        DocIterator const & ic_it = bv_->inlineCompletionPos();
        pos_type ic_pos = -1;
-       if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
+       if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
                ic_pos = ic_it.pos();
 
        // Now we iterate through until we reach the right margin
        // or the end of the par, then build a representation of the row.
        pos_type i = pos;
-       FontIterator fi = FontIterator(*this, par, pit, pos);
+       FontIterator fi = FontIterator(*this, par, row.pit(), pos);
        do {
                // this can happen for an empty row after a newline
                if (i >= end)
@@ -849,12 +859,28 @@ bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit
                        // this is needed to make sure that the row width is correct
                        row.finalizeLast();
                        int const add = max(fm.width(par.layout().labelsep),
-                                           labelEnd(pit) - row.width());
+                                           labelEnd(row.pit()) - row.width());
                        row.addSpace(i, add, *fi, par.lookupChange(i));
                } else if (c == '\t')
                        row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
                                     *fi, par.lookupChange(i));
-               else {
+               else if (c == 0x2028 || c == 0x2029) {
+                       /**
+                        * U+2028 LINE SEPARATOR
+                        * U+2029 PARAGRAPH SEPARATOR
+
+                        * These are special unicode characters that break
+                        * lines/pragraphs. Not handling them lead to trouble wrt
+                        * Qt QTextLayout formatting. We add a visible character
+                        * on screen so that the user can see that something is
+                        * happening.
+                       */
+                       row.finalizeLast();
+                       // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
+                       // ¶ 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") {
@@ -906,22 +932,23 @@ bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit
        // End of paragraph marker
        ParagraphList const & pars = text_->paragraphs();
        if (lyxrc.paragraph_markers && !need_new_row
-           && i == end && size_type(pit + 1) < pars.size()) {
+           && 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
                // in the paragraph.
-               Font f(text_->layoutFont(pit));
+               Font f(text_->layoutFont(row.pit()));
                f.fontInfo().setColor(Color_paragraphmarker);
                BufferParams const & bparams
                        = text_->inset().buffer().params();
                f.setLanguage(par.getParLanguage(bparams));
+               // ¶ U+00B6 PILCROW SIGN
                row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
        }
 
        // if the row is too large, try to cut at last separator. In case
        // of success, reset indication that the row was broken abruptly.
        if (row.shortenIfNeeded(body_pos, width))
-               row.right_boundary(false);
+               row.right_boundary(!row.empty() && row.back().endpos == row.endpos());
 
        // make sure that the RTL elements are in reverse ordering
        row.reverseRTL(is_rtl);
@@ -930,17 +957,112 @@ bool TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit
        return need_new_row;
 }
 
-
-void TextMetrics::setRowHeight(Row & row, pit_type const pit,
-                                   bool topBottomSpace) const
+int TextMetrics::parTopSpacing(pit_type const pit) const
 {
        Paragraph const & par = text_->getPar(pit);
        Layout const & layout = par.layout();
-       double const spacing_val = layout.spacing.getValue()
-               * text_->spacing(par);
+
+       int asc = 0;
+       ParagraphList const & pars = text_->paragraphs();
+       double const dh = defaultRowHeight();
+
+       BufferParams const & bparams = bv_->buffer().params();
+       Inset const & inset = text_->inset();
+       // some parskips VERY EASY IMPLEMENTATION
+       if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
+               && !inset.getLayout().parbreakIsNewline()
+               && !par.layout().parbreak_is_newline
+               && pit > 0
+               && ((layout.isParagraph() && par.getDepth() == 0)
+                   || (pars[pit - 1].layout().isParagraph()
+                       && pars[pit - 1].getDepth() == 0))) {
+               asc += bparams.getDefSkip().inPixels(*bv_);
+       }
+
+       if (par.params().startOfAppendix())
+               asc += int(3 * dh);
+
+       // special code for the top label
+       if (layout.labelIsAbove()
+           && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
+           && !par.labelString().empty()) {
+               FontInfo labelfont = text_->labelFont(par);
+               FontMetrics const & lfm = theFontMetrics(labelfont);
+               asc += int(lfm.maxHeight() * layout.spacing.getValue()
+                                          * text_->spacing(par)
+                          + (layout.topsep + layout.labelbottomsep) * dh);
+       }
+
+       // Add the layout spaces, for example before and after
+       // a section, or between the items of a itemize or enumerate
+       // environment.
+
+       pit_type prev = text_->depthHook(pit, par.getDepth());
+       Paragraph const & prevpar = pars[prev];
+       double layoutasc = 0;
+       if (prev != pit
+           && prevpar.layout() == layout
+           && prevpar.getDepth() == par.getDepth()
+           && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
+               layoutasc = layout.itemsep * dh;
+       } else if (pit != 0 && layout.topsep > 0)
+               layoutasc = layout.topsep * dh;
+
+       asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
+
+       prev = text_->outerHook(pit);
+       if (prev != pit_type(pars.size())) {
+               asc += int(pars[prev].layout().parsep * dh);
+       } else if (pit != 0) {
+               Paragraph const & prevpar = pars[pit - 1];
+               if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
+                       asc += int(layout.parsep * dh);
+       }
+
+       return asc;
+}
+
+
+int TextMetrics::parBottomSpacing(pit_type const pit) const
+{
+       double layoutdesc = 0;
+       ParagraphList const & pars = text_->paragraphs();
+       double const dh = defaultRowHeight();
+
+       // add the layout spaces, for example before and after
+       // a section, or between the items of a itemize or enumerate
+       // environment
+       pit_type nextpit = pit + 1;
+       if (nextpit != pit_type(pars.size())) {
+               pit_type cpit = pit;
+
+               if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
+                       double usual = pars[cpit].layout().bottomsep * dh;
+                       double unusual = 0;
+                       cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
+                       if (pars[cpit].layout() != pars[nextpit].layout()
+                               || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
+                               unusual = pars[cpit].layout().bottomsep * dh;
+                       layoutdesc = max(unusual, usual);
+               } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
+                       if (pars[cpit].layout() != pars[nextpit].layout()
+                               || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
+                               layoutdesc = int(pars[cpit].layout().bottomsep * dh);
+               }
+       }
+
+       return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
+}
+
+
+void TextMetrics::setRowHeight(Row & row) const
+{
+       Paragraph const & par = text_->getPar(row.pit());
+       Layout const & layout = par.layout();
+       double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
 
        // Initial value for ascent (useful if row is empty).
-       Font const font = displayFont(pit, row.pos());
+       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);
@@ -963,103 +1085,7 @@ void TextMetrics::setRowHeight(Row & row, pit_type const pit,
        ++maxasc;
        ++maxdes;
 
-       // Now use the layout information.
-       double layoutasc = 0;
-       double layoutdesc = 0;
-       int labeladdon = 0;
-       ParagraphList const & pars = text_->paragraphs();
-       Inset const & inset = text_->inset();
-       double const dh = defaultRowHeight();
-
-       // is it a top line?
-       if (row.pos() == 0 && topBottomSpace) {
-               BufferParams const & bufparams = bv_->buffer().params();
-               // some parskips VERY EASY IMPLEMENTATION
-               if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
-                   && !inset.getLayout().parbreakIsNewline()
-                   && !par.layout().parbreak_is_newline
-                   && pit > 0
-                   && ((layout.isParagraph() && par.getDepth() == 0)
-                           || (pars[pit - 1].layout().isParagraph()
-                                   && pars[pit - 1].getDepth() == 0))) {
-                       maxasc += bufparams.getDefSkip().inPixels(*bv_);
-               }
-
-               if (par.params().startOfAppendix())
-                       maxasc += int(3 * dh);
-
-               // special code for the top label
-               if (layout.labelIsAbove()
-                   && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
-                   && !par.labelString().empty()) {
-                       FontInfo labelfont = text_->labelFont(par);
-                       FontMetrics const & lfm = theFontMetrics(labelfont);
-                       labeladdon = int(
-                                 lfm.maxHeight()
-                                       * layout.spacing.getValue()
-                                       * text_->spacing(par)
-                               + (layout.topsep + layout.labelbottomsep) * dh);
-               }
-
-               // Add the layout spaces, for example before and after
-               // a section, or between the items of a itemize or enumerate
-               // environment.
-
-               pit_type prev = text_->depthHook(pit, par.getDepth());
-               Paragraph const & prevpar = pars[prev];
-               if (prev != pit
-                   && prevpar.layout() == layout
-                   && prevpar.getDepth() == par.getDepth()
-                   && prevpar.getLabelWidthString()
-                                       == par.getLabelWidthString()) {
-                       layoutasc = layout.itemsep * dh;
-               } else if (pit != 0 || row.pos() != 0) {
-                       if (layout.topsep > 0)
-                               layoutasc = layout.topsep * dh;
-               }
-
-               prev = text_->outerHook(pit);
-               if (prev != pit_type(pars.size())) {
-                       maxasc += int(pars[prev].layout().parsep * dh);
-               } else if (pit != 0) {
-                       Paragraph const & prevpar = pars[pit - 1];
-                       if (prevpar.getDepth() != 0 ||
-                                       prevpar.layout() == layout) {
-                               maxasc += int(layout.parsep * dh);
-                       }
-               }
-       }
-
-       // is it a bottom line?
-       if (row.endpos() >= par.size() && topBottomSpace) {
-               // add the layout spaces, for example before and after
-               // a section, or between the items of a itemize or enumerate
-               // environment
-               pit_type nextpit = pit + 1;
-               if (nextpit != pit_type(pars.size())) {
-                       pit_type cpit = pit;
-
-                       if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
-                               double usual = pars[cpit].layout().bottomsep * dh;
-                               double unusual = 0;
-                               cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
-                               if (pars[cpit].layout() != pars[nextpit].layout()
-                                   || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
-                                       unusual = pars[cpit].layout().bottomsep * dh;
-                               layoutdesc = max(unusual, usual);
-                       } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
-                               if (pars[cpit].layout() != pars[nextpit].layout()
-                                       || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
-                                       layoutdesc = int(pars[cpit].layout().bottomsep * dh);
-                       }
-               }
-       }
-
-       // incalculate the layout spaces
-       maxasc += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
-       maxdes += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
-
-       row.dimension().asc = maxasc + labeladdon;
+       row.dimension().asc = maxasc;
        row.dimension().des = maxdes;
 }
 
@@ -1593,17 +1619,17 @@ void TextMetrics::deleteLineForward(Cursor & cur)
 }
 
 
-bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
+bool TextMetrics::isLastRow(Row const & row) const
 {
        ParagraphList const & pars = text_->paragraphs();
-       return row.endpos() >= pars[pit].size()
-               && pit + 1 == pit_type(pars.size());
+       return row.endpos() >= pars[row.pit()].size()
+               && row.pit() + 1 == pit_type(pars.size());
 }
 
 
-bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
+bool TextMetrics::isFirstRow(Row const & row) const
 {
-       return row.pos() == 0 && pit == 0;
+       return row.pos() == 0 && row.pit() == 0;
 }
 
 
@@ -1843,7 +1869,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                        if (i)
                                y += row.ascent();
 
-                       RowPainter rp(pi, *text_, pit, row, row_x, y);
+                       RowPainter rp(pi, *text_, row, row_x, y);
 
                        rp.paintOnlyInsets();
                        y += row.descent();
@@ -1851,7 +1877,6 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                return;
        }
 
-       BufferParams const & bparams = bv_->buffer().params();
        int const ww = bv_->workHeight();
        Cursor const & cur = bv_->cursor();
        DocIterator sel_beg = cur.selectionBegin();
@@ -1887,7 +1912,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                if (i)
                        y += row.ascent();
 
-               RowPainter rp(pi, *text_, pit, row, row_x, y);
+               RowPainter rp(pi, *text_, row, row_x, y);
 
                // It is not needed to draw on screen if we are not inside.
                bool const inside = (y + row.descent() >= 0
@@ -1917,7 +1942,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                }
 
                // Row signature; has row changed since last paint?
-               row.setCrc(pm.computeRowSignature(row, bparams));
+               row.setCrc(pm.computeRowSignature(row, *bv_));
                bool row_has_changed = row.changed()
                        || bv_->hadHorizScrollOffset(text_, pit, row.pos());
 
@@ -2002,18 +2027,19 @@ void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
        DocIterator wordStart = bvcur;
        wordStart.pos() -= word.length();
 
-       // get position on screen of the word start and end
-       //FIXME: Is it necessary to explicitly set this to false?
-       wordStart.boundary(false);
-       Point lxy = cur.bv().getPos(wordStart);
-       Point rxy = cur.bv().getPos(bvcur);
-
        // calculate dimensions of the word
        Row row;
+       row.pit(bvcur.pit());
        row.pos(wordStart.pos());
        row.endpos(bvcur.pos());
-       setRowHeight(row, bvcur.pit(), false);
+       setRowHeight(row);
        dim = row.dimension();
+
+       // get position on screen of the word start and end
+       //FIXME: Is it necessary to explicitly set this to false?
+       wordStart.boundary(false);
+       Point lxy = cur.bv().getPos(wordStart);
+       Point rxy = cur.bv().getPos(bvcur);
        dim.wid = abs(rxy.x_ - lxy.x_);
 
        // calculate position of word