/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef FrameActionScheduler_h
#define FrameActionScheduler_h

#include "wtf/FastAllocBase.h"
#include "wtf/Noncopyable.h"
#include "wtf/OwnPtr.h"
#include "wtf/PassOwnPtr.h"
#include "wtf/Vector.h"

namespace WebCore {

class Node;
class Event;

class FrameAction {
    WTF_MAKE_FAST_ALLOCATED;
    WTF_MAKE_NONCOPYABLE(FrameAction);
public:
    FrameAction() {}
    virtual ~FrameAction() {}
    virtual void fire() = 0;
};

class FrameActionScheduler {
    WTF_MAKE_FAST_ALLOCATED;
public:
    FrameActionScheduler();
    ~FrameActionScheduler();

    bool isEmpty() const;
    // FIXME: Why is this < m_enqueueActions, does this
    // mean that the steady state of m_enqueueActions should be -1?
    bool isScheduled() const { return 0 < m_enqueueActions; }
    void clear();
    void pause();
    void resume();

    void scheduleAction(PassOwnPtr<FrameAction>);
    void scheduleEvent(PassRefPtr<Event>, PassRefPtr<Node>);

private:
    void dispatch();

    unsigned m_enqueueActions;
    Vector< OwnPtr<FrameAction> > m_scheduledActions;
};

} // namespace WebCore

#endif // FrameActionScheduler_h
