diff -r 000000000000 -r dd21522fd290 webengine/osswebengine/WebKit/History/WebHistoryPrivate.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/webengine/osswebengine/WebKit/History/WebHistoryPrivate.h Mon Mar 30 12:54:55 2009 +0300 @@ -0,0 +1,113 @@ +/* + * Copyright (C) 2005 Apple Computer, Inc. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of + * its contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#import + +#import + +@class WebHistoryItem; +@class NSError; + +#ifdef __cplusplus +#include +#include + +typedef int64_t WebHistoryDateKey; +typedef HashMap > DateToEntriesMap; +#else +typedef struct DateToEntriesMap DateToEntriesMap; +#endif + +/* + @constant WebHistoryItemsDiscardedWhileLoadingNotification Posted from loadFromURL:error:. + This notification comes with a userInfo dictionary that contains the array of + items discarded due to the date limit or item limit. The key for the array is WebHistoryItemsKey. +*/ +// FIXME: This notification should become API in WebHistory.h +extern NSString *WebHistoryItemsDiscardedWhileLoadingNotification; + +// FIXME: The WebHistoryPrivate interface should be in WebHistoryInternal.h or inside WebHistory.m +@interface WebHistoryPrivate : NSObject { +@private + NSMutableDictionary *_entriesByURL; + DateToEntriesMap* _entriesByDate; + NSMutableArray *_orderedLastVisitedDays; + BOOL itemLimitSet; + int itemLimit; + BOOL ageInDaysLimitSet; + int ageInDaysLimit; +} + +- (void)addItem:(WebHistoryItem *)entry; +- (void)addItems:(NSArray *)newEntries; +- (BOOL)removeItem:(WebHistoryItem *)entry; +- (BOOL)removeItems:(NSArray *)entries; +- (BOOL)removeAllItems; +- (void)setLastVisitedTimeInterval:(NSTimeInterval)time forItem:(WebHistoryItem *)item; + +- (NSArray *)orderedLastVisitedDays; +- (NSArray *)orderedItemsLastVisitedOnDay:(NSCalendarDate *)calendarDate; +- (BOOL)containsItemForURLString:(NSString *)URLString; +- (BOOL)containsURL:(NSURL *)URL; +- (WebHistoryItem *)itemForURL:(NSURL *)URL; +- (WebHistoryItem *)itemForURLString:(NSString *)URLString; + +- (BOOL)loadFromURL:(NSURL *)URL collectDiscardedItemsInto:(NSMutableArray *)discardedItems error:(NSError **)error; +- (BOOL)saveToURL:(NSURL *)URL error:(NSError **)error; + +- (NSCalendarDate*)_ageLimitDate; + +- (void)setHistoryItemLimit:(int)limit; +- (int)historyItemLimit; +- (void)setHistoryAgeInDaysLimit:(int)limit; +- (int)historyAgeInDaysLimit; + +@end + +@interface WebHistory (WebPrivate) + +// FIXME: The following SPI is used by Safari. Should it be made into public API? +- (WebHistoryItem *)_itemForURLString:(NSString *)URLString; + +// FIXME: Safari doesn't use the following SPI, and it's used in WebKit only inside WebHistory.m. +// Should we move it into a FileInternal category inside WebHistory.m, or do we need it for other +// clients? +- (void)removeItem:(WebHistoryItem *)entry; +- (void)addItem:(WebHistoryItem *)entry; +- (BOOL)containsItemForURLString:(NSString *)URLString; + +// FIXME: Safari doesn't use the following SPI, but other WebKit classes do. Should we move it into +// a WebHistoryInternal.h, or do we need it for other clients? +- (WebHistoryItem *)addItemForURL:(NSURL *)URL; +// Change date on existing item +- (void)setLastVisitedTimeInterval:(NSTimeInterval)time forItem:(WebHistoryItem *)item; + +// FIXME: neither Safari nor WebKit use the following SPI -- do we still need it? +- (NSCalendarDate*)ageLimitDate; + +@end