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 "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
23 #include "errorlist.h"
26 #include "funcrequest.h"
28 #include "insetiterator.h"
31 #include "LaTeXFeatures.h"
32 #include "LyXAction.h"
40 #include "output_docbook.h"
41 #include "output_latex.h"
42 #include "output_linuxdoc.h"
43 #include "paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "pariterator.h"
52 #include "insets/insetbibitem.h"
53 #include "insets/insetbibtex.h"
54 #include "insets/insetinclude.h"
55 #include "insets/insettext.h"
57 #include "frontends/Alert.h"
59 #include "graphics/Previews.h"
61 #include "support/FileInfo.h"
62 #include "support/filetools.h"
63 #include "support/gzstream.h"
64 #include "support/lyxlib.h"
65 #include "support/os.h"
66 #include "support/path.h"
67 #include "support/textutils.h"
68 #include "support/tostr.h"
69 #include "support/std_sstream.h"
71 #include <boost/bind.hpp>
81 using lyx::support::AddName;
82 using lyx::support::atoi;
83 using lyx::support::bformat;
84 using lyx::support::ChangeExtension;
85 using lyx::support::cmd_ret;
86 using lyx::support::createBufferTmpDir;
87 using lyx::support::destroyDir;
88 using lyx::support::FileInfo;
89 using lyx::support::FileInfo;
90 using lyx::support::getExtFromContents;
91 using lyx::support::IsDirWriteable;
92 using lyx::support::IsFileWriteable;
93 using lyx::support::LibFileSearch;
94 using lyx::support::ltrim;
95 using lyx::support::MakeAbsPath;
96 using lyx::support::MakeDisplayPath;
97 using lyx::support::MakeLatexName;
98 using lyx::support::OnlyFilename;
99 using lyx::support::OnlyPath;
100 using lyx::support::Path;
101 using lyx::support::QuoteName;
102 using lyx::support::removeAutosaveFile;
103 using lyx::support::rename;
104 using lyx::support::RunCommand;
105 using lyx::support::split;
106 using lyx::support::strToInt;
107 using lyx::support::subst;
108 using lyx::support::tempName;
109 using lyx::support::trim;
111 namespace os = lyx::support::os;
115 using std::make_pair;
120 using std::ostringstream;
128 // all these externs should eventually be removed.
129 extern BufferList bufferlist;
133 const int LYX_FORMAT = 232;
138 typedef std::map<string, bool> DepClean;
142 Impl(Buffer & parent, string const & file, bool readonly);
144 limited_stack<Undo> undostack;
145 limited_stack<Undo> redostack;
151 /// need to regenerate .tex?
155 mutable bool lyx_clean;
157 /// is autosave needed?
158 mutable bool bak_clean;
160 /// is this a unnamed file (New...)?
166 /// name of the file the buffer is associated with.
169 /// The path to the document file.
172 boost::scoped_ptr<Messages> messages;
174 /** Set to true only when the file is fully loaded.
175 * Used to prevent the premature generation of previews
176 * and by the citation inset.
178 bool file_fully_loaded;
180 /// our LyXText that should be wrapped in an InsetText
185 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
186 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
187 filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
190 lyxvc.buffer(&parent);
191 temppath = createBufferTmpDir();
192 // FIXME: And now do something if temppath == string(), because we
193 // assume from now on that temppath points to a valid temp dir.
194 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
198 Buffer::Buffer(string const & file, bool ronly)
199 : pimpl_(new Impl(*this, file, ronly))
201 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
207 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
208 // here the buffer should take care that it is
209 // saved properly, before it goes into the void.
213 if (!temppath().empty() && destroyDir(temppath()) != 0) {
214 Alert::warning(_("Could not remove temporary directory"),
215 bformat(_("Could not remove the temporary directory %1$s"), temppath()));
218 // Remove any previewed LaTeX snippets associated with this buffer.
219 lyx::graphics::Previews::get().removeLoader(*this);
223 LyXText & Buffer::text() const
225 return const_cast<LyXText &>(pimpl_->inset.text_);
229 InsetBase & Buffer::inset() const
231 return const_cast<InsetText &>(pimpl_->inset);
235 limited_stack<Undo> & Buffer::undostack()
237 return pimpl_->undostack;
241 limited_stack<Undo> const & Buffer::undostack() const
243 return pimpl_->undostack;
247 limited_stack<Undo> & Buffer::redostack()
249 return pimpl_->redostack;
253 limited_stack<Undo> const & Buffer::redostack() const
255 return pimpl_->redostack;
259 BufferParams & Buffer::params()
261 return pimpl_->params;
265 BufferParams const & Buffer::params() const
267 return pimpl_->params;
271 ParagraphList & Buffer::paragraphs()
273 return text().paragraphs();
277 ParagraphList const & Buffer::paragraphs() const
279 return text().paragraphs();
283 LyXVC & Buffer::lyxvc()
285 return pimpl_->lyxvc;
289 LyXVC const & Buffer::lyxvc() const
291 return pimpl_->lyxvc;
295 string const & Buffer::temppath() const
297 return pimpl_->temppath;
301 TexRow & Buffer::texrow()
303 return pimpl_->texrow;
307 TexRow const & Buffer::texrow() const
309 return pimpl_->texrow;
313 string const Buffer::getLatexName(bool no_path) const
315 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
316 return no_path ? OnlyFilename(name) : name;
320 pair<Buffer::LogType, string> const Buffer::getLogName() const
322 string const filename = getLatexName(false);
324 if (filename.empty())
325 return make_pair(Buffer::latexlog, string());
327 string const path = temppath();
329 string const fname = AddName(path,
330 OnlyFilename(ChangeExtension(filename,
333 AddName(path, OnlyFilename(
334 ChangeExtension(filename,
335 formats.extension("literate") + ".out")));
337 // If no Latex log or Build log is newer, show Build log
339 FileInfo const f_fi(fname);
340 FileInfo const b_fi(bname);
343 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
344 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
345 return make_pair(Buffer::buildlog, bname);
347 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
348 return make_pair(Buffer::latexlog, fname);
352 void Buffer::setReadonly(bool flag)
354 if (pimpl_->read_only != flag) {
355 pimpl_->read_only = flag;
361 void Buffer::setFileName(string const & newfile)
363 pimpl_->filename = MakeAbsPath(newfile);
364 pimpl_->filepath = OnlyPath(pimpl_->filename);
365 setReadonly(IsFileWriteable(pimpl_->filename) == 0);
370 // We'll remove this later. (Lgb)
373 void unknownClass(string const & unknown)
375 Alert::warning(_("Unknown document class"),
376 bformat(_("Using the default document class, because the "
377 "class %1$s is unknown."), unknown));
383 int Buffer::readHeader(LyXLex & lex)
385 int unknown_tokens = 0;
389 string const token = lex.getString();
394 if (token == "\\end_header")
397 lyxerr[Debug::PARSER] << "Handling header token: `"
398 << token << '\'' << endl;
401 string unknown = params().readToken(lex, token);
402 if (!unknown.empty()) {
403 if (unknown[0] != '\\') {
404 unknownClass(unknown);
407 string const s = bformat(_("Unknown token: "
411 error(ErrorItem(_("Header error"), s,
416 return unknown_tokens;
421 // changed to be public and have one parameter
422 // Returns false if "\end_document" is not read (Asger)
423 bool Buffer::readBody(LyXLex & lex)
425 if (paragraphs().empty()) {
427 if (!params().getLyXTextClass().load()) {
428 string theclass = params().getLyXTextClass().name();
429 Alert::error(_("Can't load document class"), bformat(
430 "Using the default document class, because the "
431 " class %1$s could not be loaded.", theclass));
432 params().textclass = 0;
435 // We don't want to adopt the parameters from the
436 // document we insert, so read them into a temporary buffer
437 // and then discard it
439 Buffer tmpbuf("", false);
440 tmpbuf.readHeader(lex);
443 return text().read(*this, lex);
447 // needed to insert the selection
448 void Buffer::insertStringAsLines(ParagraphList & pars,
449 par_type & par, pos_type & pos,
450 LyXFont const & fn, string const & str)
452 LyXLayout_ptr const & layout = pars[par].layout();
456 pars[par].checkInsertChar(font);
457 // insert the string, don't insert doublespace
458 bool space_inserted = true;
459 bool autobreakrows = !pars[par].inInset() ||
460 static_cast<InsetText *>(pars[par].inInset())->getAutoBreakRows();
461 for (string::const_iterator cit = str.begin();
462 cit != str.end(); ++cit) {
464 if (autobreakrows && (!pars[par].empty() || pars[par].allowEmpty())) {
465 breakParagraph(params(), paragraphs(), par, pos,
466 layout->isEnvironment());
469 space_inserted = true;
473 // do not insert consecutive spaces if !free_spacing
474 } else if ((*cit == ' ' || *cit == '\t') &&
475 space_inserted && !pars[par].isFreeSpacing()) {
477 } else if (*cit == '\t') {
478 if (!pars[par].isFreeSpacing()) {
479 // tabs are like spaces here
480 pars[par].insertChar(pos, ' ', font);
482 space_inserted = true;
484 const pos_type n = 8 - pos % 8;
485 for (pos_type i = 0; i < n; ++i) {
486 pars[par].insertChar(pos, ' ', font);
489 space_inserted = true;
491 } else if (!IsPrintable(*cit)) {
492 // Ignore unprintables
495 // just insert the character
496 pars[par].insertChar(pos, *cit, font);
498 space_inserted = (*cit == ' ');
505 bool Buffer::readFile(string const & filename)
507 // Check if the file is compressed.
508 string const format = getExtFromContents(filename);
509 if (format == "gzip" || format == "zip" || format == "compress") {
510 params().compressed = true;
513 // remove dummy empty par
514 paragraphs().clear();
515 bool ret = readFile(filename, paragraphs().size());
517 // After we have read a file, we must ensure that the buffer
518 // language is set and used in the gui.
519 // If you know of a better place to put this, please tell me. (Lgb)
520 updateDocLang(params().language);
526 bool Buffer::readFile(string const & filename, par_type pit)
529 lex.setFile(filename);
530 return readFile(lex, filename, pit);
534 bool Buffer::fully_loaded() const
536 return pimpl_->file_fully_loaded;
540 void Buffer::fully_loaded(bool value)
542 pimpl_->file_fully_loaded = value;
546 bool Buffer::readFile(LyXLex & lex, string const & filename, par_type pit)
548 BOOST_ASSERT(!filename.empty());
551 Alert::error(_("Document could not be read"),
552 bformat(_("%1$s could not be read."), filename));
557 string const token(lex.getString());
560 Alert::error(_("Document could not be read"),
561 bformat(_("%1$s could not be read."), filename));
565 // the first token _must_ be...
566 if (token != "\\lyxformat") {
567 lyxerr << "Token: " << token << endl;
569 Alert::error(_("Document format failure"),
570 bformat(_("%1$s is not a LyX document."),
576 string tmp_format = lex.getString();
577 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
578 // if present remove ".," from string.
579 string::size_type dot = tmp_format.find_first_of(".,");
580 //lyxerr << " dot found at " << dot << endl;
581 if (dot != string::npos)
582 tmp_format.erase(dot, 1);
583 int file_format = strToInt(tmp_format);
584 //lyxerr << "format: " << file_format << endl;
586 if (file_format > LYX_FORMAT) {
587 Alert::warning(_("Document format failure"),
588 bformat(_("%1$s was created with a newer"
589 " version of LyX. This is likely to"
592 } else if (file_format < LYX_FORMAT) {
593 string const tmpfile = tempName();
594 if (tmpfile.empty()) {
595 Alert::error(_("Conversion failed"),
596 bformat(_("%1$s is from an earlier"
597 " version of LyX, but a temporary"
598 " file for converting it could"
603 string command = LibFileSearch("lyx2lyx", "lyx2lyx");
604 if (command.empty()) {
605 Alert::error(_("Conversion script not found"),
606 bformat(_("%1$s is from an earlier"
607 " version of LyX, but the"
608 " conversion script lyx2lyx"
609 " could not be found."),
615 + " -o " + tmpfile + ' '
616 + QuoteName(filename);
617 lyxerr[Debug::INFO] << "Running '"
620 cmd_ret const ret = RunCommand(command);
621 if (ret.first != 0) {
622 Alert::error(_("Conversion script failed"),
623 bformat(_("%1$s is from an earlier version"
624 " of LyX, but the lyx2lyx script"
625 " failed to convert it."),
629 bool ret = readFile(tmpfile, pit);
630 // Do stuff with tmpfile name and buffer name here.
636 bool the_end = readBody(lex);
637 params().setPaperStuff();
641 if (token == "\\end_document")
645 Alert::error(_("Document format failure"),
646 bformat(_("%1$s ended unexpectedly, which means"
647 " that it is probably corrupted."),
651 pimpl_->file_fully_loaded = true;
656 // Should probably be moved to somewhere else: BufferView? LyXView?
657 bool Buffer::save() const
659 // We don't need autosaves in the immediate future. (Asger)
660 resetAutosaveTimers();
664 if (lyxrc.make_backup) {
665 s = fileName() + '~';
666 if (!lyxrc.backupdir_path.empty())
667 s = AddName(lyxrc.backupdir_path,
668 subst(os::slashify_path(s),'/','!'));
670 // Rename is the wrong way of making a backup,
671 // this is the correct way.
672 /* truss cp fil fil2:
673 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
674 stat("LyXVC.lyx", 0xEFFFF688) = 0
675 open("LyXVC.lyx", O_RDONLY) = 3
676 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
677 fstat(4, 0xEFFFF508) = 0
678 fstat(3, 0xEFFFF508) = 0
679 read(3, " # T h i s f i l e w".., 8192) = 5579
680 write(4, " # T h i s f i l e w".., 5579) = 5579
681 read(3, 0xEFFFD4A0, 8192) = 0
684 chmod("LyXVC3.lyx", 0100644) = 0
685 lseek(0, 0, SEEK_CUR) = 46440
689 // Should probably have some more error checking here.
690 // Doing it this way, also makes the inodes stay the same.
691 // This is still not a very good solution, in particular we
692 // might loose the owner of the backup.
693 FileInfo finfo(fileName());
695 mode_t fmode = finfo.getMode();
696 struct utimbuf times = {
697 finfo.getAccessTime(),
698 finfo.getModificationTime() };
700 ifstream ifs(fileName().c_str());
701 ofstream ofs(s.c_str(), ios::out|ios::trunc);
706 ::chmod(s.c_str(), fmode);
708 if (::utime(s.c_str(), ×)) {
709 lyxerr << "utime error." << endl;
712 lyxerr << "LyX was not able to make "
713 "backup copy. Beware." << endl;
718 if (writeFile(fileName())) {
720 removeAutosaveFile(fileName());
722 // Saving failed, so backup is not backup
723 if (lyxrc.make_backup)
724 rename(s, fileName());
731 bool Buffer::writeFile(string const & fname) const
733 if (pimpl_->read_only && fname == fileName())
736 FileInfo finfo(fname);
737 if (finfo.exist() && !finfo.writable())
742 if (params().compressed) {
743 gz::ogzstream ofs(fname.c_str());
747 retval = do_writeFile(ofs);
750 ofstream ofs(fname.c_str());
754 retval = do_writeFile(ofs);
761 bool Buffer::do_writeFile(ostream & ofs) const
764 // Use the standard "C" locale for file output.
765 ofs.imbue(std::locale::classic());
768 // The top of the file should not be written by params().
770 // write out a comment in the top of the file
771 ofs << "#LyX " << lyx_version
772 << " created this file. For more info see http://www.lyx.org/\n"
773 << "\\lyxformat " << LYX_FORMAT << "\n";
775 // now write out the buffer parameters.
776 params().writeFile(ofs);
778 ofs << "\\end_header\n";
781 text().write(*this, ofs);
783 // Write marker that shows file is complete
784 ofs << "\n\\end_document" << endl;
786 // Shouldn't really be needed....
789 // how to check if close went ok?
790 // Following is an attempt... (BE 20001011)
792 // good() returns false if any error occured, including some
794 // bad() returns true if something bad happened in the buffer,
795 // which should include file system full errors.
800 lyxerr << "File was not closed properly." << endl;
807 void Buffer::makeLaTeXFile(string const & fname,
808 string const & original_path,
809 OutputParams const & runparams,
810 bool output_preamble, bool output_body)
812 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
815 if (!openFileWrite(ofs, fname))
818 makeLaTeXFile(ofs, original_path,
819 runparams, output_preamble, output_body);
823 lyxerr << "File '" << fname << "' was not closed properly." << endl;
827 void Buffer::makeLaTeXFile(ostream & os,
828 string const & original_path,
829 OutputParams const & runparams_in,
830 bool output_preamble, bool output_body)
832 OutputParams runparams = runparams_in;
834 // validate the buffer.
835 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
836 LaTeXFeatures features(*this, params(), runparams.nice);
838 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
841 // The starting paragraph of the coming rows is the
842 // first paragraph of the document. (Asger)
843 texrow().start(paragraphs().begin()->id(), 0);
845 if (output_preamble && runparams.nice) {
846 os << "%% LyX " << lyx_version << " created this file. "
847 "For more info, see http://www.lyx.org/.\n"
848 "%% Do not edit unless you really know what "
853 lyxerr[Debug::INFO] << "lyx header finished" << endl;
854 // There are a few differences between nice LaTeX and usual files:
855 // usual is \batchmode and has a
856 // special input@path to allow the including of figures
857 // with either \input or \includegraphics (what figinsets do).
858 // input@path is set when the actual parameter
859 // original_path is set. This is done for usual tex-file, but not
860 // for nice-latex-file. (Matthias 250696)
861 // Note that input@path is only needed for something the user does
862 // in the preamble, included .tex files or ERT, files included by
863 // LyX work without it.
864 if (output_preamble) {
865 if (!runparams.nice) {
866 // code for usual, NOT nice-latex-file
867 os << "\\batchmode\n"; // changed
871 if (!original_path.empty()) {
872 string inputpath = os::external_path(original_path);
873 subst(inputpath, "~", "\\string~");
874 os << "\\makeatletter\n"
875 << "\\def\\input@path{{"
876 << inputpath << "/}}\n"
877 << "\\makeatother\n";
883 // Write the preamble
884 runparams.use_babel = params().writeLaTeX(os, features, texrow());
890 os << "\\begin{document}\n";
893 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
895 if (!lyxrc.language_auto_begin) {
896 os << subst(lyxrc.language_command_begin, "$$lang",
897 params().language->babel())
902 // if we are doing a real file with body, even if this is the
903 // child of some other buffer, let's cut the link here.
904 // This happens for example if only a child document is printed.
905 string save_parentname;
906 if (output_preamble) {
907 save_parentname = params().parentname;
908 params().parentname.erase();
912 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
914 // Restore the parenthood if needed
916 params().parentname = save_parentname;
918 // add this just in case after all the paragraphs
922 if (!lyxrc.language_auto_end) {
923 os << subst(lyxrc.language_command_end, "$$lang",
924 params().language->babel())
929 if (output_preamble) {
930 os << "\\end{document}\n";
933 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
935 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
939 // Just to be sure. (Asger)
942 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
943 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
948 bool Buffer::isLatex() const
950 return params().getLyXTextClass().outputType() == LATEX;
954 bool Buffer::isLinuxDoc() const
956 return params().getLyXTextClass().outputType() == LINUXDOC;
960 bool Buffer::isLiterate() const
962 return params().getLyXTextClass().outputType() == LITERATE;
966 bool Buffer::isDocBook() const
968 return params().getLyXTextClass().outputType() == DOCBOOK;
972 bool Buffer::isSGML() const
974 LyXTextClass const & tclass = params().getLyXTextClass();
976 return tclass.outputType() == LINUXDOC ||
977 tclass.outputType() == DOCBOOK;
981 void Buffer::makeLinuxDocFile(string const & fname,
982 OutputParams const & runparams,
986 if (!openFileWrite(ofs, fname))
989 LaTeXFeatures features(*this, params(), runparams.nice);
994 LyXTextClass const & tclass = params().getLyXTextClass();
996 string top_element = tclass.latexname();
999 ofs << tclass.class_header();
1001 string preamble = params().preamble;
1002 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1004 preamble += features.getIncludedFiles(name);
1005 preamble += features.getLyXSGMLEntities();
1007 if (!preamble.empty()) {
1008 ofs << " [ " << preamble << " ]";
1012 if (params().options.empty())
1013 sgml::openTag(ofs, 0, false, top_element);
1015 string top = top_element;
1017 top += params().options;
1018 sgml::openTag(ofs, 0, false, top);
1022 ofs << "<!-- LyX " << lyx_version
1023 << " created this file. For more info see http://www.lyx.org/"
1026 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1030 sgml::closeTag(ofs, 0, false, top_element);
1035 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1039 void Buffer::makeDocBookFile(string const & fname,
1040 OutputParams const & runparams,
1044 if (!openFileWrite(ofs, fname))
1047 LaTeXFeatures features(*this, params(), runparams.nice);
1052 LyXTextClass const & tclass = params().getLyXTextClass();
1053 string top_element = tclass.latexname();
1056 ofs << subst(tclass.class_header(), "#", top_element);
1058 string preamble = params().preamble;
1059 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1061 preamble += features.getIncludedFiles(name);
1062 preamble += features.getLyXSGMLEntities();
1064 if (!preamble.empty()) {
1065 ofs << "\n [ " << preamble << " ]";
1070 string top = top_element;
1072 top += params().language->code();
1075 if (!params().options.empty()) {
1077 top += params().options;
1079 sgml::openTag(ofs, 0, false, top);
1081 ofs << "<!-- SGML/XML file was created by LyX " << lyx_version
1082 << "\n See http://www.lyx.org/ for more information -->\n";
1084 params().getLyXTextClass().counters().reset();
1085 docbookParagraphs(*this, paragraphs(), ofs, runparams);
1088 sgml::closeTag(ofs, 0, false, top_element);
1092 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1096 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1097 // Other flags: -wall -v0 -x
1098 int Buffer::runChktex()
1102 // get LaTeX-Filename
1103 string const name = getLatexName();
1104 string const path = temppath();
1105 string const org_path = filePath();
1107 Path p(path); // path to LaTeX file
1108 message(_("Running chktex..."));
1110 // Generate the LaTeX file if neccessary
1111 OutputParams runparams;
1112 runparams.flavor = OutputParams::LATEX;
1113 runparams.nice = false;
1114 makeLaTeXFile(name, org_path, runparams);
1117 Chktex chktex(lyxrc.chktex_command, name, filePath());
1118 int res = chktex.run(terr); // run chktex
1121 Alert::error(_("chktex failure"),
1122 _("Could not run chktex successfully."));
1123 } else if (res > 0) {
1124 // Insert all errors as errors boxes
1125 bufferErrors(*this, terr);
1134 void Buffer::validate(LaTeXFeatures & features) const
1136 LyXTextClass const & tclass = params().getLyXTextClass();
1138 if (params().tracking_changes) {
1139 features.require("dvipost");
1140 features.require("color");
1143 // AMS Style is at document level
1144 if (params().use_amsmath == BufferParams::AMS_ON
1145 || tclass.provides(LyXTextClass::amsmath))
1146 features.require("amsmath");
1148 for_each(paragraphs().begin(), paragraphs().end(),
1149 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1151 // the bullet shapes are buffer level not paragraph level
1152 // so they are tested here
1153 for (int i = 0; i < 4; ++i) {
1154 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1155 int const font = params().user_defined_bullet(i).getFont();
1157 int const c = params()
1158 .user_defined_bullet(i)
1165 features.require("latexsym");
1167 } else if (font == 1) {
1168 features.require("amssymb");
1169 } else if ((font >= 2 && font <= 5)) {
1170 features.require("pifont");
1175 if (lyxerr.debugging(Debug::LATEX)) {
1176 features.showStruct();
1181 void Buffer::getLabelList(std::vector<string> & list) const
1183 /// if this is a child document and the parent is already loaded
1184 /// Use the parent's list instead [ale990407]
1185 Buffer const * tmp = getMasterBuffer();
1187 lyxerr << "getMasterBuffer() failed!" << endl;
1191 tmp->getLabelList(list);
1195 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1196 it.nextInset()->getLabelList(*this, list);
1200 // This is also a buffer property (ale)
1201 void Buffer::fillWithBibKeys(std::vector<std::pair<string, string> > & keys)
1204 /// if this is a child document and the parent is already loaded
1205 /// use the parent's list instead [ale990412]
1206 Buffer const * tmp = getMasterBuffer();
1209 tmp->fillWithBibKeys(keys);
1213 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1214 if (it->lyxCode() == InsetOld::BIBTEX_CODE) {
1215 InsetBibtex const & inset =
1216 dynamic_cast<InsetBibtex const &>(*it);
1217 inset.fillWithBibKeys(*this, keys);
1218 } else if (it->lyxCode() == InsetOld::INCLUDE_CODE) {
1219 InsetInclude const & inset =
1220 dynamic_cast<InsetInclude const &>(*it);
1221 inset.fillWithBibKeys(*this, keys);
1222 } else if (it->lyxCode() == InsetOld::BIBITEM_CODE) {
1223 InsetBibitem const & inset =
1224 dynamic_cast<InsetBibitem const &>(*it);
1225 string const key = inset.getContents();
1226 string const opt = inset.getOptions();
1227 string const ref; // = pit->asString(this, false);
1228 string const info = opt + "TheBibliographyRef" + ref;
1229 keys.push_back(pair<string, string>(key, info));
1235 bool Buffer::isDepClean(string const & name) const
1237 DepClean::const_iterator it = pimpl_->dep_clean.find(name);
1238 if (it == pimpl_->dep_clean.end())
1244 void Buffer::markDepClean(string const & name)
1246 pimpl_->dep_clean[name] = true;
1250 bool Buffer::dispatch(string const & command, bool * result)
1252 return dispatch(lyxaction.lookupFunc(command), result);
1256 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1258 bool dispatched = true;
1260 switch (func.action) {
1262 bool const tmp = Exporter::Export(this, func.argument, false);
1275 void Buffer::changeLanguage(Language const * from, Language const * to)
1277 lyxerr << "Changing Language!" << endl;
1279 // Take care of l10n/i18n
1282 ParIterator end = par_iterator_end();
1283 for (ParIterator it = par_iterator_begin(); it != end; ++it)
1284 it->changeLanguage(params(), from, to);
1288 void Buffer::updateDocLang(Language const * nlang)
1290 pimpl_->messages.reset(new Messages(nlang->code()));
1294 bool Buffer::isMultiLingual() const
1296 ParConstIterator end = par_iterator_end();
1297 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1298 if (it->isMultiLingual(params()))
1305 ParIterator Buffer::getParFromID(int id) const
1307 ParConstIterator it = par_iterator_begin();
1308 ParConstIterator end = par_iterator_end();
1311 // John says this is called with id == -1 from undo
1312 lyxerr << "getParFromID(), id: " << id << endl;
1316 for (; it != end; ++it)
1324 bool Buffer::hasParWithID(int id) const
1326 ParConstIterator it = par_iterator_begin();
1327 ParConstIterator end = par_iterator_end();
1330 // John says this is called with id == -1 from undo
1331 lyxerr << "hasParWithID(), id: " << id << endl;
1335 for (; it != end; ++it)
1343 ParIterator Buffer::par_iterator_begin()
1345 return ::par_iterator_begin(inset());
1349 ParIterator Buffer::par_iterator_end()
1351 return ::par_iterator_end(inset());
1355 ParConstIterator Buffer::par_iterator_begin() const
1357 return ::par_const_iterator_begin(inset());
1361 ParConstIterator Buffer::par_iterator_end() const
1363 return ::par_const_iterator_end(inset());
1367 Language const * Buffer::getLanguage() const
1369 return params().language;
1373 string const Buffer::B_(string const & l10n) const
1375 if (pimpl_->messages.get()) {
1376 return pimpl_->messages->get(l10n);
1383 bool Buffer::isClean() const
1385 return pimpl_->lyx_clean;
1389 bool Buffer::isBakClean() const
1391 return pimpl_->bak_clean;
1395 void Buffer::markClean() const
1397 if (!pimpl_->lyx_clean) {
1398 pimpl_->lyx_clean = true;
1401 // if the .lyx file has been saved, we don't need an
1403 pimpl_->bak_clean = true;
1407 void Buffer::markBakClean()
1409 pimpl_->bak_clean = true;
1413 void Buffer::setUnnamed(bool flag)
1415 pimpl_->unnamed = flag;
1419 bool Buffer::isUnnamed() const
1421 return pimpl_->unnamed;
1425 void Buffer::markDirty()
1427 if (pimpl_->lyx_clean) {
1428 pimpl_->lyx_clean = false;
1431 pimpl_->bak_clean = false;
1433 DepClean::iterator it = pimpl_->dep_clean.begin();
1434 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1436 for (; it != end; ++it) {
1442 string const & Buffer::fileName() const
1444 return pimpl_->filename;
1448 string const & Buffer::filePath() const
1450 return pimpl_->filepath;
1454 bool Buffer::isReadonly() const
1456 return pimpl_->read_only;
1460 void Buffer::setParentName(string const & name)
1462 params().parentname = name;
1466 Buffer const * Buffer::getMasterBuffer() const
1468 if (!params().parentname.empty()
1469 && bufferlist.exists(params().parentname)) {
1470 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1472 return buf->getMasterBuffer();