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 "TextClass.h"
46 #include "WordLangTuple.h"
49 #include "frontends/alert.h"
51 #include "insets/InsetBibitem.h"
52 #include "insets/InsetLabel.h"
53 #include "insets/InsetSpecialChar.h"
55 #include "support/debug.h"
56 #include "support/docstring_list.h"
57 #include "support/ExceptionMessage.h"
58 #include "support/gettext.h"
59 #include "support/lassert.h"
60 #include "support/lstrings.h"
61 #include "support/textutils.h"
67 using namespace lyx::support;
73 /// Inset identifier (above 0x10ffff, for ucs-4)
74 char_type const META_INSET = 0x200001;
79 /////////////////////////////////////////////////////////////////////
83 /////////////////////////////////////////////////////////////////////
85 class SpellResultRange {
87 SpellResultRange(FontSpan range, SpellChecker::Result result)
88 : range_(range), result_(result)
91 FontSpan const & range() const { return range_; }
93 void range(FontSpan const & r) { range_ = r; }
95 SpellChecker::Result result() const { return result_; }
97 void result(SpellChecker::Result r) { result_ = r; }
99 bool contains(pos_type pos) const { return range_.contains(pos); }
101 bool covered(FontSpan const & r) const
103 // 1. first of new range inside current range or
104 // 2. last of new range inside current range or
105 // 3. first of current range inside new range or
106 // 4. last of current range inside new range
107 //FIXME: is this the same as !range_.intersect(r).empty() ?
108 return range_.contains(r.first) || range_.contains(r.last) ||
109 r.contains(range_.first) || r.contains(range_.last);
112 void shift(pos_type pos, int offset)
114 if (range_.first > pos) {
115 range_.first += offset;
116 range_.last += offset;
117 } else if (range_.last >= pos) {
118 range_.last += offset;
123 SpellChecker::Result result_ ;
127 /////////////////////////////////////////////////////////////////////
131 /////////////////////////////////////////////////////////////////////
133 class SpellCheckerState {
137 needs_refresh_ = true;
138 current_change_number_ = 0;
141 void setRange(FontSpan const & fp, SpellChecker::Result state)
144 RangesIterator et = ranges_.end();
145 RangesIterator it = ranges_.begin();
146 for (; it != et; ++it) {
147 if (!it->covered(fp))
148 result.push_back(SpellResultRange(it->range(), it->result()));
149 else if (state == SpellChecker::WORD_OK) {
150 // trim or split the current misspelled range
151 // store misspelled ranges only
152 FontSpan range = it->range();
153 if (fp.first > range.first) {
154 // misspelled area in front of WORD_OK
155 range.last = fp.first - 1;
156 result.push_back(SpellResultRange(range, it->result()));
159 if (fp.last < range.last) {
160 // misspelled area after WORD_OK range
161 range.first = fp.last + 1;
162 result.push_back(SpellResultRange(range, it->result()));
167 if (state != SpellChecker::WORD_OK)
168 ranges_.push_back(SpellResultRange(fp, state));
171 void increasePosAfterPos(pos_type pos)
173 correctRangesAfterPos(pos, 1);
177 void decreasePosAfterPos(pos_type pos)
179 correctRangesAfterPos(pos, -1);
183 void refreshLast(pos_type pos)
185 if (pos < refresh_.last)
189 SpellChecker::Result getState(pos_type pos) const
191 SpellChecker::Result result = SpellChecker::WORD_OK;
192 RangesIterator et = ranges_.end();
193 RangesIterator it = ranges_.begin();
194 for (; it != et; ++it) {
195 if(it->contains(pos)) {
202 FontSpan const & getRange(pos_type pos) const
204 /// empty span to indicate mismatch
205 static FontSpan empty_;
206 RangesIterator et = ranges_.end();
207 RangesIterator it = ranges_.begin();
208 for (; it != et; ++it) {
209 if(it->contains(pos)) {
216 bool needsRefresh() const
218 return needs_refresh_;
221 SpellChecker::ChangeNumber currentChangeNumber() const
223 return current_change_number_;
226 void refreshRange(pos_type & first, pos_type & last) const
228 first = refresh_.first;
229 last = refresh_.last;
232 void needsRefresh(pos_type pos)
234 if (needs_refresh_ && pos != -1) {
235 if (pos < refresh_.first)
236 refresh_.first = pos;
237 if (pos > refresh_.last)
239 } else if (pos != -1) {
240 // init request check for neighbour positions too
241 refresh_.first = pos > 0 ? pos - 1 : 0;
242 // no need for special end of paragraph check
243 refresh_.last = pos + 1;
245 needs_refresh_ = pos != -1;
248 void needsCompleteRefresh(SpellChecker::ChangeNumber change_number)
250 needs_refresh_ = true;
253 current_change_number_ = change_number;
256 typedef vector<SpellResultRange> Ranges;
257 typedef Ranges::const_iterator RangesIterator;
259 /// the area of the paragraph with pending spell check
262 /// spell state cache version number
263 SpellChecker::ChangeNumber current_change_number_;
266 void correctRangesAfterPos(pos_type pos, int offset)
268 RangesIterator et = ranges_.end();
269 Ranges::iterator it = ranges_.begin();
270 for (; it != et; ++it) {
271 it->shift(pos, offset);
277 /////////////////////////////////////////////////////////////////////
279 // Paragraph::Private
281 /////////////////////////////////////////////////////////////////////
283 class Paragraph::Private
285 // Enforce our own "copy" constructor by declaring the standard one and
286 // the assignment operator private without implementing them.
287 Private(Private const &);
288 Private & operator=(Private const &);
291 Private(Paragraph * owner, Layout const & layout);
292 /// "Copy constructor"
293 Private(Private const &, Paragraph * owner);
294 /// Copy constructor from \p beg to \p end
295 Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
298 void insertChar(pos_type pos, char_type c, Change const & change);
300 /// Output the surrogate pair formed by \p c and \p next to \p os.
301 /// \return the number of characters written.
302 int latexSurrogatePair(otexstream & os, char_type c, char_type next,
303 OutputParams const &);
305 /// Output a space in appropriate formatting (or a surrogate pair
306 /// if the next character is a combining character).
307 /// \return whether a surrogate pair was output.
308 bool simpleTeXBlanks(OutputParams const &,
311 unsigned int & column,
313 Layout const & style);
315 /// Output consecutive unicode chars, belonging to the same script as
316 /// specified by the latex macro \p ltx, to \p os starting from \p i.
317 /// \return the number of characters written.
318 int writeScriptChars(otexstream & os, docstring const & ltx,
319 Change const &, Encoding const &, pos_type & i);
321 /// This could go to ParagraphParameters if we want to.
322 int startTeXParParams(BufferParams const &, otexstream &,
323 OutputParams const &) const;
325 /// This could go to ParagraphParameters if we want to.
326 bool endTeXParParams(BufferParams const &, otexstream &,
327 OutputParams const &) const;
330 void latexInset(BufferParams const &,
335 Font const & outerfont,
337 Change & running_change,
338 Layout const & style,
340 unsigned int & column);
343 void latexSpecialChar(
345 BufferParams const & bparams,
346 OutputParams const & runparams,
347 Font const & running_font,
348 Change const & running_change,
349 Layout const & style,
352 unsigned int & column);
359 unsigned int & column);
365 unsigned int & column);
368 void validate(LaTeXFeatures & features) const;
370 /// Checks if the paragraph contains only text and no inset or font change.
371 bool onlyText(Buffer const & buf, Font const & outerfont,
372 pos_type initial) const;
374 /// a vector of speller skip positions
375 typedef vector<FontSpan> SkipPositions;
376 typedef SkipPositions::const_iterator SkipPositionsIterator;
378 void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
380 Language * getSpellLanguage(pos_type const from) const;
382 Language * locateSpellRange(pos_type & from, pos_type & to,
383 SkipPositions & skips) const;
385 bool hasSpellerChange() const
387 SpellChecker::ChangeNumber speller_change_number = 0;
388 if (theSpellChecker())
389 speller_change_number = theSpellChecker()->changeNumber();
390 return speller_change_number > speller_state_.currentChangeNumber();
393 bool ignoreWord(docstring const & word) const ;
395 void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
397 pos_type textsize = owner_->size();
398 // check for sane arguments
399 if (to <= from || from >= textsize)
401 FontSpan fp = FontSpan(from, to - 1);
402 speller_state_.setRange(fp, state);
405 void requestSpellCheck(pos_type pos)
408 speller_state_.needsCompleteRefresh(speller_state_.currentChangeNumber());
410 speller_state_.needsRefresh(pos);
413 void readySpellCheck()
415 speller_state_.needsRefresh(-1);
418 bool needsSpellCheck() const
420 return speller_state_.needsRefresh();
423 void rangeOfSpellCheck(pos_type & first, pos_type & last) const
425 speller_state_.refreshRange(first, last);
427 last = owner_->size();
430 pos_type endpos = last;
431 owner_->locateWord(first, endpos, WHOLE_WORD);
434 owner_->locateWord(last, endpos, WHOLE_WORD);
439 int countSkips(SkipPositionsIterator & it, SkipPositionsIterator const et,
443 while (it != et && it->first < start) {
444 int skip = it->last - it->first + 1;
452 void markMisspelledWords(pos_type const & first, pos_type const & last,
453 SpellChecker::Result result,
454 docstring const & word,
455 SkipPositions const & skips);
457 InsetCode ownerCode() const
459 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
462 /// Which Paragraph owns us?
466 Inset const * inset_owner_;
475 ParagraphParameters params_;
477 /// for recording and looking up changes
481 InsetList insetlist_;
484 pos_type begin_of_body_;
486 typedef docstring TextContainer;
490 typedef set<docstring> Words;
491 typedef map<string, Words> LangWordsMap;
495 Layout const * layout_;
497 SpellCheckerState speller_state_;
501 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
502 : owner_(owner), inset_owner_(0), id_(-1), begin_of_body_(0), layout_(&layout)
508 // Initialization of the counter for the paragraph id's,
510 // FIXME: There should be a more intelligent way to generate and use the
511 // paragraph ids per buffer instead a global static counter for all InsetText
512 // in the running program.
513 // However, this per-session id is used in LFUN_PARAGRAPH_GOTO to
514 // switch to a different buffer, as used in the outliner for instance.
515 static int paragraph_id = -1;
517 Paragraph::Private::Private(Private const & p, Paragraph * owner)
518 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
519 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
520 begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
523 id_ = ++paragraph_id;
524 requestSpellCheck(p.text_.size());
528 Paragraph::Private::Private(Private const & p, Paragraph * owner,
529 pos_type beg, pos_type end)
530 : owner_(owner), inset_owner_(p.inset_owner_),
531 params_(p.params_), changes_(p.changes_),
532 insetlist_(p.insetlist_, beg, end),
533 begin_of_body_(p.begin_of_body_), words_(p.words_),
536 id_ = ++paragraph_id;
537 if (beg >= pos_type(p.text_.size()))
539 text_ = p.text_.substr(beg, end - beg);
541 FontList::const_iterator fcit = fontlist_.begin();
542 FontList::const_iterator fend = fontlist_.end();
543 for (; fcit != fend; ++fcit) {
544 if (fcit->pos() < beg)
546 if (fcit->pos() >= end) {
547 // Add last entry in the fontlist_.
548 fontlist_.set(text_.size() - 1, fcit->font());
551 // Add a new entry in the fontlist_.
552 fontlist_.set(fcit->pos() - beg, fcit->font());
554 requestSpellCheck(p.text_.size());
558 void Paragraph::addChangesToToc(DocIterator const & cdit,
559 Buffer const & buf, bool output_active) const
561 d->changes_.addToToc(cdit, buf, output_active);
565 bool Paragraph::isDeleted(pos_type start, pos_type end) const
567 LASSERT(start >= 0 && start <= size(), return false);
568 LASSERT(end > start && end <= size() + 1, return false);
570 return d->changes_.isDeleted(start, end);
574 bool Paragraph::isChanged(pos_type start, pos_type end) const
576 LASSERT(start >= 0 && start <= size(), return false);
577 LASSERT(end > start && end <= size() + 1, return false);
579 return d->changes_.isChanged(start, end);
583 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
585 // keep the logic here in sync with the logic of eraseChars()
589 Change const & change = d->changes_.lookup(size());
590 return change.inserted() && change.currentAuthor();
594 void Paragraph::setChange(Change const & change)
596 // beware of the imaginary end-of-par character!
597 d->changes_.set(change, 0, size() + 1);
600 * Propagate the change recursively - but not in case of DELETED!
602 * Imagine that your co-author makes changes in an existing inset. He
603 * sends your document to you and you come to the conclusion that the
604 * inset should go completely. If you erase it, LyX must not delete all
605 * text within the inset. Otherwise, the change tracked insertions of
606 * your co-author get lost and there is no way to restore them later.
608 * Conclusion: An inset's content should remain untouched if you delete it
611 if (!change.deleted()) {
612 for (pos_type pos = 0; pos < size(); ++pos) {
613 if (Inset * inset = getInset(pos))
614 inset->setChange(change);
620 void Paragraph::setChange(pos_type pos, Change const & change)
622 LASSERT(pos >= 0 && pos <= size(), return);
623 d->changes_.set(change, pos);
625 // see comment in setChange(Change const &) above
626 if (!change.deleted() && pos < size())
627 if (Inset * inset = getInset(pos))
628 inset->setChange(change);
632 Change const & Paragraph::lookupChange(pos_type pos) const
634 LBUFERR(pos >= 0 && pos <= size());
635 return d->changes_.lookup(pos);
639 void Paragraph::acceptChanges(pos_type start, pos_type end)
641 LASSERT(start >= 0 && start <= size(), return);
642 LASSERT(end > start && end <= size() + 1, return);
644 for (pos_type pos = start; pos < end; ++pos) {
645 switch (lookupChange(pos).type) {
646 case Change::UNCHANGED:
647 // accept changes in nested inset
648 if (Inset * inset = getInset(pos))
649 inset->acceptChanges();
652 case Change::INSERTED:
653 d->changes_.set(Change(Change::UNCHANGED), pos);
654 // also accept changes in nested inset
655 if (Inset * inset = getInset(pos))
656 inset->acceptChanges();
659 case Change::DELETED:
660 // Suppress access to non-existent
661 // "end-of-paragraph char"
663 eraseChar(pos, false);
674 void Paragraph::rejectChanges(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 // reject changes in nested inset
683 if (Inset * inset = getInset(pos))
684 inset->rejectChanges();
687 case Change::INSERTED:
688 // Suppress access to non-existent
689 // "end-of-paragraph char"
691 eraseChar(pos, false);
697 case Change::DELETED:
698 d->changes_.set(Change(Change::UNCHANGED), pos);
700 // Do NOT reject changes within a deleted inset!
701 // There may be insertions of a co-author inside of it!
709 void Paragraph::Private::insertChar(pos_type pos, char_type c,
710 Change const & change)
712 LASSERT(pos >= 0 && pos <= int(text_.size()), return);
715 changes_.insert(change, pos);
717 // This is actually very common when parsing buffers (and
718 // maybe inserting ascii text)
719 if (pos == pos_type(text_.size())) {
720 // when appending characters, no need to update tables
722 // but we want spell checking
723 requestSpellCheck(pos);
727 text_.insert(text_.begin() + pos, c);
729 // Update the font table.
730 fontlist_.increasePosAfterPos(pos);
733 insetlist_.increasePosAfterPos(pos);
735 // Update list of misspelled positions
736 speller_state_.increasePosAfterPos(pos);
740 bool Paragraph::insertInset(pos_type pos, Inset * inset,
741 Font const & font, Change const & change)
743 LASSERT(inset, return false);
744 LASSERT(pos >= 0 && pos <= size(), return false);
746 // Paragraph::insertInset() can be used in cut/copy/paste operation where
747 // d->inset_owner_ is not set yet.
748 if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
751 d->insertChar(pos, META_INSET, change);
752 LASSERT(d->text_[pos] == META_INSET, return false);
754 // Add a new entry in the insetlist_.
755 d->insetlist_.insert(inset, pos);
757 // Some insets require run of spell checker
758 requestSpellCheck(pos);
764 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
766 LASSERT(pos >= 0 && pos <= size(), return false);
768 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
771 Change change = d->changes_.lookup(pos);
773 // set the character to DELETED if
774 // a) it was previously unchanged or
775 // b) it was inserted by a co-author
777 if (!change.changed() ||
778 (change.inserted() && !change.currentAuthor())) {
779 setChange(pos, Change(Change::DELETED));
780 // request run of spell checker
781 requestSpellCheck(pos);
785 if (change.deleted())
789 // Don't physically access the imaginary end-of-paragraph character.
790 // eraseChar() can only mark it as DELETED. A physical deletion of
791 // end-of-par must be handled externally.
797 d->changes_.erase(pos);
799 // if it is an inset, delete the inset entry
800 if (d->text_[pos] == META_INSET)
801 d->insetlist_.erase(pos);
803 d->text_.erase(d->text_.begin() + pos);
805 // Update the fontlist_
806 d->fontlist_.erase(pos);
808 // Update the insetlist_
809 d->insetlist_.decreasePosAfterPos(pos);
811 // Update list of misspelled positions
812 d->speller_state_.decreasePosAfterPos(pos);
813 d->speller_state_.refreshLast(size());
819 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
821 LASSERT(start >= 0 && start <= size(), return 0);
822 LASSERT(end >= start && end <= size() + 1, return 0);
825 for (pos_type count = end - start; count; --count) {
826 if (!eraseChar(i, trackChanges))
833 int Paragraph::Private::latexSurrogatePair(otexstream & os, char_type c,
834 char_type next, OutputParams const & runparams)
836 // Writing next here may circumvent a possible font change between
837 // c and next. Since next is only output if it forms a surrogate pair
838 // with c we can ignore this:
839 // A font change inside a surrogate pair does not make sense and is
840 // hopefully impossible to input.
841 // FIXME: change tracking
842 // Is this correct WRT change tracking?
843 Encoding const & encoding = *(runparams.encoding);
844 docstring latex1 = encoding.latexChar(next).first;
845 if (runparams.inIPA) {
846 string const tipashortcut = Encodings::TIPAShortcut(next);
847 if (!tipashortcut.empty()) {
848 latex1 = from_ascii(tipashortcut);
851 docstring const latex2 = encoding.latexChar(c).first;
852 if (docstring(1, next) == latex1) {
853 // the encoding supports the combination
854 os << latex2 << latex1;
855 return latex1.length() + latex2.length();
856 } else if (runparams.local_font &&
857 runparams.local_font->language()->lang() == "polutonikogreek") {
858 // polutonikogreek only works without the brackets
859 os << latex1 << latex2;
860 return latex1.length() + latex2.length();
862 os << latex1 << '{' << latex2 << '}';
863 return latex1.length() + latex2.length() + 2;
867 bool Paragraph::Private::simpleTeXBlanks(OutputParams const & runparams,
870 unsigned int & column,
872 Layout const & style)
874 if (style.pass_thru || runparams.pass_thru)
877 if (i + 1 < int(text_.size())) {
878 char_type next = text_[i + 1];
879 if (Encodings::isCombiningChar(next)) {
880 // This space has an accent, so we must always output it.
881 column += latexSurrogatePair(os, ' ', next, runparams) - 1;
886 if (runparams.linelen > 0
887 && column > runparams.linelen
889 && text_[i - 1] != ' '
890 && (i + 1 < int(text_.size()))
891 // same in FreeSpacing mode
892 && !owner_->isFreeSpacing()
893 // In typewriter mode, we want to avoid
894 // ! . ? : at the end of a line
895 && !(font.fontInfo().family() == TYPEWRITER_FAMILY
896 && (text_[i - 1] == '.'
897 || text_[i - 1] == '?'
898 || text_[i - 1] == ':'
899 || text_[i - 1] == '!'))) {
901 os.texrow().start(owner_->id(), i + 1);
903 } else if (style.free_spacing) {
912 int Paragraph::Private::writeScriptChars(otexstream & os,
913 docstring const & ltx,
914 Change const & runningChange,
915 Encoding const & encoding,
918 // FIXME: modifying i here is not very nice...
920 // We only arrive here when character text_[i] could not be translated
921 // into the current latex encoding (or its latex translation has been forced,)
922 // and it belongs to a known script.
923 // TODO: We need \textcyr and \textgreek wrappers also for characters
924 // that can be encoded in the "LaTeX encoding" but not in the
925 // current *font encoding*.
926 // (See #9681 for details and test)
927 // Parameter ltx contains the latex translation of text_[i] as specified
928 // in the unicodesymbols file and is something like "\textXXX{<spec>}".
929 // The latex macro name "textXXX" specifies the script to which text_[i]
930 // belongs and we use it in order to check whether characters from the
931 // same script immediately follow, such that we can collect them in a
932 // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
933 // for the first char but only "<spec>" for all subsequent chars.
934 docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
935 docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
936 string script = to_ascii(ltx.substr(1, brace1 - 1));
939 bool closing_brace = true;
940 if (script == "textgreek" && encoding.latexName() == "iso-8859-7") {
941 // Correct encoding is being used, so we can avoid \textgreek.
942 // TODO: wrong test: we need to check the *font encoding*
943 // (i.e. the active language and its FontEncoding tag)
944 // instead of the LaTeX *input encoding*!
945 // See #9637 for details and test-cases.
948 closing_brace = false;
950 os << ltx.substr(pos, length);
951 int size = text_.size();
952 while (i + 1 < size) {
953 char_type const next = text_[i + 1];
954 // Stop here if next character belongs to another script
955 // or there is a change in change tracking status.
956 if (!Encodings::isKnownScriptChar(next, script) ||
957 runningChange != owner_->lookupChange(i + 1))
961 FontList::const_iterator cit = fontlist_.begin();
962 FontList::const_iterator end = fontlist_.end();
963 for (; cit != end; ++cit) {
964 if (cit->pos() >= i && !found) {
965 prev_font = cit->font();
968 if (cit->pos() >= i + 1)
971 // Stop here if there is a font attribute or encoding change.
972 if (found && cit != end && prev_font != cit->font())
974 docstring const latex = encoding.latexChar(next).first;
975 docstring::size_type const b1 =
976 latex.find_first_of(from_ascii("{"));
977 docstring::size_type const b2 =
978 latex.find_last_of(from_ascii("}"));
979 int const len = b2 - b1 - 1;
980 os << latex.substr(b1 + 1, len);
992 void Paragraph::Private::latexInset(BufferParams const & bparams,
994 OutputParams & runparams,
997 Font const & outerfont,
999 Change & running_change,
1000 Layout const & style,
1002 unsigned int & column)
1004 Inset * inset = owner_->getInset(i);
1007 if (style.pass_thru) {
1008 odocstringstream ods;
1009 inset->plaintext(ods, runparams);
1014 // FIXME: move this to InsetNewline::latex
1015 if (inset->lyxCode() == NEWLINE_CODE || inset->lyxCode() == SEPARATOR_CODE) {
1016 // newlines are handled differently here than
1017 // the default in simpleTeXSpecialChars().
1018 if (!style.newline_allowed) {
1022 column += running_font.latexWriteEndChanges(
1023 os, bparams, runparams,
1024 basefont, basefont);
1028 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
1031 basefont = owner_->getLayoutFont(bparams, outerfont);
1032 running_font = basefont;
1034 if (runparams.moving_arg)
1038 os.texrow().start(owner_->id(), i + 1);
1042 if (owner_->isDeleted(i)) {
1043 if( ++runparams.inDeletedInset == 1)
1044 runparams.changeOfDeletedInset = owner_->lookupChange(i);
1047 if (inset->canTrackChanges()) {
1048 column += Changes::latexMarkChange(os, bparams, running_change,
1049 Change(Change::UNCHANGED), runparams);
1050 running_change = Change(Change::UNCHANGED);
1054 odocstream::pos_type const len = os.os().tellp();
1056 if (inset->forceLTR()
1057 && !runparams.use_polyglossia
1058 && running_font.isRightToLeft()
1059 // ERT is an exception, it should be output with no
1060 // decorations at all
1061 && inset->lyxCode() != ERT_CODE) {
1062 if (running_font.language()->lang() == "farsi")
1069 // FIXME: Bug: we can have an empty font change here!
1070 // if there has just been a font change, we are going to close it
1071 // right now, which means stupid latex code like \textsf{}. AFAIK,
1072 // this does not harm dvi output. A minor bug, thus (JMarc)
1074 // Some insets cannot be inside a font change command.
1075 // However, even such insets *can* be placed in \L or \R
1076 // or their equivalents (for RTL language switches), so we don't
1077 // close the language in those cases.
1078 // ArabTeX, though, cannot handle this special behavior, it seems.
1079 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
1080 || running_font.language()->lang() == "arabic_arabtex";
1081 if (open_font && !inset->inheritFont()) {
1082 bool closeLanguage = arabtex
1083 || basefont.isRightToLeft() == running_font.isRightToLeft();
1084 unsigned int count = running_font.latexWriteEndChanges(os,
1085 bparams, runparams, basefont, basefont, closeLanguage);
1087 // if any font properties were closed, update the running_font,
1088 // making sure, however, to leave the language as it was
1090 // FIXME: probably a better way to keep track of the old
1091 // language, than copying the entire font?
1092 Font const copy_font(running_font);
1093 basefont = owner_->getLayoutFont(bparams, outerfont);
1094 running_font = basefont;
1096 running_font.setLanguage(copy_font.language());
1097 // leave font open if language is still open
1098 open_font = (running_font.language() == basefont.language());
1100 runparams.local_font = &basefont;
1104 int prev_rows = os.texrow().rows();
1107 runparams.lastid = id_;
1108 runparams.lastpos = i;
1109 inset->latex(os, runparams);
1110 } catch (EncodingException & e) {
1111 // add location information and throw again.
1118 if (running_font.language()->lang() == "farsi")
1124 if (os.texrow().rows() > prev_rows) {
1125 os.texrow().start(owner_->id(), i + 1);
1128 column += (unsigned int)(os.os().tellp() - len);
1131 if (owner_->isDeleted(i))
1132 --runparams.inDeletedInset;
1136 void Paragraph::Private::latexSpecialChar(otexstream & os,
1137 BufferParams const & bparams,
1138 OutputParams const & runparams,
1139 Font const & running_font,
1140 Change const & running_change,
1141 Layout const & style,
1144 unsigned int & column)
1146 // With polyglossia, brackets and stuff need not be reversed
1147 // in RTL scripts (see bug #8251)
1148 char_type const c = (runparams.use_polyglossia) ?
1149 owner_->getUChar(bparams, i) : text_[i];
1151 if (style.pass_thru || runparams.pass_thru
1152 || contains(style.pass_thru_chars, c)
1153 || contains(runparams.pass_thru_chars, c)) {
1155 Encoding const * const enc = runparams.encoding;
1156 if (enc && !enc->encodable(c))
1157 throw EncodingException(c);
1163 // TIPA uses its own T3 encoding
1164 if (runparams.inIPA && latexSpecialT3(c, os, i, column))
1166 // If T1 font encoding is used, use the special
1167 // characters it provides.
1168 // NOTE: Some languages reset the font encoding internally to a
1169 // non-standard font encoding. If we are using such a language,
1170 // we do not output special T1 chars.
1171 if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1172 && bparams.font_encoding() == "T1" && latexSpecialT1(c, os, i, column))
1175 // Otherwise, we use what LaTeX provides us.
1178 os << "\\textbackslash{}";
1182 os << "\\textless{}";
1186 os << "\\textgreater{}";
1190 os << "\\textbar{}";
1195 if (i + 1 < static_cast<pos_type>(text_.size()) &&
1196 (end_pos == -1 || i + 1 < end_pos) &&
1197 text_[i+1] == '-') {
1198 // Prevent "--" becoming an endash and "---" becoming
1200 // Within \ttfamily, "--" is merged to "-" (no endash)
1201 // so we avoid this rather irritating ligature as well
1207 os << "\\char`\\\"{}";
1212 case '%': case '#': case '{':
1220 os << "\\textasciitilde{}";
1225 os << "\\textasciicircum{}";
1232 // avoid being mistaken for optional arguments
1240 // Blanks are printed before font switching.
1241 // Sure? I am not! (try nice-latex)
1242 // I am sure it's correct. LyX might be smarter
1243 // in the future, but for now, nothing wrong is
1251 Encoding const & encoding = *(runparams.encoding);
1252 char_type next = '\0';
1253 if (i + 1 < int(text_.size())) {
1254 next = text_[i + 1];
1255 if (Encodings::isCombiningChar(next)) {
1256 column += latexSurrogatePair(os, c, next, runparams) - 1;
1262 pair<docstring, bool> latex = encoding.latexChar(c);
1263 docstring nextlatex;
1264 bool nexttipas = false;
1265 string nexttipashortcut;
1266 if (next != '\0' && next != META_INSET && encoding.encodable(next)) {
1267 nextlatex = encoding.latexChar(next).first;
1268 if (runparams.inIPA) {
1269 nexttipashortcut = Encodings::TIPAShortcut(next);
1270 nexttipas = !nexttipashortcut.empty();
1274 if (runparams.inIPA) {
1275 string const tipashortcut = Encodings::TIPAShortcut(c);
1276 if (!tipashortcut.empty()) {
1277 latex.first = from_ascii(tipashortcut);
1278 latex.second = false;
1282 if (Encodings::isKnownScriptChar(c, script)
1283 && prefixIs(latex.first, from_ascii("\\" + script)))
1284 column += writeScriptChars(os, latex.first,
1285 running_change, encoding, i) - 1;
1286 else if (latex.second
1287 && ((!prefixIs(nextlatex, '\\')
1288 && !prefixIs(nextlatex, '{')
1289 && !prefixIs(nextlatex, '}'))
1291 && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1293 // Prevent eating of a following
1294 // space or command corruption by
1295 // following characters
1296 if (next == ' ' || next == '\0') {
1297 column += latex.first.length() + 1;
1298 os << latex.first << "{}";
1300 column += latex.first.length();
1301 os << latex.first << " ";
1304 column += latex.first.length() - 1;
1312 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1313 pos_type i, unsigned int & column)
1319 // In T1 encoding, these characters exist
1320 // but we should avoid ligatures
1321 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1323 os << "\\textcompwordmark{}";
1330 // soul.sty breaks with \char`\"
1331 os << "\\textquotedbl{}";
1340 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1341 pos_type /*i*/, unsigned int & column)
1351 os << "\\textvertline{}";
1360 void Paragraph::Private::validate(LaTeXFeatures & features) const
1362 if (layout_->inpreamble && inset_owner_) {
1363 bool const is_command = layout_->latextype == LATEX_COMMAND;
1364 Buffer const & buf = inset_owner_->buffer();
1365 BufferParams const & bp = features.runparams().is_child
1366 ? buf.masterParams() : buf.params();
1369 // Using a string stream here circumvents the encoding
1370 // switching machinery of odocstream. Therefore the
1371 // output is wrong if this paragraph contains content
1372 // that needs to switch encoding.
1373 odocstringstream ods;
1374 otexstream os(ods, texrow);
1376 os << '\\' << from_ascii(layout_->latexname());
1377 // we have to provide all the optional arguments here, even though
1378 // the last one is the only one we care about.
1379 // Separate handling of optional argument inset.
1380 if (!layout_->latexargs().empty()) {
1381 OutputParams rp = features.runparams();
1382 rp.local_font = &owner_->getFirstFontSettings(bp);
1383 latexArgInsets(*owner_, os, rp, layout_->latexargs());
1385 os << from_ascii(layout_->latexparam());
1387 docstring::size_type const length = ods.str().length();
1388 // this will output "{" at the beginning, but not at the end
1389 owner_->latex(bp, f, os, features.runparams(), 0, -1, true);
1390 if (ods.str().length() > length) {
1393 if (!layout_->postcommandargs().empty()) {
1394 OutputParams rp = features.runparams();
1395 rp.local_font = &owner_->getFirstFontSettings(bp);
1396 latexArgInsets(*owner_, os, rp, layout_->postcommandargs(), "post:");
1399 string const snippet = to_utf8(ods.str());
1400 features.addPreambleSnippet(snippet, true);
1404 if (features.runparams().flavor == OutputParams::HTML
1405 && layout_->htmltitle()) {
1406 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1409 // check the params.
1410 if (!params_.spacing().isDefault())
1411 features.require("setspace");
1414 features.useLayout(layout_->name());
1417 fontlist_.validate(features);
1419 // then the indentation
1420 if (!params_.leftIndent().zero())
1421 features.require("ParagraphLeftIndent");
1424 InsetList::const_iterator icit = insetlist_.begin();
1425 InsetList::const_iterator iend = insetlist_.end();
1426 for (; icit != iend; ++icit) {
1428 icit->inset->validate(features);
1429 if (layout_->needprotect &&
1430 icit->inset->lyxCode() == FOOT_CODE)
1431 features.require("NeedLyXFootnoteCode");
1435 // then the contents
1436 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1437 BufferEncodings::validate(text_[i], features);
1441 /////////////////////////////////////////////////////////////////////
1445 /////////////////////////////////////////////////////////////////////
1448 Layout const emptyParagraphLayout;
1451 Paragraph::Paragraph()
1452 : d(new Paragraph::Private(this, emptyParagraphLayout))
1459 Paragraph::Paragraph(Paragraph const & par)
1460 : itemdepth(par.itemdepth),
1461 d(new Paragraph::Private(*par.d, this))
1467 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1468 : itemdepth(par.itemdepth),
1469 d(new Paragraph::Private(*par.d, this, beg, end))
1475 Paragraph & Paragraph::operator=(Paragraph const & par)
1477 // needed as we will destroy the private part before copying it
1479 itemdepth = par.itemdepth;
1483 d = new Private(*par.d, this);
1490 Paragraph::~Paragraph()
1499 // this shall be called just before every "os << ..." action.
1500 void flushString(ostream & os, docstring & s)
1509 void Paragraph::write(ostream & os, BufferParams const & bparams,
1510 depth_type & dth) const
1512 // The beginning or end of a deeper (i.e. nested) area?
1513 if (dth != d->params_.depth()) {
1514 if (d->params_.depth() > dth) {
1515 while (d->params_.depth() > dth) {
1516 os << "\n\\begin_deeper";
1520 while (d->params_.depth() < dth) {
1521 os << "\n\\end_deeper";
1527 // First write the layout
1528 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1530 d->params_.write(os);
1532 Font font1(inherit_font, bparams.language);
1534 Change running_change = Change(Change::UNCHANGED);
1536 // this string is used as a buffer to avoid repetitive calls
1537 // to to_utf8(), which turn out to be expensive (JMarc)
1538 docstring write_buffer;
1541 for (pos_type i = 0; i <= size(); ++i) {
1543 Change const & change = lookupChange(i);
1544 if (change != running_change)
1545 flushString(os, write_buffer);
1546 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1547 running_change = change;
1552 // Write font changes
1553 Font font2 = getFontSettings(bparams, i);
1554 if (font2 != font1) {
1555 flushString(os, write_buffer);
1556 font2.lyxWriteChanges(font1, os);
1561 char_type const c = d->text_[i];
1564 if (Inset const * inset = getInset(i)) {
1565 flushString(os, write_buffer);
1566 if (inset->directWrite()) {
1567 // international char, let it write
1568 // code directly so it's shorter in
1574 os << "\\begin_inset ";
1576 os << "\n\\end_inset\n\n";
1579 // FIXME This can be removed again once the mystery
1580 // crash has been resolved.
1585 flushString(os, write_buffer);
1586 os << "\n\\backslash\n";
1590 flushString(os, write_buffer);
1591 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1598 if ((column > 70 && c == ' ')
1600 flushString(os, write_buffer);
1604 // this check is to amend a bug. LyX sometimes
1605 // inserts '\0' this could cause problems.
1607 write_buffer.push_back(c);
1609 LYXERR0("NUL char in structure.");
1615 flushString(os, write_buffer);
1616 os << "\n\\end_layout\n";
1617 // FIXME This can be removed again once the mystery
1618 // crash has been resolved.
1623 void Paragraph::validate(LaTeXFeatures & features) const
1625 d->validate(features);
1629 void Paragraph::insert(pos_type start, docstring const & str,
1630 Font const & font, Change const & change)
1632 for (size_t i = 0, n = str.size(); i != n ; ++i)
1633 insertChar(start + i, str[i], font, change);
1637 void Paragraph::appendChar(char_type c, Font const & font,
1638 Change const & change)
1641 d->changes_.insert(change, d->text_.size());
1642 // when appending characters, no need to update tables
1643 d->text_.push_back(c);
1644 setFont(d->text_.size() - 1, font);
1645 d->requestSpellCheck(d->text_.size() - 1);
1649 void Paragraph::appendString(docstring const & s, Font const & font,
1650 Change const & change)
1652 pos_type end = s.size();
1653 size_t oldsize = d->text_.size();
1654 size_t newsize = oldsize + end;
1655 size_t capacity = d->text_.capacity();
1656 if (newsize >= capacity)
1657 d->text_.reserve(max(capacity + 100, newsize));
1659 // when appending characters, no need to update tables
1662 // FIXME: Optimize this!
1663 for (size_t i = oldsize; i != newsize; ++i) {
1665 d->changes_.insert(change, i);
1666 d->requestSpellCheck(i);
1668 d->fontlist_.set(oldsize, font);
1669 d->fontlist_.set(newsize - 1, font);
1673 void Paragraph::insertChar(pos_type pos, char_type c,
1676 d->insertChar(pos, c, Change(trackChanges ?
1677 Change::INSERTED : Change::UNCHANGED));
1681 void Paragraph::insertChar(pos_type pos, char_type c,
1682 Font const & font, bool trackChanges)
1684 d->insertChar(pos, c, Change(trackChanges ?
1685 Change::INSERTED : Change::UNCHANGED));
1690 void Paragraph::insertChar(pos_type pos, char_type c,
1691 Font const & font, Change const & change)
1693 d->insertChar(pos, c, change);
1698 void Paragraph::resetFonts(Font const & font)
1700 d->fontlist_.clear();
1701 d->fontlist_.set(0, font);
1702 d->fontlist_.set(d->text_.size() - 1, font);
1705 // Gets uninstantiated font setting at position.
1706 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1710 LYXERR0("pos: " << pos << " size: " << size());
1714 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1715 if (cit != d->fontlist_.end())
1718 if (pos == size() && !empty())
1719 return getFontSettings(bparams, pos - 1);
1721 // Optimisation: avoid a full font instantiation if there is no
1722 // language change from previous call.
1723 static Font previous_font;
1724 static Language const * previous_lang = 0;
1725 Language const * lang = getParLanguage(bparams);
1726 if (lang != previous_lang) {
1727 previous_lang = lang;
1728 previous_font = Font(inherit_font, lang);
1730 return previous_font;
1734 FontSpan Paragraph::fontSpan(pos_type pos) const
1736 LBUFERR(pos <= size());
1739 return FontSpan(pos, pos);
1742 FontList::const_iterator cit = d->fontlist_.begin();
1743 FontList::const_iterator end = d->fontlist_.end();
1744 for (; cit != end; ++cit) {
1745 if (cit->pos() >= pos) {
1746 if (pos >= beginOfBody())
1747 return FontSpan(max(start, beginOfBody()),
1750 return FontSpan(start,
1751 min(beginOfBody() - 1,
1754 start = cit->pos() + 1;
1757 // This should not happen, but if so, we take no chances.
1758 LYXERR0("Paragraph::fontSpan: position not found in fontinfo table!");
1759 LASSERT(false, return FontSpan(pos, pos));
1763 // Gets uninstantiated font setting at position 0
1764 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1766 if (!empty() && !d->fontlist_.empty())
1767 return d->fontlist_.begin()->font();
1769 // Optimisation: avoid a full font instantiation if there is no
1770 // language change from previous call.
1771 static Font previous_font;
1772 static Language const * previous_lang = 0;
1773 if (bparams.language != previous_lang) {
1774 previous_lang = bparams.language;
1775 previous_font = Font(inherit_font, bparams.language);
1778 return previous_font;
1782 // Gets the fully instantiated font at a given position in a paragraph
1783 // This is basically the same function as Text::GetFont() in text2.cpp.
1784 // The difference is that this one is used for generating the LaTeX file,
1785 // and thus cosmetic "improvements" are disallowed: This has to deliver
1786 // the true picture of the buffer. (Asger)
1787 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1788 Font const & outerfont) const
1792 Font font = getFontSettings(bparams, pos);
1794 pos_type const body_pos = beginOfBody();
1795 FontInfo & fi = font.fontInfo();
1797 fi.realize(d->layout_->labelfont);
1799 fi.realize(d->layout_->font);
1801 fi.realize(outerfont.fontInfo());
1802 fi.realize(bparams.getFont().fontInfo());
1808 Font const Paragraph::getLabelFont
1809 (BufferParams const & bparams, Font const & outerfont) const
1811 FontInfo tmpfont = d->layout_->labelfont;
1812 tmpfont.realize(outerfont.fontInfo());
1813 tmpfont.realize(bparams.getFont().fontInfo());
1814 return Font(tmpfont, getParLanguage(bparams));
1818 Font const Paragraph::getLayoutFont
1819 (BufferParams const & bparams, Font const & outerfont) const
1821 FontInfo tmpfont = d->layout_->font;
1822 tmpfont.realize(outerfont.fontInfo());
1823 tmpfont.realize(bparams.getFont().fontInfo());
1824 return Font(tmpfont, getParLanguage(bparams));
1828 /// Returns the height of the highest font in range
1829 FontSize Paragraph::highestFontInRange
1830 (pos_type startpos, pos_type endpos, FontSize def_size) const
1832 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1836 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1838 char_type c = d->text_[pos];
1839 if (!getFontSettings(bparams, pos).isRightToLeft())
1842 // FIXME: The arabic special casing is due to the difference of arabic
1843 // round brackets input introduced in r18599. Check if this should be
1844 // unified with Hebrew or at least if all bracket types should be
1845 // handled the same (file format change in either case).
1846 string const & lang = getFontSettings(bparams, pos).language()->lang();
1847 bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi"
1852 uc = arabic ? c : ')';
1855 uc = arabic ? c : '(';
1881 void Paragraph::setFont(pos_type pos, Font const & font)
1883 LASSERT(pos <= size(), return);
1885 // First, reduce font against layout/label font
1886 // Update: The setCharFont() routine in text2.cpp already
1887 // reduces font, so we don't need to do that here. (Asger)
1889 d->fontlist_.set(pos, font);
1893 void Paragraph::makeSameLayout(Paragraph const & par)
1895 d->layout_ = par.d->layout_;
1896 d->params_ = par.d->params_;
1900 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1902 if (isFreeSpacing())
1908 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1909 if (eraseChar(pos, trackChanges))
1915 return count > 0 || pos > 0;
1919 bool Paragraph::hasSameLayout(Paragraph const & par) const
1921 return par.d->layout_ == d->layout_
1922 && d->params_.sameLayout(par.d->params_);
1926 depth_type Paragraph::getDepth() const
1928 return d->params_.depth();
1932 depth_type Paragraph::getMaxDepthAfter() const
1934 if (d->layout_->isEnvironment())
1935 return d->params_.depth() + 1;
1937 return d->params_.depth();
1941 char Paragraph::getAlign() const
1943 if (d->params_.align() == LYX_ALIGN_LAYOUT)
1944 return d->layout_->align;
1946 return d->params_.align();
1950 docstring const & Paragraph::labelString() const
1952 return d->params_.labelString();
1956 // the next two functions are for the manual labels
1957 docstring const Paragraph::getLabelWidthString() const
1959 if (d->layout_->margintype == MARGIN_MANUAL
1960 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
1961 return d->params_.labelWidthString();
1963 return _("Senseless with this layout!");
1967 void Paragraph::setLabelWidthString(docstring const & s)
1969 d->params_.labelWidthString(s);
1973 docstring Paragraph::expandLabel(Layout const & layout,
1974 BufferParams const & bparams) const
1976 return expandParagraphLabel(layout, bparams, true);
1980 docstring Paragraph::expandDocBookLabel(Layout const & layout,
1981 BufferParams const & bparams) const
1983 return expandParagraphLabel(layout, bparams, false);
1987 docstring Paragraph::expandParagraphLabel(Layout const & layout,
1988 BufferParams const & bparams, bool process_appendix) const
1990 DocumentClass const & tclass = bparams.documentClass();
1991 string const & lang = getParLanguage(bparams)->code();
1992 bool const in_appendix = process_appendix && d->params_.appendix();
1993 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
1995 if (fmt.empty() && !layout.counter.empty())
1996 return tclass.counters().theCounter(layout.counter, lang);
1998 // handle 'inherited level parts' in 'fmt',
1999 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
2000 size_t const i = fmt.find('@', 0);
2001 if (i != docstring::npos) {
2002 size_t const j = fmt.find('@', i + 1);
2003 if (j != docstring::npos) {
2004 docstring parent(fmt, i + 1, j - i - 1);
2005 docstring label = from_ascii("??");
2006 if (tclass.hasLayout(parent))
2007 label = expandParagraphLabel(tclass[parent], bparams,
2009 fmt = docstring(fmt, 0, i) + label
2010 + docstring(fmt, j + 1, docstring::npos);
2014 return tclass.counters().counterLabel(fmt, lang);
2018 void Paragraph::applyLayout(Layout const & new_layout)
2020 d->layout_ = &new_layout;
2021 LyXAlignment const oldAlign = d->params_.align();
2023 if (!(oldAlign & d->layout_->alignpossible)) {
2024 frontend::Alert::warning(_("Alignment not permitted"),
2025 _("The new layout does not permit the alignment previously used.\nSetting to default."));
2026 d->params_.align(LYX_ALIGN_LAYOUT);
2031 pos_type Paragraph::beginOfBody() const
2033 return d->begin_of_body_;
2037 void Paragraph::setBeginOfBody()
2039 if (d->layout_->labeltype != LABEL_MANUAL) {
2040 d->begin_of_body_ = 0;
2044 // Unroll the first two cycles of the loop
2045 // and remember the previous character to
2046 // remove unnecessary getChar() calls
2048 pos_type end = size();
2049 if (i < end && !(isNewline(i) || isEnvSeparator(i))) {
2052 char_type previous_char = d->text_[i];
2053 if (!(isNewline(i) || isEnvSeparator(i))) {
2055 while (i < end && previous_char != ' ') {
2056 char_type temp = d->text_[i];
2057 if (isNewline(i) || isEnvSeparator(i))
2060 previous_char = temp;
2066 d->begin_of_body_ = i;
2070 bool Paragraph::allowParagraphCustomization() const
2072 return inInset().allowParagraphCustomization();
2076 bool Paragraph::usePlainLayout() const
2078 return inInset().usePlainLayout();
2082 bool Paragraph::isPassThru() const
2084 return inInset().isPassThru() || d->layout_->pass_thru;
2089 // paragraphs inside floats need different alignment tags to avoid
2092 bool noTrivlistCentering(InsetCode code)
2094 return code == FLOAT_CODE
2095 || code == WRAP_CODE
2096 || code == CELL_CODE;
2100 string correction(string const & orig)
2102 if (orig == "flushleft")
2103 return "raggedright";
2104 if (orig == "flushright")
2105 return "raggedleft";
2106 if (orig == "center")
2112 bool corrected_env(otexstream & os, string const & suffix, string const & env,
2113 InsetCode code, bool const lastpar, int & col)
2115 string macro = suffix + "{";
2116 if (noTrivlistCentering(code)) {
2118 // the last paragraph in non-trivlist-aligned
2119 // context is special (to avoid unwanted whitespace)
2120 if (suffix == "\\begin") {
2121 macro = "\\" + correction(env) + "{}";
2122 os << from_ascii(macro);
2123 col += macro.size();
2128 macro += correction(env);
2132 if (suffix == "\\par\\end") {
2136 os << from_ascii(macro);
2137 col += macro.size();
2138 if (suffix == "\\begin") {
2148 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2149 otexstream & os, OutputParams const & runparams) const
2154 (bparams.paragraph_separation == BufferParams::ParagraphIndentSeparation) ?
2155 (layout_->toggle_indent != ITOGGLE_NEVER) :
2156 (layout_->toggle_indent == ITOGGLE_ALWAYS);
2158 if (canindent && params_.noindent() && !layout_->pass_thru) {
2159 os << "\\noindent ";
2163 LyXAlignment const curAlign = params_.align();
2165 if (curAlign == layout_->align)
2169 case LYX_ALIGN_NONE:
2170 case LYX_ALIGN_BLOCK:
2171 case LYX_ALIGN_LAYOUT:
2172 case LYX_ALIGN_SPECIAL:
2173 case LYX_ALIGN_DECIMAL:
2175 case LYX_ALIGN_LEFT:
2176 case LYX_ALIGN_RIGHT:
2177 case LYX_ALIGN_CENTER:
2178 if (runparams.moving_arg) {
2185 string const begin_tag = "\\begin";
2186 InsetCode code = ownerCode();
2187 bool const lastpar = runparams.isLastPar;
2190 case LYX_ALIGN_NONE:
2191 case LYX_ALIGN_BLOCK:
2192 case LYX_ALIGN_LAYOUT:
2193 case LYX_ALIGN_SPECIAL:
2194 case LYX_ALIGN_DECIMAL:
2196 case LYX_ALIGN_LEFT: {
2197 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2198 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2200 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2202 } case LYX_ALIGN_RIGHT: {
2203 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2204 corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2206 corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2208 } case LYX_ALIGN_CENTER: {
2209 corrected_env(os, begin_tag, "center", code, lastpar, column);
2218 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2219 otexstream & os, OutputParams const & runparams) const
2221 LyXAlignment const curAlign = params_.align();
2223 if (curAlign == layout_->align)
2227 case LYX_ALIGN_NONE:
2228 case LYX_ALIGN_BLOCK:
2229 case LYX_ALIGN_LAYOUT:
2230 case LYX_ALIGN_SPECIAL:
2231 case LYX_ALIGN_DECIMAL:
2233 case LYX_ALIGN_LEFT:
2234 case LYX_ALIGN_RIGHT:
2235 case LYX_ALIGN_CENTER:
2236 if (runparams.moving_arg)
2241 bool output = false;
2243 string const end_tag = "\\par\\end";
2244 InsetCode code = ownerCode();
2245 bool const lastpar = runparams.isLastPar;
2248 case LYX_ALIGN_NONE:
2249 case LYX_ALIGN_BLOCK:
2250 case LYX_ALIGN_LAYOUT:
2251 case LYX_ALIGN_SPECIAL:
2252 case LYX_ALIGN_DECIMAL:
2254 case LYX_ALIGN_LEFT: {
2255 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2256 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2258 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2260 } case LYX_ALIGN_RIGHT: {
2261 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2262 output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2264 output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2266 } case LYX_ALIGN_CENTER: {
2267 corrected_env(os, end_tag, "center", code, lastpar, col);
2272 return output || lastpar;
2276 // This one spits out the text of the paragraph
2277 void Paragraph::latex(BufferParams const & bparams,
2278 Font const & outerfont,
2280 OutputParams const & runparams,
2281 int start_pos, int end_pos, bool force) const
2283 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
2285 // FIXME This check should not be needed. Perhaps issue an
2286 // error if it triggers.
2287 Layout const & style = inInset().forcePlainLayout() ?
2288 bparams.documentClass().plainLayout() : *d->layout_;
2290 if (!force && style.inpreamble)
2293 bool const allowcust = allowParagraphCustomization();
2295 // Current base font for all inherited font changes, without any
2296 // change caused by an individual character, except for the language:
2297 // It is set to the language of the first character.
2298 // As long as we are in the label, this font is the base font of the
2299 // label. Before the first body character it is set to the base font
2303 // Maybe we have to create a optional argument.
2304 pos_type body_pos = beginOfBody();
2305 unsigned int column = 0;
2308 // the optional argument is kept in curly brackets in
2309 // case it contains a ']'
2310 // This is not strictly needed, but if this is changed it
2311 // would be a file format change, and tex2lyx would need
2312 // to be adjusted, since it unconditionally removes the
2313 // braces when it parses \item.
2316 basefont = getLabelFont(bparams, outerfont);
2318 basefont = getLayoutFont(bparams, outerfont);
2321 // Which font is currently active?
2322 Font running_font(basefont);
2323 // Do we have an open font change?
2324 bool open_font = false;
2326 Change runningChange = Change(Change::UNCHANGED);
2328 Encoding const * const prev_encoding = runparams.encoding;
2330 os.texrow().start(id(), 0);
2332 // if the paragraph is empty, the loop will not be entered at all
2334 if (style.isCommand()) {
2338 if (!style.leftdelim().empty()) {
2339 os << style.leftdelim();
2340 column += style.leftdelim().size();
2343 column += d->startTeXParParams(bparams, os, runparams);
2346 for (pos_type i = 0; i < size(); ++i) {
2347 // First char in paragraph or after label?
2348 if (i == body_pos) {
2351 column += running_font.latexWriteEndChanges(
2352 os, bparams, runparams,
2353 basefont, basefont);
2356 basefont = getLayoutFont(bparams, outerfont);
2357 running_font = basefont;
2359 column += Changes::latexMarkChange(os, bparams,
2360 runningChange, Change(Change::UNCHANGED),
2362 runningChange = Change(Change::UNCHANGED);
2367 if (style.isCommand()) {
2372 if (!style.leftdelim().empty()) {
2373 os << style.leftdelim();
2374 column += style.leftdelim().size();
2378 column += d->startTeXParParams(bparams, os,
2382 Change const & change = runparams.inDeletedInset
2383 ? runparams.changeOfDeletedInset : lookupChange(i);
2385 if (bparams.output_changes && runningChange != change) {
2387 column += running_font.latexWriteEndChanges(
2388 os, bparams, runparams, basefont, basefont);
2391 basefont = getLayoutFont(bparams, outerfont);
2392 running_font = basefont;
2394 column += Changes::latexMarkChange(os, bparams, runningChange,
2396 runningChange = change;
2399 // do not output text which is marked deleted
2400 // if change tracking output is disabled
2401 if (!bparams.output_changes && change.deleted()) {
2407 // Fully instantiated font
2408 Font const font = getFont(bparams, i, outerfont);
2410 Font const last_font = running_font;
2412 // Do we need to close the previous font?
2414 (font != running_font ||
2415 font.language() != running_font.language()))
2417 column += running_font.latexWriteEndChanges(
2418 os, bparams, runparams, basefont,
2419 (i == body_pos-1) ? basefont : font);
2420 running_font = basefont;
2424 string const running_lang = runparams.use_polyglossia ?
2425 running_font.language()->polyglossia() : running_font.language()->babel();
2426 // close babel's font environment before opening CJK.
2427 string const lang_end_command = runparams.use_polyglossia ?
2428 "\\end{$$lang}" : lyxrc.language_command_end;
2429 if (!running_lang.empty() &&
2430 font.language()->encoding()->package() == Encoding::CJK) {
2431 string end_tag = subst(lang_end_command,
2434 os << from_ascii(end_tag);
2435 column += end_tag.length();
2438 // Switch file encoding if necessary (and allowed)
2439 if (!runparams.pass_thru && !style.pass_thru &&
2440 runparams.encoding->package() != Encoding::none &&
2441 font.language()->encoding()->package() != Encoding::none) {
2442 pair<bool, int> const enc_switch =
2443 switchEncoding(os.os(), bparams, runparams,
2444 *(font.language()->encoding()));
2445 if (enc_switch.first) {
2446 column += enc_switch.second;
2447 runparams.encoding = font.language()->encoding();
2451 char_type const c = d->text_[i];
2453 // Do we need to change font?
2454 if ((font != running_font ||
2455 font.language() != running_font.language()) &&
2458 odocstringstream ods;
2459 column += font.latexWriteStartChanges(ods, bparams,
2460 runparams, basefont,
2462 running_font = font;
2464 docstring fontchange = ods.str();
2465 // check whether the fontchange ends with a \\textcolor
2466 // modifier and the text starts with a space (bug 4473)
2467 docstring const last_modifier = rsplit(fontchange, '\\');
2468 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2469 os << fontchange << from_ascii("{}");
2470 // check if the fontchange ends with a trailing blank
2471 // (like "\small " (see bug 3382)
2472 else if (suffixIs(fontchange, ' ') && c == ' ')
2473 os << fontchange.substr(0, fontchange.size() - 1)
2474 << from_ascii("{}");
2479 // FIXME: think about end_pos implementation...
2480 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2481 // FIXME: integrate this case in latexSpecialChar
2482 // Do not print the separation of the optional argument
2483 // if style.pass_thru is false. This works because
2484 // latexSpecialChar ignores spaces if
2485 // style.pass_thru is false.
2486 if (i != body_pos - 1) {
2487 if (d->simpleTeXBlanks(runparams, os,
2488 i, column, font, style)) {
2489 // A surrogate pair was output. We
2490 // must not call latexSpecialChar
2491 // in this iteration, since it would output
2492 // the combining character again.
2499 OutputParams rp = runparams;
2500 rp.free_spacing = style.free_spacing;
2501 rp.local_font = &font;
2502 rp.intitle = style.intitle;
2504 // Two major modes: LaTeX or plain
2505 // Handle here those cases common to both modes
2506 // and then split to handle the two modes separately.
2507 if (c == META_INSET) {
2508 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2509 d->latexInset(bparams, os, rp, running_font,
2510 basefont, outerfont, open_font,
2511 runningChange, style, i, column);
2514 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2516 d->latexSpecialChar(os, bparams, rp, running_font, runningChange,
2517 style, i, end_pos, column);
2518 } catch (EncodingException & e) {
2519 if (runparams.dryrun) {
2520 os << "<" << _("LyX Warning: ")
2521 << _("uncodable character") << " '";
2525 // add location information and throw again.
2534 // Set the encoding to that returned from latexSpecialChar (see
2535 // comment for encoding member in OutputParams.h)
2536 runparams.encoding = rp.encoding;
2539 // If we have an open font definition, we have to close it
2541 #ifdef FIXED_LANGUAGE_END_DETECTION
2543 running_font.latexWriteEndChanges(os, bparams,
2544 runparams, basefont,
2545 next_->getFont(bparams, 0, outerfont));
2547 running_font.latexWriteEndChanges(os, bparams,
2548 runparams, basefont, basefont);
2551 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2552 //FIXME: there as we start another \selectlanguage with the next paragraph if
2553 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2554 running_font.latexWriteEndChanges(os, bparams, runparams,
2555 basefont, basefont);
2559 column += Changes::latexMarkChange(os, bparams, runningChange,
2560 Change(Change::UNCHANGED), runparams);
2562 // Needed if there is an optional argument but no contents.
2563 if (body_pos > 0 && body_pos == size()) {
2567 if (!style.rightdelim().empty()) {
2568 os << style.rightdelim();
2569 column += style.rightdelim().size();
2572 if (allowcust && d->endTeXParParams(bparams, os, runparams)
2573 && runparams.encoding != prev_encoding) {
2574 runparams.encoding = prev_encoding;
2575 os << setEncoding(prev_encoding->iconvName());
2578 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2582 bool Paragraph::emptyTag() const
2584 for (pos_type i = 0; i < size(); ++i) {
2585 if (Inset const * inset = getInset(i)) {
2586 InsetCode lyx_code = inset->lyxCode();
2587 // FIXME testing like that is wrong. What is
2589 if (lyx_code != TOC_CODE &&
2590 lyx_code != INCLUDE_CODE &&
2591 lyx_code != GRAPHICS_CODE &&
2592 lyx_code != ERT_CODE &&
2593 lyx_code != LISTINGS_CODE &&
2594 lyx_code != FLOAT_CODE &&
2595 lyx_code != TABULAR_CODE) {
2599 char_type c = d->text_[i];
2600 if (c != ' ' && c != '\t')
2608 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2611 for (pos_type i = 0; i < size(); ++i) {
2612 if (Inset const * inset = getInset(i)) {
2613 InsetCode lyx_code = inset->lyxCode();
2614 if (lyx_code == LABEL_CODE) {
2615 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2616 docstring const & id = il->getParam("name");
2617 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2625 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2629 for (i = 0; i < size(); ++i) {
2630 if (Inset const * inset = getInset(i)) {
2631 inset->docbook(os, runparams);
2633 char_type c = d->text_[i];
2636 os << sgml::escapeChar(c);
2643 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2647 for (i = 0; i < size(); ++i) {
2648 if (Inset const * inset = getInset(i)) {
2649 inset->xhtml(xs, runparams);
2651 char_type c = d->text_[i];
2661 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2664 pos_type size = text_.size();
2665 for (pos_type i = initial; i < size; ++i) {
2666 Font font = owner_->getFont(buf.params(), i, outerfont);
2667 if (text_[i] == META_INSET)
2669 if (i != initial && font != font_old)
2678 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2680 OutputParams const & runparams,
2681 Font const & outerfont,
2682 pos_type initial) const
2684 bool emph_flag = false;
2686 Layout const & style = *d->layout_;
2688 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2690 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2693 // parsing main loop
2694 for (pos_type i = initial; i < size(); ++i) {
2695 Font font = getFont(buf.params(), i, outerfont);
2697 // handle <emphasis> tag
2698 if (font_old.emph() != font.fontInfo().emph()) {
2699 if (font.fontInfo().emph() == FONT_ON) {
2702 } else if (i != initial) {
2703 os << "</emphasis>";
2708 if (Inset const * inset = getInset(i)) {
2709 inset->docbook(os, runparams);
2711 char_type c = d->text_[i];
2713 if (style.pass_thru)
2716 os << sgml::escapeChar(c);
2718 font_old = font.fontInfo();
2722 os << "</emphasis>";
2725 if (style.free_spacing)
2727 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2733 void doFontSwitch(vector<html::FontTag> & tagsToOpen,
2734 vector<html::EndFontTag> & tagsToClose,
2735 bool & flag, FontState curstate, html::FontTypes type)
2737 if (curstate == FONT_ON) {
2738 tagsToOpen.push_back(html::FontTag(type));
2741 tagsToClose.push_back(html::EndFontTag(type));
2748 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
2750 OutputParams const & runparams,
2751 Font const & outerfont,
2752 pos_type initial) const
2756 // track whether we have opened these tags
2757 bool emph_flag = false;
2758 bool bold_flag = false;
2759 bool noun_flag = false;
2760 bool ubar_flag = false;
2761 bool dbar_flag = false;
2762 bool sout_flag = false;
2763 bool wave_flag = false;
2765 bool shap_flag = false;
2767 bool faml_flag = false;
2769 bool size_flag = false;
2771 Layout const & style = *d->layout_;
2773 xs.startParagraph(allowEmpty());
2776 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2778 FontShape curr_fs = INHERIT_SHAPE;
2779 FontFamily curr_fam = INHERIT_FAMILY;
2780 FontSize curr_size = FONT_SIZE_INHERIT;
2782 string const default_family =
2783 buf.masterBuffer()->params().fonts_default_family;
2785 vector<html::FontTag> tagsToOpen;
2786 vector<html::EndFontTag> tagsToClose;
2788 // parsing main loop
2789 for (pos_type i = initial; i < size(); ++i) {
2790 // let's not show deleted material in the output
2794 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
2797 FontState curstate = font.fontInfo().emph();
2798 if (font_old.emph() != curstate)
2799 doFontSwitch(tagsToOpen, tagsToClose, emph_flag, curstate, html::FT_EMPH);
2802 curstate = font.fontInfo().noun();
2803 if (font_old.noun() != curstate)
2804 doFontSwitch(tagsToOpen, tagsToClose, noun_flag, curstate, html::FT_NOUN);
2807 curstate = font.fontInfo().underbar();
2808 if (font_old.underbar() != curstate)
2809 doFontSwitch(tagsToOpen, tagsToClose, ubar_flag, curstate, html::FT_UBAR);
2812 curstate = font.fontInfo().strikeout();
2813 if (font_old.strikeout() != curstate)
2814 doFontSwitch(tagsToOpen, tagsToClose, sout_flag, curstate, html::FT_SOUT);
2817 curstate = font.fontInfo().uuline();
2818 if (font_old.uuline() != curstate)
2819 doFontSwitch(tagsToOpen, tagsToClose, dbar_flag, curstate, html::FT_DBAR);
2822 curstate = font.fontInfo().uwave();
2823 if (font_old.uwave() != curstate)
2824 doFontSwitch(tagsToOpen, tagsToClose, wave_flag, curstate, html::FT_WAVE);
2827 // a little hackish, but allows us to reuse what we have.
2828 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
2829 if (font_old.series() != font.fontInfo().series())
2830 doFontSwitch(tagsToOpen, tagsToClose, bold_flag, curstate, html::FT_BOLD);
2833 curr_fs = font.fontInfo().shape();
2834 FontShape old_fs = font_old.shape();
2835 if (old_fs != curr_fs) {
2839 tagsToClose.push_back(html::EndFontTag(html::FT_ITALIC));
2842 tagsToClose.push_back(html::EndFontTag(html::FT_SLANTED));
2844 case SMALLCAPS_SHAPE:
2845 tagsToClose.push_back(html::EndFontTag(html::FT_SMALLCAPS));
2851 // the other tags are for internal use
2859 tagsToOpen.push_back(html::FontTag(html::FT_ITALIC));
2863 tagsToOpen.push_back(html::FontTag(html::FT_SLANTED));
2866 case SMALLCAPS_SHAPE:
2867 tagsToOpen.push_back(html::FontTag(html::FT_SMALLCAPS));
2874 // the other tags are for internal use
2881 curr_fam = font.fontInfo().family();
2882 FontFamily old_fam = font_old.family();
2883 if (old_fam != curr_fam) {
2887 tagsToClose.push_back(html::EndFontTag(html::FT_ROMAN));
2890 tagsToClose.push_back(html::EndFontTag(html::FT_SANS));
2892 case TYPEWRITER_FAMILY:
2893 tagsToClose.push_back(html::EndFontTag(html::FT_TYPE));
2895 case INHERIT_FAMILY:
2898 // the other tags are for internal use
2906 // we will treat a "default" font family as roman, since we have
2907 // no other idea what to do.
2908 if (default_family != "rmdefault" && default_family != "default") {
2909 tagsToOpen.push_back(html::FontTag(html::FT_ROMAN));
2914 if (default_family != "sfdefault") {
2915 tagsToOpen.push_back(html::FontTag(html::FT_SANS));
2919 case TYPEWRITER_FAMILY:
2920 if (default_family != "ttdefault") {
2921 tagsToOpen.push_back(html::FontTag(html::FT_TYPE));
2925 case INHERIT_FAMILY:
2928 // the other tags are for internal use
2935 curr_size = font.fontInfo().size();
2936 FontSize old_size = font_old.size();
2937 if (old_size != curr_size) {
2940 case FONT_SIZE_TINY:
2941 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_TINY));
2943 case FONT_SIZE_SCRIPT:
2944 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SCRIPT));
2946 case FONT_SIZE_FOOTNOTE:
2947 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_FOOTNOTE));
2949 case FONT_SIZE_SMALL:
2950 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SMALL));
2952 case FONT_SIZE_LARGE:
2953 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGE));
2955 case FONT_SIZE_LARGER:
2956 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGER));
2958 case FONT_SIZE_LARGEST:
2959 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGEST));
2961 case FONT_SIZE_HUGE:
2962 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGE));
2964 case FONT_SIZE_HUGER:
2965 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGER));
2967 case FONT_SIZE_INCREASE:
2968 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_INCREASE));
2970 case FONT_SIZE_DECREASE:
2971 tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_DECREASE));
2973 case FONT_SIZE_INHERIT:
2974 case FONT_SIZE_NORMAL:
2977 // the other tags are for internal use
2983 switch (curr_size) {
2984 case FONT_SIZE_TINY:
2985 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_TINY));
2988 case FONT_SIZE_SCRIPT:
2989 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SCRIPT));
2992 case FONT_SIZE_FOOTNOTE:
2993 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_FOOTNOTE));
2996 case FONT_SIZE_SMALL:
2997 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SMALL));
3000 case FONT_SIZE_LARGE:
3001 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGE));
3004 case FONT_SIZE_LARGER:
3005 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGER));
3008 case FONT_SIZE_LARGEST:
3009 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGEST));
3012 case FONT_SIZE_HUGE:
3013 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGE));
3016 case FONT_SIZE_HUGER:
3017 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGER));
3020 case FONT_SIZE_INCREASE:
3021 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_INCREASE));
3024 case FONT_SIZE_DECREASE:
3025 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_DECREASE));
3028 case FONT_SIZE_NORMAL:
3029 case FONT_SIZE_INHERIT:
3032 // the other tags are for internal use
3039 // Other such tags? What about the other text ranges?
3041 vector<html::EndFontTag>::const_iterator cit = tagsToClose.begin();
3042 vector<html::EndFontTag>::const_iterator cen = tagsToClose.end();
3043 for (; cit != cen; ++cit)
3046 vector<html::FontTag>::const_iterator sit = tagsToOpen.begin();
3047 vector<html::FontTag>::const_iterator sen = tagsToOpen.end();
3048 for (; sit != sen; ++sit)
3051 tagsToClose.clear();
3054 Inset const * inset = getInset(i);
3056 if (!runparams.for_toc || inset->isInToc()) {
3057 OutputParams np = runparams;
3058 np.local_font = &font;
3059 if (!inset->getLayout().htmlisblock())
3060 np.html_in_par = true;
3061 retval += inset->xhtml(xs, np);
3064 char_type c = getUChar(buf.masterBuffer()->params(), i);
3067 font_old = font.fontInfo();
3076 bool Paragraph::isHfill(pos_type pos) const
3078 Inset const * inset = getInset(pos);
3079 return inset && inset->isHfill();
3083 bool Paragraph::isNewline(pos_type pos) const
3085 Inset const * inset = getInset(pos);
3086 return inset && inset->lyxCode() == NEWLINE_CODE;
3090 bool Paragraph::isEnvSeparator(pos_type pos) const
3092 Inset const * inset = getInset(pos);
3093 return inset && inset->lyxCode() == SEPARATOR_CODE;
3097 bool Paragraph::isLineSeparator(pos_type pos) const
3099 char_type const c = d->text_[pos];
3100 if (isLineSeparatorChar(c))
3102 Inset const * inset = getInset(pos);
3103 return inset && inset->isLineSeparator();
3107 bool Paragraph::isWordSeparator(pos_type pos) const
3111 if (Inset const * inset = getInset(pos))
3112 return !inset->isLetter();
3113 // if we have a hard hyphen (no en- or emdash) or apostrophe
3114 // we pass this to the spell checker
3115 // FIXME: this method is subject to change, visit
3116 // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
3117 // to get an impression how complex this is.
3118 if (isHardHyphenOrApostrophe(pos))
3120 char_type const c = d->text_[pos];
3121 // We want to pass the escape chars to the spellchecker
3122 docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
3123 return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
3127 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
3129 pos_type const psize = size();
3132 char_type const c = d->text_[pos];
3133 if (c != '-' && c != '\'')
3135 int nextpos = pos + 1;
3136 int prevpos = pos > 0 ? pos - 1 : 0;
3137 if ((nextpos == psize || isSpace(nextpos))
3138 && (pos == 0 || isSpace(prevpos)))
3144 FontSpan const & Paragraph::getSpellRange(pos_type pos) const
3146 return d->speller_state_.getRange(pos);
3150 bool Paragraph::isChar(pos_type pos) const
3152 if (Inset const * inset = getInset(pos))
3153 return inset->isChar();
3154 char_type const c = d->text_[pos];
3155 return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3159 bool Paragraph::isSpace(pos_type pos) const
3161 if (Inset const * inset = getInset(pos))
3162 return inset->isSpace();
3163 char_type const c = d->text_[pos];
3164 return lyx::isSpace(c);
3169 Paragraph::getParLanguage(BufferParams const & bparams) const
3172 return getFirstFontSettings(bparams).language();
3173 // FIXME: we should check the prev par as well (Lgb)
3174 return bparams.language;
3178 bool Paragraph::isRTL(BufferParams const & bparams) const
3180 return getParLanguage(bparams)->rightToLeft()
3181 && !inInset().getLayout().forceLTR();
3185 void Paragraph::changeLanguage(BufferParams const & bparams,
3186 Language const * from, Language const * to)
3188 // change language including dummy font change at the end
3189 for (pos_type i = 0; i <= size(); ++i) {
3190 Font font = getFontSettings(bparams, i);
3191 if (font.language() == from) {
3192 font.setLanguage(to);
3194 d->requestSpellCheck(i);
3200 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3202 Language const * doc_language = bparams.language;
3203 FontList::const_iterator cit = d->fontlist_.begin();
3204 FontList::const_iterator end = d->fontlist_.end();
3206 for (; cit != end; ++cit)
3207 if (cit->font().language() != ignore_language &&
3208 cit->font().language() != latex_language &&
3209 cit->font().language() != doc_language)
3215 void Paragraph::getLanguages(std::set<Language const *> & languages) const
3217 FontList::const_iterator cit = d->fontlist_.begin();
3218 FontList::const_iterator end = d->fontlist_.end();
3220 for (; cit != end; ++cit) {
3221 Language const * lang = cit->font().language();
3222 if (lang != ignore_language &&
3223 lang != latex_language)
3224 languages.insert(lang);
3229 docstring Paragraph::asString(int options) const
3231 return asString(0, size(), options);
3235 docstring Paragraph::asString(pos_type beg, pos_type end, int options, const OutputParams *runparams) const
3237 odocstringstream os;
3240 && options & AS_STR_LABEL
3241 && !d->params_.labelString().empty())
3242 os << d->params_.labelString() << ' ';
3244 for (pos_type i = beg; i < end; ++i) {
3245 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3247 char_type const c = d->text_[i];
3248 if (isPrintable(c) || c == '\t'
3249 || (c == '\n' && (options & AS_STR_NEWLINES)))
3251 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3252 if (c == META_INSET && (options & AS_STR_PLAINTEXT)) {
3253 LASSERT(runparams != 0, return docstring());
3254 getInset(i)->plaintext(os, *runparams);
3256 getInset(i)->toString(os);
3265 void Paragraph::forOutliner(docstring & os, size_t const maxlen,
3266 bool const shorten) const
3268 size_t tmplen = shorten ? maxlen + 1 : maxlen;
3269 if (!d->params_.labelString().empty())
3270 os += d->params_.labelString() + ' ';
3271 for (pos_type i = 0; i < size() && os.length() < tmplen; ++i) {
3274 char_type const c = d->text_[i];
3277 else if (c == META_INSET)
3278 getInset(i)->forOutliner(os, tmplen, false);
3281 Text::shortenForOutliner(os, maxlen);
3285 void Paragraph::setInsetOwner(Inset const * inset)
3287 d->inset_owner_ = inset;
3291 int Paragraph::id() const
3297 void Paragraph::setId(int id)
3303 Layout const & Paragraph::layout() const
3309 void Paragraph::setLayout(Layout const & layout)
3311 d->layout_ = &layout;
3315 void Paragraph::setDefaultLayout(DocumentClass const & tc)
3317 setLayout(tc.defaultLayout());
3321 void Paragraph::setPlainLayout(DocumentClass const & tc)
3323 setLayout(tc.plainLayout());
3327 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
3329 if (usePlainLayout())
3330 setPlainLayout(tclass);
3332 setDefaultLayout(tclass);
3336 Inset const & Paragraph::inInset() const
3338 LBUFERR(d->inset_owner_);
3339 return *d->inset_owner_;
3343 ParagraphParameters & Paragraph::params()
3349 ParagraphParameters const & Paragraph::params() const
3355 bool Paragraph::isFreeSpacing() const
3357 if (d->layout_->free_spacing)
3359 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
3363 bool Paragraph::allowEmpty() const
3365 if (d->layout_->keepempty)
3367 return d->inset_owner_ && d->inset_owner_->allowEmpty();
3371 bool Paragraph::brokenBiblio() const
3373 // there is a problem if there is no bibitem at position 0 or
3374 // if there is another bibitem in the paragraph.
3375 return d->layout_->labeltype == LABEL_BIBLIO
3376 && (d->insetlist_.find(BIBITEM_CODE) != 0
3377 || d->insetlist_.find(BIBITEM_CODE, 1) > 0);
3381 int Paragraph::fixBiblio(Buffer const & buffer)
3383 // FIXME: What about the case where paragraph is not BIBLIO
3384 // but there is an InsetBibitem?
3385 // FIXME: when there was already an inset at 0, the return value is 1,
3386 // which does not tell whether another inset has been remove; the
3387 // cursor cannot be correctly updated.
3389 if (d->layout_->labeltype != LABEL_BIBLIO)
3392 bool const track_changes = buffer.params().track_changes;
3393 int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
3394 bool const hasbibitem0 = bibitem_pos == 0;
3397 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
3398 // There was an InsetBibitem at pos 0, and no other one => OK
3399 if (bibitem_pos == -1)
3401 // there is a bibitem at the 0 position, but since
3402 // there is a second one, we copy the second on the
3403 // first. We're assuming there are at most two of
3404 // these, which there should be.
3405 // FIXME: why does it make sense to do that rather
3406 // than keep the first? (JMarc)
3407 Inset * inset = releaseInset(bibitem_pos);
3408 d->insetlist_.begin()->inset = inset;
3409 return -bibitem_pos;
3412 // We need to create an inset at the beginning
3414 if (bibitem_pos > 0) {
3415 // there was one somewhere in the paragraph, let's move it
3416 inset = d->insetlist_.release(bibitem_pos);
3417 eraseChar(bibitem_pos, track_changes);
3420 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
3421 InsetCommandParams(BIBITEM_CODE));
3423 Font font(inherit_font, buffer.params().language);
3424 insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
3425 : Change::UNCHANGED));
3431 void Paragraph::checkAuthors(AuthorList const & authorList)
3433 d->changes_.checkAuthors(authorList);
3437 bool Paragraph::isChanged(pos_type pos) const
3439 return lookupChange(pos).changed();
3443 bool Paragraph::isInserted(pos_type pos) const
3445 return lookupChange(pos).inserted();
3449 bool Paragraph::isDeleted(pos_type pos) const
3451 return lookupChange(pos).deleted();
3455 InsetList const & Paragraph::insetList() const
3457 return d->insetlist_;
3461 void Paragraph::setBuffer(Buffer & b)
3463 d->insetlist_.setBuffer(b);
3467 Inset * Paragraph::releaseInset(pos_type pos)
3469 Inset * inset = d->insetlist_.release(pos);
3470 /// does not honour change tracking!
3471 eraseChar(pos, false);
3476 Inset * Paragraph::getInset(pos_type pos)
3478 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3479 ? d->insetlist_.get(pos) : 0;
3483 Inset const * Paragraph::getInset(pos_type pos) const
3485 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3486 ? d->insetlist_.get(pos) : 0;
3490 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
3491 pos_type & right, TextCase action)
3493 // process sequences of modified characters; in change
3494 // tracking mode, this approach results in much better
3495 // usability than changing case on a char-by-char basis
3496 // We also need to track the current font, since font
3497 // changes within sequences can occur.
3498 vector<pair<char_type, Font> > changes;
3500 bool const trackChanges = bparams.track_changes;
3502 bool capitalize = true;
3504 for (; pos < right; ++pos) {
3505 char_type oldChar = d->text_[pos];
3506 char_type newChar = oldChar;
3508 // ignore insets and don't play with deleted text!
3509 if (oldChar != META_INSET && !isDeleted(pos)) {
3511 case text_lowercase:
3512 newChar = lowercase(oldChar);
3514 case text_capitalization:
3516 newChar = uppercase(oldChar);
3520 case text_uppercase:
3521 newChar = uppercase(oldChar);
3526 if (isWordSeparator(pos) || isDeleted(pos)) {
3527 // permit capitalization again
3531 if (oldChar != newChar) {
3532 changes.push_back(make_pair(newChar, getFontSettings(bparams, pos)));
3533 if (pos != right - 1)
3535 // step behind the changing area
3539 int erasePos = pos - changes.size();
3540 for (size_t i = 0; i < changes.size(); i++) {
3541 insertChar(pos, changes[i].first,
3544 if (!eraseChar(erasePos, trackChanges)) {
3547 ++right; // expand selection
3555 int Paragraph::find(docstring const & str, bool cs, bool mw,
3556 pos_type start_pos, bool del) const
3558 pos_type pos = start_pos;
3559 int const strsize = str.length();
3561 pos_type const parsize = d->text_.size();
3562 for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
3563 // Ignore "invisible" letters such as ligature breaks
3564 // and hyphenation chars while searching
3565 while (pos < parsize - 1 && isInset(pos)) {
3566 odocstringstream os;
3567 getInset(pos)->toString(os);
3568 if (!getInset(pos)->isLetter() || !os.str().empty())
3572 if (cs && str[i] != d->text_[pos])
3574 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
3576 if (!del && isDeleted(pos))
3583 // if necessary, check whether string matches word
3585 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
3588 && !isWordSeparator(pos))
3592 return pos - start_pos;
3596 char_type Paragraph::getChar(pos_type pos) const
3598 return d->text_[pos];
3602 pos_type Paragraph::size() const
3604 return d->text_.size();
3608 bool Paragraph::empty() const
3610 return d->text_.empty();
3614 bool Paragraph::isInset(pos_type pos) const
3616 return d->text_[pos] == META_INSET;
3620 bool Paragraph::isSeparator(pos_type pos) const
3622 //FIXME: Are we sure this can be the only separator?
3623 return d->text_[pos] == ' ';
3627 void Paragraph::deregisterWords()
3629 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3630 Private::LangWordsMap::const_iterator ite = d->words_.end();
3631 for (; itl != ite; ++itl) {
3632 WordList * wl = theWordList(itl->first);
3633 Private::Words::const_iterator it = (itl->second).begin();
3634 Private::Words::const_iterator et = (itl->second).end();
3635 for (; it != et; ++it)
3642 void Paragraph::locateWord(pos_type & from, pos_type & to,
3643 word_location const loc) const
3646 case WHOLE_WORD_STRICT:
3647 if (from == 0 || from == size()
3648 || isWordSeparator(from)
3649 || isWordSeparator(from - 1)) {
3653 // no break here, we go to the next
3656 // If we are already at the beginning of a word, do nothing
3657 if (!from || isWordSeparator(from - 1))
3659 // no break here, we go to the next
3662 // always move the cursor to the beginning of previous word
3663 while (from && !isWordSeparator(from - 1))
3667 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
3670 // no need to move the 'from' cursor
3674 while (to < size() && !isWordSeparator(to))
3679 void Paragraph::collectWords()
3681 for (pos_type pos = 0; pos < size(); ++pos) {
3682 if (isWordSeparator(pos))
3684 pos_type from = pos;
3685 locateWord(from, pos, WHOLE_WORD);
3686 // Work around MSVC warning: The statement
3687 // if (pos < from + lyxrc.completion_minlength)
3688 // triggers a signed vs. unsigned warning.
3689 // I don't know why this happens, it could be a MSVC bug, or
3690 // related to LLP64 (windows) vs. LP64 (unix) programming
3691 // model, or the C++ standard might be ambigous in the section
3692 // defining the "usual arithmetic conversions". However, using
3693 // a temporary variable is safe and works on all compilers.
3694 pos_type const endpos = from + lyxrc.completion_minlength;
3697 FontList::const_iterator cit = d->fontlist_.fontIterator(from);
3698 if (cit == d->fontlist_.end())
3700 Language const * lang = cit->font().language();
3701 docstring const word = asString(from, pos, AS_STR_NONE);
3702 d->words_[lang->lang()].insert(word);
3707 void Paragraph::registerWords()
3709 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3710 Private::LangWordsMap::const_iterator ite = d->words_.end();
3711 for (; itl != ite; ++itl) {
3712 WordList * wl = theWordList(itl->first);
3713 Private::Words::const_iterator it = (itl->second).begin();
3714 Private::Words::const_iterator et = (itl->second).end();
3715 for (; it != et; ++it)
3721 void Paragraph::updateWords()
3729 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
3731 SkipPositionsIterator begin = skips.begin();
3732 SkipPositions::iterator end = skips.end();
3733 if (pos > 0 && begin < end) {
3735 if (end->last == pos - 1) {
3740 skips.insert(end, FontSpan(pos, pos));
3744 Language * Paragraph::Private::locateSpellRange(
3745 pos_type & from, pos_type & to,
3746 SkipPositions & skips) const
3748 // skip leading white space
3749 while (from < to && owner_->isWordSeparator(from))
3751 // don't check empty range
3754 // get current language
3755 Language * lang = getSpellLanguage(from);
3756 pos_type last = from;
3757 bool samelang = true;
3758 bool sameinset = true;
3759 while (last < to && samelang && sameinset) {
3760 // hop to end of word
3761 while (last < to && !owner_->isWordSeparator(last)) {
3762 if (owner_->getInset(last)) {
3763 appendSkipPosition(skips, last);
3764 } else if (owner_->isDeleted(last)) {
3765 appendSkipPosition(skips, last);
3769 // hop to next word while checking for insets
3770 while (sameinset && last < to && owner_->isWordSeparator(last)) {
3771 if (Inset const * inset = owner_->getInset(last))
3772 sameinset = inset->isChar() && inset->isLetter();
3773 if (sameinset && owner_->isDeleted(last)) {
3774 appendSkipPosition(skips, last);
3779 if (sameinset && last < to) {
3780 // now check for language change
3781 samelang = lang == getSpellLanguage(last);
3784 // if language change detected backstep is needed
3792 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
3795 const_cast<Language *>(owner_->getFontSettings(
3796 inset_owner_->buffer().params(), from).language());
3797 if (lang == inset_owner_->buffer().params().language
3798 && !lyxrc.spellchecker_alt_lang.empty()) {
3800 string const lang_variety =
3801 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
3802 lang->setCode(lang_code);
3803 lang->setVariety(lang_variety);
3809 void Paragraph::requestSpellCheck(pos_type pos)
3811 d->requestSpellCheck(pos);
3815 bool Paragraph::needsSpellCheck() const
3817 SpellChecker::ChangeNumber speller_change_number = 0;
3818 if (theSpellChecker())
3819 speller_change_number = theSpellChecker()->changeNumber();
3820 if (speller_change_number > d->speller_state_.currentChangeNumber()) {
3821 d->speller_state_.needsCompleteRefresh(speller_change_number);
3823 return d->needsSpellCheck();
3827 bool Paragraph::Private::ignoreWord(docstring const & word) const
3829 // Ignore words with digits
3830 // FIXME: make this customizable
3831 // (note that some checkers ignore words with digits by default)
3832 docstring::const_iterator cit = word.begin();
3833 docstring::const_iterator const end = word.end();
3834 for (; cit != end; ++cit) {
3835 if (isNumber((*cit)))
3842 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
3843 WordLangTuple & wl, docstring_list & suggestions,
3844 bool do_suggestion, bool check_learned) const
3846 SpellChecker::Result result = SpellChecker::WORD_OK;
3847 SpellChecker * speller = theSpellChecker();
3851 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
3854 locateWord(from, to, WHOLE_WORD);
3855 if (from == to || from >= size())
3858 docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
3859 Language * lang = d->getSpellLanguage(from);
3861 wl = WordLangTuple(word, lang);
3866 if (needsSpellCheck() || check_learned) {
3868 if (!d->ignoreWord(word)) {
3869 bool const trailing_dot = to < size() && d->text_[to] == '.';
3870 result = speller->check(wl);
3871 if (SpellChecker::misspelled(result) && trailing_dot) {
3872 wl = WordLangTuple(word.append(from_ascii(".")), lang);
3873 result = speller->check(wl);
3874 if (!SpellChecker::misspelled(result)) {
3875 LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
3877 from << ".." << to << "]");
3879 // spell check with dot appended failed too
3880 // restore original word/lang value
3881 word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
3882 wl = WordLangTuple(word, lang);
3886 if (!SpellChecker::misspelled(result)) {
3887 // area up to the begin of the next word is not misspelled
3888 while (end < size() && isWordSeparator(end))
3891 d->setMisspelled(from, end, result);
3893 result = d->speller_state_.getState(from);
3897 suggestions.clear();
3899 if (SpellChecker::misspelled(result)) {
3900 LYXERR(Debug::GUI, "misspelled word: \"" <<
3902 from << ".." << to << "]");
3904 speller->suggest(wl, suggestions);
3910 void Paragraph::Private::markMisspelledWords(
3911 pos_type const & first, pos_type const & last,
3912 SpellChecker::Result result,
3913 docstring const & word,
3914 SkipPositions const & skips)
3916 if (!SpellChecker::misspelled(result)) {
3917 setMisspelled(first, last, SpellChecker::WORD_OK);
3921 SpellChecker * speller = theSpellChecker();
3922 // locate and enumerate the error positions
3923 int nerrors = speller->numMisspelledWords();
3925 SkipPositionsIterator it = skips.begin();
3926 SkipPositionsIterator et = skips.end();
3927 for (int index = 0; index < nerrors; ++index) {
3930 speller->misspelledWord(index, wstart, wlen);
3931 /// should not happen if speller supports range checks
3932 if (!wlen) continue;
3933 docstring const misspelled = word.substr(wstart, wlen);
3934 wstart += first + numskipped;
3935 if (snext < wstart) {
3936 /// mark the range of correct spelling
3937 numskipped += countSkips(it, et, wstart);
3938 setMisspelled(snext,
3939 wstart - 1, SpellChecker::WORD_OK);
3941 snext = wstart + wlen;
3942 numskipped += countSkips(it, et, snext);
3943 /// mark the range of misspelling
3944 setMisspelled(wstart, snext, result);
3945 LYXERR(Debug::GUI, "misspelled word: \"" <<
3946 misspelled << "\" [" <<
3947 wstart << ".." << (snext-1) << "]");
3950 if (snext <= last) {
3951 /// mark the range of correct spelling at end
3952 setMisspelled(snext, last, SpellChecker::WORD_OK);
3957 void Paragraph::spellCheck() const
3959 SpellChecker * speller = theSpellChecker();
3960 if (!speller || empty() ||!needsSpellCheck())
3964 d->rangeOfSpellCheck(start, endpos);
3965 if (speller->canCheckParagraph()) {
3966 // loop until we leave the range
3967 for (pos_type first = start; first < endpos; ) {
3968 pos_type last = endpos;
3969 Private::SkipPositions skips;
3970 Language * lang = d->locateSpellRange(first, last, skips);
3971 if (first >= endpos)
3973 // start the spell checker on the unit of meaning
3974 docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
3975 WordLangTuple wl = WordLangTuple(word, lang);
3976 SpellChecker::Result result = word.size() ?
3977 speller->check(wl) : SpellChecker::WORD_OK;
3978 d->markMisspelledWords(first, last, result, word, skips);
3982 static docstring_list suggestions;
3983 pos_type to = endpos;
3984 while (start < endpos) {
3986 spellCheck(start, to, wl, suggestions, false);
3990 d->readySpellCheck();
3994 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
3996 bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
3997 if (result || pos <= 0 || pos > size())
3999 if (check_boundary && (pos == size() || isWordSeparator(pos)))
4000 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
4005 string Paragraph::magicLabel() const
4008 ss << "magicparlabel-" << id();