]> git.lyx.org Git - lyx.git/blob - src/text.C
- Avoid lyxerr[] like the plague. Use if (lyxerr.debugging( ... )) instead.
[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, pit_type const pit,
699                 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_ - rightMargin(buffer, par); // - 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         // This check is necessary. Otherwise the new empty paragraph will
1153         // be deleted automatically. And it is more friendly for the user!
1154         if (cur.pos() != 0 || isempty)
1155                 setCursor(cur, cur.pit() + 1, 0);
1156         else
1157                 setCursor(cur, cur.pit(), 0);
1158 }
1159
1160
1161 // insert a character, moves all the following breaks in the
1162 // same Paragraph one to the right and make a rebreak
1163 void LyXText::insertChar(LCursor & cur, char_type c)
1164 {
1165         BOOST_ASSERT(this == cur.text());
1166         BOOST_ASSERT(c != Paragraph::META_INSET);
1167
1168         recordUndo(cur, Undo::INSERT);
1169
1170         Buffer const & buffer = cur.buffer();
1171         Paragraph & par = cur.paragraph();
1172         // try to remove this
1173         pit_type const pit = cur.pit();
1174
1175         bool const freeSpacing = par.layout()->free_spacing ||
1176                 par.isFreeSpacing();
1177
1178         if (lyxrc.auto_number) {
1179                 static docstring const number_operators = from_ascii("+-/*");
1180                 static docstring const number_unary_operators = from_ascii("+-");
1181                 static docstring const number_seperators = from_ascii(".,:");
1182
1183                 if (current_font.number() == LyXFont::ON) {
1184                         if (!isDigit(c) && !contains(number_operators, c) &&
1185                             !(contains(number_seperators, c) &&
1186                               cur.pos() != 0 &&
1187                               cur.pos() != cur.lastpos() &&
1188                               getFont(buffer, par, cur.pos()).number() == LyXFont::ON &&
1189                               getFont(buffer, par, cur.pos() - 1).number() == LyXFont::ON)
1190                            )
1191                                 number(cur); // Set current_font.number to OFF
1192                 } else if (isDigit(c) &&
1193                            real_current_font.isVisibleRightToLeft()) {
1194                         number(cur); // Set current_font.number to ON
1195
1196                         if (cur.pos() != 0) {
1197                                 char_type const c = par.getChar(cur.pos() - 1);
1198                                 if (contains(number_unary_operators, c) &&
1199                                     (cur.pos() == 1
1200                                      || par.isSeparator(cur.pos() - 2)
1201                                      || par.isNewline(cur.pos() - 2))
1202                                   ) {
1203                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1204                                 } else if (contains(number_seperators, c)
1205                                      && cur.pos() >= 2
1206                                      && getFont(buffer, par, cur.pos() - 2).number() == LyXFont::ON) {
1207                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1208                                 }
1209                         }
1210                 }
1211         }
1212
1213         // First check, if there will be two blanks together or a blank at
1214         // the beginning of a paragraph.
1215         // I decided to handle blanks like normal characters, the main
1216         // difference are the special checks when calculating the row.fill
1217         // (blank does not count at the end of a row) and the check here
1218
1219         // When the free-spacing option is set for the current layout,
1220         // disable the double-space checking
1221         if (!freeSpacing && isLineSeparatorChar(c)) {
1222                 if (cur.pos() == 0) {
1223                         static bool sent_space_message = false;
1224                         if (!sent_space_message) {
1225                                 cur.message(_("You cannot insert a space at the "
1226                                                            "beginning of a paragraph. Please read the Tutorial."));
1227                                 sent_space_message = true;
1228                         }
1229                         return;
1230                 }
1231                 BOOST_ASSERT(cur.pos() > 0);
1232                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1233                     && !par.isDeleted(cur.pos() - 1)) {
1234                         static bool sent_space_message = false;
1235                         if (!sent_space_message) {
1236                                 cur.message(_("You cannot type two spaces this way. "
1237                                                            "Please read the Tutorial."));
1238                                 sent_space_message = true;
1239                         }
1240                         return;
1241                 }
1242         }
1243
1244         par.insertChar(cur.pos(), c, current_font, cur.buffer().params().trackChanges);
1245         setCursor(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1246         charInserted();
1247 }
1248
1249
1250 void LyXText::charInserted()
1251 {
1252         // Here we call finishUndo for every 20 characters inserted.
1253         // This is from my experience how emacs does it. (Lgb)
1254         static unsigned int counter;
1255         if (counter < 20) {
1256                 ++counter;
1257         } else {
1258                 finishUndo();
1259                 counter = 0;
1260         }
1261 }
1262
1263
1264 RowMetrics LyXText::computeRowMetrics(Buffer const & buffer,
1265                 pit_type const pit, Row const & row) const
1266 {
1267         RowMetrics result;
1268         Paragraph const & par = pars_[pit];
1269
1270         double w = dim_.wid - row.width();
1271
1272         bool const is_rtl = isRTL(buffer, par);
1273         if (is_rtl)
1274                 result.x = rightMargin(buffer, par);
1275         else
1276                 result.x = leftMargin(buffer, pit, row.pos());
1277
1278         // is there a manual margin with a manual label
1279         LyXLayout_ptr const & layout = par.layout();
1280
1281         if (layout->margintype == MARGIN_MANUAL
1282             && layout->labeltype == LABEL_MANUAL) {
1283                 /// We might have real hfills in the label part
1284                 int nlh = numberOfLabelHfills(par, row);
1285
1286                 // A manual label par (e.g. List) has an auto-hfill
1287                 // between the label text and the body of the
1288                 // paragraph too.
1289                 // But we don't want to do this auto hfill if the par
1290                 // is empty.
1291                 if (!par.empty())
1292                         ++nlh;
1293
1294                 if (nlh && !par.getLabelWidthString().empty())
1295                         result.label_hfill = labelFill(buffer, par, row) / double(nlh);
1296         }
1297
1298         // are there any hfills in the row?
1299         int const nh = numberOfHfills(par, row);
1300
1301         if (nh) {
1302                 if (w > 0)
1303                         result.hfill = w / nh;
1304         // we don't have to look at the alignment if it is ALIGN_LEFT and
1305         // if the row is already larger then the permitted width as then
1306         // we force the LEFT_ALIGN'edness!
1307         } else if (int(row.width()) < maxwidth_) {
1308                 // is it block, flushleft or flushright?
1309                 // set x how you need it
1310                 int align;
1311                 if (par.params().align() == LYX_ALIGN_LAYOUT)
1312                         align = layout->align;
1313                 else
1314                         align = par.params().align();
1315
1316                 // Display-style insets should always be on a centred row
1317                 // The test on par.size() is to catch zero-size pars, which
1318                 // would trigger the assert in Paragraph::getInset().
1319                 //inset = par.size() ? par.getInset(row.pos()) : 0;
1320                 if (!par.empty()
1321                     && par.isInset(row.pos())
1322                     && par.getInset(row.pos())->display())
1323                 {
1324                         align = LYX_ALIGN_CENTER;
1325                 }
1326
1327                 switch (align) {
1328                 case LYX_ALIGN_BLOCK: {
1329                         int const ns = numberOfSeparators(par, row);
1330                         bool disp_inset = false;
1331                         if (row.endpos() < par.size()) {
1332                                 InsetBase const * in = par.getInset(row.endpos());
1333                                 if (in)
1334                                         disp_inset = in->display();
1335                         }
1336                         // If we have separators, this is not the last row of a
1337                         // par, does not end in newline, and is not row above a
1338                         // display inset... then stretch it
1339                         if (ns
1340                             && row.endpos() < par.size()
1341                             && !par.isNewline(row.endpos() - 1)
1342                             && !disp_inset
1343                                 ) {
1344                                 result.separator = w / ns;
1345                         } else if (is_rtl) {
1346                                 result.x += w;
1347                         }
1348                         break;
1349                 }
1350                 case LYX_ALIGN_RIGHT:
1351                         result.x += w;
1352                         break;
1353                 case LYX_ALIGN_CENTER:
1354                         result.x += w / 2;
1355                         break;
1356                 }
1357         }
1358
1359         bidi.computeTables(par, buffer, row);
1360         if (is_rtl) {
1361                 pos_type body_pos = par.beginOfBody();
1362                 pos_type end = row.endpos();
1363
1364                 if (body_pos > 0
1365                     && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1366                 {
1367                         docstring const lsep = from_utf8(layout->labelsep);
1368                         result.x += theFontMetrics(getLabelFont(buffer, par)).width(lsep);
1369                         if (body_pos <= end)
1370                                 result.x += result.label_hfill;
1371                 }
1372         }
1373
1374         return result;
1375 }
1376
1377
1378 // the cursor set functions have a special mechanism. When they
1379 // realize, that you left an empty paragraph, they will delete it.
1380
1381 bool LyXText::cursorRightOneWord(LCursor & cur)
1382 {
1383         BOOST_ASSERT(this == cur.text());
1384
1385         LCursor old = cur;
1386
1387         if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
1388                 ++old.pit();
1389                 old.pos() = 0;
1390         } else {
1391                 // Advance through word.
1392                 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
1393                         ++old.pos();
1394                 // Skip through trailing nonword stuff.
1395                 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
1396                         ++old.pos();
1397         }
1398         return setCursor(cur, old.pit(), old.pos());
1399 }
1400
1401
1402 bool LyXText::cursorLeftOneWord(LCursor & cur)
1403 {
1404         BOOST_ASSERT(this == cur.text());
1405
1406         LCursor old = cur;
1407
1408         if (old.pos() == 0 && old.pit() != 0) {
1409                 --old.pit();
1410                 old.pos() = old.lastpos();
1411         } else {
1412                 // Skip through initial nonword stuff.
1413                 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
1414                         --old.pos();
1415                 // Advance through word.
1416                 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
1417                         --old.pos();
1418         }
1419         return setCursor(cur, old.pit(), old.pos());
1420 }
1421
1422
1423 void LyXText::selectWord(LCursor & cur, word_location loc)
1424 {
1425         BOOST_ASSERT(this == cur.text());
1426         CursorSlice from = cur.top();
1427         CursorSlice to = cur.top();
1428         getWord(from, to, loc);
1429         if (cur.top() != from)
1430                 setCursor(cur, from.pit(), from.pos());
1431         if (to == from)
1432                 return;
1433         cur.resetAnchor();
1434         setCursor(cur, to.pit(), to.pos());
1435         cur.setSelection();
1436 }
1437
1438
1439 // Select the word currently under the cursor when no
1440 // selection is currently set
1441 bool LyXText::selectWordWhenUnderCursor(LCursor & cur, word_location loc)
1442 {
1443         BOOST_ASSERT(this == cur.text());
1444         if (cur.selection())
1445                 return false;
1446         selectWord(cur, loc);
1447         return cur.selection();
1448 }
1449
1450
1451 void LyXText::acceptChange(LCursor & cur)
1452 {
1453         BOOST_ASSERT(this == cur.text());
1454         if (!cur.selection() && cur.lastpos() != 0)
1455                 return;
1456
1457         recordUndoSelection(cur, Undo::INSERT);
1458
1459         DocIterator it = cur.selectionBegin();
1460         DocIterator et = cur.selectionEnd();
1461         pit_type pit = it.pit();
1462         bool isDeleted = pars_[pit].isDeleted(it.pos());
1463         for (; pit <= et.pit(); ++pit) {
1464                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1465                 pos_type right =
1466                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1467                 pars_[pit].acceptChanges(left, right);
1468         }
1469         if (isDeleted) {
1470                 ParagraphList & plist = paragraphs();
1471                 if (it.pit() + 1 < et.pit())
1472                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1473                                     boost::next(plist.begin(), et.pit()));
1474
1475                 // Paragraph merge if appropriate:
1476                 // FIXME: change tracking (MG)
1477                 if (pars_[it.pit()].isDeleted(pars_[it.pit()].size())) {
1478                         setCursorIntern(cur, it.pit() + 1, 0);
1479                         backspacePos0(cur);
1480                 }
1481         }
1482         finishUndo();
1483         cur.clearSelection();
1484         setCursorIntern(cur, it.pit(), 0);
1485 }
1486
1487
1488 void LyXText::rejectChange(LCursor & cur)
1489 {
1490         BOOST_ASSERT(this == cur.text());
1491         if (!cur.selection() && cur.lastpos() != 0)
1492                 return;
1493
1494         recordUndoSelection(cur, Undo::INSERT);
1495
1496         DocIterator it = cur.selectionBegin();
1497         DocIterator et = cur.selectionEnd();
1498         pit_type pit = it.pit();
1499         bool isInserted = pars_[pit].isInserted(it.pos());
1500         for (; pit <= et.pit(); ++pit) {
1501                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1502                 pos_type right =
1503                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1504                 pars_[pit].rejectChanges(left, right);
1505         }
1506         if (isInserted) {
1507                 ParagraphList & plist = paragraphs();
1508                 if (it.pit() + 1 < et.pit())
1509                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1510                                     boost::next(plist.begin(), et.pit()));
1511                 // Paragraph merge if appropriate:
1512                 // FIXME: change tracking (MG)
1513                 if (pars_[it.pit()].isInserted(pars_[it.pit()].size())) {
1514                         setCursorIntern(cur, it.pit() + 1, 0);
1515                         backspacePos0(cur);
1516                 }
1517         }
1518         finishUndo();
1519         cur.clearSelection();
1520         setCursorIntern(cur, it.pit(), 0);
1521 }
1522
1523
1524 // Delete from cursor up to the end of the current or next word.
1525 void LyXText::deleteWordForward(LCursor & cur)
1526 {
1527         BOOST_ASSERT(this == cur.text());
1528         if (cur.lastpos() == 0)
1529                 cursorRight(cur);
1530         else {
1531                 cur.resetAnchor();
1532                 cur.selection() = true;
1533                 cursorRightOneWord(cur);
1534                 cur.setSelection();
1535                 cutSelection(cur, true, false);
1536         }
1537 }
1538
1539
1540 // Delete from cursor to start of current or prior word.
1541 void LyXText::deleteWordBackward(LCursor & cur)
1542 {
1543         BOOST_ASSERT(this == cur.text());
1544         if (cur.lastpos() == 0)
1545                 cursorLeft(cur);
1546         else {
1547                 cur.resetAnchor();
1548                 cur.selection() = true;
1549                 cursorLeftOneWord(cur);
1550                 cur.setSelection();
1551                 cutSelection(cur, true, false);
1552         }
1553 }
1554
1555
1556 // Kill to end of line.
1557 void LyXText::deleteLineForward(LCursor & cur)
1558 {
1559         BOOST_ASSERT(this == cur.text());
1560         if (cur.lastpos() == 0) {
1561                 // Paragraph is empty, so we just go to the right
1562                 cursorRight(cur);
1563         } else {
1564                 cur.resetAnchor();
1565                 cur.selection() = true; // to avoid deletion
1566                 cursorEnd(cur);
1567                 cur.setSelection();
1568                 // What is this test for ??? (JMarc)
1569                 if (!cur.selection())
1570                         deleteWordForward(cur);
1571                 else
1572                         cutSelection(cur, true, false);
1573         }
1574 }
1575
1576
1577 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
1578 {
1579         BOOST_ASSERT(this == cur.text());
1580         CursorSlice from;
1581         CursorSlice to;
1582
1583         if (cur.selection()) {
1584                 from = cur.selBegin();
1585                 to = cur.selEnd();
1586         } else {
1587                 from = cur.top();
1588                 getWord(from, to, PARTIAL_WORD);
1589                 cursorRightOneWord(cur);
1590         }
1591
1592         recordUndoSelection(cur);
1593
1594         pos_type pos = from.pos();
1595         int par = from.pit();
1596
1597         while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1598                 pit_type pit = par;
1599                 if (pos == pars_[pit].size()) {
1600                         ++par;
1601                         pos = 0;
1602                         continue;
1603                 }
1604                 char_type c = pars_[pit].getChar(pos);
1605                 if (c != Paragraph::META_INSET) {
1606                         switch (action) {
1607                         case text_lowercase:
1608                                 c = lowercase(c);
1609                                 break;
1610                         case text_capitalization:
1611                                 c = uppercase(c);
1612                                 action = text_lowercase;
1613                                 break;
1614                         case text_uppercase:
1615                                 c = uppercase(c);
1616                                 break;
1617                         }
1618                 }
1619
1620                 // FIXME: change tracking (MG)
1621                 // sorry but we are no longer allowed to set a single character directly
1622                 // we have to rewrite this method in terms of erase&insert operations
1623                 //pars_[pit].setChar(pos, c);
1624                 ++pos;
1625         }
1626 }
1627
1628
1629 bool LyXText::erase(LCursor & cur)
1630 {
1631         BOOST_ASSERT(this == cur.text());
1632         bool needsUpdate = false;
1633
1634         if (cur.pos() != cur.lastpos()) {
1635                 recordUndo(cur, Undo::DELETE, cur.pit());
1636                 setCursorIntern(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1637                 needsUpdate = backspace(cur);
1638                 // FIXME: change tracking (MG)
1639                 if (cur.paragraph().isDeleted(cur.pos()))
1640                         cur.posRight();
1641         } else if (cur.pit() != cur.lastpit()) {
1642                 LCursor scur = cur;
1643
1644                 setCursorIntern(cur, cur.pit() + 1, 0, false, false);
1645                 if (pars_[cur.pit()].layout() == pars_[scur.pit()].layout()) {
1646                         recordUndo(scur, Undo::DELETE, scur.pit());
1647                         needsUpdate = backspace(cur);
1648                         if (cur.buffer().params().trackChanges) {
1649                                 // FIXME: Change tracking (MG)
1650                                 // move forward after the paragraph break is DELETED
1651                                 Paragraph & par = cur.paragraph();
1652                                 // FIXME: change tracking (MG)
1653                                 if (par.isDeleted(par.size()))
1654                                         setCursorIntern(cur, cur.pit() + 1, 0);
1655                                 }
1656                 } else {
1657                         setCursorIntern(scur, scur.pit(), scur.pos(), false, scur.boundary());
1658                 }
1659         } else
1660                 needsUpdate = dissolveInset(cur);
1661
1662         return needsUpdate;
1663 }
1664
1665
1666 bool LyXText::backspacePos0(LCursor & cur)
1667 {
1668         BOOST_ASSERT(this == cur.text());
1669         bool needsUpdate = false;
1670
1671         Paragraph & par = cur.paragraph();
1672         // is it an empty paragraph?
1673         pos_type lastpos = cur.lastpos();
1674         if (lastpos == 0 || (lastpos == 1 && par.isSeparator(0))) {
1675                 // This is an empty paragraph and we delete it just
1676                 // by moving the cursor one step
1677                 // left and let the DeleteEmptyParagraphMechanism
1678                 // handle the actual deletion of the paragraph.
1679
1680                 if (cur.pit() != 0) {
1681                         // For KeepEmpty layouts we need to get
1682                         // rid of the keepEmpty setting first.
1683                         // And the only way to do this is to
1684                         // reset the layout to something
1685                         // else: f.ex. the default layout.
1686                         if (par.allowEmpty()) {
1687                                 Buffer & buf = cur.buffer();
1688                                 BufferParams const & bparams = buf.params();
1689                                 par.layout(bparams.getLyXTextClass().defaultLayout());
1690                         }
1691
1692                         cursorLeft(cur);
1693                         return true;
1694                 }
1695         }
1696
1697         if (cur.pit() != 0)
1698                 recordUndo(cur, Undo::DELETE, cur.pit() - 1);
1699
1700         pit_type tmppit = cur.pit();
1701         // We used to do cursorLeftIntern() here, but it is
1702         // not a good idea since it triggers the auto-delete
1703         // mechanism. So we do a cursorLeftIntern()-lite,
1704         // without the dreaded mechanism. (JMarc)
1705         if (cur.pit() != 0) {
1706                 // steps into the above paragraph.
1707                 setCursorIntern(cur, cur.pit() - 1,
1708                                 pars_[cur.pit() - 1].size(),
1709                                 false);
1710         }
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         // Correction (Jug 20050717): Remove check about alignment!
1717         Buffer & buf = cur.buffer();
1718         BufferParams const & bufparams = buf.params();
1719         LyXTextClass const & tclass = bufparams.getLyXTextClass();
1720         pit_type const cpit = cur.pit();
1721
1722         if (cpit != tmppit
1723             && (pars_[cpit].layout() == pars_[tmppit].layout()
1724                 || pars_[tmppit].layout() == tclass.defaultLayout()))
1725         {
1726                 mergeParagraph(bufparams, pars_, cpit);
1727                 needsUpdate = true;
1728
1729                 if (cur.pos() != 0 && pars_[cpit].isSeparator(cur.pos() - 1))
1730                                 --cur.pos();
1731
1732                 // the counters may have changed
1733                 ParIterator par_it(cur);
1734                 updateLabels(cur.buffer(), par_it);
1735
1736                 setCursor(cur, cur.pit(), cur.pos(), false);
1737         }
1738         return needsUpdate;
1739 }
1740
1741
1742 bool LyXText::backspace(LCursor & cur)
1743 {
1744         BOOST_ASSERT(this == cur.text());
1745         bool needsUpdate = false;
1746         if (cur.pos() == 0) {
1747                 if (cur.pit() == 0)
1748                         return dissolveInset(cur);
1749
1750                 // The cursor is at the beginning of a paragraph, so
1751                 // the the backspace will collapse two paragraphs into
1752                 // one.
1753
1754                 if (cur.pit() != 0 && cur.buffer().params().trackChanges) {
1755                         // FIXME: Change tracking (MG)
1756                         // Previous paragraph, mark "carriage return" as
1757                         // deleted:
1758                         Paragraph & par = pars_[cur.pit() - 1];
1759                         // Take care of a just inserted para break:
1760                         // FIXME: change tracking (MG)
1761                         if (!par.isInserted(par.size())) {
1762                                 // FIXME: change tracking (MG)
1763                                 par.setChange(par.size(), Change(Change::DELETED));
1764                                 setCursorIntern(cur, cur.pit() - 1, par.size());
1765                                 return true;
1766                         }
1767                 }
1768
1769                 needsUpdate = backspacePos0(cur);
1770
1771         } else {
1772                 // this is the code for a normal backspace, not pasting
1773                 // any paragraphs
1774                 recordUndo(cur, Undo::DELETE);
1775                 // We used to do cursorLeftIntern() here, but it is
1776                 // not a good idea since it triggers the auto-delete
1777                 // mechanism. So we do a cursorLeftIntern()-lite,
1778                 // without the dreaded mechanism. (JMarc)
1779                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1780                                 false, cur.boundary());
1781                 // FIXME: change tracking (MG)
1782                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1783         }
1784
1785         if (cur.pos() == cur.lastpos())
1786                 setCurrentFont(cur);
1787
1788         setCursor(cur, cur.pit(), cur.pos(), false, cur.boundary());
1789
1790         return needsUpdate;
1791 }
1792
1793
1794 bool LyXText::dissolveInset(LCursor & cur) {
1795         BOOST_ASSERT(this == cur.text());
1796
1797         if (isMainText(*cur.bv().buffer()) || cur.inset().nargs() != 1)
1798                 return false;
1799
1800         recordUndoInset(cur);
1801         cur.selHandle(false);
1802         // save position
1803         pos_type spos = cur.pos();
1804         pit_type spit = cur.pit();
1805         ParagraphList plist;
1806         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1807                 plist = paragraphs();
1808         cur.popLeft();
1809         // store cursor offset
1810         if (spit == 0)
1811                 spos += cur.pos();
1812         spit += cur.pit();
1813         Buffer & b = cur.buffer();
1814         // FIXME: change tracking (MG)
1815         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1816         if (!plist.empty()) {
1817                 pasteParagraphList(cur, plist, b.params().textclass,
1818                                    b.errorList("Paste"));
1819                 // restore position
1820                 cur.pit() = std::min(cur.lastpit(), spit);
1821                 cur.pos() = std::min(cur.lastpos(), spos);
1822         }
1823         cur.clearSelection();
1824         cur.resetAnchor();
1825         return true;
1826 }
1827
1828
1829 Row const & LyXText::firstRow() const
1830 {
1831         return *paragraphs().front().rows().begin();
1832 }
1833
1834
1835 bool LyXText::redoParagraph(BufferView & bv, pit_type const pit)
1836 {
1837         // remove rows of paragraph, keep track of height changes
1838         Paragraph & par = pars_[pit];
1839         Buffer const & buffer = *bv.buffer();
1840
1841         // Add bibitem insets if necessary
1842         if (par.layout()->labeltype == LABEL_BIBLIO) {
1843                 bool hasbibitem(false);
1844                 if (!par.insetlist.empty()
1845                         // Insist on it being in pos 0
1846                         && par.getChar(0) == Paragraph::META_INSET) {
1847                         InsetBase * inset = par.insetlist.begin()->inset;
1848                         if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
1849                                 hasbibitem = true;
1850                 }
1851                 if (!hasbibitem) {
1852                         InsetBibitem * inset(new
1853                                 InsetBibitem(InsetCommandParams("bibitem")));
1854                         par.insertInset(0, static_cast<InsetBase *>(inset),
1855                                         Change(buffer.params().trackChanges ?
1856                                                Change::INSERTED : Change::UNCHANGED));
1857                         bv.cursor().posRight();
1858                 }
1859         }
1860
1861         // redo insets
1862         // FIXME: We should always use getFont(), see documentation of
1863         // noFontChange() in insetbase.h.
1864         LyXFont const bufferfont = buffer.params().getFont();
1865         InsetList::iterator ii = par.insetlist.begin();
1866         InsetList::iterator iend = par.insetlist.end();
1867         for (; ii != iend; ++ii) {
1868                 Dimension dim;
1869                 int const w = maxwidth_ - leftMargin(buffer, pit, ii->pos)
1870                         - rightMargin(buffer, par);
1871                 LyXFont const & font = ii->inset->noFontChange() ?
1872                         bufferfont :
1873                         getFont(buffer, par, ii->pos);
1874                 MetricsInfo mi(&bv, font, w);
1875                 ii->inset->metrics(mi, dim);
1876         }
1877
1878         // rebreak the paragraph
1879         par.rows().clear();
1880         Dimension dim;
1881
1882         par.setBeginOfBody();
1883         pos_type z = 0;
1884         do {
1885                 Row row(z);
1886                 rowBreakPoint(buffer, pit, row);
1887                 setRowWidth(buffer, pit, row);
1888                 setHeightOfRow(bv, pit, row);
1889                 par.rows().push_back(row);
1890                 dim.wid = std::max(dim.wid, row.width());
1891                 dim.des += row.height();
1892                 z = row.endpos();
1893         } while (z < par.size());
1894
1895         // Make sure that if a par ends in newline, there is one more row
1896         // under it
1897         // FIXME this is a dirty trick. Now the _same_ position in the
1898         // paragraph occurs in _two_ different rows, and has two different
1899         // display positions, leading to weird behaviour when moving up/down.
1900         if (z > 0 && par.isNewline(z - 1)) {
1901                 Row row(z - 1);
1902                 row.endpos(z - 1);
1903                 setRowWidth(buffer, pit, row);
1904                 setHeightOfRow(bv, pit, row);
1905                 par.rows().push_back(row);
1906                 dim.des += row.height();
1907         }
1908
1909         dim.asc += par.rows()[0].ascent();
1910         dim.des -= par.rows()[0].ascent();
1911
1912         bool const same = dim == par.dim();
1913
1914         par.dim() = dim;
1915         //lyxerr << "redoParagraph: " << par.rows().size() << " rows\n";
1916
1917         return !same;
1918 }
1919
1920
1921 void LyXText::metrics(MetricsInfo & mi, Dimension & dim)
1922 {
1923         //BOOST_ASSERT(mi.base.textwidth);
1924         if (mi.base.textwidth)
1925                 maxwidth_ = mi.base.textwidth;
1926         //lyxerr << "LyXText::metrics: width: " << mi.base.textwidth
1927         //      << " maxWidth: " << maxwidth_ << "\nfont: " << mi.base.font << endl;
1928         // save the caller's font locally:
1929         font_ = mi.base.font;
1930
1931         unsigned int h = 0;
1932         unsigned int w = 0;
1933         for (pit_type pit = 0, n = paragraphs().size(); pit != n; ++pit) {
1934                 redoParagraph(*mi.base.bv, pit);
1935                 Paragraph & par = paragraphs()[pit];
1936                 h += par.height();
1937                 if (w < par.width())
1938                         w = par.width();
1939         }
1940
1941         dim.wid = w;
1942         dim.asc = pars_[0].ascent();
1943         dim.des = h - dim.asc;
1944
1945         dim_ = dim;
1946 }
1947
1948
1949 // only used for inset right now. should also be used for main text
1950 void LyXText::draw(PainterInfo & pi, int x, int y) const
1951 {
1952         paintTextInset(*this, pi, x, y);
1953 }
1954
1955
1956 // only used for inset right now. should also be used for main text
1957 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1958 {
1959         LCursor & cur = pi.base.bv->cursor();
1960         if (!cur.selection())
1961                 return;
1962         if (!ptr_cmp(cur.text(), this))
1963                 return;
1964
1965         if (lyxerr.debugging(Debug::DEBUG)) {
1966                 lyxerr[Debug::DEBUG]
1967                         << BOOST_CURRENT_FUNCTION
1968                         << "draw selection at " << x
1969                         << endl;
1970         }
1971
1972         DocIterator beg = cur.selectionBegin();
1973         DocIterator end = cur.selectionEnd();
1974
1975         BufferView & bv = *pi.base.bv;
1976         Buffer const & buffer = *bv.buffer();
1977
1978         // the selection doesn't touch the visible screen
1979         if (bv_funcs::status(&bv, beg) == bv_funcs::CUR_BELOW
1980             || bv_funcs::status(&bv, end) == bv_funcs::CUR_ABOVE)
1981                 return;
1982
1983         Paragraph const & par1 = pars_[beg.pit()];
1984         Paragraph const & par2 = pars_[end.pit()];
1985
1986         bool const above = (bv_funcs::status(&bv, beg)
1987                             == bv_funcs::CUR_ABOVE);
1988         bool const below = (bv_funcs::status(&bv, end)
1989                             == bv_funcs::CUR_BELOW);
1990         int y1,y2,x1,x2;
1991         if (above) {
1992                 y1 = 0;
1993                 y2 = 0;
1994                 x1 = 0;
1995                 x2 = dim_.wid;
1996         } else {
1997                 Row const & row1 = par1.getRow(beg.pos(), beg.boundary());
1998                 y1 = bv_funcs::getPos(bv, beg, beg.boundary()).y_ - row1.ascent();
1999                 y2 = y1 + row1.height();
2000                 int const startx = cursorX(buffer, beg.top(), beg.boundary());
2001                 if (!isRTL(buffer, par1)) {
2002                         x1 = startx;
2003                         x2 = 0 + dim_.wid;
2004                 }
2005                 else {
2006                         x1 = 0;
2007                         x2 = startx;
2008                 }
2009         }
2010
2011         int Y1,Y2,X1,X2;
2012         if (below) {
2013                 Y1 = bv.workHeight();
2014                 Y2 = bv.workHeight();
2015                 X1 = 0;
2016                 X2 = dim_.wid;
2017         } else {
2018                 Row const & row2 = par2.getRow(end.pos(), end.boundary());
2019                 Y1 = bv_funcs::getPos(bv, end, end.boundary()).y_ - row2.ascent();
2020                 Y2 = Y1 + row2.height();
2021                 int const endx = cursorX(buffer, end.top(), end.boundary());
2022                 if (!isRTL(buffer, par2)) {
2023                         X1 = 0;
2024                         X2 = endx;
2025                 }
2026                 else {
2027                         X1 = endx;
2028                         X2 = 0 + dim_.wid;
2029                 }
2030         }
2031
2032         if (!above && !below && &par1.getRow(beg.pos(), beg.boundary())
2033             == &par2.getRow(end.pos(), end.boundary()))
2034         {
2035                 // paint only one rectangle
2036                 int const b( !isRTL(*bv.buffer(), par1) ? x + x1 : x + X1 );
2037                 int const w( !isRTL(*bv.buffer(), par1) ? X2 - x1 : x2 - X1 );
2038                 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
2039                 return;
2040         }
2041
2042         if (lyxerr.debugging(Debug::DEBUG)) {
2043                 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
2044                            << "X1:" << X1 << " x2: " << X2 << " wid: " << dim_.wid
2045                         << endl;
2046         }
2047
2048         // paint upper rectangle
2049         pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
2050                                       LColor::selection);
2051         // paint bottom rectangle
2052         pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
2053                                       LColor::selection);
2054         // paint center rectangle
2055         pi.pain.fillRectangle(x, y2, dim_.wid,
2056                               Y1 - y2, LColor::selection);
2057 }
2058
2059 bool LyXText::isLastRow(pit_type pit, Row const & row) const
2060 {
2061         return row.endpos() >= pars_[pit].size()
2062                 && pit + 1 == pit_type(paragraphs().size());
2063 }
2064
2065
2066 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
2067 {
2068         return row.pos() == 0 && pit == 0;
2069 }
2070
2071
2072 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
2073         word_location const loc)
2074 {
2075         Paragraph const & from_par = pars_[from.pit()];
2076         switch (loc) {
2077         case WHOLE_WORD_STRICT:
2078                 if (from.pos() == 0 || from.pos() == from_par.size()
2079                     || !from_par.isLetter(from.pos())
2080                     || !from_par.isLetter(from.pos() - 1)) {
2081                         to = from;
2082                         return;
2083                 }
2084                 // no break here, we go to the next
2085
2086         case WHOLE_WORD:
2087                 // If we are already at the beginning of a word, do nothing
2088                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
2089                         break;
2090                 // no break here, we go to the next
2091
2092         case PREVIOUS_WORD:
2093                 // always move the cursor to the beginning of previous word
2094                 while (from.pos() && from_par.isLetter(from.pos() - 1))
2095                         --from.pos();
2096                 break;
2097         case NEXT_WORD:
2098                 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
2099                        << endl;
2100                 break;
2101         case PARTIAL_WORD:
2102                 // no need to move the 'from' cursor
2103                 break;
2104         }
2105         to = from;
2106         Paragraph & to_par = pars_[to.pit()];
2107         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
2108                 ++to.pos();
2109 }
2110
2111
2112 void LyXText::write(Buffer const & buf, std::ostream & os) const
2113 {
2114         ParagraphList::const_iterator pit = paragraphs().begin();
2115         ParagraphList::const_iterator end = paragraphs().end();
2116         depth_type dth = 0;
2117         for (; pit != end; ++pit)
2118                 pit->write(buf, os, buf.params(), dth);
2119 }
2120
2121
2122 bool LyXText::read(Buffer const & buf, LyXLex & lex, ErrorList & errorList)
2123 {
2124         depth_type depth = 0;
2125
2126         while (lex.isOK()) {
2127                 lex.nextToken();
2128                 string const token = lex.getString();
2129
2130                 if (token.empty())
2131                         continue;
2132
2133                 if (token == "\\end_inset")
2134                         break;
2135
2136                 if (token == "\\end_body")
2137                         continue;
2138
2139                 if (token == "\\begin_body")
2140                         continue;
2141
2142                 if (token == "\\end_document")
2143                         return false;
2144
2145                 if (token == "\\begin_layout") {
2146                         lex.pushToken(token);
2147
2148                         Paragraph par;
2149                         par.params().depth(depth);
2150                         par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
2151                         pars_.push_back(par);
2152
2153                         // FIXME: goddamn InsetTabular makes us pass a Buffer
2154                         // not BufferParams
2155                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
2156
2157                 } else if (token == "\\begin_deeper") {
2158                         ++depth;
2159                 } else if (token == "\\end_deeper") {
2160                         if (!depth) {
2161                                 lex.printError("\\end_deeper: " "depth is already null");
2162                         } else {
2163                                 --depth;
2164                         }
2165                 } else {
2166                         lyxerr << "Handling unknown body token: `"
2167                                << token << '\'' << endl;
2168                 }
2169         }
2170         return true;
2171 }
2172
2173
2174 int LyXText::ascent() const
2175 {
2176         return dim_.asc;
2177 }
2178
2179
2180 int LyXText::descent() const
2181 {
2182         return dim_.des;
2183 }
2184
2185
2186 int LyXText::cursorX(Buffer const & buffer, CursorSlice const & sl,
2187                 bool boundary) const
2188 {
2189         pit_type const pit = sl.pit();
2190         Paragraph const & par = pars_[pit];
2191         if (par.rows().empty())
2192                 return 0;
2193
2194         pos_type ppos = sl.pos();
2195         // Correct position in front of big insets
2196         bool const boundary_correction = ppos != 0 && boundary;
2197         if (boundary_correction)
2198                 --ppos;
2199
2200         Row const & row = par.getRow(sl.pos(), boundary);
2201
2202         pos_type cursor_vpos = 0;
2203
2204         RowMetrics const m = computeRowMetrics(buffer, pit, row);
2205         double x = m.x;
2206
2207         pos_type const row_pos  = row.pos();
2208         pos_type const end      = row.endpos();
2209
2210         if (end <= row_pos)
2211                 cursor_vpos = row_pos;
2212         else if (ppos >= end)
2213                 cursor_vpos = isRTL(buffer, par) ? row_pos : end;
2214         else if (ppos > row_pos && ppos >= end)
2215                 // Place cursor after char at (logical) position pos - 1
2216                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
2217                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
2218         else
2219                 // Place cursor before char at (logical) position ppos
2220                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
2221                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
2222
2223         pos_type body_pos = par.beginOfBody();
2224         if (body_pos > 0 &&
2225             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
2226                 body_pos = 0;
2227
2228         // Use font span to speed things up, see below
2229         FontSpan font_span;
2230         LyXFont font;
2231         FontMetrics const & labelfm = theFontMetrics(
2232                 getLabelFont(buffer, par));
2233
2234         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
2235                 pos_type pos = bidi.vis2log(vpos);
2236                 if (body_pos > 0 && pos == body_pos - 1) {
2237                         // FIXME UNICODE
2238                         docstring const lsep = from_utf8(par.layout()->labelsep);
2239                         x += m.label_hfill + labelfm.width(lsep);
2240                         if (par.isLineSeparator(body_pos - 1))
2241                                 x -= singleWidth(buffer, par, body_pos - 1);
2242                 }
2243
2244                 // Use font span to speed things up, see above
2245                 if (pos < font_span.first || pos > font_span.last) {
2246                         font_span = par.fontSpan(pos);
2247                         font = getFont(buffer, par, pos);
2248                 }
2249
2250                 x += singleWidth(par, pos, par.getChar(pos), font);
2251
2252                 if (par.hfillExpansion(row, pos))
2253                         x += (pos >= body_pos) ? m.hfill : m.label_hfill;
2254                 else if (par.isSeparator(pos) && pos >= body_pos)
2255                         x += m.separator;
2256         }
2257
2258         // see correction above
2259         if (boundary_correction)
2260                 if (getFont(buffer, par, ppos).isVisibleRightToLeft())
2261                         x -= singleWidth(buffer, par, ppos);
2262                 else
2263                         x += singleWidth(buffer, par, ppos);
2264
2265         // Make sure inside an inset we always count from the left
2266         // edge (bidi!) -- MV
2267         if (sl.pos() < par.size()) {
2268                 font = getFont(buffer, par, sl.pos());
2269                 if (!boundary && font.isVisibleRightToLeft()
2270                   && par.isInset(sl.pos()))
2271                         x -= par.getInset(sl.pos())->width();
2272         }
2273         return int(x);
2274 }
2275
2276
2277 int LyXText::cursorY(CursorSlice const & sl, bool boundary) const
2278 {
2279         //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
2280         Paragraph const & par = getPar(sl.pit());
2281         if (par.rows().empty())
2282                 return 0;
2283
2284         int h = 0;
2285         h -= pars_[0].rows()[0].ascent();
2286         for (pit_type pit = 0; pit < sl.pit(); ++pit)
2287                 h += pars_[pit].height();
2288         int pos = sl.pos();
2289         if (pos && boundary)
2290                 --pos;
2291         size_t const rend = par.pos2row(pos);
2292         for (size_t rit = 0; rit != rend; ++rit)
2293                 h += par.rows()[rit].height();
2294         h += par.rows()[rend].ascent();
2295         return h;
2296 }
2297
2298
2299 // Returns the current font and depth as a message.
2300 string LyXText::currentState(LCursor & cur)
2301 {
2302         BOOST_ASSERT(this == cur.text());
2303         Buffer & buf = cur.buffer();
2304         Paragraph const & par = cur.paragraph();
2305         std::ostringstream os;
2306
2307         if (buf.params().trackChanges)
2308                 os << "[C] ";
2309
2310         Change change = par.lookupChange(cur.pos());
2311
2312         if (change.type != Change::UNCHANGED) {
2313                 Author const & a = buf.params().authors().get(change.author);
2314                 os << to_utf8(_("Change: ")) << a.name();
2315                 if (!a.email().empty())
2316                         os << " (" << a.email() << ")";
2317                 os << to_utf8(_(" at ")) << ctime(&change.changetime);
2318                 os << " : ";
2319         }
2320
2321         // I think we should only show changes from the default
2322         // font. (Asger)
2323         // No, from the document font (MV)
2324         LyXFont font = real_current_font;
2325         font.reduce(buf.params().getFont());
2326
2327         // avoid to_utf8(_(...)) re-entrance problem
2328         string const s = font.stateText(&buf.params());
2329         os << to_utf8(bformat(_("Font: %1$s"), from_utf8(s)));
2330
2331         // os << to_utf8(bformat(_("Font: %1$s"), font.stateText(&buf.params)));
2332
2333         // The paragraph depth
2334         int depth = cur.paragraph().getDepth();
2335         if (depth > 0)
2336                 os << to_utf8(bformat(_(", Depth: %1$d"), depth));
2337
2338         // The paragraph spacing, but only if different from
2339         // buffer spacing.
2340         Spacing const & spacing = par.params().spacing();
2341         if (!spacing.isDefault()) {
2342                 os << to_utf8(_(", Spacing: "));
2343                 switch (spacing.getSpace()) {
2344                 case Spacing::Single:
2345                         os << to_utf8(_("Single"));
2346                         break;
2347                 case Spacing::Onehalf:
2348                         os << to_utf8(_("OneHalf"));
2349                         break;
2350                 case Spacing::Double:
2351                         os << to_utf8(_("Double"));
2352                         break;
2353                 case Spacing::Other:
2354                         os << to_utf8(_("Other (")) << spacing.getValueAsString() << ')';
2355                         break;
2356                 case Spacing::Default:
2357                         // should never happen, do nothing
2358                         break;
2359                 }
2360         }
2361
2362 #ifdef DEVEL_VERSION
2363         os << to_utf8(_(", Inset: ")) << &cur.inset();
2364         os << to_utf8(_(", Paragraph: ")) << cur.pit();
2365         os << to_utf8(_(", Id: ")) << par.id();
2366         os << to_utf8(_(", Position: ")) << cur.pos();
2367         os << to_utf8(_(", Boundary: ")) << cur.boundary();
2368 //      Row & row = cur.textRow();
2369 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2370 #endif
2371         return os.str();
2372 }
2373
2374
2375 string LyXText::getPossibleLabel(LCursor & cur) const
2376 {
2377         pit_type pit = cur.pit();
2378
2379         LyXLayout_ptr layout = pars_[pit].layout();
2380
2381         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
2382                 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
2383                 if (layout2->latextype != LATEX_PARAGRAPH) {
2384                         --pit;
2385                         layout = layout2;
2386                 }
2387         }
2388
2389         string name = layout->latexname();
2390
2391         // for captions, we want the abbreviation of the float type
2392         if (layout->labeltype == LABEL_SENSITIVE) {
2393                 // Search for the first float or wrap inset in the iterator
2394                 for (int i = cur.depth(); --i >= 0; ) {
2395                         InsetBase * const in = &cur[i].inset();
2396                         if (in->lyxCode() == InsetBase::FLOAT_CODE
2397                             || in->lyxCode() == InsetBase::WRAP_CODE) {
2398                                 name = to_utf8(in->getInsetName());
2399                                 break;
2400                         }
2401                 }
2402         }
2403
2404         string text = name.substr(0, 3);
2405         if (name == "theorem")
2406                 text = "thm"; // Create a correct prefix for prettyref
2407
2408         text += ':';
2409         if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
2410                 text.erase();
2411
2412         // FIXME UNICODE
2413         string par_text = to_utf8(pars_[pit].asString(cur.buffer(), false));
2414         for (int i = 0; i < lyxrc.label_init_length; ++i) {
2415                 if (par_text.empty())
2416                         break;
2417                 string head;
2418                 par_text = split(par_text, head, ' ');
2419                 // Is it legal to use spaces in labels ?
2420                 if (i > 0)
2421                         text += '-';
2422                 text += head;
2423         }
2424
2425         return text;
2426 }
2427
2428
2429 //pos_type LyXText::x2pos(pit_type pit, int row, int x) const
2430 //{
2431 //      int lastx = 0;
2432 //      int currx = 0;
2433 //      Paragraph const & par = pars_[pit];
2434 //      Row const & r = par.rows()[row];
2435 //      int pos = r.pos();
2436 //      for (; currx < x && pos < r.endpos(); ++pos) {
2437 //              lastx = currx;
2438 //              currx += singleWidth(buffer, par, pos);
2439 //      }
2440 //      if (abs(lastx - x) < abs(currx - x) && pos != r.pos())
2441 //              --pos;
2442 //      return pos;
2443 //}
2444
2445
2446 pos_type LyXText::x2pos(BufferView const & bv, pit_type pit, int row,
2447                 int x) const
2448 {
2449         BOOST_ASSERT(row < int(pars_[pit].rows().size()));
2450         bool bound = false;
2451         Row const & r = pars_[pit].rows()[row];
2452         return r.pos() + getColumnNearX(bv, pit, r, x, bound);
2453 }
2454
2455
2456 //int LyXText::pos2x(pit_type pit, pos_type pos) const
2457 //{
2458 //      Paragraph const & par = pars_[pit];
2459 //      Row const & r = par.rows()[row];
2460 //      int x = 0;
2461 //      pos -= r.pos();
2462 //}
2463
2464
2465 // x,y are screen coordinates
2466 // sets cursor only within this LyXText
2467 bool LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
2468 {
2469         BOOST_ASSERT(this == cur.text());
2470         pit_type pit = getPitNearY(cur.bv(), y);
2471         int yy = cur.bv().coordCache().get(this, pit).y_ - pars_[pit].ascent();
2472         lyxerr[Debug::DEBUG]
2473                 << BOOST_CURRENT_FUNCTION
2474                 << ": x: " << x
2475                 << " y: " << y
2476                 << " pit: " << pit
2477                 << " yy: " << yy << endl;
2478
2479         Paragraph const & par = pars_[pit];
2480         int r = 0;
2481         BOOST_ASSERT(par.rows().size());
2482         for (; r < int(par.rows().size()) - 1; ++r) {
2483                 Row const & row = par.rows()[r];
2484                 if (int(yy + row.height()) > y)
2485                         break;
2486                 yy += row.height();
2487         }
2488
2489         Row const & row = par.rows()[r];
2490
2491         lyxerr[Debug::DEBUG]
2492                 << BOOST_CURRENT_FUNCTION
2493                 << ": row " << r
2494                 << " from pos: " << row.pos()
2495                 << endl;
2496
2497         bool bound = false;
2498         int xx = x;
2499         pos_type const pos = row.pos() + getColumnNearX(cur.bv(), pit, row,
2500                 xx, bound);
2501
2502         lyxerr[Debug::DEBUG]
2503                 << BOOST_CURRENT_FUNCTION
2504                 << ": setting cursor pit: " << pit
2505                 << " pos: " << pos
2506                 << endl;
2507
2508         return setCursor(cur, pit, pos, true, bound);
2509 }
2510
2511
2512 } // namespace lyx