#include <OOJavaScriptConsoleController.h>

Inheritance diagram for OOJavaScriptConsoleController:

Collaboration diagram for OOJavaScriptConsoleController:

Instance Methods
(IBAction)	- clearConsole:

(IBAction)	- showConsole:

(IBAction)	- toggleShowOnLog:

(IBAction)	- toggleShowOnWarning:

(IBAction)	- toggleShowOnError:

(IBAction)	- consolePerformCommand:

(void)	- appendMessage:colorKey:emphasisRange:

(void)	- clearConsole

(void)	- doShowConsole

(void)	- noteConfigurationChanged:

(void)	- setDebugger:

(void)	- dealloc `[implementation]`

(void)	- awakeFromNib `[implementation]`

(void)	- applicationWillTerminate: `[implementation]`

(BOOL)	- validateMenuItem: `[implementation]`

(void)	- splitView:wasResizedFrom:to: `[implementation]`

(NSColor *)	- foregroundColorForKey: `[implementation]`

(NSColor *)	- backgroundColorForKey: `[implementation]`

(void)	- reloadAllSettings `[implementation]`

(void)	- setUpFonts `[implementation]`

(void)	- saveHistory `[implementation]`

Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf

(id)	- weakRetain `[implementation]`

(void)	- weakRefDied: `[implementation]`

Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Private Attributes
IBOutlet NSWindow *	consoleWindow

IBOutlet NSView *	consoleLogHolderView

IBOutlet NSView *	consoleInputHolderView

IBOutlet NSTextView *	consoleTextView

IBOutlet NSTextField *	consoleInputField

IBOutlet OOTextFieldHistoryManager *	inputHistoryManager

RBSplitSubview *	inputSplitSubview

IBOutlet NSScroller *	verticalScroller

OOMacDebugger *	_debugger

NSFont *	_baseFont

NSFont *	_boldFont

NSMutableDictionary *	_fgColors

NSMutableDictionary *	_bgColors

Additional Inherited Members
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 38 of file OOJavaScriptConsoleController.h.

Method Documentation

◆ appendMessage:colorKey:emphasisRange:

- (void) appendMessage:	(NSString *)	string
colorKey:	(NSString *)	colorKey
emphasisRange:	(NSRange)	emphasisRange

Definition at line 192 of file OOJavaScriptConsoleController.m.

                     :(NSString *)string
             colorKey:(NSString *)colorKey
        emphasisRange:(NSRange)emphasisRange
{
    OOJS_PROFILE_ENTER
    
    NSMutableAttributedString   *mutableStr = nil;
    NSColor                     *fgColor = nil,
                                *bgColor = nil;
    volatile NSRange            fullRange;
    NSTextStorage               *textStorage = nil;
    BOOL                        doScroll;
    NSUInteger                  length;
    
    mutableStr = [NSMutableAttributedString stringWithString:[string stringByAppendingString:@"\n"]
                                                        font:_baseFont];
    
    fullRange = (NSRange){ 0, [mutableStr length] };
    fgColor = [self foregroundColorForKey:colorKey];
    if (fgColor != nil)
    {
        if ([fgColor alphaComponent] == 0.0)  return;
        [mutableStr addAttribute:NSForegroundColorAttributeName
                           value:fgColor
                           range:fullRange];
    }
    
    bgColor = [self backgroundColorForKey:colorKey];
    if (bgColor != nil)
    {
        [mutableStr addAttribute:NSBackgroundColorAttributeName
                           value:bgColor
                           range:fullRange];
    }
    
    if (emphasisRange.length != 0)
    {
        [mutableStr addAttribute:NSFontAttributeName
                           value:_boldFont
                           range:emphasisRange];
    }
    
    doScroll = [verticalScroller floatValue] > 0.980f;
    
    textStorage = [consoleTextView textStorage];
    [textStorage appendAttributedString:mutableStr];
    length = [textStorage length];
    if (fullRange.length > kConsoleMaxSize)
    {
        [textStorage deleteCharactersInRange:(NSRange){ length - kConsoleTrimToSize, kConsoleTrimToSize }];
        length = kConsoleTrimToSize;
    }
    
    // Scroll to end of field
    if (doScroll)  [consoleTextView scrollRangeToVisible:(NSRange){ length, 0 }];
    
    OOJS_PROFILE_EXIT_VOID
}

