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
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "BaseClassList.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DocIterator.h"
28 #include "EmbeddedFiles.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "InsetIterator.h"
35 #include "InsetList.h"
37 #include "LaTeXFeatures.h"
41 #include "LyXAction.h"
45 #include "output_docbook.h"
47 #include "output_latex.h"
48 #include "output_plaintext.h"
49 #include "paragraph_funcs.h"
50 #include "Paragraph.h"
51 #include "ParagraphParameters.h"
52 #include "ParIterator.h"
53 #include "PDFOptions.h"
57 #include "TexStream.h"
59 #include "TextClass.h"
60 #include "TocBackend.h"
62 #include "VCBackend.h"
66 #include "insets/InsetBibitem.h"
67 #include "insets/InsetBibtex.h"
68 #include "insets/InsetInclude.h"
69 #include "insets/InsetText.h"
71 #include "mathed/MacroTable.h"
72 #include "mathed/MathMacroTemplate.h"
73 #include "mathed/MathSupport.h"
75 #include "frontends/alert.h"
76 #include "frontends/Delegates.h"
77 #include "frontends/WorkAreaManager.h"
79 #include "graphics/Previews.h"
81 #include "support/convert.h"
82 #include "support/debug.h"
83 #include "support/ExceptionMessage.h"
84 #include "support/FileName.h"
85 #include "support/FileNameList.h"
86 #include "support/filetools.h"
87 #include "support/ForkedCalls.h"
88 #include "support/gettext.h"
89 #include "support/gzstream.h"
90 #include "support/lstrings.h"
91 #include "support/lyxalgo.h"
92 #include "support/os.h"
93 #include "support/Package.h"
94 #include "support/Path.h"
95 #include "support/textutils.h"
96 #include "support/types.h"
97 #include "support/FileZipListDir.h"
99 #include <boost/bind.hpp>
100 #include <boost/shared_ptr.hpp>
109 using namespace lyx::support;
113 namespace Alert = frontend::Alert;
114 namespace os = support::os;
118 int const LYX_FORMAT = 315; // Richard Heck: column separation
123 typedef map<string, bool> DepClean;
128 Impl(Buffer & parent, FileName const & file, bool readonly);
141 mutable TexRow texrow;
142 Buffer const * parent_buffer;
144 /// need to regenerate .tex?
148 mutable bool lyx_clean;
150 /// is autosave needed?
151 mutable bool bak_clean;
153 /// is this a unnamed file (New...)?
159 /// name of the file the buffer is associated with.
162 /** Set to true only when the file is fully loaded.
163 * Used to prevent the premature generation of previews
164 * and by the citation inset.
166 bool file_fully_loaded;
168 /// our Text that should be wrapped in an InsetText
172 mutable TocBackend toc_backend;
175 typedef pair<DocIterator, MacroData> ScopeMacro;
176 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
177 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
178 NamePositionScopeMacroMap macros;
181 /// positions of child buffers in the buffer
182 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
183 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
184 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
185 BufferPositionMap children_positions;
186 PositionScopeBufferMap position_to_children;
188 /// Container for all sort of Buffer dependant errors.
189 map<string, ErrorList> errorLists;
191 /// all embedded files of this buffer
192 EmbeddedFileList embedded_files;
194 /// timestamp and checksum used to test if the file has been externally
195 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
197 unsigned long checksum_;
200 frontend::WorkAreaManager * wa_;
205 /// A cache for the bibfiles (including bibfiles of loaded child
206 /// documents), needed for appropriate update of natbib labels.
207 mutable EmbeddedFileList bibfilesCache_;
210 /// Creates the per buffer temporary directory
211 static FileName createBufferTmpDir()
214 // We are in our own directory. Why bother to mangle name?
215 // In fact I wrote this code to circumvent a problematic behaviour
216 // (bug?) of EMX mkstemp().
217 FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
218 convert<string>(count++));
220 if (!tmpfl.createDirectory(0777)) {
221 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
222 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
223 from_utf8(tmpfl.absFilename())));
229 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
230 : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
231 read_only(readonly_), filename(file), file_fully_loaded(false),
232 inset(params), toc_backend(&parent), macro_lock(false),
233 embedded_files(), timestamp_(0), checksum_(0), wa_(0),
236 temppath = createBufferTmpDir();
237 inset.setBuffer(parent);
238 inset.setAutoBreakRows(true);
239 lyxvc.setBuffer(&parent);
241 wa_ = new frontend::WorkAreaManager;
245 Buffer::Buffer(string const & file, bool readonly)
246 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
248 LYXERR(Debug::INFO, "Buffer::Buffer()");
250 d->inset.getText(0)->setMacrocontextPosition(par_iterator_begin());
256 LYXERR(Debug::INFO, "Buffer::~Buffer()");
257 // here the buffer should take care that it is
258 // saved properly, before it goes into the void.
260 // GuiView already destroyed
263 Buffer const * master = masterBuffer();
264 if (master != this && use_gui) {
265 // We are closing buf which was a child document so we
266 // must update the labels and section numbering of its master
268 updateLabels(*master);
269 master->updateMacros();
272 resetChildDocuments(false);
274 if (!d->temppath.destroyDirectory()) {
275 Alert::warning(_("Could not remove temporary directory"),
276 bformat(_("Could not remove the temporary directory %1$s"),
277 from_utf8(d->temppath.absFilename())));
280 // Remove any previewed LaTeX snippets associated with this buffer.
281 graphics::Previews::get().removeLoader(*this);
287 void Buffer::changed() const
294 frontend::WorkAreaManager & Buffer::workAreaManager() const
296 BOOST_ASSERT(d->wa_);
301 Text & Buffer::text() const
303 return const_cast<Text &>(d->inset.text_);
307 Inset & Buffer::inset() const
309 return const_cast<InsetText &>(d->inset);
313 BufferParams & Buffer::params()
319 BufferParams const & Buffer::params() const
325 ParagraphList & Buffer::paragraphs()
327 return text().paragraphs();
331 ParagraphList const & Buffer::paragraphs() const
333 return text().paragraphs();
337 LyXVC & Buffer::lyxvc()
343 LyXVC const & Buffer::lyxvc() const
349 string const Buffer::temppath() const
351 return d->temppath.absFilename();
355 TexRow const & Buffer::texrow() const
361 TocBackend & Buffer::tocBackend() const
363 return d->toc_backend;
367 EmbeddedFileList & Buffer::embeddedFiles()
369 return d->embedded_files;
373 EmbeddedFileList const & Buffer::embeddedFiles() const
375 return d->embedded_files;
379 bool Buffer::embedded() const
381 return params().embedded;
385 Undo & Buffer::undo()
391 string Buffer::latexName(bool const no_path) const
393 FileName latex_name = makeLatexName(d->filename);
394 return no_path ? latex_name.onlyFileName()
395 : latex_name.absFilename();
399 string Buffer::logName(LogType * type) const
401 string const filename = latexName(false);
403 if (filename.empty()) {
409 string const path = temppath();
411 FileName const fname(addName(temppath(),
412 onlyFilename(changeExtension(filename,
414 FileName const bname(
415 addName(path, onlyFilename(
416 changeExtension(filename,
417 formats.extension("literate") + ".out"))));
419 // If no Latex log or Build log is newer, show Build log
421 if (bname.exists() &&
422 (!fname.exists() || fname.lastModified() < bname.lastModified())) {
423 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
426 return bname.absFilename();
428 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
431 return fname.absFilename();
435 void Buffer::setReadonly(bool const flag)
437 if (d->read_only != flag) {
444 void Buffer::setFileName(string const & newfile)
446 d->filename = makeAbsPath(newfile);
447 setReadonly(d->filename.isReadOnly());
452 int Buffer::readHeader(Lexer & lex)
454 int unknown_tokens = 0;
456 int begin_header_line = -1;
458 // Initialize parameters that may be/go lacking in header:
459 params().branchlist().clear();
460 params().preamble.erase();
461 params().options.erase();
462 params().float_placement.erase();
463 params().paperwidth.erase();
464 params().paperheight.erase();
465 params().leftmargin.erase();
466 params().rightmargin.erase();
467 params().topmargin.erase();
468 params().bottommargin.erase();
469 params().headheight.erase();
470 params().headsep.erase();
471 params().footskip.erase();
472 params().columnsep.erase();
473 params().listings_params.clear();
474 params().clearLayoutModules();
475 params().pdfoptions().clear();
477 for (int i = 0; i < 4; ++i) {
478 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
479 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
482 ErrorList & errorList = d->errorLists["Parse"];
486 string const token = lex.getString();
491 if (token == "\\end_header")
495 if (token == "\\begin_header") {
496 begin_header_line = line;
500 LYXERR(Debug::PARSER, "Handling document header token: `"
503 string unknown = params().readToken(lex, token, d->filename.onlyPath());
504 if (!unknown.empty()) {
505 if (unknown[0] != '\\' && token == "\\textclass") {
506 Alert::warning(_("Unknown document class"),
507 bformat(_("Using the default document class, because the "
508 "class %1$s is unknown."), from_utf8(unknown)));
511 docstring const s = bformat(_("Unknown token: "
515 errorList.push_back(ErrorItem(_("Document header error"),
520 if (begin_header_line) {
521 docstring const s = _("\\begin_header is missing");
522 errorList.push_back(ErrorItem(_("Document header error"),
526 params().makeDocumentClass();
528 return unknown_tokens;
533 // changed to be public and have one parameter
534 // Returns false if "\end_document" is not read (Asger)
535 bool Buffer::readDocument(Lexer & lex)
537 ErrorList & errorList = d->errorLists["Parse"];
541 string const token = lex.getString();
542 if (token != "\\begin_document") {
543 docstring const s = _("\\begin_document is missing");
544 errorList.push_back(ErrorItem(_("Document header error"),
548 // we are reading in a brand new document
549 BOOST_ASSERT(paragraphs().empty());
553 if (params().outputChanges) {
554 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
555 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
556 LaTeXFeatures::isAvailable("xcolor");
558 if (!dvipost && !xcolorsoul) {
559 Alert::warning(_("Changes not shown in LaTeX output"),
560 _("Changes will not be highlighted in LaTeX output, "
561 "because neither dvipost nor xcolor/soul are installed.\n"
562 "Please install these packages or redefine "
563 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
564 } else if (!xcolorsoul) {
565 Alert::warning(_("Changes not shown in LaTeX output"),
566 _("Changes will not be highlighted in LaTeX output "
567 "when using pdflatex, because xcolor and soul are not installed.\n"
568 "Please install both packages or redefine "
569 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
574 bool const res = text().read(*this, lex, errorList, &(d->inset));
577 updateMacroInstances();
582 // needed to insert the selection
583 void Buffer::insertStringAsLines(ParagraphList & pars,
584 pit_type & pit, pos_type & pos,
585 Font const & fn, docstring const & str, bool autobreakrows)
589 // insert the string, don't insert doublespace
590 bool space_inserted = true;
591 for (docstring::const_iterator cit = str.begin();
592 cit != str.end(); ++cit) {
593 Paragraph & par = pars[pit];
595 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
596 breakParagraph(params(), pars, pit, pos,
597 par.layout()->isEnvironment());
600 space_inserted = true;
604 // do not insert consecutive spaces if !free_spacing
605 } else if ((*cit == ' ' || *cit == '\t') &&
606 space_inserted && !par.isFreeSpacing()) {
608 } else if (*cit == '\t') {
609 if (!par.isFreeSpacing()) {
610 // tabs are like spaces here
611 par.insertChar(pos, ' ', font, params().trackChanges);
613 space_inserted = true;
615 const pos_type n = 8 - pos % 8;
616 for (pos_type i = 0; i < n; ++i) {
617 par.insertChar(pos, ' ', font, params().trackChanges);
620 space_inserted = true;
622 } else if (!isPrintable(*cit)) {
623 // Ignore unprintables
626 // just insert the character
627 par.insertChar(pos, *cit, font, params().trackChanges);
629 space_inserted = (*cit == ' ');
636 bool Buffer::readString(string const & s)
638 params().compressed = false;
640 // remove dummy empty par
641 paragraphs().clear();
645 FileName const name = FileName::tempName();
646 switch (readFile(lex, name, true)) {
650 // We need to call lyx2lyx, so write the input to a file
651 ofstream os(name.toFilesystemEncoding().c_str());
654 return readFile(name);
664 bool Buffer::readFile(FileName const & filename)
666 FileName fname(filename);
667 // Check if the file is compressed.
668 string format = filename.guessFormatFromContents();
669 if (format == "zip") {
670 // decompress to a temp directory
671 LYXERR(Debug::FILES, filename << " is in zip format. Unzip to " << temppath());
672 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
674 FileName lyxfile(addName(temppath(), "content.lyx"));
675 // if both manifest.txt and file.lyx exist, this is am embedded file
676 if (lyxfile.exists()) {
677 // if in bundled format, save checksum of the compressed file, not content.lyx
678 saveCheckSum(filename);
679 params().embedded = true;
683 // The embedded lyx file can also be compressed, for backward compatibility
684 format = fname.guessFormatFromContents();
685 if (format == "gzip" || format == "zip" || format == "compress")
686 params().compressed = true;
688 // remove dummy empty par
689 paragraphs().clear();
692 if (readFile(lex, fname) != success)
699 bool Buffer::isFullyLoaded() const
701 return d->file_fully_loaded;
705 void Buffer::setFullyLoaded(bool value)
707 d->file_fully_loaded = value;
711 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
714 BOOST_ASSERT(!filename.empty());
717 Alert::error(_("Document could not be read"),
718 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
723 string const token = lex.getString();
726 Alert::error(_("Document could not be read"),
727 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
731 // the first token _must_ be...
732 if (token != "\\lyxformat") {
733 lyxerr << "Token: " << token << endl;
735 Alert::error(_("Document format failure"),
736 bformat(_("%1$s is not a LyX document."),
737 from_utf8(filename.absFilename())));
742 string tmp_format = lex.getString();
743 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
744 // if present remove ".," from string.
745 string::size_type dot = tmp_format.find_first_of(".,");
746 //lyxerr << " dot found at " << dot << endl;
747 if (dot != string::npos)
748 tmp_format.erase(dot, 1);
749 int const file_format = convert<int>(tmp_format);
750 //lyxerr << "format: " << file_format << endl;
752 // save timestamp and checksum of the original disk file, making sure
753 // to not overwrite them with those of the file created in the tempdir
754 // when it has to be converted to the current format.
756 // Save the timestamp and checksum of disk file. If filename is an
757 // emergency file, save the timestamp and checksum of the original lyx file
758 // because isExternallyModified will check for this file. (BUG4193)
759 string diskfile = filename.absFilename();
760 if (suffixIs(diskfile, ".emergency"))
761 diskfile = diskfile.substr(0, diskfile.size() - 10);
762 saveCheckSum(FileName(diskfile));
765 if (file_format != LYX_FORMAT) {
768 // lyx2lyx would fail
771 FileName const tmpfile = FileName::tempName();
772 if (tmpfile.empty()) {
773 Alert::error(_("Conversion failed"),
774 bformat(_("%1$s is from a different"
775 " version of LyX, but a temporary"
776 " file for converting it could"
778 from_utf8(filename.absFilename())));
781 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
782 if (lyx2lyx.empty()) {
783 Alert::error(_("Conversion script not found"),
784 bformat(_("%1$s is from a different"
785 " version of LyX, but the"
786 " conversion script lyx2lyx"
787 " could not be found."),
788 from_utf8(filename.absFilename())));
791 ostringstream command;
792 command << os::python()
793 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
794 << " -t " << convert<string>(LYX_FORMAT)
795 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
796 << ' ' << quoteName(filename.toFilesystemEncoding());
797 string const command_str = command.str();
799 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
801 cmd_ret const ret = runCommand(command_str);
802 if (ret.first != 0) {
803 Alert::error(_("Conversion script failed"),
804 bformat(_("%1$s is from a different version"
805 " of LyX, but the lyx2lyx script"
806 " failed to convert it."),
807 from_utf8(filename.absFilename())));
810 bool const ret = readFile(tmpfile);
811 // Do stuff with tmpfile name and buffer name here.
812 return ret ? success : failure;
817 if (readDocument(lex)) {
818 Alert::error(_("Document format failure"),
819 bformat(_("%1$s ended unexpectedly, which means"
820 " that it is probably corrupted."),
821 from_utf8(filename.absFilename())));
824 d->file_fully_loaded = true;
829 // Should probably be moved to somewhere else: BufferView? LyXView?
830 bool Buffer::save() const
832 // We don't need autosaves in the immediate future. (Asger)
833 resetAutosaveTimers();
835 string const encodedFilename = d->filename.toFilesystemEncoding();
838 bool madeBackup = false;
840 // make a backup if the file already exists
841 if (lyxrc.make_backup && fileName().exists()) {
842 backupName = FileName(absFileName() + '~');
843 if (!lyxrc.backupdir_path.empty()) {
844 string const mangledName =
845 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
846 backupName = FileName(addName(lyxrc.backupdir_path,
849 if (fileName().copyTo(backupName)) {
852 Alert::error(_("Backup failure"),
853 bformat(_("Cannot create backup file %1$s.\n"
854 "Please check whether the directory exists and is writeable."),
855 from_utf8(backupName.absFilename())));
856 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
860 // ask if the disk file has been externally modified (use checksum method)
861 if (fileName().exists() && isExternallyModified(checksum_method)) {
862 docstring const file = makeDisplayPath(absFileName(), 20);
863 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
864 "you want to overwrite this file?"), file);
865 int const ret = Alert::prompt(_("Overwrite modified file?"),
866 text, 1, 1, _("&Overwrite"), _("&Cancel"));
871 if (writeFile(d->filename)) {
875 // Saving failed, so backup is not backup
877 backupName.moveTo(d->filename);
883 bool Buffer::writeFile(FileName const & fname) const
885 if (d->read_only && fname == d->filename)
891 if (params().embedded)
892 // first write the .lyx file to the temporary directory
893 content = FileName(addName(temppath(), "content.lyx"));
897 docstring const str = bformat(_("Saving document %1$s..."),
898 makeDisplayPath(content.absFilename()));
901 if (params().compressed) {
902 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
903 retval = ofs && write(ofs);
905 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
906 retval = ofs && write(ofs);
910 message(str + _(" could not write file!."));
914 removeAutosaveFile(d->filename.absFilename());
916 if (params().embedded) {
917 message(str + _(" writing embedded files!."));
918 // if embedding is enabled, write file.lyx and all the embedded files
919 // to the zip file fname.
920 if (!d->embedded_files.writeFile(fname, *this)) {
921 message(str + _(" could not write embedded files!."));
925 saveCheckSum(d->filename);
926 message(str + _(" done."));
932 bool Buffer::write(ostream & ofs) const
935 // Use the standard "C" locale for file output.
936 ofs.imbue(locale::classic());
939 // The top of the file should not be written by params().
941 // write out a comment in the top of the file
942 ofs << "#LyX " << lyx_version
943 << " created this file. For more info see http://www.lyx.org/\n"
944 << "\\lyxformat " << LYX_FORMAT << "\n"
945 << "\\begin_document\n";
947 /// For each author, set 'used' to true if there is a change
948 /// by this author in the document; otherwise set it to 'false'.
949 AuthorList::Authors::const_iterator a_it = params().authors().begin();
950 AuthorList::Authors::const_iterator a_end = params().authors().end();
951 for (; a_it != a_end; ++a_it)
952 a_it->second.setUsed(false);
954 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
955 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
956 for ( ; it != end; ++it)
957 it->checkAuthors(params().authors());
959 // now write out the buffer parameters.
960 ofs << "\\begin_header\n";
961 params().writeFile(ofs);
962 ofs << "\\end_header\n";
965 ofs << "\n\\begin_body\n";
966 text().write(*this, ofs);
967 ofs << "\n\\end_body\n";
969 // Write marker that shows file is complete
970 ofs << "\\end_document" << endl;
972 // Shouldn't really be needed....
975 // how to check if close went ok?
976 // Following is an attempt... (BE 20001011)
978 // good() returns false if any error occured, including some
980 // bad() returns true if something bad happened in the buffer,
981 // which should include file system full errors.
986 lyxerr << "File was not closed properly." << endl;
993 bool Buffer::makeLaTeXFile(FileName const & fname,
994 string const & original_path,
995 OutputParams const & runparams,
996 bool output_preamble, bool output_body) const
998 string const encoding = runparams.encoding->iconvName();
999 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1002 try { ofs.reset(encoding); }
1003 catch (iconv_codecvt_facet_exception & e) {
1004 lyxerr << "Caught iconv exception: " << e.what() << endl;
1005 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1006 "verify that the support software for your encoding (%1$s) is "
1007 "properly installed"), from_ascii(encoding)));
1010 if (!openFileWrite(ofs, fname))
1013 //TexStream ts(ofs.rdbuf(), &texrow());
1014 ErrorList & errorList = d->errorLists["Export"];
1016 bool failed_export = false;
1019 writeLaTeXSource(ofs, original_path,
1020 runparams, output_preamble, output_body);
1022 catch (EncodingException & e) {
1023 odocstringstream ods;
1024 ods.put(e.failed_char);
1026 oss << "0x" << hex << e.failed_char << dec;
1027 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1028 " (code point %2$s)"),
1029 ods.str(), from_utf8(oss.str()));
1030 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1031 "representable in the chosen encoding.\n"
1032 "Changing the document encoding to utf8 could help."),
1033 e.par_id, e.pos, e.pos + 1));
1034 failed_export = true;
1036 catch (iconv_codecvt_facet_exception & e) {
1037 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1038 _(e.what()), -1, 0, 0));
1039 failed_export = true;
1041 catch (exception const & e) {
1042 errorList.push_back(ErrorItem(_("conversion failed"),
1043 _(e.what()), -1, 0, 0));
1044 failed_export = true;
1047 lyxerr << "Caught some really weird exception..." << endl;
1048 LyX::cref().exit(1);
1053 failed_export = true;
1054 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1058 return !failed_export;
1062 void Buffer::writeLaTeXSource(odocstream & os,
1063 string const & original_path,
1064 OutputParams const & runparams_in,
1065 bool const output_preamble, bool const output_body) const
1067 OutputParams runparams = runparams_in;
1069 // validate the buffer.
1070 LYXERR(Debug::LATEX, " Validating buffer...");
1071 LaTeXFeatures features(*this, params(), runparams);
1073 LYXERR(Debug::LATEX, " Buffer validation done.");
1075 // The starting paragraph of the coming rows is the
1076 // first paragraph of the document. (Asger)
1077 if (output_preamble && runparams.nice) {
1078 os << "%% LyX " << lyx_version << " created this file. "
1079 "For more info, see http://www.lyx.org/.\n"
1080 "%% Do not edit unless you really know what "
1082 d->texrow.newline();
1083 d->texrow.newline();
1085 LYXERR(Debug::INFO, "lyx document header finished");
1086 // There are a few differences between nice LaTeX and usual files:
1087 // usual is \batchmode and has a
1088 // special input@path to allow the including of figures
1089 // with either \input or \includegraphics (what figinsets do).
1090 // input@path is set when the actual parameter
1091 // original_path is set. This is done for usual tex-file, but not
1092 // for nice-latex-file. (Matthias 250696)
1093 // Note that input@path is only needed for something the user does
1094 // in the preamble, included .tex files or ERT, files included by
1095 // LyX work without it.
1096 if (output_preamble) {
1097 if (!runparams.nice) {
1098 // code for usual, NOT nice-latex-file
1099 os << "\\batchmode\n"; // changed
1100 // from \nonstopmode
1101 d->texrow.newline();
1103 if (!original_path.empty()) {
1105 // We don't know the encoding of inputpath
1106 docstring const inputpath = from_utf8(latex_path(original_path));
1107 os << "\\makeatletter\n"
1108 << "\\def\\input@path{{"
1109 << inputpath << "/}}\n"
1110 << "\\makeatother\n";
1111 d->texrow.newline();
1112 d->texrow.newline();
1113 d->texrow.newline();
1116 // Write the preamble
1117 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1123 os << "\\begin{document}\n";
1124 d->texrow.newline();
1125 } // output_preamble
1127 d->texrow.start(paragraphs().begin()->id(), 0);
1129 LYXERR(Debug::INFO, "preamble finished, now the body.");
1131 // load children, if not already done.
1132 // This includes an updateMacro() call.
1133 // Don't move this behind the parent_buffer=0 code below,
1134 // because then the macros will not get the right "redefinition"
1135 // flag as they don't see the parent macros which are output before.
1136 loadChildDocuments();
1138 // fold macros if possible, still with parent buffer as the
1139 // macros will be put in the prefix anyway.
1140 updateMacroInstances();
1142 // if we are doing a real file with body, even if this is the
1143 // child of some other buffer, let's cut the link here.
1144 // This happens for example if only a child document is printed.
1145 Buffer const * save_parent = 0;
1146 if (output_preamble) {
1147 // output the macros visible for this buffer
1148 writeParentMacros(os);
1150 save_parent = d->parent_buffer;
1151 d->parent_buffer = 0;
1155 latexParagraphs(*this, text(), os, d->texrow, runparams);
1157 // Restore the parenthood if needed
1158 if (output_preamble) {
1159 d->parent_buffer = save_parent;
1161 // restore macros with correct parent buffer (especially
1162 // important for the redefinition flag which depends on the
1167 // add this just in case after all the paragraphs
1169 d->texrow.newline();
1171 if (output_preamble) {
1172 os << "\\end{document}\n";
1173 d->texrow.newline();
1174 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1176 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1178 runparams_in.encoding = runparams.encoding;
1180 // Just to be sure. (Asger)
1181 d->texrow.newline();
1183 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1184 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1188 bool Buffer::isLatex() const
1190 return params().documentClass().outputType() == LATEX;
1194 bool Buffer::isLiterate() const
1196 return params().documentClass().outputType() == LITERATE;
1200 bool Buffer::isDocBook() const
1202 return params().documentClass().outputType() == DOCBOOK;
1206 void Buffer::makeDocBookFile(FileName const & fname,
1207 OutputParams const & runparams,
1208 bool const body_only) const
1210 LYXERR(Debug::LATEX, "makeDocBookFile...");
1213 if (!openFileWrite(ofs, fname))
1216 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1220 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1224 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1225 OutputParams const & runparams,
1226 bool const only_body) const
1228 LaTeXFeatures features(*this, params(), runparams);
1233 DocumentClass const & tclass = params().documentClass();
1234 string const top_element = tclass.latexname();
1237 if (runparams.flavor == OutputParams::XML)
1238 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1241 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1244 if (! tclass.class_header().empty())
1245 os << from_ascii(tclass.class_header());
1246 else if (runparams.flavor == OutputParams::XML)
1247 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1248 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1250 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1252 docstring preamble = from_utf8(params().preamble);
1253 if (runparams.flavor != OutputParams::XML ) {
1254 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1255 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1256 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1257 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1260 string const name = runparams.nice
1261 ? changeExtension(absFileName(), ".sgml") : fname;
1262 preamble += features.getIncludedFiles(name);
1263 preamble += features.getLyXSGMLEntities();
1265 if (!preamble.empty()) {
1266 os << "\n [ " << preamble << " ]";
1271 string top = top_element;
1273 if (runparams.flavor == OutputParams::XML)
1274 top += params().language->code();
1276 top += params().language->code().substr(0,2);
1279 if (!params().options.empty()) {
1281 top += params().options;
1284 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1285 << " file was created by LyX " << lyx_version
1286 << "\n See http://www.lyx.org/ for more information -->\n";
1288 params().documentClass().counters().reset();
1290 loadChildDocuments();
1292 sgml::openTag(os, top);
1294 docbookParagraphs(paragraphs(), *this, os, runparams);
1295 sgml::closeTag(os, top_element);
1299 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1300 // Other flags: -wall -v0 -x
1301 int Buffer::runChktex()
1305 // get LaTeX-Filename
1306 FileName const path(temppath());
1307 string const name = addName(path.absFilename(), latexName());
1308 string const org_path = filePath();
1310 PathChanger p(path); // path to LaTeX file
1311 message(_("Running chktex..."));
1313 // Generate the LaTeX file if neccessary
1314 OutputParams runparams(¶ms().encoding());
1315 runparams.flavor = OutputParams::LATEX;
1316 runparams.nice = false;
1317 makeLaTeXFile(FileName(name), org_path, runparams);
1320 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1321 int const res = chktex.run(terr); // run chktex
1324 Alert::error(_("chktex failure"),
1325 _("Could not run chktex successfully."));
1326 } else if (res > 0) {
1327 ErrorList & errlist = d->errorLists["ChkTeX"];
1329 bufferErrors(terr, errlist);
1340 void Buffer::validate(LaTeXFeatures & features) const
1342 params().validate(features);
1344 loadChildDocuments();
1346 for_each(paragraphs().begin(), paragraphs().end(),
1347 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1349 if (lyxerr.debugging(Debug::LATEX)) {
1350 features.showStruct();
1355 void Buffer::getLabelList(vector<docstring> & list) const
1357 /// if this is a child document and the parent is already loaded
1358 /// Use the parent's list instead [ale990407]
1359 Buffer const * tmp = masterBuffer();
1361 lyxerr << "masterBuffer() failed!" << endl;
1365 tmp->getLabelList(list);
1369 loadChildDocuments();
1371 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1372 it.nextInset()->getLabelList(list);
1376 void Buffer::updateBibfilesCache() const
1378 // if this is a child document and the parent is already loaded
1379 // update the parent's cache instead
1380 Buffer const * tmp = masterBuffer();
1383 tmp->updateBibfilesCache();
1387 d->bibfilesCache_.clear();
1388 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1389 if (it->lyxCode() == BIBTEX_CODE) {
1390 InsetBibtex const & inset =
1391 static_cast<InsetBibtex const &>(*it);
1392 EmbeddedFileList const bibfiles = inset.embeddedFiles();
1393 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1396 } else if (it->lyxCode() == INCLUDE_CODE) {
1397 InsetInclude & inset =
1398 static_cast<InsetInclude &>(*it);
1399 inset.updateBibfilesCache();
1400 EmbeddedFileList const & bibfiles =
1401 inset.getBibfilesCache(*this);
1402 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1410 EmbeddedFileList const & Buffer::getBibfilesCache() const
1412 // if this is a child document and the parent is already loaded
1413 // use the parent's cache instead
1414 Buffer const * tmp = masterBuffer();
1417 return tmp->getBibfilesCache();
1419 // We update the cache when first used instead of at loading time.
1420 if (d->bibfilesCache_.empty())
1421 const_cast<Buffer *>(this)->updateBibfilesCache();
1423 return d->bibfilesCache_;
1427 bool Buffer::isDepClean(string const & name) const
1429 DepClean::const_iterator const it = d->dep_clean.find(name);
1430 if (it == d->dep_clean.end())
1436 void Buffer::markDepClean(string const & name)
1438 d->dep_clean[name] = true;
1442 bool Buffer::dispatch(string const & command, bool * result)
1444 return dispatch(lyxaction.lookupFunc(command), result);
1448 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1450 bool dispatched = true;
1452 switch (func.action) {
1453 case LFUN_BUFFER_EXPORT: {
1454 bool const tmp = doExport(to_utf8(func.argument()), false);
1467 void Buffer::changeLanguage(Language const * from, Language const * to)
1472 for_each(par_iterator_begin(),
1474 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1478 bool Buffer::isMultiLingual() const
1480 ParConstIterator end = par_iterator_end();
1481 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1482 if (it->isMultiLingual(params()))
1489 DocIterator Buffer::getParFromID(int const id) const
1492 // John says this is called with id == -1 from undo
1493 lyxerr << "getParFromID(), id: " << id << endl;
1494 return doc_iterator_end(inset());
1497 for (DocIterator it = doc_iterator_begin(inset()); !it.atEnd(); it.forwardPar())
1498 if (it.paragraph().id() == id)
1501 return doc_iterator_end(inset());
1505 bool Buffer::hasParWithID(int const id) const
1507 return !getParFromID(id).atEnd();
1511 ParIterator Buffer::par_iterator_begin()
1513 return ParIterator(doc_iterator_begin(inset()));
1517 ParIterator Buffer::par_iterator_end()
1519 return ParIterator(doc_iterator_end(inset()));
1523 ParConstIterator Buffer::par_iterator_begin() const
1525 return lyx::par_const_iterator_begin(inset());
1529 ParConstIterator Buffer::par_iterator_end() const
1531 return lyx::par_const_iterator_end(inset());
1535 Language const * Buffer::language() const
1537 return params().language;
1541 docstring const Buffer::B_(string const & l10n) const
1543 return params().B_(l10n);
1547 bool Buffer::isClean() const
1549 return d->lyx_clean;
1553 bool Buffer::isBakClean() const
1555 return d->bak_clean;
1559 bool Buffer::isExternallyModified(CheckMethod method) const
1561 BOOST_ASSERT(d->filename.exists());
1562 // if method == timestamp, check timestamp before checksum
1563 return (method == checksum_method
1564 || d->timestamp_ != d->filename.lastModified())
1565 && d->checksum_ != d->filename.checksum();
1569 void Buffer::saveCheckSum(FileName const & file) const
1571 if (file.exists()) {
1572 d->timestamp_ = file.lastModified();
1573 d->checksum_ = file.checksum();
1575 // in the case of save to a new file.
1582 void Buffer::markClean() const
1584 if (!d->lyx_clean) {
1585 d->lyx_clean = true;
1588 // if the .lyx file has been saved, we don't need an
1590 d->bak_clean = true;
1594 void Buffer::markBakClean() const
1596 d->bak_clean = true;
1600 void Buffer::setUnnamed(bool flag)
1606 bool Buffer::isUnnamed() const
1612 // FIXME: this function should be moved to buffer_pimpl.C
1613 void Buffer::markDirty()
1616 d->lyx_clean = false;
1619 d->bak_clean = false;
1621 DepClean::iterator it = d->dep_clean.begin();
1622 DepClean::const_iterator const end = d->dep_clean.end();
1624 for (; it != end; ++it)
1629 FileName Buffer::fileName() const
1635 string Buffer::absFileName() const
1637 return d->filename.absFilename();
1641 string Buffer::filePath() const
1643 return d->filename.onlyPath().absFilename() + "/";
1647 bool Buffer::isReadonly() const
1649 return d->read_only;
1653 void Buffer::setParent(Buffer const * buffer)
1655 // Avoids recursive include.
1656 d->parent_buffer = buffer == this ? 0 : buffer;
1661 Buffer const * Buffer::parent()
1663 return d->parent_buffer;
1667 Buffer const * Buffer::masterBuffer() const
1669 if (!d->parent_buffer)
1672 return d->parent_buffer->masterBuffer();
1676 template<typename M>
1677 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
1682 typename M::iterator it = m.lower_bound(x);
1683 if (it == m.begin())
1691 MacroData const * Buffer::getBufferMacro(docstring const & name,
1692 DocIterator const & pos) const
1694 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
1696 // if paragraphs have no macro context set, pos will be empty
1700 // we haven't found anything yet
1701 DocIterator bestPos = par_iterator_begin();
1702 MacroData const * bestData = 0;
1704 // find macro definitions for name
1705 Impl::NamePositionScopeMacroMap::iterator nameIt
1706 = d->macros.find(name);
1707 if (nameIt != d->macros.end()) {
1708 // find last definition in front of pos or at pos itself
1709 Impl::PositionScopeMacroMap::const_iterator it
1710 = greatest_below(nameIt->second, pos);
1711 if (it != nameIt->second.end()) {
1713 // scope ends behind pos?
1714 if (pos < it->second.first) {
1715 // Looks good, remember this. If there
1716 // is no external macro behind this,
1717 // we found the right one already.
1718 bestPos = it->first;
1719 bestData = &it->second.second;
1723 // try previous macro if there is one
1724 if (it == nameIt->second.begin())
1731 // find macros in included files
1732 Impl::PositionScopeBufferMap::const_iterator it
1733 = greatest_below(d->position_to_children, pos);
1734 if (it == d->position_to_children.end())
1735 // no children before
1739 // do we know something better (i.e. later) already?
1740 if (it->first < bestPos )
1743 // scope ends behind pos?
1744 if (pos < it->second.first) {
1745 // look for macro in external file
1746 d->macro_lock = true;
1747 MacroData const * data
1748 = it->second.second->getMacro(name, false);
1749 d->macro_lock = false;
1751 bestPos = it->first;
1757 // try previous file if there is one
1758 if (it == d->position_to_children.begin())
1763 // return the best macro we have found
1768 MacroData const * Buffer::getMacro(docstring const & name,
1769 DocIterator const & pos, bool global) const
1774 // query buffer macros
1775 MacroData const * data = getBufferMacro(name, pos);
1779 // If there is a master buffer, query that
1780 if (d->parent_buffer) {
1781 d->macro_lock = true;
1782 MacroData const * macro
1783 = d->parent_buffer->getMacro(name, *this, false);
1784 d->macro_lock = false;
1790 data = MacroTable::globalMacros().get(name);
1799 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
1801 // set scope end behind the last paragraph
1802 DocIterator scope = par_iterator_begin();
1803 scope.pit() = scope.lastpit() + 1;
1805 return getMacro(name, scope, global);
1809 MacroData const * Buffer::getMacro(docstring const & name, Buffer const & child, bool global) const
1811 // look where the child buffer is included first
1812 Impl::BufferPositionMap::iterator it
1813 = d->children_positions.find(&child);
1814 if (it == d->children_positions.end())
1817 // check for macros at the inclusion position
1818 return getMacro(name, it->second, global);
1822 void Buffer::updateEnvironmentMacros(DocIterator & it,
1824 DocIterator & scope) const
1826 Paragraph & par = it.paragraph();
1828 = par.params().depth();
1829 Length const & leftIndent
1830 = par.params().leftIndent();
1832 // look for macros in each paragraph
1833 while (it.pit() <= lastpit) {
1834 Paragraph & par = it.paragraph();
1837 if ((par.params().depth() > depth
1838 || par.params().leftIndent() != leftIndent)
1839 && par.layout()->isEnvironment()) {
1840 updateBlockMacros(it, scope);
1844 // iterate over the insets of the current paragraph
1845 InsetList const & insets = par.insetList();
1846 InsetList::const_iterator iit = insets.begin();
1847 InsetList::const_iterator end = insets.end();
1848 for (; iit != end; ++iit) {
1849 it.pos() = iit->pos;
1851 // is it a nested text inset?
1852 if (iit->inset->asInsetText()) {
1853 // Inset needs its own scope?
1854 InsetText const * itext
1855 = iit->inset->asInsetText();
1856 bool newScope = itext->isMacroScope();
1858 // scope which ends just behind the inset
1859 DocIterator insetScope = it;
1862 // collect macros in inset
1863 it.push_back(CursorSlice(*iit->inset));
1864 updateInsetMacros(it, newScope ? insetScope : scope);
1869 // is it an external file?
1870 if (iit->inset->lyxCode() == INCLUDE_CODE) {
1871 // get buffer of external file
1872 InsetCommand const & inset
1873 = static_cast<InsetCommand const &>(*iit->inset);
1874 InsetCommandParams const & ip = inset.params();
1875 d->macro_lock = true;
1876 Buffer * child = loadIfNeeded(*this, ip);
1877 d->macro_lock = false;
1881 // register its position, but only when it is
1882 // included first in the buffer
1883 if (d->children_positions.find(child)
1884 == d->children_positions.end())
1885 d->children_positions[child] = it;
1887 // register child with its scope
1888 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
1893 if (iit->inset->lyxCode() != MATHMACRO_CODE)
1897 MathMacroTemplate & macroTemplate
1898 = static_cast<MathMacroTemplate &>(*iit->inset);
1899 MacroContext mc(*this, it);
1900 macroTemplate.updateToContext(mc);
1903 bool valid = macroTemplate.validMacro();
1904 // FIXME: Should be fixNameAndCheckIfValid() in fact,
1905 // then the BufferView's cursor will be invalid in
1906 // some cases which leads to crashes.
1911 d->macros[macroTemplate.name()][it]
1912 = Impl::ScopeMacro(scope, MacroData(*this, it));
1922 void Buffer::updateBlockMacros(DocIterator & it, DocIterator & scope) const
1924 Paragraph & par = it.paragraph();
1926 // set scope for macros in this paragraph:
1927 // * either the "old" outer scope
1928 // * or the scope ending after the environment
1929 if (par.layout()->isEnvironment()) {
1930 // find end of environment block,
1931 DocIterator envEnd = it;
1932 pit_type n = it.lastpit() + 1;
1933 depth_type depth = par.params().depth();
1934 Length const & length = par.params().leftIndent();
1935 // looping through the paragraph, basically until
1936 // the layout changes or the depth gets smaller.
1937 // (the logic of output_latex.cpp's TeXEnvironment)
1940 if (envEnd.pit() == n)
1942 } while (par.layout() == envEnd.paragraph().layout()
1943 || depth < envEnd.paragraph().params().depth()
1944 || length != envEnd.paragraph().params().leftIndent());
1946 // collect macros from environment block
1947 updateEnvironmentMacros(it, envEnd.pit() - 1, envEnd);
1949 // collect macros from paragraph
1950 updateEnvironmentMacros(it, it.pit(), scope);
1955 void Buffer::updateInsetMacros(DocIterator & it, DocIterator & scope) const
1957 // look for macros in each paragraph
1958 pit_type n = it.lastpit() + 1;
1959 while (it.pit() < n)
1960 updateBlockMacros(it, scope);
1964 void Buffer::updateMacros() const
1969 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
1971 // start with empty table
1973 d->children_positions.clear();
1974 d->position_to_children.clear();
1976 // Iterate over buffer, starting with first paragraph
1977 // The scope must be bigger than any lookup DocIterator
1978 // later. For the global lookup, lastpit+1 is used, hence
1979 // we use lastpit+2 here.
1980 DocIterator it = par_iterator_begin();
1981 DocIterator outerScope = it;
1982 outerScope.pit() = outerScope.lastpit() + 2;
1983 updateInsetMacros(it, outerScope);
1987 void Buffer::updateMacroInstances() const
1989 LYXERR(Debug::MACROS, "updateMacroInstances for "
1990 << d->filename.onlyFileName());
1991 DocIterator it = doc_iterator_begin(inset());
1992 DocIterator end = doc_iterator_end(inset());
1993 for (; it != end; it.forwardPos()) {
1994 // look for MathData cells in InsetMathNest insets
1995 Inset * inset = it.nextInset();
1999 InsetMath * minset = inset->asInsetMath();
2003 // update macro in all cells of the InsetMathNest
2004 DocIterator::idx_type n = minset->nargs();
2005 MacroContext mc = MacroContext(*this, it);
2006 for (DocIterator::idx_type i = 0; i < n; ++i) {
2007 MathData & data = minset->cell(i);
2008 data.updateMacros(0, mc);
2014 void Buffer::listMacroNames(MacroNameSet & macros) const
2019 d->macro_lock = true;
2021 // loop over macro names
2022 Impl::NamePositionScopeMacroMap::iterator nameIt
2023 = d->macros.begin();
2024 Impl::NamePositionScopeMacroMap::iterator nameEnd
2026 for (; nameIt != nameEnd; ++nameIt)
2027 macros.insert(nameIt->first);
2029 // loop over children
2030 Impl::BufferPositionMap::iterator it
2031 = d->children_positions.begin();
2032 Impl::BufferPositionMap::iterator end
2033 = d->children_positions.end();
2034 for (; it != end; ++it)
2035 it->first->listMacroNames(macros);
2038 if (d->parent_buffer)
2039 d->parent_buffer->listMacroNames(macros);
2041 d->macro_lock = false;
2045 void Buffer::writeParentMacros(odocstream & os) const
2047 if (!d->parent_buffer)
2050 // collect macro names
2052 d->parent_buffer->listMacroNames(names);
2054 // resolve and output them
2055 MacroNameSet::iterator it = names.begin();
2056 MacroNameSet::iterator end = names.end();
2057 for (; it != end; ++it) {
2059 MacroData const * data =
2060 d->parent_buffer->getMacro(*it, *this, false);
2062 data->write(os, true);
2067 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2070 //FIXME: This does not work for child documents yet.
2071 BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
2072 // Check if the label 'from' appears more than once
2073 vector<docstring> labels;
2076 if (code == CITE_CODE) {
2078 keys.fillWithBibKeys(this);
2079 BiblioInfo::const_iterator bit = keys.begin();
2080 BiblioInfo::const_iterator bend = keys.end();
2082 for (; bit != bend; ++bit)
2084 labels.push_back(bit->first);
2087 getLabelList(labels);
2088 paramName = "reference";
2091 if (count(labels.begin(), labels.end(), from) > 1)
2094 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2095 if (it->lyxCode() == code) {
2096 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2097 docstring const oldValue = inset.getParam(paramName);
2098 if (oldValue == from)
2099 inset.setParam(paramName, to);
2105 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2106 pit_type par_end, bool full_source)
2108 OutputParams runparams(¶ms().encoding());
2109 runparams.nice = true;
2110 runparams.flavor = OutputParams::LATEX;
2111 runparams.linelen = lyxrc.plaintext_linelen;
2112 // No side effect of file copying and image conversion
2113 runparams.dryrun = true;
2117 os << "% " << _("Preview source code") << "\n\n";
2118 d->texrow.newline();
2119 d->texrow.newline();
2121 writeLaTeXSource(os, filePath(), runparams, true, true);
2123 writeDocBookSource(os, absFileName(), runparams, false);
2126 runparams.par_begin = par_begin;
2127 runparams.par_end = par_end;
2128 if (par_begin + 1 == par_end)
2130 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2134 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2135 convert<docstring>(par_begin),
2136 convert<docstring>(par_end - 1))
2138 d->texrow.newline();
2139 d->texrow.newline();
2140 // output paragraphs
2142 latexParagraphs(*this, text(), os, d->texrow, runparams);
2145 docbookParagraphs(paragraphs(), *this, os, runparams);
2151 ErrorList & Buffer::errorList(string const & type) const
2153 static ErrorList emptyErrorList;
2154 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2155 if (I == d->errorLists.end())
2156 return emptyErrorList;
2162 void Buffer::structureChanged() const
2165 gui_->structureChanged();
2169 void Buffer::errors(string const & err) const
2176 void Buffer::message(docstring const & msg) const
2183 void Buffer::setBusy(bool on) const
2190 void Buffer::setReadOnly(bool on) const
2193 d->wa_->setReadOnly(on);
2197 void Buffer::updateTitles() const
2200 d->wa_->updateTitles();
2204 void Buffer::resetAutosaveTimers() const
2207 gui_->resetAutosaveTimers();
2211 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2220 class AutoSaveBuffer : public ForkedProcess {
2223 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2224 : buffer_(buffer), fname_(fname) {}
2226 virtual boost::shared_ptr<ForkedProcess> clone() const
2228 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2233 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2234 from_utf8(fname_.absFilename())));
2235 return run(DontWait);
2239 virtual int generateChild();
2241 Buffer const & buffer_;
2246 int AutoSaveBuffer::generateChild()
2248 // tmp_ret will be located (usually) in /tmp
2249 // will that be a problem?
2250 // Note that this calls ForkedCalls::fork(), so it's
2251 // ok cross-platform.
2252 pid_t const pid = fork();
2253 // If you want to debug the autosave
2254 // you should set pid to -1, and comment out the fork.
2255 if (pid != 0 && pid != -1)
2258 // pid = -1 signifies that lyx was unable
2259 // to fork. But we will do the save
2261 bool failed = false;
2262 FileName const tmp_ret = FileName::tempName("lyxauto");
2263 if (!tmp_ret.empty()) {
2264 buffer_.writeFile(tmp_ret);
2265 // assume successful write of tmp_ret
2266 if (!tmp_ret.moveTo(fname_))
2272 // failed to write/rename tmp_ret so try writing direct
2273 if (!buffer_.writeFile(fname_)) {
2274 // It is dangerous to do this in the child,
2275 // but safe in the parent, so...
2276 if (pid == -1) // emit message signal.
2277 buffer_.message(_("Autosave failed!"));
2281 if (pid == 0) // we are the child so...
2290 // Perfect target for a thread...
2291 void Buffer::autoSave() const
2293 if (isBakClean() || isReadonly()) {
2294 // We don't save now, but we'll try again later
2295 resetAutosaveTimers();
2299 // emit message signal.
2300 message(_("Autosaving current document..."));
2302 // create autosave filename
2303 string fname = filePath();
2305 fname += d->filename.onlyFileName();
2308 AutoSaveBuffer autosave(*this, FileName(fname));
2312 resetAutosaveTimers();
2316 void Buffer::resetChildDocuments(bool close_them) const
2321 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2322 if (it->lyxCode() != INCLUDE_CODE)
2324 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2325 InsetCommandParams const & ip = inset.params();
2327 resetParentBuffer(this, ip, close_them);
2330 if (use_gui && masterBuffer() == this)
2331 updateLabels(*this);
2333 // clear references to children in macro tables
2334 d->children_positions.clear();
2335 d->position_to_children.clear();
2339 void Buffer::loadChildDocuments() const
2341 bool parse_error = false;
2343 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2344 if (it->lyxCode() != INCLUDE_CODE)
2346 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2347 InsetCommandParams const & ip = inset.params();
2348 Buffer * child = loadIfNeeded(*this, ip);
2351 parse_error |= !child->errorList("Parse").empty();
2352 child->loadChildDocuments();
2355 if (use_gui && masterBuffer() == this)
2356 updateLabels(*this);
2362 string Buffer::bufferFormat() const
2372 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2373 string & result_file) const
2375 string backend_format;
2376 OutputParams runparams(¶ms().encoding());
2377 runparams.flavor = OutputParams::LATEX;
2378 runparams.linelen = lyxrc.plaintext_linelen;
2379 vector<string> backs = backends();
2380 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2381 // Get shortest path to format
2382 Graph::EdgePath path;
2383 for (vector<string>::const_iterator it = backs.begin();
2384 it != backs.end(); ++it) {
2385 Graph::EdgePath p = theConverters().getPath(*it, format);
2386 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2387 backend_format = *it;
2392 runparams.flavor = theConverters().getFlavor(path);
2394 Alert::error(_("Couldn't export file"),
2395 bformat(_("No information for exporting the format %1$s."),
2396 formats.prettyName(format)));
2400 backend_format = format;
2401 // FIXME: Don't hardcode format names here, but use a flag
2402 if (backend_format == "pdflatex")
2403 runparams.flavor = OutputParams::PDFLATEX;
2406 string filename = latexName(false);
2407 filename = addName(temppath(), filename);
2408 filename = changeExtension(filename,
2409 formats.extension(backend_format));
2412 updateMacroInstances();
2414 // Plain text backend
2415 if (backend_format == "text")
2416 writePlaintextFile(*this, FileName(filename), runparams);
2418 else if (backend_format == "lyx")
2419 writeFile(FileName(filename));
2421 else if (isDocBook()) {
2422 runparams.nice = !put_in_tempdir;
2423 makeDocBookFile(FileName(filename), runparams);
2426 else if (backend_format == format) {
2427 runparams.nice = true;
2428 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2430 } else if (!lyxrc.tex_allows_spaces
2431 && contains(filePath(), ' ')) {
2432 Alert::error(_("File name error"),
2433 _("The directory path to the document cannot contain spaces."));
2436 runparams.nice = false;
2437 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2441 string const error_type = (format == "program")
2442 ? "Build" : bufferFormat();
2443 string const ext = formats.extension(format);
2444 FileName const tmp_result_file(changeExtension(filename, ext));
2445 bool const success = theConverters().convert(this, FileName(filename),
2446 tmp_result_file, FileName(absFileName()), backend_format, format,
2447 errorList(error_type));
2448 // Emit the signal to show the error list.
2449 if (format != backend_format)
2454 if (put_in_tempdir) {
2455 result_file = tmp_result_file.absFilename();
2459 result_file = changeExtension(absFileName(), ext);
2460 // We need to copy referenced files (e. g. included graphics
2461 // if format == "dvi") to the result dir.
2462 vector<ExportedFile> const files =
2463 runparams.exportdata->externalFiles(format);
2464 string const dest = onlyPath(result_file);
2465 CopyStatus status = SUCCESS;
2466 for (vector<ExportedFile>::const_iterator it = files.begin();
2467 it != files.end() && status != CANCEL; ++it) {
2468 string const fmt = formats.getFormatFromFile(it->sourceName);
2469 status = copyFile(fmt, it->sourceName,
2470 makeAbsPath(it->exportName, dest),
2471 it->exportName, status == FORCE);
2473 if (status == CANCEL) {
2474 message(_("Document export cancelled."));
2475 } else if (tmp_result_file.exists()) {
2476 // Finally copy the main file
2477 status = copyFile(format, tmp_result_file,
2478 FileName(result_file), result_file,
2480 message(bformat(_("Document exported as %1$s "
2482 formats.prettyName(format),
2483 makeDisplayPath(result_file)));
2485 // This must be a dummy converter like fax (bug 1888)
2486 message(bformat(_("Document exported as %1$s"),
2487 formats.prettyName(format)));
2494 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2497 return doExport(format, put_in_tempdir, result_file);
2501 bool Buffer::preview(string const & format) const
2504 if (!doExport(format, true, result_file))
2506 return formats.view(*this, FileName(result_file), format);
2510 bool Buffer::isExportable(string const & format) const
2512 vector<string> backs = backends();
2513 for (vector<string>::const_iterator it = backs.begin();
2514 it != backs.end(); ++it)
2515 if (theConverters().isReachable(*it, format))
2521 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2523 vector<string> backs = backends();
2524 vector<Format const *> result =
2525 theConverters().getReachable(backs[0], only_viewable, true);
2526 for (vector<string>::const_iterator it = backs.begin() + 1;
2527 it != backs.end(); ++it) {
2528 vector<Format const *> r =
2529 theConverters().getReachable(*it, only_viewable, false);
2530 result.insert(result.end(), r.begin(), r.end());
2536 vector<string> Buffer::backends() const
2539 if (params().baseClass()->isTeXClassAvailable()) {
2540 v.push_back(bufferFormat());
2541 // FIXME: Don't hardcode format names here, but use a flag
2542 if (v.back() == "latex")
2543 v.push_back("pdflatex");
2545 v.push_back("text");
2551 bool Buffer::readFileHelper(FileName const & s)
2553 // File information about normal file
2555 docstring const file = makeDisplayPath(s.absFilename(), 50);
2556 docstring text = bformat(_("The specified document\n%1$s"
2557 "\ncould not be read."), file);
2558 Alert::error(_("Could not read document"), text);
2562 // Check if emergency save file exists and is newer.
2563 FileName const e(s.absFilename() + ".emergency");
2565 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2566 docstring const file = makeDisplayPath(s.absFilename(), 20);
2567 docstring const text =
2568 bformat(_("An emergency save of the document "
2570 "Recover emergency save?"), file);
2571 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2572 _("&Recover"), _("&Load Original"),
2576 // the file is not saved if we load the emergency file.
2586 // Now check if autosave file is newer.
2587 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2589 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2590 docstring const file = makeDisplayPath(s.absFilename(), 20);
2591 docstring const text =
2592 bformat(_("The backup of the document "
2593 "%1$s is newer.\n\nLoad the "
2594 "backup instead?"), file);
2595 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2596 _("&Load backup"), _("Load &original"),
2600 // the file is not saved if we load the autosave file.
2604 // Here we delete the autosave
2615 bool Buffer::loadLyXFile(FileName const & s)
2617 if (s.isReadableFile()) {
2618 if (readFileHelper(s)) {
2619 lyxvc().file_found_hook(s);
2620 if (!s.isWritable())
2625 docstring const file = makeDisplayPath(s.absFilename(), 20);
2626 // Here we probably should run
2627 if (LyXVC::file_not_found_hook(s)) {
2628 docstring const text =
2629 bformat(_("Do you want to retrieve the document"
2630 " %1$s from version control?"), file);
2631 int const ret = Alert::prompt(_("Retrieve from version control?"),
2632 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2635 // How can we know _how_ to do the checkout?
2636 // With the current VC support it has to be,
2637 // a RCS file since CVS do not have special ,v files.
2639 return loadLyXFile(s);
2647 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2649 TeXErrors::Errors::const_iterator cit = terr.begin();
2650 TeXErrors::Errors::const_iterator end = terr.end();
2652 for (; cit != end; ++cit) {
2655 int errorRow = cit->error_in_line;
2656 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2662 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2663 } while (found && id_start == id_end && pos_start == pos_end);
2665 errorList.push_back(ErrorItem(cit->error_desc,
2666 cit->error_text, id_start, pos_start, pos_end));