-/* This file is part of
- * ======================================================
+/**
+ * \file exporter.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author unknown
+ * \author Alfredo Braunstein
+ * \author Lars Gullik Bjønnes
+ * \author Jean Marc Lasgouttes
+ * \author Angus Leeming
+ * \author John Levon
+ * \author André Pönitz
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include <algorithm>
-
#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 "BufferView.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::vector;
using std::find;
+using std::string;
+using std::vector;
-bool Exporter::Export(Buffer * buffer, string const & format,
- bool put_in_tempdir, string & result_file)
+namespace fs = boost::filesystem;
+
+namespace {
+
+vector<string> const Backends(Buffer const & buffer)
+{
+ vector<string> v;
+ if (buffer.params().getLyXTextClass().isTeXClassAvailable())
+ v.push_back(BufferFormat(buffer));
+ v.push_back("text");
+ return v;
+}
+
+
+/// ask the user what to do if a file already exists
+int checkOverwrite(string const & filename)
{
- // There are so many different places that this function can be called
- // from that the removal of auto insets is best done here. This ensures
- // we always have a clean buffer for inserting errors found during export.
- BufferView * bv = buffer->getUser();
- if (bv) {
- // Remove all error insets
- if (bv->removeAutoInsets()) {
-#warning repaint() or update() or nothing ?
- bv->repaint();
- bv->fitCursor();
+ 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;
+}
+
+} //namespace anon
+
+
+bool Exporter::Export(Buffer * buffer, string const & format,
+ bool put_in_tempdir, string & result_file)
+{
string backend_format;
- vector<string> backends = Backends(buffer);
+ OutputParams runparams;
+ runparams.flavor = OutputParams::LATEX;
+ runparams.linelen = lyxrc.ascii_linelen;
+ vector<string> backends = Backends(*buffer);
if (find(backends.begin(), backends.end(), format) == backends.end()) {
for (vector<string>::const_iterator it = backends.begin();
it != backends.end(); ++it) {
- Converters::EdgePath p =
+ Graph::EdgePath p =
converters.getPath(*it, format);
if (!p.empty()) {
- lyxrc.pdf_mode = converters.usePdflatex(p);
+ runparams.flavor = converters.getFlavor(p);
backend_format = *it;
break;
}
}
if (backend_format.empty()) {
- Alert::alert(_("Cannot export file"),
- _("No information for exporting to ")
- + formats.prettyName(format));
+ Alert::error(_("Couldn't export file"),
+ bformat(_("No information for exporting the format %1$s."),
+ formats.prettyName(format)));
return false;
}
} else
backend_format = format;
string filename = buffer->getLatexName(false);
- if (!buffer->tmppath.empty())
- filename = AddName(buffer->tmppath, filename);
+ filename = AddName(buffer->temppath(), filename);
filename = ChangeExtension(filename,
formats.extension(backend_format));
// Ascii backend
if (backend_format == "text")
- buffer->writeFileAscii(filename, lyxrc.ascii_linelen);
+ writeFileAscii(*buffer, filename, runparams);
// Linuxdoc backend
- else if (buffer->isLinuxDoc())
- buffer->makeLinuxDocFile(filename, !put_in_tempdir);
+ else if (buffer->isLinuxDoc()) {
+ runparams.nice = !put_in_tempdir;
+ buffer->makeLinuxDocFile(filename, runparams);
+ }
// Docbook backend
- else if (buffer->isDocBook())
- buffer->makeDocBookFile(filename, !put_in_tempdir);
+ else if (buffer->isDocBook()) {
+ runparams.nice = !put_in_tempdir;
+ buffer->makeDocBookFile(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;
+ buffer->makeLaTeXFile(filename, string(), runparams);
+ } else if (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;
+ buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
+ }
- if (!converters.convert(buffer, filename, outfile_base,
+ 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(result_file) +'\'');
+ 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 {
+ // 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)));
+ }
+ }
+
return true;
}
string result_file;
if (!Export(buffer, format, true, result_file))
return false;
- return formats.view(buffer, result_file, format);
+ return formats.view(*buffer, result_file, format);
}
-bool Exporter::IsExportable(Buffer const * buffer, string const & format)
+bool Exporter::IsExportable(Buffer const & buffer, string const & format)
{
vector<string> backends = Backends(buffer);
for (vector<string>::const_iterator it = backends.begin();
vector<Format const *> const
-Exporter::GetExportableFormats(Buffer const * buffer, bool only_viewable)
+Exporter::GetExportableFormats(Buffer const & buffer, bool only_viewable)
{
vector<string> backends = Backends(buffer);
vector<Format const *> result =
}
-string const Exporter::BufferFormat(Buffer const * buffer)
+ExportedFile::ExportedFile(string 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<string> const Exporter::Backends(Buffer const * buffer)
+void ExportData::addExternalFile(string const & format,
+ string const & sourceName,
+ string const & exportName)
{
- vector<string> v;
- v.push_back(BufferFormat(buffer));
- v.push_back("text");
- return v;
+ 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));
+}
+
+
+vector<ExportedFile> const
+ExportData::externalFiles(string const & format) const
+{
+ FileMap::const_iterator cit = externalfiles.find(format);
+ if (cit != externalfiles.end())
+ return cit->second;
+ return vector<ExportedFile>();
}
projects / lyx.git / blobdiff