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