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