#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 "frontends/LyXView.h"
#include "lyxtext.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),
- 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();
- 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
-{
- if (cache_filled_)
- return;
-
- grfx::GCache & gc = grfx::GCache::get();
- cached_status_ = gc.status(*this);
- cached_image_ = gc.image(*this);
-}
-
-
-bool InsetGraphics::drawImage() const
+bool InsetGraphics::imageIsDrawable() 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;
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);
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()) {
+ if (imageIsDrawable()) {
paint.image(old_x + 2, baseline - lascent,
lwidth - 4, lascent + ldescent,
- *cached_image_.get());
+ *cache_->loader.image());
} else {
// 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();
cache_filled_ = false;
-}
-
-
-// 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);
+#endif
}
else
lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
- updateInset(buf->filePath());
+ cache_->update(MakeAbsPath(params().filename, buf->filePath()));
}
// LaTeX can cope if the graphics file doesn't exist, so just return the
// filename.
string const orig_file = params().filename;
- string const orig_file_with_path =
+ string orig_file_with_path =
MakeAbsPath(orig_file, buf->filePath());
- lyxerr[Debug::GRAPHICS] << "prepareFile: " << orig_file << endl
- << " with path: " << orig_file_with_path << endl;
+ 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)
- lyxerr[Debug::GRAPHICS] << "it's a zipped file\n";
- if (zipped && params().noUnzip) {
- lyxerr[Debug::GRAPHICS] << "pass file unzipped to LaTeX\n";
- return orig_file;
+ 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 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 of the graphics file is needed.
- // Return the original filename without any extension.
+ // no conversion needed!
+ // Return the original filename as is, because we do not know
+ // what the user decide.
if (buf->niceFile)
- return RemoveExtension(orig_file);
+ 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
// 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
- string temp_file(orig_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tthe orig file is: " << orig_file_with_path << endl;
+
if (lyxrc.use_tempdir) {
- string const ext_tmp = GetExtension(orig_file);
+ string const ext_tmp = GetExtension(orig_file_with_path);
// without ext and /
temp_file = subst(
- ChangeExtension(temp_file, string()), "/", "_");
- // without . and again with ext
+ 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]
- << "InsetGraphics::prepareFile. The temp file is: "
- << temp_file << endl;
-
- // If we are using a temp dir, then copy the file into it.
- if (lyxrc.use_tempdir && !IsFileReadable(temp_file)) {
- bool const success = lyx::copy(orig_file_with_path, temp_file);
lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::prepareFile. Copying from "
- << orig_file << " to " << temp_file
- << (success ? " succeeded\n" : " failed\n");
- if (!success) {
- Alert::alert(_("Cannot copy file"), orig_file,
- _("into tempdir"));
- return orig_file;
- }
- }
-
- // Uncompress the file if necessary. If it has been uncompressed in
- // a previous call to prepareFile, do nothing.
- if (zipped) {
- // What we want to end up with:
- string const temp_file_unzipped =
- ChangeExtension(temp_file, string());
-
- if (!IsFileReadable(temp_file_unzipped)) {
- // unzipFile generates a random filename, so move this
- // file where we want it to go.
- string const tmp = unzipFile(temp_file);
- lyx::copy(tmp, temp_file_unzipped);
- lyx::unlink(tmp);
+ << "\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]
- << "InsetGraphics::prepareFile. Unzipped to "
- << temp_file_unzipped << endl;
+ << "\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;
+ }
}
-
- // We have an uncompressed file where we expect it,
- // so rename temp_file and continue.
- temp_file = temp_file_unzipped;
}
- // Ascertain the graphics format that LaTeX requires.
- // Make again an absolute path, maybe that we have no
- // tempdir. Than temp_file=orig_file
- string const from = lyxrc.use_tempdir ?
- getExtFromContents(temp_file) :
- getExtFromContents(MakeAbsPath(temp_file, buf->filePath()));
- string const to = findTargetFormat(from);
-
- // No conversion is needed. LaTeX can handle the graphics file as it is.
- // This is true even if the orig_file is compressed.
+ string const to = findTargetFormat(from);
+ lyxerr[Debug::GRAPHICS]
+ << "\t we have: from " << from << " to " << to << '\n';
if (from == to) {
- return orig_file;
+ // 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 outfile_base = RemoveExtension(temp_file);
-
lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::prepareFile. The original file is "
- << orig_file << "\n"
- << "A copy has been made and convert is to be called with:\n"
+ << "\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';
- converters.convert(buf, temp_file, outfile_base, from, to);
+ // 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 RemoveExtension(temp_file);
}
// draws only a rectangle with the above bb and the
// not found filename in it.
lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::latex. Message = \"" << message << '\"' << endl;
+ << "\tMessage = \"" << message << '\"' << endl;
// These variables collect all the latex code that should be before and
// after the actual includegraphics command.
// Write the options if there are any.
string const opts = createLatexOptions();
- lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::latex. Opts = " << opts << endl;
+ lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
if (!opts.empty() && !message.empty())
- before += ("[" + opts + ',' + message);
+ before += ("[%\n" + opts + ',' + message);
else if (!message.empty())
- before += ('[' + message);
+ before += ("[%\n" + message);
else if (!opts.empty())
- before += ("[" + opts + ']');
+ before += ("[%\n" + opts + ']');
lyxerr[Debug::GRAPHICS]
- << "InsetGraphics::latex. Before = " << before
- << "\nafter = " << after << endl;
+ << "\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 = message.empty() ?
- (before + '{' + prepareFile(buf) + '}' + after) :
+ (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
(before + '{' + params().filename + " not found!}" + after);
os << latex_str;
// 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
}
+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;