src/paragraph.C

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