/* -*- 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 ***** */

#ifndef npapi_h_

#define npapi_h_

#if defined(__OS2__)

#pragma pack(1)

#endif

#include "nptypes.h"

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

#ifndef XP_OS2

#define XP_OS2 1

#endif

#endif

#ifdef INCLUDE_JAVA

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

#else

#define jref    void *

#define JRIEnv  void

#endif

#if defined(_WIN32) && !defined(__SYMBIAN32__)

#include <windows.h>

#ifndef XP_WIN

#define XP_WIN 1

#endif

#endif

#if defined(__SYMBIAN32__)

#ifndef XP_SYMBIAN

#define XP_SYMBIAN 1

#endif

#endif

#if defined(__APPLE_CC__) && !defined(XP_UNIX)

#ifndef XP_MACOSX

#define XP_MACOSX 1

#endif

#endif

#if defined(XP_MACOSX) && defined(__LP64__)

#define NP_NO_QUICKDRAW

#define NP_NO_CARBON

#endif

#if defined(XP_MACOSX)

#include <ApplicationServices/ApplicationServices.h>

#include <OpenGL/OpenGL.h>

#ifndef NP_NO_CARBON

#include <Carbon/Carbon.h>

#endif

#endif

#if defined(XP_UNIX)

#include <X11/Xlib.h>

#include <X11/Xutil.h>

#include <stdio.h>

#endif

#if defined(XP_SYMBIAN)

#include <QEvent>

#include <QRegion>

#endif

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

/*                        Plugin Version Constants                      */

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

#define NP_VERSION_MAJOR 0

#define NP_VERSION_MINOR 24

/* 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 that MUST be terminated with 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 FALSE

#define FALSE (0)

#endif

#ifndef TRUE

#define TRUE (1)

#endif

#ifndef NULL

#define NULL (0L)

#endif

typedef unsigned char NPBool;

typedef int16_t       NPError;

typedef int16_t       NPReason;

typedef char*         NPMIMEType;

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

/*                       Structures and definitions                     */

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

#if !defined(__LP64__)

#if defined(XP_MACOSX)

#pragma options align=mac68k

#endif

#endif /* __LP64__ */

/*

 *  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_t end;

  uint32_t 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_t  offset; /* negative offset means from the end */

  uint32_t length;

  struct _NPByteRange* next;

} NPByteRange;

typedef struct _NPSavedData

{

  int32_t len;

  void*   buf;

} NPSavedData;

typedef struct _NPRect

{

  uint16_t top;

  uint16_t left;

  uint16_t bottom;

  uint16_t right;

} NPRect;

typedef struct _NPSize

{

  int32_t width;

  int32_t height;

} NPSize;

/* Return values for NPP_HandleEvent */

#define kNPEventNotHandled 0

#define kNPEventHandled 1

/* Exact meaning must be spec'd in event model. */

#define kNPEventStartIME 2

#if defined(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_t type;

} NPAnyCallbackStruct;

typedef struct

{

  int32_t      type;

  Display*     display;

  Visual*      visual;

  Colormap     colormap;

  unsigned int depth;

} NPSetWindowCallbackStruct;

typedef struct

{

  int32_t type;

  FILE* fp;

} NPPrintCallbackStruct;

#endif /* XP_UNIX */

#if defined(XP_MACOSX)

typedef enum {

#ifndef NP_NO_QUICKDRAW

  NPDrawingModelQuickDraw = 0,

#endif

  NPDrawingModelCoreGraphics = 1,

  NPDrawingModelOpenGL = 2,

  NPDrawingModelCoreAnimation = 3

} NPDrawingModel;

typedef enum {

#ifndef NP_NO_CARBON

  NPEventModelCarbon = 0,

#endif

  NPEventModelCocoa = 1

} NPEventModel;

#endif

/*

 *   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 different 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

#if defined(XP_MACOSX)

#define NP_ABI_MACHO_MASK 0x01000000

#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 WebKit */

  NPPVpluginWindowSize,         /* Not implemented in WebKit */

  NPPVpluginTimerInterval,      /* Not implemented in WebKit */

  NPPVpluginScriptableInstance = (10 | NP_ABI_MASK), /* Not implemented in WebKit */

  NPPVpluginScriptableIID = 11, /* Not implemented in WebKit */

  NPPVjavascriptPushCallerBool = 12,  /* Not implemented in WebKit */

  NPPVpluginKeepLibraryInMemory = 13, /* Not implemented in WebKit */

  NPPVpluginNeedsXEmbed         = 14, /* Not implemented in WebKit */

  /* Get the NPObject for scripting the plugin. Introduced in 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 NPAPI minor version 15.

   */

  NPPVformValue = 16,    /* Not implemented in WebKit */

  NPPVpluginUrlRequestsDisplayedBool = 17, /* Not implemented in WebKit */

  /* Checks if the plugin is interested in receiving the http body of

   * all http requests (including failed ones, http status != 200).

   */

  NPPVpluginWantsAllNetworkStreams = 18,

  /* Browsers can retrieve a native ATK accessibility plug ID via this variable. */

  NPPVpluginNativeAccessibleAtkPlugId = 19,

  /* Checks to see if the plug-in would like the browser to load the "src" attribute. */

  NPPVpluginCancelSrcStream = 20

