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 "paragraph.h"
45 #include "paragraph_funcs.h"
46 #include "ParagraphParameters.h"
47 #include "pariterator.h"
53 #include "insets/insetbibitem.h"
54 #include "insets/insetbibtex.h"
55 #include "insets/insetinclude.h"
56 #include "insets/insettext.h"
58 #include "mathed/MathMacroTemplate.h"
59 #include "mathed/MathMacroTable.h"
60 #include "mathed/MathSupport.h"
62 #include "frontends/Alert.h"
64 #include "graphics/Previews.h"
66 #include "support/types.h"
67 #include "support/lyxalgo.h"
68 #include "support/filetools.h"
69 #include "support/fs_extras.h"
70 #include <boost/iostreams/filtering_stream.hpp>
71 #include <boost/iostreams/filter/gzip.hpp>
72 #include <boost/iostreams/device/file.hpp>
73 namespace io = boost::iostreams;
74 #include "support/lyxlib.h"
75 #include "support/os.h"
76 #include "support/path.h"
77 #include "support/textutils.h"
78 #include "support/convert.h"
80 #include <boost/bind.hpp>
81 #include <boost/filesystem/exception.hpp>
82 #include <boost/filesystem/operations.hpp>
84 #if defined (HAVE_UTIME_H)
86 #elif defined (HAVE_SYS_UTIME_H)
87 #include <sys/utime.h>
100 using lyx::support::addName;
101 using lyx::support::bformat;
102 using lyx::support::changeExtension;
103 using lyx::support::cmd_ret;
104 using lyx::support::createBufferTmpDir;
105 using lyx::support::destroyDir;
106 using lyx::support::getFormatFromContents;
107 using lyx::support::isDirWriteable;
108 using lyx::support::libFileSearch;
109 using lyx::support::latex_path;
110 using lyx::support::ltrim;
111 using lyx::support::makeAbsPath;
112 using lyx::support::makeDisplayPath;
113 using lyx::support::makeLatexName;
114 using lyx::support::onlyFilename;
115 using lyx::support::onlyPath;
116 using lyx::support::quoteName;
117 using lyx::support::removeAutosaveFile;
118 using lyx::support::rename;
119 using lyx::support::runCommand;
120 using lyx::support::split;
121 using lyx::support::subst;
122 using lyx::support::tempName;
123 using lyx::support::trim;
125 namespace Alert = lyx::frontend::Alert;
126 namespace os = lyx::support::os;
127 namespace fs = boost::filesystem;
131 using std::make_pair;
137 using std::ostringstream;
147 int const LYX_FORMAT = 249;
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 boost::scoped_ptr<Messages> messages;
186 /** Set to true only when the file is fully loaded.
187 * Used to prevent the premature generation of previews
188 * and by the citation inset.
190 bool file_fully_loaded;
192 /// our LyXText that should be wrapped in an InsetText
200 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
201 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
202 filename(file), file_fully_loaded(false),
205 inset.setAutoBreakRows(true);
206 lyxvc.buffer(&parent);
207 temppath = createBufferTmpDir();
208 params.filepath = onlyPath(file);
209 // FIXME: And now do something if temppath == string(), because we
210 // assume from now on that temppath points to a valid temp dir.
211 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
215 Buffer::Buffer(string const & file, bool readonly)
216 : pimpl_(new Impl(*this, file, readonly))
218 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
224 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
225 // here the buffer should take care that it is
226 // saved properly, before it goes into the void.
230 if (!temppath().empty() && !destroyDir(temppath())) {
231 Alert::warning(_("Could not remove temporary directory"),
232 bformat(_("Could not remove the temporary directory %1$s"),
233 lyx::from_utf8(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 params().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."), lyx::from_utf8(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().preamble.erase();
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();
419 ErrorList & errorList = errorLists_["Parse"];
423 string const token = lex.getString();
428 if (token == "\\end_header")
432 if (token == "\\begin_header") {
433 begin_header_line = line;
437 lyxerr[Debug::PARSER] << "Handling document header token: `"
438 << token << '\'' << endl;
440 string unknown = params().readToken(lex, token);
441 if (!unknown.empty()) {
442 if (unknown[0] != '\\' && token == "\\textclass") {
443 unknownClass(unknown);
446 docstring const s = bformat(_("Unknown token: "
448 lyx::from_utf8(token),
449 lyx::from_utf8(lex.getString()));
450 errorList.push_back(ErrorItem(_("Document header error"),
455 if (begin_header_line) {
456 docstring const s = _("\\begin_header is missing");
457 errorList.push_back(ErrorItem(_("Document header error"),
461 return unknown_tokens;
466 // changed to be public and have one parameter
467 // Returns false if "\end_document" is not read (Asger)
468 bool Buffer::readDocument(LyXLex & lex)
470 ErrorList & errorList = errorLists_["Parse"];
474 string const token = lex.getString();
475 if (token != "\\begin_document") {
476 docstring const s = _("\\begin_document is missing");
477 errorList.push_back(ErrorItem(_("Document header error"),
481 // we are reading in a brand new document
482 BOOST_ASSERT(paragraphs().empty());
485 if (!params().getLyXTextClass().load(filePath())) {
486 string theclass = params().getLyXTextClass().name();
487 Alert::error(_("Can't load document class"), bformat(
488 _("Using the default document class, because the "
489 " class %1$s could not be loaded."), lyx::from_utf8(theclass)));
490 params().textclass = 0;
493 bool const res = text().read(*this, lex, errorList);
494 for_each(text().paragraphs().begin(),
495 text().paragraphs().end(),
496 bind(&Paragraph::setInsetOwner, _1, &inset()));
497 updateBibfilesCache();
503 // needed to insert the selection
504 void Buffer::insertStringAsLines(ParagraphList & pars,
505 pit_type & pit, pos_type & pos,
506 LyXFont const & fn, docstring const & str, bool autobreakrows)
510 // insert the string, don't insert doublespace
511 bool space_inserted = true;
512 for (docstring::const_iterator cit = str.begin();
513 cit != str.end(); ++cit) {
514 Paragraph & par = pars[pit];
516 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
517 breakParagraph(params(), pars, pit, pos,
518 par.layout()->isEnvironment());
521 space_inserted = true;
525 // do not insert consecutive spaces if !free_spacing
526 } else if ((*cit == ' ' || *cit == '\t') &&
527 space_inserted && !par.isFreeSpacing()) {
529 } else if (*cit == '\t') {
530 if (!par.isFreeSpacing()) {
531 // tabs are like spaces here
532 // FIXME: change tracking (MG)
533 par.insertChar(pos, ' ', font, Change(Change::INSERTED));
535 space_inserted = true;
537 const pos_type n = 8 - pos % 8;
538 for (pos_type i = 0; i < n; ++i) {
539 // FIXME: change tracking (MG)
540 par.insertChar(pos, ' ', font, Change(Change::INSERTED));
543 space_inserted = true;
545 /* FIXME: not needed anymore?
546 } else if (!isPrintable(*cit)) {
547 // Ignore unprintables
551 // just insert the character
552 // FIXME: change tracking (MG)
553 par.insertChar(pos, *cit, font, Change(Change::INSERTED));
555 space_inserted = (*cit == ' ');
562 bool Buffer::readFile(string const & filename)
564 // Check if the file is compressed.
565 string const format = getFormatFromContents(filename);
566 if (format == "gzip" || format == "zip" || format == "compress") {
567 params().compressed = true;
570 // remove dummy empty par
571 paragraphs().clear();
573 lex.setFile(filename);
574 if (!readFile(lex, filename))
577 // After we have read a file, we must ensure that the buffer
578 // language is set and used in the gui.
579 // If you know of a better place to put this, please tell me. (Lgb)
580 updateDocLang(params().language);
586 bool Buffer::fully_loaded() const
588 return pimpl_->file_fully_loaded;
592 void Buffer::fully_loaded(bool const value)
594 pimpl_->file_fully_loaded = value;
598 bool Buffer::readFile(LyXLex & lex, string const & filename)
600 BOOST_ASSERT(!filename.empty());
603 Alert::error(_("Document could not be read"),
604 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
609 string const token(lex.getString());
612 Alert::error(_("Document could not be read"),
613 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
617 // the first token _must_ be...
618 if (token != "\\lyxformat") {
619 lyxerr << "Token: " << token << endl;
621 Alert::error(_("Document format failure"),
622 bformat(_("%1$s is not a LyX document."),
623 lyx::from_utf8(filename)));
628 string tmp_format = lex.getString();
629 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
630 // if present remove ".," from string.
631 string::size_type dot = tmp_format.find_first_of(".,");
632 //lyxerr << " dot found at " << dot << endl;
633 if (dot != string::npos)
634 tmp_format.erase(dot, 1);
635 int const file_format = convert<int>(tmp_format);
636 //lyxerr << "format: " << file_format << endl;
638 if (file_format != LYX_FORMAT) {
639 string const tmpfile = tempName();
640 if (tmpfile.empty()) {
641 Alert::error(_("Conversion failed"),
642 bformat(_("%1$s is from an earlier"
643 " version of LyX, but a temporary"
644 " file for converting it could"
646 lyx::from_utf8(filename)));
649 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
650 if (lyx2lyx.empty()) {
651 Alert::error(_("Conversion script not found"),
652 bformat(_("%1$s is from an earlier"
653 " version of LyX, but the"
654 " conversion script lyx2lyx"
655 " could not be found."),
656 lyx::from_utf8(filename)));
659 ostringstream command;
660 command << os::python() << ' ' << quoteName(lyx2lyx)
661 << " -t " << convert<string>(LYX_FORMAT)
662 << " -o " << quoteName(tmpfile) << ' '
663 << quoteName(filename);
664 string const command_str = command.str();
666 lyxerr[Debug::INFO] << "Running '"
667 << command_str << '\''
670 cmd_ret const ret = runCommand(command_str);
671 if (ret.first != 0) {
672 Alert::error(_("Conversion script failed"),
673 bformat(_("%1$s is from an earlier version"
674 " of LyX, but the lyx2lyx script"
675 " failed to convert it."),
676 lyx::from_utf8(filename)));
679 bool const ret = readFile(tmpfile);
680 // Do stuff with tmpfile name and buffer name here.
686 if (readDocument(lex)) {
687 Alert::error(_("Document format failure"),
688 bformat(_("%1$s ended unexpectedly, which means"
689 " that it is probably corrupted."),
690 lyx::from_utf8(filename)));
693 //lyxerr << "removing " << MacroTable::localMacros().size()
694 // << " temporary macro entries" << endl;
695 //MacroTable::localMacros().clear();
697 pimpl_->file_fully_loaded = true;
702 // Should probably be moved to somewhere else: BufferView? LyXView?
703 bool Buffer::save() const
705 // We don't need autosaves in the immediate future. (Asger)
706 resetAutosaveTimers();
710 if (lyxrc.make_backup) {
711 s = fileName() + '~';
712 if (!lyxrc.backupdir_path.empty())
713 s = addName(lyxrc.backupdir_path,
714 subst(os::internal_path(s),'/','!'));
716 // It might very well be that this variant is just
717 // good enough. (Lgb)
718 // But to use this we need fs::copy_file to actually do a copy,
719 // even when the target file exists. (Lgb)
721 fs::copy_file(fileName(), s, false);
723 catch (fs::filesystem_error const & fe) {
724 Alert::error(_("Backup failure"),
725 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
726 "Please check if the directory exists and is writeable."),
727 lyx::from_utf8(fs::path(s).branch_path().native_directory_string())));
728 lyxerr[Debug::DEBUG] << "Fs error: "
729 << fe.what() << endl;
733 if (writeFile(fileName())) {
735 removeAutosaveFile(fileName());
737 // Saving failed, so backup is not backup
738 if (lyxrc.make_backup)
739 rename(s, fileName());
746 bool Buffer::writeFile(string const & fname) const
748 if (pimpl_->read_only && fname == fileName())
753 if (params().compressed) {
754 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
758 retval = do_writeFile(ofs);
760 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
764 retval = do_writeFile(ofs);
771 bool Buffer::do_writeFile(ostream & ofs) const
774 // Use the standard "C" locale for file output.
775 ofs.imbue(std::locale::classic());
778 // The top of the file should not be written by params().
780 // write out a comment in the top of the file
781 ofs << "#LyX " << lyx_version
782 << " created this file. For more info see http://www.lyx.org/\n"
783 << "\\lyxformat " << LYX_FORMAT << "\n"
784 << "\\begin_document\n";
786 // now write out the buffer parameters.
787 ofs << "\\begin_header\n";
788 params().writeFile(ofs);
789 ofs << "\\end_header\n";
792 ofs << "\n\\begin_body\n";
793 text().write(*this, ofs);
794 ofs << "\n\\end_body\n";
796 // Write marker that shows file is complete
797 ofs << "\\end_document" << endl;
799 // Shouldn't really be needed....
802 // how to check if close went ok?
803 // Following is an attempt... (BE 20001011)
805 // good() returns false if any error occured, including some
807 // bad() returns true if something bad happened in the buffer,
808 // which should include file system full errors.
813 lyxerr << "File was not closed properly." << endl;
820 void Buffer::makeLaTeXFile(string const & fname,
821 string const & original_path,
822 OutputParams const & runparams,
823 bool output_preamble, bool output_body)
825 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
828 if (!openFileWrite(ofs, fname))
831 writeLaTeXSource(ofs, original_path,
832 runparams, output_preamble, output_body);
836 lyxerr << "File '" << fname << "' was not closed properly." << endl;
840 void Buffer::writeLaTeXSource(ostream & os,
841 string const & original_path,
842 OutputParams const & runparams_in,
843 bool const output_preamble, bool const output_body)
845 OutputParams runparams = runparams_in;
847 // validate the buffer.
848 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
849 LaTeXFeatures features(*this, params(), runparams);
851 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
855 // The starting paragraph of the coming rows is the
856 // first paragraph of the document. (Asger)
857 texrow().start(paragraphs().begin()->id(), 0);
859 if (output_preamble && runparams.nice) {
860 os << "%% LyX " << lyx_version << " created this file. "
861 "For more info, see http://www.lyx.org/.\n"
862 "%% Do not edit unless you really know what "
867 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
868 // There are a few differences between nice LaTeX and usual files:
869 // usual is \batchmode and has a
870 // special input@path to allow the including of figures
871 // with either \input or \includegraphics (what figinsets do).
872 // input@path is set when the actual parameter
873 // original_path is set. This is done for usual tex-file, but not
874 // for nice-latex-file. (Matthias 250696)
875 // Note that input@path is only needed for something the user does
876 // in the preamble, included .tex files or ERT, files included by
877 // LyX work without it.
878 if (output_preamble) {
879 if (!runparams.nice) {
880 // code for usual, NOT nice-latex-file
881 os << "\\batchmode\n"; // changed
885 if (!original_path.empty()) {
886 string const inputpath = latex_path(original_path);
887 os << "\\makeatletter\n"
888 << "\\def\\input@path{{"
889 << inputpath << "/}}\n"
890 << "\\makeatother\n";
896 // Write the preamble
897 runparams.use_babel = params().writeLaTeX(os, features, texrow());
903 os << "\\begin{document}\n";
906 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
908 if (!lyxrc.language_auto_begin) {
909 os << subst(lyxrc.language_command_begin, "$$lang",
910 params().language->babel())
915 // if we are doing a real file with body, even if this is the
916 // child of some other buffer, let's cut the link here.
917 // This happens for example if only a child document is printed.
918 string save_parentname;
919 if (output_preamble) {
920 save_parentname = params().parentname;
921 params().parentname.erase();
925 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
927 // Restore the parenthood if needed
929 params().parentname = save_parentname;
931 // add this just in case after all the paragraphs
935 if (!lyxrc.language_auto_end) {
936 os << subst(lyxrc.language_command_end, "$$lang",
937 params().language->babel())
942 if (output_preamble) {
943 os << "\\end{document}\n";
946 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
948 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
952 // Just to be sure. (Asger)
955 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
956 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
961 bool Buffer::isLatex() const
963 return params().getLyXTextClass().outputType() == LATEX;
967 bool Buffer::isLiterate() const
969 return params().getLyXTextClass().outputType() == LITERATE;
973 bool Buffer::isDocBook() const
975 return params().getLyXTextClass().outputType() == DOCBOOK;
979 void Buffer::makeDocBookFile(string const & fname,
980 OutputParams const & runparams,
981 bool const body_only)
983 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
986 if (!openFileWrite(ofs, fname))
989 writeDocBookSource(ofs, fname, runparams, body_only);
993 lyxerr << "File '" << fname << "' was not closed properly." << endl;
997 void Buffer::writeDocBookSource(ostream & os, string const & fname,
998 OutputParams const & runparams,
999 bool const only_body)
1001 LaTeXFeatures features(*this, params(), runparams);
1006 LyXTextClass const & tclass = params().getLyXTextClass();
1007 string const & top_element = tclass.latexname();
1010 if (runparams.flavor == OutputParams::XML)
1011 os << "<?xml version=\"1.0\" encoding=\""
1012 << params().language->encoding()->name() << "\"?>\n";
1014 os << "<!DOCTYPE " << top_element << " ";
1016 if (! tclass.class_header().empty()) os << tclass.class_header();
1017 else if (runparams.flavor == OutputParams::XML)
1018 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1019 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1021 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1023 string preamble = params().preamble;
1024 if (runparams.flavor != OutputParams::XML ) {
1025 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1026 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1027 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1028 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1031 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1033 preamble += features.getIncludedFiles(name);
1034 preamble += features.getLyXSGMLEntities();
1036 if (!preamble.empty()) {
1037 os << "\n [ " << preamble << " ]";
1042 string top = top_element;
1044 if (runparams.flavor == OutputParams::XML)
1045 top += params().language->code();
1047 top += params().language->code().substr(0,2);
1050 if (!params().options.empty()) {
1052 top += params().options;
1055 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1056 << " file was created by LyX " << lyx_version
1057 << "\n See http://www.lyx.org/ for more information -->\n";
1059 params().getLyXTextClass().counters().reset();
1061 sgml::openTag(os, top);
1063 docbookParagraphs(paragraphs(), *this, os, runparams);
1064 sgml::closeTag(os, top_element);
1068 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1069 // Other flags: -wall -v0 -x
1070 int Buffer::runChktex()
1074 // get LaTeX-Filename
1075 string const name = getLatexName();
1076 string const path = temppath();
1077 string const org_path = filePath();
1079 lyx::support::Path p(path); // path to LaTeX file
1080 message(_("Running chktex..."));
1082 // Generate the LaTeX file if neccessary
1083 OutputParams runparams;
1084 runparams.flavor = OutputParams::LATEX;
1085 runparams.nice = false;
1086 makeLaTeXFile(name, org_path, runparams);
1089 Chktex chktex(lyxrc.chktex_command, name, filePath());
1090 int const res = chktex.run(terr); // run chktex
1093 Alert::error(_("chktex failure"),
1094 _("Could not run chktex successfully."));
1095 } else if (res > 0) {
1096 // Fill-in the error list with the TeX errors
1097 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1108 void Buffer::validate(LaTeXFeatures & features) const
1110 LyXTextClass const & tclass = params().getLyXTextClass();
1112 if (features.isAvailable("dvipost") && params().outputChanges)
1113 features.require("dvipost");
1115 // AMS Style is at document level
1116 if (params().use_amsmath == BufferParams::AMS_ON
1117 || tclass.provides(LyXTextClass::amsmath))
1118 features.require("amsmath");
1120 for_each(paragraphs().begin(), paragraphs().end(),
1121 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1123 // the bullet shapes are buffer level not paragraph level
1124 // so they are tested here
1125 for (int i = 0; i < 4; ++i) {
1126 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1127 int const font = params().user_defined_bullet(i).getFont();
1129 int const c = params()
1130 .user_defined_bullet(i)
1137 features.require("latexsym");
1139 } else if (font == 1) {
1140 features.require("amssymb");
1141 } else if ((font >= 2 && font <= 5)) {
1142 features.require("pifont");
1147 if (lyxerr.debugging(Debug::LATEX)) {
1148 features.showStruct();
1153 void Buffer::getLabelList(vector<docstring> & list) const
1155 /// if this is a child document and the parent is already loaded
1156 /// Use the parent's list instead [ale990407]
1157 Buffer const * tmp = getMasterBuffer();
1159 lyxerr << "getMasterBuffer() failed!" << endl;
1163 tmp->getLabelList(list);
1167 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1168 it.nextInset()->getLabelList(*this, list);
1172 // This is also a buffer property (ale)
1173 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1176 /// if this is a child document and the parent is already loaded
1177 /// use the parent's list instead [ale990412]
1178 Buffer const * tmp = getMasterBuffer();
1181 tmp->fillWithBibKeys(keys);
1185 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1186 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1187 InsetBibtex const & inset =
1188 dynamic_cast<InsetBibtex const &>(*it);
1189 inset.fillWithBibKeys(*this, keys);
1190 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1191 InsetInclude const & inset =
1192 dynamic_cast<InsetInclude const &>(*it);
1193 inset.fillWithBibKeys(*this, keys);
1194 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1195 InsetBibitem const & inset =
1196 dynamic_cast<InsetBibitem const &>(*it);
1197 string const key = inset.getContents();
1198 string const opt = inset.getOptions();
1199 string const ref; // = pit->asString(this, false);
1200 string const info = opt + "TheBibliographyRef" + ref;
1201 keys.push_back(pair<string, string>(key, info));
1207 void Buffer::updateBibfilesCache()
1209 // if this is a child document and the parent is already loaded
1210 // update the parent's cache instead
1211 Buffer * tmp = getMasterBuffer();
1214 tmp->updateBibfilesCache();
1218 bibfilesCache_.clear();
1219 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1220 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1221 InsetBibtex const & inset =
1222 dynamic_cast<InsetBibtex const &>(*it);
1223 vector<string> const bibfiles = inset.getFiles(*this);
1224 bibfilesCache_.insert(bibfilesCache_.end(),
1227 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1228 InsetInclude & inset =
1229 dynamic_cast<InsetInclude &>(*it);
1230 inset.updateBibfilesCache(*this);
1231 vector<string> const & bibfiles =
1232 inset.getBibfilesCache(*this);
1233 bibfilesCache_.insert(bibfilesCache_.end(),
1241 vector<string> const & Buffer::getBibfilesCache() const
1243 // if this is a child document and the parent is already loaded
1244 // use the parent's cache instead
1245 Buffer const * tmp = getMasterBuffer();
1248 return tmp->getBibfilesCache();
1250 return bibfilesCache_;
1254 bool Buffer::isDepClean(string const & name) const
1256 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1257 if (it == pimpl_->dep_clean.end())
1263 void Buffer::markDepClean(string const & name)
1265 pimpl_->dep_clean[name] = true;
1269 bool Buffer::dispatch(string const & command, bool * result)
1271 return dispatch(lyxaction.lookupFunc(command), result);
1275 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1277 bool dispatched = true;
1279 switch (func.action) {
1280 case LFUN_BUFFER_EXPORT: {
1281 bool const tmp = Exporter::Export(this, lyx::to_utf8(func.argument()), false);
1294 void Buffer::changeLanguage(Language const * from, Language const * to)
1299 // Take care of l10n/i18n
1302 for_each(par_iterator_begin(),
1304 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1306 text().current_font.setLanguage(to);
1307 text().real_current_font.setLanguage(to);
1311 void Buffer::updateDocLang(Language const * nlang)
1313 BOOST_ASSERT(nlang);
1315 pimpl_->messages.reset(new Messages(nlang->code()));
1317 updateLabels(*this);
1321 bool Buffer::isMultiLingual() const
1323 ParConstIterator end = par_iterator_end();
1324 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1325 if (it->isMultiLingual(params()))
1332 ParIterator Buffer::getParFromID(int const id) const
1334 ParConstIterator it = par_iterator_begin();
1335 ParConstIterator const end = par_iterator_end();
1338 // John says this is called with id == -1 from undo
1339 lyxerr << "getParFromID(), id: " << id << endl;
1343 for (; it != end; ++it)
1351 bool Buffer::hasParWithID(int const id) const
1353 ParConstIterator const it = getParFromID(id);
1354 return it != par_iterator_end();
1358 ParIterator Buffer::par_iterator_begin()
1360 return ::par_iterator_begin(inset());
1364 ParIterator Buffer::par_iterator_end()
1366 return ::par_iterator_end(inset());
1370 ParConstIterator Buffer::par_iterator_begin() const
1372 return ::par_const_iterator_begin(inset());
1376 ParConstIterator Buffer::par_iterator_end() const
1378 return ::par_const_iterator_end(inset());
1382 Language const * Buffer::getLanguage() const
1384 return params().language;
1388 docstring const Buffer::B_(string const & l10n) const
1390 if (pimpl_->messages.get()) {
1391 return pimpl_->messages->get(l10n);
1398 bool Buffer::isClean() const
1400 return pimpl_->lyx_clean;
1404 bool Buffer::isBakClean() const
1406 return pimpl_->bak_clean;
1410 void Buffer::markClean() const
1412 if (!pimpl_->lyx_clean) {
1413 pimpl_->lyx_clean = true;
1416 // if the .lyx file has been saved, we don't need an
1418 pimpl_->bak_clean = true;
1422 void Buffer::markBakClean()
1424 pimpl_->bak_clean = true;
1428 void Buffer::setUnnamed(bool flag)
1430 pimpl_->unnamed = flag;
1434 bool Buffer::isUnnamed() const
1436 return pimpl_->unnamed;
1440 #ifdef WITH_WARNINGS
1441 #warning this function should be moved to buffer_pimpl.C
1443 void Buffer::markDirty()
1445 if (pimpl_->lyx_clean) {
1446 pimpl_->lyx_clean = false;
1449 pimpl_->bak_clean = false;
1451 DepClean::iterator it = pimpl_->dep_clean.begin();
1452 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1454 for (; it != end; ++it) {
1460 string const & Buffer::fileName() const
1462 return pimpl_->filename;
1466 string const & Buffer::filePath() const
1468 return params().filepath;
1472 bool Buffer::isReadonly() const
1474 return pimpl_->read_only;
1478 void Buffer::setParentName(string const & name)
1480 params().parentname = name;
1484 Buffer const * Buffer::getMasterBuffer() const
1486 if (!params().parentname.empty()
1487 && theBufferList().exists(params().parentname)) {
1488 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1490 return buf->getMasterBuffer();
1497 Buffer * Buffer::getMasterBuffer()
1499 if (!params().parentname.empty()
1500 && theBufferList().exists(params().parentname)) {
1501 Buffer * buf = theBufferList().getBuffer(params().parentname);
1503 return buf->getMasterBuffer();
1510 MacroData const & Buffer::getMacro(std::string const & name) const
1512 return pimpl_->macros.get(name);
1516 bool Buffer::hasMacro(string const & name) const
1518 return pimpl_->macros.has(name);
1522 void Buffer::insertMacro(string const & name, MacroData const & data)
1524 MacroTable::globalMacros().insert(name, data);
1525 pimpl_->macros.insert(name, data);
1529 void Buffer::buildMacros()
1531 // Start with global table.
1532 pimpl_->macros = MacroTable::globalMacros();
1535 ParagraphList const & pars = text().paragraphs();
1536 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1537 //lyxerr << "searching main par " << i
1538 // << " for macro definitions" << std::endl;
1539 InsetList const & insets = pars[i].insetlist;
1540 InsetList::const_iterator it = insets.begin();
1541 InsetList::const_iterator end = insets.end();
1542 for ( ; it != end; ++it) {
1543 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1544 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1545 MathMacroTemplate const & mac
1546 = static_cast<MathMacroTemplate const &>(*it->inset);
1547 insertMacro(mac.name(), mac.asMacroData());
1554 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1561 void Buffer::changeRefsIfUnique(string const & from, string const & to, InsetBase::Code code)
1563 //FIXME: This does not work for child documents yet.
1564 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1565 // Check if the label 'from' appears more than once
1566 vector<docstring> labels;
1568 if (code == InsetBase::CITE_CODE) {
1569 vector<pair<string, string> > keys;
1570 fillWithBibKeys(keys);
1571 vector<pair<string, string> >::const_iterator bit = keys.begin();
1572 vector<pair<string, string> >::const_iterator bend = keys.end();
1574 for (; bit != bend; ++bit)
1576 labels.push_back(lyx::from_utf8(bit->first));
1578 getLabelList(labels);
1581 if (lyx::count(labels.begin(), labels.end(), lyx::from_utf8(from)) > 1)
1584 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1585 if (it->lyxCode() == code) {
1586 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1587 inset.replaceContents(from, to);
1593 void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1595 OutputParams runparams;
1596 runparams.nice = true;
1597 runparams.flavor = OutputParams::LATEX;
1598 runparams.linelen = lyxrc.ascii_linelen;
1599 // No side effect of file copying and image conversion
1600 runparams.dryrun = true;
1603 os << "% Preview source code\n\n";
1605 writeLaTeXSource(os, filePath(), runparams, true, true);
1607 writeDocBookSource(os, fileName(), runparams, false);
1609 runparams.par_begin = par_begin;
1610 runparams.par_end = par_end;
1611 if (par_begin + 1 == par_end)
1612 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1614 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1615 // output paragraphs
1618 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1620 docbookParagraphs(paragraphs(), *this, os, runparams);
1625 ErrorList const & Buffer::errorList(string const & type) const
1627 static ErrorList const emptyErrorList;
1628 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1629 if (I == errorLists_.end())
1630 return emptyErrorList;
1636 ErrorList & Buffer::errorList(string const & type)
1638 return errorLists_[type];