home *** CD-ROM | disk | FTP | other *** search
/ Tools / WinSN5.0Ver.iso / NETSCAP.50 / WIN1998.ZIP / ns / include / npapi.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-04-08  |  15.2 KB  |  570 lines
  1. /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * The contents of this file are subject to the Netscape Public License
  4.  * Version 1.0 (the "NPL"); you may not use this file except in
  5.  * compliance with the NPL.  You may obtain a copy of the NPL at
  6.  * http://www.mozilla.org/NPL/
  7.  *
  8.  * Software distributed under the NPL is distributed on an "AS IS" basis,
  9.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
  10.  * for the specific language governing rights and limitations under the
  11.  * NPL.
  12.  *
  13.  * The Initial Developer of this code under the NPL is Netscape
  14.  * Communications Corporation.  Portions created by Netscape are
  15.  * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
  16.  * Reserved.
  17.  */
  18.  
  19.  
  20. /*
  21.  *  npapi.h $Revision: 3.1 $
  22.  *  Netscape client plug-in API spec
  23.  */
  24.  
  25. #ifndef _NPAPI_H_
  26. #define _NPAPI_H_
  27.  
  28. #ifdef __OS2__
  29. #pragma pack(1)
  30. #endif
  31.  
  32. #include "jri.h"                /* Java Runtime Interface */
  33.  
  34. #if defined (__OS2__ ) || defined (OS2)
  35. #    ifndef XP_OS2
  36. #        define XP_OS2 1
  37. #    endif /* XP_OS2 */
  38. #endif /* __OS2__ */
  39.  
  40. #ifdef _WINDOWS
  41. #    ifndef XP_WIN
  42. #        define XP_WIN 1
  43. #    endif /* XP_WIN */
  44. #endif /* _WINDOWS */
  45.  
  46. #ifdef __MWERKS__
  47. #    define _declspec __declspec
  48. #    ifdef macintosh
  49. #        ifndef XP_MAC
  50. #            define XP_MAC 1
  51. #        endif /* XP_MAC */
  52. #    endif /* macintosh */
  53. #    ifdef __INTEL__
  54. #        undef NULL
  55. #        ifndef XP_WIN
  56. #            define XP_WIN 1
  57. #        endif /* __INTEL__ */
  58. #    endif /* XP_PC */
  59. #endif /* __MWERKS__ */
  60.  
  61. #ifdef XP_MAC
  62.     #include <Quickdraw.h>
  63.     #include <Events.h>
  64. #endif
  65.  
  66. #ifdef XP_UNIX
  67.     #include <X11/Xlib.h>
  68.     #include <X11/Xutil.h>
  69. #endif
  70.  
  71.  
  72. /*----------------------------------------------------------------------*/
  73. /*             Plugin Version Constants                */
  74. /*----------------------------------------------------------------------*/
  75.  
  76. #define NP_VERSION_MAJOR 0
  77. #define NP_VERSION_MINOR 12
  78.  
  79.  
  80. /* The OS/2 version of Netscape uses RC_DATA to define the
  81.    mime types, file extentions, etc that are required.
  82.    Use a vertical bar to seperate types, end types with \0.
  83.    FileVersion and ProductVersion are 32bit ints, all other
  84.    entries are strings the MUST be terminated wwith a \0.
  85.  
  86. AN EXAMPLE:
  87.  
  88. RCDATA NP_INFO_ProductVersion { 1,0,0,1,}
  89.  
  90. RCDATA NP_INFO_MIMEType    { "video/x-video|",
  91.                              "video/x-flick\0" }
  92. RCDATA NP_INFO_FileExtents { "avi|",
  93.                              "flc\0" }
  94. RCDATA NP_INFO_FileOpenName{ "MMOS2 video player(*.avi)|",
  95.                              "MMOS2 Flc/Fli player(*.flc)\0" }
  96.  
  97. RCDATA NP_INFO_FileVersion       { 1,0,0,1 }
  98. RCDATA NP_INFO_CompanyName       { "Netscape Communications\0" }
  99. RCDATA NP_INFO_FileDescription   { "NPAVI32 Extension DLL\0"
  100. RCDATA NP_INFO_InternalName      { "NPAVI32\0" )
  101. RCDATA NP_INFO_LegalCopyright    { "Copyright Netscape Communications \251 1996\0"
  102. RCDATA NP_INFO_OriginalFilename  { "NVAPI32.DLL" }
  103. RCDATA NP_INFO_ProductName       { "NPAVI32 Dynamic Link Library\0" }
  104.  
  105. */
  106.  
  107.  
  108. /* RC_DATA types for version info - required */
  109. #define NP_INFO_ProductVersion      1
  110. #define NP_INFO_MIMEType            2
  111. #define NP_INFO_FileOpenName        3
  112. #define NP_INFO_FileExtents         4
  113.  
  114. /* RC_DATA types for version info - used if found */
  115. #define NP_INFO_FileDescription     5
  116. #define NP_INFO_ProductName         6
  117.  
  118. /* RC_DATA types for version info - optional */
  119. #define NP_INFO_CompanyName         7
  120. #define NP_INFO_FileVersion         8
  121. #define NP_INFO_InternalName        9
  122. #define NP_INFO_LegalCopyright      10
  123. #define NP_INFO_OriginalFilename    11
  124.  
  125. #ifndef RC_INVOKED
  126.  
  127.  
  128.  
  129. /*----------------------------------------------------------------------*/
  130. /*             Definition of Basic Types                */
  131. /*----------------------------------------------------------------------*/
  132.  
  133. #ifndef _UINT16
  134. typedef unsigned short uint16;
  135. #endif
  136. #ifndef _UINT32
  137. #if defined(__alpha)
  138. typedef unsigned int uint32;
  139. #else /* __alpha */
  140. typedef unsigned long uint32;
  141. #endif /* __alpha */
  142. #endif
  143. #ifndef _INT16
  144. typedef short int16;
  145. #endif
  146. #ifndef _INT32
  147. #if defined(__alpha)
  148. typedef int int32;
  149. #else /* __alpha */
  150. typedef long int32;
  151. #endif /* __alpha */
  152. #endif
  153.  
  154. #ifndef FALSE
  155. #define FALSE (0)
  156. #endif
  157. #ifndef TRUE
  158. #define TRUE (1)
  159. #endif
  160. #ifndef NULL
  161. #define NULL (0L)
  162. #endif
  163.  
  164. typedef unsigned char    NPBool;
  165. typedef int16            NPError;
  166. typedef int16            NPReason;
  167. typedef char*            NPMIMEType;
  168.  
  169.  
  170.  
  171. /*----------------------------------------------------------------------*/
  172. /*             Structures and definitions             */
  173. /*----------------------------------------------------------------------*/
  174.  
  175. #ifdef XP_MAC
  176. #pragma options align=mac68k
  177. #endif
  178.  
  179. /*
  180.  *  NPP is a plug-in's opaque instance handle
  181.  */
  182. typedef struct _NPP
  183. {
  184.     void*    pdata;            /* plug-in private data */
  185.     void*    ndata;            /* netscape private data */
  186. } NPP_t;
  187.  
  188. typedef NPP_t*    NPP;
  189.  
  190.  
  191. typedef struct _NPStream
  192. {
  193.     void*        pdata;        /* plug-in private data */
  194.     void*        ndata;        /* netscape private data */
  195.     const char*     url;
  196.     uint32        end;
  197.     uint32        lastmodified;
  198.     void*        notifyData;
  199. } NPStream;
  200.  
  201.  
  202. typedef struct _NPByteRange
  203. {
  204.     int32    offset;         /* negative offset means from the end */
  205.     uint32    length;
  206.     struct _NPByteRange* next;
  207. } NPByteRange;
  208.  
  209.  
  210. typedef struct _NPSavedData
  211. {
  212.     int32    len;
  213.     void*    buf;
  214. } NPSavedData;
  215.  
  216.  
  217. typedef struct _NPRect
  218. {
  219.     uint16    top;
  220.     uint16    left;
  221.     uint16    bottom;
  222.     uint16    right;
  223. } NPRect;
  224.  
  225. typedef struct _NPSize 
  226. { 
  227.   int32 width; 
  228.   int32 height; 
  229. } NPSize; 
  230.  
  231. #ifdef XP_UNIX
  232. /*
  233.  * Unix specific structures and definitions
  234.  */
  235.  
  236. /*
  237.  * Callback Structures.
  238.  *
  239.  * These are used to pass additional platform specific information.
  240.  */
  241. enum {
  242.     NP_SETWINDOW = 1,
  243.     NP_PRINT
  244. };
  245.  
  246. typedef struct
  247. {
  248.     int32        type;
  249. } NPAnyCallbackStruct;
  250.  
  251. typedef struct
  252. {
  253.     int32            type;
  254.     Display*        display;
  255.     Visual*            visual;
  256.     Colormap        colormap;
  257.     unsigned int    depth;
  258. } NPSetWindowCallbackStruct;
  259.  
  260. typedef struct
  261. {
  262.     int32            type;
  263.     FILE*            fp;
  264. } NPPrintCallbackStruct;
  265.  
  266. #endif /* XP_UNIX */
  267.  
  268. /*
  269.  * List of variable names for which NPP_GetValue shall be implemented
  270.  */
  271. typedef enum {
  272.     NPPVpluginNameString = 1,
  273.     NPPVpluginDescriptionString,
  274.     NPPVpluginWindowBool,
  275.     NPPVpluginTransparentBool,
  276.   NPPVjavaClass,
  277.   NPPVpluginWindowSize
  278. } NPPVariable;
  279.  
  280. /*
  281.  * List of variable names for which NPN_GetValue is implemented by Mozilla
  282.  */
  283. typedef enum {
  284.     NPNVxDisplay = 1,
  285.     NPNVxtAppContext,
  286.     NPNVnetscapeWindow,
  287.     NPNVjavascriptEnabledBool,
  288.     NPNVasdEnabledBool,
  289.     NPNVisOfflineBool
  290. } NPNVariable;
  291.  
  292. /*
  293.  * The type of a NPWindow - it specifies the type of the data structure
  294.  * returned in the window field.
  295.  */
  296. typedef enum {
  297.     NPWindowTypeWindow = 1,
  298.     NPWindowTypeDrawable
  299. } NPWindowType;
  300.  
  301. typedef struct _NPWindow
  302. {
  303.     void*    window;        /* Platform specific window handle */
  304.                                         /* OS/2: x - Position of bottom left corner  */
  305.                                         /* OS/2: y - relative to visible netscape window */
  306.     uint32    x;            /* Position of top left corner relative */
  307.     uint32    y;             /*    to a netscape page.                    */
  308.     uint32    width;        /* Maximum window size */
  309.     uint32    height;
  310.     NPRect    clipRect;    /* Clipping rectangle in port coordinates */
  311.                         /* Used by MAC only.              */
  312. #ifdef XP_UNIX
  313.     void *    ws_info;    /* Platform-dependent additonal data */
  314. #endif /* XP_UNIX */
  315.     NPWindowType type;    /* Is this a window or a drawable? */
  316. } NPWindow;
  317.  
  318.  
  319. typedef struct _NPFullPrint
  320. {
  321.     NPBool    pluginPrinted;    /* Set TRUE if plugin handled fullscreen */
  322.                             /*    printing                             */
  323.     NPBool    printOne;        /* TRUE if plugin should print one copy  */
  324.                             /*    to default printer                     */
  325.     void*    platformPrint;    /* Platform-specific printing info */
  326. } NPFullPrint;
  327.  
  328. typedef struct _NPEmbedPrint
  329. {
  330.     NPWindow    window;
  331.     void*    platformPrint;    /* Platform-specific printing info */
  332. } NPEmbedPrint;
  333.  
  334. typedef struct _NPPrint
  335. {
  336.     uint16    mode;                        /* NP_FULL or NP_EMBED */
  337.     union
  338.     {
  339.         NPFullPrint        fullPrint;        /* if mode is NP_FULL */
  340.         NPEmbedPrint    embedPrint;        /* if mode is NP_EMBED */
  341.     } print;
  342. } NPPrint;
  343.  
  344. #ifdef XP_MAC
  345. typedef EventRecord    NPEvent;
  346. #elif defined(XP_WIN)
  347. typedef struct _NPEvent
  348. {
  349.     uint16   event;
  350.     uint32   wParam;
  351.     uint32   lParam;
  352. } NPEvent;
  353. #elif defined(XP_OS2)
  354. typedef struct _NPEvent
  355. {
  356.     uint32   event;
  357.     uint32   wParam;
  358.     uint32   lParam;
  359. } NPEvent;
  360. #elif defined (XP_UNIX)
  361. typedef XEvent NPEvent;
  362. #else
  363. typedef void*            NPEvent;
  364. #endif /* XP_MAC */
  365.  
  366. #ifdef XP_MAC
  367. typedef RgnHandle NPRegion;
  368. #elif defined(XP_WIN)
  369. typedef HRGN NPRegion;
  370. #elif defined(XP_UNIX)
  371. typedef Region NPRegion;
  372. #else
  373. typedef void *NPRegion;
  374. #endif /* XP_MAC */
  375.  
  376. #ifdef XP_MAC
  377. /*
  378.  *  Mac-specific structures and definitions.
  379.  */
  380.  
  381. typedef struct NP_Port
  382. {
  383.     CGrafPtr    port;        /* Grafport */
  384.     int32        portx;        /* position inside the topmost window */
  385.     int32        porty;
  386. } NP_Port;
  387.  
  388. /*
  389.  *  Non-standard event types that can be passed to HandleEvent
  390.  */
  391. #define getFocusEvent        (osEvt + 16)
  392. #define loseFocusEvent        (osEvt + 17)
  393. #define adjustCursorEvent   (osEvt + 18)
  394.  
  395. #endif /* XP_MAC */
  396.  
  397.  
  398. /*
  399.  * Values for mode passed to NPP_New:
  400.  */
  401. #define NP_EMBED        1
  402. #define NP_FULL         2
  403.  
  404. /*
  405.  * Values for stream type passed to NPP_NewStream:
  406.  */
  407. #define NP_NORMAL        1
  408. #define NP_SEEK         2
  409. #define NP_ASFILE        3
  410. #define NP_ASFILEONLY        4
  411.  
  412. #define NP_MAXREADY    (((unsigned)(~0)<<1)>>1)
  413.  
  414. #ifdef XP_MAC
  415. #pragma options align=reset
  416. #endif
  417.  
  418.  
  419. /*----------------------------------------------------------------------*/
  420. /*             Error and Reason Code definitions            */
  421. /*----------------------------------------------------------------------*/
  422.  
  423. /*
  424.  *    Values of type NPError:
  425.  */
  426. #define NPERR_BASE                            0
  427. #define NPERR_NO_ERROR                        (NPERR_BASE + 0)
  428. #define NPERR_GENERIC_ERROR                    (NPERR_BASE + 1)
  429. #define NPERR_INVALID_INSTANCE_ERROR        (NPERR_BASE + 2)
  430. #define NPERR_INVALID_FUNCTABLE_ERROR        (NPERR_BASE + 3)
  431. #define NPERR_MODULE_LOAD_FAILED_ERROR        (NPERR_BASE + 4)
  432. #define NPERR_OUT_OF_MEMORY_ERROR            (NPERR_BASE + 5)
  433. #define NPERR_INVALID_PLUGIN_ERROR            (NPERR_BASE + 6)
  434. #define NPERR_INVALID_PLUGIN_DIR_ERROR        (NPERR_BASE + 7)
  435. #define NPERR_INCOMPATIBLE_VERSION_ERROR    (NPERR_BASE + 8)
  436. #define NPERR_INVALID_PARAM                (NPERR_BASE + 9)
  437. #define NPERR_INVALID_URL                    (NPERR_BASE + 10)
  438. #define NPERR_FILE_NOT_FOUND                (NPERR_BASE + 11)
  439. #define NPERR_NO_DATA                        (NPERR_BASE + 12)
  440. #define NPERR_STREAM_NOT_SEEKABLE            (NPERR_BASE + 13)
  441.  
  442. /*
  443.  *    Values of type NPReason:
  444.  */
  445. #define NPRES_BASE                0
  446. #define NPRES_DONE                    (NPRES_BASE + 0)
  447. #define NPRES_NETWORK_ERR            (NPRES_BASE + 1)
  448. #define NPRES_USER_BREAK            (NPRES_BASE + 2)
  449.  
  450. /*
  451.  *      Don't use these obsolete error codes any more.
  452.  */
  453. #define NP_NOERR  NP_NOERR_is_obsolete_use_NPERR_NO_ERROR
  454. #define NP_EINVAL NP_EINVAL_is_obsolete_use_NPERR_GENERIC_ERROR
  455. #define NP_EABORT NP_EABORT_is_obsolete_use_NPRES_USER_BREAK
  456.  
  457. /*
  458.  * Version feature information
  459.  */
  460. #define NPVERS_HAS_STREAMOUTPUT     8
  461. #define NPVERS_HAS_NOTIFICATION     9
  462. #define NPVERS_HAS_LIVECONNECT        9
  463. #define NPVERS_WIN16_HAS_LIVECONNECT    9
  464. #define NPVERS_68K_HAS_LIVECONNECT    11
  465. #define NPVERS_HAS_WINDOWLESS       11
  466.  
  467.  
  468. /*----------------------------------------------------------------------*/
  469. /*             Function Prototypes                */
  470. /*----------------------------------------------------------------------*/
  471.  
  472. #if defined(_WINDOWS) && !defined(WIN32)
  473. #define NP_LOADDS  _loadds
  474. #else
  475. #if defined(__OS2__)
  476. #define NP_LOADDS _System
  477. #else
  478. #define NP_LOADDS
  479. #endif
  480. #endif
  481.  
  482. #ifdef __cplusplus
  483. extern "C" {
  484. #endif
  485.  
  486. /*
  487.  * NPP_* functions are provided by the plugin and called by the navigator.
  488.  */
  489.  
  490. #ifdef XP_UNIX
  491. char*                    NPP_GetMIMEDescription(void);
  492. #endif /* XP_UNIX */
  493.  
  494. NPError     NP_LOADDS    NPP_Initialize(void);
  495. void        NP_LOADDS    NPP_Shutdown(void);
  496. NPError     NP_LOADDS    NPP_New(NPMIMEType pluginType, NPP instance,
  497.                                 uint16 mode, int16 argc, char* argn[],
  498.                                 char* argv[], NPSavedData* saved);
  499. NPError     NP_LOADDS    NPP_Destroy(NPP instance, NPSavedData** save);
  500. NPError     NP_LOADDS    NPP_SetWindow(NPP instance, NPWindow* window);
  501. NPError     NP_LOADDS    NPP_NewStream(NPP instance, NPMIMEType type,
  502.                                       NPStream* stream, NPBool seekable,
  503.                                       uint16* stype);
  504. NPError     NP_LOADDS    NPP_DestroyStream(NPP instance, NPStream* stream,
  505.                                           NPReason reason);
  506. int32        NP_LOADDS    NPP_WriteReady(NPP instance, NPStream* stream);
  507. int32        NP_LOADDS    NPP_Write(NPP instance, NPStream* stream, int32 offset,
  508.                                   int32 len, void* buffer);
  509. void        NP_LOADDS    NPP_StreamAsFile(NPP instance, NPStream* stream,
  510.                                          const char* fname);
  511. void        NP_LOADDS    NPP_Print(NPP instance, NPPrint* platformPrint);
  512. int16       NP_LOADDS    NPP_HandleEvent(NPP instance, void* event);
  513. void        NP_LOADDS    NPP_URLNotify(NPP instance, const char* url,
  514.                                       NPReason reason, void* notifyData);
  515. jref        NP_LOADDS            NPP_GetJavaClass(void);
  516. NPError            NP_LOADDS    NPP_GetValue(void *instance, NPPVariable variable,
  517.                                      void *value);
  518. NPError            NP_LOADDS    NPP_SetValue(void *instance, NPNVariable variable,
  519.                                      void *value);
  520.  
  521. /*
  522.  * NPN_* functions are provided by the navigator and called by the plugin.
  523.  */
  524. void       NP_LOADDS    NPN_Version(int* plugin_major, int* plugin_minor,
  525.                             int* netscape_major, int* netscape_minor);
  526. NPError    NP_LOADDS    NPN_GetURLNotify(NPP instance, const char* url,
  527.                                  const char* target, void* notifyData);
  528. NPError    NP_LOADDS    NPN_GetURL(NPP instance, const char* url,
  529.                            const char* target);
  530. NPError    NP_LOADDS    NPN_PostURLNotify(NPP instance, const char* url,
  531.                                   const char* target, uint32 len,
  532.                                   const char* buf, NPBool file,
  533.                                   void* notifyData);
  534. NPError    NP_LOADDS    NPN_PostURL(NPP instance, const char* url,
  535.                             const char* target, uint32 len,
  536.                             const char* buf, NPBool file);
  537. NPError    NP_LOADDS    NPN_RequestRead(NPStream* stream, NPByteRange* rangeList);
  538. NPError    NP_LOADDS    NPN_NewStream(NPP instance, NPMIMEType type,
  539.                               const char* target, NPStream** stream);
  540. int32      NP_LOADDS    NPN_Write(NPP instance, NPStream* stream, int32 len,
  541.                           void* buffer);
  542. NPError    NP_LOADDS    NPN_DestroyStream(NPP instance, NPStream* stream,
  543.                                   NPReason reason);
  544. void       NP_LOADDS    NPN_Status(NPP instance, const char* message);
  545. const char* NP_LOADDS    NPN_UserAgent(NPP instance);
  546. void*      NP_LOADDS    NPN_MemAlloc(uint32 size);
  547. void       NP_LOADDS    NPN_MemFree(void* ptr);
  548. uint32     NP_LOADDS    NPN_MemFlush(uint32 size);
  549. void       NP_LOADDS    NPN_ReloadPlugins(NPBool reloadPages);
  550. JRIEnv*       NP_LOADDS    NPN_GetJavaEnv(void);
  551. jref       NP_LOADDS    NPN_GetJavaPeer(NPP instance);
  552. NPError       NP_LOADDS    NPN_GetValue(NPP instance, NPNVariable variable,
  553.                              void *value);
  554. NPError       NP_LOADDS    NPN_SetValue(NPP instance, NPPVariable variable,
  555.                              void *value);
  556. void        NP_LOADDS    NPN_InvalidateRect(NPP instance, NPRect *invalidRect);
  557. void        NP_LOADDS    NPN_InvalidateRegion(NPP instance, NPRegion invalidRegion);
  558. void       NP_LOADDS    NPN_ForceRedraw(NPP instance);
  559.  
  560. #ifdef __cplusplus
  561. }  /* end extern "C" */
  562. #endif
  563.  
  564. #endif                  /* RC_INVOKED */
  565. #ifdef __OS2__
  566. #pragma pack()
  567. #endif
  568.  
  569. #endif /* _NPAPI_H_ */
  570.