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::isDirWriteable;
106 using support::libFileSearch;
107 using support::latex_path;
108 using support::ltrim;
109 using support::makeAbsPath;
110 using support::makeDisplayPath;
111 using support::makeLatexName;
112 using support::onlyFilename;
113 using support::onlyPath;
114 using support::quoteName;
115 using support::removeAutosaveFile;
116 using support::rename;
117 using support::runCommand;
118 using support::split;
119 using support::subst;
120 using support::tempName;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
125 namespace fs = boost::filesystem;
126 namespace io = boost::iostreams;
130 using std::make_pair;
135 using std::ostringstream;
145 int const LYX_FORMAT = 255;
150 typedef std::map<string, bool> DepClean;
155 Impl(Buffer & parent, FileName const & file, bool readonly);
157 limited_stack<Undo> undostack;
158 limited_stack<Undo> redostack;
164 /// need to regenerate .tex?
168 mutable bool lyx_clean;
170 /// is autosave needed?
171 mutable bool bak_clean;
173 /// is this a unnamed file (New...)?
179 /// name of the file the buffer is associated with.
182 boost::scoped_ptr<Messages> messages;
184 /** Set to true only when the file is fully loaded.
185 * Used to prevent the premature generation of previews
186 * and by the citation inset.
188 bool file_fully_loaded;
190 /// our LyXText that should be wrapped in an InsetText
197 TocBackend toc_backend;
201 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
202 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
203 filename(file), file_fully_loaded(false), inset(params),
206 inset.setAutoBreakRows(true);
207 lyxvc.buffer(&parent);
208 temppath = createBufferTmpDir();
209 params.filepath = onlyPath(file.absFilename());
210 // FIXME: And now do something if temppath == string(), because we
211 // assume from now on that temppath points to a valid temp dir.
212 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
216 Buffer::Buffer(string const & file, bool readonly)
217 : pimpl_(new Impl(*this, FileName(file), readonly))
219 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
225 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
226 // here the buffer should take care that it is
227 // saved properly, before it goes into the void.
231 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
232 Alert::warning(_("Could not remove temporary directory"),
233 bformat(_("Could not remove the temporary directory %1$s"),
234 from_utf8(temppath())));
237 // Remove any previewed LaTeX snippets associated with this buffer.
238 graphics::Previews::get().removeLoader(*this);
242 LyXText & Buffer::text() const
244 return const_cast<LyXText &>(pimpl_->inset.text_);
248 InsetBase & Buffer::inset() const
250 return const_cast<InsetText &>(pimpl_->inset);
254 limited_stack<Undo> & Buffer::undostack()
256 return pimpl_->undostack;
260 limited_stack<Undo> const & Buffer::undostack() const
262 return pimpl_->undostack;
266 limited_stack<Undo> & Buffer::redostack()
268 return pimpl_->redostack;
272 limited_stack<Undo> const & Buffer::redostack() const
274 return pimpl_->redostack;
278 BufferParams & Buffer::params()
280 return pimpl_->params;
284 BufferParams const & Buffer::params() const
286 return pimpl_->params;
290 ParagraphList & Buffer::paragraphs()
292 return text().paragraphs();
296 ParagraphList const & Buffer::paragraphs() const
298 return text().paragraphs();
302 LyXVC & Buffer::lyxvc()
304 return pimpl_->lyxvc;
308 LyXVC const & Buffer::lyxvc() const
310 return pimpl_->lyxvc;
314 string const & Buffer::temppath() const
316 return pimpl_->temppath;
320 TexRow & Buffer::texrow()
322 return pimpl_->texrow;
326 TexRow const & Buffer::texrow() const
328 return pimpl_->texrow;
332 TocBackend & Buffer::tocBackend()
334 return pimpl_->toc_backend;
338 TocBackend const & Buffer::tocBackend() const
340 return pimpl_->toc_backend;
344 string const Buffer::getLatexName(bool const no_path) const
346 string const name = changeExtension(makeLatexName(fileName()), ".tex");
347 return no_path ? onlyFilename(name) : name;
351 pair<Buffer::LogType, string> const Buffer::getLogName() const
353 string const filename = getLatexName(false);
355 if (filename.empty())
356 return make_pair(Buffer::latexlog, string());
358 string const path = temppath();
360 FileName const fname(addName(temppath(),
361 onlyFilename(changeExtension(filename,
363 FileName const bname(
364 addName(path, onlyFilename(
365 changeExtension(filename,
366 formats.extension("literate") + ".out"))));
368 // If no Latex log or Build log is newer, show Build log
370 if (fs::exists(bname.toFilesystemEncoding()) &&
371 (!fs::exists(fname.toFilesystemEncoding()) ||
372 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
373 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
374 return make_pair(Buffer::buildlog, bname.absFilename());
376 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
377 return make_pair(Buffer::latexlog, fname.absFilename());
381 void Buffer::setReadonly(bool const flag)
383 if (pimpl_->read_only != flag) {
384 pimpl_->read_only = flag;
390 void Buffer::setFileName(string const & newfile)
392 string const filename = makeAbsPath(newfile);
393 pimpl_->filename = FileName(filename);
394 params().filepath = onlyPath(filename);
395 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
400 // We'll remove this later. (Lgb)
403 void unknownClass(string const & unknown)
405 Alert::warning(_("Unknown document class"),
406 bformat(_("Using the default document class, because the "
407 "class %1$s is unknown."), from_utf8(unknown)));
413 int Buffer::readHeader(LyXLex & lex)
415 int unknown_tokens = 0;
417 int begin_header_line = -1;
419 // Initialize parameters that may be/go lacking in header:
420 params().branchlist().clear();
421 params().preamble.erase();
422 params().options.erase();
423 params().float_placement.erase();
424 params().paperwidth.erase();
425 params().paperheight.erase();
426 params().leftmargin.erase();
427 params().rightmargin.erase();
428 params().topmargin.erase();
429 params().bottommargin.erase();
430 params().headheight.erase();
431 params().headsep.erase();
432 params().footskip.erase();
434 ErrorList & errorList = errorLists_["Parse"];
438 string const token = lex.getString();
443 if (token == "\\end_header")
447 if (token == "\\begin_header") {
448 begin_header_line = line;
452 lyxerr[Debug::PARSER] << "Handling document header token: `"
453 << token << '\'' << endl;
455 string unknown = params().readToken(lex, token);
456 if (!unknown.empty()) {
457 if (unknown[0] != '\\' && token == "\\textclass") {
458 unknownClass(unknown);
461 docstring const s = bformat(_("Unknown token: "
465 errorList.push_back(ErrorItem(_("Document header error"),
470 if (begin_header_line) {
471 docstring const s = _("\\begin_header is missing");
472 errorList.push_back(ErrorItem(_("Document header error"),
476 return unknown_tokens;
481 // changed to be public and have one parameter
482 // Returns false if "\end_document" is not read (Asger)
483 bool Buffer::readDocument(LyXLex & lex)
485 ErrorList & errorList = errorLists_["Parse"];
489 string const token = lex.getString();
490 if (token != "\\begin_document") {
491 docstring const s = _("\\begin_document is missing");
492 errorList.push_back(ErrorItem(_("Document header error"),
496 // we are reading in a brand new document
497 BOOST_ASSERT(paragraphs().empty());
500 if (!params().getLyXTextClass().load(filePath())) {
501 string theclass = params().getLyXTextClass().name();
502 Alert::error(_("Can't load document class"), bformat(
503 _("Using the default document class, because the "
504 "class %1$s could not be loaded."), from_utf8(theclass)));
505 params().textclass = 0;
508 bool const res = text().read(*this, lex, errorList);
509 for_each(text().paragraphs().begin(),
510 text().paragraphs().end(),
511 bind(&Paragraph::setInsetOwner, _1, &inset()));
512 updateBibfilesCache();
518 // needed to insert the selection
519 void Buffer::insertStringAsLines(ParagraphList & pars,
520 pit_type & pit, pos_type & pos,
521 LyXFont const & fn, docstring const & str, bool autobreakrows)
525 // insert the string, don't insert doublespace
526 bool space_inserted = true;
527 for (docstring::const_iterator cit = str.begin();
528 cit != str.end(); ++cit) {
529 Paragraph & par = pars[pit];
531 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
532 breakParagraph(params(), pars, pit, pos,
533 par.layout()->isEnvironment());
536 space_inserted = true;
540 // do not insert consecutive spaces if !free_spacing
541 } else if ((*cit == ' ' || *cit == '\t') &&
542 space_inserted && !par.isFreeSpacing()) {
544 } else if (*cit == '\t') {
545 if (!par.isFreeSpacing()) {
546 // tabs are like spaces here
547 par.insertChar(pos, ' ', font, params().trackChanges);
549 space_inserted = true;
551 const pos_type n = 8 - pos % 8;
552 for (pos_type i = 0; i < n; ++i) {
553 par.insertChar(pos, ' ', font, params().trackChanges);
556 space_inserted = true;
558 } else if (!isPrintable(*cit)) {
559 // Ignore unprintables
562 // just insert the character
563 par.insertChar(pos, *cit, font, params().trackChanges);
565 space_inserted = (*cit == ' ');
572 bool Buffer::readFile(string const & filename)
574 // Check if the file is compressed.
575 FileName const name(makeAbsPath(filename));
576 string const format = getFormatFromContents(name);
577 if (format == "gzip" || format == "zip" || format == "compress") {
578 params().compressed = true;
581 // remove dummy empty par
582 paragraphs().clear();
585 if (!readFile(lex, filename))
588 // After we have read a file, we must ensure that the buffer
589 // language is set and used in the gui.
590 // If you know of a better place to put this, please tell me. (Lgb)
591 updateDocLang(params().language);
597 bool Buffer::fully_loaded() const
599 return pimpl_->file_fully_loaded;
603 void Buffer::fully_loaded(bool const value)
605 pimpl_->file_fully_loaded = value;
609 bool Buffer::readFile(LyXLex & lex, string const & filename)
611 BOOST_ASSERT(!filename.empty());
614 Alert::error(_("Document could not be read"),
615 bformat(_("%1$s could not be read."), from_utf8(filename)));
620 string const token(lex.getString());
623 Alert::error(_("Document could not be read"),
624 bformat(_("%1$s could not be read."), from_utf8(filename)));
628 // the first token _must_ be...
629 if (token != "\\lyxformat") {
630 lyxerr << "Token: " << token << endl;
632 Alert::error(_("Document format failure"),
633 bformat(_("%1$s is not a LyX document."),
634 from_utf8(filename)));
639 string tmp_format = lex.getString();
640 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
641 // if present remove ".," from string.
642 string::size_type dot = tmp_format.find_first_of(".,");
643 //lyxerr << " dot found at " << dot << endl;
644 if (dot != string::npos)
645 tmp_format.erase(dot, 1);
646 int const file_format = convert<int>(tmp_format);
647 //lyxerr << "format: " << file_format << endl;
649 if (file_format != LYX_FORMAT) {
650 string const tmpfile = tempName();
651 if (tmpfile.empty()) {
652 Alert::error(_("Conversion failed"),
653 bformat(_("%1$s is from an earlier"
654 " version of LyX, but a temporary"
655 " file for converting it could"
657 from_utf8(filename)));
660 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
661 if (lyx2lyx.empty()) {
662 Alert::error(_("Conversion script not found"),
663 bformat(_("%1$s is from an earlier"
664 " version of LyX, but the"
665 " conversion script lyx2lyx"
666 " could not be found."),
667 from_utf8(filename)));
670 ostringstream command;
671 command << os::python() << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
672 << " -t " << convert<string>(LYX_FORMAT)
673 << " -o " << quoteName(tmpfile) << ' '
674 << quoteName(filename);
675 string const command_str = command.str();
677 lyxerr[Debug::INFO] << "Running '"
678 << command_str << '\''
681 cmd_ret const ret = runCommand(command_str);
682 if (ret.first != 0) {
683 Alert::error(_("Conversion script failed"),
684 bformat(_("%1$s is from an earlier version"
685 " of LyX, but the lyx2lyx script"
686 " failed to convert it."),
687 from_utf8(filename)));
690 bool const ret = readFile(tmpfile);
691 // Do stuff with tmpfile name and buffer name here.
697 if (readDocument(lex)) {
698 Alert::error(_("Document format failure"),
699 bformat(_("%1$s ended unexpectedly, which means"
700 " that it is probably corrupted."),
701 from_utf8(filename)));
704 //lyxerr << "removing " << MacroTable::localMacros().size()
705 // << " temporary macro entries" << endl;
706 //MacroTable::localMacros().clear();
708 pimpl_->file_fully_loaded = true;
713 // Should probably be moved to somewhere else: BufferView? LyXView?
714 bool Buffer::save() const
716 // We don't need autosaves in the immediate future. (Asger)
717 resetAutosaveTimers();
719 // make a backup if the file already exists
721 if (lyxrc.make_backup && fs::exists(pimpl_->filename.toFilesystemEncoding())) {
722 s = fileName() + '~';
723 if (!lyxrc.backupdir_path.empty())
724 s = addName(lyxrc.backupdir_path,
725 subst(os::internal_path(s),'/','!'));
727 // It might very well be that this variant is just
728 // good enough. (Lgb)
729 // But to use this we need fs::copy_file to actually do a copy,
730 // even when the target file exists. (Lgb)
732 fs::copy_file(pimpl_->filename.toFilesystemEncoding(), s, false);
734 catch (fs::filesystem_error const & fe) {
735 Alert::error(_("Backup failure"),
736 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
737 "Please check if the directory exists and is writeable."),
738 from_utf8(fs::path(s).branch_path().native_directory_string())));
739 lyxerr[Debug::DEBUG] << "Fs error: "
740 << fe.what() << endl;
744 if (writeFile(pimpl_->filename)) {
746 removeAutosaveFile(fileName());
748 // Saving failed, so backup is not backup
749 if (lyxrc.make_backup)
750 rename(FileName(s), pimpl_->filename);
757 bool Buffer::writeFile(FileName const & fname) const
759 if (pimpl_->read_only && fname == pimpl_->filename)
764 if (params().compressed) {
765 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname.toFilesystemEncoding()));
769 retval = do_writeFile(ofs);
771 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
775 retval = do_writeFile(ofs);
782 bool Buffer::do_writeFile(ostream & ofs) const
785 // Use the standard "C" locale for file output.
786 ofs.imbue(std::locale::classic());
789 // The top of the file should not be written by params().
791 // write out a comment in the top of the file
792 ofs << "#LyX " << lyx_version
793 << " created this file. For more info see http://www.lyx.org/\n"
794 << "\\lyxformat " << LYX_FORMAT << "\n"
795 << "\\begin_document\n";
797 // now write out the buffer parameters.
798 ofs << "\\begin_header\n";
799 params().writeFile(ofs);
800 ofs << "\\end_header\n";
803 ofs << "\n\\begin_body\n";
804 text().write(*this, ofs);
805 ofs << "\n\\end_body\n";
807 // Write marker that shows file is complete
808 ofs << "\\end_document" << endl;
810 // Shouldn't really be needed....
813 // how to check if close went ok?
814 // Following is an attempt... (BE 20001011)
816 // good() returns false if any error occured, including some
818 // bad() returns true if something bad happened in the buffer,
819 // which should include file system full errors.
824 lyxerr << "File was not closed properly." << endl;
831 bool Buffer::makeLaTeXFile(FileName const & fname,
832 string const & original_path,
833 OutputParams const & runparams,
834 bool output_preamble, bool output_body)
836 string const encoding = params().encoding().iconvName();
837 lyxerr[Debug::LATEX] << "makeLaTeXFile encoding: "
838 << encoding << "..." << endl;
840 odocfstream ofs(encoding);
841 if (!openFileWrite(ofs, fname))
845 writeLaTeXSource(ofs, original_path,
846 runparams, output_preamble, output_body);
848 catch (iconv_codecvt_facet_exception &) {
849 Alert::error(_("Encoding error"),
850 _("Some characters of your document are not "
851 "representable in the chosen encoding.\n"
852 "Changing the document encoding to utf8 could help."));
858 lyxerr << "File '" << fname << "' was not closed properly." << endl;
859 Alert::error(_("Error closing file"),
860 _("The output file could not be closed properly.\n"
861 " Probably some characters of your document are not "
862 "representable in the chosen encoding.\n"
863 "Changing the document encoding to utf8 could help."));
870 void Buffer::writeLaTeXSource(odocstream & os,
871 string const & original_path,
872 OutputParams const & runparams_in,
873 bool const output_preamble, bool const output_body)
875 OutputParams runparams = runparams_in;
877 // validate the buffer.
878 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
879 LaTeXFeatures features(*this, params(), runparams);
881 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
885 // The starting paragraph of the coming rows is the
886 // first paragraph of the document. (Asger)
887 texrow().start(paragraphs().begin()->id(), 0);
889 if (output_preamble && runparams.nice) {
890 os << "%% LyX " << lyx_version << " created this file. "
891 "For more info, see http://www.lyx.org/.\n"
892 "%% Do not edit unless you really know what "
897 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
898 // There are a few differences between nice LaTeX and usual files:
899 // usual is \batchmode and has a
900 // special input@path to allow the including of figures
901 // with either \input or \includegraphics (what figinsets do).
902 // input@path is set when the actual parameter
903 // original_path is set. This is done for usual tex-file, but not
904 // for nice-latex-file. (Matthias 250696)
905 // Note that input@path is only needed for something the user does
906 // in the preamble, included .tex files or ERT, files included by
907 // LyX work without it.
908 if (output_preamble) {
909 if (!runparams.nice) {
910 // code for usual, NOT nice-latex-file
911 os << "\\batchmode\n"; // changed
915 if (!original_path.empty()) {
917 // We don't know the encoding of inputpath
918 docstring const inputpath = from_utf8(latex_path(original_path));
919 os << "\\makeatletter\n"
920 << "\\def\\input@path{{"
921 << inputpath << "/}}\n"
922 << "\\makeatother\n";
928 // Write the preamble
929 runparams.use_babel = params().writeLaTeX(os, features, texrow());
935 os << "\\begin{document}\n";
938 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
940 if (!lyxrc.language_auto_begin) {
942 os << from_utf8(subst(lyxrc.language_command_begin,
944 params().language->babel()))
949 // if we are doing a real file with body, even if this is the
950 // child of some other buffer, let's cut the link here.
951 // This happens for example if only a child document is printed.
952 string save_parentname;
953 if (output_preamble) {
954 save_parentname = params().parentname;
955 params().parentname.erase();
959 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
961 // Restore the parenthood if needed
963 params().parentname = save_parentname;
965 // add this just in case after all the paragraphs
969 if (!lyxrc.language_auto_end) {
970 os << from_utf8(subst(lyxrc.language_command_end,
972 params().language->babel()))
977 if (output_preamble) {
978 os << "\\end{document}\n";
981 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
983 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
987 // Just to be sure. (Asger)
990 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
991 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
996 bool Buffer::isLatex() const
998 return params().getLyXTextClass().outputType() == LATEX;
1002 bool Buffer::isLiterate() const
1004 return params().getLyXTextClass().outputType() == LITERATE;
1008 bool Buffer::isDocBook() const
1010 return params().getLyXTextClass().outputType() == DOCBOOK;
1014 void Buffer::makeDocBookFile(FileName const & fname,
1015 OutputParams const & runparams,
1016 bool const body_only)
1018 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
1022 if (!openFileWrite(ofs, fname))
1025 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1029 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1033 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1034 OutputParams const & runparams,
1035 bool const only_body)
1037 LaTeXFeatures features(*this, params(), runparams);
1042 LyXTextClass const & tclass = params().getLyXTextClass();
1043 string const top_element = tclass.latexname();
1046 if (runparams.flavor == OutputParams::XML)
1047 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1050 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1053 if (! tclass.class_header().empty())
1054 os << from_ascii(tclass.class_header());
1055 else if (runparams.flavor == OutputParams::XML)
1056 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1057 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1059 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1061 docstring preamble = from_utf8(params().preamble);
1062 if (runparams.flavor != OutputParams::XML ) {
1063 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1064 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1065 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1066 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1069 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1071 preamble += features.getIncludedFiles(name);
1072 preamble += features.getLyXSGMLEntities();
1074 if (!preamble.empty()) {
1075 os << "\n [ " << preamble << " ]";
1080 string top = top_element;
1082 if (runparams.flavor == OutputParams::XML)
1083 top += params().language->code();
1085 top += params().language->code().substr(0,2);
1088 if (!params().options.empty()) {
1090 top += params().options;
1093 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1094 << " file was created by LyX " << lyx_version
1095 << "\n See http://www.lyx.org/ for more information -->\n";
1097 params().getLyXTextClass().counters().reset();
1099 sgml::openTag(os, top);
1101 docbookParagraphs(paragraphs(), *this, os, runparams);
1102 sgml::closeTag(os, top_element);
1106 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1107 // Other flags: -wall -v0 -x
1108 int Buffer::runChktex()
1112 // get LaTeX-Filename
1113 string const name = getLatexName(false);
1114 string const path = temppath();
1115 string const org_path = filePath();
1117 support::Path p(path); // path to LaTeX file
1118 message(_("Running chktex..."));
1120 // Generate the LaTeX file if neccessary
1121 OutputParams runparams;
1122 runparams.flavor = OutputParams::LATEX;
1123 runparams.nice = false;
1124 makeLaTeXFile(FileName(name), org_path, runparams);
1127 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1128 int const res = chktex.run(terr); // run chktex
1131 Alert::error(_("chktex failure"),
1132 _("Could not run chktex successfully."));
1133 } else if (res > 0) {
1134 // Fill-in the error list with the TeX errors
1135 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1146 void Buffer::validate(LaTeXFeatures & features) const
1148 LyXTextClass const & tclass = params().getLyXTextClass();
1150 if (features.isAvailable("dvipost") && params().outputChanges)
1151 features.require("dvipost");
1153 // AMS Style is at document level
1154 if (params().use_amsmath == BufferParams::package_on
1155 || tclass.provides(LyXTextClass::amsmath))
1156 features.require("amsmath");
1157 if (params().use_esint == BufferParams::package_on)
1158 features.require("esint");
1160 for_each(paragraphs().begin(), paragraphs().end(),
1161 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1163 // the bullet shapes are buffer level not paragraph level
1164 // so they are tested here
1165 for (int i = 0; i < 4; ++i) {
1166 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1167 int const font = params().user_defined_bullet(i).getFont();
1169 int const c = params()
1170 .user_defined_bullet(i)
1177 features.require("latexsym");
1179 } else if (font == 1) {
1180 features.require("amssymb");
1181 } else if ((font >= 2 && font <= 5)) {
1182 features.require("pifont");
1187 if (lyxerr.debugging(Debug::LATEX)) {
1188 features.showStruct();
1193 void Buffer::getLabelList(vector<docstring> & list) const
1195 /// if this is a child document and the parent is already loaded
1196 /// Use the parent's list instead [ale990407]
1197 Buffer const * tmp = getMasterBuffer();
1199 lyxerr << "getMasterBuffer() failed!" << endl;
1203 tmp->getLabelList(list);
1207 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1208 it.nextInset()->getLabelList(*this, list);
1212 // This is also a buffer property (ale)
1213 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1216 /// if this is a child document and the parent is already loaded
1217 /// use the parent's list instead [ale990412]
1218 Buffer const * tmp = getMasterBuffer();
1221 tmp->fillWithBibKeys(keys);
1225 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1226 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1227 InsetBibtex const & inset =
1228 dynamic_cast<InsetBibtex const &>(*it);
1229 inset.fillWithBibKeys(*this, keys);
1230 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1231 InsetInclude const & inset =
1232 dynamic_cast<InsetInclude const &>(*it);
1233 inset.fillWithBibKeys(*this, keys);
1234 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1235 InsetBibitem const & inset =
1236 dynamic_cast<InsetBibitem const &>(*it);
1237 string const key = inset.getContents();
1238 string const opt = inset.getOptions();
1239 string const ref; // = pit->asString(this, false);
1240 string const info = opt + "TheBibliographyRef" + ref;
1241 keys.push_back(pair<string, string>(key, info));
1247 void Buffer::updateBibfilesCache()
1249 // if this is a child document and the parent is already loaded
1250 // update the parent's cache instead
1251 Buffer * tmp = getMasterBuffer();
1254 tmp->updateBibfilesCache();
1258 bibfilesCache_.clear();
1259 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1260 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1261 InsetBibtex const & inset =
1262 dynamic_cast<InsetBibtex const &>(*it);
1263 vector<FileName> const bibfiles = inset.getFiles(*this);
1264 bibfilesCache_.insert(bibfilesCache_.end(),
1267 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1268 InsetInclude & inset =
1269 dynamic_cast<InsetInclude &>(*it);
1270 inset.updateBibfilesCache(*this);
1271 vector<FileName> const & bibfiles =
1272 inset.getBibfilesCache(*this);
1273 bibfilesCache_.insert(bibfilesCache_.end(),
1281 vector<FileName> const & Buffer::getBibfilesCache() const
1283 // if this is a child document and the parent is already loaded
1284 // use the parent's cache instead
1285 Buffer const * tmp = getMasterBuffer();
1288 return tmp->getBibfilesCache();
1290 return bibfilesCache_;
1294 bool Buffer::isDepClean(string const & name) const
1296 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1297 if (it == pimpl_->dep_clean.end())
1303 void Buffer::markDepClean(string const & name)
1305 pimpl_->dep_clean[name] = true;
1309 bool Buffer::dispatch(string const & command, bool * result)
1311 return dispatch(lyxaction.lookupFunc(command), result);
1315 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1317 bool dispatched = true;
1319 switch (func.action) {
1320 case LFUN_BUFFER_EXPORT: {
1321 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1334 void Buffer::changeLanguage(Language const * from, Language const * to)
1339 // Take care of l10n/i18n
1342 for_each(par_iterator_begin(),
1344 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1346 text().current_font.setLanguage(to);
1347 text().real_current_font.setLanguage(to);
1351 void Buffer::updateDocLang(Language const * nlang)
1353 BOOST_ASSERT(nlang);
1355 pimpl_->messages.reset(new Messages(nlang->code()));
1357 updateLabels(*this);
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, string> > keys;
1621 fillWithBibKeys(keys);
1622 vector<pair<string, string> >::const_iterator bit = keys.begin();
1623 vector<pair<string, string> >::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<std::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];