/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* ***** BEGIN LICENSE BLOCK *****

 * Version: MPL 1.1/GPL 2.0/LGPL 2.1

 *

 * The contents of this file are subject to the Mozilla Public License Version

 * 1.1 (the "License"); you may not use this file except in compliance with

 * the License. You may obtain a copy of the License at

 * http://www.mozilla.org/MPL/

 *

 * Software distributed under the License is distributed on an "AS IS" basis,

 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License

 * for the specific language governing rights and limitations under the

 * License.

 *

 * The Original Code is mozilla.org code.

 *

 * The Initial Developer of the Original Code is

 * Netscape Communications Corporation.

 * Portions created by the Initial Developer are Copyright (C) 1998

 * the Initial Developer. All Rights Reserved.

 *

 * Contributor(s):

 *

 * Alternatively, the contents of this file may be used under the terms of

 * either the GNU General Public License Version 2 or later (the "GPL"), or

 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),

 * in which case the provisions of the GPL or the LGPL are applicable instead

 * of those above. If you wish to allow use of your version of this file only

 * under the terms of either the GPL or the LGPL, and not to allow others to

 * use your version of this file under the terms of the MPL, indicate your

 * decision by deleting the provisions above and replace them with the notice

 * and other provisions required by the GPL or the LGPL. If you do not delete

 * the provisions above, a recipient may use your version of this file under

 * the terms of any one of the MPL, the GPL or the LGPL.

 *

 * ***** END LICENSE BLOCK ***** */

/*

 *  npapi.h $Revision: 3.48 $

 *  Netscape client plug-in API spec

 */

#ifndef _NPAPI_H_

#define _NPAPI_H_

#ifdef __OS2__

#pragma pack(1)

#endif

#include "prtypes.h"

/* Copied from xp_core.h */

/* removed #ifdef for hpux defined in /usr/include/model.h */

#ifndef _INT16

#define _INT16

#endif

#ifndef _INT32

#define _INT32

#endif

#ifndef _UINT16

#define _UINT16

#endif

#ifndef _UINT32

#define _UINT32

#endif

/* 

 * NO_NSPR_10_SUPPORT disables the inclusion 

 * of obsolete/protypes.h, whose int16, uint16, 

 * int32, and uint32 typedefs conflict with those 

 * in this file. 

 */ 

#ifndef NO_NSPR_10_SUPPORT

#define NO_NSPR_10_SUPPORT

#endif

#ifdef OJI

#include "jri.h"                /* Java Runtime Interface */

#endif

#if defined (__OS2__ ) || defined (OS2)

#	ifndef XP_OS2

#		define XP_OS2 1

#	endif /* XP_OS2 */

#endif /* __OS2__ */

#ifdef _WINDOWS

#	include <windef.h>

#	ifndef XP_WIN

#		define XP_WIN 1

#	endif /* XP_WIN */

#endif /* _WINDOWS */

#ifdef __MWERKS__

#	define _declspec __declspec

#	ifdef __INTEL__

#		undef NULL

#		ifndef XP_WIN

#			define XP_WIN 1

#		endif /* XP_WIN */

#	endif /* __INTEL__ */

#endif /* __MWERKS__ */

#ifdef XP_MACOSX

#include <Carbon/Carbon.h>

#ifdef __LP64__

#define NP_NO_QUICKDRAW

#endif

#endif

#if defined(XP_UNIX) 

#	include <stdio.h>

#	if defined(MOZ_X11)

#		include <X11/Xlib.h>

#		include <X11/Xutil.h>

#	endif

#endif

/*----------------------------------------------------------------------*/

/*                        Plugin Version Constants                      */

/*----------------------------------------------------------------------*/

#define NP_VERSION_MAJOR 0

#define NP_VERSION_MINOR 19

/* The OS/2 version of Netscape uses RC_DATA to define the

   mime types, file extensions, etc that are required.

   Use a vertical bar to separate types, end types with \0.

   FileVersion and ProductVersion are 32bit ints, all other

   entries are strings the MUST be terminated wwith a \0.

AN EXAMPLE:

RCDATA NP_INFO_ProductVersion { 1,0,0,1,}

RCDATA NP_INFO_MIMEType    { "video/x-video|",

                             "video/x-flick\0" }

RCDATA NP_INFO_FileExtents { "avi|",

                             "flc\0" }

RCDATA NP_INFO_FileOpenName{ "MMOS2 video player(*.avi)|",

                             "MMOS2 Flc/Fli player(*.flc)\0" }

RCDATA NP_INFO_FileVersion       { 1,0,0,1 }

RCDATA NP_INFO_CompanyName       { "Netscape Communications\0" }

RCDATA NP_INFO_FileDescription   { "NPAVI32 Extension DLL\0"

RCDATA NP_INFO_InternalName      { "NPAVI32\0" )

RCDATA NP_INFO_LegalCopyright    { "Copyright Netscape Communications \251 1996\0"

RCDATA NP_INFO_OriginalFilename  { "NVAPI32.DLL" }

RCDATA NP_INFO_ProductName       { "NPAVI32 Dynamic Link Library\0" }

*/

