Home | History | Annotate | Download | only in dom 
      1 /*
      2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
      3  * Copyright (C) 2013 Google Inc. All Rights Reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in the
     12  *    documentation and/or other materials provided with the distribution.
     13  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     25  *
     26  */
     27 #ifndef ContextLifecycleNotifier_h
     28 #define ContextLifecycleNotifier_h
     29 
     30 #include "core/dom/ActiveDOMObject.h"
     31 #include "core/platform/LifecycleNotifier.h"
     32 #include "wtf/HashSet.h"
     33 #include "wtf/PassOwnPtr.h"
     34 
     35 namespace WebCore {
     36 
     37 class ActiveDOMObject;
     38 class ContextLifecycleObserver;
     39 class ScriptExecutionContext;
     40 
     41 class ContextLifecycleNotifier : public LifecycleNotifier {
     42 public:
     43     static PassOwnPtr<ContextLifecycleNotifier> create(ScriptExecutionContext*);
     44 
     45     virtual ~ContextLifecycleNotifier();
     46 
     47     typedef HashSet<ActiveDOMObject*> ActiveDOMObjectSet;
     48 
     49     const ActiveDOMObjectSet& activeDOMObjects() const { return m_activeDOMObjects; }
     50 
     51     virtual void addObserver(LifecycleObserver*) OVERRIDE;
     52     virtual void removeObserver(LifecycleObserver*) OVERRIDE;
     53 
     54     void notifyResumingActiveDOMObjects();
     55     void notifySuspendingActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
     56     void notifyStoppingActiveDOMObjects();
     57 
     58     bool contains(ActiveDOMObject* object) const { return m_activeDOMObjects.contains(object); }
     59     bool canSuspendActiveDOMObjects();
     60     bool hasPendingActivity() const;
     61 
     62 protected:
     63     explicit ContextLifecycleNotifier(ScriptExecutionContext*);
     64 
     65 private:
     66     ActiveDOMObjectSet m_activeDOMObjects;
     67 };
     68 
     69 inline PassOwnPtr<ContextLifecycleNotifier> ContextLifecycleNotifier::create(ScriptExecutionContext* context)
     70 {
     71     return adoptPtr(new ContextLifecycleNotifier(context));
     72 }
     73 
     74 } // namespace WebCore
     75 
     76 #endif // ContextLifecycleNotifier_h
     77