content/shell/tools/plugin/Tests/NPPSetWindowCalledDuringDestruction.cpp

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /*
   6  * Copyright (C) 2011 Apple Inc. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include "PluginTest.h"
  31
  32 #include "PluginObject.h"
  33
  34 using namespace std;
  35
  36 // NPP_SetWindow should be called with a null window handle as destruction begins on non-Mac platforms.
  37
  38 class NPPSetWindowCalledDuringDestruction : public PluginTest {
  39 public:
  40     NPPSetWindowCalledDuringDestruction(NPP, const string& identifier);
  41
  42     void setWillBeDestroyed() { m_willBeDestroyed = true; }
  43
  44 private:
  45     struct ScriptObject : Object<ScriptObject> {
  46         bool hasMethod(NPIdentifier);
  47         bool invoke(NPIdentifier, const NPVariant*, uint32_t, NPVariant*);
  48     };
  49
  50     virtual NPError NPP_GetValue(NPPVariable, void*);
  51     virtual NPError NPP_SetWindow(NPWindow*);
  52     virtual NPError NPP_Destroy(NPSavedData**);
  53
  54     bool m_willBeDestroyed;
  55     bool m_setWindowCalledBeforeDestruction;
  56     bool m_setWindowCalledDuringDestruction;
  57 };
  58
  59 static PluginTest::Register<NPPSetWindowCalledDuringDestruction> registrar("npp-set-window-called-during-destruction");
  60
  61 NPPSetWindowCalledDuringDestruction::NPPSetWindowCalledDuringDestruction(NPP npp, const string& identifier)
  62     : PluginTest(npp, identifier)
  63     , m_willBeDestroyed(false)
  64     , m_setWindowCalledBeforeDestruction(false)
  65     , m_setWindowCalledDuringDestruction(false)
  66 {
  67 }
  68
  69 NPError NPPSetWindowCalledDuringDestruction::NPP_GetValue(NPPVariable variable, void* value)
  70 {
  71     if (variable != NPPVpluginScriptableNPObject)
  72         return NPERR_GENERIC_ERROR;
  73
  74     *static_cast<NPObject**>(value) = ScriptObject::create(this);
  75
  76     return NPERR_NO_ERROR;
  77 }
  78
  79 NPError NPPSetWindowCalledDuringDestruction::NPP_SetWindow(NPWindow* window)
  80 {
  81     if (m_willBeDestroyed) {
  82         m_setWindowCalledDuringDestruction = true;
  83         if (!m_setWindowCalledBeforeDestruction) {
  84             log("Fail: setWillBeDestroyed() was called before the initial NPP_SetWindow call");
  85             return NPERR_NO_ERROR;
  86         }
  87 #ifndef XP_MACOSX
  88         if (window->window)
  89             log("Fail: NPP_SetWindow passed a non-null window during plugin destruction");
  90 #endif
  91         return NPERR_NO_ERROR;
  92     }
  93
  94     if (m_setWindowCalledBeforeDestruction) {
  95         log("Fail: NPP_SetWindow called more than once before plugin destruction");
  96         return NPERR_NO_ERROR;
  97     }
  98
  99     m_setWindowCalledBeforeDestruction = true;
 100     return NPERR_NO_ERROR;
 101 }
 102
 103 NPError NPPSetWindowCalledDuringDestruction::NPP_Destroy(NPSavedData**)
 104 {
 105 #ifdef XP_MACOSX
 106     bool shouldHaveBeenCalledDuringDestruction = false;
 107 #else
 108     bool shouldHaveBeenCalledDuringDestruction = true;
 109 #endif
 110
 111     if (m_setWindowCalledDuringDestruction == shouldHaveBeenCalledDuringDestruction)
 112         log("Success: NPP_SetWindow %s called during plugin destruction", shouldHaveBeenCalledDuringDestruction ? "was" : "was not");
 113     else
 114         log("Fail: NPP_SetWindow %s called during plugin destruction", shouldHaveBeenCalledDuringDestruction ? "was not" : "was");
 115
 116     return NPERR_NO_ERROR;
 117 }
 118
 119 bool NPPSetWindowCalledDuringDestruction::ScriptObject::hasMethod(NPIdentifier methodName)
 120 {
 121     return methodName == pluginTest()->NPN_GetStringIdentifier("setWillBeDestroyed");
 122 }
 123
 124 bool NPPSetWindowCalledDuringDestruction::ScriptObject::invoke(NPIdentifier identifier, const NPVariant*, uint32_t, NPVariant*)
 125 {
 126     assert(identifier == pluginTest()->NPN_GetStringIdentifier("setWillBeDestroyed"));
 127     static_cast<NPPSetWindowCalledDuringDestruction*>(pluginTest())->setWillBeDestroyed();
 128     return true;
 129 }