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