X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fexporter.C;h=d3ff74a95ef7e4e2df0315353e267d19c2e17312;hb=cd4033aef3a3f1efdb5a676b8bab3d367f53a830;hp=3d29b191acb24bb84bc67d73b0b889dccd4b451a;hpb=9625f5e2300339330e099ccea259c46667ea1461;p=lyx.git diff --git a/src/exporter.C b/src/exporter.C index 3d29b191ac..d3ff74a95e 100644 --- a/src/exporter.C +++ b/src/exporter.C @@ -1,111 +1,352 @@ -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2000 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 - #include "exporter.h" -#include "converter.h" #include "buffer.h" -#include "support/path.h" +#include "buffer_funcs.h" +#include "bufferparams.h" +#include "converter.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::find; +using std::string; using std::vector; -using std::pair; -extern void ShowMessage(Buffer * buf, - string const & msg1, - string const & msg2 = string(), - string const & msg3 = string(), int delay = 6); +namespace Alert = frontend::Alert; +namespace fs = boost::filesystem; -bool Exporter::Export(Buffer * buffer, string const & format0, - bool put_in_tempdir) +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) { - string using_format, format; - using_format = Converter::SplitFormat(format0, format); - - string filename = buffer->fileName(); - string backend_format = BufferExtension(buffer); - bool only_backend = backend_format == format; - - //string file = buffer->getLatexName(true); - string file = filename; - if (!buffer->tmppath.empty()) - file = AddName(buffer->tmppath, file); - file = ChangeExtension(file, backend_format); - - if (buffer->isLinuxDoc()) - buffer->makeLinuxDocFile(file, only_backend); - else if (only_backend) - buffer->makeLaTeXFile(file, string(), true); - else - buffer->makeLaTeXFile(file, buffer->filepath, false); - - bool return_value = Converter::convert(buffer, file, format0); - if (!return_value) + 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; + 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) { + Graph::EdgePath p = theConverters().getPath(*it, format); + if (!p.empty() && (path.empty() || p.size() < path.size())) { + backend_format = *it; + path = p; + } + } + 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 { + 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); + filename = addName(buffer->temppath(), filename); + filename = changeExtension(filename, + formats.extension(backend_format)); + + // Plain text backend + if (backend_format == "text") + writePlaintextFile(*buffer, FileName(filename), runparams); + // no backend + else if (backend_format == "lyx") + buffer->writeFile(FileName(filename)); + // Docbook backend + else if (buffer->isDocBook()) { + runparams.nice = !put_in_tempdir; + buffer->makeDocBookFile(FileName(filename), runparams); + } + // LaTeX backend + 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 { + runparams.nice = false; + if (!buffer->makeLaTeXFile(FileName(filename), buffer->filePath(), runparams)) + return false; + } + + 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) { - file = ChangeExtension(file, format); - string outfile = ChangeExtension(filename, format); - if (file != outfile) - rename(file.c_str(), outfile.c_str()); - - ShowMessage(buffer, - _("Document exported as ") - + Formats::PrettyName(format) - + _(" to file `") - + MakeDisplayPath(outfile) +'\''); + 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::Preview(Buffer * buffer, string const & format0) +bool Exporter::Export(Buffer * buffer, string const & format, + bool put_in_tempdir) +{ + string result_file; + return Export(buffer, format, put_in_tempdir, result_file); +} + + +bool Exporter::preview(Buffer * buffer, string const & format) { - if (!Export(buffer, format0, true)) + string result_file; + if (!Export(buffer, format, true, result_file)) return false; + return formats.view(*buffer, FileName(result_file), format); +} - string format; - Converter::SplitFormat(format0, format); - string filename = buffer->fileName(); - if (!buffer->tmppath.empty()) - filename = AddName(buffer->tmppath, filename); - filename = ChangeExtension(filename, format); - return Formats::View(filename); +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 (theConverters().isReachable(*it, format)) + return true; + return false; } -vector > Exporter::GetExportableFormats(Buffer * buffer) +vector const +Exporter::getExportableFormats(Buffer const & buffer, bool only_viewable) { - return Converter::GetReachable(BufferExtension(buffer), false); + vector backends = Backends(buffer); + vector result = + theConverters().getReachable(backends[0], only_viewable, true); + for (vector::const_iterator it = backends.begin() + 1; + it != backends.end(); ++it) { + vector r = + theConverters().getReachable(*it, only_viewable, false); + result.insert(result.end(), r.begin(), r.end()); + } + return result; } -vector > Exporter::GetViewableFormats(Buffer * buffer) +ExportedFile::ExportedFile(FileName const & s, string const & e) : + sourceName(s), exportName(e) {} + + +bool operator==(ExportedFile const & f1, ExportedFile const & f2) { - return Converter::GetReachable(BufferExtension(buffer), true); + return f1.sourceName == f2.sourceName && + f1.exportName == f2.exportName; + } -string Exporter::BufferExtension(Buffer * buffer) + +void ExportData::addExternalFile(string const & format, + FileName const & sourceName, + string const & exportName) { - if (buffer->isLinuxDoc()) - return "sgml"; - else - return "tex"; + // 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