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 * ======================================================
22 #include <sys/types.h>
32 #pragma implementation "buffer.h"
36 #include "bufferlist.h"
38 #include "lyx_gui_misc.h"
39 #include "LyXAction.h"
42 #include "tex-strings.h"
44 #include "bufferview_funcs.h"
45 #include "minibuffer.h"
48 #include "mathed/formulamacro.h"
49 #include "insets/lyxinset.h"
50 #include "insets/inseterror.h"
51 #include "insets/insetlabel.h"
52 #include "insets/insetref.h"
53 #include "insets/inseturl.h"
54 #include "insets/insetinfo.h"
55 #include "insets/insetquotes.h"
56 #include "insets/insetlatexaccent.h"
57 #include "insets/insetbib.h"
58 #include "insets/insetcite.h"
59 #include "insets/insetexternal.h"
60 #include "insets/insetindex.h"
61 #include "insets/insetinclude.h"
62 #include "insets/insettoc.h"
63 #include "insets/insetparent.h"
64 #include "insets/insetspecialchar.h"
65 #include "insets/figinset.h"
66 #include "insets/insettext.h"
67 #include "insets/insetert.h"
68 #include "insets/insetgraphics.h"
69 #include "insets/insetfoot.h"
70 #include "insets/insetmarginal.h"
71 #include "insets/insetminipage.h"
72 #include "insets/insetfloat.h"
73 #include "insets/insetlist.h"
74 #include "insets/insettabular.h"
75 #include "insets/insettheorem.h"
76 #include "insets/insetcaption.h"
77 #include "support/filetools.h"
78 #include "support/path.h"
83 #include "LaTeXFeatures.h"
84 #include "support/syscall.h"
85 #include "support/lyxlib.h"
86 #include "support/FileInfo.h"
90 #include "lyx_gui_misc.h" // WarnReadonly()
91 #include "frontends/Dialogs.h"
107 using std::istringstream;
109 // all these externs should eventually be removed.
110 extern BufferList bufferlist;
112 extern LyXAction lyxaction;
115 static const float LYX_FORMAT = 2.17;
117 extern int tex_code_break_column;
120 Buffer::Buffer(string const & file, bool ronly)
122 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
124 filepath = OnlyPath(file);
133 if (read_only || (lyxrc.use_tempdir)) {
134 tmppath = CreateBufferTmpDir();
135 } else tmppath.erase();
141 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
142 // here the buffer should take care that it is
143 // saved properly, before it goes into the void.
145 // make sure that views using this buffer
150 if (!tmppath.empty()) {
151 DestroyBufferTmpDir(tmppath);
154 LyXParagraph * par = paragraph;
155 LyXParagraph * tmppar;
165 string const Buffer::getLatexName(bool no_path) const
168 return OnlyFilename(ChangeExtension(MakeLatexName(filename),
171 return ChangeExtension(MakeLatexName(filename),
176 void Buffer::setReadonly(bool flag)
178 if (read_only != flag) {
181 users->owner()->getDialogs()->updateBufferDependent();
184 WarnReadonly(filename);
189 bool Buffer::saveParamsAsDefaults() // const
191 string const fname = AddName(AddPath(user_lyxdir, "templates/"),
193 Buffer defaults = Buffer(fname);
195 // Use the current buffer's parameters as default
196 defaults.params = params;
198 // add an empty paragraph. Is this enough?
199 defaults.paragraph = new LyXParagraph;
201 return defaults.writeFile(defaults.filename, false);
205 /// Update window titles of all users
206 // Should work on a list
207 void Buffer::updateTitles() const
209 if (users) users->owner()->updateWindowTitle();
213 /// Reset autosave timer of all users
214 // Should work on a list
215 void Buffer::resetAutosaveTimers() const
217 if (users) users->owner()->resetAutosaveTimer();
221 void Buffer::fileName(string const & newfile)
223 filename = MakeAbsPath(newfile);
224 filepath = OnlyPath(filename);
225 setReadonly(IsFileWriteable(filename) == 0);
230 // candidate for move to BufferView
231 // (at least some parts in the beginning of the func)
234 // changed to be public and have one parameter
235 // if par = 0 normal behavior
236 // else insert behavior
237 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
238 bool Buffer::readLyXformat2(LyXLex & lex, LyXParagraph * par)
241 char depth = 0; // signed or unsigned?
243 LyXParagraph::footnote_flag footnoteflag = LyXParagraph::NO_FOOTNOTE;
244 LyXParagraph::footnote_kind footnotekind = LyXParagraph::FOOTNOTE;
246 bool the_end_read = false;
248 LyXParagraph * return_par = 0;
249 LyXFont font(LyXFont::ALL_INHERIT, params.language_info);
250 if (format < 2.16 && params.language == "hebrew")
251 font.setLanguage(default_language);
253 // If we are inserting, we cheat and get a token in advance
254 bool has_token = false;
258 par = new LyXParagraph;
260 users->text->BreakParagraph(users);
261 return_par = users->text->FirstParagraph();
264 // We don't want to adopt the parameters from the
265 // document we insert, so we skip until the text begins:
268 pretoken = lex.GetString();
269 if (pretoken == "\\layout") {
281 pretoken = lex.GetString();
284 if (pretoken.empty()) continue;
287 parseSingleLyXformat2Token(lex, par, return_par,
288 pretoken, pos, depth,
300 paragraph = return_par;
306 // We'll remove this later. (Lgb)
307 static string last_inset_read;
311 Buffer::parseSingleLyXformat2Token(LyXLex & lex, LyXParagraph *& par,
312 LyXParagraph *& return_par,
313 string const & token, int & pos,
314 char & depth, LyXFont & font
316 , LyXParagraph::footnote_flag & footnoteflag,
317 LyXParagraph::footnote_kind & footnotekind
321 bool the_end_read = false;
323 if (token[0] != '\\') {
324 for (string::const_iterator cit = token.begin();
325 cit != token.end(); ++cit) {
326 par->InsertChar(pos, (*cit), font);
329 } else if (token == "\\i") {
330 Inset * inset = new InsetLatexAccent;
331 inset->Read(this, lex);
332 par->InsertInset(pos, inset, font);
334 } else if (token == "\\layout") {
339 par = new LyXParagraph(par);
343 string const layoutname = lex.GetString();
344 pair<bool, LyXTextClass::LayoutList::size_type> pp
345 = textclasslist.NumberOfLayout(params.textclass,
348 par->layout = pp.second;
349 } else { // layout not found
350 // use default layout "Standard" (0)
353 // Test whether the layout is obsolete.
354 LyXLayout const & layout =
355 textclasslist.Style(params.textclass,
357 if (!layout.obsoleted_by().empty())
359 textclasslist.NumberOfLayout(params.textclass,
360 layout.obsoleted_by()).second;
362 par->footnoteflag = footnoteflag;
363 par->footnotekind = footnotekind;
366 font = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
367 if (format < 2.16 && params.language == "hebrew")
368 font.setLanguage(default_language);
370 } else if (token == "\\end_float") {
375 par = new LyXParagraph(par);
377 footnotekind = LyXParagraph::FOOTNOTE;
378 footnoteflag = LyXParagraph::NO_FOOTNOTE;
381 par->layout = LYX_DUMMY_LAYOUT;
382 font = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
383 if (format < 2.16 && params.language == "hebrew")
384 font.setLanguage(default_language);
385 } else if (token == "\\begin_float") {
386 int tmpret = lex.FindToken(string_footnotekinds);
387 if (tmpret == -1) ++tmpret;
388 if (tmpret != LYX_LAYOUT_DEFAULT)
389 footnotekind = static_cast<LyXParagraph::footnote_kind>(tmpret); // bad
390 if (footnotekind == LyXParagraph::FOOTNOTE
391 || footnotekind == LyXParagraph::MARGIN)
392 footnoteflag = LyXParagraph::CLOSED_FOOTNOTE;
394 footnoteflag = LyXParagraph::OPEN_FOOTNOTE;
396 } else if (token == "\\begin_float") {
397 // This is the compability reader, unfinished but tested.
400 string const tmptok = lex.GetString();
401 //lyxerr << "old float: " << tmptok << endl;
406 if (tmptok == "footnote") {
407 inset = new InsetFoot;
408 } else if (tmptok == "margin") {
409 inset = new InsetMarginal;
410 } else if (tmptok == "fig") {
411 inset = new InsetFloat("figure");
412 old_float += "placement htbp\n";
413 } else if (tmptok == "tab") {
414 inset = new InsetFloat("table");
415 old_float += "placement htbp\n";
416 } else if (tmptok == "alg") {
417 inset = new InsetFloat("algorithm");
418 old_float += "placement htbp\n";
419 } else if (tmptok == "wide-fig") {
420 InsetFloat * tmp = new InsetFloat("figure");
423 old_float += "placement htbp\n";
424 } else if (tmptok == "wide-tab") {
425 InsetFloat * tmp = new InsetFloat("table");
428 old_float += "placement htbp\n";
431 if (!inset) return false; // no end read yet
433 old_float += "collapsed true\n";
435 // Here we need to check for \end_deeper and handle that
436 // before we do the footnote parsing.
437 // This _is_ a hack! (Lgb)
440 string const tmp = lex.GetString();
441 if (tmp == "\\end_deeper") {
442 lyxerr << "\\end_deeper caught!" << endl;
444 lex.printError("\\end_deeper: "
445 "depth is already null");
456 old_float += lex.getLongString("\\end_float");
457 old_float += "\n\\end_inset\n";
458 //lyxerr << "float body: " << old_float << endl;
460 istringstream istr(old_float);
463 nylex.setStream(istr);
465 inset->Read(this, nylex);
466 par->InsertInset(pos, inset, font);
469 } else if (token == "\\begin_deeper") {
471 } else if (token == "\\end_deeper") {
473 lex.printError("\\end_deeper: "
474 "depth is already null");
478 } else if (token == "\\begin_preamble") {
479 params.readPreamble(lex);
480 } else if (token == "\\textclass") {
482 pair<bool, LyXTextClassList::size_type> pp =
483 textclasslist.NumberOfClass(lex.GetString());
485 params.textclass = pp.second;
487 lex.printError("Unknown textclass `$$Token'");
488 params.textclass = 0;
490 if (!textclasslist.Load(params.textclass)) {
491 // if the textclass wasn't loaded properly
492 // we need to either substitute another
493 // or stop loading the file.
494 // I can substitute but I don't see how I can
495 // stop loading... ideas?? ARRae980418
496 WriteAlert(_("Textclass Loading Error!"),
497 string(_("Can't load textclass ")) +
498 textclasslist.NameOfClass(params.textclass),
499 _("-- substituting default"));
500 params.textclass = 0;
502 } else if (token == "\\options") {
504 params.options = lex.GetString();
505 } else if (token == "\\language") {
506 params.readLanguage(lex);
507 } else if (token == "\\fontencoding") {
509 } else if (token == "\\inputencoding") {
511 params.inputenc = lex.GetString();
512 } else if (token == "\\graphics") {
513 params.readGraphicsDriver(lex);
514 } else if (token == "\\fontscheme") {
516 params.fonts = lex.GetString();
517 } else if (token == "\\noindent") {
518 par->noindent = true;
519 } else if (token == "\\fill_top") {
520 par->added_space_top = VSpace(VSpace::VFILL);
521 } else if (token == "\\fill_bottom") {
522 par->added_space_bottom = VSpace(VSpace::VFILL);
523 } else if (token == "\\line_top") {
524 par->line_top = true;
525 } else if (token == "\\line_bottom") {
526 par->line_bottom = true;
527 } else if (token == "\\pagebreak_top") {
528 par->pagebreak_top = true;
529 } else if (token == "\\pagebreak_bottom") {
530 par->pagebreak_bottom = true;
531 } else if (token == "\\start_of_appendix") {
532 par->start_of_appendix = true;
533 } else if (token == "\\paragraph_separation") {
534 int tmpret = lex.FindToken(string_paragraph_separation);
535 if (tmpret == -1) ++tmpret;
536 if (tmpret != LYX_LAYOUT_DEFAULT)
537 params.paragraph_separation =
538 static_cast<BufferParams::PARSEP>(tmpret);
539 } else if (token == "\\defskip") {
541 params.defskip = VSpace(lex.GetString());
542 } else if (token == "\\epsfig") { // obsolete
543 // Indeed it is obsolete, but we HAVE to be backwards
544 // compatible until 0.14, because otherwise all figures
545 // in existing documents are irretrivably lost. (Asger)
546 params.readGraphicsDriver(lex);
547 } else if (token == "\\quotes_language") {
548 int tmpret = lex.FindToken(string_quotes_language);
549 if (tmpret == -1) ++tmpret;
550 if (tmpret != LYX_LAYOUT_DEFAULT) {
551 InsetQuotes::quote_language tmpl =
552 InsetQuotes::EnglishQ;
555 tmpl = InsetQuotes::EnglishQ;
558 tmpl = InsetQuotes::SwedishQ;
561 tmpl = InsetQuotes::GermanQ;
564 tmpl = InsetQuotes::PolishQ;
567 tmpl = InsetQuotes::FrenchQ;
570 tmpl = InsetQuotes::DanishQ;
573 params.quotes_language = tmpl;
575 } else if (token == "\\quotes_times") {
577 switch(lex.GetInteger()) {
579 params.quotes_times = InsetQuotes::SingleQ;
582 params.quotes_times = InsetQuotes::DoubleQ;
585 } else if (token == "\\papersize") {
586 int tmpret = lex.FindToken(string_papersize);
590 params.papersize2 = tmpret;
591 } else if (token == "\\paperpackage") {
592 int tmpret = lex.FindToken(string_paperpackages);
595 params.paperpackage = BufferParams::PACKAGE_NONE;
597 params.paperpackage = tmpret;
598 } else if (token == "\\use_geometry") {
600 params.use_geometry = lex.GetInteger();
601 } else if (token == "\\use_amsmath") {
603 params.use_amsmath = lex.GetInteger();
604 } else if (token == "\\paperorientation") {
605 int tmpret = lex.FindToken(string_orientation);
606 if (tmpret == -1) ++tmpret;
607 if (tmpret != LYX_LAYOUT_DEFAULT)
608 params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
609 } else if (token == "\\paperwidth") {
611 params.paperwidth = lex.GetString();
612 } else if (token == "\\paperheight") {
614 params.paperheight = lex.GetString();
615 } else if (token == "\\leftmargin") {
617 params.leftmargin = lex.GetString();
618 } else if (token == "\\topmargin") {
620 params.topmargin = lex.GetString();
621 } else if (token == "\\rightmargin") {
623 params.rightmargin = lex.GetString();
624 } else if (token == "\\bottommargin") {
626 params.bottommargin = lex.GetString();
627 } else if (token == "\\headheight") {
629 params.headheight = lex.GetString();
630 } else if (token == "\\headsep") {
632 params.headsep = lex.GetString();
633 } else if (token == "\\footskip") {
635 params.footskip = lex.GetString();
636 } else if (token == "\\paperfontsize") {
638 params.fontsize = strip(lex.GetString());
639 } else if (token == "\\papercolumns") {
641 params.columns = lex.GetInteger();
642 } else if (token == "\\papersides") {
644 switch(lex.GetInteger()) {
646 case 1: params.sides = LyXTextClass::OneSide; break;
647 case 2: params.sides = LyXTextClass::TwoSides; break;
649 } else if (token == "\\paperpagestyle") {
651 params.pagestyle = strip(lex.GetString());
652 } else if (token == "\\bullet") {
654 int const index = lex.GetInteger();
656 int temp_int = lex.GetInteger();
657 params.user_defined_bullets[index].setFont(temp_int);
658 params.temp_bullets[index].setFont(temp_int);
660 temp_int = lex.GetInteger();
661 params.user_defined_bullets[index].setCharacter(temp_int);
662 params.temp_bullets[index].setCharacter(temp_int);
664 temp_int = lex.GetInteger();
665 params.user_defined_bullets[index].setSize(temp_int);
666 params.temp_bullets[index].setSize(temp_int);
668 string const temp_str = lex.GetString();
669 if (temp_str != "\\end_bullet") {
670 // this element isn't really necessary for
671 // parsing but is easier for humans
672 // to understand bullets. Put it back and
673 // set a debug message?
674 lex.printError("\\end_bullet expected, got" + temp_str);
675 //how can I put it back?
677 } else if (token == "\\bulletLaTeX") {
679 int const index = lex.GetInteger();
681 string temp_str = lex.GetString();
683 while (temp_str != "\\end_bullet") {
684 // this loop structure is needed when user
685 // enters an empty string since the first
686 // thing returned will be the \\end_bullet
688 // if the LaTeX entry has spaces. Each element
689 // therefore needs to be read in turn
692 temp_str = lex.GetString();
694 params.user_defined_bullets[index].setText(sum_str);
695 params.temp_bullets[index].setText(sum_str);
696 } else if (token == "\\secnumdepth") {
698 params.secnumdepth = lex.GetInteger();
699 } else if (token == "\\tocdepth") {
701 params.tocdepth = lex.GetInteger();
702 } else if (token == "\\spacing") {
704 string const tmp = strip(lex.GetString());
705 Spacing::Space tmp_space = Spacing::Default;
707 if (tmp == "single") {
708 tmp_space = Spacing::Single;
709 } else if (tmp == "onehalf") {
710 tmp_space = Spacing::Onehalf;
711 } else if (tmp == "double") {
712 tmp_space = Spacing::Double;
713 } else if (tmp == "other") {
715 tmp_space = Spacing::Other;
716 tmp_val = lex.GetFloat();
718 lex.printError("Unknown spacing token: '$$Token'");
720 // Small hack so that files written with klyx will be
723 par->spacing.set(tmp_space, tmp_val);
725 params.spacing.set(tmp_space, tmp_val);
727 } else if (token == "\\paragraph_spacing") {
729 string const tmp = strip(lex.GetString());
730 if (tmp == "single") {
731 par->spacing.set(Spacing::Single);
732 } else if (tmp == "onehalf") {
733 par->spacing.set(Spacing::Onehalf);
734 } else if (tmp == "double") {
735 par->spacing.set(Spacing::Double);
736 } else if (tmp == "other") {
738 par->spacing.set(Spacing::Other,
741 lex.printError("Unknown spacing token: '$$Token'");
743 } else if (token == "\\float_placement") {
745 params.float_placement = lex.GetString();
746 } else if (token == "\\family") {
748 font.setLyXFamily(lex.GetString());
749 } else if (token == "\\series") {
751 font.setLyXSeries(lex.GetString());
752 } else if (token == "\\shape") {
754 font.setLyXShape(lex.GetString());
755 } else if (token == "\\size") {
757 font.setLyXSize(lex.GetString());
758 } else if (token == "\\latex") {
760 string const tok = lex.GetString();
761 // This is dirty, but gone with LyX3. (Asger)
762 if (tok == "no_latex")
763 font.setLatex(LyXFont::OFF);
764 else if (tok == "latex")
765 font.setLatex(LyXFont::ON);
766 else if (tok == "default")
767 font.setLatex(LyXFont::INHERIT);
769 lex.printError("Unknown LaTeX font flag "
771 } else if (token == "\\lang") {
773 string const tok = lex.GetString();
774 Languages::iterator lit = languages.find(tok);
775 if (lit != languages.end()) {
776 font.setLanguage(&(*lit).second);
778 font.setLanguage(params.language_info);
779 lex.printError("Unknown language `$$Token'");
781 } else if (token == "\\numeric") {
783 font.setNumber(font.setLyXMisc(lex.GetString()));
784 } else if (token == "\\emph") {
786 font.setEmph(font.setLyXMisc(lex.GetString()));
787 } else if (token == "\\bar") {
789 string const tok = lex.GetString();
790 // This is dirty, but gone with LyX3. (Asger)
792 font.setUnderbar(LyXFont::ON);
793 else if (tok == "no")
794 font.setUnderbar(LyXFont::OFF);
795 else if (tok == "default")
796 font.setUnderbar(LyXFont::INHERIT);
798 lex.printError("Unknown bar font flag "
800 } else if (token == "\\noun") {
802 font.setNoun(font.setLyXMisc(lex.GetString()));
803 } else if (token == "\\color") {
805 font.setLyXColor(lex.GetString());
806 } else if (token == "\\align") {
807 int tmpret = lex.FindToken(string_align);
808 if (tmpret == -1) ++tmpret;
809 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
811 for (; tmpret > 0; --tmpret)
812 tmpret2 = tmpret2 * 2;
813 par->align = LyXAlignment(tmpret2);
815 } else if (token == "\\added_space_top") {
817 par->added_space_top = VSpace(lex.GetString());
818 } else if (token == "\\added_space_bottom") {
820 par->added_space_bottom = VSpace(lex.GetString());
821 } else if (token == "\\pextra_type") {
823 par->pextra_type = lex.GetInteger();
824 } else if (token == "\\pextra_width") {
826 par->pextra_width = lex.GetString();
827 } else if (token == "\\pextra_widthp") {
829 par->pextra_widthp = lex.GetString();
830 } else if (token == "\\pextra_alignment") {
832 par->pextra_alignment = lex.GetInteger();
833 } else if (token == "\\pextra_hfill") {
835 par->pextra_hfill = lex.GetInteger();
836 } else if (token == "\\pextra_start_minipage") {
838 par->pextra_start_minipage = lex.GetInteger();
839 } else if (token == "\\labelwidthstring") {
841 par->labelwidthstring = lex.GetString();
842 // do not delete this token, it is still needed!
843 } else if (token == "\\end_inset") {
844 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
845 << "Last inset read was: " << last_inset_read
847 // Simply ignore this. The insets do not have
849 // But insets should read it, it is a part of
850 // the inset isn't it? Lgb.
851 } else if (token == "\\begin_inset") {
852 readInset(lex, par, pos, font);
853 } else if (token == "\\SpecialChar") {
854 LyXLayout const & layout =
855 textclasslist.Style(params.textclass,
858 // Insets don't make sense in a free-spacing context! ---Kayvan
859 if (layout.free_spacing) {
862 string next_token = lex.GetString();
863 if (next_token == "\\-") {
864 par->InsertChar(pos, '-', font);
865 } else if (next_token == "\\protected_separator"
866 || next_token == "~") {
867 par->InsertChar(pos, ' ', font);
869 lex.printError("Token `$$Token' "
871 "paragraph layout!");
876 Inset * inset = new InsetSpecialChar;
877 inset->Read(this, lex);
878 par->InsertInset(pos, inset, font);
881 } else if (token == "\\newline") {
882 par->InsertChar(pos, LyXParagraph::META_NEWLINE, font);
884 } else if (token == "\\LyXTable") {
885 Inset * inset = new InsetTabular(this);
886 inset->Read(this, lex);
887 par->InsertInset(pos, inset, font);
889 } else if (token == "\\hfill") {
890 par->InsertChar(pos, LyXParagraph::META_HFILL, font);
892 } else if (token == "\\protected_separator") { // obsolete
893 // This is a backward compability thingie. (Lgb)
894 // Remove it later some time...introduced with fileformat
896 LyXLayout const & layout =
897 textclasslist.Style(params.textclass,
900 if (layout.free_spacing) {
901 par->InsertChar(pos, ' ', font);
903 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
904 par->InsertInset(pos, inset, font);
907 } else if (token == "\\bibitem") { // ale970302
909 InsetCommandParams p( "bibitem" );
910 par->bibkey = new InsetBibKey(p);
912 par->bibkey->Read(this, lex);
913 } else if (token == "\\backslash") {
914 par->InsertChar(pos, '\\', font);
916 } else if (token == "\\the_end") {
919 // This should be insurance for the future: (Asger)
920 lex.printError("Unknown token `$$Token'. "
921 "Inserting as text.");
922 string::const_iterator cit = token.begin();
923 string::const_iterator end = token.end();
924 for(; cit != end; ++cit) {
925 par->InsertChar(pos, (*cit), font);
933 void Buffer::readInset(LyXLex & lex, LyXParagraph *& par,
934 int & pos, LyXFont & font)
937 if (lex.GetString() != "\\begin_inset") {
938 lyxerr << "Buffer::readInset: Consistency check failed."
945 string const tmptok = lex.GetString();
946 last_inset_read = tmptok;
948 // test the different insets
949 if (tmptok == "LatexCommand") {
950 InsetCommandParams inscmd;
953 if (inscmd.getCmdName() == "cite") {
954 inset = new InsetCitation(inscmd);
955 } else if (inscmd.getCmdName() == "bibitem") {
956 lex.printError("Wrong place for bibitem");
957 inset = new InsetBibKey(inscmd);
958 } else if (inscmd.getCmdName() == "BibTeX") {
959 inset = new InsetBibtex(inscmd);
960 } else if (inscmd.getCmdName() == "index") {
961 inset = new InsetIndex(inscmd);
962 } else if (inscmd.getCmdName() == "include") {
963 inset = new InsetInclude(inscmd, this);
964 } else if (inscmd.getCmdName() == "label") {
965 inset = new InsetLabel(inscmd);
966 } else if (inscmd.getCmdName() == "url"
967 || inscmd.getCmdName() == "htmlurl") {
968 inset = new InsetUrl(inscmd);
969 } else if (inscmd.getCmdName() == "ref"
970 || inscmd.getCmdName() == "pageref"
971 || inscmd.getCmdName() == "vref"
972 || inscmd.getCmdName() == "vpageref"
973 || inscmd.getCmdName() == "prettyref") {
974 if (!inscmd.getOptions().empty()
975 || !inscmd.getContents().empty()) {
976 inset = new InsetRef(inscmd);
978 } else if (inscmd.getCmdName() == "tableofcontents"
979 || inscmd.getCmdName() == "listofalgorithms"
980 || inscmd.getCmdName() == "listoffigures"
981 || inscmd.getCmdName() == "listoftables") {
982 inset = new InsetTOC(inscmd);
983 } else if (inscmd.getCmdName() == "printindex") {
984 inset = new InsetPrintIndex(inscmd);
985 } else if (inscmd.getCmdName() == "lyxparent") {
986 inset = new InsetParent(inscmd, this);
989 if (tmptok == "Quotes") {
990 inset = new InsetQuotes;
991 } else if (tmptok == "External") {
992 inset = new InsetExternal;
993 } else if (tmptok == "FormulaMacro") {
994 inset = new InsetFormulaMacro;
995 } else if (tmptok == "Formula") {
996 inset = new InsetFormula;
997 } else if (tmptok == "Figure") {
998 inset = new InsetFig(100, 100, this);
999 } else if (tmptok == "Info") {
1000 inset = new InsetInfo;
1001 } else if (tmptok == "Include") {
1002 InsetCommandParams p( "Include" );
1003 inset = new InsetInclude(p, this);
1004 } else if (tmptok == "ERT") {
1005 inset = new InsetERT;
1006 } else if (tmptok == "Tabular") {
1007 inset = new InsetTabular(this);
1008 } else if (tmptok == "Text") {
1009 inset = new InsetText;
1010 } else if (tmptok == "Foot") {
1011 inset = new InsetFoot;
1012 } else if (tmptok == "Marginal") {
1013 inset = new InsetMarginal;
1014 } else if (tmptok == "Minipage") {
1015 inset = new InsetMinipage;
1016 } else if (tmptok == "Float") {
1018 string tmptok = lex.GetString();
1019 inset = new InsetFloat(tmptok);
1020 } else if (tmptok == "List") {
1021 inset = new InsetList;
1022 } else if (tmptok == "Theorem") {
1023 inset = new InsetList;
1024 } else if (tmptok == "Caption") {
1025 inset = new InsetCaption;
1026 } else if (tmptok == "GRAPHICS") {
1027 inset = new InsetGraphics;
1030 if (inset) inset->Read(this, lex);
1034 par->InsertInset(pos, inset, font);
1040 bool Buffer::readFile(LyXLex & lex, LyXParagraph * par)
1044 string const token(lex.GetString());
1045 if (token == "\\lyxformat") { // the first token _must_ be...
1047 format = lex.GetFloat();
1049 if (LYX_FORMAT - format > 0.05) {
1051 printf(_("Warning: need lyxformat %.2f but found %.2f\n"),
1052 LYX_FORMAT, format);
1054 if (format - LYX_FORMAT > 0.05) {
1055 printf(_("ERROR: need lyxformat %.2f but found %.2f\n"),
1056 LYX_FORMAT, format);
1058 bool the_end = readLyXformat2(lex, par);
1059 // Formats >= 2.13 support "\the_end" marker
1066 WriteAlert(_("Warning!"),
1067 _("Reading of document is not complete"),
1068 _("Maybe the document is truncated"));
1069 // We simulate a safe reading anyways to allow
1070 // users to take the chance... (Asger)
1074 WriteAlert(_("ERROR!"),
1075 _("Old LyX file format found. "
1076 "Use LyX 0.10.x to read this!"));
1080 } else { // "\\lyxformat" not found
1081 WriteAlert(_("ERROR!"), _("Not a LyX file!"));
1084 WriteAlert(_("ERROR!"), _("Unable to read file!"));
1090 // Should probably be moved to somewhere else: BufferView? LyXView?
1091 bool Buffer::save() const
1093 // We don't need autosaves in the immediate future. (Asger)
1094 resetAutosaveTimers();
1098 if (lyxrc.make_backup) {
1099 s = fileName() + '~';
1100 if (!lyxrc.backupdir_path.empty())
1101 s = AddName(lyxrc.backupdir_path,
1102 subst(CleanupPath(s),'/','!'));
1104 // Rename is the wrong way of making a backup,
1105 // this is the correct way.
1106 /* truss cp fil fil2:
1107 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1108 stat("LyXVC.lyx", 0xEFFFF688) = 0
1109 open("LyXVC.lyx", O_RDONLY) = 3
1110 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1111 fstat(4, 0xEFFFF508) = 0
1112 fstat(3, 0xEFFFF508) = 0
1113 read(3, " # T h i s f i l e w".., 8192) = 5579
1114 write(4, " # T h i s f i l e w".., 5579) = 5579
1115 read(3, 0xEFFFD4A0, 8192) = 0
1118 chmod("LyXVC3.lyx", 0100644) = 0
1119 lseek(0, 0, SEEK_CUR) = 46440
1123 // Should proabaly have some more error checking here.
1124 // Should be cleaned up in 0.13, at least a bit.
1125 // Doing it this way, also makes the inodes stay the same.
1126 // This is still not a very good solution, in particular we
1127 // might loose the owner of the backup.
1128 FileInfo finfo(fileName());
1129 if (finfo.exist()) {
1130 mode_t fmode = finfo.getMode();
1131 struct utimbuf times = {
1132 finfo.getAccessTime(),
1133 finfo.getModificationTime() };
1135 ifstream ifs(fileName().c_str());
1136 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1141 ::chmod(s.c_str(), fmode);
1143 if (::utime(s.c_str(), ×)) {
1144 lyxerr << "utime error." << endl;
1147 lyxerr << "LyX was not able to make "
1148 "backupcopy. Beware." << endl;
1153 if (writeFile(fileName(), false)) {
1155 removeAutosaveFile(fileName());
1157 // Saving failed, so backup is not backup
1158 if (lyxrc.make_backup) {
1159 lyx::rename(s, fileName());
1167 // Returns false if unsuccesful
1168 bool Buffer::writeFile(string const & fname, bool flag) const
1170 // if flag is false writeFile will not create any GUI
1171 // warnings, only cerr.
1172 // Needed for autosave in background or panic save (Matthias 120496)
1174 if (read_only && (fname == filename)) {
1175 // Here we should come with a question if we should
1176 // perform the write anyway.
1178 lyxerr << _("Error! Document is read-only: ")
1181 WriteAlert(_("Error! Document is read-only: "),
1186 FileInfo finfo(fname);
1187 if (finfo.exist() && !finfo.writable()) {
1188 // Here we should come with a question if we should
1189 // try to do the save anyway. (i.e. do a chmod first)
1191 lyxerr << _("Error! Cannot write file: ")
1194 WriteFSAlert(_("Error! Cannot write file: "),
1199 ofstream ofs(fname.c_str());
1202 lyxerr << _("Error! Cannot open file: ")
1205 WriteFSAlert(_("Error! Cannot open file: "),
1211 // Use the standard "C" locale for file output.
1212 ofs.imbue(std::locale::classic());
1215 // The top of the file should not be written by params.
1217 // write out a comment in the top of the file
1218 ofs << '#' << LYX_DOCVERSION
1219 << " created this file. For more info see http://www.lyx.org/\n";
1220 ofs.setf(ios::showpoint|ios::fixed);
1223 char dummy_format[512];
1224 sprintf(dummy_format, "%.2f", LYX_FORMAT);
1225 ofs << "\\lyxformat " << dummy_format << "\n";
1227 ofs << "\\lyxformat " << setw(4) << LYX_FORMAT << "\n";
1229 // now write out the buffer paramters.
1230 params.writeFile(ofs);
1232 char footnoteflag = 0;
1235 // this will write out all the paragraphs
1236 // using recursive descent.
1237 paragraph->writeFile(this, ofs, params, footnoteflag, depth);
1239 // Write marker that shows file is complete
1240 ofs << "\n\\the_end" << endl;
1242 // how to check if close went ok?
1248 void Buffer::writeFileAscii(string const & fname, int linelen)
1252 char footnoteflag = 0;
1255 LyXParagraph::size_type i;
1258 int ltype_depth = 0;
1261 int currlinelen = 0;
1263 bool ref_printed = false;
1265 ofstream ofs(fname.c_str());
1267 WriteFSAlert(_("Error: Cannot write file:"), fname);
1271 string const fname1 = TmpFileName();
1272 LyXParagraph * par = paragraph;
1278 par->footnoteflag != LyXParagraph::NO_FOOTNOTE ||
1282 || par->previous->footnoteflag == LyXParagraph::NO_FOOTNOTE
1287 /* begins a footnote environment ? */
1288 if (footnoteflag != par->footnoteflag) {
1289 footnoteflag = par->footnoteflag;
1291 j = strlen(string_footnotekinds[par->footnotekind])+4;
1292 if (currlinelen + j > linelen)
1295 << string_footnotekinds[par->footnotekind] << "] ";
1301 /* begins or ends a deeper area ?*/
1302 if (depth != par->depth) {
1303 if (par->depth > depth) {
1304 while (par->depth > depth) {
1309 while (par->depth < depth) {
1315 /* First write the layout */
1316 tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1317 if (tmp == "Itemize") {
1319 ltype_depth = depth+1;
1320 } else if (tmp == "Enumerate") {
1322 ltype_depth = depth+1;
1323 } else if (contains(tmp, "ection")) {
1325 ltype_depth = depth+1;
1326 } else if (contains(tmp, "aragraph")) {
1328 ltype_depth = depth+1;
1329 } else if (tmp == "Description") {
1331 ltype_depth = depth+1;
1332 } else if (tmp == "Abstract") {
1335 } else if (tmp == "Bibliography") {
1343 /* maybe some vertical spaces */
1345 /* the labelwidthstring used in lists */
1349 /* some pagebreaks? */
1353 /* what about the alignment */
1356 /* dummy layout, that means a footnote ended */
1357 footnoteflag = LyXParagraph::NO_FOOTNOTE;
1361 lyxerr << "Should this ever happen?" << endl;
1366 LyXFont(LyXFont::ALL_INHERIT, params.language_info);
1368 for (i = 0, actpos = 1; i < par->size(); ++i, ++actpos) {
1369 if (!i && !footnoteflag && !noparbreak){
1371 for(j = 0; j < depth; ++j)
1373 currlinelen = depth * 2;
1375 case 0: /* Standard */
1376 case 4: /* (Sub)Paragraph */
1377 case 5: /* Description */
1379 case 6: /* Abstract */
1380 ofs << "Abstract\n\n";
1382 case 7: /* Bibliography */
1384 ofs << "References\n\n";
1389 ofs << par->labelstring << " ";
1392 if (ltype_depth > depth) {
1393 for(j = ltype_depth - 1; j > depth; --j)
1395 currlinelen += (ltype_depth-depth)*2;
1398 LyXFont font2 = par->GetFontSettings(params, i);
1399 if (font1.latex() != font2.latex()) {
1400 if (font2.latex() == LyXFont::OFF)
1407 c = par->GetChar(i);
1411 case LyXParagraph::META_INSET:
1412 if ((inset = par->GetInset(i))) {
1414 inset->Ascii(this, ofs);
1415 currlinelen += (ofs.tellp() - fpos);
1416 actpos += (ofs.tellp() - fpos) - 1;
1419 case LyXParagraph::META_NEWLINE:
1421 for(j = 0; j < depth; ++j)
1423 currlinelen = depth * 2;
1424 if (ltype_depth > depth) {
1425 for(j = ltype_depth;
1428 currlinelen += (ltype_depth - depth) * 2;
1431 case LyXParagraph::META_HFILL:
1438 if (currlinelen > linelen - 10
1439 && c == ' ' && i + 2 < par->size()) {
1441 for(j = 0; j < depth; ++j)
1443 currlinelen = depth * 2;
1444 if (ltype_depth > depth) {
1445 for(j = ltype_depth;
1448 currlinelen += (ltype_depth-depth)*2;
1450 } else if (c != '\0')
1453 lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1463 //----------------------------------------------------------------------------
1465 //----------------------------------------------------------------------------
1466 string const Buffer::asciiParagraph(LyXParagraph const * par,
1467 unsigned int linelen) const
1469 ostringstream buffer;
1472 Inset const * inset;
1474 LyXParagraph::footnote_flag footnoteflag = LyXParagraph::NO_FOOTNOTE;
1477 int ltype_depth = 0;
1478 unsigned int currlinelen = 0;
1479 bool ref_printed = false;
1485 par->footnoteflag != LyXParagraph::NO_FOOTNOTE ||
1489 || par->previous->footnoteflag == LyXParagraph::NO_FOOTNOTE
1493 /* begins a footnote environment ? */
1494 if (footnoteflag != par->footnoteflag) {
1495 footnoteflag = par->footnoteflag;
1497 size_t const j = strlen(string_footnotekinds[par->footnotekind]) + 4;
1498 if ((linelen > 0) &&
1499 ((currlinelen + j) > linelen)) {
1504 << string_footnotekinds[par->footnotekind]
1510 /* begins or ends a deeper area ?*/
1511 if (depth != par->depth) {
1512 if (par->depth > depth) {
1513 while (par->depth > depth) {
1518 while (par->depth < depth) {
1524 /* First write the layout */
1525 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1526 if (tmp == "Itemize") {
1528 ltype_depth = depth+1;
1529 } else if (tmp == "Enumerate") {
1531 ltype_depth = depth+1;
1532 } else if (strstr(tmp.c_str(), "ection")) {
1534 ltype_depth = depth+1;
1535 } else if (strstr(tmp.c_str(), "aragraph")) {
1537 ltype_depth = depth+1;
1538 } else if (tmp == "Description") {
1540 ltype_depth = depth+1;
1541 } else if (tmp == "Abstract") {
1544 } else if (tmp == "Bibliography") {
1552 /* maybe some vertical spaces */
1554 /* the labelwidthstring used in lists */
1558 /* some pagebreaks? */
1562 /* what about the alignment */
1565 /* dummy layout, that means a footnote ended */
1566 footnoteflag = LyXParagraph::NO_FOOTNOTE;
1570 lyxerr << "Should this ever happen?" << endl;
1574 font1 = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
1575 for (LyXParagraph::size_type i = 0; i < par->size(); ++i) {
1576 if (!i && !footnoteflag && !noparbreak){
1578 for(char j = 0; j < depth; ++j)
1580 currlinelen = depth * 2;
1582 case 0: /* Standard */
1583 case 4: /* (Sub)Paragraph */
1584 case 5: /* Description */
1586 case 6: /* Abstract */
1587 buffer << "Abstract\n\n";
1589 case 7: /* Bibliography */
1591 buffer << "References\n\n";
1596 buffer << par->labelstring << " ";
1599 if (ltype_depth > depth) {
1600 for(char j = ltype_depth - 1; j > depth; --j)
1602 currlinelen += (ltype_depth-depth)*2;
1605 font2 = par->GetFontSettings(params, i);
1606 if (font1.latex() != font2.latex()) {
1607 if (font2.latex() == LyXFont::OFF)
1614 c = par->GetChar(i);
1618 case LyXParagraph::META_INSET:
1619 if ((inset = par->GetInset(i))) {
1620 if (!inset->Ascii(this, buffer)) {
1622 string s = rsplit(buffer.str(),
1624 currlinelen += s.length();
1626 // to be sure it breaks paragraph
1627 currlinelen += linelen;
1631 case LyXParagraph::META_NEWLINE:
1633 for(char j = 0; j < depth; ++j)
1635 currlinelen = depth * 2;
1636 if (ltype_depth > depth) {
1637 for(char j = ltype_depth;
1640 currlinelen += (ltype_depth - depth) * 2;
1643 case LyXParagraph::META_HFILL:
1650 if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1651 (c == ' ') && ((i + 2) < par->size()))
1654 for(char j = 0; j < depth; ++j)
1656 currlinelen = depth * 2;
1657 if (ltype_depth > depth) {
1658 for(char j = ltype_depth;
1661 currlinelen += (ltype_depth-depth)*2;
1663 } else if (c != '\0')
1666 lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1671 return buffer.str();
1675 void Buffer::writeFileAscii(string const & fname, int linelen)
1677 ofstream ofs(fname.c_str());
1679 WriteFSAlert(_("Error: Cannot write file:"), fname);
1682 writeFileAscii(ofs, linelen);
1686 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1688 LyXParagraph * par = paragraph;
1690 ofs << asciiParagraph(par, linelen);
1697 void Buffer::makeLaTeXFile(string const & fname,
1698 string const & original_path,
1699 bool nice, bool only_body)
1701 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1703 niceFile = nice; // this will be used by Insetincludes.
1705 tex_code_break_column = lyxrc.ascii_linelen;
1707 LyXTextClass const & tclass =
1708 textclasslist.TextClass(params.textclass);
1710 ofstream ofs(fname.c_str());
1712 WriteFSAlert(_("Error: Cannot open file: "), fname);
1716 // validate the buffer.
1717 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1718 LaTeXFeatures features(params, tclass.numLayouts());
1720 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1723 // The starting paragraph of the coming rows is the
1724 // first paragraph of the document. (Asger)
1725 texrow.start(paragraph, 0);
1727 if (!only_body && nice) {
1728 ofs << "%% " LYX_DOCVERSION " created this file. "
1729 "For more info, see http://www.lyx.org/.\n"
1730 "%% Do not edit unless you really know what "
1735 lyxerr.debug() << "lyx header finished" << endl;
1736 // There are a few differences between nice LaTeX and usual files:
1737 // usual is \batchmode and has a
1738 // special input@path to allow the including of figures
1739 // with either \input or \includegraphics (what figinsets do).
1740 // batchmode is not set if there is a tex_code_break_column.
1741 // In this case somebody is interested in the generated LaTeX,
1742 // so this is OK. input@path is set when the actual parameter
1743 // original_path is set. This is done for usual tex-file, but not
1744 // for nice-latex-file. (Matthias 250696)
1747 // code for usual, NOT nice-latex-file
1748 ofs << "\\batchmode\n"; // changed
1749 // from \nonstopmode
1752 if (!original_path.empty()) {
1753 ofs << "\\makeatletter\n"
1754 << "\\def\\input@path{{"
1755 << original_path << "/}}\n"
1756 << "\\makeatother\n";
1762 ofs << "\\documentclass";
1764 string options; // the document class options.
1766 if (tokenPos(tclass.opt_fontsize(),
1767 '|', params.fontsize) >= 0) {
1768 // only write if existing in list (and not default)
1769 options += params.fontsize;
1774 if (!params.use_geometry &&
1775 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1776 switch (params.papersize) {
1777 case BufferParams::PAPER_A4PAPER:
1778 options += "a4paper,";
1780 case BufferParams::PAPER_USLETTER:
1781 options += "letterpaper,";
1783 case BufferParams::PAPER_A5PAPER:
1784 options += "a5paper,";
1786 case BufferParams::PAPER_B5PAPER:
1787 options += "b5paper,";
1789 case BufferParams::PAPER_EXECUTIVEPAPER:
1790 options += "executivepaper,";
1792 case BufferParams::PAPER_LEGALPAPER:
1793 options += "legalpaper,";
1799 if (params.sides != tclass.sides()) {
1800 switch (params.sides) {
1801 case LyXTextClass::OneSide:
1802 options += "oneside,";
1804 case LyXTextClass::TwoSides:
1805 options += "twoside,";
1812 if (params.columns != tclass.columns()) {
1813 if (params.columns == 2)
1814 options += "twocolumn,";
1816 options += "onecolumn,";
1819 if (!params.use_geometry
1820 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1821 options += "landscape,";
1823 // language should be a parameter to \documentclass
1824 bool use_babel = false;
1825 if (params.language_info->lang() == "hebrew") // This seems necessary
1826 features.UsedLanguages.insert(default_language);
1827 if (params.language != "default" ||
1828 !features.UsedLanguages.empty() ) {
1830 for (LaTeXFeatures::LanguageList::const_iterator cit =
1831 features.UsedLanguages.begin();
1832 cit != features.UsedLanguages.end(); ++cit)
1833 options += (*cit)->lang() + ",";
1834 options += params.language_info->lang() + ',';
1837 // the user-defined options
1838 if (!params.options.empty()) {
1839 options += params.options + ',';
1842 if (!options.empty()){
1843 options = strip(options, ',');
1844 ofs << '[' << options << ']';
1848 << textclasslist.LatexnameOfClass(params.textclass)
1851 // end of \documentclass defs
1853 // font selection must be done before loading fontenc.sty
1854 if (params.fonts != "default") {
1855 ofs << "\\usepackage{" << params.fonts << "}\n";
1858 // this one is not per buffer
1859 if (lyxrc.fontenc != "default") {
1860 ofs << "\\usepackage[" << lyxrc.fontenc
1865 if (params.inputenc == "auto") {
1866 string const doc_encoding =
1867 params.language_info->encoding()->LatexName();
1869 // Create a list with all the input encodings used
1871 set<string> encodings;
1872 for (LaTeXFeatures::LanguageList::const_iterator it =
1873 features.UsedLanguages.begin();
1874 it != features.UsedLanguages.end(); ++it)
1875 if ((*it)->encoding()->LatexName() != doc_encoding)
1876 encodings.insert((*it)->encoding()->LatexName());
1878 ofs << "\\usepackage[";
1879 for (set<string>::const_iterator it = encodings.begin();
1880 it != encodings.end(); ++it)
1882 ofs << doc_encoding << "]{inputenc}\n";
1884 } else if (params.inputenc != "default") {
1885 ofs << "\\usepackage[" << params.inputenc
1890 // At the very beginning the text parameters.
1891 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1892 switch (params.paperpackage) {
1893 case BufferParams::PACKAGE_A4:
1894 ofs << "\\usepackage{a4}\n";
1897 case BufferParams::PACKAGE_A4WIDE:
1898 ofs << "\\usepackage{a4wide}\n";
1901 case BufferParams::PACKAGE_WIDEMARGINSA4:
1902 ofs << "\\usepackage[widemargins]{a4}\n";
1907 if (params.use_geometry) {
1908 ofs << "\\usepackage{geometry}\n";
1910 ofs << "\\geometry{verbose";
1911 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1912 ofs << ",landscape";
1913 switch (params.papersize2) {
1914 case BufferParams::VM_PAPER_CUSTOM:
1915 if (!params.paperwidth.empty())
1916 ofs << ",paperwidth="
1917 << params.paperwidth;
1918 if (!params.paperheight.empty())
1919 ofs << ",paperheight="
1920 << params.paperheight;
1922 case BufferParams::VM_PAPER_USLETTER:
1923 ofs << ",letterpaper";
1925 case BufferParams::VM_PAPER_USLEGAL:
1926 ofs << ",legalpaper";
1928 case BufferParams::VM_PAPER_USEXECUTIVE:
1929 ofs << ",executivepaper";
1931 case BufferParams::VM_PAPER_A3:
1934 case BufferParams::VM_PAPER_A4:
1937 case BufferParams::VM_PAPER_A5:
1940 case BufferParams::VM_PAPER_B3:
1943 case BufferParams::VM_PAPER_B4:
1946 case BufferParams::VM_PAPER_B5:
1950 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1951 switch (lyxrc.default_papersize) {
1952 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1953 case BufferParams::PAPER_USLETTER:
1954 ofs << ",letterpaper";
1956 case BufferParams::PAPER_LEGALPAPER:
1957 ofs << ",legalpaper";
1959 case BufferParams::PAPER_EXECUTIVEPAPER:
1960 ofs << ",executivepaper";
1962 case BufferParams::PAPER_A3PAPER:
1965 case BufferParams::PAPER_A4PAPER:
1968 case BufferParams::PAPER_A5PAPER:
1971 case BufferParams::PAPER_B5PAPER:
1976 if (!params.topmargin.empty())
1977 ofs << ",tmargin=" << params.topmargin;
1978 if (!params.bottommargin.empty())
1979 ofs << ",bmargin=" << params.bottommargin;
1980 if (!params.leftmargin.empty())
1981 ofs << ",lmargin=" << params.leftmargin;
1982 if (!params.rightmargin.empty())
1983 ofs << ",rmargin=" << params.rightmargin;
1984 if (!params.headheight.empty())
1985 ofs << ",headheight=" << params.headheight;
1986 if (!params.headsep.empty())
1987 ofs << ",headsep=" << params.headsep;
1988 if (!params.footskip.empty())
1989 ofs << ",footskip=" << params.footskip;
1993 if (params.use_amsmath
1994 && !tclass.provides(LyXTextClass::amsmath)) {
1995 ofs << "\\usepackage{amsmath}\n";
1999 if (tokenPos(tclass.opt_pagestyle(),
2000 '|', params.pagestyle) >= 0) {
2001 if (params.pagestyle == "fancy") {
2002 ofs << "\\usepackage{fancyhdr}\n";
2005 ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2009 // We try to load babel late, in case it interferes
2010 // with other packages.
2012 ofs << lyxrc.language_package << endl;
2016 if (params.secnumdepth != tclass.secnumdepth()) {
2017 ofs << "\\setcounter{secnumdepth}{"
2018 << params.secnumdepth
2022 if (params.tocdepth != tclass.tocdepth()) {
2023 ofs << "\\setcounter{tocdepth}{"
2029 if (params.paragraph_separation) {
2030 switch (params.defskip.kind()) {
2031 case VSpace::SMALLSKIP:
2032 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2034 case VSpace::MEDSKIP:
2035 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2037 case VSpace::BIGSKIP:
2038 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2040 case VSpace::LENGTH:
2041 ofs << "\\setlength\\parskip{"
2042 << params.defskip.length().asLatexString()
2045 default: // should never happen // Then delete it.
2046 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2051 ofs << "\\setlength\\parindent{0pt}\n";
2055 // Now insert the LyX specific LaTeX commands...
2057 // The optional packages;
2058 string preamble(features.getPackages());
2060 // this might be useful...
2061 preamble += "\n\\makeatletter\n";
2063 // Some macros LyX will need
2064 string tmppreamble(features.getMacros());
2066 if (!tmppreamble.empty()) {
2067 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2068 "LyX specific LaTeX commands.\n"
2069 + tmppreamble + '\n';
2072 // the text class specific preamble
2073 tmppreamble = features.getTClassPreamble();
2074 if (!tmppreamble.empty()) {
2075 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2076 "Textclass specific LaTeX commands.\n"
2077 + tmppreamble + '\n';
2080 /* the user-defined preamble */
2081 if (!params.preamble.empty()) {
2082 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2083 "User specified LaTeX commands.\n"
2084 + params.preamble + '\n';
2087 preamble += "\\makeatother\n";
2089 // Itemize bullet settings need to be last in case the user
2090 // defines their own bullets that use a package included
2091 // in the user-defined preamble -- ARRae
2092 // Actually it has to be done much later than that
2093 // since some packages like frenchb make modifications
2094 // at \begin{document} time -- JMarc
2096 for (int i = 0; i < 4; ++i) {
2097 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2098 if (bullets_def.empty())
2099 bullets_def="\\AtBeginDocument{\n";
2100 bullets_def += " \\renewcommand{\\labelitemi";
2102 // `i' is one less than the item to modify
2109 bullets_def += "ii";
2115 bullets_def += "}{" +
2116 params.user_defined_bullets[i].getText()
2121 if (!bullets_def.empty())
2122 preamble += bullets_def + "}\n\n";
2124 for (int j = countChar(preamble, '\n'); j-- ;) {
2131 ofs << "\\begin{document}\n";
2134 lyxerr.debug() << "preamble finished, now the body." << endl;
2135 if (!lyxrc.language_auto_begin && params.language != "default") {
2136 ofs << subst(lyxrc.language_command_begin, "$$lang",
2142 latexParagraphs(ofs, paragraph, 0, texrow);
2144 // add this just in case after all the paragraphs
2148 if (!lyxrc.language_auto_end && params.language != "default") {
2149 ofs << subst(lyxrc.language_command_end, "$$lang",
2156 ofs << "\\end{document}\n";
2159 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2161 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2165 // Just to be sure. (Asger)
2168 // tex_code_break_column's value is used to decide
2169 // if we are in batchmode or not (within mathed_write()
2170 // in math_write.C) so we must set it to a non-zero
2171 // value when we leave otherwise we save incorrect .lyx files.
2172 tex_code_break_column = lyxrc.ascii_linelen;
2176 lyxerr << "File was not closed properly." << endl;
2179 lyxerr.debug() << "Finished making latex file." << endl;
2184 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2186 void Buffer::latexParagraphs(ostream & ofs, LyXParagraph * par,
2187 LyXParagraph * endpar, TexRow & texrow) const
2189 bool was_title = false;
2190 bool already_title = false;
2191 std::ostringstream ftnote;
2196 while (par != endpar) {
2199 lyxerr[Debug::LATEX] << "Error in latexParagraphs."
2202 LyXLayout const & layout =
2203 textclasslist.Style(params.textclass,
2206 if (layout.intitle) {
2207 if (already_title) {
2208 lyxerr <<"Error in latexParagraphs: You"
2209 " should not mix title layouts"
2210 " with normal ones." << endl;
2213 } else if (was_title && !already_title) {
2214 ofs << "\\maketitle\n";
2216 already_title = true;
2219 // We are at depth 0 so we can just use
2220 // ordinary \footnote{} generation
2221 // flag this with ftcount
2223 if (layout.isEnvironment()
2224 || par->pextra_type != LyXParagraph::PEXTRA_NONE) {
2225 par = par->TeXEnvironment(this, params, ofs, texrow
2227 ,ftnote, ft_texrow, ftcount
2231 par = par->TeXOnePar(this, params, ofs, texrow, false
2234 ftnote, ft_texrow, ftcount
2239 // Write out what we've generated...
2242 ofs << "\\addtocounter{footnote}{-"
2246 ofs << ftnote.str();
2247 texrow += ft_texrow;
2249 // The extra .c_str() is needed when we use
2250 // lyxstring instead of the STL string class.
2251 ftnote.str(string().c_str());
2256 // It might be that we only have a title in this document
2257 if (was_title && !already_title) {
2258 ofs << "\\maketitle\n";
2264 bool Buffer::isLatex() const
2266 return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2270 bool Buffer::isLinuxDoc() const
2272 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2276 bool Buffer::isLiterate() const
2278 return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2282 bool Buffer::isDocBook() const
2284 return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2288 bool Buffer::isSGML() const
2290 return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2291 textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2295 void Buffer::sgmlOpenTag(ostream & os, int depth,
2296 string const & latexname) const
2298 os << string(depth, ' ') << "<" << latexname << ">\n";
2302 void Buffer::sgmlCloseTag(ostream & os, int depth,
2303 string const & latexname) const
2305 os << string(depth, ' ') << "</" << latexname << ">\n";
2309 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2311 LyXParagraph * par = paragraph;
2313 niceFile = nice; // this will be used by Insetincludes.
2315 string top_element = textclasslist.LatexnameOfClass(params.textclass);
2316 string environment_stack[10];
2319 int depth = 0; // paragraph depth
2321 ofstream ofs(fname.c_str());
2324 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2328 LyXTextClass const & tclass =
2329 textclasslist.TextClass(params.textclass);
2331 LaTeXFeatures features(params, tclass.numLayouts());
2335 tex_code_break_column = lyxrc.ascii_linelen;
2337 //tex_code_break_column = 0;
2342 string sgml_includedfiles=features.getIncludedFiles();
2344 if (params.preamble.empty() && sgml_includedfiles.empty()) {
2345 ofs << "<!doctype linuxdoc system>\n\n";
2347 ofs << "<!doctype linuxdoc system [ "
2348 << params.preamble << sgml_includedfiles << " \n]>\n\n";
2351 if(params.options.empty())
2352 sgmlOpenTag(ofs, 0, top_element);
2354 string top = top_element;
2356 top += params.options;
2357 sgmlOpenTag(ofs, 0, top);
2361 ofs << "<!-- " << LYX_DOCVERSION
2362 << " created this file. For more info see http://www.lyx.org/"
2366 int desc_on = 0; // description mode
2367 LyXLayout const & style =
2368 textclasslist.Style(params.textclass,
2371 // treat <toc> as a special case for compatibility with old code
2372 if (par->GetChar(0) == LyXParagraph::META_INSET) {
2373 Inset * inset = par->GetInset(0);
2374 Inset::Code lyx_code = inset->LyxCode();
2375 if (lyx_code == Inset::TOC_CODE){
2376 string const temp = "toc";
2377 sgmlOpenTag(ofs, depth, temp);
2381 linuxDocHandleFootnote(ofs, par, depth);
2387 // environment tag closing
2388 for (; depth > par->depth; --depth) {
2389 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2390 environment_stack[depth].erase();
2393 // write opening SGML tags
2394 switch (style.latextype) {
2395 case LATEX_PARAGRAPH:
2396 if(depth == par->depth
2397 && !environment_stack[depth].empty()) {
2398 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2399 environment_stack[depth].erase();
2405 sgmlOpenTag(ofs, depth, style.latexname());
2410 LinuxDocError(par, 0,
2411 _("Error : Wrong depth for"
2412 " LatexType Command.\n"));
2414 if (!environment_stack[depth].empty()){
2415 sgmlCloseTag(ofs, depth,
2416 environment_stack[depth]);
2420 environment_stack[depth].erase();
2421 sgmlOpenTag(ofs, depth, style.latexname());
2424 case LATEX_ENVIRONMENT:
2425 case LATEX_ITEM_ENVIRONMENT:
2426 if (depth == par->depth
2427 && environment_stack[depth] != style.latexname()
2428 && !environment_stack[depth].empty()) {
2430 sgmlCloseTag(ofs, depth,
2431 environment_stack[depth]);
2432 environment_stack[depth].erase();
2434 if (depth < par->depth) {
2436 environment_stack[depth].erase();
2438 if (environment_stack[depth] != style.latexname()) {
2440 string const temp = "p";
2441 sgmlOpenTag(ofs, depth, temp);
2443 environment_stack[depth] = style.latexname();
2444 sgmlOpenTag(ofs, depth,
2445 environment_stack[depth]);
2447 if(style.latextype == LATEX_ENVIRONMENT) break;
2449 desc_on = (style.labeltype == LABEL_MANUAL);
2456 sgmlOpenTag(ofs, depth + 1, item_name);
2459 sgmlOpenTag(ofs, depth, style.latexname());
2466 SimpleLinuxDocOnePar(ofs, par, desc_on, depth);
2470 linuxDocHandleFootnote(ofs, par, depth);
2472 while(par && par->IsDummy());
2476 // write closing SGML tags
2477 switch(style.latextype) {
2479 case LATEX_ENVIRONMENT:
2480 case LATEX_ITEM_ENVIRONMENT:
2483 sgmlCloseTag(ofs, depth, style.latexname());
2489 for(; depth > 0; --depth)
2490 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2492 if(!environment_stack[depth].empty())
2493 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2497 sgmlCloseTag(ofs, 0, top_element);
2501 // How to check for successful close
2506 void Buffer::linuxDocHandleFootnote(ostream & os, LyXParagraph * & par,
2509 string const tag = "footnote";
2511 while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
2512 sgmlOpenTag(os, depth + 1, tag);
2513 SimpleLinuxDocOnePar(os, par, 0, depth + 1);
2514 sgmlCloseTag(os, depth + 1, tag);
2521 void Buffer::DocBookHandleCaption(ostream & os, string & inner_tag,
2522 int depth, int desc_on,
2523 LyXParagraph * & par)
2525 LyXParagraph * tpar = par;
2528 && (tpar->footnoteflag != LyXParagraph::NO_FOOTNOTE)
2530 && (tpar->layout != textclasslist.NumberOfLayout(params.textclass,
2534 tpar->layout == textclasslist.NumberOfLayout(params.textclass,
2535 "Caption").second) {
2536 sgmlOpenTag(os, depth + 1, inner_tag);
2538 SimpleDocBookOnePar(os, extra_par, tpar,
2539 desc_on, depth + 2);
2540 sgmlCloseTag(os, depth+1, inner_tag);
2541 if(!extra_par.empty())
2548 void Buffer::DocBookHandleFootnote(ostream & os, LyXParagraph * & par,
2551 string tag, inner_tag;
2552 string tmp_par, extra_par;
2553 bool inner_span = false;
2556 // Someone should give this enum a proper name (Lgb)
2564 SOME_ENUM last = NO_ONE;
2565 SOME_ENUM present = FOOTNOTE_LIKE;
2567 while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
2568 if (last == present) {
2570 if (!tmp_par.empty()) {
2573 sgmlCloseTag(os, depth + 1, inner_tag);
2574 sgmlOpenTag(os, depth + 1, inner_tag);
2581 if (!inner_tag.empty()) sgmlCloseTag(os, depth + 1,
2583 if (!extra_par.empty()) os << extra_par;
2584 if (!tag.empty()) sgmlCloseTag(os, depth, tag);
2587 switch (par->footnotekind) {
2588 case LyXParagraph::FOOTNOTE:
2589 case LyXParagraph::ALGORITHM:
2592 present = FOOTNOTE_LIKE;
2595 case LyXParagraph::MARGIN:
2598 present = MARGIN_LIKE;
2601 case LyXParagraph::FIG:
2602 case LyXParagraph::WIDE_FIG:
2604 inner_tag = "title";
2608 case LyXParagraph::TAB:
2609 case LyXParagraph::WIDE_TAB:
2611 inner_tag = "title";
2616 sgmlOpenTag(os, depth, tag);
2617 if ((present == TAB_LIKE) || (present == FIG_LIKE)) {
2618 DocBookHandleCaption(os, inner_tag, depth,
2622 sgmlOpenTag(os, depth + 1, inner_tag);
2625 // ignore all caption here, we processed them above!!!
2626 if (par->layout != textclasslist
2627 .NumberOfLayout(params.textclass,
2628 "Caption").second) {
2629 std::ostringstream ost;
2630 SimpleDocBookOnePar(ost, extra_par, par,
2631 desc_on, depth + 2);
2632 tmp_par += ost.str().c_str();
2634 tmp_par = frontStrip(strip(tmp_par));
2640 if(!inner_tag.empty()) sgmlCloseTag(os, depth + 1, inner_tag);
2641 if(!extra_par.empty()) os << extra_par;
2642 if(!tag.empty()) sgmlCloseTag(os, depth, tag);
2647 // push a tag in a style stack
2648 void Buffer::push_tag(ostream & os, string const & tag,
2649 int & pos, char stack[5][3])
2651 #warning Use a real stack! (Lgb)
2652 // pop all previous tags
2653 for (int j = pos; j >= 0; --j)
2654 os << "</" << stack[j] << ">";
2657 sprintf(stack[++pos], "%s", tag.c_str());
2660 for (int i = 0; i <= pos; ++i)
2661 os << "<" << stack[i] << ">";
2665 void Buffer::pop_tag(ostream & os, string const & tag,
2666 int & pos, char stack[5][3])
2668 #ifdef WITH_WARNINGS
2669 #warning Use a real stack! (Lgb)
2671 // Please, Lars, do not remove the global variable. I already
2672 // had to reintroduce it twice! (JMarc)
2675 // pop all tags till specified one
2676 for (j = pos; (j >= 0) && (strcmp(stack[j], tag.c_str())); --j)
2677 os << "</" << stack[j] << ">";
2680 os << "</" << tag << ">";
2682 // push all tags, but the specified one
2683 for (j = j + 1; j <= pos; ++j) {
2684 os << "<" << stack[j] << ">";
2685 strcpy(stack[j-1], stack[j]);
2691 // Handle internal paragraph parsing -- layout already processed.
2693 // checks, if newcol chars should be put into this line
2694 // writes newline, if necessary.
2696 void linux_doc_line_break(ostream & os, string::size_type & colcount,
2697 string::size_type newcol)
2700 if (colcount > lyxrc.ascii_linelen) {
2702 colcount = newcol; // assume write after this call
2707 void Buffer::SimpleLinuxDocOnePar(ostream & os, LyXParagraph * par,
2708 int desc_on, int /*depth*/)
2713 LyXParagraph::size_type main_body;
2715 LyXLayout const & style = textclasslist.Style(params.textclass,
2718 char family_type = 0; // family font flag
2719 bool is_bold = false; // series font flag
2720 char shape_type = 0; // shape font flag
2721 bool is_em = false; // emphasis (italic) font flag
2723 int stack_num = -1; // style stack position
2724 // Can this be rewritten to use a std::stack, please. (Lgb)
2725 char stack[5][3]; // style stack
2726 string::size_type char_line_count = 5; // Heuristic choice ;-)
2728 if (style.labeltype != LABEL_MANUAL)
2731 main_body = par->BeginningOfMainBody();
2733 // gets paragraph main font
2735 font1 = style.labelfont;
2740 // parsing main loop
2741 for (LyXParagraph::size_type i = 0;
2742 i < par->size(); ++i) {
2754 LyXFont const font2 = par->getFont(params, i);
2756 if (font1.family() != font2.family()) {
2757 switch(family_type) {
2759 if (font2.family() == LyXFont::TYPEWRITER_FAMILY) {
2760 push_tag(os, "tt", stack_num, stack);
2763 else if (font2.family() == LyXFont::SANS_FAMILY) {
2764 push_tag(os, "sf", stack_num, stack);
2769 pop_tag(os, "tt", stack_num, stack);
2770 if (font2.family() == LyXFont::SANS_FAMILY) {
2771 push_tag(os, "sf", stack_num, stack);
2778 pop_tag(os, "sf", stack_num, stack);
2779 if (font2.family() == LyXFont::TYPEWRITER_FAMILY) {
2780 push_tag(os, "tt", stack_num, stack);
2789 if (font1.series() != font2.series()) {
2790 if (font2.series() == LyXFont::BOLD_SERIES) {
2791 push_tag(os, "bf", stack_num, stack);
2793 } else if (is_bold) {
2794 pop_tag(os, "bf", stack_num, stack);
2799 // handle italic and slanted fonts
2800 if (font1.shape() != font2.shape()) {
2801 switch(shape_type) {
2803 if (font2.shape() == LyXFont::ITALIC_SHAPE) {
2804 push_tag(os, "it", stack_num, stack);
2806 } else if (font2.shape() == LyXFont::SLANTED_SHAPE) {
2807 push_tag(os, "sl", stack_num, stack);
2812 pop_tag(os, "it", stack_num, stack);
2813 if (font2.shape() == LyXFont::SLANTED_SHAPE) {
2814 push_tag(os, "sl", stack_num, stack);
2821 pop_tag(os, "sl", stack_num, stack);
2822 if (font2.shape() == LyXFont::ITALIC_SHAPE) {
2823 push_tag(os, "it", stack_num, stack);
2831 if (font1.emph() != font2.emph()) {
2832 if (font2.emph() == LyXFont::ON) {
2833 push_tag(os, "em", stack_num, stack);
2836 pop_tag(os, "em", stack_num, stack);
2841 c = par->GetChar(i);
2843 if (c == LyXParagraph::META_INSET) {
2844 inset = par->GetInset(i);
2845 inset->Linuxdoc(this, os);
2848 if (font2.latex() == LyXFont::ON) {
2849 // "TeX"-Mode on == > SGML-Mode on.
2851 os << c; // see LaTeX-Generation...
2855 if (par->linuxDocConvertChar(c, sgml_string)
2856 && !style.free_spacing) { // in freespacing
2858 // non-breaking characters
2862 linux_doc_line_break(os, char_line_count, 6);
2866 linux_doc_line_break(os, char_line_count, 1);
2871 char_line_count += sgml_string.length();
2877 // needed if there is an optional argument but no contents
2878 if (main_body > 0 && main_body == par->size()) {
2882 // pop all defined Styles
2883 for (j = stack_num; j >= 0; --j) {
2884 linux_doc_line_break(os,
2886 3 + strlen(stack[j]));
2887 os << "</" << stack[j] << ">";
2890 // resets description flag correctly
2893 // <tag> not closed...
2894 linux_doc_line_break(os, char_line_count, 6);
2898 // fprintf(file, "</p>");
2904 // Print an error message.
2905 void Buffer::LinuxDocError(LyXParagraph * par, int pos,
2906 string const & message)
2908 // insert an error marker in text
2909 InsetError * new_inset = new InsetError(message);
2910 par->InsertInset(pos, new_inset);
2913 // This constant defines the maximum number of
2914 // environment layouts that can be nesteded.
2915 // The same applies for command layouts.
2916 // These values should be more than enough.
2917 // José Matos (1999/07/22)
2919 enum { MAX_NEST_LEVEL = 25};
2921 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2923 LyXParagraph * par = paragraph;
2925 niceFile = nice; // this will be used by Insetincludes.
2927 string top_element= textclasslist.LatexnameOfClass(params.textclass);
2928 // Please use a real stack.
2929 string environment_stack[MAX_NEST_LEVEL];
2930 string environment_inner[MAX_NEST_LEVEL];
2931 // Please use a real stack.
2932 string command_stack[MAX_NEST_LEVEL];
2933 bool command_flag= false;
2934 int command_depth= 0, command_base= 0, cmd_depth= 0;
2936 string item_name, command_name;
2937 string c_depth, c_params, tmps;
2939 int depth = 0; // paragraph depth
2940 LyXTextClass const & tclass =
2941 textclasslist.TextClass(params.textclass);
2943 LaTeXFeatures features(params, tclass.numLayouts());
2947 tex_code_break_column = lyxrc.ascii_linelen;
2949 //tex_code_break_column = 0;
2951 ofstream ofs(fname.c_str());
2953 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2960 string sgml_includedfiles=features.getIncludedFiles();
2962 ofs << "<!doctype " << top_element
2963 << " public \"-//OASIS//DTD DocBook V3.1//EN\"";
2965 if (params.preamble.empty() && sgml_includedfiles.empty())
2968 ofs << "\n [ " << params.preamble
2969 << sgml_includedfiles << " \n]>\n\n";
2971 if(params.options.empty())
2972 sgmlOpenTag(ofs, 0, top_element);
2974 string top = top_element;
2976 top += params.options;
2977 sgmlOpenTag(ofs, 0, top);
2981 ofs << "<!-- DocBook file was created by " << LYX_DOCVERSION
2982 << "\n See http://www.lyx.org/ for more information -->\n";
2985 int desc_on = 0; // description mode
2986 LyXLayout const & style =
2987 textclasslist.Style(params.textclass,
2990 // environment tag closing
2991 for( ; depth > par->depth; --depth) {
2992 if(environment_inner[depth] != "!-- --") {
2993 item_name= "listitem";
2994 sgmlCloseTag(ofs, command_depth + depth,
2996 if( environment_inner[depth] == "varlistentry")
2997 sgmlCloseTag(ofs, depth+command_depth,
2998 environment_inner[depth]);
3000 sgmlCloseTag(ofs, depth + command_depth,
3001 environment_stack[depth]);
3002 environment_stack[depth].erase();
3003 environment_inner[depth].erase();
3006 if(depth == par->depth
3007 && environment_stack[depth] != style.latexname()
3008 && !environment_stack[depth].empty()) {
3009 if(environment_inner[depth] != "!-- --") {
3010 item_name= "listitem";
3011 sgmlCloseTag(ofs, command_depth+depth,
3013 if( environment_inner[depth] == "varlistentry")
3015 depth + command_depth,
3016 environment_inner[depth]);
3019 sgmlCloseTag(ofs, depth + command_depth,
3020 environment_stack[depth]);
3022 environment_stack[depth].erase();
3023 environment_inner[depth].erase();
3026 // Write opening SGML tags.
3027 switch(style.latextype) {
3028 case LATEX_PARAGRAPH:
3029 if(style.latexname() != "dummy")
3030 sgmlOpenTag(ofs, depth+command_depth,
3036 LinuxDocError(par, 0,
3037 _("Error : Wrong depth for "
3038 "LatexType Command.\n"));
3040 command_name = style.latexname();
3042 tmps = style.latexparam();
3043 c_params = split(tmps, c_depth,'|');
3045 cmd_depth= lyx::atoi(c_depth);
3048 if(cmd_depth<command_base) {
3049 for(int j = command_depth;
3050 j >= command_base; --j)
3051 if(!command_stack[j].empty())
3052 sgmlCloseTag(ofs, j, command_stack[j]);
3053 command_depth= command_base= cmd_depth;
3054 } else if(cmd_depth <= command_depth) {
3055 for(int j = command_depth;
3056 j >= cmd_depth; --j)
3058 if(!command_stack[j].empty())
3059 sgmlCloseTag(ofs, j, command_stack[j]);
3060 command_depth= cmd_depth;
3062 command_depth= cmd_depth;
3064 command_depth = command_base = cmd_depth;
3065 command_flag = true;
3067 command_stack[command_depth]= command_name;
3069 // treat label as a special case for
3070 // more WYSIWYM handling.
3071 if (par->GetChar(0) == LyXParagraph::META_INSET) {
3072 Inset * inset = par->GetInset(0);
3073 Inset::Code lyx_code = inset->LyxCode();
3074 if (lyx_code == Inset::LABEL_CODE){
3075 command_name += " id=\"";
3076 command_name += (static_cast<InsetCommand *>(inset))->getContents();
3077 command_name += "\"";
3082 sgmlOpenTag(ofs, depth + command_depth, command_name);
3083 item_name = "title";
3084 sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3087 case LATEX_ENVIRONMENT:
3088 case LATEX_ITEM_ENVIRONMENT:
3089 if (depth < par->depth) {
3091 environment_stack[depth].erase();
3094 if (environment_stack[depth] != style.latexname()) {
3095 environment_stack[depth] = style.latexname();
3096 environment_inner[depth] = "!-- --";
3097 sgmlOpenTag(ofs, depth + command_depth,
3098 environment_stack[depth]);
3100 if(environment_inner[depth] != "!-- --") {
3101 item_name= "listitem";
3103 command_depth + depth,
3105 if (environment_inner[depth] == "varlistentry")
3107 depth + command_depth,
3108 environment_inner[depth]);
3112 if(style.latextype == LATEX_ENVIRONMENT) {
3113 if(!style.latexparam().empty())
3114 sgmlOpenTag(ofs, depth + command_depth,
3115 style.latexparam());
3119 desc_on = (style.labeltype == LABEL_MANUAL);
3122 environment_inner[depth]= "varlistentry";
3124 environment_inner[depth]= "listitem";
3126 sgmlOpenTag(ofs, depth + 1 + command_depth,
3127 environment_inner[depth]);
3131 sgmlOpenTag(ofs, depth + 1 + command_depth,
3135 sgmlOpenTag(ofs, depth + 1 + command_depth,
3140 sgmlOpenTag(ofs, depth + command_depth,
3149 SimpleDocBookOnePar(ofs, extra_par, par, desc_on,
3150 depth + 1 + command_depth);
3153 DocBookHandleFootnote(ofs, par,
3154 depth + 1 + command_depth);
3156 while(par && par->IsDummy());
3159 // write closing SGML tags
3160 switch(style.latextype) {
3163 sgmlCloseTag(ofs, depth + command_depth, end_tag);
3165 case LATEX_ENVIRONMENT:
3166 if(!style.latexparam().empty())
3167 sgmlCloseTag(ofs, depth + command_depth,
3168 style.latexparam());
3170 case LATEX_ITEM_ENVIRONMENT:
3171 if(desc_on == 1) break;
3173 sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3175 case LATEX_PARAGRAPH:
3176 if(style.latexname() != "dummy")
3177 sgmlCloseTag(ofs, depth + command_depth,
3181 sgmlCloseTag(ofs, depth + command_depth,
3188 for(; depth >= 0; --depth) {
3189 if(!environment_stack[depth].empty()) {
3190 if(environment_inner[depth] != "!-- --") {
3191 item_name= "listitem";
3192 sgmlCloseTag(ofs, command_depth + depth,
3194 if( environment_inner[depth] == "varlistentry")
3195 sgmlCloseTag(ofs, depth + command_depth,
3196 environment_inner[depth]);
3199 sgmlCloseTag(ofs, depth + command_depth,
3200 environment_stack[depth]);
3204 for(int j = command_depth; j >= command_base; --j)
3205 if(!command_stack[j].empty())
3206 sgmlCloseTag(ofs, j, command_stack[j]);
3210 sgmlCloseTag(ofs, 0, top_element);
3214 // How to check for successful close
3218 void Buffer::SimpleDocBookOnePar(ostream & os, string & extra,
3219 LyXParagraph * par, int & desc_on,
3222 bool emph_flag = false;
3224 LyXLayout const & style = textclasslist.Style(params.textclass,
3227 LyXParagraph::size_type main_body;
3228 if (style.labeltype != LABEL_MANUAL)
3231 main_body = par->BeginningOfMainBody();
3233 // gets paragraph main font
3234 LyXFont font1 = main_body > 0 ? style.labelfont : style.font;
3236 int char_line_count = depth;
3237 if(!style.free_spacing)
3238 for (int j = 0; j < depth; ++j)
3241 // parsing main loop
3242 for (LyXParagraph::size_type i = 0;
3243 i < par->size(); ++i) {
3244 LyXFont font2 = par->getFont(params, i);
3246 // handle <emphasis> tag
3247 if (font1.emph() != font2.emph() && i) {
3248 if (font2.emph() == LyXFont::ON) {
3252 os << "</emphasis>";
3257 char c = par->GetChar(i);
3259 if (c == LyXParagraph::META_INSET) {
3260 Inset * inset = par->GetInset(i);
3261 std::ostringstream ost;
3262 inset->DocBook(this, ost);
3263 string tmp_out = ost.str().c_str();
3266 // This code needs some explanation:
3267 // Two insets are treated specially
3268 // label if it is the first element in a command paragraph
3270 // graphics inside tables or figure floats can't go on
3271 // title (the equivalente in latex for this case is caption
3272 // and title should come first
3275 if(desc_on!= 3 || i!= 0) {
3276 if(!tmp_out.empty() && tmp_out[0] == '@') {
3278 extra += frontStrip(tmp_out, '@');
3280 os << frontStrip(tmp_out, '@');
3285 } else if (font2.latex() == LyXFont::ON) {
3286 // "TeX"-Mode on ==> SGML-Mode on.
3292 if (par->linuxDocConvertChar(c, sgml_string)
3293 && !style.free_spacing) { // in freespacing
3295 // non-breaking characters
3299 os << "\n</term><listitem><para>";
3311 // needed if there is an optional argument but no contents
3312 if (main_body > 0 && main_body == par->size()) {
3316 os << "</emphasis>";
3319 // resets description flag correctly
3322 // <term> not closed...
3330 // This should be enabled when the Chktex class is implemented. (Asger)
3331 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3332 // Other flags: -wall -v0 -x
3333 int Buffer::runChktex()
3335 if (!users->text) return 0;
3337 ProhibitInput(users);
3339 // get LaTeX-Filename
3340 string const name = getLatexName();
3341 string path = OnlyPath(filename);
3343 string const org_path = path;
3344 if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3348 Path p(path); // path to LaTeX file
3349 users->owner()->getMiniBuffer()->Set(_("Running chktex..."));
3351 // Remove all error insets
3352 bool const removedErrorInsets = users->removeAutoInsets();
3354 // Generate the LaTeX file if neccessary
3355 makeLaTeXFile(name, org_path, false);
3358 Chktex chktex(lyxrc.chktex_command, name, filepath);
3359 int res = chktex.run(terr); // run chktex
3362 WriteAlert(_("chktex did not work!"),
3363 _("Could not run with file:"), name);
3364 } else if (res > 0) {
3365 // Insert all errors as errors boxes
3366 users->insertErrors(terr);
3369 // if we removed error insets before we ran chktex or if we inserted
3370 // error insets after we ran chktex, this must be run:
3371 if (removedErrorInsets || res){
3373 users->fitCursor(users->text);
3381 void Buffer::validate(LaTeXFeatures & features) const
3383 LyXParagraph * par = paragraph;
3384 LyXTextClass const & tclass =
3385 textclasslist.TextClass(params.textclass);
3387 // AMS Style is at document level
3389 features.amsstyle = (params.use_amsmath ||
3390 tclass.provides(LyXTextClass::amsmath));
3393 // We don't use "lyxerr.debug" because of speed. (Asger)
3394 if (lyxerr.debugging(Debug::LATEX))
3395 lyxerr << "Paragraph: " << par << endl;
3397 // Now just follow the list of paragraphs and run
3398 // validate on each of them.
3399 par->validate(features);
3401 // and then the next paragraph
3405 // the bullet shapes are buffer level not paragraph level
3406 // so they are tested here
3407 for (int i = 0; i < 4; ++i) {
3408 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3409 int const font = params.user_defined_bullets[i].getFont();
3411 int const c = params
3412 .user_defined_bullets[i]
3419 features.latexsym = true;
3421 } else if (font == 1) {
3422 features.amssymb = true;
3423 } else if ((font >= 2 && font <= 5)) {
3424 features.pifont = true;
3429 if (lyxerr.debugging(Debug::LATEX)) {
3430 features.showStruct();
3435 void Buffer::setPaperStuff()
3437 params.papersize = BufferParams::PAPER_DEFAULT;
3438 char const c1 = params.paperpackage;
3439 if (c1 == BufferParams::PACKAGE_NONE) {
3440 char const c2 = params.papersize2;
3441 if (c2 == BufferParams::VM_PAPER_USLETTER)
3442 params.papersize = BufferParams::PAPER_USLETTER;
3443 else if (c2 == BufferParams::VM_PAPER_USLEGAL)
3444 params.papersize = BufferParams::PAPER_LEGALPAPER;
3445 else if (c2 == BufferParams::VM_PAPER_USEXECUTIVE)
3446 params.papersize = BufferParams::PAPER_EXECUTIVEPAPER;
3447 else if (c2 == BufferParams::VM_PAPER_A3)
3448 params.papersize = BufferParams::PAPER_A3PAPER;
3449 else if (c2 == BufferParams::VM_PAPER_A4)
3450 params.papersize = BufferParams::PAPER_A4PAPER;
3451 else if (c2 == BufferParams::VM_PAPER_A5)
3452 params.papersize = BufferParams::PAPER_A5PAPER;
3453 else if ((c2 == BufferParams::VM_PAPER_B3) || (c2 == BufferParams::VM_PAPER_B4) ||
3454 (c2 == BufferParams::VM_PAPER_B5))
3455 params.papersize = BufferParams::PAPER_B5PAPER;
3456 } else if ((c1 == BufferParams::PACKAGE_A4) || (c1 == BufferParams::PACKAGE_A4WIDE) ||
3457 (c1 == BufferParams::PACKAGE_WIDEMARGINSA4))
3458 params.papersize = BufferParams::PAPER_A4PAPER;
3462 // This function should be in Buffer because it's a buffer's property (ale)
3463 string const Buffer::getIncludeonlyList(char delim)
3466 for (inset_iterator it = inset_iterator_begin();
3467 it != inset_iterator_end(); ++it) {
3468 if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3469 InsetInclude * insetinc =
3470 static_cast<InsetInclude *>(*it);
3471 if (insetinc->isInclude()
3472 && insetinc->isNoLoad()) {
3475 lst += OnlyFilename(ChangeExtension(insetinc->getContents(), string()));
3479 lyxerr.debug() << "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 vector<vector<Buffer::TocItem> > const Buffer::getTocList()
3507 vector<vector<TocItem> > l(4);
3508 LyXParagraph * par = paragraph;
3511 if (par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
3512 if (textclasslist.Style(params.textclass,
3513 par->GetLayout()).labeltype
3514 == LABEL_SENSITIVE) {
3518 tmp.str = par->String(this, false);
3519 switch (par->footnotekind) {
3520 case LyXParagraph::FIG:
3521 case LyXParagraph::WIDE_FIG:
3522 l[TOC_LOF].push_back(tmp);
3524 case LyXParagraph::TAB:
3525 case LyXParagraph::WIDE_TAB:
3526 l[TOC_LOT].push_back(tmp);
3528 case LyXParagraph::ALGORITHM:
3529 l[TOC_LOA].push_back(tmp);
3531 case LyXParagraph::FOOTNOTE:
3532 case LyXParagraph::MARGIN:
3536 } else if (!par->IsDummy()) {
3538 char const labeltype =
3539 textclasslist.Style(params.textclass,
3540 par->GetLayout()).labeltype;
3542 if (labeltype >= LABEL_COUNTER_CHAPTER
3543 && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3544 // insert this into the table of contents
3549 textclasslist.TextClass(params.textclass).maxcounter());
3550 tmp.str = par->String(this, true);
3551 l[TOC_TOC].push_back(tmp);
3562 // This is also a buffer property (ale)
3563 vector<pair<string,string> > const Buffer::getBibkeyList()
3565 /// if this is a child document and the parent is already loaded
3566 /// Use the parent's list instead [ale990412]
3567 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3568 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3570 return tmp->getBibkeyList();
3573 vector<pair<string, string> > keys;
3574 LyXParagraph * par = paragraph;
3577 keys.push_back(pair<string, string>(par->bibkey->getContents(),
3578 par->String(this, false)));
3582 // Might be either using bibtex or a child has bibliography
3584 for (inset_iterator it = inset_iterator_begin();
3585 it != inset_iterator_end(); ++it) {
3586 // Search for Bibtex or Include inset
3587 if ((*it)->LyxCode() == Inset::BIBTEX_CODE) {
3588 vector<pair<string,string> > tmp =
3589 static_cast<InsetBibtex*>(*it)->getKeys(this);
3590 keys.insert(keys.end(), tmp.begin(), tmp.end());
3591 } else if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3592 vector<pair<string,string> > const tmp =
3593 static_cast<InsetInclude*>(*it)->getKeys();
3594 keys.insert(keys.end(), tmp.begin(), tmp.end());
3603 bool Buffer::isDepClean(string const & name) const
3605 DEPCLEAN * item = dep_clean;
3606 while (item && item->master != name)
3608 if (!item) return true;
3613 void Buffer::markDepClean(string const & name)
3616 dep_clean = new DEPCLEAN;
3617 dep_clean->clean = true;
3618 dep_clean->master = name;
3619 dep_clean->next = 0;
3621 DEPCLEAN * item = dep_clean;
3622 while (item && item->master != name)
3627 item = new DEPCLEAN;
3629 item->master = name;
3636 bool Buffer::Dispatch(string const & command)
3638 // Split command string into command and argument
3640 string line = frontStrip(command);
3641 string const arg = strip(frontStrip(split(line, cmd, ' ')));
3643 return Dispatch(lyxaction.LookupFunc(cmd), arg);
3647 bool Buffer::Dispatch(int action, string const & argument)
3649 bool dispatched = true;
3652 Exporter::Export(this, argument, false);
3662 void Buffer::resize()
3664 /// resize the BufferViews!
3670 void Buffer::resizeInsets(BufferView * bv)
3672 /// then remove all LyXText in text-insets
3673 LyXParagraph * par = paragraph;
3674 for(; par; par = par->next) {
3675 par->resizeInsetsLyXText(bv);
3679 void Buffer::ChangeLanguage(Language const * from, Language const * to)
3682 LyXParagraph * par = paragraph;
3684 par->ChangeLanguage(params, from, to);
3690 bool Buffer::isMultiLingual()
3692 LyXParagraph * par = paragraph;
3694 if (par->isMultiLingual(params))
3702 Buffer::inset_iterator::inset_iterator(LyXParagraph * paragraph,
3703 LyXParagraph::size_type pos)
3706 it = par->InsetIterator(pos);
3707 if (it == par->inset_iterator_end()) {
3714 void Buffer::inset_iterator::SetParagraph()
3717 it = par->inset_iterator_begin();
3718 if (it != par->inset_iterator_end())
3723 // We maintain an invariant that whenever par = 0 then it = 0