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"
28 #include "BufferEncodings.h"
29 #include "InsetList.h"
31 #include "LaTeXFeatures.h"
36 #include "OutputParams.h"
37 #include "output_latex.h"
38 #include "output_xhtml.h"
39 #include "output_docbook.h"
40 #include "ParagraphParameters.h"
41 #include "SpellChecker.h"
43 #include "texstream.h"
44 #include "TextClass.h"
47 #include "WordLangTuple.h"
50 #include "frontends/alert.h"
52 #include "insets/InsetBibitem.h"
53 #include "insets/InsetLabel.h"
54 #include "insets/InsetSpecialChar.h"
55 #include "insets/InsetText.h"
57 #include "mathed/InsetMathHull.h"
59 #include "support/debug.h"
60 #include "support/docstring_list.h"
61 #include "support/ExceptionMessage.h"
62 #include "support/gettext.h"
63 #include "support/lassert.h"
64 #include "support/Length.h"
65 #include "support/lstrings.h"
66 #include "support/textutils.h"
67 #include "output_docbook.h"
74 using namespace lyx::support;
76 // OSX clang, gcc < 4.8.0, and msvc < 2015 do not support C++11 thread_local
77 #if defined(__APPLE__) || (defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ < 8)
78 #define THREAD_LOCAL_STATIC static __thread
79 #elif defined(_MSC_VER) && (_MSC_VER < 1900)
80 #define THREAD_LOCAL_STATIC static __declspec(thread)
82 #define THREAD_LOCAL_STATIC thread_local static
87 /////////////////////////////////////////////////////////////////////
91 /////////////////////////////////////////////////////////////////////
93 class SpellResultRange {
95 SpellResultRange(FontSpan range, SpellChecker::Result result)
96 : range_(range), result_(result)
99 FontSpan const & range() const { return range_; }
101 void range(FontSpan const & r) { range_ = r; }
103 SpellChecker::Result result() const { return result_; }
105 void result(SpellChecker::Result r) { result_ = r; }
107 bool contains(pos_type pos) const { return range_.contains(pos); }
109 bool covered(FontSpan const & r) const
111 // 1. first of new range inside current range or
112 // 2. last of new range inside current range or
113 // 3. first of current range inside new range or
114 // 4. last of current range inside new range
115 //FIXME: is this the same as !range_.intersect(r).empty() ?
116 return range_.contains(r.first) || range_.contains(r.last) ||
117 r.contains(range_.first) || r.contains(range_.last);
120 void shift(pos_type pos, int offset)
122 if (range_.first > pos) {
123 range_.first += offset;
124 range_.last += offset;
125 } else if (range_.last >= pos) {
126 range_.last += offset;
131 SpellChecker::Result result_ ;
135 /////////////////////////////////////////////////////////////////////
139 /////////////////////////////////////////////////////////////////////
141 class SpellCheckerState {
145 needs_refresh_ = true;
146 current_change_number_ = 0;
149 void setRange(FontSpan const & fp, SpellChecker::Result state)
152 RangesIterator et = ranges_.end();
153 RangesIterator it = ranges_.begin();
154 for (; it != et; ++it) {
155 if (!it->covered(fp))
156 result.push_back(SpellResultRange(it->range(), it->result()));
157 else if (state == SpellChecker::WORD_OK) {
158 // trim or split the current misspelled range
159 // store misspelled ranges only
160 FontSpan range = it->range();
161 if (fp.first > range.first) {
162 // misspelled area in front of WORD_OK
163 range.last = fp.first - 1;
164 result.push_back(SpellResultRange(range, it->result()));
167 if (fp.last < range.last) {
168 // misspelled area after WORD_OK range
169 range.first = fp.last + 1;
170 result.push_back(SpellResultRange(range, it->result()));
175 if (state != SpellChecker::WORD_OK)
176 ranges_.push_back(SpellResultRange(fp, state));
179 void increasePosAfterPos(pos_type pos)
181 correctRangesAfterPos(pos, 1);
185 void decreasePosAfterPos(pos_type pos)
187 correctRangesAfterPos(pos, -1);
191 void refreshLast(pos_type pos)
193 if (pos < refresh_.last)
197 SpellChecker::Result getState(pos_type pos) const
199 SpellChecker::Result result = SpellChecker::WORD_OK;
200 RangesIterator et = ranges_.end();
201 RangesIterator it = ranges_.begin();
202 for (; it != et; ++it) {
203 if(it->contains(pos)) {
210 FontSpan const & getRange(pos_type pos) const
212 /// empty span to indicate mismatch
213 static FontSpan empty_;
214 RangesIterator et = ranges_.end();
215 RangesIterator it = ranges_.begin();
216 for (; it != et; ++it) {
217 if(it->contains(pos)) {
224 bool needsRefresh() const
226 return needs_refresh_;
229 SpellChecker::ChangeNumber currentChangeNumber() const
231 return current_change_number_;
234 void refreshRange(pos_type & first, pos_type & last) const
236 first = refresh_.first;
237 last = refresh_.last;
240 void needsRefresh(pos_type pos)
242 if (needs_refresh_ && pos != -1) {
243 if (pos < refresh_.first)
244 refresh_.first = pos;
245 if (pos > refresh_.last)
247 } else if (pos != -1) {
248 // init request check for neighbour positions too
249 refresh_.first = pos > 0 ? pos - 1 : 0;
250 // no need for special end of paragraph check
251 refresh_.last = pos + 1;
253 needs_refresh_ = pos != -1;
256 void needsCompleteRefresh(SpellChecker::ChangeNumber change_number)
258 needs_refresh_ = true;
261 current_change_number_ = change_number;
264 typedef vector<SpellResultRange> Ranges;
265 typedef Ranges::const_iterator RangesIterator;
267 /// the area of the paragraph with pending spell check
269 /// spell state cache version number
270 SpellChecker::ChangeNumber current_change_number_;
274 void correctRangesAfterPos(pos_type pos, int offset)
276 RangesIterator et = ranges_.end();
277 Ranges::iterator it = ranges_.begin();
278 for (; it != et; ++it) {
279 it->shift(pos, offset);
285 /////////////////////////////////////////////////////////////////////
287 // Paragraph::Private
289 /////////////////////////////////////////////////////////////////////
291 class Paragraph::Private
293 // Enforce our own "copy" constructor
294 Private(Private const &) = delete;
295 Private & operator=(Private const &) = delete;
296 // Unique ID generator
297 static int make_id();
300 Private(Paragraph * owner, Layout const & layout);
301 /// "Copy constructor"
302 Private(Private const &, Paragraph * owner);
303 /// Copy constructor from \p beg to \p end
304 Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
307 void insertChar(pos_type pos, char_type c, Change const & change);
309 /// Output the surrogate pair formed by \p c and \p next to \p os.
310 /// \return the number of characters written.
311 int latexSurrogatePair(BufferParams const &, otexstream & os,
312 char_type c, char_type next,
313 OutputParams const &);
315 /// Output a space in appropriate formatting (or a surrogate pair
316 /// if the next character is a combining character).
317 /// \return whether a surrogate pair was output.
318 bool simpleTeXBlanks(BufferParams const &,
319 OutputParams const &,
322 unsigned int & column,
324 Layout const & style);
326 /// This could go to ParagraphParameters if we want to.
327 int startTeXParParams(BufferParams const &, otexstream &,
328 OutputParams const &) const;
330 /// This could go to ParagraphParameters if we want to.
331 bool endTeXParParams(BufferParams const &, otexstream &,
332 OutputParams const &) const;
335 void latexInset(BufferParams const &,
340 Font const & outerfont,
342 Change & running_change,
343 Layout const & style,
345 unsigned int & column,
346 bool const fontswitch_inset,
347 bool const closeLanguage,
348 bool const lang_switched_at_inset);
351 void latexSpecialChar(
353 BufferParams const & bparams,
354 OutputParams const & runparams,
355 Font const & running_font,
356 string & alien_script,
357 Layout const & style,
360 unsigned int & column);
367 unsigned int & column);
373 unsigned int & column);
379 unsigned int & column);
382 void validate(LaTeXFeatures & features) const;
384 /// Checks if the paragraph contains only text and no inset or font change.
385 bool onlyText(Buffer const & buf, Font const & outerfont,
386 pos_type initial) const;
388 /// a vector of speller skip positions
389 typedef vector<FontSpan> SkipPositions;
390 typedef SkipPositions::const_iterator SkipPositionsIterator;
392 void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
394 Language * getSpellLanguage(pos_type const from) const;
396 Language * locateSpellRange(pos_type & from, pos_type & to,
397 SkipPositions & skips) const;
399 bool hasSpellerChange() const
401 SpellChecker::ChangeNumber speller_change_number = 0;
402 if (theSpellChecker())
403 speller_change_number = theSpellChecker()->changeNumber();
404 return speller_change_number > speller_state_.currentChangeNumber();
407 bool ignoreWord(docstring const & word) const ;
409 void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
411 pos_type textsize = owner_->size();
412 // check for sane arguments
413 if (to <= from || from >= textsize)
415 FontSpan fp = FontSpan(from, to - 1);
416 speller_state_.setRange(fp, state);
419 void requestSpellCheck(pos_type pos)
422 speller_state_.needsCompleteRefresh(speller_state_.currentChangeNumber());
424 speller_state_.needsRefresh(pos);
427 void readySpellCheck()
429 speller_state_.needsRefresh(-1);
432 bool needsSpellCheck() const
434 return speller_state_.needsRefresh();
437 void rangeOfSpellCheck(pos_type & first, pos_type & last) const
439 speller_state_.refreshRange(first, last);
441 last = owner_->size();
444 pos_type endpos = last;
445 owner_->locateWord(first, endpos, WHOLE_WORD, true);
448 owner_->locateWord(last, endpos, WHOLE_WORD, true);
453 int countSkips(SkipPositionsIterator & it, SkipPositionsIterator const et,
457 while (it != et && it->first < start) {
458 long skip = it->last - it->first + 1;
466 void markMisspelledWords(pos_type const & first, pos_type const & last,
467 SpellChecker::Result result,
468 docstring const & word,
469 SkipPositions const & skips);
471 InsetCode ownerCode() const
473 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
476 /// Which Paragraph owns us?
480 Inset const * inset_owner_;
486 ParagraphParameters params_;
488 /// for recording and looking up changes
492 InsetList insetlist_;
495 pos_type begin_of_body_;
497 typedef docstring TextContainer;
501 typedef set<docstring> Words;
502 typedef map<string, Words> LangWordsMap;
506 Layout const * layout_;
508 SpellCheckerState speller_state_;
514 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
515 : owner_(owner), inset_owner_(nullptr), begin_of_body_(0), layout_(&layout), id_(-1)
522 int Paragraph::Private::make_id()
524 // The id is unique per session across buffers because it is used in
525 // LFUN_PARAGRAPH_GOTO to switch to a different buffer, for instance in the
528 static int next_id(0);
533 Paragraph::Private::Private(Private const & p, Paragraph * owner)
534 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
535 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
536 begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
537 layout_(p.layout_), id_(make_id())
539 requestSpellCheck(p.text_.size());
543 Paragraph::Private::Private(Private const & p, Paragraph * owner,
544 pos_type beg, pos_type end)
545 : owner_(owner), inset_owner_(p.inset_owner_),
546 params_(p.params_), changes_(p.changes_),
547 insetlist_(p.insetlist_, beg, end),
548 begin_of_body_(p.begin_of_body_), words_(p.words_),
549 layout_(p.layout_), id_(make_id())
551 if (beg >= pos_type(p.text_.size()))
553 text_ = p.text_.substr(beg, end - beg);
555 FontList::const_iterator fcit = fontlist_.begin();
556 FontList::const_iterator fend = fontlist_.end();
557 for (; fcit != fend; ++fcit) {
558 if (fcit->pos() < beg)
560 if (fcit->pos() >= end) {
561 // Add last entry in the fontlist_.
562 fontlist_.set(text_.size() - 1, fcit->font());
565 // Add a new entry in the fontlist_.
566 fontlist_.set(fcit->pos() - beg, fcit->font());
568 requestSpellCheck(p.text_.size());
572 void Paragraph::addChangesToToc(DocIterator const & cdit, Buffer const & buf,
573 bool output_active, TocBackend & backend) const
575 d->changes_.addToToc(cdit, buf, output_active, backend);
579 bool Paragraph::isDeleted(pos_type start, pos_type end) const
581 LASSERT(start >= 0 && start <= size(), return false);
582 LASSERT(end > start && end <= size() + 1, return false);
584 return d->changes_.isDeleted(start, end);
588 bool Paragraph::isChanged(pos_type start, pos_type end) const
590 LASSERT(start >= 0 && start <= size(), return false);
591 LASSERT(end > start && end <= size() + 1, return false);
593 return d->changes_.isChanged(start, end);
596 // FIXME: Ideally the diverse isChanged() methods should account for that!
597 bool Paragraph::hasChangedInsets(pos_type start, pos_type end) const
599 LASSERT(start >= 0 && start <= size(), return false);
600 LASSERT(end > start && end <= size() + 1, return false);
602 for (auto const & icit : d->insetlist_) {
603 if (icit.pos < start)
607 if (icit.inset && icit.inset->isChanged())
613 bool Paragraph::isChanged() const
615 return d->changes_.isChanged();
619 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
621 // keep the logic here in sync with the logic of eraseChars()
625 Change const & change = d->changes_.lookup(size());
626 return change.inserted() && change.currentAuthor();
629 Change Paragraph::parEndChange() const
631 return d->changes_.lookup(size());
635 void Paragraph::setChange(Change const & change)
637 // beware of the imaginary end-of-par character!
638 d->changes_.set(change, 0, size() + 1);
641 * Propagate the change recursively - but not in case of DELETED!
643 * Imagine that your co-author makes changes in an existing inset. He
644 * sends your document to you and you come to the conclusion that the
645 * inset should go completely. If you erase it, LyX must not delete all
646 * text within the inset. Otherwise, the change tracked insertions of
647 * your co-author get lost and there is no way to restore them later.
649 * Conclusion: An inset's content should remain untouched if you delete it
652 if (!change.deleted()) {
653 for (pos_type pos = 0; pos < size(); ++pos) {
654 if (Inset * inset = getInset(pos))
655 inset->setChange(change);
661 void Paragraph::setChange(pos_type pos, Change const & change)
663 LASSERT(pos >= 0 && pos <= size(), return);
664 d->changes_.set(change, pos);
666 // see comment in setChange(Change const &) above
667 if (!change.deleted() && pos < size())
668 if (Inset * inset = getInset(pos))
669 inset->setChange(change);
673 Change const & Paragraph::lookupChange(pos_type pos) const
675 LBUFERR(pos >= 0 && pos <= size());
676 return d->changes_.lookup(pos);
680 void Paragraph::acceptChanges(pos_type start, pos_type end)
682 LASSERT(start >= 0 && start <= size(), return);
683 LASSERT(end > start && end <= size() + 1, return);
685 for (pos_type pos = start; pos < end; ++pos) {
686 switch (lookupChange(pos).type) {
687 case Change::UNCHANGED:
688 // accept changes in nested inset
689 if (Inset * inset = getInset(pos))
690 inset->acceptChanges();
693 case Change::INSERTED:
694 d->changes_.set(Change(Change::UNCHANGED), pos);
695 // also accept changes in nested inset
696 if (Inset * inset = getInset(pos))
697 inset->acceptChanges();
700 case Change::DELETED:
701 // Suppress access to non-existent
702 // "end-of-paragraph char"
704 eraseChar(pos, false);
715 void Paragraph::rejectChanges(pos_type start, pos_type end)
717 LASSERT(start >= 0 && start <= size(), return);
718 LASSERT(end > start && end <= size() + 1, return);
720 for (pos_type pos = start; pos < end; ++pos) {
721 switch (lookupChange(pos).type) {
722 case Change::UNCHANGED:
723 // reject changes in nested inset
724 if (Inset * inset = getInset(pos))
725 inset->rejectChanges();
728 case Change::INSERTED:
729 // Suppress access to non-existent
730 // "end-of-paragraph char"
732 eraseChar(pos, false);
738 case Change::DELETED:
739 d->changes_.set(Change(Change::UNCHANGED), pos);
741 // Do NOT reject changes within a deleted inset!
742 // There may be insertions of a co-author inside of it!
750 void Paragraph::Private::insertChar(pos_type pos, char_type c,
751 Change const & change)
753 LASSERT(pos >= 0 && pos <= int(text_.size()), return);
756 changes_.insert(change, pos);
758 // This is actually very common when parsing buffers (and
759 // maybe inserting ascii text)
760 if (pos == pos_type(text_.size())) {
761 // when appending characters, no need to update tables
763 // but we want spell checking
764 requestSpellCheck(pos);
768 text_.insert(text_.begin() + pos, c);
770 // Update the font table.
771 fontlist_.increasePosAfterPos(pos);
774 insetlist_.increasePosAfterPos(pos);
776 // Update list of misspelled positions
777 speller_state_.increasePosAfterPos(pos);
781 bool Paragraph::insertInset(pos_type pos, Inset * inset,
782 Font const & font, Change const & change)
784 LASSERT(inset, return false);
785 LASSERT(pos >= 0 && pos <= size(), return false);
787 // Paragraph::insertInset() can be used in cut/copy/paste operation where
788 // d->inset_owner_ is not set yet.
789 if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
792 d->insertChar(pos, META_INSET, change);
793 LASSERT(d->text_[pos] == META_INSET, return false);
795 // Add a new entry in the insetlist_.
796 d->insetlist_.insert(inset, pos);
798 // Some insets require run of spell checker
799 requestSpellCheck(pos);
805 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
807 LASSERT(pos >= 0 && pos <= size(), return false);
809 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
812 Change change = d->changes_.lookup(pos);
814 // set the character to DELETED if
815 // a) it was previously unchanged or
816 // b) it was inserted by a co-author
818 if (!change.changed() ||
819 (change.inserted() && !change.currentAuthor())) {
820 setChange(pos, Change(Change::DELETED));
821 // request run of spell checker
822 requestSpellCheck(pos);
826 if (change.deleted())
830 // Don't physically access the imaginary end-of-paragraph character.
831 // eraseChar() can only mark it as DELETED. A physical deletion of
832 // end-of-par must be handled externally.
838 d->changes_.erase(pos);
840 // if it is an inset, delete the inset entry
841 if (d->text_[pos] == META_INSET)
842 d->insetlist_.erase(pos);
844 d->text_.erase(d->text_.begin() + pos);
846 // Update the fontlist_
847 d->fontlist_.erase(pos);
849 // Update the insetlist_
850 d->insetlist_.decreasePosAfterPos(pos);
852 // Update list of misspelled positions
853 d->speller_state_.decreasePosAfterPos(pos);
854 d->speller_state_.refreshLast(size());
860 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
862 LASSERT(start >= 0 && start <= size(), return 0);
863 LASSERT(end >= start && end <= size() + 1, return 0);
866 for (pos_type count = end - start; count; --count) {
867 if (!eraseChar(i, trackChanges))
873 // Handle combining characters
874 int Paragraph::Private::latexSurrogatePair(BufferParams const & bparams,
875 otexstream & os, char_type c, char_type next,
876 OutputParams const & runparams)
878 // Writing next here may circumvent a possible font change between
879 // c and next. Since next is only output if it forms a surrogate pair
880 // with c we can ignore this:
881 // A font change inside a surrogate pair does not make sense and is
882 // hopefully impossible to input.
883 // FIXME: change tracking
884 // Is this correct WRT change tracking?
885 Encoding const & encoding = *(runparams.encoding);
886 docstring latex1 = encoding.latexChar(next).first;
887 if (runparams.inIPA) {
888 string const tipashortcut = Encodings::TIPAShortcut(next);
889 if (!tipashortcut.empty()) {
890 latex1 = from_ascii(tipashortcut);
893 docstring latex2 = encoding.latexChar(c).first;
895 if (bparams.useNonTeXFonts || docstring(1, next) == latex1) {
896 // Encoding supports the combination:
897 // output as is (combining char after base char).
898 os << latex2 << latex1;
899 return latex1.length() + latex2.length();
902 os << latex1 << "{" << latex2 << "}";
903 return latex1.length() + latex2.length() + 2;
907 bool Paragraph::Private::simpleTeXBlanks(BufferParams const & bparams,
908 OutputParams const & runparams,
911 unsigned int & column,
913 Layout const & style)
915 if (style.pass_thru || runparams.pass_thru)
918 if (i + 1 < int(text_.size())) {
919 char_type next = text_[i + 1];
920 if (Encodings::isCombiningChar(next)) {
921 // This space has an accent, so we must always output it.
922 column += latexSurrogatePair(bparams, os, ' ', next, runparams) - 1;
927 if (runparams.linelen > 0
928 && column > runparams.linelen
930 && text_[i - 1] != ' '
931 && (i + 1 < int(text_.size()))
932 // same in FreeSpacing mode
933 && !owner_->isFreeSpacing()
934 // In typewriter mode, we want to avoid
935 // ! . ? : at the end of a line
936 && !(font.fontInfo().family() == TYPEWRITER_FAMILY
937 && (text_[i - 1] == '.'
938 || text_[i - 1] == '?'
939 || text_[i - 1] == ':'
940 || text_[i - 1] == '!'))) {
942 os.texrow().start(owner_->id(), i + 1);
944 } else if (style.free_spacing) {
953 void Paragraph::Private::latexInset(BufferParams const & bparams,
955 OutputParams & runparams,
958 Font const & outerfont,
960 Change & running_change,
961 Layout const & style,
963 unsigned int & column,
964 bool const fontswitch_inset,
965 bool const closeLanguage,
966 bool const lang_switched_at_inset)
968 Inset * inset = owner_->getInset(i);
971 if (style.pass_thru) {
972 odocstringstream ods;
973 inset->plaintext(ods, runparams);
978 // FIXME: move this to InsetNewline::latex
979 if (inset->lyxCode() == NEWLINE_CODE || inset->lyxCode() == SEPARATOR_CODE) {
980 // newlines are handled differently here than
981 // the default in simpleTeXSpecialChars().
982 if (!style.newline_allowed) {
986 bool needPar = false;
987 column += running_font.latexWriteEndChanges(
988 os, bparams, runparams,
989 basefont, basefont, needPar);
993 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
996 basefont = owner_->getLayoutFont(bparams, outerfont);
997 running_font = basefont;
999 if (runparams.moving_arg)
1003 os.texrow().start(owner_->id(), i + 1);
1007 if (owner_->isDeleted(i)) {
1008 if( ++runparams.inDeletedInset == 1)
1009 runparams.changeOfDeletedInset = owner_->lookupChange(i);
1012 if (inset->canTrackChanges()) {
1013 column += Changes::latexMarkChange(os, bparams, running_change,
1014 Change(Change::UNCHANGED), runparams);
1015 running_change = Change(Change::UNCHANGED);
1019 odocstream::pos_type const len = os.os().tellp();
1021 if (inset->forceLTR(runparams)
1022 && running_font.isRightToLeft()
1023 // ERT is an exception, it should be output with no
1024 // decorations at all
1025 && inset->lyxCode() != ERT_CODE) {
1026 if (runparams.use_polyglossia) {
1028 } else if (running_font.language()->lang() == "farsi"
1029 || running_font.language()->lang() == "arabic_arabi")
1030 os << "\\textLR{" << termcmd;
1036 if (open_font && (!inset->inheritFont() || fontswitch_inset)) {
1037 bool lang_closed = false;
1038 // Close language if needed
1039 if (closeLanguage) {
1040 // We need prev_font here as language changes directly at inset
1041 // will only be started inside the inset.
1042 Font const prev_font = (i > 0) ?
1043 owner_->getFont(bparams, i - 1, outerfont)
1045 Font tmpfont(basefont);
1046 tmpfont.setLanguage(prev_font.language());
1047 bool needPar = false;
1048 unsigned int count = tmpfont.latexWriteEndChanges(os, bparams, runparams,
1050 needPar, closeLanguage);
1052 lang_closed = count > 0;
1054 // Update the running_font, making sure, however,
1055 // to leave the language as it was.
1056 // FIXME: probably a better way to keep track of the old
1057 // language, than copying the entire font?
1058 Font const copy_font(running_font);
1059 basefont = owner_->getLayoutFont(bparams, outerfont);
1060 running_font = basefont;
1062 running_font.setLanguage(copy_font.language());
1063 // For these, we use switches, so they should be taken as
1064 // base inside the inset.
1065 basefont.fontInfo().setSize(copy_font.fontInfo().size());
1066 basefont.fontInfo().setFamily(copy_font.fontInfo().family());
1067 basefont.fontInfo().setSeries(copy_font.fontInfo().series());
1068 // Now re-do font changes in a way needed here
1069 // (using switches with multi-par insets)
1070 InsetText const * textinset = inset->asInsetText();
1071 bool const cprotect = textinset
1072 ? textinset->hasCProtectContent(runparams.moving_arg)
1073 && !textinset->text().isMainText()
1075 unsigned int count2 = basefont.latexWriteStartChanges(os, bparams,
1076 runparams, running_font,
1080 if (count2 == 0 && (lang_closed || lang_switched_at_inset))
1084 runparams.local_font = &basefont;
1087 size_t const previous_row_count = os.texrow().rows();
1090 runparams.lastid = id_;
1091 runparams.lastpos = i;
1092 inset->latex(os, runparams);
1093 } catch (EncodingException & e) {
1094 // add location information and throw again.
1103 if (os.texrow().rows() > previous_row_count) {
1104 os.texrow().start(owner_->id(), i + 1);
1107 column += (unsigned int)(os.os().tellp() - len);
1110 if (owner_->isDeleted(i))
1111 --runparams.inDeletedInset;
1115 void Paragraph::Private::latexSpecialChar(otexstream & os,
1116 BufferParams const & bparams,
1117 OutputParams const & runparams,
1118 Font const & running_font,
1119 string & alien_script,
1120 Layout const & style,
1123 unsigned int & column)
1125 char_type const c = owner_->getUChar(bparams, runparams, i);
1127 if (style.pass_thru || runparams.pass_thru
1128 || contains(style.pass_thru_chars, c)
1129 || contains(runparams.pass_thru_chars, c)) {
1131 Encoding const * const enc = runparams.encoding;
1132 if (enc && !enc->encodable(c))
1133 throw EncodingException(c);
1139 // TIPA uses its own T3 encoding
1140 if (runparams.inIPA && latexSpecialT3(c, os, i, column))
1142 // If T1 font encoding is used, use the special
1143 // characters it provides.
1144 // NOTE: Some languages reset the font encoding internally to a
1145 // non-standard font encoding. If we are using such a language,
1146 // we do not output special T1 chars.
1147 if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1148 && !runparams.isFullUnicode() && bparams.main_font_encoding() == "T1"
1149 && latexSpecialT1(c, os, i, column))
1151 // NOTE: "fontspec" (non-TeX fonts) sets the font encoding to "TU" (untill 2017 "EU1" or "EU2")
1152 else if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1153 && runparams.isFullUnicode() && latexSpecialTU(c, os, i, column))
1156 // Otherwise, we use what LaTeX provides us.
1159 os << "\\textbackslash" << termcmd;
1163 os << "\\textless" << termcmd;
1167 os << "\\textgreater" << termcmd;
1171 os << "\\textbar" << termcmd;
1176 if (i + 1 < static_cast<pos_type>(text_.size()) &&
1177 (end_pos == -1 || i + 1 < end_pos) &&
1178 text_[i+1] == '-') {
1179 // Prevent "--" becoming an en dash and "---" an em dash.
1180 // (Within \ttfamily, "---" is merged to en dash + hyphen.)
1186 os << "\\textquotedbl" << termcmd;
1191 case '%': case '#': case '{':
1199 os << "\\textasciitilde" << termcmd;
1204 os << "\\textasciicircum" << termcmd;
1211 // avoid being mistaken for optional arguments
1219 // Blanks are printed before font switching.
1220 // Sure? I am not! (try nice-latex)
1221 // I am sure it's correct. LyX might be smarter
1222 // in the future, but for now, nothing wrong is
1228 // XeTeX's dash behaviour is determined via a global setting
1229 if (bparams.use_dash_ligatures
1230 && owner_->getFontSettings(bparams, i).fontInfo().family() != TYPEWRITER_FAMILY
1232 // TODO #10961: && not in inset Flex Code
1233 // TODO #10961: && not in layout LyXCode
1234 && (!bparams.useNonTeXFonts || runparams.flavor != OutputParams::XETEX)) {
1251 Encoding const & encoding = *(runparams.encoding);
1252 char_type next = '\0';
1253 if (i + 1 < int(text_.size())) {
1254 next = text_[i + 1];
1255 if (Encodings::isCombiningChar(next)) {
1256 column += latexSurrogatePair(bparams, os, c, next, runparams) - 1;
1261 pair<docstring, bool> latex = encoding.latexChar(c);
1262 docstring nextlatex;
1263 bool nexttipas = false;
1264 string nexttipashortcut;
1265 if (next != '\0' && next != META_INSET && !encoding.encodable(next)) {
1266 nextlatex = encoding.latexChar(next).first;
1267 if (runparams.inIPA) {
1268 nexttipashortcut = Encodings::TIPAShortcut(next);
1269 nexttipas = !nexttipashortcut.empty();
1273 if (runparams.inIPA) {
1274 string const tipashortcut = Encodings::TIPAShortcut(c);
1275 if (!tipashortcut.empty()) {
1276 latex.first = from_ascii(tipashortcut);
1277 latex.second = false;
1281 // eventually close "script wrapper" command (see `Paragraph::latex`)
1282 if (!alien_script.empty()
1283 && alien_script != Encodings::isKnownScriptChar(next)) {
1284 column += latex.first.length();
1285 alien_script.clear();
1286 os << latex.first << "}";
1290 && ((!prefixIs(nextlatex, '\\')
1291 && !prefixIs(nextlatex, '{')
1292 && !prefixIs(nextlatex, '}'))
1294 && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1296 // Prevent eating of a following space or command corruption by
1297 // following characters
1298 if (next == ' ' || next == '\0') {
1299 column += latex.first.length() + 1;
1300 os << latex.first << "{}";
1302 column += latex.first.length();
1303 os << latex.first << " ";
1306 column += latex.first.length() - 1;
1314 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1315 pos_type i, unsigned int & column)
1321 // In T1 encoding, these characters exist
1322 // but we should avoid ligatures
1323 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1325 os << "\\textcompwordmark" << termcmd;
1332 // soul.sty breaks with \char`\"
1333 os << "\\textquotedbl" << termcmd;
1342 bool Paragraph::Private::latexSpecialTU(char_type const c, otexstream & os,
1343 pos_type i, unsigned int & column)
1345 // TU encoding is currently on par with T1.
1346 return latexSpecialT1(c, os, i, column);
1350 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1351 pos_type /*i*/, unsigned int & column)
1361 os << "\\textvertline" << termcmd;
1370 void Paragraph::Private::validate(LaTeXFeatures & features) const
1372 if (layout_->inpreamble && inset_owner_) {
1373 // FIXME: Using a string stream here circumvents the encoding
1374 // switching machinery of odocstream. Therefore the
1375 // output is wrong if this paragraph contains content
1376 // that needs to switch encoding.
1377 Buffer const & buf = inset_owner_->buffer();
1378 otexstringstream os;
1379 os << layout_->preamble();
1380 size_t const length = os.length();
1381 TeXOnePar(buf, *inset_owner_->getText(int(buf.getParFromID(owner_->id()).idx())),
1382 buf.getParFromID(owner_->id()).pit(), os,
1383 features.runparams(), string(), 0, -1, true);
1384 if (os.length() > length)
1385 features.addPreambleSnippet(os.release(), true);
1388 if (features.runparams().flavor == OutputParams::HTML
1389 && layout_->htmltitle()) {
1390 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1393 // check the params.
1394 if (!params_.spacing().isDefault())
1395 features.require("setspace");
1398 features.useLayout(layout_->name());
1401 fontlist_.validate(features);
1403 // then the indentation
1404 if (!params_.leftIndent().zero())
1405 features.require("ParagraphLeftIndent");
1408 InsetList::const_iterator icit = insetlist_.begin();
1409 InsetList::const_iterator iend = insetlist_.end();
1410 for (; icit != iend; ++icit) {
1412 features.inDeletedInset(owner_->isDeleted(icit->pos));
1413 if (icit->inset->lyxCode() == FOOT_CODE) {
1414 // FIXME: an item inset would make things much easier.
1415 if ((layout_->latextype == LATEX_LIST_ENVIRONMENT
1416 || (layout_->latextype == LATEX_ITEM_ENVIRONMENT
1417 && layout_->margintype == MARGIN_FIRST_DYNAMIC))
1418 && (icit->pos < begin_of_body_
1419 || (icit->pos == begin_of_body_
1420 && (icit->pos == 0 || text_[icit->pos - 1] != ' '))))
1421 features.saveNoteEnv("description");
1423 icit->inset->validate(features);
1424 features.inDeletedInset(false);
1425 if (layout_->needprotect &&
1426 icit->inset->lyxCode() == FOOT_CODE)
1427 features.require("NeedLyXFootnoteCode");
1431 // then the contents
1432 BufferParams const bp = features.runparams().is_child
1433 ? features.buffer().masterParams() : features.buffer().params();
1434 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1435 char_type c = text_[i];
1436 CharInfo const & ci = Encodings::unicodeCharInfo(c);
1438 if (features.runparams().isFullUnicode() && bp.useNonTeXFonts)
1439 features.require("textquotedblp");
1440 else if (bp.main_font_encoding() != "T1"
1441 || ((&owner_->getFontSettings(bp, i))->language()->internalFontEncoding()))
1442 features.require("textquotedbl");
1443 } else if (ci.textfeature() && contains(ci.textpreamble(), '=')) {
1444 // features that depend on the font or input encoding
1445 string feats = ci.textpreamble();
1446 string fontenc = (&owner_->getFontSettings(bp, i))->language()->fontenc(bp);
1447 if (fontenc.empty())
1448 fontenc = features.runparams().main_fontenc;
1449 while (!feats.empty()) {
1451 feats = split(feats, feat, ',');
1452 if (contains(feat, "!=")) {
1453 // a feature that is required except for the spcified
1454 // font or input encodings
1456 string const contexts = ltrim(split(feat, realfeature, '!'), "=");
1457 // multiple encodings are separated by semicolon
1458 vector<string> context = getVectorFromString(contexts, ";");
1459 // require feature if the context matches neither current font
1460 // nor input encoding
1461 if (std::find(context.begin(), context.end(), fontenc) == context.end()
1462 && std::find(context.begin(), context.end(),
1463 features.runparams().encoding->name()) == context.end())
1464 features.require(realfeature);
1465 } else if (contains(feat, '=')) {
1466 // a feature that is required only for the spcified
1467 // font or input encodings
1469 string const contexts = split(feat, realfeature, '=');
1470 // multiple encodings are separated by semicolon
1471 vector<string> context = getVectorFromString(contexts, ";");
1472 // require feature if the context matches either current font
1473 // or input encoding
1474 if (std::find(context.begin(), context.end(), fontenc) != context.end()
1475 || std::find(context.begin(), context.end(),
1476 features.runparams().encoding->name()) != context.end())
1477 features.require(realfeature);
1480 } else if (!bp.use_dash_ligatures
1481 && (c == 0x2013 || c == 0x2014)
1482 && bp.useNonTeXFonts
1483 && features.runparams().flavor == OutputParams::XETEX)
1484 // XeTeX's dash behaviour is determined via a global setting
1485 features.require("xetexdashbreakstate");
1486 BufferEncodings::validate(c, features);
1490 /////////////////////////////////////////////////////////////////////
1494 /////////////////////////////////////////////////////////////////////
1497 Layout const emptyParagraphLayout;
1500 Paragraph::Paragraph()
1501 : d(new Paragraph::Private(this, emptyParagraphLayout))
1508 Paragraph::Paragraph(Paragraph const & par)
1509 : itemdepth(par.itemdepth),
1510 d(new Paragraph::Private(*par.d, this))
1516 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1517 : itemdepth(par.itemdepth),
1518 d(new Paragraph::Private(*par.d, this, beg, end))
1524 Paragraph & Paragraph::operator=(Paragraph const & par)
1526 // needed as we will destroy the private part before copying it
1528 itemdepth = par.itemdepth;
1532 d = new Private(*par.d, this);
1539 Paragraph::~Paragraph()
1548 // this shall be called just before every "os << ..." action.
1549 void flushString(ostream & os, docstring & s)
1558 void Paragraph::write(ostream & os, BufferParams const & bparams,
1559 depth_type & dth) const
1561 // The beginning or end of a deeper (i.e. nested) area?
1562 if (dth != d->params_.depth()) {
1563 if (d->params_.depth() > dth) {
1564 while (d->params_.depth() > dth) {
1565 os << "\n\\begin_deeper";
1569 while (d->params_.depth() < dth) {
1570 os << "\n\\end_deeper";
1576 // First write the layout
1577 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1579 d->params_.write(os);
1581 Font font1(inherit_font, bparams.language);
1583 Change running_change = Change(Change::UNCHANGED);
1585 // this string is used as a buffer to avoid repetitive calls
1586 // to to_utf8(), which turn out to be expensive (JMarc)
1587 docstring write_buffer;
1590 for (pos_type i = 0; i <= size(); ++i) {
1592 Change const & change = lookupChange(i);
1593 if (change != running_change)
1594 flushString(os, write_buffer);
1595 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1596 running_change = change;
1601 // Write font changes
1602 Font font2 = getFontSettings(bparams, i);
1603 if (font2 != font1) {
1604 flushString(os, write_buffer);
1605 font2.lyxWriteChanges(font1, os);
1610 char_type const c = d->text_[i];
1613 if (Inset const * inset = getInset(i)) {
1614 flushString(os, write_buffer);
1615 if (inset->directWrite()) {
1616 // international char, let it write
1617 // code directly so it's shorter in
1623 os << "\\begin_inset ";
1625 os << "\n\\end_inset\n\n";
1628 // FIXME This can be removed again once the mystery
1629 // crash has been resolved.
1634 flushString(os, write_buffer);
1635 os << "\n\\backslash\n";
1639 flushString(os, write_buffer);
1640 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1647 if ((column > 70 && c == ' ')
1649 flushString(os, write_buffer);
1653 // this check is to amend a bug. LyX sometimes
1654 // inserts '\0' this could cause problems.
1656 write_buffer.push_back(c);
1658 LYXERR0("NUL char in structure.");
1664 flushString(os, write_buffer);
1665 os << "\n\\end_layout\n";
1666 // FIXME This can be removed again once the mystery
1667 // crash has been resolved.
1672 void Paragraph::validate(LaTeXFeatures & features) const
1674 d->validate(features);
1675 bool fragile = features.runparams().moving_arg;
1676 fragile |= layout().needprotect;
1677 if (inInset().getLayout().isNeedProtect())
1679 if (needsCProtection(fragile))
1680 features.require("cprotect");
1684 void Paragraph::insert(pos_type start, docstring const & str,
1685 Font const & font, Change const & change)
1687 for (size_t i = 0, n = str.size(); i != n ; ++i)
1688 insertChar(start + i, str[i], font, change);
1692 void Paragraph::appendChar(char_type c, Font const & font,
1693 Change const & change)
1696 d->changes_.insert(change, d->text_.size());
1697 // when appending characters, no need to update tables
1698 d->text_.push_back(c);
1699 setFont(d->text_.size() - 1, font);
1700 d->requestSpellCheck(d->text_.size() - 1);
1704 void Paragraph::appendString(docstring const & s, Font const & font,
1705 Change const & change)
1707 pos_type end = s.size();
1708 size_t oldsize = d->text_.size();
1709 size_t newsize = oldsize + end;
1710 size_t capacity = d->text_.capacity();
1711 if (newsize >= capacity)
1712 d->text_.reserve(max(capacity + 100, newsize));
1714 // when appending characters, no need to update tables
1717 // FIXME: Optimize this!
1718 for (size_t i = oldsize; i != newsize; ++i) {
1720 d->changes_.insert(change, i);
1721 d->requestSpellCheck(i);
1723 d->fontlist_.set(oldsize, font);
1724 d->fontlist_.set(newsize - 1, font);
1728 void Paragraph::insertChar(pos_type pos, char_type c,
1731 d->insertChar(pos, c, Change(trackChanges ?
1732 Change::INSERTED : Change::UNCHANGED));
1736 void Paragraph::insertChar(pos_type pos, char_type c,
1737 Font const & font, bool trackChanges)
1739 d->insertChar(pos, c, Change(trackChanges ?
1740 Change::INSERTED : Change::UNCHANGED));
1745 void Paragraph::insertChar(pos_type pos, char_type c,
1746 Font const & font, Change const & change)
1748 d->insertChar(pos, c, change);
1753 void Paragraph::resetFonts(Font const & font)
1755 d->fontlist_.clear();
1756 d->fontlist_.set(0, font);
1757 d->fontlist_.set(d->text_.size() - 1, font);
1760 // Gets uninstantiated font setting at position.
1761 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1765 LYXERR0("pos: " << pos << " size: " << size());
1769 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1770 if (cit != d->fontlist_.end())
1773 if (pos == size() && !empty())
1774 return getFontSettings(bparams, pos - 1);
1776 // Optimisation: avoid a full font instantiation if there is no
1777 // language change from previous call.
1778 static Font previous_font;
1779 static Language const * previous_lang = nullptr;
1780 Language const * lang = getParLanguage(bparams);
1781 if (lang != previous_lang) {
1782 previous_lang = lang;
1783 previous_font = Font(inherit_font, lang);
1785 return previous_font;
1789 FontSpan Paragraph::fontSpan(pos_type pos) const
1791 LBUFERR(pos <= size());
1794 return FontSpan(pos, pos);
1797 FontList::const_iterator cit = d->fontlist_.begin();
1798 FontList::const_iterator end = d->fontlist_.end();
1799 for (; cit != end; ++cit) {
1800 if (cit->pos() >= pos) {
1801 if (pos >= beginOfBody())
1802 return FontSpan(max(start, beginOfBody()),
1805 return FontSpan(start,
1806 min(beginOfBody() - 1,
1809 start = cit->pos() + 1;
1812 // This should not happen, but if so, we take no chances.
1813 LYXERR0("Paragraph::fontSpan: position not found in fontinfo table!");
1814 LASSERT(false, return FontSpan(pos, pos));
1818 // Gets uninstantiated font setting at position 0
1819 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1821 if (!empty() && !d->fontlist_.empty())
1822 return d->fontlist_.begin()->font();
1824 // Optimisation: avoid a full font instantiation if there is no
1825 // language change from previous call.
1826 static Font previous_font;
1827 static Language const * previous_lang = nullptr;
1828 if (bparams.language != previous_lang) {
1829 previous_lang = bparams.language;
1830 previous_font = Font(inherit_font, bparams.language);
1833 return previous_font;
1837 // Gets the fully instantiated font at a given position in a paragraph
1838 // This is basically the same function as Text::GetFont() in text2.cpp.
1839 // The difference is that this one is used for generating the LaTeX file,
1840 // and thus cosmetic "improvements" are disallowed: This has to deliver
1841 // the true picture of the buffer. (Asger)
1842 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1843 Font const & outerfont) const
1847 Font font = getFontSettings(bparams, pos);
1849 pos_type const body_pos = beginOfBody();
1850 FontInfo & fi = font.fontInfo();
1852 fi.realize(d->layout_->labelfont);
1854 fi.realize(d->layout_->font);
1856 fi.realize(outerfont.fontInfo());
1857 fi.realize(bparams.getFont().fontInfo());
1863 Font const Paragraph::getLabelFont
1864 (BufferParams const & bparams, Font const & outerfont) const
1866 FontInfo tmpfont = d->layout_->labelfont;
1867 tmpfont.realize(outerfont.fontInfo());
1868 tmpfont.realize(bparams.getFont().fontInfo());
1869 return Font(tmpfont, getParLanguage(bparams));
1873 Font const Paragraph::getLayoutFont
1874 (BufferParams const & bparams, Font const & outerfont) const
1876 FontInfo tmpfont = d->layout_->font;
1877 tmpfont.realize(outerfont.fontInfo());
1878 tmpfont.realize(bparams.getFont().fontInfo());
1879 return Font(tmpfont, getParLanguage(bparams));
1883 char_type Paragraph::getUChar(BufferParams const & bparams,
1884 OutputParams const & rp,
1887 char_type c = d->text_[pos];
1889 // Return unchanged character in LTR languages
1890 // or if we use poylglossia/bidi (XeTeX).
1891 if (rp.useBidiPackage()
1892 || !getFontSettings(bparams, pos).isRightToLeft())
1895 // Without polyglossia/bidi, we need to account for some special cases.
1896 // FIXME This needs to be audited!
1898 // * The input is as expected for all delimiters
1899 // => checked for Hebrew!
1900 // * The output matches the display in the LyX workarea
1901 // => checked for Hebrew!
1902 // * The special cases below are really necessary
1903 // => checked for Hebrew!
1904 // * In arabic_arabi, brackets are transformed to Arabic
1905 // Ornate Parentheses. Is this is really wanted?
1907 string const & lang = getFontSettings(bparams, pos).language()->lang();
1910 // 1. In the following languages, parentheses need to be reversed.
1911 // Also with polyglodia/luabidi
1912 bool const reverseparens = (lang == "hebrew" || rp.use_polyglossia);
1914 // 2. In the following languages, brackets don't need to be reversed.
1915 bool const reversebrackets = lang != "arabic_arabtex"
1916 && lang != "arabic_arabi"
1919 // Now swap delimiters if needed.
1930 if (reversebrackets)
1934 if (reversebrackets)
1955 void Paragraph::setFont(pos_type pos, Font const & font)
1957 LASSERT(pos <= size(), return);
1959 // First, reduce font against layout/label font
1960 // Update: The setCharFont() routine in text2.cpp already
1961 // reduces font, so we don't need to do that here. (Asger)
1963 d->fontlist_.set(pos, font);
1967 void Paragraph::makeSameLayout(Paragraph const & par)
1969 d->layout_ = par.d->layout_;
1970 d->params_ = par.d->params_;
1974 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1976 if (isFreeSpacing())
1982 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1983 if (eraseChar(pos, trackChanges))
1989 return count > 0 || pos > 0;
1993 bool Paragraph::hasSameLayout(Paragraph const & par) const
1995 return par.d->layout_ == d->layout_
1996 && d->params_.sameLayout(par.d->params_);
2000 depth_type Paragraph::getDepth() const
2002 return d->params_.depth();
2006 depth_type Paragraph::getMaxDepthAfter() const
2008 if (d->layout_->isEnvironment())
2009 return d->params_.depth() + 1;
2011 return d->params_.depth();
2015 LyXAlignment Paragraph::getAlign(BufferParams const & bparams) const
2017 if (d->params_.align() == LYX_ALIGN_LAYOUT)
2018 return getDefaultAlign(bparams);
2020 return d->params_.align();
2024 LyXAlignment Paragraph::getDefaultAlign(BufferParams const & bparams) const
2026 LyXAlignment res = layout().align;
2027 if (isRTL(bparams)) {
2029 if (res == LYX_ALIGN_LEFT)
2030 res = LYX_ALIGN_RIGHT;
2031 else if (res == LYX_ALIGN_RIGHT)
2032 res = LYX_ALIGN_LEFT;
2038 docstring const & Paragraph::labelString() const
2040 return d->params_.labelString();
2044 // the next two functions are for the manual labels
2045 docstring const Paragraph::getLabelWidthString() const
2047 if (d->layout_->margintype == MARGIN_MANUAL
2048 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
2049 return d->params_.labelWidthString();
2051 return _("Senseless with this layout!");
2055 void Paragraph::setLabelWidthString(docstring const & s)
2057 d->params_.labelWidthString(s);
2061 docstring Paragraph::expandLabel(Layout const & layout,
2062 BufferParams const & bparams) const
2064 return expandParagraphLabel(layout, bparams, true);
2068 docstring Paragraph::expandParagraphLabel(Layout const & layout,
2069 BufferParams const & bparams, bool process_appendix) const
2071 DocumentClass const & tclass = bparams.documentClass();
2072 string const & lang = getParLanguage(bparams)->code();
2073 bool const in_appendix = process_appendix && d->params_.appendix();
2074 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
2076 if (fmt.empty() && !layout.counter.empty())
2077 return tclass.counters().theCounter(layout.counter, lang);
2079 // handle 'inherited level parts' in 'fmt',
2080 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
2081 size_t const i = fmt.find('@', 0);
2082 if (i != docstring::npos) {
2083 size_t const j = fmt.find('@', i + 1);
2084 if (j != docstring::npos) {
2085 docstring parent(fmt, i + 1, j - i - 1);
2086 docstring label = from_ascii("??");
2087 if (tclass.hasLayout(parent))
2088 label = expandParagraphLabel(tclass[parent], bparams,
2090 fmt = docstring(fmt, 0, i) + label
2091 + docstring(fmt, j + 1, docstring::npos);
2095 return tclass.counters().counterLabel(fmt, lang);
2099 void Paragraph::applyLayout(Layout const & new_layout)
2101 d->layout_ = &new_layout;
2102 LyXAlignment const oldAlign = d->params_.align();
2104 if (!(oldAlign & d->layout_->alignpossible)) {
2105 frontend::Alert::warning(_("Alignment not permitted"),
2106 _("The new layout does not permit the alignment previously used.\nSetting to default."));
2107 d->params_.align(LYX_ALIGN_LAYOUT);
2112 pos_type Paragraph::beginOfBody() const
2114 return d->begin_of_body_;
2118 void Paragraph::setBeginOfBody()
2120 if (d->layout_->labeltype != LABEL_MANUAL) {
2121 d->begin_of_body_ = 0;
2125 // Unroll the first two cycles of the loop
2126 // and remember the previous character to
2127 // remove unnecessary getChar() calls
2129 pos_type end = size();
2130 bool prev_char_deleted = false;
2131 if (i < end && (!(isNewline(i) || isEnvSeparator(i)) || isDeleted(i))) {
2134 char_type previous_char = d->text_[i];
2135 if (!(isNewline(i) || isEnvSeparator(i))) {
2137 while (i < end && (previous_char != ' ' || prev_char_deleted)) {
2138 char_type temp = d->text_[i];
2139 prev_char_deleted = isDeleted(i);
2140 if (!isDeleted(i) && (isNewline(i) || isEnvSeparator(i)))
2143 previous_char = temp;
2149 d->begin_of_body_ = i;
2153 bool Paragraph::allowParagraphCustomization() const
2155 return inInset().allowParagraphCustomization();
2159 bool Paragraph::usePlainLayout() const
2161 return inInset().usePlainLayout();
2165 bool Paragraph::isPassThru() const
2167 return inInset().isPassThru() || d->layout_->pass_thru;
2172 // paragraphs inside floats need different alignment tags to avoid
2175 bool noTrivlistCentering(InsetCode code)
2177 return code == FLOAT_CODE
2178 || code == WRAP_CODE
2179 || code == CELL_CODE;
2183 string correction(string const & orig)
2185 if (orig == "flushleft")
2186 return "raggedright";
2187 if (orig == "flushright")
2188 return "raggedleft";
2189 if (orig == "center")
2195 bool corrected_env(otexstream & os, string const & suffix, string const & env,
2196 InsetCode code, bool const lastpar, int & col)
2198 string macro = suffix + "{";
2199 if (noTrivlistCentering(code)) {
2201 // the last paragraph in non-trivlist-aligned
2202 // context is special (to avoid unwanted whitespace)
2203 if (suffix == "\\begin") {
2204 macro = "\\" + correction(env) + "{}";
2205 os << from_ascii(macro);
2206 col += macro.size();
2211 macro += correction(env);
2215 if (suffix == "\\par\\end") {
2219 os << from_ascii(macro);
2220 col += macro.size();
2221 if (suffix == "\\begin") {
2231 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2232 otexstream & os, OutputParams const & runparams) const
2237 (bparams.paragraph_separation == BufferParams::ParagraphIndentSeparation) ?
2238 (layout_->toggle_indent != ITOGGLE_NEVER) :
2239 (layout_->toggle_indent == ITOGGLE_ALWAYS);
2241 if (canindent && params_.noindent() && !layout_->pass_thru) {
2242 os << "\\noindent ";
2246 LyXAlignment const curAlign = params_.align();
2248 if (curAlign == layout_->align)
2252 case LYX_ALIGN_NONE:
2253 case LYX_ALIGN_BLOCK:
2254 case LYX_ALIGN_LAYOUT:
2255 case LYX_ALIGN_SPECIAL:
2256 case LYX_ALIGN_DECIMAL:
2258 case LYX_ALIGN_LEFT:
2259 case LYX_ALIGN_RIGHT:
2260 case LYX_ALIGN_CENTER:
2261 if (runparams.moving_arg) {
2268 string const begin_tag = "\\begin";
2269 InsetCode code = ownerCode();
2270 bool const lastpar = runparams.isLastPar;
2271 // RTL in classic (PDF)LaTeX (without the Bidi package)
2272 // Luabibdi (used by LuaTeX) behaves like classic
2273 bool const rtl_classic = owner_->getParLanguage(bparams)->rightToLeft()
2274 && !runparams.useBidiPackage();
2277 case LYX_ALIGN_NONE:
2278 case LYX_ALIGN_BLOCK:
2279 case LYX_ALIGN_LAYOUT:
2280 case LYX_ALIGN_SPECIAL:
2281 case LYX_ALIGN_DECIMAL:
2283 case LYX_ALIGN_LEFT: {
2285 // Classic (PDF)LaTeX switches the left/right logic in RTL mode
2286 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2288 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2290 } case LYX_ALIGN_RIGHT: {
2292 // Classic (PDF)LaTeX switches the left/right logic in RTL mode
2293 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2295 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2297 } case LYX_ALIGN_CENTER: {
2298 corrected_env(os, begin_tag, "center", code, lastpar, column);
2307 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2308 otexstream & os, OutputParams const & runparams) const
2310 LyXAlignment const curAlign = params_.align();
2312 if (curAlign == layout_->align)
2316 case LYX_ALIGN_NONE:
2317 case LYX_ALIGN_BLOCK:
2318 case LYX_ALIGN_LAYOUT:
2319 case LYX_ALIGN_SPECIAL:
2320 case LYX_ALIGN_DECIMAL:
2322 case LYX_ALIGN_LEFT:
2323 case LYX_ALIGN_RIGHT:
2324 case LYX_ALIGN_CENTER:
2325 if (runparams.moving_arg)
2330 bool output = false;
2332 string const end_tag = "\\par\\end";
2333 InsetCode code = ownerCode();
2334 bool const lastpar = runparams.isLastPar;
2335 // RTL in classic (PDF)LaTeX (without the Bidi package)
2336 // Luabibdi (used by LuaTeX) behaves like classic
2337 bool const rtl_classic = owner_->getParLanguage(bparams)->rightToLeft()
2338 && !runparams.useBidiPackage();
2341 case LYX_ALIGN_NONE:
2342 case LYX_ALIGN_BLOCK:
2343 case LYX_ALIGN_LAYOUT:
2344 case LYX_ALIGN_SPECIAL:
2345 case LYX_ALIGN_DECIMAL:
2347 case LYX_ALIGN_LEFT: {
2349 // Classic (PDF)LaTeX switches the left/right logic in RTL mode
2350 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2352 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2354 } case LYX_ALIGN_RIGHT: {
2356 // Classic (PDF)LaTeX switches the left/right logic in RTL mode
2357 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2359 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2361 } case LYX_ALIGN_CENTER: {
2362 corrected_env(os, end_tag, "center", code, lastpar, col);
2367 return output || lastpar;
2371 // This one spits out the text of the paragraph
2372 void Paragraph::latex(BufferParams const & bparams,
2373 Font const & outerfont,
2375 OutputParams const & runparams,
2376 int start_pos, int end_pos, bool force) const
2378 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
2380 // FIXME This check should not be needed. Perhaps issue an
2381 // error if it triggers.
2382 Layout const & style = inInset().forcePlainLayout() ?
2383 bparams.documentClass().plainLayout() : *d->layout_;
2385 if (!force && style.inpreamble)
2388 bool const allowcust = allowParagraphCustomization();
2390 // Current base font for all inherited font changes, without any
2391 // change caused by an individual character, except for the language:
2392 // It is set to the language of the first character.
2393 // As long as we are in the label, this font is the base font of the
2394 // label. Before the first body character it is set to the base font
2398 // If there is an open font-encoding changing command (script wrapper),
2399 // alien_script is set to its name
2400 string alien_script;
2403 // Maybe we have to create a optional argument.
2404 pos_type body_pos = beginOfBody();
2405 unsigned int column = 0;
2407 // If we are inside an non inheritFont() inset, the real outerfont is local_font
2408 Font const real_outerfont = (!inInset().inheritFont()
2409 && runparams.local_font != nullptr)
2410 ? Font(runparams.local_font->fontInfo()) : outerfont;
2413 // the optional argument is kept in curly brackets in
2414 // case it contains a ']'
2415 // This is not strictly needed, but if this is changed it
2416 // would be a file format change, and tex2lyx would need
2417 // to be adjusted, since it unconditionally removes the
2418 // braces when it parses \item.
2421 basefont = getLabelFont(bparams, real_outerfont);
2423 basefont = getLayoutFont(bparams, real_outerfont);
2426 // Which font is currently active?
2427 Font running_font(basefont);
2428 // Do we have an open font change?
2429 bool open_font = false;
2431 Change runningChange = Change(Change::UNCHANGED);
2433 Encoding const * const prev_encoding = runparams.encoding;
2435 os.texrow().start(id(), 0);
2437 // if the paragraph is empty, the loop will not be entered at all
2439 // For InTitle commands, we have already opened a group
2440 // in output_latex::TeXOnePar.
2441 if (style.isCommand() && !style.intitle) {
2445 if (!style.leftdelim().empty()) {
2446 os << style.leftdelim();
2447 column += style.leftdelim().size();
2450 column += d->startTeXParParams(bparams, os, runparams);
2453 // Whether a \par can be issued for insets typeset inline with text.
2454 // Yes if greater than 0. This has to be static.
2455 THREAD_LOCAL_STATIC int parInline = 0;
2457 for (pos_type i = 0; i < size(); ++i) {
2458 // First char in paragraph or after label?
2459 if (i == body_pos) {
2462 bool needPar = false;
2463 column += running_font.latexWriteEndChanges(
2464 os, bparams, runparams,
2465 basefont, basefont, needPar);
2468 basefont = getLayoutFont(bparams, real_outerfont);
2469 running_font = basefont;
2471 column += Changes::latexMarkChange(os, bparams,
2472 runningChange, Change(Change::UNCHANGED),
2474 runningChange = Change(Change::UNCHANGED);
2479 // For InTitle commands, we have already opened a group
2480 // in output_latex::TeXOnePar.
2481 if (style.isCommand() && !style.intitle) {
2486 if (!style.leftdelim().empty()) {
2487 os << style.leftdelim();
2488 column += style.leftdelim().size();
2492 column += d->startTeXParParams(bparams, os,
2496 runparams.wasDisplayMath = runparams.inDisplayMath;
2497 runparams.inDisplayMath = false;
2498 bool deleted_display_math = false;
2499 Change const & change = runparams.inDeletedInset
2500 ? runparams.changeOfDeletedInset : lookupChange(i);
2502 char_type const c = d->text_[i];
2504 // Check whether a display math inset follows
2506 && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2508 runparams.ctObject = getInset(i)->CtObject(runparams);
2510 InsetMath const * im = getInset(i)->asInsetMath();
2511 if (im && im->asHullInset()
2512 && im->asHullInset()->outerDisplay()) {
2513 runparams.inDisplayMath = true;
2514 // runparams.inDeletedInset will be set by
2515 // latexInset later, but we need this info
2516 // before it is called. On the other hand, we
2517 // cannot set it here because it is a counter.
2518 deleted_display_math = isDeleted(i);
2520 if (bparams.output_changes && deleted_display_math
2521 && runningChange == change
2522 && change.type == Change::DELETED
2523 && !os.afterParbreak()) {
2524 // A display math in the same paragraph follows.
2525 // We have to close and then reopen \lyxdeleted,
2526 // otherwise the math will be shifted up.
2527 OutputParams rp = runparams;
2529 bool needPar = false;
2530 column += running_font.latexWriteEndChanges(
2531 os, bparams, rp, basefont,
2535 basefont = (body_pos > i) ? getLabelFont(bparams, real_outerfont)
2536 : getLayoutFont(bparams, real_outerfont);
2537 running_font = basefont;
2538 column += Changes::latexMarkChange(os, bparams,
2539 Change(Change::INSERTED), change, rp);
2543 if (bparams.output_changes && runningChange != change) {
2544 if (!alien_script.empty()) {
2547 alien_script.clear();
2550 bool needPar = false;
2551 column += running_font.latexWriteEndChanges(
2552 os, bparams, runparams,
2553 basefont, basefont, needPar);
2556 basefont = (body_pos > i) ? getLabelFont(bparams, real_outerfont)
2557 : getLayoutFont(bparams, real_outerfont);
2558 running_font = basefont;
2559 column += Changes::latexMarkChange(os, bparams, runningChange,
2561 runningChange = change;
2564 // do not output text which is marked deleted
2565 // if change tracking output is disabled
2566 if (!bparams.output_changes && change.deleted()) {
2572 // Fully instantiated font
2573 Font const current_font = getFont(bparams, i, outerfont);
2575 Font const prev_font = (i > 0) ?
2576 getFont(bparams, i - 1, outerfont)
2579 Font const last_font = running_font;
2580 bool const in_ct_deletion = (bparams.output_changes
2581 && runningChange == change
2582 && change.type == Change::DELETED
2583 && !os.afterParbreak());
2584 // Insets where font switches are used (rather than font commands)
2585 bool const fontswitch_inset =
2588 && getInset(i)->allowMultiPar()
2589 && !getInset(i)->isPassThru();
2591 // Do we need to close the previous font?
2593 ((current_font != running_font
2594 || current_font.language() != running_font.language())
2595 || (fontswitch_inset
2596 && (current_font == prev_font
2597 || current_font.language() == prev_font.language()))))
2599 // ensure there is no open script-wrapper
2600 if (!alien_script.empty()) {
2603 alien_script.clear();
2605 bool needPar = false;
2606 if (in_ct_deletion) {
2607 // We have to close and then reopen \lyxdeleted,
2608 // as strikeout needs to be on lowest level.
2612 column += running_font.latexWriteEndChanges(
2613 os, bparams, runparams, basefont,
2614 (i == body_pos-1) ? basefont : current_font,
2616 if (in_ct_deletion) {
2617 // We have to close and then reopen \lyxdeleted,
2618 // as strikeout needs to be on lowest level.
2619 OutputParams rp = runparams;
2620 column += Changes::latexMarkChange(os, bparams,
2621 Change(Change::UNCHANGED), Change(Change::DELETED), rp);
2623 running_font = basefont;
2627 // if necessary, close language environment before opening CJK
2628 string const running_lang = running_font.language()->babel();
2629 string const lang_end_command = lyxrc.language_command_end;
2630 if (!lang_end_command.empty() && !bparams.useNonTeXFonts
2631 && !running_lang.empty()
2632 && running_lang == openLanguageName()
2633 && current_font.language()->encoding()->package() == Encoding::CJK) {
2634 string end_tag = subst(lang_end_command, "$$lang", running_lang);
2635 os << from_ascii(end_tag);
2636 column += end_tag.length();
2640 // Switch file encoding if necessary (and allowed)
2641 if (!runparams.pass_thru && !style.pass_thru &&
2642 runparams.encoding->package() != Encoding::none &&
2643 current_font.language()->encoding()->package() != Encoding::none) {
2644 pair<bool, int> const enc_switch =
2645 switchEncoding(os.os(), bparams, runparams,
2646 *(current_font.language()->encoding()));
2647 if (enc_switch.first) {
2648 column += enc_switch.second;
2649 runparams.encoding = current_font.language()->encoding();
2653 // A display math inset inside an ulem command will be output
2654 // as a box of width \linewidth, so we have to either disable
2655 // indentation if the inset starts a paragraph, or start a new
2656 // line to accommodate such box. This has to be done before
2657 // writing any font changing commands.
2658 if (runparams.inDisplayMath && !deleted_display_math
2659 && runparams.inulemcmd) {
2660 if (os.afterParbreak())
2666 // Do we need to change font?
2667 if ((current_font != running_font ||
2668 current_font.language() != running_font.language())
2669 && i != body_pos - 1)
2671 if (in_ct_deletion) {
2672 // We have to close and then reopen \lyxdeleted,
2673 // as strikeout needs to be on lowest level.
2674 bool needPar = false;
2675 OutputParams rp = runparams;
2676 column += running_font.latexWriteEndChanges(
2677 os, bparams, rp, basefont,
2682 otexstringstream ots;
2683 if (!fontswitch_inset) {
2684 InsetText const * textinset = inInset().asInsetText();
2685 bool const cprotect = textinset
2686 ? textinset->hasCProtectContent(runparams.moving_arg)
2687 && !textinset->text().isMainText()
2689 column += current_font.latexWriteStartChanges(ots, bparams,
2690 runparams, basefont, last_font, false,
2693 // Check again for display math in ulem commands as a
2694 // font change may also occur just before a math inset.
2695 if (runparams.inDisplayMath && !deleted_display_math
2696 && runparams.inulemcmd) {
2697 if (os.afterParbreak())
2702 running_font = current_font;
2704 docstring fontchange = ots.str();
2706 // check whether the fontchange ends with a \\textcolor
2707 // modifier and the text starts with a space. If so we
2708 // need to add } in order to prevent \\textcolor from gobbling
2709 // the space (bug 4473).
2710 docstring const last_modifier = rsplit(fontchange, '\\');
2711 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2712 os << from_ascii("{}");
2713 else if (ots.terminateCommand())
2715 if (in_ct_deletion) {
2716 // We have to close and then reopen \lyxdeleted,
2717 // as strikeout needs to be on lowest level.
2718 OutputParams rp = runparams;
2719 column += Changes::latexMarkChange(os, bparams,
2720 Change(Change::UNCHANGED), change, rp);
2724 // FIXME: think about end_pos implementation...
2725 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2726 // FIXME: integrate this case in latexSpecialChar
2727 // Do not print the separation of the optional argument
2728 // if style.pass_thru is false. This works because
2729 // latexSpecialChar ignores spaces if
2730 // style.pass_thru is false.
2731 if (i != body_pos - 1) {
2732 if (d->simpleTeXBlanks(bparams, runparams, os,
2733 i, column, current_font, style)) {
2734 // A surrogate pair was output. We
2735 // must not call latexSpecialChar
2736 // in this iteration, since it would output
2737 // the combining character again.
2744 OutputParams rp = runparams;
2745 rp.free_spacing = style.free_spacing;
2746 rp.local_font = ¤t_font;
2747 rp.intitle = style.intitle;
2749 // Two major modes: LaTeX or plain
2750 // Handle here those cases common to both modes
2751 // and then split to handle the two modes separately.
2752 if (c == META_INSET) {
2753 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2754 // Greyedout notes and, in general, all insets
2755 // with InsetLayout::isDisplay() == false,
2756 // are typeset inline with the text. So, we
2757 // can add a \par to the last paragraph of
2758 // such insets only if nothing else follows.
2759 bool incremented = false;
2760 Inset const * inset = getInset(i);
2761 InsetText const * textinset = inset
2762 ? inset->asInsetText()
2764 if (i + 1 == size() && textinset
2765 && !inset->getLayout().isDisplay()) {
2766 ParagraphList const & pars =
2767 textinset->text().paragraphs();
2768 pit_type const pit = pars.size() - 1;
2769 Font const lastfont =
2770 pit < 0 || pars[pit].empty()
2771 ? pars[pit].getLayoutFont(
2774 : pars[pit].getFont(bparams,
2775 pars[pit].size() - 1,
2777 if (lastfont.fontInfo().size() !=
2778 basefont.fontInfo().size()) {
2783 // We need to restore parts of this after insets with
2784 // allowMultiPar() true
2785 Font const save_basefont = basefont;
2786 Font const save_runningfont = running_font;
2787 bool closeLanguage = false;
2788 bool lang_switched_at_inset = false;
2789 if (fontswitch_inset) {
2790 // Some insets cannot be inside a font change command.
2791 // However, even such insets *can* be placed in \L or \R
2792 // or their equivalents (for RTL language switches),
2793 // so we don't close the language in those cases
2794 // (= differing isRightToLeft()).
2795 // ArabTeX, though, doesn't seem to handle this special behavior.
2796 closeLanguage = basefont.isRightToLeft() != running_font.isRightToLeft()
2797 && basefont.language()->lang() != "arabic_arabtex"
2798 && running_font.language()->lang() != "arabic_arabtex";
2799 // We need to check prev_font as language changes directly at inset
2800 // will only be started inside the inset.
2801 lang_switched_at_inset = prev_font.language() != running_font.language();
2803 d->latexInset(bparams, os, rp, running_font,
2804 basefont, real_outerfont, open_font,
2805 runningChange, style, i, column,
2806 fontswitch_inset, closeLanguage, lang_switched_at_inset);
2807 if (fontswitch_inset) {
2809 bool needPar = false;
2810 column += running_font.latexWriteEndChanges(
2811 os, bparams, runparams,
2812 basefont, basefont, needPar);
2815 basefont.fontInfo().setSize(save_basefont.fontInfo().size());
2816 basefont.fontInfo().setFamily(save_basefont.fontInfo().family());
2817 basefont.fontInfo().setSeries(save_basefont.fontInfo().series());
2822 if (runparams.ctObject == OutputParams::CT_DISPLAYOBJECT
2823 || runparams.ctObject == OutputParams::CT_UDISPLAYOBJECT) {
2824 // Close \lyx*deleted and force its
2825 // reopening (if needed)
2828 runningChange = Change(Change::UNCHANGED);
2829 runparams.ctObject = OutputParams::CT_NORMAL;
2832 } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2833 if (!bparams.useNonTeXFonts)
2834 script = Encodings::isKnownScriptChar(c);
2835 if (script != alien_script) {
2836 if (!alien_script.empty()) {
2838 alien_script.clear();
2840 string fontenc = running_font.language()->fontenc(bparams);
2842 && !Encodings::fontencSupportsScript(fontenc, script)) {
2843 column += script.length() + 2;
2844 os << "\\" << script << "{";
2845 alien_script = script;
2849 d->latexSpecialChar(os, bparams, rp, running_font,
2850 alien_script, style, i, end_pos, column);
2851 } catch (EncodingException & e) {
2852 if (runparams.dryrun) {
2853 os << "<" << _("LyX Warning: ")
2854 << _("uncodable character") << " '";
2858 // add location information and throw again.
2866 // Set the encoding to that returned from latexSpecialChar (see
2867 // comment for encoding member in OutputParams.h)
2868 runparams.encoding = rp.encoding;
2870 // Also carry on the info on a closed ulem command for insets
2871 // such as Note that do not produce any output, so that no
2872 // command is ever executed but its opening was recorded.
2873 runparams.inulemcmd = rp.inulemcmd;
2875 // These need to be passed upstream as well
2876 runparams.need_maketitle = rp.need_maketitle;
2877 runparams.have_maketitle = rp.have_maketitle;
2879 // And finally, pass the post_macros upstream
2880 runparams.post_macro = rp.post_macro;
2883 // Close wrapper for alien script
2884 if (!alien_script.empty()) {
2886 alien_script.clear();
2889 // If we have an open font definition, we have to close it
2891 // Make sure that \\par is done with the font of the last
2892 // character if this has another size as the default.
2893 // This is necessary because LaTeX (and LyX on the screen)
2894 // calculates the space between the baselines according
2895 // to this font. (Matthias)
2897 // We must not change the font for the last paragraph
2898 // of non-multipar insets, tabular cells or commands,
2899 // since this produces unwanted whitespace.
2901 Font const font = empty()
2902 ? getLayoutFont(bparams, real_outerfont)
2903 : getFont(bparams, size() - 1, real_outerfont);
2905 InsetText const * textinset = inInset().asInsetText();
2907 bool const maintext = textinset
2908 ? textinset->text().isMainText()
2911 size_t const numpars = textinset
2912 ? textinset->text().paragraphs().size()
2915 bool needPar = false;
2917 if (style.resfont.size() != font.fontInfo().size()
2918 && (!runparams.isLastPar || maintext
2919 || (numpars > 1 && d->ownerCode() != CELL_CODE
2920 && (inInset().getLayout().isDisplay()
2922 && !style.isCommand()) {
2925 #ifdef FIXED_LANGUAGE_END_DETECTION
2927 running_font.latexWriteEndChanges(os, bparams,
2928 runparams, basefont,
2929 next_->getFont(bparams, 0, outerfont),
2932 running_font.latexWriteEndChanges(os, bparams,
2933 runparams, basefont, basefont, needPar);
2936 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2937 //FIXME: there as we start another \selectlanguage with the next paragraph if
2938 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2939 running_font.latexWriteEndChanges(os, bparams, runparams,
2940 basefont, basefont, needPar);
2943 // The \par could not be inserted at the same nesting
2944 // level of the font size change, so do it now.
2945 os << "{\\" << font.latexSize() << "\\par}";
2949 column += Changes::latexMarkChange(os, bparams, runningChange,
2950 Change(Change::UNCHANGED), runparams);
2952 // Needed if there is an optional argument but no contents.
2953 if (body_pos > 0 && body_pos == size()) {
2957 if (!style.rightdelim().empty()) {
2958 os << style.rightdelim();
2959 column += style.rightdelim().size();
2962 if (allowcust && d->endTeXParParams(bparams, os, runparams)
2963 && runparams.encoding != prev_encoding) {
2964 runparams.encoding = prev_encoding;
2965 os << setEncoding(prev_encoding->iconvName());
2968 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2972 bool Paragraph::emptyTag() const
2974 for (pos_type i = 0; i < size(); ++i) {
2975 if (Inset const * inset = getInset(i)) {
2976 InsetCode lyx_code = inset->lyxCode();
2977 // FIXME testing like that is wrong. What is
2979 if (lyx_code != TOC_CODE &&
2980 lyx_code != INCLUDE_CODE &&
2981 lyx_code != GRAPHICS_CODE &&
2982 lyx_code != ERT_CODE &&
2983 lyx_code != LISTINGS_CODE &&
2984 lyx_code != FLOAT_CODE &&
2985 lyx_code != TABULAR_CODE) {
2989 char_type c = d->text_[i];
2990 if (c != ' ' && c != '\t')
2998 string Paragraph::getID(Buffer const &, OutputParams const &)
3001 for (pos_type i = 0; i < size(); ++i) {
3002 if (Inset const * inset = getInset(i)) {
3003 InsetCode lyx_code = inset->lyxCode();
3004 if (lyx_code == LABEL_CODE) {
3005 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
3006 docstring const & id = il->getParam("name");
3007 return "id='" + to_utf8(xml::cleanID(id)) + "'";
3015 pos_type Paragraph::firstWordDocBook(XMLStream & xs, OutputParams const & runparams) const
3018 for (i = 0; i < size(); ++i) {
3019 if (Inset const * inset = getInset(i)) {
3020 inset->docbook(xs, runparams);
3022 char_type c = d->text_[i];
3032 pos_type Paragraph::firstWordLyXHTML(XMLStream & xs, OutputParams const & runparams)
3036 for (i = 0; i < size(); ++i) {
3037 if (Inset const * inset = getInset(i)) {
3038 inset->xhtml(xs, runparams);
3040 char_type c = d->text_[i];
3050 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
3053 pos_type size = text_.size();
3054 for (pos_type i = initial; i < size; ++i) {
3055 Font font = owner_->getFont(buf.params(), i, outerfont);
3056 if (text_[i] == META_INSET)
3058 if (i != initial && font != font_old)
3069 void doFontSwitchDocBook(vector<xml::FontTag> & tagsToOpen,
3070 vector<xml::EndFontTag> & tagsToClose,
3071 bool & flag, FontState curstate, xml::FontTypes type)
3073 if (curstate == FONT_ON) {
3074 tagsToOpen.push_back(docbookStartFontTag(type));
3077 tagsToClose.push_back(docbookEndFontTag(type));
3082 class OptionalFontType {
3087 OptionalFontType(): ft(xml::FT_EMPH), has_value(false) {} // A possible value at random for ft.
3088 OptionalFontType(xml::FontTypes ft): ft(ft), has_value(true) {}
3091 OptionalFontType fontShapeToXml(FontShape fs)
3095 return {xml::FT_ITALIC};
3097 return {xml::FT_SLANTED};
3098 case SMALLCAPS_SHAPE:
3099 return {xml::FT_SMALLCAPS};
3104 // the other tags are for internal use
3110 OptionalFontType fontFamilyToXml(FontFamily fm)
3114 return {xml::FT_ROMAN};
3116 return {xml::FT_SANS};
3117 case TYPEWRITER_FAMILY:
3118 return {xml::FT_TYPE};
3119 case INHERIT_FAMILY:
3122 // the other tags are for internal use
3128 OptionalFontType fontSizeToXml(FontSize fs)
3132 return {xml::FT_SIZE_TINY};
3134 return {xml::FT_SIZE_SCRIPT};
3136 return {xml::FT_SIZE_FOOTNOTE};
3138 return {xml::FT_SIZE_SMALL};
3140 return {xml::FT_SIZE_LARGE};
3142 return {xml::FT_SIZE_LARGER};
3144 return {xml::FT_SIZE_LARGEST};
3146 return {xml::FT_SIZE_HUGE};
3148 return {xml::FT_SIZE_HUGER};
3150 return {xml::FT_SIZE_INCREASE};
3152 return {xml::FT_SIZE_DECREASE};
3157 // the other tags are for internal use
3163 struct DocBookFontState
3165 FontShape curr_fs = INHERIT_SHAPE;
3166 FontFamily curr_fam = INHERIT_FAMILY;
3167 FontSize curr_size = INHERIT_SIZE;
3169 // track whether we have opened these tags
3170 bool emph_flag = false;
3171 bool bold_flag = false;
3172 bool noun_flag = false;
3173 bool ubar_flag = false;
3174 bool dbar_flag = false;
3175 bool sout_flag = false;
3176 bool xout_flag = false;
3177 bool wave_flag = false;
3179 bool shap_flag = false;
3181 bool faml_flag = false;
3183 bool size_flag = false;
3186 std::tuple<vector<xml::FontTag>, vector<xml::EndFontTag>> computeDocBookFontSwitch(FontInfo const & font_old,
3188 std::string const & default_family,
3189 DocBookFontState & fs)
3191 vector<xml::FontTag> tagsToOpen;
3192 vector<xml::EndFontTag> tagsToClose;
3195 FontState curstate = font.fontInfo().emph();
3196 if (font_old.emph() != curstate)
3197 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.emph_flag, curstate, xml::FT_EMPH);
3200 curstate = font.fontInfo().noun();
3201 if (font_old.noun() != curstate)
3202 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.noun_flag, curstate, xml::FT_NOUN);
3205 curstate = font.fontInfo().underbar();
3206 if (font_old.underbar() != curstate)
3207 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.ubar_flag, curstate, xml::FT_UBAR);
3210 curstate = font.fontInfo().strikeout();
3211 if (font_old.strikeout() != curstate)
3212 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.sout_flag, curstate, xml::FT_SOUT);
3215 curstate = font.fontInfo().xout();
3216 if (font_old.xout() != curstate)
3217 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.xout_flag, curstate, xml::FT_XOUT);
3220 curstate = font.fontInfo().uuline();
3221 if (font_old.uuline() != curstate)
3222 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.dbar_flag, curstate, xml::FT_DBAR);
3225 curstate = font.fontInfo().uwave();
3226 if (font_old.uwave() != curstate)
3227 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.wave_flag, curstate, xml::FT_WAVE);
3230 // a little hackish, but allows us to reuse what we have.
3231 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
3232 if (font_old.series() != font.fontInfo().series())
3233 doFontSwitchDocBook(tagsToOpen, tagsToClose, fs.bold_flag, curstate, xml::FT_BOLD);
3236 fs.curr_fs = font.fontInfo().shape();
3237 FontShape old_fs = font_old.shape();
3238 if (old_fs != fs.curr_fs) {
3240 OptionalFontType tag = fontShapeToXml(old_fs);
3242 tagsToClose.push_back(docbookEndFontTag(tag.ft));
3243 fs.shap_flag = false;
3246 OptionalFontType tag = fontShapeToXml(fs.curr_fs);
3248 tagsToOpen.push_back(docbookStartFontTag(tag.ft));
3252 fs.curr_fam = font.fontInfo().family();
3253 FontFamily old_fam = font_old.family();
3254 if (old_fam != fs.curr_fam) {
3256 OptionalFontType tag = fontFamilyToXml(old_fam);
3258 tagsToClose.push_back(docbookEndFontTag(tag.ft));
3259 fs.faml_flag = false;
3261 switch (fs.curr_fam) {
3263 // we will treat a "default" font family as roman, since we have
3264 // no other idea what to do.
3265 if (default_family != "rmdefault" && default_family != "default") {
3266 tagsToOpen.push_back(docbookStartFontTag(xml::FT_ROMAN));
3267 fs.faml_flag = true;
3271 if (default_family != "sfdefault") {
3272 tagsToOpen.push_back(docbookStartFontTag(xml::FT_SANS));
3273 fs.faml_flag = true;
3276 case TYPEWRITER_FAMILY:
3277 if (default_family != "ttdefault") {
3278 tagsToOpen.push_back(docbookStartFontTag(xml::FT_TYPE));
3279 fs.faml_flag = true;
3282 case INHERIT_FAMILY:
3285 // the other tags are for internal use
3292 fs.curr_size = font.fontInfo().size();
3293 FontSize old_size = font_old.size();
3294 if (old_size != fs.curr_size) {
3296 OptionalFontType tag = fontSizeToXml(old_size);
3298 tagsToClose.push_back(docbookEndFontTag(tag.ft));
3299 fs.size_flag = false;
3302 OptionalFontType tag = fontSizeToXml(fs.curr_size);
3303 if (tag.has_value) {
3304 tagsToOpen.push_back(docbookStartFontTag(tag.ft));
3305 fs.size_flag = true;
3309 return std::tuple<vector<xml::FontTag>, vector<xml::EndFontTag>>(tagsToOpen, tagsToClose);
3312 } // anonymous namespace
3315 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
3317 OutputParams const & runparams,
3318 Font const & outerfont,
3319 bool start_paragraph, bool close_paragraph,
3320 pos_type initial) const
3322 // track whether we have opened these tags
3323 DocBookFontState fs;
3325 if (start_paragraph)
3326 xs.startDivision(allowEmpty());
3328 Layout const & style = *d->layout_;
3330 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3332 string const default_family =
3333 buf.masterBuffer()->params().fonts_default_family;
3335 vector<xml::FontTag> tagsToOpen;
3336 vector<xml::EndFontTag> tagsToClose;
3338 // parsing main loop
3339 for (pos_type i = initial; i < size(); ++i) {
3340 // let's not show deleted material in the output
3344 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
3346 // Determine which tags should be opened or closed.
3347 tie(tagsToOpen, tagsToClose) = computeDocBookFontSwitch(font_old, font, default_family, fs);
3350 // Other such tags? What about the other text ranges?
3352 vector<xml::EndFontTag>::const_iterator cit = tagsToClose.begin();
3353 vector<xml::EndFontTag>::const_iterator cen = tagsToClose.end();
3354 for (; cit != cen; ++cit)
3357 vector<xml::FontTag>::const_iterator sit = tagsToOpen.begin();
3358 vector<xml::FontTag>::const_iterator sen = tagsToOpen.end();
3359 for (; sit != sen; ++sit)
3362 tagsToClose.clear();
3365 if (Inset const * inset = getInset(i)) {
3366 if (!runparams.for_toc || inset->isInToc()) {
3367 OutputParams np = runparams;
3368 np.local_font = &font;
3369 // If the paragraph has size 1, then we are in the "special
3370 // case" where we do not output the containing paragraph info.
3371 // This "special case" is defined in more details in output_docbook.cpp, makeParagraphs. The results
3372 // of that brittle logic is passed to this function through open_par.
3373 if (!inset->getLayout().htmlisblock() && size() != 1) // TODO: htmlisblock here too!
3374 np.docbook_in_par = true;
3375 inset->docbook(xs, np);
3378 char_type c = getUChar(buf.masterBuffer()->params(), runparams, i);
3381 font_old = font.fontInfo();
3384 // FIXME, this code is just imported from XHTML
3385 // I'm worried about what happens if a branch, say, is itself
3386 // wrapped in some font stuff. I think that will not work.
3388 if (runparams.docbook_in_listing)
3390 if (close_paragraph)
3397 void doFontSwitchXHTML(vector<xml::FontTag> & tagsToOpen,
3398 vector<xml::EndFontTag> & tagsToClose,
3399 bool & flag, FontState curstate, xml::FontTypes type)
3401 if (curstate == FONT_ON) {
3402 tagsToOpen.push_back(xhtmlStartFontTag(type));
3405 tagsToClose.push_back(xhtmlEndFontTag(type));
3410 } // anonymous namespace
3413 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
3415 OutputParams const & runparams,
3416 Font const & outerfont,
3417 bool start_paragraph, bool close_paragraph,
3418 pos_type initial) const
3422 // track whether we have opened these tags
3423 bool emph_flag = false;
3424 bool bold_flag = false;
3425 bool noun_flag = false;
3426 bool ubar_flag = false;
3427 bool dbar_flag = false;
3428 bool sout_flag = false;
3429 bool xout_flag = false;
3430 bool wave_flag = false;
3432 bool shap_flag = false;
3434 bool faml_flag = false;
3436 bool size_flag = false;
3438 Layout const & style = *d->layout_;
3440 if (start_paragraph)
3441 xs.startDivision(allowEmpty());
3444 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3446 FontShape curr_fs = INHERIT_SHAPE;
3447 FontFamily curr_fam = INHERIT_FAMILY;
3448 FontSize curr_size = INHERIT_SIZE;
3450 string const default_family =
3451 buf.masterBuffer()->params().fonts_default_family;
3453 vector<xml::FontTag> tagsToOpen;
3454 vector<xml::EndFontTag> tagsToClose;
3456 // parsing main loop
3457 for (pos_type i = initial; i < size(); ++i) {
3458 // let's not show deleted material in the output
3462 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
3465 FontState curstate = font.fontInfo().emph();
3466 if (font_old.emph() != curstate)
3467 doFontSwitchXHTML(tagsToOpen, tagsToClose, emph_flag, curstate, xml::FT_EMPH);
3470 curstate = font.fontInfo().noun();
3471 if (font_old.noun() != curstate)
3472 doFontSwitchXHTML(tagsToOpen, tagsToClose, noun_flag, curstate, xml::FT_NOUN);
3475 curstate = font.fontInfo().underbar();
3476 if (font_old.underbar() != curstate)
3477 doFontSwitchXHTML(tagsToOpen, tagsToClose, ubar_flag, curstate, xml::FT_UBAR);
3480 curstate = font.fontInfo().strikeout();
3481 if (font_old.strikeout() != curstate)
3482 doFontSwitchXHTML(tagsToOpen, tagsToClose, sout_flag, curstate, xml::FT_SOUT);
3485 curstate = font.fontInfo().xout();
3486 if (font_old.xout() != curstate)
3487 doFontSwitchXHTML(tagsToOpen, tagsToClose, xout_flag, curstate, xml::FT_XOUT);
3490 curstate = font.fontInfo().uuline();
3491 if (font_old.uuline() != curstate)
3492 doFontSwitchXHTML(tagsToOpen, tagsToClose, dbar_flag, curstate, xml::FT_DBAR);
3495 curstate = font.fontInfo().uwave();
3496 if (font_old.uwave() != curstate)
3497 doFontSwitchXHTML(tagsToOpen, tagsToClose, wave_flag, curstate, xml::FT_WAVE);
3500 // a little hackish, but allows us to reuse what we have.
3501 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
3502 if (font_old.series() != font.fontInfo().series())
3503 doFontSwitchXHTML(tagsToOpen, tagsToClose, bold_flag, curstate, xml::FT_BOLD);
3506 curr_fs = font.fontInfo().shape();
3507 FontShape old_fs = font_old.shape();
3508 if (old_fs != curr_fs) {
3512 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_ITALIC));
3515 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SLANTED));
3517 case SMALLCAPS_SHAPE:
3518 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SMALLCAPS));
3524 // the other tags are for internal use
3532 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_ITALIC));
3536 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SLANTED));
3539 case SMALLCAPS_SHAPE:
3540 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SMALLCAPS));
3547 // the other tags are for internal use
3554 curr_fam = font.fontInfo().family();
3555 FontFamily old_fam = font_old.family();
3556 if (old_fam != curr_fam) {
3560 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_ROMAN));
3563 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SANS));
3565 case TYPEWRITER_FAMILY:
3566 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_TYPE));
3568 case INHERIT_FAMILY:
3571 // the other tags are for internal use
3579 // we will treat a "default" font family as roman, since we have
3580 // no other idea what to do.
3581 if (default_family != "rmdefault" && default_family != "default") {
3582 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_ROMAN));
3587 if (default_family != "sfdefault") {
3588 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SANS));
3592 case TYPEWRITER_FAMILY:
3593 if (default_family != "ttdefault") {
3594 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_TYPE));
3598 case INHERIT_FAMILY:
3601 // the other tags are for internal use
3608 curr_size = font.fontInfo().size();
3609 FontSize old_size = font_old.size();
3610 if (old_size != curr_size) {
3614 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_TINY));
3617 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_SCRIPT));
3620 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_FOOTNOTE));
3623 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_SMALL));
3626 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_LARGE));
3629 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_LARGER));
3632 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_LARGEST));
3635 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_HUGE));
3638 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_HUGER));
3641 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_INCREASE));
3644 tagsToClose.emplace_back(xhtmlEndFontTag(xml::FT_SIZE_DECREASE));
3650 // the other tags are for internal use
3656 switch (curr_size) {
3658 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_TINY));
3662 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_SCRIPT));
3666 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_FOOTNOTE));
3670 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_SMALL));
3674 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_LARGE));
3678 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_LARGER));
3682 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_LARGEST));
3686 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_HUGE));
3690 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_HUGER));
3694 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_INCREASE));
3698 tagsToOpen.emplace_back(xhtmlStartFontTag(xml::FT_SIZE_DECREASE));
3705 // the other tags are for internal use
3712 // Other such tags? What about the other text ranges?
3714 vector<xml::EndFontTag>::const_iterator cit = tagsToClose.begin();
3715 vector<xml::EndFontTag>::const_iterator cen = tagsToClose.end();
3716 for (; cit != cen; ++cit)
3719 vector<xml::FontTag>::const_iterator sit = tagsToOpen.begin();
3720 vector<xml::FontTag>::const_iterator sen = tagsToOpen.end();
3721 for (; sit != sen; ++sit)
3724 tagsToClose.clear();
3727 Inset const * inset = getInset(i);
3729 if (!runparams.for_toc || inset->isInToc()) {
3730 OutputParams np = runparams;
3731 np.local_font = &font;
3732 // If the paragraph has size 1, then we are in the "special
3733 // case" where we do not output the containing paragraph info
3734 if (!inset->getLayout().htmlisblock() && size() != 1)
3735 np.html_in_par = true;
3736 retval += inset->xhtml(xs, np);
3739 char_type c = getUChar(buf.masterBuffer()->params(),
3741 if (c == ' ' && (style.free_spacing || runparams.free_spacing))
3742 xs << XMLStream::ESCAPE_NONE << " ";
3746 font_old = font.fontInfo();
3750 // I'm worried about what happens if a branch, say, is itself
3751 // wrapped in some font stuff. I think that will not work.
3753 if (close_paragraph)
3760 bool Paragraph::isHfill(pos_type pos) const
3762 Inset const * inset = getInset(pos);
3763 return inset && inset->isHfill();
3767 bool Paragraph::isNewline(pos_type pos) const
3769 // U+2028 LINE SEPARATOR
3770 // U+2029 PARAGRAPH SEPARATOR
3771 char_type const c = d->text_[pos];
3772 if (c == 0x2028 || c == 0x2029)
3774 Inset const * inset = getInset(pos);
3775 return inset && inset->lyxCode() == NEWLINE_CODE;
3779 bool Paragraph::isEnvSeparator(pos_type pos) const
3781 Inset const * inset = getInset(pos);
3782 return inset && inset->lyxCode() == SEPARATOR_CODE;
3786 bool Paragraph::isLineSeparator(pos_type pos) const
3788 char_type const c = d->text_[pos];
3789 if (isLineSeparatorChar(c))
3791 Inset const * inset = getInset(pos);
3792 return inset && inset->isLineSeparator();
3796 bool Paragraph::isWordSeparator(pos_type pos, bool const ignore_deleted) const
3800 if (ignore_deleted && isDeleted(pos))
3802 if (Inset const * inset = getInset(pos))
3803 return !inset->isLetter();
3804 // if we have a hard hyphen (no en- or emdash) or apostrophe
3805 // we pass this to the spell checker
3806 // FIXME: this method is subject to change, visit
3807 // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
3808 // to get an impression how complex this is.
3809 if (isHardHyphenOrApostrophe(pos))
3811 char_type const c = d->text_[pos];
3812 // We want to pass the escape chars to the spellchecker
3813 docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
3814 return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
3818 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
3820 pos_type const psize = size();
3823 char_type const c = d->text_[pos];
3824 if (c != '-' && c != '\'')
3826 int nextpos = pos + 1;
3827 int prevpos = pos > 0 ? pos - 1 : 0;
3828 if ((nextpos == psize || isSpace(nextpos))
3829 && (pos == 0 || isSpace(prevpos)))
3835 bool Paragraph::needsCProtection(bool const fragile) const
3837 // first check the layout of the paragraph, but only in insets
3838 InsetText const * textinset = inInset().asInsetText();
3839 bool const maintext = textinset
3840 ? textinset->text().isMainText()
3843 if (!maintext && layout().needcprotect) {
3844 // Environments need cprotection regardless the content
3845 if (layout().latextype == LATEX_ENVIRONMENT)
3848 // Commands need cprotection if they contain specific chars
3849 int const nchars_escape = 9;
3850 static char_type const chars_escape[nchars_escape] = {
3851 '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
3853 docstring const pars = asString();
3854 for (int k = 0; k < nchars_escape; k++) {
3855 if (contains(pars, chars_escape[k]))
3860 // now check whether we have insets that need cprotection
3861 pos_type size = pos_type(d->text_.size());
3862 for (pos_type i = 0; i < size; ++i) {
3865 Inset const * ins = getInset(i);
3866 if (ins->needsCProtection(maintext, fragile))
3868 if (ins->getLayout().latextype() == InsetLayout::ENVIRONMENT)
3869 // Environments need cprotection regardless the content
3871 // Now check math environments
3872 InsetMath const * im = getInset(i)->asInsetMath();
3873 if (!im || im->cell(0).empty())
3875 switch(im->cell(0)[0]->lyxCode()) {
3876 case MATH_AMSARRAY_CODE:
3877 case MATH_SUBSTACK_CODE:
3879 case MATH_XYMATRIX_CODE:
3880 // these need cprotection
3891 FontSpan const & Paragraph::getSpellRange(pos_type pos) const
3893 return d->speller_state_.getRange(pos);
3897 bool Paragraph::isChar(pos_type pos) const
3899 if (Inset const * inset = getInset(pos))
3900 return inset->isChar();
3901 char_type const c = d->text_[pos];
3902 return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3906 bool Paragraph::isSpace(pos_type pos) const
3908 if (Inset const * inset = getInset(pos))
3909 return inset->isSpace();
3910 char_type const c = d->text_[pos];
3911 return lyx::isSpace(c);
3916 Paragraph::getParLanguage(BufferParams const & bparams) const
3919 return getFirstFontSettings(bparams).language();
3920 // FIXME: we should check the prev par as well (Lgb)
3921 return bparams.language;
3925 bool Paragraph::isRTL(BufferParams const & bparams) const
3927 return getParLanguage(bparams)->rightToLeft()
3928 && !inInset().getLayout().forceLTR();
3932 void Paragraph::changeLanguage(BufferParams const & bparams,
3933 Language const * from, Language const * to)
3935 // change language including dummy font change at the end
3936 for (pos_type i = 0; i <= size(); ++i) {
3937 Font font = getFontSettings(bparams, i);
3938 if (font.language() == from) {
3939 font.setLanguage(to);
3941 d->requestSpellCheck(i);
3947 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3949 Language const * doc_language = bparams.language;
3950 for (auto const & f : d->fontlist_)
3951 if (f.font().language() != ignore_language &&
3952 f.font().language() != latex_language &&
3953 f.font().language() != doc_language)
3959 void Paragraph::getLanguages(std::set<Language const *> & langs) const
3961 for (auto const & f : d->fontlist_) {
3962 Language const * lang = f.font().language();
3963 if (lang != ignore_language &&
3964 lang != latex_language)
3970 docstring Paragraph::asString(int options) const
3972 return asString(0, size(), options);
3976 docstring Paragraph::asString(pos_type beg, pos_type end, int options, const OutputParams *runparams) const
3978 odocstringstream os;
3981 && options & AS_STR_LABEL
3982 && !d->params_.labelString().empty())
3983 os << d->params_.labelString() << ' ';
3985 for (pos_type i = beg; i < end; ++i) {
3986 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3988 char_type const c = d->text_[i];
3989 if (isPrintable(c) || c == '\t'
3990 || (c == '\n' && (options & AS_STR_NEWLINES)))
3992 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3993 if (c == META_INSET && (options & AS_STR_PLAINTEXT)) {
3994 LASSERT(runparams != nullptr, return docstring());
3995 getInset(i)->plaintext(os, *runparams);
3997 getInset(i)->toString(os);
4006 void Paragraph::forOutliner(docstring & os, size_t const maxlen,
4007 bool const shorten, bool const label) const
4009 size_t tmplen = shorten ? maxlen + 1 : maxlen;
4010 if (label && !labelString().empty())
4011 os += labelString() + ' ';
4012 if (!layout().isTocCaption())
4014 for (pos_type i = 0; i < size() && os.length() < tmplen; ++i) {
4017 char_type const c = d->text_[i];
4020 else if (c == META_INSET)
4021 getInset(i)->forOutliner(os, tmplen, false);
4024 Text::shortenForOutliner(os, maxlen);
4028 void Paragraph::setInsetOwner(Inset const * inset)
4030 d->inset_owner_ = inset;
4034 int Paragraph::id() const
4040 void Paragraph::setId(int id)
4046 Layout const & Paragraph::layout() const
4052 void Paragraph::setLayout(Layout const & layout)
4054 d->layout_ = &layout;
4058 void Paragraph::setDefaultLayout(DocumentClass const & tc)
4060 setLayout(tc.defaultLayout());
4064 void Paragraph::setPlainLayout(DocumentClass const & tc)
4066 setLayout(tc.plainLayout());
4070 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
4072 if (usePlainLayout())
4073 setPlainLayout(tclass);
4075 setDefaultLayout(tclass);
4079 Inset const & Paragraph::inInset() const
4081 LBUFERR(d->inset_owner_);
4082 return *d->inset_owner_;
4086 ParagraphParameters & Paragraph::params()
4092 ParagraphParameters const & Paragraph::params() const
4098 bool Paragraph::isFreeSpacing() const
4100 if (d->layout_->free_spacing)
4102 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
4106 bool Paragraph::allowEmpty() const
4108 if (d->layout_->keepempty)
4110 return d->inset_owner_ && d->inset_owner_->allowEmpty();
4114 bool Paragraph::brokenBiblio() const
4116 // There is a problem if there is no bibitem at position 0 in
4117 // paragraphs that need one, if there is another bibitem in the
4118 // paragraph or if this paragraph is not supposed to have
4119 // a bibitem inset at all.
4120 return ((d->layout_->labeltype == LABEL_BIBLIO
4121 && (d->insetlist_.find(BIBITEM_CODE) != 0
4122 || d->insetlist_.find(BIBITEM_CODE, 1) > 0))
4123 || (d->layout_->labeltype != LABEL_BIBLIO
4124 && d->insetlist_.find(BIBITEM_CODE) != -1));
4128 int Paragraph::fixBiblio(Buffer const & buffer)
4130 // FIXME: when there was already an inset at 0, the return value is 1,
4131 // which does not tell whether another inset has been removed; the
4132 // cursor cannot be correctly updated.
4134 bool const track_changes = buffer.params().track_changes;
4135 int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
4137 // The case where paragraph is not BIBLIO
4138 if (d->layout_->labeltype != LABEL_BIBLIO) {
4139 if (bibitem_pos == -1)
4140 // No InsetBibitem => OK
4142 // There is an InsetBibitem: remove it!
4143 d->insetlist_.release(bibitem_pos);
4144 eraseChar(bibitem_pos, track_changes);
4145 return (bibitem_pos == 0) ? -1 : -bibitem_pos;
4148 bool const hasbibitem0 = bibitem_pos == 0;
4150 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
4151 // There was an InsetBibitem at pos 0,
4152 // and no other one => OK
4153 if (bibitem_pos == -1)
4155 // there is a bibitem at the 0 position, but since
4156 // there is a second one, we copy the second on the
4157 // first. We're assuming there are at most two of
4158 // these, which there should be.
4159 // FIXME: why does it make sense to do that rather
4160 // than keep the first? (JMarc)
4161 Inset * inset = releaseInset(bibitem_pos);
4162 d->insetlist_.begin()->inset = inset;
4163 // This needs to be done to update the counter (#8499)
4164 buffer.updateBuffer();
4165 return -bibitem_pos;
4168 // We need to create an inset at the beginning
4169 Inset * inset = nullptr;
4170 if (bibitem_pos > 0) {
4171 // there was one somewhere in the paragraph, let's move it
4172 inset = d->insetlist_.release(bibitem_pos);
4173 eraseChar(bibitem_pos, track_changes);
4176 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
4177 InsetCommandParams(BIBITEM_CODE));
4179 Font font(inherit_font, buffer.params().language);
4180 insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
4181 : Change::UNCHANGED));
4183 // This is needed to get the counters right
4184 buffer.updateBuffer();
4189 void Paragraph::checkAuthors(AuthorList const & authorList)
4191 d->changes_.checkAuthors(authorList);
4195 bool Paragraph::isChanged(pos_type pos) const
4197 return lookupChange(pos).changed();
4201 bool Paragraph::isInserted(pos_type pos) const
4203 return lookupChange(pos).inserted();
4207 bool Paragraph::isDeleted(pos_type pos) const
4209 return lookupChange(pos).deleted();
4213 InsetList const & Paragraph::insetList() const
4215 return d->insetlist_;
4219 void Paragraph::setInsetBuffers(Buffer & b)
4221 d->insetlist_.setBuffer(b);
4225 void Paragraph::resetBuffer()
4227 d->insetlist_.resetBuffer();
4231 Inset * Paragraph::releaseInset(pos_type pos)
4233 Inset * inset = d->insetlist_.release(pos);
4234 /// does not honour change tracking!
4235 eraseChar(pos, false);
4240 Inset * Paragraph::getInset(pos_type pos)
4242 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
4243 ? d->insetlist_.get(pos) : nullptr;
4247 Inset const * Paragraph::getInset(pos_type pos) const
4249 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
4250 ? d->insetlist_.get(pos) : nullptr;
4254 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
4255 pos_type & right, TextCase action)
4257 // process sequences of modified characters; in change
4258 // tracking mode, this approach results in much better
4259 // usability than changing case on a char-by-char basis
4260 // We also need to track the current font, since font
4261 // changes within sequences can occur.
4262 vector<pair<char_type, Font> > changes;
4264 bool const trackChanges = bparams.track_changes;
4266 bool capitalize = true;
4268 for (; pos < right; ++pos) {
4269 char_type oldChar = d->text_[pos];
4270 char_type newChar = oldChar;
4272 // ignore insets and don't play with deleted text!
4273 if (oldChar != META_INSET && !isDeleted(pos)) {
4275 case text_lowercase:
4276 newChar = lowercase(oldChar);
4278 case text_capitalization:
4280 newChar = uppercase(oldChar);
4284 case text_uppercase:
4285 newChar = uppercase(oldChar);
4290 if (isWordSeparator(pos) || isDeleted(pos)) {
4291 // permit capitalization again
4295 if (oldChar != newChar) {
4296 changes.push_back(make_pair(newChar, getFontSettings(bparams, pos)));
4297 if (pos != right - 1)
4299 // step behind the changing area
4303 int erasePos = pos - changes.size();
4304 for (size_t i = 0; i < changes.size(); i++) {
4305 insertChar(pos, changes[i].first,
4308 if (!eraseChar(erasePos, trackChanges)) {
4311 ++right; // expand selection
4319 int Paragraph::find(docstring const & str, bool cs, bool mw,
4320 pos_type start_pos, bool del) const
4322 pos_type pos = start_pos;
4323 int const strsize = str.length();
4325 pos_type const parsize = d->text_.size();
4326 for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
4327 // Ignore "invisible" letters such as ligature breaks
4328 // and hyphenation chars while searching
4329 while (pos < parsize - 1 && isInset(pos)) {
4330 Inset const * inset = getInset(pos);
4331 if (!inset->isLetter())
4333 odocstringstream os;
4334 inset->toString(os);
4335 if (!os.str().empty())
4339 if (cs && str[i] != d->text_[pos])
4341 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
4343 if (!del && isDeleted(pos))
4350 // if necessary, check whether string matches word
4352 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
4355 && !isWordSeparator(pos))
4359 return pos - start_pos;
4363 char_type Paragraph::getChar(pos_type pos) const
4365 return d->text_[pos];
4369 pos_type Paragraph::size() const
4371 return d->text_.size();
4375 bool Paragraph::empty() const
4377 return d->text_.empty();
4381 bool Paragraph::isInset(pos_type pos) const
4383 return d->text_[pos] == META_INSET;
4387 bool Paragraph::isSeparator(pos_type pos) const
4389 //FIXME: Are we sure this can be the only separator?
4390 return d->text_[pos] == ' ';
4394 void Paragraph::deregisterWords()
4396 Private::LangWordsMap::const_iterator itl = d->words_.begin();
4397 Private::LangWordsMap::const_iterator ite = d->words_.end();
4398 for (; itl != ite; ++itl) {
4399 WordList & wl = theWordList(itl->first);
4400 Private::Words::const_iterator it = (itl->second).begin();
4401 Private::Words::const_iterator et = (itl->second).end();
4402 for (; it != et; ++it)
4409 void Paragraph::locateWord(pos_type & from, pos_type & to,
4410 word_location const loc, bool const ignore_deleted) const
4413 case WHOLE_WORD_STRICT:
4414 if (from == 0 || from == size()
4415 || isWordSeparator(from, ignore_deleted)
4416 || isWordSeparator(from - 1, ignore_deleted)) {
4423 // If we are already at the beginning of a word, do nothing
4424 if (!from || isWordSeparator(from - 1, ignore_deleted))
4429 // always move the cursor to the beginning of previous word
4430 while (from && !isWordSeparator(from - 1, ignore_deleted))
4434 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
4437 // no need to move the 'from' cursor
4441 while (to < size() && !isWordSeparator(to, ignore_deleted))
4446 void Paragraph::collectWords()
4448 for (pos_type pos = 0; pos < size(); ++pos) {
4449 if (isWordSeparator(pos))
4451 pos_type from = pos;
4452 locateWord(from, pos, WHOLE_WORD);
4453 // Work around MSVC warning: The statement
4454 // if (pos < from + lyxrc.completion_minlength)
4455 // triggers a signed vs. unsigned warning.
4456 // I don't know why this happens, it could be a MSVC bug, or
4457 // related to LLP64 (windows) vs. LP64 (unix) programming
4458 // model, or the C++ standard might be ambigous in the section
4459 // defining the "usual arithmetic conversions". However, using
4460 // a temporary variable is safe and works on all compilers.
4461 pos_type const endpos = from + lyxrc.completion_minlength;
4464 FontList::const_iterator cit = d->fontlist_.fontIterator(from);
4465 if (cit == d->fontlist_.end())
4467 Language const * lang = cit->font().language();
4468 docstring const word = asString(from, pos, AS_STR_NONE);
4469 d->words_[lang->lang()].insert(word);
4474 void Paragraph::registerWords()
4476 Private::LangWordsMap::const_iterator itl = d->words_.begin();
4477 Private::LangWordsMap::const_iterator ite = d->words_.end();
4478 for (; itl != ite; ++itl) {
4479 WordList & wl = theWordList(itl->first);
4480 Private::Words::const_iterator it = (itl->second).begin();
4481 Private::Words::const_iterator et = (itl->second).end();
4482 for (; it != et; ++it)
4488 void Paragraph::updateWords()
4496 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
4498 SkipPositionsIterator begin = skips.begin();
4499 SkipPositions::iterator end = skips.end();
4500 if (pos > 0 && begin < end) {
4502 if (end->last == pos - 1) {
4507 skips.insert(end, FontSpan(pos, pos));
4511 Language * Paragraph::Private::locateSpellRange(
4512 pos_type & from, pos_type & to,
4513 SkipPositions & skips) const
4515 // skip leading white space
4516 while (from < to && owner_->isWordSeparator(from))
4518 // don't check empty range
4521 // get current language
4522 Language * lang = getSpellLanguage(from);
4523 pos_type last = from;
4524 bool samelang = true;
4525 bool sameinset = true;
4526 while (last < to && samelang && sameinset) {
4527 // hop to end of word
4528 while (last < to && !owner_->isWordSeparator(last)) {
4529 Inset const * inset = owner_->getInset(last);
4530 if (inset && inset->lyxCode() == SPECIALCHAR_CODE) {
4531 // check for "invisible" letters such as ligature breaks
4532 odocstringstream os;
4533 inset->toString(os);
4534 if (os.str().length() != 0) {
4535 // avoid spell check of visible special char insets
4536 // stop the loop in front of the special char inset
4541 appendSkipPosition(skips, last);
4542 } else if (owner_->isDeleted(last)) {
4543 appendSkipPosition(skips, last);
4547 // hop to next word while checking for insets
4548 while (sameinset && last < to && owner_->isWordSeparator(last)) {
4549 if (Inset const * inset = owner_->getInset(last))
4550 sameinset = inset->isChar() && inset->isLetter();
4551 if (sameinset && owner_->isDeleted(last)) {
4552 appendSkipPosition(skips, last);
4557 if (sameinset && last < to) {
4558 // now check for language change
4559 samelang = lang == getSpellLanguage(last);
4562 // if language change detected backstep is needed
4570 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
4573 const_cast<Language *>(owner_->getFontSettings(
4574 inset_owner_->buffer().params(), from).language());
4575 if (lang == inset_owner_->buffer().params().language
4576 && !lyxrc.spellchecker_alt_lang.empty()) {
4578 string const lang_variety =
4579 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
4580 lang->setCode(lang_code);
4581 lang->setVariety(lang_variety);
4587 void Paragraph::requestSpellCheck(pos_type pos)
4589 d->requestSpellCheck(pos);
4593 bool Paragraph::needsSpellCheck() const
4595 SpellChecker::ChangeNumber speller_change_number = 0;
4596 if (theSpellChecker())
4597 speller_change_number = theSpellChecker()->changeNumber();
4598 if (speller_change_number > d->speller_state_.currentChangeNumber()) {
4599 d->speller_state_.needsCompleteRefresh(speller_change_number);
4601 return d->needsSpellCheck();
4605 bool Paragraph::Private::ignoreWord(docstring const & word) const
4607 // Ignore words with digits
4608 // FIXME: make this customizable
4609 // (note that some checkers ignore words with digits by default)
4610 docstring::const_iterator cit = word.begin();
4611 docstring::const_iterator const end = word.end();
4612 for (; cit != end; ++cit) {
4613 if (isNumber((*cit)))
4620 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
4621 WordLangTuple & wl, docstring_list & suggestions,
4622 bool do_suggestion, bool check_learned) const
4624 SpellChecker::Result result = SpellChecker::WORD_OK;
4625 SpellChecker * speller = theSpellChecker();
4629 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
4632 locateWord(from, to, WHOLE_WORD, true);
4633 if (from == to || from >= size())
4636 docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4637 Language * lang = d->getSpellLanguage(from);
4639 if (getFontSettings(d->inset_owner_->buffer().params(), from).fontInfo().nospellcheck() == FONT_ON)
4642 wl = WordLangTuple(word, lang);
4647 if (needsSpellCheck() || check_learned) {
4649 if (!d->ignoreWord(word)) {
4650 bool const trailing_dot = to < size() && d->text_[to] == '.';
4651 result = speller->check(wl);
4652 if (SpellChecker::misspelled(result) && trailing_dot) {
4653 wl = WordLangTuple(word.append(from_ascii(".")), lang);
4654 result = speller->check(wl);
4655 if (!SpellChecker::misspelled(result)) {
4656 LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
4658 from << ".." << to << "]");
4660 // spell check with dot appended failed too
4661 // restore original word/lang value
4662 word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4663 wl = WordLangTuple(word, lang);
4667 if (!SpellChecker::misspelled(result)) {
4668 // area up to the begin of the next word is not misspelled
4669 while (end < size() && isWordSeparator(end))
4672 d->setMisspelled(from, end, result);
4674 result = d->speller_state_.getState(from);
4678 suggestions.clear();
4680 if (SpellChecker::misspelled(result)) {
4681 LYXERR(Debug::GUI, "misspelled word: \"" <<
4683 from << ".." << to << "]");
4685 speller->suggest(wl, suggestions);
4691 void Paragraph::anonymize()
4693 // This is a very crude anonymization for now
4694 for (char_type & c : d->text_)
4695 if (isLetterChar(c) || isNumber(c))
4700 void Paragraph::Private::markMisspelledWords(
4701 pos_type const & first, pos_type const & last,
4702 SpellChecker::Result result,
4703 docstring const & word,
4704 SkipPositions const & skips)
4706 if (!SpellChecker::misspelled(result)) {
4707 setMisspelled(first, last, SpellChecker::WORD_OK);
4711 SpellChecker * speller = theSpellChecker();
4712 // locate and enumerate the error positions
4713 int nerrors = speller->numMisspelledWords();
4715 SkipPositionsIterator it = skips.begin();
4716 SkipPositionsIterator et = skips.end();
4717 for (int index = 0; index < nerrors; ++index) {
4720 speller->misspelledWord(index, wstart, wlen);
4721 /// should not happen if speller supports range checks
4722 if (!wlen) continue;
4723 docstring const misspelled = word.substr(wstart, wlen);
4724 wstart += first + numskipped;
4725 if (snext < wstart) {
4726 /// mark the range of correct spelling
4727 numskipped += countSkips(it, et, wstart);
4728 setMisspelled(snext,
4729 wstart - 1, SpellChecker::WORD_OK);
4731 snext = wstart + wlen;
4732 numskipped += countSkips(it, et, snext);
4733 /// mark the range of misspelling
4734 setMisspelled(wstart, snext, result);
4735 LYXERR(Debug::GUI, "misspelled word: \"" <<
4736 misspelled << "\" [" <<
4737 wstart << ".." << (snext-1) << "]");
4740 if (snext <= last) {
4741 /// mark the range of correct spelling at end
4742 setMisspelled(snext, last, SpellChecker::WORD_OK);
4747 void Paragraph::spellCheck() const
4749 SpellChecker * speller = theSpellChecker();
4750 if (!speller || empty() ||!needsSpellCheck())
4754 d->rangeOfSpellCheck(start, endpos);
4755 if (speller->canCheckParagraph()) {
4756 // loop until we leave the range
4757 for (pos_type first = start; first < endpos; ) {
4758 pos_type last = endpos;
4759 Private::SkipPositions skips;
4760 Language * lang = d->locateSpellRange(first, last, skips);
4761 if (first >= endpos)
4763 // start the spell checker on the unit of meaning
4764 docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
4765 WordLangTuple wl = WordLangTuple(word, lang);
4766 SpellChecker::Result result = word.size() ?
4767 speller->check(wl) : SpellChecker::WORD_OK;
4768 d->markMisspelledWords(first, last, result, word, skips);
4772 static docstring_list suggestions;
4773 pos_type to = endpos;
4774 while (start < endpos) {
4776 spellCheck(start, to, wl, suggestions, false);
4780 d->readySpellCheck();
4784 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
4786 bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
4787 if (result || pos <= 0 || pos > size())
4789 if (check_boundary && (pos == size() || isWordSeparator(pos)))
4790 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
4795 string Paragraph::magicLabel() const
4798 ss << "magicparlabel-" << id();