1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
14 #pragma implementation
17 #include "paragraph.h"
18 #include "paragraph_pimpl.h"
22 #include "tex-strings.h"
24 #include "bufferparams.h"
27 #include "BufferView.h"
29 #include "ParameterStruct.h"
32 #include "insets/insetinclude.h"
33 #include "insets/insetbib.h"
34 #include "insets/insettext.h"
36 #include "support/filetools.h"
37 #include "support/lstrings.h"
38 #include "support/lyxmanip.h"
39 #include "support/FileInfo.h"
40 #include "support/LAssert.h"
41 #include "support/textutils.h"
51 using std::lower_bound;
52 using std::upper_bound;
57 // this is a bad idea, but how can Paragraph find its buffer to get
58 // parameters? (JMarc)
60 extern string bibitemWidest(Buffer const *);
62 // this is a minibuffer
67 LyXFont minibuffer_font;
68 Inset * minibuffer_inset;
73 extern BufferView * current_view;
76 Paragraph::Paragraph()
77 : pimpl_(new Paragraph::Pimpl(this))
85 bibkey = 0; // ale970302
91 // This constructor inserts the new paragraph in a list.
92 Paragraph::Paragraph(Paragraph * par)
93 : pimpl_(new Paragraph::Pimpl(this))
98 // double linked list begin
101 next_->previous_ = this;
103 previous_->next_ = this;
106 bibkey = 0; // ale970302
112 Paragraph::Paragraph(Paragraph const & lp, bool same_ids)
113 : pimpl_(new Paragraph::Pimpl(*lp.pimpl_, this, same_ids))
121 // this is because of the dummy layout of the paragraphs that
123 layout_ = lp.layout();
127 bibkey = static_cast<InsetBibKey *>
128 (lp.bibkey->clone(*current_view->buffer()));
133 // copy everything behind the break-position to the new paragraph
134 insetlist = lp.insetlist;
135 InsetList::iterator it = insetlist.begin();
136 InsetList::iterator end = insetlist.end();
137 for (; it != end; ++it) {
138 it.setInset(it.getInset()->clone(*current_view->buffer(),
140 // tell the new inset who is the boss now
141 it.getInset()->parOwner(this);
146 // the destructor removes the new paragraph from the list
147 Paragraph::~Paragraph()
151 previous_->next_ = next_;
153 next_->previous_ = previous_;
161 //lyxerr << "Paragraph::paragraph_id = "
162 // << Paragraph::paragraph_id << endl;
166 void Paragraph::write(Buffer const * buf, ostream & os,
167 BufferParams const & bparams,
168 depth_type dth) const
170 // The beginning or end of a deeper (i.e. nested) area?
171 if (dth != params().depth()) {
172 if (params().depth() > dth) {
173 while (params().depth() > dth) {
174 os << "\n\\begin_deeper ";
178 while (params().depth() < dth) {
179 os << "\n\\end_deeper ";
185 // First write the layout
186 os << "\n\\layout " << layout()->name() << "\n";
188 // Maybe some vertical spaces.
189 if (params().spaceTop().kind() != VSpace::NONE)
190 os << "\\added_space_top "
191 << params().spaceTop().asLyXCommand() << " ";
192 if (params().spaceBottom().kind() != VSpace::NONE)
193 os << "\\added_space_bottom "
194 << params().spaceBottom().asLyXCommand() << " ";
196 // Maybe the paragraph has special spacing
197 params().spacing().writeFile(os, true);
199 // The labelwidth string used in lists.
200 if (!params().labelWidthString().empty())
201 os << "\\labelwidthstring "
202 << params().labelWidthString() << '\n';
204 // Lines above or below?
205 if (params().lineTop())
207 if (params().lineBottom())
208 os << "\\line_bottom ";
210 // Pagebreaks above or below?
211 if (params().pagebreakTop())
212 os << "\\pagebreak_top ";
213 if (params().pagebreakBottom())
214 os << "\\pagebreak_bottom ";
216 // Start of appendix?
217 if (params().startOfAppendix())
218 os << "\\start_of_appendix ";
221 if (params().noindent())
224 // Do we have a manual left indent?
225 if (!params().leftIndent().zero())
226 os << "\\leftindent " << params().leftIndent().asString() << " ";
229 if (params().align() != LYX_ALIGN_LAYOUT) {
231 switch (params().align()) {
232 case LYX_ALIGN_LEFT: h = 1; break;
233 case LYX_ALIGN_RIGHT: h = 2; break;
234 case LYX_ALIGN_CENTER: h = 3; break;
235 default: h = 0; break;
237 os << "\\align " << string_align[h] << " ";
242 bibkey->write(buf, os);
244 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
247 for (pos_type i = 0; i < size(); ++i) {
253 // Write font changes
254 LyXFont font2 = getFontSettings(bparams, i);
255 if (font2 != font1) {
256 #ifndef INHERIT_LANGUAGE
257 font2.lyxWriteChanges(font1, os);
259 font2.lyxWriteChanges(font1, bparams.language, os);
265 value_type const c = getChar(i);
269 Inset const * inset = getInset(i);
271 if (inset->directWrite()) {
272 // international char, let it write
273 // code directly so it's shorter in
275 inset->write(buf, os);
277 os << "\n\\begin_inset ";
278 inset->write(buf, os);
279 os << "\n\\end_inset \n\n";
285 os << "\n\\newline \n";
289 os << "\n\\hfill \n";
293 os << "\n\\backslash \n";
297 if (i + 1 < size() && getChar(i + 1) == ' ') {
304 if ((column > 70 && c == ' ')
309 // this check is to amend a bug. LyX sometimes
310 // inserts '\0' this could cause problems.
314 lyxerr << "ERROR (Paragraph::writeFile):"
315 " NULL char in structure." << endl;
323 void Paragraph::validate(LaTeXFeatures & features) const
325 pimpl_->validate(features, *layout());
329 // First few functions needed for cut and paste and paragraph breaking.
330 void Paragraph::copyIntoMinibuffer(Buffer const & buffer, pos_type pos) const
332 BufferParams bparams = buffer.params;
334 minibuffer_char = getChar(pos);
335 minibuffer_font = getFontSettings(bparams, pos);
336 minibuffer_inset = 0;
337 if (minibuffer_char == Paragraph::META_INSET) {
339 minibuffer_inset = getInset(pos)->clone(buffer);
341 minibuffer_inset = 0;
342 minibuffer_char = ' ';
343 // This reflects what GetInset() does (ARRae)
349 void Paragraph::cutIntoMinibuffer(BufferParams const & bparams, pos_type pos)
351 minibuffer_char = getChar(pos);
352 minibuffer_font = getFontSettings(bparams, pos);
353 minibuffer_inset = 0;
354 if (minibuffer_char == Paragraph::META_INSET) {
356 // the inset is not in a paragraph anymore
357 minibuffer_inset = insetlist.release(pos);
358 minibuffer_inset->parOwner(0);
360 minibuffer_inset = 0;
361 minibuffer_char = ' ';
362 // This reflects what GetInset() does (ARRae)
367 // Erase(pos); now the caller is responsible for that.
371 bool Paragraph::insertFromMinibuffer(pos_type pos)
373 if (minibuffer_char == Paragraph::META_INSET) {
374 if (!insetAllowed(minibuffer_inset->lyxCode())) {
377 insertInset(pos, minibuffer_inset, minibuffer_font);
379 LyXFont f = minibuffer_font;
380 if (!checkInsertChar(f)) {
383 insertChar(pos, minibuffer_char, f);
391 void Paragraph::erase(pos_type pos)
397 bool Paragraph::checkInsertChar(LyXFont & font)
399 if (pimpl_->inset_owner)
400 return pimpl_->inset_owner->checkInsertChar(font);
405 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c)
407 LyXFont const f(LyXFont::ALL_INHERIT);
408 insertChar(pos, c, f);
412 void Paragraph::insertChar(pos_type pos, Paragraph::value_type c,
413 LyXFont const & font)
415 pimpl_->insertChar(pos, c, font);
419 void Paragraph::insertInset(pos_type pos, Inset * inset)
421 LyXFont const f(LyXFont::ALL_INHERIT);
422 insertInset(pos, inset, f);
426 void Paragraph::insertInset(pos_type pos, Inset * inset, LyXFont const & font)
428 pimpl_->insertInset(pos, inset, font);
432 bool Paragraph::insetAllowed(Inset::Code code)
434 //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
436 if (pimpl_->inset_owner)
437 return pimpl_->inset_owner->insetAllowed(code);
442 Inset * Paragraph::getInset(pos_type pos)
444 lyx::Assert(pos < size());
446 return insetlist.get(pos);
450 Inset const * Paragraph::getInset(pos_type pos) const
452 lyx::Assert(pos < size());
454 return insetlist.get(pos);
458 // Gets uninstantiated font setting at position.
459 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
462 lyx::Assert(pos <= size());
464 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
465 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
466 for (; cit != end; ++cit) {
467 if (cit->pos() >= pos)
473 retfont = cit->font();
474 } else if (pos == size() && !empty()) {
475 retfont = getFontSettings(bparams, pos - 1);
477 retfont = LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
478 #ifdef INHERIT_LANGUAGE
479 if (retfont.language() == inherit_language)
480 retfont.setLanguage(bparams.language);
487 // Gets uninstantiated font setting at position 0
488 LyXFont const Paragraph::getFirstFontSettings() const
490 if (!empty() && !pimpl_->fontlist.empty())
491 return pimpl_->fontlist[0].font();
493 return LyXFont(LyXFont::ALL_INHERIT);
497 // Gets the fully instantiated font at a given position in a paragraph
498 // This is basically the same function as LyXText::GetFont() in text2.C.
499 // The difference is that this one is used for generating the LaTeX file,
500 // and thus cosmetic "improvements" are disallowed: This has to deliver
501 // the true picture of the buffer. (Asger)
502 // If position is -1, we get the layout font of the paragraph.
503 // If position is -2, we get the font of the manual label of the paragraph.
504 LyXFont const Paragraph::getFont(BufferParams const & bparams,
507 lyx::Assert(pos >= 0);
509 LyXLayout_ptr const & lout = layout();
511 pos_type main_body = 0;
512 if (lout->labeltype == LABEL_MANUAL)
513 main_body = beginningOfMainBody();
517 layoutfont = lout->labelfont;
519 layoutfont = lout->font;
521 LyXFont tmpfont = getFontSettings(bparams, pos);
522 #ifndef INHERIT_LANGUAGE
523 tmpfont.realize(layoutfont);
525 tmpfont.realize(layoutfont, bparams.language);
528 return pimpl_->realizeFont(tmpfont, bparams);
532 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams) const
534 LyXLayout_ptr const & lout = layout();
536 LyXFont tmpfont = lout->labelfont;
537 tmpfont.setLanguage(getParLanguage(bparams));
539 return pimpl_->realizeFont(tmpfont, bparams);
543 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams) const
545 LyXLayout_ptr const & lout = layout();
547 LyXFont tmpfont = lout->font;
548 tmpfont.setLanguage(getParLanguage(bparams));
550 return pimpl_->realizeFont(tmpfont, bparams);
554 /// Returns the height of the highest font in range
556 Paragraph::highestFontInRange(pos_type startpos, pos_type endpos,
557 LyXFont::FONT_SIZE const def_size) const
559 if (pimpl_->fontlist.empty())
562 Pimpl::FontList::const_iterator end_it = pimpl_->fontlist.begin();
563 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
564 for (; end_it != end; ++end_it) {
565 if (end_it->pos() >= endpos)
572 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
573 for (; cit != end; ++cit) {
574 if (cit->pos() >= startpos)
578 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
579 for (; cit != end_it; ++cit) {
580 LyXFont::FONT_SIZE size = cit->font().size();
581 if (size == LyXFont::INHERIT_SIZE)
583 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
590 Paragraph::value_type
591 Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
593 value_type c = getChar(pos);
594 if (!lyxrc.rtl_support)
624 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
631 void Paragraph::setFont(pos_type pos, LyXFont const & font)
633 lyx::Assert(pos <= size());
635 // First, reduce font against layout/label font
636 // Update: The SetCharFont() routine in text2.C already
637 // reduces font, so we don't need to do that here. (Asger)
638 // No need to simplify this because it will disappear
639 // in a new kernel. (Asger)
640 // Next search font table
642 Pimpl::FontList::iterator beg = pimpl_->fontlist.begin();
643 Pimpl::FontList::iterator it = beg;
644 Pimpl::FontList::iterator endit = pimpl_->fontlist.end();
645 for (; it != endit; ++it) {
646 if (it->pos() >= pos)
649 unsigned int i = std::distance(beg, it);
650 bool notfound = (it == endit);
652 if (!notfound && pimpl_->fontlist[i].font() == font)
655 bool begin = pos == 0 || notfound ||
656 (i > 0 && pimpl_->fontlist[i - 1].pos() == pos - 1);
657 // Is position pos is a beginning of a font block?
658 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
659 // Is position pos is the end of a font block?
660 if (begin && end) { // A single char block
661 if (i + 1 < pimpl_->fontlist.size() &&
662 pimpl_->fontlist[i + 1].font() == font) {
663 // Merge the singleton block with the next block
664 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
665 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
666 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i - 1);
667 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
668 // Merge the singleton block with the previous block
669 pimpl_->fontlist[i - 1].pos(pos);
670 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
672 pimpl_->fontlist[i].font(font);
674 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
675 pimpl_->fontlist[i - 1].pos(pos);
677 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
678 Pimpl::FontTable(pos, font));
680 pimpl_->fontlist[i].pos(pos - 1);
681 if (!(i + 1 < pimpl_->fontlist.size() &&
682 pimpl_->fontlist[i + 1].font() == font))
683 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
684 Pimpl::FontTable(pos, font));
685 } else { // The general case. The block is splitted into 3 blocks
686 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
687 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
688 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
689 Pimpl::FontTable(pos, font));
695 void Paragraph::next(Paragraph * p)
701 // This function is able to hide closed footnotes.
702 Paragraph * Paragraph::next()
708 Paragraph const * Paragraph::next() const
714 void Paragraph::previous(Paragraph * p)
720 // This function is able to hide closed footnotes.
721 Paragraph * Paragraph::previous()
727 // This function is able to hide closed footnotes.
728 Paragraph const * Paragraph::previous() const
735 void Paragraph::breakParagraph(BufferParams const & bparams,
739 // create a new paragraph
740 Paragraph * tmp = new Paragraph(this);
741 tmp->layout(bparams.getLyXTextClass().defaultLayout());
742 // remember to set the inset_owner
743 tmp->setInsetOwner(inInset());
745 // this is an idea for a more userfriendly layout handling, I will
746 // see what the users say
748 // layout stays the same with latex-environments
750 tmp->layout(layout());
751 tmp->setLabelWidthString(params().labelWidthString());
754 bool isempty = (layout()->keepempty && empty());
756 if (!isempty && (size() > pos || empty() || flag == 2)) {
757 tmp->layout(layout());
758 tmp->params().align(params().align());
759 tmp->setLabelWidthString(params().labelWidthString());
761 tmp->params().lineBottom(params().lineBottom());
762 params().lineBottom(false);
763 tmp->params().pagebreakBottom(params().pagebreakBottom());
764 params().pagebreakBottom(false);
765 tmp->params().spaceBottom(params().spaceBottom());
766 params().spaceBottom(VSpace(VSpace::NONE));
768 tmp->params().depth(params().depth());
769 tmp->params().noindent(params().noindent());
771 // copy everything behind the break-position
772 // to the new paragraph
773 pos_type pos_end = size() - 1;
776 for (; i <= pos_end; ++i) {
777 cutIntoMinibuffer(bparams, i);
778 if (tmp->insertFromMinibuffer(j - pos))
781 for (i = pos_end; i >= pos; --i) {
786 // just an idea of me
787 if (!isempty && !pos) {
788 tmp->params().lineTop(params().lineTop());
789 tmp->params().pagebreakTop(params().pagebreakTop());
790 tmp->params().spaceTop(params().spaceTop());
791 tmp->bibkey = bibkey;
796 layout(bparams.getLyXTextClass().defaultLayout());
798 // layout stays the same with latex-environments
800 layout(tmp->layout());
801 setLabelWidthString(tmp->params().labelWidthString());
802 params().depth(tmp->params().depth());
808 void Paragraph::makeSameLayout(Paragraph const * par)
810 layout(par->layout());
812 params() = par->params();
816 int Paragraph::stripLeadingSpaces()
818 if (layout()->free_spacing ||
824 while (!empty() && (isNewline(0) || isLineSeparator(0))) {
833 bool Paragraph::hasSameLayout(Paragraph const * par) const
836 par->layout() == layout() &&
837 params().sameLayout(par->params());
841 void Paragraph::breakParagraphConservative(BufferParams const & bparams,
844 // create a new paragraph
845 Paragraph * tmp = new Paragraph(this);
846 tmp->makeSameLayout(this);
848 // When can pos > Last()?
849 // I guess pos == Last() is possible.
851 // copy everything behind the break-position to the new
853 pos_type pos_end = size() - 1;
857 for (pos_type i = pos, j = pos; i <= pos_end; ++i) {
858 cutIntoMinibuffer(bparams, i);
859 if (tmp->insertFromMinibuffer(j - pos))
863 for (pos_type k = pos_end; k >= pos; --k) {
870 // Be carefull, this does not make any check at all.
871 // This method has wrong name, it combined this par with the next par.
872 // In that sense it is the reverse of break paragraph. (Lgb)
873 void Paragraph::pasteParagraph(BufferParams const & bparams)
875 // copy the next paragraph to this one
876 Paragraph * the_next = next();
878 // first the DTP-stuff
879 params().lineBottom(the_next->params().lineBottom());
880 params().spaceBottom(the_next->params().spaceBottom());
881 params().pagebreakBottom(the_next->params().pagebreakBottom());
883 pos_type pos_end = the_next->pimpl_->size() - 1;
884 pos_type pos_insert = size();
886 // ok, now copy the paragraph
887 for (pos_type i = 0, j = 0; i <= pos_end; ++i) {
888 the_next->cutIntoMinibuffer(bparams, i);
889 if (insertFromMinibuffer(pos_insert + j))
893 // delete the next paragraph
894 Paragraph * ppar = the_next->previous_;
895 Paragraph * npar = the_next->next_;
901 int Paragraph::getEndLabel() const
903 Paragraph const * par = this;
904 depth_type par_depth = getDepth();
906 LyXLayout_ptr const & layout = par->layout();
907 int const endlabeltype = layout->endlabeltype;
909 if (endlabeltype != END_LABEL_NO_LABEL) {
913 depth_type const next_depth = next_->getDepth();
914 if (par_depth > next_depth ||
915 (par_depth == next_depth
916 && layout != next_->layout()))
922 par = par->outerHook();
924 par_depth = par->getDepth();
926 return END_LABEL_NO_LABEL;
930 Paragraph::depth_type Paragraph::getDepth() const
932 return params().depth();
936 Paragraph::depth_type Paragraph::getMaxDepthAfter() const
938 bool const isenv = layout()->isEnvironment();
941 return params().depth() + 1;
943 return params().depth();
947 char Paragraph::getAlign() const
949 return params().align();
953 string const & Paragraph::getLabelstring() const
955 return params().labelString();
959 // the next two functions are for the manual labels
960 string const Paragraph::getLabelWidthString() const
962 if (!params().labelWidthString().empty())
963 return params().labelWidthString();
965 return _("Senseless with this layout!");
969 void Paragraph::setLabelWidthString(string const & s)
971 params().labelWidthString(s);
975 void Paragraph::applyLayout(LyXLayout_ptr const & new_layout)
978 params().labelWidthString(string());
979 params().align(LYX_ALIGN_LAYOUT);
980 params().spaceTop(VSpace(VSpace::NONE));
981 params().spaceBottom(VSpace(VSpace::NONE));
982 params().spacing(Spacing(Spacing::Default));
986 // if the layout of a paragraph contains a manual label, the beginning of the
987 // main body is the beginning of the second word. This is what the par-
988 // function returns. If the layout does not contain a label, the main
989 // body always starts with position 0. This differentiation is necessary,
990 // because there cannot be a newline or a blank <= the beginning of the
993 int Paragraph::beginningOfMainBody() const
995 // Unroll the first two cycles of the loop
996 // and remember the previous character to
997 // remove unnecessary GetChar() calls
999 if (i < size() && getChar(i) != Paragraph::META_NEWLINE) {
1001 char previous_char = 0;
1004 && (previous_char = getChar(i)) != Paragraph::META_NEWLINE) {
1005 // Yes, this ^ is supposed to be "= " not "=="
1008 && previous_char != ' '
1009 && (temp = getChar(i)) != Paragraph::META_NEWLINE) {
1011 previous_char = temp;
1020 Paragraph * Paragraph::depthHook(depth_type depth)
1022 Paragraph * newpar = this;
1025 newpar = newpar->previous();
1026 } while (newpar && newpar->getDepth() > depth);
1029 if (previous() || getDepth())
1030 lyxerr << "ERROR (Paragraph::DepthHook): "
1039 Paragraph const * Paragraph::depthHook(depth_type depth) const
1041 Paragraph const * newpar = this;
1044 newpar = newpar->previous();
1045 } while (newpar && newpar->getDepth() > depth);
1048 if (previous() || getDepth())
1049 lyxerr << "ERROR (Paragraph::DepthHook): "
1058 Paragraph * Paragraph::outerHook()
1062 return depthHook(depth_type(getDepth() - 1));
1066 Paragraph const * Paragraph::outerHook() const
1070 return depthHook(depth_type(getDepth() - 1));
1074 // returns -1 if inset not found
1075 int Paragraph::getPositionOfInset(Inset const * inset) const
1078 InsetList::iterator it = insetlist.begin();
1079 InsetList::iterator end = insetlist.end();
1080 for (; it != end; ++it) {
1081 if (it.getInset() == inset) {
1085 if (inset == bibkey)
1092 Paragraph * Paragraph::TeXOnePar(Buffer const * buf,
1093 BufferParams const & bparams,
1094 ostream & os, TexRow & texrow,
1097 lyxerr[Debug::LATEX] << "TeXOnePar... " << this << endl;
1098 Inset const * in = inInset();
1099 bool further_blank_line = false;
1100 LyXLayout_ptr style;
1102 // well we have to check if we are in an inset with unlimited
1103 // lenght (all in one row) if that is true then we don't allow
1104 // any special options in the paragraph and also we don't allow
1105 // any environment other then "Standard" to be valid!
1106 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
1109 if (params().startOfAppendix()) {
1110 os << "\\appendix\n";
1114 if (!params().spacing().isDefault()
1115 && (!previous() || !previous()->hasSameLayout(this))) {
1116 os << params().spacing().writeEnvirBegin() << "\n";
1120 if (style->isCommand()) {
1125 if (params().pagebreakTop()) {
1127 further_blank_line = true;
1129 if (params().spaceTop().kind() != VSpace::NONE) {
1130 os << params().spaceTop().asLatexCommand(bparams);
1131 further_blank_line = true;
1134 if (params().lineTop()) {
1135 os << "\\lyxline{\\" << getFont(bparams, 0).latexSize() << '}'
1136 << "\\vspace{-1\\parskip}";
1137 further_blank_line = true;
1140 if (further_blank_line) {
1145 style = bparams.getLyXTextClass().defaultLayout();
1148 Language const * language = getParLanguage(bparams);
1149 Language const * doc_language = bparams.language;
1150 Language const * previous_language = previous()
1151 ? previous()->getParLanguage(bparams) : doc_language;
1153 if (language->babel() != previous_language->babel()
1154 // check if we already put language command in TeXEnvironment()
1155 && !(style->isEnvironment()
1156 && (!previous() || previous()->layout() != layout() ||
1157 previous()->params().depth() != params().depth())))
1159 if (!lyxrc.language_command_end.empty() &&
1160 previous_language->babel() != doc_language->babel())
1162 os << subst(lyxrc.language_command_end, "$$lang",
1163 previous_language->babel())
1168 if (lyxrc.language_command_end.empty() ||
1169 language->babel() != doc_language->babel())
1171 os << subst(lyxrc.language_command_begin, "$$lang",
1178 if (bparams.inputenc == "auto" &&
1179 language->encoding() != previous_language->encoding()) {
1180 os << "\\inputencoding{"
1181 << language->encoding()->LatexName()
1186 switch (style->latextype) {
1189 << style->latexname()
1190 << style->latexparam();
1192 case LATEX_ITEM_ENVIRONMENT:
1194 bibkey->latex(buf, os, false, false);
1198 case LATEX_LIST_ENVIRONMENT:
1205 bool need_par = simpleTeXOnePar(buf, bparams, os, texrow, moving_arg);
1207 // Make sure that \\par is done with the font of the last
1208 // character if this has another size as the default.
1209 // This is necessary because LaTeX (and LyX on the screen)
1210 // calculates the space between the baselines according
1211 // to this font. (Matthias)
1213 // Is this really needed ? (Dekel)
1214 // We do not need to use to change the font for the last paragraph
1215 // or for a command.
1216 LyXFont const font =
1218 ? getLayoutFont(bparams) : getFont(bparams, size() - 1));
1220 bool is_command = style->isCommand();
1222 if (style->resfont.size() != font.size() && next_ && !is_command) {
1225 os << "\\" << font.latexSize() << " \\par}";
1226 } else if (need_par) {
1228 } else if (is_command)
1231 switch (style->latextype) {
1232 case LATEX_ITEM_ENVIRONMENT:
1233 case LATEX_LIST_ENVIRONMENT:
1234 if (next_ && (params().depth() < next_->params().depth())) {
1239 case LATEX_ENVIRONMENT:
1240 // if its the last paragraph of the current environment
1241 // skip it otherwise fall through
1243 && (next_->layout() != layout()
1244 || next_->params().depth() != params().depth()))
1246 // fall through possible
1248 // we don't need it for the last paragraph!!!
1255 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
1256 further_blank_line = false;
1257 if (params().lineBottom()) {
1258 os << "\\lyxline{\\" << font.latexSize() << '}';
1259 further_blank_line = true;
1262 if (params().spaceBottom().kind() != VSpace::NONE) {
1263 os << params().spaceBottom().asLatexCommand(bparams);
1264 further_blank_line = true;
1267 if (params().pagebreakBottom()) {
1269 further_blank_line = true;
1272 if (further_blank_line) {
1277 if (!params().spacing().isDefault()
1278 && (!next_ || !next_->hasSameLayout(this))) {
1279 os << params().spacing().writeEnvirEnd() << "\n";
1284 // we don't need it for the last paragraph!!!
1289 // Since \selectlanguage write the language to the aux file,
1290 // we need to reset the language at the end of footnote or
1293 if (language->babel() != doc_language->babel()) {
1294 if (lyxrc.language_command_end.empty())
1295 os << subst(lyxrc.language_command_begin,
1297 doc_language->babel())
1300 os << subst(lyxrc.language_command_end,
1308 lyxerr[Debug::LATEX] << "TeXOnePar...done " << next_ << endl;
1313 // This could go to ParagraphParameters if we want to
1314 int Paragraph::startTeXParParams(BufferParams const & bparams,
1315 ostream & os, bool moving_arg) const
1319 if (params().noindent()) {
1320 os << "\\noindent ";
1324 switch (params().align()) {
1325 case LYX_ALIGN_NONE:
1326 case LYX_ALIGN_BLOCK:
1327 case LYX_ALIGN_LAYOUT:
1328 case LYX_ALIGN_SPECIAL:
1330 case LYX_ALIGN_LEFT:
1331 case LYX_ALIGN_RIGHT:
1332 case LYX_ALIGN_CENTER:
1340 switch (params().align()) {
1341 case LYX_ALIGN_NONE:
1342 case LYX_ALIGN_BLOCK:
1343 case LYX_ALIGN_LAYOUT:
1344 case LYX_ALIGN_SPECIAL:
1346 case LYX_ALIGN_LEFT:
1347 if (getParLanguage(bparams)->babel() != "hebrew") {
1348 os << "\\begin{flushleft}";
1351 os << "\\begin{flushright}";
1355 case LYX_ALIGN_RIGHT:
1356 if (getParLanguage(bparams)->babel() != "hebrew") {
1357 os << "\\begin{flushright}";
1360 os << "\\begin{flushleft}";
1364 case LYX_ALIGN_CENTER:
1365 os << "\\begin{center}";
1374 // This could go to ParagraphParameters if we want to
1375 int Paragraph::endTeXParParams(BufferParams const & bparams,
1376 ostream & os, bool moving_arg) const
1380 switch (params().align()) {
1381 case LYX_ALIGN_NONE:
1382 case LYX_ALIGN_BLOCK:
1383 case LYX_ALIGN_LAYOUT:
1384 case LYX_ALIGN_SPECIAL:
1386 case LYX_ALIGN_LEFT:
1387 case LYX_ALIGN_RIGHT:
1388 case LYX_ALIGN_CENTER:
1396 switch (params().align()) {
1397 case LYX_ALIGN_NONE:
1398 case LYX_ALIGN_BLOCK:
1399 case LYX_ALIGN_LAYOUT:
1400 case LYX_ALIGN_SPECIAL:
1402 case LYX_ALIGN_LEFT:
1403 if (getParLanguage(bparams)->babel() != "hebrew") {
1404 os << "\\end{flushleft}";
1407 os << "\\end{flushright}";
1411 case LYX_ALIGN_RIGHT:
1412 if (getParLanguage(bparams)->babel() != "hebrew") {
1413 os << "\\end{flushright}";
1416 os << "\\end{flushleft}";
1420 case LYX_ALIGN_CENTER:
1421 os << "\\end{center}";
1429 // This one spits out the text of the paragraph
1430 bool Paragraph::simpleTeXOnePar(Buffer const * buf,
1431 BufferParams const & bparams,
1432 ostream & os, TexRow & texrow,
1435 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
1437 bool return_value = false;
1439 LyXLayout_ptr style;
1441 // well we have to check if we are in an inset with unlimited
1442 // lenght (all in one row) if that is true then we don't allow
1443 // any special options in the paragraph and also we don't allow
1444 // any environment other then "Standard" to be valid!
1446 (inInset() && inInset()->forceDefaultParagraphs(inInset()));
1449 style = bparams.getLyXTextClass().defaultLayout();
1456 // Maybe we have to create a optional argument.
1458 if (style->labeltype != LABEL_MANUAL)
1461 main_body = beginningOfMainBody();
1465 if (main_body > 0) {
1468 basefont = getLabelFont(bparams);
1470 basefont = getLayoutFont(bparams);
1473 moving_arg |= style->needprotect;
1475 // Which font is currently active?
1476 LyXFont running_font(basefont);
1477 // Do we have an open font change?
1478 bool open_font = false;
1480 texrow.start(this, 0);
1482 // if the paragraph is empty, the loop will not be entered at all
1484 if (style->isCommand()) {
1489 column += startTeXParParams(bparams, os, moving_arg);
1493 for (pos_type i = 0; i < size(); ++i) {
1495 // First char in paragraph or after label?
1496 if (i == main_body) {
1497 if (main_body > 0) {
1499 column += running_font.latexWriteEndChanges(os, basefont, basefont);
1502 basefont = getLayoutFont(bparams);
1503 running_font = basefont;
1507 if (style->isCommand()) {
1513 column += startTeXParParams(bparams, os,
1517 value_type c = getChar(i);
1519 // Fully instantiated font
1520 LyXFont font = getFont(bparams, i);
1522 LyXFont const last_font = running_font;
1524 // Spaces at end of font change are simulated to be
1525 // outside font change, i.e. we write "\textXX{text} "
1526 // rather than "\textXX{text }". (Asger)
1527 if (open_font && c == ' ' && i <= size() - 2) {
1528 LyXFont const & next_font = getFont(bparams, i + 1);
1529 if (next_font != running_font
1530 && next_font != font) {
1535 // We end font definition before blanks
1537 (font != running_font ||
1538 font.language() != running_font.language()))
1540 column += running_font.latexWriteEndChanges(os,
1542 (i == main_body-1) ? basefont : font);
1543 running_font = basefont;
1547 // Blanks are printed before start of fontswitch
1549 // Do not print the separation of the optional argument
1550 if (i != main_body - 1) {
1551 pimpl_->simpleTeXBlanks(os, texrow, i,
1552 column, font, *style);
1556 // Do we need to change font?
1557 if ((font != running_font ||
1558 font.language() != running_font.language()) &&
1561 column += font.latexWriteStartChanges(os, basefont,
1563 running_font = font;
1567 if (c == Paragraph::META_NEWLINE) {
1568 // newlines are handled differently here than
1569 // the default in SimpleTeXSpecialChars().
1570 if (!style->newline_allowed) {
1574 column += running_font.latexWriteEndChanges(os, basefont, basefont);
1577 basefont = getLayoutFont(bparams);
1578 running_font = basefont;
1579 if (font.family() ==
1580 LyXFont::TYPEWRITER_FAMILY) {
1589 texrow.start(this, i + 1);
1592 pimpl_->simpleTeXSpecialChars(buf, bparams,
1593 os, texrow, moving_arg,
1595 basefont, open_font,
1596 *style, i, column, c);
1600 // If we have an open font definition, we have to close it
1602 #ifdef FIXED_LANGUAGE_END_DETECTION
1605 .latexWriteEndChanges(os, basefont,
1606 next_->getFont(bparams,
1609 running_font.latexWriteEndChanges(os, basefont,
1613 #ifdef WITH_WARNINGS
1614 //#warning For now we ALWAYS have to close the foreign font settings if they are
1615 //#warning there as we start another \selectlanguage with the next paragraph if
1616 //#warning we are in need of this. This should be fixed sometime (Jug)
1618 running_font.latexWriteEndChanges(os, basefont, basefont);
1622 // Needed if there is an optional argument but no contents.
1623 if (main_body > 0 && main_body == size()) {
1625 return_value = false;
1629 column += endTeXParParams(bparams, os, moving_arg);
1632 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1633 return return_value;
1637 Paragraph * Paragraph::TeXEnvironment(Buffer const * buf,
1638 BufferParams const & bparams,
1639 ostream & os, TexRow & texrow)
1641 lyxerr[Debug::LATEX] << "TeXEnvironment... " << this << endl;
1643 LyXLayout_ptr const & style = layout();
1645 Language const * language = getParLanguage(bparams);
1646 Language const * doc_language = bparams.language;
1647 Language const * previous_language = previous_
1648 ? previous_->getParLanguage(bparams) : doc_language;
1649 if (language->babel() != previous_language->babel()) {
1651 if (!lyxrc.language_command_end.empty() &&
1652 previous_language->babel() != doc_language->babel()) {
1653 os << subst(lyxrc.language_command_end, "$$lang",
1654 previous_language->babel())
1659 if (lyxrc.language_command_end.empty() ||
1660 language->babel() != doc_language->babel()) {
1661 os << subst(lyxrc.language_command_begin, "$$lang",
1668 bool leftindent_open = false;
1669 if (!params().leftIndent().zero()) {
1670 os << "\\begin{LyXParagraphLeftIndent}{" <<
1671 params().leftIndent().asLatexString() << "}\n";
1673 leftindent_open = true;
1676 if (style->isEnvironment()) {
1677 if (style->latextype == LATEX_LIST_ENVIRONMENT) {
1678 os << "\\begin{" << style->latexname() << "}{"
1679 << params().labelWidthString() << "}\n";
1680 } else if (style->labeltype == LABEL_BIBLIO) {
1682 os << "\\begin{" << style->latexname() << "}{"
1683 << bibitemWidest(buf)
1685 } else if (style->latextype == LATEX_ITEM_ENVIRONMENT) {
1686 os << "\\begin{" << style->latexname() << '}'
1687 << style->latexparam() << '\n';
1689 os << "\\begin{" << style->latexname() << '}'
1690 << style->latexparam() << '\n';
1693 Paragraph * par = this;
1695 par = par->TeXOnePar(buf, bparams, os, texrow, false);
1697 if (par && par->params().depth() > params().depth()) {
1698 if (par->layout()->isParagraph()) {
1701 // How to handle this? (Lgb)
1702 //&& !suffixIs(os, "\n\n")
1704 // There should be at least one '\n' already
1705 // but we need there to be two for Standard
1706 // paragraphs that are depth-increment'ed to be
1707 // output correctly. However, tables can
1708 // also be paragraphs so don't adjust them.
1711 // Will it ever harm to have one '\n' too
1712 // many? i.e. that we sometimes will have
1713 // three in a row. (Lgb)
1717 par = par->pimpl_->TeXDeeper(buf, bparams, os, texrow);
1720 && par->layout() == layout()
1721 && par->params().depth() == params().depth()
1722 && par->params().leftIndent() == params().leftIndent());
1724 if (style->isEnvironment()) {
1725 os << "\\end{" << style->latexname() << "}\n";
1729 if (leftindent_open) {
1730 os << "\\end{LyXParagraphLeftIndent}\n";
1734 lyxerr[Debug::LATEX] << "TeXEnvironment...done " << par << endl;
1735 return par; // ale970302
1739 bool Paragraph::isHfill(pos_type pos) const
1741 return IsHfillChar(getChar(pos));
1745 bool Paragraph::isInset(pos_type pos) const
1747 return IsInsetChar(getChar(pos));
1751 bool Paragraph::isNewline(pos_type pos) const
1753 return pos >= 0 && IsNewlineChar(getChar(pos));
1757 bool Paragraph::isSeparator(pos_type pos) const
1759 return IsSeparatorChar(getChar(pos));
1763 bool Paragraph::isLineSeparator(pos_type pos) const
1765 value_type const c = getChar(pos);
1766 return IsLineSeparatorChar(c)
1767 || (IsInsetChar(c) && getInset(pos) &&
1768 getInset(pos)->isLineSeparator());
1772 bool Paragraph::isKomma(pos_type pos) const
1774 return IsKommaChar(getChar(pos));
1778 /// Used by the spellchecker
1779 bool Paragraph::isLetter(pos_type pos) const
1781 value_type const c = getChar(pos);
1782 if (IsLetterChar(c))
1785 return getInset(pos)->isLetter();
1786 // We want to pass the ' and escape chars to ispell
1787 string const extra = lyxrc.isp_esc_chars + '\'';
1788 return contains(extra, c);
1792 bool Paragraph::isWord(pos_type pos) const
1794 return IsWordChar(getChar(pos)) ;
1799 Paragraph::getParLanguage(BufferParams const & bparams) const
1802 #ifndef INHERIT_LANGUAGE
1803 return getFirstFontSettings().language();
1805 Language const * lang = getFirstFontSettings().language();
1806 #ifdef WITH_WARNINGS
1807 #warning We should make this somewhat better, any ideas? (Jug)
1809 if (lang == inherit_language || lang == ignore_language)
1810 lang = bparams.language;
1813 } else if (previous_)
1814 return previous_->getParLanguage(bparams);
1816 return bparams.language;
1820 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1822 return lyxrc.rtl_support
1823 && getParLanguage(bparams)->RightToLeft()
1824 && !(inInset() && inInset()->owner() &&
1825 inInset()->owner()->lyxCode() == Inset::ERT_CODE);
1829 void Paragraph::changeLanguage(BufferParams const & bparams,
1830 Language const * from, Language const * to)
1832 for (pos_type i = 0; i < size(); ++i) {
1833 LyXFont font = getFontSettings(bparams, i);
1834 if (font.language() == from) {
1835 font.setLanguage(to);
1842 bool Paragraph::isMultiLingual(BufferParams const & bparams)
1844 Language const * doc_language = bparams.language;
1845 Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1846 Pimpl::FontList::const_iterator end = pimpl_->fontlist.end();
1848 for (; cit != end; ++cit)
1849 if (cit->font().language() != ignore_language &&
1850 cit->font().language() != latex_language &&
1851 #ifdef INHERIT_LANGUAGE
1852 cit->font().language() != inherit_language &&
1854 cit->font().language() != doc_language)
1860 // Convert the paragraph to a string.
1861 // Used for building the table of contents
1862 string const Paragraph::asString(Buffer const * buffer, bool label)
1864 BufferParams const & bparams = buffer->params;
1866 if (label && !params().labelString().empty())
1867 s += params().labelString() + ' ';
1868 string::size_type const len = s.size();
1870 for (pos_type i = 0; i < size(); ++i) {
1871 value_type c = getChar(i);
1874 else if (c == META_INSET &&
1875 getInset(i)->lyxCode() == Inset::MATH_CODE) {
1877 getInset(i)->ascii(buffer, ost);
1878 s += subst(ost.str().c_str(),'\n',' ');
1882 if (isRightToLeftPar(bparams))
1883 reverse(s.begin() + len,s.end());
1889 string const Paragraph::asString(Buffer const * buffer,
1890 pos_type beg, pos_type end, bool label)
1894 if (beg == 0 && label && !params().labelString().empty())
1895 ost << params().labelString() << ' ';
1897 for (pos_type i = beg; i < end; ++i) {
1898 value_type const c = getUChar(buffer->params, i);
1901 else if (c == META_NEWLINE)
1903 else if (c == META_HFILL)
1905 else if (c == META_INSET) {
1906 getInset(i)->ascii(buffer, ost);
1910 return ost.str().c_str();
1914 void Paragraph::setInsetOwner(Inset * i)
1916 pimpl_->inset_owner = i;
1917 InsetList::iterator it = insetlist.begin();
1918 InsetList::iterator end = insetlist.end();
1919 for (; it != end; ++it) {
1921 it.getInset()->setOwner(i);
1926 void Paragraph::deleteInsetsLyXText(BufferView * bv)
1929 insetlist.deleteInsetsLyXText(bv);
1933 void Paragraph::resizeInsetsLyXText(BufferView * bv)
1936 insetlist.resizeInsetsLyXText(bv);
1940 void Paragraph::setContentsFromPar(Paragraph * par)
1942 pimpl_->setContentsFromPar(par);
1946 lyx::pos_type Paragraph::size() const
1948 return pimpl_->size();
1952 bool Paragraph::empty() const
1954 return pimpl_->empty();
1958 Paragraph::value_type Paragraph::getChar(pos_type pos) const
1960 return pimpl_->getChar(pos);
1964 int Paragraph::id() const
1970 LyXLayout_ptr const & Paragraph::layout() const
1976 void Paragraph::layout(LyXLayout_ptr const & new_layout)
1978 layout_ = new_layout;
1982 bool Paragraph::isFirstInSequence() const
1984 Paragraph const * dhook = depthHook(getDepth());
1985 return (dhook == this
1986 || dhook->layout() != layout()
1987 || dhook->getDepth() != getDepth());
1991 Inset * Paragraph::inInset() const
1993 return pimpl_->inset_owner;
1997 void Paragraph::clearContents()
2002 void Paragraph::setChar(pos_type pos, value_type c)
2004 pimpl_->setChar(pos, c);
2008 ParagraphParameters & Paragraph::params()
2010 return pimpl_->params;
2014 ParagraphParameters const & Paragraph::params() const
2016 return pimpl_->params;
2020 Paragraph * Paragraph::getParFromID(int id) const
2022 return pimpl_->getParFromID(id);
2026 bool Paragraph::isFreeSpacing() const
2028 // for now we just need this, later should we need this in some
2029 // other way we can always add a function to Inset::() too.
2030 if (pimpl_->inset_owner && pimpl_->inset_owner->owner())
2031 return (pimpl_->inset_owner->owner()->lyxCode() == Inset::ERT_CODE);