src/graphics/GraphicsCache.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file GraphicsCache.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Baruch Even
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS
  11  *
  12  *  grfx::Cache is the manager of the image cache.
  13  *  It is responsible for creating the grfx::CacheItem's and maintaining them.
  14  *
  15  *  grfx::Cache is a singleton class. It is possible to have only one
  16  *  instance of it at any moment.
  17  */
  18
  19 #ifndef GRAPHICSCACHE_H
  20 #define GRAPHICSCACHE_H
  21
  22 #ifdef __GNUG__
  23 #pragma interface
  24 #endif
  25
  26 #include "LString.h"
  27 #include <vector>
  28 #include <boost/utility.hpp>
  29 #include <boost/scoped_ptr.hpp>
  30 #include <boost/shared_ptr.hpp>
  31
  32
  33 namespace grfx {
  34
  35 class CacheItem;
  36
  37 class Cache : boost::noncopyable {
  38 public:
  39
  40         /// This is a singleton class. Get the instance.
  41         static Cache & get();
  42
  43         /** Which graphics formats can be loaded directly by the image loader.
  44          *  Other formats can be loaded if a converter to a loadable format
  45          *  can be defined.
  46          */
  47         std::vector<string> loadableFormats() const;
  48
  49         /// Add a graphics file to the cache.
  50         void add(string const & file) const;
  51
  52         /// Remove a file from the cache.
  53         void remove(string const & file) const;
  54
  55         /// Returns \c true if the file is in the cache.
  56         bool inCache(string const & file) const;
  57
  58         /** Get the cache item associated with file.
  59          *  Returns an empty container if there is no such item.
  60          *
  61          *  IMPORTANT: whatever uses an image must make a local copy of this
  62          *  ItemPtr. The boost::shared_ptr<>::use_count() function is
  63          *  used to ascertain whether or not to remove the item from the cache
  64          *  when remove(file) is called.
  65          *
  66          *  You have been warned!
  67          */
  68         typedef boost::shared_ptr<CacheItem> ItemPtr;
  69         ///
  70         ItemPtr const item(string const & file) const;
  71
  72 private:
  73         /** Make the c-tor, d-tor private so we can control how many objects
  74          *  are instantiated.
  75          */
  76         Cache();
  77         ///
  78         ~Cache();
  79
  80         /// Use the Pimpl idiom to hide the internals.
  81         class Impl;
  82         /// The pointer never changes although *pimpl_'s contents may.
  83         boost::scoped_ptr<Impl> const pimpl_;
  84 };
  85
  86 } // namespace grfx
  87
  88 #endif // GRAPHICSCACHE_H