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 "lyx_gui_misc.h"
25 #include "LyXAction.h"
28 #include "tex-strings.h"
30 #include "bufferview_funcs.h"
37 #include "LaTeXFeatures.h"
44 #include "converter.h"
45 #include "BufferView.h"
46 #include "ParagraphParameters.h"
47 #include "iterators.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/figinset.h"
69 #include "insets/insettext.h"
70 #include "insets/insetert.h"
71 #include "insets/insetgraphics.h"
72 #include "insets/insetfoot.h"
73 #include "insets/insetmarginal.h"
74 #include "insets/insetminipage.h"
75 #include "insets/insetfloat.h"
76 #include "insets/insettabular.h"
78 #include "insets/insettheorem.h"
79 #include "insets/insetlist.h"
81 #include "insets/insetcaption.h"
82 #include "insets/insetfloatlist.h"
84 #include "frontends/Dialogs.h"
85 #include "frontends/Alert.h"
87 #include "support/textutils.h"
88 #include "support/filetools.h"
89 #include "support/path.h"
90 #include "support/os.h"
91 #include "support/syscall.h"
92 #include "support/lyxlib.h"
93 #include "support/FileInfo.h"
94 #include "support/lyxmanip.h"
106 #include <sys/types.h>
123 using std::make_pair;
132 using lyx::layout_type;
133 using lyx::textclass_type;
135 // all these externs should eventually be removed.
136 extern BufferList bufferlist;
138 extern LyXAction lyxaction;
142 const int LYX_FORMAT = 220;
146 extern int tex_code_break_column;
149 Buffer::Buffer(string const & file, bool ronly)
151 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
153 filepath = OnlyPath(file);
162 if (read_only || (lyxrc.use_tempdir)) {
163 tmppath = CreateBufferTmpDir();
164 } else tmppath.erase();
170 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
171 // here the buffer should take care that it is
172 // saved properly, before it goes into the void.
174 // make sure that views using this buffer
179 if (!tmppath.empty()) {
180 DestroyBufferTmpDir(tmppath);
183 Paragraph * par = paragraph;
186 tmppar = par->next();
194 string const Buffer::getLatexName(bool no_path) const
196 string const name = ChangeExtension(MakeLatexName(filename), ".tex");
198 return OnlyFilename(name);
204 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
206 string const filename = getLatexName(false);
208 if (filename.empty())
209 return make_pair(Buffer::latexlog, string());
211 string path = OnlyPath(filename);
213 if (lyxrc.use_tempdir || !IsDirWriteable(path))
216 string const fname = AddName(path,
217 OnlyFilename(ChangeExtension(filename,
220 AddName(path, OnlyFilename(
221 ChangeExtension(filename,
222 formats.extension("literate") + ".out")));
224 // If no Latex log or Build log is newer, show Build log
226 FileInfo const f_fi(fname);
227 FileInfo const b_fi(bname);
230 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
231 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
232 return make_pair(Buffer::buildlog, bname);
234 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
235 return make_pair(Buffer::latexlog, fname);
239 void Buffer::setReadonly(bool flag)
241 if (read_only != flag) {
244 users->owner()->getDialogs()->updateBufferDependent(false);
249 /// Update window titles of all users
250 // Should work on a list
251 void Buffer::updateTitles() const
254 users->owner()->updateWindowTitle();
258 /// Reset autosave timer of all users
259 // Should work on a list
260 void Buffer::resetAutosaveTimers() const
263 users->owner()->resetAutosaveTimer();
267 void Buffer::setFileName(string const & newfile)
269 filename = MakeAbsPath(newfile);
270 filepath = OnlyPath(filename);
271 setReadonly(IsFileWriteable(filename) == 0);
276 // We'll remove this later. (Lgb)
279 string last_inset_read;
281 #ifndef NO_COMPABILITY
284 ErtComp() : active(false), in_tabular(false) {
291 std::stack<ErtComp> ert_stack;
295 #warning And _why_ is this here? (Lgb)
302 // candidate for move to BufferView
303 // (at least some parts in the beginning of the func)
306 // changed to be public and have one parameter
307 // if par = 0 normal behavior
308 // else insert behavior
309 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
310 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
314 #ifndef NO_COMPABILITY
315 ert_comp.contents.erase();
316 ert_comp.active = false;
317 ert_comp.in_tabular = false;
320 Paragraph::depth_type depth = 0;
321 bool the_end_read = false;
323 Paragraph * first_par = 0;
324 LyXFont font(LyXFont::ALL_INHERIT, params.language);
325 if (file_format < 216 && params.language->lang() == "hebrew")
326 font.setLanguage(default_language);
331 // We are inserting into an existing document
332 users->text->breakParagraph(users);
333 first_par = users->text->firstParagraph();
336 // We don't want to adopt the parameters from the
337 // document we insert, so we skip until the text begins:
340 string const pretoken = lex.getString();
341 if (pretoken == "\\layout") {
342 lex.pushToken(pretoken);
350 string const token = lex.getString();
352 if (token.empty()) continue;
354 lyxerr[Debug::PARSER] << "Handling token: `"
355 << token << "'" << endl;
358 parseSingleLyXformat2Token(lex, par, first_par,
366 paragraph = first_par;
368 if (unknown_layouts > 0) {
369 string s = _("Couldn't set the layout for ");
370 if (unknown_layouts == 1) {
371 s += _("one paragraph");
373 s += tostr(unknown_layouts);
374 s += _(" paragraphs");
376 Alert::alert(_("Textclass Loading Error!"), s,
377 _("When reading " + fileName()));
380 if (unknown_tokens > 0) {
381 string s = _("Encountered ");
382 if (unknown_tokens == 1) {
383 s += _("one unknown token");
385 s += tostr(unknown_tokens);
386 s += _(" unknown tokens");
388 Alert::alert(_("Textclass Loading Error!"), s,
389 _("When reading " + fileName()));
396 #ifndef NO_COMPABILITY
397 void Buffer::insertErtContents(Paragraph * par, int & pos,
398 LyXFont const & f, bool set_inactive)
400 if (!ert_comp.contents.empty()) {
401 lyxerr[Debug::INSETS] << "ERT contents:\n'"
402 << ert_comp.contents << "'" << endl;
403 Inset * inset = new InsetERT(ert_comp.contents, true);
405 font.setLanguage(f.language());
406 par->insertInset(pos++, inset, font);
407 ert_comp.contents.erase();
410 ert_comp.active = false;
417 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
418 Paragraph *& first_par,
419 string const & token, int & pos,
420 Paragraph::depth_type & depth,
424 bool the_end_read = false;
425 #ifndef NO_COMPABILITY
426 #ifndef NO_PEXTRA_REALLY
427 // This is super temporary but is needed to get the compability
428 // mode for minipages work correctly together with new tabulars.
429 static int call_depth;
431 bool checkminipage = false;
432 static Paragraph * minipar;
433 static Paragraph * parBeforeMinipage;
436 if (token[0] != '\\') {
437 #ifndef NO_COMPABILITY
438 if (ert_comp.active) {
439 ert_comp.contents += token;
442 for (string::const_iterator cit = token.begin();
443 cit != token.end(); ++cit) {
444 par->insertChar(pos, (*cit), font);
447 #ifndef NO_COMPABILITY
450 } else if (token == "\\i") {
451 Inset * inset = new InsetLatexAccent;
452 inset->read(this, lex);
453 par->insertInset(pos, inset, font);
455 } else if (token == "\\layout") {
456 #ifndef NO_COMPABILITY
457 ert_comp.in_tabular = false;
459 insertErtContents(par, pos, font);
462 string const layoutname = lex.getString();
463 pair<bool, layout_type> pp
464 = textclasslist.NumberOfLayout(params.textclass, layoutname);
466 #ifndef NO_COMPABILITY
467 if (compare_no_case(layoutname, "latex") == 0) {
468 ert_comp.active = true;
472 // The is the compability reading of layout caption.
473 // It can be removed in LyX version 1.3.0. (Lgb)
474 if (compare_no_case(layoutname, "caption") == 0) {
475 // We expect that the par we are now working on is
476 // really inside a InsetText inside a InsetFloat.
477 // We also know that captions can only be
478 // one paragraph. (Lgb)
480 // We should now read until the next "\layout"
482 // This is probably not good enough, what if the
483 // caption is the last par in the document (Lgb)
484 istream & ist = lex.getStream();
490 if (prefixIs(line, "\\layout")) {
494 if (prefixIs(line, "\\begin_inset"))
496 if (prefixIs(line, "\\end_inset")) {
507 // Now we should have the whole layout in ss
508 // we should now be able to give this to the
510 ss << "\\end_inset\n";
512 // This seems like a bug in stringstream.
513 // We really should be able to use ss
515 istringstream is(ss.str());
517 tmplex.setStream(is);
518 Inset * inset = new InsetCaption;
519 inset->Read(this, tmplex);
520 par->InsertInset(pos, inset, font);
527 par = new Paragraph(par);
531 par->layout = pp.second;
532 #ifndef NO_COMPABILITY
533 } else if (ert_comp.active) {
538 // use default layout "Standard" (0)
541 string const s = _("Layout had to be changed from\n")
542 + layoutname + _(" to ")
543 + textclasslist.NameOfLayout(params.textclass, par->layout);
544 InsetError * new_inset = new InsetError(s);
545 par->insertInset(0, new_inset);
546 par->setFont(0, LyXFont(LyXFont::ALL_INHERIT,
549 // Test whether the layout is obsolete.
550 LyXLayout const & layout =
551 textclasslist.Style(params.textclass,
553 if (!layout.obsoleted_by().empty())
554 par->layout = textclasslist
555 .NumberOfLayout(params.textclass,
556 layout.obsoleted_by())
558 par->params().depth(depth);
559 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
560 if (file_format < 216
561 && params.language->lang() == "hebrew")
562 font.setLanguage(default_language);
567 #ifndef NO_COMPABILITY
568 } else if (token == "\\begin_float") {
569 insertErtContents(par, pos, font);
570 //insertErtContents(par, pos, font, false);
571 //ert_stack.push(ert_comp);
572 //ert_comp = ErtComp();
574 // This is the compability reader. It can be removed in
575 // LyX version 1.3.0. (Lgb)
577 string const tmptok = lex.getString();
578 //lyxerr << "old float: " << tmptok << endl;
581 stringstream old_float;
583 if (tmptok == "footnote") {
584 inset = new InsetFoot;
585 old_float << "collapsed true\n";
586 } else if (tmptok == "margin") {
587 inset = new InsetMarginal;
588 old_float << "collapsed true\n";
589 } else if (tmptok == "fig") {
590 inset = new InsetFloat("figure");
591 old_float << "placement htbp\n"
593 << "collapsed false\n";
594 } else if (tmptok == "tab") {
595 inset = new InsetFloat("table");
596 old_float << "placement htbp\n"
598 << "collapsed false\n";
599 } else if (tmptok == "alg") {
600 inset = new InsetFloat("algorithm");
601 old_float << "placement htbp\n"
603 << "collapsed false\n";
604 } else if (tmptok == "wide-fig") {
605 inset = new InsetFloat("figure");
606 //InsetFloat * tmp = new InsetFloat("figure");
609 old_float << "placement htbp\n"
611 << "collapsed false\n";
612 } else if (tmptok == "wide-tab") {
613 inset = new InsetFloat("table");
614 //InsetFloat * tmp = new InsetFloat("table");
617 old_float << "placement htbp\n"
619 << "collapsed false\n";
623 #ifndef NO_PEXTRA_REALLY
626 return false; // no end read yet
629 // Here we need to check for \end_deeper and handle that
630 // before we do the footnote parsing.
631 // This _is_ a hack! (Lgb)
634 string const tmp = lex.getString();
635 if (tmp == "\\end_deeper") {
636 //lyxerr << "\\end_deeper caught!" << endl;
638 lex.printError("\\end_deeper: "
639 "depth is already null");
644 old_float << tmp << ' ';
649 old_float << lex.getLongString("\\end_float")
650 << "\n\\end_inset\n";
651 //lyxerr << "Float Body:\n" << old_float.str() << endl;
652 // That this does not work seems like a bug
653 // in stringstream. (Lgb)
654 istringstream istr(old_float.str());
656 nylex.setStream(istr);
657 inset->read(this, nylex);
658 par->insertInset(pos, inset, font);
660 insertErtContents(par, pos, font);
662 } else if (token == "\\begin_deeper") {
664 } else if (token == "\\end_deeper") {
666 lex.printError("\\end_deeper: "
667 "depth is already null");
671 } else if (token == "\\begin_preamble") {
672 params.readPreamble(lex);
673 } else if (token == "\\textclass") {
675 pair<bool, textclass_type> pp =
676 textclasslist.NumberOfClass(lex.getString());
678 params.textclass = pp.second;
680 Alert::alert(string(_("Textclass error")),
681 string(_("The document uses an unknown textclass \"")) +
682 lex.getString() + string("\"."),
683 string(_("LyX will not be able to produce output correctly.")));
684 params.textclass = 0;
686 if (!textclasslist.Load(params.textclass)) {
687 // if the textclass wasn't loaded properly
688 // we need to either substitute another
689 // or stop loading the file.
690 // I can substitute but I don't see how I can
691 // stop loading... ideas?? ARRae980418
692 Alert::alert(_("Textclass Loading Error!"),
693 string(_("Can't load textclass ")) +
694 textclasslist.NameOfClass(params.textclass),
695 _("-- substituting default"));
696 params.textclass = 0;
698 } else if (token == "\\options") {
700 params.options = lex.getString();
701 } else if (token == "\\language") {
702 params.readLanguage(lex);
703 } else if (token == "\\fontencoding") {
705 } else if (token == "\\inputencoding") {
707 params.inputenc = lex.getString();
708 } else if (token == "\\graphics") {
709 params.readGraphicsDriver(lex);
710 } else if (token == "\\fontscheme") {
712 params.fonts = lex.getString();
713 } else if (token == "\\noindent") {
714 par->params().noindent(true);
715 } else if (token == "\\fill_top") {
716 par->params().spaceTop(VSpace(VSpace::VFILL));
717 } else if (token == "\\fill_bottom") {
718 par->params().spaceBottom(VSpace(VSpace::VFILL));
719 } else if (token == "\\line_top") {
720 par->params().lineTop(true);
721 } else if (token == "\\line_bottom") {
722 par->params().lineBottom(true);
723 } else if (token == "\\pagebreak_top") {
724 par->params().pagebreakTop(true);
725 } else if (token == "\\pagebreak_bottom") {
726 par->params().pagebreakBottom(true);
727 } else if (token == "\\start_of_appendix") {
728 par->params().startOfAppendix(true);
729 } else if (token == "\\paragraph_separation") {
730 int tmpret = lex.findToken(string_paragraph_separation);
731 if (tmpret == -1) ++tmpret;
732 if (tmpret != LYX_LAYOUT_DEFAULT)
733 params.paragraph_separation =
734 static_cast<BufferParams::PARSEP>(tmpret);
735 } else if (token == "\\defskip") {
737 params.defskip = VSpace(lex.getString());
738 } else if (token == "\\epsfig") { // obsolete
739 // Indeed it is obsolete, but we HAVE to be backwards
740 // compatible until 0.14, because otherwise all figures
741 // in existing documents are irretrivably lost. (Asger)
742 params.readGraphicsDriver(lex);
743 } else if (token == "\\quotes_language") {
744 int tmpret = lex.findToken(string_quotes_language);
745 if (tmpret == -1) ++tmpret;
746 if (tmpret != LYX_LAYOUT_DEFAULT) {
747 InsetQuotes::quote_language tmpl =
748 InsetQuotes::EnglishQ;
751 tmpl = InsetQuotes::EnglishQ;
754 tmpl = InsetQuotes::SwedishQ;
757 tmpl = InsetQuotes::GermanQ;
760 tmpl = InsetQuotes::PolishQ;
763 tmpl = InsetQuotes::FrenchQ;
766 tmpl = InsetQuotes::DanishQ;
769 params.quotes_language = tmpl;
771 } else if (token == "\\quotes_times") {
773 switch (lex.getInteger()) {
775 params.quotes_times = InsetQuotes::SingleQ;
778 params.quotes_times = InsetQuotes::DoubleQ;
781 } else if (token == "\\papersize") {
782 int tmpret = lex.findToken(string_papersize);
786 params.papersize2 = tmpret;
787 } else if (token == "\\paperpackage") {
788 int tmpret = lex.findToken(string_paperpackages);
791 params.paperpackage = BufferParams::PACKAGE_NONE;
793 params.paperpackage = tmpret;
794 } else if (token == "\\use_geometry") {
796 params.use_geometry = lex.getInteger();
797 } else if (token == "\\use_amsmath") {
799 params.use_amsmath = lex.getInteger();
800 } else if (token == "\\use_natbib") {
802 params.use_natbib = lex.getInteger();
803 } else if (token == "\\use_numerical_citations") {
805 params.use_numerical_citations = lex.getInteger();
806 } else if (token == "\\paperorientation") {
807 int tmpret = lex.findToken(string_orientation);
808 if (tmpret == -1) ++tmpret;
809 if (tmpret != LYX_LAYOUT_DEFAULT)
810 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
811 } else if (token == "\\paperwidth") {
813 params.paperwidth = lex.getString();
814 } else if (token == "\\paperheight") {
816 params.paperheight = lex.getString();
817 } else if (token == "\\leftmargin") {
819 params.leftmargin = lex.getString();
820 } else if (token == "\\topmargin") {
822 params.topmargin = lex.getString();
823 } else if (token == "\\rightmargin") {
825 params.rightmargin = lex.getString();
826 } else if (token == "\\bottommargin") {
828 params.bottommargin = lex.getString();
829 } else if (token == "\\headheight") {
831 params.headheight = lex.getString();
832 } else if (token == "\\headsep") {
834 params.headsep = lex.getString();
835 } else if (token == "\\footskip") {
837 params.footskip = lex.getString();
838 } else if (token == "\\paperfontsize") {
840 params.fontsize = strip(lex.getString());
841 } else if (token == "\\papercolumns") {
843 params.columns = lex.getInteger();
844 } else if (token == "\\papersides") {
846 switch (lex.getInteger()) {
848 case 1: params.sides = LyXTextClass::OneSide; break;
849 case 2: params.sides = LyXTextClass::TwoSides; break;
851 } else if (token == "\\paperpagestyle") {
853 params.pagestyle = strip(lex.getString());
854 } else if (token == "\\bullet") {
856 int const index = lex.getInteger();
858 int temp_int = lex.getInteger();
859 params.user_defined_bullets[index].setFont(temp_int);
860 params.temp_bullets[index].setFont(temp_int);
862 temp_int = lex.getInteger();
863 params.user_defined_bullets[index].setCharacter(temp_int);
864 params.temp_bullets[index].setCharacter(temp_int);
866 temp_int = lex.getInteger();
867 params.user_defined_bullets[index].setSize(temp_int);
868 params.temp_bullets[index].setSize(temp_int);
870 string const temp_str = lex.getString();
871 if (temp_str != "\\end_bullet") {
872 // this element isn't really necessary for
873 // parsing but is easier for humans
874 // to understand bullets. Put it back and
875 // set a debug message?
876 lex.printError("\\end_bullet expected, got" + temp_str);
877 //how can I put it back?
879 } else if (token == "\\bulletLaTeX") {
881 int const index = lex.getInteger();
883 string temp_str = lex.getString();
885 while (temp_str != "\\end_bullet") {
886 // this loop structure is needed when user
887 // enters an empty string since the first
888 // thing returned will be the \\end_bullet
890 // if the LaTeX entry has spaces. Each element
891 // therefore needs to be read in turn
894 temp_str = lex.getString();
896 params.user_defined_bullets[index].setText(sum_str);
897 params.temp_bullets[index].setText(sum_str);
898 } else if (token == "\\secnumdepth") {
900 params.secnumdepth = lex.getInteger();
901 } else if (token == "\\tocdepth") {
903 params.tocdepth = lex.getInteger();
904 } else if (token == "\\spacing") {
906 string const tmp = strip(lex.getString());
907 Spacing::Space tmp_space = Spacing::Default;
909 if (tmp == "single") {
910 tmp_space = Spacing::Single;
911 } else if (tmp == "onehalf") {
912 tmp_space = Spacing::Onehalf;
913 } else if (tmp == "double") {
914 tmp_space = Spacing::Double;
915 } else if (tmp == "other") {
917 tmp_space = Spacing::Other;
918 tmp_val = lex.getFloat();
920 lex.printError("Unknown spacing token: '$$Token'");
922 // Small hack so that files written with klyx will be
925 par->params().spacing(Spacing(tmp_space, tmp_val));
927 params.spacing.set(tmp_space, tmp_val);
929 } else if (token == "\\paragraph_spacing") {
931 string const tmp = strip(lex.getString());
932 if (tmp == "single") {
933 par->params().spacing(Spacing(Spacing::Single));
934 } else if (tmp == "onehalf") {
935 par->params().spacing(Spacing(Spacing::Onehalf));
936 } else if (tmp == "double") {
937 par->params().spacing(Spacing(Spacing::Double));
938 } else if (tmp == "other") {
940 par->params().spacing(Spacing(Spacing::Other,
943 lex.printError("Unknown spacing token: '$$Token'");
945 } else if (token == "\\float_placement") {
947 params.float_placement = lex.getString();
948 } else if (token == "\\family") {
950 font.setLyXFamily(lex.getString());
951 } else if (token == "\\series") {
953 font.setLyXSeries(lex.getString());
954 } else if (token == "\\shape") {
956 font.setLyXShape(lex.getString());
957 } else if (token == "\\size") {
959 font.setLyXSize(lex.getString());
960 #ifndef NO_COMPABILITY
961 } else if (token == "\\latex") {
963 string const tok = lex.getString();
964 if (tok == "no_latex") {
966 insertErtContents(par, pos, font);
967 } else if (tok == "latex") {
968 ert_comp.active = true;
969 } else if (tok == "default") {
971 insertErtContents(par, pos, font);
973 lex.printError("Unknown LaTeX font flag "
977 } else if (token == "\\lang") {
979 string const tok = lex.getString();
980 Language const * lang = languages.getLanguage(tok);
982 font.setLanguage(lang);
984 font.setLanguage(params.language);
985 lex.printError("Unknown language `$$Token'");
987 } else if (token == "\\numeric") {
989 font.setNumber(font.setLyXMisc(lex.getString()));
990 } else if (token == "\\emph") {
992 font.setEmph(font.setLyXMisc(lex.getString()));
993 } else if (token == "\\bar") {
995 string const tok = lex.getString();
996 // This is dirty, but gone with LyX3. (Asger)
998 font.setUnderbar(LyXFont::ON);
999 else if (tok == "no")
1000 font.setUnderbar(LyXFont::OFF);
1001 else if (tok == "default")
1002 font.setUnderbar(LyXFont::INHERIT);
1004 lex.printError("Unknown bar font flag "
1006 } else if (token == "\\noun") {
1008 font.setNoun(font.setLyXMisc(lex.getString()));
1009 } else if (token == "\\color") {
1011 font.setLyXColor(lex.getString());
1012 } else if (token == "\\align") {
1013 int tmpret = lex.findToken(string_align);
1014 if (tmpret == -1) ++tmpret;
1015 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
1016 int const tmpret2 = int(pow(2.0, tmpret));
1017 //lyxerr << "Tmpret2 = " << tmpret2 << endl;
1018 par->params().align(LyXAlignment(tmpret2));
1020 } else if (token == "\\added_space_top") {
1022 par->params().spaceTop(VSpace(lex.getString()));
1023 } else if (token == "\\added_space_bottom") {
1025 par->params().spaceBottom(VSpace(lex.getString()));
1026 #ifndef NO_COMPABILITY
1027 #ifndef NO_PEXTRA_REALLY
1028 } else if (token == "\\pextra_type") {
1030 par->params().pextraType(lex.getInteger());
1031 } else if (token == "\\pextra_width") {
1033 par->params().pextraWidth(lex.getString());
1034 } else if (token == "\\pextra_widthp") {
1036 par->params().pextraWidthp(lex.getString());
1037 } else if (token == "\\pextra_alignment") {
1039 par->params().pextraAlignment(lex.getInteger());
1040 } else if (token == "\\pextra_hfill") {
1042 par->params().pextraHfill(lex.getInteger());
1043 } else if (token == "\\pextra_start_minipage") {
1045 par->params().pextraStartMinipage(lex.getInteger());
1048 } else if (token == "\\labelwidthstring") {
1050 par->params().labelWidthString(lex.getString());
1051 // do not delete this token, it is still needed!
1052 } else if (token == "\\end_inset") {
1053 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
1054 << "Last inset read was: " << last_inset_read
1056 // Simply ignore this. The insets do not have
1058 // But insets should read it, it is a part of
1059 // the inset isn't it? Lgb.
1060 } else if (token == "\\begin_inset") {
1061 #ifndef NO_COMPABILITY
1062 insertErtContents(par, pos, font, false);
1063 ert_stack.push(ert_comp);
1064 ert_comp = ErtComp();
1066 readInset(lex, par, pos, font);
1067 #ifndef NO_COMPABILITY
1068 ert_comp = ert_stack.top();
1070 insertErtContents(par, pos, font);
1072 } else if (token == "\\SpecialChar") {
1073 LyXLayout const & layout =
1074 textclasslist.Style(params.textclass,
1077 // Insets don't make sense in a free-spacing context! ---Kayvan
1078 if (layout.free_spacing || par->isFreeSpacing()) {
1081 string next_token = lex.getString();
1082 if (next_token == "\\-") {
1083 par->insertChar(pos, '-', font);
1084 } else if (next_token == "\\protected_separator"
1085 || next_token == "~") {
1086 par->insertChar(pos, ' ', font);
1088 lex.printError("Token `$$Token' "
1090 "paragraph layout!");
1095 Inset * inset = new InsetSpecialChar;
1096 inset->read(this, lex);
1097 par->insertInset(pos, inset, font);
1100 } else if (token == "\\newline") {
1101 #ifndef NO_COMPABILITY
1102 if (!ert_comp.in_tabular && ert_comp.active) {
1103 ert_comp.contents += char(Paragraph::META_NEWLINE);
1105 // Since we cannot know it this is only a regular
1106 // newline or a tabular cell delimter we have to
1107 // handle the ERT here.
1108 insertErtContents(par, pos, font, false);
1110 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1114 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1117 } else if (token == "\\LyXTable") {
1118 #ifndef NO_COMPABILITY
1119 ert_comp.in_tabular = true;
1121 Inset * inset = new InsetTabular(*this);
1122 inset->read(this, lex);
1123 par->insertInset(pos, inset, font);
1125 } else if (token == "\\hfill") {
1126 par->insertChar(pos, Paragraph::META_HFILL, font);
1128 } else if (token == "\\protected_separator") { // obsolete
1129 // This is a backward compability thingie. (Lgb)
1130 // Remove it later some time...introduced with fileformat
1132 LyXLayout const & layout =
1133 textclasslist.Style(params.textclass,
1136 if (layout.free_spacing || par->isFreeSpacing()) {
1137 par->insertChar(pos, ' ', font);
1139 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
1140 par->insertInset(pos, inset, font);
1143 } else if (token == "\\bibitem") { // ale970302
1145 InsetCommandParams p("bibitem", "dummy");
1146 par->bibkey = new InsetBibKey(p);
1148 par->bibkey->read(this, lex);
1149 } else if (token == "\\backslash") {
1150 #ifndef NO_COMPABILITY
1151 if (ert_comp.active) {
1152 ert_comp.contents += "\\";
1155 par->insertChar(pos, '\\', font);
1157 #ifndef NO_COMPABILITY
1160 } else if (token == "\\the_end") {
1161 #ifndef NO_COMPABILITY
1162 // If we still have some ert active here we have to insert
1163 // it so we don't loose it. (Lgb)
1164 insertErtContents(par, pos, font);
1166 the_end_read = true;
1167 #ifndef NO_COMPABILITY
1168 #ifndef NO_PEXTRA_REALLY
1169 minipar = parBeforeMinipage = 0;
1173 #ifndef NO_COMPABILITY
1174 if (ert_comp.active) {
1175 ert_comp.contents += token;
1178 // This should be insurance for the future: (Asger)
1181 string const s = _("Unknown token: ") + token
1182 + " " + lex.text() + "\n";
1184 InsetError * new_inset = new InsetError(s);
1185 par->insertInset(pos, new_inset);
1186 par->setFont(pos, LyXFont(LyXFont::ALL_INHERIT,
1189 #ifndef NO_COMPABILITY
1194 #ifndef NO_COMPABILITY
1195 #ifndef NO_PEXTRA_REALLY
1196 // I wonder if we could use this blanket fix for all the
1197 // checkminipage cases...
1198 if (par && par->size()) {
1199 // It is possible that this will check to often,
1200 // but that should not be an correctness issue.
1201 // Only a speed issue.
1202 checkminipage = true;
1205 // now check if we have a minipage paragraph as at this
1206 // point we already read all the necessary data!
1207 // this cannot be done in layout because there we did
1208 // not read yet the paragraph PEXTRA-params (Jug)
1210 // BEGIN pextra_minipage compability
1211 // This should be removed in 1.3.x (Lgb)
1213 // This compability code is not perfect. In a couple
1214 // of rand cases it fails. When the minipage par is
1215 // the first par in the document, and when there are
1216 // none or only one regular paragraphs after the
1217 // minipage. Currently I am not investing any effort
1218 // in fixing those cases.
1220 //lyxerr << "Call depth: " << call_depth << endl;
1221 if (checkminipage && (call_depth == 1)) {
1222 checkminipage = false;
1223 if (minipar && (minipar != par) &&
1224 (par->params().pextraType()==Paragraph::PEXTRA_MINIPAGE))
1226 lyxerr << "minipages in a row" << endl;
1227 if (par->params().pextraStartMinipage()) {
1228 lyxerr << "start new minipage" << endl;
1229 // minipages in a row
1230 par->previous()->next(0);
1233 Paragraph * tmp = minipar;
1235 tmp->params().pextraType(0);
1236 tmp->params().pextraWidth(string());
1237 tmp->params().pextraWidthp(string());
1238 tmp->params().pextraAlignment(0);
1239 tmp->params().pextraHfill(false);
1240 tmp->params().pextraStartMinipage(false);
1243 // create a new paragraph to insert the
1244 // minipages in the following case
1245 if (par->params().pextraStartMinipage() &&
1246 !par->params().pextraHfill())
1248 Paragraph * p = new Paragraph;
1250 p->previous(parBeforeMinipage);
1251 parBeforeMinipage->next(p);
1253 p->params().depth(parBeforeMinipage->params().depth());
1254 parBeforeMinipage = p;
1256 InsetMinipage * mini = new InsetMinipage;
1257 mini->pos(static_cast<InsetMinipage::Position>(par->params().pextraAlignment()));
1258 mini->width(par->params().pextraWidth());
1259 if (!par->params().pextraWidthp().empty()) {
1260 lyxerr << "WP:" << mini->width() << endl;
1261 mini->width(tostr(par->params().pextraWidthp())+"%");
1263 mini->inset.paragraph(par);
1264 // Insert the minipage last in the
1265 // previous paragraph.
1266 if (par->params().pextraHfill()) {
1267 parBeforeMinipage->insertChar
1268 (parBeforeMinipage->size(), Paragraph::META_HFILL);
1270 parBeforeMinipage->insertInset
1271 (parBeforeMinipage->size(), mini);
1275 lyxerr << "new minipage par" << endl;
1276 //nothing to do just continue reading
1279 } else if (minipar && (minipar != par)) {
1280 lyxerr << "last minipage par read" << endl;
1281 // The last paragraph read was not part of a
1282 // minipage but the par linked list is...
1283 // So we need to remove the last par from the
1285 if (par->previous())
1286 par->previous()->next(0);
1287 par->previous(parBeforeMinipage);
1288 parBeforeMinipage->next(par);
1289 Paragraph * tmp = minipar;
1291 tmp->params().pextraType(0);
1292 tmp->params().pextraWidth(string());
1293 tmp->params().pextraWidthp(string());
1294 tmp->params().pextraAlignment(0);
1295 tmp->params().pextraHfill(false);
1296 tmp->params().pextraStartMinipage(false);
1299 depth = parBeforeMinipage->params().depth();
1300 minipar = parBeforeMinipage = 0;
1301 } else if (!minipar &&
1302 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1304 // par is the first paragraph in a minipage
1305 lyxerr << "begin minipage" << endl;
1306 // To minimize problems for
1307 // the users we will insert
1308 // the first minipage in
1309 // a sequence of minipages
1310 // in its own paragraph.
1311 Paragraph * p = new Paragraph;
1313 p->previous(par->previous());
1315 p->params().depth(depth);
1316 par->params().depth(0);
1318 if (par->previous())
1319 par->previous()->next(p);
1321 parBeforeMinipage = p;
1323 if (!first_par || (first_par == par))
1326 InsetMinipage * mini = new InsetMinipage;
1327 mini->pos(static_cast<InsetMinipage::Position>(minipar->params().pextraAlignment()));
1328 mini->width(minipar->params().pextraWidth());
1329 if (!par->params().pextraWidthp().empty()) {
1330 lyxerr << "WP:" << mini->width() << endl;
1331 mini->width(tostr(par->params().pextraWidthp())+"%");
1333 mini->inset.paragraph(minipar);
1335 // Insert the minipage last in the
1336 // previous paragraph.
1337 if (minipar->params().pextraHfill()) {
1338 parBeforeMinipage->insertChar
1339 (parBeforeMinipage->size(),Paragraph::META_HFILL);
1341 parBeforeMinipage->insertInset
1342 (parBeforeMinipage->size(), mini);
1345 // End of pextra_minipage compability
1349 return the_end_read;
1352 // needed to insert the selection
1353 void Buffer::insertStringAsLines(Paragraph *& par, pos_type & pos,
1354 LyXFont const & fn,string const & str) const
1356 LyXLayout const & layout = textclasslist.Style(params.textclass,
1360 (void)par->checkInsertChar(font);
1361 // insert the string, don't insert doublespace
1362 bool space_inserted = true;
1363 for(string::const_iterator cit = str.begin();
1364 cit != str.end(); ++cit) {
1366 if (par->size() || layout.keepempty) {
1367 par->breakParagraph(params, pos,
1368 layout.isEnvironment());
1371 space_inserted = true;
1375 // do not insert consecutive spaces if !free_spacing
1376 } else if ((*cit == ' ' || *cit == '\t') &&
1377 space_inserted && !layout.free_spacing &&
1378 !par->isFreeSpacing())
1381 } else if (*cit == '\t') {
1382 if (!layout.free_spacing && !par->isFreeSpacing()) {
1383 // tabs are like spaces here
1384 par->insertChar(pos, ' ', font);
1386 space_inserted = true;
1388 const pos_type nb = 8 - pos % 8;
1389 for (pos_type a = 0; a < nb ; ++a) {
1390 par->insertChar(pos, ' ', font);
1393 space_inserted = true;
1395 } else if (!IsPrintable(*cit)) {
1396 // Ignore unprintables
1399 // just insert the character
1400 par->insertChar(pos, *cit, font);
1402 space_inserted = (*cit == ' ');
1409 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1410 int & pos, LyXFont & font)
1412 // consistency check
1413 if (lex.getString() != "\\begin_inset") {
1414 lyxerr << "Buffer::readInset: Consistency check failed."
1421 string const tmptok = lex.getString();
1422 last_inset_read = tmptok;
1424 // test the different insets
1425 if (tmptok == "LatexCommand") {
1426 InsetCommandParams inscmd;
1429 string const cmdName = inscmd.getCmdName();
1431 // This strange command allows LyX to recognize "natbib" style
1432 // citations: citet, citep, Citet etc.
1433 if (compare_no_case(cmdName, "cite", 4) == 0) {
1434 inset = new InsetCitation(inscmd);
1435 } else if (cmdName == "bibitem") {
1436 lex.printError("Wrong place for bibitem");
1437 inset = new InsetBibKey(inscmd);
1438 } else if (cmdName == "BibTeX") {
1439 inset = new InsetBibtex(inscmd);
1440 } else if (cmdName == "index") {
1441 inset = new InsetIndex(inscmd);
1442 } else if (cmdName == "include") {
1443 inset = new InsetInclude(inscmd, *this);
1444 } else if (cmdName == "label") {
1445 inset = new InsetLabel(inscmd);
1446 } else if (cmdName == "url"
1447 || cmdName == "htmlurl") {
1448 inset = new InsetUrl(inscmd);
1449 } else if (cmdName == "ref"
1450 || cmdName == "pageref"
1451 || cmdName == "vref"
1452 || cmdName == "vpageref"
1453 || cmdName == "prettyref") {
1454 if (!inscmd.getOptions().empty()
1455 || !inscmd.getContents().empty()) {
1456 inset = new InsetRef(inscmd, *this);
1458 } else if (cmdName == "tableofcontents") {
1459 inset = new InsetTOC(inscmd);
1460 } else if (cmdName == "listofalgorithms") {
1461 inset = new InsetFloatList("algorithm");
1462 } else if (cmdName == "listoffigures") {
1463 inset = new InsetFloatList("figure");
1464 } else if (cmdName == "listoftables") {
1465 inset = new InsetFloatList("table");
1466 } else if (cmdName == "printindex") {
1467 inset = new InsetPrintIndex(inscmd);
1468 } else if (cmdName == "lyxparent") {
1469 inset = new InsetParent(inscmd, *this);
1472 bool alreadyread = false;
1473 if (tmptok == "Quotes") {
1474 inset = new InsetQuotes;
1475 } else if (tmptok == "External") {
1476 inset = new InsetExternal;
1477 } else if (tmptok == "FormulaMacro") {
1478 inset = new InsetFormulaMacro;
1479 } else if (tmptok == "Formula") {
1480 inset = new InsetFormula;
1481 } else if (tmptok == "Figure") { // Backward compatibility
1482 inset = new InsetFig(100, 100, *this);
1483 //inset = new InsetGraphics;
1484 } else if (tmptok == "Graphics") {
1485 inset = new InsetGraphics;
1486 } else if (tmptok == "Info") {// backwards compatibility
1487 inset = new InsetNote(this,
1488 lex.getLongString("\\end_inset"),
1491 } else if (tmptok == "Note") {
1492 inset = new InsetNote;
1493 } else if (tmptok == "Include") {
1494 InsetCommandParams p( "Include" );
1495 inset = new InsetInclude(p, *this);
1496 } else if (tmptok == "ERT") {
1497 inset = new InsetERT;
1498 } else if (tmptok == "Tabular") {
1499 inset = new InsetTabular(*this);
1500 } else if (tmptok == "Text") {
1501 inset = new InsetText;
1502 } else if (tmptok == "Foot") {
1503 inset = new InsetFoot;
1504 } else if (tmptok == "Marginal") {
1505 inset = new InsetMarginal;
1506 } else if (tmptok == "Minipage") {
1507 inset = new InsetMinipage;
1508 } else if (tmptok == "Float") {
1510 string tmptok = lex.getString();
1511 inset = new InsetFloat(tmptok);
1513 } else if (tmptok == "List") {
1514 inset = new InsetList;
1515 } else if (tmptok == "Theorem") {
1516 inset = new InsetList;
1518 } else if (tmptok == "Caption") {
1519 inset = new InsetCaption;
1520 } else if (tmptok == "FloatList") {
1521 inset = new InsetFloatList;
1524 if (inset && !alreadyread) inset->read(this, lex);
1528 par->insertInset(pos, inset, font);
1534 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1538 string const token(lex.getString());
1539 if (token == "\\lyxformat") { // the first token _must_ be...
1541 string tmp_format = lex.getString();
1542 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1543 // if present remove ".," from string.
1544 string::size_type dot = tmp_format.find_first_of(".,");
1545 //lyxerr << " dot found at " << dot << endl;
1546 if (dot != string::npos)
1547 tmp_format.erase(dot, 1);
1548 file_format = strToInt(tmp_format);
1549 if (file_format == LYX_FORMAT) {
1551 } else if (file_format > LYX_FORMAT) {
1553 Alert::alert(_("Warning!"),
1554 _("LyX file format is newer that what"),
1555 _("is supported in this LyX version. Expect some problems."));
1557 } else if (file_format < LYX_FORMAT) {
1559 if (file_format < 200) {
1560 Alert::alert(_("ERROR!"),
1561 _("Old LyX file format found. "
1562 "Use LyX 0.10.x to read this!"));
1566 bool the_end = readLyXformat2(lex, par);
1567 params.setPaperStuff();
1568 // the_end was added in 213
1569 if (file_format < 213)
1573 Alert::alert(_("Warning!"),
1574 _("Reading of document is not complete"),
1575 _("Maybe the document is truncated"));
1578 } else { // "\\lyxformat" not found
1579 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1582 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1587 // Should probably be moved to somewhere else: BufferView? LyXView?
1588 bool Buffer::save() const
1590 // We don't need autosaves in the immediate future. (Asger)
1591 resetAutosaveTimers();
1595 if (lyxrc.make_backup) {
1596 s = fileName() + '~';
1597 if (!lyxrc.backupdir_path.empty())
1598 s = AddName(lyxrc.backupdir_path,
1599 subst(os::slashify_path(s),'/','!'));
1601 // Rename is the wrong way of making a backup,
1602 // this is the correct way.
1603 /* truss cp fil fil2:
1604 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1605 stat("LyXVC.lyx", 0xEFFFF688) = 0
1606 open("LyXVC.lyx", O_RDONLY) = 3
1607 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1608 fstat(4, 0xEFFFF508) = 0
1609 fstat(3, 0xEFFFF508) = 0
1610 read(3, " # T h i s f i l e w".., 8192) = 5579
1611 write(4, " # T h i s f i l e w".., 5579) = 5579
1612 read(3, 0xEFFFD4A0, 8192) = 0
1615 chmod("LyXVC3.lyx", 0100644) = 0
1616 lseek(0, 0, SEEK_CUR) = 46440
1620 // Should probably have some more error checking here.
1621 // Should be cleaned up in 0.13, at least a bit.
1622 // Doing it this way, also makes the inodes stay the same.
1623 // This is still not a very good solution, in particular we
1624 // might loose the owner of the backup.
1625 FileInfo finfo(fileName());
1626 if (finfo.exist()) {
1627 mode_t fmode = finfo.getMode();
1628 struct utimbuf times = {
1629 finfo.getAccessTime(),
1630 finfo.getModificationTime() };
1632 ifstream ifs(fileName().c_str());
1633 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1638 ::chmod(s.c_str(), fmode);
1640 if (::utime(s.c_str(), ×)) {
1641 lyxerr << "utime error." << endl;
1644 lyxerr << "LyX was not able to make "
1645 "backup copy. Beware." << endl;
1650 if (writeFile(fileName(), false)) {
1652 removeAutosaveFile(fileName());
1654 // Saving failed, so backup is not backup
1655 if (lyxrc.make_backup) {
1656 lyx::rename(s, fileName());
1664 // Returns false if unsuccesful
1665 bool Buffer::writeFile(string const & fname, bool flag) const
1667 // if flag is false writeFile will not create any GUI
1668 // warnings, only cerr.
1669 // Needed for autosave in background or panic save (Matthias 120496)
1671 if (read_only && (fname == filename)) {
1672 // Here we should come with a question if we should
1673 // perform the write anyway.
1675 lyxerr << _("Error! Document is read-only: ")
1678 Alert::alert(_("Error! Document is read-only: "),
1683 FileInfo finfo(fname);
1684 if (finfo.exist() && !finfo.writable()) {
1685 // Here we should come with a question if we should
1686 // try to do the save anyway. (i.e. do a chmod first)
1688 lyxerr << _("Error! Cannot write file: ")
1691 Alert::err_alert(_("Error! Cannot write file: "),
1696 ofstream ofs(fname.c_str());
1699 lyxerr << _("Error! Cannot open file: ")
1702 Alert::err_alert(_("Error! Cannot open file: "),
1708 // Use the standard "C" locale for file output.
1709 ofs.imbue(std::locale::classic());
1712 // The top of the file should not be written by params.
1714 // write out a comment in the top of the file
1715 ofs << '#' << lyx_docversion
1716 << " created this file. For more info see http://www.lyx.org/\n"
1717 << "\\lyxformat " << LYX_FORMAT << "\n";
1719 // now write out the buffer paramters.
1720 params.writeFile(ofs);
1722 Paragraph::depth_type depth = 0;
1724 // this will write out all the paragraphs
1725 // using recursive descent.
1726 paragraph->writeFile(this, ofs, params, depth);
1728 // Write marker that shows file is complete
1729 ofs << "\n\\the_end" << endl;
1733 // how to check if close went ok?
1734 // Following is an attempt... (BE 20001011)
1736 // good() returns false if any error occured, including some
1737 // formatting error.
1738 // bad() returns true if something bad happened in the buffer,
1739 // which should include file system full errors.
1746 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1748 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1758 string const Buffer::asciiParagraph(Paragraph const * par,
1759 unsigned int linelen) const
1761 ostringstream buffer;
1762 Paragraph::depth_type depth = 0;
1764 Paragraph::depth_type ltype_depth = 0;
1765 string::size_type currlinelen = 0;
1766 bool ref_printed = false;
1770 if (!par->previous()) {
1771 // begins or ends a deeper area ?
1772 if (depth != par->params().depth()) {
1773 if (par->params().depth() > depth) {
1774 while (par->params().depth() > depth) {
1778 while (par->params().depth() < depth) {
1784 // First write the layout
1785 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1786 if (tmp == "Itemize") {
1788 ltype_depth = depth + 1;
1789 } else if (tmp == "Enumerate") {
1791 ltype_depth = depth + 1;
1792 } else if (contains(tmp, "ection")) {
1794 ltype_depth = depth + 1;
1795 } else if (contains(tmp, "aragraph")) {
1797 ltype_depth = depth + 1;
1798 } else if (tmp == "Description") {
1800 ltype_depth = depth + 1;
1801 } else if (tmp == "Abstract") {
1804 } else if (tmp == "Bibliography") {
1812 /* maybe some vertical spaces */
1814 /* the labelwidthstring used in lists */
1818 /* some pagebreaks? */
1822 /* what about the alignment */
1824 lyxerr << "Should this ever happen?" << endl;
1827 for (pos_type i = 0; i < par->size(); ++i) {
1828 if (!i && !noparbreak) {
1831 for (Paragraph::depth_type j = 0; j < depth; ++j)
1833 currlinelen = depth * 2;
1836 case 4: // (Sub)Paragraph
1837 case 5: // Description
1841 buffer << "Abstract\n\n";
1843 buffer << "Abstract: ";
1845 case 7: // Bibliography
1848 buffer << "References\n\n";
1850 buffer << "References: ";
1855 buffer << par->params().labelString() << " ";
1858 if (ltype_depth > depth) {
1859 for (Paragraph::depth_type j = ltype_depth - 1;
1862 currlinelen += (ltype_depth-depth)*2;
1866 char c = par->getUChar(params, i);
1870 case Paragraph::META_INSET:
1872 Inset const * inset = par->getInset(i);
1874 if (!inset->ascii(this, buffer)) {
1877 rsplit(buffer.str().c_str(),
1879 currlinelen += s.length();
1881 // to be sure it breaks paragraph
1882 currlinelen += linelen;
1888 case Paragraph::META_NEWLINE:
1891 for (Paragraph::depth_type j = 0;
1895 currlinelen = depth * 2;
1896 if (ltype_depth > depth) {
1897 for (Paragraph::depth_type j = ltype_depth;
1900 currlinelen += (ltype_depth - depth) * 2;
1904 case Paragraph::META_HFILL:
1909 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1910 (c == ' ') && ((i + 2) < par->size()))
1913 for (Paragraph::depth_type j = 0;
1916 currlinelen = depth * 2;
1917 if (ltype_depth > depth) {
1918 for (Paragraph::depth_type j = ltype_depth;
1921 currlinelen += (ltype_depth-depth)*2;
1923 } else if (c != '\0') {
1927 lyxerr[Debug::INFO] << "writeAsciiFile: NULL char in structure." << endl;
1931 return buffer.str().c_str();
1935 void Buffer::writeFileAscii(string const & fname, int linelen)
1937 ofstream ofs(fname.c_str());
1939 Alert::err_alert(_("Error: Cannot write file:"), fname);
1942 writeFileAscii(ofs, linelen);
1946 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1948 Paragraph * par = paragraph;
1950 ofs << asciiParagraph(par, linelen);
1958 void Buffer::makeLaTeXFile(string const & fname,
1959 string const & original_path,
1960 bool nice, bool only_body)
1962 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1964 niceFile = nice; // this will be used by Insetincludes.
1966 tex_code_break_column = lyxrc.ascii_linelen;
1968 LyXTextClass const & tclass =
1969 textclasslist.TextClass(params.textclass);
1971 ofstream ofs(fname.c_str());
1973 Alert::err_alert(_("Error: Cannot open file: "), fname);
1977 // validate the buffer.
1978 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1979 LaTeXFeatures features(params, tclass.numLayouts());
1981 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1984 // The starting paragraph of the coming rows is the
1985 // first paragraph of the document. (Asger)
1986 texrow.start(paragraph, 0);
1988 if (!only_body && nice) {
1989 ofs << "%% " << lyx_docversion << " created this file. "
1990 "For more info, see http://www.lyx.org/.\n"
1991 "%% Do not edit unless you really know what "
1996 lyxerr[Debug::INFO] << "lyx header finished" << endl;
1997 // There are a few differences between nice LaTeX and usual files:
1998 // usual is \batchmode and has a
1999 // special input@path to allow the including of figures
2000 // with either \input or \includegraphics (what figinsets do).
2001 // batchmode is not set if there is a tex_code_break_column.
2002 // In this case somebody is interested in the generated LaTeX,
2003 // so this is OK. input@path is set when the actual parameter
2004 // original_path is set. This is done for usual tex-file, but not
2005 // for nice-latex-file. (Matthias 250696)
2008 // code for usual, NOT nice-latex-file
2009 ofs << "\\batchmode\n"; // changed
2010 // from \nonstopmode
2013 if (!original_path.empty()) {
2014 ofs << "\\makeatletter\n"
2015 << "\\def\\input@path{{"
2016 << os::external_path(original_path) << "/}}\n"
2017 << "\\makeatother\n";
2023 ofs << "\\documentclass";
2025 ostringstream options; // the document class options.
2027 if (tokenPos(tclass.opt_fontsize(),
2028 '|', params.fontsize) >= 0) {
2029 // only write if existing in list (and not default)
2030 options << params.fontsize << "pt,";
2034 if (!params.use_geometry &&
2035 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2036 switch (params.papersize) {
2037 case BufferParams::PAPER_A4PAPER:
2038 options << "a4paper,";
2040 case BufferParams::PAPER_USLETTER:
2041 options << "letterpaper,";
2043 case BufferParams::PAPER_A5PAPER:
2044 options << "a5paper,";
2046 case BufferParams::PAPER_B5PAPER:
2047 options << "b5paper,";
2049 case BufferParams::PAPER_EXECUTIVEPAPER:
2050 options << "executivepaper,";
2052 case BufferParams::PAPER_LEGALPAPER:
2053 options << "legalpaper,";
2059 if (params.sides != tclass.sides()) {
2060 switch (params.sides) {
2061 case LyXTextClass::OneSide:
2062 options << "oneside,";
2064 case LyXTextClass::TwoSides:
2065 options << "twoside,";
2071 if (params.columns != tclass.columns()) {
2072 if (params.columns == 2)
2073 options << "twocolumn,";
2075 options << "onecolumn,";
2078 if (!params.use_geometry
2079 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2080 options << "landscape,";
2082 // language should be a parameter to \documentclass
2084 ostringstream language_options;
2085 if (params.language->babel() == "hebrew"
2086 && default_language->babel() != "hebrew")
2087 // This seems necessary
2088 features.useLanguage(default_language);
2090 if (lyxrc.language_use_babel ||
2091 params.language->lang() != lyxrc.default_language ||
2092 !features.hasLanguages()) {
2094 language_options << features.getLanguages();
2095 language_options << params.language->babel();
2096 if (lyxrc.language_global_options)
2097 options << language_options.str() << ',';
2100 // the user-defined options
2101 if (!params.options.empty()) {
2102 options << params.options << ',';
2105 string strOptions(options.str().c_str());
2106 if (!strOptions.empty()){
2107 strOptions = strip(strOptions, ',');
2108 ofs << '[' << strOptions << ']';
2112 << textclasslist.LatexnameOfClass(params.textclass)
2115 // end of \documentclass defs
2117 // font selection must be done before loading fontenc.sty
2118 // The ae package is not needed when using OT1 font encoding.
2119 if (params.fonts != "default" &&
2120 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2121 ofs << "\\usepackage{" << params.fonts << "}\n";
2123 if (params.fonts == "ae") {
2124 ofs << "\\usepackage{aecompl}\n";
2128 // this one is not per buffer
2129 if (lyxrc.fontenc != "default") {
2130 ofs << "\\usepackage[" << lyxrc.fontenc
2135 if (params.inputenc == "auto") {
2136 string const doc_encoding =
2137 params.language->encoding()->LatexName();
2139 // Create a list with all the input encodings used
2141 set<string> encodings = features.getEncodingSet(doc_encoding);
2143 ofs << "\\usepackage[";
2144 std::copy(encodings.begin(), encodings.end(),
2145 std::ostream_iterator<string>(ofs, ","));
2146 ofs << doc_encoding << "]{inputenc}\n";
2148 } else if (params.inputenc != "default") {
2149 ofs << "\\usepackage[" << params.inputenc
2154 // At the very beginning the text parameters.
2155 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2156 switch (params.paperpackage) {
2157 case BufferParams::PACKAGE_A4:
2158 ofs << "\\usepackage{a4}\n";
2161 case BufferParams::PACKAGE_A4WIDE:
2162 ofs << "\\usepackage{a4wide}\n";
2165 case BufferParams::PACKAGE_WIDEMARGINSA4:
2166 ofs << "\\usepackage[widemargins]{a4}\n";
2171 if (params.use_geometry) {
2172 ofs << "\\usepackage{geometry}\n";
2174 ofs << "\\geometry{verbose";
2175 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2176 ofs << ",landscape";
2177 switch (params.papersize2) {
2178 case BufferParams::VM_PAPER_CUSTOM:
2179 if (!params.paperwidth.empty())
2180 ofs << ",paperwidth="
2181 << params.paperwidth;
2182 if (!params.paperheight.empty())
2183 ofs << ",paperheight="
2184 << params.paperheight;
2186 case BufferParams::VM_PAPER_USLETTER:
2187 ofs << ",letterpaper";
2189 case BufferParams::VM_PAPER_USLEGAL:
2190 ofs << ",legalpaper";
2192 case BufferParams::VM_PAPER_USEXECUTIVE:
2193 ofs << ",executivepaper";
2195 case BufferParams::VM_PAPER_A3:
2198 case BufferParams::VM_PAPER_A4:
2201 case BufferParams::VM_PAPER_A5:
2204 case BufferParams::VM_PAPER_B3:
2207 case BufferParams::VM_PAPER_B4:
2210 case BufferParams::VM_PAPER_B5:
2214 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2215 switch (lyxrc.default_papersize) {
2216 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2217 case BufferParams::PAPER_USLETTER:
2218 ofs << ",letterpaper";
2220 case BufferParams::PAPER_LEGALPAPER:
2221 ofs << ",legalpaper";
2223 case BufferParams::PAPER_EXECUTIVEPAPER:
2224 ofs << ",executivepaper";
2226 case BufferParams::PAPER_A3PAPER:
2229 case BufferParams::PAPER_A4PAPER:
2232 case BufferParams::PAPER_A5PAPER:
2235 case BufferParams::PAPER_B5PAPER:
2240 if (!params.topmargin.empty())
2241 ofs << ",tmargin=" << params.topmargin;
2242 if (!params.bottommargin.empty())
2243 ofs << ",bmargin=" << params.bottommargin;
2244 if (!params.leftmargin.empty())
2245 ofs << ",lmargin=" << params.leftmargin;
2246 if (!params.rightmargin.empty())
2247 ofs << ",rmargin=" << params.rightmargin;
2248 if (!params.headheight.empty())
2249 ofs << ",headheight=" << params.headheight;
2250 if (!params.headsep.empty())
2251 ofs << ",headsep=" << params.headsep;
2252 if (!params.footskip.empty())
2253 ofs << ",footskip=" << params.footskip;
2258 if (features.isRequired("amsstyle")
2259 && !tclass.provides(LyXTextClass::amsmath)) {
2260 ofs << "\\usepackage{amsmath}\n";
2264 if (tokenPos(tclass.opt_pagestyle(),
2265 '|', params.pagestyle) >= 0) {
2266 if (params.pagestyle == "fancy") {
2267 ofs << "\\usepackage{fancyhdr}\n";
2270 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2274 if (params.secnumdepth != tclass.secnumdepth()) {
2275 ofs << "\\setcounter{secnumdepth}{"
2276 << params.secnumdepth
2280 if (params.tocdepth != tclass.tocdepth()) {
2281 ofs << "\\setcounter{tocdepth}{"
2287 if (params.paragraph_separation) {
2288 switch (params.defskip.kind()) {
2289 case VSpace::SMALLSKIP:
2290 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2292 case VSpace::MEDSKIP:
2293 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2295 case VSpace::BIGSKIP:
2296 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2298 case VSpace::LENGTH:
2299 ofs << "\\setlength\\parskip{"
2300 << params.defskip.length().asLatexString()
2303 default: // should never happen // Then delete it.
2304 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2309 ofs << "\\setlength\\parindent{0pt}\n";
2313 // Now insert the LyX specific LaTeX commands...
2315 // The optional packages;
2316 string preamble(features.getPackages());
2318 // this might be useful...
2319 preamble += "\n\\makeatletter\n";
2321 // Some macros LyX will need
2322 string tmppreamble(features.getMacros());
2324 if (!tmppreamble.empty()) {
2325 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2326 "LyX specific LaTeX commands.\n"
2327 + tmppreamble + '\n';
2330 // the text class specific preamble
2331 tmppreamble = features.getTClassPreamble();
2332 if (!tmppreamble.empty()) {
2333 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2334 "Textclass specific LaTeX commands.\n"
2335 + tmppreamble + '\n';
2338 /* the user-defined preamble */
2339 if (!params.preamble.empty()) {
2340 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2341 "User specified LaTeX commands.\n"
2342 + params.preamble + '\n';
2345 preamble += "\\makeatother\n";
2347 // Itemize bullet settings need to be last in case the user
2348 // defines their own bullets that use a package included
2349 // in the user-defined preamble -- ARRae
2350 // Actually it has to be done much later than that
2351 // since some packages like frenchb make modifications
2352 // at \begin{document} time -- JMarc
2354 for (int i = 0; i < 4; ++i) {
2355 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2356 if (bullets_def.empty())
2357 bullets_def="\\AtBeginDocument{\n";
2358 bullets_def += " \\renewcommand{\\labelitemi";
2360 // `i' is one less than the item to modify
2367 bullets_def += "ii";
2373 bullets_def += "}{" +
2374 params.user_defined_bullets[i].getText()
2379 if (!bullets_def.empty())
2380 preamble += bullets_def + "}\n\n";
2382 for (int j = countChar(preamble, '\n'); j-- ;) {
2388 // We try to load babel late, in case it interferes
2389 // with other packages.
2391 string tmp = lyxrc.language_package;
2392 if (!lyxrc.language_global_options
2393 && tmp == "\\usepackage{babel}")
2394 tmp = string("\\usepackage[") +
2395 language_options.str().c_str() +
2402 ofs << "\\begin{document}\n";
2405 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2407 if (!lyxrc.language_auto_begin) {
2408 ofs << subst(lyxrc.language_command_begin, "$$lang",
2409 params.language->babel())
2414 latexParagraphs(ofs, paragraph, 0, texrow);
2416 // add this just in case after all the paragraphs
2420 if (!lyxrc.language_auto_end) {
2421 ofs << subst(lyxrc.language_command_end, "$$lang",
2422 params.language->babel())
2428 ofs << "\\end{document}\n";
2431 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2433 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2437 // Just to be sure. (Asger)
2440 // tex_code_break_column's value is used to decide
2441 // if we are in batchmode or not (within mathed_write()
2442 // in math_write.C) so we must set it to a non-zero
2443 // value when we leave otherwise we save incorrect .lyx files.
2444 tex_code_break_column = lyxrc.ascii_linelen;
2448 lyxerr << "File was not closed properly." << endl;
2451 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2452 lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2457 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2459 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2460 Paragraph * endpar, TexRow & texrow) const
2462 bool was_title = false;
2463 bool already_title = false;
2466 while (par != endpar) {
2467 LyXLayout const & layout =
2468 textclasslist.Style(params.textclass,
2471 if (layout.intitle) {
2472 if (already_title) {
2473 lyxerr <<"Error in latexParagraphs: You"
2474 " should not mix title layouts"
2475 " with normal ones." << endl;
2478 } else if (was_title && !already_title) {
2479 ofs << "\\maketitle\n";
2481 already_title = true;
2485 if (layout.isEnvironment()) {
2486 par = par->TeXEnvironment(this, params, ofs, texrow);
2488 par = par->TeXOnePar(this, params, ofs, texrow, false);
2491 // It might be that we only have a title in this document
2492 if (was_title && !already_title) {
2493 ofs << "\\maketitle\n";
2499 bool Buffer::isLatex() const
2501 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2505 bool Buffer::isLinuxDoc() const
2507 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2511 bool Buffer::isLiterate() const
2513 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2517 bool Buffer::isDocBook() const
2519 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2523 bool Buffer::isSGML() const
2525 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2526 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2530 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth,
2531 string const & latexname) const
2533 if (!latexname.empty() && latexname != "!-- --")
2534 //os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2535 os << string(depth, ' ') << "<" << latexname << ">\n";
2539 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth,
2540 string const & latexname) const
2542 if (!latexname.empty() && latexname != "!-- --")
2543 //os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2544 os << string(depth, ' ') << "</" << latexname << ">\n";
2548 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2550 ofstream ofs(fname.c_str());
2553 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2557 niceFile = nice; // this will be used by included files.
2559 LyXTextClass const & tclass =
2560 textclasslist.TextClass(params.textclass);
2562 LaTeXFeatures features(params, tclass.numLayouts());
2567 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2570 ofs << "<!doctype linuxdoc system";
2572 string preamble = params.preamble;
2573 preamble += features.getIncludedFiles(fname);
2574 preamble += features.getLyXSGMLEntities();
2576 if (!preamble.empty()) {
2577 ofs << " [ " << preamble << " ]";
2581 if (params.options.empty())
2582 sgmlOpenTag(ofs, 0, top_element);
2584 string top = top_element;
2586 top += params.options;
2587 sgmlOpenTag(ofs, 0, top);
2591 ofs << "<!-- " << lyx_docversion
2592 << " created this file. For more info see http://www.lyx.org/"
2595 Paragraph::depth_type depth = 0; // paragraph depth
2596 Paragraph * par = paragraph;
2598 vector<string> environment_stack(5);
2601 LyXLayout const & style =
2602 textclasslist.Style(params.textclass,
2605 // treat <toc> as a special case for compatibility with old code
2606 if (par->isInset(0)) {
2607 Inset * inset = par->getInset(0);
2608 Inset::Code lyx_code = inset->lyxCode();
2609 if (lyx_code == Inset::TOC_CODE){
2610 string const temp = "toc";
2611 sgmlOpenTag(ofs, depth, temp);
2618 // environment tag closing
2619 for (; depth > par->params().depth(); --depth) {
2620 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2621 environment_stack[depth].erase();
2624 // write opening SGML tags
2625 switch (style.latextype) {
2626 case LATEX_PARAGRAPH:
2627 if (depth == par->params().depth()
2628 && !environment_stack[depth].empty()) {
2629 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2630 environment_stack[depth].erase();
2636 sgmlOpenTag(ofs, depth, style.latexname());
2642 _("Error : Wrong depth for"
2643 " LatexType Command.\n"));
2645 if (!environment_stack[depth].empty()){
2646 sgmlCloseTag(ofs, depth,
2647 environment_stack[depth]);
2651 environment_stack[depth].erase();
2652 sgmlOpenTag(ofs, depth, style.latexname());
2655 case LATEX_ENVIRONMENT:
2656 case LATEX_ITEM_ENVIRONMENT:
2657 if (depth == par->params().depth()
2658 && environment_stack[depth] != style.latexname()) {
2659 sgmlCloseTag(ofs, depth,
2660 environment_stack[depth]);
2661 environment_stack[depth].erase();
2663 if (depth < par->params().depth()) {
2664 depth = par->params().depth();
2665 environment_stack[depth].erase();
2667 if (environment_stack[depth] != style.latexname()) {
2669 sgmlOpenTag(ofs, depth, "p");
2671 sgmlOpenTag(ofs, depth, style.latexname());
2673 if (environment_stack.size() == depth + 1)
2674 environment_stack.push_back("!-- --");
2675 environment_stack[depth] = style.latexname();
2678 if (style.latexparam() == "CDATA")
2681 if (style.latextype == LATEX_ENVIRONMENT) break;
2683 if (style.labeltype == LABEL_MANUAL)
2688 sgmlOpenTag(ofs, depth + 1, item_name);
2691 sgmlOpenTag(ofs, depth, style.latexname());
2695 simpleLinuxDocOnePar(ofs, par, depth);
2700 // write closing SGML tags
2701 switch (style.latextype) {
2704 case LATEX_ENVIRONMENT:
2705 case LATEX_ITEM_ENVIRONMENT:
2706 if (style.latexparam() == "CDATA")
2710 sgmlCloseTag(ofs, depth, style.latexname());
2716 for (int i=depth; i >= 0; --i)
2717 sgmlCloseTag(ofs, depth, environment_stack[i]);
2721 sgmlCloseTag(ofs, 0, top_element);
2725 // How to check for successful close
2729 // checks, if newcol chars should be put into this line
2730 // writes newline, if necessary.
2733 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2734 string::size_type newcol)
2737 if (colcount > lyxrc.ascii_linelen) {
2739 colcount = newcol; // assume write after this call
2754 string tag_name(PAR_TAG const & pt) {
2756 case NONE: return "!-- --";
2757 case TT: return "tt";
2758 case SF: return "sf";
2759 case BF: return "bf";
2760 case IT: return "it";
2761 case SL: return "sl";
2762 case EM: return "em";
2769 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2771 p1 = static_cast<PAR_TAG>(p1 | p2);
2776 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2778 p1 = static_cast<PAR_TAG>( p1 & ~p2);
2784 // Handle internal paragraph parsing -- layout already processed.
2785 void Buffer::simpleLinuxDocOnePar(ostream & os,
2787 Paragraph::depth_type /*depth*/)
2789 LyXLayout const & style = textclasslist.Style(params.textclass,
2791 string::size_type char_line_count = 5; // Heuristic choice ;-)
2793 // gets paragraph main font
2796 if (style.labeltype == LABEL_MANUAL) {
2797 font_old = style.labelfont;
2800 font_old = style.font;
2804 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2805 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2806 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2809 stack<PAR_TAG> tag_state;
2810 // parsing main loop
2811 for (pos_type i = 0; i < par->size(); ++i) {
2813 PAR_TAG tag_close = NONE;
2814 list < PAR_TAG > tag_open;
2816 LyXFont const font = par->getFont(params, i);
2818 if (font_old.family() != font.family()) {
2819 switch (family_type) {
2820 case LyXFont::SANS_FAMILY:
2823 case LyXFont::TYPEWRITER_FAMILY:
2830 family_type = font.family();
2832 switch (family_type) {
2833 case LyXFont::SANS_FAMILY:
2834 tag_open.push_back(SF);
2836 case LyXFont::TYPEWRITER_FAMILY:
2837 tag_open.push_back(TT);
2844 if (font_old.series() != font.series()) {
2845 switch (series_type) {
2846 case LyXFont::BOLD_SERIES:
2853 series_type = font.series();
2855 switch (series_type) {
2856 case LyXFont::BOLD_SERIES:
2857 tag_open.push_back(BF);
2865 if (font_old.shape() != font.shape()) {
2866 switch (shape_type) {
2867 case LyXFont::ITALIC_SHAPE:
2870 case LyXFont::SLANTED_SHAPE:
2877 shape_type = font.shape();
2879 switch (shape_type) {
2880 case LyXFont::ITALIC_SHAPE:
2881 tag_open.push_back(IT);
2883 case LyXFont::SLANTED_SHAPE:
2884 tag_open.push_back(SL);
2891 if (font_old.emph() != font.emph()) {
2892 if (font.emph() == LyXFont::ON) {
2893 tag_open.push_back(EM);
2902 list < PAR_TAG > temp;
2903 while (!tag_state.empty() && tag_close ) {
2904 PAR_TAG k = tag_state.top();
2906 os << "</" << tag_name(k) << ">";
2913 for(list< PAR_TAG >::const_iterator j = temp.begin();
2914 j != temp.end(); ++j) {
2916 os << "<" << tag_name(*j) << ">";
2919 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2920 j != tag_open.end(); ++j) {
2922 os << "<" << tag_name(*j) << ">";
2925 char c = par->getChar(i);
2927 if (c == Paragraph::META_INSET) {
2928 Inset * inset = par->getInset(i);
2929 inset->linuxdoc(this, os);
2934 if (style.latexparam() == "CDATA") {
2935 // "TeX"-Mode on == > SGML-Mode on.
2941 if (par->sgmlConvertChar(c, sgml_string)
2942 && !style.free_spacing && !par->isFreeSpacing())
2944 // in freespacing mode, spaces are
2945 // non-breaking characters
2946 if (desc_on) {// if char is ' ' then...
2949 sgmlLineBreak(os, char_line_count, 6);
2953 sgmlLineBreak(os, char_line_count, 1);
2958 char_line_count += sgml_string.length();
2964 while (!tag_state.empty()) {
2965 os << "</" << tag_name(tag_state.top()) << ">";
2969 // resets description flag correctly
2971 // <tag> not closed...
2972 sgmlLineBreak(os, char_line_count, 6);
2978 // Print an error message.
2979 void Buffer::sgmlError(Paragraph * par, int pos,
2980 string const & message) const
2982 // insert an error marker in text
2983 InsetError * new_inset = new InsetError(message);
2984 par->insertInset(pos, new_inset);
2985 par->setFont(pos, LyXFont(LyXFont::ALL_INHERIT, params.language));
2989 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2991 ofstream ofs(fname.c_str());
2993 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2997 Paragraph * par = paragraph;
2999 niceFile = nice; // this will be used by Insetincludes.
3001 LyXTextClass const & tclass =
3002 textclasslist.TextClass(params.textclass);
3004 LaTeXFeatures features(params, tclass.numLayouts());
3009 string top_element = textclasslist.LatexnameOfClass(params.textclass);
3012 ofs << "<!DOCTYPE " << top_element
3013 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
3015 string preamble = params.preamble;
3016 preamble += features.getIncludedFiles(fname);
3017 preamble += features.getLyXSGMLEntities();
3019 if (!preamble.empty()) {
3020 ofs << "\n [ " << preamble << " ]";
3025 string top = top_element;
3027 top += params.language->code();
3030 if (!params.options.empty()) {
3032 top += params.options;
3034 sgmlOpenTag(ofs, 0, top);
3036 ofs << "<!-- DocBook file was created by " << lyx_docversion
3037 << "\n See http://www.lyx.org/ for more information -->\n";
3039 vector<string> environment_stack(10);
3040 vector<string> environment_inner(10);
3041 vector<string> command_stack(10);
3043 bool command_flag = false;
3044 Paragraph::depth_type command_depth = 0;
3045 Paragraph::depth_type command_base = 0;
3046 Paragraph::depth_type cmd_depth = 0;
3047 Paragraph::depth_type depth = 0; // paragraph depth
3050 string command_name;
3056 int desc_on = 0; // description mode
3058 LyXLayout const & style =
3059 textclasslist.Style(params.textclass,
3062 // environment tag closing
3063 for (; depth > par->params().depth(); --depth) {
3064 if (environment_inner[depth] != "!-- --") {
3065 item_name = "listitem";
3066 sgmlCloseTag(ofs, command_depth + depth,
3068 if (environment_inner[depth] == "varlistentry")
3069 sgmlCloseTag(ofs, depth+command_depth,
3070 environment_inner[depth]);
3072 sgmlCloseTag(ofs, depth + command_depth,
3073 environment_stack[depth]);
3074 environment_stack[depth].erase();
3075 environment_inner[depth].erase();
3078 if (depth == par->params().depth()
3079 && environment_stack[depth] != style.latexname()
3080 && !environment_stack[depth].empty()) {
3081 if (environment_inner[depth] != "!-- --") {
3082 item_name= "listitem";
3083 sgmlCloseTag(ofs, command_depth+depth,
3085 if (environment_inner[depth] == "varlistentry")
3087 depth + command_depth,
3088 environment_inner[depth]);
3091 sgmlCloseTag(ofs, depth + command_depth,
3092 environment_stack[depth]);
3094 environment_stack[depth].erase();
3095 environment_inner[depth].erase();
3098 // Write opening SGML tags.
3099 switch (style.latextype) {
3100 case LATEX_PARAGRAPH:
3101 sgmlOpenTag(ofs, depth + command_depth,
3108 _("Error : Wrong depth for "
3109 "LatexType Command.\n"));
3111 command_name = style.latexname();
3113 sgmlparam = style.latexparam();
3114 c_params = split(sgmlparam, c_depth,'|');
3116 cmd_depth = lyx::atoi(c_depth);
3119 if (cmd_depth < command_base) {
3120 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3121 sgmlCloseTag(ofs, j, command_stack[j]);
3122 command_depth = command_base = cmd_depth;
3123 } else if (cmd_depth <= command_depth) {
3124 for (int j = command_depth; j >= int(cmd_depth); --j)
3125 sgmlCloseTag(ofs, j, command_stack[j]);
3126 command_depth = cmd_depth;
3128 command_depth = cmd_depth;
3130 command_depth = command_base = cmd_depth;
3131 command_flag = true;
3133 if (command_stack.size() == command_depth + 1)
3134 command_stack.push_back(string());
3135 command_stack[command_depth] = command_name;
3137 // treat label as a special case for
3138 // more WYSIWYM handling.
3139 // This is a hack while paragraphs can't have
3140 // attributes, like id in this case.
3141 if (par->isInset(0)) {
3142 Inset * inset = par->getInset(0);
3143 Inset::Code lyx_code = inset->lyxCode();
3144 if (lyx_code == Inset::LABEL_CODE){
3145 command_name += " id=\"";
3146 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3147 command_name += "\"";
3152 sgmlOpenTag(ofs, depth + command_depth, command_name);
3153 if (c_params.empty())
3154 item_name = "title";
3156 item_name = c_params;
3157 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3160 case LATEX_ENVIRONMENT:
3161 case LATEX_ITEM_ENVIRONMENT:
3162 if (depth < par->params().depth()) {
3163 depth = par->params().depth();
3164 environment_stack[depth].erase();
3167 if (environment_stack[depth] != style.latexname()) {
3168 if(environment_stack.size() == depth + 1) {
3169 environment_stack.push_back("!-- --");
3170 environment_inner.push_back("!-- --");
3172 environment_stack[depth] = style.latexname();
3173 environment_inner[depth] = "!-- --";
3174 sgmlOpenTag(ofs, depth + command_depth,
3175 environment_stack[depth]);
3177 if (environment_inner[depth] != "!-- --") {
3178 item_name= "listitem";
3180 command_depth + depth,
3182 if (environment_inner[depth] == "varlistentry")
3184 depth + command_depth,
3185 environment_inner[depth]);
3189 if (style.latextype == LATEX_ENVIRONMENT) {
3190 if (!style.latexparam().empty()) {
3191 if(style.latexparam() == "CDATA")
3194 sgmlOpenTag(ofs, depth + command_depth,
3195 style.latexparam());
3200 desc_on = (style.labeltype == LABEL_MANUAL);
3203 environment_inner[depth]= "varlistentry";
3205 environment_inner[depth]= "listitem";
3207 sgmlOpenTag(ofs, depth + 1 + command_depth,
3208 environment_inner[depth]);
3212 sgmlOpenTag(ofs, depth + 1 + command_depth,
3216 sgmlOpenTag(ofs, depth + 1 + command_depth,
3221 sgmlOpenTag(ofs, depth + command_depth,
3226 simpleDocBookOnePar(ofs, par, desc_on, depth+1+command_depth);
3230 // write closing SGML tags
3231 switch (style.latextype) {
3233 if (c_params.empty())
3237 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3239 case LATEX_ENVIRONMENT:
3240 if (!style.latexparam().empty()) {
3241 if(style.latexparam() == "CDATA")
3244 sgmlCloseTag(ofs, depth + command_depth,
3245 style.latexparam());
3248 case LATEX_ITEM_ENVIRONMENT:
3249 if (desc_on == 1) break;
3251 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3253 case LATEX_PARAGRAPH:
3254 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3257 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3263 for (int d = depth; d >= 0; --d) {
3264 if (!environment_stack[depth].empty()) {
3265 if (environment_inner[depth] != "!-- --") {
3266 item_name = "listitem";
3267 sgmlCloseTag(ofs, command_depth + depth,
3269 if (environment_inner[depth] == "varlistentry")
3270 sgmlCloseTag(ofs, depth + command_depth,
3271 environment_inner[depth]);
3274 sgmlCloseTag(ofs, depth + command_depth,
3275 environment_stack[depth]);
3279 for (int j = command_depth; j >= 0 ; --j)
3280 if (!command_stack[j].empty())
3281 sgmlCloseTag(ofs, j, command_stack[j]);
3284 sgmlCloseTag(ofs, 0, top_element);
3287 // How to check for successful close
3291 void Buffer::simpleDocBookOnePar(ostream & os,
3292 Paragraph * par, int & desc_on,
3293 Paragraph::depth_type depth) const
3295 bool emph_flag = false;
3297 LyXLayout const & style = textclasslist.Style(params.textclass,
3300 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3302 int char_line_count = depth;
3303 //if (!style.free_spacing)
3304 // os << string(depth,' ');
3306 // parsing main loop
3307 for (pos_type i = 0; i < par->size(); ++i) {
3308 LyXFont font = par->getFont(params, i);
3310 // handle <emphasis> tag
3311 if (font_old.emph() != font.emph()) {
3312 if (font.emph() == LyXFont::ON) {
3316 os << "</emphasis>";
3322 if ( par->isInset(i) ) {
3323 Inset * inset = par->getInset(i);
3324 // don't print the inset in position 0 if desc_on == 3 (label)
3325 if ( i || desc_on != 3)
3326 inset->docbook(this, os);
3328 char c = par->getChar(i);
3330 par->sgmlConvertChar(c, sgml_string);
3332 if (style.pass_thru) {
3334 } else if(style.free_spacing || par->isFreeSpacing() || c != ' ') {
3336 } else if (desc_on ==1) {
3338 os << "\n</term><listitem><para>";
3348 os << "</emphasis>";
3351 // resets description flag correctly
3353 // <term> not closed...
3356 if(style.free_spacing) os << '\n';
3360 // This should be enabled when the Chktex class is implemented. (Asger)
3361 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3362 // Other flags: -wall -v0 -x
3363 int Buffer::runChktex()
3365 if (!users->text) return 0;
3367 users->owner()->prohibitInput();
3369 // get LaTeX-Filename
3370 string const name = getLatexName();
3371 string path = OnlyPath(filename);
3373 string const org_path = path;
3374 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3378 Path p(path); // path to LaTeX file
3379 users->owner()->message(_("Running chktex..."));
3381 // Remove all error insets
3382 bool const removedErrorInsets = users->removeAutoInsets();
3384 // Generate the LaTeX file if neccessary
3385 makeLaTeXFile(name, org_path, false);
3388 Chktex chktex(lyxrc.chktex_command, name, filepath);
3389 int res = chktex.run(terr); // run chktex
3392 Alert::alert(_("chktex did not work!"),
3393 _("Could not run with file:"), name);
3394 } else if (res > 0) {
3395 // Insert all errors as errors boxes
3396 users->insertErrors(terr);
3399 // if we removed error insets before we ran chktex or if we inserted
3400 // error insets after we ran chktex, this must be run:
3401 if (removedErrorInsets || res){
3405 users->owner()->allowInput();
3411 void Buffer::validate(LaTeXFeatures & features) const
3413 Paragraph * par = paragraph;
3414 LyXTextClass const & tclass =
3415 textclasslist.TextClass(params.textclass);
3417 // AMS Style is at document level
3418 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3419 features.require("amsstyle");
3422 // We don't use "lyxerr.debug" because of speed. (Asger)
3423 if (lyxerr.debugging(Debug::LATEX))
3424 lyxerr << "Paragraph: " << par << endl;
3426 // Now just follow the list of paragraphs and run
3427 // validate on each of them.
3428 par->validate(features);
3430 // and then the next paragraph
3434 // the bullet shapes are buffer level not paragraph level
3435 // so they are tested here
3436 for (int i = 0; i < 4; ++i) {
3437 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3438 int const font = params.user_defined_bullets[i].getFont();
3440 int const c = params
3441 .user_defined_bullets[i]
3448 features.require("latexsym");
3450 } else if (font == 1) {
3451 features.require("amssymb");
3452 } else if ((font >= 2 && font <= 5)) {
3453 features.require("pifont");
3458 if (lyxerr.debugging(Debug::LATEX)) {
3459 features.showStruct();
3464 // This function should be in Buffer because it's a buffer's property (ale)
3465 string const Buffer::getIncludeonlyList(char delim)
3468 for (inset_iterator it = inset_iterator_begin();
3469 it != inset_iterator_end(); ++it) {
3470 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3471 InsetInclude * insetinc =
3472 static_cast<InsetInclude *>(*it);
3473 if (insetinc->isIncludeOnly()) {
3476 lst += insetinc->getRelFileBaseName();
3480 lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3485 vector<string> const Buffer::getLabelList()
3487 /// if this is a child document and the parent is already loaded
3488 /// Use the parent's list instead [ale990407]
3489 if (!params.parentname.empty()
3490 && bufferlist.exists(params.parentname)) {
3491 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3493 return tmp->getLabelList();
3496 vector<string> label_list;
3497 for (inset_iterator it = inset_iterator_begin();
3498 it != inset_iterator_end(); ++it) {
3499 vector<string> const l = (*it)->getLabelList();
3500 label_list.insert(label_list.end(), l.begin(), l.end());
3506 Buffer::Lists const Buffer::getLists() const
3509 Paragraph * par = paragraph;
3512 std::pair<bool, textclass_type> const tmp =
3513 textclasslist.NumberOfLayout(params.textclass, "Caption");
3514 bool const found = tmp.first;
3515 textclass_type const cap = tmp.second;
3518 // This is the prefered way to to this, but boost::tie can break
3522 boost::tie(found, cap) = textclasslist
3523 .NumberOfLayout(params.textclass, "Caption");
3527 char const labeltype =
3528 textclasslist.Style(params.textclass,
3529 par->getLayout()).labeltype;
3531 if (labeltype >= LABEL_COUNTER_CHAPTER
3532 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3533 // insert this into the table of contents
3534 SingleList & item = l["TOC"];
3537 textclasslist.TextClass(params.textclass).maxcounter());
3538 item.push_back(TocItem(par, depth, par->asString(this, true)));
3540 // For each paragrph, traverse its insets and look for
3544 Paragraph::inset_iterator it =
3545 par->inset_iterator_begin();
3546 Paragraph::inset_iterator end =
3547 par->inset_iterator_end();
3549 for (; it != end; ++it) {
3550 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3552 static_cast<InsetFloat*>(*it);
3554 string const type = il->type();
3556 // Now find the caption in the float...
3557 // We now tranverse the paragraphs of
3559 Paragraph * tmp = il->inset.paragraph();
3561 if (tmp->layout == cap) {
3562 SingleList & item = l[type];
3564 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3565 item.push_back(TocItem(tmp, 0 , str));
3572 lyxerr << "caption not found" << endl;
3581 // This is also a buffer property (ale)
3582 vector<pair<string, string> > const Buffer::getBibkeyList()
3584 /// if this is a child document and the parent is already loaded
3585 /// Use the parent's list instead [ale990412]
3586 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3587 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3589 return tmp->getBibkeyList();
3592 vector<pair<string, string> > keys;
3593 Paragraph * par = paragraph;
3596 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3597 par->asString(this, false)));
3601 // Might be either using bibtex or a child has bibliography
3603 for (inset_iterator it = inset_iterator_begin();
3604 it != inset_iterator_end(); ++it) {
3605 // Search for Bibtex or Include inset
3606 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3607 vector<pair<string,string> > tmp =
3608 static_cast<InsetBibtex*>(*it)->getKeys(this);
3609 keys.insert(keys.end(), tmp.begin(), tmp.end());
3610 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3611 vector<pair<string,string> > const tmp =
3612 static_cast<InsetInclude*>(*it)->getKeys();
3613 keys.insert(keys.end(), tmp.begin(), tmp.end());
3622 bool Buffer::isDepClean(string const & name) const
3624 DEPCLEAN * item = dep_clean;
3625 while (item && item->master != name)
3627 if (!item) return true;
3632 void Buffer::markDepClean(string const & name)
3635 dep_clean = new DEPCLEAN;
3636 dep_clean->clean = true;
3637 dep_clean->master = name;
3638 dep_clean->next = 0;
3640 DEPCLEAN * item = dep_clean;
3641 while (item && item->master != name)
3646 item = new DEPCLEAN;
3648 item->master = name;
3655 bool Buffer::dispatch(string const & command)
3657 // Split command string into command and argument
3659 string line = frontStrip(command);
3660 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3662 return dispatch(lyxaction.LookupFunc(cmd), arg);
3666 bool Buffer::dispatch(int action, string const & argument)
3668 bool dispatched = true;
3671 Exporter::Export(this, argument, false);
3681 void Buffer::resizeInsets(BufferView * bv)
3683 /// then remove all LyXText in text-insets
3684 Paragraph * par = paragraph;
3685 for (; par; par = par->next()) {
3686 par->resizeInsetsLyXText(bv);
3691 void Buffer::redraw()
3698 void Buffer::changeLanguage(Language const * from, Language const * to)
3701 ParIterator end = par_iterator_end();
3702 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3703 (*it)->changeLanguage(params, from, to);
3707 bool Buffer::isMultiLingual()
3709 ParIterator end = par_iterator_end();
3710 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3711 if ((*it)->isMultiLingual(params))
3718 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph, pos_type pos)
3721 it = par->InsetIterator(pos);
3722 if (it == par->inset_iterator_end()) {
3729 void Buffer::inset_iterator::setParagraph()
3732 it = par->inset_iterator_begin();
3733 if (it != par->inset_iterator_end())
3738 // We maintain an invariant that whenever par = 0 then it = 0
3742 Inset * Buffer::getInsetFromID(int id_arg) const
3744 for (inset_iterator it = inset_const_iterator_begin();
3745 it != inset_const_iterator_end(); ++it)
3747 if ((*it)->id() == id_arg)
3749 Inset * in = (*it)->getInsetFromID(id_arg);
3757 Paragraph * Buffer::getParFromID(int id) const
3759 if (id < 0) return 0;
3760 Paragraph * par = paragraph;
3762 if (par->id() == id) {
3765 Paragraph * tmp = par->getParFromID(id);
3775 ParIterator Buffer::par_iterator_begin()
3777 return ParIterator(paragraph);
3781 ParIterator Buffer::par_iterator_end()
3783 return ParIterator();