References backgroundColorForKey:, foregroundColorForKey:, kConsoleMaxSize, kConsoleTrimToSize, nil, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT_VOID.

Referenced by OOMacDebugger::debugMonitor:jsConsoleOutput:colorKey:emphasisRange:, and OOMacDebugger::disconnectDebugMonitor:message:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applicationWillTerminate:

- (void) applicationWillTerminate: (NSNotification *) notification

implementation

Definition at line 138 of file OOJavaScriptConsoleController.m.

138 :(NSNotification *)notification

139{

140 [self saveHistory];

141}

References saveHistory.

Here is the call graph for this function:

◆ awakeFromNib

- (void) awakeFromNib

implementation

Definition at line 94 of file OOJavaScriptConsoleController.m.

{
    assert(kConsoleTrimToSize < kConsoleMaxSize);
    
    //  Build RBSplitView programmatically to avoid issues with IB plug-in.
    NSView *contentView = [consoleWindow contentView];
    RBSplitView *splitView = [[RBSplitView alloc] initWithFrame:[contentView frame]];
    
    [contentView addSubview:splitView];
    [splitView setAutoresizingMask:NSViewHeightSizable | NSViewWidthSizable];
    
    [splitView setVertical:NO];
    [splitView setDelegate:self];
    
    [splitView addSubview:consoleLogHolderView atPosition:0];
    [[splitView subviewAtPosition:0] setMinDimension:100 andMaxDimension:0];
    
    CGFloat height = [consoleInputHolderView frame].size.height;
    [splitView addSubview:consoleInputHolderView atPosition:1];
    inputSplitSubview = [splitView subviewAtPosition:1];
    [inputSplitSubview setMinDimension:30 andMaxDimension:0];
    
    NSString *thumbPath = [[NSBundle bundleForClass:[self class]] pathForResource:@"SplitViewThumb" ofType:@"png"];
    [splitView setDivider:[[[NSImage alloc] initWithContentsOfFile:thumbPath] autorelease]];
    [inputSplitSubview setDimension:height];
    
    // Free performance boost in Leopard.
    if ([[consoleTextView layoutManager] respondsToSelector:@selector(setAllowsNonContiguousLayout:)])
    {
        [[consoleTextView layoutManager] setAllowsNonContiguousLayout:YES];
    }
    
    // Ensure auto-scrolling will work.
    [verticalScroller setFloatValue:1.0];
    
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    [inputHistoryManager setHistory:[defaults arrayForKey:@"debug-js-console-scrollback"]];
    
    [self reloadAllSettings];
    
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationWillTerminate:) name:NSApplicationWillTerminateNotification object:nil];
}

References RBSplitView::addSubview:atPosition:, awakeFromNib, consoleTextView, inputSplitSubview, kConsoleMaxSize, kConsoleTrimToSize, reloadAllSettings, RBSplitView::setDelegate:, RBSplitSubview::setDimension:, RBSplitView::setDivider:, OOTextFieldHistoryManager::setHistory:, RBSplitSubview::setMinDimension:andMaxDimension:, RBSplitView::setVertical:, and RBSplitView::subviewAtPosition:.

Referenced by awakeFromNib.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ backgroundColorForKey:

- (NSColor *) backgroundColorForKey: (NSString *) key

implementation

Provided by category OOJavaScriptConsoleController(Private).

