/* NOTES:
* Fileformat:
- * Current version is 1 (inset file format version), when changing it
- * it should be changed in the Write() function when writing in one place
- * and when reading one should change the version check and the error message.
* The filename is kept in the lyx file in a relative way, so as to allow
* moving the document file and its images with no problem.
*
#include <config.h>
#include "insets/insetgraphics.h"
-#include "insets/renderers.h"
+#include "insets/render_graphic.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
+#include "cursor.h"
#include "debug.h"
+#include "dispatchresult.h"
+#include "exporter.h"
#include "format.h"
#include "funcrequest.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
-#include "latexrunparams.h"
+#include "lyx_main.h"
#include "lyxlex.h"
-#include "lyxrc.h"
+#include "metricsinfo.h"
+#include "outputparams.h"
#include "frontends/Alert.h"
+#include "frontends/LyXView.h"
#include "support/filetools.h"
-#include "support/LAssert.h"
#include "support/lyxalgo.h" // lyx::count
#include "support/lyxlib.h" // float_equal
#include "support/os.h"
#include <boost/bind.hpp>
#include <boost/tuple/tuple.hpp>
-#include "support/std_sstream.h"
+#include <sstream>
namespace support = lyx::support;
-using namespace 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::GetExtension;
+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 os = lyx::support::os;
using std::endl;
+using std::string;
using std::auto_ptr;
using std::istringstream;
using std::ostream;
namespace {
-///////////////////////////////////////////////////////////////////////////
-int const VersionNumber = 1;
-///////////////////////////////////////////////////////////////////////////
-
// This function is a utility function
// ... that should be with ChangeExtension ...
inline
}
-string findTargetFormat(string const & suffix, LatexRunParams const & runparams)
+string findTargetFormat(string const & suffix, OutputParams const & runparams)
{
// Are we using latex or pdflatex).
- if (runparams.flavor == LatexRunParams::PDFLATEX) {
+ if (runparams.flavor == OutputParams::PDFLATEX) {
lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
if (contains(suffix, "ps") || suffix == "pdf")
return "pdf";
InsetGraphics::InsetGraphics()
: graphic_label(uniqueID()),
- graphic_(new GraphicRenderer)
-{
- graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this));
-}
+ graphic_(new RenderGraphic(this))
+{}
InsetGraphics::InsetGraphics(InsetGraphics const & ig)
: InsetOld(ig),
boost::signals::trackable(),
graphic_label(uniqueID()),
- graphic_(new GraphicRenderer(*ig.graphic_))
+ graphic_(new RenderGraphic(*ig.graphic_, this))
{
- graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this));
setParams(ig.params());
}
}
-void InsetGraphics::statusChanged()
-{
- BufferView * bv = graphic_->view();
- if (bv)
- bv->updateInset(this);
-}
-
-
-dispatch_result InsetGraphics::localDispatch(FuncRequest const & cmd)
+void InsetGraphics::priv_dispatch(LCursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
+ case LFUN_GRAPHICS_EDIT: {
+ Buffer const & buffer = *cur.bv().buffer();
+ InsetGraphicsParams p;
+ InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
+ editGraphics(p, buffer);
+ break;
+ }
+
case LFUN_INSET_MODIFY: {
- Buffer const & buffer = *cmd.view()->buffer();
+ Buffer const & buffer = cur.buffer();
InsetGraphicsParams p;
InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
if (!p.filename.empty()) {
setParams(p);
- cmd.view()->updateInset(this);
+ cur.bv().update();
}
- return DISPATCHED;
+ break;
}
case LFUN_INSET_DIALOG_UPDATE:
- InsetGraphicsMailer(*this).updateDialog(cmd.view());
- return DISPATCHED;
+ InsetGraphicsMailer(*this).updateDialog(&cur.bv());
+ break;
- case LFUN_INSET_EDIT:
case LFUN_MOUSE_RELEASE:
- InsetGraphicsMailer(*this).showDialog(cmd.view());
- return DISPATCHED;
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
+ break;
default:
- return InsetOld::localDispatch(cmd);
+ InsetOld::priv_dispatch(cur, cmd);
+ break;
}
}
+void InsetGraphics::edit(LCursor & cur, bool)
+{
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
+}
+
+
void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
{
graphic_->metrics(mi, dim);
void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
{
+ setPosCache(pi, x, y);
graphic_->draw(pi, x, y);
}
continue;
} else if (token == "\\end_inset") {
finished = true;
- } else if (token == "FormatVersion") {
- lex.next();
- int version = lex.getInteger();
- if (version > VersionNumber)
- lyxerr
- << "This document was created with a newer Graphics widget"
- ", You should use a newer version of LyX to read this"
- " file."
- << endl;
- // TODO: Possibly open up a dialog?
- }
- else {
+ } else {
if (!params_.Read(lex, token, bufpath))
lyxerr << "Unknown token, " << token << ", skipping."
<< std::endl;
if (!params().special.empty())
options << params().special << ",\n";
- string opts = STRCONV(options.str());
+ string opts = options.str();
// delete last ",\n"
return opts.substr(0, opts.size() - 2);
}
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));
+ BOOST_ASSERT(AbsolutePath(file_out));
- support::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);
-
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,
- LatexRunParams const & runparams) const
+ 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;
- if (zipped) {
- CopyStatus status;
- boost::tie(status, temp_file) =
- copyToDirIfNeeded(orig_file, buf.temppath());
+ // 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 = m_buffer->temppath();
+
+ 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';
- if (from == to && !lyxrc.use_tempdir)
- return stripExtensionIfPossible(orig_file, to);
-
// We're going to be running the exported buffer through the LaTeX
// compiler, so must ensure that LaTeX can cope with the graphics
// file format.
lyxerr[Debug::GRAPHICS]
<< "\tthe orig file is: " << orig_file << endl;
- bool conversion_needed = true;
- if (lyxrc.use_tempdir) {
- CopyStatus status;
- boost::tie(status, temp_file) =
- copyToDirIfNeeded(orig_file, buf.temppath());
-
- if (status == FAILURE)
- return orig_file;
- else if (status == IDENTICAL_CONTENTS)
- conversion_needed = false;
+ 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);
}
- if (from == to)
- return stripExtensionIfPossible(temp_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, than we take the default one
+ // 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,
- LatexRunParams const & runparams) const
+ OutputParams const & runparams) const
{
// If there is no file specified or not existing,
// just output a message about it in the latex output.
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
-#warning uh, but can our cache handle it ? no.
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]
<< "\n\tafter = " << after << endl;
- // "nice" means that the buffer is exported to LaTeX format but not
- // run through the LaTeX compiler.
- if (runparams.nice) {
- os << before <<'{' << relative_file << '}' << after;
- return 1;
- }
+ string latex_str = before + '{';
+ 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 += prepareFile(buf, runparams);
+ else
+ latex_str += relative_file + " not found!";
- // Make the filename relative to the lyx file
- // and remove the extension so the LaTeX will use whatever is
- // appropriate (when there are several versions in different formats)
- string const latex_str = message.empty() ?
- (before + '{' + os::external_path(prepareFile(buf, runparams)) + '}' + after) :
- (before + '{' + relative_file + " not found!}" + after);
+ latex_str += '}' + after;
os << latex_str;
lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
}
-int InsetGraphics::ascii(Buffer const &, ostream & os, int) const
+int InsetGraphics::plaintext(Buffer const &, ostream & os,
+ OutputParams const &) const
{
// No graphics in ascii output. Possible to use gifscii to convert
// images to ascii approximation.
}
-int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os) const
+int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
+ OutputParams const & runparams) const
{
- string const file_name = buf.niceFile() ?
+ string const file_name = runparams.nice ?
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,
- bool /*mixcont*/) 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");
}
}
+void InsetGraphics::editGraphics(InsetGraphicsParams const & p, Buffer const & buffer) const
+{
+ string const file_with_path = p.filename.absFilename();
+ formats.edit(buffer, file_with_path, getExtFromContents(file_with_path));
+}
+
+
string const InsetGraphicsMailer::name_("graphics");
InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
InsetGraphicsParams & params)
{
params = InsetGraphicsParams();
-
if (in.empty())
return;
- istringstream data(STRCONV(in));
+ istringstream data(in);
LyXLex lex(0,0);
lex.setStream(data);
- if (lex.isOK()) {
- lex.next();
- string const token = lex.getString();
- if (token != name_)
- return;
- }
+ string name;
+ lex >> name;
+ if (!lex || name != name_)
+ return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
- if (lex.isOK()) {
- InsetGraphics inset;
- inset.readInsetGraphics(lex, buffer.filePath());
- params = inset.params();
- }
+ InsetGraphics inset;
+ inset.readInsetGraphics(lex, buffer.filePath());
+ params = inset.params();
}
data << name_ << ' ';
params.Write(data, buffer.filePath());
data << "\\end_inset\n";
- return STRCONV(data.str());
+ return data.str();
}