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 Richard Heck (XHTML output)
9 * \author Jean-Marc Lasgouttes
10 * \author Angus Leeming
12 * \author André Pönitz
14 * \author Jürgen Vigna
16 * Full author contact details are available in file CREDITS.
21 #include "Paragraph.h"
23 #include "LayoutFile.h"
25 #include "BufferParams.h"
29 #include "InsetList.h"
31 #include "LaTeXFeatures.h"
37 #include "OutputParams.h"
38 #include "output_latex.h"
39 #include "output_xhtml.h"
40 #include "ParagraphParameters.h"
41 #include "SpellChecker.h"
43 #include "TextClass.h"
47 #include "WordLangTuple.h"
50 #include "frontends/alert.h"
52 #include "insets/InsetBibitem.h"
53 #include "insets/InsetLabel.h"
55 #include "support/debug.h"
56 #include "support/docstring_list.h"
57 #include "support/ExceptionMessage.h"
58 #include "support/gettext.h"
59 #include "support/lassert.h"
60 #include "support/lstrings.h"
61 #include "support/textutils.h"
67 using namespace lyx::support;
72 /// Inset identifier (above 0x10ffff, for ucs-4)
73 char_type const META_INSET = 0x200001;
76 /////////////////////////////////////////////////////////////////////
80 /////////////////////////////////////////////////////////////////////
82 class Paragraph::Private
86 Private(Paragraph * owner, Layout const & layout);
87 /// "Copy constructor"
88 Private(Private const &, Paragraph * owner);
89 /// Copy constructor from \p beg to \p end
90 Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
93 void insertChar(pos_type pos, char_type c, Change const & change);
95 /// Output the surrogate pair formed by \p c and \p next to \p os.
96 /// \return the number of characters written.
97 int latexSurrogatePair(odocstream & os, char_type c, char_type next,
98 OutputParams const &);
100 /// Output a space in appropriate formatting (or a surrogate pair
101 /// if the next character is a combining character).
102 /// \return whether a surrogate pair was output.
103 bool simpleTeXBlanks(OutputParams const &,
104 odocstream &, TexRow & texrow,
106 unsigned int & column,
108 Layout const & style);
110 /// Output consecutive unicode chars, belonging to the same script as
111 /// specified by the latex macro \p ltx, to \p os starting from \p i.
112 /// \return the number of characters written.
113 int writeScriptChars(odocstream & os, docstring const & ltx,
114 Change const &, Encoding const &, pos_type & i);
116 /// This could go to ParagraphParameters if we want to.
117 int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
118 OutputParams const &) const;
120 /// This could go to ParagraphParameters if we want to.
121 int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
122 OutputParams const &) const;
125 void latexInset(BufferParams const &,
127 TexRow & texrow, OutputParams &,
130 Font const & outerfont,
132 Change & running_change,
133 Layout const & style,
135 unsigned int & column);
138 void latexSpecialChar(
140 OutputParams const & runparams,
141 Font const & running_font,
142 Change const & running_change,
143 Layout const & style,
145 unsigned int & column);
152 unsigned int & column);
154 bool latexSpecialTypewriter(
158 unsigned int & column);
160 bool latexSpecialPhrase(
163 unsigned int & column,
164 OutputParams const & runparams);
167 void validate(LaTeXFeatures & features) const;
169 /// Checks if the paragraph contains only text and no inset or font change.
170 bool onlyText(Buffer const & buf, Font const & outerfont,
171 pos_type initial) const;
173 /// match a string against a particular point in the paragraph
174 bool isTextAt(string const & str, pos_type pos) const;
177 InsetCode ownerCode() const
179 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
182 /// Which Paragraph owns us?
186 Inset const * inset_owner_;
195 ParagraphParameters params_;
197 /// for recording and looking up changes
201 InsetList insetlist_;
204 pos_type begin_of_body_;
206 typedef docstring TextContainer;
210 typedef set<docstring> Words;
211 typedef map<Language, Words> LangWordsMap;
215 Layout const * layout_;
221 struct special_phrase {
227 special_phrase const special_phrases[] = {
228 { "LyX", from_ascii("\\LyX{}"), false },
229 { "TeX", from_ascii("\\TeX{}"), true },
230 { "LaTeX2e", from_ascii("\\LaTeXe{}"), true },
231 { "LaTeX", from_ascii("\\LaTeX{}"), true },
234 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
239 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
240 : owner_(owner), inset_owner_(0), id_(-1), begin_of_body_(0), layout_(&layout)
246 // Initialization of the counter for the paragraph id's,
248 // FIXME: There should be a more intelligent way to generate and use the
249 // paragraph ids per buffer instead a global static counter for all InsetText
250 // in the running program.
251 static int paragraph_id = -1;
253 Paragraph::Private::Private(Private const & p, Paragraph * owner)
254 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
255 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
256 begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
259 id_ = ++paragraph_id;
263 Paragraph::Private::Private(Private const & p, Paragraph * owner,
264 pos_type beg, pos_type end)
265 : owner_(owner), inset_owner_(p.inset_owner_),
266 params_(p.params_), changes_(p.changes_),
267 insetlist_(p.insetlist_, beg, end),
268 begin_of_body_(p.begin_of_body_), words_(p.words_),
271 id_ = ++paragraph_id;
272 if (beg >= pos_type(p.text_.size()))
274 text_ = p.text_.substr(beg, end - beg);
276 FontList::const_iterator fcit = fontlist_.begin();
277 FontList::const_iterator fend = fontlist_.end();
278 for (; fcit != fend; ++fcit) {
279 if (fcit->pos() < beg)
281 if (fcit->pos() >= end) {
282 // Add last entry in the fontlist_.
283 fontlist_.set(text_.size() - 1, fcit->font());
286 // Add a new entry in the fontlist_.
287 fontlist_.set(fcit->pos() - beg, fcit->font());
292 void Paragraph::addChangesToToc(DocIterator const & cdit,
293 Buffer const & buf) const
295 d->changes_.addToToc(cdit, buf);
299 bool Paragraph::isDeleted(pos_type start, pos_type end) const
301 LASSERT(start >= 0 && start <= size(), /**/);
302 LASSERT(end > start && end <= size() + 1, /**/);
304 return d->changes_.isDeleted(start, end);
308 bool Paragraph::isChanged(pos_type start, pos_type end) const
310 LASSERT(start >= 0 && start <= size(), /**/);
311 LASSERT(end > start && end <= size() + 1, /**/);
313 return d->changes_.isChanged(start, end);
317 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
319 // keep the logic here in sync with the logic of eraseChars()
323 Change const change = d->changes_.lookup(size());
324 return change.inserted() && change.currentAuthor();
328 void Paragraph::setChange(Change const & change)
330 // beware of the imaginary end-of-par character!
331 d->changes_.set(change, 0, size() + 1);
334 * Propagate the change recursively - but not in case of DELETED!
336 * Imagine that your co-author makes changes in an existing inset. He
337 * sends your document to you and you come to the conclusion that the
338 * inset should go completely. If you erase it, LyX must not delete all
339 * text within the inset. Otherwise, the change tracked insertions of
340 * your co-author get lost and there is no way to restore them later.
342 * Conclusion: An inset's content should remain untouched if you delete it
345 if (!change.deleted()) {
346 for (pos_type pos = 0; pos < size(); ++pos) {
347 if (Inset * inset = getInset(pos))
348 inset->setChange(change);
354 void Paragraph::setChange(pos_type pos, Change const & change)
356 LASSERT(pos >= 0 && pos <= size(), /**/);
357 d->changes_.set(change, pos);
359 // see comment in setChange(Change const &) above
360 if (!change.deleted() && pos < size())
361 if (Inset * inset = getInset(pos))
362 inset->setChange(change);
366 Change const & Paragraph::lookupChange(pos_type pos) const
368 LASSERT(pos >= 0 && pos <= size(), /**/);
369 return d->changes_.lookup(pos);
373 void Paragraph::acceptChanges(pos_type start, pos_type end)
375 LASSERT(start >= 0 && start <= size(), /**/);
376 LASSERT(end > start && end <= size() + 1, /**/);
378 for (pos_type pos = start; pos < end; ++pos) {
379 switch (lookupChange(pos).type) {
380 case Change::UNCHANGED:
381 // accept changes in nested inset
382 if (Inset * inset = getInset(pos))
383 inset->acceptChanges();
386 case Change::INSERTED:
387 d->changes_.set(Change(Change::UNCHANGED), pos);
388 // also accept changes in nested inset
389 if (Inset * inset = getInset(pos))
390 inset->acceptChanges();
393 case Change::DELETED:
394 // Suppress access to non-existent
395 // "end-of-paragraph char"
397 eraseChar(pos, false);
408 void Paragraph::rejectChanges(pos_type start, pos_type end)
410 LASSERT(start >= 0 && start <= size(), /**/);
411 LASSERT(end > start && end <= size() + 1, /**/);
413 for (pos_type pos = start; pos < end; ++pos) {
414 switch (lookupChange(pos).type) {
415 case Change::UNCHANGED:
416 // reject changes in nested inset
417 if (Inset * inset = getInset(pos))
418 inset->rejectChanges();
421 case Change::INSERTED:
422 // Suppress access to non-existent
423 // "end-of-paragraph char"
425 eraseChar(pos, false);
431 case Change::DELETED:
432 d->changes_.set(Change(Change::UNCHANGED), pos);
434 // Do NOT reject changes within a deleted inset!
435 // There may be insertions of a co-author inside of it!
443 void Paragraph::Private::insertChar(pos_type pos, char_type c,
444 Change const & change)
446 LASSERT(pos >= 0 && pos <= int(text_.size()), /**/);
449 changes_.insert(change, pos);
451 // This is actually very common when parsing buffers (and
452 // maybe inserting ascii text)
453 if (pos == pos_type(text_.size())) {
454 // when appending characters, no need to update tables
459 text_.insert(text_.begin() + pos, c);
461 // Update the font table.
462 fontlist_.increasePosAfterPos(pos);
465 insetlist_.increasePosAfterPos(pos);
469 bool Paragraph::insertInset(pos_type pos, Inset * inset,
470 Change const & change)
472 LASSERT(inset, /**/);
473 LASSERT(pos >= 0 && pos <= size(), /**/);
475 // Paragraph::insertInset() can be used in cut/copy/paste operation where
476 // d->inset_owner_ is not set yet.
477 if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
480 d->insertChar(pos, META_INSET, change);
481 LASSERT(d->text_[pos] == META_INSET, /**/);
483 // Add a new entry in the insetlist_.
484 d->insetlist_.insert(inset, pos);
489 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
491 LASSERT(pos >= 0 && pos <= size(), return false);
493 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
496 Change change = d->changes_.lookup(pos);
498 // set the character to DELETED if
499 // a) it was previously unchanged or
500 // b) it was inserted by a co-author
502 if (!change.changed() ||
503 (change.inserted() && !change.currentAuthor())) {
504 setChange(pos, Change(Change::DELETED));
508 if (change.deleted())
512 // Don't physically access the imaginary end-of-paragraph character.
513 // eraseChar() can only mark it as DELETED. A physical deletion of
514 // end-of-par must be handled externally.
520 d->changes_.erase(pos);
522 // if it is an inset, delete the inset entry
523 if (d->text_[pos] == META_INSET)
524 d->insetlist_.erase(pos);
526 d->text_.erase(d->text_.begin() + pos);
528 // Update the fontlist_
529 d->fontlist_.erase(pos);
531 // Update the insetlist_
532 d->insetlist_.decreasePosAfterPos(pos);
538 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
540 LASSERT(start >= 0 && start <= size(), /**/);
541 LASSERT(end >= start && end <= size() + 1, /**/);
544 for (pos_type count = end - start; count; --count) {
545 if (!eraseChar(i, trackChanges))
552 int Paragraph::Private::latexSurrogatePair(odocstream & os, char_type c,
553 char_type next, OutputParams const & runparams)
555 // Writing next here may circumvent a possible font change between
556 // c and next. Since next is only output if it forms a surrogate pair
557 // with c we can ignore this:
558 // A font change inside a surrogate pair does not make sense and is
559 // hopefully impossible to input.
560 // FIXME: change tracking
561 // Is this correct WRT change tracking?
562 Encoding const & encoding = *(runparams.encoding);
563 docstring const latex1 = encoding.latexChar(next);
564 docstring const latex2 = encoding.latexChar(c);
565 if (docstring(1, next) == latex1) {
566 // the encoding supports the combination
567 os << latex2 << latex1;
568 return latex1.length() + latex2.length();
569 } else if (runparams.local_font &&
570 runparams.local_font->language()->lang() == "polutonikogreek") {
571 // polutonikogreek only works without the brackets
572 os << latex1 << latex2;
573 return latex1.length() + latex2.length();
575 os << latex1 << '{' << latex2 << '}';
576 return latex1.length() + latex2.length() + 2;
580 bool Paragraph::Private::simpleTeXBlanks(OutputParams const & runparams,
581 odocstream & os, TexRow & texrow,
583 unsigned int & column,
585 Layout const & style)
587 if (style.pass_thru || runparams.pass_thru)
590 if (i + 1 < int(text_.size())) {
591 char_type next = text_[i + 1];
592 if (Encodings::isCombiningChar(next)) {
593 // This space has an accent, so we must always output it.
594 column += latexSurrogatePair(os, ' ', next, runparams) - 1;
599 if (runparams.linelen > 0
600 && column > runparams.linelen
602 && text_[i - 1] != ' '
603 && (i + 1 < int(text_.size()))
604 // same in FreeSpacing mode
605 && !owner_->isFreeSpacing()
606 // In typewriter mode, we want to avoid
607 // ! . ? : at the end of a line
608 && !(font.fontInfo().family() == TYPEWRITER_FAMILY
609 && (text_[i - 1] == '.'
610 || text_[i - 1] == '?'
611 || text_[i - 1] == ':'
612 || text_[i - 1] == '!'))) {
615 texrow.start(owner_->id(), i + 1);
617 } else if (style.free_spacing) {
626 int Paragraph::Private::writeScriptChars(odocstream & os,
627 docstring const & ltx,
628 Change const & runningChange,
629 Encoding const & encoding,
632 // FIXME: modifying i here is not very nice...
634 // We only arrive here when a proper language for character text_[i] has
635 // not been specified (i.e., it could not be translated in the current
636 // latex encoding) or its latex translation has been forced, and it
637 // belongs to a known script.
638 // Parameter ltx contains the latex translation of text_[i] as specified
639 // in the unicodesymbols file and is something like "\textXXX{<spec>}".
640 // The latex macro name "textXXX" specifies the script to which text_[i]
641 // belongs and we use it in order to check whether characters from the
642 // same script immediately follow, such that we can collect them in a
643 // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
644 // for the first char but only "<spec>" for all subsequent chars.
645 docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
646 docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
647 string script = to_ascii(ltx.substr(1, brace1 - 1));
650 bool closing_brace = true;
651 if (script == "textgreek" && encoding.latexName() == "iso-8859-7") {
652 // Correct encoding is being used, so we can avoid \textgreek.
655 closing_brace = false;
657 os << ltx.substr(pos, length);
658 int size = text_.size();
659 while (i + 1 < size) {
660 char_type const next = text_[i + 1];
661 // Stop here if next character belongs to another script
662 // or there is a change in change tracking status.
663 if (!Encodings::isKnownScriptChar(next, script) ||
664 runningChange != owner_->lookupChange(i + 1))
668 FontList::const_iterator cit = fontlist_.begin();
669 FontList::const_iterator end = fontlist_.end();
670 for (; cit != end; ++cit) {
671 if (cit->pos() >= i && !found) {
672 prev_font = cit->font();
675 if (cit->pos() >= i + 1)
678 // Stop here if there is a font attribute or encoding change.
679 if (found && cit != end && prev_font != cit->font())
681 docstring const latex = encoding.latexChar(next);
682 docstring::size_type const b1 =
683 latex.find_first_of(from_ascii("{"));
684 docstring::size_type const b2 =
685 latex.find_last_of(from_ascii("}"));
686 int const len = b2 - b1 - 1;
687 os << latex.substr(b1 + 1, len);
699 bool Paragraph::Private::isTextAt(string const & str, pos_type pos) const
701 pos_type const len = str.length();
703 // is the paragraph large enough?
704 if (pos + len > int(text_.size()))
707 // does the wanted text start at point?
708 for (string::size_type i = 0; i < str.length(); ++i) {
709 // Caution: direct comparison of characters works only
710 // because str is pure ASCII.
711 if (str[i] != text_[pos + i])
715 return fontlist_.hasChangeInRange(pos, len);
719 void Paragraph::Private::latexInset(BufferParams const & bparams,
722 OutputParams & runparams,
725 Font const & outerfont,
727 Change & running_change,
728 Layout const & style,
730 unsigned int & column)
732 Inset * inset = owner_->getInset(i);
733 LASSERT(inset, /**/);
735 if (style.pass_thru) {
736 inset->plaintext(os, runparams);
740 // FIXME: move this to InsetNewline::latex
741 if (inset->lyxCode() == NEWLINE_CODE) {
742 // newlines are handled differently here than
743 // the default in simpleTeXSpecialChars().
744 if (!style.newline_allowed) {
748 column += running_font.latexWriteEndChanges(
749 os, bparams, runparams,
754 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
757 basefont = owner_->getLayoutFont(bparams, outerfont);
758 running_font = basefont;
760 if (runparams.moving_arg)
765 texrow.start(owner_->id(), i + 1);
769 if (owner_->isDeleted(i)) {
770 if( ++runparams.inDeletedInset == 1)
771 runparams.changeOfDeletedInset = owner_->lookupChange(i);
774 if (inset->canTrackChanges()) {
775 column += Changes::latexMarkChange(os, bparams, running_change,
776 Change(Change::UNCHANGED), runparams);
777 running_change = Change(Change::UNCHANGED);
781 odocstream::pos_type const len = os.tellp();
783 if (inset->forceLTR()
784 && running_font.isRightToLeft()
785 // ERT is an exception, it should be output with no
786 // decorations at all
787 && inset->lyxCode() != ERT_CODE) {
788 if (running_font.language()->lang() == "farsi")
795 // FIXME: Bug: we can have an empty font change here!
796 // if there has just been a font change, we are going to close it
797 // right now, which means stupid latex code like \textsf{}. AFAIK,
798 // this does not harm dvi output. A minor bug, thus (JMarc)
800 // Some insets cannot be inside a font change command.
801 // However, even such insets *can* be placed in \L or \R
802 // or their equivalents (for RTL language switches), so we don't
803 // close the language in those cases.
804 // ArabTeX, though, cannot handle this special behavior, it seems.
805 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
806 || running_font.language()->lang() == "arabic_arabtex";
807 if (open_font && inset->noFontChange()) {
808 bool closeLanguage = arabtex
809 || basefont.isRightToLeft() == running_font.isRightToLeft();
810 unsigned int count = running_font.latexWriteEndChanges(os,
811 bparams, runparams, basefont, basefont, closeLanguage);
813 // if any font properties were closed, update the running_font,
814 // making sure, however, to leave the language as it was
816 // FIXME: probably a better way to keep track of the old
817 // language, than copying the entire font?
818 Font const copy_font(running_font);
819 basefont = owner_->getLayoutFont(bparams, outerfont);
820 running_font = basefont;
822 running_font.setLanguage(copy_font.language());
823 // leave font open if language is still open
824 open_font = (running_font.language() == basefont.language());
826 runparams.local_font = &basefont;
833 tmp = inset->latex(os, runparams);
834 } catch (EncodingException & e) {
835 // add location information and throw again.
842 if (running_font.language()->lang() == "farsi")
849 texrow.newlines(tmp);
850 texrow.start(owner_->id(), i + 1);
853 column += os.tellp() - len;
856 if (owner_->isDeleted(i))
857 --runparams.inDeletedInset;
861 void Paragraph::Private::latexSpecialChar(
863 OutputParams const & runparams,
864 Font const & running_font,
865 Change const & running_change,
866 Layout const & style,
868 unsigned int & column)
870 char_type const c = text_[i];
872 if (style.pass_thru || runparams.pass_thru) {
874 // FIXME UNICODE: This can fail if c cannot
875 // be encoded in the current encoding.
880 // If T1 font encoding is used, use the special
881 // characters it provides.
882 // NOTE: some languages reset the font encoding
884 if (!running_font.language()->internalFontEncoding()
885 && lyxrc.fontenc == "T1" && latexSpecialT1(c, os, i, column))
888 // \tt font needs special treatment
889 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY
890 && latexSpecialTypewriter(c, os, i, column))
893 // Otherwise, we use what LaTeX provides us.
896 os << "\\textbackslash{}";
900 os << "\\textless{}";
904 os << "\\textgreater{}";
915 os << "\\char`\\\"{}";
920 case '%': case '#': case '{':
928 os << "\\textasciitilde{}";
933 os << "\\textasciicircum{}";
940 // avoid being mistaken for optional arguments
948 // Blanks are printed before font switching.
949 // Sure? I am not! (try nice-latex)
950 // I am sure it's correct. LyX might be smarter
951 // in the future, but for now, nothing wrong is
957 if (latexSpecialPhrase(os, i, column, runparams))
963 Encoding const & encoding = *(runparams.encoding);
964 if (i + 1 < int(text_.size())) {
965 char_type next = text_[i + 1];
966 if (Encodings::isCombiningChar(next)) {
967 column += latexSurrogatePair(os, c, next, runparams) - 1;
973 docstring const latex = encoding.latexChar(c);
974 if (Encodings::isKnownScriptChar(c, script)
975 && prefixIs(latex, from_ascii("\\" + script)))
976 column += writeScriptChars(os, latex,
977 running_change, encoding, i) - 1;
978 else if (latex.length() > 1 && latex[latex.length() - 1] != '}') {
979 // Prevent eating of a following
980 // space or command corruption by
981 // following characters
982 column += latex.length() + 1;
985 column += latex.length() - 1;
993 bool Paragraph::Private::latexSpecialT1(char_type const c, odocstream & os,
994 pos_type i, unsigned int & column)
1000 // In T1 encoding, these characters exist
1001 // but we should avoid ligatures
1002 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1004 os << "\\textcompwordmark{}";
1011 // soul.sty breaks with \char`\"
1012 os << "\\textquotedbl{}";
1021 bool Paragraph::Private::latexSpecialTypewriter(char_type const c, odocstream & os,
1022 pos_type i, unsigned int & column)
1026 // within \ttfamily, "--" is merged to "-" (no endash)
1027 // so we avoid this rather irritating ligature
1028 if (i + 1 < int(text_.size()) && text_[i + 1] == '-') {
1035 // everything else has to be checked separately
1036 // (depending on the encoding)
1043 bool Paragraph::Private::latexSpecialPhrase(odocstream & os, pos_type & i,
1044 unsigned int & column, OutputParams const & runparams)
1046 // FIXME: if we have "LaTeX" with a font
1047 // change in the middle (before the 'T', then
1048 // the "TeX" part is still special cased.
1049 // Really we should only operate this on
1050 // "words" for some definition of word
1052 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1053 if (!isTextAt(special_phrases[pnr].phrase, i))
1055 if (runparams.moving_arg)
1057 os << special_phrases[pnr].macro;
1058 i += special_phrases[pnr].phrase.length() - 1;
1059 column += special_phrases[pnr].macro.length() - 1;
1066 void Paragraph::Private::validate(LaTeXFeatures & features) const
1068 if (layout_->inpreamble && inset_owner_) {
1069 Buffer const & buf = inset_owner_->buffer();
1070 BufferParams const & bp = buf.params();
1073 odocstringstream ods;
1074 // we have to provide all the optional arguments here, even though
1075 // the last one is the only one we care about.
1076 owner_->latex(bp, f, ods, tr, features.runparams(), 0, -1, true);
1077 docstring const d = ods.str();
1079 // this will have "{" at the beginning, but not at the end
1080 string const content = to_utf8(d);
1081 string const cmd = layout_->latexname();
1082 features.addPreambleSnippet("\\" + cmd + content + "}");
1086 if (features.runparams().flavor == OutputParams::HTML
1087 && layout_->htmltitle()) {
1088 features.setHTMLTitle(owner_->asString(AS_STR_INSETS));
1091 // check the params.
1092 if (!params_.spacing().isDefault())
1093 features.require("setspace");
1096 features.useLayout(layout_->name());
1099 fontlist_.validate(features);
1101 // then the indentation
1102 if (!params_.leftIndent().zero())
1103 features.require("ParagraphLeftIndent");
1106 InsetList::const_iterator icit = insetlist_.begin();
1107 InsetList::const_iterator iend = insetlist_.end();
1108 for (; icit != iend; ++icit) {
1110 icit->inset->validate(features);
1111 if (layout_->needprotect &&
1112 icit->inset->lyxCode() == FOOT_CODE)
1113 features.require("NeedLyXFootnoteCode");
1117 // then the contents
1118 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1119 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1120 if (!special_phrases[pnr].builtin
1121 && isTextAt(special_phrases[pnr].phrase, i)) {
1122 features.require(special_phrases[pnr].phrase);
1126 Encodings::validate(text_[i], features);
1130 /////////////////////////////////////////////////////////////////////
1134 /////////////////////////////////////////////////////////////////////
1137 Layout const emptyParagraphLayout;
1140 Paragraph::Paragraph()
1141 : d(new Paragraph::Private(this, emptyParagraphLayout))
1148 Paragraph::Paragraph(Paragraph const & par)
1149 : itemdepth(par.itemdepth),
1150 d(new Paragraph::Private(*par.d, this))
1156 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1157 : itemdepth(par.itemdepth),
1158 d(new Paragraph::Private(*par.d, this, beg, end))
1164 Paragraph & Paragraph::operator=(Paragraph const & par)
1166 // needed as we will destroy the private part before copying it
1168 itemdepth = par.itemdepth;
1172 d = new Private(*par.d, this);
1179 Paragraph::~Paragraph()
1188 // this shall be called just before every "os << ..." action.
1189 void flushString(ostream & os, docstring & s)
1198 void Paragraph::write(ostream & os, BufferParams const & bparams,
1199 depth_type & dth) const
1201 // The beginning or end of a deeper (i.e. nested) area?
1202 if (dth != d->params_.depth()) {
1203 if (d->params_.depth() > dth) {
1204 while (d->params_.depth() > dth) {
1205 os << "\n\\begin_deeper";
1209 while (d->params_.depth() < dth) {
1210 os << "\n\\end_deeper";
1216 // First write the layout
1217 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1219 d->params_.write(os);
1221 Font font1(inherit_font, bparams.language);
1223 Change running_change = Change(Change::UNCHANGED);
1225 // this string is used as a buffer to avoid repetitive calls
1226 // to to_utf8(), which turn out to be expensive (JMarc)
1227 docstring write_buffer;
1230 for (pos_type i = 0; i <= size(); ++i) {
1232 Change const change = lookupChange(i);
1233 if (change != running_change)
1234 flushString(os, write_buffer);
1235 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1236 running_change = change;
1241 // Write font changes (ignore spelling markers)
1242 Font font2 = getFontSettings(bparams, i);
1243 font2.setMisspelled(false);
1244 if (font2 != font1) {
1245 flushString(os, write_buffer);
1246 font2.lyxWriteChanges(font1, os);
1251 char_type const c = d->text_[i];
1254 if (Inset const * inset = getInset(i)) {
1255 flushString(os, write_buffer);
1256 if (inset->directWrite()) {
1257 // international char, let it write
1258 // code directly so it's shorter in
1264 os << "\\begin_inset ";
1266 os << "\n\\end_inset\n\n";
1272 flushString(os, write_buffer);
1273 os << "\n\\backslash\n";
1277 flushString(os, write_buffer);
1278 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1285 if ((column > 70 && c == ' ')
1287 flushString(os, write_buffer);
1291 // this check is to amend a bug. LyX sometimes
1292 // inserts '\0' this could cause problems.
1294 write_buffer.push_back(c);
1296 LYXERR0("NUL char in structure.");
1302 flushString(os, write_buffer);
1303 os << "\n\\end_layout\n";
1307 void Paragraph::validate(LaTeXFeatures & features) const
1309 d->validate(features);
1313 void Paragraph::insert(pos_type start, docstring const & str,
1314 Font const & font, Change const & change)
1316 for (size_t i = 0, n = str.size(); i != n ; ++i)
1317 insertChar(start + i, str[i], font, change);
1321 void Paragraph::appendChar(char_type c, Font const & font,
1322 Change const & change)
1325 d->changes_.insert(change, d->text_.size());
1326 // when appending characters, no need to update tables
1327 d->text_.push_back(c);
1328 setFont(d->text_.size() - 1, font);
1332 void Paragraph::appendString(docstring const & s, Font const & font,
1333 Change const & change)
1335 pos_type end = s.size();
1336 size_t oldsize = d->text_.size();
1337 size_t newsize = oldsize + end;
1338 size_t capacity = d->text_.capacity();
1339 if (newsize >= capacity)
1340 d->text_.reserve(max(capacity + 100, newsize));
1342 // when appending characters, no need to update tables
1345 // FIXME: Optimize this!
1346 for (size_t i = oldsize; i != newsize; ++i) {
1348 d->changes_.insert(change, i);
1350 d->fontlist_.set(oldsize, font);
1351 d->fontlist_.set(newsize - 1, font);
1355 void Paragraph::insertChar(pos_type pos, char_type c,
1358 d->insertChar(pos, c, Change(trackChanges ?
1359 Change::INSERTED : Change::UNCHANGED));
1363 void Paragraph::insertChar(pos_type pos, char_type c,
1364 Font const & font, bool trackChanges)
1366 d->insertChar(pos, c, Change(trackChanges ?
1367 Change::INSERTED : Change::UNCHANGED));
1372 void Paragraph::insertChar(pos_type pos, char_type c,
1373 Font const & font, Change const & change)
1375 d->insertChar(pos, c, change);
1380 bool Paragraph::insertInset(pos_type pos, Inset * inset,
1381 Font const & font, Change const & change)
1383 bool const success = insertInset(pos, inset, change);
1384 // Set the font/language of the inset...
1390 void Paragraph::resetFonts(Font const & font)
1392 d->fontlist_.clear();
1393 d->fontlist_.set(0, font);
1394 d->fontlist_.set(d->text_.size() - 1, font);
1397 // Gets uninstantiated font setting at position.
1398 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1402 LYXERR0("pos: " << pos << " size: " << size());
1403 LASSERT(pos <= size(), /**/);
1406 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1407 if (cit != d->fontlist_.end())
1410 if (pos == size() && !empty())
1411 return getFontSettings(bparams, pos - 1);
1413 // Optimisation: avoid a full font instantiation if there is no
1414 // language change from previous call.
1415 static Font previous_font;
1416 static Language const * previous_lang = 0;
1417 Language const * lang = getParLanguage(bparams);
1418 if (lang != previous_lang) {
1419 previous_lang = lang;
1420 previous_font = Font(inherit_font, lang);
1422 return previous_font;
1426 FontSpan Paragraph::fontSpan(pos_type pos) const
1428 LASSERT(pos <= size(), /**/);
1431 FontList::const_iterator cit = d->fontlist_.begin();
1432 FontList::const_iterator end = d->fontlist_.end();
1433 for (; cit != end; ++cit) {
1434 if (cit->pos() >= pos) {
1435 if (pos >= beginOfBody())
1436 return FontSpan(max(start, beginOfBody()),
1439 return FontSpan(start,
1440 min(beginOfBody() - 1,
1443 start = cit->pos() + 1;
1446 // This should not happen, but if so, we take no chances.
1447 // LYXERR0("Paragraph::getEndPosOfFontSpan: This should not happen!");
1448 return FontSpan(pos, pos);
1452 // Gets uninstantiated font setting at position 0
1453 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1455 if (!empty() && !d->fontlist_.empty())
1456 return d->fontlist_.begin()->font();
1458 // Optimisation: avoid a full font instantiation if there is no
1459 // language change from previous call.
1460 static Font previous_font;
1461 static Language const * previous_lang = 0;
1462 if (bparams.language != previous_lang) {
1463 previous_lang = bparams.language;
1464 previous_font = Font(inherit_font, bparams.language);
1467 return previous_font;
1471 // Gets the fully instantiated font at a given position in a paragraph
1472 // This is basically the same function as Text::GetFont() in text2.cpp.
1473 // The difference is that this one is used for generating the LaTeX file,
1474 // and thus cosmetic "improvements" are disallowed: This has to deliver
1475 // the true picture of the buffer. (Asger)
1476 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1477 Font const & outerfont) const
1479 LASSERT(pos >= 0, /**/);
1481 Font font = getFontSettings(bparams, pos);
1483 pos_type const body_pos = beginOfBody();
1484 FontInfo & fi = font.fontInfo();
1486 fi.realize(d->layout_->labelfont);
1488 fi.realize(d->layout_->font);
1490 fi.realize(outerfont.fontInfo());
1491 fi.realize(bparams.getFont().fontInfo());
1497 Font const Paragraph::getLabelFont
1498 (BufferParams const & bparams, Font const & outerfont) const
1500 FontInfo tmpfont = d->layout_->labelfont;
1501 tmpfont.realize(outerfont.fontInfo());
1502 tmpfont.realize(bparams.getFont().fontInfo());
1503 return Font(tmpfont, getParLanguage(bparams));
1507 Font const Paragraph::getLayoutFont
1508 (BufferParams const & bparams, Font const & outerfont) const
1510 FontInfo tmpfont = d->layout_->font;
1511 tmpfont.realize(outerfont.fontInfo());
1512 tmpfont.realize(bparams.getFont().fontInfo());
1513 return Font(tmpfont, getParLanguage(bparams));
1517 /// Returns the height of the highest font in range
1518 FontSize Paragraph::highestFontInRange
1519 (pos_type startpos, pos_type endpos, FontSize def_size) const
1521 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1525 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1527 char_type c = d->text_[pos];
1528 if (!lyxrc.rtl_support)
1558 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1564 void Paragraph::setFont(pos_type pos, Font const & font)
1566 LASSERT(pos <= size(), /**/);
1568 // First, reduce font against layout/label font
1569 // Update: The setCharFont() routine in text2.cpp already
1570 // reduces font, so we don't need to do that here. (Asger)
1572 d->fontlist_.set(pos, font);
1576 void Paragraph::makeSameLayout(Paragraph const & par)
1578 d->layout_ = par.d->layout_;
1579 d->params_ = par.d->params_;
1583 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1585 if (isFreeSpacing())
1591 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1592 if (eraseChar(pos, trackChanges))
1598 return count > 0 || pos > 0;
1602 bool Paragraph::hasSameLayout(Paragraph const & par) const
1604 return par.d->layout_ == d->layout_
1605 && d->params_.sameLayout(par.d->params_);
1609 depth_type Paragraph::getDepth() const
1611 return d->params_.depth();
1615 depth_type Paragraph::getMaxDepthAfter() const
1617 if (d->layout_->isEnvironment())
1618 return d->params_.depth() + 1;
1620 return d->params_.depth();
1624 char Paragraph::getAlign() const
1626 if (d->params_.align() == LYX_ALIGN_LAYOUT)
1627 return d->layout_->align;
1629 return d->params_.align();
1633 docstring const & Paragraph::labelString() const
1635 return d->params_.labelString();
1639 // the next two functions are for the manual labels
1640 docstring const Paragraph::getLabelWidthString() const
1642 if (d->layout_->margintype == MARGIN_MANUAL
1643 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
1644 return d->params_.labelWidthString();
1646 return _("Senseless with this layout!");
1650 void Paragraph::setLabelWidthString(docstring const & s)
1652 d->params_.labelWidthString(s);
1656 docstring Paragraph::expandLabel(Layout const & layout,
1657 BufferParams const & bparams) const
1659 return expandParagraphLabel(layout, bparams, true);
1663 docstring Paragraph::expandDocBookLabel(Layout const & layout,
1664 BufferParams const & bparams) const
1666 return expandParagraphLabel(layout, bparams, false);
1670 docstring Paragraph::expandParagraphLabel(Layout const & layout,
1671 BufferParams const & bparams, bool process_appendix) const
1673 DocumentClass const & tclass = bparams.documentClass();
1674 string const & lang = getParLanguage(bparams)->code();
1675 bool const in_appendix = process_appendix && d->params_.appendix();
1676 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
1678 if (fmt.empty() && layout.labeltype == LABEL_COUNTER
1679 && !layout.counter.empty())
1680 return tclass.counters().theCounter(layout.counter, lang);
1682 // handle 'inherited level parts' in 'fmt',
1683 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
1684 size_t const i = fmt.find('@', 0);
1685 if (i != docstring::npos) {
1686 size_t const j = fmt.find('@', i + 1);
1687 if (j != docstring::npos) {
1688 docstring parent(fmt, i + 1, j - i - 1);
1689 docstring label = from_ascii("??");
1690 if (tclass.hasLayout(parent))
1691 docstring label = expandParagraphLabel(tclass[parent], bparams,
1693 fmt = docstring(fmt, 0, i) + label
1694 + docstring(fmt, j + 1, docstring::npos);
1698 return tclass.counters().counterLabel(fmt, lang);
1702 void Paragraph::applyLayout(Layout const & new_layout)
1704 d->layout_ = &new_layout;
1705 LyXAlignment const oldAlign = d->params_.align();
1707 if (!(oldAlign & d->layout_->alignpossible)) {
1708 frontend::Alert::warning(_("Alignment not permitted"),
1709 _("The new layout does not permit the alignment previously used.\nSetting to default."));
1710 d->params_.align(LYX_ALIGN_LAYOUT);
1715 pos_type Paragraph::beginOfBody() const
1717 return d->begin_of_body_;
1721 void Paragraph::setBeginOfBody()
1723 if (d->layout_->labeltype != LABEL_MANUAL) {
1724 d->begin_of_body_ = 0;
1728 // Unroll the first two cycles of the loop
1729 // and remember the previous character to
1730 // remove unnecessary getChar() calls
1732 pos_type end = size();
1733 if (i < end && !isNewline(i)) {
1735 char_type previous_char = 0;
1738 previous_char = d->text_[i];
1739 if (!isNewline(i)) {
1741 while (i < end && previous_char != ' ') {
1746 previous_char = temp;
1752 d->begin_of_body_ = i;
1756 bool Paragraph::allowParagraphCustomization() const
1758 return inInset().allowParagraphCustomization();
1762 bool Paragraph::usePlainLayout() const
1764 return inInset().usePlainLayout();
1770 // paragraphs inside floats need different alignment tags to avoid
1773 bool noTrivlistCentering(InsetCode code)
1775 return code == FLOAT_CODE
1776 || code == WRAP_CODE
1777 || code == CELL_CODE;
1781 string correction(string const & orig)
1783 if (orig == "flushleft")
1784 return "raggedright";
1785 if (orig == "flushright")
1786 return "raggedleft";
1787 if (orig == "center")
1793 string const corrected_env(string const & suffix, string const & env,
1794 InsetCode code, bool const lastpar)
1796 string output = suffix + "{";
1797 if (noTrivlistCentering(code)) {
1799 // the last paragraph in non-trivlist-aligned
1800 // context is special (to avoid unwanted whitespace)
1801 if (suffix == "\\begin")
1802 return "\\" + correction(env) + "{}";
1805 output += correction(env);
1809 if (suffix == "\\begin")
1815 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1817 if (!contains(str, "\n"))
1818 column += str.size();
1822 column = rsplit(str, tmp, '\n').size();
1829 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
1830 odocstream & os, TexRow & texrow,
1831 OutputParams const & runparams) const
1835 if (params_.noindent()) {
1836 os << "\\noindent ";
1840 LyXAlignment const curAlign = params_.align();
1842 if (curAlign == layout_->align)
1846 case LYX_ALIGN_NONE:
1847 case LYX_ALIGN_BLOCK:
1848 case LYX_ALIGN_LAYOUT:
1849 case LYX_ALIGN_SPECIAL:
1850 case LYX_ALIGN_DECIMAL:
1852 case LYX_ALIGN_LEFT:
1853 case LYX_ALIGN_RIGHT:
1854 case LYX_ALIGN_CENTER:
1855 if (runparams.moving_arg) {
1862 string const begin_tag = "\\begin";
1863 InsetCode code = ownerCode();
1864 bool const lastpar = runparams.isLastPar;
1867 case LYX_ALIGN_NONE:
1868 case LYX_ALIGN_BLOCK:
1869 case LYX_ALIGN_LAYOUT:
1870 case LYX_ALIGN_SPECIAL:
1871 case LYX_ALIGN_DECIMAL:
1873 case LYX_ALIGN_LEFT: {
1875 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1876 output = corrected_env(begin_tag, "flushleft", code, lastpar);
1878 output = corrected_env(begin_tag, "flushright", code, lastpar);
1879 os << from_ascii(output);
1880 adjust_row_column(output, texrow, column);
1882 } case LYX_ALIGN_RIGHT: {
1884 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1885 output = corrected_env(begin_tag, "flushright", code, lastpar);
1887 output = corrected_env(begin_tag, "flushleft", code, lastpar);
1888 os << from_ascii(output);
1889 adjust_row_column(output, texrow, column);
1891 } case LYX_ALIGN_CENTER: {
1893 output = corrected_env(begin_tag, "center", code, lastpar);
1894 os << from_ascii(output);
1895 adjust_row_column(output, texrow, column);
1904 int Paragraph::Private::endTeXParParams(BufferParams const & bparams,
1905 odocstream & os, TexRow & texrow,
1906 OutputParams const & runparams) const
1910 LyXAlignment const curAlign = params_.align();
1912 if (curAlign == layout_->align)
1916 case LYX_ALIGN_NONE:
1917 case LYX_ALIGN_BLOCK:
1918 case LYX_ALIGN_LAYOUT:
1919 case LYX_ALIGN_SPECIAL:
1920 case LYX_ALIGN_DECIMAL:
1922 case LYX_ALIGN_LEFT:
1923 case LYX_ALIGN_RIGHT:
1924 case LYX_ALIGN_CENTER:
1925 if (runparams.moving_arg) {
1932 string const end_tag = "\n\\par\\end";
1933 InsetCode code = ownerCode();
1934 bool const lastpar = runparams.isLastPar;
1937 case LYX_ALIGN_NONE:
1938 case LYX_ALIGN_BLOCK:
1939 case LYX_ALIGN_LAYOUT:
1940 case LYX_ALIGN_SPECIAL:
1941 case LYX_ALIGN_DECIMAL:
1943 case LYX_ALIGN_LEFT: {
1945 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1946 output = corrected_env(end_tag, "flushleft", code, lastpar);
1948 output = corrected_env(end_tag, "flushright", code, lastpar);
1949 os << from_ascii(output);
1950 adjust_row_column(output, texrow, column);
1952 } case LYX_ALIGN_RIGHT: {
1954 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
1955 output = corrected_env(end_tag, "flushright", code, lastpar);
1957 output = corrected_env(end_tag, "flushleft", code, lastpar);
1958 os << from_ascii(output);
1959 adjust_row_column(output, texrow, column);
1961 } case LYX_ALIGN_CENTER: {
1963 output = corrected_env(end_tag, "center", code, lastpar);
1964 os << from_ascii(output);
1965 adjust_row_column(output, texrow, column);
1974 // This one spits out the text of the paragraph
1975 void Paragraph::latex(BufferParams const & bparams,
1976 Font const & outerfont,
1977 odocstream & os, TexRow & texrow,
1978 OutputParams const & runparams,
1979 int start_pos, int end_pos, bool force) const
1981 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
1983 // FIXME This check should not be needed. Perhaps issue an
1984 // error if it triggers.
1985 Layout const & style = inInset().forcePlainLayout() ?
1986 bparams.documentClass().plainLayout() : *d->layout_;
1988 if (!force && style.inpreamble)
1991 bool const allowcust = allowParagraphCustomization();
1993 // Current base font for all inherited font changes, without any
1994 // change caused by an individual character, except for the language:
1995 // It is set to the language of the first character.
1996 // As long as we are in the label, this font is the base font of the
1997 // label. Before the first body character it is set to the base font
2001 // Maybe we have to create a optional argument.
2002 pos_type body_pos = beginOfBody();
2003 unsigned int column = 0;
2006 // the optional argument is kept in curly brackets in
2007 // case it contains a ']'
2010 basefont = getLabelFont(bparams, outerfont);
2012 basefont = getLayoutFont(bparams, outerfont);
2015 // Which font is currently active?
2016 Font running_font(basefont);
2017 // Do we have an open font change?
2018 bool open_font = false;
2020 Change runningChange = Change(Change::UNCHANGED);
2022 Encoding const * const prev_encoding = runparams.encoding;
2024 texrow.start(id(), 0);
2026 // if the paragraph is empty, the loop will not be entered at all
2028 if (style.isCommand()) {
2033 column += d->startTeXParParams(bparams, os, texrow,
2037 for (pos_type i = 0; i < size(); ++i) {
2038 // First char in paragraph or after label?
2039 if (i == body_pos) {
2042 column += running_font.latexWriteEndChanges(
2043 os, bparams, runparams,
2044 basefont, basefont);
2047 basefont = getLayoutFont(bparams, outerfont);
2048 running_font = basefont;
2050 column += Changes::latexMarkChange(os, bparams,
2051 runningChange, Change(Change::UNCHANGED),
2053 runningChange = Change(Change::UNCHANGED);
2058 if (style.isCommand()) {
2064 column += d->startTeXParParams(bparams, os,
2069 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
2072 if (bparams.outputChanges && runningChange != change) {
2074 column += running_font.latexWriteEndChanges(
2075 os, bparams, runparams, basefont, basefont);
2078 basefont = getLayoutFont(bparams, outerfont);
2079 running_font = basefont;
2081 column += Changes::latexMarkChange(os, bparams, runningChange,
2083 runningChange = change;
2086 // do not output text which is marked deleted
2087 // if change tracking output is disabled
2088 if (!bparams.outputChanges && change.deleted()) {
2094 // Fully instantiated font
2095 Font const font = getFont(bparams, i, outerfont);
2097 Font const last_font = running_font;
2099 // Do we need to close the previous font?
2101 (font != running_font ||
2102 font.language() != running_font.language()))
2104 column += running_font.latexWriteEndChanges(
2105 os, bparams, runparams, basefont,
2106 (i == body_pos-1) ? basefont : font);
2107 running_font = basefont;
2111 // close babel's font environment before opening CJK.
2112 if (!running_font.language()->babel().empty() &&
2113 font.language()->encoding()->package() == Encoding::CJK) {
2114 string end_tag = subst(lyxrc.language_command_end,
2116 running_font.language()->babel());
2117 os << from_ascii(end_tag);
2118 column += end_tag.length();
2121 // Switch file encoding if necessary (and allowed)
2122 if (!runparams.pass_thru && !style.pass_thru &&
2123 runparams.encoding->package() != Encoding::none &&
2124 font.language()->encoding()->package() != Encoding::none) {
2125 pair<bool, int> const enc_switch = switchEncoding(os, bparams,
2126 runparams, *(font.language()->encoding()));
2127 if (enc_switch.first) {
2128 column += enc_switch.second;
2129 runparams.encoding = font.language()->encoding();
2133 char_type const c = d->text_[i];
2135 // Do we need to change font?
2136 if ((font != running_font ||
2137 font.language() != running_font.language()) &&
2140 odocstringstream ods;
2141 column += font.latexWriteStartChanges(ods, bparams,
2142 runparams, basefont,
2144 running_font = font;
2146 docstring fontchange = ods.str();
2147 // check whether the fontchange ends with a \\textcolor
2148 // modifier and the text starts with a space (bug 4473)
2149 docstring const last_modifier = rsplit(fontchange, '\\');
2150 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2151 os << fontchange << from_ascii("{}");
2152 // check if the fontchange ends with a trailing blank
2153 // (like "\small " (see bug 3382)
2154 else if (suffixIs(fontchange, ' ') && c == ' ')
2155 os << fontchange.substr(0, fontchange.size() - 1)
2156 << from_ascii("{}");
2161 // FIXME: think about end_pos implementation...
2162 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2163 // FIXME: integrate this case in latexSpecialChar
2164 // Do not print the separation of the optional argument
2165 // if style.pass_thru is false. This works because
2166 // latexSpecialChar ignores spaces if
2167 // style.pass_thru is false.
2168 if (i != body_pos - 1) {
2169 if (d->simpleTeXBlanks(
2170 runparams, os, texrow,
2171 i, column, font, style)) {
2172 // A surrogate pair was output. We
2173 // must not call latexSpecialChar
2174 // in this iteration, since it would output
2175 // the combining character again.
2182 OutputParams rp = runparams;
2183 rp.free_spacing = style.free_spacing;
2184 rp.local_font = &font;
2185 rp.intitle = style.intitle;
2187 // Two major modes: LaTeX or plain
2188 // Handle here those cases common to both modes
2189 // and then split to handle the two modes separately.
2190 if (c == META_INSET) {
2191 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2192 d->latexInset(bparams, os,
2193 texrow, rp, running_font,
2194 basefont, outerfont, open_font,
2195 runningChange, style, i, column);
2198 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2200 d->latexSpecialChar(os, rp, running_font, runningChange,
2202 } catch (EncodingException & e) {
2203 if (runparams.dryrun) {
2204 os << "<" << _("LyX Warning: ")
2205 << _("uncodable character") << " '";
2209 // add location information and throw again.
2218 // Set the encoding to that returned from latexSpecialChar (see
2219 // comment for encoding member in OutputParams.h)
2220 runparams.encoding = rp.encoding;
2223 // If we have an open font definition, we have to close it
2225 #ifdef FIXED_LANGUAGE_END_DETECTION
2227 running_font.latexWriteEndChanges(os, bparams,
2228 runparams, basefont,
2229 next_->getFont(bparams, 0, outerfont));
2231 running_font.latexWriteEndChanges(os, bparams,
2232 runparams, basefont, basefont);
2235 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2236 //FIXME: there as we start another \selectlanguage with the next paragraph if
2237 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2238 running_font.latexWriteEndChanges(os, bparams, runparams,
2239 basefont, basefont);
2243 column += Changes::latexMarkChange(os, bparams, runningChange,
2244 Change(Change::UNCHANGED), runparams);
2246 // Needed if there is an optional argument but no contents.
2247 if (body_pos > 0 && body_pos == size()) {
2251 if (allowcust && d->endTeXParParams(bparams, os, texrow, runparams)
2252 && runparams.encoding != prev_encoding) {
2253 runparams.encoding = prev_encoding;
2254 if (!bparams.useXetex)
2255 os << setEncoding(prev_encoding->iconvName());
2258 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2262 bool Paragraph::emptyTag() const
2264 for (pos_type i = 0; i < size(); ++i) {
2265 if (Inset const * inset = getInset(i)) {
2266 InsetCode lyx_code = inset->lyxCode();
2267 // FIXME testing like that is wrong. What is
2269 if (lyx_code != TOC_CODE &&
2270 lyx_code != INCLUDE_CODE &&
2271 lyx_code != GRAPHICS_CODE &&
2272 lyx_code != ERT_CODE &&
2273 lyx_code != LISTINGS_CODE &&
2274 lyx_code != FLOAT_CODE &&
2275 lyx_code != TABULAR_CODE) {
2279 char_type c = d->text_[i];
2280 if (c != ' ' && c != '\t')
2288 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2291 for (pos_type i = 0; i < size(); ++i) {
2292 if (Inset const * inset = getInset(i)) {
2293 InsetCode lyx_code = inset->lyxCode();
2294 if (lyx_code == LABEL_CODE) {
2295 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2296 docstring const & id = il->getParam("name");
2297 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2305 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2309 for (i = 0; i < size(); ++i) {
2310 if (Inset const * inset = getInset(i)) {
2311 inset->docbook(os, runparams);
2313 char_type c = d->text_[i];
2316 os << sgml::escapeChar(c);
2323 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2327 for (i = 0; i < size(); ++i) {
2328 if (Inset const * inset = getInset(i)) {
2329 inset->xhtml(xs, runparams);
2331 char_type c = d->text_[i];
2341 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2344 pos_type size = text_.size();
2345 for (pos_type i = initial; i < size; ++i) {
2346 Font font = owner_->getFont(buf.params(), i, outerfont);
2347 if (text_[i] == META_INSET)
2349 if (i != initial && font != font_old)
2358 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2360 OutputParams const & runparams,
2361 Font const & outerfont,
2362 pos_type initial) const
2364 bool emph_flag = false;
2366 Layout const & style = *d->layout_;
2368 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2370 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2373 // parsing main loop
2374 for (pos_type i = initial; i < size(); ++i) {
2375 Font font = getFont(buf.params(), i, outerfont);
2377 // handle <emphasis> tag
2378 if (font_old.emph() != font.fontInfo().emph()) {
2379 if (font.fontInfo().emph() == FONT_ON) {
2382 } else if (i != initial) {
2383 os << "</emphasis>";
2388 if (Inset const * inset = getInset(i)) {
2389 inset->docbook(os, runparams);
2391 char_type c = d->text_[i];
2393 if (style.pass_thru)
2396 os << sgml::escapeChar(c);
2398 font_old = font.fontInfo();
2402 os << "</emphasis>";
2405 if (style.free_spacing)
2407 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2412 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
2414 OutputParams const & runparams,
2415 Font const & outerfont,
2416 pos_type initial) const
2420 bool emph_flag = false;
2421 bool bold_flag = false;
2424 Layout const & style = *d->layout_;
2426 if (!runparams.for_toc && runparams.html_make_pars) {
2427 // generate a magic label for this paragraph
2428 string const attr = "id='" + magicLabel() + "'";
2429 xs << html::CompTag("a", attr);
2433 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2435 // parsing main loop
2436 for (pos_type i = initial; i < size(); ++i) {
2437 // let's not show deleted material in the output
2441 Font font = getFont(buf.params(), i, outerfont);
2444 if (font_old.emph() != font.fontInfo().emph()) {
2445 if (font.fontInfo().emph() == FONT_ON) {
2446 xs << html::StartTag("em");
2448 } else if (emph_flag && i != initial) {
2449 xs << html::EndTag("em");
2454 if (font_old.series() != font.fontInfo().series()) {
2455 if (font.fontInfo().series() == BOLD_SERIES) {
2456 xs << html::StartTag("strong");
2458 } else if (bold_flag && i != initial) {
2459 xs << html::EndTag("strong");
2464 // Other such tags? What about the other text ranges?
2466 Inset const * inset = getInset(i);
2468 InsetCommand const * ic = inset->asInsetCommand();
2469 InsetLayout const & il = inset->getLayout();
2470 InsetMath const * im = inset->asInsetMath();
2471 if (!runparams.for_toc
2472 || im || il.isInToc() || (ic && ic->isInToc())) {
2473 OutputParams np = runparams;
2474 if (!il.htmlisblock())
2475 np.html_in_par = true;
2476 retval += inset->xhtml(xs, np);
2479 char_type c = d->text_[i];
2481 if (style.pass_thru)
2483 else if (c == '-') {
2486 if (j < size() && d->text_[j] == '-') {
2488 if (j < size() && d->text_[j] == '-') {
2489 str += from_ascii("—");
2492 str += from_ascii("–");
2498 // We don't want to escape the entities. Note that
2499 // it is safe to do this, since str can otherwise
2500 // only be "-". E.g., it can't be "<".
2501 xs << XHTMLStream::NextRaw() << str;
2505 font_old = font.fontInfo();
2513 bool Paragraph::isHfill(pos_type pos) const
2515 Inset const * inset = getInset(pos);
2516 return inset && (inset->lyxCode() == SPACE_CODE &&
2517 inset->isStretchableSpace());
2521 bool Paragraph::isNewline(pos_type pos) const
2523 Inset const * inset = getInset(pos);
2524 return inset && inset->lyxCode() == NEWLINE_CODE;
2528 bool Paragraph::isLineSeparator(pos_type pos) const
2530 char_type const c = d->text_[pos];
2531 if (isLineSeparatorChar(c))
2533 Inset const * inset = getInset(pos);
2534 return inset && inset->isLineSeparator();
2538 bool Paragraph::isWordSeparator(pos_type pos) const
2540 if (Inset const * inset = getInset(pos))
2541 return !inset->isLetter();
2542 char_type const c = d->text_[pos];
2543 // We want to pass the ' and escape chars to the spellchecker
2544 static docstring const quote = from_utf8(lyxrc.spellchecker_esc_chars + '\'');
2545 return (!isLetterChar(c) && !isDigit(c) && !contains(quote, c))
2550 bool Paragraph::isChar(pos_type pos) const
2552 if (Inset const * inset = getInset(pos))
2553 return inset->isChar();
2554 char_type const c = d->text_[pos];
2555 return !isLetterChar(c) && !isDigit(c) && !lyx::isSpace(c);
2559 bool Paragraph::isSpace(pos_type pos) const
2561 if (Inset const * inset = getInset(pos))
2562 return inset->isSpace();
2563 char_type const c = d->text_[pos];
2564 return lyx::isSpace(c);
2569 Paragraph::getParLanguage(BufferParams const & bparams) const
2572 return getFirstFontSettings(bparams).language();
2573 // FIXME: we should check the prev par as well (Lgb)
2574 return bparams.language;
2578 bool Paragraph::isRTL(BufferParams const & bparams) const
2580 return lyxrc.rtl_support
2581 && getParLanguage(bparams)->rightToLeft()
2582 && !inInset().getLayout().forceLTR();
2586 void Paragraph::changeLanguage(BufferParams const & bparams,
2587 Language const * from, Language const * to)
2589 // change language including dummy font change at the end
2590 for (pos_type i = 0; i <= size(); ++i) {
2591 Font font = getFontSettings(bparams, i);
2592 if (font.language() == from) {
2593 font.setLanguage(to);
2600 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2602 Language const * doc_language = bparams.language;
2603 FontList::const_iterator cit = d->fontlist_.begin();
2604 FontList::const_iterator end = d->fontlist_.end();
2606 for (; cit != end; ++cit)
2607 if (cit->font().language() != ignore_language &&
2608 cit->font().language() != latex_language &&
2609 cit->font().language() != doc_language)
2615 void Paragraph::getLanguages(std::set<Language const *> & languages) const
2617 FontList::const_iterator cit = d->fontlist_.begin();
2618 FontList::const_iterator end = d->fontlist_.end();
2620 for (; cit != end; ++cit) {
2621 Language const * lang = cit->font().language();
2622 if (lang != ignore_language &&
2623 lang != latex_language)
2624 languages.insert(lang);
2629 docstring Paragraph::asString(int options) const
2631 return asString(0, size(), options);
2635 docstring Paragraph::asString(pos_type beg, pos_type end, int options) const
2637 odocstringstream os;
2640 && options & AS_STR_LABEL
2641 && !d->params_.labelString().empty())
2642 os << d->params_.labelString() << ' ';
2644 for (pos_type i = beg; i < end; ++i) {
2645 char_type const c = d->text_[i];
2646 if (isPrintable(c) || c == '\t'
2647 || (c == '\n' && (options & AS_STR_NEWLINES)))
2649 else if (c == META_INSET && (options & AS_STR_INSETS)) {
2650 getInset(i)->tocString(os);
2651 if (getInset(i)->asInsetMath())
2660 docstring Paragraph::stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const
2662 odocstringstream os;
2665 && options & AS_STR_LABEL
2666 && !d->params_.labelString().empty())
2667 os << d->params_.labelString() << ' ';
2669 for (pos_type i = beg; i < end; ++i) {
2670 char_type const c = d->text_[i];
2671 if (isPrintable(c) || c == '\t'
2672 || (c == '\n' && (options & AS_STR_NEWLINES)))
2674 else if (c == META_INSET && (options & AS_STR_INSETS)) {
2675 getInset(i)->plaintext(os, runparams);
2683 void Paragraph::setInsetOwner(Inset const * inset)
2685 d->inset_owner_ = inset;
2689 int Paragraph::id() const
2695 void Paragraph::setId(int id)
2701 Layout const & Paragraph::layout() const
2707 void Paragraph::setLayout(Layout const & layout)
2709 d->layout_ = &layout;
2713 void Paragraph::setDefaultLayout(DocumentClass const & tc)
2715 setLayout(tc.defaultLayout());
2719 void Paragraph::setPlainLayout(DocumentClass const & tc)
2721 setLayout(tc.plainLayout());
2725 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
2727 if (usePlainLayout())
2728 setPlainLayout(tclass);
2730 setDefaultLayout(tclass);
2734 Inset const & Paragraph::inInset() const
2736 LASSERT(d->inset_owner_, throw ExceptionMessage(BufferException,
2737 _("Memory problem"), _("Paragraph not properly initialized")));
2738 return *d->inset_owner_;
2742 ParagraphParameters & Paragraph::params()
2748 ParagraphParameters const & Paragraph::params() const
2754 bool Paragraph::isFreeSpacing() const
2756 if (d->layout_->free_spacing)
2758 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
2762 bool Paragraph::allowEmpty() const
2764 if (d->layout_->keepempty)
2766 return d->inset_owner_ && d->inset_owner_->allowEmpty();
2770 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2772 if (!Encodings::isArabicChar(c))
2775 char_type prev_char = ' ';
2776 char_type next_char = ' ';
2778 for (pos_type i = pos - 1; i >= 0; --i) {
2779 char_type const par_char = d->text_[i];
2780 if (!Encodings::isArabicComposeChar(par_char)) {
2781 prev_char = par_char;
2786 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2787 char_type const par_char = d->text_[i];
2788 if (!Encodings::isArabicComposeChar(par_char)) {
2789 next_char = par_char;
2794 if (Encodings::isArabicChar(next_char)) {
2795 if (Encodings::isArabicChar(prev_char) &&
2796 !Encodings::isArabicSpecialChar(prev_char))
2797 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2799 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2801 if (Encodings::isArabicChar(prev_char) &&
2802 !Encodings::isArabicSpecialChar(prev_char))
2803 return Encodings::transformChar(c, Encodings::FORM_FINAL);
2805 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2810 int Paragraph::checkBiblio(Buffer const & buffer)
2813 // This is getting more and more a mess. ...We really should clean
2814 // up this bibitem issue for 1.6. See also bug 2743.
2816 // Add bibitem insets if necessary
2817 if (d->layout_->labeltype != LABEL_BIBLIO)
2820 bool hasbibitem = !d->insetlist_.empty()
2821 // Insist on it being in pos 0
2822 && d->text_[0] == META_INSET
2823 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2825 bool track_changes = buffer.params().trackChanges;
2830 // remove a bibitem in pos != 0
2831 // restore it later in pos 0 if necessary
2832 // (e.g. if a user inserts contents _before_ the item)
2833 // we're assuming there's only one of these, which there
2835 int erasedInsetPosition = -1;
2836 InsetList::iterator it = d->insetlist_.begin();
2837 InsetList::iterator end = d->insetlist_.end();
2838 for (; it != end; ++it)
2839 if (it->inset->lyxCode() == BIBITEM_CODE
2841 InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2842 oldkey = olditem->getParam("key");
2843 oldlabel = olditem->getParam("label");
2844 erasedInsetPosition = it->pos;
2845 eraseChar(erasedInsetPosition, track_changes);
2849 // There was an InsetBibitem at the beginning, and we didn't
2850 // have to erase one.
2851 if (hasbibitem && erasedInsetPosition < 0)
2854 // There was an InsetBibitem at the beginning and we did have to
2855 // erase one. So we give its properties to the beginning inset.
2857 InsetBibitem * inset =
2858 static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2859 if (!oldkey.empty())
2860 inset->setParam("key", oldkey);
2861 inset->setParam("label", oldlabel);
2862 return -erasedInsetPosition;
2865 // There was no inset at the beginning, so we need to create one with
2866 // the key and label of the one we erased.
2867 InsetBibitem * inset =
2868 new InsetBibitem(const_cast<Buffer *>(&buffer), InsetCommandParams(BIBITEM_CODE));
2869 // restore values of previously deleted item in this par.
2870 if (!oldkey.empty())
2871 inset->setParam("key", oldkey);
2872 inset->setParam("label", oldlabel);
2873 insertInset(0, static_cast<Inset *>(inset),
2874 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2880 void Paragraph::checkAuthors(AuthorList const & authorList)
2882 d->changes_.checkAuthors(authorList);
2886 bool Paragraph::isChanged(pos_type pos) const
2888 return lookupChange(pos).changed();
2892 bool Paragraph::isInserted(pos_type pos) const
2894 return lookupChange(pos).inserted();
2898 bool Paragraph::isDeleted(pos_type pos) const
2900 return lookupChange(pos).deleted();
2904 InsetList const & Paragraph::insetList() const
2906 return d->insetlist_;
2910 void Paragraph::setBuffer(Buffer & b)
2912 d->insetlist_.setBuffer(b);
2916 Inset * Paragraph::releaseInset(pos_type pos)
2918 Inset * inset = d->insetlist_.release(pos);
2919 /// does not honour change tracking!
2920 eraseChar(pos, false);
2925 Inset * Paragraph::getInset(pos_type pos)
2927 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
2928 ? d->insetlist_.get(pos) : 0;
2932 Inset const * Paragraph::getInset(pos_type pos) const
2934 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
2935 ? d->insetlist_.get(pos) : 0;
2939 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
2940 pos_type & right, TextCase action)
2942 // process sequences of modified characters; in change
2943 // tracking mode, this approach results in much better
2944 // usability than changing case on a char-by-char basis
2947 bool const trackChanges = bparams.trackChanges;
2949 bool capitalize = true;
2951 for (; pos < right; ++pos) {
2952 char_type oldChar = d->text_[pos];
2953 char_type newChar = oldChar;
2955 // ignore insets and don't play with deleted text!
2956 if (oldChar != META_INSET && !isDeleted(pos)) {
2958 case text_lowercase:
2959 newChar = lowercase(oldChar);
2961 case text_capitalization:
2963 newChar = uppercase(oldChar);
2967 case text_uppercase:
2968 newChar = uppercase(oldChar);
2973 if (isWordSeparator(pos) || isDeleted(pos)) {
2974 // permit capitalization again
2978 if (oldChar != newChar) {
2980 if (pos != right - 1)
2982 // step behind the changing area
2986 int erasePos = pos - changes.size();
2987 for (size_t i = 0; i < changes.size(); i++) {
2988 insertChar(pos, changes[i],
2989 getFontSettings(bparams,
2992 if (!eraseChar(erasePos, trackChanges)) {
2995 ++right; // expand selection
3003 bool Paragraph::find(docstring const & str, bool cs, bool mw,
3004 pos_type pos, bool del) const
3006 int const strsize = str.length();
3008 pos_type const parsize = d->text_.size();
3009 for (i = 0; pos + i < parsize; ++i) {
3012 if (cs && str[i] != d->text_[pos + i])
3014 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos + i]))
3016 if (!del && isDeleted(pos + i))
3023 // if necessary, check whether string matches word
3025 if (pos > 0 && !isWordSeparator(pos - 1))
3027 if (pos + strsize < parsize
3028 && !isWordSeparator(pos + strsize))
3036 char_type Paragraph::getChar(pos_type pos) const
3038 return d->text_[pos];
3042 pos_type Paragraph::size() const
3044 return d->text_.size();
3048 bool Paragraph::empty() const
3050 return d->text_.empty();
3054 bool Paragraph::isInset(pos_type pos) const
3056 return d->text_[pos] == META_INSET;
3060 bool Paragraph::isSeparator(pos_type pos) const
3062 //FIXME: Are we sure this can be the only separator?
3063 return d->text_[pos] == ' ';
3067 void Paragraph::deregisterWords()
3069 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3070 Private::LangWordsMap::const_iterator ite = d->words_.end();
3071 for (; itl != ite; ++itl) {
3072 WordList * wl = theWordList(itl->first);
3073 Private::Words::const_iterator it = (itl->second).begin();
3074 Private::Words::const_iterator et = (itl->second).end();
3075 for (; it != et; ++it)
3082 void Paragraph::locateWord(pos_type & from, pos_type & to,
3083 word_location const loc) const
3086 case WHOLE_WORD_STRICT:
3087 if (from == 0 || from == size()
3088 || isWordSeparator(from)
3089 || isWordSeparator(from - 1)) {
3093 // no break here, we go to the next
3096 // If we are already at the beginning of a word, do nothing
3097 if (!from || isWordSeparator(from - 1))
3099 // no break here, we go to the next
3102 // always move the cursor to the beginning of previous word
3103 while (from && !isWordSeparator(from - 1))
3107 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
3110 // no need to move the 'from' cursor
3114 while (to < size() && !isWordSeparator(to))
3119 void Paragraph::collectWords()
3121 // This is the value that needs to be exposed in the preferences
3122 // to resolve bug #6760.
3123 static int minlength = 6;
3124 pos_type n = size();
3125 for (pos_type pos = 0; pos < n; ++pos) {
3126 if (isWordSeparator(pos))
3128 pos_type from = pos;
3129 locateWord(from, pos, WHOLE_WORD);
3130 if (pos - from >= minlength) {
3131 docstring word = asString(from, pos, AS_STR_NONE);
3132 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
3133 if (cit == d->fontlist_.end())
3135 Language const * lang = cit->font().language();
3136 d->words_[*lang].insert(word);
3142 void Paragraph::registerWords()
3144 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3145 Private::LangWordsMap::const_iterator ite = d->words_.end();
3146 for (; itl != ite; ++itl) {
3147 WordList * wl = theWordList(itl->first);
3148 Private::Words::const_iterator it = (itl->second).begin();
3149 Private::Words::const_iterator et = (itl->second).end();
3150 for (; it != et; ++it)
3156 void Paragraph::updateWords()
3164 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
3165 docstring_list & suggestions, bool do_suggestion) const
3167 SpellChecker * speller = theSpellChecker();
3169 return SpellChecker::WORD_OK;
3171 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
3172 return SpellChecker::WORD_OK;
3174 locateWord(from, to, WHOLE_WORD);
3175 if (from == to || from >= pos_type(d->text_.size()))
3176 return SpellChecker::WORD_OK;
3178 docstring word = asString(from, to, AS_STR_INSETS);
3179 // Ignore words with digits
3180 // FIXME: make this customizable
3181 // (note that hunspell ignores words with digits by default)
3182 bool const ignored = hasDigit(word);
3183 Language * lang = const_cast<Language *>(getFontSettings(
3184 d->inset_owner_->buffer().params(), from).language());
3185 if (lang == d->inset_owner_->buffer().params().language
3186 && !lyxrc.spellchecker_alt_lang.empty()) {
3188 string const lang_variety =
3189 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
3190 lang->setCode(lang_code);
3191 lang->setVariety(lang_variety);
3193 wl = WordLangTuple(word, lang);
3194 SpellChecker::Result res = ignored ?
3195 SpellChecker::WORD_OK : speller->check(wl);
3197 bool const misspelled_ = SpellChecker::misspelled(res) ;
3199 if (lyxrc.spellcheck_continuously)
3200 d->fontlist_.setMisspelled(from, to, misspelled_);
3202 if (misspelled_ && do_suggestion)
3203 speller->suggest(wl, suggestions);
3205 suggestions.clear();
3211 bool Paragraph::isMisspelled(pos_type pos) const
3213 pos_type from = pos;
3216 docstring_list suggestions;
3217 SpellChecker::Result res = spellCheck(from, to, wl, suggestions, false);
3218 return SpellChecker::misspelled(res) ;
3222 string Paragraph::magicLabel() const
3225 ss << "magicparlabel-" << id();