]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.cpp
Use ASCII number in \char definition
[lyx.git] / src / TextMetrics.cpp
index c10348d0d8ac6462316c7c5e898ca23aca7c9052..a93f9ba4cd3dce3ef33cb0d31193aff3f0847e2b 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;
@@ -472,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();
@@ -487,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();
@@ -501,13 +514,7 @@ bool TextMetrics::redoParagraph(pit_type const pit)
 
 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 {
-       Layout const & layout = par.layout();
-
-       LyXAlignment align;
-       if (par.params().align() == LYX_ALIGN_LAYOUT)
-               align = layout.align;
-       else
-               align = par.params().align();
+       LyXAlignment align = par.getAlign();
 
        // handle alignment inside tabular cells
        Inset const & owner = text_->inset();
@@ -554,10 +561,9 @@ LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
                // not justify stuff, then don't stretch.
                // A forced block alignment can only be overridden the 'no
                // justification on screen' setting.
-               if (((row.right_boundary() || row.endpos() == par.size())
-                    && !forced_block)
+               if ((row.flushed() && !forced_block)
                    || !bv_->buffer().params().justification)
-                       align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
+                       align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
        }
 
        return align;
@@ -612,18 +618,14 @@ void TextMetrics::computeRowMetrics(Row & row, int width) const
                // 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) && row.isRTL()) {
+                               // 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 +644,7 @@ void TextMetrics::computeRowMetrics(Row & row, int width) const
                return;
        }
 
+       // Case nh > 0. There are hfill separators.
        hfill = w / nh;
        hfill_rem = w % nh;
        row.dimension().wid += w;
@@ -854,7 +857,23 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                } 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") {
@@ -891,7 +910,7 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                        && inset->display())
                    || (!row.empty() && row.back().inset
                        && row.back().inset->display())) {
-                       row.right_boundary(true);
+                       row.flushed(true);
                        need_new_row = par.isNewline(i);
                        ++i;
                        break;
@@ -915,13 +934,21 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
                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);
+       int const next_width = max_width_ - leftMargin(max_width_, row.pit(), row.endpos())
+               - rightMargin(row.pit());
+
+       row.shortenIfNeeded(body_pos, width, next_width);
+       row.right_boundary(!row.empty() && row.endpos() < end
+                          && row.back().endpos == row.endpos());
+       // Last row in paragraph is flushed
+       if (row.endpos() == end)
+               row.flushed(true);
 
        // make sure that the RTL elements are in reverse ordering
        row.reverseRTL(is_rtl);
@@ -930,13 +957,109 @@ bool TextMetrics::breakRow(Row & row, int const right_margin) const
        return need_new_row;
 }
 
+int TextMetrics::parTopSpacing(pit_type const pit) const
+{
+       Paragraph const & par = text_->getPar(pit);
+       Layout const & layout = par.layout();
 
-void TextMetrics::setRowHeight(Row & row, bool topBottomSpace) const
+       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);
+       double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
 
        // Initial value for ascent (useful if row is empty).
        Font const font = displayFont(row.pit(), row.pos());
@@ -962,103 +1085,7 @@ void TextMetrics::setRowHeight(Row & row, bool topBottomSpace) const
        ++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
