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