WK2: Support Accessibility
[WebKit-https.git] / WebKit / mac / WebView / WebFrame.mm
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008 Apple 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 "WebFrameInternal.h"
30
31 #import "DOMCSSStyleDeclarationInternal.h"
32 #import "DOMDocumentFragmentInternal.h"
33 #import "DOMDocumentInternal.h"
34 #import "DOMElementInternal.h"
35 #import "DOMHTMLElementInternal.h"
36 #import "DOMNodeInternal.h"
37 #import "DOMRangeInternal.h"
38 #import "WebArchiveInternal.h"
39 #import "WebChromeClient.h"
40 #import "WebDataSourceInternal.h"
41 #import "WebDocumentLoaderMac.h"
42 #import "WebDynamicScrollBarsView.h"
43 #import "WebFrameLoaderClient.h"
44 #import "WebFrameViewInternal.h"
45 #import "WebHTMLView.h"
46 #import "WebHTMLViewInternal.h"
47 #import "WebKitStatisticsPrivate.h"
48 #import "WebKitVersionChecks.h"
49 #import "WebNSObjectExtras.h"
50 #import "WebNSURLExtras.h"
51 #import "WebScriptDebugger.h"
52 #import "WebScriptWorldInternal.h"
53 #import "WebViewInternal.h"
54 #import <JavaScriptCore/APICast.h>
55 #import <WebCore/AXObjectCache.h>
56 #import <WebCore/AccessibilityObject.h>
57 #import <WebCore/AnimationController.h>
58 #import <WebCore/CSSMutableStyleDeclaration.h>
59 #import <WebCore/CachedResourceLoader.h>
60 #import <WebCore/Chrome.h>
61 #import <WebCore/ColorMac.h>
62 #import <WebCore/DOMImplementation.h>
63 #import <WebCore/DocumentFragment.h>
64 #import <WebCore/DocumentMarkerController.h>
65 #import <WebCore/EventHandler.h>
66 #import <WebCore/EventNames.h>
67 #import <WebCore/Frame.h>
68 #import <WebCore/FrameLoader.h>
69 #import <WebCore/FrameLoaderStateMachine.h>
70 #import <WebCore/FrameTree.h>
71 #import <WebCore/GraphicsContext.h>
72 #import <WebCore/HTMLFrameOwnerElement.h>
73 #import <WebCore/HistoryItem.h>
74 #import <WebCore/HitTestResult.h>
75 #import <WebCore/LegacyWebArchive.h>
76 #import <WebCore/Page.h>
77 #import <WebCore/PluginData.h>
78 #import <WebCore/PrintContext.h>
79 #import <WebCore/RenderLayer.h>
80 #import <WebCore/RenderPart.h>
81 #import <WebCore/RenderView.h>
82 #import <WebCore/ReplaceSelectionCommand.h>
83 #import <WebCore/RuntimeApplicationChecks.h>
84 #import <WebCore/ScriptValue.h>
85 #import <WebCore/SmartReplace.h>
86 #import <WebCore/SVGSMILElement.h>
87 #import <WebCore/TextIterator.h>
88 #import <WebCore/ThreadCheck.h>
89 #import <WebCore/TypingCommand.h>
90 #import <WebCore/htmlediting.h>
91 #import <WebCore/markup.h>
92 #import <WebCore/visible_units.h>
93 #import <WebKitSystemInterface.h>
94 #import <runtime/JSLock.h>
95 #import <runtime/JSObject.h>
96 #import <runtime/JSValue.h>
97 #import <wtf/CurrentTime.h>
98
99 using namespace std;
100 using namespace WebCore;
101 using namespace HTMLNames;
102
103 using JSC::JSGlobalObject;
104 using JSC::JSLock;
105 using JSC::JSValue;
106 using JSC::SilenceAssertionsOnly;
107
108 /*
109 Here is the current behavior matrix for four types of navigations:
110
111 Standard Nav:
112
113  Restore form state:   YES
114  Restore scroll and focus state:  YES
115  Cache policy: NSURLRequestUseProtocolCachePolicy
116  Add to back/forward list: YES
117  
118 Back/Forward:
119
120  Restore form state:   YES
121  Restore scroll and focus state:  YES
122  Cache policy: NSURLRequestReturnCacheDataElseLoad
123  Add to back/forward list: NO
124
125 Reload (meaning only the reload button):
126
127  Restore form state:   NO
128  Restore scroll and focus state:  YES
129  Cache policy: NSURLRequestReloadIgnoringCacheData
130  Add to back/forward list: NO
131
132 Repeat load of the same URL (by any other means of navigation other than the reload button, including hitting return in the location field):
133
134  Restore form state:   NO
135  Restore scroll and focus state:  NO, reset to initial conditions
136  Cache policy: NSURLRequestReloadIgnoringCacheData
137  Add to back/forward list: NO
138 */
139
140 NSString *WebPageCacheEntryDateKey = @"WebPageCacheEntryDateKey";
141 NSString *WebPageCacheDataSourceKey = @"WebPageCacheDataSourceKey";
142 NSString *WebPageCacheDocumentViewKey = @"WebPageCacheDocumentViewKey";
143
144 NSString *WebFrameMainDocumentError = @"WebFrameMainDocumentErrorKey";
145 NSString *WebFrameHasPlugins = @"WebFrameHasPluginsKey";
146 NSString *WebFrameHasUnloadListener = @"WebFrameHasUnloadListenerKey";
147 NSString *WebFrameUsesDatabases = @"WebFrameUsesDatabasesKey";
148 NSString *WebFrameUsesGeolocation = @"WebFrameUsesGeolocationKey";
149 NSString *WebFrameUsesApplicationCache = @"WebFrameUsesApplicationCacheKey";
150 NSString *WebFrameCanSuspendActiveDOMObjects = @"WebFrameCanSuspendActiveDOMObjectsKey";
151
152 // FIXME: Remove when this key becomes publicly defined
153 NSString *NSAccessibilityEnhancedUserInterfaceAttribute = @"AXEnhancedUserInterface";
154
155 @implementation WebFramePrivate
156
157 - (void)dealloc
158 {
159     [webFrameView release];
160
161     delete scriptDebugger;
162
163     [super dealloc];
164 }
165
166 - (void)finalize
167 {
168     delete scriptDebugger;
169
170     [super finalize];
171 }
172
173 - (void)setWebFrameView:(WebFrameView *)v 
174
175     [v retain];
176     [webFrameView release];
177     webFrameView = v;
178 }
179
180 @end
181
182 EditableLinkBehavior core(WebKitEditableLinkBehavior editableLinkBehavior)
183 {
184     switch (editableLinkBehavior) {
185         case WebKitEditableLinkDefaultBehavior:
186             return EditableLinkDefaultBehavior;
187         case WebKitEditableLinkAlwaysLive:
188             return EditableLinkAlwaysLive;
189         case WebKitEditableLinkOnlyLiveWithShiftKey:
190             return EditableLinkOnlyLiveWithShiftKey;
191         case WebKitEditableLinkLiveWhenNotFocused:
192             return EditableLinkLiveWhenNotFocused;
193         case WebKitEditableLinkNeverLive:
194             return EditableLinkNeverLive;
195     }
196     ASSERT_NOT_REACHED();
197     return EditableLinkDefaultBehavior;
198 }
199
200 WebCore::EditingBehaviorType core(WebKitEditingBehavior behavior)
201 {
202     switch (behavior) {
203         case WebKitEditingMacBehavior:
204             return WebCore::EditingMacBehavior;
205         case WebKitEditingWinBehavior:
206             return WebCore::EditingWindowsBehavior;
207         case WebKitEditingUnixBehavior:
208             return WebCore::EditingUnixBehavior;
209     }
210     ASSERT_NOT_REACHED();
211     return WebCore::EditingMacBehavior;
212 }
213
214 TextDirectionSubmenuInclusionBehavior core(WebTextDirectionSubmenuInclusionBehavior behavior)
215 {
216     switch (behavior) {
217         case WebTextDirectionSubmenuNeverIncluded:
218             return TextDirectionSubmenuNeverIncluded;
219         case WebTextDirectionSubmenuAutomaticallyIncluded:
220             return TextDirectionSubmenuAutomaticallyIncluded;
221         case WebTextDirectionSubmenuAlwaysIncluded:
222             return TextDirectionSubmenuAlwaysIncluded;
223     }
224     ASSERT_NOT_REACHED();
225     return TextDirectionSubmenuNeverIncluded;
226 }
227
228 @implementation WebFrame (WebInternal)
229
230 Frame* core(WebFrame *frame)
231 {
232     return frame ? frame->_private->coreFrame : 0;
233 }
234
235 WebFrame *kit(Frame* frame)
236 {
237     return frame ? static_cast<WebFrameLoaderClient*>(frame->loader()->client())->webFrame() : nil;
238 }
239
240 Page* core(WebView *webView)
241 {
242     return [webView page];
243 }
244
245 WebView *kit(Page* page)
246 {
247     return page ? static_cast<WebChromeClient*>(page->chrome()->client())->webView() : nil;
248 }
249
250 WebView *getWebView(WebFrame *webFrame)
251 {
252     Frame* coreFrame = core(webFrame);
253     if (!coreFrame)
254         return nil;
255     return kit(coreFrame->page());
256 }
257
258 + (PassRefPtr<Frame>)_createFrameWithPage:(Page*)page frameName:(const String&)name frameView:(WebFrameView *)frameView ownerElement:(HTMLFrameOwnerElement*)ownerElement
259 {
260     WebView *webView = kit(page);
261
262     WebFrame *frame = [[self alloc] _initWithWebFrameView:frameView webView:webView];
263     RefPtr<Frame> coreFrame = Frame::create(page, ownerElement, new WebFrameLoaderClient(frame));
264     [frame release];
265     frame->_private->coreFrame = coreFrame.get();
266
267     coreFrame->tree()->setName(name);
268     if (ownerElement) {
269         ASSERT(ownerElement->document()->frame());
270         ownerElement->document()->frame()->tree()->appendChild(coreFrame.get());
271     }
272
273     coreFrame->init();
274
275     [webView _setZoomMultiplier:[webView _realZoomMultiplier] isTextOnly:[webView _realZoomMultiplierIsTextOnly]];
276
277     return coreFrame.release();
278 }
279
280 + (void)_createMainFrameWithPage:(Page*)page frameName:(const String&)name frameView:(WebFrameView *)frameView
281 {
282     [self _createFrameWithPage:page frameName:name frameView:frameView ownerElement:0];
283 }
284
285 + (PassRefPtr<WebCore::Frame>)_createSubframeWithOwnerElement:(HTMLFrameOwnerElement*)ownerElement frameName:(const String&)name frameView:(WebFrameView *)frameView
286 {
287     return [self _createFrameWithPage:ownerElement->document()->frame()->page() frameName:name frameView:frameView ownerElement:ownerElement];
288 }
289
290 - (BOOL)_isIncludedInWebKitStatistics
291 {
292     return _private && _private->includedInWebKitStatistics;
293 }
294
295 - (void)_attachScriptDebugger
296 {
297     ScriptController* scriptController = _private->coreFrame->script();
298
299     // Calling ScriptController::globalObject() would create a window shell, and dispatch corresponding callbacks, which may be premature
300     // if the script debugger is attached before a document is created.  These calls use the debuggerWorld(), we will need to pass a world
301     // to be able to debug isolated worlds.
302     if (!scriptController->existingWindowShell(debuggerWorld()))
303         return;
304
305     JSGlobalObject* globalObject = scriptController->globalObject(debuggerWorld());
306     if (!globalObject)
307         return;
308
309     if (_private->scriptDebugger) {
310         ASSERT(_private->scriptDebugger == globalObject->debugger());
311         return;
312     }
313
314     _private->scriptDebugger = new WebScriptDebugger(globalObject);
315 }
316
317 - (void)_detachScriptDebugger
318 {
319     if (!_private->scriptDebugger)
320         return;
321
322     delete _private->scriptDebugger;
323     _private->scriptDebugger = 0;
324 }
325
326 - (id)_initWithWebFrameView:(WebFrameView *)fv webView:(WebView *)v
327 {
328     self = [super init];
329     if (!self)
330         return nil;
331
332     _private = [[WebFramePrivate alloc] init];
333
334     // Set includedInWebKitStatistics before calling WebFrameView _setWebFrame, since
335     // it calls WebFrame _isIncludedInWebKitStatistics.
336     if ((_private->includedInWebKitStatistics = [[v class] shouldIncludeInWebKitStatistics]))
337         ++WebFrameCount;
338
339     if (fv) {
340         [_private setWebFrameView:fv];
341         [fv _setWebFrame:self];
342     }
343
344     _private->shouldCreateRenderers = YES;
345
346     return self;
347 }
348
349 - (void)_clearCoreFrame
350 {
351     _private->coreFrame = 0;
352 }
353
354 - (void)_updateBackgroundAndUpdatesWhileOffscreen
355 {
356     WebView *webView = getWebView(self);
357     BOOL drawsBackground = [webView drawsBackground];
358     NSColor *backgroundColor = [webView backgroundColor];
359
360     Frame* coreFrame = _private->coreFrame;
361     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
362         if ([webView _usesDocumentViews]) {
363             // Don't call setDrawsBackground:YES here because it may be NO because of a load
364             // in progress; WebFrameLoaderClient keeps it set to NO during the load process.
365             WebFrame *webFrame = kit(frame);
366             if (!drawsBackground)
367                 [[[webFrame frameView] _scrollView] setDrawsBackground:NO];
368             [[[webFrame frameView] _scrollView] setBackgroundColor:backgroundColor];
369             id documentView = [[webFrame frameView] documentView];
370             if ([documentView respondsToSelector:@selector(setDrawsBackground:)])
371                 [documentView setDrawsBackground:drawsBackground];
372             if ([documentView respondsToSelector:@selector(setBackgroundColor:)])
373                 [documentView setBackgroundColor:backgroundColor];
374         }
375
376         if (FrameView* view = frame->view()) {
377             view->setTransparent(!drawsBackground);
378             view->setBaseBackgroundColor(colorFromNSColor([backgroundColor colorUsingColorSpaceName:NSDeviceRGBColorSpace]));
379             view->setShouldUpdateWhileOffscreen([webView shouldUpdateWhileOffscreen]);
380         }
381     }
382 }
383
384 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate
385 {
386     _private->internalLoadDelegate = internalLoadDelegate;
387 }
388
389 - (id)_internalLoadDelegate
390 {
391     return _private->internalLoadDelegate;
392 }
393
394 #ifndef BUILDING_ON_TIGER
395 - (void)_unmarkAllBadGrammar
396 {
397     Frame* coreFrame = _private->coreFrame;
398     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
399         if (Document* document = frame->document())
400             document->markers()->removeMarkers(DocumentMarker::Grammar);
401     }
402 }
403 #endif
404
405 - (void)_unmarkAllMisspellings
406 {
407     Frame* coreFrame = _private->coreFrame;
408     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
409         if (Document* document = frame->document())
410             document->markers()->removeMarkers(DocumentMarker::Spelling);
411     }
412 }
413
414 - (BOOL)_hasSelection
415 {
416     if ([getWebView(self) _usesDocumentViews]) {
417         id documentView = [_private->webFrameView documentView];    
418
419         // optimization for common case to avoid creating potentially large selection string
420         if ([documentView isKindOfClass:[WebHTMLView class]])
421             if (Frame* coreFrame = _private->coreFrame)
422                 return coreFrame->selection()->isRange();
423
424         if ([documentView conformsToProtocol:@protocol(WebDocumentText)])
425             return [[documentView selectedString] length] > 0;
426         
427         return NO;
428     }
429
430     Frame* coreFrame = _private->coreFrame;
431     return coreFrame && coreFrame->selection()->isRange();
432 }
433
434 - (void)_clearSelection
435 {
436     ASSERT([getWebView(self) _usesDocumentViews]);
437     id documentView = [_private->webFrameView documentView];    
438     if ([documentView conformsToProtocol:@protocol(WebDocumentText)])
439         [documentView deselectAll];
440 }
441
442 #if !ASSERT_DISABLED
443 - (BOOL)_atMostOneFrameHasSelection
444 {
445     // FIXME: 4186050 is one known case that makes this debug check fail.
446     BOOL found = NO;
447     Frame* coreFrame = _private->coreFrame;
448     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame))
449         if ([kit(frame) _hasSelection]) {
450             if (found)
451                 return NO;
452             found = YES;
453         }
454     return YES;
455 }
456 #endif
457
458 - (WebFrame *)_findFrameWithSelection
459 {
460     Frame* coreFrame = _private->coreFrame;
461     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
462         WebFrame *webFrame = kit(frame);
463         if ([webFrame _hasSelection])
464             return webFrame;
465     }
466     return nil;
467 }
468
469 - (void)_clearSelectionInOtherFrames
470 {
471     // We rely on WebDocumentSelection protocol implementors to call this method when they become first 
472     // responder. It would be nicer to just notice first responder changes here instead, but there's no 
473     // notification sent when the first responder changes in general (Radar 2573089).
474     WebFrame *frameWithSelection = [[getWebView(self) mainFrame] _findFrameWithSelection];
475     if (frameWithSelection != self)
476         [frameWithSelection _clearSelection];
477
478     // While we're in the general area of selection and frames, check that there is only one now.
479     ASSERT([[getWebView(self) mainFrame] _atMostOneFrameHasSelection]);
480 }
481
482 static inline WebDataSource *dataSource(DocumentLoader* loader)
483 {
484     return loader ? static_cast<WebDocumentLoaderMac*>(loader)->dataSource() : nil;
485 }
486
487 - (WebDataSource *)_dataSource
488 {
489     return dataSource(_private->coreFrame->loader()->documentLoader());
490 }
491
492 - (NSString *)_stringWithDocumentTypeStringAndMarkupString:(NSString *)markupString
493 {
494     return _private->coreFrame->documentTypeString() + markupString;
495 }
496
497 - (NSArray *)_nodesFromList:(Vector<Node*> *)nodesVector
498 {
499     size_t size = nodesVector->size();
500     NSMutableArray *nodes = [NSMutableArray arrayWithCapacity:size];
501     for (size_t i = 0; i < size; ++i)
502         [nodes addObject:kit((*nodesVector)[i])];
503     return nodes;
504 }
505
506 - (NSString *)_markupStringFromRange:(DOMRange *)range nodes:(NSArray **)nodes
507 {
508     // FIXME: This is always "for interchange". Is that right? See the previous method.
509     Vector<Node*> nodeList;
510     NSString *markupString = createMarkup(core(range), nodes ? &nodeList : 0, AnnotateForInterchange);
511     if (nodes)
512         *nodes = [self _nodesFromList:&nodeList];
513
514     return [self _stringWithDocumentTypeStringAndMarkupString:markupString];
515 }
516
517 - (NSString *)_selectedString
518 {
519     return _private->coreFrame->displayStringModifiedByEncoding(_private->coreFrame->editor()->selectedText());
520 }
521
522 - (NSString *)_stringForRange:(DOMRange *)range
523 {
524     // This will give a system malloc'd buffer that can be turned directly into an NSString
525     unsigned length;
526     UChar* buf = plainTextToMallocAllocatedBuffer(core(range), length, true);
527     
528     if (!buf)
529         return [NSString string];
530
531     // Transfer buffer ownership to NSString
532     return [[[NSString alloc] initWithCharactersNoCopy:buf length:length freeWhenDone:YES] autorelease];
533 }
534
535 - (BOOL)_shouldFlattenCompositingLayers:(CGContextRef)context
536 {
537     // -currentContextDrawingToScreen returns YES for bitmap contexts.
538     BOOL isPrinting = ![NSGraphicsContext currentContextDrawingToScreen];
539     if (isPrinting)
540         return YES;
541
542     if (!WKCGContextIsBitmapContext(context))
543         return NO;
544
545     // If we're drawing into a bitmap, we might be snapshotting, or drawing into a layer-backed view.
546     if ([getWebView(self) _usesDocumentViews]) {
547         id documentView = [_private->webFrameView documentView];
548         if ([documentView isKindOfClass:[WebHTMLView class]] && [(WebHTMLView *)documentView _web_isDrawingIntoLayer])
549             return NO;
550     }
551
552     return [getWebView(self) _includesFlattenedCompositingLayersWhenDrawingToBitmap];
553 }
554
555 - (void)_drawRect:(NSRect)rect contentsOnly:(BOOL)contentsOnly
556 {
557     ASSERT([[NSGraphicsContext currentContext] isFlipped]);
558
559     CGContextRef ctx = static_cast<CGContextRef>([[NSGraphicsContext currentContext] graphicsPort]);
560     GraphicsContext context(ctx);
561
562     FrameView* view = _private->coreFrame->view();
563     
564     bool shouldFlatten = false;
565     if (Frame* parentFrame = _private->coreFrame->tree()->parent()) {
566         // For subframes, we need to inherit the paint behavior from our parent
567         FrameView* parentView = parentFrame ? parentFrame->view() : 0;
568         if (parentView)
569             shouldFlatten = parentView->paintBehavior() & PaintBehaviorFlattenCompositingLayers;
570     } else
571         shouldFlatten = [self _shouldFlattenCompositingLayers:ctx];
572
573     PaintBehavior oldBehavior = PaintBehaviorNormal;
574     if (shouldFlatten) {
575         oldBehavior = view->paintBehavior();
576         view->setPaintBehavior(oldBehavior | PaintBehaviorFlattenCompositingLayers);
577     }
578     
579     if (contentsOnly)
580         _private->coreFrame->view()->paintContents(&context, enclosingIntRect(rect));
581     else
582         _private->coreFrame->view()->paint(&context, enclosingIntRect(rect));
583
584     if (shouldFlatten)
585         view->setPaintBehavior(oldBehavior);
586 }
587
588 // Used by pagination code called from AppKit when a standalone web page is printed.
589 - (NSArray*)_computePageRectsWithPrintWidthScaleFactor:(float)printWidthScaleFactor printHeight:(float)printHeight
590 {
591     NSMutableArray* pages = [NSMutableArray arrayWithCapacity:5];
592     if (printWidthScaleFactor <= 0) {
593         LOG_ERROR("printWidthScaleFactor has bad value %.2f", printWidthScaleFactor);
594         return pages;
595     }
596     
597     if (printHeight <= 0) {
598         LOG_ERROR("printHeight has bad value %.2f", printHeight);
599         return pages;
600     }
601
602     if (!_private->coreFrame || !_private->coreFrame->document() || !_private->coreFrame->view()) return pages;
603     RenderView* root = toRenderView(_private->coreFrame->document()->renderer());
604     if (!root) return pages;
605     
606     FrameView* view = _private->coreFrame->view();
607     if (!view)
608         return pages;
609
610     NSView* documentView = view->documentView();
611     if (!documentView)
612         return pages;
613
614     float docWidth = root->layer()->width();
615     float printWidth = docWidth / printWidthScaleFactor;
616
617     PrintContext printContext(_private->coreFrame);
618     printContext.computePageRectsWithPageSize(FloatSize(printWidth, printHeight), true);
619
620     const Vector<IntRect>& pageRects = printContext.pageRects();
621     const size_t pageCount = pageRects.size();
622     for (size_t pageNumber = 0; pageNumber < pageCount; ++pageNumber)
623         [pages addObject: [NSValue valueWithRect: NSRect(pageRects[pageNumber])]];
624     return pages;
625 }
626
627 - (BOOL)_getVisibleRect:(NSRect*)rect
628 {
629     ASSERT_ARG(rect, rect);
630     if (RenderPart* ownerRenderer = _private->coreFrame->ownerRenderer()) {
631         if (ownerRenderer->needsLayout())
632             return NO;
633         *rect = ownerRenderer->absoluteClippedOverflowRect();
634         return YES;
635     }
636
637     return NO;
638 }
639
640 - (NSString *)_stringByEvaluatingJavaScriptFromString:(NSString *)string
641 {
642     return [self _stringByEvaluatingJavaScriptFromString:string forceUserGesture:true];
643 }
644
645 - (NSString *)_stringByEvaluatingJavaScriptFromString:(NSString *)string forceUserGesture:(BOOL)forceUserGesture
646 {
647     ASSERT(_private->coreFrame->document());
648     
649     JSValue result = _private->coreFrame->script()->executeScript(string, forceUserGesture).jsValue();
650
651     if (!_private->coreFrame) // In case the script removed our frame from the page.
652         return @"";
653
654     // This bizarre set of rules matches behavior from WebKit for Safari 2.0.
655     // If you don't like it, use -[WebScriptObject evaluateWebScript:] or 
656     // JSEvaluateScript instead, since they have less surprising semantics.
657     if (!result || (!result.isBoolean() && !result.isString() && !result.isNumber()))
658         return @"";
659
660     JSLock lock(SilenceAssertionsOnly);
661     return ustringToString(result.toString(_private->coreFrame->script()->globalObject(mainThreadNormalWorld())->globalExec()));
662 }
663
664 - (NSRect)_caretRectAtNode:(DOMNode *)node offset:(int)offset affinity:(NSSelectionAffinity)affinity
665 {
666     VisiblePosition visiblePosition(core(node), offset, static_cast<EAffinity>(affinity));
667     return visiblePosition.absoluteCaretBounds();
668 }
669
670 - (NSRect)_firstRectForDOMRange:(DOMRange *)range
671 {
672    return _private->coreFrame->editor()->firstRectForRange(core(range));
673 }
674
675 - (void)_scrollDOMRangeToVisible:(DOMRange *)range
676 {
677     NSRect rangeRect = [self _firstRectForDOMRange:range];    
678     Node *startNode = core([range startContainer]);
679         
680     if (startNode && startNode->renderer()) {
681         RenderLayer *layer = startNode->renderer()->enclosingLayer();
682         if (layer)
683             layer->scrollRectToVisible(enclosingIntRect(rangeRect), false, ScrollAlignment::alignToEdgeIfNeeded, ScrollAlignment::alignToEdgeIfNeeded);
684     }
685 }
686
687 - (BOOL)_needsLayout
688 {
689     return _private->coreFrame->view() ? _private->coreFrame->view()->needsLayout() : false;
690 }
691
692 - (DOMRange *)_rangeByAlteringCurrentSelection:(SelectionController::EAlteration)alteration direction:(SelectionDirection)direction granularity:(TextGranularity)granularity
693 {
694     if (_private->coreFrame->selection()->isNone())
695         return nil;
696
697     SelectionController selection;
698     selection.setSelection(_private->coreFrame->selection()->selection());
699     selection.modify(alteration, direction, granularity);
700     return kit(selection.toNormalizedRange().get());
701 }
702
703 - (TextGranularity)_selectionGranularity
704 {
705     return _private->coreFrame->selection()->granularity();
706 }
707
708 - (NSRange)_convertToNSRange:(Range *)range
709 {
710     if (!range || !range->startContainer())
711         return NSMakeRange(NSNotFound, 0);
712
713     Element* selectionRoot = _private->coreFrame->selection()->rootEditableElement();
714     Element* scope = selectionRoot ? selectionRoot : _private->coreFrame->document()->documentElement();
715     
716     // Mouse events may cause TSM to attempt to create an NSRange for a portion of the view
717     // that is not inside the current editable region.  These checks ensure we don't produce
718     // potentially invalid data when responding to such requests.
719     if (range->startContainer() != scope && !range->startContainer()->isDescendantOf(scope))
720         return NSMakeRange(NSNotFound, 0);
721     if (range->endContainer() != scope && !range->endContainer()->isDescendantOf(scope))
722         return NSMakeRange(NSNotFound, 0);
723     
724     RefPtr<Range> testRange = Range::create(scope->document(), scope, 0, range->startContainer(), range->startOffset());
725     ASSERT(testRange->startContainer() == scope);
726     int startPosition = TextIterator::rangeLength(testRange.get());
727
728     ExceptionCode ec;
729     testRange->setEnd(range->endContainer(), range->endOffset(), ec);
730     ASSERT(testRange->startContainer() == scope);
731     int endPosition = TextIterator::rangeLength(testRange.get());
732
733     return NSMakeRange(startPosition, endPosition - startPosition);
734 }
735
736 - (PassRefPtr<Range>)_convertToDOMRange:(NSRange)nsrange
737 {
738     if (nsrange.location > INT_MAX)
739         return 0;
740     if (nsrange.length > INT_MAX || nsrange.location + nsrange.length > INT_MAX)
741         nsrange.length = INT_MAX - nsrange.location;
742
743     // our critical assumption is that we are only called by input methods that
744     // concentrate on a given area containing the selection
745     // We have to do this because of text fields and textareas. The DOM for those is not
746     // directly in the document DOM, so serialization is problematic. Our solution is
747     // to use the root editable element of the selection start as the positional base.
748     // That fits with AppKit's idea of an input context.
749     Element* selectionRoot = _private->coreFrame->selection()->rootEditableElement();
750     Element* scope = selectionRoot ? selectionRoot : _private->coreFrame->document()->documentElement();
751     return TextIterator::rangeFromLocationAndLength(scope, nsrange.location, nsrange.length);
752 }
753
754 - (DOMRange *)convertNSRangeToDOMRange:(NSRange)nsrange
755 {
756     // This method exists to maintain compatibility with Leopard's Dictionary.app. <rdar://problem/6002160>
757     return [self _convertNSRangeToDOMRange:nsrange];
758 }
759
760 - (DOMRange *)_convertNSRangeToDOMRange:(NSRange)nsrange
761 {
762     return kit([self _convertToDOMRange:nsrange].get());
763 }
764
765 - (NSRange)convertDOMRangeToNSRange:(DOMRange *)range
766 {
767     // This method exists to maintain compatibility with Leopard's Dictionary.app. <rdar://problem/6002160>
768     return [self _convertDOMRangeToNSRange:range];
769 }
770
771 - (NSRange)_convertDOMRangeToNSRange:(DOMRange *)range
772 {
773     return [self _convertToNSRange:core(range)];
774 }
775
776 - (DOMRange *)_markDOMRange
777 {
778     return kit(_private->coreFrame->editor()->mark().toNormalizedRange().get());
779 }
780
781 // Given proposedRange, returns an extended range that includes adjacent whitespace that should
782 // be deleted along with the proposed range in order to preserve proper spacing and punctuation of
783 // the text surrounding the deletion.
784 - (DOMRange *)_smartDeleteRangeForProposedRange:(DOMRange *)proposedRange
785 {
786     Node* startContainer = core([proposedRange startContainer]);
787     Node* endContainer = core([proposedRange endContainer]);
788     if (startContainer == nil || endContainer == nil)
789         return nil;
790
791     ASSERT(startContainer->document() == endContainer->document());
792     
793     _private->coreFrame->document()->updateLayoutIgnorePendingStylesheets();
794
795     Position start(startContainer, [proposedRange startOffset]);
796     Position end(endContainer, [proposedRange endOffset]);
797     Position newStart = start.upstream().leadingWhitespacePosition(DOWNSTREAM, true);
798     if (newStart.isNull())
799         newStart = start;
800     Position newEnd = end.downstream().trailingWhitespacePosition(DOWNSTREAM, true);
801     if (newEnd.isNull())
802         newEnd = end;
803
804     newStart = rangeCompliantEquivalent(newStart);
805     newEnd = rangeCompliantEquivalent(newEnd);
806
807     RefPtr<Range> range = _private->coreFrame->document()->createRange();
808     int exception = 0;
809     range->setStart(newStart.node(), newStart.deprecatedEditingOffset(), exception);
810     range->setEnd(newStart.node(), newStart.deprecatedEditingOffset(), exception);
811     return kit(range.get());
812 }
813
814 - (DOMDocumentFragment *)_documentFragmentWithMarkupString:(NSString *)markupString baseURLString:(NSString *)baseURLString 
815 {
816     if (!_private->coreFrame || !_private->coreFrame->document())
817         return nil;
818
819     return kit(createFragmentFromMarkup(_private->coreFrame->document(), markupString, baseURLString, FragmentScriptingNotAllowed).get());
820 }
821
822 - (DOMDocumentFragment *)_documentFragmentWithNodesAsParagraphs:(NSArray *)nodes
823 {
824     if (!_private->coreFrame || !_private->coreFrame->document())
825         return nil;
826     
827     NSEnumerator *nodeEnum = [nodes objectEnumerator];
828     Vector<Node*> nodesVector;
829     DOMNode *node;
830     while ((node = [nodeEnum nextObject]))
831         nodesVector.append(core(node));
832     
833     return kit(createFragmentFromNodes(_private->coreFrame->document(), nodesVector).get());
834 }
835
836 - (void)_replaceSelectionWithNode:(DOMNode *)node selectReplacement:(BOOL)selectReplacement smartReplace:(BOOL)smartReplace matchStyle:(BOOL)matchStyle
837 {
838     DOMDocumentFragment *fragment = kit(_private->coreFrame->document()->createDocumentFragment().get());
839     [fragment appendChild:node];
840     [self _replaceSelectionWithFragment:fragment selectReplacement:selectReplacement smartReplace:smartReplace matchStyle:matchStyle];
841 }
842
843 - (void)_insertParagraphSeparatorInQuotedContent
844 {
845     if (_private->coreFrame->selection()->isNone())
846         return;
847     
848     TypingCommand::insertParagraphSeparatorInQuotedContent(_private->coreFrame->document());
849     _private->coreFrame->selection()->revealSelection(ScrollAlignment::alignToEdgeIfNeeded);
850 }
851
852 - (VisiblePosition)_visiblePositionForPoint:(NSPoint)point
853 {
854     // FIXME: Someone with access to Apple's sources could remove this needless wrapper call.
855     return _private->coreFrame->visiblePositionForPoint(IntPoint(point));
856 }
857
858 - (DOMRange *)_characterRangeAtPoint:(NSPoint)point
859 {
860     VisiblePosition position = [self _visiblePositionForPoint:point];
861     if (position.isNull())
862         return nil;
863     
864     VisiblePosition previous = position.previous();
865     if (previous.isNotNull()) {
866         DOMRange *previousCharacterRange = kit(makeRange(previous, position).get());
867         NSRect rect = [self _firstRectForDOMRange:previousCharacterRange];
868         if (NSPointInRect(point, rect))
869             return previousCharacterRange;
870     }
871
872     VisiblePosition next = position.next();
873     if (next.isNotNull()) {
874         DOMRange *nextCharacterRange = kit(makeRange(position, next).get());
875         NSRect rect = [self _firstRectForDOMRange:nextCharacterRange];
876         if (NSPointInRect(point, rect))
877             return nextCharacterRange;
878     }
879     
880     return nil;
881 }
882
883 - (DOMCSSStyleDeclaration *)_typingStyle
884 {
885     if (!_private->coreFrame)
886         return nil;
887     RefPtr<CSSMutableStyleDeclaration> typingStyle = _private->coreFrame->selection()->copyTypingStyle();
888     if (!typingStyle)
889         return nil;
890     return kit(typingStyle.get());
891 }
892
893 - (void)_setTypingStyle:(DOMCSSStyleDeclaration *)style withUndoAction:(EditAction)undoAction
894 {
895     if (!_private->coreFrame)
896         return;
897     _private->coreFrame->editor()->computeAndSetTypingStyle(core(style), undoAction);
898 }
899
900 - (void)_dragSourceEndedAt:(NSPoint)windowLoc operation:(NSDragOperation)operation
901 {
902     if (!_private->coreFrame)
903         return;
904     FrameView* view = _private->coreFrame->view();
905     if (!view)
906         return;
907     ASSERT([getWebView(self) _usesDocumentViews]);
908     // FIXME: These are fake modifier keys here, but they should be real ones instead.
909     PlatformMouseEvent event(IntPoint(windowLoc), globalPoint(windowLoc, [view->platformWidget() window]),
910         LeftButton, MouseEventMoved, 0, false, false, false, false, currentTime());
911     _private->coreFrame->eventHandler()->dragSourceEndedAt(event, (DragOperation)operation);
912 }
913
914 - (BOOL)_canProvideDocumentSource
915 {
916     Frame* frame = _private->coreFrame;
917     String mimeType = frame->loader()->writer()->mimeType();
918     PluginData* pluginData = frame->page() ? frame->page()->pluginData() : 0;
919
920     if (WebCore::DOMImplementation::isTextMIMEType(mimeType) ||
921         Image::supportsType(mimeType) ||
922         (pluginData && pluginData->supportsMimeType(mimeType)))
923         return NO;
924
925     return YES;
926 }
927
928 - (BOOL)_canSaveAsWebArchive
929 {
930     // Currently, all documents that we can view source for
931     // (HTML and XML documents) can also be saved as web archives
932     return [self _canProvideDocumentSource];
933 }
934
935 - (void)_commitData:(NSData *)data
936 {
937     // FIXME: This really should be a setting.
938     Document* document = _private->coreFrame->document();
939     document->setShouldCreateRenderers(_private->shouldCreateRenderers);
940
941     _private->coreFrame->loader()->documentLoader()->commitData((const char *)[data bytes], [data length]);
942 }
943
944 @end
945
946 @implementation WebFrame (WebPrivate)
947
948 // FIXME: This exists only as a convenience for Safari, consider moving there.
949 - (BOOL)_isDescendantOfFrame:(WebFrame *)ancestor
950 {
951     Frame* coreFrame = _private->coreFrame;
952     return coreFrame && coreFrame->tree()->isDescendantOf(core(ancestor));
953 }
954
955 - (void)_setShouldCreateRenderers:(BOOL)shouldCreateRenderers
956 {
957     _private->shouldCreateRenderers = shouldCreateRenderers;
958 }
959
960 - (NSColor *)_bodyBackgroundColor
961 {
962     Document* document = _private->coreFrame->document();
963     if (!document)
964         return nil;
965     HTMLElement* body = document->body();
966     if (!body)
967         return nil;
968     RenderObject* bodyRenderer = body->renderer();
969     if (!bodyRenderer)
970         return nil;
971     Color color = bodyRenderer->style()->visitedDependentColor(CSSPropertyBackgroundColor);
972     if (!color.isValid())
973         return nil;
974     return nsColor(color);
975 }
976
977 - (BOOL)_isFrameSet
978 {
979     Document* document = _private->coreFrame->document();
980     return document && document->isFrameSet();
981 }
982
983 - (BOOL)_firstLayoutDone
984 {
985     return _private->coreFrame->loader()->stateMachine()->firstLayoutDone();
986 }
987
988 - (WebFrameLoadType)_loadType
989 {
990     return (WebFrameLoadType)_private->coreFrame->loader()->loadType();
991 }
992
993 - (NSRange)_selectedNSRange
994 {
995     return [self _convertToNSRange:_private->coreFrame->selection()->toNormalizedRange().get()];
996 }
997
998 - (void)_selectNSRange:(NSRange)range
999 {
1000     RefPtr<Range> domRange = [self _convertToDOMRange:range];
1001     if (domRange)
1002         _private->coreFrame->selection()->setSelection(VisibleSelection(domRange.get(), SEL_DEFAULT_AFFINITY));
1003 }
1004
1005 - (BOOL)_isDisplayingStandaloneImage
1006 {
1007     Document* document = _private->coreFrame->document();
1008     return document && document->isImageDocument();
1009 }
1010
1011 - (unsigned)_pendingFrameUnloadEventCount
1012 {
1013     return _private->coreFrame->domWindow()->pendingUnloadEventListeners();
1014 }
1015
1016 - (void)_setIsDisconnected:(bool)isDisconnected
1017 {
1018     _private->coreFrame->setIsDisconnected(isDisconnected);
1019 }
1020
1021 - (void)_setExcludeFromTextSearch:(bool)exclude
1022 {
1023     _private->coreFrame->setExcludeFromTextSearch(exclude);
1024 }
1025
1026 #if ENABLE(NETSCAPE_PLUGIN_API)
1027 - (void)_recursive_resumeNullEventsForAllNetscapePlugins
1028 {
1029     Frame* coreFrame = core(self);
1030     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
1031         NSView <WebDocumentView> *documentView = [[kit(frame) frameView] documentView];
1032         if ([documentView isKindOfClass:[WebHTMLView class]])
1033             [(WebHTMLView *)documentView _resumeNullEventsForAllNetscapePlugins];
1034     }
1035 }
1036
1037 - (void)_recursive_pauseNullEventsForAllNetscapePlugins
1038 {
1039     Frame* coreFrame = core(self);
1040     for (Frame* frame = coreFrame; frame; frame = frame->tree()->traverseNext(coreFrame)) {
1041         NSView <WebDocumentView> *documentView = [[kit(frame) frameView] documentView];
1042         if ([documentView isKindOfClass:[WebHTMLView class]])
1043             [(WebHTMLView *)documentView _pauseNullEventsForAllNetscapePlugins];
1044     }
1045 }
1046 #endif
1047
1048 - (BOOL)_pauseAnimation:(NSString*)name onNode:(DOMNode *)node atTime:(NSTimeInterval)time
1049 {
1050     Frame* frame = core(self);
1051     if (!frame)
1052         return false;
1053
1054     AnimationController* controller = frame->animation();
1055     if (!controller)
1056         return false;
1057
1058     Node* coreNode = core(node);
1059     if (!coreNode || !coreNode->renderer())
1060         return false;
1061
1062     return controller->pauseAnimationAtTime(coreNode->renderer(), name, time);
1063 }
1064
1065 - (BOOL)_pauseTransitionOfProperty:(NSString*)name onNode:(DOMNode*)node atTime:(NSTimeInterval)time
1066 {
1067     Frame* frame = core(self);
1068     if (!frame)
1069         return false;
1070
1071     AnimationController* controller = frame->animation();
1072     if (!controller)
1073         return false;
1074
1075     Node* coreNode = core(node);
1076     if (!coreNode || !coreNode->renderer())
1077         return false;
1078
1079     return controller->pauseTransitionAtTime(coreNode->renderer(), name, time);
1080 }
1081
1082 // Pause a given SVG animation on the target node at a specific time.
1083 // This method is only intended to be used for testing the SVG animation system.
1084 - (BOOL)_pauseSVGAnimation:(NSString*)elementId onSMILNode:(DOMNode *)node atTime:(NSTimeInterval)time
1085 {
1086     Frame* frame = core(self);
1087     if (!frame)
1088         return false;
1089  
1090     Document* document = frame->document();
1091     if (!document || !document->svgExtensions())
1092         return false;
1093
1094     Node* coreNode = core(node);
1095     if (!coreNode || !SVGSMILElement::isSMILElement(coreNode))
1096         return false;
1097
1098 #if ENABLE(SVG)
1099     return document->accessSVGExtensions()->sampleAnimationAtTime(elementId, static_cast<SVGSMILElement*>(coreNode), time);
1100 #else
1101     return false;
1102 #endif
1103 }
1104
1105 - (unsigned) _numberOfActiveAnimations
1106 {
1107     Frame* frame = core(self);
1108     if (!frame)
1109         return false;
1110
1111     AnimationController* controller = frame->animation();
1112     if (!controller)
1113         return false;
1114
1115     return controller->numberOfActiveAnimations();
1116 }
1117
1118 - (void) _suspendAnimations
1119 {
1120     Frame* frame = core(self);
1121     if (!frame)
1122         return;
1123         
1124     frame->animation()->suspendAnimations();
1125 }
1126
1127 - (void) _resumeAnimations
1128 {
1129     Frame* frame = core(self);
1130     if (!frame)
1131         return;
1132
1133     frame->animation()->resumeAnimations();
1134 }
1135
1136 - (void)_replaceSelectionWithFragment:(DOMDocumentFragment *)fragment selectReplacement:(BOOL)selectReplacement smartReplace:(BOOL)smartReplace matchStyle:(BOOL)matchStyle
1137 {
1138     if (_private->coreFrame->selection()->isNone() || !fragment)
1139         return;
1140     
1141     applyCommand(ReplaceSelectionCommand::create(_private->coreFrame->document(), core(fragment), selectReplacement, smartReplace, matchStyle));
1142     _private->coreFrame->selection()->revealSelection(ScrollAlignment::alignToEdgeIfNeeded);
1143 }
1144
1145 - (void)_replaceSelectionWithText:(NSString *)text selectReplacement:(BOOL)selectReplacement smartReplace:(BOOL)smartReplace
1146 {   
1147     DOMDocumentFragment* fragment = kit(createFragmentFromText(_private->coreFrame->selection()->toNormalizedRange().get(), text).get());
1148     [self _replaceSelectionWithFragment:fragment selectReplacement:selectReplacement smartReplace:smartReplace matchStyle:YES];
1149 }
1150
1151 - (void)_replaceSelectionWithMarkupString:(NSString *)markupString baseURLString:(NSString *)baseURLString selectReplacement:(BOOL)selectReplacement smartReplace:(BOOL)smartReplace
1152 {
1153     DOMDocumentFragment *fragment = [self _documentFragmentWithMarkupString:markupString baseURLString:baseURLString];
1154     [self _replaceSelectionWithFragment:fragment selectReplacement:selectReplacement smartReplace:smartReplace matchStyle:NO];
1155 }
1156
1157 // Determines whether whitespace needs to be added around aString to preserve proper spacing and
1158 // punctuation when it's inserted into the receiver's text over charRange. Returns by reference
1159 // in beforeString and afterString any whitespace that should be added, unless either or both are
1160 // nil. Both are returned as nil if aString is nil or if smart insertion and deletion are disabled.
1161 - (void)_smartInsertForString:(NSString *)pasteString replacingRange:(DOMRange *)rangeToReplace beforeString:(NSString **)beforeString afterString:(NSString **)afterString
1162 {
1163     // give back nil pointers in case of early returns
1164     if (beforeString)
1165         *beforeString = nil;
1166     if (afterString)
1167         *afterString = nil;
1168         
1169     // inspect destination
1170     Node *startContainer = core([rangeToReplace startContainer]);
1171     Node *endContainer = core([rangeToReplace endContainer]);
1172
1173     Position startPos(startContainer, [rangeToReplace startOffset]);
1174     Position endPos(endContainer, [rangeToReplace endOffset]);
1175
1176     VisiblePosition startVisiblePos = VisiblePosition(startPos, VP_DEFAULT_AFFINITY);
1177     VisiblePosition endVisiblePos = VisiblePosition(endPos, VP_DEFAULT_AFFINITY);
1178     
1179     // this check also ensures startContainer, startPos, endContainer, and endPos are non-null
1180     if (startVisiblePos.isNull() || endVisiblePos.isNull())
1181         return;
1182
1183     bool addLeadingSpace = startPos.leadingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull() && !isStartOfParagraph(startVisiblePos);
1184     if (addLeadingSpace)
1185         if (UChar previousChar = startVisiblePos.previous().characterAfter())
1186             addLeadingSpace = !isCharacterSmartReplaceExempt(previousChar, true);
1187     
1188     bool addTrailingSpace = endPos.trailingWhitespacePosition(VP_DEFAULT_AFFINITY, true).isNull() && !isEndOfParagraph(endVisiblePos);
1189     if (addTrailingSpace)
1190         if (UChar thisChar = endVisiblePos.characterAfter())
1191             addTrailingSpace = !isCharacterSmartReplaceExempt(thisChar, false);
1192     
1193     // inspect source
1194     bool hasWhitespaceAtStart = false;
1195     bool hasWhitespaceAtEnd = false;
1196     unsigned pasteLength = [pasteString length];
1197     if (pasteLength > 0) {
1198         NSCharacterSet *whiteSet = [NSCharacterSet whitespaceAndNewlineCharacterSet];
1199         
1200         if ([whiteSet characterIsMember:[pasteString characterAtIndex:0]]) {
1201             hasWhitespaceAtStart = YES;
1202         }
1203         if ([whiteSet characterIsMember:[pasteString characterAtIndex:(pasteLength - 1)]]) {
1204             hasWhitespaceAtEnd = YES;
1205         }
1206     }
1207     
1208     // issue the verdict
1209     if (beforeString && addLeadingSpace && !hasWhitespaceAtStart)
1210         *beforeString = @" ";
1211     if (afterString && addTrailingSpace && !hasWhitespaceAtEnd)
1212         *afterString = @" ";
1213 }
1214
1215 - (NSMutableDictionary *)_cacheabilityDictionary
1216 {
1217     NSMutableDictionary *result = [NSMutableDictionary dictionary];
1218     
1219     FrameLoader* frameLoader = _private->coreFrame->loader();
1220     DocumentLoader* documentLoader = frameLoader->documentLoader();
1221     if (documentLoader && !documentLoader->mainDocumentError().isNull())
1222         [result setObject:(NSError *)documentLoader->mainDocumentError() forKey:WebFrameMainDocumentError];
1223         
1224     if (frameLoader->subframeLoader()->containsPlugins())
1225         [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameHasPlugins];
1226     
1227     if (DOMWindow* domWindow = _private->coreFrame->domWindow()) {
1228         if (domWindow->hasEventListeners(eventNames().unloadEvent))
1229             [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameHasUnloadListener];
1230             
1231 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
1232         if (domWindow->optionalApplicationCache())
1233             [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameUsesApplicationCache];
1234 #endif
1235     }
1236     
1237     if (Document* document = _private->coreFrame->document()) {
1238 #if ENABLE(DATABASE)
1239         if (document->hasOpenDatabases())
1240             [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameUsesDatabases];
1241 #endif
1242             
1243         if (document->usingGeolocation())
1244             [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameUsesGeolocation];
1245             
1246         if (!document->canSuspendActiveDOMObjects())
1247             [result setObject:[NSNumber numberWithBool:YES] forKey:WebFrameCanSuspendActiveDOMObjects];
1248     }
1249     
1250     return result;
1251 }
1252
1253 - (BOOL)_allowsFollowingLink:(NSURL *)URL
1254 {
1255     if (!_private->coreFrame)
1256         return YES;
1257     return _private->coreFrame->document()->securityOrigin()->canDisplay(URL);
1258 }
1259
1260 - (NSString *)_stringByEvaluatingJavaScriptFromString:(NSString *)string withGlobalObject:(JSObjectRef)globalObjectRef inScriptWorld:(WebScriptWorld *)world
1261 {
1262     // Start off with some guess at a frame and a global object, we'll try to do better...!
1263     JSDOMWindow* anyWorldGlobalObject = _private->coreFrame->script()->globalObject(mainThreadNormalWorld());
1264
1265     // The global object is probably a shell object? - if so, we know how to use this!
1266     JSC::JSObject* globalObjectObj = toJS(globalObjectRef);
1267     if (!strcmp(globalObjectObj->classInfo()->className, "JSDOMWindowShell"))
1268         anyWorldGlobalObject = static_cast<JSDOMWindowShell*>(globalObjectObj)->window();
1269
1270     // Get the frame frome the global object we've settled on.
1271     Frame* frame = anyWorldGlobalObject->impl()->frame();
1272     ASSERT(frame->document());
1273     JSValue result = frame->script()->executeScriptInWorld(core(world), string, true).jsValue();
1274
1275     if (!frame) // In case the script removed our frame from the page.
1276         return @"";
1277
1278     // This bizarre set of rules matches behavior from WebKit for Safari 2.0.
1279     // If you don't like it, use -[WebScriptObject evaluateWebScript:] or 
1280     // JSEvaluateScript instead, since they have less surprising semantics.
1281     if (!result || (!result.isBoolean() && !result.isString() && !result.isNumber()))
1282         return @"";
1283
1284     JSLock lock(SilenceAssertionsOnly);
1285     return ustringToString(result.toString(anyWorldGlobalObject->globalExec()));
1286 }
1287
1288 - (JSGlobalContextRef)_globalContextForScriptWorld:(WebScriptWorld *)world
1289 {
1290     Frame* coreFrame = _private->coreFrame;
1291     if (!coreFrame)
1292         return 0;
1293     DOMWrapperWorld* coreWorld = core(world);
1294     if (!coreWorld)
1295         return 0;
1296     return toGlobalRef(coreFrame->script()->globalObject(coreWorld)->globalExec());
1297 }
1298
1299 - (void)setAllowsScrollersToOverlapContent:(BOOL)flag
1300 {
1301     ASSERT([[[self frameView] _scrollView] isKindOfClass:[WebDynamicScrollBarsView class]]);
1302     [(WebDynamicScrollBarsView *)[[self frameView] _scrollView] setAllowsScrollersToOverlapContent:flag];
1303 }
1304
1305 - (void)setAlwaysHideHorizontalScroller:(BOOL)flag
1306 {
1307     ASSERT([[[self frameView] _scrollView] isKindOfClass:[WebDynamicScrollBarsView class]]);
1308     [(WebDynamicScrollBarsView *)[[self frameView] _scrollView] setAlwaysHideHorizontalScroller:flag];
1309 }
1310 - (void)setAlwaysHideVerticalScroller:(BOOL)flag
1311 {
1312     ASSERT([[[self frameView] _scrollView] isKindOfClass:[WebDynamicScrollBarsView class]]);
1313     [(WebDynamicScrollBarsView *)[[self frameView] _scrollView] setAlwaysHideVerticalScroller:flag];
1314 }
1315
1316 - (void)setAccessibleName:(NSString *)name
1317 {
1318 #if HAVE(ACCESSIBILITY)
1319     if (!AXObjectCache::accessibilityEnabled())
1320         return;
1321     
1322     if (!_private->coreFrame || !_private->coreFrame->document())
1323         return;
1324     
1325     AccessibilityObject* rootObject = _private->coreFrame->document()->axObjectCache()->rootObject();
1326     if (rootObject) {
1327         String strName(name);
1328         rootObject->setAccessibleName(strName);
1329     }
1330 #endif
1331 }
1332
1333 - (NSString*)_layerTreeAsText
1334 {
1335     Frame* coreFrame = _private->coreFrame;
1336     if (!coreFrame)
1337         return @"";
1338
1339     return coreFrame->layerTreeAsText();
1340 }
1341
1342 - (BOOL)hasSpellingMarker:(int)from length:(int)length
1343 {
1344     Frame* coreFrame = _private->coreFrame;
1345     if (!coreFrame)
1346         return NO;
1347     return coreFrame->editor()->selectionStartHasSpellingMarkerFor(from, length);
1348 }
1349
1350 - (id)accessibilityRoot
1351 {
1352 #if HAVE(ACCESSIBILITY)
1353     if (!AXObjectCache::accessibilityEnabled()) {
1354         AXObjectCache::enableAccessibility();
1355         if ([[NSApp accessibilityAttributeValue:NSAccessibilityEnhancedUserInterfaceAttribute] boolValue])
1356             AXObjectCache::enableEnhancedUserInterfaceAccessibility();
1357     }
1358     
1359     if (!_private->coreFrame || !_private->coreFrame->document())
1360         return nil;
1361     
1362     AccessibilityObject* rootObject = _private->coreFrame->document()->axObjectCache()->rootObject();
1363     if (rootObject)
1364         return rootObject->wrapper();
1365     return nil;
1366 #else
1367     return nil;
1368 #endif
1369 }
1370
1371 @end
1372
1373 @implementation WebFrame
1374
1375 - (id)init
1376 {
1377     return nil;
1378 }
1379
1380 // Should be deprecated.
1381 - (id)initWithName:(NSString *)name webFrameView:(WebFrameView *)view webView:(WebView *)webView
1382 {
1383     return nil;
1384 }
1385
1386 - (void)dealloc
1387 {
1388     if (_private && _private->includedInWebKitStatistics)
1389         --WebFrameCount;
1390
1391     [_private release];
1392
1393     [super dealloc];
1394 }
1395
1396 - (void)finalize
1397 {
1398     if (_private && _private->includedInWebKitStatistics)
1399         --WebFrameCount;
1400
1401     [super finalize];
1402 }
1403
1404 - (NSString *)name
1405 {
1406     Frame* coreFrame = _private->coreFrame;
1407     if (!coreFrame)
1408         return nil;
1409     return coreFrame->tree()->uniqueName();
1410 }
1411
1412 - (WebFrameView *)frameView
1413 {
1414     ASSERT(!getWebView(self) || [getWebView(self) _usesDocumentViews]);
1415     return _private->webFrameView;
1416 }
1417
1418 - (WebView *)webView
1419 {
1420     return getWebView(self);
1421 }
1422
1423 static bool needsMicrosoftMessengerDOMDocumentWorkaround()
1424 {
1425     static bool needsWorkaround = applicationIsMicrosoftMessenger() && [[[NSBundle mainBundle] objectForInfoDictionaryKey:(NSString *)kCFBundleVersionKey] compare:@"7.1" options:NSNumericSearch] == NSOrderedAscending;
1426     return needsWorkaround;
1427 }
1428
1429 - (DOMDocument *)DOMDocument
1430 {
1431     if (needsMicrosoftMessengerDOMDocumentWorkaround() && !pthread_main_np())
1432         return nil;
1433
1434     Frame* coreFrame = _private->coreFrame;
1435     if (!coreFrame)
1436         return nil;
1437     
1438     // FIXME: <rdar://problem/5145841> When loading a custom view/representation 
1439     // into a web frame, the old document can still be around. This makes sure that
1440     // we'll return nil in those cases.
1441     if (![[self _dataSource] _isDocumentHTML]) 
1442         return nil; 
1443
1444     Document* document = coreFrame->document();
1445     
1446     // According to the documentation, we should return nil if the frame doesn't have a document.
1447     // While full-frame images and plugins do have an underlying HTML document, we return nil here to be
1448     // backwards compatible.
1449     if (document && (document->isPluginDocument() || document->isImageDocument()))
1450         return nil;
1451     
1452     return kit(coreFrame->document());
1453 }
1454
1455 - (DOMHTMLElement *)frameElement
1456 {
1457     Frame* coreFrame = _private->coreFrame;
1458     if (!coreFrame)
1459         return nil;
1460     return kit(coreFrame->ownerElement());
1461 }
1462
1463 - (WebDataSource *)provisionalDataSource
1464 {
1465     Frame* coreFrame = _private->coreFrame;
1466     return coreFrame ? dataSource(coreFrame->loader()->provisionalDocumentLoader()) : nil;
1467 }
1468
1469 - (WebDataSource *)dataSource
1470 {
1471     Frame* coreFrame = _private->coreFrame;
1472     return coreFrame && coreFrame->loader()->frameHasLoaded() ? [self _dataSource] : nil;
1473 }
1474
1475 - (void)loadRequest:(NSURLRequest *)request
1476 {
1477     Frame* coreFrame = _private->coreFrame;
1478     if (!coreFrame)
1479         return;
1480     coreFrame->loader()->load(request, false);
1481 }
1482
1483 static NSURL *createUniqueWebDataURL()
1484 {
1485     CFUUIDRef UUIDRef = CFUUIDCreate(kCFAllocatorDefault);
1486     NSString *UUIDString = (NSString *)CFUUIDCreateString(kCFAllocatorDefault, UUIDRef);
1487     CFRelease(UUIDRef);
1488     NSURL *URL = [NSURL URLWithString:[NSString stringWithFormat:@"applewebdata://%@", UUIDString]];
1489     CFRelease(UUIDString);
1490     return URL;
1491 }
1492
1493 - (void)_loadData:(NSData *)data MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)encodingName baseURL:(NSURL *)baseURL unreachableURL:(NSURL *)unreachableURL
1494 {
1495     if (!pthread_main_np())
1496         return [[self _webkit_invokeOnMainThread] _loadData:data MIMEType:MIMEType textEncodingName:encodingName baseURL:baseURL unreachableURL:unreachableURL];
1497     
1498     KURL responseURL;
1499     if (!baseURL) {
1500         baseURL = blankURL();
1501         responseURL = createUniqueWebDataURL();
1502     }
1503     
1504     ResourceRequest request([baseURL absoluteURL]);
1505
1506     // hack because Mail checks for this property to detect data / archive loads
1507     [NSURLProtocol setProperty:@"" forKey:@"WebDataRequest" inRequest:(NSMutableURLRequest *)request.nsURLRequest()];
1508
1509     SubstituteData substituteData(WebCore::SharedBuffer::wrapNSData(data), MIMEType, encodingName, [unreachableURL absoluteURL], responseURL);
1510
1511     _private->coreFrame->loader()->load(request, substituteData, false);
1512 }
1513
1514
1515 - (void)loadData:(NSData *)data MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)encodingName baseURL:(NSURL *)baseURL
1516 {
1517     WebCoreThreadViolationCheckRoundTwo();
1518     
1519     if (!MIMEType)
1520         MIMEType = @"text/html";
1521     [self _loadData:data MIMEType:MIMEType textEncodingName:encodingName baseURL:baseURL unreachableURL:nil];
1522 }
1523
1524 - (void)_loadHTMLString:(NSString *)string baseURL:(NSURL *)baseURL unreachableURL:(NSURL *)unreachableURL
1525 {
1526     NSData *data = [string dataUsingEncoding:NSUTF8StringEncoding];
1527     [self _loadData:data MIMEType:@"text/html" textEncodingName:@"UTF-8" baseURL:baseURL unreachableURL:unreachableURL];
1528 }
1529
1530 - (void)loadHTMLString:(NSString *)string baseURL:(NSURL *)baseURL
1531 {
1532     WebCoreThreadViolationCheckRoundTwo();
1533
1534     [self _loadHTMLString:string baseURL:baseURL unreachableURL:nil];
1535 }
1536
1537 - (void)loadAlternateHTMLString:(NSString *)string baseURL:(NSURL *)baseURL forUnreachableURL:(NSURL *)unreachableURL
1538 {
1539     WebCoreThreadViolationCheckRoundTwo();
1540
1541     [self _loadHTMLString:string baseURL:baseURL unreachableURL:unreachableURL];
1542 }
1543
1544 - (void)loadArchive:(WebArchive *)archive
1545 {
1546     if (LegacyWebArchive* coreArchive = [archive _coreLegacyWebArchive])
1547         _private->coreFrame->loader()->loadArchive(coreArchive);
1548 }
1549
1550 - (void)stopLoading
1551 {
1552     if (!_private->coreFrame)
1553         return;
1554     _private->coreFrame->loader()->stopForUserCancel();
1555 }
1556
1557 - (void)reload
1558 {
1559     if (!WebKitLinkedOnOrAfter(WEBKIT_FIRST_VERSION_WITH_RELOAD_FROM_ORIGIN) && applicationIsSafari())
1560         _private->coreFrame->loader()->reload(GetCurrentKeyModifiers() & shiftKey);
1561     else
1562         _private->coreFrame->loader()->reload(false);
1563 }
1564
1565 - (void)reloadFromOrigin
1566 {
1567     _private->coreFrame->loader()->reload(true);
1568 }
1569
1570 - (WebFrame *)findFrameNamed:(NSString *)name
1571 {
1572     Frame* coreFrame = _private->coreFrame;
1573     if (!coreFrame)
1574         return nil;
1575     return kit(coreFrame->tree()->find(name));
1576 }
1577
1578 - (WebFrame *)parentFrame
1579 {
1580     Frame* coreFrame = _private->coreFrame;
1581     if (!coreFrame)
1582         return nil;
1583     return [[kit(coreFrame->tree()->parent()) retain] autorelease];
1584 }
1585
1586 - (NSArray *)childFrames
1587 {
1588     Frame* coreFrame = _private->coreFrame;
1589     if (!coreFrame)
1590         return [NSArray array];
1591     NSMutableArray *children = [NSMutableArray arrayWithCapacity:coreFrame->tree()->childCount()];
1592     for (Frame* child = coreFrame->tree()->firstChild(); child; child = child->tree()->nextSibling())
1593         [children addObject:kit(child)];
1594     return children;
1595 }
1596
1597 - (WebScriptObject *)windowObject
1598 {
1599     Frame* coreFrame = _private->coreFrame;
1600     if (!coreFrame)
1601         return 0;
1602     return coreFrame->script()->windowScriptObject();
1603 }
1604
1605 - (JSGlobalContextRef)globalContext
1606 {
1607     Frame* coreFrame = _private->coreFrame;
1608     if (!coreFrame)
1609         return 0;
1610     return toGlobalRef(coreFrame->script()->globalObject(mainThreadNormalWorld())->globalExec());
1611 }
1612
1613 @end