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

 * Version: NPL 1.1/GPL 2.0/LGPL 2.1

 *

 * The contents of this file are subject to the Netscape 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/NPL/

 *

 * 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):

 *    Portions Copyright (c) 2004-2006, Nokia Corporation

 *

 *

 * 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 NPL, 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 NPL, the GPL or the LGPL.

 *

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

/* NOTES:

 * Nokia modified this file, by changing certain variables for the purpose of

 * porting the file to the Symbian platform on May 1st, 2004.

 */

 /*

  *  Netscape client plug-in API spec

  */

#ifndef _NPAPI_H_

#define _NPAPI_H_

#define GENERIC_CONTEXTS

#ifdef INCLUDE_JAVA

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

#else

#ifndef __SYMBIAN32__

#define jref    void *

#define JRIEnv  void

#endif

#endif

#ifdef _WIN32

#    ifndef XP_WIN

#        define XP_WIN 1

#    endif /* XP_WIN */

#endif /* _WIN32 */

#ifdef __MWERKS__

#    define _declspec __declspec

#    ifdef macintosh

#        ifndef XP_MAC

#            define XP_MAC 1

#        endif /* XP_MAC */

#    endif /* macintosh */

#    ifdef __INTEL__

#        undef NULL

#        ifndef XP_WIN

#            define XP_WIN 1

#        endif /* __INTEL__ */

#    endif /* XP_PC */

#endif /* __MWERKS__ */

#ifdef __SYMBIAN32__

#undef XP_WIN

#endif

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

#   define XP_MACOSX

#endif

#ifdef XP_MAC

    #include <Quickdraw.h>

    #include <Events.h>

#endif

#ifdef XP_MACOSX

    #include <Carbon/Carbon.h>

    #include <ApplicationServices/ApplicationServices.h>

    #include <OpenGL/OpenGL.h>

#endif

#ifdef XP_UNIX

    #include <X11/Xlib.h>

    #include <X11/Xutil.h>

#endif

#ifdef XP_WIN

    #include <windows.h>

#endif

#ifdef __SYMBIAN32__

#include <np_defines.h>

#endif

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

#error 64-bit Netscape plug-ins are not supported on Mac OS X

#endif

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

/*             Plugin Version Constants                                 */

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

#define NP_VERSION_MAJOR 0

#define NP_VERSION_MINOR 18

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

/*             Definition of Basic Types                                */

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

#ifndef _UINT16

#define _UINT16

typedef unsigned short uint16;

#endif

#ifndef _UINT32

#define _UINT32

#ifdef __LP64__

typedef unsigned int uint32;

#else /* __LP64__ */

typedef unsigned long uint32;

#endif /* __LP64__ */

#endif

#ifndef _INT16

#define _INT16

typedef short int16;

#endif

#ifndef _INT32

#define _INT32

#ifdef __LP64__

typedef int int32;

#else /* __LP64__ */

typedef long int32;

#endif /* __LP64__ */

#endif

#ifndef FALSE

#define FALSE (0)

#endif

#ifndef TRUE

#define TRUE (1)

#endif

#ifndef NULL

#define NULL (0L)

#endif

typedef unsigned char    NPBool;

typedef int16            NPError;

typedef int16            NPReason;

#ifndef __SYMBIAN32__

typedef char*     		 NPMIMEType;

#else/* __SYMBIAN32__ */

typedef const TDesC8& 	 NPMIMEType;

#endif

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

/*             Structures and definitions             */

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

#if !defined(__LP64__)

#if defined(XP_MAC) || defined(XP_MACOSX)

#pragma options align=mac68k

#endif

#endif /* __LP64__ */

/*

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

 */

#ifdef __SYMBIAN32__ 

#ifndef _NP_RUNTIME_H_NPP

#define _NP_RUNTIME_H_NPP

typedef struct _NPP

{

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

    void*    ndata;            /* netscape private data */

} NPP_t;

typedef NPP_t*    NPP;

#endif // _NP_RUNTIME_H_NPP

#else

typedef struct _NPP

{

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

    void*    ndata;            /* netscape private data */

} NPP_t;

