]> git.lyx.org Git - lyx.git/blob - src/text.C
b8049a7417768a21aba308e2876cab47799d0e1a
[lyx.git] / src / text.C
1 /**
2  * \file src/text.C
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  *
14  * Full author contact details are available in file CREDITS.
15  */
16
17 #include <config.h>
18
19 #include "lyxtext.h"
20
21 #include "author.h"
22 #include "buffer.h"
23 #include "buffer_funcs.h"
24 #include "bufferparams.h"
25 #include "BufferView.h"
26 #include "cursor.h"
27 #include "pariterator.h"
28 #include "coordcache.h"
29 #include "CutAndPaste.h"
30 #include "debug.h"
31 #include "dispatchresult.h"
32 #include "encoding.h"
33 #include "errorlist.h"
34 #include "funcrequest.h"
35 #include "factory.h"
36 #include "FontIterator.h"
37 #include "gettext.h"
38 #include "language.h"
39 #include "LColor.h"
40 #include "lyxlength.h"
41 #include "lyxlex.h"
42 #include "lyxrc.h"
43 #include "lyxrow.h"
44 #include "metricsinfo.h"
45 #include "paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "rowpainter.h"
49 #include "undo.h"
50 #include "vspace.h"
51 #include "WordLangTuple.h"
52
53 #include "frontends/FontMetrics.h"
54 #include "frontends/Painter.h"
55
56 #include "insets/insettext.h"
57 #include "insets/insetbibitem.h"
58 #include "insets/insethfill.h"
59 #include "insets/insetlatexaccent.h"
60 #include "insets/insetline.h"
61 #include "insets/insetnewline.h"
62 #include "insets/insetpagebreak.h"
63 #include "insets/insetoptarg.h"
64 #include "insets/insetspace.h"
65 #include "insets/insetspecialchar.h"
66 #include "insets/insettabular.h"
67
68 #include "support/lstrings.h"
69 #include "support/textutils.h"
70 #include "support/convert.h"
71
72 #include <boost/current_function.hpp>
73
74 #include <sstream>
75
76
77 namespace lyx {
78
79 using support::bformat;
80 using support::contains;
81 using support::lowercase;
82 using support::split;
83 using support::uppercase;
84
85 using cap::cutSelection;
86 using cap::pasteParagraphList;
87
88 using frontend::FontMetrics;
89
90 using std::auto_ptr;
91 using std::advance;
92 using std::distance;
93 using std::max;
94 using std::min;
95 using std::endl;
96 using std::string;
97
98
99 namespace {
100
101 int numberOfSeparators(Paragraph const & par, Row const & row)
102 {
103         pos_type const first = max(row.pos(), par.beginOfBody());
104         pos_type const last = row.endpos() - 1;
105         int n = 0;
106         for (pos_type p = first; p < last; ++p) {
107                 if (par.isSeparator(p))
108                         ++n;
109         }
110         return n;
111 }
112
113
114 int numberOfLabelHfills(Paragraph const & par, Row const & row)
115 {
116         pos_type last = row.endpos() - 1;
117         pos_type first = row.pos();
118
119         // hfill *DO* count at the beginning of paragraphs!
120         if (first) {
121                 while (first < last && par.isHfill(first))
122                         ++first;
123         }
124
125         last = min(last, par.beginOfBody());
126         int n = 0;
127         for (pos_type p = first; p < last; ++p) {
128                 if (par.isHfill(p))
129                         ++n;
130         }
131         return n;
132 }
133
134
135 int numberOfHfills(Paragraph const & par, Row const & row)
136 {
137         pos_type const last = row.endpos();
138         pos_type first = row.pos();
139
140         // hfill *DO* count at the beginning of paragraphs!
141         if (first) {
142                 while (first < last && par.isHfill(first))
143                         ++first;
144         }
145
146         first = max(first, par.beginOfBody());
147
148         int n = 0;
149         for (pos_type p = first; p < last; ++p) {
150                 if (par.isHfill(p))
151                         ++n;
152         }
153         return n;
154 }
155
156
157 void readParToken(Buffer const & buf, Paragraph & par, LyXLex & lex,
158         string const & token, LyXFont & font, Change & change, ErrorList & errorList)
159 {
160         BufferParams const & bp = buf.params();
161
162         if (token[0] != '\\') {
163 #if 0
164                 string::const_iterator cit = token.begin();
165                 for (; cit != token.end(); ++cit)
166                         par.insertChar(par.size(), (*cit), font, change);
167 #else
168                 docstring dstr = lex.getDocString();
169                 docstring::const_iterator cit = dstr.begin();
170                 docstring::const_iterator cend = dstr.end();
171                 for (; cit != cend; ++cit)
172                         par.insertChar(par.size(), *cit, font, change);
173 #endif
174         } else if (token == "\\begin_layout") {
175                 lex.eatLine();
176                 string layoutname = lex.getString();
177
178                 font = LyXFont(LyXFont::ALL_INHERIT, bp.language);
179                 change = Change(Change::UNCHANGED);
180
181                 LyXTextClass const & tclass = bp.getLyXTextClass();
182
183                 if (layoutname.empty()) {
184                         layoutname = tclass.defaultLayoutName();
185                 }
186
187                 bool hasLayout = tclass.hasLayout(layoutname);
188
189                 if (!hasLayout) {
190                         errorList.push_back(ErrorItem(_("Unknown layout"),
191                         bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
192                         from_utf8(layoutname), from_utf8(tclass.name())), par.id(), 0, par.size()));
193                         layoutname = tclass.defaultLayoutName();
194                 }
195
196                 par.layout(bp.getLyXTextClass()[layoutname]);
197
198                 // Test whether the layout is obsolete.
199                 LyXLayout_ptr const & layout = par.layout();
200                 if (!layout->obsoleted_by().empty())
201                         par.layout(bp.getLyXTextClass()[layout->obsoleted_by()]);
202
203                 par.params().read(lex);
204
205         } else if (token == "\\end_layout") {
206                 lyxerr << BOOST_CURRENT_FUNCTION
207                        << ": Solitary \\end_layout in line "
208                        << lex.getLineNo() << "\n"
209                        << "Missing \\begin_layout?.\n";
210         } else if (token == "\\end_inset") {
211                 lyxerr << BOOST_CURRENT_FUNCTION
212                        << ": Solitary \\end_inset in line "
213                        << lex.getLineNo() << "\n"
214                        << "Missing \\begin_inset?.\n";
215         } else if (token == "\\begin_inset") {
216                 InsetBase * inset = readInset(lex, buf);
217                 if (inset)
218                         par.insertInset(par.size(), inset, font, change);
219                 else {
220                         lex.eatLine();
221                         docstring line = from_utf8(lex.getString());
222                         errorList.push_back(ErrorItem(_("Unknown Inset"), line,
223                                             par.id(), 0, par.size()));
224                 }
225         } else if (token == "\\family") {
226                 lex.next();
227                 font.setLyXFamily(lex.getString());
228         } else if (token == "\\series") {
229                 lex.next();
230                 font.setLyXSeries(lex.getString());
231         } else if (token == "\\shape") {
232                 lex.next();
233                 font.setLyXShape(lex.getString());
234         } else if (token == "\\size") {
235                 lex.next();
236                 font.setLyXSize(lex.getString());
237         } else if (token == "\\lang") {
238                 lex.next();
239                 string const tok = lex.getString();
240                 Language const * lang = languages.getLanguage(tok);
241                 if (lang) {
242                         font.setLanguage(lang);
243                 } else {
244                         font.setLanguage(bp.language);
245                         lex.printError("Unknown language `$$Token'");
246                 }
247         } else if (token == "\\numeric") {
248                 lex.next();
249                 font.setNumber(font.setLyXMisc(lex.getString()));
250         } else if (token == "\\emph") {
251                 lex.next();
252                 font.setEmph(font.setLyXMisc(lex.getString()));
253         } else if (token == "\\bar") {
254                 lex.next();
255                 string const tok = lex.getString();
256
257                 if (tok == "under")
258                         font.setUnderbar(LyXFont::ON);
259                 else if (tok == "no")
260                         font.setUnderbar(LyXFont::OFF);
261                 else if (tok == "default")
262                         font.setUnderbar(LyXFont::INHERIT);
263                 else
264                         lex.printError("Unknown bar font flag "
265                                        "`$$Token'");
266         } else if (token == "\\noun") {
267                 lex.next();
268                 font.setNoun(font.setLyXMisc(lex.getString()));
269         } else if (token == "\\color") {
270                 lex.next();
271                 font.setLyXColor(lex.getString());
272         } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
273
274                 // Insets don't make sense in a free-spacing context! ---Kayvan
275                 if (par.isFreeSpacing()) {
276                         if (token == "\\InsetSpace")
277                                 par.insertChar(par.size(), ' ', font, change);
278                         else if (lex.isOK()) {
279                                 lex.next();
280                                 string const next_token = lex.getString();
281                                 if (next_token == "\\-")
282                                         par.insertChar(par.size(), '-', font, change);
283                                 else {
284                                         lex.printError("Token `$$Token' "
285                                                        "is in free space "
286                                                        "paragraph layout!");
287                                 }
288                         }
289                 } else {
290                         auto_ptr<InsetBase> inset;
291                         if (token == "\\SpecialChar" )
292                                 inset.reset(new InsetSpecialChar);
293                         else
294                                 inset.reset(new InsetSpace);
295                         inset->read(buf, lex);
296                         par.insertInset(par.size(), inset.release(),
297                                         font, change);
298                 }
299         } else if (token == "\\i") {
300                 auto_ptr<InsetBase> inset(new InsetLatexAccent);
301                 inset->read(buf, lex);
302                 par.insertInset(par.size(), inset.release(), font, change);
303         } else if (token == "\\backslash") {
304                 par.insertChar(par.size(), '\\', font, change);
305         } else if (token == "\\newline") {
306                 auto_ptr<InsetBase> inset(new InsetNewline);
307                 inset->read(buf, lex);
308                 par.insertInset(par.size(), inset.release(), font, change);
309         } else if (token == "\\LyXTable") {
310                 auto_ptr<InsetBase> inset(new InsetTabular(buf));
311                 inset->read(buf, lex);
312                 par.insertInset(par.size(), inset.release(), font, change);
313         } else if (token == "\\hfill") {
314                 par.insertInset(par.size(), new InsetHFill, font, change);
315         } else if (token == "\\lyxline") {
316                 par.insertInset(par.size(), new InsetLine, font, change);
317         } else if (token == "\\newpage") {
318                 par.insertInset(par.size(), new InsetPagebreak, font, change);
319         } else if (token == "\\change_unchanged") {
320                 change = Change(Change::UNCHANGED);
321         } else if (token == "\\change_inserted") {
322                 lex.eatLine();
323                 std::istringstream is(lex.getString());
324                 unsigned int aid;
325                 time_type ct;
326                 is >> aid >> ct;
327                 if (aid >= bp.author_map.size()) {
328                         errorList.push_back(ErrorItem(_("Change tracking error"),
329                                             bformat(_("Unknown author index for insertion: %1$d\n"), aid),
330                                             par.id(), 0, par.size()));
331                         change = Change(Change::UNCHANGED);
332                 } else
333                         change = Change(Change::INSERTED, bp.author_map[aid], ct);
334         } else if (token == "\\change_deleted") {
335                 lex.eatLine();
336                 std::istringstream is(lex.getString());
337                 unsigned int aid;
338                 time_type ct;
339                 is >> aid >> ct;
340                 if (aid >= bp.author_map.size()) {
341                         errorList.push_back(ErrorItem(_("Change tracking error"),
342                                             bformat(_("Unknown author index for deletion: %1$d\n"), aid),
343                                             par.id(), 0, par.size()));
344                         change = Change(Change::UNCHANGED);
345                 } else
346                         change = Change(Change::DELETED, bp.author_map[aid], ct);
347         } else {
348                 lex.eatLine();
349                 errorList.push_back(ErrorItem(_("Unknown token"),
350                         bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
351                         from_utf8(lex.getString())),
352                         par.id(), 0, par.size()));
353         }
354 }
355
356
357 void readParagraph(Buffer const & buf, Paragraph & par, LyXLex & lex,
358         ErrorList & errorList)
359 {
360         lex.nextToken();
361         string token = lex.getString();
362         LyXFont font;
363         Change change(Change::UNCHANGED);
364
365         while (lex.isOK()) {
366                 readParToken(buf, par, lex, token, font, change, errorList);
367
368                 lex.nextToken();
369                 token = lex.getString();
370
371                 if (token.empty())
372                         continue;
373
374                 if (token == "\\end_layout") {
375                         //Ok, paragraph finished
376                         break;
377                 }
378
379                 lyxerr[Debug::PARSER] << "Handling paragraph token: `"
380                                       << token << '\'' << endl;
381                 if (token == "\\begin_layout" || token == "\\end_document"
382                     || token == "\\end_inset" || token == "\\begin_deeper"
383                     || token == "\\end_deeper") {
384                         lex.pushToken(token);
385                         lyxerr << "Paragraph ended in line "
386                                << lex.getLineNo() << "\n"
387                                << "Missing \\end_layout.\n";
388                         break;
389                 }
390         }
391         // Final change goes to paragraph break:
392         par.setChange(par.size(), change);
393
394         // Initialize begin_of_body_ on load; redoParagraph maintains
395         par.setBeginOfBody();
396 }
397
398
399 } // namespace anon
400
401
402
403 double LyXText::spacing(Buffer const & buffer,
404                 Paragraph const & par) const
405 {
406         if (par.params().spacing().isDefault())
407                 return buffer.params().spacing().getValue();
408         return par.params().spacing().getValue();
409 }
410
411
412 int LyXText::width() const
413 {
414         return dim_.wid;
415 }
416
417
418 int LyXText::height() const
419 {
420         return dim_.height();
421 }
422
423
424 int LyXText::singleWidth(Buffer const & buffer, Paragraph const & par,
425                 pos_type pos) const
426 {
427         return singleWidth(par, pos, par.getChar(pos),
428                 getFont(buffer, par, pos));
429 }
430
431
432 int LyXText::singleWidth(Paragraph const & par,
433                          pos_type pos, char_type c, LyXFont const & font) const
434 {
435         // The most common case is handled first (Asger)
436         if (isPrintable(c)) {
437                 Language const * language = font.language();
438                 if (language->rightToLeft()) {
439                         if ((lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
440                              lyxrc.font_norm_type == LyXRC::ISO_10646_1)
441                             && language->lang() == "arabic") {
442                                 if (Encodings::isComposeChar_arabic(c))
443                                         return 0;
444                                 c = par.transformChar(c, pos);
445                         } else if (language->lang() == "hebrew" &&
446                                    Encodings::isComposeChar_hebrew(c))
447                                 return 0;
448                 }
449                 return theFontMetrics(font).width(c);
450         }
451
452         if (c == Paragraph::META_INSET)
453                 return par.getInset(pos)->width();
454
455         return theFontMetrics(font).width(c);
456 }
457
458
459 int LyXText::leftMargin(Buffer const & buffer, pit_type pit) const
460 {
461         BOOST_ASSERT(pit >= 0);
462         BOOST_ASSERT(pit < int(pars_.size()));
463         return leftMargin(buffer, pit, pars_[pit].size());
464 }
465
466
467 int LyXText::leftMargin(Buffer const & buffer,
468                 pit_type const pit, pos_type const pos) const
469 {
470         BOOST_ASSERT(pit >= 0);
471         BOOST_ASSERT(pit < int(pars_.size()));
472         Paragraph const & par = pars_[pit];
473         BOOST_ASSERT(pos >= 0);
474         BOOST_ASSERT(pos <= par.size());
475         //lyxerr << "LyXText::leftMargin: pit: " << pit << " pos: " << pos << endl;
476         LyXTextClass const & tclass = buffer.params().getLyXTextClass();
477         LyXLayout_ptr const & layout = par.layout();
478
479         string parindent = layout->parindent;
480
481         int l_margin = 0;
482
483         if (isMainText(buffer))
484                 l_margin += changebarMargin();
485
486         // FIXME UNICODE
487         docstring leftm = from_utf8(tclass.leftmargin());
488         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
489
490         if (par.getDepth() != 0) {
491                 // find the next level paragraph
492                 pit_type newpar = outerHook(pit, pars_);
493                 if (newpar != pit_type(pars_.size())) {
494                         if (pars_[newpar].layout()->isEnvironment()) {
495                                 l_margin = leftMargin(buffer, newpar);
496                         }
497                         if (par.layout() == tclass.defaultLayout()) {
498                                 if (pars_[newpar].params().noindent())
499                                         parindent.erase();
500                                 else
501                                         parindent = pars_[newpar].layout()->parindent;
502                         }
503                 }
504         }
505
506         // This happens after sections in standard classes. The 1.3.x
507         // code compared depths too, but it does not seem necessary
508         // (JMarc)
509         if (par.layout() == tclass.defaultLayout()
510             && pit > 0 && pars_[pit - 1].layout()->nextnoindent)
511                 parindent.erase();
512
513         LyXFont const labelfont = getLabelFont(buffer, par);
514         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
515
516         switch (layout->margintype) {
517         case MARGIN_DYNAMIC:
518                 if (!layout->leftmargin.empty()) {
519                         // FIXME UNICODE
520                         docstring leftm = from_utf8(layout->leftmargin);
521                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
522                 }
523                 if (!par.getLabelstring().empty()) {
524                         // FIXME UNICODE
525                         docstring labin = from_utf8(layout->labelindent);
526                         l_margin += labelfont_metrics.signedWidth(labin);
527                         docstring labstr = par.getLabelstring();
528                         l_margin += labelfont_metrics.width(labstr);
529                         docstring labsep = from_utf8(layout->labelsep);
530                         l_margin += labelfont_metrics.width(labsep);
531                 }
532                 break;
533
534         case MARGIN_MANUAL: {
535                 // FIXME UNICODE
536                 docstring labin = from_utf8(layout->labelindent);
537                 l_margin += labelfont_metrics.signedWidth(labin);
538                 // The width of an empty par, even with manual label, should be 0
539                 if (!par.empty() && pos >= par.beginOfBody()) {
540                         if (!par.getLabelWidthString().empty()) {
541                                 docstring labstr = par.getLabelWidthString();
542                                 l_margin += labelfont_metrics.width(labstr);
543                                 docstring labsep = from_utf8(layout->labelsep);
544                                 l_margin += labelfont_metrics.width(labsep);
545                         }
546                 }
547                 break;
548         }
549
550         case MARGIN_STATIC: {
551                 // FIXME UNICODE
552                 docstring leftm = from_utf8(layout->leftmargin);
553                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm)
554                         * 4     / (par.getDepth() + 4);
555                 break;
556         }
557
558         case MARGIN_FIRST_DYNAMIC:
559                 if (layout->labeltype == LABEL_MANUAL) {
560                         if (pos >= par.beginOfBody()) {
561                                 // FIXME UNICODE
562                                 l_margin += labelfont_metrics.signedWidth(
563                                         from_utf8(layout->leftmargin));
564                         } else {
565                                 // FIXME UNICODE
566                                 l_margin += labelfont_metrics.signedWidth(
567                                         from_utf8(layout->labelindent));
568                         }
569                 } else if (pos != 0
570                            // Special case to fix problems with
571                            // theorems (JMarc)
572                            || (layout->labeltype == LABEL_STATIC
573                                && layout->latextype == LATEX_ENVIRONMENT
574                                && !isFirstInSequence(pit, pars_))) {
575                         // FIXME UNICODE
576                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->leftmargin));
577                 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
578                            && layout->labeltype != LABEL_BIBLIO
579                            && layout->labeltype !=
580                            LABEL_CENTERED_TOP_ENVIRONMENT) {
581                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->labelindent));
582                         l_margin += labelfont_metrics.width(from_utf8(layout->labelsep));
583                         l_margin += labelfont_metrics.width(par.getLabelstring());
584                 }
585                 break;
586
587         case MARGIN_RIGHT_ADDRESS_BOX: {
588 #if 0
589                 // ok, a terrible hack. The left margin depends on the widest
590                 // row in this paragraph.
591                 RowList::iterator rit = par.rows().begin();
592                 RowList::iterator end = par.rows().end();
593 #ifdef WITH_WARNINGS
594 #warning This is wrong.
595 #endif
596                 int minfill = maxwidth_;
597                 for ( ; rit != end; ++rit)
598                         if (rit->fill() < minfill)
599                                 minfill = rit->fill();
600                 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
601                 l_margin += minfill;
602 #endif
603                 // also wrong, but much shorter.
604                 l_margin += maxwidth_ / 2;
605                 break;
606         }
607         }
608
609         if (!par.params().leftIndent().zero())
610                 l_margin += par.params().leftIndent().inPixels(maxwidth_);
611
612         LyXAlignment align;
613
614         if (par.params().align() == LYX_ALIGN_LAYOUT)
615                 align = layout->align;
616         else
617                 align = par.params().align();
618
619         // set the correct parindent
620         if (pos == 0
621             && (layout->labeltype == LABEL_NO_LABEL
622                || layout->labeltype == LABEL_TOP_ENVIRONMENT
623                || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
624                || (layout->labeltype == LABEL_STATIC
625                    && layout->latextype == LATEX_ENVIRONMENT
626                    && !isFirstInSequence(pit, pars_)))
627             && align == LYX_ALIGN_BLOCK
628             && !par.params().noindent()
629             // in some insets, paragraphs are never indented
630             && !(par.inInset() && par.inInset()->neverIndent(buffer))
631             // display style insets are always centered, omit indentation
632             && !(!par.empty()
633                     && par.isInset(pos)
634                     && par.getInset(pos)->display())
635             && (par.layout() != tclass.defaultLayout()
636                 || buffer.params().paragraph_separation ==
637                    BufferParams::PARSEP_INDENT))
638         {
639                 docstring din = from_utf8(parindent);
640                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(din);
641         }
642
643         return l_margin;
644 }
645
646
647 int LyXText::rightMargin(Buffer const & buffer, Paragraph const & par) const
648 {
649         // FIXME: the correct way is to only call rightMargin() only
650         // within the main LyXText. The following test is thus bogus.
651         LyXText const & text = buffer.text();
652         // We do not want rightmargins on inner texts.
653         if (&text != this)
654                 return 0;
655
656         BufferParams const & params = buffer.params();
657         LyXTextClass const & tclass = params.getLyXTextClass();
658         docstring trmarg = from_utf8(tclass.rightmargin());
659         docstring lrmarg = from_utf8(par.layout()->rightmargin);
660         FontMetrics const & fm = theFontMetrics(params.getFont());
661         int const r_margin =
662                 lyx::rightMargin()
663                 + fm.signedWidth(trmarg)
664                 + fm.signedWidth(lrmarg)
665                 * 4 / (par.getDepth() + 4);
666
667         return r_margin;
668 }
669
670
671 int LyXText::labelEnd(Buffer const & buffer, pit_type const pit) const
672 {
673         // labelEnd is only needed if the layout fills a flushleft label.
674         if (pars_[pit].layout()->margintype != MARGIN_MANUAL)
675                 return 0;
676         // return the beginning of the body
677         return leftMargin(buffer, pit);
678 }
679
680
681 namespace {
682
683 // this needs special handling - only newlines count as a break point
684 pos_type addressBreakPoint(pos_type i, Paragraph const & par)
685 {
686         pos_type const end = par.size();
687
688         for (; i < end; ++i)
689                 if (par.isNewline(i))
690                         return i + 1;
691
692         return end;
693 }
694
695 };
696
697
698 void LyXText::rowBreakPoint(Buffer const & buffer, int right_margin,
699                 pit_type const pit,     Row & row) const
700 {
701         Paragraph const & par = pars_[pit];
702         pos_type const end = par.size();
703         pos_type const pos = row.pos();
704         if (pos == end) {
705                 row.endpos(end);
706                 return;
707         }
708
709         // maximum pixel width of a row
710         int width = maxwidth_ - right_margin; // - leftMargin(buffer, pit, row);
711         if (width < 0) {
712                 row.endpos(end);
713                 return;
714         }
715
716         LyXLayout_ptr const & layout = par.layout();
717
718         if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX) {
719                 row.endpos(addressBreakPoint(pos, par));
720                 return;
721         }
722
723         pos_type const body_pos = par.beginOfBody();
724
725
726         // Now we iterate through until we reach the right margin
727         // or the end of the par, then choose the possible break
728         // nearest that.
729
730         int const left = leftMargin(buffer, pit, pos);
731         int x = left;
732
733         // pixel width since last breakpoint
734         int chunkwidth = 0;
735
736         FontIterator fi = FontIterator(buffer, *this, par, pos);
737         pos_type point = end;
738         pos_type i = pos;
739         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
740         for ( ; i < end; ++i, ++fi) {
741                 char_type const c = par.getChar(i);
742                 int thiswidth = singleWidth(par, i, c, *fi);
743
744                 // add the auto-hfill from label end to the body
745                 if (body_pos && i == body_pos) {
746                         docstring lsep = from_utf8(layout->labelsep);
747                         int add = fm.width(lsep);
748                         if (par.isLineSeparator(i - 1))
749                                 add -= singleWidth(buffer, par, i - 1);
750
751                         add = std::max(add, labelEnd(buffer, pit) - x);
752                         thiswidth += add;
753                 }
754
755                 x += thiswidth;
756                 chunkwidth += thiswidth;
757
758                 // break before a character that will fall off
759                 // the right of the row
760                 if (x >= width) {
761                         // if no break before, break here
762                         if (point == end || chunkwidth >= width - left) {
763                                 if (i > pos)
764                                         point = i;
765                                 else
766                                         point = i + 1;
767
768                         }
769                         // exit on last registered breakpoint:
770                         break;
771                 }
772
773                 if (par.isNewline(i)) {
774                         point = i + 1;
775                         break;
776                 }
777                 // Break before...
778                 if (i + 1 < end) {
779                         if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
780                                 point = i + 1;
781                                 break;
782                         }
783                         // ...and after.
784                         if (par.isInset(i) && par.getInset(i)->display()) {
785                                 point = i + 1;
786                                 break;
787                         }
788                 }
789
790                 if (!par.isInset(i) || par.getInset(i)->isChar()) {
791                         // some insets are line separators too
792                         if (par.isLineSeparator(i)) {
793                                 // register breakpoint:
794                                 point = i + 1;
795                                 chunkwidth = 0;
796                         }
797                 }
798         }
799
800         // maybe found one, but the par is short enough.
801         if (i == end && x < width)
802                 point = end;
803
804         // manual labels cannot be broken in LaTeX. But we
805         // want to make our on-screen rendering of footnotes
806         // etc. still break
807         if (body_pos && point < body_pos)
808                 point = body_pos;
809
810         row.endpos(point);
811 }
812
813
814 void LyXText::setRowWidth(Buffer const & buffer, pit_type const pit, Row & row) const
815 {
816         // get the pure distance
817         pos_type const end = row.endpos();
818
819         Paragraph const & par = pars_[pit];
820         docstring const labelsep = from_utf8(par.layout()->labelsep);
821         int w = leftMargin(buffer, pit, row.pos());
822
823         pos_type const body_pos = par.beginOfBody();
824         pos_type i = row.pos();
825
826         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
827
828         if (i < end) {
829                 FontIterator fi = FontIterator(buffer, *this, par, i);
830                 for ( ; i < end; ++i, ++fi) {
831                         if (body_pos > 0 && i == body_pos) {
832                                 w += fm.width(labelsep);
833                                 if (par.isLineSeparator(i - 1))
834                                         w -= singleWidth(buffer, par, i - 1);
835                                 w = max(w, labelEnd(buffer, pit));
836                         }
837                         char_type const c = par.getChar(i);
838                         w += singleWidth(par, i, c, *fi);
839                 }
840         }
841
842         if (body_pos > 0 && body_pos >= end) {
843                 w += fm.width(labelsep);
844                 if (end > 0 && par.isLineSeparator(end - 1))
845                         w -= singleWidth(buffer, par, end - 1);
846                 w = max(w, labelEnd(buffer, pit));
847         }
848
849         row.width(w + rightMargin(buffer, par));
850 }
851
852
853 // returns the minimum space a manual label needs on the screen in pixel
854 int LyXText::labelFill(Buffer const & buffer, Paragraph const & par,
855                 Row const & row) const
856 {
857         pos_type last = par.beginOfBody();
858
859         BOOST_ASSERT(last > 0);
860
861         // -1 because a label ends with a space that is in the label
862         --last;
863
864         // a separator at this end does not count
865         if (par.isLineSeparator(last))
866                 --last;
867
868         int w = 0;
869         for (pos_type i = row.pos(); i <= last; ++i)
870                 w += singleWidth(buffer, par, i);
871
872         docstring const & label = par.params().labelWidthString();
873         if (label.empty())
874                 return 0;
875
876         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
877
878         return max(0, fm.width(label) - w);
879 }
880
881
882 LColor_color LyXText::backgroundColor() const
883 {
884         return LColor_color(LColor::color(background_color_));
885 }
886
887
888 void LyXText::setHeightOfRow(BufferView const & bv, pit_type const pit,
889                 Row & row)
890 {
891         Paragraph const & par = pars_[pit];
892         // get the maximum ascent and the maximum descent
893         double layoutasc = 0;
894         double layoutdesc = 0;
895         double const dh = defaultRowHeight();
896
897         // ok, let us initialize the maxasc and maxdesc value.
898         // Only the fontsize count. The other properties
899         // are taken from the layoutfont. Nicer on the screen :)
900         LyXLayout_ptr const & layout = par.layout();
901
902         // as max get the first character of this row then it can
903         // increase but not decrease the height. Just some point to
904         // start with so we don't have to do the assignment below too
905         // often.
906         Buffer const & buffer = *bv.buffer();
907         LyXFont font = getFont(buffer, par, row.pos());
908         LyXFont::FONT_SIZE const tmpsize = font.size();
909         font = getLayoutFont(buffer, pit);
910         LyXFont::FONT_SIZE const size = font.size();
911         font.setSize(tmpsize);
912
913         LyXFont labelfont = getLabelFont(buffer, par);
914
915         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
916         FontMetrics const & fontmetrics = theFontMetrics(font);
917
918         // these are minimum values
919         double const spacing_val = layout->spacing.getValue()
920                 * spacing(*bv.buffer(), par);
921         //lyxerr << "spacing_val = " << spacing_val << endl;
922         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
923         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
924
925         // insets may be taller
926         InsetList::const_iterator ii = par.insetlist.begin();
927         InsetList::const_iterator iend = par.insetlist.end();
928         for ( ; ii != iend; ++ii) {
929                 if (ii->pos >= row.pos() && ii->pos < row.endpos()) {
930                         maxasc  = max(maxasc,  ii->inset->ascent());
931                         maxdesc = max(maxdesc, ii->inset->descent());
932                 }
933         }
934
935         // Check if any custom fonts are larger (Asger)
936         // This is not completely correct, but we can live with the small,
937         // cosmetic error for now.
938         int labeladdon = 0;
939         pos_type const pos_end = row.endpos();
940
941         LyXFont::FONT_SIZE maxsize =
942                 par.highestFontInRange(row.pos(), pos_end, size);
943         if (maxsize > font.size()) {
944                 font.setSize(maxsize);
945                 maxasc  = max(maxasc,  fontmetrics.maxAscent());
946                 maxdesc = max(maxdesc, fontmetrics.maxDescent());
947         }
948
949         // This is nicer with box insets:
950         ++maxasc;
951         ++maxdesc;
952
953         row.ascent(maxasc);
954
955         // is it a top line?
956         if (row.pos() == 0) {
957                 Buffer const & buffer = *bv.buffer();
958                 BufferParams const & bufparams = buffer.params();
959                 // some parksips VERY EASY IMPLEMENTATION
960                 if (bufparams.paragraph_separation
961                     == BufferParams::PARSEP_SKIP
962                         && pit != 0
963                         && ((layout->isParagraph() && par.getDepth() == 0)
964                             || (pars_[pit - 1].layout()->isParagraph()
965                                 && pars_[pit - 1].getDepth() == 0)))
966                 {
967                                 maxasc += bufparams.getDefSkip().inPixels(bv);
968                 }
969
970                 if (par.params().startOfAppendix())
971                         maxasc += int(3 * dh);
972
973                 // This is special code for the chapter, since the label of this
974                 // layout is printed in an extra row
975                 if (layout->counter == "chapter"
976                     && !par.params().labelString().empty()) {
977                         labeladdon = int(labelfont_metrics.maxHeight()
978                                      * layout->spacing.getValue()
979                                      * spacing(buffer, par));
980                 }
981
982                 // special code for the top label
983                 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
984                      || layout->labeltype == LABEL_BIBLIO
985                      || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
986                     && isFirstInSequence(pit, paragraphs())
987                     && !par.getLabelstring().empty())
988                 {
989                         labeladdon = int(
990                                   labelfont_metrics.maxHeight()
991                                         * layout->spacing.getValue()
992                                         * spacing(*bv.buffer(), par)
993                                 + (layout->topsep + layout->labelbottomsep) * dh);
994                 }
995
996                 // Add the layout spaces, for example before and after
997                 // a section, or between the items of a itemize or enumerate
998                 // environment.
999
1000                 pit_type prev = depthHook(pit, pars_, par.getDepth());
1001                 if (prev != pit
1002                     && pars_[prev].layout() == layout
1003                     && pars_[prev].getDepth() == par.getDepth()
1004                     && pars_[prev].getLabelWidthString() == par.getLabelWidthString())
1005                 {
1006                         layoutasc = layout->itemsep * dh;
1007                 } else if (pit != 0 || row.pos() != 0) {
1008                         if (layout->topsep > 0)
1009                                 layoutasc = layout->topsep * dh;
1010                 }
1011
1012                 prev = outerHook(pit, pars_);
1013                 if (prev != pit_type(pars_.size())) {
1014                         maxasc += int(pars_[prev].layout()->parsep * dh);
1015                 } else if (pit != 0) {
1016                         if (pars_[pit - 1].getDepth() != 0 ||
1017                                         pars_[pit - 1].layout() == layout) {
1018                                 maxasc += int(layout->parsep * dh);
1019                         }
1020                 }
1021         }
1022
1023         // is it a bottom line?
1024         if (row.endpos() >= par.size()) {
1025                 // add the layout spaces, for example before and after
1026                 // a section, or between the items of a itemize or enumerate
1027                 // environment
1028                 pit_type nextpit = pit + 1;
1029                 if (nextpit != pit_type(pars_.size())) {
1030                         pit_type cpit = pit;
1031                         double usual = 0;
1032                         double unusual = 0;
1033
1034                         if (pars_[cpit].getDepth() > pars_[nextpit].getDepth()) {
1035                                 usual = pars_[cpit].layout()->bottomsep * dh;
1036                                 cpit = depthHook(cpit, paragraphs(), pars_[nextpit].getDepth());
1037                                 if (pars_[cpit].layout() != pars_[nextpit].layout()
1038                                         || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
1039                                 {
1040                                         unusual = pars_[cpit].layout()->bottomsep * dh;
1041                                 }
1042                                 layoutdesc = max(unusual, usual);
1043                         } else if (pars_[cpit].getDepth() == pars_[nextpit].getDepth()) {
1044                                 if (pars_[cpit].layout() != pars_[nextpit].layout()
1045                                         || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
1046                                         layoutdesc = int(pars_[cpit].layout()->bottomsep * dh);
1047                         }
1048                 }
1049         }
1050
1051         // incalculate the layout spaces
1052         maxasc  += int(layoutasc  * 2 / (2 + pars_[pit].getDepth()));
1053         maxdesc += int(layoutdesc * 2 / (2 + pars_[pit].getDepth()));
1054
1055         // FIXME: the correct way is to do the following is to move the 
1056         // following code in another method specially tailored for the 
1057         // main LyXText. The following test is thus bogus.
1058         LyXText const & text = buffer.text();
1059         // Top and bottom margin of the document (only at top-level)
1060         if (&text == this) {
1061                 if (pit == 0 && row.pos() == 0)
1062                         maxasc += 20;
1063                 if (pit + 1 == pit_type(pars_.size()) &&
1064                     row.endpos() == par.size())
1065                         maxdesc += 20;
1066         }
1067
1068         row.ascent(maxasc + labeladdon);
1069         row.descent(maxdesc);
1070 }
1071
1072
1073 namespace {
1074
1075 }
1076
1077 void LyXText::breakParagraph(LCursor & cur, bool keep_layout)
1078 {
1079         BOOST_ASSERT(this == cur.text());
1080
1081         Paragraph & cpar = cur.paragraph();
1082         pit_type cpit = cur.pit();
1083
1084         LyXTextClass const & tclass = cur.buffer().params().getLyXTextClass();
1085         LyXLayout_ptr const & layout = cpar.layout();
1086
1087         // this is only allowed, if the current paragraph is not empty
1088         // or caption and if it has not the keepempty flag active
1089         if (cur.lastpos() == 0 && !cpar.allowEmpty()
1090            && layout->labeltype != LABEL_SENSITIVE)
1091                 return;
1092
1093         // a layout change may affect also the following paragraph
1094         recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
1095
1096         // Always break behind a space
1097         // It is better to erase the space (Dekel)
1098         if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
1099                 // FIXME: change tracking (MG)
1100                 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1101
1102         // How should the layout for the new paragraph be?
1103         int preserve_layout = 0;
1104         if (keep_layout)
1105                 preserve_layout = 2;
1106         else
1107                 preserve_layout = layout->isEnvironment();
1108
1109         // We need to remember this before we break the paragraph, because
1110         // that invalidates the layout variable
1111         bool sensitive = layout->labeltype == LABEL_SENSITIVE;
1112
1113         // we need to set this before we insert the paragraph.
1114         bool const isempty = cpar.allowEmpty() && cpar.empty();
1115
1116         lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
1117                          cur.pos(), preserve_layout);
1118
1119         // After this, neither paragraph contains any rows!
1120
1121         cpit = cur.pit();
1122         pit_type next_par = cpit + 1;
1123
1124         // well this is the caption hack since one caption is really enough
1125         if (sensitive) {
1126                 if (cur.pos() == 0)
1127                         // set to standard-layout
1128                         pars_[cpit].applyLayout(tclass.defaultLayout());
1129                 else
1130                         // set to standard-layout
1131                         pars_[next_par].applyLayout(tclass.defaultLayout());
1132         }
1133
1134         while (!pars_[next_par].empty() && pars_[next_par].isNewline(0))
1135                 // FIXME: change tracking (MG)
1136                 pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges);
1137
1138         ParIterator current_it(cur);
1139         ParIterator last_it(cur);
1140         ++last_it;
1141         ++last_it;
1142
1143         updateLabels(cur.buffer(), current_it, last_it);
1144
1145         // Mark "carriage return" as inserted if change tracking:
1146         if (cur.buffer().params().trackChanges) {
1147                 // FIXME: Change tracking (MG)
1148                 cur.paragraph().setChange(cur.paragraph().size(),
1149                         Change(Change::INSERTED));
1150         }
1151
1152         // FIXME: back spacing have nothing to do with setting a cursor.
1153         // Because of the mix between the model (the paragraph contents) and the
1154         // view (the paragraph breaking in rows, we have to do this here.
1155         redoParagraph(cur.bv(), cpit);
1156         redoParagraph(cur.bv(), cpit + 1);
1157
1158         // This check is necessary. Otherwise the new empty paragraph will
1159         // be deleted automatically. And it is more friendly for the user!
1160         if (cur.pos() != 0 || isempty)
1161                 setCursor(cur, cur.pit() + 1, 0);
1162         else
1163                 setCursor(cur, cur.pit(), 0);
1164 }
1165
1166
1167 // insert a character, moves all the following breaks in the
1168 // same Paragraph one to the right and make a rebreak
1169 void LyXText::insertChar(LCursor & cur, char_type c)
1170 {
1171         BOOST_ASSERT(this == cur.text());
1172         BOOST_ASSERT(c != Paragraph::META_INSET);
1173
1174         recordUndo(cur, Undo::INSERT);
1175
1176         Buffer const & buffer = cur.buffer();
1177         Paragraph & par = cur.paragraph();
1178         // try to remove this
1179         pit_type const pit = cur.pit();
1180
1181         bool const freeSpacing = par.layout()->free_spacing ||
1182                 par.isFreeSpacing();
1183
1184         if (lyxrc.auto_number) {
1185                 static docstring const number_operators = from_ascii("+-/*");
1186                 static docstring const number_unary_operators = from_ascii("+-");
1187                 static docstring const number_seperators = from_ascii(".,:");
1188
1189                 if (current_font.number() == LyXFont::ON) {
1190                         if (!isDigit(c) && !contains(number_operators, c) &&
1191                             !(contains(number_seperators, c) &&
1192                               cur.pos() != 0 &&
1193                               cur.pos() != cur.lastpos() &&
1194                               getFont(buffer, par, cur.pos()).number() == LyXFont::ON &&
1195                               getFont(buffer, par, cur.pos() - 1).number() == LyXFont::ON)
1196                            )
1197                                 number(cur); // Set current_font.number to OFF
1198                 } else if (isDigit(c) &&
1199                            real_current_font.isVisibleRightToLeft()) {
1200                         number(cur); // Set current_font.number to ON
1201
1202                         if (cur.pos() != 0) {
1203                                 char_type const c = par.getChar(cur.pos() - 1);
1204                                 if (contains(number_unary_operators, c) &&
1205                                     (cur.pos() == 1
1206                                      || par.isSeparator(cur.pos() - 2)
1207                                      || par.isNewline(cur.pos() - 2))
1208                                   ) {
1209                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1210                                 } else if (contains(number_seperators, c)
1211                                      && cur.pos() >= 2
1212                                      && getFont(buffer, par, cur.pos() - 2).number() == LyXFont::ON) {
1213                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1214                                 }
1215                         }
1216                 }
1217         }
1218
1219         // First check, if there will be two blanks together or a blank at
1220         // the beginning of a paragraph.
1221         // I decided to handle blanks like normal characters, the main
1222         // difference are the special checks when calculating the row.fill
1223         // (blank does not count at the end of a row) and the check here
1224
1225         // When the free-spacing option is set for the current layout,
1226         // disable the double-space checking
1227         if (!freeSpacing && isLineSeparatorChar(c)) {
1228                 if (cur.pos() == 0) {
1229                         static bool sent_space_message = false;
1230                         if (!sent_space_message) {
1231                                 cur.message(_("You cannot insert a space at the "
1232                                                            "beginning of a paragraph. Please read the Tutorial."));
1233                                 sent_space_message = true;
1234                         }
1235                         return;
1236                 }
1237                 BOOST_ASSERT(cur.pos() > 0);
1238                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1239                     && !par.isDeleted(cur.pos() - 1)) {
1240                         static bool sent_space_message = false;
1241                         if (!sent_space_message) {
1242                                 cur.message(_("You cannot type two spaces this way. "
1243                                                            "Please read the Tutorial."));
1244                                 sent_space_message = true;
1245                         }
1246                         return;
1247                 }
1248         }
1249
1250         par.insertChar(cur.pos(), c, current_font, cur.buffer().params().trackChanges);
1251
1252         // FIXME: back spacing have nothing to do with setting a cursor.
1253         // Because of the mix between the model (the paragraph contents) and the
1254         // view (the paragraph breaking in rows, we have to do this here.
1255         redoParagraph(cur.bv(), cur.pit());
1256         setCursor(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1257         charInserted();
1258 }
1259
1260
1261 void LyXText::charInserted()
1262 {
1263         // Here we call finishUndo for every 20 characters inserted.
1264         // This is from my experience how emacs does it. (Lgb)
1265         static unsigned int counter;
1266         if (counter < 20) {
1267                 ++counter;
1268         } else {
1269                 finishUndo();
1270                 counter = 0;
1271         }
1272 }
1273
1274
1275 RowMetrics LyXText::computeRowMetrics(Buffer const & buffer,
1276                 pit_type const pit, Row const & row) const
1277 {
1278         RowMetrics result;
1279         Paragraph const & par = pars_[pit];
1280
1281         double w = dim_.wid - row.width();
1282
1283         bool const is_rtl = isRTL(buffer, par);
1284         if (is_rtl)
1285                 result.x = rightMargin(buffer, par);
1286         else
1287                 result.x = leftMargin(buffer, pit, row.pos());
1288
1289         // is there a manual margin with a manual label
1290         LyXLayout_ptr const & layout = par.layout();
1291
1292         if (layout->margintype == MARGIN_MANUAL
1293             && layout->labeltype == LABEL_MANUAL) {
1294                 /// We might have real hfills in the label part
1295                 int nlh = numberOfLabelHfills(par, row);
1296
1297                 // A manual label par (e.g. List) has an auto-hfill
1298                 // between the label text and the body of the
1299                 // paragraph too.
1300                 // But we don't want to do this auto hfill if the par
1301                 // is empty.
1302                 if (!par.empty())
1303                         ++nlh;
1304
1305                 if (nlh && !par.getLabelWidthString().empty())
1306                         result.label_hfill = labelFill(buffer, par, row) / double(nlh);
1307         }
1308
1309         // are there any hfills in the row?
1310         int const nh = numberOfHfills(par, row);
1311
1312         if (nh) {
1313                 if (w > 0)
1314                         result.hfill = w / nh;
1315         // we don't have to look at the alignment if it is ALIGN_LEFT and
1316         // if the row is already larger then the permitted width as then
1317         // we force the LEFT_ALIGN'edness!
1318         } else if (int(row.width()) < maxwidth_) {
1319                 // is it block, flushleft or flushright?
1320                 // set x how you need it
1321                 int align;
1322                 if (par.params().align() == LYX_ALIGN_LAYOUT)
1323                         align = layout->align;
1324                 else
1325                         align = par.params().align();
1326
1327                 // Display-style insets should always be on a centred row
1328                 // The test on par.size() is to catch zero-size pars, which
1329                 // would trigger the assert in Paragraph::getInset().
1330                 //inset = par.size() ? par.getInset(row.pos()) : 0;
1331                 if (!par.empty()
1332                     && par.isInset(row.pos())
1333                     && par.getInset(row.pos())->display())
1334                 {
1335                         align = LYX_ALIGN_CENTER;
1336                 }
1337
1338                 switch (align) {
1339                 case LYX_ALIGN_BLOCK: {
1340                         int const ns = numberOfSeparators(par, row);
1341                         bool disp_inset = false;
1342                         if (row.endpos() < par.size()) {
1343                                 InsetBase const * in = par.getInset(row.endpos());
1344                                 if (in)
1345                                         disp_inset = in->display();
1346                         }
1347                         // If we have separators, this is not the last row of a
1348                         // par, does not end in newline, and is not row above a
1349                         // display inset... then stretch it
1350                         if (ns
1351                             && row.endpos() < par.size()
1352                             && !par.isNewline(row.endpos() - 1)
1353                             && !disp_inset
1354                                 ) {
1355                                 result.separator = w / ns;
1356                         } else if (is_rtl) {
1357                                 result.x += w;
1358                         }
1359                         break;
1360                 }
1361                 case LYX_ALIGN_RIGHT:
1362                         result.x += w;
1363                         break;
1364                 case LYX_ALIGN_CENTER:
1365                         result.x += w / 2;
1366                         break;
1367                 }
1368         }
1369
1370         bidi.computeTables(par, buffer, row);
1371         if (is_rtl) {
1372                 pos_type body_pos = par.beginOfBody();
1373                 pos_type end = row.endpos();
1374
1375                 if (body_pos > 0
1376                     && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1377                 {
1378                         docstring const lsep = from_utf8(layout->labelsep);
1379                         result.x += theFontMetrics(getLabelFont(buffer, par)).width(lsep);
1380                         if (body_pos <= end)
1381                                 result.x += result.label_hfill;
1382                 }
1383         }
1384
1385         return result;
1386 }
1387
1388
1389 // the cursor set functions have a special mechanism. When they
1390 // realize, that you left an empty paragraph, they will delete it.
1391
1392 bool LyXText::cursorRightOneWord(LCursor & cur)
1393 {
1394         BOOST_ASSERT(this == cur.text());
1395
1396         LCursor old = cur;
1397
1398         if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
1399                 ++old.pit();
1400                 old.pos() = 0;
1401         } else {
1402                 // Advance through word.
1403                 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
1404                         ++old.pos();
1405                 // Skip through trailing nonword stuff.
1406                 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
1407                         ++old.pos();
1408         }
1409         return setCursor(cur, old.pit(), old.pos());
1410 }
1411
1412
1413 bool LyXText::cursorLeftOneWord(LCursor & cur)
1414 {
1415         BOOST_ASSERT(this == cur.text());
1416
1417         LCursor old = cur;
1418
1419         if (old.pos() == 0 && old.pit() != 0) {
1420                 --old.pit();
1421                 old.pos() = old.lastpos();
1422         } else {
1423                 // Skip through initial nonword stuff.
1424                 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
1425                         --old.pos();
1426                 // Advance through word.
1427                 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
1428                         --old.pos();
1429         }
1430         return setCursor(cur, old.pit(), old.pos());
1431 }
1432
1433
1434 void LyXText::selectWord(LCursor & cur, word_location loc)
1435 {
1436         BOOST_ASSERT(this == cur.text());
1437         CursorSlice from = cur.top();
1438         CursorSlice to = cur.top();
1439         getWord(from, to, loc);
1440         if (cur.top() != from)
1441                 setCursor(cur, from.pit(), from.pos());
1442         if (to == from)
1443                 return;
1444         cur.resetAnchor();
1445         setCursor(cur, to.pit(), to.pos());
1446         cur.setSelection();
1447 }
1448
1449
1450 // Select the word currently under the cursor when no
1451 // selection is currently set
1452 bool LyXText::selectWordWhenUnderCursor(LCursor & cur, word_location loc)
1453 {
1454         BOOST_ASSERT(this == cur.text());
1455         if (cur.selection())
1456                 return false;
1457         selectWord(cur, loc);
1458         return cur.selection();
1459 }
1460
1461
1462 void LyXText::acceptChange(LCursor & cur)
1463 {
1464         BOOST_ASSERT(this == cur.text());
1465         if (!cur.selection() && cur.lastpos() != 0)
1466                 return;
1467
1468         recordUndoSelection(cur, Undo::INSERT);
1469
1470         DocIterator it = cur.selectionBegin();
1471         DocIterator et = cur.selectionEnd();
1472         pit_type pit = it.pit();
1473         bool isDeleted = pars_[pit].isDeleted(it.pos());
1474         for (; pit <= et.pit(); ++pit) {
1475                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1476                 pos_type right =
1477                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1478                 pars_[pit].acceptChanges(left, right);
1479         }
1480         if (isDeleted) {
1481                 ParagraphList & plist = paragraphs();
1482                 if (it.pit() + 1 < et.pit())
1483                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1484                                     boost::next(plist.begin(), et.pit()));
1485
1486                 // Paragraph merge if appropriate:
1487                 // FIXME: change tracking (MG)
1488                 if (pars_[it.pit()].isDeleted(pars_[it.pit()].size())) {
1489                         setCursorIntern(cur, it.pit() + 1, 0);
1490                         backspacePos0(cur);
1491                 }
1492         }
1493         finishUndo();
1494         cur.clearSelection();
1495         setCursorIntern(cur, it.pit(), 0);
1496 }
1497
1498
1499 void LyXText::rejectChange(LCursor & cur)
1500 {
1501         BOOST_ASSERT(this == cur.text());
1502         if (!cur.selection() && cur.lastpos() != 0)
1503                 return;
1504
1505         recordUndoSelection(cur, Undo::INSERT);
1506
1507         DocIterator it = cur.selectionBegin();
1508         DocIterator et = cur.selectionEnd();
1509         pit_type pit = it.pit();
1510         bool isInserted = pars_[pit].isInserted(it.pos());
1511         for (; pit <= et.pit(); ++pit) {
1512                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1513                 pos_type right =
1514                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1515                 pars_[pit].rejectChanges(left, right);
1516         }
1517         if (isInserted) {
1518                 ParagraphList & plist = paragraphs();
1519                 if (it.pit() + 1 < et.pit())
1520                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1521                                     boost::next(plist.begin(), et.pit()));
1522                 // Paragraph merge if appropriate:
1523                 // FIXME: change tracking (MG)
1524                 if (pars_[it.pit()].isInserted(pars_[it.pit()].size())) {
1525                         setCursorIntern(cur, it.pit() + 1, 0);
1526                         backspacePos0(cur);
1527                 }
1528         }
1529         finishUndo();
1530         cur.clearSelection();
1531         setCursorIntern(cur, it.pit(), 0);
1532 }
1533
1534
1535 // Delete from cursor up to the end of the current or next word.
1536 void LyXText::deleteWordForward(LCursor & cur)
1537 {
1538         BOOST_ASSERT(this == cur.text());
1539         if (cur.lastpos() == 0)
1540                 cursorRight(cur);
1541         else {
1542                 cur.resetAnchor();
1543                 cur.selection() = true;
1544                 cursorRightOneWord(cur);
1545                 cur.setSelection();
1546                 cutSelection(cur, true, false);
1547         }
1548 }
1549
1550
1551 // Delete from cursor to start of current or prior word.
1552 void LyXText::deleteWordBackward(LCursor & cur)
1553 {
1554         BOOST_ASSERT(this == cur.text());
1555         if (cur.lastpos() == 0)
1556                 cursorLeft(cur);
1557         else {
1558                 cur.resetAnchor();
1559                 cur.selection() = true;
1560                 cursorLeftOneWord(cur);
1561                 cur.setSelection();
1562                 cutSelection(cur, true, false);
1563         }
1564 }
1565
1566
1567 // Kill to end of line.
1568 void LyXText::deleteLineForward(LCursor & cur)
1569 {
1570         BOOST_ASSERT(this == cur.text());
1571         if (cur.lastpos() == 0) {
1572                 // Paragraph is empty, so we just go to the right
1573                 cursorRight(cur);
1574         } else {
1575                 cur.resetAnchor();
1576                 cur.selection() = true; // to avoid deletion
1577                 cursorEnd(cur);
1578                 cur.setSelection();
1579                 // What is this test for ??? (JMarc)
1580                 if (!cur.selection())
1581                         deleteWordForward(cur);
1582                 else
1583                         cutSelection(cur, true, false);
1584         }
1585 }
1586
1587
1588 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
1589 {
1590         BOOST_ASSERT(this == cur.text());
1591         CursorSlice from;
1592         CursorSlice to;
1593
1594         if (cur.selection()) {
1595                 from = cur.selBegin();
1596                 to = cur.selEnd();
1597         } else {
1598                 from = cur.top();
1599                 getWord(from, to, PARTIAL_WORD);
1600                 cursorRightOneWord(cur);
1601         }
1602
1603         recordUndoSelection(cur);
1604
1605         pos_type pos = from.pos();
1606         int par = from.pit();
1607
1608         while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1609                 pit_type pit = par;
1610                 if (pos == pars_[pit].size()) {
1611                         ++par;
1612                         pos = 0;
1613                         continue;
1614                 }
1615                 char_type c = pars_[pit].getChar(pos);
1616                 if (c != Paragraph::META_INSET) {
1617                         switch (action) {
1618                         case text_lowercase:
1619                                 c = lowercase(c);
1620                                 break;
1621                         case text_capitalization:
1622                                 c = uppercase(c);
1623                                 action = text_lowercase;
1624                                 break;
1625                         case text_uppercase:
1626                                 c = uppercase(c);
1627                                 break;
1628                         }
1629                 }
1630
1631                 // FIXME: change tracking (MG)
1632                 // sorry but we are no longer allowed to set a single character directly
1633                 // we have to rewrite this method in terms of erase&insert operations
1634                 //pars_[pit].setChar(pos, c);
1635                 ++pos;
1636         }
1637 }
1638
1639
1640 bool LyXText::erase(LCursor & cur)
1641 {
1642         BOOST_ASSERT(this == cur.text());
1643         bool needsUpdate = false;
1644         Paragraph & par = cur.paragraph();
1645
1646         if (cur.pos() != cur.lastpos()) {
1647                 // this is the code for a normal delete, not pasting
1648                 // any paragraphs
1649                 recordUndo(cur, Undo::DELETE);
1650                 // FIXME: change tracking (MG)
1651                 par.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1652                 if (par.isDeleted(cur.pos()))
1653                         cur.forwardPos();
1654                 needsUpdate = true;
1655         } else if (cur.pit() != cur.lastpit()) {
1656                 if (cur.buffer().params().trackChanges
1657                     && par.isInserted(cur.pos())) {
1658                         // mark "carriage return" as deleted:
1659                         // FIXME: Change tracking (MG)
1660                         par.setChange(cur.pos(), Change(Change::DELETED));
1661                         cur.forwardPos();
1662                         needsUpdate = true;
1663                 } else {
1664                         setCursorIntern(cur, cur.pit() + 1, 0);
1665                         needsUpdate = backspacePos0(cur);
1666                         // FIXME: Change tracking (MG)
1667                         if (cur.paragraph().isDeleted(cur.pos()))
1668                                 cur.forwardPos();
1669                 }
1670         } else
1671                 needsUpdate = dissolveInset(cur);
1672
1673         // Make sure the cursor is correct. Is this really needed?
1674         if (needsUpdate)
1675                 setCursorIntern(cur, cur.pit(), cur.pos());
1676         
1677         return needsUpdate;
1678 }
1679
1680
1681 bool LyXText::backspacePos0(LCursor & cur)
1682 {
1683         BOOST_ASSERT(this == cur.text());
1684         if (cur.pit() == 0)
1685                 return false;
1686
1687         bool needsUpdate = false;
1688
1689         BufferParams const & bufparams = cur.buffer().params();
1690         LyXTextClass const & tclass = bufparams.getLyXTextClass();
1691         ParagraphList & plist = cur.text()->paragraphs();
1692         Paragraph const & par = cur.paragraph();
1693         LCursor prevcur = cur;
1694         --prevcur.pit();
1695         prevcur.pos() = prevcur.lastpos();
1696         Paragraph const & prevpar = prevcur.paragraph();
1697
1698         // is it an empty paragraph?
1699         if (cur.lastpos() == 0 
1700             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1701                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1702                 plist.erase(boost::next(plist.begin(), cur.pit()));
1703                 needsUpdate = true;
1704         }
1705         // is previous par empty?
1706         else if (prevcur.lastpos() == 0 
1707                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1708                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1709                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1710                 needsUpdate = true;
1711         }
1712         // Pasting is not allowed, if the paragraphs have different
1713         // layout. I think it is a real bug of all other
1714         // word processors to allow it. It confuses the user.
1715         // Correction: Pasting is always allowed with standard-layout
1716         else if (par.layout() == prevpar.layout()
1717                  || par.layout() == tclass.defaultLayout()) {
1718                 recordUndo(cur, Undo::ATOMIC, prevcur.pit());
1719                 mergeParagraph(bufparams, plist, prevcur.pit());
1720                 needsUpdate = true;
1721         }
1722
1723         if (needsUpdate) {
1724                 updateLabels(cur.buffer());
1725                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1726         }
1727
1728         return needsUpdate;
1729 }
1730
1731
1732
1733
1734 bool LyXText::backspace(LCursor & cur)
1735 {
1736         BOOST_ASSERT(this == cur.text());
1737         bool needsUpdate = false;
1738         if (cur.pos() == 0) {
1739                 if (cur.pit() == 0)
1740                         return dissolveInset(cur);
1741
1742                 if (cur.buffer().params().trackChanges) {
1743                         // FIXME: Change tracking (MG)
1744                         // Previous paragraph, mark "carriage return" as
1745                         // deleted:
1746                         Paragraph & par = pars_[cur.pit() - 1];
1747                         // Take care of a just inserted para break:
1748                         // FIXME: change tracking (MG)
1749                         if (!par.isInserted(par.size())) {
1750                                 // FIXME: change tracking (MG)
1751                                 par.setChange(par.size(), Change(Change::DELETED));
1752                                 setCursorIntern(cur, cur.pit() - 1, par.size());
1753                                 return true;
1754                         }
1755                 }
1756
1757                 // The cursor is at the beginning of a paragraph, so
1758                 // the backspace will collapse two paragraphs into one.
1759                 needsUpdate = backspacePos0(cur);
1760
1761         } else {
1762                 // this is the code for a normal backspace, not pasting
1763                 // any paragraphs
1764                 recordUndo(cur, Undo::DELETE);
1765                 // We used to do cursorLeftIntern() here, but it is
1766                 // not a good idea since it triggers the auto-delete
1767                 // mechanism. So we do a cursorLeftIntern()-lite,
1768                 // without the dreaded mechanism. (JMarc)
1769                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1770                                 false, cur.boundary());
1771                 // FIXME: change tracking (MG)
1772                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1773         }
1774
1775         if (cur.pos() == cur.lastpos())
1776                 setCurrentFont(cur);
1777
1778         // FIXME: back spacing have nothing to do with setting a cursor.
1779         // Because of the mix between the model (the paragraph contents) and the
1780         // view (the paragraph breaking in rows, we have to do this here.
1781         redoParagraph(cur.bv(), cur.pit());
1782         setCursor(cur, cur.pit(), cur.pos(), false, cur.boundary());
1783
1784         return needsUpdate;
1785 }
1786
1787
1788 bool LyXText::dissolveInset(LCursor & cur) {
1789         BOOST_ASSERT(this == cur.text());
1790
1791         if (isMainText(*cur.bv().buffer()) || cur.inset().nargs() != 1)
1792                 return false;
1793
1794         recordUndoInset(cur);
1795         cur.selHandle(false);
1796         // save position
1797         pos_type spos = cur.pos();
1798         pit_type spit = cur.pit();
1799         ParagraphList plist;
1800         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1801                 plist = paragraphs();
1802         cur.popLeft();
1803         // store cursor offset
1804         if (spit == 0)
1805                 spos += cur.pos();
1806         spit += cur.pit();
1807         Buffer & b = cur.buffer();
1808         // FIXME: change tracking (MG)
1809         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1810         if (!plist.empty()) {
1811                 pasteParagraphList(cur, plist, b.params().textclass,
1812                                    b.errorList("Paste"));
1813                 // restore position
1814                 cur.pit() = std::min(cur.lastpit(), spit);
1815                 cur.pos() = std::min(cur.lastpos(), spos);
1816         }
1817         cur.clearSelection();
1818         cur.resetAnchor();
1819         return true;
1820 }
1821
1822
1823 Row const & LyXText::firstRow() const
1824 {
1825         return *paragraphs().front().rows().begin();
1826 }
1827
1828
1829 bool LyXText::redoParagraph(BufferView & bv, pit_type const pit)
1830 {
1831         // remove rows of paragraph, keep track of height changes
1832         Paragraph & par = pars_[pit];
1833         Buffer const & buffer = *bv.buffer();
1834
1835         // Add bibitem insets if necessary
1836         if (par.layout()->labeltype == LABEL_BIBLIO) {
1837                 bool hasbibitem(false);
1838                 if (!par.insetlist.empty()
1839                         // Insist on it being in pos 0
1840                         && par.getChar(0) == Paragraph::META_INSET) {
1841                         InsetBase * inset = par.insetlist.begin()->inset;
1842                         if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
1843                                 hasbibitem = true;
1844                 }
1845                 if (!hasbibitem) {
1846                         InsetBibitem * inset(new
1847                                 InsetBibitem(InsetCommandParams("bibitem")));
1848                         par.insertInset(0, static_cast<InsetBase *>(inset),
1849                                         Change(buffer.params().trackChanges ?
1850                                                Change::INSERTED : Change::UNCHANGED));
1851                         bv.cursor().posRight();
1852                 }
1853         }
1854
1855         // Optimisation: this is used in the next two loops
1856         // so better to calculate that once here.
1857         int right_margin = rightMargin(buffer, par);
1858
1859         // redo insets
1860         // FIXME: We should always use getFont(), see documentation of
1861         // noFontChange() in insetbase.h.
1862         LyXFont const bufferfont = buffer.params().getFont();
1863         InsetList::iterator ii = par.insetlist.begin();
1864         InsetList::iterator iend = par.insetlist.end();
1865         for (; ii != iend; ++ii) {
1866                 Dimension dim;
1867                 int const w = maxwidth_ - leftMargin(buffer, pit, ii->pos)
1868                         - right_margin;
1869                 LyXFont const & font = ii->inset->noFontChange() ?
1870                         bufferfont :
1871                         getFont(buffer, par, ii->pos);
1872                 MetricsInfo mi(&bv, font, w);
1873                 ii->inset->metrics(mi, dim);
1874         }
1875
1876         // rebreak the paragraph
1877         par.rows().clear();
1878         Dimension dim;
1879
1880         par.setBeginOfBody();
1881         pos_type z = 0;
1882         do {
1883                 Row row(z);
1884                 rowBreakPoint(buffer, right_margin, pit, row);
1885                 setRowWidth(buffer, pit, row);
1886                 setHeightOfRow(bv, pit, row);
1887                 par.rows().push_back(row);
1888                 dim.wid = std::max(dim.wid, row.width());
1889                 dim.des += row.height();
1890                 z = row.endpos();
1891         } while (z < par.size());
1892
1893         // Make sure that if a par ends in newline, there is one more row
1894         // under it
1895         // FIXME this is a dirty trick. Now the _same_ position in the
1896         // paragraph occurs in _two_ different rows, and has two different
1897         // display positions, leading to weird behaviour when moving up/down.
1898         if (z > 0 && par.isNewline(z - 1)) {
1899                 Row row(z - 1);
1900                 row.endpos(z - 1);
1901                 setRowWidth(buffer, pit, row);
1902                 setHeightOfRow(bv, pit, row);
1903                 par.rows().push_back(row);
1904                 dim.des += row.height();
1905         }
1906
1907         dim.asc += par.rows()[0].ascent();
1908         dim.des -= par.rows()[0].ascent();
1909
1910         bool const same = dim == par.dim();
1911
1912         par.dim() = dim;
1913         //lyxerr << "redoParagraph: " << par.rows().size() << " rows\n";
1914
1915         return !same;
1916 }
1917
1918
1919 void LyXText::metrics(MetricsInfo & mi, Dimension & dim)
1920 {
1921         //BOOST_ASSERT(mi.base.textwidth);
1922         if (mi.base.textwidth)
1923                 maxwidth_ = mi.base.textwidth;
1924         //lyxerr << "LyXText::metrics: width: " << mi.base.textwidth
1925         //      << " maxWidth: " << maxwidth_ << "\nfont: " << mi.base.font << endl;
1926         // save the caller's font locally:
1927         font_ = mi.base.font;
1928
1929         unsigned int h = 0;
1930         unsigned int w = 0;
1931         for (pit_type pit = 0, n = paragraphs().size(); pit != n; ++pit) {
1932                 redoParagraph(*mi.base.bv, pit);
1933                 Paragraph & par = paragraphs()[pit];
1934                 h += par.height();
1935                 if (w < par.width())
1936                         w = par.width();
1937         }
1938
1939         dim.wid = w;
1940         dim.asc = pars_[0].ascent();
1941         dim.des = h - dim.asc;
1942
1943         dim_ = dim;
1944 }
1945
1946
1947 // only used for inset right now. should also be used for main text
1948 void LyXText::draw(PainterInfo & pi, int x, int y) const
1949 {
1950         paintTextInset(*this, pi, x, y);
1951 }
1952
1953
1954 // only used for inset right now. should also be used for main text
1955 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1956 {
1957         LCursor & cur = pi.base.bv->cursor();
1958         if (!cur.selection())
1959                 return;
1960         if (!ptr_cmp(cur.text(), this))
1961                 return;
1962
1963         if (lyxerr.debugging(Debug::DEBUG)) {
1964                 lyxerr[Debug::DEBUG]
1965                         << BOOST_CURRENT_FUNCTION
1966                         << "draw selection at " << x
1967                         << endl;
1968         }
1969
1970         DocIterator beg = cur.selectionBegin();
1971         DocIterator end = cur.selectionEnd();
1972
1973         BufferView & bv = *pi.base.bv;
1974         Buffer const & buffer = *bv.buffer();
1975
1976         // the selection doesn't touch the visible screen
1977         if (bv_funcs::status(&bv, beg) == bv_funcs::CUR_BELOW
1978             || bv_funcs::status(&bv, end) == bv_funcs::CUR_ABOVE)
1979                 return;
1980
1981         Paragraph const & par1 = pars_[beg.pit()];
1982         Paragraph const & par2 = pars_[end.pit()];
1983
1984         bool const above = (bv_funcs::status(&bv, beg)
1985                             == bv_funcs::CUR_ABOVE);
1986         bool const below = (bv_funcs::status(&bv, end)
1987                             == bv_funcs::CUR_BELOW);
1988         int y1,y2,x1,x2;
1989         if (above) {
1990                 y1 = 0;
1991                 y2 = 0;
1992                 x1 = 0;
1993                 x2 = dim_.wid;
1994         } else {
1995                 Row const & row1 = par1.getRow(beg.pos(), beg.boundary());
1996                 y1 = bv_funcs::getPos(bv, beg, beg.boundary()).y_ - row1.ascent();
1997                 y2 = y1 + row1.height();
1998                 int const startx = cursorX(buffer, beg.top(), beg.boundary());
1999                 if (!isRTL(buffer, par1)) {
2000                         x1 = startx;
2001                         x2 = 0 + dim_.wid;
2002                 }
2003                 else {
2004                         x1 = 0;
2005                         x2 = startx;
2006                 }
2007         }
2008
2009         int Y1,Y2,X1,X2;
2010         if (below) {
2011                 Y1 = bv.workHeight();
2012                 Y2 = bv.workHeight();
2013                 X1 = 0;
2014                 X2 = dim_.wid;
2015         } else {
2016                 Row const & row2 = par2.getRow(end.pos(), end.boundary());
2017                 Y1 = bv_funcs::getPos(bv, end, end.boundary()).y_ - row2.ascent();
2018                 Y2 = Y1 + row2.height();
2019                 int const endx = cursorX(buffer, end.top(), end.boundary());
2020                 if (!isRTL(buffer, par2)) {
2021                         X1 = 0;
2022                         X2 = endx;
2023                 }
2024                 else {
2025                         X1 = endx;
2026                         X2 = 0 + dim_.wid;
2027                 }
2028         }
2029
2030         if (!above && !below && &par1.getRow(beg.pos(), beg.boundary())
2031             == &par2.getRow(end.pos(), end.boundary()))
2032         {
2033                 // paint only one rectangle
2034                 int const b( !isRTL(*bv.buffer(), par1) ? x + x1 : x + X1 );
2035                 int const w( !isRTL(*bv.buffer(), par1) ? X2 - x1 : x2 - X1 );
2036                 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
2037                 return;
2038         }
2039
2040         if (lyxerr.debugging(Debug::DEBUG)) {
2041                 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
2042                            << "X1:" << X1 << " x2: " << X2 << " wid: " << dim_.wid
2043                         << endl;
2044         }
2045
2046         // paint upper rectangle
2047         pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
2048                                       LColor::selection);
2049         // paint bottom rectangle
2050         pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
2051                                       LColor::selection);
2052         // paint center rectangle
2053         pi.pain.fillRectangle(x, y2, dim_.wid,
2054                               Y1 - y2, LColor::selection);
2055 }
2056
2057 bool LyXText::isLastRow(pit_type pit, Row const & row) const
2058 {
2059         return row.endpos() >= pars_[pit].size()
2060                 && pit + 1 == pit_type(paragraphs().size());
2061 }
2062
2063
2064 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
2065 {
2066         return row.pos() == 0 && pit == 0;
2067 }
2068
2069
2070 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
2071         word_location const loc)
2072 {
2073         Paragraph const & from_par = pars_[from.pit()];
2074         switch (loc) {
2075         case WHOLE_WORD_STRICT:
2076                 if (from.pos() == 0 || from.pos() == from_par.size()
2077                     || !from_par.isLetter(from.pos())
2078                     || !from_par.isLetter(from.pos() - 1)) {
2079                         to = from;
2080                         return;
2081                 }
2082                 // no break here, we go to the next
2083
2084         case WHOLE_WORD:
2085                 // If we are already at the beginning of a word, do nothing
2086                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
2087                         break;
2088                 // no break here, we go to the next
2089
2090         case PREVIOUS_WORD:
2091                 // always move the cursor to the beginning of previous word
2092                 while (from.pos() && from_par.isLetter(from.pos() - 1))
2093                         --from.pos();
2094                 break;
2095         case NEXT_WORD:
2096                 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
2097                        << endl;
2098                 break;
2099         case PARTIAL_WORD:
2100                 // no need to move the 'from' cursor
2101                 break;
2102         }
2103         to = from;
2104         Paragraph & to_par = pars_[to.pit()];
2105         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
2106                 ++to.pos();
2107 }
2108
2109
2110 void LyXText::write(Buffer const & buf, std::ostream & os) const
2111 {
2112         ParagraphList::const_iterator pit = paragraphs().begin();
2113         ParagraphList::const_iterator end = paragraphs().end();
2114         depth_type dth = 0;
2115         for (; pit != end; ++pit)
2116                 pit->write(buf, os, buf.params(), dth);
2117 }
2118
2119
2120 bool LyXText::read(Buffer const & buf, LyXLex & lex, ErrorList & errorList)
2121 {
2122         depth_type depth = 0;
2123
2124         while (lex.isOK()) {
2125                 lex.nextToken();
2126                 string const token = lex.getString();
2127
2128                 if (token.empty())
2129                         continue;
2130
2131                 if (token == "\\end_inset")
2132                         break;
2133
2134                 if (token == "\\end_body")
2135                         continue;
2136
2137                 if (token == "\\begin_body")
2138                         continue;
2139
2140                 if (token == "\\end_document")
2141                         return false;
2142
2143                 if (token == "\\begin_layout") {
2144                         lex.pushToken(token);
2145
2146                         Paragraph par;
2147                         par.params().depth(depth);
2148                         par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
2149                         pars_.push_back(par);
2150
2151                         // FIXME: goddamn InsetTabular makes us pass a Buffer
2152                         // not BufferParams
2153                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
2154
2155                 } else if (token == "\\begin_deeper") {
2156                         ++depth;
2157                 } else if (token == "\\end_deeper") {
2158                         if (!depth) {
2159                                 lex.printError("\\end_deeper: " "depth is already null");
2160                         } else {
2161                                 --depth;
2162                         }
2163                 } else {
2164                         lyxerr << "Handling unknown body token: `"
2165                                << token << '\'' << endl;
2166                 }
2167         }
2168         return true;
2169 }
2170
2171
2172 int LyXText::ascent() const
2173 {
2174         return dim_.asc;
2175 }
2176
2177
2178 int LyXText::descent() const
2179 {
2180         return dim_.des;
2181 }
2182
2183
2184 int LyXText::cursorX(Buffer const & buffer, CursorSlice const & sl,
2185                 bool boundary) const
2186 {
2187         pit_type const pit = sl.pit();
2188         Paragraph const & par = pars_[pit];
2189         if (par.rows().empty())
2190                 return 0;
2191
2192         pos_type ppos = sl.pos();
2193         // Correct position in front of big insets
2194         bool const boundary_correction = ppos != 0 && boundary;
2195         if (boundary_correction)
2196                 --ppos;
2197
2198         Row const & row = par.getRow(sl.pos(), boundary);
2199
2200         pos_type cursor_vpos = 0;
2201
2202         RowMetrics const m = computeRowMetrics(buffer, pit, row);
2203         double x = m.x;
2204
2205         pos_type const row_pos  = row.pos();
2206         pos_type const end      = row.endpos();
2207
2208         if (end <= row_pos)
2209                 cursor_vpos = row_pos;
2210         else if (ppos >= end)
2211                 cursor_vpos = isRTL(buffer, par) ? row_pos : end;
2212         else if (ppos > row_pos && ppos >= end)
2213                 // Place cursor after char at (logical) position pos - 1
2214                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
2215                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
2216         else
2217                 // Place cursor before char at (logical) position ppos
2218                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
2219                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
2220
2221         pos_type body_pos = par.beginOfBody();
2222         if (body_pos > 0 &&
2223             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
2224                 body_pos = 0;
2225
2226         // Use font span to speed things up, see below
2227         FontSpan font_span;
2228         LyXFont font;
2229         FontMetrics const & labelfm = theFontMetrics(
2230                 getLabelFont(buffer, par));
2231
2232         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
2233                 pos_type pos = bidi.vis2log(vpos);
2234                 if (body_pos > 0 && pos == body_pos - 1) {
2235                         // FIXME UNICODE
2236                         docstring const lsep = from_utf8(par.layout()->labelsep);
2237                         x += m.label_hfill + labelfm.width(lsep);
2238                         if (par.isLineSeparator(body_pos - 1))
2239                                 x -= singleWidth(buffer, par, body_pos - 1);
2240                 }
2241
2242                 // Use font span to speed things up, see above
2243                 if (pos < font_span.first || pos > font_span.last) {
2244                         font_span = par.fontSpan(pos);
2245                         font = getFont(buffer, par, pos);
2246                 }
2247
2248                 x += singleWidth(par, pos, par.getChar(pos), font);
2249
2250                 if (par.hfillExpansion(row, pos))
2251                         x += (pos >= body_pos) ? m.hfill : m.label_hfill;
2252                 else if (par.isSeparator(pos) && pos >= body_pos)
2253                         x += m.separator;
2254         }
2255
2256         // see correction above
2257         if (boundary_correction)
2258                 if (getFont(buffer, par, ppos).isVisibleRightToLeft())
2259                         x -= singleWidth(buffer, par, ppos);
2260                 else
2261                         x += singleWidth(buffer, par, ppos);
2262
2263         // Make sure inside an inset we always count from the left
2264         // edge (bidi!) -- MV
2265         if (sl.pos() < par.size()) {
2266                 font = getFont(buffer, par, sl.pos());
2267                 if (!boundary && font.isVisibleRightToLeft()
2268                   && par.isInset(sl.pos()))
2269                         x -= par.getInset(sl.pos())->width();
2270         }
2271         return int(x);
2272 }
2273
2274
2275 int LyXText::cursorY(CursorSlice const & sl, bool boundary) const
2276 {
2277         //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
2278         Paragraph const & par = getPar(sl.pit());
2279         if (par.rows().empty())
2280                 return 0;
2281
2282         int h = 0;
2283         h -= pars_[0].rows()[0].ascent();
2284         for (pit_type pit = 0; pit < sl.pit(); ++pit)
2285                 h += pars_[pit].height();
2286         int pos = sl.pos();
2287         if (pos && boundary)
2288                 --pos;
2289         size_t const rend = par.pos2row(pos);
2290         for (size_t rit = 0; rit != rend; ++rit)
2291                 h += par.rows()[rit].height();
2292         h += par.rows()[rend].ascent();
2293         return h;
2294 }
2295
2296
2297 // Returns the current font and depth as a message.
2298 string LyXText::currentState(LCursor & cur)
2299 {
2300         BOOST_ASSERT(this == cur.text());
2301         Buffer & buf = cur.buffer();
2302         Paragraph const & par = cur.paragraph();
2303         std::ostringstream os;
2304
2305         if (buf.params().trackChanges)
2306                 os << "[C] ";
2307
2308         Change change = par.lookupChange(cur.pos());
2309
2310         if (change.type != Change::UNCHANGED) {
2311                 Author const & a = buf.params().authors().get(change.author);
2312                 os << to_utf8(_("Change: ")) << a.name();
2313                 if (!a.email().empty())
2314                         os << " (" << a.email() << ")";
2315                 os << to_utf8(_(" at ")) << ctime(&change.changetime);
2316                 os << " : ";
2317         }
2318
2319         // I think we should only show changes from the default
2320         // font. (Asger)
2321         // No, from the document font (MV)
2322         LyXFont font = real_current_font;
2323         font.reduce(buf.params().getFont());
2324
2325         // avoid to_utf8(_(...)) re-entrance problem
2326         string const s = font.stateText(&buf.params());
2327         os << to_utf8(bformat(_("Font: %1$s"), from_utf8(s)));
2328
2329         // os << to_utf8(bformat(_("Font: %1$s"), font.stateText(&buf.params)));
2330
2331         // The paragraph depth
2332         int depth = cur.paragraph().getDepth();
2333         if (depth > 0)
2334                 os << to_utf8(bformat(_(", Depth: %1$d"), depth));
2335
2336         // The paragraph spacing, but only if different from
2337         // buffer spacing.
2338         Spacing const & spacing = par.params().spacing();
2339         if (!spacing.isDefault()) {
2340                 os << to_utf8(_(", Spacing: "));
2341                 switch (spacing.getSpace()) {
2342                 case Spacing::Single:
2343                         os << to_utf8(_("Single"));
2344                         break;
2345                 case Spacing::Onehalf:
2346                         os << to_utf8(_("OneHalf"));
2347                         break;
2348                 case Spacing::Double:
2349                         os << to_utf8(_("Double"));
2350                         break;
2351                 case Spacing::Other:
2352                         os << to_utf8(_("Other (")) << spacing.getValueAsString() << ')';
2353                         break;
2354                 case Spacing::Default:
2355                         // should never happen, do nothing
2356                         break;
2357                 }
2358         }
2359
2360 #ifdef DEVEL_VERSION
2361         os << to_utf8(_(", Inset: ")) << &cur.inset();
2362         os << to_utf8(_(", Paragraph: ")) << cur.pit();
2363         os << to_utf8(_(", Id: ")) << par.id();
2364         os << to_utf8(_(", Position: ")) << cur.pos();
2365         os << to_utf8(_(", Boundary: ")) << cur.boundary();
2366 //      Row & row = cur.textRow();
2367 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2368 #endif
2369         return os.str();
2370 }
2371
2372
2373 docstring LyXText::getPossibleLabel(LCursor & cur) const
2374 {
2375         pit_type pit = cur.pit();
2376
2377         LyXLayout_ptr layout = pars_[pit].layout();
2378
2379         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
2380                 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
2381                 if (layout2->latextype != LATEX_PARAGRAPH) {
2382                         --pit;
2383                         layout = layout2;
2384                 }
2385         }
2386
2387         docstring name = from_ascii(layout->latexname());
2388
2389         // for captions, we want the abbreviation of the float type
2390         if (layout->labeltype == LABEL_SENSITIVE) {
2391                 // Search for the first float or wrap inset in the iterator
2392                 for (int i = cur.depth(); --i >= 0; ) {
2393                         InsetBase * const in = &cur[i].inset();
2394                         if (in->lyxCode() == InsetBase::FLOAT_CODE
2395                             || in->lyxCode() == InsetBase::WRAP_CODE) {
2396                                 name = in->getInsetName();
2397                                 break;
2398                         }
2399                 }
2400         }
2401
2402         docstring text = name.substr(0, 3);
2403         if (name == "theorem")
2404                 text = from_ascii("thm"); // Create a correct prefix for prettyref
2405
2406         text += ':';
2407         if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
2408                 text.erase();
2409
2410         docstring par_text = pars_[pit].asString(cur.buffer(), false);
2411         for (int i = 0; i < lyxrc.label_init_length; ++i) {
2412                 if (par_text.empty())
2413                         break;
2414                 docstring head;
2415                 par_text = split(par_text, head, ' ');
2416                 // Is it legal to use spaces in labels ?
2417                 if (i > 0)
2418                         text += '-';
2419                 text += head;
2420         }
2421
2422         return text;
2423 }
2424
2425
2426 //pos_type LyXText::x2pos(pit_type pit, int row, int x) const
2427 //{
2428 //      int lastx = 0;
2429 //      int currx = 0;
2430 //      Paragraph const & par = pars_[pit];
2431 //      Row const & r = par.rows()[row];
2432 //      int pos = r.pos();
2433 //      for (; currx < x && pos < r.endpos(); ++pos) {
2434 //              lastx = currx;
2435 //              currx += singleWidth(buffer, par, pos);
2436 //      }
2437 //      if (abs(lastx - x) < abs(currx - x) && pos != r.pos())
2438 //              --pos;
2439 //      return pos;
2440 //}
2441
2442
2443 pos_type LyXText::x2pos(BufferView const & bv, pit_type pit, int row,
2444                 int x) const
2445 {
2446         BOOST_ASSERT(row < int(pars_[pit].rows().size()));
2447         bool bound = false;
2448         Row const & r = pars_[pit].rows()[row];
2449         return r.pos() + getColumnNearX(bv, pit, r, x, bound);
2450 }
2451
2452
2453 //int LyXText::pos2x(pit_type pit, pos_type pos) const
2454 //{
2455 //      Paragraph const & par = pars_[pit];
2456 //      Row const & r = par.rows()[row];
2457 //      int x = 0;
2458 //      pos -= r.pos();
2459 //}
2460
2461
2462 // x,y are screen coordinates
2463 // sets cursor only within this LyXText
2464 bool LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
2465 {
2466         BOOST_ASSERT(this == cur.text());
2467         pit_type pit = getPitNearY(cur.bv(), y);
2468         int yy = cur.bv().coordCache().get(this, pit).y_ - pars_[pit].ascent();
2469         lyxerr[Debug::DEBUG]
2470                 << BOOST_CURRENT_FUNCTION
2471                 << ": x: " << x
2472                 << " y: " << y
2473                 << " pit: " << pit
2474                 << " yy: " << yy << endl;
2475
2476         Paragraph const & par = pars_[pit];
2477         int r = 0;
2478         BOOST_ASSERT(par.rows().size());
2479         for (; r < int(par.rows().size()) - 1; ++r) {
2480                 Row const & row = par.rows()[r];
2481                 if (int(yy + row.height()) > y)
2482                         break;
2483                 yy += row.height();
2484         }
2485
2486         Row const & row = par.rows()[r];
2487
2488         lyxerr[Debug::DEBUG]
2489                 << BOOST_CURRENT_FUNCTION
2490                 << ": row " << r
2491                 << " from pos: " << row.pos()
2492                 << endl;
2493
2494         bool bound = false;
2495         int xx = x;
2496         pos_type const pos = row.pos() + getColumnNearX(cur.bv(), pit, row,
2497                 xx, bound);
2498
2499         lyxerr[Debug::DEBUG]
2500                 << BOOST_CURRENT_FUNCTION
2501                 << ": setting cursor pit: " << pit
2502                 << " pos: " << pos
2503                 << endl;
2504
2505         return setCursor(cur, pit, pos, true, bound);
2506 }
2507
2508
2509 } // namespace lyx