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