X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fexporter.C;h=d3ff74a95ef7e4e2df0315353e267d19c2e17312;hb=cd4033aef3a3f1efdb5a676b8bab3d367f53a830;hp=4a779ca0e3ced8c9667fa8bfb4b1c0fbeabe0c91;hpb=fb424bae1b693200ba4a506b2775929d25d77be3;p=lyx.git diff --git a/src/exporter.C b/src/exporter.C index 4a779ca0e3..d3ff74a95e 100644 --- a/src/exporter.C +++ b/src/exporter.C @@ -1,99 +1,268 @@ -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. +/** + * \file exporter.C + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * ====================================================== */ + * \author unknown + * \author Alfredo Braunstein + * \author Lars Gullik Bjønnes + * \author Jean Marc Lasgouttes + * \author Angus Leeming + * \author John Levon + * \author André Pönitz + * + * Full author contact details are available in file CREDITS. + */ #include -#ifdef __GNUG__ -#pragma implementation -#endif - -#include - #include "exporter.h" + #include "buffer.h" -#include "lyx_cb.h" //ShowMessage() -#include "support/filetools.h" -#include "lyxrc.h" +#include "buffer_funcs.h" +#include "bufferparams.h" #include "converter.h" -#include "frontends/Alert.h" +#include "format.h" #include "gettext.h" +#include "lyxrc.h" +#include "mover.h" +#include "output_plaintext.h" +#include "outputparams.h" +#include "frontends/Alert.h" + +#include "support/filetools.h" +#include "support/lyxlib.h" +#include "support/package.h" + +#include + + +namespace lyx { + +using support::addName; +using support::bformat; +using support::changeExtension; +using support::contains; +using support::FileName; +using support::makeAbsPath; +using support::makeDisplayPath; +using support::onlyFilename; +using support::onlyPath; +using support::package; +using support::prefixIs; -using std::vector; using std::find; +using std::string; +using std::vector; + +namespace Alert = frontend::Alert; +namespace fs = boost::filesystem; + +namespace { + +vector const Backends(Buffer const & buffer) +{ + vector v; + if (buffer.params().getLyXTextClass().isTeXClassAvailable()) { + v.push_back(bufferFormat(buffer)); + // FIXME: Don't hardcode format names here, but use a flag + if (v.back() == "latex") + v.push_back("pdflatex"); + } + v.push_back("text"); + v.push_back("lyx"); + return v; +} + + +/// ask the user what to do if a file already exists +int checkOverwrite(FileName const & filename) +{ + if (fs::exists(filename.toFilesystemEncoding())) { + docstring text = bformat(_("The file %1$s already exists.\n\n" + "Do you want to over-write that file?"), + makeDisplayPath(filename.absFilename())); + return Alert::prompt(_("Over-write file?"), + text, 0, 2, + _("&Over-write"), _("Over-write &all"), + _("&Cancel export")); + } + return 0; +} + + +enum CopyStatus { + SUCCESS, + FORCE, + CANCEL +}; + + +/** copy file \p sourceFile to \p destFile. If \p force is false, the user + * will be asked before existing files are overwritten. + * \return + * - SUCCESS if this file got copied + * - FORCE if subsequent calls should not ask for confirmation before + * overwriting files anymore. + * - CANCEL if the export should be cancelled + */ +CopyStatus copyFile(string const & format, + FileName const & sourceFile, FileName const & destFile, + string const & latexFile, bool force) +{ + CopyStatus ret = force ? FORCE : SUCCESS; + + // Only copy files that are in our tmp dir, all other files would + // overwrite themselves. This check could be changed to + // boost::filesystem::equivalent(sourceFile, destFile) if export to + // other directories than the document directory is desired. + if (!prefixIs(onlyPath(sourceFile.absFilename()), package().temp_dir())) + return ret; + + if (!force) { + switch(checkOverwrite(destFile)) { + case 0: + ret = SUCCESS; + break; + case 1: + ret = FORCE; + break; + default: + return CANCEL; + } + } + + Mover const & mover = getMover(format); + if (!mover.copy(sourceFile, destFile, latexFile)) + Alert::error(_("Couldn't copy file"), + bformat(_("Copying %1$s to %2$s failed."), + makeDisplayPath(sourceFile.absFilename()), + makeDisplayPath(destFile.absFilename()))); + + return ret; +} + +} //namespace anon + bool Exporter::Export(Buffer * buffer, string const & format, bool put_in_tempdir, string & result_file) { string backend_format; - vector backends = Backends(buffer); + OutputParams runparams; + runparams.flavor = OutputParams::LATEX; + runparams.linelen = lyxrc.plaintext_linelen; + vector backends = Backends(*buffer); if (find(backends.begin(), backends.end(), format) == backends.end()) { + // Get shortest path to format + Graph::EdgePath path; for (vector::const_iterator it = backends.begin(); it != backends.end(); ++it) { - Converters::EdgePath p = - converters.getPath(*it, format); - if (!p.empty()) { - lyxrc.pdf_mode = converters.usePdflatex(p); + Graph::EdgePath p = theConverters().getPath(*it, format); + if (!p.empty() && (path.empty() || p.size() < path.size())) { backend_format = *it; - break; + path = p; } } - if (backend_format.empty()) { - Alert::alert(_("Cannot export file"), - _("No information for exporting to ") - + formats.prettyName(format)); + if (!path.empty()) + runparams.flavor = theConverters().getFlavor(path); + else { + Alert::error(_("Couldn't export file"), + bformat(_("No information for exporting the format %1$s."), + formats.prettyName(format))); return false; } - } else + } else { backend_format = format; + // FIXME: Don't hardcode format names here, but use a flag + if (backend_format == "pdflatex") + runparams.flavor = OutputParams::PDFLATEX; + } string filename = buffer->getLatexName(false); - if (!buffer->tmppath.empty()) - filename = AddName(buffer->tmppath, filename); - filename = ChangeExtension(filename, + filename = addName(buffer->temppath(), filename); + filename = changeExtension(filename, formats.extension(backend_format)); - // Ascii backend + // Plain text backend if (backend_format == "text") - buffer->writeFileAscii(filename, lyxrc.ascii_linelen); - // Linuxdoc backend - else if (buffer->isLinuxDoc()) - buffer->makeLinuxDocFile(filename, true); + writePlaintextFile(*buffer, FileName(filename), runparams); + // no backend + else if (backend_format == "lyx") + buffer->writeFile(FileName(filename)); // Docbook backend - else if (buffer->isDocBook()) - buffer->makeDocBookFile(filename, true); + else if (buffer->isDocBook()) { + runparams.nice = !put_in_tempdir; + buffer->makeDocBookFile(FileName(filename), runparams); + } // LaTeX backend - else if (backend_format == format) - buffer->makeLaTeXFile(filename, string(), true); - else if (contains(buffer->filePath(), ' ')) { - Alert::alert(_("Cannot run latex."), - _("The path to the lyx file cannot contain spaces.")); + else if (backend_format == format) { + runparams.nice = true; + if (!buffer->makeLaTeXFile(FileName(filename), string(), runparams)) + return false; + } else if (!lyxrc.tex_allows_spaces + && contains(buffer->filePath(), ' ')) { + Alert::error(_("File name error"), + _("The directory path to the document cannot contain spaces.")); return false; - } else - buffer->makeLaTeXFile(filename, buffer->filePath(), false); - - string outfile_base = (put_in_tempdir) - ? filename : buffer->getLatexName(false); + } else { + runparams.nice = false; + if (!buffer->makeLaTeXFile(FileName(filename), buffer->filePath(), runparams)) + return false; + } - if (!converters.convert(buffer, filename, outfile_base, - backend_format, format, result_file)) + string const error_type = (format == "program")? "Build" : bufferFormat(*buffer); + string const ext = formats.extension(format); + FileName const tmp_result_file(changeExtension(filename, ext)); + bool const success = theConverters().convert(buffer, FileName(filename), + tmp_result_file, FileName(buffer->fileName()), backend_format, format, + buffer->errorList(error_type)); + // Emit the signal to show the error list. + if (format != backend_format) + buffer->errors(error_type); + if (!success) return false; - if (!put_in_tempdir) - ShowMessage(buffer, - _("Document exported as ") - + formats.prettyName(format) - + _(" to file `") - + MakeDisplayPath(result_file) +'\''); + if (put_in_tempdir) + result_file = tmp_result_file.absFilename(); + else { + result_file = changeExtension(buffer->fileName(), ext); + // We need to copy referenced files (e. g. included graphics + // if format == "dvi") to the result dir. + vector const files = + runparams.exportdata->externalFiles(format); + string const dest = onlyPath(result_file); + CopyStatus status = SUCCESS; + for (vector::const_iterator it = files.begin(); + it != files.end() && status != CANCEL; ++it) { + string const fmt = + formats.getFormatFromFile(it->sourceName); + status = copyFile(fmt, it->sourceName, + makeAbsPath(it->exportName, dest), + it->exportName, status == FORCE); + } + if (status == CANCEL) { + buffer->message(_("Document export cancelled.")); + } else if (fs::exists(tmp_result_file.toFilesystemEncoding())) { + // Finally copy the main file + status = copyFile(format, tmp_result_file, + FileName(result_file), result_file, + status == FORCE); + buffer->message(bformat(_("Document exported as %1$s " + "to file `%2$s'"), + formats.prettyName(format), + makeDisplayPath(result_file))); + } else { + // This must be a dummy converter like fax (bug 1888) + buffer->message(bformat(_("Document exported as %1$s"), + formats.prettyName(format))); + } + } + return true; } + bool Exporter::Export(Buffer * buffer, string const & format, bool put_in_tempdir) { @@ -101,58 +270,83 @@ bool Exporter::Export(Buffer * buffer, string const & format, return Export(buffer, format, put_in_tempdir, result_file); } -bool Exporter::Preview(Buffer * buffer, string const & format) + +bool Exporter::preview(Buffer * buffer, string const & format) { string result_file; if (!Export(buffer, format, true, result_file)) return false; - return formats.view(buffer, result_file, format); + return formats.view(*buffer, FileName(result_file), format); } -bool Exporter::IsExportable(Buffer const * buffer, string const & format) +bool Exporter::isExportable(Buffer const & buffer, string const & format) { vector backends = Backends(buffer); for (vector::const_iterator it = backends.begin(); it != backends.end(); ++it) - if (converters.isReachable(*it, format)) + if (theConverters().isReachable(*it, format)) return true; return false; } vector const -Exporter::GetExportableFormats(Buffer const * buffer, bool only_viewable) +Exporter::getExportableFormats(Buffer const & buffer, bool only_viewable) { vector backends = Backends(buffer); - vector result = - converters.getReachable(backends[0], only_viewable, true); + vector result = + theConverters().getReachable(backends[0], only_viewable, true); for (vector::const_iterator it = backends.begin() + 1; it != backends.end(); ++it) { vector r = - converters.getReachable(*it, only_viewable, false); + theConverters().getReachable(*it, only_viewable, false); result.insert(result.end(), r.begin(), r.end()); } return result; } -string const Exporter::BufferFormat(Buffer const * buffer) +ExportedFile::ExportedFile(FileName const & s, string const & e) : + sourceName(s), exportName(e) {} + + +bool operator==(ExportedFile const & f1, ExportedFile const & f2) { - if (buffer->isLinuxDoc()) - return "linuxdoc"; - else if (buffer->isDocBook()) - return "docbook"; - else if (buffer->isLiterate()) - return "literate"; - else - return "latex"; + return f1.sourceName == f2.sourceName && + f1.exportName == f2.exportName; + } -vector const Exporter::Backends(Buffer const * buffer) + +void ExportData::addExternalFile(string const & format, + FileName const & sourceName, + string const & exportName) { - vector v; - v.push_back(BufferFormat(buffer)); - v.push_back("text"); - return v; + // Make sure that we have every file only once, otherwise copyFile() + // would ask several times if it should overwrite a file. + vector & files = externalfiles[format]; + ExportedFile file(sourceName, exportName); + if (find(files.begin(), files.end(), file) == files.end()) + files.push_back(file); +} + + +void ExportData::addExternalFile(string const & format, + FileName const & sourceName) +{ + addExternalFile(format, sourceName, onlyFilename(sourceName.absFilename())); } + + +vector const +ExportData::externalFiles(string const & format) const +{ + FileMap::const_iterator cit = externalfiles.find(format); + if (cit != externalfiles.end()) + return cit->second; + return vector(); +} + + +} // namespace lyx