Reviewed by Anders.
[WebKit-https.git] / WebKit / Plugins / WebBaseNetscapePluginStream.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 #import <WebKit/npfunctions.h>
32 #import <WebKit/WebPlugInStreamLoaderDelegate.h>
33
34 @class WebBaseNetscapePluginView;
35 @class NSURLResponse;
36
37 @interface WebBaseNetscapePluginStream : NSObject<WebPlugInStreamLoaderDelegate>
38 {
39     NSMutableData *deliveryData;
40     NSURL *requestURL;
41     NSURL *responseURL;
42     NSString *MIMEType;
43     
44     NPP instance;
45     uint16 transferMode;
46     int32 offset;
47     NPStream stream;
48     char *path;
49     BOOL sendNotification;
50     void *notifyData;
51     WebBaseNetscapePluginView *pluginView;
52     NPReason reason;
53     BOOL isTerminated;
54         
55     NPP_NewStreamProcPtr NPP_NewStream;
56     NPP_DestroyStreamProcPtr NPP_DestroyStream;
57     NPP_StreamAsFileProcPtr NPP_StreamAsFile;
58     NPP_WriteReadyProcPtr NPP_WriteReady;
59     NPP_WriteProcPtr NPP_Write;
60     NPP_URLNotifyProcPtr NPP_URLNotify;
61 }
62
63 + (NPReason)reasonForError:(NSError *)error;
64 - (NSError *)errorForReason:(NPReason)theReason;
65
66 - (id)initWithRequestURL:(NSURL *)theRequestURL
67            pluginPointer:(NPP)thePluginPointer
68               notifyData:(void *)theNotifyData
69         sendNotification:(BOOL)flag;
70
71 - (void)setRequestURL:(NSURL *)theRequestURL;
72 - (void)setResponseURL:(NSURL *)theResponseURL;
73 - (void)setPluginPointer:(NPP)pluginPointer;
74
75 - (uint16)transferMode;
76 - (NPP)instance;
77
78 - (void)startStreamResponseURL:(NSURL *)theResponseURL
79          expectedContentLength:(long long)expectedContentLength
80               lastModifiedDate:(NSDate *)lastModifiedDate
81                       MIMEType:(NSString *)MIMEType;
82
83 // cancelLoadWithError cancels the NSURLConnection and informs WebKit of the load error.
84 // This method is overriden by subclasses.
85 - (void)cancelLoadWithError:(NSError *)error;
86
87 @end