/* RC_DATA types for version info - required */

#define NP_INFO_ProductVersion      1

#define NP_INFO_MIMEType            2

#define NP_INFO_FileOpenName        3

#define NP_INFO_FileExtents         4

/* RC_DATA types for version info - used if found */

#define NP_INFO_FileDescription     5

#define NP_INFO_ProductName         6

/* RC_DATA types for version info - optional */

#define NP_INFO_CompanyName         7

#define NP_INFO_FileVersion         8

#define NP_INFO_InternalName        9

#define NP_INFO_LegalCopyright      10

#define NP_INFO_OriginalFilename    11

#ifndef RC_INVOKED

/*----------------------------------------------------------------------*/

/*                       Definition of Basic Types                      */

/*----------------------------------------------------------------------*/

#ifndef _UINT16

typedef unsigned short uint16;

#endif

#ifndef _UINT32

#    if defined(__alpha) || defined(__amd64__) || defined(__x86_64__)

typedef unsigned int uint32;

#    else  /* __alpha */

typedef unsigned long uint32;

#    endif /* __alpha */

#endif

/*

 * AIX defines these in sys/inttypes.h included from sys/types.h

 */

#ifndef AIX

#ifndef _INT16

typedef short int16;

#endif

#ifndef _INT32

#    if defined(__alpha) || defined(__amd64__) || defined(__x86_64__)

typedef int int32;

#    else  /* __alpha */

typedef long int32;

#    endif /* __alpha */

#endif

#endif

#ifndef FALSE

#define FALSE (0)

#endif

#ifndef TRUE

#define TRUE (1)

#endif

#ifndef NULL

#define NULL (0L)

#endif

#ifdef XP_MACOSX

typedef enum {

#ifndef NP_NO_QUICKDRAW

  NPDrawingModelQuickDraw = 0,

#endif

  NPDrawingModelCoreGraphics = 1

} NPDrawingModel;

#endif

typedef unsigned char	NPBool;

typedef int16			NPError;

typedef int16			NPReason;

typedef char*			NPMIMEType;

/*----------------------------------------------------------------------*/

/*                       Structures and definitions                     */

/*----------------------------------------------------------------------*/

/*

 *  NPP is a plug-in's opaque instance handle

 */

typedef struct _NPP

{

  void*	pdata;      /* plug-in private data */

  void*	ndata;      /* netscape private data */

} NPP_t;

typedef NPP_t*  NPP;

typedef struct _NPStream

{

  void*  pdata; /* plug-in private data */

  void*  ndata; /* netscape private data */

  const  char* url;

  uint32 end;

  uint32 lastmodified;

  void*  notifyData;

  const  char* headers; /* Response headers from host.

                         * Exists only for >= NPVERS_HAS_RESPONSE_HEADERS.

                         * Used for HTTP only; NULL for non-HTTP.

                         * Available from NPP_NewStream onwards.

                         * Plugin should copy this data before storing it.

                         * Includes HTTP status line and all headers,

                         * preferably verbatim as received from server,

                         * headers formatted as in HTTP ("Header: Value"),

                         * and newlines (\n, NOT \r\n) separating lines.

                         * Terminated by \n\0 (NOT \n\n\0). */

} NPStream;

typedef struct _NPByteRange

{

  int32  offset; /* negative offset means from the end */

  uint32 length;

  struct _NPByteRange* next;

} NPByteRange;

typedef struct _NPSavedData

{

  int32	len;

  void*	buf;

} NPSavedData;

typedef struct _NPRect

{

  uint16 top;

  uint16 left;

  uint16 bottom;

  uint16 right;

} NPRect;

typedef struct _NPSize 

{ 

  int32 width; 

  int32 height; 

} NPSize; 

#ifdef XP_UNIX

/*

 * Unix specific structures and definitions

 */

/*

 * Callback Structures.

 *

 * These are used to pass additional platform specific information.

 */

enum {

  NP_SETWINDOW = 1,

  NP_PRINT

};

typedef struct

{

  int32 type;

} NPAnyCallbackStruct;

typedef struct

{

  int32        type;

#ifdef MOZ_X11

  Display*     display;

  Visual*      visual;

  Colormap     colormap;

  unsigned int depth;

#endif

} NPSetWindowCallbackStruct;

typedef struct

{

  int32 type;

  FILE* fp;

} NPPrintCallbackStruct;

#endif /* XP_UNIX */

