]> git.lyx.org Git - lyx.git/blobdiff - src/rowpainter.C
fix compiler warnings about unused parameter
[lyx.git] / src / rowpainter.C
index ce48d1cd7400cb9fc527dac3d51480fd2760f167..2cb5b6311abefe4f6583f6b4b3edc2924fd5e762 100644 (file)
 #include "LColor.h"
 #include "lyxrc.h"
 #include "lyxrow.h"
-#include "lyxrow_funcs.h"
 #include "metricsinfo.h"
 #include "paragraph.h"
+#include "ParagraphMetrics.h"
 #include "paragraph_funcs.h"
 #include "ParagraphParameters.h"
+#include "TextMetrics.h"
 #include "vspace.h"
 
 #include "frontends/FontMetrics.h"
-#include "frontends/nullpainter.h"
 #include "frontends/Painter.h"
 
 #include "insets/insettext.h"
 namespace lyx {
 
 using frontend::Painter;
-using frontend::NullPainter;
 using frontend::FontMetrics;
 
 using std::endl;
 using std::max;
-using std::min;
 using std::string;
 
 
@@ -77,12 +75,13 @@ public:
        void paintFirst();
        void paintLast();
        void paintText();
+       int maxWidth() { return max_width_; }
 
 private:
        void paintForeignMark(double orig_x, LyXFont const & font, int desc = 0);
        void paintHebrewComposeChar(pos_type & vpos, LyXFont const & font);
        void paintArabicComposeChar(pos_type & vpos, LyXFont const & font);
-       void paintChars(pos_type & vpos, LyXFont font,
+       void paintChars(pos_type & vpos, LyXFont const & font,
                        bool hebrew, bool arabic);
        int paintAppendixStart(int y);
        void paintFromPos(pos_type & vpos);
@@ -102,6 +101,7 @@ private:
 
        /// LyXText for the row
        LyXText const & text_;
+       TextMetrics & text_metrics_;
        ParagraphList const & pars_;
 
        /// The row to paint
@@ -110,6 +110,8 @@ private:
        /// Row's paragraph
        pit_type const pit_;
        Paragraph const & par_;
+       ParagraphMetrics const & pm_;
+       int max_width_;
 
        /// is row erased? (change tracking)
        bool erased_;
@@ -127,12 +129,16 @@ private:
 
 RowPainter::RowPainter(PainterInfo & pi,
        LyXText const & text, pit_type pit, Row const & row, int x, int y)
-       : bv_(*pi.base.bv), pain_(pi.pain), text_(text), pars_(text.paragraphs()),
+       : bv_(*pi.base.bv), pain_(pi.pain), text_(text),
+         text_metrics_(pi.base.bv->textMetrics(&text)),
+         pars_(text.paragraphs()),
          row_(row), pit_(pit), par_(text.paragraphs()[pit]),
+         pm_(text_metrics_.parMetrics(pit)),
+         max_width_(bv_.workWidth()),
          erased_(pi.erased_),
-         xo_(x), yo_(y), width_(text_.width())
+         xo_(x), yo_(y), width_(text_metrics_.width())
 {
-       RowMetrics m = text_.computeRowMetrics(pit, row_);
+       RowMetrics m = text_metrics_.computeRowMetrics(pit_, row_);
        x_ = m.x + xo_;
 
        //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
@@ -149,16 +155,21 @@ RowPainter::RowPainter(PainterInfo & pi,
 
 LyXFont const RowPainter::getLabelFont() const
 {
-       return text_.getLabelFont(par_);
+       return text_.getLabelFont(*bv_.buffer(), par_);
 }
 
 
 int RowPainter::leftMargin() const
 {
-       return text_.leftMargin(pit_, row_.pos());
+       return text_.leftMargin(*bv_.buffer(), max_width_, pit_, row_.pos());
 }
 
 
+// If you want to debug inset metrics uncomment the following line:
+// #define DEBUG_METRICS
+// This draws green lines around each inset.
+
+
 void RowPainter::paintInset(pos_type const pos, LyXFont const & font)
 {
        InsetBase const * inset = par_.getInset(pos);
@@ -171,19 +182,54 @@ void RowPainter::paintInset(pos_type const pos, LyXFont const & font)
                font;
        pi.ltr_pos = (text_.bidi.level(pos) % 2 == 0);
        pi.erased_ = erased_ || par_.isDeleted(pos);
+#ifdef DEBUG_METRICS
+       int const x1 = int(x_);
+#endif
        bv_.coordCache().insets().add(inset, int(x_), yo_);
        InsetText const * const in = inset->asTextInset();
        // non-wide insets are painted completely. Recursive
        bool tmp = refreshInside;
-       if (!in || !in->Wide()) {
+       if (!in || !in->wide()) {
                refreshInside = true;
-               lyxerr[Debug::PAINTING] << endl << "Paint inset fully" << endl;
+               if (lyxerr.debugging(Debug::PAINTING)) { 
+                       lyxerr << endl << "Paint inset fully" << endl;
+               }
        }
        if (refreshInside)
                inset->drawSelection(pi, int(x_), yo_);
        inset->draw(pi, int(x_), yo_);
        refreshInside = tmp;
        x_ += inset->width();
+#ifdef DEBUG_METRICS
+       Dimension dim;
+       BOOST_ASSERT(max_witdh_ > 0);
+       int right_margin = text_metrics_.rightMargin(pm_);
+       int const w = max_witdh_ - leftMargin() - right_margin;
+       MetricsInfo mi(&bv_, font, w);
+       inset->metrics(mi, dim);
+       if (inset->width() > dim.wid) 
+               lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
+                      << " draw width " << inset->width()
+                      << "> metrics width " << dim.wid << "." << std::endl;
+       if (inset->ascent() > dim.asc) 
+               lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
+                      << " draw ascent " << inset->ascent()
+                      << "> metrics ascent " << dim.asc << "." << std::endl;
+       if (inset->descent() > dim.des) 
+               lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
+                      << " draw ascent " << inset->descent()
+                      << "> metrics descent " << dim.des << "." << std::endl;
+       BOOST_ASSERT(inset->width() <= dim.wid);
+       BOOST_ASSERT(inset->ascent() <= dim.asc);
+       BOOST_ASSERT(inset->descent() <= dim.des);
+       int const x2 = x1 + dim.wid;
+       int const y1 = yo_ + dim.des;
+       int const y2 = yo_ - dim.asc;
+       pi.pain.line(x1, y1, x1, y2, LColor::green);
+       pi.pain.line(x1, y1, x2, y1, LColor::green);
+       pi.pain.line(x2, y1, x2, y2, LColor::green);
+       pi.pain.line(x1, y2, x2, y2, LColor::green);
+#endif
 }
 
 
@@ -205,8 +251,8 @@ void RowPainter::paintHebrewComposeChar(pos_type & vpos, LyXFont const & font)
                c = par_.getChar(i);
                if (!Encodings::isComposeChar_hebrew(c)) {
                        if (isPrintableNonspace(c)) {
-                               int const width2 =
-                                       text_.singleWidth(par_, i, c, text_.getFont(par_, i));
+                               int const width2 = text_.singleWidth(par_, i, c,
+                                       text_.getFont(*bv_.buffer(), par_, i));
                                // FIXME UNICODE
                                // This does not work anymore, and non-ascii
                                // characters in source files are forbidden
@@ -244,8 +290,8 @@ void RowPainter::paintArabicComposeChar(pos_type & vpos, LyXFont const & font)
                c = par_.getChar(i);
                if (!Encodings::isComposeChar_arabic(c)) {
                        if (isPrintableNonspace(c)) {
-                               int const width2 =
-                                       text_.singleWidth(par_, i, c, text_.getFont(par_, i));
+                               int const width2 = text_.singleWidth(par_, i, c,
+                                               text_.getFont(*bv_.buffer(), par_, i));
                                dx = (width2 - width) / 2;
                        }
                        break;
@@ -255,23 +301,20 @@ void RowPainter::paintArabicComposeChar(pos_type & vpos, LyXFont const & font)
        pain_.text(int(x_) + dx, yo_, str, font);
 }
 
-
-void RowPainter::paintChars(pos_type & vpos, LyXFont font,
+void RowPainter::paintChars(pos_type & vpos, LyXFont const & font,
                            bool hebrew, bool arabic)
 {
+       // This method takes up 70% of time when typing
        pos_type pos = text_.bidi.vis2log(vpos);
        pos_type const end = row_.endpos();
        FontSpan const font_span = par_.fontSpan(pos);
        Change::Type const prev_change = par_.lookupChange(pos).type;
 
        // first character
-#if 0
-       string str;
-       str += par_.getChar(pos);
-#else
        std::vector<char_type> str;
+       str.reserve(100);
        str.push_back(par_.getChar(pos));
-#endif
+
        if (arabic) {
                char_type c = str[0];
                str[0] = par_.transformChar(c, pos);
@@ -300,26 +343,20 @@ void RowPainter::paintChars(pos_type & vpos, LyXFont font,
                if (arabic)
                        c = par_.transformChar(c, pos);
 
-#if 0
-               str += c;
-#else
                str.push_back(c);
-#endif
        }
 
-       if (prev_change == Change::DELETED)
-               font.setColor(LColor::strikeout);
-       else if (prev_change == Change::INSERTED)
-               font.setColor(LColor::newtext);
-
-       // Draw text and set the new x position
-       //lyxerr << "paint row: yo_ " << yo_ << "\n";
-#if 0
-       int width = pain_.text(int(x_), yo_, str, font);
-#else
-       int width = pain_.text(int(x_), yo_, &str[0], str.size(), font);
-#endif
-       x_ += width;
+       if (prev_change != Change::UNCHANGED) {
+               LyXFont copy(font);
+               if (prev_change == Change::DELETED) {
+                       copy.setColor(LColor::strikeout);
+               } else if (prev_change == Change::INSERTED) {
+                       copy.setColor(LColor::newtext);
+               }
+               x_ += pain_.text(int(x_), yo_, &str[0], str.size(), copy);
+       } else {
+               x_ += pain_.text(int(x_), yo_, &str[0], str.size(), font);
+       }
 }
 
 
@@ -340,7 +377,7 @@ void RowPainter::paintForeignMark(double orig_x, LyXFont const & font, int desc)
 void RowPainter::paintFromPos(pos_type & vpos)
 {
        pos_type const pos = text_.bidi.vis2log(vpos);
-       LyXFont orig_font = text_.getFont(par_, pos);
+       LyXFont orig_font = text_.getFont(*bv_.buffer(), par_, pos);
 
        double const orig_x = x_;
 
@@ -380,7 +417,13 @@ void RowPainter::paintFromPos(pos_type & vpos)
 void RowPainter::paintChangeBar()
 {
        pos_type const start = row_.pos();
-       pos_type const end = row_.endpos();
+       pos_type end = row_.endpos();
+
+       if (par_.size() == end) {
+               // this is the last row of the paragraph;
+               // thus, we must also consider the imaginary end-of-par character
+               end++;
+       }
 
        if (start == end || !par_.isChanged(start, end))
                return;
@@ -435,7 +478,7 @@ void RowPainter::paintDepthBar()
                int const w = nestMargin() / 5;
                int x = int(xo_) + w * i;
                // only consider the changebar space if we're drawing outermost text
-               if (text_.isMainText())
+               if (text_.isMainText(*bv_.buffer()))
                        x += changebarMargin();
 
                int const starty = yo_ - row_.ascent();
@@ -506,7 +549,7 @@ void RowPainter::paintFirst()
                }
        }
 
-       bool const is_rtl = text_.isRTL(par_);
+       bool const is_rtl = text_.isRTL(buffer, par_);
        bool const is_seq = isFirstInSequence(pit_, text_.paragraphs());
        //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << std::endl;
 
@@ -588,7 +631,7 @@ void RowPainter::paintFirst()
                        if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
                                if (is_rtl)
                                        x = leftMargin();
-                               x += (width_ - text_.rightMargin(par_) - leftMargin()) / 2;
+                               x += (width_ - text_metrics_.rightMargin(pm_) - leftMargin()) / 2;
                                x -= fm.width(str) / 2;
                        } else if (is_rtl) {
                                x = width_ - leftMargin() -     fm.width(str);
@@ -601,10 +644,24 @@ void RowPainter::paintFirst()
 
 void RowPainter::paintLast()
 {
-       bool const is_rtl = text_.isRTL(par_);
+       bool const is_rtl = text_.isRTL(*bv_.buffer(), par_);
        int const endlabel = getEndLabel(pit_, text_.paragraphs());
 
+       // paint imaginary end-of-paragraph character
+
+       if (par_.isInserted(par_.size()) || par_.isDeleted(par_.size())) {
+               FontMetrics const & fm = theFontMetrics(bv_.buffer()->params().getFont());
+               int const length = fm.maxAscent() / 2;
+               LColor::color col = par_.isInserted(par_.size()) ? LColor::newtext : LColor::strikeout;
+               
+               pain_.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
+                          Painter::line_solid, Painter::line_thick);
+               pain_.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1, yo_ + 2, col,
+                          Painter::line_solid, Painter::line_thick);
+       }
+
        // draw an endlabel
+
        switch (endlabel) {
        case END_LABEL_BOX:
        case END_LABEL_FILLED_BOX: {
@@ -630,7 +687,7 @@ void RowPainter::paintLast()
                docstring const & str = par_.layout()->endlabelstring();
                double const x = is_rtl ?
                        x_ - fm.width(str)
-                       : - text_.rightMargin(par_) - row_.width();
+                       : - text_metrics_.rightMargin(pm_) - row_.width();
                pain_.text(int(x), yo_, str, font);
                break;
        }
@@ -659,6 +716,7 @@ void RowPainter::paintText()
        // Use font span to speed things up, see below
        FontSpan font_span;
        LyXFont font;
+       Buffer const & buffer = *bv_.buffer();
 
        for (pos_type vpos = row_.pos(); vpos < end; ) {
                if (x_ > bv_.workWidth())
@@ -674,7 +732,7 @@ void RowPainter::paintText()
                // Use font span to speed things up, see above
                if (vpos < font_span.first || vpos > font_span.last) {
                        font_span = par_.fontSpan(vpos);
-                       font = text_.getFont(par_, vpos);
+                       font = text_.getFont(buffer, par_, vpos);
                }
 
                const int width_pos =
@@ -724,7 +782,7 @@ void RowPainter::paintText()
 
                        pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
 
-                       if (hfillExpansion(par_, row_, pos)) {
+                       if (par_.hfillExpansion(row_, pos)) {
                                int const y2 = (y0 + y1) / 2;
 
                                if (pos >= body_pos) {
@@ -765,20 +823,6 @@ void RowPainter::paintText()
 }
 
 
-size_type calculateRowSignature(Row const & row, Paragraph const & par,
-       int x, int y)
-{
-       boost::crc_32_type crc;
-       for (pos_type i = row.pos(); i < row.endpos(); ++i) {
-               const unsigned char b[] = { par.getChar(i) };
-               crc.process_bytes(b, 1);
-       }
-       const unsigned char b[] = { x, y, row.width() };
-       crc.process_bytes(b, 3);
-       return crc.checksum();
-}
-
-
 bool CursorOnRow(PainterInfo & pi, pit_type const pit,
        RowList::const_iterator rit, LyXText const & text)
 {
@@ -820,18 +864,17 @@ void paintPar
         bool repaintAll)
 {
 //     lyxerr << "  paintPar: pit: " << pit << " at y: " << y << endl;
-       static NullPainter nop;
-       static PainterInfo nullpi(pi.base.bv, nop);
        int const ww = pi.base.bv->workHeight();
 
        pi.base.bv->coordCache().parPos()[&text][pit] = Point(x, y);
 
        Paragraph const & par = text.paragraphs()[pit];
-       if (par.rows().empty())
+       ParagraphMetrics const & pm = pi.base.bv->parMetrics(&text, pit);
+       if (pm.rows().empty())
                return;
 
-       RowList::const_iterator const rb = par.rows().begin();
-       RowList::const_iterator const re = par.rows().end();
+       RowList::const_iterator const rb = pm.rows().begin();
+       RowList::const_iterator const re = pm.rows().end();
 
        y -= rb->ascent();
        size_type rowno = 0;
@@ -842,20 +885,27 @@ void paintPar
                bool tmp = refreshInside;
 
                // Row signature; has row changed since last paint?
-               size_type const row_sig = calculateRowSignature(*rit, par, x, y);
-               bool row_has_changed = par.rowSignature()[rowno] != row_sig;
+               bool row_has_changed = pm.rowChangeStatus()[rowno];
 
                bool cursor_on_row = CursorOnRow(pi, pit, rit, text);
                bool in_inset_alone_on_row = innerCursorOnRow(pi, pit, rit,
                        text);
+               bool leftEdgeFixed = 
+                       (par.getAlign() == LYX_ALIGN_LEFT ||
+                        par.getAlign() == LYX_ALIGN_BLOCK);
 
                // If this is the only object on the row, we can make it wide
+               //
+               // FIXME: there is a const_cast here because paintPar() is not supposed
+               // to touch the paragraph contents. So either we move this "wide"
+               // property out of InsetText or we localize the feature to the painting
+               // done here.
                for (pos_type i = rit->pos() ; i != rit->endpos(); ++i) {
                        InsetBase const * const in = par.getInset(i);
                        if (in) {
-                               InsetText const * const t = in->asTextInset();
+                               InsetText * t = const_cast<InsetText *>(in->asTextInset());
                                if (t)
-                                       t->Wide() = in_inset_alone_on_row;
+                                       t->setWide(in_inset_alone_on_row && leftEdgeFixed);
                        }
                }
 
@@ -863,18 +913,18 @@ void paintPar
                // from cache, or cursor is inside an inset _on this row_,
                // then paint the row
                if (repaintAll || row_has_changed || cursor_on_row) {
-                       // Add to row signature cache
-                       par.rowSignature()[rowno] = row_sig;
-
                        bool const inside = (y + rit->descent() >= 0
-                                      && y - rit->ascent() < ww);
-                       RowPainter rp(inside ? pi : nullpi, text, pit, *rit, x, y);
+                               && y - rit->ascent() < ww);
+                       // it is not needed to draw on screen if we are not inside.
+                       pi.pain.setDrawingEnabled(inside);
+                       RowPainter rp(pi, text, pit, *rit, x, y);
                        // Clear background of this row
                        // (if paragraph background was not cleared)
                        if (!repaintAll &&
-                           (!in_inset_alone_on_row || row_has_changed)) {
+                           (!(in_inset_alone_on_row && leftEdgeFixed) 
+                               || row_has_changed)) {
                                pi.pain.fillRectangle(x, y - rit->ascent(),
-                                   text.maxwidth_, rit->height(),
+                                   rp.maxWidth(), rit->height(),
                                    text.backgroundColor());
                                // If outer row has changed, force nested
                                // insets to repaint completely
@@ -884,40 +934,53 @@ void paintPar
 
                        // Instrumentation for testing row cache (see also
                        // 12 lines lower):
-                       if (text.isMainText())
-                               lyxerr[Debug::PAINTING] << "#";
-                       else
-                               lyxerr[Debug::PAINTING] << "[" <<
-                                   repaintAll << row_has_changed <<
-                                   cursor_on_row << "]";
+                       if (lyxerr.debugging(Debug::PAINTING)) {
+                               if (text.isMainText(*pi.base.bv->buffer()))
+                                       lyxerr[Debug::PAINTING] << "#";
+                               else
+                                       lyxerr[Debug::PAINTING] << "[" <<
+                                               repaintAll << row_has_changed <<
+                                               cursor_on_row << "]";
+                       }
                        rp.paintAppendix();
                        rp.paintDepthBar();
                        rp.paintChangeBar();
                        if (rit == rb)
                                rp.paintFirst();
+                       rp.paintText();
                        if (rit + 1 == re)
                                rp.paintLast();
-                       rp.paintText();
                }
                y += rit->descent();
                // Restore, see above
                refreshInside = tmp;
        }
-       lyxerr[Debug::PAINTING] << "." << endl;
+       // Re-enable screen drawing for future use of the painter.
+       pi.pain.setDrawingEnabled(true);
+
+       if (lyxerr.debugging(Debug::PAINTING)) {
+               lyxerr[Debug::PAINTING] << "." << endl;
+       }
 }
 
 } // namespace anon
 
 
-void paintText(BufferView & bv, ViewMetricsInfo const & vi,
+void paintText(BufferView & bv,
               Painter & pain)
 {
-       LyXText & text = bv.buffer()->text();
+       BOOST_ASSERT(bv.buffer());
+       Buffer const & buffer = *bv.buffer();
+       LyXText & text = buffer.text();
        bool const select = bv.cursor().selection();
-
+       ViewMetricsInfo const & vi = bv.viewMetricsInfo();
+       
        PainterInfo pi(const_cast<BufferView *>(&bv), pain);
        // Should the whole screen, including insets, be refreshed?
-       bool repaintAll = select || !vi.singlepar;
+       // FIXME: We should also distinguish DecorationUpdate to avoid text
+       // drawing if possible. This is not possible to do easily right now
+       // because of the single backing pixmap.
+       bool repaintAll = select || vi.update_strategy != SingleParUpdate;
 
        if (repaintAll) {
                // Clear background (if not delegated to rows)
@@ -932,36 +995,20 @@ void paintText(BufferView & bv, ViewMetricsInfo const & vi,
        // draw contents
        for (pit_type pit = vi.p1; pit <= vi.p2; ++pit) {
                refreshInside = repaintAll;
-               Paragraph const & par = text.getPar(pit);
-               yy += par.ascent();
+               ParagraphMetrics const & pm = bv.parMetrics(&text, pit);
+               yy += pm.ascent();
                paintPar(pi, text, pit, 0, yy, repaintAll);
-               yy += par.descent();
-       }
-
-       // Cache one paragraph above and one below
-       // Note MV: this cannot be suppressed even for singlepar.
-       // Try viewing the User Guide Mobius figure
-
-       if (vi.p1 > 0) {
-               text.redoParagraph(vi.p1 - 1);
-               bv.coordCache().parPos()[&text][vi.p1 - 1] =
-                       Point(0, vi.y1 - text.getPar(vi.p1 - 1).descent());
-       }
-
-       if (vi.p2 < pit_type(text.paragraphs().size()) - 1) {
-               text.redoParagraph(vi.p2 + 1);
-               bv.coordCache().parPos()[&text][vi.p2 + 1] =
-                       Point(0, vi.y2 + text.getPar(vi.p2 + 1).ascent());
+               yy += pm.descent();
        }
 
        // and grey out above (should not happen later)
 //     lyxerr << "par ascent: " << text.getPar(vi.p1).ascent() << endl;
-       if (vi.y1 > 0 && !vi.singlepar)
+       if (vi.y1 > 0 && vi.update_strategy != SingleParUpdate)
                pain.fillRectangle(0, 0, bv.workWidth(), vi.y1, LColor::bottomarea);
 
        // and possibly grey out below
 //     lyxerr << "par descent: " << text.getPar(vi.p1).ascent() << endl;
-       if (vi.y2 < bv.workHeight() && !vi.singlepar)
+       if (vi.y2 < bv.workHeight() && vi.update_strategy != SingleParUpdate)
                pain.fillRectangle(0, vi.y2, bv.workWidth(), bv.workHeight() - vi.y2, LColor::bottomarea);
 }
 
@@ -970,13 +1017,15 @@ void paintTextInset(LyXText const & text, PainterInfo & pi, int x, int y)
 {
 //     lyxerr << "  paintTextInset: y: " << y << endl;
 
-       y -= text.getPar(0).ascent();
-       // This flag can not be set from within same inset:
+       y -= pi.base.bv->parMetrics(&text, 0).ascent();
+       // This flag cannot be set from within same inset:
        bool repaintAll = refreshInside;
        for (int pit = 0; pit < int(text.paragraphs().size()); ++pit) {
-               y += text.getPar(pit).ascent();
+               ParagraphMetrics const & pmi 
+                       = pi.base.bv->parMetrics(&text, pit);
+               y += pmi.ascent();
                paintPar(pi, text, pit, x, y, repaintAll);
-               y += text.getPar(pit).descent();
+               y += pmi.descent();
        }
 }