2003-03-31 01:15:44 +00:00
|
|
|
|
/**
|
|
|
|
|
* \file exporter.C
|
|
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
|
* Licence details can be found in the file COPYING.
|
2002-03-21 17:27:08 +00:00
|
|
|
|
*
|
2003-03-31 01:15:44 +00:00
|
|
|
|
* \author unknown
|
2003-08-23 00:17:00 +00:00
|
|
|
|
* \author Alfredo Braunstein
|
|
|
|
|
* \author Lars Gullik Bj<EFBFBD>nnes
|
|
|
|
|
* \author Jean Marc Lasgouttes
|
|
|
|
|
* \author Angus Leeming
|
|
|
|
|
* \author John Levon
|
|
|
|
|
* \author Andr<EFBFBD> P<EFBFBD>nitz
|
2002-03-21 17:27:08 +00:00
|
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
|
* Full author contact details are available in file CREDITS.
|
2003-03-31 01:15:44 +00:00
|
|
|
|
*/
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
|
|
|
|
#include <config.h>
|
|
|
|
|
|
|
|
|
|
#include "exporter.h"
|
2003-09-06 23:36:02 +00:00
|
|
|
|
|
2000-08-30 03:40:51 +00:00
|
|
|
|
#include "buffer.h"
|
2003-06-24 20:42:15 +00:00
|
|
|
|
#include "buffer_funcs.h"
|
2003-09-09 11:24:33 +00:00
|
|
|
|
#include "bufferparams.h"
|
2000-10-16 13:27:56 +00:00
|
|
|
|
#include "converter.h"
|
2003-02-28 09:49:49 +00:00
|
|
|
|
#include "format.h"
|
2001-04-05 12:26:41 +00:00
|
|
|
|
#include "gettext.h"
|
2003-09-06 23:36:02 +00:00
|
|
|
|
#include "lyxrc.h"
|
2004-11-01 08:50:42 +00:00
|
|
|
|
#include "mover.h"
|
2003-11-05 12:06:20 +00:00
|
|
|
|
#include "output_plaintext.h"
|
|
|
|
|
#include "outputparams.h"
|
2003-09-06 23:36:02 +00:00
|
|
|
|
#include "frontends/Alert.h"
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2003-09-06 23:36:02 +00:00
|
|
|
|
#include "support/filetools.h"
|
2004-06-01 13:39:33 +00:00
|
|
|
|
#include "support/lyxlib.h"
|
2005-01-10 19:17:43 +00:00
|
|
|
|
#include "support/package.h"
|
2003-05-13 09:48:57 +00:00
|
|
|
|
|
2005-01-31 10:42:26 +00:00
|
|
|
|
#include <boost/filesystem/operations.hpp>
|
|
|
|
|
|
2003-09-09 22:13:45 +00:00
|
|
|
|
using lyx::support::AddName;
|
|
|
|
|
using lyx::support::bformat;
|
|
|
|
|
using lyx::support::ChangeExtension;
|
|
|
|
|
using lyx::support::contains;
|
2004-06-01 13:39:33 +00:00
|
|
|
|
using lyx::support::MakeAbsPath;
|
2003-09-09 22:13:45 +00:00
|
|
|
|
using lyx::support::MakeDisplayPath;
|
2004-06-01 13:39:33 +00:00
|
|
|
|
using lyx::support::OnlyFilename;
|
|
|
|
|
using lyx::support::OnlyPath;
|
2005-01-10 19:17:43 +00:00
|
|
|
|
using lyx::support::package;
|
2004-06-01 13:39:33 +00:00
|
|
|
|
using lyx::support::prefixIs;
|
2003-06-30 23:56:22 +00:00
|
|
|
|
|
2000-11-13 10:35:02 +00:00
|
|
|
|
using std::find;
|
2003-10-06 15:43:21 +00:00
|
|
|
|
using std::string;
|
2003-09-08 00:33:41 +00:00
|
|
|
|
using std::vector;
|
|
|
|
|
|
2005-01-31 10:42:26 +00:00
|
|
|
|
namespace fs = boost::filesystem;
|
2003-06-24 20:42:15 +00:00
|
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
|
|
2003-08-28 07:41:31 +00:00
|
|
|
|
vector<string> const Backends(Buffer const & buffer)
|
2003-06-24 20:42:15 +00:00
|
|
|
|
{
|
|
|
|
|
vector<string> v;
|
2006-03-28 18:49:46 +00:00
|
|
|
|
if (buffer.params().getLyXTextClass().isTeXClassAvailable()) {
|
2003-08-28 07:41:31 +00:00
|
|
|
|
v.push_back(BufferFormat(buffer));
|
2006-03-28 18:49:46 +00:00
|
|
|
|
// FIXME: Don't hardcode format names here, but use a flag
|
|
|
|
|
if (v.back() == "latex")
|
|
|
|
|
v.push_back("pdflatex");
|
|
|
|
|
}
|
2003-06-24 20:42:15 +00:00
|
|
|
|
v.push_back("text");
|
2006-02-03 21:47:25 +00:00
|
|
|
|
v.push_back("lyx");
|
2003-06-24 20:42:15 +00:00
|
|
|
|
return v;
|
|
|
|
|
}
|
|
|
|
|
|
2004-06-01 13:39:33 +00:00
|
|
|
|
|
|
|
|
|
/// ask the user what to do if a file already exists
|
|
|
|
|
int checkOverwrite(string const & filename)
|
|
|
|
|
{
|
2005-01-31 10:42:26 +00:00
|
|
|
|
if (fs::exists(filename)) {
|
2004-06-01 13:39:33 +00:00
|
|
|
|
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.
|
2004-10-05 10:11:42 +00:00
|
|
|
|
* \return
|
2004-06-01 13:39:33 +00:00
|
|
|
|
* - 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
|
|
|
|
|
*/
|
2004-11-01 08:50:42 +00:00
|
|
|
|
CopyStatus copyFile(string const & format,
|
|
|
|
|
string const & sourceFile, string const & destFile,
|
|
|
|
|
string const & latexFile, bool force)
|
2004-06-01 13:39:33 +00:00
|
|
|
|
{
|
|
|
|
|
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.
|
2005-01-10 19:17:43 +00:00
|
|
|
|
if (!prefixIs(OnlyPath(sourceFile), package().temp_dir()))
|
2004-06-01 13:39:33 +00:00
|
|
|
|
return ret;
|
|
|
|
|
|
|
|
|
|
if (!force) {
|
|
|
|
|
switch(checkOverwrite(destFile)) {
|
|
|
|
|
case 0:
|
|
|
|
|
ret = SUCCESS;
|
|
|
|
|
break;
|
|
|
|
|
case 1:
|
|
|
|
|
ret = FORCE;
|
|
|
|
|
break;
|
|
|
|
|
default:
|
|
|
|
|
return CANCEL;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2004-11-01 08:50:42 +00:00
|
|
|
|
Mover const & mover = movers(format);
|
|
|
|
|
if (!mover.copy(sourceFile, destFile, latexFile))
|
2004-06-01 13:39:33 +00:00
|
|
|
|
Alert::error(_("Couldn't copy file"),
|
|
|
|
|
bformat(_("Copying %1$s to %2$s failed."),
|
|
|
|
|
MakeDisplayPath(sourceFile),
|
|
|
|
|
MakeDisplayPath(destFile)));
|
|
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
|
}
|
|
|
|
|
|
2003-06-24 20:42:15 +00:00
|
|
|
|
} //namespace anon
|
|
|
|
|
|
|
|
|
|
|
2000-11-13 10:35:02 +00:00
|
|
|
|
bool Exporter::Export(Buffer * buffer, string const & format,
|
2000-10-23 12:16:05 +00:00
|
|
|
|
bool put_in_tempdir, string & result_file)
|
2000-08-30 03:40:51 +00:00
|
|
|
|
{
|
2000-11-13 10:35:02 +00:00
|
|
|
|
string backend_format;
|
2003-11-05 12:06:20 +00:00
|
|
|
|
OutputParams runparams;
|
|
|
|
|
runparams.flavor = OutputParams::LATEX;
|
2003-10-31 18:45:43 +00:00
|
|
|
|
runparams.linelen = lyxrc.ascii_linelen;
|
2003-08-28 07:41:31 +00:00
|
|
|
|
vector<string> backends = Backends(*buffer);
|
2006-02-03 21:47:25 +00:00
|
|
|
|
// 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()) {
|
2000-11-13 10:35:02 +00:00
|
|
|
|
for (vector<string>::const_iterator it = backends.begin();
|
|
|
|
|
it != backends.end(); ++it) {
|
2006-02-03 21:47:25 +00:00
|
|
|
|
Graph::EdgePath p = converters.getPath(*it, format);
|
2000-11-13 10:35:02 +00:00
|
|
|
|
if (!p.empty()) {
|
2003-11-27 16:38:47 +00:00
|
|
|
|
runparams.flavor = converters.getFlavor(p);
|
2000-11-13 10:35:02 +00:00
|
|
|
|
backend_format = *it;
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if (backend_format.empty()) {
|
2003-03-31 01:15:44 +00:00
|
|
|
|
Alert::error(_("Couldn't export file"),
|
2003-05-13 09:48:57 +00:00
|
|
|
|
bformat(_("No information for exporting the format %1$s."),
|
|
|
|
|
formats.prettyName(format)));
|
2000-11-13 10:35:02 +00:00
|
|
|
|
return false;
|
|
|
|
|
}
|
2006-03-28 18:49:46 +00:00
|
|
|
|
} else {
|
2000-11-13 10:35:02 +00:00
|
|
|
|
backend_format = format;
|
2006-03-28 18:49:46 +00:00
|
|
|
|
// FIXME: Don't hardcode format names here, but use a flag
|
|
|
|
|
if (backend_format == "pdflatex")
|
|
|
|
|
runparams.flavor = OutputParams::PDFLATEX;
|
|
|
|
|
}
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2000-09-05 13:16:19 +00:00
|
|
|
|
string filename = buffer->getLatexName(false);
|
2004-02-25 12:00:53 +00:00
|
|
|
|
filename = AddName(buffer->temppath(), filename);
|
2002-03-21 17:27:08 +00:00
|
|
|
|
filename = ChangeExtension(filename,
|
2001-07-30 11:56:00 +00:00
|
|
|
|
formats.extension(backend_format));
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2000-09-11 15:42:17 +00:00
|
|
|
|
// Ascii backend
|
2000-10-23 12:16:05 +00:00
|
|
|
|
if (backend_format == "text")
|
2003-11-05 12:06:20 +00:00
|
|
|
|
writeFileAscii(*buffer, filename, runparams);
|
2006-02-03 21:47:25 +00:00
|
|
|
|
// no backend
|
|
|
|
|
else if (backend_format == "lyx")
|
|
|
|
|
buffer->writeFile(filename);
|
2000-09-11 15:42:17 +00:00
|
|
|
|
// Linuxdoc backend
|
2003-10-31 18:45:43 +00:00
|
|
|
|
else if (buffer->isLinuxDoc()) {
|
|
|
|
|
runparams.nice = !put_in_tempdir;
|
|
|
|
|
buffer->makeLinuxDocFile(filename, runparams);
|
|
|
|
|
}
|
2000-09-11 15:42:17 +00:00
|
|
|
|
// Docbook backend
|
2003-10-31 18:45:43 +00:00
|
|
|
|
else if (buffer->isDocBook()) {
|
|
|
|
|
runparams.nice = !put_in_tempdir;
|
|
|
|
|
buffer->makeDocBookFile(filename, runparams);
|
|
|
|
|
}
|
2000-09-11 15:42:17 +00:00
|
|
|
|
// LaTeX backend
|
2003-05-22 21:10:22 +00:00
|
|
|
|
else if (backend_format == format) {
|
|
|
|
|
runparams.nice = true;
|
|
|
|
|
buffer->makeLaTeXFile(filename, string(), runparams);
|
2005-04-26 11:12:20 +00:00
|
|
|
|
} else if (!lyxrc.tex_allows_spaces
|
2005-03-25 15:27:30 +00:00
|
|
|
|
&& contains(buffer->filePath(), ' ')) {
|
2003-03-31 01:15:44 +00:00
|
|
|
|
Alert::error(_("File name error"),
|
|
|
|
|
_("The directory path to the document cannot contain spaces."));
|
2001-04-14 08:10:52 +00:00
|
|
|
|
return false;
|
2003-05-22 21:10:22 +00:00
|
|
|
|
} else {
|
|
|
|
|
runparams.nice = false;
|
|
|
|
|
buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
|
|
|
|
|
}
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2004-06-01 13:39:33 +00:00
|
|
|
|
if (!converters.convert(buffer, filename, filename,
|
2000-11-13 10:35:02 +00:00
|
|
|
|
backend_format, format, result_file))
|
2000-09-05 13:16:19 +00:00
|
|
|
|
return false;
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2004-06-01 13:39:33 +00:00
|
|
|
|
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.
|
2004-06-03 13:08:50 +00:00
|
|
|
|
vector<ExportedFile> const files =
|
|
|
|
|
runparams.exportdata->externalFiles(format);
|
2004-06-01 13:39:33 +00:00
|
|
|
|
string const dest = OnlyPath(result_file);
|
|
|
|
|
CopyStatus status = SUCCESS;
|
|
|
|
|
for (vector<ExportedFile>::const_iterator it = files.begin();
|
2004-11-01 08:50:42 +00:00
|
|
|
|
it != files.end() && status != CANCEL; ++it) {
|
2004-11-09 19:08:34 +00:00
|
|
|
|
string const fmt =
|
|
|
|
|
formats.getFormatFromFile(it->sourceName);
|
2004-11-01 08:50:42 +00:00
|
|
|
|
status = copyFile(fmt, it->sourceName,
|
2004-06-01 13:39:33 +00:00
|
|
|
|
MakeAbsPath(it->exportName, dest),
|
2004-11-01 08:50:42 +00:00
|
|
|
|
it->exportName, status == FORCE);
|
|
|
|
|
}
|
2004-06-01 13:39:33 +00:00
|
|
|
|
if (status == CANCEL) {
|
|
|
|
|
buffer->message(_("Document export cancelled."));
|
2005-12-07 14:09:31 +00:00
|
|
|
|
} else if (fs::exists(tmp_result_file)) {
|
2004-06-01 13:39:33 +00:00
|
|
|
|
// Finally copy the main file
|
2004-11-01 08:50:42 +00:00
|
|
|
|
status = copyFile(format, tmp_result_file,
|
|
|
|
|
result_file, result_file,
|
2004-06-01 13:39:33 +00:00
|
|
|
|
status == FORCE);
|
2005-11-28 18:58:16 +00:00
|
|
|
|
buffer->message(bformat(_("Document exported as %1$s "
|
2004-06-01 13:39:33 +00:00
|
|
|
|
"to file `%2$s'"),
|
|
|
|
|
formats.prettyName(format),
|
|
|
|
|
MakeDisplayPath(result_file)));
|
2005-12-07 14:09:31 +00:00
|
|
|
|
} else {
|
|
|
|
|
// This must be a dummy converter like fax (bug 1888)
|
2005-12-07 15:21:10 +00:00
|
|
|
|
buffer->message(bformat(_("Document exported as %1$s"),
|
2005-12-07 14:09:31 +00:00
|
|
|
|
formats.prettyName(format)));
|
2004-06-01 13:39:33 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2000-08-30 03:40:51 +00:00
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2002-10-29 15:22:25 +00:00
|
|
|
|
|
2000-10-23 12:16:05 +00:00
|
|
|
|
bool Exporter::Export(Buffer * buffer, string const & format,
|
|
|
|
|
bool put_in_tempdir)
|
|
|
|
|
{
|
|
|
|
|
string result_file;
|
|
|
|
|
return Export(buffer, format, put_in_tempdir, result_file);
|
|
|
|
|
}
|
2000-08-30 03:40:51 +00:00
|
|
|
|
|
2002-10-29 15:22:25 +00:00
|
|
|
|
|
2000-11-13 10:35:02 +00:00
|
|
|
|
bool Exporter::Preview(Buffer * buffer, string const & format)
|
2000-08-30 03:40:51 +00:00
|
|
|
|
{
|
2000-10-23 12:16:05 +00:00
|
|
|
|
string result_file;
|
2000-11-13 10:35:02 +00:00
|
|
|
|
if (!Export(buffer, format, true, result_file))
|
2000-08-30 03:40:51 +00:00
|
|
|
|
return false;
|
2003-08-28 07:41:31 +00:00
|
|
|
|
return formats.view(*buffer, result_file, format);
|
2000-08-30 03:40:51 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2003-08-28 07:41:31 +00:00
|
|
|
|
bool Exporter::IsExportable(Buffer const & buffer, string const & format)
|
2000-10-02 16:44:47 +00:00
|
|
|
|
{
|
2000-11-13 10:35:02 +00:00
|
|
|
|
vector<string> backends = Backends(buffer);
|
|
|
|
|
for (vector<string>::const_iterator it = backends.begin();
|
|
|
|
|
it != backends.end(); ++it)
|
2001-07-30 11:56:00 +00:00
|
|
|
|
if (converters.isReachable(*it, format))
|
2000-11-13 10:35:02 +00:00
|
|
|
|
return true;
|
|
|
|
|
return false;
|
2000-10-02 16:44:47 +00:00
|
|
|
|
}
|
|
|
|
|
|
2000-10-11 21:06:43 +00:00
|
|
|
|
|
2000-11-13 10:35:02 +00:00
|
|
|
|
vector<Format const *> const
|
2003-08-28 07:41:31 +00:00
|
|
|
|
Exporter::GetExportableFormats(Buffer const & buffer, bool only_viewable)
|
2000-08-30 03:40:51 +00:00
|
|
|
|
{
|
2000-11-13 10:35:02 +00:00
|
|
|
|
vector<string> backends = Backends(buffer);
|
2002-03-21 17:27:08 +00:00
|
|
|
|
vector<Format const *> result =
|
2001-07-30 11:56:00 +00:00
|
|
|
|
converters.getReachable(backends[0], only_viewable, true);
|
2000-11-13 10:35:02 +00:00
|
|
|
|
for (vector<string>::const_iterator it = backends.begin() + 1;
|
|
|
|
|
it != backends.end(); ++it) {
|
|
|
|
|
vector<Format const *> r =
|
2001-07-30 11:56:00 +00:00
|
|
|
|
converters.getReachable(*it, only_viewable, false);
|
2000-11-13 10:35:02 +00:00
|
|
|
|
result.insert(result.end(), r.begin(), r.end());
|
|
|
|
|
}
|
2000-09-11 15:42:17 +00:00
|
|
|
|
return result;
|
2000-08-30 03:40:51 +00:00
|
|
|
|
}
|
2004-06-01 13:39:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ExportedFile::ExportedFile(string const & s, string const & e) :
|
|
|
|
|
sourceName(s), exportName(e) {}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
bool operator==(ExportedFile const & f1, ExportedFile const & f2)
|
|
|
|
|
{
|
|
|
|
|
return f1.sourceName == f2.sourceName &&
|
|
|
|
|
f1.exportName == f2.exportName;
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void ExportData::addExternalFile(string const & format,
|
2004-10-05 10:11:42 +00:00
|
|
|
|
string const & sourceName,
|
|
|
|
|
string const & exportName)
|
2004-06-01 13:39:33 +00:00
|
|
|
|
{
|
|
|
|
|
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,
|
2004-10-05 10:11:42 +00:00
|
|
|
|
string const & sourceName)
|
2004-06-01 13:39:33 +00:00
|
|
|
|
{
|
|
|
|
|
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>();
|
|
|
|
|
}
|