src/paragraph.C

   1 /**
   2  * \file paragraph.C
   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 #include "paragraph_pimpl.h"
  22
  23 #include "buffer.h"
  24 #include "bufferparams.h"
  25 #include "counters.h"
  26 #include "encoding.h"
  27 #include "debug.h"
  28 #include "gettext.h"
  29 #include "language.h"
  30 #include "lyxfont.h"
  31 #include "lyxrc.h"
  32 #include "lyxrow.h"
  33 #include "outputparams.h"
  34 #include "paragraph_funcs.h"
  35 #include "sgml.h"
  36 #include "texrow.h"
  37 #include "vspace.h"
  38
  39 #include "insets/insetbibitem.h"
  40 #include "insets/insetoptarg.h"
  41
  42 #include "support/lstrings.h"
  43 #include "support/std_sstream.h"
  44 #include "support/textutils.h"
  45 #include "support/tostr.h"
  46
  47 #include <boost/tuple/tuple.hpp>
  48 #include <boost/bind.hpp>
  49
  50 #include <list>
  51 #include <stack>
  52
  53 using lyx::pos_type;
  54
  55 using lyx::support::contains;
  56 using lyx::support::subst;
  57
  58 using std::endl;
  59 using std::list;
  60 using std::stack;
  61 using std::string;
  62 using std::ostream;
  63 using std::ostringstream;
  64
  65
  66 Paragraph::Paragraph()
  67         : y(0), height(0), begin_of_body_(0),
  68           pimpl_(new Paragraph::Pimpl(this))
  69 {
  70         itemdepth = 0;
  71         params().clear();
  72 }
  73
  74
  75 Paragraph::Paragraph(Paragraph const & par)
  76         : y(0), height(0), text_(par.text_), begin_of_body_(par.begin_of_body_),
  77           pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
  78 {
  79         itemdepth = 0;
  80         // this is because of the dummy layout of the paragraphs that
  81         // follow footnotes
  82         layout_ = par.layout();
  83
  84         // copy everything behind the break-position to the new paragraph
  85         insetlist = par.insetlist;
  86         InsetList::iterator it = insetlist.begin();
  87         InsetList::iterator end = insetlist.end();
  88         for (; it != end; ++it) {
  89                 // currently we hold Inset*, not InsetBase*
  90                 it->inset = static_cast<InsetOld*>(it->inset->clone().release());
  91         }
  92 }
  93
  94
  95 void Paragraph::operator=(Paragraph const & par)
  96 {
  97         // needed as we will destroy the pimpl_ before copying it
  98         if (&par != this)
  99                 return;
 100
 101         lyxerr << "Paragraph::operator=()" << endl;
 102
 103         text_ = par.text_;
 104
 105         delete pimpl_;
 106         pimpl_ = new Pimpl(*par.pimpl_, this);
 107
 108         itemdepth = par.itemdepth;
 109         // this is because of the dummy layout of the paragraphs that
 110         // follow footnotes
 111         layout_ = par.layout();
 112
 113         // copy everything behind the break-position to the new paragraph
 114         insetlist = par.insetlist;
 115         InsetList::iterator it = insetlist.begin();
 116         InsetList::iterator end = insetlist.end();
 117         for (; it != end; ++it) {
 118                 it->inset = static_cast<InsetOld*>(it->inset->clone().release());
 119         }
 120 }
 121
 122
 123 Paragraph::~Paragraph()
 124 {
 125         delete pimpl_;
 126         //
 127         //lyxerr << "Paragraph::paragraph_id = "
 128         //       << Paragraph::paragraph_id << endl;
 129 }
 130
 131
 132 void Paragraph::write(Buffer const & buf, ostream & os,
 133                           BufferParams const & bparams,
 134                           depth_type & dth) const
 135 {
 136         // The beginning or end of a deeper (i.e. nested) area?
 137         if (dth != params().depth()) {
 138                 if (params().depth() > dth) {
 139                         while (params().depth() > dth) {
 140                                 os << "\n\\begin_deeper ";
 141                                 ++dth;
 142                         }
 143                 } else {
 144                         while (params().depth() < dth) {
 145                                 os << "\n\\end_deeper ";
 146                                 --dth;
 147                         }
 148                 }
 149         }
 150
 151         // First write the layout
 152         os << "\n\\begin_layout " << layout()->name() << '\n';
 153
 154         params().write(os);
 155
 156         LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
 157
 158         Change running_change = Change(Change::UNCHANGED);
 159         lyx::time_type const curtime(lyx::current_time());
 160
 161         int column = 0;
 162         for (pos_type i = 0; i < size(); ++i) {
 163                 if (!i) {
 164                         os << '\n';
 165                         column = 0;
 166                 }
 167
 168                 Change change = pimpl_->lookupChangeFull(i);
 169                 Changes::lyxMarkChange(os, column, curtime, running_change, change);
 170                 running_change = change;
 171
 172                 // Write font changes
 173                 LyXFont font2 = getFontSettings(bparams, i);
 174                 if (font2 != font1) {
 175                         font2.lyxWriteChanges(font1, os);
 176                         column = 0;
 177                         font1 = font2;
 178                 }
 179
 180                 value_type const c = getChar(i);
 181                 switch (c) {
 182                 case META_INSET:
 183                 {
 184                         InsetOld const * inset = getInset(i);
 185                         if (inset)
 186                                 if (inset->directWrite()) {
 187                                         // international char, let it write
 188                                         // code directly so it's shorter in
 189                                         // the file
 190                                         inset->write(buf, os);
 191                                 } else {
 192                                         os << "\n\\begin_inset ";
 193                                         inset->write(buf, os);
 194                                         os << "\n\\end_inset \n\n";
 195                                         column = 0;
 196                                 }
 197                 }
 198                 break;
 199                 case '\\':
 200                         os << "\n\\backslash \n";
 201                         column = 0;
 202                         break;
 203                 case '.':
 204                         if (i + 1 < size() && getChar(i + 1) == ' ') {
 205                                 os << ".\n";
 206                                 column = 0;
 207                         } else
 208                                 os << '.';
 209                         break;
 210                 default:
 211                         if ((column > 70 && c == ' ')
 212                             || column > 79) {
 213                                 os << '\n';
 214                                 column = 0;
 215                         }
 216                         // this check is to amend a bug. LyX sometimes
 217                         // inserts '\0' this could cause problems.
 218                         if (c != '\0')
 219                                 os << c;
 220                         else
 221                                 lyxerr << "ERROR (Paragraph::writeFile):"
 222                                         " NULL char in structure." << endl;
 223                         ++column;
 224                         break;
 225                 }
 226         }
 227
 228         // to make reading work properly
 229         if (!size()) {
 230                 running_change = pimpl_->lookupChange(0);
 231                 Changes::lyxMarkChange(os, column, curtime,
 232                         Change(Change::UNCHANGED), running_change);
 233         }
 234         Changes::lyxMarkChange(os, column, curtime,
 235                 running_change, Change(Change::UNCHANGED));
 236
 237         os << "\n\\end_layout\n";
 238 }
 239
 240
 241 void Paragraph::validate(LaTeXFeatures & features) const
 242 {
 243         pimpl_->validate(features, *layout());
 244 }
 245
 246
 247 void Paragraph::eraseIntern(lyx::pos_type pos)
 248 {
 249         pimpl_->eraseIntern(pos);
 250 }
 251
 252
 253 bool Paragraph::erase(pos_type pos)
 254 {
 255         return pimpl_->erase(pos);
 256 }
 257
 258
 259 int Paragraph::erase(pos_type start, pos_type end)
 260 {
 261         return pimpl_->erase(start, end);
 262 }
 263
 264
 265 void Paragraph::insert(pos_type start, string const & str,
 266                        LyXFont const & font)
 267 {
 268         int size = str.size();
 269         for (int i = 0 ; i < size ; ++i)
 270                 insertChar(start + i, str[i], font);
 271 }
 272
 273
 274 bool Paragraph::checkInsertChar(LyXFont & font)
 275 {
 276         if (pimpl_->inset_owner)
 277                 return pimpl_->inset_owner->checkInsertChar(font);
 278         return true;
 279 }
 280
 281
 282 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c)
 283 {
 284         insertChar(pos, c, LyXFont(LyXFont::ALL_INHERIT));
 285 }
 286
 287
 288 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
 289                            LyXFont const & font, Change change)
 290 {
 291         pimpl_->insertChar(pos, c, font, change);
 292 }
 293
 294
 295 void Paragraph::insertInset(pos_type pos, InsetOld * inset)
 296 {
 297         insertInset(pos, inset, LyXFont(LyXFont::ALL_INHERIT));
 298 }
 299
 300
 301 void Paragraph::insertInset(pos_type pos, InsetOld * inset,
 302         LyXFont const & font, Change change)
 303 {
 304         pimpl_->insertInset(pos, inset, font, change);
 305 }
 306
 307
 308 bool Paragraph::insetAllowed(InsetOld_code code)
 309 {
 310         //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
 311         if (pimpl_->inset_owner)
 312                 return pimpl_->inset_owner->insetAllowed(code);
 313         return true;
 314 }
 315
 316
 317 InsetOld * Paragraph::getInset(pos_type pos)
 318 {
 319         BOOST_ASSERT(pos < size());
 320         return insetlist.get(pos);
 321 }
 322
 323
 324 InsetOld const * Paragraph::getInset(pos_type pos) const
 325 {
 326         BOOST_ASSERT(pos < size());
 327         return insetlist.get(pos);
 328 }
 329
 330
 331 // Gets uninstantiated font setting at position.
 332 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
 333                                          pos_type pos) const
 334 {
 335         BOOST_ASSERT(pos <= size());
 336
 337         Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
 338         Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
 339         for (; cit != end; ++cit)
 340                 if (cit->pos() >= pos)
 341                         break;
 342
 343         if (cit != end)
 344                 return cit->font();
 345
 346         if (pos == size() && !empty())
 347                 return getFontSettings(bparams, pos - 1);
 348
 349         return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
 350 }
 351
 352
 353 lyx::pos_type Paragraph::getEndPosOfFontSpan(lyx::pos_type pos) const
 354 {
 355         BOOST_ASSERT(pos <= size());
 356
 357         Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
 358         Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
 359         for (; cit != end; ++cit)
 360                 if (cit->pos() >= pos)
 361                         return cit->pos();
 362
 363         // This should not happen, but if so, we take no chances.
 364         //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
 365         //      << endl;
 366         return pos;
 367 }
 368
 369
 370 // Gets uninstantiated font setting at position 0
 371 LyXFont const Paragraph::getFirstFontSettings() const
 372 {
 373         if (!empty() && !pimpl_->fontlist.empty())
 374                 return pimpl_->fontlist[0].font();
 375
 376         return LyXFont(LyXFont::ALL_INHERIT);
 377 }
 378
 379
 380 // Gets the fully instantiated font at a given position in a paragraph
 381 // This is basically the same function as LyXText::GetFont() in text2.C.
 382 // The difference is that this one is used for generating the LaTeX file,
 383 // and thus cosmetic "improvements" are disallowed: This has to deliver
 384 // the true picture of the buffer. (Asger)
 385 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
 386                                  LyXFont const & outerfont) const
 387 {
 388         BOOST_ASSERT(pos >= 0);
 389
 390         LyXLayout_ptr const & lout = layout();
 391
 392         pos_type const body_pos = beginOfBody();
 393
 394         LyXFont layoutfont;
 395         if (pos < body_pos)
 396                 layoutfont = lout->labelfont;
 397         else
 398                 layoutfont = lout->font;
 399
 400         LyXFont font = getFontSettings(bparams, pos);
 401         font.realize(layoutfont);
 402         font.realize(outerfont);
 403         font.realize(bparams.getLyXTextClass().defaultfont());
 404
 405         return font;
 406 }
 407
 408
 409 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams,
 410                                       LyXFont const & outerfont) const
 411 {
 412         LyXFont tmpfont = layout()->labelfont;
 413         tmpfont.setLanguage(getParLanguage(bparams));
 414         tmpfont.realize(outerfont);
 415         tmpfont.realize(bparams.getLyXTextClass().defaultfont());
 416         return tmpfont;
 417 }
 418
 419
 420 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams,
 421                                        LyXFont const & outerfont) const
 422 {
 423         LyXFont tmpfont = layout()->font;
 424         tmpfont.setLanguage(getParLanguage(bparams));
 425         tmpfont.realize(outerfont);
 426         tmpfont.realize(bparams.getLyXTextClass().defaultfont());
 427         return tmpfont;
 428 }
 429
 430
 431 /// Returns the height of the highest font in range
 432 LyXFont_size
 433 Paragraph::highestFontInRange(pos_type startpos, pos_type endpos,
 434                               LyXFont_size def_size) const
 435 {
 436         if (pimpl_->fontlist.empty())
 437                 return def_size;
 438
 439         Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
 440         Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
 441         for (; end_it != end; ++end_it) {
 442                 if (end_it->pos() >= endpos)
 443                         break;
 444         }
 445
 446         if (end_it != end)
 447                 ++end_it;
 448
 449         Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
 450         for (; cit != end; ++cit) {
 451                 if (cit->pos() >= startpos)
 452                         break;
 453         }
 454
 455         LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
 456         for (; cit != end_it; ++cit) {
 457                 LyXFont::FONT_SIZE size = cit->font().size();
 458                 if (size == LyXFont::INHERIT_SIZE)
 459                         size = def_size;
 460                 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
 461                         maxsize = size;
 462         }
 463         return maxsize;
 464 }
 465
 466
 467 Paragraph::value_type
 468 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
 469 {
 470         value_type c = getChar(pos);
 471         if (!lyxrc.rtl_support)
 472                 return c;
 473
 474         value_type uc = c;
 475         switch (c) {
 476         case '(':
 477                 uc = ')';
 478                 break;
 479         case ')':
 480                 uc = '(';
 481                 break;
 482         case '[':
 483                 uc = ']';
 484                 break;
 485         case ']':
 486                 uc = '[';
 487                 break;
 488         case '{':
 489                 uc = '}';
 490                 break;
 491         case '}':
 492                 uc = '{';
 493                 break;
 494         case '<':
 495                 uc = '>';
 496                 break;
 497         case '>':
 498                 uc = '<';
 499                 break;
 500         }
 501         if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
 502                 return uc;
 503         else
 504                 return c;
 505 }
 506
 507
 508 void Paragraph::setFont(pos_type pos, LyXFont const & font)
 509 {
 510         BOOST_ASSERT(pos <= size());
 511
 512         // First, reduce font against layout/label font
 513         // Update: The setCharFont() routine in text2.C already
 514         // reduces font, so we don't need to do that here. (Asger)
 515         // No need to simplify this because it will disappear
 516         // in a new kernel. (Asger)
 517         // Next search font table
 518
 519         Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
 520         Pimpl::FontList::iterator it = beg;
 521         Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
 522         for (; it != endit; ++it) {
 523                 if (it->pos() >= pos)
 524                         break;
 525         }
 526         unsigned int i = std::distance(beg, it);
 527         bool notfound = (it == endit);
 528
 529         if (!notfound && pimpl_->fontlist[i].font() == font)
 530                 return;
 531
 532         bool begin = pos == 0 || notfound ||
 533                 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
 534         // Is position pos is a beginning of a font block?
 535         bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
 536         // Is position pos is the end of a font block?
 537         if (begin && end) { // A single char block
 538                 if (i + 1 < pimpl_->fontlist.size() &&
 539                     pimpl_->fontlist[i + 1].font() == font) {
 540                         // Merge the singleton block with the next block
 541                         pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
 542                         if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
 543                                 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
 544                 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
 545                         // Merge the singleton block with the previous block
 546                         pimpl_->fontlist[i - 1].pos(pos);
 547                         pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
 548                 } else
 549                         pimpl_->fontlist[i].font(font);
 550         } else if (begin) {
 551                 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
 552                         pimpl_->fontlist[i - 1].pos(pos);
 553                 else
 554                         pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
 555                                         Pimpl::FontTable(pos, font));
 556         } else if (end) {
 557                 pimpl_->fontlist[i].pos(pos - 1);
 558                 if (!(i + 1 < pimpl_->fontlist.size() &&
 559                       pimpl_->fontlist[i + 1].font() == font))
 560                         pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
 561                                         Pimpl::FontTable(pos, font));
 562         } else { // The general case. The block is splitted into 3 blocks
 563                 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
 564                                 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
 565                 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
 566                                 Pimpl::FontTable(pos, font));
 567         }
 568 }
 569
 570
 571 void Paragraph::makeSameLayout(Paragraph const & par)
 572 {
 573         layout(par.layout());
 574         // move to pimpl?
 575         params() = par.params();
 576 }
 577
 578
 579 int Paragraph::stripLeadingSpaces()
 580 {
 581         if (isFreeSpacing())
 582                 return 0;
 583
 584         int i = 0;
 585         while (!empty() && (isNewline(0) || isLineSeparator(0))) {
 586                 pimpl_->eraseIntern(0);
 587                 ++i;
 588         }
 589
 590         return i;
 591 }
 592
 593
 594 bool Paragraph::hasSameLayout(Paragraph const & par) const
 595 {
 596         return
 597                 par.layout() == layout() &&
 598                 params().sameLayout(par.params());
 599 }
 600
 601
 602 Paragraph::depth_type Paragraph::getDepth() const
 603 {
 604         return params().depth();
 605 }
 606
 607
 608 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
 609 {
 610         if (layout()->isEnvironment())
 611                 return params().depth() + 1;
 612         else
 613                 return params().depth();
 614 }
 615
 616
 617 char Paragraph::getAlign() const
 618 {
 619         return params().align();
 620 }
 621
 622
 623 string const & Paragraph::getLabelstring() const
 624 {
 625         return params().labelString();
 626 }
 627
 628
 629 // the next two functions are for the manual labels
 630 string const Paragraph::getLabelWidthString() const
 631 {
 632         if (!params().labelWidthString().empty())
 633                 return params().labelWidthString();
 634         else
 635                 return _("Senseless with this layout!");
 636 }
 637
 638
 639 void Paragraph::setLabelWidthString(string const & s)
 640 {
 641         params().labelWidthString(s);
 642 }
 643
 644
 645 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
 646 {
 647         layout(new_layout);
 648         params().labelWidthString(string());
 649         params().align(LYX_ALIGN_LAYOUT);
 650         params().spacing(Spacing(Spacing::Default));
 651 }
 652
 653
 654 int Paragraph::beginOfBody() const
 655 {
 656         return begin_of_body_;
 657 }
 658
 659
 660 void Paragraph::setBeginOfBody()
 661 {
 662         if (layout()->labeltype != LABEL_MANUAL) {
 663                 begin_of_body_ = 0;
 664                 return;
 665         }
 666
 667         // Unroll the first two cycles of the loop
 668         // and remember the previous character to
 669         // remove unnecessary getChar() calls
 670         pos_type i = 0;
 671         pos_type end = size();
 672         if (i < end && !isNewline(i)) {
 673                 ++i;
 674                 char previous_char = 0;
 675                 char temp = 0;
 676                 if (i < end) {
 677                         previous_char = text_[i];
 678                         if (!isNewline(i)) {
 679                                 ++i;
 680                                 while (i < end && previous_char != ' ') {
 681                                         temp = text_[i];
 682                                         if (isNewline(i))
 683                                                 break;
 684                                         ++i;
 685                                         previous_char = temp;
 686                                 }
 687                         }
 688                 }
 689         }
 690
 691         begin_of_body_ = i;
 692 }
 693
 694
 695 // returns -1 if inset not found
 696 int Paragraph::getPositionOfInset(InsetOld const * inset) const
 697 {
 698         // Find the entry.
 699         InsetList::const_iterator it = insetlist.begin();
 700         InsetList::const_iterator end = insetlist.end();
 701         for (; it != end; ++it)
 702                 if (it->inset == inset)
 703                         return it->pos;
 704         return -1;
 705 }
 706
 707
 708 InsetBibitem * Paragraph::bibitem() const
 709 {
 710         if (!insetlist.empty()) {
 711                 InsetOld * inset = insetlist.begin()->inset;
 712                 if (inset->lyxCode() == InsetOld::BIBTEX_CODE)
 713                         return static_cast<InsetBibitem *>(inset);
 714         }
 715         return 0;
 716 }
 717
 718
 719 namespace {
 720
 721 /* paragraphs inside floats need different alignment tags to avoid
 722 unwanted space */
 723
 724 bool noTrivlistCentering(UpdatableInset const * inset)
 725 {
 726         if (inset && inset->owner()) {
 727                 InsetOld::Code const code = inset->owner()->lyxCode();
 728                 return code == InsetOld::FLOAT_CODE ||
 729                         code == InsetOld::WRAP_CODE;
 730         }
 731         return false;
 732 }
 733
 734
 735 string correction(string const & orig)
 736 {
 737         if (orig == "flushleft")
 738                 return "raggedright";
 739         if (orig == "flushright")
 740                 return "raggedleft";
 741         if (orig == "center")
 742                 return "centering";
 743         return orig;
 744 }
 745
 746
 747 string const corrected_env(string const & suffix, string const & env,
 748                            UpdatableInset const * inset)
 749 {
 750         string output = suffix + "{";
 751         if (noTrivlistCentering(inset))
 752                 output += correction(env);
 753         else
 754                 output += env;
 755         return output + "}";
 756 }
 757
 758 } // namespace anon
 759
 760
 761 // This could go to ParagraphParameters if we want to
 762 int Paragraph::startTeXParParams(BufferParams const & bparams,
 763                                  ostream & os, bool moving_arg) const
 764 {
 765         int column = 0;
 766
 767         if (params().noindent()) {
 768                 os << "\\noindent ";
 769                 column += 10;
 770         }
 771
 772         switch (params().align()) {
 773         case LYX_ALIGN_NONE:
 774         case LYX_ALIGN_BLOCK:
 775         case LYX_ALIGN_LAYOUT:
 776         case LYX_ALIGN_SPECIAL:
 777                 break;
 778         case LYX_ALIGN_LEFT:
 779         case LYX_ALIGN_RIGHT:
 780         case LYX_ALIGN_CENTER:
 781                 if (moving_arg) {
 782                         os << "\\protect";
 783                         column = 8;
 784                 }
 785                 break;
 786         }
 787
 788         switch (params().align()) {
 789         case LYX_ALIGN_NONE:
 790         case LYX_ALIGN_BLOCK:
 791         case LYX_ALIGN_LAYOUT:
 792         case LYX_ALIGN_SPECIAL:
 793                 break;
 794         case LYX_ALIGN_LEFT: {
 795                 string output;
 796                 UpdatableInset const * const inset = pimpl_->inset_owner;
 797                 if (getParLanguage(bparams)->babel() != "hebrew")
 798                         output = corrected_env("\\begin", "flushleft", inset);
 799                 else
 800                         output = corrected_env("\\begin", "flushright", inset);
 801                 os << output;
 802                 column += output.size();
 803                 break;
 804         } case LYX_ALIGN_RIGHT: {
 805                 string output;
 806                 UpdatableInset const * const inset = pimpl_->inset_owner;
 807                 if (getParLanguage(bparams)->babel() != "hebrew")
 808                         output = corrected_env("\\begin", "flushright", inset);
 809                 else
 810                         output = corrected_env("\\begin", "flushleft", inset);
 811                 os << output;
 812                 column += output.size();
 813                 break;
 814         } case LYX_ALIGN_CENTER: {
 815                 string output;
 816                 output = corrected_env("\\begin", "center", pimpl_->inset_owner);
 817                 os << output;
 818                 column += output.size();
 819                 break;
 820         }
 821         }
 822
 823         return column;
 824 }
 825
 826
 827 // This could go to ParagraphParameters if we want to
 828 int Paragraph::endTeXParParams(BufferParams const & bparams,
 829                                ostream & os, bool moving_arg) const
 830 {
 831         int column = 0;
 832
 833         switch (params().align()) {
 834         case LYX_ALIGN_NONE:
 835         case LYX_ALIGN_BLOCK:
 836         case LYX_ALIGN_LAYOUT:
 837         case LYX_ALIGN_SPECIAL:
 838                 break;
 839         case LYX_ALIGN_LEFT:
 840         case LYX_ALIGN_RIGHT:
 841         case LYX_ALIGN_CENTER:
 842                 if (moving_arg) {
 843                         os << "\\protect";
 844                         column = 8;
 845                 }
 846                 break;
 847         }
 848
 849         switch (params().align()) {
 850         case LYX_ALIGN_NONE:
 851         case LYX_ALIGN_BLOCK:
 852         case LYX_ALIGN_LAYOUT:
 853         case LYX_ALIGN_SPECIAL:
 854                 break;
 855         case LYX_ALIGN_LEFT: {
 856                 string output;
 857                 UpdatableInset const * const inset = pimpl_->inset_owner;
 858                 if (getParLanguage(bparams)->babel() != "hebrew")
 859                         output = corrected_env("\\par\\end", "flushleft", inset);
 860                 else
 861                         output = corrected_env("\\par\\end", "flushright", inset);
 862                 os << output;
 863                 column += output.size();
 864                 break;
 865         } case LYX_ALIGN_RIGHT: {
 866                 string output;
 867                 UpdatableInset const * const inset = pimpl_->inset_owner;
 868                 if (getParLanguage(bparams)->babel() != "hebrew")
 869                         output = corrected_env("\\par\\end", "flushright", inset);
 870                 else
 871                         output = corrected_env("\\par\\end", "flushleft", inset);
 872                 os << output;
 873                 column += output.size();
 874                 break;
 875         } case LYX_ALIGN_CENTER: {
 876                 string output;
 877                 output = corrected_env("\\par\\end", "center", pimpl_->inset_owner);
 878                 os << output;
 879                 column += output.size();
 880                 break;
 881         }
 882         }
 883
 884         return column;
 885 }
 886
 887
 888 // This one spits out the text of the paragraph
 889 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
 890                                 BufferParams const & bparams,
 891                                 LyXFont const & outerfont,
 892                                 ostream & os, TexRow & texrow,
 893                                 OutputParams const & runparams)
 894 {
 895         lyxerr[Debug::LATEX] << "SimpleTeXOnePar...     " << this << endl;
 896
 897         bool return_value = false;
 898
 899         LyXLayout_ptr style;
 900
 901         // well we have to check if we are in an inset with unlimited
 902         // length (all in one row) if that is true then we don't allow
 903         // any special options in the paragraph and also we don't allow
 904         // any environment other then "Standard" to be valid!
 905         bool asdefault =
 906                 (inInset() && inInset()->forceDefaultParagraphs(inInset()));
 907
 908         if (asdefault) {
 909                 style = bparams.getLyXTextClass().defaultLayout();
 910         } else {
 911                 style = layout();
 912         }
 913
 914         LyXFont basefont;
 915
 916         // Maybe we have to create a optional argument.
 917         pos_type body_pos = beginOfBody();
 918         unsigned int column = 0;
 919
 920         if (body_pos > 0) {
 921                 os << '[';
 922                 ++column;
 923                 basefont = getLabelFont(bparams, outerfont);
 924         } else {
 925                 basefont = getLayoutFont(bparams, outerfont);
 926         }
 927
 928         bool moving_arg = runparams.moving_arg;
 929         moving_arg |= style->needprotect;
 930
 931         // Which font is currently active?
 932         LyXFont running_font(basefont);
 933         // Do we have an open font change?
 934         bool open_font = false;
 935
 936         Change::Type running_change = Change::UNCHANGED;
 937
 938         texrow.start(id(), 0);
 939
 940         // if the paragraph is empty, the loop will not be entered at all
 941         if (empty()) {
 942                 if (style->isCommand()) {
 943                         os << '{';
 944                         ++column;
 945                 }
 946                 if (!asdefault)
 947                         column += startTeXParParams(bparams, os, moving_arg);
 948         }
 949
 950         for (pos_type i = 0; i < size(); ++i) {
 951                 ++column;
 952                 // First char in paragraph or after label?
 953                 if (i == body_pos) {
 954                         if (body_pos > 0) {
 955                                 if (open_font) {
 956                                         column += running_font.latexWriteEndChanges(os, basefont, basefont);
 957                                         open_font = false;
 958                                 }
 959                                 basefont = getLayoutFont(bparams, outerfont);
 960                                 running_font = basefont;
 961                                 os << ']';
 962                                 ++column;
 963                         }
 964                         if (style->isCommand()) {
 965                                 os << '{';
 966                                 ++column;
 967                         }
 968
 969                         if (!asdefault)
 970                                 column += startTeXParParams(bparams, os,
 971                                                             moving_arg);
 972                 }
 973
 974                 value_type c = getChar(i);
 975
 976                 // Fully instantiated font
 977                 LyXFont font = getFont(bparams, i, outerfont);
 978
 979                 LyXFont const last_font = running_font;
 980
 981                 // Spaces at end of font change are simulated to be
 982                 // outside font change, i.e. we write "\textXX{text} "
 983                 // rather than "\textXX{text }". (Asger)
 984                 if (open_font && c == ' ' && i <= size() - 2) {
 985                         LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
 986                         if (next_font != running_font && next_font != font) {
 987                                 font = next_font;
 988                         }
 989                 }
 990
 991                 // We end font definition before blanks
 992                 if (open_font &&
 993                     (font != running_font ||
 994                      font.language() != running_font.language()))
 995                 {
 996                         column += running_font.latexWriteEndChanges(os,
 997                                                                     basefont,
 998                                                                     (i == body_pos-1) ? basefont : font);
 999                         running_font = basefont;
1000                         open_font = false;
1001                 }
1002
1003                 // Blanks are printed before start of fontswitch
1004                 if (c == ' ') {
1005                         // Do not print the separation of the optional argument
1006                         if (i != body_pos - 1) {
1007                                 pimpl_->simpleTeXBlanks(os, texrow, i,
1008                                                        column, font, *style);
1009                         }
1010                 }
1011
1012                 // Do we need to change font?
1013                 if ((font != running_font ||
1014                      font.language() != running_font.language()) &&
1015                         i != body_pos - 1)
1016                 {
1017                         column += font.latexWriteStartChanges(os, basefont,
1018                                                               last_font);
1019                         running_font = font;
1020                         open_font = true;
1021                 }
1022
1023                 Change::Type change = pimpl_->lookupChange(i);
1024
1025                 column += Changes::latexMarkChange(os, running_change, change);
1026                 running_change = change;
1027
1028                 OutputParams rp = runparams;
1029                 rp.moving_arg = moving_arg;
1030                 rp.free_spacing = style->free_spacing;
1031                 pimpl_->simpleTeXSpecialChars(buf, bparams,
1032                                               os, texrow, runparams,
1033                                               font, running_font,
1034                                               basefont, outerfont, open_font,
1035                                               running_change,
1036                                               *style, i, column, c);
1037         }
1038
1039         column += Changes::latexMarkChange(os,
1040                         running_change, Change::UNCHANGED);
1041
1042         // If we have an open font definition, we have to close it
1043         if (open_font) {
1044 #ifdef FIXED_LANGUAGE_END_DETECTION
1045                 if (next_) {
1046                         running_font
1047                                 .latexWriteEndChanges(os, basefont,
1048                                                       next_->getFont(bparams,
1049                                                       0, outerfont));
1050                 } else {
1051                         running_font.latexWriteEndChanges(os, basefont,
1052                                                           basefont);
1053                 }
1054 #else
1055 #ifdef WITH_WARNINGS
1056 //#warning For now we ALWAYS have to close the foreign font settings if they are
1057 //#warning there as we start another \selectlanguage with the next paragraph if
1058 //#warning we are in need of this. This should be fixed sometime (Jug)
1059 #endif
1060                 running_font.latexWriteEndChanges(os, basefont,  basefont);
1061 #endif
1062         }
1063
1064         // Needed if there is an optional argument but no contents.
1065         if (body_pos > 0 && body_pos == size()) {
1066                 os << "]~";
1067                 return_value = false;
1068         }
1069
1070         if (!asdefault) {
1071                 column += endTeXParParams(bparams, os, moving_arg);
1072         }
1073
1074         lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1075         return return_value;
1076 }
1077
1078
1079 namespace {
1080
1081 // checks, if newcol chars should be put into this line
1082 // writes newline, if necessary.
1083 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1084                           string::size_type newcol)
1085 {
1086         colcount += newcol;
1087         if (colcount > lyxrc.ascii_linelen) {
1088                 os << "\n";
1089                 colcount = newcol; // assume write after this call
1090         }
1091 }
1092
1093 enum PAR_TAG {
1094         NONE=0,
1095         TT = 1,
1096         SF = 2,
1097         BF = 4,
1098         IT = 8,
1099         SL = 16,
1100         EM = 32
1101 };
1102
1103
1104 string tag_name(PAR_TAG const & pt) {
1105         switch (pt) {
1106         case NONE: return "!-- --";
1107         case TT: return "tt";
1108         case SF: return "sf";
1109         case BF: return "bf";
1110         case IT: return "it";
1111         case SL: return "sl";
1112         case EM: return "em";
1113         }
1114         return "";
1115 }
1116
1117
1118 inline
1119 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1120 {
1121         p1 = static_cast<PAR_TAG>(p1 | p2);
1122 }
1123
1124
1125 inline
1126 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1127 {
1128         p1 = static_cast<PAR_TAG>(p1 & ~p2);
1129 }
1130
1131 } // anon
1132
1133
1134 // Handle internal paragraph parsing -- layout already processed.
1135 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1136                                      ostream & os,
1137                                      LyXFont const & outerfont,
1138                                      OutputParams const & runparams,
1139                                      lyx::depth_type /*depth*/) const
1140 {
1141         LyXLayout_ptr const & style = layout();
1142
1143         string::size_type char_line_count = 5;     // Heuristic choice ;-)
1144
1145         // gets paragraph main font
1146         LyXFont font_old;
1147         bool desc_on;
1148         if (style->labeltype == LABEL_MANUAL) {
1149                 font_old = style->labelfont;
1150                 desc_on = true;
1151         } else {
1152                 font_old = style->font;
1153                 desc_on = false;
1154         }
1155
1156         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1157         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1158         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
1159         bool is_em = false;
1160
1161         stack<PAR_TAG> tag_state;
1162         // parsing main loop
1163         for (pos_type i = 0; i < size(); ++i) {
1164
1165                 PAR_TAG tag_close = NONE;
1166                 list < PAR_TAG > tag_open;
1167
1168                 LyXFont const font = getFont(buf.params(), i, outerfont);
1169
1170                 if (font_old.family() != font.family()) {
1171                         switch (family_type) {
1172                         case LyXFont::SANS_FAMILY:
1173                                 tag_close |= SF;
1174                                 break;
1175                         case LyXFont::TYPEWRITER_FAMILY:
1176                                 tag_close |= TT;
1177                                 break;
1178                         default:
1179                                 break;
1180                         }
1181
1182                         family_type = font.family();
1183
1184                         switch (family_type) {
1185                         case LyXFont::SANS_FAMILY:
1186                                 tag_open.push_back(SF);
1187                                 break;
1188                         case LyXFont::TYPEWRITER_FAMILY:
1189                                 tag_open.push_back(TT);
1190                                 break;
1191                         default:
1192                                 break;
1193                         }
1194                 }
1195
1196                 if (font_old.series() != font.series()) {
1197                         switch (series_type) {
1198                         case LyXFont::BOLD_SERIES:
1199                                 tag_close |= BF;
1200                                 break;
1201                         default:
1202                                 break;
1203                         }
1204
1205                         series_type = font.series();
1206
1207                         switch (series_type) {
1208                         case LyXFont::BOLD_SERIES:
1209                                 tag_open.push_back(BF);
1210                                 break;
1211                         default:
1212                                 break;
1213                         }
1214
1215                 }
1216
1217                 if (font_old.shape() != font.shape()) {
1218                         switch (shape_type) {
1219                         case LyXFont::ITALIC_SHAPE:
1220                                 tag_close |= IT;
1221                                 break;
1222                         case LyXFont::SLANTED_SHAPE:
1223                                 tag_close |= SL;
1224                                 break;
1225                         default:
1226                                 break;
1227                         }
1228
1229                         shape_type = font.shape();
1230
1231                         switch (shape_type) {
1232                         case LyXFont::ITALIC_SHAPE:
1233                                 tag_open.push_back(IT);
1234                                 break;
1235                         case LyXFont::SLANTED_SHAPE:
1236                                 tag_open.push_back(SL);
1237                                 break;
1238                         default:
1239                                 break;
1240                         }
1241                 }
1242                 // handle <em> tag
1243                 if (font_old.emph() != font.emph()) {
1244                         if (font.emph() == LyXFont::ON) {
1245                                 tag_open.push_back(EM);
1246                                 is_em = true;
1247                         }
1248                         else if (is_em) {
1249                                 tag_close |= EM;
1250                                 is_em = false;
1251                         }
1252                 }
1253
1254                 list < PAR_TAG > temp;
1255                 while (!tag_state.empty() && tag_close) {
1256                         PAR_TAG k =  tag_state.top();
1257                         tag_state.pop();
1258                         os << "</" << tag_name(k) << '>';
1259                         if (tag_close & k)
1260                                 reset(tag_close,k);
1261                         else
1262                                 temp.push_back(k);
1263                 }
1264
1265                 for(list< PAR_TAG >::const_iterator j = temp.begin();
1266                     j != temp.end(); ++j) {
1267                         tag_state.push(*j);
1268                         os << '<' << tag_name(*j) << '>';
1269                 }
1270
1271                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1272                     j != tag_open.end(); ++j) {
1273                         tag_state.push(*j);
1274                         os << '<' << tag_name(*j) << '>';
1275                 }
1276
1277                 char c = getChar(i);
1278
1279
1280                 if (c == Paragraph::META_INSET) {
1281                         InsetOld const * inset = getInset(i);
1282                         inset->linuxdoc(buf, os, runparams);
1283                         font_old = font;
1284                         continue;
1285                 }
1286
1287                 if (style->latexparam() == "CDATA") {
1288                         // "TeX"-Mode on == > SGML-Mode on.
1289                         if (c != '\0')
1290                                 os << c;
1291                         ++char_line_count;
1292                 } else {
1293                         bool ws;
1294                         string str;
1295                         boost::tie(ws, str) = sgml::escapeChar(c);
1296                         if (ws && !isFreeSpacing()) {
1297                                 // in freespacing mode, spaces are
1298                                 // non-breaking characters
1299                                 if (desc_on) {// if char is ' ' then...
1300
1301                                         ++char_line_count;
1302                                         sgmlLineBreak(os, char_line_count, 6);
1303                                         os << "</tag>";
1304                                         desc_on = false;
1305                                 } else  {
1306                                         sgmlLineBreak(os, char_line_count, 1);
1307                                         os << c;
1308                                 }
1309                         } else {
1310                                 os << str;
1311                                 char_line_count += str.length();
1312                         }
1313                 }
1314                 font_old = font;
1315         }
1316
1317         while (!tag_state.empty()) {
1318                 os << "</" << tag_name(tag_state.top()) << '>';
1319                 tag_state.pop();
1320         }
1321
1322         // resets description flag correctly
1323         if (desc_on) {
1324                 // <tag> not closed...
1325                 sgmlLineBreak(os, char_line_count, 6);
1326                 os << "</tag>";
1327         }
1328 }
1329
1330
1331 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1332                                     ostream & os,
1333                                     LyXFont const & outerfont,
1334                                     OutputParams const & runparams,
1335                                     lyx::depth_type depth,
1336                                     bool labelid) const
1337 {
1338         bool emph_flag = false;
1339
1340         LyXLayout_ptr const & style = layout();
1341         LyXLayout_ptr const & defaultstyle
1342                 = buf.params().getLyXTextClass().defaultLayout();
1343
1344         LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
1345
1346         int char_line_count = depth;
1347         bool label_closed = true;
1348         bool para_closed = true;
1349
1350         if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1351                 string ls = "";
1352                 Counters & counters = buf.params().getLyXTextClass().counters();
1353                 if (!style->free_spacing)
1354                         os << string(depth,' ');
1355                 if (!style->labeltag().empty()) {
1356                         os << "<" << style->labeltag() << ">\n";
1357                         label_closed = false;
1358                 } else {
1359                         if (!defaultstyle->latexparam().empty()) {
1360                                 counters.step("para");
1361                                 ls = tostr(counters.value("para"));
1362                                 ls = " id=\""
1363                                         + subst(defaultstyle->latexparam(), "#", ls) + '"';
1364                         }
1365                         os << "<" << style->itemtag() << ">\n"
1366                            << string(depth, ' ') << "<"
1367                            << defaultstyle->latexname() << ls << ">\n";
1368                         para_closed = false;
1369                 }
1370         }
1371
1372         // parsing main loop
1373         for (pos_type i = 0; i < size(); ++i) {
1374                 LyXFont font = getFont(buf.params(), i, outerfont);
1375
1376                 // handle <emphasis> tag
1377                 if (font_old.emph() != font.emph()) {
1378                         if (font.emph() == LyXFont::ON) {
1379                                 if (style->latexparam() == "CDATA")
1380                                         os << "]]>";
1381                                 os << "<emphasis>";
1382                                 if (style->latexparam() == "CDATA")
1383                                         os << "<![CDATA[";
1384                                 emph_flag = true;
1385                         } else if (i) {
1386                                 if (style->latexparam() == "CDATA")
1387                                         os << "]]>";
1388                                 os << "</emphasis>";
1389                                 if (style->latexparam() == "CDATA")
1390                                         os << "<![CDATA[";
1391                                 emph_flag = false;
1392                         }
1393                 }
1394
1395
1396                 if (isInset(i)) {
1397                         InsetOld const * inset = getInset(i);
1398                         // don't print the inset in position 0 if desc_on == 3 (label)
1399                         //if (i || desc_on != 3) {
1400                         if (!labelid) {
1401                                 if (style->latexparam() == "CDATA")
1402                                         os << "]]>";
1403                                 inset->docbook(buf, os, runparams);
1404                                 if (style->latexparam() == "CDATA")
1405                                         os << "<![CDATA[";
1406                         }
1407                 } else {
1408                         char c = getChar(i);
1409                         bool ws;
1410                         string str;
1411                         boost::tie(ws, str) = sgml::escapeChar(c);
1412
1413                         if (style->pass_thru) {
1414                                 os << c;
1415                         } else if (isFreeSpacing() || c != ' ') {
1416                                         os << str;
1417                         } else if (!style->labeltag().empty() && !label_closed) {
1418                                 ++char_line_count;
1419                                 os << "\n</" << style->labeltag() << "><"
1420                                    << style->itemtag() << "><"
1421                                    << defaultstyle->latexname() << ">";
1422                                 label_closed = true;
1423                                 para_closed = false;
1424                         } else {
1425                                 os << ' ';
1426                         }
1427                 }
1428                 font_old = font;
1429         }
1430
1431         if (emph_flag) {
1432                 if (style->latexparam() == "CDATA")
1433                         os << "]]>";
1434                 os << "</emphasis>";
1435                 if (style->latexparam() == "CDATA")
1436                         os << "<![CDATA[";
1437         }
1438
1439         // resets description flag correctly
1440         if (!label_closed) {
1441                 // <term> not closed...
1442                 os << "</" << style->labeltag() << ">\n<"
1443                    << style->itemtag() << "><"
1444                    << defaultstyle->latexname() << ">&nbsp;";
1445         }
1446         if (!para_closed) {
1447                 os << "\n" << string(depth, ' ') << "</"
1448                    << defaultstyle->latexname() << ">\n";
1449         }
1450         if (style->free_spacing)
1451                 os << '\n';
1452 }
1453
1454
1455 namespace {
1456
1457 /// return true if the char is a meta-character for an inset
1458 inline
1459 bool IsInsetChar(char c)
1460 {
1461         return (c == Paragraph::META_INSET);
1462 }
1463
1464 } // namespace anon
1465
1466
1467
1468 bool Paragraph::isHfill(pos_type pos) const
1469 {
1470         return IsInsetChar(getChar(pos))
1471                && getInset(pos)->lyxCode() == InsetOld::HFILL_CODE;
1472 }
1473
1474
1475 bool Paragraph::isInset(pos_type pos) const
1476 {
1477         return IsInsetChar(getChar(pos));
1478 }
1479
1480
1481 bool Paragraph::isNewline(pos_type pos) const
1482 {
1483         return IsInsetChar(getChar(pos))
1484                && getInset(pos)->lyxCode() == InsetOld::NEWLINE_CODE;
1485 }
1486
1487
1488 bool Paragraph::isSeparator(pos_type pos) const
1489 {
1490         return IsSeparatorChar(getChar(pos));
1491 }
1492
1493
1494 bool Paragraph::isLineSeparator(pos_type pos) const
1495 {
1496         value_type const c = getChar(pos);
1497         return IsLineSeparatorChar(c)
1498                 || (IsInsetChar(c) && getInset(pos) &&
1499                 getInset(pos)->isLineSeparator());
1500 }
1501
1502
1503 bool Paragraph::isKomma(pos_type pos) const
1504 {
1505         return IsKommaChar(getChar(pos));
1506 }
1507
1508
1509 /// Used by the spellchecker
1510 bool Paragraph::isLetter(pos_type pos) const
1511 {
1512         value_type const c = getChar(pos);
1513         if (IsLetterChar(c))
1514                 return true;
1515         if (isInset(pos))
1516                 return getInset(pos)->isLetter();
1517         // We want to pass the ' and escape chars to ispell
1518         string const extra = lyxrc.isp_esc_chars + '\'';
1519         return contains(extra, c);
1520 }
1521
1522
1523 bool Paragraph::isWord(pos_type pos) const
1524 {
1525         unsigned char const c = getChar(pos);
1526         return !(IsSeparatorChar(c)
1527                   || IsKommaChar(c)
1528                   || IsInsetChar(c));
1529 }
1530
1531
1532 Language const *
1533 Paragraph::getParLanguage(BufferParams const & bparams) const
1534 {
1535         if (!empty())
1536                 return getFirstFontSettings().language();
1537 #warning FIXME we should check the prev par as well (Lgb)
1538         return bparams.language;
1539 }
1540
1541
1542 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1543 {
1544         return lyxrc.rtl_support
1545                 && getParLanguage(bparams)->RightToLeft()
1546                 && !(inInset() && inInset()->owner() &&
1547                      inInset()->owner()->lyxCode() == InsetOld::ERT_CODE);
1548 }
1549
1550
1551 void Paragraph::changeLanguage(BufferParams const & bparams,
1552                                Language const * from, Language const * to)
1553 {
1554         for (pos_type i = 0; i < size(); ++i) {
1555                 LyXFont font = getFontSettings(bparams, i);
1556                 if (font.language() == from) {
1557                         font.setLanguage(to);
1558                         setFont(i, font);
1559                 }
1560         }
1561 }
1562
1563
1564 bool Paragraph::isMultiLingual(BufferParams const & bparams)
1565 {
1566         Language const * doc_language = bparams.language;
1567         Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1568         Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1569
1570         for (; cit != end; ++cit)
1571                 if (cit->font().language() != ignore_language &&
1572                     cit->font().language() != latex_language &&
1573                     cit->font().language() != doc_language)
1574                         return true;
1575         return false;
1576 }
1577
1578
1579 // Convert the paragraph to a string.
1580 // Used for building the table of contents
1581 string const Paragraph::asString(Buffer const & buffer,
1582                                  bool label) const
1583 {
1584         OutputParams runparams;
1585         return asString(buffer, runparams, label);
1586 }
1587
1588
1589 string const Paragraph::asString(Buffer const & buffer,
1590                                  OutputParams const & runparams,
1591                                  bool label) const
1592 {
1593 #if 0
1594         string s;
1595         if (label && !params().labelString().empty())
1596                 s += params().labelString() + ' ';
1597
1598         for (pos_type i = 0; i < size(); ++i) {
1599                 value_type c = getChar(i);
1600                 if (IsPrintable(c))
1601                         s += c;
1602                 else if (c == META_INSET &&
1603                          getInset(i)->lyxCode() == InsetOld::MATH_CODE) {
1604                         ostringstream os;
1605                         getInset(i)->plaintext(buffer, os, runparams);
1606                         s += subst(STRCONV(os.str()),'\n',' ');
1607                 }
1608         }
1609
1610         return s;
1611 #else
1612         // This should really be done by the caller and not here.
1613         string ret = asString(buffer, runparams, 0, size(), label);
1614         return subst(ret, '\n', ' ');
1615 #endif
1616 }
1617
1618
1619 string const Paragraph::asString(Buffer const & buffer,
1620                                  pos_type beg, pos_type end, bool label) const
1621 {
1622
1623         OutputParams const runparams;
1624         return asString(buffer, runparams, beg, end, label);
1625 }
1626
1627
1628 string const Paragraph::asString(Buffer const & buffer,
1629                                  OutputParams const & runparams,
1630                                  pos_type beg, pos_type end, bool label) const
1631 {
1632         ostringstream os;
1633
1634         if (beg == 0 && label && !params().labelString().empty())
1635                 os << params().labelString() << ' ';
1636
1637         for (pos_type i = beg; i < end; ++i) {
1638                 value_type const c = getUChar(buffer.params(), i);
1639                 if (IsPrintable(c))
1640                         os << c;
1641                 else if (c == META_INSET)
1642                         getInset(i)->plaintext(buffer, os, runparams);
1643         }
1644
1645         return os.str();
1646 }
1647
1648
1649 void Paragraph::setInsetOwner(UpdatableInset * inset)
1650 {
1651         pimpl_->inset_owner = inset;
1652         InsetList::iterator it = insetlist.begin();
1653         InsetList::iterator end = insetlist.end();
1654         for (; it != end; ++it)
1655                 if (it->inset)
1656                         it->inset->setOwner(inset);
1657 }
1658
1659
1660 void Paragraph::setContentsFromPar(Paragraph const & par)
1661 {
1662         pimpl_->setContentsFromPar(par);
1663 }
1664
1665
1666 void Paragraph::trackChanges(Change::Type type)
1667 {
1668         pimpl_->trackChanges(type);
1669 }
1670
1671
1672 void Paragraph::untrackChanges()
1673 {
1674         pimpl_->untrackChanges();
1675 }
1676
1677
1678 void Paragraph::cleanChanges()
1679 {
1680         pimpl_->cleanChanges();
1681 }
1682
1683
1684 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1685 {
1686         BOOST_ASSERT(!size() || pos < size());
1687         return pimpl_->lookupChange(pos);
1688 }
1689
1690
1691 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1692 {
1693         BOOST_ASSERT(!size() || pos < size());
1694         return pimpl_->lookupChangeFull(pos);
1695 }
1696
1697
1698 bool Paragraph::isChanged(pos_type start, pos_type end) const
1699 {
1700         return pimpl_->isChanged(start, end);
1701 }
1702
1703
1704 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1705 {
1706         return pimpl_->isChangeEdited(start, end);
1707 }
1708
1709
1710 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1711 {
1712         pimpl_->setChange(pos, type);
1713
1714 }
1715
1716
1717 void Paragraph::markErased()
1718 {
1719         pimpl_->markErased();
1720 }
1721
1722
1723 void Paragraph::acceptChange(pos_type start, pos_type end)
1724 {
1725         return pimpl_->acceptChange(start, end);
1726 }
1727
1728
1729 void Paragraph::rejectChange(pos_type start, pos_type end)
1730 {
1731         return pimpl_->rejectChange(start, end);
1732 }
1733
1734
1735 Paragraph::value_type Paragraph::getChar(pos_type pos) const
1736 {
1737         // This is in the critical path!
1738         pos_type const siz = text_.size();
1739
1740         BOOST_ASSERT(0 <= pos);
1741         BOOST_ASSERT(pos <= siz);
1742
1743         if (pos == siz) {
1744                 lyxerr << "getChar() on pos " << pos << " in par id "
1745                        << id() << " of size " << siz
1746                        << "  is a bit silly !" << endl;
1747                 BOOST_ASSERT(false);
1748                 return '\0';
1749         }
1750
1751         return text_[pos];
1752 }
1753
1754
1755 int Paragraph::id() const
1756 {
1757         return pimpl_->id_;
1758 }
1759
1760
1761 LyXLayout_ptr const & Paragraph::layout() const
1762 {
1763 /*
1764         InsetOld * inset = inInset();
1765         if (inset && inset->lyxCode() == InsetOld::ENVIRONMENT_CODE)
1766                 return static_cast<InsetEnvironment*>(inset)->layout();
1767 */
1768         return layout_;
1769 }
1770
1771
1772 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1773 {
1774         layout_ = new_layout;
1775 }
1776
1777
1778 UpdatableInset * Paragraph::inInset() const
1779 {
1780         return pimpl_->inset_owner;
1781 }
1782
1783
1784 void Paragraph::clearContents()
1785 {
1786         text_.clear();
1787 }
1788
1789
1790 void Paragraph::setChar(pos_type pos, value_type c)
1791 {
1792         text_[pos] = c;
1793 }
1794
1795
1796 ParagraphParameters & Paragraph::params()
1797 {
1798         return pimpl_->params;
1799 }
1800
1801
1802 ParagraphParameters const & Paragraph::params() const
1803 {
1804         return pimpl_->params;
1805 }
1806
1807
1808 bool Paragraph::isFreeSpacing() const
1809 {
1810         if (layout()->free_spacing)
1811                 return true;
1812
1813         // for now we just need this, later should we need this in some
1814         // other way we can always add a function to InsetOld too.
1815         if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1816                 return pimpl_->inset_owner->owner()->lyxCode() == InsetOld::ERT_CODE;
1817         return false;
1818 }
1819
1820
1821 bool Paragraph::allowEmpty() const
1822 {
1823         if (layout()->keepempty)
1824                 return true;
1825         if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1826                 return pimpl_->inset_owner->owner()->lyxCode() == InsetOld::ERT_CODE;
1827         return false;
1828 }
1829
1830
1831 RowList::iterator Paragraph::getRow(pos_type pos)
1832 {
1833         RowList::iterator rit = rows.end();
1834         RowList::iterator const begin = rows.begin();
1835
1836         for (--rit; rit != begin && rit->pos() > pos; --rit)
1837                 ;
1838
1839         return rit;
1840 }
1841
1842
1843 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1844 {
1845         if (!Encodings::is_arabic(c))
1846                 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1847                         return c + (0xb0 - '0');
1848                 else
1849                         return c;
1850
1851         unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1852         unsigned char next_char = ' ';
1853
1854         for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1855                 unsigned char const par_char = getChar(i);
1856                 if (!Encodings::IsComposeChar_arabic(par_char)) {
1857                         next_char = par_char;
1858                         break;
1859                 }
1860         }
1861
1862         if (Encodings::is_arabic(next_char)) {
1863                 if (Encodings::is_arabic(prev_char) &&
1864                         !Encodings::is_arabic_special(prev_char))
1865                         return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1866                 else
1867                         return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1868         } else {
1869                 if (Encodings::is_arabic(prev_char) &&
1870                         !Encodings::is_arabic_special(prev_char))
1871                         return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1872                 else
1873                         return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);
1874         }
1875 }