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 bool ret = readFile(lex, filename);
571 // After we have read a file, we must ensure that the buffer
572 // language is set and used in the gui.
573 // If you know of a better place to put this, please tell me. (Lgb)
574 updateDocLang(params().language);
580 bool Buffer::fully_loaded() const
582 return pimpl_->file_fully_loaded;
586 void Buffer::fully_loaded(bool const value)
588 pimpl_->file_fully_loaded = value;
592 bool Buffer::readFile(LyXLex & lex, string const & filename)
594 BOOST_ASSERT(!filename.empty());
597 Alert::error(_("Document could not be read"),
598 bformat(_("%1$s could not be read."), filename));
603 string const token(lex.getString());
606 Alert::error(_("Document could not be read"),
607 bformat(_("%1$s could not be read."), filename));
611 // the first token _must_ be...
612 if (token != "\\lyxformat") {
613 lyxerr << "Token: " << token << endl;
615 Alert::error(_("Document format failure"),
616 bformat(_("%1$s is not a LyX document."),
622 string tmp_format = lex.getString();
623 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
624 // if present remove ".," from string.
625 string::size_type dot = tmp_format.find_first_of(".,");
626 //lyxerr << " dot found at " << dot << endl;
627 if (dot != string::npos)
628 tmp_format.erase(dot, 1);
629 int const file_format = convert<int>(tmp_format);
630 //lyxerr << "format: " << file_format << endl;
632 if (file_format != LYX_FORMAT) {
633 string const tmpfile = tempName();
634 if (tmpfile.empty()) {
635 Alert::error(_("Conversion failed"),
636 bformat(_("%1$s is from an earlier"
637 " version of LyX, but a temporary"
638 " file for converting it could"
643 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
644 if (lyx2lyx.empty()) {
645 Alert::error(_("Conversion script not found"),
646 bformat(_("%1$s is from an earlier"
647 " version of LyX, but the"
648 " conversion script lyx2lyx"
649 " could not be found."),
653 ostringstream command;
654 command << os::python() << ' ' << quoteName(lyx2lyx)
655 << " -t " << convert<string>(LYX_FORMAT)
656 << " -o " << quoteName(tmpfile) << ' '
657 << quoteName(filename);
658 string const command_str = command.str();
660 lyxerr[Debug::INFO] << "Running '"
661 << command_str << '\''
664 cmd_ret const ret = runCommand(command_str);
665 if (ret.first != 0) {
666 Alert::error(_("Conversion script failed"),
667 bformat(_("%1$s is from an earlier version"
668 " of LyX, but the lyx2lyx script"
669 " failed to convert it."),
673 bool const ret = readFile(tmpfile);
674 // Do stuff with tmpfile name and buffer name here.
680 if (readDocument(lex)) {
681 Alert::error(_("Document format failure"),
682 bformat(_("%1$s ended unexpectedly, which means"
683 " that it is probably corrupted."),
687 //lyxerr << "removing " << MacroTable::localMacros().size()
688 // << " temporary macro entries" << endl;
689 //MacroTable::localMacros().clear();
691 pimpl_->file_fully_loaded = true;
696 // Should probably be moved to somewhere else: BufferView? LyXView?
697 bool Buffer::save() const
699 // We don't need autosaves in the immediate future. (Asger)
700 resetAutosaveTimers();
704 if (lyxrc.make_backup) {
705 s = fileName() + '~';
706 if (!lyxrc.backupdir_path.empty())
707 s = addName(lyxrc.backupdir_path,
708 subst(os::internal_path(s),'/','!'));
710 // It might very well be that this variant is just
711 // good enough. (Lgb)
712 // But to use this we need fs::copy_file to actually do a copy,
713 // even when the target file exists. (Lgb)
714 if (fs::exists(fileName()) && fs::is_writable(fs::path(fileName()).branch_path())) {
716 fs::copy_file(fileName(), s, false);
718 //catch (fs::filesystem_error const & fe) {
719 //lyxerr << "LyX was not able to make backup copy. Beware.\n"
720 // << fe.what() << endl;
725 if (writeFile(fileName())) {
727 removeAutosaveFile(fileName());
729 // Saving failed, so backup is not backup
730 if (lyxrc.make_backup)
731 rename(s, fileName());
738 bool Buffer::writeFile(string const & fname) const
740 if (pimpl_->read_only && fname == fileName())
745 if (params().compressed) {
746 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
750 retval = do_writeFile(ofs);
752 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
756 retval = do_writeFile(ofs);
763 bool Buffer::do_writeFile(ostream & ofs) const
766 // Use the standard "C" locale for file output.
767 ofs.imbue(std::locale::classic());
770 // The top of the file should not be written by params().
772 // write out a comment in the top of the file
773 ofs << "#LyX " << lyx_version
774 << " created this file. For more info see http://www.lyx.org/\n"
775 << "\\lyxformat " << LYX_FORMAT << "\n"
776 << "\\begin_document\n";
778 // now write out the buffer parameters.
779 ofs << "\\begin_header\n";
780 params().writeFile(ofs);
781 ofs << "\\end_header\n";
784 ofs << "\n\\begin_body\n";
785 text().write(*this, ofs);
786 ofs << "\n\\end_body\n";
788 // Write marker that shows file is complete
789 ofs << "\\end_document" << endl;
791 // Shouldn't really be needed....
794 // how to check if close went ok?
795 // Following is an attempt... (BE 20001011)
797 // good() returns false if any error occured, including some
799 // bad() returns true if something bad happened in the buffer,
800 // which should include file system full errors.
805 lyxerr << "File was not closed properly." << endl;
812 void Buffer::makeLaTeXFile(string const & fname,
813 string const & original_path,
814 OutputParams const & runparams,
815 bool output_preamble, bool output_body)
817 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
820 if (!openFileWrite(ofs, fname))
823 writeLaTeXSource(ofs, original_path,
824 runparams, output_preamble, output_body);
828 lyxerr << "File '" << fname << "' was not closed properly." << endl;
832 void Buffer::writeLaTeXSource(ostream & os,
833 string const & original_path,
834 OutputParams const & runparams_in,
835 bool const output_preamble, bool const output_body)
837 OutputParams runparams = runparams_in;
839 // validate the buffer.
840 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
841 LaTeXFeatures features(*this, params(), runparams);
843 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
847 // The starting paragraph of the coming rows is the
848 // first paragraph of the document. (Asger)
849 texrow().start(paragraphs().begin()->id(), 0);
851 if (output_preamble && runparams.nice) {
852 os << "%% LyX " << lyx_version << " created this file. "
853 "For more info, see http://www.lyx.org/.\n"
854 "%% Do not edit unless you really know what "
859 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
860 // There are a few differences between nice LaTeX and usual files:
861 // usual is \batchmode and has a
862 // special input@path to allow the including of figures
863 // with either \input or \includegraphics (what figinsets do).
864 // input@path is set when the actual parameter
865 // original_path is set. This is done for usual tex-file, but not
866 // for nice-latex-file. (Matthias 250696)
867 // Note that input@path is only needed for something the user does
868 // in the preamble, included .tex files or ERT, files included by
869 // LyX work without it.
870 if (output_preamble) {
871 if (!runparams.nice) {
872 // code for usual, NOT nice-latex-file
873 os << "\\batchmode\n"; // changed
877 if (!original_path.empty()) {
878 string const inputpath = latex_path(original_path);
879 os << "\\makeatletter\n"
880 << "\\def\\input@path{{"
881 << inputpath << "/}}\n"
882 << "\\makeatother\n";
888 // Write the preamble
889 runparams.use_babel = params().writeLaTeX(os, features, texrow());
895 os << "\\begin{document}\n";
898 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
900 if (!lyxrc.language_auto_begin) {
901 os << subst(lyxrc.language_command_begin, "$$lang",
902 params().language->babel())
907 // if we are doing a real file with body, even if this is the
908 // child of some other buffer, let's cut the link here.
909 // This happens for example if only a child document is printed.
910 string save_parentname;
911 if (output_preamble) {
912 save_parentname = params().parentname;
913 params().parentname.erase();
917 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
919 // Restore the parenthood if needed
921 params().parentname = save_parentname;
923 // add this just in case after all the paragraphs
927 if (!lyxrc.language_auto_end) {
928 os << subst(lyxrc.language_command_end, "$$lang",
929 params().language->babel())
934 if (output_preamble) {
935 os << "\\end{document}\n";
938 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
940 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
944 // Just to be sure. (Asger)
947 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
948 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
953 bool Buffer::isLatex() const
955 return params().getLyXTextClass().outputType() == LATEX;
959 bool Buffer::isLiterate() const
961 return params().getLyXTextClass().outputType() == LITERATE;
965 bool Buffer::isDocBook() const
967 return params().getLyXTextClass().outputType() == DOCBOOK;
971 void Buffer::makeDocBookFile(string const & fname,
972 OutputParams const & runparams,
973 bool const body_only)
975 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
978 if (!openFileWrite(ofs, fname))
981 writeDocBookSource(ofs, fname, runparams, body_only);
985 lyxerr << "File '" << fname << "' was not closed properly." << endl;
989 void Buffer::writeDocBookSource(ostream & os, string const & fname,
990 OutputParams const & runparams,
991 bool const only_body)
993 LaTeXFeatures features(*this, params(), runparams);
998 LyXTextClass const & tclass = params().getLyXTextClass();
999 string const & top_element = tclass.latexname();
1002 if (runparams.flavor == OutputParams::XML)
1003 os << "<?xml version=\"1.0\" encoding=\""
1004 << params().language->encoding()->name() << "\"?>\n";
1006 os << "<!DOCTYPE " << top_element << " ";
1008 if (! tclass.class_header().empty()) os << tclass.class_header();
1009 else if (runparams.flavor == OutputParams::XML)
1010 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1011 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1013 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1015 string preamble = params().preamble;
1016 if (runparams.flavor != OutputParams::XML ) {
1017 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1018 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1019 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1020 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1023 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1025 preamble += features.getIncludedFiles(name);
1026 preamble += features.getLyXSGMLEntities();
1028 if (!preamble.empty()) {
1029 os << "\n [ " << preamble << " ]";
1034 string top = top_element;
1036 if (runparams.flavor == OutputParams::XML)
1037 top += params().language->code();
1039 top += params().language->code().substr(0,2);
1042 if (!params().options.empty()) {
1044 top += params().options;
1047 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1048 << " file was created by LyX " << lyx_version
1049 << "\n See http://www.lyx.org/ for more information -->\n";
1051 params().getLyXTextClass().counters().reset();
1053 sgml::openTag(os, top);
1055 docbookParagraphs(paragraphs(), *this, os, runparams);
1056 sgml::closeTag(os, top_element);
1060 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1061 // Other flags: -wall -v0 -x
1062 int Buffer::runChktex()
1066 // get LaTeX-Filename
1067 string const name = getLatexName();
1068 string const path = temppath();
1069 string const org_path = filePath();
1071 Path p(path); // path to LaTeX file
1072 message(_("Running chktex..."));
1074 // Generate the LaTeX file if neccessary
1075 OutputParams runparams;
1076 runparams.flavor = OutputParams::LATEX;
1077 runparams.nice = false;
1078 makeLaTeXFile(name, org_path, runparams);
1081 Chktex chktex(lyxrc.chktex_command, name, filePath());
1082 int const res = chktex.run(terr); // run chktex
1085 Alert::error(_("chktex failure"),
1086 _("Could not run chktex successfully."));
1087 } else if (res > 0) {
1088 // Fill-in the error list with the TeX errors
1089 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1100 void Buffer::validate(LaTeXFeatures & features) const
1102 LyXTextClass const & tclass = params().getLyXTextClass();
1104 if (features.isAvailable("dvipost") && params().tracking_changes
1105 && params().output_changes)
1106 features.require("dvipost");
1108 // AMS Style is at document level
1109 if (params().use_amsmath == BufferParams::AMS_ON
1110 || tclass.provides(LyXTextClass::amsmath))
1111 features.require("amsmath");
1113 for_each(paragraphs().begin(), paragraphs().end(),
1114 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1116 // the bullet shapes are buffer level not paragraph level
1117 // so they are tested here
1118 for (int i = 0; i < 4; ++i) {
1119 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1120 int const font = params().user_defined_bullet(i).getFont();
1122 int const c = params()
1123 .user_defined_bullet(i)
1130 features.require("latexsym");
1132 } else if (font == 1) {
1133 features.require("amssymb");
1134 } else if ((font >= 2 && font <= 5)) {
1135 features.require("pifont");
1140 if (lyxerr.debugging(Debug::LATEX)) {
1141 features.showStruct();
1146 void Buffer::getLabelList(vector<string> & list) const
1148 /// if this is a child document and the parent is already loaded
1149 /// Use the parent's list instead [ale990407]
1150 Buffer const * tmp = getMasterBuffer();
1152 lyxerr << "getMasterBuffer() failed!" << endl;
1156 tmp->getLabelList(list);
1160 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1161 it.nextInset()->getLabelList(*this, list);
1165 // This is also a buffer property (ale)
1166 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1169 /// if this is a child document and the parent is already loaded
1170 /// use the parent's list instead [ale990412]
1171 Buffer const * tmp = getMasterBuffer();
1174 tmp->fillWithBibKeys(keys);
1178 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1179 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1180 InsetBibtex const & inset =
1181 dynamic_cast<InsetBibtex const &>(*it);
1182 inset.fillWithBibKeys(*this, keys);
1183 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1184 InsetInclude const & inset =
1185 dynamic_cast<InsetInclude const &>(*it);
1186 inset.fillWithBibKeys(*this, keys);
1187 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1188 InsetBibitem const & inset =
1189 dynamic_cast<InsetBibitem const &>(*it);
1190 string const key = inset.getContents();
1191 string const opt = inset.getOptions();
1192 string const ref; // = pit->asString(this, false);
1193 string const info = opt + "TheBibliographyRef" + ref;
1194 keys.push_back(pair<string, string>(key, info));
1200 void Buffer::updateBibfilesCache()
1202 // if this is a child document and the parent is already loaded
1203 // update the parent's cache instead
1204 Buffer * tmp = getMasterBuffer();
1207 tmp->updateBibfilesCache();
1211 bibfilesCache_.clear();
1212 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1213 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1214 InsetBibtex const & inset =
1215 dynamic_cast<InsetBibtex const &>(*it);
1216 vector<string> const bibfiles = inset.getFiles(*this);
1217 bibfilesCache_.insert(bibfilesCache_.end(),
1220 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1221 InsetInclude & inset =
1222 dynamic_cast<InsetInclude &>(*it);
1223 inset.updateBibfilesCache(*this);
1224 vector<string> const & bibfiles =
1225 inset.getBibfilesCache(*this);
1226 bibfilesCache_.insert(bibfilesCache_.end(),
1234 vector<string> const & Buffer::getBibfilesCache() const
1236 // if this is a child document and the parent is already loaded
1237 // use the parent's cache instead
1238 Buffer const * tmp = getMasterBuffer();
1241 return tmp->getBibfilesCache();
1243 return bibfilesCache_;
1247 bool Buffer::isDepClean(string const & name) const
1249 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1250 if (it == pimpl_->dep_clean.end())
1256 void Buffer::markDepClean(string const & name)
1258 pimpl_->dep_clean[name] = true;
1262 bool Buffer::dispatch(string const & command, bool * result)
1264 return dispatch(lyxaction.lookupFunc(command), result);
1268 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1270 bool dispatched = true;
1272 switch (func.action) {
1273 case LFUN_BUFFER_EXPORT: {
1274 bool const tmp = Exporter::Export(this, func.argument, false);
1287 void Buffer::changeLanguage(Language const * from, Language const * to)
1292 // Take care of l10n/i18n
1295 for_each(par_iterator_begin(),
1297 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1299 text().current_font.setLanguage(to);
1300 text().real_current_font.setLanguage(to);
1304 void Buffer::updateDocLang(Language const * nlang)
1306 BOOST_ASSERT(nlang);
1308 pimpl_->messages.reset(new Messages(nlang->code()));
1310 updateLabels(*this);
1314 bool Buffer::isMultiLingual() const
1316 ParConstIterator end = par_iterator_end();
1317 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1318 if (it->isMultiLingual(params()))
1325 ParIterator Buffer::getParFromID(int const id) const
1327 ParConstIterator it = par_iterator_begin();
1328 ParConstIterator const end = par_iterator_end();
1331 // John says this is called with id == -1 from undo
1332 lyxerr << "getParFromID(), id: " << id << endl;
1336 for (; it != end; ++it)
1344 bool Buffer::hasParWithID(int const id) const
1346 ParConstIterator const it = getParFromID(id);
1347 return it != par_iterator_end();
1351 ParIterator Buffer::par_iterator_begin()
1353 return ::par_iterator_begin(inset());
1357 ParIterator Buffer::par_iterator_end()
1359 return ::par_iterator_end(inset());
1363 ParConstIterator Buffer::par_iterator_begin() const
1365 return ::par_const_iterator_begin(inset());
1369 ParConstIterator Buffer::par_iterator_end() const
1371 return ::par_const_iterator_end(inset());
1375 Language const * Buffer::getLanguage() const
1377 return params().language;
1381 string const Buffer::B_(string const & l10n) const
1383 if (pimpl_->messages.get()) {
1384 return pimpl_->messages->get(l10n);
1391 bool Buffer::isClean() const
1393 return pimpl_->lyx_clean;
1397 bool Buffer::isBakClean() const
1399 return pimpl_->bak_clean;
1403 void Buffer::markClean() const
1405 if (!pimpl_->lyx_clean) {
1406 pimpl_->lyx_clean = true;
1409 // if the .lyx file has been saved, we don't need an
1411 pimpl_->bak_clean = true;
1415 void Buffer::markBakClean()
1417 pimpl_->bak_clean = true;
1421 void Buffer::setUnnamed(bool flag)
1423 pimpl_->unnamed = flag;
1427 bool Buffer::isUnnamed() const
1429 return pimpl_->unnamed;
1433 #ifdef WITH_WARNINGS
1434 #warning this function should be moved to buffer_pimpl.C
1436 void Buffer::markDirty()
1438 if (pimpl_->lyx_clean) {
1439 pimpl_->lyx_clean = false;
1442 pimpl_->bak_clean = false;
1444 DepClean::iterator it = pimpl_->dep_clean.begin();
1445 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1447 for (; it != end; ++it) {
1453 string const & Buffer::fileName() const
1455 return pimpl_->filename;
1459 string const & Buffer::filePath() const
1461 return params().filepath;
1465 bool Buffer::isReadonly() const
1467 return pimpl_->read_only;
1471 void Buffer::setParentName(string const & name)
1473 params().parentname = name;
1477 Buffer const * Buffer::getMasterBuffer() const
1479 if (!params().parentname.empty()
1480 && bufferlist.exists(params().parentname)) {
1481 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1483 return buf->getMasterBuffer();
1490 Buffer * Buffer::getMasterBuffer()
1492 if (!params().parentname.empty()
1493 && bufferlist.exists(params().parentname)) {
1494 Buffer * buf = bufferlist.getBuffer(params().parentname);
1496 return buf->getMasterBuffer();
1503 MacroData const & Buffer::getMacro(std::string const & name) const
1505 return pimpl_->macros.get(name);
1509 bool Buffer::hasMacro(string const & name) const
1511 return pimpl_->macros.has(name);
1515 void Buffer::insertMacro(string const & name, MacroData const & data)
1517 MacroTable::globalMacros().insert(name, data);
1518 pimpl_->macros.insert(name, data);
1522 void Buffer::buildMacros()
1524 // Start with global table.
1525 pimpl_->macros = MacroTable::globalMacros();
1528 ParagraphList const & pars = text().paragraphs();
1529 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1530 //lyxerr << "searching main par " << i
1531 // << " for macro definitions" << std::endl;
1532 InsetList const & insets = pars[i].insetlist;
1533 InsetList::const_iterator it = insets.begin();
1534 InsetList::const_iterator end = insets.end();
1535 for ( ; it != end; ++it) {
1536 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1537 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1538 MathMacroTemplate const & mac
1539 = static_cast<MathMacroTemplate const &>(*it->inset);
1540 insertMacro(mac.name(), mac.asMacroData());
1547 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1554 void Buffer::changeRefsIfUnique(string const & from, string const & to)
1556 // Check if the label 'from' appears more than once
1557 vector<string> labels;
1558 getLabelList(labels);
1560 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1563 InsetBase::Code code = InsetBase::REF_CODE;
1565 ParIterator it = par_iterator_begin();
1566 ParIterator end = par_iterator_end();
1567 for ( ; it != end; ++it) {
1568 bool changed_inset = false;
1569 for (InsetList::iterator it2 = it->insetlist.begin();
1570 it2 != it->insetlist.end(); ++it2) {
1571 if (it2->inset->lyxCode() == code) {
1572 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1573 if (inset->getContents() == from) {
1574 inset->setContents(to);
1575 //inset->setButtonLabel();
1576 changed_inset = true;
1584 void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1586 OutputParams runparams;
1587 runparams.nice = true;
1588 runparams.flavor = OutputParams::LATEX;
1589 runparams.linelen = lyxrc.ascii_linelen;
1590 // No side effect of file copying and image conversion
1591 runparams.dryrun = true;
1594 os << "% Preview source code\n\n";
1596 writeLaTeXSource(os, filePath(), runparams, true, true);
1598 writeDocBookSource(os, fileName(), runparams, false);
1600 runparams.par_begin = par_begin;
1601 runparams.par_end = par_end;
1602 if (par_begin + 1 == par_end)
1603 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1605 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1606 // output paragraphs
1609 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1611 docbookParagraphs(paragraphs(), *this, os, runparams);
1616 ErrorList const & Buffer::errorList(string const & type) const
1618 static ErrorList const emptyErrorList;
1619 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1620 if (I == errorLists_.end())
1621 return emptyErrorList;
1627 ErrorList & Buffer::errorList(string const & type)
1629 return errorLists_[type];