2007-06-18 Mitz Pettel <mitz@webkit.org>
[WebKit-https.git] / WebKit / WebInspector / WebNodeHighlight.m
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <mach/mach_time.h>
30 #import "WebNodeHighlightView.h"
31 #import "WebNodeHighlight.h"
32
33 NSString *WebNodeHighlightExpiredNotification = @"WebNodeHighlightExpiredNotification";
34
35 @implementation WebNodeHighlight
36 - (id)initWithBounds:(NSRect)bounds andRects:(NSArray *)rects forView:(NSView *)view
37 {
38     if (![self init])
39         return nil;
40
41     _startTime = 0.0;
42     _duration = 3.0;
43
44     if ([[[NSApplication sharedApplication] currentEvent] modifierFlags] & NSShiftKeyMask)
45         _duration = 6.0;
46
47     if (!rects)
48         rects = [NSArray arrayWithObject:[NSValue valueWithRect:bounds]];
49
50     _webNodeHighlightView = [[WebNodeHighlightView alloc] initWithHighlight:self andRects:rects forView:view];
51     if (!_webNodeHighlightView) {
52         [self release];
53         return nil;
54     }
55
56     // adjust size and position for rect padding that the view adds
57     bounds.origin.y -= 3.0f;
58     bounds.origin.x -= 3.0f;
59     bounds.size = [_webNodeHighlightView frame].size;
60
61     NSRect windowBounds = [view convertRect:bounds toView:nil];
62     windowBounds.origin = [[view window] convertBaseToScreen:windowBounds.origin]; // adjust for screen coords
63
64     _webNodeHighlightWindow = [[NSWindow alloc] initWithContentRect:windowBounds styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
65     [_webNodeHighlightWindow setBackgroundColor:[NSColor clearColor]];
66     [_webNodeHighlightWindow setOpaque:NO];
67     [_webNodeHighlightWindow setHasShadow:NO];
68     [_webNodeHighlightWindow setIgnoresMouseEvents:YES];
69     [_webNodeHighlightWindow setReleasedWhenClosed:YES];
70     [_webNodeHighlightWindow setContentView:_webNodeHighlightView];
71     [_webNodeHighlightView release];
72
73     [[view window] addChildWindow:_webNodeHighlightWindow ordered:NSWindowAbove];
74
75     // 30 frames per second time interval will play well with the CPU and still look smooth
76     _timer = [[NSTimer scheduledTimerWithTimeInterval:(1.0 / 30.0) target:self selector:@selector(redraw:) userInfo:nil repeats:YES] retain];
77
78     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(expire) name:NSViewBoundsDidChangeNotification object:view];
79     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(expire) name:NSViewBoundsDidChangeNotification object:[view superview]];
80     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(expire) name:NSWindowDidResizeNotification object:[view window]];
81     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(expire) name:NSWindowWillCloseNotification object:[view window]];
82
83     return self;
84 }
85
86 - (void)dealloc
87 {
88     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSViewBoundsDidChangeNotification object:nil];
89     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSWindowDidResizeNotification object:nil];
90     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSWindowWillCloseNotification object:nil];
91
92     [_timer invalidate];
93     [_timer release];
94
95     [super dealloc];
96 }
97
98 - (double)fractionComplete
99 {
100     if (_startTime == 0.0)
101         _startTime = CFAbsoluteTimeGetCurrent();
102
103     return ((CFAbsoluteTimeGetCurrent() - _startTime) / _duration);
104 }
105
106 - (void)expire
107 {
108     if (![_timer isValid])  // make sure it has not been expired already (loop prevention)
109         return;
110     
111     [_timer invalidate];
112     [_timer release];
113     _timer = nil;
114
115     // remove this observation before closing the window (more loop prevention)
116     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSWindowWillCloseNotification object:nil];
117     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSWindowDidResizeNotification object:nil];
118     
119     [[_webNodeHighlightWindow parentWindow] removeChildWindow:_webNodeHighlightWindow];
120     [_webNodeHighlightWindow close];
121     _webNodeHighlightWindow = nil;
122
123     [[NSNotificationCenter defaultCenter] postNotificationName:WebNodeHighlightExpiredNotification object:self userInfo:nil];
124 }
125
126 - (void)redraw:(NSTimer *)timer
127 {
128     [_webNodeHighlightView setNeedsDisplay:YES];    
129
130     if (_startTime == 0.0)
131         _startTime = CFAbsoluteTimeGetCurrent();
132
133     if ((CFAbsoluteTimeGetCurrent() - _startTime) > _duration)
134         [self expire];
135 }
136 @end