#if defined(XP_MACOSX)

  /* Used for negotiating drawing models */

  , NPPVpluginDrawingModel = 1000

  /* Used for negotiating event models */

  , NPPVpluginEventModel = 1001

  /* In the NPDrawingModelCoreAnimation drawing model, the browser asks the plug-in for a Core Animation layer. */

  , NPPVpluginCoreAnimationLayer = 1003

#endif

#if defined(MOZ_PLATFORM_MAEMO) && (MOZ_PLATFORM_MAEMO == 5)

  , NPPVpluginWindowlessLocalBool = 2002

#endif

} NPPVariable;

/*

 * List of variable names for which NPN_GetValue should be implemented.

 */

typedef enum {

  NPNVxDisplay = 1,

  NPNVxtAppContext,

  NPNVnetscapeWindow,

  NPNVjavascriptEnabledBool,

  NPNVasdEnabledBool,

  NPNVisOfflineBool,

  NPNVserviceManager = (10 | NP_ABI_MASK),  /* Not implemented in WebKit */

  NPNVDOMElement     = (11 | NP_ABI_MASK),  /* Not implemented in WebKit */

  NPNVDOMWindow      = (12 | NP_ABI_MASK),  /* Not implemented in WebKit */

  NPNVToolkit        = (13 | NP_ABI_MASK),  /* Not implemented in WebKit */

  NPNVSupportsXEmbedBool = 14,              /* Not implemented in WebKit */

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

  NPNVWindowNPObject = 15,

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

  NPNVPluginElementNPObject = 16,

  NPNVSupportsWindowless = 17,

  NPNVprivateModeBool = 18

#if defined(XP_MACOSX)

  /* Used for negotiating drawing models */

  , NPNVpluginDrawingModel = 1000

#ifndef NP_NO_QUICKDRAW

  , NPNVsupportsQuickDrawBool = 2000

#endif

  , NPNVsupportsCoreGraphicsBool = 2001

  , NPNVsupportsOpenGLBool = 2002

  , NPNVsupportsCoreAnimationBool = 2003

#ifndef NP_NO_CARBON

  , NPNVsupportsCarbonBool = 3000 /* TRUE if the browser supports the Carbon event model */

#endif

  , NPNVsupportsCocoaBool = 3001 /* TRUE if the browser supports the Cocoa event model */

#endif /* XP_MACOSX */

#if defined(MOZ_PLATFORM_MAEMO) && (MOZ_PLATFORM_MAEMO == 5)

  , NPNVSupportsWindowlessLocal = 2002

#endif

} NPNVariable;

typedef enum {

  NPNURLVCookie = 501,

  NPNURLVProxy

} NPNURLVariable;

/*

 * The type of Toolkit the widgets use

 */

typedef enum {

  NPNVGtk12 = 1,

  NPNVGtk2

} NPNToolkitType;

/*

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

 * returned in the window field.

 */

typedef enum {

  NPWindowTypeWindow = 1,

  NPWindowTypeDrawable

} NPWindowType;

typedef struct _NPWindow

{

  void* window;  /* Platform specific window handle */

                 /* OS/2: x - Position of bottom left corner */

                 /* OS/2: y - relative to visible netscape window */

  int32_t  x;      /* Position of top left corner relative */

  int32_t  y;      /* to a netscape page. */

  uint32_t width;  /* Maximum window size */

  uint32_t height;

  NPRect   clipRect; /* Clipping rectangle in port coordinates */

#if defined(XP_UNIX) || defined(XP_SYMBIAN)

  void * ws_info; /* Platform-dependent additonal data */

#endif /* XP_UNIX || XP_SYMBIAN */

  NPWindowType type; /* Is this a window or a drawable? */

} NPWindow;

typedef struct _NPImageExpose

{

  char*    data;       /* image pointer */

  int32_t  stride;     /* Stride of data image pointer */

  int32_t  depth;      /* Depth of image pointer */

  int32_t  x;          /* Expose x */

  int32_t  y;          /* Expose y */

  uint32_t width;      /* Expose width */

  uint32_t height;     /* Expose height */

  NPSize   dataSize;   /* Data buffer size */

  float    translateX; /* translate X matrix value */

  float    translateY; /* translate Y matrix value */

  float    scaleX;     /* scale X matrix value */

  float    scaleY;     /* scale Y matrix value */

} NPImageExpose;

typedef struct _NPFullPrint

{

  NPBool pluginPrinted;/* Set TRUE if plugin handled fullscreen printing */

  NPBool printOne;     /* TRUE if plugin should print one copy to default

                          printer */

  void* platformPrint; /* Platform-specific printing info */

} NPFullPrint;

typedef struct _NPEmbedPrint

{

  NPWindow window;

  void* platformPrint; /* Platform-specific printing info */

} NPEmbedPrint;

typedef struct _NPPrint

{

  uint16_t mode;               /* NP_FULL or NP_EMBED */

  union

  {

    NPFullPrint fullPrint;   /* if mode is NP_FULL */

    NPEmbedPrint embedPrint; /* if mode is NP_EMBED */

  } print;

} NPPrint;

#if defined(XP_MACOSX)

#ifndef NP_NO_CARBON

typedef EventRecord NPEvent;

#endif

#elif defined(XP_SYMBIAN)

typedef QEvent NPEvent;

#elif defined(XP_WIN)

typedef struct _NPEvent

{

  uint16_t event;

  uintptr_t wParam;

  uintptr_t lParam;

} NPEvent;

#elif defined(XP_OS2)

typedef struct _NPEvent

{