]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.cpp
Fix compiler warning about unused string consts
[lyx.git] / src / TextMetrics.cpp
index 1a6927ab98e08ee3078f97c9bbb467506841ca06..f4241181c295e15f440d78a48f05dbf6d7621d5f 100644 (file)
@@ -35,6 +35,7 @@
 #include "TextClass.h"
 #include "VSpace.h"
 
+#include "insets/InsetSeparator.h"
 #include "insets/InsetText.h"
 
 #include "mathed/MacroTable.h"
@@ -491,7 +492,7 @@ bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
 
                // If there is an end of paragraph marker, its size should be
                // substracted to the available width. The logic here is
-               // almost the same as in breakRow, remember keep them in sync.
+               // almost the same as in tokenizeParagraph, remember keep them in sync.
                int eop = 0;
                if (e.pos + 1 == par.size()
                      && (lyxrc.paragraph_markers || par.lookupChange(par.size()).changed())
@@ -621,7 +622,7 @@ LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
        if (Inset const * inset = par.getInset(row.pos())) {
                if (inset->rowFlags() & Display) {
                        if (inset->rowFlags() & AlignLeft)
-                               align = LYX_ALIGN_BLOCK;
+                               align = LYX_ALIGN_LEFT;
                        else if (inset->rowFlags() & AlignRight)
                                align = LYX_ALIGN_RIGHT;
                        else
@@ -786,15 +787,6 @@ int TextMetrics::labelFill(Row const & row) const
 }
 
 
-int TextMetrics::labelEnd(pit_type const pit) const
-{
-       // labelEnd is only needed if the layout fills a flushleft label.
-       if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
-               return 0;
-       // return the beginning of the body
-       return leftMargin(pit);
-}
-
 namespace {
 
 /**
@@ -901,16 +893,12 @@ Row TextMetrics::tokenizeParagraph(pit_type const pit) const
                        Dimension dim = bv_->coordCache().insets().dim(ins);
                        row.add(i, ins, dim, *fi, par.lookupChange(i));
                } else if (c == ' ' && i + 1 == body_pos) {
-                       // There is a space at i, but it should not be
-                       // added as a separator, because it is just
-                       // before body_pos. Instead, insert some spacing to
-                       // align text
+                       // This space is an \item separator. Represent it with a
+                       // special space element, which dimension will be computed
+                       // in breakRow.
                        FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
-                       // 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());
-                       row.addSpace(i, add, *fi, par.lookupChange(i));
+                       int const wid = fm.width(par.layout().labelsep);
+                       row.addMarginSpace(i, wid, *fi, par.lookupChange(i));
                } else if (c == '\t')
                        row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
                                     *fi, par.lookupChange(i));
@@ -920,7 +908,7 @@ Row TextMetrics::tokenizeParagraph(pit_type const pit) const
                         * U+2029 PARAGRAPH SEPARATOR
 
                         * These are special unicode characters that break
-                        * lines/pragraphs. Not handling them lead to trouble wrt
+                        * lines/pragraphs. Not handling them leads to trouble wrt
                         * Qt QTextLayout formatting. We add a visible character
                         * on screen so that the user can see that something is
                         * happening.
@@ -929,10 +917,10 @@ Row TextMetrics::tokenizeParagraph(pit_type const pit) const
                        // ⤶ 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), i >= body_pos);
+                       row.add(i, screen_char, *fi, par.lookupChange(i));
                } else
                        // row elements before body are unbreakable
-                       row.add(i, c, *fi, par.lookupChange(i), i >= body_pos);
+                       row.add(i, c, *fi, par.lookupChange(i));
 
                // add inline completion width
                // draw logically behind the previous character
@@ -992,7 +980,7 @@ class flexible_const_iterator {
 public:
 
        //
-       flexible_const_iterator operator++() {
+       flexible_const_iterator operator++() {
                if (pile_.empty())
                        ++cit_;
                else
@@ -1006,6 +994,11 @@ public:
 
        void put(value_type const & e) { pile_.push_back(e); }
 
+       // Put a sequence of elements on the pile (in reverse order!)
+       void put(vector<value_type> const & elts) {
+               pile_.insert(pile_.end(), elts.rbegin(), elts.rend());
+       }
+
 // This should be private, but declaring the friend functions is too much work
 //private:
        typename T::const_iterator cit_;
@@ -1037,6 +1030,7 @@ bool operator==(flexible_const_iterator<T> const & t1,
        return t1.cit_ == t2.cit_ && t1.pile_.empty() && t2.pile_.empty();
 }
 
+
 Row newRow(TextMetrics const & tm, pit_type pit, pos_type pos, bool is_rtl)
 {
        Row nrow;
@@ -1044,6 +1038,7 @@ Row newRow(TextMetrics const & tm, pit_type pit, pos_type pos, bool is_rtl)
        nrow.pos(pos);
        nrow.left_margin = tm.leftMargin(pit, pos);
        nrow.right_margin = tm.rightMargin(pit);
+       nrow.setRTL(is_rtl);
        if (is_rtl)
                swap(nrow.left_margin, nrow.right_margin);
        // Remember that the row width takes into account the left_margin
@@ -1053,15 +1048,24 @@ Row newRow(TextMetrics const & tm, pit_type pit, pos_type pos, bool is_rtl)
 }
 
 
-void cleanupRow(Row & row, pos_type pos, pos_type real_endpos, bool is_rtl)
+void cleanupRow(Row & row, bool at_end)
 {
-       row.endpos(pos);
-       row.right_boundary(!row.empty() && pos < real_endpos
-                          && row.back().endpos == pos);
+       if (row.empty()) {
+               row.endpos(row.pos());
+               return;
+       }
+
+       row.endpos(row.back().endpos);
+       // remove trailing spaces on row break
+       if (!at_end && !row.flushed())
+               row.back().rtrim();
+       // boundary exists when there was no space at the end of row
+       row.end_boundary(!at_end && row.back().endpos == row.endpos());
        // make sure that the RTL elements are in reverse ordering
-       row.reverseRTL(is_rtl);
+       row.reverseRTL();
 }
 
+
 // Implement the priorities described in RowFlags.h.
 bool needsRowBreak(int f1, int f2)
 {
@@ -1083,15 +1087,14 @@ RowList TextMetrics::breakParagraph(Row const & bigrow) const
        RowList rows;
        bool const is_rtl = text_->isRTL(bigrow.pit());
        bool const end_label = text_->getEndLabel(bigrow.pit()) != END_LABEL_NO_LABEL;
+       int const next_width = max_width_ - leftMargin(bigrow.pit(), bigrow.endpos())
+               - rightMargin(bigrow.pit());
 
-       bool need_new_row = true;
-       pos_type pos = 0;
        int width = 0;
        flexible_const_iterator<Row> fcit = flexible_begin(bigrow);
        flexible_const_iterator<Row> const end = flexible_end(bigrow);
        while (true) {
-               bool const has_row = !rows.empty();
-               bool const row_empty = !has_row || rows.back().empty();
+               bool const row_empty = rows.empty() || rows.back().empty();
                // The row flags of previous element, if there is one.
                // Otherwise we use NoBreakAfter to avoid an empty row before
                // e.g. a displayed equation.
@@ -1101,14 +1104,16 @@ RowList TextMetrics::breakParagraph(Row const & bigrow) const
                // paragraph has an end label (for which an empty row is OK).
                int const f2 = (fcit == end) ? (end_label ? Inline : NoBreakBefore)
                                             : fcit->row_flags;
-               need_new_row |= needsRowBreak(f1, f2);
-               if (need_new_row) {
-                       if (!rows.empty())
-                               cleanupRow(rows.back(), pos, bigrow.endpos(), is_rtl);
+               if (rows.empty() || needsRowBreak(f1, f2)) {
+                       if (!rows.empty()) {
+                               // Flush row as requested by row flags
+                               rows.back().flushed((f1 & Flush) || (f2 & FlushBefore));
+                               cleanupRow(rows.back(), false);
+                       }
+                       pos_type pos = rows.empty() ? 0 : rows.back().endpos();
                        rows.push_back(newRow(*this, bigrow.pit(), pos, is_rtl));
                        // the width available for the row.
                        width = max_width_ - rows.back().right_margin;
-                       need_new_row = false;
                }
 
                // The stopping condition is here because we may need a new
@@ -1119,212 +1124,37 @@ RowList TextMetrics::breakParagraph(Row const & bigrow) const
                // Next element to consider is either the top of the temporary
                // pile, or the place when we were in main row
                Row::Element elt = *fcit;
-               Row::Element next_elt = elt.splitAt(width - rows.back().width(),
-                                                   !elt.font.language()->wordWrap());
-               // a new element in the row
-               rows.back().push_back(elt);
-               rows.back().finalizeLast();
-               pos = elt.endpos;
+               Row::Elements tail;
+               elt.splitAt(width - rows.back().width(), next_width, false, tail);
+               Row & rb = rows.back();
+               if (elt.type == Row::MARGINSPACE)
+                       elt.dim.wid = max(elt.dim.wid, leftMargin(bigrow.pit()) - rb.width());
+               rb.push_back(elt);
+               rb.finalizeLast();
+               if (rb.width() > width) {
+                       // Keep the tail for later; this ought to be rare, but play safe.
+                       if (!tail.empty())
+                               fcit.put(tail);
+                       // if the row is too large, try to cut at last separator.
+                       tail = rb.shortenIfNeeded(width, next_width);
+               }
 
                // Go to next element
                ++fcit;
 
-               // Add a new next element on the pile
-               if (next_elt.isValid()) {
-                       // do as if we inserted this element in the original row
-                       fcit.put(next_elt);
-                       need_new_row = true;
-               }
+               // Handle later the elements returned by splitAt or shortenIfNeeded.
+               fcit.put(tail);
        }
 
        if (!rows.empty()) {
-               cleanupRow(rows.back(), pos, bigrow.endpos(), is_rtl);
                // Last row in paragraph is flushed
                rows.back().flushed(true);
+               cleanupRow(rows.back(), true);
        }
 
        return rows;
 }
 
-/** This is the function where the hard work is done. The code here is
- * 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) const
-{
-       LATTEST(row.empty());//
-       Paragraph const & par = text_->getPar(row.pit());//
-       Buffer const & buf = text_->inset().buffer();//
-       BookmarksSection::BookmarkPosList bpl =//
-               theSession().bookmarks().bookmarksInPar(buf.fileName(), par.id());//
-
-       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(row.pit());//
-       bool need_new_row = false;//
-
-       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.dim().wid = row.left_margin;//
-       // the width available for the row.
-       int const width = max_width_ - row.right_margin;//
-
-       // 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() == 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;//---------------------------------------------------vvv
-       FontIterator fi = FontIterator(*this, par, row.pit(), pos);
-       // The real stopping condition is a few lines below.
-       while (true) {
-               // Firstly, check whether there is a bookmark here.
-               if (lyxrc.bookmarks_visibility == LyXRC::BMK_INLINE)
-                       for (auto const & bp_p : bpl)
-                               if (bp_p.second == i) {
-                                       Font f = *fi;
-                                       f.fontInfo().setColor(Color_bookmark);
-                                       // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
-                                       char_type const ch = 0x2775 + bp_p.first;
-                                       row.addVirtual(i, docstring(1, ch), f, Change());
-                               }
-
-               // The stopping condition is here so that the display of a
-               // bookmark can take place at paragraph start too.
-               if (i >= end || (i != pos && row.width() > width))//^width
-                       break;
-
-               char_type c = par.getChar(i);
-               // The most special cases are handled first.
-               if (par.isInset(i)) {
-                       Inset const * ins = par.getInset(i);
-                       Dimension dim = bv_->coordCache().insets().dim(ins);
-                       row.add(i, ins, dim, *fi, par.lookupChange(i));
-               } else if (c == ' ' && i + 1 == body_pos) {
-                       // There is a space at i, but it should not be
-                       // added as a separator, because it is just
-                       // before body_pos. Instead, insert some spacing to
-                       // align text
-                       FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
-                       // this is needed to make sure that the row width is correct
-                       row.finalizeLast();
-                       int const add = max(fm.width(par.layout().labelsep),
-                                           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 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), i >= body_pos);
-               } else
-                       row.add(i, c, *fi, par.lookupChange(i), i >= body_pos);
-
-               // add inline completion width
-               // draw logically behind the previous character
-               if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
-                       docstring const comp = bv_->inlineCompletion();
-                       size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
-                       Font f = *fi;
-
-                       if (uniqueTo > 0) {
-                               f.fontInfo().setColor(Color_inlinecompletion);
-                               row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
-                       }
-                       f.fontInfo().setColor(Color_nonunique_inlinecompletion);
-                       row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
-               }
-
-               // Handle some situations that abruptly terminate the row
-               // - Before an inset with BreakBefore
-               // - After an inset with BreakAfter
-               Inset const * prevInset = !row.empty() ? row.back().inset : 0;
-               Inset const * nextInset = (i + 1 < end) ? par.getInset(i + 1) : 0;
-               if ((nextInset && nextInset->rowFlags() & BreakBefore)
-                   || (prevInset && prevInset->rowFlags() & BreakAfter)) {
-                       row.flushed(true);
-                       // Force a row creation after this one if it is ended by
-                       // an inset that either
-                       // - has row flag RowAfter that enforces that;
-                       // - or (1) did force the row breaking, (2) is at end of
-                       //   paragraph and (3) the said paragraph has an end label.
-                       need_new_row = prevInset &&
-                               (prevInset->rowFlags() & AlwaysBreakAfter
-                                || (prevInset->rowFlags() & BreakAfter && i + 1 == end
-                                    && text_->getEndLabel(row.pit()) != END_LABEL_NO_LABEL));
-                       ++i;
-                       break;
-               }
-
-               ++i;
-               ++fi;
-       }
-       row.finalizeLast();
-       row.endpos(i);
-
-       // End of paragraph marker. The logic here is almost the
-       // same as in redoParagraph, remember keep them in sync.
-       ParagraphList const & pars = text_->paragraphs();
-       Change const & change = par.lookupChange(i);
-       if ((lyxrc.paragraph_markers || change.changed())
-           && !need_new_row // not this
-           && 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(row.pit()));
-               f.fontInfo().setColor(Color_paragraphmarker);
-               f.setLanguage(par.getParLanguage(buf.params()));
-               // ¶ U+00B6 PILCROW SIGN
-               row.addVirtual(end, docstring(1, char_type(0x00B6)), f, change);
-       }
-
-       // Is there a end-of-paragaph change?
-       if (i == end && par.lookupChange(end).changed() && !need_new_row)
-               row.needsChangeBar(true);
-    //--------------------------------------------------------------------^^^
-       // FIXME : nothing below this
-
-       // if the row is too large, try to cut at last separator. In case
-       // of success, reset indication that the row was broken abruptly.
-       int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
-               - rightMargin(row.pit());
-
-       if (row.shortenIfNeeded(width, next_width))
-               row.flushed(false);
-       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);//
-       //LYXERR0("breakrow: row is " << row);
-
-       return need_new_row;
-}
 
 int TextMetrics::parTopSpacing(pit_type const pit) const
 {
@@ -1375,7 +1205,10 @@ int TextMetrics::parTopSpacing(pit_type const pit) const
            && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
                layoutasc = layout.itemsep * dh;
        } else if (pit != 0 && layout.topsep > 0)
-               layoutasc = layout.topsep * dh;
+               // combine the separation between different layouts (with same depth)
+               layoutasc = max(0.0,
+                       prevpar.getDepth() != par.getDepth() ? layout.topsep
+                       : layout.topsep - prevpar.layout().bottomsep) * dh;
 
        asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
 
@@ -1538,7 +1371,7 @@ pos_type TextMetrics::getPosNearX(Row const & row, int & x,
                              || inset->lyxCode() == SEPARATOR_CODE))
                        pos = row.back().pos;
                else
-                       boundary = row.right_boundary();
+                       boundary = row.end_boundary();
        }
 
        x += xo - offset;
@@ -1960,11 +1793,13 @@ int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
                }
        }
 
-       // This happens after sections or environments in standard classes.
-       // We have to check the previous layout at same depth.
+       // Check for reasons to remove indentation.
+       // First, at document level.
        if (buffer.params().paragraph_separation ==
                        BufferParams::ParagraphSkipSeparation)
                parindent.erase();
+       // This happens after sections or environments in standard classes.
+       // We have to check the previous layout at same depth.
        else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
                pit_type prev = text_->depthHook(pit, par.getDepth());
                if (par.layout() == pars[prev].layout()) {
@@ -1974,6 +1809,15 @@ int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
                } else if (pars[prev].layout().nextnoindent)
                        parindent.erase();
        }
+       // The previous paragraph may have ended with a separator inset.
+       if (pit > 0) {
+               Paragraph const & ppar = pars[pit - 1];
+               if (ppar.size() > 0) {
+                       auto * in = dynamic_cast<InsetSeparator const *>(ppar.getInset(ppar.size() - 1));
+                       if (in != nullptr && in->nextnoindent())
+                               parindent.erase();
+               }
+       }
 
        FontInfo const labelfont = text_->labelFont(par);
        FontMetrics const & lfm = theFontMetrics(labelfont);
@@ -2154,7 +1998,7 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                swap(pi.leftx, pi.rightx);
 
        BookmarksSection::BookmarkPosList bpl =
-               theSession().bookmarks().bookmarksInPar(bv_->buffer().fileName(), pm.par().id());
+               theSession().bookmarks().bookmarksInPar(bv_->buffer().fileName(), pm.id());
 
        for (size_t i = 0; i != nrows; ++i) {
 
@@ -2212,9 +2056,9 @@ void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const
                // already cleared because of a full repaint.
                if (!pi.full_repaint && row.changed()) {
                        LYXERR(Debug::PAINTING, "Clear rect@("
-                              << max(row_x, 0) << ", " << y - row.ascent() << ")="
+                              << x << ", " << y - row.ascent() << ")="
                               << width() << " x " << row.height());
-                       pi.pain.fillRectangle(row_x, y - row.ascent(),
+                       pi.pain.fillRectangle(x, y - row.ascent(),
                                              width(), row.height(), pi.background_color);
                }