1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * This file is Copyright 1996-1999
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 "insets/lyxinset.h"
53 #include "insets/inseterror.h"
54 #include "insets/insetlabel.h"
55 #include "insets/insetref.h"
56 #include "insets/inseturl.h"
57 #include "insets/insetinfo.h"
58 #include "insets/insetquotes.h"
59 #include "insets/insetlatexaccent.h"
60 #include "insets/insetbib.h"
61 #include "insets/insetcite.h"
62 #include "insets/insetexternal.h"
63 #include "insets/insetindex.h"
64 #include "insets/insetinclude.h"
65 #include "insets/insettoc.h"
66 #include "insets/insetparent.h"
67 #include "insets/insetspecialchar.h"
68 #include "insets/figinset.h"
69 #include "insets/insettext.h"
70 #include "insets/insetert.h"
71 #include "insets/insetgraphics.h"
72 #include "insets/insetfoot.h"
73 #include "insets/insetmarginal.h"
74 #include "insets/insetminipage.h"
75 #include "insets/insetfloat.h"
76 #include "insets/insetlist.h"
77 #include "insets/insettabular.h"
78 #include "insets/insettheorem.h"
79 #include "insets/insetcaption.h"
80 #include "insets/insetfloatlist.h"
81 #include "support/filetools.h"
82 #include "support/path.h"
87 #include "LaTeXFeatures.h"
88 #include "support/syscall.h"
89 #include "support/lyxlib.h"
90 #include "support/FileInfo.h"
91 #include "support/lyxmanip.h"
95 #include "lyx_gui_misc.h" // WarnReadonly()
96 #include "frontends/Dialogs.h"
100 #include "converter.h"
102 using std::stringstream;
111 using std::make_pair;
119 // all these externs should eventually be removed.
120 extern BufferList bufferlist;
122 extern LyXAction lyxaction;
126 const int LYX_FORMAT = 218;
130 extern int tex_code_break_column;
133 Buffer::Buffer(string const & file, bool ronly)
135 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
137 filepath = OnlyPath(file);
146 if (read_only || (lyxrc.use_tempdir)) {
147 tmppath = CreateBufferTmpDir();
148 } else tmppath.erase();
154 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
155 // here the buffer should take care that it is
156 // saved properly, before it goes into the void.
158 // make sure that views using this buffer
163 if (!tmppath.empty()) {
164 DestroyBufferTmpDir(tmppath);
167 LyXParagraph * par = paragraph;
168 LyXParagraph * tmppar;
170 tmppar = par->next();
178 string const Buffer::getLatexName(bool no_path) const
181 return OnlyFilename(ChangeExtension(MakeLatexName(filename),
184 return ChangeExtension(MakeLatexName(filename),
189 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
191 string const filename = getLatexName(false);
193 if (filename.empty())
194 return make_pair(Buffer::latexlog, string());
196 string path = OnlyPath(filename);
198 if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1))
201 string const fname = AddName(path,
202 OnlyFilename(ChangeExtension(filename,
205 AddName(path, OnlyFilename(
206 ChangeExtension(filename,
207 formats.Extension("literate") + ".out")));
209 // If no Latex log or Build log is newer, show Build log
211 FileInfo const f_fi(fname);
212 FileInfo const b_fi(bname);
215 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
216 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
217 return make_pair(Buffer::buildlog, bname);
219 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
220 return make_pair(Buffer::latexlog, fname);
224 void Buffer::setReadonly(bool flag)
226 if (read_only != flag) {
229 users->owner()->getDialogs()->updateBufferDependent(false);
232 WarnReadonly(filename);
237 bool Buffer::saveParamsAsDefaults() // const
239 string const fname = AddName(AddPath(user_lyxdir, "templates/"),
241 Buffer defaults = Buffer(fname);
243 // Use the current buffer's parameters as default
244 defaults.params = params;
246 // add an empty paragraph. Is this enough?
247 defaults.paragraph = new LyXParagraph;
249 return defaults.writeFile(defaults.filename, false);
253 /// Update window titles of all users
254 // Should work on a list
255 void Buffer::updateTitles() const
257 if (users) users->owner()->updateWindowTitle();
261 /// Reset autosave timer of all users
262 // Should work on a list
263 void Buffer::resetAutosaveTimers() const
265 if (users) users->owner()->resetAutosaveTimer();
269 void Buffer::setFileName(string const & newfile)
271 filename = MakeAbsPath(newfile);
272 filepath = OnlyPath(filename);
273 setReadonly(IsFileWriteable(filename) == 0);
278 // candidate for move to BufferView
279 // (at least some parts in the beginning of the func)
282 // changed to be public and have one parameter
283 // if par = 0 normal behavior
284 // else insert behavior
285 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
286 bool Buffer::readLyXformat2(LyXLex & lex, LyXParagraph * par)
289 char depth = 0; // signed or unsigned?
290 bool the_end_read = false;
292 LyXParagraph * return_par = 0;
293 LyXFont font(LyXFont::ALL_INHERIT, params.language);
294 if (file_format < 216 && params.language->lang() == "hebrew")
295 font.setLanguage(default_language);
296 // If we are inserting, we cheat and get a token in advance
297 bool has_token = false;
301 par = new LyXParagraph;
303 users->text->BreakParagraph(users);
304 return_par = users->text->FirstParagraph();
307 // We don't want to adopt the parameters from the
308 // document we insert, so we skip until the text begins:
311 pretoken = lex.GetString();
312 if (pretoken == "\\layout") {
324 pretoken = lex.GetString();
327 if (pretoken.empty()) continue;
330 parseSingleLyXformat2Token(lex, par, return_par,
331 pretoken, pos, depth,
339 paragraph = return_par;
345 // We'll remove this later. (Lgb)
348 string last_inset_read;
354 Buffer::parseSingleLyXformat2Token(LyXLex & lex, LyXParagraph *& par,
355 LyXParagraph *& return_par,
356 string const & token, int & pos,
357 char & depth, LyXFont & font
360 bool the_end_read = false;
361 #ifndef NO_PEXTRA_REALLY
362 // This is super temporary but is needed to get the compability
363 // mode for minipages work correctly together with new tabulars.
364 static int call_depth = 0;
366 bool checkminipage = false;
367 static LyXParagraph * minipar = 0;
368 static LyXParagraph * parBeforeMinipage = 0;
371 if (token[0] != '\\') {
372 for (string::const_iterator cit = token.begin();
373 cit != token.end(); ++cit)
375 par->InsertChar(pos, (*cit), font);
378 checkminipage = true;
379 } else if (token == "\\i") {
380 Inset * inset = new InsetLatexAccent;
381 inset->Read(this, lex);
382 par->InsertInset(pos, inset, font);
384 } else if (token == "\\layout") {
386 string const layoutname = lex.GetString();
387 pair<bool, LyXTextClass::LayoutList::size_type> pp
388 = textclasslist.NumberOfLayout(params.textclass,
392 // The is the compability reading of layout caption.
393 // It can be removed in LyX version 1.3.0. (Lgb)
394 if (compare_no_case(layoutname, "caption") == 0) {
395 // We expect that the par we are now working on is
396 // really inside a InsetText inside a InsetFloat.
397 // We also know that captions can only be
398 // one paragraph. (Lgb)
400 // We should now read until the next "\layout"
402 // This is probably not good enough, what if the
403 // caption is the last par in the document (Lgb)
404 istream & ist = lex.getStream();
410 if (prefixIs(line, "\\layout")) {
414 if (prefixIs(line, "\\begin_inset"))
416 if (prefixIs(line, "\\end_inset")) {
427 // Now we should have the whole layout in ss
428 // we should now be able to give this to the
430 ss << "\\end_inset\n";
432 // This seems like a bug in stringstream.
433 // We really should be able to use ss
435 istringstream is(ss.str());
437 tmplex.setStream(is);
438 Inset * inset = new InsetCaption;
439 inset->Read(this, tmplex);
440 par->InsertInset(pos, inset, font);
448 par = new LyXParagraph(par);
452 par->layout = pp.second;
455 // use default layout "Standard" (0)
458 // Test whether the layout is obsolete.
459 LyXLayout const & layout =
460 textclasslist.Style(params.textclass,
462 if (!layout.obsoleted_by().empty())
463 par->layout = textclasslist
464 .NumberOfLayout(params.textclass,
465 layout.obsoleted_by())
467 par->params.depth(depth);
468 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
469 if (file_format < 216
470 && params.language->lang() == "hebrew")
471 font.setLanguage(default_language);
476 } else if (token == "\\begin_float") {
477 // This is the compability reader. It can be removed in
478 // LyX version 1.3.0. (Lgb)
480 string const tmptok = lex.GetString();
481 //lyxerr << "old float: " << tmptok << endl;
484 stringstream old_float;
486 if (tmptok == "footnote") {
487 inset = new InsetFoot;
488 } else if (tmptok == "margin") {
489 inset = new InsetMarginal;
490 } else if (tmptok == "fig") {
491 inset = new InsetFloat("figure");
492 old_float << "placement htbp\n";
493 } else if (tmptok == "tab") {
494 inset = new InsetFloat("table");
495 old_float << "placement htbp\n";
496 } else if (tmptok == "alg") {
497 inset = new InsetFloat("algorithm");
498 old_float << "placement htbp\n";
499 } else if (tmptok == "wide-fig") {
500 InsetFloat * tmp = new InsetFloat("figure");
503 old_float << "placement htbp\n";
504 } else if (tmptok == "wide-tab") {
505 InsetFloat * tmp = new InsetFloat("table");
508 old_float << "placement htbp\n";
513 return false; // no end read yet
516 old_float << "collapsed true\n";
518 // Here we need to check for \end_deeper and handle that
519 // before we do the footnote parsing.
520 // This _is_ a hack! (Lgb)
523 string const tmp = lex.GetString();
524 if (tmp == "\\end_deeper") {
525 //lyxerr << "\\end_deeper caught!" << endl;
527 lex.printError("\\end_deeper: "
528 "depth is already null");
533 old_float << tmp << ' ';
538 old_float << lex.getLongString("\\end_float")
539 << "\n\\end_inset\n";
540 //lyxerr << "Float Body:\n" << old_float.str() << endl;
541 // That this does not work seems like a bug
542 // in stringstream. (Lgb)
543 istringstream istr(old_float.str());
545 nylex.setStream(istr);
546 inset->Read(this, nylex);
547 par->InsertInset(pos, inset, font);
549 } else if (token == "\\begin_deeper") {
551 } else if (token == "\\end_deeper") {
553 lex.printError("\\end_deeper: "
554 "depth is already null");
558 } else if (token == "\\begin_preamble") {
559 params.readPreamble(lex);
560 } else if (token == "\\textclass") {
562 pair<bool, LyXTextClassList::size_type> pp =
563 textclasslist.NumberOfClass(lex.GetString());
565 params.textclass = pp.second;
567 WriteAlert(string(_("Textclass error")),
568 string(_("The document uses an unknown textclass \"")) +
569 lex.GetString() + string("\"."),
570 string(_("LyX will not be able to produce output correctly.")));
571 params.textclass = 0;
573 if (!textclasslist.Load(params.textclass)) {
574 // if the textclass wasn't loaded properly
575 // we need to either substitute another
576 // or stop loading the file.
577 // I can substitute but I don't see how I can
578 // stop loading... ideas?? ARRae980418
579 WriteAlert(_("Textclass Loading Error!"),
580 string(_("Can't load textclass ")) +
581 textclasslist.NameOfClass(params.textclass),
582 _("-- substituting default"));
583 params.textclass = 0;
585 } else if (token == "\\options") {
587 params.options = lex.GetString();
588 } else if (token == "\\language") {
589 params.readLanguage(lex);
590 } else if (token == "\\fontencoding") {
592 } else if (token == "\\inputencoding") {
594 params.inputenc = lex.GetString();
595 } else if (token == "\\graphics") {
596 params.readGraphicsDriver(lex);
597 } else if (token == "\\fontscheme") {
599 params.fonts = lex.GetString();
600 } else if (token == "\\noindent") {
601 par->params.noindent(true);
602 } else if (token == "\\fill_top") {
603 par->params.spaceTop(VSpace(VSpace::VFILL));
604 } else if (token == "\\fill_bottom") {
605 par->params.spaceBottom(VSpace(VSpace::VFILL));
606 } else if (token == "\\line_top") {
607 par->params.lineTop(true);
608 } else if (token == "\\line_bottom") {
609 par->params.lineBottom(true);
610 } else if (token == "\\pagebreak_top") {
611 par->params.pagebreakTop(true);
612 } else if (token == "\\pagebreak_bottom") {
613 par->params.pagebreakBottom(true);
614 } else if (token == "\\start_of_appendix") {
615 par->params.startOfAppendix(true);
616 } else if (token == "\\paragraph_separation") {
617 int tmpret = lex.FindToken(string_paragraph_separation);
618 if (tmpret == -1) ++tmpret;
619 if (tmpret != LYX_LAYOUT_DEFAULT)
620 params.paragraph_separation =
621 static_cast<BufferParams::PARSEP>(tmpret);
622 } else if (token == "\\defskip") {
624 params.defskip = VSpace(lex.GetString());
625 } else if (token == "\\epsfig") { // obsolete
626 // Indeed it is obsolete, but we HAVE to be backwards
627 // compatible until 0.14, because otherwise all figures
628 // in existing documents are irretrivably lost. (Asger)
629 params.readGraphicsDriver(lex);
630 } else if (token == "\\quotes_language") {
631 int tmpret = lex.FindToken(string_quotes_language);
632 if (tmpret == -1) ++tmpret;
633 if (tmpret != LYX_LAYOUT_DEFAULT) {
634 InsetQuotes::quote_language tmpl =
635 InsetQuotes::EnglishQ;
638 tmpl = InsetQuotes::EnglishQ;
641 tmpl = InsetQuotes::SwedishQ;
644 tmpl = InsetQuotes::GermanQ;
647 tmpl = InsetQuotes::PolishQ;
650 tmpl = InsetQuotes::FrenchQ;
653 tmpl = InsetQuotes::DanishQ;
656 params.quotes_language = tmpl;
658 } else if (token == "\\quotes_times") {
660 switch (lex.GetInteger()) {
662 params.quotes_times = InsetQuotes::SingleQ;
665 params.quotes_times = InsetQuotes::DoubleQ;
668 } else if (token == "\\papersize") {
669 int tmpret = lex.FindToken(string_papersize);
673 params.papersize2 = tmpret;
674 } else if (token == "\\paperpackage") {
675 int tmpret = lex.FindToken(string_paperpackages);
678 params.paperpackage = BufferParams::PACKAGE_NONE;
680 params.paperpackage = tmpret;
681 } else if (token == "\\use_geometry") {
683 params.use_geometry = lex.GetInteger();
684 } else if (token == "\\use_amsmath") {
686 params.use_amsmath = lex.GetInteger();
687 } else if (token == "\\paperorientation") {
688 int tmpret = lex.FindToken(string_orientation);
689 if (tmpret == -1) ++tmpret;
690 if (tmpret != LYX_LAYOUT_DEFAULT)
691 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
692 } else if (token == "\\paperwidth") {
694 params.paperwidth = lex.GetString();
695 } else if (token == "\\paperheight") {
697 params.paperheight = lex.GetString();
698 } else if (token == "\\leftmargin") {
700 params.leftmargin = lex.GetString();
701 } else if (token == "\\topmargin") {
703 params.topmargin = lex.GetString();
704 } else if (token == "\\rightmargin") {
706 params.rightmargin = lex.GetString();
707 } else if (token == "\\bottommargin") {
709 params.bottommargin = lex.GetString();
710 } else if (token == "\\headheight") {
712 params.headheight = lex.GetString();
713 } else if (token == "\\headsep") {
715 params.headsep = lex.GetString();
716 } else if (token == "\\footskip") {
718 params.footskip = lex.GetString();
719 } else if (token == "\\paperfontsize") {
721 params.fontsize = strip(lex.GetString());
722 } else if (token == "\\papercolumns") {
724 params.columns = lex.GetInteger();
725 } else if (token == "\\papersides") {
727 switch (lex.GetInteger()) {
729 case 1: params.sides = LyXTextClass::OneSide; break;
730 case 2: params.sides = LyXTextClass::TwoSides; break;
732 } else if (token == "\\paperpagestyle") {
734 params.pagestyle = strip(lex.GetString());
735 } else if (token == "\\bullet") {
737 int const index = lex.GetInteger();
739 int temp_int = lex.GetInteger();
740 params.user_defined_bullets[index].setFont(temp_int);
741 params.temp_bullets[index].setFont(temp_int);
743 temp_int = lex.GetInteger();
744 params.user_defined_bullets[index].setCharacter(temp_int);
745 params.temp_bullets[index].setCharacter(temp_int);
747 temp_int = lex.GetInteger();
748 params.user_defined_bullets[index].setSize(temp_int);
749 params.temp_bullets[index].setSize(temp_int);
751 string const temp_str = lex.GetString();
752 if (temp_str != "\\end_bullet") {
753 // this element isn't really necessary for
754 // parsing but is easier for humans
755 // to understand bullets. Put it back and
756 // set a debug message?
757 lex.printError("\\end_bullet expected, got" + temp_str);
758 //how can I put it back?
760 } else if (token == "\\bulletLaTeX") {
762 int const index = lex.GetInteger();
764 string temp_str = lex.GetString();
766 while (temp_str != "\\end_bullet") {
767 // this loop structure is needed when user
768 // enters an empty string since the first
769 // thing returned will be the \\end_bullet
771 // if the LaTeX entry has spaces. Each element
772 // therefore needs to be read in turn
775 temp_str = lex.GetString();
777 params.user_defined_bullets[index].setText(sum_str);
778 params.temp_bullets[index].setText(sum_str);
779 } else if (token == "\\secnumdepth") {
781 params.secnumdepth = lex.GetInteger();
782 } else if (token == "\\tocdepth") {
784 params.tocdepth = lex.GetInteger();
785 } else if (token == "\\spacing") {
787 string const tmp = strip(lex.GetString());
788 Spacing::Space tmp_space = Spacing::Default;
790 if (tmp == "single") {
791 tmp_space = Spacing::Single;
792 } else if (tmp == "onehalf") {
793 tmp_space = Spacing::Onehalf;
794 } else if (tmp == "double") {
795 tmp_space = Spacing::Double;
796 } else if (tmp == "other") {
798 tmp_space = Spacing::Other;
799 tmp_val = lex.GetFloat();
801 lex.printError("Unknown spacing token: '$$Token'");
803 // Small hack so that files written with klyx will be
806 par->params.spacing(Spacing(tmp_space, tmp_val));
808 params.spacing.set(tmp_space, tmp_val);
810 } else if (token == "\\paragraph_spacing") {
812 string const tmp = strip(lex.GetString());
813 if (tmp == "single") {
814 par->params.spacing(Spacing(Spacing::Single));
815 } else if (tmp == "onehalf") {
816 par->params.spacing(Spacing(Spacing::Onehalf));
817 } else if (tmp == "double") {
818 par->params.spacing(Spacing(Spacing::Double));
819 } else if (tmp == "other") {
821 par->params.spacing(Spacing(Spacing::Other,
824 lex.printError("Unknown spacing token: '$$Token'");
826 } else if (token == "\\float_placement") {
828 params.float_placement = lex.GetString();
829 } else if (token == "\\family") {
831 font.setLyXFamily(lex.GetString());
832 } else if (token == "\\series") {
834 font.setLyXSeries(lex.GetString());
835 } else if (token == "\\shape") {
837 font.setLyXShape(lex.GetString());
838 } else if (token == "\\size") {
840 font.setLyXSize(lex.GetString());
841 } else if (token == "\\latex") {
843 string const tok = lex.GetString();
844 // This is dirty, but gone with LyX3. (Asger)
845 if (tok == "no_latex")
846 font.setLatex(LyXFont::OFF);
847 else if (tok == "latex")
848 font.setLatex(LyXFont::ON);
849 else if (tok == "default")
850 font.setLatex(LyXFont::INHERIT);
852 lex.printError("Unknown LaTeX font flag "
854 } else if (token == "\\lang") {
856 string const tok = lex.GetString();
857 Language const * lang = languages.getLanguage(tok);
859 font.setLanguage(lang);
861 font.setLanguage(params.language);
862 lex.printError("Unknown language `$$Token'");
864 } else if (token == "\\numeric") {
866 font.setNumber(font.setLyXMisc(lex.GetString()));
867 } else if (token == "\\emph") {
869 font.setEmph(font.setLyXMisc(lex.GetString()));
870 } else if (token == "\\bar") {
872 string const tok = lex.GetString();
873 // This is dirty, but gone with LyX3. (Asger)
875 font.setUnderbar(LyXFont::ON);
876 else if (tok == "no")
877 font.setUnderbar(LyXFont::OFF);
878 else if (tok == "default")
879 font.setUnderbar(LyXFont::INHERIT);
881 lex.printError("Unknown bar font flag "
883 } else if (token == "\\noun") {
885 font.setNoun(font.setLyXMisc(lex.GetString()));
886 } else if (token == "\\color") {
888 font.setLyXColor(lex.GetString());
889 } else if (token == "\\align") {
890 int tmpret = lex.FindToken(string_align);
891 if (tmpret == -1) ++tmpret;
892 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
893 int const tmpret2 = int(pow(2.0, tmpret));
894 //lyxerr << "Tmpret2 = " << tmpret2 << endl;
895 par->params.align(LyXAlignment(tmpret2));
897 } else if (token == "\\added_space_top") {
899 par->params.spaceTop(VSpace(lex.GetString()));
900 } else if (token == "\\added_space_bottom") {
902 par->params.spaceBottom(VSpace(lex.GetString()));
903 #ifndef NO_PEXTRA_REALLY
904 } else if (token == "\\pextra_type") {
906 par->params.pextraType(lex.GetInteger());
907 } else if (token == "\\pextra_width") {
909 par->params.pextraWidth(lex.GetString());
910 } else if (token == "\\pextra_widthp") {
912 par->params.pextraWidthp(lex.GetString());
913 } else if (token == "\\pextra_alignment") {
915 par->params.pextraAlignment(lex.GetInteger());
916 } else if (token == "\\pextra_hfill") {
918 par->params.pextraHfill(lex.GetInteger());
919 } else if (token == "\\pextra_start_minipage") {
921 par->params.pextraStartMinipage(lex.GetInteger());
923 } else if (token == "\\labelwidthstring") {
925 par->params.labelWidthString(lex.GetString());
926 // do not delete this token, it is still needed!
927 } else if (token == "\\end_inset") {
928 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
929 << "Last inset read was: " << last_inset_read
931 // Simply ignore this. The insets do not have
933 // But insets should read it, it is a part of
934 // the inset isn't it? Lgb.
935 } else if (token == "\\begin_inset") {
936 readInset(lex, par, pos, font);
937 } else if (token == "\\SpecialChar") {
938 LyXLayout const & layout =
939 textclasslist.Style(params.textclass,
942 // Insets don't make sense in a free-spacing context! ---Kayvan
943 if (layout.free_spacing) {
946 string next_token = lex.GetString();
947 if (next_token == "\\-") {
948 par->InsertChar(pos, '-', font);
949 } else if (next_token == "\\protected_separator"
950 || next_token == "~") {
951 par->InsertChar(pos, ' ', font);
953 lex.printError("Token `$$Token' "
955 "paragraph layout!");
960 Inset * inset = new InsetSpecialChar;
961 inset->Read(this, lex);
962 par->InsertInset(pos, inset, font);
965 } else if (token == "\\newline") {
966 par->InsertChar(pos, LyXParagraph::META_NEWLINE, font);
968 } else if (token == "\\LyXTable") {
969 Inset * inset = new InsetTabular(*this);
970 inset->Read(this, lex);
971 par->InsertInset(pos, inset, font);
973 // because of OLD_TABULAR_READ where tabulars have been
975 checkminipage = true;
976 } else if (token == "\\hfill") {
977 par->InsertChar(pos, LyXParagraph::META_HFILL, font);
979 } else if (token == "\\protected_separator") { // obsolete
980 // This is a backward compability thingie. (Lgb)
981 // Remove it later some time...introduced with fileformat
983 LyXLayout const & layout =
984 textclasslist.Style(params.textclass,
987 if (layout.free_spacing) {
988 par->InsertChar(pos, ' ', font);
990 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
991 par->InsertInset(pos, inset, font);
994 } else if (token == "\\bibitem") { // ale970302
996 InsetCommandParams p("bibitem", "dummy");
997 par->bibkey = new InsetBibKey(p);
999 par->bibkey->Read(this, lex);
1000 } else if (token == "\\backslash") {
1001 par->InsertChar(pos, '\\', font);
1003 } else if (token == "\\the_end") {
1004 the_end_read = true;
1005 minipar = parBeforeMinipage = 0;
1007 // This should be insurance for the future: (Asger)
1008 lex.printError("Unknown token `$$Token'. "
1009 "Inserting as text.");
1010 string::const_iterator cit = token.begin();
1011 string::const_iterator end = token.end();
1012 for (; cit != end; ++cit) {
1013 par->InsertChar(pos, (*cit), font);
1017 #ifndef NO_PEXTRA_REALLY
1018 // now check if we have a minipage paragraph as at this
1019 // point we already read all the necessary data!
1020 // this cannot be done in layout because there we did
1021 // not read yet the paragraph PEXTRA-params (Jug)
1023 // BEGIN pextra_minipage compability
1024 // This should be removed in 1.3.x (Lgb)
1026 // This compability code is not perfect. In a couple
1027 // of rand cases it fails. When the minipage par is
1028 // the first par in the document, and when there are
1029 // none or only one regular paragraphs after the
1030 // minipage. Currently I am not investing any effort
1031 // in fixing those cases.
1033 //lyxerr << "Call depth: " << call_depth << endl;
1034 if (checkminipage && (call_depth == 1)) {
1035 checkminipage = false;
1036 if (minipar && (minipar != par) &&
1037 (par->params.pextraType()==LyXParagraph::PEXTRA_MINIPAGE))
1039 lyxerr << "minipages in a row" << endl;
1040 if (par->params.pextraStartMinipage()) {
1041 lyxerr << "start new minipage" << endl;
1042 // minipages in a row
1043 par->previous()->next(0);
1046 LyXParagraph * tmp = minipar;
1048 tmp->params.pextraType(0);
1049 tmp->params.pextraWidth(string());
1050 tmp->params.pextraWidthp(string());
1051 tmp->params.pextraAlignment(0);
1052 tmp->params.pextraHfill(false);
1053 tmp->params.pextraStartMinipage(false);
1056 // create a new paragraph to insert the
1057 // minipages in the following case
1058 if (par->params.pextraStartMinipage() &&
1059 !par->params.pextraHfill())
1061 LyXParagraph * p = new LyXParagraph;
1063 p->previous(parBeforeMinipage);
1064 parBeforeMinipage->next(p);
1066 p->params.depth(parBeforeMinipage->params.depth());
1067 parBeforeMinipage = p;
1069 InsetMinipage * mini = new InsetMinipage;
1070 mini->pos(static_cast<InsetMinipage::Position>(par->params.pextraAlignment()));
1071 mini->width(par->params.pextraWidth());
1072 if (!par->params.pextraWidthp().empty()) {
1073 lyxerr << "WP:" << mini->width() << endl;
1074 mini->width(tostr(par->params.pextraWidthp())+"%");
1076 mini->inset.par = par;
1077 // Insert the minipage last in the
1078 // previous paragraph.
1079 if (par->params.pextraHfill()) {
1080 parBeforeMinipage->InsertChar
1081 (parBeforeMinipage->size(), LyXParagraph::META_HFILL);
1083 parBeforeMinipage->InsertInset
1084 (parBeforeMinipage->size(), mini);
1088 lyxerr << "new minipage par" << endl;
1089 //nothing to do just continue reading
1092 } else if (minipar && (minipar != par)) {
1093 lyxerr << "last minipage par read" << endl;
1094 // The last paragraph read was not part of a
1095 // minipage but the par linked list is...
1096 // So we need to remove the last par from the
1098 if (par->previous())
1099 par->previous()->next(0);
1100 par->previous(parBeforeMinipage);
1101 parBeforeMinipage->next(par);
1102 LyXParagraph * tmp = minipar;
1104 tmp->params.pextraType(0);
1105 tmp->params.pextraWidth(string());
1106 tmp->params.pextraWidthp(string());
1107 tmp->params.pextraAlignment(0);
1108 tmp->params.pextraHfill(false);
1109 tmp->params.pextraStartMinipage(false);
1112 depth = parBeforeMinipage->params.depth();
1113 minipar = parBeforeMinipage = 0;
1114 } else if (!minipar &&
1115 (par->params.pextraType() == LyXParagraph::PEXTRA_MINIPAGE))
1117 // par is the first paragraph in a minipage
1118 lyxerr << "begin minipage" << endl;
1119 // To minimize problems for
1120 // the users we will insert
1121 // the first minipage in
1122 // a sequence of minipages
1123 // in its own paragraph.
1124 LyXParagraph * p = new LyXParagraph;
1126 p->previous(par->previous());
1128 p->params.depth(depth);
1129 par->params.depth(0);
1131 if (par->previous())
1132 par->previous()->next(p);
1134 parBeforeMinipage = p;
1136 if (!return_par || (return_par == par))
1139 InsetMinipage * mini = new InsetMinipage;
1140 mini->pos(static_cast<InsetMinipage::Position>(minipar->params.pextraAlignment()));
1141 mini->width(minipar->params.pextraWidth());
1142 if (!par->params.pextraWidthp().empty()) {
1143 lyxerr << "WP:" << mini->width() << endl;
1144 mini->width(tostr(par->params.pextraWidthp())+"%");
1146 mini->inset.par = minipar;
1148 // Insert the minipage last in the
1149 // previous paragraph.
1150 if (minipar->params.pextraHfill()) {
1151 parBeforeMinipage->InsertChar
1152 (parBeforeMinipage->size(),LyXParagraph::META_HFILL);
1154 parBeforeMinipage->InsertInset
1155 (parBeforeMinipage->size(), mini);
1158 // End of pextra_minipage compability
1161 return the_end_read;
1165 void Buffer::readInset(LyXLex & lex, LyXParagraph *& par,
1166 int & pos, LyXFont & font)
1168 // consistency check
1169 if (lex.GetString() != "\\begin_inset") {
1170 lyxerr << "Buffer::readInset: Consistency check failed."
1177 string const tmptok = lex.GetString();
1178 last_inset_read = tmptok;
1180 // test the different insets
1181 if (tmptok == "LatexCommand") {
1182 InsetCommandParams inscmd;
1185 string const cmdName = inscmd.getCmdName();
1187 if (cmdName == "cite") {
1188 inset = new InsetCitation(inscmd);
1189 } else if (cmdName == "bibitem") {
1190 lex.printError("Wrong place for bibitem");
1191 inset = new InsetBibKey(inscmd);
1192 } else if (cmdName == "BibTeX") {
1193 inset = new InsetBibtex(inscmd);
1194 } else if (cmdName == "index") {
1195 inset = new InsetIndex(inscmd);
1196 } else if (cmdName == "include") {
1197 inset = new InsetInclude(inscmd, *this);
1198 } else if (cmdName == "label") {
1199 inset = new InsetLabel(inscmd);
1200 } else if (cmdName == "url"
1201 || cmdName == "htmlurl") {
1202 inset = new InsetUrl(inscmd);
1203 } else if (cmdName == "ref"
1204 || cmdName == "pageref"
1205 || cmdName == "vref"
1206 || cmdName == "vpageref"
1207 || cmdName == "prettyref") {
1208 if (!inscmd.getOptions().empty()
1209 || !inscmd.getContents().empty()) {
1210 inset = new InsetRef(inscmd, *this);
1212 } else if (cmdName == "tableofcontents") {
1213 inset = new InsetTOC(inscmd);
1214 } else if (cmdName == "listofalgorithms") {
1215 inset = new InsetFloatList("algorithm");
1216 } else if (cmdName == "listoffigures") {
1217 inset = new InsetFloatList("figure");
1218 } else if (cmdName == "listoftables") {
1219 inset = new InsetFloatList("table");
1220 } else if (cmdName == "printindex") {
1221 inset = new InsetPrintIndex(inscmd);
1222 } else if (cmdName == "lyxparent") {
1223 inset = new InsetParent(inscmd, *this);
1226 if (tmptok == "Quotes") {
1227 inset = new InsetQuotes;
1228 } else if (tmptok == "External") {
1229 inset = new InsetExternal;
1230 } else if (tmptok == "FormulaMacro") {
1231 inset = new InsetFormulaMacro;
1232 } else if (tmptok == "Formula") {
1233 inset = new InsetFormula;
1234 } else if (tmptok == "Figure") {
1235 inset = new InsetFig(100, 100, *this);
1236 } else if (tmptok == "Info") {
1237 inset = new InsetInfo;
1238 } else if (tmptok == "Include") {
1239 InsetCommandParams p( "Include" );
1240 inset = new InsetInclude(p, *this);
1241 } else if (tmptok == "ERT") {
1242 inset = new InsetERT;
1243 } else if (tmptok == "Tabular") {
1244 inset = new InsetTabular(*this);
1245 } else if (tmptok == "Text") {
1246 inset = new InsetText;
1247 } else if (tmptok == "Foot") {
1248 inset = new InsetFoot;
1249 } else if (tmptok == "Marginal") {
1250 inset = new InsetMarginal;
1251 } else if (tmptok == "Minipage") {
1252 inset = new InsetMinipage;
1253 } else if (tmptok == "Float") {
1255 string tmptok = lex.GetString();
1256 inset = new InsetFloat(tmptok);
1257 } else if (tmptok == "List") {
1258 inset = new InsetList;
1259 } else if (tmptok == "Theorem") {
1260 inset = new InsetList;
1261 } else if (tmptok == "Caption") {
1262 inset = new InsetCaption;
1263 } else if (tmptok == "GRAPHICS") {
1264 inset = new InsetGraphics;
1265 } else if (tmptok == "FloatList") {
1266 inset = new InsetFloatList;
1269 if (inset) inset->Read(this, lex);
1273 par->InsertInset(pos, inset, font);
1279 bool Buffer::readFile(LyXLex & lex, LyXParagraph * par)
1283 string const token(lex.GetString());
1284 if (token == "\\lyxformat") { // the first token _must_ be...
1286 string tmp_format = lex.GetString();
1287 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1288 // if present remove ".," from string.
1289 string::size_type dot = tmp_format.find_first_of(".,");
1290 //lyxerr << " dot found at " << dot << endl;
1291 if (dot != string::npos)
1292 tmp_format.erase(dot, 1);
1293 file_format = strToInt(tmp_format);
1294 if (file_format == LYX_FORMAT) {
1296 } else if (file_format > LYX_FORMAT) {
1298 WriteAlert(_("Warning!"),
1299 _("LyX file format is newer that what"),
1300 _("is supported in this LyX version. Expect some problems."));
1302 } else if (file_format < LYX_FORMAT) {
1304 if (file_format < 200) {
1305 WriteAlert(_("ERROR!"),
1306 _("Old LyX file format found. "
1307 "Use LyX 0.10.x to read this!"));
1311 bool the_end = readLyXformat2(lex, par);
1313 // the_end was added in 213
1314 if (file_format < 213)
1318 WriteAlert(_("Warning!"),
1319 _("Reading of document is not complete"),
1320 _("Maybe the document is truncated"));
1322 } else { // "\\lyxformat" not found
1323 WriteAlert(_("ERROR!"), _("Not a LyX file!"));
1326 WriteAlert(_("ERROR!"), _("Unable to read file!"));
1332 // Should probably be moved to somewhere else: BufferView? LyXView?
1333 bool Buffer::save() const
1335 // We don't need autosaves in the immediate future. (Asger)
1336 resetAutosaveTimers();
1340 if (lyxrc.make_backup) {
1341 s = fileName() + '~';
1342 if (!lyxrc.backupdir_path.empty())
1343 s = AddName(lyxrc.backupdir_path,
1344 subst(CleanupPath(s),'/','!'));
1346 // Rename is the wrong way of making a backup,
1347 // this is the correct way.
1348 /* truss cp fil fil2:
1349 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1350 stat("LyXVC.lyx", 0xEFFFF688) = 0
1351 open("LyXVC.lyx", O_RDONLY) = 3
1352 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1353 fstat(4, 0xEFFFF508) = 0
1354 fstat(3, 0xEFFFF508) = 0
1355 read(3, " # T h i s f i l e w".., 8192) = 5579
1356 write(4, " # T h i s f i l e w".., 5579) = 5579
1357 read(3, 0xEFFFD4A0, 8192) = 0
1360 chmod("LyXVC3.lyx", 0100644) = 0
1361 lseek(0, 0, SEEK_CUR) = 46440
1365 // Should proabaly have some more error checking here.
1366 // Should be cleaned up in 0.13, at least a bit.
1367 // Doing it this way, also makes the inodes stay the same.
1368 // This is still not a very good solution, in particular we
1369 // might loose the owner of the backup.
1370 FileInfo finfo(fileName());
1371 if (finfo.exist()) {
1372 mode_t fmode = finfo.getMode();
1373 struct utimbuf times = {
1374 finfo.getAccessTime(),
1375 finfo.getModificationTime() };
1377 ifstream ifs(fileName().c_str());
1378 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1383 ::chmod(s.c_str(), fmode);
1385 if (::utime(s.c_str(), ×)) {
1386 lyxerr << "utime error." << endl;
1389 lyxerr << "LyX was not able to make "
1390 "backupcopy. Beware." << endl;
1395 if (writeFile(fileName(), false)) {
1397 removeAutosaveFile(fileName());
1399 // Saving failed, so backup is not backup
1400 if (lyxrc.make_backup) {
1401 lyx::rename(s, fileName());
1409 // Returns false if unsuccesful
1410 bool Buffer::writeFile(string const & fname, bool flag) const
1412 // if flag is false writeFile will not create any GUI
1413 // warnings, only cerr.
1414 // Needed for autosave in background or panic save (Matthias 120496)
1416 if (read_only && (fname == filename)) {
1417 // Here we should come with a question if we should
1418 // perform the write anyway.
1420 lyxerr << _("Error! Document is read-only: ")
1423 WriteAlert(_("Error! Document is read-only: "),
1428 FileInfo finfo(fname);
1429 if (finfo.exist() && !finfo.writable()) {
1430 // Here we should come with a question if we should
1431 // try to do the save anyway. (i.e. do a chmod first)
1433 lyxerr << _("Error! Cannot write file: ")
1436 WriteFSAlert(_("Error! Cannot write file: "),
1441 ofstream ofs(fname.c_str());
1444 lyxerr << _("Error! Cannot open file: ")
1447 WriteFSAlert(_("Error! Cannot open file: "),
1453 // Use the standard "C" locale for file output.
1454 ofs.imbue(std::locale::classic());
1457 // The top of the file should not be written by params.
1459 // write out a comment in the top of the file
1460 ofs << '#' << LYX_DOCVERSION
1461 << " created this file. For more info see http://www.lyx.org/\n"
1462 << "\\lyxformat " << LYX_FORMAT << "\n";
1464 // now write out the buffer paramters.
1465 params.writeFile(ofs);
1467 char footnoteflag = 0;
1470 // this will write out all the paragraphs
1471 // using recursive descent.
1472 paragraph->writeFile(this, ofs, params, footnoteflag, depth);
1474 // Write marker that shows file is complete
1475 ofs << "\n\\the_end" << endl;
1479 // how to check if close went ok?
1480 // Following is an attempt... (BE 20001011)
1482 // good() returns false if any error occured, including some
1483 // formatting error.
1484 // bad() returns true if something bad happened in the buffer,
1485 // which should include file system full errors.
1492 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1494 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1504 string const Buffer::asciiParagraph(LyXParagraph const * par,
1505 unsigned int linelen) const
1507 ostringstream buffer;
1510 Inset const * inset;
1514 int ltype_depth = 0;
1515 unsigned int currlinelen = 0;
1516 bool ref_printed = false;
1520 if (!par->previous()) {
1521 /* begins or ends a deeper area ?*/
1522 if (depth != par->params.depth()) {
1523 if (par->params.depth() > depth) {
1524 while (par->params.depth() > depth) {
1528 while (par->params.depth() < depth) {
1534 /* First write the layout */
1535 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1536 if (tmp == "Itemize") {
1538 ltype_depth = depth + 1;
1539 } else if (tmp == "Enumerate") {
1541 ltype_depth = depth + 1;
1542 } else if (strstr(tmp.c_str(), "ection")) {
1544 ltype_depth = depth + 1;
1545 } else if (strstr(tmp.c_str(), "aragraph")) {
1547 ltype_depth = depth + 1;
1548 } else if (tmp == "Description") {
1550 ltype_depth = depth + 1;
1551 } else if (tmp == "Abstract") {
1554 } else if (tmp == "Bibliography") {
1562 /* maybe some vertical spaces */
1564 /* the labelwidthstring used in lists */
1568 /* some pagebreaks? */
1572 /* what about the alignment */
1574 lyxerr << "Should this ever happen?" << endl;
1577 font1 = LyXFont(LyXFont::ALL_INHERIT, params.language);
1578 for (LyXParagraph::size_type i = 0; i < par->size(); ++i) {
1579 if (!i && !noparbreak) {
1582 for (char j = 0; j < depth; ++j)
1584 currlinelen = depth * 2;
1586 case 0: /* Standard */
1587 case 4: /* (Sub)Paragraph */
1588 case 5: /* Description */
1590 case 6: /* Abstract */
1592 buffer << "Abstract\n\n";
1594 buffer << "Abstract: ";
1596 case 7: /* Bibliography */
1599 buffer << "References\n\n";
1601 buffer << "References: ";
1606 buffer << par->params.labelString() << " ";
1609 if (ltype_depth > depth) {
1610 for (char j = ltype_depth - 1; j > depth; --j)
1612 currlinelen += (ltype_depth-depth)*2;
1615 font2 = par->GetFontSettings(params, i);
1616 if (font1.latex() != font2.latex()) {
1617 if (font2.latex() == LyXFont::OFF)
1624 c = par->GetUChar(params, i);
1628 case LyXParagraph::META_INSET:
1629 if ((inset = par->GetInset(i))) {
1630 if (!inset->Ascii(this, buffer)) {
1632 string s = rsplit(buffer.str().c_str(),
1634 currlinelen += s.length();
1636 // to be sure it breaks paragraph
1637 currlinelen += linelen;
1641 case LyXParagraph::META_NEWLINE:
1644 for (char j = 0; j < depth; ++j)
1647 currlinelen = depth * 2;
1648 if (ltype_depth > depth) {
1649 for (char j = ltype_depth;
1652 currlinelen += (ltype_depth - depth) * 2;
1655 case LyXParagraph::META_HFILL:
1662 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1663 (c == ' ') && ((i + 2) < par->size()))
1666 for (char j = 0; j < depth; ++j)
1668 currlinelen = depth * 2;
1669 if (ltype_depth > depth) {
1670 for (char j = ltype_depth;
1673 currlinelen += (ltype_depth-depth)*2;
1675 } else if (c != '\0')
1678 lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1683 return buffer.str().c_str();
1687 void Buffer::writeFileAscii(string const & fname, int linelen)
1689 ofstream ofs(fname.c_str());
1691 WriteFSAlert(_("Error: Cannot write file:"), fname);
1694 writeFileAscii(ofs, linelen);
1698 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1700 LyXParagraph * par = paragraph;
1702 ofs << asciiParagraph(par, linelen);
1710 void Buffer::makeLaTeXFile(string const & fname,
1711 string const & original_path,
1712 bool nice, bool only_body)
1714 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1716 niceFile = nice; // this will be used by Insetincludes.
1718 tex_code_break_column = lyxrc.ascii_linelen;
1720 LyXTextClass const & tclass =
1721 textclasslist.TextClass(params.textclass);
1723 ofstream ofs(fname.c_str());
1725 WriteFSAlert(_("Error: Cannot open file: "), fname);
1729 // validate the buffer.
1730 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1731 LaTeXFeatures features(params, tclass.numLayouts());
1733 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1736 // The starting paragraph of the coming rows is the
1737 // first paragraph of the document. (Asger)
1738 texrow.start(paragraph, 0);
1740 if (!only_body && nice) {
1741 ofs << "%% " LYX_DOCVERSION " created this file. "
1742 "For more info, see http://www.lyx.org/.\n"
1743 "%% Do not edit unless you really know what "
1748 lyxerr.debug() << "lyx header finished" << endl;
1749 // There are a few differences between nice LaTeX and usual files:
1750 // usual is \batchmode and has a
1751 // special input@path to allow the including of figures
1752 // with either \input or \includegraphics (what figinsets do).
1753 // batchmode is not set if there is a tex_code_break_column.
1754 // In this case somebody is interested in the generated LaTeX,
1755 // so this is OK. input@path is set when the actual parameter
1756 // original_path is set. This is done for usual tex-file, but not
1757 // for nice-latex-file. (Matthias 250696)
1760 // code for usual, NOT nice-latex-file
1761 ofs << "\\batchmode\n"; // changed
1762 // from \nonstopmode
1765 if (!original_path.empty()) {
1766 ofs << "\\makeatletter\n"
1767 << "\\def\\input@path{{"
1768 << original_path << "/}}\n"
1769 << "\\makeatother\n";
1775 ofs << "\\documentclass";
1777 string options; // the document class options.
1779 if (tokenPos(tclass.opt_fontsize(),
1780 '|', params.fontsize) >= 0) {
1781 // only write if existing in list (and not default)
1782 options += params.fontsize;
1787 if (!params.use_geometry &&
1788 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1789 switch (params.papersize) {
1790 case BufferParams::PAPER_A4PAPER:
1791 options += "a4paper,";
1793 case BufferParams::PAPER_USLETTER:
1794 options += "letterpaper,";
1796 case BufferParams::PAPER_A5PAPER:
1797 options += "a5paper,";
1799 case BufferParams::PAPER_B5PAPER:
1800 options += "b5paper,";
1802 case BufferParams::PAPER_EXECUTIVEPAPER:
1803 options += "executivepaper,";
1805 case BufferParams::PAPER_LEGALPAPER:
1806 options += "legalpaper,";
1812 if (params.sides != tclass.sides()) {
1813 switch (params.sides) {
1814 case LyXTextClass::OneSide:
1815 options += "oneside,";
1817 case LyXTextClass::TwoSides:
1818 options += "twoside,";
1825 if (params.columns != tclass.columns()) {
1826 if (params.columns == 2)
1827 options += "twocolumn,";
1829 options += "onecolumn,";
1832 if (!params.use_geometry
1833 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1834 options += "landscape,";
1836 // language should be a parameter to \documentclass
1838 string language_options;
1839 if (params.language->babel() == "hebrew"
1840 && default_language->babel() != "hebrew")
1841 // This seems necessary
1842 features.UsedLanguages.insert(default_language);
1844 if (lyxrc.language_use_babel ||
1845 params.language->lang() != lyxrc.default_language ||
1846 !features.UsedLanguages.empty()) {
1848 for (LaTeXFeatures::LanguageList::const_iterator cit =
1849 features.UsedLanguages.begin();
1850 cit != features.UsedLanguages.end(); ++cit)
1851 language_options += (*cit)->babel() + ',';
1852 language_options += params.language->babel();
1853 if (lyxrc.language_global_options)
1854 options += language_options + ',';
1857 // the user-defined options
1858 if (!params.options.empty()) {
1859 options += params.options + ',';
1862 if (!options.empty()){
1863 options = strip(options, ',');
1864 ofs << '[' << options << ']';
1868 << textclasslist.LatexnameOfClass(params.textclass)
1871 // end of \documentclass defs
1873 // font selection must be done before loading fontenc.sty
1874 // The ae package is not needed when using OT1 font encoding.
1875 if (params.fonts != "default" &&
1876 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
1877 ofs << "\\usepackage{" << params.fonts << "}\n";
1879 if (params.fonts == "ae") {
1880 ofs << "\\usepackage{aecompl}\n";
1884 // this one is not per buffer
1885 if (lyxrc.fontenc != "default") {
1886 ofs << "\\usepackage[" << lyxrc.fontenc
1891 if (params.inputenc == "auto") {
1892 string const doc_encoding =
1893 params.language->encoding()->LatexName();
1895 // Create a list with all the input encodings used
1897 set<string> encodings;
1898 for (LaTeXFeatures::LanguageList::const_iterator it =
1899 features.UsedLanguages.begin();
1900 it != features.UsedLanguages.end(); ++it)
1901 if ((*it)->encoding()->LatexName() != doc_encoding)
1902 encodings.insert((*it)->encoding()->LatexName());
1904 ofs << "\\usepackage[";
1905 std::copy(encodings.begin(), encodings.end(),
1906 std::ostream_iterator<string>(ofs, ","));
1907 ofs << doc_encoding << "]{inputenc}\n";
1909 } else if (params.inputenc != "default") {
1910 ofs << "\\usepackage[" << params.inputenc
1915 // At the very beginning the text parameters.
1916 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1917 switch (params.paperpackage) {
1918 case BufferParams::PACKAGE_A4:
1919 ofs << "\\usepackage{a4}\n";
1922 case BufferParams::PACKAGE_A4WIDE:
1923 ofs << "\\usepackage{a4wide}\n";
1926 case BufferParams::PACKAGE_WIDEMARGINSA4:
1927 ofs << "\\usepackage[widemargins]{a4}\n";
1932 if (params.use_geometry) {
1933 ofs << "\\usepackage{geometry}\n";
1935 ofs << "\\geometry{verbose";
1936 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1937 ofs << ",landscape";
1938 switch (params.papersize2) {
1939 case BufferParams::VM_PAPER_CUSTOM:
1940 if (!params.paperwidth.empty())
1941 ofs << ",paperwidth="
1942 << params.paperwidth;
1943 if (!params.paperheight.empty())
1944 ofs << ",paperheight="
1945 << params.paperheight;
1947 case BufferParams::VM_PAPER_USLETTER:
1948 ofs << ",letterpaper";
1950 case BufferParams::VM_PAPER_USLEGAL:
1951 ofs << ",legalpaper";
1953 case BufferParams::VM_PAPER_USEXECUTIVE:
1954 ofs << ",executivepaper";
1956 case BufferParams::VM_PAPER_A3:
1959 case BufferParams::VM_PAPER_A4:
1962 case BufferParams::VM_PAPER_A5:
1965 case BufferParams::VM_PAPER_B3:
1968 case BufferParams::VM_PAPER_B4:
1971 case BufferParams::VM_PAPER_B5:
1975 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1976 switch (lyxrc.default_papersize) {
1977 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1978 case BufferParams::PAPER_USLETTER:
1979 ofs << ",letterpaper";
1981 case BufferParams::PAPER_LEGALPAPER:
1982 ofs << ",legalpaper";
1984 case BufferParams::PAPER_EXECUTIVEPAPER:
1985 ofs << ",executivepaper";
1987 case BufferParams::PAPER_A3PAPER:
1990 case BufferParams::PAPER_A4PAPER:
1993 case BufferParams::PAPER_A5PAPER:
1996 case BufferParams::PAPER_B5PAPER:
2001 if (!params.topmargin.empty())
2002 ofs << ",tmargin=" << params.topmargin;
2003 if (!params.bottommargin.empty())
2004 ofs << ",bmargin=" << params.bottommargin;
2005 if (!params.leftmargin.empty())
2006 ofs << ",lmargin=" << params.leftmargin;
2007 if (!params.rightmargin.empty())
2008 ofs << ",rmargin=" << params.rightmargin;
2009 if (!params.headheight.empty())
2010 ofs << ",headheight=" << params.headheight;
2011 if (!params.headsep.empty())
2012 ofs << ",headsep=" << params.headsep;
2013 if (!params.footskip.empty())
2014 ofs << ",footskip=" << params.footskip;
2018 if (features.amsstyle
2019 && !tclass.provides(LyXTextClass::amsmath)) {
2020 ofs << "\\usepackage{amsmath}\n";
2024 if (tokenPos(tclass.opt_pagestyle(),
2025 '|', params.pagestyle) >= 0) {
2026 if (params.pagestyle == "fancy") {
2027 ofs << "\\usepackage{fancyhdr}\n";
2030 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2034 // We try to load babel late, in case it interferes
2035 // with other packages.
2037 string tmp = lyxrc.language_package;
2038 if (!lyxrc.language_global_options
2039 && tmp == "\\usepackage{babel}")
2040 tmp = "\\usepackage[" +
2041 language_options + "]{babel}";
2046 if (params.secnumdepth != tclass.secnumdepth()) {
2047 ofs << "\\setcounter{secnumdepth}{"
2048 << params.secnumdepth
2052 if (params.tocdepth != tclass.tocdepth()) {
2053 ofs << "\\setcounter{tocdepth}{"
2059 if (params.paragraph_separation) {
2060 switch (params.defskip.kind()) {
2061 case VSpace::SMALLSKIP:
2062 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2064 case VSpace::MEDSKIP:
2065 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2067 case VSpace::BIGSKIP:
2068 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2070 case VSpace::LENGTH:
2071 ofs << "\\setlength\\parskip{"
2072 << params.defskip.length().asLatexString()
2075 default: // should never happen // Then delete it.
2076 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2081 ofs << "\\setlength\\parindent{0pt}\n";
2085 // Now insert the LyX specific LaTeX commands...
2087 // The optional packages;
2088 string preamble(features.getPackages());
2090 // this might be useful...
2091 preamble += "\n\\makeatletter\n";
2093 // Some macros LyX will need
2094 string tmppreamble(features.getMacros());
2096 if (!tmppreamble.empty()) {
2097 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2098 "LyX specific LaTeX commands.\n"
2099 + tmppreamble + '\n';
2102 // the text class specific preamble
2103 tmppreamble = features.getTClassPreamble();
2104 if (!tmppreamble.empty()) {
2105 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2106 "Textclass specific LaTeX commands.\n"
2107 + tmppreamble + '\n';
2110 /* the user-defined preamble */
2111 if (!params.preamble.empty()) {
2112 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2113 "User specified LaTeX commands.\n"
2114 + params.preamble + '\n';
2117 preamble += "\\makeatother\n";
2119 // Itemize bullet settings need to be last in case the user
2120 // defines their own bullets that use a package included
2121 // in the user-defined preamble -- ARRae
2122 // Actually it has to be done much later than that
2123 // since some packages like frenchb make modifications
2124 // at \begin{document} time -- JMarc
2126 for (int i = 0; i < 4; ++i) {
2127 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2128 if (bullets_def.empty())
2129 bullets_def="\\AtBeginDocument{\n";
2130 bullets_def += " \\renewcommand{\\labelitemi";
2132 // `i' is one less than the item to modify
2139 bullets_def += "ii";
2145 bullets_def += "}{" +
2146 params.user_defined_bullets[i].getText()
2151 if (!bullets_def.empty())
2152 preamble += bullets_def + "}\n\n";
2154 for (int j = countChar(preamble, '\n'); j-- ;) {
2161 ofs << "\\begin{document}\n";
2164 lyxerr.debug() << "preamble finished, now the body." << endl;
2166 if (!lyxrc.language_auto_begin) {
2167 ofs << subst(lyxrc.language_command_begin, "$$lang",
2168 params.language->babel())
2173 latexParagraphs(ofs, paragraph, 0, texrow);
2175 // add this just in case after all the paragraphs
2179 if (!lyxrc.language_auto_end) {
2180 ofs << subst(lyxrc.language_command_end, "$$lang",
2181 params.language->babel())
2187 ofs << "\\end{document}\n";
2190 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2192 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2196 // Just to be sure. (Asger)
2199 // tex_code_break_column's value is used to decide
2200 // if we are in batchmode or not (within mathed_write()
2201 // in math_write.C) so we must set it to a non-zero
2202 // value when we leave otherwise we save incorrect .lyx files.
2203 tex_code_break_column = lyxrc.ascii_linelen;
2207 lyxerr << "File was not closed properly." << endl;
2210 lyxerr.debug() << "Finished making latex file." << endl;
2215 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2217 void Buffer::latexParagraphs(ostream & ofs, LyXParagraph * par,
2218 LyXParagraph * endpar, TexRow & texrow) const
2220 bool was_title = false;
2221 bool already_title = false;
2222 std::ostringstream ftnote;
2227 while (par != endpar) {
2228 LyXLayout const & layout =
2229 textclasslist.Style(params.textclass,
2232 if (layout.intitle) {
2233 if (already_title) {
2234 lyxerr <<"Error in latexParagraphs: You"
2235 " should not mix title layouts"
2236 " with normal ones." << endl;
2239 } else if (was_title && !already_title) {
2240 ofs << "\\maketitle\n";
2242 already_title = true;
2245 // We are at depth 0 so we can just use
2246 // ordinary \footnote{} generation
2247 // flag this with ftcount
2249 if (layout.isEnvironment()) {
2250 par = par->TeXEnvironment(this, params, ofs, texrow);
2252 par = par->TeXOnePar(this, params, ofs, texrow, false);
2255 // Write out what we've generated...
2258 ofs << "\\addtocounter{footnote}{-"
2262 ofs << ftnote.str();
2263 texrow += ft_texrow;
2265 // The extra .c_str() is needed when we use
2266 // lyxstring instead of the STL string class.
2267 ftnote.str(string().c_str());
2272 // It might be that we only have a title in this document
2273 if (was_title && !already_title) {
2274 ofs << "\\maketitle\n";
2280 bool Buffer::isLatex() const
2282 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2286 bool Buffer::isLinuxDoc() const
2288 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2292 bool Buffer::isLiterate() const
2294 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2298 bool Buffer::isDocBook() const
2300 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2304 bool Buffer::isSGML() const
2306 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2307 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2311 void Buffer::sgmlOpenTag(ostream & os, int depth,
2312 string const & latexname) const
2314 if (!latexname.empty() && latexname != "!-- --")
2315 os << string(depth, ' ') << "<" << latexname << ">\n";
2319 void Buffer::sgmlCloseTag(ostream & os, int depth,
2320 string const & latexname) const
2322 if (!latexname.empty() && latexname != "!-- --")
2323 os << string(depth, ' ') << "</" << latexname << ">\n";
2327 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2329 ofstream ofs(fname.c_str());
2332 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2336 niceFile = nice; // this will be used by included files.
2338 LyXTextClass const & tclass =
2339 textclasslist.TextClass(params.textclass);
2341 LaTeXFeatures features(params, tclass.numLayouts());
2346 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2349 string sgml_includedfiles=features.getIncludedFiles(fname);
2351 if (params.preamble.empty() && sgml_includedfiles.empty()) {
2352 ofs << "<!doctype linuxdoc system>\n\n";
2354 ofs << "<!doctype linuxdoc system [ "
2355 << params.preamble << sgml_includedfiles << " \n]>\n\n";
2358 if (params.options.empty())
2359 sgmlOpenTag(ofs, 0, top_element);
2361 string top = top_element;
2363 top += params.options;
2364 sgmlOpenTag(ofs, 0, top);
2368 ofs << "<!-- " << LYX_DOCVERSION
2369 << " created this file. For more info see http://www.lyx.org/"
2372 int depth = 0; // paragraph depth
2373 LyXParagraph * par = paragraph;
2375 vector<string> environment_stack(5);
2378 LyXLayout const & style =
2379 textclasslist.Style(params.textclass,
2382 // treat <toc> as a special case for compatibility with old code
2383 if (par->GetChar(0) == LyXParagraph::META_INSET) {
2384 Inset * inset = par->GetInset(0);
2385 Inset::Code lyx_code = inset->LyxCode();
2386 if (lyx_code == Inset::TOC_CODE){
2387 string const temp = "toc";
2388 sgmlOpenTag(ofs, depth, temp);
2395 // environment tag closing
2396 for (; depth > par->params.depth(); --depth) {
2397 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2398 environment_stack[depth].erase();
2401 // write opening SGML tags
2402 switch (style.latextype) {
2403 case LATEX_PARAGRAPH:
2404 if (depth == par->params.depth()
2405 && !environment_stack[depth].empty()) {
2406 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2407 environment_stack[depth].erase();
2413 sgmlOpenTag(ofs, depth, style.latexname());
2418 LinuxDocError(par, 0,
2419 _("Error : Wrong depth for"
2420 " LatexType Command.\n"));
2422 if (!environment_stack[depth].empty()){
2423 sgmlCloseTag(ofs, depth,
2424 environment_stack[depth]);
2428 environment_stack[depth].erase();
2429 sgmlOpenTag(ofs, depth, style.latexname());
2432 case LATEX_ENVIRONMENT:
2433 case LATEX_ITEM_ENVIRONMENT:
2434 if (depth == par->params.depth()
2435 && environment_stack[depth] != style.latexname()) {
2436 sgmlCloseTag(ofs, depth,
2437 environment_stack[depth]);
2438 environment_stack[depth].erase();
2440 if (depth < par->params.depth()) {
2441 depth = par->params.depth();
2442 environment_stack[depth].erase();
2444 if (environment_stack[depth] != style.latexname()) {
2446 sgmlOpenTag(ofs, depth, "p");
2448 sgmlOpenTag(ofs, depth, style.latexname());
2450 if (environment_stack.size() == depth + 1)
2451 environment_stack.push_back("!-- --");
2452 environment_stack[depth] = style.latexname();
2455 if (style.latexparam() == "CDATA")
2458 if (style.latextype == LATEX_ENVIRONMENT) break;
2460 if (style.labeltype == LABEL_MANUAL)
2465 sgmlOpenTag(ofs, depth + 1, item_name);
2468 sgmlOpenTag(ofs, depth, style.latexname());
2472 SimpleLinuxDocOnePar(ofs, par, depth);
2477 // write closing SGML tags
2478 switch (style.latextype) {
2481 case LATEX_ENVIRONMENT:
2482 case LATEX_ITEM_ENVIRONMENT:
2483 if (style.latexparam() == "CDATA")
2487 sgmlCloseTag(ofs, depth, style.latexname());
2493 for (int i=depth; i >= 0; --i)
2494 sgmlCloseTag(ofs, depth, environment_stack[i]);
2498 sgmlCloseTag(ofs, 0, top_element);
2502 // How to check for successful close
2506 void Buffer::DocBookHandleCaption(ostream & os, string & inner_tag,
2507 int depth, int desc_on,
2508 LyXParagraph * & par)
2510 LyXParagraph * tpar = par;
2512 && (tpar->layout != textclasslist.NumberOfLayout(params.textclass,
2514 tpar = tpar->next();
2517 tpar->layout == textclasslist.NumberOfLayout(params.textclass,
2518 "Caption").second) {
2519 sgmlOpenTag(os, depth + 1, inner_tag);
2521 SimpleDocBookOnePar(os, extra_par, tpar,
2522 desc_on, depth + 2);
2523 sgmlCloseTag(os, depth+1, inner_tag);
2524 if (!extra_par.empty())
2530 // checks, if newcol chars should be put into this line
2531 // writes newline, if necessary.
2534 void linux_doc_line_break(ostream & os, string::size_type & colcount,
2535 string::size_type newcol)
2538 if (colcount > lyxrc.ascii_linelen) {
2540 colcount = newcol; // assume write after this call
2555 string tag_name(PAR_TAG const & pt) {
2557 case NONE: return "!-- --";
2558 case TT: return "tt";
2559 case SF: return "sf";
2560 case BF: return "bf";
2561 case IT: return "it";
2562 case SL: return "sl";
2563 case EM: return "em";
2570 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2572 p1 = static_cast<PAR_TAG>(p1 | p2);
2577 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2579 p1 = static_cast<PAR_TAG>( p1 & ~p2);
2587 // Handle internal paragraph parsing -- layout already processed.
2588 void Buffer::SimpleLinuxDocOnePar(ostream & os,
2589 LyXParagraph * par, int /*depth*/)
2591 LyXLayout const & style = textclasslist.Style(params.textclass,
2593 string::size_type char_line_count = 5; // Heuristic choice ;-)
2595 // gets paragraph main font
2598 if (style.labeltype == LABEL_MANUAL) {
2599 font_old = style.labelfont;
2602 font_old = style.font;
2606 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2607 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2608 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2611 stack < PAR_TAG > tag_state;
2612 // parsing main loop
2613 for (LyXParagraph::size_type i = 0; i < par->size(); ++i) {
2615 PAR_TAG tag_close = NONE;
2616 list < PAR_TAG > tag_open;
2618 LyXFont const font = par->getFont(params, i);
2620 if (font_old.family() != font.family()) {
2621 switch (family_type) {
2622 case LyXFont::SANS_FAMILY:
2625 case LyXFont::TYPEWRITER_FAMILY:
2632 family_type = font.family();
2634 switch (family_type) {
2635 case LyXFont::SANS_FAMILY:
2636 tag_open.push_back(SF);
2638 case LyXFont::TYPEWRITER_FAMILY:
2639 tag_open.push_back(TT);
2646 if (font_old.series() != font.series()) {
2647 switch (series_type) {
2648 case LyXFont::BOLD_SERIES:
2655 series_type = font.series();
2657 switch (series_type) {
2658 case LyXFont::BOLD_SERIES:
2659 tag_open.push_back(BF);
2667 if (font_old.shape() != font.shape()) {
2668 switch (shape_type) {
2669 case LyXFont::ITALIC_SHAPE:
2672 case LyXFont::SLANTED_SHAPE:
2679 shape_type = font.shape();
2681 switch (shape_type) {
2682 case LyXFont::ITALIC_SHAPE:
2683 tag_open.push_back(IT);
2685 case LyXFont::SLANTED_SHAPE:
2686 tag_open.push_back(SL);
2693 if (font_old.emph() != font.emph()) {
2694 if (font.emph() == LyXFont::ON) {
2695 tag_open.push_back(EM);
2704 list < PAR_TAG > temp;
2705 while(!tag_state.empty() && tag_close ) {
2706 PAR_TAG k = tag_state.top();
2708 os << "</" << tag_name(k) << ">";
2715 for(list< PAR_TAG >::const_iterator j = temp.begin();
2716 j != temp.end(); ++j) {
2718 os << "<" << tag_name(*j) << ">";
2721 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2722 j != tag_open.end(); ++j) {
2724 os << "<" << tag_name(*j) << ">";
2727 char c = par->GetChar(i);
2729 if (c == LyXParagraph::META_INSET) {
2730 Inset * inset = par->GetInset(i);
2731 inset->Linuxdoc(this, os);
2736 if (font.latex() == LyXFont::ON || style.latexparam() == "CDATA") {
2737 // "TeX"-Mode on == > SGML-Mode on.
2743 if (par->linuxDocConvertChar(c, sgml_string)
2744 && !style.free_spacing) {
2745 // in freespacing mode, spaces are
2746 // non-breaking characters
2747 if (desc_on) {// if char is ' ' then...
2750 linux_doc_line_break(os, char_line_count, 6);
2754 linux_doc_line_break(os, char_line_count, 1);
2759 char_line_count += sgml_string.length();
2765 while (!tag_state.empty()) {
2766 os << "</" << tag_name(tag_state.top()) << ">";
2770 // resets description flag correctly
2772 // <tag> not closed...
2773 linux_doc_line_break(os, char_line_count, 6);
2779 // Print an error message.
2780 void Buffer::LinuxDocError(LyXParagraph * par, int pos,
2781 string const & message)
2783 // insert an error marker in text
2784 InsetError * new_inset = new InsetError(message);
2785 par->InsertInset(pos, new_inset);
2789 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2791 ofstream ofs(fname.c_str());
2793 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2797 LyXParagraph * par = paragraph;
2799 niceFile = nice; // this will be used by Insetincludes.
2801 LyXTextClass const & tclass =
2802 textclasslist.TextClass(params.textclass);
2804 LaTeXFeatures features(params, tclass.numLayouts());
2809 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2812 string sgml_includedfiles = features.getIncludedFiles(fname);
2814 ofs << "<!doctype " << top_element
2815 << " public \"-//OASIS//DTD DocBook V3.1//EN\"";
2817 if (params.preamble.empty() && sgml_includedfiles.empty())
2820 ofs << "\n [ " << params.preamble
2821 << sgml_includedfiles << " \n]>\n\n";
2824 string top = top_element;
2826 top += params.language->code();
2829 if (!params.options.empty()) {
2831 top += params.options;
2833 sgmlOpenTag(ofs, 0, top);
2835 ofs << "<!-- DocBook file was created by " << LYX_DOCVERSION
2836 << "\n See http://www.lyx.org/ for more information -->\n";
2838 vector<string> environment_stack(10);
2839 vector<string> environment_inner(10);
2840 vector<string> command_stack(10);
2842 bool command_flag = false;
2843 int command_depth = 0;
2844 int command_base = 0;
2846 int depth = 0; // paragraph depth
2849 string command_name;
2855 int desc_on = 0; // description mode
2857 LyXLayout const & style =
2858 textclasslist.Style(params.textclass,
2861 // environment tag closing
2862 for (; depth > par->params.depth(); --depth) {
2863 if (environment_inner[depth] != "!-- --") {
2864 item_name = "listitem";
2865 sgmlCloseTag(ofs, command_depth + depth,
2867 if (environment_inner[depth] == "varlistentry")
2868 sgmlCloseTag(ofs, depth+command_depth,
2869 environment_inner[depth]);
2871 sgmlCloseTag(ofs, depth + command_depth,
2872 environment_stack[depth]);
2873 environment_stack[depth].erase();
2874 environment_inner[depth].erase();
2877 if (depth == par->params.depth()
2878 && environment_stack[depth] != style.latexname()
2879 && !environment_stack[depth].empty()) {
2880 if (environment_inner[depth] != "!-- --") {
2881 item_name= "listitem";
2882 sgmlCloseTag(ofs, command_depth+depth,
2884 if (environment_inner[depth] == "varlistentry")
2886 depth + command_depth,
2887 environment_inner[depth]);
2890 sgmlCloseTag(ofs, depth + command_depth,
2891 environment_stack[depth]);
2893 environment_stack[depth].erase();
2894 environment_inner[depth].erase();
2897 // Write opening SGML tags.
2898 switch (style.latextype) {
2899 case LATEX_PARAGRAPH:
2900 sgmlOpenTag(ofs, depth + command_depth,
2906 LinuxDocError(par, 0,
2907 _("Error : Wrong depth for "
2908 "LatexType Command.\n"));
2910 command_name = style.latexname();
2912 sgmlparam = style.latexparam();
2913 c_params = split(sgmlparam, c_depth,'|');
2915 cmd_depth = lyx::atoi(c_depth);
2918 if (cmd_depth < command_base) {
2919 for (int j = command_depth; j >= command_base; --j)
2920 sgmlCloseTag(ofs, j, command_stack[j]);
2921 command_depth = command_base = cmd_depth;
2922 } else if (cmd_depth <= command_depth) {
2923 for (int j = command_depth; j >= cmd_depth; --j)
2924 sgmlCloseTag(ofs, j, command_stack[j]);
2925 command_depth = cmd_depth;
2927 command_depth = cmd_depth;
2929 command_depth = command_base = cmd_depth;
2930 command_flag = true;
2932 if (command_stack.size() == command_depth + 1)
2933 command_stack.push_back("");
2934 command_stack[command_depth] = command_name;
2936 // treat label as a special case for
2937 // more WYSIWYM handling.
2938 if (par->GetChar(0) == LyXParagraph::META_INSET) {
2939 Inset * inset = par->GetInset(0);
2940 Inset::Code lyx_code = inset->LyxCode();
2941 if (lyx_code == Inset::LABEL_CODE){
2942 command_name += " id=\"";
2943 command_name += (static_cast<InsetCommand *>(inset))->getContents();
2944 command_name += "\"";
2949 sgmlOpenTag(ofs, depth + command_depth, command_name);
2950 if (c_params.empty())
2951 item_name = "title";
2953 item_name = c_params;
2954 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
2957 case LATEX_ENVIRONMENT:
2958 case LATEX_ITEM_ENVIRONMENT:
2959 if (depth < par->params.depth()) {
2960 depth = par->params.depth();
2961 environment_stack[depth].erase();
2964 if (environment_stack[depth] != style.latexname()) {
2965 if(environment_stack.size() == depth + 1) {
2966 environment_stack.push_back("!-- --");
2967 environment_inner.push_back("!-- --");
2969 environment_stack[depth] = style.latexname();
2970 environment_inner[depth] = "!-- --";
2971 sgmlOpenTag(ofs, depth + command_depth,
2972 environment_stack[depth]);
2974 if (environment_inner[depth] != "!-- --") {
2975 item_name= "listitem";
2977 command_depth + depth,
2979 if (environment_inner[depth] == "varlistentry")
2981 depth + command_depth,
2982 environment_inner[depth]);
2986 if (style.latextype == LATEX_ENVIRONMENT) {
2987 if (!style.latexparam().empty()) {
2988 if(style.latexparam() == "CDATA")
2991 sgmlOpenTag(ofs, depth + command_depth,
2992 style.latexparam());
2997 desc_on = (style.labeltype == LABEL_MANUAL);
3000 environment_inner[depth]= "varlistentry";
3002 environment_inner[depth]= "listitem";
3004 sgmlOpenTag(ofs, depth + 1 + command_depth,
3005 environment_inner[depth]);
3009 sgmlOpenTag(ofs, depth + 1 + command_depth,
3013 sgmlOpenTag(ofs, depth + 1 + command_depth,
3018 sgmlOpenTag(ofs, depth + command_depth,
3024 SimpleDocBookOnePar(ofs, extra_par, par, desc_on,
3025 depth + 1 + command_depth);
3029 // write closing SGML tags
3030 switch (style.latextype) {
3032 if (c_params.empty())
3036 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3038 case LATEX_ENVIRONMENT:
3039 if (!style.latexparam().empty()) {
3040 if(style.latexparam() == "CDATA")
3043 sgmlCloseTag(ofs, depth + command_depth,
3044 style.latexparam());
3047 case LATEX_ITEM_ENVIRONMENT:
3048 if (desc_on == 1) break;
3050 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3052 case LATEX_PARAGRAPH:
3053 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3056 sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3062 for (; depth >= 0; --depth) {
3063 if (!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")
3069 sgmlCloseTag(ofs, depth + command_depth,
3070 environment_inner[depth]);
3073 sgmlCloseTag(ofs, depth + command_depth,
3074 environment_stack[depth]);
3078 for (int j = command_depth; j >= command_base; --j)
3079 if (!command_stack[j].empty())
3080 sgmlCloseTag(ofs, j, command_stack[j]);
3083 sgmlCloseTag(ofs, 0, top_element);
3086 // How to check for successful close
3090 void Buffer::SimpleDocBookOnePar(ostream & os, string & extra,
3091 LyXParagraph * par, int & desc_on,
3094 bool emph_flag = false;
3096 LyXLayout const & style = textclasslist.Style(params.textclass,
3099 LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3101 int char_line_count = depth;
3102 if (!style.free_spacing)
3103 os << string(depth,' ');
3105 // parsing main loop
3106 for (LyXParagraph::size_type i = 0;
3107 i < par->size(); ++i) {
3108 LyXFont font = par->getFont(params, i);
3110 // handle <emphasis> tag
3111 if (font_old.emph() != font.emph()) {
3112 if (font.emph() == LyXFont::ON) {
3116 os << "</emphasis>";
3121 char c = par->GetChar(i);
3123 if (c == LyXParagraph::META_INSET) {
3124 Inset * inset = par->GetInset(i);
3125 std::ostringstream ost;
3126 inset->DocBook(this, ost);
3127 string tmp_out = ost.str().c_str();
3130 // This code needs some explanation:
3131 // Two insets are treated specially
3132 // label if it is the first element in a command paragraph
3134 // graphics inside tables or figure floats can't go on
3135 // title (the equivalente in latex for this case is caption
3136 // and title should come first
3139 if (desc_on!= 3 || i!= 0) {
3140 if (!tmp_out.empty() && tmp_out[0] == '@') {
3142 extra += frontStrip(tmp_out, '@');
3144 os << frontStrip(tmp_out, '@');
3149 } else if (font.latex() == LyXFont::ON) {
3150 // "TeX"-Mode on ==> SGML-Mode on.
3156 if (par->linuxDocConvertChar(c, sgml_string)
3157 && !style.free_spacing) { // in freespacing
3159 // non-breaking characters
3163 os << "\n</term><listitem><para>";
3176 os << "</emphasis>";
3179 // resets description flag correctly
3181 // <term> not closed...
3188 // This should be enabled when the Chktex class is implemented. (Asger)
3189 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3190 // Other flags: -wall -v0 -x
3191 int Buffer::runChktex()
3193 if (!users->text) return 0;
3195 ProhibitInput(users);
3197 // get LaTeX-Filename
3198 string const name = getLatexName();
3199 string path = OnlyPath(filename);
3201 string const org_path = path;
3202 if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3206 Path p(path); // path to LaTeX file
3207 users->owner()->message(_("Running chktex..."));
3209 // Remove all error insets
3210 bool const removedErrorInsets = users->removeAutoInsets();
3212 // Generate the LaTeX file if neccessary
3213 makeLaTeXFile(name, org_path, false);
3216 Chktex chktex(lyxrc.chktex_command, name, filepath);
3217 int res = chktex.run(terr); // run chktex
3220 WriteAlert(_("chktex did not work!"),
3221 _("Could not run with file:"), name);
3222 } else if (res > 0) {
3223 // Insert all errors as errors boxes
3224 users->insertErrors(terr);
3227 // if we removed error insets before we ran chktex or if we inserted
3228 // error insets after we ran chktex, this must be run:
3229 if (removedErrorInsets || res){
3231 users->fitCursor(users->text);
3239 void Buffer::validate(LaTeXFeatures & features) const
3241 LyXParagraph * par = paragraph;
3242 LyXTextClass const & tclass =
3243 textclasslist.TextClass(params.textclass);
3245 // AMS Style is at document level
3247 features.amsstyle = (params.use_amsmath ||
3248 tclass.provides(LyXTextClass::amsmath));
3251 // We don't use "lyxerr.debug" because of speed. (Asger)
3252 if (lyxerr.debugging(Debug::LATEX))
3253 lyxerr << "Paragraph: " << par << endl;
3255 // Now just follow the list of paragraphs and run
3256 // validate on each of them.
3257 par->validate(features);
3259 // and then the next paragraph
3263 // the bullet shapes are buffer level not paragraph level
3264 // so they are tested here
3265 for (int i = 0; i < 4; ++i) {
3266 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3267 int const font = params.user_defined_bullets[i].getFont();
3269 int const c = params
3270 .user_defined_bullets[i]
3277 features.latexsym = true;
3279 } else if (font == 1) {
3280 features.amssymb = true;
3281 } else if ((font >= 2 && font <= 5)) {
3282 features.pifont = true;
3287 if (lyxerr.debugging(Debug::LATEX)) {
3288 features.showStruct();
3293 void Buffer::setPaperStuff()
3295 params.papersize = BufferParams::PAPER_DEFAULT;
3296 char const c1 = params.paperpackage;
3297 if (c1 == BufferParams::PACKAGE_NONE) {
3298 char const c2 = params.papersize2;
3299 if (c2 == BufferParams::VM_PAPER_USLETTER)
3300 params.papersize = BufferParams::PAPER_USLETTER;
3301 else if (c2 == BufferParams::VM_PAPER_USLEGAL)
3302 params.papersize = BufferParams::PAPER_LEGALPAPER;
3303 else if (c2 == BufferParams::VM_PAPER_USEXECUTIVE)
3304 params.papersize = BufferParams::PAPER_EXECUTIVEPAPER;
3305 else if (c2 == BufferParams::VM_PAPER_A3)
3306 params.papersize = BufferParams::PAPER_A3PAPER;
3307 else if (c2 == BufferParams::VM_PAPER_A4)
3308 params.papersize = BufferParams::PAPER_A4PAPER;
3309 else if (c2 == BufferParams::VM_PAPER_A5)
3310 params.papersize = BufferParams::PAPER_A5PAPER;
3311 else if ((c2 == BufferParams::VM_PAPER_B3) || (c2 == BufferParams::VM_PAPER_B4) ||
3312 (c2 == BufferParams::VM_PAPER_B5))
3313 params.papersize = BufferParams::PAPER_B5PAPER;
3314 } else if ((c1 == BufferParams::PACKAGE_A4) || (c1 == BufferParams::PACKAGE_A4WIDE) ||
3315 (c1 == BufferParams::PACKAGE_WIDEMARGINSA4))
3316 params.papersize = BufferParams::PAPER_A4PAPER;
3320 // This function should be in Buffer because it's a buffer's property (ale)
3321 string const Buffer::getIncludeonlyList(char delim)
3324 for (inset_iterator it = inset_iterator_begin();
3325 it != inset_iterator_end(); ++it) {
3326 if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3327 InsetInclude * insetinc =
3328 static_cast<InsetInclude *>(*it);
3329 if (insetinc->isIncludeOnly()) {
3332 lst += insetinc->getRelFileBaseName();
3336 lyxerr.debug() << "Includeonly(" << lst << ')' << endl;
3341 vector<string> const Buffer::getLabelList()
3343 /// if this is a child document and the parent is already loaded
3344 /// Use the parent's list instead [ale990407]
3345 if (!params.parentname.empty()
3346 && bufferlist.exists(params.parentname)) {
3347 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3349 return tmp->getLabelList();
3352 vector<string> label_list;
3353 for (inset_iterator it = inset_iterator_begin();
3354 it != inset_iterator_end(); ++it) {
3355 vector<string> const l = (*it)->getLabelList();
3356 label_list.insert(label_list.end(), l.begin(), l.end());
3362 Buffer::Lists const Buffer::getLists() const
3365 LyXParagraph * par = paragraph;
3367 LyXTextClassList::size_type cap;
3368 boost::tie(found, cap) = textclasslist
3369 .NumberOfLayout(params.textclass, "Caption");
3372 char const labeltype =
3373 textclasslist.Style(params.textclass,
3374 par->GetLayout()).labeltype;
3376 if (labeltype >= LABEL_COUNTER_CHAPTER
3377 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3378 // insert this into the table of contents
3379 SingleList & item = l["TOC"];
3382 textclasslist.TextClass(params.textclass).maxcounter());
3383 item.push_back(TocItem(par, depth, par->String(this, true)));
3385 // For each paragrph, traverse its insets and look for
3389 LyXParagraph::inset_iterator it =
3390 par->inset_iterator_begin();
3391 LyXParagraph::inset_iterator end =
3392 par->inset_iterator_end();
3394 for (; it != end; ++it) {
3395 if ((*it)->LyxCode() == Inset::FLOAT_CODE) {
3397 static_cast<InsetFloat*>(*it);
3399 string const type = il->type();
3401 // Now find the caption in the float...
3402 // We now tranverse the paragraphs of
3404 LyXParagraph * tmp = il->inset.par;
3406 if (tmp->layout == cap) {
3407 SingleList & item = l[type];
3409 tostr(item.size()+1) + ". " + tmp->String(this, false);
3410 item.push_back(TocItem(tmp, 0 , str));
3417 lyxerr << "caption not found" << endl;
3426 // This is also a buffer property (ale)
3427 vector<pair<string, string> > const Buffer::getBibkeyList()
3429 /// if this is a child document and the parent is already loaded
3430 /// Use the parent's list instead [ale990412]
3431 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3432 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3434 return tmp->getBibkeyList();
3437 vector<pair<string, string> > keys;
3438 LyXParagraph * par = paragraph;
3441 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3442 par->String(this, false)));
3446 // Might be either using bibtex or a child has bibliography
3448 for (inset_iterator it = inset_iterator_begin();
3449 it != inset_iterator_end(); ++it) {
3450 // Search for Bibtex or Include inset
3451 if ((*it)->LyxCode() == Inset::BIBTEX_CODE) {
3452 vector<pair<string,string> > tmp =
3453 static_cast<InsetBibtex*>(*it)->getKeys(this);
3454 keys.insert(keys.end(), tmp.begin(), tmp.end());
3455 } else if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3456 vector<pair<string,string> > const tmp =
3457 static_cast<InsetInclude*>(*it)->getKeys();
3458 keys.insert(keys.end(), tmp.begin(), tmp.end());
3467 bool Buffer::isDepClean(string const & name) const
3469 DEPCLEAN * item = dep_clean;
3470 while (item && item->master != name)
3472 if (!item) return true;
3477 void Buffer::markDepClean(string const & name)
3480 dep_clean = new DEPCLEAN;
3481 dep_clean->clean = true;
3482 dep_clean->master = name;
3483 dep_clean->next = 0;
3485 DEPCLEAN * item = dep_clean;
3486 while (item && item->master != name)
3491 item = new DEPCLEAN;
3493 item->master = name;
3500 bool Buffer::Dispatch(string const & command)
3502 // Split command string into command and argument
3504 string line = frontStrip(command);
3505 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3507 return Dispatch(lyxaction.LookupFunc(cmd), arg);
3511 bool Buffer::Dispatch(int action, string const & argument)
3513 bool dispatched = true;
3516 Exporter::Export(this, argument, false);
3526 void Buffer::resize()
3528 /// resize the BufferViews!
3534 void Buffer::resizeInsets(BufferView * bv)
3536 /// then remove all LyXText in text-insets
3537 LyXParagraph * par = paragraph;
3538 for (; par; par = par->next()) {
3539 par->resizeInsetsLyXText(bv);
3544 void Buffer::ChangeLanguage(Language const * from, Language const * to)
3547 LyXParagraph * par = paragraph;
3549 par->ChangeLanguage(params, from, to);
3555 bool Buffer::isMultiLingual()
3557 LyXParagraph * par = paragraph;
3559 if (par->isMultiLingual(params))
3567 Buffer::inset_iterator::inset_iterator(LyXParagraph * paragraph,
3568 LyXParagraph::size_type pos)
3571 it = par->InsetIterator(pos);
3572 if (it == par->inset_iterator_end()) {
3579 void Buffer::inset_iterator::SetParagraph()
3582 it = par->inset_iterator_begin();
3583 if (it != par->inset_iterator_end())
3588 // We maintain an invariant that whenever par = 0 then it = 0