-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
DumpRenderTree.m
1420 lines (1211 loc) · 51.2 KB
/
DumpRenderTree.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2005, 2006, 2007 Apple, Inc. All rights reserved.
* (C) 2007 Graham Dennis (graham.dennis@gmail.com)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "DumpRenderTree.h"
#import "AppleScriptController.h"
#import "EditingDelegate.h"
#import "EventSendingController.h"
#import "GCController.h"
#import "NavigationController.h"
#import "ObjCPlugin.h"
#import "ObjCPluginFunction.h"
#import "ResourceLoadDelegate.h"
#import "TextInputController.h"
#import "UIDelegate.h"
#import <ApplicationServices/ApplicationServices.h> // for CMSetDefaultProfileBySpace
#import <CoreFoundation/CoreFoundation.h>
#import <JavaScriptCore/JavaScriptCore.h>
#import <WebKit/DOMElementPrivate.h>
#import <WebKit/DOMExtensions.h>
#import <WebKit/DOMRange.h>
#import <WebKit/WebBackForwardList.h>
#import <WebKit/WebCoreStatistics.h>
#import <WebKit/WebDataSource.h>
#import <WebKit/WebDocumentPrivate.h>
#import <WebKit/WebEditingDelegate.h>
#import <WebKit/WebFramePrivate.h>
#import <WebKit/WebFrameView.h>
#import <WebKit/WebHTMLViewPrivate.h>
#import <WebKit/WebHistory.h>
#import <WebKit/WebHistoryItemPrivate.h>
#import <WebKit/WebPluginDatabase.h>
#import <WebKit/WebPreferences.h>
#import <WebKit/WebPreferencesPrivate.h>
#import <WebKit/WebResourceLoadDelegate.h>
#import <WebKit/WebView.h>
#import <getopt.h>
#import <malloc/malloc.h>
#import <objc/objc-runtime.h> // for class_poseAs
#import <pthread.h>
#define COMMON_DIGEST_FOR_OPENSSL
#import <CommonCrypto/CommonDigest.h> // for MD5 functions
@interface DumpRenderTreeWindow : NSWindow
@end
@interface DumpRenderTreePasteboard : NSPasteboard
- (int)declareType:(NSString *)type owner:(id)newOwner;
@end
@interface DumpRenderTreeEvent : NSEvent
@end
@interface WaitUntilDoneDelegate : NSObject
@end
@interface LayoutTestController : NSObject
{
WebScriptObject *storedWebScriptObject;
}
- (void)dealloc;
@end
@interface LocalPasteboard : NSPasteboard
{
NSMutableArray *typesArray;
NSMutableSet *typesSet;
NSMutableDictionary *dataByType;
int changeCount;
}
@end
BOOL windowIsKey = YES;
WebFrame *frame = 0;
BOOL shouldDumpEditingCallbacks;
BOOL shouldDumpResourceLoadCallbacks;
static void runTest(const char *pathOrURL);
static NSString *md5HashStringForBitmap(CGImageRef bitmap);
volatile BOOL done;
static NavigationController *navigationController;
// Deciding when it's OK to dump out the state is a bit tricky. All these must be true:
// - There is no load in progress
// - There is no work queued up (see workQueue var, below)
// - waitToDump==NO. This means either waitUntilDone was never called, or it was called
// and notifyDone was called subsequently.
// Note that the call to notifyDone and the end of the load can happen in either order.
// This is the topmost frame that is loading, during a given load, or nil when no load is
// in progress. Usually this is the same as the main frame, but not always. In the case
// where a frameset is loaded, and then new content is loaded into one of the child frames,
// that child frame is the "topmost frame that is loading".
static WebFrame *topLoadingFrame; // !nil iff a load is in progress
static BOOL waitToDump; // TRUE if waitUntilDone() has been called, but notifyDone() has not yet been called
static BOOL dumpAsText;
static BOOL dumpAsWebArchive;
static BOOL dumpSelectionRect;
static BOOL dumpTitleChanges;
static BOOL dumpBackForwardList;
static BOOL dumpChildFrameScrollPositions;
static int dumpPixels = NO;
static int dumpAllPixels = NO;
static int threaded = NO;
static BOOL readFromWindow = NO;
static int testRepaintDefault = NO;
static BOOL testRepaint = NO;
static int repaintSweepHorizontallyDefault = NO;
static BOOL repaintSweepHorizontally = NO;
static int dumpTree = YES;
static BOOL printSeparators;
static NSString *currentTest = nil;
static NSMutableDictionary *localPasteboards;
static WebHistoryItem *prevTestBFItem = nil; // current b/f item at the end of the previous test
static unsigned char* screenCaptureBuffer;
static CGColorSpaceRef sharedColorSpace;
// a queue of NSInvocations, queued by callouts from the test, to be exec'ed when the load is done
static NSMutableArray *workQueue = nil;
// to prevent infinite loops, only the first page of a test can add to a work queue
// (since we may well come back to that same page)
static BOOL workQueueFrozen;
const unsigned maxViewHeight = 600;
const unsigned maxViewWidth = 800;
// Loops forever, running a script
void* runJavaScriptThread(void* arg)
{
char* script =
" \
var array = []; \
for (var i = 0; i < 1000; i++) { \
array.push(String(i)); \
} \
";
while(1) {
JSGlobalContextRef ctx = JSGlobalContextCreate(NULL);
JSStringRef scriptRef = JSStringCreateWithUTF8CString(script);
JSValueRef exception = NULL;
JSEvaluateScript(ctx, scriptRef, NULL, NULL, 0, &exception);
assert(!exception);
JSGlobalContextRelease(ctx);
JSStringRelease(scriptRef);
JSGarbageCollect(ctx);
pthread_testcancel(); // Allow thread termination
}
}
static pthread_t javaScriptThread;
static void startJavaScriptThread(void)
{
assert(!javaScriptThread);
pthread_create(&javaScriptThread, NULL, runJavaScriptThread, NULL);
}
static void stopJavaScriptThread(void)
{
assert(javaScriptThread);
pthread_cancel(javaScriptThread);
javaScriptThread = NULL;
}
static CMProfileRef currentColorProfile = 0;
static void restoreColorSpace(int ignored)
{
if (currentColorProfile) {
int error = CMSetDefaultProfileByUse(cmDisplayUse, currentColorProfile);
if (error)
fprintf(stderr, "Failed to retore previous color profile! You may need to open System Preferences : Displays : Color and manually restore your color settings. (Error: %i)", error);
currentColorProfile = 0;
}
}
static void crashHandler(int sig)
{
fprintf(stderr, "%s\n", strsignal(sig));
restoreColorSpace(0);
exit(128 + sig);
}
static void setDefaultColorProfileToRGB(void)
{
CMProfileRef genericProfile = [[NSColorSpace genericRGBColorSpace] colorSyncProfile];
CMProfileRef previousProfile;
int error = CMGetDefaultProfileByUse(cmDisplayUse, &previousProfile);
if (error) {
fprintf(stderr, "Failed to get current color profile. I will not be able to restore your current profile, thus I'm not changing it. Many pixel tests may fail as a result. (Error: %i)\n", error);
return;
}
if (previousProfile == genericProfile)
return;
CFStringRef previousProfileName;
CFStringRef genericProfileName;
char previousProfileNameString[1024];
char genericProfileNameString[1024];
CMCopyProfileDescriptionString(previousProfile, &previousProfileName);
CMCopyProfileDescriptionString(genericProfile, &genericProfileName);
CFStringGetCString(previousProfileName, previousProfileNameString, sizeof(previousProfileNameString), kCFStringEncodingUTF8);
CFStringGetCString(genericProfileName, genericProfileNameString, sizeof(previousProfileNameString), kCFStringEncodingUTF8);
CFRelease(genericProfileName);
CFRelease(previousProfileName);
fprintf(stderr, "\n\nWARNING: Temporarily changing your system color profile from \"%s\" to \"%s\".\n", previousProfileNameString, genericProfileNameString);
fprintf(stderr, "This allows the WebKit pixel-based regression tests to have consistent color values across all machines.\n");
fprintf(stderr, "The colors on your screen will change for the duration of the testing.\n\n");
if ((error = CMSetDefaultProfileByUse(cmDisplayUse, genericProfile)))
fprintf(stderr, "Failed to set color profile to \"%s\"! Many pixel tests will fail as a result. (Error: %i)",
genericProfileNameString, error);
else {
currentColorProfile = previousProfile;
signal(SIGINT, restoreColorSpace);
signal(SIGHUP, restoreColorSpace);
signal(SIGTERM, restoreColorSpace);
}
}
static void* (*savedMalloc)(malloc_zone_t*, size_t);
static void* (*savedRealloc)(malloc_zone_t*, void*, size_t);
static void* checkedMalloc(malloc_zone_t* zone, size_t size)
{
if (size >= 0x10000000)
return 0;
return savedMalloc(zone, size);
}
static void* checkedRealloc(malloc_zone_t* zone, void* ptr, size_t size)
{
if (size >= 0x10000000)
return 0;
return savedRealloc(zone, ptr, size);
}
static void makeLargeMallocFailSilently(void)
{
malloc_zone_t* zone = malloc_default_zone();
savedMalloc = zone->malloc;
savedRealloc = zone->realloc;
zone->malloc = checkedMalloc;
zone->realloc = checkedRealloc;
}
void dumpRenderTree(int argc, const char *argv[])
{
[NSApplication sharedApplication];
class_poseAs(objc_getClass("DumpRenderTreePasteboard"), objc_getClass("NSPasteboard"));
class_poseAs(objc_getClass("DumpRenderTreeWindow"), objc_getClass("NSWindow"));
class_poseAs(objc_getClass("DumpRenderTreeEvent"), objc_getClass("NSEvent"));
struct option options[] = {
{"dump-all-pixels", no_argument, &dumpAllPixels, YES},
{"horizontal-sweep", no_argument, &repaintSweepHorizontallyDefault, YES},
{"notree", no_argument, &dumpTree, NO},
{"pixel-tests", no_argument, &dumpPixels, YES},
{"repaint", no_argument, &testRepaintDefault, YES},
{"tree", no_argument, &dumpTree, YES},
{"threaded", no_argument, &threaded, YES},
{NULL, 0, NULL, 0}
};
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
[defaults setObject:@"DoubleMax" forKey:@"AppleScrollBarVariant"];
[defaults setInteger:4 forKey:@"AppleAntiAliasingThreshold"];
// 2 is the "Medium" font smoothing mode
[defaults setInteger:2 forKey:@"AppleFontSmoothing"];
[defaults setInteger:1 forKey:@"AppleAquaColorVariant"];
[defaults setObject:@"0.709800 0.835300 1.000000" forKey:@"AppleHighlightColor"];
[defaults setObject:@"0.500000 0.500000 0.500000" forKey:@"AppleOtherHighlightColor"];
[defaults setObject:[NSArray arrayWithObject:@"en"] forKey:@"AppleLanguages"];
WebPreferences *preferences = [WebPreferences standardPreferences];
[preferences setStandardFontFamily:@"Times"];
[preferences setFixedFontFamily:@"Courier"];
[preferences setSerifFontFamily:@"Times"];
[preferences setSansSerifFontFamily:@"Helvetica"];
[preferences setCursiveFontFamily:@"Apple Chancery"];
[preferences setFantasyFontFamily:@"Papyrus"];
[preferences setDefaultFontSize:16];
[preferences setDefaultFixedFontSize:13];
[preferences setMinimumFontSize:9];
[preferences setJavaEnabled:NO];
[preferences setJavaScriptCanOpenWindowsAutomatically:NO];
[preferences setEditableLinkBehavior:WebKitEditableLinkOnlyLiveWithShiftKey];
[preferences setTabsToLinks:NO];
int option;
while ((option = getopt_long(argc, (char * const *)argv, "", options, NULL)) != -1)
switch (option) {
case '?': // unknown or ambiguous option
case ':': // missing argument
exit(1);
break;
}
if ([[[NSFontManager sharedFontManager] availableMembersOfFontFamily:@"Ahem"] count] == 0) {
fprintf(stderr, "\nAhem font is not available. This special simple font is used to construct certain types of predictable tests.\n\nTo run regression tests, please get it from <http://webkit.org/quality/Ahem.ttf>.\n");
exit(1);
}
if (dumpPixels) {
setDefaultColorProfileToRGB();
screenCaptureBuffer = malloc(maxViewHeight * maxViewWidth * 4);
sharedColorSpace = CGColorSpaceCreateDeviceRGB();
}
localPasteboards = [[NSMutableDictionary alloc] init];
navigationController = [[NavigationController alloc] init];
NSRect rect = NSMakeRect(0, 0, maxViewWidth, maxViewHeight);
WebView *webView = [[WebView alloc] initWithFrame:rect];
frame = [webView mainFrame];
WaitUntilDoneDelegate *waitUntilDoneDelegate = [[WaitUntilDoneDelegate alloc] init];
[webView setFrameLoadDelegate:waitUntilDoneDelegate];
UIDelegate *uiDelegate = [[UIDelegate alloc] init];
[webView setUIDelegate:uiDelegate];
EditingDelegate *editingDelegate = [[EditingDelegate alloc] init];
[webView setEditingDelegate:editingDelegate];
ResourceLoadDelegate *resourceLoadDelegate = [[ResourceLoadDelegate alloc] init];
[webView setResourceLoadDelegate:resourceLoadDelegate];
NSString *pwd = [[NSString stringWithUTF8String:argv[0]] stringByDeletingLastPathComponent];
[WebPluginDatabase setAdditionalWebPlugInPaths:[NSArray arrayWithObject:pwd]];
[[WebPluginDatabase sharedDatabase] refresh];
// The back/forward cache is causing problems due to layouts during transition from one page to another.
// So, turn it off for now, but we might want to turn it back on some day.
[[webView backForwardList] setPageCacheSize:0];
// 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.
// Put it at -10000, -10000 in "flipped coordinates", since WebCore and the DOM use flipped coordinates.
NSRect windowRect = NSOffsetRect(rect, -10000, [[[NSScreen screens] objectAtIndex:0] frame].size.height - rect.size.height + 10000);
NSWindow *window = [[NSWindow alloc] initWithContentRect:windowRect styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
[[window contentView] addSubview:webView];
[window orderBack:nil];
[window setAutodisplay:NO];
workQueue = [[NSMutableArray alloc] init];
[webView setContinuousSpellCheckingEnabled:YES];
makeLargeMallocFailSilently();
signal(SIGILL, crashHandler); /* 4: illegal instruction (not reset when caught) */
signal(SIGTRAP, crashHandler); /* 5: trace trap (not reset when caught) */
signal(SIGEMT, crashHandler); /* 7: EMT instruction */
signal(SIGFPE, crashHandler); /* 8: floating point exception */
signal(SIGBUS, crashHandler); /* 10: bus error */
signal(SIGSEGV, crashHandler); /* 11: segmentation violation */
signal(SIGSYS, crashHandler); /* 12: bad argument to system call */
signal(SIGPIPE, crashHandler); /* 13: write on a pipe with no reader */
signal(SIGXCPU, crashHandler); /* 24: exceeded CPU time limit */
signal(SIGXFSZ, crashHandler); /* 25: exceeded file size limit */
[[NSURLCache sharedURLCache] removeAllCachedResponses];
// For reasons that are not entirely clear, the following pair of calls makes WebView handle its
// dynamic scrollbars properly. Without it, every frame will always have scrollbars.
NSBitmapImageRep *imageRep = [webView bitmapImageRepForCachingDisplayInRect:[webView bounds]];
[webView cacheDisplayInRect:[webView bounds] toBitmapImageRep:imageRep];
if (threaded)
startJavaScriptThread();
if (argc == optind+1 && strcmp(argv[optind], "-") == 0) {
char filenameBuffer[2048];
printSeparators = YES;
while (fgets(filenameBuffer, sizeof(filenameBuffer), stdin)) {
char *newLineCharacter = strchr(filenameBuffer, '\n');
if (newLineCharacter)
*newLineCharacter = '\0';
if (strlen(filenameBuffer) == 0)
continue;
runTest(filenameBuffer);
}
} else {
printSeparators = (optind < argc-1 || (dumpPixels && dumpTree));
for (int i = optind; i != argc; ++i)
runTest(argv[i]);
}
if (threaded)
stopJavaScriptThread();
[workQueue release];
[WebCoreStatistics emptyCache]; // Otherwise SVGImages trigger false positives for Frame/Node counts
[webView close];
frame = nil;
// Work around problem where registering drag types leaves an outstanding
// "perform selector" on the window, which retains the window. It's a bit
// inelegant and perhaps dangerous to just blow them all away, but in practice
// it probably won't cause any trouble (and this is just a test tool, after all).
[NSObject cancelPreviousPerformRequestsWithTarget:window];
[window close]; // releases when closed
[webView release];
[waitUntilDoneDelegate release];
[editingDelegate release];
[resourceLoadDelegate release];
[uiDelegate release];
[localPasteboards release];
localPasteboards = nil;
[navigationController release];
navigationController = nil;
if (dumpPixels)
restoreColorSpace(0);
}
int main(int argc, const char *argv[])
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
dumpRenderTree(argc, argv);
[WebCoreStatistics garbageCollectJavaScriptObjects];
[pool release];
return 0;
}
static int compareHistoryItems(id item1, id item2, void *context)
{
return [[item1 target] caseInsensitiveCompare:[item2 target]];
}
static void dumpHistoryItem(WebHistoryItem *item, int indent, BOOL current)
{
int start = 0;
if (current) {
printf("curr->");
start = 6;
}
for (int i = start; i < indent; i++)
putchar(' ');
printf("%s", [[item URLString] UTF8String]);
NSString *target = [item target];
if (target && [target length] > 0)
printf(" (in frame \"%s\")", [target UTF8String]);
if ([item isTargetItem])
printf(" **nav target**");
putchar('\n');
NSArray *kids = [item children];
if (kids) {
// must sort to eliminate arbitrary result ordering which defeats reproducible testing
kids = [kids sortedArrayUsingFunction:&compareHistoryItems context:nil];
for (unsigned i = 0; i < [kids count]; i++)
dumpHistoryItem([kids objectAtIndex:i], indent+4, NO);
}
}
static void dumpFrameScrollPosition(WebFrame *f)
{
NSPoint scrollPosition = [[[[f frameView] documentView] superview] bounds].origin;
if (ABS(scrollPosition.x) > 0.00000001 || ABS(scrollPosition.y) > 0.00000001) {
if ([f parentFrame] != nil)
printf("frame '%s' ", [[f name] UTF8String]);
printf("scrolled to %.f,%.f\n", scrollPosition.x, scrollPosition.y);
}
if (dumpChildFrameScrollPositions) {
NSArray *kids = [f childFrames];
if (kids)
for (unsigned i = 0; i < [kids count]; i++)
dumpFrameScrollPosition([kids objectAtIndex:i]);
}
}
static void convertWebResourceDataToString(NSMutableDictionary *resource)
{
NSString *mimeType = [resource objectForKey:@"WebResourceMIMEType"];
if ([mimeType hasPrefix:@"text/"] || [mimeType isEqualToString:@"application/x-javascript"]) {
NSData *data = [resource objectForKey:@"WebResourceData"];
NSString *dataAsString = [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease];
[resource setObject:dataAsString forKey:@"WebResourceData"];
}
}
static void normalizeWebResourceURL(NSMutableString *webResourceURL, NSString *oldURLBase)
{
[webResourceURL replaceOccurrencesOfString:oldURLBase
withString:@"file://"
options:NSLiteralSearch
range:NSMakeRange(0, [webResourceURL length])];
}
static void normalizeWebResourceResponse(NSMutableDictionary *propertyList, NSString *oldURLBase)
{
NSURLResponse *response = nil;
NSData *responseData = [propertyList objectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
if ([responseData isKindOfClass:[NSData class]]) {
// Decode NSURLResponse
NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:responseData];
response = [unarchiver decodeObjectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
[unarchiver finishDecoding];
[unarchiver release];
// Create replacement NSURLReponse
NSMutableString *URL = [[[NSMutableString alloc] initWithContentsOfURL:[response URL]] autorelease];
normalizeWebResourceURL(URL, oldURLBase);
NSURLResponse *newResponse = [[NSURLResponse alloc] initWithURL:[[[NSURL alloc] initWithString:URL] autorelease]
MIMEType:[response MIMEType]
expectedContentLength:[response expectedContentLength]
textEncodingName:[response textEncodingName]];
[newResponse autorelease];
// Encode replacement NSURLResponse
NSMutableData *newResponseData = [[NSMutableData alloc] init];
NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:newResponseData];
[archiver encodeObject:newResponse forKey:@"WebResourceResponse"];
[archiver finishEncoding];
[archiver release];
[propertyList setObject:newResponseData forKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
[newResponseData release];
}
}
static NSString *serializeWebArchiveToXML(WebArchive *webArchive)
{
NSString *errorString;
NSMutableDictionary *propertyList = [NSPropertyListSerialization propertyListFromData:[webArchive data]
mutabilityOption:NSPropertyListMutableContainersAndLeaves
format:NULL
errorDescription:&errorString];
if (!propertyList)
return errorString;
// Normalize WebResourceResponse and WebResourceURL values in plist for testing
NSString *cwdURL = [@"file://" stringByAppendingString:[[[NSFileManager defaultManager] currentDirectoryPath] stringByExpandingTildeInPath]];
NSMutableArray *resources = [NSMutableArray arrayWithCapacity:1];
[resources addObject:propertyList];
while ([resources count]) {
NSMutableDictionary *resourcePropertyList = [resources objectAtIndex:0];
[resources removeObjectAtIndex:0];
NSMutableDictionary *mainResource = [resourcePropertyList objectForKey:@"WebMainResource"];
normalizeWebResourceURL([mainResource objectForKey:@"WebResourceURL"], cwdURL);
convertWebResourceDataToString(mainResource);
// Add subframeArchives to list for processing
NSMutableArray *subframeArchives = [resourcePropertyList objectForKey:@"WebSubframeArchives"]; // WebSubframeArchivesKey in WebArchive.m
if (subframeArchives)
[resources addObjectsFromArray:subframeArchives];
NSMutableArray *subresources = [resourcePropertyList objectForKey:@"WebSubresources"]; // WebSubresourcesKey in WebArchive.m
NSEnumerator *enumerator = [subresources objectEnumerator];
NSMutableDictionary *subresourcePropertyList;
while ((subresourcePropertyList = [enumerator nextObject])) {
normalizeWebResourceURL([subresourcePropertyList objectForKey:@"WebResourceURL"], cwdURL);
normalizeWebResourceResponse(subresourcePropertyList, cwdURL);
convertWebResourceDataToString(subresourcePropertyList);
}
}
NSData *xmlData = [NSPropertyListSerialization dataFromPropertyList:propertyList
format:NSPropertyListXMLFormat_v1_0
errorDescription:&errorString];
if (!xmlData)
return errorString;
return [[[NSMutableString alloc] initWithData:xmlData encoding:NSUTF8StringEncoding] autorelease];
}
static void dump(void)
{
NSString *result = nil;
if (dumpTree) {
dumpAsText |= [[[[frame dataSource] response] MIMEType] isEqualToString:@"text/plain"];
if (dumpAsText) {
DOMElement *documentElement = [[frame DOMDocument] documentElement];
result = [[(DOMElement *)documentElement innerText] stringByAppendingString:@"\n"];
} else if (dumpAsWebArchive) {
WebArchive *webArchive = [[frame DOMDocument] webArchive];
result = serializeWebArchiveToXML(webArchive);
} else {
bool isSVGW3CTest = ([currentTest rangeOfString:@"svg/W3C-SVG-1.1"].length);
if (isSVGW3CTest)
[[frame webView] setFrameSize:NSMakeSize(480, 360)];
else
[[frame webView] setFrameSize:NSMakeSize(maxViewWidth, maxViewHeight)];
result = [frame renderTreeAsExternalRepresentation];
}
if (!result) {
const char *errorMessage;
if (dumpAsText)
errorMessage = "[documentElement innerText]";
else if (dumpAsWebArchive)
errorMessage = "[[frame DOMDocument] webArchive]";
else
errorMessage = "[frame renderTreeAsExternalRepresentation]";
printf("ERROR: nil result from %s", errorMessage);
} else {
fputs([result UTF8String], stdout);
if (!dumpAsText && !dumpAsWebArchive)
dumpFrameScrollPosition(frame);
}
if (dumpBackForwardList) {
printf("\n============== Back Forward List ==============\n");
WebBackForwardList *bfList = [[frame webView] backForwardList];
// Print out all items in the list after prevTestBFItem, which was from the previous test
// Gather items from the end of the list, the print them out from oldest to newest
NSMutableArray *itemsToPrint = [[NSMutableArray alloc] init];
for (int i = [bfList forwardListCount]; i > 0; i--) {
WebHistoryItem *item = [bfList itemAtIndex:i];
// something is wrong if the item from the last test is in the forward part of the b/f list
assert(item != prevTestBFItem);
[itemsToPrint addObject:item];
}
assert([bfList currentItem] != prevTestBFItem);
[itemsToPrint addObject:[bfList currentItem]];
int currentItemIndex = [itemsToPrint count] - 1;
for (int i = -1; i >= -[bfList backListCount]; i--) {
WebHistoryItem *item = [bfList itemAtIndex:i];
if (item == prevTestBFItem)
break;
[itemsToPrint addObject:item];
}
for (int i = [itemsToPrint count]-1; i >= 0; i--) {
dumpHistoryItem([itemsToPrint objectAtIndex:i], 8, i == currentItemIndex);
}
[itemsToPrint release];
printf("===============================================\n");
}
if (printSeparators)
puts("#EOF");
}
if (dumpPixels) {
if (!dumpAsText && !dumpAsWebArchive) {
// grab a bitmap from the view
WebView* view = [frame webView];
NSSize webViewSize = [view frame].size;
CGContextRef cgContext = CGBitmapContextCreate(screenCaptureBuffer, webViewSize.width, webViewSize.height, 8, webViewSize.width * 4, sharedColorSpace, kCGBitmapByteOrder32Host | kCGImageAlphaPremultipliedLast);
NSGraphicsContext* savedContext = [[[NSGraphicsContext currentContext] retain] autorelease];
NSGraphicsContext* nsContext = [NSGraphicsContext graphicsContextWithGraphicsPort:cgContext flipped:NO];
[NSGraphicsContext setCurrentContext:nsContext];
if (readFromWindow) {
NSBitmapImageRep *imageRep;
[view displayIfNeeded];
[view lockFocus];
imageRep = [[NSBitmapImageRep alloc] initWithFocusedViewRect:[view frame]];
[view unlockFocus];
[imageRep draw];
[imageRep release];
} else if (!testRepaint)
[view displayRectIgnoringOpacity:NSMakeRect(0, 0, webViewSize.width, webViewSize.height) inContext:nsContext];
else if (!repaintSweepHorizontally) {
NSRect line = NSMakeRect(0, 0, webViewSize.width, 1);
while (line.origin.y < webViewSize.height) {
[view displayRectIgnoringOpacity:line inContext:nsContext];
line.origin.y++;
}
} else {
NSRect column = NSMakeRect(0, 0, 1, webViewSize.height);
while (column.origin.x < webViewSize.width) {
[view displayRectIgnoringOpacity:column inContext:nsContext];
column.origin.x++;
}
}
if (dumpSelectionRect) {
NSView *documentView = [[frame frameView] documentView];
if ([documentView conformsToProtocol:@protocol(WebDocumentSelection)]) {
[[NSColor redColor] set];
[NSBezierPath strokeRect:[documentView convertRect:[(id <WebDocumentSelection>)documentView selectionRect] fromView:nil]];
}
}
[NSGraphicsContext setCurrentContext:savedContext];
CGImageRef bitmapImage = CGBitmapContextCreateImage(cgContext);
CGContextRelease(cgContext);
// compute the actual hash to compare to the expected image's hash
NSString *actualHash = md5HashStringForBitmap(bitmapImage);
printf("\nActualHash: %s\n", [actualHash UTF8String]);
BOOL dumpImage;
if (dumpAllPixels)
dumpImage = YES;
else {
// FIXME: It's unfortunate that we hardcode the file naming scheme here.
// At one time, the perl script had all the knowledge about file layout.
// Some day we should restore that setup by passing in more parameters to this tool.
NSString *baseTestPath = [currentTest stringByDeletingPathExtension];
NSString *baselineHashPath = [baseTestPath stringByAppendingString:@"-expected.checksum"];
NSString *baselineHash = [NSString stringWithContentsOfFile:baselineHashPath encoding:NSUTF8StringEncoding error:nil];
NSString *baselineImagePath = [baseTestPath stringByAppendingString:@"-expected.png"];
printf("BaselineHash: %s\n", [baselineHash UTF8String]);
/// send the image to stdout if the hash mismatches or if there's no file in the file system
dumpImage = ![baselineHash isEqualToString:actualHash] || access([baselineImagePath fileSystemRepresentation], F_OK) != 0;
}
if (dumpImage) {
CFMutableDataRef imageData = CFDataCreateMutable(0, 0);
CGImageDestinationRef imageDest = CGImageDestinationCreateWithData(imageData, CFSTR("public.png"), 1, 0);
CGImageDestinationAddImage(imageDest, bitmapImage, 0);
CGImageDestinationFinalize(imageDest);
CFRelease(imageDest);
printf("Content-length: %lu\n", CFDataGetLength(imageData));
fwrite(CFDataGetBytePtr(imageData), 1, CFDataGetLength(imageData), stdout);
CFRelease(imageData);
}
CGImageRelease(bitmapImage);
}
printf("#EOF\n");
}
fflush(stdout);
done = YES;
}
@implementation WaitUntilDoneDelegate
// Exec messages in the work queue until they're all done, or one of them starts a new load
- (void)processWork:(id)dummy
{
// quit doing work once a load is in progress
while ([workQueue count] > 0 && !topLoadingFrame) {
[[workQueue objectAtIndex:0] invoke];
[workQueue removeObjectAtIndex:0];
}
// if we didn't start a new load, then we finished all the commands, so we're ready to dump state
if (!topLoadingFrame && !waitToDump)
dump();
}
- (void)webView:(WebView *)c locationChangeDone:(NSError *)error forDataSource:(WebDataSource *)dataSource
{
if ([dataSource webFrame] == topLoadingFrame) {
topLoadingFrame = nil;
workQueueFrozen = YES; // first complete load freezes the queue for the rest of this test
if (!waitToDump) {
if ([workQueue count] > 0)
[self performSelector:@selector(processWork:) withObject:nil afterDelay:0];
else
dump();
}
}
}
- (void)webView:(WebView *)sender didStartProvisionalLoadForFrame:(WebFrame *)f
{
// Make sure we only set this once per test. If it gets cleared, and then set again, we might
// end up doing two dumps for one test.
if (!topLoadingFrame && !done)
topLoadingFrame = f;
}
- (void)webView:(WebView *)sender didCommitLoadForFrame:(WebFrame *)f
{
windowIsKey = YES;
NSView *documentView = [[frame frameView] documentView];
[[[frame webView] window] makeFirstResponder:documentView];
if ([documentView isKindOfClass:[WebHTMLView class]])
[(WebHTMLView *)documentView _updateActiveState];
}
- (void)webView:(WebView *)sender didFailProvisionalLoadWithError:(NSError *)error forFrame:(WebFrame *)frame
{
[self webView:sender locationChangeDone:error forDataSource:[frame provisionalDataSource]];
}
- (void)webView:(WebView *)sender didFinishLoadForFrame:(WebFrame *)frame
{
[self webView:sender locationChangeDone:nil forDataSource:[frame dataSource]];
[navigationController webView:sender didFinishLoadForFrame:frame];
}
- (void)webView:(WebView *)sender didFailLoadWithError:(NSError *)error forFrame:(WebFrame *)frame
{
[self webView:sender locationChangeDone:error forDataSource:[frame dataSource]];
}
- (void)webView:(WebView *)sender windowScriptObjectAvailable:(WebScriptObject *)obj
{
LayoutTestController *ltc = [[LayoutTestController alloc] init];
[obj setValue:ltc forKey:@"layoutTestController"];
[ltc release];
EventSendingController *esc = [[EventSendingController alloc] init];
[obj setValue:esc forKey:@"eventSender"];
[esc release];
TextInputController *tic = [[TextInputController alloc] initWithWebView:sender];
[obj setValue:tic forKey:@"textInputController"];
[tic release];
AppleScriptController *asc = [[AppleScriptController alloc] initWithWebView:sender];
[obj setValue:asc forKey:@"appleScriptController"];
[asc release];
GCController *gcc = [[GCController alloc] init];
[obj setValue:gcc forKey:@"GCController"];
[gcc release];
[obj setValue:navigationController forKey:@"navigationController"];
ObjCPlugin *plugin = [[ObjCPlugin alloc] init];
[obj setValue:plugin forKey:@"objCPlugin"];
[plugin release];
ObjCPluginFunction *pluginFunction = [[ObjCPluginFunction alloc] init];
[obj setValue:pluginFunction forKey:@"objCPluginFunction"];
[pluginFunction release];
}
- (void)webView:(WebView *)sender didReceiveTitle:(NSString *)title forFrame:(WebFrame *)frame
{
if (dumpTitleChanges)
printf("TITLE CHANGED: %s\n", [title UTF8String]);
}
@end
@implementation LayoutTestController
+ (BOOL)isSelectorExcludedFromWebScript:(SEL)aSelector
{
if (aSelector == @selector(waitUntilDone)
|| aSelector == @selector(notifyDone)
|| aSelector == @selector(dumpAsText)
|| aSelector == @selector(dumpAsWebArchive)
|| aSelector == @selector(dumpTitleChanges)
|| aSelector == @selector(dumpBackForwardList)
|| aSelector == @selector(dumpChildFrameScrollPositions)
|| aSelector == @selector(dumpEditingCallbacks)
|| aSelector == @selector(dumpResourceLoadCallbacks)
|| aSelector == @selector(setWindowIsKey:)
|| aSelector == @selector(setMainFrameIsFirstResponder:)
|| aSelector == @selector(dumpSelectionRect)
|| aSelector == @selector(display)
|| aSelector == @selector(testRepaint)
|| aSelector == @selector(repaintSweepHorizontally)
|| aSelector == @selector(queueBackNavigation:)
|| aSelector == @selector(queueForwardNavigation:)
|| aSelector == @selector(queueReload)
|| aSelector == @selector(queueScript:)
|| aSelector == @selector(queueLoad:target:)
|| aSelector == @selector(clearBackForwardList)
|| aSelector == @selector(keepWebHistory)
|| aSelector == @selector(setAcceptsEditing:)
|| aSelector == @selector(storeWebScriptObject:)
|| aSelector == @selector(accessStoredWebScriptObject))
return NO;
return YES;
}
+ (NSString *)webScriptNameForSelector:(SEL)aSelector
{
if (aSelector == @selector(setWindowIsKey:))
return @"setWindowIsKey";
if (aSelector == @selector(setMainFrameIsFirstResponder:))
return @"setMainFrameIsFirstResponder";
if (aSelector == @selector(queueBackNavigation:))
return @"queueBackNavigation";
if (aSelector == @selector(queueForwardNavigation:))
return @"queueForwardNavigation";
if (aSelector == @selector(queueScript:))
return @"queueScript";
if (aSelector == @selector(queueLoad:target:))
return @"queueLoad";
if (aSelector == @selector(setAcceptsEditing:))
return @"setAcceptsEditing";
if (aSelector == @selector(storeWebScriptObject:))
return @"storeWebScriptObject";
return nil;
}
- (void)clearBackForwardList
{
WebBackForwardList *backForwardList = [[frame webView] backForwardList];
WebHistoryItem *item = [[backForwardList currentItem] retain];
// We clear the history by setting the back/forward list's capacity to 0
// then restoring it back and adding back the current item.
int capacity = [backForwardList capacity];
[backForwardList setCapacity:0];
[backForwardList setCapacity:capacity];
[backForwardList addItem:item];
[backForwardList goToItem:item];
[item release];
}
- (void)keepWebHistory
{
if (![WebHistory optionalSharedHistory]) {
WebHistory *history = [[WebHistory alloc] init];
[WebHistory setOptionalSharedHistory:history];
[history release];
}
}
- (void)waitUntilDone
{
waitToDump = YES;
}
- (void)notifyDone
{
if (waitToDump && !topLoadingFrame && [workQueue count] == 0)
dump();
waitToDump = NO;
}
- (void)dumpAsText
{
dumpAsText = YES;
}
- (void)dumpAsWebArchive
{
dumpAsWebArchive = YES;
}
- (void)dumpSelectionRect
{
dumpSelectionRect = YES;
}
- (void)dumpTitleChanges
{
dumpTitleChanges = YES;
}
- (void)dumpBackForwardList
{
dumpBackForwardList = YES;
}
- (void)dumpChildFrameScrollPositions
{
dumpChildFrameScrollPositions = YES;
}
- (void)dumpEditingCallbacks
{