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
9 * \author Angus Leeming
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
20 #include "Paragraph.h"
23 #include "BufferParams.h"
29 #include "InsetList.h"
31 #include "LaTeXFeatures.h"
39 #include "OutputParams.h"
40 #include "output_latex.h"
41 #include "paragraph_funcs.h"
42 #include "ParagraphParameters.h"
47 #include "frontends/alert.h"
48 #include "frontends/FontMetrics.h"
50 #include "insets/InsetBibitem.h"
51 #include "insets/InsetLabel.h"
52 #include "insets/InsetOptArg.h"
54 #include "support/lstrings.h"
55 #include "support/textutils.h"
56 #include "support/convert.h"
57 #include "support/unicode.h"
68 using support::contains;
69 using support::prefixIs;
70 using support::suffixIs;
71 using support::rsplit;
75 /// Inset identifier (above 0x10ffff, for ucs-4)
76 char_type const META_INSET = 0x200001;
79 /////////////////////////////////////////////////////////////////////
83 /////////////////////////////////////////////////////////////////////
85 class Paragraph::Private
89 Private(Paragraph * owner);
90 /// "Copy constructor"
91 Private(Private const &, Paragraph * owner);
94 void insertChar(pos_type pos, char_type c, Change const & change);
96 /// Output the surrogate pair formed by \p c and \p next to \p os.
97 /// \return the number of characters written.
98 int latexSurrogatePair(odocstream & os, char_type c, char_type next,
101 /// Output a space in appropriate formatting (or a surrogate pair
102 /// if the next character is a combining character).
103 /// \return whether a surrogate pair was output.
104 bool simpleTeXBlanks(Encoding const &,
105 odocstream &, TexRow & texrow,
107 unsigned int & column,
109 Layout const & style);
111 /// Output consecutive known unicode chars, belonging to the same
112 /// language as specified by \p preamble, to \p os starting from \p c.
113 /// \return the number of characters written.
114 int knownLangChars(odocstream & os, char_type c, string & preamble,
115 Change &, Encoding const &, pos_type &);
117 /// This could go to ParagraphParameters if we want to.
118 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
121 /// This could go to ParagraphParameters if we want to.
122 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
126 void latexInset(Buffer const &, BufferParams const &,
128 TexRow & texrow, OutputParams &,
131 Font const & outerfont,
133 Change & running_change,
134 Layout const & style,
136 unsigned int & column);
139 void latexSpecialChar(
141 OutputParams & runparams,
143 Change & running_change,
144 Layout const & style,
146 unsigned int & column);
153 unsigned int & column);
155 bool latexSpecialTypewriter(
159 unsigned int & column);
161 bool latexSpecialPhrase(
164 unsigned int & column);
167 void validate(LaTeXFeatures & features,
168 Layout const & layout) const;
171 pos_type size() const { return owner_->size(); }
173 /// match a string against a particular point in the paragraph
174 bool isTextAt(std::string const & str, pos_type pos) const;
176 /// Which Paragraph owns us?
180 Inset * inset_owner_;
188 static unsigned int paragraph_id;
190 ParagraphParameters params_;
192 /// for recording and looking up changes
196 InsetList insetlist_;
202 pos_type begin_of_body_;
204 typedef std::vector<char_type> TextContainer;
213 using std::upper_bound;
214 using std::lower_bound;
218 // Initialization of the counter for the paragraph id's,
219 unsigned int Paragraph::Private::paragraph_id = 0;
223 struct special_phrase {
229 special_phrase const special_phrases[] = {
230 { "LyX", from_ascii("\\protect\\LyX{}"), false },
231 { "TeX", from_ascii("\\protect\\TeX{}"), true },
232 { "LaTeX2e", from_ascii("\\protect\\LaTeXe{}"), true },
233 { "LaTeX", from_ascii("\\protect\\LaTeX{}"), true },
236 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
241 Paragraph::Private::Private(Paragraph * owner)
242 : owner_(owner), inset_owner_(0), begin_of_body_(0)
244 id_ = paragraph_id++;
249 Paragraph::Private::Private(Private const & p, Paragraph * owner)
250 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
251 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
252 layout_(p.layout_), begin_of_body_(p.begin_of_body_), text_(p.text_)
254 id_ = paragraph_id++;
258 bool Paragraph::isChanged(pos_type start, pos_type end) const
260 BOOST_ASSERT(start >= 0 && start <= size());
261 BOOST_ASSERT(end > start && end <= size() + 1);
263 return d->changes_.isChanged(start, end);
267 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const {
268 // keep the logic here in sync with the logic of eraseChars()
274 Change change = d->changes_.lookup(size());
276 return change.type == Change::INSERTED && change.author == 0;
280 void Paragraph::setChange(Change const & change)
282 // beware of the imaginary end-of-par character!
283 d->changes_.set(change, 0, size() + 1);
286 * Propagate the change recursively - but not in case of DELETED!
288 * Imagine that your co-author makes changes in an existing inset. He
289 * sends your document to you and you come to the conclusion that the
290 * inset should go completely. If you erase it, LyX must not delete all
291 * text within the inset. Otherwise, the change tracked insertions of
292 * your co-author get lost and there is no way to restore them later.
294 * Conclusion: An inset's content should remain untouched if you delete it
297 if (change.type != Change::DELETED) {
298 for (pos_type pos = 0; pos < size(); ++pos) {
300 getInset(pos)->setChange(change);
306 void Paragraph::setChange(pos_type pos, Change const & change)
308 BOOST_ASSERT(pos >= 0 && pos <= size());
310 d->changes_.set(change, pos);
312 // see comment in setChange(Change const &) above
314 if (change.type != Change::DELETED &&
315 pos < size() && isInset(pos)) {
316 getInset(pos)->setChange(change);
321 Change const & Paragraph::lookupChange(pos_type pos) const
323 BOOST_ASSERT(pos >= 0 && pos <= size());
325 return d->changes_.lookup(pos);
329 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start,
332 BOOST_ASSERT(start >= 0 && start <= size());
333 BOOST_ASSERT(end > start && end <= size() + 1);
335 for (pos_type pos = start; pos < end; ++pos) {
336 switch (lookupChange(pos).type) {
337 case Change::UNCHANGED:
338 // accept changes in nested inset
339 if (pos < size() && isInset(pos))
340 getInset(pos)->acceptChanges(bparams);
344 case Change::INSERTED:
345 d->changes_.set(Change(Change::UNCHANGED), pos);
346 // also accept changes in nested inset
347 if (pos < size() && isInset(pos)) {
348 getInset(pos)->acceptChanges(bparams);
352 case Change::DELETED:
353 // Suppress access to non-existent
354 // "end-of-paragraph char"
356 eraseChar(pos, false);
367 void Paragraph::rejectChanges(BufferParams const & bparams,
368 pos_type start, pos_type end)
370 BOOST_ASSERT(start >= 0 && start <= size());
371 BOOST_ASSERT(end > start && end <= size() + 1);
373 for (pos_type pos = start; pos < end; ++pos) {
374 switch (lookupChange(pos).type) {
375 case Change::UNCHANGED:
376 // reject changes in nested inset
377 if (pos < size() && isInset(pos)) {
378 getInset(pos)->rejectChanges(bparams);
382 case Change::INSERTED:
383 // Suppress access to non-existent
384 // "end-of-paragraph char"
386 eraseChar(pos, false);
392 case Change::DELETED:
393 d->changes_.set(Change(Change::UNCHANGED), pos);
395 // Do NOT reject changes within a deleted inset!
396 // There may be insertions of a co-author inside of it!
404 void Paragraph::Private::insertChar(pos_type pos, char_type c,
405 Change const & change)
407 BOOST_ASSERT(pos >= 0 && pos <= size());
410 changes_.insert(change, pos);
412 // This is actually very common when parsing buffers (and
413 // maybe inserting ascii text)
415 // when appending characters, no need to update tables
420 text_.insert(text_.begin() + pos, c);
422 // Update the font table.
423 fontlist_.increasePosAfterPos(pos);
426 insetlist_.increasePosAfterPos(pos);
430 void Paragraph::insertInset(pos_type pos, Inset * inset,
431 Change const & change)
434 BOOST_ASSERT(pos >= 0 && pos <= size());
436 d->insertChar(pos, META_INSET, change);
437 BOOST_ASSERT(d->text_[pos] == META_INSET);
439 // Add a new entry in the insetlist_.
440 d->insetlist_.insert(inset, pos);
444 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
446 BOOST_ASSERT(pos >= 0 && pos <= size());
448 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
451 Change change = d->changes_.lookup(pos);
453 // set the character to DELETED if
454 // a) it was previously unchanged or
455 // b) it was inserted by a co-author
457 if (change.type == Change::UNCHANGED ||
458 (change.type == Change::INSERTED && change.author != 0)) {
459 setChange(pos, Change(Change::DELETED));
463 if (change.type == Change::DELETED)
467 // Don't physically access the imaginary end-of-paragraph character.
468 // eraseChar() can only mark it as DELETED. A physical deletion of
469 // end-of-par must be handled externally.
475 d->changes_.erase(pos);
477 // if it is an inset, delete the inset entry
478 if (d->text_[pos] == META_INSET)
479 d->insetlist_.erase(pos);
481 d->text_.erase(d->text_.begin() + pos);
483 // Update the fontlist_
484 d->fontlist_.erase(pos);
486 // Update the insetlist_
487 d->insetlist_.decreasePosAfterPos(pos);
493 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
495 BOOST_ASSERT(start >= 0 && start <= size());
496 BOOST_ASSERT(end >= start && end <= size() + 1);
499 for (pos_type count = end - start; count; --count) {
500 if (!eraseChar(i, trackChanges))
507 int Paragraph::Private::latexSurrogatePair(odocstream & os, char_type c,
508 char_type next, Encoding const & encoding)
510 // Writing next here may circumvent a possible font change between
511 // c and next. Since next is only output if it forms a surrogate pair
512 // with c we can ignore this:
513 // A font change inside a surrogate pair does not make sense and is
514 // hopefully impossible to input.
515 // FIXME: change tracking
516 // Is this correct WRT change tracking?
517 docstring const latex1 = encoding.latexChar(next);
518 docstring const latex2 = encoding.latexChar(c);
519 os << latex1 << '{' << latex2 << '}';
520 return latex1.length() + latex2.length() + 2;
524 bool Paragraph::Private::simpleTeXBlanks(Encoding const & encoding,
525 odocstream & os, TexRow & texrow,
527 unsigned int & column,
529 Layout const & style)
534 if (i + 1 < size()) {
535 char_type next = text_[i + 1];
536 if (Encodings::isCombiningChar(next)) {
537 // This space has an accent, so we must always output it.
538 column += latexSurrogatePair(os, ' ', next, encoding) - 1;
543 if (lyxrc.plaintext_linelen > 0
544 && column > lyxrc.plaintext_linelen
546 && text_[i - 1] != ' '
548 // same in FreeSpacing mode
549 && !owner_->isFreeSpacing()
550 // In typewriter mode, we want to avoid
551 // ! . ? : at the end of a line
552 && !(font.family() == Font::TYPEWRITER_FAMILY
553 && (text_[i - 1] == '.'
554 || text_[i - 1] == '?'
555 || text_[i - 1] == ':'
556 || text_[i - 1] == '!'))) {
559 texrow.start(owner_->id(), i + 1);
561 } else if (style.free_spacing) {
570 int Paragraph::Private::knownLangChars(odocstream & os,
573 Change & runningChange,
574 Encoding const & encoding,
577 // When the character is marked by the proper language, we simply
578 // get its code point in some encoding, otherwise we get the
579 // translation specified in the unicodesymbols file, which is
580 // something like "\textLANG{<spec>}". So, we have to retain
581 // "\textLANG{<spec>" for the first char but only "<spec>" for
582 // all subsequent chars.
583 docstring const latex1 = rtrim(encoding.latexChar(c), "}");
584 int length = latex1.length();
586 while (i + 1 < size()) {
587 char_type next = text_[i + 1];
588 // Stop here if next character belongs to another
589 // language or there is a change tracking status.
590 if (!Encodings::isKnownLangChar(next, preamble) ||
591 runningChange != owner_->lookupChange(i + 1))
595 FontList::const_iterator cit = fontlist_.begin();
596 FontList::const_iterator end = fontlist_.end();
597 for (; cit != end; ++cit) {
598 if (cit->pos() >= i && !found) {
599 prev_font = cit->font();
602 if (cit->pos() >= i + 1)
605 // Stop here if there is a font attribute change.
606 if (found && cit != end && prev_font != cit->font())
608 docstring const latex = rtrim(encoding.latexChar(next), "}");
609 docstring::size_type const j =
610 latex.find_first_of(from_ascii("{"));
611 if (j == docstring::npos) {
613 length += latex.length();
615 os << latex.substr(j + 1);
616 length += latex.substr(j + 1).length();
620 // When the proper language is set, we are simply passed a code
621 // point, so we should not try to close the \textLANG command.
622 if (prefixIs(latex1, from_ascii("\\" + preamble))) {
630 bool Paragraph::Private::isTextAt(string const & str, pos_type pos) const
632 pos_type const len = str.length();
634 // is the paragraph large enough?
635 if (pos + len > size())
638 // does the wanted text start at point?
639 for (string::size_type i = 0; i < str.length(); ++i) {
640 // Caution: direct comparison of characters works only
641 // because str is pure ASCII.
642 if (str[i] != text_[pos + i])
646 return fontlist_.hasChangeInRange(pos, len);
650 void Paragraph::Private::latexInset(Buffer const & buf,
651 BufferParams const & bparams,
654 OutputParams & runparams,
657 Font const & outerfont,
659 Change & running_change,
660 Layout const & style,
662 unsigned int & column)
664 Inset * inset = owner_->getInset(i);
667 if (style.pass_thru) {
668 inset->plaintext(buf, os, runparams);
672 // FIXME: move this to InsetNewline::latex
673 if (inset->lyxCode() == NEWLINE_CODE) {
674 // newlines are handled differently here than
675 // the default in simpleTeXSpecialChars().
676 if (!style.newline_allowed) {
680 column += running_font.latexWriteEndChanges(
681 os, bparams, runparams,
686 if (running_font.family() == Font::TYPEWRITER_FAMILY)
689 basefont = owner_->getLayoutFont(bparams, outerfont);
690 running_font = basefont;
692 if (runparams.moving_arg)
698 texrow.start(owner_->id(), i + 1);
702 if (owner_->lookupChange(i).type == Change::DELETED) {
703 if( ++runparams.inDeletedInset == 1)
704 runparams.changeOfDeletedInset = owner_->lookupChange(i);
707 if (inset->canTrackChanges()) {
708 column += Changes::latexMarkChange(os, bparams, running_change,
709 Change(Change::UNCHANGED));
710 running_change = Change(Change::UNCHANGED);
714 odocstream::pos_type const len = os.tellp();
716 if ((inset->lyxCode() == GRAPHICS_CODE
717 || inset->lyxCode() == MATH_CODE
718 || inset->lyxCode() == HYPERLINK_CODE)
719 && running_font.isRightToLeft()) {
720 if (running_font.language()->lang() == "farsi")
727 // FIXME: Bug: we can have an empty font change here!
728 // if there has just been a font change, we are going to close it
729 // right now, which means stupid latex code like \textsf{}. AFAIK,
730 // this does not harm dvi output. A minor bug, thus (JMarc)
732 // Some insets cannot be inside a font change command.
733 // However, even such insets *can* be placed in \L or \R
734 // or their equivalents (for RTL language switches), so we don't
735 // close the language in those cases.
736 // ArabTeX, though, cannot handle this special behavior, it seems.
737 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
738 || running_font.language()->lang() == "arabic_arabtex";
739 if (open_font && inset->noFontChange()) {
740 bool closeLanguage = arabtex
741 || basefont.isRightToLeft() == running_font.isRightToLeft();
742 unsigned int count = running_font.latexWriteEndChanges(os,
743 bparams, runparams, basefont, basefont, closeLanguage);
745 // if any font properties were closed, update the running_font,
746 // making sure, however, to leave the language as it was
748 // FIXME: probably a better way to keep track of the old
749 // language, than copying the entire font?
750 Font const copy_font(running_font);
751 basefont = owner_->getLayoutFont(bparams, outerfont);
752 running_font = basefont;
754 running_font.setLanguage(copy_font.language());
755 // leave font open if language is still open
756 open_font = (running_font.language() == basefont.language());
758 runparams.local_font = &basefont;
762 int tmp = inset->latex(buf, os, runparams);
765 if (running_font.language()->lang() == "farsi")
772 for (int j = 0; j < tmp; ++j)
775 texrow.start(owner_->id(), i + 1);
778 column += os.tellp() - len;
781 if (owner_->lookupChange(i).type == Change::DELETED)
782 --runparams.inDeletedInset;
786 void Paragraph::Private::latexSpecialChar(
788 OutputParams & runparams,
790 Change & running_change,
791 Layout const & style,
793 unsigned int & column)
795 char_type const c = text_[i];
797 if (style.pass_thru) {
799 // FIXME UNICODE: This can fail if c cannot
800 // be encoded in the current encoding.
805 if (runparams.verbatim) {
810 if (lyxrc.fontenc == "T1" && latexSpecialT1(c, os, i, column))
813 if (running_font.family() == Font::TYPEWRITER_FAMILY
814 && latexSpecialTypewriter(c, os, i, column))
817 // Otherwise, we use what LaTeX provides us.
820 os << "\\textbackslash{}";
824 os << "\\textless{}";
828 os << "\\textgreater{}";
839 os << "\\char`\\\"{}";
844 case '%': case '#': case '{':
852 os << "\\textasciitilde{}";
857 os << "\\textasciicircum{}";
862 // avoid being mistaken for optional arguments
870 // Blanks are printed before font switching.
871 // Sure? I am not! (try nice-latex)
872 // I am sure it's correct. LyX might be smarter
873 // in the future, but for now, nothing wrong is
880 if (latexSpecialPhrase(os, i, column))
886 Encoding const & encoding = *(runparams.encoding);
887 if (i + 1 < size()) {
888 char_type next = text_[i + 1];
889 if (Encodings::isCombiningChar(next)) {
890 column += latexSurrogatePair(os, c, next, encoding) - 1;
896 if (Encodings::isKnownLangChar(c, preamble)) {
897 column += knownLangChars(os, c, preamble, running_change,
901 docstring const latex = encoding.latexChar(c);
902 if (latex.length() > 1 && latex[latex.length() - 1] != '}') {
903 // Prevent eating of a following
904 // space or command corruption by
905 // following characters
906 column += latex.length() + 1;
909 column += latex.length() - 1;
917 bool Paragraph::Private::latexSpecialT1(char_type const c, odocstream & os,
918 pos_type & i, unsigned int & column)
924 // In T1 encoding, these characters exist
925 // but we should avoid ligatures
926 if (i + 1 > size() || text_[i + 1] != c)
931 //os << "\\textcompwordmark{}";
943 bool Paragraph::Private::latexSpecialTypewriter(char_type const c, odocstream & os,
944 pos_type & i, unsigned int & column)
948 if (i + 1 < size() && text_[i + 1] == '-') {
949 // "--" in Typewriter mode -> "-{}-"
956 // I assume this is hack treating typewriter as verbatim
957 // FIXME UNICODE: This can fail if c cannot be encoded
958 // in the current encoding.
963 // Those characters are not directly supported.
967 case '%': case '#': case '{':
976 // With Typewriter font, these characters exist.
983 bool Paragraph::Private::latexSpecialPhrase(odocstream & os, pos_type & i,
984 unsigned int & column)
986 // FIXME: if we have "LaTeX" with a font
987 // change in the middle (before the 'T', then
988 // the "TeX" part is still special cased.
989 // Really we should only operate this on
990 // "words" for some definition of word
992 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
993 if (!isTextAt(special_phrases[pnr].phrase, i))
995 os << special_phrases[pnr].macro;
996 i += special_phrases[pnr].phrase.length() - 1;
997 column += special_phrases[pnr].macro.length() - 1;
1004 void Paragraph::Private::validate(LaTeXFeatures & features,
1005 Layout const & layout) const
1007 // check the params.
1008 if (!params_.spacing().isDefault())
1009 features.require("setspace");
1012 features.useLayout(layout.name());
1015 fontlist_.validate(features);
1017 // then the indentation
1018 if (!params_.leftIndent().zero())
1019 features.require("ParagraphLeftIndent");
1022 InsetList::const_iterator icit = insetlist_.begin();
1023 InsetList::const_iterator iend = insetlist_.end();
1024 for (; icit != iend; ++icit) {
1026 icit->inset->validate(features);
1027 if (layout.needprotect &&
1028 icit->inset->lyxCode() == FOOT_CODE)
1029 features.require("NeedLyXFootnoteCode");
1033 // then the contents
1034 for (pos_type i = 0; i < size() ; ++i) {
1035 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1036 if (!special_phrases[pnr].builtin
1037 && isTextAt(special_phrases[pnr].phrase, i)) {
1038 features.require(special_phrases[pnr].phrase);
1042 Encodings::validate(text_[i], features);
1046 /////////////////////////////////////////////////////////////////////
1050 /////////////////////////////////////////////////////////////////////
1052 Paragraph::Paragraph()
1053 : d(new Paragraph::Private(this))
1060 Paragraph::Paragraph(Paragraph const & par)
1061 : itemdepth(par.itemdepth),
1062 d(new Paragraph::Private(*par.d, this))
1067 Paragraph & Paragraph::operator=(Paragraph const & par)
1069 // needed as we will destroy the private part before copying it
1071 itemdepth = par.itemdepth;
1074 d = new Private(*par.d, this);
1080 Paragraph::~Paragraph()
1086 void Paragraph::write(Buffer const & buf, ostream & os,
1087 BufferParams const & bparams,
1088 depth_type & dth) const
1090 // The beginning or end of a deeper (i.e. nested) area?
1091 if (dth != params().depth()) {
1092 if (params().depth() > dth) {
1093 while (params().depth() > dth) {
1094 os << "\n\\begin_deeper";
1098 while (params().depth() < dth) {
1099 os << "\n\\end_deeper";
1105 // First write the layout
1106 os << "\n\\begin_layout " << to_utf8(layout()->name()) << '\n';
1110 Font font1(Font::ALL_INHERIT, bparams.language);
1112 Change running_change = Change(Change::UNCHANGED);
1115 for (pos_type i = 0; i <= size(); ++i) {
1117 Change change = lookupChange(i);
1118 Changes::lyxMarkChange(os, column, running_change, change);
1119 running_change = change;
1124 // Write font changes
1125 Font font2 = getFontSettings(bparams, i);
1126 if (font2 != font1) {
1127 font2.lyxWriteChanges(font1, os);
1132 char_type const c = d->text_[i];
1136 Inset const * inset = getInset(i);
1138 if (inset->directWrite()) {
1139 // international char, let it write
1140 // code directly so it's shorter in
1142 inset->write(buf, os);
1146 os << "\\begin_inset ";
1147 inset->write(buf, os);
1148 os << "\n\\end_inset\n\n";
1154 os << "\n\\backslash\n";
1158 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1165 if ((column > 70 && c == ' ')
1170 // this check is to amend a bug. LyX sometimes
1171 // inserts '\0' this could cause problems.
1173 std::vector<char> tmp = ucs4_to_utf8(c);
1174 tmp.push_back('\0');
1177 lyxerr << "ERROR (Paragraph::writeFile):"
1178 " NULL char in structure." << endl;
1184 os << "\n\\end_layout\n";
1188 void Paragraph::validate(LaTeXFeatures & features) const
1190 d->validate(features, *layout());
1194 void Paragraph::insert(pos_type start, docstring const & str,
1195 Font const & font, Change const & change)
1197 for (size_t i = 0, n = str.size(); i != n ; ++i)
1198 insertChar(start + i, str[i], font, change);
1202 void Paragraph::appendChar(char_type c, Font const & font,
1203 Change const & change)
1206 d->changes_.insert(change, d->text_.size());
1207 // when appending characters, no need to update tables
1208 d->text_.push_back(c);
1209 setFont(d->text_.size() - 1, font);
1213 void Paragraph::appendString(docstring const & s, Font const & font,
1214 Change const & change)
1216 size_t end = s.size();
1217 size_t oldsize = d->text_.size();
1218 size_t newsize = oldsize + end;
1219 size_t capacity = d->text_.capacity();
1220 if (newsize >= capacity)
1221 d->text_.reserve(std::max(capacity + 100, newsize));
1223 // FIXME: Optimize this!
1224 for (pos_type i = 0; i != end; ++i) {
1226 d->changes_.insert(change, i);
1227 // when appending characters, no need to update tables
1228 d->text_.push_back(s[i]);
1230 d->fontlist_.setRange(oldsize, newsize, font);
1234 void Paragraph::insertChar(pos_type pos, char_type c,
1237 d->insertChar(pos, c, Change(trackChanges ?
1238 Change::INSERTED : Change::UNCHANGED));
1242 void Paragraph::insertChar(pos_type pos, char_type c,
1243 Font const & font, bool trackChanges)
1245 d->insertChar(pos, c, Change(trackChanges ?
1246 Change::INSERTED : Change::UNCHANGED));
1251 void Paragraph::insertChar(pos_type pos, char_type c,
1252 Font const & font, Change const & change)
1254 d->insertChar(pos, c, change);
1259 void Paragraph::insertInset(pos_type pos, Inset * inset,
1260 Font const & font, Change const & change)
1262 insertInset(pos, inset, change);
1263 // Set the font/language of the inset...
1268 bool Paragraph::insetAllowed(InsetCode code)
1270 return !d->inset_owner_ || d->inset_owner_->insetAllowed(code);
1274 // Gets uninstantiated font setting at position.
1275 Font const Paragraph::getFontSettings(BufferParams const & bparams,
1279 lyxerr << " pos: " << pos << " size: " << size() << endl;
1280 BOOST_ASSERT(pos <= size());
1283 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1284 if (cit != d->fontlist_.end())
1287 if (pos == size() && !empty())
1288 return getFontSettings(bparams, pos - 1);
1290 return Font(Font::ALL_INHERIT, getParLanguage(bparams));
1294 FontSpan Paragraph::fontSpan(pos_type pos) const
1296 BOOST_ASSERT(pos <= size());
1299 FontList::const_iterator cit = d->fontlist_.begin();
1300 FontList::const_iterator end = d->fontlist_.end();
1301 for (; cit != end; ++cit) {
1302 if (cit->pos() >= pos) {
1303 if (pos >= beginOfBody())
1304 return FontSpan(std::max(start, beginOfBody()),
1307 return FontSpan(start,
1308 std::min(beginOfBody() - 1,
1311 start = cit->pos() + 1;
1314 // This should not happen, but if so, we take no chances.
1315 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
1317 return FontSpan(pos, pos);
1321 // Gets uninstantiated font setting at position 0
1322 Font const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1324 if (!empty() && !d->fontlist_.empty())
1325 return d->fontlist_.begin()->font();
1327 return Font(Font::ALL_INHERIT, bparams.language);
1331 // Gets the fully instantiated font at a given position in a paragraph
1332 // This is basically the same function as Text::GetFont() in text2.cpp.
1333 // The difference is that this one is used for generating the LaTeX file,
1334 // and thus cosmetic "improvements" are disallowed: This has to deliver
1335 // the true picture of the buffer. (Asger)
1336 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1337 Font const & outerfont) const
1339 BOOST_ASSERT(pos >= 0);
1341 Font font = getFontSettings(bparams, pos);
1343 pos_type const body_pos = beginOfBody();
1345 font.realize(d->layout_->labelfont);
1347 font.realize(d->layout_->font);
1349 font.realize(outerfont);
1350 font.realize(bparams.getFont());
1356 Font const Paragraph::getLabelFont
1357 (BufferParams const & bparams, Font const & outerfont) const
1359 Font tmpfont = layout()->labelfont;
1360 tmpfont.setLanguage(getParLanguage(bparams));
1361 tmpfont.realize(outerfont);
1362 tmpfont.realize(bparams.getFont());
1367 Font const Paragraph::getLayoutFont
1368 (BufferParams const & bparams, Font const & outerfont) const
1370 Font tmpfont = layout()->font;
1371 tmpfont.setLanguage(getParLanguage(bparams));
1372 tmpfont.realize(outerfont);
1373 tmpfont.realize(bparams.getFont());
1378 /// Returns the height of the highest font in range
1379 Font_size Paragraph::highestFontInRange
1380 (pos_type startpos, pos_type endpos, Font_size def_size) const
1382 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1387 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1389 char_type c = d->text_[pos];
1390 if (!lyxrc.rtl_support)
1420 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1427 void Paragraph::setFont(pos_type pos, Font const & font)
1429 BOOST_ASSERT(pos <= size());
1431 // First, reduce font against layout/label font
1432 // Update: The setCharFont() routine in text2.cpp already
1433 // reduces font, so we don't need to do that here. (Asger)
1435 d->fontlist_.set(pos, font);
1439 void Paragraph::makeSameLayout(Paragraph const & par)
1441 layout(par.layout());
1443 d->params_ = par.params();
1447 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1449 if (isFreeSpacing())
1455 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1456 if (eraseChar(pos, trackChanges))
1462 return count > 0 || pos > 0;
1466 bool Paragraph::hasSameLayout(Paragraph const & par) const
1468 return par.layout() == layout() && d->params_.sameLayout(par.params());
1472 depth_type Paragraph::getDepth() const
1474 return params().depth();
1478 depth_type Paragraph::getMaxDepthAfter() const
1480 if (layout()->isEnvironment())
1481 return params().depth() + 1;
1483 return params().depth();
1487 char Paragraph::getAlign() const
1489 if (params().align() == LYX_ALIGN_LAYOUT)
1490 return layout()->align;
1492 return params().align();
1496 docstring const & Paragraph::getLabelstring() const
1498 return params().labelString();
1502 // the next two functions are for the manual labels
1503 docstring const Paragraph::getLabelWidthString() const
1505 if (layout()->margintype == MARGIN_MANUAL)
1506 return params().labelWidthString();
1508 return _("Senseless with this layout!");
1512 void Paragraph::setLabelWidthString(docstring const & s)
1514 params().labelWidthString(s);
1518 docstring const Paragraph::translateIfPossible(docstring const & s,
1519 BufferParams const & bparams) const
1521 if (!support::isAscii(s) || s.empty()) {
1522 // This must be a user defined layout. We cannot translate
1523 // this, since gettext accepts only ascii keys.
1526 // Probably standard layout, try to translate
1527 Messages & m = getMessages(getParLanguage(bparams)->code());
1528 return m.get(to_ascii(s));
1532 docstring Paragraph::expandLabel(LayoutPtr const & layout,
1533 BufferParams const & bparams, bool process_appendix) const
1535 TextClass const & tclass = bparams.getTextClass();
1538 if (process_appendix && params().appendix())
1539 fmt = translateIfPossible(layout->labelstring_appendix(),
1542 fmt = translateIfPossible(layout->labelstring(), bparams);
1544 if (fmt.empty() && layout->labeltype == LABEL_COUNTER
1545 && !layout->counter.empty())
1546 fmt = "\\the" + layout->counter;
1548 // handle 'inherited level parts' in 'fmt',
1549 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
1550 size_t const i = fmt.find('@', 0);
1551 if (i != docstring::npos) {
1552 size_t const j = fmt.find('@', i + 1);
1553 if (j != docstring::npos) {
1554 docstring parent(fmt, i + 1, j - i - 1);
1555 docstring label = from_ascii("??");
1556 if (tclass.hasLayout(parent))
1557 docstring label = expandLabel(tclass[parent], bparams,
1559 fmt = docstring(fmt, 0, i) + label
1560 + docstring(fmt, j + 1, docstring::npos);
1564 return tclass.counters().counterLabel(fmt);
1568 void Paragraph::applyLayout(LayoutPtr const & new_layout)
1571 LyXAlignment const oldAlign = params().align();
1573 if (!(oldAlign & layout()->alignpossible)) {
1574 frontend::Alert::warning(_("Alignment not permitted"),
1575 _("The new layout does not permit the alignment previously used.\nSetting to default."));
1576 params().align(LYX_ALIGN_LAYOUT);
1581 pos_type Paragraph::beginOfBody() const
1583 return d->begin_of_body_;
1587 void Paragraph::setBeginOfBody()
1589 if (layout()->labeltype != LABEL_MANUAL) {
1590 d->begin_of_body_ = 0;
1594 // Unroll the first two cycles of the loop
1595 // and remember the previous character to
1596 // remove unnecessary getChar() calls
1598 pos_type end = size();
1599 if (i < end && !isNewline(i)) {
1601 char_type previous_char = 0;
1604 previous_char = d->text_[i];
1605 if (!isNewline(i)) {
1607 while (i < end && previous_char != ' ') {
1612 previous_char = temp;
1618 d->begin_of_body_ = i;
1622 InsetBibitem * Paragraph::bibitem() const
1624 if (!d->insetlist_.empty()) {
1625 Inset * inset = d->insetlist_.begin()->inset;
1626 if (inset->lyxCode() == BIBITEM_CODE)
1627 return static_cast<InsetBibitem *>(inset);
1633 bool Paragraph::forceDefaultParagraphs() const
1635 return inInset() && inInset()->forceDefaultParagraphs(0);
1641 // paragraphs inside floats need different alignment tags to avoid
1644 bool noTrivlistCentering(InsetCode code)
1646 return code == FLOAT_CODE || code == WRAP_CODE;
1650 string correction(string const & orig)
1652 if (orig == "flushleft")
1653 return "raggedright";
1654 if (orig == "flushright")
1655 return "raggedleft";
1656 if (orig == "center")
1662 string const corrected_env(string const & suffix, string const & env,
1665 string output = suffix + "{";
1666 if (noTrivlistCentering(code))
1667 output += correction(env);
1671 if (suffix == "\\begin")
1677 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1679 if (!contains(str, "\n"))
1680 column += str.size();
1684 column = rsplit(str, tmp, '\n').size();
1691 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
1692 odocstream & os, TexRow & texrow,
1693 bool moving_arg) const
1697 if (params_.noindent()) {
1698 os << "\\noindent ";
1702 LyXAlignment const curAlign = params_.align();
1704 if (curAlign == layout_->align)
1708 case LYX_ALIGN_NONE:
1709 case LYX_ALIGN_BLOCK:
1710 case LYX_ALIGN_LAYOUT:
1711 case LYX_ALIGN_SPECIAL:
1713 case LYX_ALIGN_LEFT:
1714 case LYX_ALIGN_RIGHT:
1715 case LYX_ALIGN_CENTER:
1724 case LYX_ALIGN_NONE:
1725 case LYX_ALIGN_BLOCK:
1726 case LYX_ALIGN_LAYOUT:
1727 case LYX_ALIGN_SPECIAL:
1729 case LYX_ALIGN_LEFT: {
1731 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1732 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1734 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1735 os << from_ascii(output);
1736 adjust_row_column(output, texrow, column);
1738 } case LYX_ALIGN_RIGHT: {
1740 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1741 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1743 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1744 os << from_ascii(output);
1745 adjust_row_column(output, texrow, column);
1747 } case LYX_ALIGN_CENTER: {
1749 output = corrected_env("\\begin", "center", owner_->ownerCode());
1750 os << from_ascii(output);
1751 adjust_row_column(output, texrow, column);
1760 int Paragraph::Private::endTeXParParams(BufferParams const & bparams,
1761 odocstream & os, TexRow & texrow,
1762 bool moving_arg) const
1766 switch (params_.align()) {
1767 case LYX_ALIGN_NONE:
1768 case LYX_ALIGN_BLOCK:
1769 case LYX_ALIGN_LAYOUT:
1770 case LYX_ALIGN_SPECIAL:
1772 case LYX_ALIGN_LEFT:
1773 case LYX_ALIGN_RIGHT:
1774 case LYX_ALIGN_CENTER:
1782 switch (params_.align()) {
1783 case LYX_ALIGN_NONE:
1784 case LYX_ALIGN_BLOCK:
1785 case LYX_ALIGN_LAYOUT:
1786 case LYX_ALIGN_SPECIAL:
1788 case LYX_ALIGN_LEFT: {
1790 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1791 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1793 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1794 os << from_ascii(output);
1795 adjust_row_column(output, texrow, column);
1797 } case LYX_ALIGN_RIGHT: {
1799 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1800 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1802 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1803 os << from_ascii(output);
1804 adjust_row_column(output, texrow, column);
1806 } case LYX_ALIGN_CENTER: {
1808 output = corrected_env("\n\\par\\end", "center", owner_->ownerCode());
1809 os << from_ascii(output);
1810 adjust_row_column(output, texrow, column);
1819 // This one spits out the text of the paragraph
1820 bool Paragraph::latex(Buffer const & buf,
1821 BufferParams const & bparams,
1822 Font const & outerfont,
1823 odocstream & os, TexRow & texrow,
1824 OutputParams const & runparams) const
1826 LYXERR(Debug::LATEX) << "SimpleTeXOnePar... " << this << endl;
1828 bool return_value = false;
1832 // well we have to check if we are in an inset with unlimited
1833 // length (all in one row) if that is true then we don't allow
1834 // any special options in the paragraph and also we don't allow
1835 // any environment other than the default layout of the text class
1837 bool asdefault = forceDefaultParagraphs();
1840 style = bparams.getTextClass().defaultLayout();
1845 // Current base font for all inherited font changes, without any
1846 // change caused by an individual character, except for the language:
1847 // It is set to the language of the first character.
1848 // As long as we are in the label, this font is the base font of the
1849 // label. Before the first body character it is set to the base font
1853 // Maybe we have to create a optional argument.
1854 pos_type body_pos = beginOfBody();
1855 unsigned int column = 0;
1858 // the optional argument is kept in curly brackets in
1859 // case it contains a ']'
1862 basefont = getLabelFont(bparams, outerfont);
1864 basefont = getLayoutFont(bparams, outerfont);
1867 // Which font is currently active?
1868 Font running_font(basefont);
1869 // Do we have an open font change?
1870 bool open_font = false;
1872 Change runningChange = Change(Change::UNCHANGED);
1874 texrow.start(id(), 0);
1876 // if the paragraph is empty, the loop will not be entered at all
1878 if (style->isCommand()) {
1883 column += d->startTeXParParams(bparams, os, texrow,
1884 runparams.moving_arg);
1887 for (pos_type i = 0; i < size(); ++i) {
1888 // First char in paragraph or after label?
1889 if (i == body_pos) {
1892 column += running_font.latexWriteEndChanges(
1893 os, bparams, runparams,
1894 basefont, basefont);
1897 basefont = getLayoutFont(bparams, outerfont);
1898 running_font = basefont;
1900 column += Changes::latexMarkChange(os, bparams,
1901 runningChange, Change(Change::UNCHANGED));
1902 runningChange = Change(Change::UNCHANGED);
1907 if (style->isCommand()) {
1913 column += d->startTeXParParams(bparams, os,
1915 runparams.moving_arg);
1918 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
1921 if (bparams.outputChanges && runningChange != change) {
1923 column += running_font.latexWriteEndChanges(
1924 os, bparams, runparams, basefont, basefont);
1927 basefont = getLayoutFont(bparams, outerfont);
1928 running_font = basefont;
1930 column += Changes::latexMarkChange(os, bparams, runningChange, change);
1931 runningChange = change;
1934 // do not output text which is marked deleted
1935 // if change tracking output is disabled
1936 if (!bparams.outputChanges && change.type == Change::DELETED) {
1942 // Fully instantiated font
1943 Font const font = getFont(bparams, i, outerfont);
1945 Font const last_font = running_font;
1947 // Do we need to close the previous font?
1949 (font != running_font ||
1950 font.language() != running_font.language()))
1952 column += running_font.latexWriteEndChanges(
1953 os, bparams, runparams, basefont,
1954 (i == body_pos-1) ? basefont : font);
1955 running_font = basefont;
1959 // Switch file encoding if necessary (and allowed)
1960 if (!runparams.verbatim &&
1961 runparams.encoding->package() == Encoding::inputenc &&
1962 font.language()->encoding()->package() == Encoding::inputenc) {
1963 std::pair<bool, int> const enc_switch = switchEncoding(os, bparams,
1964 runparams.moving_arg, *(runparams.encoding),
1965 *(font.language()->encoding()));
1966 if (enc_switch.first) {
1967 column += enc_switch.second;
1968 runparams.encoding = font.language()->encoding();
1972 char_type const c = d->text_[i];
1974 // Do we need to change font?
1975 if ((font != running_font ||
1976 font.language() != running_font.language()) &&
1979 odocstringstream ods;
1980 column += font.latexWriteStartChanges(ods, bparams,
1981 runparams, basefont,
1983 running_font = font;
1985 docstring fontchange = ods.str();
1986 // check if the fontchange ends with a trailing blank
1987 // (like "\small " (see bug 3382)
1988 if (suffixIs(fontchange, ' ') && c == ' ')
1989 os << fontchange.substr(0, fontchange.size() - 1)
1990 << from_ascii("{}");
1996 // FIXME: integrate this case in latexSpecialChar
1997 // Do not print the separation of the optional argument
1998 // if style->pass_thru is false. This works because
1999 // latexSpecialChar ignores spaces if
2000 // style->pass_thru is false.
2001 if (i != body_pos - 1) {
2002 if (d->simpleTeXBlanks(
2003 *(runparams.encoding), os, texrow,
2004 i, column, font, *style)) {
2005 // A surrogate pair was output. We
2006 // must not call latexSpecialChar
2007 // in this iteration, since it would output
2008 // the combining character again.
2015 OutputParams rp = runparams;
2016 rp.free_spacing = style->free_spacing;
2017 rp.local_font = &font;
2018 rp.intitle = style->intitle;
2020 // Two major modes: LaTeX or plain
2021 // Handle here those cases common to both modes
2022 // and then split to handle the two modes separately.
2023 if (c == META_INSET)
2024 d->latexInset(buf, bparams, os,
2025 texrow, rp, running_font,
2026 basefont, outerfont, open_font,
2027 runningChange, *style, i, column);
2029 d->latexSpecialChar(os, rp, running_font, runningChange,
2032 // Set the encoding to that returned from simpleTeXSpecialChars (see
2033 // comment for encoding member in OutputParams.h)
2034 runparams.encoding = rp.encoding;
2037 // If we have an open font definition, we have to close it
2039 #ifdef FIXED_LANGUAGE_END_DETECTION
2042 .latexWriteEndChanges(os, bparams, runparams,
2044 next_->getFont(bparams, 0, outerfont));
2046 running_font.latexWriteEndChanges(os, bparams,
2047 runparams, basefont, basefont);
2050 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2051 //FIXME: there as we start another \selectlanguage with the next paragraph if
2052 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2053 running_font.latexWriteEndChanges(os, bparams, runparams,
2054 basefont, basefont);
2058 column += Changes::latexMarkChange(os, bparams, runningChange, Change(Change::UNCHANGED));
2060 // Needed if there is an optional argument but no contents.
2061 if (body_pos > 0 && body_pos == size()) {
2063 return_value = false;
2067 column += d->endTeXParParams(bparams, os, texrow,
2068 runparams.moving_arg);
2071 LYXERR(Debug::LATEX) << "SimpleTeXOnePar...done " << this << endl;
2072 return return_value;
2089 string tag_name(PAR_TAG const & pt) {
2091 case PAR_NONE: return "!-- --";
2092 case TT: return "tt";
2093 case SF: return "sf";
2094 case BF: return "bf";
2095 case IT: return "it";
2096 case SL: return "sl";
2097 case EM: return "em";
2104 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2106 p1 = static_cast<PAR_TAG>(p1 | p2);
2111 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2113 p1 = static_cast<PAR_TAG>(p1 & ~p2);
2119 bool Paragraph::emptyTag() const
2121 for (pos_type i = 0; i < size(); ++i) {
2123 Inset const * inset = getInset(i);
2124 InsetCode lyx_code = inset->lyxCode();
2125 if (lyx_code != TOC_CODE &&
2126 lyx_code != INCLUDE_CODE &&
2127 lyx_code != GRAPHICS_CODE &&
2128 lyx_code != ERT_CODE &&
2129 lyx_code != LISTINGS_CODE &&
2130 lyx_code != FLOAT_CODE &&
2131 lyx_code != TABULAR_CODE) {
2135 char_type c = d->text_[i];
2136 if (c != ' ' && c != '\t')
2144 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
2146 for (pos_type i = 0; i < size(); ++i) {
2148 Inset const * inset = getInset(i);
2149 InsetCode lyx_code = inset->lyxCode();
2150 if (lyx_code == LABEL_CODE) {
2151 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2152 docstring const & id = il->getParam("name");
2153 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2162 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
2165 for (i = 0; i < size(); ++i) {
2167 Inset const * inset = getInset(i);
2168 inset->docbook(buf, os, runparams);
2170 char_type c = d->text_[i];
2173 os << sgml::escapeChar(c);
2180 bool Paragraph::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2184 for (pos_type i = initial; i < size(); ++i) {
2185 Font font = getFont(buf.params(), i, outerfont);
2188 if (i != initial && font != font_old)
2197 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2199 OutputParams const & runparams,
2200 Font const & outerfont,
2201 pos_type initial) const
2203 bool emph_flag = false;
2205 LayoutPtr const & style = layout();
2207 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
2209 if (style->pass_thru && !onlyText(buf, outerfont, initial))
2212 // parsing main loop
2213 for (pos_type i = initial; i < size(); ++i) {
2214 Font font = getFont(buf.params(), i, outerfont);
2216 // handle <emphasis> tag
2217 if (font_old.emph() != font.emph()) {
2218 if (font.emph() == Font::ON) {
2221 } else if (i != initial) {
2222 os << "</emphasis>";
2228 Inset const * inset = getInset(i);
2229 inset->docbook(buf, os, runparams);
2231 char_type c = d->text_[i];
2233 if (style->pass_thru)
2236 os << sgml::escapeChar(c);
2242 os << "</emphasis>";
2245 if (style->free_spacing)
2247 if (style->pass_thru && !onlyText(buf, outerfont, initial))
2252 bool Paragraph::isHfill(pos_type pos) const
2255 && getInset(pos)->lyxCode() == HFILL_CODE;
2259 bool Paragraph::isNewline(pos_type pos) const
2262 && getInset(pos)->lyxCode() == NEWLINE_CODE;
2266 bool Paragraph::isLineSeparator(pos_type pos) const
2268 char_type const c = d->text_[pos];
2269 return isLineSeparatorChar(c)
2270 || (c == META_INSET && getInset(pos) &&
2271 getInset(pos)->isLineSeparator());
2275 /// Used by the spellchecker
2276 bool Paragraph::isLetter(pos_type pos) const
2279 return getInset(pos)->isLetter();
2281 char_type const c = d->text_[pos];
2282 return isLetterChar(c) || isDigit(c);
2288 Paragraph::getParLanguage(BufferParams const & bparams) const
2291 return getFirstFontSettings(bparams).language();
2292 // FIXME: we should check the prev par as well (Lgb)
2293 return bparams.language;
2297 bool Paragraph::isRTL(BufferParams const & bparams) const
2299 return lyxrc.rtl_support
2300 && getParLanguage(bparams)->rightToLeft()
2301 && ownerCode() != ERT_CODE
2302 && ownerCode() != LISTINGS_CODE;
2306 void Paragraph::changeLanguage(BufferParams const & bparams,
2307 Language const * from, Language const * to)
2309 // change language including dummy font change at the end
2310 for (pos_type i = 0; i <= size(); ++i) {
2311 Font font = getFontSettings(bparams, i);
2312 if (font.language() == from) {
2313 font.setLanguage(to);
2320 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2322 Language const * doc_language = bparams.language;
2323 FontList::const_iterator cit = d->fontlist_.begin();
2324 FontList::const_iterator end = d->fontlist_.end();
2326 for (; cit != end; ++cit)
2327 if (cit->font().language() != ignore_language &&
2328 cit->font().language() != latex_language &&
2329 cit->font().language() != doc_language)
2335 // Convert the paragraph to a string.
2336 // Used for building the table of contents
2337 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
2339 return asString(buffer, 0, size(), label);
2343 docstring const Paragraph::asString(Buffer const & buffer,
2344 pos_type beg, pos_type end, bool label) const
2347 odocstringstream os;
2349 if (beg == 0 && label && !params().labelString().empty())
2350 os << params().labelString() << ' ';
2352 for (pos_type i = beg; i < end; ++i) {
2353 char_type const c = d->text_[i];
2356 else if (c == META_INSET)
2357 getInset(i)->textString(buffer, os);
2364 void Paragraph::setInsetOwner(Inset * inset)
2366 d->inset_owner_ = inset;
2370 int Paragraph::id() const
2376 LayoutPtr const & Paragraph::layout() const
2382 void Paragraph::layout(LayoutPtr const & new_layout)
2384 d->layout_ = new_layout;
2388 Inset * Paragraph::inInset() const
2390 return d->inset_owner_;
2394 InsetCode Paragraph::ownerCode() const
2396 return d->inset_owner_ ?
2397 d->inset_owner_->lyxCode() : NO_CODE;
2401 ParagraphParameters & Paragraph::params()
2407 ParagraphParameters const & Paragraph::params() const
2413 bool Paragraph::isFreeSpacing() const
2415 if (layout()->free_spacing)
2418 // for now we just need this, later should we need this in some
2419 // other way we can always add a function to Inset too.
2420 return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2424 bool Paragraph::allowEmpty() const
2426 if (layout()->keepempty)
2428 return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2432 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2434 if (!Encodings::is_arabic(c))
2437 char_type prev_char = ' ';
2438 char_type next_char = ' ';
2440 for (pos_type i = pos - 1; i >= 0; --i) {
2441 char_type const par_char = d->text_[i];
2442 if (!Encodings::isComposeChar_arabic(par_char)) {
2443 prev_char = par_char;
2448 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2449 char_type const par_char = d->text_[i];
2450 if (!Encodings::isComposeChar_arabic(par_char)) {
2451 next_char = par_char;
2456 if (Encodings::is_arabic(next_char)) {
2457 if (Encodings::is_arabic(prev_char) &&
2458 !Encodings::is_arabic_special(prev_char))
2459 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2461 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2463 if (Encodings::is_arabic(prev_char) &&
2464 !Encodings::is_arabic_special(prev_char))
2465 return Encodings::transformChar(c, Encodings::FORM_FINAL);
2467 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2472 int Paragraph::checkBiblio(bool track_changes)
2475 //This is getting more and more a mess. ...We really should clean
2476 //up this bibitem issue for 1.6. See also bug 2743.
2478 // Add bibitem insets if necessary
2479 if (layout()->labeltype != LABEL_BIBLIO)
2482 bool hasbibitem = !d->insetlist_.empty()
2483 // Insist on it being in pos 0
2484 && d->text_[0] == META_INSET
2485 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2490 // remove a bibitem in pos != 0
2491 // restore it later in pos 0 if necessary
2492 // (e.g. if a user inserts contents _before_ the item)
2493 // we're assuming there's only one of these, which there
2495 int erasedInsetPosition = -1;
2496 InsetList::iterator it = d->insetlist_.begin();
2497 InsetList::iterator end = d->insetlist_.end();
2498 for (; it != end; ++it)
2499 if (it->inset->lyxCode() == BIBITEM_CODE
2501 InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2502 oldkey = olditem->getParam("key");
2503 oldlabel = olditem->getParam("label");
2504 erasedInsetPosition = it->pos;
2505 eraseChar(erasedInsetPosition, track_changes);
2509 //There was an InsetBibitem at the beginning, and we didn't
2510 //have to erase one.
2511 if (hasbibitem && erasedInsetPosition < 0)
2514 //There was an InsetBibitem at the beginning and we did have to
2515 //erase one. So we give its properties to the beginning inset.
2517 InsetBibitem * inset =
2518 static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2519 if (!oldkey.empty())
2520 inset->setParam("key", oldkey);
2521 inset->setParam("label", oldlabel);
2522 return -erasedInsetPosition;
2525 //There was no inset at the beginning, so we need to create one with
2526 //the key and label of the one we erased.
2527 InsetBibitem * inset(new InsetBibitem(InsetCommandParams(BIBITEM_CODE)));
2528 // restore values of previously deleted item in this par.
2529 if (!oldkey.empty())
2530 inset->setParam("key", oldkey);
2531 inset->setParam("label", oldlabel);
2532 insertInset(0, static_cast<Inset *>(inset),
2533 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2539 void Paragraph::checkAuthors(AuthorList const & authorList)
2541 d->changes_.checkAuthors(authorList);
2545 bool Paragraph::isUnchanged(pos_type pos) const
2547 return lookupChange(pos).type == Change::UNCHANGED;
2551 bool Paragraph::isInserted(pos_type pos) const
2553 return lookupChange(pos).type == Change::INSERTED;
2557 bool Paragraph::isDeleted(pos_type pos) const
2559 return lookupChange(pos).type == Change::DELETED;
2563 InsetList const & Paragraph::insetList() const
2565 return d->insetlist_;
2569 Inset * Paragraph::releaseInset(pos_type pos)
2571 Inset * inset = d->insetlist_.release(pos);
2572 /// does not honour change tracking!
2573 eraseChar(pos, false);
2578 Inset * Paragraph::getInset(pos_type pos)
2580 return d->insetlist_.get(pos);
2584 Inset const * Paragraph::getInset(pos_type pos) const
2586 return d->insetlist_.get(pos);
2590 int Paragraph::numberOfOptArgs() const
2593 InsetList::const_iterator it = insetList().begin();
2594 InsetList::const_iterator end = insetList().end();
2595 for (; it != end ; ++it) {
2596 if (it->inset->lyxCode() == OPTARG_CODE)
2603 char_type Paragraph::getChar(pos_type pos) const
2605 return d->text_[pos];
2609 pos_type Paragraph::size() const
2611 return d->text_.size();
2615 bool Paragraph::empty() const
2617 return d->text_.empty();
2621 bool Paragraph::isInset(pos_type pos) const
2623 return d->text_[pos] == META_INSET;
2627 bool Paragraph::isSeparator(pos_type pos) const
2629 //FIXME: Are we sure this can be the only separator?
2630 return d->text_[pos] == ' ';