#include "cursor.h"
#include "debug.h"
#include "dispatchresult.h"
+#include "exporter.h"
#include "format.h"
#include "funcrequest.h"
#include "gettext.h"
#include "support/os.h"
#include "support/systemcall.h"
#include "support/tostr.h"
-#include "support/std_sstream.h"
#include <boost/bind.hpp>
#include <boost/tuple/tuple.hpp>
+#include <sstream>
+
namespace support = lyx::support;
+
using lyx::support::AbsolutePath;
using lyx::support::bformat;
using lyx::support::ChangeExtension;
+using lyx::support::compare_timestamps;
using lyx::support::contains;
using lyx::support::FileName;
using lyx::support::float_equal;
using lyx::support::getExtFromContents;
using lyx::support::IsFileReadable;
using lyx::support::LibFileSearch;
+using lyx::support::OnlyFilename;
using lyx::support::rtrim;
+using lyx::support::subst;
using lyx::support::Systemcall;
using lyx::support::unzipFile;
using lyx::support::unzippedFileName;
namespace {
-///////////////////////////////////////////////////////////////////////////
-int const VersionNumber = 1;
-///////////////////////////////////////////////////////////////////////////
-
// This function is a utility function
// ... that should be with ChangeExtension ...
inline
std::pair<CopyStatus, string> const
-copyToDirIfNeeded(string const & file_in, string const & dir)
+copyFileIfNeeded(string const & file_in, string const & file_out)
{
- using support::rtrim;
-
BOOST_ASSERT(AbsolutePath(file_in));
-
- string const only_path = support::OnlyPath(file_in);
- if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/"))
- return std::make_pair(IDENTICAL_PATHS, file_in);
-
- string mangled;
- if (support::zippedFile(file_in)) {
- string const ext = GetExtension(file_in);
- string const unzipped = support::unzippedFileName(file_in);
- mangled = FileName(unzipped).mangledFilename();
- mangled += "." + ext;
- } else
- mangled = FileName(file_in).mangledFilename();
-
- string const file_out = support::MakeAbsPath(mangled, dir);
+ BOOST_ASSERT(AbsolutePath(file_out));
unsigned long const checksum_in = support::sum(file_in);
unsigned long const checksum_out = support::sum(file_out);
}
+std::pair<CopyStatus, string> const
+copyToDirIfNeeded(string const & file_in, string const & dir, bool zipped)
+{
+ using support::rtrim;
+
+ BOOST_ASSERT(AbsolutePath(file_in));
+
+ string const only_path = support::OnlyPath(file_in);
+ if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/"))
+ return std::make_pair(IDENTICAL_PATHS, file_in);
+
+ string mangled = FileName(file_in).mangledFilename();
+ if (zipped) {
+ // We need to change _eps.gz to .eps.gz. The mangled name is
+ // still unique because of the counter in mangledFilename().
+ // We can't just call mangledFilename() with the zip
+ // extension removed, because base.eps and base.eps.gz may
+ // have different content but would get the same mangled
+ // name in this case.
+ string const base = RemoveExtension(unzippedFileName(file_in));
+ string::size_type const ext_len = file_in.length() - base.length();
+ mangled[mangled.length() - ext_len] = '.';
+ }
+ string const file_out = support::MakeAbsPath(mangled, dir);
+
+ return copyFileIfNeeded(file_in, file_out);
+}
+
+
+string const stripExtension(string const & file)
+{
+ // Remove the extension so the LaTeX will use whatever
+ // is appropriate (when there are several versions in
+ // different formats)
+ // This works only if the filename contains no dots besides
+ // the just removed one. We can fool here by replacing all
+ // dots with a macro whose definition is just a dot ;-)
+ return subst(RemoveExtension(file), ".", "\\lyxdot ");
+}
+
+
string const stripExtensionIfPossible(string const & file, string const & to)
{
// No conversion is needed. LaTeX can handle the graphic file as is.
// This is true even if the orig_file is compressed.
- if (formats.getFormat(to)->extension() == GetExtension(file))
- return RemoveExtension(file);
+ string const to_format = formats.getFormat(to)->extension();
+ string const file_format = GetExtension(file);
+ // for latex .ps == .eps
+ if (to_format == file_format ||
+ (to_format == "eps" && file_format == "ps") ||
+ (to_format == "ps" && file_format == "eps"))
+ return stripExtension(file);
return file;
}
string const InsetGraphics::prepareFile(Buffer const & buf,
OutputParams const & runparams) const
{
- string orig_file = params().filename.absFilename();
+ // We assume that the file exists (the caller checks this)
+ string const orig_file = params().filename.absFilename();
string const rel_file = params().filename.relFilename(buf.filePath());
- // LaTeX can cope if the graphics file doesn't exist, so just return the
- // filename.
- if (!IsFileReadable(orig_file)) {
- lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::prepareFile\n"
- << "No file '" << orig_file << "' can be found!" << endl;
- return rel_file;
- }
-
// If the file is compressed and we have specified that it
// should not be uncompressed, then just return its name and
// let LaTeX do the rest!
bool const zipped = params().filename.isZipped();
- if (zipped && params().noUnzip) {
- lyxerr[Debug::GRAPHICS]
- << "\tpass zipped file to LaTeX but with full path.\n";
- // LaTeX needs an absolute path, otherwise the
- // coresponding *.eps.bb file isn't found
- return orig_file;
- }
-
// temp_file will contain the file for LaTeX to act on if, for example,
// we move it to a temp dir or uncompress it.
string temp_file = orig_file;
+ // The master buffer. This is useful when there are multiple levels
+ // of include files
+ Buffer const * m_buffer = buf.getMasterBuffer();
+
// We place all temporary files in the master buffer's temp dir.
// This is possible because we use mangled file names.
// This is necessary for DVI export.
- string const temp_path = buf.getMasterBuffer()->temppath();
+ string const temp_path = m_buffer->temppath();
- if (zipped) {
- CopyStatus status;
- boost::tie(status, temp_file) =
- copyToDirIfNeeded(orig_file, temp_path);
+ CopyStatus status;
+ boost::tie(status, temp_file) =
+ copyToDirIfNeeded(orig_file, temp_path, zipped);
- if (status == FAILURE)
- return orig_file;
+ if (status == FAILURE)
+ return orig_file;
- orig_file = unzippedFileName(temp_file);
- if (!IsFileReadable(orig_file)) {
- unzipFile(temp_file);
+ // a relative filename should be relative to the master
+ // buffer.
+ // "nice" means that the buffer is exported to LaTeX format but not
+ // run through the LaTeX compiler.
+ string const output_file = os::external_path(runparams.nice ?
+ params().filename.outputFilename(m_buffer->filePath()) :
+ OnlyFilename(temp_file));
+ string const source_file = runparams.nice ? orig_file : temp_file;
+
+ if (zipped) {
+ if (params().noUnzip) {
+ // We don't know whether latex can actually handle
+ // this file, but we can't check, because that would
+ // mean to unzip the file and thereby making the
+ // noUnzip parameter meaningless.
lyxerr[Debug::GRAPHICS]
- << "\tunzipped to " << orig_file << endl;
+ << "\tpass zipped file to LaTeX.\n";
+
+ string const bb_orig_file = ChangeExtension(orig_file, "bb");
+ if (runparams.nice) {
+ runparams.exportdata->addExternalFile("latex",
+ bb_orig_file,
+ ChangeExtension(output_file, "bb"));
+ } else {
+ // LaTeX needs the bounding box file in the
+ // tmp dir
+ string bb_file = ChangeExtension(temp_file, "bb");
+ boost::tie(status, bb_file) =
+ copyFileIfNeeded(bb_orig_file, bb_file);
+ if (status == FAILURE)
+ return orig_file;
+ runparams.exportdata->addExternalFile("latex",
+ bb_file);
+ }
+ runparams.exportdata->addExternalFile("latex",
+ source_file, output_file);
+ runparams.exportdata->addExternalFile("dvi",
+ source_file, output_file);
+ // We can't strip the extension, because we don't know
+ // the unzipped file format
+ return output_file;
+ }
+
+ string const unzipped_temp_file = unzippedFileName(temp_file);
+ if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
+ // temp_file has been unzipped already and
+ // orig_file has not changed in the meantime.
+ temp_file = unzipped_temp_file;
+ lyxerr[Debug::GRAPHICS]
+ << "\twas already unzipped to " << temp_file
+ << endl;
+ } else {
+ // unzipped_temp_file does not exist or is too old
+ temp_file = unzipFile(temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tunzipped to " << temp_file << endl;
}
}
- string const from = getExtFromContents(orig_file);
+ string const from = getExtFromContents(temp_file);
string const to = findTargetFormat(from, runparams);
lyxerr[Debug::GRAPHICS]
<< "\t we have: from " << from << " to " << to << '\n';
lyxerr[Debug::GRAPHICS]
<< "\tthe orig file is: " << orig_file << endl;
- bool conversion_needed = true;
- CopyStatus status;
- boost::tie(status, temp_file) =
- copyToDirIfNeeded(orig_file, temp_path);
-
- if (status == FAILURE)
- return orig_file;
- else if (status == IDENTICAL_CONTENTS)
- conversion_needed = false;
-
- if (from == to)
- return stripExtensionIfPossible(temp_file, to);
+ if (from == to) {
+ // The extension of temp_file might be != to!
+ runparams.exportdata->addExternalFile("latex", source_file,
+ output_file);
+ runparams.exportdata->addExternalFile("dvi", source_file,
+ output_file);
+ return stripExtensionIfPossible(output_file, to);
+ }
- string const to_file_base = RemoveExtension(temp_file);
- string const to_file = ChangeExtension(to_file_base, to);
+ string const to_file = ChangeExtension(temp_file, to);
+ string const output_to_file = ChangeExtension(output_file, to);
// Do we need to perform the conversion?
// Yes if to_file does not exist or if temp_file is newer than to_file
- if (!conversion_needed ||
- support::compare_timestamps(temp_file, to_file) < 0) {
+ if (compare_timestamps(temp_file, to_file) < 0) {
lyxerr[Debug::GRAPHICS]
<< bformat(_("No conversion of %1$s is needed after all"),
rel_file)
<< std::endl;
- return to_file_base;
+ runparams.exportdata->addExternalFile("latex", to_file,
+ output_to_file);
+ runparams.exportdata->addExternalFile("dvi", to_file,
+ output_to_file);
+ return stripExtension(output_file);
}
lyxerr[Debug::GRAPHICS]
<< "\tThe original file is " << orig_file << "\n"
<< "\tA copy has been made and convert is to be called with:\n"
<< "\tfile to convert = " << temp_file << '\n'
- << "\tto_file_base = " << to_file_base << '\n'
<< "\t from " << from << " to " << to << '\n';
// if no special converter defined, then we take the default one
// from ImageMagic: convert from:inname.from to:outname.to
- if (!converters.convert(&buf, temp_file, to_file_base, from, to)) {
+ if (!converters.convert(&buf, temp_file, temp_file, from, to)) {
string const command =
"sh " + LibFileSearch("scripts", "convertDefault.sh") +
' ' + from + ':' + temp_file + ' ' +
- to + ':' + to_file_base + '.' + to;
+ to + ':' + to_file;
lyxerr[Debug::GRAPHICS]
<< "No converter defined! I use convertDefault.sh:\n\t"
<< command << endl;
Systemcall one;
one.startscript(Systemcall::Wait, command);
- if (!IsFileReadable(ChangeExtension(to_file_base, to))) {
+ if (IsFileReadable(to_file)) {
+ runparams.exportdata->addExternalFile("latex",
+ to_file, output_to_file);
+ runparams.exportdata->addExternalFile("dvi",
+ to_file, output_to_file);
+ } else {
string str = bformat(_("No information for converting %1$s "
"format files to %2$s.\n"
"Try defining a convertor in the preferences."), from, to);
}
}
- return to_file_base;
+ return stripExtension(output_file);
}
int InsetGraphics::latex(Buffer const & buf, ostream & os,
OutputParams const & runparams) const
{
- // The master buffer. This is useful when there are multiple levels
- // of include files
- Buffer const * m_buffer = buf.getMasterBuffer();
-
// If there is no file specified or not existing,
// just output a message about it in the latex output.
lyxerr[Debug::GRAPHICS]
string const relative_file =
params().filename.relFilename(buf.filePath());
- // A missing (e)ps-extension is no problem for LaTeX, so
- // we have to test three different cases
-#ifdef WITH_WARNINGS
-#warning uh, but can our cache handle it ? no.
-#endif
string const file_ = params().filename.absFilename();
- bool const file_exists =
- !file_.empty() &&
- (IsFileReadable(file_) || // original
- IsFileReadable(file_ + ".eps") || // original.eps
- IsFileReadable(file_ + ".ps")); // original.ps
+ bool const file_exists = !file_.empty() && IsFileReadable(file_);
string const message = file_exists ?
string() : string("bb = 0 0 200 100, draft, type=eps");
- // if !message.empty() than there was no existing file
- // "filename(.(e)ps)" found. In this case LaTeX
+ // if !message.empty() then there was no existing file
+ // "filename" found. In this case LaTeX
// draws only a rectangle with the above bb and the
// not found filename in it.
lyxerr[Debug::GRAPHICS]
string latex_str = before + '{';
- // "nice" means that the buffer is exported to LaTeX format but not
- // run through the LaTeX compiler.
- if (runparams.nice) {
- // a relative filename should be relative to the master
- // buffer.
- latex_str += params().filename.outputFilename(m_buffer->filePath());
- } else if (file_exists) {
- // Make the filename relative to the lyx file
- // and remove the extension so the LaTeX will use whatever
+ if (file_exists)
+ // Convert the file if necessary.
+ // Remove the extension so the LaTeX will use whatever
// is appropriate (when there are several versions in
// different formats)
- latex_str += os::external_path(prepareFile(buf, runparams));
- } else
+ latex_str += prepareFile(buf, runparams);
+ else
latex_str += relative_file + " not found!";
latex_str += '}' + after;
params().filename.relFilename(buf.filePath()):
params().filename.absFilename();
+ runparams.exportdata->addExternalFile("linuxdoc",
+ params().filename.absFilename());
os << "<eps file=\"" << file_name << "\">\n";
os << "<img src=\"" << file_name << "\">";
return 0;
// For explanation on inserting graphics into DocBook checkout:
-// http://en.tldp.org/LDP/LDP-Author-Guide/inserting-pictures.html
+// http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
int InsetGraphics::docbook(Buffer const &, ostream & os,
- OutputParams const &) const
+ OutputParams const & runparams) const
{
// In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
// need to switch to MediaObject. However, for now this is sufficient and
// easier to use.
+ runparams.exportdata->addExternalFile("docbook",
+ params().filename.absFilename());
+ runparams.exportdata->addExternalFile("docbook-xml",
+ params().filename.absFilename());
os << "<graphic fileref=\"&" << graphic_label << ";\">";
return 0;
}
features.require("graphicx");
+ if (features.nice()) {
+ Buffer const * m_buffer = features.buffer().getMasterBuffer();
+ string basename =
+ params().filename.outputFilename(m_buffer->filePath());
+ basename = RemoveExtension(basename);
+ if(params().filename.isZipped())
+ basename = RemoveExtension(basename);
+ if (contains(basename, "."))
+ features.require("lyxdot");
+ }
+
if (params().subcaption)
features.require("subfigure");
}
projects / features.git / blobdiff