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/math_macrotemplate.h"
59 #include "mathed/math_macrotable.h"
60 #include "mathed/math_support.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/operations.hpp>
83 #if defined (HAVE_UTIME_H)
85 #elif defined (HAVE_SYS_UTIME_H)
86 # include <sys/utime.h>
98 using lyx::support::addName;
99 using lyx::support::bformat;
100 using lyx::support::changeExtension;
101 using lyx::support::cmd_ret;
102 using lyx::support::createBufferTmpDir;
103 using lyx::support::destroyDir;
104 using lyx::support::getFormatFromContents;
105 using lyx::support::isDirWriteable;
106 using lyx::support::libFileSearch;
107 using lyx::support::latex_path;
108 using lyx::support::ltrim;
109 using lyx::support::makeAbsPath;
110 using lyx::support::makeDisplayPath;
111 using lyx::support::makeLatexName;
112 using lyx::support::onlyFilename;
113 using lyx::support::onlyPath;
114 using lyx::support::Path;
115 using lyx::support::quoteName;
116 using lyx::support::removeAutosaveFile;
117 using lyx::support::rename;
118 using lyx::support::runCommand;
119 using lyx::support::split;
120 using lyx::support::subst;
121 using lyx::support::tempName;
122 using lyx::support::trim;
124 namespace os = lyx::support::os;
125 namespace fs = boost::filesystem;
129 using std::make_pair;
135 using std::ostringstream;
143 // all these externs should eventually be removed.
144 extern BufferList bufferlist;
148 int const LYX_FORMAT = 249;
153 typedef std::map<string, bool> DepClean;
158 Impl(Buffer & parent, string const & file, bool readonly);
160 limited_stack<Undo> undostack;
161 limited_stack<Undo> redostack;
167 /// need to regenerate .tex?
171 mutable bool lyx_clean;
173 /// is autosave needed?
174 mutable bool bak_clean;
176 /// is this a unnamed file (New...)?
182 /// name of the file the buffer is associated with.
185 boost::scoped_ptr<Messages> messages;
187 /** Set to true only when the file is fully loaded.
188 * Used to prevent the premature generation of previews
189 * and by the citation inset.
191 bool file_fully_loaded;
193 /// our LyXText that should be wrapped in an InsetText
201 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
202 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
203 filename(file), file_fully_loaded(false),
206 inset.setAutoBreakRows(true);
207 lyxvc.buffer(&parent);
208 temppath = createBufferTmpDir();
209 params.filepath = onlyPath(file);
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 readonly)
217 : pimpl_(new Impl(*this, file, readonly))
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 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."), 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 string const s = bformat(_("Unknown token: "
450 errorList.push_back(ErrorItem(_("Document header error"),
455 if (begin_header_line) {
456 string 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 string 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.", 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, string const & str, bool autobreakrows)
510 // insert the string, don't insert doublespace
511 bool space_inserted = true;
512 for (string::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 par.insertChar(pos, ' ', font);
534 space_inserted = true;
536 const pos_type n = 8 - pos % 8;
537 for (pos_type i = 0; i < n; ++i) {
538 par.insertChar(pos, ' ', font);
541 space_inserted = true;
543 } else if (!isPrintable(*cit)) {
544 // Ignore unprintables
547 // just insert the character
548 par.insertChar(pos, *cit, font);
550 space_inserted = (*cit == ' ');
557 bool Buffer::readFile(string const & filename)
559 // Check if the file is compressed.
560 string const format = getFormatFromContents(filename);
561 if (format == "gzip" || format == "zip" || format == "compress") {
562 params().compressed = true;
565 // remove dummy empty par
566 paragraphs().clear();
568 lex.setFile(filename);
569 if (!readFile(lex, filename))
572 // After we have read a file, we must ensure that the buffer
573 // language is set and used in the gui.
574 // If you know of a better place to put this, please tell me. (Lgb)
575 updateDocLang(params().language);
581 bool Buffer::fully_loaded() const
583 return pimpl_->file_fully_loaded;
587 void Buffer::fully_loaded(bool const value)
589 pimpl_->file_fully_loaded = value;
593 bool Buffer::readFile(LyXLex & lex, string const & filename)
595 BOOST_ASSERT(!filename.empty());
598 Alert::error(_("Document could not be read"),
599 bformat(_("%1$s could not be read."), filename));
604 string const token(lex.getString());
607 Alert::error(_("Document could not be read"),
608 bformat(_("%1$s could not be read."), filename));
612 // the first token _must_ be...
613 if (token != "\\lyxformat") {
614 lyxerr << "Token: " << token << endl;
616 Alert::error(_("Document format failure"),
617 bformat(_("%1$s is not a LyX document."),
623 string tmp_format = lex.getString();
624 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
625 // if present remove ".," from string.
626 string::size_type dot = tmp_format.find_first_of(".,");
627 //lyxerr << " dot found at " << dot << endl;
628 if (dot != string::npos)
629 tmp_format.erase(dot, 1);
630 int const file_format = convert<int>(tmp_format);
631 //lyxerr << "format: " << file_format << endl;
633 if (file_format != LYX_FORMAT) {
634 string const tmpfile = tempName();
635 if (tmpfile.empty()) {
636 Alert::error(_("Conversion failed"),
637 bformat(_("%1$s is from an earlier"
638 " version of LyX, but a temporary"
639 " file for converting it could"
644 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
645 if (lyx2lyx.empty()) {
646 Alert::error(_("Conversion script not found"),
647 bformat(_("%1$s is from an earlier"
648 " version of LyX, but the"
649 " conversion script lyx2lyx"
650 " could not be found."),
654 ostringstream command;
655 command << os::python() << ' ' << quoteName(lyx2lyx)
656 << " -t " << convert<string>(LYX_FORMAT)
657 << " -o " << quoteName(tmpfile) << ' '
658 << quoteName(filename);
659 string const command_str = command.str();
661 lyxerr[Debug::INFO] << "Running '"
662 << command_str << '\''
665 cmd_ret const ret = runCommand(command_str);
666 if (ret.first != 0) {
667 Alert::error(_("Conversion script failed"),
668 bformat(_("%1$s is from an earlier version"
669 " of LyX, but the lyx2lyx script"
670 " failed to convert it."),
674 bool const ret = readFile(tmpfile);
675 // Do stuff with tmpfile name and buffer name here.
681 if (readDocument(lex)) {
682 Alert::error(_("Document format failure"),
683 bformat(_("%1$s ended unexpectedly, which means"
684 " that it is probably corrupted."),
688 //lyxerr << "removing " << MacroTable::localMacros().size()
689 // << " temporary macro entries" << endl;
690 //MacroTable::localMacros().clear();
692 pimpl_->file_fully_loaded = true;
697 // Should probably be moved to somewhere else: BufferView? LyXView?
698 bool Buffer::save() const
700 // We don't need autosaves in the immediate future. (Asger)
701 resetAutosaveTimers();
705 if (lyxrc.make_backup) {
706 s = fileName() + '~';
707 if (!lyxrc.backupdir_path.empty())
708 s = addName(lyxrc.backupdir_path,
709 subst(os::internal_path(s),'/','!'));
711 // It might very well be that this variant is just
712 // good enough. (Lgb)
713 // But to use this we need fs::copy_file to actually do a copy,
714 // even when the target file exists. (Lgb)
715 if (fs::exists(fileName()) && fs::is_writable(fs::path(fileName()).branch_path())) {
717 fs::copy_file(fileName(), s, false);
719 //catch (fs::filesystem_error const & fe) {
720 //lyxerr << "LyX was not able to make backup copy. Beware.\n"
721 // << fe.what() << endl;
726 if (writeFile(fileName())) {
728 removeAutosaveFile(fileName());
730 // Saving failed, so backup is not backup
731 if (lyxrc.make_backup)
732 rename(s, fileName());
739 bool Buffer::writeFile(string const & fname) const
741 if (pimpl_->read_only && fname == fileName())
746 if (params().compressed) {
747 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
751 retval = do_writeFile(ofs);
753 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
757 retval = do_writeFile(ofs);
764 bool Buffer::do_writeFile(ostream & ofs) const
767 // Use the standard "C" locale for file output.
768 ofs.imbue(std::locale::classic());
771 // The top of the file should not be written by params().
773 // write out a comment in the top of the file
774 ofs << "#LyX " << lyx_version
775 << " created this file. For more info see http://www.lyx.org/\n"
776 << "\\lyxformat " << LYX_FORMAT << "\n"
777 << "\\begin_document\n";
779 // now write out the buffer parameters.
780 ofs << "\\begin_header\n";
781 params().writeFile(ofs);
782 ofs << "\\end_header\n";
785 ofs << "\n\\begin_body\n";
786 text().write(*this, ofs);
787 ofs << "\n\\end_body\n";
789 // Write marker that shows file is complete
790 ofs << "\\end_document" << endl;
792 // Shouldn't really be needed....
795 // how to check if close went ok?
796 // Following is an attempt... (BE 20001011)
798 // good() returns false if any error occured, including some
800 // bad() returns true if something bad happened in the buffer,
801 // which should include file system full errors.
806 lyxerr << "File was not closed properly." << endl;
813 void Buffer::makeLaTeXFile(string const & fname,
814 string const & original_path,
815 OutputParams const & runparams,
816 bool output_preamble, bool output_body)
818 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
821 if (!openFileWrite(ofs, fname))
824 writeLaTeXSource(ofs, original_path,
825 runparams, output_preamble, output_body);
829 lyxerr << "File '" << fname << "' was not closed properly." << endl;
833 void Buffer::writeLaTeXSource(ostream & os,
834 string const & original_path,
835 OutputParams const & runparams_in,
836 bool const output_preamble, bool const output_body)
838 OutputParams runparams = runparams_in;
840 // validate the buffer.
841 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
842 LaTeXFeatures features(*this, params(), runparams);
844 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
848 // The starting paragraph of the coming rows is the
849 // first paragraph of the document. (Asger)
850 texrow().start(paragraphs().begin()->id(), 0);
852 if (output_preamble && runparams.nice) {
853 os << "%% LyX " << lyx_version << " created this file. "
854 "For more info, see http://www.lyx.org/.\n"
855 "%% Do not edit unless you really know what "
860 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
861 // There are a few differences between nice LaTeX and usual files:
862 // usual is \batchmode and has a
863 // special input@path to allow the including of figures
864 // with either \input or \includegraphics (what figinsets do).
865 // input@path is set when the actual parameter
866 // original_path is set. This is done for usual tex-file, but not
867 // for nice-latex-file. (Matthias 250696)
868 // Note that input@path is only needed for something the user does
869 // in the preamble, included .tex files or ERT, files included by
870 // LyX work without it.
871 if (output_preamble) {
872 if (!runparams.nice) {
873 // code for usual, NOT nice-latex-file
874 os << "\\batchmode\n"; // changed
878 if (!original_path.empty()) {
879 string const inputpath = latex_path(original_path);
880 os << "\\makeatletter\n"
881 << "\\def\\input@path{{"
882 << inputpath << "/}}\n"
883 << "\\makeatother\n";
889 // Write the preamble
890 runparams.use_babel = params().writeLaTeX(os, features, texrow());
896 os << "\\begin{document}\n";
899 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
901 if (!lyxrc.language_auto_begin) {
902 os << subst(lyxrc.language_command_begin, "$$lang",
903 params().language->babel())
908 // if we are doing a real file with body, even if this is the
909 // child of some other buffer, let's cut the link here.
910 // This happens for example if only a child document is printed.
911 string save_parentname;
912 if (output_preamble) {
913 save_parentname = params().parentname;
914 params().parentname.erase();
918 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
920 // Restore the parenthood if needed
922 params().parentname = save_parentname;
924 // add this just in case after all the paragraphs
928 if (!lyxrc.language_auto_end) {
929 os << subst(lyxrc.language_command_end, "$$lang",
930 params().language->babel())
935 if (output_preamble) {
936 os << "\\end{document}\n";
939 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
941 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
945 // Just to be sure. (Asger)
948 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
949 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
954 bool Buffer::isLatex() const
956 return params().getLyXTextClass().outputType() == LATEX;
960 bool Buffer::isLiterate() const
962 return params().getLyXTextClass().outputType() == LITERATE;
966 bool Buffer::isDocBook() const
968 return params().getLyXTextClass().outputType() == DOCBOOK;
972 void Buffer::makeDocBookFile(string const & fname,
973 OutputParams const & runparams,
974 bool const body_only)
976 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
979 if (!openFileWrite(ofs, fname))
982 writeDocBookSource(ofs, fname, runparams, body_only);
986 lyxerr << "File '" << fname << "' was not closed properly." << endl;
990 void Buffer::writeDocBookSource(ostream & os, string const & fname,
991 OutputParams const & runparams,
992 bool const only_body)
994 LaTeXFeatures features(*this, params(), runparams);
999 LyXTextClass const & tclass = params().getLyXTextClass();
1000 string const & top_element = tclass.latexname();
1003 if (runparams.flavor == OutputParams::XML)
1004 os << "<?xml version=\"1.0\" encoding=\""
1005 << params().language->encoding()->name() << "\"?>\n";
1007 os << "<!DOCTYPE " << top_element << " ";
1009 if (! tclass.class_header().empty()) os << tclass.class_header();
1010 else if (runparams.flavor == OutputParams::XML)
1011 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1012 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1014 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1016 string preamble = params().preamble;
1017 if (runparams.flavor != OutputParams::XML ) {
1018 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1019 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1020 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1021 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1024 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1026 preamble += features.getIncludedFiles(name);
1027 preamble += features.getLyXSGMLEntities();
1029 if (!preamble.empty()) {
1030 os << "\n [ " << preamble << " ]";
1035 string top = top_element;
1037 if (runparams.flavor == OutputParams::XML)
1038 top += params().language->code();
1040 top += params().language->code().substr(0,2);
1043 if (!params().options.empty()) {
1045 top += params().options;
1048 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1049 << " file was created by LyX " << lyx_version
1050 << "\n See http://www.lyx.org/ for more information -->\n";
1052 params().getLyXTextClass().counters().reset();
1054 sgml::openTag(os, top);
1056 docbookParagraphs(paragraphs(), *this, os, runparams);
1057 sgml::closeTag(os, top_element);
1061 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1062 // Other flags: -wall -v0 -x
1063 int Buffer::runChktex()
1067 // get LaTeX-Filename
1068 string const name = getLatexName();
1069 string const path = temppath();
1070 string const org_path = filePath();
1072 Path p(path); // path to LaTeX file
1073 message(_("Running chktex..."));
1075 // Generate the LaTeX file if neccessary
1076 OutputParams runparams;
1077 runparams.flavor = OutputParams::LATEX;
1078 runparams.nice = false;
1079 makeLaTeXFile(name, org_path, runparams);
1082 Chktex chktex(lyxrc.chktex_command, name, filePath());
1083 int const res = chktex.run(terr); // run chktex
1086 Alert::error(_("chktex failure"),
1087 _("Could not run chktex successfully."));
1088 } else if (res > 0) {
1089 // Fill-in the error list with the TeX errors
1090 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1101 void Buffer::validate(LaTeXFeatures & features) const
1103 LyXTextClass const & tclass = params().getLyXTextClass();
1105 if (features.isAvailable("dvipost") && params().tracking_changes
1106 && params().output_changes)
1107 features.require("dvipost");
1109 // AMS Style is at document level
1110 if (params().use_amsmath == BufferParams::AMS_ON
1111 || tclass.provides(LyXTextClass::amsmath))
1112 features.require("amsmath");
1114 for_each(paragraphs().begin(), paragraphs().end(),
1115 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1117 // the bullet shapes are buffer level not paragraph level
1118 // so they are tested here
1119 for (int i = 0; i < 4; ++i) {
1120 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1121 int const font = params().user_defined_bullet(i).getFont();
1123 int const c = params()
1124 .user_defined_bullet(i)
1131 features.require("latexsym");
1133 } else if (font == 1) {
1134 features.require("amssymb");
1135 } else if ((font >= 2 && font <= 5)) {
1136 features.require("pifont");
1141 if (lyxerr.debugging(Debug::LATEX)) {
1142 features.showStruct();
1147 void Buffer::getLabelList(vector<string> & list) const
1149 /// if this is a child document and the parent is already loaded
1150 /// Use the parent's list instead [ale990407]
1151 Buffer const * tmp = getMasterBuffer();
1153 lyxerr << "getMasterBuffer() failed!" << endl;
1157 tmp->getLabelList(list);
1161 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1162 it.nextInset()->getLabelList(*this, list);
1166 // This is also a buffer property (ale)
1167 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1170 /// if this is a child document and the parent is already loaded
1171 /// use the parent's list instead [ale990412]
1172 Buffer const * tmp = getMasterBuffer();
1175 tmp->fillWithBibKeys(keys);
1179 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1180 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1181 InsetBibtex const & inset =
1182 dynamic_cast<InsetBibtex const &>(*it);
1183 inset.fillWithBibKeys(*this, keys);
1184 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1185 InsetInclude const & inset =
1186 dynamic_cast<InsetInclude const &>(*it);
1187 inset.fillWithBibKeys(*this, keys);
1188 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1189 InsetBibitem const & inset =
1190 dynamic_cast<InsetBibitem const &>(*it);
1191 string const key = inset.getContents();
1192 string const opt = inset.getOptions();
1193 string const ref; // = pit->asString(this, false);
1194 string const info = opt + "TheBibliographyRef" + ref;
1195 keys.push_back(pair<string, string>(key, info));
1201 void Buffer::updateBibfilesCache()
1203 // if this is a child document and the parent is already loaded
1204 // update the parent's cache instead
1205 Buffer * tmp = getMasterBuffer();
1208 tmp->updateBibfilesCache();
1212 bibfilesCache_.clear();
1213 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1214 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1215 InsetBibtex const & inset =
1216 dynamic_cast<InsetBibtex const &>(*it);
1217 vector<string> const bibfiles = inset.getFiles(*this);
1218 bibfilesCache_.insert(bibfilesCache_.end(),
1221 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1222 InsetInclude & inset =
1223 dynamic_cast<InsetInclude &>(*it);
1224 inset.updateBibfilesCache(*this);
1225 vector<string> const & bibfiles =
1226 inset.getBibfilesCache(*this);
1227 bibfilesCache_.insert(bibfilesCache_.end(),
1235 vector<string> const & Buffer::getBibfilesCache() const
1237 // if this is a child document and the parent is already loaded
1238 // use the parent's cache instead
1239 Buffer const * tmp = getMasterBuffer();
1242 return tmp->getBibfilesCache();
1244 return bibfilesCache_;
1248 bool Buffer::isDepClean(string const & name) const
1250 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1251 if (it == pimpl_->dep_clean.end())
1257 void Buffer::markDepClean(string const & name)
1259 pimpl_->dep_clean[name] = true;
1263 bool Buffer::dispatch(string const & command, bool * result)
1265 return dispatch(lyxaction.lookupFunc(command), result);
1269 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1271 bool dispatched = true;
1273 switch (func.action) {
1274 case LFUN_BUFFER_EXPORT: {
1275 bool const tmp = Exporter::Export(this, func.argument, false);
1288 void Buffer::changeLanguage(Language const * from, Language const * to)
1293 // Take care of l10n/i18n
1296 for_each(par_iterator_begin(),
1298 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1300 text().current_font.setLanguage(to);
1301 text().real_current_font.setLanguage(to);
1305 void Buffer::updateDocLang(Language const * nlang)
1307 BOOST_ASSERT(nlang);
1309 pimpl_->messages.reset(new Messages(nlang->code()));
1311 updateLabels(*this);
1315 bool Buffer::isMultiLingual() const
1317 ParConstIterator end = par_iterator_end();
1318 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1319 if (it->isMultiLingual(params()))
1326 ParIterator Buffer::getParFromID(int const id) const
1328 ParConstIterator it = par_iterator_begin();
1329 ParConstIterator const end = par_iterator_end();
1332 // John says this is called with id == -1 from undo
1333 lyxerr << "getParFromID(), id: " << id << endl;
1337 for (; it != end; ++it)
1345 bool Buffer::hasParWithID(int const id) const
1347 ParConstIterator const it = getParFromID(id);
1348 return it != par_iterator_end();
1352 ParIterator Buffer::par_iterator_begin()
1354 return ::par_iterator_begin(inset());
1358 ParIterator Buffer::par_iterator_end()
1360 return ::par_iterator_end(inset());
1364 ParConstIterator Buffer::par_iterator_begin() const
1366 return ::par_const_iterator_begin(inset());
1370 ParConstIterator Buffer::par_iterator_end() const
1372 return ::par_const_iterator_end(inset());
1376 Language const * Buffer::getLanguage() const
1378 return params().language;
1382 string const Buffer::B_(string const & l10n) const
1384 if (pimpl_->messages.get()) {
1385 return pimpl_->messages->get(l10n);
1392 bool Buffer::isClean() const
1394 return pimpl_->lyx_clean;
1398 bool Buffer::isBakClean() const
1400 return pimpl_->bak_clean;
1404 void Buffer::markClean() const
1406 if (!pimpl_->lyx_clean) {
1407 pimpl_->lyx_clean = true;
1410 // if the .lyx file has been saved, we don't need an
1412 pimpl_->bak_clean = true;
1416 void Buffer::markBakClean()
1418 pimpl_->bak_clean = true;
1422 void Buffer::setUnnamed(bool flag)
1424 pimpl_->unnamed = flag;
1428 bool Buffer::isUnnamed() const
1430 return pimpl_->unnamed;
1434 #ifdef WITH_WARNINGS
1435 #warning this function should be moved to buffer_pimpl.C
1437 void Buffer::markDirty()
1439 if (pimpl_->lyx_clean) {
1440 pimpl_->lyx_clean = false;
1443 pimpl_->bak_clean = false;
1445 DepClean::iterator it = pimpl_->dep_clean.begin();
1446 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1448 for (; it != end; ++it) {
1454 string const & Buffer::fileName() const
1456 return pimpl_->filename;
1460 string const & Buffer::filePath() const
1462 return params().filepath;
1466 bool Buffer::isReadonly() const
1468 return pimpl_->read_only;
1472 void Buffer::setParentName(string const & name)
1474 params().parentname = name;
1478 Buffer const * Buffer::getMasterBuffer() const
1480 if (!params().parentname.empty()
1481 && bufferlist.exists(params().parentname)) {
1482 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1484 return buf->getMasterBuffer();
1491 Buffer * Buffer::getMasterBuffer()
1493 if (!params().parentname.empty()
1494 && bufferlist.exists(params().parentname)) {
1495 Buffer * buf = bufferlist.getBuffer(params().parentname);
1497 return buf->getMasterBuffer();
1504 MacroData const & Buffer::getMacro(std::string const & name) const
1506 return pimpl_->macros.get(name);
1510 bool Buffer::hasMacro(string const & name) const
1512 return pimpl_->macros.has(name);
1516 void Buffer::insertMacro(string const & name, MacroData const & data)
1518 MacroTable::globalMacros().insert(name, data);
1519 pimpl_->macros.insert(name, data);
1523 void Buffer::buildMacros()
1525 // Start with global table.
1526 pimpl_->macros = MacroTable::globalMacros();
1529 ParagraphList const & pars = text().paragraphs();
1530 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1531 //lyxerr << "searching main par " << i
1532 // << " for macro definitions" << std::endl;
1533 InsetList const & insets = pars[i].insetlist;
1534 InsetList::const_iterator it = insets.begin();
1535 InsetList::const_iterator end = insets.end();
1536 for ( ; it != end; ++it) {
1537 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1538 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1539 MathMacroTemplate const & mac
1540 = static_cast<MathMacroTemplate const &>(*it->inset);
1541 insertMacro(mac.name(), mac.asMacroData());
1548 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1555 void Buffer::changeRefsIfUnique(string const & from, string const & to)
1557 // Check if the label 'from' appears more than once
1558 vector<string> labels;
1559 getLabelList(labels);
1561 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1564 InsetBase::Code code = InsetBase::REF_CODE;
1566 ParIterator it = par_iterator_begin();
1567 ParIterator end = par_iterator_end();
1568 for ( ; it != end; ++it) {
1569 bool changed_inset = false;
1570 for (InsetList::iterator it2 = it->insetlist.begin();
1571 it2 != it->insetlist.end(); ++it2) {
1572 if (it2->inset->lyxCode() == code) {
1573 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1574 if (inset->getContents() == from) {
1575 inset->setContents(to);
1576 //inset->setButtonLabel();
1577 changed_inset = true;
1585 void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1587 OutputParams runparams;
1588 runparams.nice = true;
1589 runparams.flavor = OutputParams::LATEX;
1590 runparams.linelen = lyxrc.ascii_linelen;
1591 // No side effect of file copying and image conversion
1592 runparams.dryrun = true;
1595 os << "% Preview source code\n\n";
1597 writeLaTeXSource(os, filePath(), runparams, true, true);
1599 writeDocBookSource(os, fileName(), runparams, false);
1601 runparams.par_begin = par_begin;
1602 runparams.par_end = par_end;
1603 if (par_begin + 1 == par_end)
1604 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1606 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1607 // output paragraphs
1610 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1612 docbookParagraphs(paragraphs(), *this, os, runparams);
1617 ErrorList const & Buffer::errorList(string const & type) const
1619 static ErrorList const emptyErrorList;
1620 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1621 if (I == errorLists_.end())
1622 return emptyErrorList;
1628 ErrorList & Buffer::errorList(string const & type)
1630 return errorLists_[type];