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 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, LyXFont(LyXFont::ALL_INHERIT,
1188 #ifndef NO_COMPABILITY
1193 #ifndef NO_COMPABILITY
1194 #ifndef NO_PEXTRA_REALLY
1195 // I wonder if we could use this blanket fix for all the
1196 // checkminipage cases...
1197 if (par && par->size()) {
1198 // It is possible that this will check to often,
1199 // but that should not be an correctness issue.
1200 // Only a speed issue.
1201 checkminipage = true;
1204 // now check if we have a minipage paragraph as at this
1205 // point we already read all the necessary data!
1206 // this cannot be done in layout because there we did
1207 // not read yet the paragraph PEXTRA-params (Jug)
1209 // BEGIN pextra_minipage compability
1210 // This should be removed in 1.3.x (Lgb)
1212 // This compability code is not perfect. In a couple
1213 // of rand cases it fails. When the minipage par is
1214 // the first par in the document, and when there are
1215 // none or only one regular paragraphs after the
1216 // minipage. Currently I am not investing any effort
1217 // in fixing those cases.
1219 //lyxerr << "Call depth: " << call_depth << endl;
1220 if (checkminipage && (call_depth == 1)) {
1221 checkminipage = false;
1222 if (minipar && (minipar != par) &&
1223 (par->params().pextraType()==Paragraph::PEXTRA_MINIPAGE))
1225 lyxerr << "minipages in a row" << endl;
1226 if (par->params().pextraStartMinipage()) {
1227 lyxerr << "start new minipage" << endl;
1228 // minipages in a row
1229 par->previous()->next(0);
1232 Paragraph * tmp = minipar;
1234 tmp->params().pextraType(0);
1235 tmp->params().pextraWidth(string());
1236 tmp->params().pextraWidthp(string());
1237 tmp->params().pextraAlignment(0);
1238 tmp->params().pextraHfill(false);
1239 tmp->params().pextraStartMinipage(false);
1242 // create a new paragraph to insert the
1243 // minipages in the following case
1244 if (par->params().pextraStartMinipage() &&
1245 !par->params().pextraHfill())
1247 Paragraph * p = new Paragraph;
1249 p->previous(parBeforeMinipage);
1250 parBeforeMinipage->next(p);
1252 p->params().depth(parBeforeMinipage->params().depth());
1253 parBeforeMinipage = p;
1255 InsetMinipage * mini = new InsetMinipage;
1256 mini->pos(static_cast<InsetMinipage::Position>(par->params().pextraAlignment()));
1257 mini->width(par->params().pextraWidth());
1258 if (!par->params().pextraWidthp().empty()) {
1259 lyxerr << "WP:" << mini->width() << endl;
1260 mini->width(tostr(par->params().pextraWidthp())+"%");
1262 mini->inset.paragraph(par);
1263 // Insert the minipage last in the
1264 // previous paragraph.
1265 if (par->params().pextraHfill()) {
1266 parBeforeMinipage->insertChar
1267 (parBeforeMinipage->size(), Paragraph::META_HFILL);
1269 parBeforeMinipage->insertInset
1270 (parBeforeMinipage->size(), mini);
1274 lyxerr << "new minipage par" << endl;
1275 //nothing to do just continue reading
1278 } else if (minipar && (minipar != par)) {
1279 lyxerr << "last minipage par read" << endl;
1280 // The last paragraph read was not part of a
1281 // minipage but the par linked list is...
1282 // So we need to remove the last par from the
1284 if (par->previous())
1285 par->previous()->next(0);
1286 par->previous(parBeforeMinipage);
1287 parBeforeMinipage->next(par);
1288 Paragraph * tmp = minipar;
1290 tmp->params().pextraType(0);
1291 tmp->params().pextraWidth(string());
1292 tmp->params().pextraWidthp(string());
1293 tmp->params().pextraAlignment(0);
1294 tmp->params().pextraHfill(false);
1295 tmp->params().pextraStartMinipage(false);
1298 depth = parBeforeMinipage->params().depth();
1299 minipar = parBeforeMinipage = 0;
1300 } else if (!minipar &&
1301 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1303 // par is the first paragraph in a minipage
1304 lyxerr << "begin minipage" << endl;
1305 // To minimize problems for
1306 // the users we will insert
1307 // the first minipage in
1308 // a sequence of minipages
1309 // in its own paragraph.
1310 Paragraph * p = new Paragraph;
1312 p->previous(par->previous());
1314 p->params().depth(depth);
1315 par->params().depth(0);
1317 if (par->previous())
1318 par->previous()->next(p);
1320 parBeforeMinipage = p;
1322 if (!first_par || (first_par == par))
1325 InsetMinipage * mini = new InsetMinipage;
1326 mini->pos(static_cast<InsetMinipage::Position>(minipar->params().pextraAlignment()));
1327 mini->width(minipar->params().pextraWidth());
1328 if (!par->params().pextraWidthp().empty()) {
1329 lyxerr << "WP:" << mini->width() << endl;
1330 mini->width(tostr(par->params().pextraWidthp())+"%");
1332 mini->inset.paragraph(minipar);
1334 // Insert the minipage last in the
1335 // previous paragraph.
1336 if (minipar->params().pextraHfill()) {
1337 parBeforeMinipage->insertChar
1338 (parBeforeMinipage->size(),Paragraph::META_HFILL);
1340 parBeforeMinipage->insertInset
1341 (parBeforeMinipage->size(), mini);
1344 // End of pextra_minipage compability
1348 return the_end_read;
1351 // needed to insert the selection
1352 void Buffer::insertStringAsLines(Paragraph *& par, pos_type & pos,
1353 LyXFont const & fn,string const & str) const
1355 LyXLayout const & layout = textclasslist.Style(params.textclass,
1359 (void)par->checkInsertChar(font);
1360 // insert the string, don't insert doublespace
1361 bool space_inserted = true;
1362 for(string::const_iterator cit = str.begin();
1363 cit != str.end(); ++cit) {
1365 if (par->size() || layout.keepempty) {
1366 par->breakParagraph(params, pos,
1367 layout.isEnvironment());
1370 space_inserted = true;
1374 // do not insert consecutive spaces if !free_spacing
1375 } else if ((*cit == ' ' || *cit == '\t') &&
1376 space_inserted && !layout.free_spacing &&
1377 !par->isFreeSpacing())
1380 } else if (*cit == '\t') {
1381 if (!layout.free_spacing && !par->isFreeSpacing()) {
1382 // tabs are like spaces here
1383 par->insertChar(pos, ' ', font);
1385 space_inserted = true;
1387 const pos_type nb = 8 - pos % 8;
1388 for (pos_type a = 0; a < nb ; ++a) {
1389 par->insertChar(pos, ' ', font);
1392 space_inserted = true;
1394 } else if (!IsPrintable(*cit)) {
1395 // Ignore unprintables
1398 // just insert the character
1399 par->insertChar(pos, *cit, font);
1401 space_inserted = (*cit == ' ');
1408 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1409 int & pos, LyXFont & font)
1411 // consistency check
1412 if (lex.getString() != "\\begin_inset") {
1413 lyxerr << "Buffer::readInset: Consistency check failed."
1420 string const tmptok = lex.getString();
1421 last_inset_read = tmptok;
1423 // test the different insets
1424 if (tmptok == "LatexCommand") {
1425 InsetCommandParams inscmd;
1428 string const cmdName = inscmd.getCmdName();
1430 // This strange command allows LyX to recognize "natbib" style
1431 // citations: citet, citep, Citet etc.
1432 if (compare_no_case(cmdName, "cite", 4) == 0) {
1433 inset = new InsetCitation(inscmd);
1434 } else if (cmdName == "bibitem") {
1435 lex.printError("Wrong place for bibitem");
1436 inset = new InsetBibKey(inscmd);
1437 } else if (cmdName == "BibTeX") {
1438 inset = new InsetBibtex(inscmd);
1439 } else if (cmdName == "index") {
1440 inset = new InsetIndex(inscmd);
1441 } else if (cmdName == "include") {
1442 inset = new InsetInclude(inscmd, *this);
1443 } else if (cmdName == "label") {
1444 inset = new InsetLabel(inscmd);
1445 } else if (cmdName == "url"
1446 || cmdName == "htmlurl") {
1447 inset = new InsetUrl(inscmd);
1448 } else if (cmdName == "ref"
1449 || cmdName == "pageref"
1450 || cmdName == "vref"
1451 || cmdName == "vpageref"
1452 || cmdName == "prettyref") {
1453 if (!inscmd.getOptions().empty()
1454 || !inscmd.getContents().empty()) {
1455 inset = new InsetRef(inscmd, *this);
1457 } else if (cmdName == "tableofcontents") {
1458 inset = new InsetTOC(inscmd);
1459 } else if (cmdName == "listofalgorithms") {
1460 inset = new InsetFloatList("algorithm");
1461 } else if (cmdName == "listoffigures") {
1462 inset = new InsetFloatList("figure");
1463 } else if (cmdName == "listoftables") {
1464 inset = new InsetFloatList("table");
1465 } else if (cmdName == "printindex") {
1466 inset = new InsetPrintIndex(inscmd);
1467 } else if (cmdName == "lyxparent") {
1468 inset = new InsetParent(inscmd, *this);
1471 bool alreadyread = false;
1472 if (tmptok == "Quotes") {
1473 inset = new InsetQuotes;
1474 } else if (tmptok == "External") {
1475 inset = new InsetExternal;
1476 } else if (tmptok == "FormulaMacro") {
1477 inset = new InsetFormulaMacro;
1478 } else if (tmptok == "Formula") {
1479 inset = new InsetFormula;
1480 } else if (tmptok == "Figure") { // Backward compatibility
1481 inset = new InsetFig(100, 100, *this);
1482 //inset = new InsetGraphics;
1483 } else if (tmptok == "Graphics") {
1484 inset = new InsetGraphics;
1485 } else if (tmptok == "Info") {// backwards compatibility
1486 inset = new InsetNote(this,
1487 lex.getLongString("\\end_inset"),
1490 } else if (tmptok == "Note") {
1491 inset = new InsetNote;
1492 } else if (tmptok == "Include") {
1493 InsetCommandParams p( "Include" );
1494 inset = new InsetInclude(p, *this);
1495 } else if (tmptok == "ERT") {
1496 inset = new InsetERT;
1497 } else if (tmptok == "Tabular") {
1498 inset = new InsetTabular(*this);
1499 } else if (tmptok == "Text") {
1500 inset = new InsetText;
1501 } else if (tmptok == "Foot") {
1502 inset = new InsetFoot;
1503 } else if (tmptok == "Marginal") {
1504 inset = new InsetMarginal;
1505 } else if (tmptok == "Minipage") {
1506 inset = new InsetMinipage;
1507 } else if (tmptok == "Float") {
1509 string tmptok = lex.getString();
1510 inset = new InsetFloat(tmptok);
1512 } else if (tmptok == "List") {
1513 inset = new InsetList;
1514 } else if (tmptok == "Theorem") {
1515 inset = new InsetList;
1517 } else if (tmptok == "Caption") {
1518 inset = new InsetCaption;
1519 } else if (tmptok == "FloatList") {
1520 inset = new InsetFloatList;
1523 if (inset && !alreadyread) inset->read(this, lex);
1527 par->insertInset(pos, inset, font);
1533 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1537 string const token(lex.getString());
1538 if (token == "\\lyxformat") { // the first token _must_ be...
1540 string tmp_format = lex.getString();
1541 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1542 // if present remove ".," from string.
1543 string::size_type dot = tmp_format.find_first_of(".,");
1544 //lyxerr << " dot found at " << dot << endl;
1545 if (dot != string::npos)
1546 tmp_format.erase(dot, 1);
1547 file_format = strToInt(tmp_format);
1548 if (file_format == LYX_FORMAT) {
1550 } else if (file_format > LYX_FORMAT) {
1552 Alert::alert(_("Warning!"),
1553 _("LyX file format is newer that what"),
1554 _("is supported in this LyX version. Expect some problems."));
1556 } else if (file_format < LYX_FORMAT) {
1558 if (file_format < 200) {
1559 Alert::alert(_("ERROR!"),
1560 _("Old LyX file format found. "
1561 "Use LyX 0.10.x to read this!"));
1565 bool the_end = readLyXformat2(lex, par);
1566 params.setPaperStuff();
1567 // the_end was added in 213
1568 if (file_format < 213)
1572 Alert::alert(_("Warning!"),
1573 _("Reading of document is not complete"),
1574 _("Maybe the document is truncated"));
1577 } else { // "\\lyxformat" not found
1578 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1581 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1586 // Should probably be moved to somewhere else: BufferView? LyXView?
1587 bool Buffer::save() const
1589 // We don't need autosaves in the immediate future. (Asger)
1590 resetAutosaveTimers();
1594 if (lyxrc.make_backup) {
1595 s = fileName() + '~';
1596 if (!lyxrc.backupdir_path.empty())
1597 s = AddName(lyxrc.backupdir_path,
1598 subst(os::slashify_path(s),'/','!'));
1600 // Rename is the wrong way of making a backup,
1601 // this is the correct way.
1602 /* truss cp fil fil2:
1603 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1604 stat("LyXVC.lyx", 0xEFFFF688) = 0
1605 open("LyXVC.lyx", O_RDONLY) = 3
1606 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1607 fstat(4, 0xEFFFF508) = 0
1608 fstat(3, 0xEFFFF508) = 0
1609 read(3, " # T h i s f i l e w".., 8192) = 5579
1610 write(4, " # T h i s f i l e w".., 5579) = 5579
1611 read(3, 0xEFFFD4A0, 8192) = 0
1614 chmod("LyXVC3.lyx", 0100644) = 0
1615 lseek(0, 0, SEEK_CUR) = 46440
1619 // Should probably have some more error checking here.
1620 // Should be cleaned up in 0.13, at least a bit.
1621 // Doing it this way, also makes the inodes stay the same.
1622 // This is still not a very good solution, in particular we
1623 // might loose the owner of the backup.
1624 FileInfo finfo(fileName());
1625 if (finfo.exist()) {
1626 mode_t fmode = finfo.getMode();
1627 struct utimbuf times = {
1628 finfo.getAccessTime(),
1629 finfo.getModificationTime() };
1631 ifstream ifs(fileName().c_str());
1632 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1637 ::chmod(s.c_str(), fmode);
1639 if (::utime(s.c_str(), ×)) {
1640 lyxerr << "utime error." << endl;
1643 lyxerr << "LyX was not able to make "
1644 "backup copy. Beware." << endl;
1649 if (writeFile(fileName(), false)) {
1651 removeAutosaveFile(fileName());
1653 // Saving failed, so backup is not backup
1654 if (lyxrc.make_backup) {
1655 lyx::rename(s, fileName());
1663 // Returns false if unsuccesful
1664 bool Buffer::writeFile(string const & fname, bool flag) const
1666 // if flag is false writeFile will not create any GUI
1667 // warnings, only cerr.
1668 // Needed for autosave in background or panic save (Matthias 120496)
1670 if (read_only && (fname == filename)) {
1671 // Here we should come with a question if we should
1672 // perform the write anyway.
1674 lyxerr << _("Error! Document is read-only: ")
1677 Alert::alert(_("Error! Document is read-only: "),
1682 FileInfo finfo(fname);
1683 if (finfo.exist() && !finfo.writable()) {
1684 // Here we should come with a question if we should
1685 // try to do the save anyway. (i.e. do a chmod first)
1687 lyxerr << _("Error! Cannot write file: ")
1690 Alert::err_alert(_("Error! Cannot write file: "),
1695 ofstream ofs(fname.c_str());
1698 lyxerr << _("Error! Cannot open file: ")
1701 Alert::err_alert(_("Error! Cannot open file: "),
1707 // Use the standard "C" locale for file output.
1708 ofs.imbue(std::locale::classic());
1711 // The top of the file should not be written by params.
1713 // write out a comment in the top of the file
1714 ofs << '#' << lyx_docversion
1715 << " created this file. For more info see http://www.lyx.org/\n"
1716 << "\\lyxformat " << LYX_FORMAT << "\n";
1718 // now write out the buffer paramters.
1719 params.writeFile(ofs);
1721 Paragraph::depth_type depth = 0;
1723 // this will write out all the paragraphs
1724 // using recursive descent.
1725 paragraph->writeFile(this, ofs, params, depth);
1727 // Write marker that shows file is complete
1728 ofs << "\n\\the_end" << endl;
1732 // how to check if close went ok?
1733 // Following is an attempt... (BE 20001011)
1735 // good() returns false if any error occured, including some
1736 // formatting error.
1737 // bad() returns true if something bad happened in the buffer,
1738 // which should include file system full errors.
1745 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1747 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1757 string const Buffer::asciiParagraph(Paragraph const * par,
1758 unsigned int linelen) const
1760 ostringstream buffer;
1761 Paragraph::depth_type depth = 0;
1763 Paragraph::depth_type ltype_depth = 0;
1764 string::size_type currlinelen = 0;
1765 bool ref_printed = false;
1769 if (!par->previous()) {
1770 // begins or ends a deeper area ?
1771 if (depth != par->params().depth()) {
1772 if (par->params().depth() > depth) {
1773 while (par->params().depth() > depth) {
1777 while (par->params().depth() < depth) {
1783 // First write the layout
1784 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1785 if (tmp == "Itemize") {
1787 ltype_depth = depth + 1;
1788 } else if (tmp == "Enumerate") {
1790 ltype_depth = depth + 1;
1791 } else if (contains(tmp, "ection")) {
1793 ltype_depth = depth + 1;
1794 } else if (contains(tmp, "aragraph")) {
1796 ltype_depth = depth + 1;
1797 } else if (tmp == "Description") {
1799 ltype_depth = depth + 1;
1800 } else if (tmp == "Abstract") {
1803 } else if (tmp == "Bibliography") {
1811 /* maybe some vertical spaces */
1813 /* the labelwidthstring used in lists */
1817 /* some pagebreaks? */
1821 /* what about the alignment */
1823 lyxerr << "Should this ever happen?" << endl;
1826 for (pos_type i = 0; i < par->size(); ++i) {
1827 if (!i && !noparbreak) {
1830 for (Paragraph::depth_type j = 0; j < depth; ++j)
1832 currlinelen = depth * 2;
1835 case 4: // (Sub)Paragraph
1836 case 5: // Description
1840 buffer << "Abstract\n\n";
1842 buffer << "Abstract: ";
1844 case 7: // Bibliography
1847 buffer << "References\n\n";
1849 buffer << "References: ";
1854 buffer << par->params().labelString() << " ";
1857 if (ltype_depth > depth) {
1858 for (Paragraph::depth_type j = ltype_depth - 1;
1861 currlinelen += (ltype_depth-depth)*2;
1865 char c = par->getUChar(params, i);
1869 case Paragraph::META_INSET:
1871 Inset const * inset = par->getInset(i);
1873 if (!inset->ascii(this, buffer)) {
1876 rsplit(buffer.str().c_str(),
1878 currlinelen += s.length();
1880 // to be sure it breaks paragraph
1881 currlinelen += linelen;
1887 case Paragraph::META_NEWLINE:
1890 for (Paragraph::depth_type j = 0;
1894 currlinelen = depth * 2;
1895 if (ltype_depth > depth) {
1896 for (Paragraph::depth_type j = ltype_depth;
1899 currlinelen += (ltype_depth - depth) * 2;
1903 case Paragraph::META_HFILL:
1908 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1909 (c == ' ') && ((i + 2) < par->size()))
1912 for (Paragraph::depth_type j = 0;
1915 currlinelen = depth * 2;
1916 if (ltype_depth > depth) {
1917 for (Paragraph::depth_type j = ltype_depth;
1920 currlinelen += (ltype_depth-depth)*2;
1922 } else if (c != '\0') {
1926 lyxerr[Debug::INFO] << "writeAsciiFile: NULL char in structure." << endl;
1930 return buffer.str().c_str();
1934 void Buffer::writeFileAscii(string const & fname, int linelen)
1936 ofstream ofs(fname.c_str());
1938 Alert::err_alert(_("Error: Cannot write file:"), fname);
1941 writeFileAscii(ofs, linelen);
1945 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1947 Paragraph * par = paragraph;
1949 ofs << asciiParagraph(par, linelen);
1957 void Buffer::makeLaTeXFile(string const & fname,
1958 string const & original_path,
1959 bool nice, bool only_body)
1961 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1963 niceFile = nice; // this will be used by Insetincludes.
1965 tex_code_break_column = lyxrc.ascii_linelen;
1967 LyXTextClass const & tclass =
1968 textclasslist.TextClass(params.textclass);
1970 ofstream ofs(fname.c_str());
1972 Alert::err_alert(_("Error: Cannot open file: "), fname);
1976 // validate the buffer.
1977 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1978 LaTeXFeatures features(params, tclass.numLayouts());
1980 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1983 // The starting paragraph of the coming rows is the
1984 // first paragraph of the document. (Asger)
1985 texrow.start(paragraph, 0);
1987 if (!only_body && nice) {
1988 ofs << "%% " << lyx_docversion << " created this file. "
1989 "For more info, see http://www.lyx.org/.\n"
1990 "%% Do not edit unless you really know what "
1995 lyxerr[Debug::INFO] << "lyx header finished" << endl;
1996 // There are a few differences between nice LaTeX and usual files:
1997 // usual is \batchmode and has a
1998 // special input@path to allow the including of figures
1999 // with either \input or \includegraphics (what figinsets do).
2000 // batchmode is not set if there is a tex_code_break_column.
2001 // In this case somebody is interested in the generated LaTeX,
2002 // so this is OK. input@path is set when the actual parameter
2003 // original_path is set. This is done for usual tex-file, but not
2004 // for nice-latex-file. (Matthias 250696)
2007 // code for usual, NOT nice-latex-file
2008 ofs << "\\batchmode\n"; // changed
2009 // from \nonstopmode
2012 if (!original_path.empty()) {
2013 ofs << "\\makeatletter\n"
2014 << "\\def\\input@path{{"
2015 << os::external_path(original_path) << "/}}\n"
2016 << "\\makeatother\n";
2022 ofs << "\\documentclass";
2024 ostringstream options; // the document class options.
2026 if (tokenPos(tclass.opt_fontsize(),
2027 '|', params.fontsize) >= 0) {
2028 // only write if existing in list (and not default)
2029 options << params.fontsize << "pt,";
2033 if (!params.use_geometry &&
2034 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2035 switch (params.papersize) {
2036 case BufferParams::PAPER_A4PAPER:
2037 options << "a4paper,";
2039 case BufferParams::PAPER_USLETTER:
2040 options << "letterpaper,";
2042 case BufferParams::PAPER_A5PAPER:
2043 options << "a5paper,";
2045 case BufferParams::PAPER_B5PAPER:
2046 options << "b5paper,";
2048 case BufferParams::PAPER_EXECUTIVEPAPER:
2049 options << "executivepaper,";
2051 case BufferParams::PAPER_LEGALPAPER:
2052 options << "legalpaper,";
2058 if (params.sides != tclass.sides()) {
2059 switch (params.sides) {
2060 case LyXTextClass::OneSide:
2061 options << "oneside,";
2063 case LyXTextClass::TwoSides:
2064 options << "twoside,";
2070 if (params.columns != tclass.columns()) {
2071 if (params.columns == 2)
2072 options << "twocolumn,";
2074 options << "onecolumn,";
2077 if (!params.use_geometry
2078 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2079 options << "landscape,";
2081 // language should be a parameter to \documentclass
2083 ostringstream language_options;
2084 if (params.language->babel() == "hebrew"
2085 && default_language->babel() != "hebrew")
2086 // This seems necessary
2087 features.useLanguage(default_language);
2089 if (lyxrc.language_use_babel ||
2090 params.language->lang() != lyxrc.default_language ||
2091 !features.hasLanguages()) {
2093 language_options << features.getLanguages();
2094 language_options << params.language->babel();
2095 if (lyxrc.language_global_options)
2096 options << language_options.str() << ',';
2099 // the user-defined options
2100 if (!params.options.empty()) {
2101 options << params.options << ',';
2104 string strOptions(options.str().c_str());
2105 if (!strOptions.empty()){
2106 strOptions = strip(strOptions, ',');
2107 ofs << '[' << strOptions << ']';
2111 << textclasslist.LatexnameOfClass(params.textclass)
2114 // end of \documentclass defs
2116 // font selection must be done before loading fontenc.sty
2117 // The ae package is not needed when using OT1 font encoding.
2118 if (params.fonts != "default" &&
2119 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2120 ofs << "\\usepackage{" << params.fonts << "}\n";
2122 if (params.fonts == "ae") {
2123 ofs << "\\usepackage{aecompl}\n";
2127 // this one is not per buffer
2128 if (lyxrc.fontenc != "default") {
2129 ofs << "\\usepackage[" << lyxrc.fontenc
2134 if (params.inputenc == "auto") {
2135 string const doc_encoding =
2136 params.language->encoding()->LatexName();
2138 // Create a list with all the input encodings used
2140 set<string> encodings = features.getEncodingSet(doc_encoding);
2142 ofs << "\\usepackage[";
2143 std::copy(encodings.begin(), encodings.end(),
2144 std::ostream_iterator<string>(ofs, ","));
2145 ofs << doc_encoding << "]{inputenc}\n";
2147 } else if (params.inputenc != "default") {
2148 ofs << "\\usepackage[" << params.inputenc
2153 // At the very beginning the text parameters.
2154 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2155 switch (params.paperpackage) {
2156 case BufferParams::PACKAGE_A4:
2157 ofs << "\\usepackage{a4}\n";
2160 case BufferParams::PACKAGE_A4WIDE:
2161 ofs << "\\usepackage{a4wide}\n";
2164 case BufferParams::PACKAGE_WIDEMARGINSA4:
2165 ofs << "\\usepackage[widemargins]{a4}\n";
2170 if (params.use_geometry) {
2171 ofs << "\\usepackage{geometry}\n";
2173 ofs << "\\geometry{verbose";
2174 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2175 ofs << ",landscape";
2176 switch (params.papersize2) {
2177 case BufferParams::VM_PAPER_CUSTOM:
2178 if (!params.paperwidth.empty())
2179 ofs << ",paperwidth="
2180 << params.paperwidth;
2181 if (!params.paperheight.empty())
2182 ofs << ",paperheight="
2183 << params.paperheight;
2185 case BufferParams::VM_PAPER_USLETTER:
2186 ofs << ",letterpaper";
2188 case BufferParams::VM_PAPER_USLEGAL:
2189 ofs << ",legalpaper";
2191 case BufferParams::VM_PAPER_USEXECUTIVE:
2192 ofs << ",executivepaper";
2194 case BufferParams::VM_PAPER_A3:
2197 case BufferParams::VM_PAPER_A4:
2200 case BufferParams::VM_PAPER_A5:
2203 case BufferParams::VM_PAPER_B3:
2206 case BufferParams::VM_PAPER_B4:
2209 case BufferParams::VM_PAPER_B5:
2213 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2214 switch (lyxrc.default_papersize) {
2215 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2216 case BufferParams::PAPER_USLETTER:
2217 ofs << ",letterpaper";
2219 case BufferParams::PAPER_LEGALPAPER:
2220 ofs << ",legalpaper";
2222 case BufferParams::PAPER_EXECUTIVEPAPER:
2223 ofs << ",executivepaper";
2225 case BufferParams::PAPER_A3PAPER:
2228 case BufferParams::PAPER_A4PAPER:
2231 case BufferParams::PAPER_A5PAPER:
2234 case BufferParams::PAPER_B5PAPER:
2239 if (!params.topmargin.empty())
2240 ofs << ",tmargin=" << params.topmargin;
2241 if (!params.bottommargin.empty())
2242 ofs << ",bmargin=" << params.bottommargin;
2243 if (!params.leftmargin.empty())
2244 ofs << ",lmargin=" << params.leftmargin;
2245 if (!params.rightmargin.empty())
2246 ofs << ",rmargin=" << params.rightmargin;
2247 if (!params.headheight.empty())
2248 ofs << ",headheight=" << params.headheight;
2249 if (!params.headsep.empty())
2250 ofs << ",headsep=" << params.headsep;
2251 if (!params.footskip.empty())
2252 ofs << ",footskip=" << params.footskip;
2257 if (features.isRequired("amsstyle")
2258 && !tclass.provides(LyXTextClass::amsmath)) {
2259 ofs << "\\usepackage{amsmath}\n";
2263 if (tokenPos(tclass.opt_pagestyle(),
2264 '|', params.pagestyle) >= 0) {
2265 if (params.pagestyle == "fancy") {
2266 ofs << "\\usepackage{fancyhdr}\n";
2269 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2273 if (params.secnumdepth != tclass.secnumdepth()) {
2274 ofs << "\\setcounter{secnumdepth}{"
2275 << params.secnumdepth
2279 if (params.tocdepth != tclass.tocdepth()) {
2280 ofs << "\\setcounter{tocdepth}{"
2286 if (params.paragraph_separation) {
2287 switch (params.defskip.kind()) {
2288 case VSpace::SMALLSKIP:
2289 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2291 case VSpace::MEDSKIP:
2292 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2294 case VSpace::BIGSKIP:
2295 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2297 case VSpace::LENGTH:
2298 ofs << "\\setlength\\parskip{"
2299 << params.defskip.length().asLatexString()
2302 default: // should never happen // Then delete it.
2303 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2308 ofs << "\\setlength\\parindent{0pt}\n";
2312 // Now insert the LyX specific LaTeX commands...
2314 // The optional packages;
2315 string preamble(features.getPackages());
2317 // this might be useful...
2318 preamble += "\n\\makeatletter\n";
2320 // Some macros LyX will need
2321 string tmppreamble(features.getMacros());
2323 if (!tmppreamble.empty()) {
2324 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2325 "LyX specific LaTeX commands.\n"
2326 + tmppreamble + '\n';
2329 // the text class specific preamble
2330 tmppreamble = features.getTClassPreamble();
2331 if (!tmppreamble.empty()) {
2332 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2333 "Textclass specific LaTeX commands.\n"
2334 + tmppreamble + '\n';
2337 /* the user-defined preamble */
2338 if (!params.preamble.empty()) {
2339 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2340 "User specified LaTeX commands.\n"
2341 + params.preamble + '\n';
2344 preamble += "\\makeatother\n";
2346 // Itemize bullet settings need to be last in case the user
2347 // defines their own bullets that use a package included
2348 // in the user-defined preamble -- ARRae
2349 // Actually it has to be done much later than that
2350 // since some packages like frenchb make modifications
2351 // at \begin{document} time -- JMarc
2353 for (int i = 0; i < 4; ++i) {
2354 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2355 if (bullets_def.empty())
2356 bullets_def="\\AtBeginDocument{\n";
2357 bullets_def += " \\renewcommand{\\labelitemi";
2359 // `i' is one less than the item to modify
2366 bullets_def += "ii";
2372 bullets_def += "}{" +
2373 params.user_defined_bullets[i].getText()
2378 if (!bullets_def.empty())
2379 preamble += bullets_def + "}\n\n";
2381 for (int j = countChar(preamble, '\n'); j-- ;) {
2387 // We try to load babel late, in case it interferes
2388 // with other packages.
2390 string tmp = lyxrc.language_package;
2391 if (!lyxrc.language_global_options
2392 && tmp == "\\usepackage{babel}")
2393 tmp = string("\\usepackage[") +
2394 language_options.str().c_str() +
2401 ofs << "\\begin{document}\n";
2404 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2406 if (!lyxrc.language_auto_begin) {
2407 ofs << subst(lyxrc.language_command_begin, "$$lang",
2408 params.language->babel())
2413 latexParagraphs(ofs, paragraph, 0, texrow);
2415 // add this just in case after all the paragraphs
2419 if (!lyxrc.language_auto_end) {
2420 ofs << subst(lyxrc.language_command_end, "$$lang",
2421 params.language->babel())
2427 ofs << "\\end{document}\n";
2430 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2432 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2436 // Just to be sure. (Asger)
2439 // tex_code_break_column's value is used to decide
2440 // if we are in batchmode or not (within mathed_write()
2441 // in math_write.C) so we must set it to a non-zero
2442 // value when we leave otherwise we save incorrect .lyx files.
2443 tex_code_break_column = lyxrc.ascii_linelen;
2447 lyxerr << "File was not closed properly." << endl;
2450 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2451 lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2456 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2458 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2459 Paragraph * endpar, TexRow & texrow) const
2461 bool was_title = false;
2462 bool already_title = false;
2465 while (par != endpar) {
2466 LyXLayout const & layout =
2467 textclasslist.Style(params.textclass,
2470 if (layout.intitle) {
2471 if (already_title) {
2472 lyxerr <<"Error in latexParagraphs: You"
2473 " should not mix title layouts"
2474 " with normal ones." << endl;
2477 } else if (was_title && !already_title) {
2478 ofs << "\\maketitle\n";
2480 already_title = true;
2484 if (layout.isEnvironment()) {
2485 par = par->TeXEnvironment(this, params, ofs, texrow);
2487 par = par->TeXOnePar(this, params, ofs, texrow, false);
2490 // It might be that we only have a title in this document
2491 if (was_title && !already_title) {
2492 ofs << "\\maketitle\n";
2498 bool Buffer::isLatex() const
2500 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2504 bool Buffer::isLinuxDoc() const
2506 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2510 bool Buffer::isLiterate() const
2512 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2516 bool Buffer::isDocBook() const
2518 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2522 bool Buffer::isSGML() const
2524 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2525 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2529 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth,
2530 string const & latexname) const
2532 if (!latexname.empty() && latexname != "!-- --")
2533 //os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2534 os << string(depth, ' ') << "<" << latexname << ">\n";
2538 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth,
2539 string const & latexname) const
2541 if (!latexname.empty() && latexname != "!-- --")
2542 //os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2543 os << string(depth, ' ') << "</" << latexname << ">\n";
2547 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2549 ofstream ofs(fname.c_str());
2552 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2556 niceFile = nice; // this will be used by included files.
2558 LyXTextClass const & tclass =
2559 textclasslist.TextClass(params.textclass);
2561 LaTeXFeatures features(params, tclass.numLayouts());
2566 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2569 ofs << "<!doctype linuxdoc system";
2571 string preamble = params.preamble;
2572 preamble += features.getIncludedFiles(fname);
2573 preamble += features.getLyXSGMLEntities();
2575 if (!preamble.empty()) {
2576 ofs << " [ " << preamble << " ]";
2580 if (params.options.empty())
2581 sgmlOpenTag(ofs, 0, top_element);
2583 string top = top_element;
2585 top += params.options;
2586 sgmlOpenTag(ofs, 0, top);
2590 ofs << "<!-- " << lyx_docversion
2591 << " created this file. For more info see http://www.lyx.org/"
2594 Paragraph::depth_type depth = 0; // paragraph depth
2595 Paragraph * par = paragraph;
2597 vector<string> environment_stack(5);
2600 LyXLayout const & style =
2601 textclasslist.Style(params.textclass,
2604 // treat <toc> as a special case for compatibility with old code
2605 if (par->isInset(0)) {
2606 Inset * inset = par->getInset(0);
2607 Inset::Code lyx_code = inset->lyxCode();
2608 if (lyx_code == Inset::TOC_CODE){
2609 string const temp = "toc";
2610 sgmlOpenTag(ofs, depth, temp);
2617 // environment tag closing
2618 for (; depth > par->params().depth(); --depth) {
2619 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2620 environment_stack[depth].erase();
2623 // write opening SGML tags
2624 switch (style.latextype) {
2625 case LATEX_PARAGRAPH:
2626 if (depth == par->params().depth()
2627 && !environment_stack[depth].empty()) {
2628 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2629 environment_stack[depth].erase();
2635 sgmlOpenTag(ofs, depth, style.latexname());
2641 _("Error : Wrong depth for"
2642 " LatexType Command.\n"));
2644 if (!environment_stack[depth].empty()){
2645 sgmlCloseTag(ofs, depth,
2646 environment_stack[depth]);
2650 environment_stack[depth].erase();
2651 sgmlOpenTag(ofs, depth, style.latexname());
2654 case LATEX_ENVIRONMENT:
2655 case LATEX_ITEM_ENVIRONMENT:
2656 if (depth == par->params().depth()
2657 && environment_stack[depth] != style.latexname()) {
2658 sgmlCloseTag(ofs, depth,
2659 environment_stack[depth]);
2660 environment_stack[depth].erase();
2662 if (depth < par->params().depth()) {
2663 depth = par->params().depth();
2664 environment_stack[depth].erase();
2666 if (environment_stack[depth] != style.latexname()) {
2668 sgmlOpenTag(ofs, depth, "p");
2670 sgmlOpenTag(ofs, depth, style.latexname());
2672 if (environment_stack.size() == depth + 1)
2673 environment_stack.push_back("!-- --");
2674 environment_stack[depth] = style.latexname();
2677 if (style.latexparam() == "CDATA")
2680 if (style.latextype == LATEX_ENVIRONMENT) break;
2682 if (style.labeltype == LABEL_MANUAL)
2687 sgmlOpenTag(ofs, depth + 1, item_name);
2690 sgmlOpenTag(ofs, depth, style.latexname());
2694 simpleLinuxDocOnePar(ofs, par, depth);
2699 // write closing SGML tags
2700 switch (style.latextype) {
2703 case LATEX_ENVIRONMENT:
2704 case LATEX_ITEM_ENVIRONMENT:
2705 if (style.latexparam() == "CDATA")
2709 sgmlCloseTag(ofs, depth, style.latexname());
2715 for (int i=depth; i >= 0; --i)
2716 sgmlCloseTag(ofs, depth, environment_stack[i]);
2720 sgmlCloseTag(ofs, 0, top_element);
2724 // How to check for successful close
2728 // checks, if newcol chars should be put into this line
2729 // writes newline, if necessary.
2732 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2733 string::size_type newcol)
2736 if (colcount > lyxrc.ascii_linelen) {
2738 colcount = newcol; // assume write after this call
2753 string tag_name(PAR_TAG const & pt) {
2755 case NONE: return "!-- --";
2756 case TT: return "tt";
2757 case SF: return "sf";
2758 case BF: return "bf";
2759 case IT: return "it";
2760 case SL: return "sl";
2761 case EM: return "em";
2768 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2770 p1 = static_cast<PAR_TAG>(p1 | p2);
2775 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2777 p1 = static_cast<PAR_TAG>( p1 & ~p2);
2783 // Handle internal paragraph parsing -- layout already processed.
2784 void Buffer::simpleLinuxDocOnePar(ostream & os,
2786 Paragraph::depth_type /*depth*/)
2788 LyXLayout const & style = textclasslist.Style(params.textclass,
2790 string::size_type char_line_count = 5; // Heuristic choice ;-)
2792 // gets paragraph main font
2795 if (style.labeltype == LABEL_MANUAL) {
2796 font_old = style.labelfont;
2799 font_old = style.font;
2803 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2804 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2805 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2808 stack<PAR_TAG> tag_state;
2809 // parsing main loop
2810 for (pos_type i = 0; i < par->size(); ++i) {
2812 PAR_TAG tag_close = NONE;
2813 list < PAR_TAG > tag_open;
2815 LyXFont const font = par->getFont(params, i);
2817 if (font_old.family() != font.family()) {
2818 switch (family_type) {
2819 case LyXFont::SANS_FAMILY:
2822 case LyXFont::TYPEWRITER_FAMILY:
2829 family_type = font.family();
2831 switch (family_type) {
2832 case LyXFont::SANS_FAMILY:
2833 tag_open.push_back(SF);
2835 case LyXFont::TYPEWRITER_FAMILY:
2836 tag_open.push_back(TT);
2843 if (font_old.series() != font.series()) {
2844 switch (series_type) {
2845 case LyXFont::BOLD_SERIES:
2852 series_type = font.series();
2854 switch (series_type) {
2855 case LyXFont::BOLD_SERIES:
2856 tag_open.push_back(BF);
2864 if (font_old.shape() != font.shape()) {
2865 switch (shape_type) {
2866 case LyXFont::ITALIC_SHAPE:
2869 case LyXFont::SLANTED_SHAPE:
2876 shape_type = font.shape();
2878 switch (shape_type) {
2879 case LyXFont::ITALIC_SHAPE:
2880 tag_open.push_back(IT);
2882 case LyXFont::SLANTED_SHAPE:
2883 tag_open.push_back(SL);
2890 if (font_old.emph() != font.emph()) {
2891 if (font.emph() == LyXFont::ON) {
2892 tag_open.push_back(EM);
2901 list < PAR_TAG > temp;
2902 while (!tag_state.empty() && tag_close ) {
2903 PAR_TAG k = tag_state.top();
2905 os << "</" << tag_name(k) << ">";
2912 for(list< PAR_TAG >::const_iterator j = temp.begin();
2913 j != temp.end(); ++j) {
2915 os << "<" << tag_name(*j) << ">";
2918 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2919 j != tag_open.end(); ++j) {
2921 os << "<" << tag_name(*j) << ">";
2924 char c = par->getChar(i);
2926 if (c == Paragraph::META_INSET) {
2927 Inset * inset = par->getInset(i);
2928 inset->linuxdoc(this, os);
2933 if (style.latexparam() == "CDATA") {
2934 // "TeX"-Mode on == > SGML-Mode on.
2940 if (par->sgmlConvertChar(c, sgml_string)
2941 && !style.free_spacing && !par->isFreeSpacing())
2943 // in freespacing mode, spaces are
2944 // non-breaking characters
2945 if (desc_on) {// if char is ' ' then...
2948 sgmlLineBreak(os, char_line_count, 6);
2952 sgmlLineBreak(os, char_line_count, 1);
2957 char_line_count += sgml_string.length();
2963 while (!tag_state.empty()) {
2964 os << "</" << tag_name(tag_state.top()) << ">";
2968 // resets description flag correctly
2970 // <tag> not closed...
2971 sgmlLineBreak(os, char_line_count, 6);
2977 // Print an error message.
2978 void Buffer::sgmlError(Paragraph * par, int pos,
2979 string const & message) const
2981 // insert an error marker in text
2982 InsetError * new_inset = new InsetError(message);
2983 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
2988 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2990 ofstream ofs(fname.c_str());
2992 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2996 Paragraph * par = paragraph;
2998 niceFile = nice; // this will be used by Insetincludes.
3000 LyXTextClass const & tclass =
3001 textclasslist.TextClass(params.textclass);
3003 LaTeXFeatures features(params, tclass.numLayouts());
3008 string top_element = textclasslist.LatexnameOfClass(params.textclass);
3011 ofs << "<!DOCTYPE " << top_element
3012 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
3014 string preamble = params.preamble;
3015 preamble += features.getIncludedFiles(fname);
3016 preamble += features.getLyXSGMLEntities();
3018 if (!preamble.empty()) {
3019 ofs << "\n [ " << preamble << " ]";
3024 string top = top_element;
3026 top += params.language->code();
3029 if (!params.options.empty()) {
3031 top += params.options;
3033 sgmlOpenTag(ofs, 0, top);
3035 ofs << "<!-- DocBook file was created by " << lyx_docversion
3036 << "\n See http://www.lyx.org/ for more information -->\n";
3038 vector<string> environment_stack(10);
3039 vector<string> environment_inner(10);
3040 vector<string> command_stack(10);
3042 bool command_flag = false;
3043 Paragraph::depth_type command_depth = 0;
3044 Paragraph::depth_type command_base = 0;
3045 Paragraph::depth_type cmd_depth = 0;
3046 Paragraph::depth_type depth = 0; // paragraph depth
3049 string command_name;
3055 int desc_on = 0; // description mode
3057 LyXLayout const & style =
3058 textclasslist.Style(params.textclass,
3061 // environment tag closing
3062 for (; depth > par->params().depth(); --depth) {
3063 if (environment_inner[depth] != "!-- --") {
3064 item_name = "listitem";
3065 sgmlCloseTag(ofs, command_depth + depth,
3067 if (environment_inner[depth] == "varlistentry")
3068 sgmlCloseTag(ofs, depth+command_depth,
3069 environment_inner[depth]);
3071 sgmlCloseTag(ofs, depth + command_depth,
3072 environment_stack[depth]);
3073 environment_stack[depth].erase();
3074 environment_inner[depth].erase();
3077 if (depth == par->params().depth()
3078 && environment_stack[depth] != style.latexname()
3079 && !environment_stack[depth].empty()) {
3080 if (environment_inner[depth] != "!-- --") {
3081 item_name= "listitem";
3082 sgmlCloseTag(ofs, command_depth+depth,
3084 if (environment_inner[depth] == "varlistentry")
3086 depth + command_depth,
3087 environment_inner[depth]);
3090 sgmlCloseTag(ofs, depth + command_depth,
3091 environment_stack[depth]);
3093 environment_stack[depth].erase();
3094 environment_inner[depth].erase();
3097 // Write opening SGML tags.
3098 switch (style.latextype) {
3099 case LATEX_PARAGRAPH:
3100 sgmlOpenTag(ofs, depth + command_depth,
3107 _("Error : Wrong depth for "
3108 "LatexType Command.\n"));
3110 command_name = style.latexname();
3112 sgmlparam = style.latexparam();
3113 c_params = split(sgmlparam, c_depth,'|');
3115 cmd_depth = lyx::atoi(c_depth);
3118 if (cmd_depth < command_base) {
3119 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3120 sgmlCloseTag(ofs, j, command_stack[j]);
3121 command_depth = command_base = cmd_depth;
3122 } else if (cmd_depth <= command_depth) {
3123 for (int j = command_depth; j >= int(cmd_depth); --j)
3124 sgmlCloseTag(ofs, j, command_stack[j]);
3125 command_depth = cmd_depth;
3127 command_depth = cmd_depth;
3129 command_depth = command_base = cmd_depth;
3130 command_flag = true;
3132 if (command_stack.size() == command_depth + 1)
3133 command_stack.push_back(string());
3134 command_stack[command_depth] = command_name;
3136 // treat label as a special case for
3137 // more WYSIWYM handling.
3138 // This is a hack while paragraphs can't have
3139 // attributes, like id in this case.
3140 if (par->isInset(0)) {
3141 Inset * inset = par->getInset(0);
3142 Inset::Code lyx_code = inset->lyxCode();
3143 if (lyx_code == Inset::LABEL_CODE){
3144 command_name += " id=\"";
3145 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3146 command_name += "\"";
3151 sgmlOpenTag(ofs, depth + command_depth, command_name);
3152 if (c_params.empty())
3153 item_name = "title";
3155 item_name = c_params;
3156 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3159 case LATEX_ENVIRONMENT:
3160 case LATEX_ITEM_ENVIRONMENT:
3161 if (depth < par->params().depth()) {
3162 depth = par->params().depth();
3163 environment_stack[depth].erase();
3166 if (environment_stack[depth] != style.latexname()) {
3167 if(environment_stack.size() == depth + 1) {
3168 environment_stack.push_back("!-- --");
3169 environment_inner.push_back("!-- --");
3171 environment_stack[depth] = style.latexname();
3172 environment_inner[depth] = "!-- --";
3173 sgmlOpenTag(ofs, depth + command_depth,
3174 environment_stack[depth]);
3176 if (environment_inner[depth] != "!-- --") {
3177 item_name= "listitem";
3179 command_depth + depth,
3181 if (environment_inner[depth] == "varlistentry")
3183 depth + command_depth,
3184 environment_inner[depth]);
3188 if (style.latextype == LATEX_ENVIRONMENT) {
3189 if (!style.latexparam().empty()) {
3190 if(style.latexparam() == "CDATA")
3193 sgmlOpenTag(ofs, depth + command_depth,
3194 style.latexparam());
3199 desc_on = (style.labeltype == LABEL_MANUAL);
3202 environment_inner[depth]= "varlistentry";
3204 environment_inner[depth]= "listitem";
3206 sgmlOpenTag(ofs, depth + 1 + command_depth,
3207 environment_inner[depth]);
3211 sgmlOpenTag(ofs, depth + 1 + command_depth,
3215 sgmlOpenTag(ofs, depth + 1 + command_depth,
3220 sgmlOpenTag(ofs, depth + command_depth,
3225 simpleDocBookOnePar(ofs, par, desc_on, depth+1+command_depth);
3229 // write closing SGML tags
3230 switch (style.latextype) {
3232 if (c_params.empty())
3236 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3238 case LATEX_ENVIRONMENT:
3239 if (!style.latexparam().empty()) {
3240 if(style.latexparam() == "CDATA")
3243 sgmlCloseTag(ofs, depth + command_depth,
3244 style.latexparam());
3247 case LATEX_ITEM_ENVIRONMENT:
3248 if (desc_on == 1) break;
3250 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3252 case LATEX_PARAGRAPH:
3253 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3256 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3262 for (int d = depth; d >= 0; --d) {
3263 if (!environment_stack[depth].empty()) {
3264 if (environment_inner[depth] != "!-- --") {
3265 item_name = "listitem";
3266 sgmlCloseTag(ofs, command_depth + depth,
3268 if (environment_inner[depth] == "varlistentry")
3269 sgmlCloseTag(ofs, depth + command_depth,
3270 environment_inner[depth]);
3273 sgmlCloseTag(ofs, depth + command_depth,
3274 environment_stack[depth]);
3278 for (int j = command_depth; j >= 0 ; --j)
3279 if (!command_stack[j].empty())
3280 sgmlCloseTag(ofs, j, command_stack[j]);
3283 sgmlCloseTag(ofs, 0, top_element);
3286 // How to check for successful close
3290 void Buffer::simpleDocBookOnePar(ostream & os,
3291 Paragraph * par, int & desc_on,
3292 Paragraph::depth_type depth) const
3294 bool emph_flag = false;
3296 LyXLayout const & style = textclasslist.Style(params.textclass,
3299 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3301 int char_line_count = depth;
3302 //if (!style.free_spacing)
3303 // os << string(depth,' ');
3305 // parsing main loop
3306 for (pos_type i = 0; i < par->size(); ++i) {
3307 LyXFont font = par->getFont(params, i);
3309 // handle <emphasis> tag
3310 if (font_old.emph() != font.emph()) {
3311 if (font.emph() == LyXFont::ON) {
3315 os << "</emphasis>";
3321 if ( par->isInset(i) ) {
3322 Inset * inset = par->getInset(i);
3323 // don't print the inset in position 0 if desc_on == 3 (label)
3324 if ( i || desc_on != 3)
3325 inset->docbook(this, os);
3327 char c = par->getChar(i);
3329 par->sgmlConvertChar(c, sgml_string);
3331 if (style.pass_thru) {
3333 } else if(style.free_spacing || par->isFreeSpacing() || c != ' ') {
3335 } else if (desc_on ==1) {
3337 os << "\n</term><listitem><para>";
3347 os << "</emphasis>";
3350 // resets description flag correctly
3352 // <term> not closed...
3355 if(style.free_spacing) os << '\n';
3359 // This should be enabled when the Chktex class is implemented. (Asger)
3360 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3361 // Other flags: -wall -v0 -x
3362 int Buffer::runChktex()
3364 if (!users->text) return 0;
3366 users->owner()->prohibitInput();
3368 // get LaTeX-Filename
3369 string const name = getLatexName();
3370 string path = OnlyPath(filename);
3372 string const org_path = path;
3373 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3377 Path p(path); // path to LaTeX file
3378 users->owner()->message(_("Running chktex..."));
3380 // Remove all error insets
3381 bool const removedErrorInsets = users->removeAutoInsets();
3383 // Generate the LaTeX file if neccessary
3384 makeLaTeXFile(name, org_path, false);
3387 Chktex chktex(lyxrc.chktex_command, name, filepath);
3388 int res = chktex.run(terr); // run chktex
3391 Alert::alert(_("chktex did not work!"),
3392 _("Could not run with file:"), name);
3393 } else if (res > 0) {
3394 // Insert all errors as errors boxes
3395 users->insertErrors(terr);
3398 // if we removed error insets before we ran chktex or if we inserted
3399 // error insets after we ran chktex, this must be run:
3400 if (removedErrorInsets || res){
3404 users->owner()->allowInput();
3410 void Buffer::validate(LaTeXFeatures & features) const
3412 Paragraph * par = paragraph;
3413 LyXTextClass const & tclass =
3414 textclasslist.TextClass(params.textclass);
3416 // AMS Style is at document level
3417 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3418 features.require("amsstyle");
3421 // We don't use "lyxerr.debug" because of speed. (Asger)
3422 if (lyxerr.debugging(Debug::LATEX))
3423 lyxerr << "Paragraph: " << par << endl;
3425 // Now just follow the list of paragraphs and run
3426 // validate on each of them.
3427 par->validate(features);
3429 // and then the next paragraph
3433 // the bullet shapes are buffer level not paragraph level
3434 // so they are tested here
3435 for (int i = 0; i < 4; ++i) {
3436 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3437 int const font = params.user_defined_bullets[i].getFont();
3439 int const c = params
3440 .user_defined_bullets[i]
3447 features.require("latexsym");
3449 } else if (font == 1) {
3450 features.require("amssymb");
3451 } else if ((font >= 2 && font <= 5)) {
3452 features.require("pifont");
3457 if (lyxerr.debugging(Debug::LATEX)) {
3458 features.showStruct();
3463 // This function should be in Buffer because it's a buffer's property (ale)
3464 string const Buffer::getIncludeonlyList(char delim)
3467 for (inset_iterator it = inset_iterator_begin();
3468 it != inset_iterator_end(); ++it) {
3469 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3470 InsetInclude * insetinc =
3471 static_cast<InsetInclude *>(*it);
3472 if (insetinc->isIncludeOnly()) {
3475 lst += insetinc->getRelFileBaseName();
3479 lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3484 vector<string> const Buffer::getLabelList()
3486 /// if this is a child document and the parent is already loaded
3487 /// Use the parent's list instead [ale990407]
3488 if (!params.parentname.empty()
3489 && bufferlist.exists(params.parentname)) {
3490 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3492 return tmp->getLabelList();
3495 vector<string> label_list;
3496 for (inset_iterator it = inset_iterator_begin();
3497 it != inset_iterator_end(); ++it) {
3498 vector<string> const l = (*it)->getLabelList();
3499 label_list.insert(label_list.end(), l.begin(), l.end());
3505 Buffer::Lists const Buffer::getLists() const
3508 Paragraph * par = paragraph;
3511 std::pair<bool, textclass_type> const tmp =
3512 textclasslist.NumberOfLayout(params.textclass, "Caption");
3513 bool const found = tmp.first;
3514 textclass_type const cap = tmp.second;
3517 // This is the prefered way to to this, but boost::tie can break
3521 boost::tie(found, cap) = textclasslist
3522 .NumberOfLayout(params.textclass, "Caption");
3526 char const labeltype =
3527 textclasslist.Style(params.textclass,
3528 par->getLayout()).labeltype;
3530 if (labeltype >= LABEL_COUNTER_CHAPTER
3531 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3532 // insert this into the table of contents
3533 SingleList & item = l["TOC"];
3536 textclasslist.TextClass(params.textclass).maxcounter());
3537 item.push_back(TocItem(par, depth, par->asString(this, true)));
3539 // For each paragrph, traverse its insets and look for
3543 Paragraph::inset_iterator it =
3544 par->inset_iterator_begin();
3545 Paragraph::inset_iterator end =
3546 par->inset_iterator_end();
3548 for (; it != end; ++it) {
3549 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3551 static_cast<InsetFloat*>(*it);
3553 string const type = il->type();
3555 // Now find the caption in the float...
3556 // We now tranverse the paragraphs of
3558 Paragraph * tmp = il->inset.paragraph();
3560 if (tmp->layout == cap) {
3561 SingleList & item = l[type];
3563 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3564 item.push_back(TocItem(tmp, 0 , str));
3571 lyxerr << "caption not found" << endl;
3580 // This is also a buffer property (ale)
3581 vector<pair<string, string> > const Buffer::getBibkeyList()
3583 /// if this is a child document and the parent is already loaded
3584 /// Use the parent's list instead [ale990412]
3585 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3586 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3588 return tmp->getBibkeyList();
3591 vector<pair<string, string> > keys;
3592 Paragraph * par = paragraph;
3595 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3596 par->asString(this, false)));
3600 // Might be either using bibtex or a child has bibliography
3602 for (inset_iterator it = inset_iterator_begin();
3603 it != inset_iterator_end(); ++it) {
3604 // Search for Bibtex or Include inset
3605 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3606 vector<pair<string,string> > tmp =
3607 static_cast<InsetBibtex*>(*it)->getKeys(this);
3608 keys.insert(keys.end(), tmp.begin(), tmp.end());
3609 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3610 vector<pair<string,string> > const tmp =
3611 static_cast<InsetInclude*>(*it)->getKeys();
3612 keys.insert(keys.end(), tmp.begin(), tmp.end());
3621 bool Buffer::isDepClean(string const & name) const
3623 DEPCLEAN * item = dep_clean;
3624 while (item && item->master != name)
3626 if (!item) return true;
3631 void Buffer::markDepClean(string const & name)
3634 dep_clean = new DEPCLEAN;
3635 dep_clean->clean = true;
3636 dep_clean->master = name;
3637 dep_clean->next = 0;
3639 DEPCLEAN * item = dep_clean;
3640 while (item && item->master != name)
3645 item = new DEPCLEAN;
3647 item->master = name;
3654 bool Buffer::dispatch(string const & command)
3656 // Split command string into command and argument
3658 string line = frontStrip(command);
3659 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3661 return dispatch(lyxaction.LookupFunc(cmd), arg);
3665 bool Buffer::dispatch(int action, string const & argument)
3667 bool dispatched = true;
3670 Exporter::Export(this, argument, false);
3680 void Buffer::resizeInsets(BufferView * bv)
3682 /// then remove all LyXText in text-insets
3683 Paragraph * par = paragraph;
3684 for (; par; par = par->next()) {
3685 par->resizeInsetsLyXText(bv);
3690 void Buffer::redraw()
3697 void Buffer::changeLanguage(Language const * from, Language const * to)
3700 ParIterator end = par_iterator_end();
3701 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3702 (*it)->changeLanguage(params, from, to);
3706 bool Buffer::isMultiLingual()
3708 ParIterator end = par_iterator_end();
3709 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3710 if ((*it)->isMultiLingual(params))
3717 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph, pos_type pos)
3720 it = par->InsetIterator(pos);
3721 if (it == par->inset_iterator_end()) {
3728 void Buffer::inset_iterator::setParagraph()
3731 it = par->inset_iterator_begin();
3732 if (it != par->inset_iterator_end())
3737 // We maintain an invariant that whenever par = 0 then it = 0
3741 Inset * Buffer::getInsetFromID(int id_arg) const
3743 for (inset_iterator it = inset_const_iterator_begin();
3744 it != inset_const_iterator_end(); ++it)
3746 if ((*it)->id() == id_arg)
3748 Inset * in = (*it)->getInsetFromID(id_arg);
3756 Paragraph * Buffer::getParFromID(int id) const
3758 if (id < 0) return 0;
3759 Paragraph * par = paragraph;
3761 if (par->id() == id) {
3764 Paragraph * tmp = par->getParFromID(id);
3774 ParIterator Buffer::par_iterator_begin()
3776 return ParIterator(paragraph);
3780 ParIterator Buffer::par_iterator_end()
3782 return ParIterator();