home *** CD-ROM | disk | FTP | other *** search
/ Netscape Plug-Ins Developer's Kit / Netscape_Plug-Ins_Developers_Kit.iso / source / Chap05 / zero / INCLUDE / NPAPI.H < prev    next >
Encoding:
C/C++ Source or Header  |  1996-04-30  |  9.8 KB  |  386 lines
  1. /* -*- Mode: C; tab-width: 4; -*- */
  2. /*
  3.  *  npapi.h $Revision: 1.71 $
  4.  *  Netscape client plug-in API spec
  5.  */
  6.  
  7. #ifndef _NPAPI_H_
  8. #define _NPAPI_H_
  9.  
  10. #include "jri.h"        /* Java Runtime Interface */
  11.  
  12.  
  13. /* XXX this needs to get out of here */
  14. #if defined(__MWERKS__)
  15. #ifndef XP_MAC
  16. #define XP_MAC
  17. #endif
  18. #endif
  19.  
  20.  
  21.  
  22. /*----------------------------------------------------------------------*/
  23. /*                   Plugin Version Constants                           */
  24. /*----------------------------------------------------------------------*/
  25.  
  26. #define NP_VERSION_MAJOR 0
  27. #define NP_VERSION_MINOR 9
  28.  
  29.  
  30.  
  31. /*----------------------------------------------------------------------*/
  32. /*                   Definition of Basic Types                          */
  33. /*----------------------------------------------------------------------*/
  34.  
  35. #ifndef _UINT16
  36. typedef unsigned short uint16;
  37. #endif
  38. #ifndef _UINT32
  39. #if defined(__alpha)
  40. typedef unsigned int uint32;
  41. #else /* __alpha */
  42. typedef unsigned long uint32;
  43. #endif /* __alpha */
  44. #endif
  45. #ifndef _INT16
  46. typedef short int16;
  47. #endif
  48. #ifndef _INT32
  49. #if defined(__alpha)
  50. typedef int int32;
  51. #else /* __alpha */
  52. typedef long int32;
  53. #endif /* __alpha */
  54. #endif
  55.  
  56. #ifndef FALSE
  57. #define FALSE (0)
  58. #endif
  59. #ifndef TRUE
  60. #define TRUE (1)
  61. #endif
  62. #ifndef NULL
  63. #define NULL (0L)
  64. #endif
  65.  
  66. typedef unsigned char   NPBool;
  67. typedef void*           NPEvent;
  68. typedef int16           NPError;
  69. typedef int16            NPReason;
  70. typedef char*           NPMIMEType;
  71.  
  72.  
  73.  
  74. /*----------------------------------------------------------------------*/
  75. /*                   Structures and definitions                         */
  76. /*----------------------------------------------------------------------*/
  77.  
  78. /*
  79.  *  NPP is a plug-in's opaque instance handle
  80.  */
  81. typedef struct _NPP
  82. {
  83.     void*    pdata;            /* plug-in private data */
  84.     void*    ndata;            /* netscape private data */
  85. } NPP_t;
  86.  
  87. typedef NPP_t*  NPP;
  88.  
  89.  
  90. typedef struct _NPStream
  91. {
  92.     void*        pdata;        /* plug-in private data */
  93.     void*        ndata;        /* netscape private data */
  94.     const char*    url;
  95.     uint32        end;
  96.     uint32        lastmodified;
  97.     void*        notifyData;
  98. } NPStream;
  99.  
  100.  
  101. typedef struct _NPByteRange
  102. {
  103.     int32    offset;            /* negative offset means from the end */
  104.     uint32    length;
  105.     struct _NPByteRange* next;
  106. } NPByteRange;
  107.  
  108.  
  109. typedef struct _NPSavedData
  110. {
  111.     int32    len;
  112.     void*    buf;
  113. } NPSavedData;
  114.  
  115.  
  116. typedef struct _NPRect
  117. {
  118.     uint16    top;
  119.     uint16    left;
  120.     uint16    bottom;
  121.     uint16    right;
  122. } NPRect;
  123.  
  124.  
  125. #ifdef XP_UNIX
  126. /*
  127.  * Unix specific structures and definitions
  128.  */
  129. #include <X11/Xlib.h>
  130.  
  131. /*
  132.  * Callback Structures.
  133.  *
  134.  * These are used to pass additional platform specific information.
  135.  */
  136. enum {
  137.     NP_SETWINDOW = 1
  138. };
  139.  
  140. typedef struct
  141. {
  142.     int32 type;
  143. } NPAnyCallbackStruct;
  144.  
  145. typedef struct
  146. {
  147.     int32            type;
  148.     Display*        display;
  149.     Visual*            visual;
  150.     Colormap        colormap;
  151.     unsigned int    depth;
  152. } NPSetWindowCallbackStruct;
  153.  
  154. /*
  155.  * List of variable names for which NPP_GetValue shall be implemented
  156.  */
  157. typedef enum {
  158.     NPPVpluginNameString = 1,
  159.     NPPVpluginDescriptionString
  160. } NPPVariable;
  161.  
  162. /*
  163.  * List of variable names for which NPN_GetValue is implemented by Mozilla
  164.  */
  165. typedef enum {
  166.     NPNVxDisplay = 1,
  167.     NPNVxtAppContext
  168. } NPNVariable;
  169.  
  170. #endif /* XP_UNIX */
  171.  
  172.  
  173. typedef struct _NPWindow 
  174. {
  175.     void*    window;        /* Platform specific window handle */
  176.     uint32    x;            /* Position of top left corner relative */
  177.     uint32    y;             /*    to a netscape page.        */
  178.     uint32    width;        /* Maximum window size */
  179.     uint32    height;
  180.     NPRect    clipRect;    /* Clipping rectangle in port coordinates */
  181.                         /* Used by MAC only.                      */
  182. #ifdef XP_UNIX
  183.     void *    ws_info;    /* Platform-dependent additonal data */
  184. #endif /* XP_UNIX */
  185. } NPWindow;
  186.  
  187.  
  188. typedef struct _NPFullPrint
  189. {
  190.     NPBool    pluginPrinted;    /* Set TRUE if plugin handled fullscreen */
  191.                             /*    printing                         */
  192.     NPBool  printOne;        /* TRUE if plugin should print one copy  */
  193.                             /*    to default printer               */
  194.     void*    platformPrint;    /* Platform-specific printing info */
  195. } NPFullPrint;
  196.  
  197. typedef struct _NPEmbedPrint
  198. {
  199.     NPWindow    window;
  200.     void*       platformPrint;    /* Platform-specific printing info */
  201. } NPEmbedPrint;
  202.  
  203. typedef struct _NPPrint
  204. {
  205.     uint16    mode;                /* NP_FULL or NP_EMBED */
  206.     union
  207.     {
  208.     NPFullPrint    fullPrint;        /* if mode is NP_FULL */
  209.     NPEmbedPrint embedPrint;    /* if mode is NP_EMBED */
  210.     } print;
  211. } NPPrint;
  212.  
  213.  
  214. #ifdef XP_MAC
  215. /*
  216.  *  Mac-specific structures and definitions.
  217.  */
  218.  
  219. #include <Quickdraw.h>
  220. #include <Events.h>
  221.  
  222. typedef struct NP_Port
  223. {
  224.     CGrafPtr    port;        /* Grafport */
  225.     int32        portx;        /* position inside the topmost window */
  226.     int32        porty;
  227. } NP_Port;
  228.  
  229. /*
  230.  *  Non-standard event types that can be passed to HandleEvent
  231.  */
  232. #define getFocusEvent       (osEvt + 16)
  233. #define loseFocusEvent      (osEvt + 17)
  234. #define adjustCursorEvent   (osEvt + 18)
  235.  
  236. #endif /* XP_MAC */
  237.  
  238.  
  239. /*
  240.  * Values for mode passed to NPP_New:
  241.  */
  242. #define NP_EMBED        1
  243. #define NP_FULL            2
  244.  
  245. /*
  246.  * Values for stream type passed to NPP_NewStream:
  247.  */
  248. #define NP_NORMAL        1
  249. #define NP_SEEK            2
  250. #define NP_ASFILE        3
  251. #define NP_ASFILEONLY    4
  252.  
  253. #define NP_MAXREADY    (((unsigned)(~0)<<1)>>1)
  254.  
  255.  
  256.  
  257. /*----------------------------------------------------------------------*/
  258. /*                   Error and Reason Code definitions                  */
  259. /*----------------------------------------------------------------------*/
  260.  
  261. /*
  262.  *    Values of type NPError:
  263.  */
  264. #define NPERR_BASE                            0
  265. #define NPERR_NO_ERROR                        (NPERR_BASE + 0)
  266. #define NPERR_GENERIC_ERROR                    (NPERR_BASE + 1)
  267. #define NPERR_INVALID_INSTANCE_ERROR        (NPERR_BASE + 2)
  268. #define NPERR_INVALID_FUNCTABLE_ERROR        (NPERR_BASE + 3)
  269. #define NPERR_MODULE_LOAD_FAILED_ERROR        (NPERR_BASE + 4)
  270. #define NPERR_OUT_OF_MEMORY_ERROR            (NPERR_BASE + 5)
  271. #define NPERR_INVALID_PLUGIN_ERROR            (NPERR_BASE + 6)
  272. #define NPERR_INVALID_PLUGIN_DIR_ERROR        (NPERR_BASE + 7)
  273. #define NPERR_INCOMPATIBLE_VERSION_ERROR    (NPERR_BASE + 8)
  274. #define NPERR_INVALID_PARAM                 (NPERR_BASE + 9)
  275. #define NPERR_INVALID_URL                     (NPERR_BASE + 10)
  276. #define NPERR_FILE_NOT_FOUND                 (NPERR_BASE + 11)
  277. #define NPERR_NO_DATA                         (NPERR_BASE + 12)
  278. #define NPERR_STREAM_NOT_SEEKABLE            (NPERR_BASE + 13)
  279.  
  280. /*
  281.  *    Values of type NPReason:
  282.  */
  283. #define NPRES_BASE                          0
  284. #define NPRES_NETWORK_ERR                   (NPRES_BASE + 0)
  285. #define NPRES_USER_BREAK                    (NPRES_BASE + 2)
  286. #define NPRES_DONE                          (NPRES_BASE + 3)
  287.  
  288. /*
  289.  *    Don't use these obsolete error codes any more.
  290.  */
  291. #define NP_NOERR  NP_NOERR_is_obsolete_use_NPERR_NO_ERROR
  292. #define NP_EINVAL NP_EINVAL_is_obsolete_use_NPERR_GENERIC_ERROR
  293. #define NP_EABORT NP_EABORT_is_obsolete_use_NPRES_USER_BREAK
  294.  
  295.  
  296.  
  297.  
  298. /*----------------------------------------------------------------------*/
  299. /*                   Function Prototypes                                */
  300. /*----------------------------------------------------------------------*/
  301.  
  302. #if defined(_WINDOWS) && !defined(WIN32)
  303. #define NP_LOADDS  _loadds
  304. #else
  305. #define NP_LOADDS
  306. #endif
  307.  
  308. #ifdef __cplusplus
  309. extern "C" {
  310. #endif
  311.  
  312. /*
  313.  * NPP_* functions are provided by the plugin and called by the navigator.
  314.  */
  315.  
  316. #ifdef XP_UNIX
  317. char*                    NPP_GetMIMEDescription(void);
  318. NPError                    NPP_GetValue(void *, NPPVariable variable, void *value);
  319. #endif /* XP_UNIX */
  320. NPError                   NPP_Initialize(void);
  321. void                      NPP_Shutdown(void);
  322. NPError     NP_LOADDS    NPP_New(NPMIMEType pluginType, NPP instance,
  323.                             uint16 mode, int16 argc, char* argn[],
  324.                             char* argv[], NPSavedData* saved);
  325. NPError     NP_LOADDS    NPP_Destroy(NPP instance, NPSavedData** save);
  326. NPError     NP_LOADDS    NPP_SetWindow(NPP instance, NPWindow* window);
  327. NPError     NP_LOADDS    NPP_NewStream(NPP instance, NPMIMEType type,
  328.                             NPStream* stream, NPBool seekable,
  329.                             uint16* stype);
  330. NPError     NP_LOADDS    NPP_DestroyStream(NPP instance, NPStream* stream,
  331.                             NPReason reason);
  332. int32       NP_LOADDS    NPP_WriteReady(NPP instance, NPStream* stream);
  333. int32       NP_LOADDS    NPP_Write(NPP instance, NPStream* stream, int32 offset,
  334.                             int32 len, void* buffer);
  335. void        NP_LOADDS    NPP_StreamAsFile(NPP instance, NPStream* stream,
  336.                             const char* fname);
  337. void        NP_LOADDS    NPP_Print(NPP instance, NPPrint* platformPrint);
  338. int16                     NPP_HandleEvent(NPP instance, void* event);
  339. void                     NPP_URLNotify(NPP instance, const char* url,
  340.                             NPReason reason, void* notifyData);
  341. jref                    NPP_GetJavaClass(void);
  342.  
  343.  
  344. /*
  345.  * NPN_* functions are provided by the navigator and called by the plugin.
  346.  */
  347.  
  348. #ifdef XP_UNIX
  349. NPError                    NPN_GetValue(NPP instance, NPNVariable variable,
  350.                             void *value);
  351. #endif /* XP_UNIX */
  352. void                    NPN_Version(int* plugin_major, int* plugin_minor,
  353.                             int* netscape_major, int* netscape_minor);
  354. NPError                 NPN_GetURLNotify(NPP instance, const char* url,
  355.                             const char* target, void* notifyData);
  356. NPError                 NPN_GetURL(NPP instance, const char* url,
  357.                             const char* target);
  358. NPError                 NPN_PostURLNotify(NPP instance, const char* url,
  359.                             const char* target, uint32 len, const char* buf,
  360.                             NPBool file, void* notifyData);
  361. NPError                 NPN_PostURL(NPP instance, const char* url,
  362.                             const char* target, uint32 len, const char* buf,
  363.                             NPBool file);
  364. NPError                 NPN_RequestRead(NPStream* stream, NPByteRange* rangeList);
  365. NPError                 NPN_NewStream(NPP instance, NPMIMEType type,
  366.                             const char* target, NPStream** stream);
  367. int32                   NPN_Write(NPP instance, NPStream* stream, int32 len,
  368.                             void* buffer);
  369. NPError                     NPN_DestroyStream(NPP instance, NPStream* stream,
  370.                             NPReason reason);
  371. void                    NPN_Status(NPP instance, const char* message);
  372. const char*             NPN_UserAgent(NPP instance);
  373. void*                   NPN_MemAlloc(uint32 size);
  374. void                    NPN_MemFree(void* ptr);
  375. uint32                  NPN_MemFlush(uint32 size);
  376. void                    NPN_ReloadPlugins(NPBool reloadPages);
  377. JRIEnv*                    NPN_GetJavaEnv(void);
  378. jref                    NPN_GetJavaPeer(NPP instance);
  379.  
  380.  
  381. #ifdef __cplusplus
  382. }  /* end extern "C" */
  383. #endif
  384.  
  385. #endif /* _NPAPI_H_ */
  386.