servo/components/script/task_source/dom_manipulation.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

use dom::bindings::refcounted::Trusted;
use dom::event::{EventBubbles, EventCancelable};
use dom::eventtarget::EventTarget;
use script_thread::{MainThreadRunnable, MainThreadScriptMsg, Runnable, ScriptThread};
use std::result::Result;
use std::sync::mpsc::Sender;
use string_cache::Atom;
use task_source::TaskSource;

#[derive(JSTraceable)]
pub struct DOMManipulationTaskSource(pub Sender<MainThreadScriptMsg>);

impl TaskSource<DOMManipulationTask> for DOMManipulationTaskSource {
    fn queue(&self, msg: DOMManipulationTask) -> Result<(), ()> {
        self.0.send(MainThreadScriptMsg::DOMManipulation(msg)).map_err(|_| ())
    }
}

impl DOMManipulationTaskSource {
    pub fn queue_event(&self,
                       target: &EventTarget,
                       name: Atom,
                       bubbles: EventBubbles,
                       cancelable: EventCancelable) {
        let target = Trusted::new(target);
        let _ = self.0.send(MainThreadScriptMsg::DOMManipulation(DOMManipulationTask::FireEvent(
            target, name, bubbles, cancelable)));
    }

    pub fn queue_simple_event(&self, target: &EventTarget, name: Atom) {
        let target = Trusted::new(target);
        let _ = self.0.send(MainThreadScriptMsg::DOMManipulation(DOMManipulationTask::FireSimpleEvent(
            target, name)));
    }

    pub fn clone(&self) -> DOMManipulationTaskSource {
        DOMManipulationTaskSource((&self.0).clone())
    }
}

pub enum DOMManipulationTask {
    // https://html.spec.whatwg.org/multipage/#the-end step 7
    DocumentProgress(Box<Runnable + Send>),
    // https://dom.spec.whatwg.org/#concept-event-fire
    FireEvent(Trusted<EventTarget>, Atom, EventBubbles, EventCancelable),
    // https://html.spec.whatwg.org/multipage/#fire-a-simple-event
    FireSimpleEvent(Trusted<EventTarget>, Atom),
    // https://html.spec.whatwg.org/multipage/#details-notification-task-steps
    FireToggleEvent(Box<Runnable + Send>),
    // Placeholder until there's a real media element task queue implementation
    MediaTask(Box<Runnable + Send>),
    // https://html.spec.whatwg.org/multipage/#planned-navigation
    PlannedNavigation(Box<Runnable + Send>),
    // https://html.spec.whatwg.org/multipage/#send-a-storage-notification
    SendStorageNotification(Box<MainThreadRunnable + Send>)
}

impl DOMManipulationTask {
    pub fn handle_task(self, script_thread: &ScriptThread) {
        use self::DOMManipulationTask::*;

        match self {
            DocumentProgress(runnable) => runnable.handler(),
            FireEvent(element, name, bubbles, cancelable) => {
                let target = element.root();
                target.fire_event(&*name, bubbles, cancelable);
            }
            FireSimpleEvent(element, name) => {
                let target = element.root();
                target.fire_simple_event(&*name);
            }
            FireToggleEvent(runnable) => runnable.handler(),
            MediaTask(runnable) => runnable.handler(),
            PlannedNavigation(runnable) => runnable.handler(),
            SendStorageNotification(runnable) => runnable.handler(script_thread)
        }
    }
}