]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.cpp
Amend 3093789e for cmake build
[lyx.git] / src / BufferView.cpp
index 9430ba46320af8709136c882a0cc887b6ede6d02..ea841a05542448807d5a7608892f03689ae6edc9 100644 (file)
@@ -18,7 +18,6 @@
 
 #include "BranchList.h"
 #include "Buffer.h"
-#include "buffer_funcs.h"
 #include "BufferList.h"
 #include "BufferParams.h"
 #include "CoordCache.h"
 #include "CutAndPaste.h"
 #include "DispatchResult.h"
 #include "ErrorList.h"
-#include "factory.h"
-#include "FloatList.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "Intl.h"
-#include "InsetIterator.h"
 #include "Language.h"
-#include "LaTeXFeatures.h"
 #include "LayoutFile.h"
-#include "Length.h"
 #include "Lexer.h"
 #include "LyX.h"
 #include "LyXAction.h"
 #include "lyxfind.h"
-#include "Layout.h"
 #include "LyXRC.h"
 #include "MetricsInfo.h"
 #include "Paragraph.h"
-#include "ParagraphParameters.h"
-#include "ParIterator.h"
-#include "RowPainter.h"
 #include "Session.h"
 #include "Text.h"
-#include "TextClass.h"
 #include "TextMetrics.h"
 #include "TexRow.h"
 #include "TocBackend.h"
-#include "WordLangTuple.h"
 
 #include "insets/InsetBibtex.h"
 #include "insets/InsetCitation.h"
 #include "insets/InsetCommand.h" // ChangeRefs
-#include "insets/InsetExternal.h"
 #include "insets/InsetGraphics.h"
-#include "insets/InsetNote.h"
 #include "insets/InsetRef.h"
 #include "insets/InsetText.h"
 
 #include "mathed/MathData.h"
-#include "mathed/InsetMathNest.h"
 
 #include "frontends/alert.h"
-#include "frontends/Application.h"
+#include "frontends/CaretGeometry.h"
 #include "frontends/Delegates.h"
 #include "frontends/FontMetrics.h"
 #include "frontends/NullPainter.h"
 
 #include "support/convert.h"
 #include "support/debug.h"
-#include "support/ExceptionMessage.h"
+#include "support/docstring.h"
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lassert.h"
+#include "support/Length.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
-#include "support/Package.h"
 #include "support/types.h"
 
+#include <algorithm>
 #include <cerrno>
+#include <cstring>
 #include <fstream>
 #include <functional>
 #include <iterator>
@@ -179,13 +166,6 @@ bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 }
 
 
-/// Looks for next inset with the given code
-void findInset(DocIterator & dit, InsetCode code, bool same_content)
-{
-       findInset(dit, vector<InsetCode>(1, code), same_content);
-}
-
-
 /// Moves cursor to the next inset with one of the given codes.
 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
               bool same_content)
@@ -202,13 +182,6 @@ void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
 }
 
 
-/// Moves cursor to the next inset with given code.
-void gotoInset(BufferView * bv, InsetCode code, bool same_content)
-{
-       gotoInset(bv, vector<InsetCode>(1, code), same_content);
-}
-
-
 /// A map from a Text to the associated text metrics
 typedef map<Text const *, TextMetrics> TextMetricsCache;
 
@@ -316,6 +289,8 @@ struct BufferView::Private
        CursorSlice current_row_slice_;
        /// are we hovering something that we can click
        bool clickable_inset_;
+       /// shape of the caret
+       frontend::CaretGeometry caret_geometry_;
 };
 
 
@@ -374,6 +349,20 @@ int BufferView::leftMargin() const
 }
 
 
