6b767ff0ec7973f5a37f7d6fdf151c7427b244e8
[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
33 @class WebBaseNetscapePluginView;
34 @class NSURLResponse;
35
36 @interface WebBaseNetscapePluginStream : NSObject
37 {
38     NSMutableData *deliveryData;
39     NSURL *requestURL;
40     NSURL *responseURL;
41     NSString *MIMEType;
42     
43     NPP instance;
44     uint16 transferMode;
45     int32 offset;
46     NPStream stream;
47     char *path;
48     BOOL sendNotification;
49     void *notifyData;
50     WebBaseNetscapePluginView *pluginView;
51     NPReason reason;
52     BOOL isTerminated;
53         
54     NPP_NewStreamProcPtr NPP_NewStream;
55     NPP_DestroyStreamProcPtr NPP_DestroyStream;
56     NPP_StreamAsFileProcPtr NPP_StreamAsFile;
57     NPP_WriteReadyProcPtr NPP_WriteReady;
58     NPP_WriteProcPtr NPP_Write;
59     NPP_URLNotifyProcPtr NPP_URLNotify;
60 }
61
62 + (NPReason)reasonForError:(NSError *)error;
63 - (NSError *)errorForReason:(NPReason)theReason;
64
65 - (id)initWithRequestURL:(NSURL *)theRequestURL
66            pluginPointer:(NPP)thePluginPointer
67               notifyData:(void *)theNotifyData
68         sendNotification:(BOOL)flag;
69
70 - (void)setRequestURL:(NSURL *)theRequestURL;
71 - (void)setResponseURL:(NSURL *)theResponseURL;
72 - (void)setPluginPointer:(NPP)pluginPointer;
73
74 - (uint16)transferMode;
75 - (NPP)instance;
76
77 - (void)startStreamResponseURL:(NSURL *)theResponseURL
78          expectedContentLength:(long long)expectedContentLength
79               lastModifiedDate:(NSDate *)lastModifiedDate
80                       MIMEType:(NSString *)MIMEType;
81 - (void)startStreamWithResponse:(NSURLResponse *)r;
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 // destroyStreamWithError tells the plug-in that the load is completed (error == nil) or ended in error.
88 - (void)destroyStreamWithError:(NSError *)error;
89
90 // cancelLoadAndDestoryStreamWithError calls cancelLoadWithError: then destroyStreamWithError:.
91 - (void)cancelLoadAndDestroyStreamWithError:(NSError *)error;
92
93 - (void)receivedData:(NSData *)data;
94 - (void)finishedLoadingWithData:(NSData *)data;
95
96 @end