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"
38 #include "OutputParams.h"
39 #include "output_latex.h"
40 #include "paragraph_funcs.h"
41 #include "ParagraphParameters.h"
46 #include "frontends/alert.h"
47 #include "frontends/FontMetrics.h"
49 #include "insets/InsetBibitem.h"
50 #include "insets/InsetLabel.h"
51 #include "insets/InsetOptArg.h"
53 #include "support/lstrings.h"
54 #include "support/textutils.h"
55 #include "support/convert.h"
56 #include "support/unicode.h"
67 using support::contains;
68 using support::lowercase;
69 using support::prefixIs;
70 using support::suffixIs;
71 using support::rsplit;
72 using support::uppercase;
75 /// Inset identifier (above 0x10ffff, for ucs-4)
76 char_type const META_INSET = 0x200001;
79 /////////////////////////////////////////////////////////////////////
83 /////////////////////////////////////////////////////////////////////
85 class Paragraph::Private
89 Private(Paragraph * owner);
90 /// "Copy constructor"
91 Private(Private const &, Paragraph * owner);
94 void insertChar(pos_type pos, char_type c, Change const & change);
96 /// Output the surrogate pair formed by \p c and \p next to \p os.
97 /// \return the number of characters written.
98 int latexSurrogatePair(odocstream & os, char_type c, char_type next,
101 /// Output a space in appropriate formatting (or a surrogate pair
102 /// if the next character is a combining character).
103 /// \return whether a surrogate pair was output.
104 bool simpleTeXBlanks(OutputParams const &,
105 odocstream &, TexRow & texrow,
107 unsigned int & column,
109 Layout const & style);
111 /// Output consecutive unicode chars, belonging to the same script as
112 /// specified by the latex macro \p ltx, to \p os starting from \p c.
113 /// \return the number of characters written.
114 int writeScriptChars(odocstream & os, char_type c, docstring const & ltx,
115 Change &, Encoding const &, pos_type &);
117 /// This could go to ParagraphParameters if we want to.
118 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
121 /// This could go to ParagraphParameters if we want to.
122 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
126 void latexInset(Buffer const &, BufferParams const &,
128 TexRow & texrow, OutputParams &,
131 Font const & outerfont,
133 Change & running_change,
134 Layout const & style,
136 unsigned int & column);
139 void latexSpecialChar(
141 OutputParams & runparams,
143 Change & running_change,
144 Layout const & style,
146 unsigned int & column);
153 unsigned int & column);
155 bool latexSpecialTypewriter(
159 unsigned int & column);
161 bool latexSpecialPhrase(
164 unsigned int & column);
167 void validate(LaTeXFeatures & features,
168 Layout const & layout) const;
170 /// Checks if the paragraph contains only text and no inset or font change.
171 bool onlyText(Buffer const & buf, Font const & outerfont,
172 pos_type initial) const;
174 /// match a string against a particular point in the paragraph
175 bool isTextAt(std::string const & str, pos_type pos) const;
177 /// Which Paragraph owns us?
181 Inset * inset_owner_;
189 static unsigned int paragraph_id;
191 ParagraphParameters params_;
193 /// for recording and looking up changes
197 InsetList insetlist_;
203 pos_type begin_of_body_;
205 typedef docstring TextContainer;
214 using std::upper_bound;
215 using std::lower_bound;
219 // Initialization of the counter for the paragraph id's,
220 unsigned int Paragraph::Private::paragraph_id = 0;
224 struct special_phrase {
230 special_phrase const special_phrases[] = {
231 { "LyX", from_ascii("\\protect\\LyX{}"), false },
232 { "TeX", from_ascii("\\protect\\TeX{}"), true },
233 { "LaTeX2e", from_ascii("\\protect\\LaTeXe{}"), true },
234 { "LaTeX", from_ascii("\\protect\\LaTeX{}"), true },
237 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
242 Paragraph::Private::Private(Paragraph * owner)
243 : owner_(owner), inset_owner_(0), begin_of_body_(0)
245 id_ = paragraph_id++;
250 Paragraph::Private::Private(Private const & p, Paragraph * owner)
251 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
252 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
253 layout_(p.layout_), begin_of_body_(p.begin_of_body_), text_(p.text_)
255 id_ = paragraph_id++;
259 bool Paragraph::isChanged(pos_type start, pos_type end) const
261 BOOST_ASSERT(start >= 0 && start <= size());
262 BOOST_ASSERT(end > start && end <= size() + 1);
264 return d->changes_.isChanged(start, end);
268 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const {
269 // keep the logic here in sync with the logic of eraseChars()
275 Change change = d->changes_.lookup(size());
277 return change.type == Change::INSERTED && change.author == 0;
281 void Paragraph::setChange(Change const & change)
283 // beware of the imaginary end-of-par character!
284 d->changes_.set(change, 0, size() + 1);
287 * Propagate the change recursively - but not in case of DELETED!
289 * Imagine that your co-author makes changes in an existing inset. He
290 * sends your document to you and you come to the conclusion that the
291 * inset should go completely. If you erase it, LyX must not delete all
292 * text within the inset. Otherwise, the change tracked insertions of
293 * your co-author get lost and there is no way to restore them later.
295 * Conclusion: An inset's content should remain untouched if you delete it
298 if (change.type != Change::DELETED) {
299 for (pos_type pos = 0; pos < size(); ++pos) {
301 getInset(pos)->setChange(change);
307 void Paragraph::setChange(pos_type pos, Change const & change)
309 BOOST_ASSERT(pos >= 0 && pos <= size());
311 d->changes_.set(change, pos);
313 // see comment in setChange(Change const &) above
315 if (change.type != Change::DELETED &&
316 pos < size() && isInset(pos)) {
317 getInset(pos)->setChange(change);
322 Change const & Paragraph::lookupChange(pos_type pos) const
324 BOOST_ASSERT(pos >= 0 && pos <= size());
326 return d->changes_.lookup(pos);
330 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start,
333 BOOST_ASSERT(start >= 0 && start <= size());
334 BOOST_ASSERT(end > start && end <= size() + 1);
336 for (pos_type pos = start; pos < end; ++pos) {
337 switch (lookupChange(pos).type) {
338 case Change::UNCHANGED:
339 // accept changes in nested inset
340 if (pos < size() && isInset(pos))
341 getInset(pos)->acceptChanges(bparams);
345 case Change::INSERTED:
346 d->changes_.set(Change(Change::UNCHANGED), pos);
347 // also accept changes in nested inset
348 if (pos < size() && isInset(pos)) {
349 getInset(pos)->acceptChanges(bparams);
353 case Change::DELETED:
354 // Suppress access to non-existent
355 // "end-of-paragraph char"
357 eraseChar(pos, false);
368 void Paragraph::rejectChanges(BufferParams const & bparams,
369 pos_type start, pos_type end)
371 BOOST_ASSERT(start >= 0 && start <= size());
372 BOOST_ASSERT(end > start && end <= size() + 1);
374 for (pos_type pos = start; pos < end; ++pos) {
375 switch (lookupChange(pos).type) {
376 case Change::UNCHANGED:
377 // reject changes in nested inset
378 if (pos < size() && isInset(pos)) {
379 getInset(pos)->rejectChanges(bparams);
383 case Change::INSERTED:
384 // Suppress access to non-existent
385 // "end-of-paragraph char"
387 eraseChar(pos, false);
393 case Change::DELETED:
394 d->changes_.set(Change(Change::UNCHANGED), pos);
396 // Do NOT reject changes within a deleted inset!
397 // There may be insertions of a co-author inside of it!
405 void Paragraph::Private::insertChar(pos_type pos, char_type c,
406 Change const & change)
408 BOOST_ASSERT(pos >= 0 && pos <= int(text_.size()));
411 changes_.insert(change, pos);
413 // This is actually very common when parsing buffers (and
414 // maybe inserting ascii text)
415 if (pos == text_.size()) {
416 // when appending characters, no need to update tables
421 text_.insert(text_.begin() + pos, c);
423 // Update the font table.
424 fontlist_.increasePosAfterPos(pos);
427 insetlist_.increasePosAfterPos(pos);
431 void Paragraph::insertInset(pos_type pos, Inset * inset,
432 Change const & change)
435 BOOST_ASSERT(pos >= 0 && pos <= size());
437 d->insertChar(pos, META_INSET, change);
438 BOOST_ASSERT(d->text_[pos] == META_INSET);
440 // Add a new entry in the insetlist_.
441 d->insetlist_.insert(inset, pos);
445 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
447 BOOST_ASSERT(pos >= 0 && pos <= size());
449 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
452 Change change = d->changes_.lookup(pos);
454 // set the character to DELETED if
455 // a) it was previously unchanged or
456 // b) it was inserted by a co-author
458 if (change.type == Change::UNCHANGED ||
459 (change.type == Change::INSERTED && change.author != 0)) {
460 setChange(pos, Change(Change::DELETED));
464 if (change.type == Change::DELETED)
468 // Don't physically access the imaginary end-of-paragraph character.
469 // eraseChar() can only mark it as DELETED. A physical deletion of
470 // end-of-par must be handled externally.
476 d->changes_.erase(pos);
478 // if it is an inset, delete the inset entry
479 if (d->text_[pos] == META_INSET)
480 d->insetlist_.erase(pos);
482 d->text_.erase(d->text_.begin() + pos);
484 // Update the fontlist_
485 d->fontlist_.erase(pos);
487 // Update the insetlist_
488 d->insetlist_.decreasePosAfterPos(pos);
494 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
496 BOOST_ASSERT(start >= 0 && start <= size());
497 BOOST_ASSERT(end >= start && end <= size() + 1);
500 for (pos_type count = end - start; count; --count) {
501 if (!eraseChar(i, trackChanges))
508 int Paragraph::Private::latexSurrogatePair(odocstream & os, char_type c,
509 char_type next, Encoding const & encoding)
511 // Writing next here may circumvent a possible font change between
512 // c and next. Since next is only output if it forms a surrogate pair
513 // with c we can ignore this:
514 // A font change inside a surrogate pair does not make sense and is
515 // hopefully impossible to input.
516 // FIXME: change tracking
517 // Is this correct WRT change tracking?
518 docstring const latex1 = encoding.latexChar(next);
519 docstring const latex2 = encoding.latexChar(c);
520 os << latex1 << '{' << latex2 << '}';
521 return latex1.length() + latex2.length() + 2;
525 bool Paragraph::Private::simpleTeXBlanks(OutputParams const & runparams,
526 odocstream & os, TexRow & texrow,
528 unsigned int & column,
530 Layout const & style)
532 if (style.pass_thru || runparams.verbatim)
535 if (i + 1 < int(text_.size())) {
536 char_type next = text_[i + 1];
537 if (Encodings::isCombiningChar(next)) {
538 Encoding const & encoding = *(runparams.encoding);
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.fontInfo().family() == 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.fontInfo().family() == 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.fontInfo().family() == 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(inherit_font, 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_.set(oldsize, font);
1234 d->fontlist_.set(newsize - 1, font);
1238 void Paragraph::insertChar(pos_type pos, char_type c,
1241 d->insertChar(pos, c, Change(trackChanges ?
1242 Change::INSERTED : Change::UNCHANGED));
1246 void Paragraph::insertChar(pos_type pos, char_type c,
1247 Font const & font, bool trackChanges)
1249 d->insertChar(pos, c, Change(trackChanges ?
1250 Change::INSERTED : Change::UNCHANGED));
1255 void Paragraph::insertChar(pos_type pos, char_type c,
1256 Font const & font, Change const & change)
1258 d->insertChar(pos, c, change);
1263 void Paragraph::insertInset(pos_type pos, Inset * inset,
1264 Font const & font, Change const & change)
1266 insertInset(pos, inset, change);
1267 // Set the font/language of the inset...
1272 bool Paragraph::insetAllowed(InsetCode code)
1274 return !d->inset_owner_ || d->inset_owner_->insetAllowed(code);
1278 void Paragraph::resetFonts(Font const & font)
1280 d->fontlist_.clear();
1281 d->fontlist_.set(0, font);
1282 d->fontlist_.set(d->text_.size() - 1, font);
1285 // Gets uninstantiated font setting at position.
1286 Font const Paragraph::getFontSettings(BufferParams const & bparams,
1290 lyxerr << " pos: " << pos << " size: " << size() << endl;
1291 BOOST_ASSERT(pos <= size());
1294 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1295 if (cit != d->fontlist_.end())
1298 if (pos == size() && !empty())
1299 return getFontSettings(bparams, pos - 1);
1301 return Font(inherit_font, getParLanguage(bparams));
1305 FontSpan Paragraph::fontSpan(pos_type pos) const
1307 BOOST_ASSERT(pos <= size());
1310 FontList::const_iterator cit = d->fontlist_.begin();
1311 FontList::const_iterator end = d->fontlist_.end();
1312 for (; cit != end; ++cit) {
1313 if (cit->pos() >= pos) {
1314 if (pos >= beginOfBody())
1315 return FontSpan(std::max(start, beginOfBody()),
1318 return FontSpan(start,
1319 std::min(beginOfBody() - 1,
1322 start = cit->pos() + 1;
1325 // This should not happen, but if so, we take no chances.
1326 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
1328 return FontSpan(pos, pos);
1332 // Gets uninstantiated font setting at position 0
1333 Font const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1335 if (!empty() && !d->fontlist_.empty())
1336 return d->fontlist_.begin()->font();
1338 return Font(inherit_font, bparams.language);
1342 // Gets the fully instantiated font at a given position in a paragraph
1343 // This is basically the same function as Text::GetFont() in text2.cpp.
1344 // The difference is that this one is used for generating the LaTeX file,
1345 // and thus cosmetic "improvements" are disallowed: This has to deliver
1346 // the true picture of the buffer. (Asger)
1347 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1348 Font const & outerfont) const
1350 BOOST_ASSERT(pos >= 0);
1352 Font font = getFontSettings(bparams, pos);
1354 pos_type const body_pos = beginOfBody();
1356 font.fontInfo().realize(d->layout_->labelfont);
1358 font.fontInfo().realize(d->layout_->font);
1360 font.fontInfo().realize(outerfont.fontInfo());
1361 font.fontInfo().realize(bparams.getFont().fontInfo());
1367 Font const Paragraph::getLabelFont
1368 (BufferParams const & bparams, Font const & outerfont) const
1370 FontInfo tmpfont = layout()->labelfont;
1371 tmpfont.realize(outerfont.fontInfo());
1372 tmpfont.realize(bparams.getFont().fontInfo());
1373 return Font(tmpfont, getParLanguage(bparams));
1377 Font const Paragraph::getLayoutFont
1378 (BufferParams const & bparams, Font const & outerfont) const
1380 FontInfo tmpfont = layout()->font;
1381 tmpfont.realize(outerfont.fontInfo());
1382 tmpfont.realize(bparams.getFont().fontInfo());
1383 return Font(tmpfont, getParLanguage(bparams));
1387 /// Returns the height of the highest font in range
1388 FontSize Paragraph::highestFontInRange
1389 (pos_type startpos, pos_type endpos, FontSize def_size) const
1391 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1396 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1398 char_type c = d->text_[pos];
1399 if (!lyxrc.rtl_support)
1429 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1436 void Paragraph::setFont(pos_type pos, Font const & font)
1438 BOOST_ASSERT(pos <= size());
1440 // First, reduce font against layout/label font
1441 // Update: The setCharFont() routine in text2.cpp already
1442 // reduces font, so we don't need to do that here. (Asger)
1444 d->fontlist_.set(pos, font);
1448 void Paragraph::makeSameLayout(Paragraph const & par)
1450 layout(par.layout());
1452 d->params_ = par.params();
1456 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1458 if (isFreeSpacing())
1464 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1465 if (eraseChar(pos, trackChanges))
1471 return count > 0 || pos > 0;
1475 bool Paragraph::hasSameLayout(Paragraph const & par) const
1477 return par.layout() == layout() && d->params_.sameLayout(par.params());
1481 depth_type Paragraph::getDepth() const
1483 return params().depth();
1487 depth_type Paragraph::getMaxDepthAfter() const
1489 if (layout()->isEnvironment())
1490 return params().depth() + 1;
1492 return params().depth();
1496 char Paragraph::getAlign() const
1498 if (params().align() == LYX_ALIGN_LAYOUT)
1499 return layout()->align;
1501 return params().align();
1505 docstring const & Paragraph::getLabelstring() const
1507 return params().labelString();
1511 // the next two functions are for the manual labels
1512 docstring const Paragraph::getLabelWidthString() const
1514 if (layout()->margintype == MARGIN_MANUAL)
1515 return params().labelWidthString();
1517 return _("Senseless with this layout!");
1521 void Paragraph::setLabelWidthString(docstring const & s)
1523 params().labelWidthString(s);
1527 docstring const Paragraph::translateIfPossible(docstring const & s,
1528 BufferParams const & bparams) const
1530 if (!support::isAscii(s) || s.empty()) {
1531 // This must be a user defined layout. We cannot translate
1532 // this, since gettext accepts only ascii keys.
1535 // Probably standard layout, try to translate
1536 Messages & m = getMessages(getParLanguage(bparams)->code());
1537 return m.get(to_ascii(s));
1541 docstring Paragraph::expandLabel(LayoutPtr const & layout,
1542 BufferParams const & bparams, bool process_appendix) const
1544 TextClass const & tclass = bparams.getTextClass();
1547 if (process_appendix && params().appendix())
1548 fmt = translateIfPossible(layout->labelstring_appendix(),
1551 fmt = translateIfPossible(layout->labelstring(), bparams);
1553 if (fmt.empty() && layout->labeltype == LABEL_COUNTER
1554 && !layout->counter.empty())
1555 fmt = "\\the" + layout->counter;
1557 // handle 'inherited level parts' in 'fmt',
1558 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
1559 size_t const i = fmt.find('@', 0);
1560 if (i != docstring::npos) {
1561 size_t const j = fmt.find('@', i + 1);
1562 if (j != docstring::npos) {
1563 docstring parent(fmt, i + 1, j - i - 1);
1564 docstring label = from_ascii("??");
1565 if (tclass.hasLayout(parent))
1566 docstring label = expandLabel(tclass[parent], bparams,
1568 fmt = docstring(fmt, 0, i) + label
1569 + docstring(fmt, j + 1, docstring::npos);
1573 return tclass.counters().counterLabel(fmt);
1577 void Paragraph::applyLayout(LayoutPtr const & new_layout)
1580 LyXAlignment const oldAlign = params().align();
1582 if (!(oldAlign & layout()->alignpossible)) {
1583 frontend::Alert::warning(_("Alignment not permitted"),
1584 _("The new layout does not permit the alignment previously used.\nSetting to default."));
1585 params().align(LYX_ALIGN_LAYOUT);
1590 pos_type Paragraph::beginOfBody() const
1592 return d->begin_of_body_;
1596 void Paragraph::setBeginOfBody()
1598 if (layout()->labeltype != LABEL_MANUAL) {
1599 d->begin_of_body_ = 0;
1603 // Unroll the first two cycles of the loop
1604 // and remember the previous character to
1605 // remove unnecessary getChar() calls
1607 pos_type end = size();
1608 if (i < end && !isNewline(i)) {
1610 char_type previous_char = 0;
1613 previous_char = d->text_[i];
1614 if (!isNewline(i)) {
1616 while (i < end && previous_char != ' ') {
1621 previous_char = temp;
1627 d->begin_of_body_ = i;
1631 bool Paragraph::forceDefaultParagraphs() const
1633 return inInset() && inInset()->forceDefaultParagraphs(0);
1639 // paragraphs inside floats need different alignment tags to avoid
1642 bool noTrivlistCentering(InsetCode code)
1644 return code == FLOAT_CODE || code == WRAP_CODE;
1648 string correction(string const & orig)
1650 if (orig == "flushleft")
1651 return "raggedright";
1652 if (orig == "flushright")
1653 return "raggedleft";
1654 if (orig == "center")
1660 string const corrected_env(string const & suffix, string const & env,
1663 string output = suffix + "{";
1664 if (noTrivlistCentering(code))
1665 output += correction(env);
1669 if (suffix == "\\begin")
1675 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1677 if (!contains(str, "\n"))
1678 column += str.size();
1682 column = rsplit(str, tmp, '\n').size();
1689 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
1690 odocstream & os, TexRow & texrow,
1691 bool moving_arg) const
1695 if (params_.noindent()) {
1696 os << "\\noindent ";
1700 LyXAlignment const curAlign = params_.align();
1702 if (curAlign == layout_->align)
1706 case LYX_ALIGN_NONE:
1707 case LYX_ALIGN_BLOCK:
1708 case LYX_ALIGN_LAYOUT:
1709 case LYX_ALIGN_SPECIAL:
1711 case LYX_ALIGN_LEFT:
1712 case LYX_ALIGN_RIGHT:
1713 case LYX_ALIGN_CENTER:
1722 case LYX_ALIGN_NONE:
1723 case LYX_ALIGN_BLOCK:
1724 case LYX_ALIGN_LAYOUT:
1725 case LYX_ALIGN_SPECIAL:
1727 case LYX_ALIGN_LEFT: {
1729 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1730 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1732 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1733 os << from_ascii(output);
1734 adjust_row_column(output, texrow, column);
1736 } case LYX_ALIGN_RIGHT: {
1738 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1739 output = corrected_env("\\begin", "flushright", owner_->ownerCode());
1741 output = corrected_env("\\begin", "flushleft", owner_->ownerCode());
1742 os << from_ascii(output);
1743 adjust_row_column(output, texrow, column);
1745 } case LYX_ALIGN_CENTER: {
1747 output = corrected_env("\\begin", "center", owner_->ownerCode());
1748 os << from_ascii(output);
1749 adjust_row_column(output, texrow, column);
1758 int Paragraph::Private::endTeXParParams(BufferParams const & bparams,
1759 odocstream & os, TexRow & texrow,
1760 bool moving_arg) const
1764 switch (params_.align()) {
1765 case LYX_ALIGN_NONE:
1766 case LYX_ALIGN_BLOCK:
1767 case LYX_ALIGN_LAYOUT:
1768 case LYX_ALIGN_SPECIAL:
1770 case LYX_ALIGN_LEFT:
1771 case LYX_ALIGN_RIGHT:
1772 case LYX_ALIGN_CENTER:
1780 switch (params_.align()) {
1781 case LYX_ALIGN_NONE:
1782 case LYX_ALIGN_BLOCK:
1783 case LYX_ALIGN_LAYOUT:
1784 case LYX_ALIGN_SPECIAL:
1786 case LYX_ALIGN_LEFT: {
1788 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1789 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1791 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1792 os << from_ascii(output);
1793 adjust_row_column(output, texrow, column);
1795 } case LYX_ALIGN_RIGHT: {
1797 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1798 output = corrected_env("\n\\par\\end", "flushright", owner_->ownerCode());
1800 output = corrected_env("\n\\par\\end", "flushleft", owner_->ownerCode());
1801 os << from_ascii(output);
1802 adjust_row_column(output, texrow, column);
1804 } case LYX_ALIGN_CENTER: {
1806 output = corrected_env("\n\\par\\end", "center", owner_->ownerCode());
1807 os << from_ascii(output);
1808 adjust_row_column(output, texrow, column);
1817 // This one spits out the text of the paragraph
1818 bool Paragraph::latex(Buffer const & buf,
1819 BufferParams const & bparams,
1820 Font const & outerfont,
1821 odocstream & os, TexRow & texrow,
1822 OutputParams const & runparams) const
1824 LYXERR(Debug::LATEX) << "SimpleTeXOnePar... " << this << endl;
1826 bool return_value = false;
1830 // well we have to check if we are in an inset with unlimited
1831 // length (all in one row) if that is true then we don't allow
1832 // any special options in the paragraph and also we don't allow
1833 // any environment other than the default layout of the text class
1835 bool asdefault = forceDefaultParagraphs();
1838 style = bparams.getTextClass().defaultLayout();
1843 // Current base font for all inherited font changes, without any
1844 // change caused by an individual character, except for the language:
1845 // It is set to the language of the first character.
1846 // As long as we are in the label, this font is the base font of the
1847 // label. Before the first body character it is set to the base font
1851 // Maybe we have to create a optional argument.
1852 pos_type body_pos = beginOfBody();
1853 unsigned int column = 0;
1856 // the optional argument is kept in curly brackets in
1857 // case it contains a ']'
1860 basefont = getLabelFont(bparams, outerfont);
1862 basefont = getLayoutFont(bparams, outerfont);
1865 // Which font is currently active?
1866 Font running_font(basefont);
1867 // Do we have an open font change?
1868 bool open_font = false;
1870 Change runningChange = Change(Change::UNCHANGED);
1872 texrow.start(id(), 0);
1874 // if the paragraph is empty, the loop will not be entered at all
1876 if (style->isCommand()) {
1881 column += d->startTeXParParams(bparams, os, texrow,
1882 runparams.moving_arg);
1885 for (pos_type i = 0; i < size(); ++i) {
1886 // First char in paragraph or after label?
1887 if (i == body_pos) {
1890 column += running_font.latexWriteEndChanges(
1891 os, bparams, runparams,
1892 basefont, basefont);
1895 basefont = getLayoutFont(bparams, outerfont);
1896 running_font = basefont;
1898 column += Changes::latexMarkChange(os, bparams,
1899 runningChange, Change(Change::UNCHANGED));
1900 runningChange = Change(Change::UNCHANGED);
1905 if (style->isCommand()) {
1911 column += d->startTeXParParams(bparams, os,
1913 runparams.moving_arg);
1916 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
1919 if (bparams.outputChanges && runningChange != change) {
1921 column += running_font.latexWriteEndChanges(
1922 os, bparams, runparams, basefont, basefont);
1925 basefont = getLayoutFont(bparams, outerfont);
1926 running_font = basefont;
1928 column += Changes::latexMarkChange(os, bparams, runningChange, change);
1929 runningChange = change;
1932 // do not output text which is marked deleted
1933 // if change tracking output is disabled
1934 if (!bparams.outputChanges && change.type == Change::DELETED) {
1940 // Fully instantiated font
1941 Font const font = getFont(bparams, i, outerfont);
1943 Font const last_font = running_font;
1945 // Do we need to close the previous font?
1947 (font != running_font ||
1948 font.language() != running_font.language()))
1950 column += running_font.latexWriteEndChanges(
1951 os, bparams, runparams, basefont,
1952 (i == body_pos-1) ? basefont : font);
1953 running_font = basefont;
1957 // Switch file encoding if necessary (and allowed)
1958 if (!runparams.verbatim &&
1959 runparams.encoding->package() == Encoding::inputenc &&
1960 font.language()->encoding()->package() == Encoding::inputenc) {
1961 std::pair<bool, int> const enc_switch = switchEncoding(os, bparams,
1962 runparams.moving_arg, *(runparams.encoding),
1963 *(font.language()->encoding()));
1964 if (enc_switch.first) {
1965 column += enc_switch.second;
1966 runparams.encoding = font.language()->encoding();
1970 char_type const c = d->text_[i];
1972 // Do we need to change font?
1973 if ((font != running_font ||
1974 font.language() != running_font.language()) &&
1977 odocstringstream ods;
1978 column += font.latexWriteStartChanges(ods, bparams,
1979 runparams, basefont,
1981 running_font = font;
1983 docstring fontchange = ods.str();
1984 // check if the fontchange ends with a trailing blank
1985 // (like "\small " (see bug 3382)
1986 if (suffixIs(fontchange, ' ') && c == ' ')
1987 os << fontchange.substr(0, fontchange.size() - 1)
1988 << from_ascii("{}");
1994 // FIXME: integrate this case in latexSpecialChar
1995 // Do not print the separation of the optional argument
1996 // if style->pass_thru is false. This works because
1997 // latexSpecialChar ignores spaces if
1998 // style->pass_thru is false.
1999 if (i != body_pos - 1) {
2000 if (d->simpleTeXBlanks(
2001 runparams, os, texrow,
2002 i, column, font, *style)) {
2003 // A surrogate pair was output. We
2004 // must not call latexSpecialChar
2005 // in this iteration, since it would output
2006 // the combining character again.
2013 OutputParams rp = runparams;
2014 rp.free_spacing = style->free_spacing;
2015 rp.local_font = &font;
2016 rp.intitle = style->intitle;
2018 // Two major modes: LaTeX or plain
2019 // Handle here those cases common to both modes
2020 // and then split to handle the two modes separately.
2021 if (c == META_INSET)
2022 d->latexInset(buf, bparams, os,
2023 texrow, rp, running_font,
2024 basefont, outerfont, open_font,
2025 runningChange, *style, i, column);
2027 d->latexSpecialChar(os, rp, running_font, runningChange,
2030 // Set the encoding to that returned from simpleTeXSpecialChars (see
2031 // comment for encoding member in OutputParams.h)
2032 runparams.encoding = rp.encoding;
2035 // If we have an open font definition, we have to close it
2037 #ifdef FIXED_LANGUAGE_END_DETECTION
2040 .latexWriteEndChanges(os, bparams, runparams,
2042 next_->getFont(bparams, 0, outerfont));
2044 running_font.latexWriteEndChanges(os, bparams,
2045 runparams, basefont, basefont);
2048 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2049 //FIXME: there as we start another \selectlanguage with the next paragraph if
2050 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2051 running_font.latexWriteEndChanges(os, bparams, runparams,
2052 basefont, basefont);
2056 column += Changes::latexMarkChange(os, bparams, runningChange, Change(Change::UNCHANGED));
2058 // Needed if there is an optional argument but no contents.
2059 if (body_pos > 0 && body_pos == size()) {
2061 return_value = false;
2065 column += d->endTeXParParams(bparams, os, texrow,
2066 runparams.moving_arg);
2069 LYXERR(Debug::LATEX) << "SimpleTeXOnePar...done " << this << endl;
2070 return return_value;
2074 bool Paragraph::emptyTag() const
2076 for (pos_type i = 0; i < size(); ++i) {
2078 Inset const * inset = getInset(i);
2079 InsetCode lyx_code = inset->lyxCode();
2080 if (lyx_code != TOC_CODE &&
2081 lyx_code != INCLUDE_CODE &&
2082 lyx_code != GRAPHICS_CODE &&
2083 lyx_code != ERT_CODE &&
2084 lyx_code != LISTINGS_CODE &&
2085 lyx_code != FLOAT_CODE &&
2086 lyx_code != TABULAR_CODE) {
2090 char_type c = d->text_[i];
2091 if (c != ' ' && c != '\t')
2099 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
2101 for (pos_type i = 0; i < size(); ++i) {
2103 Inset const * inset = getInset(i);
2104 InsetCode lyx_code = inset->lyxCode();
2105 if (lyx_code == LABEL_CODE) {
2106 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2107 docstring const & id = il->getParam("name");
2108 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2117 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
2120 for (i = 0; i < size(); ++i) {
2122 Inset const * inset = getInset(i);
2123 inset->docbook(buf, os, runparams);
2125 char_type c = d->text_[i];
2128 os << sgml::escapeChar(c);
2135 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2138 pos_type size = text_.size();
2139 for (pos_type i = initial; i < size; ++i) {
2140 Font font = owner_->getFont(buf.params(), i, outerfont);
2141 if (text_[i] == META_INSET)
2143 if (i != initial && font != font_old)
2152 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2154 OutputParams const & runparams,
2155 Font const & outerfont,
2156 pos_type initial) const
2158 bool emph_flag = false;
2160 LayoutPtr const & style = layout();
2162 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
2164 if (style->pass_thru && !d->onlyText(buf, outerfont, initial))
2167 // parsing main loop
2168 for (pos_type i = initial; i < size(); ++i) {
2169 Font font = getFont(buf.params(), i, outerfont);
2171 // handle <emphasis> tag
2172 if (font_old.emph() != font.fontInfo().emph()) {
2173 if (font.fontInfo().emph() == FONT_ON) {
2176 } else if (i != initial) {
2177 os << "</emphasis>";
2183 Inset const * inset = getInset(i);
2184 inset->docbook(buf, os, runparams);
2186 char_type c = d->text_[i];
2188 if (style->pass_thru)
2191 os << sgml::escapeChar(c);
2193 font_old = font.fontInfo();
2197 os << "</emphasis>";
2200 if (style->free_spacing)
2202 if (style->pass_thru && !d->onlyText(buf, outerfont, initial))
2207 bool Paragraph::isHfill(pos_type pos) const
2210 && getInset(pos)->lyxCode() == HFILL_CODE;
2214 bool Paragraph::isNewline(pos_type pos) const
2217 && getInset(pos)->lyxCode() == NEWLINE_CODE;
2221 bool Paragraph::isLineSeparator(pos_type pos) const
2223 char_type const c = d->text_[pos];
2224 return isLineSeparatorChar(c)
2225 || (c == META_INSET && getInset(pos) &&
2226 getInset(pos)->isLineSeparator());
2230 /// Used by the spellchecker
2231 bool Paragraph::isLetter(pos_type pos) const
2234 return getInset(pos)->isLetter();
2236 char_type const c = d->text_[pos];
2237 return isLetterChar(c) || isDigit(c);
2243 Paragraph::getParLanguage(BufferParams const & bparams) const
2246 return getFirstFontSettings(bparams).language();
2247 // FIXME: we should check the prev par as well (Lgb)
2248 return bparams.language;
2252 bool Paragraph::isRTL(BufferParams const & bparams) const
2254 return lyxrc.rtl_support
2255 && getParLanguage(bparams)->rightToLeft()
2256 && ownerCode() != ERT_CODE
2257 && ownerCode() != LISTINGS_CODE;
2261 void Paragraph::changeLanguage(BufferParams const & bparams,
2262 Language const * from, Language const * to)
2264 // change language including dummy font change at the end
2265 for (pos_type i = 0; i <= size(); ++i) {
2266 Font font = getFontSettings(bparams, i);
2267 if (font.language() == from) {
2268 font.setLanguage(to);
2275 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2277 Language const * doc_language = bparams.language;
2278 FontList::const_iterator cit = d->fontlist_.begin();
2279 FontList::const_iterator end = d->fontlist_.end();
2281 for (; cit != end; ++cit)
2282 if (cit->font().language() != ignore_language &&
2283 cit->font().language() != latex_language &&
2284 cit->font().language() != doc_language)
2290 // Convert the paragraph to a string.
2291 // Used for building the table of contents
2292 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
2294 return asString(buffer, 0, size(), label);
2298 docstring const Paragraph::asString(Buffer const & buffer,
2299 pos_type beg, pos_type end, bool label) const
2302 odocstringstream os;
2304 if (beg == 0 && label && !params().labelString().empty())
2305 os << params().labelString() << ' ';
2307 for (pos_type i = beg; i < end; ++i) {
2308 char_type const c = d->text_[i];
2311 else if (c == META_INSET)
2312 getInset(i)->textString(buffer, os);
2319 void Paragraph::setInsetOwner(Inset * inset)
2321 d->inset_owner_ = inset;
2325 int Paragraph::id() const
2331 LayoutPtr const & Paragraph::layout() const
2337 void Paragraph::layout(LayoutPtr const & new_layout)
2339 d->layout_ = new_layout;
2343 Inset * Paragraph::inInset() const
2345 return d->inset_owner_;
2349 InsetCode Paragraph::ownerCode() const
2351 return d->inset_owner_ ?
2352 d->inset_owner_->lyxCode() : NO_CODE;
2356 ParagraphParameters & Paragraph::params()
2362 ParagraphParameters const & Paragraph::params() const
2368 bool Paragraph::isFreeSpacing() const
2370 if (layout()->free_spacing)
2372 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
2376 bool Paragraph::allowEmpty() const
2378 if (layout()->keepempty)
2380 return d->inset_owner_ && d->inset_owner_->allowEmpty();
2384 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2386 if (!Encodings::is_arabic(c))
2389 char_type prev_char = ' ';
2390 char_type next_char = ' ';
2392 for (pos_type i = pos - 1; i >= 0; --i) {
2393 char_type const par_char = d->text_[i];
2394 if (!Encodings::isComposeChar_arabic(par_char)) {
2395 prev_char = par_char;
2400 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2401 char_type const par_char = d->text_[i];
2402 if (!Encodings::isComposeChar_arabic(par_char)) {
2403 next_char = par_char;
2408 if (Encodings::is_arabic(next_char)) {
2409 if (Encodings::is_arabic(prev_char) &&
2410 !Encodings::is_arabic_special(prev_char))
2411 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2413 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2415 if (Encodings::is_arabic(prev_char) &&
2416 !Encodings::is_arabic_special(prev_char))
2417 return Encodings::transformChar(c, Encodings::FORM_FINAL);
2419 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2424 int Paragraph::checkBiblio(bool track_changes)
2427 //This is getting more and more a mess. ...We really should clean
2428 //up this bibitem issue for 1.6. See also bug 2743.
2430 // Add bibitem insets if necessary
2431 if (layout()->labeltype != LABEL_BIBLIO)
2434 bool hasbibitem = !d->insetlist_.empty()
2435 // Insist on it being in pos 0
2436 && d->text_[0] == META_INSET
2437 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2442 // remove a bibitem in pos != 0
2443 // restore it later in pos 0 if necessary
2444 // (e.g. if a user inserts contents _before_ the item)
2445 // we're assuming there's only one of these, which there
2447 int erasedInsetPosition = -1;
2448 InsetList::iterator it = d->insetlist_.begin();
2449 InsetList::iterator end = d->insetlist_.end();
2450 for (; it != end; ++it)
2451 if (it->inset->lyxCode() == BIBITEM_CODE
2453 InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2454 oldkey = olditem->getParam("key");
2455 oldlabel = olditem->getParam("label");
2456 erasedInsetPosition = it->pos;
2457 eraseChar(erasedInsetPosition, track_changes);
2461 //There was an InsetBibitem at the beginning, and we didn't
2462 //have to erase one.
2463 if (hasbibitem && erasedInsetPosition < 0)
2466 //There was an InsetBibitem at the beginning and we did have to
2467 //erase one. So we give its properties to the beginning inset.
2469 InsetBibitem * inset =
2470 static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2471 if (!oldkey.empty())
2472 inset->setParam("key", oldkey);
2473 inset->setParam("label", oldlabel);
2474 return -erasedInsetPosition;
2477 //There was no inset at the beginning, so we need to create one with
2478 //the key and label of the one we erased.
2479 InsetBibitem * inset(new InsetBibitem(InsetCommandParams(BIBITEM_CODE)));
2480 // restore values of previously deleted item in this par.
2481 if (!oldkey.empty())
2482 inset->setParam("key", oldkey);
2483 inset->setParam("label", oldlabel);
2484 insertInset(0, static_cast<Inset *>(inset),
2485 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2491 void Paragraph::checkAuthors(AuthorList const & authorList)
2493 d->changes_.checkAuthors(authorList);
2497 bool Paragraph::isUnchanged(pos_type pos) const
2499 return lookupChange(pos).type == Change::UNCHANGED;
2503 bool Paragraph::isInserted(pos_type pos) const
2505 return lookupChange(pos).type == Change::INSERTED;
2509 bool Paragraph::isDeleted(pos_type pos) const
2511 return lookupChange(pos).type == Change::DELETED;
2515 InsetList const & Paragraph::insetList() const
2517 return d->insetlist_;
2521 Inset * Paragraph::releaseInset(pos_type pos)
2523 Inset * inset = d->insetlist_.release(pos);
2524 /// does not honour change tracking!
2525 eraseChar(pos, false);
2530 Inset * Paragraph::getInset(pos_type pos)
2532 return d->insetlist_.get(pos);
2536 Inset const * Paragraph::getInset(pos_type pos) const
2538 return d->insetlist_.get(pos);
2542 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
2543 pos_type right, TextCase action)
2545 // process sequences of modified characters; in change
2546 // tracking mode, this approach results in much better
2547 // usability than changing case on a char-by-char basis
2550 bool const trackChanges = bparams.trackChanges;
2552 bool capitalize = true;
2554 for (; pos < right; ++pos) {
2555 char_type oldChar = d->text_[pos];
2556 char_type newChar = oldChar;
2558 // ignore insets and don't play with deleted text!
2559 if (oldChar != META_INSET && !isDeleted(pos)) {
2561 case text_lowercase:
2562 newChar = lowercase(oldChar);
2564 case text_capitalization:
2566 newChar = uppercase(oldChar);
2570 case text_uppercase:
2571 newChar = uppercase(oldChar);
2576 if (!isLetter(pos) || isDeleted(pos)) {
2577 // permit capitalization again
2581 if (oldChar != newChar)
2584 if (oldChar == newChar || pos == right - 1) {
2585 if (oldChar != newChar) {
2586 // step behind the changing area
2589 int erasePos = pos - changes.size();
2590 for (size_t i = 0; i < changes.size(); i++) {
2591 insertChar(pos, changes[i],
2592 getFontSettings(bparams,
2595 if (!eraseChar(erasePos, trackChanges)) {
2598 ++right; // expand selection
2607 bool Paragraph::find(docstring const & str, bool cs, bool mw,
2608 pos_type pos, bool del) const
2610 int const strsize = str.length();
2612 pos_type const parsize = d->text_.size();
2613 for (i = 0; pos + i < parsize; ++i) {
2616 if (cs && str[i] != d->text_[pos + i])
2618 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos + i]))
2620 if (!del && isDeleted(pos + i))
2627 // if necessary, check whether string matches word
2629 if (pos > 0 && isLetter(pos - 1))
2631 if (pos + strsize < parsize
2632 && isLetter(pos + strsize))
2640 char_type Paragraph::getChar(pos_type pos) const
2642 return d->text_[pos];
2646 pos_type Paragraph::size() const
2648 return d->text_.size();
2652 bool Paragraph::empty() const
2654 return d->text_.empty();
2658 bool Paragraph::isInset(pos_type pos) const
2660 return d->text_[pos] == META_INSET;
2664 bool Paragraph::isSeparator(pos_type pos) const
2666 //FIXME: Are we sure this can be the only separator?
2667 return d->text_[pos] == ' ';