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

 * vim: sw=4 ts=4 et :

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_PluginLibrary_h

#define mozilla_PluginLibrary_h 1

#include "prlink.h"

#include "npapi.h"

#include "npfunctions.h"

#include "nscore.h"

#include "nsStringFwd.h"

#include "nsTArray.h"

#include "nsError.h"

#include "mozilla/EventForwards.h"

#include "nsSize.h"

#include "nsRect.h"

class nsNPAPIPlugin;

namespace mozilla {

namespace gfx {

class DrawTarget;

}

namespace layers {

class Image;

class ImageContainer;

} // namespace layers

} // namespace mozilla

class nsIClearSiteDataCallback;

#define nsIGetSitesWithDataCallback_CID {0xd0028b83, 0xfdf9, 0x4c53, {0xb7, 0xbb, 0x47, 0x46, 0x0f, 0x6b, 0x83, 0x6c}}

class nsIGetSitesWithDataCallback : public nsISupports {

public:

  NS_IMETHOD SitesWithData(InfallibleTArray<nsCString>& result) = 0;

  NS_DECLARE_STATIC_IID_ACCESSOR(nsIGetSitesWithDataCallback_CID)

};

NS_DEFINE_STATIC_IID_ACCESSOR(nsIGetSitesWithDataCallback, nsIGetSitesWithDataCallback_CID)

namespace mozilla {

class PluginLibrary

{

public:

  typedef mozilla::gfx::DrawTarget DrawTarget;

  virtual ~PluginLibrary() { }

  /**

   * Inform this library about the nsNPAPIPlugin which owns it. This

   * object will hold a weak pointer to the plugin.

   */

  virtual void SetPlugin(nsNPAPIPlugin* plugin) = 0;

  virtual bool HasRequiredFunctions() = 0;

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

  virtual nsresult NP_Initialize(NPNetscapeFuncs* bFuncs, NPPluginFuncs* pFuncs, NPError* error) = 0;

#else

  virtual nsresult NP_Initialize(NPNetscapeFuncs* bFuncs, NPError* error) = 0;

#endif

  virtual nsresult NP_Shutdown(NPError* error) = 0;

  virtual nsresult NP_GetMIMEDescription(const char** mimeDesc) = 0;

  virtual nsresult NP_GetValue(void *future, NPPVariable aVariable,

                               void *aValue, NPError* error) = 0;

#if defined(XP_WIN) || defined(XP_MACOSX)

  virtual nsresult NP_GetEntryPoints(NPPluginFuncs* pFuncs, NPError* error) = 0;

#endif

  virtual nsresult NPP_New(NPMIMEType pluginType, NPP instance,

                           int16_t argc, char* argn[],

                           char* argv[], NPSavedData* saved,

                           NPError* error) = 0;

  virtual nsresult NPP_ClearSiteData(const char* site, uint64_t flags,

                                     uint64_t maxAge, nsCOMPtr<nsIClearSiteDataCallback> callback) = 0;

  virtual nsresult NPP_GetSitesWithData(nsCOMPtr<nsIGetSitesWithDataCallback> callback) = 0;

  virtual nsresult AsyncSetWindow(NPP instance, NPWindow* window) = 0;

  virtual nsresult GetImageContainer(NPP instance, mozilla::layers::ImageContainer** aContainer) = 0;

  virtual nsresult GetImageSize(NPP instance, nsIntSize* aSize) = 0;

  virtual void DidComposite(NPP instance) = 0;

  virtual bool IsOOP() = 0;

#if defined(XP_MACOSX)

  virtual nsresult IsRemoteDrawingCoreAnimation(NPP instance, bool *aDrawing) = 0;

#endif

#if defined(XP_MACOSX) || defined(XP_WIN)

  virtual nsresult ContentsScaleFactorChanged(NPP instance, double aContentsScaleFactor) = 0;

#endif

#if defined(XP_WIN)

    virtual nsresult GetScrollCaptureContainer(NPP aInstance, mozilla::layers::ImageContainer** aContainer) = 0;

#endif

  virtual nsresult HandledWindowedPluginKeyEvent(

                     NPP aInstance,

                     const mozilla::NativeEventData& aNativeKeyData,

                     bool aIsCOnsumed) = 0;

  /**

   * The next three methods are the third leg in the trip to

   * PluginInstanceParent.  They approximately follow the ReadbackSink

   * API.

   */

  virtual nsresult SetBackgroundUnknown(NPP instance) = 0;

  virtual nsresult BeginUpdateBackground(NPP instance,

                                         const nsIntRect&, DrawTarget**) = 0;

  virtual nsresult EndUpdateBackground(NPP instance, const nsIntRect&) = 0;

  virtual nsresult GetRunID(uint32_t* aRunID) = 0;

  virtual void SetHasLocalInstance() = 0;

};

} // namespace mozilla

#endif  // ifndef mozilla_PluginLibrary_h