src/Paragraph.cpp

   1 /**
   2  * \file Paragraph.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   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
  11  * \author John Levon
  12  * \author André Pönitz
  13  * \author Dekel Tsur
  14  * \author Jürgen Vigna
  15  *
  16  * Full author contact details are available in file CREDITS.
  17  */
  18
  19 #include <config.h>
  20
  21 #include "Paragraph.h"
  22
  23 #include "LayoutFile.h"
  24 #include "Buffer.h"
  25 #include "BufferParams.h"
  26 #include "Changes.h"
  27 #include "Counters.h"
  28 #include "BufferEncodings.h"
  29 #include "InsetList.h"
  30 #include "Language.h"
  31 #include "LaTeXFeatures.h"
  32 #include "Layout.h"
  33 #include "Length.h"
  34 #include "Font.h"
  35 #include "FontList.h"
  36 #include "LyXRC.h"
  37 #include "OutputParams.h"
  38 #include "output_latex.h"
  39 #include "output_xhtml.h"
  40 #include "ParagraphParameters.h"
  41 #include "SpellChecker.h"
  42 #include "sgml.h"
  43 #include "texstream.h"
  44 #include "TextClass.h"
  45 #include "TexRow.h"
  46 #include "Text.h"
  47 #include "WordLangTuple.h"
  48 #include "WordList.h"
  49
  50 #include "frontends/alert.h"
  51
  52 #include "insets/InsetBibitem.h"
  53 #include "insets/InsetLabel.h"
  54 #include "insets/InsetSpecialChar.h"
  55 #include "insets/InsetText.h"
  56
  57 #include "mathed/InsetMathHull.h"
  58
  59 #include "support/debug.h"
  60 #include "support/docstring_list.h"
  61 #include "support/ExceptionMessage.h"
  62 #include "support/gettext.h"
  63 #include "support/lassert.h"
  64 #include "support/lstrings.h"
  65 #include "support/textutils.h"
  66
  67 #include <atomic>
  68 #include <sstream>
  69 #include <vector>
  70
  71 using namespace std;
  72 using namespace lyx::support;
  73
  74 // OSX clang, gcc < 4.8.0, and msvc < 2015 do not support C++11 thread_local
  75 #if defined(__APPLE__) || (defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ < 8)
  76 #define THREAD_LOCAL_STATIC static __thread
  77 #elif defined(_MSC_VER) && (_MSC_VER < 1900)
  78 #define THREAD_LOCAL_STATIC static __declspec(thread)
  79 #else
  80 #define THREAD_LOCAL_STATIC thread_local static
  81 #endif
  82
  83 namespace lyx {
  84
  85 namespace {
  86
  87 /// Inset identifier (above 0x10ffff, for ucs-4)
  88 char_type const META_INSET = 0x200001;
  89
  90 } // namespace
  91
  92
  93 /////////////////////////////////////////////////////////////////////
  94 //
  95 // SpellResultRange
  96 //
  97 /////////////////////////////////////////////////////////////////////
  98
  99 class SpellResultRange {
 100 public:
 101         SpellResultRange(FontSpan range, SpellChecker::Result result)
 102         : range_(range), result_(result)
 103         {}
 104         ///
 105         FontSpan const & range() const { return range_; }
 106         ///
 107         void range(FontSpan const & r) { range_ = r; }
 108         ///
 109         SpellChecker::Result result() const { return result_; }
 110         ///
 111         void result(SpellChecker::Result r) { result_ = r; }
 112         ///
 113         bool contains(pos_type pos) const { return range_.contains(pos); }
 114         ///
 115         bool covered(FontSpan const & r) const
 116         {
 117                 // 1. first of new range inside current range or
 118                 // 2. last of new range inside current range or
 119                 // 3. first of current range inside new range or
 120                 // 4. last of current range inside new range
 121                 //FIXME: is this the same as !range_.intersect(r).empty() ?
 122                 return range_.contains(r.first) || range_.contains(r.last) ||
 123                         r.contains(range_.first) || r.contains(range_.last);
 124         }
 125         ///
 126         void shift(pos_type pos, int offset)
 127         {
 128                 if (range_.first > pos) {
 129                         range_.first += offset;
 130                         range_.last += offset;
 131                 } else if (range_.last >= pos) {
 132                         range_.last += offset;
 133                 }
 134         }
 135 private:
 136         FontSpan range_ ;
 137         SpellChecker::Result result_ ;
 138 };
 139
 140
 141 /////////////////////////////////////////////////////////////////////
 142 //
 143 // SpellCheckerState
 144 //
 145 /////////////////////////////////////////////////////////////////////
 146
 147 class SpellCheckerState {
 148 public:
 149         SpellCheckerState()
 150         {
 151                 needs_refresh_ = true;
 152                 current_change_number_ = 0;
 153         }
 154
 155         void setRange(FontSpan const & fp, SpellChecker::Result state)
 156         {
 157                 Ranges result;
 158                 RangesIterator et = ranges_.end();
 159                 RangesIterator it = ranges_.begin();
 160                 for (; it != et; ++it) {
 161                         if (!it->covered(fp))
 162                                 result.push_back(SpellResultRange(it->range(), it->result()));
 163                         else if (state == SpellChecker::WORD_OK) {
 164                                 // trim or split the current misspelled range
 165                                 // store misspelled ranges only
 166                                 FontSpan range = it->range();
 167                                 if (fp.first > range.first) {
 168                                         // misspelled area in front of WORD_OK
 169                                         range.last = fp.first - 1;
 170                                         result.push_back(SpellResultRange(range, it->result()));
 171                                         range = it->range();
 172                                 }
 173                                 if (fp.last < range.last) {
 174                                         // misspelled area after WORD_OK range
 175                                         range.first = fp.last + 1;
 176                                         result.push_back(SpellResultRange(range, it->result()));
 177                                 }
 178                         }
 179                 }
 180                 ranges_ = result;
 181                 if (state != SpellChecker::WORD_OK)
 182                         ranges_.push_back(SpellResultRange(fp, state));
 183         }
 184
 185         void increasePosAfterPos(pos_type pos)
 186         {
 187                 correctRangesAfterPos(pos, 1);
 188                 needsRefresh(pos);
 189         }
 190
 191         void decreasePosAfterPos(pos_type pos)
 192         {
 193                 correctRangesAfterPos(pos, -1);
 194                 needsRefresh(pos);
 195         }
 196
 197         void refreshLast(pos_type pos)
 198         {
 199                 if (pos < refresh_.last)
 200                         refresh_.last = pos;
 201         }
 202
 203         SpellChecker::Result getState(pos_type pos) const
 204         {
 205                 SpellChecker::Result result = SpellChecker::WORD_OK;
 206                 RangesIterator et = ranges_.end();
 207                 RangesIterator it = ranges_.begin();
 208                 for (; it != et; ++it) {
 209                         if(it->contains(pos)) {
 210                                 return it->result();
 211                         }
 212                 }
 213                 return result;
 214         }
 215
 216         FontSpan const & getRange(pos_type pos) const
 217         {
 218                 /// empty span to indicate mismatch
 219                 static FontSpan empty_;
 220                 RangesIterator et = ranges_.end();
 221                 RangesIterator it = ranges_.begin();
 222                 for (; it != et; ++it) {
 223                         if(it->contains(pos)) {
 224                                 return it->range();
 225                         }
 226                 }
 227                 return empty_;
 228         }
 229
 230         bool needsRefresh() const
 231         {
 232                 return needs_refresh_;
 233         }
 234
 235         SpellChecker::ChangeNumber currentChangeNumber() const
 236         {
 237                 return current_change_number_;
 238         }
 239
 240         void refreshRange(pos_type & first, pos_type & last) const
 241         {
 242                 first = refresh_.first;
 243                 last = refresh_.last;
 244         }
 245
 246         void needsRefresh(pos_type pos)
 247         {
 248                 if (needs_refresh_ && pos != -1) {
 249                         if (pos < refresh_.first)
 250                                 refresh_.first = pos;
 251                         if (pos > refresh_.last)
 252                                 refresh_.last = pos;
 253                 } else if (pos != -1) {
 254                         // init request check for neighbour positions too
 255                         refresh_.first = pos > 0 ? pos - 1 : 0;
 256                         // no need for special end of paragraph check
 257                         refresh_.last = pos + 1;
 258                 }
 259                 needs_refresh_ = pos != -1;
 260         }
 261
 262         void needsCompleteRefresh(SpellChecker::ChangeNumber change_number)
 263         {
 264                 needs_refresh_ = true;
 265                 refresh_.first = 0;
 266                 refresh_.last = -1;
 267                 current_change_number_ = change_number;
 268         }
 269 private:
 270         typedef vector<SpellResultRange> Ranges;
 271         typedef Ranges::const_iterator RangesIterator;
 272         Ranges ranges_;
 273         /// the area of the paragraph with pending spell check
 274         FontSpan refresh_;
 275         bool needs_refresh_;
 276         /// spell state cache version number
 277         SpellChecker::ChangeNumber current_change_number_;
 278
 279
 280         void correctRangesAfterPos(pos_type pos, int offset)
 281         {
 282                 RangesIterator et = ranges_.end();
 283                 Ranges::iterator it = ranges_.begin();
 284                 for (; it != et; ++it) {
 285                         it->shift(pos, offset);
 286                 }
 287         }
 288
 289 };
 290
 291 /////////////////////////////////////////////////////////////////////
 292 //
 293 // Paragraph::Private
 294 //
 295 /////////////////////////////////////////////////////////////////////
 296
 297 class Paragraph::Private
 298 {
 299         // Enforce our own "copy" constructor
 300         Private(Private const &) = delete;
 301         Private & operator=(Private const &) = delete;
 302         // Unique ID generator
 303         static int make_id();
 304 public:
 305         ///
 306         Private(Paragraph * owner, Layout const & layout);
 307         /// "Copy constructor"
 308         Private(Private const &, Paragraph * owner);
 309         /// Copy constructor from \p beg  to \p end
 310         Private(Private const &, Paragraph * owner, pos_type beg, pos_type end);
 311
 312         ///
 313         void insertChar(pos_type pos, char_type c, Change const & change);
 314
 315         /// Output the surrogate pair formed by \p c and \p next to \p os.
 316         /// \return the number of characters written.
 317         int latexSurrogatePair(BufferParams const &, otexstream & os,
 318                                char_type c, char_type next,
 319                                OutputParams const &);
 320
 321         /// Output a space in appropriate formatting (or a surrogate pair
 322         /// if the next character is a combining character).
 323         /// \return whether a surrogate pair was output.
 324         bool simpleTeXBlanks(BufferParams const &,
 325                              OutputParams const &,
 326                              otexstream &,
 327                              pos_type i,
 328                              unsigned int & column,
 329                              Font const & font,
 330                              Layout const & style);
 331
 332         /// Output consecutive unicode chars, belonging to the same script as
 333         /// specified by the latex macro \p ltx, to \p os starting from \p i.
 334         /// \return the number of characters written.
 335         int writeScriptChars(BufferParams const &, OutputParams const &,
 336                              otexstream & os,
 337                              docstring const & ltx,
 338                              Change const &, Encoding const &,
 339                              std::string const, pos_type & i);
 340
 341         /// This could go to ParagraphParameters if we want to.
 342         int startTeXParParams(BufferParams const &, otexstream &,
 343                               OutputParams const &) const;
 344
 345         /// This could go to ParagraphParameters if we want to.
 346         bool endTeXParParams(BufferParams const &, otexstream &,
 347                              OutputParams const &) const;
 348
 349         ///
 350         void latexInset(BufferParams const &,
 351                                    otexstream &,
 352                                    OutputParams &,
 353                                    Font & running_font,
 354                                    Font & basefont,
 355                                    Font const & outerfont,
 356                                    bool & open_font,
 357                                    Change & running_change,
 358                                    Layout const & style,
 359                                    pos_type & i,
 360                                    unsigned int & column);
 361
 362         ///
 363         void latexSpecialChar(
 364                                    otexstream & os,
 365                                    BufferParams const & bparams,
 366                                    OutputParams const & runparams,
 367                                    Font const & running_font,
 368                                    Change const & running_change,
 369                                    Layout const & style,
 370                                    pos_type & i,
 371                                    pos_type end_pos,
 372                                    unsigned int & column);
 373
 374         ///
 375         bool latexSpecialT1(
 376                 char_type const c,
 377                 otexstream & os,
 378                 pos_type i,
 379                 unsigned int & column);
 380         ///
 381         bool latexSpecialTU(
 382                 char_type const c,
 383                 otexstream & os,
 384                 pos_type i,
 385                 unsigned int & column);
 386         ///
 387         bool latexSpecialT3(
 388                 char_type const c,
 389                 otexstream & os,
 390                 pos_type i,
 391                 unsigned int & column);
 392
 393         ///
 394         void validate(LaTeXFeatures & features) const;
 395
 396         /// Checks if the paragraph contains only text and no inset or font change.
 397         bool onlyText(Buffer const & buf, Font const & outerfont,
 398                       pos_type initial) const;
 399
 400         /// a vector of speller skip positions
 401         typedef vector<FontSpan> SkipPositions;
 402         typedef SkipPositions::const_iterator SkipPositionsIterator;
 403
 404         void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
 405
 406         Language * getSpellLanguage(pos_type const from) const;
 407
 408         Language * locateSpellRange(pos_type & from, pos_type & to,
 409                                     SkipPositions & skips) const;
 410
 411         bool hasSpellerChange() const
 412         {
 413                 SpellChecker::ChangeNumber speller_change_number = 0;
 414                 if (theSpellChecker())
 415                         speller_change_number = theSpellChecker()->changeNumber();
 416                 return speller_change_number > speller_state_.currentChangeNumber();
 417         }
 418
 419         bool ignoreWord(docstring const & word) const ;
 420
 421         void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
 422         {
 423                 pos_type textsize = owner_->size();
 424                 // check for sane arguments
 425                 if (to <= from || from >= textsize)
 426                         return;
 427                 FontSpan fp = FontSpan(from, to - 1);
 428                 speller_state_.setRange(fp, state);
 429         }
 430
 431         void requestSpellCheck(pos_type pos)
 432         {
 433                 if (pos == -1)
 434                         speller_state_.needsCompleteRefresh(speller_state_.currentChangeNumber());
 435                 else
 436                         speller_state_.needsRefresh(pos);
 437         }
 438
 439         void readySpellCheck()
 440         {
 441                 speller_state_.needsRefresh(-1);
 442         }
 443
 444         bool needsSpellCheck() const
 445         {
 446                 return speller_state_.needsRefresh();
 447         }
 448
 449         void rangeOfSpellCheck(pos_type & first, pos_type & last) const
 450         {
 451                 speller_state_.refreshRange(first, last);
 452                 if (last == -1) {
 453                         last = owner_->size();
 454                         return;
 455                 }
 456                 pos_type endpos = last;
 457                 owner_->locateWord(first, endpos, WHOLE_WORD);
 458                 if (endpos < last) {
 459                         endpos = last;
 460                         owner_->locateWord(last, endpos, WHOLE_WORD);
 461                 }
 462                 last = endpos;
 463         }
 464
 465         int countSkips(SkipPositionsIterator & it, SkipPositionsIterator const et,
 466                             int & start) const
 467         {
 468                 int numskips = 0;
 469                 while (it != et && it->first < start) {
 470                         int skip = it->last - it->first + 1;
 471                         start += skip;
 472                         numskips += skip;
 473                         ++it;
 474                 }
 475                 return numskips;
 476         }
 477
 478         void markMisspelledWords(pos_type const & first, pos_type const & last,
 479                                                          SpellChecker::Result result,
 480                                                          docstring const & word,
 481                                                          SkipPositions const & skips);
 482
 483         InsetCode ownerCode() const
 484         {
 485                 return inset_owner_ ? inset_owner_->lyxCode() : NO_CODE;
 486         }
 487
 488         /// Which Paragraph owns us?
 489         Paragraph * owner_;
 490
 491         /// In which Inset?
 492         Inset const * inset_owner_;
 493
 494         ///
 495         FontList fontlist_;
 496
 497         ///
 498         int id_;
 499
 500         ///
 501         ParagraphParameters params_;
 502
 503         /// for recording and looking up changes
 504         Changes changes_;
 505
 506         ///
 507         InsetList insetlist_;
 508
 509         /// end of label
 510         pos_type begin_of_body_;
 511
 512         typedef docstring TextContainer;
 513         ///
 514         TextContainer text_;
 515
 516         typedef set<docstring> Words;
 517         typedef map<string, Words> LangWordsMap;
 518         ///
 519         LangWordsMap words_;
 520         ///
 521         Layout const * layout_;
 522         ///
 523         SpellCheckerState speller_state_;
 524 };
 525
 526
 527 Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
 528         : owner_(owner), inset_owner_(0), id_(-1), begin_of_body_(0), layout_(&layout)
 529 {
 530         text_.reserve(100);
 531 }
 532
 533
 534 //static
 535 int Paragraph::Private::make_id()
 536 {
 537         // The id is unique per session across buffers because it is used in
 538         // LFUN_PARAGRAPH_GOTO to switch to a different buffer, for instance in the
 539         // outliner.
 540         // (thread-safe)
 541         static atomic_uint next_id(0);
 542         return next_id++;
 543 }
 544
 545
 546 Paragraph::Private::Private(Private const & p, Paragraph * owner)
 547         : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
 548           id_(make_id()),
 549           params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
 550           begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
 551           layout_(p.layout_)
 552 {
 553         requestSpellCheck(p.text_.size());
 554 }
 555
 556
 557 Paragraph::Private::Private(Private const & p, Paragraph * owner,
 558         pos_type beg, pos_type end)
 559         : owner_(owner), inset_owner_(p.inset_owner_), id_(make_id()),
 560           params_(p.params_), changes_(p.changes_),
 561           insetlist_(p.insetlist_, beg, end),
 562           begin_of_body_(p.begin_of_body_), words_(p.words_),
 563           layout_(p.layout_)
 564 {
 565         if (beg >= pos_type(p.text_.size()))
 566                 return;
 567         text_ = p.text_.substr(beg, end - beg);
 568
 569         FontList::const_iterator fcit = fontlist_.begin();
 570         FontList::const_iterator fend = fontlist_.end();
 571         for (; fcit != fend; ++fcit) {
 572                 if (fcit->pos() < beg)
 573                         continue;
 574                 if (fcit->pos() >= end) {
 575                         // Add last entry in the fontlist_.
 576                         fontlist_.set(text_.size() - 1, fcit->font());
 577                         break;
 578                 }
 579                 // Add a new entry in the fontlist_.
 580                 fontlist_.set(fcit->pos() - beg, fcit->font());
 581         }
 582         requestSpellCheck(p.text_.size());
 583 }
 584
 585
 586 void Paragraph::addChangesToToc(DocIterator const & cdit, Buffer const & buf,
 587                                 bool output_active, TocBackend & backend) const
 588 {
 589         d->changes_.addToToc(cdit, buf, output_active, backend);
 590 }
 591
 592
 593 void Paragraph::addChangesToBuffer(Buffer const & buf) const
 594 {
 595         d->changes_.updateBuffer(buf);
 596 }
 597
 598
 599 bool Paragraph::isChangeUpdateRequired() const
 600 {
 601         return d->changes_.isUpdateRequired();
 602 }
 603
 604
 605 bool Paragraph::isDeleted(pos_type start, pos_type end) const
 606 {
 607         LASSERT(start >= 0 && start <= size(), return false);
 608         LASSERT(end > start && end <= size() + 1, return false);
 609
 610         return d->changes_.isDeleted(start, end);
 611 }
 612
 613
 614 bool Paragraph::isChanged(pos_type start, pos_type end) const
 615 {
 616         LASSERT(start >= 0 && start <= size(), return false);
 617         LASSERT(end > start && end <= size() + 1, return false);
 618
 619         return d->changes_.isChanged(start, end);
 620 }
 621
 622
 623 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
 624 {
 625         // keep the logic here in sync with the logic of eraseChars()
 626         if (!trackChanges)
 627                 return true;
 628
 629         Change const & change = d->changes_.lookup(size());
 630         return change.inserted() && change.currentAuthor();
 631 }
 632
 633
 634 void Paragraph::setChange(Change const & change)
 635 {
 636         // beware of the imaginary end-of-par character!
 637         d->changes_.set(change, 0, size() + 1);
 638
 639         /*
 640          * Propagate the change recursively - but not in case of DELETED!
 641          *
 642          * Imagine that your co-author makes changes in an existing inset. He
 643          * sends your document to you and you come to the conclusion that the
 644          * inset should go completely. If you erase it, LyX must not delete all
 645          * text within the inset. Otherwise, the change tracked insertions of
 646          * your co-author get lost and there is no way to restore them later.
 647          *
 648          * Conclusion: An inset's content should remain untouched if you delete it
 649          */
 650
 651         if (!change.deleted()) {
 652                 for (pos_type pos = 0; pos < size(); ++pos) {
 653                         if (Inset * inset = getInset(pos))
 654                                 inset->setChange(change);
 655                 }
 656         }
 657 }
 658
 659
 660 void Paragraph::setChange(pos_type pos, Change const & change)
 661 {
 662         LASSERT(pos >= 0 && pos <= size(), return);
 663         d->changes_.set(change, pos);
 664
 665         // see comment in setChange(Change const &) above
 666         if (!change.deleted() && pos < size())
 667                         if (Inset * inset = getInset(pos))
 668                                 inset->setChange(change);
 669 }
 670
 671
 672 Change const & Paragraph::lookupChange(pos_type pos) const
 673 {
 674         LBUFERR(pos >= 0 && pos <= size());
 675         return d->changes_.lookup(pos);
 676 }
 677
 678
 679 void Paragraph::acceptChanges(pos_type start, pos_type end)
 680 {
 681         LASSERT(start >= 0 && start <= size(), return);
 682         LASSERT(end > start && end <= size() + 1, return);
 683
 684         for (pos_type pos = start; pos < end; ++pos) {
 685                 switch (lookupChange(pos).type) {
 686                         case Change::UNCHANGED:
 687                                 // accept changes in nested inset
 688                                 if (Inset * inset = getInset(pos))
 689                                         inset->acceptChanges();
 690                                 break;
 691
 692                         case Change::INSERTED:
 693                                 d->changes_.set(Change(Change::UNCHANGED), pos);
 694                                 // also accept changes in nested inset
 695                                 if (Inset * inset = getInset(pos))
 696                                         inset->acceptChanges();
 697                                 break;
 698
 699                         case Change::DELETED:
 700                                 // Suppress access to non-existent
 701                                 // "end-of-paragraph char"
 702                                 if (pos < size()) {
 703                                         eraseChar(pos, false);
 704                                         --end;
 705                                         --pos;
 706                                 }
 707                                 break;
 708                 }
 709
 710         }
 711 }
 712
 713
 714 void Paragraph::rejectChanges(pos_type start, pos_type end)
 715 {
 716         LASSERT(start >= 0 && start <= size(), return);
 717         LASSERT(end > start && end <= size() + 1, return);
 718
 719         for (pos_type pos = start; pos < end; ++pos) {
 720                 switch (lookupChange(pos).type) {
 721                         case Change::UNCHANGED:
 722                                 // reject changes in nested inset
 723                                 if (Inset * inset = getInset(pos))
 724                                                 inset->rejectChanges();
 725                                 break;
 726
 727                         case Change::INSERTED:
 728                                 // Suppress access to non-existent
 729                                 // "end-of-paragraph char"
 730                                 if (pos < size()) {
 731                                         eraseChar(pos, false);
 732                                         --end;
 733                                         --pos;
 734                                 }
 735                                 break;
 736
 737                         case Change::DELETED:
 738                                 d->changes_.set(Change(Change::UNCHANGED), pos);
 739
 740                                 // Do NOT reject changes within a deleted inset!
 741                                 // There may be insertions of a co-author inside of it!
 742
 743                                 break;
 744                 }
 745         }
 746 }
 747
 748
 749 void Paragraph::Private::insertChar(pos_type pos, char_type c,
 750                 Change const & change)
 751 {
 752         LASSERT(pos >= 0 && pos <= int(text_.size()), return);
 753
 754         // track change
 755         changes_.insert(change, pos);
 756
 757         // This is actually very common when parsing buffers (and
 758         // maybe inserting ascii text)
 759         if (pos == pos_type(text_.size())) {
 760                 // when appending characters, no need to update tables
 761                 text_.push_back(c);
 762                 // but we want spell checking
 763                 requestSpellCheck(pos);
 764                 return;
 765         }
 766
 767         text_.insert(text_.begin() + pos, c);
 768
 769         // Update the font table.
 770         fontlist_.increasePosAfterPos(pos);
 771
 772         // Update the insets
 773         insetlist_.increasePosAfterPos(pos);
 774
 775         // Update list of misspelled positions
 776         speller_state_.increasePosAfterPos(pos);
 777 }
 778
 779
 780 bool Paragraph::insertInset(pos_type pos, Inset * inset,
 781                                    Font const & font, Change const & change)
 782 {
 783         LASSERT(inset, return false);
 784         LASSERT(pos >= 0 && pos <= size(), return false);
 785
 786         // Paragraph::insertInset() can be used in cut/copy/paste operation where
 787         // d->inset_owner_ is not set yet.
 788         if (d->inset_owner_ && !d->inset_owner_->insetAllowed(inset->lyxCode()))
 789                 return false;
 790
 791         d->insertChar(pos, META_INSET, change);
 792         LASSERT(d->text_[pos] == META_INSET, return false);
 793
 794         // Add a new entry in the insetlist_.
 795         d->insetlist_.insert(inset, pos);
 796
 797         // Some insets require run of spell checker
 798         requestSpellCheck(pos);
 799         setFont(pos, font);
 800         return true;
 801 }
 802
 803
 804 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
 805 {
 806         LASSERT(pos >= 0 && pos <= size(), return false);
 807
 808         // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
 809
 810         if (trackChanges) {
 811                 Change change = d->changes_.lookup(pos);
 812
 813                 // set the character to DELETED if
 814                 //  a) it was previously unchanged or
 815                 //  b) it was inserted by a co-author
 816
 817                 if (!change.changed() ||
 818                       (change.inserted() && !change.currentAuthor())) {
 819                         setChange(pos, Change(Change::DELETED));
 820                         // request run of spell checker
 821                         requestSpellCheck(pos);
 822                         return false;
 823                 }
 824
 825                 if (change.deleted())
 826                         return false;
 827         }
 828
 829         // Don't physically access the imaginary end-of-paragraph character.
 830         // eraseChar() can only mark it as DELETED. A physical deletion of
 831         // end-of-par must be handled externally.
 832         if (pos == size()) {
 833                 return false;
 834         }
 835
 836         // track change
 837         d->changes_.erase(pos);
 838
 839         // if it is an inset, delete the inset entry
 840         if (d->text_[pos] == META_INSET)
 841                 d->insetlist_.erase(pos);
 842
 843         d->text_.erase(d->text_.begin() + pos);
 844
 845         // Update the fontlist_
 846         d->fontlist_.erase(pos);
 847
 848         // Update the insetlist_
 849         d->insetlist_.decreasePosAfterPos(pos);
 850
 851         // Update list of misspelled positions
 852         d->speller_state_.decreasePosAfterPos(pos);
 853         d->speller_state_.refreshLast(size());
 854
 855         return true;
 856 }
 857
 858
 859 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
 860 {
 861         LASSERT(start >= 0 && start <= size(), return 0);
 862         LASSERT(end >= start && end <= size() + 1, return 0);
 863
 864         pos_type i = start;
 865         for (pos_type count = end - start; count; --count) {
 866                 if (!eraseChar(i, trackChanges))
 867                         ++i;
 868         }
 869         return end - i;
 870 }
 871
 872
 873 int Paragraph::Private::latexSurrogatePair(BufferParams const & bparams,
 874                 otexstream & os, char_type c, char_type next,
 875                 OutputParams const & runparams)
 876 {
 877         // Writing next here may circumvent a possible font change between
 878         // c and next. Since next is only output if it forms a surrogate pair
 879         // with c we can ignore this:
 880         // A font change inside a surrogate pair does not make sense and is
 881         // hopefully impossible to input.
 882         // FIXME: change tracking
 883         // Is this correct WRT change tracking?
 884         Encoding const & encoding = *(runparams.encoding);
 885         docstring latex1 = encoding.latexChar(next).first;
 886         if (runparams.inIPA) {
 887                 string const tipashortcut = Encodings::TIPAShortcut(next);
 888                 if (!tipashortcut.empty()) {
 889                         latex1 = from_ascii(tipashortcut);
 890                 }
 891         }
 892         docstring latex2 = encoding.latexChar(c).first;
 893
 894         if (docstring(1, next) == latex1) {
 895                 // The encoding supports the combination:
 896                 // output as is (combining char after base char).
 897                 os << latex2 << latex1;
 898                 return latex1.length() + latex2.length();
 899         }
 900
 901         // Handle combining characters in "script" context (i.e., \textgreek and \textcyrillic)
 902         docstring::size_type const brace1 = latex2.find_first_of(from_ascii("{"));
 903         docstring::size_type const brace2 = latex2.find_last_of(from_ascii("}"));
 904         string script = to_ascii(latex2.substr(1, brace1 - 1));
 905         // "Script chars" need to embraced in \textcyrillic and \textgreek notwithstanding
 906         // whether they are encodable or not (it only depends on the font encoding)
 907         if (!runparams.isFullUnicode())
 908                 // This will get us a script value to deal with below
 909                 Encodings::isKnownScriptChar(c, script);
 910         int pos = 0;
 911         int length = brace2;
 912         string fontenc;
 913         if (runparams.local_font)
 914                 fontenc = runparams.local_font->language()->fontenc(bparams);
 915         else
 916                 fontenc = runparams.main_fontenc;
 917         docstring scriptmacro;
 918         docstring cb;
 919         if (script == "textgreek" || script == "textcyrillic") {
 920                 // We separate the script macro (\text[greek|cyr]) from the rest,
 921                 // since we need to include the combining char in it (#6463).
 922                 // This is "the rest":
 923                 pos = brace1 + 1;
 924                 length -= pos;
 925                 latex2 = latex2.substr(pos, length);
 926                 // We only need the script macro with non-native font encodings
 927                 if (Encodings::needsScriptWrapper(script, fontenc)) {
 928                         scriptmacro = from_ascii("\\" + script + "{");
 929                         cb = from_ascii("}");
 930                 }
 931         }
 932
 933         docstring lb;
 934         docstring rb;
 935         // polutonikogreek does not play nice with brackets
 936         if (!runparams.local_font
 937             || runparams.local_font->language()->lang() != "polutonikogreek") {
 938                 lb = from_ascii("{");
 939                 rb = from_ascii("}");
 940         }
 941
 942         os << scriptmacro << latex1 << lb << latex2 << rb << cb;
 943         return latex1.length() + latex2.length() + lb.length() + rb.length() + cb.length();
 944 }
 945
 946
 947 bool Paragraph::Private::simpleTeXBlanks(BufferParams const & bparams,
 948                                        OutputParams const & runparams,
 949                                        otexstream & os,
 950                                        pos_type i,
 951                                        unsigned int & column,
 952                                        Font const & font,
 953                                        Layout const & style)
 954 {
 955         if (style.pass_thru || runparams.pass_thru)
 956                 return false;
 957
 958         if (i + 1 < int(text_.size())) {
 959                 char_type next = text_[i + 1];
 960                 if (Encodings::isCombiningChar(next)) {
 961                         // This space has an accent, so we must always output it.
 962                         column += latexSurrogatePair(bparams, os, ' ', next, runparams) - 1;
 963                         return true;
 964                 }
 965         }
 966
 967         if (runparams.linelen > 0
 968             && column > runparams.linelen
 969             && i
 970             && text_[i - 1] != ' '
 971             && (i + 1 < int(text_.size()))
 972             // same in FreeSpacing mode
 973             && !owner_->isFreeSpacing()
 974             // In typewriter mode, we want to avoid
 975             // ! . ? : at the end of a line
 976             && !(font.fontInfo().family() == TYPEWRITER_FAMILY
 977                  && (text_[i - 1] == '.'
 978                      || text_[i - 1] == '?'
 979                      || text_[i - 1] == ':'
 980                      || text_[i - 1] == '!'))) {
 981                 os << '\n';
 982                 os.texrow().start(owner_->id(), i + 1);
 983                 column = 0;
 984         } else if (style.free_spacing) {
 985                 os << '~';
 986         } else {
 987                 os << ' ';
 988         }
 989         return false;
 990 }
 991
 992
 993 int Paragraph::Private::writeScriptChars(BufferParams const & bparams,
 994                                          OutputParams const & runparams,
 995                                          otexstream & os,
 996                                          docstring const & ltx,
 997                                          Change const & runningChange,
 998                                          Encoding const & encoding,
 999                                          string const fontenc,
1000                                          pos_type & i)
1001 {
1002         // FIXME: modifying i here is not very nice...
1003
1004         // We only arrive here when character text_[i] could not be translated
1005         // into the current latex encoding (or its latex translation has been forced,)
1006         // and it belongs to a known script.
1007         // Parameter ltx contains the latex translation of text_[i] as specified
1008         // in the unicodesymbols file and is something like "\textXXX{<spec>}".
1009         // The latex macro name "textXXX" specifies the script to which text_[i]
1010         // belongs and we use it in order to check whether characters from the
1011         // same script immediately follow, such that we can collect them in a
1012         // single "\textXXX" macro. So, we have to retain "\textXXX{<spec>"
1013         // for the first char but only "<spec>" for all subsequent chars.
1014         docstring::size_type const brace1 = ltx.find_first_of(from_ascii("{"));
1015         docstring::size_type const brace2 = ltx.find_last_of(from_ascii("}"));
1016         string script = to_ascii(ltx.substr(1, brace1 - 1));
1017         int pos = 0;
1018         int length = brace2;
1019         bool closing_brace = true;
1020         if (!Encodings::needsScriptWrapper(script, fontenc)) {
1021                 // Correct font encoding is being used, so we can avoid \text[greek|cyr].
1022                 pos = brace1 + 1;
1023                 length -= pos;
1024                 closing_brace = false;
1025         }
1026         os << ltx.substr(pos, length);
1027         int size = text_.size();
1028         while (i + 1 < size) {
1029                 char_type const next = text_[i + 1];
1030                 // Stop here if next character belongs to another script
1031                 // or there is a change in change tracking status.
1032                 if (!Encodings::isKnownScriptChar(next, script) ||
1033                     runningChange != owner_->lookupChange(i + 1))
1034                         break;
1035                 Font prev_font;
1036                 bool found = false;
1037                 FontList::const_iterator cit = fontlist_.begin();
1038                 FontList::const_iterator end = fontlist_.end();
1039                 for (; cit != end; ++cit) {
1040                         if (cit->pos() >= i && !found) {
1041                                 prev_font = cit->font();
1042                                 found = true;
1043                         }
1044                         if (cit->pos() >= i + 1)
1045                                 break;
1046                 }
1047                 // Stop here if there is a font attribute or encoding change.
1048                 if (found && cit != end && prev_font != cit->font())
1049                         break;
1050
1051                 // Check whether we have a combining pair
1052                 char_type next_next = '\0';
1053                 if (i + 2 < size) {
1054                         next_next = text_[i + 2];
1055                         if (Encodings::isCombiningChar(next_next)) {
1056                                 length += latexSurrogatePair(bparams, os, next, next_next, runparams) - 1;
1057                                 i += 2;
1058                                 continue;
1059                         }
1060                 }
1061
1062                 docstring const latex = encoding.latexChar(next).first;
1063                 docstring::size_type const b1 =
1064                                         latex.find_first_of(from_ascii("{"));
1065                 docstring::size_type const b2 =
1066                                         latex.find_last_of(from_ascii("}"));
1067                 int const len = b2 - b1 - 1;
1068                 os << latex.substr(b1 + 1, len);
1069                 length += len;
1070                 ++i;
1071         }
1072         if (closing_brace) {
1073                 os << '}';
1074                 ++length;
1075         }
1076         return length;
1077 }
1078
1079
1080 void Paragraph::Private::latexInset(BufferParams const & bparams,
1081                                     otexstream & os,
1082                                     OutputParams & runparams,
1083                                     Font & running_font,
1084                                     Font & basefont,
1085                                     Font const & outerfont,
1086                                     bool & open_font,
1087                                     Change & running_change,
1088                                     Layout const & style,
1089                                     pos_type & i,
1090                                     unsigned int & column)
1091 {
1092         Inset * inset = owner_->getInset(i);
1093         LBUFERR(inset);
1094
1095         if (style.pass_thru) {
1096                 odocstringstream ods;
1097                 inset->plaintext(ods, runparams);
1098                 os << ods.str();
1099                 return;
1100         }
1101
1102         // FIXME: move this to InsetNewline::latex
1103         if (inset->lyxCode() == NEWLINE_CODE || inset->lyxCode() == SEPARATOR_CODE) {
1104                 // newlines are handled differently here than
1105                 // the default in simpleTeXSpecialChars().
1106                 if (!style.newline_allowed) {
1107                         os << '\n';
1108                 } else {
1109                         if (open_font) {
1110                                 bool needPar = false;
1111                                 column += running_font.latexWriteEndChanges(
1112                                         os, bparams, runparams,
1113                                         basefont, basefont, needPar);
1114                                 open_font = false;
1115                         }
1116
1117                         if (running_font.fontInfo().family() == TYPEWRITER_FAMILY)
1118                                 os << '~';
1119
1120                         basefont = owner_->getLayoutFont(bparams, outerfont);
1121                         running_font = basefont;
1122
1123                         if (runparams.moving_arg)
1124                                 os << "\\protect ";
1125
1126                 }
1127                 os.texrow().start(owner_->id(), i + 1);
1128                 column = 0;
1129         }
1130
1131         if (owner_->isDeleted(i)) {
1132                 if( ++runparams.inDeletedInset == 1)
1133                         runparams.changeOfDeletedInset = owner_->lookupChange(i);
1134         }
1135
1136         if (inset->canTrackChanges()) {
1137                 column += Changes::latexMarkChange(os, bparams, running_change,
1138                         Change(Change::UNCHANGED), runparams);
1139                 running_change = Change(Change::UNCHANGED);
1140         }
1141
1142         bool close = false;
1143         odocstream::pos_type const len = os.os().tellp();
1144
1145         if (inset->forceLTR()
1146             && !runparams.use_polyglossia
1147             && running_font.isRightToLeft()
1148             // ERT is an exception, it should be output with no
1149             // decorations at all
1150             && inset->lyxCode() != ERT_CODE) {
1151                 if (running_font.language()->lang() == "farsi")
1152                         os << "\\beginL" << termcmd;
1153                 else
1154                         os << "\\L{";
1155                 close = true;
1156         }
1157
1158         // FIXME: Bug: we can have an empty font change here!
1159         // if there has just been a font change, we are going to close it
1160         // right now, which means stupid latex code like \textsf{}. AFAIK,
1161         // this does not harm dvi output. A minor bug, thus (JMarc)
1162
1163         // Some insets cannot be inside a font change command.
1164         // However, even such insets *can* be placed in \L or \R
1165         // or their equivalents (for RTL language switches), so we don't
1166         // close the language in those cases.
1167         // ArabTeX, though, cannot handle this special behavior, it seems.
1168         bool arabtex = basefont.language()->lang() == "arabic_arabtex"
1169                 || running_font.language()->lang() == "arabic_arabtex";
1170         if (open_font && !inset->inheritFont()) {
1171                 bool needPar = false;
1172                 bool closeLanguage = arabtex
1173                         || basefont.isRightToLeft() == running_font.isRightToLeft();
1174                 unsigned int count = running_font.latexWriteEndChanges(os,
1175                                         bparams, runparams, basefont, basefont,
1176                                         needPar, closeLanguage);
1177                 column += count;
1178                 // if any font properties were closed, update the running_font,
1179                 // making sure, however, to leave the language as it was
1180                 if (count > 0) {
1181                         // FIXME: probably a better way to keep track of the old
1182                         // language, than copying the entire font?
1183                         Font const copy_font(running_font);
1184                         basefont = owner_->getLayoutFont(bparams, outerfont);
1185                         running_font = basefont;
1186                         if (!closeLanguage)
1187                                 running_font.setLanguage(copy_font.language());
1188                         // leave font open if language is still open
1189                         open_font = (running_font.language() == basefont.language());
1190                         if (closeLanguage)
1191                                 runparams.local_font = &basefont;
1192                 }
1193         }
1194
1195         size_t const previous_row_count = os.texrow().rows();
1196
1197         try {
1198                 runparams.lastid = id_;
1199                 runparams.lastpos = i;
1200                 inset->latex(os, runparams);
1201         } catch (EncodingException & e) {
1202                 // add location information and throw again.
1203                 e.par_id = id_;
1204                 e.pos = i;
1205                 throw(e);
1206         }
1207
1208         if (close) {
1209                 if (running_font.language()->lang() == "farsi")
1210                                 os << "\\endL" << termcmd;
1211                         else
1212                                 os << '}';
1213         }
1214
1215         if (os.texrow().rows() > previous_row_count) {
1216                 os.texrow().start(owner_->id(), i + 1);
1217                 column = 0;
1218         } else {
1219                 column += (unsigned int)(os.os().tellp() - len);
1220         }
1221
1222         if (owner_->isDeleted(i))
1223                 --runparams.inDeletedInset;
1224 }
1225
1226
1227 void Paragraph::Private::latexSpecialChar(otexstream & os,
1228                                           BufferParams const & bparams,
1229                                           OutputParams const & runparams,
1230                                           Font const & running_font,
1231                                           Change const & running_change,
1232                                           Layout const & style,
1233                                           pos_type & i,
1234                                           pos_type end_pos,
1235                                           unsigned int & column)
1236 {
1237         // With polyglossia, brackets and stuff need not be reversed
1238         // in RTL scripts (see bug #8251)
1239         char_type const c = (runparams.use_polyglossia) ?
1240                 owner_->getUChar(bparams, i) : text_[i];
1241
1242         if (style.pass_thru || runparams.pass_thru
1243             || contains(style.pass_thru_chars, c)
1244             || contains(runparams.pass_thru_chars, c)) {
1245                 if (c != '\0') {
1246                         Encoding const * const enc = runparams.encoding;
1247                         if (enc && !enc->encodable(c))
1248                                 throw EncodingException(c);
1249                         os.put(c);
1250                 }
1251                 return;
1252         }
1253
1254         // TIPA uses its own T3 encoding
1255         if (runparams.inIPA && latexSpecialT3(c, os, i, column))
1256                 return;
1257         // If T1 font encoding is used, use the special
1258         // characters it provides.
1259         // NOTE: Some languages reset the font encoding internally to a
1260         //       non-standard font encoding. If we are using such a language,
1261         //       we do not output special T1 chars.
1262         if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1263             && !runparams.isFullUnicode() && bparams.main_font_encoding() == "T1"
1264             && latexSpecialT1(c, os, i, column))
1265                 return;
1266         // NOTE: XeTeX and LuaTeX use EU1/2 (pre 2017) or TU (as of 2017) encoding
1267         else if (!runparams.inIPA && !running_font.language()->internalFontEncoding()
1268                  && runparams.isFullUnicode() && latexSpecialTU(c, os, i, column))
1269                      return;
1270
1271         // Otherwise, we use what LaTeX provides us.
1272         switch (c) {
1273         case '\\':
1274                 os << "\\textbackslash" << termcmd;
1275                 column += 15;
1276                 break;
1277         case '<':
1278                 os << "\\textless" << termcmd;
1279                 column += 10;
1280                 break;
1281         case '>':
1282                 os << "\\textgreater" << termcmd;
1283                 column += 13;
1284                 break;
1285         case '|':
1286                 os << "\\textbar" << termcmd;
1287                 column += 9;
1288                 break;
1289         case '-':
1290                 os << '-';
1291                 if (i + 1 < static_cast<pos_type>(text_.size()) &&
1292                     (end_pos == -1 || i + 1 < end_pos) &&
1293                     text_[i+1] == '-') {
1294                         // Prevent "--" becoming an en dash and "---" an em dash.
1295                         // (Within \ttfamily, "---" is merged to en dash + hyphen.)
1296                         os << "{}";
1297                         column += 2;
1298                 }
1299                 break;
1300         case '\"':
1301                 os << "\\textquotedbl" << termcmd;
1302                 column += 14;
1303                 break;
1304
1305         case '$': case '&':
1306         case '%': case '#': case '{':
1307         case '}': case '_':
1308                 os << '\\';
1309                 os.put(c);
1310                 column += 1;
1311                 break;
1312
1313         case '~':
1314                 os << "\\textasciitilde" << termcmd;
1315                 column += 16;
1316                 break;
1317
1318         case '^':
1319                 os << "\\textasciicircum" << termcmd;
1320                 column += 17;
1321                 break;
1322
1323         case '*':
1324         case '[':
1325         case ']':
1326                 // avoid being mistaken for optional arguments
1327                 os << '{';
1328                 os.put(c);
1329                 os << '}';
1330                 column += 2;
1331                 break;
1332
1333         case ' ':
1334                 // Blanks are printed before font switching.
1335                 // Sure? I am not! (try nice-latex)
1336                 // I am sure it's correct. LyX might be smarter
1337                 // in the future, but for now, nothing wrong is
1338                 // written. (Asger)
1339                 break;
1340
1341         case 0x2013:
1342         case 0x2014:
1343                 // XeTeX's dash behaviour is determined via a global setting
1344                 if (bparams.use_dash_ligatures
1345                     && owner_->getFontSettings(bparams, i).fontInfo().family() != TYPEWRITER_FAMILY
1346                     && !runparams.inIPA
1347                         // TODO #10961: && not in inset Flex Code
1348                         // TODO #10961: && not in layout LyXCode
1349                     && (!bparams.useNonTeXFonts || runparams.flavor != OutputParams::XETEX)) {
1350                         if (c == 0x2013) {
1351                                 // en-dash
1352                                 os << "--";
1353                                 column +=2;
1354                         } else {
1355                                 // em-dash
1356                                 os << "---";
1357                                 column +=3;
1358                         }
1359                         break;
1360                 }
1361                 // fall through
1362         default:
1363                 if (c == '\0')
1364                         return;
1365
1366                 Encoding const & encoding = *(runparams.encoding);
1367                 char_type next = '\0';
1368                 if (i + 1 < int(text_.size())) {
1369                         next = text_[i + 1];
1370                         if (Encodings::isCombiningChar(next)) {
1371                                 column += latexSurrogatePair(bparams, os, c, next, runparams) - 1;
1372                                 ++i;
1373                                 break;
1374                         }
1375                 }
1376                 string script;
1377                 pair<docstring, bool> latex = encoding.latexChar(c);
1378                 docstring nextlatex;
1379                 bool nexttipas = false;
1380                 string nexttipashortcut;
1381                 if (next != '\0' && next != META_INSET && encoding.encodable(next)) {
1382                         nextlatex = encoding.latexChar(next).first;
1383                         if (runparams.inIPA) {
1384                                 nexttipashortcut = Encodings::TIPAShortcut(next);
1385                                 nexttipas = !nexttipashortcut.empty();
1386                         }
1387                 }
1388                 bool tipas = false;
1389                 if (runparams.inIPA) {
1390                         string const tipashortcut = Encodings::TIPAShortcut(c);
1391                         if (!tipashortcut.empty()) {
1392                                 latex.first = from_ascii(tipashortcut);
1393                                 latex.second = false;
1394                                 tipas = true;
1395                         }
1396                 }
1397                 string fontenc;
1398                 if (running_font.language()->lang() == bparams.language->lang())
1399                         fontenc = runparams.main_fontenc;
1400                 else
1401                         fontenc = running_font.language()->fontenc(bparams);
1402                 // "Script chars" need to embraced in \textcyrillic and \textgreek notwithstanding
1403                 // whether they are encodable or not (it only depends on the font encoding)
1404                 if (!runparams.isFullUnicode() && Encodings::isKnownScriptChar(c, script)) {
1405                         docstring const wrapper = from_ascii("\\" + script + "{");
1406                         docstring ltx = latex.first;
1407                         if (!prefixIs(ltx, wrapper))
1408                                 ltx = wrapper + latex.first + from_ascii("}");
1409                         column += writeScriptChars(bparams, runparams, os, ltx, running_change,
1410                                                    encoding, fontenc, i) - 1;
1411                 } else if (latex.second
1412                          && ((!prefixIs(nextlatex, '\\')
1413                                && !prefixIs(nextlatex, '{')
1414                                && !prefixIs(nextlatex, '}'))
1415                              || (nexttipas
1416                                  && !prefixIs(from_ascii(nexttipashortcut), '\\')))
1417                          && !tipas) {
1418                         // Prevent eating of a following
1419                         // space or command corruption by
1420                         // following characters
1421                         if (next == ' ' || next == '\0') {
1422                                 column += latex.first.length() + 1;
1423                                 os << latex.first << "{}";
1424                         } else {
1425                                 column += latex.first.length();
1426                                 os << latex.first << " ";
1427                         }
1428                 } else {
1429                         column += latex.first.length() - 1;
1430                         os << latex.first;
1431                 }
1432                 break;
1433         }
1434 }
1435
1436
1437 bool Paragraph::Private::latexSpecialT1(char_type const c, otexstream & os,
1438         pos_type i, unsigned int & column)
1439 {
1440         switch (c) {
1441         case '>':
1442         case '<':
1443                 os.put(c);
1444                 // In T1 encoding, these characters exist
1445                 // but we should avoid ligatures
1446                 if (i + 1 >= int(text_.size()) || text_[i + 1] != c)
1447                         return true;
1448                 os << "\\textcompwordmark" << termcmd;
1449                 column += 19;
1450                 return true;
1451         case '|':
1452                 os.put(c);
1453                 return true;
1454         case '\"':
1455                 // soul.sty breaks with \char`\"
1456                 os << "\\textquotedbl" << termcmd;
1457                 column += 14;
1458                 return true;
1459         default:
1460                 return false;
1461         }
1462 }
1463
1464
1465 bool Paragraph::Private::latexSpecialTU(char_type const c, otexstream & os,
1466         pos_type i, unsigned int & column)
1467 {
1468         // TU encoding is currently on par with T1.
1469         return latexSpecialT1(c, os, i, column);
1470 }
1471
1472
1473 bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
1474         pos_type /*i*/, unsigned int & column)
1475 {
1476         switch (c) {
1477         case '*':
1478         case '[':
1479         case ']':
1480         case '\"':
1481                 os.put(c);
1482                 return true;
1483         case '|':
1484                 os << "\\textvertline" << termcmd;
1485                 column += 14;
1486                 return true;
1487         default:
1488                 return false;
1489         }
1490 }
1491
1492
1493 void Paragraph::Private::validate(LaTeXFeatures & features) const
1494 {
1495         if (layout_->inpreamble && inset_owner_) {
1496                 // FIXME: Using a string stream here circumvents the encoding
1497                 // switching machinery of odocstream. Therefore the
1498                 // output is wrong if this paragraph contains content
1499                 // that needs to switch encoding.
1500                 Buffer const & buf = inset_owner_->buffer();
1501                 otexstringstream os;
1502                 os << layout_->preamble();
1503                 size_t const length = os.length();
1504                 TeXOnePar(buf, buf.text(), buf.getParFromID(owner_->id()).pit(), os,
1505                           features.runparams(), string(), 0, -1, true);
1506                 if (os.length() > length)
1507                         features.addPreambleSnippet(os.release(), true);
1508         }
1509
1510         if (features.runparams().flavor == OutputParams::HTML
1511             && layout_->htmltitle()) {
1512                 features.setHTMLTitle(owner_->asString(AS_STR_INSETS | AS_STR_SKIPDELETE));
1513         }
1514
1515         // check the params.
1516         if (!params_.spacing().isDefault())
1517                 features.require("setspace");
1518
1519         // then the layouts
1520         features.useLayout(layout_->name());
1521
1522         // then the fonts
1523         fontlist_.validate(features);
1524
1525         // then the indentation
1526         if (!params_.leftIndent().zero())
1527                 features.require("ParagraphLeftIndent");
1528
1529         // then the insets
1530         InsetList::const_iterator icit = insetlist_.begin();
1531         InsetList::const_iterator iend = insetlist_.end();
1532         for (; icit != iend; ++icit) {
1533                 if (icit->inset) {
1534                         features.inDeletedInset(owner_->isDeleted(icit->pos));
1535                         if (icit->inset->lyxCode() == FOOT_CODE) {
1536                                 // FIXME: an item inset would make things much easier.
1537                                 if ((layout_->latextype == LATEX_LIST_ENVIRONMENT
1538                                      || (layout_->latextype == LATEX_ITEM_ENVIRONMENT
1539                                          && layout_->margintype == MARGIN_FIRST_DYNAMIC))
1540                                     && (icit->pos < begin_of_body_
1541                                         || (icit->pos == begin_of_body_
1542                                             && (icit->pos == 0 || text_[icit->pos - 1] != ' '))))
1543                                         features.saveNoteEnv("description");
1544                         }
1545                         icit->inset->validate(features);
1546                         features.inDeletedInset(false);
1547                         if (layout_->needprotect &&
1548                             icit->inset->lyxCode() == FOOT_CODE)
1549                                 features.require("NeedLyXFootnoteCode");
1550                 }
1551         }
1552
1553         // then the contents
1554         BufferParams const bp = features.runparams().is_child
1555                 ? features.buffer().masterParams() : features.buffer().params();
1556         for (pos_type i = 0; i < int(text_.size()) ; ++i) {
1557                 char_type c = text_[i];
1558                 CharInfo const & ci = Encodings::unicodeCharInfo(c);
1559                 if (c == 0x0022) {
1560                         if (features.runparams().isFullUnicode() && bp.useNonTeXFonts)
1561                                 features.require("textquotedblp");
1562                         else if (bp.main_font_encoding() != "T1"
1563                                  || ((&owner_->getFontSettings(bp, i))->language()->internalFontEncoding()))
1564                                 features.require("textquotedbl");
1565                 } else if (ci.textfeature() && contains(ci.textpreamble(), '=')) {
1566                         // features that depend on the font or input encoding
1567                         string feats = ci.textpreamble();
1568                         string fontenc = (&owner_->getFontSettings(bp, i))->language()->fontenc(bp);
1569                         if (fontenc.empty())
1570                                 fontenc = features.runparams().main_fontenc;
1571                         while (!feats.empty()) {
1572                                 string feat;
1573                                 feats = split(feats, feat, ',');
1574                                 if (contains(feat, "!=")) {
1575                                         // a feature that is required except for the spcified
1576                                         // font or input encodings
1577                                         string realfeature;
1578                                         string const contexts = ltrim(split(feat, realfeature, '!'), "=");
1579                                         // multiple encodings are separated by semicolon
1580                                         vector<string> context = getVectorFromString(contexts, ";");
1581                                         // require feature if the context matches neither current font
1582                                         // nor input encoding
1583                                         if (std::find(context.begin(), context.end(), fontenc) == context.end()
1584                                             && std::find(context.begin(), context.end(),
1585                                                          features.runparams().encoding->name()) == context.end())
1586                                                 features.require(realfeature);
1587                                 } else if (contains(feat, '=')) {
1588                                         // a feature that is required only for the spcified
1589                                         // font or input encodings
1590                                         string realfeature;
1591                                         string const contexts = split(feat, realfeature, '=');
1592                                         // multiple encodings are separated by semicolon
1593                                         vector<string> context = getVectorFromString(contexts, ";");
1594                                         // require feature if the context matches either current font
1595                                         // or input encoding
1596                                         if (std::find(context.begin(), context.end(), fontenc) != context.end()
1597                                             || std::find(context.begin(), context.end(),
1598                                                          features.runparams().encoding->name()) != context.end())
1599                                                 features.require(realfeature);
1600                                 }
1601                         }
1602                 } else if (!bp.use_dash_ligatures
1603                            && (c == 0x2013 || c == 0x2014)
1604                            && bp.useNonTeXFonts
1605                            && features.runparams().flavor == OutputParams::XETEX)
1606                         // XeTeX's dash behaviour is determined via a global setting
1607                         features.require("xetexdashbreakstate");
1608                 BufferEncodings::validate(c, features);
1609         }
1610 }
1611
1612 /////////////////////////////////////////////////////////////////////
1613 //
1614 // Paragraph
1615 //
1616 /////////////////////////////////////////////////////////////////////
1617
1618 namespace {
1619         Layout const emptyParagraphLayout;
1620 }
1621
1622 Paragraph::Paragraph()
1623         : d(new Paragraph::Private(this, emptyParagraphLayout))
1624 {
1625         itemdepth = 0;
1626         d->params_.clear();
1627 }
1628
1629
1630 Paragraph::Paragraph(Paragraph const & par)
1631         : itemdepth(par.itemdepth),
1632         d(new Paragraph::Private(*par.d, this))
1633 {
1634         registerWords();
1635 }
1636
1637
1638 Paragraph::Paragraph(Paragraph const & par, pos_type beg, pos_type end)
1639         : itemdepth(par.itemdepth),
1640         d(new Paragraph::Private(*par.d, this, beg, end))
1641 {
1642         registerWords();
1643 }
1644
1645
1646 Paragraph & Paragraph::operator=(Paragraph const & par)
1647 {
1648         // needed as we will destroy the private part before copying it
1649         if (&par != this) {
1650                 itemdepth = par.itemdepth;
1651
1652                 deregisterWords();
1653                 delete d;
1654                 d = new Private(*par.d, this);
1655                 registerWords();
1656         }
1657         return *this;
1658 }
1659
1660
1661 Paragraph::~Paragraph()
1662 {
1663         deregisterWords();
1664         delete d;
1665 }
1666
1667
1668 namespace {
1669
1670 // this shall be called just before every "os << ..." action.
1671 void flushString(ostream & os, docstring & s)
1672 {
1673         os << to_utf8(s);
1674         s.erase();
1675 }
1676
1677 } // namespace
1678
1679
1680 void Paragraph::write(ostream & os, BufferParams const & bparams,
1681         depth_type & dth) const
1682 {
1683         // The beginning or end of a deeper (i.e. nested) area?
1684         if (dth != d->params_.depth()) {
1685                 if (d->params_.depth() > dth) {
1686                         while (d->params_.depth() > dth) {
1687                                 os << "\n\\begin_deeper";
1688                                 ++dth;
1689                         }
1690                 } else {
1691                         while (d->params_.depth() < dth) {
1692                                 os << "\n\\end_deeper";
1693                                 --dth;
1694                         }
1695                 }
1696         }
1697
1698         // First write the layout
1699         os << "\n\\begin_layout " << to_utf8(d->layout_->name()) << '\n';
1700
1701         d->params_.write(os);
1702
1703         Font font1(inherit_font, bparams.language);
1704
1705         Change running_change = Change(Change::UNCHANGED);
1706
1707         // this string is used as a buffer to avoid repetitive calls
1708         // to to_utf8(), which turn out to be expensive (JMarc)
1709         docstring write_buffer;
1710
1711         int column = 0;
1712         for (pos_type i = 0; i <= size(); ++i) {
1713
1714                 Change const & change = lookupChange(i);
1715                 if (change != running_change)
1716                         flushString(os, write_buffer);
1717                 Changes::lyxMarkChange(os, bparams, column, running_change, change);
1718                 running_change = change;
1719
1720                 if (i == size())
1721                         break;
1722
1723                 // Write font changes
1724                 Font font2 = getFontSettings(bparams, i);
1725                 if (font2 != font1) {
1726                         flushString(os, write_buffer);
1727                         font2.lyxWriteChanges(font1, os);
1728                         column = 0;
1729                         font1 = font2;
1730                 }
1731
1732                 char_type const c = d->text_[i];
1733                 switch (c) {
1734                 case META_INSET:
1735                         if (Inset const * inset = getInset(i)) {
1736                                 flushString(os, write_buffer);
1737                                 if (inset->directWrite()) {
1738                                         // international char, let it write
1739                                         // code directly so it's shorter in
1740                                         // the file
1741                                         inset->write(os);
1742                                 } else {
1743                                         if (i)
1744                                                 os << '\n';
1745                                         os << "\\begin_inset ";
1746                                         inset->write(os);
1747                                         os << "\n\\end_inset\n\n";
1748                                         column = 0;
1749                                 }
1750                                 // FIXME This can be removed again once the mystery
1751                                 // crash has been resolved.
1752                                 os << flush;
1753                         }
1754                         break;
1755                 case '\\':
1756                         flushString(os, write_buffer);
1757                         os << "\n\\backslash\n";
1758                         column = 0;
1759                         break;
1760                 case '.':
1761                         flushString(os, write_buffer);
1762                         if (i + 1 < size() && d->text_[i + 1] == ' ') {
1763                                 os << ".\n";
1764                                 column = 0;
1765                         } else
1766                                 os << '.';
1767                         break;
1768                 default:
1769                         if ((column > 70 && c == ' ')
1770                             || column > 79) {
1771                                 flushString(os, write_buffer);
1772                                 os << '\n';
1773                                 column = 0;
1774                         }
1775                         // this check is to amend a bug. LyX sometimes
1776                         // inserts '\0' this could cause problems.
1777                         if (c != '\0')
1778                                 write_buffer.push_back(c);
1779                         else
1780                                 LYXERR0("NUL char in structure.");
1781                         ++column;
1782                         break;
1783                 }
1784         }
1785
1786         flushString(os, write_buffer);
1787         os << "\n\\end_layout\n";
1788         // FIXME This can be removed again once the mystery
1789         // crash has been resolved.
1790         os << flush;
1791 }
1792
1793
1794 void Paragraph::validate(LaTeXFeatures & features) const
1795 {
1796         d->validate(features);
1797         bool fragile = features.runparams().moving_arg;
1798         fragile |= layout().needprotect;
1799         if (needsCProtection(fragile))
1800                 features.require("cprotect");
1801 }
1802
1803
1804 void Paragraph::insert(pos_type start, docstring const & str,
1805                        Font const & font, Change const & change)
1806 {
1807         for (size_t i = 0, n = str.size(); i != n ; ++i)
1808                 insertChar(start + i, str[i], font, change);
1809 }
1810
1811
1812 void Paragraph::appendChar(char_type c, Font const & font,
1813                 Change const & change)
1814 {
1815         // track change
1816         d->changes_.insert(change, d->text_.size());
1817         // when appending characters, no need to update tables
1818         d->text_.push_back(c);
1819         setFont(d->text_.size() - 1, font);
1820         d->requestSpellCheck(d->text_.size() - 1);
1821 }
1822
1823
1824 void Paragraph::appendString(docstring const & s, Font const & font,
1825                 Change const & change)
1826 {
1827         pos_type end = s.size();
1828         size_t oldsize = d->text_.size();
1829         size_t newsize = oldsize + end;
1830         size_t capacity = d->text_.capacity();
1831         if (newsize >= capacity)
1832                 d->text_.reserve(max(capacity + 100, newsize));
1833
1834         // when appending characters, no need to update tables
1835         d->text_.append(s);
1836
1837         // FIXME: Optimize this!
1838         for (size_t i = oldsize; i != newsize; ++i) {
1839                 // track change
1840                 d->changes_.insert(change, i);
1841                 d->requestSpellCheck(i);
1842         }
1843         d->fontlist_.set(oldsize, font);
1844         d->fontlist_.set(newsize - 1, font);
1845 }
1846
1847
1848 void Paragraph::insertChar(pos_type pos, char_type c,
1849                            bool trackChanges)
1850 {
1851         d->insertChar(pos, c, Change(trackChanges ?
1852                            Change::INSERTED : Change::UNCHANGED));
1853 }
1854
1855
1856 void Paragraph::insertChar(pos_type pos, char_type c,
1857                            Font const & font, bool trackChanges)
1858 {
1859         d->insertChar(pos, c, Change(trackChanges ?
1860                            Change::INSERTED : Change::UNCHANGED));
1861         setFont(pos, font);
1862 }
1863
1864
1865 void Paragraph::insertChar(pos_type pos, char_type c,
1866                            Font const & font, Change const & change)
1867 {
1868         d->insertChar(pos, c, change);
1869         setFont(pos, font);
1870 }
1871
1872
1873 void Paragraph::resetFonts(Font const & font)
1874 {
1875         d->fontlist_.clear();
1876         d->fontlist_.set(0, font);
1877         d->fontlist_.set(d->text_.size() - 1, font);
1878 }
1879
1880 // Gets uninstantiated font setting at position.
1881 Font const & Paragraph::getFontSettings(BufferParams const & bparams,
1882                                          pos_type pos) const
1883 {
1884         if (pos > size()) {
1885                 LYXERR0("pos: " << pos << " size: " << size());
1886                 LBUFERR(false);
1887         }
1888
1889         FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1890         if (cit != d->fontlist_.end())
1891                 return cit->font();
1892
1893         if (pos == size() && !empty())
1894                 return getFontSettings(bparams, pos - 1);
1895
1896         // Optimisation: avoid a full font instantiation if there is no
1897         // language change from previous call.
1898         static Font previous_font;
1899         static Language const * previous_lang = 0;
1900         Language const * lang = getParLanguage(bparams);
1901         if (lang != previous_lang) {
1902                 previous_lang = lang;
1903                 previous_font = Font(inherit_font, lang);
1904         }
1905         return previous_font;
1906 }
1907
1908
1909 FontSpan Paragraph::fontSpan(pos_type pos) const
1910 {
1911         LBUFERR(pos <= size());
1912
1913         if (pos == size())
1914                 return FontSpan(pos, pos);
1915
1916         pos_type start = 0;
1917         FontList::const_iterator cit = d->fontlist_.begin();
1918         FontList::const_iterator end = d->fontlist_.end();
1919         for (; cit != end; ++cit) {
1920                 if (cit->pos() >= pos) {
1921                         if (pos >= beginOfBody())
1922                                 return FontSpan(max(start, beginOfBody()),
1923                                                 cit->pos());
1924                         else
1925                                 return FontSpan(start,
1926                                                 min(beginOfBody() - 1,
1927                                                          cit->pos()));
1928                 }
1929                 start = cit->pos() + 1;
1930         }
1931
1932         // This should not happen, but if so, we take no chances.
1933         LYXERR0("Paragraph::fontSpan: position not found in fontinfo table!");
1934         LASSERT(false, return FontSpan(pos, pos));
1935 }
1936
1937
1938 // Gets uninstantiated font setting at position 0
1939 Font const & Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1940 {
1941         if (!empty() && !d->fontlist_.empty())
1942                 return d->fontlist_.begin()->font();
1943
1944         // Optimisation: avoid a full font instantiation if there is no
1945         // language change from previous call.
1946         static Font previous_font;
1947         static Language const * previous_lang = 0;
1948         if (bparams.language != previous_lang) {
1949                 previous_lang = bparams.language;
1950                 previous_font = Font(inherit_font, bparams.language);
1951         }
1952
1953         return previous_font;
1954 }
1955
1956
1957 // Gets the fully instantiated font at a given position in a paragraph
1958 // This is basically the same function as Text::GetFont() in text2.cpp.
1959 // The difference is that this one is used for generating the LaTeX file,
1960 // and thus cosmetic "improvements" are disallowed: This has to deliver
1961 // the true picture of the buffer. (Asger)
1962 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1963                                  Font const & outerfont) const
1964 {
1965         LBUFERR(pos >= 0);
1966
1967         Font font = getFontSettings(bparams, pos);
1968
1969         pos_type const body_pos = beginOfBody();
1970         FontInfo & fi = font.fontInfo();
1971         if (pos < body_pos)
1972                 fi.realize(d->layout_->labelfont);
1973         else
1974                 fi.realize(d->layout_->font);
1975
1976         fi.realize(outerfont.fontInfo());
1977         fi.realize(bparams.getFont().fontInfo());
1978
1979         return font;
1980 }
1981
1982
1983 Font const Paragraph::getLabelFont
1984         (BufferParams const & bparams, Font const & outerfont) const
1985 {
1986         FontInfo tmpfont = d->layout_->labelfont;
1987         tmpfont.realize(outerfont.fontInfo());
1988         tmpfont.realize(bparams.getFont().fontInfo());
1989         return Font(tmpfont, getParLanguage(bparams));
1990 }
1991
1992
1993 Font const Paragraph::getLayoutFont
1994         (BufferParams const & bparams, Font const & outerfont) const
1995 {
1996         FontInfo tmpfont = d->layout_->font;
1997         tmpfont.realize(outerfont.fontInfo());
1998         tmpfont.realize(bparams.getFont().fontInfo());
1999         return Font(tmpfont, getParLanguage(bparams));
2000 }
2001
2002
2003 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
2004 {
2005         char_type c = d->text_[pos];
2006         if (!getFontSettings(bparams, pos).isRightToLeft())
2007                 return c;
2008
2009         // FIXME: The arabic special casing is due to the difference of arabic
2010         // round brackets input introduced in r18599. Check if this should be
2011         // unified with Hebrew or at least if all bracket types should be
2012         // handled the same (file format change in either case).
2013         string const & lang = getFontSettings(bparams, pos).language()->lang();
2014         bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi"
2015                 || lang == "farsi";
2016         char_type uc = c;
2017         switch (c) {
2018         case '(':
2019                 uc = arabic ? c : ')';
2020                 break;
2021         case ')':
2022                 uc = arabic ? c : '(';
2023                 break;
2024         case '[':
2025                 uc = ']';
2026                 break;
2027         case ']':
2028                 uc = '[';
2029                 break;
2030         case '{':
2031                 uc = '}';
2032                 break;
2033         case '}':
2034                 uc = '{';
2035                 break;
2036         case '<':
2037                 uc = '>';
2038                 break;
2039         case '>':
2040                 uc = '<';
2041                 break;
2042         }
2043
2044         return uc;
2045 }
2046
2047
2048 void Paragraph::setFont(pos_type pos, Font const & font)
2049 {
2050         LASSERT(pos <= size(), return);
2051
2052         // First, reduce font against layout/label font
2053         // Update: The setCharFont() routine in text2.cpp already
2054         // reduces font, so we don't need to do that here. (Asger)
2055
2056         d->fontlist_.set(pos, font);
2057 }
2058
2059
2060 void Paragraph::makeSameLayout(Paragraph const & par)
2061 {
2062         d->layout_ = par.d->layout_;
2063         d->params_ = par.d->params_;
2064 }
2065
2066
2067 bool Paragraph::stripLeadingSpaces(bool trackChanges)
2068 {
2069         if (isFreeSpacing())
2070                 return false;
2071
2072         int pos = 0;
2073         int count = 0;
2074
2075         while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
2076                 if (eraseChar(pos, trackChanges))
2077                         ++count;
2078                 else
2079                         ++pos;
2080         }
2081
2082         return count > 0 || pos > 0;
2083 }
2084
2085
2086 bool Paragraph::hasSameLayout(Paragraph const & par) const
2087 {
2088         return par.d->layout_ == d->layout_
2089                 && d->params_.sameLayout(par.d->params_);
2090 }
2091
2092
2093 depth_type Paragraph::getDepth() const
2094 {
2095         return d->params_.depth();
2096 }
2097
2098
2099 depth_type Paragraph::getMaxDepthAfter() const
2100 {
2101         if (d->layout_->isEnvironment())
2102                 return d->params_.depth() + 1;
2103         else
2104                 return d->params_.depth();
2105 }
2106
2107
2108 LyXAlignment Paragraph::getAlign() const
2109 {
2110         if (d->params_.align() == LYX_ALIGN_LAYOUT)
2111                 return d->layout_->align;
2112         else
2113                 return d->params_.align();
2114 }
2115
2116
2117 docstring const & Paragraph::labelString() const
2118 {
2119         return d->params_.labelString();
2120 }
2121
2122
2123 // the next two functions are for the manual labels
2124 docstring const Paragraph::getLabelWidthString() const
2125 {
2126         if (d->layout_->margintype == MARGIN_MANUAL
2127             || d->layout_->latextype == LATEX_BIB_ENVIRONMENT)
2128                 return d->params_.labelWidthString();
2129         else
2130                 return _("Senseless with this layout!");
2131 }
2132
2133
2134 void Paragraph::setLabelWidthString(docstring const & s)
2135 {
2136         d->params_.labelWidthString(s);
2137 }
2138
2139
2140 docstring Paragraph::expandLabel(Layout const & layout,
2141                 BufferParams const & bparams) const
2142 {
2143         return expandParagraphLabel(layout, bparams, true);
2144 }
2145
2146
2147 docstring Paragraph::expandDocBookLabel(Layout const & layout,
2148                 BufferParams const & bparams) const
2149 {
2150         return expandParagraphLabel(layout, bparams, false);
2151 }
2152
2153
2154 docstring Paragraph::expandParagraphLabel(Layout const & layout,
2155                 BufferParams const & bparams, bool process_appendix) const
2156 {
2157         DocumentClass const & tclass = bparams.documentClass();
2158         string const & lang = getParLanguage(bparams)->code();
2159         bool const in_appendix = process_appendix && d->params_.appendix();
2160         docstring fmt = translateIfPossible(layout.labelstring(in_appendix), lang);
2161
2162         if (fmt.empty() && !layout.counter.empty())
2163                 return tclass.counters().theCounter(layout.counter, lang);
2164
2165         // handle 'inherited level parts' in 'fmt',
2166         // i.e. the stuff between '@' in   '@Section@.\arabic{subsection}'
2167         size_t const i = fmt.find('@', 0);
2168         if (i != docstring::npos) {
2169                 size_t const j = fmt.find('@', i + 1);
2170                 if (j != docstring::npos) {
2171                         docstring parent(fmt, i + 1, j - i - 1);
2172                         docstring label = from_ascii("??");
2173                         if (tclass.hasLayout(parent))
2174                                 label = expandParagraphLabel(tclass[parent], bparams,
2175                                                       process_appendix);
2176                         fmt = docstring(fmt, 0, i) + label
2177                                 + docstring(fmt, j + 1, docstring::npos);
2178                 }
2179         }
2180
2181         return tclass.counters().counterLabel(fmt, lang);
2182 }
2183
2184
2185 void Paragraph::applyLayout(Layout const & new_layout)
2186 {
2187         d->layout_ = &new_layout;
2188         LyXAlignment const oldAlign = d->params_.align();
2189
2190         if (!(oldAlign & d->layout_->alignpossible)) {
2191                 frontend::Alert::warning(_("Alignment not permitted"),
2192                         _("The new layout does not permit the alignment previously used.\nSetting to default."));
2193                 d->params_.align(LYX_ALIGN_LAYOUT);
2194         }
2195 }
2196
2197
2198 pos_type Paragraph::beginOfBody() const
2199 {
2200         return d->begin_of_body_;
2201 }
2202
2203
2204 void Paragraph::setBeginOfBody()
2205 {
2206         if (d->layout_->labeltype != LABEL_MANUAL) {
2207                 d->begin_of_body_ = 0;
2208                 return;
2209         }
2210
2211         // Unroll the first two cycles of the loop
2212         // and remember the previous character to
2213         // remove unnecessary getChar() calls
2214         pos_type i = 0;
2215         pos_type end = size();
2216         if (i < end && !(isNewline(i) || isEnvSeparator(i))) {
2217                 ++i;
2218                 if (i < end) {
2219                         char_type previous_char = d->text_[i];
2220                         if (!(isNewline(i) || isEnvSeparator(i))) {
2221                                 ++i;
2222                                 while (i < end && previous_char != ' ') {
2223                                         char_type temp = d->text_[i];
2224                                         if (isNewline(i) || isEnvSeparator(i))
2225                                                 break;
2226                                         ++i;
2227                                         previous_char = temp;
2228                                 }
2229                         }
2230                 }
2231         }
2232
2233         d->begin_of_body_ = i;
2234 }
2235
2236
2237 bool Paragraph::allowParagraphCustomization() const
2238 {
2239         return inInset().allowParagraphCustomization();
2240 }
2241
2242
2243 bool Paragraph::usePlainLayout() const
2244 {
2245         return inInset().usePlainLayout();
2246 }
2247
2248
2249 bool Paragraph::isPassThru() const
2250 {
2251         return inInset().isPassThru() || d->layout_->pass_thru;
2252 }
2253
2254 namespace {
2255
2256 // paragraphs inside floats need different alignment tags to avoid
2257 // unwanted space
2258
2259 bool noTrivlistCentering(InsetCode code)
2260 {
2261         return code == FLOAT_CODE
2262                || code == WRAP_CODE
2263                || code == CELL_CODE;
2264 }
2265
2266
2267 string correction(string const & orig)
2268 {
2269         if (orig == "flushleft")
2270                 return "raggedright";
2271         if (orig == "flushright")
2272                 return "raggedleft";
2273         if (orig == "center")
2274                 return "centering";
2275         return orig;
2276 }
2277
2278
2279 bool corrected_env(otexstream & os, string const & suffix, string const & env,
2280         InsetCode code, bool const lastpar, int & col)
2281 {
2282         string macro = suffix + "{";
2283         if (noTrivlistCentering(code)) {
2284                 if (lastpar) {
2285                         // the last paragraph in non-trivlist-aligned
2286                         // context is special (to avoid unwanted whitespace)
2287                         if (suffix == "\\begin") {
2288                                 macro = "\\" + correction(env) + "{}";
2289                                 os << from_ascii(macro);
2290                                 col += macro.size();
2291                                 return true;
2292                         }
2293                         return false;
2294                 }
2295                 macro += correction(env);
2296         } else
2297                 macro += env;
2298         macro += "}";
2299         if (suffix == "\\par\\end") {
2300                 os << breakln;
2301                 col = 0;
2302         }
2303         os << from_ascii(macro);
2304         col += macro.size();
2305         if (suffix == "\\begin") {
2306                 os << breakln;
2307                 col = 0;
2308         }
2309         return true;
2310 }
2311
2312 } // namespace
2313
2314
2315 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
2316                         otexstream & os, OutputParams const & runparams) const
2317 {
2318         int column = 0;
2319
2320         bool canindent =
2321                 (bparams.paragraph_separation == BufferParams::ParagraphIndentSeparation) ?
2322                         (layout_->toggle_indent != ITOGGLE_NEVER) :
2323                         (layout_->toggle_indent == ITOGGLE_ALWAYS);
2324
2325         if (canindent && params_.noindent() && !layout_->pass_thru) {
2326                 os << "\\noindent ";
2327                 column += 10;
2328         }
2329
2330         LyXAlignment const curAlign = params_.align();
2331
2332         if (curAlign == layout_->align)
2333                 return column;
2334
2335         switch (curAlign) {
2336         case LYX_ALIGN_NONE:
2337         case LYX_ALIGN_BLOCK:
2338         case LYX_ALIGN_LAYOUT:
2339         case LYX_ALIGN_SPECIAL:
2340         case LYX_ALIGN_DECIMAL:
2341                 break;
2342         case LYX_ALIGN_LEFT:
2343         case LYX_ALIGN_RIGHT:
2344         case LYX_ALIGN_CENTER:
2345                 if (runparams.moving_arg) {
2346                         os << "\\protect";
2347                         column += 8;
2348                 }
2349                 break;
2350         }
2351
2352         string const begin_tag = "\\begin";
2353         InsetCode code = ownerCode();
2354         bool const lastpar = runparams.isLastPar;
2355
2356         switch (curAlign) {
2357         case LYX_ALIGN_NONE:
2358         case LYX_ALIGN_BLOCK:
2359         case LYX_ALIGN_LAYOUT:
2360         case LYX_ALIGN_SPECIAL:
2361         case LYX_ALIGN_DECIMAL:
2362                 break;
2363         case LYX_ALIGN_LEFT: {
2364                 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2365                         corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2366                 else
2367                         corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2368                 break;
2369         } case LYX_ALIGN_RIGHT: {
2370                 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2371                         corrected_env(os, begin_tag, "flushright", code, lastpar, column);
2372                 else
2373                         corrected_env(os, begin_tag, "flushleft", code, lastpar, column);
2374                 break;
2375         } case LYX_ALIGN_CENTER: {
2376                 corrected_env(os, begin_tag, "center", code, lastpar, column);
2377                 break;
2378         }
2379         }
2380
2381         return column;
2382 }
2383
2384
2385 bool Paragraph::Private::endTeXParParams(BufferParams const & bparams,
2386                         otexstream & os, OutputParams const & runparams) const
2387 {
2388         LyXAlignment const curAlign = params_.align();
2389
2390         if (curAlign == layout_->align)
2391                 return false;
2392
2393         switch (curAlign) {
2394         case LYX_ALIGN_NONE:
2395         case LYX_ALIGN_BLOCK:
2396         case LYX_ALIGN_LAYOUT:
2397         case LYX_ALIGN_SPECIAL:
2398         case LYX_ALIGN_DECIMAL:
2399                 break;
2400         case LYX_ALIGN_LEFT:
2401         case LYX_ALIGN_RIGHT:
2402         case LYX_ALIGN_CENTER:
2403                 if (runparams.moving_arg)
2404                         os << "\\protect";
2405                 break;
2406         }
2407
2408         bool output = false;
2409         int col = 0;
2410         string const end_tag = "\\par\\end";
2411         InsetCode code = ownerCode();
2412         bool const lastpar = runparams.isLastPar;
2413
2414         switch (curAlign) {
2415         case LYX_ALIGN_NONE:
2416         case LYX_ALIGN_BLOCK:
2417         case LYX_ALIGN_LAYOUT:
2418         case LYX_ALIGN_SPECIAL:
2419         case LYX_ALIGN_DECIMAL:
2420                 break;
2421         case LYX_ALIGN_LEFT: {
2422                 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2423                         output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2424                 else
2425                         output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2426                 break;
2427         } case LYX_ALIGN_RIGHT: {
2428                 if (owner_->getParLanguage(bparams)->babel() != "hebrew")
2429                         output = corrected_env(os, end_tag, "flushright", code, lastpar, col);
2430                 else
2431                         output = corrected_env(os, end_tag, "flushleft", code, lastpar, col);
2432                 break;
2433         } case LYX_ALIGN_CENTER: {
2434                 corrected_env(os, end_tag, "center", code, lastpar, col);
2435                 break;
2436         }
2437         }
2438
2439         return output || lastpar;
2440 }
2441
2442
2443 // This one spits out the text of the paragraph
2444 void Paragraph::latex(BufferParams const & bparams,
2445         Font const & outerfont,
2446         otexstream & os,
2447         OutputParams const & runparams,
2448         int start_pos, int end_pos, bool force) const
2449 {
2450         LYXERR(Debug::LATEX, "Paragraph::latex...     " << this);
2451
2452         // FIXME This check should not be needed. Perhaps issue an
2453         // error if it triggers.
2454         Layout const & style = inInset().forcePlainLayout() ?
2455                 bparams.documentClass().plainLayout() : *d->layout_;
2456
2457         if (!force && style.inpreamble)
2458                 return;
2459
2460         bool const allowcust = allowParagraphCustomization();
2461
2462         // Current base font for all inherited font changes, without any
2463         // change caused by an individual character, except for the language:
2464         // It is set to the language of the first character.
2465         // As long as we are in the label, this font is the base font of the
2466         // label. Before the first body character it is set to the base font
2467         // of the body.
2468         Font basefont;
2469
2470         // Maybe we have to create a optional argument.
2471         pos_type body_pos = beginOfBody();
2472         unsigned int column = 0;
2473
2474         if (body_pos > 0) {
2475                 // the optional argument is kept in curly brackets in
2476                 // case it contains a ']'
2477                 // This is not strictly needed, but if this is changed it
2478                 // would be a file format change, and tex2lyx would need
2479                 // to be adjusted, since it unconditionally removes the
2480                 // braces when it parses \item.
2481                 os << "[{";
2482                 column += 2;
2483                 basefont = getLabelFont(bparams, outerfont);
2484         } else {
2485                 basefont = getLayoutFont(bparams, outerfont);
2486         }
2487
2488         // Which font is currently active?
2489         Font running_font(basefont);
2490         // Do we have an open font change?
2491         bool open_font = false;
2492
2493         Change runningChange = Change(Change::UNCHANGED);
2494
2495         Encoding const * const prev_encoding = runparams.encoding;
2496
2497         os.texrow().start(id(), 0);
2498
2499         // if the paragraph is empty, the loop will not be entered at all
2500         if (empty()) {
2501                 // For InTitle commands, we have already opened a group
2502                 // in output_latex::TeXOnePar.
2503                 if (style.isCommand() && !style.intitle) {
2504                         os << '{';
2505                         ++column;
2506                 }
2507                 if (!style.leftdelim().empty()) {
2508                         os << style.leftdelim();
2509                         column += style.leftdelim().size();
2510                 }
2511                 if (allowcust)
2512                         column += d->startTeXParParams(bparams, os, runparams);
2513         }
2514
2515         // Whether a \par can be issued for insets typeset inline with text.
2516         // Yes if greater than 0. This has to be static.
2517         THREAD_LOCAL_STATIC int parInline = 0;
2518
2519         for (pos_type i = 0; i < size(); ++i) {
2520                 // First char in paragraph or after label?
2521                 if (i == body_pos) {
2522                         if (body_pos > 0) {
2523                                 if (open_font) {
2524                                         bool needPar = false;
2525                                         column += running_font.latexWriteEndChanges(
2526                                                 os, bparams, runparams,
2527                                                 basefont, basefont, needPar);
2528                                         open_font = false;
2529                                 }
2530                                 basefont = getLayoutFont(bparams, outerfont);
2531                                 running_font = basefont;
2532
2533                                 column += Changes::latexMarkChange(os, bparams,
2534                                                 runningChange, Change(Change::UNCHANGED),
2535                                                 runparams);
2536                                 runningChange = Change(Change::UNCHANGED);
2537
2538                                 os << "}] ";
2539                                 column +=3;
2540                         }
2541                         // For InTitle commands, we have already opened a group
2542                         // in output_latex::TeXOnePar.
2543                         if (style.isCommand() && !style.intitle) {
2544                                 os << '{';
2545                                 ++column;
2546                         }
2547
2548                         if (!style.leftdelim().empty()) {
2549                                 os << style.leftdelim();
2550                                 column += style.leftdelim().size();
2551                         }
2552
2553                         if (allowcust)
2554                                 column += d->startTeXParParams(bparams, os,
2555                                                             runparams);
2556                 }
2557
2558                 runparams.wasDisplayMath = runparams.inDisplayMath;
2559                 runparams.inDisplayMath = false;
2560                 bool deleted_display_math = false;
2561                 Change const & change = runparams.inDeletedInset
2562                         ? runparams.changeOfDeletedInset : lookupChange(i);
2563
2564                 // Check whether a display math inset follows
2565                 if (d->text_[i] == META_INSET
2566                     && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2567                         InsetMath const * im = getInset(i)->asInsetMath();
2568                         if (im && im->asHullInset()
2569                             && im->asHullInset()->outerDisplay()) {
2570                                 runparams.inDisplayMath = true;
2571                                 // runparams.inDeletedInset will be set by
2572                                 // latexInset later, but we need this info
2573                                 // before it is called. On the other hand, we
2574                                 // cannot set it here because it is a counter.
2575                                 deleted_display_math = isDeleted(i);
2576                         }
2577                         if (bparams.output_changes && deleted_display_math
2578                             && runningChange == change
2579                             && change.type == Change::DELETED
2580                             && !os.afterParbreak()) {
2581                                 // A display math in the same paragraph follows.
2582                                 // We have to close and then reopen \lyxdeleted,
2583                                 // otherwise the math will be shifted up.
2584                                 OutputParams rp = runparams;
2585                                 if (open_font) {
2586                                         bool needPar = false;
2587                                         column += running_font.latexWriteEndChanges(
2588                                                 os, bparams, rp, basefont,
2589                                                 basefont, needPar);
2590                                         open_font = false;
2591                                 }
2592                                 basefont = getLayoutFont(bparams, outerfont);
2593                                 running_font = basefont;
2594                                 column += Changes::latexMarkChange(os, bparams,
2595                                         Change(Change::INSERTED), change, rp);
2596                         }
2597                 }
2598
2599                 if (bparams.output_changes && runningChange != change) {
2600                         if (open_font) {
2601                                 bool needPar = false;
2602                                 column += running_font.latexWriteEndChanges(
2603                                                 os, bparams, runparams,
2604                                                 basefont, basefont, needPar);
2605                                 open_font = false;
2606                         }
2607                         basefont = getLayoutFont(bparams, outerfont);
2608                         running_font = basefont;
2609                         column += Changes::latexMarkChange(os, bparams, runningChange,
2610                                                            change, runparams);
2611                         runningChange = change;
2612                 }
2613
2614                 // do not output text which is marked deleted
2615                 // if change tracking output is disabled
2616                 if (!bparams.output_changes && change.deleted()) {
2617                         continue;
2618                 }
2619
2620                 ++column;
2621
2622                 // Fully instantiated font
2623                 Font const current_font = getFont(bparams, i, outerfont);
2624
2625                 Font const last_font = running_font;
2626
2627                 // Do we need to close the previous font?
2628                 if (open_font &&
2629                     (current_font != running_font ||
2630                      current_font.language() != running_font.language()))
2631                 {
2632                         bool needPar = false;
2633                         column += running_font.latexWriteEndChanges(
2634                                     os, bparams, runparams, basefont,
2635                                     (i == body_pos-1) ? basefont : current_font,
2636                                     needPar);
2637                         running_font = basefont;
2638                         open_font = false;
2639                 }
2640
2641                 string const running_lang = runparams.use_polyglossia ?
2642                         running_font.language()->polyglossia() : running_font.language()->babel();
2643                 // close babel's font environment before opening CJK.
2644                 string const lang_end_command = runparams.use_polyglossia ?
2645                         "\\end{$$lang}" : lyxrc.language_command_end;
2646                 bool const using_begin_end = runparams.use_polyglossia ||
2647                                                 !lang_end_command.empty();
2648                 if (!running_lang.empty() &&
2649                     (!using_begin_end || running_lang == openLanguageName()) &&
2650                     current_font.language()->encoding()->package() == Encoding::CJK) {
2651                                 string end_tag = subst(lang_end_command,
2652                                                         "$$lang",
2653                                                         running_lang);
2654                                 os << from_ascii(end_tag);
2655                                 column += end_tag.length();
2656                                 if (using_begin_end)
2657                                         popLanguageName();
2658                 }
2659
2660                 // Switch file encoding if necessary (and allowed)
2661                 if (!runparams.pass_thru && !style.pass_thru &&
2662                     runparams.encoding->package() != Encoding::none &&
2663                     current_font.language()->encoding()->package() != Encoding::none) {
2664                         pair<bool, int> const enc_switch =
2665                                 switchEncoding(os.os(), bparams, runparams,
2666                                         *(current_font.language()->encoding()));
2667                         if (enc_switch.first) {
2668                                 column += enc_switch.second;
2669                                 runparams.encoding = current_font.language()->encoding();
2670                         }
2671                 }
2672
2673                 char_type const c = d->text_[i];
2674
2675                 // A display math inset inside an ulem command will be output
2676                 // as a box of width \linewidth, so we have to either disable
2677                 // indentation if the inset starts a paragraph, or start a new
2678                 // line to accommodate such box. This has to be done before
2679                 // writing any font changing commands.
2680                 if (runparams.inDisplayMath && !deleted_display_math
2681                     && runparams.inulemcmd) {
2682                         if (os.afterParbreak())
2683                                 os << "\\noindent";
2684                         else
2685                                 os << "\\\\\n";
2686                 }
2687
2688                 // Do we need to change font?
2689                 if ((current_font != running_font ||
2690                      current_font.language() != running_font.language()) &&
2691                         i != body_pos - 1)
2692                 {
2693                         odocstringstream ods;
2694                         column += current_font.latexWriteStartChanges(ods, bparams,
2695                                                               runparams, basefont,
2696                                                               last_font);
2697                         // Check again for display math in ulem commands as a
2698                         // font change may also occur just before a math inset.
2699                         if (runparams.inDisplayMath && !deleted_display_math
2700                             && runparams.inulemcmd) {
2701                                 if (os.afterParbreak())
2702                                         os << "\\noindent";
2703                                 else
2704                                         os << "\\\\\n";
2705                         }
2706                         running_font = current_font;
2707                         open_font = true;
2708                         docstring fontchange = ods.str();
2709                         // check whether the fontchange ends with a \\textcolor
2710                         // modifier and the text starts with a space (bug 4473)
2711                         docstring const last_modifier = rsplit(fontchange, '\\');
2712                         if (prefixIs(last_modifier, from_ascii("textcolor")) && c == ' ')
2713                                 os << fontchange << from_ascii("{}");
2714                         // check if the fontchange ends with a trailing blank
2715                         // (like "\small " (see bug 3382)
2716                         else if (suffixIs(fontchange, ' ') && c == ' ')
2717                                 os << fontchange.substr(0, fontchange.size() - 1)
2718                                    << from_ascii("{}");
2719                         else
2720                                 os << fontchange;
2721                 }
2722
2723                 // FIXME: think about end_pos implementation...
2724                 if (c == ' ' && i >= start_pos && (end_pos == -1 || i < end_pos)) {
2725                         // FIXME: integrate this case in latexSpecialChar
2726                         // Do not print the separation of the optional argument
2727                         // if style.pass_thru is false. This works because
2728                         // latexSpecialChar ignores spaces if
2729                         // style.pass_thru is false.
2730                         if (i != body_pos - 1) {
2731                                 if (d->simpleTeXBlanks(bparams, runparams, os,
2732                                                 i, column, current_font, style)) {
2733                                         // A surrogate pair was output. We
2734                                         // must not call latexSpecialChar
2735                                         // in this iteration, since it would output
2736                                         // the combining character again.
2737                                         ++i;
2738                                         continue;
2739                                 }
2740                         }
2741                 }
2742
2743                 OutputParams rp = runparams;
2744                 rp.free_spacing = style.free_spacing;
2745                 rp.local_font = &current_font;
2746                 rp.intitle = style.intitle;
2747
2748                 // Two major modes:  LaTeX or plain
2749                 // Handle here those cases common to both modes
2750                 // and then split to handle the two modes separately.
2751                 if (c == META_INSET) {
2752                         if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2753                                 // Greyedout notes and, in general, all insets
2754                                 // with InsetLayout::isDisplay() == false,
2755                                 // are typeset inline with the text. So, we
2756                                 // can add a \par to the last paragraph of
2757                                 // such insets only if nothing else follows.
2758                                 bool incremented = false;
2759                                 Inset const * inset = getInset(i);
2760                                 InsetText const * textinset = inset
2761                                                         ? inset->asInsetText()
2762                                                         : 0;
2763                                 if (i + 1 == size() && textinset
2764                                     && !inset->getLayout().isDisplay()) {
2765                                         ParagraphList const & pars =
2766                                                 textinset->text().paragraphs();
2767                                         pit_type const pit = pars.size() - 1;
2768                                         Font const lastfont =
2769                                                 pit < 0 || pars[pit].empty()
2770                                                 ? pars[pit].getLayoutFont(
2771                                                                 bparams,
2772                                                                 outerfont)
2773                                                 : pars[pit].getFont(bparams,
2774                                                         pars[pit].size() - 1,
2775                                                         outerfont);
2776                                         if (lastfont.fontInfo().size() !=
2777                                             basefont.fontInfo().size()) {
2778                                                 ++parInline;
2779                                                 incremented = true;
2780                                         }
2781                                 }
2782                                 d->latexInset(bparams, os, rp, running_font,
2783                                                 basefont, outerfont, open_font,
2784                                                 runningChange, style, i, column);
2785                                 if (incremented)
2786                                         --parInline;
2787                         }
2788                 } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
2789                         try {
2790                                 d->latexSpecialChar(os, bparams, rp,
2791                                                     running_font, runningChange,
2792                                                     style, i, end_pos, column);
2793                         } catch (EncodingException & e) {
2794                                 if (runparams.dryrun) {
2795                                         os << "<" << _("LyX Warning: ")
2796                                            << _("uncodable character") << " '";
2797                                         os.put(c);
2798                                         os << "'>";
2799                                 } else {
2800                                         // add location information and throw again.
2801                                         e.par_id = id();
2802                                         e.pos = i;
2803                                         throw(e);
2804                                 }
2805                         }
2806                 }
2807
2808                 // Set the encoding to that returned from latexSpecialChar (see
2809                 // comment for encoding member in OutputParams.h)
2810                 runparams.encoding = rp.encoding;
2811
2812                 // Also carry on the info on a closed ulem command for insets
2813                 // such as Note that do not produce any output, so that no
2814                 // command is ever executed but its opening was recorded.
2815                 runparams.inulemcmd = rp.inulemcmd;
2816         }
2817
2818         // If we have an open font definition, we have to close it
2819         if (open_font) {
2820                 // Make sure that \\par is done with the font of the last
2821                 // character if this has another size as the default.
2822                 // This is necessary because LaTeX (and LyX on the screen)
2823                 // calculates the space between the baselines according
2824                 // to this font. (Matthias)
2825                 //
2826                 // We must not change the font for the last paragraph
2827                 // of non-multipar insets, tabular cells or commands,
2828                 // since this produces unwanted whitespace.
2829
2830                 Font const font = empty()
2831                         ? getLayoutFont(bparams, outerfont)
2832                         : getFont(bparams, size() - 1, outerfont);
2833
2834                 InsetText const * textinset = inInset().asInsetText();
2835
2836                 bool const maintext = textinset
2837                         ? textinset->text().isMainText()
2838                         : false;
2839
2840                 size_t const numpars = textinset
2841                         ? textinset->text().paragraphs().size()
2842                         : 0;
2843
2844                 bool needPar = false;
2845
2846                 if (style.resfont.size() != font.fontInfo().size()
2847                     && (!runparams.isLastPar || maintext
2848                         || (numpars > 1 && d->ownerCode() != CELL_CODE
2849                             && (inInset().getLayout().isDisplay()
2850                                 || parInline)))
2851                     && !style.isCommand()) {
2852                         needPar = true;
2853                 }
2854 #ifdef FIXED_LANGUAGE_END_DETECTION
2855                 if (next_) {
2856                         running_font.latexWriteEndChanges(os, bparams,
2857                                         runparams, basefont,
2858                                         next_->getFont(bparams, 0, outerfont),
2859                                                        needPar);
2860                 } else {
2861                         running_font.latexWriteEndChanges(os, bparams,
2862                                         runparams, basefont, basefont, needPar);
2863                 }
2864 #else
2865 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
2866 //FIXME: there as we start another \selectlanguage with the next paragraph if
2867 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2868                 running_font.latexWriteEndChanges(os, bparams, runparams,
2869                                 basefont, basefont, needPar);
2870 #endif
2871                 if (needPar) {
2872                         // The \par could not be inserted at the same nesting
2873                         // level of the font size change, so do it now.
2874                         os << "{\\" << font.latexSize() << "\\par}";
2875                 }
2876         }
2877
2878         column += Changes::latexMarkChange(os, bparams, runningChange,
2879                                            Change(Change::UNCHANGED), runparams);
2880
2881         // Needed if there is an optional argument but no contents.
2882         if (body_pos > 0 && body_pos == size()) {
2883                 os << "}]~";
2884         }
2885
2886         if (!style.rightdelim().empty()) {
2887                 os << style.rightdelim();
2888                 column += style.rightdelim().size();
2889         }
2890
2891         if (allowcust && d->endTeXParParams(bparams, os, runparams)
2892             && runparams.encoding != prev_encoding) {
2893                 runparams.encoding = prev_encoding;
2894                 os << setEncoding(prev_encoding->iconvName());
2895         }
2896
2897         LYXERR(Debug::LATEX, "Paragraph::latex... done " << this);
2898 }
2899
2900
2901 bool Paragraph::emptyTag() const
2902 {
2903         for (pos_type i = 0; i < size(); ++i) {
2904                 if (Inset const * inset = getInset(i)) {
2905                         InsetCode lyx_code = inset->lyxCode();
2906                         // FIXME testing like that is wrong. What is
2907                         // the intent?
2908                         if (lyx_code != TOC_CODE &&
2909                             lyx_code != INCLUDE_CODE &&
2910                             lyx_code != GRAPHICS_CODE &&
2911                             lyx_code != ERT_CODE &&
2912                             lyx_code != LISTINGS_CODE &&
2913                             lyx_code != FLOAT_CODE &&
2914                             lyx_code != TABULAR_CODE) {
2915                                 return false;
2916                         }
2917                 } else {
2918                         char_type c = d->text_[i];
2919                         if (c != ' ' && c != '\t')
2920                                 return false;
2921                 }
2922         }
2923         return true;
2924 }
2925
2926
2927 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams)
2928         const
2929 {
2930         for (pos_type i = 0; i < size(); ++i) {
2931                 if (Inset const * inset = getInset(i)) {
2932                         InsetCode lyx_code = inset->lyxCode();
2933                         if (lyx_code == LABEL_CODE) {
2934                                 InsetLabel const * const il = static_cast<InsetLabel const *>(inset);
2935                                 docstring const & id = il->getParam("name");
2936                                 return "id='" + to_utf8(sgml::cleanID(buf, runparams, id)) + "'";
2937                         }
2938                 }
2939         }
2940         return string();
2941 }
2942
2943
2944 pos_type Paragraph::firstWordDocBook(odocstream & os, OutputParams const & runparams)
2945         const
2946 {
2947         pos_type i;
2948         for (i = 0; i < size(); ++i) {
2949                 if (Inset const * inset = getInset(i)) {
2950                         inset->docbook(os, runparams);
2951                 } else {
2952                         char_type c = d->text_[i];
2953                         if (c == ' ')
2954                                 break;
2955                         os << sgml::escapeChar(c);
2956                 }
2957         }
2958         return i;
2959 }
2960
2961
2962 pos_type Paragraph::firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams)
2963         const
2964 {
2965         pos_type i;
2966         for (i = 0; i < size(); ++i) {
2967                 if (Inset const * inset = getInset(i)) {
2968                         inset->xhtml(xs, runparams);
2969                 } else {
2970                         char_type c = d->text_[i];
2971                         if (c == ' ')
2972                                 break;
2973                         xs << c;
2974                 }
2975         }
2976         return i;
2977 }
2978
2979
2980 bool Paragraph::Private::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2981 {
2982         Font font_old;
2983         pos_type size = text_.size();
2984         for (pos_type i = initial; i < size; ++i) {
2985                 Font font = owner_->getFont(buf.params(), i, outerfont);
2986                 if (text_[i] == META_INSET)
2987                         return false;
2988                 if (i != initial && font != font_old)
2989                         return false;
2990                 font_old = font;
2991         }
2992
2993         return true;
2994 }
2995
2996
2997 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2998                                     odocstream & os,
2999                                     OutputParams const & runparams,
3000                                     Font const & outerfont,
3001                                     pos_type initial) const
3002 {
3003         bool emph_flag = false;
3004
3005         Layout const & style = *d->layout_;
3006         FontInfo font_old =
3007                 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3008
3009         if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
3010                 os << "]]>";
3011
3012         // parsing main loop
3013         for (pos_type i = initial; i < size(); ++i) {
3014                 Font font = getFont(buf.params(), i, outerfont);
3015
3016                 // handle <emphasis> tag
3017                 if (font_old.emph() != font.fontInfo().emph()) {
3018                         if (font.fontInfo().emph() == FONT_ON) {
3019                                 os << "<emphasis>";
3020                                 emph_flag = true;
3021                         } else if (i != initial) {
3022                                 os << "</emphasis>";
3023                                 emph_flag = false;
3024                         }
3025                 }
3026
3027                 if (Inset const * inset = getInset(i)) {
3028                         inset->docbook(os, runparams);
3029                 } else {
3030                         char_type c = d->text_[i];
3031
3032                         if (style.pass_thru)
3033                                 os.put(c);
3034                         else
3035                                 os << sgml::escapeChar(c);
3036                 }
3037                 font_old = font.fontInfo();
3038         }
3039
3040         if (emph_flag) {
3041                 os << "</emphasis>";
3042         }
3043
3044         if (style.free_spacing)
3045                 os << '\n';
3046         if (style.pass_thru && !d->onlyText(buf, outerfont, initial))
3047                 os << "<![CDATA[";
3048 }
3049
3050
3051 namespace {
3052 void doFontSwitch(vector<html::FontTag> & tagsToOpen,
3053                   vector<html::EndFontTag> & tagsToClose,
3054                   bool & flag, FontState curstate, html::FontTypes type)
3055 {
3056         if (curstate == FONT_ON) {
3057                 tagsToOpen.push_back(html::FontTag(type));
3058                 flag = true;
3059         } else if (flag) {
3060                 tagsToClose.push_back(html::EndFontTag(type));
3061                 flag = false;
3062         }
3063 }
3064 } // namespace
3065
3066
3067 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
3068                                     XHTMLStream & xs,
3069                                     OutputParams const & runparams,
3070                                     Font const & outerfont,
3071                                     bool start_paragraph, bool close_paragraph,
3072                                     pos_type initial) const
3073 {
3074         docstring retval;
3075
3076         // track whether we have opened these tags
3077         bool emph_flag = false;
3078         bool bold_flag = false;
3079         bool noun_flag = false;
3080         bool ubar_flag = false;
3081         bool dbar_flag = false;
3082         bool sout_flag = false;
3083         bool xout_flag = false;
3084         bool wave_flag = false;
3085         // shape tags
3086         bool shap_flag = false;
3087         // family tags
3088         bool faml_flag = false;
3089         // size tags
3090         bool size_flag = false;
3091
3092         Layout const & style = *d->layout_;
3093
3094         if (start_paragraph)
3095                 xs.startDivision(allowEmpty());
3096
3097         FontInfo font_old =
3098                 style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3099
3100         FontShape  curr_fs   = INHERIT_SHAPE;
3101         FontFamily curr_fam  = INHERIT_FAMILY;
3102         FontSize   curr_size = FONT_SIZE_INHERIT;
3103
3104         string const default_family =
3105                 buf.masterBuffer()->params().fonts_default_family;
3106
3107         vector<html::FontTag> tagsToOpen;
3108         vector<html::EndFontTag> tagsToClose;
3109
3110         // parsing main loop
3111         for (pos_type i = initial; i < size(); ++i) {
3112                 // let's not show deleted material in the output
3113                 if (isDeleted(i))
3114                         continue;
3115
3116                 Font const font = getFont(buf.masterBuffer()->params(), i, outerfont);
3117
3118                 // emphasis
3119                 FontState curstate = font.fontInfo().emph();
3120                 if (font_old.emph() != curstate)
3121                         doFontSwitch(tagsToOpen, tagsToClose, emph_flag, curstate, html::FT_EMPH);
3122
3123                 // noun
3124                 curstate = font.fontInfo().noun();
3125                 if (font_old.noun() != curstate)
3126                         doFontSwitch(tagsToOpen, tagsToClose, noun_flag, curstate, html::FT_NOUN);
3127
3128                 // underbar
3129                 curstate = font.fontInfo().underbar();
3130                 if (font_old.underbar() != curstate)
3131                         doFontSwitch(tagsToOpen, tagsToClose, ubar_flag, curstate, html::FT_UBAR);
3132
3133                 // strikeout
3134                 curstate = font.fontInfo().strikeout();
3135                 if (font_old.strikeout() != curstate)
3136                         doFontSwitch(tagsToOpen, tagsToClose, sout_flag, curstate, html::FT_SOUT);
3137
3138                 // xout
3139                 curstate = font.fontInfo().xout();
3140                 if (font_old.xout() != curstate)
3141                         doFontSwitch(tagsToOpen, tagsToClose, xout_flag, curstate, html::FT_XOUT);
3142
3143                 // double underbar
3144                 curstate = font.fontInfo().uuline();
3145                 if (font_old.uuline() != curstate)
3146                         doFontSwitch(tagsToOpen, tagsToClose, dbar_flag, curstate, html::FT_DBAR);
3147
3148                 // wavy line
3149                 curstate = font.fontInfo().uwave();
3150                 if (font_old.uwave() != curstate)
3151                         doFontSwitch(tagsToOpen, tagsToClose, wave_flag, curstate, html::FT_WAVE);
3152
3153                 // bold
3154                 // a little hackish, but allows us to reuse what we have.
3155                 curstate = (font.fontInfo().series() == BOLD_SERIES ? FONT_ON : FONT_OFF);
3156                 if (font_old.series() != font.fontInfo().series())
3157                         doFontSwitch(tagsToOpen, tagsToClose, bold_flag, curstate, html::FT_BOLD);
3158
3159                 // Font shape
3160                 curr_fs = font.fontInfo().shape();
3161                 FontShape old_fs = font_old.shape();
3162                 if (old_fs != curr_fs) {
3163                         if (shap_flag) {
3164                                 switch (old_fs) {
3165                                 case ITALIC_SHAPE:
3166                                         tagsToClose.push_back(html::EndFontTag(html::FT_ITALIC));
3167                                         break;
3168                                 case SLANTED_SHAPE:
3169                                         tagsToClose.push_back(html::EndFontTag(html::FT_SLANTED));
3170                                         break;
3171                                 case SMALLCAPS_SHAPE:
3172                                         tagsToClose.push_back(html::EndFontTag(html::FT_SMALLCAPS));
3173                                         break;
3174                                 case UP_SHAPE:
3175                                 case INHERIT_SHAPE:
3176                                         break;
3177                                 default:
3178                                         // the other tags are for internal use
3179                                         LATTEST(false);
3180                                         break;
3181                                 }
3182                                 shap_flag = false;
3183                         }
3184                         switch (curr_fs) {
3185                         case ITALIC_SHAPE:
3186                                 tagsToOpen.push_back(html::FontTag(html::FT_ITALIC));
3187                                 shap_flag = true;
3188                                 break;
3189                         case SLANTED_SHAPE:
3190                                 tagsToOpen.push_back(html::FontTag(html::FT_SLANTED));
3191                                 shap_flag = true;
3192                                 break;
3193                         case SMALLCAPS_SHAPE:
3194                                 tagsToOpen.push_back(html::FontTag(html::FT_SMALLCAPS));
3195                                 shap_flag = true;
3196                                 break;
3197                         case UP_SHAPE:
3198                         case INHERIT_SHAPE:
3199                                 break;
3200                         default:
3201                                 // the other tags are for internal use
3202                                 LATTEST(false);
3203                                 break;
3204                         }
3205                 }
3206
3207                 // Font family
3208                 curr_fam = font.fontInfo().family();
3209                 FontFamily old_fam = font_old.family();
3210                 if (old_fam != curr_fam) {
3211                         if (faml_flag) {
3212                                 switch (old_fam) {
3213                                 case ROMAN_FAMILY:
3214                                         tagsToClose.push_back(html::EndFontTag(html::FT_ROMAN));
3215                                         break;
3216                                 case SANS_FAMILY:
3217                                         tagsToClose.push_back(html::EndFontTag(html::FT_SANS));
3218                                         break;
3219                                 case TYPEWRITER_FAMILY:
3220                                         tagsToClose.push_back(html::EndFontTag(html::FT_TYPE));
3221                                         break;
3222                                 case INHERIT_FAMILY:
3223                                         break;
3224                                 default:
3225                                         // the other tags are for internal use
3226                                         LATTEST(false);
3227                                         break;
3228                                 }
3229                                 faml_flag = false;
3230                         }
3231                         switch (curr_fam) {
3232                         case ROMAN_FAMILY:
3233                                 // we will treat a "default" font family as roman, since we have
3234                                 // no other idea what to do.
3235                                 if (default_family != "rmdefault" && default_family != "default") {
3236                                         tagsToOpen.push_back(html::FontTag(html::FT_ROMAN));
3237                                         faml_flag = true;
3238                                 }
3239                                 break;
3240                         case SANS_FAMILY:
3241                                 if (default_family != "sfdefault") {
3242                                         tagsToOpen.push_back(html::FontTag(html::FT_SANS));
3243                                         faml_flag = true;
3244                                 }
3245                                 break;
3246                         case TYPEWRITER_FAMILY:
3247                                 if (default_family != "ttdefault") {
3248                                         tagsToOpen.push_back(html::FontTag(html::FT_TYPE));
3249                                         faml_flag = true;
3250                                 }
3251                                 break;
3252                         case INHERIT_FAMILY:
3253                                 break;
3254                         default:
3255                                 // the other tags are for internal use
3256                                 LATTEST(false);
3257                                 break;
3258                         }
3259                 }
3260
3261                 // Font size
3262                 curr_size = font.fontInfo().size();
3263                 FontSize old_size = font_old.size();
3264                 if (old_size != curr_size) {
3265                         if (size_flag) {
3266                                 switch (old_size) {
3267                                 case FONT_SIZE_TINY:
3268                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_TINY));
3269                                         break;
3270                                 case FONT_SIZE_SCRIPT:
3271                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SCRIPT));
3272                                         break;
3273                                 case FONT_SIZE_FOOTNOTE:
3274                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_FOOTNOTE));
3275                                         break;
3276                                 case FONT_SIZE_SMALL:
3277                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_SMALL));
3278                                         break;
3279                                 case FONT_SIZE_LARGE:
3280                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGE));
3281                                         break;
3282                                 case FONT_SIZE_LARGER:
3283                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGER));
3284                                         break;
3285                                 case FONT_SIZE_LARGEST:
3286                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_LARGEST));
3287                                         break;
3288                                 case FONT_SIZE_HUGE:
3289                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGE));
3290                                         break;
3291                                 case FONT_SIZE_HUGER:
3292                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_HUGER));
3293                                         break;
3294                                 case FONT_SIZE_INCREASE:
3295                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_INCREASE));
3296                                         break;
3297                                 case FONT_SIZE_DECREASE:
3298                                         tagsToClose.push_back(html::EndFontTag(html::FT_SIZE_DECREASE));
3299                                         break;
3300                                 case FONT_SIZE_INHERIT:
3301                                 case FONT_SIZE_NORMAL:
3302                                         break;
3303                                 default:
3304                                         // the other tags are for internal use
3305                                         LATTEST(false);
3306                                         break;
3307                                 }
3308                                 size_flag = false;
3309                         }
3310                         switch (curr_size) {
3311                         case FONT_SIZE_TINY:
3312                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_TINY));
3313                                 size_flag = true;
3314                                 break;
3315                         case FONT_SIZE_SCRIPT:
3316                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SCRIPT));
3317                                 size_flag = true;
3318                                 break;
3319                         case FONT_SIZE_FOOTNOTE:
3320                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_FOOTNOTE));
3321                                 size_flag = true;
3322                                 break;
3323                         case FONT_SIZE_SMALL:
3324                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_SMALL));
3325                                 size_flag = true;
3326                                 break;
3327                         case FONT_SIZE_LARGE:
3328                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGE));
3329                                 size_flag = true;
3330                                 break;
3331                         case FONT_SIZE_LARGER:
3332                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGER));
3333                                 size_flag = true;
3334                                 break;
3335                         case FONT_SIZE_LARGEST:
3336                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_LARGEST));
3337                                 size_flag = true;
3338                                 break;
3339                         case FONT_SIZE_HUGE:
3340                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGE));
3341                                 size_flag = true;
3342                                 break;
3343                         case FONT_SIZE_HUGER:
3344                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_HUGER));
3345                                 size_flag = true;
3346                                 break;
3347                         case FONT_SIZE_INCREASE:
3348                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_INCREASE));
3349                                 size_flag = true;
3350                                 break;
3351                         case FONT_SIZE_DECREASE:
3352                                 tagsToOpen.push_back(html::FontTag(html::FT_SIZE_DECREASE));
3353                                 size_flag = true;
3354                                 break;
3355                         case FONT_SIZE_NORMAL:
3356                         case FONT_SIZE_INHERIT:
3357                                 break;
3358                         default:
3359                                 // the other tags are for internal use
3360                                 LATTEST(false);
3361                                 break;
3362                         }
3363                 }
3364
3365                 // FIXME XHTML
3366                 // Other such tags? What about the other text ranges?
3367
3368                 vector<html::EndFontTag>::const_iterator cit = tagsToClose.begin();
3369                 vector<html::EndFontTag>::const_iterator cen = tagsToClose.end();
3370                 for (; cit != cen; ++cit)
3371                         xs << *cit;
3372
3373                 vector<html::FontTag>::const_iterator sit = tagsToOpen.begin();
3374                 vector<html::FontTag>::const_iterator sen = tagsToOpen.end();
3375                 for (; sit != sen; ++sit)
3376                         xs << *sit;
3377
3378                 tagsToClose.clear();
3379                 tagsToOpen.clear();
3380
3381                 Inset const * inset = getInset(i);
3382                 if (inset) {
3383                         if (!runparams.for_toc || inset->isInToc()) {
3384                                 OutputParams np = runparams;
3385                                 np.local_font = &font;
3386                                 // If the paragraph has size 1, then we are in the "special
3387                                 // case" where we do not output the containing paragraph info
3388                                 if (!inset->getLayout().htmlisblock() && size() != 1)
3389                                         np.html_in_par = true;
3390                                 retval += inset->xhtml(xs, np);
3391                         }
3392                 } else {
3393                         char_type c = getUChar(buf.masterBuffer()->params(), i);
3394                         xs << c;
3395                 }
3396                 font_old = font.fontInfo();
3397         }
3398
3399         // FIXME XHTML
3400         // I'm worried about what happens if a branch, say, is itself
3401         // wrapped in some font stuff. I think that will not work.
3402         xs.closeFontTags();
3403         if (close_paragraph)
3404                 xs.endDivision();
3405
3406         return retval;
3407 }
3408
3409
3410 bool Paragraph::isHfill(pos_type pos) const
3411 {
3412         Inset const * inset = getInset(pos);
3413         return inset && inset->isHfill();
3414 }
3415
3416
3417 bool Paragraph::isNewline(pos_type pos) const
3418 {
3419         // U+2028 LINE SEPARATOR
3420         // U+2029 PARAGRAPH SEPARATOR
3421         char_type const c = d->text_[pos];
3422         if (c == 0x2028 || c == 0x2029)
3423                 return true;
3424         Inset const * inset = getInset(pos);
3425         return inset && inset->lyxCode() == NEWLINE_CODE;
3426 }
3427
3428
3429 bool Paragraph::isEnvSeparator(pos_type pos) const
3430 {
3431         Inset const * inset = getInset(pos);
3432         return inset && inset->lyxCode() == SEPARATOR_CODE;
3433 }
3434
3435
3436 bool Paragraph::isLineSeparator(pos_type pos) const
3437 {
3438         char_type const c = d->text_[pos];
3439         if (isLineSeparatorChar(c))
3440                 return true;
3441         Inset const * inset = getInset(pos);
3442         return inset && inset->isLineSeparator();
3443 }
3444
3445
3446 bool Paragraph::isWordSeparator(pos_type pos) const
3447 {
3448         if (pos == size())
3449                 return true;
3450         if (Inset const * inset = getInset(pos))
3451                 return !inset->isLetter();
3452         // if we have a hard hyphen (no en- or emdash) or apostrophe
3453         // we pass this to the spell checker
3454         // FIXME: this method is subject to change, visit
3455         // https://bugzilla.mozilla.org/show_bug.cgi?id=355178
3456         // to get an impression how complex this is.
3457         if (isHardHyphenOrApostrophe(pos))
3458                 return false;
3459         char_type const c = d->text_[pos];
3460         // We want to pass the escape chars to the spellchecker
3461         docstring const escape_chars = from_utf8(lyxrc.spellchecker_esc_chars);
3462         return !isLetterChar(c) && !isDigitASCII(c) && !contains(escape_chars, c);
3463 }
3464
3465
3466 bool Paragraph::isHardHyphenOrApostrophe(pos_type pos) const
3467 {
3468         pos_type const psize = size();
3469         if (pos >= psize)
3470                 return false;
3471         char_type const c = d->text_[pos];
3472         if (c != '-' && c != '\'')
3473                 return false;
3474         int nextpos = pos + 1;
3475         int prevpos = pos > 0 ? pos - 1 : 0;
3476         if ((nextpos == psize || isSpace(nextpos))
3477                 && (pos == 0 || isSpace(prevpos)))
3478                 return false;
3479         return true;
3480 }
3481
3482
3483 bool Paragraph::needsCProtection(bool const fragile) const
3484 {
3485         // first check the layout of the paragraph, but only in insets
3486         InsetText const * textinset = inInset().asInsetText();
3487         bool const maintext = textinset
3488                 ? textinset->text().isMainText()
3489                 : false;
3490
3491         if (!maintext && layout().needcprotect) {
3492                 // Environments need cprotection regardless the content
3493                 if (layout().latextype == LATEX_ENVIRONMENT)
3494                         return true;
3495
3496                 // Commands need cprotection if they contain specific chars
3497                 int const nchars_escape = 9;
3498                 static char_type const chars_escape[nchars_escape] = {
3499                         '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
3500
3501                 docstring const pars = asString();
3502                 for (int k = 0; k < nchars_escape; k++) {
3503                         if (contains(pars, chars_escape[k]))
3504                                 return true;
3505                 }
3506         }
3507
3508         // now check whether we have insets that need cprotection
3509         pos_type size = d->text_.size();
3510         for (pos_type i = 0; i < size; ++i)
3511                 if (isInset(i) && getInset(i)->needsCProtection(maintext, fragile))
3512                         return true;
3513
3514         return false;
3515 }
3516
3517
3518 FontSpan const & Paragraph::getSpellRange(pos_type pos) const
3519 {
3520         return d->speller_state_.getRange(pos);
3521 }
3522
3523
3524 bool Paragraph::isChar(pos_type pos) const
3525 {
3526         if (Inset const * inset = getInset(pos))
3527                 return inset->isChar();
3528         char_type const c = d->text_[pos];
3529         return !isLetterChar(c) && !isDigitASCII(c) && !lyx::isSpace(c);
3530 }
3531
3532
3533 bool Paragraph::isSpace(pos_type pos) const
3534 {
3535         if (Inset const * inset = getInset(pos))
3536                 return inset->isSpace();
3537         char_type const c = d->text_[pos];
3538         return lyx::isSpace(c);
3539 }
3540
3541
3542 Language const *
3543 Paragraph::getParLanguage(BufferParams const & bparams) const
3544 {
3545         if (!empty())
3546                 return getFirstFontSettings(bparams).language();
3547         // FIXME: we should check the prev par as well (Lgb)
3548         return bparams.language;
3549 }
3550
3551
3552 bool Paragraph::isRTL(BufferParams const & bparams) const
3553 {
3554         return getParLanguage(bparams)->rightToLeft()
3555                 && !inInset().getLayout().forceLTR();
3556 }
3557
3558
3559 void Paragraph::changeLanguage(BufferParams const & bparams,
3560                                Language const * from, Language const * to)
3561 {
3562         // change language including dummy font change at the end
3563         for (pos_type i = 0; i <= size(); ++i) {
3564                 Font font = getFontSettings(bparams, i);
3565                 if (font.language() == from) {
3566                         font.setLanguage(to);
3567                         setFont(i, font);
3568                         d->requestSpellCheck(i);
3569                 }
3570         }
3571 }
3572
3573
3574 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
3575 {
3576         Language const * doc_language = bparams.language;
3577         for (auto const & f : d->fontlist_)
3578                 if (f.font().language() != ignore_language &&
3579                     f.font().language() != latex_language &&
3580                     f.font().language() != doc_language)
3581                         return true;
3582         return false;
3583 }
3584
3585
3586 void Paragraph::getLanguages(std::set<Language const *> & langs) const
3587 {
3588         for (auto const & f : d->fontlist_) {
3589                 Language const * lang = f.font().language();
3590                 if (lang != ignore_language &&
3591                     lang != latex_language)
3592                         langs.insert(lang);
3593         }
3594 }
3595
3596
3597 docstring Paragraph::asString(int options) const
3598 {
3599         return asString(0, size(), options);
3600 }
3601
3602
3603 docstring Paragraph::asString(pos_type beg, pos_type end, int options, const OutputParams *runparams) const
3604 {
3605         odocstringstream os;
3606
3607         if (beg == 0
3608             && options & AS_STR_LABEL
3609             && !d->params_.labelString().empty())
3610                 os << d->params_.labelString() << ' ';
3611
3612         for (pos_type i = beg; i < end; ++i) {
3613                 if ((options & AS_STR_SKIPDELETE) && isDeleted(i))
3614                         continue;
3615                 char_type const c = d->text_[i];
3616                 if (isPrintable(c) || c == '\t'
3617                     || (c == '\n' && (options & AS_STR_NEWLINES)))
3618                         os.put(c);
3619                 else if (c == META_INSET && (options & AS_STR_INSETS)) {
3620                         if (c == META_INSET && (options & AS_STR_PLAINTEXT)) {
3621                                 LASSERT(runparams != 0, return docstring());
3622                                 getInset(i)->plaintext(os, *runparams);
3623                         } else {
3624                                 getInset(i)->toString(os);
3625                         }
3626                 }
3627         }
3628
3629         return os.str();
3630 }
3631
3632
3633 void Paragraph::forOutliner(docstring & os, size_t const maxlen,
3634                             bool const shorten, bool const label) const
3635 {
3636         size_t tmplen = shorten ? maxlen + 1 : maxlen;
3637         if (label && !labelString().empty())
3638                 os += labelString() + ' ';
3639         if (!layout().isTocCaption())
3640                 return;
3641         for (pos_type i = 0; i < size() && os.length() < tmplen; ++i) {
3642                 if (isDeleted(i))
3643                         continue;
3644                 char_type const c = d->text_[i];
3645                 if (isPrintable(c))
3646                         os += c;
3647                 else if (c == META_INSET)
3648                         getInset(i)->forOutliner(os, tmplen, false);
3649         }
3650         if (shorten)
3651                 Text::shortenForOutliner(os, maxlen);
3652 }
3653
3654
3655 void Paragraph::setInsetOwner(Inset const * inset)
3656 {
3657         d->inset_owner_ = inset;
3658 }
3659
3660
3661 int Paragraph::id() const
3662 {
3663         return d->id_;
3664 }
3665
3666
3667 void Paragraph::setId(int id)
3668 {
3669         d->id_ = id;
3670 }
3671
3672
3673 Layout const & Paragraph::layout() const
3674 {
3675         return *d->layout_;
3676 }
3677
3678
3679 void Paragraph::setLayout(Layout const & layout)
3680 {
3681         d->layout_ = &layout;
3682 }
3683
3684
3685 void Paragraph::setDefaultLayout(DocumentClass const & tc)
3686 {
3687         setLayout(tc.defaultLayout());
3688 }
3689
3690
3691 void Paragraph::setPlainLayout(DocumentClass const & tc)
3692 {
3693         setLayout(tc.plainLayout());
3694 }
3695
3696
3697 void Paragraph::setPlainOrDefaultLayout(DocumentClass const & tclass)
3698 {
3699         if (usePlainLayout())
3700                 setPlainLayout(tclass);
3701         else
3702                 setDefaultLayout(tclass);
3703 }
3704
3705
3706 Inset const & Paragraph::inInset() const
3707 {
3708         LBUFERR(d->inset_owner_);
3709         return *d->inset_owner_;
3710 }
3711
3712
3713 ParagraphParameters & Paragraph::params()
3714 {
3715         return d->params_;
3716 }
3717
3718
3719 ParagraphParameters const & Paragraph::params() const
3720 {
3721         return d->params_;
3722 }
3723
3724
3725 bool Paragraph::isFreeSpacing() const
3726 {
3727         if (d->layout_->free_spacing)
3728                 return true;
3729         return d->inset_owner_ && d->inset_owner_->isFreeSpacing();
3730 }
3731
3732
3733 bool Paragraph::allowEmpty() const
3734 {
3735         if (d->layout_->keepempty)
3736                 return true;
3737         return d->inset_owner_ && d->inset_owner_->allowEmpty();
3738 }
3739
3740
3741 bool Paragraph::brokenBiblio() const
3742 {
3743         // there is a problem if there is no bibitem at position 0 or
3744         // if there is another bibitem in the paragraph.
3745         return d->layout_->labeltype == LABEL_BIBLIO
3746                 && (d->insetlist_.find(BIBITEM_CODE) != 0
3747                     || d->insetlist_.find(BIBITEM_CODE, 1) > 0);
3748 }
3749
3750
3751 int Paragraph::fixBiblio(Buffer const & buffer)
3752 {
3753         // FIXME: What about the case where paragraph is not BIBLIO
3754         // but there is an InsetBibitem?
3755         // FIXME: when there was already an inset at 0, the return value is 1,
3756         // which does not tell whether another inset has been remove; the
3757         // cursor cannot be correctly updated.
3758
3759         if (d->layout_->labeltype != LABEL_BIBLIO)
3760                 return 0;
3761
3762         bool const track_changes = buffer.params().track_changes;
3763         int bibitem_pos = d->insetlist_.find(BIBITEM_CODE);
3764         bool const hasbibitem0 = bibitem_pos == 0;
3765
3766         if (hasbibitem0) {
3767                 bibitem_pos = d->insetlist_.find(BIBITEM_CODE, 1);
3768                 // There was an InsetBibitem at pos 0, and no other one => OK
3769                 if (bibitem_pos == -1)
3770                         return 0;
3771                 // there is a bibitem at the 0 position, but since
3772                 // there is a second one, we copy the second on the
3773                 // first. We're assuming there are at most two of
3774                 // these, which there should be.
3775                 // FIXME: why does it make sense to do that rather
3776                 // than keep the first? (JMarc)
3777                 Inset * inset = releaseInset(bibitem_pos);
3778                 d->insetlist_.begin()->inset = inset;
3779                 return -bibitem_pos;
3780         }
3781
3782         // We need to create an inset at the beginning
3783         Inset * inset = 0;
3784         if (bibitem_pos > 0) {
3785                 // there was one somewhere in the paragraph, let's move it
3786                 inset = d->insetlist_.release(bibitem_pos);
3787                 eraseChar(bibitem_pos, track_changes);
3788         } else
3789                 // make a fresh one
3790                 inset = new InsetBibitem(const_cast<Buffer *>(&buffer),
3791                                          InsetCommandParams(BIBITEM_CODE));
3792
3793         Font font(inherit_font, buffer.params().language);
3794         insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
3795                                                    : Change::UNCHANGED));
3796
3797         return 1;
3798 }
3799
3800
3801 void Paragraph::checkAuthors(AuthorList const & authorList)
3802 {
3803         d->changes_.checkAuthors(authorList);
3804 }
3805
3806
3807 bool Paragraph::isChanged(pos_type pos) const
3808 {
3809         return lookupChange(pos).changed();
3810 }
3811
3812
3813 bool Paragraph::isInserted(pos_type pos) const
3814 {
3815         return lookupChange(pos).inserted();
3816 }
3817
3818
3819 bool Paragraph::isDeleted(pos_type pos) const
3820 {
3821         return lookupChange(pos).deleted();
3822 }
3823
3824
3825 InsetList const & Paragraph::insetList() const
3826 {
3827         return d->insetlist_;
3828 }
3829
3830
3831 void Paragraph::setInsetBuffers(Buffer & b)
3832 {
3833         d->insetlist_.setBuffer(b);
3834 }
3835
3836
3837 void Paragraph::resetBuffer()
3838 {
3839         d->insetlist_.resetBuffer();
3840 }
3841
3842
3843 Inset * Paragraph::releaseInset(pos_type pos)
3844 {
3845         Inset * inset = d->insetlist_.release(pos);
3846         /// does not honour change tracking!
3847         eraseChar(pos, false);
3848         return inset;
3849 }
3850
3851
3852 Inset * Paragraph::getInset(pos_type pos)
3853 {
3854         return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3855                  ? d->insetlist_.get(pos) : 0;
3856 }
3857
3858
3859 Inset const * Paragraph::getInset(pos_type pos) const
3860 {
3861         return (pos < pos_type(d->text_.size()) && d->text_[pos] == META_INSET)
3862                  ? d->insetlist_.get(pos) : 0;
3863 }
3864
3865
3866 void Paragraph::changeCase(BufferParams const & bparams, pos_type pos,
3867                 pos_type & right, TextCase action)
3868 {
3869         // process sequences of modified characters; in change
3870         // tracking mode, this approach results in much better
3871         // usability than changing case on a char-by-char basis
3872         // We also need to track the current font, since font
3873         // changes within sequences can occur.
3874         vector<pair<char_type, Font> > changes;
3875
3876         bool const trackChanges = bparams.track_changes;
3877
3878         bool capitalize = true;
3879
3880         for (; pos < right; ++pos) {
3881                 char_type oldChar = d->text_[pos];
3882                 char_type newChar = oldChar;
3883
3884                 // ignore insets and don't play with deleted text!
3885                 if (oldChar != META_INSET && !isDeleted(pos)) {
3886                         switch (action) {
3887                                 case text_lowercase:
3888                                         newChar = lowercase(oldChar);
3889                                         break;
3890                                 case text_capitalization:
3891                                         if (capitalize) {
3892                                                 newChar = uppercase(oldChar);
3893                                                 capitalize = false;
3894                                         }
3895                                         break;
3896                                 case text_uppercase:
3897                                         newChar = uppercase(oldChar);
3898                                         break;
3899                         }
3900                 }
3901
3902                 if (isWordSeparator(pos) || isDeleted(pos)) {
3903                         // permit capitalization again
3904                         capitalize = true;
3905                 }
3906
3907                 if (oldChar != newChar) {
3908                         changes.push_back(make_pair(newChar, getFontSettings(bparams, pos)));
3909                         if (pos != right - 1)
3910                                 continue;
3911                         // step behind the changing area
3912                         pos++;
3913                 }
3914
3915                 int erasePos = pos - changes.size();
3916                 for (size_t i = 0; i < changes.size(); i++) {
3917                         insertChar(pos, changes[i].first,
3918                                    changes[i].second,
3919                                    trackChanges);
3920                         if (!eraseChar(erasePos, trackChanges)) {
3921                                 ++erasePos;
3922                                 ++pos; // advance
3923                                 ++right; // expand selection
3924                         }
3925                 }
3926                 changes.clear();
3927         }
3928 }
3929
3930
3931 int Paragraph::find(docstring const & str, bool cs, bool mw,
3932                 pos_type start_pos, bool del) const
3933 {
3934         pos_type pos = start_pos;
3935         int const strsize = str.length();
3936         int i = 0;
3937         pos_type const parsize = d->text_.size();
3938         for (i = 0; i < strsize && pos < parsize; ++i, ++pos) {
3939                 // Ignore "invisible" letters such as ligature breaks
3940                 // and hyphenation chars while searching
3941                 while (pos < parsize - 1 && isInset(pos)) {
3942                         odocstringstream os;
3943                         getInset(pos)->toString(os);
3944                         if (!getInset(pos)->isLetter() || !os.str().empty())
3945                                 break;
3946                         pos++;
3947                 }
3948                 if (cs && str[i] != d->text_[pos])
3949                         break;
3950                 if (!cs && uppercase(str[i]) != uppercase(d->text_[pos]))
3951                         break;
3952                 if (!del && isDeleted(pos))
3953                         break;
3954         }
3955
3956         if (i != strsize)
3957                 return 0;
3958
3959         // if necessary, check whether string matches word
3960         if (mw) {
3961                 if (start_pos > 0 && !isWordSeparator(start_pos - 1))
3962                         return 0;
3963                 if (pos < parsize
3964                         && !isWordSeparator(pos))
3965                         return 0;
3966         }
3967
3968         return pos - start_pos;
3969 }
3970
3971
3972 char_type Paragraph::getChar(pos_type pos) const
3973 {
3974         return d->text_[pos];
3975 }
3976
3977
3978 pos_type Paragraph::size() const
3979 {
3980         return d->text_.size();
3981 }
3982
3983
3984 bool Paragraph::empty() const
3985 {
3986         return d->text_.empty();
3987 }
3988
3989
3990 bool Paragraph::isInset(pos_type pos) const
3991 {
3992         return d->text_[pos] == META_INSET;
3993 }
3994
3995
3996 bool Paragraph::isSeparator(pos_type pos) const
3997 {
3998         //FIXME: Are we sure this can be the only separator?
3999         return d->text_[pos] == ' ';
4000 }
4001
4002
4003 void Paragraph::deregisterWords()
4004 {
4005         Private::LangWordsMap::const_iterator itl = d->words_.begin();
4006         Private::LangWordsMap::const_iterator ite = d->words_.end();
4007         for (; itl != ite; ++itl) {
4008                 WordList & wl = theWordList(itl->first);
4009                 Private::Words::const_iterator it = (itl->second).begin();
4010                 Private::Words::const_iterator et = (itl->second).end();
4011                 for (; it != et; ++it)
4012                         wl.remove(*it);
4013         }
4014         d->words_.clear();
4015 }
4016
4017
4018 void Paragraph::locateWord(pos_type & from, pos_type & to,
4019         word_location const loc) const
4020 {
4021         switch (loc) {
4022         case WHOLE_WORD_STRICT:
4023                 if (from == 0 || from == size()
4024                     || isWordSeparator(from)
4025                     || isWordSeparator(from - 1)) {
4026                         to = from;
4027                         return;
4028                 }
4029                 // fall through
4030
4031         case WHOLE_WORD:
4032                 // If we are already at the beginning of a word, do nothing
4033                 if (!from || isWordSeparator(from - 1))
4034                         break;
4035                 // fall through
4036
4037         case PREVIOUS_WORD:
4038                 // always move the cursor to the beginning of previous word
4039                 while (from && !isWordSeparator(from - 1))
4040                         --from;
4041                 break;
4042         case NEXT_WORD:
4043                 LYXERR0("Paragraph::locateWord: NEXT_WORD not implemented yet");
4044                 break;
4045         case PARTIAL_WORD:
4046                 // no need to move the 'from' cursor
4047                 break;
4048         }
4049         to = from;
4050         while (to < size() && !isWordSeparator(to))
4051                 ++to;
4052 }
4053
4054
4055 void Paragraph::collectWords()
4056 {
4057         for (pos_type pos = 0; pos < size(); ++pos) {
4058                 if (isWordSeparator(pos))
4059                         continue;
4060                 pos_type from = pos;
4061                 locateWord(from, pos, WHOLE_WORD);
4062                 // Work around MSVC warning: The statement
4063                 // if (pos < from + lyxrc.completion_minlength)
4064                 // triggers a signed vs. unsigned warning.
4065                 // I don't know why this happens, it could be a MSVC bug, or
4066                 // related to LLP64 (windows) vs. LP64 (unix) programming
4067                 // model, or the C++ standard might be ambigous in the section
4068                 // defining the "usual arithmetic conversions". However, using
4069                 // a temporary variable is safe and works on all compilers.
4070                 pos_type const endpos = from + lyxrc.completion_minlength;
4071                 if (pos < endpos)
4072                         continue;
4073                 FontList::const_iterator cit = d->fontlist_.fontIterator(from);
4074                 if (cit == d->fontlist_.end())
4075                         return;
4076                 Language const * lang = cit->font().language();
4077                 docstring const word = asString(from, pos, AS_STR_NONE);
4078                 d->words_[lang->lang()].insert(word);
4079         }
4080 }
4081
4082
4083 void Paragraph::registerWords()
4084 {
4085         Private::LangWordsMap::const_iterator itl = d->words_.begin();
4086         Private::LangWordsMap::const_iterator ite = d->words_.end();
4087         for (; itl != ite; ++itl) {
4088                 WordList & wl = theWordList(itl->first);
4089                 Private::Words::const_iterator it = (itl->second).begin();
4090                 Private::Words::const_iterator et = (itl->second).end();
4091                 for (; it != et; ++it)
4092                         wl.insert(*it);
4093         }
4094 }
4095
4096
4097 void Paragraph::updateWords()
4098 {
4099         deregisterWords();
4100         collectWords();
4101         registerWords();
4102 }
4103
4104
4105 void Paragraph::Private::appendSkipPosition(SkipPositions & skips, pos_type const pos) const
4106 {
4107         SkipPositionsIterator begin = skips.begin();
4108         SkipPositions::iterator end = skips.end();
4109         if (pos > 0 && begin < end) {
4110                 --end;
4111                 if (end->last == pos - 1) {
4112                         end->last = pos;
4113                         return;
4114                 }
4115         }
4116         skips.insert(end, FontSpan(pos, pos));
4117 }
4118
4119
4120 Language * Paragraph::Private::locateSpellRange(
4121         pos_type & from, pos_type & to,
4122         SkipPositions & skips) const
4123 {
4124         // skip leading white space
4125         while (from < to && owner_->isWordSeparator(from))
4126                 ++from;
4127         // don't check empty range
4128         if (from >= to)
4129                 return 0;
4130         // get current language
4131         Language * lang = getSpellLanguage(from);
4132         pos_type last = from;
4133         bool samelang = true;
4134         bool sameinset = true;
4135         while (last < to && samelang && sameinset) {
4136                 // hop to end of word
4137                 while (last < to && !owner_->isWordSeparator(last)) {
4138                         if (owner_->getInset(last)) {
4139                                 appendSkipPosition(skips, last);
4140                         } else if (owner_->isDeleted(last)) {
4141                                 appendSkipPosition(skips, last);
4142                         }
4143                         ++last;
4144                 }
4145                 // hop to next word while checking for insets
4146                 while (sameinset && last < to && owner_->isWordSeparator(last)) {
4147                         if (Inset const * inset = owner_->getInset(last))
4148                                 sameinset = inset->isChar() && inset->isLetter();
4149                         if (sameinset && owner_->isDeleted(last)) {
4150                                 appendSkipPosition(skips, last);
4151                         }
4152                         if (sameinset)
4153                                 last++;
4154                 }
4155                 if (sameinset && last < to) {
4156                         // now check for language change
4157                         samelang = lang == getSpellLanguage(last);
4158                 }
4159         }
4160         // if language change detected backstep is needed
4161         if (!samelang)
4162                 --last;
4163         to = last;
4164         return lang;
4165 }
4166
4167
4168 Language * Paragraph::Private::getSpellLanguage(pos_type const from) const
4169 {
4170         Language * lang =
4171                 const_cast<Language *>(owner_->getFontSettings(
4172                         inset_owner_->buffer().params(), from).language());
4173         if (lang == inset_owner_->buffer().params().language
4174                 && !lyxrc.spellchecker_alt_lang.empty()) {
4175                 string lang_code;
4176                 string const lang_variety =
4177                         split(lyxrc.spellchecker_alt_lang, lang_code, '-');
4178                 lang->setCode(lang_code);
4179                 lang->setVariety(lang_variety);
4180         }
4181         return lang;
4182 }
4183
4184
4185 void Paragraph::requestSpellCheck(pos_type pos)
4186 {
4187         d->requestSpellCheck(pos);
4188 }
4189
4190
4191 bool Paragraph::needsSpellCheck() const
4192 {
4193         SpellChecker::ChangeNumber speller_change_number = 0;
4194         if (theSpellChecker())
4195                 speller_change_number = theSpellChecker()->changeNumber();
4196         if (speller_change_number > d->speller_state_.currentChangeNumber()) {
4197                 d->speller_state_.needsCompleteRefresh(speller_change_number);
4198         }
4199         return d->needsSpellCheck();
4200 }
4201
4202
4203 bool Paragraph::Private::ignoreWord(docstring const & word) const
4204 {
4205         // Ignore words with digits
4206         // FIXME: make this customizable
4207         // (note that some checkers ignore words with digits by default)
4208         docstring::const_iterator cit = word.begin();
4209         docstring::const_iterator const end = word.end();
4210         for (; cit != end; ++cit) {
4211                 if (isNumber((*cit)))
4212                         return true;
4213         }
4214         return false;
4215 }
4216
4217
4218 SpellChecker::Result Paragraph::spellCheck(pos_type & from, pos_type & to,
4219         WordLangTuple & wl, docstring_list & suggestions,
4220         bool do_suggestion, bool check_learned) const
4221 {
4222         SpellChecker::Result result = SpellChecker::WORD_OK;
4223         SpellChecker * speller = theSpellChecker();
4224         if (!speller)
4225                 return result;
4226
4227         if (!d->layout_->spellcheck || !inInset().allowSpellCheck())
4228                 return result;
4229
4230         locateWord(from, to, WHOLE_WORD);
4231         if (from == to || from >= size())
4232                 return result;
4233
4234         docstring word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4235         Language * lang = d->getSpellLanguage(from);
4236
4237         wl = WordLangTuple(word, lang);
4238
4239         if (word.empty())
4240                 return result;
4241
4242         if (needsSpellCheck() || check_learned) {
4243                 pos_type end = to;
4244                 if (!d->ignoreWord(word)) {
4245                         bool const trailing_dot = to < size() && d->text_[to] == '.';
4246                         result = speller->check(wl);
4247                         if (SpellChecker::misspelled(result) && trailing_dot) {
4248                                 wl = WordLangTuple(word.append(from_ascii(".")), lang);
4249                                 result = speller->check(wl);
4250                                 if (!SpellChecker::misspelled(result)) {
4251                                         LYXERR(Debug::GUI, "misspelled word is correct with dot: \"" <<
4252                                            word << "\" [" <<
4253                                            from << ".." << to << "]");
4254                                 } else {
4255                                         // spell check with dot appended failed too
4256                                         // restore original word/lang value
4257                                         word = asString(from, to, AS_STR_INSETS | AS_STR_SKIPDELETE);
4258                                         wl = WordLangTuple(word, lang);
4259                                 }
4260                         }
4261                 }
4262                 if (!SpellChecker::misspelled(result)) {
4263                         // area up to the begin of the next word is not misspelled
4264                         while (end < size() && isWordSeparator(end))
4265                                 ++end;
4266                 }
4267                 d->setMisspelled(from, end, result);
4268         } else {
4269                 result = d->speller_state_.getState(from);
4270         }
4271
4272         if (do_suggestion)
4273                 suggestions.clear();
4274
4275         if (SpellChecker::misspelled(result)) {
4276                 LYXERR(Debug::GUI, "misspelled word: \"" <<
4277                            word << "\" [" <<
4278                            from << ".." << to << "]");
4279                 if (do_suggestion)
4280                         speller->suggest(wl, suggestions);
4281         }
4282         return result;
4283 }
4284
4285
4286 void Paragraph::anonymize()
4287 {
4288         // This is a very crude anonymization for now
4289         for (char_type & c : d->text_)
4290                 if (isLetterChar(c) || isNumber(c))
4291                         c = 'a';
4292 }
4293
4294
4295 void Paragraph::Private::markMisspelledWords(
4296         pos_type const & first, pos_type const & last,
4297         SpellChecker::Result result,
4298         docstring const & word,
4299         SkipPositions const & skips)
4300 {
4301         if (!SpellChecker::misspelled(result)) {
4302                 setMisspelled(first, last, SpellChecker::WORD_OK);
4303                 return;
4304         }
4305         int snext = first;
4306         SpellChecker * speller = theSpellChecker();
4307         // locate and enumerate the error positions
4308         int nerrors = speller->numMisspelledWords();
4309         int numskipped = 0;
4310         SkipPositionsIterator it = skips.begin();
4311         SkipPositionsIterator et = skips.end();
4312         for (int index = 0; index < nerrors; ++index) {
4313                 int wstart;
4314                 int wlen = 0;
4315                 speller->misspelledWord(index, wstart, wlen);
4316                 /// should not happen if speller supports range checks
4317                 if (!wlen) continue;
4318                 docstring const misspelled = word.substr(wstart, wlen);
4319                 wstart += first + numskipped;
4320                 if (snext < wstart) {
4321                         /// mark the range of correct spelling
4322                         numskipped += countSkips(it, et, wstart);
4323                         setMisspelled(snext,
4324                                 wstart - 1, SpellChecker::WORD_OK);
4325                 }
4326                 snext = wstart + wlen;
4327                 numskipped += countSkips(it, et, snext);
4328                 /// mark the range of misspelling
4329                 setMisspelled(wstart, snext, result);
4330                 LYXERR(Debug::GUI, "misspelled word: \"" <<
4331                            misspelled << "\" [" <<
4332                            wstart << ".." << (snext-1) << "]");
4333                 ++snext;
4334         }
4335         if (snext <= last) {
4336                 /// mark the range of correct spelling at end
4337                 setMisspelled(snext, last, SpellChecker::WORD_OK);
4338         }
4339 }
4340
4341
4342 void Paragraph::spellCheck() const
4343 {
4344         SpellChecker * speller = theSpellChecker();
4345         if (!speller || empty() ||!needsSpellCheck())
4346                 return;
4347         pos_type start;
4348         pos_type endpos;
4349         d->rangeOfSpellCheck(start, endpos);
4350         if (speller->canCheckParagraph()) {
4351                 // loop until we leave the range
4352                 for (pos_type first = start; first < endpos; ) {
4353                         pos_type last = endpos;
4354                         Private::SkipPositions skips;
4355                         Language * lang = d->locateSpellRange(first, last, skips);
4356                         if (first >= endpos)
4357                                 break;
4358                         // start the spell checker on the unit of meaning
4359                         docstring word = asString(first, last, AS_STR_INSETS + AS_STR_SKIPDELETE);
4360                         WordLangTuple wl = WordLangTuple(word, lang);
4361                         SpellChecker::Result result = word.size() ?
4362                                 speller->check(wl) : SpellChecker::WORD_OK;
4363                         d->markMisspelledWords(first, last, result, word, skips);
4364                         first = ++last;
4365                 }
4366         } else {
4367                 static docstring_list suggestions;
4368                 pos_type to = endpos;
4369                 while (start < endpos) {
4370                         WordLangTuple wl;
4371                         spellCheck(start, to, wl, suggestions, false);
4372                         start = to + 1;
4373                 }
4374         }
4375         d->readySpellCheck();
4376 }
4377
4378
4379 bool Paragraph::isMisspelled(pos_type pos, bool check_boundary) const
4380 {
4381         bool result = SpellChecker::misspelled(d->speller_state_.getState(pos));
4382         if (result || pos <= 0 || pos > size())
4383                 return result;
4384         if (check_boundary && (pos == size() || isWordSeparator(pos)))
4385                 result = SpellChecker::misspelled(d->speller_state_.getState(pos - 1));
4386         return result;
4387 }
4388
4389
4390 string Paragraph::magicLabel() const
4391 {
4392         stringstream ss;
4393         ss << "magicparlabel-" << id();
4394         return ss.str();
4395 }
4396
4397
4398 } // namespace lyx