Definition at line 376 of file OOJavaScriptConsoleController.m.

                                  :(NSString *)key
{
    NSColor                     *result = nil;
    NSString                    *expandedKey = nil;
    
    if (key == nil)  key = @"general";
    
    result = [_bgColors objectForKey:key];
    if (result == nil)
    {
        // No cached colour; load colour description from config file
        expandedKey = [key stringByAppendingString:@"-background-color"];
        result = [NSColor colorWithOOColorDescription:[_debugger configurationValueForKey:expandedKey]];
        if (result == nil)
        {
            expandedKey = [key stringByAppendingString:@"-background-colour"];
            result = [NSColor colorWithOOColorDescription:[_debugger configurationValueForKey:expandedKey]];
        }
        if (result == nil && ![key isEqualToString:@"general"])
        {
            result = [self backgroundColorForKey:nil];
        }
        if (result == nil)  result = [NSColor whiteColor];
        
        // Store loaded colour in cache
        if (result != nil)
        {
            if (_bgColors == nil)  _bgColors = [[NSMutableDictionary alloc] init];
            [_bgColors setObject:result forKey:key];
        }
    }
    
    return result;
}

Referenced by appendMessage:colorKey:emphasisRange:, OOJavaScriptConsoleController(Private)::backgroundColorForKey:, noteConfigurationChanged:, and OOJavaScriptConsoleController(Private)::reloadAllSettings.

Here is the caller graph for this function:

◆ clearConsole

- (void) clearConsole

Definition at line 252 of file OOJavaScriptConsoleController.m.

{
    NSTextStorage               *textStorage = nil;
    
    textStorage = [consoleTextView textStorage];
    [textStorage deleteCharactersInRange:(NSRange){ 0, [textStorage length] }];
}

References clearConsole, and nil.

Referenced by clearConsole, clearConsole:, and OOMacDebugger::debugMonitorClearConsole:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearConsole:

- (IBAction) clearConsole: (id) sender

Definition at line 146 of file OOJavaScriptConsoleController.m.

146 :sender

147{

148 [self clearConsole];

149}

References clearConsole.

Here is the call graph for this function:

◆ consolePerformCommand:

- (IBAction) consolePerformCommand: (id) sender

Definition at line 176 of file OOJavaScriptConsoleController.m.

                                 :sender
{
    NSString                    *command = nil;
    
    // Use consoleInputField rather than sender so we can, e.g., add a button.
    command = [consoleInputField stringValue];
    [consoleInputField setStringValue:@""];
    [consoleWindow makeFirstResponder:consoleInputField];   // Is unset if an empty string is entered otherwise.
    
    [inputHistoryManager addToHistory:command];
    [self saveHistory];
    
    [_debugger performConsoleCommand:command];
}

References OOTextFieldHistoryManager::addToHistory:, nil, OOMacDebugger::performConsoleCommand:, and saveHistory.

Here is the call graph for this function:

◆ dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Definition at line 79 of file OOJavaScriptConsoleController.m.

{
    [consoleWindow release];
    [inputHistoryManager release];
    
    [_baseFont release];
    [_boldFont release];
    
    [_fgColors release];
    [_bgColors release];
    
    [super dealloc];
}

References dealloc, and OOWeakRefObject::dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doShowConsole

- (void) doShowConsole

Definition at line 261 of file OOJavaScriptConsoleController.m.

262{

263 [consoleWindow makeKeyAndOrderFront:nil];

264 [consoleWindow makeFirstResponder:consoleInputField];

265}

References doShowConsole.

Referenced by OOMacDebugger::debugMonitorShowConsole:, and doShowConsole.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ foregroundColorForKey:

- (NSColor *) foregroundColorForKey: (NSString *) key

implementation

Provided by category OOJavaScriptConsoleController(Private).

