Home | History | Annotate | Download | only in frame 
      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 DOMTimer_h
     28 #define DOMTimer_h
     29 
     30 #include "bindings/v8/ScheduledAction.h"
     31 #include "core/frame/SuspendableTimer.h"
     32 #include "platform/UserGestureIndicator.h"
     33 #include "wtf/Compiler.h"
     34 #include "wtf/OwnPtr.h"
     35 #include "wtf/PassOwnPtr.h"
     36 
     37 namespace WebCore {
     38 
     39 class ExecutionContext;
     40 
     41 class DOMTimer FINAL : public SuspendableTimer {
     42 public:
     43     // Creates a new timer owned by the ExecutionContext, starts it and returns its ID.
     44     static int install(ExecutionContext*, PassOwnPtr<ScheduledAction>, int timeout, bool singleShot);
     45     static void removeByID(ExecutionContext*, int timeoutID);
     46 
     47     virtual ~DOMTimer();
     48 
     49     int timeoutID() const;
     50 
     51     // ActiveDOMObject
     52     virtual void contextDestroyed() OVERRIDE;
     53     virtual void stop() OVERRIDE;
     54 
     55     // The following are essentially constants. All intervals are in seconds.
     56     static double hiddenPageAlignmentInterval();
     57     static double visiblePageAlignmentInterval();
     58 
     59 private:
     60     friend class ExecutionContext; // For create().
     61 
     62     // Should only be used by ExecutionContext.
     63     static PassOwnPtr<DOMTimer> create(ExecutionContext* context, PassOwnPtr<ScheduledAction> action, int timeout, bool singleShot, int timeoutID)
     64     {
     65         return adoptPtr(new DOMTimer(context, action, timeout, singleShot, timeoutID));
     66     }
     67 
     68     DOMTimer(ExecutionContext*, PassOwnPtr<ScheduledAction>, int interval, bool singleShot, int timeoutID);
     69     virtual void fired() OVERRIDE;
     70 
     71     // Retuns timer fire time rounded to the next multiple of timer alignment interval.
     72     virtual double alignedFireTime(double) const OVERRIDE;
     73 
     74     int m_timeoutID;
     75     int m_nestingLevel;
     76     OwnPtr<ScheduledAction> m_action;
     77     RefPtr<UserGestureToken> m_userGestureToken;
     78 };
     79 
     80 } // namespace WebCore
     81 
     82 #endif // DOMTimer_h
     83