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"
35 #include "ParagraphList_fwd.h"
40 #include "insets/insetbibitem.h"
41 #include "insets/insetoptarg.h"
43 #include "support/lstrings.h"
44 #include "support/textutils.h"
45 #include "support/tostr.h"
47 #include <boost/tuple/tuple.hpp>
48 #include <boost/bind.hpp>
56 using lyx::support::contains;
57 using lyx::support::subst;
65 using std::ostringstream;
68 ParagraphList::ParagraphList()
72 Paragraph::Paragraph()
73 : y(0), height(0), begin_of_body_(0),
74 pimpl_(new Paragraph::Pimpl(this))
76 //lyxerr << "sizeof Paragraph::Pimpl: " << sizeof(Paragraph::Pimpl) << endl;
82 Paragraph::Paragraph(Paragraph const & par)
83 : itemdepth(par.itemdepth), insetlist(par.insetlist),
84 rows(par.rows), y(par.y), height(par.height),
85 width(par.width), layout_(par.layout_),
86 text_(par.text_), begin_of_body_(par.begin_of_body_),
87 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
89 //lyxerr << "Paragraph::Paragraph(Paragraph const&)" << endl;
90 InsetList::iterator it = insetlist.begin();
91 InsetList::iterator end = insetlist.end();
92 for (; it != end; ++it)
93 it->inset = it->inset->clone().release();
97 Paragraph & Paragraph::operator=(Paragraph const & par)
99 // needed as we will destroy the pimpl_ before copying it
101 itemdepth = par.itemdepth;
103 insetlist = par.insetlist;
104 InsetList::iterator it = insetlist.begin();
105 InsetList::iterator end = insetlist.end();
106 for (; it != end; ++it)
107 it->inset = it->inset->clone().release();
113 layout_ = par.layout();
115 begin_of_body_ = par.begin_of_body_;
118 pimpl_ = new Pimpl(*par.pimpl_, this);
124 Paragraph::~Paragraph()
128 //lyxerr << "Paragraph::paragraph_id = "
129 // << Paragraph::paragraph_id << endl;
133 void Paragraph::write(Buffer const & buf, ostream & os,
134 BufferParams const & bparams,
135 depth_type & dth) const
137 // The beginning or end of a deeper (i.e. nested) area?
138 if (dth != params().depth()) {
139 if (params().depth() > dth) {
140 while (params().depth() > dth) {
141 os << "\n\\begin_deeper";
145 while (params().depth() < dth) {
146 os << "\n\\end_deeper";
152 // First write the layout
153 os << "\n\\begin_layout " << layout()->name() << '\n';
157 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
159 Change running_change = Change(Change::UNCHANGED);
160 lyx::time_type const curtime(lyx::current_time());
163 for (pos_type i = 0; i < size(); ++i) {
169 Change change = pimpl_->lookupChangeFull(i);
170 Changes::lyxMarkChange(os, column, curtime, running_change, change);
171 running_change = change;
173 // Write font changes
174 LyXFont font2 = getFontSettings(bparams, i);
175 if (font2 != font1) {
176 font2.lyxWriteChanges(font1, os);
181 value_type const c = getChar(i);
185 InsetBase const * inset = getInset(i);
187 if (inset->directWrite()) {
188 // international char, let it write
189 // code directly so it's shorter in
191 inset->write(buf, os);
193 os << "\n\\begin_inset ";
194 inset->write(buf, os);
195 os << "\n\\end_inset\n\n";
201 os << "\n\\backslash\n";
205 if (i + 1 < size() && getChar(i + 1) == ' ') {
212 if ((column > 70 && c == ' ')
217 // this check is to amend a bug. LyX sometimes
218 // inserts '\0' this could cause problems.
222 lyxerr << "ERROR (Paragraph::writeFile):"
223 " NULL char in structure." << endl;
229 // to make reading work properly
231 running_change = pimpl_->lookupChange(0);
232 Changes::lyxMarkChange(os, column, curtime,
233 Change(Change::UNCHANGED), running_change);
235 Changes::lyxMarkChange(os, column, curtime,
236 running_change, Change(Change::UNCHANGED));
238 os << "\n\\end_layout\n";
242 void Paragraph::validate(LaTeXFeatures & features) const
244 pimpl_->validate(features, *layout());
248 void Paragraph::eraseIntern(lyx::pos_type pos)
250 pimpl_->eraseIntern(pos);
254 bool Paragraph::erase(pos_type pos)
256 return pimpl_->erase(pos);
260 int Paragraph::erase(pos_type start, pos_type end)
262 return pimpl_->erase(start, end);
266 void Paragraph::insert(pos_type start, string const & str,
267 LyXFont const & font)
269 int size = str.size();
270 for (int i = 0 ; i < size ; ++i)
271 insertChar(start + i, str[i], font);
275 bool Paragraph::checkInsertChar(LyXFont &)
281 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
284 pimpl_->insertChar(pos, c, change);
288 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
289 LyXFont const & font, Change change)
291 pimpl_->insertChar(pos, c, change);
296 void Paragraph::insertInset(pos_type pos, InsetBase * inset, Change change)
298 pimpl_->insertInset(pos, inset, change);
302 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
303 LyXFont const & font, Change change)
305 pimpl_->insertInset(pos, inset, change);
310 bool Paragraph::insetAllowed(InsetOld_code code)
312 return !pimpl_->inset_owner || pimpl_->inset_owner->insetAllowed(code);
316 InsetBase * Paragraph::getInset(pos_type pos)
318 BOOST_ASSERT(pos < size());
319 return insetlist.get(pos);
323 InsetBase 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,
335 lyxerr << " pos: " << pos << " size: " << size() << endl;
336 BOOST_ASSERT(pos <= size());
339 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
340 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
341 for (; cit != end; ++cit)
342 if (cit->pos() >= pos)
348 if (pos == size() && !empty())
349 return getFontSettings(bparams, pos - 1);
351 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
355 lyx::pos_type Paragraph::getEndPosOfFontSpan(lyx::pos_type pos) const
357 BOOST_ASSERT(pos <= size());
359 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
360 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
361 for (; cit != end; ++cit)
362 if (cit->pos() >= pos)
365 // This should not happen, but if so, we take no chances.
366 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
372 // Gets uninstantiated font setting at position 0
373 LyXFont const Paragraph::getFirstFontSettings() const
375 if (!empty() && !pimpl_->fontlist.empty())
376 return pimpl_->fontlist[0].font();
378 return LyXFont(LyXFont::ALL_INHERIT);
382 // Gets the fully instantiated font at a given position in a paragraph
383 // This is basically the same function as LyXText::GetFont() in text2.C.
384 // The difference is that this one is used for generating the LaTeX file,
385 // and thus cosmetic "improvements" are disallowed: This has to deliver
386 // the true picture of the buffer. (Asger)
387 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
388 LyXFont const & outerfont) const
390 BOOST_ASSERT(pos >= 0);
392 LyXLayout_ptr const & lout = layout();
394 pos_type const body_pos = beginOfBody();
398 layoutfont = lout->labelfont;
400 layoutfont = lout->font;
402 LyXFont font = getFontSettings(bparams, pos);
403 font.realize(layoutfont);
404 font.realize(outerfont);
405 font.realize(bparams.getLyXTextClass().defaultfont());
411 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams,
412 LyXFont const & outerfont) const
414 LyXFont tmpfont = layout()->labelfont;
415 tmpfont.setLanguage(getParLanguage(bparams));
416 tmpfont.realize(outerfont);
417 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
422 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams,
423 LyXFont const & outerfont) const
425 LyXFont tmpfont = layout()->font;
426 tmpfont.setLanguage(getParLanguage(bparams));
427 tmpfont.realize(outerfont);
428 tmpfont.realize(bparams.getLyXTextClass().defaultfont());
433 /// Returns the height of the highest font in range
435 Paragraph::highestFontInRange(pos_type startpos, pos_type endpos,
436 LyXFont_size def_size) const
438 if (pimpl_->fontlist.empty())
441 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
442 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
443 for (; end_it != end; ++end_it) {
444 if (end_it->pos() >= endpos)
451 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
452 for (; cit != end; ++cit) {
453 if (cit->pos() >= startpos)
457 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
458 for (; cit != end_it; ++cit) {
459 LyXFont::FONT_SIZE size = cit->font().size();
460 if (size == LyXFont::INHERIT_SIZE)
462 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
469 Paragraph::value_type
470 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
472 value_type c = getChar(pos);
473 if (!lyxrc.rtl_support)
503 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
510 void Paragraph::setFont(pos_type pos, LyXFont const & font)
512 BOOST_ASSERT(pos <= size());
514 // First, reduce font against layout/label font
515 // Update: The setCharFont() routine in text2.C already
516 // reduces font, so we don't need to do that here. (Asger)
517 // No need to simplify this because it will disappear
518 // in a new kernel. (Asger)
519 // Next search font table
521 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
522 Pimpl::FontList::iterator it = beg;
523 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
524 for (; it != endit; ++it) {
525 if (it->pos() >= pos)
528 unsigned int i = distance(beg, it);
529 bool notfound = (it == endit);
531 if (!notfound && pimpl_->fontlist[i].font() == font)
534 bool begin = pos == 0 || notfound ||
535 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
536 // Is position pos is a beginning of a font block?
537 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
538 // Is position pos is the end of a font block?
539 if (begin && end) { // A single char block
540 if (i + 1 < pimpl_->fontlist.size() &&
541 pimpl_->fontlist[i + 1].font() == font) {
542 // Merge the singleton block with the next block
543 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
544 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
545 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
546 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
547 // Merge the singleton block with the previous block
548 pimpl_->fontlist[i - 1].pos(pos);
549 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
551 pimpl_->fontlist[i].font(font);
553 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
554 pimpl_->fontlist[i - 1].pos(pos);
556 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
557 Pimpl::FontTable(pos, font));
559 pimpl_->fontlist[i].pos(pos - 1);
560 if (!(i + 1 < pimpl_->fontlist.size() &&
561 pimpl_->fontlist[i + 1].font() == font))
562 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
563 Pimpl::FontTable(pos, font));
564 } else { // The general case. The block is splitted into 3 blocks
565 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
566 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
567 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
568 Pimpl::FontTable(pos, font));
573 void Paragraph::makeSameLayout(Paragraph const & par)
575 layout(par.layout());
577 params() = par.params();
581 int Paragraph::stripLeadingSpaces()
587 while (!empty() && (isNewline(0) || isLineSeparator(0))) {
588 pimpl_->eraseIntern(0);
596 bool Paragraph::hasSameLayout(Paragraph const & par) const
598 return par.layout() == layout() && params().sameLayout(par.params());
602 Paragraph::depth_type Paragraph::getDepth() const
604 return params().depth();
608 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
610 if (layout()->isEnvironment())
611 return params().depth() + 1;
613 return params().depth();
617 char Paragraph::getAlign() const
619 return params().align();
623 string const & Paragraph::getLabelstring() const
625 return params().labelString();
629 // the next two functions are for the manual labels
630 string const Paragraph::getLabelWidthString() const
632 if (!params().labelWidthString().empty())
633 return params().labelWidthString();
635 return _("Senseless with this layout!");
639 void Paragraph::setLabelWidthString(string const & s)
641 params().labelWidthString(s);
645 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
648 params().labelWidthString(string());
649 params().align(LYX_ALIGN_LAYOUT);
650 params().spacing(Spacing(Spacing::Default));
654 pos_type Paragraph::beginOfBody() const
656 return begin_of_body_;
660 void Paragraph::setBeginOfBody()
662 if (layout()->labeltype != LABEL_MANUAL) {
667 // Unroll the first two cycles of the loop
668 // and remember the previous character to
669 // remove unnecessary getChar() calls
671 pos_type end = size();
672 if (i < end && !isNewline(i)) {
674 char previous_char = 0;
677 previous_char = text_[i];
680 while (i < end && previous_char != ' ') {
685 previous_char = temp;
695 // returns -1 if inset not found
696 int Paragraph::getPositionOfInset(InsetBase const * inset) const
699 InsetList::const_iterator it = insetlist.begin();
700 InsetList::const_iterator end = insetlist.end();
701 for (; it != end; ++it)
702 if (it->inset == inset)
708 InsetBibitem * Paragraph::bibitem() const
710 if (!insetlist.empty()) {
711 InsetBase * inset = insetlist.begin()->inset;
712 if (inset->lyxCode() == InsetBase::BIBTEX_CODE)
713 return static_cast<InsetBibitem *>(inset);
719 bool Paragraph::forceDefaultParagraphs() const
721 return inInset() && inInset()->forceDefaultParagraphs(inInset());
725 bool Paragraph::autoBreakRows() const
727 return inInset() && static_cast<InsetText *>(inInset())->getAutoBreakRows();
733 // paragraphs inside floats need different alignment tags to avoid
736 bool noTrivlistCentering(InsetBase::Code code)
738 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
742 string correction(string const & orig)
744 if (orig == "flushleft")
745 return "raggedright";
746 if (orig == "flushright")
748 if (orig == "center")
754 string const corrected_env(string const & suffix, string const & env,
755 InsetBase::Code code)
757 string output = suffix + "{";
758 if (noTrivlistCentering(code))
759 output += correction(env);
768 // This could go to ParagraphParameters if we want to
769 int Paragraph::startTeXParParams(BufferParams const & bparams,
770 ostream & os, bool moving_arg) const
774 if (params().noindent()) {
779 switch (params().align()) {
781 case LYX_ALIGN_BLOCK:
782 case LYX_ALIGN_LAYOUT:
783 case LYX_ALIGN_SPECIAL:
786 case LYX_ALIGN_RIGHT:
787 case LYX_ALIGN_CENTER:
795 switch (params().align()) {
797 case LYX_ALIGN_BLOCK:
798 case LYX_ALIGN_LAYOUT:
799 case LYX_ALIGN_SPECIAL:
801 case LYX_ALIGN_LEFT: {
803 if (getParLanguage(bparams)->babel() != "hebrew")
804 output = corrected_env("\\begin", "flushleft", ownerCode());
806 output = corrected_env("\\begin", "flushright", ownerCode());
808 column += output.size();
810 } case LYX_ALIGN_RIGHT: {
812 if (getParLanguage(bparams)->babel() != "hebrew")
813 output = corrected_env("\\begin", "flushright", ownerCode());
815 output = corrected_env("\\begin", "flushleft", ownerCode());
817 column += output.size();
819 } case LYX_ALIGN_CENTER: {
821 output = corrected_env("\\begin", "center", ownerCode());
823 column += output.size();
832 // This could go to ParagraphParameters if we want to
833 int Paragraph::endTeXParParams(BufferParams const & bparams,
834 ostream & os, bool moving_arg) const
838 switch (params().align()) {
840 case LYX_ALIGN_BLOCK:
841 case LYX_ALIGN_LAYOUT:
842 case LYX_ALIGN_SPECIAL:
845 case LYX_ALIGN_RIGHT:
846 case LYX_ALIGN_CENTER:
854 switch (params().align()) {
856 case LYX_ALIGN_BLOCK:
857 case LYX_ALIGN_LAYOUT:
858 case LYX_ALIGN_SPECIAL:
860 case LYX_ALIGN_LEFT: {
862 if (getParLanguage(bparams)->babel() != "hebrew")
863 output = corrected_env("\\par\\end", "flushleft", ownerCode());
865 output = corrected_env("\\par\\end", "flushright", ownerCode());
867 column += output.size();
869 } case LYX_ALIGN_RIGHT: {
871 if (getParLanguage(bparams)->babel() != "hebrew")
872 output = corrected_env("\\par\\end", "flushright", ownerCode());
874 output = corrected_env("\\par\\end", "flushleft", ownerCode());
876 column += output.size();
878 } case LYX_ALIGN_CENTER: {
880 output = corrected_env("\\par\\end", "center", ownerCode());
882 column += output.size();
891 // This one spits out the text of the paragraph
892 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
893 BufferParams const & bparams,
894 LyXFont const & outerfont,
895 ostream & os, TexRow & texrow,
896 OutputParams const & runparams) const
898 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
900 bool return_value = false;
904 // well we have to check if we are in an inset with unlimited
905 // length (all in one row) if that is true then we don't allow
906 // any special options in the paragraph and also we don't allow
907 // any environment other then "Standard" to be valid!
908 bool asdefault = forceDefaultParagraphs();
911 style = bparams.getLyXTextClass().defaultLayout();
918 // Maybe we have to create a optional argument.
919 pos_type body_pos = beginOfBody();
920 unsigned int column = 0;
923 // the optional argument is kept in curly brackets in
924 // case it contains a ']'
927 basefont = getLabelFont(bparams, outerfont);
929 basefont = getLayoutFont(bparams, outerfont);
932 bool const moving_arg = runparams.moving_arg | style->needprotect;
934 // Which font is currently active?
935 LyXFont running_font(basefont);
936 // Do we have an open font change?
937 bool open_font = false;
939 Change::Type running_change = Change::UNCHANGED;
941 texrow.start(id(), 0);
943 // if the paragraph is empty, the loop will not be entered at all
945 if (style->isCommand()) {
950 column += startTeXParParams(bparams, os, moving_arg);
953 for (pos_type i = 0; i < size(); ++i) {
955 // First char in paragraph or after label?
959 column += running_font.latexWriteEndChanges(os, basefont, basefont);
962 basefont = getLayoutFont(bparams, outerfont);
963 running_font = basefont;
967 if (style->isCommand()) {
973 column += startTeXParParams(bparams, os,
977 value_type c = getChar(i);
979 // Fully instantiated font
980 LyXFont font = getFont(bparams, i, outerfont);
982 LyXFont const last_font = running_font;
984 // Spaces at end of font change are simulated to be
985 // outside font change, i.e. we write "\textXX{text} "
986 // rather than "\textXX{text }". (Asger)
987 if (open_font && c == ' ' && i <= size() - 2) {
988 LyXFont const & next_font = getFont(bparams, i + 1, outerfont);
989 if (next_font != running_font && next_font != font) {
994 // We end font definition before blanks
996 (font != running_font ||
997 font.language() != running_font.language()))
999 column += running_font.latexWriteEndChanges(os,
1001 (i == body_pos-1) ? basefont : font);
1002 running_font = basefont;
1006 // Blanks are printed before start of fontswitch
1008 // Do not print the separation of the optional argument
1009 if (i != body_pos - 1) {
1010 pimpl_->simpleTeXBlanks(os, texrow, i,
1011 column, font, *style);
1015 // Do we need to change font?
1016 if ((font != running_font ||
1017 font.language() != running_font.language()) &&
1020 column += font.latexWriteStartChanges(os, basefont,
1022 running_font = font;
1026 Change::Type change = pimpl_->lookupChange(i);
1028 column += Changes::latexMarkChange(os, running_change, change);
1029 running_change = change;
1031 OutputParams rp = runparams;
1032 rp.moving_arg = moving_arg;
1033 rp.free_spacing = style->free_spacing;
1034 rp.lang = font.language()->babel();
1035 rp.intitle = style->intitle;
1036 pimpl_->simpleTeXSpecialChars(buf, bparams,
1039 basefont, outerfont, open_font,
1041 *style, i, column, c);
1044 column += Changes::latexMarkChange(os,
1045 running_change, Change::UNCHANGED);
1047 // If we have an open font definition, we have to close it
1049 #ifdef FIXED_LANGUAGE_END_DETECTION
1052 .latexWriteEndChanges(os, basefont,
1053 next_->getFont(bparams,
1056 running_font.latexWriteEndChanges(os, basefont,
1060 #ifdef WITH_WARNINGS
1061 //#warning For now we ALWAYS have to close the foreign font settings if they are
1062 //#warning there as we start another \selectlanguage with the next paragraph if
1063 //#warning we are in need of this. This should be fixed sometime (Jug)
1065 running_font.latexWriteEndChanges(os, basefont, basefont);
1069 // Needed if there is an optional argument but no contents.
1070 if (body_pos > 0 && body_pos == size()) {
1072 return_value = false;
1076 column += endTeXParParams(bparams, os, moving_arg);
1079 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1080 return return_value;
1086 // checks, if newcol chars should be put into this line
1087 // writes newline, if necessary.
1088 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1089 string::size_type newcol)
1092 if (colcount > lyxrc.ascii_linelen) {
1094 colcount = newcol; // assume write after this call
1109 string tag_name(PAR_TAG const & pt) {
1111 case PAR_NONE: return "!-- --";
1112 case TT: return "tt";
1113 case SF: return "sf";
1114 case BF: return "bf";
1115 case IT: return "it";
1116 case SL: return "sl";
1117 case EM: return "em";
1124 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1126 p1 = static_cast<PAR_TAG>(p1 | p2);
1131 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1133 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1139 // Handle internal paragraph parsing -- layout already processed.
1140 void Paragraph::simpleLinuxDocOnePar(Buffer const & buf,
1142 LyXFont const & outerfont,
1143 OutputParams const & runparams,
1144 lyx::depth_type /*depth*/) const
1146 LyXLayout_ptr const & style = layout();
1148 string::size_type char_line_count = 5; // Heuristic choice ;-)
1150 // gets paragraph main font
1153 if (style->labeltype == LABEL_MANUAL) {
1154 font_old = style->labelfont;
1157 font_old = style->font;
1161 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1162 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1163 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
1166 stack<PAR_TAG> tag_state;
1167 // parsing main loop
1168 for (pos_type i = 0; i < size(); ++i) {
1170 PAR_TAG tag_close = PAR_NONE;
1171 list < PAR_TAG > tag_open;
1173 LyXFont const font = getFont(buf.params(), i, outerfont);
1175 if (font_old.family() != font.family()) {
1176 switch (family_type) {
1177 case LyXFont::SANS_FAMILY:
1180 case LyXFont::TYPEWRITER_FAMILY:
1187 family_type = font.family();
1189 switch (family_type) {
1190 case LyXFont::SANS_FAMILY:
1191 tag_open.push_back(SF);
1193 case LyXFont::TYPEWRITER_FAMILY:
1194 tag_open.push_back(TT);
1201 if (font_old.series() != font.series()) {
1202 switch (series_type) {
1203 case LyXFont::BOLD_SERIES:
1210 series_type = font.series();
1212 switch (series_type) {
1213 case LyXFont::BOLD_SERIES:
1214 tag_open.push_back(BF);
1222 if (font_old.shape() != font.shape()) {
1223 switch (shape_type) {
1224 case LyXFont::ITALIC_SHAPE:
1227 case LyXFont::SLANTED_SHAPE:
1234 shape_type = font.shape();
1236 switch (shape_type) {
1237 case LyXFont::ITALIC_SHAPE:
1238 tag_open.push_back(IT);
1240 case LyXFont::SLANTED_SHAPE:
1241 tag_open.push_back(SL);
1248 if (font_old.emph() != font.emph()) {
1249 if (font.emph() == LyXFont::ON) {
1250 tag_open.push_back(EM);
1259 list < PAR_TAG > temp;
1260 while (!tag_state.empty() && tag_close) {
1261 PAR_TAG k = tag_state.top();
1263 os << "</" << tag_name(k) << '>';
1270 for(list< PAR_TAG >::const_iterator j = temp.begin();
1271 j != temp.end(); ++j) {
1273 os << '<' << tag_name(*j) << '>';
1276 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1277 j != tag_open.end(); ++j) {
1279 os << '<' << tag_name(*j) << '>';
1282 char c = getChar(i);
1285 if (c == Paragraph::META_INSET) {
1286 getInset(i)->linuxdoc(buf, os, runparams);
1291 if (style->latexparam() == "CDATA") {
1292 // "TeX"-Mode on == > SGML-Mode on.
1299 boost::tie(ws, str) = sgml::escapeChar(c);
1300 if (ws && !isFreeSpacing()) {
1301 // in freespacing mode, spaces are
1302 // non-breaking characters
1303 if (desc_on) { // if char is ' ' then...
1305 sgmlLineBreak(os, char_line_count, 6);
1309 sgmlLineBreak(os, char_line_count, 1);
1314 char_line_count += str.length();
1320 while (!tag_state.empty()) {
1321 os << "</" << tag_name(tag_state.top()) << '>';
1325 // resets description flag correctly
1327 // <tag> not closed...
1328 sgmlLineBreak(os, char_line_count, 6);
1334 string Paragraph::getDocbookId() const
1336 for (pos_type i = 0; i < size(); ++i) {
1338 InsetBase const * inset = getInset(i);
1339 InsetBase::Code lyx_code = inset->lyxCode();
1340 if (lyx_code == InsetBase::LABEL_CODE) {
1341 return static_cast<InsetCommand const *>(inset)->getContents();
1350 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1352 LyXFont const & outerfont,
1353 OutputParams const & runparams,
1354 lyx::depth_type depth) const
1356 bool emph_flag = false;
1358 LyXLayout_ptr const & style = layout();
1359 LyXLayout_ptr const & defaultstyle =
1360 buf.params().getLyXTextClass().defaultLayout();
1363 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1365 int char_line_count = depth;
1366 bool label_closed = true;
1367 bool para_closed = true;
1369 if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1371 Counters & counters = buf.params().getLyXTextClass().counters();
1372 if (!style->free_spacing)
1373 os << string(depth,' ');
1374 if (!style->labeltag().empty()) {
1375 os << "<" << style->labeltag() << ">\n";
1376 label_closed = false;
1378 if (!defaultstyle->latexparam().empty()) {
1379 counters.step("para");
1380 ls = tostr(counters.value("para"));
1382 + subst(defaultstyle->latexparam(), "#", ls) + '"';
1384 os << "<" << style->itemtag() << ">\n"
1385 << string(depth, ' ') << "<"
1386 << defaultstyle->latexname() << ls << ">\n";
1387 para_closed = false;
1391 // parsing main loop
1392 for (pos_type i = 0; i < size(); ++i) {
1393 LyXFont font = getFont(buf.params(), i, outerfont);
1395 // handle <emphasis> tag
1396 if (font_old.emph() != font.emph()) {
1397 if (font.emph() == LyXFont::ON) {
1398 if (style->latexparam() == "CDATA")
1401 if (style->latexparam() == "CDATA")
1405 if (style->latexparam() == "CDATA")
1407 os << "</emphasis>";
1408 if (style->latexparam() == "CDATA")
1415 InsetBase const * inset = getInset(i);
1416 if (style->latexparam() == "CDATA")
1418 inset->docbook(buf, os, runparams);
1419 if (style->latexparam() == "CDATA")
1422 char c = getChar(i);
1425 boost::tie(ws, str) = sgml::escapeChar(c);
1427 if (style->pass_thru) {
1429 } else if (isFreeSpacing() || c != ' ') {
1431 } else if (!style->labeltag().empty() && !label_closed) {
1433 os << "\n</" << style->labeltag() << "><"
1434 << style->itemtag() << "><"
1435 << defaultstyle->latexname() << ">";
1436 label_closed = true;
1437 para_closed = false;
1446 if (style->latexparam() == "CDATA")
1448 os << "</emphasis>";
1449 if (style->latexparam() == "CDATA")
1453 // resets description flag correctly
1454 if (!label_closed) {
1455 // <term> not closed...
1456 os << "</" << style->labeltag() << ">\n<"
1457 << style->itemtag() << "><"
1458 << defaultstyle->latexname() << "> ";
1461 os << "\n" << string(depth, ' ') << "</"
1462 << defaultstyle->latexname() << ">\n";
1464 if (style->free_spacing)
1471 /// return true if the char is a meta-character for an inset
1473 bool IsInsetChar(char c)
1475 return (c == Paragraph::META_INSET);
1482 bool Paragraph::isHfill(pos_type pos) const
1485 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
1489 bool Paragraph::isNewline(pos_type pos) const
1492 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1496 bool Paragraph::isSeparator(pos_type pos) const
1498 return IsSeparatorChar(getChar(pos));
1502 bool Paragraph::isLineSeparator(pos_type pos) const
1504 value_type const c = getChar(pos);
1505 return IsLineSeparatorChar(c)
1506 || (IsInsetChar(c) && getInset(pos) &&
1507 getInset(pos)->isLineSeparator());
1511 bool Paragraph::isKomma(pos_type pos) const
1513 return IsKommaChar(getChar(pos));
1517 /// Used by the spellchecker
1518 bool Paragraph::isLetter(pos_type pos) const
1520 value_type const c = getChar(pos);
1521 if (IsLetterChar(c))
1524 return getInset(pos)->isLetter();
1525 // We want to pass the ' and escape chars to ispell
1526 string const extra = lyxrc.isp_esc_chars + '\'';
1527 return contains(extra, c);
1531 bool Paragraph::isWord(pos_type pos) const
1534 return getInset(pos)->isLetter();
1535 value_type const c = getChar(pos);
1536 return !(IsSeparatorChar(c)
1543 Paragraph::getParLanguage(BufferParams const & bparams) const
1546 return getFirstFontSettings().language();
1547 #ifdef WITH_WARNINGS
1548 #warning FIXME we should check the prev par as well (Lgb)
1550 return bparams.language;
1554 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1556 return lyxrc.rtl_support
1557 && getParLanguage(bparams)->RightToLeft()
1558 && ownerCode() != InsetBase::ERT_CODE;
1562 void Paragraph::changeLanguage(BufferParams const & bparams,
1563 Language const * from, Language const * to)
1565 for (pos_type i = 0; i < size(); ++i) {
1566 LyXFont font = getFontSettings(bparams, i);
1567 if (font.language() == from) {
1568 font.setLanguage(to);
1575 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1577 Language const * doc_language = bparams.language;
1578 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1579 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1581 for (; cit != end; ++cit)
1582 if (cit->font().language() != ignore_language &&
1583 cit->font().language() != latex_language &&
1584 cit->font().language() != doc_language)
1590 // Convert the paragraph to a string.
1591 // Used for building the table of contents
1592 string const Paragraph::asString(Buffer const & buffer, bool label) const
1594 OutputParams runparams;
1595 return asString(buffer, runparams, label);
1599 string const Paragraph::asString(Buffer const & buffer,
1600 OutputParams const & runparams,
1605 if (label && !params().labelString().empty())
1606 s += params().labelString() + ' ';
1608 for (pos_type i = 0; i < size(); ++i) {
1609 value_type c = getChar(i);
1612 else if (c == META_INSET &&
1613 getInset(i)->lyxCode() == InsetBase::MATH_CODE) {
1615 getInset(i)->plaintext(buffer, os, runparams);
1616 s += subst(STRCONV(os.str()),'\n',' ');
1622 // This should really be done by the caller and not here.
1623 string ret = asString(buffer, runparams, 0, size(), label);
1624 return subst(ret, '\n', ' ');
1629 string const Paragraph::asString(Buffer const & buffer,
1630 pos_type beg, pos_type end, bool label) const
1633 OutputParams const runparams;
1634 return asString(buffer, runparams, beg, end, label);
1638 string const Paragraph::asString(Buffer const & buffer,
1639 OutputParams const & runparams,
1640 pos_type beg, pos_type end, bool label) const
1644 if (beg == 0 && label && !params().labelString().empty())
1645 os << params().labelString() << ' ';
1647 for (pos_type i = beg; i < end; ++i) {
1648 value_type const c = getUChar(buffer.params(), i);
1651 else if (c == META_INSET)
1652 getInset(i)->plaintext(buffer, os, runparams);
1659 void Paragraph::setInsetOwner(UpdatableInset * inset)
1661 pimpl_->inset_owner = inset;
1665 void Paragraph::setContentsFromPar(Paragraph const & par)
1667 pimpl_->setContentsFromPar(par);
1671 void Paragraph::trackChanges(Change::Type type)
1673 pimpl_->trackChanges(type);
1677 void Paragraph::untrackChanges()
1679 pimpl_->untrackChanges();
1683 void Paragraph::cleanChanges()
1685 pimpl_->cleanChanges();
1689 Change::Type Paragraph::lookupChange(lyx::pos_type pos) const
1691 BOOST_ASSERT(empty() || pos < size());
1692 return pimpl_->lookupChange(pos);
1696 Change const Paragraph::lookupChangeFull(lyx::pos_type pos) const
1698 BOOST_ASSERT(empty() || pos < size());
1699 return pimpl_->lookupChangeFull(pos);
1703 bool Paragraph::isChanged(pos_type start, pos_type end) const
1705 return pimpl_->isChanged(start, end);
1709 bool Paragraph::isChangeEdited(pos_type start, pos_type end) const
1711 return pimpl_->isChangeEdited(start, end);
1715 void Paragraph::setChange(lyx::pos_type pos, Change::Type type)
1717 pimpl_->setChange(pos, type);
1721 void Paragraph::markErased()
1723 pimpl_->markErased();
1727 void Paragraph::acceptChange(pos_type start, pos_type end)
1729 return pimpl_->acceptChange(start, end);
1733 void Paragraph::rejectChange(pos_type start, pos_type end)
1735 return pimpl_->rejectChange(start, end);
1739 int Paragraph::id() const
1745 LyXLayout_ptr const & Paragraph::layout() const
1751 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1753 layout_ = new_layout;
1757 UpdatableInset * Paragraph::inInset() const
1759 return pimpl_->inset_owner;
1763 InsetBase::Code Paragraph::ownerCode() const
1765 return pimpl_->inset_owner
1766 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1770 void Paragraph::clearContents()
1776 void Paragraph::setChar(pos_type pos, value_type c)
1782 ParagraphParameters & Paragraph::params()
1784 return pimpl_->params;
1788 ParagraphParameters const & Paragraph::params() const
1790 return pimpl_->params;
1794 bool Paragraph::isFreeSpacing() const
1796 if (layout()->free_spacing)
1799 // for now we just need this, later should we need this in some
1800 // other way we can always add a function to InsetBase too.
1801 return ownerCode() == InsetBase::ERT_CODE;
1805 bool Paragraph::allowEmpty() const
1807 if (layout()->keepempty)
1809 return ownerCode() == InsetBase::ERT_CODE;
1813 RowList::iterator Paragraph::getRow(pos_type pos)
1815 RowList::iterator rit = rows.end();
1816 RowList::iterator const begin = rows.begin();
1818 for (--rit; rit != begin && rit->pos() > pos; --rit)
1825 RowList::const_iterator Paragraph::getRow(pos_type pos) const
1827 RowList::const_iterator rit = rows.end();
1828 RowList::const_iterator const begin = rows.begin();
1830 for (--rit; rit != begin && rit->pos() > pos; --rit)
1837 size_t Paragraph::row(pos_type pos) const
1839 RowList::const_iterator rit = rows.end();
1840 RowList::const_iterator const begin = rows.begin();
1842 for (--rit; rit != begin && rit->pos() > pos; --rit)
1849 unsigned char Paragraph::transformChar(unsigned char c, pos_type pos) const
1851 if (!Encodings::is_arabic(c))
1852 if (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 && IsDigit(c))
1853 return c + (0xb0 - '0');
1857 unsigned char const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1858 unsigned char next_char = ' ';
1860 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1861 unsigned char const par_char = getChar(i);
1862 if (!Encodings::IsComposeChar_arabic(par_char)) {
1863 next_char = par_char;
1868 if (Encodings::is_arabic(next_char)) {
1869 if (Encodings::is_arabic(prev_char) &&
1870 !Encodings::is_arabic_special(prev_char))
1871 return Encodings::TransformChar(c, Encodings::FORM_MEDIAL);
1873 return Encodings::TransformChar(c, Encodings::FORM_INITIAL);
1875 if (Encodings::is_arabic(prev_char) &&
1876 !Encodings::is_arabic_special(prev_char))
1877 return Encodings::TransformChar(c, Encodings::FORM_FINAL);
1879 return Encodings::TransformChar(c, Encodings::FORM_ISOLATED);