OOLogging.m File Reference

import "OOLoggingExtended.h"
import "OOPListParsing.h"
import "OOFunctionAttributes.h"
import "ResourceManager.h"
import "OOCollectionExtractors.h"
import "NSThreadOOExtensions.h"
import "OOLogHeader.h"
import "OOLogOutputHandler.h"

Include dependency graph for OOLogging.m:

Go to the source code of this file.

Classes
struct	OOLogIndentStackElement

Macros
#define	OOLOG_POISON_NSLOG   0
#define	PER_THREAD_INDENTATION   1
#define	USE_INDENT_GLOBALS   0
#define	OOLOG_NOT_INITED   1
#define	OOLOG_SETTING_SET   0
#define	OOLOG_SETTING_RETRIEVE   0
#define	OOLOG_UNDEFINED_METACLASS   1
#define	OOLOG_BAD_SETTING   1
#define	OOLOG_BAD_DEFAULT_SETTING   1
#define	OOLOG_BAD_POP_INDENT   1
#define	OOLOG_EXCEPTION_IN_LOG   1
#define	OOLogInternal(cond, format, ...)
#define	INDENT_LOCK()
#define	INDENT_UNLOCK()
#define	INDENT_FACTOR   2 /* Spaces per indent level */
#define	MAX_INDENT   64 /* Maximum number of indentation _spaces_ */

Typedefs
typedef struct OOLogIndentStackElement	OOLogIndentStackElement

Functions
static void	OOLogInternal_ (const char *inFunction, NSString *inFormat,...)
static void	LoadExplicitSettings (void)
static void	LoadExplicitSettingsFromDictionary (NSDictionary *inDict)
static id	ResolveDisplaySetting (NSString *inMessageClass)
static id	ResolveMetaClassReference (NSString *inMetaClass, NSMutableSet *ioSeenMetaClasses)
OOINLINE unsigned	GetIndentLevel (void) PURE_FUNC
OOINLINE void	SetIndentLevel (unsigned level)
OOINLINE id	CacheValue (BOOL inValue) PURE_FUNC
OOINLINE BOOL	Inited (void)
BOOL	OOLogWillDisplayMessagesInClass (NSString *inMessageClass)
void	OOLogSetDisplayMessagesInClass (NSString *inClass, BOOL inFlag)
NSString *	OOLogGetParentMessageClass (NSString *inClass)
void	OOLogPushIndent (void)
void	OOLogPopIndent (void)
void	OOLogIndent (void)
void	OOLogOutdent (void)
void	OOLogWithPrefix (NSString *inMessageClass, const char *inFunction, const char *inFile, unsigned long inLine, NSString *inPrefix, NSString *inFormat,...)
void	OOLogWithFunctionFileAndLine (NSString *inMessageClass, const char *inFunction, const char *inFile, unsigned long inLine, NSString *inFormat,...)
void	OOLogWithFunctionFileAndLineAndArguments (NSString *inMessageClass, const char *inFunction, const char *inFile, unsigned long inLine, NSString *inFormat, va_list inArguments)
void	OOLogGenericParameterErrorForFunction (const char *inFunction)
void	OOLogGenericSubclassResponsibilityForFunction (const char *inFunction)
BOOL	OOLogShowFunction (void)
void	OOLogSetShowFunction (BOOL flag)
BOOL	OOLogShowFileAndLine (void)
void	OOLogSetShowFileAndLine (BOOL flag)
BOOL	OOLogShowTime (void)
void	OOLogSetShowTime (BOOL flag)
BOOL	OOLogShowMessageClass (void)
void	OOLogSetShowMessageClass (BOOL flag)
void	OOLogSetShowMessageClassTemporary (BOOL flag)
void	OOLoggingInit (void)
void	OOLoggingTerminate (void)
void	OOLoggingReloadSettings (void)
void	OOLogInsertMarker (void)
NSString *	OOLogAbbreviatedFileName (const char *inName)

Variables
static NSString *const	kIndentLevelKey = @"org.aegidian.oolite.oolog.indentLevel"
static NSString *const	kIndentStackKey = @"org.aegidian.oolite.oolog.indentStack"
static BOOL	sInited = NO
static NSLock *	sLock = nil
static NSMutableDictionary *	sExplicitSettings = nil
static NSMutableDictionary *	sDerivedSettingsCache = nil
static BOOL	sShowFunction = NO
static BOOL	sShowFileAndLine = NO
static BOOL	sShowTime = NO
static BOOL	sShowClass = NO
static BOOL	sDefaultDisplay = YES
static BOOL	sOverrideInEffect = NO
static BOOL	sOverrideValue = NO
static NSString *const	kTrueToken = @"on"
static NSString *const	kFalseToken = @"off"
static NSString *const	kInheritToken = @"inherit"
static NSMapTable *	sFileNamesCache = NULL
NSString *const	kOOLogSubclassResponsibility = @"general.error.subclassResponsibility"
NSString *const	kOOLogParameterError = @"general.error.parameterError"
NSString *const	kOOLogDeprecatedMethod = @"general.error.deprecatedMethod"
NSString *const	kOOLogAllocationFailure = @"general.error.allocationFailure"
NSString *const	kOOLogInconsistentState = @"general.error.inconsistentState"
NSString *const	kOOLogException = @"exception"
NSString *const	kOOLogFileNotFound = @"files.notFound"
NSString *const	kOOLogFileNotLoaded = @"files.notLoaded"
NSString *const	kOOLogOpenGLError = @"rendering.opengl.error"
NSString *const	kOOLogUnconvertedNSLog = @"unclassified"

Macro Definition Documentation

INDENT_FACTOR

#define INDENT_FACTOR   2 /* Spaces per indent level */

