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>
48 #include <boost/bind.hpp>
55 using lyx::support::contains;
56 using lyx::support::subst;
64 using std::ostringstream;
67 Paragraph::Paragraph()
68 : y(0), height(0), begin_of_body_(0),
69 pimpl_(new Paragraph::Pimpl(this))
76 Paragraph::Paragraph(Paragraph const & par)
77 : y(0), height(0), text_(par.text_), begin_of_body_(par.begin_of_body_),
78 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
81 // this is because of the dummy layout of the paragraphs that
83 layout_ = par.layout();
85 // copy everything behind the break-position to the new paragraph
86 insetlist = par.insetlist;
87 InsetList::iterator it = insetlist.begin();
88 InsetList::iterator end = insetlist.end();
89 for (; it != end; ++it)
90 it->inset = it->inset->clone().release();
94 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 = it->inset->clone().release();
121 Paragraph::~Paragraph()
125 //lyxerr << "Paragraph::paragraph_id = "
126 // << Paragraph::paragraph_id << endl;
130 void Paragraph::write(Buffer const & buf, ostream & os,
131 BufferParams const & bparams,
132 depth_type & dth) const
134 // The beginning or end of a deeper (i.e. nested) area?
135 if (dth != params().depth()) {
136 if (params().depth() > dth) {
137 while (params().depth() > dth) {
138 os << "\n\\begin_deeper ";
142 while (params().depth() < dth) {
143 os << "\n\\end_deeper ";
149 // First write the layout
150 os << "\n\\begin_layout " << layout()->name() << '\n';
154 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
156 Change running_change = Change(Change::UNCHANGED);
157 lyx::time_type const curtime(lyx::current_time());
160 for (pos_type i = 0; i < size(); ++i) {
166 Change change = pimpl_->lookupChangeFull(i);
167 Changes::lyxMarkChange(os, column, curtime, running_change, change);
168 running_change = change;
170 // Write font changes
171 LyXFont font2 = getFontSettings(bparams, i);
172 if (font2 != font1) {
173 font2.lyxWriteChanges(font1, os);
178 value_type const c = getChar(i);
182 InsetBase const * inset = getInset(i);
184 if (inset->directWrite()) {
185 // international char, let it write
186 // code directly so it's shorter in
188 inset->write(buf, os);
190 os << "\n\\begin_inset ";
191 inset->write(buf, os);
192 os << "\n\\end_inset \n\n";
198 os << "\n\\backslash \n";
202 if (i + 1 < size() && getChar(i + 1) == ' ') {
209 if ((column > 70 && c == ' ')
214 // this check is to amend a bug. LyX sometimes
215 // inserts '\0' this could cause problems.
219 lyxerr << "ERROR (Paragraph::writeFile):"
220 " NULL char in structure." << endl;
226 // to make reading work properly
228 running_change = pimpl_->lookupChange(0);
229 Changes::lyxMarkChange(os, column, curtime,
230 Change(Change::UNCHANGED), running_change);
232 Changes::lyxMarkChange(os, column, curtime,
233 running_change, Change(Change::UNCHANGED));
235 os << "\n\\end_layout\n";
239 void Paragraph::validate(LaTeXFeatures & features) const
241 pimpl_->validate(features, *layout());
245 void Paragraph::eraseIntern(lyx::pos_type pos)
247 pimpl_->eraseIntern(pos);
251 bool Paragraph::erase(pos_type pos)
253 return pimpl_->erase(pos);
257 int Paragraph::erase(pos_type start, pos_type end)
259 return pimpl_->erase(start, end);
263 void Paragraph::insert(pos_type start, string const & str,
264 LyXFont const & font)
266 int size = str.size();
267 for (int i = 0 ; i < size ; ++i)
268 insertChar(start + i, str[i], font);
272 bool Paragraph::checkInsertChar(LyXFont &)
278 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c)
280 insertChar(pos, c, LyXFont(LyXFont::ALL_INHERIT));
284 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
285 LyXFont const & font, Change change)
287 pimpl_->insertChar(pos, c, font, change);
291 void Paragraph::insertInset(pos_type pos, InsetBase * inset)
293 insertInset(pos, inset, LyXFont(LyXFont::ALL_INHERIT));
297 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
298 LyXFont const & font, Change change)
300 pimpl_->insertInset(pos, inset, font, change);
304 bool Paragraph::insetAllowed(InsetOld_code code)
306 //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
307 if (pimpl_->inset_owner)
308 return pimpl_->inset_owner->insetAllowed(code);
313 InsetBase * Paragraph::getInset(pos_type pos)
315 BOOST_ASSERT(pos < size());
316 return insetlist.get(pos);
320 InsetBase const * Paragraph::getInset(pos_type pos) const
322 BOOST_ASSERT(pos < size());
323 return insetlist.get(pos);
327 // Gets uninstantiated font setting at position.
328 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
332 lyxerr << " pos: " << pos << " size: " << size() << endl;
333 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 = 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
595 return par.layout() == layout() && params().sameLayout(par.params());
599 Paragraph::depth_type Paragraph::getDepth() const
601 return params().depth();
605 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
607 if (layout()->isEnvironment())
608 return params().depth() + 1;
610 return params().depth();
614 char Paragraph::getAlign() const
616 return params().align();
620 string const & Paragraph::getLabelstring() const
622 return params().labelString();
626 // the next two functions are for the manual labels
627 string const Paragraph::getLabelWidthString() const
629 if (!params().labelWidthString().empty())
630 return params().labelWidthString();
632 return _("Senseless with this layout!");
636 void Paragraph::setLabelWidthString(string const & s)
638 params().labelWidthString(s);
642 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
645 params().labelWidthString(string());
646 params().align(LYX_ALIGN_LAYOUT);
647 params().spacing(Spacing(Spacing::Default));
651 int Paragraph::beginOfBody() const
653 return begin_of_body_;
657 void Paragraph::setBeginOfBody()
659 if (layout()->labeltype != LABEL_MANUAL) {
664 // Unroll the first two cycles of the loop
665 // and remember the previous character to
666 // remove unnecessary getChar() calls
668 pos_type end = size();
669 if (i < end && !isNewline(i)) {
671 char previous_char = 0;
674 previous_char = text_[i];
677 while (i < end && previous_char != ' ') {
682 previous_char = temp;
692 // returns -1 if inset not found
693 int Paragraph::getPositionOfInset(InsetBase const * inset) const
696 InsetList::const_iterator it = insetlist.begin();
697 InsetList::const_iterator end = insetlist.end();
698 for (; it != end; ++it)
699 if (it->inset == inset)
705 InsetBibitem * Paragraph::bibitem() const
707 if (!insetlist.empty()) {
708 InsetBase * inset = insetlist.begin()->inset;
709 if (inset->lyxCode() == InsetBase::BIBTEX_CODE)
710 return static_cast<InsetBibitem *>(inset);
718 // paragraphs inside floats need different alignment tags to avoid
721 bool noTrivlistCentering(UpdatableInset const * inset)
723 if (inset && inset->owner()) {
724 InsetBase::Code const code = inset->owner()->lyxCode();
725 return code == InsetBase::FLOAT_CODE ||
726 code == InsetBase::WRAP_CODE;
732 string correction(string const & orig)
734 if (orig == "flushleft")
735 return "raggedright";
736 if (orig == "flushright")
738 if (orig == "center")
744 string const corrected_env(string const & suffix, string const & env,
745 UpdatableInset const * inset)
747 string output = suffix + "{";
748 if (noTrivlistCentering(inset))
749 output += correction(env);
758 // This could go to ParagraphParameters if we want to
759 int Paragraph::startTeXParParams(BufferParams const & bparams,
760 ostream & os, bool moving_arg) const
764 if (params().noindent()) {
769 switch (params().align()) {
771 case LYX_ALIGN_BLOCK:
772 case LYX_ALIGN_LAYOUT:
773 case LYX_ALIGN_SPECIAL:
776 case LYX_ALIGN_RIGHT:
777 case LYX_ALIGN_CENTER:
785 switch (params().align()) {
787 case LYX_ALIGN_BLOCK:
788 case LYX_ALIGN_LAYOUT:
789 case LYX_ALIGN_SPECIAL:
791 case LYX_ALIGN_LEFT: {
793 UpdatableInset const * const inset = pimpl_->inset_owner;
794 if (getParLanguage(bparams)->babel() != "hebrew")
795 output = corrected_env("\\begin", "flushleft", inset);
797 output = corrected_env("\\begin", "flushright", inset);
799 column += output.size();
801 } case LYX_ALIGN_RIGHT: {
803 UpdatableInset const * const inset = pimpl_->inset_owner;
804 if (getParLanguage(bparams)->babel() != "hebrew")
805 output = corrected_env("\\begin", "flushright", inset);
807 output = corrected_env("\\begin", "flushleft", inset);
809 column += output.size();
811 } case LYX_ALIGN_CENTER: {
813 output = corrected_env("\\begin", "center", pimpl_->inset_owner);
815 column += output.size();
824 // This could go to ParagraphParameters if we want to
825 int Paragraph::endTeXParParams(BufferParams const & bparams,
826 ostream & os, bool moving_arg) const
830 switch (params().align()) {
832 case LYX_ALIGN_BLOCK:
833 case LYX_ALIGN_LAYOUT:
834 case LYX_ALIGN_SPECIAL:
837 case LYX_ALIGN_RIGHT:
838 case LYX_ALIGN_CENTER:
846 switch (params().align()) {
848 case LYX_ALIGN_BLOCK:
849 case LYX_ALIGN_LAYOUT:
850 case LYX_ALIGN_SPECIAL:
852 case LYX_ALIGN_LEFT: {
854 UpdatableInset const * const inset = pimpl_->inset_owner;
855 if (getParLanguage(bparams)->babel() != "hebrew")
856 output = corrected_env("\\par\\end", "flushleft", inset);
858 output = corrected_env("\\par\\end", "flushright", inset);
860 column += output.size();
862 } case LYX_ALIGN_RIGHT: {
864 UpdatableInset const * const inset = pimpl_->inset_owner;
865 if (getParLanguage(bparams)->babel() != "hebrew")
866 output = corrected_env("\\par\\end", "flushright", inset);
868 output = corrected_env("\\par\\end", "flushleft", inset);
870 column += output.size();
872 } case LYX_ALIGN_CENTER: {
874 output = corrected_env("\\par\\end", "center", pimpl_->inset_owner);
876 column += output.size();
885 // This one spits out the text of the paragraph
886 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
887 BufferParams const & bparams,
888 LyXFont const & outerfont,
889 ostream & os, TexRow & texrow,
890 OutputParams const & runparams)
892 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
894 bool return_value = false;
898 // well we have to check if we are in an inset with unlimited
899 // length (all in one row) if that is true then we don't allow
900 // any special options in the paragraph and also we don't allow
901 // any environment other then "Standard" to be valid!
903 (inInset() && inInset()->forceDefaultParagraphs(inInset()));
906 style = bparams.getLyXTextClass().defaultLayout();
913 // Maybe we have to create a optional argument.
914 pos_type body_pos = beginOfBody();
915 unsigned int column = 0;
920 basefont = getLabelFont(bparams, outerfont);
922 basefont = getLayoutFont(bparams, outerfont);
925 bool moving_arg = runparams.moving_arg;
926 moving_arg |= style->needprotect;
928 // Which font is currently active?
929 LyXFont running_font(basefont);
930 // Do we have an open font change?
931 bool open_font = false;
933 Change::Type running_change = Change::UNCHANGED;
935 texrow.start(id(), 0);
937 // if the paragraph is empty, the loop will not be entered at all
939 if (style->isCommand()) {
944 column += startTeXParParams(bparams, os, moving_arg);
947 for (pos_type i = 0; i < size(); ++i) {
949 // First char in paragraph or after label?
953 column += running_font.latexWriteEndChanges(os, basefont, basefont);
956 basefont = getLayoutFont(bparams, outerfont);
957 running_font = basefont;
961 if (style->isCommand()) {
967 column += startTeXParParams(bparams, os,
971 value_type c = getChar(i);
973 // Fully instantiated font
974 LyXFont font = getFont(bparams, i, outerfont);
976 LyXFont const last_font = running_font;
978 // Spaces at end of font change are simulated to be
979 // outside font change, i.e. we write "\textXX{text} "
980 // rather than "\textXX{text }". (Asger)
981 if (open_font && c == ' ' && i <= size() - 2) {
982 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
983 if (next_font != running_font && next_font != font) {
988 // We end font definition before blanks
990 (font != running_font ||
991 font.language() != running_font.language()))
993 column += running_font.latexWriteEndChanges(os,
995 (i == body_pos-1) ? basefont : font);
996 running_font = basefont;
1000 // Blanks are printed before start of fontswitch
1002 // Do not print the separation of the optional argument
1003 if (i != body_pos - 1) {
1004 pimpl_->simpleTeXBlanks(os, texrow, i,
1005 column, font, *style);
1009 // Do we need to change font?
1010 if ((font != running_font ||
1011 font.language() != running_font.language()) &&
1014 column += font.latexWriteStartChanges(os, basefont,
1016 running_font = font;
1020 Change::Type change = pimpl_->lookupChange(i);
1022 column += Changes::latexMarkChange(os, running_change, change);
1023 running_change = change;
1025 OutputParams rp = runparams;
1026 rp.moving_arg = moving_arg;
1027 rp.free_spacing = style->free_spacing;
1028 pimpl_->simpleTeXSpecialChars(buf, bparams,
1029 os, texrow, runparams,
1031 basefont, outerfont, open_font,
1033 *style, i, column, c);
1036 column += Changes::latexMarkChange(os,
1037 running_change, Change::UNCHANGED);
1039 // If we have an open font definition, we have to close it
1041 #ifdef FIXED_LANGUAGE_END_DETECTION
1044 .latexWriteEndChanges(os, basefont,
1045 next_->getFont(bparams,
1048 running_font.latexWriteEndChanges(os, basefont,
1052 #ifdef WITH_WARNINGS
1053 //#warning For now we ALWAYS have to close the foreign font settings if they are
1054 //#warning there as we start another \selectlanguage with the next paragraph if
1055 //#warning we are in need of this. This should be fixed sometime (Jug)
1057 running_font.latexWriteEndChanges(os, basefont, basefont);
1061 // Needed if there is an optional argument but no contents.
1062 if (body_pos > 0 && body_pos == size()) {
1064 return_value = false;
1068 column += endTeXParParams(bparams, os, moving_arg);
1071 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1072 return return_value;
1078 // checks, if newcol chars should be put into this line
1079 // writes newline, if necessary.
1080 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1081 string::size_type newcol)
1084 if (colcount > lyxrc.ascii_linelen) {
1086 colcount = newcol; // assume write after this call
1101 string tag_name(PAR_TAG const & pt) {
1103 case PAR_NONE: return "!-- --";
1104 case TT: return "tt";
1105 case SF: return "sf";
1106 case BF: return "bf";
1107 case IT: return "it";
1108 case SL: return "sl";
1109 case EM: return "em";
1116 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1118 p1 = static_cast<PAR_TAG>(p1 | p2);
1123 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1125 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1131 // Handle internal paragraph parsing -- layout already processed.
1132 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1134 LyXFont const & outerfont,
1135 OutputParams const & runparams,
1136 lyx::depth_type /*depth*/) const
1138 LyXLayout_ptr const & style = layout();
1140 string::size_type char_line_count = 5; // Heuristic choice ;-)
1142 // gets paragraph main font
1145 if (style->labeltype == LABEL_MANUAL) {
1146 font_old = style->labelfont;
1149 font_old = style->font;
1153 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1154 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1155 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
1158 stack<PAR_TAG> tag_state;
1159 // parsing main loop
1160 for (pos_type i = 0; i < size(); ++i) {
1162 PAR_TAG tag_close = PAR_NONE;
1163 list < PAR_TAG > tag_open;
1165 LyXFont const font = getFont(buf.params(), i, outerfont);
1167 if (font_old.family() != font.family()) {
1168 switch (family_type) {
1169 case LyXFont::SANS_FAMILY:
1172 case LyXFont::TYPEWRITER_FAMILY:
1179 family_type = font.family();
1181 switch (family_type) {
1182 case LyXFont::SANS_FAMILY:
1183 tag_open.push_back(SF);
1185 case LyXFont::TYPEWRITER_FAMILY:
1186 tag_open.push_back(TT);
1193 if (font_old.series() != font.series()) {
1194 switch (series_type) {
1195 case LyXFont::BOLD_SERIES:
1202 series_type = font.series();
1204 switch (series_type) {
1205 case LyXFont::BOLD_SERIES:
1206 tag_open.push_back(BF);
1214 if (font_old.shape() != font.shape()) {
1215 switch (shape_type) {
1216 case LyXFont::ITALIC_SHAPE:
1219 case LyXFont::SLANTED_SHAPE:
1226 shape_type = font.shape();
1228 switch (shape_type) {
1229 case LyXFont::ITALIC_SHAPE:
1230 tag_open.push_back(IT);
1232 case LyXFont::SLANTED_SHAPE:
1233 tag_open.push_back(SL);
1240 if (font_old.emph() != font.emph()) {
1241 if (font.emph() == LyXFont::ON) {
1242 tag_open.push_back(EM);
1251 list < PAR_TAG > temp;
1252 while (!tag_state.empty() && tag_close) {
1253 PAR_TAG k = tag_state.top();
1255 os << "</" << tag_name(k) << '>';
1262 for(list< PAR_TAG >::const_iterator j = temp.begin();
1263 j != temp.end(); ++j) {
1265 os << '<' << tag_name(*j) << '>';
1268 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1269 j != tag_open.end(); ++j) {
1271 os << '<' << tag_name(*j) << '>';
1274 char c = getChar(i);
1277 if (c == Paragraph::META_INSET) {
1278 getInset(i)->linuxdoc(buf, os, runparams);
1283 if (style->latexparam() == "CDATA") {
1284 // "TeX"-Mode on == > SGML-Mode on.
1291 boost::tie(ws, str) = sgml::escapeChar(c);
1292 if (ws && !isFreeSpacing()) {
1293 // in freespacing mode, spaces are
1294 // non-breaking characters
1295 if (desc_on) { // if char is ' ' then...
1297 sgmlLineBreak(os, char_line_count, 6);
1301 sgmlLineBreak(os, char_line_count, 1);
1306 char_line_count += str.length();
1312 while (!tag_state.empty()) {
1313 os << "</" << tag_name(tag_state.top()) << '>';
1317 // resets description flag correctly
1319 // <tag> not closed...
1320 sgmlLineBreak(os, char_line_count, 6);
1326 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1328 LyXFont const & outerfont,
1329 OutputParams const & runparams,
1330 lyx::depth_type depth,
1333 bool emph_flag = false;
1335 LyXLayout_ptr const & style = layout();
1336 LyXLayout_ptr const & defaultstyle =
1337 buf.params().getLyXTextClass().defaultLayout();
1340 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1342 int char_line_count = depth;
1343 bool label_closed = true;
1344 bool para_closed = true;
1346 if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1348 Counters & counters = buf.params().getLyXTextClass().counters();
1349 if (!style->free_spacing)
1350 os << string(depth,' ');
1351 if (!style->labeltag().empty()) {
1352 os << "<" << style->labeltag() << ">\n";
1353 label_closed = false;
1355 if (!defaultstyle->latexparam().empty()) {
1356 counters.step("para");
1357 ls = tostr(counters.value("para"));
1359 + subst(defaultstyle->latexparam(), "#", ls) + '"';
1361 os << "<" << style->itemtag() << ">\n"
1362 << string(depth, ' ') << "<"
1363 << defaultstyle->latexname() << ls << ">\n";
1364 para_closed = false;
1368 // parsing main loop
1369 for (pos_type i = 0; i < size(); ++i) {
1370 LyXFont font = getFont(buf.params(), i, outerfont);
1372 // handle <emphasis> tag
1373 if (font_old.emph() != font.emph()) {
1374 if (font.emph() == LyXFont::ON) {
1375 if (style->latexparam() == "CDATA")
1378 if (style->latexparam() == "CDATA")
1382 if (style->latexparam() == "CDATA")
1384 os << "</emphasis>";
1385 if (style->latexparam() == "CDATA")
1392 InsetBase const * inset = getInset(i);
1393 // don't print the inset in position 0 if desc_on == 3 (label)
1394 //if (i || desc_on != 3) {
1396 if (style->latexparam() == "CDATA")
1398 inset->docbook(buf, os, runparams);
1399 if (style->latexparam() == "CDATA")
1403 char c = getChar(i);
1406 boost::tie(ws, str) = sgml::escapeChar(c);
1408 if (style->pass_thru) {
1410 } else if (isFreeSpacing() || c != ' ') {
1412 } else if (!style->labeltag().empty() && !label_closed) {
1414 os << "\n</" << style->labeltag() << "><"
1415 << style->itemtag() << "><"
1416 << defaultstyle->latexname() << ">";
1417 label_closed = true;
1418 para_closed = false;
1427 if (style->latexparam() == "CDATA")
1429 os << "</emphasis>";
1430 if (style->latexparam() == "CDATA")
1434 // resets description flag correctly
1435 if (!label_closed) {
1436 // <term> not closed...
1437 os << "</" << style->labeltag() << ">\n<"
1438 << style->itemtag() << "><"
1439 << defaultstyle->latexname() << "> ";
1442 os << "\n" << string(depth, ' ') << "</"
1443 << defaultstyle->latexname() << ">\n";
1445 if (style->free_spacing)
1452 /// return true if the char is a meta-character for an inset
1454 bool IsInsetChar(char c)
1456 return (c == Paragraph::META_INSET);
1463 bool Paragraph::isHfill(pos_type pos) const
1465 return IsInsetChar(getChar(pos))
1466 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
1470 bool Paragraph::isInset(pos_type pos) const
1472 return IsInsetChar(getChar(pos));
1476 bool Paragraph::isNewline(pos_type pos) const
1478 return IsInsetChar(getChar(pos))
1479 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1483 bool Paragraph::isSeparator(pos_type pos) const
1485 return IsSeparatorChar(getChar(pos));
1489 bool Paragraph::isLineSeparator(pos_type pos) const
1491 value_type const c = getChar(pos);
1492 return IsLineSeparatorChar(c)
1493 || (IsInsetChar(c) && getInset(pos) &&
1494 getInset(pos)->isLineSeparator());
1498 bool Paragraph::isKomma(pos_type pos) const
1500 return IsKommaChar(getChar(pos));
1504 /// Used by the spellchecker
1505 bool Paragraph::isLetter(pos_type pos) const
1507 value_type const c = getChar(pos);
1508 if (IsLetterChar(c))
1511 return getInset(pos)->isLetter();
1512 // We want to pass the ' and escape chars to ispell
1513 string const extra = lyxrc.isp_esc_chars + '\'';
1514 return contains(extra, c);
1518 bool Paragraph::isWord(pos_type pos) const
1520 unsigned char const c = getChar(pos);
1521 return !(IsSeparatorChar(c)
1528 Paragraph::getParLanguage(BufferParams const & bparams) const
1531 return getFirstFontSettings().language();
1532 #warning FIXME we should check the prev par as well (Lgb)
1533 return bparams.language;
1537 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1539 return lyxrc.rtl_support
1540 && getParLanguage(bparams)->RightToLeft()
1541 && !(inInset() && inInset()->owner() &&
1542 inInset()->owner()->lyxCode() == InsetBase::ERT_CODE);
1546 void Paragraph::changeLanguage(BufferParams const & bparams,
1547 Language const * from, Language const * to)
1549 for (pos_type i = 0; i < size(); ++i) {
1550 LyXFont font = getFontSettings(bparams, i);
1551 if (font.language() == from) {
1552 font.setLanguage(to);
1559 bool Paragraph::isMultiLingual(BufferParams const & bparams)
1561 Language const * doc_language = bparams.language;
1562 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1563 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1565 for (; cit != end; ++cit)
1566 if (cit->font().language() != ignore_language &&
1567 cit->font().language() != latex_language &&
1568 cit->font().language() != doc_language)
1574 // Convert the paragraph to a string.
1575 // Used for building the table of contents
1576 string const Paragraph::asString(Buffer const & buffer,
1579 OutputParams runparams;
1580 return asString(buffer, runparams, label);
1584 string const Paragraph::asString(Buffer const & buffer,
1585 OutputParams const & runparams,
1590 if (label && !params().labelString().empty())
1591 s += params().labelString() + ' ';
1593 for (pos_type i = 0; i < size(); ++i) {
1594 value_type c = getChar(i);
1597 else if (c == META_INSET &&
1598 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1600 getInset(i)->plaintext(buffer, os, runparams);
1601 s += subst(STRCONV(os.str()),'\n',' ');
1607 // This should really be done by the caller and not here.
1608 string ret = asString(buffer, runparams, 0, size(), label);
1609 return subst(ret, '\n', ' ');
1614 string const Paragraph::asString(Buffer const & buffer,
1615 pos_type beg, pos_type end, bool label) const
1618 OutputParams const runparams;
1619 return asString(buffer, runparams, beg, end, label);
1623 string const Paragraph::asString(Buffer const & buffer,
1624 OutputParams const & runparams,
1625 pos_type beg, pos_type end, bool label) const
1629 if (beg == 0 && label && !params().labelString().empty())
1630 os << params().labelString() << ' ';
1632 for (pos_type i = beg; i < end; ++i) {
1633 value_type const c = getUChar(buffer.params(), i);
1636 else if (c == META_INSET)
1637 getInset(i)->plaintext(buffer, os, runparams);
1644 void Paragraph::setInsetOwner(UpdatableInset * inset)
1646 pimpl_->inset_owner = inset;
1647 InsetList::iterator it = insetlist.begin();
1648 InsetList::iterator end = insetlist.end();
1649 for (; it != end; ++it)
1651 it->inset->setOwner(inset);
1655 void Paragraph::setContentsFromPar(Paragraph const & par)
1657 pimpl_->setContentsFromPar(par);
1661 void Paragraph::trackChanges(Change::Type type)
1663 pimpl_->trackChanges(type);
1667 void Paragraph::untrackChanges()
1669 pimpl_->untrackChanges();
1673 void Paragraph::cleanChanges()
1675 pimpl_->cleanChanges();
1679 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1681 BOOST_ASSERT(!size() || pos < size());
1682 return pimpl_->lookupChange(pos);
1686 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1688 BOOST_ASSERT(!size() || pos < size());
1689 return pimpl_->lookupChangeFull(pos);
1693 bool Paragraph::isChanged(pos_type start, pos_type end) const
1695 return pimpl_->isChanged(start, end);
1699 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1701 return pimpl_->isChangeEdited(start, end);
1705 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1707 pimpl_->setChange(pos, type);
1711 void Paragraph::markErased()
1713 pimpl_->markErased();
1717 void Paragraph::acceptChange(pos_type start, pos_type end)
1719 return pimpl_->acceptChange(start, end);
1723 void Paragraph::rejectChange(pos_type start, pos_type end)
1725 return pimpl_->rejectChange(start, end);
1729 Paragraph::value_type Paragraph::getChar(pos_type pos) const
1731 // This is in the critical path!
1732 pos_type const siz = text_.size();
1734 BOOST_ASSERT(0 <= pos);
1735 BOOST_ASSERT(pos <= siz);
1738 lyxerr << "getChar() on pos " << pos << " in par id "
1739 << id() << " of size " << siz
1740 << " is a bit silly !" << endl;
1741 BOOST_ASSERT(false);
1748 int Paragraph::id() const
1754 LyXLayout_ptr const & Paragraph::layout() const
1757 InsetBase * inset = inInset();
1758 if (inset && inset->lyxCode() == InsetBase::ENVIRONMENT_CODE)
1759 return static_cast<InsetEnvironment*>(inset)->layout();
1765 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1767 layout_ = new_layout;
1771 UpdatableInset * Paragraph::inInset() const
1773 return pimpl_->inset_owner;
1777 void Paragraph::clearContents()
1783 void Paragraph::setChar(pos_type pos, value_type c)
1789 ParagraphParameters & Paragraph::params()
1791 return pimpl_->params;
1795 ParagraphParameters const & Paragraph::params() const
1797 return pimpl_->params;
1801 bool Paragraph::isFreeSpacing() const
1803 if (layout()->free_spacing)
1806 // for now we just need this, later should we need this in some
1807 // other way we can always add a function to InsetBase too.
1808 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1809 return pimpl_->inset_owner->owner()->lyxCode() == InsetBase::ERT_CODE;
1814 bool Paragraph::allowEmpty() const
1816 if (layout()->keepempty)
1818 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
1819 return pimpl_->inset_owner->owner()->lyxCode() == InsetBase::ERT_CODE;
1824 RowList::iterator Paragraph::getRow(pos_type pos)
1826 RowList::iterator rit = rows.end();
1827 RowList::iterator const begin = rows.begin();
1829 for (--rit; rit != begin && rit->pos() > pos; --rit)
1836 RowList::const_iterator Paragraph::getRow(pos_type pos) const
1838 RowList::const_iterator rit = rows.end();
1839 RowList::const_iterator const begin = rows.begin();
1841 for (--rit; rit != begin && rit->pos() > pos; --rit)
1848 size_t Paragraph::row(pos_type pos) const
1850 RowList::const_iterator rit = rows.end();
1851 RowList::const_iterator const begin = rows.begin();
1853 for (--rit; rit != begin && rit->pos() > pos; --rit)
1860 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1862 if (!Encodings::is_arabic(c))
1863 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1864 return c + (0xb0 - '0');
1868 unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1869 unsigned char next_char = ' ';
1871 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1872 unsigned char const par_char = getChar(i);
1873 if (!Encodings::IsComposeChar_arabic(par_char)) {
1874 next_char = par_char;
1879 if (Encodings::is_arabic(next_char)) {
1880 if (Encodings::is_arabic(prev_char) &&
1881 !Encodings::is_arabic_special(prev_char))
1882 return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1884 return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1886 if (Encodings::is_arabic(prev_char) &&
1887 !Encodings::is_arabic_special(prev_char))
1888 return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1890 return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);