]> git.lyx.org Git - lyx.git/blob - src/TextMetrics.cpp
Move OS specific code to proper place. Also make sure that no other
[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 "Bidi.h"
23 #include "Buffer.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
28 #include "Cursor.h"
29 #include "CutAndPaste.h"
30 #include "FuncRequest.h"
31 #include "HSpace.h"
32 #include "InsetList.h"
33 #include "Layout.h"
34 #include "Length.h"
35 #include "LyXRC.h"
36 #include "MetricsInfo.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
40 #include "Text.h"
41 #include "TextClass.h"
42 #include "VSpace.h"
43 #include "WordLangTuple.h"
44
45 #include "insets/InsetText.h"
46
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathMacroTemplate.h"
49
50 #include "frontends/FontMetrics.h"
51 #include "frontends/Painter.h"
52
53 #include "support/debug.h"
54 #include "support/docstring_list.h"
55 #include "support/lassert.h"
56
57 #include <cstdlib>
58
59 using namespace std;
60
61
62 namespace lyx {
63
64 using frontend::FontMetrics;
65
66 static int numberOfSeparators(Paragraph const & par, Row const & row)
67 {
68         pos_type const first = max(row.pos(), par.beginOfBody());
69         pos_type const last = row.endpos() - 1;
70         int n = 0;
71         for (pos_type p = first; p < last; ++p) {
72                 if (par.isSeparator(p))
73                         ++n;
74         }
75         return n;
76 }
77
78
79 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
80 {
81         pos_type last = row.endpos() - 1;
82         pos_type first = row.pos();
83
84         // hfill *DO* count at the beginning of paragraphs!
85         if (first) {
86                 while (first < last && par.isHfill(first))
87                         ++first;
88         }
89
90         last = min(last, par.beginOfBody());
91         int n = 0;
92         for (pos_type p = first; p < last; ++p) {
93                 if (par.isHfill(p))
94                         ++n;
95         }
96         return n;
97 }
98
99
100 static int numberOfHfills(Paragraph const & par, Row const & row)
101 {
102         pos_type const last = row.endpos();
103         pos_type first = row.pos();
104
105         // hfill *DO* count at the beginning of paragraphs!
106         if (first) {
107                 while (first < last && par.isHfill(first))
108                         ++first;
109         }
110
111         first = max(first, par.beginOfBody());
112
113         int n = 0;
114         for (pos_type p = first; p < last; ++p) {
115                 if (par.isHfill(p))
116                         ++n;
117         }
118         return n;
119 }
120
121
122 /////////////////////////////////////////////////////////////////////
123 //
124 // TextMetrics
125 //
126 /////////////////////////////////////////////////////////////////////
127
128
129 TextMetrics::TextMetrics(BufferView * bv, Text * text)
130         : bv_(bv), text_(text)
131 {
132         LASSERT(bv_, /**/);
133         max_width_ = bv_->workWidth();
134         dim_.wid = max_width_;
135         dim_.asc = 10;
136         dim_.des = 10;
137
138         //text_->updateLabels(bv->buffer());
139 }
140
141
142 bool TextMetrics::contains(pit_type pit) const
143 {
144         return par_metrics_.find(pit) != par_metrics_.end();
145 }
146
147
148 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
149 {
150         return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
151 }
152
153
154
155 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
156 {
157         ParMetricsCache::const_iterator it = par_metrics_.begin();
158         return make_pair(it->first, &it->second);
159 }
160
161
162 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
163 {
164         ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
165         return make_pair(it->first, &it->second);
166 }
167
168
169 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
170 {
171         ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
172         if (pmc_it == par_metrics_.end()) {
173                 pmc_it = par_metrics_.insert(
174                         make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
175         }
176         if (pmc_it->second.rows().empty() && redo)
177                 redoParagraph(pit);
178         return pmc_it->second;
179 }
180
181
182 int TextMetrics::parPosition(pit_type pit) const
183 {
184         if (pit < par_metrics_.begin()->first)
185                 return -1000000;
186         if (pit > par_metrics_.rbegin()->first)
187                 return +1000000;
188
189         return par_metrics_[pit].position();
190 }
191
192
193 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
194 {
195         LASSERT(mi.base.textwidth > 0, /**/);
196         max_width_ = mi.base.textwidth;
197         // backup old dimension.
198         Dimension const old_dim = dim_;
199         // reset dimension.
200         dim_ = Dimension();
201         dim_.wid = min_width;
202         pit_type const npar = text_->paragraphs().size();
203         if (npar > 1)
204                 // If there is more than one row, expand the text to
205                 // the full allowable width.
206                 dim_.wid = max_width_;
207
208         //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
209         //      << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
210
211         bool changed = false;
212         unsigned int h = 0;
213         for (pit_type pit = 0; pit != npar; ++pit) {
214                 changed |= redoParagraph(pit);
215                 ParagraphMetrics const & pm = par_metrics_[pit];
216                 h += pm.height();
217                 if (dim_.wid < pm.width())
218                         dim_.wid = pm.width();
219         }
220
221         dim_.asc = par_metrics_[0].ascent();
222         dim_.des = h - dim_.asc;
223         //lyxerr << "dim_.wid " << dim_.wid << endl;
224         //lyxerr << "dim_.asc " << dim_.asc << endl;
225         //lyxerr << "dim_.des " << dim_.des << endl;
226
227         changed |= dim_ != old_dim;
228         dim = dim_;
229         return changed;
230 }
231
232
233 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
234 {
235         return main_text_? pm.rightMargin(*bv_) : 0;
236 }
237
238
239 int TextMetrics::rightMargin(pit_type const pit) const
240 {
241         return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
242 }
243
244
245 void TextMetrics::applyOuterFont(Font & font) const
246 {
247         Font lf(font_);
248         lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
249         lf.fontInfo().realize(font.fontInfo());
250         lf.setLanguage(font.language());
251         font = lf;
252 }
253
254
255 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
256 {
257         LASSERT(pos >= 0, /**/);
258
259         ParagraphList const & pars = text_->paragraphs();
260         Paragraph const & par = pars[pit];
261         Layout const & layout = par.layout();
262         Buffer const & buffer = bv_->buffer();
263         // FIXME: broken?
264         BufferParams const & params = buffer.params();
265         pos_type const body_pos = par.beginOfBody();
266
267         // We specialize the 95% common case:
268         if (!par.getDepth()) {
269                 Font f = par.getFontSettings(params, pos);
270                 if (!text_->isMainText())
271                         applyOuterFont(f);
272                 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
273
274                 FontInfo const & lf = lab ? layout.labelfont : layout.font;
275                 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
276
277                 // In case the default family has been customized
278                 if (lf.family() == INHERIT_FAMILY)
279                         rlf.setFamily(params.getFont().fontInfo().family());
280                 f.fontInfo().realize(rlf);
281                 return f;
282         }
283
284         // The uncommon case need not be optimized as much
285         FontInfo const & layoutfont = pos < body_pos ?
286                 layout.labelfont : layout.font;
287
288         Font font = par.getFontSettings(params, pos);
289         font.fontInfo().realize(layoutfont);
290
291         if (!text_->isMainText())
292                 applyOuterFont(font);
293
294         // Realize against environment font information
295         // NOTE: the cast to pit_type should be removed when pit_type
296         // changes to a unsigned integer.
297         if (pit < pit_type(pars.size()))
298                 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
299
300         // Realize with the fonts of lesser depth.
301         font.fontInfo().realize(params.getFont().fontInfo());
302
303         return font;
304 }
305
306
307 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
308 {
309         if (!lyxrc.rtl_support || !sl.text())
310                 return false;
311
312         int correction = 0;
313         if (boundary && sl.pos() > 0)
314                 correction = -1;
315
316         return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
317 }
318
319
320 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
321 {
322         if (!lyxrc.rtl_support)
323                 return false;
324
325         // no RTL boundary at paragraph start
326         if (pos == 0)
327                 return false;
328
329         Font const & left_font = displayFont(pit, pos - 1);
330
331         return isRTLBoundary(pit, pos, left_font);
332 }
333
334
335 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
336                 Font const & font) const
337 {
338         if (!lyxrc.rtl_support)
339                 return false;
340
341         // no RTL boundary at paragraph start
342         if (pos == 0)
343                 return false;
344         
345         ParagraphMetrics & pm = par_metrics_[pit];
346         // no RTL boundary in empty paragraph
347         if (pm.rows().empty())
348                 return false;
349
350         pos_type endpos = pm.getRow(pos - 1, false).endpos();
351         pos_type startpos = pm.getRow(pos, false).pos();
352         // no RTL boundary at line start:
353         // abc\n   -> toggle to RTL ->    abc\n     (and not:    abc\n|
354         // |                              |                               )
355         if (pos == startpos && pos == endpos) // start of cur row, end of prev row
356                 return false;
357
358         Paragraph const & par = text_->getPar(pit);
359         bool left = font.isVisibleRightToLeft();
360         bool right;
361         if (pos == par.size())
362                 right = par.isRTL(bv_->buffer().params());
363         else
364                 right = displayFont(pit, pos).isVisibleRightToLeft();
365         
366         // no RTL boundary at line break:
367         // abc|\n    -> move right ->   abc\n       (and not:    abc\n|
368         // FED                          FED|                     FED     )
369         if (startpos == pos && endpos == pos && endpos != par.size() 
370                 && (par.isNewline(pos - 1) 
371                         || par.isLineSeparator(pos - 1) 
372                         || par.isSeparator(pos - 1)))
373                 return false;
374         
375         return left != right;
376 }
377
378
379 bool TextMetrics::redoParagraph(pit_type const pit)
380 {
381         Paragraph & par = text_->getPar(pit);
382         // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
383         // redoParagraph() recursively inside parMetrics.
384         Dimension old_dim = parMetrics(pit, false).dim();
385         ParagraphMetrics & pm = par_metrics_[pit];
386         pm.reset(par);
387
388         Buffer & buffer = bv_->buffer();
389         main_text_ = (text_ == &buffer.text());
390         bool changed = false;
391
392         // FIXME: This check ought to be done somewhere else. It is the reason
393         // why text_ is not     const. But then, where else to do it?
394         // Well, how can you end up with either (a) a biblio environment that
395         // has no InsetBibitem or (b) a biblio environment with more than one
396         // InsetBibitem? I think the answer is: when paragraphs are merged;
397         // when layout is set; when material is pasted.
398         int const moveCursor = par.checkBiblio(buffer);
399         if (moveCursor > 0)
400                 const_cast<Cursor &>(bv_->cursor()).posForward();
401         else if (moveCursor < 0) {
402                 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
403                 if (cursor.pos() >= -moveCursor)
404                         cursor.posBackward();
405         }
406
407         // Optimisation: this is used in the next two loops
408         // so better to calculate that once here.
409         int const right_margin = rightMargin(pm);
410
411         // iterator pointing to paragraph to resolve macros
412         DocIterator parPos = text_->macrocontextPosition();
413         if (!parPos.empty())
414                 parPos.pit() = pit;
415         else {
416                 LYXERR(Debug::INFO, "MacroContext not initialised!"
417                         << " Going through the buffer again and hope"
418                         << " the context is better then.");
419                 bv_->buffer().updateLabels();
420                 parPos = text_->macrocontextPosition();
421                 LASSERT(!parPos.empty(), /**/);
422                 parPos.pit() = pit;
423         }
424
425         // redo insets
426         // FIXME: We should always use getFont(), see documentation of
427         // noFontChange() in Inset.h.
428         Font const bufferfont = buffer.params().getFont();
429         InsetList::const_iterator ii = par.insetList().begin();
430         InsetList::const_iterator iend = par.insetList().end();
431         for (; ii != iend; ++ii) {
432                 // position already initialized?
433                 if (!parPos.empty()) {
434                         parPos.pos() = ii->pos;
435
436                         // A macro template would normally not be visible
437                         // by itself. But the tex macro semantics allow
438                         // recursion, so we artifically take the context
439                         // after the macro template to simulate this.
440                         if (ii->inset->lyxCode() == MATHMACRO_CODE)
441                                 parPos.pos()++;
442                 }
443
444                 // do the metric calculation
445                 Dimension dim;
446                 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
447                         - right_margin;
448                 Font const & font = ii->inset->noFontChange() ?
449                         bufferfont : displayFont(pit, ii->pos);
450                 MacroContext mc(buffer, parPos);
451                 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
452                 ii->inset->metrics(mi, dim);
453                 Dimension const old_dim = pm.insetDimension(ii->inset);
454                 if (old_dim != dim) {
455                         pm.setInsetDimension(ii->inset, dim);
456                         changed = true;
457                 }
458         }
459
460         par.setBeginOfBody();
461         pos_type first = 0;
462         size_t row_index = 0;
463         // maximum pixel width of a row
464         int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
465         do {
466                 Dimension dim;
467                 pos_type end = rowBreakPoint(width, pit, first);
468                 if (row_index || end < 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
474                 dim = rowHeight(pit, first, end);
475                 dim.wid = rowWidth(right_margin, pit, first, end);
476                 if (row_index == pm.rows().size())
477                         pm.rows().push_back(Row());
478                 Row & row = pm.rows()[row_index];
479                 row.setChanged(false);
480                 row.pos(first);
481                 row.endpos(end);
482                 row.setDimension(dim);
483                 int const max_row_width = max(dim_.wid, dim.wid);
484                 computeRowMetrics(pit, row, max_row_width);
485                 first = end;
486                 ++row_index;
487
488                 pm.dim().wid = max(pm.dim().wid, dim.wid);
489                 pm.dim().des += dim.height();
490         } while (first < par.size());
491
492         if (row_index < pm.rows().size())
493                 pm.rows().resize(row_index);
494
495         // Make sure that if a par ends in newline, there is one more row
496         // under it
497         if (first > 0 && par.isNewline(first - 1)) {
498                 Dimension dim = rowHeight(pit, first, first);
499                 dim.wid = rowWidth(right_margin, pit, first, first);
500                 if (row_index == pm.rows().size())
501                         pm.rows().push_back(Row());
502                 Row & row = pm.rows()[row_index];
503                 row.setChanged(false);
504                 row.pos(first);
505                 row.endpos(first);
506                 row.setDimension(dim);
507                 int const max_row_width = max(dim_.wid, dim.wid);
508                 computeRowMetrics(pit, row, max_row_width);
509                 pm.dim().des += dim.height();
510         }
511
512         pm.dim().asc += pm.rows()[0].ascent();
513         pm.dim().des -= pm.rows()[0].ascent();
514
515         changed |= old_dim.height() != pm.dim().height();
516
517         return changed;
518 }
519
520
521 void TextMetrics::computeRowMetrics(pit_type const pit,
522                 Row & row, int width) const
523 {
524         row.label_hfill = 0;
525         row.separator = 0;
526
527         Paragraph const & par = text_->getPar(pit);
528
529         double w = width - row.width();
530         // FIXME: put back this assertion when the crash on new doc is solved.
531         //LASSERT(w >= 0, /**/);
532
533         //lyxerr << "\ndim_.wid " << dim_.wid << endl;
534         //lyxerr << "row.width() " << row.width() << endl;
535         //lyxerr << "w " << w << endl;
536
537         bool const is_rtl = text_->isRTL(par);
538         if (is_rtl)
539                 row.x = rightMargin(pit);
540         else
541                 row.x = leftMargin(max_width_, pit, row.pos());
542
543         // is there a manual margin with a manual label
544         Layout const & layout = par.layout();
545
546         if (layout.margintype == MARGIN_MANUAL
547             && layout.labeltype == LABEL_MANUAL) {
548                 /// We might have real hfills in the label part
549                 int nlh = numberOfLabelHfills(par, row);
550
551                 // A manual label par (e.g. List) has an auto-hfill
552                 // between the label text and the body of the
553                 // paragraph too.
554                 // But we don't want to do this auto hfill if the par
555                 // is empty.
556                 if (!par.empty())
557                         ++nlh;
558
559                 if (nlh && !par.getLabelWidthString().empty())
560                         row.label_hfill = labelFill(pit, row) / double(nlh);
561         }
562
563         double hfill = 0;
564         // are there any hfills in the row?
565         if (int const nh = numberOfHfills(par, row)) {
566                 if (w > 0)
567                         hfill = w / double(nh);
568         // we don't have to look at the alignment if it is ALIGN_LEFT and
569         // if the row is already larger then the permitted width as then
570         // we force the LEFT_ALIGN'edness!
571         } else if (int(row.width()) < max_width_) {
572                 // is it block, flushleft or flushright?
573                 // set x how you need it
574                 int align;
575                 if (par.params().align() == LYX_ALIGN_LAYOUT)
576                         align = layout.align;
577                 else
578                         align = par.params().align();
579
580                 // handle alignment inside tabular cells
581                 Inset const & owner = text_->inset();
582                 switch (owner.contentAlignment()) {
583                         case LYX_ALIGN_CENTER:
584                         case LYX_ALIGN_LEFT:
585                         case LYX_ALIGN_RIGHT:
586                                 if (align == LYX_ALIGN_NONE 
587                                     || align == LYX_ALIGN_BLOCK)
588                                         align = owner.contentAlignment();
589                                 break;
590                         default:
591                                 // unchanged (use align)
592                                 break;
593                 }
594
595                 // Display-style insets should always be on a centered row
596                 if (Inset const * inset = par.getInset(row.pos())) {
597                         switch (inset->display()) {
598                                 case Inset::AlignLeft:
599                                         align = LYX_ALIGN_BLOCK;
600                                         break;
601                                 case Inset::AlignCenter:
602                                         align = LYX_ALIGN_CENTER;
603                                         break;
604                                 case Inset::Inline:
605                                         // unchanged (use align)
606                                         break;
607                                 case Inset::AlignRight:
608                                         align = LYX_ALIGN_RIGHT;
609                                         break;
610                         }
611                 }
612
613                 switch (align) {
614                 case LYX_ALIGN_BLOCK: {
615                         int const ns = numberOfSeparators(par, row);
616                         bool disp_inset = false;
617                         if (row.endpos() < par.size()) {
618                                 Inset const * in = par.getInset(row.endpos());
619                                 if (in)
620                                         disp_inset = in->display();
621                         }
622                         // If we have separators, this is not the last row of a
623                         // par, does not end in newline, and is not row above a
624                         // display inset... then stretch it
625                         if (ns
626                             && row.endpos() < par.size()
627                             && !par.isNewline(row.endpos() - 1)
628                             && !disp_inset
629                                 ) {
630                                 row.separator = w / ns;
631                                 //lyxerr << "row.separator " << row.separator << endl;
632                                 //lyxerr << "ns " << ns << endl;
633                         } else if (is_rtl) {
634                                 row.x += w;
635                         }
636                         break;
637                 }
638                 case LYX_ALIGN_RIGHT:
639                         row.x += w;
640                         break;
641                 case LYX_ALIGN_CENTER:
642                         row.x += w / 2;
643                         break;
644                 }
645         }
646
647         if (is_rtl) {
648                 pos_type body_pos = par.beginOfBody();
649                 pos_type end = row.endpos();
650
651                 if (body_pos > 0
652                     && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
653                 {
654                         row.x += theFontMetrics(text_->labelFont(par)).
655                                 width(layout.labelsep);
656                         if (body_pos <= end)
657                                 row.x += row.label_hfill;
658                 }
659         }
660
661         pos_type const endpos = row.endpos();
662         pos_type body_pos = par.beginOfBody();
663         if (body_pos > 0
664                 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
665                 body_pos = 0;
666
667         ParagraphMetrics & pm = par_metrics_[pit];
668         InsetList::const_iterator ii = par.insetList().begin();
669         InsetList::const_iterator iend = par.insetList().end();
670         for ( ; ii != iend; ++ii) {
671                 if (ii->pos >= endpos || ii->pos < row.pos()
672                         || (ii->inset->lyxCode() != SPACE_CODE ||
673                             !ii->inset->isStretchableSpace()))
674                         continue;
675                 Dimension dim = row.dimension();
676                 if (pm.hfillExpansion(row, ii->pos))
677                         dim.wid = int(ii->pos >= body_pos ?
678                                 max(hfill, 5.0) : row.label_hfill);
679                 else
680                         dim.wid = 5;
681                 // Cache the inset dimension.
682                 bv_->coordCache().insets().add(ii->inset, dim);
683                 pm.setInsetDimension(ii->inset, dim);
684         }
685 }
686
687
688 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
689 {
690         Paragraph const & par = text_->getPar(pit);
691
692         pos_type last = par.beginOfBody();
693         LASSERT(last > 0, /**/);
694
695         // -1 because a label ends with a space that is in the label
696         --last;
697
698         // a separator at this end does not count
699         if (par.isLineSeparator(last))
700                 --last;
701
702         int w = 0;
703         for (pos_type i = row.pos(); i <= last; ++i)
704                 w += singleWidth(pit, i);
705
706         docstring const & label = par.params().labelWidthString();
707         if (label.empty())
708                 return 0;
709
710         FontMetrics const & fm
711                 = theFontMetrics(text_->labelFont(par));
712
713         return max(0, fm.width(label) - w);
714 }
715
716
717 // this needs special handling - only newlines count as a break point
718 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
719 {
720         pos_type const end = par.size();
721
722         for (; i < end; ++i)
723                 if (par.isNewline(i))
724                         return i + 1;
725
726         return end;
727 }
728
729
730 int TextMetrics::labelEnd(pit_type const pit) const
731 {
732         // labelEnd is only needed if the layout fills a flushleft label.
733         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
734                 return 0;
735         // return the beginning of the body
736         return leftMargin(max_width_, pit);
737 }
738
739 namespace {
740
741 /**
742  * Calling Text::getFont is slow. While rebreaking we scan a
743  * paragraph from left to right calling getFont for every char.  This
744  * simple class address this problem by hidding an optimization trick
745  * (not mine btw -AB): the font is reused in the whole font span.  The
746  * class handles transparently the "hidden" (not part of the fontlist)
747  * label font (as getFont does).
748  **/
749 class FontIterator
750 {
751 public:
752         ///
753         FontIterator(TextMetrics const & tm,
754                 Paragraph const & par, pit_type pit, pos_type pos)
755                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
756                 font_(tm.displayFont(pit, pos)),
757                 endspan_(par.fontSpan(pos).last),
758                 bodypos_(par.beginOfBody())
759         {}
760
761         ///
762         Font const & operator*() const { return font_; }
763
764         ///
765         FontIterator & operator++()
766         {
767                 ++pos_;
768                 if (pos_ > endspan_ || pos_ == bodypos_) {
769                         font_ = tm_.displayFont(pit_, pos_);
770                         endspan_ = par_.fontSpan(pos_).last;
771                 }
772                 return *this;
773         }
774
775         ///
776         Font * operator->() { return &font_; }
777
778 private:
779         ///
780         TextMetrics const & tm_;
781         ///
782         Paragraph const & par_;
783         ///
784         pit_type pit_;
785         ///
786         pos_type pos_;
787         ///
788         Font font_;
789         ///
790         pos_type endspan_;
791         ///
792         pos_type bodypos_;
793 };
794
795 } // anon namespace
796
797 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
798                 pos_type pos) const
799 {
800         ParagraphMetrics const & pm = par_metrics_[pit];
801         Paragraph const & par = text_->getPar(pit);
802         pos_type const end = par.size();
803         if (pos == end || width < 0)
804                 return end;
805
806         Layout const & layout = par.layout();
807
808         if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
809                 return addressBreakPoint(pos, par);
810
811         pos_type const body_pos = par.beginOfBody();
812
813         // check for possible inline completion
814         DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
815         pos_type inlineCompletionLPos = -1;
816         if (inlineCompletionPos.inTexted()
817             && inlineCompletionPos.text() == text_
818             && inlineCompletionPos.pit() == pit) {
819                 // draw logically behind the previous character
820                 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
821         }
822
823         // Now we iterate through until we reach the right margin
824         // or the end of the par, then choose the possible break
825         // nearest that.
826
827         int label_end = labelEnd(pit);
828         int const left = leftMargin(max_width_, pit, pos);
829         int x = left;
830
831         // pixel width since last breakpoint
832         int chunkwidth = 0;
833
834         FontIterator fi = FontIterator(*this, par, pit, pos);
835         pos_type point = end;
836         pos_type i = pos;
837         for ( ; i < end; ++i, ++fi) {
838                 int thiswidth = pm.singleWidth(i, *fi);
839
840                 // add inline completion width
841                 if (inlineCompletionLPos == i) {
842                         docstring const & completion = bv_->inlineCompletion();
843                         if (completion.length() > 0)
844                                 thiswidth += theFontMetrics(*fi).width(completion);
845                 }
846
847                 // add the auto-hfill from label end to the body
848                 if (body_pos && i == body_pos) {
849                         FontMetrics const & fm = theFontMetrics(
850                                 text_->labelFont(par));
851                         int add = fm.width(layout.labelsep);
852                         if (par.isLineSeparator(i - 1))
853                                 add -= singleWidth(pit, i - 1);
854
855                         add = max(add, label_end - x);
856                         thiswidth += add;
857                 }
858
859                 x += thiswidth;
860                 chunkwidth += thiswidth;
861
862                 // break before a character that will fall off
863                 // the right of the row
864                 if (x >= width) {
865                         // if no break before, break here
866                         if (point == end || chunkwidth >= width - left) {
867                                 if (i > pos)
868                                         point = i;
869                                 else
870                                         point = i + 1;
871                         }
872                         // exit on last registered breakpoint:
873                         break;
874                 }
875
876                 if (par.isNewline(i)) {
877                         point = i + 1;
878                         break;
879                 }
880                 Inset const * inset = 0;
881                 // Break before...
882                 if (i + 1 < end) {
883                         if ((inset = par.getInset(i + 1)) && inset->display()) {
884                                 point = i + 1;
885                                 break;
886                         }
887                         // ...and after.
888                         if ((inset = par.getInset(i)) && inset->display()) {
889                                 point = i + 1;
890                                 break;
891                         }
892                 }
893
894                 inset = par.getInset(i);
895                 if (!inset || inset->isChar()) {
896                         // some insets are line separators too
897                         if (par.isLineSeparator(i)) {
898                                 // register breakpoint:
899                                 point = i + 1;
900                                 chunkwidth = 0;
901                         }
902                 }
903         }
904
905         // maybe found one, but the par is short enough.
906         if (i == end && x < width)
907                 point = end;
908
909         // manual labels cannot be broken in LaTeX. But we
910         // want to make our on-screen rendering of footnotes
911         // etc. still break
912         if (body_pos && point < body_pos)
913                 point = body_pos;
914
915         return point;
916 }
917
918
919 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
920                 pos_type const first, pos_type const end) const
921 {
922         // get the pure distance
923         ParagraphMetrics const & pm = par_metrics_[pit];
924         Paragraph const & par = text_->getPar(pit);
925         int w = leftMargin(max_width_, pit, first);
926         int label_end = labelEnd(pit);
927
928         // check for possible inline completion
929         DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
930         pos_type inlineCompletionLPos = -1;
931         if (inlineCompletionPos.inTexted()
932             && inlineCompletionPos.text() == text_
933             && inlineCompletionPos.pit() == pit) {
934                 // draw logically behind the previous character
935                 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
936         }
937
938         pos_type const body_pos = par.beginOfBody();
939         pos_type i = first;
940
941         if (i < end) {
942                 FontIterator fi = FontIterator(*this, par, pit, i);
943                 for ( ; i < end; ++i, ++fi) {
944                         if (body_pos > 0 && i == body_pos) {
945                                 FontMetrics const & fm = theFontMetrics(
946                                         text_->labelFont(par));
947                                 w += fm.width(par.layout().labelsep);
948                                 if (par.isLineSeparator(i - 1))
949                                         w -= singleWidth(pit, i - 1);
950                                 w = max(w, label_end);
951                         }
952                         
953                         // a line separator at the end of a line (but not at the end of a 
954                         // paragraph) will not be drawn and should therefore not count for
955                         // the row width.
956                         if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
957                                 w += pm.singleWidth(i, *fi);
958
959                         // add inline completion width
960                         if (inlineCompletionLPos == i) {
961                                 docstring const & completion = bv_->inlineCompletion();
962                                 if (completion.length() > 0)
963                                         w += theFontMetrics(*fi).width(completion);
964                         }
965                 }
966         }
967
968         if (body_pos > 0 && body_pos >= end) {
969                 FontMetrics const & fm = theFontMetrics(
970                         text_->labelFont(par));
971                 w += fm.width(par.layout().labelsep);
972                 if (end > 0 && par.isLineSeparator(end - 1))
973                         w -= singleWidth(pit, end - 1);
974                 w = max(w, label_end);
975         }
976
977         return w + right_margin;
978 }
979
980
981 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
982                 pos_type const end, bool topBottomSpace) const
983 {
984         Paragraph const & par = text_->getPar(pit);
985         // get the maximum ascent and the maximum descent
986         double layoutasc = 0;
987         double layoutdesc = 0;
988         double const dh = defaultRowHeight();
989
990         // ok, let us initialize the maxasc and maxdesc value.
991         // Only the fontsize count. The other properties
992         // are taken from the layoutfont. Nicer on the screen :)
993         Layout const & layout = par.layout();
994
995         // as max get the first character of this row then it can
996         // increase but not decrease the height. Just some point to
997         // start with so we don't have to do the assignment below too
998         // often.
999         Buffer const & buffer = bv_->buffer();
1000         Font font = displayFont(pit, first);
1001         FontSize const tmpsize = font.fontInfo().size();
1002         font.fontInfo() = text_->layoutFont(pit);
1003         FontSize const size = font.fontInfo().size();
1004         font.fontInfo().setSize(tmpsize);
1005
1006         FontInfo labelfont = text_->labelFont(par);
1007
1008         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1009         FontMetrics const & fontmetrics = theFontMetrics(font);
1010
1011         // these are minimum values
1012         double const spacing_val = layout.spacing.getValue()
1013                 * text_->spacing(par);
1014         //lyxerr << "spacing_val = " << spacing_val << endl;
1015         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
1016         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1017
1018         // insets may be taller
1019         ParagraphMetrics const & pm = par_metrics_[pit];
1020         InsetList::const_iterator ii = par.insetList().begin();
1021         InsetList::const_iterator iend = par.insetList().end();
1022         for ( ; ii != iend; ++ii) {
1023                 if (ii->pos >= first && ii->pos < end) {
1024                         Dimension const & dim = pm.insetDimension(ii->inset);
1025                         maxasc  = max(maxasc,  dim.ascent());
1026                         maxdesc = max(maxdesc, dim.descent());
1027                 }
1028         }
1029
1030         // Check if any custom fonts are larger (Asger)
1031         // This is not completely correct, but we can live with the small,
1032         // cosmetic error for now.
1033         int labeladdon = 0;
1034
1035         FontSize maxsize =
1036                 par.highestFontInRange(first, end, size);
1037         if (maxsize > font.fontInfo().size()) {
1038                 // use standard paragraph font with the maximal size
1039                 FontInfo maxfont = font.fontInfo();
1040                 maxfont.setSize(maxsize);
1041                 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1042                 maxasc  = max(maxasc,  maxfontmetrics.maxAscent());
1043                 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1044         }
1045
1046         // This is nicer with box insets:
1047         ++maxasc;
1048         ++maxdesc;
1049
1050         ParagraphList const & pars = text_->paragraphs();
1051         Inset const & inset = text_->inset();
1052
1053         // is it a top line?
1054         if (first == 0 && topBottomSpace) {
1055                 BufferParams const & bufparams = buffer.params();
1056                 // some parskips VERY EASY IMPLEMENTATION
1057                 if (bufparams.paragraph_separation
1058                     == BufferParams::ParagraphSkipSeparation
1059                         && inset.lyxCode() != ERT_CODE
1060                         && inset.lyxCode() != LISTINGS_CODE
1061                         && pit > 0
1062                         && ((layout.isParagraph() && par.getDepth() == 0)
1063                             || (pars[pit - 1].layout().isParagraph()
1064                                 && pars[pit - 1].getDepth() == 0)))
1065                 {
1066                                 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1067                 }
1068
1069                 if (par.params().startOfAppendix())
1070                         maxasc += int(3 * dh);
1071
1072                 // This is special code for the chapter, since the label of this
1073                 // layout is printed in an extra row
1074                 if (layout.counter == "chapter"
1075                     && !par.params().labelString().empty()) {
1076                         labeladdon = int(labelfont_metrics.maxHeight()
1077                                      * layout.spacing.getValue()
1078                                      * text_->spacing(par));
1079                 }
1080
1081                 // special code for the top label
1082                 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1083                      || layout.labeltype == LABEL_BIBLIO
1084                      || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1085                     && text_->isFirstInSequence(pit)
1086                     && !par.labelString().empty())
1087                 {
1088                         labeladdon = int(
1089                                   labelfont_metrics.maxHeight()
1090                                         * layout.spacing.getValue()
1091                                         * text_->spacing(par)
1092                                 + (layout.topsep + layout.labelbottomsep) * dh);
1093                 }
1094
1095                 // Add the layout spaces, for example before and after
1096                 // a section, or between the items of a itemize or enumerate
1097                 // environment.
1098
1099                 pit_type prev = text_->depthHook(pit, par.getDepth());
1100                 Paragraph const & prevpar = pars[prev];
1101                 if (prev != pit
1102                     && prevpar.layout() == layout
1103                     && prevpar.getDepth() == par.getDepth()
1104                     && prevpar.getLabelWidthString()
1105                                         == par.getLabelWidthString()) {
1106                         layoutasc = layout.itemsep * dh;
1107                 } else if (pit != 0 || first != 0) {
1108                         if (layout.topsep > 0)
1109                                 layoutasc = layout.topsep * dh;
1110                 }
1111
1112                 prev = text_->outerHook(pit);
1113                 if (prev != pit_type(pars.size())) {
1114                         maxasc += int(pars[prev].layout().parsep * dh);
1115                 } else if (pit != 0) {
1116                         Paragraph const & prevpar = pars[pit - 1];
1117                         if (prevpar.getDepth() != 0 ||
1118                                         prevpar.layout() == layout) {
1119                                 maxasc += int(layout.parsep * dh);
1120                         }
1121                 }
1122         }
1123
1124         // is it a bottom line?
1125         if (end >= par.size() && topBottomSpace) {
1126                 // add the layout spaces, for example before and after
1127                 // a section, or between the items of a itemize or enumerate
1128                 // environment
1129                 pit_type nextpit = pit + 1;
1130                 if (nextpit != pit_type(pars.size())) {
1131                         pit_type cpit = pit;
1132                         double usual = 0;
1133                         double unusual = 0;
1134
1135                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1136                                 usual = pars[cpit].layout().bottomsep * dh;
1137                                 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1138                                 if (pars[cpit].layout() != pars[nextpit].layout()
1139                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1140                                 {
1141                                         unusual = pars[cpit].layout().bottomsep * dh;
1142                                 }
1143                                 layoutdesc = max(unusual, usual);
1144                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1145                                 if (pars[cpit].layout() != pars[nextpit].layout()
1146                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1147                                         layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1148                         }
1149                 }
1150         }
1151
1152         // incalculate the layout spaces
1153         maxasc  += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
1154         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1155
1156         // FIXME: the correct way is to do the following is to move the
1157         // following code in another method specially tailored for the
1158         // main Text. The following test is thus bogus.
1159         // Top and bottom margin of the document (only at top-level)
1160         if (main_text_ && topBottomSpace) {
1161                 if (pit == 0 && first == 0)
1162                         maxasc += 20;
1163                 if (pit + 1 == pit_type(pars.size()) &&
1164                     end == par.size() &&
1165                                 !(end > 0 && par.isNewline(end - 1)))
1166                         maxdesc += 20;
1167         }
1168
1169         return Dimension(0, maxasc + labeladdon, maxdesc);
1170 }
1171
1172
1173 // x is an absolute screen coord
1174 // returns the column near the specified x-coordinate of the row
1175 // x is set to the real beginning of this column
1176 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1177                 Row const & row, int & x, bool & boundary) const
1178 {
1179         Buffer const & buffer = bv_->buffer();
1180
1181         /// For the main Text, it is possible that this pit is not
1182         /// yet in the CoordCache when moving cursor up.
1183         /// x Paragraph coordinate is always 0 for main text anyway.
1184         int const xo = origin_.x_;
1185         x -= xo;
1186         Paragraph const & par = text_->getPar(pit);
1187         Bidi bidi;
1188         bidi.computeTables(par, buffer, row);
1189
1190         pos_type vc = row.pos();
1191         pos_type end = row.endpos();
1192         pos_type c = 0;
1193         Layout const & layout = par.layout();
1194
1195         bool left_side = false;
1196
1197         pos_type body_pos = par.beginOfBody();
1198
1199         double tmpx = row.x;
1200         double last_tmpx = tmpx;
1201
1202         if (body_pos > 0 &&
1203             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1204                 body_pos = 0;
1205
1206         // check for empty row
1207         if (vc == end) {
1208                 x = int(tmpx) + xo;
1209                 return 0;
1210         }
1211
1212         while (vc < end && tmpx <= x) {
1213                 c = bidi.vis2log(vc);
1214                 last_tmpx = tmpx;
1215                 if (body_pos > 0 && c == body_pos - 1) {
1216                         FontMetrics const & fm = theFontMetrics(
1217                                 text_->labelFont(par));
1218                         tmpx += row.label_hfill + fm.width(layout.labelsep);
1219                         if (par.isLineSeparator(body_pos - 1))
1220                                 tmpx -= singleWidth(pit, body_pos - 1);
1221                 }
1222
1223                 tmpx += singleWidth(pit, c);
1224                 if (par.isSeparator(c) && c >= body_pos)
1225                                 tmpx += row.separator;
1226                 ++vc;
1227         }
1228
1229         if ((tmpx + last_tmpx) / 2 > x) {
1230                 tmpx = last_tmpx;
1231                 left_side = true;
1232         }
1233
1234         LASSERT(vc <= end, /**/);  // This shouldn't happen.
1235
1236         boundary = false;
1237         // This (rtl_support test) is not needed, but gives
1238         // some speedup if rtl_support == false
1239         bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1240
1241         // If lastrow is false, we don't need to compute
1242         // the value of rtl.
1243         bool const rtl = lastrow ? text_->isRTL(par) : false;
1244         if (lastrow &&
1245             ((rtl  &&  left_side && vc == row.pos() && x < tmpx - 5) ||
1246              (!rtl && !left_side && vc == end  && x > tmpx + 5))) {
1247                 if (!par.isNewline(end - 1))
1248                         c = end;
1249         } else if (vc == row.pos()) {
1250                 c = bidi.vis2log(vc);
1251                 if (bidi.level(c) % 2 == 1)
1252                         ++c;
1253         } else {
1254                 c = bidi.vis2log(vc - 1);
1255                 bool const rtl = (bidi.level(c) % 2 == 1);
1256                 if (left_side == rtl) {
1257                         ++c;
1258                         boundary = isRTLBoundary(pit, c);
1259                 }
1260         }
1261
1262 // I believe this code is not needed anymore (Jug 20050717)
1263 #if 0
1264         // The following code is necessary because the cursor position past
1265         // the last char in a row is logically equivalent to that before
1266         // the first char in the next row. That's why insets causing row
1267         // divisions -- Newline and display-style insets -- must be treated
1268         // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1269         // Newline inset, air gap below:
1270         if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1271                 if (bidi.level(end -1) % 2 == 0)
1272                         tmpx -= singleWidth(pit, end - 1);
1273                 else
1274                         tmpx += singleWidth(pit, end - 1);
1275                 c = end - 1;
1276         }
1277
1278         // Air gap above display inset:
1279         if (row.pos() < end && c >= end && end < par.size()
1280             && par.isInset(end) && par.getInset(end)->display()) {
1281                 c = end - 1;
1282         }
1283         // Air gap below display inset:
1284         if (row.pos() < end && c >= end && par.isInset(end - 1)
1285             && par.getInset(end - 1)->display()) {
1286                 c = end - 1;
1287         }
1288 #endif
1289
1290         x = int(tmpx) + xo;
1291         pos_type const col = c - row.pos();
1292
1293         if (!c || end == par.size())
1294                 return col;
1295
1296         if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1297                 boundary = true;
1298                 return col;
1299         }
1300
1301         return min(col, end - 1 - row.pos());
1302 }
1303
1304
1305 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1306 {
1307         // We play safe and use parMetrics(pit) to make sure the
1308         // ParagraphMetrics will be redone and OK to use if needed.
1309         // Otherwise we would use an empty ParagraphMetrics in
1310         // upDownInText() while in selection mode.
1311         ParagraphMetrics const & pm = parMetrics(pit);
1312
1313         LASSERT(row < int(pm.rows().size()), /**/);
1314         bool bound = false;
1315         Row const & r = pm.rows()[row];
1316         return r.pos() + getColumnNearX(pit, r, x, bound);
1317 }
1318
1319
1320 void TextMetrics::newParMetricsDown()
1321 {
1322         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1323         pit_type const pit = last.first + 1;
1324         if (pit == int(text_->paragraphs().size()))
1325                 return;
1326
1327         // do it and update its position.
1328         redoParagraph(pit);
1329         par_metrics_[pit].setPosition(last.second.position()
1330                 + last.second.descent() + par_metrics_[pit].ascent());
1331 }
1332
1333
1334 void TextMetrics::newParMetricsUp()
1335 {
1336         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1337         if (first.first == 0)
1338                 return;
1339
1340         pit_type const pit = first.first - 1;
1341         // do it and update its position.
1342         redoParagraph(pit);
1343         par_metrics_[pit].setPosition(first.second.position()
1344                 - first.second.ascent() - par_metrics_[pit].descent());
1345 }
1346
1347 // y is screen coordinate
1348 pit_type TextMetrics::getPitNearY(int y)
1349 {
1350         LASSERT(!text_->paragraphs().empty(), return -1);
1351         LASSERT(!par_metrics_.empty(), return -1);
1352         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1353
1354         // look for highest numbered paragraph with y coordinate less than given y
1355         pit_type pit = -1;
1356         int yy = -1;
1357         ParMetricsCache::const_iterator it = par_metrics_.begin();
1358         ParMetricsCache::const_iterator et = par_metrics_.end();
1359         ParMetricsCache::const_iterator last = et; last--;
1360
1361         ParagraphMetrics const & pm = it->second;
1362
1363         if (y < it->second.position() - int(pm.ascent())) {
1364                 // We are looking for a position that is before the first paragraph in
1365                 // the cache (which is in priciple off-screen, that is before the
1366                 // visible part.
1367                 if (it->first == 0)
1368                         // We are already at the first paragraph in the inset.
1369                         return 0;
1370                 // OK, this is the paragraph we are looking for.
1371                 pit = it->first - 1;
1372                 newParMetricsUp();
1373                 return pit;
1374         }
1375
1376         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1377
1378         if (y >= last->second.position() + int(pm_last.descent())) {
1379                 // We are looking for a position that is after the last paragraph in
1380                 // the cache (which is in priciple off-screen), that is before the
1381                 // visible part.
1382                 pit = last->first + 1;
1383                 if (pit == int(text_->paragraphs().size()))
1384                         //  We are already at the last paragraph in the inset.
1385                         return last->first;
1386                 // OK, this is the paragraph we are looking for.
1387                 newParMetricsDown();
1388                 return pit;
1389         }
1390
1391         for (; it != et; ++it) {
1392                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1393                         << " y: " << it->second.position());
1394
1395                 ParagraphMetrics const & pm = par_metrics_[it->first];
1396
1397                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1398                         pit = it->first;
1399                         yy = it->second.position();
1400                 }
1401         }
1402
1403         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1404
1405         return pit;
1406 }
1407
1408
1409 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1410         bool assert_in_view, bool up)
1411 {
1412         ParagraphMetrics const & pm = par_metrics_[pit];
1413
1414         int yy = pm.position() - pm.ascent();
1415         LASSERT(!pm.rows().empty(), /**/);
1416         RowList::const_iterator rit = pm.rows().begin();
1417         RowList::const_iterator rlast = pm.rows().end();
1418         --rlast;
1419         for (; rit != rlast; yy += rit->height(), ++rit)
1420                 if (yy + rit->height() > y)
1421                         break;
1422
1423         if (assert_in_view && yy + rit->height() != y) {
1424                 if (!up) {
1425                         if (rit != pm.rows().begin()) {
1426                                 y = yy;
1427                                 --rit;
1428                         } else if (pit != 0) {
1429                                 --pit;
1430                                 newParMetricsUp();
1431                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1432                                 rit = pm2.rows().end();
1433                                 --rit;
1434                                 y = yy;
1435                         }
1436                 } else  {
1437                         if (rit != rlast) {
1438                                 y = yy + rit->height();
1439                                 ++rit;
1440                         } else if (pit != int(par_metrics_.size())) {
1441                                 ++pit;
1442                                 newParMetricsDown();
1443                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1444                                 rit = pm2.rows().begin();
1445                                 y = pm2.position();
1446                         }
1447                 }
1448         }
1449         return *rit;
1450 }
1451
1452
1453 // x,y are absolute screen coordinates
1454 // sets cursor recursively descending into nested editable insets
1455 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1456         bool assert_in_view, bool up)
1457 {
1458         if (lyxerr.debugging(Debug::WORKAREA)) {
1459                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1460                 cur.bv().coordCache().dump();
1461         }
1462         pit_type pit = getPitNearY(y);
1463         LASSERT(pit != -1, return 0);
1464         
1465         int yy = y; // is modified by getPitAndRowNearY
1466         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1467         bool bound = false;
1468
1469         int xx = x; // is modified by getColumnNearX
1470         pos_type const pos = row.pos()
1471                 + getColumnNearX(pit, row, xx, bound);
1472         cur.pit() = pit;
1473         cur.pos() = pos;
1474         cur.boundary(bound);
1475         cur.setTargetX(x);
1476
1477         // try to descend into nested insets
1478         Inset * inset = checkInsetHit(x, yy);
1479         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1480         if (!inset) {
1481                 // Either we deconst editXY or better we move current_font
1482                 // and real_current_font to Cursor
1483                 // FIXME: what is needed now that current_font and real_current_font
1484                 // are transferred?
1485                 cur.setCurrentFont();
1486                 return 0;
1487         }
1488
1489         ParagraphList const & pars = text_->paragraphs();
1490         Inset const * insetBefore = pos ? pars[pit].getInset(pos - 1) : 0;
1491         //Inset * insetBehind = pars[pit].getInset(pos);
1492
1493         // This should be just before or just behind the
1494         // cursor position set above.
1495         LASSERT((pos != 0 && inset == insetBefore)
1496                 || inset == pars[pit].getInset(pos), /**/);
1497
1498         // Make sure the cursor points to the position before
1499         // this inset.
1500         if (inset == insetBefore) {
1501                 --cur.pos();
1502                 cur.boundary(false);
1503         }
1504
1505         // Try to descend recursively inside the inset.
1506         inset = inset->editXY(cur, x, yy);
1507
1508         if (cur.top().text() == text_)
1509                 cur.setCurrentFont();
1510         return inset;
1511 }
1512
1513
1514 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1515 {
1516         LASSERT(text_ == cur.text(), /**/);
1517         pit_type pit = getPitNearY(y);
1518         LASSERT(pit != -1, return);
1519
1520         ParagraphMetrics const & pm = par_metrics_[pit];
1521
1522         int yy = pm.position() - pm.ascent();
1523         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1524                 " pit: " << pit << " yy: " << yy);
1525
1526         int r = 0;
1527         LASSERT(pm.rows().size(), /**/);
1528         for (; r < int(pm.rows().size()) - 1; ++r) {
1529                 Row const & row = pm.rows()[r];
1530                 if (int(yy + row.height()) > y)
1531                         break;
1532                 yy += row.height();
1533         }
1534
1535         Row const & row = pm.rows()[r];
1536
1537         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1538
1539         bool bound = false;
1540         int xx = x;
1541         pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1542
1543         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1544
1545         text_->setCursor(cur, pit, pos, true, bound);
1546         // remember new position.
1547         cur.setTargetX();
1548 }
1549
1550
1551 //takes screen x,y coordinates
1552 Inset * TextMetrics::checkInsetHit(int x, int y)
1553 {
1554         pit_type pit = getPitNearY(y);
1555         LASSERT(pit != -1, return 0);
1556
1557         Paragraph const & par = text_->paragraphs()[pit];
1558         ParagraphMetrics const & pm = par_metrics_[pit];
1559
1560         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1561
1562         InsetList::const_iterator iit = par.insetList().begin();
1563         InsetList::const_iterator iend = par.insetList().end();
1564         for (; iit != iend; ++iit) {
1565                 Inset * inset = iit->inset;
1566
1567                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1568
1569                 if (!bv_->coordCache().getInsets().has(inset)) {
1570                         LYXERR(Debug::DEBUG, "inset has no cached position");
1571                         return 0;
1572                 }
1573
1574                 Dimension const & dim = pm.insetDimension(inset);
1575                 Point p = bv_->coordCache().getInsets().xy(inset);
1576
1577                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1578                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1579
1580                 if (x >= p.x_
1581                         && x <= p.x_ + dim.wid
1582                         && y >= p.y_ - dim.asc
1583                         && y <= p.y_ + dim.des) {
1584                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1585                         return inset;
1586                 }
1587         }
1588
1589         LYXERR(Debug::DEBUG, "No inset hit. ");
1590         return 0;
1591 }
1592
1593
1594 int TextMetrics::cursorX(CursorSlice const & sl,
1595                 bool boundary) const
1596 {
1597         LASSERT(sl.text() == text_, /**/);
1598         pit_type const pit = sl.pit();
1599         Paragraph const & par = text_->paragraphs()[pit];
1600         ParagraphMetrics const & pm = par_metrics_[pit];
1601         if (pm.rows().empty())
1602                 return 0;
1603
1604         pos_type ppos = sl.pos();
1605         // Correct position in front of big insets
1606         bool const boundary_correction = ppos != 0 && boundary;
1607         if (boundary_correction)
1608                 --ppos;
1609
1610         Row const & row = pm.getRow(sl.pos(), boundary);
1611
1612         pos_type cursor_vpos = 0;
1613
1614         Buffer const & buffer = bv_->buffer();
1615         double x = row.x;
1616         Bidi bidi;
1617         bidi.computeTables(par, buffer, row);
1618
1619         pos_type const row_pos  = row.pos();
1620         pos_type const end      = row.endpos();
1621         // Spaces at logical line breaks in bidi text must be skipped during
1622         // cursor positioning. However, they may appear visually in the middle
1623         // of a row; they must be skipped, wherever they are...
1624         // * logically "abc_[HEBREW_\nHEBREW]"
1625         // * visually "abc_[_WERBEH\nWERBEH]"
1626         pos_type skipped_sep_vpos = -1;
1627
1628         if (end <= row_pos)
1629                 cursor_vpos = row_pos;
1630         else if (ppos >= end)
1631                 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1632         else if (ppos > row_pos && ppos >= end)
1633                 // Place cursor after char at (logical) position pos - 1
1634                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1635                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1636         else
1637                 // Place cursor before char at (logical) position ppos
1638                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1639                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1640
1641         pos_type body_pos = par.beginOfBody();
1642         if (body_pos > 0 &&
1643             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1644                 body_pos = 0;
1645
1646         // check for possible inline completion in this row
1647         DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1648         pos_type inlineCompletionVPos = -1;
1649         if (inlineCompletionPos.inTexted()
1650             && inlineCompletionPos.text() == text_
1651             && inlineCompletionPos.pit() == pit
1652             && inlineCompletionPos.pos() - 1 >= row_pos
1653             && inlineCompletionPos.pos() - 1 < end) {
1654                 // draw logically behind the previous character
1655                 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1656         }
1657
1658         // Use font span to speed things up, see below
1659         FontSpan font_span;
1660         Font font;
1661
1662         // If the last logical character is a separator, skip it, unless
1663         // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1664         if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1665                 skipped_sep_vpos = bidi.log2vis(end - 1);
1666
1667         // Inline completion RTL special case row_pos == cursor_pos:
1668         // "__|b" => cursor_pos is right of __
1669         if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1670                 font = displayFont(pit, row_pos + 1);
1671                 docstring const & completion = bv_->inlineCompletion();
1672                 if (font.isRightToLeft() && completion.length() > 0)
1673                         x += theFontMetrics(font.fontInfo()).width(completion);
1674         }
1675
1676         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1677                 // Skip the separator which is at the logical end of the row
1678                 if (vpos == skipped_sep_vpos)
1679                         continue;
1680                 pos_type pos = bidi.vis2log(vpos);
1681                 if (body_pos > 0 && pos == body_pos - 1) {
1682                         FontMetrics const & labelfm = theFontMetrics(
1683                                 text_->labelFont(par));
1684                         x += row.label_hfill + labelfm.width(par.layout().labelsep);
1685                         if (par.isLineSeparator(body_pos - 1))
1686                                 x -= singleWidth(pit, body_pos - 1);
1687                 }
1688
1689                 // Use font span to speed things up, see above
1690                 if (pos < font_span.first || pos > font_span.last) {
1691                         font_span = par.fontSpan(pos);
1692                         font = displayFont(pit, pos);
1693                 }
1694
1695                 x += pm.singleWidth(pos, font);
1696
1697                 // Inline completion RTL case:
1698                 // "a__|b", __ of b => non-boundary a-pos is right of __
1699                 if (vpos + 1 == inlineCompletionVPos
1700                     && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1701                         font = displayFont(pit, vpos + 1);
1702                         docstring const & completion = bv_->inlineCompletion();
1703                         if (font.isRightToLeft() && completion.length() > 0)
1704                                 x += theFontMetrics(font.fontInfo()).width(completion);
1705                 }
1706
1707                 //  Inline completion LTR case:
1708                 // "b|__a", __ of b => non-boundary a-pos is in front of __
1709                 if (vpos == inlineCompletionVPos
1710                     && (vpos + 1 < cursor_vpos || boundary_correction)) {
1711                         font = displayFont(pit, vpos);
1712                         docstring const & completion = bv_->inlineCompletion();
1713                         if (!font.isRightToLeft() && completion.length() > 0)
1714                                 x += theFontMetrics(font.fontInfo()).width(completion);
1715                 }
1716
1717                 if (par.isSeparator(pos) && pos >= body_pos)
1718                         x += row.separator;
1719         }
1720
1721         // see correction above
1722         if (boundary_correction) {
1723                 if (isRTL(sl, boundary))
1724                         x -= singleWidth(pit, ppos);
1725                 else
1726                         x += singleWidth(pit, ppos);
1727         }
1728
1729         return int(x);
1730 }
1731
1732
1733 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1734 {
1735         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1736         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1737         if (pm.rows().empty())
1738                 return 0;
1739
1740         int h = 0;
1741         h -= par_metrics_[0].rows()[0].ascent();
1742         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1743                 h += par_metrics_[pit].height();
1744         }
1745         int pos = sl.pos();
1746         if (pos && boundary)
1747                 --pos;
1748         size_t const rend = pm.pos2row(pos);
1749         for (size_t rit = 0; rit != rend; ++rit)
1750                 h += pm.rows()[rit].height();
1751         h += pm.rows()[rend].ascent();
1752         return h;
1753 }
1754
1755
1756 // the cursor set functions have a special mechanism. When they
1757 // realize you left an empty paragraph, they will delete it.
1758
1759 bool TextMetrics::cursorHome(Cursor & cur)
1760 {
1761         LASSERT(text_ == cur.text(), /**/);
1762         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1763         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1764         return text_->setCursor(cur, cur.pit(), row.pos());
1765 }
1766
1767
1768 bool TextMetrics::cursorEnd(Cursor & cur)
1769 {
1770         LASSERT(text_ == cur.text(), /**/);
1771         // if not on the last row of the par, put the cursor before
1772         // the final space exept if I have a spanning inset or one string
1773         // is so long that we force a break.
1774         pos_type end = cur.textRow().endpos();
1775         if (end == 0)
1776                 // empty text, end-1 is no valid position
1777                 return false;
1778         bool boundary = false;
1779         if (end != cur.lastpos()) {
1780                 if (!cur.paragraph().isLineSeparator(end-1)
1781                     && !cur.paragraph().isNewline(end-1))
1782                         boundary = true;
1783                 else
1784                         --end;
1785         }
1786         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1787 }
1788
1789
1790 void TextMetrics::deleteLineForward(Cursor & cur)
1791 {
1792         LASSERT(text_ == cur.text(), /**/);
1793         if (cur.lastpos() == 0) {
1794                 // Paragraph is empty, so we just go forward
1795                 text_->cursorForward(cur);
1796         } else {
1797                 cur.resetAnchor();
1798                 cur.setSelection(true); // to avoid deletion
1799                 cursorEnd(cur);
1800                 cur.setSelection();
1801                 // What is this test for ??? (JMarc)
1802                 if (!cur.selection())
1803                         text_->deleteWordForward(cur);
1804                 else
1805                         cap::cutSelection(cur, true, false);
1806                 cur.checkBufferStructure();
1807         }
1808 }
1809
1810
1811 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1812 {
1813         ParagraphList const & pars = text_->paragraphs();
1814         return row.endpos() >= pars[pit].size()
1815                 && pit + 1 == pit_type(pars.size());
1816 }
1817
1818
1819 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1820 {
1821         return row.pos() == 0 && pit == 0;
1822 }
1823
1824
1825 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1826 {
1827         LASSERT(pit >= 0, /**/);
1828         LASSERT(pit < int(text_->paragraphs().size()), /**/);
1829         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1830 }
1831
1832
1833 int TextMetrics::leftMargin(int max_width,
1834                 pit_type const pit, pos_type const pos) const
1835 {
1836         ParagraphList const & pars = text_->paragraphs();
1837
1838         LASSERT(pit >= 0, /**/);
1839         LASSERT(pit < int(pars.size()), /**/);
1840         Paragraph const & par = pars[pit];
1841         LASSERT(pos >= 0, /**/);
1842         LASSERT(pos <= par.size(), /**/);
1843         Buffer const & buffer = bv_->buffer();
1844         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1845         DocumentClass const & tclass = buffer.params().documentClass();
1846         Layout const & layout = par.layout();
1847
1848         docstring parindent = layout.parindent;
1849
1850         int l_margin = 0;
1851
1852         if (text_->isMainText())
1853                 l_margin += bv_->leftMargin();
1854
1855         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1856                 tclass.leftmargin());
1857
1858         if (par.getDepth() != 0) {
1859                 // find the next level paragraph
1860                 pit_type newpar = text_->outerHook(pit);
1861                 if (newpar != pit_type(pars.size())) {
1862                         if (pars[newpar].layout().isEnvironment()) {
1863                                 l_margin = leftMargin(max_width, newpar);
1864                         }
1865                         if (tclass.isDefaultLayout(par.layout())
1866                             || tclass.isPlainLayout(par.layout())) {
1867                                 if (pars[newpar].params().noindent())
1868                                         parindent.erase();
1869                                 else
1870                                         parindent = pars[newpar].layout().parindent;
1871                         }
1872                 }
1873         }
1874
1875         // This happens after sections in standard classes. The 1.3.x
1876         // code compared depths too, but it does not seem necessary
1877         // (JMarc)
1878         if (tclass.isDefaultLayout(par.layout())
1879             && pit > 0 && pars[pit - 1].layout().nextnoindent)
1880                 parindent.erase();
1881
1882         FontInfo const labelfont = text_->labelFont(par);
1883         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1884
1885         switch (layout.margintype) {
1886         case MARGIN_DYNAMIC:
1887                 if (!layout.leftmargin.empty()) {
1888                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1889                                 layout.leftmargin);
1890                 }
1891                 if (!par.labelString().empty()) {
1892                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1893                         l_margin += labelfont_metrics.width(par.labelString());
1894                         l_margin += labelfont_metrics.width(layout.labelsep);
1895                 }
1896                 break;
1897
1898         case MARGIN_MANUAL: {
1899                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1900                 // The width of an empty par, even with manual label, should be 0
1901                 if (!par.empty() && pos >= par.beginOfBody()) {
1902                         if (!par.getLabelWidthString().empty()) {
1903                                 docstring labstr = par.getLabelWidthString();
1904                                 l_margin += labelfont_metrics.width(labstr);
1905                                 l_margin += labelfont_metrics.width(layout.labelsep);
1906                         }
1907                 }
1908                 break;
1909         }
1910
1911         case MARGIN_STATIC: {
1912                 l_margin += theFontMetrics(buffer.params().getFont()).
1913                         signedWidth(layout.leftmargin) * 4      / (par.getDepth() + 4);
1914                 break;
1915         }
1916
1917         case MARGIN_FIRST_DYNAMIC:
1918                 if (layout.labeltype == LABEL_MANUAL) {
1919                         // if we are at position 0, we are never in the body
1920                         if (pos > 0 && pos >= par.beginOfBody())
1921                                 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1922                         else
1923                                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1924                 } else if (pos != 0
1925                            // Special case to fix problems with
1926                            // theorems (JMarc)
1927                            || (layout.labeltype == LABEL_STATIC
1928                                && layout.latextype == LATEX_ENVIRONMENT
1929                                && !text_->isFirstInSequence(pit))) {
1930                         l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1931                 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1932                            && layout.labeltype != LABEL_BIBLIO
1933                            && layout.labeltype !=
1934                            LABEL_CENTERED_TOP_ENVIRONMENT) {
1935                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1936                         l_margin += labelfont_metrics.width(layout.labelsep);
1937                         l_margin += labelfont_metrics.width(par.labelString());
1938                 }
1939                 break;
1940
1941         case MARGIN_RIGHT_ADDRESS_BOX: {
1942 #if 0
1943                 // ok, a terrible hack. The left margin depends on the widest
1944                 // row in this paragraph.
1945                 RowList::iterator rit = par.rows().begin();
1946                 RowList::iterator end = par.rows().end();
1947                 // FIXME: This is wrong.
1948                 int minfill = max_width;
1949                 for ( ; rit != end; ++rit)
1950                         if (rit->fill() < minfill)
1951                                 minfill = rit->fill();
1952                 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1953                 l_margin += minfill;
1954 #endif
1955                 // also wrong, but much shorter.
1956                 l_margin += max_width / 2;
1957                 break;
1958         }
1959         }
1960
1961         if (!par.params().leftIndent().zero())
1962                 l_margin += par.params().leftIndent().inPixels(max_width);
1963
1964         LyXAlignment align;
1965
1966         if (par.params().align() == LYX_ALIGN_LAYOUT)
1967                 align = layout.align;
1968         else
1969                 align = par.params().align();
1970
1971         // set the correct parindent
1972         if (pos == 0
1973             && (layout.labeltype == LABEL_NO_LABEL
1974                || layout.labeltype == LABEL_TOP_ENVIRONMENT
1975                || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1976                || (layout.labeltype == LABEL_STATIC
1977                    && layout.latextype == LATEX_ENVIRONMENT
1978                    && !text_->isFirstInSequence(pit)))
1979             && align == LYX_ALIGN_BLOCK
1980             && !par.params().noindent()
1981             // in some insets, paragraphs are never indented
1982             && !text_->inset().neverIndent()
1983             // display style insets are always centered, omit indentation
1984             && !(!par.empty()
1985                     && par.isInset(pos)
1986                     && par.getInset(pos)->display())
1987                         && (!(tclass.isDefaultLayout(par.layout())
1988                  || tclass.isPlainLayout(par.layout()))
1989                 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
1990             )
1991                 {
1992                         // use the parindent of the layout when the default indentation is used
1993                         // otherwise use the indentation set in the document settings
1994                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1995                                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1996                                 parindent);
1997                         else
1998                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1999                 }
2000         
2001         return l_margin;
2002 }
2003
2004
2005 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2006 {
2007         ParagraphMetrics const & pm = par_metrics_[pit];
2008
2009         return pm.singleWidth(pos, displayFont(pit, pos));
2010 }
2011
2012
2013 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2014 {
2015         if (par_metrics_.empty())
2016                 return;
2017
2018         origin_.x_ = x;
2019         origin_.y_ = y;
2020
2021         ParMetricsCache::iterator it = par_metrics_.begin();
2022         ParMetricsCache::iterator const pm_end = par_metrics_.end();
2023         y -= it->second.ascent();
2024         for (; it != pm_end; ++it) {
2025                 ParagraphMetrics const & pmi = it->second;
2026                 y += pmi.ascent();
2027                 pit_type const pit = it->first;
2028                 // Save the paragraph position in the cache.
2029                 it->second.setPosition(y);
2030                 drawParagraph(pi, pit, x, y);
2031                 y += pmi.descent();
2032         }
2033 }
2034
2035
2036 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2037 {
2038         BufferParams const & bparams = bv_->buffer().params();
2039         ParagraphMetrics const & pm = par_metrics_[pit];
2040         if (pm.rows().empty())
2041                 return;
2042
2043         Bidi bidi;
2044         bool const original_drawing_state = pi.pain.isDrawingEnabled();
2045         int const ww = bv_->workHeight();
2046         size_t const nrows = pm.rows().size();
2047
2048         Cursor const & cur = bv_->cursor();
2049         DocIterator sel_beg = cur.selectionBegin();
2050         DocIterator sel_end = cur.selectionEnd();
2051         bool selection = cur.selection()
2052                 // This is our text.
2053                 && cur.text() == text_
2054                 // if the anchor is outside, this is not our selection
2055                 && cur.anchor().text() == text_
2056                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2057
2058         // We store the begin and end pos of the selection relative to this par
2059         DocIterator sel_beg_par = cur.selectionBegin();
2060         DocIterator sel_end_par = cur.selectionEnd();
2061         
2062         // We care only about visible selection.
2063         if (selection) {
2064                 if (pit != sel_beg.pit()) {
2065                         sel_beg_par.pit() = pit;
2066                         sel_beg_par.pos() = 0;
2067                 }
2068                 if (pit != sel_end.pit()) {
2069                         sel_end_par.pit() = pit;
2070                         sel_end_par.pos() = sel_end_par.lastpos();
2071                 }
2072         }
2073
2074         for (size_t i = 0; i != nrows; ++i) {
2075
2076                 Row const & row = pm.rows()[i];
2077                 if (i)
2078                         y += row.ascent();
2079
2080                 bool const inside = (y + row.descent() >= 0
2081                         && y - row.ascent() < ww);
2082                 // It is not needed to draw on screen if we are not inside.
2083                 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2084                 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2085
2086                 if (selection)
2087                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2088                 else
2089                         row.setSelection(-1, -1);
2090                 
2091                 // The row knows nothing about the paragraph, so we have to check
2092                 // whether this row is the first or last and update the margins.
2093                 if (row.selection()) {
2094                         if (row.sel_beg == 0)
2095                                 row.begin_margin_sel = sel_beg.pit() < pit;
2096                         if (row.sel_end == sel_end_par.lastpos())
2097                                 row.end_margin_sel = sel_end.pit() > pit;
2098                 }
2099
2100                 // Row signature; has row changed since last paint?
2101                 row.setCrc(pm.computeRowSignature(row, bparams));
2102                 bool row_has_changed = row.changed();
2103
2104                 // Take this opportunity to spellcheck the row contents.
2105                 if (row_has_changed && lyxrc.spellcheck_continuously) {
2106                         WordLangTuple wl;
2107                         // dummy variable, not used.
2108                         static docstring_list suggestions;
2109                         pos_type from = row.pos();
2110                         pos_type to = row.endpos();
2111                         while (from < row.endpos()) {
2112                                 text_->getPar(pit).spellCheck(from, to, wl, suggestions, false);
2113                                 from = to + 1;
2114                         }
2115                 }
2116
2117                 // Don't paint the row if a full repaint has not been requested
2118                 // and if it has not changed.
2119                 if (!pi.full_repaint && !row_has_changed) {
2120                         // Paint only the insets if the text itself is
2121                         // unchanged.
2122                         rp.paintOnlyInsets();
2123                         y += row.descent();
2124                         continue;
2125                 }
2126
2127                 // Clear background of this row if paragraph background was not
2128                 // already cleared because of a full repaint.
2129                 if (!pi.full_repaint && row_has_changed) {
2130                         pi.pain.fillRectangle(x, y - row.ascent(),
2131                                 width(), row.height(), pi.background_color);
2132                 }
2133                 
2134                 if (row.selection())
2135                         drawRowSelection(pi, x, row, cur, pit);
2136
2137                 // Instrumentation for testing row cache (see also
2138                 // 12 lines lower):
2139                 if (lyxerr.debugging(Debug::PAINTING) && inside
2140                         && (row.selection() || pi.full_repaint || row_has_changed)) {
2141                                 string const foreword = text_->isMainText() ?
2142                                         "main text redraw " : "inset text redraw: ";
2143                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2144                                 << " row_selection="    << row.selection()
2145                                 << " full_repaint="     << pi.full_repaint
2146                                 << " row_has_changed="  << row_has_changed);
2147                 }
2148
2149                 // Backup full_repaint status and force full repaint
2150                 // for inner insets as the Row has been cleared out.
2151                 bool tmp = pi.full_repaint;
2152                 pi.full_repaint = true;
2153                 rp.paintAppendix();
2154                 rp.paintDepthBar();
2155                 rp.paintChangeBar();
2156                 if (i == 0)
2157                         rp.paintFirst();
2158                 rp.paintText();
2159                 if (i == nrows - 1)
2160                         rp.paintLast();
2161                 y += row.descent();
2162                 // Restore full_repaint status.
2163                 pi.full_repaint = tmp;
2164         }
2165         // Re-enable screen drawing for future use of the painter.
2166         pi.pain.setDrawingEnabled(original_drawing_state);
2167
2168         //LYXERR(Debug::PAINTING, ".");
2169 }
2170
2171
2172 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2173                 Cursor const & curs, pit_type pit) const
2174 {
2175         DocIterator beg = curs.selectionBegin();
2176         beg.pit() = pit;
2177         beg.pos() = row.sel_beg;
2178
2179         DocIterator end = curs.selectionEnd();
2180         end.pit() = pit;
2181         end.pos() = row.sel_end;
2182
2183         bool const begin_boundary = beg.pos() >= row.endpos();
2184         bool const end_boundary = row.sel_end == row.endpos();
2185
2186         DocIterator cur = beg;
2187         cur.boundary(begin_boundary);
2188         int x1 = cursorX(beg.top(), begin_boundary);
2189         int x2 = cursorX(end.top(), end_boundary);
2190         int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2191         int const y2 = y1 + row.height();
2192
2193         int const rm = text_->isMainText() ? bv_->rightMargin() : 0;
2194         int const lm = text_->isMainText() ? bv_->leftMargin() : 0;
2195
2196         // draw the margins
2197         if (row.begin_margin_sel) {
2198                 if (text_->isRTL(beg.paragraph())) {
2199                         pi.pain.fillRectangle(x + x1, y1,  width() - rm - x1, y2 - y1,
2200                                 Color_selection);
2201                 } else {
2202                         pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2203                                 Color_selection);
2204                 }
2205         }
2206
2207         if (row.end_margin_sel) {
2208                 if (text_->isRTL(beg.paragraph())) {
2209                         pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2210                                 Color_selection);
2211                 } else {
2212                         pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2213                                 Color_selection);
2214                 }
2215         }
2216
2217         // if we are on a boundary from the beginning, it's probably
2218         // a RTL boundary and we jump to the other side directly as this
2219         // segement is 0-size and confuses the logic below
2220         if (cur.boundary())
2221                 cur.boundary(false);
2222
2223         // go through row and draw from RTL boundary to RTL boundary
2224         while (cur < end) {
2225                 bool drawNow = false;
2226
2227                 // simplified cursorForward code below which does not
2228                 // descend into insets and which does not go into the
2229                 // next line. Compare the logic with the original cursorForward
2230
2231                 // if left of boundary -> just jump to right side, but
2232                 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2233                 if (cur.boundary()) {
2234                         cur.boundary(false);
2235                 }       else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2236                         // in front of RTL boundary -> Stay on this side of the boundary
2237                         // because:  ab|cDDEEFFghi -> abc|DDEEFFghi
2238                         ++cur.pos();
2239                         cur.boundary(true);
2240                         drawNow = true;
2241                 } else {
2242                         // move right
2243                         ++cur.pos();
2244
2245                         // line end?
2246                         if (cur.pos() == row.endpos())
2247                                 cur.boundary(true);
2248                 }
2249
2250                 if (x1 == -1) {
2251                         // the previous segment was just drawn, now the next starts
2252                         x1 = cursorX(cur.top(), cur.boundary());
2253                 }
2254
2255                 if (!(cur < end) || drawNow) {
2256                         x2 = cursorX(cur.top(), cur.boundary());
2257                         pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2258                                 Color_selection);
2259
2260                         // reset x1, so it is set again next round (which will be on the
2261                         // right side of a boundary or at the selection end)
2262                         x1 = -1;
2263                 }
2264         }
2265 }
2266
2267
2268 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2269         Dimension & dim) const
2270 {
2271         Cursor const & bvcur = cur.bv().cursor();
2272
2273         // get word in front of cursor
2274         docstring word = text_->previousWord(bvcur.top());
2275         DocIterator wordStart = bvcur;
2276         wordStart.pos() -= word.length();
2277
2278         // get position on screen of the word start and end
2279         Point lxy = cur.bv().getPos(wordStart, false);
2280         Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2281
2282         // calculate dimensions of the word
2283         dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2284         dim.wid = abs(rxy.x_ - lxy.x_);
2285
2286         // calculate position of word
2287         y = lxy.y_;
2288         x = min(rxy.x_, lxy.x_);
2289
2290         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2291         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2292 }
2293
2294 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2295 //{
2296 //      ParagraphMetrics const & pm = par_metrics_[pit];
2297 //      Row const & r = pm.rows()[row];
2298 //      int x = 0;
2299 //      pos -= r.pos();
2300 //}
2301
2302
2303 int defaultRowHeight()
2304 {
2305         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2306 }
2307
2308 } // namespace lyx