Referenced by OOLogWithFunctionFileAndLineAndArguments().

INDENT_LOCK

#define INDENT_LOCK

(

)

Value:

do {} while (0)

Definition at line 298 of file OOLogging.m.

Referenced by OOLogIndent(), and OOLogOutdent().

INDENT_UNLOCK

#define INDENT_UNLOCK

(

)

Value:

do {} while (0)

Definition at line 299 of file OOLogging.m.

Referenced by OOLogIndent(), and OOLogOutdent().

MAX_INDENT

#define MAX_INDENT   64 /* Maximum number of indentation _spaces_ */

Referenced by OOLogWithFunctionFileAndLineAndArguments().

OOLOG_BAD_DEFAULT_SETTING

#define OOLOG_BAD_DEFAULT_SETTING   1

Definition at line 67 of file OOLogging.m.

Referenced by LoadExplicitSettings().

OOLOG_BAD_POP_INDENT

#define OOLOG_BAD_POP_INDENT   1

Definition at line 68 of file OOLogging.m.

Referenced by OOLogPopIndent().

OOLOG_BAD_SETTING

#define OOLOG_BAD_SETTING   1

Definition at line 66 of file OOLogging.m.

Referenced by LoadExplicitSettingsFromDictionary(), and ResolveMetaClassReference().

OOLOG_EXCEPTION_IN_LOG

#define OOLOG_EXCEPTION_IN_LOG   1

Definition at line 69 of file OOLogging.m.

Referenced by OOLogWithFunctionFileAndLineAndArguments().

OOLOG_NOT_INITED

#define OOLOG_NOT_INITED   1

Definition at line 62 of file OOLogging.m.

Referenced by Inited().

OOLOG_POISON_NSLOG

#define OOLOG_POISON_NSLOG   0

Definition at line 29 of file OOLogging.m.

OOLOG_SETTING_RETRIEVE

#define OOLOG_SETTING_RETRIEVE   0

Definition at line 64 of file OOLogging.m.

Referenced by OOLogWillDisplayMessagesInClass().

OOLOG_SETTING_SET

#define OOLOG_SETTING_SET   0

Definition at line 63 of file OOLogging.m.

Referenced by LoadExplicitSettings(), and OOLogSetDisplayMessagesInClass().

OOLOG_UNDEFINED_METACLASS

#define OOLOG_UNDEFINED_METACLASS   1

Definition at line 65 of file OOLogging.m.

Referenced by ResolveMetaClassReference().

OOLogInternal

#define OOLogInternal	(		cond,
			format,
			... )

Value:

