1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * This file is Copyright 1996-2001
12 * ======================================================
18 #pragma implementation
22 #include "bufferlist.h"
23 #include "LyXAction.h"
26 #include "tex-strings.h"
28 #include "bufferview_funcs.h"
34 #include "LaTeXFeatures.h"
41 #include "converter.h"
42 #include "BufferView.h"
43 #include "ParagraphParameters.h"
44 #include "iterators.h"
45 #include "lyxtextclasslist.h"
47 #include "paragraph_funcs.h"
49 #include "frontends/LyXView.h"
51 #include "mathed/formulamacro.h"
52 #include "mathed/formula.h"
54 #include "insets/inset.h"
55 #include "insets/inseterror.h"
56 #include "insets/insetlabel.h"
57 #include "insets/insetref.h"
58 #include "insets/inseturl.h"
59 #include "insets/insetnote.h"
60 #include "insets/insetquotes.h"
61 #include "insets/insetlatexaccent.h"
62 #include "insets/insetbib.h"
63 #include "insets/insetcite.h"
64 #include "insets/insetexternal.h"
65 #include "insets/insetindex.h"
66 #include "insets/insetinclude.h"
67 #include "insets/insettoc.h"
68 #include "insets/insetparent.h"
69 #include "insets/insetspecialchar.h"
70 #include "insets/insettext.h"
71 #include "insets/insetert.h"
72 #include "insets/insetgraphics.h"
73 #include "insets/insetfoot.h"
74 #include "insets/insetmarginal.h"
75 #include "insets/insetoptarg.h"
76 #include "insets/insetminipage.h"
77 #include "insets/insetfloat.h"
78 #include "insets/insetwrap.h"
79 #include "insets/insettabular.h"
81 #include "insets/insettheorem.h"
82 #include "insets/insetlist.h"
84 #include "insets/insetcaption.h"
85 #include "insets/insetfloatlist.h"
87 #include "frontends/Dialogs.h"
88 #include "frontends/Alert.h"
90 #include "graphics/Previews.h"
92 #include "support/textutils.h"
93 #include "support/filetools.h"
94 #include "support/path.h"
95 #include "support/os.h"
96 #include "support/lyxlib.h"
97 #include "support/FileInfo.h"
98 #include "support/lyxmanip.h"
99 #include "support/lyxalgo.h" // for lyx::count
101 #include <boost/bind.hpp>
102 #include <boost/tuple/tuple.hpp>
114 #include <sys/types.h>
121 #ifndef CXX_GLOBAL_CSTD
133 using std::make_pair;
143 using lyx::textclass_type;
145 // all these externs should eventually be removed.
146 extern BufferList bufferlist;
150 const int LYX_FORMAT = 221;
154 Buffer::Buffer(string const & file, bool ronly)
155 : niceFile(true), lyx_clean(true), bak_clean(true),
156 unnamed(false), dep_clean(0), read_only(ronly),
157 filename_(file), users(0)
159 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
160 filepath_ = OnlyPath(file);
162 if (read_only || lyxrc.use_tempdir) {
163 tmppath = CreateBufferTmpDir();
172 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
173 // here the buffer should take care that it is
174 // saved properly, before it goes into the void.
176 // make sure that views using this buffer
181 if (!tmppath.empty()) {
182 DestroyBufferTmpDir(tmppath);
187 // Remove any previewed LaTeX snippets assocoated with this buffer.
188 grfx::Previews::get().removeLoader(this);
192 string const Buffer::getLatexName(bool no_path) const
194 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
196 return OnlyFilename(name);
202 pair<Buffer::LogType, string> const Buffer::getLogName(void) const
204 string const filename = getLatexName(false);
206 if (filename.empty())
207 return make_pair(Buffer::latexlog, string());
209 string path = OnlyPath(filename);
211 if (lyxrc.use_tempdir || !IsDirWriteable(path))
214 string const fname = AddName(path,
215 OnlyFilename(ChangeExtension(filename,
218 AddName(path, OnlyFilename(
219 ChangeExtension(filename,
220 formats.extension("literate") + ".out")));
222 // If no Latex log or Build log is newer, show Build log
224 FileInfo const f_fi(fname);
225 FileInfo const b_fi(bname);
228 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
229 lyxerr[Debug::FILES] << "Log name calculated as : " << bname << endl;
230 return make_pair(Buffer::buildlog, bname);
232 lyxerr[Debug::FILES] << "Log name calculated as : " << fname << endl;
233 return make_pair(Buffer::latexlog, fname);
237 void Buffer::setReadonly(bool flag)
239 if (read_only != flag) {
242 users->owner()->getDialogs().updateBufferDependent(false);
247 /// Update window titles of all users
248 // Should work on a list
249 void Buffer::updateTitles() const
252 users->owner()->updateWindowTitle();
256 /// Reset autosave timer of all users
257 // Should work on a list
258 void Buffer::resetAutosaveTimers() const
261 users->owner()->resetAutosaveTimer();
265 void Buffer::setFileName(string const & newfile)
267 filename_ = MakeAbsPath(newfile);
268 filepath_ = OnlyPath(filename_);
269 setReadonly(IsFileWriteable(filename_) == 0);
274 // We'll remove this later. (Lgb)
277 string last_inset_read;
280 #warning And _why_ is this here? (Lgb)
288 // candidate for move to BufferView
289 // (at least some parts in the beginning of the func)
292 // changed to be public and have one parameter
293 // if par = 0 normal behavior
294 // else insert behavior
295 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
296 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
302 Paragraph::depth_type depth = 0;
303 bool the_end_read = false;
305 Paragraph * first_par = 0;
306 LyXFont font(LyXFont::ALL_INHERIT, params.language);
309 if (file_format < 216 && params.language->lang() == "hebrew")
310 font.setLanguage(default_language);
315 par->layout(params.getLyXTextClass().defaultLayout());
317 // We are inserting into an existing document
318 users->text->breakParagraph(users);
319 first_par = users->text->ownerParagraph();
322 // We don't want to adopt the parameters from the
323 // document we insert, so we skip until the text begins:
326 string const pretoken = lex.getString();
327 if (pretoken == "\\layout") {
328 lex.pushToken(pretoken);
336 string const token = lex.getString();
338 if (token.empty()) continue;
340 lyxerr[Debug::PARSER] << "Handling token: `"
341 << token << "'" << endl;
344 parseSingleLyXformat2Token(lex, par, first_par,
352 paragraphs.set(first_par);
354 if (unknown_layouts > 0) {
355 string s = _("Couldn't set the layout for ");
356 if (unknown_layouts == 1) {
357 s += _("one paragraph");
359 s += tostr(unknown_layouts);
360 s += _(" paragraphs");
362 Alert::alert(_("Textclass Loading Error!"), s,
363 _("When reading " + fileName()));
366 if (unknown_tokens > 0) {
367 string s = _("Encountered ");
368 if (unknown_tokens == 1) {
369 s += _("one unknown token");
371 s += tostr(unknown_tokens);
372 s += _(" unknown tokens");
374 Alert::alert(_("Textclass Loading Error!"), s,
375 _("When reading " + fileName()));
383 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
384 Paragraph *& first_par,
385 string const & token, int & pos,
386 Paragraph::depth_type & depth,
390 bool the_end_read = false;
392 // The order of the tags tested may seem unnatural, but this
393 // has been done in order to reduce the number of string
394 // comparisons needed to recognize a given token. This leads
395 // on large documents like UserGuide to a reduction of a
397 if (token[0] != '\\') {
398 for (string::const_iterator cit = token.begin();
399 cit != token.end(); ++cit) {
400 par->insertChar(pos, (*cit), font);
403 } else if (token == "\\layout") {
404 // reset the font as we start a new layout and if the font is
405 // not ALL_INHERIT,document_language then it will be set to the
406 // right values after this tag (Jug 20020420)
407 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
410 if (file_format < 216 && params.language->lang() == "hebrew")
411 font.setLanguage(default_language);
415 string layoutname = lex.getString();
417 LyXTextClass const & tclass = params.getLyXTextClass();
419 if (layoutname.empty()) {
420 layoutname = tclass.defaultLayoutName();
422 bool hasLayout = tclass.hasLayout(layoutname);
424 lyxerr << "Layout '" << layoutname << "' does not"
425 << " exist in textclass '" << tclass.name()
427 lyxerr << "Trying to use default layout instead."
429 layoutname = tclass.defaultLayoutName();
433 // The is the compability reading of layout caption.
434 // It can be removed in LyX version 1.3.0. (Lgb)
435 if (compare_ascii_no_case(layoutname, "caption") == 0) {
436 // We expect that the par we are now working on is
437 // really inside a InsetText inside a InsetFloat.
438 // We also know that captions can only be
439 // one paragraph. (Lgb)
441 // We should now read until the next "\layout"
443 // This is probably not good enough, what if the
444 // caption is the last par in the document (Lgb)
445 istream & ist = lex.getStream();
451 if (prefixIs(line, "\\layout")) {
455 if (prefixIs(line, "\\begin_inset"))
457 if (prefixIs(line, "\\end_inset")) {
468 // Now we should have the whole layout in ss
469 // we should now be able to give this to the
471 ss << "\\end_inset\n";
473 // This seems like a bug in stringstream.
474 // We really should be able to use ss
476 istringstream is(ss.str());
478 tmplex.setStream(is);
479 Inset * inset = new InsetCaption;
480 inset->Read(this, tmplex);
481 par->InsertInset(pos, inset, font);
488 par = new Paragraph(par);
489 par->layout(params.getLyXTextClass().defaultLayout());
492 par->layout(params.getLyXTextClass()[layoutname]);
493 // Test whether the layout is obsolete.
494 LyXLayout_ptr const & layout = par->layout();
495 if (!layout->obsoleted_by().empty())
496 par->layout(params.getLyXTextClass()[layout->obsoleted_by()]);
497 par->params().depth(depth);
502 } else if (token == "\\end_inset") {
503 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
504 << "Last inset read was: " << last_inset_read
506 // Simply ignore this. The insets do not have
508 // But insets should read it, it is a part of
509 // the inset isn't it? Lgb.
510 } else if (token == "\\begin_inset") {
511 readInset(lex, par, pos, font);
512 } else if (token == "\\family") {
514 font.setLyXFamily(lex.getString());
515 } else if (token == "\\series") {
517 font.setLyXSeries(lex.getString());
518 } else if (token == "\\shape") {
520 font.setLyXShape(lex.getString());
521 } else if (token == "\\size") {
523 font.setLyXSize(lex.getString());
524 } else if (token == "\\lang") {
526 string const tok = lex.getString();
527 Language const * lang = languages.getLanguage(tok);
529 font.setLanguage(lang);
531 font.setLanguage(params.language);
532 lex.printError("Unknown language `$$Token'");
534 } else if (token == "\\numeric") {
536 font.setNumber(font.setLyXMisc(lex.getString()));
537 } else if (token == "\\emph") {
539 font.setEmph(font.setLyXMisc(lex.getString()));
540 } else if (token == "\\bar") {
542 string const tok = lex.getString();
543 // This is dirty, but gone with LyX3. (Asger)
545 font.setUnderbar(LyXFont::ON);
546 else if (tok == "no")
547 font.setUnderbar(LyXFont::OFF);
548 else if (tok == "default")
549 font.setUnderbar(LyXFont::INHERIT);
551 lex.printError("Unknown bar font flag "
553 } else if (token == "\\noun") {
555 font.setNoun(font.setLyXMisc(lex.getString()));
556 } else if (token == "\\color") {
558 font.setLyXColor(lex.getString());
559 } else if (token == "\\SpecialChar") {
560 LyXLayout_ptr const & layout = par->layout();
562 // Insets don't make sense in a free-spacing context! ---Kayvan
563 if (layout->free_spacing || par->isFreeSpacing()) {
566 string next_token = lex.getString();
567 if (next_token == "\\-") {
568 par->insertChar(pos, '-', font);
569 } else if (next_token == "\\protected_separator"
570 || next_token == "~") {
571 par->insertChar(pos, ' ', font);
573 lex.printError("Token `$$Token' "
575 "paragraph layout!");
580 Inset * inset = new InsetSpecialChar;
581 inset->read(this, lex);
582 par->insertInset(pos, inset, font);
585 } else if (token == "\\i") {
586 Inset * inset = new InsetLatexAccent;
587 inset->read(this, lex);
588 par->insertInset(pos, inset, font);
590 } else if (token == "\\backslash") {
591 par->insertChar(pos, '\\', font);
593 } else if (token == "\\begin_deeper") {
595 } else if (token == "\\end_deeper") {
597 lex.printError("\\end_deeper: "
598 "depth is already null");
602 } else if (token == "\\begin_preamble") {
603 params.readPreamble(lex);
604 } else if (token == "\\textclass") {
606 pair<bool, textclass_type> pp =
607 textclasslist.NumberOfClass(lex.getString());
609 params.textclass = pp.second;
611 Alert::alert(string(_("Textclass error")),
612 string(_("The document uses an unknown textclass \"")) +
613 lex.getString() + string("\"."),
614 string(_("LyX will not be able to produce output correctly.")));
615 params.textclass = 0;
617 if (!params.getLyXTextClass().load()) {
618 // if the textclass wasn't loaded properly
619 // we need to either substitute another
620 // or stop loading the file.
621 // I can substitute but I don't see how I can
622 // stop loading... ideas?? ARRae980418
623 Alert::alert(_("Textclass Loading Error!"),
624 string(_("Can't load textclass ")) +
625 params.getLyXTextClass().name(),
626 _("-- substituting default"));
627 params.textclass = 0;
629 } else if (token == "\\options") {
631 params.options = lex.getString();
632 } else if (token == "\\language") {
633 params.readLanguage(lex);
634 } else if (token == "\\fontencoding") {
636 } else if (token == "\\inputencoding") {
638 params.inputenc = lex.getString();
639 } else if (token == "\\graphics") {
640 params.readGraphicsDriver(lex);
641 } else if (token == "\\fontscheme") {
643 params.fonts = lex.getString();
644 } else if (token == "\\noindent") {
645 par->params().noindent(true);
646 } else if (token == "\\leftindent") {
648 LyXLength value(lex.getString());
649 par->params().leftIndent(value);
650 } else if (token == "\\fill_top") {
651 par->params().spaceTop(VSpace(VSpace::VFILL));
652 } else if (token == "\\fill_bottom") {
653 par->params().spaceBottom(VSpace(VSpace::VFILL));
654 } else if (token == "\\line_top") {
655 par->params().lineTop(true);
656 } else if (token == "\\line_bottom") {
657 par->params().lineBottom(true);
658 } else if (token == "\\pagebreak_top") {
659 par->params().pagebreakTop(true);
660 } else if (token == "\\pagebreak_bottom") {
661 par->params().pagebreakBottom(true);
662 } else if (token == "\\start_of_appendix") {
663 par->params().startOfAppendix(true);
664 } else if (token == "\\paragraph_separation") {
665 int tmpret = lex.findToken(string_paragraph_separation);
668 params.paragraph_separation =
669 static_cast<BufferParams::PARSEP>(tmpret);
670 } else if (token == "\\defskip") {
672 params.defskip = VSpace(lex.getString());
673 } else if (token == "\\quotes_language") {
674 int tmpret = lex.findToken(string_quotes_language);
677 InsetQuotes::quote_language tmpl =
678 InsetQuotes::EnglishQ;
681 tmpl = InsetQuotes::EnglishQ;
684 tmpl = InsetQuotes::SwedishQ;
687 tmpl = InsetQuotes::GermanQ;
690 tmpl = InsetQuotes::PolishQ;
693 tmpl = InsetQuotes::FrenchQ;
696 tmpl = InsetQuotes::DanishQ;
699 params.quotes_language = tmpl;
700 } else if (token == "\\quotes_times") {
702 switch (lex.getInteger()) {
704 params.quotes_times = InsetQuotes::SingleQ;
707 params.quotes_times = InsetQuotes::DoubleQ;
710 } else if (token == "\\papersize") {
711 int tmpret = lex.findToken(string_papersize);
715 params.papersize2 = tmpret;
716 } else if (token == "\\paperpackage") {
717 int tmpret = lex.findToken(string_paperpackages);
720 params.paperpackage = BufferParams::PACKAGE_NONE;
722 params.paperpackage = tmpret;
723 } else if (token == "\\use_geometry") {
725 params.use_geometry = lex.getInteger();
726 } else if (token == "\\use_amsmath") {
728 params.use_amsmath = lex.getInteger();
729 } else if (token == "\\use_natbib") {
731 params.use_natbib = lex.getInteger();
732 } else if (token == "\\use_numerical_citations") {
734 params.use_numerical_citations = lex.getInteger();
735 } else if (token == "\\paperorientation") {
736 int tmpret = lex.findToken(string_orientation);
740 static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
741 } else if (token == "\\paperwidth") {
743 params.paperwidth = lex.getString();
744 } else if (token == "\\paperheight") {
746 params.paperheight = lex.getString();
747 } else if (token == "\\leftmargin") {
749 params.leftmargin = lex.getString();
750 } else if (token == "\\topmargin") {
752 params.topmargin = lex.getString();
753 } else if (token == "\\rightmargin") {
755 params.rightmargin = lex.getString();
756 } else if (token == "\\bottommargin") {
758 params.bottommargin = lex.getString();
759 } else if (token == "\\headheight") {
761 params.headheight = lex.getString();
762 } else if (token == "\\headsep") {
764 params.headsep = lex.getString();
765 } else if (token == "\\footskip") {
767 params.footskip = lex.getString();
768 } else if (token == "\\paperfontsize") {
770 params.fontsize = rtrim(lex.getString());
771 } else if (token == "\\papercolumns") {
773 params.columns = lex.getInteger();
774 } else if (token == "\\papersides") {
776 switch (lex.getInteger()) {
778 case 1: params.sides = LyXTextClass::OneSide; break;
779 case 2: params.sides = LyXTextClass::TwoSides; break;
781 } else if (token == "\\paperpagestyle") {
783 params.pagestyle = rtrim(lex.getString());
784 } else if (token == "\\bullet") {
786 int const index = lex.getInteger();
788 int temp_int = lex.getInteger();
789 params.user_defined_bullets[index].setFont(temp_int);
790 params.temp_bullets[index].setFont(temp_int);
792 temp_int = lex.getInteger();
793 params.user_defined_bullets[index].setCharacter(temp_int);
794 params.temp_bullets[index].setCharacter(temp_int);
796 temp_int = lex.getInteger();
797 params.user_defined_bullets[index].setSize(temp_int);
798 params.temp_bullets[index].setSize(temp_int);
800 string const temp_str = lex.getString();
801 if (temp_str != "\\end_bullet") {
802 // this element isn't really necessary for
803 // parsing but is easier for humans
804 // to understand bullets. Put it back and
805 // set a debug message?
806 lex.printError("\\end_bullet expected, got" + temp_str);
807 //how can I put it back?
809 } else if (token == "\\bulletLaTeX") {
810 // The bullet class should be able to read this.
812 int const index = lex.getInteger();
814 string temp_str = lex.getString();
816 while (temp_str != "\\end_bullet") {
817 // this loop structure is needed when user
818 // enters an empty string since the first
819 // thing returned will be the \\end_bullet
821 // if the LaTeX entry has spaces. Each element
822 // therefore needs to be read in turn
825 temp_str = lex.getString();
828 params.user_defined_bullets[index].setText(sum_str);
829 params.temp_bullets[index].setText(sum_str);
830 } else if (token == "\\secnumdepth") {
832 params.secnumdepth = lex.getInteger();
833 } else if (token == "\\tocdepth") {
835 params.tocdepth = lex.getInteger();
836 } else if (token == "\\spacing") {
838 string const tmp = rtrim(lex.getString());
839 Spacing::Space tmp_space = Spacing::Default;
841 if (tmp == "single") {
842 tmp_space = Spacing::Single;
843 } else if (tmp == "onehalf") {
844 tmp_space = Spacing::Onehalf;
845 } else if (tmp == "double") {
846 tmp_space = Spacing::Double;
847 } else if (tmp == "other") {
849 tmp_space = Spacing::Other;
850 tmp_val = lex.getFloat();
852 lex.printError("Unknown spacing token: '$$Token'");
854 // Small hack so that files written with klyx will be
857 par->params().spacing(Spacing(tmp_space, tmp_val));
859 params.spacing.set(tmp_space, tmp_val);
861 } else if (token == "\\paragraph_spacing") {
863 string const tmp = rtrim(lex.getString());
864 if (tmp == "single") {
865 par->params().spacing(Spacing(Spacing::Single));
866 } else if (tmp == "onehalf") {
867 par->params().spacing(Spacing(Spacing::Onehalf));
868 } else if (tmp == "double") {
869 par->params().spacing(Spacing(Spacing::Double));
870 } else if (tmp == "other") {
872 par->params().spacing(Spacing(Spacing::Other,
875 lex.printError("Unknown spacing token: '$$Token'");
877 } else if (token == "\\float_placement") {
879 params.float_placement = lex.getString();
880 } else if (token == "\\align") {
881 int tmpret = lex.findToken(string_align);
882 if (tmpret == -1) ++tmpret;
883 int const tmpret2 = int(pow(2.0, tmpret));
884 par->params().align(LyXAlignment(tmpret2));
885 } else if (token == "\\added_space_top") {
887 VSpace value = VSpace(lex.getString());
888 // only add the length when value > 0 or
890 if ((value.length().len().value() != 0) ||
892 (value.kind() != VSpace::LENGTH))
893 par->params().spaceTop(value);
894 } else if (token == "\\added_space_bottom") {
896 VSpace value = VSpace(lex.getString());
897 // only add the length when value > 0 or
899 if ((value.length().len().value() != 0) ||
901 (value.kind() != VSpace::LENGTH))
902 par->params().spaceBottom(value);
903 } else if (token == "\\labelwidthstring") {
905 par->params().labelWidthString(lex.getString());
906 // do not delete this token, it is still needed!
907 } else if (token == "\\newline") {
908 par->insertChar(pos, Paragraph::META_NEWLINE, font);
910 } else if (token == "\\LyXTable") {
911 Inset * inset = new InsetTabular(*this);
912 inset->read(this, lex);
913 par->insertInset(pos, inset, font);
915 } else if (token == "\\hfill") {
916 par->insertChar(pos, Paragraph::META_HFILL, font);
918 } else if (token == "\\protected_separator") { // obsolete
919 // This is a backward compability thingie. (Lgb)
920 // Remove it later some time...introduced with fileformat
922 LyXLayout_ptr const & layout = par->layout();
924 if (layout->free_spacing || par->isFreeSpacing()) {
925 par->insertChar(pos, ' ', font);
927 Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
928 par->insertInset(pos, inset, font);
931 } else if (token == "\\bibitem") { // ale970302
933 InsetCommandParams p("bibitem", "dummy");
934 par->bibkey = new InsetBibKey(p);
936 par->bibkey->read(this, lex);
937 } else if (token == "\\the_end") {
940 // This should be insurance for the future: (Asger)
943 string const s = _("Unknown token: ") + token
944 + " " + lex.text() + "\n";
945 // we can do this here this way because we're actually reading
946 // the buffer and don't care about LyXText right now.
947 InsetError * new_inset = new InsetError(s);
948 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
956 // needed to insert the selection
957 void Buffer::insertStringAsLines(Paragraph *& par, pos_type & pos,
958 LyXFont const & fn,string const & str) const
960 LyXLayout_ptr const & layout = par->layout();
964 par->checkInsertChar(font);
965 // insert the string, don't insert doublespace
966 bool space_inserted = true;
967 bool autobreakrows = !par->inInset() ||
968 static_cast<InsetText *>(par->inInset())->getAutoBreakRows();
969 for(string::const_iterator cit = str.begin();
970 cit != str.end(); ++cit) {
972 if (autobreakrows && (!par->empty() || layout->keepempty)) {
973 breakParagraph(params, par, pos,
974 layout->isEnvironment());
977 space_inserted = true;
981 // do not insert consecutive spaces if !free_spacing
982 } else if ((*cit == ' ' || *cit == '\t') &&
983 space_inserted && !layout->free_spacing &&
984 !par->isFreeSpacing())
987 } else if (*cit == '\t') {
988 if (!layout->free_spacing && !par->isFreeSpacing()) {
989 // tabs are like spaces here
990 par->insertChar(pos, ' ', font);
992 space_inserted = true;
994 const pos_type nb = 8 - pos % 8;
995 for (pos_type a = 0; a < nb ; ++a) {
996 par->insertChar(pos, ' ', font);
999 space_inserted = true;
1001 } else if (!IsPrintable(*cit)) {
1002 // Ignore unprintables
1005 // just insert the character
1006 par->insertChar(pos, *cit, font);
1008 space_inserted = (*cit == ' ');
1015 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1016 int & pos, LyXFont & font)
1018 // consistency check
1019 if (lex.getString() != "\\begin_inset") {
1020 lyxerr << "Buffer::readInset: Consistency check failed."
1027 string const tmptok = lex.getString();
1028 last_inset_read = tmptok;
1030 // test the different insets
1031 if (tmptok == "LatexCommand") {
1032 InsetCommandParams inscmd;
1035 string const cmdName = inscmd.getCmdName();
1037 // This strange command allows LyX to recognize "natbib" style
1038 // citations: citet, citep, Citet etc.
1039 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
1040 inset = new InsetCitation(inscmd);
1041 } else if (cmdName == "bibitem") {
1042 lex.printError("Wrong place for bibitem");
1043 inset = new InsetBibKey(inscmd);
1044 } else if (cmdName == "BibTeX") {
1045 inset = new InsetBibtex(inscmd);
1046 } else if (cmdName == "index") {
1047 inset = new InsetIndex(inscmd);
1048 } else if (cmdName == "include") {
1049 inset = new InsetInclude(inscmd, *this);
1050 } else if (cmdName == "label") {
1051 inset = new InsetLabel(inscmd);
1052 } else if (cmdName == "url"
1053 || cmdName == "htmlurl") {
1054 inset = new InsetUrl(inscmd);
1055 } else if (cmdName == "ref"
1056 || cmdName == "pageref"
1057 || cmdName == "vref"
1058 || cmdName == "vpageref"
1059 || cmdName == "prettyref") {
1060 if (!inscmd.getOptions().empty()
1061 || !inscmd.getContents().empty()) {
1062 inset = new InsetRef(inscmd, *this);
1064 } else if (cmdName == "tableofcontents") {
1065 inset = new InsetTOC(inscmd);
1066 } else if (cmdName == "listofalgorithms") {
1067 inset = new InsetFloatList("algorithm");
1068 } else if (cmdName == "listoffigures") {
1069 inset = new InsetFloatList("figure");
1070 } else if (cmdName == "listoftables") {
1071 inset = new InsetFloatList("table");
1072 } else if (cmdName == "printindex") {
1073 inset = new InsetPrintIndex(inscmd);
1074 } else if (cmdName == "lyxparent") {
1075 inset = new InsetParent(inscmd, *this);
1078 bool alreadyread = false;
1079 if (tmptok == "Quotes") {
1080 inset = new InsetQuotes;
1081 } else if (tmptok == "External") {
1082 inset = new InsetExternal;
1083 } else if (tmptok == "FormulaMacro") {
1084 inset = new InsetFormulaMacro;
1085 } else if (tmptok == "Formula") {
1086 inset = new InsetFormula;
1087 } else if (tmptok == "Figure") { // Backward compatibility
1088 // inset = new InsetFig(100, 100, *this);
1089 inset = new InsetGraphics;
1090 } else if (tmptok == "Graphics") {
1091 inset = new InsetGraphics;
1092 } else if (tmptok == "Info") {// backwards compatibility
1093 inset = new InsetNote(this,
1094 lex.getLongString("\\end_inset"),
1097 } else if (tmptok == "Note") {
1098 inset = new InsetNote(params);
1099 } else if (tmptok == "Include") {
1100 InsetCommandParams p("Include");
1101 inset = new InsetInclude(p, *this);
1102 } else if (tmptok == "ERT") {
1103 inset = new InsetERT(params);
1104 } else if (tmptok == "Tabular") {
1105 inset = new InsetTabular(*this);
1106 } else if (tmptok == "Text") {
1107 inset = new InsetText(params);
1108 } else if (tmptok == "Foot") {
1109 inset = new InsetFoot(params);
1110 } else if (tmptok == "Marginal") {
1111 inset = new InsetMarginal(params);
1112 } else if (tmptok == "OptArg") {
1113 inset = new InsetOptArg(params);
1114 } else if (tmptok == "Minipage") {
1115 inset = new InsetMinipage(params);
1116 } else if (tmptok == "Float") {
1118 string tmptok = lex.getString();
1119 inset = new InsetFloat(params, tmptok);
1120 } else if (tmptok == "Wrap") {
1122 string tmptok = lex.getString();
1123 inset = new InsetWrap(params, tmptok);
1125 } else if (tmptok == "List") {
1126 inset = new InsetList;
1127 } else if (tmptok == "Theorem") {
1128 inset = new InsetList;
1130 } else if (tmptok == "Caption") {
1131 inset = new InsetCaption(params);
1132 } else if (tmptok == "FloatList") {
1133 inset = new InsetFloatList;
1136 if (inset && !alreadyread) inset->read(this, lex);
1140 par->insertInset(pos, inset, font);
1146 bool Buffer::readFile(LyXLex & lex, string const & filename, Paragraph * par)
1150 string const token(lex.getString());
1151 if (token == "\\lyxformat") { // the first token _must_ be...
1153 string tmp_format = lex.getString();
1154 //lyxerr << "LyX Format: `" << tmp_format << "'" << endl;
1155 // if present remove ".," from string.
1156 string::size_type dot = tmp_format.find_first_of(".,");
1157 //lyxerr << " dot found at " << dot << endl;
1158 if (dot != string::npos)
1159 tmp_format.erase(dot, 1);
1160 file_format = strToInt(tmp_format);
1161 //lyxerr << "format: " << file_format << endl;
1162 if (file_format == LYX_FORMAT) {
1164 } else if (file_format > LYX_FORMAT) {
1166 Alert::alert(_("Warning!"),
1167 _("The file was created with a newer version of"
1168 "LyX. This is likely to cause problems."));
1170 } else if (file_format < LYX_FORMAT) {
1172 if (file_format < 200) {
1173 Alert::alert(_("ERROR!"),
1174 _("Old LyX file format found. "
1175 "Use LyX 0.10.x to read this!"));
1177 } else if (!filename.empty()) {
1179 LibFileSearch("lyx2lyx", "lyx2lyx");
1180 if (command.empty()) {
1181 Alert::alert(_("ERROR!"),
1182 _("Can't find conversion script."));
1186 +tostr(LYX_FORMAT)+" "
1187 + QuoteName(filename);
1188 lyxerr[Debug::INFO] << "Running '"
1189 << command << "'" << endl;
1190 cmd_ret const ret = RunCommand(command);
1192 Alert::alert(_("ERROR!"),
1193 _("An error occured while "
1194 "running the conversion script."));
1197 istringstream is(ret.second);
1198 LyXLex tmplex(0, 0);
1199 tmplex.setStream(is);
1200 return readFile(tmplex, string());
1202 // This code is reached if lyx2lyx failed (for
1203 // some reason) to change the file format of
1209 bool the_end = readLyXformat2(lex, par);
1210 params.setPaperStuff();
1213 // the_end was added in 213
1214 if (file_format < 213)
1219 Alert::alert(_("Warning!"),
1220 _("Reading of document is not complete"),
1221 _("Maybe the document is truncated"));
1224 } else { // "\\lyxformat" not found
1225 Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1228 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1233 // Should probably be moved to somewhere else: BufferView? LyXView?
1234 bool Buffer::save() const
1236 // We don't need autosaves in the immediate future. (Asger)
1237 resetAutosaveTimers();
1241 if (lyxrc.make_backup) {
1242 s = fileName() + '~';
1243 if (!lyxrc.backupdir_path.empty())
1244 s = AddName(lyxrc.backupdir_path,
1245 subst(os::slashify_path(s),'/','!'));
1247 // Rename is the wrong way of making a backup,
1248 // this is the correct way.
1249 /* truss cp fil fil2:
1250 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
1251 stat("LyXVC.lyx", 0xEFFFF688) = 0
1252 open("LyXVC.lyx", O_RDONLY) = 3
1253 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1254 fstat(4, 0xEFFFF508) = 0
1255 fstat(3, 0xEFFFF508) = 0
1256 read(3, " # T h i s f i l e w".., 8192) = 5579
1257 write(4, " # T h i s f i l e w".., 5579) = 5579
1258 read(3, 0xEFFFD4A0, 8192) = 0
1261 chmod("LyXVC3.lyx", 0100644) = 0
1262 lseek(0, 0, SEEK_CUR) = 46440
1266 // Should probably have some more error checking here.
1267 // Doing it this way, also makes the inodes stay the same.
1268 // This is still not a very good solution, in particular we
1269 // might loose the owner of the backup.
1270 FileInfo finfo(fileName());
1271 if (finfo.exist()) {
1272 mode_t fmode = finfo.getMode();
1273 struct utimbuf times = {
1274 finfo.getAccessTime(),
1275 finfo.getModificationTime() };
1277 ifstream ifs(fileName().c_str());
1278 ofstream ofs(s.c_str(), ios::out|ios::trunc);
1283 ::chmod(s.c_str(), fmode);
1285 if (::utime(s.c_str(), ×)) {
1286 lyxerr << "utime error." << endl;
1289 lyxerr << "LyX was not able to make "
1290 "backup copy. Beware." << endl;
1295 if (writeFile(fileName())) {
1297 removeAutosaveFile(fileName());
1299 // Saving failed, so backup is not backup
1300 if (lyxrc.make_backup) {
1301 lyx::rename(s, fileName());
1309 bool Buffer::writeFile(string const & fname) const
1311 if (read_only && (fname == fileName())) {
1315 FileInfo finfo(fname);
1316 if (finfo.exist() && !finfo.writable()) {
1320 ofstream ofs(fname.c_str());
1326 // Use the standard "C" locale for file output.
1327 ofs.imbue(std::locale::classic());
1330 // The top of the file should not be written by params.
1332 // write out a comment in the top of the file
1333 ofs << '#' << lyx_docversion
1334 << " created this file. For more info see http://www.lyx.org/\n"
1335 << "\\lyxformat " << LYX_FORMAT << "\n";
1337 // now write out the buffer paramters.
1338 params.writeFile(ofs);
1340 Paragraph::depth_type depth = 0;
1342 // this will write out all the paragraphs
1343 // using recursive descent.
1344 ParagraphList::iterator pit = paragraphs.begin();
1345 ParagraphList::iterator pend = paragraphs.end();
1346 for (; pit != pend; ++pit)
1347 pit->write(this, ofs, params, depth);
1349 // Write marker that shows file is complete
1350 ofs << "\n\\the_end" << endl;
1354 // how to check if close went ok?
1355 // Following is an attempt... (BE 20001011)
1357 // good() returns false if any error occured, including some
1358 // formatting error.
1359 // bad() returns true if something bad happened in the buffer,
1360 // which should include file system full errors.
1367 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1369 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1381 pair<int, string> const addDepth(int depth, int ldepth)
1385 d += (ldepth - depth) * 2;
1386 return make_pair(d, string(d, ' '));
1392 string const Buffer::asciiParagraph(Paragraph const & par,
1393 unsigned int linelen,
1394 bool noparbreak) const
1396 ostringstream buffer;
1397 Paragraph::depth_type depth = 0;
1399 Paragraph::depth_type ltype_depth = 0;
1400 bool ref_printed = false;
1401 // if (!par->previous()) {
1403 // begins or ends a deeper area ?
1404 if (depth != par->params().depth()) {
1405 if (par->params().depth() > depth) {
1406 while (par->params().depth() > depth) {
1410 while (par->params().depth() < depth) {
1416 depth = par.params().depth();
1419 // First write the layout
1420 string const & tmp = par.layout()->name();
1421 if (compare_no_case(tmp, "itemize") == 0) {
1423 ltype_depth = depth + 1;
1424 } else if (compare_ascii_no_case(tmp, "enumerate") == 0) {
1426 ltype_depth = depth + 1;
1427 } else if (contains(ascii_lowercase(tmp), "ection")) {
1429 ltype_depth = depth + 1;
1430 } else if (contains(ascii_lowercase(tmp), "aragraph")) {
1432 ltype_depth = depth + 1;
1433 } else if (compare_ascii_no_case(tmp, "description") == 0) {
1435 ltype_depth = depth + 1;
1436 } else if (compare_ascii_no_case(tmp, "abstract") == 0) {
1439 } else if (compare_ascii_no_case(tmp, "bibliography") == 0) {
1447 /* maybe some vertical spaces */
1449 /* the labelwidthstring used in lists */
1453 /* some pagebreaks? */
1457 /* what about the alignment */
1459 // lyxerr << "Should this ever happen?" << endl;
1462 // linelen <= 0 is special and means we don't have paragraph breaks
1464 string::size_type currlinelen = 0;
1470 buffer << string(depth * 2, ' ');
1471 currlinelen += depth * 2;
1474 // we should probably change to the paragraph language in the
1475 // gettext here (if possible) so that strings are outputted in
1476 // the correct language! (20012712 Jug)
1480 case 4: // (Sub)Paragraph
1481 case 5: // Description
1485 buffer << _("Abstract") << "\n\n";
1488 string const abst = _("Abstract: ");
1490 currlinelen += abst.length();
1493 case 7: // Bibliography
1496 buffer << _("References") << "\n\n";
1499 string const refs = _("References: ");
1501 currlinelen += refs.length();
1509 string const parlab = par.params().labelString();
1510 buffer << parlab << " ";
1511 currlinelen += parlab.length() + 1;
1519 pair<int, string> p = addDepth(depth, ltype_depth);
1521 currlinelen += p.first;
1524 // this is to change the linebreak to do it by word a bit more
1525 // intelligent hopefully! (only in the case where we have a
1526 // max linelenght!) (Jug)
1530 for (pos_type i = 0; i < par.size(); ++i) {
1531 char c = par.getUChar(params, i);
1533 case Paragraph::META_INSET:
1535 Inset const * inset = par.getInset(i);
1539 currlinelen += word.length();
1542 if (inset->ascii(this, buffer, linelen)) {
1543 // to be sure it breaks paragraph
1544 currlinelen += linelen;
1550 case Paragraph::META_NEWLINE:
1552 buffer << word << "\n";
1555 pair<int, string> p = addDepth(depth,
1558 currlinelen = p.first;
1562 case Paragraph::META_HFILL:
1563 buffer << word << "\t";
1564 currlinelen += word.length() + 1;
1571 currlinelen + word.length() > linelen - 10) {
1573 pair<int, string> p =
1574 addDepth(depth, ltype_depth);
1576 currlinelen = p.first;
1579 buffer << word << ' ';
1580 currlinelen += word.length() + 1;
1587 lyxerr[Debug::INFO] <<
1588 "writeAsciiFile: NULL char in structure." << endl;
1590 if ((linelen > 0) &&
1591 (currlinelen + word.length()) > linelen)
1595 pair<int, string> p =
1596 addDepth(depth, ltype_depth);
1598 currlinelen = p.first;
1605 return buffer.str().c_str();
1609 void Buffer::writeFileAscii(string const & fname, int linelen)
1611 ofstream ofs(fname.c_str());
1613 Alert::err_alert(_("Error: Cannot write file:"), fname);
1616 writeFileAscii(ofs, linelen);
1620 void Buffer::writeFileAscii(ostream & os, int linelen)
1622 ParagraphList::iterator beg = paragraphs.begin();
1623 ParagraphList::iterator end = paragraphs.end();
1624 ParagraphList::iterator it = beg;
1625 for (; it != end; ++it) {
1626 os << asciiParagraph(*it, linelen, it == beg);
1635 void Buffer::makeLaTeXFile(string const & fname,
1636 string const & original_path,
1637 bool nice, bool only_body, bool only_preamble)
1639 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1641 ofstream ofs(fname.c_str());
1643 Alert::err_alert(_("Error: Cannot open file: "), fname);
1647 makeLaTeXFile(ofs, original_path, nice, only_body, only_preamble);
1651 lyxerr << "File was not closed properly." << endl;
1656 void Buffer::makeLaTeXFile(ostream & os,
1657 string const & original_path,
1658 bool nice, bool only_body, bool only_preamble)
1660 niceFile = nice; // this will be used by Insetincludes.
1662 // validate the buffer.
1663 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
1664 LaTeXFeatures features(params);
1666 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
1669 // The starting paragraph of the coming rows is the
1670 // first paragraph of the document. (Asger)
1671 texrow.start(&*(paragraphs.begin()), 0);
1673 if (!only_body && nice) {
1674 os << "%% " << lyx_docversion << " created this file. "
1675 "For more info, see http://www.lyx.org/.\n"
1676 "%% Do not edit unless you really know what "
1681 lyxerr[Debug::INFO] << "lyx header finished" << endl;
1682 // There are a few differences between nice LaTeX and usual files:
1683 // usual is \batchmode and has a
1684 // special input@path to allow the including of figures
1685 // with either \input or \includegraphics (what figinsets do).
1686 // input@path is set when the actual parameter
1687 // original_path is set. This is done for usual tex-file, but not
1688 // for nice-latex-file. (Matthias 250696)
1691 // code for usual, NOT nice-latex-file
1692 os << "\\batchmode\n"; // changed
1693 // from \nonstopmode
1696 if (!original_path.empty()) {
1697 string inputpath = os::external_path(original_path);
1698 subst(inputpath, "~", "\\string~");
1699 os << "\\makeatletter\n"
1700 << "\\def\\input@path{{"
1701 << inputpath << "/}}\n"
1702 << "\\makeatother\n";
1708 os << "\\documentclass";
1710 LyXTextClass const & tclass = params.getLyXTextClass();
1712 ostringstream options; // the document class options.
1714 if (tokenPos(tclass.opt_fontsize(),
1715 '|', params.fontsize) >= 0) {
1716 // only write if existing in list (and not default)
1717 options << params.fontsize << "pt,";
1721 if (!params.use_geometry &&
1722 (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1723 switch (params.papersize) {
1724 case BufferParams::PAPER_A4PAPER:
1725 options << "a4paper,";
1727 case BufferParams::PAPER_USLETTER:
1728 options << "letterpaper,";
1730 case BufferParams::PAPER_A5PAPER:
1731 options << "a5paper,";
1733 case BufferParams::PAPER_B5PAPER:
1734 options << "b5paper,";
1736 case BufferParams::PAPER_EXECUTIVEPAPER:
1737 options << "executivepaper,";
1739 case BufferParams::PAPER_LEGALPAPER:
1740 options << "legalpaper,";
1746 if (params.sides != tclass.sides()) {
1747 switch (params.sides) {
1748 case LyXTextClass::OneSide:
1749 options << "oneside,";
1751 case LyXTextClass::TwoSides:
1752 options << "twoside,";
1758 if (params.columns != tclass.columns()) {
1759 if (params.columns == 2)
1760 options << "twocolumn,";
1762 options << "onecolumn,";
1765 if (!params.use_geometry
1766 && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1767 options << "landscape,";
1769 // language should be a parameter to \documentclass
1771 ostringstream language_options;
1772 if (params.language->babel() == "hebrew"
1773 && default_language->babel() != "hebrew")
1774 // This seems necessary
1775 features.useLanguage(default_language);
1777 if (lyxrc.language_use_babel ||
1778 params.language->lang() != lyxrc.default_language ||
1779 features.hasLanguages()) {
1781 language_options << features.getLanguages();
1782 language_options << params.language->babel();
1783 if (lyxrc.language_global_options)
1784 options << language_options.str() << ',';
1787 // the user-defined options
1788 if (!params.options.empty()) {
1789 options << params.options << ',';
1792 string strOptions(options.str().c_str());
1793 if (!strOptions.empty()) {
1794 strOptions = rtrim(strOptions, ",");
1795 os << '[' << strOptions << ']';
1798 os << '{' << tclass.latexname() << "}\n";
1800 // end of \documentclass defs
1802 // font selection must be done before loading fontenc.sty
1803 // The ae package is not needed when using OT1 font encoding.
1804 if (params.fonts != "default" &&
1805 (params.fonts != "ae" || lyxrc.fontenc != "default")) {
1806 os << "\\usepackage{" << params.fonts << "}\n";
1808 if (params.fonts == "ae") {
1809 os << "\\usepackage{aecompl}\n";
1813 // this one is not per buffer
1814 if (lyxrc.fontenc != "default") {
1815 os << "\\usepackage[" << lyxrc.fontenc
1820 if (params.inputenc == "auto") {
1821 string const doc_encoding =
1822 params.language->encoding()->LatexName();
1824 // Create a list with all the input encodings used
1826 set<string> encodings = features.getEncodingSet(doc_encoding);
1828 os << "\\usepackage[";
1829 std::copy(encodings.begin(), encodings.end(),
1830 std::ostream_iterator<string>(os, ","));
1831 os << doc_encoding << "]{inputenc}\n";
1833 } else if (params.inputenc != "default") {
1834 os << "\\usepackage[" << params.inputenc
1839 // At the very beginning the text parameters.
1840 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1841 switch (params.paperpackage) {
1842 case BufferParams::PACKAGE_A4:
1843 os << "\\usepackage{a4}\n";
1846 case BufferParams::PACKAGE_A4WIDE:
1847 os << "\\usepackage{a4wide}\n";
1850 case BufferParams::PACKAGE_WIDEMARGINSA4:
1851 os << "\\usepackage[widemargins]{a4}\n";
1856 if (params.use_geometry) {
1857 os << "\\usepackage{geometry}\n";
1859 os << "\\geometry{verbose";
1860 if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1862 switch (params.papersize2) {
1863 case BufferParams::VM_PAPER_CUSTOM:
1864 if (!params.paperwidth.empty())
1865 os << ",paperwidth="
1866 << params.paperwidth;
1867 if (!params.paperheight.empty())
1868 os << ",paperheight="
1869 << params.paperheight;
1871 case BufferParams::VM_PAPER_USLETTER:
1872 os << ",letterpaper";
1874 case BufferParams::VM_PAPER_USLEGAL:
1875 os << ",legalpaper";
1877 case BufferParams::VM_PAPER_USEXECUTIVE:
1878 os << ",executivepaper";
1880 case BufferParams::VM_PAPER_A3:
1883 case BufferParams::VM_PAPER_A4:
1886 case BufferParams::VM_PAPER_A5:
1889 case BufferParams::VM_PAPER_B3:
1892 case BufferParams::VM_PAPER_B4:
1895 case BufferParams::VM_PAPER_B5:
1899 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1900 switch (lyxrc.default_papersize) {
1901 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1902 case BufferParams::PAPER_USLETTER:
1903 os << ",letterpaper";
1905 case BufferParams::PAPER_LEGALPAPER:
1906 os << ",legalpaper";
1908 case BufferParams::PAPER_EXECUTIVEPAPER:
1909 os << ",executivepaper";
1911 case BufferParams::PAPER_A3PAPER:
1914 case BufferParams::PAPER_A4PAPER:
1917 case BufferParams::PAPER_A5PAPER:
1920 case BufferParams::PAPER_B5PAPER:
1925 if (!params.topmargin.empty())
1926 os << ",tmargin=" << params.topmargin;
1927 if (!params.bottommargin.empty())
1928 os << ",bmargin=" << params.bottommargin;
1929 if (!params.leftmargin.empty())
1930 os << ",lmargin=" << params.leftmargin;
1931 if (!params.rightmargin.empty())
1932 os << ",rmargin=" << params.rightmargin;
1933 if (!params.headheight.empty())
1934 os << ",headheight=" << params.headheight;
1935 if (!params.headsep.empty())
1936 os << ",headsep=" << params.headsep;
1937 if (!params.footskip.empty())
1938 os << ",footskip=" << params.footskip;
1943 if (tokenPos(tclass.opt_pagestyle(),
1944 '|', params.pagestyle) >= 0) {
1945 if (params.pagestyle == "fancy") {
1946 os << "\\usepackage{fancyhdr}\n";
1949 os << "\\pagestyle{" << params.pagestyle << "}\n";
1953 if (params.secnumdepth != tclass.secnumdepth()) {
1954 os << "\\setcounter{secnumdepth}{"
1955 << params.secnumdepth
1959 if (params.tocdepth != tclass.tocdepth()) {
1960 os << "\\setcounter{tocdepth}{"
1966 if (params.paragraph_separation) {
1967 switch (params.defskip.kind()) {
1968 case VSpace::SMALLSKIP:
1969 os << "\\setlength\\parskip{\\smallskipamount}\n";
1971 case VSpace::MEDSKIP:
1972 os << "\\setlength\\parskip{\\medskipamount}\n";
1974 case VSpace::BIGSKIP:
1975 os << "\\setlength\\parskip{\\bigskipamount}\n";
1977 case VSpace::LENGTH:
1978 os << "\\setlength\\parskip{"
1979 << params.defskip.length().asLatexString()
1982 default: // should never happen // Then delete it.
1983 os << "\\setlength\\parskip{\\medskipamount}\n";
1988 os << "\\setlength\\parindent{0pt}\n";
1992 // Now insert the LyX specific LaTeX commands...
1994 // The optional packages;
1995 string preamble(features.getPackages());
1997 // this might be useful...
1998 preamble += "\n\\makeatletter\n";
2000 // Some macros LyX will need
2001 string tmppreamble(features.getMacros());
2003 if (!tmppreamble.empty()) {
2004 preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2005 "LyX specific LaTeX commands.\n"
2006 + tmppreamble + '\n';
2009 // the text class specific preamble
2010 tmppreamble = features.getTClassPreamble();
2011 if (!tmppreamble.empty()) {
2012 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2013 "Textclass specific LaTeX commands.\n"
2014 + tmppreamble + '\n';
2017 /* the user-defined preamble */
2018 if (!params.preamble.empty()) {
2019 preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2020 "User specified LaTeX commands.\n"
2021 + params.preamble + '\n';
2024 // Itemize bullet settings need to be last in case the user
2025 // defines their own bullets that use a package included
2026 // in the user-defined preamble -- ARRae
2027 // Actually it has to be done much later than that
2028 // since some packages like frenchb make modifications
2029 // at \begin{document} time -- JMarc
2031 for (int i = 0; i < 4; ++i) {
2032 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2033 if (bullets_def.empty())
2034 bullets_def="\\AtBeginDocument{\n";
2035 bullets_def += " \\renewcommand{\\labelitemi";
2037 // `i' is one less than the item to modify
2044 bullets_def += "ii";
2050 bullets_def += "}{" +
2051 params.user_defined_bullets[i].getText()
2056 if (!bullets_def.empty())
2057 preamble += bullets_def + "}\n\n";
2060 int(lyx::count(preamble.begin(), preamble.end(), '\n'));
2061 for (int j = 0; j != nlines; ++j) {
2065 // We try to load babel late, in case it interferes
2066 // with other packages.
2068 string tmp = lyxrc.language_package;
2069 if (!lyxrc.language_global_options
2070 && tmp == "\\usepackage{babel}")
2071 tmp = string("\\usepackage[") +
2072 language_options.str().c_str() +
2074 preamble += tmp + "\n";
2075 preamble += features.getBabelOptions();
2078 preamble += "\\makeatother\n";
2086 os << "\\begin{document}\n";
2089 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2091 if (!lyxrc.language_auto_begin) {
2092 os << subst(lyxrc.language_command_begin, "$$lang",
2093 params.language->babel())
2098 latexParagraphs(os, &*(paragraphs.begin()), 0, texrow);
2100 // add this just in case after all the paragraphs
2104 if (!lyxrc.language_auto_end) {
2105 os << subst(lyxrc.language_command_end, "$$lang",
2106 params.language->babel())
2112 os << "\\end{document}\n";
2115 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2117 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2121 // Just to be sure. (Asger)
2124 lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2125 lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2127 // we want this to be true outside previews (for insetexternal)
2133 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2135 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2136 Paragraph * endpar, TexRow & texrow,
2137 bool moving_arg) const
2139 bool was_title = false;
2140 bool already_title = false;
2143 while (par != endpar) {
2144 Inset * in = par->inInset();
2145 // well we have to check if we are in an inset with unlimited
2146 // length (all in one row) if that is true then we don't allow
2147 // any special options in the paragraph and also we don't allow
2148 // any environment other then "Standard" to be valid!
2149 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
2150 LyXLayout_ptr const & layout = par->layout();
2152 if (layout->intitle) {
2153 if (already_title) {
2154 lyxerr <<"Error in latexParagraphs: You"
2155 " should not mix title layouts"
2156 " with normal ones." << endl;
2159 } else if (was_title && !already_title) {
2160 ofs << "\\maketitle\n";
2162 already_title = true;
2166 if (layout->isEnvironment() ||
2167 !par->params().leftIndent().zero())
2169 par = par->TeXEnvironment(this, params, ofs, texrow);
2171 par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2174 par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2177 // It might be that we only have a title in this document
2178 if (was_title && !already_title) {
2179 ofs << "\\maketitle\n";
2185 bool Buffer::isLatex() const
2187 return params.getLyXTextClass().outputType() == LATEX;
2191 bool Buffer::isLinuxDoc() const
2193 return params.getLyXTextClass().outputType() == LINUXDOC;
2197 bool Buffer::isLiterate() const
2199 return params.getLyXTextClass().outputType() == LITERATE;
2203 bool Buffer::isDocBook() const
2205 return params.getLyXTextClass().outputType() == DOCBOOK;
2209 bool Buffer::isSGML() const
2211 LyXTextClass const & tclass = params.getLyXTextClass();
2213 return tclass.outputType() == LINUXDOC ||
2214 tclass.outputType() == DOCBOOK;
2218 int Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2219 string const & latexname) const
2221 if (!latexname.empty() && latexname != "!-- --") {
2223 os << string(" ",depth);
2224 os << "<" << latexname << ">";
2234 int Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2235 string const & latexname) const
2237 if (!latexname.empty() && latexname != "!-- --") {
2239 os << endl << string(" ",depth);
2240 os << "</" << latexname << ">";
2250 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2252 ofstream ofs(fname.c_str());
2255 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2259 niceFile = nice; // this will be used by included files.
2261 LaTeXFeatures features(params);
2267 LyXTextClass const & tclass = params.getLyXTextClass();
2269 string top_element = tclass.latexname();
2272 ofs << "<!doctype linuxdoc system";
2274 string preamble = params.preamble;
2275 const string name = nice ? ChangeExtension(filename_, ".sgml")
2277 preamble += features.getIncludedFiles(name);
2278 preamble += features.getLyXSGMLEntities();
2280 if (!preamble.empty()) {
2281 ofs << " [ " << preamble << " ]";
2285 if (params.options.empty())
2286 sgmlOpenTag(ofs, 0, false, top_element);
2288 string top = top_element;
2290 top += params.options;
2291 sgmlOpenTag(ofs, 0, false, top);
2295 ofs << "<!-- " << lyx_docversion
2296 << " created this file. For more info see http://www.lyx.org/"
2299 Paragraph::depth_type depth = 0; // paragraph depth
2300 Paragraph * par = &*(paragraphs.begin());
2302 vector<string> environment_stack(5);
2305 LyXLayout_ptr const & style = par->layout();
2306 // treat <toc> as a special case for compatibility with old code
2307 if (par->isInset(0)) {
2308 Inset * inset = par->getInset(0);
2309 Inset::Code lyx_code = inset->lyxCode();
2310 if (lyx_code == Inset::TOC_CODE) {
2311 string const temp = "toc";
2312 sgmlOpenTag(ofs, depth, false, temp);
2319 // environment tag closing
2320 for (; depth > par->params().depth(); --depth) {
2321 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2322 environment_stack[depth].erase();
2325 // write opening SGML tags
2326 switch (style->latextype) {
2327 case LATEX_PARAGRAPH:
2328 if (depth == par->params().depth()
2329 && !environment_stack[depth].empty()) {
2330 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2331 environment_stack[depth].erase();
2337 sgmlOpenTag(ofs, depth, false, style->latexname());
2343 _("Error : Wrong depth for"
2344 " LatexType Command.\n"));
2346 if (!environment_stack[depth].empty()) {
2347 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2351 environment_stack[depth].erase();
2352 sgmlOpenTag(ofs, depth, false, style->latexname());
2355 case LATEX_ENVIRONMENT:
2356 case LATEX_ITEM_ENVIRONMENT:
2358 string const & latexname = style->latexname();
2360 if (depth == par->params().depth()
2361 && environment_stack[depth] != latexname) {
2362 sgmlCloseTag(ofs, depth, false,
2363 environment_stack[depth]);
2364 environment_stack[depth].erase();
2366 if (depth < par->params().depth()) {
2367 depth = par->params().depth();
2368 environment_stack[depth].erase();
2370 if (environment_stack[depth] != latexname) {
2372 sgmlOpenTag(ofs, depth, false, "p");
2374 sgmlOpenTag(ofs, depth, false, latexname);
2376 if (environment_stack.size() == depth + 1)
2377 environment_stack.push_back("!-- --");
2378 environment_stack[depth] = latexname;
2381 if (style->latexparam() == "CDATA")
2384 if (style->latextype == LATEX_ENVIRONMENT) break;
2386 if (style->labeltype == LABEL_MANUAL)
2391 sgmlOpenTag(ofs, depth + 1, false, item_name);
2396 sgmlOpenTag(ofs, depth, false, style->latexname());
2400 simpleLinuxDocOnePar(ofs, par, depth);
2405 // write closing SGML tags
2406 switch (style->latextype) {
2409 case LATEX_ENVIRONMENT:
2410 case LATEX_ITEM_ENVIRONMENT:
2411 if (style->latexparam() == "CDATA")
2415 sgmlCloseTag(ofs, depth, false, style->latexname());
2421 for (int i = depth; i >= 0; --i)
2422 sgmlCloseTag(ofs, depth, false, environment_stack[i]);
2426 sgmlCloseTag(ofs, 0, false, top_element);
2430 // How to check for successful close
2432 // we want this to be true outside previews (for insetexternal)
2437 // checks, if newcol chars should be put into this line
2438 // writes newline, if necessary.
2441 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2442 string::size_type newcol)
2445 if (colcount > lyxrc.ascii_linelen) {
2447 colcount = newcol; // assume write after this call
2462 string tag_name(PAR_TAG const & pt) {
2464 case NONE: return "!-- --";
2465 case TT: return "tt";
2466 case SF: return "sf";
2467 case BF: return "bf";
2468 case IT: return "it";
2469 case SL: return "sl";
2470 case EM: return "em";
2477 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2479 p1 = static_cast<PAR_TAG>(p1 | p2);
2484 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2486 p1 = static_cast<PAR_TAG>(p1 & ~p2);
2492 // Handle internal paragraph parsing -- layout already processed.
2493 void Buffer::simpleLinuxDocOnePar(ostream & os,
2495 Paragraph::depth_type /*depth*/)
2497 LyXLayout_ptr const & style = par->layout();
2499 string::size_type char_line_count = 5; // Heuristic choice ;-)
2501 // gets paragraph main font
2504 if (style->labeltype == LABEL_MANUAL) {
2505 font_old = style->labelfont;
2508 font_old = style->font;
2512 LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2513 LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2514 LyXFont::FONT_SHAPE shape_type = LyXFont::UP_SHAPE;
2517 stack<PAR_TAG> tag_state;
2518 // parsing main loop
2519 for (pos_type i = 0; i < par->size(); ++i) {
2521 PAR_TAG tag_close = NONE;
2522 list < PAR_TAG > tag_open;
2524 LyXFont const font = par->getFont(params, i);
2526 if (font_old.family() != font.family()) {
2527 switch (family_type) {
2528 case LyXFont::SANS_FAMILY:
2531 case LyXFont::TYPEWRITER_FAMILY:
2538 family_type = font.family();
2540 switch (family_type) {
2541 case LyXFont::SANS_FAMILY:
2542 tag_open.push_back(SF);
2544 case LyXFont::TYPEWRITER_FAMILY:
2545 tag_open.push_back(TT);
2552 if (font_old.series() != font.series()) {
2553 switch (series_type) {
2554 case LyXFont::BOLD_SERIES:
2561 series_type = font.series();
2563 switch (series_type) {
2564 case LyXFont::BOLD_SERIES:
2565 tag_open.push_back(BF);
2573 if (font_old.shape() != font.shape()) {
2574 switch (shape_type) {
2575 case LyXFont::ITALIC_SHAPE:
2578 case LyXFont::SLANTED_SHAPE:
2585 shape_type = font.shape();
2587 switch (shape_type) {
2588 case LyXFont::ITALIC_SHAPE:
2589 tag_open.push_back(IT);
2591 case LyXFont::SLANTED_SHAPE:
2592 tag_open.push_back(SL);
2599 if (font_old.emph() != font.emph()) {
2600 if (font.emph() == LyXFont::ON) {
2601 tag_open.push_back(EM);
2610 list < PAR_TAG > temp;
2611 while (!tag_state.empty() && tag_close) {
2612 PAR_TAG k = tag_state.top();
2614 os << "</" << tag_name(k) << ">";
2621 for(list< PAR_TAG >::const_iterator j = temp.begin();
2622 j != temp.end(); ++j) {
2624 os << "<" << tag_name(*j) << ">";
2627 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2628 j != tag_open.end(); ++j) {
2630 os << "<" << tag_name(*j) << ">";
2633 char c = par->getChar(i);
2635 if (c == Paragraph::META_INSET) {
2636 Inset * inset = par->getInset(i);
2637 inset->linuxdoc(this, os);
2642 if (style->latexparam() == "CDATA") {
2643 // "TeX"-Mode on == > SGML-Mode on.
2650 boost::tie(ws, str) = sgml::escapeChar(c);
2651 if (ws && !style->free_spacing && !par->isFreeSpacing()) {
2652 // in freespacing mode, spaces are
2653 // non-breaking characters
2654 if (desc_on) {// if char is ' ' then...
2657 sgmlLineBreak(os, char_line_count, 6);
2661 sgmlLineBreak(os, char_line_count, 1);
2666 char_line_count += str.length();
2672 while (!tag_state.empty()) {
2673 os << "</" << tag_name(tag_state.top()) << ">";
2677 // resets description flag correctly
2679 // <tag> not closed...
2680 sgmlLineBreak(os, char_line_count, 6);
2686 // Print an error message.
2687 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
2688 string const & /*message*/) const
2690 #ifdef WITH_WARNINGS
2691 #warning This is wrong we cannot insert an inset like this!!!
2692 // I guess this was Jose' so I explain you more or less why this
2693 // is wrong. This way you insert something in the paragraph and
2694 // don't tell it to LyXText (row rebreaking and undo handling!!!)
2695 // I deactivate this code, have a look at BufferView::insertErrors
2696 // how you should do this correctly! (Jug 20020315)
2699 // insert an error marker in text
2700 InsetError * new_inset = new InsetError(message);
2701 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
2707 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2709 ofstream ofs(fname.c_str());
2711 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2715 Paragraph * par = &*(paragraphs.begin());
2717 niceFile = nice; // this will be used by Insetincludes.
2719 LaTeXFeatures features(params);
2724 LyXTextClass const & tclass = params.getLyXTextClass();
2725 string top_element = tclass.latexname();
2728 ofs << "<!DOCTYPE " << top_element
2729 << " PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
2731 string preamble = params.preamble;
2732 const string name = nice ? ChangeExtension(filename_, ".sgml")
2734 preamble += features.getIncludedFiles(name);
2735 preamble += features.getLyXSGMLEntities();
2737 if (!preamble.empty()) {
2738 ofs << "\n [ " << preamble << " ]";
2743 string top = top_element;
2745 top += params.language->code();
2748 if (!params.options.empty()) {
2750 top += params.options;
2752 sgmlOpenTag(ofs, 0, false, top);
2754 ofs << "<!-- DocBook file was created by " << lyx_docversion
2755 << "\n See http://www.lyx.org/ for more information -->\n";
2757 vector<string> environment_stack(10);
2758 vector<string> environment_inner(10);
2759 vector<string> command_stack(10);
2761 bool command_flag = false;
2762 Paragraph::depth_type command_depth = 0;
2763 Paragraph::depth_type command_base = 0;
2764 Paragraph::depth_type cmd_depth = 0;
2765 Paragraph::depth_type depth = 0; // paragraph depth
2768 string command_name;
2774 int desc_on = 0; // description mode
2776 LyXLayout_ptr const & style = par->layout();
2778 // environment tag closing
2779 for (; depth > par->params().depth(); --depth) {
2780 if (environment_inner[depth] != "!-- --") {
2781 item_name = "listitem";
2782 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2783 if (environment_inner[depth] == "varlistentry")
2784 sgmlCloseTag(ofs, depth+command_depth, false, environment_inner[depth]);
2786 sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2787 environment_stack[depth].erase();
2788 environment_inner[depth].erase();
2791 if (depth == par->params().depth()
2792 && environment_stack[depth] != style->latexname()
2793 && !environment_stack[depth].empty()) {
2794 if (environment_inner[depth] != "!-- --") {
2795 item_name= "listitem";
2796 sgmlCloseTag(ofs, command_depth+depth, false, item_name);
2797 if (environment_inner[depth] == "varlistentry")
2798 sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2801 sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2803 environment_stack[depth].erase();
2804 environment_inner[depth].erase();
2807 // Write opening SGML tags.
2808 switch (style->latextype) {
2809 case LATEX_PARAGRAPH:
2810 sgmlOpenTag(ofs, depth + command_depth,
2811 false, style->latexname());
2817 _("Error : Wrong depth for "
2818 "LatexType Command.\n"));
2820 command_name = style->latexname();
2822 sgmlparam = style->latexparam();
2823 c_params = split(sgmlparam, c_depth,'|');
2825 cmd_depth = lyx::atoi(c_depth);
2828 if (cmd_depth < command_base) {
2829 for (Paragraph::depth_type j = command_depth;
2830 j >= command_base; --j) {
2831 sgmlCloseTag(ofs, j, false, command_stack[j]);
2834 command_depth = command_base = cmd_depth;
2835 } else if (cmd_depth <= command_depth) {
2836 for (int j = command_depth;
2837 j >= int(cmd_depth); --j) {
2838 sgmlCloseTag(ofs, j, false, command_stack[j]);
2841 command_depth = cmd_depth;
2843 command_depth = cmd_depth;
2845 command_depth = command_base = cmd_depth;
2846 command_flag = true;
2848 if (command_stack.size() == command_depth + 1)
2849 command_stack.push_back(string());
2850 command_stack[command_depth] = command_name;
2852 // treat label as a special case for
2853 // more WYSIWYM handling.
2854 // This is a hack while paragraphs can't have
2855 // attributes, like id in this case.
2856 if (par->isInset(0)) {
2857 Inset * inset = par->getInset(0);
2858 Inset::Code lyx_code = inset->lyxCode();
2859 if (lyx_code == Inset::LABEL_CODE) {
2860 command_name += " id=\"";
2861 command_name += (static_cast<InsetCommand *>(inset))->getContents();
2862 command_name += "\"";
2867 sgmlOpenTag(ofs, depth + command_depth, false, command_name);
2869 item_name = c_params.empty()?"title":c_params;
2870 sgmlOpenTag(ofs, depth + 1 + command_depth, false, item_name);
2873 case LATEX_ENVIRONMENT:
2874 case LATEX_ITEM_ENVIRONMENT:
2875 if (depth < par->params().depth()) {
2876 depth = par->params().depth();
2877 environment_stack[depth].erase();
2880 if (environment_stack[depth] != style->latexname()) {
2881 if (environment_stack.size() == depth + 1) {
2882 environment_stack.push_back("!-- --");
2883 environment_inner.push_back("!-- --");
2885 environment_stack[depth] = style->latexname();
2886 environment_inner[depth] = "!-- --";
2887 sgmlOpenTag(ofs, depth + command_depth, false, environment_stack[depth]);
2889 if (environment_inner[depth] != "!-- --") {
2890 item_name= "listitem";
2891 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2892 if (environment_inner[depth] == "varlistentry")
2893 sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2897 if (style->latextype == LATEX_ENVIRONMENT) {
2898 if (!style->latexparam().empty()) {
2899 if (style->latexparam() == "CDATA")
2902 sgmlOpenTag(ofs, depth + command_depth, false, style->latexparam());
2907 desc_on = (style->labeltype == LABEL_MANUAL);
2909 environment_inner[depth] = desc_on ? "varlistentry" : "listitem";
2910 sgmlOpenTag(ofs, depth + 1 + command_depth,
2911 false, environment_inner[depth]);
2913 item_name = desc_on ? "term" : "para";
2914 sgmlOpenTag(ofs, depth + 1 + command_depth,
2918 sgmlOpenTag(ofs, depth + command_depth,
2919 false, style->latexname());
2923 simpleDocBookOnePar(ofs, par, desc_on,
2924 depth + 1 + command_depth);
2928 // write closing SGML tags
2929 switch (style->latextype) {
2931 end_tag = c_params.empty() ? "title" : c_params;
2932 sgmlCloseTag(ofs, depth + command_depth,
2935 case LATEX_ENVIRONMENT:
2936 if (!style->latexparam().empty()) {
2937 if (style->latexparam() == "CDATA")
2940 sgmlCloseTag(ofs, depth + command_depth, false, style->latexparam());
2943 case LATEX_ITEM_ENVIRONMENT:
2944 if (desc_on == 1) break;
2946 sgmlCloseTag(ofs, depth + 1 + command_depth, false, end_tag);
2948 case LATEX_PARAGRAPH:
2949 sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
2952 sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
2958 for (int d = depth; d >= 0; --d) {
2959 if (!environment_stack[depth].empty()) {
2960 if (environment_inner[depth] != "!-- --") {
2961 item_name = "listitem";
2962 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2963 if (environment_inner[depth] == "varlistentry")
2964 sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2967 sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2971 for (int j = command_depth; j >= 0 ; --j)
2972 if (!command_stack[j].empty()) {
2973 sgmlCloseTag(ofs, j, false, command_stack[j]);
2978 sgmlCloseTag(ofs, 0, false, top_element);
2981 // How to check for successful close
2983 // we want this to be true outside previews (for insetexternal)
2988 void Buffer::simpleDocBookOnePar(ostream & os,
2989 Paragraph * par, int & desc_on,
2990 Paragraph::depth_type depth) const
2992 bool emph_flag = false;
2994 LyXLayout_ptr const & style = par->layout();
2996 LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
2998 int char_line_count = depth;
2999 //if (!style.free_spacing)
3000 // os << string(depth,' ');
3002 // parsing main loop
3003 for (pos_type i = 0; i < par->size(); ++i) {
3004 LyXFont font = par->getFont(params, i);
3006 // handle <emphasis> tag
3007 if (font_old.emph() != font.emph()) {
3008 if (font.emph() == LyXFont::ON) {
3009 if (style->latexparam() == "CDATA")
3012 if (style->latexparam() == "CDATA")
3016 if (style->latexparam() == "CDATA")
3018 os << "</emphasis>";
3019 if (style->latexparam() == "CDATA")
3026 if (par->isInset(i)) {
3027 Inset * inset = par->getInset(i);
3028 // don't print the inset in position 0 if desc_on == 3 (label)
3029 if (i || desc_on != 3) {
3030 if (style->latexparam() == "CDATA")
3032 inset->docbook(this, os, false);
3033 if (style->latexparam() == "CDATA")
3037 char c = par->getChar(i);
3040 boost::tie(ws, str) = sgml::escapeChar(c);
3042 if (style->pass_thru) {
3044 } else if (style->free_spacing || par->isFreeSpacing() || c != ' ') {
3046 } else if (desc_on ==1) {
3048 os << "\n</term><listitem><para>";
3058 if (style->latexparam() == "CDATA")
3060 os << "</emphasis>";
3061 if (style->latexparam() == "CDATA")
3065 // resets description flag correctly
3067 // <term> not closed...
3068 os << "</term>\n<listitem><para> </para>";
3070 if (style->free_spacing)
3075 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3076 // Other flags: -wall -v0 -x
3077 int Buffer::runChktex()
3079 if (!users->text) return 0;
3081 users->owner()->prohibitInput();
3083 // get LaTeX-Filename
3084 string const name = getLatexName();
3085 string path = filePath();
3087 string const org_path = path;
3088 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3092 Path p(path); // path to LaTeX file
3093 users->owner()->message(_("Running chktex..."));
3095 // Remove all error insets
3096 bool const removedErrorInsets = users->removeAutoInsets();
3098 // Generate the LaTeX file if neccessary
3099 makeLaTeXFile(name, org_path, false);
3102 Chktex chktex(lyxrc.chktex_command, name, filePath());
3103 int res = chktex.run(terr); // run chktex
3106 Alert::alert(_("chktex did not work!"),
3107 _("Could not run with file:"), name);
3108 } else if (res > 0) {
3109 // Insert all errors as errors boxes
3110 users->insertErrors(terr);
3113 // if we removed error insets before we ran chktex or if we inserted
3114 // error insets after we ran chktex, this must be run:
3115 if (removedErrorInsets || res) {
3116 #warning repaint needed here, or do you mean update() ?
3120 users->owner()->allowInput();
3126 void Buffer::validate(LaTeXFeatures & features) const
3128 LyXTextClass const & tclass = params.getLyXTextClass();
3130 // AMS Style is at document level
3131 if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3132 features.require("amsmath");
3134 for_each(paragraphs.begin(), paragraphs.end(),
3135 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
3137 // the bullet shapes are buffer level not paragraph level
3138 // so they are tested here
3139 for (int i = 0; i < 4; ++i) {
3140 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3141 int const font = params.user_defined_bullets[i].getFont();
3143 int const c = params
3144 .user_defined_bullets[i]
3151 features.require("latexsym");
3153 } else if (font == 1) {
3154 features.require("amssymb");
3155 } else if ((font >= 2 && font <= 5)) {
3156 features.require("pifont");
3161 if (lyxerr.debugging(Debug::LATEX)) {
3162 features.showStruct();
3167 vector<string> const Buffer::getLabelList() const
3169 /// if this is a child document and the parent is already loaded
3170 /// Use the parent's list instead [ale990407]
3171 if (!params.parentname.empty()
3172 && bufferlist.exists(params.parentname)) {
3173 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
3175 return tmp->getLabelList();
3178 vector<string> label_list;
3179 for (inset_iterator it = inset_const_iterator_begin();
3180 it != inset_const_iterator_end(); ++it) {
3181 vector<string> const l = it->getLabelList();
3182 label_list.insert(label_list.end(), l.begin(), l.end());
3188 // This is also a buffer property (ale)
3189 vector<pair<string, string> > const Buffer::getBibkeyList() const
3191 typedef pair<string, string> StringPair;
3192 /// if this is a child document and the parent is already loaded
3193 /// Use the parent's list instead [ale990412]
3194 if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3195 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
3197 return tmp->getBibkeyList();
3200 vector<StringPair> keys;
3201 ParagraphList::iterator pit = paragraphs.begin();
3202 ParagraphList::iterator pend = paragraphs.end();
3203 for (; pit != pend; ++pit) {
3205 string const key = pit->bibkey->getContents();
3206 string const opt = pit->bibkey->getOptions();
3207 string const ref = pit->asString(this, false);
3208 string const info = opt + "TheBibliographyRef" + ref;
3210 keys.push_back(StringPair(key, info));
3217 // Might be either using bibtex or a child has bibliography
3218 for (inset_iterator it = inset_const_iterator_begin();
3219 it != inset_const_iterator_end(); ++it) {
3220 // Search for Bibtex or Include inset
3221 if (it->lyxCode() == Inset::BIBTEX_CODE) {
3222 vector<StringPair> tmp =
3223 static_cast<InsetBibtex &>(*it).getKeys(this);
3224 keys.insert(keys.end(), tmp.begin(), tmp.end());
3225 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
3226 vector<StringPair> const tmp =
3227 static_cast<InsetInclude &>(*it).getKeys();
3228 keys.insert(keys.end(), tmp.begin(), tmp.end());
3236 bool Buffer::isDepClean(string const & name) const
3238 DEPCLEAN * item = dep_clean;
3239 while (item && item->master != name)
3241 if (!item) return true;
3246 void Buffer::markDepClean(string const & name)
3249 dep_clean = new DEPCLEAN;
3250 dep_clean->clean = true;
3251 dep_clean->master = name;
3252 dep_clean->next = 0;
3254 DEPCLEAN * item = dep_clean;
3255 while (item && item->master != name)
3260 item = new DEPCLEAN;
3262 item->master = name;
3269 bool Buffer::dispatch(string const & command, bool * result)
3271 // Split command string into command and argument
3273 string line = ltrim(command);
3274 string const arg = trim(split(line, cmd, ' '));
3276 return dispatch(lyxaction.LookupFunc(cmd), arg, result);
3280 bool Buffer::dispatch(int action, string const & argument, bool * result)
3282 bool dispatched = true;
3286 bool const tmp = Exporter::Export(this, argument, false);
3299 void Buffer::resizeInsets(BufferView * bv)
3301 /// then remove all LyXText in text-insets
3302 for_each(paragraphs.begin(), paragraphs.end(),
3303 boost::bind(&Paragraph::resizeInsetsLyXText, _1, bv));
3307 void Buffer::redraw()
3309 #warning repaint needed here, or do you mean update() ?
3315 void Buffer::changeLanguage(Language const * from, Language const * to)
3318 ParIterator end = par_iterator_end();
3319 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3320 (*it)->changeLanguage(params, from, to);
3324 bool Buffer::isMultiLingual()
3326 ParIterator end = par_iterator_end();
3327 for (ParIterator it = par_iterator_begin(); it != end; ++it)
3328 if ((*it)->isMultiLingual(params))
3335 void Buffer::inset_iterator::setParagraph()
3337 while (pit != pend) {
3338 it = pit->insetlist.begin();
3339 if (it != pit->insetlist.end())
3346 Inset * Buffer::getInsetFromID(int id_arg) const
3348 for (inset_iterator it = inset_const_iterator_begin();
3349 it != inset_const_iterator_end(); ++it)
3351 if (it->id() == id_arg)
3353 Inset * in = it->getInsetFromID(id_arg);
3361 Paragraph * Buffer::getParFromID(int id) const
3366 ParagraphList::iterator it = paragraphs.begin();
3367 ParagraphList::iterator end = paragraphs.end();
3368 for (; it != end; ++it) {
3369 if (it->id() == id) {
3372 Paragraph * tmp = it->getParFromID(id);
3381 ParIterator Buffer::par_iterator_begin()
3383 return ParIterator(&*(paragraphs.begin()));
3387 ParIterator Buffer::par_iterator_end()
3389 return ParIterator();
3393 void Buffer::addUser(BufferView * u)
3399 void Buffer::delUser(BufferView *)
3405 Language const * Buffer::getLanguage() const
3407 return params.language;
3411 bool Buffer::isClean() const
3417 bool Buffer::isBakClean() const
3423 void Buffer::markClean() const
3429 // if the .lyx file has been saved, we don't need an
3435 void Buffer::markBakClean()
3441 void Buffer::setUnnamed(bool flag)
3447 bool Buffer::isUnnamed()
3453 void Buffer::markDirty()
3460 DEPCLEAN * tmp = dep_clean;
3468 string const & Buffer::fileName() const
3474 string const & Buffer::filePath() const
3480 bool Buffer::isReadonly() const
3486 BufferView * Buffer::getUser() const
3492 void Buffer::setParentName(string const & name)
3494 params.parentname = name;
3498 Buffer::inset_iterator::inset_iterator()
3503 Buffer::inset_iterator::inset_iterator(base_type p, base_type e)
3510 Buffer::inset_iterator & Buffer::inset_iterator::operator++()
3514 if (it == pit->insetlist.end()) {
3523 Buffer::inset_iterator Buffer::inset_iterator::operator++(int)
3525 inset_iterator tmp = *this;
3531 Buffer::inset_iterator::reference Buffer::inset_iterator::operator*()
3533 return *it.getInset();
3537 Buffer::inset_iterator::pointer Buffer::inset_iterator::operator->()
3539 return it.getInset();
3543 Paragraph * Buffer::inset_iterator::getPar()
3549 lyx::pos_type Buffer::inset_iterator::getPos() const
3555 bool operator==(Buffer::inset_iterator const & iter1,
3556 Buffer::inset_iterator const & iter2)
3558 return iter1.pit == iter2.pit
3559 && (iter1.pit == iter1.pend || iter1.it == iter2.it);
3563 bool operator!=(Buffer::inset_iterator const & iter1,
3564 Buffer::inset_iterator const & iter2)
3566 return !(iter1 == iter2);