3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
16 #include "BranchList.h"
17 #include "buffer_funcs.h"
18 #include "bufferlist.h"
19 #include "bufferparams.h"
25 #include "errorlist.h"
28 #include "funcrequest.h"
30 #include "insetiterator.h"
33 #include "LaTeXFeatures.h"
34 #include "LyXAction.h"
42 #include "output_docbook.h"
43 #include "output_latex.h"
44 #include "output_linuxdoc.h"
45 #include "paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "pariterator.h"
54 #include "insets/insetbibitem.h"
55 #include "insets/insetbibtex.h"
56 #include "insets/insetinclude.h"
57 #include "insets/insettext.h"
59 #include "mathed/math_macrotemplate.h"
60 #include "mathed/math_macrotable.h"
61 #include "mathed/math_support.h"
63 #include "frontends/Alert.h"
65 #include "graphics/Previews.h"
67 #include "support/filetools.h"
68 #include "support/fs_extras.h"
69 #ifdef USE_COMPRESSION
70 # include "support/gzstream.h"
72 #include "support/lyxlib.h"
73 #include "support/os.h"
74 #include "support/path.h"
75 #include "support/textutils.h"
76 #include "support/convert.h"
78 #include <boost/bind.hpp>
79 #include <boost/filesystem/operations.hpp>
81 #if defined (HAVE_UTIME_H)
83 #elif defined (HAVE_SYS_UTIME_H)
84 # include <sys/utime.h>
96 using lyx::support::AddName;
97 using lyx::support::bformat;
98 using lyx::support::ChangeExtension;
99 using lyx::support::cmd_ret;
100 using lyx::support::createBufferTmpDir;
101 using lyx::support::destroyDir;
102 using lyx::support::getFormatFromContents;
103 using lyx::support::IsDirWriteable;
104 using lyx::support::LibFileSearch;
105 using lyx::support::latex_path;
106 using lyx::support::ltrim;
107 using lyx::support::MakeAbsPath;
108 using lyx::support::MakeDisplayPath;
109 using lyx::support::MakeLatexName;
110 using lyx::support::OnlyFilename;
111 using lyx::support::OnlyPath;
112 using lyx::support::Path;
113 using lyx::support::QuoteName;
114 using lyx::support::removeAutosaveFile;
115 using lyx::support::rename;
116 using lyx::support::RunCommand;
117 using lyx::support::split;
118 using lyx::support::subst;
119 using lyx::support::tempName;
120 using lyx::support::trim;
122 namespace os = lyx::support::os;
123 namespace fs = boost::filesystem;
127 using std::make_pair;
133 using std::ostringstream;
141 // all these externs should eventually be removed.
142 extern BufferList bufferlist;
146 int const LYX_FORMAT = 241;
151 typedef std::map<string, bool> DepClean;
156 Impl(Buffer & parent, string const & file, bool readonly);
158 limited_stack<Undo> undostack;
159 limited_stack<Undo> redostack;
165 /// need to regenerate .tex?
169 mutable bool lyx_clean;
171 /// is autosave needed?
172 mutable bool bak_clean;
174 /// is this a unnamed file (New...)?
180 /// name of the file the buffer is associated with.
183 /// The path to the document file.
186 boost::scoped_ptr<Messages> messages;
188 /** Set to true only when the file is fully loaded.
189 * Used to prevent the premature generation of previews
190 * and by the citation inset.
192 bool file_fully_loaded;
194 /// our LyXText that should be wrapped in an InsetText
202 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
203 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
204 filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
207 inset.setAutoBreakRows(true);
208 lyxvc.buffer(&parent);
209 temppath = createBufferTmpDir();
210 // FIXME: And now do something if temppath == string(), because we
211 // assume from now on that temppath points to a valid temp dir.
212 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
216 Buffer::Buffer(string const & file, bool ronly)
217 : pimpl_(new Impl(*this, file, ronly))
219 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
225 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
226 // here the buffer should take care that it is
227 // saved properly, before it goes into the void.
231 if (!temppath().empty() && !destroyDir(temppath())) {
232 Alert::warning(_("Could not remove temporary directory"),
233 bformat(_("Could not remove the temporary directory %1$s"), temppath()));
236 // Remove any previewed LaTeX snippets associated with this buffer.
237 lyx::graphics::Previews::get().removeLoader(*this);
241 LyXText & Buffer::text() const
243 return const_cast<LyXText &>(pimpl_->inset.text_);
247 InsetBase & Buffer::inset() const
249 return const_cast<InsetText &>(pimpl_->inset);
253 limited_stack<Undo> & Buffer::undostack()
255 return pimpl_->undostack;
259 limited_stack<Undo> const & Buffer::undostack() const
261 return pimpl_->undostack;
265 limited_stack<Undo> & Buffer::redostack()
267 return pimpl_->redostack;
271 limited_stack<Undo> const & Buffer::redostack() const
273 return pimpl_->redostack;
277 BufferParams & Buffer::params()
279 return pimpl_->params;
283 BufferParams const & Buffer::params() const
285 return pimpl_->params;
289 ParagraphList & Buffer::paragraphs()
291 return text().paragraphs();
295 ParagraphList const & Buffer::paragraphs() const
297 return text().paragraphs();
301 LyXVC & Buffer::lyxvc()
303 return pimpl_->lyxvc;
307 LyXVC const & Buffer::lyxvc() const
309 return pimpl_->lyxvc;
313 string const & Buffer::temppath() const
315 return pimpl_->temppath;
319 TexRow & Buffer::texrow()
321 return pimpl_->texrow;
325 TexRow const & Buffer::texrow() const
327 return pimpl_->texrow;
331 string const Buffer::getLatexName(bool const no_path) const
333 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
334 return no_path ? OnlyFilename(name) : name;
338 pair<Buffer::LogType, string> const Buffer::getLogName() const
340 string const filename = getLatexName(false);
342 if (filename.empty())
343 return make_pair(Buffer::latexlog, string());
345 string const path = temppath();
347 string const fname = AddName(path,
348 OnlyFilename(ChangeExtension(filename,
351 AddName(path, OnlyFilename(
352 ChangeExtension(filename,
353 formats.extension("literate") + ".out")));
355 // If no Latex log or Build log is newer, show Build log
357 if (fs::exists(bname) &&
358 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
359 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
360 return make_pair(Buffer::buildlog, bname);
362 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
363 return make_pair(Buffer::latexlog, fname);
367 void Buffer::setReadonly(bool const flag)
369 if (pimpl_->read_only != flag) {
370 pimpl_->read_only = flag;
376 void Buffer::setFileName(string const & newfile)
378 pimpl_->filename = MakeAbsPath(newfile);
379 pimpl_->filepath = OnlyPath(pimpl_->filename);
380 setReadonly(fs::is_readonly(pimpl_->filename));
385 // We'll remove this later. (Lgb)
388 void unknownClass(string const & unknown)
390 Alert::warning(_("Unknown document class"),
391 bformat(_("Using the default document class, because the "
392 "class %1$s is unknown."), unknown));
398 int Buffer::readHeader(LyXLex & lex)
400 int unknown_tokens = 0;
402 int begin_header_line = -1;
404 // Initialize parameters that may be/go lacking in header:
405 params().branchlist().clear();
406 params().options.erase();
407 params().float_placement.erase();
408 params().paperwidth.erase();
409 params().paperheight.erase();
410 params().leftmargin.erase();
411 params().rightmargin.erase();
412 params().topmargin.erase();
413 params().bottommargin.erase();
414 params().headheight.erase();
415 params().headsep.erase();
416 params().footskip.erase();
420 string const token = lex.getString();
425 if (token == "\\end_header")
429 if (token == "\\begin_header") {
430 begin_header_line = line;
434 lyxerr[Debug::PARSER] << "Handling header token: `"
435 << token << '\'' << endl;
437 string unknown = params().readToken(lex, token);
438 if (!unknown.empty()) {
439 if (unknown[0] != '\\' && token == "\\textclass") {
440 unknownClass(unknown);
443 string const s = bformat(_("Unknown token: "
447 error(ErrorItem(_("Header error"), s,
452 if (begin_header_line) {
453 string const s = _("\\begin_header is missing");
454 error(ErrorItem(_("Header error"), s, -1, 0, 0));
456 return unknown_tokens;
461 // changed to be public and have one parameter
462 // Returns false if "\end_document" is not read (Asger)
463 bool Buffer::readDocument(LyXLex & lex)
466 string const token = lex.getString();
467 if (token != "\\begin_document") {
468 string const s = _("\\begin_document is missing");
469 error(ErrorItem(_("Header error"), s, -1, 0, 0));
472 if (paragraphs().empty()) {
474 if (!params().getLyXTextClass().load()) {
475 string theclass = params().getLyXTextClass().name();
476 Alert::error(_("Can't load document class"), bformat(
477 "Using the default document class, because the "
478 " class %1$s could not be loaded.", theclass));
479 params().textclass = 0;
482 // We don't want to adopt the parameters from the
483 // document we insert, so read them into a temporary buffer
484 // and then discard it
486 Buffer tmpbuf("", false);
487 tmpbuf.readHeader(lex);
490 return text().read(*this, lex);
494 // needed to insert the selection
495 void Buffer::insertStringAsLines(ParagraphList & pars,
496 pit_type & pit, pos_type & pos,
497 LyXFont const & fn, string const & str, bool autobreakrows)
501 pars[pit].checkInsertChar(font);
502 // insert the string, don't insert doublespace
503 bool space_inserted = true;
504 for (string::const_iterator cit = str.begin();
505 cit != str.end(); ++cit) {
506 Paragraph & par = pars[pit];
508 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
509 breakParagraph(params(), pars, pit, pos,
510 par.layout()->isEnvironment());
513 space_inserted = true;
517 // do not insert consecutive spaces if !free_spacing
518 } else if ((*cit == ' ' || *cit == '\t') &&
519 space_inserted && !par.isFreeSpacing()) {
521 } else if (*cit == '\t') {
522 if (!par.isFreeSpacing()) {
523 // tabs are like spaces here
524 par.insertChar(pos, ' ', font);
526 space_inserted = true;
528 const pos_type n = 8 - pos % 8;
529 for (pos_type i = 0; i < n; ++i) {
530 par.insertChar(pos, ' ', font);
533 space_inserted = true;
535 } else if (!IsPrintable(*cit)) {
536 // Ignore unprintables
539 // just insert the character
540 par.insertChar(pos, *cit, font);
542 space_inserted = (*cit == ' ');
549 bool Buffer::readFile(string const & filename)
551 // Check if the file is compressed.
552 string const format = getFormatFromContents(filename);
553 if (format == "gzip" || format == "zip" || format == "compress") {
554 params().compressed = true;
557 // remove dummy empty par
558 paragraphs().clear();
559 bool ret = readFile(filename, paragraphs().size());
561 // After we have read a file, we must ensure that the buffer
562 // language is set and used in the gui.
563 // If you know of a better place to put this, please tell me. (Lgb)
564 updateDocLang(params().language);
570 bool Buffer::readFile(string const & filename, pit_type const pit)
573 lex.setFile(filename);
574 return readFile(lex, filename, pit);
578 bool Buffer::fully_loaded() const
580 return pimpl_->file_fully_loaded;
584 void Buffer::fully_loaded(bool const value)
586 pimpl_->file_fully_loaded = value;
590 bool Buffer::readFile(LyXLex & lex, string const & filename, pit_type const pit)
592 BOOST_ASSERT(!filename.empty());
595 Alert::error(_("Document could not be read"),
596 bformat(_("%1$s could not be read."), filename));
601 string const token(lex.getString());
604 Alert::error(_("Document could not be read"),
605 bformat(_("%1$s could not be read."), filename));
609 // the first token _must_ be...
610 if (token != "\\lyxformat") {
611 lyxerr << "Token: " << token << endl;
613 Alert::error(_("Document format failure"),
614 bformat(_("%1$s is not a LyX document."),
620 string tmp_format = lex.getString();
621 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
622 // if present remove ".," from string.
623 string::size_type dot = tmp_format.find_first_of(".,");
624 //lyxerr << " dot found at " << dot << endl;
625 if (dot != string::npos)
626 tmp_format.erase(dot, 1);
627 int const file_format = convert<int>(tmp_format);
628 //lyxerr << "format: " << file_format << endl;
630 if (file_format != LYX_FORMAT) {
631 string const tmpfile = tempName();
632 if (tmpfile.empty()) {
633 Alert::error(_("Conversion failed"),
634 bformat(_("%1$s is from an earlier"
635 " version of LyX, but a temporary"
636 " file for converting it could"
642 "python " + LibFileSearch("lyx2lyx", "lyx2lyx");
643 if (command.empty()) {
644 Alert::error(_("Conversion script not found"),
645 bformat(_("%1$s is from an earlier"
646 " version of LyX, but the"
647 " conversion script lyx2lyx"
648 " could not be found."),
653 + convert<string>(LYX_FORMAT)
654 + " -o " + tmpfile + ' '
655 + QuoteName(filename);
656 lyxerr[Debug::INFO] << "Running '"
659 cmd_ret const ret = RunCommand(command);
660 if (ret.first != 0) {
661 Alert::error(_("Conversion script failed"),
662 bformat(_("%1$s is from an earlier version"
663 " of LyX, but the lyx2lyx script"
664 " failed to convert it."),
668 bool const ret = readFile(tmpfile, pit);
669 // Do stuff with tmpfile name and buffer name here.
675 if (readDocument(lex)) {
676 Alert::error(_("Document format failure"),
677 bformat(_("%1$s ended unexpectedly, which means"
678 " that it is probably corrupted."),
682 //lyxerr << "removing " << MacroTable::localMacros().size()
683 // << " temporary macro entries" << endl;
684 //MacroTable::localMacros().clear();
685 params().setPaperStuff();
687 pimpl_->file_fully_loaded = true;
692 // Should probably be moved to somewhere else: BufferView? LyXView?
693 bool Buffer::save() const
695 // We don't need autosaves in the immediate future. (Asger)
696 resetAutosaveTimers();
700 if (lyxrc.make_backup) {
701 s = fileName() + '~';
702 if (!lyxrc.backupdir_path.empty())
703 s = AddName(lyxrc.backupdir_path,
704 subst(os::internal_path(s),'/','!'));
706 // It might very well be that this variant is just
707 // good enough. (Lgb)
708 // But to use this we need fs::copy_file to actually do a copy,
709 // even when the target file exists. (Lgb)
710 if (fs::exists(fileName())) {
712 fs::copy_file(fileName(), s, false);
714 //catch (fs::filesystem_error const & fe) {
715 //lyxerr << "LyX was not able to make backup copy. Beware.\n"
716 // << fe.what() << endl;
721 if (writeFile(fileName())) {
723 removeAutosaveFile(fileName());
725 // Saving failed, so backup is not backup
726 if (lyxrc.make_backup)
727 rename(s, fileName());
734 bool Buffer::writeFile(string const & fname) const
736 if (pimpl_->read_only && fname == fileName())
741 if (params().compressed) {
742 #ifdef USE_COMPRESSION
743 gz::ogzstream ofs(fname.c_str(), ios::out|ios::trunc);
747 retval = do_writeFile(ofs);
752 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
756 retval = do_writeFile(ofs);
763 bool Buffer::do_writeFile(ostream & ofs) const
766 // Use the standard "C" locale for file output.
767 ofs.imbue(std::locale::classic());
770 // The top of the file should not be written by params().
772 // write out a comment in the top of the file
773 ofs << "#LyX " << lyx_version
774 << " created this file. For more info see http://www.lyx.org/\n"
775 << "\\lyxformat " << LYX_FORMAT << "\n"
776 << "\\begin_document\n";
778 // now write out the buffer parameters.
779 ofs << "\\begin_header\n";
780 params().writeFile(ofs);
781 ofs << "\\end_header\n";
784 ofs << "\n\\begin_body\n";
785 text().write(*this, ofs);
786 ofs << "\n\\end_body\n";
788 // Write marker that shows file is complete
789 ofs << "\\end_document" << endl;
791 // Shouldn't really be needed....
794 // how to check if close went ok?
795 // Following is an attempt... (BE 20001011)
797 // good() returns false if any error occured, including some
799 // bad() returns true if something bad happened in the buffer,
800 // which should include file system full errors.
805 lyxerr << "File was not closed properly." << endl;
812 void Buffer::makeLaTeXFile(string const & fname,
813 string const & original_path,
814 OutputParams const & runparams,
815 bool output_preamble, bool output_body)
817 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
820 if (!openFileWrite(ofs, fname))
823 makeLaTeXFile(ofs, original_path,
824 runparams, output_preamble, output_body);
828 lyxerr << "File '" << fname << "' was not closed properly." << endl;
832 void Buffer::makeLaTeXFile(ostream & os,
833 string const & original_path,
834 OutputParams const & runparams_in,
835 bool const output_preamble, bool const output_body)
837 OutputParams runparams = runparams_in;
839 // validate the buffer.
840 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
841 LaTeXFeatures features(*this, params(), runparams.nice);
843 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
847 // The starting paragraph of the coming rows is the
848 // first paragraph of the document. (Asger)
849 texrow().start(paragraphs().begin()->id(), 0);
851 if (output_preamble && runparams.nice) {
852 os << "%% LyX " << lyx_version << " created this file. "
853 "For more info, see http://www.lyx.org/.\n"
854 "%% Do not edit unless you really know what "
859 lyxerr[Debug::INFO] << "lyx header finished" << endl;
860 // There are a few differences between nice LaTeX and usual files:
861 // usual is \batchmode and has a
862 // special input@path to allow the including of figures
863 // with either \input or \includegraphics (what figinsets do).
864 // input@path is set when the actual parameter
865 // original_path is set. This is done for usual tex-file, but not
866 // for nice-latex-file. (Matthias 250696)
867 // Note that input@path is only needed for something the user does
868 // in the preamble, included .tex files or ERT, files included by
869 // LyX work without it.
870 if (output_preamble) {
871 if (!runparams.nice) {
872 // code for usual, NOT nice-latex-file
873 os << "\\batchmode\n"; // changed
877 if (!original_path.empty()) {
878 string const inputpath = latex_path(original_path);
879 os << "\\makeatletter\n"
880 << "\\def\\input@path{{"
881 << inputpath << "/}}\n"
882 << "\\makeatother\n";
888 // Write the preamble
889 runparams.use_babel = params().writeLaTeX(os, features, texrow());
895 os << "\\begin{document}\n";
898 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
900 if (!lyxrc.language_auto_begin) {
901 os << subst(lyxrc.language_command_begin, "$$lang",
902 params().language->babel())
907 // if we are doing a real file with body, even if this is the
908 // child of some other buffer, let's cut the link here.
909 // This happens for example if only a child document is printed.
910 string save_parentname;
911 if (output_preamble) {
912 save_parentname = params().parentname;
913 params().parentname.erase();
917 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
919 // Restore the parenthood if needed
921 params().parentname = save_parentname;
923 // add this just in case after all the paragraphs
927 if (!lyxrc.language_auto_end) {
928 os << subst(lyxrc.language_command_end, "$$lang",
929 params().language->babel())
934 if (output_preamble) {
935 os << "\\end{document}\n";
938 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
940 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
944 // Just to be sure. (Asger)
947 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
948 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
953 bool Buffer::isLatex() const
955 return params().getLyXTextClass().outputType() == LATEX;
959 bool Buffer::isLinuxDoc() const
961 return params().getLyXTextClass().outputType() == LINUXDOC;
965 bool Buffer::isLiterate() const
967 return params().getLyXTextClass().outputType() == LITERATE;
971 bool Buffer::isDocBook() const
973 return params().getLyXTextClass().outputType() == DOCBOOK;
977 bool Buffer::isSGML() const
979 LyXTextClass const & tclass = params().getLyXTextClass();
981 return tclass.outputType() == LINUXDOC ||
982 tclass.outputType() == DOCBOOK;
986 void Buffer::makeLinuxDocFile(string const & fname,
987 OutputParams const & runparams,
988 bool const body_only)
991 if (!openFileWrite(ofs, fname))
994 LaTeXFeatures features(*this, params(), runparams.nice);
999 LyXTextClass const & tclass = params().getLyXTextClass();
1001 string const & top_element = tclass.latexname();
1004 ofs << tclass.class_header();
1006 string preamble = params().preamble;
1007 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1009 preamble += features.getIncludedFiles(name);
1010 preamble += features.getLyXSGMLEntities();
1012 if (!preamble.empty()) {
1013 ofs << " [ " << preamble << " ]";
1017 if (params().options.empty())
1018 sgml::openTag(ofs, top_element);
1020 string top = top_element;
1022 top += params().options;
1023 sgml::openTag(ofs, top);
1027 ofs << "<!-- LyX " << lyx_version
1028 << " created this file. For more info see http://www.lyx.org/"
1031 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1035 sgml::closeTag(ofs, top_element);
1040 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1044 void Buffer::makeDocBookFile(string const & fname,
1045 OutputParams const & runparams,
1046 bool const only_body)
1049 if (!openFileWrite(ofs, fname))
1052 LaTeXFeatures features(*this, params(), runparams.nice);
1057 LyXTextClass const & tclass = params().getLyXTextClass();
1058 string const & top_element = tclass.latexname();
1061 if (runparams.flavor == OutputParams::XML)
1062 ofs << "<?xml version=\"1.0\" encoding=\""
1063 << params().language->encoding()->Name() << "\"?>\n";
1065 ofs << "<!DOCTYPE " << top_element << " ";
1067 if (! tclass.class_header().empty()) ofs << tclass.class_header();
1068 else if (runparams.flavor == OutputParams::XML)
1069 ofs << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1070 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1072 ofs << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1074 string preamble = params().preamble;
1075 if (runparams.flavor != OutputParams::XML ) {
1076 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1077 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1078 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1079 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1082 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1084 preamble += features.getIncludedFiles(name);
1085 preamble += features.getLyXSGMLEntities();
1087 if (!preamble.empty()) {
1088 ofs << "\n [ " << preamble << " ]";
1093 string top = top_element;
1095 if (runparams.flavor == OutputParams::XML)
1096 top += params().language->code();
1098 top += params().language->code().substr(0,2);
1101 if (!params().options.empty()) {
1103 top += params().options;
1106 ofs << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1107 << " file was created by LyX " << lyx_version
1108 << "\n See http://www.lyx.org/ for more information -->\n";
1110 params().getLyXTextClass().counters().reset();
1112 sgml::openTag(ofs, top);
1114 docbookParagraphs(paragraphs(), *this, ofs, runparams);
1115 sgml::closeTag(ofs, top_element);
1119 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1123 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1124 // Other flags: -wall -v0 -x
1125 int Buffer::runChktex()
1129 // get LaTeX-Filename
1130 string const name = getLatexName();
1131 string const path = temppath();
1132 string const org_path = filePath();
1134 Path p(path); // path to LaTeX file
1135 message(_("Running chktex..."));
1137 // Generate the LaTeX file if neccessary
1138 OutputParams runparams;
1139 runparams.flavor = OutputParams::LATEX;
1140 runparams.nice = false;
1141 makeLaTeXFile(name, org_path, runparams);
1144 Chktex chktex(lyxrc.chktex_command, name, filePath());
1145 int const res = chktex.run(terr); // run chktex
1148 Alert::error(_("chktex failure"),
1149 _("Could not run chktex successfully."));
1150 } else if (res > 0) {
1151 // Insert all errors as errors boxes
1152 bufferErrors(*this, terr);
1161 void Buffer::validate(LaTeXFeatures & features) const
1163 LyXTextClass const & tclass = params().getLyXTextClass();
1165 if (features.isAvailable("dvipost") && params().tracking_changes
1166 && params().output_changes) {
1167 features.require("dvipost");
1168 features.require("color");
1171 // AMS Style is at document level
1172 if (params().use_amsmath == BufferParams::AMS_ON
1173 || tclass.provides(LyXTextClass::amsmath))
1174 features.require("amsmath");
1176 for_each(paragraphs().begin(), paragraphs().end(),
1177 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1179 // the bullet shapes are buffer level not paragraph level
1180 // so they are tested here
1181 for (int i = 0; i < 4; ++i) {
1182 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1183 int const font = params().user_defined_bullet(i).getFont();
1185 int const c = params()
1186 .user_defined_bullet(i)
1193 features.require("latexsym");
1195 } else if (font == 1) {
1196 features.require("amssymb");
1197 } else if ((font >= 2 && font <= 5)) {
1198 features.require("pifont");
1203 if (lyxerr.debugging(Debug::LATEX)) {
1204 features.showStruct();
1209 void Buffer::getLabelList(vector<string> & list) const
1211 /// if this is a child document and the parent is already loaded
1212 /// Use the parent's list instead [ale990407]
1213 Buffer const * tmp = getMasterBuffer();
1215 lyxerr << "getMasterBuffer() failed!" << endl;
1219 tmp->getLabelList(list);
1223 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1224 it.nextInset()->getLabelList(*this, list);
1228 // This is also a buffer property (ale)
1229 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1232 /// if this is a child document and the parent is already loaded
1233 /// use the parent's list instead [ale990412]
1234 Buffer const * tmp = getMasterBuffer();
1237 tmp->fillWithBibKeys(keys);
1241 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1242 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1243 InsetBibtex const & inset =
1244 dynamic_cast<InsetBibtex const &>(*it);
1245 inset.fillWithBibKeys(*this, keys);
1246 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1247 InsetInclude const & inset =
1248 dynamic_cast<InsetInclude const &>(*it);
1249 inset.fillWithBibKeys(*this, keys);
1250 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1251 InsetBibitem const & inset =
1252 dynamic_cast<InsetBibitem const &>(*it);
1253 string const key = inset.getContents();
1254 string const opt = inset.getOptions();
1255 string const ref; // = pit->asString(this, false);
1256 string const info = opt + "TheBibliographyRef" + ref;
1257 keys.push_back(pair<string, string>(key, info));
1263 bool Buffer::isDepClean(string const & name) const
1265 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1266 if (it == pimpl_->dep_clean.end())
1272 void Buffer::markDepClean(string const & name)
1274 pimpl_->dep_clean[name] = true;
1278 bool Buffer::dispatch(string const & command, bool * result)
1280 return dispatch(lyxaction.lookupFunc(command), result);
1284 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1286 bool dispatched = true;
1288 switch (func.action) {
1290 bool const tmp = Exporter::Export(this, func.argument, false);
1303 void Buffer::changeLanguage(Language const * from, Language const * to)
1308 lyxerr << "Changing Language!" << endl;
1310 // Take care of l10n/i18n
1313 for_each(par_iterator_begin(),
1315 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1319 void Buffer::updateDocLang(Language const * nlang)
1321 BOOST_ASSERT(nlang);
1323 pimpl_->messages.reset(new Messages(nlang->code()));
1327 bool Buffer::isMultiLingual() const
1329 ParConstIterator end = par_iterator_end();
1330 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1331 if (it->isMultiLingual(params()))
1338 ParIterator Buffer::getParFromID(int const id) const
1340 ParConstIterator it = par_iterator_begin();
1341 ParConstIterator const end = par_iterator_end();
1344 // John says this is called with id == -1 from undo
1345 lyxerr << "getParFromID(), id: " << id << endl;
1349 for (; it != end; ++it)
1357 bool Buffer::hasParWithID(int const id) const
1359 ParConstIterator const it = getParFromID(id);
1360 return it != par_iterator_end();
1364 ParIterator Buffer::par_iterator_begin()
1366 return ::par_iterator_begin(inset());
1370 ParIterator Buffer::par_iterator_end()
1372 return ::par_iterator_end(inset());
1376 ParConstIterator Buffer::par_iterator_begin() const
1378 return ::par_const_iterator_begin(inset());
1382 ParConstIterator Buffer::par_iterator_end() const
1384 return ::par_const_iterator_end(inset());
1388 Language const * Buffer::getLanguage() const
1390 return params().language;
1394 string const Buffer::B_(string const & l10n) const
1396 if (pimpl_->messages.get()) {
1397 return pimpl_->messages->get(l10n);
1404 bool Buffer::isClean() const
1406 return pimpl_->lyx_clean;
1410 bool Buffer::isBakClean() const
1412 return pimpl_->bak_clean;
1416 void Buffer::markClean() const
1418 if (!pimpl_->lyx_clean) {
1419 pimpl_->lyx_clean = true;
1422 // if the .lyx file has been saved, we don't need an
1424 pimpl_->bak_clean = true;
1428 void Buffer::markBakClean()
1430 pimpl_->bak_clean = true;
1434 void Buffer::setUnnamed(bool flag)
1436 pimpl_->unnamed = flag;
1440 bool Buffer::isUnnamed() const
1442 return pimpl_->unnamed;
1446 #ifdef WITH_WARNINGS
1447 #warning this function should be moved to buffer_pimpl.C
1449 void Buffer::markDirty()
1451 if (pimpl_->lyx_clean) {
1452 pimpl_->lyx_clean = false;
1455 pimpl_->bak_clean = false;
1457 DepClean::iterator it = pimpl_->dep_clean.begin();
1458 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1460 for (; it != end; ++it) {
1466 string const & Buffer::fileName() const
1468 return pimpl_->filename;
1472 string const & Buffer::filePath() const
1474 return pimpl_->filepath;
1478 bool Buffer::isReadonly() const
1480 return pimpl_->read_only;
1484 void Buffer::setParentName(string const & name)
1486 params().parentname = name;
1490 Buffer const * Buffer::getMasterBuffer() const
1492 if (!params().parentname.empty()
1493 && bufferlist.exists(params().parentname)) {
1494 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1496 return buf->getMasterBuffer();
1503 MacroData const & Buffer::getMacro(std::string const & name) const
1505 return pimpl_->macros.get(name);
1509 bool Buffer::hasMacro(string const & name) const
1511 return pimpl_->macros.has(name);
1515 void Buffer::insertMacro(string const & name, MacroData const & data)
1517 MacroTable::globalMacros().insert(name, data);
1518 pimpl_->macros.insert(name, data);
1522 void Buffer::buildMacros()
1524 // Start with global table.
1525 pimpl_->macros = MacroTable::globalMacros();
1528 ParagraphList & pars = text().paragraphs();
1529 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1530 //lyxerr << "searching main par " << i
1531 // << " for macro definitions" << std::endl;
1532 InsetList::iterator it = pars[i].insetlist.begin();
1533 InsetList::iterator end = pars[i].insetlist.end();
1534 for ( ; it != end; ++it) {
1535 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1536 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1537 MathMacroTemplate & mac
1538 = static_cast<MathMacroTemplate &>(*it->inset);
1539 insertMacro(mac.name(), mac.asMacroData());