X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsCacheItem.cpp;h=f54ce80ec3f0d790c1169745ace908d09eb1e888;hb=47973dc2b448dd2753f0b55c057ceda9e349a5f1;hp=565be61f2fd0c6a0f61b3c3848298926d91b2684;hpb=00e305c9d9bd8b0ff54b6c58adb6192d5934ed60;p=lyx.git diff --git a/src/graphics/GraphicsCacheItem.cpp b/src/graphics/GraphicsCacheItem.cpp index 565be61f2f..f54ce80ec3 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. @@ -13,43 +13,45 @@ #include #include "GraphicsCacheItem.h" + +#include "Buffer.h" +#include "GraphicsCache.h" #include "GraphicsConverter.h" #include "GraphicsImage.h" #include "ConverterCache.h" -#include "debug.h" #include "Format.h" +#include "support/debug.h" +#include "support/FileName.h" #include "support/filetools.h" #include "support/FileMonitor.h" -#include "support/lyxlib.h" +#include "support/lassert.h" +#include "support/unique_ptr.h" -#include +#include "support/TempFile.h" +using namespace std; +using namespace lyx::support; 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 graphics { -class CacheItem::Impl : public boost::signals::trackable { +class CacheItem::Impl { public: /// - Impl(FileName const & file); + Impl(FileName const & file, FileName const & doc_file); + + void startMonitor(); + + /** + * 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. @@ -58,9 +60,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(). */ @@ -69,7 +68,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 @@ -77,12 +76,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. */ @@ -102,8 +95,10 @@ public: /// The filename we refer too. FileName const filename_; + /// The document filename this graphic item belongs to + FileName const doc_file_; /// - FileMonitor const monitor_; + ActiveFileMonitorPtr monitor_; /// Is the file compressed? bool zipped_; @@ -119,31 +114,27 @@ 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_; - - /// The connection of the signal ConvProcess::finishedConversion, - boost::signals::connection cc_; + signals2::signal statusChanged; /// - boost::scoped_ptr converter_; + unique_ptr converter_; }; -CacheItem::CacheItem(FileName const & file) - : pimpl_(new Impl(file)) +CacheItem::CacheItem(FileName const & file, FileName const & doc_file) + : pimpl_(new Impl(file,doc_file)) {} CacheItem::~CacheItem() -{} +{ + delete pimpl_; +} FileName const & CacheItem::filename() const @@ -152,6 +143,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(); @@ -160,20 +165,21 @@ void CacheItem::startLoading() const void CacheItem::startMonitoring() const { - if (!pimpl_->monitor_.monitoring()) - pimpl_->monitor_.start(); + pimpl_->startMonitor(); } bool CacheItem::monitoring() const { - return pimpl_->monitor_.monitoring(); + return (bool)pimpl_->monitor_; } -unsigned long CacheItem::checksum() const +void CacheItem::checkModifiedAsync() const { - return pimpl_->monitor_.checksum(); + if (!pimpl_->monitor_) + return; + pimpl_->monitor_->checkModifiedAsync(); } @@ -189,7 +195,7 @@ ImageStatus CacheItem::status() const } -boost::signals::connection CacheItem::connect(slot_type const & slot) const +signals2::connection CacheItem::connect(slot_type const & slot) const { return pimpl_->statusChanged.connect(slot); } @@ -200,14 +206,21 @@ boost::signals::connection CacheItem::connect(slot_type const & slot) const //------------------------------ -CacheItem::Impl::Impl(FileName const & file) - : filename_(file), - monitor_(file, 2000), +CacheItem::Impl::Impl(FileName const & file, FileName const & doc_file) + : filename_(file), doc_file_(doc_file), zipped_(false), remove_loaded_file_(false), status_(WaitingToLoad) +{} + + +void CacheItem::Impl::startMonitor() { - monitor_.connect(boost::bind(&Impl::startLoading, this)); + if (monitor_) + return; + monitor_ = FileSystemWatcher::activeMonitor(filename_); + // Disconnected at the same time as this is destroyed. + monitor_->connect([=](bool /* exists */){ startLoading(); }); } @@ -224,27 +237,21 @@ void CacheItem::Impl::reset() { zipped_ = false; if (!unzipped_filename_.empty()) - unlink(unzipped_filename_); + unzipped_filename_.removeFile(); unzipped_filename_.erase(); if (remove_loaded_file_ && !file_to_load_.empty()) - unlink(file_to_load_); + file_to_load_.removeFile(); remove_loaded_file_ = false; 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(); } @@ -262,22 +269,20 @@ void CacheItem::Impl::setStatus(ImageStatus new_status) 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 << '.'); - file_to_load_ = converter_.get() ? - FileName(converter_->convertedFile()) : FileName(); + file_to_load_ = converter_ ? FileName(converter_->convertedFile()) + : FileName(); converter_.reset(); - cc_.disconnect(); - success = !file_to_load_.empty() && isFileReadable(file_to_load_); + success = !file_to_load_.empty() && file_to_load_.isReadableFile(); if (!success) { - LYXERR(Debug::GRAPHICS) << "Unable to find converted file!" - << endl; + LYXERR(Debug::GRAPHICS, "Unable to find converted file!"); setStatus(ErrorConverting); if (zipped_) - unlink(unzipped_filename_); + unzipped_filename_.removeFile(); return; } @@ -285,57 +290,39 @@ 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." << endl; + LYXERR(Debug::GRAPHICS, "Loading image."); - image_ = Image::newImage(); + image_.reset(newImage()); - cl_.disconnect(); - cl_ = image_->finishedLoading.connect( - boost::bind(&Impl::imageLoaded, this, _1)); - image_->load(file_to_load_); -} - - -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 << '.' << endl; + LYXERR(Debug::GRAPHICS, "Image loading " << text << '.'); // Clean up after loading. if (zipped_) - unlink(unzipped_filename_); + unzipped_filename_.removeFile(); if (remove_loaded_file_ && unzipped_filename_ != file_to_load_) - unlink(file_to_load_); - - cl_.disconnect(); - - if (!success) { - setStatus(ErrorLoading); - return; - } + file_to_load_.removeFile(); - // Inform the outside world. - setStatus(Loaded); + return success; } -static string const findTargetFormat(string const & from) -{ - typedef lyx::graphics::Image::FormatList FormatList; - FormatList const formats = lyx::graphics::Image::loadableFormats(); +typedef vector FormatList; +static string const findTargetFormat(FormatList const & format_list, string const & from) +{ // There must be a format to load from. - BOOST_ASSERT(!formats.empty()); + LASSERT(!theFormats().empty(), return string()); // Use the standard converter if we don't know the format to load // from. @@ -343,22 +330,21 @@ static string const findTargetFormat(string const & from) return string("ppm"); // First ascertain if we can load directly with no conversion - FormatList::const_iterator it = formats.begin(); - FormatList::const_iterator end = formats.end(); + FormatList::const_iterator it = format_list.begin(); + FormatList::const_iterator end = format_list.end(); for (; it != end; ++it) { if (from == *it) return *it; } // So, we have to convert to a loadable format. Can we? - it = formats.begin(); + it = format_list.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; + LYXERR(Debug::GRAPHICS, "Unable to convert from " << from + << " to " << *it); } // Failed! so we have to try to convert it to PPM format @@ -367,83 +353,102 @@ 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! - if (!isFileReadable(filename_)) { + filename_.refresh(); + if (!filename_.isReadableFile()) { if (status_ != ErrorNoFile) { - setStatus(ErrorNoFile); - LYXERR(Debug::GRAPHICS) - << "\tThe file is not readable" << endl; + 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_ = zippedFile(filename_); + zipped_ = theFormats().isZippedFile(filename_); if (zipped_) { - unzipped_filename_ = tempName(FileName(), 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); - LYXERR(Debug::GRAPHICS) - << "\tCould not create temporary file." << endl; - return; + status_ = ErrorConverting; + LYXERR(Debug::GRAPHICS, "\tCould not create temporary file."); + return false; } filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding()); - } else + } else { filename = filename_; + } - docstring const displayed_filename = makeDisplayPath(filename_.absFilename()); - LYXERR(Debug::GRAPHICS) << "[graphics::CacheItem::Impl::convertToDisplayFormat]\n" + docstring const displayed_filename = makeDisplayPath(filename_.absFileName()); + LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n" << "\tAttempting to convert image file: " << filename - << "\n\twith displayed filename: " << lyx::to_utf8(displayed_filename) - << endl; + << "\n\twith displayed filename: " << to_utf8(displayed_filename)); - string const from = formats.getFormatFromFile(filename); + from = theFormats().getFormatFromFile(filename); if (from.empty()) { - setStatus(ErrorConverting); - LYXERR(Debug::GRAPHICS) - << "\tCould not determine file format." << endl; + status_ = ErrorConverting; + LYXERR(Debug::GRAPHICS, "\tCould not determine file format."); } - LYXERR(Debug::GRAPHICS) - << "\n\tThe file contains " << from << " format data." << endl; - to_ = findTargetFormat(from); + LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data."); + to_ = findTargetFormat(Cache::get().loadableFormats(), from); if (from == to_) { // No conversion needed! - LYXERR(Debug::GRAPHICS) << "\tNo conversion needed (from == to)!" << endl; + 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)!" - << endl; + LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!"); file_to_load_ = ConverterCache::get().cacheName(filename, to_); - loadImage(); + 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; } - LYXERR(Debug::GRAPHICS) << "\tConverting it to " << to_ << " format." << endl; + // 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(tempName(FileName(), "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! - 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.absFilename(), from, to_)); - converter_->connect(boost::bind(&Impl::imageConverted, this, _1)); + converter_ = make_unique(doc_file_, filename, + to_file_base.absFileName(), + from, to_); + // Connection is closed at the same time as *this is destroyed. + converter_->connect([this](bool success){ + imageConverted(success); + }); converter_->startConversion(); }