Definition at line 340 of file OOJavaScriptConsoleController.m.

                                  :(NSString *)key
{
    NSColor                     *result = nil;
    NSString                    *expandedKey = nil;
    
    if (key == nil)  key = @"general";
    
    result = [_fgColors objectForKey:key];
    if (result == nil)
    {
        // No cached colour; load colour description from config file
        expandedKey = [key stringByAppendingString:@"-foreground-color"];
        result = [NSColor colorWithOOColorDescription:[_debugger configurationValueForKey:expandedKey]];
        if (result == nil)
        {
            expandedKey = [key stringByAppendingString:@"-foreground-colour"];
            result = [NSColor colorWithOOColorDescription:[_debugger configurationValueForKey:expandedKey]];
        }
        if (result == nil && ![key isEqualToString:@"general"])
        {
            result = [self foregroundColorForKey:nil];
        }
        if (result == nil)  result = [NSColor blackColor];
        
        // Store loaded colour in cache
        if (result != nil)
        {
            if (_fgColors == nil)  _fgColors = [[NSMutableDictionary alloc] init];
            [_fgColors setObject:result forKey:key];
        }
    }
    
    return result;
}

Referenced by appendMessage:colorKey:emphasisRange:, and OOJavaScriptConsoleController(Private)::foregroundColorForKey:.

Here is the caller graph for this function:

◆ noteConfigurationChanged:

- (void) noteConfigurationChanged: (NSString *) key

Definition at line 268 of file OOJavaScriptConsoleController.m.

                                :(NSString *)key
{
    if ([key hasSuffix:@"-foreground-color"] || [key hasSuffix:@"-foreground-colour"])
    {
        // Flush foreground colour cache
        [_fgColors removeAllObjects];
    }
    else if ([key hasSuffix:@"-background-color"] || [key hasSuffix:@"-background-colour"])
    {
        // Flush background colour cache
        [_bgColors removeAllObjects];
        [consoleTextView setBackgroundColor:[self backgroundColorForKey:nil]];
    }
    else if ([key hasPrefix:@"font-"])
    {
        [self setUpFonts];
    }
}

References backgroundColorForKey:, and setUpFonts.

Referenced by OOMacDebugger::debugMonitor:noteChangedConfigrationValue:forKey:, and OOMacDebugger::debugMonitor:noteConfiguration:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reloadAllSettings

- (void) reloadAllSettings

implementation

Provided by category OOJavaScriptConsoleController(Private).

Definition at line 412 of file OOJavaScriptConsoleController.m.

{
    [_fgColors removeAllObjects];
    [_bgColors removeAllObjects];
    [consoleTextView setBackgroundColor:[self backgroundColorForKey:nil]];
    [self setUpFonts];
}

Referenced by awakeFromNib, and setDebugger:.

Here is the caller graph for this function:

◆ saveHistory

- (void) saveHistory

implementation

Provided by category OOJavaScriptConsoleController(Private).

Definition at line 448 of file OOJavaScriptConsoleController.m.

{
    NSArray                     *history = nil;
    
    history = [inputHistoryManager history];
    if (history != nil)
    {
        [[NSUserDefaults standardUserDefaults] setObject:history forKey:@"debug-js-console-scrollback"];
        [[NSUserDefaults standardUserDefaults] synchronize];
    }
}

Referenced by applicationWillTerminate:, and consolePerformCommand:.

Here is the caller graph for this function:

◆ setDebugger:

- (void) setDebugger: (OOMacDebugger *) debugger

Definition at line 288 of file OOJavaScriptConsoleController.m.

                   :(OOMacDebugger *)debugger
{
    _debugger = debugger;
    [self reloadAllSettings];
}

References _debugger, and reloadAllSettings.

Referenced by OOMacDebugger::initWithController:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUpFonts

- (void) setUpFonts

implementation

Provided by category OOJavaScriptConsoleController(Private).

Definition at line 421 of file OOJavaScriptConsoleController.m.

{
    NSString                    *fontFace = nil;
    NSInteger                   fontSize;
    
    DESTROY(_baseFont);
    DESTROY(_boldFont);
    
    // Set font.
    fontFace = [_debugger configurationValueForKey:@"font-face"
                                            class:[NSString class]
                                     defaultValue:@"Courier"];
    fontSize = (NSInteger)[_debugger configurationIntValueForKey:@"font-size"
                                                    defaultValue:12];
    
    _baseFont = [NSFont fontWithName:fontFace size:fontSize];
    if (_baseFont == nil)  _baseFont = [NSFont userFixedPitchFontOfSize:0];
    [_baseFont retain];
    
    // Get bold variant of font.
    _boldFont = [[NSFontManager sharedFontManager] convertFont:_baseFont
                                                   toHaveTrait:NSBoldFontMask];
    if (_boldFont == nil)  _boldFont = _baseFont;
    [_boldFont retain];
}

