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"
67 using support::contains;
68 using support::prefixIs;
69 using support::suffixIs;
70 using support::rsplit;
74 /////////////////////////////////////////////////////////////////////
78 /////////////////////////////////////////////////////////////////////
80 class Paragraph::Private
84 Private(Paragraph * owner);
85 /// "Copy constructor"
86 Private(Private const &, Paragraph * owner);
89 value_type getChar(pos_type pos) const;
91 void insertChar(pos_type pos, value_type c, Change const & change);
93 /// Output the surrogate pair formed by \p c and \p next to \p os.
94 /// \return the number of characters written.
95 int latexSurrogatePair(odocstream & os, value_type c, value_type next,
98 /// Output a space in appropriate formatting (or a surrogate pair
99 /// if the next character is a combining character).
100 /// \return whether a surrogate pair was output.
101 bool simpleTeXBlanks(Encoding const &,
102 odocstream &, TexRow & texrow,
104 unsigned int & column,
106 Layout const & style);
108 /// Output consecutive known unicode chars, belonging to the same
109 /// language as specified by \p preamble, to \p os starting from \p c.
110 /// \return the number of characters written.
111 int knownLangChars(odocstream & os, value_type c, string & preamble,
112 Change &, Encoding const &, pos_type &);
114 /// This could go to ParagraphParameters if we want to.
115 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
118 /// This could go to ParagraphParameters if we want to.
119 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
123 void latexInset(Buffer const &, BufferParams const &,
125 TexRow & texrow, OutputParams &,
128 Font const & outerfont,
130 Change & running_change,
131 Layout const & style,
133 unsigned int & column);
136 void latexSpecialChar(
138 OutputParams & runparams,
140 Change & running_change,
141 Layout const & style,
143 unsigned int & column);
150 unsigned int & column);
152 bool latexSpecialTypewriter(
156 unsigned int & column);
158 bool latexSpecialPhrase(
161 unsigned int & column);
164 void validate(LaTeXFeatures & features,
165 Layout const & layout) const;
168 pos_type size() const { return owner_->size(); }
170 /// match a string against a particular point in the paragraph
171 bool isTextAt(std::string const & str, pos_type pos) const;
173 /// Which Paragraph owns us?
177 Inset * inset_owner_;
185 static unsigned int paragraph_id;
187 ParagraphParameters params_;
189 /// for recording and looking up changes
193 InsetList insetlist_;
199 pos_type begin_of_body_;
206 using std::upper_bound;
207 using std::lower_bound;
211 // Initialization of the counter for the paragraph id's,
212 unsigned int Paragraph::Private::paragraph_id = 0;
216 struct special_phrase {
222 special_phrase const special_phrases[] = {
223 { "LyX", from_ascii("\\protect\\LyX{}"), false },
224 { "TeX", from_ascii("\\protect\\TeX{}"), true },
225 { "LaTeX2e", from_ascii("\\protect\\LaTeXe{}"), true },
226 { "LaTeX", from_ascii("\\protect\\LaTeX{}"), true },
229 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
234 Paragraph::Private::Private(Paragraph * owner)
235 : owner_(owner), inset_owner_(0), begin_of_body_(0)
237 id_ = paragraph_id++;
241 Paragraph::Private::Private(Private const & p, Paragraph * owner)
242 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
243 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
244 layout_(p.layout_), begin_of_body_(p.begin_of_body_)
246 id_ = paragraph_id++;
250 bool Paragraph::isChanged(pos_type start, pos_type end) const
252 BOOST_ASSERT(start >= 0 && start <= size());
253 BOOST_ASSERT(end > start && end <= size() + 1);
255 return d->changes_.isChanged(start, end);
259 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const {
260 // keep the logic here in sync with the logic of eraseChars()
266 Change change = d->changes_.lookup(size());
268 return change.type == Change::INSERTED && change.author == 0;
272 void Paragraph::setChange(Change const & change)
274 // beware of the imaginary end-of-par character!
275 d->changes_.set(change, 0, size() + 1);
278 * Propagate the change recursively - but not in case of DELETED!
280 * Imagine that your co-author makes changes in an existing inset. He
281 * sends your document to you and you come to the conclusion that the
282 * inset should go completely. If you erase it, LyX must not delete all
283 * text within the inset. Otherwise, the change tracked insertions of
284 * your co-author get lost and there is no way to restore them later.
286 * Conclusion: An inset's content should remain untouched if you delete it
289 if (change.type != Change::DELETED) {
290 for (pos_type pos = 0; pos < size(); ++pos) {
292 getInset(pos)->setChange(change);
298 void Paragraph::setChange(pos_type pos, Change const & change)
300 BOOST_ASSERT(pos >= 0 && pos <= size());
302 d->changes_.set(change, pos);
304 // see comment in setChange(Change const &) above
306 if (change.type != Change::DELETED &&
307 pos < size() && isInset(pos)) {
308 getInset(pos)->setChange(change);
313 Change const & Paragraph::lookupChange(pos_type pos) const
315 BOOST_ASSERT(pos >= 0 && pos <= size());
317 return d->changes_.lookup(pos);
321 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start,
324 BOOST_ASSERT(start >= 0 && start <= size());
325 BOOST_ASSERT(end > start && end <= size() + 1);
327 for (pos_type pos = start; pos < end; ++pos) {
328 switch (lookupChange(pos).type) {
329 case Change::UNCHANGED:
330 // accept changes in nested inset
331 if (pos < size() && isInset(pos))
332 getInset(pos)->acceptChanges(bparams);
336 case Change::INSERTED:
337 d->changes_.set(Change(Change::UNCHANGED), pos);
338 // also accept changes in nested inset
339 if (pos < size() && isInset(pos)) {
340 getInset(pos)->acceptChanges(bparams);
344 case Change::DELETED:
345 // Suppress access to non-existent
346 // "end-of-paragraph char"
348 eraseChar(pos, false);
359 void Paragraph::rejectChanges(BufferParams const & bparams,
360 pos_type start, pos_type end)
362 BOOST_ASSERT(start >= 0 && start <= size());
363 BOOST_ASSERT(end > start && end <= size() + 1);
365 for (pos_type pos = start; pos < end; ++pos) {
366 switch (lookupChange(pos).type) {
367 case Change::UNCHANGED:
368 // reject changes in nested inset
369 if (pos < size() && isInset(pos)) {
370 getInset(pos)->rejectChanges(bparams);
374 case Change::INSERTED:
375 // Suppress access to non-existent
376 // "end-of-paragraph char"
378 eraseChar(pos, false);
384 case Change::DELETED:
385 d->changes_.set(Change(Change::UNCHANGED), pos);
387 // Do NOT reject changes within a deleted inset!
388 // There may be insertions of a co-author inside of it!
396 Paragraph::value_type Paragraph::Private::getChar(pos_type pos) const
398 BOOST_ASSERT(pos >= 0 && pos <= size());
400 return owner_->getChar(pos);
404 void Paragraph::Private::insertChar(pos_type pos, value_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
416 owner_->text_.push_back(c);
420 owner_->text_.insert(owner_->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(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 (text_[pos] == Paragraph::META_INSET)
479 d->insetlist_.erase(pos);
481 text_.erase(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, value_type c,
508 value_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 = getChar(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 && getChar(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 && (getChar(i - 1) == '.'
554 || getChar(i - 1) == '?'
555 || getChar(i - 1) == ':'
556 || getChar(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 = getChar(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] != owner_->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 value_type const c = getChar(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 = getChar(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() || getChar(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() && getChar(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(getChar(i), features);
1046 /////////////////////////////////////////////////////////////////////
1050 /////////////////////////////////////////////////////////////////////
1052 Paragraph::Paragraph()
1053 : d(new Paragraph::Private(this))
1061 Paragraph::Paragraph(Paragraph const & par)
1062 : itemdepth(par.itemdepth), text_(par.text_),
1063 d(new Paragraph::Private(*par.d, this))
1068 Paragraph & Paragraph::operator=(Paragraph const & par)
1070 // needed as we will destroy the private part before copying it
1072 itemdepth = par.itemdepth;
1076 d = new Private(*par.d, this);
1082 Paragraph::~Paragraph()
1088 void Paragraph::write(Buffer const & buf, ostream & os,
1089 BufferParams const & bparams,
1090 depth_type & dth) const
1092 // The beginning or end of a deeper (i.e. nested) area?
1093 if (dth != params().depth()) {
1094 if (params().depth() > dth) {
1095 while (params().depth() > dth) {
1096 os << "\n\\begin_deeper";
1100 while (params().depth() < dth) {
1101 os << "\n\\end_deeper";
1107 // First write the layout
1108 os << "\n\\begin_layout " << to_utf8(layout()->name()) << '\n';
1112 Font font1(Font::ALL_INHERIT, bparams.language);
1114 Change running_change = Change(Change::UNCHANGED);
1117 for (pos_type i = 0; i <= size(); ++i) {
1119 Change change = lookupChange(i);
1120 Changes::lyxMarkChange(os, column, running_change, change);
1121 running_change = change;
1126 // Write font changes
1127 Font font2 = getFontSettings(bparams, i);
1128 if (font2 != font1) {
1129 font2.lyxWriteChanges(font1, os);
1134 value_type const c = getChar(i);
1138 Inset const * inset = getInset(i);
1140 if (inset->directWrite()) {
1141 // international char, let it write
1142 // code directly so it's shorter in
1144 inset->write(buf, os);
1148 os << "\\begin_inset ";
1149 inset->write(buf, os);
1150 os << "\n\\end_inset\n\n";
1156 os << "\n\\backslash\n";
1160 if (i + 1 < size() && getChar(i + 1) == ' ') {
1167 if ((column > 70 && c == ' ')
1172 // this check is to amend a bug. LyX sometimes
1173 // inserts '\0' this could cause problems.
1175 std::vector<char> tmp = ucs4_to_utf8(c);
1176 tmp.push_back('\0');
1179 lyxerr << "ERROR (Paragraph::writeFile):"
1180 " NULL char in structure." << endl;
1186 os << "\n\\end_layout\n";
1190 void Paragraph::validate(LaTeXFeatures & features) const
1192 d->validate(features, *layout());
1196 void Paragraph::insert(pos_type start, docstring const & str,
1197 Font const & font, Change const & change)
1199 for (size_t i = 0, n = str.size(); i != n ; ++i)
1200 insertChar(start + i, str[i], font, change);
1204 void Paragraph::appendChar(value_type c, Font const & font,
1205 Change const & change)
1208 d->changes_.insert(change, text_.size());
1209 // when appending characters, no need to update tables
1211 setFont(text_.size() - 1, font);
1215 void Paragraph::appendString(docstring const & s, Font const & font,
1216 Change const & change)
1218 size_t end = s.size();
1219 size_t oldsize = text_.size();
1220 size_t newsize = oldsize + end;
1221 size_t capacity = text_.capacity();
1222 if (newsize >= capacity)
1223 text_.reserve(std::max(capacity + 100, newsize));
1225 // FIXME: Optimize this!
1226 for (pos_type i = 0; i != end; ++i) {
1228 d->changes_.insert(change, i);
1229 // when appending characters, no need to update tables
1230 text_.push_back(s[i]);
1232 d->fontlist_.setRange(oldsize, newsize, font);
1236 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1239 d->insertChar(pos, c, Change(trackChanges ?
1240 Change::INSERTED : Change::UNCHANGED));
1244 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1245 Font const & font, bool trackChanges)
1247 d->insertChar(pos, c, Change(trackChanges ?
1248 Change::INSERTED : Change::UNCHANGED));
1253 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1254 Font const & font, Change const & change)
1256 d->insertChar(pos, c, change);
1261 void Paragraph::insertInset(pos_type pos, Inset * inset,
1262 Font const & font, Change const & change)
1264 insertInset(pos, inset, change);
1265 // Set the font/language of the inset...
1270 bool Paragraph::insetAllowed(InsetCode code)
1272 return !d->inset_owner_ || d->inset_owner_->insetAllowed(code);
1276 // Gets uninstantiated font setting at position.
1277 Font const Paragraph::getFontSettings(BufferParams const & bparams,
1281 lyxerr << " pos: " << pos << " size: " << size() << endl;
1282 BOOST_ASSERT(pos <= size());
1285 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1286 if (cit != d->fontlist_.end())
1289 if (pos == size() && !empty())
1290 return getFontSettings(bparams, pos - 1);
1292 return Font(Font::ALL_INHERIT, getParLanguage(bparams));
1296 FontSpan Paragraph::fontSpan(pos_type pos) const
1298 BOOST_ASSERT(pos <= size());
1301 FontList::const_iterator cit = d->fontlist_.begin();
1302 FontList::const_iterator end = d->fontlist_.end();
1303 for (; cit != end; ++cit) {
1304 if (cit->pos() >= pos) {
1305 if (pos >= beginOfBody())
1306 return FontSpan(std::max(start, beginOfBody()),
1309 return FontSpan(start,
1310 std::min(beginOfBody() - 1,
1313 start = cit->pos() + 1;
1316 // This should not happen, but if so, we take no chances.
1317 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
1319 return FontSpan(pos, pos);
1323 // Gets uninstantiated font setting at position 0
1324 Font const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1326 if (!empty() && !d->fontlist_.empty())
1327 return d->fontlist_.begin()->font();
1329 return Font(Font::ALL_INHERIT, bparams.language);
1333 // Gets the fully instantiated font at a given position in a paragraph
1334 // This is basically the same function as Text::GetFont() in text2.cpp.
1335 // The difference is that this one is used for generating the LaTeX file,
1336 // and thus cosmetic "improvements" are disallowed: This has to deliver
1337 // the true picture of the buffer. (Asger)
1338 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1339 Font const & outerfont) const
1341 BOOST_ASSERT(pos >= 0);
1343 Font font = getFontSettings(bparams, pos);
1345 pos_type const body_pos = beginOfBody();
1347 font.realize(d->layout_->labelfont);
1349 font.realize(d->layout_->font);
1351 font.realize(outerfont);
1352 font.realize(bparams.getFont());
1358 Font const Paragraph::getLabelFont
1359 (BufferParams const & bparams, Font const & outerfont) const
1361 Font tmpfont = layout()->labelfont;
1362 tmpfont.setLanguage(getParLanguage(bparams));
1363 tmpfont.realize(outerfont);
1364 tmpfont.realize(bparams.getFont());
1369 Font const Paragraph::getLayoutFont
1370 (BufferParams const & bparams, Font const & outerfont) const
1372 Font tmpfont = layout()->font;
1373 tmpfont.setLanguage(getParLanguage(bparams));
1374 tmpfont.realize(outerfont);
1375 tmpfont.realize(bparams.getFont());
1380 /// Returns the height of the highest font in range
1381 Font_size Paragraph::highestFontInRange
1382 (pos_type startpos, pos_type endpos, Font_size def_size) const
1384 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1388 Paragraph::value_type
1389 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1391 value_type c = getChar(pos);
1392 if (!lyxrc.rtl_support)
1422 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1429 void Paragraph::setFont(pos_type pos, Font const & font)
1431 BOOST_ASSERT(pos <= size());
1433 // First, reduce font against layout/label font
1434 // Update: The setCharFont() routine in text2.cpp already
1435 // reduces font, so we don't need to do that here. (Asger)
1437 d->fontlist_.set(pos, font);
1441 void Paragraph::makeSameLayout(Paragraph const & par)
1443 layout(par.layout());
1445 d->params_ = par.params();
1449 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1451 if (isFreeSpacing())
1457 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1458 if (eraseChar(pos, trackChanges))
1464 return count > 0 || pos > 0;
1468 bool Paragraph::hasSameLayout(Paragraph const & par) const
1470 return par.layout() == layout() && d->params_.sameLayout(par.params());
1474 depth_type Paragraph::getDepth() const
1476 return params().depth();
1480 depth_type Paragraph::getMaxDepthAfter() const
1482 if (layout()->isEnvironment())
1483 return params().depth() + 1;
1485 return params().depth();
1489 char Paragraph::getAlign() const
1491 if (params().align() == LYX_ALIGN_LAYOUT)
1492 return layout()->align;
1494 return params().align();
1498 docstring const & Paragraph::getLabelstring() const
1500 return params().labelString();
1504 // the next two functions are for the manual labels
1505 docstring const Paragraph::getLabelWidthString() const
1507 if (layout()->margintype == MARGIN_MANUAL)
1508 return params().labelWidthString();
1510 return _("Senseless with this layout!");
1514 void Paragraph::setLabelWidthString(docstring const & s)
1516 params().labelWidthString(s);
1520 docstring const Paragraph::translateIfPossible(docstring const & s,
1521 BufferParams const & bparams) const
1523 if (!support::isAscii(s) || s.empty()) {
1524 // This must be a user defined layout. We cannot translate
1525 // this, since gettext accepts only ascii keys.
1528 // Probably standard layout, try to translate
1529 Messages & m = getMessages(getParLanguage(bparams)->code());
1530 return m.get(to_ascii(s));
1534 docstring Paragraph::expandLabel(LayoutPtr const & layout,
1535 BufferParams const & bparams, bool process_appendix) const
1537 TextClass const & tclass = bparams.getTextClass();
1540 if (process_appendix && params().appendix())
1541 fmt = translateIfPossible(layout->labelstring_appendix(),
1544 fmt = translateIfPossible(layout->labelstring(), bparams);
1546 if (fmt.empty() && layout->labeltype == LABEL_COUNTER
1547 && !layout->counter.empty())
1548 fmt = "\\the" + layout->counter;
1550 // handle 'inherited level parts' in 'fmt',
1551 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
1552 size_t const i = fmt.find('@', 0);
1553 if (i != docstring::npos) {
1554 size_t const j = fmt.find('@', i + 1);
1555 if (j != docstring::npos) {
1556 docstring parent(fmt, i + 1, j - i - 1);
1557 docstring label = from_ascii("??");
1558 if (tclass.hasLayout(parent))
1559 docstring label = expandLabel(tclass[parent], bparams,
1561 fmt = docstring(fmt, 0, i) + label
1562 + docstring(fmt, j + 1, docstring::npos);
1566 return tclass.counters().counterLabel(fmt);
1570 void Paragraph::applyLayout(LayoutPtr const & new_layout)
1573 LyXAlignment const oldAlign = params().align();
1575 if (!(oldAlign & layout()->alignpossible)) {
1576 frontend::Alert::warning(_("Alignment not permitted"),
1577 _("The new layout does not permit the alignment previously used.\nSetting to default."));
1578 params().align(LYX_ALIGN_LAYOUT);
1583 pos_type Paragraph::beginOfBody() const
1585 return d->begin_of_body_;
1589 void Paragraph::setBeginOfBody()
1591 if (layout()->labeltype != LABEL_MANUAL) {
1592 d->begin_of_body_ = 0;
1596 // Unroll the first two cycles of the loop
1597 // and remember the previous character to
1598 // remove unnecessary getChar() calls
1600 pos_type end = size();
1601 if (i < end && !isNewline(i)) {
1603 char_type previous_char = 0;
1606 previous_char = text_[i];
1607 if (!isNewline(i)) {
1609 while (i < end && previous_char != ' ') {
1614 previous_char = temp;
1620 d->begin_of_body_ = i;
1624 InsetBibitem * Paragraph::bibitem() const
1626 if (!d->insetlist_.empty()) {
1627 Inset * inset = d->insetlist_.begin()->inset;
1628 if (inset->lyxCode() == BIBITEM_CODE)
1629 return static_cast<InsetBibitem *>(inset);
1635 bool Paragraph::forceDefaultParagraphs() const
1637 return inInset() && inInset()->forceDefaultParagraphs(0);
1643 // paragraphs inside floats need different alignment tags to avoid
1646 bool noTrivlistCentering(InsetCode code)
1648 return code == FLOAT_CODE || code == WRAP_CODE;
1652 string correction(string const & orig)
1654 if (orig == "flushleft")
1655 return "raggedright";
1656 if (orig == "flushright")
1657 return "raggedleft";
1658 if (orig == "center")
1664 string const corrected_env(string const & suffix, string const & env,
1667 string output = suffix + "{";
1668 if (noTrivlistCentering(code))
1669 output += correction(env);
1673 if (suffix == "\\begin")
1679 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1681 if (!contains(str, "\n"))
1682 column += str.size();
1686 column = rsplit(str, tmp, '\n').size();
1693 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
1694 odocstream & os, TexRow & texrow,
1695 bool moving_arg) const
1699 if (params_.noindent()) {
1700 os << "\\noindent ";
1704 LyXAlignment const curAlign = params_.align();
1706 if (curAlign == layout_->align)
1710 case LYX_ALIGN_NONE:
1711 case LYX_ALIGN_BLOCK:
1712 case LYX_ALIGN_LAYOUT:
1713 case LYX_ALIGN_SPECIAL:
1715 case LYX_ALIGN_LEFT:
1716 case LYX_ALIGN_RIGHT:
1717 case LYX_ALIGN_CENTER:
1726 case LYX_ALIGN_NONE:
1727 case LYX_ALIGN_BLOCK:
1728 case LYX_ALIGN_LAYOUT:
1729 case LYX_ALIGN_SPECIAL:
1731 case LYX_ALIGN_LEFT: {
1733 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1734 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1736 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1737 os << from_ascii(output);
1738 adjust_row_column(output, texrow, column);
1740 } case LYX_ALIGN_RIGHT: {
1742 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1743 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1745 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1746 os << from_ascii(output);
1747 adjust_row_column(output, texrow, column);
1749 } case LYX_ALIGN_CENTER: {
1751 output = corrected_env("\\begin", "center", owner_->ownerCode());
1752 os << from_ascii(output);
1753 adjust_row_column(output, texrow, column);
1762 int Paragraph::Private::endTeXParParams(BufferParams const & bparams,
1763 odocstream & os, TexRow & texrow,
1764 bool moving_arg) const
1768 switch (params_.align()) {
1769 case LYX_ALIGN_NONE:
1770 case LYX_ALIGN_BLOCK:
1771 case LYX_ALIGN_LAYOUT:
1772 case LYX_ALIGN_SPECIAL:
1774 case LYX_ALIGN_LEFT:
1775 case LYX_ALIGN_RIGHT:
1776 case LYX_ALIGN_CENTER:
1784 switch (params_.align()) {
1785 case LYX_ALIGN_NONE:
1786 case LYX_ALIGN_BLOCK:
1787 case LYX_ALIGN_LAYOUT:
1788 case LYX_ALIGN_SPECIAL:
1790 case LYX_ALIGN_LEFT: {
1792 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1793 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1795 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1796 os << from_ascii(output);
1797 adjust_row_column(output, texrow, column);
1799 } case LYX_ALIGN_RIGHT: {
1801 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1802 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1804 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1805 os << from_ascii(output);
1806 adjust_row_column(output, texrow, column);
1808 } case LYX_ALIGN_CENTER: {
1810 output = corrected_env("\n\\par\\end", "center", owner_->ownerCode());
1811 os << from_ascii(output);
1812 adjust_row_column(output, texrow, column);
1821 // This one spits out the text of the paragraph
1822 bool Paragraph::latex(Buffer const & buf,
1823 BufferParams const & bparams,
1824 Font const & outerfont,
1825 odocstream & os, TexRow & texrow,
1826 OutputParams const & runparams) const
1828 LYXERR(Debug::LATEX) << "SimpleTeXOnePar... " << this << endl;
1830 bool return_value = false;
1834 // well we have to check if we are in an inset with unlimited
1835 // length (all in one row) if that is true then we don't allow
1836 // any special options in the paragraph and also we don't allow
1837 // any environment other than the default layout of the text class
1839 bool asdefault = forceDefaultParagraphs();
1842 style = bparams.getTextClass().defaultLayout();
1847 // Current base font for all inherited font changes, without any
1848 // change caused by an individual character, except for the language:
1849 // It is set to the language of the first character.
1850 // As long as we are in the label, this font is the base font of the
1851 // label. Before the first body character it is set to the base font
1855 // Maybe we have to create a optional argument.
1856 pos_type body_pos = beginOfBody();
1857 unsigned int column = 0;
1860 // the optional argument is kept in curly brackets in
1861 // case it contains a ']'
1864 basefont = getLabelFont(bparams, outerfont);
1866 basefont = getLayoutFont(bparams, outerfont);
1869 // Which font is currently active?
1870 Font running_font(basefont);
1871 // Do we have an open font change?
1872 bool open_font = false;
1874 Change runningChange = Change(Change::UNCHANGED);
1876 texrow.start(id(), 0);
1878 // if the paragraph is empty, the loop will not be entered at all
1880 if (style->isCommand()) {
1885 column += d->startTeXParParams(bparams, os, texrow,
1886 runparams.moving_arg);
1889 for (pos_type i = 0; i < size(); ++i) {
1890 // First char in paragraph or after label?
1891 if (i == body_pos) {
1894 column += running_font.latexWriteEndChanges(
1895 os, bparams, runparams,
1896 basefont, basefont);
1899 basefont = getLayoutFont(bparams, outerfont);
1900 running_font = basefont;
1902 column += Changes::latexMarkChange(os, bparams,
1903 runningChange, Change(Change::UNCHANGED));
1904 runningChange = Change(Change::UNCHANGED);
1909 if (style->isCommand()) {
1915 column += d->startTeXParParams(bparams, os,
1917 runparams.moving_arg);
1920 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
1923 if (bparams.outputChanges && runningChange != change) {
1925 column += running_font.latexWriteEndChanges(
1926 os, bparams, runparams, basefont, basefont);
1929 basefont = getLayoutFont(bparams, outerfont);
1930 running_font = basefont;
1932 column += Changes::latexMarkChange(os, bparams, runningChange, change);
1933 runningChange = change;
1936 // do not output text which is marked deleted
1937 // if change tracking output is disabled
1938 if (!bparams.outputChanges && change.type == Change::DELETED) {
1944 // Fully instantiated font
1945 Font const font = getFont(bparams, i, outerfont);
1947 Font const last_font = running_font;
1949 // Do we need to close the previous font?
1951 (font != running_font ||
1952 font.language() != running_font.language()))
1954 column += running_font.latexWriteEndChanges(
1955 os, bparams, runparams, basefont,
1956 (i == body_pos-1) ? basefont : font);
1957 running_font = basefont;
1961 // Switch file encoding if necessary (and allowed)
1962 if (!runparams.verbatim &&
1963 runparams.encoding->package() == Encoding::inputenc &&
1964 font.language()->encoding()->package() == Encoding::inputenc) {
1965 std::pair<bool, int> const enc_switch = switchEncoding(os, bparams,
1966 runparams.moving_arg, *(runparams.encoding),
1967 *(font.language()->encoding()));
1968 if (enc_switch.first) {
1969 column += enc_switch.second;
1970 runparams.encoding = font.language()->encoding();
1974 value_type const c = getChar(i);
1976 // Do we need to change font?
1977 if ((font != running_font ||
1978 font.language() != running_font.language()) &&
1981 odocstringstream ods;
1982 column += font.latexWriteStartChanges(ods, bparams,
1983 runparams, basefont,
1985 running_font = font;
1987 docstring fontchange = ods.str();
1988 // check if the fontchange ends with a trailing blank
1989 // (like "\small " (see bug 3382)
1990 if (suffixIs(fontchange, ' ') && c == ' ')
1991 os << fontchange.substr(0, fontchange.size() - 1)
1992 << from_ascii("{}");
1998 // FIXME: integrate this case in latexSpecialChar
1999 // Do not print the separation of the optional argument
2000 // if style->pass_thru is false. This works because
2001 // latexSpecialChar ignores spaces if
2002 // style->pass_thru is false.
2003 if (i != body_pos - 1) {
2004 if (d->simpleTeXBlanks(
2005 *(runparams.encoding), os, texrow,
2006 i, column, font, *style)) {
2007 // A surrogate pair was output. We
2008 // must not call latexSpecialChar
2009 // in this iteration, since it would output
2010 // the combining character again.
2017 OutputParams rp = runparams;
2018 rp.free_spacing = style->free_spacing;
2019 rp.local_font = &font;
2020 rp.intitle = style->intitle;
2022 // Two major modes: LaTeX or plain
2023 // Handle here those cases common to both modes
2024 // and then split to handle the two modes separately.
2025 if (c == Paragraph::META_INSET)
2026 d->latexInset(buf, bparams, os,
2027 texrow, rp, running_font,
2028 basefont, outerfont, open_font,
2029 runningChange, *style, i, column);
2031 d->latexSpecialChar(os, rp, running_font, runningChange,
2034 // Set the encoding to that returned from simpleTeXSpecialChars (see
2035 // comment for encoding member in OutputParams.h)
2036 runparams.encoding = rp.encoding;
2039 // If we have an open font definition, we have to close it
2041 #ifdef FIXED_LANGUAGE_END_DETECTION
2044 .latexWriteEndChanges(os, bparams, runparams,
2046 next_->getFont(bparams, 0, outerfont));
2048 running_font.latexWriteEndChanges(os, bparams,
2049 runparams, basefont, basefont);
2052 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2053 //FIXME: there as we start another \selectlanguage with the next paragraph if
2054 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2055 running_font.latexWriteEndChanges(os, bparams, runparams,
2056 basefont, basefont);
2060 column += Changes::latexMarkChange(os, bparams, runningChange, Change(Change::UNCHANGED));
2062 // Needed if there is an optional argument but no contents.
2063 if (body_pos > 0 && body_pos == size()) {
2065 return_value = false;
2069 column += d->endTeXParParams(bparams, os, texrow,
2070 runparams.moving_arg);
2073 LYXERR(Debug::LATEX) << "SimpleTeXOnePar...done " << this << endl;
2074 return return_value;
2091 string tag_name(PAR_TAG const & pt) {
2093 case PAR_NONE: return "!-- --";
2094 case TT: return "tt";
2095 case SF: return "sf";
2096 case BF: return "bf";
2097 case IT: return "it";
2098 case SL: return "sl";
2099 case EM: return "em";
2106 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2108 p1 = static_cast<PAR_TAG>(p1 | p2);
2113 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2115 p1 = static_cast<PAR_TAG>(p1 & ~p2);
2121 bool Paragraph::emptyTag() const
2123 for (pos_type i = 0; i < size(); ++i) {
2125 Inset const * inset = getInset(i);
2126 InsetCode lyx_code = inset->lyxCode();
2127 if (lyx_code != TOC_CODE &&
2128 lyx_code != INCLUDE_CODE &&
2129 lyx_code != GRAPHICS_CODE &&
2130 lyx_code != ERT_CODE &&
2131 lyx_code != LISTINGS_CODE &&
2132 lyx_code != FLOAT_CODE &&
2133 lyx_code != TABULAR_CODE) {
2137 value_type c = getChar(i);
2138 if (c != ' ' && c != '\t')
2146 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
2148 for (pos_type i = 0; i < size(); ++i) {
2150 Inset const * inset = getInset(i);
2151 InsetCode lyx_code = inset->lyxCode();
2152 if (lyx_code == LABEL_CODE) {
2153 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2154 docstring const & id = il->getParam("name");
2155 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2164 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
2167 for (i = 0; i < size(); ++i) {
2169 Inset const * inset = getInset(i);
2170 inset->docbook(buf, os, runparams);
2172 value_type c = getChar(i);
2175 os << sgml::escapeChar(c);
2182 bool Paragraph::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2186 for (pos_type i = initial; i < size(); ++i) {
2187 Font font = getFont(buf.params(), i, outerfont);
2190 if (i != initial && font != font_old)
2199 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2201 OutputParams const & runparams,
2202 Font const & outerfont,
2203 pos_type initial) const
2205 bool emph_flag = false;
2207 LayoutPtr const & style = layout();
2209 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
2211 if (style->pass_thru && !onlyText(buf, outerfont, initial))
2214 // parsing main loop
2215 for (pos_type i = initial; i < size(); ++i) {
2216 Font font = getFont(buf.params(), i, outerfont);
2218 // handle <emphasis> tag
2219 if (font_old.emph() != font.emph()) {
2220 if (font.emph() == Font::ON) {
2223 } else if (i != initial) {
2224 os << "</emphasis>";
2230 Inset const * inset = getInset(i);
2231 inset->docbook(buf, os, runparams);
2233 value_type c = getChar(i);
2235 if (style->pass_thru)
2238 os << sgml::escapeChar(c);
2244 os << "</emphasis>";
2247 if (style->free_spacing)
2249 if (style->pass_thru && !onlyText(buf, outerfont, initial))
2254 bool Paragraph::isHfill(pos_type pos) const
2257 && getInset(pos)->lyxCode() == HFILL_CODE;
2261 bool Paragraph::isNewline(pos_type pos) const
2264 && getInset(pos)->lyxCode() == NEWLINE_CODE;
2268 bool Paragraph::isLineSeparator(pos_type pos) const
2270 value_type const c = getChar(pos);
2271 return isLineSeparatorChar(c)
2272 || (c == Paragraph::META_INSET && getInset(pos) &&
2273 getInset(pos)->isLineSeparator());
2277 /// Used by the spellchecker
2278 bool Paragraph::isLetter(pos_type pos) const
2281 return getInset(pos)->isLetter();
2283 value_type const c = getChar(pos);
2284 return isLetterChar(c) || isDigit(c);
2290 Paragraph::getParLanguage(BufferParams const & bparams) const
2293 return getFirstFontSettings(bparams).language();
2294 // FIXME: we should check the prev par as well (Lgb)
2295 return bparams.language;
2299 bool Paragraph::isRTL(BufferParams const & bparams) const
2301 return lyxrc.rtl_support
2302 && getParLanguage(bparams)->rightToLeft()
2303 && ownerCode() != ERT_CODE
2304 && ownerCode() != LISTINGS_CODE;
2308 void Paragraph::changeLanguage(BufferParams const & bparams,
2309 Language const * from, Language const * to)
2311 // change language including dummy font change at the end
2312 for (pos_type i = 0; i <= size(); ++i) {
2313 Font font = getFontSettings(bparams, i);
2314 if (font.language() == from) {
2315 font.setLanguage(to);
2322 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2324 Language const * doc_language = bparams.language;
2325 FontList::const_iterator cit = d->fontlist_.begin();
2326 FontList::const_iterator end = d->fontlist_.end();
2328 for (; cit != end; ++cit)
2329 if (cit->font().language() != ignore_language &&
2330 cit->font().language() != latex_language &&
2331 cit->font().language() != doc_language)
2337 // Convert the paragraph to a string.
2338 // Used for building the table of contents
2339 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
2341 return asString(buffer, 0, size(), label);
2345 docstring const Paragraph::asString(Buffer const & buffer,
2346 pos_type beg, pos_type end, bool label) const
2349 odocstringstream os;
2351 if (beg == 0 && label && !params().labelString().empty())
2352 os << params().labelString() << ' ';
2354 for (pos_type i = beg; i < end; ++i) {
2355 value_type const c = getChar(i);
2358 else if (c == META_INSET)
2359 getInset(i)->textString(buffer, os);
2366 void Paragraph::setInsetOwner(Inset * inset)
2368 d->inset_owner_ = inset;
2372 int Paragraph::id() const
2378 LayoutPtr const & Paragraph::layout() const
2384 void Paragraph::layout(LayoutPtr const & new_layout)
2386 d->layout_ = new_layout;
2390 Inset * Paragraph::inInset() const
2392 return d->inset_owner_;
2396 InsetCode Paragraph::ownerCode() const
2398 return d->inset_owner_ ?
2399 d->inset_owner_->lyxCode() : NO_CODE;
2403 ParagraphParameters & Paragraph::params()
2409 ParagraphParameters const & Paragraph::params() const
2415 bool Paragraph::isFreeSpacing() const
2417 if (layout()->free_spacing)
2420 // for now we just need this, later should we need this in some
2421 // other way we can always add a function to Inset too.
2422 return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2426 bool Paragraph::allowEmpty() const
2428 if (layout()->keepempty)
2430 return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2434 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2436 if (!Encodings::is_arabic(c))
2439 value_type prev_char = ' ';
2440 value_type next_char = ' ';
2442 for (pos_type i = pos - 1; i >= 0; --i) {
2443 value_type const par_char = getChar(i);
2444 if (!Encodings::isComposeChar_arabic(par_char)) {
2445 prev_char = par_char;
2450 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2451 value_type const par_char = getChar(i);
2452 if (!Encodings::isComposeChar_arabic(par_char)) {
2453 next_char = par_char;
2458 if (Encodings::is_arabic(next_char)) {
2459 if (Encodings::is_arabic(prev_char) &&
2460 !Encodings::is_arabic_special(prev_char))
2461 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2463 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2465 if (Encodings::is_arabic(prev_char) &&
2466 !Encodings::is_arabic_special(prev_char))
2467 return Encodings::transformChar(c, Encodings::FORM_FINAL);
2469 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2474 int Paragraph::checkBiblio(bool track_changes)
2477 //This is getting more and more a mess. ...We really should clean
2478 //up this bibitem issue for 1.6. See also bug 2743.
2480 // Add bibitem insets if necessary
2481 if (layout()->labeltype != LABEL_BIBLIO)
2484 bool hasbibitem = !d->insetlist_.empty()
2485 // Insist on it being in pos 0
2486 && getChar(0) == Paragraph::META_INSET
2487 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2492 // remove a bibitem in pos != 0
2493 // restore it later in pos 0 if necessary
2494 // (e.g. if a user inserts contents _before_ the item)
2495 // we're assuming there's only one of these, which there
2497 int erasedInsetPosition = -1;
2498 InsetList::iterator it = d->insetlist_.begin();
2499 InsetList::iterator end = d->insetlist_.end();
2500 for (; it != end; ++it)
2501 if (it->inset->lyxCode() == BIBITEM_CODE
2503 InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2504 oldkey = olditem->getParam("key");
2505 oldlabel = olditem->getParam("label");
2506 erasedInsetPosition = it->pos;
2507 eraseChar(erasedInsetPosition, track_changes);
2511 //There was an InsetBibitem at the beginning, and we didn't
2512 //have to erase one.
2513 if (hasbibitem && erasedInsetPosition < 0)
2516 //There was an InsetBibitem at the beginning and we did have to
2517 //erase one. So we give its properties to the beginning inset.
2519 InsetBibitem * inset =
2520 static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2521 if (!oldkey.empty())
2522 inset->setParam("key", oldkey);
2523 inset->setParam("label", oldlabel);
2524 return -erasedInsetPosition;
2527 //There was no inset at the beginning, so we need to create one with
2528 //the key and label of the one we erased.
2529 InsetBibitem * inset(new InsetBibitem(InsetCommandParams(BIBITEM_CODE)));
2530 // restore values of previously deleted item in this par.
2531 if (!oldkey.empty())
2532 inset->setParam("key", oldkey);
2533 inset->setParam("label", oldlabel);
2534 insertInset(0, static_cast<Inset *>(inset),
2535 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2541 void Paragraph::checkAuthors(AuthorList const & authorList)
2543 d->changes_.checkAuthors(authorList);
2547 bool Paragraph::isUnchanged(pos_type pos) const
2549 return lookupChange(pos).type == Change::UNCHANGED;
2553 bool Paragraph::isInserted(pos_type pos) const
2555 return lookupChange(pos).type == Change::INSERTED;
2559 bool Paragraph::isDeleted(pos_type pos) const
2561 return lookupChange(pos).type == Change::DELETED;
2565 InsetList const & Paragraph::insetList() const
2567 return d->insetlist_;
2571 Inset * Paragraph::releaseInset(pos_type pos)
2573 Inset * inset = d->insetlist_.release(pos);
2574 /// does not honour change tracking!
2575 eraseChar(pos, false);
2580 Inset * Paragraph::getInset(pos_type pos)
2582 return d->insetlist_.get(pos);
2586 Inset const * Paragraph::getInset(pos_type pos) const
2588 return d->insetlist_.get(pos);
2592 int Paragraph::numberOfOptArgs() const
2595 InsetList::const_iterator it = insetList().begin();
2596 InsetList::const_iterator end = insetList().end();
2597 for (; it != end ; ++it) {
2598 if (it->inset->lyxCode() == OPTARG_CODE)