Reviewed by Geoff.
[WebKit-https.git] / WebKitTools / DumpRenderTree / TestNetscapePlugIn.subproj / PluginObject.c
1 /*
2  IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc. ("Apple") in
3  consideration of your agreement to the following terms, and your use, installation, 
4  modification or redistribution of this Apple software constitutes acceptance of these 
5  terms.  If you do not agree with these terms, please do not use, install, modify or 
6  redistribute this Apple software.
7  
8  In consideration of your agreement to abide by the following terms, and subject to these 
9  terms, Apple grants you a personal, non-exclusive license, under Appleƕs copyrights in 
10  this original Apple software (the "Apple Software"), to use, reproduce, modify and 
11  redistribute the Apple Software, with or without modifications, in source and/or binary 
12  forms; provided that if you redistribute the Apple Software in its entirety and without 
13  modifications, you must retain this notice and the following text and disclaimers in all 
14  such redistributions of the Apple Software.  Neither the name, trademarks, service marks 
15  or logos of Apple Computer, Inc. may be used to endorse or promote products derived from 
16  the Apple Software without specific prior written permission from Apple. Except as expressly
17  stated in this notice, no other rights or licenses, express or implied, are granted by Apple
18  herein, including but not limited to any patent rights that may be infringed by your 
19  derivative works or by other works in which the Apple Software may be incorporated.
20  
21  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO WARRANTIES, 
22  EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, 
23  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS 
24  USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
25  
26  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL 
27  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
28  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, 
29  REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND 
30  WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR 
31  OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #import "PluginObject.h"
35
36 static void pluginInvalidate(NPObject *obj);
37 static bool pluginHasProperty(NPObject *obj, NPIdentifier name);
38 static bool pluginHasMethod(NPObject *obj, NPIdentifier name);
39 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant);
40 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant);
41 static bool pluginInvoke(NPObject *obj, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result);
42 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
43 static NPObject *pluginAllocate(NPP npp, NPClass *theClass);
44 static void pluginDeallocate(NPObject *obj);
45
46 NPNetscapeFuncs *browser;
47
48 static NPClass pluginClass = { 
49     NP_CLASS_STRUCT_VERSION,
50     pluginAllocate, 
51     pluginDeallocate, 
52     pluginInvalidate,
53     pluginHasMethod,
54     pluginInvoke,
55     pluginInvokeDefault,
56     pluginHasProperty,
57     pluginGetProperty,
58     pluginSetProperty,
59 };
60  
61 NPClass *getPluginClass(void)
62 {
63     return &pluginClass;
64 }
65
66 static bool identifiersInitialized = false;
67
68 #define ID_PROPERTY_PROPERTY        0
69 #define NUM_PROPERTY_IDENTIFIERS    1
70
71 static NPIdentifier pluginPropertyIdentifiers[NUM_PROPERTY_IDENTIFIERS];
72 static const NPUTF8 *pluginPropertyIdentifierNames[NUM_PROPERTY_IDENTIFIERS] = {
73     "property"
74 };
75
76 #define ID_TEST_CALLBACK_METHOD     0
77 #define ID_TEST_GETURL              1
78 #define ID_REMOVE_DEFAULT_METHOD    2
79
80 #define NUM_METHOD_IDENTIFIERS      3
81
82 static NPIdentifier pluginMethodIdentifiers[NUM_METHOD_IDENTIFIERS];
83 static const NPUTF8 *pluginMethodIdentifierNames[NUM_METHOD_IDENTIFIERS] = {
84     "testCallback",
85     "getURL",
86     "removeDefaultMethod",
87 };
88
89 static NPUTF8* createCStringFromNPVariant(const NPVariant *variant)
90 {
91     size_t length = NPVARIANT_TO_STRING(*variant).UTF8Length;
92     NPUTF8* result = malloc(length + 1);
93     memcpy(result, NPVARIANT_TO_STRING(*variant).UTF8Characters, length);
94     result[length] = '\0';
95     return result;
96 }
97
98 static void initializeIdentifiers(void)
99 {
100     browser->getstringidentifiers(pluginPropertyIdentifierNames, NUM_PROPERTY_IDENTIFIERS, pluginPropertyIdentifiers);
101     browser->getstringidentifiers(pluginMethodIdentifierNames, NUM_METHOD_IDENTIFIERS, pluginMethodIdentifiers);
102 }
103
104 static bool pluginHasProperty(NPObject *obj, NPIdentifier name)
105 {
106     for (int i = 0; i < NUM_PROPERTY_IDENTIFIERS; i++)
107         if (name == pluginPropertyIdentifiers[i])
108             return true;
109     return false;
110 }
111
112 static bool pluginHasMethod(NPObject *obj, NPIdentifier name)
113 {
114     for (int i = 0; i < NUM_METHOD_IDENTIFIERS; i++)
115         if (name == pluginMethodIdentifiers[i])
116             return true;
117     return false;
118 }
119
120 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant)
121 {
122     if (name == pluginPropertyIdentifiers[ID_PROPERTY_PROPERTY]) {
123         STRINGZ_TO_NPVARIANT("property", *variant);
124         return true;
125     }
126     return false;
127 }
128
129 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant)
130 {
131     return false;
132 }
133
134 static bool pluginInvoke(NPObject *header, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result)
135 {
136     PluginObject *obj = (PluginObject *)header;
137     if (name == pluginMethodIdentifiers[ID_TEST_CALLBACK_METHOD]) {
138         // call whatever method name we're given
139         if (argCount > 0 && NPVARIANT_IS_STRING(args[0])) {
140             NPObject *windowScriptObject;
141             browser->getvalue(obj->npp, NPPVpluginScriptableNPObject, &windowScriptObject);
142
143             NPUTF8* callbackString = createCStringFromNPVariant(&args[0]);
144             NPIdentifier callbackIdentifier = browser->getstringidentifier(callbackString);
145             free(callbackString);
146
147             NPVariant browserResult;
148             browser->invoke(obj->npp, windowScriptObject, callbackIdentifier, 0, 0, &browserResult);
149             browser->releasevariantvalue(&browserResult);
150
151             VOID_TO_NPVARIANT(*result);
152             return true;
153         }
154     } else if (name == pluginMethodIdentifiers[ID_TEST_GETURL]) {
155         if (argCount == 2 && NPVARIANT_IS_STRING(args[0]) && NPVARIANT_IS_STRING(args[1])) {
156             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
157             NPUTF8* targetString = createCStringFromNPVariant(&args[1]);
158             browser->geturl(obj->npp, urlString, targetString);
159             free(urlString);
160             free(targetString);
161
162             VOID_TO_NPVARIANT(*result);
163             return true;
164         }
165     } else if (name == pluginMethodIdentifiers[ID_REMOVE_DEFAULT_METHOD]) {
166         pluginClass.invokeDefault = 0;
167         VOID_TO_NPVARIANT(*result);
168         return true;
169     }
170
171     return false;
172 }
173
174 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result)
175 {
176     INT32_TO_NPVARIANT(1, *result);
177     return true;
178 }
179
180 static void pluginInvalidate(NPObject *obj)
181 {
182 }
183
184 static NPObject *pluginAllocate(NPP npp, NPClass *theClass)
185 {
186     PluginObject *newInstance = malloc(sizeof(PluginObject));
187     
188     if (!identifiersInitialized) {
189         identifiersInitialized = true;
190         initializeIdentifiers();
191     }
192
193     newInstance->npp = npp;
194     
195     return (NPObject *)newInstance;
196 }
197
198 static void pluginDeallocate(NPObject *obj) 
199 {
200     free(obj);
201 }