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 "bufferparams.h"
24 #include "errorlist.h"
27 #include "funcrequest.h"
29 #include "insetiterator.h"
32 #include "LaTeXFeatures.h"
33 #include "LyXAction.h"
41 #include "output_docbook.h"
42 #include "output_latex.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 "mathed/MathMacroTemplate.h"
58 #include "mathed/MathMacroTable.h"
59 #include "mathed/MathSupport.h"
61 #include "frontends/Alert.h"
62 #include "frontends/Application.h"
64 #include "graphics/Previews.h"
66 #include "support/types.h"
67 #include "support/lyxalgo.h"
68 #include "support/filetools.h"
69 #include "support/fs_extras.h"
70 # include <boost/iostreams/filtering_stream.hpp>
71 # include <boost/iostreams/filter/gzip.hpp>
72 # include <boost/iostreams/device/file.hpp>
73 namespace io = boost::iostreams;
74 #include "support/lyxlib.h"
75 #include "support/os.h"
76 #include "support/path.h"
77 #include "support/textutils.h"
78 #include "support/convert.h"
80 #include <boost/bind.hpp>
81 #include <boost/filesystem/exception.hpp>
82 #include <boost/filesystem/operations.hpp>
84 #if defined (HAVE_UTIME_H)
86 #elif defined (HAVE_SYS_UTIME_H)
87 # include <sys/utime.h>
100 using lyx::support::addName;
101 using lyx::support::bformat;
102 using lyx::support::changeExtension;
103 using lyx::support::cmd_ret;
104 using lyx::support::createBufferTmpDir;
105 using lyx::support::destroyDir;
106 using lyx::support::getFormatFromContents;
107 using lyx::support::isDirWriteable;
108 using lyx::support::libFileSearch;
109 using lyx::support::latex_path;
110 using lyx::support::ltrim;
111 using lyx::support::makeAbsPath;
112 using lyx::support::makeDisplayPath;
113 using lyx::support::makeLatexName;
114 using lyx::support::onlyFilename;
115 using lyx::support::onlyPath;
116 using lyx::support::quoteName;
117 using lyx::support::removeAutosaveFile;
118 using lyx::support::rename;
119 using lyx::support::runCommand;
120 using lyx::support::split;
121 using lyx::support::subst;
122 using lyx::support::tempName;
123 using lyx::support::trim;
125 namespace os = lyx::support::os;
126 namespace fs = boost::filesystem;
130 using std::make_pair;
136 using std::ostringstream;
146 int const LYX_FORMAT = 249;
151 typedef std::map<string, bool> DepClean;
156 Impl(Buffer & parent, string const & file, bool readonly);
158 limited_stack<Undo> undostack;
159 limited_stack<Undo> redostack;
165 /// need to regenerate .tex?
169 mutable bool lyx_clean;
171 /// is autosave needed?
172 mutable bool bak_clean;
174 /// is this a unnamed file (New...)?
180 /// name of the file the buffer is associated with.
183 boost::scoped_ptr<Messages> messages;
185 /** Set to true only when the file is fully loaded.
186 * Used to prevent the premature generation of previews
187 * and by the citation inset.
189 bool file_fully_loaded;
191 /// our LyXText that should be wrapped in an InsetText
199 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
200 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
201 filename(file), file_fully_loaded(false),
204 inset.setAutoBreakRows(true);
205 lyxvc.buffer(&parent);
206 temppath = createBufferTmpDir();
207 params.filepath = onlyPath(file);
208 // FIXME: And now do something if temppath == string(), because we
209 // assume from now on that temppath points to a valid temp dir.
210 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
214 Buffer::Buffer(string const & file, bool readonly)
215 : pimpl_(new Impl(*this, file, readonly))
217 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
223 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
224 // here the buffer should take care that it is
225 // saved properly, before it goes into the void.
229 if (!temppath().empty() && !destroyDir(temppath())) {
230 Alert::warning(_("Could not remove temporary directory"),
231 bformat(_("Could not remove the temporary directory %1$s"),
232 lyx::from_utf8(temppath())));
235 // Remove any previewed LaTeX snippets associated with this buffer.
236 lyx::graphics::Previews::get().removeLoader(*this);
240 LyXText & Buffer::text() const
242 return const_cast<LyXText &>(pimpl_->inset.text_);
246 InsetBase & Buffer::inset() const
248 return const_cast<InsetText &>(pimpl_->inset);
252 limited_stack<Undo> & Buffer::undostack()
254 return pimpl_->undostack;
258 limited_stack<Undo> const & Buffer::undostack() const
260 return pimpl_->undostack;
264 limited_stack<Undo> & Buffer::redostack()
266 return pimpl_->redostack;
270 limited_stack<Undo> const & Buffer::redostack() const
272 return pimpl_->redostack;
276 BufferParams & Buffer::params()
278 return pimpl_->params;
282 BufferParams const & Buffer::params() const
284 return pimpl_->params;
288 ParagraphList & Buffer::paragraphs()
290 return text().paragraphs();
294 ParagraphList const & Buffer::paragraphs() const
296 return text().paragraphs();
300 LyXVC & Buffer::lyxvc()
302 return pimpl_->lyxvc;
306 LyXVC const & Buffer::lyxvc() const
308 return pimpl_->lyxvc;
312 string const & Buffer::temppath() const
314 return pimpl_->temppath;
318 TexRow & Buffer::texrow()
320 return pimpl_->texrow;
324 TexRow const & Buffer::texrow() const
326 return pimpl_->texrow;
330 string const Buffer::getLatexName(bool const no_path) const
332 string const name = changeExtension(makeLatexName(fileName()), ".tex");
333 return no_path ? onlyFilename(name) : name;
337 pair<Buffer::LogType, string> const Buffer::getLogName() const
339 string const filename = getLatexName(false);
341 if (filename.empty())
342 return make_pair(Buffer::latexlog, string());
344 string const path = temppath();
346 string const fname = addName(path,
347 onlyFilename(changeExtension(filename,
350 addName(path, onlyFilename(
351 changeExtension(filename,
352 formats.extension("literate") + ".out")));
354 // If no Latex log or Build log is newer, show Build log
356 if (fs::exists(bname) &&
357 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
358 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
359 return make_pair(Buffer::buildlog, bname);
361 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
362 return make_pair(Buffer::latexlog, fname);
366 void Buffer::setReadonly(bool const flag)
368 if (pimpl_->read_only != flag) {
369 pimpl_->read_only = flag;
375 void Buffer::setFileName(string const & newfile)
377 pimpl_->filename = makeAbsPath(newfile);
378 params().filepath = onlyPath(pimpl_->filename);
379 setReadonly(fs::is_readonly(pimpl_->filename));
384 // We'll remove this later. (Lgb)
387 void unknownClass(string const & unknown)
389 Alert::warning(_("Unknown document class"),
390 bformat(_("Using the default document class, because the "
391 "class %1$s is unknown."), lyx::from_utf8(unknown)));
397 int Buffer::readHeader(LyXLex & lex)
399 int unknown_tokens = 0;
401 int begin_header_line = -1;
403 // Initialize parameters that may be/go lacking in header:
404 params().branchlist().clear();
405 params().preamble.erase();
406 params().options.erase();
407 params().float_placement.erase();
408 params().paperwidth.erase();
409 params().paperheight.erase();
410 params().leftmargin.erase();
411 params().rightmargin.erase();
412 params().topmargin.erase();
413 params().bottommargin.erase();
414 params().headheight.erase();
415 params().headsep.erase();
416 params().footskip.erase();
418 ErrorList & errorList = errorLists_["Parse"];
422 string const token = lex.getString();
427 if (token == "\\end_header")
431 if (token == "\\begin_header") {
432 begin_header_line = line;
436 lyxerr[Debug::PARSER] << "Handling document header token: `"
437 << token << '\'' << endl;
439 string unknown = params().readToken(lex, token);
440 if (!unknown.empty()) {
441 if (unknown[0] != '\\' && token == "\\textclass") {
442 unknownClass(unknown);
445 docstring const s = bformat(_("Unknown token: "
447 lyx::from_utf8(token),
448 lyx::from_utf8(lex.getString()));
449 errorList.push_back(ErrorItem(_("Document header error"),
454 if (begin_header_line) {
455 docstring const s = _("\\begin_header is missing");
456 errorList.push_back(ErrorItem(_("Document header error"),
460 return unknown_tokens;
465 // changed to be public and have one parameter
466 // Returns false if "\end_document" is not read (Asger)
467 bool Buffer::readDocument(LyXLex & lex)
469 ErrorList & errorList = errorLists_["Parse"];
473 string const token = lex.getString();
474 if (token != "\\begin_document") {
475 docstring const s = _("\\begin_document is missing");
476 errorList.push_back(ErrorItem(_("Document header error"),
480 // we are reading in a brand new document
481 BOOST_ASSERT(paragraphs().empty());
484 if (!params().getLyXTextClass().load(filePath())) {
485 string theclass = params().getLyXTextClass().name();
486 Alert::error(_("Can't load document class"), bformat(
487 _("Using the default document class, because the "
488 " class %1$s could not be loaded."), lyx::from_utf8(theclass)));
489 params().textclass = 0;
492 bool const res = text().read(*this, lex, errorList);
493 for_each(text().paragraphs().begin(),
494 text().paragraphs().end(),
495 bind(&Paragraph::setInsetOwner, _1, &inset()));
496 updateBibfilesCache();
502 // needed to insert the selection
503 void Buffer::insertStringAsLines(ParagraphList & pars,
504 pit_type & pit, pos_type & pos,
505 LyXFont const & fn, docstring const & str, bool autobreakrows)
509 // insert the string, don't insert doublespace
510 bool space_inserted = true;
511 for (docstring::const_iterator cit = str.begin();
512 cit != str.end(); ++cit) {
513 Paragraph & par = pars[pit];
515 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
516 breakParagraph(params(), pars, pit, pos,
517 par.layout()->isEnvironment());
520 space_inserted = true;
524 // do not insert consecutive spaces if !free_spacing
525 } else if ((*cit == ' ' || *cit == '\t') &&
526 space_inserted && !par.isFreeSpacing()) {
528 } else if (*cit == '\t') {
529 if (!par.isFreeSpacing()) {
530 // tabs are like spaces here
531 par.insertChar(pos, ' ', font);
533 space_inserted = true;
535 const pos_type n = 8 - pos % 8;
536 for (pos_type i = 0; i < n; ++i) {
537 par.insertChar(pos, ' ', font);
540 space_inserted = true;
542 /* FIXME: not needed anymore?
543 } else if (!isPrintable(*cit)) {
544 // Ignore unprintables
548 // just insert the character
549 par.insertChar(pos, *cit, font);
551 space_inserted = (*cit == ' ');
558 bool Buffer::readFile(string const & filename)
560 // Check if the file is compressed.
561 string const format = getFormatFromContents(filename);
562 if (format == "gzip" || format == "zip" || format == "compress") {
563 params().compressed = true;
566 // remove dummy empty par
567 paragraphs().clear();
569 lex.setFile(filename);
570 if (!readFile(lex, filename))
573 // After we have read a file, we must ensure that the buffer
574 // language is set and used in the gui.
575 // If you know of a better place to put this, please tell me. (Lgb)
576 updateDocLang(params().language);
582 bool Buffer::fully_loaded() const
584 return pimpl_->file_fully_loaded;
588 void Buffer::fully_loaded(bool const value)
590 pimpl_->file_fully_loaded = value;
594 bool Buffer::readFile(LyXLex & lex, string const & filename)
596 BOOST_ASSERT(!filename.empty());
599 Alert::error(_("Document could not be read"),
600 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
605 string const token(lex.getString());
608 Alert::error(_("Document could not be read"),
609 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
613 // the first token _must_ be...
614 if (token != "\\lyxformat") {
615 lyxerr << "Token: " << token << endl;
617 Alert::error(_("Document format failure"),
618 bformat(_("%1$s is not a LyX document."),
619 lyx::from_utf8(filename)));
624 string tmp_format = lex.getString();
625 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
626 // if present remove ".," from string.
627 string::size_type dot = tmp_format.find_first_of(".,");
628 //lyxerr << " dot found at " << dot << endl;
629 if (dot != string::npos)
630 tmp_format.erase(dot, 1);
631 int const file_format = convert<int>(tmp_format);
632 //lyxerr << "format: " << file_format << endl;
634 if (file_format != LYX_FORMAT) {
635 string const tmpfile = tempName();
636 if (tmpfile.empty()) {
637 Alert::error(_("Conversion failed"),
638 bformat(_("%1$s is from an earlier"
639 " version of LyX, but a temporary"
640 " file for converting it could"
642 lyx::from_utf8(filename)));
645 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
646 if (lyx2lyx.empty()) {
647 Alert::error(_("Conversion script not found"),
648 bformat(_("%1$s is from an earlier"
649 " version of LyX, but the"
650 " conversion script lyx2lyx"
651 " could not be found."),
652 lyx::from_utf8(filename)));
655 ostringstream command;
656 command << os::python() << ' ' << quoteName(lyx2lyx)
657 << " -t " << convert<string>(LYX_FORMAT)
658 << " -o " << quoteName(tmpfile) << ' '
659 << quoteName(filename);
660 string const command_str = command.str();
662 lyxerr[Debug::INFO] << "Running '"
663 << command_str << '\''
666 cmd_ret const ret = runCommand(command_str);
667 if (ret.first != 0) {
668 Alert::error(_("Conversion script failed"),
669 bformat(_("%1$s is from an earlier version"
670 " of LyX, but the lyx2lyx script"
671 " failed to convert it."),
672 lyx::from_utf8(filename)));
675 bool const ret = readFile(tmpfile);
676 // Do stuff with tmpfile name and buffer name here.
682 if (readDocument(lex)) {
683 Alert::error(_("Document format failure"),
684 bformat(_("%1$s ended unexpectedly, which means"
685 " that it is probably corrupted."),
686 lyx::from_utf8(filename)));
689 //lyxerr << "removing " << MacroTable::localMacros().size()
690 // << " temporary macro entries" << endl;
691 //MacroTable::localMacros().clear();
693 pimpl_->file_fully_loaded = true;
698 // Should probably be moved to somewhere else: BufferView? LyXView?
699 bool Buffer::save() const
701 // We don't need autosaves in the immediate future. (Asger)
702 resetAutosaveTimers();
706 if (lyxrc.make_backup) {
707 s = fileName() + '~';
708 if (!lyxrc.backupdir_path.empty())
709 s = addName(lyxrc.backupdir_path,
710 subst(os::internal_path(s),'/','!'));
712 // It might very well be that this variant is just
713 // good enough. (Lgb)
714 // But to use this we need fs::copy_file to actually do a copy,
715 // even when the target file exists. (Lgb)
717 fs::copy_file(fileName(), s, false);
719 catch (fs::filesystem_error const & fe) {
720 Alert::error(_("Backup failure"),
721 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
722 "Please check if the directory exists and is writeable."),
723 lyx::from_utf8(fs::path(s).branch_path().native_directory_string())));
724 lyxerr[Debug::DEBUG] << "Fs error: "
725 << fe.what() << endl;
729 if (writeFile(fileName())) {
731 removeAutosaveFile(fileName());
733 // Saving failed, so backup is not backup
734 if (lyxrc.make_backup)
735 rename(s, fileName());
742 bool Buffer::writeFile(string const & fname) const
744 if (pimpl_->read_only && fname == fileName())
749 if (params().compressed) {
750 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
754 retval = do_writeFile(ofs);
756 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
760 retval = do_writeFile(ofs);
767 bool Buffer::do_writeFile(ostream & ofs) const
770 // Use the standard "C" locale for file output.
771 ofs.imbue(std::locale::classic());
774 // The top of the file should not be written by params().
776 // write out a comment in the top of the file
777 ofs << "#LyX " << lyx_version
778 << " created this file. For more info see http://www.lyx.org/\n"
779 << "\\lyxformat " << LYX_FORMAT << "\n"
780 << "\\begin_document\n";
782 // now write out the buffer parameters.
783 ofs << "\\begin_header\n";
784 params().writeFile(ofs);
785 ofs << "\\end_header\n";
788 ofs << "\n\\begin_body\n";
789 text().write(*this, ofs);
790 ofs << "\n\\end_body\n";
792 // Write marker that shows file is complete
793 ofs << "\\end_document" << endl;
795 // Shouldn't really be needed....
798 // how to check if close went ok?
799 // Following is an attempt... (BE 20001011)
801 // good() returns false if any error occured, including some
803 // bad() returns true if something bad happened in the buffer,
804 // which should include file system full errors.
809 lyxerr << "File was not closed properly." << endl;
816 void Buffer::makeLaTeXFile(string const & fname,
817 string const & original_path,
818 OutputParams const & runparams,
819 bool output_preamble, bool output_body)
821 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
824 if (!openFileWrite(ofs, fname))
827 writeLaTeXSource(ofs, original_path,
828 runparams, output_preamble, output_body);
832 lyxerr << "File '" << fname << "' was not closed properly." << endl;
836 void Buffer::writeLaTeXSource(ostream & os,
837 string const & original_path,
838 OutputParams const & runparams_in,
839 bool const output_preamble, bool const output_body)
841 OutputParams runparams = runparams_in;
843 // validate the buffer.
844 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
845 LaTeXFeatures features(*this, params(), runparams);
847 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
851 // The starting paragraph of the coming rows is the
852 // first paragraph of the document. (Asger)
853 texrow().start(paragraphs().begin()->id(), 0);
855 if (output_preamble && runparams.nice) {
856 os << "%% LyX " << lyx_version << " created this file. "
857 "For more info, see http://www.lyx.org/.\n"
858 "%% Do not edit unless you really know what "
863 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
864 // There are a few differences between nice LaTeX and usual files:
865 // usual is \batchmode and has a
866 // special input@path to allow the including of figures
867 // with either \input or \includegraphics (what figinsets do).
868 // input@path is set when the actual parameter
869 // original_path is set. This is done for usual tex-file, but not
870 // for nice-latex-file. (Matthias 250696)
871 // Note that input@path is only needed for something the user does
872 // in the preamble, included .tex files or ERT, files included by
873 // LyX work without it.
874 if (output_preamble) {
875 if (!runparams.nice) {
876 // code for usual, NOT nice-latex-file
877 os << "\\batchmode\n"; // changed
881 if (!original_path.empty()) {
882 string const inputpath = latex_path(original_path);
883 os << "\\makeatletter\n"
884 << "\\def\\input@path{{"
885 << inputpath << "/}}\n"
886 << "\\makeatother\n";
892 // Write the preamble
893 runparams.use_babel = params().writeLaTeX(os, features, texrow());
899 os << "\\begin{document}\n";
902 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
904 if (!lyxrc.language_auto_begin) {
905 os << subst(lyxrc.language_command_begin, "$$lang",
906 params().language->babel())
911 // if we are doing a real file with body, even if this is the
912 // child of some other buffer, let's cut the link here.
913 // This happens for example if only a child document is printed.
914 string save_parentname;
915 if (output_preamble) {
916 save_parentname = params().parentname;
917 params().parentname.erase();
921 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
923 // Restore the parenthood if needed
925 params().parentname = save_parentname;
927 // add this just in case after all the paragraphs
931 if (!lyxrc.language_auto_end) {
932 os << subst(lyxrc.language_command_end, "$$lang",
933 params().language->babel())
938 if (output_preamble) {
939 os << "\\end{document}\n";
942 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
944 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
948 // Just to be sure. (Asger)
951 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
952 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
957 bool Buffer::isLatex() const
959 return params().getLyXTextClass().outputType() == LATEX;
963 bool Buffer::isLiterate() const
965 return params().getLyXTextClass().outputType() == LITERATE;
969 bool Buffer::isDocBook() const
971 return params().getLyXTextClass().outputType() == DOCBOOK;
975 void Buffer::makeDocBookFile(string const & fname,
976 OutputParams const & runparams,
977 bool const body_only)
979 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
982 if (!openFileWrite(ofs, fname))
985 writeDocBookSource(ofs, fname, runparams, body_only);
989 lyxerr << "File '" << fname << "' was not closed properly." << endl;
993 void Buffer::writeDocBookSource(ostream & os, string const & fname,
994 OutputParams const & runparams,
995 bool const only_body)
997 LaTeXFeatures features(*this, params(), runparams);
1002 LyXTextClass const & tclass = params().getLyXTextClass();
1003 string const & top_element = tclass.latexname();
1006 if (runparams.flavor == OutputParams::XML)
1007 os << "<?xml version=\"1.0\" encoding=\""
1008 << params().language->encoding()->name() << "\"?>\n";
1010 os << "<!DOCTYPE " << top_element << " ";
1012 if (! tclass.class_header().empty()) os << tclass.class_header();
1013 else if (runparams.flavor == OutputParams::XML)
1014 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1015 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1017 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1019 string preamble = params().preamble;
1020 if (runparams.flavor != OutputParams::XML ) {
1021 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1022 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1023 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1024 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1027 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1029 preamble += features.getIncludedFiles(name);
1030 preamble += features.getLyXSGMLEntities();
1032 if (!preamble.empty()) {
1033 os << "\n [ " << preamble << " ]";
1038 string top = top_element;
1040 if (runparams.flavor == OutputParams::XML)
1041 top += params().language->code();
1043 top += params().language->code().substr(0,2);
1046 if (!params().options.empty()) {
1048 top += params().options;
1051 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1052 << " file was created by LyX " << lyx_version
1053 << "\n See http://www.lyx.org/ for more information -->\n";
1055 params().getLyXTextClass().counters().reset();
1057 sgml::openTag(os, top);
1059 docbookParagraphs(paragraphs(), *this, os, runparams);
1060 sgml::closeTag(os, top_element);
1064 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1065 // Other flags: -wall -v0 -x
1066 int Buffer::runChktex()
1070 // get LaTeX-Filename
1071 string const name = getLatexName();
1072 string const path = temppath();
1073 string const org_path = filePath();
1075 lyx::support::Path p(path); // path to LaTeX file
1076 message(_("Running chktex..."));
1078 // Generate the LaTeX file if neccessary
1079 OutputParams runparams;
1080 runparams.flavor = OutputParams::LATEX;
1081 runparams.nice = false;
1082 makeLaTeXFile(name, org_path, runparams);
1085 Chktex chktex(lyxrc.chktex_command, name, filePath());
1086 int const res = chktex.run(terr); // run chktex
1089 Alert::error(_("chktex failure"),
1090 _("Could not run chktex successfully."));
1091 } else if (res > 0) {
1092 // Fill-in the error list with the TeX errors
1093 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1104 void Buffer::validate(LaTeXFeatures & features) const
1106 LyXTextClass const & tclass = params().getLyXTextClass();
1108 if (features.isAvailable("dvipost") && params().tracking_changes
1109 && params().output_changes)
1110 features.require("dvipost");
1112 // AMS Style is at document level
1113 if (params().use_amsmath == BufferParams::AMS_ON
1114 || tclass.provides(LyXTextClass::amsmath))
1115 features.require("amsmath");
1117 for_each(paragraphs().begin(), paragraphs().end(),
1118 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1120 // the bullet shapes are buffer level not paragraph level
1121 // so they are tested here
1122 for (int i = 0; i < 4; ++i) {
1123 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1124 int const font = params().user_defined_bullet(i).getFont();
1126 int const c = params()
1127 .user_defined_bullet(i)
1134 features.require("latexsym");
1136 } else if (font == 1) {
1137 features.require("amssymb");
1138 } else if ((font >= 2 && font <= 5)) {
1139 features.require("pifont");
1144 if (lyxerr.debugging(Debug::LATEX)) {
1145 features.showStruct();
1150 void Buffer::getLabelList(vector<string> & list) const
1152 /// if this is a child document and the parent is already loaded
1153 /// Use the parent's list instead [ale990407]
1154 Buffer const * tmp = getMasterBuffer();
1156 lyxerr << "getMasterBuffer() failed!" << endl;
1160 tmp->getLabelList(list);
1164 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1165 it.nextInset()->getLabelList(*this, list);
1169 // This is also a buffer property (ale)
1170 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1173 /// if this is a child document and the parent is already loaded
1174 /// use the parent's list instead [ale990412]
1175 Buffer const * tmp = getMasterBuffer();
1178 tmp->fillWithBibKeys(keys);
1182 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1183 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1184 InsetBibtex const & inset =
1185 dynamic_cast<InsetBibtex const &>(*it);
1186 inset.fillWithBibKeys(*this, keys);
1187 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1188 InsetInclude const & inset =
1189 dynamic_cast<InsetInclude const &>(*it);
1190 inset.fillWithBibKeys(*this, keys);
1191 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1192 InsetBibitem const & inset =
1193 dynamic_cast<InsetBibitem const &>(*it);
1194 string const key = inset.getContents();
1195 string const opt = inset.getOptions();
1196 string const ref; // = pit->asString(this, false);
1197 string const info = opt + "TheBibliographyRef" + ref;
1198 keys.push_back(pair<string, string>(key, info));
1204 void Buffer::updateBibfilesCache()
1206 // if this is a child document and the parent is already loaded
1207 // update the parent's cache instead
1208 Buffer * tmp = getMasterBuffer();
1211 tmp->updateBibfilesCache();
1215 bibfilesCache_.clear();
1216 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1217 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1218 InsetBibtex const & inset =
1219 dynamic_cast<InsetBibtex const &>(*it);
1220 vector<string> const bibfiles = inset.getFiles(*this);
1221 bibfilesCache_.insert(bibfilesCache_.end(),
1224 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1225 InsetInclude & inset =
1226 dynamic_cast<InsetInclude &>(*it);
1227 inset.updateBibfilesCache(*this);
1228 vector<string> const & bibfiles =
1229 inset.getBibfilesCache(*this);
1230 bibfilesCache_.insert(bibfilesCache_.end(),
1238 vector<string> const & Buffer::getBibfilesCache() const
1240 // if this is a child document and the parent is already loaded
1241 // use the parent's cache instead
1242 Buffer const * tmp = getMasterBuffer();
1245 return tmp->getBibfilesCache();
1247 return bibfilesCache_;
1251 bool Buffer::isDepClean(string const & name) const
1253 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1254 if (it == pimpl_->dep_clean.end())
1260 void Buffer::markDepClean(string const & name)
1262 pimpl_->dep_clean[name] = true;
1266 bool Buffer::dispatch(string const & command, bool * result)
1268 return dispatch(lyxaction.lookupFunc(command), result);
1272 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1274 bool dispatched = true;
1276 switch (func.action) {
1277 case LFUN_BUFFER_EXPORT: {
1278 bool const tmp = Exporter::Export(this, lyx::to_utf8(func.argument()), false);
1291 void Buffer::changeLanguage(Language const * from, Language const * to)
1296 // Take care of l10n/i18n
1299 for_each(par_iterator_begin(),
1301 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1303 text().current_font.setLanguage(to);
1304 text().real_current_font.setLanguage(to);
1308 void Buffer::updateDocLang(Language const * nlang)
1310 BOOST_ASSERT(nlang);
1312 pimpl_->messages.reset(new Messages(nlang->code()));
1314 updateLabels(*this);
1318 bool Buffer::isMultiLingual() const
1320 ParConstIterator end = par_iterator_end();
1321 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1322 if (it->isMultiLingual(params()))
1329 ParIterator Buffer::getParFromID(int const id) const
1331 ParConstIterator it = par_iterator_begin();
1332 ParConstIterator const end = par_iterator_end();
1335 // John says this is called with id == -1 from undo
1336 lyxerr << "getParFromID(), id: " << id << endl;
1340 for (; it != end; ++it)
1348 bool Buffer::hasParWithID(int const id) const
1350 ParConstIterator const it = getParFromID(id);
1351 return it != par_iterator_end();
1355 ParIterator Buffer::par_iterator_begin()
1357 return ::par_iterator_begin(inset());
1361 ParIterator Buffer::par_iterator_end()
1363 return ::par_iterator_end(inset());
1367 ParConstIterator Buffer::par_iterator_begin() const
1369 return ::par_const_iterator_begin(inset());
1373 ParConstIterator Buffer::par_iterator_end() const
1375 return ::par_const_iterator_end(inset());
1379 Language const * Buffer::getLanguage() const
1381 return params().language;
1385 docstring const Buffer::B_(string const & l10n) const
1387 if (pimpl_->messages.get()) {
1388 return pimpl_->messages->get(l10n);
1395 bool Buffer::isClean() const
1397 return pimpl_->lyx_clean;
1401 bool Buffer::isBakClean() const
1403 return pimpl_->bak_clean;
1407 void Buffer::markClean() const
1409 if (!pimpl_->lyx_clean) {
1410 pimpl_->lyx_clean = true;
1413 // if the .lyx file has been saved, we don't need an
1415 pimpl_->bak_clean = true;
1419 void Buffer::markBakClean()
1421 pimpl_->bak_clean = true;
1425 void Buffer::setUnnamed(bool flag)
1427 pimpl_->unnamed = flag;
1431 bool Buffer::isUnnamed() const
1433 return pimpl_->unnamed;
1437 #ifdef WITH_WARNINGS
1438 #warning this function should be moved to buffer_pimpl.C
1440 void Buffer::markDirty()
1442 if (pimpl_->lyx_clean) {
1443 pimpl_->lyx_clean = false;
1446 pimpl_->bak_clean = false;
1448 DepClean::iterator it = pimpl_->dep_clean.begin();
1449 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1451 for (; it != end; ++it) {
1457 string const & Buffer::fileName() const
1459 return pimpl_->filename;
1463 string const & Buffer::filePath() const
1465 return params().filepath;
1469 bool Buffer::isReadonly() const
1471 return pimpl_->read_only;
1475 void Buffer::setParentName(string const & name)
1477 params().parentname = name;
1481 Buffer const * Buffer::getMasterBuffer() const
1483 if (!params().parentname.empty()
1484 && theApp->bufferList().exists(params().parentname)) {
1485 Buffer const * buf = theApp->bufferList().getBuffer(params().parentname);
1487 return buf->getMasterBuffer();
1494 Buffer * Buffer::getMasterBuffer()
1496 if (!params().parentname.empty()
1497 && theApp->bufferList().exists(params().parentname)) {
1498 Buffer * buf = theApp->bufferList().getBuffer(params().parentname);
1500 return buf->getMasterBuffer();
1507 MacroData const & Buffer::getMacro(std::string const & name) const
1509 return pimpl_->macros.get(name);
1513 bool Buffer::hasMacro(string const & name) const
1515 return pimpl_->macros.has(name);
1519 void Buffer::insertMacro(string const & name, MacroData const & data)
1521 MacroTable::globalMacros().insert(name, data);
1522 pimpl_->macros.insert(name, data);
1526 void Buffer::buildMacros()
1528 // Start with global table.
1529 pimpl_->macros = MacroTable::globalMacros();
1532 ParagraphList const & pars = text().paragraphs();
1533 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1534 //lyxerr << "searching main par " << i
1535 // << " for macro definitions" << std::endl;
1536 InsetList const & insets = pars[i].insetlist;
1537 InsetList::const_iterator it = insets.begin();
1538 InsetList::const_iterator end = insets.end();
1539 for ( ; it != end; ++it) {
1540 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1541 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1542 MathMacroTemplate const & mac
1543 = static_cast<MathMacroTemplate const &>(*it->inset);
1544 insertMacro(mac.name(), mac.asMacroData());
1551 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1558 void Buffer::changeRefsIfUnique(string const & from, string const & to)
1560 // Check if the label 'from' appears more than once
1561 vector<string> labels;
1562 getLabelList(labels);
1564 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1567 InsetBase::Code code = InsetBase::REF_CODE;
1569 ParIterator it = par_iterator_begin();
1570 ParIterator end = par_iterator_end();
1571 for ( ; it != end; ++it) {
1572 bool changed_inset = false;
1573 for (InsetList::iterator it2 = it->insetlist.begin();
1574 it2 != it->insetlist.end(); ++it2) {
1575 if (it2->inset->lyxCode() == code) {
1576 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1577 if (inset->getContents() == from) {
1578 inset->setContents(to);
1579 //inset->setButtonLabel();
1580 changed_inset = true;
1588 void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1590 OutputParams runparams;
1591 runparams.nice = true;
1592 runparams.flavor = OutputParams::LATEX;
1593 runparams.linelen = lyxrc.ascii_linelen;
1594 // No side effect of file copying and image conversion
1595 runparams.dryrun = true;
1598 os << "% Preview source code\n\n";
1600 writeLaTeXSource(os, filePath(), runparams, true, true);
1602 writeDocBookSource(os, fileName(), runparams, false);
1604 runparams.par_begin = par_begin;
1605 runparams.par_end = par_end;
1606 if (par_begin + 1 == par_end)
1607 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1609 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1610 // output paragraphs
1613 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1615 docbookParagraphs(paragraphs(), *this, os, runparams);
1620 ErrorList const & Buffer::errorList(string const & type) const
1622 static ErrorList const emptyErrorList;
1623 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1624 if (I == errorLists_.end())
1625 return emptyErrorList;
1631 ErrorList & Buffer::errorList(string const & type)
1633 return errorLists_[type];