/*

 *   The following masks are applied on certain platforms to NPNV and 

 *   NPPV selectors that pass around pointers to COM interfaces. Newer 

 *   compilers on some platforms may generate vtables that are not 

 *   compatible with older compilers. To prevent older plugins from 

 *   not understanding a new browser's ABI, these masks change the 

 *   values of those selectors on those platforms. To remain backwards

 *   compatible with differenet versions of the browser, plugins can 

 *   use these masks to dynamically determine and use the correct C++

 *   ABI that the browser is expecting. This does not apply to Windows 

 *   as Microsoft's COM ABI will likely not change.

 */

#define NP_ABI_GCC3_MASK  0x10000000

/*

 *   gcc 3.x generated vtables on UNIX and OSX are incompatible with 

 *   previous compilers.

 */

#if (defined (XP_UNIX) && defined(__GNUC__) && (__GNUC__ >= 3))

#define _NP_ABI_MIXIN_FOR_GCC3 NP_ABI_GCC3_MASK

#else

#define _NP_ABI_MIXIN_FOR_GCC3 0

#endif

#define NP_ABI_MACHO_MASK 0x01000000

/*

 *   On OSX, the Mach-O executable format is significantly

 *   different than CFM. In addition to having a different

 *   C++ ABI, it also has has different C calling convention.

 *   You must use glue code when calling between CFM and

 *   Mach-O C functions. 

 */

#if (defined(TARGET_RT_MAC_MACHO))

#define _NP_ABI_MIXIN_FOR_MACHO NP_ABI_MACHO_MASK

#else

#define _NP_ABI_MIXIN_FOR_MACHO 0

#endif

#define NP_ABI_MASK (_NP_ABI_MIXIN_FOR_GCC3 | _NP_ABI_MIXIN_FOR_MACHO)

/*

 * List of variable names for which NPP_GetValue shall be implemented

 */

typedef enum {

  NPPVpluginNameString = 1,

  NPPVpluginDescriptionString,

  NPPVpluginWindowBool,

  NPPVpluginTransparentBool,

  NPPVjavaClass,                /* Not implemented in Mozilla 1.0 */

  NPPVpluginWindowSize,

  NPPVpluginTimerInterval,

  NPPVpluginScriptableInstance = (10 | NP_ABI_MASK),

  NPPVpluginScriptableIID = 11,

  /* Introduced in Mozilla 0.9.9 */

  NPPVjavascriptPushCallerBool = 12,

  /* Introduced in Mozilla 1.0 */

  NPPVpluginKeepLibraryInMemory = 13,

  NPPVpluginNeedsXEmbed         = 14,

  /* Get the NPObject for scripting the plugin. Introduced in Firefox

   * 1.0 (NPAPI minor version 14).

   */

  NPPVpluginScriptableNPObject  = 15,

  /* Get the plugin value (as \0-terminated UTF-8 string data) for

   * form submission if the plugin is part of a form. Use

   * NPN_MemAlloc() to allocate memory for the string data. Introduced

   * in Mozilla 1.8b2 (NPAPI minor version 15).

   */

  NPPVformValue = 16

#ifdef XP_MACOSX

  /* Used for negotiating drawing models */

  , NPPVpluginDrawingModel = 1000

#endif

} NPPVariable;

/*

 * List of variable names for which NPN_GetValue is implemented by Mozilla

 */

typedef enum {

  NPNVxDisplay = 1,

  NPNVxtAppContext,

  NPNVnetscapeWindow,

  NPNVjavascriptEnabledBool,

  NPNVasdEnabledBool,

  NPNVisOfflineBool,

  /* 10 and over are available on Mozilla builds starting with 0.9.4 */

  NPNVserviceManager = (10 | NP_ABI_MASK),

  NPNVDOMElement     = (11 | NP_ABI_MASK),   /* available in Mozilla 1.2 */

  NPNVDOMWindow      = (12 | NP_ABI_MASK),

  NPNVToolkit        = (13 | NP_ABI_MASK),

  NPNVSupportsXEmbedBool = 14,

  /* Get the NPObject wrapper for the browser window. */

  NPNVWindowNPObject = 15,

  /* Get the NPObject wrapper for the plugins DOM element. */

  NPNVPluginElementNPObject = 16,

  NPNVSupportsWindowless = 17

#ifdef XP_MACOSX

  /* Used for negotiating drawing models */

  , NPNVpluginDrawingModel = 1000

#ifndef NP_NO_QUICKDRAW

  , NPNVsupportsQuickDrawBool = 2000

#endif

  , NPNVsupportsCoreGraphicsBool = 2001

#endif

} NPNVariable;

/*

 * The type of Tookkit the widgets use

 */

typedef enum {

  NPNVGtk12 = 1,

  NPNVGtk2

} NPNToolkitType;

/*

 * The type of a NPWindow - it specifies the type of the data structure