-/* 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 <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "exporter.h"
-#include "converter.h"
+
#include "buffer.h"
-#include "lyx_cb.h" //ShowMessage()
-#include "support/filetools.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 <boost/filesystem/operations.hpp>
+using lyx::support::addName;
+using lyx::support::bformat;
+using lyx::support::changeExtension;
+using lyx::support::contains;
+using lyx::support::makeAbsPath;
+using lyx::support::makeDisplayPath;
+using lyx::support::onlyFilename;
+using lyx::support::onlyPath;
+using lyx::support::package;
+using lyx::support::prefixIs;
+
+using std::find;
+using std::string;
using std::vector;
-using std::pair;
-bool Exporter::Export(Buffer * buffer, string const & format0,
- bool put_in_tempdir, string * view_file)
+namespace fs = boost::filesystem;
+
+namespace {
+
+vector<string> const Backends(Buffer const & buffer)
{
- string format;
- string using_format = Converter::SplitFormat(format0, format);
+ vector<string> 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(string const & filename)
+{
+ if (fs::exists(filename)) {
+ string text = bformat(_("The file %1$s already exists.\n\n"
+ "Do you want to over-write that file?"),
+ makeDisplayPath(filename));
+ 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,
+ string const & sourceFile, string 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), 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 = movers(format);
+ if (!mover.copy(sourceFile, destFile, latexFile))
+ Alert::error(_("Couldn't copy file"),
+ bformat(_("Copying %1$s to %2$s failed."),
+ makeDisplayPath(sourceFile),
+ makeDisplayPath(destFile)));
+
+ return ret;
+}
- string backend_format = (format == "txt")
- ? format : BufferExtension(buffer);
- bool only_backend = backend_format == format;
+} //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.ascii_linelen;
+ vector<string> backends = Backends(*buffer);
+ // FIXME: Without this test export to lyx13 would be through
+ // latex -> lyx -> lyx13, because the first backend below with a
+ // working conversion path is used. We should replace this test and
+ // the explicit loop below with a method
+ // getShortestPath(vector<string> const & from, string const & to)
+ // which returns the shortest path from one of the formats in 'from'
+ // to 'to'.
+ if (format == "lyx13x" && !converters.getPath("lyx", format).empty())
+ backend_format = "lyx";
+ else if (find(backends.begin(), backends.end(), format) == backends.end()) {
+ for (vector<string>::const_iterator it = backends.begin();
+ it != backends.end(); ++it) {
+ Graph::EdgePath p = converters.getPath(*it, format);
+ if (!p.empty()) {
+ runparams.flavor = converters.getFlavor(p);
+ backend_format = *it;
+ break;
+ }
+ }
+ if (backend_format.empty()) {
+ 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);
- if (!buffer->tmppath.empty())
- filename = AddName(buffer->tmppath, filename);
- filename = ChangeExtension(filename, backend_format);
+ filename = addName(buffer->temppath(), filename);
+ filename = changeExtension(filename,
+ formats.extension(backend_format));
// Ascii backend
- if (backend_format == "txt")
- buffer->writeFileAscii(filename, lyxrc.ascii_linelen);
+ if (backend_format == "text")
+ writeFileAscii(*buffer, filename, runparams);
+ // no backend
+ else if (backend_format == "lyx")
+ buffer->writeFile(filename);
// Linuxdoc backend
- else if (buffer->isLinuxDoc())
- buffer->makeLinuxDocFile(filename, true);
+ else if (buffer->isLinuxDoc()) {
+ runparams.nice = !put_in_tempdir;
+ buffer->makeLinuxDocFile(filename, runparams);
+ }
// Docbook backend
- else if (buffer->isDocBook())
- buffer->makeDocBookFile(filename, true);
+ else if (buffer->isDocBook()) {
+ runparams.nice = !put_in_tempdir;
+ buffer->makeDocBookFile(filename, runparams);
+ }
// LaTeX backend
- else if (only_backend)
- buffer->makeLaTeXFile(filename, string(), true);
- else
- buffer->makeLaTeXFile(filename, buffer->filepath, false);
-
- string outfile = (put_in_tempdir)
- ? ChangeExtension(filename, format)
- : ChangeExtension(buffer->getLatexName(false), format);
+ else if (backend_format == format) {
+ runparams.nice = true;
+ buffer->makeLaTeXFile(filename, string(), runparams);
+ } 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;
+ buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
+ }
- if (!Converter::Convert(buffer, filename, outfile, using_format,
- view_file))
+ if (!converters.convert(buffer, filename, filename,
+ backend_format, format, result_file))
return false;
- if (!put_in_tempdir)
- ShowMessage(buffer,
- _("Document exported as ")
- + Formats::PrettyName(format)
- + _(" to file `")
- + MakeDisplayPath(outfile) +'\'');
+ if (!put_in_tempdir) {
+ string const tmp_result_file = result_file;
+ result_file = changeExtension(buffer->fileName(),
+ formats.extension(format));
+ // We need to copy referenced files (e. g. included graphics
+ // if format == "dvi") to the result dir.
+ vector<ExportedFile> const files =
+ runparams.exportdata->externalFiles(format);
+ string const dest = onlyPath(result_file);
+ CopyStatus status = SUCCESS;
+ for (vector<ExportedFile>::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)) {
+ // Finally copy the main file
+ status = copyFile(format, tmp_result_file,
+ 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 view_file;
- if (!Export(buffer, format0, true, &view_file))
+ string result_file;
+ return Export(buffer, format, put_in_tempdir, result_file);
+}
+
+
+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, view_file);
+bool Exporter::IsExportable(Buffer const & buffer, string const & format)
+{
+ vector<string> backends = Backends(buffer);
+ for (vector<string>::const_iterator it = backends.begin();
+ it != backends.end(); ++it)
+ if (converters.isReachable(*it, format))
+ return true;
+ return false;
}
-vector<pair<string, string> > const
-Exporter::GetExportableFormats(Buffer const * buffer)
+vector<Format const *> const
+Exporter::GetExportableFormats(Buffer const & buffer, bool only_viewable)
{
- vector<pair<string, string> > result =
- Converter::GetReachable(BufferExtension(buffer), false);
- result.push_back(pair<string,string>("txt", "Ascii"));
+ vector<string> backends = Backends(buffer);
+ vector<Format const *> result =
+ converters.getReachable(backends[0], only_viewable, true);
+ for (vector<string>::const_iterator it = backends.begin() + 1;
+ it != backends.end(); ++it) {
+ vector<Format const *> r =
+ converters.getReachable(*it, only_viewable, false);
+ result.insert(result.end(), r.begin(), r.end());
+ }
return result;
}
-vector<pair<string, string> > const
-Exporter::GetViewableFormats(Buffer const * buffer)
+ExportedFile::ExportedFile(string const & s, string const & e) :
+ sourceName(s), exportName(e) {}
+
+
+bool operator==(ExportedFile const & f1, ExportedFile const & f2)
{
- vector<pair<string, string> > result =
- Converter::GetReachable(BufferExtension(buffer), false);
- Format * format = Formats::GetFormat("txt");
- if (format && !format->viewer.empty())
- result.push_back(pair<string,string>("txt", "Ascii"));
- return result;
+ return f1.sourceName == f2.sourceName &&
+ f1.exportName == f2.exportName;
+
+}
+
+
+void ExportData::addExternalFile(string const & format,
+ string const & sourceName,
+ string const & exportName)
+{
+ BOOST_ASSERT(lyx::support::absolutePath(sourceName));
+
+ // Make sure that we have every file only once, otherwise copyFile()
+ // would ask several times if it should overwrite a file.
+ vector<ExportedFile> & 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,
+ string const & sourceName)
+{
+ addExternalFile(format, sourceName, onlyFilename(sourceName));
}
-string const Exporter::BufferExtension(Buffer const * buffer)
+vector<ExportedFile> const
+ExportData::externalFiles(string const & format) const
{
- if (buffer->isLinuxDoc())
- return "sgml";
- else if (buffer->isDocBook())
- return "docbook";
- else
- return "tex";
+ FileMap::const_iterator cit = externalfiles.find(format);
+ if (cit != externalfiles.end())
+ return cit->second;
+ return vector<ExportedFile>();
}
projects / lyx.git / blobdiff