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 en dash and "---" an em dash.
1242 // (Within \ttfamily, "---" is merged to en dash + hyphen.)
1248 os << "\\textquotedbl" << termcmd;
1253 case '%': case '#': case '{':
1261 os << "\\textasciitilde" << termcmd;
1266 os << "\\textasciicircum" << termcmd;
1273 // avoid being mistaken for optional arguments
1281 // Blanks are printed before font switching.
1282 // Sure? I am not! (try nice-latex)
1283 // I am sure it's correct. LyX might be smarter
1284 // in the future, but for now, nothing wrong is
1290 // XeTeX's dash behaviour is determined via a global setting
1291 if (bparams.use_dash_ligatures
1292 && owner_->getFontSettings(bparams, i).fontInfo().family() != TYPEWRITER_FAMILY
1293 && (!bparams.useNonTeXFonts || runparams.flavor != OutputParams::XETEX)) {
1310 Encoding const & encoding = *(runparams.encoding);
1311 char_type next = '\0';
1312 if (i + 1 < int(text_.size())) {
1313 next = text_[i + 1];
1314 if (Encodings::isCombiningChar(next)) {
1315 column += latexSurrogatePair(os, c, next, runparams) - 1;
1321 pair<docstring, bool> latex = encoding.latexChar(c);
1322 docstring nextlatex;
1323 bool nexttipas = false;
1324 string nexttipashortcut;
1325 if (next != '\0' && next != META_INSET && encoding.encodable(next)) {
1326 nextlatex = encoding.latexChar(next).first;
1327 if (runparams.inIPA) {
1328 nexttipashortcut = Encodings::TIPAShortcut(next);
1329 nexttipas = !nexttipashortcut.empty();
1333 if (runparams.inIPA) {
1334 string const tipashortcut = Encodings::TIPAShortcut(c);
1335 if (!tipashortcut.empty()) {
1336 latex.first = from_ascii(tipashortcut);
1337 latex.second = false;
1341 if (Encodings::isKnownScriptChar(c, script)
1342 && prefixIs(latex.first, from_ascii("\\" + script)))
1343 column += writeScriptChars(os, latex.first,
1344 running_change, encoding, i) - 1;
1345 else if (latex.second
1346 && ((!prefixIs(nextlatex, '\\')
1347 && !prefixIs(nextlatex, '{')
1348 && !prefixIs(nextlatex, '}'))
1350 && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1352 // Prevent eating of a following
1353 // space or command corruption by
1354 // following characters
1355 if (next == ' ' || next == '\0') {
1356 column += latex.first.length() + 1;
1357 os << latex.first << "{}";
1359 column += latex.first.length();
1360 os << latex.first << " ";
1363 column += latex.first.length() - 1;
1371 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1372 pos_type i, unsigned int & column)
1378 // In T1 encoding, these characters exist
1379 // but we should avoid ligatures
1380 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1382 os << "\\textcompwordmark" << termcmd;
1389 // soul.sty breaks with \char`\"
1390 os << "\\textquotedbl" << termcmd;
1399 bool Paragraph::Private::latexSpecialTU(char_type const c, otexstream & os,
1400 pos_type i, unsigned int & column)
1402 // TU encoding is currently on par with T1.
1403 return latexSpecialT1(c, os, i, column);
1407 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1408 pos_type /*i*/, unsigned int & column)
1418 os << "\\textvertline" << termcmd;
1422 os << "\\textendash" << termcmd;
1426 os << "\\textemdash" << termcmd;
1435 void Paragraph::Private::validate(LaTeXFeatures & features) const
1437 Buffer const & buf = inset_owner_->buffer();
1438 BufferParams const & bp = features.runparams().is_child
1439 ? buf.masterParams() : buf.params();
1440 if (layout_->inpreamble && inset_owner_) {
1441 // FIXME: Using a string stream here circumvents the encoding
1442 // switching machinery of odocstream. Therefore the
1443 // output is wrong if this paragraph contains content
1444 // that needs to switch encoding.
1445 otexstringstream os;
1446 os << layout_->preamble();
1447 size_t const length = os.length();
1448 TeXOnePar(buf, buf.text(), buf.getParFromID(owner_->id()).pit(), os,
1449 features.runparams(), string(), 0, -1, true);
1450 if (os.length() > length)
1451 features.addPreambleSnippet(os.release(), true);
1454 if (features.runparams().flavor == OutputParams::HTML
1455 && layout_->htmltitle()) {
1456 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1459 // check the params.
1460 if (!params_.spacing().isDefault())
1461 features.require("setspace");
1464 features.useLayout(layout_->name());
1467 fontlist_.validate(features);
1469 // then the indentation
1470 if (!params_.leftIndent().zero())
1471 features.require("ParagraphLeftIndent");
1474 InsetList::const_iterator icit = insetlist_.begin();
1475 InsetList::const_iterator iend = insetlist_.end();
1476 for (; icit != iend; ++icit) {
1478 features.inDeletedInset(owner_->isDeleted(icit->pos));
1479 if (icit->inset->lyxCode() == FOOT_CODE) {
1480 // FIXME: an item inset would make things much easier.
1481 if ((layout_->latextype == LATEX_LIST_ENVIRONMENT
1482 || (layout_->latextype == LATEX_ITEM_ENVIRONMENT
1483 && layout_->margintype == MARGIN_FIRST_DYNAMIC))
1484 && (icit->pos < begin_of_body_
1485 || (icit->pos == begin_of_body_
1486 && (icit->pos == 0 || text_[icit->pos - 1] != ' '))))
1487 features.saveNoteEnv("description");
1489 icit->inset->validate(features);
1490 features.inDeletedInset(false);
1491 if (layout_->needprotect &&
1492 icit->inset->lyxCode() == FOOT_CODE)
1493 features.require("NeedLyXFootnoteCode");
1497 // then the contents
1498 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1499 char_type c = text_[i];
1501 if (features.runparams().isFullUnicode() && bp.useNonTeXFonts)
1502 features.require("textquotedblp");
1503 else if (bp.main_font_encoding() != "T1"
1504 || ((&owner_->getFontSettings(bp, i))->language()->internalFontEncoding()))
1505 features.require("textquotedbl");
1507 if (!bp.use_dash_ligatures
1508 && (c == 0x2013 || c == 0x2014)
1509 && bp.useNonTeXFonts
1510 && features.runparams().flavor == OutputParams::XETEX)
1511 // XeTeX's dash behaviour is determined via a global setting
1512 features.require("xetexdashbreakstate");
1513 BufferEncodings::validate(c, features);
1517 /////////////////////////////////////////////////////////////////////
1521 /////////////////////////////////////////////////////////////////////
1524 Layout const emptyParagraphLayout;
1527 Paragraph::Paragraph()
1528 : d(new Paragraph::Private(this, emptyParagraphLayout))
1535 Paragraph::Paragraph(Paragraph const & par)
1536 : itemdepth(par.itemdepth),
1537 d(new Paragraph::Private(*par.d, this))
1543 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1544 : itemdepth(par.itemdepth),
1545 d(new Paragraph::Private(*par.d, this, beg, end))
1551 Paragraph & Paragraph::operator=(Paragraph const & par)
1553 // needed as we will destroy the private part before copying it
1555 itemdepth = par.itemdepth;
1559 d = new Private(*par.d, this);
1566 Paragraph::~Paragraph()
1575 // this shall be called just before every "os << ..." action.
1576 void flushString(ostream & os, docstring & s)
1585 void Paragraph::write(ostream & os, BufferParams const & bparams,
1586 depth_type & dth) const
1588 // The beginning or end of a deeper (i.e. nested) area?
1589 if (dth != d->params_.depth()) {
1590 if (d->params_.depth() > dth) {
1591 while (d->params_.depth() > dth) {
1592 os << "\n\\begin_deeper";
1596 while (d->params_.depth() < dth) {
1597 os << "\n\\end_deeper";
1603 // First write the layout
1604 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1606 d->params_.write(os);
1608 Font font1(inherit_font, bparams.language);
1610 Change running_change = Change(Change::UNCHANGED);
1612 // this string is used as a buffer to avoid repetitive calls
1613 // to to_utf8(), which turn out to be expensive (JMarc)
1614 docstring write_buffer;
1617 for (pos_type i = 0; i <= size(); ++i) {
1619 Change const & change = lookupChange(i);
1620 if (change != running_change)
1621 flushString(os, write_buffer);
1622 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1623 running_change = change;
1628 // Write font changes
1629 Font font2 = getFontSettings(bparams, i);
1630 if (font2 != font1) {
1631 flushString(os, write_buffer);
1632 font2.lyxWriteChanges(font1, os);
1637 char_type const c = d->text_[i];
1640 if (Inset const * inset = getInset(i)) {
1641 flushString(os, write_buffer);
1642 if (inset->directWrite()) {
1643 // international char, let it write
1644 // code directly so it's shorter in
1650 os << "\\begin_inset ";
1652 os << "\n\\end_inset\n\n";
1655 // FIXME This can be removed again once the mystery
1656 // crash has been resolved.
1661 flushString(os, write_buffer);
1662 os << "\n\\backslash\n";
1666 flushString(os, write_buffer);
1667 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1674 if ((column > 70 && c == ' ')
1676 flushString(os, write_buffer);
1680 // this check is to amend a bug. LyX sometimes
1681 // inserts '\0' this could cause problems.
1683 write_buffer.push_back(c);
1685 LYXERR0("NUL char in structure.");
1691 flushString(os, write_buffer);
1692 os << "\n\\end_layout\n";
1693 // FIXME This can be removed again once the mystery
1694 // crash has been resolved.
1699 void Paragraph::validate(LaTeXFeatures & features) const
1701 d->validate(features);
1705 void Paragraph::insert(pos_type start, docstring const & str,
1706 Font const & font, Change const & change)
1708 for (size_t i = 0, n = str.size(); i != n ; ++i)
1709 insertChar(start + i, str[i], font, change);
1713 void Paragraph::appendChar(char_type c, Font const & font,
1714 Change const & change)
1717 d->changes_.insert(change, d->text_.size());
1718 // when appending characters, no need to update tables
1719 d->text_.push_back(c);
1720 setFont(d->text_.size() - 1, font);
1721 d->requestSpellCheck(d->text_.size() - 1);
1725 void Paragraph::appendString(docstring const & s, Font const & font,
1726 Change const & change)
1728 pos_type end = s.size();
1729 size_t oldsize = d->text_.size();
1730 size_t newsize = oldsize + end;
1731 size_t capacity = d->text_.capacity();
1732 if (newsize >= capacity)
1733 d->text_.reserve(max(capacity + 100, newsize));
1735 // when appending characters, no need to update tables
1738 // FIXME: Optimize this!
1739 for (size_t i = oldsize; i != newsize; ++i) {
1741 d->changes_.insert(change, i);
1742 d->requestSpellCheck(i);
1744 d->fontlist_.set(oldsize, font);
1745 d->fontlist_.set(newsize - 1, font);
1749 void Paragraph::insertChar(pos_type pos, char_type c,
1752 d->insertChar(pos, c, Change(trackChanges ?
1753 Change::INSERTED : Change::UNCHANGED));
1757 void Paragraph::insertChar(pos_type pos, char_type c,
1758 Font const & font, bool trackChanges)
1760 d->insertChar(pos, c, Change(trackChanges ?
1761 Change::INSERTED : Change::UNCHANGED));
1766 void Paragraph::insertChar(pos_type pos, char_type c,
1767 Font const & font, Change const & change)
1769 d->insertChar(pos, c, change);
1774 void Paragraph::resetFonts(Font const & font)
1776 d->fontlist_.clear();
1777 d->fontlist_.set(0, font);
1778 d->fontlist_.set(d->text_.size() - 1, font);
1781 // Gets uninstantiated font setting at position.
1782 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1786 LYXERR0("pos: " << pos << " size: " << size());
1790 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1791 if (cit != d->fontlist_.end())
1794 if (pos == size() && !empty())
1795 return getFontSettings(bparams, pos - 1);
1797 // Optimisation: avoid a full font instantiation if there is no
1798 // language change from previous call.
1799 static Font previous_font;
1800 static Language const * previous_lang = 0;
1801 Language const * lang = getParLanguage(bparams);
1802 if (lang != previous_lang) {
1803 previous_lang = lang;
1804 previous_font = Font(inherit_font, lang);
1806 return previous_font;
1810 FontSpan Paragraph::fontSpan(pos_type pos) const
1812 LBUFERR(pos <= size());
1815 return FontSpan(pos, pos);
1818 FontList::const_iterator cit = d->fontlist_.begin();
1819 FontList::const_iterator end = d->fontlist_.end();
1820 for (; cit != end; ++cit) {
1821 if (cit->pos() >= pos) {
1822 if (pos >= beginOfBody())
1823 return FontSpan(max(start, beginOfBody()),
1826 return FontSpan(start,
1827 min(beginOfBody() - 1,
1830 start = cit->pos() + 1;
1833 // This should not happen, but if so, we take no chances.
1834 LYXERR0("Paragraph::fontSpan: position not found in fontinfo table!");
1835 LASSERT(false, return FontSpan(pos, pos));
1839 // Gets uninstantiated font setting at position 0
1840 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1842 if (!empty() && !d->fontlist_.empty())
1843 return d->fontlist_.begin()->font();
1845 // Optimisation: avoid a full font instantiation if there is no
1846 // language change from previous call.
1847 static Font previous_font;
1848 static Language const * previous_lang = 0;
1849 if (bparams.language != previous_lang) {
1850 previous_lang = bparams.language;
1851 previous_font = Font(inherit_font, bparams.language);
1854 return previous_font;
1858 // Gets the fully instantiated font at a given position in a paragraph
1859 // This is basically the same function as Text::GetFont() in text2.cpp.
1860 // The difference is that this one is used for generating the LaTeX file,
1861 // and thus cosmetic "improvements" are disallowed: This has to deliver
1862 // the true picture of the buffer. (Asger)
1863 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1864 Font const & outerfont) const
1868 Font font = getFontSettings(bparams, pos);
1870 pos_type const body_pos = beginOfBody();
1871 FontInfo & fi = font.fontInfo();
1873 fi.realize(d->layout_->labelfont);
1875 fi.realize(d->layout_->font);
1877 fi.realize(outerfont.fontInfo());
1878 fi.realize(bparams.getFont().fontInfo());
1884 Font const Paragraph::getLabelFont
1885 (BufferParams const & bparams, Font const & outerfont) const
1887 FontInfo tmpfont = d->layout_->labelfont;
1888 tmpfont.realize(outerfont.fontInfo());
1889 tmpfont.realize(bparams.getFont().fontInfo());
1890 return Font(tmpfont, getParLanguage(bparams));
1894 Font const Paragraph::getLayoutFont
1895 (BufferParams const & bparams, Font const & outerfont) const
1897 FontInfo tmpfont = d->layout_->font;
1898 tmpfont.realize(outerfont.fontInfo());
1899 tmpfont.realize(bparams.getFont().fontInfo());
1900 return Font(tmpfont, getParLanguage(bparams));
1904 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1906 char_type c = d->text_[pos];
1907 if (!getFontSettings(bparams, pos).isRightToLeft())
1910 // FIXME: The arabic special casing is due to the difference of arabic
1911 // round brackets input introduced in r18599. Check if this should be
1912 // unified with Hebrew or at least if all bracket types should be
1913 // handled the same (file format change in either case).
1914 string const & lang = getFontSettings(bparams, pos).language()->lang();
1915 bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi"
1920 uc = arabic ? c : ')';
1923 uc = arabic ? c : '(';
1949 void Paragraph::setFont(pos_type pos, Font const & font)
1951 LASSERT(pos <= size(), return);
1953 // First, reduce font against layout/label font
1954 // Update: The setCharFont() routine in text2.cpp already
1955 // reduces font, so we don't need to do that here. (Asger)
1957 d->fontlist_.set(pos, font);
1961 void Paragraph::makeSameLayout(Paragraph const & par)
1963 d->layout_ = par.d->layout_;
1964 d->params_ = par.d->params_;
1968 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1970 if (isFreeSpacing())
1976 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1977 if (eraseChar(pos, trackChanges))
1983 return count > 0 || pos > 0;
1987 bool Paragraph::hasSameLayout(Paragraph const & par) const
1989 return par.d->layout_ == d->layout_
1990 && d->params_.sameLayout(par.d->params_);
1994 depth_type Paragraph::getDepth() const
1996 return d->params_.depth();
2000 depth_type Paragraph::getMaxDepthAfter() const
2002 if (d->layout_->isEnvironment())
2003 return d->params_.depth() + 1;
2005 return d->params_.depth();
2009 LyXAlignment Paragraph::getAlign() const
2011 if (d->params_.align() == LYX_ALIGN_LAYOUT)
2012 return d->layout_->align;
2014 return d->params_.align();
2018 docstring const & Paragraph::labelString() const
2020 return d->params_.labelString();
2024 // the next two functions are for the manual labels
2025 docstring const Paragraph::getLabelWidthString() const
2027 if (d->layout_->margintype == MARGIN_MANUAL
2028 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
2029 return d->params_.labelWidthString();
2031 return _("Senseless with this layout!");
2035 void Paragraph::setLabelWidthString(docstring const & s)
2037 d->params_.labelWidthString(s);
2041 docstring Paragraph::expandLabel(Layout const & layout,
2042 BufferParams const & bparams) const
2044 return expandParagraphLabel(layout, bparams, true);
2048 docstring Paragraph::expandDocBookLabel(Layout const & layout,
2049 BufferParams const & bparams) const
2051 return expandParagraphLabel(layout, bparams, false);
2055 docstring Paragraph::expandParagraphLabel(Layout const & layout,
2056 BufferParams const & bparams, bool process_appendix) const
2058 DocumentClass const & tclass = bparams.documentClass();
2059 string const & lang = getParLanguage(bparams)->code();
2060 bool const in_appendix = process_appendix && d->params_.appendix();
2061 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
2063 if (fmt.empty() && !layout.counter.empty())
2064 return tclass.counters().theCounter(layout.counter, lang);
2066 // handle 'inherited level parts' in 'fmt',
2067 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
2068 size_t const i = fmt.find('@', 0);
2069 if (i != docstring::npos) {
2070 size_t const j = fmt.find('@', i + 1);
2071 if (j != docstring::npos) {
2072 docstring parent(fmt, i + 1, j - i - 1);
2073 docstring label = from_ascii("??");
2074 if (tclass.hasLayout(parent))
2075 label = expandParagraphLabel(tclass[parent], bparams,
2077 fmt = docstring(fmt, 0, i) + label
2078 + docstring(fmt, j + 1, docstring::npos);
2082 return tclass.counters().counterLabel(fmt, lang);
2086 void Paragraph::applyLayout(Layout const & new_layout)
2088 d->layout_ = &new_layout;
2089 LyXAlignment const oldAlign = d->params_.align();
2091 if (!(oldAlign & d->layout_->alignpossible)) {
2092 frontend::Alert::warning(_("Alignment not permitted"),
2093 _("The new layout does not permit the alignment previously used.\nSetting to default."));
2094 d->params_.align(LYX_ALIGN_LAYOUT);
2099 pos_type Paragraph::beginOfBody() const
2101 return d->begin_of_body_;
2105 void Paragraph::setBeginOfBody()
2107 if (d->layout_->labeltype != LABEL_MANUAL) {
2108 d->begin_of_body_ = 0;
2112 // Unroll the first two cycles of the loop
2113 // and remember the previous character to
2114 // remove unnecessary getChar() calls
2116 pos_type end = size();
2117 if (i < end && !(isNewline(i) || isEnvSeparator(i))) {
2120 char_type previous_char = d->text_[i];
2121 if (!(isNewline(i) || isEnvSeparator(i))) {
2123 while (i < end && previous_char != ' ') {
2124 char_type temp = d->text_[i];
2125 if (isNewline(i) || isEnvSeparator(i))
2128 previous_char = temp;
2134 d->begin_of_body_ = i;
2138 bool Paragraph::allowParagraphCustomization() const
2140 return inInset().allowParagraphCustomization();
2144 bool Paragraph::usePlainLayout() const
2146 return inInset().usePlainLayout();
2150 bool Paragraph::isPassThru() const
2152 return inInset().isPassThru() || d->layout_->pass_thru;
2157 // paragraphs inside floats need different alignment tags to avoid
2160 bool noTrivlistCentering(InsetCode code)
2162 return code == FLOAT_CODE
2163 || code == WRAP_CODE
2164 || code == CELL_CODE;
2168 string correction(string const & orig)
2170 if (orig == "flushleft")
2171 return "raggedright";
2172 if (orig == "flushright")
2173 return "raggedleft";
2174 if (orig == "center")
2180 bool corrected_env(otexstream & os, string const & suffix, string const & env,
2181 InsetCode code, bool const lastpar, int & col)
2183 string macro = suffix + "{";
2184 if (noTrivlistCentering(code)) {
2186 // the last paragraph in non-trivlist-aligned
2187 // context is special (to avoid unwanted whitespace)
2188 if (suffix == "\\begin") {
2189 macro = "\\" + correction(env) + "{}";
2190 os << from_ascii(macro);
2191 col += macro.size();
2196 macro += correction(env);
2200 if (suffix == "\\par\\end") {
2204 os << from_ascii(macro);
2205 col += macro.size();
2206 if (suffix == "\\begin") {
2216 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2217 otexstream & os, OutputParams const & runparams) const
2222 (bparams.paragraph_separation == BufferParams::ParagraphIndentSeparation) ?
2223 (layout_->toggle_indent != ITOGGLE_NEVER) :
2224 (layout_->toggle_indent == ITOGGLE_ALWAYS);
2226 if (canindent && params_.noindent() && !layout_->pass_thru) {
2227 os << "\\noindent ";
2231 LyXAlignment const curAlign = params_.align();
2233 if (curAlign == layout_->align)
2237 case LYX_ALIGN_NONE:
2238 case LYX_ALIGN_BLOCK:
2239 case LYX_ALIGN_LAYOUT:
2240 case LYX_ALIGN_SPECIAL:
2241 case LYX_ALIGN_DECIMAL:
2243 case LYX_ALIGN_LEFT:
2244 case LYX_ALIGN_RIGHT:
2245 case LYX_ALIGN_CENTER:
2246 if (runparams.moving_arg) {
2253 string const begin_tag = "\\begin";
2254 InsetCode code = ownerCode();
2255 bool const lastpar = runparams.isLastPar;
2258 case LYX_ALIGN_NONE:
2259 case LYX_ALIGN_BLOCK:
2260 case LYX_ALIGN_LAYOUT:
2261 case LYX_ALIGN_SPECIAL:
2262 case LYX_ALIGN_DECIMAL:
2264 case LYX_ALIGN_LEFT: {
2265 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2266 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2268 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2270 } case LYX_ALIGN_RIGHT: {
2271 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2272 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2274 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2276 } case LYX_ALIGN_CENTER: {
2277 corrected_env(os, begin_tag, "center", code, lastpar, column);
2286 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2287 otexstream & os, OutputParams const & runparams) const
2289 LyXAlignment const curAlign = params_.align();
2291 if (curAlign == layout_->align)
2295 case LYX_ALIGN_NONE:
2296 case LYX_ALIGN_BLOCK:
2297 case LYX_ALIGN_LAYOUT:
2298 case LYX_ALIGN_SPECIAL:
2299 case LYX_ALIGN_DECIMAL:
2301 case LYX_ALIGN_LEFT:
2302 case LYX_ALIGN_RIGHT:
2303 case LYX_ALIGN_CENTER:
2304 if (runparams.moving_arg)
2309 bool output = false;
2311 string const end_tag = "\\par\\end";
2312 InsetCode code = ownerCode();
2313 bool const lastpar = runparams.isLastPar;
2316 case LYX_ALIGN_NONE:
2317 case LYX_ALIGN_BLOCK:
2318 case LYX_ALIGN_LAYOUT:
2319 case LYX_ALIGN_SPECIAL:
2320 case LYX_ALIGN_DECIMAL:
2322 case LYX_ALIGN_LEFT: {
2323 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2324 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2326 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2328 } case LYX_ALIGN_RIGHT: {
2329 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2330 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2332 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2334 } case LYX_ALIGN_CENTER: {
2335 corrected_env(os, end_tag, "center", code, lastpar, col);
2340 return output || lastpar;
2344 // This one spits out the text of the paragraph
2345 void Paragraph::latex(BufferParams const & bparams,
2346 Font const & outerfont,
2348 OutputParams const & runparams,
2349 int start_pos, int end_pos, bool force) const
2351 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
2353 // FIXME This check should not be needed. Perhaps issue an
2354 // error if it triggers.
2355 Layout const & style = inInset().forcePlainLayout() ?
2356 bparams.documentClass().plainLayout() : *d->layout_;
2358 if (!force && style.inpreamble)
2361 bool const allowcust = allowParagraphCustomization();
2363 // Current base font for all inherited font changes, without any
2364 // change caused by an individual character, except for the language:
2365 // It is set to the language of the first character.
2366 // As long as we are in the label, this font is the base font of the
2367 // label. Before the first body character it is set to the base font
2371 // Maybe we have to create a optional argument.
2372 pos_type body_pos = beginOfBody();
2373 unsigned int column = 0;
2376 // the optional argument is kept in curly brackets in
2377 // case it contains a ']'
2378 // This is not strictly needed, but if this is changed it
2379 // would be a file format change, and tex2lyx would need
2380 // to be adjusted, since it unconditionally removes the
2381 // braces when it parses \item.
2384 basefont = getLabelFont(bparams, outerfont);
2386 basefont = getLayoutFont(bparams, outerfont);
2389 // Which font is currently active?
2390 Font running_font(basefont);
2391 // Do we have an open font change?
2392 bool open_font = false;
2394 Change runningChange = Change(Change::UNCHANGED);
2396 Encoding const * const prev_encoding = runparams.encoding;
2398 os.texrow().start(id(), 0);
2400 // if the paragraph is empty, the loop will not be entered at all
2402 // For InTitle commands, we have already opened a group
2403 // in output_latex::TeXOnePar.
2404 if (style.isCommand() && !style.intitle) {
2408 if (!style.leftdelim().empty()) {
2409 os << style.leftdelim();
2410 column += style.leftdelim().size();
2413 column += d->startTeXParParams(bparams, os, runparams);
2416 // Whether a \par can be issued for insets typeset inline with text.
2417 // Yes if greater than 0. This has to be static.
2418 THREAD_LOCAL_STATIC int parInline = 0;
2420 for (pos_type i = 0; i < size(); ++i) {
2421 // First char in paragraph or after label?
2422 if (i == body_pos) {
2425 bool needPar = false;
2426 column += running_font.latexWriteEndChanges(
2427 os, bparams, runparams,
2428 basefont, basefont, needPar);
2431 basefont = getLayoutFont(bparams, outerfont);
2432 running_font = basefont;
2434 column += Changes::latexMarkChange(os, bparams,
2435 runningChange, Change(Change::UNCHANGED),
2437 runningChange = Change(Change::UNCHANGED);
2442 // For InTitle commands, we have already opened a group
2443 // in output_latex::TeXOnePar.
2444 if (style.isCommand() && !style.intitle) {
2449 if (!style.leftdelim().empty()) {
2450 os << style.leftdelim();
2451 column += style.leftdelim().size();
2455 column += d->startTeXParParams(bparams, os,
2459 runparams.wasDisplayMath = runparams.inDisplayMath;
2460 runparams.inDisplayMath = false;
2461 bool deleted_display_math = false;
2462 Change const & change = runparams.inDeletedInset
2463 ? runparams.changeOfDeletedInset : lookupChange(i);
2465 // Check whether a display math inset follows
2466 if (d->text_[i] == META_INSET
2467 && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2468 InsetMath const * im = getInset(i)->asInsetMath();
2469 if (im && im->asHullInset()
2470 && im->asHullInset()->outerDisplay()) {
2471 runparams.inDisplayMath = true;
2472 // runparams.inDeletedInset will be set by
2473 // latexInset later, but we need this info
2474 // before it is called. On the other hand, we
2475 // cannot set it here because it is a counter.
2476 deleted_display_math = isDeleted(i);
2478 if (bparams.output_changes && deleted_display_math
2479 && runningChange == change
2480 && change.type == Change::DELETED
2481 && !os.afterParbreak()) {
2482 // A display math in the same paragraph follows.
2483 // We have to close and then reopen \lyxdeleted,
2484 // otherwise the math will be shifted up.
2485 OutputParams rp = runparams;
2487 bool needPar = false;
2488 column += running_font.latexWriteEndChanges(
2489 os, bparams, rp, basefont,
2493 basefont = getLayoutFont(bparams, outerfont);
2494 running_font = basefont;
2495 column += Changes::latexMarkChange(os, bparams,
2496 Change(Change::INSERTED), change, rp);
2500 if (bparams.output_changes && runningChange != change) {
2502 bool needPar = false;
2503 column += running_font.latexWriteEndChanges(
2504 os, bparams, runparams,
2505 basefont, basefont, needPar);
2508 basefont = getLayoutFont(bparams, outerfont);
2509 running_font = basefont;
2510 column += Changes::latexMarkChange(os, bparams, runningChange,
2512 runningChange = change;
2515 // do not output text which is marked deleted
2516 // if change tracking output is disabled
2517 if (!bparams.output_changes && change.deleted()) {
2523 // Fully instantiated font
2524 Font const current_font = getFont(bparams, i, outerfont);
2526 Font const last_font = running_font;
2528 // Do we need to close the previous font?
2530 (current_font != running_font ||
2531 current_font.language() != running_font.language()))
2533 bool needPar = false;
2534 column += running_font.latexWriteEndChanges(
2535 os, bparams, runparams, basefont,
2536 (i == body_pos-1) ? basefont : current_font,
2538 running_font = basefont;
2542 string const running_lang = runparams.use_polyglossia ?
2543 running_font.language()->polyglossia() : running_font.language()->babel();
2544 // close babel's font environment before opening CJK.
2545 string const lang_end_command = runparams.use_polyglossia ?
2546 "\\end{$$lang}" : lyxrc.language_command_end;
2547 bool const using_begin_end = runparams.use_polyglossia ||
2548 !lang_end_command.empty();
2549 if (!running_lang.empty() &&
2550 (!using_begin_end || running_lang == openLanguageName()) &&
2551 current_font.language()->encoding()->package() == Encoding::CJK) {
2552 string end_tag = subst(lang_end_command,
2555 os << from_ascii(end_tag);
2556 column += end_tag.length();
2557 if (using_begin_end)
2561 // Switch file encoding if necessary (and allowed)
2562 if (!runparams.pass_thru && !style.pass_thru &&
2563 runparams.encoding->package() != Encoding::none &&
2564 current_font.language()->encoding()->package() != Encoding::none) {
2565 pair<bool, int> const enc_switch =
2566 switchEncoding(os.os(), bparams, runparams,
2567 *(current_font.language()->encoding()));
2568 if (enc_switch.first) {
2569 column += enc_switch.second;
2570 runparams.encoding = current_font.language()->encoding();
2574 char_type const c = d->text_[i];
2576 // A display math inset inside an ulem command will be output
2577 // as a box of width \linewidth, so we have to either disable
2578 // indentation if the inset starts a paragraph, or start a new
2579 // line to accommodate such box. This has to be done before
2580 // writing any font changing commands.
2581 if (runparams.inDisplayMath && !deleted_display_math
2582 && runparams.inulemcmd) {
2583 if (os.afterParbreak())
2589 // Do we need to change font?
2590 if ((current_font != running_font ||
2591 current_font.language() != running_font.language()) &&
2594 odocstringstream ods;
2595 column += current_font.latexWriteStartChanges(ods, bparams,
2596 runparams, basefont,
2598 // Check again for display math in ulem commands as a
2599 // font change may also occur just before a math inset.
2600 if (runparams.inDisplayMath && !deleted_display_math
2601 && runparams.inulemcmd) {
2602 if (os.afterParbreak())
2607 running_font = current_font;
2609 docstring fontchange = ods.str();
2610 // check whether the fontchange ends with a \\textcolor
2611 // modifier and the text starts with a space (bug 4473)
2612 docstring const last_modifier = rsplit(fontchange, '\\');
2613 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2614 os << fontchange << from_ascii("{}");
2615 // check if the fontchange ends with a trailing blank
2616 // (like "\small " (see bug 3382)
2617 else if (suffixIs(fontchange, ' ') && c == ' ')
2618 os << fontchange.substr(0, fontchange.size() - 1)
2619 << from_ascii("{}");
2624 // FIXME: think about end_pos implementation...
2625 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2626 // FIXME: integrate this case in latexSpecialChar
2627 // Do not print the separation of the optional argument
2628 // if style.pass_thru is false. This works because
2629 // latexSpecialChar ignores spaces if
2630 // style.pass_thru is false.
2631 if (i != body_pos - 1) {
2632 if (d->simpleTeXBlanks(runparams, os,
2633 i, column, current_font, style)) {
2634 // A surrogate pair was output. We
2635 // must not call latexSpecialChar
2636 // in this iteration, since it would output
2637 // the combining character again.
2644 OutputParams rp = runparams;
2645 rp.free_spacing = style.free_spacing;
2646 rp.local_font = ¤t_font;
2647 rp.intitle = style.intitle;
2649 // Two major modes: LaTeX or plain
2650 // Handle here those cases common to both modes
2651 // and then split to handle the two modes separately.
2652 if (c == META_INSET) {
2653 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2654 // Greyedout notes and, in general, all insets
2655 // with InsetLayout::isDisplay() == false,
2656 // are typeset inline with the text. So, we
2657 // can add a \par to the last paragraph of
2658 // such insets only if nothing else follows.
2659 bool incremented = false;
2660 Inset const * inset = getInset(i);
2661 InsetText const * textinset = inset
2662 ? inset->asInsetText()
2664 if (i + 1 == size() && textinset
2665 && !inset->getLayout().isDisplay()) {
2666 ParagraphList const & pars =
2667 textinset->text().paragraphs();
2668 pit_type const pit = pars.size() - 1;
2669 Font const last_font =
2670 pit < 0 || pars[pit].empty()
2671 ? pars[pit].getLayoutFont(
2674 : pars[pit].getFont(bparams,
2675 pars[pit].size() - 1,
2677 if (last_font.fontInfo().size() !=
2678 basefont.fontInfo().size()) {
2683 d->latexInset(bparams, os, rp, running_font,
2684 basefont, outerfont, open_font,
2685 runningChange, style, i, column);
2689 } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2691 d->latexSpecialChar(os, bparams, rp,
2692 running_font, runningChange,
2693 style, i, end_pos, column);
2694 } catch (EncodingException & e) {
2695 if (runparams.dryrun) {
2696 os << "<" << _("LyX Warning: ")
2697 << _("uncodable character") << " '";
2701 // add location information and throw again.
2709 // Set the encoding to that returned from latexSpecialChar (see
2710 // comment for encoding member in OutputParams.h)
2711 runparams.encoding = rp.encoding;
2713 // Also carry on the info on a closed ulem command for insets
2714 // such as Note that do not produce any output, so that no
2715 // command is ever executed but its opening was recorded.
2716 runparams.inulemcmd = rp.inulemcmd;
2719 // If we have an open font definition, we have to close it
2721 // Make sure that \\par is done with the font of the last
2722 // character if this has another size as the default.
2723 // This is necessary because LaTeX (and LyX on the screen)
2724 // calculates the space between the baselines according
2725 // to this font. (Matthias)
2727 // We must not change the font for the last paragraph
2728 // of non-multipar insets, tabular cells or commands,
2729 // since this produces unwanted whitespace.
2731 Font const font = empty()
2732 ? getLayoutFont(bparams, outerfont)
2733 : getFont(bparams, size() - 1, outerfont);
2735 InsetText const * textinset = inInset().asInsetText();
2737 bool const maintext = textinset
2738 ? textinset->text().isMainText()
2741 size_t const numpars = textinset
2742 ? textinset->text().paragraphs().size()
2745 bool needPar = false;
2747 if (style.resfont.size() != font.fontInfo().size()
2748 && (!runparams.isLastPar || maintext
2749 || (numpars > 1 && d->ownerCode() != CELL_CODE
2750 && (inInset().getLayout().isDisplay()
2752 && !style.isCommand()) {
2755 #ifdef FIXED_LANGUAGE_END_DETECTION
2757 running_font.latexWriteEndChanges(os, bparams,
2758 runparams, basefont,
2759 next_->getFont(bparams, 0, outerfont),
2762 running_font.latexWriteEndChanges(os, bparams,
2763 runparams, basefont, basefont, needPar);
2766 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2767 //FIXME: there as we start another \selectlanguage with the next paragraph if
2768 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2769 running_font.latexWriteEndChanges(os, bparams, runparams,
2770 basefont, basefont, needPar);
2773 // The \par could not be inserted at the same nesting
2774 // level of the font size change, so do it now.
2775 os << "{\\" << font.latexSize() << "\\par}";
2779 column += Changes::latexMarkChange(os, bparams, runningChange,
2780 Change(Change::UNCHANGED), runparams);
2782 // Needed if there is an optional argument but no contents.
2783 if (body_pos > 0 && body_pos == size()) {
2787 if (!style.rightdelim().empty()) {
2788 os << style.rightdelim();
2789 column += style.rightdelim().size();
2792 if (allowcust && d->endTeXParParams(bparams, os, runparams)
2793 && runparams.encoding != prev_encoding) {
2794 runparams.encoding = prev_encoding;
2795 os << setEncoding(prev_encoding->iconvName());
2798 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2802 bool Paragraph::emptyTag() const
2804 for (pos_type i = 0; i < size(); ++i) {
2805 if (Inset const * inset = getInset(i)) {
2806 InsetCode lyx_code = inset->lyxCode();
2807 // FIXME testing like that is wrong. What is
2809 if (lyx_code != TOC_CODE &&
2810 lyx_code != INCLUDE_CODE &&
2811 lyx_code != GRAPHICS_CODE &&
2812 lyx_code != ERT_CODE &&
2813 lyx_code != LISTINGS_CODE &&
2814 lyx_code != FLOAT_CODE &&
2815 lyx_code != TABULAR_CODE) {
2819 char_type c = d->text_[i];
2820 if (c != ' ' && c != '\t')
2828 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2831 for (pos_type i = 0; i < size(); ++i) {
2832 if (Inset const * inset = getInset(i)) {
2833 InsetCode lyx_code = inset->lyxCode();
2834 if (lyx_code == LABEL_CODE) {
2835 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2836 docstring const & id = il->getParam("name");
2837 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2845 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2849 for (i = 0; i < size(); ++i) {
2850 if (Inset const * inset = getInset(i)) {
2851 inset->docbook(os, runparams);
2853 char_type c = d->text_[i];
2856 os << sgml::escapeChar(c);
2863 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2867 for (i = 0; i < size(); ++i) {
2868 if (Inset const * inset = getInset(i)) {
2869 inset->xhtml(xs, runparams);
2871 char_type c = d->text_[i];
2881 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2884 pos_type size = text_.size();
2885 for (pos_type i = initial; i < size; ++i) {
2886 Font font = owner_->getFont(buf.params(), i, outerfont);
2887 if (text_[i] == META_INSET)
2889 if (i != initial && font != font_old)
2898 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2900 OutputParams const & runparams,
2901 Font const & outerfont,
2902 pos_type initial) const
2904 bool emph_flag = false;
2906 Layout const & style = *d->layout_;
2908 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2910 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2913 // parsing main loop
2914 for (pos_type i = initial; i < size(); ++i) {
2915 Font font = getFont(buf.params(), i, outerfont);
2917 // handle <emphasis> tag
2918 if (font_old.emph() != font.fontInfo().emph()) {
2919 if (font.fontInfo().emph() == FONT_ON) {
2922 } else if (i != initial) {
2923 os << "</emphasis>";
2928 if (Inset const * inset = getInset(i)) {
2929 inset->docbook(os, runparams);
2931 char_type c = d->text_[i];
2933 if (style.pass_thru)
2936 os << sgml::escapeChar(c);
2938 font_old = font.fontInfo();
2942 os << "</emphasis>";
2945 if (style.free_spacing)
2947 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2953 void doFontSwitch(vector<html::FontTag> & tagsToOpen,
2954 vector<html::EndFontTag> & tagsToClose,
2955 bool & flag, FontState curstate, html::FontTypes type)
2957 if (curstate == FONT_ON) {
2958 tagsToOpen.push_back(html::FontTag(type));
2961 tagsToClose.push_back(html::EndFontTag(type));
2968 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
2970 OutputParams const & runparams,
2971 Font const & outerfont,
2972 bool start_paragraph, bool close_paragraph,
2973 pos_type initial) const
2977 // track whether we have opened these tags
2978 bool emph_flag = false;
2979 bool bold_flag = false;
2980 bool noun_flag = false;
2981 bool ubar_flag = false;
2982 bool dbar_flag = false;
2983 bool sout_flag = false;
2984 bool xout_flag = false;
2985 bool wave_flag = false;
2987 bool shap_flag = false;
2989 bool faml_flag = false;
2991 bool size_flag = false;
2993 Layout const & style = *d->layout_;
2995 if (start_paragraph)
2996 xs.startDivision(allowEmpty());
2999 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3001 FontShape curr_fs = INHERIT_SHAPE;
3002 FontFamily curr_fam = INHERIT_FAMILY;
3003 FontSize curr_size = FONT_SIZE_INHERIT;
3005 string const default_family =
3006 buf.masterBuffer()->params().fonts_default_family;
3008 vector<html::FontTag> tagsToOpen;
3009 vector<html::EndFontTag> tagsToClose;
3011 // parsing main loop
3012 for (pos_type i = initial; i < size(); ++i) {
3013 // let's not show deleted material in the output
3017 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
3020 FontState curstate = font.fontInfo().emph();
3021 if (font_old.emph() != curstate)
3022 doFontSwitch(tagsToOpen, tagsToClose, emph_flag, curstate, html::FT_EMPH);
3025 curstate = font.fontInfo().noun();
3026 if (font_old.noun() != curstate)
3027 doFontSwitch(tagsToOpen, tagsToClose, noun_flag, curstate, html::FT_NOUN);
3030 curstate = font.fontInfo().underbar();
3031 if (font_old.underbar() != curstate)
3032 doFontSwitch(tagsToOpen, tagsToClose, ubar_flag, curstate, html::FT_UBAR);
3035 curstate = font.fontInfo().strikeout();
3036 if (font_old.strikeout() != curstate)
3037 doFontSwitch(tagsToOpen, tagsToClose, sout_flag, curstate, html::FT_SOUT);
3040 curstate = font.fontInfo().xout();
3041 if (font_old.xout() != curstate)
3042 doFontSwitch(tagsToOpen, tagsToClose, xout_flag, curstate, html::FT_XOUT);
3045 curstate = font.fontInfo().uuline();
3046 if (font_old.uuline() != curstate)
3047 doFontSwitch(tagsToOpen, tagsToClose, dbar_flag, curstate, html::FT_DBAR);
3050 curstate = font.fontInfo().uwave();
3051 if (font_old.uwave() != curstate)
3052 doFontSwitch(tagsToOpen, tagsToClose, wave_flag, curstate, html::FT_WAVE);
3055 // a little hackish, but allows us to reuse what we have.
3056 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
3057 if (font_old.series() != font.fontInfo().series())
3058 doFontSwitch(tagsToOpen, tagsToClose, bold_flag, curstate, html::FT_BOLD);
3061 curr_fs = font.fontInfo().shape();
3062 FontShape old_fs = font_old.shape();
3063 if (old_fs != curr_fs) {
3067 tagsToClose.push_back(html::EndFontTag(html::FT_ITALIC));
3070 tagsToClose.push_back(html::EndFontTag(html::FT_SLANTED));
3072 case SMALLCAPS_SHAPE:
3073 tagsToClose.push_back(html::EndFontTag(html::FT_SMALLCAPS));
3079 // the other tags are for internal use
3087 tagsToOpen.push_back(html::FontTag(html::FT_ITALIC));
3091 tagsToOpen.push_back(html::FontTag(html::FT_SLANTED));
3094 case SMALLCAPS_SHAPE:
3095 tagsToOpen.push_back(html::FontTag(html::FT_SMALLCAPS));
3102 // the other tags are for internal use
3109 curr_fam = font.fontInfo().family();
3110 FontFamily old_fam = font_old.family();
3111 if (old_fam != curr_fam) {
3115 tagsToClose.push_back(html::EndFontTag(html::FT_ROMAN));
3118 tagsToClose.push_back(html::EndFontTag(html::FT_SANS));
3120 case TYPEWRITER_FAMILY:
3121 tagsToClose.push_back(html::EndFontTag(html::FT_TYPE));
3123 case INHERIT_FAMILY:
3126 // the other tags are for internal use
3134 // we will treat a "default" font family as roman, since we have
3135 // no other idea what to do.
3136 if (default_family != "rmdefault" && default_family != "default") {
3137 tagsToOpen.push_back(html::FontTag(html::FT_ROMAN));
3142 if (default_family != "sfdefault") {
3143 tagsToOpen.push_back(html::FontTag(html::FT_SANS));
3147 case TYPEWRITER_FAMILY:
3148 if (default_family != "ttdefault") {
3149 tagsToOpen.push_back(html::FontTag(html::FT_TYPE));
3153 case INHERIT_FAMILY:
3156 // the other tags are for internal use
3163 curr_size = font.fontInfo().size();
3164 FontSize old_size = font_old.size();
3165 if (old_size != curr_size) {
3168 case FONT_SIZE_TINY:
3169 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_TINY));
3171 case FONT_SIZE_SCRIPT:
3172 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SCRIPT));
3174 case FONT_SIZE_FOOTNOTE:
3175 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_FOOTNOTE));
3177 case FONT_SIZE_SMALL:
3178 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SMALL));
3180 case FONT_SIZE_LARGE:
3181 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGE));
3183 case FONT_SIZE_LARGER:
3184 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGER));
3186 case FONT_SIZE_LARGEST:
3187 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGEST));
3189 case FONT_SIZE_HUGE:
3190 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGE));
3192 case FONT_SIZE_HUGER:
3193 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGER));
3195 case FONT_SIZE_INCREASE:
3196 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_INCREASE));
3198 case FONT_SIZE_DECREASE:
3199 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_DECREASE));
3201 case FONT_SIZE_INHERIT:
3202 case FONT_SIZE_NORMAL:
3205 // the other tags are for internal use
3211 switch (curr_size) {
3212 case FONT_SIZE_TINY:
3213 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_TINY));
3216 case FONT_SIZE_SCRIPT:
3217 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SCRIPT));
3220 case FONT_SIZE_FOOTNOTE:
3221 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_FOOTNOTE));
3224 case FONT_SIZE_SMALL:
3225 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SMALL));
3228 case FONT_SIZE_LARGE:
3229 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGE));
3232 case FONT_SIZE_LARGER:
3233 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGER));
3236 case FONT_SIZE_LARGEST:
3237 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGEST));
3240 case FONT_SIZE_HUGE:
3241 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGE));
3244 case FONT_SIZE_HUGER:
3245 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGER));
3248 case FONT_SIZE_INCREASE:
3249 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_INCREASE));
3252 case FONT_SIZE_DECREASE:
3253 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_DECREASE));
3256 case FONT_SIZE_NORMAL:
3257 case FONT_SIZE_INHERIT:
3260 // the other tags are for internal use
3267 // Other such tags? What about the other text ranges?
3269 vector<html::EndFontTag>::const_iterator cit = tagsToClose.begin();
3270 vector<html::EndFontTag>::const_iterator cen = tagsToClose.end();
3271 for (; cit != cen; ++cit)
3274 vector<html::FontTag>::const_iterator sit = tagsToOpen.begin();
3275 vector<html::FontTag>::const_iterator sen = tagsToOpen.end();
3276 for (; sit != sen; ++sit)
3279 tagsToClose.clear();
3282 Inset const * inset = getInset(i);
3284 if (!runparams.for_toc || inset->isInToc()) {
3285 OutputParams np = runparams;
3286 np.local_font = &font;
3287 // If the paragraph has size 1, then we are in the "special
3288 // case" where we do not output the containing paragraph info
3289 if (!inset->getLayout().htmlisblock() && size() != 1)
3290 np.html_in_par = true;
3291 retval += inset->xhtml(xs, np);
3294 char_type c = getUChar(buf.masterBuffer()->params(), i);
3297 font_old = font.fontInfo();
3301 // I'm worried about what happens if a branch, say, is itself
3302 // wrapped in some font stuff. I think that will not work.
3304 if (close_paragraph)
3311 bool Paragraph::isHfill(pos_type pos) const
3313 Inset const * inset = getInset(pos);
3314 return inset && inset->isHfill();
3318 bool Paragraph::isNewline(pos_type pos) const
3320 // U+2028 LINE SEPARATOR
3321 // U+2029 PARAGRAPH SEPARATOR
3322 char_type const c = d->text_[pos];
3323 if (c == 0x2028 || c == 0x2029)
3325 Inset const * inset = getInset(pos);
3326 return inset && inset->lyxCode() == NEWLINE_CODE;
3330 bool Paragraph::isEnvSeparator(pos_type pos) const
3332 Inset const * inset = getInset(pos);
3333 return inset && inset->lyxCode() == SEPARATOR_CODE;
3337 bool Paragraph::isLineSeparator(pos_type pos) const
3339 char_type const c = d->text_[pos];
3340 if (isLineSeparatorChar(c))
3342 Inset const * inset = getInset(pos);
3343 return inset && inset->isLineSeparator();
3347 bool Paragraph::isWordSeparator(pos_type pos) const
3351 if (Inset const * inset = getInset(pos))
3352 return !inset->isLetter();
3353 // if we have a hard hyphen (no en- or emdash) or apostrophe
3354 // we pass this to the spell checker
3355 // FIXME: this method is subject to change, visit
3356 // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
3357 // to get an impression how complex this is.
3358 if (isHardHyphenOrApostrophe(pos))
3360 char_type const c = d->text_[pos];
3361 // We want to pass the escape chars to the spellchecker
3362 docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
3363 return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
3367 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
3369 pos_type const psize = size();
3372 char_type const c = d->text_[pos];
3373 if (c != '-' && c != '\'')
3375 int nextpos = pos + 1;
3376 int prevpos = pos > 0 ? pos - 1 : 0;
3377 if ((nextpos == psize || isSpace(nextpos))
3378 && (pos == 0 || isSpace(prevpos)))
3384 FontSpan const & Paragraph::getSpellRange(pos_type pos) const
3386 return d->speller_state_.getRange(pos);
3390 bool Paragraph::isChar(pos_type pos) const
3392 if (Inset const * inset = getInset(pos))
3393 return inset->isChar();
3394 char_type const c = d->text_[pos];
3395 return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3399 bool Paragraph::isSpace(pos_type pos) const
3401 if (Inset const * inset = getInset(pos))
3402 return inset->isSpace();
3403 char_type const c = d->text_[pos];
3404 return lyx::isSpace(c);
3409 Paragraph::getParLanguage(BufferParams const & bparams) const
3412 return getFirstFontSettings(bparams).language();
3413 // FIXME: we should check the prev par as well (Lgb)
3414 return bparams.language;
3418 bool Paragraph::isRTL(BufferParams const & bparams) const
3420 return getParLanguage(bparams)->rightToLeft()
3421 && !inInset().getLayout().forceLTR();
3425 void Paragraph::changeLanguage(BufferParams const & bparams,
3426 Language const * from, Language const * to)
3428 // change language including dummy font change at the end
3429 for (pos_type i = 0; i <= size(); ++i) {
3430 Font font = getFontSettings(bparams, i);
3431 if (font.language() == from) {
3432 font.setLanguage(to);
3434 d->requestSpellCheck(i);
3440 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3442 Language const * doc_language = bparams.language;
3443 FontList::const_iterator cit = d->fontlist_.begin();
3444 FontList::const_iterator end = d->fontlist_.end();
3446 for (; cit != end; ++cit)
3447 if (cit->font().language() != ignore_language &&
3448 cit->font().language() != latex_language &&
3449 cit->font().language() != doc_language)
3455 void Paragraph::getLanguages(std::set<Language const *> & languages) const
3457 FontList::const_iterator cit = d->fontlist_.begin();
3458 FontList::const_iterator end = d->fontlist_.end();
3460 for (; cit != end; ++cit) {
3461 Language const * lang = cit->font().language();
3462 if (lang != ignore_language &&
3463 lang != latex_language)
3464 languages.insert(lang);
3469 docstring Paragraph::asString(int options) const
3471 return asString(0, size(), options);
3475 docstring Paragraph::asString(pos_type beg, pos_type end, int options, const OutputParams *runparams) const
3477 odocstringstream os;
3480 && options & AS_STR_LABEL
3481 && !d->params_.labelString().empty())
3482 os << d->params_.labelString() << ' ';
3484 for (pos_type i = beg; i < end; ++i) {
3485 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3487 char_type const c = d->text_[i];
3488 if (isPrintable(c) || c == '\t'
3489 || (c == '\n' && (options & AS_STR_NEWLINES)))
3491 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3492 if (c == META_INSET && (options & AS_STR_PLAINTEXT)) {
3493 LASSERT(runparams != 0, return docstring());
3494 getInset(i)->plaintext(os, *runparams);
3496 getInset(i)->toString(os);
3505 void Paragraph::forOutliner(docstring & os, size_t const maxlen,
3506 bool const shorten, bool const label) const
3508 size_t tmplen = shorten ? maxlen + 1 : maxlen;
3509 if (label && !labelString().empty())
3510 os += labelString() + ' ';
3511 for (pos_type i = 0; i < size() && os.length() < tmplen; ++i) {
3514 char_type const c = d->text_[i];
3517 else if (c == META_INSET)
3518 getInset(i)->forOutliner(os, tmplen, false);
3521 Text::shortenForOutliner(os, maxlen);
3525 void Paragraph::setInsetOwner(Inset const * inset)
3527 d->inset_owner_ = inset;
3531 int Paragraph::id() const
3537 void Paragraph::setId(int id)
3543 Layout const & Paragraph::layout() const
3549 void Paragraph::setLayout(Layout const & layout)
3551 d->layout_ = &layout;
3555 void Paragraph::setDefaultLayout(DocumentClass const & tc)
3557 setLayout(tc.defaultLayout());
3561 void Paragraph::setPlainLayout(DocumentClass const & tc)
3563 setLayout(tc.plainLayout());
3567 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
3569 if (usePlainLayout())
3570 setPlainLayout(tclass);
3572 setDefaultLayout(tclass);
3576 Inset const & Paragraph::inInset() const
3578 LBUFERR(d->inset_owner_);
3579 return *d->inset_owner_;
3583 ParagraphParameters & Paragraph::params()
3589 ParagraphParameters const & Paragraph::params() const
3595 bool Paragraph::isFreeSpacing() const
3597 if (d->layout_->free_spacing)
3599 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
3603 bool Paragraph::allowEmpty() const
3605 if (d->layout_->keepempty)
3607 return d->inset_owner_ && d->inset_owner_->allowEmpty();
3611 bool Paragraph::brokenBiblio() const
3613 // there is a problem if there is no bibitem at position 0 or
3614 // if there is another bibitem in the paragraph.
3615 return d->layout_->labeltype == LABEL_BIBLIO
3616 && (d->insetlist_.find(BIBITEM_CODE) != 0
3617 || d->insetlist_.find(BIBITEM_CODE, 1) > 0);
3621 int Paragraph::fixBiblio(Buffer const & buffer)
3623 // FIXME: What about the case where paragraph is not BIBLIO
3624 // but there is an InsetBibitem?
3625 // FIXME: when there was already an inset at 0, the return value is 1,
3626 // which does not tell whether another inset has been remove; the
3627 // cursor cannot be correctly updated.
3629 if (d->layout_->labeltype != LABEL_BIBLIO)
3632 bool const track_changes = buffer.params().track_changes;
3633 int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
3634 bool const hasbibitem0 = bibitem_pos == 0;
3637 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
3638 // There was an InsetBibitem at pos 0, and no other one => OK
3639 if (bibitem_pos == -1)
3641 // there is a bibitem at the 0 position, but since
3642 // there is a second one, we copy the second on the
3643 // first. We're assuming there are at most two of
3644 // these, which there should be.
3645 // FIXME: why does it make sense to do that rather
3646 // than keep the first? (JMarc)
3647 Inset * inset = releaseInset(bibitem_pos);
3648 d->insetlist_.begin()->inset = inset;
3649 return -bibitem_pos;
3652 // We need to create an inset at the beginning
3654 if (bibitem_pos > 0) {
3655 // there was one somewhere in the paragraph, let's move it
3656 inset = d->insetlist_.release(bibitem_pos);
3657 eraseChar(bibitem_pos, track_changes);
3660 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
3661 InsetCommandParams(BIBITEM_CODE));
3663 Font font(inherit_font, buffer.params().language);
3664 insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
3665 : Change::UNCHANGED));
3671 void Paragraph::checkAuthors(AuthorList const & authorList)
3673 d->changes_.checkAuthors(authorList);
3677 bool Paragraph::isChanged(pos_type pos) const
3679 return lookupChange(pos).changed();
3683 bool Paragraph::isInserted(pos_type pos) const
3685 return lookupChange(pos).inserted();
3689 bool Paragraph::isDeleted(pos_type pos) const
3691 return lookupChange(pos).deleted();
3695 InsetList const & Paragraph::insetList() const
3697 return d->insetlist_;
3701 void Paragraph::setInsetBuffers(Buffer & b)
3703 d->insetlist_.setBuffer(b);
3707 void Paragraph::resetBuffer()
3709 d->insetlist_.resetBuffer();
3713 Inset * Paragraph::releaseInset(pos_type pos)
3715 Inset * inset = d->insetlist_.release(pos);
3716 /// does not honour change tracking!
3717 eraseChar(pos, false);
3722 Inset * Paragraph::getInset(pos_type pos)
3724 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3725 ? d->insetlist_.get(pos) : 0;
3729 Inset const * Paragraph::getInset(pos_type pos) const
3731 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3732 ? d->insetlist_.get(pos) : 0;
3736 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
3737 pos_type & right, TextCase action)
3739 // process sequences of modified characters; in change
3740 // tracking mode, this approach results in much better
3741 // usability than changing case on a char-by-char basis
3742 // We also need to track the current font, since font
3743 // changes within sequences can occur.
3744 vector<pair<char_type, Font> > changes;
3746 bool const trackChanges = bparams.track_changes;
3748 bool capitalize = true;
3750 for (; pos < right; ++pos) {
3751 char_type oldChar = d->text_[pos];
3752 char_type newChar = oldChar;
3754 // ignore insets and don't play with deleted text!
3755 if (oldChar != META_INSET && !isDeleted(pos)) {
3757 case text_lowercase:
3758 newChar = lowercase(oldChar);
3760 case text_capitalization:
3762 newChar = uppercase(oldChar);
3766 case text_uppercase:
3767 newChar = uppercase(oldChar);
3772 if (isWordSeparator(pos) || isDeleted(pos)) {
3773 // permit capitalization again
3777 if (oldChar != newChar) {
3778 changes.push_back(make_pair(newChar, getFontSettings(bparams, pos)));
3779 if (pos != right - 1)
3781 // step behind the changing area
3785 int erasePos = pos - changes.size();
3786 for (size_t i = 0; i < changes.size(); i++) {
3787 insertChar(pos, changes[i].first,
3790 if (!eraseChar(erasePos, trackChanges)) {
3793 ++right; // expand selection
3801 int Paragraph::find(docstring const & str, bool cs, bool mw,
3802 pos_type start_pos, bool del) const
3804 pos_type pos = start_pos;
3805 int const strsize = str.length();
3807 pos_type const parsize = d->text_.size();
3808 for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
3809 // Ignore "invisible" letters such as ligature breaks
3810 // and hyphenation chars while searching
3811 while (pos < parsize - 1 && isInset(pos)) {
3812 odocstringstream os;
3813 getInset(pos)->toString(os);
3814 if (!getInset(pos)->isLetter() || !os.str().empty())
3818 if (cs && str[i] != d->text_[pos])
3820 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
3822 if (!del && isDeleted(pos))
3829 // if necessary, check whether string matches word
3831 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
3834 && !isWordSeparator(pos))
3838 return pos - start_pos;
3842 char_type Paragraph::getChar(pos_type pos) const
3844 return d->text_[pos];
3848 pos_type Paragraph::size() const
3850 return d->text_.size();
3854 bool Paragraph::empty() const
3856 return d->text_.empty();
3860 bool Paragraph::isInset(pos_type pos) const
3862 return d->text_[pos] == META_INSET;
3866 bool Paragraph::isSeparator(pos_type pos) const
3868 //FIXME: Are we sure this can be the only separator?
3869 return d->text_[pos] == ' ';
3873 void Paragraph::deregisterWords()
3875 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3876 Private::LangWordsMap::const_iterator ite = d->words_.end();
3877 for (; itl != ite; ++itl) {
3878 WordList & wl = theWordList(itl->first);
3879 Private::Words::const_iterator it = (itl->second).begin();
3880 Private::Words::const_iterator et = (itl->second).end();
3881 for (; it != et; ++it)
3888 void Paragraph::locateWord(pos_type & from, pos_type & to,
3889 word_location const loc) const
3892 case WHOLE_WORD_STRICT:
3893 if (from == 0 || from == size()
3894 || isWordSeparator(from)
3895 || isWordSeparator(from - 1)) {
3902 // If we are already at the beginning of a word, do nothing
3903 if (!from || isWordSeparator(from - 1))
3908 // always move the cursor to the beginning of previous word
3909 while (from && !isWordSeparator(from - 1))
3913 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
3916 // no need to move the 'from' cursor
3920 while (to < size() && !isWordSeparator(to))
3925 void Paragraph::collectWords()
3927 for (pos_type pos = 0; pos < size(); ++pos) {
3928 if (isWordSeparator(pos))
3930 pos_type from = pos;
3931 locateWord(from, pos, WHOLE_WORD);
3932 // Work around MSVC warning: The statement
3933 // if (pos < from + lyxrc.completion_minlength)
3934 // triggers a signed vs. unsigned warning.
3935 // I don't know why this happens, it could be a MSVC bug, or
3936 // related to LLP64 (windows) vs. LP64 (unix) programming
3937 // model, or the C++ standard might be ambigous in the section
3938 // defining the "usual arithmetic conversions". However, using
3939 // a temporary variable is safe and works on all compilers.
3940 pos_type const endpos = from + lyxrc.completion_minlength;
3943 FontList::const_iterator cit = d->fontlist_.fontIterator(from);
3944 if (cit == d->fontlist_.end())
3946 Language const * lang = cit->font().language();
3947 docstring const word = asString(from, pos, AS_STR_NONE);
3948 d->words_[lang->lang()].insert(word);
3953 void Paragraph::registerWords()
3955 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3956 Private::LangWordsMap::const_iterator ite = d->words_.end();
3957 for (; itl != ite; ++itl) {
3958 WordList & wl = theWordList(itl->first);
3959 Private::Words::const_iterator it = (itl->second).begin();
3960 Private::Words::const_iterator et = (itl->second).end();
3961 for (; it != et; ++it)
3967 void Paragraph::updateWords()
3975 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
3977 SkipPositionsIterator begin = skips.begin();
3978 SkipPositions::iterator end = skips.end();
3979 if (pos > 0 && begin < end) {
3981 if (end->last == pos - 1) {
3986 skips.insert(end, FontSpan(pos, pos));
3990 Language * Paragraph::Private::locateSpellRange(
3991 pos_type & from, pos_type & to,
3992 SkipPositions & skips) const
3994 // skip leading white space
3995 while (from < to && owner_->isWordSeparator(from))
3997 // don't check empty range
4000 // get current language
4001 Language * lang = getSpellLanguage(from);
4002 pos_type last = from;
4003 bool samelang = true;
4004 bool sameinset = true;
4005 while (last < to && samelang && sameinset) {
4006 // hop to end of word
4007 while (last < to && !owner_->isWordSeparator(last)) {
4008 if (owner_->getInset(last)) {
4009 appendSkipPosition(skips, last);
4010 } else if (owner_->isDeleted(last)) {
4011 appendSkipPosition(skips, last);
4015 // hop to next word while checking for insets
4016 while (sameinset && last < to && owner_->isWordSeparator(last)) {
4017 if (Inset const * inset = owner_->getInset(last))
4018 sameinset = inset->isChar() && inset->isLetter();
4019 if (sameinset && owner_->isDeleted(last)) {
4020 appendSkipPosition(skips, last);
4025 if (sameinset && last < to) {
4026 // now check for language change
4027 samelang = lang == getSpellLanguage(last);
4030 // if language change detected backstep is needed
4038 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
4041 const_cast<Language *>(owner_->getFontSettings(
4042 inset_owner_->buffer().params(), from).language());
4043 if (lang == inset_owner_->buffer().params().language
4044 && !lyxrc.spellchecker_alt_lang.empty()) {
4046 string const lang_variety =
4047 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
4048 lang->setCode(lang_code);
4049 lang->setVariety(lang_variety);
4055 void Paragraph::requestSpellCheck(pos_type pos)
4057 d->requestSpellCheck(pos);
4061 bool Paragraph::needsSpellCheck() const
4063 SpellChecker::ChangeNumber speller_change_number = 0;
4064 if (theSpellChecker())
4065 speller_change_number = theSpellChecker()->changeNumber();
4066 if (speller_change_number > d->speller_state_.currentChangeNumber()) {
4067 d->speller_state_.needsCompleteRefresh(speller_change_number);
4069 return d->needsSpellCheck();
4073 bool Paragraph::Private::ignoreWord(docstring const & word) const
4075 // Ignore words with digits
4076 // FIXME: make this customizable
4077 // (note that some checkers ignore words with digits by default)
4078 docstring::const_iterator cit = word.begin();
4079 docstring::const_iterator const end = word.end();
4080 for (; cit != end; ++cit) {
4081 if (isNumber((*cit)))
4088 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
4089 WordLangTuple & wl, docstring_list & suggestions,
4090 bool do_suggestion, bool check_learned) const
4092 SpellChecker::Result result = SpellChecker::WORD_OK;
4093 SpellChecker * speller = theSpellChecker();
4097 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
4100 locateWord(from, to, WHOLE_WORD);
4101 if (from == to || from >= size())
4104 docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4105 Language * lang = d->getSpellLanguage(from);
4107 wl = WordLangTuple(word, lang);
4112 if (needsSpellCheck() || check_learned) {
4114 if (!d->ignoreWord(word)) {
4115 bool const trailing_dot = to < size() && d->text_[to] == '.';
4116 result = speller->check(wl);
4117 if (SpellChecker::misspelled(result) && trailing_dot) {
4118 wl = WordLangTuple(word.append(from_ascii(".")), lang);
4119 result = speller->check(wl);
4120 if (!SpellChecker::misspelled(result)) {
4121 LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
4123 from << ".." << to << "]");
4125 // spell check with dot appended failed too
4126 // restore original word/lang value
4127 word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4128 wl = WordLangTuple(word, lang);
4132 if (!SpellChecker::misspelled(result)) {
4133 // area up to the begin of the next word is not misspelled
4134 while (end < size() && isWordSeparator(end))
4137 d->setMisspelled(from, end, result);
4139 result = d->speller_state_.getState(from);
4143 suggestions.clear();
4145 if (SpellChecker::misspelled(result)) {
4146 LYXERR(Debug::GUI, "misspelled word: \"" <<
4148 from << ".." << to << "]");
4150 speller->suggest(wl, suggestions);
4156 void Paragraph::Private::markMisspelledWords(
4157 pos_type const & first, pos_type const & last,
4158 SpellChecker::Result result,
4159 docstring const & word,
4160 SkipPositions const & skips)
4162 if (!SpellChecker::misspelled(result)) {
4163 setMisspelled(first, last, SpellChecker::WORD_OK);
4167 SpellChecker * speller = theSpellChecker();
4168 // locate and enumerate the error positions
4169 int nerrors = speller->numMisspelledWords();
4171 SkipPositionsIterator it = skips.begin();
4172 SkipPositionsIterator et = skips.end();
4173 for (int index = 0; index < nerrors; ++index) {
4176 speller->misspelledWord(index, wstart, wlen);
4177 /// should not happen if speller supports range checks
4178 if (!wlen) continue;
4179 docstring const misspelled = word.substr(wstart, wlen);
4180 wstart += first + numskipped;
4181 if (snext < wstart) {
4182 /// mark the range of correct spelling
4183 numskipped += countSkips(it, et, wstart);
4184 setMisspelled(snext,
4185 wstart - 1, SpellChecker::WORD_OK);
4187 snext = wstart + wlen;
4188 numskipped += countSkips(it, et, snext);
4189 /// mark the range of misspelling
4190 setMisspelled(wstart, snext, result);
4191 LYXERR(Debug::GUI, "misspelled word: \"" <<
4192 misspelled << "\" [" <<
4193 wstart << ".." << (snext-1) << "]");
4196 if (snext <= last) {
4197 /// mark the range of correct spelling at end
4198 setMisspelled(snext, last, SpellChecker::WORD_OK);
4203 void Paragraph::spellCheck() const
4205 SpellChecker * speller = theSpellChecker();
4206 if (!speller || empty() ||!needsSpellCheck())
4210 d->rangeOfSpellCheck(start, endpos);
4211 if (speller->canCheckParagraph()) {
4212 // loop until we leave the range
4213 for (pos_type first = start; first < endpos; ) {
4214 pos_type last = endpos;
4215 Private::SkipPositions skips;
4216 Language * lang = d->locateSpellRange(first, last, skips);
4217 if (first >= endpos)
4219 // start the spell checker on the unit of meaning
4220 docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
4221 WordLangTuple wl = WordLangTuple(word, lang);
4222 SpellChecker::Result result = word.size() ?
4223 speller->check(wl) : SpellChecker::WORD_OK;
4224 d->markMisspelledWords(first, last, result, word, skips);
4228 static docstring_list suggestions;
4229 pos_type to = endpos;
4230 while (start < endpos) {
4232 spellCheck(start, to, wl, suggestions, false);
4236 d->readySpellCheck();
4240 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
4242 bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
4243 if (result || pos <= 0 || pos > size())
4245 if (check_boundary && (pos == size() || isWordSeparator(pos)))
4246 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
4251 string Paragraph::magicLabel() const
4254 ss << "magicparlabel-" << id();