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 Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Dekel Tsur
  13  * \author Jürgen Vigna
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #include <config.h>
  19
  20 #include "Paragraph.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "Changes.h"
  25 #include "Counters.h"
  26 #include "Encoding.h"
  27 #include "debug.h"
  28 #include "gettext.h"
  29 #include "InsetList.h"
  30 #include "Language.h"
  31 #include "LaTeXFeatures.h"
  32 #include "Color.h"
  33 #include "Layout.h"
  34 #include "Length.h"
  35 #include "Font.h"
  36 #include "FontList.h"
  37 #include "LyXRC.h"
  38 #include "Messages.h"
  39 #include "OutputParams.h"
  40 #include "output_latex.h"
  41 #include "paragraph_funcs.h"
  42 #include "ParagraphParameters.h"
  43 #include "sgml.h"
  44 #include "TexRow.h"
  45 #include "VSpace.h"
  46
  47 #include "frontends/alert.h"
  48 #include "frontends/FontMetrics.h"
  49
  50 #include "insets/InsetBibitem.h"
  51 #include "insets/InsetOptArg.h"
  52
  53 #include "support/lstrings.h"
  54 #include "support/textutils.h"
  55 #include "support/convert.h"
  56 #include "support/unicode.h"
  57
  58 #include <sstream>
  59
  60 using std::endl;
  61 using std::string;
  62 using std::ostream;
  63
  64 namespace lyx {
  65
  66 using support::contains;
  67 using support::prefixIs;
  68 using support::suffixIs;
  69 using support::rsplit;
  70 using support::rtrim;
  71
  72
  73 /////////////////////////////////////////////////////////////////////
  74 //
  75 // Paragraph::Private
  76 //
  77 /////////////////////////////////////////////////////////////////////
  78
  79 class Paragraph::Private
  80 {
  81 public:
  82         ///
  83         Private(Paragraph * owner);
  84         /// "Copy constructor"
  85         Private(Private const &, Paragraph * owner);
  86
  87         ///
  88         value_type getChar(pos_type pos) const;
  89         ///
  90         void insertChar(pos_type pos, value_type c, Change const & change);
  91
  92         /// Output the surrogate pair formed by \p c and \p next to \p os.
  93         /// \return the number of characters written.
  94         int latexSurrogatePair(odocstream & os, value_type c, value_type next,
  95                                Encoding const &);
  96
  97         /// Output a space in appropriate formatting (or a surrogate pair
  98         /// if the next character is a combining character).
  99         /// \return whether a surrogate pair was output.
 100         bool simpleTeXBlanks(Encoding const &,
 101                              odocstream &, TexRow & texrow,
 102                              pos_type i,
 103                              unsigned int & column,
 104                              Font const & font,
 105                              Layout const & style);
 106
 107         /// Output consecutive known unicode chars, belonging to the same
 108         /// language as specified by \p preamble, to \p os starting from \p c.
 109         /// \return the number of characters written.
 110         int knownLangChars(odocstream & os, value_type c, string & preamble,
 111                            Change &, Encoding const &, pos_type &);
 112         ///
 113         void latexInset(Buffer const &, BufferParams const &,
 114                                    odocstream &,
 115                                    TexRow & texrow, OutputParams &,
 116                                    Font & running_font,
 117                                    Font & basefont,
 118                                    Font const & outerfont,
 119                                    bool & open_font,
 120                                    Change & running_change,
 121                                    Layout const & style,
 122                                    pos_type & i,
 123                                    unsigned int & column);
 124
 125         ///
 126         void latexSpecialChar(
 127                                    odocstream & os,
 128                                    OutputParams & runparams,
 129                                    Font & running_font,
 130                                    Change & running_change,
 131                                    Layout const & style,
 132                                    pos_type & i,
 133                                    unsigned int & column);
 134
 135         ///
 136         void validate(LaTeXFeatures & features,
 137                       Layout const & layout) const;
 138
 139         ///
 140         pos_type size() const { return owner_->size(); }
 141
 142         /// match a string against a particular point in the paragraph
 143         bool isTextAt(std::string const & str, pos_type pos) const;
 144
 145         /// Which Paragraph owns us?
 146         Paragraph * owner_;
 147
 148         /// In which Inset?
 149         Inset * inset_owner_;
 150
 151         ///
 152         FontList fontlist_;
 153
 154         ///
 155         unsigned int id_;
 156         ///
 157         static unsigned int paragraph_id;
 158         ///
 159         ParagraphParameters params_;
 160
 161         /// for recording and looking up changes
 162         Changes changes_;
 163
 164         ///
 165         InsetList insetlist_;
 166 };
 167
 168
 169
 170
 171 using std::endl;
 172 using std::upper_bound;
 173 using std::lower_bound;
 174 using std::string;
 175
 176
 177 // Initialization of the counter for the paragraph id's,
 178 unsigned int Paragraph::Private::paragraph_id = 0;
 179
 180 namespace {
 181
 182 struct special_phrase {
 183         string phrase;
 184         docstring macro;
 185         bool builtin;
 186 };
 187
 188 special_phrase const special_phrases[] = {
 189         { "LyX", from_ascii("\\protect\\LyX{}"), false },
 190         { "TeX", from_ascii("\\protect\\TeX{}"), true },
 191         { "LaTeX2e", from_ascii("\\protect\\LaTeXe{}"), true },
 192         { "LaTeX", from_ascii("\\protect\\LaTeX{}"), true },
 193 };
 194
 195 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
 196
 197 } // namespace anon
 198
 199
 200 Paragraph::Private::Private(Paragraph * owner)
 201         : owner_(owner)
 202 {
 203         inset_owner_ = 0;
 204         id_ = paragraph_id++;
 205 }
 206
 207
 208 Paragraph::Private::Private(Private const & p, Paragraph * owner)
 209         : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
 210           params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_)
 211 {
 212         id_ = paragraph_id++;
 213 }
 214
 215
 216 bool Paragraph::isChanged(pos_type start, pos_type end) const
 217 {
 218         BOOST_ASSERT(start >= 0 && start <= size());
 219         BOOST_ASSERT(end > start && end <= size() + 1);
 220
 221         return d->changes_.isChanged(start, end);
 222 }
 223
 224
 225 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const {
 226         // keep the logic here in sync with the logic of eraseChars()
 227
 228         if (!trackChanges) {
 229                 return true;
 230         }
 231
 232         Change change = d->changes_.lookup(size());
 233
 234         return change.type == Change::INSERTED && change.author == 0;
 235 }
 236
 237
 238 void Paragraph::setChange(Change const & change)
 239 {
 240         // beware of the imaginary end-of-par character!
 241         d->changes_.set(change, 0, size() + 1);
 242
 243         /*
 244          * Propagate the change recursively - but not in case of DELETED!
 245          *
 246          * Imagine that your co-author makes changes in an existing inset. He
 247          * sends your document to you and you come to the conclusion that the
 248          * inset should go completely. If you erase it, LyX must not delete all
 249          * text within the inset. Otherwise, the change tracked insertions of
 250          * your co-author get lost and there is no way to restore them later.
 251          *
 252          * Conclusion: An inset's content should remain untouched if you delete it
 253          */
 254
 255         if (change.type != Change::DELETED) {
 256                 for (pos_type pos = 0; pos < size(); ++pos) {
 257                         if (isInset(pos))
 258                                 getInset(pos)->setChange(change);
 259                 }
 260         }
 261 }
 262
 263
 264 void Paragraph::setChange(pos_type pos, Change const & change)
 265 {
 266         BOOST_ASSERT(pos >= 0 && pos <= size());
 267
 268         d->changes_.set(change, pos);
 269
 270         // see comment in setChange(Change const &) above
 271
 272         if (change.type != Change::DELETED &&
 273             pos < size() && isInset(pos)) {
 274                 getInset(pos)->setChange(change);
 275         }
 276 }
 277
 278
 279 Change const & Paragraph::lookupChange(pos_type pos) const
 280 {
 281         BOOST_ASSERT(pos >= 0 && pos <= size());
 282
 283         return d->changes_.lookup(pos);
 284 }
 285
 286
 287 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start,
 288                 pos_type end)
 289 {
 290         BOOST_ASSERT(start >= 0 && start <= size());
 291         BOOST_ASSERT(end > start && end <= size() + 1);
 292
 293         for (pos_type pos = start; pos < end; ++pos) {
 294                 switch (lookupChange(pos).type) {
 295                         case Change::UNCHANGED:
 296                                 // accept changes in nested inset
 297                                 if (pos < size() && isInset(pos))
 298                                         getInset(pos)->acceptChanges(bparams);
 299
 300                                 break;
 301
 302                         case Change::INSERTED:
 303                                 d->changes_.set(Change(Change::UNCHANGED), pos);
 304                                 // also accept changes in nested inset
 305                                 if (pos < size() && isInset(pos)) {
 306                                         getInset(pos)->acceptChanges(bparams);
 307                                 }
 308                                 break;
 309
 310                         case Change::DELETED:
 311                                 // Suppress access to non-existent
 312                                 // "end-of-paragraph char"
 313                                 if (pos < size()) {
 314                                         eraseChar(pos, false);
 315                                         --end;
 316                                         --pos;
 317                                 }
 318                                 break;
 319                 }
 320
 321         }
 322 }
 323
 324
 325 void Paragraph::rejectChanges(BufferParams const & bparams,
 326                 pos_type start, pos_type end)
 327 {
 328         BOOST_ASSERT(start >= 0 && start <= size());
 329         BOOST_ASSERT(end > start && end <= size() + 1);
 330
 331         for (pos_type pos = start; pos < end; ++pos) {
 332                 switch (lookupChange(pos).type) {
 333                         case Change::UNCHANGED:
 334                                 // reject changes in nested inset
 335                                 if (pos < size() && isInset(pos)) {
 336                                         getInset(pos)->rejectChanges(bparams);
 337                                 }
 338                                 break;
 339
 340                         case Change::INSERTED:
 341                                 // Suppress access to non-existent
 342                                 // "end-of-paragraph char"
 343                                 if (pos < size()) {
 344                                         eraseChar(pos, false);
 345                                         --end;
 346                                         --pos;
 347                                 }
 348                                 break;
 349
 350                         case Change::DELETED:
 351                                 d->changes_.set(Change(Change::UNCHANGED), pos);
 352
 353                                 // Do NOT reject changes within a deleted inset!
 354                                 // There may be insertions of a co-author inside of it!
 355
 356                                 break;
 357                 }
 358         }
 359 }
 360
 361
 362 Paragraph::value_type Paragraph::Private::getChar(pos_type pos) const
 363 {
 364         BOOST_ASSERT(pos >= 0 && pos <= size());
 365
 366         return owner_->getChar(pos);
 367 }
 368
 369
 370 void Paragraph::Private::insertChar(pos_type pos, value_type c,
 371                 Change const & change)
 372 {
 373         BOOST_ASSERT(pos >= 0 && pos <= size());
 374
 375         // track change
 376         changes_.insert(change, pos);
 377
 378         // This is actually very common when parsing buffers (and
 379         // maybe inserting ascii text)
 380         if (pos == size()) {
 381                 // when appending characters, no need to update tables
 382                 owner_->text_.push_back(c);
 383                 return;
 384         }
 385
 386         owner_->text_.insert(owner_->text_.begin() + pos, c);
 387
 388         // Update the font table.
 389         fontlist_.increasePosAfterPos(pos);
 390
 391         // Update the insets
 392         insetlist_.increasePosAfterPos(pos);
 393 }
 394
 395
 396 void Paragraph::insertInset(pos_type pos, Inset * inset,
 397                                    Change const & change)
 398 {
 399         BOOST_ASSERT(inset);
 400         BOOST_ASSERT(pos >= 0 && pos <= size());
 401
 402         d->insertChar(pos, META_INSET, change);
 403         BOOST_ASSERT(text_[pos] == META_INSET);
 404
 405         // Add a new entry in the insetlist_.
 406         d->insetlist_.insert(inset, pos);
 407 }
 408
 409
 410 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
 411 {
 412         BOOST_ASSERT(pos >= 0 && pos <= size());
 413
 414         // keep the logic here in sync with the logic of isMergedOnEndOfParDeletion()
 415
 416         if (trackChanges) {
 417                 Change change = d->changes_.lookup(pos);
 418
 419                 // set the character to DELETED if
 420                 //  a) it was previously unchanged or
 421                 //  b) it was inserted by a co-author
 422
 423                 if (change.type == Change::UNCHANGED ||
 424                     (change.type == Change::INSERTED && change.author != 0)) {
 425                         setChange(pos, Change(Change::DELETED));
 426                         return false;
 427                 }
 428
 429                 if (change.type == Change::DELETED)
 430                         return false;
 431         }
 432
 433         // Don't physically access the imaginary end-of-paragraph character.
 434         // eraseChar() can only mark it as DELETED. A physical deletion of
 435         // end-of-par must be handled externally.
 436         if (pos == size()) {
 437                 return false;
 438         }
 439
 440         // track change
 441         d->changes_.erase(pos);
 442
 443         // if it is an inset, delete the inset entry
 444         if (text_[pos] == Paragraph::META_INSET)
 445                 d->insetlist_.erase(pos);
 446
 447         text_.erase(text_.begin() + pos);
 448
 449         // Update the fontlist_
 450         d->fontlist_.erase(pos);
 451
 452         // Update the insetlist_
 453         d->insetlist_.decreasePosAfterPos(pos);
 454
 455         return true;
 456 }
 457
 458
 459 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
 460 {
 461         BOOST_ASSERT(start >= 0 && start <= size());
 462         BOOST_ASSERT(end >= start && end <= size() + 1);
 463
 464         pos_type i = start;
 465         for (pos_type count = end - start; count; --count) {
 466                 if (!eraseChar(i, trackChanges))
 467                         ++i;
 468         }
 469         return end - i;
 470 }
 471
 472
 473 int Paragraph::Private::latexSurrogatePair(odocstream & os, value_type c,
 474                 value_type next, Encoding const & encoding)
 475 {
 476         // Writing next here may circumvent a possible font change between
 477         // c and next. Since next is only output if it forms a surrogate pair
 478         // with c we can ignore this:
 479         // A font change inside a surrogate pair does not make sense and is
 480         // hopefully impossible to input.
 481         // FIXME: change tracking
 482         // Is this correct WRT change tracking?
 483         docstring const latex1 = encoding.latexChar(next);
 484         docstring const latex2 = encoding.latexChar(c);
 485         os << latex1 << '{' << latex2 << '}';
 486         return latex1.length() + latex2.length() + 2;
 487 }
 488
 489
 490 bool Paragraph::Private::simpleTeXBlanks(Encoding const & encoding,
 491                                        odocstream & os, TexRow & texrow,
 492                                        pos_type i,
 493                                        unsigned int & column,
 494                                        Font const & font,
 495                                        Layout const & style)
 496 {
 497         if (style.pass_thru)
 498                 return false;
 499
 500         if (i + 1 < size()) {
 501                 char_type next = getChar(i + 1);
 502                 if (Encodings::isCombiningChar(next)) {
 503                         // This space has an accent, so we must always output it.
 504                         column += latexSurrogatePair(os, ' ', next, encoding) - 1;
 505                         return true;
 506                 }
 507         }
 508
 509         if (lyxrc.plaintext_linelen > 0
 510             && column > lyxrc.plaintext_linelen
 511             && i
 512             && getChar(i - 1) != ' '
 513             && (i + 1 < size())
 514             // same in FreeSpacing mode
 515             && !owner_->isFreeSpacing()
 516             // In typewriter mode, we want to avoid
 517             // ! . ? : at the end of a line
 518             && !(font.family() == Font::TYPEWRITER_FAMILY
 519                  && (getChar(i - 1) == '.'
 520                      || getChar(i - 1) == '?'
 521                      || getChar(i - 1) == ':'
 522                      || getChar(i - 1) == '!'))) {
 523                 os << '\n';
 524                 texrow.newline();
 525                 texrow.start(owner_->id(), i + 1);
 526                 column = 0;
 527         } else if (style.free_spacing) {
 528                 os << '~';
 529         } else {
 530                 os << ' ';
 531         }
 532         return false;
 533 }
 534
 535
 536 int Paragraph::Private::knownLangChars(odocstream & os,
 537                                      value_type c,
 538                                      string & preamble,
 539                                      Change & runningChange,
 540                                      Encoding const & encoding,
 541                                      pos_type & i)
 542 {
 543         // When the character is marked by the proper language, we simply
 544         // get its code point in some encoding, otherwise we get the
 545         // translation specified in the unicodesymbols file, which is
 546         // something like "\textLANG{<spec>}". So, we have to retain
 547         // "\textLANG{<spec>" for the first char but only "<spec>" for
 548         // all subsequent chars.
 549         docstring const latex1 = rtrim(encoding.latexChar(c), "}");
 550         int length = latex1.length();
 551         os << latex1;
 552         while (i + 1 < size()) {
 553                 char_type next = getChar(i + 1);
 554                 // Stop here if next character belongs to another
 555                 // language or there is a change tracking status.
 556                 if (!Encodings::isKnownLangChar(next, preamble) ||
 557                     runningChange != owner_->lookupChange(i + 1))
 558                         break;
 559                 Font prev_font;
 560                 bool found = false;
 561                 FontList::const_iterator cit = fontlist_.begin();
 562                 FontList::const_iterator end = fontlist_.end();
 563                 for (; cit != end; ++cit) {
 564                         if (cit->pos() >= i && !found) {
 565                                 prev_font = cit->font();
 566                                 found = true;
 567                         }
 568                         if (cit->pos() >= i + 1)
 569                                 break;
 570                 }
 571                 // Stop here if there is a font attribute change.
 572                 if (found && cit != end && prev_font != cit->font())
 573                         break;
 574                 docstring const latex = rtrim(encoding.latexChar(next), "}");
 575                 docstring::size_type const j =
 576                                         latex.find_first_of(from_ascii("{"));
 577                 if (j == docstring::npos) {
 578                         os << latex;
 579                         length += latex.length();
 580                 } else {
 581                         os << latex.substr(j + 1);
 582                         length += latex.substr(j + 1).length();
 583                 }
 584                 ++i;
 585         }
 586         // When the proper language is set, we are simply passed a code
 587         // point, so we should not try to close the \textLANG command.
 588         if (prefixIs(latex1, from_ascii("\\" + preamble))) {
 589                 os << '}';
 590                 ++length;
 591         }
 592         return length;
 593 }
 594
 595
 596 bool Paragraph::Private::isTextAt(string const & str, pos_type pos) const
 597 {
 598         pos_type const len = str.length();
 599
 600         // is the paragraph large enough?
 601         if (pos + len > size())
 602                 return false;
 603
 604         // does the wanted text start at point?
 605         for (string::size_type i = 0; i < str.length(); ++i) {
 606                 // Caution: direct comparison of characters works only
 607                 // because str is pure ASCII.
 608                 if (str[i] != owner_->text_[pos + i])
 609                         return false;
 610         }
 611
 612         return fontlist_.hasChangeInRange(pos, len);
 613 }
 614
 615
 616 void Paragraph::Private::latexInset(Buffer const & buf,
 617                                              BufferParams const & bparams,
 618                                              odocstream & os,
 619                                              TexRow & texrow,
 620                                              OutputParams & runparams,
 621                                              Font & running_font,
 622                                              Font & basefont,
 623                                              Font const & outerfont,
 624                                              bool & open_font,
 625                                              Change & running_change,
 626                                              Layout const & style,
 627                                              pos_type & i,
 628                                              unsigned int & column)
 629 {
 630         Inset * inset = owner_->getInset(i);
 631         BOOST_ASSERT(inset);
 632
 633         if (style.pass_thru) {
 634                 inset->plaintext(buf, os, runparams);
 635                 return;
 636         }
 637
 638         // FIXME: move this to InsetNewline::latex
 639         if (inset->lyxCode() == NEWLINE_CODE) {
 640                 // newlines are handled differently here than
 641                 // the default in simpleTeXSpecialChars().
 642                 if (!style.newline_allowed) {
 643                         os << '\n';
 644                 } else {
 645                         if (open_font) {
 646                                 column += running_font.latexWriteEndChanges(
 647                                         os, bparams, runparams,
 648                                         basefont, basefont);
 649                                 open_font = false;
 650                         }
 651
 652                         if (running_font.family() == Font::TYPEWRITER_FAMILY)
 653                                 os << '~';
 654
 655                         basefont = owner_->getLayoutFont(bparams, outerfont);
 656                         running_font = basefont;
 657
 658                         if (runparams.moving_arg)
 659                                 os << "\\protect ";
 660
 661                         os << "\\\\\n";
 662                 }
 663                 texrow.newline();
 664                 texrow.start(owner_->id(), i + 1);
 665                 column = 0;
 666         }
 667
 668         if (owner_->lookupChange(i).type == Change::DELETED) {
 669                 if( ++runparams.inDeletedInset == 1)
 670                         runparams.changeOfDeletedInset = owner_->lookupChange(i);
 671         }
 672
 673         if (inset->canTrackChanges()) {
 674                 column += Changes::latexMarkChange(os, bparams, running_change,
 675                         Change(Change::UNCHANGED));
 676                 running_change = Change(Change::UNCHANGED);
 677         }
 678
 679         bool close = false;
 680         odocstream::pos_type const len = os.tellp();
 681
 682         if ((inset->lyxCode() == GRAPHICS_CODE
 683              || inset->lyxCode() == MATH_CODE
 684              || inset->lyxCode() == HYPERLINK_CODE)
 685             && running_font.isRightToLeft()) {
 686                 if (running_font.language()->lang() == "farsi")
 687                         os << "\\beginL{}";
 688                 else
 689                         os << "\\L{";
 690                 close = true;
 691         }
 692
 693         // FIXME: Bug: we can have an empty font change here!
 694         // if there has just been a font change, we are going to close it
 695         // right now, which means stupid latex code like \textsf{}. AFAIK,
 696         // this does not harm dvi output. A minor bug, thus (JMarc)
 697
 698         // Some insets cannot be inside a font change command.
 699         // However, even such insets *can* be placed in \L or \R
 700         // or their equivalents (for RTL language switches), so we don't
 701         // close the language in those cases.
 702         // ArabTeX, though, cannot handle this special behavior, it seems.
 703         bool arabtex = basefont.language()->lang() == "arabic_arabtex"
 704                 || running_font.language()->lang() == "arabic_arabtex";
 705         if (open_font && inset->noFontChange()) {
 706                 bool closeLanguage = arabtex
 707                         || basefont.isRightToLeft() == running_font.isRightToLeft();
 708                 unsigned int count = running_font.latexWriteEndChanges(os,
 709                         bparams, runparams, basefont, basefont, closeLanguage);
 710                 column += count;
 711                 // if any font properties were closed, update the running_font,
 712                 // making sure, however, to leave the language as it was
 713                 if (count > 0) {
 714                         // FIXME: probably a better way to keep track of the old
 715                         // language, than copying the entire font?
 716                         Font const copy_font(running_font);
 717                         basefont = owner_->getLayoutFont(bparams, outerfont);
 718                         running_font = basefont;
 719                         if (!closeLanguage)
 720                                 running_font.setLanguage(copy_font.language());
 721                         // leave font open if language is still open
 722                         open_font = (running_font.language() == basefont.language());
 723                         if (closeLanguage)
 724                                 runparams.local_font = &basefont;
 725                 }
 726         }
 727
 728         int tmp = inset->latex(buf, os, runparams);
 729
 730         if (close) {
 731         if (running_font.language()->lang() == "farsi")
 732                         os << "\\endL{}";
 733                 else
 734                         os << '}';
 735         }
 736
 737         if (tmp) {
 738                 for (int j = 0; j < tmp; ++j)
 739                         texrow.newline();
 740
 741                 texrow.start(owner_->id(), i + 1);
 742                 column = 0;
 743         } else {
 744                 column += os.tellp() - len;
 745         }
 746
 747         if (owner_->lookupChange(i).type == Change::DELETED)
 748                 --runparams.inDeletedInset;
 749 }
 750
 751
 752 void Paragraph::Private::latexSpecialChar(
 753                                              odocstream & os,
 754                                              OutputParams & runparams,
 755                                              Font & running_font,
 756                                              Change & running_change,
 757                                              Layout const & style,
 758                                              pos_type & i,
 759                                              unsigned int & column)
 760 {
 761         value_type const c = getChar(i);
 762
 763         if (style.pass_thru) {
 764                 if (c != '\0')
 765                         // FIXME UNICODE: This can fail if c cannot
 766                         // be encoded in the current encoding.
 767                         os.put(c);
 768                 return;
 769         }
 770
 771         if (runparams.verbatim) {
 772                 os.put(c);
 773                 return;
 774         }
 775
 776         switch (c) {
 777         case '\\':
 778                 os << "\\textbackslash{}";
 779                 column += 15;
 780                 break;
 781
 782         case '|':
 783         case '<':
 784         case '>':
 785                 // In T1 encoding, these characters exist
 786                 if (lyxrc.fontenc == "T1") {
 787                         os.put(c);
 788                         //... but we should avoid ligatures
 789                         if ((c == '>' || c == '<')
 790                             && i <= size() - 2
 791                             && getChar(i + 1) == c) {
 792                                 //os << "\\textcompwordmark{}";
 793                                 //column += 19;
 794                                 // Jean-Marc, have a look at
 795                                 // this. I think this works
 796                                 // equally well:
 797                                 os << "\\,{}";
 798                                 // Lgb
 799                                 column += 3;
 800                         }
 801                         break;
 802                 }
 803                 // Typewriter font also has them
 804                 if (running_font.family() == Font::TYPEWRITER_FAMILY) {
 805                         os.put(c);
 806                         break;
 807                 }
 808                 // Otherwise, we use what LaTeX
 809                 // provides us.
 810                 switch (c) {
 811                 case '<':
 812                         os << "\\textless{}";
 813                         column += 10;
 814                         break;
 815                 case '>':
 816                         os << "\\textgreater{}";
 817                         column += 13;
 818                         break;
 819                 case '|':
 820                         os << "\\textbar{}";
 821                         column += 9;
 822                         break;
 823                 }
 824                 break;
 825
 826         case '-': // "--" in Typewriter mode -> "-{}-"
 827                 if (i <= size() - 2 &&
 828                     getChar(i + 1) == '-' &&
 829                     running_font.family() == Font::TYPEWRITER_FAMILY) {
 830                         os << "-{}";
 831                         column += 2;
 832                 } else {
 833                         os << '-';
 834                 }
 835                 break;
 836
 837         case '\"':
 838                 os << "\\char`\\\"{}";
 839                 column += 9;
 840                 break;
 841
 842         case '$': case '&':
 843         case '%': case '#': case '{':
 844         case '}': case '_':
 845                 os << '\\';
 846                 os.put(c);
 847                 column += 1;
 848                 break;
 849
 850         case '~':
 851                 os << "\\textasciitilde{}";
 852                 column += 16;
 853                 break;
 854
 855         case '^':
 856                 os << "\\textasciicircum{}";
 857                 column += 17;
 858                 break;
 859
 860         case '*': case '[':
 861                 // avoid being mistaken for optional arguments
 862                 os << '{';
 863                 os.put(c);
 864                 os << '}';
 865                 column += 2;
 866                 break;
 867
 868         case ' ':
 869                 // Blanks are printed before font switching.
 870                 // Sure? I am not! (try nice-latex)
 871                 // I am sure it's correct. LyX might be smarter
 872                 // in the future, but for now, nothing wrong is
 873                 // written. (Asger)
 874                 break;
 875
 876         default:
 877                 // I assume this is hack treating typewriter as verbatim
 878                 // FIXME UNICODE: This can fail if c cannot be encoded
 879                 // in the current encoding.
 880                 if (running_font.family() == Font::TYPEWRITER_FAMILY) {
 881                         if (c != '\0')
 882                                 os.put(c);
 883                         break;
 884                 }
 885
 886                 // LyX, LaTeX etc.
 887
 888                 // FIXME: if we have "LaTeX" with a font
 889                 // change in the middle (before the 'T', then
 890                 // the "TeX" part is still special cased.
 891                 // Really we should only operate this on
 892                 // "words" for some definition of word
 893
 894                 size_t pnr = 0;
 895
 896                 for (; pnr < phrases_nr; ++pnr) {
 897                         if (isTextAt(special_phrases[pnr].phrase, i)) {
 898                                 os << special_phrases[pnr].macro;
 899                                 i += special_phrases[pnr].phrase.length() - 1;
 900                                 column += special_phrases[pnr].macro.length() - 1;
 901                                 break;
 902                         }
 903                 }
 904
 905                 if (pnr == phrases_nr && c != '\0') {
 906                         Encoding const & encoding = *(runparams.encoding);
 907                         if (i + 1 < size()) {
 908                                 char_type next = getChar(i + 1);
 909                                 if (Encodings::isCombiningChar(next)) {
 910                                         column += latexSurrogatePair(os, c, next, encoding) - 1;
 911                                         ++i;
 912                                         break;
 913                                 }
 914                         }
 915                         string preamble;
 916                         if (Encodings::isKnownLangChar(c, preamble)) {
 917                                 column += knownLangChars(os, c, preamble, running_change,
 918                                         encoding, i) - 1;
 919                                 break;
 920                         }
 921                         docstring const latex = encoding.latexChar(c);
 922                         if (latex.length() > 1 && latex[latex.length() - 1] != '}') {
 923                                 // Prevent eating of a following
 924                                 // space or command corruption by
 925                                 // following characters
 926                                 column += latex.length() + 1;
 927                                 os << latex << "{}";
 928                         } else {
 929                                 column += latex.length() - 1;
 930                                 os << latex;
 931                         }
 932                 }
 933                 break;
 934         }
 935 }
 936
 937
 938 void Paragraph::Private::validate(LaTeXFeatures & features,
 939                                 Layout const & layout) const
 940 {
 941         // check the params.
 942         if (!params_.spacing().isDefault())
 943                 features.require("setspace");
 944
 945         // then the layouts
 946         features.useLayout(layout.name());
 947
 948         // then the fonts
 949         fontlist_.validate(features);
 950
 951         // then the indentation
 952         if (!params_.leftIndent().zero())
 953                 features.require("ParagraphLeftIndent");
 954
 955         // then the insets
 956         InsetList::const_iterator icit = insetlist_.begin();
 957         InsetList::const_iterator iend = insetlist_.end();
 958         for (; icit != iend; ++icit) {
 959                 if (icit->inset) {
 960                         icit->inset->validate(features);
 961                         if (layout.needprotect &&
 962                             icit->inset->lyxCode() == FOOT_CODE)
 963                                 features.require("NeedLyXFootnoteCode");
 964                 }
 965         }
 966
 967         // then the contents
 968         for (pos_type i = 0; i < size() ; ++i) {
 969                 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
 970                         if (!special_phrases[pnr].builtin
 971                             && isTextAt(special_phrases[pnr].phrase, i)) {
 972                                 features.require(special_phrases[pnr].phrase);
 973                                 break;
 974                         }
 975                 }
 976                 Encodings::validate(getChar(i), features);
 977         }
 978 }
 979
 980 /////////////////////////////////////////////////////////////////////
 981 //
 982 // Paragraph
 983 //
 984 /////////////////////////////////////////////////////////////////////
 985
 986 Paragraph::Paragraph()
 987         : begin_of_body_(0), d(new Paragraph::Private(this))
 988 {
 989         itemdepth = 0;
 990         d->params_.clear();
 991 }
 992
 993
 994 Paragraph::Paragraph(Paragraph const & par)
 995         : itemdepth(par.itemdepth),
 996         layout_(par.layout_),
 997         text_(par.text_), begin_of_body_(par.begin_of_body_),
 998         d(new Paragraph::Private(*par.d, this))
 999 {
1000 }
1001
1002
1003 Paragraph & Paragraph::operator=(Paragraph const & par)
1004 {
1005         // needed as we will destroy the private part before copying it
1006         if (&par != this) {
1007                 itemdepth = par.itemdepth;
1008                 layout_ = par.layout();
1009                 text_ = par.text_;
1010                 begin_of_body_ = par.begin_of_body_;
1011
1012                 delete d;
1013                 d = new Private(*par.d, this);
1014         }
1015         return *this;
1016 }
1017
1018
1019 Paragraph::~Paragraph()
1020 {
1021         delete d;
1022 }
1023
1024
1025 void Paragraph::write(Buffer const & buf, ostream & os,
1026                           BufferParams const & bparams,
1027                           depth_type & dth) const
1028 {
1029         // The beginning or end of a deeper (i.e. nested) area?
1030         if (dth != params().depth()) {
1031                 if (params().depth() > dth) {
1032                         while (params().depth() > dth) {
1033                                 os << "\n\\begin_deeper";
1034                                 ++dth;
1035                         }
1036                 } else {
1037                         while (params().depth() < dth) {
1038                                 os << "\n\\end_deeper";
1039                                 --dth;
1040                         }
1041                 }
1042         }
1043
1044         // First write the layout
1045         os << "\n\\begin_layout " << to_utf8(layout()->name()) << '\n';
1046
1047         params().write(os);
1048
1049         Font font1(Font::ALL_INHERIT, bparams.language);
1050
1051         Change running_change = Change(Change::UNCHANGED);
1052
1053         int column = 0;
1054         for (pos_type i = 0; i <= size(); ++i) {
1055
1056                 Change change = lookupChange(i);
1057                 Changes::lyxMarkChange(os, column, running_change, change);
1058                 running_change = change;
1059
1060                 if (i == size())
1061                         break;
1062
1063                 // Write font changes
1064                 Font font2 = getFontSettings(bparams, i);
1065                 if (font2 != font1) {
1066                         font2.lyxWriteChanges(font1, os);
1067                         column = 0;
1068                         font1 = font2;
1069                 }
1070
1071                 value_type const c = getChar(i);
1072                 switch (c) {
1073                 case META_INSET:
1074                 {
1075                         Inset const * inset = getInset(i);
1076                         if (inset)
1077                                 if (inset->directWrite()) {
1078                                         // international char, let it write
1079                                         // code directly so it's shorter in
1080                                         // the file
1081                                         inset->write(buf, os);
1082                                 } else {
1083                                         if (i)
1084                                                 os << '\n';
1085                                         os << "\\begin_inset ";
1086                                         inset->write(buf, os);
1087                                         os << "\n\\end_inset\n\n";
1088                                         column = 0;
1089                                 }
1090                 }
1091                 break;
1092                 case '\\':
1093                         os << "\n\\backslash\n";
1094                         column = 0;
1095                         break;
1096                 case '.':
1097                         if (i + 1 < size() && getChar(i + 1) == ' ') {
1098                                 os << ".\n";
1099                                 column = 0;
1100                         } else
1101                                 os << '.';
1102                         break;
1103                 default:
1104                         if ((column > 70 && c == ' ')
1105                             || column > 79) {
1106                                 os << '\n';
1107                                 column = 0;
1108                         }
1109                         // this check is to amend a bug. LyX sometimes
1110                         // inserts '\0' this could cause problems.
1111                         if (c != '\0') {
1112                                 std::vector<char> tmp = ucs4_to_utf8(c);
1113                                 tmp.push_back('\0');
1114                                 os << &tmp[0];
1115                         } else
1116                                 lyxerr << "ERROR (Paragraph::writeFile):"
1117                                         " NULL char in structure." << endl;
1118                         ++column;
1119                         break;
1120                 }
1121         }
1122
1123         os << "\n\\end_layout\n";
1124 }
1125
1126
1127 void Paragraph::validate(LaTeXFeatures & features) const
1128 {
1129         d->validate(features, *layout());
1130 }
1131
1132
1133 void Paragraph::insert(pos_type start, docstring const & str,
1134                        Font const & font, Change const & change)
1135 {
1136         for (size_t i = 0, n = str.size(); i != n ; ++i)
1137                 insertChar(start + i, str[i], font, change);
1138 }
1139
1140
1141 void Paragraph::appendChar(value_type c, Font const & font,
1142                 Change const & change)
1143 {
1144         // track change
1145         d->changes_.insert(change, text_.size());
1146         // when appending characters, no need to update tables
1147         text_.push_back(c);
1148         setFont(text_.size() - 1, font);
1149 }
1150
1151
1152 void Paragraph::appendString(docstring const & s, Font const & font,
1153                 Change const & change)
1154 {
1155         size_t end = s.size();
1156         // FIXME: Optimize this!
1157         text_.reserve(text_.size() + end);
1158         for (pos_type i = 0; i != end; ++i) {
1159                 // track change
1160                 d->changes_.insert(change, i);
1161                 // when appending characters, no need to update tables
1162                 text_.push_back(s[i]);
1163                 setFont(i, font);
1164         }
1165 }
1166
1167
1168 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1169                            bool trackChanges)
1170 {
1171         d->insertChar(pos, c, Change(trackChanges ?
1172                            Change::INSERTED : Change::UNCHANGED));
1173 }
1174
1175
1176 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1177                            Font const & font, bool trackChanges)
1178 {
1179         d->insertChar(pos, c, Change(trackChanges ?
1180                            Change::INSERTED : Change::UNCHANGED));
1181         setFont(pos, font);
1182 }
1183
1184
1185 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
1186                            Font const & font, Change const & change)
1187 {
1188         d->insertChar(pos, c, change);
1189         setFont(pos, font);
1190 }
1191
1192
1193 void Paragraph::insertInset(pos_type pos, Inset * inset,
1194                             Font const & font, Change const & change)
1195 {
1196         insertInset(pos, inset, change);
1197         // Set the font/language of the inset...
1198         setFont(pos, font);
1199 }
1200
1201
1202 bool Paragraph::insetAllowed(InsetCode code)
1203 {
1204         return !d->inset_owner_ || d->inset_owner_->insetAllowed(code);
1205 }
1206
1207
1208 // Gets uninstantiated font setting at position.
1209 Font const Paragraph::getFontSettings(BufferParams const & bparams,
1210                                          pos_type pos) const
1211 {
1212         if (pos > size()) {
1213                 lyxerr << " pos: " << pos << " size: " << size() << endl;
1214                 BOOST_ASSERT(pos <= size());
1215         }
1216
1217         FontList::const_iterator cit = d->fontlist_.fontIterator(pos);
1218         if (cit != d->fontlist_.end())
1219                 return cit->font();
1220
1221         if (pos == size() && !empty())
1222                 return getFontSettings(bparams, pos - 1);
1223
1224         return Font(Font::ALL_INHERIT, getParLanguage(bparams));
1225 }
1226
1227
1228 FontSpan Paragraph::fontSpan(pos_type pos) const
1229 {
1230         BOOST_ASSERT(pos <= size());
1231         pos_type start = 0;
1232
1233         FontList::const_iterator cit = d->fontlist_.begin();
1234         FontList::const_iterator end = d->fontlist_.end();
1235         for (; cit != end; ++cit) {
1236                 if (cit->pos() >= pos) {
1237                         if (pos >= beginOfBody())
1238                                 return FontSpan(std::max(start, beginOfBody()),
1239                                                 cit->pos());
1240                         else
1241                                 return FontSpan(start,
1242                                                 std::min(beginOfBody() - 1,
1243                                                          cit->pos()));
1244                 }
1245                 start = cit->pos() + 1;
1246         }
1247
1248         // This should not happen, but if so, we take no chances.
1249         //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
1250         //      << endl;
1251         return FontSpan(pos, pos);
1252 }
1253
1254
1255 // Gets uninstantiated font setting at position 0
1256 Font const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
1257 {
1258         if (!empty() && !d->fontlist_.empty())
1259                 return d->fontlist_.begin()->font();
1260
1261         return Font(Font::ALL_INHERIT, bparams.language);
1262 }
1263
1264
1265 // Gets the fully instantiated font at a given position in a paragraph
1266 // This is basically the same function as Text::GetFont() in text2.cpp.
1267 // The difference is that this one is used for generating the LaTeX file,
1268 // and thus cosmetic "improvements" are disallowed: This has to deliver
1269 // the true picture of the buffer. (Asger)
1270 Font const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
1271                                  Font const & outerfont) const
1272 {
1273         BOOST_ASSERT(pos >= 0);
1274
1275         Font font = getFontSettings(bparams, pos);
1276
1277         pos_type const body_pos = beginOfBody();
1278         if (pos < body_pos)
1279                 font.realize(layout_->labelfont);
1280         else
1281                 font.realize(layout_->font);
1282
1283         font.realize(outerfont);
1284         font.realize(bparams.getFont());
1285
1286         return font;
1287 }
1288
1289
1290 Font const Paragraph::getLabelFont
1291         (BufferParams const & bparams, Font const & outerfont) const
1292 {
1293         Font tmpfont = layout()->labelfont;
1294         tmpfont.setLanguage(getParLanguage(bparams));
1295         tmpfont.realize(outerfont);
1296         tmpfont.realize(bparams.getFont());
1297         return tmpfont;
1298 }
1299
1300
1301 Font const Paragraph::getLayoutFont
1302         (BufferParams const & bparams, Font const & outerfont) const
1303 {
1304         Font tmpfont = layout()->font;
1305         tmpfont.setLanguage(getParLanguage(bparams));
1306         tmpfont.realize(outerfont);
1307         tmpfont.realize(bparams.getFont());
1308         return tmpfont;
1309 }
1310
1311
1312 /// Returns the height of the highest font in range
1313 Font_size Paragraph::highestFontInRange
1314         (pos_type startpos, pos_type endpos, Font_size def_size) const
1315 {
1316         return d->fontlist_.highestInRange(startpos, endpos, def_size);
1317 }
1318
1319
1320 Paragraph::value_type
1321 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
1322 {
1323         value_type c = getChar(pos);
1324         if (!lyxrc.rtl_support)
1325                 return c;
1326
1327         value_type uc = c;
1328         switch (c) {
1329         case '(':
1330                 uc = ')';
1331                 break;
1332         case ')':
1333                 uc = '(';
1334                 break;
1335         case '[':
1336                 uc = ']';
1337                 break;
1338         case ']':
1339                 uc = '[';
1340                 break;
1341         case '{':
1342                 uc = '}';
1343                 break;
1344         case '}':
1345                 uc = '{';
1346                 break;
1347         case '<':
1348                 uc = '>';
1349                 break;
1350         case '>':
1351                 uc = '<';
1352                 break;
1353         }
1354         if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
1355                 return uc;
1356         else
1357                 return c;
1358 }
1359
1360
1361 void Paragraph::setFont(pos_type pos, Font const & font)
1362 {
1363         BOOST_ASSERT(pos <= size());
1364
1365         // First, reduce font against layout/label font
1366         // Update: The setCharFont() routine in text2.cpp already
1367         // reduces font, so we don't need to do that here. (Asger)
1368
1369         d->fontlist_.set(pos, font);
1370 }
1371
1372
1373 void Paragraph::makeSameLayout(Paragraph const & par)
1374 {
1375         layout(par.layout());
1376         // move to pimpl?
1377         d->params_ = par.params();
1378 }
1379
1380
1381 bool Paragraph::stripLeadingSpaces(bool trackChanges)
1382 {
1383         if (isFreeSpacing())
1384                 return false;
1385
1386         int pos = 0;
1387         int count = 0;
1388
1389         while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
1390                 if (eraseChar(pos, trackChanges))
1391                         ++count;
1392                 else
1393                         ++pos;
1394         }
1395
1396         return count > 0 || pos > 0;
1397 }
1398
1399
1400 bool Paragraph::hasSameLayout(Paragraph const & par) const
1401 {
1402         return par.layout() == layout() && d->params_.sameLayout(par.params());
1403 }
1404
1405
1406 depth_type Paragraph::getDepth() const
1407 {
1408         return params().depth();
1409 }
1410
1411
1412 depth_type Paragraph::getMaxDepthAfter() const
1413 {
1414         if (layout()->isEnvironment())
1415                 return params().depth() + 1;
1416         else
1417                 return params().depth();
1418 }
1419
1420
1421 char Paragraph::getAlign() const
1422 {
1423         if (params().align() == LYX_ALIGN_LAYOUT)
1424                 return layout()->align;
1425         else
1426                 return params().align();
1427 }
1428
1429
1430 docstring const & Paragraph::getLabelstring() const
1431 {
1432         return params().labelString();
1433 }
1434
1435
1436 // the next two functions are for the manual labels
1437 docstring const Paragraph::getLabelWidthString() const
1438 {
1439         if (layout()->margintype == MARGIN_MANUAL)
1440                 return params().labelWidthString();
1441         else
1442                 return _("Senseless with this layout!");
1443 }
1444
1445
1446 void Paragraph::setLabelWidthString(docstring const & s)
1447 {
1448         params().labelWidthString(s);
1449 }
1450
1451
1452 docstring const Paragraph::translateIfPossible(docstring const & s,
1453                 BufferParams const & bparams) const
1454 {
1455         if (!support::isAscii(s) || s.empty()) {
1456                 // This must be a user defined layout. We cannot translate
1457                 // this, since gettext accepts only ascii keys.
1458                 return s;
1459         }
1460         // Probably standard layout, try to translate
1461         Messages & m = getMessages(getParLanguage(bparams)->code());
1462         return m.get(to_ascii(s));
1463 }
1464
1465
1466 docstring Paragraph::expandLabel(LayoutPtr const & layout,
1467                 BufferParams const & bparams, bool process_appendix) const
1468 {
1469         TextClass const & tclass = bparams.getTextClass();
1470
1471         docstring fmt;
1472         if (process_appendix && params().appendix())
1473                 fmt = translateIfPossible(layout->labelstring_appendix(),
1474                         bparams);
1475         else
1476                 fmt = translateIfPossible(layout->labelstring(), bparams);
1477
1478         if (fmt.empty() && layout->labeltype == LABEL_COUNTER
1479             && !layout->counter.empty())
1480                 fmt = "\\the" + layout->counter;
1481
1482         // handle 'inherited level parts' in 'fmt',
1483         // i.e. the stuff between '@' in   '@Section@.\arabic{subsection}'
1484         size_t const i = fmt.find('@', 0);
1485         if (i != docstring::npos) {
1486                 size_t const j = fmt.find('@', i + 1);
1487                 if (j != docstring::npos) {
1488                         docstring parent(fmt, i + 1, j - i - 1);
1489                         docstring label = from_ascii("??");
1490                         if (tclass.hasLayout(parent))
1491                                 docstring label = expandLabel(tclass[parent], bparams,
1492                                                       process_appendix);
1493                         fmt = docstring(fmt, 0, i) + label
1494                                 + docstring(fmt, j + 1, docstring::npos);
1495                 }
1496         }
1497
1498         return tclass.counters().counterLabel(fmt);
1499 }
1500
1501
1502 void Paragraph::applyLayout(LayoutPtr const & new_layout)
1503 {
1504         layout(new_layout);
1505         LyXAlignment const oldAlign = params().align();
1506
1507         if (!(oldAlign & layout()->alignpossible)) {
1508                 frontend::Alert::warning(_("Alignment not permitted"),
1509                         _("The new layout does not permit the alignment previously used.\nSetting to default."));
1510                 params().align(LYX_ALIGN_LAYOUT);
1511         }
1512 }
1513
1514
1515 pos_type Paragraph::beginOfBody() const
1516 {
1517         return begin_of_body_;
1518 }
1519
1520
1521 void Paragraph::setBeginOfBody()
1522 {
1523         if (layout()->labeltype != LABEL_MANUAL) {
1524                 begin_of_body_ = 0;
1525                 return;
1526         }
1527
1528         // Unroll the first two cycles of the loop
1529         // and remember the previous character to
1530         // remove unnecessary getChar() calls
1531         pos_type i = 0;
1532         pos_type end = size();
1533         if (i < end && !isNewline(i)) {
1534                 ++i;
1535                 char_type previous_char = 0;
1536                 char_type temp = 0;
1537                 if (i < end) {
1538                         previous_char = text_[i];
1539                         if (!isNewline(i)) {
1540                                 ++i;
1541                                 while (i < end && previous_char != ' ') {
1542                                         temp = text_[i];
1543                                         if (isNewline(i))
1544                                                 break;
1545                                         ++i;
1546                                         previous_char = temp;
1547                                 }
1548                         }
1549                 }
1550         }
1551
1552         begin_of_body_ = i;
1553 }
1554
1555
1556 // returns -1 if inset not found
1557 int Paragraph::getPositionOfInset(Inset const * inset) const
1558 {
1559         // Find the entry.
1560         InsetList::const_iterator it = d->insetlist_.begin();
1561         InsetList::const_iterator end = d->insetlist_.end();
1562         for (; it != end; ++it)
1563                 if (it->inset == inset)
1564                         return it->pos;
1565         return -1;
1566 }
1567
1568
1569 InsetBibitem * Paragraph::bibitem() const
1570 {
1571         if (!d->insetlist_.empty()) {
1572                 Inset * inset = d->insetlist_.begin()->inset;
1573                 if (inset->lyxCode() == BIBITEM_CODE)
1574                         return static_cast<InsetBibitem *>(inset);
1575         }
1576         return 0;
1577 }
1578
1579
1580 bool Paragraph::forceDefaultParagraphs() const
1581 {
1582         return inInset() && inInset()->forceDefaultParagraphs(0);
1583 }
1584
1585
1586 namespace {
1587
1588 // paragraphs inside floats need different alignment tags to avoid
1589 // unwanted space
1590
1591 bool noTrivlistCentering(InsetCode code)
1592 {
1593         return code == FLOAT_CODE || code == WRAP_CODE;
1594 }
1595
1596
1597 string correction(string const & orig)
1598 {
1599         if (orig == "flushleft")
1600                 return "raggedright";
1601         if (orig == "flushright")
1602                 return "raggedleft";
1603         if (orig == "center")
1604                 return "centering";
1605         return orig;
1606 }
1607
1608
1609 string const corrected_env(string const & suffix, string const & env,
1610         InsetCode code)
1611 {
1612         string output = suffix + "{";
1613         if (noTrivlistCentering(code))
1614                 output += correction(env);
1615         else
1616                 output += env;
1617         output += "}";
1618         if (suffix == "\\begin")
1619                 output += "\n";
1620         return output;
1621 }
1622
1623
1624 void adjust_row_column(string const & str, TexRow & texrow, int & column)
1625 {
1626         if (!contains(str, "\n"))
1627                 column += str.size();
1628         else {
1629                 string tmp;
1630                 texrow.newline();
1631                 column = rsplit(str, tmp, '\n').size();
1632         }
1633 }
1634
1635 } // namespace anon
1636
1637
1638 // This could go to ParagraphParameters if we want to
1639 int Paragraph::startTeXParParams(BufferParams const & bparams,
1640                                  odocstream & os, TexRow & texrow,
1641                                  bool moving_arg) const
1642 {
1643         int column = 0;
1644
1645         if (params().noindent()) {
1646                 os << "\\noindent ";
1647                 column += 10;
1648         }
1649
1650         LyXAlignment const curAlign = params().align();
1651
1652         if (curAlign == layout()->align)
1653                 return column;
1654
1655         switch (curAlign) {
1656         case LYX_ALIGN_NONE:
1657         case LYX_ALIGN_BLOCK:
1658         case LYX_ALIGN_LAYOUT:
1659         case LYX_ALIGN_SPECIAL:
1660                 break;
1661         case LYX_ALIGN_LEFT:
1662         case LYX_ALIGN_RIGHT:
1663         case LYX_ALIGN_CENTER:
1664                 if (moving_arg) {
1665                         os << "\\protect";
1666                         column += 8;
1667                 }
1668                 break;
1669         }
1670
1671         switch (curAlign) {
1672         case LYX_ALIGN_NONE:
1673         case LYX_ALIGN_BLOCK:
1674         case LYX_ALIGN_LAYOUT:
1675         case LYX_ALIGN_SPECIAL:
1676                 break;
1677         case LYX_ALIGN_LEFT: {
1678                 string output;
1679                 if (getParLanguage(bparams)->babel() != "hebrew")
1680                         output = corrected_env("\\begin", "flushleft", ownerCode());
1681                 else
1682                         output = corrected_env("\\begin", "flushright", ownerCode());
1683                 os << from_ascii(output);
1684                 adjust_row_column(output, texrow, column);
1685                 break;
1686         } case LYX_ALIGN_RIGHT: {
1687                 string output;
1688                 if (getParLanguage(bparams)->babel() != "hebrew")
1689                         output = corrected_env("\\begin", "flushright", ownerCode());
1690                 else
1691                         output = corrected_env("\\begin", "flushleft", ownerCode());
1692                 os << from_ascii(output);
1693                 adjust_row_column(output, texrow, column);
1694                 break;
1695         } case LYX_ALIGN_CENTER: {
1696                 string output;
1697                 output = corrected_env("\\begin", "center", ownerCode());
1698                 os << from_ascii(output);
1699                 adjust_row_column(output, texrow, column);
1700                 break;
1701         }
1702         }
1703
1704         return column;
1705 }
1706
1707
1708 // This could go to ParagraphParameters if we want to
1709 int Paragraph::endTeXParParams(BufferParams const & bparams,
1710                                odocstream & os, TexRow & texrow,
1711                                bool moving_arg) const
1712 {
1713         int column = 0;
1714
1715         switch (params().align()) {
1716         case LYX_ALIGN_NONE:
1717         case LYX_ALIGN_BLOCK:
1718         case LYX_ALIGN_LAYOUT:
1719         case LYX_ALIGN_SPECIAL:
1720                 break;
1721         case LYX_ALIGN_LEFT:
1722         case LYX_ALIGN_RIGHT:
1723         case LYX_ALIGN_CENTER:
1724                 if (moving_arg) {
1725                         os << "\\protect";
1726                         column = 8;
1727                 }
1728                 break;
1729         }
1730
1731         switch (params().align()) {
1732         case LYX_ALIGN_NONE:
1733         case LYX_ALIGN_BLOCK:
1734         case LYX_ALIGN_LAYOUT:
1735         case LYX_ALIGN_SPECIAL:
1736                 break;
1737         case LYX_ALIGN_LEFT: {
1738                 string output;
1739                 if (getParLanguage(bparams)->babel() != "hebrew")
1740                         output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
1741                 else
1742                         output = corrected_env("\n\\par\\end", "flushright", ownerCode());
1743                 os << from_ascii(output);
1744                 adjust_row_column(output, texrow, column);
1745                 break;
1746         } case LYX_ALIGN_RIGHT: {
1747                 string output;
1748                 if (getParLanguage(bparams)->babel() != "hebrew")
1749                         output = corrected_env("\n\\par\\end", "flushright", ownerCode());
1750                 else
1751                         output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
1752                 os << from_ascii(output);
1753                 adjust_row_column(output, texrow, column);
1754                 break;
1755         } case LYX_ALIGN_CENTER: {
1756                 string output;
1757                 output = corrected_env("\n\\par\\end", "center", ownerCode());
1758                 os << from_ascii(output);
1759                 adjust_row_column(output, texrow, column);
1760                 break;
1761         }
1762         }
1763
1764         return column;
1765 }
1766
1767
1768 // This one spits out the text of the paragraph
1769 bool Paragraph::latex(Buffer const & buf,
1770                                 BufferParams const & bparams,
1771                                 Font const & outerfont,
1772                                 odocstream & os, TexRow & texrow,
1773                                 OutputParams const & runparams) const
1774 {
1775         LYXERR(Debug::LATEX) << "SimpleTeXOnePar...     " << this << endl;
1776
1777         bool return_value = false;
1778
1779         LayoutPtr style;
1780
1781         // well we have to check if we are in an inset with unlimited
1782         // length (all in one row) if that is true then we don't allow
1783         // any special options in the paragraph and also we don't allow
1784         // any environment other than the default layout of the text class
1785         // to be valid!
1786         bool asdefault = forceDefaultParagraphs();
1787
1788         if (asdefault) {
1789                 style = bparams.getTextClass().defaultLayout();
1790         } else {
1791                 style = layout();
1792         }
1793
1794         // Current base font for all inherited font changes, without any
1795         // change caused by an individual character, except for the language:
1796         // It is set to the language of the first character.
1797         // As long as we are in the label, this font is the base font of the
1798         // label. Before the first body character it is set to the base font
1799         // of the body.
1800         Font basefont;
1801
1802         // Maybe we have to create a optional argument.
1803         pos_type body_pos = beginOfBody();
1804         unsigned int column = 0;
1805
1806         if (body_pos > 0) {
1807                 // the optional argument is kept in curly brackets in
1808                 // case it contains a ']'
1809                 os << "[{";
1810                 column += 2;
1811                 basefont = getLabelFont(bparams, outerfont);
1812         } else {
1813                 basefont = getLayoutFont(bparams, outerfont);
1814         }
1815
1816         // Which font is currently active?
1817         Font running_font(basefont);
1818         // Do we have an open font change?
1819         bool open_font = false;
1820
1821         Change runningChange = Change(Change::UNCHANGED);
1822
1823         texrow.start(id(), 0);
1824
1825         // if the paragraph is empty, the loop will not be entered at all
1826         if (empty()) {
1827                 if (style->isCommand()) {
1828                         os << '{';
1829                         ++column;
1830                 }
1831                 if (!asdefault)
1832                         column += startTeXParParams(bparams, os, texrow,
1833                                                     runparams.moving_arg);
1834         }
1835
1836         for (pos_type i = 0; i < size(); ++i) {
1837                 // First char in paragraph or after label?
1838                 if (i == body_pos) {
1839                         if (body_pos > 0) {
1840                                 if (open_font) {
1841                                         column += running_font.latexWriteEndChanges(
1842                                                 os, bparams, runparams,
1843                                                 basefont, basefont);
1844                                         open_font = false;
1845                                 }
1846                                 basefont = getLayoutFont(bparams, outerfont);
1847                                 running_font = basefont;
1848
1849                                 column += Changes::latexMarkChange(os, bparams,
1850                                                 runningChange, Change(Change::UNCHANGED));
1851                                 runningChange = Change(Change::UNCHANGED);
1852
1853                                 os << "}] ";
1854                                 column +=3;
1855                         }
1856                         if (style->isCommand()) {
1857                                 os << '{';
1858                                 ++column;
1859                         }
1860
1861                         if (!asdefault)
1862                                 column += startTeXParParams(bparams, os,
1863                                                             texrow,
1864                                                             runparams.moving_arg);
1865                 }
1866
1867                 Change const & change = runparams.inDeletedInset ? runparams.changeOfDeletedInset
1868                                                                  : lookupChange(i);
1869
1870                 if (bparams.outputChanges && runningChange != change) {
1871                         if (open_font) {
1872                                 column += running_font.latexWriteEndChanges(
1873                                                 os, bparams, runparams, basefont, basefont);
1874                                 open_font = false;
1875                         }
1876                         basefont = getLayoutFont(bparams, outerfont);
1877                         running_font = basefont;
1878
1879                         column += Changes::latexMarkChange(os, bparams, runningChange, change);
1880                         runningChange = change;
1881                 }
1882
1883                 // do not output text which is marked deleted
1884                 // if change tracking output is disabled
1885                 if (!bparams.outputChanges && change.type == Change::DELETED) {
1886                         continue;
1887                 }
1888
1889                 ++column;
1890
1891                 // Fully instantiated font
1892                 Font const font = getFont(bparams, i, outerfont);
1893
1894                 Font const last_font = running_font;
1895
1896                 // Do we need to close the previous font?
1897                 if (open_font &&
1898                     (font != running_font ||
1899                      font.language() != running_font.language()))
1900                 {
1901                         column += running_font.latexWriteEndChanges(
1902                                         os, bparams, runparams, basefont,
1903                                         (i == body_pos-1) ? basefont : font);
1904                         running_font = basefont;
1905                         open_font = false;
1906                 }
1907
1908                 // Switch file encoding if necessary
1909                 if (runparams.encoding->package() == Encoding::inputenc &&
1910                     font.language()->encoding()->package() == Encoding::inputenc) {
1911                         std::pair<bool, int> const enc_switch = switchEncoding(os, bparams,
1912                                         runparams.moving_arg, *(runparams.encoding),
1913                                         *(font.language()->encoding()));
1914                         if (enc_switch.first) {
1915                                 column += enc_switch.second;
1916                                 runparams.encoding = font.language()->encoding();
1917                         }
1918                 }
1919
1920                 value_type const c = getChar(i);
1921
1922                 // Do we need to change font?
1923                 if ((font != running_font ||
1924                      font.language() != running_font.language()) &&
1925                         i != body_pos - 1)
1926                 {
1927                         odocstringstream ods;
1928                         column += font.latexWriteStartChanges(ods, bparams,
1929                                                               runparams, basefont,
1930                                                               last_font);
1931                         running_font = font;
1932                         open_font = true;
1933                         docstring fontchange = ods.str();
1934                         // check if the fontchange ends with a trailing blank
1935                         // (like "\small " (see bug 3382)
1936                         if (suffixIs(fontchange, ' ') && c == ' ')
1937                                 os << fontchange.substr(0, fontchange.size() - 1)
1938                                    << from_ascii("{}");
1939                         else
1940                                 os << fontchange;
1941                 }
1942
1943                 if (c == ' ') {
1944                         // FIXME: integrate this case in latexSpecialChar
1945                         // Do not print the separation of the optional argument
1946                         // if style->pass_thru is false. This works because
1947                         // latexSpecialChar ignores spaces if
1948                         // style->pass_thru is false.
1949                         if (i != body_pos - 1) {
1950                                 if (d->simpleTeXBlanks(
1951                                                 *(runparams.encoding), os, texrow,
1952                                                 i, column, font, *style)) {
1953                                         // A surrogate pair was output. We
1954                                         // must not call latexSpecialChar
1955                                         // in this iteration, since it would output
1956                                         // the combining character again.
1957                                         ++i;
1958                                         continue;
1959                                 }
1960                         }
1961                 }
1962
1963                 OutputParams rp = runparams;
1964                 rp.free_spacing = style->free_spacing;
1965                 rp.local_font = &font;
1966                 rp.intitle = style->intitle;
1967
1968                 // Two major modes:  LaTeX or plain
1969                 // Handle here those cases common to both modes
1970                 // and then split to handle the two modes separately.
1971                 if (c == Paragraph::META_INSET)
1972                         d->latexInset(buf, bparams, os,
1973                                         texrow, rp, running_font,
1974                                         basefont, outerfont, open_font,
1975                                         runningChange, *style, i, column);
1976                 else
1977                         d->latexSpecialChar(os, rp, running_font, runningChange,
1978                                 *style, i, column);
1979
1980                 // Set the encoding to that returned from simpleTeXSpecialChars (see
1981                 // comment for encoding member in OutputParams.h)
1982                 runparams.encoding = rp.encoding;
1983         }
1984
1985         // If we have an open font definition, we have to close it
1986         if (open_font) {
1987 #ifdef FIXED_LANGUAGE_END_DETECTION
1988                 if (next_) {
1989                         running_font
1990                                 .latexWriteEndChanges(os, bparams, runparams,
1991                                         basefont,
1992                                         next_->getFont(bparams, 0, outerfont));
1993                 } else {
1994                         running_font.latexWriteEndChanges(os, bparams,
1995                                         runparams, basefont, basefont);
1996                 }
1997 #else
1998 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
1999 //FIXME: there as we start another \selectlanguage with the next paragraph if
2000 //FIXME: we are in need of this. This should be fixed sometime (Jug)
2001                 running_font.latexWriteEndChanges(os, bparams, runparams,
2002                                 basefont, basefont);
2003 #endif
2004         }
2005
2006         column += Changes::latexMarkChange(os, bparams, runningChange, Change(Change::UNCHANGED));
2007
2008         // Needed if there is an optional argument but no contents.
2009         if (body_pos > 0 && body_pos == size()) {
2010                 os << "}]~";
2011                 return_value = false;
2012         }
2013
2014         if (!asdefault) {
2015                 column += endTeXParParams(bparams, os, texrow,
2016                                           runparams.moving_arg);
2017         }
2018
2019         LYXERR(Debug::LATEX) << "SimpleTeXOnePar...done " << this << endl;
2020         return return_value;
2021 }
2022
2023
2024 namespace {
2025
2026 enum PAR_TAG {
2027         PAR_NONE=0,
2028         TT = 1,
2029         SF = 2,
2030         BF = 4,
2031         IT = 8,
2032         SL = 16,
2033         EM = 32
2034 };
2035
2036
2037 string tag_name(PAR_TAG const & pt) {
2038         switch (pt) {
2039         case PAR_NONE: return "!-- --";
2040         case TT: return "tt";
2041         case SF: return "sf";
2042         case BF: return "bf";
2043         case IT: return "it";
2044         case SL: return "sl";
2045         case EM: return "em";
2046         }
2047         return "";
2048 }
2049
2050
2051 inline
2052 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2053 {
2054         p1 = static_cast<PAR_TAG>(p1 | p2);
2055 }
2056
2057
2058 inline
2059 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2060 {
2061         p1 = static_cast<PAR_TAG>(p1 & ~p2);
2062 }
2063
2064 } // anon
2065
2066
2067 bool Paragraph::emptyTag() const
2068 {
2069         for (pos_type i = 0; i < size(); ++i) {
2070                 if (isInset(i)) {
2071                         Inset const * inset = getInset(i);
2072                         InsetCode lyx_code = inset->lyxCode();
2073                         if (lyx_code != TOC_CODE &&
2074                             lyx_code != INCLUDE_CODE &&
2075                             lyx_code != GRAPHICS_CODE &&
2076                             lyx_code != ERT_CODE &&
2077                             lyx_code != LISTINGS_CODE &&
2078                             lyx_code != FLOAT_CODE &&
2079                             lyx_code != TABULAR_CODE) {
2080                                 return false;
2081                         }
2082                 } else {
2083                         value_type c = getChar(i);
2084                         if (c != ' ' && c != '\t')
2085                                 return false;
2086                 }
2087         }
2088         return true;
2089 }
2090
2091
2092 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
2093 {
2094         for (pos_type i = 0; i < size(); ++i) {
2095                 if (isInset(i)) {
2096                         Inset const * inset = getInset(i);
2097                         InsetCode lyx_code = inset->lyxCode();
2098                         if (lyx_code == LABEL_CODE) {
2099                                 string const id = static_cast<InsetCommand const *>(inset)->getContents();
2100                                 return "id='" + to_utf8(sgml::cleanID(buf, runparams, from_utf8(id))) + "'";
2101                         }
2102                 }
2103
2104         }
2105         return string();
2106 }
2107
2108
2109 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
2110 {
2111         pos_type i;
2112         for (i = 0; i < size(); ++i) {
2113                 if (isInset(i)) {
2114                         Inset const * inset = getInset(i);
2115                         inset->docbook(buf, os, runparams);
2116                 } else {
2117                         value_type c = getChar(i);
2118                         if (c == ' ')
2119                                 break;
2120                         os << sgml::escapeChar(c);
2121                 }
2122         }
2123         return i;
2124 }
2125
2126
2127 bool Paragraph::onlyText(Buffer const & buf, Font const & outerfont, pos_type initial) const
2128 {
2129         Font font_old;
2130
2131         for (pos_type i = initial; i < size(); ++i) {
2132                 Font font = getFont(buf.params(), i, outerfont);
2133                 if (isInset(i))
2134                         return false;
2135                 if (i != initial && font != font_old)
2136                         return false;
2137                 font_old = font;
2138         }
2139
2140         return true;
2141 }
2142
2143
2144 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
2145                                     odocstream & os,
2146                                     OutputParams const & runparams,
2147                                     Font const & outerfont,
2148                                     pos_type initial) const
2149 {
2150         bool emph_flag = false;
2151
2152         LayoutPtr const & style = layout();
2153         Font font_old =
2154                 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
2155
2156         if (style->pass_thru && !onlyText(buf, outerfont, initial))
2157                 os << "]]>";
2158
2159         // parsing main loop
2160         for (pos_type i = initial; i < size(); ++i) {
2161                 Font font = getFont(buf.params(), i, outerfont);
2162
2163                 // handle <emphasis> tag
2164                 if (font_old.emph() != font.emph()) {
2165                         if (font.emph() == Font::ON) {
2166                                 os << "<emphasis>";
2167                                 emph_flag = true;
2168                         } else if (i != initial) {
2169                                 os << "</emphasis>";
2170                                 emph_flag = false;
2171                         }
2172                 }
2173
2174                 if (isInset(i)) {
2175                         Inset const * inset = getInset(i);
2176                         inset->docbook(buf, os, runparams);
2177                 } else {
2178                         value_type c = getChar(i);
2179
2180                         if (style->pass_thru)
2181                                 os.put(c);
2182                         else
2183                                 os << sgml::escapeChar(c);
2184                 }
2185                 font_old = font;
2186         }
2187
2188         if (emph_flag) {
2189                 os << "</emphasis>";
2190         }
2191
2192         if (style->free_spacing)
2193                 os << '\n';
2194         if (style->pass_thru && !onlyText(buf, outerfont, initial))
2195                 os << "<![CDATA[";
2196 }
2197
2198
2199 bool Paragraph::isHfill(pos_type pos) const
2200 {
2201         return isInset(pos)
2202                 && getInset(pos)->lyxCode() == HFILL_CODE;
2203 }
2204
2205
2206 bool Paragraph::isNewline(pos_type pos) const
2207 {
2208         return isInset(pos)
2209                 && getInset(pos)->lyxCode() == NEWLINE_CODE;
2210 }
2211
2212
2213 bool Paragraph::isLineSeparator(pos_type pos) const
2214 {
2215         value_type const c = getChar(pos);
2216         return isLineSeparatorChar(c)
2217                 || (c == Paragraph::META_INSET && getInset(pos) &&
2218                 getInset(pos)->isLineSeparator());
2219 }
2220
2221
2222 /// Used by the spellchecker
2223 bool Paragraph::isLetter(pos_type pos) const
2224 {
2225         if (isInset(pos))
2226                 return getInset(pos)->isLetter();
2227         else {
2228                 value_type const c = getChar(pos);
2229                 return isLetterChar(c) || isDigit(c);
2230         }
2231 }
2232
2233
2234 Language const *
2235 Paragraph::getParLanguage(BufferParams const & bparams) const
2236 {
2237         if (!empty())
2238                 return getFirstFontSettings(bparams).language();
2239         // FIXME: we should check the prev par as well (Lgb)
2240         return bparams.language;
2241 }
2242
2243
2244 bool Paragraph::isRTL(BufferParams const & bparams) const
2245 {
2246         return lyxrc.rtl_support
2247                 && getParLanguage(bparams)->rightToLeft()
2248                 && ownerCode() != ERT_CODE
2249                 && ownerCode() != LISTINGS_CODE;
2250 }
2251
2252
2253 void Paragraph::changeLanguage(BufferParams const & bparams,
2254                                Language const * from, Language const * to)
2255 {
2256         // change language including dummy font change at the end
2257         for (pos_type i = 0; i <= size(); ++i) {
2258                 Font font = getFontSettings(bparams, i);
2259                 if (font.language() == from) {
2260                         font.setLanguage(to);
2261                         setFont(i, font);
2262                 }
2263         }
2264 }
2265
2266
2267 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
2268 {
2269         Language const * doc_language = bparams.language;
2270         FontList::const_iterator cit = d->fontlist_.begin();
2271         FontList::const_iterator end = d->fontlist_.end();
2272
2273         for (; cit != end; ++cit)
2274                 if (cit->font().language() != ignore_language &&
2275                     cit->font().language() != latex_language &&
2276                     cit->font().language() != doc_language)
2277                         return true;
2278         return false;
2279 }
2280
2281
2282 // Convert the paragraph to a string.
2283 // Used for building the table of contents
2284 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
2285 {
2286         return asString(buffer, 0, size(), label);
2287 }
2288
2289
2290 docstring const Paragraph::asString(Buffer const & buffer,
2291                                  pos_type beg, pos_type end, bool label) const
2292 {
2293
2294         odocstringstream os;
2295
2296         if (beg == 0 && label && !params().labelString().empty())
2297                 os << params().labelString() << ' ';
2298
2299         for (pos_type i = beg; i < end; ++i) {
2300                 value_type const c = getChar(i);
2301                 if (isPrintable(c))
2302                         os.put(c);
2303                 else if (c == META_INSET)
2304                         getInset(i)->textString(buffer, os);
2305         }
2306
2307         return os.str();
2308 }
2309
2310
2311 void Paragraph::setInsetOwner(Inset * inset)
2312 {
2313         d->inset_owner_ = inset;
2314 }
2315
2316
2317 int Paragraph::id() const
2318 {
2319         return d->id_;
2320 }
2321
2322
2323 LayoutPtr const & Paragraph::layout() const
2324 {
2325         return layout_;
2326 }
2327
2328
2329 void Paragraph::layout(LayoutPtr const & new_layout)
2330 {
2331         layout_ = new_layout;
2332 }
2333
2334
2335 Inset * Paragraph::inInset() const
2336 {
2337         return d->inset_owner_;
2338 }
2339
2340
2341 InsetCode Paragraph::ownerCode() const
2342 {
2343         return d->inset_owner_ ?
2344                 d->inset_owner_->lyxCode() : NO_CODE;
2345 }
2346
2347
2348 ParagraphParameters & Paragraph::params()
2349 {
2350         return d->params_;
2351 }
2352
2353
2354 ParagraphParameters const & Paragraph::params() const
2355 {
2356         return d->params_;
2357 }
2358
2359
2360 bool Paragraph::isFreeSpacing() const
2361 {
2362         if (layout()->free_spacing)
2363                 return true;
2364
2365         // for now we just need this, later should we need this in some
2366         // other way we can always add a function to Inset too.
2367         return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2368 }
2369
2370
2371 bool Paragraph::allowEmpty() const
2372 {
2373         if (layout()->keepempty)
2374                 return true;
2375         return ownerCode() == ERT_CODE || ownerCode() == LISTINGS_CODE;
2376 }
2377
2378
2379 char_type Paragraph::transformChar(char_type c, pos_type pos) const
2380 {
2381         if (!Encodings::is_arabic(c))
2382                 return c;
2383
2384         value_type prev_char = ' ';
2385         value_type next_char = ' ';
2386
2387         for (pos_type i = pos - 1; i >= 0; --i) {
2388                 value_type const par_char = getChar(i);
2389                 if (!Encodings::isComposeChar_arabic(par_char)) {
2390                         prev_char = par_char;
2391                         break;
2392                 }
2393         }
2394
2395         for (pos_type i = pos + 1, end = size(); i < end; ++i) {
2396                 value_type const par_char = getChar(i);
2397                 if (!Encodings::isComposeChar_arabic(par_char)) {
2398                         next_char = par_char;
2399                         break;
2400                 }
2401         }
2402
2403         if (Encodings::is_arabic(next_char)) {
2404                 if (Encodings::is_arabic(prev_char) &&
2405                         !Encodings::is_arabic_special(prev_char))
2406                         return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
2407                 else
2408                         return Encodings::transformChar(c, Encodings::FORM_INITIAL);
2409         } else {
2410                 if (Encodings::is_arabic(prev_char) &&
2411                         !Encodings::is_arabic_special(prev_char))
2412                         return Encodings::transformChar(c, Encodings::FORM_FINAL);
2413                 else
2414                         return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
2415         }
2416 }
2417
2418
2419 int Paragraph::checkBiblio(bool track_changes)
2420 {
2421         //FIXME From JS:
2422         //This is getting more and more a mess. ...We really should clean
2423         //up this bibitem issue for 1.6. See also bug 2743.
2424
2425         // Add bibitem insets if necessary
2426         if (layout()->labeltype != LABEL_BIBLIO)
2427                 return 0;
2428
2429         bool hasbibitem = !d->insetlist_.empty()
2430                 // Insist on it being in pos 0
2431                 && getChar(0) == Paragraph::META_INSET
2432                 && d->insetlist_.begin()->inset->lyxCode() == BIBITEM_CODE;
2433
2434         docstring oldkey;
2435         docstring oldlabel;
2436
2437         // remove a bibitem in pos != 0
2438         // restore it later in pos 0 if necessary
2439         // (e.g. if a user inserts contents _before_ the item)
2440         // we're assuming there's only one of these, which there
2441         // should be.
2442         int erasedInsetPosition = -1;
2443         InsetList::iterator it = d->insetlist_.begin();
2444         InsetList::iterator end = d->insetlist_.end();
2445         for (; it != end; ++it)
2446                 if (it->inset->lyxCode() == BIBITEM_CODE
2447                     && it->pos > 0) {
2448                         InsetBibitem * olditem = static_cast<InsetBibitem *>(it->inset);
2449                         oldkey = olditem->getParam("key");
2450                         oldlabel = olditem->getParam("label");
2451                         erasedInsetPosition = it->pos;
2452                         eraseChar(erasedInsetPosition, track_changes);
2453                         break;
2454         }
2455
2456         //There was an InsetBibitem at the beginning, and we didn't
2457         //have to erase one.
2458         if (hasbibitem && erasedInsetPosition < 0)
2459                         return 0;
2460
2461         //There was an InsetBibitem at the beginning and we did have to
2462         //erase one. So we give its properties to the beginning inset.
2463         if (hasbibitem) {
2464                 InsetBibitem * inset =
2465                         static_cast<InsetBibitem *>(d->insetlist_.begin()->inset);
2466                 if (!oldkey.empty())
2467                         inset->setParam("key", oldkey);
2468                 inset->setParam("label", oldlabel);
2469                 return -erasedInsetPosition;
2470         }
2471
2472         //There was no inset at the beginning, so we need to create one with
2473         //the key and label of the one we erased.
2474         InsetBibitem * inset(new InsetBibitem(InsetCommandParams(BIBITEM_CODE)));
2475         // restore values of previously deleted item in this par.
2476         if (!oldkey.empty())
2477                 inset->setParam("key", oldkey);
2478         inset->setParam("label", oldlabel);
2479         insertInset(0, static_cast<Inset *>(inset),
2480                     Change(track_changes ? Change::INSERTED : Change::UNCHANGED));
2481
2482         return 1;
2483 }
2484
2485
2486 void Paragraph::checkAuthors(AuthorList const & authorList)
2487 {
2488         d->changes_.checkAuthors(authorList);
2489 }
2490
2491
2492 bool Paragraph::isUnchanged(pos_type pos) const
2493 {
2494         return lookupChange(pos).type == Change::UNCHANGED;
2495 }
2496
2497
2498 bool Paragraph::isInserted(pos_type pos) const
2499 {
2500         return lookupChange(pos).type == Change::INSERTED;
2501 }
2502
2503
2504 bool Paragraph::isDeleted(pos_type pos) const
2505 {
2506         return lookupChange(pos).type == Change::DELETED;
2507 }
2508
2509
2510 InsetList const & Paragraph::insetList() const
2511 {
2512         return d->insetlist_;
2513 }
2514
2515
2516 Inset * Paragraph::releaseInset(pos_type pos)
2517 {
2518         Inset * inset = d->insetlist_.release(pos);
2519         /// does not honour change tracking!
2520         eraseChar(pos, false);
2521         return inset;
2522 }
2523
2524
2525 Inset * Paragraph::getInset(pos_type pos)
2526 {
2527         return d->insetlist_.get(pos);
2528 }
2529
2530
2531 Inset const * Paragraph::getInset(pos_type pos) const
2532 {
2533         return d->insetlist_.get(pos);
2534 }
2535
2536
2537 int Paragraph::numberOfOptArgs() const
2538 {
2539         int num = 0;
2540         InsetList::const_iterator it = insetList().begin();
2541         InsetList::const_iterator end = insetList().end();
2542         for (; it != end ; ++it) {
2543                 if (it->inset->lyxCode() == OPTARG_CODE)
2544                         ++num;
2545         }
2546         return num;
2547 }
2548
2549
2550 } // namespace lyx