Referenced by noteConfigurationChanged:, and OOJavaScriptConsoleController(Private)::reloadAllSettings.

Here is the caller graph for this function:

◆ showConsole:

- (IBAction) showConsole: (id) sender

Definition at line 152 of file OOJavaScriptConsoleController.m.

152 :sender

153{

154 [[OODebugMonitor sharedDebugMonitor] showJSConsole];

155}

OODebugMonitor

Definition OODebugMonitor.h:67

-[OODebugMonitor showJSConsole]

void showJSConsole()

Definition OODebugMonitor.m:257

+[OODebugMonitor sharedDebugMonitor]

OODebugMonitor * sharedDebugMonitor()

Definition OODebugMonitor.m:146

References OODebugMonitor::sharedDebugMonitor, and OODebugMonitor::showJSConsole.

Here is the call graph for this function:

◆ splitView:wasResizedFrom:to:

- (void) splitView:	(RBSplitView*)	sender
wasResizedFrom:	(float)	oldDimension
to:	(float)	newDimension

implementation

Definition at line 330 of file OOJavaScriptConsoleController.m.

330 :(RBSplitView*)sender wasResizedFrom:(float)oldDimension to:(float)newDimension

331{

332 [sender adjustSubviewsExcepting:inputSplitSubview];

333}

-[RBSplitView adjustSubviewsExcepting:]

void adjustSubviewsExcepting:(RBSplitSubview *excepting)

Definition RBSplitView.m:839

References RBSplitView::adjustSubviewsExcepting:.

Here is the call graph for this function:

◆ toggleShowOnError:

- (IBAction) toggleShowOnError: (id) sender

Definition at line 164 of file OOJavaScriptConsoleController.m.

164 :sender

165{

166 [_debugger performConsoleCommand:@"console.settings[\"show-console-on-error\"] = !console.settings[\"show-console-on-error\"]"];

167}

References OOMacDebugger::performConsoleCommand:.

Here is the call graph for this function:

◆ toggleShowOnLog:

- (IBAction) toggleShowOnLog: (id) sender

Definition at line 170 of file OOJavaScriptConsoleController.m.

170 :sender

171{

172 [_debugger performConsoleCommand:@"console.settings[\"show-console-on-log\"] = !console.settings[\"show-console-on-log\"]"];

173}

References OOMacDebugger::performConsoleCommand:.

Here is the call graph for this function:

◆ toggleShowOnWarning:

- (IBAction) toggleShowOnWarning: (id) sender

Definition at line 158 of file OOJavaScriptConsoleController.m.

158 :sender

159{

160 [_debugger performConsoleCommand:@"console.settings[\"show-console-on-warning\"] = !console.settings[\"show-console-on-warning\"]"];

161}

References OOMacDebugger::performConsoleCommand:.

Here is the call graph for this function:

◆ validateMenuItem:

- (BOOL) validateMenuItem: (NSMenuItem *) menuItem

implementation

Definition at line 297 of file OOJavaScriptConsoleController.m.

                        :(NSMenuItem *)menuItem
{
    SEL                         action = NULL;
    OODebugMonitor              *monitor = nil;
    
    action = [menuItem action];
    monitor = [OODebugMonitor sharedDebugMonitor];
    
    if (action == @selector(toggleShowOnWarning:))
    {
        [menuItem setState:[_debugger configurationBoolValueForKey:@"show-console-on-warning"]];
        return [monitor debuggerConnected];
    }
    if (action == @selector(toggleShowOnError:))
    {
        [menuItem setState:[_debugger configurationBoolValueForKey:@"show-console-on-error"]];
        return [monitor debuggerConnected];
    }
    if (action == @selector(toggleShowOnLog:))
    {
        [menuItem setState:[_debugger configurationBoolValueForKey:@"show-console-on-log"]];
        return [monitor debuggerConnected];
    }
    if (action == @selector(showConsole:))
    {
        return [monitor debuggerConnected];
    }
    
    return [self respondsToSelector:action];
}

