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