3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
14 * Full author contact details are available in file CREDITS.
23 #include "buffer_funcs.h"
24 #include "bufferparams.h"
25 #include "BufferView.h"
27 #include "coordcache.h"
28 #include "CutAndPaste.h"
30 #include "dispatchresult.h"
32 #include "errorlist.h"
33 #include "funcrequest.h"
35 #include "FontIterator.h"
39 #include "lyxlength.h"
43 #include "lyxrow_funcs.h"
44 #include "metricsinfo.h"
45 #include "paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "rowpainter.h"
51 #include "WordLangTuple.h"
53 #include "frontends/font_metrics.h"
54 #include "frontends/LyXView.h"
55 #include "frontends/Painter.h"
57 #include "insets/insettext.h"
58 #include "insets/insetbibitem.h"
59 #include "insets/insethfill.h"
60 #include "insets/insetlatexaccent.h"
61 #include "insets/insetline.h"
62 #include "insets/insetnewline.h"
63 #include "insets/insetpagebreak.h"
64 #include "insets/insetoptarg.h"
65 #include "insets/insetspace.h"
66 #include "insets/insetspecialchar.h"
67 #include "insets/insettabular.h"
69 #include "support/lstrings.h"
70 #include "support/textutils.h"
71 #include "support/convert.h"
73 #include <boost/current_function.hpp>
79 using lyx::word_location;
81 using lyx::support::bformat;
82 using lyx::support::contains;
83 using lyx::support::lowercase;
84 using lyx::support::split;
85 using lyx::support::uppercase;
87 using lyx::cap::cutSelection;
100 int numberOfSeparators(Paragraph const & par, Row const & row)
102 pos_type const first = max(row.pos(), par.beginOfBody());
103 pos_type const last = row.endpos() - 1;
105 for (pos_type p = first; p < last; ++p) {
106 if (par.isSeparator(p))
113 int numberOfLabelHfills(Paragraph const & par, Row const & row)
115 pos_type last = row.endpos() - 1;
116 pos_type first = row.pos();
118 // hfill *DO* count at the beginning of paragraphs!
120 while (first < last && par.isHfill(first))
124 last = min(last, par.beginOfBody());
126 for (pos_type p = first; p < last; ++p) {
134 int numberOfHfills(Paragraph const & par, Row const & row)
136 pos_type const last = row.endpos() - 1;
137 pos_type first = row.pos();
139 // hfill *DO* count at the beginning of paragraphs!
141 while (first < last && par.isHfill(first))
145 first = max(first, par.beginOfBody());
148 for (pos_type p = first; p < last; ++p) {
156 void readParToken(Buffer const & buf, Paragraph & par, LyXLex & lex,
157 string const & token, LyXFont & font, Change & change)
159 BufferParams const & bp = buf.params();
161 if (token[0] != '\\') {
162 string::const_iterator cit = token.begin();
163 for (; cit != token.end(); ++cit)
164 par.insertChar(par.size(), (*cit), font, change);
165 } else if (token == "\\begin_layout") {
167 string layoutname = lex.getString();
169 font = LyXFont(LyXFont::ALL_INHERIT, bp.language);
172 LyXTextClass const & tclass = bp.getLyXTextClass();
174 if (layoutname.empty()) {
175 layoutname = tclass.defaultLayoutName();
178 bool hasLayout = tclass.hasLayout(layoutname);
181 buf.error(ErrorItem(_("Unknown layout"),
182 bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
183 layoutname, tclass.name()), par.id(), 0, par.size()));
184 layoutname = tclass.defaultLayoutName();
187 par.layout(bp.getLyXTextClass()[layoutname]);
189 // Test whether the layout is obsolete.
190 LyXLayout_ptr const & layout = par.layout();
191 if (!layout->obsoleted_by().empty())
192 par.layout(bp.getLyXTextClass()[layout->obsoleted_by()]);
194 par.params().read(lex);
196 } else if (token == "\\end_layout") {
197 lyxerr << BOOST_CURRENT_FUNCTION
198 << ": Solitary \\end_layout in line "
199 << lex.getLineNo() << "\n"
200 << "Missing \\begin_layout?.\n";
201 } else if (token == "\\end_inset") {
202 lyxerr << BOOST_CURRENT_FUNCTION
203 << ": Solitary \\end_inset in line "
204 << lex.getLineNo() << "\n"
205 << "Missing \\begin_inset?.\n";
206 } else if (token == "\\begin_inset") {
207 InsetBase * inset = readInset(lex, buf);
209 par.insertInset(par.size(), inset, font, change);
212 string line = lex.getString();
213 buf.error(ErrorItem(_("Unknown Inset"), line,
214 par.id(), 0, par.size()));
216 } else if (token == "\\family") {
218 font.setLyXFamily(lex.getString());
219 } else if (token == "\\series") {
221 font.setLyXSeries(lex.getString());
222 } else if (token == "\\shape") {
224 font.setLyXShape(lex.getString());
225 } else if (token == "\\size") {
227 font.setLyXSize(lex.getString());
228 } else if (token == "\\lang") {
230 string const tok = lex.getString();
231 Language const * lang = languages.getLanguage(tok);
233 font.setLanguage(lang);
235 font.setLanguage(bp.language);
236 lex.printError("Unknown language `$$Token'");
238 } else if (token == "\\numeric") {
240 font.setNumber(font.setLyXMisc(lex.getString()));
241 } else if (token == "\\emph") {
243 font.setEmph(font.setLyXMisc(lex.getString()));
244 } else if (token == "\\bar") {
246 string const tok = lex.getString();
249 font.setUnderbar(LyXFont::ON);
250 else if (tok == "no")
251 font.setUnderbar(LyXFont::OFF);
252 else if (tok == "default")
253 font.setUnderbar(LyXFont::INHERIT);
255 lex.printError("Unknown bar font flag "
257 } else if (token == "\\noun") {
259 font.setNoun(font.setLyXMisc(lex.getString()));
260 } else if (token == "\\color") {
262 font.setLyXColor(lex.getString());
263 } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
265 // Insets don't make sense in a free-spacing context! ---Kayvan
266 if (par.isFreeSpacing()) {
267 if (token == "\\InsetSpace")
268 par.insertChar(par.size(), ' ', font, change);
269 else if (lex.isOK()) {
271 string const next_token = lex.getString();
272 if (next_token == "\\-")
273 par.insertChar(par.size(), '-', font, change);
275 lex.printError("Token `$$Token' "
277 "paragraph layout!");
281 auto_ptr<InsetBase> inset;
282 if (token == "\\SpecialChar" )
283 inset.reset(new InsetSpecialChar);
285 inset.reset(new InsetSpace);
286 inset->read(buf, lex);
287 par.insertInset(par.size(), inset.release(),
290 } else if (token == "\\i") {
291 auto_ptr<InsetBase> inset(new InsetLatexAccent);
292 inset->read(buf, lex);
293 par.insertInset(par.size(), inset.release(), font, change);
294 } else if (token == "\\backslash") {
295 par.insertChar(par.size(), '\\', font, change);
296 } else if (token == "\\newline") {
297 auto_ptr<InsetBase> inset(new InsetNewline);
298 inset->read(buf, lex);
299 par.insertInset(par.size(), inset.release(), font, change);
300 } else if (token == "\\LyXTable") {
301 auto_ptr<InsetBase> inset(new InsetTabular(buf));
302 inset->read(buf, lex);
303 par.insertInset(par.size(), inset.release(), font, change);
304 } else if (token == "\\bibitem") {
305 InsetCommandParams p("bibitem", "dummy");
306 auto_ptr<InsetBibitem> inset(new InsetBibitem(p));
307 inset->read(buf, lex);
308 par.insertInset(par.size(), inset.release(), font, change);
309 } else if (token == "\\hfill") {
310 par.insertInset(par.size(), new InsetHFill, font, change);
311 } else if (token == "\\lyxline") {
312 par.insertInset(par.size(), new InsetLine, font, change);
313 } else if (token == "\\newpage") {
314 par.insertInset(par.size(), new InsetPagebreak, font, change);
315 } else if (token == "\\change_unchanged") {
316 // Hack ! Needed for empty paragraphs :/
317 // FIXME: is it still ??
322 change = Change(Change::UNCHANGED);
323 } else if (token == "\\change_inserted") {
325 std::istringstream is(lex.getString());
329 change = Change(Change::INSERTED, bp.author_map[aid], ct);
330 } else if (token == "\\change_deleted") {
332 std::istringstream is(lex.getString());
336 change = Change(Change::DELETED, bp.author_map[aid], ct);
339 buf.error(ErrorItem(_("Unknown token"),
340 bformat(_("Unknown token: %1$s %2$s\n"), token, lex.getString()),
341 par.id(), 0, par.size()));
346 void readParagraph(Buffer const & buf, Paragraph & par, LyXLex & lex)
349 string token = lex.getString();
355 readParToken(buf, par, lex, token, font, change);
358 token = lex.getString();
363 if (token == "\\end_layout") {
364 //Ok, paragraph finished
368 lyxerr[Debug::PARSER] << "Handling paragraph token: `"
369 << token << '\'' << endl;
370 if (token == "\\begin_layout" || token == "\\end_document"
371 || token == "\\end_inset" || token == "\\begin_deeper"
372 || token == "\\end_deeper") {
373 lex.pushToken(token);
374 lyxerr << "Paragraph ended in line "
375 << lex.getLineNo() << "\n"
376 << "Missing \\end_layout.\n";
380 // Final change goes to paragraph break:
381 par.setChangeFull(par.size(), change);
383 // Initialize begin_of_body_ on load; redoParagraph maintains
384 par.setBeginOfBody();
392 BufferView * LyXText::bv() const
394 BOOST_ASSERT(bv_owner != 0);
399 double LyXText::spacing(Paragraph const & par) const
401 if (par.params().spacing().isDefault())
402 return bv()->buffer()->params().spacing().getValue();
403 return par.params().spacing().getValue();
407 int LyXText::width() const
413 int LyXText::height() const
415 return dim_.height();
419 int LyXText::singleWidth(Paragraph const & par, pos_type pos) const
421 return singleWidth(par, pos, par.getChar(pos), getFont(par, pos));
425 int LyXText::singleWidth(Paragraph const & par,
426 pos_type pos, char c, LyXFont const & font) const
428 // The most common case is handled first (Asger)
429 if (IsPrintable(c)) {
430 Language const * language = font.language();
431 if (language->RightToLeft()) {
432 if ((lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
433 lyxrc.font_norm_type == LyXRC::ISO_10646_1)
434 && language->lang() == "arabic") {
435 if (Encodings::IsComposeChar_arabic(c))
437 c = par.transformChar(c, pos);
438 } else if (language->lang() == "hebrew" &&
439 Encodings::IsComposeChar_hebrew(c))
442 return font_metrics::width(c, font);
445 if (c == Paragraph::META_INSET)
446 return par.getInset(pos)->width();
448 return font_metrics::width(c, font);
452 int LyXText::leftMargin(pit_type pit) const
454 BOOST_ASSERT(pit >= 0);
455 BOOST_ASSERT(pit < int(pars_.size()));
456 return leftMargin(pit, pars_[pit].size());
460 int LyXText::leftMargin(pit_type const pit, pos_type const pos) const
462 BOOST_ASSERT(pit >= 0);
463 BOOST_ASSERT(pit < int(pars_.size()));
464 Paragraph const & par = pars_[pit];
465 BOOST_ASSERT(pos >= 0);
466 BOOST_ASSERT(pos <= par.size());
467 //lyxerr << "LyXText::leftMargin: pit: " << pit << " pos: " << pos << endl;
468 LyXTextClass const & tclass =
469 bv()->buffer()->params().getLyXTextClass();
470 LyXLayout_ptr const & layout = par.layout();
472 string parindent = layout->parindent;
477 l_margin += changebarMargin();
479 l_margin += font_metrics::signedWidth(tclass.leftmargin(), tclass.defaultfont());
481 if (par.getDepth() != 0) {
482 // find the next level paragraph
483 pit_type newpar = outerHook(pit, pars_);
484 if (newpar != pit_type(pars_.size())) {
485 if (pars_[newpar].layout()->isEnvironment()) {
486 l_margin = leftMargin(newpar);
488 if (par.layout() == tclass.defaultLayout()) {
489 if (pars_[newpar].params().noindent())
492 parindent = pars_[newpar].layout()->parindent;
497 // This happens after sections in standard classes. The 1.3.x
498 // code compared depths too, but it does not seem necessary
500 if (par.layout() == tclass.defaultLayout()
501 && pit > 0 && pars_[pit - 1].layout()->nextnoindent)
504 LyXFont const labelfont = getLabelFont(par);
505 switch (layout->margintype) {
507 if (!layout->leftmargin.empty())
508 l_margin += font_metrics::signedWidth(layout->leftmargin,
509 tclass.defaultfont());
510 if (!par.getLabelstring().empty()) {
511 l_margin += font_metrics::signedWidth(layout->labelindent,
513 l_margin += font_metrics::width(par.getLabelstring(),
515 l_margin += font_metrics::width(layout->labelsep, labelfont);
520 l_margin += font_metrics::signedWidth(layout->labelindent, labelfont);
521 // The width of an empty par, even with manual label, should be 0
522 if (!par.empty() && pos >= par.beginOfBody()) {
523 if (!par.getLabelWidthString().empty()) {
524 l_margin += font_metrics::width(par.getLabelWidthString(),
526 l_margin += font_metrics::width(layout->labelsep, labelfont);
532 l_margin += font_metrics::signedWidth(layout->leftmargin, tclass.defaultfont()) * 4
533 / (par.getDepth() + 4);
536 case MARGIN_FIRST_DYNAMIC:
537 if (layout->labeltype == LABEL_MANUAL) {
538 if (pos >= par.beginOfBody()) {
539 l_margin += font_metrics::signedWidth(layout->leftmargin,
542 l_margin += font_metrics::signedWidth(layout->labelindent,
546 // Special case to fix problems with
548 || (layout->labeltype == LABEL_STATIC
549 && layout->latextype == LATEX_ENVIRONMENT
550 && !isFirstInSequence(pit, pars_))) {
551 l_margin += font_metrics::signedWidth(layout->leftmargin,
553 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
554 && layout->labeltype != LABEL_BIBLIO
555 && layout->labeltype !=
556 LABEL_CENTERED_TOP_ENVIRONMENT) {
557 l_margin += font_metrics::signedWidth(layout->labelindent,
559 l_margin += font_metrics::width(layout->labelsep, labelfont);
560 l_margin += font_metrics::width(par.getLabelstring(),
565 case MARGIN_RIGHT_ADDRESS_BOX: {
567 // ok, a terrible hack. The left margin depends on the widest
568 // row in this paragraph.
569 RowList::iterator rit = par.rows().begin();
570 RowList::iterator end = par.rows().end();
572 #warning This is wrong.
574 int minfill = maxwidth_;
575 for ( ; rit != end; ++rit)
576 if (rit->fill() < minfill)
577 minfill = rit->fill();
578 l_margin += font_metrics::signedWidth(layout->leftmargin,
579 tclass.defaultfont());
582 // also wrong, but much shorter.
583 l_margin += maxwidth_ / 2;
588 if (!par.params().leftIndent().zero())
589 l_margin += par.params().leftIndent().inPixels(maxwidth_);
593 if (par.params().align() == LYX_ALIGN_LAYOUT)
594 align = layout->align;
596 align = par.params().align();
598 // set the correct parindent
600 && (layout->labeltype == LABEL_NO_LABEL
601 || layout->labeltype == LABEL_TOP_ENVIRONMENT
602 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
603 || (layout->labeltype == LABEL_STATIC
604 && layout->latextype == LATEX_ENVIRONMENT
605 && !isFirstInSequence(pit, pars_)))
606 && align == LYX_ALIGN_BLOCK
607 && !par.params().noindent()
608 // in some insets, paragraphs are never indented
609 && !(par.inInset() && par.inInset()->neverIndent())
610 // display style insets are always centered, omit indentation
613 && par.getInset(pos)->display())
614 && (par.layout() != tclass.defaultLayout()
615 || bv()->buffer()->params().paragraph_separation ==
616 BufferParams::PARSEP_INDENT))
618 l_margin += font_metrics::signedWidth(parindent, tclass.defaultfont());
625 int LyXText::rightMargin(Paragraph const & par) const
627 // We do not want rightmargins on inner texts.
628 if (bv()->text() != this)
631 LyXTextClass const & tclass = bv()->buffer()->params().getLyXTextClass();
634 + font_metrics::signedWidth(tclass.rightmargin(),
635 tclass.defaultfont())
636 + font_metrics::signedWidth(par.layout()->rightmargin,
637 tclass.defaultfont())
638 * 4 / (par.getDepth() + 4);
644 int LyXText::labelEnd(pit_type const pit) const
646 // labelEnd is only needed if the layout fills a flushleft label.
647 if (pars_[pit].layout()->margintype != MARGIN_MANUAL)
649 // return the beginning of the body
650 return leftMargin(pit);
656 // this needs special handling - only newlines count as a break point
657 pos_type addressBreakPoint(pos_type i, Paragraph const & par)
659 pos_type const end = par.size();
662 if (par.isNewline(i))
671 void LyXText::rowBreakPoint(pit_type const pit, Row & row) const
673 Paragraph const & par = pars_[pit];
674 pos_type const end = par.size();
675 pos_type const pos = row.pos();
681 // maximum pixel width of a row
682 int width = maxwidth_ - rightMargin(par); // - leftMargin(pit, row);
688 LyXLayout_ptr const & layout = par.layout();
690 if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX) {
691 row.endpos(addressBreakPoint(pos, par));
695 pos_type const body_pos = par.beginOfBody();
698 // Now we iterate through until we reach the right margin
699 // or the end of the par, then choose the possible break
702 int const left = leftMargin(pit, pos);
705 // pixel width since last breakpoint
708 FontIterator fi = FontIterator(*this, par, pos);
709 pos_type point = end;
711 for ( ; i < end; ++i, ++fi) {
712 char const c = par.getChar(i);
713 int thiswidth = singleWidth(par, i, c, *fi);
715 // add the auto-hfill from label end to the body
716 if (body_pos && i == body_pos) {
717 int add = font_metrics::width(layout->labelsep, getLabelFont(par));
718 if (par.isLineSeparator(i - 1))
719 add -= singleWidth(par, i - 1);
721 add = std::max(add, labelEnd(pit) - x);
726 chunkwidth += thiswidth;
728 // break before a character that will fall off
729 // the right of the row
731 // if no break before, break here
732 if (point == end || chunkwidth >= width - left) {
739 // exit on last registered breakpoint:
743 if (par.isNewline(i)) {
749 if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
754 if (par.isInset(i) && par.getInset(i)->display()) {
760 if (!par.isInset(i) || par.getInset(i)->isChar()) {
761 // some insets are line separators too
762 if (par.isLineSeparator(i)) {
763 // register breakpoint:
770 // maybe found one, but the par is short enough.
771 if (i == end && x < width)
774 // manual labels cannot be broken in LaTeX. But we
775 // want to make our on-screen rendering of footnotes
777 if (body_pos && point < body_pos)
784 void LyXText::setRowWidth(pit_type const pit, Row & row) const
786 // get the pure distance
787 pos_type const end = row.endpos();
789 Paragraph const & par = pars_[pit];
790 string const & labelsep = par.layout()->labelsep;
791 int w = leftMargin(pit, row.pos());
793 pos_type const body_pos = par.beginOfBody();
794 pos_type i = row.pos();
797 FontIterator fi = FontIterator(*this, par, i);
798 for ( ; i < end; ++i, ++fi) {
799 if (body_pos > 0 && i == body_pos) {
800 w += font_metrics::width(labelsep, getLabelFont(par));
801 if (par.isLineSeparator(i - 1))
802 w -= singleWidth(par, i - 1);
803 w = max(w, labelEnd(pit));
805 char const c = par.getChar(i);
806 w += singleWidth(par, i, c, *fi);
810 if (body_pos > 0 && body_pos >= end) {
811 w += font_metrics::width(labelsep, getLabelFont(par));
812 if (end > 0 && par.isLineSeparator(end - 1))
813 w -= singleWidth(par, end - 1);
814 w = max(w, labelEnd(pit));
817 row.width(w + rightMargin(par));
821 // returns the minimum space a manual label needs on the screen in pixel
822 int LyXText::labelFill(Paragraph const & par, Row const & row) const
824 pos_type last = par.beginOfBody();
826 BOOST_ASSERT(last > 0);
828 // -1 because a label ends with a space that is in the label
831 // a separator at this end does not count
832 if (par.isLineSeparator(last))
836 for (pos_type i = row.pos(); i <= last; ++i)
837 w += singleWidth(par, i);
839 string const & label = par.params().labelWidthString();
843 return max(0, font_metrics::width(label, getLabelFont(par)) - w);
847 LColor_color LyXText::backgroundColor() const
849 return LColor_color(LColor::color(background_color_));
853 void LyXText::setHeightOfRow(pit_type const pit, Row & row)
855 Paragraph const & par = pars_[pit];
856 // get the maximum ascent and the maximum descent
857 double layoutasc = 0;
858 double layoutdesc = 0;
859 double const dh = defaultRowHeight();
861 // ok, let us initialize the maxasc and maxdesc value.
862 // Only the fontsize count. The other properties
863 // are taken from the layoutfont. Nicer on the screen :)
864 LyXLayout_ptr const & layout = par.layout();
866 // as max get the first character of this row then it can
867 // increase but not decrease the height. Just some point to
868 // start with so we don't have to do the assignment below too
870 LyXFont font = getFont(par, row.pos());
871 LyXFont::FONT_SIZE const tmpsize = font.size();
872 font = getLayoutFont(pit);
873 LyXFont::FONT_SIZE const size = font.size();
874 font.setSize(tmpsize);
876 LyXFont labelfont = getLabelFont(par);
878 // these are minimum values
879 double const spacing_val = layout->spacing.getValue() * spacing(par);
880 //lyxerr << "spacing_val = " << spacing_val << endl;
881 int maxasc = int(font_metrics::maxAscent(font) * spacing_val);
882 int maxdesc = int(font_metrics::maxDescent(font) * spacing_val);
884 // insets may be taller
885 InsetList::const_iterator ii = par.insetlist.begin();
886 InsetList::const_iterator iend = par.insetlist.end();
887 for ( ; ii != iend; ++ii) {
888 if (ii->pos >= row.pos() && ii->pos < row.endpos()) {
889 maxasc = max(maxasc, ii->inset->ascent());
890 maxdesc = max(maxdesc, ii->inset->descent());
894 // Check if any custom fonts are larger (Asger)
895 // This is not completely correct, but we can live with the small,
896 // cosmetic error for now.
898 pos_type const pos_end = row.endpos();
900 LyXFont::FONT_SIZE maxsize =
901 par.highestFontInRange(row.pos(), pos_end, size);
902 if (maxsize > font.size()) {
903 font.setSize(maxsize);
904 maxasc = max(maxasc, font_metrics::maxAscent(font));
905 maxdesc = max(maxdesc, font_metrics::maxDescent(font));
908 // This is nicer with box insets:
915 if (row.pos() == 0) {
916 BufferParams const & bufparams = bv()->buffer()->params();
917 // some parksips VERY EASY IMPLEMENTATION
918 if (bv()->buffer()->params().paragraph_separation
919 == BufferParams::PARSEP_SKIP
921 && ((layout->isParagraph() && par.getDepth() == 0)
922 || (pars_[pit - 1].layout()->isParagraph()
923 && pars_[pit - 1].getDepth() == 0)))
925 maxasc += bufparams.getDefSkip().inPixels(*bv());
928 if (par.params().startOfAppendix())
929 maxasc += int(3 * dh);
931 // This is special code for the chapter, since the label of this
932 // layout is printed in an extra row
933 if (layout->counter == "chapter"
934 && !par.params().labelString().empty()) {
935 labeladdon = int(font_metrics::maxHeight(labelfont)
936 * layout->spacing.getValue()
940 // special code for the top label
941 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
942 || layout->labeltype == LABEL_BIBLIO
943 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
944 && isFirstInSequence(pit, paragraphs())
945 && !par.getLabelstring().empty())
948 font_metrics::maxHeight(labelfont)
949 * layout->spacing.getValue()
951 + (layout->topsep + layout->labelbottomsep) * dh);
954 // Add the layout spaces, for example before and after
955 // a section, or between the items of a itemize or enumerate
958 pit_type prev = depthHook(pit, pars_, par.getDepth());
960 && pars_[prev].layout() == layout
961 && pars_[prev].getDepth() == par.getDepth()
962 && pars_[prev].getLabelWidthString() == par.getLabelWidthString())
964 layoutasc = layout->itemsep * dh;
965 } else if (pit != 0 || row.pos() != 0) {
966 if (layout->topsep > 0)
967 layoutasc = layout->topsep * dh;
970 prev = outerHook(pit, pars_);
971 if (prev != pit_type(pars_.size())) {
972 maxasc += int(pars_[prev].layout()->parsep * dh);
973 } else if (pit != 0) {
974 if (pars_[pit - 1].getDepth() != 0 ||
975 pars_[pit - 1].layout() == layout) {
976 maxasc += int(layout->parsep * dh);
981 // is it a bottom line?
982 if (row.endpos() >= par.size()) {
983 // add the layout spaces, for example before and after
984 // a section, or between the items of a itemize or enumerate
986 pit_type nextpit = pit + 1;
987 if (nextpit != pit_type(pars_.size())) {
992 if (pars_[cpit].getDepth() > pars_[nextpit].getDepth()) {
993 usual = pars_[cpit].layout()->bottomsep * dh;
994 cpit = depthHook(cpit, paragraphs(), pars_[nextpit].getDepth());
995 if (pars_[cpit].layout() != pars_[nextpit].layout()
996 || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
998 unusual = pars_[cpit].layout()->bottomsep * dh;
1000 layoutdesc = max(unusual, usual);
1001 } else if (pars_[cpit].getDepth() == pars_[nextpit].getDepth()) {
1002 if (pars_[cpit].layout() != pars_[nextpit].layout()
1003 || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
1004 layoutdesc = int(pars_[cpit].layout()->bottomsep * dh);
1009 // incalculate the layout spaces
1010 maxasc += int(layoutasc * 2 / (2 + pars_[pit].getDepth()));
1011 maxdesc += int(layoutdesc * 2 / (2 + pars_[pit].getDepth()));
1013 // Top and bottom margin of the document (only at top-level)
1014 if (bv_owner->text() == this) {
1015 if (pit == 0 && row.pos() == 0)
1017 if (pit + 1 == pit_type(pars_.size()) &&
1018 row.endpos() == par.size())
1022 row.ascent(maxasc + labeladdon);
1023 row.descent(maxdesc);
1031 void LyXText::breakParagraph(LCursor & cur, bool keep_layout)
1033 BOOST_ASSERT(this == cur.text());
1035 Paragraph & cpar = cur.paragraph();
1036 pit_type cpit = cur.pit();
1038 LyXTextClass const & tclass = cur.buffer().params().getLyXTextClass();
1039 LyXLayout_ptr const & layout = cpar.layout();
1041 // this is only allowed, if the current paragraph is not empty
1042 // or caption and if it has not the keepempty flag active
1043 if (cur.lastpos() == 0 && !cpar.allowEmpty()
1044 && layout->labeltype != LABEL_SENSITIVE)
1047 // a layout change may affect also the following paragraph
1048 recUndo(cur.pit(), undoSpan(cur.pit()) - 1);
1050 // Always break behind a space
1051 // It is better to erase the space (Dekel)
1052 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
1053 cpar.erase(cur.pos());
1055 // How should the layout for the new paragraph be?
1056 int preserve_layout = 0;
1058 preserve_layout = 2;
1060 preserve_layout = layout->isEnvironment();
1062 // We need to remember this before we break the paragraph, because
1063 // that invalidates the layout variable
1064 bool sensitive = layout->labeltype == LABEL_SENSITIVE;
1066 // we need to set this before we insert the paragraph.
1067 bool const isempty = cpar.allowEmpty() && cpar.empty();
1069 ::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
1070 cur.pos(), preserve_layout);
1072 // After this, neither paragraph contains any rows!
1075 pit_type next_par = cpit + 1;
1077 // well this is the caption hack since one caption is really enough
1080 // set to standard-layout
1081 pars_[cpit].applyLayout(tclass.defaultLayout());
1083 // set to standard-layout
1084 pars_[next_par].applyLayout(tclass.defaultLayout());
1087 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0))
1088 pars_[next_par].erase(0);
1090 updateCounters(cur.buffer());
1092 // Mark "carriage return" as inserted if change tracking:
1093 if (cur.buffer().params().tracking_changes) {
1094 cur.paragraph().setChange(cur.paragraph().size(),
1098 // This check is necessary. Otherwise the new empty paragraph will
1099 // be deleted automatically. And it is more friendly for the user!
1100 if (cur.pos() != 0 || isempty)
1101 setCursor(cur, cur.pit() + 1, 0);
1103 setCursor(cur, cur.pit(), 0);
1107 // insert a character, moves all the following breaks in the
1108 // same Paragraph one to the right and make a rebreak
1109 void LyXText::insertChar(LCursor & cur, char c)
1111 BOOST_ASSERT(this == cur.text());
1112 BOOST_ASSERT(c != Paragraph::META_INSET);
1114 recordUndo(cur, Undo::INSERT);
1116 Paragraph & par = cur.paragraph();
1117 // try to remove this
1118 pit_type const pit = cur.pit();
1120 bool const freeSpacing = par.layout()->free_spacing ||
1121 par.isFreeSpacing();
1123 if (lyxrc.auto_number) {
1124 static string const number_operators = "+-/*";
1125 static string const number_unary_operators = "+-";
1126 static string const number_seperators = ".,:";
1128 if (current_font.number() == LyXFont::ON) {
1129 if (!IsDigit(c) && !contains(number_operators, c) &&
1130 !(contains(number_seperators, c) &&
1132 cur.pos() != cur.lastpos() &&
1133 getFont(par, cur.pos()).number() == LyXFont::ON &&
1134 getFont(par, cur.pos() - 1).number() == LyXFont::ON)
1136 number(cur); // Set current_font.number to OFF
1137 } else if (IsDigit(c) &&
1138 real_current_font.isVisibleRightToLeft()) {
1139 number(cur); // Set current_font.number to ON
1141 if (cur.pos() != 0) {
1142 char const c = par.getChar(cur.pos() - 1);
1143 if (contains(number_unary_operators, c) &&
1145 || par.isSeparator(cur.pos() - 2)
1146 || par.isNewline(cur.pos() - 2))
1148 setCharFont(pit, cur.pos() - 1, current_font);
1149 } else if (contains(number_seperators, c)
1151 && getFont(par, cur.pos() - 2).number() == LyXFont::ON) {
1152 setCharFont(pit, cur.pos() - 1, current_font);
1158 // First check, if there will be two blanks together or a blank at
1159 // the beginning of a paragraph.
1160 // I decided to handle blanks like normal characters, the main
1161 // difference are the special checks when calculating the row.fill
1162 // (blank does not count at the end of a row) and the check here
1164 // When the free-spacing option is set for the current layout,
1165 // disable the double-space checking
1166 if (!freeSpacing && IsLineSeparatorChar(c)) {
1167 if (cur.pos() == 0) {
1168 static bool sent_space_message = false;
1169 if (!sent_space_message) {
1170 cur.message(_("You cannot insert a space at the "
1171 "beginning of a paragraph. Please read the Tutorial."));
1172 sent_space_message = true;
1176 BOOST_ASSERT(cur.pos() > 0);
1177 if ((par.isLineSeparator(cur.pos() - 1)
1178 || par.isNewline(cur.pos() - 1))
1179 && par.lookupChange(cur.pos() - 1) != Change::DELETED) {
1180 static bool sent_space_message = false;
1181 if (!sent_space_message) {
1182 cur.message(_("You cannot type two spaces this way. "
1183 "Please read the Tutorial."));
1184 sent_space_message = true;
1190 par.insertChar(cur.pos(), c, current_font);
1191 setCursor(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1196 void LyXText::charInserted()
1198 // Here we call finishUndo for every 20 characters inserted.
1199 // This is from my experience how emacs does it. (Lgb)
1200 static unsigned int counter;
1211 LyXText::computeRowMetrics(pit_type const pit, Row const & row) const
1214 Paragraph const & par = pars_[pit];
1216 double w = dim_.wid - row.width();
1218 bool const is_rtl = isRTL(par);
1220 result.x = rightMargin(par);
1222 result.x = leftMargin(pit, row.pos());
1224 // is there a manual margin with a manual label
1225 LyXLayout_ptr const & layout = par.layout();
1227 if (layout->margintype == MARGIN_MANUAL
1228 && layout->labeltype == LABEL_MANUAL) {
1229 /// We might have real hfills in the label part
1230 int nlh = numberOfLabelHfills(par, row);
1232 // A manual label par (e.g. List) has an auto-hfill
1233 // between the label text and the body of the
1235 // But we don't want to do this auto hfill if the par
1240 if (nlh && !par.getLabelWidthString().empty())
1241 result.label_hfill = labelFill(par, row) / double(nlh);
1244 // are there any hfills in the row?
1245 int const nh = numberOfHfills(par, row);
1249 result.hfill = w / nh;
1250 // we don't have to look at the alignment if it is ALIGN_LEFT and
1251 // if the row is already larger then the permitted width as then
1252 // we force the LEFT_ALIGN'edness!
1253 } else if (int(row.width()) < maxwidth_) {
1254 // is it block, flushleft or flushright?
1255 // set x how you need it
1257 if (par.params().align() == LYX_ALIGN_LAYOUT)
1258 align = layout->align;
1260 align = par.params().align();
1262 // Display-style insets should always be on a centred row
1263 // The test on par.size() is to catch zero-size pars, which
1264 // would trigger the assert in Paragraph::getInset().
1265 //inset = par.size() ? par.getInset(row.pos()) : 0;
1267 && par.isInset(row.pos())
1268 && par.getInset(row.pos())->display())
1270 align = LYX_ALIGN_CENTER;
1274 case LYX_ALIGN_BLOCK: {
1275 int const ns = numberOfSeparators(par, row);
1276 bool disp_inset = false;
1277 if (row.endpos() < par.size()) {
1278 InsetBase const * in = par.getInset(row.endpos());
1280 disp_inset = in->display();
1282 // If we have separators, this is not the last row of a
1283 // par, does not end in newline, and is not row above a
1284 // display inset... then stretch it
1286 && row.endpos() < par.size()
1287 && !par.isNewline(row.endpos() - 1)
1290 result.separator = w / ns;
1291 } else if (is_rtl) {
1296 case LYX_ALIGN_RIGHT:
1299 case LYX_ALIGN_CENTER:
1305 bidi.computeTables(par, *bv()->buffer(), row);
1307 pos_type body_pos = par.beginOfBody();
1308 pos_type end = row.endpos();
1311 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1313 result.x += font_metrics::width(layout->labelsep, getLabelFont(par));
1314 if (body_pos <= end)
1315 result.x += result.label_hfill;
1323 // the cursor set functions have a special mechanism. When they
1324 // realize, that you left an empty paragraph, they will delete it.
1326 bool LyXText::cursorRightOneWord(LCursor & cur)
1328 BOOST_ASSERT(this == cur.text());
1332 if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
1336 // Advance through word.
1337 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
1339 // Skip through trailing nonword stuff.
1340 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
1343 return setCursor(cur, old.pit(), old.pos());
1347 bool LyXText::cursorLeftOneWord(LCursor & cur)
1349 BOOST_ASSERT(this == cur.text());
1353 if (old.pos() == 0 && old.pit() != 0) {
1355 old.pos() = old.lastpos();
1357 // Skip through initial nonword stuff.
1358 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
1360 // Advance through word.
1361 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
1364 return setCursor(cur, old.pit(), old.pos());
1368 void LyXText::selectWord(LCursor & cur, word_location loc)
1370 BOOST_ASSERT(this == cur.text());
1371 CursorSlice from = cur.top();
1372 CursorSlice to = cur.top();
1373 getWord(from, to, loc);
1374 if (cur.top() != from)
1375 setCursor(cur, from.pit(), from.pos());
1379 setCursor(cur, to.pit(), to.pos());
1384 // Select the word currently under the cursor when no
1385 // selection is currently set
1386 bool LyXText::selectWordWhenUnderCursor(LCursor & cur, word_location loc)
1388 BOOST_ASSERT(this == cur.text());
1389 if (cur.selection())
1391 selectWord(cur, loc);
1392 return cur.selection();
1396 void LyXText::acceptChange(LCursor & cur)
1398 BOOST_ASSERT(this == cur.text());
1399 if (!cur.selection() && cur.lastpos() != 0)
1402 recordUndoSelection(cur, Undo::INSERT);
1404 DocIterator it = cur.selectionBegin();
1405 DocIterator et = cur.selectionEnd();
1406 pit_type pit = it.pit();
1407 Change::Type const type = pars_[pit].lookupChange(it.pos());
1408 for (; pit <= et.pit(); ++pit) {
1409 pos_type left = ( pit == it.pit() ? it.pos() : 0 );
1411 ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1412 pars_[pit].acceptChange(left, right);
1414 if (type == Change::DELETED) {
1415 ParagraphList & plist = paragraphs();
1416 if (it.pit() + 1 < et.pit())
1417 pars_.erase(plist.begin() + it.pit() + 1,
1418 plist.begin() + et.pit());
1420 // Paragraph merge if appropriate:
1421 if (pars_[it.pit()].lookupChange(pars_[it.pit()].size())
1422 == Change::DELETED) {
1423 setCursorIntern(cur, it.pit() + 1, 0);
1428 cur.clearSelection();
1429 setCursorIntern(cur, it.pit(), 0);
1433 void LyXText::rejectChange(LCursor & cur)
1435 BOOST_ASSERT(this == cur.text());
1436 if (!cur.selection() && cur.lastpos() != 0)
1439 recordUndoSelection(cur, Undo::INSERT);
1441 DocIterator it = cur.selectionBegin();
1442 DocIterator et = cur.selectionEnd();
1443 pit_type pit = it.pit();
1444 Change::Type const type = pars_[pit].lookupChange(it.pos());
1445 for (; pit <= et.pit(); ++pit) {
1446 pos_type left = ( pit == it.pit() ? it.pos() : 0 );
1448 ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1449 pars_[pit].rejectChange(left, right);
1451 if (type == Change::INSERTED) {
1452 ParagraphList & plist = paragraphs();
1453 if (it.pit() + 1 < et.pit())
1454 pars_.erase(plist.begin() + it.pit() + 1,
1455 plist.begin() + et.pit());
1456 // Paragraph merge if appropriate:
1457 if (pars_[it.pit()].lookupChange(pars_[it.pit()].size())
1458 == Change::INSERTED) {
1459 setCursorIntern(cur, it.pit() + 1, 0);
1464 cur.clearSelection();
1465 setCursorIntern(cur, it.pit(), 0);
1469 // Delete from cursor up to the end of the current or next word.
1470 void LyXText::deleteWordForward(LCursor & cur)
1472 BOOST_ASSERT(this == cur.text());
1473 if (cur.lastpos() == 0)
1477 cur.selection() = true;
1478 cursorRightOneWord(cur);
1480 cutSelection(cur, true, false);
1485 // Delete from cursor to start of current or prior word.
1486 void LyXText::deleteWordBackward(LCursor & cur)
1488 BOOST_ASSERT(this == cur.text());
1489 if (cur.lastpos() == 0)
1493 cur.selection() = true;
1494 cursorLeftOneWord(cur);
1496 cutSelection(cur, true, false);
1501 // Kill to end of line.
1502 void LyXText::deleteLineForward(LCursor & cur)
1504 BOOST_ASSERT(this == cur.text());
1505 if (cur.lastpos() == 0) {
1506 // Paragraph is empty, so we just go to the right
1510 cur.selection() = true; // to avoid deletion
1513 // What is this test for ??? (JMarc)
1514 if (!cur.selection())
1515 deleteWordForward(cur);
1517 cutSelection(cur, true, false);
1522 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
1524 BOOST_ASSERT(this == cur.text());
1528 if (cur.selection()) {
1529 from = cur.selBegin();
1533 getWord(from, to, lyx::PARTIAL_WORD);
1534 cursorRightOneWord(cur);
1537 recordUndoSelection(cur);
1539 pos_type pos = from.pos();
1540 int par = from.pit();
1542 while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1544 if (pos == pars_[pit].size()) {
1549 unsigned char c = pars_[pit].getChar(pos);
1550 if (c != Paragraph::META_INSET) {
1552 case text_lowercase:
1555 case text_capitalization:
1557 action = text_lowercase;
1559 case text_uppercase:
1564 #ifdef WITH_WARNINGS
1567 pars_[pit].setChar(pos, c);
1573 bool LyXText::Delete(LCursor & cur)
1575 BOOST_ASSERT(this == cur.text());
1576 bool needsUpdate = false;
1578 if (cur.pos() != cur.lastpos()) {
1579 recordUndo(cur, Undo::DELETE, cur.pit());
1580 setCursorIntern(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1581 needsUpdate = backspace(cur);
1582 } else if (cur.pit() != cur.lastpit()) {
1585 setCursorIntern(cur, cur.pit()+1, 0, false, false);
1586 if (pars_[cur.pit()].layout() == pars_[scur.pit()].layout()) {
1587 recordUndo(scur, Undo::DELETE, scur.pit());
1588 needsUpdate = backspace(cur);
1590 setCursorIntern(scur, scur.pit(), scur.pos(), false, scur.boundary());
1597 bool LyXText::backspacePos0(LCursor & cur)
1599 BOOST_ASSERT(this == cur.text());
1600 bool needsUpdate = false;
1602 Paragraph & par = cur.paragraph();
1603 // is it an empty paragraph?
1604 pos_type lastpos = cur.lastpos();
1605 if (lastpos == 0 || (lastpos == 1 && par.isSeparator(0))) {
1606 // This is an empty paragraph and we delete it just
1607 // by moving the cursor one step
1608 // left and let the DeleteEmptyParagraphMechanism
1609 // handle the actual deletion of the paragraph.
1611 if (cur.pit() != 0) {
1612 // For KeepEmpty layouts we need to get
1613 // rid of the keepEmpty setting first.
1614 // And the only way to do this is to
1615 // reset the layout to something
1616 // else: f.ex. the default layout.
1617 if (par.allowEmpty()) {
1618 Buffer & buf = cur.buffer();
1619 BufferParams const & bparams = buf.params();
1620 par.layout(bparams.getLyXTextClass().defaultLayout());
1629 recordUndo(cur, Undo::DELETE, cur.pit() - 1);
1631 pit_type tmppit = cur.pit();
1632 // We used to do cursorLeftIntern() here, but it is
1633 // not a good idea since it triggers the auto-delete
1634 // mechanism. So we do a cursorLeftIntern()-lite,
1635 // without the dreaded mechanism. (JMarc)
1636 if (cur.pit() != 0) {
1637 // steps into the above paragraph.
1638 setCursorIntern(cur, cur.pit() - 1,
1639 pars_[cur.pit() - 1].size(),
1643 // Pasting is not allowed, if the paragraphs have different
1644 // layout. I think it is a real bug of all other
1645 // word processors to allow it. It confuses the user.
1646 // Correction: Pasting is always allowed with standard-layout
1647 // Correction (Jug 20050717): Remove check about alignment!
1648 Buffer & buf = cur.buffer();
1649 BufferParams const & bufparams = buf.params();
1650 LyXTextClass const & tclass = bufparams.getLyXTextClass();
1651 pit_type const cpit = cur.pit();
1654 && (pars_[cpit].layout() == pars_[tmppit].layout()
1655 || pars_[tmppit].layout() == tclass.defaultLayout()))
1657 mergeParagraph(bufparams, pars_, cpit);
1660 if (cur.pos() != 0 && pars_[cpit].isSeparator(cur.pos() - 1))
1663 // the counters may have changed
1664 updateCounters(cur.buffer());
1665 setCursor(cur, cur.pit(), cur.pos(), false);
1671 bool LyXText::backspace(LCursor & cur)
1673 BOOST_ASSERT(this == cur.text());
1674 bool needsUpdate = false;
1675 if (cur.pos() == 0) {
1676 // The cursor is at the beginning of a paragraph, so
1677 // the the backspace will collapse two paragraphs into
1680 if (cur.buffer().params().tracking_changes) {
1681 // Previous paragraph, mark "carriage return" as
1683 Paragraph & par = pars_[cur.pit() - 1];
1684 par.setChange(par.size(), Change::DELETED);
1685 setCursorIntern(cur, cur.pit() - 1, par.size());
1689 needsUpdate = backspacePos0(cur);
1692 // this is the code for a normal backspace, not pasting
1694 recordUndo(cur, Undo::DELETE);
1695 // We used to do cursorLeftIntern() here, but it is
1696 // not a good idea since it triggers the auto-delete
1697 // mechanism. So we do a cursorLeftIntern()-lite,
1698 // without the dreaded mechanism. (JMarc)
1699 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1700 false, cur.boundary());
1701 cur.paragraph().erase(cur.pos());
1704 if (cur.pos() == cur.lastpos())
1705 setCurrentFont(cur);
1707 setCursor(cur, cur.pit(), cur.pos(), false, cur.boundary());
1713 Row const & LyXText::firstRow() const
1715 return *paragraphs().front().rows().begin();
1719 bool LyXText::redoParagraph(pit_type const pit)
1721 // remove rows of paragraph, keep track of height changes
1722 Paragraph & par = pars_[pit];
1724 // Add bibitem insets if necessary
1725 if (par.layout()->labeltype == LABEL_BIBLIO) {
1726 bool hasbibitem(false);
1727 if (!par.insetlist.empty()
1728 // Insist on it being in pos 0
1729 && par.getChar(0) == Paragraph::META_INSET) {
1730 InsetBase * inset = par.insetlist.begin()->inset;
1731 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
1735 InsetBibitem * inset(new
1736 InsetBibitem(InsetCommandParams("bibitem")));
1737 par.insertInset(0, static_cast<InsetBase *>(inset));
1738 bv()->cursor().posRight();
1743 // FIXME: We should always use getFont(), see documentation of
1744 // noFontChange() in insetbase.h.
1745 LyXFont const bufferfont = bv()->buffer()->params().getFont();
1746 InsetList::iterator ii = par.insetlist.begin();
1747 InsetList::iterator iend = par.insetlist.end();
1748 for (; ii != iend; ++ii) {
1750 int const w = maxwidth_ - leftMargin(pit, ii->pos) - rightMargin(par);
1751 LyXFont const & font = ii->inset->noFontChange() ?
1753 getFont(par, ii->pos);
1754 MetricsInfo mi(bv(), font, w);
1755 ii->inset->metrics(mi, dim);
1758 // rebreak the paragraph
1762 par.setBeginOfBody();
1766 rowBreakPoint(pit, row);
1767 setRowWidth(pit, row);
1768 setHeightOfRow(pit, row);
1769 par.rows().push_back(row);
1770 dim.wid = std::max(dim.wid, row.width());
1771 dim.des += row.height();
1773 } while (z < par.size());
1775 // Make sure that if a par ends in newline, there is one more row
1777 // FIXME this is a dirty trick. Now the _same_ position in the
1778 // paragraph occurs in _two_ different rows, and has two different
1779 // display positions, leading to weird behaviour when moving up/down.
1780 if (z > 0 && par.isNewline(z - 1)) {
1783 setRowWidth(pit, row);
1784 setHeightOfRow(pit, row);
1785 par.rows().push_back(row);
1786 dim.des += row.height();
1789 dim.asc += par.rows()[0].ascent();
1790 dim.des -= par.rows()[0].ascent();
1792 bool const same = dim == par.dim();
1795 //lyxerr << "redoParagraph: " << par.rows().size() << " rows\n";
1801 void LyXText::metrics(MetricsInfo & mi, Dimension & dim)
1803 //BOOST_ASSERT(mi.base.textwidth);
1804 if (mi.base.textwidth)
1805 maxwidth_ = mi.base.textwidth;
1806 //lyxerr << "LyXText::metrics: width: " << mi.base.textwidth
1807 // << " maxWidth: " << maxwidth_ << "\nfont: " << mi.base.font << endl;
1808 // save the caller's font locally:
1809 font_ = mi.base.font;
1813 for (pit_type pit = 0, n = paragraphs().size(); pit != n; ++pit) {
1815 Paragraph & par = paragraphs()[pit];
1817 if (w < par.width())
1822 dim.asc = pars_[0].ascent();
1823 dim.des = h - dim.asc;
1829 // only used for inset right now. should also be used for main text
1830 void LyXText::draw(PainterInfo & pi, int x, int y) const
1832 paintTextInset(*this, pi, x, y);
1837 // only used for inset right now. should also be used for main text
1838 void LyXText::drawSelection(PainterInfo & pi, int x , int) const
1840 LCursor & cur = pi.base.bv->cursor();
1841 if (!cur.selection())
1843 if (!ptr_cmp(cur.text(), this))
1846 lyxerr << "draw selection at " << x << endl;
1848 DocIterator beg = cur.selectionBegin();
1849 DocIterator end = cur.selectionEnd();
1851 // the selection doesn't touch the visible screen
1852 if (bv_funcs::status(pi.base.bv, beg) == bv_funcs::CUR_BELOW
1853 || bv_funcs::status(pi.base.bv, end) == bv_funcs::CUR_ABOVE)
1856 Paragraph const & par1 = pars_[beg.pit()];
1857 Paragraph const & par2 = pars_[end.pit()];
1859 Row const & row1 = par1.getRow(beg.pos(), beg.boundary());
1860 Row const & row2 = par2.getRow(end.pos(), end.boundary());
1863 if (bv_funcs::status(pi.base.bv, beg) == bv_funcs::CUR_ABOVE) {
1868 y1 = bv_funcs::getPos(beg).y_ - row1.ascent();
1869 int const startx = cursorX(beg.top(), begin.boundary());
1870 x1 = isRTL(par1) ? startx : 0;
1871 x2 = isRTL(par1) ? 0 + dim_.wid : startx;
1875 if (bv_funcs::status(pi.base.bv, end) == bv_funcs::CUR_BELOW) {
1876 y2 = pi.base.bv->workHeight();
1880 y2 = bv_funcs::getPos(end).y_ + row2.descent();
1881 int const endx = cursorX(end.top(), end.boundary());
1882 X1 = isRTL(par2) ? 0 : endx;
1883 X2 = isRTL(par2) ? endx : 0 + dim_.wid;
1886 lyxerr << " y1: " << y1 << " y2: " << y2
1887 << " xo: " << xo_ << " wid: " << dim_.wid
1890 // paint big rectangle in one go
1891 pi.pain.fillRectangle(x, y1, dim_.wid, y2 - y1, LColor::selection);
1893 // reset background at begin of first selected line
1894 pi.pain.fillRectangle(x + x1, y1, x2 - x1, row1.height(),
1895 LColor::background);
1897 // reset background at end of last selected line
1898 pi.pain.fillRectangle(x + X1, y2 - row2.height(),
1899 X2 - X1, row2.height(), LColor::background);
1904 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1906 LCursor & cur = pi.base.bv->cursor();
1907 if (!cur.selection())
1909 if (!ptr_cmp(cur.text(), this))
1912 lyxerr[Debug::DEBUG]
1913 << BOOST_CURRENT_FUNCTION
1914 << "draw selection at " << x
1917 DocIterator beg = cur.selectionBegin();
1918 DocIterator end = cur.selectionEnd();
1920 // the selection doesn't touch the visible screen
1921 if (bv_funcs::status(pi.base.bv, beg) == bv_funcs::CUR_BELOW
1922 || bv_funcs::status(pi.base.bv, end) == bv_funcs::CUR_ABOVE)
1925 Paragraph const & par1 = pars_[beg.pit()];
1926 Paragraph const & par2 = pars_[end.pit()];
1928 bool const above = (bv_funcs::status(pi.base.bv, beg)
1929 == bv_funcs::CUR_ABOVE);
1930 bool const below = (bv_funcs::status(pi.base.bv, end)
1931 == bv_funcs::CUR_BELOW);
1939 Row const & row1 = par1.getRow(beg.pos(), beg.boundary());
1940 y1 = bv_funcs::getPos(beg, beg.boundary()).y_ - row1.ascent();
1941 y2 = y1 + row1.height();
1942 int const startx = cursorX(beg.top(), beg.boundary());
1943 x1 = !isRTL(par1) ? startx : 0;
1944 x2 = !isRTL(par1) ? 0 + dim_.wid : startx;
1949 Y1 = pi.base.bv->workHeight();
1950 Y2 = pi.base.bv->workHeight();
1954 Row const & row2 = par2.getRow(end.pos(), end.boundary());
1955 Y1 = bv_funcs::getPos(end, end.boundary()).y_ - row2.ascent();
1956 Y2 = Y1 + row2.height();
1957 int const endx = cursorX(end.top(), end.boundary());
1958 X1 = !isRTL(par2) ? 0 : endx;
1959 X2 = !isRTL(par2) ? endx : 0 + dim_.wid;
1962 if (!above && !below && &par1.getRow(beg.pos(), beg.boundary())
1963 == &par2.getRow(end.pos(), end.boundary()))
1965 // paint only one rectangle
1966 int const b( !isRTL(par1) ? x + x1 : x + X1 );
1967 int const w( !isRTL(par1) ? X2 - x1 : x2 - X1 );
1968 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
1972 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
1973 << "X1:" << X1 << " x2: " << X2 << " wid: " << dim_.wid
1976 // paint upper rectangle
1977 pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
1979 // paint bottom rectangle
1980 pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
1982 // paint center rectangle
1983 pi.pain.fillRectangle(x, y2, dim_.wid,
1984 Y1 - y2, LColor::selection);
1988 bool LyXText::isLastRow(pit_type pit, Row const & row) const
1990 return row.endpos() >= pars_[pit].size()
1991 && pit + 1 == pit_type(paragraphs().size());
1995 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
1997 return row.pos() == 0 && pit == 0;
2001 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
2002 word_location const loc)
2004 Paragraph const & from_par = pars_[from.pit()];
2006 case lyx::WHOLE_WORD_STRICT:
2007 if (from.pos() == 0 || from.pos() == from_par.size()
2008 || !from_par.isLetter(from.pos())
2009 || !from_par.isLetter(from.pos() - 1)) {
2013 // no break here, we go to the next
2015 case lyx::WHOLE_WORD:
2016 // If we are already at the beginning of a word, do nothing
2017 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
2019 // no break here, we go to the next
2021 case lyx::PREVIOUS_WORD:
2022 // always move the cursor to the beginning of previous word
2023 while (from.pos() && from_par.isLetter(from.pos() - 1))
2026 case lyx::NEXT_WORD:
2027 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
2030 case lyx::PARTIAL_WORD:
2031 // no need to move the 'from' cursor
2035 Paragraph & to_par = pars_[to.pit()];
2036 while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
2041 void LyXText::write(Buffer const & buf, std::ostream & os) const
2043 ParagraphList::const_iterator pit = paragraphs().begin();
2044 ParagraphList::const_iterator end = paragraphs().end();
2045 Paragraph::depth_type dth = 0;
2046 for (; pit != end; ++pit)
2047 pit->write(buf, os, buf.params(), dth);
2051 bool LyXText::read(Buffer const & buf, LyXLex & lex)
2053 Paragraph::depth_type depth = 0;
2055 while (lex.isOK()) {
2057 string const token = lex.getString();
2062 if (token == "\\end_inset") {
2066 if (token == "\\end_body") {
2070 if (token == "\\begin_body") {
2074 if (token == "\\end_document") {
2078 if (token == "\\begin_layout") {
2079 lex.pushToken(token);
2082 par.params().depth(depth);
2083 if (buf.params().tracking_changes)
2085 par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
2086 pars_.push_back(par);
2088 // FIXME: goddamn InsetTabular makes us pass a Buffer
2090 ::readParagraph(buf, pars_.back(), lex);
2092 } else if (token == "\\begin_deeper") {
2094 } else if (token == "\\end_deeper") {
2096 lex.printError("\\end_deeper: " "depth is already null");
2101 lyxerr << "Handling unknown body token: `"
2102 << token << '\'' << endl;
2109 int LyXText::ascent() const
2115 int LyXText::descent() const
2121 int LyXText::cursorX(CursorSlice const & sl, bool boundary) const
2123 pit_type const pit = sl.pit();
2124 Paragraph const & par = pars_[pit];
2125 if (par.rows().empty())
2128 pos_type ppos = sl.pos();
2129 // Correct position in front of big insets
2130 bool const boundary_correction = ppos != 0 && boundary;
2131 if (boundary_correction)
2134 Row const & row = par.getRow(sl.pos(), boundary);
2136 pos_type cursor_vpos = 0;
2138 RowMetrics const m = computeRowMetrics(pit, row);
2141 pos_type const row_pos = row.pos();
2142 pos_type const end = row.endpos();
2145 cursor_vpos = row_pos;
2146 else if (ppos >= end)
2147 cursor_vpos = isRTL(par) ? row_pos : end;
2148 else if (ppos > row_pos && ppos >= end)
2149 // Place cursor after char at (logical) position pos - 1
2150 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
2151 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
2153 // Place cursor before char at (logical) position ppos
2154 cursor_vpos = (bidi.level(ppos) % 2 == 0)
2155 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
2157 pos_type body_pos = par.beginOfBody();
2159 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
2162 // Use font span to speed things up, see below
2166 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
2167 pos_type pos = bidi.vis2log(vpos);
2168 if (body_pos > 0 && pos == body_pos - 1) {
2170 + font_metrics::width(par.layout()->labelsep,
2172 if (par.isLineSeparator(body_pos - 1))
2173 x -= singleWidth(par, body_pos - 1);
2176 // Use font span to speed things up, see above
2177 if (pos < font_span.first || pos > font_span.last) {
2178 font_span = par.fontSpan(pos);
2179 font = getFont(par, pos);
2182 x += singleWidth(par, pos, par.getChar(pos), font);
2184 if (hfillExpansion(par, row, pos))
2185 x += (pos >= body_pos) ? m.hfill : m.label_hfill;
2186 else if (par.isSeparator(pos) && pos >= body_pos)
2190 // see correction above
2191 if (boundary_correction)
2192 if (getFont(par, ppos).isVisibleRightToLeft())
2193 x -= singleWidth(par, ppos);
2195 x += singleWidth(par, ppos);
2197 // Make sure inside an inset we always count from the left
2198 // edge (bidi!) -- MV
2199 if (sl.pos() < par.size()) {
2200 font = getFont(par, sl.pos());
2201 if (!boundary && font.isVisibleRightToLeft()
2202 && par.isInset(sl.pos()))
2203 x -= par.getInset(sl.pos())->width();
2209 int LyXText::cursorY(CursorSlice const & sl, bool boundary) const
2211 //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
2212 Paragraph const & par = getPar(sl.pit());
2214 h -= pars_[0].rows()[0].ascent();
2215 for (pit_type pit = 0; pit < sl.pit(); ++pit)
2216 h += pars_[pit].height();
2218 if (pos && boundary)
2220 size_t const rend = par.pos2row(pos);
2221 for (size_t rit = 0; rit != rend; ++rit)
2222 h += par.rows()[rit].height();
2223 h += par.rows()[rend].ascent();
2228 // Returns the current font and depth as a message.
2229 string LyXText::currentState(LCursor & cur)
2231 BOOST_ASSERT(this == cur.text());
2232 Buffer & buf = cur.buffer();
2233 Paragraph const & par = cur.paragraph();
2234 std::ostringstream os;
2236 bool const show_change = buf.params().tracking_changes
2237 && par.lookupChange(cur.pos()) != Change::UNCHANGED;
2239 if (buf.params().tracking_changes)
2243 Change change = par.lookupChangeFull(cur.pos());
2244 Author const & a = buf.params().authors().get(change.author);
2245 os << _("Change: ") << a.name();
2246 if (!a.email().empty())
2247 os << " (" << a.email() << ")";
2248 if (change.changetime)
2249 os << _(" at ") << ctime(&change.changetime);
2253 // I think we should only show changes from the default
2255 // No, from the document font (MV)
2256 LyXFont font = real_current_font;
2257 font.reduce(buf.params().getFont());
2259 // avoid _(...) re-entrance problem
2260 string const s = font.stateText(&buf.params());
2261 os << bformat(_("Font: %1$s"), s);
2263 // os << bformat(_("Font: %1$s"), font.stateText(&buf.params));
2265 // The paragraph depth
2266 int depth = cur.paragraph().getDepth();
2268 os << bformat(_(", Depth: %1$d"), depth);
2270 // The paragraph spacing, but only if different from
2272 Spacing const & spacing = par.params().spacing();
2273 if (!spacing.isDefault()) {
2274 os << _(", Spacing: ");
2275 switch (spacing.getSpace()) {
2276 case Spacing::Single:
2279 case Spacing::Onehalf:
2282 case Spacing::Double:
2285 case Spacing::Other:
2286 os << _("Other (") << spacing.getValueAsString() << ')';
2288 case Spacing::Default:
2289 // should never happen, do nothing
2294 #ifdef DEVEL_VERSION
2295 os << _(", Inset: ") << &cur.inset();
2296 os << _(", Paragraph: ") << cur.pit();
2297 os << _(", Id: ") << par.id();
2298 os << _(", Position: ") << cur.pos();
2299 os << _(", Boundary: ") << cur.boundary();
2300 // Row & row = cur.textRow();
2301 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2307 string LyXText::getPossibleLabel(LCursor & cur) const
2309 pit_type pit = cur.pit();
2311 LyXLayout_ptr layout = pars_[pit].layout();
2313 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
2314 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
2315 if (layout2->latextype != LATEX_PARAGRAPH) {
2321 string text = layout->latexname().substr(0, 3);
2322 if (layout->latexname() == "theorem")
2323 text = "thm"; // Create a correct prefix for prettyref
2326 if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
2329 string par_text = pars_[pit].asString(cur.buffer(), false);
2330 for (int i = 0; i < lyxrc.label_init_length; ++i) {
2331 if (par_text.empty())
2334 par_text = split(par_text, head, ' ');
2335 // Is it legal to use spaces in labels ?
2345 //pos_type LyXText::x2pos(pit_type pit, int row, int x) const
2349 // Paragraph const & par = pars_[pit];
2350 // Row const & r = par.rows()[row];
2351 // int pos = r.pos();
2352 // for (; currx < x && pos < r.endpos(); ++pos) {
2354 // currx += singleWidth(par, pos);
2356 // if (abs(lastx - x) < abs(currx - x) && pos != r.pos())
2362 pos_type LyXText::x2pos(pit_type pit, int row, int x) const
2364 BOOST_ASSERT(row < int(pars_[pit].rows().size()));
2366 Row const & r = pars_[pit].rows()[row];
2367 return r.pos() + getColumnNearX(pit, r, x, bound);
2371 //int LyXText::pos2x(pit_type pit, pos_type pos) const
2373 // Paragraph const & par = pars_[pit];
2374 // Row const & r = par.rows()[row];
2380 // x,y are screen coordinates
2381 // sets cursor only within this LyXText
2382 bool LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
2384 pit_type pit = getPitNearY(y);
2385 int yy = theCoords.get(this, pit).y_ - pars_[pit].ascent();
2386 lyxerr[Debug::DEBUG]
2387 << BOOST_CURRENT_FUNCTION
2391 << " yy: " << yy << endl;
2393 Paragraph const & par = pars_[pit];
2395 BOOST_ASSERT(par.rows().size());
2396 for (; r < int(par.rows().size()) - 1; ++r) {
2397 Row const & row = par.rows()[r];
2398 if (int(yy + row.height()) > y)
2403 Row const & row = par.rows()[r];
2405 lyxerr[Debug::DEBUG]
2406 << BOOST_CURRENT_FUNCTION
2408 << " from pos: " << row.pos()
2413 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
2415 lyxerr[Debug::DEBUG]
2416 << BOOST_CURRENT_FUNCTION
2417 << ": setting cursor pit: " << pit
2421 return setCursor(cur, pit, pos, true, bound);