sky/engine/core/dom/custom/CustomElementScheduler.h

/*
 * Copyright (C) 2013 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:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of Google Inc. nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 SKY_ENGINE_CORE_DOM_CUSTOM_CUSTOMELEMENTSCHEDULER_H_
#define SKY_ENGINE_CORE_DOM_CUSTOM_CUSTOMELEMENTSCHEDULER_H_

#include "sky/engine/core/dom/custom/CustomElementCallbackQueue.h"
#include "sky/engine/core/dom/custom/CustomElementLifecycleCallbacks.h"
#include "sky/engine/platform/heap/Handle.h"
#include "sky/engine/wtf/HashMap.h"
#include "sky/engine/wtf/OwnPtr.h"
#include "sky/engine/wtf/PassRefPtr.h"
#include "sky/engine/wtf/text/AtomicString.h"

namespace blink {

class CustomElementDescriptor;
class CustomElementMicrotaskImportStep;
class CustomElementMicrotaskStep;
class CustomElementRegistrationContext;
class Document;
class Element;
class HTMLImportChild;

class CustomElementScheduler final {
    DECLARE_EMPTY_DESTRUCTOR_WILL_BE_REMOVED(CustomElementScheduler);
public:

    static void scheduleCallback(PassRefPtr<CustomElementLifecycleCallbacks>, PassRefPtr<Element>, CustomElementLifecycleCallbacks::CallbackType);
    static void scheduleAttributeChangedCallback(PassRefPtr<CustomElementLifecycleCallbacks>, PassRefPtr<Element>, const AtomicString& name, const AtomicString& oldValue, const AtomicString& newValue);

    static void resolveOrScheduleResolution(PassRefPtr<CustomElementRegistrationContext>, PassRefPtr<Element>, const CustomElementDescriptor&);
    static CustomElementMicrotaskImportStep* scheduleImport(HTMLImportChild*);

    static void microtaskDispatcherDidFinish();
    static void callbackDispatcherDidFinish();

private:
    CustomElementScheduler() { }

    static CustomElementScheduler& instance();
    static void enqueueMicrotaskStep(Document&, PassOwnPtr<CustomElementMicrotaskStep>, bool importIsSync = true);

    CustomElementCallbackQueue& ensureCallbackQueue(PassRefPtr<Element>);
    CustomElementCallbackQueue& schedule(PassRefPtr<Element>);

    // FIXME: Consider moving the element's callback queue to
    // ElementRareData. Then the scheduler can become completely
    // static.
    void clearElementCallbackQueueMap();

    // The element -> callback queue map is populated by the scheduler
    // and owns the lifetimes of the CustomElementCallbackQueues.
    typedef HashMap<RawPtr<Element>, OwnPtr<CustomElementCallbackQueue> > ElementCallbackQueueMap;
    ElementCallbackQueueMap m_elementCallbackQueueMap;
};

}

#endif  // SKY_ENGINE_CORE_DOM_CUSTOM_CUSTOMELEMENTSCHEDULER_H_