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"
30 #include "LaTeXFeatures.h"
34 #include "outputparams.h"
35 #include "paragraph_funcs.h"
36 #include "ParagraphList_fwd.h"
41 #include "insets/insetbibitem.h"
42 #include "insets/insetoptarg.h"
44 #include "support/lstrings.h"
45 #include "support/textutils.h"
46 #include "support/convert.h"
48 #include <boost/tuple/tuple.hpp>
49 #include <boost/bind.hpp>
58 using lyx::support::subst;
66 using std::ostringstream;
69 ParagraphList::ParagraphList()
73 Paragraph::Paragraph()
74 : begin_of_body_(0), pimpl_(new Paragraph::Pimpl(this))
81 Paragraph::Paragraph(Paragraph const & par)
82 : itemdepth(par.itemdepth), insetlist(par.insetlist),
84 rows_(par.rows_), layout_(par.layout_),
85 text_(par.text_), begin_of_body_(par.begin_of_body_),
86 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
88 //lyxerr << "Paragraph::Paragraph(Paragraph const&)" << endl;
89 InsetList::iterator it = insetlist.begin();
90 InsetList::iterator end = insetlist.end();
91 for (; it != end; ++it)
92 it->inset = it->inset->clone().release();
96 Paragraph & Paragraph::operator=(Paragraph const & par)
98 // needed as we will destroy the pimpl_ before copying it
100 itemdepth = par.itemdepth;
102 insetlist = par.insetlist;
103 InsetList::iterator it = insetlist.begin();
104 InsetList::iterator end = insetlist.end();
105 for (; it != end; ++it)
106 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);
121 Paragraph::~Paragraph()
125 //lyxerr << "Paragraph::paragraph_id = "
126 // << Paragraph::paragraph_id << endl;
130 void Paragraph::write(Buffer const & buf, ostream & os,
131 BufferParams const & bparams,
132 depth_type & dth) const
134 // The beginning or end of a deeper (i.e. nested) area?
135 if (dth != params().depth()) {
136 if (params().depth() > dth) {
137 while (params().depth() > dth) {
138 os << "\n\\begin_deeper";
142 while (params().depth() < dth) {
143 os << "\n\\end_deeper";
149 // First write the layout
150 os << "\n\\begin_layout " << layout()->name() << '\n';
154 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
156 Change running_change = Change(Change::UNCHANGED);
157 lyx::time_type const curtime(lyx::current_time());
160 for (pos_type i = 0; i < size(); ++i) {
162 Change change = pimpl_->lookupChangeFull(i);
163 Changes::lyxMarkChange(os, column, curtime, running_change, change);
164 running_change = change;
166 // Write font changes
167 LyXFont font2 = getFontSettings(bparams, i);
168 if (font2 != font1) {
169 font2.lyxWriteChanges(font1, os);
174 value_type const c = getChar(i);
178 InsetBase const * inset = getInset(i);
180 if (inset->directWrite()) {
181 // international char, let it write
182 // code directly so it's shorter in
184 inset->write(buf, os);
188 os << "\\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 for (size_t i = 0, n = str.size(); i != n ; ++i)
265 insertChar(start + i, str[i], font);
269 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
272 pimpl_->insertChar(pos, c, change);
276 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
277 LyXFont const & font, Change change)
279 pimpl_->insertChar(pos, c, change);
284 void Paragraph::insertInset(pos_type pos, InsetBase * inset, Change change)
286 pimpl_->insertInset(pos, inset, change);
290 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
291 LyXFont const & font, Change change)
293 pimpl_->insertInset(pos, inset, change);
298 bool Paragraph::insetAllowed(InsetBase_code code)
300 return !pimpl_->inset_owner || pimpl_->inset_owner->insetAllowed(code);
304 // Gets uninstantiated font setting at position.
305 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
309 lyxerr << " pos: " << pos << " size: " << size() << endl;
310 BOOST_ASSERT(pos <= size());
313 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
314 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
315 for (; cit != end; ++cit)
316 if (cit->pos() >= pos)
322 if (pos == size() && !empty())
323 return getFontSettings(bparams, pos - 1);
325 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
329 FontSpan Paragraph::fontSpan(lyx::pos_type pos) const
331 BOOST_ASSERT(pos <= size());
332 lyx::pos_type start = 0;
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) {
338 if (pos >= beginOfBody())
339 return FontSpan(std::max(start, beginOfBody()),
342 return FontSpan(start,
343 std::min(beginOfBody() - 1,
346 start = cit->pos() + 1;
349 // This should not happen, but if so, we take no chances.
350 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
352 return FontSpan(pos, pos);
356 // Gets uninstantiated font setting at position 0
357 LyXFont const Paragraph::getFirstFontSettings() const
359 if (!empty() && !pimpl_->fontlist.empty())
360 return pimpl_->fontlist[0].font();
362 return LyXFont(LyXFont::ALL_INHERIT);
366 // Gets the fully instantiated font at a given position in a paragraph
367 // This is basically the same function as LyXText::GetFont() in text2.C.
368 // The difference is that this one is used for generating the LaTeX file,
369 // and thus cosmetic "improvements" are disallowed: This has to deliver
370 // the true picture of the buffer. (Asger)
371 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
372 LyXFont const & outerfont) const
374 BOOST_ASSERT(pos >= 0);
376 LyXLayout_ptr const & lout = layout();
378 pos_type const body_pos = beginOfBody();
382 layoutfont = lout->labelfont;
384 layoutfont = lout->font;
386 LyXFont font = getFontSettings(bparams, pos);
387 font.realize(layoutfont);
388 font.realize(outerfont);
389 font.realize(bparams.getLyXTextClass().defaultfont());
395 LyXFont const Paragraph::getLabelFont
396 (BufferParams const & bparams, LyXFont const & outerfont) const
398 LyXFont tmpfont = layout()->labelfont;
399 tmpfont.setLanguage(getParLanguage(bparams));
400 tmpfont.realize(outerfont);
401 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
406 LyXFont const Paragraph::getLayoutFont
407 (BufferParams const & bparams, LyXFont const & outerfont) const
409 LyXFont tmpfont = layout()->font;
410 tmpfont.setLanguage(getParLanguage(bparams));
411 tmpfont.realize(outerfont);
412 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
417 /// Returns the height of the highest font in range
418 LyXFont_size Paragraph::highestFontInRange
419 (pos_type startpos, pos_type endpos, LyXFont_size def_size) const
421 if (pimpl_->fontlist.empty())
424 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
425 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
426 for (; end_it != end; ++end_it) {
427 if (end_it->pos() >= endpos)
434 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
435 for (; cit != end; ++cit) {
436 if (cit->pos() >= startpos)
440 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
441 for (; cit != end_it; ++cit) {
442 LyXFont::FONT_SIZE size = cit->font().size();
443 if (size == LyXFont::INHERIT_SIZE)
445 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
452 Paragraph::value_type
453 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
455 value_type c = getChar(pos);
456 if (!lyxrc.rtl_support)
486 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
493 void Paragraph::setFont(pos_type pos, LyXFont const & font)
495 BOOST_ASSERT(pos <= size());
497 // First, reduce font against layout/label font
498 // Update: The setCharFont() routine in text2.C already
499 // reduces font, so we don't need to do that here. (Asger)
500 // No need to simplify this because it will disappear
501 // in a new kernel. (Asger)
502 // Next search font table
504 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
505 Pimpl::FontList::iterator it = beg;
506 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
507 for (; it != endit; ++it) {
508 if (it->pos() >= pos)
511 size_t const i = distance(beg, it);
512 bool notfound = (it == endit);
514 if (!notfound && pimpl_->fontlist[i].font() == font)
517 bool begin = pos == 0 || notfound ||
518 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
519 // Is position pos is a beginning of a font block?
520 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
521 // Is position pos is the end of a font block?
522 if (begin && end) { // A single char block
523 if (i + 1 < pimpl_->fontlist.size() &&
524 pimpl_->fontlist[i + 1].font() == font) {
525 // Merge the singleton block with the next block
526 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
527 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
528 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
529 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
530 // Merge the singleton block with the previous block
531 pimpl_->fontlist[i - 1].pos(pos);
532 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
534 pimpl_->fontlist[i].font(font);
536 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
537 pimpl_->fontlist[i - 1].pos(pos);
539 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
540 Pimpl::FontTable(pos, font));
542 pimpl_->fontlist[i].pos(pos - 1);
543 if (!(i + 1 < pimpl_->fontlist.size() &&
544 pimpl_->fontlist[i + 1].font() == font))
545 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
546 Pimpl::FontTable(pos, font));
547 } else { // The general case. The block is splitted into 3 blocks
548 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
549 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
550 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
551 Pimpl::FontTable(pos, font));
556 void Paragraph::makeSameLayout(Paragraph const & par)
558 layout(par.layout());
560 params() = par.params();
564 int Paragraph::stripLeadingSpaces()
570 while (!empty() && (isNewline(0) || isLineSeparator(0))) {
571 // Set Change::Type to Change::INSERTED to quietly remove it
572 setChange(0, Change::INSERTED);
581 bool Paragraph::hasSameLayout(Paragraph const & par) const
583 return par.layout() == layout() && params().sameLayout(par.params());
587 Paragraph::depth_type Paragraph::getDepth() const
589 return params().depth();
593 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
595 if (layout()->isEnvironment())
596 return params().depth() + 1;
598 return params().depth();
602 char Paragraph::getAlign() const
604 return params().align();
608 string const & Paragraph::getLabelstring() const
610 return params().labelString();
614 // the next two functions are for the manual labels
615 string const Paragraph::getLabelWidthString() const
617 if (!params().labelWidthString().empty())
618 return params().labelWidthString();
620 return _("Senseless with this layout!");
624 void Paragraph::setLabelWidthString(string const & s)
626 params().labelWidthString(s);
630 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
633 params().labelWidthString(string());
634 params().align(LYX_ALIGN_LAYOUT);
635 params().spacing(Spacing(Spacing::Default));
639 pos_type Paragraph::beginOfBody() const
641 return begin_of_body_;
645 void Paragraph::setBeginOfBody()
647 if (layout()->labeltype != LABEL_MANUAL) {
652 // Unroll the first two cycles of the loop
653 // and remember the previous character to
654 // remove unnecessary getChar() calls
656 pos_type end = size();
657 if (i < end && !isNewline(i)) {
659 char previous_char = 0;
662 previous_char = text_[i];
665 while (i < end && previous_char != ' ') {
670 previous_char = temp;
680 // returns -1 if inset not found
681 int Paragraph::getPositionOfInset(InsetBase const * inset) const
684 InsetList::const_iterator it = insetlist.begin();
685 InsetList::const_iterator end = insetlist.end();
686 for (; it != end; ++it)
687 if (it->inset == inset)
693 InsetBibitem * Paragraph::bibitem() const
695 if (!insetlist.empty()) {
696 InsetBase * inset = insetlist.begin()->inset;
697 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
698 return static_cast<InsetBibitem *>(inset);
704 bool Paragraph::forceDefaultParagraphs() const
706 return inInset() && inInset()->forceDefaultParagraphs(0);
712 // paragraphs inside floats need different alignment tags to avoid
715 bool noTrivlistCentering(InsetBase::Code code)
717 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
721 string correction(string const & orig)
723 if (orig == "flushleft")
724 return "raggedright";
725 if (orig == "flushright")
727 if (orig == "center")
733 string const corrected_env(string const & suffix, string const & env,
734 InsetBase::Code code)
736 string output = suffix + "{";
737 if (noTrivlistCentering(code))
738 output += correction(env);
747 // This could go to ParagraphParameters if we want to
748 int Paragraph::startTeXParParams(BufferParams const & bparams,
749 ostream & os, bool moving_arg) const
753 if (params().noindent()) {
758 switch (params().align()) {
760 case LYX_ALIGN_BLOCK:
761 case LYX_ALIGN_LAYOUT:
762 case LYX_ALIGN_SPECIAL:
765 case LYX_ALIGN_RIGHT:
766 case LYX_ALIGN_CENTER:
774 switch (params().align()) {
776 case LYX_ALIGN_BLOCK:
777 case LYX_ALIGN_LAYOUT:
778 case LYX_ALIGN_SPECIAL:
780 case LYX_ALIGN_LEFT: {
782 if (getParLanguage(bparams)->babel() != "hebrew")
783 output = corrected_env("\\begin", "flushleft", ownerCode());
785 output = corrected_env("\\begin", "flushright", ownerCode());
787 column += output.size();
789 } case LYX_ALIGN_RIGHT: {
791 if (getParLanguage(bparams)->babel() != "hebrew")
792 output = corrected_env("\\begin", "flushright", ownerCode());
794 output = corrected_env("\\begin", "flushleft", ownerCode());
796 column += output.size();
798 } case LYX_ALIGN_CENTER: {
800 output = corrected_env("\\begin", "center", ownerCode());
802 column += output.size();
811 // This could go to ParagraphParameters if we want to
812 int Paragraph::endTeXParParams(BufferParams const & bparams,
813 ostream & os, bool moving_arg) const
817 switch (params().align()) {
819 case LYX_ALIGN_BLOCK:
820 case LYX_ALIGN_LAYOUT:
821 case LYX_ALIGN_SPECIAL:
824 case LYX_ALIGN_RIGHT:
825 case LYX_ALIGN_CENTER:
833 switch (params().align()) {
835 case LYX_ALIGN_BLOCK:
836 case LYX_ALIGN_LAYOUT:
837 case LYX_ALIGN_SPECIAL:
839 case LYX_ALIGN_LEFT: {
841 if (getParLanguage(bparams)->babel() != "hebrew")
842 output = corrected_env("\\par\\end", "flushleft", ownerCode());
844 output = corrected_env("\\par\\end", "flushright", ownerCode());
846 column += output.size();
848 } case LYX_ALIGN_RIGHT: {
850 if (getParLanguage(bparams)->babel() != "hebrew")
851 output = corrected_env("\\par\\end", "flushright", ownerCode());
853 output = corrected_env("\\par\\end", "flushleft", ownerCode());
855 column += output.size();
857 } case LYX_ALIGN_CENTER: {
859 output = corrected_env("\\par\\end", "center", ownerCode());
861 column += output.size();
870 // This one spits out the text of the paragraph
871 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
872 BufferParams const & bparams,
873 LyXFont const & outerfont,
874 ostream & os, TexRow & texrow,
875 OutputParams const & runparams) const
877 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
879 bool return_value = false;
883 // well we have to check if we are in an inset with unlimited
884 // length (all in one row) if that is true then we don't allow
885 // any special options in the paragraph and also we don't allow
886 // any environment other then "Standard" to be valid!
887 bool asdefault = forceDefaultParagraphs();
890 style = bparams.getLyXTextClass().defaultLayout();
897 LaTeXFeatures features(buf, bparams, runparams.nice);
899 // output change tracking marks only if desired,
900 // if dvipost is installed,
901 // and with dvi/ps (other formats don't work)
902 bool const output = bparams.output_changes
903 && runparams.flavor == OutputParams::LATEX
904 && features.isAvailable("dvipost");
906 // Maybe we have to create a optional argument.
907 pos_type body_pos = beginOfBody();
908 unsigned int column = 0;
911 // the optional argument is kept in curly brackets in
912 // case it contains a ']'
915 basefont = getLabelFont(bparams, outerfont);
917 basefont = getLayoutFont(bparams, outerfont);
920 // Which font is currently active?
921 LyXFont running_font(basefont);
922 // Do we have an open font change?
923 bool open_font = false;
925 Change::Type running_change = Change::UNCHANGED;
927 texrow.start(id(), 0);
929 // if the paragraph is empty, the loop will not be entered at all
931 if (style->isCommand()) {
936 column += startTeXParParams(bparams, os,
937 runparams.moving_arg);
940 for (pos_type i = 0; i < size(); ++i) {
942 // First char in paragraph or after label?
946 column += running_font.latexWriteEndChanges(os, basefont, basefont);
949 basefont = getLayoutFont(bparams, outerfont);
950 running_font = basefont;
954 if (style->isCommand()) {
960 column += startTeXParParams(bparams, os,
961 runparams.moving_arg);
964 value_type c = getChar(i);
966 // Fully instantiated font
967 LyXFont font = getFont(bparams, i, outerfont);
969 LyXFont const last_font = running_font;
971 // Spaces at end of font change are simulated to be
972 // outside font change, i.e. we write "\textXX{text} "
973 // rather than "\textXX{text }". (Asger)
974 if (open_font && c == ' ' && i <= size() - 2) {
975 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
976 if (next_font != running_font && next_font != font) {
981 // We end font definition before blanks
983 (font != running_font ||
984 font.language() != running_font.language()))
986 column += running_font.latexWriteEndChanges(os,
988 (i == body_pos-1) ? basefont : font);
989 running_font = basefont;
993 // Blanks are printed before start of fontswitch
995 // Do not print the separation of the optional argument
996 if (i != body_pos - 1) {
997 pimpl_->simpleTeXBlanks(os, texrow, i,
998 column, font, *style);
1002 // Do we need to change font?
1003 if ((font != running_font ||
1004 font.language() != running_font.language()) &&
1007 column += font.latexWriteStartChanges(os, basefont,
1009 running_font = font;
1013 Change::Type change = pimpl_->lookupChange(i);
1015 column += Changes::latexMarkChange(os, running_change,
1017 running_change = change;
1019 // do not output text which is marked deleted
1020 // if change tracking output is not desired
1021 if (output || running_change != Change::DELETED) {
1022 OutputParams rp = runparams;
1023 rp.free_spacing = style->free_spacing;
1024 rp.local_font = &font;
1025 rp.intitle = style->intitle;
1026 pimpl_->simpleTeXSpecialChars(buf, bparams,
1029 basefont, outerfont, open_font,
1031 *style, i, column, c);
1035 column += Changes::latexMarkChange(os,
1036 running_change, Change::UNCHANGED, output);
1038 // If we have an open font definition, we have to close it
1040 #ifdef FIXED_LANGUAGE_END_DETECTION
1043 .latexWriteEndChanges(os, basefont,
1044 next_->getFont(bparams,
1047 running_font.latexWriteEndChanges(os, basefont,
1051 #ifdef WITH_WARNINGS
1052 //#warning For now we ALWAYS have to close the foreign font settings if they are
1053 //#warning there as we start another \selectlanguage with the next paragraph if
1054 //#warning we are in need of this. This should be fixed sometime (Jug)
1056 running_font.latexWriteEndChanges(os, basefont, basefont);
1060 // Needed if there is an optional argument but no contents.
1061 if (body_pos > 0 && body_pos == size()) {
1063 return_value = false;
1067 column += endTeXParParams(bparams, os, runparams.moving_arg);
1070 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1071 return return_value;
1077 // checks, if newcol chars should be put into this line
1078 // writes newline, if necessary.
1079 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1080 string::size_type newcol)
1083 if (colcount > lyxrc.ascii_linelen) {
1085 colcount = newcol; // assume write after this call
1100 string tag_name(PAR_TAG const & pt) {
1102 case PAR_NONE: return "!-- --";
1103 case TT: return "tt";
1104 case SF: return "sf";
1105 case BF: return "bf";
1106 case IT: return "it";
1107 case SL: return "sl";
1108 case EM: return "em";
1115 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1117 p1 = static_cast<PAR_TAG>(p1 | p2);
1122 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1124 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1130 // Handle internal paragraph parsing -- layout already processed.
1131 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1133 LyXFont const & outerfont,
1134 OutputParams const & runparams,
1135 lyx::depth_type /*depth*/) const
1137 LyXLayout_ptr const & style = layout();
1139 string::size_type char_line_count = 5; // Heuristic choice ;-)
1141 // gets paragraph main font
1144 if (style->labeltype == LABEL_MANUAL) {
1145 font_old = style->labelfont;
1148 font_old = style->font;
1152 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1153 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1154 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
1157 stack<PAR_TAG> tag_state;
1158 // parsing main loop
1159 for (pos_type i = 0; i < size(); ++i) {
1161 PAR_TAG tag_close = PAR_NONE;
1162 list < PAR_TAG > tag_open;
1164 LyXFont const font = getFont(buf.params(), i, outerfont);
1166 if (font_old.family() != font.family()) {
1167 switch (family_type) {
1168 case LyXFont::SANS_FAMILY:
1171 case LyXFont::TYPEWRITER_FAMILY:
1178 family_type = font.family();
1180 switch (family_type) {
1181 case LyXFont::SANS_FAMILY:
1182 tag_open.push_back(SF);
1184 case LyXFont::TYPEWRITER_FAMILY:
1185 tag_open.push_back(TT);
1192 if (font_old.series() != font.series()) {
1193 switch (series_type) {
1194 case LyXFont::BOLD_SERIES:
1201 series_type = font.series();
1203 switch (series_type) {
1204 case LyXFont::BOLD_SERIES:
1205 tag_open.push_back(BF);
1213 if (font_old.shape() != font.shape()) {
1214 switch (shape_type) {
1215 case LyXFont::ITALIC_SHAPE:
1218 case LyXFont::SLANTED_SHAPE:
1225 shape_type = font.shape();
1227 switch (shape_type) {
1228 case LyXFont::ITALIC_SHAPE:
1229 tag_open.push_back(IT);
1231 case LyXFont::SLANTED_SHAPE:
1232 tag_open.push_back(SL);
1239 if (font_old.emph() != font.emph()) {
1240 if (font.emph() == LyXFont::ON) {
1241 tag_open.push_back(EM);
1250 list < PAR_TAG > temp;
1251 while (!tag_state.empty() && tag_close) {
1252 PAR_TAG k = tag_state.top();
1254 os << "</" << tag_name(k) << '>';
1261 for(list< PAR_TAG >::const_iterator j = temp.begin();
1262 j != temp.end(); ++j) {
1264 os << '<' << tag_name(*j) << '>';
1267 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1268 j != tag_open.end(); ++j) {
1270 os << '<' << tag_name(*j) << '>';
1273 value_type c = getChar(i);
1276 if (c == Paragraph::META_INSET) {
1277 getInset(i)->linuxdoc(buf, os, runparams);
1282 if (style->latexparam() == "CDATA") {
1283 // "TeX"-Mode on == > SGML-Mode on.
1290 boost::tie(ws, str) = sgml::escapeChar(c);
1291 if (ws && !isFreeSpacing()) {
1292 // in freespacing mode, spaces are
1293 // non-breaking characters
1294 if (desc_on) { // if char is ' ' then...
1296 sgmlLineBreak(os, char_line_count, 6);
1300 sgmlLineBreak(os, char_line_count, 1);
1305 char_line_count += str.length();
1311 while (!tag_state.empty()) {
1312 os << "</" << tag_name(tag_state.top()) << '>';
1316 // resets description flag correctly
1318 // <tag> not closed...
1319 sgmlLineBreak(os, char_line_count, 6);
1325 bool Paragraph::emptyTag() const
1327 for (pos_type i = 0; i < size(); ++i) {
1329 InsetBase const * inset = getInset(i);
1330 InsetBase::Code lyx_code = inset->lyxCode();
1331 if (lyx_code != InsetBase::TOC_CODE &&
1332 lyx_code != InsetBase::INCLUDE_CODE &&
1333 lyx_code != InsetBase::GRAPHICS_CODE &&
1334 lyx_code != InsetBase::ERT_CODE &&
1335 lyx_code != InsetBase::FLOAT_CODE &&
1336 lyx_code != InsetBase::TABULAR_CODE) {
1340 value_type c = getChar(i);
1341 if (c != ' ' && c != '\t')
1349 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
1351 for (pos_type i = 0; i < size(); ++i) {
1353 InsetBase const * inset = getInset(i);
1354 InsetBase::Code lyx_code = inset->lyxCode();
1355 if (lyx_code == InsetBase::LABEL_CODE) {
1356 string const id = static_cast<InsetCommand const *>(inset)->getContents();
1357 return "id=\"" + sgml::cleanID(buf, runparams, id) + "\"";
1366 pos_type Paragraph::getFirstWord(Buffer const & buf, ostream & os, OutputParams const & runparams) const
1369 for (i = 0; i < size(); ++i) {
1371 InsetBase const * inset = getInset(i);
1372 inset->docbook(buf, os, runparams);
1374 value_type c = getChar(i);
1379 boost::tie(ws, str) = sgml::escapeChar(c);
1388 bool Paragraph::onlyText(Buffer const & buf, LyXFont const & outerfont, pos_type initial) const
1392 for (pos_type i = initial; i < size(); ++i) {
1393 LyXFont font = getFont(buf.params(), i, outerfont);
1396 if (i != initial && font != font_old)
1405 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1407 OutputParams const & runparams,
1408 LyXFont const & outerfont,
1409 pos_type initial) const
1411 bool emph_flag = false;
1413 LyXLayout_ptr const & style = layout();
1415 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1417 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1420 // parsing main loop
1421 for (pos_type i = initial; i < size(); ++i) {
1422 LyXFont font = getFont(buf.params(), i, outerfont);
1424 // handle <emphasis> tag
1425 if (font_old.emph() != font.emph()) {
1426 if (font.emph() == LyXFont::ON) {
1429 } else if (i != initial) {
1430 os << "</emphasis>";
1436 InsetBase const * inset = getInset(i);
1437 inset->docbook(buf, os, runparams);
1439 value_type c = getChar(i);
1442 boost::tie(ws, str) = sgml::escapeChar(c);
1444 if (style->pass_thru)
1453 os << "</emphasis>";
1456 if (style->free_spacing)
1458 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1463 bool Paragraph::isNewline(pos_type pos) const
1466 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1470 bool Paragraph::isLineSeparator(pos_type pos) const
1472 value_type const c = getChar(pos);
1473 return IsLineSeparatorChar(c)
1474 || (c == Paragraph::META_INSET && getInset(pos) &&
1475 getInset(pos)->isLineSeparator());
1479 /// Used by the spellchecker
1480 bool Paragraph::isLetter(pos_type pos) const
1483 return getInset(pos)->isLetter();
1485 value_type const c = getChar(pos);
1486 return IsLetterChar(c) || IsDigit(c);
1492 Paragraph::getParLanguage(BufferParams const & bparams) const
1495 return getFirstFontSettings().language();
1496 #ifdef WITH_WARNINGS
1497 #warning FIXME we should check the prev par as well (Lgb)
1499 return bparams.language;
1503 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1505 return lyxrc.rtl_support
1506 && getParLanguage(bparams)->RightToLeft()
1507 && ownerCode() != InsetBase::ERT_CODE;
1511 void Paragraph::changeLanguage(BufferParams const & bparams,
1512 Language const * from, Language const * to)
1514 for (pos_type i = 0; i < size(); ++i) {
1515 LyXFont font = getFontSettings(bparams, i);
1516 if (font.language() == from) {
1517 font.setLanguage(to);
1524 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1526 Language const * doc_language = bparams.language;
1527 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1528 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1530 for (; cit != end; ++cit)
1531 if (cit->font().language() != ignore_language &&
1532 cit->font().language() != latex_language &&
1533 cit->font().language() != doc_language)
1539 // Convert the paragraph to a string.
1540 // Used for building the table of contents
1541 string const Paragraph::asString(Buffer const & buffer, bool label) const
1543 OutputParams runparams;
1544 return asString(buffer, runparams, label);
1548 string const Paragraph::asString(Buffer const & buffer,
1549 OutputParams const & runparams,
1554 if (label && !params().labelString().empty())
1555 s += params().labelString() + ' ';
1557 for (pos_type i = 0; i < size(); ++i) {
1558 value_type c = getChar(i);
1561 else if (c == META_INSET &&
1562 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1564 getInset(i)->plaintext(buffer, os, runparams);
1565 s += subst(STRCONV(os.str()),'\n',' ');
1571 // This should really be done by the caller and not here.
1572 string ret = asString(buffer, runparams, 0, size(), label);
1573 return subst(ret, '\n', ' ');
1578 string const Paragraph::asString(Buffer const & buffer,
1579 pos_type beg, pos_type end, bool label) const
1582 OutputParams const runparams;
1583 return asString(buffer, runparams, beg, end, label);
1587 string const Paragraph::asString(Buffer const & buffer,
1588 OutputParams const & runparams,
1589 pos_type beg, pos_type end, bool label) const
1593 if (beg == 0 && label && !params().labelString().empty())
1594 os << params().labelString() << ' ';
1596 for (pos_type i = beg; i < end; ++i) {
1597 value_type const c = getUChar(buffer.params(), i);
1600 else if (c == META_INSET)
1601 getInset(i)->plaintext(buffer, os, runparams);
1608 void Paragraph::setInsetOwner(InsetBase * inset)
1610 pimpl_->inset_owner = inset;
1614 void Paragraph::setContentsFromPar(Paragraph const & par)
1616 pimpl_->setContentsFromPar(par);
1620 void Paragraph::trackChanges(Change::Type type)
1622 pimpl_->trackChanges(type);
1626 void Paragraph::untrackChanges()
1628 pimpl_->untrackChanges();
1632 void Paragraph::cleanChanges()
1634 pimpl_->cleanChanges();
1638 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1640 BOOST_ASSERT(empty() || pos < size());
1641 return pimpl_->lookupChange(pos);
1645 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1647 BOOST_ASSERT(empty() || pos < size());
1648 return pimpl_->lookupChangeFull(pos);
1652 bool Paragraph::isChanged(pos_type start, pos_type end) const
1654 return pimpl_->isChanged(start, end);
1658 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1660 return pimpl_->isChangeEdited(start, end);
1664 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1666 pimpl_->setChange(pos, type);
1670 void Paragraph::markErased(bool erased)
1672 pimpl_->markErased(erased);
1676 void Paragraph::acceptChange(pos_type start, pos_type end)
1678 return pimpl_->acceptChange(start, end);
1682 void Paragraph::rejectChange(pos_type start, pos_type end)
1684 return pimpl_->rejectChange(start, end);
1688 int Paragraph::id() const
1694 LyXLayout_ptr const & Paragraph::layout() const
1700 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1702 layout_ = new_layout;
1706 InsetBase * Paragraph::inInset() const
1708 return pimpl_->inset_owner;
1712 InsetBase::Code Paragraph::ownerCode() const
1714 return pimpl_->inset_owner
1715 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1719 void Paragraph::clearContents()
1725 void Paragraph::setChar(pos_type pos, value_type c)
1731 ParagraphParameters & Paragraph::params()
1733 return pimpl_->params;
1737 ParagraphParameters const & Paragraph::params() const
1739 return pimpl_->params;
1743 bool Paragraph::isFreeSpacing() const
1745 if (layout()->free_spacing)
1748 // for now we just need this, later should we need this in some
1749 // other way we can always add a function to InsetBase too.
1750 return ownerCode() == InsetBase::ERT_CODE;
1754 bool Paragraph::allowEmpty() const
1756 if (layout()->keepempty)
1758 return ownerCode() == InsetBase::ERT_CODE;
1762 Row & Paragraph::getRow(pos_type pos, bool boundary)
1764 BOOST_ASSERT(!rows().empty());
1766 // If boundary is set we should return the row on which
1767 // the character before is inside.
1768 if (pos > 0 && boundary)
1771 RowList::iterator rit = rows_.end();
1772 RowList::iterator const begin = rows_.begin();
1774 for (--rit; rit != begin && rit->pos() > pos; --rit)
1781 Row const & Paragraph::getRow(pos_type pos, bool boundary) const
1783 BOOST_ASSERT(!rows().empty());
1785 // If boundary is set we should return the row on which
1786 // the character before is inside.
1787 if (pos > 0 && boundary)
1790 RowList::const_iterator rit = rows_.end();
1791 RowList::const_iterator const begin = rows_.begin();
1793 for (--rit; rit != begin && rit->pos() > pos; --rit)
1800 size_t Paragraph::pos2row(pos_type pos) const
1802 BOOST_ASSERT(!rows().empty());
1804 RowList::const_iterator rit = rows_.end();
1805 RowList::const_iterator const begin = rows_.begin();
1807 for (--rit; rit != begin && rit->pos() > pos; --rit)
1814 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1816 if (!Encodings::is_arabic(c))
1817 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1818 return c + (0xb0 - '0');
1822 unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1823 unsigned char next_char = ' ';
1825 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1826 unsigned char const par_char = getChar(i);
1827 if (!Encodings::IsComposeChar_arabic(par_char)) {
1828 next_char = par_char;
1833 if (Encodings::is_arabic(next_char)) {
1834 if (Encodings::is_arabic(prev_char) &&
1835 !Encodings::is_arabic_special(prev_char))
1836 return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1838 return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1840 if (Encodings::is_arabic(prev_char) &&
1841 !Encodings::is_arabic_special(prev_char))
1842 return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1844 return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);
1849 void Paragraph::dump() const
1851 lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
1852 for (size_t i = 0; i != rows_.size(); ++i) {
1853 lyxerr << " row " << i << ": ";