#include "insets/insetgraphics.h"
#include "insets/insetgraphicsParams.h"
-#include "graphics/GraphicsCache.h"
+#include "graphics/GraphicsLoader.h"
#include "graphics/GraphicsImage.h"
+#include "graphics/GraphicsParams.h"
-#include "LyXView.h"
+#include "frontends/LyXView.h"
#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
-#include "Painter.h"
+#include "frontends/Painter.h"
#include "lyxrc.h"
-#include "font.h" // For the lyxfont class.
+#include "frontends/font_metrics.h"
#include "debug.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
#include "frontends/Dialogs.h"
+#include "frontends/Alert.h"
#include "frontends/controllers/helper_funcs.h" // getVectorFromString
#include "support/LAssert.h"
#include "support/filetools.h"
#include "support/lyxalgo.h" // lyx::count
+#include "support/path.h"
+#include "support/systemcall.h"
+#include "support/os.h"
+
+#include <boost/bind.hpp>
+#include <boost/signals/trackable.hpp>
#include <algorithm> // For the std::max
+// Very, Very UGLY!
+extern BufferView * current_view;
+
extern string system_tempdir;
using std::ostream;
namespace {
-string const unique_id()
+string const uniqueID()
{
static unsigned int seed = 1000;
} // namespace anon
-InsetGraphics::InsetGraphics()
- : graphic_label(unique_id()),
- cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
+struct InsetGraphics::Cache : boost::signals::trackable
+{
+ ///
+ Cache(InsetGraphics &);
+ ///
+ void update(string const & file_with_path);
+
+ ///
+ int old_ascent;
+ ///
+ grfx::Loader loader;
+
+private:
+ ///
+ InsetGraphics & parent_;
+};
+
+
+InsetGraphics::Cache::Cache(InsetGraphics & p)
+ : old_ascent(0), parent_(p)
+{
+ loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
+}
+
+void InsetGraphics::Cache::update(string const & file_with_path)
+{
+ lyx::Assert(!file_with_path.empty());
+
+ string const path = OnlyPath(file_with_path);
+ loader.reset(file_with_path, parent_.params().as_grfxParams(path));
+}
+
+
+InsetGraphics::InsetGraphics()
+ : graphic_label(uniqueID()),
+ cache_(new Cache(*this))
{}
string const & filepath,
bool same_id)
: Inset(ig, same_id),
- SigC::Object(),
- graphic_label(unique_id()),
- cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
+ graphic_label(uniqueID()),
+ cache_(new Cache(*this))
{
setParams(ig.params(), filepath);
}
InsetGraphics::~InsetGraphics()
{
- cached_image_.reset(0);
- grfx::GCache & gc = grfx::GCache::get();
- gc.remove(*this);
-
// Emits the hide signal to the dialog connected (if any)
hideDialog();
}
{
string msg;
- switch (cached_status_) {
+ switch (cache_->loader.status()) {
case grfx::WaitingToLoad:
msg = _("Waiting for draw request to start loading...");
break;
case grfx::Converting:
msg = _("Converting to loadable format...");
break;
+ case grfx::Loaded:
+ msg = _("Loaded into memory. Must now generate pixmap.");
+ break;
case grfx::ScalingEtc:
- msg = _("Loaded. Scaling etc...");
+ msg = _("Scaling etc...");
+ break;
+ case grfx::Ready:
+ msg = _("Ready to display");
break;
case grfx::ErrorNoFile:
msg = _("No file found!");
break;
- case grfx::ErrorLoading:
- msg = _("Error loading file into memory");
- break;
case grfx::ErrorConverting:
msg = _("Error converting to loadable format");
break;
- case grfx::ErrorScalingEtc:
- msg = _("Error scaling etc");
+ case grfx::ErrorLoading:
+ msg = _("Error loading file into memory");
+ break;
+ case grfx::ErrorGeneratingPixmap:
+ msg = _("Error generating the pixmap");
break;
case grfx::ErrorUnknown:
msg = _("No image");
break;
- case grfx::Loaded:
- msg = _("Loaded but not displaying");
- break;
}
return msg;
}
-void InsetGraphics::setCache() const
+bool InsetGraphics::imageIsDrawable() const
{
- if (cache_filled_)
- return;
-
- grfx::GCache & gc = grfx::GCache::get();
- cached_status_ = gc.status(*this);
- cached_image_ = gc.image(*this);
-}
-
-
-bool InsetGraphics::drawImage() const
-{
- setCache();
- Pixmap const pixmap =
- (cached_status_ == grfx::Loaded && cached_image_.get() != 0) ?
- cached_image_->getPixmap() : 0;
+ if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
+ return false;
- return pixmap != 0;
+ return cache_->loader.image()->isDrawable();
}
int InsetGraphics::ascent(BufferView *, LyXFont const &) const
{
- old_asc = 50;
- if (drawImage())
- old_asc = cached_image_->getHeight();
- return old_asc;
+ cache_->old_ascent = 50;
+ if (imageIsDrawable())
+ cache_->old_ascent = cache_->loader.image()->getHeight();
+ return cache_->old_ascent;
}
int InsetGraphics::width(BufferView *, LyXFont const & font) const
{
- if (drawImage())
- return cached_image_->getWidth();
+ if (imageIsDrawable())
+ return cache_->loader.image()->getWidth();
else {
int font_width = 0;
string const justname = OnlyFilename (params().filename);
if (!justname.empty()) {
msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- font_width = lyxfont::width(justname, msgFont);
+ font_width = font_metrics::width(justname, msgFont);
}
string const msg = statusMessage();
if (!msg.empty()) {
msgFont.setSize(LyXFont::SIZE_TINY);
- int const msg_width = lyxfont::width(msg, msgFont);
+ int const msg_width = font_metrics::width(msg, msgFont);
font_width = std::max(font_width, msg_width);
}
void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
int baseline, float & x, bool) const
{
- int oasc = old_asc;
- grfx::ImageStatus old_status_ = cached_status_;
+ int oasc = cache_->old_ascent;
int ldescent = descent(bv, font);
int lascent = ascent(bv, font);
// But I still don't know the best way to go. So let's do this like this
// for now (Jug 20020311)
if (lascent != oasc) {
-// lyxerr << "IG(" << this << "): " << x << endl;
return;
}
int old_x = int(x);
x += lwidth;
- // Initiate the loading of the graphics file
- if (cached_status_ == grfx::WaitingToLoad) {
- grfx::GCache & gc = grfx::GCache::get();
- gc.startLoading(*this);
+ if (cache_->loader.status() == grfx::WaitingToLoad) {
+ cache_->loader.startLoading(*this, *bv);
}
// This will draw the graphics. If the graphics has not been loaded yet,
// we draw just a rectangle.
Painter & paint = bv->painter();
- if (drawImage()) {
-// lyxerr << "IG(" << this << "): " << old_x << endl;
+ if (imageIsDrawable()) {
paint.image(old_x + 2, baseline - lascent,
lwidth - 4, lascent + ldescent,
- *cached_image_.get());
+ *cache_->loader.image());
} else {
if (!justname.empty()) {
msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
paint.text(old_x + 8,
- baseline - lyxfont::maxAscent(msgFont) - 4,
+ baseline - font_metrics::maxAscent(msgFont) - 4,
justname, msgFont);
}
// the status message may mean we changed size, so indicate
// we need a row redraw
+#if 0
if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
}
+#endif
// Reset the cache, ready for the next draw request
+#if 0
cached_status_ = grfx::ErrorUnknown;
- cached_image_.reset(0);
+ cached_image_.reset();
cache_filled_ = false;
+#endif
}
-// Update the inset after parameters changed (read from file or changed in
-// dialog. The grfx::GCache makes the decisions about whether or not to draw
-// (interogates lyxrc, ascertains whether file exists etc)
-void InsetGraphics::updateInset(string const & filepath) const
-{
- grfx::GCache & gc = grfx::GCache::get();
- gc.update(*this, filepath);
-}
-
-
-void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
+void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
{
bv->owner()->getDialogs()->showGraphics(this);
}
void InsetGraphics::edit(BufferView * bv, bool)
{
- edit(bv, 0, 0, 0);
+ edit(bv, 0, 0, mouse_button::none);
}
else
lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
- updateInset(buf->filePath());
+ cache_->update(MakeAbsPath(params().filename, buf->filePath()));
}
} else if (token == "subcaption") {
if (lex.eatLine())
params_.subcaptionText = lex.getString();
- params_.subcaption = true;
} else if (token == "label") {
if (lex.next());
// kept for backwards compability. Delete in 0.13.x
} else if (token == "angle") {
- if (lex.next())
+ if (lex.next()) {
params_.rotate = true;
params_.rotateAngle = lex.getFloat();
+ }
} else if (token == "size") {
if (lex.next())
params_.lyxwidth = LyXLength(lex.getString()+"pt");
if (lex.next())
params_.lyxheight = LyXLength(lex.getString()+"pt");
+ params_.lyxsize_type = InsetGraphicsParams::WH;
} else if (token == "flags") {
if (lex.next())
switch (lex.getInteger()) {
// lyxrc.pdf_mode means:
// Are we creating a PDF or a PS file?
// (Should actually mean, are we using latex or pdflatex).
- lyxerr[Debug::GRAPHICS] << "decideOutput: lyxrc.pdf_mode = "
- << lyxrc.pdf_mode << std::endl;
if (lyxrc.pdf_mode) {
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
if (contains(suffix,"ps") || suffix == "pdf")
return "pdf";
- else if (suffix == "jpg")
+ else if (suffix == "jpg") // pdflatex can use jpeg
return suffix;
else
- return "png";
+ return "png"; // and also png
}
// If it's postscript, we always do eps.
- lyxerr[Debug::GRAPHICS] << "decideOutput: we have PostScript mode\n";
- if (suffix != "ps")
- return "eps";
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
+ if (suffix != "ps") // any other than ps
+ return "eps"; // is changed to eps
else
- return "ps";
+ return suffix; // let ps untouched
}
} // Anon. namespace
string const InsetGraphics::prepareFile(Buffer const *buf) const
{
- // do_convert = Do we need to convert the file?
- // nice = Do we create a nice version?
- // This is used when exporting the latex file only.
- // if (!do_convert)
- // return original filename
- // if (!nice)
- // convert_place = temp directory
- // return new filename in temp directory
- // else
- // convert_place = original file directory
- // return original filename without the extension
- //
- // if it's a zipped one, than let LaTeX do the rest!!!
- string filename_ = MakeAbsPath(params().filename, buf->filePath());
- bool const zipped = zippedFile(filename_);
-
- if ((zipped && params().noUnzip) || buf->niceFile) {
- lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
- << filename_ << endl;
- return filename_;
- }
-
+ // LaTeX can cope if the graphics file doesn't exist, so just return the
+ // filename.
+ string const orig_file = params().filename;
+ string orig_file_with_path =
+ MakeAbsPath(orig_file, buf->filePath());
+ lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
+ << orig_file << "\n\twith path: "
+ << orig_file_with_path << endl;
+
+ if (!IsFileReadable(orig_file_with_path))
+ return orig_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!
+
+ // maybe that other zip extensions also be useful, especially the
+ // ones that may be declared in texmf/tex/latex/config/graphics.cfg.
+ // for example:
+ /* -----------snip-------------
+ {\DeclareGraphicsRule{.pz}{eps}{.bb}{}%
+ \DeclareGraphicsRule{.eps.Z}{eps}{.eps.bb}{}%
+ \DeclareGraphicsRule{.ps.Z}{eps}{.ps.bb}{}%
+ \DeclareGraphicsRule{.ps.gz}{eps}{.ps.bb}{}%
+ \DeclareGraphicsRule{.eps.gz}{eps}{.eps.bb}{}}}%
+ -----------snip-------------*/
+
+ bool const zipped = zippedFile(orig_file_with_path);
if (zipped)
- filename_ = unzipFile(filename_);
+ lyxerr[Debug::GRAPHICS] << "\twe have a zipped file ("
+ << getExtFromContents(orig_file_with_path) << ")\n";
+ if (params().noUnzip && zipped) {
+ lyxerr[Debug::GRAPHICS]
+ << "\tpass file unzipped to LaTeX but with full path.\n";
+ // latex needs an absolue path, otherwise the coresponding
+ // *.eps.bb file isn't found
+ return orig_file_with_path;
+ }
- string const from = getExtFromContents(filename_);
- string const to = findTargetFormat(from);
+ string temp_file(orig_file);
+ // Uncompress the file if necessary. If it has been uncompressed in
+ // a previous call to prepareFile, do nothing.
+ if (zipped) {
+ temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
+ lyxerr[Debug::GRAPHICS]
+ << "\ttemp_file: " << temp_file << endl;
+ if (!IsFileReadable(temp_file)) {
+ bool const success = lyx::copy(orig_file_with_path, temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCopying zipped file from "
+ << orig_file_with_path << " to " << temp_file
+ << (success ? " succeeded\n" : " failed\n");
+ } else
+ lyxerr[Debug::GRAPHICS]
+ << "\tzipped file " << temp_file
+ << " exists! Maybe no tempdir ...\n";
+ orig_file_with_path = unzipFile(temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tunzipped to " << orig_file_with_path << endl;
+ }
+ string const from = getExtFromContents(orig_file_with_path);
+
+ // "nice" means that the buffer is exported to LaTeX format but not
+ // run through the LaTeX compiler.
+ // if (nice)
+ // no conversion needed!
+ // Return the original filename as is, because we do not know
+ // what the user decide.
+ if (buf->niceFile)
+ return orig_file;
+
+ // 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.
+
+ // Perform all these manipulations on a temporary file if possible.
+ // If we are not using a temp dir, then temp_file contains the
+ // original file.
+ // to allow files with the same name in different dirs
+ // we manipulate the original file "any.dir/file.ext"
+ // to "any_dir_file.ext"! changing the dots in the
+ // dirname is important for the use of ChangeExtension
+ lyxerr[Debug::GRAPHICS]
+ << "\tthe orig file is: " << orig_file_with_path << endl;
+
+ if (lyxrc.use_tempdir) {
+ string const ext_tmp = GetExtension(orig_file_with_path);
+ // without ext and /
+ temp_file = subst(
+ ChangeExtension(orig_file_with_path, string()), "/", "_");
+ // without dots and again with ext
+ temp_file = ChangeExtension(
+ subst(temp_file, ".", "_"), ext_tmp);
+ // now we have any_dir_file.ext
+ temp_file = MakeAbsPath(temp_file, buf->tmppath);
+ lyxerr[Debug::GRAPHICS]
+ << "\tchanged to: " << temp_file << endl;
+
+ // if the file doen't exists, copy it into the tempdi
+ if (!IsFileReadable(temp_file)) {
+ bool const success = lyx::copy(orig_file_with_path, temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tcopying from " << orig_file_with_path << " to "
+ << temp_file
+ << (success ? " succeeded\n" : " failed\n");
+ if (!success) {
+ Alert::alert(_("Cannot copy file"), orig_file_with_path,
+ _("into tempdir"));
+ return orig_file;
+ }
+ }
+ }
+ string const to = findTargetFormat(from);
+ lyxerr[Debug::GRAPHICS]
+ << "\t we have: from " << from << " to " << to << '\n';
if (from == to) {
- // No conversion needed!
- return filename_;
+ // No conversion is needed. LaTeX can handle the graphic file as is.
+ // This is true even if the orig_file is compressed. We have to return
+ // the orig_file_with_path, maybe it is a zipped one
+ if (lyxrc.use_tempdir)
+ return RemoveExtension(temp_file);
+ return RemoveExtension(orig_file_with_path);
}
- string const temp = AddName(buf->tmppath, filename_);
- string const outfile_base = RemoveExtension(temp);
-
- lyxerr[Debug::GRAPHICS] << "tempname = " << temp << "\n";
- lyxerr[Debug::GRAPHICS] << "buf::tmppath = " << buf->tmppath << "\n";
- lyxerr[Debug::GRAPHICS] << "filename_ = " << filename_ << "\n";
- lyxerr[Debug::GRAPHICS] << "outfile_base = " << outfile_base << endl;
-
- converters.convert(buf, filename_, outfile_base, from, to);
- return outfile_base;
-}
-
-
-namespace {
-
-string const latexify(string const str)
-{
- ostringstream out;
-
- string::const_iterator it = str.begin();
- string::const_iterator end = str.end();
-
- for (; it != end; ++it) {
- switch (*it) {
-
- case ('$'):
- case ('&'):
- case ('%'):
- case ('#'):
- case ('_'):
- case ('{'):
- case ('}'):
- out << '\\' << *it;
- break;
-
- case ('~'):
- case ('^'):
- out << '\\' << *it << "{}";
- break;
-
- case ('\\'):
- out << "\textbackslash ";
- break;
-
- default:
- out << *it;
- break;
- }
+ string const outfile_base = RemoveExtension(temp_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'
+ << "\toutfile_base = " << outfile_base << '\n'
+ << "\t from " << from << " to " << to << '\n';
+
+ // if no special converter defined, than we take the default one
+ // from ImageMagic: convert from:inname.from to:outname.to
+ if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
+ string const command =
+ "convert " +
+ from + ':' + temp_file + ' ' +
+ to + ':' + outfile_base + '.' + to;
+ lyxerr[Debug::GRAPHICS]
+ << "No converter defined! I use convert from ImageMagic:\n\t"
+ << command << endl;
+ Systemcall one;
+ one.startscript(Systemcall::Wait, command);
+ if (!IsFileReadable(ChangeExtension(outfile_base, to)))
+ Alert::alert(_("Cannot convert Image (not existing file?)"),
+ _("No information for converting from ")
+ + from + _(" to ") + to);
}
-
- return out.str().c_str();
+
+ return RemoveExtension(temp_file);
}
-
-} // namespace anon
int InsetGraphics::latex(Buffer const *buf, ostream & os,
bool /*fragile*/, bool/*fs*/) const
{
- // If there is no file specified, just output a message about it in
- // the latex output.
- if (params().filename.empty()) {
- os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
- << _("empty figure path") << "}\n";
- return 1; // One end-of-line marker added to the stream.
- }
- // Ditto if the file is not there.
- if (!IsFileReadable(MakeAbsPath(params().filename, buf->filePath()))) {
- os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
- << latexify(MakeRelPath(params().filename, buf->filePath()))
- << _(" not found") << "}\n";
- return 1; // One end-of-line marker added to the stream.
- }
+ // If there is no file specified or not existing,
+ // just output a message about it in the latex output.
+ lyxerr[Debug::GRAPHICS]
+ << "insetgraphics::latex: Filename = "
+ << params().filename << endl;
+
+ // A missing (e)ps-extension is no problem for LaTeX, so
+ // we have to test three different cases
+ string const file_(MakeAbsPath(params().filename, buf->filePath()));
+ bool const file_exists =
+ !file_.empty() &&
+ (IsFileReadable(file_) || // original
+ IsFileReadable(file_ + ".eps") || // original.eps
+ IsFileReadable(file_ + ".ps")); // original.ps
+ 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
+ // draws only a rectangle with the above bb and the
+ // not found filename in it.
+ lyxerr[Debug::GRAPHICS]
+ << "\tMessage = \"" << message << '\"' << endl;
+
// These variables collect all the latex code that should be before and
// after the actual includegraphics command.
string before;
}
// We never use the starred form, we use the "clip" option instead.
before += "\\includegraphics";
+
// Write the options if there are any.
string const opts = createLatexOptions();
- if (!opts.empty()) {
- before += ("[%\n" + opts +']');
- }
+ lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
+
+ if (!opts.empty() && !message.empty())
+ before += ("[%\n" + opts + ',' + message);
+ else if (!message.empty())
+ before += ("[%\n" + message);
+ else if (!opts.empty())
+ before += ("[%\n" + opts + ']');
+
+ lyxerr[Debug::GRAPHICS]
+ << "\tBefore = " << before
+ << "\n\tafter = " << after << endl;
+
// 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 = before + '{' + prepareFile(buf) + '}' + after;
+ string const latex_str = message.empty() ?
+ (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
+ (before + '{' + params().filename + " not found!}" + after);
os << latex_str;
// Return how many newlines we issued.
int const newlines =
int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
- // lyxerr << "includegraphics: " << newlines << " lines of text"
- // << endl;
return newlines;
}
// For explanation on inserting graphics into DocBook checkout:
// http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(Buffer const *, ostream & os) const
+int InsetGraphics::docbook(Buffer const *, ostream & os,
+ bool /*mixcont*/) 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
if (params().filename.empty())
return ;
- features.includeFile(graphic_label, RemoveExtension(params_.filename));
+ features.includeFile(graphic_label, RemoveExtension(params().filename));
features.require("graphicx");
}
+void InsetGraphics::statusChanged()
+{
+ current_view->updateInset(this, false);
+}
+
+
bool InsetGraphics::setParams(InsetGraphicsParams const & p,
string const & filepath)
{
params_ = p;
// Update the inset with the new parameters.
- updateInset(filepath);
+ cache_->update(MakeAbsPath(params().filename, filepath));
// We have changed data, report it.
return true;