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/lyxalgo.h"
68 #include "support/filetools.h"
69 #include "support/fs_extras.h"
70 #ifdef USE_COMPRESSION
71 # include "support/gzstream.h"
73 #include "support/lyxlib.h"
74 #include "support/os.h"
75 #include "support/path.h"
76 #include "support/textutils.h"
77 #include "support/convert.h"
79 #include <boost/bind.hpp>
80 #include <boost/filesystem/operations.hpp>
82 #if defined (HAVE_UTIME_H)
84 #elif defined (HAVE_SYS_UTIME_H)
85 # include <sys/utime.h>
97 using lyx::support::AddName;
98 using lyx::support::bformat;
99 using lyx::support::ChangeExtension;
100 using lyx::support::cmd_ret;
101 using lyx::support::createBufferTmpDir;
102 using lyx::support::destroyDir;
103 using lyx::support::getFormatFromContents;
104 using lyx::support::IsDirWriteable;
105 using lyx::support::LibFileSearch;
106 using lyx::support::latex_path;
107 using lyx::support::ltrim;
108 using lyx::support::MakeAbsPath;
109 using lyx::support::MakeDisplayPath;
110 using lyx::support::MakeLatexName;
111 using lyx::support::OnlyFilename;
112 using lyx::support::OnlyPath;
113 using lyx::support::Path;
114 using lyx::support::QuoteName;
115 using lyx::support::removeAutosaveFile;
116 using lyx::support::rename;
117 using lyx::support::RunCommand;
118 using lyx::support::split;
119 using lyx::support::subst;
120 using lyx::support::tempName;
121 using lyx::support::trim;
123 namespace os = lyx::support::os;
124 namespace fs = boost::filesystem;
128 using std::make_pair;
134 using std::ostringstream;
142 // all these externs should eventually be removed.
143 extern BufferList bufferlist;
147 int const LYX_FORMAT = 245;
152 typedef std::map<string, bool> DepClean;
157 Impl(Buffer & parent, string const & file, bool readonly);
159 limited_stack<Undo> undostack;
160 limited_stack<Undo> redostack;
166 /// need to regenerate .tex?
170 mutable bool lyx_clean;
172 /// is autosave needed?
173 mutable bool bak_clean;
175 /// is this a unnamed file (New...)?
181 /// name of the file the buffer is associated with.
184 /// The path to the document file.
187 boost::scoped_ptr<Messages> messages;
189 /** Set to true only when the file is fully loaded.
190 * Used to prevent the premature generation of previews
191 * and by the citation inset.
193 bool file_fully_loaded;
195 /// our LyXText that should be wrapped in an InsetText
203 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
204 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
205 filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
208 inset.setAutoBreakRows(true);
209 lyxvc.buffer(&parent);
210 temppath = createBufferTmpDir();
211 // FIXME: And now do something if temppath == string(), because we
212 // assume from now on that temppath points to a valid temp dir.
213 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
217 Buffer::Buffer(string const & file, bool readonly)
218 : pimpl_(new Impl(*this, file, readonly))
220 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
226 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
227 // here the buffer should take care that it is
228 // saved properly, before it goes into the void.
232 if (!temppath().empty() && !destroyDir(temppath())) {
233 Alert::warning(_("Could not remove temporary directory"),
234 bformat(_("Could not remove the temporary directory %1$s"), temppath()));
237 // Remove any previewed LaTeX snippets associated with this buffer.
238 lyx::graphics::Previews::get().removeLoader(*this);
242 LyXText & Buffer::text() const
244 return const_cast<LyXText &>(pimpl_->inset.text_);
248 InsetBase & Buffer::inset() const
250 return const_cast<InsetText &>(pimpl_->inset);
254 limited_stack<Undo> & Buffer::undostack()
256 return pimpl_->undostack;
260 limited_stack<Undo> const & Buffer::undostack() const
262 return pimpl_->undostack;
266 limited_stack<Undo> & Buffer::redostack()
268 return pimpl_->redostack;
272 limited_stack<Undo> const & Buffer::redostack() const
274 return pimpl_->redostack;
278 BufferParams & Buffer::params()
280 return pimpl_->params;
284 BufferParams const & Buffer::params() const
286 return pimpl_->params;
290 ParagraphList & Buffer::paragraphs()
292 return text().paragraphs();
296 ParagraphList const & Buffer::paragraphs() const
298 return text().paragraphs();
302 LyXVC & Buffer::lyxvc()
304 return pimpl_->lyxvc;
308 LyXVC const & Buffer::lyxvc() const
310 return pimpl_->lyxvc;
314 string const & Buffer::temppath() const
316 return pimpl_->temppath;
320 TexRow & Buffer::texrow()
322 return pimpl_->texrow;
326 TexRow const & Buffer::texrow() const
328 return pimpl_->texrow;
332 string const Buffer::getLatexName(bool const no_path) const
334 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
335 return no_path ? OnlyFilename(name) : name;
339 pair<Buffer::LogType, string> const Buffer::getLogName() const
341 string const filename = getLatexName(false);
343 if (filename.empty())
344 return make_pair(Buffer::latexlog, string());
346 string const path = temppath();
348 string const fname = AddName(path,
349 OnlyFilename(ChangeExtension(filename,
352 AddName(path, OnlyFilename(
353 ChangeExtension(filename,
354 formats.extension("literate") + ".out")));
356 // If no Latex log or Build log is newer, show Build log
358 if (fs::exists(bname) &&
359 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
360 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
361 return make_pair(Buffer::buildlog, bname);
363 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
364 return make_pair(Buffer::latexlog, fname);
368 void Buffer::setReadonly(bool const flag)
370 if (pimpl_->read_only != flag) {
371 pimpl_->read_only = flag;
377 void Buffer::setFileName(string const & newfile)
379 pimpl_->filename = MakeAbsPath(newfile);
380 pimpl_->filepath = OnlyPath(pimpl_->filename);
381 setReadonly(fs::is_readonly(pimpl_->filename));
386 // We'll remove this later. (Lgb)
389 void unknownClass(string const & unknown)
391 Alert::warning(_("Unknown document class"),
392 bformat(_("Using the default document class, because the "
393 "class %1$s is unknown."), unknown));
399 int Buffer::readHeader(LyXLex & lex)
401 int unknown_tokens = 0;
403 int begin_header_line = -1;
405 // Initialize parameters that may be/go lacking in header:
406 params().branchlist().clear();
407 params().options.erase();
408 params().float_placement.erase();
409 params().paperwidth.erase();
410 params().paperheight.erase();
411 params().leftmargin.erase();
412 params().rightmargin.erase();
413 params().topmargin.erase();
414 params().bottommargin.erase();
415 params().headheight.erase();
416 params().headsep.erase();
417 params().footskip.erase();
421 string const token = lex.getString();
426 if (token == "\\end_header")
430 if (token == "\\begin_header") {
431 begin_header_line = line;
435 lyxerr[Debug::PARSER] << "Handling document header token: `"
436 << token << '\'' << endl;
438 string unknown = params().readToken(lex, token);
439 if (!unknown.empty()) {
440 if (unknown[0] != '\\' && token == "\\textclass") {
441 unknownClass(unknown);
444 string const s = bformat(_("Unknown token: "
448 error(ErrorItem(_("Document header error"), s,
453 if (begin_header_line) {
454 string const s = _("\\begin_header is missing");
455 error(ErrorItem(_("Document header error"), s, -1, 0, 0));
457 return unknown_tokens;
462 // changed to be public and have one parameter
463 // Returns false if "\end_document" is not read (Asger)
464 bool Buffer::readDocument(LyXLex & lex)
467 string const token = lex.getString();
468 if (token != "\\begin_document") {
469 string const s = _("\\begin_document is missing");
470 error(ErrorItem(_("Document header error"), s, -1, 0, 0));
473 if (paragraphs().empty()) {
475 if (!params().getLyXTextClass().load()) {
476 string theclass = params().getLyXTextClass().name();
477 Alert::error(_("Can't load document class"), bformat(
478 "Using the default document class, because the "
479 " class %1$s could not be loaded.", theclass));
480 params().textclass = 0;
483 // We don't want to adopt the parameters from the
484 // document we insert, so read them into a temporary buffer
485 // and then discard it
487 Buffer tmpbuf("", false);
488 tmpbuf.readHeader(lex);
491 return text().read(*this, lex);
495 // needed to insert the selection
496 void Buffer::insertStringAsLines(ParagraphList & pars,
497 pit_type & pit, pos_type & pos,
498 LyXFont const & fn, string const & str, bool autobreakrows)
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"
641 string const lyx2lyx = LibFileSearch("lyx2lyx", "lyx2lyx");
642 if (lyx2lyx.empty()) {
643 Alert::error(_("Conversion script not found"),
644 bformat(_("%1$s is from an earlier"
645 " version of LyX, but the"
646 " conversion script lyx2lyx"
647 " could not be found."),
651 ostringstream command;
652 command << "python " << QuoteName(lyx2lyx)
653 << " -t " << convert<string>(LYX_FORMAT)
654 << " -o " << QuoteName(tmpfile) << ' '
655 << QuoteName(filename);
656 string const command_str = command.str();
658 lyxerr[Debug::INFO] << "Running '"
659 << command_str << '\''
662 cmd_ret const ret = RunCommand(command_str);
663 if (ret.first != 0) {
664 Alert::error(_("Conversion script failed"),
665 bformat(_("%1$s is from an earlier version"
666 " of LyX, but the lyx2lyx script"
667 " failed to convert it."),
671 bool const ret = readFile(tmpfile, pit);
672 // Do stuff with tmpfile name and buffer name here.
678 if (readDocument(lex)) {
679 Alert::error(_("Document format failure"),
680 bformat(_("%1$s ended unexpectedly, which means"
681 " that it is probably corrupted."),
685 //lyxerr << "removing " << MacroTable::localMacros().size()
686 // << " temporary macro entries" << endl;
687 //MacroTable::localMacros().clear();
689 pimpl_->file_fully_loaded = true;
694 // Should probably be moved to somewhere else: BufferView? LyXView?
695 bool Buffer::save() const
697 // We don't need autosaves in the immediate future. (Asger)
698 resetAutosaveTimers();
702 if (lyxrc.make_backup) {
703 s = fileName() + '~';
704 if (!lyxrc.backupdir_path.empty())
705 s = AddName(lyxrc.backupdir_path,
706 subst(os::internal_path(s),'/','!'));
708 // It might very well be that this variant is just
709 // good enough. (Lgb)
710 // But to use this we need fs::copy_file to actually do a copy,
711 // even when the target file exists. (Lgb)
712 if (fs::exists(fileName()) && fs::is_writable(fs::path(fileName()).branch_path())) {
714 fs::copy_file(fileName(), s, false);
716 //catch (fs::filesystem_error const & fe) {
717 //lyxerr << "LyX was not able to make backup copy. Beware.\n"
718 // << fe.what() << endl;
723 if (writeFile(fileName())) {
725 removeAutosaveFile(fileName());
727 // Saving failed, so backup is not backup
728 if (lyxrc.make_backup)
729 rename(s, fileName());
736 bool Buffer::writeFile(string const & fname) const
738 if (pimpl_->read_only && fname == fileName())
743 if (params().compressed) {
744 #ifdef USE_COMPRESSION
745 gz::ogzstream ofs(fname.c_str(), ios::out|ios::trunc);
749 retval = do_writeFile(ofs);
754 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
758 retval = do_writeFile(ofs);
765 bool Buffer::do_writeFile(ostream & ofs) const
768 // Use the standard "C" locale for file output.
769 ofs.imbue(std::locale::classic());
772 // The top of the file should not be written by params().
774 // write out a comment in the top of the file
775 ofs << "#LyX " << lyx_version
776 << " created this file. For more info see http://www.lyx.org/\n"
777 << "\\lyxformat " << LYX_FORMAT << "\n"
778 << "\\begin_document\n";
780 // now write out the buffer parameters.
781 ofs << "\\begin_header\n";
782 params().writeFile(ofs);
783 ofs << "\\end_header\n";
786 ofs << "\n\\begin_body\n";
787 text().write(*this, ofs);
788 ofs << "\n\\end_body\n";
790 // Write marker that shows file is complete
791 ofs << "\\end_document" << endl;
793 // Shouldn't really be needed....
796 // how to check if close went ok?
797 // Following is an attempt... (BE 20001011)
799 // good() returns false if any error occured, including some
801 // bad() returns true if something bad happened in the buffer,
802 // which should include file system full errors.
807 lyxerr << "File was not closed properly." << endl;
814 void Buffer::makeLaTeXFile(string const & fname,
815 string const & original_path,
816 OutputParams const & runparams,
817 bool output_preamble, bool output_body)
819 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
822 if (!openFileWrite(ofs, fname))
825 makeLaTeXFile(ofs, original_path,
826 runparams, output_preamble, output_body);
830 lyxerr << "File '" << fname << "' was not closed properly." << endl;
834 void Buffer::makeLaTeXFile(ostream & os,
835 string const & original_path,
836 OutputParams const & runparams_in,
837 bool const output_preamble, bool const output_body)
839 OutputParams runparams = runparams_in;
841 // validate the buffer.
842 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
843 LaTeXFeatures features(*this, params(), runparams.nice);
845 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
849 // The starting paragraph of the coming rows is the
850 // first paragraph of the document. (Asger)
851 texrow().start(paragraphs().begin()->id(), 0);
853 if (output_preamble && runparams.nice) {
854 os << "%% LyX " << lyx_version << " created this file. "
855 "For more info, see http://www.lyx.org/.\n"
856 "%% Do not edit unless you really know what "
861 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
862 // There are a few differences between nice LaTeX and usual files:
863 // usual is \batchmode and has a
864 // special input@path to allow the including of figures
865 // with either \input or \includegraphics (what figinsets do).
866 // input@path is set when the actual parameter
867 // original_path is set. This is done for usual tex-file, but not
868 // for nice-latex-file. (Matthias 250696)
869 // Note that input@path is only needed for something the user does
870 // in the preamble, included .tex files or ERT, files included by
871 // LyX work without it.
872 if (output_preamble) {
873 if (!runparams.nice) {
874 // code for usual, NOT nice-latex-file
875 os << "\\batchmode\n"; // changed
879 if (!original_path.empty()) {
880 string const inputpath = latex_path(original_path);
881 os << "\\makeatletter\n"
882 << "\\def\\input@path{{"
883 << inputpath << "/}}\n"
884 << "\\makeatother\n";
890 // Write the preamble
891 runparams.use_babel = params().writeLaTeX(os, features, texrow());
897 os << "\\begin{document}\n";
900 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
902 if (!lyxrc.language_auto_begin) {
903 os << subst(lyxrc.language_command_begin, "$$lang",
904 params().language->babel())
909 // if we are doing a real file with body, even if this is the
910 // child of some other buffer, let's cut the link here.
911 // This happens for example if only a child document is printed.
912 string save_parentname;
913 if (output_preamble) {
914 save_parentname = params().parentname;
915 params().parentname.erase();
919 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
921 // Restore the parenthood if needed
923 params().parentname = save_parentname;
925 // add this just in case after all the paragraphs
929 if (!lyxrc.language_auto_end) {
930 os << subst(lyxrc.language_command_end, "$$lang",
931 params().language->babel())
936 if (output_preamble) {
937 os << "\\end{document}\n";
940 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
942 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
946 // Just to be sure. (Asger)
949 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
950 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
955 bool Buffer::isLatex() const
957 return params().getLyXTextClass().outputType() == LATEX;
961 bool Buffer::isLinuxDoc() const
963 return params().getLyXTextClass().outputType() == LINUXDOC;
967 bool Buffer::isLiterate() const
969 return params().getLyXTextClass().outputType() == LITERATE;
973 bool Buffer::isDocBook() const
975 return params().getLyXTextClass().outputType() == DOCBOOK;
979 bool Buffer::isSGML() const
981 LyXTextClass const & tclass = params().getLyXTextClass();
983 return tclass.outputType() == LINUXDOC ||
984 tclass.outputType() == DOCBOOK;
988 void Buffer::makeLinuxDocFile(string const & fname,
989 OutputParams const & runparams,
990 bool const body_only)
993 if (!openFileWrite(ofs, fname))
996 LaTeXFeatures features(*this, params(), runparams.nice);
1001 LyXTextClass const & tclass = params().getLyXTextClass();
1003 string const & top_element = tclass.latexname();
1006 ofs << tclass.class_header();
1008 string preamble = params().preamble;
1009 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1011 preamble += features.getIncludedFiles(name);
1012 preamble += features.getLyXSGMLEntities();
1014 if (!preamble.empty()) {
1015 ofs << " [ " << preamble << " ]";
1019 if (params().options.empty())
1020 sgml::openTag(ofs, top_element);
1022 string top = top_element;
1024 top += params().options;
1025 sgml::openTag(ofs, top);
1029 ofs << "<!-- LyX " << lyx_version
1030 << " created this file. For more info see http://www.lyx.org/"
1033 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1037 sgml::closeTag(ofs, top_element);
1042 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1046 void Buffer::makeDocBookFile(string const & fname,
1047 OutputParams const & runparams,
1048 bool const only_body)
1051 if (!openFileWrite(ofs, fname))
1054 LaTeXFeatures features(*this, params(), runparams.nice);
1059 LyXTextClass const & tclass = params().getLyXTextClass();
1060 string const & top_element = tclass.latexname();
1063 if (runparams.flavor == OutputParams::XML)
1064 ofs << "<?xml version=\"1.0\" encoding=\""
1065 << params().language->encoding()->Name() << "\"?>\n";
1067 ofs << "<!DOCTYPE " << top_element << " ";
1069 if (! tclass.class_header().empty()) ofs << tclass.class_header();
1070 else if (runparams.flavor == OutputParams::XML)
1071 ofs << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1072 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1074 ofs << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1076 string preamble = params().preamble;
1077 if (runparams.flavor != OutputParams::XML ) {
1078 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1079 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1080 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1081 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1084 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1086 preamble += features.getIncludedFiles(name);
1087 preamble += features.getLyXSGMLEntities();
1089 if (!preamble.empty()) {
1090 ofs << "\n [ " << preamble << " ]";
1095 string top = top_element;
1097 if (runparams.flavor == OutputParams::XML)
1098 top += params().language->code();
1100 top += params().language->code().substr(0,2);
1103 if (!params().options.empty()) {
1105 top += params().options;
1108 ofs << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1109 << " file was created by LyX " << lyx_version
1110 << "\n See http://www.lyx.org/ for more information -->\n";
1112 params().getLyXTextClass().counters().reset();
1114 sgml::openTag(ofs, top);
1116 docbookParagraphs(paragraphs(), *this, ofs, runparams);
1117 sgml::closeTag(ofs, top_element);
1121 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1125 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1126 // Other flags: -wall -v0 -x
1127 int Buffer::runChktex()
1131 // get LaTeX-Filename
1132 string const name = getLatexName();
1133 string const path = temppath();
1134 string const org_path = filePath();
1136 Path p(path); // path to LaTeX file
1137 message(_("Running chktex..."));
1139 // Generate the LaTeX file if neccessary
1140 OutputParams runparams;
1141 runparams.flavor = OutputParams::LATEX;
1142 runparams.nice = false;
1143 makeLaTeXFile(name, org_path, runparams);
1146 Chktex chktex(lyxrc.chktex_command, name, filePath());
1147 int const res = chktex.run(terr); // run chktex
1150 Alert::error(_("chktex failure"),
1151 _("Could not run chktex successfully."));
1152 } else if (res > 0) {
1153 // Insert all errors as errors boxes
1154 bufferErrors(*this, terr);
1163 void Buffer::validate(LaTeXFeatures & features) const
1165 LyXTextClass const & tclass = params().getLyXTextClass();
1167 if (features.isAvailable("dvipost") && params().tracking_changes
1168 && params().output_changes) {
1169 features.require("dvipost");
1170 features.require("color");
1173 // AMS Style is at document level
1174 if (params().use_amsmath == BufferParams::AMS_ON
1175 || tclass.provides(LyXTextClass::amsmath))
1176 features.require("amsmath");
1178 for_each(paragraphs().begin(), paragraphs().end(),
1179 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1181 // the bullet shapes are buffer level not paragraph level
1182 // so they are tested here
1183 for (int i = 0; i < 4; ++i) {
1184 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1185 int const font = params().user_defined_bullet(i).getFont();
1187 int const c = params()
1188 .user_defined_bullet(i)
1195 features.require("latexsym");
1197 } else if (font == 1) {
1198 features.require("amssymb");
1199 } else if ((font >= 2 && font <= 5)) {
1200 features.require("pifont");
1205 if (lyxerr.debugging(Debug::LATEX)) {
1206 features.showStruct();
1211 void Buffer::getLabelList(vector<string> & list) const
1213 /// if this is a child document and the parent is already loaded
1214 /// Use the parent's list instead [ale990407]
1215 Buffer const * tmp = getMasterBuffer();
1217 lyxerr << "getMasterBuffer() failed!" << endl;
1221 tmp->getLabelList(list);
1225 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1226 it.nextInset()->getLabelList(*this, list);
1230 // This is also a buffer property (ale)
1231 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1234 /// if this is a child document and the parent is already loaded
1235 /// use the parent's list instead [ale990412]
1236 Buffer const * tmp = getMasterBuffer();
1239 tmp->fillWithBibKeys(keys);
1243 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1244 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1245 InsetBibtex const & inset =
1246 dynamic_cast<InsetBibtex const &>(*it);
1247 inset.fillWithBibKeys(*this, keys);
1248 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1249 InsetInclude const & inset =
1250 dynamic_cast<InsetInclude const &>(*it);
1251 inset.fillWithBibKeys(*this, keys);
1252 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1253 InsetBibitem const & inset =
1254 dynamic_cast<InsetBibitem const &>(*it);
1255 string const key = inset.getContents();
1256 string const opt = inset.getOptions();
1257 string const ref; // = pit->asString(this, false);
1258 string const info = opt + "TheBibliographyRef" + ref;
1259 keys.push_back(pair<string, string>(key, info));
1265 bool Buffer::isDepClean(string const & name) const
1267 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1268 if (it == pimpl_->dep_clean.end())
1274 void Buffer::markDepClean(string const & name)
1276 pimpl_->dep_clean[name] = true;
1280 bool Buffer::dispatch(string const & command, bool * result)
1282 return dispatch(lyxaction.lookupFunc(command), result);
1286 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1288 bool dispatched = true;
1290 switch (func.action) {
1292 bool const tmp = Exporter::Export(this, func.argument, false);
1305 void Buffer::changeLanguage(Language const * from, Language const * to)
1310 lyxerr << "Changing Language!" << endl;
1312 // Take care of l10n/i18n
1315 for_each(par_iterator_begin(),
1317 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1321 void Buffer::updateDocLang(Language const * nlang)
1323 BOOST_ASSERT(nlang);
1325 pimpl_->messages.reset(new Messages(nlang->code()));
1329 bool Buffer::isMultiLingual() const
1331 ParConstIterator end = par_iterator_end();
1332 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1333 if (it->isMultiLingual(params()))
1340 ParIterator Buffer::getParFromID(int const id) const
1342 ParConstIterator it = par_iterator_begin();
1343 ParConstIterator const end = par_iterator_end();
1346 // John says this is called with id == -1 from undo
1347 lyxerr << "getParFromID(), id: " << id << endl;
1351 for (; it != end; ++it)
1359 bool Buffer::hasParWithID(int const id) const
1361 ParConstIterator const it = getParFromID(id);
1362 return it != par_iterator_end();
1366 ParIterator Buffer::par_iterator_begin()
1368 return ::par_iterator_begin(inset());
1372 ParIterator Buffer::par_iterator_end()
1374 return ::par_iterator_end(inset());
1378 ParConstIterator Buffer::par_iterator_begin() const
1380 return ::par_const_iterator_begin(inset());
1384 ParConstIterator Buffer::par_iterator_end() const
1386 return ::par_const_iterator_end(inset());
1390 Language const * Buffer::getLanguage() const
1392 return params().language;
1396 string const Buffer::B_(string const & l10n) const
1398 if (pimpl_->messages.get()) {
1399 return pimpl_->messages->get(l10n);
1406 bool Buffer::isClean() const
1408 return pimpl_->lyx_clean;
1412 bool Buffer::isBakClean() const
1414 return pimpl_->bak_clean;
1418 void Buffer::markClean() const
1420 if (!pimpl_->lyx_clean) {
1421 pimpl_->lyx_clean = true;
1424 // if the .lyx file has been saved, we don't need an
1426 pimpl_->bak_clean = true;
1430 void Buffer::markBakClean()
1432 pimpl_->bak_clean = true;
1436 void Buffer::setUnnamed(bool flag)
1438 pimpl_->unnamed = flag;
1442 bool Buffer::isUnnamed() const
1444 return pimpl_->unnamed;
1448 #ifdef WITH_WARNINGS
1449 #warning this function should be moved to buffer_pimpl.C
1451 void Buffer::markDirty()
1453 if (pimpl_->lyx_clean) {
1454 pimpl_->lyx_clean = false;
1457 pimpl_->bak_clean = false;
1459 DepClean::iterator it = pimpl_->dep_clean.begin();
1460 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1462 for (; it != end; ++it) {
1468 string const & Buffer::fileName() const
1470 return pimpl_->filename;
1474 string const & Buffer::filePath() const
1476 return pimpl_->filepath;
1480 bool Buffer::isReadonly() const
1482 return pimpl_->read_only;
1486 void Buffer::setParentName(string const & name)
1488 params().parentname = name;
1492 Buffer const * Buffer::getMasterBuffer() const
1494 if (!params().parentname.empty()
1495 && bufferlist.exists(params().parentname)) {
1496 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1498 return buf->getMasterBuffer();
1505 MacroData const & Buffer::getMacro(std::string const & name) const
1507 return pimpl_->macros.get(name);
1511 bool Buffer::hasMacro(string const & name) const
1513 return pimpl_->macros.has(name);
1517 void Buffer::insertMacro(string const & name, MacroData const & data)
1519 MacroTable::globalMacros().insert(name, data);
1520 pimpl_->macros.insert(name, data);
1524 void Buffer::buildMacros()
1526 // Start with global table.
1527 pimpl_->macros = MacroTable::globalMacros();
1530 ParagraphList const & pars = text().paragraphs();
1531 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1532 //lyxerr << "searching main par " << i
1533 // << " for macro definitions" << std::endl;
1534 InsetList const & insets = pars[i].insetlist;
1535 InsetList::const_iterator it = insets.begin();
1536 InsetList::const_iterator end = insets.end();
1537 for ( ; it != end; ++it) {
1538 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1539 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1540 MathMacroTemplate const & mac
1541 = static_cast<MathMacroTemplate const &>(*it->inset);
1542 insertMacro(mac.name(), mac.asMacroData());
1549 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1556 void Buffer::changeRefsIfUnique(string const & from, string const & to)
1558 // Check if the label 'from' appears more than once
1559 vector<string> labels;
1560 getLabelList(labels);
1562 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1565 InsetBase::Code code = InsetBase::REF_CODE;
1567 ParIterator it = par_iterator_begin();
1568 ParIterator end = par_iterator_end();
1569 for ( ; it != end; ++it) {
1570 bool changed_inset = false;
1571 for (InsetList::iterator it2 = it->insetlist.begin();
1572 it2 != it->insetlist.end(); ++it2) {
1573 if (it2->inset->lyxCode() == code) {
1574 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1575 if (inset->getContents() == from) {
1576 inset->setContents(to);
1577 //inset->setButtonLabel();
1578 changed_inset = true;