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"
37 #include "OutputParams.h"
38 #include "output_latex.h"
39 #include "output_xhtml.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/lstrings.h"
65 #include "support/textutils.h"
72 using namespace lyx::support;
74 // OSX clang, gcc < 4.8.0, and msvc < 2015 do not support C++11 thread_local
75 #if defined(__APPLE__) || (defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ < 8)
76 #define THREAD_LOCAL_STATIC static __thread
77 #elif defined(_MSC_VER) && (_MSC_VER < 1900)
78 #define THREAD_LOCAL_STATIC static __declspec(thread)
80 #define THREAD_LOCAL_STATIC thread_local static
87 /// Inset identifier (above 0x10ffff, for ucs-4)
88 char_type const META_INSET = 0x200001;
93 /////////////////////////////////////////////////////////////////////
97 /////////////////////////////////////////////////////////////////////
99 class SpellResultRange {
101 SpellResultRange(FontSpan range, SpellChecker::Result result)
102 : range_(range), result_(result)
105 FontSpan const & range() const { return range_; }
107 void range(FontSpan const & r) { range_ = r; }
109 SpellChecker::Result result() const { return result_; }
111 void result(SpellChecker::Result r) { result_ = r; }
113 bool contains(pos_type pos) const { return range_.contains(pos); }
115 bool covered(FontSpan const & r) const
117 // 1. first of new range inside current range or
118 // 2. last of new range inside current range or
119 // 3. first of current range inside new range or
120 // 4. last of current range inside new range
121 //FIXME: is this the same as !range_.intersect(r).empty() ?
122 return range_.contains(r.first) || range_.contains(r.last) ||
123 r.contains(range_.first) || r.contains(range_.last);
126 void shift(pos_type pos, int offset)
128 if (range_.first > pos) {
129 range_.first += offset;
130 range_.last += offset;
131 } else if (range_.last >= pos) {
132 range_.last += offset;
137 SpellChecker::Result result_ ;
141 /////////////////////////////////////////////////////////////////////
145 /////////////////////////////////////////////////////////////////////
147 class SpellCheckerState {
151 needs_refresh_ = true;
152 current_change_number_ = 0;
155 void setRange(FontSpan const & fp, SpellChecker::Result state)
158 RangesIterator et = ranges_.end();
159 RangesIterator it = ranges_.begin();
160 for (; it != et; ++it) {
161 if (!it->covered(fp))
162 result.push_back(SpellResultRange(it->range(), it->result()));
163 else if (state == SpellChecker::WORD_OK) {
164 // trim or split the current misspelled range
165 // store misspelled ranges only
166 FontSpan range = it->range();
167 if (fp.first > range.first) {
168 // misspelled area in front of WORD_OK
169 range.last = fp.first - 1;
170 result.push_back(SpellResultRange(range, it->result()));
173 if (fp.last < range.last) {
174 // misspelled area after WORD_OK range
175 range.first = fp.last + 1;
176 result.push_back(SpellResultRange(range, it->result()));
181 if (state != SpellChecker::WORD_OK)
182 ranges_.push_back(SpellResultRange(fp, state));
185 void increasePosAfterPos(pos_type pos)
187 correctRangesAfterPos(pos, 1);
191 void decreasePosAfterPos(pos_type pos)
193 correctRangesAfterPos(pos, -1);
197 void refreshLast(pos_type pos)
199 if (pos < refresh_.last)
203 SpellChecker::Result getState(pos_type pos) const
205 SpellChecker::Result result = SpellChecker::WORD_OK;
206 RangesIterator et = ranges_.end();
207 RangesIterator it = ranges_.begin();
208 for (; it != et; ++it) {
209 if(it->contains(pos)) {
216 FontSpan const & getRange(pos_type pos) const
218 /// empty span to indicate mismatch
219 static FontSpan empty_;
220 RangesIterator et = ranges_.end();
221 RangesIterator it = ranges_.begin();
222 for (; it != et; ++it) {
223 if(it->contains(pos)) {
230 bool needsRefresh() const
232 return needs_refresh_;
235 SpellChecker::ChangeNumber currentChangeNumber() const
237 return current_change_number_;
240 void refreshRange(pos_type & first, pos_type & last) const
242 first = refresh_.first;
243 last = refresh_.last;
246 void needsRefresh(pos_type pos)
248 if (needs_refresh_ && pos != -1) {
249 if (pos < refresh_.first)
250 refresh_.first = pos;
251 if (pos > refresh_.last)
253 } else if (pos != -1) {
254 // init request check for neighbour positions too
255 refresh_.first = pos > 0 ? pos - 1 : 0;
256 // no need for special end of paragraph check
257 refresh_.last = pos + 1;
259 needs_refresh_ = pos != -1;
262 void needsCompleteRefresh(SpellChecker::ChangeNumber change_number)
264 needs_refresh_ = true;
267 current_change_number_ = change_number;
270 typedef vector<SpellResultRange> Ranges;
271 typedef Ranges::const_iterator RangesIterator;
273 /// the area of the paragraph with pending spell check
276 /// spell state cache version number
277 SpellChecker::ChangeNumber current_change_number_;
280 void correctRangesAfterPos(pos_type pos, int offset)
282 RangesIterator et = ranges_.end();
283 Ranges::iterator it = ranges_.begin();
284 for (; it != et; ++it) {
285 it->shift(pos, offset);
291 /////////////////////////////////////////////////////////////////////
293 // Paragraph::Private
295 /////////////////////////////////////////////////////////////////////
297 class Paragraph::Private
299 // Enforce our own "copy" constructor
300 Private(Private const &) = delete;
301 Private & operator=(Private const &) = delete;
302 // Unique ID generator
303 static int make_id();
306 Private(Paragraph * owner, Layout const & layout);
307 /// "Copy constructor"
308 Private(Private const &, Paragraph * owner);
309 /// Copy constructor from \p beg to \p end
310 Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
313 void insertChar(pos_type pos, char_type c, Change const & change);
315 /// Output the surrogate pair formed by \p c and \p next to \p os.
316 /// \return the number of characters written.
317 int latexSurrogatePair(otexstream & os, char_type c, char_type next,
318 OutputParams const &);
320 /// Output a space in appropriate formatting (or a surrogate pair
321 /// if the next character is a combining character).
322 /// \return whether a surrogate pair was output.
323 bool simpleTeXBlanks(OutputParams const &,
326 unsigned int & column,
328 Layout const & style);
330 /// Output consecutive unicode chars, belonging to the same script as
331 /// specified by the latex macro \p ltx, to \p os starting from \p i.
332 /// \return the number of characters written.
333 int writeScriptChars(otexstream & os, docstring const & ltx,
334 Change const &, Encoding const &, pos_type & i);
336 /// This could go to ParagraphParameters if we want to.
337 int startTeXParParams(BufferParams const &, otexstream &,
338 OutputParams const &) const;
340 /// This could go to ParagraphParameters if we want to.
341 bool endTeXParParams(BufferParams const &, otexstream &,
342 OutputParams const &) const;
345 void latexInset(BufferParams const &,
350 Font const & outerfont,
352 Change & running_change,
353 Layout const & style,
355 unsigned int & column);
358 void latexSpecialChar(
360 BufferParams const & bparams,
361 OutputParams const & runparams,
362 Font const & running_font,
363 Change const & running_change,
364 Layout const & style,
367 unsigned int & column);
374 unsigned int & column);
380 unsigned int & column);
386 unsigned int & column);
389 void validate(LaTeXFeatures & features) const;
391 /// Checks if the paragraph contains only text and no inset or font change.
392 bool onlyText(Buffer const & buf, Font const & outerfont,
393 pos_type initial) const;
395 /// a vector of speller skip positions
396 typedef vector<FontSpan> SkipPositions;
397 typedef SkipPositions::const_iterator SkipPositionsIterator;
399 void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
401 Language * getSpellLanguage(pos_type const from) const;
403 Language * locateSpellRange(pos_type & from, pos_type & to,
404 SkipPositions & skips) const;
406 bool hasSpellerChange() const
408 SpellChecker::ChangeNumber speller_change_number = 0;
409 if (theSpellChecker())
410 speller_change_number = theSpellChecker()->changeNumber();
411 return speller_change_number > speller_state_.currentChangeNumber();
414 bool ignoreWord(docstring const & word) const ;
416 void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
418 pos_type textsize = owner_->size();
419 // check for sane arguments
420 if (to <= from || from >= textsize)
422 FontSpan fp = FontSpan(from, to - 1);
423 speller_state_.setRange(fp, state);
426 void requestSpellCheck(pos_type pos)
429 speller_state_.needsCompleteRefresh(speller_state_.currentChangeNumber());
431 speller_state_.needsRefresh(pos);
434 void readySpellCheck()
436 speller_state_.needsRefresh(-1);
439 bool needsSpellCheck() const
441 return speller_state_.needsRefresh();
444 void rangeOfSpellCheck(pos_type & first, pos_type & last) const
446 speller_state_.refreshRange(first, last);
448 last = owner_->size();
451 pos_type endpos = last;
452 owner_->locateWord(first, endpos, WHOLE_WORD);
455 owner_->locateWord(last, endpos, WHOLE_WORD);
460 int countSkips(SkipPositionsIterator & it, SkipPositionsIterator const et,
464 while (it != et && it->first < start) {
465 int skip = it->last - it->first + 1;
473 void markMisspelledWords(pos_type const & first, pos_type const & last,
474 SpellChecker::Result result,
475 docstring const & word,
476 SkipPositions const & skips);
478 InsetCode ownerCode() const
480 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
483 /// Which Paragraph owns us?
487 Inset const * inset_owner_;
496 ParagraphParameters params_;
498 /// for recording and looking up changes
502 InsetList insetlist_;
505 pos_type begin_of_body_;
507 typedef docstring TextContainer;
511 typedef set<docstring> Words;
512 typedef map<string, Words> LangWordsMap;
516 Layout const * layout_;
518 SpellCheckerState speller_state_;
522 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
523 : owner_(owner), inset_owner_(0), id_(-1), begin_of_body_(0), layout_(&layout)
530 int Paragraph::Private::make_id()
532 // The id is unique per session across buffers because it is used in
533 // LFUN_PARAGRAPH_GOTO to switch to a different buffer, for instance in the
536 static atomic_uint next_id(0);
541 Paragraph::Private::Private(Private const & p, Paragraph * owner)
542 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
544 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
545 begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
548 requestSpellCheck(p.text_.size());
552 Paragraph::Private::Private(Private const & p, Paragraph * owner,
553 pos_type beg, pos_type end)
554 : owner_(owner), inset_owner_(p.inset_owner_), id_(make_id()),
555 params_(p.params_), changes_(p.changes_),
556 insetlist_(p.insetlist_, beg, end),
557 begin_of_body_(p.begin_of_body_), words_(p.words_),
560 if (beg >= pos_type(p.text_.size()))
562 text_ = p.text_.substr(beg, end - beg);
564 FontList::const_iterator fcit = fontlist_.begin();
565 FontList::const_iterator fend = fontlist_.end();
566 for (; fcit != fend; ++fcit) {
567 if (fcit->pos() < beg)
569 if (fcit->pos() >= end) {
570 // Add last entry in the fontlist_.
571 fontlist_.set(text_.size() - 1, fcit->font());
574 // Add a new entry in the fontlist_.
575 fontlist_.set(fcit->pos() - beg, fcit->font());
577 requestSpellCheck(p.text_.size());
581 void Paragraph::addChangesToToc(DocIterator const & cdit, Buffer const & buf,
582 bool output_active, TocBackend & backend) const
584 d->changes_.addToToc(cdit, buf, output_active, backend);
588 void Paragraph::addChangesToBuffer(Buffer const & buf) const
590 d->changes_.updateBuffer(buf);
594 bool Paragraph::isChangeUpdateRequired() const
596 return d->changes_.isUpdateRequired();
600 bool Paragraph::isDeleted(pos_type start, pos_type end) const
602 LASSERT(start >= 0 && start <= size(), return false);
603 LASSERT(end > start && end <= size() + 1, return false);
605 return d->changes_.isDeleted(start, end);
609 bool Paragraph::isChanged(pos_type start, pos_type end) const
611 LASSERT(start >= 0 && start <= size(), return false);
612 LASSERT(end > start && end <= size() + 1, return false);
614 return d->changes_.isChanged(start, end);
618 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
620 // keep the logic here in sync with the logic of eraseChars()
624 Change const & change = d->changes_.lookup(size());
625 return change.inserted() && change.currentAuthor();
629 void Paragraph::setChange(Change const & change)
631 // beware of the imaginary end-of-par character!
632 d->changes_.set(change, 0, size() + 1);
635 * Propagate the change recursively - but not in case of DELETED!
637 * Imagine that your co-author makes changes in an existing inset. He
638 * sends your document to you and you come to the conclusion that the
639 * inset should go completely. If you erase it, LyX must not delete all
640 * text within the inset. Otherwise, the change tracked insertions of
641 * your co-author get lost and there is no way to restore them later.
643 * Conclusion: An inset's content should remain untouched if you delete it
646 if (!change.deleted()) {
647 for (pos_type pos = 0; pos < size(); ++pos) {
648 if (Inset * inset = getInset(pos))
649 inset->setChange(change);
655 void Paragraph::setChange(pos_type pos, Change const & change)
657 LASSERT(pos >= 0 && pos <= size(), return);
658 d->changes_.set(change, pos);
660 // see comment in setChange(Change const &) above
661 if (!change.deleted() && pos < size())
662 if (Inset * inset = getInset(pos))
663 inset->setChange(change);
667 Change const & Paragraph::lookupChange(pos_type pos) const
669 LBUFERR(pos >= 0 && pos <= size());
670 return d->changes_.lookup(pos);
674 void Paragraph::acceptChanges(pos_type start, pos_type end)
676 LASSERT(start >= 0 && start <= size(), return);
677 LASSERT(end > start && end <= size() + 1, return);
679 for (pos_type pos = start; pos < end; ++pos) {
680 switch (lookupChange(pos).type) {
681 case Change::UNCHANGED:
682 // accept changes in nested inset
683 if (Inset * inset = getInset(pos))
684 inset->acceptChanges();
687 case Change::INSERTED:
688 d->changes_.set(Change(Change::UNCHANGED), pos);
689 // also accept changes in nested inset
690 if (Inset * inset = getInset(pos))
691 inset->acceptChanges();
694 case Change::DELETED:
695 // Suppress access to non-existent
696 // "end-of-paragraph char"
698 eraseChar(pos, false);
709 void Paragraph::rejectChanges(pos_type start, pos_type end)
711 LASSERT(start >= 0 && start <= size(), return);
712 LASSERT(end > start && end <= size() + 1, return);
714 for (pos_type pos = start; pos < end; ++pos) {
715 switch (lookupChange(pos).type) {
716 case Change::UNCHANGED:
717 // reject changes in nested inset
718 if (Inset * inset = getInset(pos))
719 inset->rejectChanges();
722 case Change::INSERTED:
723 // Suppress access to non-existent
724 // "end-of-paragraph char"
726 eraseChar(pos, false);
732 case Change::DELETED:
733 d->changes_.set(Change(Change::UNCHANGED), pos);
735 // Do NOT reject changes within a deleted inset!
736 // There may be insertions of a co-author inside of it!
744 void Paragraph::Private::insertChar(pos_type pos, char_type c,
745 Change const & change)
747 LASSERT(pos >= 0 && pos <= int(text_.size()), return);
750 changes_.insert(change, pos);
752 // This is actually very common when parsing buffers (and
753 // maybe inserting ascii text)
754 if (pos == pos_type(text_.size())) {
755 // when appending characters, no need to update tables
757 // but we want spell checking
758 requestSpellCheck(pos);
762 text_.insert(text_.begin() + pos, c);
764 // Update the font table.
765 fontlist_.increasePosAfterPos(pos);
768 insetlist_.increasePosAfterPos(pos);
770 // Update list of misspelled positions
771 speller_state_.increasePosAfterPos(pos);
775 bool Paragraph::insertInset(pos_type pos, Inset * inset,
776 Font const & font, Change const & change)
778 LASSERT(inset, return false);
779 LASSERT(pos >= 0 && pos <= size(), return false);
781 // Paragraph::insertInset() can be used in cut/copy/paste operation where
782 // d->inset_owner_ is not set yet.
783 if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
786 d->insertChar(pos, META_INSET, change);
787 LASSERT(d->text_[pos] == META_INSET, return false);
789 // Add a new entry in the insetlist_.
790 d->insetlist_.insert(inset, pos);
792 // Some insets require run of spell checker
793 requestSpellCheck(pos);
799 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
801 LASSERT(pos >= 0 && pos <= size(), return false);
803 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
806 Change change = d->changes_.lookup(pos);
808 // set the character to DELETED if
809 // a) it was previously unchanged or
810 // b) it was inserted by a co-author
812 if (!change.changed() ||
813 (change.inserted() && !change.currentAuthor())) {
814 setChange(pos, Change(Change::DELETED));
815 // request run of spell checker
816 requestSpellCheck(pos);
820 if (change.deleted())
824 // Don't physically access the imaginary end-of-paragraph character.
825 // eraseChar() can only mark it as DELETED. A physical deletion of
826 // end-of-par must be handled externally.
832 d->changes_.erase(pos);
834 // if it is an inset, delete the inset entry
835 if (d->text_[pos] == META_INSET)
836 d->insetlist_.erase(pos);
838 d->text_.erase(d->text_.begin() + pos);
840 // Update the fontlist_
841 d->fontlist_.erase(pos);
843 // Update the insetlist_
844 d->insetlist_.decreasePosAfterPos(pos);
846 // Update list of misspelled positions
847 d->speller_state_.decreasePosAfterPos(pos);
848 d->speller_state_.refreshLast(size());
854 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
856 LASSERT(start >= 0 && start <= size(), return 0);
857 LASSERT(end >= start && end <= size() + 1, return 0);
860 for (pos_type count = end - start; count; --count) {
861 if (!eraseChar(i, trackChanges))
868 int Paragraph::Private::latexSurrogatePair(otexstream & os, char_type c,
869 char_type next, OutputParams const & runparams)
871 // Writing next here may circumvent a possible font change between
872 // c and next. Since next is only output if it forms a surrogate pair
873 // with c we can ignore this:
874 // A font change inside a surrogate pair does not make sense and is
875 // hopefully impossible to input.
876 // FIXME: change tracking
877 // Is this correct WRT change tracking?
878 Encoding const & encoding = *(runparams.encoding);
879 docstring latex1 = encoding.latexChar(next).first;
880 if (runparams.inIPA) {
881 string const tipashortcut = Encodings::TIPAShortcut(next);
882 if (!tipashortcut.empty()) {
883 latex1 = from_ascii(tipashortcut);
886 docstring const latex2 = encoding.latexChar(c).first;
887 if (docstring(1, next) == latex1) {
888 // the encoding supports the combination
889 os << latex2 << latex1;
890 return latex1.length() + latex2.length();
891 } else if (runparams.local_font &&
892 runparams.local_font->language()->lang() == "polutonikogreek") {
893 // polutonikogreek only works without the brackets
894 os << latex1 << latex2;
895 return latex1.length() + latex2.length();
897 os << latex1 << '{' << latex2 << '}';
898 return latex1.length() + latex2.length() + 2;
902 bool Paragraph::Private::simpleTeXBlanks(OutputParams const & runparams,
905 unsigned int & column,
907 Layout const & style)
909 if (style.pass_thru || runparams.pass_thru)
912 if (i + 1 < int(text_.size())) {
913 char_type next = text_[i + 1];
914 if (Encodings::isCombiningChar(next)) {
915 // This space has an accent, so we must always output it.
916 column += latexSurrogatePair(os, ' ', next, runparams) - 1;
921 if (runparams.linelen > 0
922 && column > runparams.linelen
924 && text_[i - 1] != ' '
925 && (i + 1 < int(text_.size()))
926 // same in FreeSpacing mode
927 && !owner_->isFreeSpacing()
928 // In typewriter mode, we want to avoid
929 // ! . ? : at the end of a line
930 && !(font.fontInfo().family() == TYPEWRITER_FAMILY
931 && (text_[i - 1] == '.'
932 || text_[i - 1] == '?'
933 || text_[i - 1] == ':'
934 || text_[i - 1] == '!'))) {
936 os.texrow().start(owner_->id(), i + 1);
938 } else if (style.free_spacing) {
947 int Paragraph::Private::writeScriptChars(otexstream & os,
948 docstring const & ltx,
949 Change const & runningChange,
950 Encoding const & encoding,
953 // FIXME: modifying i here is not very nice...
955 // We only arrive here when character text_[i] could not be translated
956 // into the current latex encoding (or its latex translation has been forced,)
957 // and it belongs to a known script.
958 // TODO: We need \textcyr and \textgreek wrappers also for characters
959 // that can be encoded in the "LaTeX encoding" but not in the
960 // current *font encoding*.
961 // (See #9681 for details and test)
962 // Parameter ltx contains the latex translation of text_[i] as specified
963 // in the unicodesymbols file and is something like "\textXXX{<spec>}".
964 // The latex macro name "textXXX" specifies the script to which text_[i]
965 // belongs and we use it in order to check whether characters from the
966 // same script immediately follow, such that we can collect them in a
967 // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
968 // for the first char but only "<spec>" for all subsequent chars.
969 docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
970 docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
971 string script = to_ascii(ltx.substr(1, brace1 - 1));
974 bool closing_brace = true;
975 if (script == "textgreek" && encoding.latexName() == "iso-8859-7") {
976 // Correct encoding is being used, so we can avoid \textgreek.
977 // TODO: wrong test: we need to check the *font encoding*
978 // (i.e. the active language and its FontEncoding tag)
979 // instead of the LaTeX *input encoding*!
980 // See #9637 for details and test-cases.
983 closing_brace = false;
985 os << ltx.substr(pos, length);
986 int size = text_.size();
987 while (i + 1 < size) {
988 char_type const next = text_[i + 1];
989 // Stop here if next character belongs to another script
990 // or there is a change in change tracking status.
991 if (!Encodings::isKnownScriptChar(next, script) ||
992 runningChange != owner_->lookupChange(i + 1))
996 FontList::const_iterator cit = fontlist_.begin();
997 FontList::const_iterator end = fontlist_.end();
998 for (; cit != end; ++cit) {
999 if (cit->pos() >= i && !found) {
1000 prev_font = cit->font();
1003 if (cit->pos() >= i + 1)
1006 // Stop here if there is a font attribute or encoding change.
1007 if (found && cit != end && prev_font != cit->font())
1009 docstring const latex = encoding.latexChar(next).first;
1010 docstring::size_type const b1 =
1011 latex.find_first_of(from_ascii("{"));
1012 docstring::size_type const b2 =
1013 latex.find_last_of(from_ascii("}"));
1014 int const len = b2 - b1 - 1;
1015 os << latex.substr(b1 + 1, len);
1019 if (closing_brace) {
1027 void Paragraph::Private::latexInset(BufferParams const & bparams,
1029 OutputParams & runparams,
1030 Font & running_font,
1032 Font const & outerfont,
1034 Change & running_change,
1035 Layout const & style,
1037 unsigned int & column)
1039 Inset * inset = owner_->getInset(i);
1042 if (style.pass_thru) {
1043 odocstringstream ods;
1044 inset->plaintext(ods, runparams);
1049 // FIXME: move this to InsetNewline::latex
1050 if (inset->lyxCode() == NEWLINE_CODE || inset->lyxCode() == SEPARATOR_CODE) {
1051 // newlines are handled differently here than
1052 // the default in simpleTeXSpecialChars().
1053 if (!style.newline_allowed) {
1057 bool needPar = false;
1058 column += running_font.latexWriteEndChanges(
1059 os, bparams, runparams,
1060 basefont, basefont, needPar);
1064 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
1067 basefont = owner_->getLayoutFont(bparams, outerfont);
1068 running_font = basefont;
1070 if (runparams.moving_arg)
1074 os.texrow().start(owner_->id(), i + 1);
1078 if (owner_->isDeleted(i)) {
1079 if( ++runparams.inDeletedInset == 1)
1080 runparams.changeOfDeletedInset = owner_->lookupChange(i);
1083 if (inset->canTrackChanges()) {
1084 column += Changes::latexMarkChange(os, bparams, running_change,
1085 Change(Change::UNCHANGED), runparams);
1086 running_change = Change(Change::UNCHANGED);
1090 odocstream::pos_type const len = os.os().tellp();
1092 if (inset->forceLTR()
1093 && !runparams.use_polyglossia
1094 && running_font.isRightToLeft()
1095 // ERT is an exception, it should be output with no
1096 // decorations at all
1097 && inset->lyxCode() != ERT_CODE) {
1098 if (running_font.language()->lang() == "farsi")
1099 os << "\\beginL" << termcmd;
1105 // FIXME: Bug: we can have an empty font change here!
1106 // if there has just been a font change, we are going to close it
1107 // right now, which means stupid latex code like \textsf{}. AFAIK,
1108 // this does not harm dvi output. A minor bug, thus (JMarc)
1110 // Some insets cannot be inside a font change command.
1111 // However, even such insets *can* be placed in \L or \R
1112 // or their equivalents (for RTL language switches), so we don't
1113 // close the language in those cases.
1114 // ArabTeX, though, cannot handle this special behavior, it seems.
1115 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
1116 || running_font.language()->lang() == "arabic_arabtex";
1117 if (open_font && !inset->inheritFont()) {
1118 bool needPar = false;
1119 bool closeLanguage = arabtex
1120 || basefont.isRightToLeft() == running_font.isRightToLeft();
1121 unsigned int count = running_font.latexWriteEndChanges(os,
1122 bparams, runparams, basefont, basefont,
1123 needPar, closeLanguage);
1125 // if any font properties were closed, update the running_font,
1126 // making sure, however, to leave the language as it was
1128 // FIXME: probably a better way to keep track of the old
1129 // language, than copying the entire font?
1130 Font const copy_font(running_font);
1131 basefont = owner_->getLayoutFont(bparams, outerfont);
1132 running_font = basefont;
1134 running_font.setLanguage(copy_font.language());
1135 // leave font open if language is still open
1136 open_font = (running_font.language() == basefont.language());
1138 runparams.local_font = &basefont;
1142 size_t const previous_row_count = os.texrow().rows();
1145 runparams.lastid = id_;
1146 runparams.lastpos = i;
1147 inset->latex(os, runparams);
1148 } catch (EncodingException & e) {
1149 // add location information and throw again.
1156 if (running_font.language()->lang() == "farsi")
1157 os << "\\endL" << termcmd;
1162 if (os.texrow().rows() > previous_row_count) {
1163 os.texrow().start(owner_->id(), i + 1);
1166 column += (unsigned int)(os.os().tellp() - len);
1169 if (owner_->isDeleted(i))
1170 --runparams.inDeletedInset;
1174 void Paragraph::Private::latexSpecialChar(otexstream & os,
1175 BufferParams const & bparams,
1176 OutputParams const & runparams,
1177 Font const & running_font,
1178 Change const & running_change,
1179 Layout const & style,
1182 unsigned int & column)
1184 // With polyglossia, brackets and stuff need not be reversed
1185 // in RTL scripts (see bug #8251)
1186 char_type const c = (runparams.use_polyglossia) ?
1187 owner_->getUChar(bparams, i) : text_[i];
1189 if (style.pass_thru || runparams.pass_thru
1190 || contains(style.pass_thru_chars, c)
1191 || contains(runparams.pass_thru_chars, c)) {
1193 Encoding const * const enc = runparams.encoding;
1194 if (enc && !enc->encodable(c))
1195 throw EncodingException(c);
1201 // TIPA uses its own T3 encoding
1202 if (runparams.inIPA && latexSpecialT3(c, os, i, column))
1204 // If T1 font encoding is used, use the special
1205 // characters it provides.
1206 // NOTE: Some languages reset the font encoding internally to a
1207 // non-standard font encoding. If we are using such a language,
1208 // we do not output special T1 chars.
1209 if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1210 && !runparams.isFullUnicode() && bparams.main_font_encoding() == "T1"
1211 && latexSpecialT1(c, os, i, column))
1213 // NOTE: XeTeX and LuaTeX use EU1/2 (pre 2017) or TU (as of 2017) encoding
1214 else if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1215 && runparams.isFullUnicode() && latexSpecialTU(c, os, i, column))
1218 // Otherwise, we use what LaTeX provides us.
1221 os << "\\textbackslash" << termcmd;
1225 os << "\\textless" << termcmd;
1229 os << "\\textgreater" << termcmd;
1233 os << "\\textbar" << termcmd;
1238 if (i + 1 < static_cast<pos_type>(text_.size()) &&
1239 (end_pos == -1 || i + 1 < end_pos) &&
1240 text_[i+1] == '-') {
1241 // Prevent "--" becoming an endash and "---" becoming
1243 // Within \ttfamily, "--" is merged to "-" (no endash)
1244 // so we avoid this rather irritating ligature as well
1250 os << "\\textquotedbl" << termcmd;
1255 case '%': case '#': case '{':
1263 os << "\\textasciitilde" << termcmd;
1268 os << "\\textasciicircum" << termcmd;
1275 // avoid being mistaken for optional arguments
1283 // Blanks are printed before font switching.
1284 // Sure? I am not! (try nice-latex)
1285 // I am sure it's correct. LyX might be smarter
1286 // in the future, but for now, nothing wrong is
1292 if (bparams.use_dash_ligatures && !bparams.useNonTeXFonts) {
1309 Encoding const & encoding = *(runparams.encoding);
1310 char_type next = '\0';
1311 if (i + 1 < int(text_.size())) {
1312 next = text_[i + 1];
1313 if (Encodings::isCombiningChar(next)) {
1314 column += latexSurrogatePair(os, c, next, runparams) - 1;
1320 pair<docstring, bool> latex = encoding.latexChar(c);
1321 docstring nextlatex;
1322 bool nexttipas = false;
1323 string nexttipashortcut;
1324 if (next != '\0' && next != META_INSET && encoding.encodable(next)) {
1325 nextlatex = encoding.latexChar(next).first;
1326 if (runparams.inIPA) {
1327 nexttipashortcut = Encodings::TIPAShortcut(next);
1328 nexttipas = !nexttipashortcut.empty();
1332 if (runparams.inIPA) {
1333 string const tipashortcut = Encodings::TIPAShortcut(c);
1334 if (!tipashortcut.empty()) {
1335 latex.first = from_ascii(tipashortcut);
1336 latex.second = false;
1340 if (Encodings::isKnownScriptChar(c, script)
1341 && prefixIs(latex.first, from_ascii("\\" + script)))
1342 column += writeScriptChars(os, latex.first,
1343 running_change, encoding, i) - 1;
1344 else if (latex.second
1345 && ((!prefixIs(nextlatex, '\\')
1346 && !prefixIs(nextlatex, '{')
1347 && !prefixIs(nextlatex, '}'))
1349 && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1351 // Prevent eating of a following
1352 // space or command corruption by
1353 // following characters
1354 if (next == ' ' || next == '\0') {
1355 column += latex.first.length() + 1;
1356 os << latex.first << "{}";
1358 column += latex.first.length();
1359 os << latex.first << " ";
1362 column += latex.first.length() - 1;
1370 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1371 pos_type i, unsigned int & column)
1377 // In T1 encoding, these characters exist
1378 // but we should avoid ligatures
1379 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1381 os << "\\textcompwordmark" << termcmd;
1388 // soul.sty breaks with \char`\"
1389 os << "\\textquotedbl" << termcmd;
1398 bool Paragraph::Private::latexSpecialTU(char_type const c, otexstream & os,
1399 pos_type i, unsigned int & column)
1401 // TU encoding is currently on par with T1.
1402 return latexSpecialT1(c, os, i, column);
1406 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1407 pos_type /*i*/, unsigned int & column)
1417 os << "\\textvertline" << termcmd;
1426 void Paragraph::Private::validate(LaTeXFeatures & features) const
1428 if (layout_->inpreamble && inset_owner_) {
1429 bool const is_command = layout_->latextype == LATEX_COMMAND;
1430 Buffer const & buf = inset_owner_->buffer();
1431 BufferParams const & bp = features.runparams().is_child
1432 ? buf.masterParams() : buf.params();
1434 // Using a string stream here circumvents the encoding
1435 // switching machinery of odocstream. Therefore the
1436 // output is wrong if this paragraph contains content
1437 // that needs to switch encoding.
1438 otexstringstream os;
1439 os << layout_->preamble();
1441 os << '\\' << from_ascii(layout_->latexname());
1442 // we have to provide all the optional arguments here, even though
1443 // the last one is the only one we care about.
1444 // Separate handling of optional argument inset.
1445 if (!layout_->latexargs().empty()) {
1446 OutputParams rp = features.runparams();
1447 rp.local_font = &owner_->getFirstFontSettings(bp);
1448 latexArgInsets(*owner_, os, rp, layout_->latexargs());
1450 os << from_ascii(layout_->latexparam());
1452 size_t const length = os.length();
1453 // this will output "{" at the beginning, but not at the end
1454 owner_->latex(bp, f, os, features.runparams(), 0, -1, true);
1455 if (os.length() > length) {
1458 if (!layout_->postcommandargs().empty()) {
1459 OutputParams rp = features.runparams();
1460 rp.local_font = &owner_->getFirstFontSettings(bp);
1461 latexArgInsets(*owner_, os, rp, layout_->postcommandargs(), "post:");
1464 features.addPreambleSnippet(os.release(), true);
1468 if (features.runparams().flavor == OutputParams::HTML
1469 && layout_->htmltitle()) {
1470 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1473 // check the params.
1474 if (!params_.spacing().isDefault())
1475 features.require("setspace");
1478 features.useLayout(layout_->name());
1481 fontlist_.validate(features);
1483 // then the indentation
1484 if (!params_.leftIndent().zero())
1485 features.require("ParagraphLeftIndent");
1488 InsetList::const_iterator icit = insetlist_.begin();
1489 InsetList::const_iterator iend = insetlist_.end();
1490 for (; icit != iend; ++icit) {
1492 features.inDeletedInset(owner_->isDeleted(icit->pos));
1493 icit->inset->validate(features);
1494 features.inDeletedInset(false);
1495 if (layout_->needprotect &&
1496 icit->inset->lyxCode() == FOOT_CODE)
1497 features.require("NeedLyXFootnoteCode");
1501 // then the contents
1502 BufferParams const bp = features.buffer().masterParams();
1503 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1504 char_type c = text_[i];
1506 if (features.runparams().isFullUnicode() && bp.useNonTeXFonts)
1507 features.require("textquotedblp");
1508 else if (bp.main_font_encoding() != "T1"
1509 || ((&owner_->getFontSettings(bp, i))->language()->internalFontEncoding()))
1510 features.require("textquotedbl");
1512 BufferEncodings::validate(c, features);
1516 /////////////////////////////////////////////////////////////////////
1520 /////////////////////////////////////////////////////////////////////
1523 Layout const emptyParagraphLayout;
1526 Paragraph::Paragraph()
1527 : d(new Paragraph::Private(this, emptyParagraphLayout))
1534 Paragraph::Paragraph(Paragraph const & par)
1535 : itemdepth(par.itemdepth),
1536 d(new Paragraph::Private(*par.d, this))
1542 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1543 : itemdepth(par.itemdepth),
1544 d(new Paragraph::Private(*par.d, this, beg, end))
1550 Paragraph & Paragraph::operator=(Paragraph const & par)
1552 // needed as we will destroy the private part before copying it
1554 itemdepth = par.itemdepth;
1558 d = new Private(*par.d, this);
1565 Paragraph::~Paragraph()
1574 // this shall be called just before every "os << ..." action.
1575 void flushString(ostream & os, docstring & s)
1584 void Paragraph::write(ostream & os, BufferParams const & bparams,
1585 depth_type & dth) const
1587 // The beginning or end of a deeper (i.e. nested) area?
1588 if (dth != d->params_.depth()) {
1589 if (d->params_.depth() > dth) {
1590 while (d->params_.depth() > dth) {
1591 os << "\n\\begin_deeper";
1595 while (d->params_.depth() < dth) {
1596 os << "\n\\end_deeper";
1602 // First write the layout
1603 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1605 d->params_.write(os);
1607 Font font1(inherit_font, bparams.language);
1609 Change running_change = Change(Change::UNCHANGED);
1611 // this string is used as a buffer to avoid repetitive calls
1612 // to to_utf8(), which turn out to be expensive (JMarc)
1613 docstring write_buffer;
1616 for (pos_type i = 0; i <= size(); ++i) {
1618 Change const & change = lookupChange(i);
1619 if (change != running_change)
1620 flushString(os, write_buffer);
1621 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1622 running_change = change;
1627 // Write font changes
1628 Font font2 = getFontSettings(bparams, i);
1629 if (font2 != font1) {
1630 flushString(os, write_buffer);
1631 font2.lyxWriteChanges(font1, os);
1636 char_type const c = d->text_[i];
1639 if (Inset const * inset = getInset(i)) {
1640 flushString(os, write_buffer);
1641 if (inset->directWrite()) {
1642 // international char, let it write
1643 // code directly so it's shorter in
1649 os << "\\begin_inset ";
1651 os << "\n\\end_inset\n\n";
1654 // FIXME This can be removed again once the mystery
1655 // crash has been resolved.
1660 flushString(os, write_buffer);
1661 os << "\n\\backslash\n";
1665 flushString(os, write_buffer);
1666 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1673 if ((column > 70 && c == ' ')
1675 flushString(os, write_buffer);
1679 // this check is to amend a bug. LyX sometimes
1680 // inserts '\0' this could cause problems.
1682 write_buffer.push_back(c);
1684 LYXERR0("NUL char in structure.");
1690 flushString(os, write_buffer);
1691 os << "\n\\end_layout\n";
1692 // FIXME This can be removed again once the mystery
1693 // crash has been resolved.
1698 void Paragraph::validate(LaTeXFeatures & features) const
1700 d->validate(features);
1704 void Paragraph::insert(pos_type start, docstring const & str,
1705 Font const & font, Change const & change)
1707 for (size_t i = 0, n = str.size(); i != n ; ++i)
1708 insertChar(start + i, str[i], font, change);
1712 void Paragraph::appendChar(char_type c, Font const & font,
1713 Change const & change)
1716 d->changes_.insert(change, d->text_.size());
1717 // when appending characters, no need to update tables
1718 d->text_.push_back(c);
1719 setFont(d->text_.size() - 1, font);
1720 d->requestSpellCheck(d->text_.size() - 1);
1724 void Paragraph::appendString(docstring const & s, Font const & font,
1725 Change const & change)
1727 pos_type end = s.size();
1728 size_t oldsize = d->text_.size();
1729 size_t newsize = oldsize + end;
1730 size_t capacity = d->text_.capacity();
1731 if (newsize >= capacity)
1732 d->text_.reserve(max(capacity + 100, newsize));
1734 // when appending characters, no need to update tables
1737 // FIXME: Optimize this!
1738 for (size_t i = oldsize; i != newsize; ++i) {
1740 d->changes_.insert(change, i);
1741 d->requestSpellCheck(i);
1743 d->fontlist_.set(oldsize, font);
1744 d->fontlist_.set(newsize - 1, font);
1748 void Paragraph::insertChar(pos_type pos, char_type c,
1751 d->insertChar(pos, c, Change(trackChanges ?
1752 Change::INSERTED : Change::UNCHANGED));
1756 void Paragraph::insertChar(pos_type pos, char_type c,
1757 Font const & font, bool trackChanges)
1759 d->insertChar(pos, c, Change(trackChanges ?
1760 Change::INSERTED : Change::UNCHANGED));
1765 void Paragraph::insertChar(pos_type pos, char_type c,
1766 Font const & font, Change const & change)
1768 d->insertChar(pos, c, change);
1773 void Paragraph::resetFonts(Font const & font)
1775 d->fontlist_.clear();
1776 d->fontlist_.set(0, font);
1777 d->fontlist_.set(d->text_.size() - 1, font);
1780 // Gets uninstantiated font setting at position.
1781 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1785 LYXERR0("pos: " << pos << " size: " << size());
1789 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1790 if (cit != d->fontlist_.end())
1793 if (pos == size() && !empty())
1794 return getFontSettings(bparams, pos - 1);
1796 // Optimisation: avoid a full font instantiation if there is no
1797 // language change from previous call.
1798 static Font previous_font;
1799 static Language const * previous_lang = 0;
1800 Language const * lang = getParLanguage(bparams);
1801 if (lang != previous_lang) {
1802 previous_lang = lang;
1803 previous_font = Font(inherit_font, lang);
1805 return previous_font;
1809 FontSpan Paragraph::fontSpan(pos_type pos) const
1811 LBUFERR(pos <= size());
1814 return FontSpan(pos, pos);
1817 FontList::const_iterator cit = d->fontlist_.begin();
1818 FontList::const_iterator end = d->fontlist_.end();
1819 for (; cit != end; ++cit) {
1820 if (cit->pos() >= pos) {
1821 if (pos >= beginOfBody())
1822 return FontSpan(max(start, beginOfBody()),
1825 return FontSpan(start,
1826 min(beginOfBody() - 1,
1829 start = cit->pos() + 1;
1832 // This should not happen, but if so, we take no chances.
1833 LYXERR0("Paragraph::fontSpan: position not found in fontinfo table!");
1834 LASSERT(false, return FontSpan(pos, pos));
1838 // Gets uninstantiated font setting at position 0
1839 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1841 if (!empty() && !d->fontlist_.empty())
1842 return d->fontlist_.begin()->font();
1844 // Optimisation: avoid a full font instantiation if there is no
1845 // language change from previous call.
1846 static Font previous_font;
1847 static Language const * previous_lang = 0;
1848 if (bparams.language != previous_lang) {
1849 previous_lang = bparams.language;
1850 previous_font = Font(inherit_font, bparams.language);
1853 return previous_font;
1857 // Gets the fully instantiated font at a given position in a paragraph
1858 // This is basically the same function as Text::GetFont() in text2.cpp.
1859 // The difference is that this one is used for generating the LaTeX file,
1860 // and thus cosmetic "improvements" are disallowed: This has to deliver
1861 // the true picture of the buffer. (Asger)
1862 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1863 Font const & outerfont) const
1867 Font font = getFontSettings(bparams, pos);
1869 pos_type const body_pos = beginOfBody();
1870 FontInfo & fi = font.fontInfo();
1872 fi.realize(d->layout_->labelfont);
1874 fi.realize(d->layout_->font);
1876 fi.realize(outerfont.fontInfo());
1877 fi.realize(bparams.getFont().fontInfo());
1883 Font const Paragraph::getLabelFont
1884 (BufferParams const & bparams, Font const & outerfont) const
1886 FontInfo tmpfont = d->layout_->labelfont;
1887 tmpfont.realize(outerfont.fontInfo());
1888 tmpfont.realize(bparams.getFont().fontInfo());
1889 return Font(tmpfont, getParLanguage(bparams));
1893 Font const Paragraph::getLayoutFont
1894 (BufferParams const & bparams, Font const & outerfont) const
1896 FontInfo tmpfont = d->layout_->font;
1897 tmpfont.realize(outerfont.fontInfo());
1898 tmpfont.realize(bparams.getFont().fontInfo());
1899 return Font(tmpfont, getParLanguage(bparams));
1903 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1905 char_type c = d->text_[pos];
1906 if (!getFontSettings(bparams, pos).isRightToLeft())
1909 // FIXME: The arabic special casing is due to the difference of arabic
1910 // round brackets input introduced in r18599. Check if this should be
1911 // unified with Hebrew or at least if all bracket types should be
1912 // handled the same (file format change in either case).
1913 string const & lang = getFontSettings(bparams, pos).language()->lang();
1914 bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi"
1919 uc = arabic ? c : ')';
1922 uc = arabic ? c : '(';
1948 void Paragraph::setFont(pos_type pos, Font const & font)
1950 LASSERT(pos <= size(), return);
1952 // First, reduce font against layout/label font
1953 // Update: The setCharFont() routine in text2.cpp already
1954 // reduces font, so we don't need to do that here. (Asger)
1956 d->fontlist_.set(pos, font);
1960 void Paragraph::makeSameLayout(Paragraph const & par)
1962 d->layout_ = par.d->layout_;
1963 d->params_ = par.d->params_;
1967 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1969 if (isFreeSpacing())
1975 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1976 if (eraseChar(pos, trackChanges))
1982 return count > 0 || pos > 0;
1986 bool Paragraph::hasSameLayout(Paragraph const & par) const
1988 return par.d->layout_ == d->layout_
1989 && d->params_.sameLayout(par.d->params_);
1993 depth_type Paragraph::getDepth() const
1995 return d->params_.depth();
1999 depth_type Paragraph::getMaxDepthAfter() const
2001 if (d->layout_->isEnvironment())
2002 return d->params_.depth() + 1;
2004 return d->params_.depth();
2008 LyXAlignment Paragraph::getAlign() const
2010 if (d->params_.align() == LYX_ALIGN_LAYOUT)
2011 return d->layout_->align;
2013 return d->params_.align();
2017 docstring const & Paragraph::labelString() const
2019 return d->params_.labelString();
2023 // the next two functions are for the manual labels
2024 docstring const Paragraph::getLabelWidthString() const
2026 if (d->layout_->margintype == MARGIN_MANUAL
2027 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
2028 return d->params_.labelWidthString();
2030 return _("Senseless with this layout!");
2034 void Paragraph::setLabelWidthString(docstring const & s)
2036 d->params_.labelWidthString(s);
2040 docstring Paragraph::expandLabel(Layout const & layout,
2041 BufferParams const & bparams) const
2043 return expandParagraphLabel(layout, bparams, true);
2047 docstring Paragraph::expandDocBookLabel(Layout const & layout,
2048 BufferParams const & bparams) const
2050 return expandParagraphLabel(layout, bparams, false);
2054 docstring Paragraph::expandParagraphLabel(Layout const & layout,
2055 BufferParams const & bparams, bool process_appendix) const
2057 DocumentClass const & tclass = bparams.documentClass();
2058 string const & lang = getParLanguage(bparams)->code();
2059 bool const in_appendix = process_appendix && d->params_.appendix();
2060 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
2062 if (fmt.empty() && !layout.counter.empty())
2063 return tclass.counters().theCounter(layout.counter, lang);
2065 // handle 'inherited level parts' in 'fmt',
2066 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
2067 size_t const i = fmt.find('@', 0);
2068 if (i != docstring::npos) {
2069 size_t const j = fmt.find('@', i + 1);
2070 if (j != docstring::npos) {
2071 docstring parent(fmt, i + 1, j - i - 1);
2072 docstring label = from_ascii("??");
2073 if (tclass.hasLayout(parent))
2074 label = expandParagraphLabel(tclass[parent], bparams,
2076 fmt = docstring(fmt, 0, i) + label
2077 + docstring(fmt, j + 1, docstring::npos);
2081 return tclass.counters().counterLabel(fmt, lang);
2085 void Paragraph::applyLayout(Layout const & new_layout)
2087 d->layout_ = &new_layout;
2088 LyXAlignment const oldAlign = d->params_.align();
2090 if (!(oldAlign & d->layout_->alignpossible)) {
2091 frontend::Alert::warning(_("Alignment not permitted"),
2092 _("The new layout does not permit the alignment previously used.\nSetting to default."));
2093 d->params_.align(LYX_ALIGN_LAYOUT);
2098 pos_type Paragraph::beginOfBody() const
2100 return d->begin_of_body_;
2104 void Paragraph::setBeginOfBody()
2106 if (d->layout_->labeltype != LABEL_MANUAL) {
2107 d->begin_of_body_ = 0;
2111 // Unroll the first two cycles of the loop
2112 // and remember the previous character to
2113 // remove unnecessary getChar() calls
2115 pos_type end = size();
2116 if (i < end && !(isNewline(i) || isEnvSeparator(i))) {
2119 char_type previous_char = d->text_[i];
2120 if (!(isNewline(i) || isEnvSeparator(i))) {
2122 while (i < end && previous_char != ' ') {
2123 char_type temp = d->text_[i];
2124 if (isNewline(i) || isEnvSeparator(i))
2127 previous_char = temp;
2133 d->begin_of_body_ = i;
2137 bool Paragraph::allowParagraphCustomization() const
2139 return inInset().allowParagraphCustomization();
2143 bool Paragraph::usePlainLayout() const
2145 return inInset().usePlainLayout();
2149 bool Paragraph::isPassThru() const
2151 return inInset().isPassThru() || d->layout_->pass_thru;
2156 // paragraphs inside floats need different alignment tags to avoid
2159 bool noTrivlistCentering(InsetCode code)
2161 return code == FLOAT_CODE
2162 || code == WRAP_CODE
2163 || code == CELL_CODE;
2167 string correction(string const & orig)
2169 if (orig == "flushleft")
2170 return "raggedright";
2171 if (orig == "flushright")
2172 return "raggedleft";
2173 if (orig == "center")
2179 bool corrected_env(otexstream & os, string const & suffix, string const & env,
2180 InsetCode code, bool const lastpar, int & col)
2182 string macro = suffix + "{";
2183 if (noTrivlistCentering(code)) {
2185 // the last paragraph in non-trivlist-aligned
2186 // context is special (to avoid unwanted whitespace)
2187 if (suffix == "\\begin") {
2188 macro = "\\" + correction(env) + "{}";
2189 os << from_ascii(macro);
2190 col += macro.size();
2195 macro += correction(env);
2199 if (suffix == "\\par\\end") {
2203 os << from_ascii(macro);
2204 col += macro.size();
2205 if (suffix == "\\begin") {
2215 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2216 otexstream & os, OutputParams const & runparams) const
2221 (bparams.paragraph_separation == BufferParams::ParagraphIndentSeparation) ?
2222 (layout_->toggle_indent != ITOGGLE_NEVER) :
2223 (layout_->toggle_indent == ITOGGLE_ALWAYS);
2225 if (canindent && params_.noindent() && !layout_->pass_thru) {
2226 os << "\\noindent ";
2230 LyXAlignment const curAlign = params_.align();
2232 if (curAlign == layout_->align)
2236 case LYX_ALIGN_NONE:
2237 case LYX_ALIGN_BLOCK:
2238 case LYX_ALIGN_LAYOUT:
2239 case LYX_ALIGN_SPECIAL:
2240 case LYX_ALIGN_DECIMAL:
2242 case LYX_ALIGN_LEFT:
2243 case LYX_ALIGN_RIGHT:
2244 case LYX_ALIGN_CENTER:
2245 if (runparams.moving_arg) {
2252 string const begin_tag = "\\begin";
2253 InsetCode code = ownerCode();
2254 bool const lastpar = runparams.isLastPar;
2257 case LYX_ALIGN_NONE:
2258 case LYX_ALIGN_BLOCK:
2259 case LYX_ALIGN_LAYOUT:
2260 case LYX_ALIGN_SPECIAL:
2261 case LYX_ALIGN_DECIMAL:
2263 case LYX_ALIGN_LEFT: {
2264 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2265 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2267 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2269 } case LYX_ALIGN_RIGHT: {
2270 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2271 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2273 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2275 } case LYX_ALIGN_CENTER: {
2276 corrected_env(os, begin_tag, "center", code, lastpar, column);
2285 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2286 otexstream & os, OutputParams const & runparams) const
2288 LyXAlignment const curAlign = params_.align();
2290 if (curAlign == layout_->align)
2294 case LYX_ALIGN_NONE:
2295 case LYX_ALIGN_BLOCK:
2296 case LYX_ALIGN_LAYOUT:
2297 case LYX_ALIGN_SPECIAL:
2298 case LYX_ALIGN_DECIMAL:
2300 case LYX_ALIGN_LEFT:
2301 case LYX_ALIGN_RIGHT:
2302 case LYX_ALIGN_CENTER:
2303 if (runparams.moving_arg)
2308 bool output = false;
2310 string const end_tag = "\\par\\end";
2311 InsetCode code = ownerCode();
2312 bool const lastpar = runparams.isLastPar;
2315 case LYX_ALIGN_NONE:
2316 case LYX_ALIGN_BLOCK:
2317 case LYX_ALIGN_LAYOUT:
2318 case LYX_ALIGN_SPECIAL:
2319 case LYX_ALIGN_DECIMAL:
2321 case LYX_ALIGN_LEFT: {
2322 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2323 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2325 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2327 } case LYX_ALIGN_RIGHT: {
2328 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2329 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2331 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2333 } case LYX_ALIGN_CENTER: {
2334 corrected_env(os, end_tag, "center", code, lastpar, col);
2339 return output || lastpar;
2343 // This one spits out the text of the paragraph
2344 void Paragraph::latex(BufferParams const & bparams,
2345 Font const & outerfont,
2347 OutputParams const & runparams,
2348 int start_pos, int end_pos, bool force) const
2350 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
2352 // FIXME This check should not be needed. Perhaps issue an
2353 // error if it triggers.
2354 Layout const & style = inInset().forcePlainLayout() ?
2355 bparams.documentClass().plainLayout() : *d->layout_;
2357 if (!force && style.inpreamble)
2360 bool const allowcust = allowParagraphCustomization();
2362 // Current base font for all inherited font changes, without any
2363 // change caused by an individual character, except for the language:
2364 // It is set to the language of the first character.
2365 // As long as we are in the label, this font is the base font of the
2366 // label. Before the first body character it is set to the base font
2370 // Maybe we have to create a optional argument.
2371 pos_type body_pos = beginOfBody();
2372 unsigned int column = 0;
2375 // the optional argument is kept in curly brackets in
2376 // case it contains a ']'
2377 // This is not strictly needed, but if this is changed it
2378 // would be a file format change, and tex2lyx would need
2379 // to be adjusted, since it unconditionally removes the
2380 // braces when it parses \item.
2383 basefont = getLabelFont(bparams, outerfont);
2385 basefont = getLayoutFont(bparams, outerfont);
2388 // Which font is currently active?
2389 Font running_font(basefont);
2390 // Do we have an open font change?
2391 bool open_font = false;
2393 Change runningChange = Change(Change::UNCHANGED);
2395 Encoding const * const prev_encoding = runparams.encoding;
2397 os.texrow().start(id(), 0);
2399 // if the paragraph is empty, the loop will not be entered at all
2401 if (style.isCommand()) {
2405 if (!style.leftdelim().empty()) {
2406 os << style.leftdelim();
2407 column += style.leftdelim().size();
2410 column += d->startTeXParParams(bparams, os, runparams);
2413 // Whether a \par can be issued for insets typeset inline with text.
2414 // Yes if greater than 0. This has to be static.
2415 THREAD_LOCAL_STATIC int parInline = 0;
2417 for (pos_type i = 0; i < size(); ++i) {
2418 // First char in paragraph or after label?
2419 if (i == body_pos) {
2422 bool needPar = false;
2423 column += running_font.latexWriteEndChanges(
2424 os, bparams, runparams,
2425 basefont, basefont, needPar);
2428 basefont = getLayoutFont(bparams, outerfont);
2429 running_font = basefont;
2431 column += Changes::latexMarkChange(os, bparams,
2432 runningChange, Change(Change::UNCHANGED),
2434 runningChange = Change(Change::UNCHANGED);
2439 if (style.isCommand()) {
2444 if (!style.leftdelim().empty()) {
2445 os << style.leftdelim();
2446 column += style.leftdelim().size();
2450 column += d->startTeXParParams(bparams, os,
2454 runparams.wasDisplayMath = runparams.inDisplayMath;
2455 runparams.inDisplayMath = false;
2456 bool deleted_display_math = false;
2457 Change const & change = runparams.inDeletedInset
2458 ? runparams.changeOfDeletedInset : lookupChange(i);
2460 // Check whether a display math inset follows
2461 if (d->text_[i] == META_INSET
2462 && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2463 InsetMath const * im = getInset(i)->asInsetMath();
2464 if (im && im->asHullInset()
2465 && im->asHullInset()->outerDisplay()) {
2466 runparams.inDisplayMath = true;
2467 // runparams.inDeletedInset will be set by
2468 // latexInset later, but we need this info
2469 // before it is called. On the other hand, we
2470 // cannot set it here because it is a counter.
2471 deleted_display_math = isDeleted(i);
2473 if (bparams.output_changes && deleted_display_math
2474 && runningChange == change
2475 && change.type == Change::DELETED
2476 && !os.afterParbreak()) {
2477 // A display math in the same paragraph follows.
2478 // We have to close and then reopen \lyxdeleted,
2479 // otherwise the math will be shifted up.
2480 OutputParams rp = runparams;
2482 bool needPar = false;
2483 column += running_font.latexWriteEndChanges(
2484 os, bparams, rp, basefont,
2488 basefont = getLayoutFont(bparams, outerfont);
2489 running_font = basefont;
2490 column += Changes::latexMarkChange(os, bparams,
2491 Change(Change::INSERTED), change, rp);
2495 if (bparams.output_changes && runningChange != change) {
2497 bool needPar = false;
2498 column += running_font.latexWriteEndChanges(
2499 os, bparams, runparams,
2500 basefont, basefont, needPar);
2503 basefont = getLayoutFont(bparams, outerfont);
2504 running_font = basefont;
2505 column += Changes::latexMarkChange(os, bparams, runningChange,
2507 runningChange = change;
2510 // do not output text which is marked deleted
2511 // if change tracking output is disabled
2512 if (!bparams.output_changes && change.deleted()) {
2518 // Fully instantiated font
2519 Font const current_font = getFont(bparams, i, outerfont);
2521 Font const last_font = running_font;
2523 // Do we need to close the previous font?
2525 (current_font != running_font ||
2526 current_font.language() != running_font.language()))
2528 bool needPar = false;
2529 column += running_font.latexWriteEndChanges(
2530 os, bparams, runparams, basefont,
2531 (i == body_pos-1) ? basefont : current_font,
2533 running_font = basefont;
2537 string const running_lang = runparams.use_polyglossia ?
2538 running_font.language()->polyglossia() : running_font.language()->babel();
2539 // close babel's font environment before opening CJK.
2540 string const lang_end_command = runparams.use_polyglossia ?
2541 "\\end{$$lang}" : lyxrc.language_command_end;
2542 bool const using_begin_end = runparams.use_polyglossia ||
2543 !lang_end_command.empty();
2544 if (!running_lang.empty() &&
2545 (!using_begin_end || running_lang == openLanguageName()) &&
2546 current_font.language()->encoding()->package() == Encoding::CJK) {
2547 string end_tag = subst(lang_end_command,
2550 os << from_ascii(end_tag);
2551 column += end_tag.length();
2552 if (using_begin_end)
2556 // Switch file encoding if necessary (and allowed)
2557 if (!runparams.pass_thru && !style.pass_thru &&
2558 runparams.encoding->package() != Encoding::none &&
2559 current_font.language()->encoding()->package() != Encoding::none) {
2560 pair<bool, int> const enc_switch =
2561 switchEncoding(os.os(), bparams, runparams,
2562 *(current_font.language()->encoding()));
2563 if (enc_switch.first) {
2564 column += enc_switch.second;
2565 runparams.encoding = current_font.language()->encoding();
2569 char_type const c = d->text_[i];
2571 // A display math inset inside an ulem command will be output
2572 // as a box of width \linewidth, so we have to either disable
2573 // indentation if the inset starts a paragraph, or start a new
2574 // line to accommodate such box. This has to be done before
2575 // writing any font changing commands.
2576 if (runparams.inDisplayMath && !deleted_display_math
2577 && runparams.inulemcmd) {
2578 if (os.afterParbreak())
2584 // Do we need to change font?
2585 if ((current_font != running_font ||
2586 current_font.language() != running_font.language()) &&
2589 odocstringstream ods;
2590 column += current_font.latexWriteStartChanges(ods, bparams,
2591 runparams, basefont,
2593 // Check again for display math in ulem commands as a
2594 // font change may also occur just before a math inset.
2595 if (runparams.inDisplayMath && !deleted_display_math
2596 && runparams.inulemcmd) {
2597 if (os.afterParbreak())
2602 running_font = current_font;
2604 docstring fontchange = ods.str();
2605 // check whether the fontchange ends with a \\textcolor
2606 // modifier and the text starts with a space (bug 4473)
2607 docstring const last_modifier = rsplit(fontchange, '\\');
2608 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2609 os << fontchange << from_ascii("{}");
2610 // check if the fontchange ends with a trailing blank
2611 // (like "\small " (see bug 3382)
2612 else if (suffixIs(fontchange, ' ') && c == ' ')
2613 os << fontchange.substr(0, fontchange.size() - 1)
2614 << from_ascii("{}");
2619 // FIXME: think about end_pos implementation...
2620 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2621 // FIXME: integrate this case in latexSpecialChar
2622 // Do not print the separation of the optional argument
2623 // if style.pass_thru is false. This works because
2624 // latexSpecialChar ignores spaces if
2625 // style.pass_thru is false.
2626 if (i != body_pos - 1) {
2627 if (d->simpleTeXBlanks(runparams, os,
2628 i, column, current_font, style)) {
2629 // A surrogate pair was output. We
2630 // must not call latexSpecialChar
2631 // in this iteration, since it would output
2632 // the combining character again.
2639 OutputParams rp = runparams;
2640 rp.free_spacing = style.free_spacing;
2641 rp.local_font = ¤t_font;
2642 rp.intitle = style.intitle;
2644 // Two major modes: LaTeX or plain
2645 // Handle here those cases common to both modes
2646 // and then split to handle the two modes separately.
2647 if (c == META_INSET) {
2648 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2649 // Greyedout notes and, in general, all insets
2650 // with InsetLayout::isDisplay() == false,
2651 // are typeset inline with the text. So, we
2652 // can add a \par to the last paragraph of
2653 // such insets only if nothing else follows.
2654 bool incremented = false;
2655 Inset const * inset = getInset(i);
2656 InsetText const * textinset = inset
2657 ? inset->asInsetText()
2659 if (i + 1 == size() && textinset
2660 && !inset->getLayout().isDisplay()) {
2661 ParagraphList const & pars =
2662 textinset->text().paragraphs();
2663 pit_type const pit = pars.size() - 1;
2664 Font const last_font =
2665 pit < 0 || pars[pit].empty()
2666 ? pars[pit].getLayoutFont(
2669 : pars[pit].getFont(bparams,
2670 pars[pit].size() - 1,
2672 if (last_font.fontInfo().size() !=
2673 basefont.fontInfo().size()) {
2678 d->latexInset(bparams, os, rp, running_font,
2679 basefont, outerfont, open_font,
2680 runningChange, style, i, column);
2684 } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2686 d->latexSpecialChar(os, bparams, rp,
2687 running_font, runningChange,
2688 style, i, end_pos, column);
2689 } catch (EncodingException & e) {
2690 if (runparams.dryrun) {
2691 os << "<" << _("LyX Warning: ")
2692 << _("uncodable character") << " '";
2696 // add location information and throw again.
2704 // Set the encoding to that returned from latexSpecialChar (see
2705 // comment for encoding member in OutputParams.h)
2706 runparams.encoding = rp.encoding;
2708 // Also carry on the info on a closed ulem command for insets
2709 // such as Note that do not produce any output, so that no
2710 // command is ever executed but its opening was recorded.
2711 runparams.inulemcmd = rp.inulemcmd;
2714 // If we have an open font definition, we have to close it
2716 // Make sure that \\par is done with the font of the last
2717 // character if this has another size as the default.
2718 // This is necessary because LaTeX (and LyX on the screen)
2719 // calculates the space between the baselines according
2720 // to this font. (Matthias)
2722 // We must not change the font for the last paragraph
2723 // of non-multipar insets, tabular cells or commands,
2724 // since this produces unwanted whitespace.
2726 Font const font = empty()
2727 ? getLayoutFont(bparams, outerfont)
2728 : getFont(bparams, size() - 1, outerfont);
2730 InsetText const * textinset = inInset().asInsetText();
2732 bool const maintext = textinset
2733 ? textinset->text().isMainText()
2736 size_t const numpars = textinset
2737 ? textinset->text().paragraphs().size()
2740 bool needPar = false;
2742 if (style.resfont.size() != font.fontInfo().size()
2743 && (!runparams.isLastPar || maintext
2744 || (numpars > 1 && d->ownerCode() != CELL_CODE
2745 && (inInset().getLayout().isDisplay()
2747 && !style.isCommand()) {
2750 #ifdef FIXED_LANGUAGE_END_DETECTION
2752 running_font.latexWriteEndChanges(os, bparams,
2753 runparams, basefont,
2754 next_->getFont(bparams, 0, outerfont),
2757 running_font.latexWriteEndChanges(os, bparams,
2758 runparams, basefont, basefont, needPar);
2761 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2762 //FIXME: there as we start another \selectlanguage with the next paragraph if
2763 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2764 running_font.latexWriteEndChanges(os, bparams, runparams,
2765 basefont, basefont, needPar);
2768 // The \par could not be inserted at the same nesting
2769 // level of the font size change, so do it now.
2770 os << "{\\" << font.latexSize() << "\\par}";
2774 column += Changes::latexMarkChange(os, bparams, runningChange,
2775 Change(Change::UNCHANGED), runparams);
2777 // Needed if there is an optional argument but no contents.
2778 if (body_pos > 0 && body_pos == size()) {
2782 if (!style.rightdelim().empty()) {
2783 os << style.rightdelim();
2784 column += style.rightdelim().size();
2787 if (allowcust && d->endTeXParParams(bparams, os, runparams)
2788 && runparams.encoding != prev_encoding) {
2789 runparams.encoding = prev_encoding;
2790 os << setEncoding(prev_encoding->iconvName());
2793 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2797 bool Paragraph::emptyTag() const
2799 for (pos_type i = 0; i < size(); ++i) {
2800 if (Inset const * inset = getInset(i)) {
2801 InsetCode lyx_code = inset->lyxCode();
2802 // FIXME testing like that is wrong. What is
2804 if (lyx_code != TOC_CODE &&
2805 lyx_code != INCLUDE_CODE &&
2806 lyx_code != GRAPHICS_CODE &&
2807 lyx_code != ERT_CODE &&
2808 lyx_code != LISTINGS_CODE &&
2809 lyx_code != FLOAT_CODE &&
2810 lyx_code != TABULAR_CODE) {
2814 char_type c = d->text_[i];
2815 if (c != ' ' && c != '\t')
2823 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2826 for (pos_type i = 0; i < size(); ++i) {
2827 if (Inset const * inset = getInset(i)) {
2828 InsetCode lyx_code = inset->lyxCode();
2829 if (lyx_code == LABEL_CODE) {
2830 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2831 docstring const & id = il->getParam("name");
2832 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2840 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2844 for (i = 0; i < size(); ++i) {
2845 if (Inset const * inset = getInset(i)) {
2846 inset->docbook(os, runparams);
2848 char_type c = d->text_[i];
2851 os << sgml::escapeChar(c);
2858 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2862 for (i = 0; i < size(); ++i) {
2863 if (Inset const * inset = getInset(i)) {
2864 inset->xhtml(xs, runparams);
2866 char_type c = d->text_[i];
2876 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2879 pos_type size = text_.size();
2880 for (pos_type i = initial; i < size; ++i) {
2881 Font font = owner_->getFont(buf.params(), i, outerfont);
2882 if (text_[i] == META_INSET)
2884 if (i != initial && font != font_old)
2893 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2895 OutputParams const & runparams,
2896 Font const & outerfont,
2897 pos_type initial) const
2899 bool emph_flag = false;
2901 Layout const & style = *d->layout_;
2903 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2905 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2908 // parsing main loop
2909 for (pos_type i = initial; i < size(); ++i) {
2910 Font font = getFont(buf.params(), i, outerfont);
2912 // handle <emphasis> tag
2913 if (font_old.emph() != font.fontInfo().emph()) {
2914 if (font.fontInfo().emph() == FONT_ON) {
2917 } else if (i != initial) {
2918 os << "</emphasis>";
2923 if (Inset const * inset = getInset(i)) {
2924 inset->docbook(os, runparams);
2926 char_type c = d->text_[i];
2928 if (style.pass_thru)
2931 os << sgml::escapeChar(c);
2933 font_old = font.fontInfo();
2937 os << "</emphasis>";
2940 if (style.free_spacing)
2942 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2948 void doFontSwitch(vector<html::FontTag> & tagsToOpen,
2949 vector<html::EndFontTag> & tagsToClose,
2950 bool & flag, FontState curstate, html::FontTypes type)
2952 if (curstate == FONT_ON) {
2953 tagsToOpen.push_back(html::FontTag(type));
2956 tagsToClose.push_back(html::EndFontTag(type));
2963 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
2965 OutputParams const & runparams,
2966 Font const & outerfont,
2967 bool start_paragraph, bool close_paragraph,
2968 pos_type initial) const
2972 // track whether we have opened these tags
2973 bool emph_flag = false;
2974 bool bold_flag = false;
2975 bool noun_flag = false;
2976 bool ubar_flag = false;
2977 bool dbar_flag = false;
2978 bool sout_flag = false;
2979 bool xout_flag = false;
2980 bool wave_flag = false;
2982 bool shap_flag = false;
2984 bool faml_flag = false;
2986 bool size_flag = false;
2988 Layout const & style = *d->layout_;
2990 if (start_paragraph)
2991 xs.startDivision(allowEmpty());
2994 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2996 FontShape curr_fs = INHERIT_SHAPE;
2997 FontFamily curr_fam = INHERIT_FAMILY;
2998 FontSize curr_size = FONT_SIZE_INHERIT;
3000 string const default_family =
3001 buf.masterBuffer()->params().fonts_default_family;
3003 vector<html::FontTag> tagsToOpen;
3004 vector<html::EndFontTag> tagsToClose;
3006 // parsing main loop
3007 for (pos_type i = initial; i < size(); ++i) {
3008 // let's not show deleted material in the output
3012 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
3015 FontState curstate = font.fontInfo().emph();
3016 if (font_old.emph() != curstate)
3017 doFontSwitch(tagsToOpen, tagsToClose, emph_flag, curstate, html::FT_EMPH);
3020 curstate = font.fontInfo().noun();
3021 if (font_old.noun() != curstate)
3022 doFontSwitch(tagsToOpen, tagsToClose, noun_flag, curstate, html::FT_NOUN);
3025 curstate = font.fontInfo().underbar();
3026 if (font_old.underbar() != curstate)
3027 doFontSwitch(tagsToOpen, tagsToClose, ubar_flag, curstate, html::FT_UBAR);
3030 curstate = font.fontInfo().strikeout();
3031 if (font_old.strikeout() != curstate)
3032 doFontSwitch(tagsToOpen, tagsToClose, sout_flag, curstate, html::FT_SOUT);
3035 curstate = font.fontInfo().xout();
3036 if (font_old.xout() != curstate)
3037 doFontSwitch(tagsToOpen, tagsToClose, xout_flag, curstate, html::FT_XOUT);
3040 curstate = font.fontInfo().uuline();
3041 if (font_old.uuline() != curstate)
3042 doFontSwitch(tagsToOpen, tagsToClose, dbar_flag, curstate, html::FT_DBAR);
3045 curstate = font.fontInfo().uwave();
3046 if (font_old.uwave() != curstate)
3047 doFontSwitch(tagsToOpen, tagsToClose, wave_flag, curstate, html::FT_WAVE);
3050 // a little hackish, but allows us to reuse what we have.
3051 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
3052 if (font_old.series() != font.fontInfo().series())
3053 doFontSwitch(tagsToOpen, tagsToClose, bold_flag, curstate, html::FT_BOLD);
3056 curr_fs = font.fontInfo().shape();
3057 FontShape old_fs = font_old.shape();
3058 if (old_fs != curr_fs) {
3062 tagsToClose.push_back(html::EndFontTag(html::FT_ITALIC));
3065 tagsToClose.push_back(html::EndFontTag(html::FT_SLANTED));
3067 case SMALLCAPS_SHAPE:
3068 tagsToClose.push_back(html::EndFontTag(html::FT_SMALLCAPS));
3074 // the other tags are for internal use
3082 tagsToOpen.push_back(html::FontTag(html::FT_ITALIC));
3086 tagsToOpen.push_back(html::FontTag(html::FT_SLANTED));
3089 case SMALLCAPS_SHAPE:
3090 tagsToOpen.push_back(html::FontTag(html::FT_SMALLCAPS));
3097 // the other tags are for internal use
3104 curr_fam = font.fontInfo().family();
3105 FontFamily old_fam = font_old.family();
3106 if (old_fam != curr_fam) {
3110 tagsToClose.push_back(html::EndFontTag(html::FT_ROMAN));
3113 tagsToClose.push_back(html::EndFontTag(html::FT_SANS));
3115 case TYPEWRITER_FAMILY:
3116 tagsToClose.push_back(html::EndFontTag(html::FT_TYPE));
3118 case INHERIT_FAMILY:
3121 // the other tags are for internal use
3129 // we will treat a "default" font family as roman, since we have
3130 // no other idea what to do.
3131 if (default_family != "rmdefault" && default_family != "default") {
3132 tagsToOpen.push_back(html::FontTag(html::FT_ROMAN));
3137 if (default_family != "sfdefault") {
3138 tagsToOpen.push_back(html::FontTag(html::FT_SANS));
3142 case TYPEWRITER_FAMILY:
3143 if (default_family != "ttdefault") {
3144 tagsToOpen.push_back(html::FontTag(html::FT_TYPE));
3148 case INHERIT_FAMILY:
3151 // the other tags are for internal use
3158 curr_size = font.fontInfo().size();
3159 FontSize old_size = font_old.size();
3160 if (old_size != curr_size) {
3163 case FONT_SIZE_TINY:
3164 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_TINY));
3166 case FONT_SIZE_SCRIPT:
3167 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SCRIPT));
3169 case FONT_SIZE_FOOTNOTE:
3170 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_FOOTNOTE));
3172 case FONT_SIZE_SMALL:
3173 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SMALL));
3175 case FONT_SIZE_LARGE:
3176 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGE));
3178 case FONT_SIZE_LARGER:
3179 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGER));
3181 case FONT_SIZE_LARGEST:
3182 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGEST));
3184 case FONT_SIZE_HUGE:
3185 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGE));
3187 case FONT_SIZE_HUGER:
3188 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGER));
3190 case FONT_SIZE_INCREASE:
3191 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_INCREASE));
3193 case FONT_SIZE_DECREASE:
3194 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_DECREASE));
3196 case FONT_SIZE_INHERIT:
3197 case FONT_SIZE_NORMAL:
3200 // the other tags are for internal use
3206 switch (curr_size) {
3207 case FONT_SIZE_TINY:
3208 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_TINY));
3211 case FONT_SIZE_SCRIPT:
3212 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SCRIPT));
3215 case FONT_SIZE_FOOTNOTE:
3216 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_FOOTNOTE));
3219 case FONT_SIZE_SMALL:
3220 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SMALL));
3223 case FONT_SIZE_LARGE:
3224 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGE));
3227 case FONT_SIZE_LARGER:
3228 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGER));
3231 case FONT_SIZE_LARGEST:
3232 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGEST));
3235 case FONT_SIZE_HUGE:
3236 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGE));
3239 case FONT_SIZE_HUGER:
3240 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGER));
3243 case FONT_SIZE_INCREASE:
3244 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_INCREASE));
3247 case FONT_SIZE_DECREASE:
3248 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_DECREASE));
3251 case FONT_SIZE_NORMAL:
3252 case FONT_SIZE_INHERIT:
3255 // the other tags are for internal use
3262 // Other such tags? What about the other text ranges?
3264 vector<html::EndFontTag>::const_iterator cit = tagsToClose.begin();
3265 vector<html::EndFontTag>::const_iterator cen = tagsToClose.end();
3266 for (; cit != cen; ++cit)
3269 vector<html::FontTag>::const_iterator sit = tagsToOpen.begin();
3270 vector<html::FontTag>::const_iterator sen = tagsToOpen.end();
3271 for (; sit != sen; ++sit)
3274 tagsToClose.clear();
3277 Inset const * inset = getInset(i);
3279 if (!runparams.for_toc || inset->isInToc()) {
3280 OutputParams np = runparams;
3281 np.local_font = &font;
3282 // If the paragraph has size 1, then we are in the "special
3283 // case" where we do not output the containing paragraph info
3284 if (!inset->getLayout().htmlisblock() && size() != 1)
3285 np.html_in_par = true;
3286 retval += inset->xhtml(xs, np);
3289 char_type c = getUChar(buf.masterBuffer()->params(), i);
3292 font_old = font.fontInfo();
3296 // I'm worried about what happens if a branch, say, is itself
3297 // wrapped in some font stuff. I think that will not work.
3299 if (close_paragraph)
3306 bool Paragraph::isHfill(pos_type pos) const
3308 Inset const * inset = getInset(pos);
3309 return inset && inset->isHfill();
3313 bool Paragraph::isNewline(pos_type pos) const
3315 // U+2028 LINE SEPARATOR
3316 // U+2029 PARAGRAPH SEPARATOR
3317 char_type const c = d->text_[pos];
3318 if (c == 0x2028 || c == 0x2029)
3320 Inset const * inset = getInset(pos);
3321 return inset && inset->lyxCode() == NEWLINE_CODE;
3325 bool Paragraph::isEnvSeparator(pos_type pos) const
3327 Inset const * inset = getInset(pos);
3328 return inset && inset->lyxCode() == SEPARATOR_CODE;
3332 bool Paragraph::isLineSeparator(pos_type pos) const
3334 char_type const c = d->text_[pos];
3335 if (isLineSeparatorChar(c))
3337 Inset const * inset = getInset(pos);
3338 return inset && inset->isLineSeparator();
3342 bool Paragraph::isWordSeparator(pos_type pos) const
3346 if (Inset const * inset = getInset(pos))
3347 return !inset->isLetter();
3348 // if we have a hard hyphen (no en- or emdash) or apostrophe
3349 // we pass this to the spell checker
3350 // FIXME: this method is subject to change, visit
3351 // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
3352 // to get an impression how complex this is.
3353 if (isHardHyphenOrApostrophe(pos))
3355 char_type const c = d->text_[pos];
3356 // We want to pass the escape chars to the spellchecker
3357 docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
3358 return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
3362 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
3364 pos_type const psize = size();
3367 char_type const c = d->text_[pos];
3368 if (c != '-' && c != '\'')
3370 int nextpos = pos + 1;
3371 int prevpos = pos > 0 ? pos - 1 : 0;
3372 if ((nextpos == psize || isSpace(nextpos))
3373 && (pos == 0 || isSpace(prevpos)))
3379 FontSpan const & Paragraph::getSpellRange(pos_type pos) const
3381 return d->speller_state_.getRange(pos);
3385 bool Paragraph::isChar(pos_type pos) const
3387 if (Inset const * inset = getInset(pos))
3388 return inset->isChar();
3389 char_type const c = d->text_[pos];
3390 return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3394 bool Paragraph::isSpace(pos_type pos) const
3396 if (Inset const * inset = getInset(pos))
3397 return inset->isSpace();
3398 char_type const c = d->text_[pos];
3399 return lyx::isSpace(c);
3404 Paragraph::getParLanguage(BufferParams const & bparams) const
3407 return getFirstFontSettings(bparams).language();
3408 // FIXME: we should check the prev par as well (Lgb)
3409 return bparams.language;
3413 bool Paragraph::isRTL(BufferParams const & bparams) const
3415 return getParLanguage(bparams)->rightToLeft()
3416 && !inInset().getLayout().forceLTR();
3420 void Paragraph::changeLanguage(BufferParams const & bparams,
3421 Language const * from, Language const * to)
3423 // change language including dummy font change at the end
3424 for (pos_type i = 0; i <= size(); ++i) {
3425 Font font = getFontSettings(bparams, i);
3426 if (font.language() == from) {
3427 font.setLanguage(to);
3429 d->requestSpellCheck(i);
3435 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3437 Language const * doc_language = bparams.language;
3438 FontList::const_iterator cit = d->fontlist_.begin();
3439 FontList::const_iterator end = d->fontlist_.end();
3441 for (; cit != end; ++cit)
3442 if (cit->font().language() != ignore_language &&
3443 cit->font().language() != latex_language &&
3444 cit->font().language() != doc_language)
3450 void Paragraph::getLanguages(std::set<Language const *> & languages) const
3452 FontList::const_iterator cit = d->fontlist_.begin();
3453 FontList::const_iterator end = d->fontlist_.end();
3455 for (; cit != end; ++cit) {
3456 Language const * lang = cit->font().language();
3457 if (lang != ignore_language &&
3458 lang != latex_language)
3459 languages.insert(lang);
3464 docstring Paragraph::asString(int options) const
3466 return asString(0, size(), options);
3470 docstring Paragraph::asString(pos_type beg, pos_type end, int options, const OutputParams *runparams) const
3472 odocstringstream os;
3475 && options & AS_STR_LABEL
3476 && !d->params_.labelString().empty())
3477 os << d->params_.labelString() << ' ';
3479 for (pos_type i = beg; i < end; ++i) {
3480 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3482 char_type const c = d->text_[i];
3483 if (isPrintable(c) || c == '\t'
3484 || (c == '\n' && (options & AS_STR_NEWLINES)))
3486 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3487 if (c == META_INSET && (options & AS_STR_PLAINTEXT)) {
3488 LASSERT(runparams != 0, return docstring());
3489 getInset(i)->plaintext(os, *runparams);
3491 getInset(i)->toString(os);
3500 void Paragraph::forOutliner(docstring & os, size_t const maxlen,
3501 bool const shorten, bool const label) const
3503 size_t tmplen = shorten ? maxlen + 1 : maxlen;
3504 if (label && !labelString().empty())
3505 os += labelString() + ' ';
3506 for (pos_type i = 0; i < size() && os.length() < tmplen; ++i) {
3509 char_type const c = d->text_[i];
3512 else if (c == META_INSET)
3513 getInset(i)->forOutliner(os, tmplen, false);
3516 Text::shortenForOutliner(os, maxlen);
3520 void Paragraph::setInsetOwner(Inset const * inset)
3522 d->inset_owner_ = inset;
3526 int Paragraph::id() const
3532 void Paragraph::setId(int id)
3538 Layout const & Paragraph::layout() const
3544 void Paragraph::setLayout(Layout const & layout)
3546 d->layout_ = &layout;
3550 void Paragraph::setDefaultLayout(DocumentClass const & tc)
3552 setLayout(tc.defaultLayout());
3556 void Paragraph::setPlainLayout(DocumentClass const & tc)
3558 setLayout(tc.plainLayout());
3562 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
3564 if (usePlainLayout())
3565 setPlainLayout(tclass);
3567 setDefaultLayout(tclass);
3571 Inset const & Paragraph::inInset() const
3573 LBUFERR(d->inset_owner_);
3574 return *d->inset_owner_;
3578 ParagraphParameters & Paragraph::params()
3584 ParagraphParameters const & Paragraph::params() const
3590 bool Paragraph::isFreeSpacing() const
3592 if (d->layout_->free_spacing)
3594 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
3598 bool Paragraph::allowEmpty() const
3600 if (d->layout_->keepempty)
3602 return d->inset_owner_ && d->inset_owner_->allowEmpty();
3606 bool Paragraph::brokenBiblio() const
3608 // there is a problem if there is no bibitem at position 0 or
3609 // if there is another bibitem in the paragraph.
3610 return d->layout_->labeltype == LABEL_BIBLIO
3611 && (d->insetlist_.find(BIBITEM_CODE) != 0
3612 || d->insetlist_.find(BIBITEM_CODE, 1) > 0);
3616 int Paragraph::fixBiblio(Buffer const & buffer)
3618 // FIXME: What about the case where paragraph is not BIBLIO
3619 // but there is an InsetBibitem?
3620 // FIXME: when there was already an inset at 0, the return value is 1,
3621 // which does not tell whether another inset has been remove; the
3622 // cursor cannot be correctly updated.
3624 if (d->layout_->labeltype != LABEL_BIBLIO)
3627 bool const track_changes = buffer.params().track_changes;
3628 int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
3629 bool const hasbibitem0 = bibitem_pos == 0;
3632 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
3633 // There was an InsetBibitem at pos 0, and no other one => OK
3634 if (bibitem_pos == -1)
3636 // there is a bibitem at the 0 position, but since
3637 // there is a second one, we copy the second on the
3638 // first. We're assuming there are at most two of
3639 // these, which there should be.
3640 // FIXME: why does it make sense to do that rather
3641 // than keep the first? (JMarc)
3642 Inset * inset = releaseInset(bibitem_pos);
3643 d->insetlist_.begin()->inset = inset;
3644 return -bibitem_pos;
3647 // We need to create an inset at the beginning
3649 if (bibitem_pos > 0) {
3650 // there was one somewhere in the paragraph, let's move it
3651 inset = d->insetlist_.release(bibitem_pos);
3652 eraseChar(bibitem_pos, track_changes);
3655 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
3656 InsetCommandParams(BIBITEM_CODE));
3658 Font font(inherit_font, buffer.params().language);
3659 insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
3660 : Change::UNCHANGED));
3666 void Paragraph::checkAuthors(AuthorList const & authorList)
3668 d->changes_.checkAuthors(authorList);
3672 bool Paragraph::isChanged(pos_type pos) const
3674 return lookupChange(pos).changed();
3678 bool Paragraph::isInserted(pos_type pos) const
3680 return lookupChange(pos).inserted();
3684 bool Paragraph::isDeleted(pos_type pos) const
3686 return lookupChange(pos).deleted();
3690 InsetList const & Paragraph::insetList() const
3692 return d->insetlist_;
3696 void Paragraph::setInsetBuffers(Buffer & b)
3698 d->insetlist_.setBuffer(b);
3702 void Paragraph::resetBuffer()
3704 d->insetlist_.resetBuffer();
3708 Inset * Paragraph::releaseInset(pos_type pos)
3710 Inset * inset = d->insetlist_.release(pos);
3711 /// does not honour change tracking!
3712 eraseChar(pos, false);
3717 Inset * Paragraph::getInset(pos_type pos)
3719 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3720 ? d->insetlist_.get(pos) : 0;
3724 Inset const * Paragraph::getInset(pos_type pos) const
3726 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3727 ? d->insetlist_.get(pos) : 0;
3731 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
3732 pos_type & right, TextCase action)
3734 // process sequences of modified characters; in change
3735 // tracking mode, this approach results in much better
3736 // usability than changing case on a char-by-char basis
3737 // We also need to track the current font, since font
3738 // changes within sequences can occur.
3739 vector<pair<char_type, Font> > changes;
3741 bool const trackChanges = bparams.track_changes;
3743 bool capitalize = true;
3745 for (; pos < right; ++pos) {
3746 char_type oldChar = d->text_[pos];
3747 char_type newChar = oldChar;
3749 // ignore insets and don't play with deleted text!
3750 if (oldChar != META_INSET && !isDeleted(pos)) {
3752 case text_lowercase:
3753 newChar = lowercase(oldChar);
3755 case text_capitalization:
3757 newChar = uppercase(oldChar);
3761 case text_uppercase:
3762 newChar = uppercase(oldChar);
3767 if (isWordSeparator(pos) || isDeleted(pos)) {
3768 // permit capitalization again
3772 if (oldChar != newChar) {
3773 changes.push_back(make_pair(newChar, getFontSettings(bparams, pos)));
3774 if (pos != right - 1)
3776 // step behind the changing area
3780 int erasePos = pos - changes.size();
3781 for (size_t i = 0; i < changes.size(); i++) {
3782 insertChar(pos, changes[i].first,
3785 if (!eraseChar(erasePos, trackChanges)) {
3788 ++right; // expand selection
3796 int Paragraph::find(docstring const & str, bool cs, bool mw,
3797 pos_type start_pos, bool del) const
3799 pos_type pos = start_pos;
3800 int const strsize = str.length();
3802 pos_type const parsize = d->text_.size();
3803 for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
3804 // Ignore "invisible" letters such as ligature breaks
3805 // and hyphenation chars while searching
3806 while (pos < parsize - 1 && isInset(pos)) {
3807 odocstringstream os;
3808 getInset(pos)->toString(os);
3809 if (!getInset(pos)->isLetter() || !os.str().empty())
3813 if (cs && str[i] != d->text_[pos])
3815 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
3817 if (!del && isDeleted(pos))
3824 // if necessary, check whether string matches word
3826 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
3829 && !isWordSeparator(pos))
3833 return pos - start_pos;
3837 char_type Paragraph::getChar(pos_type pos) const
3839 return d->text_[pos];
3843 pos_type Paragraph::size() const
3845 return d->text_.size();
3849 bool Paragraph::empty() const
3851 return d->text_.empty();
3855 bool Paragraph::isInset(pos_type pos) const
3857 return d->text_[pos] == META_INSET;
3861 bool Paragraph::isSeparator(pos_type pos) const
3863 //FIXME: Are we sure this can be the only separator?
3864 return d->text_[pos] == ' ';
3868 void Paragraph::deregisterWords()
3870 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3871 Private::LangWordsMap::const_iterator ite = d->words_.end();
3872 for (; itl != ite; ++itl) {
3873 WordList & wl = theWordList(itl->first);
3874 Private::Words::const_iterator it = (itl->second).begin();
3875 Private::Words::const_iterator et = (itl->second).end();
3876 for (; it != et; ++it)
3883 void Paragraph::locateWord(pos_type & from, pos_type & to,
3884 word_location const loc) const
3887 case WHOLE_WORD_STRICT:
3888 if (from == 0 || from == size()
3889 || isWordSeparator(from)
3890 || isWordSeparator(from - 1)) {
3897 // If we are already at the beginning of a word, do nothing
3898 if (!from || isWordSeparator(from - 1))
3903 // always move the cursor to the beginning of previous word
3904 while (from && !isWordSeparator(from - 1))
3908 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
3911 // no need to move the 'from' cursor
3915 while (to < size() && !isWordSeparator(to))
3920 void Paragraph::collectWords()
3922 for (pos_type pos = 0; pos < size(); ++pos) {
3923 if (isWordSeparator(pos))
3925 pos_type from = pos;
3926 locateWord(from, pos, WHOLE_WORD);
3927 // Work around MSVC warning: The statement
3928 // if (pos < from + lyxrc.completion_minlength)
3929 // triggers a signed vs. unsigned warning.
3930 // I don't know why this happens, it could be a MSVC bug, or
3931 // related to LLP64 (windows) vs. LP64 (unix) programming
3932 // model, or the C++ standard might be ambigous in the section
3933 // defining the "usual arithmetic conversions". However, using
3934 // a temporary variable is safe and works on all compilers.
3935 pos_type const endpos = from + lyxrc.completion_minlength;
3938 FontList::const_iterator cit = d->fontlist_.fontIterator(from);
3939 if (cit == d->fontlist_.end())
3941 Language const * lang = cit->font().language();
3942 docstring const word = asString(from, pos, AS_STR_NONE);
3943 d->words_[lang->lang()].insert(word);
3948 void Paragraph::registerWords()
3950 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3951 Private::LangWordsMap::const_iterator ite = d->words_.end();
3952 for (; itl != ite; ++itl) {
3953 WordList & wl = theWordList(itl->first);
3954 Private::Words::const_iterator it = (itl->second).begin();
3955 Private::Words::const_iterator et = (itl->second).end();
3956 for (; it != et; ++it)
3962 void Paragraph::updateWords()
3970 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
3972 SkipPositionsIterator begin = skips.begin();
3973 SkipPositions::iterator end = skips.end();
3974 if (pos > 0 && begin < end) {
3976 if (end->last == pos - 1) {
3981 skips.insert(end, FontSpan(pos, pos));
3985 Language * Paragraph::Private::locateSpellRange(
3986 pos_type & from, pos_type & to,
3987 SkipPositions & skips) const
3989 // skip leading white space
3990 while (from < to && owner_->isWordSeparator(from))
3992 // don't check empty range
3995 // get current language
3996 Language * lang = getSpellLanguage(from);
3997 pos_type last = from;
3998 bool samelang = true;
3999 bool sameinset = true;
4000 while (last < to && samelang && sameinset) {
4001 // hop to end of word
4002 while (last < to && !owner_->isWordSeparator(last)) {
4003 if (owner_->getInset(last)) {
4004 appendSkipPosition(skips, last);
4005 } else if (owner_->isDeleted(last)) {
4006 appendSkipPosition(skips, last);
4010 // hop to next word while checking for insets
4011 while (sameinset && last < to && owner_->isWordSeparator(last)) {
4012 if (Inset const * inset = owner_->getInset(last))
4013 sameinset = inset->isChar() && inset->isLetter();
4014 if (sameinset && owner_->isDeleted(last)) {
4015 appendSkipPosition(skips, last);
4020 if (sameinset && last < to) {
4021 // now check for language change
4022 samelang = lang == getSpellLanguage(last);
4025 // if language change detected backstep is needed
4033 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
4036 const_cast<Language *>(owner_->getFontSettings(
4037 inset_owner_->buffer().params(), from).language());
4038 if (lang == inset_owner_->buffer().params().language
4039 && !lyxrc.spellchecker_alt_lang.empty()) {
4041 string const lang_variety =
4042 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
4043 lang->setCode(lang_code);
4044 lang->setVariety(lang_variety);
4050 void Paragraph::requestSpellCheck(pos_type pos)
4052 d->requestSpellCheck(pos);
4056 bool Paragraph::needsSpellCheck() const
4058 SpellChecker::ChangeNumber speller_change_number = 0;
4059 if (theSpellChecker())
4060 speller_change_number = theSpellChecker()->changeNumber();
4061 if (speller_change_number > d->speller_state_.currentChangeNumber()) {
4062 d->speller_state_.needsCompleteRefresh(speller_change_number);
4064 return d->needsSpellCheck();
4068 bool Paragraph::Private::ignoreWord(docstring const & word) const
4070 // Ignore words with digits
4071 // FIXME: make this customizable
4072 // (note that some checkers ignore words with digits by default)
4073 docstring::const_iterator cit = word.begin();
4074 docstring::const_iterator const end = word.end();
4075 for (; cit != end; ++cit) {
4076 if (isNumber((*cit)))
4083 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
4084 WordLangTuple & wl, docstring_list & suggestions,
4085 bool do_suggestion, bool check_learned) const
4087 SpellChecker::Result result = SpellChecker::WORD_OK;
4088 SpellChecker * speller = theSpellChecker();
4092 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
4095 locateWord(from, to, WHOLE_WORD);
4096 if (from == to || from >= size())
4099 docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4100 Language * lang = d->getSpellLanguage(from);
4102 wl = WordLangTuple(word, lang);
4107 if (needsSpellCheck() || check_learned) {
4109 if (!d->ignoreWord(word)) {
4110 bool const trailing_dot = to < size() && d->text_[to] == '.';
4111 result = speller->check(wl);
4112 if (SpellChecker::misspelled(result) && trailing_dot) {
4113 wl = WordLangTuple(word.append(from_ascii(".")), lang);
4114 result = speller->check(wl);
4115 if (!SpellChecker::misspelled(result)) {
4116 LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
4118 from << ".." << to << "]");
4120 // spell check with dot appended failed too
4121 // restore original word/lang value
4122 word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4123 wl = WordLangTuple(word, lang);
4127 if (!SpellChecker::misspelled(result)) {
4128 // area up to the begin of the next word is not misspelled
4129 while (end < size() && isWordSeparator(end))
4132 d->setMisspelled(from, end, result);
4134 result = d->speller_state_.getState(from);
4138 suggestions.clear();
4140 if (SpellChecker::misspelled(result)) {
4141 LYXERR(Debug::GUI, "misspelled word: \"" <<
4143 from << ".." << to << "]");
4145 speller->suggest(wl, suggestions);
4151 void Paragraph::Private::markMisspelledWords(
4152 pos_type const & first, pos_type const & last,
4153 SpellChecker::Result result,
4154 docstring const & word,
4155 SkipPositions const & skips)
4157 if (!SpellChecker::misspelled(result)) {
4158 setMisspelled(first, last, SpellChecker::WORD_OK);
4162 SpellChecker * speller = theSpellChecker();
4163 // locate and enumerate the error positions
4164 int nerrors = speller->numMisspelledWords();
4166 SkipPositionsIterator it = skips.begin();
4167 SkipPositionsIterator et = skips.end();
4168 for (int index = 0; index < nerrors; ++index) {
4171 speller->misspelledWord(index, wstart, wlen);
4172 /// should not happen if speller supports range checks
4173 if (!wlen) continue;
4174 docstring const misspelled = word.substr(wstart, wlen);
4175 wstart += first + numskipped;
4176 if (snext < wstart) {
4177 /// mark the range of correct spelling
4178 numskipped += countSkips(it, et, wstart);
4179 setMisspelled(snext,
4180 wstart - 1, SpellChecker::WORD_OK);
4182 snext = wstart + wlen;
4183 numskipped += countSkips(it, et, snext);
4184 /// mark the range of misspelling
4185 setMisspelled(wstart, snext, result);
4186 LYXERR(Debug::GUI, "misspelled word: \"" <<
4187 misspelled << "\" [" <<
4188 wstart << ".." << (snext-1) << "]");
4191 if (snext <= last) {
4192 /// mark the range of correct spelling at end
4193 setMisspelled(snext, last, SpellChecker::WORD_OK);
4198 void Paragraph::spellCheck() const
4200 SpellChecker * speller = theSpellChecker();
4201 if (!speller || empty() ||!needsSpellCheck())
4205 d->rangeOfSpellCheck(start, endpos);
4206 if (speller->canCheckParagraph()) {
4207 // loop until we leave the range
4208 for (pos_type first = start; first < endpos; ) {
4209 pos_type last = endpos;
4210 Private::SkipPositions skips;
4211 Language * lang = d->locateSpellRange(first, last, skips);
4212 if (first >= endpos)
4214 // start the spell checker on the unit of meaning
4215 docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
4216 WordLangTuple wl = WordLangTuple(word, lang);
4217 SpellChecker::Result result = word.size() ?
4218 speller->check(wl) : SpellChecker::WORD_OK;
4219 d->markMisspelledWords(first, last, result, word, skips);
4223 static docstring_list suggestions;
4224 pos_type to = endpos;
4225 while (start < endpos) {
4227 spellCheck(start, to, wl, suggestions, false);
4231 d->readySpellCheck();
4235 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
4237 bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
4238 if (result || pos <= 0 || pos > size())
4240 if (check_boundary && (pos == size() || isWordSeparator(pos)))
4241 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
4246 string Paragraph::magicLabel() const
4249 ss << "magicparlabel-" << id();