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
21 #include "paragraph.h"
22 #include "paragraph_pimpl.h"
23 #include "support/textutils.h"
27 #include "tex-strings.h"
29 #include "bufferparams.h"
30 #include "support/FileInfo.h"
31 #include "support/LAssert.h"
33 #include "LaTeXFeatures.h"
34 #include "insets/insetinclude.h"
35 #include "insets/insetbib.h"
36 #include "insets/insettext.h"
37 #include "support/filetools.h"
38 #include "support/lstrings.h"
39 #include "lyx_gui_misc.h"
41 #include "support/lyxmanip.h"
42 #include "BufferView.h"
44 #include "ParameterStruct.h"
51 using std::lower_bound;
52 using std::upper_bound;
55 int tex_code_break_column = 72; // needs non-zero initialization. set later.
56 // this is a bad idea, but how can Paragraph find its buffer to get
57 // parameters? (JMarc)
59 extern string bibitemWidest(Buffer const *);
61 // this is a minibuffer
66 LyXFont minibuffer_font;
67 Inset * minibuffer_inset;
72 extern BufferView * current_view;
75 Paragraph::Paragraph()
76 : pimpl_(new Paragraph::Pimpl(this))
78 for (int i = 0; i < 10; ++i) setCounter(i , 0);
83 bibkey = 0; // ale970302
88 // This konstruktor inserts the new paragraph in a list.
89 Paragraph::Paragraph(Paragraph * par)
90 : pimpl_(new Paragraph::Pimpl(this))
92 for (int i = 0; i < 10; ++i)
97 // double linked list begin
100 next_->previous_ = this;
102 previous_->next_ = this;
105 bibkey = 0; // ale970302
111 Paragraph::Paragraph(Paragraph const & lp, bool same_ids)
112 : pimpl_(new Paragraph::Pimpl(*lp.pimpl_, this, same_ids))
114 for (int i = 0; i < 10; ++i)
121 // this is because of the dummy layout of the paragraphs that
127 bibkey = static_cast<InsetBibKey *>
128 (lp.bibkey->clone(*current_view->buffer()));
133 // copy everything behind the break-position to the new paragraph
135 insetlist = lp.insetlist;
136 for (InsetList::iterator it = insetlist.begin();
137 it != insetlist.end(); ++it)
139 it->inset = it->inset->clone(*current_view->buffer(), same_ids);
144 // the destructor removes the new paragraph from the list
145 Paragraph::~Paragraph()
148 previous_->next_ = next_;
150 next_->previous_ = previous_;
152 for (InsetList::iterator it = insetlist.begin();
153 it != insetlist.end(); ++it) {
162 //lyxerr << "Paragraph::paragraph_id = "
163 // << Paragraph::paragraph_id << endl;
167 void Paragraph::writeFile(Buffer const * buf, ostream & os,
168 BufferParams const & bparams,
169 depth_type dth) const
171 // The beginning or end of a deeper (i.e. nested) area?
172 if (dth != params().depth()) {
173 if (params().depth() > dth) {
174 while (params().depth() > dth) {
175 os << "\n\\begin_deeper ";
179 while (params().depth() < dth) {
180 os << "\n\\end_deeper ";
186 // First write the layout
188 << textclasslist.NameOfLayout(bparams.textclass, layout)
191 // Maybe some vertical spaces.
192 if (params().spaceTop().kind() != VSpace::NONE)
193 os << "\\added_space_top "
194 << params().spaceTop().asLyXCommand() << " ";
195 if (params().spaceBottom().kind() != VSpace::NONE)
196 os << "\\added_space_bottom "
197 << params().spaceBottom().asLyXCommand() << " ";
199 // Maybe the paragraph has special spacing
200 params().spacing().writeFile(os, true);
202 // The labelwidth string used in lists.
203 if (!params().labelWidthString().empty())
204 os << "\\labelwidthstring "
205 << params().labelWidthString() << '\n';
207 // Lines above or below?
208 if (params().lineTop())
210 if (params().lineBottom())
211 os << "\\line_bottom ";
213 // Pagebreaks above or below?
214 if (params().pagebreakTop())
215 os << "\\pagebreak_top ";
216 if (params().pagebreakBottom())
217 os << "\\pagebreak_bottom ";
219 // Start of appendix?
220 if (params().startOfAppendix())
221 os << "\\start_of_appendix ";
224 if (params().noindent())
228 if (params().align() != LYX_ALIGN_LAYOUT) {
230 switch (params().align()) {
231 case LYX_ALIGN_LEFT: h = 1; break;
232 case LYX_ALIGN_RIGHT: h = 2; break;
233 case LYX_ALIGN_CENTER: h = 3; break;
234 default: h = 0; break;
236 os << "\\align " << string_align[h] << " ";
241 bibkey->write(buf, os);
243 LyXFont font1(LyXFont::ALL_INHERIT, bparams.language);
246 for (size_type i = 0; i < size(); ++i) {
252 // Write font changes
253 LyXFont font2 = getFontSettings(bparams, i);
254 if (font2 != font1) {
255 #ifndef INHERIT_LANGUAGE
256 font2.lyxWriteChanges(font1, os);
258 font2.lyxWriteChanges(font1, bparams.language, os);
264 value_type const c = getChar(i);
268 Inset const * inset = getInset(i);
270 if (inset->directWrite()) {
271 // international char, let it write
272 // code directly so it's shorter in
274 inset->write(buf, os);
276 os << "\n\\begin_inset ";
277 inset->write(buf, os);
278 os << "\n\\end_inset \n\n";
284 os << "\n\\newline \n";
288 os << "\n\\hfill \n";
292 os << "\n\\backslash \n";
296 if (i + 1 < size() && getChar(i + 1) == ' ') {
303 if ((column > 70 && c == ' ')
308 // this check is to amend a bug. LyX sometimes
309 // inserts '\0' this could cause problems.
313 lyxerr << "ERROR (Paragraph::writeFile):"
314 " NULL char in structure." << endl;
320 // now write the next paragraph
322 next_->writeFile(buf, os, bparams, dth);
326 void Paragraph::validate(LaTeXFeatures & features) const
328 BufferParams const & bparams = features.bufferParams();
331 if (params().lineTop() || params().lineBottom())
332 features.lyxline = true;
333 if (!params().spacing().isDefault())
334 features.setspace = true;
337 features.layout[getLayout()] = true;
340 Language const * doc_language = bparams.language;
342 for (Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
343 cit != pimpl_->fontlist.end(); ++cit) {
344 if (cit->font().noun() == LyXFont::ON) {
345 lyxerr[Debug::LATEX] << "font.noun: "
346 << cit->font().noun()
348 features.noun = true;
349 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
350 << cit->font().stateText(0)
353 switch (cit->font().color()) {
355 case LColor::inherit:
357 // probably we should put here all interface colors used for
358 // font displaying! For now I just add this ones I know of (Jug)
363 features.color = true;
364 lyxerr[Debug::LATEX] << "Color enabled. Font: "
365 << cit->font().stateText(0)
369 Language const * language = cit->font().language();
370 if (language->babel() != doc_language->babel() &&
371 language != ignore_language &&
372 #ifdef INHERIT_LANGUAGE
373 language != inherit_language &&
375 language != latex_language)
377 features.UsedLanguages.insert(language);
378 lyxerr[Debug::LATEX] << "Found language "
379 << language->babel() << endl;
384 LyXLayout const & layout =
385 textclasslist.Style(bparams.textclass,
388 for (InsetList::const_iterator cit = insetlist.begin();
389 cit != insetlist.end(); ++cit) {
391 cit->inset->validate(features);
392 if (layout.needprotect &&
393 cit->inset->lyxCode() == Inset::FOOT_CODE)
394 features.NeedLyXFootnoteCode = true;
400 // First few functions needed for cut and paste and paragraph breaking.
401 void Paragraph::copyIntoMinibuffer(Buffer const & buffer,
402 Paragraph::size_type pos) const
404 BufferParams bparams = buffer.params;
406 minibuffer_char = getChar(pos);
407 minibuffer_font = getFontSettings(bparams, pos);
408 minibuffer_inset = 0;
409 if (minibuffer_char == Paragraph::META_INSET) {
411 minibuffer_inset = getInset(pos)->clone(buffer);
413 minibuffer_inset = 0;
414 minibuffer_char = ' ';
415 // This reflects what GetInset() does (ARRae)
421 void Paragraph::cutIntoMinibuffer(BufferParams const & bparams,
422 Paragraph::size_type pos)
424 minibuffer_char = getChar(pos);
425 minibuffer_font = getFontSettings(bparams, pos);
426 minibuffer_inset = 0;
427 if (minibuffer_char == Paragraph::META_INSET) {
429 minibuffer_inset = getInset(pos);
430 // This is a little hack since I want exactly
431 // the inset, not just a clone. Otherwise
432 // the inset would be deleted when calling Erase(pos)
434 InsetTable search_elem(pos, 0);
435 InsetList::iterator it =
436 lower_bound(insetlist.begin(),
438 search_elem, Pimpl::matchIT());
439 if (it != insetlist.end() && it->pos == pos)
442 minibuffer_inset = 0;
443 minibuffer_char = ' ';
444 // This reflects what GetInset() does (ARRae)
449 // Erase(pos); now the caller is responsible for that.
453 bool Paragraph::insertFromMinibuffer(Paragraph::size_type pos)
455 if ((minibuffer_char == Paragraph::META_INSET) &&
456 !insetAllowed(minibuffer_inset->lyxCode()))
458 if (minibuffer_char == Paragraph::META_INSET)
459 insertInset(pos, minibuffer_inset, minibuffer_font);
461 LyXFont f = minibuffer_font;
462 if (checkInsertChar(f))
463 insertChar(pos, minibuffer_char, f);
472 void Paragraph::clear()
481 void Paragraph::erase(Paragraph::size_type pos)
487 bool Paragraph::checkInsertChar(LyXFont & font)
489 if (pimpl_->inset_owner)
490 return pimpl_->inset_owner->checkInsertChar(font);
495 void Paragraph::insertChar(Paragraph::size_type pos, Paragraph::value_type c)
497 LyXFont const f(LyXFont::ALL_INHERIT);
498 insertChar(pos, c, f);
502 void Paragraph::insertChar(Paragraph::size_type pos, Paragraph::value_type c,
503 LyXFont const & font)
505 pimpl_->insertChar(pos, c, font);
509 void Paragraph::insertInset(Paragraph::size_type pos, Inset * inset)
511 LyXFont const f(LyXFont::ALL_INHERIT);
512 insertInset(pos, inset, f);
516 void Paragraph::insertInset(Paragraph::size_type pos, Inset * inset,
517 LyXFont const & font)
519 pimpl_->insertInset(pos, inset, font);
523 bool Paragraph::insetAllowed(Inset::Code code)
525 //lyxerr << "Paragraph::InsertInsetAllowed" << endl;
527 if (pimpl_->inset_owner)
528 return pimpl_->inset_owner->insetAllowed(code);
533 Inset * Paragraph::getInset(Paragraph::size_type pos)
535 lyx::Assert(pos < size());
538 InsetTable search_inset(pos, 0);
539 InsetList::iterator it = lower_bound(insetlist.begin(),
541 search_inset, Pimpl::matchIT());
542 if (it != insetlist.end() && it->pos == pos)
545 lyxerr << "ERROR (Paragraph::getInset): "
546 "Inset does not exist: " << pos << endl;
549 // text[pos] = ' '; // WHY!!! does this set the pos to ' '????
550 // Did this commenting out introduce a bug? So far I have not
551 // see any, please enlighten me. (Lgb)
552 // My guess is that since the inset does not exist, we might
553 // as well replace it with a space to prevent craches. (Asger)
558 Inset const * Paragraph::getInset(Paragraph::size_type pos) const
560 lyx::Assert(pos < size());
563 InsetTable search_inset(pos, 0);
564 InsetList::const_iterator cit = lower_bound(insetlist.begin(),
566 search_inset, Pimpl::matchIT());
567 if (cit != insetlist.end() && cit->pos == pos)
570 lyxerr << "ERROR (Paragraph::GetInset): "
571 "Inset does not exist: " << pos << endl;
573 //text[pos] = ' '; // WHY!!! does this set the pos to ' '????
574 // Did this commenting out introduce a bug? So far I have not
575 // see any, please enlighten me. (Lgb)
576 // My guess is that since the inset does not exist, we might
577 // as well replace it with a space to prevent craches. (Asger)
582 // Gets uninstantiated font setting at position.
583 LyXFont const Paragraph::getFontSettings(BufferParams const & bparams,
584 Paragraph::size_type pos) const
586 lyx::Assert(pos <= size());
588 Pimpl::FontTable search_font(pos, LyXFont());
589 Pimpl::FontList::const_iterator cit = lower_bound(pimpl_->fontlist.begin(),
590 pimpl_->fontlist.end(),
591 search_font, Pimpl::matchFT());
593 if (cit != pimpl_->fontlist.end()) {
594 retfont = cit->font();
595 } else if (pos == size() && size()) {
596 retfont = getFontSettings(bparams, pos - 1);
598 retfont = LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
599 #ifdef INHERIT_LANGUAGE
600 if (retfont.language() == inherit_language)
601 retfont.setLanguage(bparams.language);
608 // Gets uninstantiated font setting at position 0
609 LyXFont const Paragraph::getFirstFontSettings() const
612 if (!pimpl_->fontlist.empty())
613 return pimpl_->fontlist[0].font();
616 return LyXFont(LyXFont::ALL_INHERIT);
620 // Gets the fully instantiated font at a given position in a paragraph
621 // This is basically the same function as LyXText::GetFont() in text2.C.
622 // The difference is that this one is used for generating the LaTeX file,
623 // and thus cosmetic "improvements" are disallowed: This has to deliver
624 // the true picture of the buffer. (Asger)
625 // If position is -1, we get the layout font of the paragraph.
626 // If position is -2, we get the font of the manual label of the paragraph.
627 LyXFont const Paragraph::getFont(BufferParams const & bparams,
628 Paragraph::size_type pos) const
630 lyx::Assert(pos >= 0);
632 LyXLayout const & layout =
633 textclasslist.Style(bparams.textclass,
635 Paragraph::size_type main_body = 0;
636 if (layout.labeltype == LABEL_MANUAL)
637 main_body = beginningOfMainBody();
641 layoutfont = layout.labelfont;
643 layoutfont = layout.font;
645 LyXFont tmpfont = getFontSettings(bparams, pos);
646 #ifndef INHERIT_LANGUAGE
647 tmpfont.realize(layoutfont);
649 tmpfont.realize(layoutfont, bparams.language);
652 return pimpl_->realizeFont(tmpfont, bparams);
656 LyXFont const Paragraph::getLabelFont(BufferParams const & bparams) const
658 LyXLayout const & layout =
659 textclasslist.Style(bparams.textclass, getLayout());
661 LyXFont tmpfont = layout.labelfont;
662 tmpfont.setLanguage(getParLanguage(bparams));
664 return pimpl_->realizeFont(tmpfont, bparams);
668 LyXFont const Paragraph::getLayoutFont(BufferParams const & bparams) const
670 LyXLayout const & layout =
671 textclasslist.Style(bparams.textclass,
674 LyXFont tmpfont = layout.font;
675 tmpfont.setLanguage(getParLanguage(bparams));
677 return pimpl_->realizeFont(tmpfont, bparams);
681 /// Returns the height of the highest font in range
683 Paragraph::highestFontInRange(Paragraph::size_type startpos,
684 Paragraph::size_type endpos,
685 LyXFont::FONT_SIZE const def_size) const
687 if (pimpl_->fontlist.empty())
690 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
691 Pimpl::FontTable end_search(endpos, LyXFont());
692 Pimpl::FontList::const_iterator end_it =
693 lower_bound(pimpl_->fontlist.begin(),
694 pimpl_->fontlist.end(),
695 end_search, Pimpl::matchFT());
696 if (end_it != pimpl_->fontlist.end())
699 Pimpl::FontTable start_search(startpos, LyXFont());
700 Pimpl::FontList::const_iterator cit =
701 lower_bound(pimpl_->fontlist.begin(),
702 pimpl_->fontlist.end(),
703 start_search, Pimpl::matchFT());
705 for (; cit != end_it; ++cit) {
706 LyXFont::FONT_SIZE size = cit->font().size();
707 if (size == LyXFont::INHERIT_SIZE)
709 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
716 Paragraph::value_type
717 Paragraph::getUChar(BufferParams const & bparams,
718 Paragraph::size_type pos) const
720 value_type c = getChar(pos);
721 if (!lyxrc.rtl_support)
751 if (uc != c && getFontSettings(bparams, pos).isRightToLeft())
758 void Paragraph::setFont(Paragraph::size_type pos,
759 LyXFont const & font)
761 lyx::Assert(pos <= size());
763 // First, reduce font against layout/label font
764 // Update: The SetCharFont() routine in text2.C already
765 // reduces font, so we don't need to do that here. (Asger)
766 // No need to simplify this because it will disappear
767 // in a new kernel. (Asger)
768 // Next search font table
770 Pimpl::FontTable search_font(pos, LyXFont());
771 Pimpl::FontList::iterator it = lower_bound(pimpl_->fontlist.begin(),
772 pimpl_->fontlist.end(),
773 search_font, Pimpl::matchFT());
774 unsigned int i = it - pimpl_->fontlist.begin();
775 bool notfound = it == pimpl_->fontlist.end();
777 if (!notfound && pimpl_->fontlist[i].font() == font)
780 bool begin = pos == 0 || notfound ||
781 (i > 0 && pimpl_->fontlist[i-1].pos() == pos - 1);
782 // Is position pos is a beginning of a font block?
783 bool end = !notfound && pimpl_->fontlist[i].pos() == pos;
784 // Is position pos is the end of a font block?
785 if (begin && end) { // A single char block
786 if (i + 1 < pimpl_->fontlist.size() &&
787 pimpl_->fontlist[i + 1].font() == font) {
788 // Merge the singleton block with the next block
789 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
790 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
791 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i-1);
792 } else if (i > 0 && pimpl_->fontlist[i - 1].font() == font) {
793 // Merge the singleton block with the previous block
794 pimpl_->fontlist[i - 1].pos(pos);
795 pimpl_->fontlist.erase(pimpl_->fontlist.begin() + i);
797 pimpl_->fontlist[i].font(font);
799 if (i > 0 && pimpl_->fontlist[i - 1].font() == font)
800 pimpl_->fontlist[i - 1].pos(pos);
802 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
803 Pimpl::FontTable(pos, font));
805 pimpl_->fontlist[i].pos(pos - 1);
806 if (!(i + 1 < pimpl_->fontlist.size() &&
807 pimpl_->fontlist[i + 1].font() == font))
808 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
809 Pimpl::FontTable(pos, font));
810 } else { // The general case. The block is splitted into 3 blocks
811 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i,
812 Pimpl::FontTable(pos - 1, pimpl_->fontlist[i].font()));
813 pimpl_->fontlist.insert(pimpl_->fontlist.begin() + i + 1,
814 Pimpl::FontTable(pos, font));
820 void Paragraph::next(Paragraph * p)
826 // This function is able to hide closed footnotes.
827 Paragraph * Paragraph::next()
833 Paragraph const * Paragraph::next() const
839 void Paragraph::previous(Paragraph * p)
845 // This function is able to hide closed footnotes.
846 Paragraph * Paragraph::previous()
852 // This function is able to hide closed footnotes.
853 Paragraph const * Paragraph::previous() const
859 void Paragraph::breakParagraph(BufferParams const & bparams,
860 Paragraph::size_type pos,
863 // create a new paragraph
864 Paragraph * tmp = new Paragraph(this);
865 // remember to set the inset_owner
866 tmp->setInsetOwner(inInset());
868 // this is an idea for a more userfriendly layout handling, I will
869 // see what the users say
871 // layout stays the same with latex-environments
873 tmp->setOnlyLayout(layout);
874 tmp->setLabelWidthString(params().labelWidthString());
877 if (size() > pos || !size() || flag == 2) {
878 tmp->setOnlyLayout(layout);
879 tmp->params().align(params().align());
880 tmp->setLabelWidthString(params().labelWidthString());
882 tmp->params().lineBottom(params().lineBottom());
883 params().lineBottom(false);
884 tmp->params().pagebreakBottom(params().pagebreakBottom());
885 params().pagebreakBottom(false);
886 tmp->params().spaceBottom(params().spaceBottom());
887 params().spaceBottom(VSpace(VSpace::NONE));
889 tmp->params().depth(params().depth());
890 tmp->params().noindent(params().noindent());
892 // copy everything behind the break-position
893 // to the new paragraph
894 size_type pos_end = pimpl_->size() - 1;
897 for (; i <= pos_end; ++i) {
898 cutIntoMinibuffer(bparams, i);
899 if (tmp->insertFromMinibuffer(j - pos))
902 for (i = pos_end; i >= pos; --i) {
907 // just an idea of me
909 tmp->params().lineTop(params().lineTop());
910 tmp->params().pagebreakTop(params().pagebreakTop());
911 tmp->params().spaceTop(params().spaceTop());
912 tmp->bibkey = bibkey;
914 // layout stays the same with latex-environments
916 setOnlyLayout(tmp->layout);
917 setLabelWidthString(tmp->params().labelWidthString());
918 params().depth(tmp->params().depth());
924 void Paragraph::makeSameLayout(Paragraph const * par)
926 layout = par->layout;
928 params() = par->params();
932 int Paragraph::stripLeadingSpaces(LyXTextClassList::size_type tclass)
934 if (textclasslist.Style(tclass, getLayout()).free_spacing)
939 && (isNewline(0) || isLineSeparator(0))){
948 bool Paragraph::hasSameLayout(Paragraph const * par) const
951 par->layout == layout &&
952 params().sameLayout(par->params());
956 void Paragraph::breakParagraphConservative(BufferParams const & bparams,
957 Paragraph::size_type pos)
959 // create a new paragraph
960 Paragraph * tmp = new Paragraph(this);
961 tmp->makeSameLayout(this);
963 // When can pos > Last()?
964 // I guess pos == Last() is possible.
966 // copy everything behind the break-position to the new
968 size_type pos_end = pimpl_->size() - 1;
972 for (size_type i = pos, j = pos; i <= pos_end; ++i) {
973 cutIntoMinibuffer(bparams, i);
974 if (tmp->insertFromMinibuffer(j - pos))
978 for (size_type k = pos_end; k >= pos; --k) {
985 // Be carefull, this does not make any check at all.
986 // This method has wrong name, it combined this par with the next par.
987 // In that sense it is the reverse of break paragraph. (Lgb)
988 void Paragraph::pasteParagraph(BufferParams const & bparams)
990 // copy the next paragraph to this one
991 Paragraph * the_next = next();
993 // first the DTP-stuff
994 params().lineBottom(the_next->params().lineBottom());
995 params().spaceBottom(the_next->params().spaceBottom());
996 params().pagebreakBottom(the_next->params().pagebreakBottom());
998 size_type pos_end = the_next->pimpl_->size() - 1;
999 size_type pos_insert = size();
1001 // ok, now copy the paragraph
1002 for (size_type i = 0, j = 0; i <= pos_end; ++i) {
1003 the_next->cutIntoMinibuffer(bparams, i);
1004 if (insertFromMinibuffer(pos_insert + j))
1008 // delete the next paragraph
1009 Paragraph * ppar = the_next->previous_;
1010 Paragraph * npar = the_next->next_;
1016 int Paragraph::getEndLabel(BufferParams const & bparams) const
1018 Paragraph const * par = this;
1019 depth_type par_depth = getDepth();
1021 LyXTextClass::LayoutList::size_type layout = par->getLayout();
1022 int const endlabeltype =
1023 textclasslist.Style(bparams.textclass,
1024 layout).endlabeltype;
1025 if (endlabeltype != END_LABEL_NO_LABEL) {
1027 return endlabeltype;
1029 depth_type const next_depth = next_->getDepth();
1030 if (par_depth > next_depth ||
1031 (par_depth == next_depth
1032 && layout != next_->getLayout()))
1033 return endlabeltype;
1038 par = par->outerHook();
1040 par_depth = par->getDepth();
1042 return END_LABEL_NO_LABEL;
1046 Paragraph::depth_type Paragraph::getDepth() const
1048 return params().depth();
1052 char Paragraph::getAlign() const
1054 return params().align();
1058 string const & Paragraph::getLabelstring() const
1060 return params().labelString();
1064 int Paragraph::getFirstCounter(int i) const
1066 return pimpl_->counter_[i];
1070 // the next two functions are for the manual labels
1071 string const Paragraph::getLabelWidthString() const
1073 if (!params().labelWidthString().empty())
1074 return params().labelWidthString();
1076 return _("Senseless with this layout!");
1080 void Paragraph::setLabelWidthString(string const & s)
1082 params().labelWidthString(s);
1086 void Paragraph::setOnlyLayout(LyXTextClass::size_type new_layout)
1088 layout = new_layout;
1092 void Paragraph::setLayout(LyXTextClass::size_type new_layout)
1094 layout = new_layout;
1095 params().labelWidthString(string());
1096 params().align(LYX_ALIGN_LAYOUT);
1097 params().spaceTop(VSpace(VSpace::NONE));
1098 params().spaceBottom(VSpace(VSpace::NONE));
1099 params().spacing(Spacing(Spacing::Default));
1103 // if the layout of a paragraph contains a manual label, the beginning of the
1104 // main body is the beginning of the second word. This is what the par-
1105 // function returns. If the layout does not contain a label, the main
1106 // body always starts with position 0. This differentiation is necessary,
1107 // because there cannot be a newline or a blank <= the beginning of the
1108 // main body in TeX.
1110 int Paragraph::beginningOfMainBody() const
1112 // Unroll the first two cycles of the loop
1113 // and remember the previous character to
1114 // remove unnecessary GetChar() calls
1117 && getChar(i) != Paragraph::META_NEWLINE) {
1119 char previous_char = 0;
1122 && (previous_char = getChar(i)) != Paragraph::META_NEWLINE) {
1123 // Yes, this ^ is supposed to be "= " not "=="
1126 && previous_char != ' '
1127 && (temp = getChar(i)) != Paragraph::META_NEWLINE) {
1129 previous_char = temp;
1138 Paragraph * Paragraph::depthHook(depth_type depth)
1140 Paragraph * newpar = this;
1143 newpar = newpar->previous();
1144 } while (newpar && newpar->getDepth() > depth);
1147 if (previous() || getDepth())
1148 lyxerr << "ERROR (Paragraph::DepthHook): "
1157 Paragraph const * Paragraph::depthHook(depth_type depth) const
1159 Paragraph const * newpar = this;
1162 newpar = newpar->previous();
1163 } while (newpar && newpar->getDepth() > depth);
1166 if (previous() || getDepth())
1167 lyxerr << "ERROR (Paragraph::DepthHook): "
1175 Paragraph * Paragraph::outerHook()
1179 return depthHook(depth_type(getDepth() - 1));
1182 Paragraph const * Paragraph::outerHook() const
1186 return depthHook(depth_type(getDepth() - 1));
1189 int Paragraph::autoDeleteInsets()
1192 InsetList::size_type index = 0;
1193 while (index < insetlist.size()) {
1194 if (insetlist[index].inset && insetlist[index].inset->autoDelete()) {
1195 erase(insetlist[index].pos);
1196 // Erase() calls to insetlist.erase(&insetlist[index])
1197 // so index shouldn't be increased.
1206 Paragraph::inset_iterator
1207 Paragraph::InsetIterator(Paragraph::size_type pos)
1209 InsetTable search_inset(pos, 0);
1210 InsetList::iterator it = lower_bound(insetlist.begin(),
1212 search_inset, Pimpl::matchIT());
1213 return inset_iterator(it);
1217 // returns -1 if inset not found
1218 int Paragraph::getPositionOfInset(Inset * inset) const
1221 for (InsetList::const_iterator cit = insetlist.begin();
1222 cit != insetlist.end(); ++cit) {
1223 if (cit->inset == inset) {
1227 if (inset == bibkey)
1234 Paragraph * Paragraph::TeXOnePar(Buffer const * buf,
1235 BufferParams const & bparams,
1236 ostream & os, TexRow & texrow,
1239 lyxerr[Debug::LATEX] << "TeXOnePar... " << this << endl;
1240 LyXLayout const & style =
1241 textclasslist.Style(bparams.textclass,
1244 bool further_blank_line = false;
1246 if (params().startOfAppendix()) {
1247 os << "\\appendix\n";
1251 if (!params().spacing().isDefault()
1252 && (!previous() || !previous()->hasSameLayout(this))) {
1253 os << params().spacing().writeEnvirBegin() << "\n";
1257 if (tex_code_break_column && style.isCommand()){
1262 if (params().pagebreakTop()) {
1264 further_blank_line = true;
1266 if (params().spaceTop().kind() != VSpace::NONE) {
1267 os << params().spaceTop().asLatexCommand(bparams);
1268 further_blank_line = true;
1271 if (params().lineTop()) {
1272 os << "\\lyxline{\\" << getFont(bparams, 0).latexSize() << '}'
1273 << "\\vspace{-1\\parskip}";
1274 further_blank_line = true;
1277 if (further_blank_line){
1282 Language const * language = getParLanguage(bparams);
1283 Language const * doc_language = bparams.language;
1284 Language const * previous_language = previous()
1285 ? previous()->getParLanguage(bparams) : doc_language;
1287 if (language->babel() != previous_language->babel()
1288 // check if we already put language command in TeXEnvironment()
1289 && !(textclasslist.Style(bparams.textclass, layout).isEnvironment()
1290 && (!previous() || previous()->layout != layout ||
1291 previous()->params().depth() != params().depth()))) {
1293 if (!lyxrc.language_command_end.empty() &&
1294 previous_language->babel() != doc_language->babel()) {
1295 os << subst(lyxrc.language_command_end, "$$lang",
1296 previous_language->babel())
1301 if (lyxrc.language_command_end.empty() ||
1302 language->babel() != doc_language->babel()) {
1303 os << subst(lyxrc.language_command_begin, "$$lang",
1310 if (bparams.inputenc == "auto" &&
1311 language->encoding() != previous_language->encoding()) {
1312 os << "\\inputencoding{"
1313 << language->encoding()->LatexName()
1318 switch (style.latextype) {
1321 << style.latexname()
1322 << style.latexparam();
1324 case LATEX_ITEM_ENVIRONMENT:
1326 bibkey->latex(buf, os, false, false);
1330 case LATEX_LIST_ENVIRONMENT:
1337 bool need_par = simpleTeXOnePar(buf, bparams, os, texrow, moving_arg);
1339 // Make sure that \\par is done with the font of the last
1340 // character if this has another size as the default.
1341 // This is necessary because LaTeX (and LyX on the screen)
1342 // calculates the space between the baselines according
1343 // to this font. (Matthias)
1345 // Is this really needed ? (Dekel)
1346 // We do not need to use to change the font for the last paragraph
1347 // or for a command.
1348 LyXFont const font =
1350 ? getLayoutFont(bparams)
1351 : getFont(bparams, size() - 1));
1353 bool is_command = textclasslist.Style(bparams.textclass,
1354 getLayout()).isCommand();
1355 if (style.resfont.size() != font.size() && next_ && !is_command) {
1358 os << "\\" << font.latexSize() << " \\par}";
1359 } else if (need_par) {
1361 } else if (is_command)
1364 switch (style.latextype) {
1365 case LATEX_ITEM_ENVIRONMENT:
1366 case LATEX_LIST_ENVIRONMENT:
1367 if (next_ && (params().depth() < next_->params().depth())) {
1372 case LATEX_ENVIRONMENT:
1373 // if its the last paragraph of the current environment
1374 // skip it otherwise fall through
1376 && (next_->layout != layout
1377 || next_->params().depth() != params().depth()))
1380 // we don't need it for the last paragraph!!!
1387 further_blank_line = false;
1388 if (params().lineBottom()) {
1389 os << "\\lyxline{\\" << font.latexSize() << '}';
1390 further_blank_line = true;
1393 if (params().spaceBottom().kind() != VSpace::NONE) {
1394 os << params().spaceBottom().asLatexCommand(bparams);
1395 further_blank_line = true;
1398 if (params().pagebreakBottom()) {
1400 further_blank_line = true;
1403 if (further_blank_line){
1408 if (!params().spacing().isDefault()
1409 && (!next_ || !next_->hasSameLayout(this))) {
1410 os << params().spacing().writeEnvirEnd() << "\n";
1414 // we don't need it for the last paragraph!!!
1419 // Since \selectlanguage write the language to the aux file,
1420 // we need to reset the language at the end of footnote or
1423 if (language->babel() != doc_language->babel()) {
1424 if (lyxrc.language_command_end.empty())
1425 os << subst(lyxrc.language_command_begin,
1427 doc_language->babel())
1430 os << subst(lyxrc.language_command_end,
1438 lyxerr[Debug::LATEX] << "TeXOnePar...done " << next_ << endl;
1443 // This one spits out the text of the paragraph
1444 bool Paragraph::simpleTeXOnePar(Buffer const * buf,
1445 BufferParams const & bparams,
1446 ostream & os, TexRow & texrow,
1449 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
1451 bool return_value = false;
1453 LyXLayout const & style =
1454 textclasslist.Style(bparams.textclass,
1458 // Maybe we have to create a optional argument.
1459 size_type main_body;
1460 if (style.labeltype != LABEL_MANUAL)
1463 main_body = beginningOfMainBody();
1467 if (main_body > 0) {
1470 basefont = getLabelFont(bparams);
1472 basefont = getLayoutFont(bparams);
1476 && !pimpl_->size()) {
1477 if (style.isCommand()) {
1483 moving_arg |= style.needprotect;
1485 // Which font is currently active?
1486 LyXFont running_font(basefont);
1487 // Do we have an open font change?
1488 bool open_font = false;
1490 texrow.start(this, 0);
1492 for (size_type i = 0; i < size(); ++i) {
1494 // First char in paragraph or after label?
1495 if (i == main_body) {
1496 if (main_body > 0) {
1498 column += running_font.latexWriteEndChanges(os, basefont, basefont);
1501 basefont = getLayoutFont(bparams);
1502 running_font = basefont;
1506 if (style.isCommand()) {
1511 if (params().noindent()) {
1512 os << "\\noindent ";
1515 switch (params().align()) {
1516 case LYX_ALIGN_NONE:
1517 case LYX_ALIGN_BLOCK:
1518 case LYX_ALIGN_LAYOUT:
1519 case LYX_ALIGN_SPECIAL:
1521 case LYX_ALIGN_LEFT:
1522 if (getParLanguage(bparams)->babel() != "hebrew") {
1523 os << "\\begin{flushleft}";
1526 os << "\\begin{flushright}";
1530 case LYX_ALIGN_RIGHT:
1531 if (getParLanguage(bparams)->babel() != "hebrew") {
1532 os << "\\begin{flushright}";
1535 os << "\\begin{flushleft}";
1539 case LYX_ALIGN_CENTER:
1540 os << "\\begin{center}";
1546 value_type c = getChar(i);
1548 // Fully instantiated font
1549 LyXFont font = getFont(bparams, i);
1551 LyXFont const last_font = running_font;
1553 // Spaces at end of font change are simulated to be
1554 // outside font change, i.e. we write "\textXX{text} "
1555 // rather than "\textXX{text }". (Asger)
1556 if (open_font && c == ' ' && i <= size() - 2) {
1557 LyXFont const next_font = getFont(bparams, i + 1);
1558 if (next_font != running_font
1559 && next_font != font) {
1564 // We end font definition before blanks
1565 if (font != running_font && open_font) {
1566 column += running_font.latexWriteEndChanges(os,
1568 (i == main_body-1) ? basefont : font);
1569 running_font = basefont;
1573 // Blanks are printed before start of fontswitch
1575 // Do not print the separation of the optional argument
1576 if (i != main_body - 1) {
1577 pimpl_->simpleTeXBlanks(os, texrow, i,
1578 column, font, style);
1582 // Do we need to change font?
1583 if (font != running_font && i != main_body - 1) {
1584 column += font.latexWriteStartChanges(os, basefont,
1586 running_font = font;
1590 if (c == Paragraph::META_NEWLINE) {
1591 // newlines are handled differently here than
1592 // the default in SimpleTeXSpecialChars().
1593 if (!style.newline_allowed) {
1597 column += running_font.latexWriteEndChanges(os, basefont, basefont);
1600 basefont = getLayoutFont(bparams);
1601 running_font = basefont;
1602 if (font.family() ==
1603 LyXFont::TYPEWRITER_FAMILY) {
1611 texrow.start(this, i + 1);
1614 pimpl_->simpleTeXSpecialChars(buf, bparams,
1615 os, texrow, moving_arg,
1617 basefont, open_font,
1618 style, i, column, c);
1622 // If we have an open font definition, we have to close it
1624 #ifdef FIXED_LANGUAGE_END_DETECTION
1627 .latexWriteEndChanges(os, basefont,
1628 next_->getFont(bparams,
1631 running_font.latexWriteEndChanges(os, basefont,
1635 #ifdef WITH_WARNINGS
1636 //#warning For now we ALWAYS have to close the foreign font settings if they are
1637 //#warning there as we start another \selectlanguage with the next paragraph if
1638 //#warning we are in need of this. This should be fixed sometime (Jug)
1640 running_font.latexWriteEndChanges(os, basefont, basefont);
1644 // Needed if there is an optional argument but no contents.
1645 if (main_body > 0 && main_body == size()) {
1647 return_value = false;
1650 switch (params().align()) {
1651 case LYX_ALIGN_NONE:
1652 case LYX_ALIGN_BLOCK:
1653 case LYX_ALIGN_LAYOUT:
1654 case LYX_ALIGN_SPECIAL:
1656 case LYX_ALIGN_LEFT:
1657 if (getParLanguage(bparams)->babel() != "hebrew") {
1658 os << "\\end{flushleft}";
1661 os << "\\end{flushright}";
1665 case LYX_ALIGN_RIGHT:
1666 if (getParLanguage(bparams)->babel() != "hebrew") {
1667 os << "\\end{flushright}";
1670 os << "\\end{flushleft}";
1674 case LYX_ALIGN_CENTER:
1675 os << "\\end{center}";
1680 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
1681 return return_value;
1685 bool Paragraph::sgmlConvertChar(char c, string & sgml_string)
1687 bool retval = false;
1689 case Paragraph::META_HFILL:
1690 sgml_string.erase();
1692 case Paragraph::META_NEWLINE:
1696 sgml_string = "&";
1699 sgml_string = "<";
1702 sgml_string = ">";
1705 sgml_string = "$";
1708 sgml_string = "#";
1711 sgml_string = "%";
1714 sgml_string = "[";
1717 sgml_string = "]";
1720 sgml_string = "{";
1723 sgml_string = "}";
1726 sgml_string = "˜";
1729 sgml_string = """;
1732 sgml_string = "\";
1738 case '\0': // Ignore :-)
1739 sgml_string.erase();
1749 Paragraph * Paragraph::TeXEnvironment(Buffer const * buf,
1750 BufferParams const & bparams,
1751 ostream & os, TexRow & texrow)
1753 lyxerr[Debug::LATEX] << "TeXEnvironment... " << this << endl;
1755 LyXLayout const & style =
1756 textclasslist.Style(bparams.textclass,
1759 Language const * language = getParLanguage(bparams);
1760 Language const * doc_language = bparams.language;
1761 Language const * previous_language = previous_
1762 ? previous_->getParLanguage(bparams) : doc_language;
1763 if (language->babel() != previous_language->babel()) {
1765 if (!lyxrc.language_command_end.empty() &&
1766 previous_language->babel() != doc_language->babel()) {
1767 os << subst(lyxrc.language_command_end, "$$lang",
1768 previous_language->babel())
1773 if (lyxrc.language_command_end.empty() ||
1774 language->babel() != doc_language->babel()) {
1775 os << subst(lyxrc.language_command_begin, "$$lang",
1782 if (style.isEnvironment()){
1783 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
1784 os << "\\begin{" << style.latexname() << "}{"
1785 << params().labelWidthString() << "}\n";
1786 } else if (style.labeltype == LABEL_BIBLIO) {
1788 os << "\\begin{" << style.latexname() << "}{"
1789 << bibitemWidest(buf)
1791 } else if (style.latextype == LATEX_ITEM_ENVIRONMENT) {
1792 os << "\\begin{" << style.latexname() << '}'
1793 << style.latexparam() << '\n';
1795 os << "\\begin{" << style.latexname() << '}'
1796 << style.latexparam() << '\n';
1799 Paragraph * par = this;
1801 par = par->TeXOnePar(buf, bparams,
1804 if (par && par->params().depth() > params().depth()) {
1805 if (textclasslist.Style(bparams.textclass,
1806 par->layout).isParagraph()
1808 // How to handle this? (Lgb)
1809 //&& !suffixIs(os, "\n\n")
1811 // There should be at least one '\n' already
1812 // but we need there to be two for Standard
1813 // paragraphs that are depth-increment'ed to be
1814 // output correctly. However, tables can
1815 // also be paragraphs so don't adjust them.
1818 // Will it ever harm to have one '\n' too
1819 // many? i.e. that we sometimes will have
1820 // three in a row. (Lgb)
1824 par = par->pimpl_->TeXDeeper(buf, bparams, os, texrow);
1827 && par->layout == layout
1828 && par->params().depth() == params().depth());
1830 if (style.isEnvironment()) {
1831 os << "\\end{" << style.latexname() << "}\n";
1834 lyxerr[Debug::LATEX] << "TeXEnvironment...done " << par << endl;
1835 return par; // ale970302
1839 bool Paragraph::isHfill(size_type pos) const
1841 return IsHfillChar(getChar(pos));
1845 bool Paragraph::isInset(size_type pos) const
1847 return IsInsetChar(getChar(pos));
1851 bool Paragraph::isNewline(size_type pos) const
1853 return pos >= 0 && IsNewlineChar(getChar(pos));
1857 bool Paragraph::isSeparator(size_type pos) const
1859 return IsSeparatorChar(getChar(pos));
1863 bool Paragraph::isLineSeparator(size_type pos) const
1865 return IsLineSeparatorChar(getChar(pos));
1869 bool Paragraph::isKomma(size_type pos) const
1871 return IsKommaChar(getChar(pos));
1875 /// Used by the spellchecker
1876 bool Paragraph::isLetter(Paragraph::size_type pos) const
1878 value_type const c = getChar(pos);
1879 if (IsLetterChar(c))
1882 return getInset(pos)->isLetter();
1883 // We want to pass the ' and escape chars to ispell
1884 string const extra = lyxrc.isp_esc_chars + '\'';
1885 return contains(extra, c);
1889 bool Paragraph::isWord(size_type pos ) const
1891 return IsWordChar(getChar(pos)) ;
1896 Paragraph::getParLanguage(BufferParams const & bparams) const
1899 #ifndef INHERIT_LANGUAGE
1900 return getFirstFontSettings().language();
1902 Language const * lang = getFirstFontSettings().language();
1903 #warning We should make this somewhat better, any ideas? (Jug)
1904 if (lang == inherit_language || lang == ignore_language)
1905 lang = bparams.language;
1908 } else if (previous_)
1909 return previous_->getParLanguage(bparams);
1911 return bparams.language;
1915 bool Paragraph::isRightToLeftPar(BufferParams const & bparams) const
1917 return lyxrc.rtl_support
1918 && getParLanguage(bparams)->RightToLeft();
1922 void Paragraph::changeLanguage(BufferParams const & bparams,
1923 Language const * from, Language const * to)
1925 for (size_type i = 0; i < size(); ++i) {
1926 LyXFont font = getFontSettings(bparams, i);
1927 if (font.language() == from) {
1928 font.setLanguage(to);
1935 bool Paragraph::isMultiLingual(BufferParams const & bparams)
1937 Language const * doc_language = bparams.language;
1938 for (Pimpl::FontList::const_iterator cit = pimpl_->fontlist.begin();
1939 cit != pimpl_->fontlist.end(); ++cit)
1940 if (cit->font().language() != ignore_language &&
1941 cit->font().language() != latex_language &&
1942 #ifdef INHERIT_LANGUAGE
1943 cit->font().language() != inherit_language &&
1945 cit->font().language() != doc_language)
1951 // Convert the paragraph to a string.
1952 // Used for building the table of contents
1953 string const Paragraph::asString(Buffer const * buffer, bool label)
1955 BufferParams const & bparams = buffer->params;
1957 if (label && !params().labelString().empty())
1958 s += params().labelString() + ' ';
1959 string::size_type const len = s.size();
1961 for (Paragraph::size_type i = 0; i < size(); ++i) {
1962 value_type c = getChar(i);
1965 else if (c == META_INSET &&
1966 getInset(i)->lyxCode() == Inset::MATH_CODE) {
1968 getInset(i)->ascii(buffer, ost);
1969 s += subst(ost.str().c_str(),'\n',' ');
1973 if (isRightToLeftPar(bparams))
1974 reverse(s.begin() + len,s.end());
1980 string const Paragraph::asString(Buffer const * buffer,
1981 Paragraph::size_type beg,
1982 Paragraph::size_type end,
1987 if (beg == 0 && label && !params().labelString().empty())
1988 ost << params().labelString() << ' ';
1990 for (Paragraph::size_type i = beg; i < end; ++i) {
1991 value_type const c = getUChar(buffer->params, i);
1994 else if (c == META_NEWLINE)
1996 else if (c == META_HFILL)
1998 else if (c == META_INSET) {
1999 getInset(i)->ascii(buffer, ost);
2003 return ost.str().c_str();
2007 void Paragraph::setInsetOwner(Inset * i)
2009 pimpl_->inset_owner = i;
2010 for (InsetList::const_iterator cit = insetlist.begin();
2011 cit != insetlist.end(); ++cit) {
2013 cit->inset->setOwner(i);
2018 void Paragraph::deleteInsetsLyXText(BufferView * bv)
2021 for (InsetList::const_iterator cit = insetlist.begin();
2022 cit != insetlist.end(); ++cit) {
2024 if (cit->inset->isTextInset()) {
2025 static_cast<UpdatableInset *>
2026 (cit->inset)->deleteLyXText(bv, true);
2033 void Paragraph::resizeInsetsLyXText(BufferView * bv)
2036 for (InsetList::const_iterator cit = insetlist.begin();
2037 cit != insetlist.end(); ++cit)
2040 if (cit->inset->isTextInset()) {
2041 static_cast<UpdatableInset *>
2042 (cit->inset)->resizeLyXText(bv, true);
2049 void Paragraph::setContentsFromPar(Paragraph * par)
2051 pimpl_->setContentsFromPar(par);
2055 Paragraph::size_type Paragraph::size() const
2057 return pimpl_->size();
2061 Paragraph::value_type
2062 Paragraph::getChar(Paragraph::size_type pos) const
2064 return pimpl_->getChar(pos);
2068 int Paragraph::id() const
2074 void Paragraph::id(int id_arg)
2076 pimpl_->id_ = id_arg;
2080 LyXTextClass::LayoutList::size_type Paragraph::getLayout() const
2086 bool Paragraph::isFirstInSequence() const
2088 Paragraph const * dhook = depthHook(getDepth());
2089 return (dhook == this
2090 || dhook->getLayout() != getLayout()
2091 || dhook->getDepth() != getDepth());
2095 Inset * Paragraph::inInset() const
2097 return pimpl_->inset_owner;
2101 void Paragraph::clearContents()
2107 void Paragraph::setCounter(int i, int v)
2109 pimpl_->counter_[i] = v;
2113 int Paragraph::getCounter(int i) const
2115 return pimpl_->counter_[i];
2119 void Paragraph::incCounter(int i)
2121 pimpl_->counter_[i]++;
2125 void Paragraph::setChar(size_type pos, value_type c)
2127 pimpl_->setChar(pos, c);
2131 Paragraph::inset_iterator::inset_iterator(Paragraph::InsetList::iterator const & iter)
2136 Paragraph::inset_iterator Paragraph::inset_iterator_begin()
2138 return inset_iterator(insetlist.begin());
2142 Paragraph::inset_iterator Paragraph::inset_iterator_end()
2144 return inset_iterator(insetlist.end());
2148 ParagraphParameters & Paragraph::params()
2150 return pimpl_->params;
2154 ParagraphParameters const & Paragraph::params() const
2156 return pimpl_->params;
2160 Paragraph * Paragraph::getParFromID(int id) const
2162 return pimpl_->getParFromID(id);