WebCore/bridge/mac/WebCoreIconDatabaseBridge.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifdef __cplusplus
  27 namespace WebCore {
  28 class IconDatabase;
  29 class Image;
  30 class String;
  31 }
  32 typedef WebCore::IconDatabase WebCoreIconDatabase;
  33 #else
  34 @class WebCoreIconDatabase;
  35 #endif
  36 @class WebCoreIconDatabaseBridge;
  37
  38 @interface WebCoreIconDatabaseBridge : NSObject
  39 {
  40     WebCoreIconDatabaseBridge *_sharedInstance;
  41     WebCoreIconDatabase *_iconDB;
  42 }
  43 - (BOOL)openSharedDatabaseWithPath:(NSString *)path;
  44 - (void)closeSharedDatabase;
  45 - (BOOL)isOpen;
  46 - (void)removeAllIcons;
  47
  48 - (NSImage *)iconForPageURL:(NSString *)url withSize:(NSSize)size;
  49 - (NSString *)iconURLForPageURL:(NSString *)url;
  50 - (NSImage *)defaultIconWithSize:(NSSize)size;
  51 - (void)retainIconForURL:(NSString *)url;
  52 - (void)releaseIconForURL:(NSString *)url;
  53
  54 - (BOOL)isIconExpiredForIconURL:(NSString *)iconURL;
  55
  56 - (void)setPrivateBrowsingEnabled:(BOOL)flag;
  57 - (BOOL)privateBrowsingEnabled;
  58
  59 - (NSString *)defaultDatabaseFilename;
  60
  61 - (void)_setIconData:(NSData *)data forIconURL:(NSString *)iconURL;
  62 - (void)_setHaveNoIconForIconURL:(NSString *)iconURL;
  63 - (BOOL)_setIconURL:(NSString *)iconURL forPageURL:(NSString *)pageURL;
  64 - (BOOL)_hasEntryForIconURL:(NSString *)iconURL;
  65
  66 - (BOOL)_isEmpty;
  67 @end
  68
  69
  70 // The WebCoreIconDatabaseBridge protocol contains methods for use by the WebCore side of the bridge.
  71
  72 @protocol WebCoreIconDatabaseBridge
  73 + (WebCoreIconDatabaseBridge *)sharedBridgeInstance;
  74 - (void)loadIconFromURL:(NSString *)iconURL;
  75 @end
  76
  77
  78 // This interface definition allows those who hold a WebCoreIconDatabaseBridge * to call all the methods
  79 // in the WebCoreIconDatabaseBridge protocol without requiring the base implementation to supply the methods.
  80 // This idiom is appropriate because WebCoreIconDatabaseBridge is an abstract class.
  81
  82 @interface WebCoreIconDatabaseBridge (SubclassResponsibility) <WebCoreIconDatabaseBridge>
  83 @end