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 for(string::const_iterator cit = str.begin();
1404 cit != str.end(); ++cit) {
1406 if (par->size() || layout.keepempty) {
1407 par->breakParagraph(params, pos,
1408 layout.isEnvironment());
1411 space_inserted = true;
1415 // do not insert consecutive spaces if !free_spacing
1416 } else if ((*cit == ' ' || *cit == '\t') &&
1417 space_inserted && !layout.free_spacing &&
1418 !par->isFreeSpacing())
1421 } else if (*cit == '\t') {
1422 if (!layout.free_spacing && !par->isFreeSpacing()) {
1423 // tabs are like spaces here
1424 par->insertChar(pos, ' ', font);
1426 space_inserted = true;
1428 const pos_type nb = 8 - pos % 8;
1429 for (pos_type a = 0; a < nb ; ++a) {
1430 par->insertChar(pos, ' ', font);
1433 space_inserted = true;
1435 } else if (!IsPrintable(*cit)) {
1436 // Ignore unprintables
1439 // just insert the character
1440 par->insertChar(pos, *cit, font);
1442 space_inserted = (*cit == ' ');
1449 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1450 int & pos, LyXFont & font)
1452 // consistency check
1453 if (lex.getString() != "\\begin_inset") {
1454 lyxerr << "Buffer::readInset: Consistency check failed."
1461 string const tmptok = lex.getString();
1462 last_inset_read = tmptok;
1464 // test the different insets
1465 if (tmptok == "LatexCommand") {
1466 InsetCommandParams inscmd;
1469 string const cmdName = inscmd.getCmdName();
1471 // This strange command allows LyX to recognize "natbib" style
1472 // citations: citet, citep, Citet etc.
1473 if (compare_no_case(cmdName, "cite", 4) == 0) {
1474 inset = new InsetCitation(inscmd);
1475 } else if (cmdName == "bibitem") {
1476 lex.printError("Wrong place for bibitem");
1477 inset = new InsetBibKey(inscmd);
1478 } else if (cmdName == "BibTeX") {
1479 inset = new InsetBibtex(inscmd);
1480 } else if (cmdName == "index") {
1481 inset = new InsetIndex(inscmd);
1482 } else if (cmdName == "include") {
1483 inset = new InsetInclude(inscmd, *this);
1484 } else if (cmdName == "label") {
1485 inset = new InsetLabel(inscmd);
1486 } else if (cmdName == "url"
1487 || cmdName == "htmlurl") {
1488 inset = new InsetUrl(inscmd);
1489 } else if (cmdName == "ref"
1490 || cmdName == "pageref"
1491 || cmdName == "vref"
1492 || cmdName == "vpageref"
1493 || cmdName == "prettyref") {
1494 if (!inscmd.getOptions().empty()
1495 || !inscmd.getContents().empty()) {
1496 inset = new InsetRef(inscmd, *this);
1498 } else if (cmdName == "tableofcontents") {
1499 inset = new InsetTOC(inscmd);
1500 } else if (cmdName == "listofalgorithms") {
1501 inset = new InsetFloatList("algorithm");
1502 } else if (cmdName == "listoffigures") {
1503 inset = new InsetFloatList("figure");
1504 } else if (cmdName == "listoftables") {
1505 inset = new InsetFloatList("table");
1506 } else if (cmdName == "printindex") {
1507 inset = new InsetPrintIndex(inscmd);
1508 } else if (cmdName == "lyxparent") {
1509 inset = new InsetParent(inscmd, *this);
1512 bool alreadyread = false;
1513 if (tmptok == "Quotes") {
1514 inset = new InsetQuotes;
1515 } else if (tmptok == "External") {
1516 inset = new InsetExternal;
1517 } else if (tmptok == "FormulaMacro") {
1518 inset = new InsetFormulaMacro;
1519 } else if (tmptok == "Formula") {
1520 inset = new InsetFormula;
1521 } else if (tmptok == "Figure") { // Backward compatibility
1522 // inset = new InsetFig(100, 100, *this);
1523 inset = new InsetGraphics;
1524 } else if (tmptok == "Graphics") {
1525 inset = new InsetGraphics;
1526 } else if (tmptok == "Info") {// backwards compatibility
1527 inset = new InsetNote(this,
1528 lex.getLongString("\\end_inset"),
1531 } else if (tmptok == "Note") {
1532 inset = new InsetNote(params);
1533 } else if (tmptok == "Include") {
1534 InsetCommandParams p("Include");
1535 inset = new InsetInclude(p, *this);
1536 } else if (tmptok == "ERT") {
1537 inset = new InsetERT(params);
1538 } else if (tmptok == "Tabular") {
1539 inset = new InsetTabular(*this);
1540 } else if (tmptok == "Text") {
1541 inset = new InsetText(params);
1542 } else if (tmptok == "Foot") {
1543 inset = new InsetFoot(params);
1544 } else if (tmptok == "Marginal") {
1545 inset = new InsetMarginal(params);
1546 } else if (tmptok == "Minipage") {
1547 inset = new InsetMinipage(params);
1548 } else if (tmptok == "Float") {
1550 string tmptok = lex.getString();
1551 inset = new InsetFloat(params, tmptok);
1553 } else if (tmptok == "List") {
1554 inset = new InsetList;
1555 } else if (tmptok == "Theorem") {
1556 inset = new InsetList;
1558 } else if (tmptok == "Caption") {
1559 inset = new InsetCaption(params);
1560 } else if (tmptok == "FloatList") {
1561 inset = new InsetFloatList;
1564 if (inset && !alreadyread) inset->read(this, lex);
1568 par->insertInset(pos, inset, font);
1574 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1578 string const token(lex.getString());
1579 if (token == "\\lyxformat") { // the first token _must_ be...
1581 string tmp_format = lex.getString();
1582 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1583 // if present remove ".," from string.
1584 string::size_type dot = tmp_format.find_first_of(".,");
1585 //lyxerr << " dot found at " << dot << endl;
1586 if (dot != string::npos)
1587 tmp_format.erase(dot, 1);
1588 file_format = strToInt(tmp_format);
1589 if (file_format == LYX_FORMAT) {
1591 } else if (file_format > LYX_FORMAT) {
1593 Alert::alert(_("Warning!"),
1594 _("LyX file format is newer that what"),
1595 _("is supported in this LyX version. Expect some problems."));
1597 } else if (file_format < LYX_FORMAT) {
1599 if (file_format < 200) {
1600 Alert::alert(_("ERROR!"),
1601 _("Old LyX file format found. "
1602 "Use LyX 0.10.x to read this!"));
1606 bool the_end = readLyXformat2(lex, par);
1607 params.setPaperStuff();
1608 // the_end was added in 213
1609 if (file_format < 213)
1613 Alert::alert(_("Warning!"),
1614 _("Reading of document is not complete"),
1615 _("Maybe the document is truncated"));
1618 } else { // "\\lyxformat" not found
1619 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1622 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1627 // Should probably be moved to somewhere else: BufferView? LyXView?
1628 bool Buffer::save() const
1630 // We don't need autosaves in the immediate future. (Asger)
1631 resetAutosaveTimers();
1635 if (lyxrc.make_backup) {
1636 s = fileName() + '~';
1637 if (!lyxrc.backupdir_path.empty())
1638 s = AddName(lyxrc.backupdir_path,
1639 subst(os::slashify_path(s),'/','!'));
1641 // Rename is the wrong way of making a backup,
1642 // this is the correct way.
1643 /* truss cp fil fil2:
1644 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1645 stat("LyXVC.lyx", 0xEFFFF688) = 0
1646 open("LyXVC.lyx", O_RDONLY) = 3
1647 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1648 fstat(4, 0xEFFFF508) = 0
1649 fstat(3, 0xEFFFF508) = 0
1650 read(3, " # T h i s f i l e w".., 8192) = 5579
1651 write(4, " # T h i s f i l e w".., 5579) = 5579
1652 read(3, 0xEFFFD4A0, 8192) = 0
1655 chmod("LyXVC3.lyx", 0100644) = 0
1656 lseek(0, 0, SEEK_CUR) = 46440
1660 // Should probably have some more error checking here.
1661 // Should be cleaned up in 0.13, at least a bit.
1662 // Doing it this way, also makes the inodes stay the same.
1663 // This is still not a very good solution, in particular we
1664 // might loose the owner of the backup.
1665 FileInfo finfo(fileName());
1666 if (finfo.exist()) {
1667 mode_t fmode = finfo.getMode();
1668 struct utimbuf times = {
1669 finfo.getAccessTime(),
1670 finfo.getModificationTime() };
1672 ifstream ifs(fileName().c_str());
1673 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1678 ::chmod(s.c_str(), fmode);
1680 if (::utime(s.c_str(), ×)) {
1681 lyxerr << "utime error." << endl;
1684 lyxerr << "LyX was not able to make "
1685 "backup copy. Beware." << endl;
1690 if (writeFile(fileName(), false)) {
1692 removeAutosaveFile(fileName());
1694 // Saving failed, so backup is not backup
1695 if (lyxrc.make_backup) {
1696 lyx::rename(s, fileName());
1704 // Returns false if unsuccesful
1705 bool Buffer::writeFile(string const & fname, bool flag) const
1707 // if flag is false writeFile will not create any GUI
1708 // warnings, only cerr.
1709 // Needed for autosave in background or panic save (Matthias 120496)
1711 if (read_only && (fname == fileName())) {
1712 // Here we should come with a question if we should
1713 // perform the write anyway.
1715 lyxerr << _("Error! Document is read-only: ")
1718 Alert::alert(_("Error! Document is read-only: "),
1723 FileInfo finfo(fname);
1724 if (finfo.exist() && !finfo.writable()) {
1725 // Here we should come with a question if we should
1726 // try to do the save anyway. (i.e. do a chmod first)
1728 lyxerr << _("Error! Cannot write file: ")
1731 Alert::err_alert(_("Error! Cannot write file: "),
1736 ofstream ofs(fname.c_str());
1739 lyxerr << _("Error! Cannot open file: ")
1742 Alert::err_alert(_("Error! Cannot open file: "),
1748 // Use the standard "C" locale for file output.
1749 ofs.imbue(std::locale::classic());
1752 // The top of the file should not be written by params.
1754 // write out a comment in the top of the file
1755 ofs << '#' << lyx_docversion
1756 << " created this file. For more info see http://www.lyx.org/\n"
1757 << "\\lyxformat " << LYX_FORMAT << "\n";
1759 // now write out the buffer paramters.
1760 params.writeFile(ofs);
1762 Paragraph::depth_type depth = 0;
1764 // this will write out all the paragraphs
1765 // using recursive descent.
1766 paragraph->writeFile(this, ofs, params, depth);
1768 // Write marker that shows file is complete
1769 ofs << "\n\\the_end" << endl;
1773 // how to check if close went ok?
1774 // Following is an attempt... (BE 20001011)
1776 // good() returns false if any error occured, including some
1777 // formatting error.
1778 // bad() returns true if something bad happened in the buffer,
1779 // which should include file system full errors.
1786 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1788 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1800 pair<int, string> const addDepth(int depth, int ldepth)
1804 d += (ldepth - depth) * 2;
1805 return make_pair(d, string(d, ' '));
1811 string const Buffer::asciiParagraph(Paragraph const * par,
1812 unsigned int linelen,
1813 bool noparbreak) const
1815 ostringstream buffer;
1816 Paragraph::depth_type depth = 0;
1818 Paragraph::depth_type ltype_depth = 0;
1819 bool ref_printed = false;
1820 // if (!par->previous()) {
1822 // begins or ends a deeper area ?
1823 if (depth != par->params().depth()) {
1824 if (par->params().depth() > depth) {
1825 while (par->params().depth() > depth) {
1829 while (par->params().depth() < depth) {
1835 depth = par->params().depth();
1838 // First write the layout
1839 string const & tmp = par->layout();
1840 if (compare_no_case(tmp, "itemize") == 0) {
1842 ltype_depth = depth + 1;
1843 } else if (compare_no_case(tmp, "enumerate") == 0) {
1845 ltype_depth = depth + 1;
1846 } else if (contains(lowercase(tmp), "ection")) {
1848 ltype_depth = depth + 1;
1849 } else if (contains(lowercase(tmp), "aragraph")) {
1851 ltype_depth = depth + 1;
1852 } else if (compare_no_case(tmp, "description") == 0) {
1854 ltype_depth = depth + 1;
1855 } else if (compare_no_case(tmp, "abstract") == 0) {
1858 } else if (compare_no_case(tmp, "bibliography") == 0) {
1866 /* maybe some vertical spaces */
1868 /* the labelwidthstring used in lists */
1872 /* some pagebreaks? */
1876 /* what about the alignment */
1878 // lyxerr << "Should this ever happen?" << endl;
1881 // linelen <= 0 is special and means we don't have pargraph breaks
1883 string::size_type currlinelen = 0;
1889 buffer << string(depth * 2, ' ');
1890 currlinelen += depth * 2;
1893 // we should probably change to the paragraph language in the
1894 // gettext here (if possible) so that strings are outputted in
1895 // the correct language! (20012712 Jug)
1899 case 4: // (Sub)Paragraph
1900 case 5: // Description
1904 buffer << _("Abstract") << "\n\n";
1907 string const abst = _("Abstract: ");
1909 currlinelen += abst.length();
1912 case 7: // Bibliography
1915 buffer << _("References") << "\n\n";
1918 string const refs = _("References: ");
1920 currlinelen += refs.length();
1928 string const parlab = par->params().labelString();
1929 buffer << parlab << " ";
1930 currlinelen += parlab.length() + 1;
1938 pair<int, string> p = addDepth(depth, ltype_depth);
1940 currlinelen += p.first;
1943 // this is to change the linebreak to do it by word a bit more
1944 // intelligent hopefully! (only in the case where we have a
1945 // max linelenght!) (Jug)
1949 for (pos_type i = 0; i < par->size(); ++i) {
1950 char c = par->getUChar(params, i);
1952 case Paragraph::META_INSET:
1954 Inset const * inset = par->getInset(i);
1958 currlinelen += word.length();
1961 if (inset->ascii(this, buffer, linelen)) {
1962 // to be sure it breaks paragraph
1963 currlinelen += linelen;
1969 case Paragraph::META_NEWLINE:
1971 buffer << word << "\n";
1974 pair<int, string> p = addDepth(depth,
1977 currlinelen = p.first;
1981 case Paragraph::META_HFILL:
1982 buffer << word << "\t";
1983 currlinelen += word.length() + 1;
1990 currlinelen + word.length() > linelen - 10) {
1992 pair<int, string> p =
1993 addDepth(depth, ltype_depth);
1995 currlinelen = p.first;
1998 buffer << word << ' ';
1999 currlinelen += word.length() + 1;
2006 lyxerr[Debug::INFO] <<
2007 "writeAsciiFile: NULL char in structure." << endl;
2009 if ((linelen > 0) &&
2010 (currlinelen + word.length()) > linelen)
2014 pair<int, string> p =
2015 addDepth(depth, ltype_depth);
2017 currlinelen = p.first;
2024 return buffer.str().c_str();
2028 void Buffer::writeFileAscii(string const & fname, int linelen)
2030 ofstream ofs(fname.c_str());
2032 Alert::err_alert(_("Error: Cannot write file:"), fname);
2035 writeFileAscii(ofs, linelen);
2039 void Buffer::writeFileAscii(ostream & ofs, int linelen)
2041 Paragraph * par = paragraph;
2043 ofs << asciiParagraph(par, linelen, par->previous() == 0);
2053 void Buffer::makeLaTeXFile(string const & fname,
2054 string const & original_path,
2055 bool nice, bool only_body)
2057 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
2059 ofstream ofs(fname.c_str());
2061 Alert::err_alert(_("Error: Cannot open file: "), fname);
2065 niceFile = nice; // this will be used by Insetincludes.
2067 tex_code_break_column = lyxrc.ascii_linelen;
2069 // validate the buffer.
2070 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
2071 LaTeXFeatures features(params);
2073 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
2076 // The starting paragraph of the coming rows is the
2077 // first paragraph of the document. (Asger)
2078 texrow.start(paragraph, 0);
2080 if (!only_body && nice) {
2081 ofs << "%% " << lyx_docversion << " created this file. "
2082 "For more info, see http://www.lyx.org/.\n"
2083 "%% Do not edit unless you really know what "
2088 lyxerr[Debug::INFO] << "lyx header finished" << endl;
2089 // There are a few differences between nice LaTeX and usual files:
2090 // usual is \batchmode and has a
2091 // special input@path to allow the including of figures
2092 // with either \input or \includegraphics (what figinsets do).
2093 // batchmode is not set if there is a tex_code_break_column.
2094 // In this case somebody is interested in the generated LaTeX,
2095 // so this is OK. input@path is set when the actual parameter
2096 // original_path is set. This is done for usual tex-file, but not
2097 // for nice-latex-file. (Matthias 250696)
2100 // code for usual, NOT nice-latex-file
2101 ofs << "\\batchmode\n"; // changed
2102 // from \nonstopmode
2105 if (!original_path.empty()) {
2106 string inputpath = os::external_path(original_path);
2107 subst(inputpath, "~", "\\string~");
2108 ofs << "\\makeatletter\n"
2109 << "\\def\\input@path{{"
2110 << inputpath << "/}}\n"
2111 << "\\makeatother\n";
2117 ofs << "\\documentclass";
2119 LyXTextClass const & tclass = textclasslist[params.textclass];
2121 ostringstream options; // the document class options.
2123 if (tokenPos(tclass.opt_fontsize(),
2124 '|', params.fontsize) >= 0) {
2125 // only write if existing in list (and not default)
2126 options << params.fontsize << "pt,";
2130 if (!params.use_geometry &&
2131 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2132 switch (params.papersize) {
2133 case BufferParams::PAPER_A4PAPER:
2134 options << "a4paper,";
2136 case BufferParams::PAPER_USLETTER:
2137 options << "letterpaper,";
2139 case BufferParams::PAPER_A5PAPER:
2140 options << "a5paper,";
2142 case BufferParams::PAPER_B5PAPER:
2143 options << "b5paper,";
2145 case BufferParams::PAPER_EXECUTIVEPAPER:
2146 options << "executivepaper,";
2148 case BufferParams::PAPER_LEGALPAPER:
2149 options << "legalpaper,";
2155 if (params.sides != tclass.sides()) {
2156 switch (params.sides) {
2157 case LyXTextClass::OneSide:
2158 options << "oneside,";
2160 case LyXTextClass::TwoSides:
2161 options << "twoside,";
2167 if (params.columns != tclass.columns()) {
2168 if (params.columns == 2)
2169 options << "twocolumn,";
2171 options << "onecolumn,";
2174 if (!params.use_geometry
2175 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2176 options << "landscape,";
2178 // language should be a parameter to \documentclass
2180 ostringstream language_options;
2181 if (params.language->babel() == "hebrew"
2182 && default_language->babel() != "hebrew")
2183 // This seems necessary
2184 features.useLanguage(default_language);
2186 if (lyxrc.language_use_babel ||
2187 params.language->lang() != lyxrc.default_language ||
2188 !features.hasLanguages()) {
2190 language_options << features.getLanguages();
2191 language_options << params.language->babel();
2192 if (lyxrc.language_global_options)
2193 options << language_options.str() << ',';
2196 // the user-defined options
2197 if (!params.options.empty()) {
2198 options << params.options << ',';
2201 string strOptions(options.str().c_str());
2202 if (!strOptions.empty()) {
2203 strOptions = strip(strOptions, ',');
2204 ofs << '[' << strOptions << ']';
2207 ofs << '{' << tclass.latexname() << "}\n";
2209 // end of \documentclass defs
2211 // font selection must be done before loading fontenc.sty
2212 // The ae package is not needed when using OT1 font encoding.
2213 if (params.fonts != "default" &&
2214 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2215 ofs << "\\usepackage{" << params.fonts << "}\n";
2217 if (params.fonts == "ae") {
2218 ofs << "\\usepackage{aecompl}\n";
2222 // this one is not per buffer
2223 if (lyxrc.fontenc != "default") {
2224 ofs << "\\usepackage[" << lyxrc.fontenc
2229 if (params.inputenc == "auto") {
2230 string const doc_encoding =
2231 params.language->encoding()->LatexName();
2233 // Create a list with all the input encodings used
2235 set<string> encodings = features.getEncodingSet(doc_encoding);
2237 ofs << "\\usepackage[";
2238 std::copy(encodings.begin(), encodings.end(),
2239 std::ostream_iterator<string>(ofs, ","));
2240 ofs << doc_encoding << "]{inputenc}\n";
2242 } else if (params.inputenc != "default") {
2243 ofs << "\\usepackage[" << params.inputenc
2248 // At the very beginning the text parameters.
2249 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2250 switch (params.paperpackage) {
2251 case BufferParams::PACKAGE_A4:
2252 ofs << "\\usepackage{a4}\n";
2255 case BufferParams::PACKAGE_A4WIDE:
2256 ofs << "\\usepackage{a4wide}\n";
2259 case BufferParams::PACKAGE_WIDEMARGINSA4:
2260 ofs << "\\usepackage[widemargins]{a4}\n";
2265 if (params.use_geometry) {
2266 ofs << "\\usepackage{geometry}\n";
2268 ofs << "\\geometry{verbose";
2269 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2270 ofs << ",landscape";
2271 switch (params.papersize2) {
2272 case BufferParams::VM_PAPER_CUSTOM:
2273 if (!params.paperwidth.empty())
2274 ofs << ",paperwidth="
2275 << params.paperwidth;
2276 if (!params.paperheight.empty())
2277 ofs << ",paperheight="
2278 << params.paperheight;
2280 case BufferParams::VM_PAPER_USLETTER:
2281 ofs << ",letterpaper";
2283 case BufferParams::VM_PAPER_USLEGAL:
2284 ofs << ",legalpaper";
2286 case BufferParams::VM_PAPER_USEXECUTIVE:
2287 ofs << ",executivepaper";
2289 case BufferParams::VM_PAPER_A3:
2292 case BufferParams::VM_PAPER_A4:
2295 case BufferParams::VM_PAPER_A5:
2298 case BufferParams::VM_PAPER_B3:
2301 case BufferParams::VM_PAPER_B4:
2304 case BufferParams::VM_PAPER_B5:
2308 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2309 switch (lyxrc.default_papersize) {
2310 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2311 case BufferParams::PAPER_USLETTER:
2312 ofs << ",letterpaper";
2314 case BufferParams::PAPER_LEGALPAPER:
2315 ofs << ",legalpaper";
2317 case BufferParams::PAPER_EXECUTIVEPAPER:
2318 ofs << ",executivepaper";
2320 case BufferParams::PAPER_A3PAPER:
2323 case BufferParams::PAPER_A4PAPER:
2326 case BufferParams::PAPER_A5PAPER:
2329 case BufferParams::PAPER_B5PAPER:
2334 if (!params.topmargin.empty())
2335 ofs << ",tmargin=" << params.topmargin;
2336 if (!params.bottommargin.empty())
2337 ofs << ",bmargin=" << params.bottommargin;
2338 if (!params.leftmargin.empty())
2339 ofs << ",lmargin=" << params.leftmargin;
2340 if (!params.rightmargin.empty())
2341 ofs << ",rmargin=" << params.rightmargin;
2342 if (!params.headheight.empty())
2343 ofs << ",headheight=" << params.headheight;
2344 if (!params.headsep.empty())
2345 ofs << ",headsep=" << params.headsep;
2346 if (!params.footskip.empty())
2347 ofs << ",footskip=" << params.footskip;
2352 if (tokenPos(tclass.opt_pagestyle(),
2353 '|', params.pagestyle) >= 0) {
2354 if (params.pagestyle == "fancy") {
2355 ofs << "\\usepackage{fancyhdr}\n";
2358 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2362 if (params.secnumdepth != tclass.secnumdepth()) {
2363 ofs << "\\setcounter{secnumdepth}{"
2364 << params.secnumdepth
2368 if (params.tocdepth != tclass.tocdepth()) {
2369 ofs << "\\setcounter{tocdepth}{"
2375 if (params.paragraph_separation) {
2376 switch (params.defskip.kind()) {
2377 case VSpace::SMALLSKIP:
2378 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2380 case VSpace::MEDSKIP:
2381 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2383 case VSpace::BIGSKIP:
2384 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2386 case VSpace::LENGTH:
2387 ofs << "\\setlength\\parskip{"
2388 << params.defskip.length().asLatexString()
2391 default: // should never happen // Then delete it.
2392 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2397 ofs << "\\setlength\\parindent{0pt}\n";
2401 // Now insert the LyX specific LaTeX commands...
2403 // The optional packages;
2404 string preamble(features.getPackages());
2406 // this might be useful...
2407 preamble += "\n\\makeatletter\n";
2409 // Some macros LyX will need
2410 string tmppreamble(features.getMacros());
2412 if (!tmppreamble.empty()) {
2413 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2414 "LyX specific LaTeX commands.\n"
2415 + tmppreamble + '\n';
2418 // the text class specific preamble
2419 tmppreamble = features.getTClassPreamble();
2420 if (!tmppreamble.empty()) {
2421 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2422 "Textclass specific LaTeX commands.\n"
2423 + tmppreamble + '\n';
2426 /* the user-defined preamble */
2427 if (!params.preamble.empty()) {
2428 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2429 "User specified LaTeX commands.\n"
2430 + params.preamble + '\n';
2433 preamble += "\\makeatother\n";
2435 // Itemize bullet settings need to be last in case the user
2436 // defines their own bullets that use a package included
2437 // in the user-defined preamble -- ARRae
2438 // Actually it has to be done much later than that
2439 // since some packages like frenchb make modifications
2440 // at \begin{document} time -- JMarc
2442 for (int i = 0; i < 4; ++i) {
2443 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2444 if (bullets_def.empty())
2445 bullets_def="\\AtBeginDocument{\n";
2446 bullets_def += " \\renewcommand{\\labelitemi";
2448 // `i' is one less than the item to modify
2455 bullets_def += "ii";
2461 bullets_def += "}{" +
2462 params.user_defined_bullets[i].getText()
2467 if (!bullets_def.empty())
2468 preamble += bullets_def + "}\n\n";
2471 int(lyx::count(preamble.begin(), preamble.end(), '\n'));
2472 for (int j = 0; j != nlines; ++j) {
2478 // We try to load babel late, in case it interferes
2479 // with other packages.
2481 string tmp = lyxrc.language_package;
2482 if (!lyxrc.language_global_options
2483 && tmp == "\\usepackage{babel}")
2484 tmp = string("\\usepackage[") +
2485 language_options.str().c_str() +
2492 ofs << "\\begin{document}\n";
2495 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2497 if (!lyxrc.language_auto_begin) {
2498 ofs << subst(lyxrc.language_command_begin, "$$lang",
2499 params.language->babel())
2504 latexParagraphs(ofs, paragraph, 0, texrow);
2506 // add this just in case after all the paragraphs
2510 if (!lyxrc.language_auto_end) {
2511 ofs << subst(lyxrc.language_command_end, "$$lang",
2512 params.language->babel())
2518 ofs << "\\end{document}\n";
2521 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2523 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2527 // Just to be sure. (Asger)
2530 // tex_code_break_column's value is used to decide
2531 // if we are in batchmode or not (within mathed_write()
2532 // in math_write.C) so we must set it to a non-zero
2533 // value when we leave otherwise we save incorrect .lyx files.
2534 tex_code_break_column = lyxrc.ascii_linelen;
2538 lyxerr << "File was not closed properly." << endl;
2541 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2542 lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2544 // we want this to be true outside previews (for insetexternal)
2550 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2552 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2553 Paragraph * endpar, TexRow & texrow) const
2555 bool was_title = false;
2556 bool already_title = false;
2559 while (par != endpar) {
2560 Inset * in = par->inInset();
2561 // well we have to check if we are in an inset with unlimited
2562 // lenght (all in one row) if that is true then we don't allow
2563 // any special options in the paragraph and also we don't allow
2564 // any environment other then "Standard" to be valid!
2565 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
2566 LyXLayout const & layout =
2567 textclasslist[params.textclass][par->layout()];
2569 if (layout.intitle) {
2570 if (already_title) {
2571 lyxerr <<"Error in latexParagraphs: You"
2572 " should not mix title layouts"
2573 " with normal ones." << endl;
2576 } else if (was_title && !already_title) {
2577 ofs << "\\maketitle\n";
2579 already_title = true;
2583 if (layout.isEnvironment()) {
2584 par = par->TeXEnvironment(this, params, ofs, texrow);
2586 par = par->TeXOnePar(this, params, ofs, texrow, false);
2589 par = par->TeXOnePar(this, params, ofs, texrow, false);
2592 // It might be that we only have a title in this document
2593 if (was_title && !already_title) {
2594 ofs << "\\maketitle\n";
2600 bool Buffer::isLatex() const
2602 return textclasslist[params.textclass].outputType() == LATEX;
2606 bool Buffer::isLinuxDoc() const
2608 return textclasslist[params.textclass].outputType() == LINUXDOC;
2612 bool Buffer::isLiterate() const
2614 return textclasslist[params.textclass].outputType() == LITERATE;
2618 bool Buffer::isDocBook() const
2620 return textclasslist[params.textclass].outputType() == DOCBOOK;
2624 bool Buffer::isSGML() const
2626 LyXTextClass const & tclass = textclasslist[params.textclass];
2628 return tclass.outputType() == LINUXDOC ||
2629 tclass.outputType() == DOCBOOK;
2633 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type,
2634 string const & latexname) const
2636 if (!latexname.empty() && latexname != "!-- --")
2637 //os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2638 os << "<" << latexname << ">";
2642 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type,
2643 string const & latexname) const
2645 if (!latexname.empty() && latexname != "!-- --")
2646 //os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2647 os << "</" << latexname << ">";
2651 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2653 ofstream ofs(fname.c_str());
2656 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2660 niceFile = nice; // this will be used by included files.
2662 LaTeXFeatures features(params);
2668 LyXTextClass const & tclass = textclasslist[params.textclass];
2670 string top_element = tclass.latexname();
2673 ofs << "<!doctype linuxdoc system";
2675 string preamble = params.preamble;
2676 const string name = nice ? ChangeExtension(filename_, ".sgml")
2678 preamble += features.getIncludedFiles(name);
2679 preamble += features.getLyXSGMLEntities();
2681 if (!preamble.empty()) {
2682 ofs << " [ " << preamble << " ]";
2686 if (params.options.empty())
2687 sgmlOpenTag(ofs, 0, top_element);
2689 string top = top_element;
2691 top += params.options;
2692 sgmlOpenTag(ofs, 0, top);
2696 ofs << "<!-- " << lyx_docversion
2697 << " created this file. For more info see http://www.lyx.org/"
2700 Paragraph::depth_type depth = 0; // paragraph depth
2701 Paragraph * par = paragraph;
2703 vector<string> environment_stack(5);
2706 LyXLayout const & style = tclass[par->layout()];
2708 // treat <toc> as a special case for compatibility with old code
2709 if (par->isInset(0)) {
2710 Inset * inset = par->getInset(0);
2711 Inset::Code lyx_code = inset->lyxCode();
2712 if (lyx_code == Inset::TOC_CODE) {
2713 string const temp = "toc";
2714 sgmlOpenTag(ofs, depth, temp);
2721 // environment tag closing
2722 for (; depth > par->params().depth(); --depth) {
2723 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2724 environment_stack[depth].erase();
2727 // write opening SGML tags
2728 switch (style.latextype) {
2729 case LATEX_PARAGRAPH:
2730 if (depth == par->params().depth()
2731 && !environment_stack[depth].empty()) {
2732 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2733 environment_stack[depth].erase();
2739 sgmlOpenTag(ofs, depth, style.latexname());
2745 _("Error : Wrong depth for"
2746 " LatexType Command.\n"));
2748 if (!environment_stack[depth].empty()) {
2749 sgmlCloseTag(ofs, depth,
2750 environment_stack[depth]);
2754 environment_stack[depth].erase();
2755 sgmlOpenTag(ofs, depth, style.latexname());
2758 case LATEX_ENVIRONMENT:
2759 case LATEX_ITEM_ENVIRONMENT:
2760 if (depth == par->params().depth()
2761 && environment_stack[depth] != style.latexname()) {
2762 sgmlCloseTag(ofs, depth,
2763 environment_stack[depth]);
2764 environment_stack[depth].erase();
2766 if (depth < par->params().depth()) {
2767 depth = par->params().depth();
2768 environment_stack[depth].erase();
2770 if (environment_stack[depth] != style.latexname()) {
2772 sgmlOpenTag(ofs, depth, "p");
2774 sgmlOpenTag(ofs, depth, style.latexname());
2776 if (environment_stack.size() == depth + 1)
2777 environment_stack.push_back("!-- --");
2778 environment_stack[depth] = style.latexname();
2781 if (style.latexparam() == "CDATA")
2784 if (style.latextype == LATEX_ENVIRONMENT) break;
2786 if (style.labeltype == LABEL_MANUAL)
2791 sgmlOpenTag(ofs, depth + 1, item_name);
2794 sgmlOpenTag(ofs, depth, style.latexname());
2798 simpleLinuxDocOnePar(ofs, par, depth);
2803 // write closing SGML tags
2804 switch (style.latextype) {
2807 case LATEX_ENVIRONMENT:
2808 case LATEX_ITEM_ENVIRONMENT:
2809 if (style.latexparam() == "CDATA")
2813 sgmlCloseTag(ofs, depth, style.latexname());
2819 for (int i=depth; i >= 0; --i)
2820 sgmlCloseTag(ofs, depth, environment_stack[i]);
2824 sgmlCloseTag(ofs, 0, top_element);
2828 // How to check for successful close
2830 // we want this to be true outside previews (for insetexternal)
2835 // checks, if newcol chars should be put into this line
2836 // writes newline, if necessary.
2839 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2840 string::size_type newcol)
2843 if (colcount > lyxrc.ascii_linelen) {
2845 colcount = newcol; // assume write after this call
2860 string tag_name(PAR_TAG const & pt) {
2862 case NONE: return "!-- --";
2863 case TT: return "tt";
2864 case SF: return "sf";
2865 case BF: return "bf";
2866 case IT: return "it";
2867 case SL: return "sl";
2868 case EM: return "em";
2875 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2877 p1 = static_cast<PAR_TAG>(p1 | p2);
2882 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2884 p1 = static_cast<PAR_TAG>(p1 & ~p2);
2890 // Handle internal paragraph parsing -- layout already processed.
2891 void Buffer::simpleLinuxDocOnePar(ostream & os,
2893 Paragraph::depth_type /*depth*/)
2895 LyXLayout const & style =
2896 textclasslist[params.textclass][par->layout()];
2897 string::size_type char_line_count = 5; // Heuristic choice ;-)
2899 // gets paragraph main font
2902 if (style.labeltype == LABEL_MANUAL) {
2903 font_old = style.labelfont;
2906 font_old = style.font;
2910 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2911 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2912 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2915 stack<PAR_TAG> tag_state;
2916 // parsing main loop
2917 for (pos_type i = 0; i < par->size(); ++i) {
2919 PAR_TAG tag_close = NONE;
2920 list < PAR_TAG > tag_open;
2922 LyXFont const font = par->getFont(params, i);
2924 if (font_old.family() != font.family()) {
2925 switch (family_type) {
2926 case LyXFont::SANS_FAMILY:
2929 case LyXFont::TYPEWRITER_FAMILY:
2936 family_type = font.family();
2938 switch (family_type) {
2939 case LyXFont::SANS_FAMILY:
2940 tag_open.push_back(SF);
2942 case LyXFont::TYPEWRITER_FAMILY:
2943 tag_open.push_back(TT);
2950 if (font_old.series() != font.series()) {
2951 switch (series_type) {
2952 case LyXFont::BOLD_SERIES:
2959 series_type = font.series();
2961 switch (series_type) {
2962 case LyXFont::BOLD_SERIES:
2963 tag_open.push_back(BF);
2971 if (font_old.shape() != font.shape()) {
2972 switch (shape_type) {
2973 case LyXFont::ITALIC_SHAPE:
2976 case LyXFont::SLANTED_SHAPE:
2983 shape_type = font.shape();
2985 switch (shape_type) {
2986 case LyXFont::ITALIC_SHAPE:
2987 tag_open.push_back(IT);
2989 case LyXFont::SLANTED_SHAPE:
2990 tag_open.push_back(SL);
2997 if (font_old.emph() != font.emph()) {
2998 if (font.emph() == LyXFont::ON) {
2999 tag_open.push_back(EM);
3008 list < PAR_TAG > temp;
3009 while (!tag_state.empty() && tag_close) {
3010 PAR_TAG k = tag_state.top();
3012 os << "</" << tag_name(k) << ">";
3019 for(list< PAR_TAG >::const_iterator j = temp.begin();
3020 j != temp.end(); ++j) {
3022 os << "<" << tag_name(*j) << ">";
3025 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
3026 j != tag_open.end(); ++j) {
3028 os << "<" << tag_name(*j) << ">";
3031 char c = par->getChar(i);
3033 if (c == Paragraph::META_INSET) {
3034 Inset * inset = par->getInset(i);
3035 inset->linuxdoc(this, os);
3040 if (style.latexparam() == "CDATA") {
3041 // "TeX"-Mode on == > SGML-Mode on.
3047 if (par->sgmlConvertChar(c, sgml_string)
3048 && !style.free_spacing && !par->isFreeSpacing())
3050 // in freespacing mode, spaces are
3051 // non-breaking characters
3052 if (desc_on) {// if char is ' ' then...
3055 sgmlLineBreak(os, char_line_count, 6);
3059 sgmlLineBreak(os, char_line_count, 1);
3064 char_line_count += sgml_string.length();
3070 while (!tag_state.empty()) {
3071 os << "</" << tag_name(tag_state.top()) << ">";
3075 // resets description flag correctly
3077 // <tag> not closed...
3078 sgmlLineBreak(os, char_line_count, 6);
3084 // Print an error message.
3085 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
3086 string const & /*message*/) const
3088 #warning This is wrong we cannot insert an inset like this!!!
3089 // I guess this was Jose' so I explain you more or less why this
3090 // is wrong. This way you insert something in the paragraph and
3091 // don't tell it to LyXText (row rebreaking and undo handling!!!)
3092 // I deactivate this code, have a look at BufferView::insertErrors
3093 // how you should do this correctly! (Jug 20020315)
3095 // insert an error marker in text
3096 InsetError * new_inset = new InsetError(message);
3097 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
3103 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
3105 ofstream ofs(fname.c_str());
3107 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
3111 Paragraph * par = paragraph;
3113 niceFile = nice; // this will be used by Insetincludes.
3115 LaTeXFeatures features(params);
3120 LyXTextClass const & tclass = textclasslist[params.textclass];
3121 string top_element = tclass.latexname();
3124 ofs << "<!DOCTYPE " << top_element
3125 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
3127 string preamble = params.preamble;
3128 const string name = nice ? ChangeExtension(filename_, ".sgml")
3130 preamble += features.getIncludedFiles(name);
3131 preamble += features.getLyXSGMLEntities();
3133 if (!preamble.empty()) {
3134 ofs << "\n [ " << preamble << " ]";
3139 string top = top_element;
3141 top += params.language->code();
3144 if (!params.options.empty()) {
3146 top += params.options;
3148 sgmlOpenTag(ofs, 0, top);
3150 ofs << "<!-- DocBook file was created by " << lyx_docversion
3151 << "\n See http://www.lyx.org/ for more information -->\n";
3153 vector<string> environment_stack(10);
3154 vector<string> environment_inner(10);
3155 vector<string> command_stack(10);
3157 bool command_flag = false;
3158 Paragraph::depth_type command_depth = 0;
3159 Paragraph::depth_type command_base = 0;
3160 Paragraph::depth_type cmd_depth = 0;
3161 Paragraph::depth_type depth = 0; // paragraph depth
3164 string command_name;
3170 int desc_on = 0; // description mode
3172 LyXLayout const & style = tclass[par->layout()];
3174 // environment tag closing
3175 for (; depth > par->params().depth(); --depth) {
3176 if (environment_inner[depth] != "!-- --") {
3177 item_name = "listitem";
3178 sgmlCloseTag(ofs, command_depth + depth,
3180 if (environment_inner[depth] == "varlistentry")
3181 sgmlCloseTag(ofs, depth+command_depth,
3182 environment_inner[depth]);
3184 sgmlCloseTag(ofs, depth + command_depth,
3185 environment_stack[depth]);
3186 environment_stack[depth].erase();
3187 environment_inner[depth].erase();
3190 if (depth == par->params().depth()
3191 && environment_stack[depth] != style.latexname()
3192 && !environment_stack[depth].empty()) {
3193 if (environment_inner[depth] != "!-- --") {
3194 item_name= "listitem";
3195 sgmlCloseTag(ofs, command_depth+depth,
3197 if (environment_inner[depth] == "varlistentry")
3199 depth + command_depth,
3200 environment_inner[depth]);
3203 sgmlCloseTag(ofs, depth + command_depth,
3204 environment_stack[depth]);
3206 environment_stack[depth].erase();
3207 environment_inner[depth].erase();
3210 // Write opening SGML tags.
3211 switch (style.latextype) {
3212 case LATEX_PARAGRAPH:
3213 sgmlOpenTag(ofs, depth + command_depth,
3220 _("Error : Wrong depth for "
3221 "LatexType Command.\n"));
3223 command_name = style.latexname();
3225 sgmlparam = style.latexparam();
3226 c_params = split(sgmlparam, c_depth,'|');
3228 cmd_depth = lyx::atoi(c_depth);
3231 if (cmd_depth < command_base) {
3232 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3233 sgmlCloseTag(ofs, j, command_stack[j]);
3234 command_depth = command_base = cmd_depth;
3235 } else if (cmd_depth <= command_depth) {
3236 for (int j = command_depth; j >= int(cmd_depth); --j)
3237 sgmlCloseTag(ofs, j, command_stack[j]);
3238 command_depth = cmd_depth;
3240 command_depth = cmd_depth;
3242 command_depth = command_base = cmd_depth;
3243 command_flag = true;
3245 if (command_stack.size() == command_depth + 1)
3246 command_stack.push_back(string());
3247 command_stack[command_depth] = command_name;
3249 // treat label as a special case for
3250 // more WYSIWYM handling.
3251 // This is a hack while paragraphs can't have
3252 // attributes, like id in this case.
3253 if (par->isInset(0)) {
3254 Inset * inset = par->getInset(0);
3255 Inset::Code lyx_code = inset->lyxCode();
3256 if (lyx_code == Inset::LABEL_CODE) {
3257 command_name += " id=\"";
3258 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3259 command_name += "\"";
3264 sgmlOpenTag(ofs, depth + command_depth, command_name);
3265 if (c_params.empty())
3266 item_name = "title";
3268 item_name = c_params;
3269 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3272 case LATEX_ENVIRONMENT:
3273 case LATEX_ITEM_ENVIRONMENT:
3274 if (depth < par->params().depth()) {
3275 depth = par->params().depth();
3276 environment_stack[depth].erase();
3279 if (environment_stack[depth] != style.latexname()) {
3280 if (environment_stack.size() == depth + 1) {
3281 environment_stack.push_back("!-- --");
3282 environment_inner.push_back("!-- --");
3284 environment_stack[depth] = style.latexname();
3285 environment_inner[depth] = "!-- --";
3286 sgmlOpenTag(ofs, depth + command_depth,
3287 environment_stack[depth]);
3289 if (environment_inner[depth] != "!-- --") {
3290 item_name= "listitem";
3292 command_depth + depth,
3294 if (environment_inner[depth] == "varlistentry")
3296 depth + command_depth,
3297 environment_inner[depth]);
3301 if (style.latextype == LATEX_ENVIRONMENT) {
3302 if (!style.latexparam().empty()) {
3303 if (style.latexparam() == "CDATA")
3306 sgmlOpenTag(ofs, depth + command_depth,
3307 style.latexparam());
3312 desc_on = (style.labeltype == LABEL_MANUAL);
3315 environment_inner[depth]= "varlistentry";
3317 environment_inner[depth]= "listitem";
3319 sgmlOpenTag(ofs, depth + 1 + command_depth,
3320 environment_inner[depth]);
3324 sgmlOpenTag(ofs, depth + 1 + command_depth,
3328 sgmlOpenTag(ofs, depth + 1 + command_depth,
3333 sgmlOpenTag(ofs, depth + command_depth,
3338 simpleDocBookOnePar(ofs, par, desc_on, depth+1+command_depth);
3342 // write closing SGML tags
3343 switch (style.latextype) {
3345 if (c_params.empty())
3349 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3351 case LATEX_ENVIRONMENT:
3352 if (!style.latexparam().empty()) {
3353 if (style.latexparam() == "CDATA")
3356 sgmlCloseTag(ofs, depth + command_depth,
3357 style.latexparam());
3360 case LATEX_ITEM_ENVIRONMENT:
3361 if (desc_on == 1) break;
3363 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3365 case LATEX_PARAGRAPH:
3366 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3369 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3375 for (int d = depth; d >= 0; --d) {
3376 if (!environment_stack[depth].empty()) {
3377 if (environment_inner[depth] != "!-- --") {
3378 item_name = "listitem";
3379 sgmlCloseTag(ofs, command_depth + depth,
3381 if (environment_inner[depth] == "varlistentry")
3382 sgmlCloseTag(ofs, depth + command_depth,
3383 environment_inner[depth]);
3386 sgmlCloseTag(ofs, depth + command_depth,
3387 environment_stack[depth]);
3391 for (int j = command_depth; j >= 0 ; --j)
3392 if (!command_stack[j].empty())
3393 sgmlCloseTag(ofs, j, command_stack[j]);
3396 sgmlCloseTag(ofs, 0, top_element);
3399 // How to check for successful close
3401 // we want this to be true outside previews (for insetexternal)
3406 void Buffer::simpleDocBookOnePar(ostream & os,
3407 Paragraph * par, int & desc_on,
3408 Paragraph::depth_type depth) const
3410 bool emph_flag = false;
3412 LyXLayout const & style =
3413 textclasslist[params.textclass][par->layout()];
3415 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3417 int char_line_count = depth;
3418 //if (!style.free_spacing)
3419 // os << string(depth,' ');
3421 // parsing main loop
3422 for (pos_type i = 0; i < par->size(); ++i) {
3423 LyXFont font = par->getFont(params, i);
3425 // handle <emphasis> tag
3426 if (font_old.emph() != font.emph()) {
3427 if (font.emph() == LyXFont::ON) {
3431 os << "</emphasis>";
3437 if (par->isInset(i)) {
3438 Inset * inset = par->getInset(i);
3439 // don't print the inset in position 0 if desc_on == 3 (label)
3440 if ( i || desc_on != 3) {
3441 if(style.latexparam() == "CDATA")
3443 inset->docbook(this, os);
3444 if(style.latexparam() == "CDATA")
3448 char c = par->getChar(i);
3450 par->sgmlConvertChar(c, sgml_string);
3452 if (style.pass_thru) {
3454 } else if (style.free_spacing || par->isFreeSpacing() || c != ' ') {
3456 } else if (desc_on ==1) {
3458 os << "\n</term><listitem><para>";
3468 os << "</emphasis>";
3471 // resets description flag correctly
3473 // <term> not closed...
3474 os << "</term>\n<listitem><para> </para>";
3476 if (style.free_spacing) os << '\n';
3480 // This should be enabled when the Chktex class is implemented. (Asger)
3481 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3482 // Other flags: -wall -v0 -x
3483 int Buffer::runChktex()
3485 if (!users->text) return 0;
3487 users->owner()->prohibitInput();
3489 // get LaTeX-Filename
3490 string const name = getLatexName();
3491 string path = filePath();
3493 string const org_path = path;
3494 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3498 Path p(path); // path to LaTeX file
3499 users->owner()->message(_("Running chktex..."));
3501 // Remove all error insets
3502 bool const removedErrorInsets = users->removeAutoInsets();
3504 // Generate the LaTeX file if neccessary
3505 makeLaTeXFile(name, org_path, false);
3508 Chktex chktex(lyxrc.chktex_command, name, filePath());
3509 int res = chktex.run(terr); // run chktex
3512 Alert::alert(_("chktex did not work!"),
3513 _("Could not run with file:"), name);
3514 } else if (res > 0) {
3515 // Insert all errors as errors boxes
3516 users->insertErrors(terr);
3519 // if we removed error insets before we ran chktex or if we inserted
3520 // error insets after we ran chktex, this must be run:
3521 if (removedErrorInsets || res) {
3525 users->owner()->allowInput();
3531 void Buffer::validate(LaTeXFeatures & features) const
3533 Paragraph * par = paragraph;
3534 LyXTextClass const & tclass = textclasslist[params.textclass];
3536 // AMS Style is at document level
3537 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3538 features.require("amsmath");
3541 // We don't use "lyxerr.debug" because of speed. (Asger)
3542 if (lyxerr.debugging(Debug::LATEX))
3543 lyxerr << "Paragraph: " << par << endl;
3545 // Now just follow the list of paragraphs and run
3546 // validate on each of them.
3547 par->validate(features);
3549 // and then the next paragraph
3553 // the bullet shapes are buffer level not paragraph level
3554 // so they are tested here
3555 for (int i = 0; i < 4; ++i) {
3556 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3557 int const font = params.user_defined_bullets[i].getFont();
3559 int const c = params
3560 .user_defined_bullets[i]
3567 features.require("latexsym");
3569 } else if (font == 1) {
3570 features.require("amssymb");
3571 } else if ((font >= 2 && font <= 5)) {
3572 features.require("pifont");
3577 if (lyxerr.debugging(Debug::LATEX)) {
3578 features.showStruct();
3583 // This function should be in Buffer because it's a buffer's property (ale)
3584 string const Buffer::getIncludeonlyList(char delim)
3587 for (inset_iterator it = inset_iterator_begin();
3588 it != inset_iterator_end(); ++it) {
3589 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3590 InsetInclude * insetinc =
3591 static_cast<InsetInclude *>(*it);
3592 if (insetinc->isIncludeOnly()) {
3595 lst += insetinc->getRelFileBaseName();
3599 lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3604 vector<string> const Buffer::getLabelList()
3606 /// if this is a child document and the parent is already loaded
3607 /// Use the parent's list instead [ale990407]
3608 if (!params.parentname.empty()
3609 && bufferlist.exists(params.parentname)) {
3610 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3612 return tmp->getLabelList();
3615 vector<string> label_list;
3616 for (inset_iterator it = inset_iterator_begin();
3617 it != inset_iterator_end(); ++it) {
3618 vector<string> const l = (*it)->getLabelList();
3619 label_list.insert(label_list.end(), l.begin(), l.end());
3625 Buffer::Lists const Buffer::getLists() const
3628 Paragraph * par = paragraph;
3630 LyXTextClass const & textclass = textclasslist[params.textclass];
3631 bool found = textclass.hasLayout("Caption");
3632 string const layout("Caption");
3635 char const labeltype = textclass[par->layout()].labeltype;
3637 if (labeltype >= LABEL_COUNTER_CHAPTER
3638 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3639 // insert this into the table of contents
3640 SingleList & item = l["TOC"];
3643 textclass.maxcounter());
3644 item.push_back(TocItem(par, depth, par->asString(this, true)));
3646 // For each paragrph, traverse its insets and look for
3650 Paragraph::inset_iterator it =
3651 par->inset_iterator_begin();
3652 Paragraph::inset_iterator end =
3653 par->inset_iterator_end();
3655 for (; it != end; ++it) {
3656 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3658 static_cast<InsetFloat*>(*it);
3660 string const type = il->type();
3662 // Now find the caption in the float...
3663 // We now tranverse the paragraphs of
3665 Paragraph * tmp = il->inset.paragraph();
3667 if (tmp->layout() == layout) {
3668 SingleList & item = l[type];
3670 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3671 item.push_back(TocItem(tmp, 0 , str));
3678 lyxerr << "Caption not found" << endl;
3687 // This is also a buffer property (ale)
3688 vector<pair<string, string> > const Buffer::getBibkeyList()
3690 /// if this is a child document and the parent is already loaded
3691 /// Use the parent's list instead [ale990412]
3692 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3693 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3695 return tmp->getBibkeyList();
3698 vector<pair<string, string> > keys;
3699 Paragraph * par = paragraph;
3702 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3703 par->asString(this, false)));
3707 // Might be either using bibtex or a child has bibliography
3709 for (inset_iterator it = inset_iterator_begin();
3710 it != inset_iterator_end(); ++it) {
3711 // Search for Bibtex or Include inset
3712 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3713 vector<pair<string,string> > tmp =
3714 static_cast<InsetBibtex*>(*it)->getKeys(this);
3715 keys.insert(keys.end(), tmp.begin(), tmp.end());
3716 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3717 vector<pair<string,string> > const tmp =
3718 static_cast<InsetInclude*>(*it)->getKeys();
3719 keys.insert(keys.end(), tmp.begin(), tmp.end());
3728 bool Buffer::isDepClean(string const & name) const
3730 DEPCLEAN * item = dep_clean;
3731 while (item && item->master != name)
3733 if (!item) return true;
3738 void Buffer::markDepClean(string const & name)
3741 dep_clean = new DEPCLEAN;
3742 dep_clean->clean = true;
3743 dep_clean->master = name;
3744 dep_clean->next = 0;
3746 DEPCLEAN * item = dep_clean;
3747 while (item && item->master != name)
3752 item = new DEPCLEAN;
3754 item->master = name;
3761 bool Buffer::dispatch(string const & command)
3763 // Split command string into command and argument
3765 string line = frontStrip(command);
3766 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3768 return dispatch(lyxaction.LookupFunc(cmd), arg);
3772 bool Buffer::dispatch(int action, string const & argument)
3774 bool dispatched = true;
3777 Exporter::Export(this, argument, false);
3787 void Buffer::resizeInsets(BufferView * bv)
3789 /// then remove all LyXText in text-insets
3790 Paragraph * par = paragraph;
3791 for (; par; par = par->next()) {
3792 par->resizeInsetsLyXText(bv);
3797 void Buffer::redraw()
3804 void Buffer::changeLanguage(Language const * from, Language const * to)
3807 ParIterator end = par_iterator_end();
3808 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3809 (*it)->changeLanguage(params, from, to);
3813 bool Buffer::isMultiLingual()
3815 ParIterator end = par_iterator_end();
3816 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3817 if ((*it)->isMultiLingual(params))
3824 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph, pos_type pos)
3827 it = par->InsetIterator(pos);
3828 if (it == par->inset_iterator_end()) {
3835 void Buffer::inset_iterator::setParagraph()
3838 it = par->inset_iterator_begin();
3839 if (it != par->inset_iterator_end())
3844 // We maintain an invariant that whenever par = 0 then it = 0
3848 Inset * Buffer::getInsetFromID(int id_arg) const
3850 for (inset_iterator it = inset_const_iterator_begin();
3851 it != inset_const_iterator_end(); ++it)
3853 if ((*it)->id() == id_arg)
3855 Inset * in = (*it)->getInsetFromID(id_arg);
3863 Paragraph * Buffer::getParFromID(int id) const
3865 if (id < 0) return 0;
3866 Paragraph * par = paragraph;
3868 if (par->id() == id) {
3871 Paragraph * tmp = par->getParFromID(id);
3881 ParIterator Buffer::par_iterator_begin()
3883 return ParIterator(paragraph);
3887 ParIterator Buffer::par_iterator_end()
3889 return ParIterator();