Move Mac files from WebKit into WebKit/mac.
[WebKit-https.git] / WebKit / mac / WebInspector / WebNodeHighlightView.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 "WebNodeHighlightView.h"
30 #import "WebNodeHighlight.h"
31 #import "WebNSViewExtras.h"
32
33 #import <WebKit/DOMCore.h>
34 #import <WebKit/DOMExtensions.h>
35
36 #import <JavaScriptCore/Assertions.h>
37
38 #define OVERLAY_MAX_ALPHA 0.7
39 #define OVERLAY_WHITE_VALUE 0.1
40
41 #define WHITE_FRAME_THICKNESS 1.0
42
43 @interface WebNodeHighlightView (FileInternal)
44 - (NSArray *)_holes;
45 @end
46
47 @implementation WebNodeHighlightView
48
49 - (id)initWithWebNodeHighlight:(WebNodeHighlight *)webNodeHighlight
50 {
51     self = [self initWithFrame:NSZeroRect];
52     if (!self)
53         return nil;
54
55     _webNodeHighlight = [webNodeHighlight retain];
56
57     return self;
58 }
59
60 - (void)dealloc
61 {
62     [self detachFromWebNodeHighlight];
63     [super dealloc];
64 }
65
66 - (void)detachFromWebNodeHighlight
67 {
68     [_webNodeHighlight release];
69     _webNodeHighlight = nil;
70 }
71
72 - (void)drawRect:(NSRect)rect 
73 {
74     [NSGraphicsContext saveGraphicsState];
75
76     // draw translucent gray fill, out of which we will cut holes
77     [[NSColor colorWithCalibratedWhite:OVERLAY_WHITE_VALUE alpha:(_fractionFadedIn * OVERLAY_MAX_ALPHA)] set];
78     NSRectFill(rect);
79
80     // determine set of holes
81     NSArray *holes = [self _holes];
82     int holeCount = [holes count];
83     int holeIndex;
84
85     // Draw white frames around holes in first pass, so they will be erased in
86     // places where holes overlap or abut.
87     [[NSColor colorWithCalibratedWhite:1.0 alpha:_fractionFadedIn] set];
88
89     // white frame is just outside of the hole that the delegate returned
90     for (holeIndex = 0; holeIndex < holeCount; ++holeIndex) {
91         NSRect hole = [[holes objectAtIndex:holeIndex] rectValue];
92         hole = NSInsetRect(hole, -WHITE_FRAME_THICKNESS, -WHITE_FRAME_THICKNESS);
93         NSRectFill(hole);
94     }
95
96     [[NSColor clearColor] set];
97
98     // Erase holes in second pass.
99     for (holeIndex = 0; holeIndex < holeCount; ++holeIndex)
100         NSRectFill([[holes objectAtIndex:holeIndex] rectValue]);
101
102     [NSGraphicsContext restoreGraphicsState];
103 }
104
105 - (WebNodeHighlight *)webNodeHighlight
106 {
107     return _webNodeHighlight;
108 }
109
110 - (float)fractionFadedIn
111 {
112     return _fractionFadedIn;
113 }
114
115 - (void)setFractionFadedIn:(float)fraction
116 {
117     ASSERT_ARG(fraction, fraction >= 0.0 && fraction <= 1.0);
118
119     if (_fractionFadedIn == fraction)
120         return;
121     
122     _fractionFadedIn = fraction;
123     [self setNeedsDisplay:YES];
124 }
125
126 - (void)setHolesNeedUpdateInRect:(NSRect)rect
127 {
128     // Redisplay a slightly larger rect to account for white border around holes
129     rect = NSInsetRect(rect, -1 * WHITE_FRAME_THICKNESS, 
130                              -1 * WHITE_FRAME_THICKNESS);
131
132     [self setNeedsDisplayInRect:rect];
133 }
134
135 @end
136
137 @implementation WebNodeHighlightView (FileInternal)
138
139 - (NSArray *)_holes
140 {
141     DOMNode *node = [_webNodeHighlight highlightedNode];
142
143     // FIXME: node view needs to be the correct frame document view, it isn't always the main frame
144     NSView *nodeView = [_webNodeHighlight targetView];
145
146     NSArray *lineBoxRects = nil;
147     if ([node isKindOfClass:[DOMElement class]]) {
148         DOMCSSStyleDeclaration *style = [[node ownerDocument] getComputedStyle:(DOMElement *)node pseudoElement:@""];
149         if ([[style getPropertyValue:@"display"] isEqualToString:@"inline"])
150             lineBoxRects = [node lineBoxRects];
151     } else if ([node isKindOfClass:[DOMText class]]) {
152 #if ENABLE(SVG)
153         if (![[node parentNode] isKindOfClass:NSClassFromString(@"DOMSVGElement")])
154 #endif
155             lineBoxRects = [node lineBoxRects];
156     }
157
158     if (![lineBoxRects count]) {
159         NSRect boundingBox = [nodeView _web_convertRect:[node boundingBox] toView:self];
160         return [NSArray arrayWithObject:[NSValue valueWithRect:boundingBox]];
161     }
162
163     NSMutableArray *rects = [[NSMutableArray alloc] initWithCapacity:[lineBoxRects count]];
164
165     unsigned lineBoxRectCount = [lineBoxRects count];
166     for (unsigned lineBoxRectIndex = 0; lineBoxRectIndex < lineBoxRectCount; ++lineBoxRectIndex) {
167         NSRect r = [[lineBoxRects objectAtIndex:lineBoxRectIndex] rectValue];
168         NSRect overlayViewRect = [nodeView _web_convertRect:r toView:self];
169         [rects addObject:[NSValue valueWithRect:overlayViewRect]];
170     }
171
172     return [rects autorelease];
173 }
174
175 @end