Source/WebCore/dom/ActiveDOMObject.h

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  */
  26
  27 #ifndef ActiveDOMObject_h
  28 #define ActiveDOMObject_h
  29
  30 #include <wtf/Assertions.h>
  31
  32 namespace WebCore {
  33
  34     class ScriptExecutionContext;
  35
  36     // FIXME: Move this class to it's own file.
  37     class ContextDestructionObserver {
  38     public:
  39         explicit ContextDestructionObserver(ScriptExecutionContext*);
  40         virtual void contextDestroyed();
  41
  42         ScriptExecutionContext* scriptExecutionContext() const { return m_scriptExecutionContext; }
  43
  44     protected:
  45         virtual ~ContextDestructionObserver();
  46
  47         ScriptExecutionContext* m_scriptExecutionContext;
  48     };
  49
  50     class ActiveDOMObject : public ContextDestructionObserver {
  51     public:
  52         ActiveDOMObject(ScriptExecutionContext*, void* upcastPointer);
  53
  54         virtual bool hasPendingActivity() const;
  55
  56         // canSuspend() is used by the caller if there is a choice between suspending and stopping.
  57         // For example, a page won't be suspended and placed in the back/forward cache if it has
  58         // the objects that can not be suspended.
  59         // However, 'suspend' can be called even if canSuspend() would return 'false'. That
  60         // happens in step-by-step JS debugging for example - in this case it would be incorrect
  61         // to stop the object. Exact semantics of suspend is up to the object then.
  62         enum ReasonForSuspension {
  63             JavaScriptDebuggerPaused,
  64             WillShowDialog,
  65             DocumentWillBecomeInactive
  66         };
  67         virtual bool canSuspend() const;
  68         virtual void suspend(ReasonForSuspension);
  69         virtual void resume();
  70         virtual void stop();
  71
  72         template<class T> void setPendingActivity(T* thisObject)
  73         {
  74             ASSERT(thisObject == this);
  75             thisObject->ref();
  76             m_pendingActivityCount++;
  77         }
  78
  79         template<class T> void unsetPendingActivity(T* thisObject)
  80         {
  81             ASSERT(m_pendingActivityCount > 0);
  82             --m_pendingActivityCount;
  83             thisObject->deref();
  84         }
  85
  86     protected:
  87         virtual ~ActiveDOMObject();
  88
  89     private:
  90         unsigned m_pendingActivityCount;
  91     };
  92
  93 } // namespace WebCore
  94
  95 #endif // ActiveDOMObject_h