do { if ((cond)) { OOLogInternal_(OOLOG_FUNCTION_NAME, format, ## __VA_ARGS__); }} while (0)

Definition at line 106 of file OOLogging.m.

Referenced by Inited(), LoadExplicitSettings(), LoadExplicitSettingsFromDictionary(), OOLogPopIndent(), OOLogSetDisplayMessagesInClass(), OOLogWillDisplayMessagesInClass(), OOLogWithFunctionFileAndLineAndArguments(), and ResolveMetaClassReference().

PER_THREAD_INDENTATION

#define PER_THREAD_INDENTATION   1

Definition at line 43 of file OOLogging.m.

USE_INDENT_GLOBALS

#define USE_INDENT_GLOBALS   0

Definition at line 51 of file OOLogging.m.

Typedef Documentation

OOLogIndentStackElement

typedef struct OOLogIndentStackElement OOLogIndentStackElement

Definition at line 73 of file OOLogging.m.

Function Documentation

CacheValue()

OOINLINE id CacheValue

(

BOOL

inValue

)

Definition at line 127 of file OOLogging.m.

{
    return inValue ? kTrueToken : kFalseToken;
}

References kFalseToken, and kTrueToken.

Referenced by LoadExplicitSettingsFromDictionary(), OOLogSetDisplayMessagesInClass(), ResolveDisplaySetting(), and ResolveMetaClassReference().

Here is the caller graph for this function:

GetIndentLevel()

OOINLINE unsigned GetIndentLevel

(

void

)

Definition at line 302 of file OOLogging.m.

{
    NSMutableDictionary *threadDict = [[NSThread currentThread] threadDictionary];
    return [[threadDict objectForKey:kIndentLevelKey] unsignedIntValue];
}

Referenced by OOLogIndent(), OOLogOutdent(), and OOLogWithFunctionFileAndLineAndArguments().

Here is the caller graph for this function:

Inited()

OOINLINE BOOL Inited

(

void

)

Definition at line 136 of file OOLogging.m.

{
    if (EXPECT(sInited)) return YES;
    OOLogInternal(OOLOG_NOT_INITED, @"***** ERROR: OOLoggingInit() has not been called.");
    return NO;
}

References EXPECT, OOLOG_NOT_INITED, OOLogInternal, and sInited.

Referenced by OOLogSetDisplayMessagesInClass(), and OOLogWillDisplayMessagesInClass().

Here is the caller graph for this function:

LoadExplicitSettings()

static void LoadExplicitSettings ( void )

static

Definition at line 705 of file OOLogging.m.

{
    // Load display settings.
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
    sShowFunction = [prefs oo_boolForKey:@"logging-show-function" defaultValue:NO];
    sShowFileAndLine = [prefs oo_boolForKey:@"logging-show-file-and-line" defaultValue:NO];
    sShowTime = [prefs oo_boolForKey:@"logging-show-time" defaultValue:YES];
    sShowClass = [prefs oo_boolForKey:@"logging-show-class" defaultValue:YES];
    
    NSDictionary *oldSettings = sExplicitSettings;
    
    /*
        HACK: we look up search paths while loading settings, which touches
        the cache, which logs stuff. To avoid spam like dataCache.retrieve.success,
        we first load the built-in logcontrol.plist only and use it while
        loading the full settings.
    */
    NSString *path = [[[ResourceManager builtInPath] stringByAppendingPathComponent:@"Config"]
                      stringByAppendingPathComponent:@"logcontrol.plist"];
    sExplicitSettings = [NSMutableDictionary dictionary];
    LoadExplicitSettingsFromDictionary(OODictionaryFromFile(path));
    
    // Release previous sExplicitSettings.
    [oldSettings release];
    
    // Load new settings.
    NSDictionary *settings = [ResourceManager logControlDictionary];
    
    // Replace the old dictionary.
    sExplicitSettings = [[NSMutableDictionary alloc] init];
    
    // Populate.
    LoadExplicitSettingsFromDictionary(settings);
    
    // Get _default and _override values.
    id value = [sExplicitSettings objectForKey:@"_default"];
    if (value != nil && [value respondsToSelector:@selector(boolValue)])
    {
        if (value == kTrueToken) sDefaultDisplay = YES;
        else if (value == kFalseToken) sDefaultDisplay = NO;
        else OOLogInternal(OOLOG_BAD_DEFAULT_SETTING, @"_default may not be set to a metaclass, ignoring.");
        
        [sExplicitSettings removeObjectForKey:@"_default"];
    }
    value = [sExplicitSettings objectForKey:@"_override"];
    if (value != nil && [value respondsToSelector:@selector(boolValue)])
    {
        if (value == kTrueToken)
        {
            sOverrideInEffect = YES;
            sOverrideValue = YES;
        }
        else if (value == kFalseToken)
        {
            sOverrideInEffect = YES;
            sOverrideValue = NO;
        }
        else OOLogInternal(OOLOG_BAD_DEFAULT_SETTING, @"_override may not be set to a metaclass, ignoring.");
        
        [sExplicitSettings removeObjectForKey:@"_override"];
    }
    
    // Invalidate cache.
    DESTROY(sDerivedSettingsCache);
    
    OOLogInternal(OOLOG_SETTING_SET, @"Settings: %@", sExplicitSettings);
}

References ResourceManager::builtInPath, DESTROY, kFalseToken, kTrueToken, LoadExplicitSettingsFromDictionary(), ResourceManager::logControlDictionary, nil, OODictionaryFromFile(), OOLOG_BAD_DEFAULT_SETTING, OOLOG_SETTING_SET, OOLogInternal, sDefaultDisplay, sDerivedSettingsCache, sExplicitSettings, sOverrideInEffect, sOverrideValue, sShowClass, sShowFileAndLine, sShowFunction, and sShowTime.

Referenced by OOLoggingInit(), and OOLoggingReloadSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadExplicitSettingsFromDictionary()

static void LoadExplicitSettingsFromDictionary ( NSDictionary * inDict )

static

Definition at line 777 of file OOLogging.m.

{
    id key = nil;
    foreachkey (key, inDict)
    {
        id value = [inDict objectForKey:key];
        
        /*  Supported values:
            "yes", "true" or "on" -> kTrueToken
            "no", "false" or "off" -> kFalseToken
            "inherit" or "inherited" -> nil
            NSNumber -> kTrueToken or kFalseToken
            "$metaclass" -> "$metaclass"
        */
        if ([value isKindOfClass:[NSString class]])
        {
            if (NSOrderedSame == [value caseInsensitiveCompare:@"yes"] ||
                NSOrderedSame == [value caseInsensitiveCompare:@"true"] ||
                NSOrderedSame == [value caseInsensitiveCompare:@"on"])
            {
                value = kTrueToken;
            }
            else if (NSOrderedSame == [value caseInsensitiveCompare:@"no"] ||
                NSOrderedSame == [value caseInsensitiveCompare:@"false"] ||
                NSOrderedSame == [value caseInsensitiveCompare:@"off"])
            {
                value = kFalseToken;
            }
            else if (NSOrderedSame == [value caseInsensitiveCompare:@"inherit"] ||
                NSOrderedSame == [value caseInsensitiveCompare:@"inherited"])
            {
                value = nil;
                [sExplicitSettings removeObjectForKey:key];
            }
            else if (![value hasPrefix:@"$"])
            {
                OOLogInternal(OOLOG_BAD_SETTING, @"Bad setting value \"%@\" (expected yes, no, inherit or $metaclass).", value);
                value = nil;
            }
        }
        else if ([value respondsToSelector:@selector(boolValue)])
        {
            value = CacheValue([value boolValue]);
        }
        else
        {
            OOLogInternal(OOLOG_BAD_SETTING, @"Bad setting value \"%@\" (expected yes, no, inherit or $metaclass).", value);
            value = nil;
        }
        
        if (value != nil)
        {
            [sExplicitSettings setObject:value forKey:key];
        }
    }
}

References CacheValue(), foreachkey, kFalseToken, kTrueToken, nil, OOLOG_BAD_SETTING, and OOLogInternal.

Referenced by LoadExplicitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogAbbreviatedFileName()

NSString * OOLogAbbreviatedFileName

(

const char *

inName

)

Definition at line 839 of file OOLogging.m.

{
    NSString            *name = nil;
    
    if (EXPECT_NOT(inName == NULL))  return @"unspecified file";
    
    [sLock lock];
    name = NSMapGet(sFileNamesCache, inName);
    if (EXPECT_NOT(name == nil))
    {
        name = [[NSString stringWithUTF8String:inName] lastPathComponent];
        NSMapInsertKnownAbsent(sFileNamesCache, inName, name);
    }
    [sLock unlock];
    
    return name;
}

References EXPECT_NOT, nil, and sFileNamesCache.

Referenced by OOJSStopTimeLimiter_(), and OOJSUnreachable().

Here is the caller graph for this function:

OOLogGenericParameterErrorForFunction()

void OOLogGenericParameterErrorForFunction

(

const char *

inFunction

)

Definition at line 495 of file OOLogging.m.

{
    OOLog(kOOLogParameterError, @"***** %s: bad parameters. (This is an internal programming error, please report it.)", inFunction);
}

References kOOLogParameterError, and OOLog.

OOLogGenericSubclassResponsibilityForFunction()

void OOLogGenericSubclassResponsibilityForFunction

(

const char *

inFunction

)

Definition at line 501 of file OOLogging.m.

{
    OOLog(kOOLogSubclassResponsibility, @"***** %s is a subclass responsibility. (This is an internal programming error, please report it.)", inFunction);
}

References kOOLogSubclassResponsibility, and OOLog.

OOLogGetParentMessageClass()

NSString * OOLogGetParentMessageClass

(

NSString *

inClass

)

Definition at line 207 of file OOLogging.m.

{
    NSRange                 range;
    
    if (inClass == nil) return nil;
    
    range = [inClass rangeOfString:@"." options:NSCaseInsensitiveSearch | NSLiteralSearch | NSBackwardsSearch]; // Only NSBackwardsSearch is important, others are optimizations
    if (range.location == NSNotFound) return nil;
    
    return [inClass substringToIndex:range.location];
}

References nil.

Referenced by ResolveDisplaySetting().

Here is the caller graph for this function:

OOLoggingInit()

void OOLoggingInit

(

void

)

Definition at line 585 of file OOLogging.m.

{
    NSAutoreleasePool       *pool = nil;
    
    if (sInited) return;
    
    pool = [[NSAutoreleasePool alloc] init];
    
    sLock = [[NSLock alloc] init];
    [sLock setName:@"OOLogging lock"];
    if (sLock == nil) exit(EXIT_FAILURE);
    
#ifndef OOLOG_NO_FILE_NAME
    sFileNamesCache = NSCreateMapTable(NSNonOwnedPointerMapKeyCallBacks, NSObjectMapValueCallBacks, 100);
#endif
    
    sInited = YES;  // Must be before OOLogOutputHandlerInit().
    OOLogOutputHandlerInit();
    
    OOPrintLogHeader();
    
    LoadExplicitSettings();
    
    [pool release];
}

References LoadExplicitSettings(), nil, OOLogOutputHandlerInit(), OOPrintLogHeader(), sFileNamesCache, sInited, and sLock.

Referenced by main(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLoggingReloadSettings()

void OOLoggingReloadSettings

(

void

)

Definition at line 626 of file OOLogging.m.

{
    LoadExplicitSettings();
}

References LoadExplicitSettings().

Here is the call graph for this function:

OOLoggingTerminate()

void OOLoggingTerminate

(

void

)

Definition at line 612 of file OOLogging.m.

{
    if (!sInited) return;
    
    OOLogOutputHandlerClose();
    
    /*  We do not set sInited to NO. Instead, the output handler is required
        to be able to handle working even after being closed. Under OS X, this
        is done by writing to stderr in this case; on other platforms, NSLog()
        is used and OOLogOutputHandlerClose() is a no-op.
    */
}

References OOLogOutputHandlerClose(), and sInited.

Here is the call graph for this function:

OOLogIndent()

void OOLogIndent

(

void

)

Definition at line 366 of file OOLogging.m.

{
    INDENT_LOCK();
 
    SetIndentLevel(GetIndentLevel() + 1);
    
    INDENT_UNLOCK();
}

References GetIndentLevel(), INDENT_LOCK, INDENT_UNLOCK, and SetIndentLevel().

Referenced by GLDumpCullingState(), GLDumpFogState(), GLDumpLightState(), GLDumpMaterialState(), GLDumpStateFlags(), LogOpenGLState(), OOCheckOpenGLErrors(), OOJSBeginProfiling(), OOJSProfileEnter(), and VerifyOpenGLStateInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogInsertMarker()

void OOLogInsertMarker

(

void

)

Definition at line 632 of file OOLogging.m.

{
    static unsigned     lastMarkerID = 0;
    unsigned            thisMarkerID;
    NSString            *marker = nil;
    
    [sLock lock];
    thisMarkerID = ++lastMarkerID;
    [sLock unlock];
    
    marker = [NSString stringWithFormat:@"\n\n========== [Marker %u] ==========", thisMarkerID];
    OOLogOutputHandlerPrint(marker);
}

References nil, and OOLogOutputHandlerPrint().

Referenced by ConsoleWriteLogMarker().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogInternal_()

static void OOLogInternal_ ( const char * inFunction, NSString * inFormat, ... )

static

Definition at line 662 of file OOLogging.m.

{
    va_list             args;
    NSString            *formattedMessage = nil;
    NSAutoreleasePool   *pool = nil;
    
    pool = [[NSAutoreleasePool alloc] init];
    
    @try
    {
        va_start(args, inFormat);
        formattedMessage = [[[NSString alloc] initWithFormat:inFormat arguments:args] autorelease];
        va_end(args);
        
        formattedMessage = [NSString stringWithFormat:@"OOLogging internal - %s: %@", inFunction, formattedMessage];
        
        OOLogOutputHandlerPrint(formattedMessage);
    }
    @catch (NSException *exception)
    {
        fprintf(stderr, "***** Exception in OOLogInternal_(): %s : %s", [[exception name] UTF8String], [[exception reason] UTF8String]);
    }
    
    [pool release];
}

References nil, and OOLogOutputHandlerPrint().

Here is the call graph for this function:

OOLogOutdent()

void OOLogOutdent

(

void

)

Definition at line 376 of file OOLogging.m.

{
    INDENT_LOCK();
    
    unsigned indentLevel = GetIndentLevel();
    if (indentLevel != 0)  SetIndentLevel(indentLevel - 1);
    
    INDENT_UNLOCK();
}

References GetIndentLevel(), INDENT_LOCK, INDENT_UNLOCK, and SetIndentLevel().

Referenced by OOTimeProfileEntry(Private)::addSampleWithTotalTime:selfTime:, GLDumpCullingState(), GLDumpFogState(), GLDumpLightState(), GLDumpMaterialState(), GLDumpStateFlags(), LogOpenGLState(), OOCheckOpenGLErrors(), OOJSEndProfiling(), and VerifyOpenGLStateInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogPopIndent()

void OOLogPopIndent

(

void

)

Definition at line 340 of file OOLogging.m.

{
    OOLogIndentStackElement *elem = NULL;
    NSMutableDictionary     *threadDict = nil;
    NSValue                 *val = nil;
    
    threadDict = [[NSThread currentThread] threadDictionary];
    val = [threadDict objectForKey:kIndentStackKey];
    
    elem = [val pointerValue];
    
    if (elem != NULL)
    {
        [threadDict setObject:[NSNumber numberWithUnsignedInt:elem->indent] forKey:kIndentLevelKey];
        [threadDict setObject:[NSValue valueWithPointer:elem->link] forKey:kIndentStackKey];
        free(elem);
    }
    else
    {
        OOLogInternal(OOLOG_BAD_POP_INDENT, @"OOLogPopIndent(): state stack underflow.");
    }
}

References nil, OOLOG_BAD_POP_INDENT, and OOLogInternal.

OOLogPushIndent()

void OOLogPushIndent

(

void

)

Definition at line 316 of file OOLogging.m.

{
    OOLogIndentStackElement *elem = NULL;
    NSMutableDictionary     *threadDict = nil;
    NSValue                 *val = nil;
    
    elem = malloc(sizeof *elem);
    if (elem != NULL)
    {
        threadDict = [[NSThread currentThread] threadDictionary];
        val = [threadDict objectForKey:kIndentStackKey];
        
        elem->indent = [[threadDict objectForKey:kIndentLevelKey] intValue];
        elem->link = [val pointerValue];
        
        /*
            Clang static analyzer reports elem not released here. It is in fact
            released in OOLogPopIndent().
        */
        [threadDict setObject:[NSValue valueWithPointer:elem] forKey:kIndentStackKey];
    }
}

References OOLogIndentStackElement::indent, OOLogIndentStackElement::link, and nil.

OOLogSetDisplayMessagesInClass()

void OOLogSetDisplayMessagesInClass	(	NSString *	inClass,
		BOOL	inFlag )

Definition at line 182 of file OOLogging.m.

{
    id              value = nil;
    
    if (!Inited()) return;
    
    [sLock lock];
    value = [sExplicitSettings objectForKey:inClass];
    if (value == nil || value != CacheValue(inFlag))
    {
        OOLogInternal(OOLOG_SETTING_SET, @"Setting %@ to %s", inClass, inFlag ? "ON" : "OFF");
        
        [sExplicitSettings setObject:CacheValue(inFlag) forKey:inClass];
        
        // Clear cache and let it be rebuilt as needed.
        DESTROY(sDerivedSettingsCache);
    }
    else
    {
        OOLogInternal(OOLOG_SETTING_SET, @"Keeping %@ %s", inClass, inFlag ? "ON" : "OFF");
    }
    [sLock unlock];
}

References CacheValue(), DESTROY, Inited(), nil, OOLOG_SETTING_SET, OOLogInternal, and sDerivedSettingsCache.

Referenced by ConsoleSetDisplayMessagesInClass().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogSetShowFileAndLine()

void OOLogSetShowFileAndLine

(

BOOL

flag

)

Definition at line 531 of file OOLogging.m.

{
    flag = !!flag;  // YES or NO, not 42.
    
    if (flag != sShowFileAndLine)
    {
        sShowFileAndLine = flag;
        [[NSUserDefaults standardUserDefaults] setBool:flag forKey:@"logging-show-file-and-line"];
    }
}

References sShowFileAndLine.

OOLogSetShowFunction()

void OOLogSetShowFunction

(

BOOL

flag

)

Definition at line 513 of file OOLogging.m.

{
    flag = !!flag;  // YES or NO, not 42.
    
    if (flag != sShowFunction)
    {
        sShowFunction = flag;
        [[NSUserDefaults standardUserDefaults] setBool:flag forKey:@"logging-show-function"];
    }
}

References sShowFunction.

OOLogSetShowMessageClass()

void OOLogSetShowMessageClass

(

BOOL

flag

)

Definition at line 567 of file OOLogging.m.

{
    flag = !!flag;  // YES or NO, not 42.
    
    if (flag != sShowClass)
    {
        sShowClass = flag;
        [[NSUserDefaults standardUserDefaults] setBool:flag forKey:@"logging-show-class"];
    }
}

References sShowClass.

OOLogSetShowMessageClassTemporary()

void OOLogSetShowMessageClassTemporary

(

BOOL

flag

)

Definition at line 579 of file OOLogging.m.

{
    sShowClass = !!flag;    // YES or NO, not 42.
}

References sShowClass.

OOLogSetShowTime()

void OOLogSetShowTime

(

BOOL

flag

)

Definition at line 549 of file OOLogging.m.

{
    flag = !!flag;  // YES or NO, not 42.
    
    if (flag != sShowTime)
    {
        sShowTime = flag;
        [[NSUserDefaults standardUserDefaults] setBool:flag forKey:@"logging-show-time"];
    }
}

References sShowTime.

OOLogShowFileAndLine()

BOOL OOLogShowFileAndLine

(

void

)

Definition at line 525 of file OOLogging.m.

{
    return sShowFileAndLine;
}

References sShowFileAndLine.

OOLogShowFunction()

BOOL OOLogShowFunction

(

void

)

Definition at line 507 of file OOLogging.m.

{
    return sShowFunction;
}

References sShowFunction.

OOLogShowMessageClass()

BOOL OOLogShowMessageClass

(

void

)

Definition at line 561 of file OOLogging.m.

{
    return sShowClass;
}

References sShowClass.

OOLogShowTime()

BOOL OOLogShowTime

(

void

)

Definition at line 543 of file OOLogging.m.

{
    return sShowTime;
}

References sShowTime.

OOLogWillDisplayMessagesInClass()

BOOL OOLogWillDisplayMessagesInClass

(

NSString *

inMessageClass

)

Definition at line 144 of file OOLogging.m.

{
    id              value = nil;
    
    if (!Inited()) return NO;
    
    if (sOverrideInEffect)  return sOverrideValue;
    
    [sLock lock];
    
    // Look for cached value
    value = [sDerivedSettingsCache objectForKey:inMessageClass];
    if (EXPECT_NOT(value == nil))
    {
        @try
        {
            // No cached value.
            value = ResolveDisplaySetting(inMessageClass);
            
            if (value != nil)
            {
                if (EXPECT_NOT(sDerivedSettingsCache == nil)) sDerivedSettingsCache = [[NSMutableDictionary alloc] init];
                [sDerivedSettingsCache setObject:value forKey:inMessageClass];
            }
        }
        @catch (id exception)
        {
            [sLock unlock];
            @throw exception;
        }
    }
    [sLock unlock];
    
    OOLogInternal(OOLOG_SETTING_RETRIEVE, @"%@ is %s", inMessageClass, (value == kTrueToken) ? "on" : "off");
    return value == kTrueToken;
}

References EXPECT_NOT, Inited(), kTrueToken, nil, OOLOG_SETTING_RETRIEVE, OOLogInternal, ResolveDisplaySetting(), sDerivedSettingsCache, sOverrideInEffect, and sOverrideValue.

Referenced by ConsoleDisplayMessagesInClass(), GlobalLog(), LogOpenGLState(), OOCheckOpenGLErrors(), OOLogWithFunctionFileAndLineAndArguments(), OOLogWithPrefix(), OONSLogCStringFunction(), ReportJSError(), SyntaxIssue(), and VerifyOpenGLStateInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogWithFunctionFileAndLine()

void OOLogWithFunctionFileAndLine	(	NSString *	inMessageClass,
		const char *	inFunction,
		const char *	inFile,
		unsigned long	inLine,
		NSString *	inFormat,
			... )

Definition at line 397 of file OOLogging.m.

{
    va_list             args;
    
    va_start(args, inFormat);
    OOLogWithFunctionFileAndLineAndArguments(inMessageClass, inFunction, inFile, inLine, inFormat, args);
    va_end(args);
}

References OOLogWithFunctionFileAndLineAndArguments().

Here is the call graph for this function:

OOLogWithFunctionFileAndLineAndArguments()

void OOLogWithFunctionFileAndLineAndArguments	(	NSString *	inMessageClass,
		const char *	inFunction,
		const char *	inFile,
		unsigned long	inLine,
		NSString *	inFormat,
		va_list	inArguments )

Definition at line 407 of file OOLogging.m.

{
    NSAutoreleasePool   *pool = nil;
    NSString            *formattedMessage = nil;
    unsigned            indentLevel;
    
    if (inFormat == nil)  return;
    
#if !OOLOG_SHORT_CIRCUIT
    if (!OOLogWillDisplayMessagesInClass(inMessageClass))  return;
#endif
    
    pool = [[NSAutoreleasePool alloc] init];
    @try
    {
        // Do argument substitution
        formattedMessage = [[[NSString alloc] initWithFormat:inFormat arguments:inArguments] autorelease];
        
        // Apply various prefix options
    #ifndef OOLOG_NO_FILE_NAME
        if (sShowFileAndLine && inFile != NULL)
        {
            if (sShowFunction)
            {
                formattedMessage = [NSString stringWithFormat:@"%s (%@:%lu): %@", inFunction, OOLogAbbreviatedFileName(inFile), inLine, formattedMessage];
            }
            else
            {
                formattedMessage = [NSString stringWithFormat:@"%@:%lu: %@", OOLogAbbreviatedFileName(inFile), inLine, formattedMessage];
            }
        }
        else
    #endif
        {
            if (sShowFunction)
            {
                formattedMessage = [NSString stringWithFormat:@"%s: %@", inFunction, formattedMessage];
            }
        }
        
        if (sShowClass)
        {
            if (sShowFunction || sShowFileAndLine)
            {
                formattedMessage = [NSString stringWithFormat:@"[%@] %@", inMessageClass, formattedMessage];
            }
            else
            {
                formattedMessage = [NSString stringWithFormat:@"[%@]: %@", inMessageClass, formattedMessage];
            }
        }
        
        if (sShowTime)
        {
            formattedMessage = [NSString stringWithFormat:@"%@ %@", [[NSDate date] descriptionWithCalendarFormat:@"%H:%M:%S.%F" timeZone:nil locale:nil], formattedMessage];
        }
        
        // Apply indentation
        indentLevel = GetIndentLevel();
        if (indentLevel != 0)
        {
            #define INDENT_FACTOR   2       /* Spaces per indent level */
            #define MAX_INDENT      64      /* Maximum number of indentation _spaces_ */
            
            unsigned            indent;
                                // String of 64 spaces (null-terminated)
            const char          spaces[MAX_INDENT + 1] =
                                "                                                                ";
            const char          *indentString;
            
            indent = INDENT_FACTOR * indentLevel;
            if (MAX_INDENT < indent) indent = MAX_INDENT;
            indentString = &spaces[MAX_INDENT - indent];
            
            formattedMessage = [NSString stringWithFormat:@"%s%@", indentString, formattedMessage];
        }
        
        OOLogOutputHandlerPrint(formattedMessage);
    }
    @catch (NSException *exception)
    {
        OOLogInternal(OOLOG_EXCEPTION_IN_LOG, @"***** Exception thrown during logging: %@ : %@", [exception name], [exception reason]);
    }
    
    [pool release];
}

References GetIndentLevel(), OOLogIndentStackElement::indent, INDENT_FACTOR, MAX_INDENT, nil, OOLOG_EXCEPTION_IN_LOG, OOLogInternal, OOLogOutputHandlerPrint(), OOLogWillDisplayMessagesInClass(), sShowClass, sShowFileAndLine, sShowFunction, and sShowTime.

Referenced by OOLogWithFunctionFileAndLine(), and OOLogWithPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogWithPrefix()

void OOLogWithPrefix	(	NSString *	inMessageClass,
		const char *	inFunction,
		const char *	inFile,
		unsigned long	inLine,
		NSString *	inPrefix,
		NSString *	inFormat,
			... )

Definition at line 387 of file OOLogging.m.

{
    if (!OOLogWillDisplayMessagesInClass(inMessageClass)) return;
    va_list             args;
    va_start(args, inFormat);
    OOLogWithFunctionFileAndLineAndArguments(inMessageClass, inFunction, inFile, inLine, [inPrefix stringByAppendingString:inFormat], args);
    va_end(args);
}

References OOLogWillDisplayMessagesInClass(), and OOLogWithFunctionFileAndLineAndArguments().

Here is the call graph for this function:

ResolveDisplaySetting()

static id ResolveDisplaySetting ( NSString * inMessageClass )

static

Definition at line 861 of file OOLogging.m.

{
    id                  value = nil;
    NSMutableSet        *seenMetaClasses = nil;
    
    if (inMessageClass == nil) return CacheValue(sDefaultDisplay);
    
    value = [sExplicitSettings objectForKey:inMessageClass];
    
    // Simple case: explicit setting for this value
    if (value == kTrueToken || value == kFalseToken) return value;
    
    // Simplish case: use inherited value
    if (value == nil || value == kInheritToken) return ResolveDisplaySetting(OOLogGetParentMessageClass(inMessageClass));
    
    // Less simple case: should be a metaclass.
    seenMetaClasses = [NSMutableSet set];
    return ResolveMetaClassReference(value, seenMetaClasses);
}

References CacheValue(), kFalseToken, kInheritToken, kTrueToken, nil, OOLogGetParentMessageClass(), ResolveDisplaySetting(), ResolveMetaClassReference(), and sDefaultDisplay.

Referenced by OOLogWillDisplayMessagesInClass(), and ResolveDisplaySetting().

Here is the call graph for this function:

Here is the caller graph for this function:

ResolveMetaClassReference()

static id ResolveMetaClassReference ( NSString * inMetaClass, NSMutableSet * ioSeenMetaClasses )

static

Definition at line 885 of file OOLogging.m.

{
    id                  value = nil;
    
    // All values should have been checked at load time, but what the hey.
    if (![inMetaClass isKindOfClass:[NSString class]] || ![inMetaClass hasPrefix:@"$"])
    {
        OOLogInternal(OOLOG_BAD_SETTING, @"Bad setting value \"%@\" (expected yes, no, inherit or $metaclass). Falling back to _default.", inMetaClass);
        return CacheValue(sDefaultDisplay);
    }
    
    [ioSeenMetaClasses addObject:inMetaClass];
    
    value = [sExplicitSettings objectForKey:inMetaClass];
    
    if (value == kTrueToken || value == kFalseToken) return value;
    if (value == nil)
    {
        OOLogInternal(OOLOG_UNDEFINED_METACLASS, @"Reference to undefined metaclass %@, falling back to _default.", inMetaClass);
        return CacheValue(sDefaultDisplay);
    }
    
    // If we get here, it should be a metaclass reference.
    return ResolveMetaClassReference(value, ioSeenMetaClasses);
}

References CacheValue(), kFalseToken, kTrueToken, nil, OOLOG_BAD_SETTING, OOLOG_UNDEFINED_METACLASS, OOLogInternal, ResolveMetaClassReference(), and sDefaultDisplay.

Referenced by ResolveDisplaySetting(), and ResolveMetaClassReference().

Here is the call graph for this function:

Here is the caller graph for this function:

SetIndentLevel()

OOINLINE void SetIndentLevel

(

unsigned

level

)

Definition at line 309 of file OOLogging.m.

{
    NSMutableDictionary *threadDict = [[NSThread currentThread] threadDictionary];
    [threadDict setObject:[NSNumber numberWithUnsignedInt:value] forKey:kIndentLevelKey];
}

Referenced by OOLogIndent(), and OOLogOutdent().

Here is the caller graph for this function:

Variable Documentation

kFalseToken

NSString* const kFalseToken = @"off"

static

Definition at line 101 of file OOLogging.m.

Referenced by CacheValue(), LoadExplicitSettings(), LoadExplicitSettingsFromDictionary(), ResolveDisplaySetting(), and ResolveMetaClassReference().

kIndentLevelKey

NSString* const kIndentLevelKey = @"org.aegidian.oolite.oolog.indentLevel"

static

Definition at line 52 of file OOLogging.m.

kIndentStackKey

NSString* const kIndentStackKey = @"org.aegidian.oolite.oolog.indentStack"

static

Definition at line 53 of file OOLogging.m.

kInheritToken

NSString* const kInheritToken = @"inherit"

static

Definition at line 102 of file OOLogging.m.

Referenced by ResolveDisplaySetting().

kOOLogAllocationFailure

NSString* const kOOLogAllocationFailure = @"general.error.allocationFailure"

Definition at line 649 of file OOLogging.m.

Referenced by OOMeshToOctreeConverter::addTriangle:.

kOOLogDeprecatedMethod

NSString* const kOOLogDeprecatedMethod = @"general.error.deprecatedMethod"

Definition at line 648 of file OOLogging.m.

kOOLogException

NSString* const kOOLogException = @"exception"

Definition at line 651 of file OOLogging.m.

Referenced by AI::clearAllData, main(), MissionRunCallback(), and OOJSDumpStack().

kOOLogFileNotFound

NSString* const kOOLogFileNotFound = @"files.notFound"

Definition at line 652 of file OOLogging.m.

kOOLogFileNotLoaded

NSString* const kOOLogFileNotLoaded = @"files.notLoaded"

Definition at line 653 of file OOLogging.m.

kOOLogInconsistentState

NSString* const kOOLogInconsistentState = @"general.error.inconsistentState"

Definition at line 650 of file OOLogging.m.

kOOLogOpenGLError

NSString* const kOOLogOpenGLError = @"rendering.opengl.error"

Definition at line 654 of file OOLogging.m.

Referenced by OOCheckOpenGLErrors().

kOOLogParameterError

NSString* const kOOLogParameterError = @"general.error.parameterError"

Definition at line 647 of file OOLogging.m.

Referenced by OOConcreteTexture::apply, OOGenerateMipMaps(), OOInterpretTextureSpecifier(), and OOLogGenericParameterErrorForFunction().

kOOLogSubclassResponsibility

NSString* const kOOLogSubclassResponsibility = @"general.error.subclassResponsibility"

Definition at line 646 of file OOLogging.m.

Referenced by OOLogGenericSubclassResponsibilityForFunction().

kOOLogUnconvertedNSLog

NSString* const kOOLogUnconvertedNSLog = @"unclassified"

Definition at line 655 of file OOLogging.m.

kTrueToken

NSString* const kTrueToken = @"on"

static

Definition at line 100 of file OOLogging.m.

Referenced by CacheValue(), LoadExplicitSettings(), LoadExplicitSettingsFromDictionary(), OOLogWillDisplayMessagesInClass(), ResolveDisplaySetting(), and ResolveMetaClassReference().

sDefaultDisplay

BOOL sDefaultDisplay = YES

static

Definition at line 95 of file OOLogging.m.

Referenced by LoadExplicitSettings(), ResolveDisplaySetting(), and ResolveMetaClassReference().

sDerivedSettingsCache

NSMutableDictionary* sDerivedSettingsCache = nil

static

Definition at line 85 of file OOLogging.m.

Referenced by LoadExplicitSettings(), OOLogSetDisplayMessagesInClass(), and OOLogWillDisplayMessagesInClass().

sExplicitSettings

NSMutableDictionary* sExplicitSettings = nil

static

Definition at line 84 of file OOLogging.m.

Referenced by LoadExplicitSettings().

sFileNamesCache

NSMapTable* sFileNamesCache = NULL

static

Definition at line 121 of file OOLogging.m.

Referenced by OOLogAbbreviatedFileName(), and OOLoggingInit().

sInited

BOOL sInited = NO

static

Definition at line 82 of file OOLogging.m.

Referenced by Inited(), OOLoggingInit(), and OOLoggingTerminate().

sLock

NSLock* sLock = nil

static

Definition at line 83 of file OOLogging.m.

Referenced by OOLoggingInit().

sOverrideInEffect

BOOL sOverrideInEffect = NO

static

Definition at line 96 of file OOLogging.m.

Referenced by LoadExplicitSettings(), and OOLogWillDisplayMessagesInClass().

sOverrideValue

BOOL sOverrideValue = NO

static

Definition at line 97 of file OOLogging.m.

Referenced by LoadExplicitSettings(), and OOLogWillDisplayMessagesInClass().

sShowClass

BOOL sShowClass = NO

static

Definition at line 94 of file OOLogging.m.

Referenced by LoadExplicitSettings(), OOLogSetShowMessageClass(), OOLogSetShowMessageClassTemporary(), OOLogShowMessageClass(), and OOLogWithFunctionFileAndLineAndArguments().

sShowFileAndLine

BOOL sShowFileAndLine = NO

static

Definition at line 92 of file OOLogging.m.

Referenced by LoadExplicitSettings(), OOLogSetShowFileAndLine(), OOLogShowFileAndLine(), and OOLogWithFunctionFileAndLineAndArguments().

sShowFunction

BOOL sShowFunction = NO

static

Definition at line 91 of file OOLogging.m.

Referenced by LoadExplicitSettings(), OOLogSetShowFunction(), OOLogShowFunction(), and OOLogWithFunctionFileAndLineAndArguments().

sShowTime

BOOL sShowTime = NO

static

Definition at line 93 of file OOLogging.m.

Referenced by LoadExplicitSettings(), OOLogSetShowTime(), OOLogShowTime(), and OOLogWithFunctionFileAndLineAndArguments().