typedef NPP_t*    NPP;

#endif //

typedef struct _NPStream

{

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

    void*        ndata;        /* netscape private data */

#ifndef __SYMBIAN32__ 

    const char*  url;

#else /*__SYMBIAN32__*/

    HBufC* url;

#endif

    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;

#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;

    Display*        display;

    Visual*         visual;

    Colormap        colormap;

    unsigned int    depth;

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

    /* 12 and over are available on Mozilla builds starting with 0.9.9 */

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

    NPPVpluginScriptableNPObject  = 15,

#ifdef __SYMBIAN32__

    // Custom NPP variables, starting from 100 till 1000

    NPPVPluginFocusPosition = 100,    

    NPPVPluginDeactivate = 101,

    NPPVPluginZoom = 102,

    NPPVPluginPointerEvent = 103,

    NPPVpluginInteractiveBool = 1000,

#endif

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

     */

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

    NPPVpluginFullScreenBool = 17 /* Not implemented in WebKit */

} 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),  /* 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,

#ifdef XP_MACOSX

    , NPNVpluginDrawingModel = 1000 /* The NPDrawingModel specified by the plugin */

#ifndef NP_NO_QUICKDRAW

    , NPNVsupportsQuickDrawBool = 2000 /* TRUE if the browser supports the QuickDraw drawing model */

#endif

    , NPNVsupportsCoreGraphicsBool = 2001 /* TRUE if the browser supports the CoreGraphics drawing model */

    , NPNVsupportsOpenGLBool = 2002 /* TRUE if the browser supports the OpenGL drawing model (CGL on Mac) */

#endif /* XP_MACOSX */

    /* Get the id of the currently connected access point */

    NPNNetworkAccess,

    NPNVGenericParameter,

    NPNVSupportsWindowless

} NPNVariable;

#ifdef GENERIC_CONTEXTS

union  NPN_GenericParam {

    NPN_GenericParam(int aIntValue)

    :intValue(aIntValue)

        {

        }

    NPN_GenericParam(bool aBoolValue)

    :boolValue(aBoolValue)

        {

        }

    NPN_GenericParam(const TDesC& aStrValue)

    :strValue(aStrValue)

        {

        }

    NPN_GenericParam(void*  aVoidValue)

    :voidValue(aVoidValue)

        {

        }

    int intValue;

    bool   boolValue;

    const TDesC& strValue;

    void*  voidValue;

};

typedef struct NPN_GenericElement{          

    NPN_GenericElement(const TDesC& aElementId, int aElementValue)

    :genericElementId(aElementId), genericElementValue(aElementValue)

        {

        }

    NPN_GenericElement(const TDesC& aElementId, bool aElementValue)

    :genericElementId(aElementId), genericElementValue(aElementValue)

        {

        }

    NPN_GenericElement(const TDesC& aElementId, void* aElementValue)

    :genericElementId(aElementId), genericElementValue(aElementValue)

        {

        }

    NPN_GenericElement(const TDesC& aElementId, const TDesC& aElementValue)

    :genericElementId(aElementId), genericElementValue(aElementValue)

        {

        }

    const TDesC&  genericElementId;          

    NPN_GenericParam genericElementValue;

} GenericEntry;

#endif

/*

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

 * returned in the window field.

 */

typedef enum {

    NPWindowTypeWindow = 1,

    NPWindowTypeDrawable

} NPWindowType;

#ifdef XP_MACOSX

/*

 * The drawing model for a Mac OS X plugin.  These are the possible values for the NPNVpluginDrawingModel variable.

 */

typedef enum {

#ifndef NP_NO_QUICKDRAW

    NPDrawingModelQuickDraw = 0,

#endif

    NPDrawingModelCoreGraphics = 1,

    NPDrawingModelOpenGL = 2

} NPDrawingModel;

#endif

typedef struct _NPWindow

{

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

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

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

    uint32    width;        /* Maximum window size */

    uint32    height;

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

                        /* Used by MAC only.              */

#ifdef XP_UNIX

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

#endif /* XP_UNIX */

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

} NPWindow;