1 files changed, 177 insertions, 0 deletions
diff --git a/sd/source/ui/slidesorter/inc/cache/SlsPageCacheManager.hxx b/sd/source/ui/slidesorter/inc/cache/SlsPageCacheManager.hxx
new file mode 100644
index 000000000000..50202a7eed3d
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/cache/SlsPageCacheManager.hxx
@@ -0,0 +1,177 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef SD_PAGE_CACHE_MANAGER_HXX
+#define SD_PAGE_CACHE_MANAGER_HXX
+
+#include <sal/types.h>
+#include <com/sun/star/uno/XInterface.hpp>
+#include <boost/shared_ptr.hpp>
+#include <memory>
+#include <vector>
+
+class Size;
+class SdDrawDocument;
+class SdrPage;
+
+namespace sd { namespace slidesorter { namespace view {
+class SlideSorterView;
+class PageObjectViewObjectContact;
+} } }
+
+namespace sd { namespace slidesorter { namespace model {
+class SlideSorterModel;
+} } }
+
+namespace sd { namespace slidesorter { namespace cache {
+
+namespace css = ::com::sun::star;
+
+class BitmapCache;
+
+
+/** Provide and manage the preview bitmap caches for all slide sorter
+    instances.  There is one cache per active slide sorter plus a small
+    number of caches that are no longer in use.  The later are kept to speed
+    up the switching between views.
+*/
+class PageCacheManager
+{
+public:
+    typedef BitmapCache Cache;
+    typedef ::std::vector< ::std::pair<Size, ::boost::shared_ptr<BitmapCache> > > BestFittingPageCaches;
+    typedef css::uno::Reference<css::uno::XInterface> DocumentKey;
+
+    /** Return the one instance of the PageCacheManager class.
+    */
+    static ::boost::shared_ptr<PageCacheManager> Instance (void);
+
+    /** Look up the cache for the given model in which the previews have the
+        specified size.  If no such cache exists, then one is created.  When
+        a new BitmapCache is created its Recycle() method is called with a
+        sorted list of existing caches from which the new one initialize its
+        previews.
+        @return
+            The returned cache lives as long as somebody keeps a shared
+            pointer and the ReleaseCache() method has not been called.
+    */
+    ::boost::shared_ptr<Cache> GetCache (
+        DocumentKey pDocument,
+        const Size& rPreviewSize);
+
+    /** Tell the cache manager to release its own reference to the specified
+        cache.  After that the cache will live as long as the caller (and
+        maybe others) holds its reference.
+    */
+    void ReleaseCache (const ::boost::shared_ptr<Cache>& rpCache);
+
+    /** This is an information to the cache manager that the size of preview
+        bitmaps in the specified cache has changed.
+
+    */
+    ::boost::shared_ptr<Cache> ChangeSize (
+        const ::boost::shared_ptr<Cache>& rpCache,
+        const Size& rOldPreviewSize,
+        const Size& rNewPreviewSize);
+
+    /** Invalidate the preview bitmap for one slide that belongs to the
+        specified document.  The bitmaps for this slide in all caches are
+        marked as out-of-date and will be re-created when they are requested
+        the next time.
+    */
+    void InvalidatePreviewBitmap (
+        DocumentKey pDocument,
+        const SdrPage* pPage);
+
+    /** Invalidate all the caches that are currently in use and destroy
+        those that are not.  This is used for example when the high contrast
+        mode is turned on or off.
+    */
+    void InvalidateAllCaches (void);
+
+private:
+    /** Singleton instance of the cache manager.  Note that this is a weak
+        pointer.  The (implementation class of) ViewShellBase holds a
+        shared_ptr so that the cache manager has the same life time as the
+        ViewShellBase.
+    */
+    static ::boost::weak_ptr<PageCacheManager> mpInstance;
+
+    /// List of active caches.
+    class PageCacheContainer;
+    ::std::auto_ptr<PageCacheContainer> mpPageCaches;
+
+    /// List of inactive, recently used caches.
+    class RecentlyUsedPageCaches;
+    ::std::auto_ptr<RecentlyUsedPageCaches> mpRecentlyUsedPageCaches;
+
+    /** The maximal number of recently used caches that are kept alive after
+        they have become inactive, i.e. after they are not used anymore by a
+        slide sorter.
+    */
+    const sal_uInt32 mnMaximalRecentlyCacheCount;
+
+    PageCacheManager (void);
+    ~PageCacheManager (void);
+
+    class Deleter;
+    friend class Deleter;
+
+    ::boost::shared_ptr<Cache> GetRecentlyUsedCache(
+        DocumentKey pDocument,
+        const Size& rSize);
+
+    /** Add the given cache to the list of recently used caches for the
+        document.  There is one such list per document.  Each least has at
+        most mnMaximalRecentlyCacheCount members.
+    */
+    void PutRecentlyUsedCache(
+        DocumentKey pDocument,
+        const Size& rPreviewSize,
+        const ::boost::shared_ptr<Cache>& rpCache);
+
+    /** Return a sorted list of the available caches, both active caches and
+        those recently used, for the given document.  The sort order is so
+        that an exact match of the preview size is at the front.  Other
+        caches follow with the largest size first.
+    */
+    BestFittingPageCaches GetBestFittingCaches (
+        DocumentKey pDocument,
+        const Size& rPreviewSize);
+
+    /** This method is used internally to initialize a newly created
+        BitmapCache with already exisiting previews.
+    */
+    void Recycle (
+        const ::boost::shared_ptr<Cache>& rpCache,
+        DocumentKey pDocument,
+        const Size& rPreviewSize);
+};
+
+} } } // end of namespace ::sd::slidesorter::cache
+
+#endif