X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsCacheItem.cpp;h=ea59173eff79bc93588ed18373b7c167965f4a68;hb=2fd2e657458f571df373a1b3fba1e6a33c8f6d59;hp=7448f2318e00f5eb71f0b0822e7291174aa381a7;hpb=20b45450f6abbeaceafebebc4aaacb692abf63f9;p=lyx.git diff --git a/src/graphics/GraphicsCacheItem.cpp b/src/graphics/GraphicsCacheItem.cpp index 7448f2318e..ea59173eff 100644 --- a/src/graphics/GraphicsCacheItem.cpp +++ b/src/graphics/GraphicsCacheItem.cpp @@ -4,7 +4,7 @@ * Licence details can be found in the file COPYING. * * \author Baruch Even - * \author Herbert Voß + * \author Herbert Voß * \author Angus Leeming * * Full author contact details are available in file CREDITS. @@ -25,8 +25,11 @@ #include "support/FileName.h" #include "support/filetools.h" #include "support/FileMonitor.h" +#include "support/lassert.h" +#include "support/unique_ptr.h" -#include +#include "support/bind.h" +#include "support/TempFile.h" using namespace std; using namespace lyx::support; @@ -35,12 +38,19 @@ namespace lyx { namespace graphics { -class CacheItem::Impl : public boost::signals::trackable { +class CacheItem::Impl : public boost::signals2::trackable { public: /// Impl(FileName const & file); + /** + * If no file conversion is needed, then tryDisplayFormat() calls + * loadImage() directly. + * \return true if a conversion is necessary and no error occurred. + */ + bool tryDisplayFormat(FileName & filename, string & from); + /** 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 @@ -48,9 +58,6 @@ public: * 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(). */ @@ -59,7 +66,7 @@ public: /** Load the image into memory. This is called either from * convertToDisplayFormat() direct or from imageConverted(). */ - void loadImage(); + bool loadImage(); /** Get a notification when the image conversion is done. * Connected to a signal on_finish_ which is passed to @@ -67,12 +74,6 @@ public: */ 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. */ @@ -109,21 +110,18 @@ public: bool remove_loaded_file_; /// The image and its loading status. - boost::shared_ptr image_; + std::shared_ptr image_; /// ImageStatus status_; /// This signal is emitted when the image loading status changes. - boost::signal statusChanged; - - /// The connection to the signal Image::finishedLoading - boost::signals::connection cl_; + boost::signals2::signal statusChanged; /// The connection of the signal ConvProcess::finishedConversion, - boost::signals::connection cc_; + boost::signals2::connection cc_; /// - boost::scoped_ptr converter_; + unique_ptr converter_; }; @@ -144,6 +142,20 @@ FileName const & CacheItem::filename() const } +bool CacheItem::tryDisplayFormat() const +{ + if (pimpl_->status_ != WaitingToLoad) + pimpl_->reset(); + FileName filename; + string from; + bool const conversion_needed = pimpl_->tryDisplayFormat(filename, from); + bool const success = status() == Loaded && !conversion_needed; + if (!success) + pimpl_->reset(); + return success; +} + + void CacheItem::startLoading() const { pimpl_->startLoading(); @@ -181,7 +193,7 @@ ImageStatus CacheItem::status() const } -boost::signals::connection CacheItem::connect(slot_type const & slot) const +boost::signals2::connection CacheItem::connect(slot_type const & slot) const { return pimpl_->statusChanged.connect(slot); } @@ -199,7 +211,7 @@ CacheItem::Impl::Impl(FileName const & file) remove_loaded_file_(false), status_(WaitingToLoad) { - monitor_.connect(boost::bind(&Impl::startLoading, this)); + monitor_.connect(bind(&Impl::startLoading, this)); } @@ -225,18 +237,15 @@ void CacheItem::Impl::reset() file_to_load_.erase(); to_.erase(); - if (image_.get()) + if (image_) image_.reset(); status_ = WaitingToLoad; - if (cl_.connected()) - cl_.disconnect(); - if (cc_.connected()) cc_.disconnect(); - if (converter_.get()) + if (converter_) converter_.reset(); } @@ -256,8 +265,8 @@ void CacheItem::Impl::imageConverted(bool success) string const text = success ? "succeeded" : "failed"; LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.'); - file_to_load_ = converter_.get() ? - FileName(converter_->convertedFile()) : FileName(); + file_to_load_ = converter_ ? FileName(converter_->convertedFile()) + : FileName(); converter_.reset(); cc_.disconnect(); @@ -276,28 +285,19 @@ void CacheItem::Impl::imageConverted(bool success) // Add the converted file to the file cache ConverterCache::get().add(filename_, to_, file_to_load_); - loadImage(); + setStatus(loadImage() ? Loaded : ErrorLoading); } // This function gets called from the callback after the image has been // converted successfully. -void CacheItem::Impl::loadImage() +bool CacheItem::Impl::loadImage() { - setStatus(Loading); LYXERR(Debug::GRAPHICS, "Loading image."); - image_.reset(Image::newImage()); - - cl_.disconnect(); - cl_ = image_->finishedLoading.connect( - boost::bind(&Impl::imageLoaded, this, _1)); - image_->load(file_to_load_); -} - + image_.reset(newImage()); -void CacheItem::Impl::imageLoaded(bool success) -{ + bool success = image_->load(file_to_load_); string const text = success ? "succeeded" : "failed"; LYXERR(Debug::GRAPHICS, "Image loading " << text << '.'); @@ -308,15 +308,7 @@ void CacheItem::Impl::imageLoaded(bool success) if (remove_loaded_file_ && unzipped_filename_ != file_to_load_) file_to_load_.removeFile(); - cl_.disconnect(); - - if (!success) { - setStatus(ErrorLoading); - return; - } - - // Inform the outside world. - setStatus(Loaded); + return success; } @@ -326,7 +318,7 @@ static string const findTargetFormat(string const & from) FormatList const & formats = Cache::get().loadableFormats(); // There must be a format to load from. - LASSERT(!formats.empty(), /**/); + LASSERT(!formats.empty(), return string()); // Use the standard converter if we don't know the format to load // from. @@ -357,43 +349,46 @@ static string const findTargetFormat(string const & from) } -void CacheItem::Impl::convertToDisplayFormat() +bool CacheItem::Impl::tryDisplayFormat(FileName & filename, string & from) { - setStatus(Converting); - // First, check that the file exists! + filename_.refresh(); if (!filename_.isReadableFile()) { if (status_ != ErrorNoFile) { - setStatus(ErrorNoFile); + status_ = ErrorNoFile; LYXERR(Debug::GRAPHICS, "\tThe file is not readable"); } - return; + return false; } - // Make a local copy in case we unzip it - FileName filename; - zipped_ = filename_.isZippedFile(); + zipped_ = formats.isZippedFile(filename_); if (zipped_) { - unzipped_filename_ = FileName::tempName( - filename_.toFilesystemEncoding()); + string tempname = unzippedFileName(filename_.toFilesystemEncoding()); + string const ext = getExtension(tempname); + tempname = changeExtension(tempname, "") + "-XXXXXX"; + if (!ext.empty()) + tempname = addExtension(tempname, ext); + TempFile tempfile(tempname); + tempfile.setAutoRemove(false); + unzipped_filename_ = tempfile.name(); if (unzipped_filename_.empty()) { - setStatus(ErrorConverting); + status_ = ErrorConverting; LYXERR(Debug::GRAPHICS, "\tCould not create temporary file."); - return; + return false; } filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding()); } else { filename = filename_; } - docstring const displayed_filename = makeDisplayPath(filename_.absFilename()); + docstring const displayed_filename = makeDisplayPath(filename_.absFileName()); LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n" << "\tAttempting to convert image file: " << filename << "\n\twith displayed filename: " << to_utf8(displayed_filename)); - string const from = formats.getFormatFromFile(filename); + from = formats.getFormatFromFile(filename); if (from.empty()) { - setStatus(ErrorConverting); + status_ = ErrorConverting; LYXERR(Debug::GRAPHICS, "\tCould not determine file format."); } LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data."); @@ -403,33 +398,49 @@ void CacheItem::Impl::convertToDisplayFormat() // No conversion needed! LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!"); file_to_load_ = filename; - loadImage(); - return; + status_ = loadImage() ? Loaded : ErrorLoading; + return false; } if (ConverterCache::get().inCache(filename, to_)) { LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!"); file_to_load_ = ConverterCache::get().cacheName(filename, to_); - loadImage(); - return; + status_ = loadImage() ? Loaded : ErrorLoading; + return false; } + return true; +} + +void CacheItem::Impl::convertToDisplayFormat() +{ LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format."); + // Make a local copy in case we unzip it + FileName filename; + string from; + if (!tryDisplayFormat(filename, from)) { + // The image status has changed, tell it to the outside world. + statusChanged(); + return; + } + + // We will need a conversion, tell it to the outside world. + setStatus(Converting); + // Add some stuff to create a uniquely named temporary file. // This file is deleted in loadImage after it is loaded into memory. - FileName const to_file_base = FileName::tempName("CacheItem"); + TempFile tempfile("CacheItem"); + tempfile.setAutoRemove(false); + FileName const to_file_base = tempfile.name(); remove_loaded_file_ = true; - // Remove the temp file, we only want the name... - // FIXME: This is unsafe! - to_file_base.removeFile(); - // 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.absFilename(), from, to_)); - converter_->connect(boost::bind(&Impl::imageConverted, this, _1)); + converter_ = make_unique(filename, to_file_base.absFileName(), + from, to_); + converter_->connect(bind(&Impl::imageConverted, this, _1)); converter_->startConversion(); }