src/third_party/WebKit/Source/core/page/PageLifecycleNotifier.h

   1 /*
   2  * Copyright (C) 2013 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
   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 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 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 #ifndef PageLifecycleNotifier_h
  27 #define PageLifecycleNotifier_h
  28
  29 #include "core/page/PageLifecycleObserver.h"
  30 #include "platform/LifecycleNotifier.h"
  31 #include "wtf/PassOwnPtr.h"
  32 #include "wtf/TemporaryChange.h"
  33
  34 namespace blink {
  35
  36 class Page;
  37 class LocalFrame;
  38
  39 class PageLifecycleNotifier final : public LifecycleNotifier<Page> {
  40 public:
  41     static PassOwnPtr<PageLifecycleNotifier> create(Page*);
  42
  43     void notifyPageVisibilityChanged();
  44     void notifyDidCommitLoad(LocalFrame*);
  45
  46     virtual void addObserver(Observer*) override;
  47     virtual void removeObserver(Observer*) override;
  48
  49 private:
  50     explicit PageLifecycleNotifier(Page*);
  51
  52     using PageObserverSet = HashSet<PageLifecycleObserver*>;
  53     PageObserverSet m_pageObservers;
  54 };
  55
  56 inline PassOwnPtr<PageLifecycleNotifier> PageLifecycleNotifier::create(Page* context)
  57 {
  58     return adoptPtr(new PageLifecycleNotifier(context));
  59 }
  60
  61 inline void PageLifecycleNotifier::notifyPageVisibilityChanged()
  62 {
  63     TemporaryChange<IterationType> scope(this->m_iterating, IteratingOverPageObservers);
  64     for (PageLifecycleObserver* pageObserver : m_pageObservers)
  65         pageObserver->pageVisibilityChanged();
  66 }
  67
  68 inline void PageLifecycleNotifier::notifyDidCommitLoad(LocalFrame* frame)
  69 {
  70     TemporaryChange<IterationType> scope(this->m_iterating, IteratingOverPageObservers);
  71     for (PageLifecycleObserver* pageObserver : m_pageObservers)
  72         pageObserver->didCommitLoad(frame);
  73 }
  74
  75 } // namespace blink
  76
  77 #endif // PageLifecycleNotifier_h