OOCache Class Reference

#include <OOCache.h>

Inheritance diagram for OOCache:

Collaboration diagram for OOCache:

Instance Methods
(id)	- init
(id)	- initWithPList:
(id)	- pListRepresentation
(id)	- objectForKey:
(void)	- setObject:forKey:
(void)	- removeObjectForKey:
(void)	- setPruneThreshold:
(unsigned)	- pruneThreshold
(void)	- setAutoPrune:
(BOOL)	- autoPrune
(void)	- prune
(BOOL)	- dirty
(void)	- markClean
(NSString *)	- name
(void)	- setName:
(NSArray *)	- objectsByAge
(void)	- dealloc [implementation]
(NSString *)	- description [implementation]
(void)	- loadFromArray: [implementation]

Private Attributes
struct OOCacheImpl *	cache
unsigned	pruneThreshold
BOOL	autoPrune
BOOL	dirty

Detailed Description

Definition at line 57 of file OOCache.h.

Method Documentation

autoPrune

- (BOOL) autoPrune

References autoPrune, and prune.

Here is the call graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 197 of file OOCache.m.

{
    CHECK_INTEGRITY(@"dealloc");
    CacheFree(cache);
    
    [super dealloc];
}

References cache, CacheFree(), CHECK_INTEGRITY, and dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

description

- (NSString *) description

implementation

Definition at line 206 of file OOCache.m.

{
    return [NSString stringWithFormat:@"<%@ %p>{\"%@\", %u elements, prune threshold=%u, auto-prune=%s dirty=%s}", [self class], self, [self name], CacheGetCount(cache), pruneThreshold, autoPrune ? "yes" : "no", dirty ? "yes" : "no"];
}

References description, and name.

Referenced by description.

Here is the call graph for this function:

Here is the caller graph for this function:

dirty

- (BOOL) dirty

References dirty, markClean, name, and objectsByAge.

Here is the call graph for this function:

init

- (id) init

Definition at line 212 of file OOCache.m.

{
    return [self initWithPList:nil];
}

References init, and initWithPList:.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithPList:

- (id) initWithPList:

(id)

pList

Definition at line 218 of file OOCache.m.

                   :(id)pList
{
    BOOL                    OK = YES;
    
    self = [super init];
    OK = self != nil;
    
    if (OK)
    {
        cache = CacheAllocate();
        if (cache == NULL) OK = NO;
    }
    
    if (pList != nil)
    {
        if (OK) OK = [pList isKindOfClass:[NSArray class]];
        if (OK) [self loadFromArray:pList];
    }
    if (OK)
    {
        pruneThreshold = kOOCacheDefaultPruneThreshold;
        autoPrune = YES;
    }
    
    if (!OK)
    {
        [self release];
        self = nil;
    }
    
    return self;
}

References autoPrune, cache, CacheAllocate(), kOOCacheDefaultPruneThreshold, loadFromArray:, nil, and pruneThreshold.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromArray:

- (void) loadFromArray: (NSArray *) inArray

implementation

Provided by category OOCache(Private).

Definition at line 391 of file OOCache.m.

                     :(NSArray *)array
{
    NSEnumerator            *entryEnum = nil;
    NSDictionary            *entry = nil;
    NSString                *key = nil;
    id                      value = nil;
    
    if (array == nil) return;
    
    for (entryEnum = [array objectEnumerator]; (entry = [entryEnum nextObject]); )
    {
        if ([entry isKindOfClass:[NSDictionary class]])
        {
            key = [entry objectForKey:kSerializedEntryKeyKey];
            value = [entry objectForKey:kSerializedEntryKeyValue];
            if ([key isKindOfClass:[NSString class]] && value != nil)
            {
                [self setObject:value forKey:key];
            }
        }
    }
}

Referenced by initWithPList:.

Here is the caller graph for this function:

markClean

- (void) markClean

Definition at line 363 of file OOCache.m.

{
    dirty = NO;
}

References dirty, and markClean.

Referenced by dirty, and markClean.

Here is the call graph for this function:

Here is the caller graph for this function:

name

- (NSString *) name

Definition at line 369 of file OOCache.m.

{
    return CacheGetName(cache);
}

References cache, CacheGetName(), and name.

Referenced by description, dirty, name, and setName:.

Here is the call graph for this function:

Here is the caller graph for this function:

objectForKey:

- (id) objectForKey:

(id)

key

Definition at line 260 of file OOCache.m.

                  :(id)key
{
    id                      result = nil;
    
    CHECK_INTEGRITY(@"objectForKey: before");
    
    result = CacheRetrieve(cache, key);
    // Note: while reordering the age list technically makes the cache dirty, it's not worth rewriting it just for that, so we don't flag it.
    
    CHECK_INTEGRITY(@"objectForKey: after");
    
    return [[result retain] autorelease];
}

References cache, CacheRetrieve(), CHECK_INTEGRITY, and nil.

Referenced by OOEncodingConverter::convertString:.

Here is the call graph for this function:

Here is the caller graph for this function:

objectsByAge

- (NSArray *) objectsByAge

Definition at line 381 of file OOCache.m.

{
    return CacheArrayOfContentsByAge(cache);
}

References cache, CacheArrayOfContentsByAge(), and objectsByAge.

Referenced by OOTexture::cachedTexturesByAge, dirty, and objectsByAge.

Here is the call graph for this function:

Here is the caller graph for this function:

pListRepresentation

- (id) pListRepresentation

Definition at line 252 of file OOCache.m.

{
    return CacheArrayOfNodesByAge(cache);
    
    return nil;
}

