import <Foundation/Foundation.h>

Include dependency graph for OOLogOutputHandler.h:

This graph shows which files directly or indirectly include this file:

Functions
void	OOLogOutputHandlerInit (void)

void	OOLogOutputHandlerClose (void)

void	OOLogOutputHandlerPrint (NSString *string)

NSString *	OOLogHandlerGetLogPath (void)

NSString *	OOLogHandlerGetLogBasePath (void)

void	OOLogOutputHandlerChangeLogFile (NSString *newLogName)

void	OOLogOutputHandlerStartLoggingToStdout (void)

void	OOLogOutputHandlerStopLoggingToStdout (void)

Function Documentation

◆ OOLogHandlerGetLogBasePath()

NSString * OOLogHandlerGetLogBasePath ( void )

Definition at line 608 of file OOLogOutputHandler.m.

{
    static NSString     *basePath = nil;
 
    if (basePath == nil)
    {
        const char *logdirEnv = SDL_getenv("OO_LOGSDIR");
 
        if (logdirEnv)
        {
            basePath = [NSString stringWithUTF8String:logdirEnv];
        }
        else
        {
#if OOLITE_MAC_OS_X
            // ~/Library
            basePath = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex:0];
#elif OOLITE_LINUX
            // ~
            basePath = NSHomeDirectory();
 
            // ~/.Oolite
            basePath = [basePath stringByAppendingPathComponent:@".Oolite"];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
#elif OOLITE_WINDOWS
            // <Install path>\Oolite
            basePath = NSHomeDirectory();
#endif
 
            // .../Logs
            basePath = [basePath stringByAppendingPathComponent:@"Logs"];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
 
#if OOLITE_MAC_OS_X
            // ~/Library/Logs/Oolite
            basePath = [basePath stringByAppendingPathComponent:GetAppName()];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
#endif
        }
#if OOLITE_MAC_OS_X
        ExcludeFromTimeMachine(basePath);
#endif
        [basePath retain];
    }
 
    return basePath;
}

References DirectoryExistCreatingIfNecessary(), ExcludeFromTimeMachine(), and nil.

Here is the call graph for this function:

◆ OOLogHandlerGetLogPath()

NSString * OOLogHandlerGetLogPath ( void )

Definition at line 221 of file OOLogOutputHandler.m.

{
    return [OOLogHandlerGetLogBasePath() stringByAppendingPathComponent:sLogFileName];  
}

Referenced by OOOXPVerifier(OOPrivate)::buildDependencyGraph.

Here is the caller graph for this function:

◆ OOLogOutputHandlerChangeLogFile()

void OOLogOutputHandlerChangeLogFile ( NSString * newLogName )

Definition at line 227 of file OOLogOutputHandler.m.

{
    if (![sLogFileName isEqual:newLogName])
    {
        sLogFileName = [newLogName copy];
        [sLogger changeFile];
    }
}

References OOAsyncLogger::changeFile, and sLogFileName.

Referenced by SwitchLogFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OOLogOutputHandlerClose()

void OOLogOutputHandlerClose ( void )

Definition at line 162 of file OOLogOutputHandler.m.

{
    if (sInited)
    {
        sWriteToStderr = YES;
        sInited = NO;
        
        [sLogger endLogging];
        DESTROY(sLogger);
        
#if OOLITE_MAC_OS_X
        if (sDefaultLogCStringFunction != NULL && _NSSetLogCStringFunction != NULL)
        {
            _NSSetLogCStringFunction(sDefaultLogCStringFunction);
            sDefaultLogCStringFunction = NULL;
        }
#elif GNUSTEP_BASE_LIBRARY
        NSRecursiveLock *lock = GSLogLock();
        [lock lock];
        _NSLog_printf_handler = NULL;
        [lock unlock];
#endif
    }
}

References _NSSetLogCStringFunction, DESTROY, OOAsyncLogger::endLogging, sDefaultLogCStringFunction, sInited, sLogger, and sWriteToStderr.

Referenced by OOLoggingTerminate(), and OOLogOutputHandlerInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OOLogOutputHandlerInit()

void OOLogOutputHandlerInit ( void )

Definition at line 120 of file OOLogOutputHandler.m.

{
    if (sInited)  return;
    
#if SET_CRASH_REPORTER_INFO
    InitCrashReporterInfo();
#endif
    
    sLogger = [[OOAsyncLogger alloc] init];
    sInited = YES;
    
    if (sLogger != nil)
    {
        sWriteToStderr = [[NSUserDefaults standardUserDefaults] boolForKey:@"logging-echo-to-stderr"];
    }
    else
    {
        sWriteToStderr = YES;
    }
    
#if OOLITE_MAC_OS_X
    LoadLogCStringFunctions();
    if (_NSSetLogCStringFunction != NULL)
    {
        sDefaultLogCStringFunction = _NSLogCStringFunction();
        _NSSetLogCStringFunction(OONSLogCStringFunction);
    }
    else
    {
        OOLog(@"logging.nsLogFilter.install.failed", @"Failed to install NSLog() filter; system messages will not be logged in log file.");
    }
#elif GNUSTEP_BASE_LIBRARY
    NSRecursiveLock *lock = GSLogLock();
    [lock lock];
    _NSLog_printf_handler = OONSLogPrintfHandler;
    [lock unlock];
#endif
    
    atexit(OOLogOutputHandlerClose);
}

References _NSLogCStringFunction, _NSSetLogCStringFunction, InitCrashReporterInfo(), LoadLogCStringFunctions(), nil, OOLog, OOLogOutputHandlerClose(), OONSLogCStringFunction(), sDefaultLogCStringFunction, sInited, sLogger, and sWriteToStderr.

Referenced by OOLoggingInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OOLogOutputHandlerPrint()

void OOLogOutputHandlerPrint ( NSString * string )

Definition at line 196 of file OOLogOutputHandler.m.

{
    if (sInited && sLogger != nil && !sWriteToStdout)  [sLogger asyncLogMessage:string];
    
    BOOL doCStringStuff = sWriteToStderr || sWriteToStdout;
#if SET_CRASH_REPORTER_INFO
    doCStringStuff = doCStringStuff || sCrashReporterInfoAvailable;
#endif
    
    if (doCStringStuff)
    {
        const char *cStr = [[string stringByAppendingString:@"\n"] UTF8String];
        if (sWriteToStdout)
            fputs(cStr, stdout);
        else if (sWriteToStderr)
            fputs(cStr, stderr);
        
#if SET_CRASH_REPORTER_INFO
        if (sCrashReporterInfoAvailable)  SetCrashReporterInfo(cStr);
#endif
    }
    
}

References OOAsyncLogger::asyncLogMessage:, nil, sCrashReporterInfoAvailable, SetCrashReporterInfo(), sInited, sLogger, sWriteToStderr, and sWriteToStdout.

Referenced by OOLogInsertMarker(), OOLogInternal_(), and OOLogWithFunctionFileAndLineAndArguments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OOLogOutputHandlerStartLoggingToStdout()

void OOLogOutputHandlerStartLoggingToStdout ( void )

Definition at line 187 of file OOLogOutputHandler.m.

{
    sWriteToStdout = true;
}

References sWriteToStdout.

◆ OOLogOutputHandlerStopLoggingToStdout()

void OOLogOutputHandlerStopLoggingToStdout ( void )

Definition at line 191 of file OOLogOutputHandler.m.

{
    sWriteToStdout = false;
}

References sWriteToStdout.