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