References cache, CacheArrayOfNodesByAge(), nil, and pListRepresentation.

Referenced by pListRepresentation.

Here is the call graph for this function:

Here is the caller graph for this function:

prune

- (void) prune

Definition at line 333 of file OOCache.m.

{
    unsigned                pruneCount;
    unsigned                desiredCount;
    unsigned                count;
    
    // Order of operations is to ensure rounding down.
    if (autoPrune)  desiredCount = (pruneThreshold * 4) / 5;
    else  desiredCount = pruneThreshold;
    
    if (pruneThreshold == kOOCacheNoPrune || (count = CacheGetCount(cache)) <= pruneThreshold)  return;
    
    pruneCount = count - desiredCount;
    
    NSString *logKey = [NSString stringWithFormat:@"dataCache.prune.%@", CacheGetName(cache)];
    OOLog(logKey, @"Pruning cache \"%@\" - removing %u entries", CacheGetName(cache), pruneCount);
    OOLogIndentIf(logKey);
    
    while (pruneCount--)  CacheRemoveOldest(cache, logKey);
    
    OOLogOutdentIf(logKey);
}

References autoPrune, cache, CacheGetCount(), CacheGetName(), CacheRemoveOldest(), count, kOOCacheNoPrune, OOLog, OOLogIndentIf, OOLogOutdentIf, prune, and pruneThreshold.

Referenced by autoPrune, prune, setAutoPrune:, setObject:forKey:, and setPruneThreshold:.

Here is the call graph for this function:

Here is the caller graph for this function:

pruneThreshold

- (unsigned) pruneThreshold

References pruneThreshold.

removeObjectForKey:

- (void) removeObjectForKey:

(id)

key

Definition at line 289 of file OOCache.m.

                          :(id)key
{
    CHECK_INTEGRITY(@"removeObjectForKey: before");
    
    if (CacheRemove(cache, key)) dirty = YES;
    
    CHECK_INTEGRITY(@"removeObjectForKey: after");
}

References cache, CacheRemove(), CHECK_INTEGRITY, and dirty.

Referenced by OOTexture(SubclassInterface)::removeFromCaches.

Here is the call graph for this function:

Here is the caller graph for this function:

setAutoPrune:

- (void) setAutoPrune:

(BOOL)

flag

Definition at line 316 of file OOCache.m.

                    :(BOOL)flag
{
    BOOL prune = (flag != NO);
    if (prune != autoPrune)
    {
        autoPrune = prune;
        [self prune];
    }
}

References autoPrune, and prune.

Referenced by OOTexture(OOPrivate)::addToCaches.

Here is the call graph for this function:

Here is the caller graph for this function:

setName:

- (void) setName:

(NSString *)

name

Definition at line 375 of file OOCache.m.

               :(NSString *)name
{
    CacheSetName(cache, name);
}

References cache, CacheSetName(), and name.

Referenced by OOTexture(OOPrivate)::addToCaches, and OOEncodingConverter::initWithEncoding:substitutions:.

Here is the call graph for this function:

Here is the caller graph for this function:

setObject:forKey:

- (void) setObject:		(id)	value
forKey:		(id)	key

Definition at line 275 of file OOCache.m.

                 :inObject forKey:(id)key
{
    CHECK_INTEGRITY(@"setObject:forKey: before");
    
    if (CacheInsert(cache, key, inObject))
    {
        dirty = YES;
        if (autoPrune)  [self prune];
    }
    
    CHECK_INTEGRITY(@"setObject:forKey: after");
}

References autoPrune, cache, CacheInsert(), CHECK_INTEGRITY, dirty, and prune.

Referenced by OOTexture(OOPrivate)::addToCaches, PlayerEntity::commanderDataDictionary, OOEncodingConverter::convertString:, OOShipRegistry(OODataLoader)::loadCachedRoleProbabilitySets, and OOCache(Private)::loadFromArray:.

Here is the call graph for this function:

Here is the caller graph for this function:

setPruneThreshold:

- (void) setPruneThreshold:

(unsigned)

threshold

Definition at line 299 of file OOCache.m.

                         :(unsigned)threshold
{
    threshold = MAX(threshold, (unsigned)kOOCacheMinimumPruneThreshold);
    if (threshold != pruneThreshold)
    {
        pruneThreshold = threshold;
        if (autoPrune)  [self prune];
    }
}

References autoPrune, kOOCacheMinimumPruneThreshold, MAX, prune, and pruneThreshold.

Referenced by OOTexture(OOPrivate)::addToCaches, and OOEncodingConverter::initWithEncoding:substitutions:.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

autoPrune

- (BOOL) autoPrune

private

Definition at line 327 of file OOCache.m.

{
    return autoPrune;
}

Referenced by autoPrune, initWithPList:, prune, setAutoPrune:, setObject:forKey:, and setPruneThreshold:.

cache

- (struct OOCacheImpl*) cache

private

Definition at line 60 of file OOCache.h.

Referenced by dealloc, initWithPList:, name, objectForKey:, objectsByAge, pListRepresentation, prune, removeObjectForKey:, setName:, and setObject:forKey:.

dirty

- (BOOL) dirty

private

Definition at line 357 of file OOCache.m.

{
    return dirty;
}

Referenced by dirty, markClean, removeObjectForKey:, and setObject:forKey:.

pruneThreshold

- (unsigned) pruneThreshold

private

Definition at line 310 of file OOCache.m.

{
    return pruneThreshold;
}

Referenced by initWithPList:, prune, pruneThreshold, and setPruneThreshold:.

---

The documentation for this class was generated from the following files:

• src/Core/OOCache.h
• src/Core/OOCache.m