]> git.lyx.org Git - lyx.git/blob - src/TextMetrics.cpp
c99517c5176eaad2439bf768be8e7426d0b725ce
[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                         // this is needed to make sure that the row width is correct
853                         row.finalizeLast();
854                         int const add = max(fm.width(par.layout().labelsep),
855                                             labelEnd(pit) - row.width());
856                         row.addSpace(i, add, *fi, par.lookupChange(i));
857                 } else if (par.isLineSeparator(i)) {
858                         // In theory, no inset has this property. If
859                         // this is done, a new addSeparator which
860                         // takes an inset as parameter should be
861                         // added.
862                         LATTEST(!par.isInset(i));
863                         row.addSeparator(i, c, *fi, par.lookupChange(i));
864                 } else if (c == '\t')
865                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
866                                      *fi, par.lookupChange(i));
867                 else
868                         row.add(i, c, *fi, par.lookupChange(i));
869
870                 // add inline completion width
871                 if (inlineCompletionLPos == i &&
872                     !bv_->inlineCompletion().empty()) {
873                         Font f = *fi;
874                         f.fontInfo().setColor(Color_inlinecompletion);
875                         row.addVirtual(i + 1, bv_->inlineCompletion(),
876                                           f, Change());
877                 }
878
879                 // Handle some situations that abruptly terminate the row
880                 // - A newline inset
881                 // - Before a display inset
882                 // - After a display inset
883                 Inset const * inset = 0;
884                 if (par.isNewline(i) || par.isEnvSeparator(i)
885                     || (i + 1 < end && (inset = par.getInset(i + 1))
886                         && inset->display())
887                     || (!row.empty() && row.back().inset
888                         && row.back().inset->display())) {
889                         row.right_boundary(true);
890                         ++i;
891                         break;
892                 }
893
894                 ++i;
895                 ++fi;
896         }
897         row.finalizeLast();
898         row.endpos(i);
899
900         // End of paragraph marker
901         if (lyxrc.paragraph_markers
902             && i == end && size_type(pit + 1) < pars.size()) {
903                 // add a virtual element for the end-of-paragraph
904                 // marker; it is shown on screen, but does not exist
905                 // in the paragraph.
906                 Font f(text_->layoutFont(pit));
907                 f.fontInfo().setColor(Color_paragraphmarker);
908                 BufferParams const & bparams
909                         = text_->inset().buffer().params();
910                 f.setLanguage(par.getParLanguage(bparams));
911                 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
912         }
913
914         // if the row is too large, try to cut at last separator.
915         row.shortenIfNeeded(body_pos, width);
916
917         // if the row ends with a separator that is not at end of
918         // paragraph, remove it
919         if (!row.empty() && row.back().type == Row::SEPARATOR
920             && row.endpos() < par.size())
921                 row.pop_back();
922
923         // make sure that the RTL elements are in reverse ordering
924         row.reverseRTL(text_->isRTL(par));
925 }
926
927
928 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
929                                     bool topBottomSpace) const
930 {
931         Paragraph const & par = text_->getPar(pit);
932         // get the maximum ascent and the maximum descent
933         double layoutasc = 0;
934         double layoutdesc = 0;
935         double const dh = defaultRowHeight();
936
937         // ok, let us initialize the maxasc and maxdesc value.
938         // Only the fontsize count. The other properties
939         // are taken from the layoutfont. Nicer on the screen :)
940         Layout const & layout = par.layout();
941
942         // as max get the first character of this row then it can
943         // increase but not decrease the height. Just some point to
944         // start with so we don't have to do the assignment below too
945         // often.
946         Buffer const & buffer = bv_->buffer();
947         Font font = displayFont(pit, row.pos());
948         FontSize const tmpsize = font.fontInfo().size();
949         font.fontInfo() = text_->layoutFont(pit);
950         FontSize const size = font.fontInfo().size();
951         font.fontInfo().setSize(tmpsize);
952
953         FontInfo labelfont = text_->labelFont(par);
954
955         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
956         FontMetrics const & fontmetrics = theFontMetrics(font);
957
958         // these are minimum values
959         double const spacing_val = layout.spacing.getValue()
960                 * text_->spacing(par);
961         //lyxerr << "spacing_val = " << spacing_val << endl;
962         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
963         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
964
965         // insets may be taller
966         ParagraphMetrics const & pm = par_metrics_[pit];
967         Row::const_iterator cit = row.begin();
968         Row::const_iterator cend = row.end();
969         for ( ; cit != cend; ++cit) {
970                 if (cit->inset) {
971                         Dimension const & dim = pm.insetDimension(cit->inset);
972                         maxasc  = max(maxasc,  dim.ascent());
973                         maxdesc = max(maxdesc, dim.descent());
974                 }
975         }
976
977         // Check if any custom fonts are larger (Asger)
978         // This is not completely correct, but we can live with the small,
979         // cosmetic error for now.
980         int labeladdon = 0;
981
982         FontSize maxsize =
983                 par.highestFontInRange(row.pos(), row.endpos(), size);
984         if (maxsize > font.fontInfo().size()) {
985                 // use standard paragraph font with the maximal size
986                 FontInfo maxfont = font.fontInfo();
987                 maxfont.setSize(maxsize);
988                 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
989                 maxasc  = max(maxasc,  maxfontmetrics.maxAscent());
990                 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
991         }
992
993         // This is nicer with box insets:
994         ++maxasc;
995         ++maxdesc;
996
997         ParagraphList const & pars = text_->paragraphs();
998         Inset const & inset = text_->inset();
999
1000         // is it a top line?
1001         if (row.pos() == 0 && topBottomSpace) {
1002                 BufferParams const & bufparams = buffer.params();
1003                 // some parskips VERY EASY IMPLEMENTATION
1004                 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1005                     && !inset.getLayout().parbreakIsNewline()
1006                     && !par.layout().parbreak_is_newline
1007                     && pit > 0
1008                     && ((layout.isParagraph() && par.getDepth() == 0)
1009                         || (pars[pit - 1].layout().isParagraph()
1010                             && pars[pit - 1].getDepth() == 0))) {
1011                         maxasc += bufparams.getDefSkip().inPixels(*bv_);
1012                 }
1013
1014                 if (par.params().startOfAppendix())
1015                         maxasc += int(3 * dh);
1016
1017                 // special code for the top label
1018                 if (layout.labelIsAbove()
1019                     && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1020                     && !par.labelString().empty()) {
1021                         labeladdon = int(
1022                                   labelfont_metrics.maxHeight()
1023                                         * layout.spacing.getValue()
1024                                         * text_->spacing(par)
1025                                 + (layout.topsep + layout.labelbottomsep) * dh);
1026                 }
1027
1028                 // Add the layout spaces, for example before and after
1029                 // a section, or between the items of a itemize or enumerate
1030                 // environment.
1031
1032                 pit_type prev = text_->depthHook(pit, par.getDepth());
1033                 Paragraph const & prevpar = pars[prev];
1034                 if (prev != pit
1035                     && prevpar.layout() == layout
1036                     && prevpar.getDepth() == par.getDepth()
1037                     && prevpar.getLabelWidthString()
1038                                         == par.getLabelWidthString()) {
1039                         layoutasc = layout.itemsep * dh;
1040                 } else if (pit != 0 || row.pos() != 0) {
1041                         if (layout.topsep > 0)
1042                                 layoutasc = layout.topsep * dh;
1043                 }
1044
1045                 prev = text_->outerHook(pit);
1046                 if (prev != pit_type(pars.size())) {
1047                         maxasc += int(pars[prev].layout().parsep * dh);
1048                 } else if (pit != 0) {
1049                         Paragraph const & prevpar = pars[pit - 1];
1050                         if (prevpar.getDepth() != 0 ||
1051                                         prevpar.layout() == layout) {
1052                                 maxasc += int(layout.parsep * dh);
1053                         }
1054                 }
1055         }
1056
1057         // is it a bottom line?
1058         if (row.endpos() >= par.size() && topBottomSpace) {
1059                 // add the layout spaces, for example before and after
1060                 // a section, or between the items of a itemize or enumerate
1061                 // environment
1062                 pit_type nextpit = pit + 1;
1063                 if (nextpit != pit_type(pars.size())) {
1064                         pit_type cpit = pit;
1065
1066                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1067                                 double usual = pars[cpit].layout().bottomsep * dh;
1068                                 double unusual = 0;
1069                                 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1070                                 if (pars[cpit].layout() != pars[nextpit].layout()
1071                                     || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1072                                         unusual = pars[cpit].layout().bottomsep * dh;
1073                                 layoutdesc = max(unusual, usual);
1074                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1075                                 if (pars[cpit].layout() != pars[nextpit].layout()
1076                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1077                                         layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1078                         }
1079                 }
1080         }
1081
1082         // incalculate the layout spaces
1083         maxasc  += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
1084         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1085
1086         // FIXME: the correct way is to do the following is to move the
1087         // following code in another method specially tailored for the
1088         // main Text. The following test is thus bogus.
1089         // Top and bottom margin of the document (only at top-level)
1090         if (main_text_ && topBottomSpace) {
1091                 if (pit == 0 && row.pos() == 0)
1092                         maxasc += 20;
1093                 if (pit + 1 == pit_type(pars.size()) &&
1094                     row.endpos() == par.size() &&
1095                                 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1096                         maxdesc += 20;
1097         }
1098
1099         row.dimension().asc = maxasc + labeladdon;
1100         row.dimension().des = maxdesc;
1101 }
1102
1103
1104 // x is an absolute screen coord
1105 // returns the column near the specified x-coordinate of the row
1106 // x is set to the real beginning of this column
1107 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1108                                   bool & boundary) const
1109 {
1110         /// For the main Text, it is possible that this pit is not
1111         /// yet in the CoordCache when moving cursor up.
1112         /// x Paragraph coordinate is always 0 for main text anyway.
1113         int const xo = origin_.x_;
1114         x -= xo;
1115
1116         pos_type pos = row.pos();
1117         boundary = false;
1118         if (row.empty())
1119                 x = int(row.x);
1120         else if (x <= row.x) {
1121                 pos = row.front().left_pos();
1122                 x = int(row.x);
1123         } else if (x >= row.width() - row.right_margin) {
1124                 pos = row.back().right_pos();
1125                 x = row.width() - row.right_margin;
1126         } else {
1127                 double w = row.x;
1128                 Row::const_iterator cit = row.begin();
1129                 Row::const_iterator cend = row.end();
1130                 for ( ; cit != cend; ++cit) {
1131                         if (w <= x &&  w + cit->width() > x) {
1132                                 double x_offset = x - w;
1133                                 pos = cit->x2pos(x_offset);
1134                                 x = int(x_offset + w);
1135                                 break;
1136                         }
1137                         w += cit->width();
1138                 }
1139                 if (cit == row.end()) {
1140                         pos = row.back().right_pos();
1141                         x = row.width() - row.right_margin;
1142                 }
1143                 /** This tests for the case where the cursor is placed
1144                  * just before a font direction change. See comment on
1145                  * the boundary_ member in DocIterator.h to understand
1146                  * how boundary helps here.
1147                  */
1148                 else if (pos == cit->endpos
1149                          && cit + 1 != row.end()
1150                          && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1151                         boundary = true;
1152         }
1153
1154         /** This tests for the case where the cursor is set at the end
1155          * of a row which has been broken due something else than a
1156          * separator (a display inset or a forced breaking of the
1157          * row). We know that there is a separator when the end of the
1158          * row is larger than the end of its last element.
1159          */
1160         if (!row.empty() && pos == row.back().endpos
1161             && row.back().endpos == row.endpos())
1162                 boundary = true;
1163
1164         x += xo;
1165         return pos;
1166 }
1167
1168
1169 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1170 {
1171         // We play safe and use parMetrics(pit) to make sure the
1172         // ParagraphMetrics will be redone and OK to use if needed.
1173         // Otherwise we would use an empty ParagraphMetrics in
1174         // upDownInText() while in selection mode.
1175         ParagraphMetrics const & pm = parMetrics(pit);
1176
1177         LBUFERR(row < int(pm.rows().size()));
1178         bool bound = false;
1179         Row const & r = pm.rows()[row];
1180         return getPosNearX(r, x, bound);
1181 }
1182
1183
1184 void TextMetrics::newParMetricsDown()
1185 {
1186         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1187         pit_type const pit = last.first + 1;
1188         if (pit == int(text_->paragraphs().size()))
1189                 return;
1190
1191         // do it and update its position.
1192         redoParagraph(pit);
1193         par_metrics_[pit].setPosition(last.second.position()
1194                 + last.second.descent() + par_metrics_[pit].ascent());
1195 }
1196
1197
1198 void TextMetrics::newParMetricsUp()
1199 {
1200         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1201         if (first.first == 0)
1202                 return;
1203
1204         pit_type const pit = first.first - 1;
1205         // do it and update its position.
1206         redoParagraph(pit);
1207         par_metrics_[pit].setPosition(first.second.position()
1208                 - first.second.ascent() - par_metrics_[pit].descent());
1209 }
1210
1211 // y is screen coordinate
1212 pit_type TextMetrics::getPitNearY(int y)
1213 {
1214         LASSERT(!text_->paragraphs().empty(), return -1);
1215         LASSERT(!par_metrics_.empty(), return -1);
1216         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1217
1218         // look for highest numbered paragraph with y coordinate less than given y
1219         pit_type pit = -1;
1220         int yy = -1;
1221         ParMetricsCache::const_iterator it = par_metrics_.begin();
1222         ParMetricsCache::const_iterator et = par_metrics_.end();
1223         ParMetricsCache::const_iterator last = et;
1224         --last;
1225
1226         ParagraphMetrics const & pm = it->second;
1227
1228         if (y < it->second.position() - int(pm.ascent())) {
1229                 // We are looking for a position that is before the first paragraph in
1230                 // the cache (which is in priciple off-screen, that is before the
1231                 // visible part.
1232                 if (it->first == 0)
1233                         // We are already at the first paragraph in the inset.
1234                         return 0;
1235                 // OK, this is the paragraph we are looking for.
1236                 pit = it->first - 1;
1237                 newParMetricsUp();
1238                 return pit;
1239         }
1240
1241         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1242
1243         if (y >= last->second.position() + int(pm_last.descent())) {
1244                 // We are looking for a position that is after the last paragraph in
1245                 // the cache (which is in priciple off-screen), that is before the
1246                 // visible part.
1247                 pit = last->first + 1;
1248                 if (pit == int(text_->paragraphs().size()))
1249                         //  We are already at the last paragraph in the inset.
1250                         return last->first;
1251                 // OK, this is the paragraph we are looking for.
1252                 newParMetricsDown();
1253                 return pit;
1254         }
1255
1256         for (; it != et; ++it) {
1257                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1258                         << " y: " << it->second.position());
1259
1260                 ParagraphMetrics const & pm = par_metrics_[it->first];
1261
1262                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1263                         pit = it->first;
1264                         yy = it->second.position();
1265                 }
1266         }
1267
1268         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1269
1270         return pit;
1271 }
1272
1273
1274 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1275         bool assert_in_view, bool up)
1276 {
1277         ParagraphMetrics const & pm = par_metrics_[pit];
1278
1279         int yy = pm.position() - pm.ascent();
1280         LBUFERR(!pm.rows().empty());
1281         RowList::const_iterator rit = pm.rows().begin();
1282         RowList::const_iterator rlast = pm.rows().end();
1283         --rlast;
1284         for (; rit != rlast; yy += rit->height(), ++rit)
1285                 if (yy + rit->height() > y)
1286                         break;
1287
1288         if (assert_in_view) {
1289                 if (!up && yy + rit->height() > y) {
1290                         if (rit != pm.rows().begin()) {
1291                                 y = yy;
1292                                 --rit;
1293                         } else if (pit != 0) {
1294                                 --pit;
1295                                 newParMetricsUp();
1296                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1297                                 rit = pm2.rows().end();
1298                                 --rit;
1299                                 y = yy;
1300                         }
1301                 } else if (up && yy != y) {
1302                         if (rit != rlast) {
1303                                 y = yy + rit->height();
1304                                 ++rit;
1305                         } else if (pit < int(text_->paragraphs().size()) - 1) {
1306                                 ++pit;
1307                                 newParMetricsDown();
1308                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1309                                 rit = pm2.rows().begin();
1310                                 y = pm2.position();
1311                         }
1312                 }
1313         }
1314         return *rit;
1315 }
1316
1317
1318 // x,y are absolute screen coordinates
1319 // sets cursor recursively descending into nested editable insets
1320 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1321         bool assert_in_view, bool up)
1322 {
1323         if (lyxerr.debugging(Debug::WORKAREA)) {
1324                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1325                 cur.bv().coordCache().dump();
1326         }
1327         pit_type pit = getPitNearY(y);
1328         LASSERT(pit != -1, return 0);
1329
1330         int yy = y; // is modified by getPitAndRowNearY
1331         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1332
1333         cur.pit() = pit;
1334
1335         // Do we cover an inset?
1336         InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1337
1338         if (!it) {
1339                 // No inset, set position in the text
1340                 bool bound = false; // is modified by getPosNearX
1341                 int xx = x; // is modified by getPosNearX
1342                 cur.pos() = getPosNearX(row, xx, bound);
1343                 cur.boundary(bound);
1344                 cur.setCurrentFont();
1345                 cur.setTargetX(xx);
1346                 return 0;
1347         }
1348
1349         Inset * inset = it->inset;
1350         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1351
1352         // Set position in front of inset
1353         cur.pos() = it->pos;
1354         cur.boundary(false);
1355         cur.setTargetX(x);
1356
1357         // Try to descend recursively inside the inset.
1358         inset = inset->editXY(cur, x, yy);
1359
1360         if (cur.top().text() == text_)
1361                 cur.setCurrentFont();
1362         return inset;
1363 }
1364
1365
1366 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1367 {
1368         LASSERT(text_ == cur.text(), return);
1369         pit_type const pit = getPitNearY(y);
1370         LASSERT(pit != -1, return);
1371
1372         ParagraphMetrics const & pm = par_metrics_[pit];
1373
1374         int yy = pm.position() - pm.ascent();
1375         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1376                 " pit: " << pit << " yy: " << yy);
1377
1378         int r = 0;
1379         LBUFERR(pm.rows().size());
1380         for (; r < int(pm.rows().size()) - 1; ++r) {
1381                 Row const & row = pm.rows()[r];
1382                 if (int(yy + row.height()) > y)
1383                         break;
1384                 yy += row.height();
1385         }
1386
1387         Row const & row = pm.rows()[r];
1388
1389         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1390
1391         bool bound = false;
1392         int xx = x;
1393         pos_type const pos = getPosNearX(row, xx, bound);
1394
1395         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1396
1397         text_->setCursor(cur, pit, pos, true, bound);
1398         // remember new position.
1399         cur.setTargetX();
1400 }
1401
1402
1403 //takes screen x,y coordinates
1404 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1405 {
1406         Paragraph const & par = text_->paragraphs()[pit];
1407         ParagraphMetrics const & pm = par_metrics_[pit];
1408
1409         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1410
1411         InsetList::const_iterator iit = par.insetList().begin();
1412         InsetList::const_iterator iend = par.insetList().end();
1413         for (; iit != iend; ++iit) {
1414                 Inset * inset = iit->inset;
1415
1416                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1417
1418                 if (!bv_->coordCache().getInsets().has(inset)) {
1419                         LYXERR(Debug::DEBUG, "inset has no cached position");
1420                         return 0;
1421                 }
1422
1423                 Dimension const & dim = pm.insetDimension(inset);
1424                 Point p = bv_->coordCache().getInsets().xy(inset);
1425
1426                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1427                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1428
1429                 if (x >= p.x_ && x <= p.x_ + dim.wid
1430                     && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1431                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1432                         return const_cast<InsetList::InsetTable *>(&(*iit));
1433                 }
1434         }
1435
1436         LYXERR(Debug::DEBUG, "No inset hit. ");
1437         return 0;
1438 }
1439
1440
1441 //takes screen x,y coordinates
1442 Inset * TextMetrics::checkInsetHit(int x, int y)
1443 {
1444         pit_type const pit = getPitNearY(y);
1445         LASSERT(pit != -1, return 0);
1446         InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1447
1448         if (!it)
1449                 return 0;
1450
1451         return it->inset;
1452 }
1453
1454
1455 int TextMetrics::cursorX(CursorSlice const & sl,
1456                 bool boundary) const
1457 {
1458         LASSERT(sl.text() == text_, return 0);
1459
1460         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1461         if (pm.rows().empty())
1462                 return 0;
1463         Row const & row = pm.getRow(sl.pos(), boundary);
1464         pos_type const pos = sl.pos();
1465
1466         /**
1467          * When boundary is true, position i is in the row element (pos, endpos)
1468          * if
1469          *    pos < i <= endpos
1470          * whereas, when boundary is false, the test is
1471          *    pos <= i < endpos
1472          * The correction below allows to handle both cases.
1473         */
1474         int const boundary_corr = (boundary && pos) ? -1 : 0;
1475
1476         /** Early return in trivial cases
1477          * 1) the row is empty
1478          * 2) the position is the left-most position of the row; there
1479          * is a quirck herehowever: if the first element is virtual
1480          * (end-of-par marker for example), then we have to look
1481          * closer
1482          */
1483         if (row.empty()
1484             || (pos == row.begin()->left_pos()
1485                 && pos != row.begin()->right_pos()))
1486                 return int(row.x);
1487
1488         Row::const_iterator cit = row.begin();
1489         double x = row.x;
1490         for ( ; cit != row.end() ; ++cit) {
1491                 /** Look whether the cursor is inside the element's
1492                  * span. Note that it is necessary to take the
1493                  * boundary in account, and to accept virtual
1494                  * elements, which have pos == endpos.
1495                  */
1496                 if (pos + boundary_corr >= cit->pos
1497                     && (pos + boundary_corr < cit->endpos
1498                         || cit->pos == cit->endpos)) {
1499                                 x += cit->pos2x(pos);
1500                                 break;
1501                 }
1502                 x += cit->width();
1503         }
1504
1505         return int(x);
1506 }
1507
1508
1509 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1510 {
1511         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1512         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1513         if (pm.rows().empty())
1514                 return 0;
1515
1516         int h = 0;
1517         h -= par_metrics_[0].rows()[0].ascent();
1518         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1519                 h += par_metrics_[pit].height();
1520         }
1521         int pos = sl.pos();
1522         if (pos && boundary)
1523                 --pos;
1524         size_t const rend = pm.pos2row(pos);
1525         for (size_t rit = 0; rit != rend; ++rit)
1526                 h += pm.rows()[rit].height();
1527         h += pm.rows()[rend].ascent();
1528         return h;
1529 }
1530
1531
1532 // the cursor set functions have a special mechanism. When they
1533 // realize you left an empty paragraph, they will delete it.
1534
1535 bool TextMetrics::cursorHome(Cursor & cur)
1536 {
1537         LASSERT(text_ == cur.text(), return false);
1538         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1539         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1540         return text_->setCursor(cur, cur.pit(), row.pos());
1541 }
1542
1543
1544 bool TextMetrics::cursorEnd(Cursor & cur)
1545 {
1546         LASSERT(text_ == cur.text(), return false);
1547         // if not on the last row of the par, put the cursor before
1548         // the final space exept if I have a spanning inset or one string
1549         // is so long that we force a break.
1550         pos_type end = cur.textRow().endpos();
1551         if (end == 0)
1552                 // empty text, end-1 is no valid position
1553                 return false;
1554         bool boundary = false;
1555         if (end != cur.lastpos()) {
1556                 if (!cur.paragraph().isLineSeparator(end-1)
1557                     && !cur.paragraph().isNewline(end-1)
1558                     && !cur.paragraph().isEnvSeparator(end-1))
1559                         boundary = true;
1560                 else
1561                         --end;
1562         }
1563         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1564 }
1565
1566
1567 void TextMetrics::deleteLineForward(Cursor & cur)
1568 {
1569         LASSERT(text_ == cur.text(), return);
1570         if (cur.lastpos() == 0) {
1571                 // Paragraph is empty, so we just go forward
1572                 text_->cursorForward(cur);
1573         } else {
1574                 cur.resetAnchor();
1575                 cur.setSelection(true); // to avoid deletion
1576                 cursorEnd(cur);
1577                 cur.setSelection();
1578                 // What is this test for ??? (JMarc)
1579                 if (!cur.selection())
1580                         text_->deleteWordForward(cur);
1581                 else
1582                         cap::cutSelection(cur, true, false);
1583                 cur.checkBufferStructure();
1584         }
1585 }
1586
1587
1588 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1589 {
1590         ParagraphList const & pars = text_->paragraphs();
1591         return row.endpos() >= pars[pit].size()
1592                 && pit + 1 == pit_type(pars.size());
1593 }
1594
1595
1596 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1597 {
1598         return row.pos() == 0 && pit == 0;
1599 }
1600
1601
1602 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1603 {
1604         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1605 }
1606
1607
1608 int TextMetrics::leftMargin(int max_width,
1609                 pit_type const pit, pos_type const pos) const
1610 {
1611         ParagraphList const & pars = text_->paragraphs();
1612
1613         LASSERT(pit >= 0, return 0);
1614         LASSERT(pit < int(pars.size()), return 0);
1615         Paragraph const & par = pars[pit];
1616         LASSERT(pos >= 0, return 0);
1617         LASSERT(pos <= par.size(), return 0);
1618         Buffer const & buffer = bv_->buffer();
1619         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1620         DocumentClass const & tclass = buffer.params().documentClass();
1621         Layout const & layout = par.layout();
1622
1623         docstring parindent = layout.parindent;
1624
1625         int l_margin = 0;
1626
1627         if (text_->isMainText())
1628                 l_margin += bv_->leftMargin();
1629
1630         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1631                 tclass.leftmargin());
1632
1633         if (par.getDepth() != 0) {
1634                 // find the next level paragraph
1635                 pit_type newpar = text_->outerHook(pit);
1636                 if (newpar != pit_type(pars.size())) {
1637                         if (pars[newpar].layout().isEnvironment()) {
1638                                 l_margin = leftMargin(max_width, newpar);
1639                                 // Remove the parindent that has been added
1640                                 // if the paragraph was empty.
1641                                 if (pars[newpar].empty() &&
1642                                     buffer.params().paragraph_separation ==
1643                                     BufferParams::ParagraphIndentSeparation) {
1644                                         docstring pi = pars[newpar].layout().parindent;
1645                                         l_margin -= theFontMetrics(
1646                                                 buffer.params().getFont()).signedWidth(pi);
1647                                 }
1648                         }
1649                         if (tclass.isDefaultLayout(par.layout())
1650                             || tclass.isPlainLayout(par.layout())) {
1651                                 if (pars[newpar].params().noindent())
1652                                         parindent.erase();
1653                                 else
1654                                         parindent = pars[newpar].layout().parindent;
1655                         }
1656                 }
1657         }
1658
1659         // This happens after sections or environments in standard classes.
1660         // We have to check the previous layout at same depth.
1661         if (buffer.params().paragraph_separation ==
1662                         BufferParams::ParagraphSkipSeparation)
1663                 parindent.erase();
1664         else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1665                 pit_type prev = text_->depthHook(pit, par.getDepth());
1666                 if (par.layout() == pars[prev].layout()) {
1667                         if (prev != pit - 1
1668                             && pars[pit - 1].layout().nextnoindent)
1669                                 parindent.erase();
1670                 } else if (pars[prev].layout().nextnoindent)
1671                         parindent.erase();
1672         }
1673
1674         FontInfo const labelfont = text_->labelFont(par);
1675         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1676
1677         switch (layout.margintype) {
1678         case MARGIN_DYNAMIC:
1679                 if (!layout.leftmargin.empty()) {
1680                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1681                                 layout.leftmargin);
1682                 }
1683                 if (!par.labelString().empty()) {
1684                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1685                         l_margin += labelfont_metrics.width(par.labelString());
1686                         l_margin += labelfont_metrics.width(layout.labelsep);
1687                 }
1688                 break;
1689
1690         case MARGIN_MANUAL: {
1691                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1692                 // The width of an empty par, even with manual label, should be 0
1693                 if (!par.empty() && pos >= par.beginOfBody()) {
1694                         if (!par.getLabelWidthString().empty()) {
1695                                 docstring labstr = par.getLabelWidthString();
1696                                 l_margin += labelfont_metrics.width(labstr);
1697                                 l_margin += labelfont_metrics.width(layout.labelsep);
1698                         }
1699                 }
1700                 break;
1701         }
1702
1703         case MARGIN_STATIC: {
1704                 l_margin += theFontMetrics(buffer.params().getFont()).
1705                         signedWidth(layout.leftmargin) * 4      / (par.getDepth() + 4);
1706                 break;
1707         }
1708
1709         case MARGIN_FIRST_DYNAMIC:
1710                 if (layout.labeltype == LABEL_MANUAL) {
1711                         // if we are at position 0, we are never in the body
1712                         if (pos > 0 && pos >= par.beginOfBody())
1713                                 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1714                         else
1715                                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1716                 } else if (pos != 0
1717                            // Special case to fix problems with
1718                            // theorems (JMarc)
1719                            || (layout.labeltype == LABEL_STATIC
1720                                && layout.latextype == LATEX_ENVIRONMENT
1721                                && !text_->isFirstInSequence(pit))) {
1722                         l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1723                 } else if (!layout.labelIsAbove()) {
1724                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1725                         l_margin += labelfont_metrics.width(layout.labelsep);
1726                         l_margin += labelfont_metrics.width(par.labelString());
1727                 }
1728                 break;
1729
1730         case MARGIN_RIGHT_ADDRESS_BOX: {
1731 #if 0
1732                 // The left margin depends on the widest row in this paragraph.
1733                 // This code is wrong because it depends on the rows, but at the
1734                 // same time this function is used in redoParagraph to construct
1735                 // the rows.
1736                 ParagraphMetrics const & pm = par_metrics_[pit];
1737                 RowList::const_iterator rit = pm.rows().begin();
1738                 RowList::const_iterator end = pm.rows().end();
1739                 int minfill = max_width;
1740                 for ( ; rit != end; ++rit)
1741                         if (rit->fill() < minfill)
1742                                 minfill = rit->fill();
1743                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1744                 l_margin += minfill;
1745 #endif
1746                 // also wrong, but much shorter.
1747                 l_margin += max_width / 2;
1748                 break;
1749         }
1750         }
1751
1752         if (!par.params().leftIndent().zero())
1753                 l_margin += par.params().leftIndent().inPixels(max_width);
1754
1755         LyXAlignment align;
1756
1757         if (par.params().align() == LYX_ALIGN_LAYOUT)
1758                 align = layout.align;
1759         else
1760                 align = par.params().align();
1761
1762         // set the correct parindent
1763         if (pos == 0
1764             && (layout.labeltype == LABEL_NO_LABEL
1765                 || layout.labeltype == LABEL_ABOVE
1766                 || layout.labeltype == LABEL_CENTERED
1767                 || (layout.labeltype == LABEL_STATIC
1768                     && layout.latextype == LATEX_ENVIRONMENT
1769                     && !text_->isFirstInSequence(pit)))
1770             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1771             && !par.params().noindent()
1772             // in some insets, paragraphs are never indented
1773             && !text_->inset().neverIndent()
1774             // display style insets are always centered, omit indentation
1775             && !(!par.empty()
1776                  && par.isInset(pos)
1777                  && par.getInset(pos)->display())
1778             && (!(tclass.isDefaultLayout(par.layout())
1779                   || tclass.isPlainLayout(par.layout()))
1780                 || buffer.params().paragraph_separation
1781                                 == BufferParams::ParagraphIndentSeparation)) {
1782                         // use the parindent of the layout when the
1783                         // default indentation is used otherwise use
1784                         // the indentation set in the document
1785                         // settings
1786                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1787                                 l_margin += theFontMetrics(
1788                                         buffer.params().getFont()).signedWidth(parindent);
1789                         else
1790                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1791                 }
1792
1793         return l_margin;
1794 }
1795
1796
1797 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1798 {
1799         if (par_metrics_.empty())
1800                 return;
1801
1802         origin_.x_ = x;
1803         origin_.y_ = y;
1804
1805         ParMetricsCache::iterator it = par_metrics_.begin();
1806         ParMetricsCache::iterator const pm_end = par_metrics_.end();
1807         y -= it->second.ascent();
1808         for (; it != pm_end; ++it) {
1809                 ParagraphMetrics const & pmi = it->second;
1810                 y += pmi.ascent();
1811                 pit_type const pit = it->first;
1812                 // Save the paragraph position in the cache.
1813                 it->second.setPosition(y);
1814                 drawParagraph(pi, pit, x, y);
1815                 y += pmi.descent();
1816         }
1817 }
1818
1819
1820 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1821 {
1822         BufferParams const & bparams = bv_->buffer().params();
1823         ParagraphMetrics const & pm = par_metrics_[pit];
1824         if (pm.rows().empty())
1825                 return;
1826
1827         bool const original_drawing_state = pi.pain.isDrawingEnabled();
1828         int const ww = bv_->workHeight();
1829         size_t const nrows = pm.rows().size();
1830
1831         Cursor const & cur = bv_->cursor();
1832         DocIterator sel_beg = cur.selectionBegin();
1833         DocIterator sel_end = cur.selectionEnd();
1834         bool selection = cur.selection()
1835                 // This is our text.
1836                 && cur.text() == text_
1837                 // if the anchor is outside, this is not our selection
1838                 && cur.normalAnchor().text() == text_
1839                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1840
1841         // We store the begin and end pos of the selection relative to this par
1842         DocIterator sel_beg_par = cur.selectionBegin();
1843         DocIterator sel_end_par = cur.selectionEnd();
1844
1845         // We care only about visible selection.
1846         if (selection) {
1847                 if (pit != sel_beg.pit()) {
1848                         sel_beg_par.pit() = pit;
1849                         sel_beg_par.pos() = 0;
1850                 }
1851                 if (pit != sel_end.pit()) {
1852                         sel_end_par.pit() = pit;
1853                         sel_end_par.pos() = sel_end_par.lastpos();
1854                 }
1855         }
1856
1857         for (size_t i = 0; i != nrows; ++i) {
1858
1859                 Row const & row = pm.rows()[i];
1860                 if (i)
1861                         y += row.ascent();
1862
1863                 bool const inside = (y + row.descent() >= 0
1864                         && y - row.ascent() < ww);
1865                 // It is not needed to draw on screen if we are not inside.
1866                 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1867                 RowPainter rp(pi, *text_, pit, row, x, y);
1868
1869                 if (selection)
1870                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1871                 else
1872                         row.setSelection(-1, -1);
1873
1874                 // The row knows nothing about the paragraph, so we have to check
1875                 // whether this row is the first or last and update the margins.
1876                 if (row.selection()) {
1877                         if (row.sel_beg == 0)
1878                                 row.begin_margin_sel = sel_beg.pit() < pit;
1879                         if (row.sel_end == sel_end_par.lastpos())
1880                                 row.end_margin_sel = sel_end.pit() > pit;
1881                 }
1882
1883                 // Row signature; has row changed since last paint?
1884                 row.setCrc(pm.computeRowSignature(row, bparams));
1885                 bool row_has_changed = row.changed();
1886
1887                 // Take this opportunity to spellcheck the row contents.
1888                 if (row_has_changed && lyxrc.spellcheck_continuously) {
1889                         text_->getPar(pit).spellCheck();
1890                 }
1891
1892                 // Don't paint the row if a full repaint has not been requested
1893                 // and if it has not changed.
1894                 if (!pi.full_repaint && !row_has_changed) {
1895                         // Paint only the insets if the text itself is
1896                         // unchanged.
1897                         rp.paintOnlyInsets();
1898                         y += row.descent();
1899                         continue;
1900                 }
1901
1902                 // Clear background of this row if paragraph background was not
1903                 // already cleared because of a full repaint.
1904                 if (!pi.full_repaint && row_has_changed) {
1905                         pi.pain.fillRectangle(x, y - row.ascent(),
1906                                 width(), row.height(), pi.background_color);
1907                 }
1908
1909                 // Instrumentation for testing row cache (see also
1910                 // 12 lines lower):
1911                 if (lyxerr.debugging(Debug::PAINTING) && inside
1912                         && (row.selection() || pi.full_repaint || row_has_changed)) {
1913                                 string const foreword = text_->isMainText() ?
1914                                         "main text redraw " : "inset text redraw: ";
1915                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1916                                 << " row_selection="    << row.selection()
1917                                 << " full_repaint="     << pi.full_repaint
1918                                 << " row_has_changed="  << row_has_changed);
1919                 }
1920
1921                 // Backup full_repaint status and force full repaint
1922                 // for inner insets as the Row has been cleared out.
1923                 bool tmp = pi.full_repaint;
1924                 pi.full_repaint = true;
1925
1926                 rp.paintSelection();
1927                 rp.paintAppendix();
1928                 rp.paintDepthBar();
1929                 rp.paintChangeBar();
1930                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1931                 if (i == 0 && !is_rtl)
1932                         rp.paintFirst();
1933                 if (i == nrows - 1 && is_rtl)
1934                         rp.paintLast();
1935                 rp.paintText();
1936                 if (i == nrows - 1 && !is_rtl)
1937                         rp.paintLast();
1938                 if (i == 0 && is_rtl)
1939                         rp.paintFirst();
1940                 y += row.descent();
1941
1942                 // Restore full_repaint status.
1943                 pi.full_repaint = tmp;
1944         }
1945         // Re-enable screen drawing for future use of the painter.
1946         pi.pain.setDrawingEnabled(original_drawing_state);
1947
1948         //LYXERR(Debug::PAINTING, ".");
1949 }
1950
1951
1952 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1953         Dimension & dim) const
1954 {
1955         Cursor const & bvcur = cur.bv().cursor();
1956
1957         // get word in front of cursor
1958         docstring word = text_->previousWord(bvcur.top());
1959         DocIterator wordStart = bvcur;
1960         wordStart.pos() -= word.length();
1961
1962         // get position on screen of the word start and end
1963         //FIXME: Is it necessary to explicitly set this to false?
1964         wordStart.boundary(false);
1965         Point lxy = cur.bv().getPos(wordStart);
1966         Point rxy = cur.bv().getPos(bvcur);
1967
1968         // calculate dimensions of the word
1969         Row row;
1970         row.pos(wordStart.pos());
1971         row.endpos(bvcur.pos());
1972         setRowHeight(row, bvcur.pit(), false);
1973         dim = row.dimension();
1974         dim.wid = abs(rxy.x_ - lxy.x_);
1975
1976         // calculate position of word
1977         y = lxy.y_;
1978         x = min(rxy.x_, lxy.x_);
1979
1980         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1981         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1982 }
1983
1984 int defaultRowHeight()
1985 {
1986         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
1987 }
1988
1989 } // namespace lyx