-                   && row.pit() > 0
-                   && ((layout.isParagraph() && par.getDepth() == 0)
-                           || (pars[row.pit() - 1].layout().isParagraph()
-                                   && pars[row.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(row.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(row.pit(), par.getDepth());
-               Paragraph const & prevpar = pars[prev];
-               if (prev != row.pit()
-                   && prevpar.layout() == layout
-                   && prevpar.getDepth() == par.getDepth()
-                   && prevpar.getLabelWidthString()
-                                       == par.getLabelWidthString()) {
-                       layoutasc = layout.itemsep * dh;
-               } else if (row.pit() != 0 || row.pos() != 0) {
-                       if (layout.topsep > 0)
-                               layoutasc = layout.topsep * dh;
-               }
-
-               prev = text_->outerHook(row.pit());
-               if (prev != pit_type(pars.size())) {
-                       maxasc += int(pars[prev].layout().parsep * dh);
-               } else if (row.pit() != 0) {
-                       Paragraph const & prevpar = pars[row.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 = row.pit() + 1;
-               if (nextpit != pit_type(pars.size())) {
-                       pit_type cpit = row.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[row.pit()].getDepth()));
-       maxdes += int(layoutdesc * 2 / (2 + pars[row.pit()].getDepth()));
-
-       row.dimension().asc = maxasc + labeladdon;
+       row.dimension().asc = maxasc;
        row.dimension().des = maxdes;
 }
 
@@ -1400,28 +1427,12 @@ InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
 
        LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
 
-       InsetList::const_iterator iit = par.insetList().begin();
-       InsetList::const_iterator iend = par.insetList().end();
-       for (; iit != iend; ++iit) {
-               Inset * inset = iit->inset;
-
-               LYXERR(Debug::DEBUG, "examining inset " << inset);
+       for (auto const & it : par.insetList()) {
+               LYXERR(Debug::DEBUG, "examining inset " << it.inset);
 
-               if (!insetCache.has(inset)) {
-                       LYXERR(Debug::DEBUG, "inset has no cached position");
-                       return 0;
-               }
-
-               Dimension const & dim = insetCache.dim(inset);
-               Point p = insetCache.xy(inset);
-
-               LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
-                       << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
-
-               if (x >= p.x_ && x <= p.x_ + dim.wid
-                   && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
-                       LYXERR(Debug::DEBUG, "Hit inset: " << inset);
-                       return const_cast<InsetList::InsetTable *>(&(*iit));
+               if (insetCache.covers(it.inset, x, y)) {
+                       LYXERR(Debug::DEBUG, "Hit inset: " << it.inset);
+                       return const_cast<InsetList::InsetTable *>(&it);
                }
        }
 
@@ -1444,56 +1455,6 @@ Inset * TextMetrics::checkInsetHit(int x, int y)
 }
 
 
-Row::const_iterator const
-TextMetrics::findRowElement(Row const & row, 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 = row.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 (row.empty()
-           || (pos == row.begin()->left_pos() && !boundary
-                       && !row.begin()->isVirtual()))
-               return row.begin();
-
-       Row::const_iterator cit = row.begin();
-       for ( ; cit != row.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 == row.end())
-               --cit;
-
-       return cit;
-}
-
-
 int TextMetrics::cursorX(CursorSlice const & sl,
                bool boundary) const
 {
@@ -1506,7 +1467,7 @@ int TextMetrics::cursorX(CursorSlice const & sl,
        pos_type const pos = sl.pos();
 
        double x = 0;
-       findRowElement(row, pos, boundary, x);
+       row.findElement(pos, boundary, x);
        return int(x);
 
 }
@@ -1761,12 +1722,7 @@ int TextMetrics::leftMargin(int max_width,
        if (!par.params().leftIndent().zero())
                l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
 
-       LyXAlignment align;
-
-       if (par.params().align() == LYX_ALIGN_LAYOUT)
-               align = layout.align;
-       else
-               align = par.params().align();
+       LyXAlignment align = par.getAlign();
 
        // set the correct parindent
        if (pos == 0
@@ -1850,7 +1806,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();
@@ -1916,7 +1871,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());
 
@@ -1967,15 +1922,14 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                rp.paintAppendix();
                rp.paintDepthBar();
                rp.paintChangeBar();
-               bool const is_rtl = text_->isRTL(text_->getPar(pit));
-               if (i == 0 && !is_rtl)
+               if (i == 0 && !row.isRTL())
                        rp.paintFirst();
-               if (i == nrows - 1 && is_rtl)
+               if (i == nrows - 1 && row.isRTL())
                        rp.paintLast();
                rp.paintText();
-               if (i == nrows - 1 && !is_rtl)
+               if (i == nrows - 1 && !row.isRTL())
                        rp.paintLast();
-               if (i == 0 && is_rtl)
+               if (i == 0 && row.isRTL())
                        rp.paintFirst();
                rp.paintTooLargeMarks(row_x + row.left_x() < 0,
                                      row_x + row.right_x() > bv_->workWidth());
@@ -2001,18 +1955,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, 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