3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
20 #include "paragraph.h"
21 #include "paragraph_pimpl.h"
24 #include "bufferparams.h"
33 #include "outputparams.h"
34 #include "paragraph_funcs.h"
39 #include "insets/insetbibitem.h"
40 #include "insets/insetoptarg.h"
42 #include "support/lstrings.h"
43 #include "support/std_sstream.h"
44 #include "support/textutils.h"
45 #include "support/tostr.h"
47 #include <boost/tuple/tuple.hpp>
48 #include <boost/bind.hpp>
55 using lyx::support::contains;
56 using lyx::support::subst;
64 using std::ostringstream;
67 Paragraph::Paragraph()
68 : y(0), height(0), begin_of_body_(0),
69 pimpl_(new Paragraph::Pimpl(this))
76 Paragraph::Paragraph(Paragraph const & par)
77 : itemdepth(par.itemdepth), insetlist(par.insetlist),
78 rows(par.rows), y(par.y), height(par.height),
79 width(par.width), layout_(par.layout_),
80 text_(par.text_), begin_of_body_(par.begin_of_body_),
81 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
83 InsetList::iterator it = insetlist.begin();
84 InsetList::iterator end = insetlist.end();
85 for (; it != end; ++it)
86 it->inset = it->inset->clone().release();
90 void Paragraph::operator=(Paragraph const & par)
92 // needed as we will destroy the pimpl_ before copying it
96 lyxerr << "Paragraph::operator=()" << endl;
98 itemdepth = par.itemdepth;
100 insetlist = par.insetlist;
101 InsetList::iterator it = insetlist.begin();
102 InsetList::iterator end = insetlist.end();
103 for (; it != end; ++it)
104 it->inset = it->inset->clone().release();
110 layout_ = par.layout();
112 begin_of_body_ = par.begin_of_body_;
115 pimpl_ = new Pimpl(*par.pimpl_, this);
119 Paragraph::~Paragraph()
123 //lyxerr << "Paragraph::paragraph_id = "
124 // << Paragraph::paragraph_id << endl;
128 void Paragraph::write(Buffer const & buf, ostream & os,
129 BufferParams const & bparams,
130 depth_type & dth) const
132 // The beginning or end of a deeper (i.e. nested) area?
133 if (dth != params().depth()) {
134 if (params().depth() > dth) {
135 while (params().depth() > dth) {
136 os << "\n\\begin_deeper ";
140 while (params().depth() < dth) {
141 os << "\n\\end_deeper ";
147 // First write the layout
148 os << "\n\\begin_layout " << layout()->name() << '\n';
152 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
154 Change running_change = Change(Change::UNCHANGED);
155 lyx::time_type const curtime(lyx::current_time());
158 for (pos_type i = 0; i < size(); ++i) {
164 Change change = pimpl_->lookupChangeFull(i);
165 Changes::lyxMarkChange(os, column, curtime, running_change, change);
166 running_change = change;
168 // Write font changes
169 LyXFont font2 = getFontSettings(bparams, i);
170 if (font2 != font1) {
171 font2.lyxWriteChanges(font1, os);
176 value_type const c = getChar(i);
180 InsetBase const * inset = getInset(i);
182 if (inset->directWrite()) {
183 // international char, let it write
184 // code directly so it's shorter in
186 inset->write(buf, os);
188 os << "\n\\begin_inset ";
189 inset->write(buf, os);
190 os << "\n\\end_inset \n\n";
196 os << "\n\\backslash \n";
200 if (i + 1 < size() && getChar(i + 1) == ' ') {
207 if ((column > 70 && c == ' ')
212 // this check is to amend a bug. LyX sometimes
213 // inserts '\0' this could cause problems.
217 lyxerr << "ERROR (Paragraph::writeFile):"
218 " NULL char in structure." << endl;
224 // to make reading work properly
226 running_change = pimpl_->lookupChange(0);
227 Changes::lyxMarkChange(os, column, curtime,
228 Change(Change::UNCHANGED), running_change);
230 Changes::lyxMarkChange(os, column, curtime,
231 running_change, Change(Change::UNCHANGED));
233 os << "\n\\end_layout\n";
237 void Paragraph::validate(LaTeXFeatures & features) const
239 pimpl_->validate(features, *layout());
243 void Paragraph::eraseIntern(lyx::pos_type pos)
245 pimpl_->eraseIntern(pos);
249 bool Paragraph::erase(pos_type pos)
251 return pimpl_->erase(pos);
255 int Paragraph::erase(pos_type start, pos_type end)
257 return pimpl_->erase(start, end);
261 void Paragraph::insert(pos_type start, string const & str,
262 LyXFont const & font)
264 int size = str.size();
265 for (int i = 0 ; i < size ; ++i)
266 insertChar(start + i, str[i], font);
270 bool Paragraph::checkInsertChar(LyXFont &)
276 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c)
278 insertChar(pos, c, LyXFont(LyXFont::ALL_INHERIT));
282 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
283 LyXFont const & font, Change change)
285 pimpl_->insertChar(pos, c, font, change);
289 void Paragraph::insertInset(pos_type pos, InsetBase * inset)
291 insertInset(pos, inset, LyXFont(LyXFont::ALL_INHERIT));
295 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
296 LyXFont const & font, Change change)
298 pimpl_->insertInset(pos, inset, font, change);
302 bool Paragraph::insetAllowed(InsetOld_code code)
304 //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
305 if (pimpl_->inset_owner)
306 return pimpl_->inset_owner->insetAllowed(code);
311 InsetBase * Paragraph::getInset(pos_type pos)
313 BOOST_ASSERT(pos < size());
314 return insetlist.get(pos);
318 InsetBase const * Paragraph::getInset(pos_type pos) const
320 BOOST_ASSERT(pos < size());
321 return insetlist.get(pos);
325 // Gets uninstantiated font setting at position.
326 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
330 lyxerr << " pos: " << pos << " size: " << size() << endl;
331 BOOST_ASSERT(pos <= size());
334 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
335 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
336 for (; cit != end; ++cit)
337 if (cit->pos() >= pos)
343 if (pos == size() && !empty())
344 return getFontSettings(bparams, pos - 1);
346 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
350 lyx::pos_type Paragraph::getEndPosOfFontSpan(lyx::pos_type pos) const
352 BOOST_ASSERT(pos <= size());
354 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
355 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
356 for (; cit != end; ++cit)
357 if (cit->pos() >= pos)
360 // This should not happen, but if so, we take no chances.
361 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
367 // Gets uninstantiated font setting at position 0
368 LyXFont const Paragraph::getFirstFontSettings() const
370 if (!empty() && !pimpl_->fontlist.empty())
371 return pimpl_->fontlist[0].font();
373 return LyXFont(LyXFont::ALL_INHERIT);
377 // Gets the fully instantiated font at a given position in a paragraph
378 // This is basically the same function as LyXText::GetFont() in text2.C.
379 // The difference is that this one is used for generating the LaTeX file,
380 // and thus cosmetic "improvements" are disallowed: This has to deliver
381 // the true picture of the buffer. (Asger)
382 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
383 LyXFont const & outerfont) const
385 BOOST_ASSERT(pos >= 0);
387 LyXLayout_ptr const & lout = layout();
389 pos_type const body_pos = beginOfBody();
393 layoutfont = lout->labelfont;
395 layoutfont = lout->font;
397 LyXFont font = getFontSettings(bparams, pos);
398 font.realize(layoutfont);
399 font.realize(outerfont);
400 font.realize(bparams.getLyXTextClass().defaultfont());
406 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams,
407 LyXFont const & outerfont) const
409 LyXFont tmpfont = layout()->labelfont;
410 tmpfont.setLanguage(getParLanguage(bparams));
411 tmpfont.realize(outerfont);
412 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
417 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams,
418 LyXFont const & outerfont) const
420 LyXFont tmpfont = layout()->font;
421 tmpfont.setLanguage(getParLanguage(bparams));
422 tmpfont.realize(outerfont);
423 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
428 /// Returns the height of the highest font in range
430 Paragraph::highestFontInRange(pos_type startpos, pos_type endpos,
431 LyXFont_size def_size) const
433 if (pimpl_->fontlist.empty())
436 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
437 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
438 for (; end_it != end; ++end_it) {
439 if (end_it->pos() >= endpos)
446 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
447 for (; cit != end; ++cit) {
448 if (cit->pos() >= startpos)
452 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
453 for (; cit != end_it; ++cit) {
454 LyXFont::FONT_SIZE size = cit->font().size();
455 if (size == LyXFont::INHERIT_SIZE)
457 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
464 Paragraph::value_type
465 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
467 value_type c = getChar(pos);
468 if (!lyxrc.rtl_support)
498 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
505 void Paragraph::setFont(pos_type pos, LyXFont const & font)
507 BOOST_ASSERT(pos <= size());
509 // First, reduce font against layout/label font
510 // Update: The setCharFont() routine in text2.C already
511 // reduces font, so we don't need to do that here. (Asger)
512 // No need to simplify this because it will disappear
513 // in a new kernel. (Asger)
514 // Next search font table
516 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
517 Pimpl::FontList::iterator it = beg;
518 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
519 for (; it != endit; ++it) {
520 if (it->pos() >= pos)
523 unsigned int i = distance(beg, it);
524 bool notfound = (it == endit);
526 if (!notfound && pimpl_->fontlist[i].font() == font)
529 bool begin = pos == 0 || notfound ||
530 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
531 // Is position pos is a beginning of a font block?
532 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
533 // Is position pos is the end of a font block?
534 if (begin && end) { // A single char block
535 if (i + 1 < pimpl_->fontlist.size() &&
536 pimpl_->fontlist[i + 1].font() == font) {
537 // Merge the singleton block with the next block
538 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
539 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
540 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
541 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
542 // Merge the singleton block with the previous block
543 pimpl_->fontlist[i - 1].pos(pos);
544 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
546 pimpl_->fontlist[i].font(font);
548 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
549 pimpl_->fontlist[i - 1].pos(pos);
551 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
552 Pimpl::FontTable(pos, font));
554 pimpl_->fontlist[i].pos(pos - 1);
555 if (!(i + 1 < pimpl_->fontlist.size() &&
556 pimpl_->fontlist[i + 1].font() == font))
557 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
558 Pimpl::FontTable(pos, font));
559 } else { // The general case. The block is splitted into 3 blocks
560 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
561 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
562 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
563 Pimpl::FontTable(pos, font));
568 void Paragraph::makeSameLayout(Paragraph const & par)
570 layout(par.layout());
572 params() = par.params();
576 int Paragraph::stripLeadingSpaces()
582 while (!empty() && (isNewline(0) || isLineSeparator(0))) {
583 pimpl_->eraseIntern(0);
591 bool Paragraph::hasSameLayout(Paragraph const & par) const
593 return par.layout() == layout() && params().sameLayout(par.params());
597 Paragraph::depth_type Paragraph::getDepth() const
599 return params().depth();
603 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
605 if (layout()->isEnvironment())
606 return params().depth() + 1;
608 return params().depth();
612 char Paragraph::getAlign() const
614 return params().align();
618 string const & Paragraph::getLabelstring() const
620 return params().labelString();
624 // the next two functions are for the manual labels
625 string const Paragraph::getLabelWidthString() const
627 if (!params().labelWidthString().empty())
628 return params().labelWidthString();
630 return _("Senseless with this layout!");
634 void Paragraph::setLabelWidthString(string const & s)
636 params().labelWidthString(s);
640 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
643 params().labelWidthString(string());
644 params().align(LYX_ALIGN_LAYOUT);
645 params().spacing(Spacing(Spacing::Default));
649 int Paragraph::beginOfBody() const
651 return begin_of_body_;
655 void Paragraph::setBeginOfBody()
657 if (layout()->labeltype != LABEL_MANUAL) {
662 // Unroll the first two cycles of the loop
663 // and remember the previous character to
664 // remove unnecessary getChar() calls
666 pos_type end = size();
667 if (i < end && !isNewline(i)) {
669 char previous_char = 0;
672 previous_char = text_[i];
675 while (i < end && previous_char != ' ') {
680 previous_char = temp;
690 // returns -1 if inset not found
691 int Paragraph::getPositionOfInset(InsetBase const * inset) const
694 InsetList::const_iterator it = insetlist.begin();
695 InsetList::const_iterator end = insetlist.end();
696 for (; it != end; ++it)
697 if (it->inset == inset)
703 InsetBibitem * Paragraph::bibitem() const
705 if (!insetlist.empty()) {
706 InsetBase * inset = insetlist.begin()->inset;
707 if (inset->lyxCode() == InsetBase::BIBTEX_CODE)
708 return static_cast<InsetBibitem *>(inset);
716 // paragraphs inside floats need different alignment tags to avoid
719 bool noTrivlistCentering(UpdatableInset const * inset)
721 if (inset && inset->owner()) {
722 InsetBase::Code const code = inset->owner()->lyxCode();
723 return code == InsetBase::FLOAT_CODE ||
724 code == InsetBase::WRAP_CODE;
730 string correction(string const & orig)
732 if (orig == "flushleft")
733 return "raggedright";
734 if (orig == "flushright")
736 if (orig == "center")
742 string const corrected_env(string const & suffix, string const & env,
743 UpdatableInset const * inset)
745 string output = suffix + "{";
746 if (noTrivlistCentering(inset))
747 output += correction(env);
756 // This could go to ParagraphParameters if we want to
757 int Paragraph::startTeXParParams(BufferParams const & bparams,
758 ostream & os, bool moving_arg) const
762 if (params().noindent()) {
767 switch (params().align()) {
769 case LYX_ALIGN_BLOCK:
770 case LYX_ALIGN_LAYOUT:
771 case LYX_ALIGN_SPECIAL:
774 case LYX_ALIGN_RIGHT:
775 case LYX_ALIGN_CENTER:
783 switch (params().align()) {
785 case LYX_ALIGN_BLOCK:
786 case LYX_ALIGN_LAYOUT:
787 case LYX_ALIGN_SPECIAL:
789 case LYX_ALIGN_LEFT: {
791 UpdatableInset const * const inset = pimpl_->inset_owner;
792 if (getParLanguage(bparams)->babel() != "hebrew")
793 output = corrected_env("\\begin", "flushleft", inset);
795 output = corrected_env("\\begin", "flushright", inset);
797 column += output.size();
799 } case LYX_ALIGN_RIGHT: {
801 UpdatableInset const * const inset = pimpl_->inset_owner;
802 if (getParLanguage(bparams)->babel() != "hebrew")
803 output = corrected_env("\\begin", "flushright", inset);
805 output = corrected_env("\\begin", "flushleft", inset);
807 column += output.size();
809 } case LYX_ALIGN_CENTER: {
811 output = corrected_env("\\begin", "center", pimpl_->inset_owner);
813 column += output.size();
822 // This could go to ParagraphParameters if we want to
823 int Paragraph::endTeXParParams(BufferParams const & bparams,
824 ostream & os, bool moving_arg) const
828 switch (params().align()) {
830 case LYX_ALIGN_BLOCK:
831 case LYX_ALIGN_LAYOUT:
832 case LYX_ALIGN_SPECIAL:
835 case LYX_ALIGN_RIGHT:
836 case LYX_ALIGN_CENTER:
844 switch (params().align()) {
846 case LYX_ALIGN_BLOCK:
847 case LYX_ALIGN_LAYOUT:
848 case LYX_ALIGN_SPECIAL:
850 case LYX_ALIGN_LEFT: {
852 UpdatableInset const * const inset = pimpl_->inset_owner;
853 if (getParLanguage(bparams)->babel() != "hebrew")
854 output = corrected_env("\\par\\end", "flushleft", inset);
856 output = corrected_env("\\par\\end", "flushright", inset);
858 column += output.size();
860 } case LYX_ALIGN_RIGHT: {
862 UpdatableInset const * const inset = pimpl_->inset_owner;
863 if (getParLanguage(bparams)->babel() != "hebrew")
864 output = corrected_env("\\par\\end", "flushright", inset);
866 output = corrected_env("\\par\\end", "flushleft", inset);
868 column += output.size();
870 } case LYX_ALIGN_CENTER: {
872 output = corrected_env("\\par\\end", "center", pimpl_->inset_owner);
874 column += output.size();
883 // This one spits out the text of the paragraph
884 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
885 BufferParams const & bparams,
886 LyXFont const & outerfont,
887 ostream & os, TexRow & texrow,
888 OutputParams const & runparams)
890 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
892 bool return_value = false;
896 // well we have to check if we are in an inset with unlimited
897 // length (all in one row) if that is true then we don't allow
898 // any special options in the paragraph and also we don't allow
899 // any environment other then "Standard" to be valid!
901 (inInset() && inInset()->forceDefaultParagraphs(inInset()));
904 style = bparams.getLyXTextClass().defaultLayout();
911 // Maybe we have to create a optional argument.
912 pos_type body_pos = beginOfBody();
913 unsigned int column = 0;
918 basefont = getLabelFont(bparams, outerfont);
920 basefont = getLayoutFont(bparams, outerfont);
923 bool moving_arg = runparams.moving_arg;
924 moving_arg |= style->needprotect;
926 // Which font is currently active?
927 LyXFont running_font(basefont);
928 // Do we have an open font change?
929 bool open_font = false;
931 Change::Type running_change = Change::UNCHANGED;
933 texrow.start(id(), 0);
935 // if the paragraph is empty, the loop will not be entered at all
937 if (style->isCommand()) {
942 column += startTeXParParams(bparams, os, moving_arg);
945 for (pos_type i = 0; i < size(); ++i) {
947 // First char in paragraph or after label?
951 column += running_font.latexWriteEndChanges(os, basefont, basefont);
954 basefont = getLayoutFont(bparams, outerfont);
955 running_font = basefont;
959 if (style->isCommand()) {
965 column += startTeXParParams(bparams, os,
969 value_type c = getChar(i);
971 // Fully instantiated font
972 LyXFont font = getFont(bparams, i, outerfont);
974 LyXFont const last_font = running_font;
976 // Spaces at end of font change are simulated to be
977 // outside font change, i.e. we write "\textXX{text} "
978 // rather than "\textXX{text }". (Asger)
979 if (open_font && c == ' ' && i <= size() - 2) {
980 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
981 if (next_font != running_font && next_font != font) {
986 // We end font definition before blanks
988 (font != running_font ||
989 font.language() != running_font.language()))
991 column += running_font.latexWriteEndChanges(os,
993 (i == body_pos-1) ? basefont : font);
994 running_font = basefont;
998 // Blanks are printed before start of fontswitch
1000 // Do not print the separation of the optional argument
1001 if (i != body_pos - 1) {
1002 pimpl_->simpleTeXBlanks(os, texrow, i,
1003 column, font, *style);
1007 // Do we need to change font?
1008 if ((font != running_font ||
1009 font.language() != running_font.language()) &&
1012 column += font.latexWriteStartChanges(os, basefont,
1014 running_font = font;
1018 Change::Type change = pimpl_->lookupChange(i);
1020 column += Changes::latexMarkChange(os, running_change, change);
1021 running_change = change;
1023 OutputParams rp = runparams;
1024 rp.moving_arg = moving_arg;
1025 rp.free_spacing = style->free_spacing;
1026 pimpl_->simpleTeXSpecialChars(buf, bparams,
1027 os, texrow, runparams,
1029 basefont, outerfont, open_font,
1031 *style, i, column, c);
1034 column += Changes::latexMarkChange(os,
1035 running_change, Change::UNCHANGED);
1037 // If we have an open font definition, we have to close it
1039 #ifdef FIXED_LANGUAGE_END_DETECTION
1042 .latexWriteEndChanges(os, basefont,
1043 next_->getFont(bparams,
1046 running_font.latexWriteEndChanges(os, basefont,
1050 #ifdef WITH_WARNINGS
1051 //#warning For now we ALWAYS have to close the foreign font settings if they are
1052 //#warning there as we start another \selectlanguage with the next paragraph if
1053 //#warning we are in need of this. This should be fixed sometime (Jug)
1055 running_font.latexWriteEndChanges(os, basefont, basefont);
1059 // Needed if there is an optional argument but no contents.
1060 if (body_pos > 0 && body_pos == size()) {
1062 return_value = false;
1066 column += endTeXParParams(bparams, os, moving_arg);
1069 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1070 return return_value;
1076 // checks, if newcol chars should be put into this line
1077 // writes newline, if necessary.
1078 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1079 string::size_type newcol)
1082 if (colcount > lyxrc.ascii_linelen) {
1084 colcount = newcol; // assume write after this call
1099 string tag_name(PAR_TAG const & pt) {
1101 case PAR_NONE: return "!-- --";
1102 case TT: return "tt";
1103 case SF: return "sf";
1104 case BF: return "bf";
1105 case IT: return "it";
1106 case SL: return "sl";
1107 case EM: return "em";
1114 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1116 p1 = static_cast<PAR_TAG>(p1 | p2);
1121 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1123 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1129 // Handle internal paragraph parsing -- layout already processed.
1130 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1132 LyXFont const & outerfont,
1133 OutputParams const & runparams,
1134 lyx::depth_type /*depth*/) const
1136 LyXLayout_ptr const & style = layout();
1138 string::size_type char_line_count = 5; // Heuristic choice ;-)
1140 // gets paragraph main font
1143 if (style->labeltype == LABEL_MANUAL) {
1144 font_old = style->labelfont;
1147 font_old = style->font;
1151 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1152 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1153 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
1156 stack<PAR_TAG> tag_state;
1157 // parsing main loop
1158 for (pos_type i = 0; i < size(); ++i) {
1160 PAR_TAG tag_close = PAR_NONE;
1161 list < PAR_TAG > tag_open;
1163 LyXFont const font = getFont(buf.params(), i, outerfont);
1165 if (font_old.family() != font.family()) {
1166 switch (family_type) {
1167 case LyXFont::SANS_FAMILY:
1170 case LyXFont::TYPEWRITER_FAMILY:
1177 family_type = font.family();
1179 switch (family_type) {
1180 case LyXFont::SANS_FAMILY:
1181 tag_open.push_back(SF);
1183 case LyXFont::TYPEWRITER_FAMILY:
1184 tag_open.push_back(TT);
1191 if (font_old.series() != font.series()) {
1192 switch (series_type) {
1193 case LyXFont::BOLD_SERIES:
1200 series_type = font.series();
1202 switch (series_type) {
1203 case LyXFont::BOLD_SERIES:
1204 tag_open.push_back(BF);
1212 if (font_old.shape() != font.shape()) {
1213 switch (shape_type) {
1214 case LyXFont::ITALIC_SHAPE:
1217 case LyXFont::SLANTED_SHAPE:
1224 shape_type = font.shape();
1226 switch (shape_type) {
1227 case LyXFont::ITALIC_SHAPE:
1228 tag_open.push_back(IT);
1230 case LyXFont::SLANTED_SHAPE:
1231 tag_open.push_back(SL);
1238 if (font_old.emph() != font.emph()) {
1239 if (font.emph() == LyXFont::ON) {
1240 tag_open.push_back(EM);
1249 list < PAR_TAG > temp;
1250 while (!tag_state.empty() && tag_close) {
1251 PAR_TAG k = tag_state.top();
1253 os << "</" << tag_name(k) << '>';
1260 for(list< PAR_TAG >::const_iterator j = temp.begin();
1261 j != temp.end(); ++j) {
1263 os << '<' << tag_name(*j) << '>';
1266 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1267 j != tag_open.end(); ++j) {
1269 os << '<' << tag_name(*j) << '>';
1272 char c = getChar(i);
1275 if (c == Paragraph::META_INSET) {
1276 getInset(i)->linuxdoc(buf, os, runparams);
1281 if (style->latexparam() == "CDATA") {
1282 // "TeX"-Mode on == > SGML-Mode on.
1289 boost::tie(ws, str) = sgml::escapeChar(c);
1290 if (ws && !isFreeSpacing()) {
1291 // in freespacing mode, spaces are
1292 // non-breaking characters
1293 if (desc_on) { // if char is ' ' then...
1295 sgmlLineBreak(os, char_line_count, 6);
1299 sgmlLineBreak(os, char_line_count, 1);
1304 char_line_count += str.length();
1310 while (!tag_state.empty()) {
1311 os << "</" << tag_name(tag_state.top()) << '>';
1315 // resets description flag correctly
1317 // <tag> not closed...
1318 sgmlLineBreak(os, char_line_count, 6);
1324 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1326 LyXFont const & outerfont,
1327 OutputParams const & runparams,
1328 lyx::depth_type depth,
1331 bool emph_flag = false;
1333 LyXLayout_ptr const & style = layout();
1334 LyXLayout_ptr const & defaultstyle =
1335 buf.params().getLyXTextClass().defaultLayout();
1338 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1340 int char_line_count = depth;
1341 bool label_closed = true;
1342 bool para_closed = true;
1344 if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1346 Counters & counters = buf.params().getLyXTextClass().counters();
1347 if (!style->free_spacing)
1348 os << string(depth,' ');
1349 if (!style->labeltag().empty()) {
1350 os << "<" << style->labeltag() << ">\n";
1351 label_closed = false;
1353 if (!defaultstyle->latexparam().empty()) {
1354 counters.step("para");
1355 ls = tostr(counters.value("para"));
1357 + subst(defaultstyle->latexparam(), "#", ls) + '"';
1359 os << "<" << style->itemtag() << ">\n"
1360 << string(depth, ' ') << "<"
1361 << defaultstyle->latexname() << ls << ">\n";
1362 para_closed = false;
1366 // parsing main loop
1367 for (pos_type i = 0; i < size(); ++i) {
1368 LyXFont font = getFont(buf.params(), i, outerfont);
1370 // handle <emphasis> tag
1371 if (font_old.emph() != font.emph()) {
1372 if (font.emph() == LyXFont::ON) {
1373 if (style->latexparam() == "CDATA")
1376 if (style->latexparam() == "CDATA")
1380 if (style->latexparam() == "CDATA")
1382 os << "</emphasis>";
1383 if (style->latexparam() == "CDATA")
1390 InsetBase const * inset = getInset(i);
1391 // don't print the inset in position 0 if desc_on == 3 (label)
1392 //if (i || desc_on != 3) {
1394 if (style->latexparam() == "CDATA")
1396 inset->docbook(buf, os, runparams);
1397 if (style->latexparam() == "CDATA")
1401 char c = getChar(i);
1404 boost::tie(ws, str) = sgml::escapeChar(c);
1406 if (style->pass_thru) {
1408 } else if (isFreeSpacing() || c != ' ') {
1410 } else if (!style->labeltag().empty() && !label_closed) {
1412 os << "\n</" << style->labeltag() << "><"
1413 << style->itemtag() << "><"
1414 << defaultstyle->latexname() << ">";
1415 label_closed = true;
1416 para_closed = false;
1425 if (style->latexparam() == "CDATA")
1427 os << "</emphasis>";
1428 if (style->latexparam() == "CDATA")
1432 // resets description flag correctly
1433 if (!label_closed) {
1434 // <term> not closed...
1435 os << "</" << style->labeltag() << ">\n<"
1436 << style->itemtag() << "><"
1437 << defaultstyle->latexname() << "> ";
1440 os << "\n" << string(depth, ' ') << "</"
1441 << defaultstyle->latexname() << ">\n";
1443 if (style->free_spacing)
1450 /// return true if the char is a meta-character for an inset
1452 bool IsInsetChar(char c)
1454 return (c == Paragraph::META_INSET);
1461 bool Paragraph::isHfill(pos_type pos) const
1463 return IsInsetChar(getChar(pos))
1464 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
1468 bool Paragraph::isInset(pos_type pos) const
1470 return IsInsetChar(getChar(pos));
1474 bool Paragraph::isNewline(pos_type pos) const
1476 return IsInsetChar(getChar(pos))
1477 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1481 bool Paragraph::isSeparator(pos_type pos) const
1483 return IsSeparatorChar(getChar(pos));
1487 bool Paragraph::isLineSeparator(pos_type pos) const
1489 value_type const c = getChar(pos);
1490 return IsLineSeparatorChar(c)
1491 || (IsInsetChar(c) && getInset(pos) &&
1492 getInset(pos)->isLineSeparator());
1496 bool Paragraph::isKomma(pos_type pos) const
1498 return IsKommaChar(getChar(pos));
1502 /// Used by the spellchecker
1503 bool Paragraph::isLetter(pos_type pos) const
1505 value_type const c = getChar(pos);
1506 if (IsLetterChar(c))
1509 return getInset(pos)->isLetter();
1510 // We want to pass the ' and escape chars to ispell
1511 string const extra = lyxrc.isp_esc_chars + '\'';
1512 return contains(extra, c);
1516 bool Paragraph::isWord(pos_type pos) const
1518 unsigned char const c = getChar(pos);
1519 return !(IsSeparatorChar(c)
1526 Paragraph::getParLanguage(BufferParams const & bparams) const
1529 return getFirstFontSettings().language();
1530 #warning FIXME we should check the prev par as well (Lgb)
1531 return bparams.language;
1535 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1537 return lyxrc.rtl_support
1538 && getParLanguage(bparams)->RightToLeft()
1539 && !(inInset() && inInset()->owner() &&
1540 inInset()->owner()->lyxCode() == InsetBase::ERT_CODE);
1544 void Paragraph::changeLanguage(BufferParams const & bparams,
1545 Language const * from, Language const * to)
1547 for (pos_type i = 0; i < size(); ++i) {
1548 LyXFont font = getFontSettings(bparams, i);
1549 if (font.language() == from) {
1550 font.setLanguage(to);
1557 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1559 Language const * doc_language = bparams.language;
1560 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1561 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1563 for (; cit != end; ++cit)
1564 if (cit->font().language() != ignore_language &&
1565 cit->font().language() != latex_language &&
1566 cit->font().language() != doc_language)
1572 // Convert the paragraph to a string.
1573 // Used for building the table of contents
1574 string const Paragraph::asString(Buffer const & buffer,
1577 OutputParams runparams;
1578 return asString(buffer, runparams, label);
1582 string const Paragraph::asString(Buffer const & buffer,
1583 OutputParams const & runparams,
1588 if (label && !params().labelString().empty())
1589 s += params().labelString() + ' ';
1591 for (pos_type i = 0; i < size(); ++i) {
1592 value_type c = getChar(i);
1595 else if (c == META_INSET &&
1596 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1598 getInset(i)->plaintext(buffer, os, runparams);
1599 s += subst(STRCONV(os.str()),'\n',' ');
1605 // This should really be done by the caller and not here.
1606 string ret = asString(buffer, runparams, 0, size(), label);
1607 return subst(ret, '\n', ' ');
1612 string const Paragraph::asString(Buffer const & buffer,
1613 pos_type beg, pos_type end, bool label) const
1616 OutputParams const runparams;
1617 return asString(buffer, runparams, beg, end, label);
1621 string const Paragraph::asString(Buffer const & buffer,
1622 OutputParams const & runparams,
1623 pos_type beg, pos_type end, bool label) const
1627 if (beg == 0 && label && !params().labelString().empty())
1628 os << params().labelString() << ' ';
1630 for (pos_type i = beg; i < end; ++i) {
1631 value_type const c = getUChar(buffer.params(), i);
1634 else if (c == META_INSET)
1635 getInset(i)->plaintext(buffer, os, runparams);
1642 void Paragraph::setInsetOwner(UpdatableInset * inset)
1644 pimpl_->inset_owner = inset;
1645 InsetList::iterator it = insetlist.begin();
1646 InsetList::iterator end = insetlist.end();
1647 for (; it != end; ++it)
1649 it->inset->setOwner(inset);
1653 void Paragraph::setContentsFromPar(Paragraph const & par)
1655 pimpl_->setContentsFromPar(par);
1659 void Paragraph::trackChanges(Change::Type type)
1661 pimpl_->trackChanges(type);
1665 void Paragraph::untrackChanges()
1667 pimpl_->untrackChanges();
1671 void Paragraph::cleanChanges()
1673 pimpl_->cleanChanges();
1677 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1679 BOOST_ASSERT(!size() || pos < size());
1680 return pimpl_->lookupChange(pos);
1684 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1686 BOOST_ASSERT(!size() || pos < size());
1687 return pimpl_->lookupChangeFull(pos);
1691 bool Paragraph::isChanged(pos_type start, pos_type end) const
1693 return pimpl_->isChanged(start, end);
1697 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1699 return pimpl_->isChangeEdited(start, end);
1703 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1705 pimpl_->setChange(pos, type);
1709 void Paragraph::markErased()
1711 pimpl_->markErased();
1715 void Paragraph::acceptChange(pos_type start, pos_type end)
1717 return pimpl_->acceptChange(start, end);
1721 void Paragraph::rejectChange(pos_type start, pos_type end)
1723 return pimpl_->rejectChange(start, end);
1727 Paragraph::value_type Paragraph::getChar(pos_type pos) const
1729 // This is in the critical path!
1730 pos_type const siz = text_.size();
1732 BOOST_ASSERT(0 <= pos);
1733 BOOST_ASSERT(pos <= siz);
1736 lyxerr << "getChar() on pos " << pos << " in par id "
1737 << id() << " of size " << siz
1738 << " is a bit silly !" << endl;
1739 BOOST_ASSERT(false);
1746 int Paragraph::id() const
1752 LyXLayout_ptr const & Paragraph::layout() const
1755 InsetBase * inset = inInset();
1756 if (inset && inset->lyxCode() == InsetBase::ENVIRONMENT_CODE)
1757 return static_cast<InsetEnvironment*>(inset)->layout();
1763 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1765 layout_ = new_layout;
1769 UpdatableInset * Paragraph::inInset() const
1771 return pimpl_->inset_owner;
1775 void Paragraph::clearContents()
1781 void Paragraph::setChar(pos_type pos, value_type c)
1787 ParagraphParameters & Paragraph::params()
1789 return pimpl_->params;
1793 ParagraphParameters const & Paragraph::params() const
1795 return pimpl_->params;
1799 bool Paragraph::isFreeSpacing() const
1801 if (layout()->free_spacing)
1804 // for now we just need this, later should we need this in some
1805 // other way we can always add a function to InsetBase too.
1806 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1807 return pimpl_->inset_owner->owner()->lyxCode() == InsetBase::ERT_CODE;
1812 bool Paragraph::allowEmpty() const
1814 if (layout()->keepempty)
1816 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1817 return pimpl_->inset_owner->owner()->lyxCode() == InsetBase::ERT_CODE;
1822 RowList::iterator Paragraph::getRow(pos_type pos)
1824 RowList::iterator rit = rows.end();
1825 RowList::iterator const begin = rows.begin();
1827 for (--rit; rit != begin && rit->pos() > pos; --rit)
1834 RowList::const_iterator Paragraph::getRow(pos_type pos) const
1836 RowList::const_iterator rit = rows.end();
1837 RowList::const_iterator const begin = rows.begin();
1839 for (--rit; rit != begin && rit->pos() > pos; --rit)
1846 size_t Paragraph::row(pos_type pos) const
1848 RowList::const_iterator rit = rows.end();
1849 RowList::const_iterator const begin = rows.begin();
1851 for (--rit; rit != begin && rit->pos() > pos; --rit)
1858 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1860 if (!Encodings::is_arabic(c))
1861 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1862 return c + (0xb0 - '0');
1866 unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1867 unsigned char next_char = ' ';
1869 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1870 unsigned char const par_char = getChar(i);
1871 if (!Encodings::IsComposeChar_arabic(par_char)) {
1872 next_char = par_char;
1877 if (Encodings::is_arabic(next_char)) {
1878 if (Encodings::is_arabic(prev_char) &&
1879 !Encodings::is_arabic_special(prev_char))
1880 return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1882 return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1884 if (Encodings::is_arabic(prev_char) &&
1885 !Encodings::is_arabic_special(prev_char))
1886 return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1888 return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);