1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/* ***** BEGIN LICENSE BLOCK *****
*
* Copyright (c) 2008, Mozilla Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of the Mozilla Corporation nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Contributor(s):
* Josh Aas <josh@mozilla.com>
*
* ***** END LICENSE BLOCK ***** */
#ifndef nptest_platform_h_
#define nptest_platform_h_
#include "nptest.h"
/**
* Returns true if the plugin supports windowed mode
*/
bool pluginSupportsWindowMode();
/**
* Returns true if the plugin supports windowless mode. At least one of
* "pluginSupportsWindowMode" and "pluginSupportsWindowlessMode" must
* return true.
*/
bool pluginSupportsWindowlessMode();
/**
* Initialize the plugin instance. Returning an error here will cause the
* plugin instantiation to fail.
*/
NPError pluginInstanceInit(InstanceData* instanceData);
/**
* Shutdown the plugin instance.
*/
void pluginInstanceShutdown(InstanceData* instanceData);
/**
* Set the instanceData's window to newWindow.
*/
void pluginDoSetWindow(InstanceData* instanceData, NPWindow* newWindow);
/**
* Initialize the window for a windowed plugin. oldWindow is the old
* native window value. This will never be called for windowless plugins.
*/
void pluginWidgetInit(InstanceData* instanceData, void* oldWindow);
/**
* Handle an event for a windowless plugin. (Windowed plugins are
* responsible for listening for their own events.)
*/
int16_t pluginHandleEvent(InstanceData* instanceData, void* event);
enum RectEdge {
EDGE_LEFT = 0,
EDGE_TOP = 1,
EDGE_RIGHT = 2,
EDGE_BOTTOM = 3
};
enum {
NPTEST_INT32_ERROR = 0x7FFFFFFF
};
/**
* Return the coordinate of the given edge of the plugin's area, relative
* to the top-left corner of the toplevel window containing the plugin,
* including window decorations. Only works for window-mode plugins
* and Mac plugins.
* Returns NPTEST_ERROR on error.
*/
int32_t pluginGetEdge(InstanceData* instanceData, RectEdge edge);
/**
* Return the number of rectangles in the plugin's clip region. Only
* works for window-mode plugins and Mac plugins.
* Returns NPTEST_ERROR on error.
*/
int32_t pluginGetClipRegionRectCount(InstanceData* instanceData);
/**
* Return the coordinate of the given edge of a rectangle in the plugin's
* clip region, relative to the top-left corner of the toplevel window
* containing the plugin, including window decorations. Only works for
* window-mode plugins and Mac plugins.
* Returns NPTEST_ERROR on error.
*/
int32_t pluginGetClipRegionRectEdge(InstanceData* instanceData,
int32_t rectIndex, RectEdge edge);
/**
* Check that the platform-specific plugin state is internally consistent.
* Just return if everything is OK, otherwise append error messages
* to 'error' separated by \n.
*/
void pluginDoInternalConsistencyCheck(InstanceData* instanceData, std::string& error);
/**
* Get the current clipboard item as text. If the clipboard item
* isn't text, the returned value is undefined.
*/
std::string pluginGetClipboardText(InstanceData* instanceData);
/**
* Crash while in a nested event loop. The goal is to catch the
* browser processing the XPCOM event generated from the plugin's
* crash while other plugin code is still on the stack.
* See https://bugzilla.mozilla.org/show_bug.cgi?id=550026.
*/
bool pluginCrashInNestedLoop(InstanceData* instanceData);
/**
* Generate an X11 protocol error to terminate the plugin process.
*/
bool pluginTriggerXError(InstanceData* instanceData);
/**
* Destroy gfx things that might be shared with the parent process
* when we're run out-of-process. It's not expected that this
* function will be called when the test plugin is loaded in-process,
* and bad things will happen if it is called.
*
* This call leaves the plugin subprocess in an undefined state. It
* must not be used after this call or weird things will happen.
*/
bool pluginDestroySharedGfxStuff(InstanceData* instanceData);
/**
* Checks to see if the native widget is marked as visible. Works
* in e10s and non-e10s. Useful in testing e10s related compositor
* plugin window functionality. Supported on Windows.
*/
bool pluginNativeWidgetIsVisible(InstanceData* instanceData);
#endif // nptest_platform_h_
|
