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()));
515 // needed to insert the selection
516 void Buffer::insertStringAsLines(ParagraphList & pars,
517 pit_type & pit, pos_type & pos,
518 LyXFont const & fn, docstring const & str, bool autobreakrows)
522 // insert the string, don't insert doublespace
523 bool space_inserted = true;
524 for (docstring::const_iterator cit = str.begin();
525 cit != str.end(); ++cit) {
526 Paragraph & par = pars[pit];
528 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
529 breakParagraph(params(), pars, pit, pos,
530 par.layout()->isEnvironment());
533 space_inserted = true;
537 // do not insert consecutive spaces if !free_spacing
538 } else if ((*cit == ' ' || *cit == '\t') &&
539 space_inserted && !par.isFreeSpacing()) {
541 } else if (*cit == '\t') {
542 if (!par.isFreeSpacing()) {
543 // tabs are like spaces here
544 par.insertChar(pos, ' ', font, params().trackChanges);
546 space_inserted = true;
548 const pos_type n = 8 - pos % 8;
549 for (pos_type i = 0; i < n; ++i) {
550 par.insertChar(pos, ' ', font, params().trackChanges);
553 space_inserted = true;
555 } else if (!isPrintable(*cit)) {
556 // Ignore unprintables
559 // just insert the character
560 par.insertChar(pos, *cit, font, params().trackChanges);
562 space_inserted = (*cit == ' ');
569 bool Buffer::readFile(FileName const & filename)
571 // Check if the file is compressed.
572 string const format = getFormatFromContents(filename);
573 if (format == "gzip" || format == "zip" || format == "compress") {
574 params().compressed = true;
577 // remove dummy empty par
578 paragraphs().clear();
580 lex.setFile(filename);
581 if (!readFile(lex, filename))
584 // After we have read a file, we must ensure that the buffer
585 // language is set and used in the gui.
586 // If you know of a better place to put this, please tell me. (Lgb)
587 updateDocLang(params().language);
593 bool Buffer::fully_loaded() const
595 return pimpl_->file_fully_loaded;
599 void Buffer::fully_loaded(bool const value)
601 pimpl_->file_fully_loaded = value;
605 bool Buffer::readFile(LyXLex & lex, FileName const & filename)
607 BOOST_ASSERT(!filename.empty());
610 Alert::error(_("Document could not be read"),
611 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
616 string const token(lex.getString());
619 Alert::error(_("Document could not be read"),
620 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
624 // the first token _must_ be...
625 if (token != "\\lyxformat") {
626 lyxerr << "Token: " << token << endl;
628 Alert::error(_("Document format failure"),
629 bformat(_("%1$s is not a LyX document."),
630 from_utf8(filename.absFilename())));
635 string tmp_format = lex.getString();
636 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
637 // if present remove ".," from string.
638 string::size_type dot = tmp_format.find_first_of(".,");
639 //lyxerr << " dot found at " << dot << endl;
640 if (dot != string::npos)
641 tmp_format.erase(dot, 1);
642 int const file_format = convert<int>(tmp_format);
643 //lyxerr << "format: " << file_format << endl;
645 if (file_format != LYX_FORMAT) {
646 FileName const tmpfile(tempName());
647 if (tmpfile.empty()) {
648 Alert::error(_("Conversion failed"),
649 bformat(_("%1$s is from an earlier"
650 " version of LyX, but a temporary"
651 " file for converting it could"
653 from_utf8(filename.absFilename())));
656 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
657 if (lyx2lyx.empty()) {
658 Alert::error(_("Conversion script not found"),
659 bformat(_("%1$s is from an earlier"
660 " version of LyX, but the"
661 " conversion script lyx2lyx"
662 " could not be found."),
663 from_utf8(filename.absFilename())));
666 ostringstream command;
667 command << os::python()
668 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
669 << " -t " << convert<string>(LYX_FORMAT)
670 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
671 << ' ' << quoteName(filename.toFilesystemEncoding());
672 string const command_str = command.str();
674 lyxerr[Debug::INFO] << "Running '"
675 << command_str << '\''
678 cmd_ret const ret = runCommand(command_str);
679 if (ret.first != 0) {
680 Alert::error(_("Conversion script failed"),
681 bformat(_("%1$s is from an earlier version"
682 " of LyX, but the lyx2lyx script"
683 " failed to convert it."),
684 from_utf8(filename.absFilename())));
687 bool const ret = readFile(tmpfile);
688 // Do stuff with tmpfile name and buffer name here.
694 if (readDocument(lex)) {
695 Alert::error(_("Document format failure"),
696 bformat(_("%1$s ended unexpectedly, which means"
697 " that it is probably corrupted."),
698 from_utf8(filename.absFilename())));
701 //lyxerr << "removing " << MacroTable::localMacros().size()
702 // << " temporary macro entries" << endl;
703 //MacroTable::localMacros().clear();
705 pimpl_->file_fully_loaded = true;
710 // Should probably be moved to somewhere else: BufferView? LyXView?
711 bool Buffer::save() const
713 // We don't need autosaves in the immediate future. (Asger)
714 resetAutosaveTimers();
716 // make a backup if the file already exists
718 if (lyxrc.make_backup && fs::exists(pimpl_->filename.toFilesystemEncoding())) {
719 s = fileName() + '~';
720 if (!lyxrc.backupdir_path.empty())
721 s = addName(lyxrc.backupdir_path,
722 subst(os::internal_path(s),'/','!'));
724 // It might very well be that this variant is just
725 // good enough. (Lgb)
726 // But to use this we need fs::copy_file to actually do a copy,
727 // even when the target file exists. (Lgb)
729 fs::copy_file(pimpl_->filename.toFilesystemEncoding(), s, false);
731 catch (fs::filesystem_error const & fe) {
732 Alert::error(_("Backup failure"),
733 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
734 "Please check if the directory exists and is writeable."),
735 from_utf8(fs::path(s).branch_path().native_directory_string())));
736 lyxerr[Debug::DEBUG] << "Fs error: "
737 << fe.what() << endl;
741 if (writeFile(pimpl_->filename)) {
743 removeAutosaveFile(fileName());
745 // Saving failed, so backup is not backup
746 if (lyxrc.make_backup)
747 rename(FileName(s), pimpl_->filename);
754 bool Buffer::writeFile(FileName const & fname) const
756 if (pimpl_->read_only && fname == pimpl_->filename)
761 if (params().compressed) {
762 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname.toFilesystemEncoding()));
766 retval = do_writeFile(ofs);
768 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
772 retval = do_writeFile(ofs);
779 bool Buffer::do_writeFile(ostream & ofs) const
782 // Use the standard "C" locale for file output.
783 ofs.imbue(std::locale::classic());
786 // The top of the file should not be written by params().
788 // write out a comment in the top of the file
789 ofs << "#LyX " << lyx_version
790 << " created this file. For more info see http://www.lyx.org/\n"
791 << "\\lyxformat " << LYX_FORMAT << "\n"
792 << "\\begin_document\n";
794 // now write out the buffer parameters.
795 ofs << "\\begin_header\n";
796 params().writeFile(ofs);
797 ofs << "\\end_header\n";
800 ofs << "\n\\begin_body\n";
801 text().write(*this, ofs);
802 ofs << "\n\\end_body\n";
804 // Write marker that shows file is complete
805 ofs << "\\end_document" << endl;
807 // Shouldn't really be needed....
810 // how to check if close went ok?
811 // Following is an attempt... (BE 20001011)
813 // good() returns false if any error occured, including some
815 // bad() returns true if something bad happened in the buffer,
816 // which should include file system full errors.
821 lyxerr << "File was not closed properly." << endl;
828 bool Buffer::makeLaTeXFile(FileName const & fname,
829 string const & original_path,
830 OutputParams const & runparams,
831 bool output_preamble, bool output_body)
833 string const encoding = params().encoding().iconvName();
834 lyxerr[Debug::LATEX] << "makeLaTeXFile encoding: "
835 << encoding << "..." << endl;
837 odocfstream ofs(encoding);
838 if (!openFileWrite(ofs, fname))
842 writeLaTeXSource(ofs, original_path,
843 runparams, output_preamble, output_body);
845 catch (iconv_codecvt_facet_exception &) {
846 Alert::error(_("Encoding error"),
847 _("Some characters of your document are not "
848 "representable in the chosen encoding.\n"
849 "Changing the document encoding to utf8 could help."));
855 lyxerr << "File '" << fname << "' was not closed properly." << endl;
856 Alert::error(_("Error closing file"),
857 _("The output file could not be closed properly.\n"
858 " Probably some characters of your document are not "
859 "representable in the chosen encoding.\n"
860 "Changing the document encoding to utf8 could help."));
867 void Buffer::writeLaTeXSource(odocstream & os,
868 string const & original_path,
869 OutputParams const & runparams_in,
870 bool const output_preamble, bool const output_body)
872 OutputParams runparams = runparams_in;
874 // validate the buffer.
875 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
876 LaTeXFeatures features(*this, params(), runparams);
878 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
882 // The starting paragraph of the coming rows is the
883 // first paragraph of the document. (Asger)
884 texrow().start(paragraphs().begin()->id(), 0);
886 if (output_preamble && runparams.nice) {
887 os << "%% LyX " << lyx_version << " created this file. "
888 "For more info, see http://www.lyx.org/.\n"
889 "%% Do not edit unless you really know what "
894 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
895 // There are a few differences between nice LaTeX and usual files:
896 // usual is \batchmode and has a
897 // special input@path to allow the including of figures
898 // with either \input or \includegraphics (what figinsets do).
899 // input@path is set when the actual parameter
900 // original_path is set. This is done for usual tex-file, but not
901 // for nice-latex-file. (Matthias 250696)
902 // Note that input@path is only needed for something the user does
903 // in the preamble, included .tex files or ERT, files included by
904 // LyX work without it.
905 if (output_preamble) {
906 if (!runparams.nice) {
907 // code for usual, NOT nice-latex-file
908 os << "\\batchmode\n"; // changed
912 if (!original_path.empty()) {
914 // We don't know the encoding of inputpath
915 docstring const inputpath = from_utf8(latex_path(original_path));
916 os << "\\makeatletter\n"
917 << "\\def\\input@path{{"
918 << inputpath << "/}}\n"
919 << "\\makeatother\n";
925 // Write the preamble
926 runparams.use_babel = params().writeLaTeX(os, features, texrow());
932 os << "\\begin{document}\n";
935 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
937 if (!lyxrc.language_auto_begin) {
939 os << from_utf8(subst(lyxrc.language_command_begin,
941 params().language->babel()))
946 // if we are doing a real file with body, even if this is the
947 // child of some other buffer, let's cut the link here.
948 // This happens for example if only a child document is printed.
949 string save_parentname;
950 if (output_preamble) {
951 save_parentname = params().parentname;
952 params().parentname.erase();
956 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
958 // Restore the parenthood if needed
960 params().parentname = save_parentname;
962 // add this just in case after all the paragraphs
966 if (!lyxrc.language_auto_end) {
967 os << from_utf8(subst(lyxrc.language_command_end,
969 params().language->babel()))
974 if (output_preamble) {
975 os << "\\end{document}\n";
978 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
980 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
984 // Just to be sure. (Asger)
987 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
988 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
993 bool Buffer::isLatex() const
995 return params().getLyXTextClass().outputType() == LATEX;
999 bool Buffer::isLiterate() const
1001 return params().getLyXTextClass().outputType() == LITERATE;
1005 bool Buffer::isDocBook() const
1007 return params().getLyXTextClass().outputType() == DOCBOOK;
1011 void Buffer::makeDocBookFile(FileName const & fname,
1012 OutputParams const & runparams,
1013 bool const body_only)
1015 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
1019 if (!openFileWrite(ofs, fname))
1022 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1026 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1030 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1031 OutputParams const & runparams,
1032 bool const only_body)
1034 LaTeXFeatures features(*this, params(), runparams);
1039 LyXTextClass const & tclass = params().getLyXTextClass();
1040 string const top_element = tclass.latexname();
1043 if (runparams.flavor == OutputParams::XML)
1044 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1047 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1050 if (! tclass.class_header().empty())
1051 os << from_ascii(tclass.class_header());
1052 else if (runparams.flavor == OutputParams::XML)
1053 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1054 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1056 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1058 docstring preamble = from_utf8(params().preamble);
1059 if (runparams.flavor != OutputParams::XML ) {
1060 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1061 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1062 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1063 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1066 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1068 preamble += features.getIncludedFiles(name);
1069 preamble += features.getLyXSGMLEntities();
1071 if (!preamble.empty()) {
1072 os << "\n [ " << preamble << " ]";
1077 string top = top_element;
1079 if (runparams.flavor == OutputParams::XML)
1080 top += params().language->code();
1082 top += params().language->code().substr(0,2);
1085 if (!params().options.empty()) {
1087 top += params().options;
1090 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1091 << " file was created by LyX " << lyx_version
1092 << "\n See http://www.lyx.org/ for more information -->\n";
1094 params().getLyXTextClass().counters().reset();
1096 sgml::openTag(os, top);
1098 docbookParagraphs(paragraphs(), *this, os, runparams);
1099 sgml::closeTag(os, top_element);
1103 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1104 // Other flags: -wall -v0 -x
1105 int Buffer::runChktex()
1109 // get LaTeX-Filename
1110 string const name = getLatexName(false);
1111 string const path = temppath();
1112 string const org_path = filePath();
1114 support::Path p(path); // path to LaTeX file
1115 message(_("Running chktex..."));
1117 // Generate the LaTeX file if neccessary
1118 OutputParams runparams;
1119 runparams.flavor = OutputParams::LATEX;
1120 runparams.nice = false;
1121 makeLaTeXFile(FileName(name), org_path, runparams);
1124 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1125 int const res = chktex.run(terr); // run chktex
1128 Alert::error(_("chktex failure"),
1129 _("Could not run chktex successfully."));
1130 } else if (res > 0) {
1131 // Fill-in the error list with the TeX errors
1132 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1143 void Buffer::validate(LaTeXFeatures & features) const
1145 LyXTextClass const & tclass = params().getLyXTextClass();
1147 if (features.isAvailable("dvipost") && params().outputChanges)
1148 features.require("dvipost");
1150 // AMS Style is at document level
1151 if (params().use_amsmath == BufferParams::package_on
1152 || tclass.provides(LyXTextClass::amsmath))
1153 features.require("amsmath");
1154 if (params().use_esint == BufferParams::package_on)
1155 features.require("esint");
1157 for_each(paragraphs().begin(), paragraphs().end(),
1158 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1160 // the bullet shapes are buffer level not paragraph level
1161 // so they are tested here
1162 for (int i = 0; i < 4; ++i) {
1163 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1164 int const font = params().user_defined_bullet(i).getFont();
1166 int const c = params()
1167 .user_defined_bullet(i)
1174 features.require("latexsym");
1176 } else if (font == 1) {
1177 features.require("amssymb");
1178 } else if ((font >= 2 && font <= 5)) {
1179 features.require("pifont");
1184 if (lyxerr.debugging(Debug::LATEX)) {
1185 features.showStruct();
1190 void Buffer::getLabelList(vector<docstring> & list) const
1192 /// if this is a child document and the parent is already loaded
1193 /// Use the parent's list instead [ale990407]
1194 Buffer const * tmp = getMasterBuffer();
1196 lyxerr << "getMasterBuffer() failed!" << endl;
1200 tmp->getLabelList(list);
1204 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1205 it.nextInset()->getLabelList(*this, list);
1209 // This is also a buffer property (ale)
1210 void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
1213 /// if this is a child document and the parent is already loaded
1214 /// use the parent's list instead [ale990412]
1215 Buffer const * tmp = getMasterBuffer();
1218 tmp->fillWithBibKeys(keys);
1222 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1223 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1224 InsetBibtex const & inset =
1225 dynamic_cast<InsetBibtex const &>(*it);
1226 inset.fillWithBibKeys(*this, keys);
1227 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1228 InsetInclude const & inset =
1229 dynamic_cast<InsetInclude const &>(*it);
1230 inset.fillWithBibKeys(*this, keys);
1231 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1232 InsetBibitem const & inset =
1233 dynamic_cast<InsetBibitem const &>(*it);
1235 string const key = to_utf8(inset.getParam("key"));
1236 docstring const label = inset.getParam("label");
1237 docstring const ref; // = pit->asString(this, false);
1238 docstring const info = label + "TheBibliographyRef" + ref;
1239 keys.push_back(pair<string, docstring>(key, info));
1245 void Buffer::updateBibfilesCache()
1247 // if this is a child document and the parent is already loaded
1248 // update the parent's cache instead
1249 Buffer * tmp = getMasterBuffer();
1252 tmp->updateBibfilesCache();
1256 bibfilesCache_.clear();
1257 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1258 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1259 InsetBibtex const & inset =
1260 dynamic_cast<InsetBibtex const &>(*it);
1261 vector<FileName> const bibfiles = inset.getFiles(*this);
1262 bibfilesCache_.insert(bibfilesCache_.end(),
1265 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1266 InsetInclude & inset =
1267 dynamic_cast<InsetInclude &>(*it);
1268 inset.updateBibfilesCache(*this);
1269 vector<FileName> const & bibfiles =
1270 inset.getBibfilesCache(*this);
1271 bibfilesCache_.insert(bibfilesCache_.end(),
1279 vector<FileName> const & Buffer::getBibfilesCache() const
1281 // if this is a child document and the parent is already loaded
1282 // use the parent's cache instead
1283 Buffer const * tmp = getMasterBuffer();
1286 return tmp->getBibfilesCache();
1288 // We update the cache when first used instead of at loading time.
1289 if (bibfilesCache_.empty())
1290 const_cast<Buffer *>(this)->updateBibfilesCache();
1292 return bibfilesCache_;
1296 bool Buffer::isDepClean(string const & name) const
1298 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1299 if (it == pimpl_->dep_clean.end())
1305 void Buffer::markDepClean(string const & name)
1307 pimpl_->dep_clean[name] = true;
1311 bool Buffer::dispatch(string const & command, bool * result)
1313 return dispatch(lyxaction.lookupFunc(command), result);
1317 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1319 bool dispatched = true;
1321 switch (func.action) {
1322 case LFUN_BUFFER_EXPORT: {
1323 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1336 void Buffer::changeLanguage(Language const * from, Language const * to)
1341 // Take care of l10n/i18n
1344 for_each(par_iterator_begin(),
1346 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1348 text().current_font.setLanguage(to);
1349 text().real_current_font.setLanguage(to);
1353 void Buffer::updateDocLang(Language const * nlang)
1355 BOOST_ASSERT(nlang);
1357 pimpl_->messages.reset(new Messages(nlang->code()));
1361 bool Buffer::isMultiLingual() const
1363 ParConstIterator end = par_iterator_end();
1364 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1365 if (it->isMultiLingual(params()))
1372 ParIterator Buffer::getParFromID(int const id) const
1374 ParConstIterator it = par_iterator_begin();
1375 ParConstIterator const end = par_iterator_end();
1378 // John says this is called with id == -1 from undo
1379 lyxerr << "getParFromID(), id: " << id << endl;
1383 for (; it != end; ++it)
1391 bool Buffer::hasParWithID(int const id) const
1393 ParConstIterator const it = getParFromID(id);
1394 return it != par_iterator_end();
1398 ParIterator Buffer::par_iterator_begin()
1400 return lyx::par_iterator_begin(inset());
1404 ParIterator Buffer::par_iterator_end()
1406 return lyx::par_iterator_end(inset());
1410 ParConstIterator Buffer::par_iterator_begin() const
1412 return lyx::par_const_iterator_begin(inset());
1416 ParConstIterator Buffer::par_iterator_end() const
1418 return lyx::par_const_iterator_end(inset());
1422 Language const * Buffer::getLanguage() const
1424 return params().language;
1428 docstring const Buffer::B_(string const & l10n) const
1430 if (pimpl_->messages.get())
1431 return pimpl_->messages->get(l10n);
1437 docstring const Buffer::translateLabel(docstring const & label) const
1439 if (support::isAscii(label))
1440 // Probably standard layout, try to translate
1441 return B_(to_ascii(label));
1443 // This must be a user defined layout. We cannot translate
1444 // this, since gettext accepts only ascii keys.
1449 bool Buffer::isClean() const
1451 return pimpl_->lyx_clean;
1455 bool Buffer::isBakClean() const
1457 return pimpl_->bak_clean;
1461 void Buffer::markClean() const
1463 if (!pimpl_->lyx_clean) {
1464 pimpl_->lyx_clean = true;
1467 // if the .lyx file has been saved, we don't need an
1469 pimpl_->bak_clean = true;
1473 void Buffer::markBakClean()
1475 pimpl_->bak_clean = true;
1479 void Buffer::setUnnamed(bool flag)
1481 pimpl_->unnamed = flag;
1485 bool Buffer::isUnnamed() const
1487 return pimpl_->unnamed;
1491 #ifdef WITH_WARNINGS
1492 #warning this function should be moved to buffer_pimpl.C
1494 void Buffer::markDirty()
1496 if (pimpl_->lyx_clean) {
1497 pimpl_->lyx_clean = false;
1500 pimpl_->bak_clean = false;
1502 DepClean::iterator it = pimpl_->dep_clean.begin();
1503 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1505 for (; it != end; ++it)
1510 string const Buffer::fileName() const
1512 return pimpl_->filename.absFilename();
1516 string const & Buffer::filePath() const
1518 return params().filepath;
1522 bool Buffer::isReadonly() const
1524 return pimpl_->read_only;
1528 void Buffer::setParentName(string const & name)
1530 params().parentname = name;
1534 Buffer const * Buffer::getMasterBuffer() const
1536 if (!params().parentname.empty()
1537 && theBufferList().exists(params().parentname)) {
1538 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1540 return buf->getMasterBuffer();
1547 Buffer * Buffer::getMasterBuffer()
1549 if (!params().parentname.empty()
1550 && theBufferList().exists(params().parentname)) {
1551 Buffer * buf = theBufferList().getBuffer(params().parentname);
1553 return buf->getMasterBuffer();
1560 MacroData const & Buffer::getMacro(docstring const & name) const
1562 return pimpl_->macros.get(name);
1566 bool Buffer::hasMacro(docstring const & name) const
1568 return pimpl_->macros.has(name);
1572 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1574 MacroTable::globalMacros().insert(name, data);
1575 pimpl_->macros.insert(name, data);
1579 void Buffer::buildMacros()
1581 // Start with global table.
1582 pimpl_->macros = MacroTable::globalMacros();
1585 ParagraphList const & pars = text().paragraphs();
1586 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1587 //lyxerr << "searching main par " << i
1588 // << " for macro definitions" << std::endl;
1589 InsetList const & insets = pars[i].insetlist;
1590 InsetList::const_iterator it = insets.begin();
1591 InsetList::const_iterator end = insets.end();
1592 for ( ; it != end; ++it) {
1593 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1594 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1595 MathMacroTemplate const & mac
1596 = static_cast<MathMacroTemplate const &>(*it->inset);
1597 insertMacro(mac.name(), mac.asMacroData());
1604 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1611 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1612 InsetBase::Code code)
1614 //FIXME: This does not work for child documents yet.
1615 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1616 // Check if the label 'from' appears more than once
1617 vector<docstring> labels;
1619 if (code == InsetBase::CITE_CODE) {
1620 vector<pair<string, docstring> > keys;
1621 fillWithBibKeys(keys);
1622 vector<pair<string, docstring> >::const_iterator bit = keys.begin();
1623 vector<pair<string, docstring> >::const_iterator bend = keys.end();
1625 for (; bit != bend; ++bit)
1627 labels.push_back(from_utf8(bit->first));
1629 getLabelList(labels);
1631 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1634 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1635 if (it->lyxCode() == code) {
1636 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1637 inset.replaceContents(to_utf8(from), to_utf8(to));
1643 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1644 pit_type par_end, bool full_source)
1646 OutputParams runparams;
1647 runparams.nice = true;
1648 runparams.flavor = OutputParams::LATEX;
1649 runparams.linelen = lyxrc.ascii_linelen;
1650 // No side effect of file copying and image conversion
1651 runparams.dryrun = true;
1653 /* Support for docbook temprarily commented out. */
1655 os << "% Preview source code\n\n";
1657 writeLaTeXSource(os, filePath(), runparams, true, true);
1659 writeDocBookSource(os, fileName(), runparams, false);
1662 runparams.par_begin = par_begin;
1663 runparams.par_end = par_end;
1664 if (par_begin + 1 == par_end)
1665 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1667 os << "% Preview source code from paragraph " << par_begin
1668 << " to " << par_end - 1 << "\n\n";
1669 // output paragraphs
1672 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1675 docbookParagraphs(paragraphs(), *this, os, runparams);
1681 ErrorList const & Buffer::errorList(string const & type) const
1683 static ErrorList const emptyErrorList;
1684 std::map<string, ErrorList>::const_iterator I = errorLists_.find(type);
1685 if (I == errorLists_.end())
1686 return emptyErrorList;
1692 ErrorList & Buffer::errorList(string const & type)
1694 return errorLists_[type];