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 * This file is Copyright 1996-2001
12 * ======================================================
18 #pragma implementation
22 #include "bufferlist.h"
24 #include "LyXAction.h"
27 #include "tex-strings.h"
29 #include "bufferview_funcs.h"
36 #include "LaTeXFeatures.h"
43 #include "converter.h"
44 #include "BufferView.h"
45 #include "ParagraphParameters.h"
46 #include "iterators.h"
47 #include "lyxtextclasslist.h"
49 #include "mathed/formulamacro.h"
50 #include "mathed/formula.h"
52 #include "insets/inset.h"
53 #include "insets/inseterror.h"
54 #include "insets/insetlabel.h"
55 #include "insets/insetref.h"
56 #include "insets/inseturl.h"
57 #include "insets/insetnote.h"
58 #include "insets/insetquotes.h"
59 #include "insets/insetlatexaccent.h"
60 #include "insets/insetbib.h"
61 #include "insets/insetcite.h"
62 #include "insets/insetexternal.h"
63 #include "insets/insetindex.h"
64 #include "insets/insetinclude.h"
65 #include "insets/insettoc.h"
66 #include "insets/insetparent.h"
67 #include "insets/insetspecialchar.h"
68 #include "insets/insettext.h"
69 #include "insets/insetert.h"
70 #include "insets/insetgraphics.h"
71 #include "insets/insetfoot.h"
72 #include "insets/insetmarginal.h"
73 #include "insets/insetminipage.h"
74 #include "insets/insetfloat.h"
75 #include "insets/insettabular.h"
77 #include "insets/insettheorem.h"
78 #include "insets/insetlist.h"
80 #include "insets/insetcaption.h"
81 #include "insets/insetfloatlist.h"
83 #include "frontends/Dialogs.h"
84 #include "frontends/Alert.h"
86 #include "support/textutils.h"
87 #include "support/filetools.h"
88 #include "support/path.h"
89 #include "support/os.h"
90 #include "support/lyxlib.h"
91 #include "support/FileInfo.h"
92 #include "support/lyxmanip.h"
93 #include "support/lyxalgo.h" // for lyx::count
105 #include <sys/types.h>
122 using std::make_pair;
131 using lyx::textclass_type;
133 // all these externs should eventually be removed.
134 extern BufferList bufferlist;
136 extern LyXAction lyxaction;
140 const int LYX_FORMAT = 220;
144 extern int tex_code_break_column;
147 Buffer::Buffer(string const & file, bool ronly)
148 : paragraph(0), niceFile(true), lyx_clean(true), bak_clean(true),
149 unnamed(false), dep_clean(0), read_only(ronly),
150 filename_(file), users(0)
152 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
154 filepath_ = OnlyPath(file);
159 // read_only = ronly;
163 if (read_only || lyxrc.use_tempdir) {
164 tmppath = CreateBufferTmpDir();
173 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
174 // here the buffer should take care that it is
175 // saved properly, before it goes into the void.
177 // make sure that views using this buffer
182 if (!tmppath.empty()) {
183 DestroyBufferTmpDir(tmppath);
186 Paragraph * par = paragraph;
189 tmppar = par->next();
197 string const Buffer::getLatexName(bool no_path) const
199 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
201 return OnlyFilename(name);
207 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
209 string const filename = getLatexName(false);
211 if (filename.empty())
212 return make_pair(Buffer::latexlog, string());
214 string path = OnlyPath(filename);
216 if (lyxrc.use_tempdir || !IsDirWriteable(path))
219 string const fname = AddName(path,
220 OnlyFilename(ChangeExtension(filename,
223 AddName(path, OnlyFilename(
224 ChangeExtension(filename,
225 formats.extension("literate") + ".out")));
227 // If no Latex log or Build log is newer, show Build log
229 FileInfo const f_fi(fname);
230 FileInfo const b_fi(bname);
233 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
234 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
235 return make_pair(Buffer::buildlog, bname);
237 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
238 return make_pair(Buffer::latexlog, fname);
242 void Buffer::setReadonly(bool flag)
244 if (read_only != flag) {
247 users->owner()->getDialogs()->updateBufferDependent(false);
252 /// Update window titles of all users
253 // Should work on a list
254 void Buffer::updateTitles() const
257 users->owner()->updateWindowTitle();
261 /// Reset autosave timer of all users
262 // Should work on a list
263 void Buffer::resetAutosaveTimers() const
266 users->owner()->resetAutosaveTimer();
270 void Buffer::setFileName(string const & newfile)
272 filename_ = MakeAbsPath(newfile);
273 filepath_ = OnlyPath(filename_);
274 setReadonly(IsFileWriteable(filename_) == 0);
279 // We'll remove this later. (Lgb)
282 string last_inset_read;
284 #ifndef NO_COMPABILITY
287 ErtComp() : active(false), in_tabular(false) {
295 std::stack<ErtComp> ert_stack;
300 #warning And _why_ is this here? (Lgb)
308 // candidate for move to BufferView
309 // (at least some parts in the beginning of the func)
312 // changed to be public and have one parameter
313 // if par = 0 normal behavior
314 // else insert behavior
315 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
316 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
320 #ifndef NO_COMPABILITY
321 ert_comp.contents.erase();
322 ert_comp.active = false;
323 ert_comp.in_tabular = false;
326 Paragraph::depth_type depth = 0;
327 bool the_end_read = false;
329 Paragraph * first_par = 0;
330 LyXFont font(LyXFont::ALL_INHERIT, params.language);
331 if (file_format < 216 && params.language->lang() == "hebrew")
332 font.setLanguage(default_language);
336 par->layout(textclasslist[params.textclass].defaultLayoutName());
338 // We are inserting into an existing document
339 users->text->breakParagraph(users);
340 first_par = users->text->ownerParagraph();
343 // We don't want to adopt the parameters from the
344 // document we insert, so we skip until the text begins:
347 string const pretoken = lex.getString();
348 if (pretoken == "\\layout") {
349 lex.pushToken(pretoken);
357 string const token = lex.getString();
359 if (token.empty()) continue;
361 lyxerr[Debug::PARSER] << "Handling token: `"
362 << token << "'" << endl;
365 parseSingleLyXformat2Token(lex, par, first_par,
373 paragraph = first_par;
375 if (unknown_layouts > 0) {
376 string s = _("Couldn't set the layout for ");
377 if (unknown_layouts == 1) {
378 s += _("one paragraph");
380 s += tostr(unknown_layouts);
381 s += _(" paragraphs");
383 Alert::alert(_("Textclass Loading Error!"), s,
384 _("When reading " + fileName()));
387 if (unknown_tokens > 0) {
388 string s = _("Encountered ");
389 if (unknown_tokens == 1) {
390 s += _("one unknown token");
392 s += tostr(unknown_tokens);
393 s += _(" unknown tokens");
395 Alert::alert(_("Textclass Loading Error!"), s,
396 _("When reading " + fileName()));
403 #ifndef NO_COMPABILITY
404 void Buffer::insertErtContents(Paragraph * par, int & pos, bool set_inactive)
406 if (!ert_comp.contents.empty()) {
407 lyxerr[Debug::INSETS] << "ERT contents:\n'"
408 << ert_comp.contents << "'" << endl;
409 Inset * inset = new InsetERT(params, params.language,
410 ert_comp.contents, true);
411 par->insertInset(pos++, inset, ert_comp.font);
412 ert_comp.contents.erase();
415 ert_comp.active = false;
422 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
423 Paragraph *& first_par,
424 string const & token, int & pos,
425 Paragraph::depth_type & depth,
429 bool the_end_read = false;
430 #ifndef NO_COMPABILITY
431 #ifndef NO_PEXTRA_REALLY
432 // This is super temporary but is needed to get the compability
433 // mode for minipages work correctly together with new tabulars.
434 static int call_depth;
436 bool checkminipage = false;
437 static Paragraph * minipar = 0;
438 static Paragraph * parBeforeMinipage;
441 if (token[0] != '\\') {
442 #ifndef NO_COMPABILITY
443 if (ert_comp.active) {
444 ert_comp.contents += token;
447 for (string::const_iterator cit = token.begin();
448 cit != token.end(); ++cit) {
449 par->insertChar(pos, (*cit), font);
452 #ifndef NO_COMPABILITY
455 } else if (token == "\\i") {
456 Inset * inset = new InsetLatexAccent;
457 inset->read(this, lex);
458 par->insertInset(pos, inset, font);
460 } else if (token == "\\layout") {
461 #ifndef NO_COMPABILITY
462 ert_comp.in_tabular = false;
464 insertErtContents(par, pos);
467 string layoutname = lex.getString();
469 LyXTextClass const & tclass = textclasslist[params.textclass];
471 if (layoutname.empty()) {
472 layoutname = tclass.defaultLayoutName();
475 bool hasLayout = tclass.hasLayout(layoutname);
477 lyxerr << "Layout '" << layoutname << "' does not"
478 << " exist in textclass '" << tclass.name()
480 lyxerr << "Trying to use default layout instead."
482 layoutname = tclass.defaultLayoutName();
485 #ifndef NO_COMPABILITY
486 if (compare_no_case(layoutname, "latex") == 0) {
487 ert_comp.active = true;
488 ert_comp.font = font;
492 // The is the compability reading of layout caption.
493 // It can be removed in LyX version 1.3.0. (Lgb)
494 if (compare_no_case(layoutname, "caption") == 0) {
495 // We expect that the par we are now working on is
496 // really inside a InsetText inside a InsetFloat.
497 // We also know that captions can only be
498 // one paragraph. (Lgb)
500 // We should now read until the next "\layout"
502 // This is probably not good enough, what if the
503 // caption is the last par in the document (Lgb)
504 istream & ist = lex.getStream();
510 if (prefixIs(line, "\\layout")) {
514 if (prefixIs(line, "\\begin_inset"))
516 if (prefixIs(line, "\\end_inset")) {
527 // Now we should have the whole layout in ss
528 // we should now be able to give this to the
530 ss << "\\end_inset\n";
532 // This seems like a bug in stringstream.
533 // We really should be able to use ss
535 istringstream is(ss.str());
537 tmplex.setStream(is);
538 Inset * inset = new InsetCaption;
539 inset->Read(this, tmplex);
540 par->InsertInset(pos, inset, font);
547 par = new Paragraph(par);
548 par->layout(textclasslist[params.textclass].defaultLayoutName());
551 par->layout(layoutname);
552 // Test whether the layout is obsolete.
553 LyXLayout const & layout =
554 textclasslist[params.textclass][par->layout()];
555 if (!layout.obsoleted_by().empty())
556 par->layout(layout.obsoleted_by());
557 par->params().depth(depth);
558 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
559 if (file_format < 216
560 && params.language->lang() == "hebrew")
561 font.setLanguage(default_language);
566 #ifndef NO_COMPABILITY
567 } else if (token == "\\begin_float") {
568 insertErtContents(par, pos);
569 //insertErtContents(par, pos, false);
570 //ert_stack.push(ert_comp);
571 //ert_comp = ErtComp();
573 // This is the compability reader. It can be removed in
574 // LyX version 1.3.0. (Lgb)
576 string const tmptok = lex.getString();
577 //lyxerr << "old float: " << tmptok << endl;
580 stringstream old_float;
582 if (tmptok == "footnote") {
583 inset = new InsetFoot(params);
584 old_float << "collapsed true\n";
585 } else if (tmptok == "margin") {
586 inset = new InsetMarginal(params);
587 old_float << "collapsed true\n";
588 } else if (tmptok == "fig") {
589 inset = new InsetFloat(params, "figure");
590 old_float << "placement htbp\n"
592 << "collapsed false\n";
593 } else if (tmptok == "tab") {
594 inset = new InsetFloat(params, "table");
595 old_float << "placement htbp\n"
597 << "collapsed false\n";
598 } else if (tmptok == "alg") {
599 inset = new InsetFloat(params, "algorithm");
600 old_float << "placement htbp\n"
602 << "collapsed false\n";
603 } else if (tmptok == "wide-fig") {
604 inset = new InsetFloat(params, "figure");
605 //InsetFloat * tmp = new InsetFloat("figure");
608 old_float << "placement htbp\n"
610 << "collapsed false\n";
611 } else if (tmptok == "wide-tab") {
612 inset = new InsetFloat(params, "table");
613 //InsetFloat * tmp = new InsetFloat("table");
616 old_float << "placement htbp\n"
618 << "collapsed false\n";
622 #ifndef NO_PEXTRA_REALLY
625 return false; // no end read yet
628 // we have to reset the font as in the old format after a float
629 // the font was automatically reset!
630 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
632 // Here we need to check for \end_deeper and handle that
633 // before we do the footnote parsing.
634 // This _is_ a hack! (Lgb)
637 string const tmp = lex.getString();
638 if (tmp == "\\end_deeper") {
639 //lyxerr << "\\end_deeper caught!" << endl;
641 lex.printError("\\end_deeper: "
642 "depth is already null");
647 old_float << tmp << ' ';
652 old_float << lex.getLongString("\\end_float")
653 << "\n\\end_inset\n";
654 //lyxerr << "Float Body:\n" << old_float.str() << endl;
655 // That this does not work seems like a bug
656 // in stringstream. (Lgb)
657 istringstream istr(old_float.str());
659 nylex.setStream(istr);
660 inset->read(this, nylex);
661 par->insertInset(pos, inset, font);
663 insertErtContents(par, pos);
665 } else if (token == "\\begin_deeper") {
667 } else if (token == "\\end_deeper") {
669 lex.printError("\\end_deeper: "
670 "depth is already null");
674 } else if (token == "\\begin_preamble") {
675 params.readPreamble(lex);
676 } else if (token == "\\textclass") {
678 pair<bool, textclass_type> pp =
679 textclasslist.NumberOfClass(lex.getString());
681 params.textclass = pp.second;
683 Alert::alert(string(_("Textclass error")),
684 string(_("The document uses an unknown textclass \"")) +
685 lex.getString() + string("\"."),
686 string(_("LyX will not be able to produce output correctly.")));
687 params.textclass = 0;
689 if (!textclasslist[params.textclass].load()) {
690 // if the textclass wasn't loaded properly
691 // we need to either substitute another
692 // or stop loading the file.
693 // I can substitute but I don't see how I can
694 // stop loading... ideas?? ARRae980418
695 Alert::alert(_("Textclass Loading Error!"),
696 string(_("Can't load textclass ")) +
697 textclasslist[params.textclass].name(),
698 _("-- substituting default"));
699 params.textclass = 0;
701 } else if (token == "\\options") {
703 params.options = lex.getString();
704 } else if (token == "\\language") {
705 params.readLanguage(lex);
706 } else if (token == "\\fontencoding") {
708 } else if (token == "\\inputencoding") {
710 params.inputenc = lex.getString();
711 } else if (token == "\\graphics") {
712 params.readGraphicsDriver(lex);
713 } else if (token == "\\fontscheme") {
715 params.fonts = lex.getString();
716 } else if (token == "\\noindent") {
717 par->params().noindent(true);
718 } else if (token == "\\fill_top") {
719 par->params().spaceTop(VSpace(VSpace::VFILL));
720 } else if (token == "\\fill_bottom") {
721 par->params().spaceBottom(VSpace(VSpace::VFILL));
722 } else if (token == "\\line_top") {
723 par->params().lineTop(true);
724 } else if (token == "\\line_bottom") {
725 par->params().lineBottom(true);
726 } else if (token == "\\pagebreak_top") {
727 par->params().pagebreakTop(true);
728 } else if (token == "\\pagebreak_bottom") {
729 par->params().pagebreakBottom(true);
730 } else if (token == "\\start_of_appendix") {
731 par->params().startOfAppendix(true);
732 } else if (token == "\\paragraph_separation") {
733 int tmpret = lex.findToken(string_paragraph_separation);
736 if (tmpret != LYX_LAYOUT_DEFAULT)
737 params.paragraph_separation =
738 static_cast<BufferParams::PARSEP>(tmpret);
739 } else if (token == "\\defskip") {
741 params.defskip = VSpace(lex.getString());
742 #ifndef NO_COMPABILITY
743 } else if (token == "\\epsfig") { // obsolete
744 // Indeed it is obsolete, but we HAVE to be backwards
745 // compatible until 0.14, because otherwise all figures
746 // in existing documents are irretrivably lost. (Asger)
747 params.readGraphicsDriver(lex);
749 } else if (token == "\\quotes_language") {
750 int tmpret = lex.findToken(string_quotes_language);
753 if (tmpret != LYX_LAYOUT_DEFAULT) {
754 InsetQuotes::quote_language tmpl =
755 InsetQuotes::EnglishQ;
758 tmpl = InsetQuotes::EnglishQ;
761 tmpl = InsetQuotes::SwedishQ;
764 tmpl = InsetQuotes::GermanQ;
767 tmpl = InsetQuotes::PolishQ;
770 tmpl = InsetQuotes::FrenchQ;
773 tmpl = InsetQuotes::DanishQ;
776 params.quotes_language = tmpl;
778 } else if (token == "\\quotes_times") {
780 switch (lex.getInteger()) {
782 params.quotes_times = InsetQuotes::SingleQ;
785 params.quotes_times = InsetQuotes::DoubleQ;
788 } else if (token == "\\papersize") {
789 int tmpret = lex.findToken(string_papersize);
793 params.papersize2 = tmpret;
794 } else if (token == "\\paperpackage") {
795 int tmpret = lex.findToken(string_paperpackages);
798 params.paperpackage = BufferParams::PACKAGE_NONE;
800 params.paperpackage = tmpret;
801 } else if (token == "\\use_geometry") {
803 params.use_geometry = lex.getInteger();
804 } else if (token == "\\use_amsmath") {
806 params.use_amsmath = lex.getInteger();
807 } else if (token == "\\use_natbib") {
809 params.use_natbib = lex.getInteger();
810 } else if (token == "\\use_numerical_citations") {
812 params.use_numerical_citations = lex.getInteger();
813 } else if (token == "\\paperorientation") {
814 int tmpret = lex.findToken(string_orientation);
817 if (tmpret != LYX_LAYOUT_DEFAULT)
818 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
819 } else if (token == "\\paperwidth") {
821 params.paperwidth = lex.getString();
822 } else if (token == "\\paperheight") {
824 params.paperheight = lex.getString();
825 } else if (token == "\\leftmargin") {
827 params.leftmargin = lex.getString();
828 } else if (token == "\\topmargin") {
830 params.topmargin = lex.getString();
831 } else if (token == "\\rightmargin") {
833 params.rightmargin = lex.getString();
834 } else if (token == "\\bottommargin") {
836 params.bottommargin = lex.getString();
837 } else if (token == "\\headheight") {
839 params.headheight = lex.getString();
840 } else if (token == "\\headsep") {
842 params.headsep = lex.getString();
843 } else if (token == "\\footskip") {
845 params.footskip = lex.getString();
846 } else if (token == "\\paperfontsize") {
848 params.fontsize = strip(lex.getString());
849 } else if (token == "\\papercolumns") {
851 params.columns = lex.getInteger();
852 } else if (token == "\\papersides") {
854 switch (lex.getInteger()) {
856 case 1: params.sides = LyXTextClass::OneSide; break;
857 case 2: params.sides = LyXTextClass::TwoSides; break;
859 } else if (token == "\\paperpagestyle") {
861 params.pagestyle = strip(lex.getString());
862 } else if (token == "\\bullet") {
864 int const index = lex.getInteger();
866 int temp_int = lex.getInteger();
867 params.user_defined_bullets[index].setFont(temp_int);
868 params.temp_bullets[index].setFont(temp_int);
870 temp_int = lex.getInteger();
871 params.user_defined_bullets[index].setCharacter(temp_int);
872 params.temp_bullets[index].setCharacter(temp_int);
874 temp_int = lex.getInteger();
875 params.user_defined_bullets[index].setSize(temp_int);
876 params.temp_bullets[index].setSize(temp_int);
878 string const temp_str = lex.getString();
879 if (temp_str != "\\end_bullet") {
880 // this element isn't really necessary for
881 // parsing but is easier for humans
882 // to understand bullets. Put it back and
883 // set a debug message?
884 lex.printError("\\end_bullet expected, got" + temp_str);
885 //how can I put it back?
887 } else if (token == "\\bulletLaTeX") {
888 // The bullet class should be able to read this.
890 int const index = lex.getInteger();
892 string temp_str = lex.getString();
894 while (temp_str != "\\end_bullet") {
895 // this loop structure is needed when user
896 // enters an empty string since the first
897 // thing returned will be the \\end_bullet
899 // if the LaTeX entry has spaces. Each element
900 // therefore needs to be read in turn
903 temp_str = lex.getString();
906 params.user_defined_bullets[index].setText(sum_str);
907 params.temp_bullets[index].setText(sum_str);
908 } else if (token == "\\secnumdepth") {
910 params.secnumdepth = lex.getInteger();
911 } else if (token == "\\tocdepth") {
913 params.tocdepth = lex.getInteger();
914 } else if (token == "\\spacing") {
916 string const tmp = strip(lex.getString());
917 Spacing::Space tmp_space = Spacing::Default;
919 if (tmp == "single") {
920 tmp_space = Spacing::Single;
921 } else if (tmp == "onehalf") {
922 tmp_space = Spacing::Onehalf;
923 } else if (tmp == "double") {
924 tmp_space = Spacing::Double;
925 } else if (tmp == "other") {
927 tmp_space = Spacing::Other;
928 tmp_val = lex.getFloat();
930 lex.printError("Unknown spacing token: '$$Token'");
932 // Small hack so that files written with klyx will be
935 par->params().spacing(Spacing(tmp_space, tmp_val));
937 params.spacing.set(tmp_space, tmp_val);
939 } else if (token == "\\paragraph_spacing") {
941 string const tmp = strip(lex.getString());
942 if (tmp == "single") {
943 par->params().spacing(Spacing(Spacing::Single));
944 } else if (tmp == "onehalf") {
945 par->params().spacing(Spacing(Spacing::Onehalf));
946 } else if (tmp == "double") {
947 par->params().spacing(Spacing(Spacing::Double));
948 } else if (tmp == "other") {
950 par->params().spacing(Spacing(Spacing::Other,
953 lex.printError("Unknown spacing token: '$$Token'");
955 } else if (token == "\\float_placement") {
957 params.float_placement = lex.getString();
958 } else if (token == "\\family") {
960 font.setLyXFamily(lex.getString());
961 } else if (token == "\\series") {
963 font.setLyXSeries(lex.getString());
964 } else if (token == "\\shape") {
966 font.setLyXShape(lex.getString());
967 } else if (token == "\\size") {
969 font.setLyXSize(lex.getString());
970 #ifndef NO_COMPABILITY
971 } else if (token == "\\latex") {
973 string const tok = lex.getString();
974 if (tok == "no_latex") {
976 insertErtContents(par, pos);
977 } else if (tok == "latex") {
978 ert_comp.active = true;
979 ert_comp.font = font;
980 } else if (tok == "default") {
982 insertErtContents(par, pos);
984 lex.printError("Unknown LaTeX font flag "
988 } else if (token == "\\lang") {
990 string const tok = lex.getString();
991 Language const * lang = languages.getLanguage(tok);
993 font.setLanguage(lang);
995 font.setLanguage(params.language);
996 lex.printError("Unknown language `$$Token'");
998 } else if (token == "\\numeric") {
1000 font.setNumber(font.setLyXMisc(lex.getString()));
1001 } else if (token == "\\emph") {
1003 font.setEmph(font.setLyXMisc(lex.getString()));
1004 } else if (token == "\\bar") {
1006 string const tok = lex.getString();
1007 // This is dirty, but gone with LyX3. (Asger)
1009 font.setUnderbar(LyXFont::ON);
1010 else if (tok == "no")
1011 font.setUnderbar(LyXFont::OFF);
1012 else if (tok == "default")
1013 font.setUnderbar(LyXFont::INHERIT);
1015 lex.printError("Unknown bar font flag "
1017 } else if (token == "\\noun") {
1019 font.setNoun(font.setLyXMisc(lex.getString()));
1020 } else if (token == "\\color") {
1022 font.setLyXColor(lex.getString());
1023 } else if (token == "\\align") {
1024 int tmpret = lex.findToken(string_align);
1025 if (tmpret == -1) ++tmpret;
1026 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
1027 int const tmpret2 = int(pow(2.0, tmpret));
1028 //lyxerr << "Tmpret2 = " << tmpret2 << endl;
1029 par->params().align(LyXAlignment(tmpret2));
1031 } else if (token == "\\added_space_top") {
1033 VSpace value = VSpace(lex.getString());
1034 if ((value.length().len().value() != 0) ||
1035 (value.kind() != VSpace::LENGTH))
1036 par->params().spaceTop(value);
1037 } else if (token == "\\added_space_bottom") {
1039 VSpace value = VSpace(lex.getString());
1040 if ((value.length().len().value() != 0) ||
1041 (value.kind() != VSpace::LENGTH))
1042 par->params().spaceBottom(value);
1043 #ifndef NO_COMPABILITY
1044 #ifndef NO_PEXTRA_REALLY
1045 } else if (token == "\\pextra_type") {
1047 par->params().pextraType(lex.getInteger());
1048 } else if (token == "\\pextra_width") {
1050 par->params().pextraWidth(lex.getString());
1051 } else if (token == "\\pextra_widthp") {
1053 par->params().pextraWidthp(lex.getString());
1054 } else if (token == "\\pextra_alignment") {
1056 par->params().pextraAlignment(lex.getInteger());
1057 } else if (token == "\\pextra_hfill") {
1059 par->params().pextraHfill(lex.getInteger());
1060 } else if (token == "\\pextra_start_minipage") {
1062 par->params().pextraStartMinipage(lex.getInteger());
1065 } else if (token == "\\labelwidthstring") {
1067 par->params().labelWidthString(lex.getString());
1068 // do not delete this token, it is still needed!
1069 } else if (token == "\\end_inset") {
1070 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
1071 << "Last inset read was: " << last_inset_read
1073 // Simply ignore this. The insets do not have
1075 // But insets should read it, it is a part of
1076 // the inset isn't it? Lgb.
1077 } else if (token == "\\begin_inset") {
1078 #ifndef NO_COMPABILITY
1079 insertErtContents(par, pos, false);
1080 ert_stack.push(ert_comp);
1081 ert_comp = ErtComp();
1083 readInset(lex, par, pos, font);
1084 #ifndef NO_COMPABILITY
1085 ert_comp = ert_stack.top();
1087 insertErtContents(par, pos);
1089 } else if (token == "\\SpecialChar") {
1090 LyXLayout const & layout =
1091 textclasslist[params.textclass][par->layout()];
1093 // Insets don't make sense in a free-spacing context! ---Kayvan
1094 if (layout.free_spacing || par->isFreeSpacing()) {
1097 string next_token = lex.getString();
1098 if (next_token == "\\-") {
1099 par->insertChar(pos, '-', font);
1100 } else if (next_token == "\\protected_separator"
1101 || next_token == "~") {
1102 par->insertChar(pos, ' ', font);
1104 lex.printError("Token `$$Token' "
1106 "paragraph layout!");
1111 Inset * inset = new InsetSpecialChar;
1112 inset->read(this, lex);
1113 par->insertInset(pos, inset, font);
1116 } else if (token == "\\newline") {
1117 #ifndef NO_COMPABILITY
1118 if (!ert_comp.in_tabular && ert_comp.active) {
1119 ert_comp.contents += char(Paragraph::META_NEWLINE);
1121 // Since we cannot know it this is only a regular
1122 // newline or a tabular cell delimter we have to
1123 // handle the ERT here.
1124 insertErtContents(par, pos, false);
1126 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1130 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1133 } else if (token == "\\LyXTable") {
1134 #ifndef NO_COMPABILITY
1135 ert_comp.in_tabular = true;
1137 Inset * inset = new InsetTabular(*this);
1138 inset->read(this, lex);
1139 par->insertInset(pos, inset, font);
1141 } else if (token == "\\hfill") {
1142 par->insertChar(pos, Paragraph::META_HFILL, font);
1144 } else if (token == "\\protected_separator") { // obsolete
1145 // This is a backward compability thingie. (Lgb)
1146 // Remove it later some time...introduced with fileformat
1148 LyXLayout const & layout =
1149 textclasslist[params.textclass][par->layout()];
1151 if (layout.free_spacing || par->isFreeSpacing()) {
1152 par->insertChar(pos, ' ', font);
1154 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
1155 par->insertInset(pos, inset, font);
1158 } else if (token == "\\bibitem") { // ale970302
1160 InsetCommandParams p("bibitem", "dummy");
1161 par->bibkey = new InsetBibKey(p);
1163 par->bibkey->read(this, lex);
1164 } else if (token == "\\backslash") {
1165 #ifndef NO_COMPABILITY
1166 if (ert_comp.active) {
1167 ert_comp.contents += "\\";
1170 par->insertChar(pos, '\\', font);
1172 #ifndef NO_COMPABILITY
1175 } else if (token == "\\the_end") {
1176 #ifndef NO_COMPABILITY
1177 // If we still have some ert active here we have to insert
1178 // it so we don't loose it. (Lgb)
1179 insertErtContents(par, pos);
1181 the_end_read = true;
1182 #ifndef NO_COMPABILITY
1183 #ifndef NO_PEXTRA_REALLY
1186 minipar = parBeforeMinipage = 0;
1190 #ifndef NO_COMPABILITY
1191 if (ert_comp.active) {
1192 ert_comp.contents += token;
1195 // This should be insurance for the future: (Asger)
1198 string const s = _("Unknown token: ") + token
1199 + " " + lex.text() + "\n";
1200 // we can do this here this way because we're actually reading
1201 // the buffer and don't care about LyXText right now.
1202 InsetError * new_inset = new InsetError(s);
1203 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
1206 #ifndef NO_COMPABILITY
1211 #ifndef NO_COMPABILITY
1212 #ifndef NO_PEXTRA_REALLY
1213 // I wonder if we could use this blanket fix for all the
1214 // checkminipage cases...
1215 // don't forget about ert paragraphs and compatibility read for'em
1216 if (par && (par->size() || !ert_comp.contents.empty())) {
1217 // It is possible that this will check to often,
1218 // but that should not be an correctness issue.
1219 // Only a speed issue.
1220 checkminipage = true;
1223 // now check if we have a minipage paragraph as at this
1224 // point we already read all the necessary data!
1225 // this cannot be done in layout because there we did
1226 // not read yet the paragraph PEXTRA-params (Jug)
1228 // BEGIN pextra_minipage compability
1229 // This should be removed in 1.3.x (Lgb)
1230 // I don't think we should remove this so fast (Jug)
1232 // This compability code is not perfect. In a couple
1233 // of rand cases it fails. When the minipage par is
1234 // the first par in the document, and when there are
1235 // none or only one regular paragraphs after the
1236 // minipage. Currently I am not investing any effort
1237 // in fixing those cases.
1239 //lyxerr << "Call depth: " << call_depth << endl;
1240 if (checkminipage && (call_depth == 1)) {
1241 checkminipage = false;
1242 if (minipar && (minipar != par) &&
1243 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1245 lyxerr << "minipages in a row" << endl;
1246 if (par->params().pextraStartMinipage()) {
1247 lyxerr << "start new minipage" << endl;
1248 // minipages in a row
1249 par->previous()->next(0);
1252 Paragraph * tmp = minipar;
1254 tmp->params().pextraType(0);
1255 tmp->params().pextraWidth(string());
1256 tmp->params().pextraWidthp(string());
1257 tmp->params().pextraAlignment(0);
1258 tmp->params().pextraHfill(false);
1259 tmp->params().pextraStartMinipage(false);
1262 // create a new paragraph to insert the
1263 // minipages in the following case
1264 if (par->params().pextraStartMinipage() &&
1265 !par->params().pextraHfill()) {
1266 Paragraph * p = new Paragraph;
1267 p->layout(textclasslist[params.textclass].defaultLayoutName());
1269 p->previous(parBeforeMinipage);
1270 parBeforeMinipage->next(p);
1272 p->params().depth(parBeforeMinipage->params().depth());
1273 parBeforeMinipage = p;
1275 InsetMinipage * mini = new InsetMinipage(params);
1276 mini->pos(static_cast<InsetMinipage::Position>(par->params().pextraAlignment()));
1277 mini->pageWidth(LyXLength(par->params().pextraWidth()));
1278 if (!par->params().pextraWidthp().empty()) {
1279 lyxerr << "WP:" << mini->pageWidth().asString() << endl;
1280 mini->pageWidth(LyXLength((par->params().pextraWidthp())+"p%"));
1282 Paragraph * op = mini->firstParagraph();
1283 mini->inset.paragraph(par);
1285 // and free the old ones!
1288 Paragraph * pp = op->next();
1292 // Insert the minipage last in the
1293 // previous paragraph.
1294 if (par->params().pextraHfill()) {
1295 parBeforeMinipage->insertChar
1296 (parBeforeMinipage->size(), Paragraph::META_HFILL);
1298 parBeforeMinipage->insertInset
1299 (parBeforeMinipage->size(), mini);
1303 lyxerr << "new minipage par" << endl;
1304 //nothing to do just continue reading
1307 } else if (minipar && (minipar != par)) {
1308 lyxerr << "last minipage par read" << endl;
1309 // The last paragraph read was not part of a
1310 // minipage but the par linked list is...
1311 // So we need to remove the last par from the
1313 if (par->previous())
1314 par->previous()->next(0);
1315 par->previous(parBeforeMinipage);
1316 parBeforeMinipage->next(par);
1317 Paragraph * tmp = minipar;
1319 tmp->params().pextraType(0);
1320 tmp->params().pextraWidth(string());
1321 tmp->params().pextraWidthp(string());
1322 tmp->params().pextraAlignment(0);
1323 tmp->params().pextraHfill(false);
1324 tmp->params().pextraStartMinipage(false);
1327 depth = parBeforeMinipage->params().depth();
1328 // and set this depth on the par as it has not been set already
1329 par->params().depth(depth);
1330 minipar = parBeforeMinipage = 0;
1331 } else if (!minipar &&
1332 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1334 // par is the first paragraph in a minipage
1335 lyxerr << "begin minipage" << endl;
1336 // To minimize problems for
1337 // the users we will insert
1338 // the first minipage in
1339 // a sequence of minipages
1340 // in its own paragraph.
1341 Paragraph * p = new Paragraph;
1342 p->layout(textclasslist[params.textclass].defaultLayoutName());
1343 p->previous(par->previous());
1345 p->params().depth(depth);
1346 par->params().depth(0);
1348 if (par->previous())
1349 par->previous()->next(p);
1351 parBeforeMinipage = p;
1353 if (!first_par || (first_par == par))
1356 InsetMinipage * mini = new InsetMinipage(params);
1357 mini->pos(static_cast<InsetMinipage::Position>(minipar->params().pextraAlignment()));
1358 mini->pageWidth(LyXLength(minipar->params().pextraWidth()));
1359 if (!par->params().pextraWidthp().empty()) {
1360 lyxerr << "WP:" << mini->pageWidth().asString() << endl;
1361 mini->pageWidth(LyXLength((par->params().pextraWidthp())+"p%"));
1364 Paragraph * op = mini->firstParagraph();
1365 mini->inset.paragraph(minipar);
1367 // and free the old ones!
1370 Paragraph * pp = op->next();
1375 // Insert the minipage last in the
1376 // previous paragraph.
1377 if (minipar->params().pextraHfill()) {
1378 parBeforeMinipage->insertChar
1379 (parBeforeMinipage->size(),Paragraph::META_HFILL);
1381 parBeforeMinipage->insertInset
1382 (parBeforeMinipage->size(), mini);
1385 // End of pextra_minipage compability
1389 return the_end_read;
1392 // needed to insert the selection
1393 void Buffer::insertStringAsLines(Paragraph *& par, pos_type & pos,
1394 LyXFont const & fn,string const & str) const
1396 LyXLayout const & layout =
1397 textclasslist[params.textclass][par->layout()];
1400 par->checkInsertChar(font);
1401 // insert the string, don't insert doublespace
1402 bool space_inserted = true;
1403 bool autobreakrows = !par->inInset() ||
1404 static_cast<InsetText *>(par->inInset())->getAutoBreakRows();
1405 for(string::const_iterator cit = str.begin();
1406 cit != str.end(); ++cit) {
1408 if (autobreakrows && (par->size() || layout.keepempty)) {
1409 par->breakParagraph(params, pos,
1410 layout.isEnvironment());
1413 space_inserted = true;
1417 // do not insert consecutive spaces if !free_spacing
1418 } else if ((*cit == ' ' || *cit == '\t') &&
1419 space_inserted && !layout.free_spacing &&
1420 !par->isFreeSpacing())
1423 } else if (*cit == '\t') {
1424 if (!layout.free_spacing && !par->isFreeSpacing()) {
1425 // tabs are like spaces here
1426 par->insertChar(pos, ' ', font);
1428 space_inserted = true;
1430 const pos_type nb = 8 - pos % 8;
1431 for (pos_type a = 0; a < nb ; ++a) {
1432 par->insertChar(pos, ' ', font);
1435 space_inserted = true;
1437 } else if (!IsPrintable(*cit)) {
1438 // Ignore unprintables
1441 // just insert the character
1442 par->insertChar(pos, *cit, font);
1444 space_inserted = (*cit == ' ');
1451 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1452 int & pos, LyXFont & font)
1454 // consistency check
1455 if (lex.getString() != "\\begin_inset") {
1456 lyxerr << "Buffer::readInset: Consistency check failed."
1463 string const tmptok = lex.getString();
1464 last_inset_read = tmptok;
1466 // test the different insets
1467 if (tmptok == "LatexCommand") {
1468 InsetCommandParams inscmd;
1471 string const cmdName = inscmd.getCmdName();
1473 // This strange command allows LyX to recognize "natbib" style
1474 // citations: citet, citep, Citet etc.
1475 if (compare_no_case(cmdName, "cite", 4) == 0) {
1476 inset = new InsetCitation(inscmd);
1477 } else if (cmdName == "bibitem") {
1478 lex.printError("Wrong place for bibitem");
1479 inset = new InsetBibKey(inscmd);
1480 } else if (cmdName == "BibTeX") {
1481 inset = new InsetBibtex(inscmd);
1482 } else if (cmdName == "index") {
1483 inset = new InsetIndex(inscmd);
1484 } else if (cmdName == "include") {
1485 inset = new InsetInclude(inscmd, *this);
1486 } else if (cmdName == "label") {
1487 inset = new InsetLabel(inscmd);
1488 } else if (cmdName == "url"
1489 || cmdName == "htmlurl") {
1490 inset = new InsetUrl(inscmd);
1491 } else if (cmdName == "ref"
1492 || cmdName == "pageref"
1493 || cmdName == "vref"
1494 || cmdName == "vpageref"
1495 || cmdName == "prettyref") {
1496 if (!inscmd.getOptions().empty()
1497 || !inscmd.getContents().empty()) {
1498 inset = new InsetRef(inscmd, *this);
1500 } else if (cmdName == "tableofcontents") {
1501 inset = new InsetTOC(inscmd);
1502 } else if (cmdName == "listofalgorithms") {
1503 inset = new InsetFloatList("algorithm");
1504 } else if (cmdName == "listoffigures") {
1505 inset = new InsetFloatList("figure");
1506 } else if (cmdName == "listoftables") {
1507 inset = new InsetFloatList("table");
1508 } else if (cmdName == "printindex") {
1509 inset = new InsetPrintIndex(inscmd);
1510 } else if (cmdName == "lyxparent") {
1511 inset = new InsetParent(inscmd, *this);
1514 bool alreadyread = false;
1515 if (tmptok == "Quotes") {
1516 inset = new InsetQuotes;
1517 } else if (tmptok == "External") {
1518 inset = new InsetExternal;
1519 } else if (tmptok == "FormulaMacro") {
1520 inset = new InsetFormulaMacro;
1521 } else if (tmptok == "Formula") {
1522 inset = new InsetFormula;
1523 } else if (tmptok == "Figure") { // Backward compatibility
1524 // inset = new InsetFig(100, 100, *this);
1525 inset = new InsetGraphics;
1526 } else if (tmptok == "Graphics") {
1527 inset = new InsetGraphics;
1528 } else if (tmptok == "Info") {// backwards compatibility
1529 inset = new InsetNote(this,
1530 lex.getLongString("\\end_inset"),
1533 } else if (tmptok == "Note") {
1534 inset = new InsetNote(params);
1535 } else if (tmptok == "Include") {
1536 InsetCommandParams p("Include");
1537 inset = new InsetInclude(p, *this);
1538 } else if (tmptok == "ERT") {
1539 inset = new InsetERT(params);
1540 } else if (tmptok == "Tabular") {
1541 inset = new InsetTabular(*this);
1542 } else if (tmptok == "Text") {
1543 inset = new InsetText(params);
1544 } else if (tmptok == "Foot") {
1545 inset = new InsetFoot(params);
1546 } else if (tmptok == "Marginal") {
1547 inset = new InsetMarginal(params);
1548 } else if (tmptok == "Minipage") {
1549 inset = new InsetMinipage(params);
1550 } else if (tmptok == "Float") {
1552 string tmptok = lex.getString();
1553 inset = new InsetFloat(params, tmptok);
1555 } else if (tmptok == "List") {
1556 inset = new InsetList;
1557 } else if (tmptok == "Theorem") {
1558 inset = new InsetList;
1560 } else if (tmptok == "Caption") {
1561 inset = new InsetCaption(params);
1562 } else if (tmptok == "FloatList") {
1563 inset = new InsetFloatList;
1566 if (inset && !alreadyread) inset->read(this, lex);
1570 par->insertInset(pos, inset, font);
1576 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1580 string const token(lex.getString());
1581 if (token == "\\lyxformat") { // the first token _must_ be...
1583 string tmp_format = lex.getString();
1584 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1585 // if present remove ".," from string.
1586 string::size_type dot = tmp_format.find_first_of(".,");
1587 //lyxerr << " dot found at " << dot << endl;
1588 if (dot != string::npos)
1589 tmp_format.erase(dot, 1);
1590 file_format = strToInt(tmp_format);
1591 if (file_format == LYX_FORMAT) {
1593 } else if (file_format > LYX_FORMAT) {
1595 Alert::alert(_("Warning!"),
1596 _("LyX file format is newer that what"),
1597 _("is supported in this LyX version. Expect some problems."));
1599 } else if (file_format < LYX_FORMAT) {
1601 if (file_format < 200) {
1602 Alert::alert(_("ERROR!"),
1603 _("Old LyX file format found. "
1604 "Use LyX 0.10.x to read this!"));
1608 bool the_end = readLyXformat2(lex, par);
1609 params.setPaperStuff();
1610 // the_end was added in 213
1611 if (file_format < 213)
1615 Alert::alert(_("Warning!"),
1616 _("Reading of document is not complete"),
1617 _("Maybe the document is truncated"));
1620 } else { // "\\lyxformat" not found
1621 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1624 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1629 // Should probably be moved to somewhere else: BufferView? LyXView?
1630 bool Buffer::save() const
1632 // We don't need autosaves in the immediate future. (Asger)
1633 resetAutosaveTimers();
1637 if (lyxrc.make_backup) {
1638 s = fileName() + '~';
1639 if (!lyxrc.backupdir_path.empty())
1640 s = AddName(lyxrc.backupdir_path,
1641 subst(os::slashify_path(s),'/','!'));
1643 // Rename is the wrong way of making a backup,
1644 // this is the correct way.
1645 /* truss cp fil fil2:
1646 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1647 stat("LyXVC.lyx", 0xEFFFF688) = 0
1648 open("LyXVC.lyx", O_RDONLY) = 3
1649 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1650 fstat(4, 0xEFFFF508) = 0
1651 fstat(3, 0xEFFFF508) = 0
1652 read(3, " # T h i s f i l e w".., 8192) = 5579
1653 write(4, " # T h i s f i l e w".., 5579) = 5579
1654 read(3, 0xEFFFD4A0, 8192) = 0
1657 chmod("LyXVC3.lyx", 0100644) = 0
1658 lseek(0, 0, SEEK_CUR) = 46440
1662 // Should probably have some more error checking here.
1663 // Should be cleaned up in 0.13, at least a bit.
1664 // Doing it this way, also makes the inodes stay the same.
1665 // This is still not a very good solution, in particular we
1666 // might loose the owner of the backup.
1667 FileInfo finfo(fileName());
1668 if (finfo.exist()) {
1669 mode_t fmode = finfo.getMode();
1670 struct utimbuf times = {
1671 finfo.getAccessTime(),
1672 finfo.getModificationTime() };
1674 ifstream ifs(fileName().c_str());
1675 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1680 ::chmod(s.c_str(), fmode);
1682 if (::utime(s.c_str(), ×)) {
1683 lyxerr << "utime error." << endl;
1686 lyxerr << "LyX was not able to make "
1687 "backup copy. Beware." << endl;
1692 if (writeFile(fileName(), false)) {
1694 removeAutosaveFile(fileName());
1696 // Saving failed, so backup is not backup
1697 if (lyxrc.make_backup) {
1698 lyx::rename(s, fileName());
1706 // Returns false if unsuccesful
1707 bool Buffer::writeFile(string const & fname, bool flag) const
1709 // if flag is false writeFile will not create any GUI
1710 // warnings, only cerr.
1711 // Needed for autosave in background or panic save (Matthias 120496)
1713 if (read_only && (fname == fileName())) {
1714 // Here we should come with a question if we should
1715 // perform the write anyway.
1717 lyxerr << _("Error! Document is read-only: ")
1720 Alert::alert(_("Error! Document is read-only: "),
1725 FileInfo finfo(fname);
1726 if (finfo.exist() && !finfo.writable()) {
1727 // Here we should come with a question if we should
1728 // try to do the save anyway. (i.e. do a chmod first)
1730 lyxerr << _("Error! Cannot write file: ")
1733 Alert::err_alert(_("Error! Cannot write file: "),
1738 ofstream ofs(fname.c_str());
1741 lyxerr << _("Error! Cannot open file: ")
1744 Alert::err_alert(_("Error! Cannot open file: "),
1750 // Use the standard "C" locale for file output.
1751 ofs.imbue(std::locale::classic());
1754 // The top of the file should not be written by params.
1756 // write out a comment in the top of the file
1757 ofs << '#' << lyx_docversion
1758 << " created this file. For more info see http://www.lyx.org/\n"
1759 << "\\lyxformat " << LYX_FORMAT << "\n";
1761 // now write out the buffer paramters.
1762 params.writeFile(ofs);
1764 Paragraph::depth_type depth = 0;
1766 // this will write out all the paragraphs
1767 // using recursive descent.
1768 paragraph->writeFile(this, ofs, params, depth);
1770 // Write marker that shows file is complete
1771 ofs << "\n\\the_end" << endl;
1775 // how to check if close went ok?
1776 // Following is an attempt... (BE 20001011)
1778 // good() returns false if any error occured, including some
1779 // formatting error.
1780 // bad() returns true if something bad happened in the buffer,
1781 // which should include file system full errors.
1788 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1790 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1802 pair<int, string> const addDepth(int depth, int ldepth)
1806 d += (ldepth - depth) * 2;
1807 return make_pair(d, string(d, ' '));
1813 string const Buffer::asciiParagraph(Paragraph const * par,
1814 unsigned int linelen,
1815 bool noparbreak) const
1817 ostringstream buffer;
1818 Paragraph::depth_type depth = 0;
1820 Paragraph::depth_type ltype_depth = 0;
1821 bool ref_printed = false;
1822 // if (!par->previous()) {
1824 // begins or ends a deeper area ?
1825 if (depth != par->params().depth()) {
1826 if (par->params().depth() > depth) {
1827 while (par->params().depth() > depth) {
1831 while (par->params().depth() < depth) {
1837 depth = par->params().depth();
1840 // First write the layout
1841 string const & tmp = par->layout();
1842 if (compare_no_case(tmp, "itemize") == 0) {
1844 ltype_depth = depth + 1;
1845 } else if (compare_no_case(tmp, "enumerate") == 0) {
1847 ltype_depth = depth + 1;
1848 } else if (contains(lowercase(tmp), "ection")) {
1850 ltype_depth = depth + 1;
1851 } else if (contains(lowercase(tmp), "aragraph")) {
1853 ltype_depth = depth + 1;
1854 } else if (compare_no_case(tmp, "description") == 0) {
1856 ltype_depth = depth + 1;
1857 } else if (compare_no_case(tmp, "abstract") == 0) {
1860 } else if (compare_no_case(tmp, "bibliography") == 0) {
1868 /* maybe some vertical spaces */
1870 /* the labelwidthstring used in lists */
1874 /* some pagebreaks? */
1878 /* what about the alignment */
1880 // lyxerr << "Should this ever happen?" << endl;
1883 // linelen <= 0 is special and means we don't have pargraph breaks
1885 string::size_type currlinelen = 0;
1891 buffer << string(depth * 2, ' ');
1892 currlinelen += depth * 2;
1895 // we should probably change to the paragraph language in the
1896 // gettext here (if possible) so that strings are outputted in
1897 // the correct language! (20012712 Jug)
1901 case 4: // (Sub)Paragraph
1902 case 5: // Description
1906 buffer << _("Abstract") << "\n\n";
1909 string const abst = _("Abstract: ");
1911 currlinelen += abst.length();
1914 case 7: // Bibliography
1917 buffer << _("References") << "\n\n";
1920 string const refs = _("References: ");
1922 currlinelen += refs.length();
1930 string const parlab = par->params().labelString();
1931 buffer << parlab << " ";
1932 currlinelen += parlab.length() + 1;
1940 pair<int, string> p = addDepth(depth, ltype_depth);
1942 currlinelen += p.first;
1945 // this is to change the linebreak to do it by word a bit more
1946 // intelligent hopefully! (only in the case where we have a
1947 // max linelenght!) (Jug)
1951 for (pos_type i = 0; i < par->size(); ++i) {
1952 char c = par->getUChar(params, i);
1954 case Paragraph::META_INSET:
1956 Inset const * inset = par->getInset(i);
1960 currlinelen += word.length();
1963 if (inset->ascii(this, buffer, linelen)) {
1964 // to be sure it breaks paragraph
1965 currlinelen += linelen;
1971 case Paragraph::META_NEWLINE:
1973 buffer << word << "\n";
1976 pair<int, string> p = addDepth(depth,
1979 currlinelen = p.first;
1983 case Paragraph::META_HFILL:
1984 buffer << word << "\t";
1985 currlinelen += word.length() + 1;
1992 currlinelen + word.length() > linelen - 10) {
1994 pair<int, string> p =
1995 addDepth(depth, ltype_depth);
1997 currlinelen = p.first;
2000 buffer << word << ' ';
2001 currlinelen += word.length() + 1;
2008 lyxerr[Debug::INFO] <<
2009 "writeAsciiFile: NULL char in structure." << endl;
2011 if ((linelen > 0) &&
2012 (currlinelen + word.length()) > linelen)
2016 pair<int, string> p =
2017 addDepth(depth, ltype_depth);
2019 currlinelen = p.first;
2026 return buffer.str().c_str();
2030 void Buffer::writeFileAscii(string const & fname, int linelen)
2032 ofstream ofs(fname.c_str());
2034 Alert::err_alert(_("Error: Cannot write file:"), fname);
2037 writeFileAscii(ofs, linelen);
2041 void Buffer::writeFileAscii(ostream & ofs, int linelen)
2043 Paragraph * par = paragraph;
2045 ofs << asciiParagraph(par, linelen, par->previous() == 0);
2055 void Buffer::makeLaTeXFile(string const & fname,
2056 string const & original_path,
2057 bool nice, bool only_body)
2059 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
2061 ofstream ofs(fname.c_str());
2063 Alert::err_alert(_("Error: Cannot open file: "), fname);
2067 niceFile = nice; // this will be used by Insetincludes.
2069 tex_code_break_column = lyxrc.ascii_linelen;
2071 // validate the buffer.
2072 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
2073 LaTeXFeatures features(params);
2075 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
2078 // The starting paragraph of the coming rows is the
2079 // first paragraph of the document. (Asger)
2080 texrow.start(paragraph, 0);
2082 if (!only_body && nice) {
2083 ofs << "%% " << lyx_docversion << " created this file. "
2084 "For more info, see http://www.lyx.org/.\n"
2085 "%% Do not edit unless you really know what "
2090 lyxerr[Debug::INFO] << "lyx header finished" << endl;
2091 // There are a few differences between nice LaTeX and usual files:
2092 // usual is \batchmode and has a
2093 // special input@path to allow the including of figures
2094 // with either \input or \includegraphics (what figinsets do).
2095 // batchmode is not set if there is a tex_code_break_column.
2096 // In this case somebody is interested in the generated LaTeX,
2097 // so this is OK. input@path is set when the actual parameter
2098 // original_path is set. This is done for usual tex-file, but not
2099 // for nice-latex-file. (Matthias 250696)
2102 // code for usual, NOT nice-latex-file
2103 ofs << "\\batchmode\n"; // changed
2104 // from \nonstopmode
2107 if (!original_path.empty()) {
2108 string inputpath = os::external_path(original_path);
2109 subst(inputpath, "~", "\\string~");
2110 ofs << "\\makeatletter\n"
2111 << "\\def\\input@path{{"
2112 << inputpath << "/}}\n"
2113 << "\\makeatother\n";
2119 ofs << "\\documentclass";
2121 LyXTextClass const & tclass = textclasslist[params.textclass];
2123 ostringstream options; // the document class options.
2125 if (tokenPos(tclass.opt_fontsize(),
2126 '|', params.fontsize) >= 0) {
2127 // only write if existing in list (and not default)
2128 options << params.fontsize << "pt,";
2132 if (!params.use_geometry &&
2133 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2134 switch (params.papersize) {
2135 case BufferParams::PAPER_A4PAPER:
2136 options << "a4paper,";
2138 case BufferParams::PAPER_USLETTER:
2139 options << "letterpaper,";
2141 case BufferParams::PAPER_A5PAPER:
2142 options << "a5paper,";
2144 case BufferParams::PAPER_B5PAPER:
2145 options << "b5paper,";
2147 case BufferParams::PAPER_EXECUTIVEPAPER:
2148 options << "executivepaper,";
2150 case BufferParams::PAPER_LEGALPAPER:
2151 options << "legalpaper,";
2157 if (params.sides != tclass.sides()) {
2158 switch (params.sides) {
2159 case LyXTextClass::OneSide:
2160 options << "oneside,";
2162 case LyXTextClass::TwoSides:
2163 options << "twoside,";
2169 if (params.columns != tclass.columns()) {
2170 if (params.columns == 2)
2171 options << "twocolumn,";
2173 options << "onecolumn,";
2176 if (!params.use_geometry
2177 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2178 options << "landscape,";
2180 // language should be a parameter to \documentclass
2182 ostringstream language_options;
2183 if (params.language->babel() == "hebrew"
2184 && default_language->babel() != "hebrew")
2185 // This seems necessary
2186 features.useLanguage(default_language);
2188 if (lyxrc.language_use_babel ||
2189 params.language->lang() != lyxrc.default_language ||
2190 !features.hasLanguages()) {
2192 language_options << features.getLanguages();
2193 language_options << params.language->babel();
2194 if (lyxrc.language_global_options)
2195 options << language_options.str() << ',';
2198 // the user-defined options
2199 if (!params.options.empty()) {
2200 options << params.options << ',';
2203 string strOptions(options.str().c_str());
2204 if (!strOptions.empty()) {
2205 strOptions = strip(strOptions, ',');
2206 ofs << '[' << strOptions << ']';
2209 ofs << '{' << tclass.latexname() << "}\n";
2211 // end of \documentclass defs
2213 // font selection must be done before loading fontenc.sty
2214 // The ae package is not needed when using OT1 font encoding.
2215 if (params.fonts != "default" &&
2216 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2217 ofs << "\\usepackage{" << params.fonts << "}\n";
2219 if (params.fonts == "ae") {
2220 ofs << "\\usepackage{aecompl}\n";
2224 // this one is not per buffer
2225 if (lyxrc.fontenc != "default") {
2226 ofs << "\\usepackage[" << lyxrc.fontenc
2231 if (params.inputenc == "auto") {
2232 string const doc_encoding =
2233 params.language->encoding()->LatexName();
2235 // Create a list with all the input encodings used
2237 set<string> encodings = features.getEncodingSet(doc_encoding);
2239 ofs << "\\usepackage[";
2240 std::copy(encodings.begin(), encodings.end(),
2241 std::ostream_iterator<string>(ofs, ","));
2242 ofs << doc_encoding << "]{inputenc}\n";
2244 } else if (params.inputenc != "default") {
2245 ofs << "\\usepackage[" << params.inputenc
2250 // At the very beginning the text parameters.
2251 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2252 switch (params.paperpackage) {
2253 case BufferParams::PACKAGE_A4:
2254 ofs << "\\usepackage{a4}\n";
2257 case BufferParams::PACKAGE_A4WIDE:
2258 ofs << "\\usepackage{a4wide}\n";
2261 case BufferParams::PACKAGE_WIDEMARGINSA4:
2262 ofs << "\\usepackage[widemargins]{a4}\n";
2267 if (params.use_geometry) {
2268 ofs << "\\usepackage{geometry}\n";
2270 ofs << "\\geometry{verbose";
2271 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2272 ofs << ",landscape";
2273 switch (params.papersize2) {
2274 case BufferParams::VM_PAPER_CUSTOM:
2275 if (!params.paperwidth.empty())
2276 ofs << ",paperwidth="
2277 << params.paperwidth;
2278 if (!params.paperheight.empty())
2279 ofs << ",paperheight="
2280 << params.paperheight;
2282 case BufferParams::VM_PAPER_USLETTER:
2283 ofs << ",letterpaper";
2285 case BufferParams::VM_PAPER_USLEGAL:
2286 ofs << ",legalpaper";
2288 case BufferParams::VM_PAPER_USEXECUTIVE:
2289 ofs << ",executivepaper";
2291 case BufferParams::VM_PAPER_A3:
2294 case BufferParams::VM_PAPER_A4:
2297 case BufferParams::VM_PAPER_A5:
2300 case BufferParams::VM_PAPER_B3:
2303 case BufferParams::VM_PAPER_B4:
2306 case BufferParams::VM_PAPER_B5:
2310 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2311 switch (lyxrc.default_papersize) {
2312 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2313 case BufferParams::PAPER_USLETTER:
2314 ofs << ",letterpaper";
2316 case BufferParams::PAPER_LEGALPAPER:
2317 ofs << ",legalpaper";
2319 case BufferParams::PAPER_EXECUTIVEPAPER:
2320 ofs << ",executivepaper";
2322 case BufferParams::PAPER_A3PAPER:
2325 case BufferParams::PAPER_A4PAPER:
2328 case BufferParams::PAPER_A5PAPER:
2331 case BufferParams::PAPER_B5PAPER:
2336 if (!params.topmargin.empty())
2337 ofs << ",tmargin=" << params.topmargin;
2338 if (!params.bottommargin.empty())
2339 ofs << ",bmargin=" << params.bottommargin;
2340 if (!params.leftmargin.empty())
2341 ofs << ",lmargin=" << params.leftmargin;
2342 if (!params.rightmargin.empty())
2343 ofs << ",rmargin=" << params.rightmargin;
2344 if (!params.headheight.empty())
2345 ofs << ",headheight=" << params.headheight;
2346 if (!params.headsep.empty())
2347 ofs << ",headsep=" << params.headsep;
2348 if (!params.footskip.empty())
2349 ofs << ",footskip=" << params.footskip;
2354 if (tokenPos(tclass.opt_pagestyle(),
2355 '|', params.pagestyle) >= 0) {
2356 if (params.pagestyle == "fancy") {
2357 ofs << "\\usepackage{fancyhdr}\n";
2360 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2364 if (params.secnumdepth != tclass.secnumdepth()) {
2365 ofs << "\\setcounter{secnumdepth}{"
2366 << params.secnumdepth
2370 if (params.tocdepth != tclass.tocdepth()) {
2371 ofs << "\\setcounter{tocdepth}{"
2377 if (params.paragraph_separation) {
2378 switch (params.defskip.kind()) {
2379 case VSpace::SMALLSKIP:
2380 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2382 case VSpace::MEDSKIP:
2383 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2385 case VSpace::BIGSKIP:
2386 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2388 case VSpace::LENGTH:
2389 ofs << "\\setlength\\parskip{"
2390 << params.defskip.length().asLatexString()
2393 default: // should never happen // Then delete it.
2394 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2399 ofs << "\\setlength\\parindent{0pt}\n";
2403 // Now insert the LyX specific LaTeX commands...
2405 // The optional packages;
2406 string preamble(features.getPackages());
2408 // this might be useful...
2409 preamble += "\n\\makeatletter\n";
2411 // Some macros LyX will need
2412 string tmppreamble(features.getMacros());
2414 if (!tmppreamble.empty()) {
2415 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2416 "LyX specific LaTeX commands.\n"
2417 + tmppreamble + '\n';
2420 // the text class specific preamble
2421 tmppreamble = features.getTClassPreamble();
2422 if (!tmppreamble.empty()) {
2423 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2424 "Textclass specific LaTeX commands.\n"
2425 + tmppreamble + '\n';
2428 /* the user-defined preamble */
2429 if (!params.preamble.empty()) {
2430 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2431 "User specified LaTeX commands.\n"
2432 + params.preamble + '\n';
2435 preamble += "\\makeatother\n";
2437 // Itemize bullet settings need to be last in case the user
2438 // defines their own bullets that use a package included
2439 // in the user-defined preamble -- ARRae
2440 // Actually it has to be done much later than that
2441 // since some packages like frenchb make modifications
2442 // at \begin{document} time -- JMarc
2444 for (int i = 0; i < 4; ++i) {
2445 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2446 if (bullets_def.empty())
2447 bullets_def="\\AtBeginDocument{\n";
2448 bullets_def += " \\renewcommand{\\labelitemi";
2450 // `i' is one less than the item to modify
2457 bullets_def += "ii";
2463 bullets_def += "}{" +
2464 params.user_defined_bullets[i].getText()
2469 if (!bullets_def.empty())
2470 preamble += bullets_def + "}\n\n";
2473 int(lyx::count(preamble.begin(), preamble.end(), '\n'));
2474 for (int j = 0; j != nlines; ++j) {
2480 // We try to load babel late, in case it interferes
2481 // with other packages.
2483 string tmp = lyxrc.language_package;
2484 if (!lyxrc.language_global_options
2485 && tmp == "\\usepackage{babel}")
2486 tmp = string("\\usepackage[") +
2487 language_options.str().c_str() +
2494 ofs << "\\begin{document}\n";
2497 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2499 if (!lyxrc.language_auto_begin) {
2500 ofs << subst(lyxrc.language_command_begin, "$$lang",
2501 params.language->babel())
2506 latexParagraphs(ofs, paragraph, 0, texrow);
2508 // add this just in case after all the paragraphs
2512 if (!lyxrc.language_auto_end) {
2513 ofs << subst(lyxrc.language_command_end, "$$lang",
2514 params.language->babel())
2520 ofs << "\\end{document}\n";
2523 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2525 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2529 // Just to be sure. (Asger)
2532 // tex_code_break_column's value is used to decide
2533 // if we are in batchmode or not (within mathed_write()
2534 // in math_write.C) so we must set it to a non-zero
2535 // value when we leave otherwise we save incorrect .lyx files.
2536 tex_code_break_column = lyxrc.ascii_linelen;
2540 lyxerr << "File was not closed properly." << endl;
2543 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2544 lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2546 // we want this to be true outside previews (for insetexternal)
2552 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2554 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2555 Paragraph * endpar, TexRow & texrow) const
2557 bool was_title = false;
2558 bool already_title = false;
2561 while (par != endpar) {
2562 Inset * in = par->inInset();
2563 // well we have to check if we are in an inset with unlimited
2564 // lenght (all in one row) if that is true then we don't allow
2565 // any special options in the paragraph and also we don't allow
2566 // any environment other then "Standard" to be valid!
2567 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
2568 LyXLayout const & layout =
2569 textclasslist[params.textclass][par->layout()];
2571 if (layout.intitle) {
2572 if (already_title) {
2573 lyxerr <<"Error in latexParagraphs: You"
2574 " should not mix title layouts"
2575 " with normal ones." << endl;
2578 } else if (was_title && !already_title) {
2579 ofs << "\\maketitle\n";
2581 already_title = true;
2585 if (layout.isEnvironment()) {
2586 par = par->TeXEnvironment(this, params, ofs, texrow);
2588 par = par->TeXOnePar(this, params, ofs, texrow, false);
2591 par = par->TeXOnePar(this, params, ofs, texrow, false);
2594 // It might be that we only have a title in this document
2595 if (was_title && !already_title) {
2596 ofs << "\\maketitle\n";
2602 bool Buffer::isLatex() const
2604 return textclasslist[params.textclass].outputType() == LATEX;
2608 bool Buffer::isLinuxDoc() const
2610 return textclasslist[params.textclass].outputType() == LINUXDOC;
2614 bool Buffer::isLiterate() const
2616 return textclasslist[params.textclass].outputType() == LITERATE;
2620 bool Buffer::isDocBook() const
2622 return textclasslist[params.textclass].outputType() == DOCBOOK;
2626 bool Buffer::isSGML() const
2628 LyXTextClass const & tclass = textclasslist[params.textclass];
2630 return tclass.outputType() == LINUXDOC ||
2631 tclass.outputType() == DOCBOOK;
2635 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type,
2636 string const & latexname) const
2638 if (!latexname.empty() && latexname != "!-- --")
2639 //os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2640 os << "<" << latexname << ">";
2644 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type,
2645 string const & latexname) const
2647 if (!latexname.empty() && latexname != "!-- --")
2648 //os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2649 os << "</" << latexname << ">";
2653 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2655 ofstream ofs(fname.c_str());
2658 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2662 niceFile = nice; // this will be used by included files.
2664 LaTeXFeatures features(params);
2670 LyXTextClass const & tclass = textclasslist[params.textclass];
2672 string top_element = tclass.latexname();
2675 ofs << "<!doctype linuxdoc system";
2677 string preamble = params.preamble;
2678 const string name = nice ? ChangeExtension(filename_, ".sgml")
2680 preamble += features.getIncludedFiles(name);
2681 preamble += features.getLyXSGMLEntities();
2683 if (!preamble.empty()) {
2684 ofs << " [ " << preamble << " ]";
2688 if (params.options.empty())
2689 sgmlOpenTag(ofs, 0, top_element);
2691 string top = top_element;
2693 top += params.options;
2694 sgmlOpenTag(ofs, 0, top);
2698 ofs << "<!-- " << lyx_docversion
2699 << " created this file. For more info see http://www.lyx.org/"
2702 Paragraph::depth_type depth = 0; // paragraph depth
2703 Paragraph * par = paragraph;
2705 vector<string> environment_stack(5);
2708 LyXLayout const & style = tclass[par->layout()];
2710 // treat <toc> as a special case for compatibility with old code
2711 if (par->isInset(0)) {
2712 Inset * inset = par->getInset(0);
2713 Inset::Code lyx_code = inset->lyxCode();
2714 if (lyx_code == Inset::TOC_CODE) {
2715 string const temp = "toc";
2716 sgmlOpenTag(ofs, depth, temp);
2723 // environment tag closing
2724 for (; depth > par->params().depth(); --depth) {
2725 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2726 environment_stack[depth].erase();
2729 // write opening SGML tags
2730 switch (style.latextype) {
2731 case LATEX_PARAGRAPH:
2732 if (depth == par->params().depth()
2733 && !environment_stack[depth].empty()) {
2734 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2735 environment_stack[depth].erase();
2741 sgmlOpenTag(ofs, depth, style.latexname());
2747 _("Error : Wrong depth for"
2748 " LatexType Command.\n"));
2750 if (!environment_stack[depth].empty()) {
2751 sgmlCloseTag(ofs, depth,
2752 environment_stack[depth]);
2756 environment_stack[depth].erase();
2757 sgmlOpenTag(ofs, depth, style.latexname());
2760 case LATEX_ENVIRONMENT:
2761 case LATEX_ITEM_ENVIRONMENT:
2762 if (depth == par->params().depth()
2763 && environment_stack[depth] != style.latexname()) {
2764 sgmlCloseTag(ofs, depth,
2765 environment_stack[depth]);
2766 environment_stack[depth].erase();
2768 if (depth < par->params().depth()) {
2769 depth = par->params().depth();
2770 environment_stack[depth].erase();
2772 if (environment_stack[depth] != style.latexname()) {
2774 sgmlOpenTag(ofs, depth, "p");
2776 sgmlOpenTag(ofs, depth, style.latexname());
2778 if (environment_stack.size() == depth + 1)
2779 environment_stack.push_back("!-- --");
2780 environment_stack[depth] = style.latexname();
2783 if (style.latexparam() == "CDATA")
2786 if (style.latextype == LATEX_ENVIRONMENT) break;
2788 if (style.labeltype == LABEL_MANUAL)
2793 sgmlOpenTag(ofs, depth + 1, item_name);
2796 sgmlOpenTag(ofs, depth, style.latexname());
2800 simpleLinuxDocOnePar(ofs, par, depth);
2805 // write closing SGML tags
2806 switch (style.latextype) {
2809 case LATEX_ENVIRONMENT:
2810 case LATEX_ITEM_ENVIRONMENT:
2811 if (style.latexparam() == "CDATA")
2815 sgmlCloseTag(ofs, depth, style.latexname());
2821 for (int i=depth; i >= 0; --i)
2822 sgmlCloseTag(ofs, depth, environment_stack[i]);
2826 sgmlCloseTag(ofs, 0, top_element);
2830 // How to check for successful close
2832 // we want this to be true outside previews (for insetexternal)
2837 // checks, if newcol chars should be put into this line
2838 // writes newline, if necessary.
2841 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2842 string::size_type newcol)
2845 if (colcount > lyxrc.ascii_linelen) {
2847 colcount = newcol; // assume write after this call
2862 string tag_name(PAR_TAG const & pt) {
2864 case NONE: return "!-- --";
2865 case TT: return "tt";
2866 case SF: return "sf";
2867 case BF: return "bf";
2868 case IT: return "it";
2869 case SL: return "sl";
2870 case EM: return "em";
2877 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2879 p1 = static_cast<PAR_TAG>(p1 | p2);
2884 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2886 p1 = static_cast<PAR_TAG>(p1 & ~p2);
2892 // Handle internal paragraph parsing -- layout already processed.
2893 void Buffer::simpleLinuxDocOnePar(ostream & os,
2895 Paragraph::depth_type /*depth*/)
2897 LyXLayout const & style =
2898 textclasslist[params.textclass][par->layout()];
2899 string::size_type char_line_count = 5; // Heuristic choice ;-)
2901 // gets paragraph main font
2904 if (style.labeltype == LABEL_MANUAL) {
2905 font_old = style.labelfont;
2908 font_old = style.font;
2912 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2913 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2914 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2917 stack<PAR_TAG> tag_state;
2918 // parsing main loop
2919 for (pos_type i = 0; i < par->size(); ++i) {
2921 PAR_TAG tag_close = NONE;
2922 list < PAR_TAG > tag_open;
2924 LyXFont const font = par->getFont(params, i);
2926 if (font_old.family() != font.family()) {
2927 switch (family_type) {
2928 case LyXFont::SANS_FAMILY:
2931 case LyXFont::TYPEWRITER_FAMILY:
2938 family_type = font.family();
2940 switch (family_type) {
2941 case LyXFont::SANS_FAMILY:
2942 tag_open.push_back(SF);
2944 case LyXFont::TYPEWRITER_FAMILY:
2945 tag_open.push_back(TT);
2952 if (font_old.series() != font.series()) {
2953 switch (series_type) {
2954 case LyXFont::BOLD_SERIES:
2961 series_type = font.series();
2963 switch (series_type) {
2964 case LyXFont::BOLD_SERIES:
2965 tag_open.push_back(BF);
2973 if (font_old.shape() != font.shape()) {
2974 switch (shape_type) {
2975 case LyXFont::ITALIC_SHAPE:
2978 case LyXFont::SLANTED_SHAPE:
2985 shape_type = font.shape();
2987 switch (shape_type) {
2988 case LyXFont::ITALIC_SHAPE:
2989 tag_open.push_back(IT);
2991 case LyXFont::SLANTED_SHAPE:
2992 tag_open.push_back(SL);
2999 if (font_old.emph() != font.emph()) {
3000 if (font.emph() == LyXFont::ON) {
3001 tag_open.push_back(EM);
3010 list < PAR_TAG > temp;
3011 while (!tag_state.empty() && tag_close) {
3012 PAR_TAG k = tag_state.top();
3014 os << "</" << tag_name(k) << ">";
3021 for(list< PAR_TAG >::const_iterator j = temp.begin();
3022 j != temp.end(); ++j) {
3024 os << "<" << tag_name(*j) << ">";
3027 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
3028 j != tag_open.end(); ++j) {
3030 os << "<" << tag_name(*j) << ">";
3033 char c = par->getChar(i);
3035 if (c == Paragraph::META_INSET) {
3036 Inset * inset = par->getInset(i);
3037 inset->linuxdoc(this, os);
3042 if (style.latexparam() == "CDATA") {
3043 // "TeX"-Mode on == > SGML-Mode on.
3049 if (par->sgmlConvertChar(c, sgml_string)
3050 && !style.free_spacing && !par->isFreeSpacing())
3052 // in freespacing mode, spaces are
3053 // non-breaking characters
3054 if (desc_on) {// if char is ' ' then...
3057 sgmlLineBreak(os, char_line_count, 6);
3061 sgmlLineBreak(os, char_line_count, 1);
3066 char_line_count += sgml_string.length();
3072 while (!tag_state.empty()) {
3073 os << "</" << tag_name(tag_state.top()) << ">";
3077 // resets description flag correctly
3079 // <tag> not closed...
3080 sgmlLineBreak(os, char_line_count, 6);
3086 // Print an error message.
3087 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
3088 string const & /*message*/) const
3090 #warning This is wrong we cannot insert an inset like this!!!
3091 // I guess this was Jose' so I explain you more or less why this
3092 // is wrong. This way you insert something in the paragraph and
3093 // don't tell it to LyXText (row rebreaking and undo handling!!!)
3094 // I deactivate this code, have a look at BufferView::insertErrors
3095 // how you should do this correctly! (Jug 20020315)
3097 // insert an error marker in text
3098 InsetError * new_inset = new InsetError(message);
3099 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
3105 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
3107 ofstream ofs(fname.c_str());
3109 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
3113 Paragraph * par = paragraph;
3115 niceFile = nice; // this will be used by Insetincludes.
3117 LaTeXFeatures features(params);
3122 LyXTextClass const & tclass = textclasslist[params.textclass];
3123 string top_element = tclass.latexname();
3126 ofs << "<!DOCTYPE " << top_element
3127 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
3129 string preamble = params.preamble;
3130 const string name = nice ? ChangeExtension(filename_, ".sgml")
3132 preamble += features.getIncludedFiles(name);
3133 preamble += features.getLyXSGMLEntities();
3135 if (!preamble.empty()) {
3136 ofs << "\n [ " << preamble << " ]";
3141 string top = top_element;
3143 top += params.language->code();
3146 if (!params.options.empty()) {
3148 top += params.options;
3150 sgmlOpenTag(ofs, 0, top);
3152 ofs << "<!-- DocBook file was created by " << lyx_docversion
3153 << "\n See http://www.lyx.org/ for more information -->\n";
3155 vector<string> environment_stack(10);
3156 vector<string> environment_inner(10);
3157 vector<string> command_stack(10);
3159 bool command_flag = false;
3160 Paragraph::depth_type command_depth = 0;
3161 Paragraph::depth_type command_base = 0;
3162 Paragraph::depth_type cmd_depth = 0;
3163 Paragraph::depth_type depth = 0; // paragraph depth
3166 string command_name;
3172 int desc_on = 0; // description mode
3174 LyXLayout const & style = tclass[par->layout()];
3176 // environment tag closing
3177 for (; depth > par->params().depth(); --depth) {
3178 if (environment_inner[depth] != "!-- --") {
3179 item_name = "listitem";
3180 sgmlCloseTag(ofs, command_depth + depth,
3182 if (environment_inner[depth] == "varlistentry")
3183 sgmlCloseTag(ofs, depth+command_depth,
3184 environment_inner[depth]);
3186 sgmlCloseTag(ofs, depth + command_depth,
3187 environment_stack[depth]);
3188 environment_stack[depth].erase();
3189 environment_inner[depth].erase();
3192 if (depth == par->params().depth()
3193 && environment_stack[depth] != style.latexname()
3194 && !environment_stack[depth].empty()) {
3195 if (environment_inner[depth] != "!-- --") {
3196 item_name= "listitem";
3197 sgmlCloseTag(ofs, command_depth+depth,
3199 if (environment_inner[depth] == "varlistentry")
3201 depth + command_depth,
3202 environment_inner[depth]);
3205 sgmlCloseTag(ofs, depth + command_depth,
3206 environment_stack[depth]);
3208 environment_stack[depth].erase();
3209 environment_inner[depth].erase();
3212 // Write opening SGML tags.
3213 switch (style.latextype) {
3214 case LATEX_PARAGRAPH:
3215 sgmlOpenTag(ofs, depth + command_depth,
3222 _("Error : Wrong depth for "
3223 "LatexType Command.\n"));
3225 command_name = style.latexname();
3227 sgmlparam = style.latexparam();
3228 c_params = split(sgmlparam, c_depth,'|');
3230 cmd_depth = lyx::atoi(c_depth);
3233 if (cmd_depth < command_base) {
3234 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3235 sgmlCloseTag(ofs, j, command_stack[j]);
3236 command_depth = command_base = cmd_depth;
3237 } else if (cmd_depth <= command_depth) {
3238 for (int j = command_depth; j >= int(cmd_depth); --j)
3239 sgmlCloseTag(ofs, j, command_stack[j]);
3240 command_depth = cmd_depth;
3242 command_depth = cmd_depth;
3244 command_depth = command_base = cmd_depth;
3245 command_flag = true;
3247 if (command_stack.size() == command_depth + 1)
3248 command_stack.push_back(string());
3249 command_stack[command_depth] = command_name;
3251 // treat label as a special case for
3252 // more WYSIWYM handling.
3253 // This is a hack while paragraphs can't have
3254 // attributes, like id in this case.
3255 if (par->isInset(0)) {
3256 Inset * inset = par->getInset(0);
3257 Inset::Code lyx_code = inset->lyxCode();
3258 if (lyx_code == Inset::LABEL_CODE) {
3259 command_name += " id=\"";
3260 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3261 command_name += "\"";
3266 sgmlOpenTag(ofs, depth + command_depth, command_name);
3267 if (c_params.empty())
3268 item_name = "title";
3270 item_name = c_params;
3271 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3274 case LATEX_ENVIRONMENT:
3275 case LATEX_ITEM_ENVIRONMENT:
3276 if (depth < par->params().depth()) {
3277 depth = par->params().depth();
3278 environment_stack[depth].erase();
3281 if (environment_stack[depth] != style.latexname()) {
3282 if (environment_stack.size() == depth + 1) {
3283 environment_stack.push_back("!-- --");
3284 environment_inner.push_back("!-- --");
3286 environment_stack[depth] = style.latexname();
3287 environment_inner[depth] = "!-- --";
3288 sgmlOpenTag(ofs, depth + command_depth,
3289 environment_stack[depth]);
3291 if (environment_inner[depth] != "!-- --") {
3292 item_name= "listitem";
3294 command_depth + depth,
3296 if (environment_inner[depth] == "varlistentry")
3298 depth + command_depth,
3299 environment_inner[depth]);
3303 if (style.latextype == LATEX_ENVIRONMENT) {
3304 if (!style.latexparam().empty()) {
3305 if (style.latexparam() == "CDATA")
3308 sgmlOpenTag(ofs, depth + command_depth,
3309 style.latexparam());
3314 desc_on = (style.labeltype == LABEL_MANUAL);
3317 environment_inner[depth]= "varlistentry";
3319 environment_inner[depth]= "listitem";
3321 sgmlOpenTag(ofs, depth + 1 + command_depth,
3322 environment_inner[depth]);
3326 sgmlOpenTag(ofs, depth + 1 + command_depth,
3330 sgmlOpenTag(ofs, depth + 1 + command_depth,
3335 sgmlOpenTag(ofs, depth + command_depth,
3340 simpleDocBookOnePar(ofs, par, desc_on, depth+1+command_depth);
3344 // write closing SGML tags
3345 switch (style.latextype) {
3347 if (c_params.empty())
3351 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3353 case LATEX_ENVIRONMENT:
3354 if (!style.latexparam().empty()) {
3355 if (style.latexparam() == "CDATA")
3358 sgmlCloseTag(ofs, depth + command_depth,
3359 style.latexparam());
3362 case LATEX_ITEM_ENVIRONMENT:
3363 if (desc_on == 1) break;
3365 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3367 case LATEX_PARAGRAPH:
3368 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3371 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3377 for (int d = depth; d >= 0; --d) {
3378 if (!environment_stack[depth].empty()) {
3379 if (environment_inner[depth] != "!-- --") {
3380 item_name = "listitem";
3381 sgmlCloseTag(ofs, command_depth + depth,
3383 if (environment_inner[depth] == "varlistentry")
3384 sgmlCloseTag(ofs, depth + command_depth,
3385 environment_inner[depth]);
3388 sgmlCloseTag(ofs, depth + command_depth,
3389 environment_stack[depth]);
3393 for (int j = command_depth; j >= 0 ; --j)
3394 if (!command_stack[j].empty())
3395 sgmlCloseTag(ofs, j, command_stack[j]);
3398 sgmlCloseTag(ofs, 0, top_element);
3401 // How to check for successful close
3403 // we want this to be true outside previews (for insetexternal)
3408 void Buffer::simpleDocBookOnePar(ostream & os,
3409 Paragraph * par, int & desc_on,
3410 Paragraph::depth_type depth) const
3412 bool emph_flag = false;
3414 LyXLayout const & style =
3415 textclasslist[params.textclass][par->layout()];
3417 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3419 int char_line_count = depth;
3420 //if (!style.free_spacing)
3421 // os << string(depth,' ');
3423 // parsing main loop
3424 for (pos_type i = 0; i < par->size(); ++i) {
3425 LyXFont font = par->getFont(params, i);
3427 // handle <emphasis> tag
3428 if (font_old.emph() != font.emph()) {
3429 if (font.emph() == LyXFont::ON) {
3433 os << "</emphasis>";
3439 if (par->isInset(i)) {
3440 Inset * inset = par->getInset(i);
3441 // don't print the inset in position 0 if desc_on == 3 (label)
3442 if ( i || desc_on != 3) {
3443 if(style.latexparam() == "CDATA")
3445 inset->docbook(this, os);
3446 if(style.latexparam() == "CDATA")
3450 char c = par->getChar(i);
3452 par->sgmlConvertChar(c, sgml_string);
3454 if (style.pass_thru) {
3456 } else if (style.free_spacing || par->isFreeSpacing() || c != ' ') {
3458 } else if (desc_on ==1) {
3460 os << "\n</term><listitem><para>";
3470 os << "</emphasis>";
3473 // resets description flag correctly
3475 // <term> not closed...
3476 os << "</term>\n<listitem><para> </para>";
3478 if (style.free_spacing) os << '\n';
3482 // This should be enabled when the Chktex class is implemented. (Asger)
3483 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3484 // Other flags: -wall -v0 -x
3485 int Buffer::runChktex()
3487 if (!users->text) return 0;
3489 users->owner()->prohibitInput();
3491 // get LaTeX-Filename
3492 string const name = getLatexName();
3493 string path = filePath();
3495 string const org_path = path;
3496 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3500 Path p(path); // path to LaTeX file
3501 users->owner()->message(_("Running chktex..."));
3503 // Remove all error insets
3504 bool const removedErrorInsets = users->removeAutoInsets();
3506 // Generate the LaTeX file if neccessary
3507 makeLaTeXFile(name, org_path, false);
3510 Chktex chktex(lyxrc.chktex_command, name, filePath());
3511 int res = chktex.run(terr); // run chktex
3514 Alert::alert(_("chktex did not work!"),
3515 _("Could not run with file:"), name);
3516 } else if (res > 0) {
3517 // Insert all errors as errors boxes
3518 users->insertErrors(terr);
3521 // if we removed error insets before we ran chktex or if we inserted
3522 // error insets after we ran chktex, this must be run:
3523 if (removedErrorInsets || res) {
3527 users->owner()->allowInput();
3533 void Buffer::validate(LaTeXFeatures & features) const
3535 Paragraph * par = paragraph;
3536 LyXTextClass const & tclass = textclasslist[params.textclass];
3538 // AMS Style is at document level
3539 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3540 features.require("amsmath");
3543 // We don't use "lyxerr.debug" because of speed. (Asger)
3544 if (lyxerr.debugging(Debug::LATEX))
3545 lyxerr << "Paragraph: " << par << endl;
3547 // Now just follow the list of paragraphs and run
3548 // validate on each of them.
3549 par->validate(features);
3551 // and then the next paragraph
3555 // the bullet shapes are buffer level not paragraph level
3556 // so they are tested here
3557 for (int i = 0; i < 4; ++i) {
3558 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3559 int const font = params.user_defined_bullets[i].getFont();
3561 int const c = params
3562 .user_defined_bullets[i]
3569 features.require("latexsym");
3571 } else if (font == 1) {
3572 features.require("amssymb");
3573 } else if ((font >= 2 && font <= 5)) {
3574 features.require("pifont");
3579 if (lyxerr.debugging(Debug::LATEX)) {
3580 features.showStruct();
3585 // This function should be in Buffer because it's a buffer's property (ale)
3586 string const Buffer::getIncludeonlyList(char delim)
3589 for (inset_iterator it = inset_iterator_begin();
3590 it != inset_iterator_end(); ++it) {
3591 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3592 InsetInclude * insetinc =
3593 static_cast<InsetInclude *>(*it);
3594 if (insetinc->isIncludeOnly()) {
3597 lst += insetinc->getRelFileBaseName();
3601 lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3606 vector<string> const Buffer::getLabelList()
3608 /// if this is a child document and the parent is already loaded
3609 /// Use the parent's list instead [ale990407]
3610 if (!params.parentname.empty()
3611 && bufferlist.exists(params.parentname)) {
3612 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3614 return tmp->getLabelList();
3617 vector<string> label_list;
3618 for (inset_iterator it = inset_iterator_begin();
3619 it != inset_iterator_end(); ++it) {
3620 vector<string> const l = (*it)->getLabelList();
3621 label_list.insert(label_list.end(), l.begin(), l.end());
3627 Buffer::Lists const Buffer::getLists() const
3630 Paragraph * par = paragraph;
3632 LyXTextClass const & textclass = textclasslist[params.textclass];
3633 bool found = textclass.hasLayout("Caption");
3634 string const layout("Caption");
3637 char const labeltype = textclass[par->layout()].labeltype;
3639 if (labeltype >= LABEL_COUNTER_CHAPTER
3640 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3641 // insert this into the table of contents
3642 SingleList & item = l["TOC"];
3645 textclass.maxcounter());
3646 item.push_back(TocItem(par, depth, par->asString(this, true)));
3648 // For each paragrph, traverse its insets and look for
3652 Paragraph::inset_iterator it =
3653 par->inset_iterator_begin();
3654 Paragraph::inset_iterator end =
3655 par->inset_iterator_end();
3657 for (; it != end; ++it) {
3658 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3660 static_cast<InsetFloat*>(*it);
3662 string const type = il->type();
3664 // Now find the caption in the float...
3665 // We now tranverse the paragraphs of
3667 Paragraph * tmp = il->inset.paragraph();
3669 if (tmp->layout() == layout) {
3670 SingleList & item = l[type];
3672 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3673 item.push_back(TocItem(tmp, 0 , str));
3680 lyxerr << "Caption not found" << endl;
3689 // This is also a buffer property (ale)
3690 vector<pair<string, string> > const Buffer::getBibkeyList()
3692 /// if this is a child document and the parent is already loaded
3693 /// Use the parent's list instead [ale990412]
3694 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3695 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3697 return tmp->getBibkeyList();
3700 vector<pair<string, string> > keys;
3701 Paragraph * par = paragraph;
3704 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3705 par->asString(this, false)));
3709 // Might be either using bibtex or a child has bibliography
3711 for (inset_iterator it = inset_iterator_begin();
3712 it != inset_iterator_end(); ++it) {
3713 // Search for Bibtex or Include inset
3714 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3715 vector<pair<string,string> > tmp =
3716 static_cast<InsetBibtex*>(*it)->getKeys(this);
3717 keys.insert(keys.end(), tmp.begin(), tmp.end());
3718 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3719 vector<pair<string,string> > const tmp =
3720 static_cast<InsetInclude*>(*it)->getKeys();
3721 keys.insert(keys.end(), tmp.begin(), tmp.end());
3730 bool Buffer::isDepClean(string const & name) const
3732 DEPCLEAN * item = dep_clean;
3733 while (item && item->master != name)
3735 if (!item) return true;
3740 void Buffer::markDepClean(string const & name)
3743 dep_clean = new DEPCLEAN;
3744 dep_clean->clean = true;
3745 dep_clean->master = name;
3746 dep_clean->next = 0;
3748 DEPCLEAN * item = dep_clean;
3749 while (item && item->master != name)
3754 item = new DEPCLEAN;
3756 item->master = name;
3763 bool Buffer::dispatch(string const & command)
3765 // Split command string into command and argument
3767 string line = frontStrip(command);
3768 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3770 return dispatch(lyxaction.LookupFunc(cmd), arg);
3774 bool Buffer::dispatch(int action, string const & argument)
3776 bool dispatched = true;
3779 Exporter::Export(this, argument, false);
3789 void Buffer::resizeInsets(BufferView * bv)
3791 /// then remove all LyXText in text-insets
3792 Paragraph * par = paragraph;
3793 for (; par; par = par->next()) {
3794 par->resizeInsetsLyXText(bv);
3799 void Buffer::redraw()
3806 void Buffer::changeLanguage(Language const * from, Language const * to)
3809 ParIterator end = par_iterator_end();
3810 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3811 (*it)->changeLanguage(params, from, to);
3815 bool Buffer::isMultiLingual()
3817 ParIterator end = par_iterator_end();
3818 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3819 if ((*it)->isMultiLingual(params))
3826 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph, pos_type pos)
3829 it = par->InsetIterator(pos);
3830 if (it == par->inset_iterator_end()) {
3837 void Buffer::inset_iterator::setParagraph()
3840 it = par->inset_iterator_begin();
3841 if (it != par->inset_iterator_end())
3846 // We maintain an invariant that whenever par = 0 then it = 0
3850 Inset * Buffer::getInsetFromID(int id_arg) const
3852 for (inset_iterator it = inset_const_iterator_begin();
3853 it != inset_const_iterator_end(); ++it)
3855 if ((*it)->id() == id_arg)
3857 Inset * in = (*it)->getInsetFromID(id_arg);
3865 Paragraph * Buffer::getParFromID(int id) const
3867 if (id < 0) return 0;
3868 Paragraph * par = paragraph;
3870 if (par->id() == id) {
3873 Paragraph * tmp = par->getParFromID(id);
3883 ParIterator Buffer::par_iterator_begin()
3885 return ParIterator(paragraph);
3889 ParIterator Buffer::par_iterator_end()
3891 return ParIterator();