OODebugSupport.m

Go to the documentation of this file.

/*
 
OODebugSupport.m
 
 
Copyright (C) 2007-2013 Jens Ayton
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#ifndef OO_EXCLUDE_DEBUG_SUPPORT
 
 
#import "OODebugSupport.h"
#import "ResourceManager.h"
#import "OOCollectionExtractors.h"
#import "OODebugMonitor.h"
#import "OODebugTCPConsoleClient.h"
#import "GameController.h"
#import "OOJavaScriptEngine.h"
 
 
#if OOLITE_MAC_OS_X
static id LoadDebugPlugIn(void);
#else
#define LoadDebugPlugIn() nil
#endif
 
 
static id sDebugPlugInController;
 
 
@interface NSObject (OODebugPlugInController)
 
- (id<OODebuggerInterface>) setUpDebugger;
 
@end
 
 
void OOInitDebugSupport(void)
{
    NSString                *debugOXPPath = nil;
    NSDictionary            *debugSettings = nil;
    NSString                *consoleHost = nil;
    unsigned short          consolePort = 0;
    id<OODebuggerInterface> debugger = nil;
    BOOL                    activateDebugConsole = NO;
    
    // Load debug settings.
    debugSettings = [ResourceManager dictionaryFromFilesNamed:@"debugConfig.plist"
                                                     inFolder:@"Config"
                                                    mergeMode:MERGE_BASIC
                                                        cache:NO];
    
    // Check that the debug OXP is installed. If not, we don't enable debug support.
    debugOXPPath = [ResourceManager pathForFileNamed:@"DebugOXPLocatorBeacon.magic" inFolder:@"nil"];
    if (debugOXPPath != nil)
    {
        // Load plug-in debugging code on platforms where this is supported.
        sDebugPlugInController = [LoadDebugPlugIn() retain];
        
        consoleHost = [debugSettings oo_stringForKey:@"console-host"];
        consolePort = [debugSettings oo_unsignedShortForKey:@"console-port"];
        
        // If consoleHost is nil, and the debug plug-in can set up a debugger, use that.
        if (consoleHost == nil && [sDebugPlugInController respondsToSelector:@selector(setUpDebugger)])
        {
            debugger = [sDebugPlugInController setUpDebugger];
            [[OODebugMonitor sharedDebugMonitor] setUsingPlugInController:YES];
        }
        
        // Otherwise, use TCP debugger connection.
        if (debugger == nil)
        {
            debugger = [[OODebugTCPConsoleClient alloc] initWithAddress:consoleHost
                                                                   port:consolePort];
            [debugger autorelease];
            [[OODebugMonitor sharedDebugMonitor] setUsingPlugInController:NO];
        }
        
        activateDebugConsole = (debugger != nil);
    }
    
    if (!activateDebugConsole)
    {
        activateDebugConsole = [debugSettings oo_boolForKey:@"always-load-debug-console"];
    }
    
    
    if (activateDebugConsole)
    {
        // Set up monitor and register debugger, if any.
        [[OODebugMonitor sharedDebugMonitor] setDebugger:debugger];
        [[OOJavaScriptEngine sharedEngine] enableDebuggerStatement];
    }
}
 
 
#if OOLITE_MAC_OS_X
 
static id LoadDebugPlugIn()
{
    OO_DEBUG_PUSH_PROGRESS(@"Loading debug plug-in");
    
    id debugController = nil;
    
    NSURL *plugInURL = NSBundle.mainBundle.builtInPlugInsURL;
    plugInURL = [plugInURL URLByAppendingPathComponent:@"Debug.bundle"];
    NSBundle *debugBundle = [NSBundle bundleWithURL:plugInURL];
    
    if ([debugBundle load])
    {
        Class principalClass = debugBundle.principalClass;
        if (principalClass != Nil)
        {
            // Instantiate principal class of debug bundle, and let it do whatever it wants.
            debugController = [[principalClass new] autorelease];
        }
        else
        {
            OOLog(@"debugSupport.load.failed", @"Failed to find principal class of debug bundle.");
        }
    }
    else
    {
        OOLog(@"debugSupport.load.failed", @"Failed to load debug OXP plug-in from %@.", plugInURL.path);
    }
    
    OO_DEBUG_POP_PROGRESS();
    
    return debugController;
}
 
#endif
 
#endif  /* OO_EXCLUDE_DEBUG_SUPPORT */