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 * ======================================================
26 #include <sys/types.h>
36 #pragma implementation
40 #include "bufferlist.h"
42 #include "lyx_gui_misc.h"
43 #include "LyXAction.h"
46 #include "tex-strings.h"
48 #include "bufferview_funcs.h"
51 #include "mathed/formulamacro.h"
52 #include "mathed/formula.h"
53 #include "insets/inset.h"
54 #include "insets/inseterror.h"
55 #include "insets/insetlabel.h"
56 #include "insets/insetref.h"
57 #include "insets/inseturl.h"
58 #include "insets/insetnote.h"
59 #include "insets/insetquotes.h"
60 #include "insets/insetlatexaccent.h"
61 #include "insets/insetbib.h"
62 #include "insets/insetcite.h"
63 #include "insets/insetexternal.h"
64 #include "insets/insetindex.h"
65 #include "insets/insetinclude.h"
66 #include "insets/insettoc.h"
67 #include "insets/insetparent.h"
68 #include "insets/insetspecialchar.h"
69 #include "insets/figinset.h"
70 #include "insets/insettext.h"
71 #include "insets/insetert.h"
72 #include "insets/insetgraphics.h"
73 #include "insets/insetfoot.h"
74 #include "insets/insetmarginal.h"
75 #include "insets/insetminipage.h"
76 #include "insets/insetfloat.h"
77 #include "insets/insettabular.h"
79 #include "insets/insettheorem.h"
80 #include "insets/insetlist.h"
82 #include "insets/insetcaption.h"
83 #include "insets/insetfloatlist.h"
84 #include "support/textutils.h"
85 #include "support/filetools.h"
86 #include "support/path.h"
87 #include "support/os.h"
92 #include "LaTeXFeatures.h"
93 #include "support/syscall.h"
94 #include "support/lyxlib.h"
95 #include "support/FileInfo.h"
96 #include "support/lyxmanip.h"
100 #include "frontends/Dialogs.h"
101 #include "frontends/Alert.h"
102 #include "encoding.h"
103 #include "exporter.h"
104 #include "Lsstream.h"
105 #include "converter.h"
106 #include "BufferView.h"
107 #include "ParagraphParameters.h"
108 #include "iterators.h"
118 using std::make_pair;
126 // all these externs should eventually be removed.
127 extern BufferList bufferlist;
129 extern LyXAction lyxaction;
133 const int LYX_FORMAT = 220;
137 extern int tex_code_break_column;
140 Buffer::Buffer(string const & file, bool ronly)
142 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
144 filepath = OnlyPath(file);
153 if (read_only || (lyxrc.use_tempdir)) {
154 tmppath = CreateBufferTmpDir();
155 } else tmppath.erase();
161 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
162 // here the buffer should take care that it is
163 // saved properly, before it goes into the void.
165 // make sure that views using this buffer
170 if (!tmppath.empty()) {
171 DestroyBufferTmpDir(tmppath);
174 Paragraph * par = paragraph;
177 tmppar = par->next();
185 string const Buffer::getLatexName(bool no_path) const
187 string name = ChangeExtension(MakeLatexName(filename), ".tex");
189 return OnlyFilename(name);
195 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
197 string const filename = getLatexName(false);
199 if (filename.empty())
200 return make_pair(Buffer::latexlog, string());
202 string path = OnlyPath(filename);
204 if (lyxrc.use_tempdir || !IsDirWriteable(path))
207 string const fname = AddName(path,
208 OnlyFilename(ChangeExtension(filename,
211 AddName(path, OnlyFilename(
212 ChangeExtension(filename,
213 formats.extension("literate") + ".out")));
215 // If no Latex log or Build log is newer, show Build log
217 FileInfo const f_fi(fname);
218 FileInfo const b_fi(bname);
221 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
222 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
223 return make_pair(Buffer::buildlog, bname);
225 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
226 return make_pair(Buffer::latexlog, fname);
230 void Buffer::setReadonly(bool flag)
232 if (read_only != flag) {
235 users->owner()->getDialogs()->updateBufferDependent(false);
240 /// Update window titles of all users
241 // Should work on a list
242 void Buffer::updateTitles() const
244 if (users) users->owner()->updateWindowTitle();
248 /// Reset autosave timer of all users
249 // Should work on a list
250 void Buffer::resetAutosaveTimers() const
252 if (users) users->owner()->resetAutosaveTimer();
256 void Buffer::setFileName(string const & newfile)
258 filename = MakeAbsPath(newfile);
259 filepath = OnlyPath(filename);
260 setReadonly(IsFileWriteable(filename) == 0);
265 // We'll remove this later. (Lgb)
268 string last_inset_read;
270 #ifndef NO_COMPABILITY
273 ErtComp() : active(false), in_tabular(false) {
280 std::stack<ErtComp> ert_stack;
284 #warning And _why_ is this here? (Lgb)
291 // candidate for move to BufferView
292 // (at least some parts in the beginning of the func)
295 // changed to be public and have one parameter
296 // if par = 0 normal behavior
297 // else insert behavior
298 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
299 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
303 #ifndef NO_COMPABILITY
304 ert_comp.contents.erase();
305 ert_comp.active = false;
306 ert_comp.in_tabular = false;
309 Paragraph::depth_type depth = 0;
310 bool the_end_read = false;
312 Paragraph * first_par = 0;
313 LyXFont font(LyXFont::ALL_INHERIT, params.language);
314 if (file_format < 216 && params.language->lang() == "hebrew")
315 font.setLanguage(default_language);
320 // We are inserting into an existing document
321 users->text->breakParagraph(users);
322 first_par = users->text->firstParagraph();
325 // We don't want to adopt the parameters from the
326 // document we insert, so we skip until the text begins:
329 string const pretoken = lex.getString();
330 if (pretoken == "\\layout") {
331 lex.pushToken(pretoken);
339 string const token = lex.getString();
341 if (token.empty()) continue;
343 lyxerr[Debug::PARSER] << "Handling token: `"
344 << token << "'" << endl;
347 parseSingleLyXformat2Token(lex, par, first_par,
355 paragraph = first_par;
357 if (unknown_layouts > 0) {
358 string s = _("Couldn't set the layout for ");
359 if (unknown_layouts == 1) {
360 s += _("one paragraph");
362 s += tostr(unknown_layouts);
363 s += _(" paragraphs");
365 Alert::alert(_("Textclass Loading Error!"), s,
366 _("When reading " + fileName()));
369 if (unknown_tokens > 0) {
370 string s = _("Encountered ");
371 if (unknown_tokens == 1) {
372 s += _("one unknown token");
374 s += tostr(unknown_tokens);
375 s += _(" unknown tokens");
377 Alert::alert(_("Textclass Loading Error!"), s,
378 _("When reading " + fileName()));
385 #ifndef NO_COMPABILITY
386 void Buffer::insertErtContents(Paragraph * par, int & pos,
387 LyXFont const & font, bool set_inactive)
389 if (!ert_comp.contents.empty()) {
390 lyxerr[Debug::INSETS] << "ERT contents:\n"
391 << ert_comp.contents << endl;
392 Inset * inset = new InsetERT(ert_comp.contents, true);
393 par->insertInset(pos++, inset, font);
394 ert_comp.contents.erase();
397 ert_comp.active = false;
404 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
405 Paragraph *& first_par,
406 string const & token, int & pos,
407 Paragraph::depth_type & depth,
411 bool the_end_read = false;
412 #ifndef NO_COMPABILITY
413 #ifndef NO_PEXTRA_REALLY
414 // This is super temporary but is needed to get the compability
415 // mode for minipages work correctly together with new tabulars.
416 static int call_depth;
418 bool checkminipage = false;
419 static Paragraph * minipar;
420 static Paragraph * parBeforeMinipage;
423 if (token[0] != '\\') {
424 #ifndef NO_COMPABILITY
425 if (ert_comp.active) {
426 ert_comp.contents += token;
429 for (string::const_iterator cit = token.begin();
430 cit != token.end(); ++cit) {
431 par->insertChar(pos, (*cit), font);
434 #ifndef NO_COMPABILITY
437 } else if (token == "\\i") {
438 Inset * inset = new InsetLatexAccent;
439 inset->read(this, lex);
440 par->insertInset(pos, inset, font);
442 } else if (token == "\\layout") {
443 #ifndef NO_COMPABILITY
444 ert_comp.in_tabular = false;
446 insertErtContents(par, pos, font);
449 string const layoutname = lex.getString();
450 pair<bool, LyXTextClass::LayoutList::size_type> pp
451 = textclasslist.NumberOfLayout(params.textclass,
454 #ifndef NO_COMPABILITY
455 if (compare_no_case(layoutname, "latex") == 0) {
456 ert_comp.active = true;
460 // The is the compability reading of layout caption.
461 // It can be removed in LyX version 1.3.0. (Lgb)
462 if (compare_no_case(layoutname, "caption") == 0) {
463 // We expect that the par we are now working on is
464 // really inside a InsetText inside a InsetFloat.
465 // We also know that captions can only be
466 // one paragraph. (Lgb)
468 // We should now read until the next "\layout"
470 // This is probably not good enough, what if the
471 // caption is the last par in the document (Lgb)
472 istream & ist = lex.getStream();
478 if (prefixIs(line, "\\layout")) {
482 if (prefixIs(line, "\\begin_inset"))
484 if (prefixIs(line, "\\end_inset")) {
495 // Now we should have the whole layout in ss
496 // we should now be able to give this to the
498 ss << "\\end_inset\n";
500 // This seems like a bug in stringstream.
501 // We really should be able to use ss
503 istringstream is(ss.str());
505 tmplex.setStream(is);
506 Inset * inset = new InsetCaption;
507 inset->Read(this, tmplex);
508 par->InsertInset(pos, inset, font);
515 par = new Paragraph(par);
519 par->layout = pp.second;
520 #ifndef NO_COMPABILITY
521 } else if (ert_comp.active) {
526 // use default layout "Standard" (0)
529 string const s = _("Layout had to be changed from\n")
530 + layoutname + _(" to ")
531 + textclasslist.NameOfLayout(params.textclass, par->layout);
532 InsetError * new_inset = new InsetError(s);
533 par->insertInset(0, new_inset);
535 // Test whether the layout is obsolete.
536 LyXLayout const & layout =
537 textclasslist.Style(params.textclass,
539 if (!layout.obsoleted_by().empty())
540 par->layout = textclasslist
541 .NumberOfLayout(params.textclass,
542 layout.obsoleted_by())
544 par->params().depth(depth);
545 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
546 if (file_format < 216
547 && params.language->lang() == "hebrew")
548 font.setLanguage(default_language);
553 #ifndef NO_COMPABILITY
554 } else if (token == "\\begin_float") {
555 insertErtContents(par, pos, font);
556 //insertErtContents(par, pos, font, false);
557 //ert_stack.push(ert_comp);
558 //ert_comp = ErtComp();
560 // This is the compability reader. It can be removed in
561 // LyX version 1.3.0. (Lgb)
563 string const tmptok = lex.getString();
564 //lyxerr << "old float: " << tmptok << endl;
567 stringstream old_float;
569 if (tmptok == "footnote") {
570 inset = new InsetFoot;
571 old_float << "collapsed true\n";
572 } else if (tmptok == "margin") {
573 inset = new InsetMarginal;
574 old_float << "collapsed true\n";
575 } else if (tmptok == "fig") {
576 inset = new InsetFloat("figure");
577 old_float << "placement htbp\n"
579 << "collapsed false\n";
580 } else if (tmptok == "tab") {
581 inset = new InsetFloat("table");
582 old_float << "placement htbp\n"
584 << "collapsed false\n";
585 } else if (tmptok == "alg") {
586 inset = new InsetFloat("algorithm");
587 old_float << "placement htbp\n"
589 << "collapsed false\n";
590 } else if (tmptok == "wide-fig") {
591 inset = new InsetFloat("figure");
592 //InsetFloat * tmp = new InsetFloat("figure");
595 old_float << "placement htbp\n"
597 << "collapsed false\n";
598 } else if (tmptok == "wide-tab") {
599 inset = new InsetFloat("table");
600 //InsetFloat * tmp = new InsetFloat("table");
603 old_float << "placement htbp\n"
605 << "collapsed false\n";
609 #ifndef NO_PEXTRA_REALLY
612 return false; // no end read yet
615 // Here we need to check for \end_deeper and handle that
616 // before we do the footnote parsing.
617 // This _is_ a hack! (Lgb)
620 string const tmp = lex.getString();
621 if (tmp == "\\end_deeper") {
622 //lyxerr << "\\end_deeper caught!" << endl;
624 lex.printError("\\end_deeper: "
625 "depth is already null");
630 old_float << tmp << ' ';
635 old_float << lex.getLongString("\\end_float")
636 << "\n\\end_inset\n";
637 //lyxerr << "Float Body:\n" << old_float.str() << endl;
638 // That this does not work seems like a bug
639 // in stringstream. (Lgb)
640 istringstream istr(old_float.str());
642 nylex.setStream(istr);
643 inset->read(this, nylex);
644 par->insertInset(pos, inset, font);
646 insertErtContents(par, pos, font);
648 } else if (token == "\\begin_deeper") {
650 } else if (token == "\\end_deeper") {
652 lex.printError("\\end_deeper: "
653 "depth is already null");
657 } else if (token == "\\begin_preamble") {
658 params.readPreamble(lex);
659 } else if (token == "\\textclass") {
661 pair<bool, LyXTextClassList::size_type> pp =
662 textclasslist.NumberOfClass(lex.getString());
664 params.textclass = pp.second;
666 Alert::alert(string(_("Textclass error")),
667 string(_("The document uses an unknown textclass \"")) +
668 lex.getString() + string("\"."),
669 string(_("LyX will not be able to produce output correctly.")));
670 params.textclass = 0;
672 if (!textclasslist.Load(params.textclass)) {
673 // if the textclass wasn't loaded properly
674 // we need to either substitute another
675 // or stop loading the file.
676 // I can substitute but I don't see how I can
677 // stop loading... ideas?? ARRae980418
678 Alert::alert(_("Textclass Loading Error!"),
679 string(_("Can't load textclass ")) +
680 textclasslist.NameOfClass(params.textclass),
681 _("-- substituting default"));
682 params.textclass = 0;
684 } else if (token == "\\options") {
686 params.options = lex.getString();
687 } else if (token == "\\language") {
688 params.readLanguage(lex);
689 } else if (token == "\\fontencoding") {
691 } else if (token == "\\inputencoding") {
693 params.inputenc = lex.getString();
694 } else if (token == "\\graphics") {
695 params.readGraphicsDriver(lex);
696 } else if (token == "\\fontscheme") {
698 params.fonts = lex.getString();
699 } else if (token == "\\noindent") {
700 par->params().noindent(true);
701 } else if (token == "\\fill_top") {
702 par->params().spaceTop(VSpace(VSpace::VFILL));
703 } else if (token == "\\fill_bottom") {
704 par->params().spaceBottom(VSpace(VSpace::VFILL));
705 } else if (token == "\\line_top") {
706 par->params().lineTop(true);
707 } else if (token == "\\line_bottom") {
708 par->params().lineBottom(true);
709 } else if (token == "\\pagebreak_top") {
710 par->params().pagebreakTop(true);
711 } else if (token == "\\pagebreak_bottom") {
712 par->params().pagebreakBottom(true);
713 } else if (token == "\\start_of_appendix") {
714 par->params().startOfAppendix(true);
715 } else if (token == "\\paragraph_separation") {
716 int tmpret = lex.findToken(string_paragraph_separation);
717 if (tmpret == -1) ++tmpret;
718 if (tmpret != LYX_LAYOUT_DEFAULT)
719 params.paragraph_separation =
720 static_cast<BufferParams::PARSEP>(tmpret);
721 } else if (token == "\\defskip") {
723 params.defskip = VSpace(lex.getString());
724 } else if (token == "\\epsfig") { // obsolete
725 // Indeed it is obsolete, but we HAVE to be backwards
726 // compatible until 0.14, because otherwise all figures
727 // in existing documents are irretrivably lost. (Asger)
728 params.readGraphicsDriver(lex);
729 } else if (token == "\\quotes_language") {
730 int tmpret = lex.findToken(string_quotes_language);
731 if (tmpret == -1) ++tmpret;
732 if (tmpret != LYX_LAYOUT_DEFAULT) {
733 InsetQuotes::quote_language tmpl =
734 InsetQuotes::EnglishQ;
737 tmpl = InsetQuotes::EnglishQ;
740 tmpl = InsetQuotes::SwedishQ;
743 tmpl = InsetQuotes::GermanQ;
746 tmpl = InsetQuotes::PolishQ;
749 tmpl = InsetQuotes::FrenchQ;
752 tmpl = InsetQuotes::DanishQ;
755 params.quotes_language = tmpl;
757 } else if (token == "\\quotes_times") {
759 switch (lex.getInteger()) {
761 params.quotes_times = InsetQuotes::SingleQ;
764 params.quotes_times = InsetQuotes::DoubleQ;
767 } else if (token == "\\papersize") {
768 int tmpret = lex.findToken(string_papersize);
772 params.papersize2 = tmpret;
773 } else if (token == "\\paperpackage") {
774 int tmpret = lex.findToken(string_paperpackages);
777 params.paperpackage = BufferParams::PACKAGE_NONE;
779 params.paperpackage = tmpret;
780 } else if (token == "\\use_geometry") {
782 params.use_geometry = lex.getInteger();
783 } else if (token == "\\use_amsmath") {
785 params.use_amsmath = lex.getInteger();
786 } else if (token == "\\use_natbib") {
788 params.use_natbib = lex.getInteger();
789 } else if (token == "\\use_numerical_citations") {
791 params.use_numerical_citations = lex.getInteger();
792 } else if (token == "\\paperorientation") {
793 int tmpret = lex.findToken(string_orientation);
794 if (tmpret == -1) ++tmpret;
795 if (tmpret != LYX_LAYOUT_DEFAULT)
796 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
797 } else if (token == "\\paperwidth") {
799 params.paperwidth = lex.getString();
800 } else if (token == "\\paperheight") {
802 params.paperheight = lex.getString();
803 } else if (token == "\\leftmargin") {
805 params.leftmargin = lex.getString();
806 } else if (token == "\\topmargin") {
808 params.topmargin = lex.getString();
809 } else if (token == "\\rightmargin") {
811 params.rightmargin = lex.getString();
812 } else if (token == "\\bottommargin") {
814 params.bottommargin = lex.getString();
815 } else if (token == "\\headheight") {
817 params.headheight = lex.getString();
818 } else if (token == "\\headsep") {
820 params.headsep = lex.getString();
821 } else if (token == "\\footskip") {
823 params.footskip = lex.getString();
824 } else if (token == "\\paperfontsize") {
826 params.fontsize = strip(lex.getString());
827 } else if (token == "\\papercolumns") {
829 params.columns = lex.getInteger();
830 } else if (token == "\\papersides") {
832 switch (lex.getInteger()) {
834 case 1: params.sides = LyXTextClass::OneSide; break;
835 case 2: params.sides = LyXTextClass::TwoSides; break;
837 } else if (token == "\\paperpagestyle") {
839 params.pagestyle = strip(lex.getString());
840 } else if (token == "\\bullet") {
842 int const index = lex.getInteger();
844 int temp_int = lex.getInteger();
845 params.user_defined_bullets[index].setFont(temp_int);
846 params.temp_bullets[index].setFont(temp_int);
848 temp_int = lex.getInteger();
849 params.user_defined_bullets[index].setCharacter(temp_int);
850 params.temp_bullets[index].setCharacter(temp_int);
852 temp_int = lex.getInteger();
853 params.user_defined_bullets[index].setSize(temp_int);
854 params.temp_bullets[index].setSize(temp_int);
856 string const temp_str = lex.getString();
857 if (temp_str != "\\end_bullet") {
858 // this element isn't really necessary for
859 // parsing but is easier for humans
860 // to understand bullets. Put it back and
861 // set a debug message?
862 lex.printError("\\end_bullet expected, got" + temp_str);
863 //how can I put it back?
865 } else if (token == "\\bulletLaTeX") {
867 int const index = lex.getInteger();
869 string temp_str = lex.getString();
871 while (temp_str != "\\end_bullet") {
872 // this loop structure is needed when user
873 // enters an empty string since the first
874 // thing returned will be the \\end_bullet
876 // if the LaTeX entry has spaces. Each element
877 // therefore needs to be read in turn
880 temp_str = lex.getString();
882 params.user_defined_bullets[index].setText(sum_str);
883 params.temp_bullets[index].setText(sum_str);
884 } else if (token == "\\secnumdepth") {
886 params.secnumdepth = lex.getInteger();
887 } else if (token == "\\tocdepth") {
889 params.tocdepth = lex.getInteger();
890 } else if (token == "\\spacing") {
892 string const tmp = strip(lex.getString());
893 Spacing::Space tmp_space = Spacing::Default;
895 if (tmp == "single") {
896 tmp_space = Spacing::Single;
897 } else if (tmp == "onehalf") {
898 tmp_space = Spacing::Onehalf;
899 } else if (tmp == "double") {
900 tmp_space = Spacing::Double;
901 } else if (tmp == "other") {
903 tmp_space = Spacing::Other;
904 tmp_val = lex.getFloat();
906 lex.printError("Unknown spacing token: '$$Token'");
908 // Small hack so that files written with klyx will be
911 par->params().spacing(Spacing(tmp_space, tmp_val));
913 params.spacing.set(tmp_space, tmp_val);
915 } else if (token == "\\paragraph_spacing") {
917 string const tmp = strip(lex.getString());
918 if (tmp == "single") {
919 par->params().spacing(Spacing(Spacing::Single));
920 } else if (tmp == "onehalf") {
921 par->params().spacing(Spacing(Spacing::Onehalf));
922 } else if (tmp == "double") {
923 par->params().spacing(Spacing(Spacing::Double));
924 } else if (tmp == "other") {
926 par->params().spacing(Spacing(Spacing::Other,
929 lex.printError("Unknown spacing token: '$$Token'");
931 } else if (token == "\\float_placement") {
933 params.float_placement = lex.getString();
934 } else if (token == "\\family") {
936 font.setLyXFamily(lex.getString());
937 } else if (token == "\\series") {
939 font.setLyXSeries(lex.getString());
940 } else if (token == "\\shape") {
942 font.setLyXShape(lex.getString());
943 } else if (token == "\\size") {
945 font.setLyXSize(lex.getString());
946 #ifndef NO_COMPABILITY
947 } else if (token == "\\latex") {
949 string const tok = lex.getString();
950 if (tok == "no_latex") {
952 insertErtContents(par, pos, font);
953 } else if (tok == "latex") {
954 ert_comp.active = true;
955 } else if (tok == "default") {
957 insertErtContents(par, pos, font);
959 lex.printError("Unknown LaTeX font flag "
963 } else if (token == "\\lang") {
965 string const tok = lex.getString();
966 Language const * lang = languages.getLanguage(tok);
968 font.setLanguage(lang);
970 font.setLanguage(params.language);
971 lex.printError("Unknown language `$$Token'");
973 } else if (token == "\\numeric") {
975 font.setNumber(font.setLyXMisc(lex.getString()));
976 } else if (token == "\\emph") {
978 font.setEmph(font.setLyXMisc(lex.getString()));
979 } else if (token == "\\bar") {
981 string const tok = lex.getString();
982 // This is dirty, but gone with LyX3. (Asger)
984 font.setUnderbar(LyXFont::ON);
985 else if (tok == "no")
986 font.setUnderbar(LyXFont::OFF);
987 else if (tok == "default")
988 font.setUnderbar(LyXFont::INHERIT);
990 lex.printError("Unknown bar font flag "
992 } else if (token == "\\noun") {
994 font.setNoun(font.setLyXMisc(lex.getString()));
995 } else if (token == "\\color") {
997 font.setLyXColor(lex.getString());
998 } else if (token == "\\align") {
999 int tmpret = lex.findToken(string_align);
1000 if (tmpret == -1) ++tmpret;
1001 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
1002 int const tmpret2 = int(pow(2.0, tmpret));
1003 //lyxerr << "Tmpret2 = " << tmpret2 << endl;
1004 par->params().align(LyXAlignment(tmpret2));
1006 } else if (token == "\\added_space_top") {
1008 par->params().spaceTop(VSpace(lex.getString()));
1009 } else if (token == "\\added_space_bottom") {
1011 par->params().spaceBottom(VSpace(lex.getString()));
1012 #ifndef NO_COMPABILITY
1013 #ifndef NO_PEXTRA_REALLY
1014 } else if (token == "\\pextra_type") {
1016 par->params().pextraType(lex.getInteger());
1017 } else if (token == "\\pextra_width") {
1019 par->params().pextraWidth(lex.getString());
1020 } else if (token == "\\pextra_widthp") {
1022 par->params().pextraWidthp(lex.getString());
1023 } else if (token == "\\pextra_alignment") {
1025 par->params().pextraAlignment(lex.getInteger());
1026 } else if (token == "\\pextra_hfill") {
1028 par->params().pextraHfill(lex.getInteger());
1029 } else if (token == "\\pextra_start_minipage") {
1031 par->params().pextraStartMinipage(lex.getInteger());
1034 } else if (token == "\\labelwidthstring") {
1036 par->params().labelWidthString(lex.getString());
1037 // do not delete this token, it is still needed!
1038 } else if (token == "\\end_inset") {
1039 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
1040 << "Last inset read was: " << last_inset_read
1042 // Simply ignore this. The insets do not have
1044 // But insets should read it, it is a part of
1045 // the inset isn't it? Lgb.
1046 } else if (token == "\\begin_inset") {
1047 #ifndef NO_COMPABILITY
1048 insertErtContents(par, pos, font, false);
1049 ert_stack.push(ert_comp);
1050 ert_comp = ErtComp();
1052 readInset(lex, par, pos, font);
1053 #ifndef NO_COMPABILITY
1054 ert_comp = ert_stack.top();
1056 insertErtContents(par, pos, font);
1058 } else if (token == "\\SpecialChar") {
1059 LyXLayout const & layout =
1060 textclasslist.Style(params.textclass,
1063 // Insets don't make sense in a free-spacing context! ---Kayvan
1064 if (layout.free_spacing) {
1067 string next_token = lex.getString();
1068 if (next_token == "\\-") {
1069 par->insertChar(pos, '-', font);
1070 } else if (next_token == "\\protected_separator"
1071 || next_token == "~") {
1072 par->insertChar(pos, ' ', font);
1074 lex.printError("Token `$$Token' "
1076 "paragraph layout!");
1081 Inset * inset = new InsetSpecialChar;
1082 inset->read(this, lex);
1083 par->insertInset(pos, inset, font);
1086 } else if (token == "\\newline") {
1087 #ifndef NO_COMPABILITY
1088 if (!ert_comp.in_tabular && ert_comp.active) {
1089 ert_comp.contents += char(Paragraph::META_NEWLINE);
1091 // Since we cannot know it this is only a regular
1092 // newline or a tabular cell delimter we have to
1093 // handle the ERT here.
1094 insertErtContents(par, pos, font, false);
1096 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1100 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1103 } else if (token == "\\LyXTable") {
1104 #ifndef NO_COMPABILITY
1105 ert_comp.in_tabular = true;
1107 Inset * inset = new InsetTabular(*this);
1108 inset->read(this, lex);
1109 par->insertInset(pos, inset, font);
1111 } else if (token == "\\hfill") {
1112 par->insertChar(pos, Paragraph::META_HFILL, font);
1114 } else if (token == "\\protected_separator") { // obsolete
1115 // This is a backward compability thingie. (Lgb)
1116 // Remove it later some time...introduced with fileformat
1118 LyXLayout const & layout =
1119 textclasslist.Style(params.textclass,
1122 if (layout.free_spacing) {
1123 par->insertChar(pos, ' ', font);
1125 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
1126 par->insertInset(pos, inset, font);
1129 } else if (token == "\\bibitem") { // ale970302
1131 InsetCommandParams p("bibitem", "dummy");
1132 par->bibkey = new InsetBibKey(p);
1134 par->bibkey->read(this, lex);
1135 } else if (token == "\\backslash") {
1136 #ifndef NO_COMPABILITY
1137 if (ert_comp.active) {
1138 ert_comp.contents += "\\";
1141 par->insertChar(pos, '\\', font);
1143 #ifndef NO_COMPABILITY
1146 } else if (token == "\\the_end") {
1147 #ifndef NO_COMPABILITY
1148 // If we still have some ert active here we have to insert
1149 // it so we don't loose it. (Lgb)
1150 insertErtContents(par, pos, font);
1152 the_end_read = true;
1153 #ifndef NO_COMPABILITY
1154 #ifndef NO_PEXTRA_REALLY
1155 minipar = parBeforeMinipage = 0;
1159 #ifndef NO_COMPABILITY
1160 if (ert_comp.active) {
1161 ert_comp.contents += token;
1164 // This should be insurance for the future: (Asger)
1167 string const s = _("Unknown token: ") + token
1168 + " " + lex.text() + "\n";
1170 InsetError * new_inset = new InsetError(s);
1171 par->insertInset(pos, new_inset);
1173 #ifndef NO_COMPABILITY
1178 #ifndef NO_COMPABILITY
1179 #ifndef NO_PEXTRA_REALLY
1180 // I wonder if we could use this blanket fix for all the
1181 // checkminipage cases...
1182 if (par && par->size()) {
1183 // It is possible that this will check to often,
1184 // but that should not be an correctness issue.
1185 // Only a speed issue.
1186 checkminipage = true;
1189 // now check if we have a minipage paragraph as at this
1190 // point we already read all the necessary data!
1191 // this cannot be done in layout because there we did
1192 // not read yet the paragraph PEXTRA-params (Jug)
1194 // BEGIN pextra_minipage compability
1195 // This should be removed in 1.3.x (Lgb)
1197 // This compability code is not perfect. In a couple
1198 // of rand cases it fails. When the minipage par is
1199 // the first par in the document, and when there are
1200 // none or only one regular paragraphs after the
1201 // minipage. Currently I am not investing any effort
1202 // in fixing those cases.
1204 //lyxerr << "Call depth: " << call_depth << endl;
1205 if (checkminipage && (call_depth == 1)) {
1206 checkminipage = false;
1207 if (minipar && (minipar != par) &&
1208 (par->params().pextraType()==Paragraph::PEXTRA_MINIPAGE))
1210 lyxerr << "minipages in a row" << endl;
1211 if (par->params().pextraStartMinipage()) {
1212 lyxerr << "start new minipage" << endl;
1213 // minipages in a row
1214 par->previous()->next(0);
1217 Paragraph * tmp = minipar;
1219 tmp->params().pextraType(0);
1220 tmp->params().pextraWidth(string());
1221 tmp->params().pextraWidthp(string());
1222 tmp->params().pextraAlignment(0);
1223 tmp->params().pextraHfill(false);
1224 tmp->params().pextraStartMinipage(false);
1227 // create a new paragraph to insert the
1228 // minipages in the following case
1229 if (par->params().pextraStartMinipage() &&
1230 !par->params().pextraHfill())
1232 Paragraph * p = new Paragraph;
1234 p->previous(parBeforeMinipage);
1235 parBeforeMinipage->next(p);
1237 p->params().depth(parBeforeMinipage->params().depth());
1238 parBeforeMinipage = p;
1240 InsetMinipage * mini = new InsetMinipage;
1241 mini->pos(static_cast<InsetMinipage::Position>(par->params().pextraAlignment()));
1242 mini->width(par->params().pextraWidth());
1243 if (!par->params().pextraWidthp().empty()) {
1244 lyxerr << "WP:" << mini->width() << endl;
1245 mini->width(tostr(par->params().pextraWidthp())+"%");
1247 mini->inset.paragraph(par);
1248 // Insert the minipage last in the
1249 // previous paragraph.
1250 if (par->params().pextraHfill()) {
1251 parBeforeMinipage->insertChar
1252 (parBeforeMinipage->size(), Paragraph::META_HFILL);
1254 parBeforeMinipage->insertInset
1255 (parBeforeMinipage->size(), mini);
1259 lyxerr << "new minipage par" << endl;
1260 //nothing to do just continue reading
1263 } else if (minipar && (minipar != par)) {
1264 lyxerr << "last minipage par read" << endl;
1265 // The last paragraph read was not part of a
1266 // minipage but the par linked list is...
1267 // So we need to remove the last par from the
1269 if (par->previous())
1270 par->previous()->next(0);
1271 par->previous(parBeforeMinipage);
1272 parBeforeMinipage->next(par);
1273 Paragraph * tmp = minipar;
1275 tmp->params().pextraType(0);
1276 tmp->params().pextraWidth(string());
1277 tmp->params().pextraWidthp(string());
1278 tmp->params().pextraAlignment(0);
1279 tmp->params().pextraHfill(false);
1280 tmp->params().pextraStartMinipage(false);
1283 depth = parBeforeMinipage->params().depth();
1284 minipar = parBeforeMinipage = 0;
1285 } else if (!minipar &&
1286 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1288 // par is the first paragraph in a minipage
1289 lyxerr << "begin minipage" << endl;
1290 // To minimize problems for
1291 // the users we will insert
1292 // the first minipage in
1293 // a sequence of minipages
1294 // in its own paragraph.
1295 Paragraph * p = new Paragraph;
1297 p->previous(par->previous());
1299 p->params().depth(depth);
1300 par->params().depth(0);
1302 if (par->previous())
1303 par->previous()->next(p);
1305 parBeforeMinipage = p;
1307 if (!first_par || (first_par == par))
1310 InsetMinipage * mini = new InsetMinipage;
1311 mini->pos(static_cast<InsetMinipage::Position>(minipar->params().pextraAlignment()));
1312 mini->width(minipar->params().pextraWidth());
1313 if (!par->params().pextraWidthp().empty()) {
1314 lyxerr << "WP:" << mini->width() << endl;
1315 mini->width(tostr(par->params().pextraWidthp())+"%");
1317 mini->inset.paragraph(minipar);
1319 // Insert the minipage last in the
1320 // previous paragraph.
1321 if (minipar->params().pextraHfill()) {
1322 parBeforeMinipage->insertChar
1323 (parBeforeMinipage->size(),Paragraph::META_HFILL);
1325 parBeforeMinipage->insertInset
1326 (parBeforeMinipage->size(), mini);
1329 // End of pextra_minipage compability
1333 return the_end_read;
1336 // needed to insert the selection
1337 void Buffer::insertStringAsLines(Paragraph *& par, Paragraph::size_type & pos,
1338 LyXFont const & fn,string const & str) const
1340 LyXLayout const & layout = textclasslist.Style(params.textclass,
1344 (void)par->checkInsertChar(font);
1345 // insert the string, don't insert doublespace
1346 bool space_inserted = true;
1347 for(string::const_iterator cit = str.begin();
1348 cit != str.end(); ++cit) {
1350 if (par->size() || layout.keepempty) {
1351 par->breakParagraph(params, pos,
1352 layout.isEnvironment());
1355 space_inserted = true;
1359 // do not insert consecutive spaces if !free_spacing
1360 } else if ((*cit == ' ' || *cit == '\t') &&
1361 space_inserted && !layout.free_spacing)
1364 } else if (*cit == '\t') {
1365 if (!layout.free_spacing) {
1366 // tabs are like spaces here
1367 par->insertChar(pos, ' ', font);
1369 space_inserted = true;
1371 const Paragraph::size_type nb = 8 - pos % 8;
1372 for (Paragraph::size_type a = 0;
1374 par->insertChar(pos, ' ', font);
1377 space_inserted = true;
1379 } else if (!IsPrintable(*cit)) {
1380 // Ignore unprintables
1383 // just insert the character
1384 par->insertChar(pos, *cit, font);
1386 space_inserted = (*cit == ' ');
1393 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1394 int & pos, LyXFont & font)
1396 // consistency check
1397 if (lex.getString() != "\\begin_inset") {
1398 lyxerr << "Buffer::readInset: Consistency check failed."
1405 string const tmptok = lex.getString();
1406 last_inset_read = tmptok;
1408 // test the different insets
1409 if (tmptok == "LatexCommand") {
1410 InsetCommandParams inscmd;
1413 string const cmdName = inscmd.getCmdName();
1415 // This strange command allows LyX to recognize "natbib" style
1416 // citations: citet, citep, Citet etc.
1417 if (compare_no_case(cmdName, "cite", 4) == 0) {
1418 inset = new InsetCitation(inscmd);
1419 } else if (cmdName == "bibitem") {
1420 lex.printError("Wrong place for bibitem");
1421 inset = new InsetBibKey(inscmd);
1422 } else if (cmdName == "BibTeX") {
1423 inset = new InsetBibtex(inscmd);
1424 } else if (cmdName == "index") {
1425 inset = new InsetIndex(inscmd);
1426 } else if (cmdName == "include") {
1427 inset = new InsetInclude(inscmd, *this);
1428 } else if (cmdName == "label") {
1429 inset = new InsetLabel(inscmd);
1430 } else if (cmdName == "url"
1431 || cmdName == "htmlurl") {
1432 inset = new InsetUrl(inscmd);
1433 } else if (cmdName == "ref"
1434 || cmdName == "pageref"
1435 || cmdName == "vref"
1436 || cmdName == "vpageref"
1437 || cmdName == "prettyref") {
1438 if (!inscmd.getOptions().empty()
1439 || !inscmd.getContents().empty()) {
1440 inset = new InsetRef(inscmd, *this);
1442 } else if (cmdName == "tableofcontents") {
1443 inset = new InsetTOC(inscmd);
1444 } else if (cmdName == "listofalgorithms") {
1445 inset = new InsetFloatList("algorithm");
1446 } else if (cmdName == "listoffigures") {
1447 inset = new InsetFloatList("figure");
1448 } else if (cmdName == "listoftables") {
1449 inset = new InsetFloatList("table");
1450 } else if (cmdName == "printindex") {
1451 inset = new InsetPrintIndex(inscmd);
1452 } else if (cmdName == "lyxparent") {
1453 inset = new InsetParent(inscmd, *this);
1456 bool alreadyread = false;
1457 if (tmptok == "Quotes") {
1458 inset = new InsetQuotes;
1459 } else if (tmptok == "External") {
1460 inset = new InsetExternal;
1461 } else if (tmptok == "FormulaMacro") {
1462 inset = new InsetFormulaMacro;
1463 } else if (tmptok == "Formula") {
1464 inset = new InsetFormula;
1465 } else if (tmptok == "Figure") { // Backward compatibility
1466 inset = new InsetFig(100, 100, *this);
1467 //inset = new InsetGraphics;
1468 } else if (tmptok == "Graphics") {
1469 inset = new InsetGraphics;
1470 } else if (tmptok == "Info") {// backwards compatibility
1471 inset = new InsetNote(this,
1472 lex.getLongString("\\end_inset"),
1475 } else if (tmptok == "Note") {
1476 inset = new InsetNote;
1477 } else if (tmptok == "Include") {
1478 InsetCommandParams p( "Include" );
1479 inset = new InsetInclude(p, *this);
1480 } else if (tmptok == "ERT") {
1481 inset = new InsetERT;
1482 } else if (tmptok == "Tabular") {
1483 inset = new InsetTabular(*this);
1484 } else if (tmptok == "Text") {
1485 inset = new InsetText;
1486 } else if (tmptok == "Foot") {
1487 inset = new InsetFoot;
1488 } else if (tmptok == "Marginal") {
1489 inset = new InsetMarginal;
1490 } else if (tmptok == "Minipage") {
1491 inset = new InsetMinipage;
1492 } else if (tmptok == "Float") {
1494 string tmptok = lex.getString();
1495 inset = new InsetFloat(tmptok);
1497 } else if (tmptok == "List") {
1498 inset = new InsetList;
1499 } else if (tmptok == "Theorem") {
1500 inset = new InsetList;
1502 } else if (tmptok == "Caption") {
1503 inset = new InsetCaption;
1504 } else if (tmptok == "FloatList") {
1505 inset = new InsetFloatList;
1508 if (inset && !alreadyread) inset->read(this, lex);
1512 par->insertInset(pos, inset, font);
1518 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1522 string const token(lex.getString());
1523 if (token == "\\lyxformat") { // the first token _must_ be...
1525 string tmp_format = lex.getString();
1526 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1527 // if present remove ".," from string.
1528 string::size_type dot = tmp_format.find_first_of(".,");
1529 //lyxerr << " dot found at " << dot << endl;
1530 if (dot != string::npos)
1531 tmp_format.erase(dot, 1);
1532 file_format = strToInt(tmp_format);
1533 if (file_format == LYX_FORMAT) {
1535 } else if (file_format > LYX_FORMAT) {
1537 Alert::alert(_("Warning!"),
1538 _("LyX file format is newer that what"),
1539 _("is supported in this LyX version. Expect some problems."));
1541 } else if (file_format < LYX_FORMAT) {
1543 if (file_format < 200) {
1544 Alert::alert(_("ERROR!"),
1545 _("Old LyX file format found. "
1546 "Use LyX 0.10.x to read this!"));
1550 bool the_end = readLyXformat2(lex, par);
1551 params.setPaperStuff();
1552 // the_end was added in 213
1553 if (file_format < 213)
1557 Alert::alert(_("Warning!"),
1558 _("Reading of document is not complete"),
1559 _("Maybe the document is truncated"));
1562 } else { // "\\lyxformat" not found
1563 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1566 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1571 // Should probably be moved to somewhere else: BufferView? LyXView?
1572 bool Buffer::save() const
1574 // We don't need autosaves in the immediate future. (Asger)
1575 resetAutosaveTimers();
1579 if (lyxrc.make_backup) {
1580 s = fileName() + '~';
1581 if (!lyxrc.backupdir_path.empty())
1582 s = AddName(lyxrc.backupdir_path,
1583 subst(os::slashify_path(s),'/','!'));
1585 // Rename is the wrong way of making a backup,
1586 // this is the correct way.
1587 /* truss cp fil fil2:
1588 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1589 stat("LyXVC.lyx", 0xEFFFF688) = 0
1590 open("LyXVC.lyx", O_RDONLY) = 3
1591 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1592 fstat(4, 0xEFFFF508) = 0
1593 fstat(3, 0xEFFFF508) = 0
1594 read(3, " # T h i s f i l e w".., 8192) = 5579
1595 write(4, " # T h i s f i l e w".., 5579) = 5579
1596 read(3, 0xEFFFD4A0, 8192) = 0
1599 chmod("LyXVC3.lyx", 0100644) = 0
1600 lseek(0, 0, SEEK_CUR) = 46440
1604 // Should probably have some more error checking here.
1605 // Should be cleaned up in 0.13, at least a bit.
1606 // Doing it this way, also makes the inodes stay the same.
1607 // This is still not a very good solution, in particular we
1608 // might loose the owner of the backup.
1609 FileInfo finfo(fileName());
1610 if (finfo.exist()) {
1611 mode_t fmode = finfo.getMode();
1612 struct utimbuf times = {
1613 finfo.getAccessTime(),
1614 finfo.getModificationTime() };
1616 ifstream ifs(fileName().c_str());
1617 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1622 ::chmod(s.c_str(), fmode);
1624 if (::utime(s.c_str(), ×)) {
1625 lyxerr << "utime error." << endl;
1628 lyxerr << "LyX was not able to make "
1629 "backup copy. Beware." << endl;
1634 if (writeFile(fileName(), false)) {
1636 removeAutosaveFile(fileName());
1638 // Saving failed, so backup is not backup
1639 if (lyxrc.make_backup) {
1640 lyx::rename(s, fileName());
1648 // Returns false if unsuccesful
1649 bool Buffer::writeFile(string const & fname, bool flag) const
1651 // if flag is false writeFile will not create any GUI
1652 // warnings, only cerr.
1653 // Needed for autosave in background or panic save (Matthias 120496)
1655 if (read_only && (fname == filename)) {
1656 // Here we should come with a question if we should
1657 // perform the write anyway.
1659 lyxerr << _("Error! Document is read-only: ")
1662 Alert::alert(_("Error! Document is read-only: "),
1667 FileInfo finfo(fname);
1668 if (finfo.exist() && !finfo.writable()) {
1669 // Here we should come with a question if we should
1670 // try to do the save anyway. (i.e. do a chmod first)
1672 lyxerr << _("Error! Cannot write file: ")
1675 Alert::err_alert(_("Error! Cannot write file: "),
1680 ofstream ofs(fname.c_str());
1683 lyxerr << _("Error! Cannot open file: ")
1686 Alert::err_alert(_("Error! Cannot open file: "),
1692 // Use the standard "C" locale for file output.
1693 ofs.imbue(std::locale::classic());
1696 // The top of the file should not be written by params.
1698 // write out a comment in the top of the file
1699 ofs << '#' << lyx_docversion
1700 << " created this file. For more info see http://www.lyx.org/\n"
1701 << "\\lyxformat " << LYX_FORMAT << "\n";
1703 // now write out the buffer paramters.
1704 params.writeFile(ofs);
1706 Paragraph::depth_type depth = 0;
1708 // this will write out all the paragraphs
1709 // using recursive descent.
1710 paragraph->writeFile(this, ofs, params, depth);
1712 // Write marker that shows file is complete
1713 ofs << "\n\\the_end" << endl;
1717 // how to check if close went ok?
1718 // Following is an attempt... (BE 20001011)
1720 // good() returns false if any error occured, including some
1721 // formatting error.
1722 // bad() returns true if something bad happened in the buffer,
1723 // which should include file system full errors.
1730 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1732 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1742 string const Buffer::asciiParagraph(Paragraph const * par,
1743 unsigned int linelen) const
1745 ostringstream buffer;
1746 Paragraph::depth_type depth = 0;
1748 Paragraph::depth_type ltype_depth = 0;
1749 string::size_type currlinelen = 0;
1750 bool ref_printed = false;
1754 if (!par->previous()) {
1755 // begins or ends a deeper area ?
1756 if (depth != par->params().depth()) {
1757 if (par->params().depth() > depth) {
1758 while (par->params().depth() > depth) {
1762 while (par->params().depth() < depth) {
1768 // First write the layout
1769 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1770 if (tmp == "Itemize") {
1772 ltype_depth = depth + 1;
1773 } else if (tmp == "Enumerate") {
1775 ltype_depth = depth + 1;
1776 } else if (contains(tmp, "ection")) {
1778 ltype_depth = depth + 1;
1779 } else if (contains(tmp, "aragraph")) {
1781 ltype_depth = depth + 1;
1782 } else if (tmp == "Description") {
1784 ltype_depth = depth + 1;
1785 } else if (tmp == "Abstract") {
1788 } else if (tmp == "Bibliography") {
1796 /* maybe some vertical spaces */
1798 /* the labelwidthstring used in lists */
1802 /* some pagebreaks? */
1806 /* what about the alignment */
1808 lyxerr << "Should this ever happen?" << endl;
1811 for (Paragraph::size_type i = 0; i < par->size(); ++i) {
1812 if (!i && !noparbreak) {
1815 for (Paragraph::depth_type j = 0; j < depth; ++j)
1817 currlinelen = depth * 2;
1820 case 4: // (Sub)Paragraph
1821 case 5: // Description
1825 buffer << "Abstract\n\n";
1827 buffer << "Abstract: ";
1829 case 7: // Bibliography
1832 buffer << "References\n\n";
1834 buffer << "References: ";
1839 buffer << par->params().labelString() << " ";
1842 if (ltype_depth > depth) {
1843 for (Paragraph::depth_type j = ltype_depth - 1;
1846 currlinelen += (ltype_depth-depth)*2;
1850 char c = par->getUChar(params, i);
1854 case Paragraph::META_INSET:
1856 Inset const * inset = par->getInset(i);
1858 if (!inset->ascii(this, buffer)) {
1861 rsplit(buffer.str().c_str(),
1863 currlinelen += s.length();
1865 // to be sure it breaks paragraph
1866 currlinelen += linelen;
1872 case Paragraph::META_NEWLINE:
1875 for (Paragraph::depth_type j = 0;
1879 currlinelen = depth * 2;
1880 if (ltype_depth > depth) {
1881 for (Paragraph::depth_type j = ltype_depth;
1884 currlinelen += (ltype_depth - depth) * 2;
1888 case Paragraph::META_HFILL:
1893 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1894 (c == ' ') && ((i + 2) < par->size()))
1897 for (Paragraph::depth_type j = 0;
1900 currlinelen = depth * 2;
1901 if (ltype_depth > depth) {
1902 for (Paragraph::depth_type j = ltype_depth;
1905 currlinelen += (ltype_depth-depth)*2;
1907 } else if (c != '\0') {
1911 lyxerr[Debug::INFO] << "writeAsciiFile: NULL char in structure." << endl;
1915 return buffer.str().c_str();
1919 void Buffer::writeFileAscii(string const & fname, int linelen)
1921 ofstream ofs(fname.c_str());
1923 Alert::err_alert(_("Error: Cannot write file:"), fname);
1926 writeFileAscii(ofs, linelen);
1930 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1932 Paragraph * par = paragraph;
1934 ofs << asciiParagraph(par, linelen);
1942 void Buffer::makeLaTeXFile(string const & fname,
1943 string const & original_path,
1944 bool nice, bool only_body)
1946 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1948 niceFile = nice; // this will be used by Insetincludes.
1950 tex_code_break_column = lyxrc.ascii_linelen;
1952 LyXTextClass const & tclass =
1953 textclasslist.TextClass(params.textclass);
1955 ofstream ofs(fname.c_str());
1957 Alert::err_alert(_("Error: Cannot open file: "), fname);
1961 // validate the buffer.
1962 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1963 LaTeXFeatures features(params, tclass.numLayouts());
1965 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1968 // The starting paragraph of the coming rows is the
1969 // first paragraph of the document. (Asger)
1970 texrow.start(paragraph, 0);
1972 if (!only_body && nice) {
1973 ofs << "%% " << lyx_docversion << " created this file. "
1974 "For more info, see http://www.lyx.org/.\n"
1975 "%% Do not edit unless you really know what "
1980 lyxerr[Debug::INFO] << "lyx header finished" << endl;
1981 // There are a few differences between nice LaTeX and usual files:
1982 // usual is \batchmode and has a
1983 // special input@path to allow the including of figures
1984 // with either \input or \includegraphics (what figinsets do).
1985 // batchmode is not set if there is a tex_code_break_column.
1986 // In this case somebody is interested in the generated LaTeX,
1987 // so this is OK. input@path is set when the actual parameter
1988 // original_path is set. This is done for usual tex-file, but not
1989 // for nice-latex-file. (Matthias 250696)
1992 // code for usual, NOT nice-latex-file
1993 ofs << "\\batchmode\n"; // changed
1994 // from \nonstopmode
1997 if (!original_path.empty()) {
1998 ofs << "\\makeatletter\n"
1999 << "\\def\\input@path{{"
2000 << os::external_path(original_path) << "/}}\n"
2001 << "\\makeatother\n";
2007 ofs << "\\documentclass";
2009 ostringstream options; // the document class options.
2011 if (tokenPos(tclass.opt_fontsize(),
2012 '|', params.fontsize) >= 0) {
2013 // only write if existing in list (and not default)
2014 options << params.fontsize << "pt,";
2018 if (!params.use_geometry &&
2019 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2020 switch (params.papersize) {
2021 case BufferParams::PAPER_A4PAPER:
2022 options << "a4paper,";
2024 case BufferParams::PAPER_USLETTER:
2025 options << "letterpaper,";
2027 case BufferParams::PAPER_A5PAPER:
2028 options << "a5paper,";
2030 case BufferParams::PAPER_B5PAPER:
2031 options << "b5paper,";
2033 case BufferParams::PAPER_EXECUTIVEPAPER:
2034 options << "executivepaper,";
2036 case BufferParams::PAPER_LEGALPAPER:
2037 options << "legalpaper,";
2043 if (params.sides != tclass.sides()) {
2044 switch (params.sides) {
2045 case LyXTextClass::OneSide:
2046 options << "oneside,";
2048 case LyXTextClass::TwoSides:
2049 options << "twoside,";
2055 if (params.columns != tclass.columns()) {
2056 if (params.columns == 2)
2057 options << "twocolumn,";
2059 options << "onecolumn,";
2062 if (!params.use_geometry
2063 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2064 options << "landscape,";
2066 // language should be a parameter to \documentclass
2068 ostringstream language_options;
2069 if (params.language->babel() == "hebrew"
2070 && default_language->babel() != "hebrew")
2071 // This seems necessary
2072 features.useLanguage(default_language);
2074 if (lyxrc.language_use_babel ||
2075 params.language->lang() != lyxrc.default_language ||
2076 !features.hasLanguages()) {
2078 language_options << features.getLanguages();
2079 language_options << params.language->babel();
2080 if (lyxrc.language_global_options)
2081 options << language_options.str() << ',';
2084 // the user-defined options
2085 if (!params.options.empty()) {
2086 options << params.options << ',';
2089 string strOptions(options.str().c_str());
2090 if (!strOptions.empty()){
2091 strOptions = strip(strOptions, ',');
2092 ofs << '[' << strOptions << ']';
2096 << textclasslist.LatexnameOfClass(params.textclass)
2099 // end of \documentclass defs
2101 // font selection must be done before loading fontenc.sty
2102 // The ae package is not needed when using OT1 font encoding.
2103 if (params.fonts != "default" &&
2104 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2105 ofs << "\\usepackage{" << params.fonts << "}\n";
2107 if (params.fonts == "ae") {
2108 ofs << "\\usepackage{aecompl}\n";
2112 // this one is not per buffer
2113 if (lyxrc.fontenc != "default") {
2114 ofs << "\\usepackage[" << lyxrc.fontenc
2119 if (params.inputenc == "auto") {
2120 string const doc_encoding =
2121 params.language->encoding()->LatexName();
2123 // Create a list with all the input encodings used
2125 set<string> encodings = features.getEncodingSet(doc_encoding);
2127 ofs << "\\usepackage[";
2128 std::copy(encodings.begin(), encodings.end(),
2129 std::ostream_iterator<string>(ofs, ","));
2130 ofs << doc_encoding << "]{inputenc}\n";
2132 } else if (params.inputenc != "default") {
2133 ofs << "\\usepackage[" << params.inputenc
2138 // At the very beginning the text parameters.
2139 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2140 switch (params.paperpackage) {
2141 case BufferParams::PACKAGE_A4:
2142 ofs << "\\usepackage{a4}\n";
2145 case BufferParams::PACKAGE_A4WIDE:
2146 ofs << "\\usepackage{a4wide}\n";
2149 case BufferParams::PACKAGE_WIDEMARGINSA4:
2150 ofs << "\\usepackage[widemargins]{a4}\n";
2155 if (params.use_geometry) {
2156 ofs << "\\usepackage{geometry}\n";
2158 ofs << "\\geometry{verbose";
2159 if (params.sides == LyXTextClass::TwoSides)
2161 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2162 ofs << ",landscape";
2163 switch (params.papersize2) {
2164 case BufferParams::VM_PAPER_CUSTOM:
2165 if (!params.paperwidth.empty())
2166 ofs << ",paperwidth="
2167 << params.paperwidth;
2168 if (!params.paperheight.empty())
2169 ofs << ",paperheight="
2170 << params.paperheight;
2172 case BufferParams::VM_PAPER_USLETTER:
2173 ofs << ",letterpaper";
2175 case BufferParams::VM_PAPER_USLEGAL:
2176 ofs << ",legalpaper";
2178 case BufferParams::VM_PAPER_USEXECUTIVE:
2179 ofs << ",executivepaper";
2181 case BufferParams::VM_PAPER_A3:
2184 case BufferParams::VM_PAPER_A4:
2187 case BufferParams::VM_PAPER_A5:
2190 case BufferParams::VM_PAPER_B3:
2193 case BufferParams::VM_PAPER_B4:
2196 case BufferParams::VM_PAPER_B5:
2200 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2201 switch (lyxrc.default_papersize) {
2202 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2203 case BufferParams::PAPER_USLETTER:
2204 ofs << ",letterpaper";
2206 case BufferParams::PAPER_LEGALPAPER:
2207 ofs << ",legalpaper";
2209 case BufferParams::PAPER_EXECUTIVEPAPER:
2210 ofs << ",executivepaper";
2212 case BufferParams::PAPER_A3PAPER:
2215 case BufferParams::PAPER_A4PAPER:
2218 case BufferParams::PAPER_A5PAPER:
2221 case BufferParams::PAPER_B5PAPER:
2226 if (!params.topmargin.empty())
2227 ofs << ",tmargin=" << params.topmargin;
2228 if (!params.bottommargin.empty())
2229 ofs << ",bmargin=" << params.bottommargin;
2230 if (!params.leftmargin.empty())
2231 ofs << ",lmargin=" << params.leftmargin;
2232 if (!params.rightmargin.empty())
2233 ofs << ",rmargin=" << params.rightmargin;
2234 if (!params.headheight.empty())
2235 ofs << ",headheight=" << params.headheight;
2236 if (!params.headsep.empty())
2237 ofs << ",headsep=" << params.headsep;
2238 if (!params.footskip.empty())
2239 ofs << ",footskip=" << params.footskip;
2244 if (features.isRequired("amsstyle")
2245 && !tclass.provides(LyXTextClass::amsmath)) {
2246 ofs << "\\usepackage{amsmath}\n";
2250 if (tokenPos(tclass.opt_pagestyle(),
2251 '|', params.pagestyle) >= 0) {
2252 if (params.pagestyle == "fancy") {
2253 ofs << "\\usepackage{fancyhdr}\n";
2256 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2260 if (params.secnumdepth != tclass.secnumdepth()) {
2261 ofs << "\\setcounter{secnumdepth}{"
2262 << params.secnumdepth
2266 if (params.tocdepth != tclass.tocdepth()) {
2267 ofs << "\\setcounter{tocdepth}{"
2273 if (params.paragraph_separation) {
2274 switch (params.defskip.kind()) {
2275 case VSpace::SMALLSKIP:
2276 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2278 case VSpace::MEDSKIP:
2279 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2281 case VSpace::BIGSKIP:
2282 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2284 case VSpace::LENGTH:
2285 ofs << "\\setlength\\parskip{"
2286 << params.defskip.length().asLatexString()
2289 default: // should never happen // Then delete it.
2290 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2295 ofs << "\\setlength\\parindent{0pt}\n";
2299 // Now insert the LyX specific LaTeX commands...
2301 // The optional packages;
2302 string preamble(features.getPackages());
2304 // this might be useful...
2305 preamble += "\n\\makeatletter\n";
2307 // Some macros LyX will need
2308 string tmppreamble(features.getMacros());
2310 if (!tmppreamble.empty()) {
2311 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2312 "LyX specific LaTeX commands.\n"
2313 + tmppreamble + '\n';
2316 // the text class specific preamble
2317 tmppreamble = features.getTClassPreamble();
2318 if (!tmppreamble.empty()) {
2319 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2320 "Textclass specific LaTeX commands.\n"
2321 + tmppreamble + '\n';
2324 /* the user-defined preamble */
2325 if (!params.preamble.empty()) {
2326 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2327 "User specified LaTeX commands.\n"
2328 + params.preamble + '\n';
2331 preamble += "\\makeatother\n";
2333 // Itemize bullet settings need to be last in case the user
2334 // defines their own bullets that use a package included
2335 // in the user-defined preamble -- ARRae
2336 // Actually it has to be done much later than that
2337 // since some packages like frenchb make modifications
2338 // at \begin{document} time -- JMarc
2340 for (int i = 0; i < 4; ++i) {
2341 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2342 if (bullets_def.empty())
2343 bullets_def="\\AtBeginDocument{\n";
2344 bullets_def += " \\renewcommand{\\labelitemi";
2346 // `i' is one less than the item to modify
2353 bullets_def += "ii";
2359 bullets_def += "}{" +
2360 params.user_defined_bullets[i].getText()
2365 if (!bullets_def.empty())
2366 preamble += bullets_def + "}\n\n";
2368 for (int j = countChar(preamble, '\n'); j-- ;) {
2374 // We try to load babel late, in case it interferes
2375 // with other packages.
2377 string tmp = lyxrc.language_package;
2378 if (!lyxrc.language_global_options
2379 && tmp == "\\usepackage{babel}")
2380 tmp = string("\\usepackage[") +
2381 language_options.str().c_str() +
2388 ofs << "\\begin{document}\n";
2391 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2393 if (!lyxrc.language_auto_begin) {
2394 ofs << subst(lyxrc.language_command_begin, "$$lang",
2395 params.language->babel())
2400 latexParagraphs(ofs, paragraph, 0, texrow);
2402 // add this just in case after all the paragraphs
2406 if (!lyxrc.language_auto_end) {
2407 ofs << subst(lyxrc.language_command_end, "$$lang",
2408 params.language->babel())
2414 ofs << "\\end{document}\n";
2417 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2419 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2423 // Just to be sure. (Asger)
2426 // tex_code_break_column's value is used to decide
2427 // if we are in batchmode or not (within mathed_write()
2428 // in math_write.C) so we must set it to a non-zero
2429 // value when we leave otherwise we save incorrect .lyx files.
2430 tex_code_break_column = lyxrc.ascii_linelen;
2434 lyxerr << "File was not closed properly." << endl;
2437 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2442 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2444 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2445 Paragraph * endpar, TexRow & texrow) const
2447 bool was_title = false;
2448 bool already_title = false;
2451 while (par != endpar) {
2452 LyXLayout const & layout =
2453 textclasslist.Style(params.textclass,
2456 if (layout.intitle) {
2457 if (already_title) {
2458 lyxerr <<"Error in latexParagraphs: You"
2459 " should not mix title layouts"
2460 " with normal ones." << endl;
2463 } else if (was_title && !already_title) {
2464 ofs << "\\maketitle\n";
2466 already_title = true;
2470 if (layout.isEnvironment()) {
2471 par = par->TeXEnvironment(this, params, ofs, texrow);
2473 par = par->TeXOnePar(this, params, ofs, texrow, false);
2476 // It might be that we only have a title in this document
2477 if (was_title && !already_title) {
2478 ofs << "\\maketitle\n";
2484 bool Buffer::isLatex() const
2486 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2490 bool Buffer::isLinuxDoc() const
2492 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2496 bool Buffer::isLiterate() const
2498 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2502 bool Buffer::isDocBook() const
2504 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2508 bool Buffer::isSGML() const
2510 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2511 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2515 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth,
2516 string const & latexname) const
2518 if (!latexname.empty() && latexname != "!-- --")
2519 //os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2520 os << string(depth, ' ') << "<" << latexname << ">\n";
2524 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth,
2525 string const & latexname) const
2527 if (!latexname.empty() && latexname != "!-- --")
2528 //os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2529 os << string(depth, ' ') << "</" << latexname << ">\n";
2533 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2535 ofstream ofs(fname.c_str());
2538 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2542 niceFile = nice; // this will be used by included files.
2544 LyXTextClass const & tclass =
2545 textclasslist.TextClass(params.textclass);
2547 LaTeXFeatures features(params, tclass.numLayouts());
2552 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2555 ofs << "<!doctype linuxdoc system";
2557 string preamble = params.preamble;
2558 preamble += features.getIncludedFiles(fname);
2559 preamble += features.getLyXSGMLEntities();
2561 if (!preamble.empty()) {
2562 ofs << " [ " << preamble << " ]";
2566 if (params.options.empty())
2567 sgmlOpenTag(ofs, 0, top_element);
2569 string top = top_element;
2571 top += params.options;
2572 sgmlOpenTag(ofs, 0, top);
2576 ofs << "<!-- " << lyx_docversion
2577 << " created this file. For more info see http://www.lyx.org/"
2580 Paragraph::depth_type depth = 0; // paragraph depth
2581 Paragraph * par = paragraph;
2583 vector<string> environment_stack(5);
2586 LyXLayout const & style =
2587 textclasslist.Style(params.textclass,
2590 // treat <toc> as a special case for compatibility with old code
2591 if (par->isInset(0)) {
2592 Inset * inset = par->getInset(0);
2593 Inset::Code lyx_code = inset->lyxCode();
2594 if (lyx_code == Inset::TOC_CODE){
2595 string const temp = "toc";
2596 sgmlOpenTag(ofs, depth, temp);
2603 // environment tag closing
2604 for (; depth > par->params().depth(); --depth) {
2605 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2606 environment_stack[depth].erase();
2609 // write opening SGML tags
2610 switch (style.latextype) {
2611 case LATEX_PARAGRAPH:
2612 if (depth == par->params().depth()
2613 && !environment_stack[depth].empty()) {
2614 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2615 environment_stack[depth].erase();
2621 sgmlOpenTag(ofs, depth, style.latexname());
2627 _("Error : Wrong depth for"
2628 " LatexType Command.\n"));
2630 if (!environment_stack[depth].empty()){
2631 sgmlCloseTag(ofs, depth,
2632 environment_stack[depth]);
2636 environment_stack[depth].erase();
2637 sgmlOpenTag(ofs, depth, style.latexname());
2640 case LATEX_ENVIRONMENT:
2641 case LATEX_ITEM_ENVIRONMENT:
2642 if (depth == par->params().depth()
2643 && environment_stack[depth] != style.latexname()) {
2644 sgmlCloseTag(ofs, depth,
2645 environment_stack[depth]);
2646 environment_stack[depth].erase();
2648 if (depth < par->params().depth()) {
2649 depth = par->params().depth();
2650 environment_stack[depth].erase();
2652 if (environment_stack[depth] != style.latexname()) {
2654 sgmlOpenTag(ofs, depth, "p");
2656 sgmlOpenTag(ofs, depth, style.latexname());
2658 if (environment_stack.size() == depth + 1)
2659 environment_stack.push_back("!-- --");
2660 environment_stack[depth] = style.latexname();
2663 if (style.latexparam() == "CDATA")
2666 if (style.latextype == LATEX_ENVIRONMENT) break;
2668 if (style.labeltype == LABEL_MANUAL)
2673 sgmlOpenTag(ofs, depth + 1, item_name);
2676 sgmlOpenTag(ofs, depth, style.latexname());
2680 simpleLinuxDocOnePar(ofs, par, depth);
2685 // write closing SGML tags
2686 switch (style.latextype) {
2689 case LATEX_ENVIRONMENT:
2690 case LATEX_ITEM_ENVIRONMENT:
2691 if (style.latexparam() == "CDATA")
2695 sgmlCloseTag(ofs, depth, style.latexname());
2701 for (int i=depth; i >= 0; --i)
2702 sgmlCloseTag(ofs, depth, environment_stack[i]);
2706 sgmlCloseTag(ofs, 0, top_element);
2710 // How to check for successful close
2714 // checks, if newcol chars should be put into this line
2715 // writes newline, if necessary.
2718 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2719 string::size_type newcol)
2722 if (colcount > lyxrc.ascii_linelen) {
2724 colcount = newcol; // assume write after this call
2739 string tag_name(PAR_TAG const & pt) {
2741 case NONE: return "!-- --";
2742 case TT: return "tt";
2743 case SF: return "sf";
2744 case BF: return "bf";
2745 case IT: return "it";
2746 case SL: return "sl";
2747 case EM: return "em";
2754 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2756 p1 = static_cast<PAR_TAG>(p1 | p2);
2761 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2763 p1 = static_cast<PAR_TAG>( p1 & ~p2);
2769 // Handle internal paragraph parsing -- layout already processed.
2770 void Buffer::simpleLinuxDocOnePar(ostream & os,
2772 Paragraph::depth_type /*depth*/)
2774 LyXLayout const & style = textclasslist.Style(params.textclass,
2776 string::size_type char_line_count = 5; // Heuristic choice ;-)
2778 // gets paragraph main font
2781 if (style.labeltype == LABEL_MANUAL) {
2782 font_old = style.labelfont;
2785 font_old = style.font;
2789 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2790 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2791 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2794 stack<PAR_TAG> tag_state;
2795 // parsing main loop
2796 for (Paragraph::size_type i = 0; i < par->size(); ++i) {
2798 PAR_TAG tag_close = NONE;
2799 list < PAR_TAG > tag_open;
2801 LyXFont const font = par->getFont(params, i);
2803 if (font_old.family() != font.family()) {
2804 switch (family_type) {
2805 case LyXFont::SANS_FAMILY:
2808 case LyXFont::TYPEWRITER_FAMILY:
2815 family_type = font.family();
2817 switch (family_type) {
2818 case LyXFont::SANS_FAMILY:
2819 tag_open.push_back(SF);
2821 case LyXFont::TYPEWRITER_FAMILY:
2822 tag_open.push_back(TT);
2829 if (font_old.series() != font.series()) {
2830 switch (series_type) {
2831 case LyXFont::BOLD_SERIES:
2838 series_type = font.series();
2840 switch (series_type) {
2841 case LyXFont::BOLD_SERIES:
2842 tag_open.push_back(BF);
2850 if (font_old.shape() != font.shape()) {
2851 switch (shape_type) {
2852 case LyXFont::ITALIC_SHAPE:
2855 case LyXFont::SLANTED_SHAPE:
2862 shape_type = font.shape();
2864 switch (shape_type) {
2865 case LyXFont::ITALIC_SHAPE:
2866 tag_open.push_back(IT);
2868 case LyXFont::SLANTED_SHAPE:
2869 tag_open.push_back(SL);
2876 if (font_old.emph() != font.emph()) {
2877 if (font.emph() == LyXFont::ON) {
2878 tag_open.push_back(EM);
2887 list < PAR_TAG > temp;
2888 while(!tag_state.empty() && tag_close ) {
2889 PAR_TAG k = tag_state.top();
2891 os << "</" << tag_name(k) << ">";
2898 for(list< PAR_TAG >::const_iterator j = temp.begin();
2899 j != temp.end(); ++j) {
2901 os << "<" << tag_name(*j) << ">";
2904 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2905 j != tag_open.end(); ++j) {
2907 os << "<" << tag_name(*j) << ">";
2910 char c = par->getChar(i);
2912 if (c == Paragraph::META_INSET) {
2913 Inset * inset = par->getInset(i);
2914 inset->linuxdoc(this, os);
2919 if (style.latexparam() == "CDATA") {
2920 // "TeX"-Mode on == > SGML-Mode on.
2926 if (par->sgmlConvertChar(c, sgml_string)
2927 && !style.free_spacing) {
2928 // in freespacing mode, spaces are
2929 // non-breaking characters
2930 if (desc_on) {// if char is ' ' then...
2933 sgmlLineBreak(os, char_line_count, 6);
2937 sgmlLineBreak(os, char_line_count, 1);
2942 char_line_count += sgml_string.length();
2948 while (!tag_state.empty()) {
2949 os << "</" << tag_name(tag_state.top()) << ">";
2953 // resets description flag correctly
2955 // <tag> not closed...
2956 sgmlLineBreak(os, char_line_count, 6);
2962 // Print an error message.
2963 void Buffer::sgmlError(Paragraph * par, int pos,
2964 string const & message) const
2966 // insert an error marker in text
2967 InsetError * new_inset = new InsetError(message);
2968 par->insertInset(pos, new_inset);
2972 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2974 ofstream ofs(fname.c_str());
2976 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2980 Paragraph * par = paragraph;
2982 niceFile = nice; // this will be used by Insetincludes.
2984 LyXTextClass const & tclass =
2985 textclasslist.TextClass(params.textclass);
2987 LaTeXFeatures features(params, tclass.numLayouts());
2992 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2995 ofs << "<!DOCTYPE " << top_element
2996 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
2998 string preamble = params.preamble;
2999 preamble += features.getIncludedFiles(fname);
3000 preamble += features.getLyXSGMLEntities();
3002 if (!preamble.empty()) {
3003 ofs << "\n [ " << preamble << " ]";
3008 string top = top_element;
3010 top += params.language->code();
3013 if (!params.options.empty()) {
3015 top += params.options;
3017 sgmlOpenTag(ofs, 0, top);
3019 ofs << "<!-- DocBook file was created by " << lyx_docversion
3020 << "\n See http://www.lyx.org/ for more information -->\n";
3022 vector<string> environment_stack(10);
3023 vector<string> environment_inner(10);
3024 vector<string> command_stack(10);
3026 bool command_flag = false;
3027 Paragraph::depth_type command_depth = 0;
3028 Paragraph::depth_type command_base = 0;
3029 Paragraph::depth_type cmd_depth = 0;
3030 Paragraph::depth_type depth = 0; // paragraph depth
3033 string command_name;
3039 int desc_on = 0; // description mode
3041 LyXLayout const & style =
3042 textclasslist.Style(params.textclass,
3045 // environment tag closing
3046 for (; depth > par->params().depth(); --depth) {
3047 if (environment_inner[depth] != "!-- --") {
3048 item_name = "listitem";
3049 sgmlCloseTag(ofs, command_depth + depth,
3051 if (environment_inner[depth] == "varlistentry")
3052 sgmlCloseTag(ofs, depth+command_depth,
3053 environment_inner[depth]);
3055 sgmlCloseTag(ofs, depth + command_depth,
3056 environment_stack[depth]);
3057 environment_stack[depth].erase();
3058 environment_inner[depth].erase();
3061 if (depth == par->params().depth()
3062 && environment_stack[depth] != style.latexname()
3063 && !environment_stack[depth].empty()) {
3064 if (environment_inner[depth] != "!-- --") {
3065 item_name= "listitem";
3066 sgmlCloseTag(ofs, command_depth+depth,
3068 if (environment_inner[depth] == "varlistentry")
3070 depth + command_depth,
3071 environment_inner[depth]);
3074 sgmlCloseTag(ofs, depth + command_depth,
3075 environment_stack[depth]);
3077 environment_stack[depth].erase();
3078 environment_inner[depth].erase();
3081 // Write opening SGML tags.
3082 switch (style.latextype) {
3083 case LATEX_PARAGRAPH:
3084 sgmlOpenTag(ofs, depth + command_depth,
3091 _("Error : Wrong depth for "
3092 "LatexType Command.\n"));
3094 command_name = style.latexname();
3096 sgmlparam = style.latexparam();
3097 c_params = split(sgmlparam, c_depth,'|');
3099 cmd_depth = lyx::atoi(c_depth);
3102 if (cmd_depth < command_base) {
3103 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3104 sgmlCloseTag(ofs, j, command_stack[j]);
3105 command_depth = command_base = cmd_depth;
3106 } else if (cmd_depth <= command_depth) {
3107 for (int j = command_depth; j >= int(cmd_depth); --j)
3108 sgmlCloseTag(ofs, j, command_stack[j]);
3109 command_depth = cmd_depth;
3111 command_depth = cmd_depth;
3113 command_depth = command_base = cmd_depth;
3114 command_flag = true;
3116 if (command_stack.size() == command_depth + 1)
3117 command_stack.push_back(string());
3118 command_stack[command_depth] = command_name;
3120 // treat label as a special case for
3121 // more WYSIWYM handling.
3122 if (par->isInset(0)) {
3123 Inset * inset = par->getInset(0);
3124 Inset::Code lyx_code = inset->lyxCode();
3125 if (lyx_code == Inset::LABEL_CODE){
3126 command_name += " id=\"";
3127 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3128 command_name += "\"";
3133 sgmlOpenTag(ofs, depth + command_depth, command_name);
3134 if (c_params.empty())
3135 item_name = "title";
3137 item_name = c_params;
3138 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3141 case LATEX_ENVIRONMENT:
3142 case LATEX_ITEM_ENVIRONMENT:
3143 if (depth < par->params().depth()) {
3144 depth = par->params().depth();
3145 environment_stack[depth].erase();
3148 if (environment_stack[depth] != style.latexname()) {
3149 if(environment_stack.size() == depth + 1) {
3150 environment_stack.push_back("!-- --");
3151 environment_inner.push_back("!-- --");
3153 environment_stack[depth] = style.latexname();
3154 environment_inner[depth] = "!-- --";
3155 sgmlOpenTag(ofs, depth + command_depth,
3156 environment_stack[depth]);
3158 if (environment_inner[depth] != "!-- --") {
3159 item_name= "listitem";
3161 command_depth + depth,
3163 if (environment_inner[depth] == "varlistentry")
3165 depth + command_depth,
3166 environment_inner[depth]);
3170 if (style.latextype == LATEX_ENVIRONMENT) {
3171 if (!style.latexparam().empty()) {
3172 if(style.latexparam() == "CDATA")
3175 sgmlOpenTag(ofs, depth + command_depth,
3176 style.latexparam());
3181 desc_on = (style.labeltype == LABEL_MANUAL);
3184 environment_inner[depth]= "varlistentry";
3186 environment_inner[depth]= "listitem";
3188 sgmlOpenTag(ofs, depth + 1 + command_depth,
3189 environment_inner[depth]);
3193 sgmlOpenTag(ofs, depth + 1 + command_depth,
3197 sgmlOpenTag(ofs, depth + 1 + command_depth,
3202 sgmlOpenTag(ofs, depth + command_depth,
3207 simpleDocBookOnePar(ofs, par, desc_on, depth+1+command_depth);
3211 // write closing SGML tags
3212 switch (style.latextype) {
3214 if (c_params.empty())
3218 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3220 case LATEX_ENVIRONMENT:
3221 if (!style.latexparam().empty()) {
3222 if(style.latexparam() == "CDATA")
3225 sgmlCloseTag(ofs, depth + command_depth,
3226 style.latexparam());
3229 case LATEX_ITEM_ENVIRONMENT:
3230 if (desc_on == 1) break;
3232 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3234 case LATEX_PARAGRAPH:
3235 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3238 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3244 for (int d = depth; d >= 0; --d) {
3245 if (!environment_stack[depth].empty()) {
3246 if (environment_inner[depth] != "!-- --") {
3247 item_name = "listitem";
3248 sgmlCloseTag(ofs, command_depth + depth,
3250 if (environment_inner[depth] == "varlistentry")
3251 sgmlCloseTag(ofs, depth + command_depth,
3252 environment_inner[depth]);
3255 sgmlCloseTag(ofs, depth + command_depth,
3256 environment_stack[depth]);
3260 for (int j = command_depth; j >= 0 ; --j)
3261 if (!command_stack[j].empty())
3262 sgmlCloseTag(ofs, j, command_stack[j]);
3265 sgmlCloseTag(ofs, 0, top_element);
3268 // How to check for successful close
3272 void Buffer::simpleDocBookOnePar(ostream & os,
3273 Paragraph * par, int & desc_on,
3274 Paragraph::depth_type depth) const
3276 bool emph_flag = false;
3278 LyXLayout const & style = textclasslist.Style(params.textclass,
3281 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3283 int char_line_count = depth;
3284 //if (!style.free_spacing)
3285 // os << string(depth,' ');
3287 // parsing main loop
3288 for (Paragraph::size_type i = 0;
3289 i < par->size(); ++i) {
3290 LyXFont font = par->getFont(params, i);
3292 // handle <emphasis> tag
3293 if (font_old.emph() != font.emph()) {
3294 if (font.emph() == LyXFont::ON) {
3298 os << "</emphasis>";
3303 char c = par->getChar(i);
3305 if (c == Paragraph::META_INSET) {
3306 Inset * inset = par->getInset(i);
3307 inset->docbook(this, os);
3310 par->sgmlConvertChar(c, sgml_string);
3312 if (style.pass_thru) {
3314 } else if(style.free_spacing || c != ' ') {
3316 } else if (desc_on ==1) {
3318 os << "\n</term><listitem><para>";
3328 os << "</emphasis>";
3331 // resets description flag correctly
3333 // <term> not closed...
3336 if(style.free_spacing) os << '\n';
3340 // This should be enabled when the Chktex class is implemented. (Asger)
3341 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3342 // Other flags: -wall -v0 -x
3343 int Buffer::runChktex()
3345 if (!users->text) return 0;
3347 users->owner()->prohibitInput();
3349 // get LaTeX-Filename
3350 string const name = getLatexName();
3351 string path = OnlyPath(filename);
3353 string const org_path = path;
3354 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3358 Path p(path); // path to LaTeX file
3359 users->owner()->message(_("Running chktex..."));
3361 // Remove all error insets
3362 bool const removedErrorInsets = users->removeAutoInsets();
3364 // Generate the LaTeX file if neccessary
3365 makeLaTeXFile(name, org_path, false);
3368 Chktex chktex(lyxrc.chktex_command, name, filepath);
3369 int res = chktex.run(terr); // run chktex
3372 Alert::alert(_("chktex did not work!"),
3373 _("Could not run with file:"), name);
3374 } else if (res > 0) {
3375 // Insert all errors as errors boxes
3376 users->insertErrors(terr);
3379 // if we removed error insets before we ran chktex or if we inserted
3380 // error insets after we ran chktex, this must be run:
3381 if (removedErrorInsets || res){
3385 users->owner()->allowInput();
3391 void Buffer::validate(LaTeXFeatures & features) const
3393 Paragraph * par = paragraph;
3394 LyXTextClass const & tclass =
3395 textclasslist.TextClass(params.textclass);
3397 // AMS Style is at document level
3398 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3399 features.require("amsstyle");
3402 // We don't use "lyxerr.debug" because of speed. (Asger)
3403 if (lyxerr.debugging(Debug::LATEX))
3404 lyxerr << "Paragraph: " << par << endl;
3406 // Now just follow the list of paragraphs and run
3407 // validate on each of them.
3408 par->validate(features);
3410 // and then the next paragraph
3414 // the bullet shapes are buffer level not paragraph level
3415 // so they are tested here
3416 for (int i = 0; i < 4; ++i) {
3417 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3418 int const font = params.user_defined_bullets[i].getFont();
3420 int const c = params
3421 .user_defined_bullets[i]
3428 features.require("latexsym");
3430 } else if (font == 1) {
3431 features.require("amssymb");
3432 } else if ((font >= 2 && font <= 5)) {
3433 features.require("pifont");
3438 if (lyxerr.debugging(Debug::LATEX)) {
3439 features.showStruct();
3444 // This function should be in Buffer because it's a buffer's property (ale)
3445 string const Buffer::getIncludeonlyList(char delim)
3448 for (inset_iterator it = inset_iterator_begin();
3449 it != inset_iterator_end(); ++it) {
3450 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3451 InsetInclude * insetinc =
3452 static_cast<InsetInclude *>(*it);
3453 if (insetinc->isIncludeOnly()) {
3456 lst += insetinc->getRelFileBaseName();
3460 lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3465 vector<string> const Buffer::getLabelList()
3467 /// if this is a child document and the parent is already loaded
3468 /// Use the parent's list instead [ale990407]
3469 if (!params.parentname.empty()
3470 && bufferlist.exists(params.parentname)) {
3471 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3473 return tmp->getLabelList();
3476 vector<string> label_list;
3477 for (inset_iterator it = inset_iterator_begin();
3478 it != inset_iterator_end(); ++it) {
3479 vector<string> const l = (*it)->getLabelList();
3480 label_list.insert(label_list.end(), l.begin(), l.end());
3486 Buffer::Lists const Buffer::getLists() const
3489 Paragraph * par = paragraph;
3492 std::pair<bool, LyXTextClassList::size_type> const tmp =
3493 textclasslist.NumberOfLayout(params.textclass, "Caption");
3494 bool const found = tmp.first;
3495 LyXTextClassList::size_type const cap = tmp.second;
3498 // This is the prefered way to to this, but boost::tie can break
3501 LyXTextClassList::size_type cap;
3502 boost::tie(found, cap) = textclasslist
3503 .NumberOfLayout(params.textclass, "Caption");
3507 char const labeltype =
3508 textclasslist.Style(params.textclass,
3509 par->getLayout()).labeltype;
3511 if (labeltype >= LABEL_COUNTER_CHAPTER
3512 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3513 // insert this into the table of contents
3514 SingleList & item = l["TOC"];
3517 textclasslist.TextClass(params.textclass).maxcounter());
3518 item.push_back(TocItem(par, depth, par->asString(this, true)));
3520 // For each paragrph, traverse its insets and look for
3524 Paragraph::inset_iterator it =
3525 par->inset_iterator_begin();
3526 Paragraph::inset_iterator end =
3527 par->inset_iterator_end();
3529 for (; it != end; ++it) {
3530 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3532 static_cast<InsetFloat*>(*it);
3534 string const type = il->type();
3536 // Now find the caption in the float...
3537 // We now tranverse the paragraphs of
3539 Paragraph * tmp = il->inset.paragraph();
3541 if (tmp->layout == cap) {
3542 SingleList & item = l[type];
3544 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3545 item.push_back(TocItem(tmp, 0 , str));
3552 lyxerr << "caption not found" << endl;
3561 // This is also a buffer property (ale)
3562 vector<pair<string, string> > const Buffer::getBibkeyList()
3564 /// if this is a child document and the parent is already loaded
3565 /// Use the parent's list instead [ale990412]
3566 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3567 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3569 return tmp->getBibkeyList();
3572 vector<pair<string, string> > keys;
3573 Paragraph * par = paragraph;
3576 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3577 par->asString(this, false)));
3581 // Might be either using bibtex or a child has bibliography
3583 for (inset_iterator it = inset_iterator_begin();
3584 it != inset_iterator_end(); ++it) {
3585 // Search for Bibtex or Include inset
3586 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3587 vector<pair<string,string> > tmp =
3588 static_cast<InsetBibtex*>(*it)->getKeys(this);
3589 keys.insert(keys.end(), tmp.begin(), tmp.end());
3590 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3591 vector<pair<string,string> > const tmp =
3592 static_cast<InsetInclude*>(*it)->getKeys();
3593 keys.insert(keys.end(), tmp.begin(), tmp.end());
3602 bool Buffer::isDepClean(string const & name) const
3604 DEPCLEAN * item = dep_clean;
3605 while (item && item->master != name)
3607 if (!item) return true;
3612 void Buffer::markDepClean(string const & name)
3615 dep_clean = new DEPCLEAN;
3616 dep_clean->clean = true;
3617 dep_clean->master = name;
3618 dep_clean->next = 0;
3620 DEPCLEAN * item = dep_clean;
3621 while (item && item->master != name)
3626 item = new DEPCLEAN;
3628 item->master = name;
3635 bool Buffer::dispatch(string const & command)
3637 // Split command string into command and argument
3639 string line = frontStrip(command);
3640 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3642 return dispatch(lyxaction.LookupFunc(cmd), arg);
3646 bool Buffer::dispatch(int action, string const & argument)
3648 bool dispatched = true;
3651 Exporter::Export(this, argument, false);
3661 void Buffer::resizeInsets(BufferView * bv)
3663 /// then remove all LyXText in text-insets
3664 Paragraph * par = paragraph;
3665 for (; par; par = par->next()) {
3666 par->resizeInsetsLyXText(bv);
3671 void Buffer::redraw()
3678 void Buffer::changeLanguage(Language const * from, Language const * to)
3681 ParIterator end = par_iterator_end();
3682 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3683 (*it)->changeLanguage(params, from, to);
3687 bool Buffer::isMultiLingual()
3689 ParIterator end = par_iterator_end();
3690 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3691 if ((*it)->isMultiLingual(params))
3698 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph,
3699 Paragraph::size_type pos)
3702 it = par->InsetIterator(pos);
3703 if (it == par->inset_iterator_end()) {
3710 void Buffer::inset_iterator::setParagraph()
3713 it = par->inset_iterator_begin();
3714 if (it != par->inset_iterator_end())
3719 // We maintain an invariant that whenever par = 0 then it = 0
3723 Inset * Buffer::getInsetFromID(int id_arg) const
3725 for (inset_iterator it = inset_const_iterator_begin();
3726 it != inset_const_iterator_end(); ++it)
3728 if ((*it)->id() == id_arg)
3730 Inset * in = (*it)->getInsetFromID(id_arg);
3738 Paragraph * Buffer::getParFromID(int id) const
3740 if (id < 0) return 0;
3741 Paragraph * par = paragraph;
3743 if (par->id() == id) {
3746 Paragraph * tmp = par->getParFromID(id);
3756 ParIterator Buffer::par_iterator_begin()
3758 return ParIterator(paragraph);
3762 ParIterator Buffer::par_iterator_end()
3764 return ParIterator();