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"
47 #include "support/unicode.h"
49 #include <boost/bind.hpp>
67 using std::ostringstream;
70 Paragraph::Paragraph()
71 : begin_of_body_(0), pimpl_(new Paragraph::Pimpl(this))
78 Paragraph::Paragraph(Paragraph const & par)
79 : itemdepth(par.itemdepth), insetlist(par.insetlist),
81 rows_(par.rows_), rowSignature_(par.rowSignature_),
83 text_(par.text_), begin_of_body_(par.begin_of_body_),
84 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
86 //lyxerr << "Paragraph::Paragraph(Paragraph const&)" << endl;
87 InsetList::iterator it = insetlist.begin();
88 InsetList::iterator end = insetlist.end();
89 for (; it != end; ++it)
90 it->inset = it->inset->clone().release();
94 Paragraph & Paragraph::operator=(Paragraph const & par)
96 // needed as we will destroy the pimpl_ before copying it
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();
108 rowSignature_ = par.rowSignature_;
109 layout_ = par.layout();
111 begin_of_body_ = par.begin_of_body_;
114 pimpl_ = new Pimpl(*par.pimpl_, this);
120 Paragraph::~Paragraph()
124 //lyxerr << "Paragraph::paragraph_id = "
125 // << Paragraph::paragraph_id << endl;
129 void Paragraph::write(Buffer const & buf, ostream & os,
130 BufferParams const & bparams,
131 depth_type & dth) const
133 // The beginning or end of a deeper (i.e. nested) area?
134 if (dth != params().depth()) {
135 if (params().depth() > dth) {
136 while (params().depth() > dth) {
137 os << "\n\\begin_deeper";
141 while (params().depth() < dth) {
142 os << "\n\\end_deeper";
148 // First write the layout
149 os << "\n\\begin_layout " << layout()->name() << '\n';
153 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
155 Change running_change = Change(Change::UNCHANGED);
156 time_type const curtime = current_time();
159 for (pos_type i = 0; i <= size(); ++i) {
161 Change change = pimpl_->lookupChange(i);
162 Changes::lyxMarkChange(os, column, curtime, running_change, change);
163 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);
190 os << "\\begin_inset ";
191 inset->write(buf, os);
192 os << "\n\\end_inset\n\n";
198 os << "\n\\backslash\n";
202 if (i + 1 < size() && getChar(i + 1) == ' ') {
209 if ((column > 70 && c == ' ')
214 // this check is to amend a bug. LyX sometimes
215 // inserts '\0' this could cause problems.
217 std::vector<char> tmp = ucs4_to_utf8(c);
221 lyxerr << "ERROR (Paragraph::writeFile):"
222 " NULL char in structure." << endl;
228 os << "\n\\end_layout\n";
232 void Paragraph::validate(LaTeXFeatures & features) const
234 pimpl_->validate(features, *layout());
238 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
240 return pimpl_->eraseChar(pos, trackChanges);
244 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
246 return pimpl_->eraseChars(start, end, trackChanges);
250 void Paragraph::insert(pos_type start, docstring const & str,
251 LyXFont const & font, Change const & change)
253 for (size_t i = 0, n = str.size(); i != n ; ++i)
254 insertChar(start + i, str[i], font, change);
258 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
261 pimpl_->insertChar(pos, c, Change(trackChanges ?
262 Change::INSERTED : Change::UNCHANGED));
266 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
267 LyXFont const & font, bool trackChanges)
269 pimpl_->insertChar(pos, c, Change(trackChanges ?
270 Change::INSERTED : Change::UNCHANGED));
275 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
276 LyXFont const & font, Change const & change)
278 pimpl_->insertChar(pos, c, change);
283 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
284 Change const & change)
286 pimpl_->insertInset(pos, inset, change);
290 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
291 LyXFont const & font, Change const & 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(pos_type pos) const
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) {
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(BufferParams const & bparams) const
359 if (!empty() && !pimpl_->fontlist.empty())
360 return pimpl_->fontlist[0].font();
362 return LyXFont(LyXFont::ALL_INHERIT, bparams.language);
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.getFont());
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.getFont());
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.getFont());
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))
572 eraseChar(0, false); // no change tracking here
580 bool Paragraph::hasSameLayout(Paragraph const & par) const
582 return par.layout() == layout() && params().sameLayout(par.params());
586 depth_type Paragraph::getDepth() const
588 return params().depth();
592 depth_type Paragraph::getMaxDepthAfter() const
594 if (layout()->isEnvironment())
595 return params().depth() + 1;
597 return params().depth();
601 char Paragraph::getAlign() const
603 return params().align();
607 docstring const & Paragraph::getLabelstring() const
609 return params().labelString();
613 // the next two functions are for the manual labels
614 docstring const Paragraph::getLabelWidthString() const
616 if (!params().labelWidthString().empty())
617 return params().labelWidthString();
619 return _("Senseless with this layout!");
623 void Paragraph::setLabelWidthString(docstring const & s)
625 params().labelWidthString(s);
629 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
632 params().labelWidthString(docstring());
633 params().align(LYX_ALIGN_LAYOUT);
634 params().spacing(Spacing(Spacing::Default));
638 pos_type Paragraph::beginOfBody() const
640 return begin_of_body_;
644 void Paragraph::setBeginOfBody()
646 if (layout()->labeltype != LABEL_MANUAL) {
651 // Unroll the first two cycles of the loop
652 // and remember the previous character to
653 // remove unnecessary getChar() calls
655 pos_type end = size();
656 if (i < end && !isNewline(i)) {
658 char_type previous_char = 0;
661 previous_char = text_[i];
664 while (i < end && previous_char != ' ') {
669 previous_char = temp;
679 // returns -1 if inset not found
680 int Paragraph::getPositionOfInset(InsetBase const * inset) const
683 InsetList::const_iterator it = insetlist.begin();
684 InsetList::const_iterator end = insetlist.end();
685 for (; it != end; ++it)
686 if (it->inset == inset)
692 InsetBibitem * Paragraph::bibitem() const
694 if (!insetlist.empty()) {
695 InsetBase * inset = insetlist.begin()->inset;
696 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
697 return static_cast<InsetBibitem *>(inset);
703 bool Paragraph::forceDefaultParagraphs() const
705 return inInset() && inInset()->forceDefaultParagraphs(0);
711 // paragraphs inside floats need different alignment tags to avoid
714 bool noTrivlistCentering(InsetBase::Code code)
716 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
720 string correction(string const & orig)
722 if (orig == "flushleft")
723 return "raggedright";
724 if (orig == "flushright")
726 if (orig == "center")
732 string const corrected_env(string const & suffix, string const & env,
733 InsetBase::Code code)
735 string output = suffix + "{";
736 if (noTrivlistCentering(code))
737 output += correction(env);
746 // This could go to ParagraphParameters if we want to
747 int Paragraph::startTeXParParams(BufferParams const & bparams,
748 odocstream & os, bool moving_arg) const
752 if (params().noindent()) {
757 switch (params().align()) {
759 case LYX_ALIGN_BLOCK:
760 case LYX_ALIGN_LAYOUT:
761 case LYX_ALIGN_SPECIAL:
764 case LYX_ALIGN_RIGHT:
765 case LYX_ALIGN_CENTER:
773 switch (params().align()) {
775 case LYX_ALIGN_BLOCK:
776 case LYX_ALIGN_LAYOUT:
777 case LYX_ALIGN_SPECIAL:
779 case LYX_ALIGN_LEFT: {
781 if (getParLanguage(bparams)->babel() != "hebrew")
782 output = corrected_env("\\begin", "flushleft", ownerCode());
784 output = corrected_env("\\begin", "flushright", ownerCode());
785 os << from_ascii(output);
786 column += output.size();
788 } case LYX_ALIGN_RIGHT: {
790 if (getParLanguage(bparams)->babel() != "hebrew")
791 output = corrected_env("\\begin", "flushright", ownerCode());
793 output = corrected_env("\\begin", "flushleft", ownerCode());
794 os << from_ascii(output);
795 column += output.size();
797 } case LYX_ALIGN_CENTER: {
799 output = corrected_env("\\begin", "center", ownerCode());
800 os << from_ascii(output);
801 column += output.size();
810 // This could go to ParagraphParameters if we want to
811 int Paragraph::endTeXParParams(BufferParams const & bparams,
812 odocstream & os, bool moving_arg) const
816 switch (params().align()) {
818 case LYX_ALIGN_BLOCK:
819 case LYX_ALIGN_LAYOUT:
820 case LYX_ALIGN_SPECIAL:
823 case LYX_ALIGN_RIGHT:
824 case LYX_ALIGN_CENTER:
832 switch (params().align()) {
834 case LYX_ALIGN_BLOCK:
835 case LYX_ALIGN_LAYOUT:
836 case LYX_ALIGN_SPECIAL:
838 case LYX_ALIGN_LEFT: {
840 if (getParLanguage(bparams)->babel() != "hebrew")
841 output = corrected_env("\\par\\end", "flushleft", ownerCode());
843 output = corrected_env("\\par\\end", "flushright", ownerCode());
844 os << from_ascii(output);
845 column += output.size();
847 } case LYX_ALIGN_RIGHT: {
849 if (getParLanguage(bparams)->babel() != "hebrew")
850 output = corrected_env("\\par\\end", "flushright", ownerCode());
852 output = corrected_env("\\par\\end", "flushleft", ownerCode());
853 os << from_ascii(output);
854 column += output.size();
856 } case LYX_ALIGN_CENTER: {
858 output = corrected_env("\\par\\end", "center", ownerCode());
859 os << from_ascii(output);
860 column += output.size();
869 // This one spits out the text of the paragraph
870 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
871 BufferParams const & bparams,
872 LyXFont const & outerfont,
873 odocstream & os, TexRow & texrow,
874 OutputParams const & runparams) const
876 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
878 bool return_value = false;
882 // well we have to check if we are in an inset with unlimited
883 // length (all in one row) if that is true then we don't allow
884 // any special options in the paragraph and also we don't allow
885 // any environment other then "Standard" to be valid!
886 bool asdefault = forceDefaultParagraphs();
889 style = bparams.getLyXTextClass().defaultLayout();
896 LaTeXFeatures features(buf, bparams, runparams);
898 // output change tracking marks only if desired,
899 // if dvipost is installed,
900 // and with dvi/ps (other formats don't work)
901 bool const output = bparams.outputChanges
902 && runparams.flavor == OutputParams::LATEX
903 && features.isAvailable("dvipost");
905 // Maybe we have to create a optional argument.
906 pos_type body_pos = beginOfBody();
907 unsigned int column = 0;
910 // the optional argument is kept in curly brackets in
911 // case it contains a ']'
914 basefont = getLabelFont(bparams, outerfont);
916 basefont = getLayoutFont(bparams, outerfont);
919 // Which font is currently active?
920 LyXFont running_font(basefont);
921 // Do we have an open font change?
922 bool open_font = false;
924 Change::Type runningChangeType = Change::UNCHANGED;
926 texrow.start(id(), 0);
928 // if the paragraph is empty, the loop will not be entered at all
930 if (style->isCommand()) {
935 column += startTeXParParams(bparams, os,
936 runparams.moving_arg);
939 for (pos_type i = 0; i < size(); ++i) {
941 // First char in paragraph or after label?
945 column += running_font.latexWriteEndChanges(os, basefont, basefont);
948 basefont = getLayoutFont(bparams, outerfont);
949 running_font = basefont;
953 if (style->isCommand()) {
959 column += startTeXParParams(bparams, os,
960 runparams.moving_arg);
963 value_type c = getChar(i);
965 // Fully instantiated font
966 LyXFont font = getFont(bparams, i, outerfont);
968 LyXFont const last_font = running_font;
970 // Spaces at end of font change are simulated to be
971 // outside font change, i.e. we write "\textXX{text} "
972 // rather than "\textXX{text }". (Asger)
973 if (open_font && c == ' ' && i <= size() - 2) {
974 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
975 if (next_font != running_font && next_font != font) {
980 // We end font definition before blanks
982 (font != running_font ||
983 font.language() != running_font.language()))
985 column += running_font.latexWriteEndChanges(os,
987 (i == body_pos-1) ? basefont : font);
988 running_font = basefont;
992 // Blanks are printed before start of fontswitch
994 // Do not print the separation of the optional argument
995 if (i != body_pos - 1) {
996 pimpl_->simpleTeXBlanks(os, texrow, i,
997 column, font, *style);
1001 // Do we need to change font?
1002 if ((font != running_font ||
1003 font.language() != running_font.language()) &&
1006 column += font.latexWriteStartChanges(os, basefont,
1008 running_font = font;
1012 Change::Type changeType = pimpl_->lookupChange(i).type;
1014 column += Changes::latexMarkChange(os, runningChangeType,
1015 changeType, output);
1016 runningChangeType = changeType;
1018 // do not output text which is marked deleted
1019 // if change tracking output is not desired
1020 if (output || runningChangeType != Change::DELETED) {
1021 OutputParams rp = runparams;
1022 rp.free_spacing = style->free_spacing;
1023 rp.local_font = &font;
1024 rp.intitle = style->intitle;
1025 pimpl_->simpleTeXSpecialChars(buf, bparams,
1028 basefont, outerfont, open_font,
1030 *style, i, column, c);
1034 column += Changes::latexMarkChange(os,
1035 runningChangeType, Change::UNCHANGED, output);
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, runparams.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 bool Paragraph::emptyTag() const
1131 for (pos_type i = 0; i < size(); ++i) {
1133 InsetBase const * inset = getInset(i);
1134 InsetBase::Code lyx_code = inset->lyxCode();
1135 if (lyx_code != InsetBase::TOC_CODE &&
1136 lyx_code != InsetBase::INCLUDE_CODE &&
1137 lyx_code != InsetBase::GRAPHICS_CODE &&
1138 lyx_code != InsetBase::ERT_CODE &&
1139 lyx_code != InsetBase::FLOAT_CODE &&
1140 lyx_code != InsetBase::TABULAR_CODE) {
1144 value_type c = getChar(i);
1145 if (c != ' ' && c != '\t')
1153 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
1155 for (pos_type i = 0; i < size(); ++i) {
1157 InsetBase const * inset = getInset(i);
1158 InsetBase::Code lyx_code = inset->lyxCode();
1159 if (lyx_code == InsetBase::LABEL_CODE) {
1160 string const id = static_cast<InsetCommand const *>(inset)->getContents();
1161 return "id='" + to_utf8(sgml::cleanID(buf, runparams, from_utf8(id))) + "'";
1170 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
1173 for (i = 0; i < size(); ++i) {
1175 InsetBase const * inset = getInset(i);
1176 inset->docbook(buf, os, runparams);
1178 value_type c = getChar(i);
1181 os << sgml::escapeChar(c);
1188 bool Paragraph::onlyText(Buffer const & buf, LyXFont const & outerfont, pos_type initial) const
1192 for (pos_type i = initial; i < size(); ++i) {
1193 LyXFont font = getFont(buf.params(), i, outerfont);
1196 if (i != initial && font != font_old)
1205 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1207 OutputParams const & runparams,
1208 LyXFont const & outerfont,
1209 pos_type initial) const
1211 bool emph_flag = false;
1213 LyXLayout_ptr const & style = layout();
1215 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1217 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1220 // parsing main loop
1221 for (pos_type i = initial; i < size(); ++i) {
1222 LyXFont font = getFont(buf.params(), i, outerfont);
1224 // handle <emphasis> tag
1225 if (font_old.emph() != font.emph()) {
1226 if (font.emph() == LyXFont::ON) {
1229 } else if (i != initial) {
1230 os << "</emphasis>";
1236 InsetBase const * inset = getInset(i);
1237 inset->docbook(buf, os, runparams);
1239 value_type c = getChar(i);
1241 if (style->pass_thru)
1245 os << sgml::escapeChar(c);
1251 os << "</emphasis>";
1254 if (style->free_spacing)
1256 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1261 bool Paragraph::isNewline(pos_type pos) const
1264 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1268 bool Paragraph::isLineSeparator(pos_type pos) const
1270 value_type const c = getChar(pos);
1271 return isLineSeparatorChar(c)
1272 || (c == Paragraph::META_INSET && getInset(pos) &&
1273 getInset(pos)->isLineSeparator());
1277 /// Used by the spellchecker
1278 bool Paragraph::isLetter(pos_type pos) const
1281 return getInset(pos)->isLetter();
1283 value_type const c = getChar(pos);
1284 return isLetterChar(c) || isDigit(c);
1290 Paragraph::getParLanguage(BufferParams const & bparams) const
1293 return getFirstFontSettings(bparams).language();
1294 #ifdef WITH_WARNINGS
1295 #warning FIXME we should check the prev par as well (Lgb)
1297 return bparams.language;
1301 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1303 return lyxrc.rtl_support
1304 && getParLanguage(bparams)->rightToLeft()
1305 && ownerCode() != InsetBase::ERT_CODE;
1309 void Paragraph::changeLanguage(BufferParams const & bparams,
1310 Language const * from, Language const * to)
1312 for (pos_type i = 0; i < size(); ++i) {
1313 LyXFont font = getFontSettings(bparams, i);
1314 if (font.language() == from) {
1315 font.setLanguage(to);
1322 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1324 Language const * doc_language = bparams.language;
1325 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1326 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1328 for (; cit != end; ++cit)
1329 if (cit->font().language() != ignore_language &&
1330 cit->font().language() != latex_language &&
1331 cit->font().language() != doc_language)
1337 // Convert the paragraph to a string.
1338 // Used for building the table of contents
1339 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
1341 OutputParams runparams;
1342 return asString(buffer, runparams, label);
1346 docstring const Paragraph::asString(Buffer const & buffer,
1347 OutputParams const & runparams,
1352 if (label && !params().labelString().empty())
1353 s += params().labelString() + ' ';
1355 for (pos_type i = 0; i < size(); ++i) {
1356 value_type c = getChar(i);
1359 else if (c == META_INSET &&
1360 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1362 getInset(i)->plaintext(buffer, os, runparams);
1363 s += subst(STRCONV(os.str()),'\n',' ');
1369 // This should really be done by the caller and not here.
1370 docstring ret = asString(buffer, runparams, 0, size(), label);
1371 return subst(ret, '\n', ' ');
1376 docstring const Paragraph::asString(Buffer const & buffer,
1377 pos_type beg, pos_type end, bool label) const
1380 OutputParams const runparams;
1381 return asString(buffer, runparams, beg, end, label);
1385 docstring const Paragraph::asString(Buffer const & buffer,
1386 OutputParams const & runparams,
1387 pos_type beg, pos_type end, bool label) const
1389 lyx::odocstringstream os;
1391 if (beg == 0 && label && !params().labelString().empty())
1392 os << params().labelString() << ' ';
1394 for (pos_type i = beg; i < end; ++i) {
1395 value_type const c = getUChar(buffer.params(), i);
1396 // FIXME: isPrintable does not work for lyx::char_type
1399 else if (c == META_INSET)
1400 getInset(i)->textString(buffer, os, runparams);
1407 void Paragraph::setInsetOwner(InsetBase * inset)
1409 pimpl_->inset_owner = inset;
1413 void Paragraph::setContentsFromPar(Paragraph const & par)
1415 pimpl_->setContentsFromPar(par);
1419 Change const Paragraph::lookupChange(pos_type pos) const
1421 BOOST_ASSERT(pos <= size());
1422 return pimpl_->lookupChange(pos);
1426 bool Paragraph::isChanged(pos_type start, pos_type end) const
1428 return pimpl_->isChanged(start, end);
1432 void Paragraph::setChange(Change const & change)
1434 pimpl_->setChange(change);
1438 void Paragraph::setChange(pos_type pos, Change const & change)
1440 pimpl_->setChange(pos, change);
1444 void Paragraph::acceptChange(pos_type start, pos_type end)
1446 return pimpl_->acceptChange(start, end);
1450 void Paragraph::rejectChange(pos_type start, pos_type end)
1452 return pimpl_->rejectChange(start, end);
1456 int Paragraph::id() const
1462 LyXLayout_ptr const & Paragraph::layout() const
1468 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1470 layout_ = new_layout;
1474 InsetBase * Paragraph::inInset() const
1476 return pimpl_->inset_owner;
1480 InsetBase::Code Paragraph::ownerCode() const
1482 return pimpl_->inset_owner
1483 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1487 void Paragraph::clearContents()
1493 ParagraphParameters & Paragraph::params()
1495 return pimpl_->params;
1499 ParagraphParameters const & Paragraph::params() const
1501 return pimpl_->params;
1505 bool Paragraph::isFreeSpacing() const
1507 if (layout()->free_spacing)
1510 // for now we just need this, later should we need this in some
1511 // other way we can always add a function to InsetBase too.
1512 return ownerCode() == InsetBase::ERT_CODE;
1516 bool Paragraph::allowEmpty() const
1518 if (layout()->keepempty)
1520 return ownerCode() == InsetBase::ERT_CODE;
1524 Row & Paragraph::getRow(pos_type pos, bool boundary)
1526 BOOST_ASSERT(!rows().empty());
1528 // If boundary is set we should return the row on which
1529 // the character before is inside.
1530 if (pos > 0 && boundary)
1533 RowList::iterator rit = rows_.end();
1534 RowList::iterator const begin = rows_.begin();
1536 for (--rit; rit != begin && rit->pos() > pos; --rit)
1543 Row const & Paragraph::getRow(pos_type pos, bool boundary) const
1545 BOOST_ASSERT(!rows().empty());
1547 // If boundary is set we should return the row on which
1548 // the character before is inside.
1549 if (pos > 0 && boundary)
1552 RowList::const_iterator rit = rows_.end();
1553 RowList::const_iterator const begin = rows_.begin();
1555 for (--rit; rit != begin && rit->pos() > pos; --rit)
1562 size_t Paragraph::pos2row(pos_type pos) const
1564 BOOST_ASSERT(!rows().empty());
1566 RowList::const_iterator rit = rows_.end();
1567 RowList::const_iterator const begin = rows_.begin();
1569 for (--rit; rit != begin && rit->pos() > pos; --rit)
1576 char_type Paragraph::transformChar(char_type c, pos_type pos) const
1578 if (!Encodings::is_arabic(c))
1579 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && isDigit(c))
1580 return c + (0xb0 - '0');
1584 value_type const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1585 value_type next_char = ' ';
1587 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1588 value_type const par_char = getChar(i);
1589 if (!Encodings::isComposeChar_arabic(par_char)) {
1590 next_char = par_char;
1595 if (Encodings::is_arabic(next_char)) {
1596 if (Encodings::is_arabic(prev_char) &&
1597 !Encodings::is_arabic_special(prev_char))
1598 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
1600 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
1602 if (Encodings::is_arabic(prev_char) &&
1603 !Encodings::is_arabic_special(prev_char))
1604 return Encodings::transformChar(c, Encodings::FORM_FINAL);
1606 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
1611 void Paragraph::dump() const
1613 lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
1614 for (size_t i = 0; i != rows_.size(); ++i) {
1615 lyxerr << " row " << i << ": ";
1621 bool Paragraph::hfillExpansion(Row const & row, pos_type pos) const
1626 // at the end of a row it does not count
1627 // unless another hfill exists on the line
1628 if (pos >= row.endpos()) {
1629 for (pos_type i = row.pos(); i < pos && !isHfill(i); ++i)
1633 // at the beginning of a row it does not count, if it is not
1634 // the first row of a paragaph
1638 // in some labels it does not count
1639 if (layout()->margintype != MARGIN_MANUAL && pos < beginOfBody())
1642 // if there is anything between the first char of the row and
1643 // the specified position that is not a newline and not a hfill,
1644 // the hfill will count, otherwise not
1645 pos_type i = row.pos();
1646 while (i < pos && (isNewline(i) || isHfill(i)))