WebBackForwardList.mm [plain text]
/*
* Copyright (C) 2005, 2007 Apple 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 "WebBackForwardList.h"
#import "WebBackForwardListInternal.h"
#import "WebFrameInternal.h"
#import "WebHistoryItemInternal.h"
#import "WebHistoryItemPrivate.h"
#import "WebKitLogging.h"
#import "WebKitVersionChecks.h"
#import "WebNSObjectExtras.h"
#import "WebPreferencesPrivate.h"
#import "WebTypesInternal.h"
#import "WebViewPrivate.h"
#import <WebCore/BackForwardListImpl.h>
#import <WebCore/HistoryItem.h>
#import <WebCore/Page.h>
#import <WebCore/PageCache.h>
#import <WebCore/Settings.h>
#import <WebCore/ThreadCheck.h>
#import <WebCore/WebCoreObjCExtras.h>
#import <runtime/InitializeThreading.h>
#import <wtf/Assertions.h>
#import <wtf/RetainPtr.h>
#import <wtf/StdLibExtras.h>
#import <wtf/Threading.h>
using namespace WebCore;
typedef HashMap<BackForwardListImpl*, WebBackForwardList*> BackForwardListMap;
// FIXME: Instead of this we could just create a class derived from BackForwardListImpl
// with a pointer to a WebBackForwardList in it.
static BackForwardListMap& backForwardLists()
{
DEFINE_STATIC_LOCAL(BackForwardListMap, staticBackForwardLists, ());
return staticBackForwardLists;
}
@implementation WebBackForwardList (WebBackForwardListInternal)
BackForwardListImpl* core(WebBackForwardList *webBackForwardList)
{
if (!webBackForwardList)
return 0;
return reinterpret_cast<BackForwardListImpl*>(webBackForwardList->_private);
}
WebBackForwardList *kit(BackForwardListImpl* backForwardList)
{
if (!backForwardList)
return nil;
if (WebBackForwardList *webBackForwardList = backForwardLists().get(backForwardList))
return webBackForwardList;
return [[[WebBackForwardList alloc] initWithBackForwardList:backForwardList] autorelease];
}
- (id)initWithBackForwardList:(PassRefPtr<BackForwardListImpl>)backForwardList
{
WebCoreThreadViolationCheckRoundOne();
self = [super init];
if (!self)
return nil;
_private = reinterpret_cast<WebBackForwardListPrivate*>(backForwardList.releaseRef());
backForwardLists().set(core(self), self);
return self;
}
@end
@implementation WebBackForwardList
+ (void)initialize
{
JSC::initializeThreading();
WTF::initializeMainThreadToProcessMainThread();
WebCoreObjCFinalizeOnMainThread(self);
}
- (id)init
{
return [self initWithBackForwardList:BackForwardListImpl::create(0)];
}
- (void)dealloc
{
if (WebCoreObjCScheduleDeallocateOnMainThread([WebBackForwardList class], self))
return;
BackForwardListImpl* backForwardList = core(self);
ASSERT(backForwardList);
if (backForwardList) {
ASSERT(backForwardList->closed());
backForwardLists().remove(backForwardList);
backForwardList->deref();
}
[super dealloc];
}
- (void)finalize
{
WebCoreThreadViolationCheckRoundOne();
BackForwardListImpl* backForwardList = core(self);
ASSERT(backForwardList);
if (backForwardList) {
ASSERT(backForwardList->closed());
backForwardLists().remove(backForwardList);
backForwardList->deref();
}
[super finalize];
}
- (void)_close
{
core(self)->close();
}
- (void)addItem:(WebHistoryItem *)entry
{
core(self)->addItem(core(entry));
// Since the assumed contract with WebBackForwardList is that it retains its WebHistoryItems,
// the following line prevents a whole class of problems where a history item will be created in
// a function, added to the BFlist, then used in the rest of that function.
[[entry retain] autorelease];
}
- (void)removeItem:(WebHistoryItem *)item
{
core(self)->removeItem(core(item));
}
- (BOOL)containsItem:(WebHistoryItem *)item
{
return core(self)->containsItem(core(item));
}
- (void)goBack
{
core(self)->goBack();
}
- (void)goForward
{
core(self)->goForward();
}
- (void)goToItem:(WebHistoryItem *)item
{
core(self)->goToItem(core(item));
}
- (WebHistoryItem *)backItem
{
return [[kit(core(self)->backItem()) retain] autorelease];
}
- (WebHistoryItem *)currentItem
{
return [[kit(core(self)->currentItem()) retain] autorelease];
}
- (WebHistoryItem *)forwardItem
{
return [[kit(core(self)->forwardItem()) retain] autorelease];
}
static NSArray* vectorToNSArray(HistoryItemVector& list)
{
unsigned size = list.size();
NSMutableArray *result = [[[NSMutableArray alloc] initWithCapacity:size] autorelease];
for (unsigned i = 0; i < size; ++i)
[result addObject:kit(list[i].get())];
return result;
}
static bool bumperCarBackForwardHackNeeded()
{
static bool hackNeeded = [[[NSBundle mainBundle] bundleIdentifier] isEqualToString:@"com.freeverse.bumpercar"] &&
!WebKitLinkedOnOrAfter(WEBKIT_FIRST_VERSION_WITHOUT_BUMPERCAR_BACK_FORWARD_QUIRK);
return hackNeeded;
}
- (NSArray *)backListWithLimit:(int)limit
{
HistoryItemVector list;
core(self)->backListWithLimit(limit, list);
NSArray *result = vectorToNSArray(list);
if (bumperCarBackForwardHackNeeded()) {
static NSArray *lastBackListArray = nil;
[lastBackListArray release];
lastBackListArray = [result retain];
}
return result;
}
- (NSArray *)forwardListWithLimit:(int)limit
{
HistoryItemVector list;
core(self)->forwardListWithLimit(limit, list);
NSArray *result = vectorToNSArray(list);
if (bumperCarBackForwardHackNeeded()) {
static NSArray *lastForwardListArray = nil;
[lastForwardListArray release];
lastForwardListArray = [result retain];
}
return result;
}
- (int)capacity
{
return core(self)->capacity();
}
- (void)setCapacity:(int)size
{
core(self)->setCapacity(size);
}
-(NSString *)description
{
NSMutableString *result;
result = [NSMutableString stringWithCapacity:512];
[result appendString:@"\n--------------------------------------------\n"];
[result appendString:@"WebBackForwardList:\n"];
BackForwardListImpl* backForwardList = core(self);
HistoryItemVector& entries = backForwardList->entries();
unsigned size = entries.size();
for (unsigned i = 0; i < size; ++i) {
if (entries[i] == backForwardList->currentItem()) {
[result appendString:@" >>>"];
} else {
[result appendString:@" "];
}
[result appendFormat:@"%2d) ", i];
int currPos = [result length];
[result appendString:[kit(entries[i].get()) description]];
// shift all the contents over. a bit slow, but this is for debugging
NSRange replRange = {currPos, [result length]-currPos};
[result replaceOccurrencesOfString:@"\n" withString:@"\n " options:0 range:replRange];
[result appendString:@"\n"];
}
[result appendString:@"\n--------------------------------------------\n"];
return result;
}
- (void)setPageCacheSize:(NSUInteger)size
{
[kit(core(self)->page()) setUsesPageCache:size != 0];
}
- (NSUInteger)pageCacheSize
{
return [kit(core(self)->page()) usesPageCache] ? pageCache()->capacity() : 0;
}
- (int)backListCount
{
return core(self)->backListCount();
}
- (int)forwardListCount
{
return core(self)->forwardListCount();
}
- (WebHistoryItem *)itemAtIndex:(int)index
{
return [[kit(core(self)->itemAtIndex(index)) retain] autorelease];
}
@end