third_party/WebKit/public/web/WebHelperPlugin.h

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebHelperPlugin_h
  32 #define WebHelperPlugin_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "WebFrame.h"
  36
  37 namespace blink {
  38
  39 class WebPlugin;
  40 class WebString;
  41
  42 class WebHelperPlugin {
  43 public:
  44     // May return null if initialization fails. If the returned pointer is
  45     // non-null, the caller must free it by calling destroy().
  46     BLINK_EXPORT static WebHelperPlugin* create(const WebString& PluginType, WebLocalFrame*);
  47
  48     // Returns a WebPlugin corresponding to the instantiated plugin. This will
  49     // never return null.
  50     virtual WebPlugin* getPlugin() = 0;
  51
  52     // Initiates destruction of the WebHelperPlugin.
  53     virtual void destroy() = 0;
  54
  55 protected:
  56     virtual ~WebHelperPlugin() { }
  57 };
  58
  59 } // namespace blink
  60
  61 namespace WTF {
  62
  63 template<typename T> struct OwnedPtrDeleter;
  64 template<> struct OwnedPtrDeleter<blink::WebHelperPlugin> {
  65     static void deletePtr(blink::WebHelperPlugin* plugin)
  66     {
  67         if (plugin)
  68             plugin->destroy();
  69     }
  70 };
  71
  72 } // namespace WTF
  73
  74 #endif