3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
20 #include "paragraph.h"
21 #include "paragraph_pimpl.h"
24 #include "bufferparams.h"
30 #include "LaTeXFeatures.h"
35 #include "outputparams.h"
36 #include "output_latex.h"
37 #include "paragraph_funcs.h"
39 #include "rowpainter.h"
45 #include "frontends/FontMetrics.h"
47 #include "insets/insetbibitem.h"
48 #include "insets/insetoptarg.h"
50 #include "support/lstrings.h"
51 #include "support/textutils.h"
52 #include "support/convert.h"
53 #include "support/unicode.h"
55 #include <boost/bind.hpp>
68 using std::ostringstream;
72 using support::contains;
73 using support::rsplit;
76 Paragraph::Paragraph()
77 : begin_of_body_(0), pimpl_(new Paragraph::Pimpl(this))
84 Paragraph::Paragraph(Paragraph const & par)
85 : itemdepth(par.itemdepth), insetlist(par.insetlist),
87 text_(par.text_), begin_of_body_(par.begin_of_body_),
88 pimpl_(new Paragraph::Pimpl(*par.pimpl_, this))
90 //lyxerr << "Paragraph::Paragraph(Paragraph const&)" << endl;
91 InsetList::iterator it = insetlist.begin();
92 InsetList::iterator end = insetlist.end();
93 for (; it != end; ++it)
94 it->inset = it->inset->clone().release();
98 Paragraph & Paragraph::operator=(Paragraph const & par)
100 // needed as we will destroy the pimpl_ before copying it
102 itemdepth = par.itemdepth;
104 insetlist = par.insetlist;
105 InsetList::iterator it = insetlist.begin();
106 InsetList::iterator end = insetlist.end();
107 for (; it != end; ++it)
108 it->inset = it->inset->clone().release();
110 layout_ = par.layout();
112 begin_of_body_ = par.begin_of_body_;
115 pimpl_ = new Pimpl(*par.pimpl_, this);
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);
159 for (pos_type i = 0; i <= size(); ++i) {
161 Change change = pimpl_->lookupChange(i);
162 Changes::lyxMarkChange(os, column, running_change, change);
163 running_change = change;
168 // Write font changes
169 LyXFont font2 = getFontSettings(bparams, i);
170 if (font2 != font1) {
171 font2.lyxWriteChanges(font1, os);
176 value_type const c = getChar(i);
180 InsetBase const * inset = getInset(i);
182 if (inset->directWrite()) {
183 // international char, let it write
184 // code directly so it's shorter in
186 inset->write(buf, os);
190 os << "\\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.
217 std::vector<char> tmp = ucs4_to_utf8(c);
221 lyxerr << "ERROR (Paragraph::writeFile):"
222 " NULL char in structure." << endl;
228 os << "\n\\end_layout\n";
232 void Paragraph::validate(LaTeXFeatures & features) const
234 pimpl_->validate(features, *layout());
238 bool Paragraph::eraseChar(pos_type pos, bool trackChanges)
240 return pimpl_->eraseChar(pos, trackChanges);
244 int Paragraph::eraseChars(pos_type start, pos_type end, bool trackChanges)
246 return pimpl_->eraseChars(start, end, trackChanges);
250 void Paragraph::insert(pos_type start, docstring const & str,
251 LyXFont const & font, Change const & change)
253 for (size_t i = 0, n = str.size(); i != n ; ++i)
254 insertChar(start + i, str[i], font, change);
258 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
261 pimpl_->insertChar(pos, c, Change(trackChanges ?
262 Change::INSERTED : Change::UNCHANGED));
266 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
267 LyXFont const & font, bool trackChanges)
269 pimpl_->insertChar(pos, c, Change(trackChanges ?
270 Change::INSERTED : Change::UNCHANGED));
275 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
276 LyXFont const & font, Change const & change)
278 pimpl_->insertChar(pos, c, change);
283 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
284 Change const & change)
286 pimpl_->insertInset(pos, inset, change);
290 void Paragraph::insertInset(pos_type pos, InsetBase * inset,
291 LyXFont const & font, Change const & change)
293 pimpl_->insertInset(pos, inset, change);
298 bool Paragraph::insetAllowed(InsetBase_code code)
300 return !pimpl_->inset_owner || pimpl_->inset_owner->insetAllowed(code);
304 // Gets uninstantiated font setting at position.
305 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
309 lyxerr << " pos: " << pos << " size: " << size() << endl;
310 BOOST_ASSERT(pos <= size());
313 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
314 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
315 for (; cit != end; ++cit)
316 if (cit->pos() >= pos)
322 if (pos == size() && !empty())
323 return getFontSettings(bparams, pos - 1);
325 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
329 FontSpan Paragraph::fontSpan(pos_type pos) const
331 BOOST_ASSERT(pos <= size());
334 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
335 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
336 for (; cit != end; ++cit) {
337 if (cit->pos() >= pos) {
338 if (pos >= beginOfBody())
339 return FontSpan(std::max(start, beginOfBody()),
342 return FontSpan(start,
343 std::min(beginOfBody() - 1,
346 start = cit->pos() + 1;
349 // This should not happen, but if so, we take no chances.
350 //lyxerr << "Paragraph::getEndPosOfFontSpan: This should not happen!"
352 return FontSpan(pos, pos);
356 // Gets uninstantiated font setting at position 0
357 LyXFont const Paragraph::getFirstFontSettings(BufferParams const & bparams) const
359 if (!empty() && !pimpl_->fontlist.empty())
360 return pimpl_->fontlist[0].font();
362 return LyXFont(LyXFont::ALL_INHERIT, bparams.language);
366 // Gets the fully instantiated font at a given position in a paragraph
367 // This is basically the same function as LyXText::GetFont() in text2.C.
368 // The difference is that this one is used for generating the LaTeX file,
369 // and thus cosmetic "improvements" are disallowed: This has to deliver
370 // the true picture of the buffer. (Asger)
371 LyXFont const Paragraph::getFont(BufferParams const & bparams, pos_type pos,
372 LyXFont const & outerfont) const
374 BOOST_ASSERT(pos >= 0);
376 LyXLayout_ptr const & lout = layout();
378 pos_type const body_pos = beginOfBody();
382 layoutfont = lout->labelfont;
384 layoutfont = lout->font;
386 LyXFont font = getFontSettings(bparams, pos);
387 font.realize(layoutfont);
388 font.realize(outerfont);
389 font.realize(bparams.getFont());
395 LyXFont const Paragraph::getLabelFont
396 (BufferParams const & bparams, LyXFont const & outerfont) const
398 LyXFont tmpfont = layout()->labelfont;
399 tmpfont.setLanguage(getParLanguage(bparams));
400 tmpfont.realize(outerfont);
401 tmpfont.realize(bparams.getFont());
406 LyXFont const Paragraph::getLayoutFont
407 (BufferParams const & bparams, LyXFont const & outerfont) const
409 LyXFont tmpfont = layout()->font;
410 tmpfont.setLanguage(getParLanguage(bparams));
411 tmpfont.realize(outerfont);
412 tmpfont.realize(bparams.getFont());
417 /// Returns the height of the highest font in range
418 LyXFont_size Paragraph::highestFontInRange
419 (pos_type startpos, pos_type endpos, LyXFont_size def_size) const
421 if (pimpl_->fontlist.empty())
424 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
425 Pimpl::FontList::const_iterator const end = pimpl_->fontlist.end();
426 for (; end_it != end; ++end_it) {
427 if (end_it->pos() >= endpos)
434 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
435 for (; cit != end; ++cit) {
436 if (cit->pos() >= startpos)
440 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
441 for (; cit != end_it; ++cit) {
442 LyXFont::FONT_SIZE size = cit->font().size();
443 if (size == LyXFont::INHERIT_SIZE)
445 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
452 Paragraph::value_type
453 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
455 value_type c = getChar(pos);
456 if (!lyxrc.rtl_support)
486 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
493 void Paragraph::setFont(pos_type pos, LyXFont const & font)
495 BOOST_ASSERT(pos <= size());
497 // First, reduce font against layout/label font
498 // Update: The setCharFont() routine in text2.C already
499 // reduces font, so we don't need to do that here. (Asger)
500 // No need to simplify this because it will disappear
501 // in a new kernel. (Asger)
502 // Next search font table
504 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
505 Pimpl::FontList::iterator it = beg;
506 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
507 for (; it != endit; ++it) {
508 if (it->pos() >= pos)
511 size_t const i = distance(beg, it);
512 bool notfound = (it == endit);
514 if (!notfound && pimpl_->fontlist[i].font() == font)
517 bool begin = pos == 0 || notfound ||
518 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
519 // Is position pos is a beginning of a font block?
520 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
521 // Is position pos is the end of a font block?
522 if (begin && end) { // A single char block
523 if (i + 1 < pimpl_->fontlist.size() &&
524 pimpl_->fontlist[i + 1].font() == font) {
525 // Merge the singleton block with the next block
526 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
527 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
528 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
529 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
530 // Merge the singleton block with the previous block
531 pimpl_->fontlist[i - 1].pos(pos);
532 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
534 pimpl_->fontlist[i].font(font);
536 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
537 pimpl_->fontlist[i - 1].pos(pos);
539 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
540 Pimpl::FontTable(pos, font));
542 pimpl_->fontlist[i].pos(pos - 1);
543 if (!(i + 1 < pimpl_->fontlist.size() &&
544 pimpl_->fontlist[i + 1].font() == font))
545 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
546 Pimpl::FontTable(pos, font));
547 } else { // The general case. The block is splitted into 3 blocks
548 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
549 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
550 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
551 Pimpl::FontTable(pos, font));
556 void Paragraph::makeSameLayout(Paragraph const & par)
558 layout(par.layout());
560 params() = par.params();
564 bool Paragraph::stripLeadingSpaces(bool trackChanges)
572 while (pos < size() && (isNewline(pos) || isLineSeparator(pos))) {
573 if (eraseChar(pos, trackChanges))
579 return count > 0 || pos > 0;
583 bool Paragraph::hasSameLayout(Paragraph const & par) const
585 return par.layout() == layout() && params().sameLayout(par.params());
589 depth_type Paragraph::getDepth() const
591 return params().depth();
595 depth_type Paragraph::getMaxDepthAfter() const
597 if (layout()->isEnvironment())
598 return params().depth() + 1;
600 return params().depth();
604 char Paragraph::getAlign() const
606 if (params().align() == LYX_ALIGN_LAYOUT)
607 return layout()->align;
609 return params().align();
613 docstring const & Paragraph::getLabelstring() const
615 return params().labelString();
619 // the next two functions are for the manual labels
620 docstring const Paragraph::getLabelWidthString() const
622 if (!params().labelWidthString().empty())
623 return params().labelWidthString();
625 return _("Senseless with this layout!");
629 void Paragraph::setLabelWidthString(docstring const & s)
631 params().labelWidthString(s);
635 docstring const Paragraph::translateIfPossible(docstring const & s,
636 BufferParams const & bparams) const
638 if (!support::isAscii(s) || s.empty()) {
639 // This must be a user defined layout. We cannot translate
640 // this, since gettext accepts only ascii keys.
643 // Probably standard layout, try to translate
644 Messages & m = getMessages(getParLanguage(bparams)->code());
645 return m.get(to_ascii(s));
649 docstring Paragraph::expandLabel(LyXLayout_ptr const & layout,
650 BufferParams const & bparams, bool process_appendix) const
652 LyXTextClass const & tclass = bparams.getLyXTextClass();
655 if (process_appendix && params().appendix())
656 fmt = translateIfPossible(layout->labelstring_appendix(),
659 fmt = translateIfPossible(layout->labelstring(), bparams);
661 // handle 'inherited level parts' in 'fmt',
662 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
663 size_t const i = fmt.find('@', 0);
664 if (i != docstring::npos) {
665 size_t const j = fmt.find('@', i + 1);
666 if (j != docstring::npos) {
667 docstring parent(fmt, i + 1, j - i - 1);
669 docstring label = expandLabel(tclass[to_utf8(parent)], bparams);
670 fmt = docstring(fmt, 0, i) + label + docstring(fmt, j + 1, docstring::npos);
674 return tclass.counters().counterLabel(fmt);
678 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
681 params().labelWidthString(docstring());
682 params().align(LYX_ALIGN_LAYOUT);
683 params().spacing(Spacing(Spacing::Default));
687 pos_type Paragraph::beginOfBody() const
689 return begin_of_body_;
693 void Paragraph::setBeginOfBody()
695 if (layout()->labeltype != LABEL_MANUAL) {
700 // Unroll the first two cycles of the loop
701 // and remember the previous character to
702 // remove unnecessary getChar() calls
704 pos_type end = size();
705 if (i < end && !isNewline(i)) {
707 char_type previous_char = 0;
710 previous_char = text_[i];
713 while (i < end && previous_char != ' ') {
718 previous_char = temp;
728 // returns -1 if inset not found
729 int Paragraph::getPositionOfInset(InsetBase const * inset) const
732 InsetList::const_iterator it = insetlist.begin();
733 InsetList::const_iterator end = insetlist.end();
734 for (; it != end; ++it)
735 if (it->inset == inset)
741 InsetBibitem * Paragraph::bibitem() const
743 if (!insetlist.empty()) {
744 InsetBase * inset = insetlist.begin()->inset;
745 if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
746 return static_cast<InsetBibitem *>(inset);
752 bool Paragraph::forceDefaultParagraphs() const
754 return inInset() && inInset()->forceDefaultParagraphs(0);
760 // paragraphs inside floats need different alignment tags to avoid
763 bool noTrivlistCentering(InsetBase::Code code)
765 return code == InsetBase::FLOAT_CODE || code == InsetBase::WRAP_CODE;
769 string correction(string const & orig)
771 if (orig == "flushleft")
772 return "raggedright";
773 if (orig == "flushright")
775 if (orig == "center")
781 string const corrected_env(string const & suffix, string const & env,
782 InsetBase::Code code)
784 string output = suffix + "{";
785 if (noTrivlistCentering(code))
786 output += correction(env);
790 if (suffix == "\\begin")
796 void adjust_row_column(string const & str, TexRow & texrow, int & column)
798 if (!contains(str, "\n"))
799 column += str.size();
803 column = rsplit(str, tmp, '\n').size();
810 // This could go to ParagraphParameters if we want to
811 int Paragraph::startTeXParParams(BufferParams const & bparams,
812 odocstream & os, TexRow & texrow,
813 bool moving_arg) const
817 if (params().noindent()) {
822 switch (params().align()) {
824 case LYX_ALIGN_BLOCK:
825 case LYX_ALIGN_LAYOUT:
826 case LYX_ALIGN_SPECIAL:
829 case LYX_ALIGN_RIGHT:
830 case LYX_ALIGN_CENTER:
838 switch (params().align()) {
840 case LYX_ALIGN_BLOCK:
841 case LYX_ALIGN_LAYOUT:
842 case LYX_ALIGN_SPECIAL:
844 case LYX_ALIGN_LEFT: {
846 if (getParLanguage(bparams)->babel() != "hebrew")
847 output = corrected_env("\\begin", "flushleft", ownerCode());
849 output = corrected_env("\\begin", "flushright", ownerCode());
850 os << from_ascii(output);
851 adjust_row_column(output, texrow, column);
853 } case LYX_ALIGN_RIGHT: {
855 if (getParLanguage(bparams)->babel() != "hebrew")
856 output = corrected_env("\\begin", "flushright", ownerCode());
858 output = corrected_env("\\begin", "flushleft", ownerCode());
859 os << from_ascii(output);
860 adjust_row_column(output, texrow, column);
862 } case LYX_ALIGN_CENTER: {
864 output = corrected_env("\\begin", "center", ownerCode());
865 os << from_ascii(output);
866 adjust_row_column(output, texrow, column);
875 // This could go to ParagraphParameters if we want to
876 int Paragraph::endTeXParParams(BufferParams const & bparams,
877 odocstream & os, TexRow & texrow,
878 bool moving_arg) const
882 switch (params().align()) {
884 case LYX_ALIGN_BLOCK:
885 case LYX_ALIGN_LAYOUT:
886 case LYX_ALIGN_SPECIAL:
889 case LYX_ALIGN_RIGHT:
890 case LYX_ALIGN_CENTER:
898 switch (params().align()) {
900 case LYX_ALIGN_BLOCK:
901 case LYX_ALIGN_LAYOUT:
902 case LYX_ALIGN_SPECIAL:
904 case LYX_ALIGN_LEFT: {
906 if (getParLanguage(bparams)->babel() != "hebrew")
907 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
909 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
910 os << from_ascii(output);
911 adjust_row_column(output, texrow, column);
913 } case LYX_ALIGN_RIGHT: {
915 if (getParLanguage(bparams)->babel() != "hebrew")
916 output = corrected_env("\n\\par\\end", "flushright", ownerCode());
918 output = corrected_env("\n\\par\\end", "flushleft", ownerCode());
919 os << from_ascii(output);
920 adjust_row_column(output, texrow, column);
922 } case LYX_ALIGN_CENTER: {
924 output = corrected_env("\n\\par\\end", "center", ownerCode());
925 os << from_ascii(output);
926 adjust_row_column(output, texrow, column);
935 // This one spits out the text of the paragraph
936 bool Paragraph::simpleTeXOnePar(Buffer const & buf,
937 BufferParams const & bparams,
938 LyXFont const & outerfont,
939 odocstream & os, TexRow & texrow,
940 OutputParams const & runparams) const
942 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
944 bool return_value = false;
948 // well we have to check if we are in an inset with unlimited
949 // length (all in one row) if that is true then we don't allow
950 // any special options in the paragraph and also we don't allow
951 // any environment other than the default layout of the text class
953 bool asdefault = forceDefaultParagraphs();
956 style = bparams.getLyXTextClass().defaultLayout();
961 // Current base font for all inherited font changes, without any
962 // change caused by an individual character, except for the language:
963 // It is set to the language of the first character.
964 // As long as we are in the label, this font is the base font of the
965 // label. Before the first body character it is set to the base font
969 // output change tracking marks only if desired,
970 // if dvipost is installed,
971 // and with dvi/ps (other formats don't work)
972 bool const output = bparams.outputChanges
973 && runparams.flavor == OutputParams::LATEX
974 && LaTeXFeatures::isAvailable("dvipost");
976 // Maybe we have to create a optional argument.
977 pos_type body_pos = beginOfBody();
978 unsigned int column = 0;
981 // the optional argument is kept in curly brackets in
982 // case it contains a ']'
985 basefont = getLabelFont(bparams, outerfont);
987 basefont = getLayoutFont(bparams, outerfont);
990 // Which font is currently active?
991 LyXFont running_font(basefont);
992 // Do we have an open font change?
993 bool open_font = false;
995 Change::Type runningChangeType = Change::UNCHANGED;
997 texrow.start(id(), 0);
999 // if the paragraph is empty, the loop will not be entered at all
1001 if (style->isCommand()) {
1006 column += startTeXParParams(bparams, os, texrow,
1007 runparams.moving_arg);
1010 // Computed only once per paragraph since bparams.encoding() is expensive
1011 Encoding const & doc_encoding = bparams.encoding();
1013 for (pos_type i = 0; i < size(); ++i) {
1014 // First char in paragraph or after label?
1015 if (i == body_pos) {
1018 column += running_font.latexWriteEndChanges(
1019 os, basefont, basefont);
1022 basefont = getLayoutFont(bparams, outerfont);
1023 running_font = basefont;
1025 column += Changes::latexMarkChange(os,
1026 runningChangeType, Change::UNCHANGED, output);
1027 runningChangeType = Change::UNCHANGED;
1032 if (style->isCommand()) {
1038 column += startTeXParParams(bparams, os,
1040 runparams.moving_arg);
1043 Change::Type changeType = pimpl_->lookupChange(i).type;
1045 // do not output text which is marked deleted
1046 // if change tracking output is disabled
1047 if (!output && changeType == Change::DELETED) {
1048 runningChangeType = changeType;
1054 column += Changes::latexMarkChange(os, runningChangeType,
1055 changeType, output);
1056 runningChangeType = changeType;
1058 value_type const c = getChar(i);
1060 // Fully instantiated font
1061 LyXFont const font = getFont(bparams, i, outerfont);
1063 LyXFont const last_font = running_font;
1065 // Do we need to close the previous font?
1067 (font != running_font ||
1068 font.language() != running_font.language()))
1070 column += running_font.latexWriteEndChanges(
1072 (i == body_pos-1) ? basefont : font);
1073 running_font = basefont;
1077 // Switch file encoding if necessary
1078 int const count = switchEncoding(os, bparams,
1079 *(runparams.encoding),
1080 *(font.language()->encoding()));
1083 runparams.encoding = font.language()->encoding();
1086 // Do we need to change font?
1087 if ((font != running_font ||
1088 font.language() != running_font.language()) &&
1091 column += font.latexWriteStartChanges(os, basefont,
1093 running_font = font;
1098 // Do not print the separation of the optional argument
1099 // if style->pass_thru is false. This works because
1100 // simpleTeXSpecialChars ignores spaces if
1101 // style->pass_thru is false.
1102 if (i != body_pos - 1) {
1103 if (pimpl_->simpleTeXBlanks(bparams,
1104 doc_encoding, os, texrow,
1105 i, column, font, *style))
1106 // A surrogate pair was output. We
1107 // must not call simpleTeXSpecialChars
1108 // in this iteration, since
1109 // simpleTeXBlanks incremented i, and
1110 // simpleTeXSpecialChars would output
1111 // the combining character again.
1116 OutputParams rp = runparams;
1117 rp.free_spacing = style->free_spacing;
1118 rp.local_font = &font;
1119 rp.intitle = style->intitle;
1120 pimpl_->simpleTeXSpecialChars(buf, bparams, doc_encoding, os,
1121 texrow, rp, running_font,
1122 basefont, outerfont, open_font,
1123 runningChangeType, *style, i, column, c);
1126 // If we have an open font definition, we have to close it
1128 #ifdef FIXED_LANGUAGE_END_DETECTION
1131 .latexWriteEndChanges(os, basefont,
1132 next_->getFont(bparams, 0, outerfont));
1134 running_font.latexWriteEndChanges(os, basefont,
1138 #ifdef WITH_WARNINGS
1139 //#warning For now we ALWAYS have to close the foreign font settings if they are
1140 //#warning there as we start another \selectlanguage with the next paragraph if
1141 //#warning we are in need of this. This should be fixed sometime (Jug)
1143 running_font.latexWriteEndChanges(os, basefont, basefont);
1147 column += Changes::latexMarkChange(os,
1148 runningChangeType, Change::UNCHANGED, output);
1150 // Needed if there is an optional argument but no contents.
1151 if (body_pos > 0 && body_pos == size()) {
1153 return_value = false;
1157 column += endTeXParParams(bparams, os, texrow,
1158 runparams.moving_arg);
1161 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1162 return return_value;
1179 string tag_name(PAR_TAG const & pt) {
1181 case PAR_NONE: return "!-- --";
1182 case TT: return "tt";
1183 case SF: return "sf";
1184 case BF: return "bf";
1185 case IT: return "it";
1186 case SL: return "sl";
1187 case EM: return "em";
1194 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1196 p1 = static_cast<PAR_TAG>(p1 | p2);
1201 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1203 p1 = static_cast<PAR_TAG>(p1 & ~p2);
1209 bool Paragraph::emptyTag() const
1211 for (pos_type i = 0; i < size(); ++i) {
1213 InsetBase const * inset = getInset(i);
1214 InsetBase::Code lyx_code = inset->lyxCode();
1215 if (lyx_code != InsetBase::TOC_CODE &&
1216 lyx_code != InsetBase::INCLUDE_CODE &&
1217 lyx_code != InsetBase::GRAPHICS_CODE &&
1218 lyx_code != InsetBase::ERT_CODE &&
1219 lyx_code != InsetBase::FLOAT_CODE &&
1220 lyx_code != InsetBase::TABULAR_CODE) {
1224 value_type c = getChar(i);
1225 if (c != ' ' && c != '\t')
1233 string Paragraph::getID(Buffer const & buf, OutputParams const & runparams) const
1235 for (pos_type i = 0; i < size(); ++i) {
1237 InsetBase const * inset = getInset(i);
1238 InsetBase::Code lyx_code = inset->lyxCode();
1239 if (lyx_code == InsetBase::LABEL_CODE) {
1240 string const id = static_cast<InsetCommand const *>(inset)->getContents();
1241 return "id='" + to_utf8(sgml::cleanID(buf, runparams, from_utf8(id))) + "'";
1250 pos_type Paragraph::getFirstWord(Buffer const & buf, odocstream & os, OutputParams const & runparams) const
1253 for (i = 0; i < size(); ++i) {
1255 InsetBase const * inset = getInset(i);
1256 inset->docbook(buf, os, runparams);
1258 value_type c = getChar(i);
1261 os << sgml::escapeChar(c);
1268 bool Paragraph::onlyText(Buffer const & buf, LyXFont const & outerfont, pos_type initial) const
1272 for (pos_type i = initial; i < size(); ++i) {
1273 LyXFont font = getFont(buf.params(), i, outerfont);
1276 if (i != initial && font != font_old)
1285 void Paragraph::simpleDocBookOnePar(Buffer const & buf,
1287 OutputParams const & runparams,
1288 LyXFont const & outerfont,
1289 pos_type initial) const
1291 bool emph_flag = false;
1293 LyXLayout_ptr const & style = layout();
1295 style->labeltype == LABEL_MANUAL ? style->labelfont : style->font;
1297 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1300 // parsing main loop
1301 for (pos_type i = initial; i < size(); ++i) {
1302 LyXFont font = getFont(buf.params(), i, outerfont);
1304 // handle <emphasis> tag
1305 if (font_old.emph() != font.emph()) {
1306 if (font.emph() == LyXFont::ON) {
1309 } else if (i != initial) {
1310 os << "</emphasis>";
1316 InsetBase const * inset = getInset(i);
1317 inset->docbook(buf, os, runparams);
1319 value_type c = getChar(i);
1321 if (style->pass_thru)
1324 os << sgml::escapeChar(c);
1330 os << "</emphasis>";
1333 if (style->free_spacing)
1335 if (style->pass_thru && !onlyText(buf, outerfont, initial))
1340 bool Paragraph::isNewline(pos_type pos) const
1343 && getInset(pos)->lyxCode() == InsetBase::NEWLINE_CODE;
1347 bool Paragraph::isLineSeparator(pos_type pos) const
1349 value_type const c = getChar(pos);
1350 return isLineSeparatorChar(c)
1351 || (c == Paragraph::META_INSET && getInset(pos) &&
1352 getInset(pos)->isLineSeparator());
1356 /// Used by the spellchecker
1357 bool Paragraph::isLetter(pos_type pos) const
1360 return getInset(pos)->isLetter();
1362 value_type const c = getChar(pos);
1363 return isLetterChar(c) || isDigit(c);
1369 Paragraph::getParLanguage(BufferParams const & bparams) const
1372 return getFirstFontSettings(bparams).language();
1373 #ifdef WITH_WARNINGS
1374 #warning FIXME we should check the prev par as well (Lgb)
1376 return bparams.language;
1380 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1382 return lyxrc.rtl_support
1383 && getParLanguage(bparams)->rightToLeft()
1384 && ownerCode() != InsetBase::ERT_CODE;
1388 void Paragraph::changeLanguage(BufferParams const & bparams,
1389 Language const * from, Language const * to)
1391 // change language including dummy font change at the end
1392 for (pos_type i = 0; i <= size(); ++i) {
1393 LyXFont font = getFontSettings(bparams, i);
1394 if (font.language() == from) {
1395 font.setLanguage(to);
1402 bool Paragraph::isMultiLingual(BufferParams const & bparams) const
1404 Language const * doc_language = bparams.language;
1405 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1406 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1408 for (; cit != end; ++cit)
1409 if (cit->font().language() != ignore_language &&
1410 cit->font().language() != latex_language &&
1411 cit->font().language() != doc_language)
1417 // Convert the paragraph to a string.
1418 // Used for building the table of contents
1419 docstring const Paragraph::asString(Buffer const & buffer, bool label) const
1421 return asString(buffer, 0, size(), label);
1425 docstring const Paragraph::asString(Buffer const & buffer,
1426 pos_type beg, pos_type end, bool label) const
1429 odocstringstream os;
1431 if (beg == 0 && label && !params().labelString().empty())
1432 os << params().labelString() << ' ';
1434 for (pos_type i = beg; i < end; ++i) {
1435 value_type const c = getUChar(buffer.params(), i);
1438 else if (c == META_INSET)
1439 getInset(i)->textString(buffer, os);
1446 void Paragraph::setInsetOwner(InsetBase * inset)
1448 pimpl_->inset_owner = inset;
1452 Change const & Paragraph::lookupChange(pos_type pos) const
1454 BOOST_ASSERT(pos <= size());
1455 return pimpl_->lookupChange(pos);
1459 bool Paragraph::isChanged(pos_type start, pos_type end) const
1461 return pimpl_->isChanged(start, end);
1465 bool Paragraph::isMergedOnEndOfParDeletion(bool trackChanges) const
1467 return pimpl_->isMergedOnEndOfParDeletion(trackChanges);
1471 void Paragraph::setChange(Change const & change)
1473 pimpl_->setChange(change);
1477 void Paragraph::setChange(pos_type pos, Change const & change)
1479 pimpl_->setChange(pos, change);
1483 void Paragraph::acceptChanges(BufferParams const & bparams, pos_type start, pos_type end)
1485 return pimpl_->acceptChanges(bparams, start, end);
1489 void Paragraph::rejectChanges(BufferParams const & bparams, pos_type start, pos_type end)
1491 return pimpl_->rejectChanges(bparams, start, end);
1495 int Paragraph::id() const
1501 LyXLayout_ptr const & Paragraph::layout() const
1507 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1509 layout_ = new_layout;
1513 InsetBase * Paragraph::inInset() const
1515 return pimpl_->inset_owner;
1519 InsetBase::Code Paragraph::ownerCode() const
1521 return pimpl_->inset_owner
1522 ? pimpl_->inset_owner->lyxCode() : InsetBase::NO_CODE;
1526 ParagraphParameters & Paragraph::params()
1528 return pimpl_->params;
1532 ParagraphParameters const & Paragraph::params() const
1534 return pimpl_->params;
1538 bool Paragraph::isFreeSpacing() const
1540 if (layout()->free_spacing)
1543 // for now we just need this, later should we need this in some
1544 // other way we can always add a function to InsetBase too.
1545 return ownerCode() == InsetBase::ERT_CODE;
1549 bool Paragraph::allowEmpty() const
1551 if (layout()->keepempty)
1553 return ownerCode() == InsetBase::ERT_CODE;
1557 char_type Paragraph::transformChar(char_type c, pos_type pos) const
1559 if (!Encodings::is_arabic(c))
1562 value_type const prev_char = pos > 0 ? getChar(pos - 1) : ' ';
1563 value_type next_char = ' ';
1565 for (pos_type i = pos + 1, end = size(); i < end; ++i) {
1566 value_type const par_char = getChar(i);
1567 if (!Encodings::isComposeChar_arabic(par_char)) {
1568 next_char = par_char;
1573 if (Encodings::is_arabic(next_char)) {
1574 if (Encodings::is_arabic(prev_char) &&
1575 !Encodings::is_arabic_special(prev_char))
1576 return Encodings::transformChar(c, Encodings::FORM_MEDIAL);
1578 return Encodings::transformChar(c, Encodings::FORM_INITIAL);
1580 if (Encodings::is_arabic(prev_char) &&
1581 !Encodings::is_arabic_special(prev_char))
1582 return Encodings::transformChar(c, Encodings::FORM_FINAL);
1584 return Encodings::transformChar(c, Encodings::FORM_ISOLATED);
1589 bool Paragraph::hfillExpansion(Row const & row, pos_type pos) const
1594 BOOST_ASSERT(pos >= row.pos() && pos < row.endpos());
1596 // expand at the end of a row only if there is another hfill on the same row
1597 if (pos == row.endpos() - 1) {
1598 for (pos_type i = row.pos(); i < pos; i++) {
1605 // expand at the beginning of a row only if it is the first row of a paragraph
1606 if (pos == row.pos()) {
1610 // do not expand in some labels
1611 if (layout()->margintype != MARGIN_MANUAL && pos < beginOfBody())
1614 // if there is anything between the first char of the row and
1615 // the specified position that is neither a newline nor an hfill,
1616 // the hfill will be expanded, otherwise it won't
1617 for (pos_type i = row.pos(); i < pos; i++) {
1618 if (!isNewline(i) && !isHfill(i))
1625 bool Paragraph::checkBiblio(bool track_changes)
1627 // Add bibitem insets if necessary
1628 if (layout()->labeltype != LABEL_BIBLIO)
1631 bool hasbibitem = !insetlist.empty()
1632 // Insist on it being in pos 0
1633 && getChar(0) == Paragraph::META_INSET
1634 && insetlist.begin()->inset->lyxCode() == InsetBase::BIBITEM_CODE;
1639 InsetBibitem * inset(new InsetBibitem(InsetCommandParams("bibitem")));
1640 insertInset(0, static_cast<InsetBase *>(inset),
1641 Change(track_changes ? Change::INSERTED : Change::UNCHANGED));