]> git.lyx.org Git - lyx.git/blob - src/TextMetrics.cpp
Do not require an extra pit parameter when a row is available
[lyx.git] / src / TextMetrics.cpp
1 /**
2  * \file src/TextMetrics.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Asger Alstrup
7  * \author Lars Gullik Bjønnes
8  * \author Jean-Marc Lasgouttes
9  * \author John Levon
10  * \author André Pönitz
11  * \author Dekel Tsur
12  * \author Jürgen Vigna
13  * \author Abdelrazak Younes
14  *
15  * Full author contact details are available in file CREDITS.
16  */
17
18 #include <config.h>
19
20 #include "TextMetrics.h"
21
22 #include "Buffer.h"
23 #include "buffer_funcs.h"
24 #include "BufferParams.h"
25 #include "BufferView.h"
26 #include "CoordCache.h"
27 #include "Cursor.h"
28 #include "CutAndPaste.h"
29 #include "HSpace.h"
30 #include "InsetList.h"
31 #include "Language.h"
32 #include "Layout.h"
33 #include "LyXRC.h"
34 #include "MetricsInfo.h"
35 #include "ParagraphParameters.h"
36 #include "RowPainter.h"
37 #include "Text.h"
38 #include "TextClass.h"
39 #include "VSpace.h"
40
41 #include "insets/InsetText.h"
42
43 #include "mathed/MathMacroTemplate.h"
44
45 #include "frontends/FontMetrics.h"
46 #include "frontends/Painter.h"
47
48 #include "support/debug.h"
49 #include "support/lassert.h"
50
51 #include <cmath>
52
53 using namespace std;
54
55
56 namespace lyx {
57
58 using frontend::FontMetrics;
59
60 namespace {
61
62
63 int numberOfLabelHfills(Paragraph const & par, Row const & row)
64 {
65         pos_type last = row.endpos() - 1;
66         pos_type first = row.pos();
67
68         // hfill *DO* count at the beginning of paragraphs!
69         if (first) {
70                 while (first < last && par.isHfill(first))
71                         ++first;
72         }
73
74         last = min(last, par.beginOfBody());
75         int n = 0;
76         for (pos_type p = first; p < last; ++p) {
77                 if (par.isHfill(p))
78                         ++n;
79         }
80         return n;
81 }
82
83 // FIXME: this needs to be rewritten, probably by merging it into some
84 // code that, besides counting, sets the active status of the space
85 // inset in the row element.
86 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
87                    pos_type const body_pos)
88 {
89         int n = 0;
90         Row::const_iterator cit = row.begin();
91         Row::const_iterator const end = row.end();
92         for ( ; cit != end ; ++cit)
93                 if (cit->pos >= body_pos
94                     && cit->inset && pm.hfillExpansion(row, cit->pos))
95                         ++n;
96         return n;
97 }
98
99
100 }
101
102 /////////////////////////////////////////////////////////////////////
103 //
104 // TextMetrics
105 //
106 /////////////////////////////////////////////////////////////////////
107
108
109 TextMetrics::TextMetrics(BufferView * bv, Text * text)
110         : bv_(bv), text_(text)
111 {
112         LBUFERR(bv_);
113         max_width_ = bv_->workWidth();
114         dim_.wid = max_width_;
115         dim_.asc = 10;
116         dim_.des = 10;
117 }
118
119
120 bool TextMetrics::contains(pit_type pit) const
121 {
122         return par_metrics_.find(pit) != par_metrics_.end();
123 }
124
125
126 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
127 {
128         return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
129 }
130
131
132
133 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
134 {
135         ParMetricsCache::const_iterator it = par_metrics_.begin();
136         return make_pair(it->first, &it->second);
137 }
138
139
140 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
141 {
142         LBUFERR(!par_metrics_.empty());
143         ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
144         return make_pair(it->first, &it->second);
145 }
146
147
148 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
149 {
150         ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
151         if (pmc_it == par_metrics_.end()) {
152                 pmc_it = par_metrics_.insert(
153                         make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
154         }
155         if (pmc_it->second.rows().empty() && redo)
156                 redoParagraph(pit);
157         return pmc_it->second;
158 }
159
160
161 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
162 {
163         LBUFERR(mi.base.textwidth > 0);
164         max_width_ = mi.base.textwidth;
165         // backup old dimension.
166         Dimension const old_dim = dim_;
167         // reset dimension.
168         dim_ = Dimension();
169         dim_.wid = min_width;
170         pit_type const npar = text_->paragraphs().size();
171         if (npar > 1)
172                 // If there is more than one row, expand the text to
173                 // the full allowable width.
174                 dim_.wid = max_width_;
175
176         //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
177         //      << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
178
179         bool changed = false;
180         unsigned int h = 0;
181         for (pit_type pit = 0; pit != npar; ++pit) {
182                 changed |= redoParagraph(pit);
183                 ParagraphMetrics const & pm = par_metrics_[pit];
184                 h += pm.height();
185                 if (dim_.wid < pm.width())
186                         dim_.wid = pm.width();
187         }
188
189         dim_.asc = par_metrics_[0].ascent();
190         dim_.des = h - dim_.asc;
191         //lyxerr << "dim_.wid " << dim_.wid << endl;
192         //lyxerr << "dim_.asc " << dim_.asc << endl;
193         //lyxerr << "dim_.des " << dim_.des << endl;
194
195         changed |= dim_ != old_dim;
196         dim = dim_;
197         return changed;
198 }
199
200
201 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
202 {
203         return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
204 }
205
206
207 int TextMetrics::rightMargin(pit_type const pit) const
208 {
209         return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
210 }
211
212
213 void TextMetrics::applyOuterFont(Font & font) const
214 {
215         FontInfo lf(font_.fontInfo());
216         lf.reduce(bv_->buffer().params().getFont().fontInfo());
217         font.fontInfo().realize(lf);
218 }
219
220
221 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
222 {
223         LASSERT(pos >= 0, { static Font f; return f; });
224
225         ParagraphList const & pars = text_->paragraphs();
226         Paragraph const & par = pars[pit];
227         Layout const & layout = par.layout();
228         Buffer const & buffer = bv_->buffer();
229         // FIXME: broken?
230         BufferParams const & params = buffer.params();
231         pos_type const body_pos = par.beginOfBody();
232
233         // We specialize the 95% common case:
234         if (!par.getDepth()) {
235                 Font f = par.getFontSettings(params, pos);
236                 if (!text_->isMainText())
237                         applyOuterFont(f);
238                 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
239
240                 FontInfo const & lf = lab ? layout.labelfont : layout.font;
241                 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
242
243                 // In case the default family has been customized
244                 if (lf.family() == INHERIT_FAMILY)
245                         rlf.setFamily(params.getFont().fontInfo().family());
246                 f.fontInfo().realize(rlf);
247                 return f;
248         }
249
250         // The uncommon case need not be optimized as much
251         FontInfo const & layoutfont = pos < body_pos ?
252                 layout.labelfont : layout.font;
253
254         Font font = par.getFontSettings(params, pos);
255         font.fontInfo().realize(layoutfont);
256
257         if (!text_->isMainText())
258                 applyOuterFont(font);
259
260         // Realize against environment font information
261         // NOTE: the cast to pit_type should be removed when pit_type
262         // changes to a unsigned integer.
263         if (pit < pit_type(pars.size()))
264                 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
265
266         // Realize with the fonts of lesser depth.
267         font.fontInfo().realize(params.getFont().fontInfo());
268
269         return font;
270 }
271
272
273 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
274 {
275         if (!sl.text())
276                 return false;
277
278         int correction = 0;
279         if (boundary && sl.pos() > 0)
280                 correction = -1;
281
282         return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
283 }
284
285
286 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
287 {
288         // no RTL boundary at paragraph start
289         if (pos == 0)
290                 return false;
291
292         Font const & left_font = displayFont(pit, pos - 1);
293
294         return isRTLBoundary(pit, pos, left_font);
295 }
296
297
298 // isRTLBoundary returns false on a real end-of-line boundary,
299 // because otherwise the two boundary types get mixed up.
300 // This is the whole purpose of this being in TextMetrics.
301 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
302                 Font const & font) const
303 {
304         if (// no RTL boundary at paragraph start
305             pos == 0
306             // if the metrics have not been calculated, then we are not
307             // on screen and can safely ignore issues about boundaries.
308             || !contains(pit))
309                 return false;
310
311         ParagraphMetrics & pm = par_metrics_[pit];
312         // no RTL boundary in empty paragraph
313         if (pm.rows().empty())
314                 return false;
315
316         pos_type endpos = pm.getRow(pos - 1, false).endpos();
317         pos_type startpos = pm.getRow(pos, false).pos();
318         // no RTL boundary at line start:
319         // abc\n   -> toggle to RTL ->    abc\n     (and not:    abc\n|
320         // |                              |                               )
321         if (pos == startpos && pos == endpos) // start of cur row, end of prev row
322                 return false;
323
324         Paragraph const & par = text_->getPar(pit);
325         // no RTL boundary at line break:
326         // abc|\n    -> move right ->   abc\n       (and not:    abc\n|
327         // FED                          FED|                     FED     )
328         if (startpos == pos && endpos == pos && endpos != par.size()
329                 && (par.isNewline(pos - 1)
330                         || par.isEnvSeparator(pos - 1)
331                         || par.isLineSeparator(pos - 1)
332                         || par.isSeparator(pos - 1)))
333                 return false;
334
335         bool left = font.isVisibleRightToLeft();
336         bool right;
337         if (pos == par.size())
338                 right = par.isRTL(bv_->buffer().params());
339         else
340                 right = displayFont(pit, pos).isVisibleRightToLeft();
341
342         return left != right;
343 }
344
345
346 bool TextMetrics::redoParagraph(pit_type const pit)
347 {
348         Paragraph & par = text_->getPar(pit);
349         // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
350         // redoParagraph() recursively inside parMetrics.
351         Dimension old_dim = parMetrics(pit, false).dim();
352         ParagraphMetrics & pm = par_metrics_[pit];
353         pm.reset(par);
354
355         Buffer & buffer = bv_->buffer();
356         bool changed = false;
357
358         // Check whether there are InsetBibItems that need fixing
359         // FIXME: This check ought to be done somewhere else. It is the reason
360         // why text_ is not const. But then, where else to do it?
361         // Well, how can you end up with either (a) a biblio environment that
362         // has no InsetBibitem or (b) a biblio environment with more than one
363         // InsetBibitem? I think the answer is: when paragraphs are merged;
364         // when layout is set; when material is pasted.
365         if (par.brokenBiblio()) {
366                 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
367                 // In some cases, we do not know how to record undo
368                 if (&cur.inset() == &text_->inset())
369                         cur.recordUndo(pit, pit);
370
371                 int const moveCursor = par.fixBiblio(buffer);
372
373                 // Is it necessary to update the cursor?
374                 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
375                         if (moveCursor > 0)
376                                 cur.posForward();
377                         else if (moveCursor < 0 && cur.pos() >= -moveCursor)
378                                 cur.posBackward();
379                 }
380         }
381
382         // Optimisation: this is used in the next two loops
383         // so better to calculate that once here.
384         int const right_margin = rightMargin(pm);
385
386         // iterator pointing to paragraph to resolve macros
387         DocIterator parPos = text_->macrocontextPosition();
388         if (!parPos.empty())
389                 parPos.pit() = pit;
390         else {
391                 LYXERR(Debug::INFO, "MacroContext not initialised!"
392                         << " Going through the buffer again and hope"
393                         << " the context is better then.");
394                 // FIXME audit updateBuffer calls
395                 // This should not be here, but it is not clear yet where else it
396                 // should be.
397                 bv_->buffer().updateBuffer();
398                 parPos = text_->macrocontextPosition();
399                 LBUFERR(!parPos.empty());
400                 parPos.pit() = pit;
401         }
402
403         // redo insets
404         Font const bufferfont = buffer.params().getFont();
405         CoordCache::Insets & insetCache = bv_->coordCache().insets();
406         InsetList::const_iterator ii = par.insetList().begin();
407         InsetList::const_iterator iend = par.insetList().end();
408         for (; ii != iend; ++ii) {
409                 // FIXME Doesn't this HAVE to be non-empty?
410                 // position already initialized?
411                 if (!parPos.empty()) {
412                         parPos.pos() = ii->pos;
413
414                         // A macro template would normally not be visible
415                         // by itself. But the tex macro semantics allow
416                         // recursion, so we artifically take the context
417                         // after the macro template to simulate this.
418                         if (ii->inset->lyxCode() == MATHMACRO_CODE)
419                                 parPos.pos()++;
420                 }
421
422                 // do the metric calculation
423                 Dimension dim;
424                 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
425                         - right_margin;
426                 Font const & font = ii->inset->inheritFont() ?
427                         displayFont(pit, ii->pos) : bufferfont;
428                 MacroContext mc(&buffer, parPos);
429                 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
430                 ii->inset->metrics(mi, dim);
431                 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
432                         insetCache.add(ii->inset, dim);
433                         changed = true;
434                 }
435         }
436
437         par.setBeginOfBody();
438         pos_type first = 0;
439         size_t row_index = 0;
440         bool need_new_row = false;
441         // maximum pixel width of a row
442         do {
443                 if (row_index == pm.rows().size())
444                         pm.rows().push_back(Row());
445                 Row & row = pm.rows()[row_index];
446                 row.pit(pit);
447                 row.pos(first);
448                 row.pit(pit);
449                 need_new_row = breakRow(row, right_margin);
450                 setRowHeight(row);
451                 row.setChanged(false);
452                 if (row_index || row.endpos() < par.size()
453                     || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
454                         /* If there is more than one row or the row has been
455                          * broken by a display inset or a newline, expand the text
456                          * to the full allowable width. This setting here is
457                          * needed for the computeRowMetrics() below. In the case
458                          * of a display inset, we do nothing when inside a table
459                          * cell, because the tabular code is not prepared for
460                          * that, and it triggers when using a caption in a
461                          * longtable (see bugs #9945 and #9757).
462                          */
463                         if (dim_.wid < max_width_)
464                                 dim_.wid = max_width_;
465                 }
466                 int const max_row_width = max(dim_.wid, row.width());
467                 computeRowMetrics(row, max_row_width);
468                 first = row.endpos();
469                 ++row_index;
470
471                 pm.dim().wid = max(pm.dim().wid, row.width());
472                 pm.dim().des += row.height();
473         } while (first < par.size() || need_new_row);
474
475         // FIXME: It might be better to move this in another method
476         // specially tailored for the main text.
477         // Top and bottom margin of the document (only at top-level)
478         if (text_->isMainText()) {
479                 if (pit == 0) {
480                         pm.rows().front().dimension().asc += 20;
481                         pm.dim().des += 20;
482                 }
483                 ParagraphList const & pars = text_->paragraphs();
484                 if (pit + 1 == pit_type(pars.size())) {
485                         pm.rows().back().dimension().des += 20;
486                         pm.dim().des += 20;
487                 }
488         }
489
490         if (row_index < pm.rows().size())
491                 pm.rows().resize(row_index);
492
493         pm.dim().asc += pm.rows()[0].ascent();
494         pm.dim().des -= pm.rows()[0].ascent();
495
496         changed |= old_dim.height() != pm.dim().height();
497
498         return changed;
499 }
500
501
502 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
503 {
504         Layout const & layout = par.layout();
505
506         LyXAlignment align;
507         if (par.params().align() == LYX_ALIGN_LAYOUT)
508                 align = layout.align;
509         else
510                 align = par.params().align();
511
512         // handle alignment inside tabular cells
513         Inset const & owner = text_->inset();
514         bool forced_block = false;
515         switch (owner.contentAlignment()) {
516         case LYX_ALIGN_BLOCK:
517                 // In general block align is the default state, but here it is
518                 // an explicit choice. Therefore it should not be overridden
519                 // later.
520                 forced_block = true;
521                 // fall through
522         case LYX_ALIGN_CENTER:
523         case LYX_ALIGN_LEFT:
524         case LYX_ALIGN_RIGHT:
525                 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
526                         align = owner.contentAlignment();
527                 break;
528         default:
529                 // unchanged (use align)
530                 break;
531         }
532
533         // Display-style insets should always be on a centered row
534         if (Inset const * inset = par.getInset(row.pos())) {
535                 switch (inset->display()) {
536                 case Inset::AlignLeft:
537                         align = LYX_ALIGN_BLOCK;
538                         break;
539                 case Inset::AlignCenter:
540                         align = LYX_ALIGN_CENTER;
541                         break;
542                 case Inset::Inline:
543                         // unchanged (use align)
544                         break;
545                 case Inset::AlignRight:
546                         align = LYX_ALIGN_RIGHT;
547                         break;
548                 }
549         }
550
551         if (align == LYX_ALIGN_BLOCK) {
552                 // If this row has been broken abruptly by a display inset, or
553                 // it is the end of the paragraph, or the user requested we
554                 // not justify stuff, then don't stretch.
555                 // A forced block alignment can only be overridden the 'no
556                 // justification on screen' setting.
557                 if (((row.right_boundary() || row.endpos() == par.size())
558                      && !forced_block)
559                     || !bv_->buffer().params().justification)
560                         align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
561         }
562
563         return align;
564 }
565
566
567 void TextMetrics::computeRowMetrics(Row & row, int width) const
568 {
569         row.label_hfill = 0;
570         row.separator = 0;
571
572         Paragraph const & par = text_->getPar(row.pit());
573
574         int const w = width - row.right_margin - row.width();
575         // FIXME: put back this assertion when the crash on new doc is solved.
576         //LASSERT(w >= 0, /**/);
577
578         // is there a manual margin with a manual label
579         Layout const & layout = par.layout();
580
581         int nlh = 0;
582         if (layout.margintype == MARGIN_MANUAL
583             && layout.labeltype == LABEL_MANUAL) {
584                 /// We might have real hfills in the label part
585                 nlh = numberOfLabelHfills(par, row);
586
587                 // A manual label par (e.g. List) has an auto-hfill
588                 // between the label text and the body of the
589                 // paragraph too.
590                 // But we don't want to do this auto hfill if the par
591                 // is empty.
592                 if (!par.empty())
593                         ++nlh;
594
595                 if (nlh && !par.getLabelWidthString().empty())
596                         row.label_hfill = labelFill(row) / double(nlh);
597         }
598
599         // are there any hfills in the row?
600         ParagraphMetrics & pm = par_metrics_[row.pit()];
601         int nh = numberOfHfills(row, pm, par.beginOfBody());
602         int hfill = 0;
603         int hfill_rem = 0;
604
605         // We don't have to look at the alignment if the row is already
606         // larger then the permitted width as then we force the
607         // LEFT_ALIGN'edness!
608         if (int(row.width()) >= max_width_)
609                 return;
610
611         if (nh == 0) {
612                 // Common case : there is no hfill, and the alignment will be
613                 // meaningful
614                 switch (getAlign(par, row)) {
615                 case LYX_ALIGN_BLOCK: {
616                         int const ns = row.countSeparators();
617                         // If we have separators, then stretch the row
618                         if (ns) {
619                                 row.setSeparatorExtraWidth(double(w) / ns);
620                                 row.dimension().wid += w;
621                         } else if (text_->isRTL(par)) {
622                                 row.left_margin += w;
623                                 row.dimension().wid += w;
624                         }
625                         break;
626                 }
627                 case LYX_ALIGN_RIGHT:
628                         row.left_margin += w;
629                         row.dimension().wid += w;
630                         break;
631                 case LYX_ALIGN_CENTER:
632                         row.dimension().wid += w / 2;
633                         row.left_margin += w / 2;
634                         break;
635                 case LYX_ALIGN_LEFT:
636                 case LYX_ALIGN_NONE:
637                 case LYX_ALIGN_LAYOUT:
638                 case LYX_ALIGN_SPECIAL:
639                 case LYX_ALIGN_DECIMAL:
640                         break;
641                 }
642                 return;
643         }
644
645         hfill = w / nh;
646         hfill_rem = w % nh;
647         row.dimension().wid += w;
648         // Set size of hfill insets
649         pos_type const endpos = row.endpos();
650         pos_type body_pos = par.beginOfBody();
651         if (body_pos > 0
652             && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
653                 body_pos = 0;
654
655         CoordCache::Insets & insetCache = bv_->coordCache().insets();
656         Row::iterator cit = row.begin();
657         Row::iterator const cend = row.end();
658         for ( ; cit != cend; ++cit) {
659                 if (row.label_hfill && cit->endpos == body_pos
660                     && cit->type == Row::SPACE)
661                         cit->dim.wid -= int(row.label_hfill * (nlh - 1));
662                 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
663                         if (cit->pos >= body_pos) {
664                                 cit->dim.wid += hfill;
665                                 --nh;
666                                 if (nh == 0)
667                                         cit->dim.wid += hfill_rem;
668                         } else
669                                 cit->dim.wid += int(row.label_hfill);
670                         // Cache the inset dimension.
671                         insetCache.add(cit->inset, cit->dim);
672                 }
673         }
674 }
675
676
677 int TextMetrics::labelFill(Row const & row) const
678 {
679         Paragraph const & par = text_->getPar(row.pit());
680         LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
681
682         int w = 0;
683         Row::const_iterator cit = row.begin();
684         Row::const_iterator const end = row.end();
685         // iterate over elements before main body (except the last one,
686         // which is extra space).
687         while (cit!= end && cit->endpos < par.beginOfBody()) {
688                 w += cit->dim.wid;
689                 ++cit;
690         }
691
692         docstring const & label = par.params().labelWidthString();
693         if (label.empty())
694                 return 0;
695
696         FontMetrics const & fm
697                 = theFontMetrics(text_->labelFont(par));
698
699         return max(0, fm.width(label) - w);
700 }
701
702
703 #if 0
704 // Not used, see TextMetrics::breakRow
705 // this needs special handling - only newlines count as a break point
706 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
707 {
708         pos_type const end = par.size();
709
710         for (; i < end; ++i)
711                 if (par.isNewline(i))
712                         return i + 1;
713
714         return end;
715 }
716 #endif
717
718
719 int TextMetrics::labelEnd(pit_type const pit) const
720 {
721         // labelEnd is only needed if the layout fills a flushleft label.
722         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
723                 return 0;
724         // return the beginning of the body
725         return leftMargin(max_width_, pit);
726 }
727
728 namespace {
729
730 /**
731  * Calling Text::getFont is slow. While rebreaking we scan a
732  * paragraph from left to right calling getFont for every char.  This
733  * simple class address this problem by hidding an optimization trick
734  * (not mine btw -AB): the font is reused in the whole font span.  The
735  * class handles transparently the "hidden" (not part of the fontlist)
736  * label font (as getFont does).
737  **/
738 class FontIterator
739 {
740 public:
741         ///
742         FontIterator(TextMetrics const & tm,
743                 Paragraph const & par, pit_type pit, pos_type pos)
744                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
745                 font_(tm.displayFont(pit, pos)),
746                 endspan_(par.fontSpan(pos).last),
747                 bodypos_(par.beginOfBody())
748         {}
749
750         ///
751         Font const & operator*() const { return font_; }
752
753         ///
754         FontIterator & operator++()
755         {
756                 ++pos_;
757                 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
758                         font_ = tm_.displayFont(pit_, pos_);
759                         endspan_ = par_.fontSpan(pos_).last;
760                 }
761                 return *this;
762         }
763
764         ///
765         Font * operator->() { return &font_; }
766
767 private:
768         ///
769         TextMetrics const & tm_;
770         ///
771         Paragraph const & par_;
772         ///
773         pit_type pit_;
774         ///
775         pos_type pos_;
776         ///
777         Font font_;
778         ///
779         pos_type endspan_;
780         ///
781         pos_type bodypos_;
782 };
783
784 } // anon namespace
785
786 /** This is the function where the hard work is done. The code here is
787  * very sensitive to small changes :) Note that part of the
788  * intelligence is also in Row::shortenIfNeeded.
789  */
790 bool TextMetrics::breakRow(Row & row, int const right_margin) const
791 {
792         Paragraph const & par = text_->getPar(row.pit());
793         pos_type const end = par.size();
794         pos_type const pos = row.pos();
795         pos_type const body_pos = par.beginOfBody();
796         bool const is_rtl = text_->isRTL(par);
797         bool need_new_row = false;
798
799         row.clear();
800         row.left_margin = leftMargin(max_width_, row.pit(), pos);
801         row.right_margin = right_margin;
802         if (is_rtl)
803                 swap(row.left_margin, row.right_margin);
804         // Remember that the row width takes into account the left_margin
805         // but not the right_margin.
806         row.dimension().wid = row.left_margin;
807         // the width available for the row.
808         int const width = max_width_ - row.right_margin;
809
810         if (pos >= end || row.width() > width) {
811                 row.endpos(end);
812                 return need_new_row;
813         }
814
815 #if 0
816         //FIXME: As long as leftMargin() is not correctly implemented for
817         // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
818         // Otherwise, long rows will be painted off the screen.
819         if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
820                 return addressBreakPoint(pos, par);
821 #endif
822
823         // check for possible inline completion
824         DocIterator const & ic_it = bv_->inlineCompletionPos();
825         pos_type ic_pos = -1;
826         if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
827                 ic_pos = ic_it.pos();
828
829         // Now we iterate through until we reach the right margin
830         // or the end of the par, then build a representation of the row.
831         pos_type i = pos;
832         FontIterator fi = FontIterator(*this, par, row.pit(), pos);
833         do {
834                 // this can happen for an empty row after a newline
835                 if (i >= end)
836                         break;
837                 char_type c = par.getChar(i);
838                 // The most special cases are handled first.
839                 if (par.isInset(i)) {
840                         Inset const * ins = par.getInset(i);
841                         Dimension dim = bv_->coordCache().insets().dim(ins);
842                         row.add(i, ins, dim, *fi, par.lookupChange(i));
843                 } else if (c == ' ' && i + 1 == body_pos) {
844                         // There is a space at i, but it should not be
845                         // added as a separator, because it is just
846                         // before body_pos. Instead, insert some spacing to
847                         // align text
848                         FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
849                         // this is needed to make sure that the row width is correct
850                         row.finalizeLast();
851                         int const add = max(fm.width(par.layout().labelsep),
852                                             labelEnd(row.pit()) - row.width());
853                         row.addSpace(i, add, *fi, par.lookupChange(i));
854                 } else if (c == '\t')
855                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
856                                      *fi, par.lookupChange(i));
857                 else {
858                         // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
859                         // see also Paragraph::getUChar.
860                         if (fi->language()->lang() == "hebrew") {
861                                 if (c == '(')
862                                         c = ')';
863                                 else if (c == ')')
864                                         c = '(';
865                         }
866                         row.add(i, c, *fi, par.lookupChange(i));
867                 }
868
869                 // add inline completion width
870                 // draw logically behind the previous character
871                 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
872                         docstring const comp = bv_->inlineCompletion();
873                         size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
874                         Font f = *fi;
875
876                         if (uniqueTo > 0) {
877                                 f.fontInfo().setColor(Color_inlinecompletion);
878                                 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
879                         }
880                         f.fontInfo().setColor(Color_nonunique_inlinecompletion);
881                         row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
882                 }
883
884                 // Handle some situations that abruptly terminate the row
885                 // - A newline inset
886                 // - Before a display inset
887                 // - After a display inset
888                 Inset const * inset = 0;
889                 if (par.isNewline(i) || par.isEnvSeparator(i)
890                     || (i + 1 < end && (inset = par.getInset(i + 1))
891                         && inset->display())
892                     || (!row.empty() && row.back().inset
893                         && row.back().inset->display())) {
894                         row.right_boundary(true);
895                         need_new_row = par.isNewline(i);
896                         ++i;
897                         break;
898                 }
899
900                 ++i;
901                 ++fi;
902         } while (i < end && row.width() <= width);
903         row.finalizeLast();
904         row.endpos(i);
905
906         // End of paragraph marker
907         ParagraphList const & pars = text_->paragraphs();
908         if (lyxrc.paragraph_markers && !need_new_row
909             && i == end && size_type(row.pit() + 1) < pars.size()) {
910                 // add a virtual element for the end-of-paragraph
911                 // marker; it is shown on screen, but does not exist
912                 // in the paragraph.
913                 Font f(text_->layoutFont(row.pit()));
914                 f.fontInfo().setColor(Color_paragraphmarker);
915                 BufferParams const & bparams
916                         = text_->inset().buffer().params();
917                 f.setLanguage(par.getParLanguage(bparams));
918                 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
919         }
920
921         // if the row is too large, try to cut at last separator. In case
922         // of success, reset indication that the row was broken abruptly.
923         if (row.shortenIfNeeded(body_pos, width))
924                 row.right_boundary(false);
925
926         // make sure that the RTL elements are in reverse ordering
927         row.reverseRTL(is_rtl);
928         //LYXERR0("breakrow: row is " << row);
929
930         return need_new_row;
931 }
932
933
934 void TextMetrics::setRowHeight(Row & row, bool topBottomSpace) const
935 {
936         Paragraph const & par = text_->getPar(row.pit());
937         Layout const & layout = par.layout();
938         double const spacing_val = layout.spacing.getValue()
939                 * text_->spacing(par);
940
941         // Initial value for ascent (useful if row is empty).
942         Font const font = displayFont(row.pit(), row.pos());
943         FontMetrics const & fm = theFontMetrics(font);
944         int maxasc = int(fm.maxAscent() * spacing_val);
945         int maxdes = int(fm.maxDescent() * spacing_val);
946
947         // Find the ascent/descent of the row contents
948         Row::const_iterator cit = row.begin();
949         Row::const_iterator cend = row.end();
950         for ( ; cit != cend; ++cit) {
951                 if (cit->inset) {
952                         maxasc = max(maxasc, cit->dim.ascent());
953                         maxdes = max(maxdes, cit->dim.descent());
954                 } else {
955                         FontMetrics const & fm = theFontMetrics(cit->font);
956                         maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
957                         maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
958                 }
959         }
960
961         // This is nicer with box insets
962         ++maxasc;
963         ++maxdes;
964
965         // Now use the layout information.
966         double layoutasc = 0;
967         double layoutdesc = 0;
968         int labeladdon = 0;
969         ParagraphList const & pars = text_->paragraphs();
970         Inset const & inset = text_->inset();
971         double const dh = defaultRowHeight();
972
973         // is it a top line?
974         if (row.pos() == 0 && topBottomSpace) {
975                 BufferParams const & bufparams = bv_->buffer().params();
976                 // some parskips VERY EASY IMPLEMENTATION
977                 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
978                     && !inset.getLayout().parbreakIsNewline()
979                     && !par.layout().parbreak_is_newline
980                     && row.pit() > 0
981                     && ((layout.isParagraph() && par.getDepth() == 0)
982                             || (pars[row.pit() - 1].layout().isParagraph()
983                                     && pars[row.pit() - 1].getDepth() == 0))) {
984                         maxasc += bufparams.getDefSkip().inPixels(*bv_);
985                 }
986
987                 if (par.params().startOfAppendix())
988                         maxasc += int(3 * dh);
989
990                 // special code for the top label
991                 if (layout.labelIsAbove()
992                     && (!layout.isParagraphGroup() || text_->isFirstInSequence(row.pit()))
993                     && !par.labelString().empty()) {
994                         FontInfo labelfont = text_->labelFont(par);
995                         FontMetrics const & lfm = theFontMetrics(labelfont);
996                         labeladdon = int(
997                                   lfm.maxHeight()
998                                         * layout.spacing.getValue()
999                                         * text_->spacing(par)
1000                                 + (layout.topsep + layout.labelbottomsep) * dh);
1001                 }
1002
1003                 // Add the layout spaces, for example before and after
1004                 // a section, or between the items of a itemize or enumerate
1005                 // environment.
1006
1007                 pit_type prev = text_->depthHook(row.pit(), par.getDepth());
1008                 Paragraph const & prevpar = pars[prev];
1009                 if (prev != row.pit()
1010                     && prevpar.layout() == layout
1011                     && prevpar.getDepth() == par.getDepth()
1012                     && prevpar.getLabelWidthString()
1013                                         == par.getLabelWidthString()) {
1014                         layoutasc = layout.itemsep * dh;
1015                 } else if (row.pit() != 0 || row.pos() != 0) {
1016                         if (layout.topsep > 0)
1017                                 layoutasc = layout.topsep * dh;
1018                 }
1019
1020                 prev = text_->outerHook(row.pit());
1021                 if (prev != pit_type(pars.size())) {
1022                         maxasc += int(pars[prev].layout().parsep * dh);
1023                 } else if (row.pit() != 0) {
1024                         Paragraph const & prevpar = pars[row.pit() - 1];
1025                         if (prevpar.getDepth() != 0 ||
1026                                         prevpar.layout() == layout) {
1027                                 maxasc += int(layout.parsep * dh);
1028                         }
1029                 }
1030         }
1031
1032         // is it a bottom line?
1033         if (row.endpos() >= par.size() && topBottomSpace) {
1034                 // add the layout spaces, for example before and after
1035                 // a section, or between the items of a itemize or enumerate
1036                 // environment
1037                 pit_type nextpit = row.pit() + 1;
1038                 if (nextpit != pit_type(pars.size())) {
1039                         pit_type cpit = row.pit();
1040
1041                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1042                                 double usual = pars[cpit].layout().bottomsep * dh;
1043                                 double unusual = 0;
1044                                 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1045                                 if (pars[cpit].layout() != pars[nextpit].layout()
1046                                     || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1047                                         unusual = pars[cpit].layout().bottomsep * dh;
1048                                 layoutdesc = max(unusual, usual);
1049                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1050                                 if (pars[cpit].layout() != pars[nextpit].layout()
1051                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1052                                         layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1053                         }
1054                 }
1055         }
1056
1057         // incalculate the layout spaces
1058         maxasc += int(layoutasc  * 2 / (2 + pars[row.pit()].getDepth()));
1059         maxdes += int(layoutdesc * 2 / (2 + pars[row.pit()].getDepth()));
1060
1061         row.dimension().asc = maxasc + labeladdon;
1062         row.dimension().des = maxdes;
1063 }
1064
1065
1066 // x is an absolute screen coord
1067 // returns the column near the specified x-coordinate of the row
1068 // x is set to the real beginning of this column
1069 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1070                                   bool & boundary) const
1071 {
1072         //LYXERR0("getPosNearX(" << x << ") row=" << row);
1073         /// For the main Text, it is possible that this pit is not
1074         /// yet in the CoordCache when moving cursor up.
1075         /// x Paragraph coordinate is always 0 for main text anyway.
1076         int const xo = origin_.x_;
1077         x -= xo;
1078
1079         // Adapt to cursor row scroll offset if applicable.
1080         int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1081         x += offset;
1082
1083         pos_type pos = row.pos();
1084         boundary = false;
1085         if (row.empty())
1086                 x = row.left_margin;
1087         else if (x <= row.left_margin) {
1088                 pos = row.front().left_pos();
1089                 x = row.left_margin;
1090         } else if (x >= row.width()) {
1091                 pos = row.back().right_pos();
1092                 x = row.width();
1093         } else {
1094                 double w = row.left_margin;
1095                 Row::const_iterator cit = row.begin();
1096                 Row::const_iterator cend = row.end();
1097                 for ( ; cit != cend; ++cit) {
1098                         if (w <= x &&  w + cit->full_width() > x) {
1099                                 int x_offset = int(x - w);
1100                                 pos = cit->x2pos(x_offset);
1101                                 x = int(x_offset + w);
1102                                 break;
1103                         }
1104                         w += cit->full_width();
1105                 }
1106                 if (cit == row.end()) {
1107                         pos = row.back().right_pos();
1108                         x = row.width();
1109                 }
1110                 /** This tests for the case where the cursor is placed
1111                  * just before a font direction change. See comment on
1112                  * the boundary_ member in DocIterator.h to understand
1113                  * how boundary helps here.
1114                  */
1115                 else if (pos == cit->endpos
1116                          && cit + 1 != row.end()
1117                          && cit->isRTL() != (cit + 1)->isRTL())
1118                         boundary = true;
1119         }
1120
1121         /** This tests for the case where the cursor is set at the end
1122          * of a row which has been broken due something else than a
1123          * separator (a display inset or a forced breaking of the
1124          * row). We know that there is a separator when the end of the
1125          * row is larger than the end of its last element.
1126          */
1127         if (!row.empty() && pos == row.back().endpos
1128             && row.back().endpos == row.endpos()) {
1129                 Inset const * inset = row.back().inset;
1130                 if (inset && (inset->lyxCode() == NEWLINE_CODE
1131                               || inset->lyxCode() == SEPARATOR_CODE))
1132                         pos = row.back().pos;
1133                 else
1134                         boundary = row.right_boundary();
1135         }
1136
1137         x += xo - offset;
1138         //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1139
1140         return pos;
1141 }
1142
1143
1144 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1145 {
1146         // We play safe and use parMetrics(pit) to make sure the
1147         // ParagraphMetrics will be redone and OK to use if needed.
1148         // Otherwise we would use an empty ParagraphMetrics in
1149         // upDownInText() while in selection mode.
1150         ParagraphMetrics const & pm = parMetrics(pit);
1151
1152         LBUFERR(row < int(pm.rows().size()));
1153         bool bound = false;
1154         Row const & r = pm.rows()[row];
1155         return getPosNearX(r, x, bound);
1156 }
1157
1158
1159 void TextMetrics::newParMetricsDown()
1160 {
1161         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1162         pit_type const pit = last.first + 1;
1163         if (pit == int(text_->paragraphs().size()))
1164                 return;
1165
1166         // do it and update its position.
1167         redoParagraph(pit);
1168         par_metrics_[pit].setPosition(last.second.position()
1169                 + last.second.descent() + par_metrics_[pit].ascent());
1170 }
1171
1172
1173 void TextMetrics::newParMetricsUp()
1174 {
1175         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1176         if (first.first == 0)
1177                 return;
1178
1179         pit_type const pit = first.first - 1;
1180         // do it and update its position.
1181         redoParagraph(pit);
1182         par_metrics_[pit].setPosition(first.second.position()
1183                 - first.second.ascent() - par_metrics_[pit].descent());
1184 }
1185
1186 // y is screen coordinate
1187 pit_type TextMetrics::getPitNearY(int y)
1188 {
1189         LASSERT(!text_->paragraphs().empty(), return -1);
1190         LASSERT(!par_metrics_.empty(), return -1);
1191         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1192
1193         // look for highest numbered paragraph with y coordinate less than given y
1194         pit_type pit = -1;
1195         int yy = -1;
1196         ParMetricsCache::const_iterator it = par_metrics_.begin();
1197         ParMetricsCache::const_iterator et = par_metrics_.end();
1198         ParMetricsCache::const_iterator last = et;
1199         --last;
1200
1201         ParagraphMetrics const & pm = it->second;
1202
1203         if (y < it->second.position() - int(pm.ascent())) {
1204                 // We are looking for a position that is before the first paragraph in
1205                 // the cache (which is in priciple off-screen, that is before the
1206                 // visible part.
1207                 if (it->first == 0)
1208                         // We are already at the first paragraph in the inset.
1209                         return 0;
1210                 // OK, this is the paragraph we are looking for.
1211                 pit = it->first - 1;
1212                 newParMetricsUp();
1213                 return pit;
1214         }
1215
1216         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1217
1218         if (y >= last->second.position() + int(pm_last.descent())) {
1219                 // We are looking for a position that is after the last paragraph in
1220                 // the cache (which is in priciple off-screen), that is before the
1221                 // visible part.
1222                 pit = last->first + 1;
1223                 if (pit == int(text_->paragraphs().size()))
1224                         //  We are already at the last paragraph in the inset.
1225                         return last->first;
1226                 // OK, this is the paragraph we are looking for.
1227                 newParMetricsDown();
1228                 return pit;
1229         }
1230
1231         for (; it != et; ++it) {
1232                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1233                         << " y: " << it->second.position());
1234
1235                 ParagraphMetrics const & pm = par_metrics_[it->first];
1236
1237                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1238                         pit = it->first;
1239                         yy = it->second.position();
1240                 }
1241         }
1242
1243         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1244
1245         return pit;
1246 }
1247
1248
1249 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1250         bool assert_in_view, bool up)
1251 {
1252         ParagraphMetrics const & pm = par_metrics_[pit];
1253
1254         int yy = pm.position() - pm.ascent();
1255         LBUFERR(!pm.rows().empty());
1256         RowList::const_iterator rit = pm.rows().begin();
1257         RowList::const_iterator rlast = pm.rows().end();
1258         --rlast;
1259         for (; rit != rlast; yy += rit->height(), ++rit)
1260                 if (yy + rit->height() > y)
1261                         break;
1262
1263         if (assert_in_view) {
1264                 if (!up && yy + rit->height() > y) {
1265                         if (rit != pm.rows().begin()) {
1266                                 y = yy;
1267                                 --rit;
1268                         } else if (pit != 0) {
1269                                 --pit;
1270                                 newParMetricsUp();
1271                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1272                                 rit = pm2.rows().end();
1273                                 --rit;
1274                                 y = yy;
1275                         }
1276                 } else if (up && yy != y) {
1277                         if (rit != rlast) {
1278                                 y = yy + rit->height();
1279                                 ++rit;
1280                         } else if (pit < int(text_->paragraphs().size()) - 1) {
1281                                 ++pit;
1282                                 newParMetricsDown();
1283                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1284                                 rit = pm2.rows().begin();
1285                                 y = pm2.position();
1286                         }
1287                 }
1288         }
1289         return *rit;
1290 }
1291
1292
1293 // x,y are absolute screen coordinates
1294 // sets cursor recursively descending into nested editable insets
1295 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1296         bool assert_in_view, bool up)
1297 {
1298         if (lyxerr.debugging(Debug::WORKAREA)) {
1299                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1300                 cur.bv().coordCache().dump();
1301         }
1302         pit_type pit = getPitNearY(y);
1303         LASSERT(pit != -1, return 0);
1304
1305         int yy = y; // is modified by getPitAndRowNearY
1306         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1307
1308         cur.pit() = pit;
1309
1310         // Do we cover an inset?
1311         InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1312
1313         if (!it) {
1314                 // No inset, set position in the text
1315                 bool bound = false; // is modified by getPosNearX
1316                 int xx = x; // is modified by getPosNearX
1317                 cur.pos() = getPosNearX(row, xx, bound);
1318                 cur.boundary(bound);
1319                 cur.setCurrentFont();
1320                 cur.setTargetX(xx);
1321                 return 0;
1322         }
1323
1324         Inset * inset = it->inset;
1325         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1326
1327         // Set position in front of inset
1328         cur.pos() = it->pos;
1329         cur.boundary(false);
1330         cur.setTargetX(x);
1331
1332         // Try to descend recursively inside the inset.
1333         Inset * edited = inset->editXY(cur, x, yy);
1334         if (edited == inset && cur.pos() == it->pos) {
1335                 // non-editable inset, set cursor after the inset if x is
1336                 // nearer to that position (bug 9628)
1337                 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1338                 Dimension const & dim = insetCache.dim(inset);
1339                 Point p = insetCache.xy(inset);
1340                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1341                 if (is_rtl) {
1342                         // "in front of" == "right of"
1343                         if (abs(p.x_ - x) < abs(p.x_ + dim.wid - x))
1344                                 cur.posForward();
1345                 } else {
1346                         // "in front of" == "left of"
1347                         if (abs(p.x_ + dim.wid - x) < abs(p.x_ - x))
1348                                 cur.posForward();
1349                 }
1350         }
1351
1352         if (cur.top().text() == text_)
1353                 cur.setCurrentFont();
1354         return edited;
1355 }
1356
1357
1358 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1359 {
1360         LASSERT(text_ == cur.text(), return);
1361         pit_type const pit = getPitNearY(y);
1362         LASSERT(pit != -1, return);
1363
1364         ParagraphMetrics const & pm = par_metrics_[pit];
1365
1366         int yy = pm.position() - pm.ascent();
1367         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1368                 " pit: " << pit << " yy: " << yy);
1369
1370         int r = 0;
1371         LBUFERR(pm.rows().size());
1372         for (; r < int(pm.rows().size()) - 1; ++r) {
1373                 Row const & row = pm.rows()[r];
1374                 if (int(yy + row.height()) > y)
1375                         break;
1376                 yy += row.height();
1377         }
1378
1379         Row const & row = pm.rows()[r];
1380
1381         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1382
1383         bool bound = false;
1384         int xx = x;
1385         pos_type const pos = getPosNearX(row, xx, bound);
1386
1387         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1388
1389         text_->setCursor(cur, pit, pos, true, bound);
1390         // remember new position.
1391         cur.setTargetX();
1392 }
1393
1394
1395 //takes screen x,y coordinates
1396 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1397 {
1398         Paragraph const & par = text_->paragraphs()[pit];
1399         CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1400
1401         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1402
1403         InsetList::const_iterator iit = par.insetList().begin();
1404         InsetList::const_iterator iend = par.insetList().end();
1405         for (; iit != iend; ++iit) {
1406                 Inset * inset = iit->inset;
1407
1408                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1409
1410                 if (!insetCache.has(inset)) {
1411                         LYXERR(Debug::DEBUG, "inset has no cached position");
1412                         return 0;
1413                 }
1414
1415                 Dimension const & dim = insetCache.dim(inset);
1416                 Point p = insetCache.xy(inset);
1417
1418                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1419                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1420
1421                 if (x >= p.x_ && x <= p.x_ + dim.wid
1422                     && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1423                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1424                         return const_cast<InsetList::InsetTable *>(&(*iit));
1425                 }
1426         }
1427
1428         LYXERR(Debug::DEBUG, "No inset hit. ");
1429         return 0;
1430 }
1431
1432
1433 //takes screen x,y coordinates
1434 Inset * TextMetrics::checkInsetHit(int x, int y)
1435 {
1436         pit_type const pit = getPitNearY(y);
1437         LASSERT(pit != -1, return 0);
1438         InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1439
1440         if (!it)
1441                 return 0;
1442
1443         return it->inset;
1444 }
1445
1446
1447 Row::const_iterator const
1448 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1449                             bool const boundary, double & x) const
1450 {
1451         /**
1452          * When boundary is true, position i is in the row element (pos, endpos)
1453          * if
1454          *    pos < i <= endpos
1455          * whereas, when boundary is false, the test is
1456          *    pos <= i < endpos
1457          * The correction below allows to handle both cases.
1458         */
1459         int const boundary_corr = (boundary && pos) ? -1 : 0;
1460
1461         x = row.left_margin;
1462
1463         /** Early return in trivial cases
1464          * 1) the row is empty
1465          * 2) the position is the left-most position of the row; there
1466          * is a quirk here however: if the first element is virtual
1467          * (end-of-par marker for example), then we have to look
1468          * closer
1469          */
1470         if (row.empty()
1471             || (pos == row.begin()->left_pos() && !boundary
1472                         && !row.begin()->isVirtual()))
1473                 return row.begin();
1474
1475         Row::const_iterator cit = row.begin();
1476         for ( ; cit != row.end() ; ++cit) {
1477                 /** Look whether the cursor is inside the element's
1478                  * span. Note that it is necessary to take the
1479                  * boundary into account, and to accept virtual
1480                  * elements, which have pos == endpos.
1481                  */
1482                 if (pos + boundary_corr >= cit->pos
1483                     && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1484                                 x += cit->pos2x(pos);
1485                                 break;
1486                 }
1487                 x += cit->full_width();
1488         }
1489
1490         if (cit == row.end())
1491                 --cit;
1492
1493         return cit;
1494 }
1495
1496
1497 int TextMetrics::cursorX(CursorSlice const & sl,
1498                 bool boundary) const
1499 {
1500         LASSERT(sl.text() == text_, return 0);
1501
1502         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1503         if (pm.rows().empty())
1504                 return 0;
1505         Row const & row = pm.getRow(sl.pos(), boundary);
1506         pos_type const pos = sl.pos();
1507
1508         double x = 0;
1509         findRowElement(row, pos, boundary, x);
1510         return int(x);
1511
1512 }
1513
1514
1515 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1516 {
1517         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1518         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1519         if (pm.rows().empty())
1520                 return 0;
1521
1522         int h = 0;
1523         h -= par_metrics_[0].rows()[0].ascent();
1524         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1525                 h += par_metrics_[pit].height();
1526         }
1527         int pos = sl.pos();
1528         if (pos && boundary)
1529                 --pos;
1530         size_t const rend = pm.pos2row(pos);
1531         for (size_t rit = 0; rit != rend; ++rit)
1532                 h += pm.rows()[rit].height();
1533         h += pm.rows()[rend].ascent();
1534         return h;
1535 }
1536
1537
1538 // the cursor set functions have a special mechanism. When they
1539 // realize you left an empty paragraph, they will delete it.
1540
1541 bool TextMetrics::cursorHome(Cursor & cur)
1542 {
1543         LASSERT(text_ == cur.text(), return false);
1544         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1545         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1546         return text_->setCursor(cur, cur.pit(), row.pos());
1547 }
1548
1549
1550 bool TextMetrics::cursorEnd(Cursor & cur)
1551 {
1552         LASSERT(text_ == cur.text(), return false);
1553         // if not on the last row of the par, put the cursor before
1554         // the final space exept if I have a spanning inset or one string
1555         // is so long that we force a break.
1556         pos_type end = cur.textRow().endpos();
1557         if (end == 0)
1558                 // empty text, end-1 is no valid position
1559                 return false;
1560         bool boundary = false;
1561         if (end != cur.lastpos()) {
1562                 if (!cur.paragraph().isLineSeparator(end-1)
1563                     && !cur.paragraph().isNewline(end-1)
1564                     && !cur.paragraph().isEnvSeparator(end-1))
1565                         boundary = true;
1566                 else
1567                         --end;
1568         } else if (cur.paragraph().isEnvSeparator(end-1))
1569                 --end;
1570         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1571 }
1572
1573
1574 void TextMetrics::deleteLineForward(Cursor & cur)
1575 {
1576         LASSERT(text_ == cur.text(), return);
1577         if (cur.lastpos() == 0) {
1578                 // Paragraph is empty, so we just go forward
1579                 text_->cursorForward(cur);
1580         } else {
1581                 cur.resetAnchor();
1582                 cur.selection(true); // to avoid deletion
1583                 cursorEnd(cur);
1584                 cur.setSelection();
1585                 // What is this test for ??? (JMarc)
1586                 if (!cur.selection())
1587                         text_->deleteWordForward(cur);
1588                 else
1589                         cap::cutSelection(cur, true, false);
1590                 cur.checkBufferStructure();
1591         }
1592 }
1593
1594
1595 bool TextMetrics::isLastRow(Row const & row) const
1596 {
1597         ParagraphList const & pars = text_->paragraphs();
1598         return row.endpos() >= pars[row.pit()].size()
1599                 && row.pit() + 1 == pit_type(pars.size());
1600 }
1601
1602
1603 bool TextMetrics::isFirstRow(Row const & row) const
1604 {
1605         return row.pos() == 0 && row.pit() == 0;
1606 }
1607
1608
1609 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1610 {
1611         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1612 }
1613
1614
1615 int TextMetrics::leftMargin(int max_width,
1616                 pit_type const pit, pos_type const pos) const
1617 {
1618         ParagraphList const & pars = text_->paragraphs();
1619
1620         LASSERT(pit >= 0, return 0);
1621         LASSERT(pit < int(pars.size()), return 0);
1622         Paragraph const & par = pars[pit];
1623         LASSERT(pos >= 0, return 0);
1624         LASSERT(pos <= par.size(), return 0);
1625         Buffer const & buffer = bv_->buffer();
1626         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1627         DocumentClass const & tclass = buffer.params().documentClass();
1628         Layout const & layout = par.layout();
1629         FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1630
1631         docstring parindent = layout.parindent;
1632
1633         int l_margin = 0;
1634
1635         if (text_->isMainText())
1636                 l_margin += bv_->leftMargin();
1637
1638         l_margin += bfm.signedWidth(tclass.leftmargin());
1639
1640         int depth = par.getDepth();
1641         if (depth != 0) {
1642                 // find the next level paragraph
1643                 pit_type newpar = text_->outerHook(pit);
1644                 if (newpar != pit_type(pars.size())) {
1645                         if (pars[newpar].layout().isEnvironment()) {
1646                                 int nestmargin = depth * nestMargin();
1647                                 if (text_->isMainText())
1648                                         nestmargin += changebarMargin();
1649                                 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1650                                 // Remove the parindent that has been added
1651                                 // if the paragraph was empty.
1652                                 if (pars[newpar].empty() &&
1653                                     buffer.params().paragraph_separation ==
1654                                     BufferParams::ParagraphIndentSeparation) {
1655                                         docstring pi = pars[newpar].layout().parindent;
1656                                         l_margin -= bfm.signedWidth(pi);
1657                                 }
1658                         }
1659                         if (tclass.isDefaultLayout(par.layout())
1660                             || tclass.isPlainLayout(par.layout())) {
1661                                 if (pars[newpar].params().noindent())
1662                                         parindent.erase();
1663                                 else
1664                                         parindent = pars[newpar].layout().parindent;
1665                         }
1666                 }
1667         }
1668
1669         // This happens after sections or environments in standard classes.
1670         // We have to check the previous layout at same depth.
1671         if (buffer.params().paragraph_separation ==
1672                         BufferParams::ParagraphSkipSeparation)
1673                 parindent.erase();
1674         else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1675                 pit_type prev = text_->depthHook(pit, par.getDepth());
1676                 if (par.layout() == pars[prev].layout()) {
1677                         if (prev != pit - 1
1678                             && pars[pit - 1].layout().nextnoindent)
1679                                 parindent.erase();
1680                 } else if (pars[prev].layout().nextnoindent)
1681                         parindent.erase();
1682         }
1683
1684         FontInfo const labelfont = text_->labelFont(par);
1685         FontMetrics const & lfm = theFontMetrics(labelfont);
1686
1687         switch (layout.margintype) {
1688         case MARGIN_DYNAMIC:
1689                 if (!layout.leftmargin.empty()) {
1690                         l_margin += bfm.signedWidth(layout.leftmargin);
1691                 }
1692                 if (!par.labelString().empty()) {
1693                         l_margin += lfm.signedWidth(layout.labelindent);
1694                         l_margin += lfm.width(par.labelString());
1695                         l_margin += lfm.width(layout.labelsep);
1696                 }
1697                 break;
1698
1699         case MARGIN_MANUAL: {
1700                 l_margin += lfm.signedWidth(layout.labelindent);
1701                 // The width of an empty par, even with manual label, should be 0
1702                 if (!par.empty() && pos >= par.beginOfBody()) {
1703                         if (!par.getLabelWidthString().empty()) {
1704                                 docstring labstr = par.getLabelWidthString();
1705                                 l_margin += lfm.width(labstr);
1706                                 l_margin += lfm.width(layout.labelsep);
1707                         }
1708                 }
1709                 break;
1710         }
1711
1712         case MARGIN_STATIC: {
1713                 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1714                              / (par.getDepth() + 4);
1715                 break;
1716         }
1717
1718         case MARGIN_FIRST_DYNAMIC:
1719                 if (layout.labeltype == LABEL_MANUAL) {
1720                         // if we are at position 0, we are never in the body
1721                         if (pos > 0 && pos >= par.beginOfBody())
1722                                 l_margin += lfm.signedWidth(layout.leftmargin);
1723                         else
1724                                 l_margin += lfm.signedWidth(layout.labelindent);
1725                 } else if (pos != 0
1726                            // Special case to fix problems with
1727                            // theorems (JMarc)
1728                            || (layout.labeltype == LABEL_STATIC
1729                                && layout.latextype == LATEX_ENVIRONMENT
1730                                && !text_->isFirstInSequence(pit))) {
1731                         l_margin += lfm.signedWidth(layout.leftmargin);
1732                 } else if (!layout.labelIsAbove()) {
1733                         l_margin += lfm.signedWidth(layout.labelindent);
1734                         l_margin += lfm.width(layout.labelsep);
1735                         l_margin += lfm.width(par.labelString());
1736                 }
1737                 break;
1738
1739         case MARGIN_RIGHT_ADDRESS_BOX: {
1740 #if 0
1741                 // The left margin depends on the widest row in this paragraph.
1742                 // This code is wrong because it depends on the rows, but at the
1743                 // same time this function is used in redoParagraph to construct
1744                 // the rows.
1745                 ParagraphMetrics const & pm = par_metrics_[pit];
1746                 RowList::const_iterator rit = pm.rows().begin();
1747                 RowList::const_iterator end = pm.rows().end();
1748                 int minfill = max_width;
1749                 for ( ; rit != end; ++rit)
1750                         if (rit->fill() < minfill)
1751                                 minfill = rit->fill();
1752                 l_margin += bfm.signedWidth(layout.leftmargin);
1753                 l_margin += minfill;
1754 #endif
1755                 // also wrong, but much shorter.
1756                 l_margin += max_width / 2;
1757                 break;
1758         }
1759         }
1760
1761         if (!par.params().leftIndent().zero())
1762                 l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
1763
1764         LyXAlignment align;
1765
1766         if (par.params().align() == LYX_ALIGN_LAYOUT)
1767                 align = layout.align;
1768         else
1769                 align = par.params().align();
1770
1771         // set the correct parindent
1772         if (pos == 0
1773             && (layout.labeltype == LABEL_NO_LABEL
1774                 || layout.labeltype == LABEL_ABOVE
1775                 || layout.labeltype == LABEL_CENTERED
1776                 || (layout.labeltype == LABEL_STATIC
1777                     && layout.latextype == LATEX_ENVIRONMENT
1778                     && !text_->isFirstInSequence(pit)))
1779             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1780             && !par.params().noindent()
1781             // in some insets, paragraphs are never indented
1782             && !text_->inset().neverIndent()
1783             // display style insets are always centered, omit indentation
1784             && !(!par.empty()
1785                  && par.isInset(pos)
1786                  && par.getInset(pos)->display())
1787             && (!(tclass.isDefaultLayout(par.layout())
1788                   || tclass.isPlainLayout(par.layout()))
1789                 || buffer.params().paragraph_separation
1790                                 == BufferParams::ParagraphIndentSeparation)) {
1791                         // use the parindent of the layout when the
1792                         // default indentation is used otherwise use
1793                         // the indentation set in the document
1794                         // settings
1795                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1796                                 l_margin += bfm.signedWidth(parindent);
1797                         else
1798                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1799                 }
1800
1801         return l_margin;
1802 }
1803
1804
1805 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1806 {
1807         if (par_metrics_.empty())
1808                 return;
1809
1810         origin_.x_ = x;
1811         origin_.y_ = y;
1812
1813         ParMetricsCache::iterator it = par_metrics_.begin();
1814         ParMetricsCache::iterator const pm_end = par_metrics_.end();
1815         y -= it->second.ascent();
1816         for (; it != pm_end; ++it) {
1817                 ParagraphMetrics const & pmi = it->second;
1818                 y += pmi.ascent();
1819                 pit_type const pit = it->first;
1820                 // Save the paragraph position in the cache.
1821                 it->second.setPosition(y);
1822                 drawParagraph(pi, pit, x, y);
1823                 y += pmi.descent();
1824         }
1825 }
1826
1827
1828 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1829 {
1830         ParagraphMetrics const & pm = par_metrics_[pit];
1831         if (pm.rows().empty())
1832                 return;
1833         size_t const nrows = pm.rows().size();
1834
1835         // Use fast lane when drawing is disabled.
1836         if (!pi.pain.isDrawingEnabled()) {
1837                 for (size_t i = 0; i != nrows; ++i) {
1838
1839                         Row const & row = pm.rows()[i];
1840                         // Adapt to cursor row scroll offset if applicable.
1841                         int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1842                         if (i)
1843                                 y += row.ascent();
1844
1845                         RowPainter rp(pi, *text_, row, row_x, y);
1846
1847                         rp.paintOnlyInsets();
1848                         y += row.descent();
1849                 }
1850                 return;
1851         }
1852
1853         BufferParams const & bparams = bv_->buffer().params();
1854         int const ww = bv_->workHeight();
1855         Cursor const & cur = bv_->cursor();
1856         DocIterator sel_beg = cur.selectionBegin();
1857         DocIterator sel_end = cur.selectionEnd();
1858         bool selection = cur.selection()
1859                 // This is our text.
1860                 && cur.text() == text_
1861                 // if the anchor is outside, this is not our selection
1862                 && cur.normalAnchor().text() == text_
1863                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1864
1865         // We store the begin and end pos of the selection relative to this par
1866         DocIterator sel_beg_par = cur.selectionBegin();
1867         DocIterator sel_end_par = cur.selectionEnd();
1868
1869         // We care only about visible selection.
1870         if (selection) {
1871                 if (pit != sel_beg.pit()) {
1872                         sel_beg_par.pit() = pit;
1873                         sel_beg_par.pos() = 0;
1874                 }
1875                 if (pit != sel_end.pit()) {
1876                         sel_end_par.pit() = pit;
1877                         sel_end_par.pos() = sel_end_par.lastpos();
1878                 }
1879         }
1880
1881         for (size_t i = 0; i != nrows; ++i) {
1882
1883                 Row const & row = pm.rows()[i];
1884                 // Adapt to cursor row scroll offset if applicable.
1885                 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1886                 if (i)
1887                         y += row.ascent();
1888
1889                 RowPainter rp(pi, *text_, row, row_x, y);
1890
1891                 // It is not needed to draw on screen if we are not inside.
1892                 bool const inside = (y + row.descent() >= 0
1893                         && y - row.ascent() < ww);
1894                 pi.pain.setDrawingEnabled(inside);
1895                 if (!inside) {
1896                         // Paint only the insets to set inset cache correctly
1897                         // FIXME: remove paintOnlyInsets when we know that positions
1898                         // have already been set.
1899                         rp.paintOnlyInsets();
1900                         y += row.descent();
1901                         continue;
1902                 }
1903
1904                 if (selection)
1905                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1906                 else
1907                         row.setSelection(-1, -1);
1908
1909                 // The row knows nothing about the paragraph, so we have to check
1910                 // whether this row is the first or last and update the margins.
1911                 if (row.selection()) {
1912                         if (row.sel_beg == 0)
1913                                 row.begin_margin_sel = sel_beg.pit() < pit;
1914                         if (row.sel_end == sel_end_par.lastpos())
1915                                 row.end_margin_sel = sel_end.pit() > pit;
1916                 }
1917
1918                 // Row signature; has row changed since last paint?
1919                 row.setCrc(pm.computeRowSignature(row, bparams));
1920                 bool row_has_changed = row.changed()
1921                         || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1922
1923                 // Take this opportunity to spellcheck the row contents.
1924                 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1925                         text_->getPar(pit).spellCheck();
1926                 }
1927
1928                 // Don't paint the row if a full repaint has not been requested
1929                 // and if it has not changed.
1930                 if (!pi.full_repaint && !row_has_changed) {
1931                         // Paint only the insets if the text itself is
1932                         // unchanged.
1933                         rp.paintOnlyInsets();
1934                         y += row.descent();
1935                         continue;
1936                 }
1937
1938                 // Clear background of this row if paragraph background was not
1939                 // already cleared because of a full repaint.
1940                 if (!pi.full_repaint && row_has_changed) {
1941                         LYXERR(Debug::PAINTING, "Clear rect@("
1942                                << max(row_x, 0) << ", " << y - row.ascent() << ")="
1943                                << width() << " x " << row.height());
1944                         pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1945                                 width(), row.height(), pi.background_color);
1946                 }
1947
1948                 // Instrumentation for testing row cache (see also
1949                 // 12 lines lower):
1950                 if (lyxerr.debugging(Debug::PAINTING)
1951                         && (row.selection() || pi.full_repaint || row_has_changed)) {
1952                                 string const foreword = text_->isMainText() ?
1953                                         "main text redraw " : "inset text redraw: ";
1954                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1955                                 << " row_selection="    << row.selection()
1956                                 << " full_repaint="     << pi.full_repaint
1957                                 << " row_has_changed="  << row_has_changed
1958                                 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1959                 }
1960
1961                 // Backup full_repaint status and force full repaint
1962                 // for inner insets as the Row has been cleared out.
1963                 bool tmp = pi.full_repaint;
1964                 pi.full_repaint = true;
1965
1966                 rp.paintSelection();
1967                 rp.paintAppendix();
1968                 rp.paintDepthBar();
1969                 rp.paintChangeBar();
1970                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1971                 if (i == 0 && !is_rtl)
1972                         rp.paintFirst();
1973                 if (i == nrows - 1 && is_rtl)
1974                         rp.paintLast();
1975                 rp.paintText();
1976                 if (i == nrows - 1 && !is_rtl)
1977                         rp.paintLast();
1978                 if (i == 0 && is_rtl)
1979                         rp.paintFirst();
1980                 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1981                                       row_x + row.right_x() > bv_->workWidth());
1982                 y += row.descent();
1983
1984                 // Restore full_repaint status.
1985                 pi.full_repaint = tmp;
1986         }
1987         // Re-enable screen drawing for future use of the painter.
1988         pi.pain.setDrawingEnabled(true);
1989
1990         //LYXERR(Debug::PAINTING, ".");
1991 }
1992
1993
1994 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1995         Dimension & dim) const
1996 {
1997         Cursor const & bvcur = cur.bv().cursor();
1998
1999         // get word in front of cursor
2000         docstring word = text_->previousWord(bvcur.top());
2001         DocIterator wordStart = bvcur;
2002         wordStart.pos() -= word.length();
2003
2004         // get position on screen of the word start and end
2005         //FIXME: Is it necessary to explicitly set this to false?
2006         wordStart.boundary(false);
2007         Point lxy = cur.bv().getPos(wordStart);
2008         Point rxy = cur.bv().getPos(bvcur);
2009
2010         // calculate dimensions of the word
2011         Row row;
2012         row.pos(wordStart.pos());
2013         row.endpos(bvcur.pos());
2014         setRowHeight(row, false);
2015         dim = row.dimension();
2016         dim.wid = abs(rxy.x_ - lxy.x_);
2017
2018         // calculate position of word
2019         y = lxy.y_;
2020         x = min(rxy.x_, lxy.x_);
2021
2022         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2023         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2024 }
2025
2026 int defaultRowHeight()
2027 {
2028         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2029 }
2030
2031 } // namespace lyx