+int BufferView::topMargin() const
+{
+       // original value was 20px, which is 0.2in at 100dpi
+       return zoomedPixels(20);
+}
+
+
+int BufferView::bottomMargin() const
+{
+       // original value was 20px, which is 0.2in at 100dpi
+       return zoomedPixels(20);
+}
+
+
 int BufferView::inPixels(Length const & len) const
 {
        Font const font = buffer().params().getFont();
@@ -518,9 +507,9 @@ void BufferView::processUpdateFlags(Update::flags flags)
        // We handle this before FitCursor because the later will require
        // correct metrics at cursor position.
        if (!(flags & Update::ForceDraw)
-           && (flags & Update::SinglePar)
-               && !singleParUpdate())
-                       updateMetrics(flags);
+                       && (flags & Update::SinglePar)
+                       && !singleParUpdate())
+               updateMetrics(flags);
 
        // Then make sure that the screen contains the cursor if needed
        if (flags & Update::FitCursor) {
@@ -668,24 +657,24 @@ string BufferView::contextMenu(int x, int y) const
 
 
 
-void BufferView::scrollDocView(int const value, bool update)
+void BufferView::scrollDocView(int const pixels, bool update)
 {
        // The scrollbar values are relative to the top of the screen, therefore the
        // offset is equal to the target value.
 
        // No scrolling at all? No need to redraw anything
-       if (value == 0)
+       if (pixels == 0)
                return;
 
        // If the offset is less than 2 screen height, prefer to scroll instead.
-       if (abs(value) <= 2 * height_) {
-               d->anchor_ypos_ -= value;
+       if (abs(pixels) <= 2 * height_) {
+               d->anchor_ypos_ -= pixels;
                processUpdateFlags(Update::Force);
                return;
        }
 
        // cut off at the top
-       if (value <= d->scrollbarParameters_.min) {
+       if (pixels <= d->scrollbarParameters_.min) {
                DocIterator dit = doc_iterator_begin(&buffer_);
                showCursor(dit, false, update);
                LYXERR(Debug::SCROLLING, "scroll to top");
@@ -693,7 +682,7 @@ void BufferView::scrollDocView(int const value, bool update)
        }
 
        // cut off at the bottom
-       if (value >= d->scrollbarParameters_.max) {
+       if (pixels >= d->scrollbarParameters_.max) {
                DocIterator dit = doc_iterator_end(&buffer_);
                dit.backwardPos();
                showCursor(dit, false, update);
@@ -706,11 +695,11 @@ void BufferView::scrollDocView(int const value, bool update)
        pit_type i = 0;
        for (; i != int(d->par_height_.size()); ++i) {
                par_pos += d->par_height_[i];
-               if (par_pos >= value)
+               if (par_pos >= pixels)
                        break;
        }
 
-       if (par_pos < value) {
+       if (par_pos < pixels) {
                // It seems we didn't find the correct pit so stay on the safe side and
                // scroll to bottom.
                LYXERR0("scrolling position not found!");
@@ -720,7 +709,7 @@ void BufferView::scrollDocView(int const value, bool update)
 
        DocIterator dit = doc_iterator_begin(&buffer_);
        dit.pit() = i;
-       LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
+       LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
        showCursor(dit, false, update);
 }
 
@@ -938,13 +927,16 @@ bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
        if (height_ == 0)
                return false;
 
-       LYXERR(Debug::SCROLLING, "recentering!");
+       if (recenter)
+         LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
+       else
+         LYXERR(Debug::SCROLLING, "scrolling to cursor");
 
        CursorSlice const & bot = dit.bottom();
        TextMetrics & tm = d->text_metrics_[bot.text()];
 
        pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
-       int bot_pit = bot.pit();
+       pos_type bot_pit = bot.pit();
        if (bot_pit > max_pit) {
                // FIXME: Why does this happen?
                LYXERR0("bottom pit is greater that max pit: "
@@ -1133,7 +1125,7 @@ bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
                break;
        case LFUN_FILE_INSERT_PLAINTEXT_PARA:
        case LFUN_FILE_INSERT_PLAINTEXT: {
-               docstring const fname = cmd.argument();
+               docstring const fname = cmd.argument();
                if (!FileName::isAbsolute(to_utf8(fname))) {
                        flag.message(_("Absolute filename expected."));
                        return false;
@@ -1527,14 +1519,19 @@ void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
        }
 
        case LFUN_NOTE_NEXT:
-               gotoInset(this, NOTE_CODE, false);
+               gotoInset(this, { NOTE_CODE }, false);
+               // FIXME: if SinglePar is changed to act on the inner
+               // paragraph, this will not be OK anymore. The update is
+               // useful for auto-open collapsible insets.
+               dr.screenUpdate(Update::SinglePar | Update::FitCursor);
                break;
 
        case LFUN_REFERENCE_NEXT: {
-               vector<InsetCode> tmp;
-               tmp.push_back(LABEL_CODE);
-               tmp.push_back(REF_CODE);
-               gotoInset(this, tmp, true);
+               gotoInset(this, { LABEL_CODE, REF_CODE }, true);
+               // FIXME: if SinglePar is changed to act on the inner
+               // paragraph, this will not be OK anymore. The update is
+               // useful for auto-open collapsible insets.
+               dr.screenUpdate(Update::SinglePar | Update::FitCursor);
                break;
        }
 
@@ -1712,7 +1709,7 @@ void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
 
        case LFUN_BIBTEX_DATABASE_ADD: {
                Cursor tmpcur = cur;
-               findInset(tmpcur, BIBTEX_CODE, false);
+               findInset(tmpcur, { BIBTEX_CODE }, false);
                InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
                                                BIBTEX_CODE);
                if (inset) {
@@ -1724,7 +1721,7 @@ void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
 
        case LFUN_BIBTEX_DATABASE_DEL: {
                Cursor tmpcur = cur;
-               findInset(tmpcur, BIBTEX_CODE, false);
+               findInset(tmpcur, { BIBTEX_CODE }, false);
                InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
                                                BIBTEX_CODE);
                if (inset) {
@@ -2431,21 +2428,21 @@ int BufferView::minVisiblePart()
 }
 
 
-int BufferView::scroll(int y)
+int BufferView::scroll(int pixels)
 {
-       if (y > 0)
-               return scrollDown(y);
-       if (y < 0)
-               return scrollUp(-y);
+       if (pixels > 0)
+               return scrollDown(pixels);
+       if (pixels < 0)
+               return scrollUp(-pixels);
        return 0;
 }
 
 
-int BufferView::scrollDown(int offset)
+int BufferView::scrollDown(int pixels)
 {
        Text * text = &buffer_.text();
        TextMetrics & tm = d->text_metrics_[text];
-       int const ymax = height_ + offset;
+       int const ymax = height_ + pixels;
        while (true) {
                pair<pit_type, ParagraphMetrics const *> last = tm.last();
                int bottom_pos = last.second->position() + last.second->descent();
@@ -2454,38 +2451,38 @@ int BufferView::scrollDown(int offset)
                if (last.first + 1 == int(text->paragraphs().size())) {
                        if (bottom_pos <= height_)
                                return 0;
-                       offset = min(offset, bottom_pos - height_);
+                       pixels = min(pixels, bottom_pos - height_);
                        break;
                }
                if (bottom_pos > ymax)
                        break;
                tm.newParMetricsDown();
        }
-       d->anchor_ypos_ -= offset;
-       return -offset;
+       d->anchor_ypos_ -= pixels;
+       return -pixels;
 }
 
 
-int BufferView::scrollUp(int offset)
+int BufferView::scrollUp(int pixels)
 {
        Text * text = &buffer_.text();
        TextMetrics & tm = d->text_metrics_[text];
-       int ymin = - offset;
+       int ymin = - pixels;
        while (true) {
                pair<pit_type, ParagraphMetrics const *> first = tm.first();
                int top_pos = first.second->position() - first.second->ascent();
                if (first.first == 0) {
                        if (top_pos >= 0)
                                return 0;
-                       offset = min(offset, - top_pos);
+                       pixels = min(pixels, - top_pos);
                        break;
                }
                if (top_pos < ymin)
                        break;
                tm.newParMetricsUp();
        }
-       d->anchor_ypos_ += offset;
-       return offset;
+       d->anchor_ypos_ += pixels;
+       return pixels;
 }
 
 
@@ -2769,7 +2766,7 @@ bool BufferView::singleParUpdate()
        Text & buftext = buffer_.text();
        pit_type const bottom_pit = d->cursor_.bottom().pit();
        TextMetrics & tm = textMetrics(&buftext);
-       int old_height = tm.parMetrics(bottom_pit).height();
+       Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
 
        // make sure inline completion pointer is ok
        if (d->inlineCompletionPos_.fixIfBroken())
@@ -2780,11 +2777,16 @@ bool BufferView::singleParUpdate()
        // (if this paragraph contains insets etc., rebreaking will
        // recursively descend)
        tm.redoParagraph(bottom_pit);
-       ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
-       if (pm.height() != old_height)
+       ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
+       if (pm.height() != old_dim.height()) {
                // Paragraph height has changed so we cannot proceed to
                // the singlePar optimisation.
                return false;
+       }
+       // Since position() points to the baseline of the first row, we
+       // may have to update it. See ticket #11601 for an example where
+       // the height does not change but the ascent does.
+       pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
 
        tm.updatePosCache(bottom_pit);
 
@@ -2832,7 +2834,7 @@ void BufferView::updateMetrics(Update::flags & update_flags)
 
        // Rebreak anchor paragraph.
        tm.redoParagraph(d->anchor_pit_);
-       ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
+       ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
 
        // position anchor
        if (d->anchor_pit_ == 0) {
@@ -2859,7 +2861,7 @@ void BufferView::updateMetrics(Update::flags & update_flags)
        pit_type pit1 = d->anchor_pit_ - 1;
        for (; pit1 >= 0 && y1 >= 0; --pit1) {
                tm.redoParagraph(pit1);
-               ParagraphMetrics & pm = tm.par_metrics_[pit1];
+               ParagraphMetrics & pm = tm.parMetrics(pit1);
                y1 -= pm.descent();
                // Save the paragraph position in the cache.
                pm.setPosition(y1);
@@ -2873,7 +2875,7 @@ void BufferView::updateMetrics(Update::flags & update_flags)
        pit_type pit2 = d->anchor_pit_ + 1;
        for (; pit2 < npit && y2 <= height_; ++pit2) {
                tm.redoParagraph(pit2);
-               ParagraphMetrics & pm = tm.par_metrics_[pit2];
+               ParagraphMetrics & pm = tm.parMetrics(pit2);
                y2 += pm.ascent();
                // Save the paragraph position in the cache.
                pm.setPosition(y2);
@@ -3049,23 +3051,107 @@ bool BufferView::paragraphVisible(DocIterator const & dit) const
 }
 
 
-void BufferView::caretPosAndHeight(Point & p, int & h) const
+void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
 {
-       int asc, des;
        Cursor const & cur = cursor();
        if (cur.inMathed()) {
                MathRow const & mrow = mathRow(&cur.cell());
-               asc = mrow.caret_ascent;
-               des = mrow.caret_descent;
+               dim = mrow.caret_dim;
        } else {
                Font const font = cur.real_current_font;
                frontend::FontMetrics const & fm = theFontMetrics(font);
-               asc = fm.maxAscent();
-               des = fm.maxDescent();
+               dim.wid = fm.lineWidth();
+               dim.asc = fm.maxAscent();
+               dim.des = fm.maxDescent();
        }
-       h = asc + des;
+       if (lyxrc.cursor_width > 0)
+               dim.wid = lyxrc.cursor_width;
+
        p = getPos(cur);
-       p.y_ -= asc;
+       // center fat carets horizontally
+       p.x_ -= dim.wid / 2;
+       // p is top-left
+       p.y_ -= dim.asc;
+}
+
+
+void BufferView::buildCaretGeometry(bool complet)
+{
+       Point p;
+       Dimension dim;
+       caretPosAndDim(p, dim);
+
+       Cursor const & cur = d->cursor_;
+       Font const & realfont = cur.real_current_font;
+       frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
+       bool const isrtl = realfont.isVisibleRightToLeft();
+       int const dir = isrtl ? -1 : 1;
+
+       frontend::CaretGeometry & cg = d->caret_geometry_;
+       cg.shapes.clear();
+
+       // The caret itself, slanted for italics in text edit mode except
+       // for selections because the selection rect does not slant
+       bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
+       double const slope = slant ? fm.italicSlope() : 0;
+       cg.shapes.push_back(
+               {{iround(p.x_ + dim.asc * slope), p.y_},
+                {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
+                {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
+                {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
+               );
+
+       // The language indicator _| (if needed)
+       Language const * doclang = buffer().params().language;
+       if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
+                 || realfont.language() == latex_language)) {
+               int const lx = dim.height() / 3;
+               int const xx = iround(p.x_ - dim.des * slope);
+               int const yy = p.y_ + dim.height();
+               cg.shapes.push_back(
+                       {{xx, yy - dim.wid},
+                        {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
+                        {xx + dir * (dim.wid + lx - 1), yy},
+                        {xx, yy}}
+                       );
+       }
+
+       // The completion triangle |> (if needed)
+       if (complet) {
+               int const m = p.y_ + dim.height() / 2;
+               int const d = dim.height() / 8;
+               // offset for slanted carret
+               int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
+               // starting position x
+               int const xx = p.x_ + dir * dim.wid + sx;
+               cg.shapes.push_back(
+                       {{xx, m - d},
+                        {xx + dir * d, m},
+                        {xx, m + d},
+                        {xx, m + d - dim.wid},
+                        {xx + dir * d - dim.wid, m},
+                        {xx, m - d + dim.wid}}
+                       );
+       }
+
+       // compute extremal x values
+       cg.left = 1000000;
+       cg.right = -1000000;
+       cg.top = 1000000;
+       cg.bottom = -1000000;
+       for (auto const & shape : cg.shapes)
+               for (Point const & p : shape) {
+                       cg.left = min(cg.left, p.x_);
+                       cg.right = max(cg.right, p.x_);
+                       cg.top = min(cg.top, p.y_);
+                       cg.bottom = max(cg.bottom, p.y_);
+               }
+}
+
+
+frontend::CaretGeometry const &  BufferView::caretGeometry() const
+{
+       return d->caret_geometry_;
 }
 
 
@@ -3074,11 +3160,11 @@ bool BufferView::caretInView() const
        if (!paragraphVisible(cursor()))
                return false;
        Point p;
-       int h;
-       caretPosAndHeight(p, h);
+       Dimension dim;
+       caretPosAndDim(p, dim);
 
        // does the cursor touch the screen ?
-       if (p.y_ + h < 0 || p.y_ >= workHeight())
+       if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
                return false;
        return true;
 }
@@ -3264,6 +3350,7 @@ void BufferView::draw(frontend::Painter & pain, bool paint_caret)
                                : "\t\t *** END DRAWING ***"));
 
        // The scrollbar needs an update.
+       // FIXME: does it always? see ticket #11947.
        updateScrollbar();
 
        // Normalize anchor for next time
@@ -3292,8 +3379,17 @@ void BufferView::draw(frontend::Painter & pain, bool paint_caret)
         * move at all
         */
        if (paint_caret) {
-               Row const & caret_row = d->cursor_.textRow();
-               caret_row.changed(true);
+               Cursor cur(d->cursor_);
+               while (cur.depth() > 1) {
+                       if (!cur.inTexted())
+                               break;
+                       TextMetrics const & tm = textMetrics(cur.text());
+                       if (d->caret_geometry_.left >= tm.origin().x_
+                               && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
+                               break;
+                       cur.pop();
+               }
+               cur.textRow().changed(true);
        }
 }
 
@@ -3395,7 +3491,7 @@ docstring const & BufferView::inlineCompletion() const
 }
 
 
-size_t const & BufferView::inlineCompletionUniqueChars() const
+size_t BufferView::inlineCompletionUniqueChars() const
 {
        return d->inlineCompletionUniqueChars_;
 }