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::lowercase;
70 using support::prefixIs;
71 using support::suffixIs;
72 using support::rsplit;
73 using support::uppercase;
76 /// Inset identifier (above 0x10ffff, for ucs-4)
77 char_type const META_INSET = 0x200001;
80 /////////////////////////////////////////////////////////////////////
84 /////////////////////////////////////////////////////////////////////
86 class Paragraph::Private
90 Private(Paragraph * owner);
91 /// "Copy constructor"
92 Private(Private const &, Paragraph * owner);
95 void insertChar(pos_type pos, char_type c, Change const & change);
97 /// Output the surrogate pair formed by \p c and \p next to \p os.
98 /// \return the number of characters written.
99 int latexSurrogatePair(odocstream & os, char_type c, char_type next,
102 /// Output a space in appropriate formatting (or a surrogate pair
103 /// if the next character is a combining character).
104 /// \return whether a surrogate pair was output.
105 bool simpleTeXBlanks(Encoding const &,
106 odocstream &, TexRow & texrow,
108 unsigned int & column,
110 Layout const & style);
112 /// Output consecutive unicode chars, belonging to the same script as
113 /// specified by the latex macro \p ltx, to \p os starting from \p c.
114 /// \return the number of characters written.
115 int writeScriptChars(odocstream & os, char_type c, docstring const & ltx,
116 Change &, Encoding const &, pos_type &);
118 /// This could go to ParagraphParameters if we want to.
119 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
122 /// This could go to ParagraphParameters if we want to.
123 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
127 void latexInset(Buffer const &, BufferParams const &,
129 TexRow & texrow, OutputParams &,
132 Font const & outerfont,
134 Change & running_change,
135 Layout const & style,
137 unsigned int & column);
140 void latexSpecialChar(
142 OutputParams & runparams,
144 Change & running_change,
145 Layout const & style,
147 unsigned int & column);
154 unsigned int & column);
156 bool latexSpecialTypewriter(
160 unsigned int & column);
162 bool latexSpecialPhrase(
165 unsigned int & column);
168 void validate(LaTeXFeatures & features,
169 Layout const & layout) const;
171 /// Checks if the paragraph contains only text and no inset or font change.
172 bool onlyText(Buffer const & buf, Font const & outerfont,
173 pos_type initial) const;
175 /// match a string against a particular point in the paragraph
176 bool isTextAt(std::string const & str, pos_type pos) const;
178 /// Which Paragraph owns us?
182 Inset * inset_owner_;
190 static unsigned int paragraph_id;
192 ParagraphParameters params_;
194 /// for recording and looking up changes
198 InsetList insetlist_;
204 pos_type begin_of_body_;
206 typedef docstring TextContainer;
215 using std::upper_bound;
216 using std::lower_bound;
220 // Initialization of the counter for the paragraph id's,
221 unsigned int Paragraph::Private::paragraph_id = 0;
225 struct special_phrase {
231 special_phrase const special_phrases[] = {
232 { "LyX", from_ascii("\\protect\\LyX{}"), false },
233 { "TeX", from_ascii("\\protect\\TeX{}"), true },
234 { "LaTeX2e", from_ascii("\\protect\\LaTeXe{}"), true },
235 { "LaTeX", from_ascii("\\protect\\LaTeX{}"), true },
238 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
243 Paragraph::Private::Private(Paragraph * owner)
244 : owner_(owner), inset_owner_(0), begin_of_body_(0)
246 id_ = paragraph_id++;
251 Paragraph::Private::Private(Private const & p, Paragraph * owner)
252 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
253 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
254 layout_(p.layout_), begin_of_body_(p.begin_of_body_), text_(p.text_)
256 id_ = paragraph_id++;
260 bool Paragraph::isChanged(pos_type start, pos_type end) const
262 BOOST_ASSERT(start >= 0 && start <= size());
263 BOOST_ASSERT(end > start && end <= size() + 1);
265 return d->changes_.isChanged(start, end);
269 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const {
270 // keep the logic here in sync with the logic of eraseChars()
276 Change change = d->changes_.lookup(size());
278 return change.type == Change::INSERTED && change.author == 0;
282 void Paragraph::setChange(Change const & change)
284 // beware of the imaginary end-of-par character!
285 d->changes_.set(change, 0, size() + 1);
288 * Propagate the change recursively - but not in case of DELETED!
290 * Imagine that your co-author makes changes in an existing inset. He
291 * sends your document to you and you come to the conclusion that the
292 * inset should go completely. If you erase it, LyX must not delete all
293 * text within the inset. Otherwise, the change tracked insertions of
294 * your co-author get lost and there is no way to restore them later.
296 * Conclusion: An inset's content should remain untouched if you delete it
299 if (change.type != Change::DELETED) {
300 for (pos_type pos = 0; pos < size(); ++pos) {
302 getInset(pos)->setChange(change);
308 void Paragraph::setChange(pos_type pos, Change const & change)
310 BOOST_ASSERT(pos >= 0 && pos <= size());
312 d->changes_.set(change, pos);
314 // see comment in setChange(Change const &) above
316 if (change.type != Change::DELETED &&
317 pos < size() && isInset(pos)) {
318 getInset(pos)->setChange(change);
323 Change const & Paragraph::lookupChange(pos_type pos) const
325 BOOST_ASSERT(pos >= 0 && pos <= size());
327 return d->changes_.lookup(pos);
331 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start,
334 BOOST_ASSERT(start >= 0 && start <= size());
335 BOOST_ASSERT(end > start && end <= size() + 1);
337 for (pos_type pos = start; pos < end; ++pos) {
338 switch (lookupChange(pos).type) {
339 case Change::UNCHANGED:
340 // accept changes in nested inset
341 if (pos < size() && isInset(pos))
342 getInset(pos)->acceptChanges(bparams);
346 case Change::INSERTED:
347 d->changes_.set(Change(Change::UNCHANGED), pos);
348 // also accept changes in nested inset
349 if (pos < size() && isInset(pos)) {
350 getInset(pos)->acceptChanges(bparams);
354 case Change::DELETED:
355 // Suppress access to non-existent
356 // "end-of-paragraph char"
358 eraseChar(pos, false);
369 void Paragraph::rejectChanges(BufferParams const & bparams,
370 pos_type start, pos_type end)
372 BOOST_ASSERT(start >= 0 && start <= size());
373 BOOST_ASSERT(end > start && end <= size() + 1);
375 for (pos_type pos = start; pos < end; ++pos) {
376 switch (lookupChange(pos).type) {
377 case Change::UNCHANGED:
378 // reject changes in nested inset
379 if (pos < size() && isInset(pos)) {
380 getInset(pos)->rejectChanges(bparams);
384 case Change::INSERTED:
385 // Suppress access to non-existent
386 // "end-of-paragraph char"
388 eraseChar(pos, false);
394 case Change::DELETED:
395 d->changes_.set(Change(Change::UNCHANGED), pos);
397 // Do NOT reject changes within a deleted inset!
398 // There may be insertions of a co-author inside of it!
406 void Paragraph::Private::insertChar(pos_type pos, char_type c,
407 Change const & change)
409 BOOST_ASSERT(pos >= 0 && pos <= int(text_.size()));
412 changes_.insert(change, pos);
414 // This is actually very common when parsing buffers (and
415 // maybe inserting ascii text)
416 if (pos == text_.size()) {
417 // when appending characters, no need to update tables
422 text_.insert(text_.begin() + pos, c);
424 // Update the font table.
425 fontlist_.increasePosAfterPos(pos);
428 insetlist_.increasePosAfterPos(pos);
432 void Paragraph::insertInset(pos_type pos, Inset * inset,
433 Change const & change)
436 BOOST_ASSERT(pos >= 0 && pos <= size());
438 d->insertChar(pos, META_INSET, change);
439 BOOST_ASSERT(d->text_[pos] == META_INSET);
441 // Add a new entry in the insetlist_.
442 d->insetlist_.insert(inset, pos);
446 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
448 BOOST_ASSERT(pos >= 0 && pos <= size());
450 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
453 Change change = d->changes_.lookup(pos);
455 // set the character to DELETED if
456 // a) it was previously unchanged or
457 // b) it was inserted by a co-author
459 if (change.type == Change::UNCHANGED ||
460 (change.type == Change::INSERTED && change.author != 0)) {
461 setChange(pos, Change(Change::DELETED));
465 if (change.type == Change::DELETED)
469 // Don't physically access the imaginary end-of-paragraph character.
470 // eraseChar() can only mark it as DELETED. A physical deletion of
471 // end-of-par must be handled externally.
477 d->changes_.erase(pos);
479 // if it is an inset, delete the inset entry
480 if (d->text_[pos] == META_INSET)
481 d->insetlist_.erase(pos);
483 d->text_.erase(d->text_.begin() + pos);
485 // Update the fontlist_
486 d->fontlist_.erase(pos);
488 // Update the insetlist_
489 d->insetlist_.decreasePosAfterPos(pos);
495 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
497 BOOST_ASSERT(start >= 0 && start <= size());
498 BOOST_ASSERT(end >= start && end <= size() + 1);
501 for (pos_type count = end - start; count; --count) {
502 if (!eraseChar(i, trackChanges))
509 int Paragraph::Private::latexSurrogatePair(odocstream & os, char_type c,
510 char_type next, Encoding const & encoding)
512 // Writing next here may circumvent a possible font change between
513 // c and next. Since next is only output if it forms a surrogate pair
514 // with c we can ignore this:
515 // A font change inside a surrogate pair does not make sense and is
516 // hopefully impossible to input.
517 // FIXME: change tracking
518 // Is this correct WRT change tracking?
519 docstring const latex1 = encoding.latexChar(next);
520 docstring const latex2 = encoding.latexChar(c);
521 os << latex1 << '{' << latex2 << '}';
522 return latex1.length() + latex2.length() + 2;
526 bool Paragraph::Private::simpleTeXBlanks(Encoding const & encoding,
527 odocstream & os, TexRow & texrow,
529 unsigned int & column,
531 Layout const & style)
536 if (i + 1 < int(text_.size())) {
537 char_type next = text_[i + 1];
538 if (Encodings::isCombiningChar(next)) {
539 // This space has an accent, so we must always output it.
540 column += latexSurrogatePair(os, ' ', next, encoding) - 1;
545 if (lyxrc.plaintext_linelen > 0
546 && column > lyxrc.plaintext_linelen
548 && text_[i - 1] != ' '
549 && (i + 1 < int(text_.size()))
550 // same in FreeSpacing mode
551 && !owner_->isFreeSpacing()
552 // In typewriter mode, we want to avoid
553 // ! . ? : at the end of a line
554 && !(font.family() == Font::TYPEWRITER_FAMILY
555 && (text_[i - 1] == '.'
556 || text_[i - 1] == '?'
557 || text_[i - 1] == ':'
558 || text_[i - 1] == '!'))) {
561 texrow.start(owner_->id(), i + 1);
563 } else if (style.free_spacing) {
572 int Paragraph::Private::writeScriptChars(odocstream & os,
574 docstring const & ltx,
575 Change & runningChange,
576 Encoding const & encoding,
579 // We only arrive here when a proper language for character c has not
580 // been specified (i.e., it could not be translated in the current
581 // latex encoding) and it belongs to a known script.
582 // Parameter ltx contains the latex translation of c as specified in
583 // the unicodesymbols file and is something like "\textXXX{<spec>}".
584 // The latex macro name "textXXX" specifies the script to which c
585 // belongs and we use it in order to check whether characters from the
586 // same script immediately follow, such that we can collect them in a
587 // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
588 // for the first char but only "<spec>" for all subsequent chars.
589 docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
590 docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
591 string script = to_ascii(ltx.substr(1, brace1 - 1));
592 int length = ltx.substr(0, brace2).length();
593 os << ltx.substr(0, brace2);
594 int size = text_.size();
595 while (i + 1 < size) {
596 char_type const next = text_[i + 1];
597 // Stop here if next character belongs to another script
598 // or there is a change in change tracking status.
599 if (!Encodings::isKnownScriptChar(next, script) ||
600 runningChange != owner_->lookupChange(i + 1))
604 FontList::const_iterator cit = fontlist_.begin();
605 FontList::const_iterator end = fontlist_.end();
606 for (; cit != end; ++cit) {
607 if (cit->pos() >= i && !found) {
608 prev_font = cit->font();
611 if (cit->pos() >= i + 1)
614 // Stop here if there is a font attribute or encoding change.
615 if (found && cit != end && prev_font != cit->font())
617 docstring const latex = encoding.latexChar(next);
618 docstring::size_type const b1 =
619 latex.find_first_of(from_ascii("{"));
620 docstring::size_type const b2 =
621 latex.find_last_of(from_ascii("}"));
622 int const len = b2 - b1 - 1;
623 os << latex.substr(b1 + 1, len);
633 bool Paragraph::Private::isTextAt(string const & str, pos_type pos) const
635 pos_type const len = str.length();
637 // is the paragraph large enough?
638 if (pos + len > int(text_.size()))
641 // does the wanted text start at point?
642 for (string::size_type i = 0; i < str.length(); ++i) {
643 // Caution: direct comparison of characters works only
644 // because str is pure ASCII.
645 if (str[i] != text_[pos + i])
649 return fontlist_.hasChangeInRange(pos, len);
653 void Paragraph::Private::latexInset(Buffer const & buf,
654 BufferParams const & bparams,
657 OutputParams & runparams,
660 Font const & outerfont,
662 Change & running_change,
663 Layout const & style,
665 unsigned int & column)
667 Inset * inset = owner_->getInset(i);
670 if (style.pass_thru) {
671 inset->plaintext(buf, os, runparams);
675 // FIXME: move this to InsetNewline::latex
676 if (inset->lyxCode() == NEWLINE_CODE) {
677 // newlines are handled differently here than
678 // the default in simpleTeXSpecialChars().
679 if (!style.newline_allowed) {
683 column += running_font.latexWriteEndChanges(
684 os, bparams, runparams,
689 if (running_font.family() == Font::TYPEWRITER_FAMILY)
692 basefont = owner_->getLayoutFont(bparams, outerfont);
693 running_font = basefont;
695 if (runparams.moving_arg)
701 texrow.start(owner_->id(), i + 1);
705 if (owner_->lookupChange(i).type == Change::DELETED) {
706 if( ++runparams.inDeletedInset == 1)
707 runparams.changeOfDeletedInset = owner_->lookupChange(i);
710 if (inset->canTrackChanges()) {
711 column += Changes::latexMarkChange(os, bparams, running_change,
712 Change(Change::UNCHANGED));
713 running_change = Change(Change::UNCHANGED);
717 odocstream::pos_type const len = os.tellp();
719 if ((inset->lyxCode() == GRAPHICS_CODE
720 || inset->lyxCode() == MATH_CODE
721 || inset->lyxCode() == HYPERLINK_CODE)
722 && running_font.isRightToLeft()) {
723 if (running_font.language()->lang() == "farsi")
730 // FIXME: Bug: we can have an empty font change here!
731 // if there has just been a font change, we are going to close it
732 // right now, which means stupid latex code like \textsf{}. AFAIK,
733 // this does not harm dvi output. A minor bug, thus (JMarc)
735 // Some insets cannot be inside a font change command.
736 // However, even such insets *can* be placed in \L or \R
737 // or their equivalents (for RTL language switches), so we don't
738 // close the language in those cases.
739 // ArabTeX, though, cannot handle this special behavior, it seems.
740 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
741 || running_font.language()->lang() == "arabic_arabtex";
742 if (open_font && inset->noFontChange()) {
743 bool closeLanguage = arabtex
744 || basefont.isRightToLeft() == running_font.isRightToLeft();
745 unsigned int count = running_font.latexWriteEndChanges(os,
746 bparams, runparams, basefont, basefont, closeLanguage);
748 // if any font properties were closed, update the running_font,
749 // making sure, however, to leave the language as it was
751 // FIXME: probably a better way to keep track of the old
752 // language, than copying the entire font?
753 Font const copy_font(running_font);
754 basefont = owner_->getLayoutFont(bparams, outerfont);
755 running_font = basefont;
757 running_font.setLanguage(copy_font.language());
758 // leave font open if language is still open
759 open_font = (running_font.language() == basefont.language());
761 runparams.local_font = &basefont;
765 int tmp = inset->latex(buf, os, runparams);
768 if (running_font.language()->lang() == "farsi")
775 for (int j = 0; j < tmp; ++j)
778 texrow.start(owner_->id(), i + 1);
781 column += os.tellp() - len;
784 if (owner_->lookupChange(i).type == Change::DELETED)
785 --runparams.inDeletedInset;
789 void Paragraph::Private::latexSpecialChar(
791 OutputParams & runparams,
793 Change & running_change,
794 Layout const & style,
796 unsigned int & column)
798 char_type const c = text_[i];
800 if (style.pass_thru) {
802 // FIXME UNICODE: This can fail if c cannot
803 // be encoded in the current encoding.
808 if (runparams.verbatim) {
813 if (lyxrc.fontenc == "T1" && latexSpecialT1(c, os, i, column))
816 if (running_font.family() == Font::TYPEWRITER_FAMILY
817 && latexSpecialTypewriter(c, os, i, column))
820 // Otherwise, we use what LaTeX provides us.
823 os << "\\textbackslash{}";
827 os << "\\textless{}";
831 os << "\\textgreater{}";
842 os << "\\char`\\\"{}";
847 case '%': case '#': case '{':
855 os << "\\textasciitilde{}";
860 os << "\\textasciicircum{}";
865 // avoid being mistaken for optional arguments
873 // Blanks are printed before font switching.
874 // Sure? I am not! (try nice-latex)
875 // I am sure it's correct. LyX might be smarter
876 // in the future, but for now, nothing wrong is
883 if (latexSpecialPhrase(os, i, column))
889 Encoding const & encoding = *(runparams.encoding);
890 if (i + 1 < int(text_.size())) {
891 char_type next = text_[i + 1];
892 if (Encodings::isCombiningChar(next)) {
893 column += latexSurrogatePair(os, c, next, encoding) - 1;
899 docstring const latex = encoding.latexChar(c);
900 if (Encodings::isKnownScriptChar(c, script)
901 && prefixIs(latex, from_ascii("\\" + script)))
902 column += writeScriptChars(os, c, latex,
903 running_change, encoding, i) - 1;
904 else if (latex.length() > 1 && latex[latex.length() - 1] != '}') {
905 // Prevent eating of a following
906 // space or command corruption by
907 // following characters
908 column += latex.length() + 1;
911 column += latex.length() - 1;
919 bool Paragraph::Private::latexSpecialT1(char_type const c, odocstream & os,
920 pos_type & i, unsigned int & column)
926 // In T1 encoding, these characters exist
927 // but we should avoid ligatures
928 if (i + 1 > int(text_.size()) || text_[i + 1] != c)
933 //os << "\\textcompwordmark{}";
945 bool Paragraph::Private::latexSpecialTypewriter(char_type const c, odocstream & os,
946 pos_type & i, unsigned int & column)
950 if (i + 1 < int(text_.size()) && text_[i + 1] == '-') {
951 // "--" in Typewriter mode -> "-{}-"
958 // I assume this is hack treating typewriter as verbatim
959 // FIXME UNICODE: This can fail if c cannot be encoded
960 // in the current encoding.
965 // Those characters are not directly supported.
969 case '%': case '#': case '{':
978 // With Typewriter font, these characters exist.
985 bool Paragraph::Private::latexSpecialPhrase(odocstream & os, pos_type & i,
986 unsigned int & column)
988 // FIXME: if we have "LaTeX" with a font
989 // change in the middle (before the 'T', then
990 // the "TeX" part is still special cased.
991 // Really we should only operate this on
992 // "words" for some definition of word
994 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
995 if (!isTextAt(special_phrases[pnr].phrase, i))
997 os << special_phrases[pnr].macro;
998 i += special_phrases[pnr].phrase.length() - 1;
999 column += special_phrases[pnr].macro.length() - 1;
1006 void Paragraph::Private::validate(LaTeXFeatures & features,
1007 Layout const & layout) const
1009 // check the params.
1010 if (!params_.spacing().isDefault())
1011 features.require("setspace");
1014 features.useLayout(layout.name());
1017 fontlist_.validate(features);
1019 // then the indentation
1020 if (!params_.leftIndent().zero())
1021 features.require("ParagraphLeftIndent");
1024 InsetList::const_iterator icit = insetlist_.begin();
1025 InsetList::const_iterator iend = insetlist_.end();
1026 for (; icit != iend; ++icit) {
1028 icit->inset->validate(features);
1029 if (layout.needprotect &&
1030 icit->inset->lyxCode() == FOOT_CODE)
1031 features.require("NeedLyXFootnoteCode");
1035 // then the contents
1036 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1037 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1038 if (!special_phrases[pnr].builtin
1039 && isTextAt(special_phrases[pnr].phrase, i)) {
1040 features.require(special_phrases[pnr].phrase);
1044 Encodings::validate(text_[i], features);
1048 /////////////////////////////////////////////////////////////////////
1052 /////////////////////////////////////////////////////////////////////
1054 Paragraph::Paragraph()
1055 : d(new Paragraph::Private(this))
1062 Paragraph::Paragraph(Paragraph const & par)
1063 : itemdepth(par.itemdepth),
1064 d(new Paragraph::Private(*par.d, this))
1069 Paragraph & Paragraph::operator=(Paragraph const & par)
1071 // needed as we will destroy the private part before copying it
1073 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 char_type const c = d->text_[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() && d->text_[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(char_type c, Font const & font,
1205 Change const & change)
1208 d->changes_.insert(change, d->text_.size());
1209 // when appending characters, no need to update tables
1210 d->text_.push_back(c);
1211 setFont(d->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 = d->text_.size();
1220 size_t newsize = oldsize + end;
1221 size_t capacity = d->text_.capacity();
1222 if (newsize >= capacity)
1223 d->text_.reserve(std::max(capacity + 100, newsize));
1225 // when appending characters, no need to update tables
1228 // FIXME: Optimize this!
1229 for (pos_type i = 0; i != end; ++i) {
1231 d->changes_.insert(change, i);
1233 d->fontlist_.setRange(oldsize, newsize, font);
1237 void Paragraph::insertChar(pos_type pos, char_type c,
1240 d->insertChar(pos, c, Change(trackChanges ?
1241 Change::INSERTED : Change::UNCHANGED));
1245 void Paragraph::insertChar(pos_type pos, char_type c,
1246 Font const & font, bool trackChanges)
1248 d->insertChar(pos, c, Change(trackChanges ?
1249 Change::INSERTED : Change::UNCHANGED));
1254 void Paragraph::insertChar(pos_type pos, char_type c,
1255 Font const & font, Change const & change)
1257 d->insertChar(pos, c, change);
1262 void Paragraph::insertInset(pos_type pos, Inset * inset,
1263 Font const & font, Change const & change)
1265 insertInset(pos, inset, change);
1266 // Set the font/language of the inset...
1271 bool Paragraph::insetAllowed(InsetCode code)
1273 return !d->inset_owner_ || d->inset_owner_->insetAllowed(code);
1277 // Gets uninstantiated font setting at position.
1278 Font const Paragraph::getFontSettings(BufferParams const & bparams,
1282 lyxerr << " pos: " << pos << " size: " << size() << endl;
1283 BOOST_ASSERT(pos <= size());
1286 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1287 if (cit != d->fontlist_.end())
1290 if (pos == size() && !empty())
1291 return getFontSettings(bparams, pos - 1);
1293 return Font(Font::ALL_INHERIT, getParLanguage(bparams));
1297 FontSpan Paragraph::fontSpan(pos_type pos) const
1299 BOOST_ASSERT(pos <= size());
1302 FontList::const_iterator cit = d->fontlist_.begin();
1303 FontList::const_iterator end = d->fontlist_.end();
1304 for (; cit != end; ++cit) {
1305 if (cit->pos() >= pos) {
1306 if (pos >= beginOfBody())
1307 return FontSpan(std::max(start, beginOfBody()),
1310 return FontSpan(start,
1311 std::min(beginOfBody() - 1,
1314 start = cit->pos() + 1;
1317 // This should not happen, but if so, we take no chances.
1318 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
1320 return FontSpan(pos, pos);
1324 // Gets uninstantiated font setting at position 0
1325 Font const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1327 if (!empty() && !d->fontlist_.empty())
1328 return d->fontlist_.begin()->font();
1330 return Font(Font::ALL_INHERIT, bparams.language);
1334 // Gets the fully instantiated font at a given position in a paragraph
1335 // This is basically the same function as Text::GetFont() in text2.cpp.
1336 // The difference is that this one is used for generating the LaTeX file,
1337 // and thus cosmetic "improvements" are disallowed: This has to deliver
1338 // the true picture of the buffer. (Asger)
1339 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1340 Font const & outerfont) const
1342 BOOST_ASSERT(pos >= 0);
1344 Font font = getFontSettings(bparams, pos);
1346 pos_type const body_pos = beginOfBody();
1348 font.realize(d->layout_->labelfont);
1350 font.realize(d->layout_->font);
1352 font.realize(outerfont);
1353 font.realize(bparams.getFont());
1359 Font const Paragraph::getLabelFont
1360 (BufferParams const & bparams, Font const & outerfont) const
1362 Font tmpfont = layout()->labelfont;
1363 tmpfont.setLanguage(getParLanguage(bparams));
1364 tmpfont.realize(outerfont);
1365 tmpfont.realize(bparams.getFont());
1370 Font const Paragraph::getLayoutFont
1371 (BufferParams const & bparams, Font const & outerfont) const
1373 Font tmpfont = layout()->font;
1374 tmpfont.setLanguage(getParLanguage(bparams));
1375 tmpfont.realize(outerfont);
1376 tmpfont.realize(bparams.getFont());
1381 /// Returns the height of the highest font in range
1382 Font_size Paragraph::highestFontInRange
1383 (pos_type startpos, pos_type endpos, Font_size def_size) const
1385 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1390 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1392 char_type c = d->text_[pos];
1393 if (!lyxrc.rtl_support)
1423 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1430 void Paragraph::setFont(pos_type pos, Font const & font)
1432 BOOST_ASSERT(pos <= size());
1434 // First, reduce font against layout/label font
1435 // Update: The setCharFont() routine in text2.cpp already
1436 // reduces font, so we don't need to do that here. (Asger)
1438 d->fontlist_.set(pos, font);
1442 void Paragraph::makeSameLayout(Paragraph const & par)
1444 layout(par.layout());
1446 d->params_ = par.params();
1450 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1452 if (isFreeSpacing())
1458 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1459 if (eraseChar(pos, trackChanges))
1465 return count > 0 || pos > 0;
1469 bool Paragraph::hasSameLayout(Paragraph const & par) const
1471 return par.layout() == layout() && d->params_.sameLayout(par.params());
1475 depth_type Paragraph::getDepth() const
1477 return params().depth();
1481 depth_type Paragraph::getMaxDepthAfter() const
1483 if (layout()->isEnvironment())
1484 return params().depth() + 1;
1486 return params().depth();
1490 char Paragraph::getAlign() const
1492 if (params().align() == LYX_ALIGN_LAYOUT)
1493 return layout()->align;
1495 return params().align();
1499 docstring const & Paragraph::getLabelstring() const
1501 return params().labelString();
1505 // the next two functions are for the manual labels
1506 docstring const Paragraph::getLabelWidthString() const
1508 if (layout()->margintype == MARGIN_MANUAL)
1509 return params().labelWidthString();
1511 return _("Senseless with this layout!");
1515 void Paragraph::setLabelWidthString(docstring const & s)
1517 params().labelWidthString(s);
1521 docstring const Paragraph::translateIfPossible(docstring const & s,
1522 BufferParams const & bparams) const
1524 if (!support::isAscii(s) || s.empty()) {
1525 // This must be a user defined layout. We cannot translate
1526 // this, since gettext accepts only ascii keys.
1529 // Probably standard layout, try to translate
1530 Messages & m = getMessages(getParLanguage(bparams)->code());
1531 return m.get(to_ascii(s));
1535 docstring Paragraph::expandLabel(LayoutPtr const & layout,
1536 BufferParams const & bparams, bool process_appendix) const
1538 TextClass const & tclass = bparams.getTextClass();
1541 if (process_appendix && params().appendix())
1542 fmt = translateIfPossible(layout->labelstring_appendix(),
1545 fmt = translateIfPossible(layout->labelstring(), bparams);
1547 if (fmt.empty() && layout->labeltype == LABEL_COUNTER
1548 && !layout->counter.empty())
1549 fmt = "\\the" + layout->counter;
1551 // handle 'inherited level parts' in 'fmt',
1552 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
1553 size_t const i = fmt.find('@', 0);
1554 if (i != docstring::npos) {
1555 size_t const j = fmt.find('@', i + 1);
1556 if (j != docstring::npos) {
1557 docstring parent(fmt, i + 1, j - i - 1);
1558 docstring label = from_ascii("??");
1559 if (tclass.hasLayout(parent))
1560 docstring label = expandLabel(tclass[parent], bparams,
1562 fmt = docstring(fmt, 0, i) + label
1563 + docstring(fmt, j + 1, docstring::npos);
1567 return tclass.counters().counterLabel(fmt);
1571 void Paragraph::applyLayout(LayoutPtr const & new_layout)
1574 LyXAlignment const oldAlign = params().align();
1576 if (!(oldAlign & layout()->alignpossible)) {
1577 frontend::Alert::warning(_("Alignment not permitted"),
1578 _("The new layout does not permit the alignment previously used.\nSetting to default."));
1579 params().align(LYX_ALIGN_LAYOUT);
1584 pos_type Paragraph::beginOfBody() const
1586 return d->begin_of_body_;
1590 void Paragraph::setBeginOfBody()
1592 if (layout()->labeltype != LABEL_MANUAL) {
1593 d->begin_of_body_ = 0;
1597 // Unroll the first two cycles of the loop
1598 // and remember the previous character to
1599 // remove unnecessary getChar() calls
1601 pos_type end = size();
1602 if (i < end && !isNewline(i)) {
1604 char_type previous_char = 0;
1607 previous_char = d->text_[i];
1608 if (!isNewline(i)) {
1610 while (i < end && previous_char != ' ') {
1615 previous_char = temp;
1621 d->begin_of_body_ = i;
1625 bool Paragraph::forceDefaultParagraphs() const
1627 return inInset() && inInset()->forceDefaultParagraphs(0);
1633 // paragraphs inside floats need different alignment tags to avoid
1636 bool noTrivlistCentering(InsetCode code)
1638 return code == FLOAT_CODE || code == WRAP_CODE;
1642 string correction(string const & orig)
1644 if (orig == "flushleft")
1645 return "raggedright";
1646 if (orig == "flushright")
1647 return "raggedleft";
1648 if (orig == "center")
1654 string const corrected_env(string const & suffix, string const & env,
1657 string output = suffix + "{";
1658 if (noTrivlistCentering(code))
1659 output += correction(env);
1663 if (suffix == "\\begin")
1669 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1671 if (!contains(str, "\n"))
1672 column += str.size();
1676 column = rsplit(str, tmp, '\n').size();
1683 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
1684 odocstream & os, TexRow & texrow,
1685 bool moving_arg) const
1689 if (params_.noindent()) {
1690 os << "\\noindent ";
1694 LyXAlignment const curAlign = params_.align();
1696 if (curAlign == layout_->align)
1700 case LYX_ALIGN_NONE:
1701 case LYX_ALIGN_BLOCK:
1702 case LYX_ALIGN_LAYOUT:
1703 case LYX_ALIGN_SPECIAL:
1705 case LYX_ALIGN_LEFT:
1706 case LYX_ALIGN_RIGHT:
1707 case LYX_ALIGN_CENTER:
1716 case LYX_ALIGN_NONE:
1717 case LYX_ALIGN_BLOCK:
1718 case LYX_ALIGN_LAYOUT:
1719 case LYX_ALIGN_SPECIAL:
1721 case LYX_ALIGN_LEFT: {
1723 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1724 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1726 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1727 os << from_ascii(output);
1728 adjust_row_column(output, texrow, column);
1730 } case LYX_ALIGN_RIGHT: {
1732 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1733 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1735 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1736 os << from_ascii(output);
1737 adjust_row_column(output, texrow, column);
1739 } case LYX_ALIGN_CENTER: {
1741 output = corrected_env("\\begin", "center", owner_->ownerCode());
1742 os << from_ascii(output);
1743 adjust_row_column(output, texrow, column);
1752 int Paragraph::Private::endTeXParParams(BufferParams const & bparams,
1753 odocstream & os, TexRow & texrow,
1754 bool moving_arg) const
1758 switch (params_.align()) {
1759 case LYX_ALIGN_NONE:
1760 case LYX_ALIGN_BLOCK:
1761 case LYX_ALIGN_LAYOUT:
1762 case LYX_ALIGN_SPECIAL:
1764 case LYX_ALIGN_LEFT:
1765 case LYX_ALIGN_RIGHT:
1766 case LYX_ALIGN_CENTER:
1774 switch (params_.align()) {
1775 case LYX_ALIGN_NONE:
1776 case LYX_ALIGN_BLOCK:
1777 case LYX_ALIGN_LAYOUT:
1778 case LYX_ALIGN_SPECIAL:
1780 case LYX_ALIGN_LEFT: {
1782 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1783 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1785 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1786 os << from_ascii(output);
1787 adjust_row_column(output, texrow, column);
1789 } case LYX_ALIGN_RIGHT: {
1791 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1792 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1794 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1795 os << from_ascii(output);
1796 adjust_row_column(output, texrow, column);
1798 } case LYX_ALIGN_CENTER: {
1800 output = corrected_env("\n\\par\\end", "center", owner_->ownerCode());
1801 os << from_ascii(output);
1802 adjust_row_column(output, texrow, column);
1811 // This one spits out the text of the paragraph
1812 bool Paragraph::latex(Buffer const & buf,
1813 BufferParams const & bparams,
1814 Font const & outerfont,
1815 odocstream & os, TexRow & texrow,
1816 OutputParams const & runparams) const
1818 LYXERR(Debug::LATEX) << "SimpleTeXOnePar... " << this << endl;
1820 bool return_value = false;
1824 // well we have to check if we are in an inset with unlimited
1825 // length (all in one row) if that is true then we don't allow
1826 // any special options in the paragraph and also we don't allow
1827 // any environment other than the default layout of the text class
1829 bool asdefault = forceDefaultParagraphs();
1832 style = bparams.getTextClass().defaultLayout();
1837 // Current base font for all inherited font changes, without any
1838 // change caused by an individual character, except for the language:
1839 // It is set to the language of the first character.
1840 // As long as we are in the label, this font is the base font of the
1841 // label. Before the first body character it is set to the base font
1845 // Maybe we have to create a optional argument.
1846 pos_type body_pos = beginOfBody();
1847 unsigned int column = 0;
1850 // the optional argument is kept in curly brackets in
1851 // case it contains a ']'
1854 basefont = getLabelFont(bparams, outerfont);
1856 basefont = getLayoutFont(bparams, outerfont);
1859 // Which font is currently active?
1860 Font running_font(basefont);
1861 // Do we have an open font change?
1862 bool open_font = false;
1864 Change runningChange = Change(Change::UNCHANGED);
1866 texrow.start(id(), 0);
1868 // if the paragraph is empty, the loop will not be entered at all
1870 if (style->isCommand()) {
1875 column += d->startTeXParParams(bparams, os, texrow,
1876 runparams.moving_arg);
1879 for (pos_type i = 0; i < size(); ++i) {
1880 // First char in paragraph or after label?
1881 if (i == body_pos) {
1884 column += running_font.latexWriteEndChanges(
1885 os, bparams, runparams,
1886 basefont, basefont);
1889 basefont = getLayoutFont(bparams, outerfont);
1890 running_font = basefont;
1892 column += Changes::latexMarkChange(os, bparams,
1893 runningChange, Change(Change::UNCHANGED));
1894 runningChange = Change(Change::UNCHANGED);
1899 if (style->isCommand()) {
1905 column += d->startTeXParParams(bparams, os,
1907 runparams.moving_arg);
1910 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
1913 if (bparams.outputChanges && runningChange != change) {
1915 column += running_font.latexWriteEndChanges(
1916 os, bparams, runparams, basefont, basefont);
1919 basefont = getLayoutFont(bparams, outerfont);
1920 running_font = basefont;
1922 column += Changes::latexMarkChange(os, bparams, runningChange, change);
1923 runningChange = change;
1926 // do not output text which is marked deleted
1927 // if change tracking output is disabled
1928 if (!bparams.outputChanges && change.type == Change::DELETED) {
1934 // Fully instantiated font
1935 Font const font = getFont(bparams, i, outerfont);
1937 Font const last_font = running_font;
1939 // Do we need to close the previous font?
1941 (font != running_font ||
1942 font.language() != running_font.language()))
1944 column += running_font.latexWriteEndChanges(
1945 os, bparams, runparams, basefont,
1946 (i == body_pos-1) ? basefont : font);
1947 running_font = basefont;
1951 // Switch file encoding if necessary (and allowed)
1952 if (!runparams.verbatim &&
1953 runparams.encoding->package() == Encoding::inputenc &&
1954 font.language()->encoding()->package() == Encoding::inputenc) {
1955 std::pair<bool, int> const enc_switch = switchEncoding(os, bparams,
1956 runparams.moving_arg, *(runparams.encoding),
1957 *(font.language()->encoding()));
1958 if (enc_switch.first) {
1959 column += enc_switch.second;
1960 runparams.encoding = font.language()->encoding();
1964 char_type const c = d->text_[i];
1966 // Do we need to change font?
1967 if ((font != running_font ||
1968 font.language() != running_font.language()) &&
1971 odocstringstream ods;
1972 column += font.latexWriteStartChanges(ods, bparams,
1973 runparams, basefont,
1975 running_font = font;
1977 docstring fontchange = ods.str();
1978 // check if the fontchange ends with a trailing blank
1979 // (like "\small " (see bug 3382)
1980 if (suffixIs(fontchange, ' ') && c == ' ')
1981 os << fontchange.substr(0, fontchange.size() - 1)
1982 << from_ascii("{}");
1988 // FIXME: integrate this case in latexSpecialChar
1989 // Do not print the separation of the optional argument
1990 // if style->pass_thru is false. This works because
1991 // latexSpecialChar ignores spaces if
1992 // style->pass_thru is false.
1993 if (i != body_pos - 1) {
1994 if (d->simpleTeXBlanks(
1995 *(runparams.encoding), os, texrow,
1996 i, column, font, *style)) {
1997 // A surrogate pair was output. We
1998 // must not call latexSpecialChar
1999 // in this iteration, since it would output
2000 // the combining character again.
2007 OutputParams rp = runparams;
2008 rp.free_spacing = style->free_spacing;
2009 rp.local_font = &font;
2010 rp.intitle = style->intitle;
2012 // Two major modes: LaTeX or plain
2013 // Handle here those cases common to both modes
2014 // and then split to handle the two modes separately.
2015 if (c == META_INSET)
2016 d->latexInset(buf, bparams, os,
2017 texrow, rp, running_font,
2018 basefont, outerfont, open_font,
2019 runningChange, *style, i, column);
2021 d->latexSpecialChar(os, rp, running_font, runningChange,
2024 // Set the encoding to that returned from simpleTeXSpecialChars (see
2025 // comment for encoding member in OutputParams.h)
2026 runparams.encoding = rp.encoding;
2029 // If we have an open font definition, we have to close it
2031 #ifdef FIXED_LANGUAGE_END_DETECTION
2034 .latexWriteEndChanges(os, bparams, runparams,
2036 next_->getFont(bparams, 0, outerfont));
2038 running_font.latexWriteEndChanges(os, bparams,
2039 runparams, basefont, basefont);
2042 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2043 //FIXME: there as we start another \selectlanguage with the next paragraph if
2044 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2045 running_font.latexWriteEndChanges(os, bparams, runparams,
2046 basefont, basefont);
2050 column += Changes::latexMarkChange(os, bparams, runningChange, Change(Change::UNCHANGED));
2052 // Needed if there is an optional argument but no contents.
2053 if (body_pos > 0 && body_pos == size()) {
2055 return_value = false;
2059 column += d->endTeXParParams(bparams, os, texrow,
2060 runparams.moving_arg);
2063 LYXERR(Debug::LATEX) << "SimpleTeXOnePar...done " << this << endl;
2064 return return_value;
2068 bool Paragraph::emptyTag() const
2070 for (pos_type i = 0; i < size(); ++i) {
2072 Inset const * inset = getInset(i);
2073 InsetCode lyx_code = inset->lyxCode();
2074 if (lyx_code != TOC_CODE &&
2075 lyx_code != INCLUDE_CODE &&
2076 lyx_code != GRAPHICS_CODE &&
2077 lyx_code != ERT_CODE &&
2078 lyx_code != LISTINGS_CODE &&
2079 lyx_code != FLOAT_CODE &&
2080 lyx_code != TABULAR_CODE) {
2084 char_type c = d->text_[i];
2085 if (c != ' ' && c != '\t')
2093 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
2095 for (pos_type i = 0; i < size(); ++i) {
2097 Inset const * inset = getInset(i);
2098 InsetCode lyx_code = inset->lyxCode();
2099 if (lyx_code == LABEL_CODE) {
2100 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2101 docstring const & id = il->getParam("name");
2102 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2111 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
2114 for (i = 0; i < size(); ++i) {
2116 Inset const * inset = getInset(i);
2117 inset->docbook(buf, os, runparams);
2119 char_type c = d->text_[i];
2122 os << sgml::escapeChar(c);
2129 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2132 pos_type size = text_.size();
2133 for (pos_type i = initial; i < size; ++i) {
2134 Font font = owner_->getFont(buf.params(), i, outerfont);
2135 if (text_[i] == META_INSET)
2137 if (i != initial && font != font_old)
2146 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2148 OutputParams const & runparams,
2149 Font const & outerfont,
2150 pos_type initial) const
2152 bool emph_flag = false;
2154 LayoutPtr const & style = layout();
2156 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
2158 if (style->pass_thru && !d->onlyText(buf, outerfont, initial))
2161 // parsing main loop
2162 for (pos_type i = initial; i < size(); ++i) {
2163 Font font = getFont(buf.params(), i, outerfont);
2165 // handle <emphasis> tag
2166 if (font_old.emph() != font.emph()) {
2167 if (font.emph() == Font::ON) {
2170 } else if (i != initial) {
2171 os << "</emphasis>";
2177 Inset const * inset = getInset(i);
2178 inset->docbook(buf, os, runparams);
2180 char_type c = d->text_[i];
2182 if (style->pass_thru)
2185 os << sgml::escapeChar(c);
2191 os << "</emphasis>";
2194 if (style->free_spacing)
2196 if (style->pass_thru && !d->onlyText(buf, outerfont, initial))
2201 bool Paragraph::isHfill(pos_type pos) const
2204 && getInset(pos)->lyxCode() == HFILL_CODE;
2208 bool Paragraph::isNewline(pos_type pos) const
2211 && getInset(pos)->lyxCode() == NEWLINE_CODE;
2215 bool Paragraph::isLineSeparator(pos_type pos) const
2217 char_type const c = d->text_[pos];
2218 return isLineSeparatorChar(c)
2219 || (c == META_INSET && getInset(pos) &&
2220 getInset(pos)->isLineSeparator());
2224 /// Used by the spellchecker
2225 bool Paragraph::isLetter(pos_type pos) const
2228 return getInset(pos)->isLetter();
2230 char_type const c = d->text_[pos];
2231 return isLetterChar(c) || isDigit(c);
2237 Paragraph::getParLanguage(BufferParams const & bparams) const
2240 return getFirstFontSettings(bparams).language();
2241 // FIXME: we should check the prev par as well (Lgb)
2242 return bparams.language;
2246 bool Paragraph::isRTL(BufferParams const & bparams) const
2248 return lyxrc.rtl_support
2249 && getParLanguage(bparams)->rightToLeft()
2250 && ownerCode() != ERT_CODE
2251 && ownerCode() != LISTINGS_CODE;
2255 void Paragraph::changeLanguage(BufferParams const & bparams,
2256 Language const * from, Language const * to)
2258 // change language including dummy font change at the end
2259 for (pos_type i = 0; i <= size(); ++i) {
2260 Font font = getFontSettings(bparams, i);
2261 if (font.language() == from) {
2262 font.setLanguage(to);
2269 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2271 Language const * doc_language = bparams.language;
2272 FontList::const_iterator cit = d->fontlist_.begin();
2273 FontList::const_iterator end = d->fontlist_.end();
2275 for (; cit != end; ++cit)
2276 if (cit->font().language() != ignore_language &&
2277 cit->font().language() != latex_language &&
2278 cit->font().language() != doc_language)
2284 // Convert the paragraph to a string.
2285 // Used for building the table of contents
2286 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
2288 return asString(buffer, 0, size(), label);
2292 docstring const Paragraph::asString(Buffer const & buffer,
2293 pos_type beg, pos_type end, bool label) const
2296 odocstringstream os;
2298 if (beg == 0 && label && !params().labelString().empty())
2299 os << params().labelString() << ' ';
2301 for (pos_type i = beg; i < end; ++i) {
2302 char_type const c = d->text_[i];
2305 else if (c == META_INSET)
2306 getInset(i)->textString(buffer, os);
2313 void Paragraph::setInsetOwner(Inset * inset)
2315 d->inset_owner_ = inset;
2319 int Paragraph::id() const
2325 LayoutPtr const & Paragraph::layout() const
2331 void Paragraph::layout(LayoutPtr const & new_layout)
2333 d->layout_ = new_layout;
2337 Inset * Paragraph::inInset() const
2339 return d->inset_owner_;
2343 InsetCode Paragraph::ownerCode() const
2345 return d->inset_owner_ ?
2346 d->inset_owner_->lyxCode() : NO_CODE;
2350 ParagraphParameters & Paragraph::params()
2356 ParagraphParameters const & Paragraph::params() const
2362 bool Paragraph::isFreeSpacing() const
2364 if (layout()->free_spacing)
2366 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
2370 bool Paragraph::allowEmpty() const
2372 if (layout()->keepempty)
2374 return d->inset_owner_ && d->inset_owner_->allowEmpty();
2378 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2380 if (!Encodings::is_arabic(c))
2383 char_type prev_char = ' ';
2384 char_type next_char = ' ';
2386 for (pos_type i = pos - 1; i >= 0; --i) {
2387 char_type const par_char = d->text_[i];
2388 if (!Encodings::isComposeChar_arabic(par_char)) {
2389 prev_char = par_char;
2394 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2395 char_type const par_char = d->text_[i];
2396 if (!Encodings::isComposeChar_arabic(par_char)) {
2397 next_char = par_char;
2402 if (Encodings::is_arabic(next_char)) {
2403 if (Encodings::is_arabic(prev_char) &&
2404 !Encodings::is_arabic_special(prev_char))
2405 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2407 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2409 if (Encodings::is_arabic(prev_char) &&
2410 !Encodings::is_arabic_special(prev_char))
2411 return Encodings::transformChar(c, Encodings::FORM_FINAL);
2413 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2418 int Paragraph::checkBiblio(bool track_changes)
2421 //This is getting more and more a mess. ...We really should clean
2422 //up this bibitem issue for 1.6. See also bug 2743.
2424 // Add bibitem insets if necessary
2425 if (layout()->labeltype != LABEL_BIBLIO)
2428 bool hasbibitem = !d->insetlist_.empty()
2429 // Insist on it being in pos 0
2430 && d->text_[0] == META_INSET
2431 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2436 // remove a bibitem in pos != 0
2437 // restore it later in pos 0 if necessary
2438 // (e.g. if a user inserts contents _before_ the item)
2439 // we're assuming there's only one of these, which there
2441 int erasedInsetPosition = -1;
2442 InsetList::iterator it = d->insetlist_.begin();
2443 InsetList::iterator end = d->insetlist_.end();
2444 for (; it != end; ++it)
2445 if (it->inset->lyxCode() == BIBITEM_CODE
2447 InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2448 oldkey = olditem->getParam("key");
2449 oldlabel = olditem->getParam("label");
2450 erasedInsetPosition = it->pos;
2451 eraseChar(erasedInsetPosition, track_changes);
2455 //There was an InsetBibitem at the beginning, and we didn't
2456 //have to erase one.
2457 if (hasbibitem && erasedInsetPosition < 0)
2460 //There was an InsetBibitem at the beginning and we did have to
2461 //erase one. So we give its properties to the beginning inset.
2463 InsetBibitem * inset =
2464 static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2465 if (!oldkey.empty())
2466 inset->setParam("key", oldkey);
2467 inset->setParam("label", oldlabel);
2468 return -erasedInsetPosition;
2471 //There was no inset at the beginning, so we need to create one with
2472 //the key and label of the one we erased.
2473 InsetBibitem * inset(new InsetBibitem(InsetCommandParams(BIBITEM_CODE)));
2474 // restore values of previously deleted item in this par.
2475 if (!oldkey.empty())
2476 inset->setParam("key", oldkey);
2477 inset->setParam("label", oldlabel);
2478 insertInset(0, static_cast<Inset *>(inset),
2479 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2485 void Paragraph::checkAuthors(AuthorList const & authorList)
2487 d->changes_.checkAuthors(authorList);
2491 bool Paragraph::isUnchanged(pos_type pos) const
2493 return lookupChange(pos).type == Change::UNCHANGED;
2497 bool Paragraph::isInserted(pos_type pos) const
2499 return lookupChange(pos).type == Change::INSERTED;
2503 bool Paragraph::isDeleted(pos_type pos) const
2505 return lookupChange(pos).type == Change::DELETED;
2509 InsetList const & Paragraph::insetList() const
2511 return d->insetlist_;
2515 Inset * Paragraph::releaseInset(pos_type pos)
2517 Inset * inset = d->insetlist_.release(pos);
2518 /// does not honour change tracking!
2519 eraseChar(pos, false);
2524 Inset * Paragraph::getInset(pos_type pos)
2526 return d->insetlist_.get(pos);
2530 Inset const * Paragraph::getInset(pos_type pos) const
2532 return d->insetlist_.get(pos);
2536 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
2537 pos_type right, TextCase action)
2539 // process sequences of modified characters; in change
2540 // tracking mode, this approach results in much better
2541 // usability than changing case on a char-by-char basis
2544 bool const trackChanges = bparams.trackChanges;
2546 bool capitalize = true;
2548 for (; pos < right; ++pos) {
2549 char_type oldChar = d->text_[pos];
2550 char_type newChar = oldChar;
2552 // ignore insets and don't play with deleted text!
2553 if (oldChar != META_INSET && !isDeleted(pos)) {
2555 case text_lowercase:
2556 newChar = lowercase(oldChar);
2558 case text_capitalization:
2560 newChar = uppercase(oldChar);
2564 case text_uppercase:
2565 newChar = uppercase(oldChar);
2570 if (!isLetter(pos) || isDeleted(pos)) {
2571 // permit capitalization again
2575 if (oldChar != newChar)
2578 if (oldChar == newChar || pos == right - 1) {
2579 if (oldChar != newChar) {
2580 // step behind the changing area
2583 int erasePos = pos - changes.size();
2584 for (size_t i = 0; i < changes.size(); i++) {
2585 insertChar(pos, changes[i],
2586 getFontSettings(bparams,
2589 if (!eraseChar(erasePos, trackChanges)) {
2592 ++right; // expand selection
2601 bool Paragraph::find(docstring const & str, bool cs, bool mw,
2602 pos_type pos, bool del) const
2604 int const strsize = str.length();
2606 pos_type const parsize = d->text_.size();
2607 for (i = 0; pos + i < parsize; ++i) {
2610 if (cs && str[i] != d->text_[pos + i])
2612 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos + i]))
2614 if (!del && isDeleted(pos + i))
2621 // if necessary, check whether string matches word
2623 if (pos > 0 && isLetter(pos - 1))
2625 if (pos + strsize < parsize
2626 && isLetter(pos + strsize))
2634 char_type Paragraph::getChar(pos_type pos) const
2636 return d->text_[pos];
2640 pos_type Paragraph::size() const
2642 return d->text_.size();
2646 bool Paragraph::empty() const
2648 return d->text_.empty();
2652 bool Paragraph::isInset(pos_type pos) const
2654 return d->text_[pos] == META_INSET;
2658 bool Paragraph::isSeparator(pos_type pos) const
2660 //FIXME: Are we sure this can be the only separator?
2661 return d->text_[pos] == ' ';