WebKit/Loader/WebLoader.h

   1 /*
   2  * Copyright (C) 2005 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 <Foundation/Foundation.h>
  30
  31 @class NSError;
  32 @class NSURLAuthenticationChallenge;
  33 @class NSURLConnection;
  34 @class NSURLConnectionAuthenticationChallenge;
  35 @class NSURLCredential;
  36 @class NSURLRequest;
  37 @class NSURLResponse;
  38 @class WebDataSource;
  39 @class WebResource;
  40 @class WebFrameLoader;
  41
  42 @interface WebLoader : NSObject
  43 {
  44 @protected
  45     WebFrameLoader *frameLoader;
  46     NSURLConnection *connection;
  47     NSURLRequest *request;
  48     BOOL reachedTerminalState;
  49     BOOL loadingMultipartContent;
  50     BOOL signalledFinish;
  51     BOOL cancelledFlag;
  52     id identifier;
  53 @private
  54     NSURLResponse *response;
  55     NSURLAuthenticationChallenge *currentConnectionChallenge;
  56     NSURLAuthenticationChallenge *currentWebChallenge;
  57     BOOL defersCallbacks;
  58     BOOL waitingToDeliverResource;
  59     BOOL deliveredResource;
  60     NSURL *originalURL;
  61     NSMutableData *resourceData;
  62     WebResource *resource;
  63 #ifndef NDEBUG
  64     BOOL isInitializingConnection;
  65 #endif
  66 }
  67 - (void)signalFinish;
  68
  69 - (BOOL)loadWithRequest:(NSURLRequest *)request;
  70
  71 - (void)setFrameLoader:(WebFrameLoader *)fl;
  72 - (WebFrameLoader *)frameLoader;
  73
  74 - (void)cancel;
  75 - (void)cancelWithError:(NSError *)error;
  76
  77 - (void)setDefersCallbacks:(BOOL)defers;
  78 - (BOOL)defersCallbacks;
  79
  80 - (NSError *)cancelledError;
  81
  82 - (void)setIdentifier:(id)ident;
  83
  84 - (void)releaseResources;
  85 - (NSURLResponse *)response;
  86
  87 - (void)addData:(NSData *)data;
  88 - (NSData *)resourceData;
  89 - (void)clearResourceData;
  90
  91 // Connection-less callbacks allow us to send callbacks using data attained from a WebResource instead of an NSURLConnection.
  92 - (NSURLRequest *)willSendRequest:(NSURLRequest *)newRequest redirectResponse:(NSURLResponse *)redirectResponse;
  93 - (void)didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge;
  94 - (void)didCancelAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge;
  95 - (void)didReceiveResponse:(NSURLResponse *)r;
  96 - (void)didReceiveData:(NSData *)data lengthReceived:(long long)lengthReceived;
  97 - (void)willStopBufferingData:(NSData *)data;
  98 - (void)didFinishLoading;
  99 - (void)didFailWithError:(NSError *)error;
 100 - (NSCachedURLResponse *)willCacheResponse:(NSCachedURLResponse *)cachedResponse;
 101
 102 // Used to work around the fact that you don't get any more NSURLConnection callbacks until you return from the first one.
 103 + (BOOL)inConnectionCallback;
 104
 105 @end
 106
 107 // Note: This interface can be removed once this method is declared
 108 // in Foundation (probably will be in Foundation-485).
 109 @interface NSObject (WebLoaderExtras)
 110 - (void)connection:(NSURLConnection *)con didReceiveData:(NSData *)data lengthReceived:(long long)lengthReceived;
 111 @end