/**
* \file GraphicsCacheItem.C
- * 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
- * \author Herbert Voss
- * \author Angus Leeming
+ * \author Baruch Even
+ * \author Herbert Voß
+ * \author Angus Leeming
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "GraphicsCacheItem.h"
-#include "GraphicsImage.h"
#include "GraphicsConverter.h"
+#include "GraphicsImage.h"
-#include "support/FileMonitor.h"
-
+#include "ConverterCache.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/shared_ptr.hpp>
#include <boost/bind.hpp>
-#include <boost/signals/trackable.hpp>
+
+
+namespace lyx {
+
+using support::FileMonitor;
+using support::FileName;
+using support::isFileReadable;
+using support::makeDisplayPath;
+using support::onlyFilename;
+using support::tempName;
+using support::unlink;
+using support::unzipFile;
+using support::zippedFile;
using std::endl;
+using std::string;
-namespace grfx {
-struct CacheItem::Impl : public boost::signals::trackable {
+namespace graphics {
+
+class CacheItem::Impl : public boost::signals::trackable {
+public:
///
- Impl(string const & file);
+ Impl(FileName const & file);
/** Start the image conversion process, checking first that it is
* necessary. If it is necessary, then a conversion task is started.
/** Get a notification when the image loading is done.
* Connected to a signal on_finish_ which is passed to
- * grfx::Image::loadImage.
+ * lyx::graphics::Image::loadImage.
*/
void imageLoaded(bool);
void reset();
/// The filename we refer too.
- string const filename_;
+ FileName const filename_;
///
FileMonitor const monitor_;
/// Is the file compressed?
bool zipped_;
/// If so, store the uncompressed file in this temporary file.
- string unzipped_filename_;
+ FileName unzipped_filename_;
+ /// The target format
+ string to_;
/// What file are we trying to load?
- string file_to_load_;
+ FileName file_to_load_;
/** Should we delete the file after loading? True if the file is
* the result of a conversion process.
*/
ImageStatus status_;
/// This signal is emitted when the image loading status changes.
- boost::signal0<void> statusChanged;
+ boost::signal<void()> statusChanged;
/// The connection to the signal Image::finishedLoading
boost::signals::connection cl_;
};
-CacheItem::CacheItem(string const & file)
+CacheItem::CacheItem(FileName const & file)
: pimpl_(new Impl(file))
{}
{}
-string const & CacheItem::filename() const
+FileName const & CacheItem::filename() const
{
return pimpl_->filename_;
}
//------------------------------
-CacheItem::Impl::Impl(string const & file)
+CacheItem::Impl::Impl(FileName const & file)
: filename_(file),
monitor_(file, 2000),
zipped_(false),
{
zipped_ = false;
if (!unzipped_filename_.empty())
- lyx::unlink(unzipped_filename_);
+ unlink(unzipped_filename_);
unzipped_filename_.erase();
if (remove_loaded_file_ && !file_to_load_.empty())
- lyx::unlink(file_to_load_);
+ unlink(file_to_load_);
remove_loaded_file_ = false;
file_to_load_.erase();
+ to_.erase();
if (image_.get())
image_.reset();
void CacheItem::Impl::imageConverted(bool success)
{
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();
+ FileName(converter_->convertedFile()) : FileName();
converter_.reset();
cc_.disconnect();
- success = !file_to_load_.empty() && IsFileReadable(file_to_load_);
- lyxerr[Debug::GRAPHICS] << "Unable to find converted file!" << endl;
+ 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;
}
+ // Add the converted file to the file cache
+ ConverterCache::get().add(filename_, to_, file_to_load_);
+
loadImage();
}
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();
}
-} // namespace grfx
-
-
-namespace {
-
-string const findTargetFormat(string const & from)
+static string const findTargetFormat(string const & from)
{
- typedef grfx::Image::FormatList FormatList;
- FormatList const formats = grfx::Image::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());
+ // There must be a format to load from.
+ BOOST_ASSERT(!formats.empty());
+
+ // Use the standard converter if we don't know the format to load
+ // from.
+ if (from.empty())
+ return string("ppm");
// 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?
- FormatList::const_iterator it2 = formats.begin();
- for (; it2 != end; ++it2) {
- if (grfx::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
-
-
-namespace grfx {
void CacheItem::Impl::convertToDisplayFormat()
{
setStatus(Converting);
// First, check that the file exists!
- if (!IsFileReadable(filename_)) {
+ if (!isFileReadable(filename_)) {
if (status_ != ErrorNoFile) {
setStatus(ErrorNoFile);
lyxerr[Debug::GRAPHICS]
}
// Make a local copy in case we unzip it
- string const filename = zippedFile(filename_) ?
- unzipFile(filename_) : filename_;
- string const displayed_filename = MakeDisplayPath(filename_);
+ FileName filename;
+ zipped_ = zippedFile(filename_);
+ if (zipped_) {
+ unzipped_filename_ = tempName(FileName(), filename_.toFilesystemEncoding());
+ if (unzipped_filename_.empty()) {
+ setStatus(ErrorConverting);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCould not create temporary file." << endl;
+ return;
+ }
+ filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
+ } else
+ filename = filename_;
+
+ docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
lyxerr[Debug::GRAPHICS] << "[GrahicsCacheItem::convertToDisplayFormat]\n"
<< "\tAttempting to convert image file: " << filename
- << "\n\twith displayed filename: " << displayed_filename
+ << "\n\twith displayed filename: " << lyx::to_utf8(displayed_filename)
<< endl;
- string from = getExtFromContents(filename);
+ string const from = formats.getFormatFromFile(filename);
+ if (from.empty()) {
+ setStatus(ErrorConverting);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCould not determine file format." << endl;
+ }
lyxerr[Debug::GRAPHICS]
<< "\n\tThe file contains " << from << " format data." << endl;
- string const to = findTargetFormat(from);
+ to_ = findTargetFormat(from);
- if (from == to) {
+ if (from == to_) {
// No conversion needed!
lyxerr[Debug::GRAPHICS] << "\tNo conversion needed (from == to)!" << endl;
file_to_load_ = filename;
return;
}
- lyxerr[Debug::GRAPHICS] << "\tConverting it to " << to << " format." << endl;
- // Take only the filename part of the file, without path or extension.
- string const temp = ChangeExtension(OnlyFilename(filename), string());
+ if (ConverterCache::get().inCache(filename, to_)) {
+ lyxerr[Debug::GRAPHICS] << "\tNo conversion needed (file in file cache)!"
+ << endl;
+ file_to_load_ = ConverterCache::get().cacheName(filename, to_);
+ loadImage();
+ return;
+ }
+
+ lyxerr[Debug::GRAPHICS] << "\tConverting it to " << to_ << " format." << endl;
// 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);
+ FileName const to_file_base(tempName(FileName(), "CacheItem"));
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.
- converter_.reset(new Converter(filename, to_file_base, from, to));
+ converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
converter_->startConversion();
}
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
projects / lyx.git / blobdiff