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/insetinfo.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/insetlist.h"
78 #include "insets/insettabular.h"
79 #include "insets/insettheorem.h"
80 #include "insets/insetcaption.h"
81 #include "insets/insetfloatlist.h"
82 #include "support/filetools.h"
83 #include "support/path.h"
84 #include "support/os.h"
89 #include "LaTeXFeatures.h"
90 #include "support/syscall.h"
91 #include "support/lyxlib.h"
92 #include "support/FileInfo.h"
93 #include "support/lyxmanip.h"
97 #include "lyx_gui_misc.h" // WarnReadonly()
98 #include "frontends/Dialogs.h"
100 #include "exporter.h"
101 #include "Lsstream.h"
102 #include "converter.h"
103 #include "BufferView.h"
104 #include "ParagraphParameters.h"
114 using std::make_pair;
122 // all these externs should eventually be removed.
123 extern BufferList bufferlist;
125 extern LyXAction lyxaction;
129 const int LYX_FORMAT = 220;
133 extern int tex_code_break_column;
136 Buffer::Buffer(string const & file, bool ronly)
138 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
140 filepath = OnlyPath(file);
149 if (read_only || (lyxrc.use_tempdir)) {
150 tmppath = CreateBufferTmpDir();
151 } else tmppath.erase();
157 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
158 // here the buffer should take care that it is
159 // saved properly, before it goes into the void.
161 // make sure that views using this buffer
166 if (!tmppath.empty()) {
167 DestroyBufferTmpDir(tmppath);
170 Paragraph * par = paragraph;
173 tmppar = par->next();
181 string const Buffer::getLatexName(bool no_path) const
183 string name = ChangeExtension(MakeLatexName(filename), ".tex");
185 return OnlyFilename(name);
191 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
193 string const filename = getLatexName(false);
195 if (filename.empty())
196 return make_pair(Buffer::latexlog, string());
198 string path = OnlyPath(filename);
200 if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1))
203 string const fname = AddName(path,
204 OnlyFilename(ChangeExtension(filename,
207 AddName(path, OnlyFilename(
208 ChangeExtension(filename,
209 formats.Extension("literate") + ".out")));
211 // If no Latex log or Build log is newer, show Build log
213 FileInfo const f_fi(fname);
214 FileInfo const b_fi(bname);
217 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
218 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
219 return make_pair(Buffer::buildlog, bname);
221 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
222 return make_pair(Buffer::latexlog, fname);
226 void Buffer::setReadonly(bool flag)
228 if (read_only != flag) {
231 users->owner()->getDialogs()->updateBufferDependent(false);
234 WarnReadonly(filename);
239 bool Buffer::saveParamsAsDefaults() // const
241 string const fname = AddName(AddPath(user_lyxdir, "templates/"),
243 Buffer defaults = Buffer(fname);
245 // Use the current buffer's parameters as default
246 defaults.params = params;
248 // add an empty paragraph. Is this enough?
249 defaults.paragraph = new Paragraph;
251 return defaults.writeFile(defaults.filename, false);
255 /// Update window titles of all users
256 // Should work on a list
257 void Buffer::updateTitles() const
259 if (users) users->owner()->updateWindowTitle();
263 /// Reset autosave timer of all users
264 // Should work on a list
265 void Buffer::resetAutosaveTimers() const
267 if (users) users->owner()->resetAutosaveTimer();
271 void Buffer::setFileName(string const & newfile)
273 filename = MakeAbsPath(newfile);
274 filepath = OnlyPath(filename);
275 setReadonly(IsFileWriteable(filename) == 0);
280 // We'll remove this later. (Lgb)
283 string last_inset_read;
287 ErtComp() : active(false), in_tabular(false) {
294 std::stack<ErtComp> ert_stack;
303 // candidate for move to BufferView
304 // (at least some parts in the beginning of the func)
307 // changed to be public and have one parameter
308 // if par = 0 normal behavior
309 // else insert behavior
310 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
311 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
315 ert_comp.contents.erase();
316 ert_comp.active = false;
317 ert_comp.in_tabular = false;
321 Paragraph::depth_type depth = 0;
322 bool the_end_read = false;
324 Paragraph * first_par = 0;
325 LyXFont font(LyXFont::ALL_INHERIT, params.language);
326 if (file_format < 216 && params.language->lang() == "hebrew")
327 font.setLanguage(default_language);
332 // We are inserting into an existing document
333 users->text->breakParagraph(users);
334 first_par = users->text->firstParagraph();
337 // We don't want to adopt the parameters from the
338 // document we insert, so we skip until the text begins:
341 string const pretoken = lex.GetString();
342 if (pretoken == "\\layout") {
343 lex.pushToken(pretoken);
351 string const token = lex.GetString();
353 if (token.empty()) continue;
355 lyxerr[Debug::PARSER] << "Handling token: `"
356 << token << "'" << endl;
359 parseSingleLyXformat2Token(lex, par, first_par,
367 paragraph = first_par;
369 if (unknown_layouts > 0) {
370 string s = _("Couldn't set the layout for ");
371 if (unknown_layouts == 1) {
372 s += _("one paragraph");
374 s += tostr(unknown_layouts);
375 s += _(" paragraphs");
377 WriteAlert(_("Textclass Loading Error!"), s,
378 _("When reading " + fileName()));
385 void Buffer::insertErtContents(Paragraph * par, int & pos,
386 LyXFont const & font, bool set_inactive)
388 if (!ert_comp.contents.empty()) {
389 lyxerr[Debug::INSETS] << "ERT contents:\n"
390 << ert_comp.contents << endl;
391 Inset * inset = new InsetERT(ert_comp.contents);
392 par->insertInset(pos++, inset, font);
393 ert_comp.contents.erase();
396 ert_comp.active = false;
402 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
403 Paragraph *& first_par,
404 string const & token, int & pos,
405 Paragraph::depth_type & depth,
409 bool the_end_read = false;
410 #ifndef NO_PEXTRA_REALLY
411 // This is super temporary but is needed to get the compability
412 // mode for minipages work correctly together with new tabulars.
413 static int call_depth;
415 bool checkminipage = false;
416 static Paragraph * minipar;
417 static Paragraph * parBeforeMinipage;
420 if (token[0] != '\\') {
422 if (ert_comp.active) {
423 ert_comp.contents += token;
426 for (string::const_iterator cit = token.begin();
427 cit != token.end(); ++cit) {
428 par->insertChar(pos, (*cit), font);
431 checkminipage = true;
435 } else if (token == "\\i") {
436 Inset * inset = new InsetLatexAccent;
437 inset->read(this, lex);
438 par->insertInset(pos, inset, font);
440 } else if (token == "\\layout") {
442 ert_comp.in_tabular = false;
444 insertErtContents(par, pos, font);
447 string const layoutname = lex.GetString();
448 pair<bool, LyXTextClass::LayoutList::size_type> pp
449 = textclasslist.NumberOfLayout(params.textclass,
453 if (compare_no_case(layoutname, "latex") == 0) {
454 ert_comp.active = true;
458 // The is the compability reading of layout caption.
459 // It can be removed in LyX version 1.3.0. (Lgb)
460 if (compare_no_case(layoutname, "caption") == 0) {
461 // We expect that the par we are now working on is
462 // really inside a InsetText inside a InsetFloat.
463 // We also know that captions can only be
464 // one paragraph. (Lgb)
466 // We should now read until the next "\layout"
468 // This is probably not good enough, what if the
469 // caption is the last par in the document (Lgb)
470 istream & ist = lex.getStream();
476 if (prefixIs(line, "\\layout")) {
480 if (prefixIs(line, "\\begin_inset"))
482 if (prefixIs(line, "\\end_inset")) {
493 // Now we should have the whole layout in ss
494 // we should now be able to give this to the
496 ss << "\\end_inset\n";
498 // This seems like a bug in stringstream.
499 // We really should be able to use ss
501 istringstream is(ss.str());
503 tmplex.setStream(is);
504 Inset * inset = new InsetCaption;
505 inset->Read(this, tmplex);
506 par->InsertInset(pos, inset, font);
513 par = new Paragraph(par);
517 par->layout = pp.second;
520 // use default layout "Standard" (0)
523 string const s = _("Layout had to be changed from\n")
524 + layoutname + _(" to ")
525 + textclasslist.NameOfLayout(params.textclass, par->layout);
526 InsetError * new_inset = new InsetError(s);
527 par->insertInset(0, new_inset);
529 // Test whether the layout is obsolete.
530 LyXLayout const & layout =
531 textclasslist.Style(params.textclass,
533 if (!layout.obsoleted_by().empty())
534 par->layout = textclasslist
535 .NumberOfLayout(params.textclass,
536 layout.obsoleted_by())
538 par->params().depth(depth);
539 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
540 if (file_format < 216
541 && params.language->lang() == "hebrew")
542 font.setLanguage(default_language);
547 } else if (token == "\\begin_float") {
548 // This is the compability reader. It can be removed in
549 // LyX version 1.3.0. (Lgb)
551 string const tmptok = lex.GetString();
552 //lyxerr << "old float: " << tmptok << endl;
555 stringstream old_float;
557 if (tmptok == "footnote") {
558 inset = new InsetFoot;
559 } else if (tmptok == "margin") {
560 inset = new InsetMarginal;
561 } else if (tmptok == "fig") {
562 inset = new InsetFloat("figure");
563 old_float << "placement htbp\n"
565 } else if (tmptok == "tab") {
566 inset = new InsetFloat("table");
567 old_float << "placement htbp\n"
569 } else if (tmptok == "alg") {
570 inset = new InsetFloat("algorithm");
571 old_float << "placement htbp\n"
573 } else if (tmptok == "wide-fig") {
574 inset = new InsetFloat("figure");
575 //InsetFloat * tmp = new InsetFloat("figure");
578 old_float << "placement htbp\n"
580 } else if (tmptok == "wide-tab") {
581 inset = new InsetFloat("table");
582 //InsetFloat * tmp = new InsetFloat("table");
585 old_float << "placement htbp\n"
591 return false; // no end read yet
594 old_float << "collapsed true\n";
596 // Here we need to check for \end_deeper and handle that
597 // before we do the footnote parsing.
598 // This _is_ a hack! (Lgb)
601 string const tmp = lex.GetString();
602 if (tmp == "\\end_deeper") {
603 //lyxerr << "\\end_deeper caught!" << endl;
605 lex.printError("\\end_deeper: "
606 "depth is already null");
611 old_float << tmp << ' ';
616 old_float << lex.getLongString("\\end_float")
617 << "\n\\end_inset\n";
618 //lyxerr << "Float Body:\n" << old_float.str() << endl;
619 // That this does not work seems like a bug
620 // in stringstream. (Lgb)
621 istringstream istr(old_float.str());
623 nylex.setStream(istr);
624 inset->read(this, nylex);
625 par->insertInset(pos, inset, font);
627 } else if (token == "\\begin_deeper") {
629 } else if (token == "\\end_deeper") {
631 lex.printError("\\end_deeper: "
632 "depth is already null");
636 } else if (token == "\\begin_preamble") {
637 params.readPreamble(lex);
638 } else if (token == "\\textclass") {
640 pair<bool, LyXTextClassList::size_type> pp =
641 textclasslist.NumberOfClass(lex.GetString());
643 params.textclass = pp.second;
645 WriteAlert(string(_("Textclass error")),
646 string(_("The document uses an unknown textclass \"")) +
647 lex.GetString() + string("\"."),
648 string(_("LyX will not be able to produce output correctly.")));
649 params.textclass = 0;
651 if (!textclasslist.Load(params.textclass)) {
652 // if the textclass wasn't loaded properly
653 // we need to either substitute another
654 // or stop loading the file.
655 // I can substitute but I don't see how I can
656 // stop loading... ideas?? ARRae980418
657 WriteAlert(_("Textclass Loading Error!"),
658 string(_("Can't load textclass ")) +
659 textclasslist.NameOfClass(params.textclass),
660 _("-- substituting default"));
661 params.textclass = 0;
663 } else if (token == "\\options") {
665 params.options = lex.GetString();
666 } else if (token == "\\language") {
667 params.readLanguage(lex);
668 } else if (token == "\\fontencoding") {
670 } else if (token == "\\inputencoding") {
672 params.inputenc = lex.GetString();
673 } else if (token == "\\graphics") {
674 params.readGraphicsDriver(lex);
675 } else if (token == "\\fontscheme") {
677 params.fonts = lex.GetString();
678 } else if (token == "\\noindent") {
679 par->params().noindent(true);
680 } else if (token == "\\fill_top") {
681 par->params().spaceTop(VSpace(VSpace::VFILL));
682 } else if (token == "\\fill_bottom") {
683 par->params().spaceBottom(VSpace(VSpace::VFILL));
684 } else if (token == "\\line_top") {
685 par->params().lineTop(true);
686 } else if (token == "\\line_bottom") {
687 par->params().lineBottom(true);
688 } else if (token == "\\pagebreak_top") {
689 par->params().pagebreakTop(true);
690 } else if (token == "\\pagebreak_bottom") {
691 par->params().pagebreakBottom(true);
692 } else if (token == "\\start_of_appendix") {
693 par->params().startOfAppendix(true);
694 } else if (token == "\\paragraph_separation") {
695 int tmpret = lex.FindToken(string_paragraph_separation);
696 if (tmpret == -1) ++tmpret;
697 if (tmpret != LYX_LAYOUT_DEFAULT)
698 params.paragraph_separation =
699 static_cast<BufferParams::PARSEP>(tmpret);
700 } else if (token == "\\defskip") {
702 params.defskip = VSpace(lex.GetString());
703 } else if (token == "\\epsfig") { // obsolete
704 // Indeed it is obsolete, but we HAVE to be backwards
705 // compatible until 0.14, because otherwise all figures
706 // in existing documents are irretrivably lost. (Asger)
707 params.readGraphicsDriver(lex);
708 } else if (token == "\\quotes_language") {
709 int tmpret = lex.FindToken(string_quotes_language);
710 if (tmpret == -1) ++tmpret;
711 if (tmpret != LYX_LAYOUT_DEFAULT) {
712 InsetQuotes::quote_language tmpl =
713 InsetQuotes::EnglishQ;
716 tmpl = InsetQuotes::EnglishQ;
719 tmpl = InsetQuotes::SwedishQ;
722 tmpl = InsetQuotes::GermanQ;
725 tmpl = InsetQuotes::PolishQ;
728 tmpl = InsetQuotes::FrenchQ;
731 tmpl = InsetQuotes::DanishQ;
734 params.quotes_language = tmpl;
736 } else if (token == "\\quotes_times") {
738 switch (lex.GetInteger()) {
740 params.quotes_times = InsetQuotes::SingleQ;
743 params.quotes_times = InsetQuotes::DoubleQ;
746 } else if (token == "\\papersize") {
747 int tmpret = lex.FindToken(string_papersize);
751 params.papersize2 = tmpret;
752 } else if (token == "\\paperpackage") {
753 int tmpret = lex.FindToken(string_paperpackages);
756 params.paperpackage = BufferParams::PACKAGE_NONE;
758 params.paperpackage = tmpret;
759 } else if (token == "\\use_geometry") {
761 params.use_geometry = lex.GetInteger();
762 } else if (token == "\\use_amsmath") {
764 params.use_amsmath = lex.GetInteger();
765 } else if (token == "\\paperorientation") {
766 int tmpret = lex.FindToken(string_orientation);
767 if (tmpret == -1) ++tmpret;
768 if (tmpret != LYX_LAYOUT_DEFAULT)
769 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
770 } else if (token == "\\paperwidth") {
772 params.paperwidth = lex.GetString();
773 } else if (token == "\\paperheight") {
775 params.paperheight = lex.GetString();
776 } else if (token == "\\leftmargin") {
778 params.leftmargin = lex.GetString();
779 } else if (token == "\\topmargin") {
781 params.topmargin = lex.GetString();
782 } else if (token == "\\rightmargin") {
784 params.rightmargin = lex.GetString();
785 } else if (token == "\\bottommargin") {
787 params.bottommargin = lex.GetString();
788 } else if (token == "\\headheight") {
790 params.headheight = lex.GetString();
791 } else if (token == "\\headsep") {
793 params.headsep = lex.GetString();
794 } else if (token == "\\footskip") {
796 params.footskip = lex.GetString();
797 } else if (token == "\\paperfontsize") {
799 params.fontsize = strip(lex.GetString());
800 } else if (token == "\\papercolumns") {
802 params.columns = lex.GetInteger();
803 } else if (token == "\\papersides") {
805 switch (lex.GetInteger()) {
807 case 1: params.sides = LyXTextClass::OneSide; break;
808 case 2: params.sides = LyXTextClass::TwoSides; break;
810 } else if (token == "\\paperpagestyle") {
812 params.pagestyle = strip(lex.GetString());
813 } else if (token == "\\bullet") {
815 int const index = lex.GetInteger();
817 int temp_int = lex.GetInteger();
818 params.user_defined_bullets[index].setFont(temp_int);
819 params.temp_bullets[index].setFont(temp_int);
821 temp_int = lex.GetInteger();
822 params.user_defined_bullets[index].setCharacter(temp_int);
823 params.temp_bullets[index].setCharacter(temp_int);
825 temp_int = lex.GetInteger();
826 params.user_defined_bullets[index].setSize(temp_int);
827 params.temp_bullets[index].setSize(temp_int);
829 string const temp_str = lex.GetString();
830 if (temp_str != "\\end_bullet") {
831 // this element isn't really necessary for
832 // parsing but is easier for humans
833 // to understand bullets. Put it back and
834 // set a debug message?
835 lex.printError("\\end_bullet expected, got" + temp_str);
836 //how can I put it back?
838 } else if (token == "\\bulletLaTeX") {
840 int const index = lex.GetInteger();
842 string temp_str = lex.GetString();
844 while (temp_str != "\\end_bullet") {
845 // this loop structure is needed when user
846 // enters an empty string since the first
847 // thing returned will be the \\end_bullet
849 // if the LaTeX entry has spaces. Each element
850 // therefore needs to be read in turn
853 temp_str = lex.GetString();
855 params.user_defined_bullets[index].setText(sum_str);
856 params.temp_bullets[index].setText(sum_str);
857 } else if (token == "\\secnumdepth") {
859 params.secnumdepth = lex.GetInteger();
860 } else if (token == "\\tocdepth") {
862 params.tocdepth = lex.GetInteger();
863 } else if (token == "\\spacing") {
865 string const tmp = strip(lex.GetString());
866 Spacing::Space tmp_space = Spacing::Default;
868 if (tmp == "single") {
869 tmp_space = Spacing::Single;
870 } else if (tmp == "onehalf") {
871 tmp_space = Spacing::Onehalf;
872 } else if (tmp == "double") {
873 tmp_space = Spacing::Double;
874 } else if (tmp == "other") {
876 tmp_space = Spacing::Other;
877 tmp_val = lex.GetFloat();
879 lex.printError("Unknown spacing token: '$$Token'");
881 // Small hack so that files written with klyx will be
884 par->params().spacing(Spacing(tmp_space, tmp_val));
886 params.spacing.set(tmp_space, tmp_val);
888 } else if (token == "\\paragraph_spacing") {
890 string const tmp = strip(lex.GetString());
891 if (tmp == "single") {
892 par->params().spacing(Spacing(Spacing::Single));
893 } else if (tmp == "onehalf") {
894 par->params().spacing(Spacing(Spacing::Onehalf));
895 } else if (tmp == "double") {
896 par->params().spacing(Spacing(Spacing::Double));
897 } else if (tmp == "other") {
899 par->params().spacing(Spacing(Spacing::Other,
902 lex.printError("Unknown spacing token: '$$Token'");
904 } else if (token == "\\float_placement") {
906 params.float_placement = lex.GetString();
907 } else if (token == "\\family") {
909 font.setLyXFamily(lex.GetString());
910 } else if (token == "\\series") {
912 font.setLyXSeries(lex.GetString());
913 } else if (token == "\\shape") {
915 font.setLyXShape(lex.GetString());
916 } else if (token == "\\size") {
918 font.setLyXSize(lex.GetString());
921 #warning compatability hack needed
923 } else if (token == "\\latex") {
925 string const tok = lex.GetString();
926 // This is dirty, but gone with LyX3. (Asger)
927 if (tok == "no_latex")
928 font.setLatex(LyXFont::OFF);
929 else if (tok == "latex")
930 font.setLatex(LyXFont::ON);
931 else if (tok == "default")
932 font.setLatex(LyXFont::INHERIT);
934 lex.printError("Unknown LaTeX font flag "
937 } else if (token == "\\latex") {
939 string const tok = lex.GetString();
940 if (tok == "no_latex") {
942 insertErtContents(par, pos, font);
943 } else if (tok == "latex") {
944 ert_comp.active = true;
945 } else if (tok == "default") {
947 insertErtContents(par, pos, font);
949 lex.printError("Unknown LaTeX font flag "
953 } else if (token == "\\lang") {
955 string const tok = lex.GetString();
956 Language const * lang = languages.getLanguage(tok);
958 font.setLanguage(lang);
960 font.setLanguage(params.language);
961 lex.printError("Unknown language `$$Token'");
963 } else if (token == "\\numeric") {
965 font.setNumber(font.setLyXMisc(lex.GetString()));
966 } else if (token == "\\emph") {
968 font.setEmph(font.setLyXMisc(lex.GetString()));
969 } else if (token == "\\bar") {
971 string const tok = lex.GetString();
972 // This is dirty, but gone with LyX3. (Asger)
974 font.setUnderbar(LyXFont::ON);
975 else if (tok == "no")
976 font.setUnderbar(LyXFont::OFF);
977 else if (tok == "default")
978 font.setUnderbar(LyXFont::INHERIT);
980 lex.printError("Unknown bar font flag "
982 } else if (token == "\\noun") {
984 font.setNoun(font.setLyXMisc(lex.GetString()));
985 } else if (token == "\\color") {
987 font.setLyXColor(lex.GetString());
988 } else if (token == "\\align") {
989 int tmpret = lex.FindToken(string_align);
990 if (tmpret == -1) ++tmpret;
991 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
992 int const tmpret2 = int(pow(2.0, tmpret));
993 //lyxerr << "Tmpret2 = " << tmpret2 << endl;
994 par->params().align(LyXAlignment(tmpret2));
996 } else if (token == "\\added_space_top") {
998 par->params().spaceTop(VSpace(lex.GetString()));
999 } else if (token == "\\added_space_bottom") {
1001 par->params().spaceBottom(VSpace(lex.GetString()));
1002 #ifndef NO_PEXTRA_REALLY
1003 } else if (token == "\\pextra_type") {
1005 par->params().pextraType(lex.GetInteger());
1006 } else if (token == "\\pextra_width") {
1008 par->params().pextraWidth(lex.GetString());
1009 } else if (token == "\\pextra_widthp") {
1011 par->params().pextraWidthp(lex.GetString());
1012 } else if (token == "\\pextra_alignment") {
1014 par->params().pextraAlignment(lex.GetInteger());
1015 } else if (token == "\\pextra_hfill") {
1017 par->params().pextraHfill(lex.GetInteger());
1018 } else if (token == "\\pextra_start_minipage") {
1020 par->params().pextraStartMinipage(lex.GetInteger());
1022 } else if (token == "\\labelwidthstring") {
1024 par->params().labelWidthString(lex.GetString());
1025 // do not delete this token, it is still needed!
1026 } else if (token == "\\end_inset") {
1027 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
1028 << "Last inset read was: " << last_inset_read
1030 // Simply ignore this. The insets do not have
1032 // But insets should read it, it is a part of
1033 // the inset isn't it? Lgb.
1034 } else if (token == "\\begin_inset") {
1036 insertErtContents(par, pos, font, false);
1037 ert_stack.push(ert_comp);
1038 ert_comp = ErtComp();
1040 readInset(lex, par, pos, font);
1042 ert_comp = ert_stack.top();
1045 } else if (token == "\\SpecialChar") {
1046 LyXLayout const & layout =
1047 textclasslist.Style(params.textclass,
1050 // Insets don't make sense in a free-spacing context! ---Kayvan
1051 if (layout.free_spacing) {
1054 string next_token = lex.GetString();
1055 if (next_token == "\\-") {
1056 par->insertChar(pos, '-', font);
1057 } else if (next_token == "\\protected_separator"
1058 || next_token == "~") {
1059 par->insertChar(pos, ' ', font);
1061 lex.printError("Token `$$Token' "
1063 "paragraph layout!");
1068 Inset * inset = new InsetSpecialChar;
1069 inset->read(this, lex);
1070 par->insertInset(pos, inset, font);
1073 } else if (token == "\\newline") {
1076 if (!ert_comp.in_tabular && ert_comp.active) {
1077 ert_comp.contents += char(Paragraph::META_NEWLINE);
1079 // Since we cannot know it this is only a regular
1080 // newline or a tabular cell delimter we have to
1081 // handle the ERT here.
1082 insertErtContents(par, pos, font, false);
1084 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1088 par->insertChar(pos, Paragraph::META_NEWLINE, font);
1091 } else if (token == "\\LyXTable") {
1093 ert_comp.in_tabular = true;
1095 Inset * inset = new InsetTabular(*this);
1096 inset->read(this, lex);
1097 par->insertInset(pos, inset, font);
1099 // because of OLD_TABULAR_READ where tabulars have been
1101 checkminipage = true;
1102 } else if (token == "\\hfill") {
1103 par->insertChar(pos, Paragraph::META_HFILL, font);
1105 } else if (token == "\\protected_separator") { // obsolete
1106 // This is a backward compability thingie. (Lgb)
1107 // Remove it later some time...introduced with fileformat
1109 LyXLayout const & layout =
1110 textclasslist.Style(params.textclass,
1113 if (layout.free_spacing) {
1114 par->insertChar(pos, ' ', font);
1116 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
1117 par->insertInset(pos, inset, font);
1120 } else if (token == "\\bibitem") { // ale970302
1122 InsetCommandParams p("bibitem", "dummy");
1123 par->bibkey = new InsetBibKey(p);
1125 par->bibkey->read(this, lex);
1126 } else if (token == "\\backslash") {
1128 if (ert_comp.active) {
1129 ert_comp.contents += "\\";
1132 par->insertChar(pos, '\\', font);
1137 } else if (token == "\\the_end") {
1139 // If we still have some ert active here we have to insert
1140 // it so we don't loose it. (Lgb)
1141 insertErtContents(par, pos, font);
1143 the_end_read = true;
1144 minipar = parBeforeMinipage = 0;
1147 if (ert_comp.active) {
1148 ert_comp.contents += token;
1151 // This should be insurance for the future: (Asger)
1152 lex.printError("Unknown token `$$Token'. "
1153 "Inserting as text.");
1154 string::const_iterator cit = token.begin();
1155 string::const_iterator end = token.end();
1156 for (; cit != end; ++cit) {
1157 par->insertChar(pos, (*cit), font);
1164 #ifndef NO_PEXTRA_REALLY
1165 // now check if we have a minipage paragraph as at this
1166 // point we already read all the necessary data!
1167 // this cannot be done in layout because there we did
1168 // not read yet the paragraph PEXTRA-params (Jug)
1170 // BEGIN pextra_minipage compability
1171 // This should be removed in 1.3.x (Lgb)
1173 // This compability code is not perfect. In a couple
1174 // of rand cases it fails. When the minipage par is
1175 // the first par in the document, and when there are
1176 // none or only one regular paragraphs after the
1177 // minipage. Currently I am not investing any effort
1178 // in fixing those cases.
1180 //lyxerr << "Call depth: " << call_depth << endl;
1181 if (checkminipage && (call_depth == 1)) {
1182 checkminipage = false;
1183 if (minipar && (minipar != par) &&
1184 (par->params().pextraType()==Paragraph::PEXTRA_MINIPAGE))
1186 lyxerr << "minipages in a row" << endl;
1187 if (par->params().pextraStartMinipage()) {
1188 lyxerr << "start new minipage" << endl;
1189 // minipages in a row
1190 par->previous()->next(0);
1193 Paragraph * tmp = minipar;
1195 tmp->params().pextraType(0);
1196 tmp->params().pextraWidth(string());
1197 tmp->params().pextraWidthp(string());
1198 tmp->params().pextraAlignment(0);
1199 tmp->params().pextraHfill(false);
1200 tmp->params().pextraStartMinipage(false);
1203 // create a new paragraph to insert the
1204 // minipages in the following case
1205 if (par->params().pextraStartMinipage() &&
1206 !par->params().pextraHfill())
1208 Paragraph * p = new Paragraph;
1210 p->previous(parBeforeMinipage);
1211 parBeforeMinipage->next(p);
1213 p->params().depth(parBeforeMinipage->params().depth());
1214 parBeforeMinipage = p;
1216 InsetMinipage * mini = new InsetMinipage;
1217 mini->pos(static_cast<InsetMinipage::Position>(par->params().pextraAlignment()));
1218 mini->width(par->params().pextraWidth());
1219 if (!par->params().pextraWidthp().empty()) {
1220 lyxerr << "WP:" << mini->width() << endl;
1221 mini->width(tostr(par->params().pextraWidthp())+"%");
1223 mini->inset.paragraph(par);
1224 // Insert the minipage last in the
1225 // previous paragraph.
1226 if (par->params().pextraHfill()) {
1227 parBeforeMinipage->insertChar
1228 (parBeforeMinipage->size(), Paragraph::META_HFILL);
1230 parBeforeMinipage->insertInset
1231 (parBeforeMinipage->size(), mini);
1235 lyxerr << "new minipage par" << endl;
1236 //nothing to do just continue reading
1239 } else if (minipar && (minipar != par)) {
1240 lyxerr << "last minipage par read" << endl;
1241 // The last paragraph read was not part of a
1242 // minipage but the par linked list is...
1243 // So we need to remove the last par from the
1245 if (par->previous())
1246 par->previous()->next(0);
1247 par->previous(parBeforeMinipage);
1248 parBeforeMinipage->next(par);
1249 Paragraph * tmp = minipar;
1251 tmp->params().pextraType(0);
1252 tmp->params().pextraWidth(string());
1253 tmp->params().pextraWidthp(string());
1254 tmp->params().pextraAlignment(0);
1255 tmp->params().pextraHfill(false);
1256 tmp->params().pextraStartMinipage(false);
1259 depth = parBeforeMinipage->params().depth();
1260 minipar = parBeforeMinipage = 0;
1261 } else if (!minipar &&
1262 (par->params().pextraType() == Paragraph::PEXTRA_MINIPAGE))
1264 // par is the first paragraph in a minipage
1265 lyxerr << "begin minipage" << endl;
1266 // To minimize problems for
1267 // the users we will insert
1268 // the first minipage in
1269 // a sequence of minipages
1270 // in its own paragraph.
1271 Paragraph * p = new Paragraph;
1273 p->previous(par->previous());
1275 p->params().depth(depth);
1276 par->params().depth(0);
1278 if (par->previous())
1279 par->previous()->next(p);
1281 parBeforeMinipage = p;
1283 if (!first_par || (first_par == par))
1286 InsetMinipage * mini = new InsetMinipage;
1287 mini->pos(static_cast<InsetMinipage::Position>(minipar->params().pextraAlignment()));
1288 mini->width(minipar->params().pextraWidth());
1289 if (!par->params().pextraWidthp().empty()) {
1290 lyxerr << "WP:" << mini->width() << endl;
1291 mini->width(tostr(par->params().pextraWidthp())+"%");
1293 mini->inset.paragraph(minipar);
1295 // Insert the minipage last in the
1296 // previous paragraph.
1297 if (minipar->params().pextraHfill()) {
1298 parBeforeMinipage->insertChar
1299 (parBeforeMinipage->size(),Paragraph::META_HFILL);
1301 parBeforeMinipage->insertInset
1302 (parBeforeMinipage->size(), mini);
1305 // End of pextra_minipage compability
1308 return the_end_read;
1312 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1313 int & pos, LyXFont & font)
1315 // consistency check
1316 if (lex.GetString() != "\\begin_inset") {
1317 lyxerr << "Buffer::readInset: Consistency check failed."
1324 string const tmptok = lex.GetString();
1325 last_inset_read = tmptok;
1327 // test the different insets
1328 if (tmptok == "LatexCommand") {
1329 InsetCommandParams inscmd;
1332 string const cmdName = inscmd.getCmdName();
1334 if (cmdName == "cite") {
1335 inset = new InsetCitation(inscmd);
1336 } else if (cmdName == "bibitem") {
1337 lex.printError("Wrong place for bibitem");
1338 inset = new InsetBibKey(inscmd);
1339 } else if (cmdName == "BibTeX") {
1340 inset = new InsetBibtex(inscmd);
1341 } else if (cmdName == "index") {
1342 inset = new InsetIndex(inscmd);
1343 } else if (cmdName == "include") {
1344 inset = new InsetInclude(inscmd, *this);
1345 } else if (cmdName == "label") {
1346 inset = new InsetLabel(inscmd);
1347 } else if (cmdName == "url"
1348 || cmdName == "htmlurl") {
1349 inset = new InsetUrl(inscmd);
1350 } else if (cmdName == "ref"
1351 || cmdName == "pageref"
1352 || cmdName == "vref"
1353 || cmdName == "vpageref"
1354 || cmdName == "prettyref") {
1355 if (!inscmd.getOptions().empty()
1356 || !inscmd.getContents().empty()) {
1357 inset = new InsetRef(inscmd, *this);
1359 } else if (cmdName == "tableofcontents") {
1360 inset = new InsetTOC(inscmd);
1361 } else if (cmdName == "listofalgorithms") {
1362 inset = new InsetFloatList("algorithm");
1363 } else if (cmdName == "listoffigures") {
1364 inset = new InsetFloatList("figure");
1365 } else if (cmdName == "listoftables") {
1366 inset = new InsetFloatList("table");
1367 } else if (cmdName == "printindex") {
1368 inset = new InsetPrintIndex(inscmd);
1369 } else if (cmdName == "lyxparent") {
1370 inset = new InsetParent(inscmd, *this);
1373 if (tmptok == "Quotes") {
1374 inset = new InsetQuotes;
1375 } else if (tmptok == "External") {
1376 inset = new InsetExternal;
1377 } else if (tmptok == "FormulaMacro") {
1378 inset = new InsetFormulaMacro;
1379 } else if (tmptok == "Formula") {
1380 inset = new InsetFormula;
1381 } else if (tmptok == "Figure") {
1382 inset = new InsetFig(100, 100, *this);
1383 } else if (tmptok == "Info") {
1384 inset = new InsetInfo;
1385 } else if (tmptok == "Include") {
1386 InsetCommandParams p( "Include" );
1387 inset = new InsetInclude(p, *this);
1388 } else if (tmptok == "ERT") {
1389 inset = new InsetERT;
1390 } else if (tmptok == "Tabular") {
1391 inset = new InsetTabular(*this);
1392 } else if (tmptok == "Text") {
1393 inset = new InsetText;
1394 } else if (tmptok == "Foot") {
1395 inset = new InsetFoot;
1396 } else if (tmptok == "Marginal") {
1397 inset = new InsetMarginal;
1398 } else if (tmptok == "Minipage") {
1399 inset = new InsetMinipage;
1400 } else if (tmptok == "Float") {
1402 string tmptok = lex.GetString();
1403 inset = new InsetFloat(tmptok);
1404 } else if (tmptok == "List") {
1405 inset = new InsetList;
1406 } else if (tmptok == "Theorem") {
1407 inset = new InsetList;
1408 } else if (tmptok == "Caption") {
1409 inset = new InsetCaption;
1410 } else if (tmptok == "GRAPHICS") {
1411 inset = new InsetGraphics;
1412 } else if (tmptok == "FloatList") {
1413 inset = new InsetFloatList;
1416 if (inset) inset->read(this, lex);
1420 par->insertInset(pos, inset, font);
1426 bool Buffer::readFile(LyXLex & lex, Paragraph * par)
1430 string const token(lex.GetString());
1431 if (token == "\\lyxformat") { // the first token _must_ be...
1433 string tmp_format = lex.GetString();
1434 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1435 // if present remove ".," from string.
1436 string::size_type dot = tmp_format.find_first_of(".,");
1437 //lyxerr << " dot found at " << dot << endl;
1438 if (dot != string::npos)
1439 tmp_format.erase(dot, 1);
1440 file_format = strToInt(tmp_format);
1441 if (file_format == LYX_FORMAT) {
1443 } else if (file_format > LYX_FORMAT) {
1445 WriteAlert(_("Warning!"),
1446 _("LyX file format is newer that what"),
1447 _("is supported in this LyX version. Expect some problems."));
1449 } else if (file_format < LYX_FORMAT) {
1451 if (file_format < 200) {
1452 WriteAlert(_("ERROR!"),
1453 _("Old LyX file format found. "
1454 "Use LyX 0.10.x to read this!"));
1458 bool the_end = readLyXformat2(lex, par);
1460 // the_end was added in 213
1461 if (file_format < 213)
1465 WriteAlert(_("Warning!"),
1466 _("Reading of document is not complete"),
1467 _("Maybe the document is truncated"));
1469 } else { // "\\lyxformat" not found
1470 WriteAlert(_("ERROR!"), _("Not a LyX file!"));
1473 WriteAlert(_("ERROR!"), _("Unable to read file!"));
1478 // Should probably be moved to somewhere else: BufferView? LyXView?
1479 bool Buffer::save() const
1481 // We don't need autosaves in the immediate future. (Asger)
1482 resetAutosaveTimers();
1486 if (lyxrc.make_backup) {
1487 s = fileName() + '~';
1488 if (!lyxrc.backupdir_path.empty())
1489 s = AddName(lyxrc.backupdir_path,
1490 subst(os::slashify_path(s),'/','!'));
1492 // Rename is the wrong way of making a backup,
1493 // this is the correct way.
1494 /* truss cp fil fil2:
1495 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1496 stat("LyXVC.lyx", 0xEFFFF688) = 0
1497 open("LyXVC.lyx", O_RDONLY) = 3
1498 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1499 fstat(4, 0xEFFFF508) = 0
1500 fstat(3, 0xEFFFF508) = 0
1501 read(3, " # T h i s f i l e w".., 8192) = 5579
1502 write(4, " # T h i s f i l e w".., 5579) = 5579
1503 read(3, 0xEFFFD4A0, 8192) = 0
1506 chmod("LyXVC3.lyx", 0100644) = 0
1507 lseek(0, 0, SEEK_CUR) = 46440
1511 // Should probably have some more error checking here.
1512 // Should be cleaned up in 0.13, at least a bit.
1513 // Doing it this way, also makes the inodes stay the same.
1514 // This is still not a very good solution, in particular we
1515 // might loose the owner of the backup.
1516 FileInfo finfo(fileName());
1517 if (finfo.exist()) {
1518 mode_t fmode = finfo.getMode();
1519 struct utimbuf times = {
1520 finfo.getAccessTime(),
1521 finfo.getModificationTime() };
1523 ifstream ifs(fileName().c_str());
1524 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1529 ::chmod(s.c_str(), fmode);
1531 if (::utime(s.c_str(), ×)) {
1532 lyxerr << "utime error." << endl;
1535 lyxerr << "LyX was not able to make "
1536 "backup copy. Beware." << endl;
1541 if (writeFile(fileName(), false)) {
1543 removeAutosaveFile(fileName());
1545 // Saving failed, so backup is not backup
1546 if (lyxrc.make_backup) {
1547 lyx::rename(s, fileName());
1555 // Returns false if unsuccesful
1556 bool Buffer::writeFile(string const & fname, bool flag) const
1558 // if flag is false writeFile will not create any GUI
1559 // warnings, only cerr.
1560 // Needed for autosave in background or panic save (Matthias 120496)
1562 if (read_only && (fname == filename)) {
1563 // Here we should come with a question if we should
1564 // perform the write anyway.
1566 lyxerr << _("Error! Document is read-only: ")
1569 WriteAlert(_("Error! Document is read-only: "),
1574 FileInfo finfo(fname);
1575 if (finfo.exist() && !finfo.writable()) {
1576 // Here we should come with a question if we should
1577 // try to do the save anyway. (i.e. do a chmod first)
1579 lyxerr << _("Error! Cannot write file: ")
1582 WriteFSAlert(_("Error! Cannot write file: "),
1587 ofstream ofs(fname.c_str());
1590 lyxerr << _("Error! Cannot open file: ")
1593 WriteFSAlert(_("Error! Cannot open file: "),
1599 // Use the standard "C" locale for file output.
1600 ofs.imbue(std::locale::classic());
1603 // The top of the file should not be written by params.
1605 // write out a comment in the top of the file
1606 ofs << '#' << LYX_DOCVERSION
1607 << " created this file. For more info see http://www.lyx.org/\n"
1608 << "\\lyxformat " << LYX_FORMAT << "\n";
1610 // now write out the buffer paramters.
1611 params.writeFile(ofs);
1613 Paragraph::depth_type depth = 0;
1615 // this will write out all the paragraphs
1616 // using recursive descent.
1617 paragraph->writeFile(this, ofs, params, depth);
1619 // Write marker that shows file is complete
1620 ofs << "\n\\the_end" << endl;
1624 // how to check if close went ok?
1625 // Following is an attempt... (BE 20001011)
1627 // good() returns false if any error occured, including some
1628 // formatting error.
1629 // bad() returns true if something bad happened in the buffer,
1630 // which should include file system full errors.
1637 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1639 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1649 string const Buffer::asciiParagraph(Paragraph const * par,
1650 unsigned int linelen) const
1652 ostringstream buffer;
1653 Paragraph::depth_type depth = 0;
1655 Paragraph::depth_type ltype_depth = 0;
1656 unsigned int currlinelen = 0;
1657 bool ref_printed = false;
1661 if (!par->previous()) {
1662 // begins or ends a deeper area ?
1663 if (depth != par->params().depth()) {
1664 if (par->params().depth() > depth) {
1665 while (par->params().depth() > depth) {
1669 while (par->params().depth() < depth) {
1675 // First write the layout
1676 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1677 if (tmp == "Itemize") {
1679 ltype_depth = depth + 1;
1680 } else if (tmp == "Enumerate") {
1682 ltype_depth = depth + 1;
1683 } else if (contains(tmp, "ection")) {
1685 ltype_depth = depth + 1;
1686 } else if (contains(tmp, "aragraph")) {
1688 ltype_depth = depth + 1;
1689 } else if (tmp == "Description") {
1691 ltype_depth = depth + 1;
1692 } else if (tmp == "Abstract") {
1695 } else if (tmp == "Bibliography") {
1703 /* maybe some vertical spaces */
1705 /* the labelwidthstring used in lists */
1709 /* some pagebreaks? */
1713 /* what about the alignment */
1715 lyxerr << "Should this ever happen?" << endl;
1719 LyXFont const font1 = LyXFont(LyXFont::ALL_INHERIT, params.language);
1721 for (Paragraph::size_type i = 0; i < par->size(); ++i) {
1722 if (!i && !noparbreak) {
1725 for (Paragraph::depth_type j = 0; j < depth; ++j)
1727 currlinelen = depth * 2;
1730 case 4: // (Sub)Paragraph
1731 case 5: // Description
1735 buffer << "Abstract\n\n";
1737 buffer << "Abstract: ";
1739 case 7: // Bibliography
1742 buffer << "References\n\n";
1744 buffer << "References: ";
1749 buffer << par->params().labelString() << " ";
1752 if (ltype_depth > depth) {
1753 for (Paragraph::depth_type j = ltype_depth - 1;
1756 currlinelen += (ltype_depth-depth)*2;
1760 LyXFont const font2 = par->getFontSettings(params, i);
1761 if (font1.latex() != font2.latex()) {
1762 if (font2.latex() == LyXFont::OFF)
1771 char c = par->getUChar(params, i);
1775 case Paragraph::META_INSET:
1777 Inset const * inset = par->getInset(i);
1779 if (!inset->ascii(this, buffer)) {
1782 rsplit(buffer.str().c_str(),
1784 currlinelen += s.length();
1786 // to be sure it breaks paragraph
1787 currlinelen += linelen;
1793 case Paragraph::META_NEWLINE:
1796 for (Paragraph::depth_type j = 0;
1800 currlinelen = depth * 2;
1801 if (ltype_depth > depth) {
1802 for (Paragraph::depth_type j = ltype_depth;
1805 currlinelen += (ltype_depth - depth) * 2;
1809 case Paragraph::META_HFILL:
1818 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1819 (c == ' ') && ((i + 2) < par->size()))
1822 for (Paragraph::depth_type j = 0;
1825 currlinelen = depth * 2;
1826 if (ltype_depth > depth) {
1827 for (Paragraph::depth_type j = ltype_depth;
1830 currlinelen += (ltype_depth-depth)*2;
1832 } else if (c != '\0')
1835 lyxerr[Debug::INFO] << "writeAsciiFile: NULL char in structure." << endl;
1840 return buffer.str().c_str();
1844 void Buffer::writeFileAscii(string const & fname, int linelen)
1846 ofstream ofs(fname.c_str());
1848 WriteFSAlert(_("Error: Cannot write file:"), fname);
1851 writeFileAscii(ofs, linelen);
1855 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1857 Paragraph * par = paragraph;
1859 ofs << asciiParagraph(par, linelen);
1867 void Buffer::makeLaTeXFile(string const & fname,
1868 string const & original_path,
1869 bool nice, bool only_body)
1871 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1873 niceFile = nice; // this will be used by Insetincludes.
1875 tex_code_break_column = lyxrc.ascii_linelen;
1877 LyXTextClass const & tclass =
1878 textclasslist.TextClass(params.textclass);
1880 ofstream ofs(fname.c_str());
1882 WriteFSAlert(_("Error: Cannot open file: "), fname);
1886 // validate the buffer.
1887 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1888 LaTeXFeatures features(params, tclass.numLayouts());
1890 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1893 // The starting paragraph of the coming rows is the
1894 // first paragraph of the document. (Asger)
1895 texrow.start(paragraph, 0);
1897 if (!only_body && nice) {
1898 ofs << "%% " LYX_DOCVERSION " created this file. "
1899 "For more info, see http://www.lyx.org/.\n"
1900 "%% Do not edit unless you really know what "
1905 lyxerr[Debug::INFO] << "lyx header finished" << endl;
1906 // There are a few differences between nice LaTeX and usual files:
1907 // usual is \batchmode and has a
1908 // special input@path to allow the including of figures
1909 // with either \input or \includegraphics (what figinsets do).
1910 // batchmode is not set if there is a tex_code_break_column.
1911 // In this case somebody is interested in the generated LaTeX,
1912 // so this is OK. input@path is set when the actual parameter
1913 // original_path is set. This is done for usual tex-file, but not
1914 // for nice-latex-file. (Matthias 250696)
1917 // code for usual, NOT nice-latex-file
1918 ofs << "\\batchmode\n"; // changed
1919 // from \nonstopmode
1922 if (!original_path.empty()) {
1923 ofs << "\\makeatletter\n"
1924 << "\\def\\input@path{{"
1925 << os::external_path(original_path) << "/}}\n"
1926 << "\\makeatother\n";
1932 ofs << "\\documentclass";
1934 ostringstream options; // the document class options.
1936 if (tokenPos(tclass.opt_fontsize(),
1937 '|', params.fontsize) >= 0) {
1938 // only write if existing in list (and not default)
1939 options << params.fontsize << "pt,";
1943 if (!params.use_geometry &&
1944 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1945 switch (params.papersize) {
1946 case BufferParams::PAPER_A4PAPER:
1947 options << "a4paper,";
1949 case BufferParams::PAPER_USLETTER:
1950 options << "letterpaper,";
1952 case BufferParams::PAPER_A5PAPER:
1953 options << "a5paper,";
1955 case BufferParams::PAPER_B5PAPER:
1956 options << "b5paper,";
1958 case BufferParams::PAPER_EXECUTIVEPAPER:
1959 options << "executivepaper,";
1961 case BufferParams::PAPER_LEGALPAPER:
1962 options << "legalpaper,";
1968 if (params.sides != tclass.sides()) {
1969 switch (params.sides) {
1970 case LyXTextClass::OneSide:
1971 options << "oneside,";
1973 case LyXTextClass::TwoSides:
1974 options << "twoside,";
1980 if (params.columns != tclass.columns()) {
1981 if (params.columns == 2)
1982 options << "twocolumn,";
1984 options << "onecolumn,";
1987 if (!params.use_geometry
1988 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1989 options << "landscape,";
1991 // language should be a parameter to \documentclass
1993 ostringstream language_options;
1994 if (params.language->babel() == "hebrew"
1995 && default_language->babel() != "hebrew")
1996 // This seems necessary
1997 features.UsedLanguages.insert(default_language);
1999 if (lyxrc.language_use_babel ||
2000 params.language->lang() != lyxrc.default_language ||
2001 !features.UsedLanguages.empty()) {
2003 for (LaTeXFeatures::LanguageList::const_iterator cit =
2004 features.UsedLanguages.begin();
2005 cit != features.UsedLanguages.end(); ++cit)
2006 language_options << (*cit)->babel() << ',';
2007 language_options << params.language->babel();
2008 if (lyxrc.language_global_options)
2009 options << language_options.str() << ',';
2012 // the user-defined options
2013 if (!params.options.empty()) {
2014 options << params.options << ',';
2017 string strOptions(options.str().c_str());
2018 if (!strOptions.empty()){
2019 strOptions = strip(strOptions, ',');
2020 ofs << '[' << strOptions << ']';
2024 << textclasslist.LatexnameOfClass(params.textclass)
2027 // end of \documentclass defs
2029 // font selection must be done before loading fontenc.sty
2030 // The ae package is not needed when using OT1 font encoding.
2031 if (params.fonts != "default" &&
2032 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2033 ofs << "\\usepackage{" << params.fonts << "}\n";
2035 if (params.fonts == "ae") {
2036 ofs << "\\usepackage{aecompl}\n";
2040 // this one is not per buffer
2041 if (lyxrc.fontenc != "default") {
2042 ofs << "\\usepackage[" << lyxrc.fontenc
2047 if (params.inputenc == "auto") {
2048 string const doc_encoding =
2049 params.language->encoding()->LatexName();
2051 // Create a list with all the input encodings used
2053 set<string> encodings;
2054 for (LaTeXFeatures::LanguageList::const_iterator it =
2055 features.UsedLanguages.begin();
2056 it != features.UsedLanguages.end(); ++it)
2057 if ((*it)->encoding()->LatexName() != doc_encoding)
2058 encodings.insert((*it)->encoding()->LatexName());
2060 ofs << "\\usepackage[";
2061 std::copy(encodings.begin(), encodings.end(),
2062 std::ostream_iterator<string>(ofs, ","));
2063 ofs << doc_encoding << "]{inputenc}\n";
2065 } else if (params.inputenc != "default") {
2066 ofs << "\\usepackage[" << params.inputenc
2071 // At the very beginning the text parameters.
2072 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2073 switch (params.paperpackage) {
2074 case BufferParams::PACKAGE_A4:
2075 ofs << "\\usepackage{a4}\n";
2078 case BufferParams::PACKAGE_A4WIDE:
2079 ofs << "\\usepackage{a4wide}\n";
2082 case BufferParams::PACKAGE_WIDEMARGINSA4:
2083 ofs << "\\usepackage[widemargins]{a4}\n";
2088 if (params.use_geometry) {
2089 ofs << "\\usepackage{geometry}\n";
2091 ofs << "\\geometry{verbose";
2092 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2093 ofs << ",landscape";
2094 switch (params.papersize2) {
2095 case BufferParams::VM_PAPER_CUSTOM:
2096 if (!params.paperwidth.empty())
2097 ofs << ",paperwidth="
2098 << params.paperwidth;
2099 if (!params.paperheight.empty())
2100 ofs << ",paperheight="
2101 << params.paperheight;
2103 case BufferParams::VM_PAPER_USLETTER:
2104 ofs << ",letterpaper";
2106 case BufferParams::VM_PAPER_USLEGAL:
2107 ofs << ",legalpaper";
2109 case BufferParams::VM_PAPER_USEXECUTIVE:
2110 ofs << ",executivepaper";
2112 case BufferParams::VM_PAPER_A3:
2115 case BufferParams::VM_PAPER_A4:
2118 case BufferParams::VM_PAPER_A5:
2121 case BufferParams::VM_PAPER_B3:
2124 case BufferParams::VM_PAPER_B4:
2127 case BufferParams::VM_PAPER_B5:
2131 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2132 switch (lyxrc.default_papersize) {
2133 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2134 case BufferParams::PAPER_USLETTER:
2135 ofs << ",letterpaper";
2137 case BufferParams::PAPER_LEGALPAPER:
2138 ofs << ",legalpaper";
2140 case BufferParams::PAPER_EXECUTIVEPAPER:
2141 ofs << ",executivepaper";
2143 case BufferParams::PAPER_A3PAPER:
2146 case BufferParams::PAPER_A4PAPER:
2149 case BufferParams::PAPER_A5PAPER:
2152 case BufferParams::PAPER_B5PAPER:
2157 if (!params.topmargin.empty())
2158 ofs << ",tmargin=" << params.topmargin;
2159 if (!params.bottommargin.empty())
2160 ofs << ",bmargin=" << params.bottommargin;
2161 if (!params.leftmargin.empty())
2162 ofs << ",lmargin=" << params.leftmargin;
2163 if (!params.rightmargin.empty())
2164 ofs << ",rmargin=" << params.rightmargin;
2165 if (!params.headheight.empty())
2166 ofs << ",headheight=" << params.headheight;
2167 if (!params.headsep.empty())
2168 ofs << ",headsep=" << params.headsep;
2169 if (!params.footskip.empty())
2170 ofs << ",footskip=" << params.footskip;
2174 if (features.amsstyle
2175 && !tclass.provides(LyXTextClass::amsmath)) {
2176 ofs << "\\usepackage{amsmath}\n";
2180 if (tokenPos(tclass.opt_pagestyle(),
2181 '|', params.pagestyle) >= 0) {
2182 if (params.pagestyle == "fancy") {
2183 ofs << "\\usepackage{fancyhdr}\n";
2186 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2190 // We try to load babel late, in case it interferes
2191 // with other packages.
2193 string tmp = lyxrc.language_package;
2194 if (!lyxrc.language_global_options
2195 && tmp == "\\usepackage{babel}")
2196 tmp = string("\\usepackage[") +
2197 language_options.str().c_str() +
2203 if (params.secnumdepth != tclass.secnumdepth()) {
2204 ofs << "\\setcounter{secnumdepth}{"
2205 << params.secnumdepth
2209 if (params.tocdepth != tclass.tocdepth()) {
2210 ofs << "\\setcounter{tocdepth}{"
2216 if (params.paragraph_separation) {
2217 switch (params.defskip.kind()) {
2218 case VSpace::SMALLSKIP:
2219 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2221 case VSpace::MEDSKIP:
2222 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2224 case VSpace::BIGSKIP:
2225 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2227 case VSpace::LENGTH:
2228 ofs << "\\setlength\\parskip{"
2229 << params.defskip.length().asLatexString()
2232 default: // should never happen // Then delete it.
2233 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2238 ofs << "\\setlength\\parindent{0pt}\n";
2242 // Now insert the LyX specific LaTeX commands...
2244 // The optional packages;
2245 string preamble(features.getPackages());
2247 // this might be useful...
2248 preamble += "\n\\makeatletter\n";
2250 // Some macros LyX will need
2251 string tmppreamble(features.getMacros());
2253 if (!tmppreamble.empty()) {
2254 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2255 "LyX specific LaTeX commands.\n"
2256 + tmppreamble + '\n';
2259 // the text class specific preamble
2260 tmppreamble = features.getTClassPreamble();
2261 if (!tmppreamble.empty()) {
2262 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2263 "Textclass specific LaTeX commands.\n"
2264 + tmppreamble + '\n';
2267 /* the user-defined preamble */
2268 if (!params.preamble.empty()) {
2269 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2270 "User specified LaTeX commands.\n"
2271 + params.preamble + '\n';
2274 preamble += "\\makeatother\n";
2276 // Itemize bullet settings need to be last in case the user
2277 // defines their own bullets that use a package included
2278 // in the user-defined preamble -- ARRae
2279 // Actually it has to be done much later than that
2280 // since some packages like frenchb make modifications
2281 // at \begin{document} time -- JMarc
2283 for (int i = 0; i < 4; ++i) {
2284 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2285 if (bullets_def.empty())
2286 bullets_def="\\AtBeginDocument{\n";
2287 bullets_def += " \\renewcommand{\\labelitemi";
2289 // `i' is one less than the item to modify
2296 bullets_def += "ii";
2302 bullets_def += "}{" +
2303 params.user_defined_bullets[i].getText()
2308 if (!bullets_def.empty())
2309 preamble += bullets_def + "}\n\n";
2311 for (int j = countChar(preamble, '\n'); j-- ;) {
2318 ofs << "\\begin{document}\n";
2321 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2323 if (!lyxrc.language_auto_begin) {
2324 ofs << subst(lyxrc.language_command_begin, "$$lang",
2325 params.language->babel())
2330 latexParagraphs(ofs, paragraph, 0, texrow);
2332 // add this just in case after all the paragraphs
2336 if (!lyxrc.language_auto_end) {
2337 ofs << subst(lyxrc.language_command_end, "$$lang",
2338 params.language->babel())
2344 ofs << "\\end{document}\n";
2347 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2349 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2353 // Just to be sure. (Asger)
2356 // tex_code_break_column's value is used to decide
2357 // if we are in batchmode or not (within mathed_write()
2358 // in math_write.C) so we must set it to a non-zero
2359 // value when we leave otherwise we save incorrect .lyx files.
2360 tex_code_break_column = lyxrc.ascii_linelen;
2364 lyxerr << "File was not closed properly." << endl;
2367 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2372 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2374 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2375 Paragraph * endpar, TexRow & texrow) const
2377 bool was_title = false;
2378 bool already_title = false;
2381 while (par != endpar) {
2382 LyXLayout const & layout =
2383 textclasslist.Style(params.textclass,
2386 if (layout.intitle) {
2387 if (already_title) {
2388 lyxerr <<"Error in latexParagraphs: You"
2389 " should not mix title layouts"
2390 " with normal ones." << endl;
2393 } else if (was_title && !already_title) {
2394 ofs << "\\maketitle\n";
2396 already_title = true;
2400 if (layout.isEnvironment()) {
2401 par = par->TeXEnvironment(this, params, ofs, texrow);
2403 par = par->TeXOnePar(this, params, ofs, texrow, false);
2406 // It might be that we only have a title in this document
2407 if (was_title && !already_title) {
2408 ofs << "\\maketitle\n";
2414 bool Buffer::isLatex() const
2416 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2420 bool Buffer::isLinuxDoc() const
2422 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2426 bool Buffer::isLiterate() const
2428 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2432 bool Buffer::isDocBook() const
2434 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2438 bool Buffer::isSGML() const
2440 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2441 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2445 void Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth,
2446 string const & latexname) const
2448 if (!latexname.empty() && latexname != "!-- --")
2449 os << "<!-- " << depth << " -->" << "<" << latexname << ">";
2450 //os << string(depth, ' ') << "<" << latexname << ">\n";
2454 void Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth,
2455 string const & latexname) const
2457 if (!latexname.empty() && latexname != "!-- --")
2458 os << "<!-- " << depth << " -->" << "</" << latexname << ">\n";
2459 //os << string(depth, ' ') << "</" << latexname << ">\n";
2463 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2465 ofstream ofs(fname.c_str());
2468 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2472 niceFile = nice; // this will be used by included files.
2474 LyXTextClass const & tclass =
2475 textclasslist.TextClass(params.textclass);
2477 LaTeXFeatures features(params, tclass.numLayouts());
2482 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2485 string sgml_includedfiles=features.getIncludedFiles(fname);
2487 if (params.preamble.empty() && sgml_includedfiles.empty()) {
2488 ofs << "<!doctype linuxdoc system>\n\n";
2490 ofs << "<!doctype linuxdoc system [ "
2491 << params.preamble << sgml_includedfiles << " \n]>\n\n";
2494 if (params.options.empty())
2495 sgmlOpenTag(ofs, 0, top_element);
2497 string top = top_element;
2499 top += params.options;
2500 sgmlOpenTag(ofs, 0, top);
2504 ofs << "<!-- " << LYX_DOCVERSION
2505 << " created this file. For more info see http://www.lyx.org/"
2508 Paragraph::depth_type depth = 0; // paragraph depth
2509 Paragraph * par = paragraph;
2511 vector<string> environment_stack(5);
2514 LyXLayout const & style =
2515 textclasslist.Style(params.textclass,
2518 // treat <toc> as a special case for compatibility with old code
2519 if (par->getChar(0) == Paragraph::META_INSET) {
2520 Inset * inset = par->getInset(0);
2521 Inset::Code lyx_code = inset->lyxCode();
2522 if (lyx_code == Inset::TOC_CODE){
2523 string const temp = "toc";
2524 sgmlOpenTag(ofs, depth, temp);
2531 // environment tag closing
2532 for (; depth > par->params().depth(); --depth) {
2533 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2534 environment_stack[depth].erase();
2537 // write opening SGML tags
2538 switch (style.latextype) {
2539 case LATEX_PARAGRAPH:
2540 if (depth == par->params().depth()
2541 && !environment_stack[depth].empty()) {
2542 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2543 environment_stack[depth].erase();
2549 sgmlOpenTag(ofs, depth, style.latexname());
2554 linuxDocError(par, 0,
2555 _("Error : Wrong depth for"
2556 " LatexType Command.\n"));
2558 if (!environment_stack[depth].empty()){
2559 sgmlCloseTag(ofs, depth,
2560 environment_stack[depth]);
2564 environment_stack[depth].erase();
2565 sgmlOpenTag(ofs, depth, style.latexname());
2568 case LATEX_ENVIRONMENT:
2569 case LATEX_ITEM_ENVIRONMENT:
2570 if (depth == par->params().depth()
2571 && environment_stack[depth] != style.latexname()) {
2572 sgmlCloseTag(ofs, depth,
2573 environment_stack[depth]);
2574 environment_stack[depth].erase();
2576 if (depth < par->params().depth()) {
2577 depth = par->params().depth();
2578 environment_stack[depth].erase();
2580 if (environment_stack[depth] != style.latexname()) {
2582 sgmlOpenTag(ofs, depth, "p");
2584 sgmlOpenTag(ofs, depth, style.latexname());
2586 if (environment_stack.size() == depth + 1)
2587 environment_stack.push_back("!-- --");
2588 environment_stack[depth] = style.latexname();
2591 if (style.latexparam() == "CDATA")
2594 if (style.latextype == LATEX_ENVIRONMENT) break;
2596 if (style.labeltype == LABEL_MANUAL)
2601 sgmlOpenTag(ofs, depth + 1, item_name);
2604 sgmlOpenTag(ofs, depth, style.latexname());
2608 simpleLinuxDocOnePar(ofs, par, depth);
2613 // write closing SGML tags
2614 switch (style.latextype) {
2617 case LATEX_ENVIRONMENT:
2618 case LATEX_ITEM_ENVIRONMENT:
2619 if (style.latexparam() == "CDATA")
2623 sgmlCloseTag(ofs, depth, style.latexname());
2629 for (int i=depth; i >= 0; --i)
2630 sgmlCloseTag(ofs, depth, environment_stack[i]);
2634 sgmlCloseTag(ofs, 0, top_element);
2638 // How to check for successful close
2642 void Buffer::docBookHandleCaption(ostream & os, string & inner_tag,
2643 Paragraph::depth_type depth, int desc_on,
2646 Paragraph * tpar = par;
2648 && (tpar->layout != textclasslist.NumberOfLayout(params.textclass,
2650 tpar = tpar->next();
2653 tpar->layout == textclasslist.NumberOfLayout(params.textclass,
2654 "Caption").second) {
2655 sgmlOpenTag(os, depth + 1, inner_tag);
2657 simpleDocBookOnePar(os, extra_par, tpar,
2658 desc_on, depth + 2);
2659 sgmlCloseTag(os, depth+1, inner_tag);
2660 if (!extra_par.empty())
2666 // checks, if newcol chars should be put into this line
2667 // writes newline, if necessary.
2670 void linux_doc_line_break(ostream & os, string::size_type & colcount,
2671 string::size_type newcol)
2674 if (colcount > lyxrc.ascii_linelen) {
2676 colcount = newcol; // assume write after this call
2691 string tag_name(PAR_TAG const & pt) {
2693 case NONE: return "!-- --";
2694 case TT: return "tt";
2695 case SF: return "sf";
2696 case BF: return "bf";
2697 case IT: return "it";
2698 case SL: return "sl";
2699 case EM: return "em";
2706 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2708 p1 = static_cast<PAR_TAG>(p1 | p2);
2713 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2715 p1 = static_cast<PAR_TAG>( p1 & ~p2);
2723 // Handle internal paragraph parsing -- layout already processed.
2724 void Buffer::simpleLinuxDocOnePar(ostream & os,
2726 Paragraph::depth_type /*depth*/)
2728 LyXLayout const & style = textclasslist.Style(params.textclass,
2730 string::size_type char_line_count = 5; // Heuristic choice ;-)
2732 // gets paragraph main font
2735 if (style.labeltype == LABEL_MANUAL) {
2736 font_old = style.labelfont;
2739 font_old = style.font;
2743 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2744 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2745 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2748 stack < PAR_TAG > tag_state;
2749 // parsing main loop
2750 for (Paragraph::size_type i = 0; i < par->size(); ++i) {
2752 PAR_TAG tag_close = NONE;
2753 list < PAR_TAG > tag_open;
2755 LyXFont const font = par->getFont(params, i);
2757 if (font_old.family() != font.family()) {
2758 switch (family_type) {
2759 case LyXFont::SANS_FAMILY:
2762 case LyXFont::TYPEWRITER_FAMILY:
2769 family_type = font.family();
2771 switch (family_type) {
2772 case LyXFont::SANS_FAMILY:
2773 tag_open.push_back(SF);
2775 case LyXFont::TYPEWRITER_FAMILY:
2776 tag_open.push_back(TT);
2783 if (font_old.series() != font.series()) {
2784 switch (series_type) {
2785 case LyXFont::BOLD_SERIES:
2792 series_type = font.series();
2794 switch (series_type) {
2795 case LyXFont::BOLD_SERIES:
2796 tag_open.push_back(BF);
2804 if (font_old.shape() != font.shape()) {
2805 switch (shape_type) {
2806 case LyXFont::ITALIC_SHAPE:
2809 case LyXFont::SLANTED_SHAPE:
2816 shape_type = font.shape();
2818 switch (shape_type) {
2819 case LyXFont::ITALIC_SHAPE:
2820 tag_open.push_back(IT);
2822 case LyXFont::SLANTED_SHAPE:
2823 tag_open.push_back(SL);
2830 if (font_old.emph() != font.emph()) {
2831 if (font.emph() == LyXFont::ON) {
2832 tag_open.push_back(EM);
2841 list < PAR_TAG > temp;
2842 while(!tag_state.empty() && tag_close ) {
2843 PAR_TAG k = tag_state.top();
2845 os << "</" << tag_name(k) << ">";
2852 for(list< PAR_TAG >::const_iterator j = temp.begin();
2853 j != temp.end(); ++j) {
2855 os << "<" << tag_name(*j) << ">";
2858 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2859 j != tag_open.end(); ++j) {
2861 os << "<" << tag_name(*j) << ">";
2864 char c = par->getChar(i);
2866 if (c == Paragraph::META_INSET) {
2867 Inset * inset = par->getInset(i);
2868 inset->linuxdoc(this, os);
2875 font.latex() == LyXFont::ON ||
2877 style.latexparam() == "CDATA") {
2878 // "TeX"-Mode on == > SGML-Mode on.
2884 if (par->linuxDocConvertChar(c, sgml_string)
2885 && !style.free_spacing) {
2886 // in freespacing mode, spaces are
2887 // non-breaking characters
2888 if (desc_on) {// if char is ' ' then...
2891 linux_doc_line_break(os, char_line_count, 6);
2895 linux_doc_line_break(os, char_line_count, 1);
2900 char_line_count += sgml_string.length();
2906 while (!tag_state.empty()) {
2907 os << "</" << tag_name(tag_state.top()) << ">";
2911 // resets description flag correctly
2913 // <tag> not closed...
2914 linux_doc_line_break(os, char_line_count, 6);
2920 // Print an error message.
2921 void Buffer::linuxDocError(Paragraph * par, int pos,
2922 string const & message)
2924 // insert an error marker in text
2925 InsetError * new_inset = new InsetError(message);
2926 par->insertInset(pos, new_inset);
2930 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2932 ofstream ofs(fname.c_str());
2934 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2938 Paragraph * par = paragraph;
2940 niceFile = nice; // this will be used by Insetincludes.
2942 LyXTextClass const & tclass =
2943 textclasslist.TextClass(params.textclass);
2945 LaTeXFeatures features(params, tclass.numLayouts());
2950 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2953 string sgml_includedfiles = features.getIncludedFiles(fname);
2955 ofs << "<!doctype " << top_element
2956 << " public \"-//OASIS//DTD DocBook V3.1//EN\"";
2958 if (params.preamble.empty() && sgml_includedfiles.empty())
2961 ofs << "\n [ " << params.preamble
2962 << sgml_includedfiles << " \n]>\n\n";
2965 string top = top_element;
2967 top += params.language->code();
2970 if (!params.options.empty()) {
2972 top += params.options;
2974 sgmlOpenTag(ofs, 0, top);
2976 ofs << "<!-- DocBook file was created by " << LYX_DOCVERSION
2977 << "\n See http://www.lyx.org/ for more information -->\n";
2979 vector<string> environment_stack(10);
2980 vector<string> environment_inner(10);
2981 vector<string> command_stack(10);
2983 bool command_flag = false;
2984 Paragraph::depth_type command_depth = 0;
2985 Paragraph::depth_type command_base = 0;
2986 Paragraph::depth_type cmd_depth = 0;
2987 Paragraph::depth_type depth = 0; // paragraph depth
2990 string command_name;
2996 int desc_on = 0; // description mode
2998 LyXLayout const & style =
2999 textclasslist.Style(params.textclass,
3002 // environment tag closing
3003 for (; depth > par->params().depth(); --depth) {
3004 if (environment_inner[depth] != "!-- --") {
3005 item_name = "listitem";
3006 sgmlCloseTag(ofs, command_depth + depth,
3008 if (environment_inner[depth] == "varlistentry")
3009 sgmlCloseTag(ofs, depth+command_depth,
3010 environment_inner[depth]);
3012 sgmlCloseTag(ofs, depth + command_depth,
3013 environment_stack[depth]);
3014 environment_stack[depth].erase();
3015 environment_inner[depth].erase();
3018 if (depth == par->params().depth()
3019 && environment_stack[depth] != style.latexname()
3020 && !environment_stack[depth].empty()) {
3021 if (environment_inner[depth] != "!-- --") {
3022 item_name= "listitem";
3023 sgmlCloseTag(ofs, command_depth+depth,
3025 if (environment_inner[depth] == "varlistentry")
3027 depth + command_depth,
3028 environment_inner[depth]);
3031 sgmlCloseTag(ofs, depth + command_depth,
3032 environment_stack[depth]);
3034 environment_stack[depth].erase();
3035 environment_inner[depth].erase();
3038 // Write opening SGML tags.
3039 switch (style.latextype) {
3040 case LATEX_PARAGRAPH:
3041 sgmlOpenTag(ofs, depth + command_depth,
3047 linuxDocError(par, 0,
3048 _("Error : Wrong depth for "
3049 "LatexType Command.\n"));
3051 command_name = style.latexname();
3053 sgmlparam = style.latexparam();
3054 c_params = split(sgmlparam, c_depth,'|');
3056 cmd_depth = lyx::atoi(c_depth);
3059 if (cmd_depth < command_base) {
3060 for (Paragraph::depth_type j = command_depth; j >= command_base; --j)
3061 sgmlCloseTag(ofs, j, command_stack[j]);
3062 command_depth = command_base = cmd_depth;
3063 } else if (cmd_depth <= command_depth) {
3064 for (int j = command_depth; j >= int(cmd_depth); --j)
3065 sgmlCloseTag(ofs, j, command_stack[j]);
3066 command_depth = cmd_depth;
3068 command_depth = cmd_depth;
3070 command_depth = command_base = cmd_depth;
3071 command_flag = true;
3073 if (command_stack.size() == command_depth + 1)
3074 command_stack.push_back(string());
3075 command_stack[command_depth] = command_name;
3077 // treat label as a special case for
3078 // more WYSIWYM handling.
3079 if (par->getChar(0) == Paragraph::META_INSET) {
3080 Inset * inset = par->getInset(0);
3081 Inset::Code lyx_code = inset->lyxCode();
3082 if (lyx_code == Inset::LABEL_CODE){
3083 command_name += " id=\"";
3084 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3085 command_name += "\"";
3090 sgmlOpenTag(ofs, depth + command_depth, command_name);
3091 if (c_params.empty())
3092 item_name = "title";
3094 item_name = c_params;
3095 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3098 case LATEX_ENVIRONMENT:
3099 case LATEX_ITEM_ENVIRONMENT:
3100 if (depth < par->params().depth()) {
3101 depth = par->params().depth();
3102 environment_stack[depth].erase();
3105 if (environment_stack[depth] != style.latexname()) {
3106 if(environment_stack.size() == depth + 1) {
3107 environment_stack.push_back("!-- --");
3108 environment_inner.push_back("!-- --");
3110 environment_stack[depth] = style.latexname();
3111 environment_inner[depth] = "!-- --";
3112 sgmlOpenTag(ofs, depth + command_depth,
3113 environment_stack[depth]);
3115 if (environment_inner[depth] != "!-- --") {
3116 item_name= "listitem";
3118 command_depth + depth,
3120 if (environment_inner[depth] == "varlistentry")
3122 depth + command_depth,
3123 environment_inner[depth]);
3127 if (style.latextype == LATEX_ENVIRONMENT) {
3128 if (!style.latexparam().empty()) {
3129 if(style.latexparam() == "CDATA")
3132 sgmlOpenTag(ofs, depth + command_depth,
3133 style.latexparam());
3138 desc_on = (style.labeltype == LABEL_MANUAL);
3141 environment_inner[depth]= "varlistentry";
3143 environment_inner[depth]= "listitem";
3145 sgmlOpenTag(ofs, depth + 1 + command_depth,
3146 environment_inner[depth]);
3150 sgmlOpenTag(ofs, depth + 1 + command_depth,
3154 sgmlOpenTag(ofs, depth + 1 + command_depth,
3159 sgmlOpenTag(ofs, depth + command_depth,
3165 simpleDocBookOnePar(ofs, extra_par, par, desc_on,
3166 depth + 1 + command_depth);
3170 // write closing SGML tags
3171 switch (style.latextype) {
3173 if (c_params.empty())
3177 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3179 case LATEX_ENVIRONMENT:
3180 if (!style.latexparam().empty()) {
3181 if(style.latexparam() == "CDATA")
3184 sgmlCloseTag(ofs, depth + command_depth,
3185 style.latexparam());
3188 case LATEX_ITEM_ENVIRONMENT:
3189 if (desc_on == 1) break;
3191 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3193 case LATEX_PARAGRAPH:
3194 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3197 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3203 for (int d = depth; d >= 0; --d) {
3204 if (!environment_stack[depth].empty()) {
3205 if (environment_inner[depth] != "!-- --") {
3206 item_name = "listitem";
3207 sgmlCloseTag(ofs, command_depth + depth,
3209 if (environment_inner[depth] == "varlistentry")
3210 sgmlCloseTag(ofs, depth + command_depth,
3211 environment_inner[depth]);
3214 sgmlCloseTag(ofs, depth + command_depth,
3215 environment_stack[depth]);
3219 for (int j = command_depth; j >= 0 ; --j)
3220 if (!command_stack[j].empty())
3221 sgmlCloseTag(ofs, j, command_stack[j]);
3224 sgmlCloseTag(ofs, 0, top_element);
3227 // How to check for successful close
3231 void Buffer::simpleDocBookOnePar(ostream & os, string & extra,
3232 Paragraph * par, int & desc_on,
3233 Paragraph::depth_type depth) const
3235 bool emph_flag = false;
3237 LyXLayout const & style = textclasslist.Style(params.textclass,
3240 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3242 int char_line_count = depth;
3243 //if (!style.free_spacing)
3244 // os << string(depth,' ');
3246 // parsing main loop
3247 for (Paragraph::size_type i = 0;
3248 i < par->size(); ++i) {
3249 LyXFont font = par->getFont(params, i);
3251 // handle <emphasis> tag
3252 if (font_old.emph() != font.emph()) {
3253 if (font.emph() == LyXFont::ON) {
3257 os << "</emphasis>";
3262 char c = par->getChar(i);
3264 if (c == Paragraph::META_INSET) {
3265 Inset * inset = par->getInset(i);
3267 inset->docBook(this, ost);
3268 string tmp_out = ost.str().c_str();
3271 // This code needs some explanation:
3272 // Two insets are treated specially
3273 // label if it is the first element in a command paragraph
3275 // graphics inside tables or figure floats can't go on
3276 // title (the equivalente in latex for this case is caption
3277 // and title should come first
3280 if (desc_on!= 3 || i!= 0) {
3281 if (!tmp_out.empty() && tmp_out[0] == '@') {
3283 extra += frontStrip(tmp_out, '@');
3285 os << frontStrip(tmp_out, '@');
3291 } else if (font.latex() == LyXFont::ON) {
3292 // "TeX"-Mode on ==> SGML-Mode on.
3299 if (par->linuxDocConvertChar(c, sgml_string)
3300 && !style.free_spacing) { // in freespacing
3302 // non-breaking characters
3306 os << "\n</term><listitem><para>";
3319 os << "</emphasis>";
3322 // resets description flag correctly
3324 // <term> not closed...
3327 if(style.free_spacing) os << '\n';
3331 // This should be enabled when the Chktex class is implemented. (Asger)
3332 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3333 // Other flags: -wall -v0 -x
3334 int Buffer::runChktex()
3336 if (!users->text) return 0;
3338 users->owner()->prohibitInput();
3340 // get LaTeX-Filename
3341 string const name = getLatexName();
3342 string path = OnlyPath(filename);
3344 string const org_path = path;
3345 if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3349 Path p(path); // path to LaTeX file
3350 users->owner()->message(_("Running chktex..."));
3352 // Remove all error insets
3353 bool const removedErrorInsets = users->removeAutoInsets();
3355 // Generate the LaTeX file if neccessary
3356 makeLaTeXFile(name, org_path, false);
3359 Chktex chktex(lyxrc.chktex_command, name, filepath);
3360 int res = chktex.run(terr); // run chktex
3363 WriteAlert(_("chktex did not work!"),
3364 _("Could not run with file:"), name);
3365 } else if (res > 0) {
3366 // Insert all errors as errors boxes
3367 users->insertErrors(terr);
3370 // if we removed error insets before we ran chktex or if we inserted
3371 // error insets after we ran chktex, this must be run:
3372 if (removedErrorInsets || res){
3374 users->fitCursor(users->text);
3376 users->owner()->allowInput();
3382 void Buffer::validate(LaTeXFeatures & features) const
3384 Paragraph * par = paragraph;
3385 LyXTextClass const & tclass =
3386 textclasslist.TextClass(params.textclass);
3388 // AMS Style is at document level
3390 features.amsstyle = (params.use_amsmath ||
3391 tclass.provides(LyXTextClass::amsmath));
3394 // We don't use "lyxerr.debug" because of speed. (Asger)
3395 if (lyxerr.debugging(Debug::LATEX))
3396 lyxerr << "Paragraph: " << par << endl;
3398 // Now just follow the list of paragraphs and run
3399 // validate on each of them.
3400 par->validate(features);
3402 // and then the next paragraph
3406 // the bullet shapes are buffer level not paragraph level
3407 // so they are tested here
3408 for (int i = 0; i < 4; ++i) {
3409 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3410 int const font = params.user_defined_bullets[i].getFont();
3412 int const c = params
3413 .user_defined_bullets[i]
3420 features.latexsym = true;
3422 } else if (font == 1) {
3423 features.amssymb = true;
3424 } else if ((font >= 2 && font <= 5)) {
3425 features.pifont = true;
3430 if (lyxerr.debugging(Debug::LATEX)) {
3431 features.showStruct();
3436 void Buffer::setPaperStuff()
3438 params.papersize = BufferParams::PAPER_DEFAULT;
3439 char const c1 = params.paperpackage;
3440 if (c1 == BufferParams::PACKAGE_NONE) {
3441 char const c2 = params.papersize2;
3442 if (c2 == BufferParams::VM_PAPER_USLETTER)
3443 params.papersize = BufferParams::PAPER_USLETTER;
3444 else if (c2 == BufferParams::VM_PAPER_USLEGAL)
3445 params.papersize = BufferParams::PAPER_LEGALPAPER;
3446 else if (c2 == BufferParams::VM_PAPER_USEXECUTIVE)
3447 params.papersize = BufferParams::PAPER_EXECUTIVEPAPER;
3448 else if (c2 == BufferParams::VM_PAPER_A3)
3449 params.papersize = BufferParams::PAPER_A3PAPER;
3450 else if (c2 == BufferParams::VM_PAPER_A4)
3451 params.papersize = BufferParams::PAPER_A4PAPER;
3452 else if (c2 == BufferParams::VM_PAPER_A5)
3453 params.papersize = BufferParams::PAPER_A5PAPER;
3454 else if ((c2 == BufferParams::VM_PAPER_B3) || (c2 == BufferParams::VM_PAPER_B4) ||
3455 (c2 == BufferParams::VM_PAPER_B5))
3456 params.papersize = BufferParams::PAPER_B5PAPER;
3457 } else if ((c1 == BufferParams::PACKAGE_A4) || (c1 == BufferParams::PACKAGE_A4WIDE) ||
3458 (c1 == BufferParams::PACKAGE_WIDEMARGINSA4))
3459 params.papersize = BufferParams::PAPER_A4PAPER;
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;
3510 LyXTextClassList::size_type cap;
3511 boost::tie(found, cap) = textclasslist
3512 .NumberOfLayout(params.textclass, "Caption");
3515 char const labeltype =
3516 textclasslist.Style(params.textclass,
3517 par->getLayout()).labeltype;
3519 if (labeltype >= LABEL_COUNTER_CHAPTER
3520 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3521 // insert this into the table of contents
3522 SingleList & item = l["TOC"];
3525 textclasslist.TextClass(params.textclass).maxcounter());
3526 item.push_back(TocItem(par, depth, par->asString(this, true)));
3528 // For each paragrph, traverse its insets and look for
3532 Paragraph::inset_iterator it =
3533 par->inset_iterator_begin();
3534 Paragraph::inset_iterator end =
3535 par->inset_iterator_end();
3537 for (; it != end; ++it) {
3538 if ((*it)->lyxCode() == Inset::FLOAT_CODE) {
3540 static_cast<InsetFloat*>(*it);
3542 string const type = il->type();
3544 // Now find the caption in the float...
3545 // We now tranverse the paragraphs of
3547 Paragraph * tmp = il->inset.paragraph();
3549 if (tmp->layout == cap) {
3550 SingleList & item = l[type];
3552 tostr(item.size()+1) + ". " + tmp->asString(this, false);
3553 item.push_back(TocItem(tmp, 0 , str));
3560 lyxerr << "caption not found" << endl;
3569 // This is also a buffer property (ale)
3570 vector<pair<string, string> > const Buffer::getBibkeyList()
3572 /// if this is a child document and the parent is already loaded
3573 /// Use the parent's list instead [ale990412]
3574 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3575 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3577 return tmp->getBibkeyList();
3580 vector<pair<string, string> > keys;
3581 Paragraph * par = paragraph;
3584 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3585 par->asString(this, false)));
3589 // Might be either using bibtex or a child has bibliography
3591 for (inset_iterator it = inset_iterator_begin();
3592 it != inset_iterator_end(); ++it) {
3593 // Search for Bibtex or Include inset
3594 if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3595 vector<pair<string,string> > tmp =
3596 static_cast<InsetBibtex*>(*it)->getKeys(this);
3597 keys.insert(keys.end(), tmp.begin(), tmp.end());
3598 } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3599 vector<pair<string,string> > const tmp =
3600 static_cast<InsetInclude*>(*it)->getKeys();
3601 keys.insert(keys.end(), tmp.begin(), tmp.end());
3610 bool Buffer::isDepClean(string const & name) const
3612 DEPCLEAN * item = dep_clean;
3613 while (item && item->master != name)
3615 if (!item) return true;
3620 void Buffer::markDepClean(string const & name)
3623 dep_clean = new DEPCLEAN;
3624 dep_clean->clean = true;
3625 dep_clean->master = name;
3626 dep_clean->next = 0;
3628 DEPCLEAN * item = dep_clean;
3629 while (item && item->master != name)
3634 item = new DEPCLEAN;
3636 item->master = name;
3643 bool Buffer::dispatch(string const & command)
3645 // Split command string into command and argument
3647 string line = frontStrip(command);
3648 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3650 return dispatch(lyxaction.LookupFunc(cmd), arg);
3654 bool Buffer::dispatch(int action, string const & argument)
3656 bool dispatched = true;
3659 Exporter::Export(this, argument, false);
3669 void Buffer::resizeInsets(BufferView * bv)
3671 /// then remove all LyXText in text-insets
3672 Paragraph * par = paragraph;
3673 for (; par; par = par->next()) {
3674 par->resizeInsetsLyXText(bv);
3679 void Buffer::redraw()
3682 users->fitCursor(users->text);
3686 void Buffer::changeLanguage(Language const * from, Language const * to)
3689 Paragraph * par = paragraph;
3691 par->changeLanguage(params, from, to);
3697 bool Buffer::isMultiLingual()
3699 Paragraph * par = paragraph;
3701 if (par->isMultiLingual(params))
3709 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph,
3710 Paragraph::size_type pos)
3713 it = par->InsetIterator(pos);
3714 if (it == par->inset_iterator_end()) {
3721 void Buffer::inset_iterator::setParagraph()
3724 it = par->inset_iterator_begin();
3725 if (it != par->inset_iterator_end())
3730 // We maintain an invariant that whenever par = 0 then it = 0
3734 Inset * Buffer::getInsetFromID(int id_arg) const
3736 for (inset_iterator it = inset_const_iterator_begin();
3737 it != inset_const_iterator_end(); ++it)
3739 if ((*it)->id() == id_arg)
3741 Inset * in = (*it)->getInsetFromID(id_arg);
3749 Paragraph * Buffer::getParFromID(int id) const
3751 if (id < 0) return 0;
3752 Paragraph * par = paragraph;
3754 if (par->id() == id) {
3757 Paragraph * tmp = par->getParFromID(id);