1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * ====================================================== */
14 #pragma implementation "lyxparagraph.h"
21 #include "lyxparagraph.h"
22 #include "support/textutils.h"
25 #include "tex-strings.h"
27 #include "bufferparams.h"
28 #include "support/FileInfo.h"
29 #include "support/LAssert.h"
31 #include "LaTeXFeatures.h"
32 #include "insets/insetinclude.h"
33 #include "insets/insetbib.h"
34 #include "insets/insettext.h"
35 #include "support/filetools.h"
36 #include "lyx_gui_misc.h"
38 #include "support/lyxmanip.h"
39 #include "BufferView.h"
46 using std::lower_bound;
47 using std::upper_bound;
50 int tex_code_break_column = 72; // needs non-zero initialization. set later.
51 // this is a bad idea, but how can LyXParagraph find its buffer to get
52 // parameters? (JMarc)
53 extern BufferView * current_view;
54 extern string bibitemWidest(Buffer const *);
56 // this is a minibuffer
57 static char minibuffer_char;
58 static LyXFont minibuffer_font;
59 static Inset * minibuffer_inset;
62 // Initialization of the counter for the paragraph id's,
63 // declared in lyxparagraph.h
64 unsigned int LyXParagraph::paragraph_id = 0;
67 LyXParagraph::LyXParagraph()
69 text.reserve(500); // is this number too big?
71 for (int i = 0; i < 10; ++i) setCounter(i , 0);
78 footnoteflag = LyXParagraph::NO_FOOTNOTE;
79 footnotekind = LyXParagraph::FOOTNOTE; // should not be needed
81 align = LYX_ALIGN_BLOCK;
85 bibkey = 0; // ale970302
90 // This konstruktor inserts the new paragraph in a list.
91 LyXParagraph::LyXParagraph(LyXParagraph * par)
94 par->text.resize(par->text.size());
96 for (int i = 0; i < 10; ++i) setCounter(i, 0);
100 // double linked list begin
103 next->previous = this;
105 previous->next = this;
108 footnoteflag = LyXParagraph::NO_FOOTNOTE;
109 footnotekind = LyXParagraph::FOOTNOTE;
112 id_ = paragraph_id++;
114 bibkey = 0; // ale970302
120 void LyXParagraph::writeFile(Buffer const * buf, ostream & os,
121 BufferParams const & params,
122 char footflag, char dth) const
126 footnoteflag != LyXParagraph::NO_FOOTNOTE ||
128 || previous->footnoteflag == LyXParagraph::NO_FOOTNOTE
133 // The beginning or the end of a footnote environment?
134 if (footflag != footnoteflag) {
135 footflag = footnoteflag;
137 os << "\n\\begin_float "
138 << string_footnotekinds[footnotekind]
141 os << "\n\\end_float ";
145 // The beginning or end of a deeper (i.e. nested) area?
148 while (depth > dth) {
149 os << "\n\\begin_deeper ";
153 while (depth < dth) {
154 os << "\n\\end_deeper ";
160 // First write the layout
162 << textclasslist.NameOfLayout(params.textclass, layout)
165 // Maybe some vertical spaces.
166 if (added_space_top.kind() != VSpace::NONE)
167 os << "\\added_space_top "
168 << added_space_top.asLyXCommand() << " ";
169 if (added_space_bottom.kind() != VSpace::NONE)
170 os << "\\added_space_bottom "
171 << added_space_bottom.asLyXCommand() << " ";
173 // Maybe the paragraph has special spacing
174 spacing.writeFile(os, true);
176 // The labelwidth string used in lists.
177 if (!labelwidthstring.empty())
178 os << "\\labelwidthstring "
179 << labelwidthstring << '\n';
181 // Lines above or below?
185 os << "\\line_bottom ";
187 // Pagebreaks above or below?
189 os << "\\pagebreak_top ";
190 if (pagebreak_bottom)
191 os << "\\pagebreak_bottom ";
193 // Start of appendix?
194 if (start_of_appendix)
195 os << "\\start_of_appendix ";
202 if (align != LYX_ALIGN_LAYOUT) {
205 case LYX_ALIGN_LEFT: h = 1; break;
206 case LYX_ALIGN_RIGHT: h = 2; break;
207 case LYX_ALIGN_CENTER: h = 3; break;
208 default: h = 0; break;
210 os << "\\align " << string_align[h] << " ";
212 if (pextra_type != PEXTRA_NONE) {
213 os << "\\pextra_type " << pextra_type;
214 if (pextra_type == PEXTRA_MINIPAGE) {
215 os << " \\pextra_alignment "
218 os << " \\pextra_hfill "
220 if (pextra_start_minipage)
221 os << " \\pextra_start_minipage "
222 << pextra_start_minipage;
224 if (!pextra_width.empty()) {
225 os << " \\pextra_width "
226 << VSpace(pextra_width).asLyXCommand();
227 } else if (!pextra_widthp.empty()) {
228 os << " \\pextra_widthp "
235 // Dummy layout. This means that a footnote ended.
236 os << "\n\\end_float ";
237 footflag = LyXParagraph::NO_FOOTNOTE;
243 bibkey->Write(buf, os);
245 LyXFont font1(LyXFont::ALL_INHERIT, params.language);
248 for (size_type i = 0; i < size(); ++i) {
254 // Write font changes
255 LyXFont font2 = GetFontSettings(params, i);
256 if (font2 != font1) {
257 font2.lyxWriteChanges(font1, os);
262 value_type c = GetChar(i);
266 Inset const * inset = GetInset(i);
268 if (inset->DirectWrite()) {
269 // international char, let it write
270 // code directly so it's shorter in
272 inset->Write(buf, os);
274 os << "\n\\begin_inset ";
275 inset->Write(buf, os);
276 os << "\n\\end_inset \n\n";
282 os << "\n\\newline \n";
286 os << "\n\\hfill \n";
290 os << "\n\\backslash \n";
294 if (i + 1 < size() && GetChar(i + 1) == ' ') {
301 if ((column > 70 && c == ' ')
306 // this check is to amend a bug. LyX sometimes
307 // inserts '\0' this could cause problems.
311 lyxerr << "ERROR (LyXParagraph::writeFile):"
312 " NULL char in structure." << endl;
318 // now write the next paragraph
320 next->writeFile(buf, os, params, footflag, dth);
324 void LyXParagraph::validate(LaTeXFeatures & features) const
326 BufferParams const & params = features.bufferParams();
329 // this will be useful later
330 LyXLayout const & layout =
331 textclasslist.Style(params.textclass,
336 if (line_top || line_bottom)
337 features.lyxline = true;
338 if (!spacing.isDefault())
339 features.setspace = true;
342 features.layout[GetLayout()] = true;
345 Language const * doc_language = params.language;
347 for (FontList::const_iterator cit = fontlist.begin();
348 cit != fontlist.end(); ++cit) {
349 if ((*cit).font.noun() == LyXFont::ON) {
350 lyxerr[Debug::LATEX] << "font.noun: "
351 << (*cit).font.noun()
353 features.noun = true;
354 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
355 << (*cit).font.stateText(0)
358 switch ((*cit).font.color()) {
360 case LColor::inherit:
364 features.color = true;
365 lyxerr[Debug::LATEX] << "Color enabled. Font: "
366 << (*cit).font.stateText(0)
370 Language const * language = (*cit).font.language();
371 if (language->babel() != doc_language->babel()) {
372 features.UsedLanguages.insert(language);
373 lyxerr[Debug::LATEX] << "Found language "
374 << language->babel() << endl;
379 for (InsetList::const_iterator cit = insetlist.begin();
380 cit != insetlist.end(); ++cit) {
382 (*cit).inset->Validate(features);
385 if (pextra_type == PEXTRA_INDENT)
386 features.LyXParagraphIndent = true;
387 if (pextra_type == PEXTRA_FLOATFLT)
388 features.floatflt = true;
390 if (layout.needprotect
391 && next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE)
392 features.NeedLyXFootnoteCode = true;
394 if (params.paragraph_separation == BufferParams::PARSEP_INDENT
395 && pextra_type == LyXParagraph::PEXTRA_MINIPAGE)
396 features.NeedLyXMinipageIndent = true;
398 if (footnoteflag != NO_FOOTNOTE && footnotekind == ALGORITHM)
399 features.algorithm = true;
404 // First few functions needed for cut and paste and paragraph breaking.
405 void LyXParagraph::CopyIntoMinibuffer(BufferParams const & bparams,
406 LyXParagraph::size_type pos) const
408 minibuffer_char = GetChar(pos);
409 minibuffer_font = GetFontSettings(bparams, pos);
410 minibuffer_inset = 0;
411 if (minibuffer_char == LyXParagraph::META_INSET) {
413 minibuffer_inset = GetInset(pos)->Clone(*current_view->buffer());
415 minibuffer_inset = 0;
416 minibuffer_char = ' ';
417 // This reflects what GetInset() does (ARRae)
423 void LyXParagraph::CutIntoMinibuffer(BufferParams const & bparams,
424 LyXParagraph::size_type pos)
426 minibuffer_char = GetChar(pos);
427 minibuffer_font = GetFontSettings(bparams, pos);
428 minibuffer_inset = 0;
429 if (minibuffer_char == LyXParagraph::META_INSET) {
431 minibuffer_inset = GetInset(pos);
432 // This is a little hack since I want exactly
433 // the inset, not just a clone. Otherwise
434 // the inset would be deleted when calling Erase(pos)
436 InsetTable search_elem(pos, 0);
437 InsetList::iterator it =
438 lower_bound(insetlist.begin(),
440 search_elem, matchIT());
441 if (it != insetlist.end() && (*it).pos == pos)
444 minibuffer_inset = 0;
445 minibuffer_char = ' ';
446 // This reflects what GetInset() does (ARRae)
451 // Erase(pos); now the caller is responsible for that.
455 bool LyXParagraph::InsertFromMinibuffer(LyXParagraph::size_type pos)
457 if ((minibuffer_char == LyXParagraph::META_INSET) &&
458 !InsertInsetAllowed(minibuffer_inset))
460 if (minibuffer_char == LyXParagraph::META_INSET)
461 InsertInset(pos, minibuffer_inset, minibuffer_font);
463 InsertChar(pos, minibuffer_char, minibuffer_font);
471 void LyXParagraph::Clear()
476 pagebreak_top = false;
477 pagebreak_bottom = false;
479 added_space_top = VSpace(VSpace::NONE);
480 added_space_bottom = VSpace(VSpace::NONE);
481 spacing.set(Spacing::Default);
483 align = LYX_ALIGN_LAYOUT;
487 pextra_type = PEXTRA_NONE;
488 pextra_width.erase();
489 pextra_widthp.erase();
490 pextra_alignment = MINIPAGE_ALIGN_TOP;
491 pextra_hfill = false;
492 pextra_start_minipage = false;
495 labelwidthstring.erase();
499 start_of_appendix = false;
503 // the destructor removes the new paragraph from the list
504 LyXParagraph::~LyXParagraph()
507 previous->next = next;
509 next->previous = previous;
511 for (InsetList::iterator it = insetlist.begin();
512 it != insetlist.end(); ++it) {
519 //lyxerr << "LyXParagraph::paragraph_id = "
520 // << LyXParagraph::paragraph_id << endl;
524 void LyXParagraph::Erase(LyXParagraph::size_type pos)
527 // > because last is the next unused position, and you can
528 // use it if you want
530 if (next && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
531 NextAfterFootnote()->Erase(pos - text.size() - 1);
533 lyxerr.debug() << "ERROR (LyXParagraph::Erase): "
534 "position does not exist." << endl;
538 Assert(pos < size());
541 if (pos < size()) { // last is free for insertation, but should be empty
543 // if it is an inset, delete the inset entry
544 if (text[pos] == LyXParagraph::META_INSET) {
546 InsetTable search_inset(pos, 0);
547 InsetList::iterator it =
548 lower_bound(insetlist.begin(),
550 search_inset, matchIT());
551 if (it != insetlist.end() && (*it).pos == pos) {
556 text.erase(text.begin() + pos);
558 // Erase entries in the tables.
559 FontTable search_font(pos, LyXFont());
561 FontList::iterator it =
562 lower_bound(fontlist.begin(),
564 search_font, matchFT());
565 if (it != fontlist.end() && (*it).pos == pos &&
567 (it != fontlist.begin() && (*(it-1)).pos == pos - 1))) {
568 // If it is a multi-character font
569 // entry, we just make it smaller
570 // (see update below), otherwise we
572 unsigned int i = it - fontlist.begin();
573 fontlist.erase(fontlist.begin() + i);
574 it = fontlist.begin() + i;
575 if (i > 0 && i < fontlist.size() &&
576 fontlist[i-1].font == fontlist[i].font) {
577 fontlist.erase(fontlist.begin() + i-1);
578 it = fontlist.begin() + i-1;
582 // Update all other entries.
583 FontList::iterator fend = fontlist.end();
584 for (; it != fend; ++it)
587 // Update the inset table.
588 InsetTable search_inset(pos, 0);
589 InsetList::iterator lend = insetlist.end();
590 for (InsetList::iterator it =
591 upper_bound(insetlist.begin(),
593 search_inset, matchIT());
598 lyxerr << "ERROR (LyXParagraph::Erase): "
599 "can't erase non-existant char." << endl;
605 void LyXParagraph::InsertChar(LyXParagraph::size_type pos,
606 LyXParagraph::value_type c)
608 LyXFont f(LyXFont::ALL_INHERIT);
609 InsertChar(pos, c, f);
613 void LyXParagraph::InsertChar(LyXParagraph::size_type pos,
614 LyXParagraph::value_type c,
615 LyXFont const & font)
618 // > because last is the next unused position, and you can
619 // use it if you want
622 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
623 NextAfterFootnote()->InsertChar(pos - text.size() - 1,
626 lyxerr.debug() << "ERROR (LyXParagraph::InsertChar): "
627 "position does not exist." << endl;
631 Assert(pos <= size());
633 text.insert(text.begin() + pos, c);
634 // Update the font table.
635 FontTable search_font(pos, LyXFont());
636 for (FontList::iterator it = lower_bound(fontlist.begin(),
638 search_font, matchFT());
639 it != fontlist.end(); ++it)
642 // Update the inset table.
643 InsetTable search_inset(pos, 0);
644 for (InsetList::iterator it = lower_bound(insetlist.begin(),
646 search_inset, matchIT());
647 it != insetlist.end(); ++it)
654 void LyXParagraph::InsertInset(LyXParagraph::size_type pos,
657 LyXFont f(LyXFont::ALL_INHERIT);
658 InsertInset(pos, inset, f);
662 void LyXParagraph::InsertInset(LyXParagraph::size_type pos,
663 Inset * inset, LyXFont const & font)
668 // > because last is the next unused position, and you can
669 // use it if you want
672 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
674 ->InsertInset(pos - text.size() - 1,
677 lyxerr << "ERROR (LyXParagraph::InsertInset): "
678 "position does not exist: " << pos << endl;
682 Assert(pos <= size());
685 InsertChar(pos, META_INSET, font);
686 Assert(text[pos] == META_INSET);
688 // Add a new entry in the inset table.
689 InsetTable search_inset(pos, 0);
690 InsetList::iterator it = lower_bound(insetlist.begin(),
692 search_inset, matchIT());
693 if (it != insetlist.end() && (*it).pos == pos)
694 lyxerr << "ERROR (LyXParagraph::InsertInset): "
695 "there is an inset in position: " << pos << endl;
697 insetlist.insert(it, InsetTable(pos, inset));
699 inset->setOwner(inset_owner);
703 bool LyXParagraph::InsertInsetAllowed(Inset * inset)
705 //lyxerr << "LyXParagraph::InsertInsetAllowed" << endl;
708 return inset_owner->InsertInsetAllowed(inset);
713 Inset * LyXParagraph::GetInset(LyXParagraph::size_type pos)
718 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
719 return NextAfterFootnote()
720 ->GetInset(pos - text.size() - 1);
722 lyxerr << "ERROR (LyXParagraph::GetInset): "
723 "position does not exist: "
729 Assert(pos < size());
732 InsetTable search_inset(pos, 0);
733 InsetList::iterator it = lower_bound(insetlist.begin(),
735 search_inset, matchIT());
736 if (it != insetlist.end() && (*it).pos == pos)
739 lyxerr << "ERROR (LyXParagraph::GetInset): "
740 "Inset does not exist: " << pos << endl;
743 // text[pos] = ' '; // WHY!!! does this set the pos to ' '????
744 // Did this commenting out introduce a bug? So far I have not
745 // see any, please enlighten me. (Lgb)
746 // My guess is that since the inset does not exist, we might
747 // as well replace it with a space to prevent craches. (Asger)
752 Inset const * LyXParagraph::GetInset(LyXParagraph::size_type pos) const
757 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
758 return NextAfterFootnote()
759 ->GetInset(pos - text.size() - 1);
761 lyxerr << "ERROR (LyXParagraph::GetInset): "
762 "position does not exist: "
768 Assert(pos < size());
771 InsetTable search_inset(pos, 0);
772 InsetList::const_iterator cit = lower_bound(insetlist.begin(),
774 search_inset, matchIT());
775 if (cit != insetlist.end() && (*cit).pos == pos)
778 lyxerr << "ERROR (LyXParagraph::GetInset): "
779 "Inset does not exist: " << pos << endl;
781 //text[pos] = ' '; // WHY!!! does this set the pos to ' '????
782 // Did this commenting out introduce a bug? So far I have not
783 // see any, please enlighten me. (Lgb)
784 // My guess is that since the inset does not exist, we might
785 // as well replace it with a space to prevent craches. (Asger)
790 // Gets uninstantiated font setting at position.
791 // Optimized after profiling. (Asger)
792 LyXFont const LyXParagraph::GetFontSettings(BufferParams const & bparams,
793 LyXParagraph::size_type pos) const
796 Assert(pos <= size());
801 FontTable search_font(pos, LyXFont());
802 FontList::const_iterator cit = lower_bound(fontlist.begin(),
804 search_font, matchFT());
805 if (cit != fontlist.end())
811 // > because last is the next unused position, and you can
812 // use it if you want
813 else if (pos > size()) {
815 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
816 return NextAfterFootnote()
817 ->GetFontSettings(bparams,
818 pos - text.size() - 1);
820 // Why is it an error to ask for the font of a
821 // position that does not exist? Would it be
822 // enough for this to be enabled on debug?
823 // We want strict error checking, but it's ok to only
824 // have it when debugging. (Asger)
825 lyxerr << "ERROR (LyXParagraph::GetFontSettings): "
826 "position does not exist. "
827 << pos << " (" << static_cast<int>(pos)
831 return GetFontSettings(bparams, pos - 1);
834 if (pos == size() && size())
835 return GetFontSettings(bparams, pos - 1);
839 return LyXFont(LyXFont::ALL_INHERIT, getParLanguage(bparams));
841 //return LyXFont(LyXFont::ALL_INHERIT);
844 // Gets uninstantiated font setting at position 0
845 LyXFont const LyXParagraph::GetFirstFontSettings() const
848 if (!fontlist.empty())
849 return fontlist[0].font;
853 else if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE)
854 return NextAfterFootnote()->GetFirstFontSettings();
856 return LyXFont(LyXFont::ALL_INHERIT);
860 // Gets the fully instantiated font at a given position in a paragraph
861 // This is basically the same function as LyXText::GetFont() in text2.C.
862 // The difference is that this one is used for generating the LaTeX file,
863 // and thus cosmetic "improvements" are disallowed: This has to deliver
864 // the true picture of the buffer. (Asger)
865 // If position is -1, we get the layout font of the paragraph.
866 // If position is -2, we get the font of the manual label of the paragraph.
867 LyXFont const LyXParagraph::getFont(BufferParams const & bparams,
868 LyXParagraph::size_type pos) const
871 LyXLayout const & layout =
872 textclasslist.Style(bparams.textclass,
874 LyXParagraph::size_type main_body = 0;
875 if (layout.labeltype == LABEL_MANUAL)
876 main_body = BeginningOfMainBody();
881 layoutfont = layout.labelfont;
883 layoutfont = layout.font;
884 tmpfont = GetFontSettings(bparams, pos);
885 tmpfont.realize(layoutfont);
887 // process layoutfont for pos == -1 and labelfont for pos < -1
889 tmpfont = layout.font;
891 tmpfont = layout.labelfont;
892 tmpfont.setLanguage(getParLanguage(bparams));
895 // check for environment font information
896 char par_depth = GetDepth();
897 LyXParagraph const * par = this;
898 while (par && par_depth && !tmpfont.resolved()) {
899 par = par->DepthHook(par_depth - 1);
901 tmpfont.realize(textclasslist.
902 Style(bparams.textclass,
903 par->GetLayout()).font);
904 par_depth = par->GetDepth();
908 tmpfont.realize(textclasslist
909 .TextClass(bparams.textclass)
915 /// Returns the height of the highest font in range
917 LyXParagraph::HighestFontInRange(LyXParagraph::size_type startpos,
918 LyXParagraph::size_type endpos) const
920 LyXFont::FONT_SIZE maxsize = LyXFont::SIZE_TINY;
921 if (fontlist.empty())
924 FontTable end_search(endpos, LyXFont());
925 FontList::const_iterator end_it = lower_bound(fontlist.begin(),
927 end_search, matchFT());
928 if (end_it != fontlist.end())
931 FontTable start_search(startpos, LyXFont());
932 for (FontList::const_iterator cit =
933 lower_bound(fontlist.begin(),
935 start_search, matchFT());
936 cit != end_it; ++cit) {
937 LyXFont::FONT_SIZE size = (*cit).font.size();
938 if (size > maxsize && size <= LyXFont::SIZE_HUGER)
945 LyXParagraph::value_type
946 LyXParagraph::GetChar(LyXParagraph::size_type pos) const
951 Assert(pos <= size());
952 if (!size() || pos == size()) return '\0';
963 // > because last is the next unused position, and you can
964 // use it if you want
965 else if (pos > size()) {
966 if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE)
967 return NextAfterFootnote()
968 ->GetChar(pos - text.size() - 1);
971 lyxerr << "ERROR (LyXParagraph::GetChar const): "
972 "position does not exist."
973 << pos << " (" << static_cast<int>(pos)
979 // We should have a footnote environment.
980 if (!next || next->footnoteflag == LyXParagraph::NO_FOOTNOTE) {
981 // Notice that LyX does request the
982 // last char from time to time. (Asger)
983 //lyxerr << "ERROR (LyXParagraph::GetChar): "
984 // "expected footnote." << endl;
987 switch (next->footnotekind) {
988 case LyXParagraph::FOOTNOTE:
989 return LyXParagraph::META_FOOTNOTE;
990 case LyXParagraph::MARGIN:
991 return LyXParagraph::META_MARGIN;
992 case LyXParagraph::FIG:
993 case LyXParagraph::WIDE_FIG:
994 return LyXParagraph::META_FIG;
995 case LyXParagraph::TAB:
996 case LyXParagraph::WIDE_TAB:
997 return LyXParagraph::META_TAB;
998 case LyXParagraph::ALGORITHM:
999 return LyXParagraph::META_ALGORITHM;
1001 return '\0'; // to shut up gcc
1007 // return an string of the current word, and the end of the word in lastpos.
1008 string const LyXParagraph::GetWord(LyXParagraph::size_type & lastpos) const
1010 Assert(lastpos >= 0);
1012 // the current word is defined as starting at the first character
1013 // from the immediate left of lastpospos which meets the definition
1014 // of IsLetter(), continuing to the last character to the right
1015 // of this meeting IsLetter.
1021 // move back until we have a letter
1023 //there's no real reason to have firstpos & lastpos as
1024 //separate variables as this is written, but maybe someon
1025 // will want to return firstpos in the future.
1027 //since someone might have typed a punctuation first
1028 int firstpos = lastpos;
1030 while ((firstpos >= 0) && !IsLetter(firstpos))
1033 // now find the beginning by looking for a nonletter
1035 while ((firstpos>= 0) && IsLetter(firstpos))
1038 // the above is now pointing to the preceeding non-letter
1042 // so copy characters into theword until we get a nonletter
1043 // note that this can easily exceed lastpos, wich means
1044 // that if used in the middle of a word, the whole word
1047 while (IsLetter(lastpos)) theword += GetChar(lastpos++);
1055 #warning Remember to get rid of this one. (Lgb)
1057 LyXParagraph::size_type LyXParagraph::Last() const
1060 if (next && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1061 return text.size() + NextAfterFootnote()->Last() + 1;
1062 // the 1 is the symbol
1071 LyXParagraph * LyXParagraph::ParFromPos(LyXParagraph::size_type pos)
1073 // > because last is the next unused position, and you can
1074 // use it if you want
1077 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1078 return NextAfterFootnote()
1079 ->ParFromPos(pos - text.size() - 1);
1081 lyxerr << "ERROR (LyXParagraph::ParFromPos): "
1082 "position does not exist." << endl;
1091 int LyXParagraph::PositionInParFromPos(LyXParagraph::size_type pos) const
1093 // > because last is the next unused position, and you can
1094 // use it if you want
1097 && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1098 return NextAfterFootnote()
1099 ->PositionInParFromPos(pos - text.size() - 1);
1102 "ERROR (LyXParagraph::PositionInParFromPos): "
1103 "position does not exist." << endl;
1112 void LyXParagraph::SetFont(LyXParagraph::size_type pos,
1113 LyXFont const & font)
1116 // > because last is the next unused position, and you can
1117 // use it if you want
1120 next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
1121 NextAfterFootnote()->SetFont(pos - text.size() - 1,
1124 lyxerr << "ERROR (LyXParagraph::SetFont): "
1125 "position does not exist." << endl;
1130 Assert(pos <= size());
1133 // First, reduce font against layout/label font
1134 // Update: The SetCharFont() routine in text2.C already
1135 // reduces font, so we don't need to do that here. (Asger)
1136 // No need to simplify this because it will disappear
1137 // in a new kernel. (Asger)
1138 // Next search font table
1140 FontTable search_font(pos, LyXFont());
1141 FontList::iterator it = lower_bound(fontlist.begin(),
1143 search_font, matchFT());
1144 unsigned int i = it - fontlist.begin();
1145 bool notfound = it == fontlist.end();
1147 if (!notfound && fontlist[i].font == font)
1150 bool begin = pos == 0 || notfound ||
1151 (i > 0 && fontlist[i-1].pos == pos - 1);
1152 // Is position pos is a beginning of a font block?
1153 bool end = !notfound && fontlist[i].pos == pos;
1154 // Is position pos is the end of a font block?
1155 if (begin && end) { // A single char block
1156 if (i+1 < fontlist.size() &&
1157 fontlist[i+1].font == font) {
1158 // Merge the singleton block with the next block
1159 fontlist.erase(fontlist.begin() + i);
1160 if (i > 0 && fontlist[i-1].font == font)
1161 fontlist.erase(fontlist.begin() + i-1);
1162 } else if (i > 0 && fontlist[i-1].font == font) {
1163 // Merge the singleton block with the previous block
1164 fontlist[i-1].pos = pos;
1165 fontlist.erase(fontlist.begin() + i);
1167 fontlist[i].font = font;
1169 if (i > 0 && fontlist[i-1].font == font)
1170 fontlist[i-1].pos = pos;
1172 fontlist.insert(fontlist.begin() + i,
1173 FontTable(pos, font));
1175 fontlist[i].pos = pos - 1;
1176 if (!(i+1 < fontlist.size() &&
1177 fontlist[i+1].font == font))
1178 fontlist.insert(fontlist.begin() + i+1,
1179 FontTable(pos, font));
1180 } else { // The general case. The block is splitted into 3 blocks
1181 fontlist.insert(fontlist.begin() + i,
1182 FontTable(pos - 1, fontlist[i].font));
1183 fontlist.insert(fontlist.begin() + i+1, FontTable(pos, font));
1188 // This function is able to hide closed footnotes.
1189 LyXParagraph * LyXParagraph::Next()
1192 if (next && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
1193 LyXParagraph * tmp = next;
1195 && tmp->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1197 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1198 return tmp->Next(); /* there can be more than one
1199 footnote in a logical
1202 return next; // This should never happen!
1210 LyXParagraph * LyXParagraph::NextAfterFootnote()
1212 if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
1213 LyXParagraph * tmp = next;
1214 while (tmp && tmp->footnoteflag != LyXParagraph::NO_FOOTNOTE)
1216 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1217 return tmp; /* there can be more than one footnote
1218 in a logical paragraph */
1220 return next; // This should never happen!
1228 LyXParagraph const * LyXParagraph::NextAfterFootnote() const
1230 if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
1231 LyXParagraph * tmp = next;
1232 while (tmp && tmp->footnoteflag != LyXParagraph::NO_FOOTNOTE)
1234 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1235 return tmp; /* there can be more than one footnote
1236 in a logical paragraph */
1238 return next; // This should never happen!
1246 LyXParagraph * LyXParagraph::PreviousBeforeFootnote()
1249 if (previous && previous->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
1251 while (tmp && tmp->footnoteflag != LyXParagraph::NO_FOOTNOTE)
1252 tmp = tmp->previous;
1253 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1254 return tmp; /* there can be more than one footnote
1255 in a logical paragraph */
1257 return previous; // This should never happen!
1265 LyXParagraph * LyXParagraph::LastPhysicalPar()
1267 if (footnoteflag != LyXParagraph::NO_FOOTNOTE)
1270 LyXParagraph * tmp = this;
1272 && tmp->next->footnoteflag != LyXParagraph::NO_FOOTNOTE)
1273 tmp = tmp->NextAfterFootnote();
1281 LyXParagraph const * LyXParagraph::LastPhysicalPar() const
1283 if (footnoteflag != LyXParagraph::NO_FOOTNOTE)
1286 LyXParagraph const * tmp = this;
1288 && tmp->next->footnoteflag != LyXParagraph::NO_FOOTNOTE)
1289 tmp = tmp->NextAfterFootnote();
1297 LyXParagraph * LyXParagraph::FirstPhysicalPar()
1301 LyXParagraph * tmppar = this;
1305 || tmppar->footnoteflag != LyXParagraph::NO_FOOTNOTE))
1306 tmppar = tmppar->previous;
1317 LyXParagraph const * LyXParagraph::FirstPhysicalPar() const
1321 LyXParagraph const * tmppar = this;
1325 || tmppar->footnoteflag != LyXParagraph::NO_FOOTNOTE))
1326 tmppar = tmppar->previous;
1336 // This function is able to hide closed footnotes.
1337 LyXParagraph * LyXParagraph::Previous()
1340 LyXParagraph * tmp = previous;
1345 && tmp->previous->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
1346 tmp = tmp->previous;
1348 && tmp->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1349 tmp = tmp->previous;
1350 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1351 return tmp->next->Previous();
1361 // This function is able to hide closed footnotes.
1362 LyXParagraph const * LyXParagraph::Previous() const
1365 LyXParagraph * tmp = previous;
1369 && tmp->previous->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
1370 tmp = tmp->previous;
1372 && tmp->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE)
1373 tmp = tmp->previous;
1374 if (tmp && tmp->footnoteflag != LyXParagraph::CLOSED_FOOTNOTE)
1375 return tmp->next->Previous();
1385 void LyXParagraph::BreakParagraph(BufferParams const & bparams,
1386 LyXParagraph::size_type pos,
1391 // create a new paragraph
1394 size_type pos_first;
1395 LyXParagraph * par = ParFromPos(pos);
1396 LyXParagraph * firstpar = FirstPhysicalPar();
1398 LyXParagraph * tmp = new LyXParagraph(par);
1400 //LyXParagraph * par = this;
1401 //LyXParagraph * firstpar = this;
1402 LyXParagraph * tmp = new LyXParagraph(this);
1406 tmp->footnoteflag = footnoteflag;
1407 tmp->footnotekind = footnotekind;
1409 // this is an idea for a more userfriendly layout handling, I will
1410 // see what the users say
1413 // layout stays the same with latex-environments
1415 tmp->SetOnlyLayout(bparams, firstpar->layout);
1416 tmp->SetLabelWidthString(firstpar->labelwidthstring);
1419 // layout stays the same with latex-environments
1421 tmp->SetOnlyLayout(bparams, layout);
1422 tmp->SetLabelWidthString(labelwidthstring);
1426 if (Last() > pos || !Last() || flag == 2) {
1427 tmp->SetOnlyLayout(bparams, firstpar->layout);
1428 tmp->align = firstpar->align;
1429 tmp->SetLabelWidthString(firstpar->labelwidthstring);
1431 tmp->line_bottom = firstpar->line_bottom;
1432 firstpar->line_bottom = false;
1433 tmp->pagebreak_bottom = firstpar->pagebreak_bottom;
1434 firstpar->pagebreak_bottom = false;
1435 tmp->added_space_bottom = firstpar->added_space_bottom;
1436 firstpar->added_space_bottom = VSpace(VSpace::NONE);
1438 tmp->depth = firstpar->depth;
1439 tmp->noindent = firstpar->noindent;
1441 if (Last() > pos || !Last() || flag == 2) {
1442 tmp->SetOnlyLayout(bparams, layout);
1444 tmp->SetLabelWidthString(labelwidthstring);
1446 tmp->line_bottom = line_bottom;
1447 line_bottom = false;
1448 tmp->pagebreak_bottom = pagebreak_bottom;
1449 pagebreak_bottom = false;
1450 tmp->added_space_bottom = added_space_bottom;
1451 added_space_bottom = VSpace(VSpace::NONE);
1454 tmp->noindent = noindent;
1456 // copy everything behind the break-position
1457 // to the new paragraph
1460 while (ParFromPos(pos_first) != par)
1462 pos_end = pos_first + par->text.size() - 1;
1465 for (i = j = pos; i <= pos_end; ++i) {
1466 par->CutIntoMinibuffer(bparams, i - pos_first);
1467 if (tmp->InsertFromMinibuffer(j - pos))
1470 tmp->text.resize(tmp->text.size());
1471 for (i = pos_end; i >= pos; --i)
1472 par->Erase(i - pos_first);
1474 par->text.resize(par->text.size());
1476 size_type pos_end = text.size() - 1;
1478 for (i = j = pos; i <= pos_end; ++i) {
1479 CutIntoMinibuffer(bparams, i);
1480 if (tmp->InsertFromMinibuffer(j - pos))
1484 for (i = pos_end; i >= pos; --i)
1492 // just an idea of me
1494 tmp->line_top = firstpar->line_top;
1495 tmp->pagebreak_top = firstpar->pagebreak_top;
1496 tmp->added_space_top = firstpar->added_space_top;
1497 tmp->bibkey = firstpar->bibkey;
1499 // layout stays the same with latex-environments
1501 firstpar->SetOnlyLayout(bparams, tmp->layout);
1502 firstpar->SetLabelWidthString(tmp->labelwidthstring);
1503 firstpar->depth = tmp->depth;
1507 // just an idea of me
1509 tmp->line_top = line_top;
1510 tmp->pagebreak_top = pagebreak_top;
1511 tmp->added_space_top = added_space_top;
1512 tmp->bibkey = bibkey;
1514 // layout stays the same with latex-environments
1516 SetOnlyLayout(bparams, tmp->layout);
1517 SetLabelWidthString(tmp->labelwidthstring);
1525 void LyXParagraph::MakeSameLayout(LyXParagraph const * par)
1528 par = par->FirstPhysicalPar();
1529 footnoteflag = par->footnoteflag;
1530 footnotekind = par->footnotekind;
1532 layout = par->layout;
1533 align = par-> align;
1534 SetLabelWidthString(par->labelwidthstring);
1536 line_bottom = par->line_bottom;
1537 pagebreak_bottom = par->pagebreak_bottom;
1538 added_space_bottom = par->added_space_bottom;
1540 line_top = par->line_top;
1541 pagebreak_top = par->pagebreak_top;
1542 added_space_top = par->added_space_top;
1544 spacing = par->spacing;
1546 pextra_type = par->pextra_type;
1547 pextra_width = par->pextra_width;
1548 pextra_widthp = par->pextra_widthp;
1549 pextra_alignment = par->pextra_alignment;
1550 pextra_hfill = par->pextra_hfill;
1551 pextra_start_minipage = par->pextra_start_minipage;
1553 noindent = par->noindent;
1559 LyXParagraph * LyXParagraph::FirstSelfrowPar()
1561 LyXParagraph * tmppar = this;
1564 && tmppar->previous->footnoteflag ==
1565 LyXParagraph::CLOSED_FOOTNOTE)
1566 || tmppar->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE))
1567 tmppar = tmppar->previous;
1570 return this; // This should never happen!
1577 int LyXParagraph::StripLeadingSpaces(LyXTextClassList::size_type tclass)
1579 if (textclasslist.Style(tclass, GetLayout()).free_spacing)
1587 && (IsNewline(0) || IsLineSeparator(0))){
1598 LyXParagraph * LyXParagraph::Clone() const
1600 // create a new paragraph
1601 LyXParagraph * result = new LyXParagraph;
1603 result->MakeSameLayout(this);
1605 // this is because of the dummy layout of the paragraphs that
1607 result->layout = layout;
1609 result->inset_owner = inset_owner;
1613 result->bibkey = static_cast<InsetBibKey *>
1614 (bibkey->Clone(*current_view->buffer()));
1618 // copy everything behind the break-position to the new paragraph
1620 result->text = text;
1621 result->fontlist = fontlist;
1622 result->insetlist = insetlist;
1623 for (InsetList::iterator it = result->insetlist.begin();
1624 it != result->insetlist.end(); ++it)
1625 (*it).inset = (*it).inset->Clone(*current_view->buffer());
1630 bool LyXParagraph::HasSameLayout(LyXParagraph const * par) const
1633 par = par->FirstPhysicalPar();
1638 par->footnoteflag == footnoteflag &&
1639 par->footnotekind == footnotekind &&
1641 par->layout == layout &&
1643 par->align == align &&
1645 par->line_bottom == line_bottom &&
1646 par->pagebreak_bottom == pagebreak_bottom &&
1647 par->added_space_bottom == added_space_bottom &&
1649 par->line_top == line_top &&
1650 par->pagebreak_top == pagebreak_top &&
1651 par->added_space_top == added_space_top &&
1653 par->spacing == spacing &&
1655 par->pextra_type == pextra_type &&
1656 par->pextra_width == pextra_width &&
1657 par->pextra_widthp == pextra_widthp &&
1658 par->pextra_alignment == pextra_alignment &&
1659 par->pextra_hfill == pextra_hfill &&
1660 par->pextra_start_minipage == pextra_start_minipage &&
1661 par->noindent == noindent &&
1662 par->depth == depth);
1666 void LyXParagraph::BreakParagraphConservative(BufferParams const & bparams,
1667 LyXParagraph::size_type pos)
1670 // create a new paragraph
1671 LyXParagraph * par = ParFromPos(pos);
1673 LyXParagraph * tmp = new LyXParagraph(par);
1675 tmp->MakeSameLayout(par);
1677 // When can pos < Last()?
1678 // I guess pos == Last() is possible.
1680 // copy everything behind the break-position to the new
1682 size_type pos_first = 0;
1683 while (ParFromPos(pos_first) != par)
1685 size_type pos_end = pos_first + par->text.size() - 1;
1688 for (i = j = pos; i <= pos_end; ++i) {
1689 par->CutIntoMinibuffer(bparams, i - pos_first);
1690 if (tmp->InsertFromMinibuffer(j - pos))
1693 tmp->text.resize(tmp->text.size());
1694 for (size_type i = pos_end; i >= pos; --i)
1695 par->Erase(i - pos_first);
1697 par->text.resize(par->text.size());
1700 // create a new paragraph
1701 LyXParagraph * tmp = new LyXParagraph(this);
1702 tmp->MakeSameLayout(this);
1704 // When can pos > Last()?
1705 // I guess pos == Last() is possible.
1707 // copy everything behind the break-position to the new
1709 size_type pos_end = text.size() - 1;
1712 for (i = j = pos; i <= pos_end; ++i) {
1713 CutIntoMinibuffer(bparams, i);
1714 if (tmp->InsertFromMinibuffer(j - pos))
1720 for (size_type i = pos_end; i >= pos; --i)
1729 // Be carefull, this does not make any check at all.
1730 // This method has wrong name, it combined this par with the next par.
1731 // In that sense it is the reverse of break paragraph. (Lgb)
1732 void LyXParagraph::PasteParagraph(BufferParams const & bparams)
1734 // copy the next paragraph to this one
1735 LyXParagraph * the_next = Next();
1737 LyXParagraph * firstpar = FirstPhysicalPar();
1740 // first the DTP-stuff
1742 firstpar->line_bottom = the_next->line_bottom;
1743 firstpar->added_space_bottom = the_next->added_space_bottom;
1744 firstpar->pagebreak_bottom = the_next->pagebreak_bottom;
1746 line_bottom = the_next->line_bottom;
1747 added_space_bottom = the_next->added_space_bottom;
1748 pagebreak_bottom = the_next->pagebreak_bottom;
1751 size_type pos_end = the_next->text.size() - 1;
1752 size_type pos_insert = Last();
1754 // ok, now copy the paragraph
1756 for (i = j = 0; i <= pos_end; ++i) {
1757 the_next->CutIntoMinibuffer(bparams, i);
1758 if (InsertFromMinibuffer(pos_insert + j))
1762 // delete the next paragraph
1763 LyXParagraph * ppar = the_next->previous;
1764 LyXParagraph * npar = the_next->next;
1771 void LyXParagraph::OpenFootnote(LyXParagraph::size_type pos)
1773 LyXParagraph * par = ParFromPos(pos);
1775 while (par && par->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
1776 par->footnoteflag = LyXParagraph::OPEN_FOOTNOTE;
1782 void LyXParagraph::CloseFootnote(LyXParagraph::size_type pos)
1784 LyXParagraph * par = ParFromPos(pos);
1786 while (par && par->footnoteflag == LyXParagraph::OPEN_FOOTNOTE) {
1787 par->footnoteflag = LyXParagraph::CLOSED_FOOTNOTE;
1794 int LyXParagraph::GetEndLabel(BufferParams const & bparams) const
1796 LyXParagraph const * par = this;
1797 int par_depth = GetDepth();
1799 LyXTextClass::LayoutList::size_type layout = par->GetLayout();
1800 int const endlabeltype =
1801 textclasslist.Style(bparams.textclass,
1802 layout).endlabeltype;
1803 if (endlabeltype != END_LABEL_NO_LABEL) {
1804 LyXParagraph const * last = this;
1806 if( footnoteflag == NO_FOOTNOTE)
1807 last = LastPhysicalPar();
1808 else if (next->footnoteflag == NO_FOOTNOTE)
1809 return endlabeltype;
1814 if (!last || !last->next)
1815 return endlabeltype;
1817 int next_depth = last->next->GetDepth();
1818 if (par_depth > next_depth ||
1819 (par_depth == next_depth && layout != last->next->GetLayout() ))
1820 return endlabeltype;
1825 par = par->DepthHook(par_depth - 1);
1827 par_depth = par->GetDepth();
1829 return END_LABEL_NO_LABEL;
1833 LyXTextClass::size_type LyXParagraph::GetLayout() const
1836 return FirstPhysicalPar()->layout;
1843 char LyXParagraph::GetDepth() const
1846 return FirstPhysicalPar()->depth;
1853 char LyXParagraph::GetAlign() const
1856 return FirstPhysicalPar()->align;
1863 string const & LyXParagraph::GetLabelstring() const
1866 return FirstPhysicalPar()->labelstring;
1873 int LyXParagraph::GetFirstCounter(int i) const
1876 return FirstPhysicalPar()->counter_[i];
1883 // the next two functions are for the manual labels
1884 string const LyXParagraph::GetLabelWidthString() const
1887 if (!FirstPhysicalPar()->labelwidthstring.empty())
1888 return FirstPhysicalPar()->labelwidthstring;
1890 if (!labelwidthstring.empty())
1891 return labelwidthstring;
1894 return _("Senseless with this layout!");
1898 void LyXParagraph::SetLabelWidthString(string const & s)
1901 LyXParagraph * par = FirstPhysicalPar();
1903 par->labelwidthstring = s;
1905 labelwidthstring = s;
1910 void LyXParagraph::SetOnlyLayout(BufferParams const & bparams,
1911 LyXTextClass::size_type new_layout)
1914 LyXParagraph * par = FirstPhysicalPar();
1916 LyXParagraph * par = this;
1918 LyXParagraph * ppar = 0;
1919 LyXParagraph * npar = 0;
1921 par->layout = new_layout;
1923 if (par->pextra_type == PEXTRA_NONE) {
1924 if (par->Previous()) {
1926 ppar = par->Previous()->FirstPhysicalPar();
1928 ppar = par->Previous();
1932 && (ppar->depth > par->depth))
1934 ppar = ppar->Previous()->FirstPhysicalPar();
1936 ppar = ppar->Previous();
1941 npar = par->Next()->NextAfterFootnote();
1947 && (npar->depth > par->depth))
1949 npar = npar->Next()->NextAfterFootnote();
1951 npar = npar->Next();
1954 if (ppar && (ppar->pextra_type != PEXTRA_NONE)) {
1956 p1 = ppar->pextra_width,
1957 p2 = ppar->pextra_widthp;
1958 ppar->SetPExtraType(bparams, ppar->pextra_type,
1961 if ((par->pextra_type == PEXTRA_NONE) &&
1962 npar && (npar->pextra_type != PEXTRA_NONE)) {
1964 p1 = npar->pextra_width,
1965 p2 = npar->pextra_widthp;
1966 npar->SetPExtraType(bparams, npar->pextra_type,
1973 void LyXParagraph::SetLayout(BufferParams const & bparams,
1974 LyXTextClass::size_type new_layout)
1978 * par = FirstPhysicalPar(),
1985 par->layout = new_layout;
1986 par->labelwidthstring.erase();
1987 par->align = LYX_ALIGN_LAYOUT;
1988 par->added_space_top = VSpace(VSpace::NONE);
1989 par->added_space_bottom = VSpace(VSpace::NONE);
1990 par->spacing.set(Spacing::Default);
1992 if (par->pextra_type == PEXTRA_NONE) {
1993 if (par->Previous()) {
1995 ppar = par->Previous()->FirstPhysicalPar();
1997 ppar = par->Previous();
2001 && (ppar->depth > par->depth))
2003 ppar = ppar->Previous()->FirstPhysicalPar();
2005 ppar = ppar->Previous();
2010 npar = par->Next()->NextAfterFootnote();
2016 && (npar->depth > par->depth))
2018 npar = npar->Next()->NextAfterFootnote();
2020 npar = npar->Next();
2023 if (ppar && (ppar->pextra_type != PEXTRA_NONE)) {
2025 p1 = ppar->pextra_width,
2026 p2 = ppar->pextra_widthp;
2027 ppar->SetPExtraType(bparams, ppar->pextra_type,
2030 if ((par->pextra_type == PEXTRA_NONE) &&
2031 npar && (npar->pextra_type != PEXTRA_NONE)) {
2033 p1 = npar->pextra_width,
2034 p2 = npar->pextra_widthp;
2035 npar->SetPExtraType(bparams, npar->pextra_type,
2042 // if the layout of a paragraph contains a manual label, the beginning of the
2043 // main body is the beginning of the second word. This is what the par-
2044 // function returns. If the layout does not contain a label, the main
2045 // body always starts with position 0. This differentiation is necessary,
2046 // because there cannot be a newline or a blank <= the beginning of the
2047 // main body in TeX.
2049 int LyXParagraph::BeginningOfMainBody() const
2052 if (FirstPhysicalPar() != this)
2055 // Unroll the first two cycles of the loop
2056 // and remember the previous character to
2057 // remove unnecessary GetChar() calls
2060 && GetChar(i) != LyXParagraph::META_NEWLINE
2063 char previous_char = 0, temp = 0;
2065 && (previous_char = GetChar(i)) != LyXParagraph::META_NEWLINE) {
2066 // Yes, this ^ is supposed to be "= " not "=="
2069 && previous_char != ' '
2070 && (temp = GetChar(i)) != LyXParagraph::META_NEWLINE) {
2072 previous_char = temp;
2078 if (i == 0 && i == size() &&
2079 !(footnoteflag == LyXParagraph::NO_FOOTNOTE
2080 && next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE))
2081 ++i; /* the cursor should not jump
2082 * to the main body if there
2089 LyXParagraph * LyXParagraph::DepthHook(int deth)
2091 LyXParagraph * newpar = this;
2097 newpar = newpar->FirstPhysicalPar()->Previous();
2099 newpar = newpar->Previous();
2101 } while (newpar && newpar->GetDepth() > deth
2103 && newpar->footnoteflag == footnoteflag
2108 if (Previous() || GetDepth())
2109 lyxerr << "ERROR (LyXParagraph::DepthHook): "
2114 return newpar->FirstPhysicalPar();
2121 LyXParagraph const * LyXParagraph::DepthHook(int deth) const
2123 LyXParagraph const * newpar = this;
2129 newpar = newpar->FirstPhysicalPar()->Previous();
2131 newpar = newpar->Previous();
2133 } while (newpar && newpar->GetDepth() > deth
2135 && newpar->footnoteflag == footnoteflag
2140 if (Previous() || GetDepth())
2141 lyxerr << "ERROR (LyXParagraph::DepthHook): "
2146 return newpar->FirstPhysicalPar();
2153 int LyXParagraph::AutoDeleteInsets()
2156 InsetList::size_type index = 0;
2157 while (index < insetlist.size()) {
2158 if (insetlist[index].inset && insetlist[index].inset->AutoDelete()) {
2159 Erase(insetlist[index].pos);
2160 // Erase() calls to insetlist.erase(&insetlist[index])
2161 // so index shouldn't be increased.
2170 LyXParagraph::inset_iterator
2171 LyXParagraph::InsetIterator(LyXParagraph::size_type pos)
2173 InsetTable search_inset(pos, 0);
2174 InsetList::iterator it = lower_bound(insetlist.begin(),
2176 search_inset, matchIT());
2177 return inset_iterator(it);
2181 // returns -1 if inset not found
2182 int LyXParagraph::GetPositionOfInset(Inset * inset) const
2185 for (InsetList::const_iterator cit = insetlist.begin();
2186 cit != insetlist.end(); ++cit) {
2187 if ((*cit).inset == inset) {
2192 // Think about footnotes.
2193 if (footnoteflag == LyXParagraph::NO_FOOTNOTE
2194 && next && next->footnoteflag == LyXParagraph::CLOSED_FOOTNOTE) {
2196 NextAfterFootnote()->GetPositionOfInset(inset);
2198 return text.size() + 1 + further;
2205 LyXParagraph * LyXParagraph::TeXOnePar(Buffer const * buf,
2206 BufferParams const & bparams,
2207 ostream & os, TexRow & texrow,
2212 TexRow & foot_texrow,
2217 lyxerr[Debug::LATEX] << "TeXOnePar... " << this << endl;
2218 LyXLayout const & style =
2219 textclasslist.Style(bparams.textclass,
2222 bool further_blank_line = false;
2225 lyxerr << "ERROR (LyXParagraph::TeXOnePar) is dummy." << endl;
2228 if (start_of_appendix) {
2229 os << "\\appendix\n";
2233 if (!spacing.isDefault()
2234 && (!Previous() || !Previous()->HasSameLayout(this))) {
2235 os << spacing.writeEnvirBegin() << "\n";
2239 if (tex_code_break_column && style.isCommand()){
2244 if (pagebreak_top) {
2246 further_blank_line = true;
2248 if (added_space_top.kind() != VSpace::NONE) {
2249 os << added_space_top.asLatexCommand(bparams);
2250 further_blank_line = true;
2254 os << "\\lyxline{\\" << getFont(bparams, 0).latexSize() << '}'
2255 << "\\vspace{-1\\parskip}";
2256 further_blank_line = true;
2259 if (further_blank_line){
2264 Language const * language = getParLanguage(bparams);
2265 Language const * doc_language = bparams.language;
2266 Language const * previous_language = previous
2267 ? previous->getParLanguage(bparams) : doc_language;
2268 if (language->babel() != doc_language->babel() &&
2269 language->babel() != previous_language->babel()) {
2270 os << subst(lyxrc.language_command_begin, "$$lang",
2276 if (bparams.inputenc == "auto" &&
2277 language->encoding() != previous_language->encoding()) {
2278 os << "\\inputencoding{"
2279 << language->encoding()->LatexName()
2284 switch (style.latextype) {
2287 << style.latexname()
2288 << style.latexparam();
2290 case LATEX_ITEM_ENVIRONMENT:
2292 bibkey->Latex(buf, os, false, false);
2296 case LATEX_LIST_ENVIRONMENT:
2303 bool need_par = SimpleTeXOnePar(buf, bparams, os, texrow, moving_arg);
2305 LyXParagraph * par = next;
2307 // Spit out footnotes
2308 if (lyxrc.rtl_support) {
2309 if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE
2310 && next->footnoteflag != footnoteflag) {
2311 LyXParagraph * p = 0;
2312 bool is_rtl = (size() > 0)
2313 ? GetFontSettings(bparams,
2314 size()-1).isRightToLeft()
2315 : language->RightToLeft();
2316 if ( (p = NextAfterFootnote()) != 0 &&
2318 p->GetFontSettings(bparams, 0).isRightToLeft() != is_rtl)
2319 is_rtl = getParLanguage(bparams)->RightToLeft();
2320 while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE
2321 && par->footnoteflag != footnoteflag) {
2322 par = par->TeXFootnote(buf, bparams,
2324 foot_texrow, foot_count,
2326 par->SimpleTeXOnePar(buf, bparams,
2327 os, texrow, moving_arg);
2328 is_rtl = (par->size() > 0)
2329 ? par->GetFontSettings(bparams,
2330 par->size()-1).isRightToLeft()
2331 : language->RightToLeft();
2333 par->next->footnoteflag != LyXParagraph::NO_FOOTNOTE &&
2334 (p = par->NextAfterFootnote()) != 0 &&
2336 p->GetFontSettings(bparams, 0).isRightToLeft() != is_rtl)
2337 is_rtl = language->RightToLeft();
2342 while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE
2343 && par->footnoteflag != footnoteflag) {
2344 par = par->TeXFootnote(buf, bparams,
2346 foot, foot_texrow, foot_count,
2348 par->SimpleTeXOnePar(buf, bparams, os, texrow, moving_arg);
2354 // Make sure that \\par is done with the font of the last
2355 // character if this has another size as the default.
2356 // This is necessary because LaTeX (and LyX on the screen)
2357 // calculates the space between the baselines according
2358 // to this font. (Matthias)
2359 LyXFont font = getFont(bparams, Last() - 1);
2360 if (need_par && next) {
2361 if (style.resfont.size() != font.size()) {
2367 } else if (textclasslist.Style(bparams.textclass,
2368 GetLayout()).isCommand()) {
2369 if (style.resfont.size() != font.size()) {
2375 } else if ((style.resfont.size() != font.size()) && next){
2376 os << "{\\" << font.latexSize() << " \\par}";
2379 if (language->babel() != doc_language->babel() &&
2382 || (footnoteflag != NO_FOOTNOTE && par->footnoteflag != footnoteflag)
2384 || par->getParLanguage(bparams)->babel() != language->babel())) {
2386 << subst(lyxrc.language_command_end, "$$lang",
2387 doc_language->babel());
2390 switch (style.latextype) {
2391 case LATEX_ITEM_ENVIRONMENT:
2392 case LATEX_LIST_ENVIRONMENT:
2393 if (par && (depth < par->depth)) {
2398 case LATEX_ENVIRONMENT:
2399 // if its the last paragraph of the current environment
2400 // skip it otherwise fall through
2402 && (par->layout != layout
2403 || par->depth != depth
2404 || par->pextra_type != pextra_type))
2407 // we don't need it for the last paragraph!!!
2414 further_blank_line = false;
2416 os << "\\lyxline{\\" << getFont(bparams, Last() - 1).latexSize() << '}';
2417 further_blank_line = true;
2420 if (added_space_bottom.kind() != VSpace::NONE) {
2421 os << added_space_bottom.asLatexCommand(bparams);
2422 further_blank_line = true;
2425 if (pagebreak_bottom) {
2427 further_blank_line = true;
2430 if (further_blank_line){
2435 if (!spacing.isDefault()
2436 && (!par || !par->HasSameLayout(this))) {
2437 os << spacing.writeEnvirEnd() << "\n";
2441 // we don't need it for the last paragraph!!!
2444 && !(footnoteflag != LyXParagraph::NO_FOOTNOTE && par &&
2445 par->footnoteflag == LyXParagraph::NO_FOOTNOTE)
2452 lyxerr[Debug::LATEX] << "TeXOnePar...done " << par << endl;
2457 // This one spits out the text of the paragraph
2458 bool LyXParagraph::SimpleTeXOnePar(Buffer const * buf,
2459 BufferParams const & bparams,
2460 ostream & os, TexRow & texrow,
2463 lyxerr[Debug::LATEX] << "SimpleTeXOnePar... " << this << endl;
2465 bool return_value = false;
2467 LyXLayout const & style =
2468 textclasslist.Style(bparams.textclass,
2470 LyXFont basefont, last_font;
2472 // Maybe we have to create a optional argument.
2473 size_type main_body;
2474 if (style.labeltype != LABEL_MANUAL)
2477 main_body = BeginningOfMainBody();
2479 if (main_body > 0) {
2481 basefont = getFont(bparams, -2); // Get label font
2483 basefont = getFont(bparams, -1); // Get layout font
2494 if (style.isCommand()) {
2497 } else if (align != LYX_ALIGN_LAYOUT) {
2500 return_value = true;
2504 moving_arg |= style.needprotect;
2506 // Which font is currently active?
2507 LyXFont running_font(basefont);
2508 // Do we have an open font change?
2509 bool open_font = false;
2511 texrow.start(this, 0);
2513 for (size_type i = 0; i < size(); ++i) {
2515 // First char in paragraph or after label?
2521 if (main_body > 0) {
2523 column += running_font.latexWriteEndChanges(os, basefont, basefont);
2526 basefont = getFont(bparams, -1); // Now use the layout font
2527 running_font = basefont;
2531 if (style.isCommand()) {
2534 } else if (align != LYX_ALIGN_LAYOUT) {
2537 return_value = true;
2541 os << "\\noindent ";
2545 case LYX_ALIGN_NONE:
2546 case LYX_ALIGN_BLOCK:
2547 case LYX_ALIGN_LAYOUT:
2548 case LYX_ALIGN_SPECIAL:
2550 case LYX_ALIGN_LEFT:
2551 if (getParLanguage(bparams)->babel() != "hebrew") {
2552 os << "\\raggedright ";
2555 os << "\\raggedleft ";
2559 case LYX_ALIGN_RIGHT:
2560 if (getParLanguage(bparams)->babel() != "hebrew") {
2561 os << "\\raggedleft ";
2564 os << "\\raggedright ";
2568 case LYX_ALIGN_CENTER:
2569 os << "\\centering ";
2575 value_type c = GetChar(i);
2577 // Fully instantiated font
2578 LyXFont font = getFont(bparams, i);
2580 LyXParagraph * p = 0;
2583 previous->footnoteflag != LyXParagraph::NO_FOOTNOTE &&
2584 (p = PreviousBeforeFootnote()) != 0)
2585 last_font = p->getFont(bparams, p->size() - 1);
2588 last_font = running_font;
2590 // Spaces at end of font change are simulated to be
2591 // outside font change, i.e. we write "\textXX{text} "
2592 // rather than "\textXX{text }". (Asger)
2593 if (open_font && c == ' ' && i <= size() - 2
2594 && !getFont(bparams, i + 1).equalExceptLatex(running_font)
2595 && !getFont(bparams, i + 1).equalExceptLatex(font)) {
2596 font = getFont(bparams, i + 1);
2598 // We end font definition before blanks
2599 if (!font.equalExceptLatex(running_font) && open_font) {
2600 column += running_font.latexWriteEndChanges(os,
2602 (i == main_body-1) ? basefont : font);
2603 running_font = basefont;
2607 // Blanks are printed before start of fontswitch
2609 // Do not print the separation of the optional argument
2610 if (i != main_body - 1) {
2611 SimpleTeXBlanks(os, texrow, i,
2612 column, font, style);
2616 // Do we need to change font?
2617 if (!font.equalExceptLatex(running_font)
2618 && i != main_body-1) {
2619 column += font.latexWriteStartChanges(os, basefont,
2621 running_font = font;
2625 if (c == LyXParagraph::META_NEWLINE) {
2626 // newlines are handled differently here than
2627 // the default in SimpleTeXSpecialChars().
2628 if (!style.newline_allowed
2629 || font.latex() == LyXFont::ON) {
2633 column += running_font.latexWriteEndChanges(os, basefont, basefont);
2636 basefont = getFont(bparams, -1);
2637 running_font = basefont;
2638 if (font.family() ==
2639 LyXFont::TYPEWRITER_FAMILY) {
2647 texrow.start(this, i + 1);
2650 SimpleTeXSpecialChars(buf, bparams,
2651 os, texrow, moving_arg,
2652 font, running_font, basefont,
2653 open_font, style, i, column, c);
2657 // If we have an open font definition, we have to close it
2659 LyXParagraph * p = 0;
2662 && next->footnoteflag != LyXParagraph::NO_FOOTNOTE
2663 && (p = NextAfterFootnote()) != 0
2668 running_font.latexWriteEndChanges(os, basefont,
2669 p->getFont(bparams, 0));
2671 running_font.latexWriteEndChanges(os, basefont, basefont);
2674 // Needed if there is an optional argument but no contents.
2675 if (main_body > 0 && main_body == size()) {
2677 return_value = false;
2680 lyxerr[Debug::LATEX] << "SimpleTeXOnePar...done " << this << endl;
2681 return return_value;
2685 bool LyXParagraph::linuxDocConvertChar(char c, string & sgml_string)
2687 bool retval = false;
2689 case LyXParagraph::META_HFILL:
2690 sgml_string.erase();
2692 case LyXParagraph::META_NEWLINE:
2696 sgml_string = "&";
2699 sgml_string = "<";
2702 sgml_string = ">";
2705 sgml_string = "$";
2708 sgml_string = "#";
2711 sgml_string = "%";
2714 sgml_string = "[";
2717 sgml_string = "]";
2720 sgml_string = "{";
2723 sgml_string = "}";
2726 sgml_string = "˜";
2729 sgml_string = """;
2732 sgml_string = "\";
2738 case '\0': // Ignore :-)
2739 sgml_string.erase();
2749 void LyXParagraph::SimpleTeXBlanks(ostream & os, TexRow & texrow,
2750 LyXParagraph::size_type const i,
2751 int & column, LyXFont const & font,
2752 LyXLayout const & style)
2754 if (column > tex_code_break_column
2756 && GetChar(i - 1) != ' '
2758 // In LaTeX mode, we don't want to
2759 // break lines since some commands
2761 && ! (font.latex() == LyXFont::ON)
2762 // same in FreeSpacing mode
2763 && !style.free_spacing
2764 // In typewriter mode, we want to avoid
2765 // ! . ? : at the end of a line
2766 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
2767 && (GetChar(i-1) == '.'
2768 || GetChar(i-1) == '?'
2769 || GetChar(i-1) == ':'
2770 || GetChar(i-1) == '!'))) {
2771 if (tex_code_break_column == 0) {
2772 // in batchmode we need LaTeX to still
2773 // see it as a space not as an extra '\n'
2779 texrow.start(this, i + 1);
2781 } else if (font.latex() == LyXFont::OFF) {
2782 if (style.free_spacing) {
2791 void LyXParagraph::SimpleTeXSpecialChars(Buffer const * buf,
2792 BufferParams const & bparams,
2793 ostream & os, TexRow & texrow,
2796 LyXFont & running_font,
2799 LyXLayout const & style,
2800 LyXParagraph::size_type & i,
2802 LyXParagraph::value_type const c)
2804 // Two major modes: LaTeX or plain
2805 // Handle here those cases common to both modes
2806 // and then split to handle the two modes separately.
2808 case LyXParagraph::META_INSET: {
2809 Inset * inset = GetInset(i);
2812 int len = os.tellp();
2813 if ((inset->LyxCode() == Inset::GRAPHICS_CODE
2814 || inset->LyxCode() == Inset::MATH_CODE
2815 || inset->LyxCode() == Inset::URL_CODE)
2816 && running_font.isRightToLeft()) {
2821 int tmp = inset->Latex(buf, os, moving_arg,
2822 style.free_spacing);
2830 column += os.tellp() - len;
2839 case LyXParagraph::META_NEWLINE:
2841 column += running_font.latexWriteEndChanges(os,
2846 basefont = getFont(bparams, -1);
2847 running_font = basefont;
2850 case LyXParagraph::META_HFILL:
2856 // And now for the special cases within each mode
2857 // Are we in LaTeX mode?
2858 if (font.latex() == LyXFont::ON) {
2859 // at present we only have one option
2860 // but I'll leave it as a switch statement
2861 // so its simpler to extend. (ARRae)
2864 // make sure that we will not print
2865 // error generating chars to the tex
2866 // file. This test would not be needed
2867 // if it were done in the buffer
2875 // Plain mode (i.e. not LaTeX)
2878 os << "\\textbackslash{}";
2882 case '°': case '±': case '²': case '³':
2883 case '×': case '÷': case '¹': case 'ª':
2884 case 'º': case '¬': case 'µ':
2885 if (bparams.inputenc == "latin1" ||
2886 (bparams.inputenc == "auto" &&
2887 font.language()->encoding()->LatexName()
2889 os << "\\ensuremath{"
2898 case '|': case '<': case '>':
2899 // In T1 encoding, these characters exist
2900 if (lyxrc.fontenc == "T1") {
2902 //... but we should avoid ligatures
2903 if ((c == '>' || c == '<')
2905 && GetChar(i + 1) == c) {
2906 //os << "\\textcompwordmark{}";
2907 // Jean-Marc, have a look at
2908 // this. IÂ think this works
2916 // Typewriter font also has them
2917 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
2921 // Otherwise, we use what LaTeX
2925 os << "\\textless{}";
2929 os << "\\textgreater{}";
2933 os << "\\textbar{}";
2939 case '-': // "--" in Typewriter mode -> "-{}-"
2941 && GetChar(i + 1) == '-'
2942 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
2951 os << "\\char`\\\"{}";
2956 if (bparams.inputenc == "default") {
2965 case '%': case '#': case '{':
2972 os << "\\textasciitilde{}";
2977 os << "\\textasciicircum{}";
2981 case '*': case '[': case ']':
2982 // avoid being mistaken for optional arguments
2983 os << '{' << c << '}';
2988 // Blanks are printed before font switching.
2989 // Sure? I am not! (try nice-latex)
2990 // I am sure it's correct. LyX might be smarter
2991 // in the future, but for now, nothing wrong is
2996 /* idea for labels --- begin*/
3000 && font.family() != LyXFont::TYPEWRITER_FAMILY
3001 && GetChar(i + 1) == 'y'
3002 && GetChar(i + 2) == 'X') {
3010 && font.family() != LyXFont::TYPEWRITER_FAMILY
3011 && GetChar(i + 1) == 'e'
3012 && GetChar(i + 2) == 'X') {
3017 // Check for "LaTeX2e"
3020 && font.family() != LyXFont::TYPEWRITER_FAMILY
3021 && GetChar(i + 1) == 'a'
3022 && GetChar(i + 2) == 'T'
3023 && GetChar(i + 3) == 'e'
3024 && GetChar(i + 4) == 'X'
3025 && GetChar(i + 5) == '2'
3026 && GetChar(i + 6) == 'e') {
3031 // Check for "LaTeX"
3034 && font.family() != LyXFont::TYPEWRITER_FAMILY
3035 && GetChar(i + 1) == 'a'
3036 && GetChar(i + 2) == 'T'
3037 && GetChar(i + 3) == 'e'
3038 && GetChar(i + 4) == 'X') {
3042 /* idea for labels --- end*/
3043 } else if (c != '\0') {
3053 LyXParagraph * LyXParagraph::TeXDeeper(Buffer const * buf,
3054 BufferParams const & bparams,
3055 ostream & os, TexRow & texrow
3058 TexRow & foot_texrow,
3063 lyxerr[Debug::LATEX] << "TeXDeeper... " << this << endl;
3064 LyXParagraph * par = this;
3067 (par->depth == depth)
3069 && (par->footnoteflag == footnoteflag)
3074 lyxerr << "ERROR (LyXParagraph::TeXDeeper)" << endl;
3076 if (textclasslist.Style(bparams.textclass,
3077 par->layout).isEnvironment()
3078 || par->pextra_type != PEXTRA_NONE) {
3079 par = par->TeXEnvironment(buf, bparams,
3087 par = par->TeXOnePar(buf, bparams,
3097 lyxerr[Debug::LATEX] << "TeXDeeper...done " << par << endl;
3103 LyXParagraph * LyXParagraph::TeXEnvironment(Buffer const * buf,
3104 BufferParams const & bparams,
3105 ostream & os, TexRow & texrow
3108 TexRow & foot_texrow,
3113 bool eindent_open = false;
3115 bool foot_this_level = false;
3117 // flags when footnotetext should be appended to file.
3118 static bool minipage_open = false;
3119 static int minipage_open_depth = 0;
3120 char par_sep = bparams.paragraph_separation;
3122 lyxerr[Debug::LATEX] << "TeXEnvironment... " << this << endl;
3125 lyxerr << "ERROR (LyXParagraph::TeXEnvironment)" << endl;
3128 LyXLayout const & style =
3129 textclasslist.Style(bparams.textclass,
3132 if (pextra_type == PEXTRA_INDENT) {
3133 if (!pextra_width.empty()) {
3134 os << "\\begin{LyXParagraphIndent}{"
3135 << pextra_width << "}\n";
3137 //float ib = atof(pextra_widthp.c_str())/100;
3138 // string can't handle floats at present (971109)
3139 // so I'll do a conversion by hand knowing that
3140 // the limits are 0.0 to 1.0. ARRae.
3141 os << "\\begin{LyXParagraphIndent}{";
3142 switch (pextra_widthp.length()) {
3154 os << "\\columnwidth}\n";
3157 eindent_open = true;
3159 if ((pextra_type == PEXTRA_MINIPAGE) && !minipage_open) {
3160 if (pextra_hfill && Previous() &&
3161 (Previous()->pextra_type == PEXTRA_MINIPAGE)) {
3162 os << "\\hfill{}\n";
3165 if (par_sep == BufferParams::PARSEP_INDENT) {
3166 os << "{\\setlength\\parindent{0pt}\n";
3169 os << "\\begin{minipage}";
3170 switch(pextra_alignment) {
3171 case MINIPAGE_ALIGN_TOP:
3174 case MINIPAGE_ALIGN_MIDDLE:
3177 case MINIPAGE_ALIGN_BOTTOM:
3181 if (!pextra_width.empty()) {
3182 os << '{' << pextra_width << "}\n";
3184 //float ib = atof(par->pextra_width.c_str())/100;
3185 // string can't handle floats at present
3186 // so I'll do a conversion by hand knowing that
3187 // the limits are 0.0 to 1.0. ARRae.
3189 switch (pextra_widthp.length()) {
3201 os << "\\columnwidth}\n";
3204 if (par_sep == BufferParams::PARSEP_INDENT) {
3205 os << "\\setlength\\parindent{\\LyXMinipageIndent}\n";
3208 minipage_open = true;
3209 minipage_open_depth = depth;
3212 #ifdef WITH_WARNINGS
3213 #warning Define FANCY_FOOTNOTE_CODE to re-enable Allan footnote code
3214 //I disabled it because it breaks when lists span on several
3217 if (style.isEnvironment()){
3218 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
3219 #ifdef FANCY_FOOTNOTE_CODE
3220 if (foot_count < 0) {
3221 // flag that footnote[mark][text] should be
3222 // used for any footnotes from now on
3224 foot_this_level = true;
3227 os << "\\begin{" << style.latexname() << "}{"
3228 << labelwidthstring << "}\n";
3229 } else if (style.labeltype == LABEL_BIBLIO) {
3231 os << "\\begin{" << style.latexname() << "}{"
3232 << bibitemWidest(buf)
3234 } else if (style.latextype == LATEX_ITEM_ENVIRONMENT) {
3235 #ifdef FANCY_FOOTNOTE_CODE
3236 if (foot_count < 0) {
3237 // flag that footnote[mark][text] should be
3238 // used for any footnotes from now on
3240 foot_this_level = true;
3243 os << "\\begin{" << style.latexname() << '}'
3244 << style.latexparam() << '\n';
3246 os << "\\begin{" << style.latexname() << '}'
3247 << style.latexparam() << '\n';
3250 LyXParagraph * par = this;
3252 par = par->TeXOnePar(buf, bparams,
3256 foot, foot_texrow, foot_count
3260 if (minipage_open && par && !style.isEnvironment() &&
3261 (par->pextra_type == PEXTRA_MINIPAGE) &&
3262 par->pextra_start_minipage) {
3263 os << "\\end{minipage}\n";
3265 if (par_sep == BufferParams::PARSEP_INDENT) {
3269 minipage_open = false;
3271 if (par && par->depth > depth) {
3272 if (textclasslist.Style(bparams.textclass,
3273 par->layout).isParagraph()
3275 // How to handle this? (Lgb)
3276 //&& !suffixIs(os, "\n\n")
3278 // There should be at least one '\n' already
3279 // but we need there to be two for Standard
3280 // paragraphs that are depth-increment'ed to be
3281 // output correctly. However, tables can
3282 // also be paragraphs so don't adjust them.
3285 // Will it ever harm to have one '\n' too
3286 // many? i.e. that we sometimes will have
3287 // three in a row. (Lgb)
3291 par = par->TeXDeeper(buf, bparams, os, texrow
3293 ,foot, foot_texrow, foot_count
3297 if (par && par->layout == layout && par->depth == depth &&
3298 (par->pextra_type == PEXTRA_MINIPAGE) && !minipage_open) {
3299 if (par->pextra_hfill && par->Previous() &&
3300 (par->Previous()->pextra_type == PEXTRA_MINIPAGE)){
3301 os << "\\hfill{}\n";
3304 if (par_sep == BufferParams::PARSEP_INDENT) {
3305 os << "{\\setlength\\parindent{0pt}\n";
3308 os << "\\begin{minipage}";
3309 switch(par->pextra_alignment) {
3310 case MINIPAGE_ALIGN_TOP:
3313 case MINIPAGE_ALIGN_MIDDLE:
3316 case MINIPAGE_ALIGN_BOTTOM:
3320 if (!par->pextra_width.empty()) {
3321 os << '{' << par->pextra_width << "}\n";
3323 //float ib = atof(par->pextra_widthp.c_str())/100;
3324 // string can't handle floats at present
3325 // so I'll do a conversion by hand knowing that
3326 // the limits are 0.0 to 1.0. ARRae.
3328 switch (par->pextra_widthp.length()) {
3333 os << "0." << par->pextra_widthp;
3336 os << "0.0" << par->pextra_widthp;
3338 os << "\\columnwidth}\n";
3341 if (par_sep == BufferParams::PARSEP_INDENT) {
3342 os << "\\setlength\\parindent{\\LyXMinipageIndent}\n";
3345 minipage_open = true;
3346 minipage_open_depth = par->depth;
3349 && par->layout == layout
3350 && par->depth == depth
3351 && par->pextra_type == pextra_type
3353 && par->footnoteflag == footnoteflag
3357 if (style.isEnvironment()) {
3358 os << "\\end{" << style.latexname() << '}';
3360 // maybe this should go after the minipage closes?
3361 if (foot_this_level) {
3362 if (foot_count >= 1) {
3363 if (foot_count > 1) {
3364 os << "\\addtocounter{footnote}{-"
3369 texrow += foot_texrow;
3371 foot_texrow.reset();
3377 if (minipage_open && (minipage_open_depth == depth) &&
3378 (!par || par->pextra_start_minipage ||
3379 par->pextra_type != PEXTRA_MINIPAGE)) {
3380 os << "\\end{minipage}\n";
3382 if (par_sep == BufferParams::PARSEP_INDENT) {
3386 if (par && par->pextra_type != PEXTRA_MINIPAGE) {
3387 os << "\\medskip\n\n";
3391 minipage_open = false;
3394 os << "\\end{LyXParagraphIndent}\n";
3397 if (!(par && (par->pextra_type == PEXTRA_MINIPAGE)
3398 && par->pextra_hfill)) {
3402 lyxerr[Debug::LATEX] << "TeXEnvironment...done " << par << endl;
3403 return par; // ale970302
3408 LyXParagraph * LyXParagraph::TeXFootnote(Buffer const * buf,
3409 BufferParams const & bparams,
3410 ostream & os, TexRow & texrow,
3411 ostream & foot, TexRow & foot_texrow,
3415 lyxerr[Debug::LATEX] << "TeXFootnote... " << this << endl;
3416 if (footnoteflag == LyXParagraph::NO_FOOTNOTE)
3417 lyxerr << "ERROR (LyXParagraph::TeXFootnote): "
3418 "No footnote!" << endl;
3420 LyXParagraph * par = this;
3421 LyXLayout const & style =
3422 textclasslist.Style(bparams.textclass,
3423 previous->GetLayout());
3425 if (style.needprotect && footnotekind != LyXParagraph::FOOTNOTE){
3426 lyxerr << "ERROR (LyXParagraph::TeXFootnote): "
3427 "Float other than footnote in command"
3428 " with moving argument is illegal" << endl;
3431 if (footnotekind != LyXParagraph::FOOTNOTE
3432 && footnotekind != LyXParagraph::MARGIN
3435 // How to solve this?
3436 //&& !suffixIs(file, '\n')
3438 // we need to ensure that real floats like tables and figures
3439 // have their \begin{} on a new line otherwise we can get
3440 // incorrect results when using the endfloat.sty package
3441 // especially if two floats follow one another. ARRae 981022
3442 // NOTE: if the file is length 0 it must have just been
3443 // written out so we assume it ended with a '\n'
3445 // As far as I can see there is never any harm in writing
3446 // a '\n' too much. Please tell me if I am wrong. (Lgb)
3451 bool moving_arg = false;
3452 bool need_closing = false;
3453 bool is_rtl = isRightToLeftPar(bparams);
3455 if (is_rtl != parent_is_rtl) {
3460 need_closing = true;
3463 bool footer_in_body = true;
3464 switch (footnotekind) {
3465 case LyXParagraph::FOOTNOTE:
3466 if (style.intitle) {
3467 os << "\\thanks{\n";
3468 footer_in_body = false;
3471 if (foot_count == -1) {
3472 // we're at depth 0 so we can use:
3473 os << "\\footnote{%\n";
3474 footer_in_body = false;
3476 os << "\\footnotemark{}%\n";
3478 // we only need this when there are
3479 // multiple footnotes
3480 os << "\\stepcounter{footnote}";
3482 os << "\\footnotetext{%\n";
3483 foot_texrow.start(this, 0);
3484 foot_texrow.newline();
3489 case LyXParagraph::MARGIN:
3490 os << "\\marginpar{\n";
3492 case LyXParagraph::FIG:
3493 if (pextra_type == PEXTRA_FLOATFLT
3494 && (!pextra_width.empty()
3495 || !pextra_widthp.empty())) {
3496 if (!pextra_width.empty())
3497 os << "\\begin{floatingfigure}{"
3498 << pextra_width << "}\n";
3500 os << "\\begin{floatingfigure}{"
3501 << lyx::atoi(pextra_widthp) / 100.0
3502 << "\\textwidth}\n";
3504 os << "\\begin{figure}";
3505 if (!bparams.float_placement.empty()) {
3506 os << '[' << bparams.float_placement << "]\n";
3512 case LyXParagraph::TAB:
3513 os << "\\begin{table}";
3514 if (!bparams.float_placement.empty()) {
3515 os << '[' << bparams.float_placement << "]\n";
3520 case LyXParagraph::WIDE_FIG:
3521 os << "\\begin{figure*}";
3522 if (!bparams.float_placement.empty()) {
3523 os << '[' << bparams.float_placement << "]\n";
3528 case LyXParagraph::WIDE_TAB:
3529 os << "\\begin{table*}";
3530 if (!bparams.float_placement.empty()) {
3531 os << '[' << bparams.float_placement << "]\n";
3536 case LyXParagraph::ALGORITHM:
3537 os << "\\begin{algorithm}\n";
3542 if (footnotekind != LyXParagraph::FOOTNOTE
3543 || !footer_in_body) {
3544 // Process text for all floats except footnotes in body
3546 LyXLayout const & style =
3548 .Style(bparams.textclass, par->layout);
3550 lyxerr << "ERROR (LyXParagraph::TeXFootnote)"
3552 if (style.isEnvironment()
3553 || par->pextra_type == PEXTRA_MINIPAGE) { /* && !minipage_open ?? */
3554 // Allows the use of minipages within float
3555 // environments. Shouldn't be circular because
3556 // we don't support footnotes inside
3557 // floats (yet). ARRae
3558 par = par->TeXEnvironment(buf, bparams, os,
3563 par = par->TeXOnePar(buf, bparams,
3564 os, texrow, moving_arg,
3569 if (par && !par->IsDummy() && par->depth > depth) {
3570 par = par->TeXDeeper(buf, bparams, os, texrow,
3574 } while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE);
3576 // process footnotes > depth 0 or in environments separately
3577 // NOTE: Currently don't support footnotes within footnotes
3578 // even though that is possible using the \footnotemark
3579 std::ostringstream dummy;
3580 TexRow dummy_texrow;
3581 int dummy_count = 0;
3583 LyXLayout const & style =
3585 .Style(bparams.textclass, par->layout);
3587 lyxerr << "ERROR (LyXParagraph::TeXFootnote)"
3589 if (style.isEnvironment()
3590 || par->pextra_type == PEXTRA_MINIPAGE) { /* && !minipage_open ?? */
3591 // Allows the use of minipages within float
3592 // environments. Shouldn't be circular because
3593 // we don't support footnotes inside
3594 // floats (yet). ARRae
3595 par = par->TeXEnvironment(buf, bparams,
3597 dummy, dummy_texrow,
3600 par = par->TeXOnePar(buf, bparams,
3603 dummy, dummy_texrow,
3607 if (par && !par->IsDummy() && par->depth > depth) {
3608 par = par->TeXDeeper(buf, bparams,
3610 dummy, dummy_texrow,
3614 && par->footnoteflag != LyXParagraph::NO_FOOTNOTE);
3616 lyxerr << "ERROR (LyXParagraph::TeXFootnote): "
3617 "Footnote in a Footnote -- not supported"
3620 //#ifndef HAVE_OSTREAM
3621 // delete [] dummy.str();
3625 switch (footnotekind) {
3626 case LyXParagraph::FOOTNOTE:
3627 if (footer_in_body) {
3628 // This helps tell which of the multiple
3629 // footnotetexts an error was in.
3631 foot_texrow.newline();
3636 case LyXParagraph::MARGIN:
3639 case LyXParagraph::FIG:
3640 if (pextra_type == PEXTRA_FLOATFLT
3641 && (!pextra_width.empty()
3642 || !pextra_widthp.empty()))
3643 os << "\\end{floatingfigure}";
3645 os << "\\end{figure}";
3647 case LyXParagraph::TAB:
3648 os << "\\end{table}";
3650 case LyXParagraph::WIDE_FIG:
3651 os << "\\end{figure*}";
3653 case LyXParagraph::WIDE_TAB:
3654 os << "\\end{table*}";
3656 case LyXParagraph::ALGORITHM:
3657 os << "\\end{algorithm}";
3664 if (footnotekind != LyXParagraph::FOOTNOTE
3665 && footnotekind != LyXParagraph::MARGIN) {
3666 // we need to ensure that real floats like tables and figures
3667 // have their \end{} on a line of their own otherwise we can
3668 // get incorrect results when using the endfloat.sty package.
3673 lyxerr[Debug::LATEX] << "TeXFootnote...done " << par->next << endl;
3678 bool LyXParagraph::IsDummy() const
3680 return (footnoteflag == LyXParagraph::NO_FOOTNOTE && previous
3681 && previous->footnoteflag != LyXParagraph::NO_FOOTNOTE);
3685 void LyXParagraph::SetPExtraType(BufferParams const & bparams,
3686 int type, string const & width,
3687 string const & widthp)
3690 pextra_width = width;
3691 pextra_widthp = widthp;
3693 if (textclasslist.Style(bparams.textclass,
3694 layout).isEnvironment()) {
3695 LyXParagraph * par = this;
3696 LyXParagraph * ppar = par;
3698 while (par && (par->layout == layout)
3699 && (par->depth == depth)) {
3701 par = par->Previous();
3704 par = par->FirstPhysicalPar();
3706 while (par && par->depth > depth) {
3707 par = par->Previous();
3710 par = par->FirstPhysicalPar();
3715 while (par && (par->layout == layout)
3716 && (par->depth == depth)) {
3717 par->pextra_type = type;
3718 par->pextra_width = width;
3719 par->pextra_widthp = widthp;
3721 par = par->NextAfterFootnote();
3725 if (par && (par->depth > depth))
3726 par->SetPExtraType(bparams,
3727 type, width, widthp);
3729 while (par && ((par->depth > depth) || par->IsDummy()))
3730 par = par->NextAfterFootnote();
3732 while (par && ((par->depth > depth)))
3740 void LyXParagraph::UnsetPExtraType(BufferParams const & bparams)
3742 if (pextra_type == PEXTRA_NONE)
3745 pextra_type = PEXTRA_NONE;
3746 pextra_width.erase();
3747 pextra_widthp.erase();
3749 if (textclasslist.Style(bparams.textclass,
3750 layout).isEnvironment()) {
3751 LyXParagraph * par = this;
3752 LyXParagraph * ppar = par;
3754 while (par && (par->layout == layout)
3755 && (par->depth == depth)) {
3757 par = par->Previous();
3760 par = par->FirstPhysicalPar();
3762 while (par && par->depth > depth) {
3763 par = par->Previous();
3766 par = par->FirstPhysicalPar();
3771 while (par && (par->layout == layout)
3772 && (par->depth == depth)) {
3773 par->pextra_type = PEXTRA_NONE;
3774 par->pextra_width.erase();
3775 par->pextra_widthp.erase();
3777 par = par->NextAfterFootnote();
3781 if (par && (par->depth > depth))
3782 par->UnsetPExtraType(bparams);
3784 while (par && ((par->depth > depth) || par->IsDummy()))
3785 par = par->NextAfterFootnote();
3787 while (par && ((par->depth > depth)))
3795 bool LyXParagraph::IsHfill(size_type pos) const
3797 return IsHfillChar(GetChar(pos));
3801 bool LyXParagraph::IsInset(size_type pos) const
3803 return IsInsetChar(GetChar(pos));
3808 bool LyXParagraph::IsFloat(size_type pos) const
3810 return IsFloatChar(GetChar(pos));
3815 bool LyXParagraph::IsNewline(size_type pos) const
3817 return pos >= 0 && IsNewlineChar(GetChar(pos));
3821 bool LyXParagraph::IsSeparator(size_type pos) const
3823 return IsSeparatorChar(GetChar(pos));
3827 bool LyXParagraph::IsLineSeparator(size_type pos) const
3829 return IsLineSeparatorChar(GetChar(pos));
3833 bool LyXParagraph::IsKomma(size_type pos) const
3835 return IsKommaChar(GetChar(pos));
3839 /// Used by the spellchecker
3840 bool LyXParagraph::IsLetter(LyXParagraph::size_type pos) const
3842 value_type c = GetChar(pos);
3843 if (IsLetterChar(c))
3845 // '\0' is not a letter, allthough every string contains "" (below)
3848 // We want to pass the ' and escape chars to ispell
3849 string extra = lyxrc.isp_esc_chars + '\'';
3850 char ch[2] = { c, 0 };
3851 return contains(extra, ch);
3855 bool LyXParagraph::IsWord(size_type pos ) const
3857 return IsWordChar(GetChar(pos)) ;
3862 LyXParagraph::getParLanguage(BufferParams const & bparams) const
3866 return FirstPhysicalPar()->getParLanguage(bparams);
3870 #ifdef DO_USE_DEFAULT_LANGUAGE
3871 Language const * lang = GetFirstFontSettings().language();
3873 if (lang->lang() == "default")
3874 return bparams.language;
3877 return GetFirstFontSettings().language();
3879 } else if (previous)
3880 return previous->getParLanguage(bparams);
3882 return bparams.language;
3886 bool LyXParagraph::isRightToLeftPar(BufferParams const & bparams) const
3888 return lyxrc.rtl_support
3889 && getParLanguage(bparams)->RightToLeft();
3893 void LyXParagraph::ChangeLanguage(BufferParams const & bparams,
3894 Language const * from, Language const * to)
3896 for(size_type i = 0; i < size(); ++i) {
3897 LyXFont font = GetFontSettings(bparams, i);
3898 if (font.language() == from) {
3899 font.setLanguage(to);
3906 bool LyXParagraph::isMultiLingual(BufferParams const & bparams)
3908 Language const * doc_language = bparams.language;
3909 for (FontList::const_iterator cit = fontlist.begin();
3910 cit != fontlist.end(); ++cit)
3911 if ((*cit).font.language() != doc_language)
3917 // Convert the paragraph to a string.
3918 // Used for building the table of contents
3919 string const LyXParagraph::String(Buffer const * buffer, bool label)
3921 BufferParams const & bparams = buffer->params;
3924 if (label && !IsDummy() && !labelstring.empty())
3926 if (label && !labelstring.empty())
3928 s += labelstring + ' ';
3929 string::size_type len = s.size();
3931 for (LyXParagraph::size_type i = 0; i < size(); ++i) {
3932 value_type c = GetChar(i);
3935 else if (c == META_INSET &&
3936 GetInset(i)->LyxCode() == Inset::MATH_CODE) {
3937 std::ostringstream ost;
3938 GetInset(i)->Ascii(buffer, ost);
3939 s += subst(ost.str(),'\n',' ');
3944 if (next && next->footnoteflag != LyXParagraph::NO_FOOTNOTE
3945 && footnoteflag == LyXParagraph::NO_FOOTNOTE)
3946 s += NextAfterFootnote()->String(buffer, false);
3950 if (isRightToLeftPar(bparams))
3951 reverse(s.begin() + len,s.end());
3959 string const LyXParagraph::String(Buffer const * buffer,
3960 LyXParagraph::size_type beg,
3961 LyXParagraph::size_type end)
3966 if (beg == 0 && !IsDummy() && !labelstring.empty())
3968 if (beg == 0 && !labelstring.empty())
3970 s += labelstring + ' ';
3972 for (LyXParagraph::size_type i = beg; i < end; ++i) {
3973 value_type c = GetChar(i);
3976 else if (c == META_INSET) {
3977 std::ostringstream ost;
3978 GetInset(i)->Ascii(buffer, ost);
3987 void LyXParagraph::SetInsetOwner(Inset * i)
3990 for (InsetList::const_iterator cit = insetlist.begin();
3991 cit != insetlist.end(); ++cit) {
3993 (*cit).inset->setOwner(i);
3998 void LyXParagraph::deleteInsetsLyXText(BufferView * bv)
4001 for (InsetList::const_iterator cit = insetlist.begin();
4002 cit != insetlist.end(); ++cit) {
4004 if ((*cit).inset->IsTextInset()) {
4005 static_cast<UpdatableInset *>
4006 ((*cit).inset)->deleteLyXText(bv);
4013 void LyXParagraph::resizeInsetsLyXText(BufferView * bv)
4016 for (InsetList::const_iterator cit = insetlist.begin();
4017 cit != insetlist.end(); ++cit) {
4019 if ((*cit).inset->IsTextInset()) {
4020 static_cast<UpdatableInset *>
4021 ((*cit).inset)->resizeLyXText(bv);