3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Richard Heck (XHTML output)
9 * \author Jean-Marc Lasgouttes
10 * \author Angus Leeming
12 * \author André Pönitz
14 * \author Jürgen Vigna
16 * Full author contact details are available in file CREDITS.
21 #include "Paragraph.h"
23 #include "LayoutFile.h"
25 #include "BufferParams.h"
29 #include "InsetList.h"
31 #include "LaTeXFeatures.h"
37 #include "OutputParams.h"
38 #include "output_latex.h"
39 #include "output_xhtml.h"
40 #include "ParagraphParameters.h"
41 #include "SpellChecker.h"
43 #include "TextClass.h"
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 inside(pos_type pos) const { return range_.inside(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 return range_.inside(r.first) || range_.inside(r.last) ||
108 r.inside(range_.first) || r.inside(range_.last);
111 void shift(pos_type pos, int offset)
113 if (range_.first > pos) {
114 range_.first += offset;
115 range_.last += offset;
116 } else if (range_.last >= pos) {
117 range_.last += offset;
122 SpellChecker::Result result_ ;
126 /////////////////////////////////////////////////////////////////////
130 /////////////////////////////////////////////////////////////////////
132 class SpellCheckerState {
136 needs_refresh_ = true;
137 current_change_number_ = 0;
140 void setRange(FontSpan const & fp, SpellChecker::Result state)
143 RangesIterator et = ranges_.end();
144 RangesIterator it = ranges_.begin();
145 for (; it != et; ++it) {
146 if (!it->covered(fp))
147 result.push_back(SpellResultRange(it->range(), it->result()));
148 else if (state == SpellChecker::WORD_OK) {
149 // trim or split the current misspelled range
150 // store misspelled ranges only
151 FontSpan range = it->range();
152 if (fp.first > range.first) {
153 // misspelled area in front of WORD_OK
154 range.last = fp.first - 1;
155 result.push_back(SpellResultRange(range, it->result()));
158 if (fp.last < range.last) {
159 // misspelled area after WORD_OK range
160 range.first = fp.last + 1;
161 result.push_back(SpellResultRange(range, it->result()));
166 if (state != SpellChecker::WORD_OK)
167 ranges_.push_back(SpellResultRange(fp, state));
170 void increasePosAfterPos(pos_type pos)
172 correctRangesAfterPos(pos, 1);
176 void decreasePosAfterPos(pos_type pos)
178 correctRangesAfterPos(pos, -1);
182 void refreshLast(pos_type pos)
184 if (pos < refresh_.last)
188 SpellChecker::Result getState(pos_type pos) const
190 SpellChecker::Result result = SpellChecker::WORD_OK;
191 RangesIterator et = ranges_.end();
192 RangesIterator it = ranges_.begin();
193 for (; it != et; ++it) {
194 if(it->inside(pos)) {
201 FontSpan const & getRange(pos_type pos) const
203 /// empty span to indicate mismatch
204 static FontSpan empty_;
205 RangesIterator et = ranges_.end();
206 RangesIterator it = ranges_.begin();
207 for (; it != et; ++it) {
208 if(it->inside(pos)) {
215 bool needsRefresh() const
217 return needs_refresh_;
220 SpellChecker::ChangeNumber currentChangeNumber() const
222 return current_change_number_;
225 void refreshRange(pos_type & first, pos_type & last) const
227 first = refresh_.first;
228 last = refresh_.last;
231 void needsRefresh(pos_type pos)
233 if (needs_refresh_ && pos != -1) {
234 if (pos < refresh_.first)
235 refresh_.first = pos;
236 if (pos > refresh_.last)
238 } else if (pos != -1) {
239 // init request check for neighbour positions too
240 refresh_.first = pos > 0 ? pos - 1 : 0;
241 // no need for special end of paragraph check
242 refresh_.last = pos + 1;
244 needs_refresh_ = pos != -1;
247 void needsCompleteRefresh(SpellChecker::ChangeNumber change_number)
249 needs_refresh_ = true;
252 current_change_number_ = change_number;
255 typedef vector<SpellResultRange> Ranges;
256 typedef Ranges::const_iterator RangesIterator;
258 /// the area of the paragraph with pending spell check
261 /// spell state cache version number
262 SpellChecker::ChangeNumber current_change_number_;
265 void correctRangesAfterPos(pos_type pos, int offset)
267 RangesIterator et = ranges_.end();
268 Ranges::iterator it = ranges_.begin();
269 for (; it != et; ++it) {
270 it->shift(pos, offset);
276 /////////////////////////////////////////////////////////////////////
278 // Paragraph::Private
280 /////////////////////////////////////////////////////////////////////
282 class Paragraph::Private
286 Private(Paragraph * owner, Layout const & layout);
287 /// "Copy constructor"
288 Private(Private const &, Paragraph * owner);
289 /// Copy constructor from \p beg to \p end
290 Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
293 void insertChar(pos_type pos, char_type c, Change const & change);
295 /// Output the surrogate pair formed by \p c and \p next to \p os.
296 /// \return the number of characters written.
297 int latexSurrogatePair(otexstream & os, char_type c, char_type next,
298 OutputParams const &);
300 /// Output a space in appropriate formatting (or a surrogate pair
301 /// if the next character is a combining character).
302 /// \return whether a surrogate pair was output.
303 bool simpleTeXBlanks(OutputParams const &,
306 unsigned int & column,
308 Layout const & style);
310 /// Output consecutive unicode chars, belonging to the same script as
311 /// specified by the latex macro \p ltx, to \p os starting from \p i.
312 /// \return the number of characters written.
313 int writeScriptChars(otexstream & os, docstring const & ltx,
314 Change const &, Encoding const &, pos_type & i);
316 /// This could go to ParagraphParameters if we want to.
317 int startTeXParParams(BufferParams const &, otexstream &,
318 OutputParams const &) const;
320 /// This could go to ParagraphParameters if we want to.
321 bool endTeXParParams(BufferParams const &, otexstream &,
322 OutputParams const &) const;
325 void latexInset(BufferParams const &,
330 Font const & outerfont,
332 Change & running_change,
333 Layout const & style,
335 unsigned int & column);
338 void latexSpecialChar(
340 BufferParams const & bparams,
341 OutputParams const & runparams,
342 Font const & running_font,
343 Change const & running_change,
344 Layout const & style,
347 unsigned int & column);
354 unsigned int & column);
360 unsigned int & column);
362 bool latexSpecialTypewriter(
366 unsigned int & column);
368 bool latexSpecialPhrase(
372 unsigned int & column,
373 OutputParams const & runparams);
376 void validate(LaTeXFeatures & features) const;
378 /// Checks if the paragraph contains only text and no inset or font change.
379 bool onlyText(Buffer const & buf, Font const & outerfont,
380 pos_type initial) const;
382 /// match a string against a particular point in the paragraph
383 bool isTextAt(string const & str, pos_type pos) const;
385 /// a vector of speller skip positions
386 typedef vector<FontSpan> SkipPositions;
387 typedef SkipPositions::const_iterator SkipPositionsIterator;
389 void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
391 Language * getSpellLanguage(pos_type const from) const;
393 Language * locateSpellRange(pos_type & from, pos_type & to,
394 SkipPositions & skips) const;
396 bool hasSpellerChange() const
398 SpellChecker::ChangeNumber speller_change_number = 0;
399 if (theSpellChecker())
400 speller_change_number = theSpellChecker()->changeNumber();
401 return speller_change_number > speller_state_.currentChangeNumber();
404 bool ignoreWord(docstring const & word) const ;
406 void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
408 pos_type textsize = owner_->size();
409 // check for sane arguments
410 if (to <= from || from >= textsize)
412 FontSpan fp = FontSpan(from, to - 1);
413 speller_state_.setRange(fp, state);
416 void requestSpellCheck(pos_type pos)
419 speller_state_.needsCompleteRefresh(speller_state_.currentChangeNumber());
421 speller_state_.needsRefresh(pos);
424 void readySpellCheck()
426 speller_state_.needsRefresh(-1);
429 bool needsSpellCheck() const
431 return speller_state_.needsRefresh();
434 void rangeOfSpellCheck(pos_type & first, pos_type & last) const
436 speller_state_.refreshRange(first, last);
438 last = owner_->size();
441 pos_type endpos = last;
442 owner_->locateWord(first, endpos, WHOLE_WORD);
445 owner_->locateWord(last, endpos, WHOLE_WORD);
450 int countSkips(SkipPositionsIterator & it, SkipPositionsIterator const et,
454 while (it != et && it->first < start) {
455 int skip = it->last - it->first + 1;
463 void markMisspelledWords(pos_type const & first, pos_type const & last,
464 SpellChecker::Result result,
465 docstring const & word,
466 SkipPositions const & skips);
468 InsetCode ownerCode() const
470 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
473 /// Which Paragraph owns us?
477 Inset const * inset_owner_;
486 ParagraphParameters params_;
488 /// for recording and looking up changes
492 InsetList insetlist_;
495 pos_type begin_of_body_;
497 typedef docstring TextContainer;
501 typedef set<docstring> Words;
502 typedef map<Language, Words> LangWordsMap;
506 Layout const * layout_;
508 SpellCheckerState speller_state_;
514 struct special_phrase {
520 special_phrase const special_phrases[] = {
521 { "LyX", from_ascii("\\LyX{}"), false },
522 { "TeX", from_ascii("\\TeX{}"), true },
523 { "LaTeX2e", from_ascii("\\LaTeXe{}"), true },
524 { "LaTeX", from_ascii("\\LaTeX{}"), true },
527 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
532 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
533 : owner_(owner), inset_owner_(0), id_(-1), begin_of_body_(0), layout_(&layout)
539 // Initialization of the counter for the paragraph id's,
541 // FIXME: There should be a more intelligent way to generate and use the
542 // paragraph ids per buffer instead a global static counter for all InsetText
543 // in the running program.
544 static int paragraph_id = -1;
546 Paragraph::Private::Private(Private const & p, Paragraph * owner)
547 : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
548 params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
549 begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
552 id_ = ++paragraph_id;
553 requestSpellCheck(p.text_.size());
557 Paragraph::Private::Private(Private const & p, Paragraph * owner,
558 pos_type beg, pos_type end)
559 : owner_(owner), inset_owner_(p.inset_owner_),
560 params_(p.params_), changes_(p.changes_),
561 insetlist_(p.insetlist_, beg, end),
562 begin_of_body_(p.begin_of_body_), words_(p.words_),
565 id_ = ++paragraph_id;
566 if (beg >= pos_type(p.text_.size()))
568 text_ = p.text_.substr(beg, end - beg);
570 FontList::const_iterator fcit = fontlist_.begin();
571 FontList::const_iterator fend = fontlist_.end();
572 for (; fcit != fend; ++fcit) {
573 if (fcit->pos() < beg)
575 if (fcit->pos() >= end) {
576 // Add last entry in the fontlist_.
577 fontlist_.set(text_.size() - 1, fcit->font());
580 // Add a new entry in the fontlist_.
581 fontlist_.set(fcit->pos() - beg, fcit->font());
583 requestSpellCheck(p.text_.size());
587 void Paragraph::addChangesToToc(DocIterator const & cdit,
588 Buffer const & buf) const
590 d->changes_.addToToc(cdit, buf);
594 bool Paragraph::isDeleted(pos_type start, pos_type end) const
596 LASSERT(start >= 0 && start <= size(), /**/);
597 LASSERT(end > start && end <= size() + 1, /**/);
599 return d->changes_.isDeleted(start, end);
603 bool Paragraph::isChanged(pos_type start, pos_type end) const
605 LASSERT(start >= 0 && start <= size(), /**/);
606 LASSERT(end > start && end <= size() + 1, /**/);
608 return d->changes_.isChanged(start, end);
612 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
614 // keep the logic here in sync with the logic of eraseChars()
618 Change const change = d->changes_.lookup(size());
619 return change.inserted() && change.currentAuthor();
623 void Paragraph::setChange(Change const & change)
625 // beware of the imaginary end-of-par character!
626 d->changes_.set(change, 0, size() + 1);
629 * Propagate the change recursively - but not in case of DELETED!
631 * Imagine that your co-author makes changes in an existing inset. He
632 * sends your document to you and you come to the conclusion that the
633 * inset should go completely. If you erase it, LyX must not delete all
634 * text within the inset. Otherwise, the change tracked insertions of
635 * your co-author get lost and there is no way to restore them later.
637 * Conclusion: An inset's content should remain untouched if you delete it
640 if (!change.deleted()) {
641 for (pos_type pos = 0; pos < size(); ++pos) {
642 if (Inset * inset = getInset(pos))
643 inset->setChange(change);
649 void Paragraph::setChange(pos_type pos, Change const & change)
651 LASSERT(pos >= 0 && pos <= size(), /**/);
652 d->changes_.set(change, pos);
654 // see comment in setChange(Change const &) above
655 if (!change.deleted() && pos < size())
656 if (Inset * inset = getInset(pos))
657 inset->setChange(change);
661 Change const & Paragraph::lookupChange(pos_type pos) const
663 LASSERT(pos >= 0 && pos <= size(), /**/);
664 return d->changes_.lookup(pos);
668 void Paragraph::acceptChanges(pos_type start, pos_type end)
670 LASSERT(start >= 0 && start <= size(), /**/);
671 LASSERT(end > start && end <= size() + 1, /**/);
673 for (pos_type pos = start; pos < end; ++pos) {
674 switch (lookupChange(pos).type) {
675 case Change::UNCHANGED:
676 // accept changes in nested inset
677 if (Inset * inset = getInset(pos))
678 inset->acceptChanges();
681 case Change::INSERTED:
682 d->changes_.set(Change(Change::UNCHANGED), pos);
683 // also accept changes in nested inset
684 if (Inset * inset = getInset(pos))
685 inset->acceptChanges();
688 case Change::DELETED:
689 // Suppress access to non-existent
690 // "end-of-paragraph char"
692 eraseChar(pos, false);
703 void Paragraph::rejectChanges(pos_type start, pos_type end)
705 LASSERT(start >= 0 && start <= size(), /**/);
706 LASSERT(end > start && end <= size() + 1, /**/);
708 for (pos_type pos = start; pos < end; ++pos) {
709 switch (lookupChange(pos).type) {
710 case Change::UNCHANGED:
711 // reject changes in nested inset
712 if (Inset * inset = getInset(pos))
713 inset->rejectChanges();
716 case Change::INSERTED:
717 // Suppress access to non-existent
718 // "end-of-paragraph char"
720 eraseChar(pos, false);
726 case Change::DELETED:
727 d->changes_.set(Change(Change::UNCHANGED), pos);
729 // Do NOT reject changes within a deleted inset!
730 // There may be insertions of a co-author inside of it!
738 void Paragraph::Private::insertChar(pos_type pos, char_type c,
739 Change const & change)
741 LASSERT(pos >= 0 && pos <= int(text_.size()), /**/);
744 changes_.insert(change, pos);
746 // This is actually very common when parsing buffers (and
747 // maybe inserting ascii text)
748 if (pos == pos_type(text_.size())) {
749 // when appending characters, no need to update tables
751 // but we want spell checking
752 requestSpellCheck(pos);
756 text_.insert(text_.begin() + pos, c);
758 // Update the font table.
759 fontlist_.increasePosAfterPos(pos);
762 insetlist_.increasePosAfterPos(pos);
764 // Update list of misspelled positions
765 speller_state_.increasePosAfterPos(pos);
769 bool Paragraph::insertInset(pos_type pos, Inset * inset,
770 Change const & change)
772 LASSERT(inset, /**/);
773 LASSERT(pos >= 0 && pos <= size(), /**/);
775 // Paragraph::insertInset() can be used in cut/copy/paste operation where
776 // d->inset_owner_ is not set yet.
777 if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
780 d->insertChar(pos, META_INSET, change);
781 LASSERT(d->text_[pos] == META_INSET, /**/);
783 // Add a new entry in the insetlist_.
784 d->insetlist_.insert(inset, pos);
786 // Some insets require run of spell checker
787 requestSpellCheck(pos);
792 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
794 LASSERT(pos >= 0 && pos <= size(), return false);
796 // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
799 Change change = d->changes_.lookup(pos);
801 // set the character to DELETED if
802 // a) it was previously unchanged or
803 // b) it was inserted by a co-author
805 if (!change.changed() ||
806 (change.inserted() && !change.currentAuthor())) {
807 setChange(pos, Change(Change::DELETED));
808 // request run of spell checker
809 requestSpellCheck(pos);
813 if (change.deleted())
817 // Don't physically access the imaginary end-of-paragraph character.
818 // eraseChar() can only mark it as DELETED. A physical deletion of
819 // end-of-par must be handled externally.
825 d->changes_.erase(pos);
827 // if it is an inset, delete the inset entry
828 if (d->text_[pos] == META_INSET)
829 d->insetlist_.erase(pos);
831 d->text_.erase(d->text_.begin() + pos);
833 // Update the fontlist_
834 d->fontlist_.erase(pos);
836 // Update the insetlist_
837 d->insetlist_.decreasePosAfterPos(pos);
839 // Update list of misspelled positions
840 d->speller_state_.decreasePosAfterPos(pos);
841 d->speller_state_.refreshLast(size());
847 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
849 LASSERT(start >= 0 && start <= size(), /**/);
850 LASSERT(end >= start && end <= size() + 1, /**/);
853 for (pos_type count = end - start; count; --count) {
854 if (!eraseChar(i, trackChanges))
861 int Paragraph::Private::latexSurrogatePair(otexstream & os, char_type c,
862 char_type next, OutputParams const & runparams)
864 // Writing next here may circumvent a possible font change between
865 // c and next. Since next is only output if it forms a surrogate pair
866 // with c we can ignore this:
867 // A font change inside a surrogate pair does not make sense and is
868 // hopefully impossible to input.
869 // FIXME: change tracking
870 // Is this correct WRT change tracking?
871 Encoding const & encoding = *(runparams.encoding);
872 docstring latex1 = encoding.latexChar(next).first;
873 if (runparams.inIPA) {
874 string const tipashortcut = Encodings::TIPAShortcut(next);
875 if (!tipashortcut.empty()) {
876 latex1 = from_ascii(tipashortcut);
879 docstring const latex2 = encoding.latexChar(c).first;
880 if (docstring(1, next) == latex1) {
881 // the encoding supports the combination
882 os << latex2 << latex1;
883 return latex1.length() + latex2.length();
884 } else if (runparams.local_font &&
885 runparams.local_font->language()->lang() == "polutonikogreek") {
886 // polutonikogreek only works without the brackets
887 os << latex1 << latex2;
888 return latex1.length() + latex2.length();
890 os << latex1 << '{' << latex2 << '}';
891 return latex1.length() + latex2.length() + 2;
895 bool Paragraph::Private::simpleTeXBlanks(OutputParams const & runparams,
898 unsigned int & column,
900 Layout const & style)
902 if (style.pass_thru || runparams.pass_thru)
905 if (i + 1 < int(text_.size())) {
906 char_type next = text_[i + 1];
907 if (Encodings::isCombiningChar(next)) {
908 // This space has an accent, so we must always output it.
909 column += latexSurrogatePair(os, ' ', next, runparams) - 1;
914 if (runparams.linelen > 0
915 && column > runparams.linelen
917 && text_[i - 1] != ' '
918 && (i + 1 < int(text_.size()))
919 // same in FreeSpacing mode
920 && !owner_->isFreeSpacing()
921 // In typewriter mode, we want to avoid
922 // ! . ? : at the end of a line
923 && !(font.fontInfo().family() == TYPEWRITER_FAMILY
924 && (text_[i - 1] == '.'
925 || text_[i - 1] == '?'
926 || text_[i - 1] == ':'
927 || text_[i - 1] == '!'))) {
929 os.texrow().start(owner_->id(), i + 1);
931 } else if (style.free_spacing) {
940 int Paragraph::Private::writeScriptChars(otexstream & os,
941 docstring const & ltx,
942 Change const & runningChange,
943 Encoding const & encoding,
946 // FIXME: modifying i here is not very nice...
948 // We only arrive here when a proper language for character text_[i] has
949 // not been specified (i.e., it could not be translated in the current
950 // latex encoding) or its latex translation has been forced, and it
951 // belongs to a known script.
952 // Parameter ltx contains the latex translation of text_[i] as specified
953 // in the unicodesymbols file and is something like "\textXXX{<spec>}".
954 // The latex macro name "textXXX" specifies the script to which text_[i]
955 // belongs and we use it in order to check whether characters from the
956 // same script immediately follow, such that we can collect them in a
957 // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
958 // for the first char but only "<spec>" for all subsequent chars.
959 docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
960 docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
961 string script = to_ascii(ltx.substr(1, brace1 - 1));
964 bool closing_brace = true;
965 if (script == "textgreek" && encoding.latexName() == "iso-8859-7") {
966 // Correct encoding is being used, so we can avoid \textgreek.
969 closing_brace = false;
971 os << ltx.substr(pos, length);
972 int size = text_.size();
973 while (i + 1 < size) {
974 char_type const next = text_[i + 1];
975 // Stop here if next character belongs to another script
976 // or there is a change in change tracking status.
977 if (!Encodings::isKnownScriptChar(next, script) ||
978 runningChange != owner_->lookupChange(i + 1))
982 FontList::const_iterator cit = fontlist_.begin();
983 FontList::const_iterator end = fontlist_.end();
984 for (; cit != end; ++cit) {
985 if (cit->pos() >= i && !found) {
986 prev_font = cit->font();
989 if (cit->pos() >= i + 1)
992 // Stop here if there is a font attribute or encoding change.
993 if (found && cit != end && prev_font != cit->font())
995 docstring const latex = encoding.latexChar(next).first;
996 docstring::size_type const b1 =
997 latex.find_first_of(from_ascii("{"));
998 docstring::size_type const b2 =
999 latex.find_last_of(from_ascii("}"));
1000 int const len = b2 - b1 - 1;
1001 os << latex.substr(b1 + 1, len);
1005 if (closing_brace) {
1013 bool Paragraph::Private::isTextAt(string const & str, pos_type pos) const
1015 pos_type const len = str.length();
1017 // is the paragraph large enough?
1018 if (pos + len > int(text_.size()))
1021 // does the wanted text start at point?
1022 for (string::size_type i = 0; i < str.length(); ++i) {
1023 // Caution: direct comparison of characters works only
1024 // because str is pure ASCII.
1025 if (str[i] != text_[pos + i])
1029 return fontlist_.hasChangeInRange(pos, len);
1033 void Paragraph::Private::latexInset(BufferParams const & bparams,
1035 OutputParams & runparams,
1036 Font & running_font,
1038 Font const & outerfont,
1040 Change & running_change,
1041 Layout const & style,
1043 unsigned int & column)
1045 Inset * inset = owner_->getInset(i);
1046 LASSERT(inset, /**/);
1048 if (style.pass_thru) {
1049 inset->plaintext(os.os(), runparams);
1053 // FIXME: move this to InsetNewline::latex
1054 if (inset->lyxCode() == NEWLINE_CODE) {
1055 // newlines are handled differently here than
1056 // the default in simpleTeXSpecialChars().
1057 if (!style.newline_allowed) {
1061 column += running_font.latexWriteEndChanges(
1062 os, bparams, runparams,
1063 basefont, basefont);
1067 if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
1070 basefont = owner_->getLayoutFont(bparams, outerfont);
1071 running_font = basefont;
1073 if (runparams.moving_arg)
1077 os.texrow().start(owner_->id(), i + 1);
1081 if (owner_->isDeleted(i)) {
1082 if( ++runparams.inDeletedInset == 1)
1083 runparams.changeOfDeletedInset = owner_->lookupChange(i);
1086 if (inset->canTrackChanges()) {
1087 column += Changes::latexMarkChange(os, bparams, running_change,
1088 Change(Change::UNCHANGED), runparams);
1089 running_change = Change(Change::UNCHANGED);
1093 odocstream::pos_type const len = os.os().tellp();
1095 if (inset->forceLTR()
1096 && !runparams.use_polyglossia
1097 && running_font.isRightToLeft()
1098 // ERT is an exception, it should be output with no
1099 // decorations at all
1100 && inset->lyxCode() != ERT_CODE) {
1101 if (running_font.language()->lang() == "farsi")
1108 // FIXME: Bug: we can have an empty font change here!
1109 // if there has just been a font change, we are going to close it
1110 // right now, which means stupid latex code like \textsf{}. AFAIK,
1111 // this does not harm dvi output. A minor bug, thus (JMarc)
1113 // Some insets cannot be inside a font change command.
1114 // However, even such insets *can* be placed in \L or \R
1115 // or their equivalents (for RTL language switches), so we don't
1116 // close the language in those cases.
1117 // ArabTeX, though, cannot handle this special behavior, it seems.
1118 bool arabtex = basefont.language()->lang() == "arabic_arabtex"
1119 || running_font.language()->lang() == "arabic_arabtex";
1120 if (open_font && !inset->inheritFont()) {
1121 bool closeLanguage = arabtex
1122 || basefont.isRightToLeft() == running_font.isRightToLeft();
1123 unsigned int count = running_font.latexWriteEndChanges(os,
1124 bparams, runparams, basefont, basefont, closeLanguage);
1126 // if any font properties were closed, update the running_font,
1127 // making sure, however, to leave the language as it was
1129 // FIXME: probably a better way to keep track of the old
1130 // language, than copying the entire font?
1131 Font const copy_font(running_font);
1132 basefont = owner_->getLayoutFont(bparams, outerfont);
1133 running_font = basefont;
1135 running_font.setLanguage(copy_font.language());
1136 // leave font open if language is still open
1137 open_font = (running_font.language() == basefont.language());
1139 runparams.local_font = &basefont;
1143 int prev_rows = os.texrow().rows();
1146 runparams.lastid = id_;
1147 runparams.lastpos = i;
1148 inset->latex(os, runparams);
1149 } catch (EncodingException & e) {
1150 // add location information and throw again.
1157 if (running_font.language()->lang() == "farsi")
1163 if (os.texrow().rows() > prev_rows) {
1164 os.texrow().start(owner_->id(), i + 1);
1167 column += (unsigned int)(os.os().tellp() - len);
1170 if (owner_->isDeleted(i))
1171 --runparams.inDeletedInset;
1175 void Paragraph::Private::latexSpecialChar(otexstream & os,
1176 BufferParams const & bparams,
1177 OutputParams const & runparams,
1178 Font const & running_font,
1179 Change const & running_change,
1180 Layout const & style,
1183 unsigned int & column)
1185 // With polyglossia, brackets and stuff need not be reversed
1186 // in RTL scripts (see bug #8251)
1187 char_type const c = (runparams.use_polyglossia) ?
1188 owner_->getUChar(bparams, i) : text_[i];
1190 if (style.pass_thru || runparams.pass_thru) {
1192 Encoding const * const enc = runparams.encoding;
1193 if (enc && !enc->encodable(c))
1194 throw EncodingException(c);
1200 // TIPA uses its own T3 encoding
1201 if (runparams.inIPA && latexSpecialT3(c, os, i, column))
1203 // If T1 font encoding is used, use the special
1204 // characters it provides.
1205 // NOTE: some languages reset the font encoding
1207 if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1208 && lyxrc.fontenc == "T1" && latexSpecialT1(c, os, i, column))
1211 // \tt font needs special treatment
1212 if (!runparams.inIPA
1213 && running_font.fontInfo().family() == TYPEWRITER_FAMILY
1214 && latexSpecialTypewriter(c, os, i, column))
1217 // Otherwise, we use what LaTeX provides us.
1220 os << "\\textbackslash{}";
1224 os << "\\textless{}";
1228 os << "\\textgreater{}";
1232 os << "\\textbar{}";
1239 os << "\\char`\\\"{}";
1244 case '%': case '#': case '{':
1252 os << "\\textasciitilde{}";
1257 os << "\\textasciicircum{}";
1264 // avoid being mistaken for optional arguments
1272 // Blanks are printed before font switching.
1273 // Sure? I am not! (try nice-latex)
1274 // I am sure it's correct. LyX might be smarter
1275 // in the future, but for now, nothing wrong is
1281 if (latexSpecialPhrase(os, i, end_pos, column, runparams))
1287 Encoding const & encoding = *(runparams.encoding);
1288 char_type next = '\0';
1289 if (i + 1 < int(text_.size())) {
1290 next = text_[i + 1];
1291 if (Encodings::isCombiningChar(next)) {
1292 column += latexSurrogatePair(os, c, next, runparams) - 1;
1298 pair<docstring, bool> latex = encoding.latexChar(c);
1299 docstring nextlatex;
1300 bool nexttipas = false;
1301 string nexttipashortcut;
1302 if (next != '\0' && next != META_INSET) {
1303 nextlatex = encoding.latexChar(next).first;
1304 if (runparams.inIPA) {
1305 nexttipashortcut = Encodings::TIPAShortcut(next);
1306 nexttipas = !nexttipashortcut.empty();
1310 if (runparams.inIPA) {
1311 string const tipashortcut = Encodings::TIPAShortcut(c);
1312 if (!tipashortcut.empty()) {
1313 latex.first = from_ascii(tipashortcut);
1314 latex.second = false;
1318 if (Encodings::isKnownScriptChar(c, script)
1319 && prefixIs(latex.first, from_ascii("\\" + script)))
1320 column += writeScriptChars(os, latex.first,
1321 running_change, encoding, i) - 1;
1322 else if (latex.second
1323 && ((!prefixIs(nextlatex, '\\')
1324 && !prefixIs(nextlatex, '{')
1325 && !prefixIs(nextlatex, '}'))
1327 && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1329 // Prevent eating of a following
1330 // space or command corruption by
1331 // following characters
1332 if (next == ' ' || next == '\0') {
1333 column += latex.first.length() + 1;
1334 os << latex.first << "{}";
1336 column += latex.first.length();
1337 os << latex.first << " ";
1340 column += latex.first.length() - 1;
1348 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1349 pos_type i, unsigned int & column)
1355 // In T1 encoding, these characters exist
1356 // but we should avoid ligatures
1357 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1359 os << "\\textcompwordmark{}";
1366 // soul.sty breaks with \char`\"
1367 os << "\\textquotedbl{}";
1376 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1377 pos_type /*i*/, unsigned int & column)
1387 os << "\\textvertline{}";
1396 bool Paragraph::Private::latexSpecialTypewriter(char_type const c, otexstream & os,
1397 pos_type i, unsigned int & column)
1401 // within \ttfamily, "--" is merged to "-" (no endash)
1402 // so we avoid this rather irritating ligature
1403 if (i + 1 < int(text_.size()) && text_[i + 1] == '-') {
1410 // everything else has to be checked separately
1411 // (depending on the encoding)
1419 /// If [start_pos, end_pos) does not include entirely the special phrase, then
1420 /// do not apply the macro transformation.
1421 bool Paragraph::Private::latexSpecialPhrase(otexstream & os, pos_type & i, pos_type end_pos,
1422 unsigned int & column, OutputParams const & runparams)
1424 // FIXME: if we have "LaTeX" with a font
1425 // change in the middle (before the 'T', then
1426 // the "TeX" part is still special cased.
1427 // Really we should only operate this on
1428 // "words" for some definition of word
1430 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1431 if (!isTextAt(special_phrases[pnr].phrase, i)
1432 || (end_pos != -1 && i + int(special_phrases[pnr].phrase.size()) > end_pos))
1434 if (runparams.moving_arg)
1436 os << special_phrases[pnr].macro;
1437 i += special_phrases[pnr].phrase.length() - 1;
1438 column += special_phrases[pnr].macro.length() - 1;
1445 void Paragraph::Private::validate(LaTeXFeatures & features) const
1447 if (layout_->inpreamble && inset_owner_) {
1448 bool const is_command = layout_->latextype == LATEX_COMMAND;
1449 Buffer const & buf = inset_owner_->buffer();
1450 BufferParams const & bp = buf.params();
1453 // Using a string stream here circumvents the encoding
1454 // switching machinery of odocstream. Therefore the
1455 // output is wrong if this paragraph contains content
1456 // that needs to switch encoding.
1457 odocstringstream ods;
1458 otexstream os(ods, texrow);
1460 os << '\\' << from_ascii(layout_->latexname());
1461 // we have to provide all the optional arguments here, even though
1462 // the last one is the only one we care about.
1463 // Separate handling of optional argument inset.
1464 if (!layout_->latexargs().empty()) {
1465 OutputParams rp = features.runparams();
1466 rp.local_font = &owner_->getFirstFontSettings(bp);
1467 latexArgInsets(*owner_, os, rp, layout_->latexargs());
1469 os << from_ascii(layout_->latexparam());
1471 docstring::size_type const length = ods.str().length();
1472 // this will output "{" at the beginning, but not at the end
1473 owner_->latex(bp, f, os, features.runparams(), 0, -1, true);
1474 if (ods.str().length() > length) {
1477 if (!layout_->postcommandargs().empty()) {
1478 OutputParams rp = features.runparams();
1479 rp.local_font = &owner_->getFirstFontSettings(bp);
1480 latexArgInsets(*owner_, os, rp, layout_->postcommandargs(), "post:");
1483 string const snippet = to_utf8(ods.str());
1484 features.addPreambleSnippet(snippet);
1488 if (features.runparams().flavor == OutputParams::HTML
1489 && layout_->htmltitle()) {
1490 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1493 // check the params.
1494 if (!params_.spacing().isDefault())
1495 features.require("setspace");
1498 features.useLayout(layout_->name());
1501 fontlist_.validate(features);
1503 // then the indentation
1504 if (!params_.leftIndent().zero())
1505 features.require("ParagraphLeftIndent");
1508 InsetList::const_iterator icit = insetlist_.begin();
1509 InsetList::const_iterator iend = insetlist_.end();
1510 for (; icit != iend; ++icit) {
1512 icit->inset->validate(features);
1513 if (layout_->needprotect &&
1514 icit->inset->lyxCode() == FOOT_CODE)
1515 features.require("NeedLyXFootnoteCode");
1519 // then the contents
1520 for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1521 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
1522 if (!special_phrases[pnr].builtin
1523 && isTextAt(special_phrases[pnr].phrase, i)) {
1524 features.require(special_phrases[pnr].phrase);
1528 Encodings::validate(text_[i], features);
1532 /////////////////////////////////////////////////////////////////////
1536 /////////////////////////////////////////////////////////////////////
1539 Layout const emptyParagraphLayout;
1542 Paragraph::Paragraph()
1543 : d(new Paragraph::Private(this, emptyParagraphLayout))
1550 Paragraph::Paragraph(Paragraph const & par)
1551 : itemdepth(par.itemdepth),
1552 d(new Paragraph::Private(*par.d, this))
1558 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1559 : itemdepth(par.itemdepth),
1560 d(new Paragraph::Private(*par.d, this, beg, end))
1566 Paragraph & Paragraph::operator=(Paragraph const & par)
1568 // needed as we will destroy the private part before copying it
1570 itemdepth = par.itemdepth;
1574 d = new Private(*par.d, this);
1581 Paragraph::~Paragraph()
1590 // this shall be called just before every "os << ..." action.
1591 void flushString(ostream & os, docstring & s)
1600 void Paragraph::write(ostream & os, BufferParams const & bparams,
1601 depth_type & dth) const
1603 // The beginning or end of a deeper (i.e. nested) area?
1604 if (dth != d->params_.depth()) {
1605 if (d->params_.depth() > dth) {
1606 while (d->params_.depth() > dth) {
1607 os << "\n\\begin_deeper";
1611 while (d->params_.depth() < dth) {
1612 os << "\n\\end_deeper";
1618 // First write the layout
1619 os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1621 d->params_.write(os);
1623 Font font1(inherit_font, bparams.language);
1625 Change running_change = Change(Change::UNCHANGED);
1627 // this string is used as a buffer to avoid repetitive calls
1628 // to to_utf8(), which turn out to be expensive (JMarc)
1629 docstring write_buffer;
1632 for (pos_type i = 0; i <= size(); ++i) {
1634 Change const change = lookupChange(i);
1635 if (change != running_change)
1636 flushString(os, write_buffer);
1637 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1638 running_change = change;
1643 // Write font changes
1644 Font font2 = getFontSettings(bparams, i);
1645 if (font2 != font1) {
1646 flushString(os, write_buffer);
1647 font2.lyxWriteChanges(font1, os);
1652 char_type const c = d->text_[i];
1655 if (Inset const * inset = getInset(i)) {
1656 flushString(os, write_buffer);
1657 if (inset->directWrite()) {
1658 // international char, let it write
1659 // code directly so it's shorter in
1665 os << "\\begin_inset ";
1667 os << "\n\\end_inset\n\n";
1673 flushString(os, write_buffer);
1674 os << "\n\\backslash\n";
1678 flushString(os, write_buffer);
1679 if (i + 1 < size() && d->text_[i + 1] == ' ') {
1686 if ((column > 70 && c == ' ')
1688 flushString(os, write_buffer);
1692 // this check is to amend a bug. LyX sometimes
1693 // inserts '\0' this could cause problems.
1695 write_buffer.push_back(c);
1697 LYXERR0("NUL char in structure.");
1703 flushString(os, write_buffer);
1704 os << "\n\\end_layout\n";
1708 void Paragraph::validate(LaTeXFeatures & features) const
1710 d->validate(features);
1714 void Paragraph::insert(pos_type start, docstring const & str,
1715 Font const & font, Change const & change)
1717 for (size_t i = 0, n = str.size(); i != n ; ++i)
1718 insertChar(start + i, str[i], font, change);
1722 void Paragraph::appendChar(char_type c, Font const & font,
1723 Change const & change)
1726 d->changes_.insert(change, d->text_.size());
1727 // when appending characters, no need to update tables
1728 d->text_.push_back(c);
1729 setFont(d->text_.size() - 1, font);
1730 d->requestSpellCheck(d->text_.size() - 1);
1734 void Paragraph::appendString(docstring const & s, Font const & font,
1735 Change const & change)
1737 pos_type end = s.size();
1738 size_t oldsize = d->text_.size();
1739 size_t newsize = oldsize + end;
1740 size_t capacity = d->text_.capacity();
1741 if (newsize >= capacity)
1742 d->text_.reserve(max(capacity + 100, newsize));
1744 // when appending characters, no need to update tables
1747 // FIXME: Optimize this!
1748 for (size_t i = oldsize; i != newsize; ++i) {
1750 d->changes_.insert(change, i);
1751 d->requestSpellCheck(i);
1753 d->fontlist_.set(oldsize, font);
1754 d->fontlist_.set(newsize - 1, font);
1758 void Paragraph::insertChar(pos_type pos, char_type c,
1761 d->insertChar(pos, c, Change(trackChanges ?
1762 Change::INSERTED : Change::UNCHANGED));
1766 void Paragraph::insertChar(pos_type pos, char_type c,
1767 Font const & font, bool trackChanges)
1769 d->insertChar(pos, c, Change(trackChanges ?
1770 Change::INSERTED : Change::UNCHANGED));
1775 void Paragraph::insertChar(pos_type pos, char_type c,
1776 Font const & font, Change const & change)
1778 d->insertChar(pos, c, change);
1783 bool Paragraph::insertInset(pos_type pos, Inset * inset,
1784 Font const & font, Change const & change)
1786 bool const success = insertInset(pos, inset, change);
1787 // Set the font/language of the inset...
1793 void Paragraph::resetFonts(Font const & font)
1795 d->fontlist_.clear();
1796 d->fontlist_.set(0, font);
1797 d->fontlist_.set(d->text_.size() - 1, font);
1800 // Gets uninstantiated font setting at position.
1801 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1805 LYXERR0("pos: " << pos << " size: " << size());
1806 LASSERT(pos <= size(), /**/);
1809 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1810 if (cit != d->fontlist_.end())
1813 if (pos == size() && !empty())
1814 return getFontSettings(bparams, pos - 1);
1816 // Optimisation: avoid a full font instantiation if there is no
1817 // language change from previous call.
1818 static Font previous_font;
1819 static Language const * previous_lang = 0;
1820 Language const * lang = getParLanguage(bparams);
1821 if (lang != previous_lang) {
1822 previous_lang = lang;
1823 previous_font = Font(inherit_font, lang);
1825 return previous_font;
1829 FontSpan Paragraph::fontSpan(pos_type pos) const
1831 LASSERT(pos <= size(), /**/);
1834 FontList::const_iterator cit = d->fontlist_.begin();
1835 FontList::const_iterator end = d->fontlist_.end();
1836 for (; cit != end; ++cit) {
1837 if (cit->pos() >= pos) {
1838 if (pos >= beginOfBody())
1839 return FontSpan(max(start, beginOfBody()),
1842 return FontSpan(start,
1843 min(beginOfBody() - 1,
1846 start = cit->pos() + 1;
1849 // This should not happen, but if so, we take no chances.
1850 // LYXERR0("Paragraph::getEndPosOfFontSpan: This should not happen!");
1851 return FontSpan(pos, pos);
1855 // Gets uninstantiated font setting at position 0
1856 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1858 if (!empty() && !d->fontlist_.empty())
1859 return d->fontlist_.begin()->font();
1861 // Optimisation: avoid a full font instantiation if there is no
1862 // language change from previous call.
1863 static Font previous_font;
1864 static Language const * previous_lang = 0;
1865 if (bparams.language != previous_lang) {
1866 previous_lang = bparams.language;
1867 previous_font = Font(inherit_font, bparams.language);
1870 return previous_font;
1874 // Gets the fully instantiated font at a given position in a paragraph
1875 // This is basically the same function as Text::GetFont() in text2.cpp.
1876 // The difference is that this one is used for generating the LaTeX file,
1877 // and thus cosmetic "improvements" are disallowed: This has to deliver
1878 // the true picture of the buffer. (Asger)
1879 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1880 Font const & outerfont) const
1882 LASSERT(pos >= 0, /**/);
1884 Font font = getFontSettings(bparams, pos);
1886 pos_type const body_pos = beginOfBody();
1887 FontInfo & fi = font.fontInfo();
1889 fi.realize(d->layout_->labelfont);
1891 fi.realize(d->layout_->font);
1893 fi.realize(outerfont.fontInfo());
1894 fi.realize(bparams.getFont().fontInfo());
1900 Font const Paragraph::getLabelFont
1901 (BufferParams const & bparams, Font const & outerfont) const
1903 FontInfo tmpfont = d->layout_->labelfont;
1904 tmpfont.realize(outerfont.fontInfo());
1905 tmpfont.realize(bparams.getFont().fontInfo());
1906 return Font(tmpfont, getParLanguage(bparams));
1910 Font const Paragraph::getLayoutFont
1911 (BufferParams const & bparams, Font const & outerfont) const
1913 FontInfo tmpfont = d->layout_->font;
1914 tmpfont.realize(outerfont.fontInfo());
1915 tmpfont.realize(bparams.getFont().fontInfo());
1916 return Font(tmpfont, getParLanguage(bparams));
1920 /// Returns the height of the highest font in range
1921 FontSize Paragraph::highestFontInRange
1922 (pos_type startpos, pos_type endpos, FontSize def_size) const
1924 return d->fontlist_.highestInRange(startpos, endpos, def_size);
1928 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1930 char_type c = d->text_[pos];
1931 if (!lyxrc.rtl_support || !getFontSettings(bparams, pos).isRightToLeft())
1934 // FIXME: The arabic special casing is due to the difference of arabic
1935 // round brackets input introduced in r18599. Check if this should be
1936 // unified with Hebrew or at least if all bracket types should be
1937 // handled the same (file format change in either case).
1938 string const & lang = getFontSettings(bparams, pos).language()->lang();
1939 bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi"
1944 uc = arabic ? c : ')';
1947 uc = arabic ? c : '(';
1973 void Paragraph::setFont(pos_type pos, Font const & font)
1975 LASSERT(pos <= size(), /**/);
1977 // First, reduce font against layout/label font
1978 // Update: The setCharFont() routine in text2.cpp already
1979 // reduces font, so we don't need to do that here. (Asger)
1981 d->fontlist_.set(pos, font);
1985 void Paragraph::makeSameLayout(Paragraph const & par)
1987 d->layout_ = par.d->layout_;
1988 d->params_ = par.d->params_;
1992 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1994 if (isFreeSpacing())
2000 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
2001 if (eraseChar(pos, trackChanges))
2007 return count > 0 || pos > 0;
2011 bool Paragraph::hasSameLayout(Paragraph const & par) const
2013 return par.d->layout_ == d->layout_
2014 && d->params_.sameLayout(par.d->params_);
2018 depth_type Paragraph::getDepth() const
2020 return d->params_.depth();
2024 depth_type Paragraph::getMaxDepthAfter() const
2026 if (d->layout_->isEnvironment())
2027 return d->params_.depth() + 1;
2029 return d->params_.depth();
2033 char Paragraph::getAlign() const
2035 if (d->params_.align() == LYX_ALIGN_LAYOUT)
2036 return d->layout_->align;
2038 return d->params_.align();
2042 docstring const & Paragraph::labelString() const
2044 return d->params_.labelString();
2048 // the next two functions are for the manual labels
2049 docstring const Paragraph::getLabelWidthString() const
2051 if (d->layout_->margintype == MARGIN_MANUAL
2052 || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
2053 return d->params_.labelWidthString();
2055 return _("Senseless with this layout!");
2059 void Paragraph::setLabelWidthString(docstring const & s)
2061 d->params_.labelWidthString(s);
2065 docstring Paragraph::expandLabel(Layout const & layout,
2066 BufferParams const & bparams) const
2068 return expandParagraphLabel(layout, bparams, true);
2072 docstring Paragraph::expandDocBookLabel(Layout const & layout,
2073 BufferParams const & bparams) const
2075 return expandParagraphLabel(layout, bparams, false);
2079 docstring Paragraph::expandParagraphLabel(Layout const & layout,
2080 BufferParams const & bparams, bool process_appendix) const
2082 DocumentClass const & tclass = bparams.documentClass();
2083 string const & lang = getParLanguage(bparams)->code();
2084 bool const in_appendix = process_appendix && d->params_.appendix();
2085 docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
2087 if (fmt.empty() && !layout.counter.empty())
2088 return tclass.counters().theCounter(layout.counter, lang);
2090 // handle 'inherited level parts' in 'fmt',
2091 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
2092 size_t const i = fmt.find('@', 0);
2093 if (i != docstring::npos) {
2094 size_t const j = fmt.find('@', i + 1);
2095 if (j != docstring::npos) {
2096 docstring parent(fmt, i + 1, j - i - 1);
2097 docstring label = from_ascii("??");
2098 if (tclass.hasLayout(parent))
2099 docstring label = expandParagraphLabel(tclass[parent], bparams,
2101 fmt = docstring(fmt, 0, i) + label
2102 + docstring(fmt, j + 1, docstring::npos);
2106 return tclass.counters().counterLabel(fmt, lang);
2110 void Paragraph::applyLayout(Layout const & new_layout)
2112 d->layout_ = &new_layout;
2113 LyXAlignment const oldAlign = d->params_.align();
2115 if (!(oldAlign & d->layout_->alignpossible)) {
2116 frontend::Alert::warning(_("Alignment not permitted"),
2117 _("The new layout does not permit the alignment previously used.\nSetting to default."));
2118 d->params_.align(LYX_ALIGN_LAYOUT);
2123 pos_type Paragraph::beginOfBody() const
2125 return d->begin_of_body_;
2129 void Paragraph::setBeginOfBody()
2131 if (d->layout_->labeltype != LABEL_MANUAL) {
2132 d->begin_of_body_ = 0;
2136 // Unroll the first two cycles of the loop
2137 // and remember the previous character to
2138 // remove unnecessary getChar() calls
2140 pos_type end = size();
2141 if (i < end && !isNewline(i)) {
2143 char_type previous_char = 0;
2146 previous_char = d->text_[i];
2147 if (!isNewline(i)) {
2149 while (i < end && previous_char != ' ') {
2154 previous_char = temp;
2160 d->begin_of_body_ = i;
2164 bool Paragraph::allowParagraphCustomization() const
2166 return inInset().allowParagraphCustomization();
2170 bool Paragraph::usePlainLayout() const
2172 return inInset().usePlainLayout();
2176 bool Paragraph::isPassThru() const
2178 return inInset().isPassThru() || d->layout_->pass_thru;
2183 // paragraphs inside floats need different alignment tags to avoid
2186 bool noTrivlistCentering(InsetCode code)
2188 return code == FLOAT_CODE
2189 || code == WRAP_CODE
2190 || code == CELL_CODE;
2194 string correction(string const & orig)
2196 if (orig == "flushleft")
2197 return "raggedright";
2198 if (orig == "flushright")
2199 return "raggedleft";
2200 if (orig == "center")
2206 string const corrected_env(string const & suffix, string const & env,
2207 InsetCode code, bool const lastpar)
2209 string output = suffix + "{";
2210 if (noTrivlistCentering(code)) {
2212 // the last paragraph in non-trivlist-aligned
2213 // context is special (to avoid unwanted whitespace)
2214 if (suffix == "\\begin")
2215 return "\\" + correction(env) + "{}";
2218 output += correction(env);
2222 if (suffix == "\\begin")
2228 void adjust_column(string const & str, int & column)
2230 if (!contains(str, "\n"))
2231 column += str.size();
2234 column = rsplit(str, tmp, '\n').size();
2241 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2242 otexstream & os, OutputParams const & runparams) const
2246 if (params_.noindent() && !layout_->pass_thru) {
2247 os << "\\noindent ";
2251 LyXAlignment const curAlign = params_.align();
2253 if (curAlign == layout_->align)
2257 case LYX_ALIGN_NONE:
2258 case LYX_ALIGN_BLOCK:
2259 case LYX_ALIGN_LAYOUT:
2260 case LYX_ALIGN_SPECIAL:
2261 case LYX_ALIGN_DECIMAL:
2263 case LYX_ALIGN_LEFT:
2264 case LYX_ALIGN_RIGHT:
2265 case LYX_ALIGN_CENTER:
2266 if (runparams.moving_arg) {
2273 string const begin_tag = "\\begin";
2274 InsetCode code = ownerCode();
2275 bool const lastpar = runparams.isLastPar;
2278 case LYX_ALIGN_NONE:
2279 case LYX_ALIGN_BLOCK:
2280 case LYX_ALIGN_LAYOUT:
2281 case LYX_ALIGN_SPECIAL:
2282 case LYX_ALIGN_DECIMAL:
2284 case LYX_ALIGN_LEFT: {
2286 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2287 output = corrected_env(begin_tag, "flushleft", code, lastpar);
2289 output = corrected_env(begin_tag, "flushright", code, lastpar);
2290 os << from_ascii(output);
2291 adjust_column(output, column);
2293 } case LYX_ALIGN_RIGHT: {
2295 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2296 output = corrected_env(begin_tag, "flushright", code, lastpar);
2298 output = corrected_env(begin_tag, "flushleft", code, lastpar);
2299 os << from_ascii(output);
2300 adjust_column(output, column);
2302 } case LYX_ALIGN_CENTER: {
2304 output = corrected_env(begin_tag, "center", code, lastpar);
2305 os << from_ascii(output);
2306 adjust_column(output, column);
2315 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2316 otexstream & os, OutputParams const & runparams) const
2318 LyXAlignment const curAlign = params_.align();
2320 if (curAlign == layout_->align)
2324 case LYX_ALIGN_NONE:
2325 case LYX_ALIGN_BLOCK:
2326 case LYX_ALIGN_LAYOUT:
2327 case LYX_ALIGN_SPECIAL:
2328 case LYX_ALIGN_DECIMAL:
2330 case LYX_ALIGN_LEFT:
2331 case LYX_ALIGN_RIGHT:
2332 case LYX_ALIGN_CENTER:
2333 if (runparams.moving_arg)
2339 string const end_tag = "\n\\par\\end";
2340 InsetCode code = ownerCode();
2341 bool const lastpar = runparams.isLastPar;
2344 case LYX_ALIGN_NONE:
2345 case LYX_ALIGN_BLOCK:
2346 case LYX_ALIGN_LAYOUT:
2347 case LYX_ALIGN_SPECIAL:
2348 case LYX_ALIGN_DECIMAL:
2350 case LYX_ALIGN_LEFT: {
2351 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2352 output = corrected_env(end_tag, "flushleft", code, lastpar);
2354 output = corrected_env(end_tag, "flushright", code, lastpar);
2355 os << from_ascii(output);
2357 } case LYX_ALIGN_RIGHT: {
2358 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2359 output = corrected_env(end_tag, "flushright", code, lastpar);
2361 output = corrected_env(end_tag, "flushleft", code, lastpar);
2362 os << from_ascii(output);
2364 } case LYX_ALIGN_CENTER: {
2365 output = corrected_env(end_tag, "center", code, lastpar);
2366 os << from_ascii(output);
2371 return !output.empty() || lastpar;
2375 // This one spits out the text of the paragraph
2376 void Paragraph::latex(BufferParams const & bparams,
2377 Font const & outerfont,
2379 OutputParams const & runparams,
2380 int start_pos, int end_pos, bool force) const
2382 LYXERR(Debug::LATEX, "Paragraph::latex... " << this);
2384 // FIXME This check should not be needed. Perhaps issue an
2385 // error if it triggers.
2386 Layout const & style = inInset().forcePlainLayout() ?
2387 bparams.documentClass().plainLayout() : *d->layout_;
2389 if (!force && style.inpreamble)
2392 bool const allowcust = allowParagraphCustomization();
2394 // Current base font for all inherited font changes, without any
2395 // change caused by an individual character, except for the language:
2396 // It is set to the language of the first character.
2397 // As long as we are in the label, this font is the base font of the
2398 // label. Before the first body character it is set to the base font
2402 // Maybe we have to create a optional argument.
2403 pos_type body_pos = beginOfBody();
2404 unsigned int column = 0;
2407 // the optional argument is kept in curly brackets in
2408 // case it contains a ']'
2409 // This is not strictly needed, but if this is changed it
2410 // would be a file format change, and tex2lyx would need
2411 // to be adjusted, since it unconditionally removes the
2412 // braces when it parses \item.
2415 basefont = getLabelFont(bparams, outerfont);
2417 basefont = getLayoutFont(bparams, outerfont);
2420 // Which font is currently active?
2421 Font running_font(basefont);
2422 // Do we have an open font change?
2423 bool open_font = false;
2425 Change runningChange = Change(Change::UNCHANGED);
2427 Encoding const * const prev_encoding = runparams.encoding;
2429 os.texrow().start(id(), 0);
2431 // if the paragraph is empty, the loop will not be entered at all
2433 if (style.isCommand()) {
2437 if (!style.leftdelim().empty()) {
2438 os << style.leftdelim();
2439 column += style.leftdelim().size();
2442 column += d->startTeXParParams(bparams, os, runparams);
2445 for (pos_type i = 0; i < size(); ++i) {
2446 // First char in paragraph or after label?
2447 if (i == body_pos) {
2450 column += running_font.latexWriteEndChanges(
2451 os, bparams, runparams,
2452 basefont, basefont);
2455 basefont = getLayoutFont(bparams, outerfont);
2456 running_font = basefont;
2458 column += Changes::latexMarkChange(os, bparams,
2459 runningChange, Change(Change::UNCHANGED),
2461 runningChange = Change(Change::UNCHANGED);
2466 if (style.isCommand()) {
2471 if (!style.leftdelim().empty()) {
2472 os << style.leftdelim();
2473 column += style.leftdelim().size();
2477 column += d->startTeXParParams(bparams, os,
2481 Change const & change = runparams.inDeletedInset
2482 ? runparams.changeOfDeletedInset : lookupChange(i);
2484 if (bparams.outputChanges && runningChange != change) {
2486 column += running_font.latexWriteEndChanges(
2487 os, bparams, runparams, basefont, basefont);
2490 basefont = getLayoutFont(bparams, outerfont);
2491 running_font = basefont;
2493 column += Changes::latexMarkChange(os, bparams, runningChange,
2495 runningChange = change;
2498 // do not output text which is marked deleted
2499 // if change tracking output is disabled
2500 if (!bparams.outputChanges && change.deleted()) {
2506 // Fully instantiated font
2507 Font const font = getFont(bparams, i, outerfont);
2509 Font const last_font = running_font;
2511 // Do we need to close the previous font?
2513 (font != running_font ||
2514 font.language() != running_font.language()))
2516 column += running_font.latexWriteEndChanges(
2517 os, bparams, runparams, basefont,
2518 (i == body_pos-1) ? basefont : font);
2519 running_font = basefont;
2523 string const running_lang = runparams.use_polyglossia ?
2524 running_font.language()->polyglossia() : running_font.language()->babel();
2525 // close babel's font environment before opening CJK.
2526 string const lang_end_command = runparams.use_polyglossia ?
2527 "\\end{$$lang}" : lyxrc.language_command_end;
2528 if (!running_lang.empty() &&
2529 font.language()->encoding()->package() == Encoding::CJK) {
2530 string end_tag = subst(lang_end_command,
2533 os << from_ascii(end_tag);
2534 column += end_tag.length();
2537 // Switch file encoding if necessary (and allowed)
2538 if (!runparams.pass_thru && !style.pass_thru &&
2539 runparams.encoding->package() != Encoding::none &&
2540 font.language()->encoding()->package() != Encoding::none) {
2541 pair<bool, int> const enc_switch =
2542 switchEncoding(os.os(), bparams, runparams,
2543 *(font.language()->encoding()));
2544 if (enc_switch.first) {
2545 column += enc_switch.second;
2546 runparams.encoding = font.language()->encoding();
2550 char_type const c = d->text_[i];
2552 // Do we need to change font?
2553 if ((font != running_font ||
2554 font.language() != running_font.language()) &&
2557 odocstringstream ods;
2558 column += font.latexWriteStartChanges(ods, bparams,
2559 runparams, basefont,
2561 running_font = font;
2563 docstring fontchange = ods.str();
2564 // check whether the fontchange ends with a \\textcolor
2565 // modifier and the text starts with a space (bug 4473)
2566 docstring const last_modifier = rsplit(fontchange, '\\');
2567 if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2568 os << fontchange << from_ascii("{}");
2569 // check if the fontchange ends with a trailing blank
2570 // (like "\small " (see bug 3382)
2571 else if (suffixIs(fontchange, ' ') && c == ' ')
2572 os << fontchange.substr(0, fontchange.size() - 1)
2573 << from_ascii("{}");
2578 // FIXME: think about end_pos implementation...
2579 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2580 // FIXME: integrate this case in latexSpecialChar
2581 // Do not print the separation of the optional argument
2582 // if style.pass_thru is false. This works because
2583 // latexSpecialChar ignores spaces if
2584 // style.pass_thru is false.
2585 if (i != body_pos - 1) {
2586 if (d->simpleTeXBlanks(runparams, os,
2587 i, column, font, style)) {
2588 // A surrogate pair was output. We
2589 // must not call latexSpecialChar
2590 // in this iteration, since it would output
2591 // the combining character again.
2598 OutputParams rp = runparams;
2599 rp.free_spacing = style.free_spacing;
2600 rp.local_font = &font;
2601 rp.intitle = style.intitle;
2603 // Two major modes: LaTeX or plain
2604 // Handle here those cases common to both modes
2605 // and then split to handle the two modes separately.
2606 if (c == META_INSET) {
2607 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2608 d->latexInset(bparams, os, rp, running_font,
2609 basefont, outerfont, open_font,
2610 runningChange, style, i, column);
2613 if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2615 d->latexSpecialChar(os, bparams, rp, running_font, runningChange,
2616 style, i, end_pos, column);
2617 } catch (EncodingException & e) {
2618 if (runparams.dryrun) {
2619 os << "<" << _("LyX Warning: ")
2620 << _("uncodable character") << " '";
2624 // add location information and throw again.
2633 // Set the encoding to that returned from latexSpecialChar (see
2634 // comment for encoding member in OutputParams.h)
2635 runparams.encoding = rp.encoding;
2638 // If we have an open font definition, we have to close it
2640 #ifdef FIXED_LANGUAGE_END_DETECTION
2642 running_font.latexWriteEndChanges(os, bparams,
2643 runparams, basefont,
2644 next_->getFont(bparams, 0, outerfont));
2646 running_font.latexWriteEndChanges(os, bparams,
2647 runparams, basefont, basefont);
2650 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2651 //FIXME: there as we start another \selectlanguage with the next paragraph if
2652 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2653 running_font.latexWriteEndChanges(os, bparams, runparams,
2654 basefont, basefont);
2658 column += Changes::latexMarkChange(os, bparams, runningChange,
2659 Change(Change::UNCHANGED), runparams);
2661 // Needed if there is an optional argument but no contents.
2662 if (body_pos > 0 && body_pos == size()) {
2666 if (!style.rightdelim().empty()) {
2667 os << style.rightdelim();
2668 column += style.rightdelim().size();
2671 if (allowcust && d->endTeXParParams(bparams, os, runparams)
2672 && runparams.encoding != prev_encoding) {
2673 runparams.encoding = prev_encoding;
2674 if (!runparams.isFullUnicode())
2675 os << setEncoding(prev_encoding->iconvName());
2678 LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2682 bool Paragraph::emptyTag() const
2684 for (pos_type i = 0; i < size(); ++i) {
2685 if (Inset const * inset = getInset(i)) {
2686 InsetCode lyx_code = inset->lyxCode();
2687 // FIXME testing like that is wrong. What is
2689 if (lyx_code != TOC_CODE &&
2690 lyx_code != INCLUDE_CODE &&
2691 lyx_code != GRAPHICS_CODE &&
2692 lyx_code != ERT_CODE &&
2693 lyx_code != LISTINGS_CODE &&
2694 lyx_code != FLOAT_CODE &&
2695 lyx_code != TABULAR_CODE) {
2699 char_type c = d->text_[i];
2700 if (c != ' ' && c != '\t')
2708 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2711 for (pos_type i = 0; i < size(); ++i) {
2712 if (Inset const * inset = getInset(i)) {
2713 InsetCode lyx_code = inset->lyxCode();
2714 if (lyx_code == LABEL_CODE) {
2715 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2716 docstring const & id = il->getParam("name");
2717 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2725 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2729 for (i = 0; i < size(); ++i) {
2730 if (Inset const * inset = getInset(i)) {
2731 inset->docbook(os, runparams);
2733 char_type c = d->text_[i];
2736 os << sgml::escapeChar(c);
2743 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2747 for (i = 0; i < size(); ++i) {
2748 if (Inset const * inset = getInset(i)) {
2749 inset->xhtml(xs, runparams);
2751 char_type c = d->text_[i];
2761 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2764 pos_type size = text_.size();
2765 for (pos_type i = initial; i < size; ++i) {
2766 Font font = owner_->getFont(buf.params(), i, outerfont);
2767 if (text_[i] == META_INSET)
2769 if (i != initial && font != font_old)
2778 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2780 OutputParams const & runparams,
2781 Font const & outerfont,
2782 pos_type initial) const
2784 bool emph_flag = false;
2786 Layout const & style = *d->layout_;
2788 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2790 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2793 // parsing main loop
2794 for (pos_type i = initial; i < size(); ++i) {
2795 Font font = getFont(buf.params(), i, outerfont);
2797 // handle <emphasis> tag
2798 if (font_old.emph() != font.fontInfo().emph()) {
2799 if (font.fontInfo().emph() == FONT_ON) {
2802 } else if (i != initial) {
2803 os << "</emphasis>";
2808 if (Inset const * inset = getInset(i)) {
2809 inset->docbook(os, runparams);
2811 char_type c = d->text_[i];
2813 if (style.pass_thru)
2816 os << sgml::escapeChar(c);
2818 font_old = font.fontInfo();
2822 os << "</emphasis>";
2825 if (style.free_spacing)
2827 if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
2832 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
2834 OutputParams const & runparams,
2835 Font const & outerfont,
2836 pos_type initial) const
2840 bool emph_flag = false;
2841 bool bold_flag = false;
2843 Layout const & style = *d->layout_;
2845 xs.startParagraph(allowEmpty());
2847 if (!runparams.for_toc && runparams.html_make_pars) {
2848 // generate a magic label for this paragraph
2849 string const attr = "id='" + magicLabel() + "'";
2850 xs << html::CompTag("a", attr);
2854 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
2856 // parsing main loop
2857 for (pos_type i = initial; i < size(); ++i) {
2858 // let's not show deleted material in the output
2862 Font font = getFont(buf.params(), i, outerfont);
2865 if (font_old.emph() != font.fontInfo().emph()) {
2866 if (font.fontInfo().emph() == FONT_ON) {
2867 xs << html::StartTag("em");
2869 } else if (emph_flag && i != initial) {
2870 xs << html::EndTag("em");
2875 if (font_old.series() != font.fontInfo().series()) {
2876 if (font.fontInfo().series() == BOLD_SERIES) {
2877 xs << html::StartTag("strong");
2879 } else if (bold_flag && i != initial) {
2880 xs << html::EndTag("strong");
2885 // Other such tags? What about the other text ranges?
2887 Inset const * inset = getInset(i);
2889 if (!runparams.for_toc || inset->isInToc()) {
2890 OutputParams np = runparams;
2891 if (!inset->getLayout().htmlisblock())
2892 np.html_in_par = true;
2893 retval += inset->xhtml(xs, np);
2896 char_type c = getUChar(buf.params(), i);
2898 if (style.pass_thru || runparams.pass_thru)
2900 else if (c == '-') {
2903 if (j < size() && d->text_[j] == '-') {
2905 if (j < size() && d->text_[j] == '-') {
2906 str += from_ascii("—");
2909 str += from_ascii("–");
2915 // We don't want to escape the entities. Note that
2916 // it is safe to do this, since str can otherwise
2917 // only be "-". E.g., it can't be "<".
2918 xs << XHTMLStream::ESCAPE_NONE << str;
2922 font_old = font.fontInfo();
2931 bool Paragraph::isHfill(pos_type pos) const
2933 Inset const * inset = getInset(pos);
2934 return inset && (inset->lyxCode() == SPACE_CODE &&
2935 inset->isStretchableSpace());
2939 bool Paragraph::isNewline(pos_type pos) const
2941 Inset const * inset = getInset(pos);
2942 return inset && inset->lyxCode() == NEWLINE_CODE;
2946 bool Paragraph::isLineSeparator(pos_type pos) const
2948 char_type const c = d->text_[pos];
2949 if (isLineSeparatorChar(c))
2951 Inset const * inset = getInset(pos);
2952 return inset && inset->isLineSeparator();
2956 bool Paragraph::isWordSeparator(pos_type pos) const
2960 if (Inset const * inset = getInset(pos))
2961 return !inset->isLetter();
2962 // if we have a hard hyphen (no en- or emdash) or apostrophe
2963 // we pass this to the spell checker
2964 // FIXME: this method is subject to change, visit
2965 // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
2966 // to get an impression how complex this is.
2967 if (isHardHyphenOrApostrophe(pos))
2969 char_type const c = d->text_[pos];
2970 // We want to pass the escape chars to the spellchecker
2971 docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
2972 return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
2976 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
2978 pos_type const psize = size();
2981 char_type const c = d->text_[pos];
2982 if (c != '-' && c != '\'')
2984 int nextpos = pos + 1;
2985 int prevpos = pos > 0 ? pos - 1 : 0;
2986 if ((nextpos == psize || isSpace(nextpos))
2987 && (pos == 0 || isSpace(prevpos)))
2990 || ((nextpos == psize || d->text_[nextpos] != '-')
2991 && (pos == 0 || d->text_[prevpos] != '-'));
2995 bool Paragraph::isSameSpellRange(pos_type pos1, pos_type pos2) const
2998 || d->speller_state_.getRange(pos1) == d->speller_state_.getRange(pos2);
3002 bool Paragraph::isChar(pos_type pos) const
3004 if (Inset const * inset = getInset(pos))
3005 return inset->isChar();
3006 char_type const c = d->text_[pos];
3007 return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3011 bool Paragraph::isSpace(pos_type pos) const
3013 if (Inset const * inset = getInset(pos))
3014 return inset->isSpace();
3015 char_type const c = d->text_[pos];
3016 return lyx::isSpace(c);
3021 Paragraph::getParLanguage(BufferParams const & bparams) const
3024 return getFirstFontSettings(bparams).language();
3025 // FIXME: we should check the prev par as well (Lgb)
3026 return bparams.language;
3030 bool Paragraph::isRTL(BufferParams const & bparams) const
3032 return lyxrc.rtl_support
3033 && getParLanguage(bparams)->rightToLeft()
3034 && !inInset().getLayout().forceLTR();
3038 void Paragraph::changeLanguage(BufferParams const & bparams,
3039 Language const * from, Language const * to)
3041 // change language including dummy font change at the end
3042 for (pos_type i = 0; i <= size(); ++i) {
3043 Font font = getFontSettings(bparams, i);
3044 if (font.language() == from) {
3045 font.setLanguage(to);
3047 d->requestSpellCheck(i);
3053 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3055 Language const * doc_language = bparams.language;
3056 FontList::const_iterator cit = d->fontlist_.begin();
3057 FontList::const_iterator end = d->fontlist_.end();
3059 for (; cit != end; ++cit)
3060 if (cit->font().language() != ignore_language &&
3061 cit->font().language() != latex_language &&
3062 cit->font().language() != doc_language)
3068 void Paragraph::getLanguages(std::set<Language const *> & languages) const
3070 FontList::const_iterator cit = d->fontlist_.begin();
3071 FontList::const_iterator end = d->fontlist_.end();
3073 for (; cit != end; ++cit) {
3074 Language const * lang = cit->font().language();
3075 if (lang != ignore_language &&
3076 lang != latex_language)
3077 languages.insert(lang);
3082 docstring Paragraph::asString(int options) const
3084 return asString(0, size(), options);
3088 docstring Paragraph::asString(pos_type beg, pos_type end, int options) const
3090 odocstringstream os;
3093 && options & AS_STR_LABEL
3094 && !d->params_.labelString().empty())
3095 os << d->params_.labelString() << ' ';
3097 for (pos_type i = beg; i < end; ++i) {
3098 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3100 char_type const c = d->text_[i];
3101 if (isPrintable(c) || c == '\t'
3102 || (c == '\n' && (options & AS_STR_NEWLINES)))
3104 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3105 getInset(i)->toString(os);
3106 if (getInset(i)->asInsetMath())
3115 void Paragraph::forToc(docstring & os, size_t maxlen) const
3117 if (!d->params_.labelString().empty())
3118 os += d->params_.labelString() + ' ';
3119 for (pos_type i = 0; i < size() && os.length() < maxlen; ++i) {
3122 char_type const c = d->text_[i];
3125 else if (c == '\t' || c == '\n')
3127 else if (c == META_INSET)
3128 getInset(i)->forToc(os, maxlen);
3133 docstring Paragraph::stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const
3135 odocstringstream os;
3138 && options & AS_STR_LABEL
3139 && !d->params_.labelString().empty())
3140 os << d->params_.labelString() << ' ';
3142 for (pos_type i = beg; i < end; ++i) {
3143 char_type const c = d->text_[i];
3144 if (isPrintable(c) || c == '\t'
3145 || (c == '\n' && (options & AS_STR_NEWLINES)))
3147 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3148 getInset(i)->plaintext(os, runparams);
3156 void Paragraph::setInsetOwner(Inset const * inset)
3158 d->inset_owner_ = inset;
3162 int Paragraph::id() const
3168 void Paragraph::setId(int id)
3174 Layout const & Paragraph::layout() const
3180 void Paragraph::setLayout(Layout const & layout)
3182 d->layout_ = &layout;
3186 void Paragraph::setDefaultLayout(DocumentClass const & tc)
3188 setLayout(tc.defaultLayout());
3192 void Paragraph::setPlainLayout(DocumentClass const & tc)
3194 setLayout(tc.plainLayout());
3198 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
3200 if (usePlainLayout())
3201 setPlainLayout(tclass);
3203 setDefaultLayout(tclass);
3207 Inset const & Paragraph::inInset() const
3209 LASSERT(d->inset_owner_, throw ExceptionMessage(BufferException,
3210 _("Memory problem"), _("Paragraph not properly initialized")));
3211 return *d->inset_owner_;
3215 ParagraphParameters & Paragraph::params()
3221 ParagraphParameters const & Paragraph::params() const
3227 bool Paragraph::isFreeSpacing() const
3229 if (d->layout_->free_spacing)
3231 return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
3235 bool Paragraph::allowEmpty() const
3237 if (d->layout_->keepempty)
3239 return d->inset_owner_ && d->inset_owner_->allowEmpty();
3243 char_type Paragraph::transformChar(char_type c, pos_type pos) const
3245 if (!Encodings::isArabicChar(c))
3248 char_type prev_char = ' ';
3249 char_type next_char = ' ';
3251 for (pos_type i = pos - 1; i >= 0; --i) {
3252 char_type const par_char = d->text_[i];
3253 if (!Encodings::isArabicComposeChar(par_char)) {
3254 prev_char = par_char;
3259 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
3260 char_type const par_char = d->text_[i];
3261 if (!Encodings::isArabicComposeChar(par_char)) {
3262 next_char = par_char;
3267 if (Encodings::isArabicChar(next_char)) {
3268 if (Encodings::isArabicChar(prev_char) &&
3269 !Encodings::isArabicSpecialChar(prev_char))
3270 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
3272 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
3274 if (Encodings::isArabicChar(prev_char) &&
3275 !Encodings::isArabicSpecialChar(prev_char))
3276 return Encodings::transformChar(c, Encodings::FORM_FINAL);
3278 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
3283 bool Paragraph::brokenBiblio() const
3285 // there is a problem if there is no bibitem at position 0 or
3286 // if there is another bibitem in the paragraph.
3287 return d->layout_->labeltype == LABEL_BIBLIO
3288 && (d->insetlist_.find(BIBITEM_CODE) != 0
3289 || d->insetlist_.find(BIBITEM_CODE, 1) > 0);
3293 int Paragraph::fixBiblio(Buffer const & buffer)
3295 // FIXME: What about the case where paragraph is not BIBLIO
3296 // but there is an InsetBibitem?
3297 // FIXME: when there was already an inset at 0, the return value is 1,
3298 // which does not tell whether another inset has been remove; the
3299 // cursor cannot be correctly updated.
3301 if (d->layout_->labeltype != LABEL_BIBLIO)
3304 bool const track_changes = buffer.params().trackChanges;
3305 int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
3306 bool const hasbibitem0 = bibitem_pos == 0;
3309 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
3310 // There was an InsetBibitem at pos 0, and no other one => OK
3311 if (bibitem_pos == -1)
3313 // there is a bibitem at the 0 position, but since
3314 // there is a second one, we copy the second on the
3315 // first. We're assuming there are at most two of
3316 // these, which there should be.
3317 // FIXME: why does it make sense to do that rather
3318 // than keep the first? (JMarc)
3319 Inset * inset = d->insetlist_.release(bibitem_pos);
3320 eraseChar(bibitem_pos, track_changes);
3321 d->insetlist_.begin()->inset = inset;
3322 return -bibitem_pos;
3325 // We need to create an inset at the beginning
3327 if (bibitem_pos > 0) {
3328 // there was one somewhere in the paragraph, let's move it
3329 inset = d->insetlist_.release(bibitem_pos);
3330 eraseChar(bibitem_pos, track_changes);
3333 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
3334 InsetCommandParams(BIBITEM_CODE));
3336 insertInset(0, inset, Change(track_changes ? Change::INSERTED
3337 : Change::UNCHANGED));
3343 void Paragraph::checkAuthors(AuthorList const & authorList)
3345 d->changes_.checkAuthors(authorList);
3349 bool Paragraph::isChanged(pos_type pos) const
3351 return lookupChange(pos).changed();
3355 bool Paragraph::isInserted(pos_type pos) const
3357 return lookupChange(pos).inserted();
3361 bool Paragraph::isDeleted(pos_type pos) const
3363 return lookupChange(pos).deleted();
3367 InsetList const & Paragraph::insetList() const
3369 return d->insetlist_;
3373 void Paragraph::setBuffer(Buffer & b)
3375 d->insetlist_.setBuffer(b);
3379 Inset * Paragraph::releaseInset(pos_type pos)
3381 Inset * inset = d->insetlist_.release(pos);
3382 /// does not honour change tracking!
3383 eraseChar(pos, false);
3388 Inset * Paragraph::getInset(pos_type pos)
3390 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3391 ? d->insetlist_.get(pos) : 0;
3395 Inset const * Paragraph::getInset(pos_type pos) const
3397 return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3398 ? d->insetlist_.get(pos) : 0;
3402 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
3403 pos_type & right, TextCase action)
3405 // process sequences of modified characters; in change
3406 // tracking mode, this approach results in much better
3407 // usability than changing case on a char-by-char basis
3410 bool const trackChanges = bparams.trackChanges;
3412 bool capitalize = true;
3414 for (; pos < right; ++pos) {
3415 char_type oldChar = d->text_[pos];
3416 char_type newChar = oldChar;
3418 // ignore insets and don't play with deleted text!
3419 if (oldChar != META_INSET && !isDeleted(pos)) {
3421 case text_lowercase:
3422 newChar = lowercase(oldChar);
3424 case text_capitalization:
3426 newChar = uppercase(oldChar);
3430 case text_uppercase:
3431 newChar = uppercase(oldChar);
3436 if (isWordSeparator(pos) || isDeleted(pos)) {
3437 // permit capitalization again
3441 if (oldChar != newChar) {
3443 if (pos != right - 1)
3445 // step behind the changing area
3449 int erasePos = pos - changes.size();
3450 for (size_t i = 0; i < changes.size(); i++) {
3451 insertChar(pos, changes[i],
3452 getFontSettings(bparams,
3455 if (!eraseChar(erasePos, trackChanges)) {
3458 ++right; // expand selection
3466 int Paragraph::find(docstring const & str, bool cs, bool mw,
3467 pos_type start_pos, bool del) const
3469 pos_type pos = start_pos;
3470 int const strsize = str.length();
3472 pos_type const parsize = d->text_.size();
3473 for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
3474 // Ignore "invisible" letters such as ligature breaks
3475 // and hyphenation chars while searching
3476 while (pos < parsize - 1 && isInset(pos)) {
3477 odocstringstream os;
3478 getInset(pos)->toString(os);
3479 if (!getInset(pos)->isLetter() || !os.str().empty())
3483 if (cs && str[i] != d->text_[pos])
3485 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
3487 if (!del && isDeleted(pos))
3494 // if necessary, check whether string matches word
3496 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
3499 && !isWordSeparator(pos))
3503 return pos - start_pos;
3507 char_type Paragraph::getChar(pos_type pos) const
3509 return d->text_[pos];
3513 pos_type Paragraph::size() const
3515 return d->text_.size();
3519 bool Paragraph::empty() const
3521 return d->text_.empty();
3525 bool Paragraph::isInset(pos_type pos) const
3527 return d->text_[pos] == META_INSET;
3531 bool Paragraph::isSeparator(pos_type pos) const
3533 //FIXME: Are we sure this can be the only separator?
3534 return d->text_[pos] == ' ';
3538 void Paragraph::deregisterWords()
3540 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3541 Private::LangWordsMap::const_iterator ite = d->words_.end();
3542 for (; itl != ite; ++itl) {
3543 WordList * wl = theWordList(itl->first);
3544 Private::Words::const_iterator it = (itl->second).begin();
3545 Private::Words::const_iterator et = (itl->second).end();
3546 for (; it != et; ++it)
3553 void Paragraph::locateWord(pos_type & from, pos_type & to,
3554 word_location const loc) const
3557 case WHOLE_WORD_STRICT:
3558 if (from == 0 || from == size()
3559 || isWordSeparator(from)
3560 || isWordSeparator(from - 1)) {
3564 // no break here, we go to the next
3567 // If we are already at the beginning of a word, do nothing
3568 if (!from || isWordSeparator(from - 1))
3570 // no break here, we go to the next
3573 // always move the cursor to the beginning of previous word
3574 while (from && !isWordSeparator(from - 1))
3578 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
3581 // no need to move the 'from' cursor
3585 while (to < size() && !isWordSeparator(to))
3590 void Paragraph::collectWords()
3592 pos_type n = size();
3593 for (pos_type pos = 0; pos < n; ++pos) {
3594 if (isWordSeparator(pos))
3596 pos_type from = pos;
3597 locateWord(from, pos, WHOLE_WORD);
3598 if ((pos - from) >= (int)lyxrc.completion_minlength) {
3599 docstring word = asString(from, pos, AS_STR_NONE);
3600 FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
3601 if (cit == d->fontlist_.end())
3603 Language const * lang = cit->font().language();
3604 d->words_[*lang].insert(word);
3610 void Paragraph::registerWords()
3612 Private::LangWordsMap::const_iterator itl = d->words_.begin();
3613 Private::LangWordsMap::const_iterator ite = d->words_.end();
3614 for (; itl != ite; ++itl) {
3615 WordList * wl = theWordList(itl->first);
3616 Private::Words::const_iterator it = (itl->second).begin();
3617 Private::Words::const_iterator et = (itl->second).end();
3618 for (; it != et; ++it)
3624 void Paragraph::updateWords()
3632 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
3634 SkipPositionsIterator begin = skips.begin();
3635 SkipPositions::iterator end = skips.end();
3636 if (pos > 0 && begin < end) {
3638 if (end->last == pos - 1) {
3643 skips.insert(end, FontSpan(pos, pos));
3647 Language * Paragraph::Private::locateSpellRange(
3648 pos_type & from, pos_type & to,
3649 SkipPositions & skips) const
3651 // skip leading white space
3652 while (from < to && owner_->isWordSeparator(from))
3654 // don't check empty range
3657 // get current language
3658 Language * lang = getSpellLanguage(from);
3659 pos_type last = from;
3660 bool samelang = true;
3661 bool sameinset = true;
3662 while (last < to && samelang && sameinset) {
3663 // hop to end of word
3664 while (last < to && !owner_->isWordSeparator(last)) {
3665 if (owner_->getInset(last)) {
3666 appendSkipPosition(skips, last);
3667 } else if (owner_->isDeleted(last)) {
3668 appendSkipPosition(skips, last);
3672 // hop to next word while checking for insets
3673 while (sameinset && last < to && owner_->isWordSeparator(last)) {
3674 if (Inset const * inset = owner_->getInset(last))
3675 sameinset = inset->isChar() && inset->isLetter();
3676 if (sameinset && owner_->isDeleted(last)) {
3677 appendSkipPosition(skips, last);
3682 if (sameinset && last < to) {
3683 // now check for language change
3684 samelang = lang == getSpellLanguage(last);
3687 // if language change detected backstep is needed
3695 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
3698 const_cast<Language *>(owner_->getFontSettings(
3699 inset_owner_->buffer().params(), from).language());
3700 if (lang == inset_owner_->buffer().params().language
3701 && !lyxrc.spellchecker_alt_lang.empty()) {
3703 string const lang_variety =
3704 split(lyxrc.spellchecker_alt_lang, lang_code, '-');
3705 lang->setCode(lang_code);
3706 lang->setVariety(lang_variety);
3712 void Paragraph::requestSpellCheck(pos_type pos)
3714 d->requestSpellCheck(pos);
3718 bool Paragraph::needsSpellCheck() const
3720 SpellChecker::ChangeNumber speller_change_number = 0;
3721 if (theSpellChecker())
3722 speller_change_number = theSpellChecker()->changeNumber();
3723 if (speller_change_number > d->speller_state_.currentChangeNumber()) {
3724 d->speller_state_.needsCompleteRefresh(speller_change_number);
3726 return d->needsSpellCheck();
3730 bool Paragraph::Private::ignoreWord(docstring const & word) const
3732 // Ignore words with digits
3733 // FIXME: make this customizable
3734 // (note that some checkers ignore words with digits by default)
3735 docstring::const_iterator cit = word.begin();
3736 docstring::const_iterator const end = word.end();
3737 for (; cit != end; ++cit) {
3738 if (isNumber((*cit)))
3745 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
3746 WordLangTuple & wl, docstring_list & suggestions,
3747 bool do_suggestion, bool check_learned) const
3749 SpellChecker::Result result = SpellChecker::WORD_OK;
3750 SpellChecker * speller = theSpellChecker();
3754 if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
3757 locateWord(from, to, WHOLE_WORD);
3758 if (from == to || from >= size())
3761 docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
3762 Language * lang = d->getSpellLanguage(from);
3764 wl = WordLangTuple(word, lang);
3769 if (needsSpellCheck() || check_learned) {
3771 if (!d->ignoreWord(word)) {
3772 bool const trailing_dot = to < size() && d->text_[to] == '.';
3773 result = speller->check(wl);
3774 if (SpellChecker::misspelled(result) && trailing_dot) {
3775 wl = WordLangTuple(word.append(from_ascii(".")), lang);
3776 result = speller->check(wl);
3777 if (!SpellChecker::misspelled(result)) {
3778 LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
3780 from << ".." << to << "]");
3782 // spell check with dot appended failed too
3783 // restore original word/lang value
3784 word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
3785 wl = WordLangTuple(word, lang);
3789 if (!SpellChecker::misspelled(result)) {
3790 // area up to the begin of the next word is not misspelled
3791 while (end < size() && isWordSeparator(end))
3794 d->setMisspelled(from, end, result);
3796 result = d->speller_state_.getState(from);
3800 suggestions.clear();
3802 if (SpellChecker::misspelled(result)) {
3803 LYXERR(Debug::GUI, "misspelled word: \"" <<
3805 from << ".." << to << "]");
3807 speller->suggest(wl, suggestions);
3813 void Paragraph::Private::markMisspelledWords(
3814 pos_type const & first, pos_type const & last,
3815 SpellChecker::Result result,
3816 docstring const & word,
3817 SkipPositions const & skips)
3819 if (!SpellChecker::misspelled(result)) {
3820 setMisspelled(first, last, SpellChecker::WORD_OK);
3824 SpellChecker * speller = theSpellChecker();
3825 // locate and enumerate the error positions
3826 int nerrors = speller->numMisspelledWords();
3828 SkipPositionsIterator it = skips.begin();
3829 SkipPositionsIterator et = skips.end();
3830 for (int index = 0; index < nerrors; ++index) {
3833 speller->misspelledWord(index, wstart, wlen);
3834 /// should not happen if speller supports range checks
3835 if (!wlen) continue;
3836 docstring const misspelled = word.substr(wstart, wlen);
3837 wstart += first + numskipped;
3838 if (snext < wstart) {
3839 /// mark the range of correct spelling
3840 numskipped += countSkips(it, et, wstart);
3841 setMisspelled(snext,
3842 wstart - 1, SpellChecker::WORD_OK);
3844 snext = wstart + wlen;
3845 numskipped += countSkips(it, et, snext);
3846 /// mark the range of misspelling
3847 setMisspelled(wstart, snext, result);
3848 LYXERR(Debug::GUI, "misspelled word: \"" <<
3849 misspelled << "\" [" <<
3850 wstart << ".." << (snext-1) << "]");
3853 if (snext <= last) {
3854 /// mark the range of correct spelling at end
3855 setMisspelled(snext, last, SpellChecker::WORD_OK);
3860 void Paragraph::spellCheck() const
3862 SpellChecker * speller = theSpellChecker();
3863 if (!speller || empty() ||!needsSpellCheck())
3867 d->rangeOfSpellCheck(start, endpos);
3868 if (speller->canCheckParagraph()) {
3869 // loop until we leave the range
3870 for (pos_type first = start; first < endpos; ) {
3871 pos_type last = endpos;
3872 Private::SkipPositions skips;
3873 Language * lang = d->locateSpellRange(first, last, skips);
3874 if (first >= endpos)
3876 // start the spell checker on the unit of meaning
3877 docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
3878 WordLangTuple wl = WordLangTuple(word, lang);
3879 SpellChecker::Result result = word.size() ?
3880 speller->check(wl) : SpellChecker::WORD_OK;
3881 d->markMisspelledWords(first, last, result, word, skips);
3885 static docstring_list suggestions;
3886 pos_type to = endpos;
3887 while (start < endpos) {
3889 spellCheck(start, to, wl, suggestions, false);
3893 d->readySpellCheck();
3897 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
3899 bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
3900 if (result || pos <= 0 || pos > size())
3902 if (check_boundary && (pos == size() || isWordSeparator(pos)))
3903 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
3908 string Paragraph::magicLabel() const
3911 ss << "magicparlabel-" << id();