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"
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"
49 #include "TocBackend.h"
53 #include "insets/insetbibitem.h"
54 #include "insets/insetbibtex.h"
55 #include "insets/insetinclude.h"
56 #include "insets/insettext.h"
58 #include "mathed/MathMacroTemplate.h"
59 #include "mathed/MathMacroTable.h"
60 #include "mathed/MathSupport.h"
62 #include "frontends/Alert.h"
64 #include "graphics/Previews.h"
66 #include "support/types.h"
67 #include "support/lyxalgo.h"
68 #include "support/filetools.h"
69 #include "support/fs_extras.h"
70 #include "support/lyxlib.h"
71 #include "support/os.h"
72 #include "support/path.h"
73 #include "support/textutils.h"
74 #include "support/convert.h"
76 #include <boost/iostreams/filtering_stream.hpp>
77 #include <boost/iostreams/filter/gzip.hpp>
78 #include <boost/iostreams/device/file.hpp>
79 #include <boost/bind.hpp>
80 #include <boost/filesystem/exception.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>
97 using support::addName;
98 using support::bformat;
99 using support::changeExtension;
100 using support::cmd_ret;
101 using support::createBufferTmpDir;
102 using support::destroyDir;
103 using support::FileName;
104 using support::getFormatFromContents;
105 using support::libFileSearch;
106 using support::latex_path;
107 using support::ltrim;
108 using support::makeAbsPath;
109 using support::makeDisplayPath;
110 using support::makeLatexName;
111 using support::onlyFilename;
112 using support::onlyPath;
113 using support::quoteName;
114 using support::removeAutosaveFile;
115 using support::rename;
116 using support::runCommand;
117 using support::split;
118 using support::subst;
119 using support::tempName;
122 namespace Alert = frontend::Alert;
123 namespace os = support::os;
124 namespace fs = boost::filesystem;
125 namespace io = boost::iostreams;
129 using std::make_pair;
134 using std::ostringstream;
144 int const LYX_FORMAT = 256;
149 typedef std::map<string, bool> DepClean;
154 Impl(Buffer & parent, FileName const & file, bool readonly);
156 limited_stack<Undo> undostack;
157 limited_stack<Undo> redostack;
163 /// need to regenerate .tex?
167 mutable bool lyx_clean;
169 /// is autosave needed?
170 mutable bool bak_clean;
172 /// is this a unnamed file (New...)?
178 /// name of the file the buffer is associated with.
181 boost::scoped_ptr<Messages> messages;
183 /** Set to true only when the file is fully loaded.
184 * Used to prevent the premature generation of previews
185 * and by the citation inset.
187 bool file_fully_loaded;
189 /// our LyXText that should be wrapped in an InsetText
196 TocBackend toc_backend;
200 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
201 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
202 filename(file), file_fully_loaded(false), inset(params),
205 inset.setAutoBreakRows(true);
206 lyxvc.buffer(&parent);
207 temppath = createBufferTmpDir();
208 params.filepath = onlyPath(file.absFilename());
209 // FIXME: And now do something if temppath == string(), because we
210 // assume from now on that temppath points to a valid temp dir.
211 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
215 Buffer::Buffer(string const & file, bool readonly)
216 : pimpl_(new Impl(*this, FileName(file), readonly))
218 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
224 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
225 // here the buffer should take care that it is
226 // saved properly, before it goes into the void.
230 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
231 Alert::warning(_("Could not remove temporary directory"),
232 bformat(_("Could not remove the temporary directory %1$s"),
233 from_utf8(temppath())));
236 // Remove any previewed LaTeX snippets associated with this buffer.
237 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 TocBackend & Buffer::tocBackend()
333 return pimpl_->toc_backend;
337 TocBackend const & Buffer::tocBackend() const
339 return pimpl_->toc_backend;
343 string const Buffer::getLatexName(bool const no_path) const
345 string const name = changeExtension(makeLatexName(fileName()), ".tex");
346 return no_path ? onlyFilename(name) : name;
350 pair<Buffer::LogType, string> const Buffer::getLogName() const
352 string const filename = getLatexName(false);
354 if (filename.empty())
355 return make_pair(Buffer::latexlog, string());
357 string const path = temppath();
359 FileName const fname(addName(temppath(),
360 onlyFilename(changeExtension(filename,
362 FileName const bname(
363 addName(path, onlyFilename(
364 changeExtension(filename,
365 formats.extension("literate") + ".out"))));
367 // If no Latex log or Build log is newer, show Build log
369 if (fs::exists(bname.toFilesystemEncoding()) &&
370 (!fs::exists(fname.toFilesystemEncoding()) ||
371 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
372 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
373 return make_pair(Buffer::buildlog, bname.absFilename());
375 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
376 return make_pair(Buffer::latexlog, fname.absFilename());
380 void Buffer::setReadonly(bool const flag)
382 if (pimpl_->read_only != flag) {
383 pimpl_->read_only = flag;
389 void Buffer::setFileName(string const & newfile)
391 pimpl_->filename = makeAbsPath(newfile);
392 params().filepath = onlyPath(pimpl_->filename.absFilename());
393 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
398 // We'll remove this later. (Lgb)
401 void unknownClass(string const & unknown)
403 Alert::warning(_("Unknown document class"),
404 bformat(_("Using the default document class, because the "
405 "class %1$s is unknown."), from_utf8(unknown)));
411 int Buffer::readHeader(LyXLex & lex)
413 int unknown_tokens = 0;
415 int begin_header_line = -1;
417 // Initialize parameters that may be/go lacking in header:
418 params().branchlist().clear();
419 params().preamble.erase();
420 params().options.erase();
421 params().float_placement.erase();
422 params().paperwidth.erase();
423 params().paperheight.erase();
424 params().leftmargin.erase();
425 params().rightmargin.erase();
426 params().topmargin.erase();
427 params().bottommargin.erase();
428 params().headheight.erase();
429 params().headsep.erase();
430 params().footskip.erase();
432 ErrorList & errorList = errorLists_["Parse"];
436 string const token = lex.getString();
441 if (token == "\\end_header")
445 if (token == "\\begin_header") {
446 begin_header_line = line;
450 lyxerr[Debug::PARSER] << "Handling document header token: `"
451 << token << '\'' << endl;
453 string unknown = params().readToken(lex, token);
454 if (!unknown.empty()) {
455 if (unknown[0] != '\\' && token == "\\textclass") {
456 unknownClass(unknown);
459 docstring const s = bformat(_("Unknown token: "
463 errorList.push_back(ErrorItem(_("Document header error"),
468 if (begin_header_line) {
469 docstring const s = _("\\begin_header is missing");
470 errorList.push_back(ErrorItem(_("Document header error"),
474 return unknown_tokens;
479 // changed to be public and have one parameter
480 // Returns false if "\end_document" is not read (Asger)
481 bool Buffer::readDocument(LyXLex & lex)
483 ErrorList & errorList = errorLists_["Parse"];
487 string const token = lex.getString();
488 if (token != "\\begin_document") {
489 docstring const s = _("\\begin_document is missing");
490 errorList.push_back(ErrorItem(_("Document header error"),
494 // we are reading in a brand new document
495 BOOST_ASSERT(paragraphs().empty());
498 if (!params().getLyXTextClass().load(filePath())) {
499 string theclass = params().getLyXTextClass().name();
500 Alert::error(_("Can't load document class"), bformat(
501 _("Using the default document class, because the "
502 "class %1$s could not be loaded."), from_utf8(theclass)));
503 params().textclass = 0;
506 bool const res = text().read(*this, lex, errorList);
507 for_each(text().paragraphs().begin(),
508 text().paragraphs().end(),
509 bind(&Paragraph::setInsetOwner, _1, &inset()));
510 updateBibfilesCache();
516 // needed to insert the selection
517 void Buffer::insertStringAsLines(ParagraphList & pars,
518 pit_type & pit, pos_type & pos,
519 LyXFont const & fn, docstring const & str, bool autobreakrows)
523 // insert the string, don't insert doublespace
524 bool space_inserted = true;
525 for (docstring::const_iterator cit = str.begin();
526 cit != str.end(); ++cit) {
527 Paragraph & par = pars[pit];
529 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
530 breakParagraph(params(), pars, pit, pos,
531 par.layout()->isEnvironment());
534 space_inserted = true;
538 // do not insert consecutive spaces if !free_spacing
539 } else if ((*cit == ' ' || *cit == '\t') &&
540 space_inserted && !par.isFreeSpacing()) {
542 } else if (*cit == '\t') {
543 if (!par.isFreeSpacing()) {
544 // tabs are like spaces here
545 par.insertChar(pos, ' ', font, params().trackChanges);
547 space_inserted = true;
549 const pos_type n = 8 - pos % 8;
550 for (pos_type i = 0; i < n; ++i) {
551 par.insertChar(pos, ' ', font, params().trackChanges);
554 space_inserted = true;
556 } else if (!isPrintable(*cit)) {
557 // Ignore unprintables
560 // just insert the character
561 par.insertChar(pos, *cit, font, params().trackChanges);
563 space_inserted = (*cit == ' ');
570 bool Buffer::readFile(FileName const & filename)
572 // Check if the file is compressed.
573 string const format = getFormatFromContents(filename);
574 if (format == "gzip" || format == "zip" || format == "compress") {
575 params().compressed = true;
578 // remove dummy empty par
579 paragraphs().clear();
581 lex.setFile(filename);
582 if (!readFile(lex, filename))
585 // After we have read a file, we must ensure that the buffer
586 // language is set and used in the gui.
587 // If you know of a better place to put this, please tell me. (Lgb)
588 updateDocLang(params().language);
594 bool Buffer::fully_loaded() const
596 return pimpl_->file_fully_loaded;
600 void Buffer::fully_loaded(bool const value)
602 pimpl_->file_fully_loaded = value;
606 bool Buffer::readFile(LyXLex & lex, FileName const & filename)
608 BOOST_ASSERT(!filename.empty());
611 Alert::error(_("Document could not be read"),
612 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
617 string const token(lex.getString());
620 Alert::error(_("Document could not be read"),
621 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
625 // the first token _must_ be...
626 if (token != "\\lyxformat") {
627 lyxerr << "Token: " << token << endl;
629 Alert::error(_("Document format failure"),
630 bformat(_("%1$s is not a LyX document."),
631 from_utf8(filename.absFilename())));
636 string tmp_format = lex.getString();
637 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
638 // if present remove ".," from string.
639 string::size_type dot = tmp_format.find_first_of(".,");
640 //lyxerr << " dot found at " << dot << endl;
641 if (dot != string::npos)
642 tmp_format.erase(dot, 1);
643 int const file_format = convert<int>(tmp_format);
644 //lyxerr << "format: " << file_format << endl;
646 if (file_format != LYX_FORMAT) {
647 FileName const tmpfile(tempName());
648 if (tmpfile.empty()) {
649 Alert::error(_("Conversion failed"),
650 bformat(_("%1$s is from an earlier"
651 " version of LyX, but a temporary"
652 " file for converting it could"
654 from_utf8(filename.absFilename())));
657 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
658 if (lyx2lyx.empty()) {
659 Alert::error(_("Conversion script not found"),
660 bformat(_("%1$s is from an earlier"
661 " version of LyX, but the"
662 " conversion script lyx2lyx"
663 " could not be found."),
664 from_utf8(filename.absFilename())));
667 ostringstream command;
668 command << os::python()
669 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
670 << " -t " << convert<string>(LYX_FORMAT)
671 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
672 << ' ' << quoteName(filename.toFilesystemEncoding());
673 string const command_str = command.str();
675 lyxerr[Debug::INFO] << "Running '"
676 << command_str << '\''
679 cmd_ret const ret = runCommand(command_str);
680 if (ret.first != 0) {
681 Alert::error(_("Conversion script failed"),
682 bformat(_("%1$s is from an earlier version"
683 " of LyX, but the lyx2lyx script"
684 " failed to convert it."),
685 from_utf8(filename.absFilename())));
688 bool const ret = readFile(tmpfile);
689 // Do stuff with tmpfile name and buffer name here.
695 if (readDocument(lex)) {
696 Alert::error(_("Document format failure"),
697 bformat(_("%1$s ended unexpectedly, which means"
698 " that it is probably corrupted."),
699 from_utf8(filename.absFilename())));
702 //lyxerr << "removing " << MacroTable::localMacros().size()
703 // << " temporary macro entries" << endl;
704 //MacroTable::localMacros().clear();
706 pimpl_->file_fully_loaded = true;
711 // Should probably be moved to somewhere else: BufferView? LyXView?
712 bool Buffer::save() const
714 // We don't need autosaves in the immediate future. (Asger)
715 resetAutosaveTimers();
717 // make a backup if the file already exists
719 if (lyxrc.make_backup && fs::exists(pimpl_->filename.toFilesystemEncoding())) {
720 s = fileName() + '~';
721 if (!lyxrc.backupdir_path.empty())
722 s = addName(lyxrc.backupdir_path,
723 subst(os::internal_path(s),'/','!'));
725 // It might very well be that this variant is just
726 // good enough. (Lgb)
727 // But to use this we need fs::copy_file to actually do a copy,
728 // even when the target file exists. (Lgb)
730 fs::copy_file(pimpl_->filename.toFilesystemEncoding(), s, false);
732 catch (fs::filesystem_error const & fe) {
733 Alert::error(_("Backup failure"),
734 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
735 "Please check if the directory exists and is writeable."),
736 from_utf8(fs::path(s).branch_path().native_directory_string())));
737 lyxerr[Debug::DEBUG] << "Fs error: "
738 << fe.what() << endl;
742 if (writeFile(pimpl_->filename)) {
744 removeAutosaveFile(fileName());
746 // Saving failed, so backup is not backup
747 if (lyxrc.make_backup)
748 rename(FileName(s), pimpl_->filename);
755 bool Buffer::writeFile(FileName const & fname) const
757 if (pimpl_->read_only && fname == pimpl_->filename)
762 if (params().compressed) {
763 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname.toFilesystemEncoding()));
767 retval = do_writeFile(ofs);
769 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
773 retval = do_writeFile(ofs);
780 bool Buffer::do_writeFile(ostream & ofs) const
783 // Use the standard "C" locale for file output.
784 ofs.imbue(std::locale::classic());
787 // The top of the file should not be written by params().
789 // write out a comment in the top of the file
790 ofs << "#LyX " << lyx_version
791 << " created this file. For more info see http://www.lyx.org/\n"
792 << "\\lyxformat " << LYX_FORMAT << "\n"
793 << "\\begin_document\n";
795 // now write out the buffer parameters.
796 ofs << "\\begin_header\n";
797 params().writeFile(ofs);
798 ofs << "\\end_header\n";
801 ofs << "\n\\begin_body\n";
802 text().write(*this, ofs);
803 ofs << "\n\\end_body\n";
805 // Write marker that shows file is complete
806 ofs << "\\end_document" << endl;
808 // Shouldn't really be needed....
811 // how to check if close went ok?
812 // Following is an attempt... (BE 20001011)
814 // good() returns false if any error occured, including some
816 // bad() returns true if something bad happened in the buffer,
817 // which should include file system full errors.
822 lyxerr << "File was not closed properly." << endl;
829 bool Buffer::makeLaTeXFile(FileName const & fname,
830 string const & original_path,
831 OutputParams const & runparams,
832 bool output_preamble, bool output_body)
834 string const encoding = params().encoding().iconvName();
835 lyxerr[Debug::LATEX] << "makeLaTeXFile encoding: "
836 << encoding << "..." << endl;
838 odocfstream ofs(encoding);
839 if (!openFileWrite(ofs, fname))
843 writeLaTeXSource(ofs, original_path,
844 runparams, output_preamble, output_body);
846 catch (iconv_codecvt_facet_exception &) {
847 Alert::error(_("Encoding error"),
848 _("Some characters of your document are not "
849 "representable in the chosen encoding.\n"
850 "Changing the document encoding to utf8 could help."));
856 lyxerr << "File '" << fname << "' was not closed properly." << endl;
857 Alert::error(_("Error closing file"),
858 _("The output file could not be closed properly.\n"
859 " Probably some characters of your document are not "
860 "representable in the chosen encoding.\n"
861 "Changing the document encoding to utf8 could help."));
868 void Buffer::writeLaTeXSource(odocstream & os,
869 string const & original_path,
870 OutputParams const & runparams_in,
871 bool const output_preamble, bool const output_body)
873 OutputParams runparams = runparams_in;
875 // validate the buffer.
876 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
877 LaTeXFeatures features(*this, params(), runparams);
879 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
883 // The starting paragraph of the coming rows is the
884 // first paragraph of the document. (Asger)
885 texrow().start(paragraphs().begin()->id(), 0);
887 if (output_preamble && runparams.nice) {
888 os << "%% LyX " << lyx_version << " created this file. "
889 "For more info, see http://www.lyx.org/.\n"
890 "%% Do not edit unless you really know what "
895 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
896 // There are a few differences between nice LaTeX and usual files:
897 // usual is \batchmode and has a
898 // special input@path to allow the including of figures
899 // with either \input or \includegraphics (what figinsets do).
900 // input@path is set when the actual parameter
901 // original_path is set. This is done for usual tex-file, but not
902 // for nice-latex-file. (Matthias 250696)
903 // Note that input@path is only needed for something the user does
904 // in the preamble, included .tex files or ERT, files included by
905 // LyX work without it.
906 if (output_preamble) {
907 if (!runparams.nice) {
908 // code for usual, NOT nice-latex-file
909 os << "\\batchmode\n"; // changed
913 if (!original_path.empty()) {
915 // We don't know the encoding of inputpath
916 docstring const inputpath = from_utf8(latex_path(original_path));
917 os << "\\makeatletter\n"
918 << "\\def\\input@path{{"
919 << inputpath << "/}}\n"
920 << "\\makeatother\n";
926 // Write the preamble
927 runparams.use_babel = params().writeLaTeX(os, features, texrow());
933 os << "\\begin{document}\n";
936 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
938 if (!lyxrc.language_auto_begin) {
940 os << from_utf8(subst(lyxrc.language_command_begin,
942 params().language->babel()))
947 // if we are doing a real file with body, even if this is the
948 // child of some other buffer, let's cut the link here.
949 // This happens for example if only a child document is printed.
950 string save_parentname;
951 if (output_preamble) {
952 save_parentname = params().parentname;
953 params().parentname.erase();
957 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
959 // Restore the parenthood if needed
961 params().parentname = save_parentname;
963 // add this just in case after all the paragraphs
967 if (!lyxrc.language_auto_end) {
968 os << from_utf8(subst(lyxrc.language_command_end,
970 params().language->babel()))
975 if (output_preamble) {
976 os << "\\end{document}\n";
979 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
981 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
985 // Just to be sure. (Asger)
988 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
989 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
994 bool Buffer::isLatex() const
996 return params().getLyXTextClass().outputType() == LATEX;
1000 bool Buffer::isLiterate() const
1002 return params().getLyXTextClass().outputType() == LITERATE;
1006 bool Buffer::isDocBook() const
1008 return params().getLyXTextClass().outputType() == DOCBOOK;
1012 void Buffer::makeDocBookFile(FileName const & fname,
1013 OutputParams const & runparams,
1014 bool const body_only)
1016 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
1020 if (!openFileWrite(ofs, fname))
1023 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1027 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1031 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1032 OutputParams const & runparams,
1033 bool const only_body)
1035 LaTeXFeatures features(*this, params(), runparams);
1040 LyXTextClass const & tclass = params().getLyXTextClass();
1041 string const top_element = tclass.latexname();
1044 if (runparams.flavor == OutputParams::XML)
1045 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1048 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1051 if (! tclass.class_header().empty())
1052 os << from_ascii(tclass.class_header());
1053 else if (runparams.flavor == OutputParams::XML)
1054 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1055 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1057 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1059 docstring preamble = from_utf8(params().preamble);
1060 if (runparams.flavor != OutputParams::XML ) {
1061 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1062 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1063 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1064 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1067 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1069 preamble += features.getIncludedFiles(name);
1070 preamble += features.getLyXSGMLEntities();
1072 if (!preamble.empty()) {
1073 os << "\n [ " << preamble << " ]";
1078 string top = top_element;
1080 if (runparams.flavor == OutputParams::XML)
1081 top += params().language->code();
1083 top += params().language->code().substr(0,2);
1086 if (!params().options.empty()) {
1088 top += params().options;
1091 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1092 << " file was created by LyX " << lyx_version
1093 << "\n See http://www.lyx.org/ for more information -->\n";
1095 params().getLyXTextClass().counters().reset();
1097 sgml::openTag(os, top);
1099 docbookParagraphs(paragraphs(), *this, os, runparams);
1100 sgml::closeTag(os, top_element);
1104 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1105 // Other flags: -wall -v0 -x
1106 int Buffer::runChktex()
1110 // get LaTeX-Filename
1111 string const name = getLatexName(false);
1112 string const path = temppath();
1113 string const org_path = filePath();
1115 support::Path p(path); // path to LaTeX file
1116 message(_("Running chktex..."));
1118 // Generate the LaTeX file if neccessary
1119 OutputParams runparams;
1120 runparams.flavor = OutputParams::LATEX;
1121 runparams.nice = false;
1122 makeLaTeXFile(FileName(name), org_path, runparams);
1125 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1126 int const res = chktex.run(terr); // run chktex
1129 Alert::error(_("chktex failure"),
1130 _("Could not run chktex successfully."));
1131 } else if (res > 0) {
1132 // Fill-in the error list with the TeX errors
1133 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1144 void Buffer::validate(LaTeXFeatures & features) const
1146 LyXTextClass const & tclass = params().getLyXTextClass();
1148 if (features.isAvailable("dvipost") && params().outputChanges)
1149 features.require("dvipost");
1151 // AMS Style is at document level
1152 if (params().use_amsmath == BufferParams::package_on
1153 || tclass.provides(LyXTextClass::amsmath))
1154 features.require("amsmath");
1155 if (params().use_esint == BufferParams::package_on)
1156 features.require("esint");
1158 for_each(paragraphs().begin(), paragraphs().end(),
1159 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1161 // the bullet shapes are buffer level not paragraph level
1162 // so they are tested here
1163 for (int i = 0; i < 4; ++i) {
1164 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1165 int const font = params().user_defined_bullet(i).getFont();
1167 int const c = params()
1168 .user_defined_bullet(i)
1175 features.require("latexsym");
1177 } else if (font == 1) {
1178 features.require("amssymb");
1179 } else if ((font >= 2 && font <= 5)) {
1180 features.require("pifont");
1185 if (lyxerr.debugging(Debug::LATEX)) {
1186 features.showStruct();
1191 void Buffer::getLabelList(vector<docstring> & list) const
1193 /// if this is a child document and the parent is already loaded
1194 /// Use the parent's list instead [ale990407]
1195 Buffer const * tmp = getMasterBuffer();
1197 lyxerr << "getMasterBuffer() failed!" << endl;
1201 tmp->getLabelList(list);
1205 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1206 it.nextInset()->getLabelList(*this, list);
1210 // This is also a buffer property (ale)
1211 void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
1214 /// if this is a child document and the parent is already loaded
1215 /// use the parent's list instead [ale990412]
1216 Buffer const * tmp = getMasterBuffer();
1219 tmp->fillWithBibKeys(keys);
1223 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1224 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1225 InsetBibtex const & inset =
1226 dynamic_cast<InsetBibtex const &>(*it);
1227 inset.fillWithBibKeys(*this, keys);
1228 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1229 InsetInclude const & inset =
1230 dynamic_cast<InsetInclude const &>(*it);
1231 inset.fillWithBibKeys(*this, keys);
1232 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1233 InsetBibitem const & inset =
1234 dynamic_cast<InsetBibitem const &>(*it);
1236 string const key = to_utf8(inset.getParam("key"));
1237 docstring const label = inset.getParam("label");
1238 docstring const ref; // = pit->asString(this, false);
1239 docstring const info = label + "TheBibliographyRef" + ref;
1240 keys.push_back(pair<string, docstring>(key, info));
1246 void Buffer::updateBibfilesCache()
1248 // if this is a child document and the parent is already loaded
1249 // update the parent's cache instead
1250 Buffer * tmp = getMasterBuffer();
1253 tmp->updateBibfilesCache();
1257 bibfilesCache_.clear();
1258 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1259 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1260 InsetBibtex const & inset =
1261 dynamic_cast<InsetBibtex const &>(*it);
1262 vector<FileName> const bibfiles = inset.getFiles(*this);
1263 bibfilesCache_.insert(bibfilesCache_.end(),
1266 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1267 InsetInclude & inset =
1268 dynamic_cast<InsetInclude &>(*it);
1269 inset.updateBibfilesCache(*this);
1270 vector<FileName> const & bibfiles =
1271 inset.getBibfilesCache(*this);
1272 bibfilesCache_.insert(bibfilesCache_.end(),
1280 vector<FileName> const & Buffer::getBibfilesCache() const
1282 // if this is a child document and the parent is already loaded
1283 // use the parent's cache instead
1284 Buffer const * tmp = getMasterBuffer();
1287 return tmp->getBibfilesCache();
1289 // We update the cache when first used instead of at loading time.
1290 if (bibfilesCache_.empty())
1291 const_cast<Buffer *>(this)->updateBibfilesCache();
1293 return bibfilesCache_;
1297 bool Buffer::isDepClean(string const & name) const
1299 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1300 if (it == pimpl_->dep_clean.end())
1306 void Buffer::markDepClean(string const & name)
1308 pimpl_->dep_clean[name] = true;
1312 bool Buffer::dispatch(string const & command, bool * result)
1314 return dispatch(lyxaction.lookupFunc(command), result);
1318 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1320 bool dispatched = true;
1322 switch (func.action) {
1323 case LFUN_BUFFER_EXPORT: {
1324 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1337 void Buffer::changeLanguage(Language const * from, Language const * to)
1342 // Take care of l10n/i18n
1345 for_each(par_iterator_begin(),
1347 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1349 text().current_font.setLanguage(to);
1350 text().real_current_font.setLanguage(to);
1354 void Buffer::updateDocLang(Language const * nlang)
1356 BOOST_ASSERT(nlang);
1358 pimpl_->messages.reset(new Messages(nlang->code()));
1362 bool Buffer::isMultiLingual() const
1364 ParConstIterator end = par_iterator_end();
1365 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1366 if (it->isMultiLingual(params()))
1373 ParIterator Buffer::getParFromID(int const id) const
1375 ParConstIterator it = par_iterator_begin();
1376 ParConstIterator const end = par_iterator_end();
1379 // John says this is called with id == -1 from undo
1380 lyxerr << "getParFromID(), id: " << id << endl;
1384 for (; it != end; ++it)
1392 bool Buffer::hasParWithID(int const id) const
1394 ParConstIterator const it = getParFromID(id);
1395 return it != par_iterator_end();
1399 ParIterator Buffer::par_iterator_begin()
1401 return lyx::par_iterator_begin(inset());
1405 ParIterator Buffer::par_iterator_end()
1407 return lyx::par_iterator_end(inset());
1411 ParConstIterator Buffer::par_iterator_begin() const
1413 return lyx::par_const_iterator_begin(inset());
1417 ParConstIterator Buffer::par_iterator_end() const
1419 return lyx::par_const_iterator_end(inset());
1423 Language const * Buffer::getLanguage() const
1425 return params().language;
1429 docstring const Buffer::B_(string const & l10n) const
1431 if (pimpl_->messages.get())
1432 return pimpl_->messages->get(l10n);
1438 docstring const Buffer::translateLabel(docstring const & label) const
1440 if (support::isAscii(label))
1441 // Probably standard layout, try to translate
1442 return B_(to_ascii(label));
1444 // This must be a user defined layout. We cannot translate
1445 // this, since gettext accepts only ascii keys.
1450 bool Buffer::isClean() const
1452 return pimpl_->lyx_clean;
1456 bool Buffer::isBakClean() const
1458 return pimpl_->bak_clean;
1462 void Buffer::markClean() const
1464 if (!pimpl_->lyx_clean) {
1465 pimpl_->lyx_clean = true;
1468 // if the .lyx file has been saved, we don't need an
1470 pimpl_->bak_clean = true;
1474 void Buffer::markBakClean()
1476 pimpl_->bak_clean = true;
1480 void Buffer::setUnnamed(bool flag)
1482 pimpl_->unnamed = flag;
1486 bool Buffer::isUnnamed() const
1488 return pimpl_->unnamed;
1492 #ifdef WITH_WARNINGS
1493 #warning this function should be moved to buffer_pimpl.C
1495 void Buffer::markDirty()
1497 if (pimpl_->lyx_clean) {
1498 pimpl_->lyx_clean = false;
1501 pimpl_->bak_clean = false;
1503 DepClean::iterator it = pimpl_->dep_clean.begin();
1504 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1506 for (; it != end; ++it)
1511 string const Buffer::fileName() const
1513 return pimpl_->filename.absFilename();
1517 string const & Buffer::filePath() const
1519 return params().filepath;
1523 bool Buffer::isReadonly() const
1525 return pimpl_->read_only;
1529 void Buffer::setParentName(string const & name)
1531 params().parentname = name;
1535 Buffer const * Buffer::getMasterBuffer() const
1537 if (!params().parentname.empty()
1538 && theBufferList().exists(params().parentname)) {
1539 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1541 return buf->getMasterBuffer();
1548 Buffer * Buffer::getMasterBuffer()
1550 if (!params().parentname.empty()
1551 && theBufferList().exists(params().parentname)) {
1552 Buffer * buf = theBufferList().getBuffer(params().parentname);
1554 return buf->getMasterBuffer();
1561 MacroData const & Buffer::getMacro(docstring const & name) const
1563 return pimpl_->macros.get(name);
1567 bool Buffer::hasMacro(docstring const & name) const
1569 return pimpl_->macros.has(name);
1573 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1575 MacroTable::globalMacros().insert(name, data);
1576 pimpl_->macros.insert(name, data);
1580 void Buffer::buildMacros()
1582 // Start with global table.
1583 pimpl_->macros = MacroTable::globalMacros();
1586 ParagraphList const & pars = text().paragraphs();
1587 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1588 //lyxerr << "searching main par " << i
1589 // << " for macro definitions" << std::endl;
1590 InsetList const & insets = pars[i].insetlist;
1591 InsetList::const_iterator it = insets.begin();
1592 InsetList::const_iterator end = insets.end();
1593 for ( ; it != end; ++it) {
1594 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1595 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1596 MathMacroTemplate const & mac
1597 = static_cast<MathMacroTemplate const &>(*it->inset);
1598 insertMacro(mac.name(), mac.asMacroData());
1605 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1612 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1613 InsetBase::Code code)
1615 //FIXME: This does not work for child documents yet.
1616 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1617 // Check if the label 'from' appears more than once
1618 vector<docstring> labels;
1620 if (code == InsetBase::CITE_CODE) {
1621 vector<pair<string, docstring> > keys;
1622 fillWithBibKeys(keys);
1623 vector<pair<string, docstring> >::const_iterator bit = keys.begin();
1624 vector<pair<string, docstring> >::const_iterator bend = keys.end();
1626 for (; bit != bend; ++bit)
1628 labels.push_back(from_utf8(bit->first));
1630 getLabelList(labels);
1632 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1635 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1636 if (it->lyxCode() == code) {
1637 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1638 inset.replaceContents(to_utf8(from), to_utf8(to));
1644 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1645 pit_type par_end, bool full_source)
1647 OutputParams runparams;
1648 runparams.nice = true;
1649 runparams.flavor = OutputParams::LATEX;
1650 runparams.linelen = lyxrc.ascii_linelen;
1651 // No side effect of file copying and image conversion
1652 runparams.dryrun = true;
1654 /* Support for docbook temprarily commented out. */
1656 os << "% Preview source code\n\n";
1658 writeLaTeXSource(os, filePath(), runparams, true, true);
1660 writeDocBookSource(os, fileName(), runparams, false);
1663 runparams.par_begin = par_begin;
1664 runparams.par_end = par_end;
1665 if (par_begin + 1 == par_end)
1666 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1668 os << "% Preview source code from paragraph " << par_begin
1669 << " to " << par_end - 1 << "\n\n";
1670 // output paragraphs
1673 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1676 docbookParagraphs(paragraphs(), *this, os, runparams);
1682 ErrorList const & Buffer::errorList(string const & type) const
1684 static ErrorList const emptyErrorList;
1685 std::map<string, ErrorList>::const_iterator I = errorLists_.find(type);
1686 if (I == errorLists_.end())
1687 return emptyErrorList;
1693 ErrorList & Buffer::errorList(string const & type)
1695 return errorLists_[type];