Updated printing test patch
[WebKit-https.git] / WebKitTools / DumpRenderTree / mac / DumpRenderTree.mm
1 /*
2  * Copyright (C) 2005, 2006, 2007 Apple Inc. All rights reserved.
3  *           (C) 2007 Graham Dennis (graham.dennis@gmail.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29  
30 #import "DumpRenderTree.h"
31
32 #import "AccessibilityController.h"
33 #import "CheckedMalloc.h"
34 #import "DumpRenderTreePasteboard.h"
35 #import "DumpRenderTreeWindow.h"
36 #import "EditingDelegate.h"
37 #import "EventSendingController.h"
38 #import "FrameLoadDelegate.h"
39 #import "JavaScriptThreading.h"
40 #import "LayoutTestController.h"
41 #import "NavigationController.h"
42 #import "ObjCPlugin.h"
43 #import "ObjCPluginFunction.h"
44 #import "PixelDumpSupport.h"
45 #import "PolicyDelegate.h"
46 #import "ResourceLoadDelegate.h"
47 #import "UIDelegate.h"
48 #import "WorkQueue.h"
49 #import "WorkQueueItem.h"
50 #import <CoreFoundation/CoreFoundation.h>
51 #import <WebKit/DOMElementPrivate.h>
52 #import <WebKit/DOMExtensions.h>
53 #import <WebKit/DOMRange.h>
54 #import <WebKit/WebBackForwardList.h>
55 #import <WebKit/WebCache.h>
56 #import <WebKit/WebCoreStatistics.h>
57 #import <WebKit/WebDataSourcePrivate.h>
58 #import <WebKit/WebDatabaseManagerPrivate.h>
59 #import <WebKit/WebDocumentPrivate.h>
60 #import <WebKit/WebEditingDelegate.h>
61 #import <WebKit/WebFrameView.h>
62 #import <WebKit/WebHistory.h>
63 #import <WebKit/WebHistoryItemPrivate.h>
64 #import <WebKit/WebPluginDatabase.h>
65 #import <WebKit/WebPreferences.h>
66 #import <WebKit/WebPreferencesPrivate.h>
67 #import <WebKit/WebResourceLoadDelegate.h>
68 #import <WebKit/WebTypesInternal.h>
69 #import <WebKit/WebViewPrivate.h>
70 #import <getopt.h>
71 #import <mach-o/getsect.h>
72 #import <objc/objc-runtime.h>
73 #import <wtf/Assertions.h>
74 #import <wtf/RetainPtr.h>
75 #import <wtf/OwnPtr.h>
76
77 @interface DumpRenderTreeEvent : NSEvent
78 @end
79
80 static void runTest(const char *pathOrURL);
81
82 // Deciding when it's OK to dump out the state is a bit tricky.  All these must be true:
83 // - There is no load in progress
84 // - There is no work queued up (see workQueue var, below)
85 // - waitToDump==NO.  This means either waitUntilDone was never called, or it was called
86 //       and notifyDone was called subsequently.
87 // Note that the call to notifyDone and the end of the load can happen in either order.
88
89 volatile bool done;
90
91 NavigationController* navigationController = 0;
92 LayoutTestController* layoutTestController = 0;
93
94 WebFrame *mainFrame = 0;
95 // This is the topmost frame that is loading, during a given load, or nil when no load is 
96 // in progress.  Usually this is the same as the main frame, but not always.  In the case
97 // where a frameset is loaded, and then new content is loaded into one of the child frames,
98 // that child frame is the "topmost frame that is loading".
99 WebFrame *topLoadingFrame = nil;     // !nil iff a load is in progress
100
101
102 CFMutableSetRef disallowedURLs = 0;
103 CFRunLoopTimerRef waitToDumpWatchdog = 0;
104
105 // Delegates
106 static FrameLoadDelegate *frameLoadDelegate;
107 static UIDelegate *uiDelegate;
108 static EditingDelegate *editingDelegate;
109 static ResourceLoadDelegate *resourceLoadDelegate;
110 PolicyDelegate *policyDelegate;
111
112 static int dumpPixels;
113 static int dumpAllPixels;
114 static int threaded;
115 static int testRepaintDefault;
116 static int repaintSweepHorizontallyDefault;
117 static int dumpTree = YES;
118 static BOOL printSeparators;
119 static NSString *currentTest = nil;
120 static RetainPtr<CFStringRef> persistentUserStyleSheetLocation;
121
122 static WebHistoryItem *prevTestBFItem = nil;  // current b/f item at the end of the previous test
123
124 const unsigned maxViewHeight = 600;
125 const unsigned maxViewWidth = 800;
126
127 #if __OBJC2__
128 static void swizzleAllMethods(Class imposter, Class original)
129 {
130     unsigned int imposterMethodCount;
131     Method* imposterMethods = class_copyMethodList(imposter, &imposterMethodCount);
132
133     unsigned int originalMethodCount;
134     Method* originalMethods = class_copyMethodList(original, &originalMethodCount);
135
136     for (unsigned int i = 0; i < imposterMethodCount; i++) {
137         SEL imposterMethodName = method_getName(imposterMethods[i]);
138
139         // Attempt to add the method to the original class.  If it fails, the method already exists and we should
140         // instead exchange the implementations.
141         if (class_addMethod(original, imposterMethodName, method_getImplementation(originalMethods[i]), method_getTypeEncoding(originalMethods[i])))
142             continue;
143
144         unsigned int j = 0;
145         for (; j < originalMethodCount; j++) {
146             SEL originalMethodName = method_getName(originalMethods[j]);
147             if (sel_isEqual(imposterMethodName, originalMethodName))
148                 break;
149         }
150
151         // If class_addMethod failed above then the method must exist on the original class.
152         ASSERT(j < originalMethodCount);
153         method_exchangeImplementations(imposterMethods[i], originalMethods[j]);
154     }
155
156     free(imposterMethods);
157     free(originalMethods);
158 }
159 #endif
160
161 static void poseAsClass(const char* imposter, const char* original)
162 {
163     Class imposterClass = objc_getClass(imposter);
164     Class originalClass = objc_getClass(original);
165
166 #if !__OBJC2__
167     class_poseAs(imposterClass, originalClass);
168 #else
169
170     // Swizzle instance methods
171     swizzleAllMethods(imposterClass, originalClass);
172     // and then class methods
173     swizzleAllMethods(object_getClass(imposterClass), object_getClass(originalClass));
174 #endif
175 }
176
177 void setPersistentUserStyleSheetLocation(CFStringRef url)
178 {
179     persistentUserStyleSheetLocation = url;
180 }
181
182 static BOOL shouldIgnoreWebCoreNodeLeaks(CFStringRef URLString)
183 {
184     static CFStringRef const ignoreSet[] = {
185         // Keeping this infrastructure around in case we ever need it again.
186     };
187     static const int ignoreSetCount = sizeof(ignoreSet) / sizeof(CFStringRef);
188     
189     for (int i = 0; i < ignoreSetCount; i++) {
190         CFStringRef ignoreString = ignoreSet[i];
191         CFRange range = CFRangeMake(0, CFStringGetLength(URLString));
192         CFOptionFlags flags = kCFCompareAnchored | kCFCompareBackwards | kCFCompareCaseInsensitive;
193         if (CFStringFindWithOptions(URLString, ignoreString, range, flags, NULL))
194             return YES;
195     }
196     return NO;
197 }
198
199 static void activateFonts()
200 {
201     static const char* fontSectionNames[] = {
202         "Ahem",
203         "WeightWatcher100",
204         "WeightWatcher200",
205         "WeightWatcher300",
206         "WeightWatcher400",
207         "WeightWatcher500",
208         "WeightWatcher600",
209         "WeightWatcher700",
210         "WeightWatcher800",
211         "WeightWatcher900",
212         0
213     };
214
215     for (unsigned i = 0; fontSectionNames[i]; ++i) {
216         unsigned long fontDataLength;
217         char* fontData = getsectdata("__DATA", fontSectionNames[i], &fontDataLength);
218         if (!fontData) {
219             fprintf(stderr, "Failed to locate the %s font.\n", fontSectionNames[i]);
220             exit(1);
221         }
222
223         ATSFontContainerRef fontContainer;
224         OSStatus status = ATSFontActivateFromMemory(fontData, fontDataLength, kATSFontContextLocal, kATSFontFormatUnspecified, NULL, kATSOptionFlagsDefault, &fontContainer);
225
226         if (status != noErr) {
227             fprintf(stderr, "Failed to activate the %s font.\n", fontSectionNames[i]);
228             exit(1);
229         }
230     }
231 }
232
233 WebView *createWebViewAndOffscreenWindow()
234 {
235     NSRect rect = NSMakeRect(0, 0, maxViewWidth, maxViewHeight);
236     WebView *webView = [[WebView alloc] initWithFrame:rect frameName:nil groupName:@"org.webkit.DumpRenderTree"];
237         
238     [webView setUIDelegate:uiDelegate];
239     [webView setFrameLoadDelegate:frameLoadDelegate];
240     [webView setEditingDelegate:editingDelegate];
241     [webView setResourceLoadDelegate:resourceLoadDelegate];
242
243     // Register the same schemes that Safari does
244     [WebView registerURLSchemeAsLocal:@"feed"];
245     [WebView registerURLSchemeAsLocal:@"feeds"];
246     [WebView registerURLSchemeAsLocal:@"feedsearch"];
247     
248     [webView setContinuousSpellCheckingEnabled:YES];
249     
250     // To make things like certain NSViews, dragging, and plug-ins work, put the WebView a window, but put it off-screen so you don't see it.
251     // Put it at -10000, -10000 in "flipped coordinates", since WebCore and the DOM use flipped coordinates.
252     NSRect windowRect = NSOffsetRect(rect, -10000, [[[NSScreen screens] objectAtIndex:0] frame].size.height - rect.size.height + 10000);
253     DumpRenderTreeWindow *window = [[DumpRenderTreeWindow alloc] initWithContentRect:windowRect styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
254     [[window contentView] addSubview:webView];
255     [window orderBack:nil];
256     [window setAutodisplay:NO];
257     
258     // For reasons that are not entirely clear, the following pair of calls makes WebView handle its
259     // dynamic scrollbars properly. Without it, every frame will always have scrollbars.
260     NSBitmapImageRep *imageRep = [webView bitmapImageRepForCachingDisplayInRect:[webView bounds]];
261     [webView cacheDisplayInRect:[webView bounds] toBitmapImageRep:imageRep];
262         
263     return webView;
264 }
265
266 void testStringByEvaluatingJavaScriptFromString()
267 {
268     // maps expected result <= JavaScript expression
269     NSDictionary *expressions = [NSDictionary dictionaryWithObjectsAndKeys:
270         @"0", @"0", 
271         @"0", @"'0'", 
272         @"", @"",
273         @"", @"''", 
274         @"", @"new String()", 
275         @"", @"new String('0')", 
276         @"", @"throw 1", 
277         @"", @"{ }", 
278         @"", @"[ ]", 
279         @"", @"//", 
280         @"", @"a.b.c", 
281         @"", @"(function() { throw 'error'; })()", 
282         @"", @"null",
283         @"", @"undefined",
284         @"true", @"true",
285         @"false", @"false",
286         nil
287     ];
288
289     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
290     WebView *webView = [[WebView alloc] initWithFrame:NSZeroRect frameName:@"" groupName:@""];
291
292     NSEnumerator *enumerator = [expressions keyEnumerator];
293     id expression;
294     while ((expression = [enumerator nextObject])) {
295         NSString *expectedResult = [expressions objectForKey:expression];
296         NSString *result = [webView stringByEvaluatingJavaScriptFromString:expression];
297         assert([result isEqualToString:expectedResult]);
298     }
299
300     [webView close];
301     [webView release];
302     [pool release];
303 }
304
305 static void setDefaultsToConsistentValuesForTesting()
306 {
307     // Give some clear to undocumented defaults values
308     static const int MediumFontSmoothing = 2;
309     static const int BlueTintedAppearance = 1;
310
311     NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
312     [defaults setObject:@"DoubleMax" forKey:@"AppleScrollBarVariant"];
313     [defaults setInteger:4 forKey:@"AppleAntiAliasingThreshold"]; // smallest font size to CG should perform antialiasing on
314     [defaults setInteger:MediumFontSmoothing forKey:@"AppleFontSmoothing"];
315     [defaults setInteger:BlueTintedAppearance forKey:@"AppleAquaColorVariant"];
316     [defaults setObject:@"0.709800 0.835300 1.000000" forKey:@"AppleHighlightColor"];
317     [defaults setObject:@"0.500000 0.500000 0.500000" forKey:@"AppleOtherHighlightColor"];
318     [defaults setObject:[NSArray arrayWithObject:@"en"] forKey:@"AppleLanguages"];
319
320     NSString *libraryPath = [@"~/Library/Application Support/DumpRenderTree" stringByExpandingTildeInPath];
321     [defaults setObject:[libraryPath stringByAppendingPathComponent:@"Databases"] forKey:WebDatabaseDirectoryDefaultsKey];
322     
323     WebPreferences *preferences = [WebPreferences standardPreferences];
324
325     [preferences setStandardFontFamily:@"Times"];
326     [preferences setFixedFontFamily:@"Courier"];
327     [preferences setSerifFontFamily:@"Times"];
328     [preferences setSansSerifFontFamily:@"Helvetica"];
329     [preferences setCursiveFontFamily:@"Apple Chancery"];
330     [preferences setFantasyFontFamily:@"Papyrus"];
331     [preferences setDefaultFontSize:16];
332     [preferences setDefaultFixedFontSize:13];
333     [preferences setMinimumFontSize:1];
334     [preferences setJavaEnabled:NO];
335     [preferences setEditableLinkBehavior:WebKitEditableLinkOnlyLiveWithShiftKey];
336     [preferences setTabsToLinks:NO];
337     [preferences setDOMPasteAllowed:YES];
338
339     // The back/forward cache is causing problems due to layouts during transition from one page to another.
340     // So, turn it off for now, but we might want to turn it back on some day.
341     [preferences setUsesPageCache:NO];
342 }
343
344 static void crashHandler(int sig)
345 {
346     char *signalName = strsignal(sig);
347     write(STDERR_FILENO, signalName, strlen(signalName));
348     write(STDERR_FILENO, "\n", 1);
349     restoreColorSpace(0);
350     exit(128 + sig);
351 }
352
353 static void installSignalHandlers()
354 {
355     signal(SIGILL, crashHandler);    /* 4:   illegal instruction (not reset when caught) */
356     signal(SIGTRAP, crashHandler);   /* 5:   trace trap (not reset when caught) */
357     signal(SIGEMT, crashHandler);    /* 7:   EMT instruction */
358     signal(SIGFPE, crashHandler);    /* 8:   floating point exception */
359     signal(SIGBUS, crashHandler);    /* 10:  bus error */
360     signal(SIGSEGV, crashHandler);   /* 11:  segmentation violation */
361     signal(SIGSYS, crashHandler);    /* 12:  bad argument to system call */
362     signal(SIGPIPE, crashHandler);   /* 13:  write on a pipe with no reader */
363     signal(SIGXCPU, crashHandler);   /* 24:  exceeded CPU time limit */
364     signal(SIGXFSZ, crashHandler);   /* 25:  exceeded file size limit */
365 }
366
367 static void allocateGlobalControllers()
368 {
369     // FIXME: We should remove these and move to the ObjC standard [Foo sharedInstance] model
370     navigationController = [[NavigationController alloc] init];
371     frameLoadDelegate = [[FrameLoadDelegate alloc] init];
372     uiDelegate = [[UIDelegate alloc] init];
373     editingDelegate = [[EditingDelegate alloc] init];
374     resourceLoadDelegate = [[ResourceLoadDelegate alloc] init];
375     policyDelegate = [[PolicyDelegate alloc] init];
376 }
377
378 // ObjC++ doens't seem to let me pass NSObject*& sadly.
379 static inline void releaseAndZero(NSObject** object)
380 {
381     [*object release];
382     *object = nil;
383 }
384
385 static void releaseGlobalControllers()
386 {
387     releaseAndZero(&navigationController);
388     releaseAndZero(&frameLoadDelegate);
389     releaseAndZero(&editingDelegate);
390     releaseAndZero(&resourceLoadDelegate);
391     releaseAndZero(&uiDelegate);
392     releaseAndZero(&policyDelegate);
393 }
394
395 static void initializeGlobalsFromCommandLineOptions(int argc, const char *argv[])
396 {
397     struct option options[] = {
398         {"dump-all-pixels", no_argument, &dumpAllPixels, YES},
399         {"horizontal-sweep", no_argument, &repaintSweepHorizontallyDefault, YES},
400         {"notree", no_argument, &dumpTree, NO},
401         {"pixel-tests", no_argument, &dumpPixels, YES},
402         {"repaint", no_argument, &testRepaintDefault, YES},
403         {"tree", no_argument, &dumpTree, YES},
404         {"threaded", no_argument, &threaded, YES},
405         {NULL, 0, NULL, 0}
406     };
407     
408     int option;
409     while ((option = getopt_long(argc, (char * const *)argv, "", options, NULL)) != -1) {
410         switch (option) {
411             case '?':   // unknown or ambiguous option
412             case ':':   // missing argument
413                 exit(1);
414                 break;
415         }
416     }
417 }
418
419 static void addTestPluginsToPluginSearchPath(const char* executablePath)
420 {
421     NSString *pwd = [[NSString stringWithUTF8String:executablePath] stringByDeletingLastPathComponent];
422     [WebPluginDatabase setAdditionalWebPlugInPaths:[NSArray arrayWithObject:pwd]];
423     [[WebPluginDatabase sharedDatabase] refresh];
424 }
425
426 static bool useLongRunningServerMode(int argc, const char *argv[])
427 {
428     // This assumes you've already called getopt_long
429     return (argc == optind+1 && strcmp(argv[optind], "-") == 0);
430 }
431
432 static void runTestingServerLoop()
433 {
434     // When DumpRenderTree run in server mode, we just wait around for file names
435     // to be passed to us and read each in turn, passing the results back to the client
436     char filenameBuffer[2048];
437     while (fgets(filenameBuffer, sizeof(filenameBuffer), stdin)) {
438         char *newLineCharacter = strchr(filenameBuffer, '\n');
439         if (newLineCharacter)
440             *newLineCharacter = '\0';
441
442         if (strlen(filenameBuffer) == 0)
443             continue;
444
445         runTest(filenameBuffer);
446     }
447 }
448
449 static void prepareConsistentTestingEnvironment()
450 {
451     poseAsClass("DumpRenderTreePasteboard", "NSPasteboard");
452     poseAsClass("DumpRenderTreeEvent", "NSEvent");
453
454     setDefaultsToConsistentValuesForTesting();
455     activateFonts();
456     
457     if (dumpPixels)
458         initializeColorSpaceAndScreeBufferForPixelTests();
459     allocateGlobalControllers();
460     
461     makeLargeMallocFailSilently();
462 }
463
464 void dumpRenderTree(int argc, const char *argv[])
465 {
466     initializeGlobalsFromCommandLineOptions(argc, argv);
467     prepareConsistentTestingEnvironment();
468     addTestPluginsToPluginSearchPath(argv[0]);
469     if (dumpPixels)
470         installSignalHandlers();
471     
472     WebView *webView = createWebViewAndOffscreenWindow();
473     mainFrame = [webView mainFrame];
474
475     [[NSURLCache sharedURLCache] removeAllCachedResponses];
476
477     [WebCache empty];
478      
479     // <rdar://problem/5222911>
480     testStringByEvaluatingJavaScriptFromString();
481
482     if (threaded)
483         startJavaScriptThreads();
484
485     if (useLongRunningServerMode(argc, argv)) {
486         printSeparators = YES;
487         runTestingServerLoop();
488     } else {
489         printSeparators = (optind < argc-1 || (dumpPixels && dumpTree));
490         for (int i = optind; i != argc; ++i)
491             runTest(argv[i]);
492     }
493
494     if (threaded)
495         stopJavaScriptThreads();
496
497     [WebCoreStatistics emptyCache]; // Otherwise SVGImages trigger false positives for Frame/Node counts    
498     [webView close];
499     mainFrame = nil;
500
501     // Work around problem where registering drag types leaves an outstanding
502     // "perform selector" on the window, which retains the window. It's a bit
503     // inelegant and perhaps dangerous to just blow them all away, but in practice
504     // it probably won't cause any trouble (and this is just a test tool, after all).
505     NSWindow *window = [webView window];
506     [NSObject cancelPreviousPerformRequestsWithTarget:window];
507     
508     [window close]; // releases when closed
509     [webView release];
510     
511     releaseGlobalControllers();
512     
513     [DumpRenderTreePasteboard releaseLocalPasteboards];
514
515     // FIXME: This should be moved onto LayoutTestController and made into a HashSet
516     if (disallowedURLs) {
517         CFRelease(disallowedURLs);
518         disallowedURLs = 0;
519     }
520
521     if (dumpPixels)
522         restoreColorSpace(0);
523 }
524
525 int main(int argc, const char *argv[])
526 {
527     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
528     [NSApplication sharedApplication]; // Force AppKit to init itself
529     dumpRenderTree(argc, argv);
530     [WebCoreStatistics garbageCollectJavaScriptObjects];
531     [pool release];
532     return 0;
533 }
534
535 static NSInteger compareHistoryItems(id item1, id item2, void *context)
536 {
537     return [[item1 target] caseInsensitiveCompare:[item2 target]];
538 }
539
540 static void dumpHistoryItem(WebHistoryItem *item, int indent, BOOL current)
541 {
542     int start = 0;
543     if (current) {
544         printf("curr->");
545         start = 6;
546     }
547     for (int i = start; i < indent; i++)
548         putchar(' ');
549     printf("%s", [[item URLString] UTF8String]);
550     NSString *target = [item target];
551     if (target && [target length] > 0)
552         printf(" (in frame \"%s\")", [target UTF8String]);
553     if ([item isTargetItem])
554         printf("  **nav target**");
555     putchar('\n');
556     NSArray *kids = [item children];
557     if (kids) {
558         // must sort to eliminate arbitrary result ordering which defeats reproducible testing
559         kids = [kids sortedArrayUsingFunction:&compareHistoryItems context:nil];
560         for (unsigned i = 0; i < [kids count]; i++)
561             dumpHistoryItem([kids objectAtIndex:i], indent+4, NO);
562     }
563 }
564
565 static void dumpFrameScrollPosition(WebFrame *f)
566 {
567     NSPoint scrollPosition = [[[[f frameView] documentView] superview] bounds].origin;
568     if (ABS(scrollPosition.x) > 0.00000001 || ABS(scrollPosition.y) > 0.00000001) {
569         if ([f parentFrame] != nil)
570             printf("frame '%s' ", [[f name] UTF8String]);
571         printf("scrolled to %.f,%.f\n", scrollPosition.x, scrollPosition.y);
572     }
573
574     if (layoutTestController->dumpChildFrameScrollPositions()) {
575         NSArray *kids = [f childFrames];
576         if (kids)
577             for (unsigned i = 0; i < [kids count]; i++)
578                 dumpFrameScrollPosition([kids objectAtIndex:i]);
579     }
580 }
581
582 static NSString *dumpFramesAsText(WebFrame *frame)
583 {
584     DOMDocument *document = [frame DOMDocument];
585     DOMElement *documentElement = [document documentElement];
586
587     if (!documentElement)
588         return @"";
589
590     NSMutableString *result = [[[NSMutableString alloc] init] autorelease];
591
592     // Add header for all but the main frame.
593     if ([frame parentFrame])
594         result = [NSMutableString stringWithFormat:@"\n--------\nFrame: '%@'\n--------\n", [frame name]];
595
596     [result appendFormat:@"%@\n", [documentElement innerText]];
597
598     if (layoutTestController->dumpChildFramesAsText()) {
599         NSArray *kids = [frame childFrames];
600         if (kids) {
601             for (unsigned i = 0; i < [kids count]; i++)
602                 [result appendString:dumpFramesAsText([kids objectAtIndex:i])];
603         }
604     }
605
606     return result;
607 }
608
609 static NSData *dumpFrameAsPDF(WebFrame *frame)
610 {
611     if (!frame)
612         return nil;
613
614     // Sadly we have to dump to a file and then read from that file again
615     // +[NSPrintOperation PDFOperationWithView:insideRect:] requires a rect and prints to a single page
616     // likewise +[NSView dataWithPDFInsideRect:] also prints to a single continuous page
617     // The goal of this function is to test "real" printing across multiple pages.
618     // FIXME: It's possible there might be printing SPI to let us print a multi-page PDF to an NSData object
619     NSString *path = @"/tmp/test.pdf";
620
621     NSMutableDictionary *printInfoDict = [NSMutableDictionary dictionaryWithDictionary:[[NSPrintInfo sharedPrintInfo] dictionary]];
622     [printInfoDict setObject:NSPrintSaveJob forKey:NSPrintJobDisposition];
623     [printInfoDict setObject:path forKey:NSPrintSavePath];
624
625     NSPrintInfo *printInfo = [[NSPrintInfo alloc] initWithDictionary:printInfoDict];
626     [printInfo setHorizontalPagination:NSAutoPagination];
627     [printInfo setVerticalPagination:NSAutoPagination];
628     [printInfo setVerticallyCentered:NO];
629
630     NSPrintOperation *printOperation = [NSPrintOperation printOperationWithView:[frame frameView] printInfo:printInfo];
631     [printOperation setShowPanels:NO];
632     [printOperation runOperation];
633
634     [printInfo release];
635
636     NSData *pdfData = [NSData dataWithContentsOfFile:path];
637     [[NSFileManager defaultManager] removeFileAtPath:path handler:nil];
638
639     return pdfData;
640 }
641
642 static void convertMIMEType(NSMutableString *mimeType)
643 {
644     if ([mimeType isEqualToString:@"application/x-javascript"])
645         [mimeType setString:@"text/javascript"];
646 }
647
648 static void convertWebResourceDataToString(NSMutableDictionary *resource)
649 {
650     NSMutableString *mimeType = [resource objectForKey:@"WebResourceMIMEType"];
651     convertMIMEType(mimeType);
652     
653     if ([mimeType hasPrefix:@"text/"]) {
654         NSData *data = [resource objectForKey:@"WebResourceData"];
655         NSString *dataAsString = [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease];
656         [resource setObject:dataAsString forKey:@"WebResourceData"];
657     }
658 }
659
660 static void normalizeWebResourceURL(NSMutableString *webResourceURL)
661 {
662     static int fileUrlLength = [(NSString *)@"file://" length];
663     NSRange layoutTestsWebArchivePathRange = [webResourceURL rangeOfString:@"/LayoutTests/" options:NSBackwardsSearch];
664     if (layoutTestsWebArchivePathRange.location == NSNotFound)
665         return;
666     NSRange currentWorkingDirectoryRange = NSMakeRange(fileUrlLength, layoutTestsWebArchivePathRange.location - fileUrlLength);
667     [webResourceURL replaceCharactersInRange:currentWorkingDirectoryRange withString:@""];
668 }
669
670 static void convertWebResourceResponseToDictionary(NSMutableDictionary *propertyList)
671 {
672     NSURLResponse *response = nil;
673     NSData *responseData = [propertyList objectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
674     if ([responseData isKindOfClass:[NSData class]]) {
675         // Decode NSURLResponse
676         NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:responseData];
677         response = [unarchiver decodeObjectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
678         [unarchiver finishDecoding];
679         [unarchiver release];
680     }        
681     
682     NSMutableDictionary *responseDictionary = [[NSMutableDictionary alloc] init];
683     
684     NSMutableString *urlString = [[[response URL] description] mutableCopy];
685     normalizeWebResourceURL(urlString);
686     [responseDictionary setObject:urlString forKey:@"URL"];
687     [urlString release];
688     
689     NSMutableString *mimeTypeString = [[response MIMEType] mutableCopy];
690     convertMIMEType(mimeTypeString);
691     [responseDictionary setObject:mimeTypeString forKey:@"MIMEType"];
692     [mimeTypeString release];
693
694     NSString *textEncodingName = [response textEncodingName];
695     if (textEncodingName)
696         [responseDictionary setObject:textEncodingName forKey:@"textEncodingName"];
697     [responseDictionary setObject:[NSNumber numberWithLongLong:[response expectedContentLength]] forKey:@"expectedContentLength"];
698     
699     if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
700         NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
701         
702         [responseDictionary setObject:[httpResponse allHeaderFields] forKey:@"allHeaderFields"];
703         [responseDictionary setObject:[NSNumber numberWithInt:[httpResponse statusCode]] forKey:@"statusCode"];
704     }
705     
706     [propertyList setObject:responseDictionary forKey:@"WebResourceResponse"];
707     [responseDictionary release];
708 }
709
710 static NSInteger compareResourceURLs(id resource1, id resource2, void *context)
711 {
712     NSString *url1 = [resource1 objectForKey:@"WebResourceURL"];
713     NSString *url2 = [resource2 objectForKey:@"WebResourceURL"];
714  
715     return [url1 compare:url2];
716 }
717
718 static NSString *serializeWebArchiveToXML(WebArchive *webArchive)
719 {
720     NSString *errorString;
721     NSMutableDictionary *propertyList = [NSPropertyListSerialization propertyListFromData:[webArchive data]
722                                                                          mutabilityOption:NSPropertyListMutableContainersAndLeaves
723                                                                                    format:NULL
724                                                                          errorDescription:&errorString];
725     if (!propertyList)
726         return errorString;
727
728     NSMutableArray *resources = [NSMutableArray arrayWithCapacity:1];
729     [resources addObject:propertyList];
730
731     while ([resources count]) {
732         NSMutableDictionary *resourcePropertyList = [resources objectAtIndex:0];
733         [resources removeObjectAtIndex:0];
734
735         NSMutableDictionary *mainResource = [resourcePropertyList objectForKey:@"WebMainResource"];
736         normalizeWebResourceURL([mainResource objectForKey:@"WebResourceURL"]);
737         convertWebResourceDataToString(mainResource);
738
739         // Add subframeArchives to list for processing
740         NSMutableArray *subframeArchives = [resourcePropertyList objectForKey:@"WebSubframeArchives"]; // WebSubframeArchivesKey in WebArchive.m
741         if (subframeArchives)
742             [resources addObjectsFromArray:subframeArchives];
743
744         NSMutableArray *subresources = [resourcePropertyList objectForKey:@"WebSubresources"]; // WebSubresourcesKey in WebArchive.m
745         NSEnumerator *enumerator = [subresources objectEnumerator];
746         NSMutableDictionary *subresourcePropertyList;
747         while ((subresourcePropertyList = [enumerator nextObject])) {
748             normalizeWebResourceURL([subresourcePropertyList objectForKey:@"WebResourceURL"]);
749             convertWebResourceResponseToDictionary(subresourcePropertyList);
750             convertWebResourceDataToString(subresourcePropertyList);
751         }
752         
753         // Sort the subresources so they're always in a predictable order for the dump
754         if (NSArray *sortedSubresources = [subresources sortedArrayUsingFunction:compareResourceURLs context:nil])
755             [resourcePropertyList setObject:sortedSubresources forKey:@"WebSubresources"];
756     }
757
758     NSData *xmlData = [NSPropertyListSerialization dataFromPropertyList:propertyList
759                                                                  format:NSPropertyListXMLFormat_v1_0
760                                                        errorDescription:&errorString];
761     if (!xmlData)
762         return errorString;
763
764     NSMutableString *string = [[[NSMutableString alloc] initWithData:xmlData encoding:NSUTF8StringEncoding] autorelease];
765
766     // Replace "Apple Computer" with "Apple" in the DTD declaration.
767     NSRange range = [string rangeOfString:@"-//Apple Computer//"];
768     if (range.location != NSNotFound)
769         [string replaceCharactersInRange:range withString:@"-//Apple//"];
770     
771     return string;
772 }
773
774 static void dumpBackForwardListForWebView(WebView *view)
775 {
776     printf("\n============== Back Forward List ==============\n");
777     WebBackForwardList *bfList = [view backForwardList];
778
779     // Print out all items in the list after prevTestBFItem, which was from the previous test
780     // Gather items from the end of the list, the print them out from oldest to newest
781     NSMutableArray *itemsToPrint = [[NSMutableArray alloc] init];
782     for (int i = [bfList forwardListCount]; i > 0; i--) {
783         WebHistoryItem *item = [bfList itemAtIndex:i];
784         // something is wrong if the item from the last test is in the forward part of the b/f list
785         assert(item != prevTestBFItem);
786         [itemsToPrint addObject:item];
787     }
788             
789     assert([bfList currentItem] != prevTestBFItem);
790     [itemsToPrint addObject:[bfList currentItem]];
791     int currentItemIndex = [itemsToPrint count] - 1;
792
793     for (int i = -1; i >= -[bfList backListCount]; i--) {
794         WebHistoryItem *item = [bfList itemAtIndex:i];
795         if (item == prevTestBFItem)
796             break;
797         [itemsToPrint addObject:item];
798     }
799
800     for (int i = [itemsToPrint count]-1; i >= 0; i--)
801         dumpHistoryItem([itemsToPrint objectAtIndex:i], 8, i == currentItemIndex);
802
803     [itemsToPrint release];
804     printf("===============================================\n");
805 }
806
807 static void sizeWebViewForCurrentTest()
808 {
809     // W3C SVG tests expect to be 480x360
810     bool isSVGW3CTest = ([currentTest rangeOfString:@"svg/W3C-SVG-1.1"].length);
811     if (isSVGW3CTest)
812         [[mainFrame webView] setFrameSize:NSMakeSize(480, 360)];
813     else
814         [[mainFrame webView] setFrameSize:NSMakeSize(maxViewWidth, maxViewHeight)];
815 }
816
817 static const char *methodNameStringForFailedTest()
818 {
819     const char *errorMessage;
820     if (layoutTestController->dumpAsText())
821         errorMessage = "[documentElement innerText]";
822     else if (layoutTestController->dumpDOMAsWebArchive())
823         errorMessage = "[[mainFrame DOMDocument] webArchive]";
824     else if (layoutTestController->dumpSourceAsWebArchive())
825         errorMessage = "[[mainFrame dataSource] webArchive]";
826     else
827         errorMessage = "[mainFrame renderTreeAsExternalRepresentation]";
828
829     return errorMessage;
830 }
831
832 static void dumpBackForwardListForAllWindows()
833 {
834     CFArrayRef openWindows = (CFArrayRef)[DumpRenderTreeWindow openWindows];
835     unsigned count = CFArrayGetCount(openWindows);
836     for (unsigned i = 0; i < count; i++) {
837         NSWindow *window = (NSWindow *)CFArrayGetValueAtIndex(openWindows, i);
838         WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
839         dumpBackForwardListForWebView(webView);
840     }
841 }
842
843 static void invalidateAnyPreviousWaitToDumpWatchdog()
844 {
845     if (waitToDumpWatchdog) {
846         CFRunLoopTimerInvalidate(waitToDumpWatchdog);
847         CFRelease(waitToDumpWatchdog);
848         waitToDumpWatchdog = 0;
849     }
850 }
851
852 void dump()
853 {
854     invalidateAnyPreviousWaitToDumpWatchdog();
855
856     if (dumpTree) {
857         NSString *resultString = nil;
858         NSData *resultData = nil;
859         NSString *resultMimeType = @"text/plain";
860
861         bool dumpAsText = layoutTestController->dumpAsText();
862         dumpAsText |= [[[mainFrame dataSource] _responseMIMEType] isEqualToString:@"text/plain"];
863         layoutTestController->setDumpAsText(dumpAsText);
864         if (layoutTestController->dumpAsText()) {
865             resultString = dumpFramesAsText(mainFrame);
866         } else if (layoutTestController->dumpAsPDF()) {
867             resultData = dumpFrameAsPDF(mainFrame);
868             resultMimeType = @"application/pdf";
869         } else if (layoutTestController->dumpDOMAsWebArchive()) {
870             WebArchive *webArchive = [[mainFrame DOMDocument] webArchive];
871             resultString = serializeWebArchiveToXML(webArchive);
872             resultMimeType = @"application/x-webarchive";
873         } else if (layoutTestController->dumpSourceAsWebArchive()) {
874             WebArchive *webArchive = [[mainFrame dataSource] webArchive];
875             resultString = serializeWebArchiveToXML(webArchive);
876             resultMimeType = @"application/x-webarchive";
877         } else {
878             sizeWebViewForCurrentTest();
879             resultString = [mainFrame renderTreeAsExternalRepresentation];
880         }
881
882         if (resultString && !resultData)
883             resultData = [resultString dataUsingEncoding:NSUTF8StringEncoding];
884
885         printf("Content-Type: %s\n", [resultMimeType UTF8String]);
886
887         if (resultData) {
888             fwrite([resultData bytes], 1, [resultData length], stdout);
889
890             if (!layoutTestController->dumpAsText() && !layoutTestController->dumpDOMAsWebArchive() && !layoutTestController->dumpSourceAsWebArchive())
891                 dumpFrameScrollPosition(mainFrame);
892
893             if (layoutTestController->dumpBackForwardList())
894                 dumpBackForwardListForAllWindows();
895         } else
896             printf("ERROR: nil result from %s", methodNameStringForFailedTest());
897
898         if (printSeparators) {
899             puts("#EOF");
900             fputs("#EOF\n", stderr);
901         }            
902     }
903     
904     if (dumpPixels)
905         dumpWebViewAsPixelsAndCompareWithExpected([currentTest UTF8String], dumpAllPixels);
906
907     fflush(stdout);
908     fflush(stderr);
909
910     done = YES;
911 }
912
913 static bool shouldLogFrameLoadDelegates(const char *pathOrURL)
914 {
915     return strstr(pathOrURL, "loading/");
916 }
917
918 static CFURLRef createCFURLFromPathOrURL(CFStringRef pathOrURLString)
919 {
920     CFURLRef URL;
921     if (CFStringHasPrefix(pathOrURLString, CFSTR("http://")) || CFStringHasPrefix(pathOrURLString, CFSTR("https://")))
922         URL = CFURLCreateWithString(NULL, pathOrURLString, NULL);
923     else
924         URL = CFURLCreateWithFileSystemPath(NULL, pathOrURLString, kCFURLPOSIXPathStyle, FALSE);
925     return URL;
926 }
927
928 static void resetWebViewToConsistentStateBeforeTesting()
929 {
930     WebView *webView = [mainFrame webView];
931     [(EditingDelegate *)[webView editingDelegate] setAcceptsEditing:YES];
932     [webView makeTextStandardSize:nil];
933     [webView resetPageZoom:nil];
934     [webView setTabKeyCyclesThroughElements:YES];
935     [webView setPolicyDelegate:nil];
936     [webView _setDashboardBehavior:WebDashboardBehaviorUseBackwardCompatibilityMode to:NO];
937
938     WebPreferences *preferences = [webView preferences];
939     [preferences setPrivateBrowsingEnabled:NO];
940     [preferences setAuthorAndUserStylesEnabled:YES];
941     [preferences setJavaScriptCanOpenWindowsAutomatically:YES];
942     [preferences setOfflineWebApplicationCacheEnabled:YES];
943     
944     if (persistentUserStyleSheetLocation) {
945         [preferences setUserStyleSheetLocation:[NSURL URLWithString:(NSString *)(persistentUserStyleSheetLocation.get())]];
946         [preferences setUserStyleSheetEnabled:YES];
947     } else
948         [preferences setUserStyleSheetEnabled:NO];
949
950     [WebView _setUsesTestModeFocusRingColor:YES];
951 }
952
953 static void runTest(const char *pathOrURL)
954 {
955     CFStringRef pathOrURLString = CFStringCreateWithCString(NULL, pathOrURL, kCFStringEncodingUTF8);
956     if (!pathOrURLString) {
957         fprintf(stderr, "Failed to parse filename as UTF-8: %s\n", pathOrURL);
958         return;
959     }
960
961     CFURLRef URL = createCFURLFromPathOrURL(pathOrURLString);
962     if (!URL) {
963         CFRelease(pathOrURLString);
964         fprintf(stderr, "Can't turn %s into a CFURL\n", pathOrURL);
965         return;
966     }
967
968     resetWebViewToConsistentStateBeforeTesting();
969
970     layoutTestController = new LayoutTestController(testRepaintDefault, repaintSweepHorizontallyDefault);
971     topLoadingFrame = nil;
972     done = NO;
973
974     if (disallowedURLs)
975         CFSetRemoveAllValues(disallowedURLs);
976     if (shouldLogFrameLoadDelegates(pathOrURL))
977         layoutTestController->setDumpFrameLoadCallbacks(true);
978
979     if ([WebHistory optionalSharedHistory])
980         [WebHistory setOptionalSharedHistory:nil];
981     lastMousePosition = NSZeroPoint;
982     lastClickPosition = NSZeroPoint;
983
984     if (currentTest != nil)
985         CFRelease(currentTest);
986     currentTest = (NSString *)pathOrURLString;
987     [prevTestBFItem release];
988     prevTestBFItem = [[[[mainFrame webView] backForwardList] currentItem] retain];
989
990     WorkQueue::shared()->clear();
991     WorkQueue::shared()->setFrozen(false);
992
993     BOOL _shouldIgnoreWebCoreNodeLeaks = shouldIgnoreWebCoreNodeLeaks(CFURLGetString(URL));
994     if (_shouldIgnoreWebCoreNodeLeaks)
995         [WebCoreStatistics startIgnoringWebCoreNodeLeaks];
996
997     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
998     [mainFrame loadRequest:[NSURLRequest requestWithURL:(NSURL *)URL]];
999     CFRelease(URL);
1000     [pool release];
1001     while (!done) {
1002         pool = [[NSAutoreleasePool alloc] init];
1003         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantPast]];
1004         [pool release];
1005     }
1006     pool = [[NSAutoreleasePool alloc] init];
1007     [EventSendingController clearSavedEvents];
1008     [[mainFrame webView] setSelectedDOMRange:nil affinity:NSSelectionAffinityDownstream];
1009
1010     WorkQueue::shared()->clear();
1011
1012     if (layoutTestController->closeRemainingWindowsWhenComplete()) {
1013         NSArray* array = [DumpRenderTreeWindow openWindows];
1014
1015         unsigned count = [array count];
1016         for (unsigned i = 0; i < count; i++) {
1017             NSWindow *window = [array objectAtIndex:i];
1018
1019             // Don't try to close the main window
1020             if (window == [[mainFrame webView] window])
1021                 continue;
1022             
1023             WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
1024
1025             [webView close];
1026             [window close];
1027         }
1028     }
1029     
1030     [mainFrame loadHTMLString:@"<html></html>" baseURL:[NSURL URLWithString:@"about:blank"]];
1031     [mainFrame stopLoading];
1032     
1033     [pool release];
1034
1035     // We should only have our main window left open when we're done
1036     ASSERT(CFArrayGetCount(openWindowsRef) == 1);
1037     ASSERT(CFArrayGetValueAtIndex(openWindowsRef, 0) == [[mainFrame webView] window]);
1038
1039     delete layoutTestController;
1040     layoutTestController = 0;
1041
1042     if (_shouldIgnoreWebCoreNodeLeaks)
1043         [WebCoreStatistics stopIgnoringWebCoreNodeLeaks];
1044 }
1045
1046 void displayWebView()
1047 {
1048     NSView *webView = [mainFrame webView];
1049     [webView display];
1050     [webView lockFocus];
1051     [[[NSColor blackColor] colorWithAlphaComponent:0.66] set];
1052     NSRectFillUsingOperation([webView frame], NSCompositeSourceOver);
1053     [webView unlockFocus];
1054 }
1055
1056 @implementation DumpRenderTreeEvent
1057
1058 + (NSPoint)mouseLocation
1059 {
1060     return [[[mainFrame webView] window] convertBaseToScreen:lastMousePosition];
1061 }
1062
1063 @end