-/*
+/**
* \file GraphicsCacheItem.C
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * \author Baruch Even <baruch.even@writeme.com>
- * \author Herbert Voss <voss@lyx.org>
- * \author Angus Leeming <a.leeming@ic.ac.uk>
+ * \author Baruch Even
+ * \author Herbert Voß
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include "graphics/GraphicsCacheItem.h"
-#include "graphics/GraphicsImage.h"
-#include "graphics/GraphicsConverter.h"
+#include "GraphicsCacheItem.h"
+#include "GraphicsConverter.h"
+#include "GraphicsImage.h"
#include "debug.h"
+#include "format.h"
-#include "support/LAssert.h"
#include "support/filetools.h"
+#include "support/FileMonitor.h"
+#include "support/lyxlib.h"
#include <boost/bind.hpp>
-using std::endl;
+namespace support = lyx::support;
+
+using support::ChangeExtension;
+using support::FileMonitor;
+using support::IsFileReadable;
+using support::MakeDisplayPath;
+using support::OnlyFilename;
+using support::tempName;
+using support::unlink;
+using support::unzipFile;
+using support::unzippedFileName;
+using support::zippedFile;
+
+using std::endl;
+using std::string;
+
+
+namespace lyx {
+namespace graphics {
+
+class CacheItem::Impl : public boost::signals::trackable {
+public:
+
+ ///
+ Impl(string const & file);
+
+ /** Start the image conversion process, checking first that it is
+ * necessary. If it is necessary, then a conversion task is started.
+ * CacheItem asumes that the conversion is asynchronous and so
+ * passes a Signal to the converting routine. When the conversion
+ * is finished, this Signal is emitted, returning the converted
+ * file to this->imageConverted.
+ *
+ * If no file conversion is needed, then convertToDisplayFormat() calls
+ * loadImage() directly.
+ *
+ * convertToDisplayFormat() will set the loading status flag as
+ * approriate through calls to setStatus().
+ */
+ void convertToDisplayFormat();
+
+ /** Load the image into memory. This is called either from
+ * convertToDisplayFormat() direct or from imageConverted().
+ */
+ void loadImage();
+
+ /** Get a notification when the image conversion is done.
+ * Connected to a signal on_finish_ which is passed to
+ * Converter::convert.
+ */
+ void imageConverted(bool);
+
+ /** Get a notification when the image loading is done.
+ * Connected to a signal on_finish_ which is passed to
+ * lyx::graphics::Image::loadImage.
+ */
+ void imageLoaded(bool);
+
+ /** Sets the status of the loading process. Also notifies
+ * listeners that the status has changed.
+ */
+ void setStatus(ImageStatus new_status);
+
+ /** Can be invoked directly by the user, but is also connected to the
+ * FileMonitor and so is invoked when the file is changed
+ * (if monitoring is taking place).
+ */
+ void startLoading();
+
+ /** If we are asked to load the file for a second or further time,
+ * (because the file has changed), then we'll have to first reset
+ * many of the variables below.
+ */
+ void reset();
+
+ /// The filename we refer too.
+ string const filename_;
+ ///
+ FileMonitor const monitor_;
+
+ /// Is the file compressed?
+ bool zipped_;
+ /// If so, store the uncompressed file in this temporary file.
+ string unzipped_filename_;
+ /// What file are we trying to load?
+ string file_to_load_;
+ /** Should we delete the file after loading? True if the file is
+ * the result of a conversion process.
+ */
+ bool remove_loaded_file_;
+
+ /// The image and its loading status.
+ boost::shared_ptr<Image> image_;
+ ///
+ ImageStatus status_;
+
+ /// This signal is emitted when the image loading status changes.
+ boost::signal<void()> statusChanged;
+
+ /// The connection to the signal Image::finishedLoading
+ boost::signals::connection cl_;
+
+ /// The connection of the signal ConvProcess::finishedConversion,
+ boost::signals::connection cc_;
+
+ ///
+ boost::scoped_ptr<Converter> converter_;
+};
+
+
+CacheItem::CacheItem(string const & file)
+ : pimpl_(new Impl(file))
+{}
-namespace grfx {
-GCacheItem::GCacheItem(string const & file)
- : filename_(file), zipped_(false),
- remove_loaded_file_(false), status_(WaitingToLoad)
+CacheItem::~CacheItem()
{}
-void GCacheItem::startLoading()
+string const & CacheItem::filename() const
{
- if (status() != WaitingToLoad)
- return;
+ return pimpl_->filename_;
+}
+
+
+void CacheItem::startLoading() const
+{
+ pimpl_->startLoading();
+}
+
+
+void CacheItem::startMonitoring() const
+{
+ if (!pimpl_->monitor_.monitoring())
+ pimpl_->monitor_.start();
+}
+
+
+bool CacheItem::monitoring() const
+{
+ return pimpl_->monitor_.monitoring();
+}
+
+
+unsigned long CacheItem::checksum() const
+{
+ return pimpl_->monitor_.checksum();
+}
+
+
+Image const * CacheItem::image() const
+{
+ return pimpl_->image_.get();
+}
+
+
+ImageStatus CacheItem::status() const
+{
+ return pimpl_->status_;
+}
+
+
+boost::signals::connection CacheItem::connect(slot_type const & slot) const
+{
+ return pimpl_->statusChanged.connect(slot);
+}
+
+
+//------------------------------
+// Implementation details follow
+//------------------------------
+
+
+CacheItem::Impl::Impl(string const & file)
+ : filename_(file),
+ monitor_(file, 2000),
+ zipped_(false),
+ remove_loaded_file_(false),
+ status_(WaitingToLoad)
+{
+ monitor_.connect(boost::bind(&Impl::startLoading, this));
+}
+
+
+void CacheItem::Impl::startLoading()
+{
+ if (status_ != WaitingToLoad)
+ reset();
convertToDisplayFormat();
}
-void GCacheItem::setStatus(ImageStatus new_status)
+void CacheItem::Impl::reset()
+{
+ zipped_ = false;
+ if (!unzipped_filename_.empty())
+ unlink(unzipped_filename_);
+ unzipped_filename_.erase();
+
+ if (remove_loaded_file_ && !file_to_load_.empty())
+ unlink(file_to_load_);
+ remove_loaded_file_ = false;
+ file_to_load_.erase();
+
+ if (image_.get())
+ image_.reset();
+
+ status_ = WaitingToLoad;
+
+ if (cl_.connected())
+ cl_.disconnect();
+
+ if (cc_.connected())
+ cc_.disconnect();
+
+ if (converter_.get())
+ converter_.reset();
+}
+
+
+void CacheItem::Impl::setStatus(ImageStatus new_status)
{
if (status_ == new_status)
return;
}
-void GCacheItem::imageConverted(string const & file_to_load)
+void CacheItem::Impl::imageConverted(bool success)
{
- bool const success =
- (!file_to_load.empty() && IsFileReadable(file_to_load));
-
string const text = success ? "succeeded" : "failed";
- lyxerr[Debug::GRAPHICS] << "Image conversion " << text << "." << endl;
+ lyxerr[Debug::GRAPHICS] << "Image conversion " << text << '.' << endl;
+
+ file_to_load_ = converter_.get() ?
+ converter_->convertedFile() : string();
+ converter_.reset();
+ cc_.disconnect();
+
+ success = !file_to_load_.empty() && IsFileReadable(file_to_load_);
if (!success) {
+ lyxerr[Debug::GRAPHICS] << "Unable to find converted file!"
+ << endl;
setStatus(ErrorConverting);
if (zipped_)
- lyx::unlink(unzipped_filename_);
+ unlink(unzipped_filename_);
return;
}
- cc_.disconnect();
-
- // Do the actual image loading from file to memory.
- file_to_load_ = file_to_load;
-
loadImage();
}
// This function gets called from the callback after the image has been
// converted successfully.
-void GCacheItem::loadImage()
+void CacheItem::Impl::loadImage()
{
setStatus(Loading);
lyxerr[Debug::GRAPHICS] << "Loading image." << endl;
- // Connect a signal to this->imageLoaded and pass this signal to
- // GImage::loadImage.
- SignalLoadTypePtr on_finish;
- on_finish.reset(new SignalLoadType);
- cl_ = on_finish->connect(boost::bind(&GCacheItem::imageLoaded, this, _1));
+ image_ = Image::newImage();
- image_ = GImage::newImage();
- image_->load(file_to_load_, on_finish);
+ cl_.disconnect();
+ cl_ = image_->finishedLoading.connect(
+ boost::bind(&Impl::imageLoaded, this, _1));
+ image_->load(file_to_load_);
}
-void GCacheItem::imageLoaded(bool success)
+void CacheItem::Impl::imageLoaded(bool success)
{
string const text = success ? "succeeded" : "failed";
- lyxerr[Debug::GRAPHICS] << "Image loading " << text << "." << endl;
+ lyxerr[Debug::GRAPHICS] << "Image loading " << text << '.' << endl;
// Clean up after loading.
if (zipped_)
- lyx::unlink(unzipped_filename_);
+ unlink(unzipped_filename_);
if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
- lyx::unlink(file_to_load_);
+ unlink(file_to_load_);
cl_.disconnect();
return;
}
+ // Inform the outside world.
setStatus(Loaded);
}
+} // namespace graphics
+} // namespace lyx
+
+
namespace {
string const findTargetFormat(string const & from)
{
- typedef GImage::FormatList FormatList;
- FormatList const formats = GImage::loadableFormats();
+ typedef lyx::graphics::Image::FormatList FormatList;
+ FormatList const formats = lyx::graphics::Image::loadableFormats();
// There must be a format to load from.
- lyx::Assert(!formats.empty());
+ BOOST_ASSERT(!formats.empty());
// First ascertain if we can load directly with no conversion
- FormatList::const_iterator it1 = formats.begin();
+ FormatList::const_iterator it = formats.begin();
FormatList::const_iterator end = formats.end();
- for (; it1 != end; ++it1) {
- if (from == *it1)
- return *it1;
+ for (; it != end; ++it) {
+ if (from == *it)
+ return *it;
}
// So, we have to convert to a loadable format. Can we?
- grfx::GConverter const & graphics_converter = grfx::GConverter::get();
-
- FormatList::const_iterator it2 = formats.begin();
- for (; it2 != end; ++it2) {
- if (graphics_converter.isReachable(from, *it2))
- return *it2;
+ it = formats.begin();
+ for (; it != end; ++it) {
+ if (lyx::graphics::Converter::isReachable(from, *it))
+ return *it;
+ else
+ lyxerr[Debug::GRAPHICS]
+ << "Unable to convert from " << from
+ << " to " << *it << std::endl;
}
- // Failed! so we have to try to convert it to XPM format
+ // Failed! so we have to try to convert it to PPM format
// with the standard converter
- return string("xpm");
+ return string("ppm");
}
} // anon namespace
-void GCacheItem::convertToDisplayFormat()
+namespace lyx {
+namespace graphics {
+
+void CacheItem::Impl::convertToDisplayFormat()
{
setStatus(Converting);
+
+ // First, check that the file exists!
+ if (!IsFileReadable(filename_)) {
+ if (status_ != ErrorNoFile) {
+ setStatus(ErrorNoFile);
+ lyxerr[Debug::GRAPHICS]
+ << "\tThe file is not readable" << endl;
+ }
+ return;
+ }
+
// Make a local copy in case we unzip it
- string const filename = zippedFile(filename_) ?
- unzipFile(filename_) : filename_;
+ string filename;
+ if ((zipped_ = zippedFile(filename_))) {
+ unzipped_filename_ = tempName(string(), filename_);
+ if (unzipped_filename_.empty()) {
+ setStatus(ErrorConverting);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCould not create temporary file." << endl;
+ return;
+ }
+ filename = unzipFile(filename_, unzipped_filename_);
+ } else
+ filename = filename_;
+
string const displayed_filename = MakeDisplayPath(filename_);
lyxerr[Debug::GRAPHICS] << "[GrahicsCacheItem::convertToDisplayFormat]\n"
<< "\tAttempting to convert image file: " << filename
<< "\n\twith displayed filename: " << displayed_filename
<< endl;
- // First, check that the file exists!
- if (!IsFileReadable(filename)) {
- setStatus(ErrorNoFile);
- lyxerr[Debug::GRAPHICS] << "\tThe file is not readable" << endl;
+ string const from = formats.getFormatFromFile(filename);
+ if (from.empty()) {
+ setStatus(ErrorConverting);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCould not determine file format." << endl;
return;
}
-
- string from = getExtFromContents(filename);
- // Some old ps-files make problems, so we do not need direct
- // loading of an ps-file
- if (from == "ps") {
- lyxerr[Debug::GRAPHICS]
- << "\n\tThe file contains PostScript format data.\n"
- << "\tchanging it to eps-format to get it converted to xpm\n";
- from = "eps";
- } else
- lyxerr[Debug::GRAPHICS]
- << "\n\tThe file contains " << from << " format data." << endl;
- string const to = grfx::findTargetFormat(from);
+ lyxerr[Debug::GRAPHICS]
+ << "\n\tThe file contains " << from << " format data." << endl;
+ string const to = findTargetFormat(from);
if (from == to) {
// No conversion needed!
// Add some stuff to create a uniquely named temporary file.
// This file is deleted in loadImage after it is loaded into memory.
- string const to_file_base = lyx::tempName(string(), temp);
+ string const to_file_base = tempName(string(), temp);
remove_loaded_file_ = true;
// Remove the temp file, we only want the name...
- lyx::unlink(to_file_base);
+ // FIXME: This is unsafe!
+ unlink(to_file_base);
// Connect a signal to this->imageConverted and pass this signal to
// the graphics converter so that we can load the modified file
// on completion of the conversion process.
- SignalConvertTypePtr on_finish;
- on_finish.reset(new SignalConvertType);
- cc_ = on_finish->connect(boost::bind(&GCacheItem::imageConverted, this, _1));
-
- GConverter & graphics_converter = GConverter::get();
- graphics_converter.convert(filename, to_file_base, from, to, on_finish);
+ converter_.reset(new Converter(filename, to_file_base, from, to));
+ converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
+ converter_->startConversion();
}
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
projects / lyx.git / blobdiff