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>
59 using lyx::support::contains;
60 using lyx::support::rsplit;
69 using std::ostringstream;
72 Paragraph::Paragraph()
73 : begin_of_body_(0), pimpl_(new Paragraph::Pimpl(this))
80 Paragraph::Paragraph(Paragraph const & par)
81 : itemdepth(par.itemdepth), insetlist(par.insetlist),
83 rows_(par.rows_), rowSignature_(par.rowSignature_),
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 rowSignature_ = par.rowSignature_;
111 layout_ = par.layout();
113 begin_of_body_ = par.begin_of_body_;
116 pimpl_ = new Pimpl(*par.pimpl_, this);
122 Paragraph::~Paragraph()
126 //lyxerr << "Paragraph::paragraph_id = "
127 // << Paragraph::paragraph_id << endl;
131 void Paragraph::write(Buffer const & buf, ostream & os,
132 BufferParams const & bparams,
133 depth_type & dth) const
135 // The beginning or end of a deeper (i.e. nested) area?
136 if (dth != params().depth()) {
137 if (params().depth() > dth) {
138 while (params().depth() > dth) {
139 os << "\n\\begin_deeper";
143 while (params().depth() < dth) {
144 os << "\n\\end_deeper";
150 // First write the layout
151 os << "\n\\begin_layout " << layout()->name() << '\n';
155 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
157 Change running_change = Change(Change::UNCHANGED);
160 for (pos_type i = 0; i <= size(); ++i) {
162 Change change = pimpl_->lookupChange(i);
163 Changes::lyxMarkChange(os, column, running_change, change);
164 running_change = change;
169 // Write font changes
170 LyXFont font2 = getFontSettings(bparams, i);
171 if (font2 != font1) {
172 font2.lyxWriteChanges(font1, os);
177 value_type const c = getChar(i);
181 InsetBase const * inset = getInset(i);
183 if (inset->directWrite()) {
184 // international char, let it write
185 // code directly so it's shorter in
187 inset->write(buf, os);
191 os << "\\begin_inset ";
192 inset->write(buf, os);
193 os << "\n\\end_inset\n\n";
199 os << "\n\\backslash\n";
203 if (i + 1 < size() && getChar(i + 1) == ' ') {
210 if ((column > 70 && c == ' ')
215 // this check is to amend a bug. LyX sometimes
216 // inserts '\0' this could cause problems.
218 std::vector<char> tmp = ucs4_to_utf8(c);
222 lyxerr << "ERROR (Paragraph::writeFile):"
223 " NULL char in structure." << endl;
229 os << "\n\\end_layout\n";
233 void Paragraph::validate(LaTeXFeatures & features) const
235 pimpl_->validate(features, *layout());
239 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
241 return pimpl_->eraseChar(pos, trackChanges);
245 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
247 return pimpl_->eraseChars(start, end, trackChanges);
251 void Paragraph::insert(pos_type start, docstring const & str,
252 LyXFont const & font, Change const & change)
254 for (size_t i = 0, n = str.size(); i != n ; ++i)
255 insertChar(start + i, str[i], font, change);
259 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
262 pimpl_->insertChar(pos, c, Change(trackChanges ?
263 Change::INSERTED : Change::UNCHANGED));
267 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
268 LyXFont const & font, bool trackChanges)
270 pimpl_->insertChar(pos, c, Change(trackChanges ?
271 Change::INSERTED : Change::UNCHANGED));
276 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
277 LyXFont const & font, Change const & change)
279 pimpl_->insertChar(pos, c, change);
284 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
285 Change const & change)
287 pimpl_->insertInset(pos, inset, change);
291 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
292 LyXFont const & font, Change const & change)
294 pimpl_->insertInset(pos, inset, change);
299 bool Paragraph::insetAllowed(InsetBase_code code)
301 return !pimpl_->inset_owner || pimpl_->inset_owner->insetAllowed(code);
305 // Gets uninstantiated font setting at position.
306 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
310 lyxerr << " pos: " << pos << " size: " << size() << endl;
311 BOOST_ASSERT(pos <= size());
314 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
315 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
316 for (; cit != end; ++cit)
317 if (cit->pos() >= pos)
323 if (pos == size() && !empty())
324 return getFontSettings(bparams, pos - 1);
326 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
330 FontSpan Paragraph::fontSpan(pos_type pos) const
332 BOOST_ASSERT(pos <= size());
335 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
336 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
337 for (; cit != end; ++cit) {
338 if (cit->pos() >= pos) {
339 if (pos >= beginOfBody())
340 return FontSpan(std::max(start, beginOfBody()),
343 return FontSpan(start,
344 std::min(beginOfBody() - 1,
347 start = cit->pos() + 1;
350 // This should not happen, but if so, we take no chances.
351 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
353 return FontSpan(pos, pos);
357 // Gets uninstantiated font setting at position 0
358 LyXFont const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
360 if (!empty() && !pimpl_->fontlist.empty())
361 return pimpl_->fontlist[0].font();
363 return LyXFont(LyXFont::ALL_INHERIT, bparams.language);
367 // Gets the fully instantiated font at a given position in a paragraph
368 // This is basically the same function as LyXText::GetFont() in text2.C.
369 // The difference is that this one is used for generating the LaTeX file,
370 // and thus cosmetic "improvements" are disallowed: This has to deliver
371 // the true picture of the buffer. (Asger)
372 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
373 LyXFont const & outerfont) const
375 BOOST_ASSERT(pos >= 0);
377 LyXLayout_ptr const & lout = layout();
379 pos_type const body_pos = beginOfBody();
383 layoutfont = lout->labelfont;
385 layoutfont = lout->font;
387 LyXFont font = getFontSettings(bparams, pos);
388 font.realize(layoutfont);
389 font.realize(outerfont);
390 font.realize(bparams.getFont());
396 LyXFont const Paragraph::getLabelFont
397 (BufferParams const & bparams, LyXFont const & outerfont) const
399 LyXFont tmpfont = layout()->labelfont;
400 tmpfont.setLanguage(getParLanguage(bparams));
401 tmpfont.realize(outerfont);
402 tmpfont.realize(bparams.getFont());
407 LyXFont const Paragraph::getLayoutFont
408 (BufferParams const & bparams, LyXFont const & outerfont) const
410 LyXFont tmpfont = layout()->font;
411 tmpfont.setLanguage(getParLanguage(bparams));
412 tmpfont.realize(outerfont);
413 tmpfont.realize(bparams.getFont());
418 /// Returns the height of the highest font in range
419 LyXFont_size Paragraph::highestFontInRange
420 (pos_type startpos, pos_type endpos, LyXFont_size def_size) const
422 if (pimpl_->fontlist.empty())
425 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
426 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
427 for (; end_it != end; ++end_it) {
428 if (end_it->pos() >= endpos)
435 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
436 for (; cit != end; ++cit) {
437 if (cit->pos() >= startpos)
441 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
442 for (; cit != end_it; ++cit) {
443 LyXFont::FONT_SIZE size = cit->font().size();
444 if (size == LyXFont::INHERIT_SIZE)
446 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
453 Paragraph::value_type
454 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
456 value_type c = getChar(pos);
457 if (!lyxrc.rtl_support)
487 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
494 void Paragraph::setFont(pos_type pos, LyXFont const & font)
496 BOOST_ASSERT(pos <= size());
498 // First, reduce font against layout/label font
499 // Update: The setCharFont() routine in text2.C already
500 // reduces font, so we don't need to do that here. (Asger)
501 // No need to simplify this because it will disappear
502 // in a new kernel. (Asger)
503 // Next search font table
505 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
506 Pimpl::FontList::iterator it = beg;
507 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
508 for (; it != endit; ++it) {
509 if (it->pos() >= pos)
512 size_t const i = distance(beg, it);
513 bool notfound = (it == endit);
515 if (!notfound && pimpl_->fontlist[i].font() == font)
518 bool begin = pos == 0 || notfound ||
519 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
520 // Is position pos is a beginning of a font block?
521 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
522 // Is position pos is the end of a font block?
523 if (begin && end) { // A single char block
524 if (i + 1 < pimpl_->fontlist.size() &&
525 pimpl_->fontlist[i + 1].font() == font) {
526 // Merge the singleton block with the next block
527 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
528 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
529 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
530 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
531 // Merge the singleton block with the previous block
532 pimpl_->fontlist[i - 1].pos(pos);
533 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
535 pimpl_->fontlist[i].font(font);
537 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
538 pimpl_->fontlist[i - 1].pos(pos);
540 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
541 Pimpl::FontTable(pos, font));
543 pimpl_->fontlist[i].pos(pos - 1);
544 if (!(i + 1 < pimpl_->fontlist.size() &&
545 pimpl_->fontlist[i + 1].font() == font))
546 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
547 Pimpl::FontTable(pos, font));
548 } else { // The general case. The block is splitted into 3 blocks
549 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
550 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
551 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
552 Pimpl::FontTable(pos, font));
557 void Paragraph::makeSameLayout(Paragraph const & par)
559 layout(par.layout());
561 params() = par.params();
565 int Paragraph::stripLeadingSpaces()
571 while (!empty() && (isNewline(0) || isLineSeparator(0))
573 eraseChar(0, false); // no change tracking here
581 bool Paragraph::hasSameLayout(Paragraph const & par) const
583 return par.layout() == layout() && params().sameLayout(par.params());
587 depth_type Paragraph::getDepth() const
589 return params().depth();
593 depth_type Paragraph::getMaxDepthAfter() const
595 if (layout()->isEnvironment())
596 return params().depth() + 1;
598 return params().depth();
602 char Paragraph::getAlign() const
604 if (params().align() == LYX_ALIGN_LAYOUT)
605 return layout()->align;
607 return params().align();
611 docstring const & Paragraph::getLabelstring() const
613 return params().labelString();
617 // the next two functions are for the manual labels
618 docstring const Paragraph::getLabelWidthString() const
620 if (!params().labelWidthString().empty())
621 return params().labelWidthString();
623 return _("Senseless with this layout!");
627 void Paragraph::setLabelWidthString(docstring const & s)
629 params().labelWidthString(s);
633 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
636 params().labelWidthString(docstring());
637 params().align(LYX_ALIGN_LAYOUT);
638 params().spacing(Spacing(Spacing::Default));
642 pos_type Paragraph::beginOfBody() const
644 return begin_of_body_;
648 void Paragraph::setBeginOfBody()
650 if (layout()->labeltype != LABEL_MANUAL) {
655 // Unroll the first two cycles of the loop
656 // and remember the previous character to
657 // remove unnecessary getChar() calls
659 pos_type end = size();
660 if (i < end && !isNewline(i)) {
662 char_type previous_char = 0;
665 previous_char = text_[i];
668 while (i < end && previous_char != ' ') {
673 previous_char = temp;
683 // returns -1 if inset not found
684 int Paragraph::getPositionOfInset(InsetBase const * inset) const
687 InsetList::const_iterator it = insetlist.begin();
688 InsetList::const_iterator end = insetlist.end();
689 for (; it != end; ++it)
690 if (it->inset == inset)
696 InsetBibitem * Paragraph::bibitem() const
698 if (!insetlist.empty()) {
699 InsetBase * inset = insetlist.begin()->inset;
700 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
701 return static_cast<InsetBibitem *>(inset);
707 bool Paragraph::forceDefaultParagraphs() const
709 return inInset() && inInset()->forceDefaultParagraphs(0);
715 // paragraphs inside floats need different alignment tags to avoid
718 bool noTrivlistCentering(InsetBase::Code code)
720 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
724 string correction(string const & orig)
726 if (orig == "flushleft")
727 return "raggedright";
728 if (orig == "flushright")
730 if (orig == "center")
736 string const corrected_env(string const & suffix, string const & env,
737 InsetBase::Code code)
739 string output = suffix + "{";
740 if (noTrivlistCentering(code))
741 output += correction(env);
745 if (suffix == "\\begin")
751 int adjust_column_count(string const & str, int oldcol)
753 if (!contains(str, "\n"))
754 return oldcol + str.size();
757 return rsplit(str, tmp, '\n').size();
764 // This could go to ParagraphParameters if we want to
765 int Paragraph::startTeXParParams(BufferParams const & bparams,
766 odocstream & os, bool moving_arg) const
770 if (params().noindent()) {
775 switch (params().align()) {
777 case LYX_ALIGN_BLOCK:
778 case LYX_ALIGN_LAYOUT:
779 case LYX_ALIGN_SPECIAL:
782 case LYX_ALIGN_RIGHT:
783 case LYX_ALIGN_CENTER:
791 switch (params().align()) {
793 case LYX_ALIGN_BLOCK:
794 case LYX_ALIGN_LAYOUT:
795 case LYX_ALIGN_SPECIAL:
797 case LYX_ALIGN_LEFT: {
799 if (getParLanguage(bparams)->babel() != "hebrew")
800 output = corrected_env("\\begin", "flushleft", ownerCode());
802 output = corrected_env("\\begin", "flushright", ownerCode());
803 os << from_ascii(output);
804 column = adjust_column_count(output, column);
806 } case LYX_ALIGN_RIGHT: {
808 if (getParLanguage(bparams)->babel() != "hebrew")
809 output = corrected_env("\\begin", "flushright", ownerCode());
811 output = corrected_env("\\begin", "flushleft", ownerCode());
812 os << from_ascii(output);
813 column = adjust_column_count(output, column);
815 } case LYX_ALIGN_CENTER: {
817 output = corrected_env("\\begin", "center", ownerCode());
818 os << from_ascii(output);
819 column = adjust_column_count(output, column);
828 // This could go to ParagraphParameters if we want to
829 int Paragraph::endTeXParParams(BufferParams const & bparams,
830 odocstream & os, bool moving_arg) const
834 switch (params().align()) {
836 case LYX_ALIGN_BLOCK:
837 case LYX_ALIGN_LAYOUT:
838 case LYX_ALIGN_SPECIAL:
841 case LYX_ALIGN_RIGHT:
842 case LYX_ALIGN_CENTER:
850 switch (params().align()) {
852 case LYX_ALIGN_BLOCK:
853 case LYX_ALIGN_LAYOUT:
854 case LYX_ALIGN_SPECIAL:
856 case LYX_ALIGN_LEFT: {
858 if (getParLanguage(bparams)->babel() != "hebrew")
859 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
861 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
862 os << from_ascii(output);
863 column = adjust_column_count(output, column);
865 } case LYX_ALIGN_RIGHT: {
867 if (getParLanguage(bparams)->babel() != "hebrew")
868 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
870 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
871 os << from_ascii(output);
872 column = adjust_column_count(output, column);
874 } case LYX_ALIGN_CENTER: {
876 output = corrected_env("\n\\par\\end", "center", ownerCode());
877 os << from_ascii(output);
878 column = adjust_column_count(output, column);
887 // This one spits out the text of the paragraph
888 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
889 BufferParams const & bparams,
890 LyXFont const & outerfont,
891 odocstream & os, TexRow & texrow,
892 OutputParams const & runparams) const
894 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
896 bool return_value = false;
900 // well we have to check if we are in an inset with unlimited
901 // length (all in one row) if that is true then we don't allow
902 // any special options in the paragraph and also we don't allow
903 // any environment other then "Standard" to be valid!
904 bool asdefault = forceDefaultParagraphs();
907 style = bparams.getLyXTextClass().defaultLayout();
914 LaTeXFeatures features(buf, bparams, runparams);
916 // output change tracking marks only if desired,
917 // if dvipost is installed,
918 // and with dvi/ps (other formats don't work)
919 bool const output = bparams.outputChanges
920 && runparams.flavor == OutputParams::LATEX
921 && features.isAvailable("dvipost");
923 // Maybe we have to create a optional argument.
924 pos_type body_pos = beginOfBody();
925 unsigned int column = 0;
928 // the optional argument is kept in curly brackets in
929 // case it contains a ']'
932 basefont = getLabelFont(bparams, outerfont);
934 basefont = getLayoutFont(bparams, outerfont);
937 // Which font is currently active?
938 LyXFont running_font(basefont);
939 // Do we have an open font change?
940 bool open_font = false;
942 Change::Type runningChangeType = Change::UNCHANGED;
944 texrow.start(id(), 0);
946 // if the paragraph is empty, the loop will not be entered at all
948 if (style->isCommand()) {
953 column += startTeXParParams(bparams, os,
954 runparams.moving_arg);
957 for (pos_type i = 0; i < size(); ++i) {
959 // First char in paragraph or after label?
963 column += running_font.latexWriteEndChanges(os, basefont, basefont);
966 basefont = getLayoutFont(bparams, outerfont);
967 running_font = basefont;
971 if (style->isCommand()) {
977 column += startTeXParParams(bparams, os,
978 runparams.moving_arg);
981 value_type c = getChar(i);
983 // Fully instantiated font
984 LyXFont font = getFont(bparams, i, outerfont);
986 LyXFont const last_font = running_font;
988 // Spaces at end of font change are simulated to be
989 // outside font change, i.e. we write "\textXX{text} "
990 // rather than "\textXX{text }". (Asger)
991 if (open_font && c == ' ' && i <= size() - 2) {
992 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
993 if (next_font != running_font && next_font != font) {
998 // We end font definition before blanks
1000 (font != running_font ||
1001 font.language() != running_font.language()))
1003 column += running_font.latexWriteEndChanges(os,
1005 (i == body_pos-1) ? basefont : font);
1006 running_font = basefont;
1010 // Blanks are printed before start of fontswitch
1012 // Do not print the separation of the optional argument
1013 if (i != body_pos - 1) {
1014 pimpl_->simpleTeXBlanks(os, texrow, i,
1015 column, font, *style);
1019 // Do we need to change font?
1020 if ((font != running_font ||
1021 font.language() != running_font.language()) &&
1024 column += font.latexWriteStartChanges(os, basefont,
1026 running_font = font;
1030 Change::Type changeType = pimpl_->lookupChange(i).type;
1032 column += Changes::latexMarkChange(os, runningChangeType,
1033 changeType, output);
1034 runningChangeType = changeType;
1036 // do not output text which is marked deleted
1037 // if change tracking output is not desired
1038 if (output || runningChangeType != Change::DELETED) {
1039 OutputParams rp = runparams;
1040 rp.free_spacing = style->free_spacing;
1041 rp.local_font = &font;
1042 rp.intitle = style->intitle;
1043 pimpl_->simpleTeXSpecialChars(buf, bparams,
1046 basefont, outerfont, open_font,
1048 *style, i, column, c);
1052 column += Changes::latexMarkChange(os,
1053 runningChangeType, Change::UNCHANGED, output);
1055 // If we have an open font definition, we have to close it
1057 #ifdef FIXED_LANGUAGE_END_DETECTION
1060 .latexWriteEndChanges(os, basefont,
1061 next_->getFont(bparams,
1064 running_font.latexWriteEndChanges(os, basefont,
1068 #ifdef WITH_WARNINGS
1069 //#warning For now we ALWAYS have to close the foreign font settings if they are
1070 //#warning there as we start another \selectlanguage with the next paragraph if
1071 //#warning we are in need of this. This should be fixed sometime (Jug)
1073 running_font.latexWriteEndChanges(os, basefont, basefont);
1077 // Needed if there is an optional argument but no contents.
1078 if (body_pos > 0 && body_pos == size()) {
1080 return_value = false;
1084 column += endTeXParParams(bparams, os, runparams.moving_arg);
1087 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1088 return return_value;
1094 // checks, if newcol chars should be put into this line
1095 // writes newline, if necessary.
1096 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1097 string::size_type newcol)
1100 if (colcount > lyxrc.ascii_linelen) {
1102 colcount = newcol; // assume write after this call
1117 string tag_name(PAR_TAG const & pt) {
1119 case PAR_NONE: return "!-- --";
1120 case TT: return "tt";
1121 case SF: return "sf";
1122 case BF: return "bf";
1123 case IT: return "it";
1124 case SL: return "sl";
1125 case EM: return "em";
1132 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1134 p1 = static_cast<PAR_TAG>(p1 | p2);
1139 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1141 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1147 bool Paragraph::emptyTag() const
1149 for (pos_type i = 0; i < size(); ++i) {
1151 InsetBase const * inset = getInset(i);
1152 InsetBase::Code lyx_code = inset->lyxCode();
1153 if (lyx_code != InsetBase::TOC_CODE &&
1154 lyx_code != InsetBase::INCLUDE_CODE &&
1155 lyx_code != InsetBase::GRAPHICS_CODE &&
1156 lyx_code != InsetBase::ERT_CODE &&
1157 lyx_code != InsetBase::FLOAT_CODE &&
1158 lyx_code != InsetBase::TABULAR_CODE) {
1162 value_type c = getChar(i);
1163 if (c != ' ' && c != '\t')
1171 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
1173 for (pos_type i = 0; i < size(); ++i) {
1175 InsetBase const * inset = getInset(i);
1176 InsetBase::Code lyx_code = inset->lyxCode();
1177 if (lyx_code == InsetBase::LABEL_CODE) {
1178 string const id = static_cast<InsetCommand const *>(inset)->getContents();
1179 return "id='" + to_utf8(sgml::cleanID(buf, runparams, from_utf8(id))) + "'";
1188 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
1191 for (i = 0; i < size(); ++i) {
1193 InsetBase const * inset = getInset(i);
1194 inset->docbook(buf, os, runparams);
1196 value_type c = getChar(i);
1199 os << sgml::escapeChar(c);
1206 bool Paragraph::onlyText(Buffer const & buf, LyXFont const & outerfont, pos_type initial) const
1210 for (pos_type i = initial; i < size(); ++i) {
1211 LyXFont font = getFont(buf.params(), i, outerfont);
1214 if (i != initial && font != font_old)
1223 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1225 OutputParams const & runparams,
1226 LyXFont const & outerfont,
1227 pos_type initial) const
1229 bool emph_flag = false;
1231 LyXLayout_ptr const & style = layout();
1233 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1235 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1238 // parsing main loop
1239 for (pos_type i = initial; i < size(); ++i) {
1240 LyXFont font = getFont(buf.params(), i, outerfont);
1242 // handle <emphasis> tag
1243 if (font_old.emph() != font.emph()) {
1244 if (font.emph() == LyXFont::ON) {
1247 } else if (i != initial) {
1248 os << "</emphasis>";
1254 InsetBase const * inset = getInset(i);
1255 inset->docbook(buf, os, runparams);
1257 value_type c = getChar(i);
1259 if (style->pass_thru)
1262 os << sgml::escapeChar(c);
1268 os << "</emphasis>";
1271 if (style->free_spacing)
1273 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1278 bool Paragraph::isNewline(pos_type pos) const
1281 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1285 bool Paragraph::isLineSeparator(pos_type pos) const
1287 value_type const c = getChar(pos);
1288 return isLineSeparatorChar(c)
1289 || (c == Paragraph::META_INSET && getInset(pos) &&
1290 getInset(pos)->isLineSeparator());
1294 /// Used by the spellchecker
1295 bool Paragraph::isLetter(pos_type pos) const
1298 return getInset(pos)->isLetter();
1300 value_type const c = getChar(pos);
1301 return isLetterChar(c) || isDigit(c);
1307 Paragraph::getParLanguage(BufferParams const & bparams) const
1310 return getFirstFontSettings(bparams).language();
1311 #ifdef WITH_WARNINGS
1312 #warning FIXME we should check the prev par as well (Lgb)
1314 return bparams.language;
1318 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1320 return lyxrc.rtl_support
1321 && getParLanguage(bparams)->rightToLeft()
1322 && ownerCode() != InsetBase::ERT_CODE;
1326 void Paragraph::changeLanguage(BufferParams const & bparams,
1327 Language const * from, Language const * to)
1329 // change language including dummy font change at the end
1330 for (pos_type i = 0; i <= size(); ++i) {
1331 LyXFont font = getFontSettings(bparams, i);
1332 if (font.language() == from) {
1333 font.setLanguage(to);
1340 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1342 Language const * doc_language = bparams.language;
1343 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1344 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1346 for (; cit != end; ++cit)
1347 if (cit->font().language() != ignore_language &&
1348 cit->font().language() != latex_language &&
1349 cit->font().language() != doc_language)
1355 // Convert the paragraph to a string.
1356 // Used for building the table of contents
1357 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
1359 OutputParams runparams;
1360 return asString(buffer, runparams, label);
1364 docstring const Paragraph::asString(Buffer const & buffer,
1365 OutputParams const & runparams,
1370 if (label && !params().labelString().empty())
1371 s += params().labelString() + ' ';
1373 for (pos_type i = 0; i < size(); ++i) {
1374 value_type c = getChar(i);
1377 else if (c == META_INSET &&
1378 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1380 getInset(i)->plaintext(buffer, os, runparams);
1381 s += subst(STRCONV(os.str()),'\n',' ');
1387 // This should really be done by the caller and not here.
1388 docstring ret = asString(buffer, runparams, 0, size(), label);
1389 return subst(ret, '\n', ' ');
1394 docstring const Paragraph::asString(Buffer const & buffer,
1395 pos_type beg, pos_type end, bool label) const
1398 OutputParams const runparams;
1399 return asString(buffer, runparams, beg, end, label);
1403 docstring const Paragraph::asString(Buffer const & buffer,
1404 OutputParams const & runparams,
1405 pos_type beg, pos_type end, bool label) const
1407 lyx::odocstringstream os;
1409 if (beg == 0 && label && !params().labelString().empty())
1410 os << params().labelString() << ' ';
1412 for (pos_type i = beg; i < end; ++i) {
1413 value_type const c = getUChar(buffer.params(), i);
1416 else if (c == META_INSET)
1417 getInset(i)->textString(buffer, os, runparams);
1424 void Paragraph::setInsetOwner(InsetBase * inset)
1426 pimpl_->inset_owner = inset;
1430 Change const Paragraph::lookupChange(pos_type pos) const
1432 BOOST_ASSERT(pos <= size());
1433 return pimpl_->lookupChange(pos);
1437 bool Paragraph::isChanged(pos_type start, pos_type end) const
1439 return pimpl_->isChanged(start, end);
1443 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
1445 return pimpl_->isMergedOnEndOfParDeletion(trackChanges);
1449 void Paragraph::setChange(Change const & change)
1451 pimpl_->setChange(change);
1455 void Paragraph::setChange(pos_type pos, Change const & change)
1457 pimpl_->setChange(pos, change);
1461 void Paragraph::acceptChanges(pos_type start, pos_type end)
1463 return pimpl_->acceptChanges(start, end);
1467 void Paragraph::rejectChanges(pos_type start, pos_type end)
1469 return pimpl_->rejectChanges(start, end);
1473 int Paragraph::id() const
1479 LyXLayout_ptr const & Paragraph::layout() const
1485 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1487 layout_ = new_layout;
1491 InsetBase * Paragraph::inInset() const
1493 return pimpl_->inset_owner;
1497 InsetBase::Code Paragraph::ownerCode() const
1499 return pimpl_->inset_owner
1500 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1504 void Paragraph::clearContents()
1510 ParagraphParameters & Paragraph::params()
1512 return pimpl_->params;
1516 ParagraphParameters const & Paragraph::params() const
1518 return pimpl_->params;
1522 bool Paragraph::isFreeSpacing() const
1524 if (layout()->free_spacing)
1527 // for now we just need this, later should we need this in some
1528 // other way we can always add a function to InsetBase too.
1529 return ownerCode() == InsetBase::ERT_CODE;
1533 bool Paragraph::allowEmpty() const
1535 if (layout()->keepempty)
1537 return ownerCode() == InsetBase::ERT_CODE;
1541 Row & Paragraph::getRow(pos_type pos, bool boundary)
1543 BOOST_ASSERT(!rows().empty());
1545 // If boundary is set we should return the row on which
1546 // the character before is inside.
1547 if (pos > 0 && boundary)
1550 RowList::iterator rit = rows_.end();
1551 RowList::iterator const begin = rows_.begin();
1553 for (--rit; rit != begin && rit->pos() > pos; --rit)
1560 Row const & Paragraph::getRow(pos_type pos, bool boundary) const
1562 BOOST_ASSERT(!rows().empty());
1564 // If boundary is set we should return the row on which
1565 // the character before is inside.
1566 if (pos > 0 && boundary)
1569 RowList::const_iterator rit = rows_.end();
1570 RowList::const_iterator const begin = rows_.begin();
1572 for (--rit; rit != begin && rit->pos() > pos; --rit)
1579 size_t Paragraph::pos2row(pos_type pos) const
1581 BOOST_ASSERT(!rows().empty());
1583 RowList::const_iterator rit = rows_.end();
1584 RowList::const_iterator const begin = rows_.begin();
1586 for (--rit; rit != begin && rit->pos() > pos; --rit)
1593 char_type Paragraph::transformChar(char_type c, pos_type pos) const
1595 if (!Encodings::is_arabic(c))
1596 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && isDigit(c))
1597 // FIXME UNICODE What does this do?
1598 return c + (0xb0 - '0');
1602 value_type const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1603 value_type next_char = ' ';
1605 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1606 value_type const par_char = getChar(i);
1607 if (!Encodings::isComposeChar_arabic(par_char)) {
1608 next_char = par_char;
1613 if (Encodings::is_arabic(next_char)) {
1614 if (Encodings::is_arabic(prev_char) &&
1615 !Encodings::is_arabic_special(prev_char))
1616 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
1618 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
1620 if (Encodings::is_arabic(prev_char) &&
1621 !Encodings::is_arabic_special(prev_char))
1622 return Encodings::transformChar(c, Encodings::FORM_FINAL);
1624 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
1629 void Paragraph::dump() const
1631 lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
1632 for (size_t i = 0; i != rows_.size(); ++i) {
1633 lyxerr << " row " << i << ": ";
1639 bool Paragraph::hfillExpansion(Row const & row, pos_type pos) const
1644 // at the end of a row it does not count
1645 // unless another hfill exists on the line
1646 if (pos >= row.endpos()) {
1647 for (pos_type i = row.pos(); i < pos && !isHfill(i); ++i)
1651 // at the beginning of a row it does not count, if it is not
1652 // the first row of a paragaph
1656 // in some labels it does not count
1657 if (layout()->margintype != MARGIN_MANUAL && pos < beginOfBody())
1660 // if there is anything between the first char of the row and
1661 // the specified position that is not a newline and not a hfill,
1662 // the hfill will count, otherwise not
1663 pos_type i = row.pos();
1664 while (i < pos && (isNewline(i) || isHfill(i)))