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 "BiblioInfo.h"
18 #include "BranchList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
24 #include "Converter.h"
26 #include "DocIterator.h"
27 #include "EmbeddedFiles.h"
29 #include "ErrorList.h"
32 #include "FuncRequest.h"
33 #include "InsetIterator.h"
34 #include "InsetList.h"
36 #include "LaTeXFeatures.h"
40 #include "LyXAction.h"
44 #include "output_docbook.h"
46 #include "output_latex.h"
47 #include "output_plaintext.h"
48 #include "paragraph_funcs.h"
49 #include "Paragraph.h"
50 #include "ParagraphParameters.h"
51 #include "ParIterator.h"
52 #include "PDFOptions.h"
56 #include "TexStream.h"
57 #include "TextClassList.h"
59 #include "TocBackend.h"
61 #include "VCBackend.h"
64 #include "insets/InsetBibitem.h"
65 #include "insets/InsetBibtex.h"
66 #include "insets/InsetInclude.h"
67 #include "insets/InsetText.h"
69 #include "mathed/MacroTable.h"
70 #include "mathed/MathMacroTemplate.h"
71 #include "mathed/MathSupport.h"
73 #include "frontends/alert.h"
74 #include "frontends/Delegates.h"
75 #include "frontends/WorkAreaManager.h"
77 #include "graphics/Previews.h"
79 #include "support/convert.h"
80 #include "support/debug.h"
81 #include "support/FileFilterList.h"
82 #include "support/FileNameList.h"
83 #include "support/filetools.h"
84 #include "support/ForkedCalls.h"
85 #include "support/gettext.h"
86 #include "support/gzstream.h"
87 #include "support/lstrings.h"
88 #include "support/lyxalgo.h"
89 #include "support/lyxlib.h"
90 #include "support/os.h"
91 #include "support/Path.h"
92 #include "support/textutils.h"
93 #include "support/types.h"
94 #include "support/FileZipListDir.h"
96 #if !defined (HAVE_FORK)
100 #include <boost/bind.hpp>
101 #include <boost/shared_ptr.hpp>
110 using namespace lyx::support;
114 namespace Alert = frontend::Alert;
115 namespace os = support::os;
119 int const LYX_FORMAT = 308; // Uwe: Serbian-Latin
124 typedef map<string, bool> DepClean;
129 Impl(Buffer & parent, FileName const & file, bool readonly);
142 mutable TexRow texrow;
143 Buffer const * parent_buffer;
145 /// need to regenerate .tex?
149 mutable bool lyx_clean;
151 /// is autosave needed?
152 mutable bool bak_clean;
154 /// is this a unnamed file (New...)?
160 /// name of the file the buffer is associated with.
163 /** Set to true only when the file is fully loaded.
164 * Used to prevent the premature generation of previews
165 * and by the citation inset.
167 bool file_fully_loaded;
169 /// our Text that should be wrapped in an InsetText
173 mutable TocBackend toc_backend;
176 typedef map<unsigned int, MacroData, greater<int> > PositionToMacroMap;
177 typedef map<docstring, PositionToMacroMap> NameToPositionMacroMap;
178 NameToPositionMacroMap macros;
180 /// Container for all sort of Buffer dependant errors.
181 map<string, ErrorList> errorLists;
183 /// all embedded files of this buffer
184 EmbeddedFiles embedded_files;
186 /// timestamp and checksum used to test if the file has been externally
187 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
189 unsigned long checksum_;
192 frontend::WorkAreaManager * wa_;
197 /// A cache for the bibfiles (including bibfiles of loaded child
198 /// documents), needed for appropriate update of natbib labels.
199 mutable FileNameList bibfilesCache_;
203 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
204 : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
205 read_only(readonly_), filename(file), file_fully_loaded(false),
206 inset(params), toc_backend(&parent), embedded_files(&parent),
207 timestamp_(0), checksum_(0), wa_(0), undo_(parent)
209 inset.setAutoBreakRows(true);
210 lyxvc.setBuffer(&parent);
211 temppath = createBufferTmpDir();
213 // FIXME: And now do something if temppath == string(), because we
214 // assume from now on that temppath points to a valid temp dir.
215 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
218 wa_ = new frontend::WorkAreaManager;
222 Buffer::Buffer(string const & file, bool readonly)
223 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
225 LYXERR(Debug::INFO, "Buffer::Buffer()");
231 LYXERR(Debug::INFO, "Buffer::~Buffer()");
232 // here the buffer should take care that it is
233 // saved properly, before it goes into the void.
235 // GuiView already destroyed
238 Buffer const * master = masterBuffer();
239 if (master != this && use_gui)
240 // We are closing buf which was a child document so we
241 // must update the labels and section numbering of its master
243 updateLabels(*master);
245 resetChildDocuments(false);
247 if (!temppath().empty() && !FileName(temppath()).destroyDirectory()) {
248 Alert::warning(_("Could not remove temporary directory"),
249 bformat(_("Could not remove the temporary directory %1$s"),
250 from_utf8(temppath())));
253 // Remove any previewed LaTeX snippets associated with this buffer.
254 graphics::Previews::get().removeLoader(*this);
260 void Buffer::changed() const
267 frontend::WorkAreaManager & Buffer::workAreaManager() const
269 BOOST_ASSERT(d->wa_);
274 Text & Buffer::text() const
276 return const_cast<Text &>(d->inset.text_);
280 Inset & Buffer::inset() const
282 return const_cast<InsetText &>(d->inset);
286 BufferParams & Buffer::params()
292 BufferParams const & Buffer::params() const
298 ParagraphList & Buffer::paragraphs()
300 return text().paragraphs();
304 ParagraphList const & Buffer::paragraphs() const
306 return text().paragraphs();
310 LyXVC & Buffer::lyxvc()
316 LyXVC const & Buffer::lyxvc() const
322 string const & Buffer::temppath() const
328 TexRow const & Buffer::texrow() const
334 TocBackend & Buffer::tocBackend() const
336 return d->toc_backend;
340 EmbeddedFiles & Buffer::embeddedFiles()
342 return d->embedded_files;
346 EmbeddedFiles const & Buffer::embeddedFiles() const
348 return d->embedded_files;
352 Undo & Buffer::undo()
358 string Buffer::latexName(bool const no_path) const
360 FileName latex_name = makeLatexName(d->filename);
361 return no_path ? latex_name.onlyFileName()
362 : latex_name.absFilename();
366 string Buffer::logName(LogType * type) const
368 string const filename = latexName(false);
370 if (filename.empty()) {
376 string const path = temppath();
378 FileName const fname(addName(temppath(),
379 onlyFilename(changeExtension(filename,
381 FileName const bname(
382 addName(path, onlyFilename(
383 changeExtension(filename,
384 formats.extension("literate") + ".out"))));
386 // If no Latex log or Build log is newer, show Build log
388 if (bname.exists() &&
389 (!fname.exists() || fname.lastModified() < bname.lastModified())) {
390 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
393 return bname.absFilename();
395 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
398 return fname.absFilename();
402 void Buffer::setReadonly(bool const flag)
404 if (d->read_only != flag) {
411 void Buffer::setFileName(string const & newfile)
413 d->filename = makeAbsPath(newfile);
414 setReadonly(d->filename.isReadOnly());
419 int Buffer::readHeader(Lexer & lex)
421 int unknown_tokens = 0;
423 int begin_header_line = -1;
425 // Initialize parameters that may be/go lacking in header:
426 params().branchlist().clear();
427 params().preamble.erase();
428 params().options.erase();
429 params().float_placement.erase();
430 params().paperwidth.erase();
431 params().paperheight.erase();
432 params().leftmargin.erase();
433 params().rightmargin.erase();
434 params().topmargin.erase();
435 params().bottommargin.erase();
436 params().headheight.erase();
437 params().headsep.erase();
438 params().footskip.erase();
439 params().listings_params.clear();
440 params().clearLayoutModules();
441 params().pdfoptions().clear();
443 for (int i = 0; i < 4; ++i) {
444 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
445 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
448 ErrorList & errorList = d->errorLists["Parse"];
452 string const token = lex.getString();
457 if (token == "\\end_header")
461 if (token == "\\begin_header") {
462 begin_header_line = line;
466 LYXERR(Debug::PARSER, "Handling document header token: `"
469 string unknown = params().readToken(lex, token, d->filename.onlyPath());
470 if (!unknown.empty()) {
471 if (unknown[0] != '\\' && token == "\\textclass") {
472 Alert::warning(_("Unknown document class"),
473 bformat(_("Using the default document class, because the "
474 "class %1$s is unknown."), from_utf8(unknown)));
477 docstring const s = bformat(_("Unknown token: "
481 errorList.push_back(ErrorItem(_("Document header error"),
486 if (begin_header_line) {
487 docstring const s = _("\\begin_header is missing");
488 errorList.push_back(ErrorItem(_("Document header error"),
492 return unknown_tokens;
497 // changed to be public and have one parameter
498 // Returns false if "\end_document" is not read (Asger)
499 bool Buffer::readDocument(Lexer & lex)
501 ErrorList & errorList = d->errorLists["Parse"];
505 string const token = lex.getString();
506 if (token != "\\begin_document") {
507 docstring const s = _("\\begin_document is missing");
508 errorList.push_back(ErrorItem(_("Document header error"),
512 // we are reading in a brand new document
513 BOOST_ASSERT(paragraphs().empty());
516 TextClass const & baseClass = textclasslist[params().getBaseClass()];
517 if (!baseClass.load(filePath())) {
518 string theclass = baseClass.name();
519 Alert::error(_("Can't load document class"), bformat(
520 _("Using the default document class, because the "
521 "class %1$s could not be loaded."), from_utf8(theclass)));
522 params().setBaseClass(defaultTextclass());
525 if (params().outputChanges) {
526 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
527 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
528 LaTeXFeatures::isAvailable("xcolor");
530 if (!dvipost && !xcolorsoul) {
531 Alert::warning(_("Changes not shown in LaTeX output"),
532 _("Changes will not be highlighted in LaTeX output, "
533 "because neither dvipost nor xcolor/soul are installed.\n"
534 "Please install these packages or redefine "
535 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
536 } else if (!xcolorsoul) {
537 Alert::warning(_("Changes not shown in LaTeX output"),
538 _("Changes will not be highlighted in LaTeX output "
539 "when using pdflatex, because xcolor and soul are not installed.\n"
540 "Please install both packages or redefine "
541 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
546 bool const res = text().read(*this, lex, errorList);
547 for_each(text().paragraphs().begin(),
548 text().paragraphs().end(),
549 bind(&Paragraph::setInsetOwner, _1, &inset()));
555 // needed to insert the selection
556 void Buffer::insertStringAsLines(ParagraphList & pars,
557 pit_type & pit, pos_type & pos,
558 Font const & fn, docstring const & str, bool autobreakrows)
562 // insert the string, don't insert doublespace
563 bool space_inserted = true;
564 for (docstring::const_iterator cit = str.begin();
565 cit != str.end(); ++cit) {
566 Paragraph & par = pars[pit];
568 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
569 breakParagraph(params(), pars, pit, pos,
570 par.layout()->isEnvironment());
573 space_inserted = true;
577 // do not insert consecutive spaces if !free_spacing
578 } else if ((*cit == ' ' || *cit == '\t') &&
579 space_inserted && !par.isFreeSpacing()) {
581 } else if (*cit == '\t') {
582 if (!par.isFreeSpacing()) {
583 // tabs are like spaces here
584 par.insertChar(pos, ' ', font, params().trackChanges);
586 space_inserted = true;
588 const pos_type n = 8 - pos % 8;
589 for (pos_type i = 0; i < n; ++i) {
590 par.insertChar(pos, ' ', font, params().trackChanges);
593 space_inserted = true;
595 } else if (!isPrintable(*cit)) {
596 // Ignore unprintables
599 // just insert the character
600 par.insertChar(pos, *cit, font, params().trackChanges);
602 space_inserted = (*cit == ' ');
609 bool Buffer::readString(string const & s)
611 params().compressed = false;
613 // remove dummy empty par
614 paragraphs().clear();
618 FileName const name(tempName());
619 switch (readFile(lex, name, true)) {
623 // We need to call lyx2lyx, so write the input to a file
624 ofstream os(name.toFilesystemEncoding().c_str());
627 return readFile(name);
637 bool Buffer::readFile(FileName const & filename)
639 FileName fname(filename);
640 // Check if the file is compressed.
641 string format = filename.guessFormatFromContents();
642 if (format == "zip") {
643 // decompress to a temp directory
644 LYXERR(Debug::FILES, filename << " is in zip format. Unzip to " << temppath());
645 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
647 FileName lyxfile(addName(temppath(), "content.lyx"));
648 // if both manifest.txt and file.lyx exist, this is am embedded file
649 if (lyxfile.exists()) {
650 params().embedded = true;
654 // The embedded lyx file can also be compressed, for backward compatibility
655 format = fname.guessFormatFromContents();
656 if (format == "gzip" || format == "zip" || format == "compress")
657 params().compressed = true;
659 // remove dummy empty par
660 paragraphs().clear();
663 if (readFile(lex, fname) != success)
670 bool Buffer::isFullyLoaded() const
672 return d->file_fully_loaded;
676 void Buffer::setFullyLoaded(bool value)
678 d->file_fully_loaded = value;
682 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
685 BOOST_ASSERT(!filename.empty());
688 Alert::error(_("Document could not be read"),
689 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
694 string const token = lex.getString();
697 Alert::error(_("Document could not be read"),
698 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
702 // the first token _must_ be...
703 if (token != "\\lyxformat") {
704 lyxerr << "Token: " << token << endl;
706 Alert::error(_("Document format failure"),
707 bformat(_("%1$s is not a LyX document."),
708 from_utf8(filename.absFilename())));
713 string tmp_format = lex.getString();
714 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
715 // if present remove ".," from string.
716 string::size_type dot = tmp_format.find_first_of(".,");
717 //lyxerr << " dot found at " << dot << endl;
718 if (dot != string::npos)
719 tmp_format.erase(dot, 1);
720 int const file_format = convert<int>(tmp_format);
721 //lyxerr << "format: " << file_format << endl;
723 // save timestamp and checksum of the original disk file, making sure
724 // to not overwrite them with those of the file created in the tempdir
725 // when it has to be converted to the current format.
727 // Save the timestamp and checksum of disk file. If filename is an
728 // emergency file, save the timestamp and checksum of the original lyx file
729 // because isExternallyModified will check for this file. (BUG4193)
730 string diskfile = filename.absFilename();
731 if (suffixIs(diskfile, ".emergency"))
732 diskfile = diskfile.substr(0, diskfile.size() - 10);
733 saveCheckSum(FileName(diskfile));
736 if (file_format != LYX_FORMAT) {
739 // lyx2lyx would fail
742 FileName const tmpfile(tempName());
743 if (tmpfile.empty()) {
744 Alert::error(_("Conversion failed"),
745 bformat(_("%1$s is from a different"
746 " version of LyX, but a temporary"
747 " file for converting it could"
749 from_utf8(filename.absFilename())));
752 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
753 if (lyx2lyx.empty()) {
754 Alert::error(_("Conversion script not found"),
755 bformat(_("%1$s is from a different"
756 " version of LyX, but the"
757 " conversion script lyx2lyx"
758 " could not be found."),
759 from_utf8(filename.absFilename())));
762 ostringstream command;
763 command << os::python()
764 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
765 << " -t " << convert<string>(LYX_FORMAT)
766 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
767 << ' ' << quoteName(filename.toFilesystemEncoding());
768 string const command_str = command.str();
770 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
772 cmd_ret const ret = runCommand(command_str);
773 if (ret.first != 0) {
774 Alert::error(_("Conversion script failed"),
775 bformat(_("%1$s is from a different version"
776 " of LyX, but the lyx2lyx script"
777 " failed to convert it."),
778 from_utf8(filename.absFilename())));
781 bool const ret = readFile(tmpfile);
782 // Do stuff with tmpfile name and buffer name here.
783 return ret ? success : failure;
788 if (readDocument(lex)) {
789 Alert::error(_("Document format failure"),
790 bformat(_("%1$s ended unexpectedly, which means"
791 " that it is probably corrupted."),
792 from_utf8(filename.absFilename())));
795 d->file_fully_loaded = true;
800 // Should probably be moved to somewhere else: BufferView? LyXView?
801 bool Buffer::save() const
803 // We don't need autosaves in the immediate future. (Asger)
804 resetAutosaveTimers();
806 string const encodedFilename = d->filename.toFilesystemEncoding();
809 bool madeBackup = false;
811 // make a backup if the file already exists
812 if (lyxrc.make_backup && fileName().exists()) {
813 backupName = FileName(absFileName() + '~');
814 if (!lyxrc.backupdir_path.empty()) {
815 string const mangledName =
816 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
817 backupName = FileName(addName(lyxrc.backupdir_path,
820 if (fileName().copyTo(backupName, true)) {
823 Alert::error(_("Backup failure"),
824 bformat(_("Cannot create backup file %1$s.\n"
825 "Please check whether the directory exists and is writeable."),
826 from_utf8(backupName.absFilename())));
827 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
831 // ask if the disk file has been externally modified (use checksum method)
832 if (fileName().exists() && isExternallyModified(checksum_method)) {
833 docstring const file = makeDisplayPath(absFileName(), 20);
834 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
835 "you want to overwrite this file?"), file);
836 int const ret = Alert::prompt(_("Overwrite modified file?"),
837 text, 1, 1, _("&Overwrite"), _("&Cancel"));
842 if (writeFile(d->filename)) {
846 // Saving failed, so backup is not backup
848 backupName.renameTo(d->filename);
854 bool Buffer::writeFile(FileName const & fname) const
856 if (d->read_only && fname == d->filename)
862 if (params().embedded)
863 // first write the .lyx file to the temporary directory
864 content = FileName(addName(temppath(), "content.lyx"));
868 docstring const str = bformat(_("Saving document %1$s..."),
869 makeDisplayPath(content.absFilename()));
872 if (params().compressed) {
873 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
874 retval = ofs && write(ofs);
876 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
877 retval = ofs && write(ofs);
881 message(str + _(" could not write file!."));
885 removeAutosaveFile(d->filename.absFilename());
886 saveCheckSum(d->filename);
887 message(str + _(" done."));
889 if (!params().embedded)
892 message(str + _(" writing embedded files!."));
893 // if embedding is enabled, write file.lyx and all the embedded files
894 // to the zip file fname.
895 if (!d->embedded_files.writeFile(fname)) {
896 message(str + _(" could not write embedded files!."));
899 message(str + _(" error while writing embedded files."));
904 bool Buffer::write(ostream & ofs) const
907 // Use the standard "C" locale for file output.
908 ofs.imbue(locale::classic());
911 // The top of the file should not be written by params().
913 // write out a comment in the top of the file
914 ofs << "#LyX " << lyx_version
915 << " created this file. For more info see http://www.lyx.org/\n"
916 << "\\lyxformat " << LYX_FORMAT << "\n"
917 << "\\begin_document\n";
920 /// For each author, set 'used' to true if there is a change
921 /// by this author in the document; otherwise set it to 'false'.
922 AuthorList::Authors::const_iterator a_it = params().authors().begin();
923 AuthorList::Authors::const_iterator a_end = params().authors().end();
924 for (; a_it != a_end; ++a_it)
925 a_it->second.setUsed(false);
927 ParIterator const end = par_iterator_end();
928 ParIterator it = par_iterator_begin();
929 for ( ; it != end; ++it)
930 it->checkAuthors(params().authors());
932 // now write out the buffer parameters.
933 ofs << "\\begin_header\n";
934 params().writeFile(ofs);
935 ofs << "\\end_header\n";
938 ofs << "\n\\begin_body\n";
939 text().write(*this, ofs);
940 ofs << "\n\\end_body\n";
942 // Write marker that shows file is complete
943 ofs << "\\end_document" << endl;
945 // Shouldn't really be needed....
948 // how to check if close went ok?
949 // Following is an attempt... (BE 20001011)
951 // good() returns false if any error occured, including some
953 // bad() returns true if something bad happened in the buffer,
954 // which should include file system full errors.
959 lyxerr << "File was not closed properly." << endl;
966 bool Buffer::makeLaTeXFile(FileName const & fname,
967 string const & original_path,
968 OutputParams const & runparams,
969 bool output_preamble, bool output_body) const
971 string const encoding = runparams.encoding->iconvName();
972 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
975 try { ofs.reset(encoding); }
976 catch (iconv_codecvt_facet_exception & e) {
977 lyxerr << "Caught iconv exception: " << e.what() << endl;
978 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
979 "verify that the support software for your encoding (%1$s) is "
980 "properly installed"), from_ascii(encoding)));
983 if (!openFileWrite(ofs, fname))
986 //TexStream ts(ofs.rdbuf(), &texrow());
988 bool failed_export = false;
991 writeLaTeXSource(ofs, original_path,
992 runparams, output_preamble, output_body);
994 catch (iconv_codecvt_facet_exception & e) {
995 lyxerr << "Caught iconv exception: " << e.what() << endl;
996 failed_export = true;
998 catch (exception const & e) {
999 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1000 failed_export = true;
1003 lyxerr << "Caught some really weird exception..." << endl;
1004 LyX::cref().emergencyCleanup();
1005 lyx::support::abort();
1010 failed_export = true;
1011 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1014 if (failed_export) {
1015 Alert::error(_("Encoding error"),
1016 _("Some characters of your document are probably not "
1017 "representable in the chosen encoding.\n"
1018 "Changing the document encoding to utf8 could help."));
1025 void Buffer::writeLaTeXSource(odocstream & os,
1026 string const & original_path,
1027 OutputParams const & runparams_in,
1028 bool const output_preamble, bool const output_body) const
1030 OutputParams runparams = runparams_in;
1032 // validate the buffer.
1033 LYXERR(Debug::LATEX, " Validating buffer...");
1034 LaTeXFeatures features(*this, params(), runparams);
1036 LYXERR(Debug::LATEX, " Buffer validation done.");
1038 // The starting paragraph of the coming rows is the
1039 // first paragraph of the document. (Asger)
1040 if (output_preamble && runparams.nice) {
1041 os << "%% LyX " << lyx_version << " created this file. "
1042 "For more info, see http://www.lyx.org/.\n"
1043 "%% Do not edit unless you really know what "
1045 d->texrow.newline();
1046 d->texrow.newline();
1048 LYXERR(Debug::INFO, "lyx document header finished");
1049 // There are a few differences between nice LaTeX and usual files:
1050 // usual is \batchmode and has a
1051 // special input@path to allow the including of figures
1052 // with either \input or \includegraphics (what figinsets do).
1053 // input@path is set when the actual parameter
1054 // original_path is set. This is done for usual tex-file, but not
1055 // for nice-latex-file. (Matthias 250696)
1056 // Note that input@path is only needed for something the user does
1057 // in the preamble, included .tex files or ERT, files included by
1058 // LyX work without it.
1059 if (output_preamble) {
1060 if (!runparams.nice) {
1061 // code for usual, NOT nice-latex-file
1062 os << "\\batchmode\n"; // changed
1063 // from \nonstopmode
1064 d->texrow.newline();
1066 if (!original_path.empty()) {
1068 // We don't know the encoding of inputpath
1069 docstring const inputpath = from_utf8(latex_path(original_path));
1070 os << "\\makeatletter\n"
1071 << "\\def\\input@path{{"
1072 << inputpath << "/}}\n"
1073 << "\\makeatother\n";
1074 d->texrow.newline();
1075 d->texrow.newline();
1076 d->texrow.newline();
1079 // Write the preamble
1080 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1086 os << "\\begin{document}\n";
1087 d->texrow.newline();
1088 } // output_preamble
1090 d->texrow.start(paragraphs().begin()->id(), 0);
1092 LYXERR(Debug::INFO, "preamble finished, now the body.");
1094 // if we are doing a real file with body, even if this is the
1095 // child of some other buffer, let's cut the link here.
1096 // This happens for example if only a child document is printed.
1097 Buffer const * save_parent = 0;
1098 if (output_preamble) {
1099 save_parent = d->parent_buffer;
1100 d->parent_buffer = 0;
1103 loadChildDocuments();
1106 latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1108 // Restore the parenthood if needed
1109 if (output_preamble)
1110 d->parent_buffer = save_parent;
1112 // add this just in case after all the paragraphs
1114 d->texrow.newline();
1116 if (output_preamble) {
1117 os << "\\end{document}\n";
1118 d->texrow.newline();
1119 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1121 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1123 runparams_in.encoding = runparams.encoding;
1125 // Just to be sure. (Asger)
1126 d->texrow.newline();
1128 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1129 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1133 bool Buffer::isLatex() const
1135 return params().getTextClass().outputType() == LATEX;
1139 bool Buffer::isLiterate() const
1141 return params().getTextClass().outputType() == LITERATE;
1145 bool Buffer::isDocBook() const
1147 return params().getTextClass().outputType() == DOCBOOK;
1151 void Buffer::makeDocBookFile(FileName const & fname,
1152 OutputParams const & runparams,
1153 bool const body_only) const
1155 LYXERR(Debug::LATEX, "makeDocBookFile...");
1159 if (!openFileWrite(ofs, fname))
1162 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1166 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1170 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1171 OutputParams const & runparams,
1172 bool const only_body) const
1174 LaTeXFeatures features(*this, params(), runparams);
1179 TextClass const & tclass = params().getTextClass();
1180 string const top_element = tclass.latexname();
1183 if (runparams.flavor == OutputParams::XML)
1184 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1187 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1190 if (! tclass.class_header().empty())
1191 os << from_ascii(tclass.class_header());
1192 else if (runparams.flavor == OutputParams::XML)
1193 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1194 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1196 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1198 docstring preamble = from_utf8(params().preamble);
1199 if (runparams.flavor != OutputParams::XML ) {
1200 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1201 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1202 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1203 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1206 string const name = runparams.nice
1207 ? changeExtension(absFileName(), ".sgml") : fname;
1208 preamble += features.getIncludedFiles(name);
1209 preamble += features.getLyXSGMLEntities();
1211 if (!preamble.empty()) {
1212 os << "\n [ " << preamble << " ]";
1217 string top = top_element;
1219 if (runparams.flavor == OutputParams::XML)
1220 top += params().language->code();
1222 top += params().language->code().substr(0,2);
1225 if (!params().options.empty()) {
1227 top += params().options;
1230 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1231 << " file was created by LyX " << lyx_version
1232 << "\n See http://www.lyx.org/ for more information -->\n";
1234 params().getTextClass().counters().reset();
1236 loadChildDocuments();
1238 sgml::openTag(os, top);
1240 docbookParagraphs(paragraphs(), *this, os, runparams);
1241 sgml::closeTag(os, top_element);
1245 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1246 // Other flags: -wall -v0 -x
1247 int Buffer::runChktex()
1251 // get LaTeX-Filename
1252 FileName const path(temppath());
1253 string const name = addName(path.absFilename(), latexName());
1254 string const org_path = filePath();
1256 PathChanger p(path); // path to LaTeX file
1257 message(_("Running chktex..."));
1259 // Generate the LaTeX file if neccessary
1260 OutputParams runparams(¶ms().encoding());
1261 runparams.flavor = OutputParams::LATEX;
1262 runparams.nice = false;
1263 makeLaTeXFile(FileName(name), org_path, runparams);
1266 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1267 int const res = chktex.run(terr); // run chktex
1270 Alert::error(_("chktex failure"),
1271 _("Could not run chktex successfully."));
1272 } else if (res > 0) {
1273 ErrorList & errlist = d->errorLists["ChkTeX"];
1275 bufferErrors(terr, errlist);
1286 void Buffer::validate(LaTeXFeatures & features) const
1288 params().validate(features);
1290 loadChildDocuments();
1292 for_each(paragraphs().begin(), paragraphs().end(),
1293 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1295 if (lyxerr.debugging(Debug::LATEX)) {
1296 features.showStruct();
1301 void Buffer::getLabelList(vector<docstring> & list) const
1303 /// if this is a child document and the parent is already loaded
1304 /// Use the parent's list instead [ale990407]
1305 Buffer const * tmp = masterBuffer();
1307 lyxerr << "masterBuffer() failed!" << endl;
1311 tmp->getLabelList(list);
1315 loadChildDocuments();
1317 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1318 it.nextInset()->getLabelList(*this, list);
1322 void Buffer::updateBibfilesCache() const
1324 // if this is a child document and the parent is already loaded
1325 // update the parent's cache instead
1326 Buffer const * tmp = masterBuffer();
1329 tmp->updateBibfilesCache();
1333 d->bibfilesCache_.clear();
1334 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1335 if (it->lyxCode() == BIBTEX_CODE) {
1336 InsetBibtex const & inset =
1337 static_cast<InsetBibtex const &>(*it);
1338 FileNameList const bibfiles = inset.getFiles(*this);
1339 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1342 } else if (it->lyxCode() == INCLUDE_CODE) {
1343 InsetInclude & inset =
1344 static_cast<InsetInclude &>(*it);
1345 inset.updateBibfilesCache(*this);
1346 FileNameList const & bibfiles =
1347 inset.getBibfilesCache(*this);
1348 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1356 FileNameList const & Buffer::getBibfilesCache() const
1358 // if this is a child document and the parent is already loaded
1359 // use the parent's cache instead
1360 Buffer const * tmp = masterBuffer();
1363 return tmp->getBibfilesCache();
1365 // We update the cache when first used instead of at loading time.
1366 if (d->bibfilesCache_.empty())
1367 const_cast<Buffer *>(this)->updateBibfilesCache();
1369 return d->bibfilesCache_;
1373 bool Buffer::isDepClean(string const & name) const
1375 DepClean::const_iterator const it = d->dep_clean.find(name);
1376 if (it == d->dep_clean.end())
1382 void Buffer::markDepClean(string const & name)
1384 d->dep_clean[name] = true;
1388 bool Buffer::dispatch(string const & command, bool * result)
1390 return dispatch(lyxaction.lookupFunc(command), result);
1394 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1396 bool dispatched = true;
1398 switch (func.action) {
1399 case LFUN_BUFFER_EXPORT: {
1400 bool const tmp = doExport(to_utf8(func.argument()), false);
1413 void Buffer::changeLanguage(Language const * from, Language const * to)
1418 for_each(par_iterator_begin(),
1420 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1424 bool Buffer::isMultiLingual() const
1426 ParConstIterator end = par_iterator_end();
1427 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1428 if (it->isMultiLingual(params()))
1435 ParIterator Buffer::getParFromID(int const id) const
1437 ParConstIterator it = par_iterator_begin();
1438 ParConstIterator const end = par_iterator_end();
1441 // John says this is called with id == -1 from undo
1442 lyxerr << "getParFromID(), id: " << id << endl;
1446 for (; it != end; ++it)
1454 bool Buffer::hasParWithID(int const id) const
1456 ParConstIterator const it = getParFromID(id);
1457 return it != par_iterator_end();
1461 ParIterator Buffer::par_iterator_begin()
1463 return lyx::par_iterator_begin(inset());
1467 ParIterator Buffer::par_iterator_end()
1469 return lyx::par_iterator_end(inset());
1473 ParConstIterator Buffer::par_iterator_begin() const
1475 return lyx::par_const_iterator_begin(inset());
1479 ParConstIterator Buffer::par_iterator_end() const
1481 return lyx::par_const_iterator_end(inset());
1485 Language const * Buffer::language() const
1487 return params().language;
1491 docstring const Buffer::B_(string const & l10n) const
1493 return params().B_(l10n);
1497 bool Buffer::isClean() const
1499 return d->lyx_clean;
1503 bool Buffer::isBakClean() const
1505 return d->bak_clean;
1509 bool Buffer::isExternallyModified(CheckMethod method) const
1511 BOOST_ASSERT(d->filename.exists());
1512 // if method == timestamp, check timestamp before checksum
1513 return (method == checksum_method
1514 || d->timestamp_ != d->filename.lastModified())
1515 && d->checksum_ != d->filename.checksum();
1519 void Buffer::saveCheckSum(FileName const & file) const
1521 if (file.exists()) {
1522 d->timestamp_ = file.lastModified();
1523 d->checksum_ = file.checksum();
1525 // in the case of save to a new file.
1532 void Buffer::markClean() const
1534 if (!d->lyx_clean) {
1535 d->lyx_clean = true;
1538 // if the .lyx file has been saved, we don't need an
1540 d->bak_clean = true;
1544 void Buffer::markBakClean() const
1546 d->bak_clean = true;
1550 void Buffer::setUnnamed(bool flag)
1556 bool Buffer::isUnnamed() const
1562 // FIXME: this function should be moved to buffer_pimpl.C
1563 void Buffer::markDirty()
1566 d->lyx_clean = false;
1569 d->bak_clean = false;
1571 DepClean::iterator it = d->dep_clean.begin();
1572 DepClean::const_iterator const end = d->dep_clean.end();
1574 for (; it != end; ++it)
1579 FileName Buffer::fileName() const
1585 string Buffer::absFileName() const
1587 return d->filename.absFilename();
1591 string Buffer::filePath() const
1593 return d->filename.onlyPath().absFilename();
1597 bool Buffer::isReadonly() const
1599 return d->read_only;
1603 void Buffer::setParent(Buffer const * buffer)
1605 // Avoids recursive include.
1606 d->parent_buffer = buffer == this ? 0 : buffer;
1610 Buffer const * Buffer::parent()
1612 return d->parent_buffer;
1616 Buffer const * Buffer::masterBuffer() const
1618 if (!d->parent_buffer)
1621 return d->parent_buffer->masterBuffer();
1625 bool Buffer::hasMacro(docstring const & name, Paragraph const & par) const
1627 Impl::PositionToMacroMap::iterator it;
1628 it = d->macros[name].upper_bound(par.macrocontextPosition());
1629 if (it != d->macros[name].end())
1632 // If there is a master buffer, query that
1633 Buffer const * master = masterBuffer();
1634 if (master && master != this)
1635 return master->hasMacro(name);
1637 return MacroTable::globalMacros().has(name);
1641 bool Buffer::hasMacro(docstring const & name) const
1643 if( !d->macros[name].empty() )
1646 // If there is a master buffer, query that
1647 Buffer const * master = masterBuffer();
1648 if (master && master != this)
1649 return master->hasMacro(name);
1651 return MacroTable::globalMacros().has(name);
1655 MacroData const & Buffer::getMacro(docstring const & name,
1656 Paragraph const & par) const
1658 Impl::PositionToMacroMap::iterator it;
1659 it = d->macros[name].upper_bound(par.macrocontextPosition());
1660 if( it != d->macros[name].end() )
1663 // If there is a master buffer, query that
1664 Buffer const * master = masterBuffer();
1665 if (master && master != this)
1666 return master->getMacro(name);
1668 return MacroTable::globalMacros().get(name);
1672 MacroData const & Buffer::getMacro(docstring const & name) const
1674 Impl::PositionToMacroMap::iterator it;
1675 it = d->macros[name].begin();
1676 if( it != d->macros[name].end() )
1679 // If there is a master buffer, query that
1680 Buffer const * master = masterBuffer();
1681 if (master && master != this)
1682 return master->getMacro(name);
1684 return MacroTable::globalMacros().get(name);
1688 void Buffer::updateMacros()
1690 // start with empty table
1691 d->macros = Impl::NameToPositionMacroMap();
1693 // Iterate over buffer
1694 ParagraphList & pars = text().paragraphs();
1695 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1696 // set position again
1697 pars[i].setMacrocontextPosition(i);
1699 //lyxerr << "searching main par " << i
1700 // << " for macro definitions" << endl;
1701 InsetList const & insets = pars[i].insetList();
1702 InsetList::const_iterator it = insets.begin();
1703 InsetList::const_iterator end = insets.end();
1704 for ( ; it != end; ++it) {
1705 if (it->inset->lyxCode() != MATHMACRO_CODE)
1709 MathMacroTemplate const & macroTemplate
1710 = static_cast<MathMacroTemplate const &>(*it->inset);
1713 if (macroTemplate.validMacro()) {
1714 MacroData macro = macroTemplate.asMacroData();
1717 // call hasMacro here instead of directly querying mc to
1718 // also take the master document into consideration
1719 macro.setRedefinition(hasMacro(macroTemplate.name()));
1721 // register macro (possibly overwrite the previous one of this paragraph)
1722 d->macros[macroTemplate.name()][i] = macro;
1729 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1732 //FIXME: This does not work for child documents yet.
1733 BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
1734 // Check if the label 'from' appears more than once
1735 vector<docstring> labels;
1738 if (code == CITE_CODE) {
1740 keys.fillWithBibKeys(this);
1741 BiblioInfo::const_iterator bit = keys.begin();
1742 BiblioInfo::const_iterator bend = keys.end();
1744 for (; bit != bend; ++bit)
1746 labels.push_back(bit->first);
1749 getLabelList(labels);
1750 paramName = "reference";
1753 if (count(labels.begin(), labels.end(), from) > 1)
1756 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1757 if (it->lyxCode() == code) {
1758 InsetCommand & inset = static_cast<InsetCommand &>(*it);
1759 docstring const oldValue = inset.getParam(paramName);
1760 if (oldValue == from)
1761 inset.setParam(paramName, to);
1767 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1768 pit_type par_end, bool full_source)
1770 OutputParams runparams(¶ms().encoding());
1771 runparams.nice = true;
1772 runparams.flavor = OutputParams::LATEX;
1773 runparams.linelen = lyxrc.plaintext_linelen;
1774 // No side effect of file copying and image conversion
1775 runparams.dryrun = true;
1779 os << "% " << _("Preview source code") << "\n\n";
1780 d->texrow.newline();
1781 d->texrow.newline();
1783 writeLaTeXSource(os, filePath(), runparams, true, true);
1785 writeDocBookSource(os, absFileName(), runparams, false);
1788 runparams.par_begin = par_begin;
1789 runparams.par_end = par_end;
1790 if (par_begin + 1 == par_end)
1792 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1796 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1797 convert<docstring>(par_begin),
1798 convert<docstring>(par_end - 1))
1800 d->texrow.newline();
1801 d->texrow.newline();
1802 // output paragraphs
1804 latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1807 docbookParagraphs(paragraphs(), *this, os, runparams);
1813 ErrorList & Buffer::errorList(string const & type) const
1815 static ErrorList emptyErrorList;
1816 map<string, ErrorList>::iterator I = d->errorLists.find(type);
1817 if (I == d->errorLists.end())
1818 return emptyErrorList;
1824 void Buffer::structureChanged() const
1827 gui_->structureChanged();
1831 void Buffer::errors(string const & err) const
1838 void Buffer::message(docstring const & msg) const
1845 void Buffer::setBusy(bool on) const
1852 void Buffer::setReadOnly(bool on) const
1855 d->wa_->setReadOnly(on);
1859 void Buffer::updateTitles() const
1862 d->wa_->updateTitles();
1866 void Buffer::resetAutosaveTimers() const
1869 gui_->resetAutosaveTimers();
1873 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
1882 class AutoSaveBuffer : public ForkedProcess {
1885 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
1886 : buffer_(buffer), fname_(fname) {}
1888 virtual boost::shared_ptr<ForkedProcess> clone() const
1890 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
1895 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
1896 from_utf8(fname_.absFilename())));
1897 return run(DontWait);
1901 virtual int generateChild();
1903 Buffer const & buffer_;
1908 #if !defined (HAVE_FORK)
1912 int AutoSaveBuffer::generateChild()
1914 // tmp_ret will be located (usually) in /tmp
1915 // will that be a problem?
1916 pid_t const pid = fork();
1917 // If you want to debug the autosave
1918 // you should set pid to -1, and comment out the fork.
1919 if (pid == 0 || pid == -1) {
1920 // pid = -1 signifies that lyx was unable
1921 // to fork. But we will do the save
1923 bool failed = false;
1925 FileName const tmp_ret(tempName(FileName(), "lyxauto"));
1926 if (!tmp_ret.empty()) {
1927 buffer_.writeFile(tmp_ret);
1928 // assume successful write of tmp_ret
1929 if (!tmp_ret.renameTo(fname_)) {
1931 // most likely couldn't move between
1932 // filesystems unless write of tmp_ret
1933 // failed so remove tmp file (if it
1935 tmp_ret.removeFile();
1942 // failed to write/rename tmp_ret so try writing direct
1943 if (!buffer_.writeFile(fname_)) {
1944 // It is dangerous to do this in the child,
1945 // but safe in the parent, so...
1946 if (pid == -1) // emit message signal.
1947 buffer_.message(_("Autosave failed!"));
1950 if (pid == 0) { // we are the child so...
1960 // Perfect target for a thread...
1961 void Buffer::autoSave() const
1963 if (isBakClean() || isReadonly()) {
1964 // We don't save now, but we'll try again later
1965 resetAutosaveTimers();
1969 // emit message signal.
1970 message(_("Autosaving current document..."));
1972 // create autosave filename
1973 string fname = filePath();
1975 fname += d->filename.onlyFileName();
1978 AutoSaveBuffer autosave(*this, FileName(fname));
1982 resetAutosaveTimers();
1986 void Buffer::resetChildDocuments(bool close_them) const
1988 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1989 if (it->lyxCode() != INCLUDE_CODE)
1991 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
1992 InsetCommandParams const & ip = inset.params();
1994 resetParentBuffer(this, ip, close_them);
1997 if (use_gui && masterBuffer() == this)
1998 updateLabels(*this);
2002 void Buffer::loadChildDocuments() const
2004 bool parse_error = false;
2006 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2007 if (it->lyxCode() != INCLUDE_CODE)
2009 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2010 InsetCommandParams const & ip = inset.params();
2011 Buffer * child = loadIfNeeded(*this, ip);
2014 parse_error |= !child->errorList("Parse").empty();
2015 child->loadChildDocuments();
2018 if (use_gui && masterBuffer() == this)
2019 updateLabels(*this);
2023 string Buffer::bufferFormat() const
2033 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2034 string & result_file) const
2036 string backend_format;
2037 OutputParams runparams(¶ms().encoding());
2038 runparams.flavor = OutputParams::LATEX;
2039 runparams.linelen = lyxrc.plaintext_linelen;
2040 vector<string> backs = backends();
2041 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2042 // Get shortest path to format
2043 Graph::EdgePath path;
2044 for (vector<string>::const_iterator it = backs.begin();
2045 it != backs.end(); ++it) {
2046 Graph::EdgePath p = theConverters().getPath(*it, format);
2047 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2048 backend_format = *it;
2053 runparams.flavor = theConverters().getFlavor(path);
2055 Alert::error(_("Couldn't export file"),
2056 bformat(_("No information for exporting the format %1$s."),
2057 formats.prettyName(format)));
2061 backend_format = format;
2062 // FIXME: Don't hardcode format names here, but use a flag
2063 if (backend_format == "pdflatex")
2064 runparams.flavor = OutputParams::PDFLATEX;
2067 string filename = latexName(false);
2068 filename = addName(temppath(), filename);
2069 filename = changeExtension(filename,
2070 formats.extension(backend_format));
2072 // Plain text backend
2073 if (backend_format == "text")
2074 writePlaintextFile(*this, FileName(filename), runparams);
2076 else if (backend_format == "lyx")
2077 writeFile(FileName(filename));
2079 else if (isDocBook()) {
2080 runparams.nice = !put_in_tempdir;
2081 makeDocBookFile(FileName(filename), runparams);
2084 else if (backend_format == format) {
2085 runparams.nice = true;
2086 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2088 } else if (!lyxrc.tex_allows_spaces
2089 && contains(filePath(), ' ')) {
2090 Alert::error(_("File name error"),
2091 _("The directory path to the document cannot contain spaces."));
2094 runparams.nice = false;
2095 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2099 string const error_type = (format == "program")
2100 ? "Build" : bufferFormat();
2101 string const ext = formats.extension(format);
2102 FileName const tmp_result_file(changeExtension(filename, ext));
2103 bool const success = theConverters().convert(this, FileName(filename),
2104 tmp_result_file, FileName(absFileName()), backend_format, format,
2105 errorList(error_type));
2106 // Emit the signal to show the error list.
2107 if (format != backend_format)
2113 result_file = tmp_result_file.absFilename();
2115 result_file = changeExtension(absFileName(), ext);
2116 // We need to copy referenced files (e. g. included graphics
2117 // if format == "dvi") to the result dir.
2118 vector<ExportedFile> const files =
2119 runparams.exportdata->externalFiles(format);
2120 string const dest = onlyPath(result_file);
2121 CopyStatus status = SUCCESS;
2122 for (vector<ExportedFile>::const_iterator it = files.begin();
2123 it != files.end() && status != CANCEL; ++it) {
2125 formats.getFormatFromFile(it->sourceName);
2126 status = copyFile(fmt, it->sourceName,
2127 makeAbsPath(it->exportName, dest),
2128 it->exportName, status == FORCE);
2130 if (status == CANCEL) {
2131 message(_("Document export cancelled."));
2132 } else if (tmp_result_file.exists()) {
2133 // Finally copy the main file
2134 status = copyFile(format, tmp_result_file,
2135 FileName(result_file), result_file,
2137 message(bformat(_("Document exported as %1$s "
2139 formats.prettyName(format),
2140 makeDisplayPath(result_file)));
2142 // This must be a dummy converter like fax (bug 1888)
2143 message(bformat(_("Document exported as %1$s"),
2144 formats.prettyName(format)));
2152 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2155 return doExport(format, put_in_tempdir, result_file);
2159 bool Buffer::preview(string const & format) const
2162 if (!doExport(format, true, result_file))
2164 return formats.view(*this, FileName(result_file), format);
2168 bool Buffer::isExportable(string const & format) const
2170 vector<string> backs = backends();
2171 for (vector<string>::const_iterator it = backs.begin();
2172 it != backs.end(); ++it)
2173 if (theConverters().isReachable(*it, format))
2179 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2181 vector<string> backs = backends();
2182 vector<Format const *> result =
2183 theConverters().getReachable(backs[0], only_viewable, true);
2184 for (vector<string>::const_iterator it = backs.begin() + 1;
2185 it != backs.end(); ++it) {
2186 vector<Format const *> r =
2187 theConverters().getReachable(*it, only_viewable, false);
2188 result.insert(result.end(), r.begin(), r.end());
2194 vector<string> Buffer::backends() const
2197 if (params().getTextClass().isTeXClassAvailable()) {
2198 v.push_back(bufferFormat());
2199 // FIXME: Don't hardcode format names here, but use a flag
2200 if (v.back() == "latex")
2201 v.push_back("pdflatex");
2203 v.push_back("text");
2209 bool Buffer::readFileHelper(FileName const & s)
2211 // File information about normal file
2213 docstring const file = makeDisplayPath(s.absFilename(), 50);
2214 docstring text = bformat(_("The specified document\n%1$s"
2215 "\ncould not be read."), file);
2216 Alert::error(_("Could not read document"), text);
2220 // Check if emergency save file exists and is newer.
2221 FileName const e(s.absFilename() + ".emergency");
2223 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2224 docstring const file = makeDisplayPath(s.absFilename(), 20);
2225 docstring const text =
2226 bformat(_("An emergency save of the document "
2228 "Recover emergency save?"), file);
2229 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2230 _("&Recover"), _("&Load Original"),
2234 // the file is not saved if we load the emergency file.
2244 // Now check if autosave file is newer.
2245 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2247 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2248 docstring const file = makeDisplayPath(s.absFilename(), 20);
2249 docstring const text =
2250 bformat(_("The backup of the document "
2251 "%1$s is newer.\n\nLoad the "
2252 "backup instead?"), file);
2253 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2254 _("&Load backup"), _("Load &original"),
2258 // the file is not saved if we load the autosave file.
2262 // Here we delete the autosave
2273 bool Buffer::loadLyXFile(FileName const & s)
2275 if (s.isReadableFile()) {
2276 if (readFileHelper(s)) {
2277 lyxvc().file_found_hook(s);
2278 if (!s.isWritable())
2283 docstring const file = makeDisplayPath(s.absFilename(), 20);
2284 // Here we probably should run
2285 if (LyXVC::file_not_found_hook(s)) {
2286 docstring const text =
2287 bformat(_("Do you want to retrieve the document"
2288 " %1$s from version control?"), file);
2289 int const ret = Alert::prompt(_("Retrieve from version control?"),
2290 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2293 // How can we know _how_ to do the checkout?
2294 // With the current VC support it has to be,
2295 // a RCS file since CVS do not have special ,v files.
2297 return loadLyXFile(s);
2305 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2307 TeXErrors::Errors::const_iterator cit = terr.begin();
2308 TeXErrors::Errors::const_iterator end = terr.end();
2310 for (; cit != end; ++cit) {
2313 int errorRow = cit->error_in_line;
2314 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2320 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2321 } while (found && id_start == id_end && pos_start == pos_end);
2323 errorList.push_back(ErrorItem(cit->error_desc,
2324 cit->error_text, id_start, pos_start, pos_end));