References OOMacDebugger::configurationBoolValueForKey:, OODebugMonitor::debuggerConnected, nil, and OODebugMonitor::sharedDebugMonitor.

Here is the call graph for this function:

Member Data Documentation

◆ _baseFont

- (NSFont*) _baseFont

private

Definition at line 57 of file OOJavaScriptConsoleController.h.

◆ _bgColors

- (NSMutableDictionary *) _bgColors

private

Definition at line 62 of file OOJavaScriptConsoleController.h.

◆ _boldFont

- (NSFont *) _boldFont

private

Definition at line 58 of file OOJavaScriptConsoleController.h.

◆ _debugger

- (OOMacDebugger*) _debugger

private

Definition at line 55 of file OOJavaScriptConsoleController.h.

Referenced by setDebugger:.

◆ _fgColors

- (NSMutableDictionary*) _fgColors

private

Definition at line 61 of file OOJavaScriptConsoleController.h.

◆ consoleInputField

- (IBOutlet NSTextField*) consoleInputField

private

Definition at line 49 of file OOJavaScriptConsoleController.h.

◆ consoleInputHolderView

- (IBOutlet NSView*) consoleInputHolderView

private

Definition at line 45 of file OOJavaScriptConsoleController.h.

◆ consoleLogHolderView

- (IBOutlet NSView*) consoleLogHolderView

private

Definition at line 44 of file OOJavaScriptConsoleController.h.

◆ consoleTextView

- (IBOutlet NSTextView*) consoleTextView

private

Definition at line 48 of file OOJavaScriptConsoleController.h.

Referenced by awakeFromNib.

◆ consoleWindow

- (IBOutlet NSWindow*) consoleWindow

private

Definition at line 41 of file OOJavaScriptConsoleController.h.

◆ inputHistoryManager

- (IBOutlet OOTextFieldHistoryManager*) inputHistoryManager

private

Definition at line 51 of file OOJavaScriptConsoleController.h.

◆ inputSplitSubview

- (RBSplitSubview*) inputSplitSubview

private

Definition at line 52 of file OOJavaScriptConsoleController.h.

Referenced by awakeFromNib.

◆ verticalScroller

- (IBOutlet NSScroller*) verticalScroller

private

Definition at line 53 of file OOJavaScriptConsoleController.h.

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

Mac-specific/DebugBundle/Source/OOJavaScriptConsoleController.h
Mac-specific/DebugBundle/Source/OOJavaScriptConsoleController.m

Instance Methods

Private Attributes

Additional Inherited Members

Detailed Description

Method Documentation

◆ appendMessage:colorKey:emphasisRange:

◆ applicationWillTerminate:

◆ awakeFromNib

◆ backgroundColorForKey:

◆ clearConsole

◆ clearConsole:

◆ consolePerformCommand:

◆ dealloc

◆ doShowConsole

◆ foregroundColorForKey:

◆ noteConfigurationChanged:

◆ reloadAllSettings

◆ saveHistory

◆ setDebugger:

◆ setUpFonts

◆ showConsole:

◆ splitView:wasResizedFrom:to:

◆ toggleShowOnError:

◆ toggleShowOnLog:

◆ toggleShowOnWarning:

◆ validateMenuItem:

Member Data Documentation

◆ _baseFont

◆ _bgColors

◆ _boldFont

◆ _debugger

◆ _fgColors

◆ consoleInputField

◆ consoleInputHolderView

◆ consoleLogHolderView

◆ consoleTextView

◆ consoleWindow

◆ inputHistoryManager

◆ inputSplitSubview

◆ verticalScroller