Rubber stamped by Maciej.
[WebKit-https.git] / WebKit / Loader / WebDocumentLoader.h
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <Cocoa/Cocoa.h>
30
31 @class WebFrameLoader;
32
33 // To be renamed to WebDocumentLoader
34 @interface WebDocumentLoader : NSObject
35 {
36 @public
37     WebFrameLoader *frameLoader;
38     
39     NSData *mainResourceData;
40
41     // A reference to actual request used to create the data source.
42     // This should only be used by the resourceLoadDelegate's
43     // identifierForInitialRequest:fromDatasource: method.  It is
44     // not guaranteed to remain unchanged, as requests are mutable.
45     NSURLRequest *originalRequest;    
46
47     // A copy of the original request used to create the data source.
48     // We have to copy the request because requests are mutable.
49     NSURLRequest *originalRequestCopy;
50     
51     // The 'working' request for this datasource.  It may be mutated
52     // several times from the original request to include additional
53     // headers, cookie information, canonicalization and redirects.
54     NSMutableURLRequest *request;
55
56     NSURLResponse *response;
57     
58     NSError *mainDocumentError;    
59     
60     // The time when the data source was told to start loading.
61     double loadingStartedTime;
62
63     BOOL committed;
64     BOOL stopping;
65     BOOL loading;
66     BOOL gotFirstByte;
67     BOOL primaryLoadComplete;
68     BOOL isClientRedirect;
69     
70     NSString *pageTitle;
71     
72     NSString *encoding;
73     NSString *overrideEncoding;
74     
75     // The action that triggered loading of this data source -
76     // we keep this around for the benefit of the various policy
77     // handlers.
78     NSDictionary *triggeringAction;
79     
80     // The last request that we checked click policy for - kept around
81     // so we can avoid asking again needlessly.
82     NSURLRequest *lastCheckedRequest;
83     
84     // We retain all the received responses so we can play back the
85     // WebResourceLoadDelegate messages if the item is loaded from the
86     // page cache.
87     NSMutableArray *responses;
88     BOOL stopRecordingResponses;        
89 }
90
91 - (id)initWithRequest:(NSURLRequest *)request;
92 - (void)setFrameLoader:(WebFrameLoader *)fl;
93 - (WebFrameLoader *)frameLoader;
94 - (void)setMainResourceData:(NSData *)data;
95 - (NSData *)mainResourceData;
96 - (NSURLRequest *)originalRequest;
97 - (NSURLRequest *)originalRequestCopy;
98 - (NSMutableURLRequest *)request;
99 - (void)setRequest:(NSURLRequest *)request;
100 - (NSMutableURLRequest *)actualRequest;
101 - (void)replaceRequestURLForAnchorScrollWithURL:(NSURL *)URL;
102 - (BOOL)isStopping;
103 - (void)stopLoading;
104 - (void)setupForReplace;
105 - (void)commitIfReady;
106 - (void)setCommitted:(BOOL)f;
107 - (BOOL)isCommitted;
108 - (BOOL)isLoading;
109 - (void)setLoading:(BOOL)f;
110 - (void)updateLoading;
111 - (void)receivedData:(NSData *)data;
112 - (void)setupForReplaceByMIMEType:(NSString *)newMIMEType;
113 - (void)finishedLoading;
114 - (NSURLResponse *)response;
115 - (void)clearErrors;
116 - (NSError *)mainDocumentError;
117 - (void)mainReceivedError:(NSError *)error complete:(BOOL)isComplete;
118 - (void)setResponse:(NSURLResponse *)resp;
119 - (void)detachFromFrameLoader;
120 - (void)prepareForLoadStart;
121 - (double)loadingStartedTime;
122 - (BOOL)isClientRedirect;
123 - (void)setIsClientRedirect:(BOOL)flag;
124 - (BOOL)isLoadingInAPISense;
125 - (void)setPrimaryLoadComplete:(BOOL)flag;
126 - (void)setTitle:(NSString *)title;
127 - (NSString *)overrideEncoding;
128 - (void)addResponse:(NSURLResponse *)r;
129 - (NSArray *)responses;
130 - (NSDictionary *)triggeringAction;
131 - (void)setTriggeringAction:(NSDictionary *)action;
132 - (void)setOverrideEncoding:(NSString *)overrideEncoding;
133 - (NSString *)overrideEncoding;
134 - (NSDictionary *)triggeringAction;
135 - (void)setTriggeringAction:(NSDictionary *)action;
136 - (void)setLastCheckedRequest:(NSURLRequest *)request;
137 - (NSURLRequest *)lastCheckedRequest;
138 - (void)stopRecordingResponses;
139 - (NSString *)title;
140
141 @end