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"
38 #include "rowpainter.h"
44 #include "frontends/FontMetrics.h"
46 #include "insets/insetbibitem.h"
47 #include "insets/insetoptarg.h"
49 #include "support/lstrings.h"
50 #include "support/textutils.h"
51 #include "support/convert.h"
52 #include "support/unicode.h"
54 #include <boost/bind.hpp>
67 using std::ostringstream;
71 using support::contains;
72 using support::rsplit;
75 Paragraph::Paragraph()
76 : begin_of_body_(0), pimpl_(new Paragraph::Pimpl(this))
83 Paragraph::Paragraph(Paragraph const & par)
84 : itemdepth(par.itemdepth), insetlist(par.insetlist),
86 text_(par.text_), begin_of_body_(par.begin_of_body_),
87 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
89 //lyxerr << "Paragraph::Paragraph(Paragraph const&)" << endl;
90 InsetList::iterator it = insetlist.begin();
91 InsetList::iterator end = insetlist.end();
92 for (; it != end; ++it)
93 it->inset = it->inset->clone().release();
97 Paragraph & Paragraph::operator=(Paragraph const & par)
99 // needed as we will destroy the pimpl_ before copying it
101 itemdepth = par.itemdepth;
103 insetlist = par.insetlist;
104 InsetList::iterator it = insetlist.begin();
105 InsetList::iterator end = insetlist.end();
106 for (; it != end; ++it)
107 it->inset = it->inset->clone().release();
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);
158 for (pos_type i = 0; i <= size(); ++i) {
160 Change change = pimpl_->lookupChange(i);
161 Changes::lyxMarkChange(os, column, running_change, change);
162 running_change = change;
167 // Write font changes
168 LyXFont font2 = getFontSettings(bparams, i);
169 if (font2 != font1) {
170 font2.lyxWriteChanges(font1, os);
175 value_type const c = getChar(i);
179 InsetBase const * inset = getInset(i);
181 if (inset->directWrite()) {
182 // international char, let it write
183 // code directly so it's shorter in
185 inset->write(buf, os);
189 os << "\\begin_inset ";
190 inset->write(buf, os);
191 os << "\n\\end_inset\n\n";
197 os << "\n\\backslash\n";
201 if (i + 1 < size() && getChar(i + 1) == ' ') {
208 if ((column > 70 && c == ' ')
213 // this check is to amend a bug. LyX sometimes
214 // inserts '\0' this could cause problems.
216 std::vector<char> tmp = ucs4_to_utf8(c);
220 lyxerr << "ERROR (Paragraph::writeFile):"
221 " NULL char in structure." << endl;
227 os << "\n\\end_layout\n";
231 void Paragraph::validate(LaTeXFeatures & features) const
233 pimpl_->validate(features, *layout());
237 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
239 return pimpl_->eraseChar(pos, trackChanges);
243 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
245 return pimpl_->eraseChars(start, end, trackChanges);
249 void Paragraph::insert(pos_type start, docstring const & str,
250 LyXFont const & font, Change const & change)
252 for (size_t i = 0, n = str.size(); i != n ; ++i)
253 insertChar(start + i, str[i], font, change);
257 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
260 pimpl_->insertChar(pos, c, Change(trackChanges ?
261 Change::INSERTED : Change::UNCHANGED));
265 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
266 LyXFont const & font, bool trackChanges)
268 pimpl_->insertChar(pos, c, Change(trackChanges ?
269 Change::INSERTED : Change::UNCHANGED));
274 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
275 LyXFont const & font, Change const & change)
277 pimpl_->insertChar(pos, c, change);
282 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
283 Change const & change)
285 pimpl_->insertInset(pos, inset, change);
289 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
290 LyXFont const & font, Change const & change)
292 pimpl_->insertInset(pos, inset, change);
297 bool Paragraph::insetAllowed(InsetBase_code code)
299 return !pimpl_->inset_owner || pimpl_->inset_owner->insetAllowed(code);
303 // Gets uninstantiated font setting at position.
304 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
308 lyxerr << " pos: " << pos << " size: " << size() << endl;
309 BOOST_ASSERT(pos <= size());
312 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
313 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
314 for (; cit != end; ++cit)
315 if (cit->pos() >= pos)
321 if (pos == size() && !empty())
322 return getFontSettings(bparams, pos - 1);
324 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
328 FontSpan Paragraph::fontSpan(pos_type pos) const
330 BOOST_ASSERT(pos <= size());
333 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
334 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
335 for (; cit != end; ++cit) {
336 if (cit->pos() >= pos) {
337 if (pos >= beginOfBody())
338 return FontSpan(std::max(start, beginOfBody()),
341 return FontSpan(start,
342 std::min(beginOfBody() - 1,
345 start = cit->pos() + 1;
348 // This should not happen, but if so, we take no chances.
349 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
351 return FontSpan(pos, pos);
355 // Gets uninstantiated font setting at position 0
356 LyXFont const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
358 if (!empty() && !pimpl_->fontlist.empty())
359 return pimpl_->fontlist[0].font();
361 return LyXFont(LyXFont::ALL_INHERIT, bparams.language);
365 // Gets the fully instantiated font at a given position in a paragraph
366 // This is basically the same function as LyXText::GetFont() in text2.C.
367 // The difference is that this one is used for generating the LaTeX file,
368 // and thus cosmetic "improvements" are disallowed: This has to deliver
369 // the true picture of the buffer. (Asger)
370 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
371 LyXFont const & outerfont) const
373 BOOST_ASSERT(pos >= 0);
375 LyXLayout_ptr const & lout = layout();
377 pos_type const body_pos = beginOfBody();
381 layoutfont = lout->labelfont;
383 layoutfont = lout->font;
385 LyXFont font = getFontSettings(bparams, pos);
386 font.realize(layoutfont);
387 font.realize(outerfont);
388 font.realize(bparams.getFont());
394 LyXFont const Paragraph::getLabelFont
395 (BufferParams const & bparams, LyXFont const & outerfont) const
397 LyXFont tmpfont = layout()->labelfont;
398 tmpfont.setLanguage(getParLanguage(bparams));
399 tmpfont.realize(outerfont);
400 tmpfont.realize(bparams.getFont());
405 LyXFont const Paragraph::getLayoutFont
406 (BufferParams const & bparams, LyXFont const & outerfont) const
408 LyXFont tmpfont = layout()->font;
409 tmpfont.setLanguage(getParLanguage(bparams));
410 tmpfont.realize(outerfont);
411 tmpfont.realize(bparams.getFont());
416 /// Returns the height of the highest font in range
417 LyXFont_size Paragraph::highestFontInRange
418 (pos_type startpos, pos_type endpos, LyXFont_size def_size) const
420 if (pimpl_->fontlist.empty())
423 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
424 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
425 for (; end_it != end; ++end_it) {
426 if (end_it->pos() >= endpos)
433 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
434 for (; cit != end; ++cit) {
435 if (cit->pos() >= startpos)
439 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
440 for (; cit != end_it; ++cit) {
441 LyXFont::FONT_SIZE size = cit->font().size();
442 if (size == LyXFont::INHERIT_SIZE)
444 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
451 Paragraph::value_type
452 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
454 value_type c = getChar(pos);
455 if (!lyxrc.rtl_support)
485 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
492 void Paragraph::setFont(pos_type pos, LyXFont const & font)
494 BOOST_ASSERT(pos <= size());
496 // First, reduce font against layout/label font
497 // Update: The setCharFont() routine in text2.C already
498 // reduces font, so we don't need to do that here. (Asger)
499 // No need to simplify this because it will disappear
500 // in a new kernel. (Asger)
501 // Next search font table
503 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
504 Pimpl::FontList::iterator it = beg;
505 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
506 for (; it != endit; ++it) {
507 if (it->pos() >= pos)
510 size_t const i = distance(beg, it);
511 bool notfound = (it == endit);
513 if (!notfound && pimpl_->fontlist[i].font() == font)
516 bool begin = pos == 0 || notfound ||
517 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
518 // Is position pos is a beginning of a font block?
519 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
520 // Is position pos is the end of a font block?
521 if (begin && end) { // A single char block
522 if (i + 1 < pimpl_->fontlist.size() &&
523 pimpl_->fontlist[i + 1].font() == font) {
524 // Merge the singleton block with the next block
525 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
526 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
527 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
528 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
529 // Merge the singleton block with the previous block
530 pimpl_->fontlist[i - 1].pos(pos);
531 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
533 pimpl_->fontlist[i].font(font);
535 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
536 pimpl_->fontlist[i - 1].pos(pos);
538 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
539 Pimpl::FontTable(pos, font));
541 pimpl_->fontlist[i].pos(pos - 1);
542 if (!(i + 1 < pimpl_->fontlist.size() &&
543 pimpl_->fontlist[i + 1].font() == font))
544 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
545 Pimpl::FontTable(pos, font));
546 } else { // The general case. The block is splitted into 3 blocks
547 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
548 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
549 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
550 Pimpl::FontTable(pos, font));
555 void Paragraph::makeSameLayout(Paragraph const & par)
557 layout(par.layout());
559 params() = par.params();
563 int Paragraph::stripLeadingSpaces(bool trackChanges)
571 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
572 if (eraseChar(pos, trackChanges))
582 bool Paragraph::hasSameLayout(Paragraph const & par) const
584 return par.layout() == layout() && params().sameLayout(par.params());
588 depth_type Paragraph::getDepth() const
590 return params().depth();
594 depth_type Paragraph::getMaxDepthAfter() const
596 if (layout()->isEnvironment())
597 return params().depth() + 1;
599 return params().depth();
603 char Paragraph::getAlign() const
605 if (params().align() == LYX_ALIGN_LAYOUT)
606 return layout()->align;
608 return params().align();
612 docstring const & Paragraph::getLabelstring() const
614 return params().labelString();
618 // the next two functions are for the manual labels
619 docstring const Paragraph::getLabelWidthString() const
621 if (!params().labelWidthString().empty())
622 return params().labelWidthString();
624 return _("Senseless with this layout!");
628 void Paragraph::setLabelWidthString(docstring const & s)
630 params().labelWidthString(s);
634 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
637 params().labelWidthString(docstring());
638 params().align(LYX_ALIGN_LAYOUT);
639 params().spacing(Spacing(Spacing::Default));
643 pos_type Paragraph::beginOfBody() const
645 return begin_of_body_;
649 void Paragraph::setBeginOfBody()
651 if (layout()->labeltype != LABEL_MANUAL) {
656 // Unroll the first two cycles of the loop
657 // and remember the previous character to
658 // remove unnecessary getChar() calls
660 pos_type end = size();
661 if (i < end && !isNewline(i)) {
663 char_type previous_char = 0;
666 previous_char = text_[i];
669 while (i < end && previous_char != ' ') {
674 previous_char = temp;
684 // returns -1 if inset not found
685 int Paragraph::getPositionOfInset(InsetBase const * inset) const
688 InsetList::const_iterator it = insetlist.begin();
689 InsetList::const_iterator end = insetlist.end();
690 for (; it != end; ++it)
691 if (it->inset == inset)
697 InsetBibitem * Paragraph::bibitem() const
699 if (!insetlist.empty()) {
700 InsetBase * inset = insetlist.begin()->inset;
701 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
702 return static_cast<InsetBibitem *>(inset);
708 bool Paragraph::forceDefaultParagraphs() const
710 return inInset() && inInset()->forceDefaultParagraphs(0);
716 // paragraphs inside floats need different alignment tags to avoid
719 bool noTrivlistCentering(InsetBase::Code code)
721 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
725 string correction(string const & orig)
727 if (orig == "flushleft")
728 return "raggedright";
729 if (orig == "flushright")
731 if (orig == "center")
737 string const corrected_env(string const & suffix, string const & env,
738 InsetBase::Code code)
740 string output = suffix + "{";
741 if (noTrivlistCentering(code))
742 output += correction(env);
746 if (suffix == "\\begin")
752 int adjust_column_count(string const & str, int oldcol)
754 if (!contains(str, "\n"))
755 return oldcol + str.size();
758 return rsplit(str, tmp, '\n').size();
765 // This could go to ParagraphParameters if we want to
766 int Paragraph::startTeXParParams(BufferParams const & bparams,
767 odocstream & os, bool moving_arg) const
771 if (params().noindent()) {
776 switch (params().align()) {
778 case LYX_ALIGN_BLOCK:
779 case LYX_ALIGN_LAYOUT:
780 case LYX_ALIGN_SPECIAL:
783 case LYX_ALIGN_RIGHT:
784 case LYX_ALIGN_CENTER:
792 switch (params().align()) {
794 case LYX_ALIGN_BLOCK:
795 case LYX_ALIGN_LAYOUT:
796 case LYX_ALIGN_SPECIAL:
798 case LYX_ALIGN_LEFT: {
800 if (getParLanguage(bparams)->babel() != "hebrew")
801 output = corrected_env("\\begin", "flushleft", ownerCode());
803 output = corrected_env("\\begin", "flushright", ownerCode());
804 os << from_ascii(output);
805 column = adjust_column_count(output, column);
807 } case LYX_ALIGN_RIGHT: {
809 if (getParLanguage(bparams)->babel() != "hebrew")
810 output = corrected_env("\\begin", "flushright", ownerCode());
812 output = corrected_env("\\begin", "flushleft", ownerCode());
813 os << from_ascii(output);
814 column = adjust_column_count(output, column);
816 } case LYX_ALIGN_CENTER: {
818 output = corrected_env("\\begin", "center", ownerCode());
819 os << from_ascii(output);
820 column = adjust_column_count(output, column);
829 // This could go to ParagraphParameters if we want to
830 int Paragraph::endTeXParParams(BufferParams const & bparams,
831 odocstream & os, bool moving_arg) const
835 switch (params().align()) {
837 case LYX_ALIGN_BLOCK:
838 case LYX_ALIGN_LAYOUT:
839 case LYX_ALIGN_SPECIAL:
842 case LYX_ALIGN_RIGHT:
843 case LYX_ALIGN_CENTER:
851 switch (params().align()) {
853 case LYX_ALIGN_BLOCK:
854 case LYX_ALIGN_LAYOUT:
855 case LYX_ALIGN_SPECIAL:
857 case LYX_ALIGN_LEFT: {
859 if (getParLanguage(bparams)->babel() != "hebrew")
860 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
862 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
863 os << from_ascii(output);
864 column = adjust_column_count(output, column);
866 } case LYX_ALIGN_RIGHT: {
868 if (getParLanguage(bparams)->babel() != "hebrew")
869 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
871 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
872 os << from_ascii(output);
873 column = adjust_column_count(output, column);
875 } case LYX_ALIGN_CENTER: {
877 output = corrected_env("\n\\par\\end", "center", ownerCode());
878 os << from_ascii(output);
879 column = adjust_column_count(output, column);
888 // This one spits out the text of the paragraph
889 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
890 BufferParams const & bparams,
891 LyXFont const & outerfont,
892 odocstream & os, TexRow & texrow,
893 OutputParams const & runparams) const
895 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
897 bool return_value = false;
901 // well we have to check if we are in an inset with unlimited
902 // length (all in one row) if that is true then we don't allow
903 // any special options in the paragraph and also we don't allow
904 // any environment other than "Standard" to be valid!
905 bool asdefault = forceDefaultParagraphs();
908 style = bparams.getLyXTextClass().defaultLayout();
913 // Current base font for all inherited font changes, without any
914 // change caused by an individual character, except for the language:
915 // It is set to the language of the first character.
916 // As long as we are in the label, this font is the base font of the
917 // label. Before the first body character it is set to the base font
919 // This must be identical to basefont in TeXOnePar().
922 LaTeXFeatures features(buf, bparams, runparams);
924 // output change tracking marks only if desired,
925 // if dvipost is installed,
926 // and with dvi/ps (other formats don't work)
927 bool const output = bparams.outputChanges
928 && runparams.flavor == OutputParams::LATEX
929 && features.isAvailable("dvipost");
931 // Maybe we have to create a optional argument.
932 pos_type body_pos = beginOfBody();
933 unsigned int column = 0;
936 // the optional argument is kept in curly brackets in
937 // case it contains a ']'
940 basefont = getLabelFont(bparams, outerfont);
942 basefont = getLayoutFont(bparams, outerfont);
945 // Which font is currently active?
946 LyXFont running_font(basefont);
947 // Do we have an open font change?
948 bool open_font = false;
950 Change::Type runningChangeType = Change::UNCHANGED;
952 texrow.start(id(), 0);
954 // if the paragraph is empty, the loop will not be entered at all
956 if (style->isCommand()) {
961 column += startTeXParParams(bparams, os,
962 runparams.moving_arg);
965 for (pos_type i = 0; i < size(); ++i) {
967 // First char in paragraph or after label?
971 column += running_font.latexWriteEndChanges(
972 os, basefont, basefont, bparams);
975 basefont = getLayoutFont(bparams, outerfont);
976 running_font = basefont;
980 if (style->isCommand()) {
986 column += startTeXParParams(bparams, os,
987 runparams.moving_arg);
990 value_type c = getChar(i);
992 // Fully instantiated font
993 LyXFont font = getFont(bparams, i, outerfont);
995 LyXFont const last_font = running_font;
997 // Spaces at end of font change are simulated to be
998 // outside font change, i.e. we write "\textXX{text} "
999 // rather than "\textXX{text }". (Asger)
1000 if (open_font && c == ' ' && i <= size() - 2) {
1001 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
1002 if (next_font != running_font && next_font != font) {
1007 // We end font definition before blanks
1009 (font != running_font ||
1010 font.language() != running_font.language()))
1012 column += running_font.latexWriteEndChanges(
1014 (i == body_pos-1) ? basefont : font,
1016 running_font = basefont;
1020 // Blanks are printed before start of fontswitch
1022 // Do not print the separation of the optional argument
1023 if (i != body_pos - 1) {
1024 pimpl_->simpleTeXBlanks(os, texrow, i,
1025 column, font, *style);
1029 // Do we need to change font?
1030 if ((font != running_font ||
1031 font.language() != running_font.language()) &&
1034 column += font.latexWriteStartChanges(
1035 os, basefont, last_font, bparams);
1036 running_font = font;
1040 Change::Type changeType = pimpl_->lookupChange(i).type;
1042 column += Changes::latexMarkChange(os, runningChangeType,
1043 changeType, output);
1044 runningChangeType = changeType;
1046 // do not output text which is marked deleted
1047 // if change tracking output is not desired
1048 if (output || runningChangeType != Change::DELETED) {
1049 OutputParams rp = runparams;
1050 rp.free_spacing = style->free_spacing;
1051 rp.local_font = &font;
1052 rp.intitle = style->intitle;
1053 pimpl_->simpleTeXSpecialChars(buf, bparams,
1056 basefont, outerfont, open_font,
1058 *style, i, column, c);
1062 column += Changes::latexMarkChange(os,
1063 runningChangeType, Change::UNCHANGED, output);
1065 // If we have an open font definition, we have to close it
1067 #ifdef FIXED_LANGUAGE_END_DETECTION
1070 .latexWriteEndChanges(os, basefont,
1071 next_->getFont(bparams, 0, outerfont),
1074 running_font.latexWriteEndChanges(os, basefont,
1078 #ifdef WITH_WARNINGS
1079 //#warning For now we ALWAYS have to close the foreign font settings if they are
1080 //#warning there as we start another \selectlanguage with the next paragraph if
1081 //#warning we are in need of this. This should be fixed sometime (Jug)
1083 running_font.latexWriteEndChanges(os, basefont, basefont,
1088 // Needed if there is an optional argument but no contents.
1089 if (body_pos > 0 && body_pos == size()) {
1091 return_value = false;
1095 column += endTeXParParams(bparams, os, runparams.moving_arg);
1098 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1099 return return_value;
1105 // checks, if newcol chars should be put into this line
1106 // writes newline, if necessary.
1107 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1108 string::size_type newcol)
1111 if (colcount > lyxrc.ascii_linelen) {
1113 colcount = newcol; // assume write after this call
1128 string tag_name(PAR_TAG const & pt) {
1130 case PAR_NONE: return "!-- --";
1131 case TT: return "tt";
1132 case SF: return "sf";
1133 case BF: return "bf";
1134 case IT: return "it";
1135 case SL: return "sl";
1136 case EM: return "em";
1143 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1145 p1 = static_cast<PAR_TAG>(p1 | p2);
1150 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1152 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1158 bool Paragraph::emptyTag() const
1160 for (pos_type i = 0; i < size(); ++i) {
1162 InsetBase const * inset = getInset(i);
1163 InsetBase::Code lyx_code = inset->lyxCode();
1164 if (lyx_code != InsetBase::TOC_CODE &&
1165 lyx_code != InsetBase::INCLUDE_CODE &&
1166 lyx_code != InsetBase::GRAPHICS_CODE &&
1167 lyx_code != InsetBase::ERT_CODE &&
1168 lyx_code != InsetBase::FLOAT_CODE &&
1169 lyx_code != InsetBase::TABULAR_CODE) {
1173 value_type c = getChar(i);
1174 if (c != ' ' && c != '\t')
1182 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
1184 for (pos_type i = 0; i < size(); ++i) {
1186 InsetBase const * inset = getInset(i);
1187 InsetBase::Code lyx_code = inset->lyxCode();
1188 if (lyx_code == InsetBase::LABEL_CODE) {
1189 string const id = static_cast<InsetCommand const *>(inset)->getContents();
1190 return "id='" + to_utf8(sgml::cleanID(buf, runparams, from_utf8(id))) + "'";
1199 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
1202 for (i = 0; i < size(); ++i) {
1204 InsetBase const * inset = getInset(i);
1205 inset->docbook(buf, os, runparams);
1207 value_type c = getChar(i);
1210 os << sgml::escapeChar(c);
1217 bool Paragraph::onlyText(Buffer const & buf, LyXFont const & outerfont, pos_type initial) const
1221 for (pos_type i = initial; i < size(); ++i) {
1222 LyXFont font = getFont(buf.params(), i, outerfont);
1225 if (i != initial && font != font_old)
1234 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1236 OutputParams const & runparams,
1237 LyXFont const & outerfont,
1238 pos_type initial) const
1240 bool emph_flag = false;
1242 LyXLayout_ptr const & style = layout();
1244 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1246 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1249 // parsing main loop
1250 for (pos_type i = initial; i < size(); ++i) {
1251 LyXFont font = getFont(buf.params(), i, outerfont);
1253 // handle <emphasis> tag
1254 if (font_old.emph() != font.emph()) {
1255 if (font.emph() == LyXFont::ON) {
1258 } else if (i != initial) {
1259 os << "</emphasis>";
1265 InsetBase const * inset = getInset(i);
1266 inset->docbook(buf, os, runparams);
1268 value_type c = getChar(i);
1270 if (style->pass_thru)
1273 os << sgml::escapeChar(c);
1279 os << "</emphasis>";
1282 if (style->free_spacing)
1284 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1289 bool Paragraph::isNewline(pos_type pos) const
1292 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1296 bool Paragraph::isLineSeparator(pos_type pos) const
1298 value_type const c = getChar(pos);
1299 return isLineSeparatorChar(c)
1300 || (c == Paragraph::META_INSET && getInset(pos) &&
1301 getInset(pos)->isLineSeparator());
1305 /// Used by the spellchecker
1306 bool Paragraph::isLetter(pos_type pos) const
1309 return getInset(pos)->isLetter();
1311 value_type const c = getChar(pos);
1312 return isLetterChar(c) || isDigit(c);
1318 Paragraph::getParLanguage(BufferParams const & bparams) const
1321 return getFirstFontSettings(bparams).language();
1322 #ifdef WITH_WARNINGS
1323 #warning FIXME we should check the prev par as well (Lgb)
1325 return bparams.language;
1329 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1331 return lyxrc.rtl_support
1332 && getParLanguage(bparams)->rightToLeft()
1333 && ownerCode() != InsetBase::ERT_CODE;
1337 void Paragraph::changeLanguage(BufferParams const & bparams,
1338 Language const * from, Language const * to)
1340 // change language including dummy font change at the end
1341 for (pos_type i = 0; i <= size(); ++i) {
1342 LyXFont font = getFontSettings(bparams, i);
1343 if (font.language() == from) {
1344 font.setLanguage(to);
1351 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1353 Language const * doc_language = bparams.language;
1354 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1355 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1357 for (; cit != end; ++cit)
1358 if (cit->font().language() != ignore_language &&
1359 cit->font().language() != latex_language &&
1360 cit->font().language() != doc_language)
1366 // Convert the paragraph to a string.
1367 // Used for building the table of contents
1368 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
1370 OutputParams runparams;
1371 return asString(buffer, runparams, label);
1375 docstring const Paragraph::asString(Buffer const & buffer,
1376 OutputParams const & runparams,
1381 if (label && !params().labelString().empty())
1382 s += params().labelString() + ' ';
1384 for (pos_type i = 0; i < size(); ++i) {
1385 value_type c = getChar(i);
1388 else if (c == META_INSET &&
1389 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1391 getInset(i)->plaintext(buffer, os, runparams);
1392 s += subst(STRCONV(os.str()),'\n',' ');
1398 // This should really be done by the caller and not here.
1399 docstring ret = asString(buffer, runparams, 0, size(), label);
1400 return subst(ret, '\n', ' ');
1405 docstring const Paragraph::asString(Buffer const & buffer,
1406 pos_type beg, pos_type end, bool label) const
1409 OutputParams const runparams;
1410 return asString(buffer, runparams, beg, end, label);
1414 docstring const Paragraph::asString(Buffer const & buffer,
1415 OutputParams const & runparams,
1416 pos_type beg, pos_type end, bool label) const
1418 lyx::odocstringstream os;
1420 if (beg == 0 && label && !params().labelString().empty())
1421 os << params().labelString() << ' ';
1423 for (pos_type i = beg; i < end; ++i) {
1424 value_type const c = getUChar(buffer.params(), i);
1427 else if (c == META_INSET)
1428 getInset(i)->textString(buffer, os, runparams);
1435 void Paragraph::setInsetOwner(InsetBase * inset)
1437 pimpl_->inset_owner = inset;
1441 Change const & Paragraph::lookupChange(pos_type pos) const
1443 BOOST_ASSERT(pos <= size());
1444 return pimpl_->lookupChange(pos);
1448 bool Paragraph::isChanged(pos_type start, pos_type end) const
1450 return pimpl_->isChanged(start, end);
1454 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
1456 return pimpl_->isMergedOnEndOfParDeletion(trackChanges);
1460 void Paragraph::setChange(Change const & change)
1462 pimpl_->setChange(change);
1466 void Paragraph::setChange(pos_type pos, Change const & change)
1468 pimpl_->setChange(pos, change);
1472 void Paragraph::acceptChanges(pos_type start, pos_type end)
1474 return pimpl_->acceptChanges(start, end);
1478 void Paragraph::rejectChanges(pos_type start, pos_type end)
1480 return pimpl_->rejectChanges(start, end);
1484 int Paragraph::id() const
1490 LyXLayout_ptr const & Paragraph::layout() const
1496 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1498 layout_ = new_layout;
1502 InsetBase * Paragraph::inInset() const
1504 return pimpl_->inset_owner;
1508 InsetBase::Code Paragraph::ownerCode() const
1510 return pimpl_->inset_owner
1511 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1515 void Paragraph::clearContents()
1521 ParagraphParameters & Paragraph::params()
1523 return pimpl_->params;
1527 ParagraphParameters const & Paragraph::params() const
1529 return pimpl_->params;
1533 bool Paragraph::isFreeSpacing() const
1535 if (layout()->free_spacing)
1538 // for now we just need this, later should we need this in some
1539 // other way we can always add a function to InsetBase too.
1540 return ownerCode() == InsetBase::ERT_CODE;
1544 bool Paragraph::allowEmpty() const
1546 if (layout()->keepempty)
1548 return ownerCode() == InsetBase::ERT_CODE;
1552 char_type Paragraph::transformChar(char_type c, pos_type pos) const
1554 if (!Encodings::is_arabic(c))
1555 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && isDigit(c))
1556 // FIXME UNICODE What does this do?
1557 return c + (0xb0 - '0');
1561 value_type const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1562 value_type next_char = ' ';
1564 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1565 value_type const par_char = getChar(i);
1566 if (!Encodings::isComposeChar_arabic(par_char)) {
1567 next_char = par_char;
1572 if (Encodings::is_arabic(next_char)) {
1573 if (Encodings::is_arabic(prev_char) &&
1574 !Encodings::is_arabic_special(prev_char))
1575 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
1577 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
1579 if (Encodings::is_arabic(prev_char) &&
1580 !Encodings::is_arabic_special(prev_char))
1581 return Encodings::transformChar(c, Encodings::FORM_FINAL);
1583 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
1588 bool Paragraph::hfillExpansion(Row const & row, pos_type pos) const
1593 BOOST_ASSERT(pos >= row.pos() && pos < row.endpos());
1595 // expand at the end of a row only if there is another hfill on the same row
1596 if (pos == row.endpos() - 1) {
1597 for (pos_type i = row.pos(); i < pos; i++) {
1604 // expand at the beginning of a row only if it is the first row of a paragraph
1605 if (pos == row.pos()) {
1609 // do not expand in some labels
1610 if (layout()->margintype != MARGIN_MANUAL && pos < beginOfBody())
1613 // if there is anything between the first char of the row and
1614 // the specified position that is neither a newline nor an hfill,
1615 // the hfill will be expanded, otherwise it won't
1616 for (pos_type i = row.pos(); i < pos; i++) {
1617 if (!isNewline(i) && !isHfill(i))
1624 bool Paragraph::checkBiblio(bool track_changes)
1626 // Add bibitem insets if necessary
1627 if (layout()->labeltype != LABEL_BIBLIO)
1630 bool hasbibitem = !insetlist.empty()
1631 // Insist on it being in pos 0
1632 && getChar(0) == Paragraph::META_INSET
1633 && insetlist.begin()->inset->lyxCode() == InsetBase::BIBITEM_CODE;
1638 InsetBibitem * inset(new InsetBibitem(InsetCommandParams("bibitem")));
1639 insertInset(0, static_cast<InsetBase *>(inset),
1640 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));