3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
20 #include "paragraph.h"
21 #include "paragraph_pimpl.h"
24 #include "bufferparams.h"
33 #include "outputparams.h"
34 #include "paragraph_funcs.h"
39 #include "insets/insetbibitem.h"
40 #include "insets/insetoptarg.h"
42 #include "support/lstrings.h"
43 #include "support/std_sstream.h"
44 #include "support/textutils.h"
45 #include "support/tostr.h"
47 #include <boost/tuple/tuple.hpp>
54 using lyx::support::contains;
55 using lyx::support::subst;
62 using std::ostringstream;
65 Paragraph::Paragraph()
66 : y(0), height(0), begin_of_body_(0),
67 pimpl_(new Paragraph::Pimpl(this))
74 Paragraph::Paragraph(Paragraph const & par)
75 : y(0), height(0), text_(par.text_), begin_of_body_(par.begin_of_body_),
76 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
79 // this is because of the dummy layout of the paragraphs that
81 layout_ = par.layout();
83 // copy everything behind the break-position to the new paragraph
84 insetlist = par.insetlist;
85 InsetList::iterator it = insetlist.begin();
86 InsetList::iterator end = insetlist.end();
87 for (; it != end; ++it) {
88 // currently we hold Inset*, not InsetBase*
89 it->inset = static_cast<InsetOld*>(it->inset->clone().release());
94 void Paragraph::operator=(Paragraph const & par)
96 // needed as we will destroy the pimpl_ before copying it
100 lyxerr << "Paragraph::operator=()" << endl;
105 pimpl_ = new Pimpl(*par.pimpl_, this);
107 itemdepth = par.itemdepth;
108 // this is because of the dummy layout of the paragraphs that
110 layout_ = par.layout();
112 // copy everything behind the break-position to the new paragraph
113 insetlist = par.insetlist;
114 InsetList::iterator it = insetlist.begin();
115 InsetList::iterator end = insetlist.end();
116 for (; it != end; ++it) {
117 it->inset = static_cast<InsetOld*>(it->inset->clone().release());
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);
158 lyx::time_type const curtime(lyx::current_time());
161 for (pos_type i = 0; i < size(); ++i) {
167 Change change = pimpl_->lookupChangeFull(i);
168 Changes::lyxMarkChange(os, column, curtime, running_change, change);
169 running_change = change;
171 // Write font changes
172 LyXFont font2 = getFontSettings(bparams, i);
173 if (font2 != font1) {
174 font2.lyxWriteChanges(font1, os);
179 value_type const c = getChar(i);
183 InsetOld const * inset = getInset(i);
185 if (inset->directWrite()) {
186 // international char, let it write
187 // code directly so it's shorter in
189 inset->write(buf, os);
191 os << "\n\\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.
220 lyxerr << "ERROR (Paragraph::writeFile):"
221 " NULL char in structure." << endl;
227 // to make reading work properly
229 running_change = pimpl_->lookupChange(0);
230 Changes::lyxMarkChange(os, column, curtime,
231 Change(Change::UNCHANGED), running_change);
233 Changes::lyxMarkChange(os, column, curtime,
234 running_change, Change(Change::UNCHANGED));
236 os << "\n\\end_layout\n";
240 void Paragraph::validate(LaTeXFeatures & features) const
242 pimpl_->validate(features, *layout());
246 void Paragraph::eraseIntern(lyx::pos_type pos)
248 pimpl_->eraseIntern(pos);
252 bool Paragraph::erase(pos_type pos)
254 return pimpl_->erase(pos);
258 int Paragraph::erase(pos_type start, pos_type end)
260 return pimpl_->erase(start, end);
264 void Paragraph::insert(pos_type start, string const & str,
265 LyXFont const & font)
267 int size = str.size();
268 for (int i = 0 ; i < size ; ++i)
269 insertChar(start + i, str[i], font);
273 bool Paragraph::checkInsertChar(LyXFont & font)
275 if (pimpl_->inset_owner)
276 return pimpl_->inset_owner->checkInsertChar(font);
281 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c)
283 insertChar(pos, c, LyXFont(LyXFont::ALL_INHERIT));
287 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
288 LyXFont const & font, Change change)
290 pimpl_->insertChar(pos, c, font, change);
294 void Paragraph::insertInset(pos_type pos, InsetOld * inset)
296 insertInset(pos, inset, LyXFont(LyXFont::ALL_INHERIT));
300 void Paragraph::insertInset(pos_type pos, InsetOld * inset,
301 LyXFont const & font, Change change)
303 pimpl_->insertInset(pos, inset, font, change);
307 bool Paragraph::insetAllowed(InsetOld_code code)
309 //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
310 if (pimpl_->inset_owner)
311 return pimpl_->inset_owner->insetAllowed(code);
316 InsetOld * Paragraph::getInset(pos_type pos)
318 BOOST_ASSERT(pos < size());
319 return insetlist.get(pos);
323 InsetOld const * Paragraph::getInset(pos_type pos) const
325 BOOST_ASSERT(pos < size());
326 return insetlist.get(pos);
330 // Gets uninstantiated font setting at position.
331 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
334 BOOST_ASSERT(pos <= size());
336 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
337 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
338 for (; cit != end; ++cit)
339 if (cit->pos() >= pos)
345 if (pos == size() && !empty())
346 return getFontSettings(bparams, pos - 1);
348 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
352 lyx::pos_type Paragraph::getEndPosOfFontSpan(lyx::pos_type pos) const
354 BOOST_ASSERT(pos <= size());
356 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
357 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
358 for (; cit != end; ++cit)
359 if (cit->pos() >= pos)
362 // This should not happen, but if so, we take no chances.
363 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
369 // Gets uninstantiated font setting at position 0
370 LyXFont const Paragraph::getFirstFontSettings() const
372 if (!empty() && !pimpl_->fontlist.empty())
373 return pimpl_->fontlist[0].font();
375 return LyXFont(LyXFont::ALL_INHERIT);
379 // Gets the fully instantiated font at a given position in a paragraph
380 // This is basically the same function as LyXText::GetFont() in text2.C.
381 // The difference is that this one is used for generating the LaTeX file,
382 // and thus cosmetic "improvements" are disallowed: This has to deliver
383 // the true picture of the buffer. (Asger)
384 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
385 LyXFont const & outerfont) const
387 BOOST_ASSERT(pos >= 0);
389 LyXLayout_ptr const & lout = layout();
391 pos_type const body_pos = beginOfBody();
395 layoutfont = lout->labelfont;
397 layoutfont = lout->font;
399 LyXFont font = getFontSettings(bparams, pos);
400 font.realize(layoutfont);
401 font.realize(outerfont);
402 font.realize(bparams.getLyXTextClass().defaultfont());
408 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams,
409 LyXFont const & outerfont) const
411 LyXFont tmpfont = layout()->labelfont;
412 tmpfont.setLanguage(getParLanguage(bparams));
413 tmpfont.realize(outerfont);
414 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
419 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams,
420 LyXFont const & outerfont) const
422 LyXFont tmpfont = layout()->font;
423 tmpfont.setLanguage(getParLanguage(bparams));
424 tmpfont.realize(outerfont);
425 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
430 /// Returns the height of the highest font in range
432 Paragraph::highestFontInRange(pos_type startpos, pos_type endpos,
433 LyXFont_size def_size) const
435 if (pimpl_->fontlist.empty())
438 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
439 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
440 for (; end_it != end; ++end_it) {
441 if (end_it->pos() >= endpos)
448 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
449 for (; cit != end; ++cit) {
450 if (cit->pos() >= startpos)
454 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
455 for (; cit != end_it; ++cit) {
456 LyXFont::FONT_SIZE size = cit->font().size();
457 if (size == LyXFont::INHERIT_SIZE)
459 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
466 Paragraph::value_type
467 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
469 value_type c = getChar(pos);
470 if (!lyxrc.rtl_support)
500 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
507 void Paragraph::setFont(pos_type pos, LyXFont const & font)
509 BOOST_ASSERT(pos <= size());
511 // First, reduce font against layout/label font
512 // Update: The setCharFont() routine in text2.C already
513 // reduces font, so we don't need to do that here. (Asger)
514 // No need to simplify this because it will disappear
515 // in a new kernel. (Asger)
516 // Next search font table
518 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
519 Pimpl::FontList::iterator it = beg;
520 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
521 for (; it != endit; ++it) {
522 if (it->pos() >= pos)
525 unsigned int i = std::distance(beg, it);
526 bool notfound = (it == endit);
528 if (!notfound && pimpl_->fontlist[i].font() == font)
531 bool begin = pos == 0 || notfound ||
532 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
533 // Is position pos is a beginning of a font block?
534 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
535 // Is position pos is the end of a font block?
536 if (begin && end) { // A single char block
537 if (i + 1 < pimpl_->fontlist.size() &&
538 pimpl_->fontlist[i + 1].font() == font) {
539 // Merge the singleton block with the next block
540 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
541 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
542 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
543 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
544 // Merge the singleton block with the previous block
545 pimpl_->fontlist[i - 1].pos(pos);
546 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
548 pimpl_->fontlist[i].font(font);
550 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
551 pimpl_->fontlist[i - 1].pos(pos);
553 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
554 Pimpl::FontTable(pos, font));
556 pimpl_->fontlist[i].pos(pos - 1);
557 if (!(i + 1 < pimpl_->fontlist.size() &&
558 pimpl_->fontlist[i + 1].font() == font))
559 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
560 Pimpl::FontTable(pos, font));
561 } else { // The general case. The block is splitted into 3 blocks
562 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
563 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
564 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
565 Pimpl::FontTable(pos, font));
570 void Paragraph::makeSameLayout(Paragraph const & par)
572 layout(par.layout());
574 params() = par.params();
578 int Paragraph::stripLeadingSpaces()
584 while (!empty() && (isNewline(0) || isLineSeparator(0))) {
585 pimpl_->eraseIntern(0);
593 bool Paragraph::hasSameLayout(Paragraph const & par) const
596 par.layout() == layout() &&
597 params().sameLayout(par.params());
601 Paragraph::depth_type Paragraph::getDepth() const
603 return params().depth();
607 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
609 if (layout()->isEnvironment())
610 return params().depth() + 1;
612 return params().depth();
616 char Paragraph::getAlign() const
618 return params().align();
622 string const & Paragraph::getLabelstring() const
624 return params().labelString();
628 // the next two functions are for the manual labels
629 string const Paragraph::getLabelWidthString() const
631 if (!params().labelWidthString().empty())
632 return params().labelWidthString();
634 return _("Senseless with this layout!");
638 void Paragraph::setLabelWidthString(string const & s)
640 params().labelWidthString(s);
644 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
647 params().labelWidthString(string());
648 params().align(LYX_ALIGN_LAYOUT);
649 params().spaceTop(VSpace(VSpace::NONE));
650 params().spaceBottom(VSpace(VSpace::NONE));
651 params().spacing(Spacing(Spacing::Default));
655 int Paragraph::beginOfBody() const
657 return begin_of_body_;
661 void Paragraph::setBeginOfBody()
663 if (layout()->labeltype != LABEL_MANUAL) {
668 // Unroll the first two cycles of the loop
669 // and remember the previous character to
670 // remove unnecessary getChar() calls
672 pos_type end = size();
673 if (i < end && !isNewline(i)) {
675 char previous_char = 0;
678 previous_char = text_[i];
681 while (i < end && previous_char != ' ') {
686 previous_char = temp;
696 // returns -1 if inset not found
697 int Paragraph::getPositionOfInset(InsetOld const * inset) const
700 InsetList::const_iterator it = insetlist.begin();
701 InsetList::const_iterator end = insetlist.end();
702 for (; it != end; ++it)
703 if (it->inset == inset)
709 InsetBibitem * Paragraph::bibitem() const
711 if (!insetlist.empty()) {
712 InsetOld * inset = insetlist.begin()->inset;
713 if (inset->lyxCode() == InsetOld::BIBTEX_CODE)
714 return static_cast<InsetBibitem *>(inset);
722 /* paragraphs inside floats need different alignment tags to avoid
725 bool noTrivlistCentering(UpdatableInset const * inset)
727 if (inset && inset->owner()) {
728 InsetOld::Code const code = inset->owner()->lyxCode();
729 return code == InsetOld::FLOAT_CODE ||
730 code == InsetOld::WRAP_CODE;
736 string correction(string const & orig)
738 if (orig == "flushleft")
739 return "raggedright";
740 if (orig == "flushright")
742 if (orig == "center")
748 string const corrected_env(string const & suffix, string const & env,
749 UpdatableInset const * inset)
751 string output = suffix + "{";
752 if (noTrivlistCentering(inset))
753 output += correction(env);
762 // This could go to ParagraphParameters if we want to
763 int Paragraph::startTeXParParams(BufferParams const & bparams,
764 ostream & os, bool moving_arg) const
768 if (params().noindent()) {
773 switch (params().align()) {
775 case LYX_ALIGN_BLOCK:
776 case LYX_ALIGN_LAYOUT:
777 case LYX_ALIGN_SPECIAL:
780 case LYX_ALIGN_RIGHT:
781 case LYX_ALIGN_CENTER:
789 switch (params().align()) {
791 case LYX_ALIGN_BLOCK:
792 case LYX_ALIGN_LAYOUT:
793 case LYX_ALIGN_SPECIAL:
795 case LYX_ALIGN_LEFT: {
797 UpdatableInset const * const inset = pimpl_->inset_owner;
798 if (getParLanguage(bparams)->babel() != "hebrew")
799 output = corrected_env("\\begin", "flushleft", inset);
801 output = corrected_env("\\begin", "flushright", inset);
803 column += output.size();
805 } case LYX_ALIGN_RIGHT: {
807 UpdatableInset const * const inset = pimpl_->inset_owner;
808 if (getParLanguage(bparams)->babel() != "hebrew")
809 output = corrected_env("\\begin", "flushright", inset);
811 output = corrected_env("\\begin", "flushleft", inset);
813 column += output.size();
815 } case LYX_ALIGN_CENTER: {
817 output = corrected_env("\\begin", "center", pimpl_->inset_owner);
819 column += output.size();
828 // This could go to ParagraphParameters if we want to
829 int Paragraph::endTeXParParams(BufferParams const & bparams,
830 ostream & 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 UpdatableInset const * const inset = pimpl_->inset_owner;
859 if (getParLanguage(bparams)->babel() != "hebrew")
860 output = corrected_env("\\par\\end", "flushleft", inset);
862 output = corrected_env("\\par\\end", "flushright", inset);
864 column += output.size();
866 } case LYX_ALIGN_RIGHT: {
868 UpdatableInset const * const inset = pimpl_->inset_owner;
869 if (getParLanguage(bparams)->babel() != "hebrew")
870 output = corrected_env("\\par\\end", "flushright", inset);
872 output = corrected_env("\\par\\end", "flushleft", inset);
874 column += output.size();
876 } case LYX_ALIGN_CENTER: {
878 output = corrected_env("\\par\\end", "center", pimpl_->inset_owner);
880 column += output.size();
889 // This one spits out the text of the paragraph
890 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
891 BufferParams const & bparams,
892 LyXFont const & outerfont,
893 ostream & os, TexRow & texrow,
894 OutputParams const & runparams)
896 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
898 bool return_value = false;
902 // well we have to check if we are in an inset with unlimited
903 // length (all in one row) if that is true then we don't allow
904 // any special options in the paragraph and also we don't allow
905 // any environment other then "Standard" to be valid!
907 (inInset() && inInset()->forceDefaultParagraphs(inInset()));
910 style = bparams.getLyXTextClass().defaultLayout();
917 // Maybe we have to create a optional argument.
918 pos_type body_pos = beginOfBody();
919 unsigned int column = 0;
924 basefont = getLabelFont(bparams, outerfont);
926 basefont = getLayoutFont(bparams, outerfont);
929 bool moving_arg = runparams.moving_arg;
930 moving_arg |= style->needprotect;
932 // Which font is currently active?
933 LyXFont running_font(basefont);
934 // Do we have an open font change?
935 bool open_font = false;
937 Change::Type running_change = Change::UNCHANGED;
939 texrow.start(id(), 0);
941 // if the paragraph is empty, the loop will not be entered at all
943 if (style->isCommand()) {
948 column += startTeXParParams(bparams, os, moving_arg);
951 for (pos_type i = 0; i < size(); ++i) {
953 // First char in paragraph or after label?
957 column += running_font.latexWriteEndChanges(os, basefont, basefont);
960 basefont = getLayoutFont(bparams, outerfont);
961 running_font = basefont;
965 if (style->isCommand()) {
971 column += startTeXParParams(bparams, os,
975 value_type c = getChar(i);
977 // Fully instantiated font
978 LyXFont font = getFont(bparams, i, outerfont);
980 LyXFont const last_font = running_font;
982 // Spaces at end of font change are simulated to be
983 // outside font change, i.e. we write "\textXX{text} "
984 // rather than "\textXX{text }". (Asger)
985 if (open_font && c == ' ' && i <= size() - 2) {
986 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
987 if (next_font != running_font && next_font != font) {
992 // We end font definition before blanks
994 (font != running_font ||
995 font.language() != running_font.language()))
997 column += running_font.latexWriteEndChanges(os,
999 (i == body_pos-1) ? basefont : font);
1000 running_font = basefont;
1004 // Blanks are printed before start of fontswitch
1006 // Do not print the separation of the optional argument
1007 if (i != body_pos - 1) {
1008 pimpl_->simpleTeXBlanks(os, texrow, i,
1009 column, font, *style);
1013 // Do we need to change font?
1014 if ((font != running_font ||
1015 font.language() != running_font.language()) &&
1018 column += font.latexWriteStartChanges(os, basefont,
1020 running_font = font;
1024 Change::Type change = pimpl_->lookupChange(i);
1026 column += Changes::latexMarkChange(os, running_change, change);
1027 running_change = change;
1029 OutputParams rp = runparams;
1030 rp.moving_arg = moving_arg;
1031 rp.free_spacing = style->free_spacing;
1032 pimpl_->simpleTeXSpecialChars(buf, bparams,
1033 os, texrow, runparams,
1035 basefont, outerfont, open_font,
1037 *style, i, column, c);
1040 column += Changes::latexMarkChange(os,
1041 running_change, Change::UNCHANGED);
1043 // If we have an open font definition, we have to close it
1045 #ifdef FIXED_LANGUAGE_END_DETECTION
1048 .latexWriteEndChanges(os, basefont,
1049 next_->getFont(bparams,
1052 running_font.latexWriteEndChanges(os, basefont,
1056 #ifdef WITH_WARNINGS
1057 //#warning For now we ALWAYS have to close the foreign font settings if they are
1058 //#warning there as we start another \selectlanguage with the next paragraph if
1059 //#warning we are in need of this. This should be fixed sometime (Jug)
1061 running_font.latexWriteEndChanges(os, basefont, basefont);
1065 // Needed if there is an optional argument but no contents.
1066 if (body_pos > 0 && body_pos == size()) {
1068 return_value = false;
1072 column += endTeXParParams(bparams, os, moving_arg);
1075 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1076 return return_value;
1082 // checks, if newcol chars should be put into this line
1083 // writes newline, if necessary.
1084 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1085 string::size_type newcol)
1088 if (colcount > lyxrc.ascii_linelen) {
1090 colcount = newcol; // assume write after this call
1105 string tag_name(PAR_TAG const & pt) {
1107 case NONE: return "!-- --";
1108 case TT: return "tt";
1109 case SF: return "sf";
1110 case BF: return "bf";
1111 case IT: return "it";
1112 case SL: return "sl";
1113 case EM: return "em";
1120 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1122 p1 = static_cast<PAR_TAG>(p1 | p2);
1127 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1129 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1135 // Handle internal paragraph parsing -- layout already processed.
1136 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1138 LyXFont const & outerfont,
1139 OutputParams const & runparams,
1140 lyx::depth_type /*depth*/) const
1142 LyXLayout_ptr const & style = layout();
1144 string::size_type char_line_count = 5; // Heuristic choice ;-)
1146 // gets paragraph main font
1149 if (style->labeltype == LABEL_MANUAL) {
1150 font_old = style->labelfont;
1153 font_old = style->font;
1157 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1158 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1159 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
1162 stack<PAR_TAG> tag_state;
1163 // parsing main loop
1164 for (pos_type i = 0; i < size(); ++i) {
1166 PAR_TAG tag_close = NONE;
1167 list < PAR_TAG > tag_open;
1169 LyXFont const font = getFont(buf.params(), i, outerfont);
1171 if (font_old.family() != font.family()) {
1172 switch (family_type) {
1173 case LyXFont::SANS_FAMILY:
1176 case LyXFont::TYPEWRITER_FAMILY:
1183 family_type = font.family();
1185 switch (family_type) {
1186 case LyXFont::SANS_FAMILY:
1187 tag_open.push_back(SF);
1189 case LyXFont::TYPEWRITER_FAMILY:
1190 tag_open.push_back(TT);
1197 if (font_old.series() != font.series()) {
1198 switch (series_type) {
1199 case LyXFont::BOLD_SERIES:
1206 series_type = font.series();
1208 switch (series_type) {
1209 case LyXFont::BOLD_SERIES:
1210 tag_open.push_back(BF);
1218 if (font_old.shape() != font.shape()) {
1219 switch (shape_type) {
1220 case LyXFont::ITALIC_SHAPE:
1223 case LyXFont::SLANTED_SHAPE:
1230 shape_type = font.shape();
1232 switch (shape_type) {
1233 case LyXFont::ITALIC_SHAPE:
1234 tag_open.push_back(IT);
1236 case LyXFont::SLANTED_SHAPE:
1237 tag_open.push_back(SL);
1244 if (font_old.emph() != font.emph()) {
1245 if (font.emph() == LyXFont::ON) {
1246 tag_open.push_back(EM);
1255 list < PAR_TAG > temp;
1256 while (!tag_state.empty() && tag_close) {
1257 PAR_TAG k = tag_state.top();
1259 os << "</" << tag_name(k) << '>';
1266 for(list< PAR_TAG >::const_iterator j = temp.begin();
1267 j != temp.end(); ++j) {
1269 os << '<' << tag_name(*j) << '>';
1272 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1273 j != tag_open.end(); ++j) {
1275 os << '<' << tag_name(*j) << '>';
1278 char c = getChar(i);
1280 if (c == Paragraph::META_INSET) {
1281 InsetOld const * inset = getInset(i);
1282 inset->linuxdoc(buf, os, runparams);
1287 if (style->latexparam() == "CDATA") {
1288 // "TeX"-Mode on == > SGML-Mode on.
1295 boost::tie(ws, str) = sgml::escapeChar(c);
1296 if (ws && !isFreeSpacing()) {
1297 // in freespacing mode, spaces are
1298 // non-breaking characters
1299 if (desc_on) {// if char is ' ' then...
1302 sgmlLineBreak(os, char_line_count, 6);
1306 sgmlLineBreak(os, char_line_count, 1);
1311 char_line_count += str.length();
1317 while (!tag_state.empty()) {
1318 os << "</" << tag_name(tag_state.top()) << '>';
1322 // resets description flag correctly
1324 // <tag> not closed...
1325 sgmlLineBreak(os, char_line_count, 6);
1331 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1333 LyXFont const & outerfont,
1334 OutputParams const & runparams,
1335 lyx::depth_type depth,
1338 bool emph_flag = false;
1340 LyXLayout_ptr const & style = layout();
1341 LyXLayout_ptr const & defaultstyle
1342 = buf.params().getLyXTextClass().defaultLayout();
1344 LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
1346 int char_line_count = depth;
1347 bool label_closed = true;
1348 bool para_closed = true;
1350 if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1352 Counters & counters = buf.params().getLyXTextClass().counters();
1353 if (!style->free_spacing)
1354 os << string(depth,' ');
1355 if (!style->labeltag().empty()) {
1356 os << "<" << style->labeltag() << ">\n";
1357 label_closed = false;
1359 if (!defaultstyle->latexparam().empty()) {
1360 counters.step("para");
1361 ls = tostr(counters.value("para"));
1363 + subst(defaultstyle->latexparam(), "#", ls) + '"';
1365 os << "<" << style->itemtag() << ">\n"
1366 << string(depth, ' ') << "<"
1367 << defaultstyle->latexname() << ls << ">\n";
1368 para_closed = false;
1372 // parsing main loop
1373 for (pos_type i = 0; i < size(); ++i) {
1374 LyXFont font = getFont(buf.params(), i, outerfont);
1376 // handle <emphasis> tag
1377 if (font_old.emph() != font.emph()) {
1378 if (font.emph() == LyXFont::ON) {
1379 if (style->latexparam() == "CDATA")
1382 if (style->latexparam() == "CDATA")
1386 if (style->latexparam() == "CDATA")
1388 os << "</emphasis>";
1389 if (style->latexparam() == "CDATA")
1397 InsetOld const * inset = getInset(i);
1398 // don't print the inset in position 0 if desc_on == 3 (label)
1399 //if (i || desc_on != 3) {
1401 if (style->latexparam() == "CDATA")
1403 inset->docbook(buf, os, runparams);
1404 if (style->latexparam() == "CDATA")
1408 char c = getChar(i);
1411 boost::tie(ws, str) = sgml::escapeChar(c);
1413 if (style->pass_thru) {
1415 } else if (isFreeSpacing() || c != ' ') {
1417 } else if (!style->labeltag().empty() && !label_closed) {
1419 os << "\n</" << style->labeltag() << "><"
1420 << style->itemtag() << "><"
1421 << defaultstyle->latexname() << ">";
1422 label_closed = true;
1423 para_closed = false;
1432 if (style->latexparam() == "CDATA")
1434 os << "</emphasis>";
1435 if (style->latexparam() == "CDATA")
1439 // resets description flag correctly
1440 if (!label_closed) {
1441 // <term> not closed...
1442 os << "</" << style->labeltag() << ">\n<"
1443 << style->itemtag() << "><"
1444 << defaultstyle->latexname() << "> ";
1447 os << "\n" << string(depth, ' ') << "</"
1448 << defaultstyle->latexname() << ">\n";
1450 if (style->free_spacing)
1457 /// return true if the char is a meta-character for an inset
1459 bool IsInsetChar(char c)
1461 return (c == Paragraph::META_INSET);
1468 bool Paragraph::isHfill(pos_type pos) const
1470 return IsInsetChar(getChar(pos))
1471 && getInset(pos)->lyxCode() == InsetOld::HFILL_CODE;
1475 bool Paragraph::isInset(pos_type pos) const
1477 return IsInsetChar(getChar(pos));
1481 bool Paragraph::isNewline(pos_type pos) const
1483 return IsInsetChar(getChar(pos))
1484 && getInset(pos)->lyxCode() == InsetOld::NEWLINE_CODE;
1488 bool Paragraph::isSeparator(pos_type pos) const
1490 return IsSeparatorChar(getChar(pos));
1494 bool Paragraph::isLineSeparator(pos_type pos) const
1496 value_type const c = getChar(pos);
1497 return IsLineSeparatorChar(c)
1498 || (IsInsetChar(c) && getInset(pos) &&
1499 getInset(pos)->isLineSeparator());
1503 bool Paragraph::isKomma(pos_type pos) const
1505 return IsKommaChar(getChar(pos));
1509 /// Used by the spellchecker
1510 bool Paragraph::isLetter(pos_type pos) const
1512 value_type const c = getChar(pos);
1513 if (IsLetterChar(c))
1516 return getInset(pos)->isLetter();
1517 // We want to pass the ' and escape chars to ispell
1518 string const extra = lyxrc.isp_esc_chars + '\'';
1519 return contains(extra, c);
1523 bool Paragraph::isWord(pos_type pos) const
1525 unsigned char const c = getChar(pos);
1526 return !(IsSeparatorChar(c)
1533 Paragraph::getParLanguage(BufferParams const & bparams) const
1536 return getFirstFontSettings().language();
1537 #warning FIXME we should check the prev par as well (Lgb)
1538 return bparams.language;
1542 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1544 return lyxrc.rtl_support
1545 && getParLanguage(bparams)->RightToLeft()
1546 && !(inInset() && inInset()->owner() &&
1547 inInset()->owner()->lyxCode() == InsetOld::ERT_CODE);
1551 void Paragraph::changeLanguage(BufferParams const & bparams,
1552 Language const * from, Language const * to)
1554 for (pos_type i = 0; i < size(); ++i) {
1555 LyXFont font = getFontSettings(bparams, i);
1556 if (font.language() == from) {
1557 font.setLanguage(to);
1564 bool Paragraph::isMultiLingual(BufferParams const & bparams)
1566 Language const * doc_language = bparams.language;
1567 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1568 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1570 for (; cit != end; ++cit)
1571 if (cit->font().language() != ignore_language &&
1572 cit->font().language() != latex_language &&
1573 cit->font().language() != doc_language)
1579 // Convert the paragraph to a string.
1580 // Used for building the table of contents
1581 string const Paragraph::asString(Buffer const & buffer,
1584 OutputParams runparams;
1585 return asString(buffer, runparams, label);
1589 string const Paragraph::asString(Buffer const & buffer,
1590 OutputParams const & runparams,
1595 if (label && !params().labelString().empty())
1596 s += params().labelString() + ' ';
1598 for (pos_type i = 0; i < size(); ++i) {
1599 value_type c = getChar(i);
1602 else if (c == META_INSET &&
1603 getInset(i)->lyxCode() == InsetOld::MATH_CODE) {
1605 getInset(i)->plaintext(buffer, os, runparams);
1606 s += subst(STRCONV(os.str()),'\n',' ');
1612 // This should really be done by the caller and not here.
1613 string ret = asString(buffer, runparams, 0, size(), label);
1614 return subst(ret, '\n', ' ');
1619 string const Paragraph::asString(Buffer const & buffer,
1620 pos_type beg, pos_type end, bool label) const
1623 OutputParams const runparams;
1624 return asString(buffer, runparams, beg, end, label);
1628 string const Paragraph::asString(Buffer const & buffer,
1629 OutputParams const & runparams,
1630 pos_type beg, pos_type end, bool label) const
1634 if (beg == 0 && label && !params().labelString().empty())
1635 os << params().labelString() << ' ';
1637 for (pos_type i = beg; i < end; ++i) {
1638 value_type const c = getUChar(buffer.params(), i);
1641 else if (c == META_INSET)
1642 getInset(i)->plaintext(buffer, os, runparams);
1649 void Paragraph::setInsetOwner(UpdatableInset * inset)
1651 pimpl_->inset_owner = inset;
1652 InsetList::iterator it = insetlist.begin();
1653 InsetList::iterator end = insetlist.end();
1654 for (; it != end; ++it)
1656 it->inset->setOwner(inset);
1660 void Paragraph::setContentsFromPar(Paragraph const & par)
1662 pimpl_->setContentsFromPar(par);
1666 void Paragraph::trackChanges(Change::Type type)
1668 pimpl_->trackChanges(type);
1672 void Paragraph::untrackChanges()
1674 pimpl_->untrackChanges();
1678 void Paragraph::cleanChanges()
1680 pimpl_->cleanChanges();
1684 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1686 BOOST_ASSERT(!size() || pos < size());
1687 return pimpl_->lookupChange(pos);
1691 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1693 BOOST_ASSERT(!size() || pos < size());
1694 return pimpl_->lookupChangeFull(pos);
1698 bool Paragraph::isChanged(pos_type start, pos_type end) const
1700 return pimpl_->isChanged(start, end);
1704 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1706 return pimpl_->isChangeEdited(start, end);
1710 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1712 pimpl_->setChange(pos, type);
1717 void Paragraph::markErased()
1719 pimpl_->markErased();
1723 void Paragraph::acceptChange(pos_type start, pos_type end)
1725 return pimpl_->acceptChange(start, end);
1729 void Paragraph::rejectChange(pos_type start, pos_type end)
1731 return pimpl_->rejectChange(start, end);
1735 Paragraph::value_type Paragraph::getChar(pos_type pos) const
1737 // This is in the critical path!
1738 pos_type const siz = text_.size();
1740 BOOST_ASSERT(0 <= pos);
1741 BOOST_ASSERT(pos <= siz);
1744 lyxerr << "getChar() on pos " << pos << " in par id "
1745 << id() << " of size " << siz
1746 << " is a bit silly !" << endl;
1747 BOOST_ASSERT(false);
1755 int Paragraph::id() const
1761 LyXLayout_ptr const & Paragraph::layout() const
1764 InsetOld * inset = inInset();
1765 if (inset && inset->lyxCode() == InsetOld::ENVIRONMENT_CODE)
1766 return static_cast<InsetEnvironment*>(inset)->layout();
1772 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1774 layout_ = new_layout;
1778 UpdatableInset * Paragraph::inInset() const
1780 return pimpl_->inset_owner;
1784 void Paragraph::clearContents()
1790 void Paragraph::setChar(pos_type pos, value_type c)
1796 ParagraphParameters & Paragraph::params()
1798 return pimpl_->params;
1802 ParagraphParameters const & Paragraph::params() const
1804 return pimpl_->params;
1808 bool Paragraph::isFreeSpacing() const
1810 if (layout()->free_spacing)
1813 // for now we just need this, later should we need this in some
1814 // other way we can always add a function to InsetOld too.
1815 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1816 return pimpl_->inset_owner->owner()->lyxCode() == InsetOld::ERT_CODE;
1821 bool Paragraph::allowEmpty() const
1823 if (layout()->keepempty)
1825 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1826 return pimpl_->inset_owner->owner()->lyxCode() == InsetOld::ERT_CODE;
1831 RowList::iterator Paragraph::getRow(pos_type pos)
1833 RowList::iterator rit = rows.end();
1834 RowList::iterator const begin = rows.begin();
1836 for (--rit; rit != begin && rit->pos() > pos; --rit)
1843 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1845 if (!Encodings::is_arabic(c))
1846 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1847 return c + (0xb0 - '0');
1851 unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1852 unsigned char next_char = ' ';
1854 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1855 unsigned char const par_char = getChar(i);
1856 if (!Encodings::IsComposeChar_arabic(par_char)) {
1857 next_char = par_char;
1862 if (Encodings::is_arabic(next_char)) {
1863 if (Encodings::is_arabic(prev_char) &&
1864 !Encodings::is_arabic_special(prev_char))
1865 return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1867 return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1869 if (Encodings::is_arabic(prev_char) &&
1870 !Encodings::is_arabic_special(prev_char))
1871 return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1873 return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);