Add indent/unindent for recursive debugging about cocoalumberjack HOT 7 CLOSED

DDLogIndent(i,   @"Lumberjack is:");
DDLogIndent(++i, @"- Fast");
DDLogIndent(i,   @"- Simple");
DDLogIndent(i,   @"- Powerful");
DDLogIndent(i--, @"- Flexible");
DDLogIndent(i,   @"But don't take my word for it.");
DDLogIndent(i,   @"Try it yourself.");

#define DDLogIndent(indentLevel, frmt, ...)                   \
  [DDLog log:YES                /* Asynchronous           */  \
       level:ddLogLevel         /* Current log level      */  \
        flag:LOG_FLAG_VERBOSE   /* Log if verbose enabled */  \
     context:0                  /* Normal app context     */  \
        file:__FILE__                                                 \
    function:sel_getName(_cmd)                                        \
        line:__LINE__                                                 \
         tag:[NSNumber numberWithInt:indentLevel] /* Special sauce*/  \
      format:(frmt), ##__VA_ARGS__]

And then I tweaked the formatter to look like this:

- (NSString *)formatLogMessage:(DDLogMessage *)logMessage
{
    NSMutableString *str = [NSMutableString stringWithCapacity:32];

    [str appendFormat:@"%@ | %s @ %i | ", logMessage.fileName, logMessage->function, logMessage->lineNumber];

    NSNumber *indentLevelNumber = (NSNumber *)logMessage->tag;
    int indentLevel = [indentLevelNumber intValue];

    for (int i = 0; i < indentLevel; i++)
    {
        [str appendString:@"  "];
    }

    [str appendFormat:@"%@", logMessage->logMsg];

    return str;
}

#import <Foundation/Foundation.h>
#import "DDLog.h"

extern id const DDLogIncrementIndentLevel;
extern id const DDLogDecrementIndentLevel;

#define DDLogIndent()                  \
  [DDLog log:YES                       \
       level:0                         \
        flag:0                         \
     context:0                         \
        file:NULL                      \
    function:NULL                      \
        line:0                         \
         tag:DDLogIncrementIndentLevel \
      format:@""] 

#define DDLogUnindent()                \
  [DDLog log:YES                       \
       level:0                         \
        flag:0                         \
     context:0                         \
        file:NULL                      \
    function:NULL                      \
        line:0                         \
         tag:DDLogDecrementIndentLevel \
      format:@""]

@interface RecursionFormatter : NSObject <DDLogFormatter>

@end

#import "RecursionFormatter.h"
#import <pthread.h>


id const DDLogIncrementIndentLevel = @"DDLogIncrementIndentLevel";
id const DDLogDecrementIndentLevel = @"DDLogDecrementIndentLevel";


@implementation RecursionFormatter
{
    dispatch_queue_t indentQueue;
    NSMutableDictionary *indentDict;
}

- (id)init
{
    if ((self = [super init]))
    {
        indentQueue = dispatch_queue_create("TestFormatter", NULL);
        indentDict = [[NSMutableDictionary alloc] init];
    }
    return self;
}

- (NSUInteger)indentLevel:(mach_port_t)threadID
{
    __block NSUInteger indentLevel;

    dispatch_sync(indentQueue, ^{

        NSNumber *key = [NSNumber numberWithUnsignedInt:threadID];

        indentLevel = [[indentDict objectForKey:key] unsignedIntegerValue];

        NSLog(@"indentLevel: %lu", (unsigned long)indentLevel);
    });

    return indentLevel;
}

- (void)indent:(mach_port_t)threadID
{
    dispatch_async(indentQueue, ^{

        NSNumber *key = [NSNumber numberWithUnsignedInt:threadID];

        NSUInteger oldIndentLevel = [[indentDict objectForKey:key] unsignedIntegerValue];
        NSUInteger newIndentLevel = oldIndentLevel + 1;

        NSLog(@"indent  : %lu -> %lu", (unsigned long)oldIndentLevel, (unsigned long)newIndentLevel);

        [indentDict setObject:[NSNumber numberWithUnsignedInteger:newIndentLevel] forKey:key];
    });
}

- (void)unindent:(mach_port_t)threadID
{
    dispatch_async(indentQueue, ^{

        NSNumber *key = [NSNumber numberWithUnsignedInt:threadID];

        NSUInteger oldIndentLevel = [[indentDict objectForKey:key] unsignedIntegerValue];
        NSUInteger newIndentLevel = oldIndentLevel > 0 ? oldIndentLevel - 1 : 0;

        NSLog(@"unindent: %lu -> %lu", (unsigned long)oldIndentLevel, (unsigned long)newIndentLevel);

        [indentDict setObject:[NSNumber numberWithUnsignedInteger:newIndentLevel] forKey:key];
    });
}

- (NSString *)formatLogMessage:(DDLogMessage *)logMessage
{
    if (logMessage->tag == DDLogIncrementIndentLevel)
    {
        [self indent:logMessage->machThreadID];
        return nil;
    }
    if (logMessage->tag == DDLogDecrementIndentLevel)
    {
        [self unindent:logMessage->machThreadID];
        return nil;
    }

    NSMutableString *str = [[NSMutableString alloc] init];

    [str appendFormat:@"%@ | ", logMessage.fileName];

    NSUInteger indentLevel = [self indentLevel:logMessage->machThreadID];

    NSUInteger i;
    for (i = 0; i < indentLevel; i++)
    {
        [str appendString:@"  "];
    }

    [str appendString:logMessage->logMsg];

    return str;
}

@end

- (void)recursiveMethod:(NSUInteger)i
{
    DDLogIndent();

    if (i > 0)
    {
        DDLogInfo(@"pre-recursion");
        [self recursiveMethod:(i-1)];
        DDLogInfo(@"post-recursion");
    }

    DDLogUnindent();
}

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
    // Setup logging (with our custom formatter)

    formatter = [[RecursionFormatter alloc] init];

    [[DDTTYLogger sharedInstance] setLogFormatter:formatter];
    [DDLog addLogger:[DDTTYLogger sharedInstance]];

    [self recursiveMethod:4];
}