servo/src/components/script/dom/htmlimageelement.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::codegen::BindingDeclarations::HTMLImageElementBinding;
use dom::bindings::codegen::InheritTypes::{NodeCast, ElementCast, HTMLElementCast, HTMLImageElementDerived};
use dom::bindings::error::ErrorResult;
use dom::bindings::js::{JS, JSRef, Unrooted, RootCollection};
use dom::bindings::trace::Untraceable;
use dom::document::Document;
use dom::element::{Element, HTMLImageElementTypeId};
use dom::element::AttributeHandlers;
use dom::eventtarget::{EventTarget, NodeTargetTypeId};
use dom::htmlelement::HTMLElement;
use dom::node::{Node, ElementNodeTypeId, NodeHelpers, window_from_node};
use dom::virtualmethods::VirtualMethods;
use servo_util::geometry::to_px;
use servo_net::image_cache_task;
use servo_util::url::parse_url;
use servo_util::str::DOMString;
use url::Url;

#[deriving(Encodable)]
pub struct HTMLImageElement {
    pub htmlelement: HTMLElement,
    image: Untraceable<Option<Url>>,
}

impl HTMLImageElementDerived for EventTarget {
    fn is_htmlimageelement(&self) -> bool {
        match self.type_id {
            NodeTargetTypeId(ElementNodeTypeId(HTMLImageElementTypeId)) => true,
            _ => false
        }
    }
}

impl HTMLImageElement {
    pub fn new_inherited(localName: DOMString, document: JS<Document>) -> HTMLImageElement {
        HTMLImageElement {
            htmlelement: HTMLElement::new_inherited(HTMLImageElementTypeId, localName, document),
            image: Untraceable::new(None),
        }
    }

    pub fn new(localName: DOMString, document: &JSRef<Document>) -> Unrooted<HTMLImageElement> {
        let element = HTMLImageElement::new_inherited(localName, document.unrooted());
        Node::reflect_node(~element, document, HTMLImageElementBinding::Wrap)
    }
}

impl HTMLImageElement {
    pub fn image<'a>(&'a self) -> &'a Option<Url> {
        &*self.image
    }

    /// Makes the local `image` member match the status of the `src` attribute and starts
    /// prefetching the image. This method must be called after `src` is changed.
    fn update_image(&mut self, value: Option<DOMString>, url: Option<Url>) {
        let roots = RootCollection::new();
        let elem = &mut self.htmlelement.element;
        let document = elem.node.owner_doc().root(&roots);
        let window = document.deref().window.root(&roots);
        let image_cache = &window.image_cache_task;
        match value {
            None => {
                *self.image = None;
            }
            Some(src) => {
                let img_url = parse_url(src, url);
                *self.image = Some(img_url.clone());

                // inform the image cache to load this, but don't store a
                // handle.
                //
                // TODO (Issue #84): don't prefetch if we are within a
                // <noscript> tag.
                image_cache.send(image_cache_task::Prefetch(img_url));
            }
        }
    }

    pub fn Alt(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("alt")
    }

    pub fn SetAlt(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, alt: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("alt", alt)
    }

    pub fn Src(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("src")
    }

    pub fn SetSrc(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, src: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_url_attribute("src", src)
    }

    pub fn CrossOrigin(&self) -> DOMString {
        ~""
    }

    pub fn SetCrossOrigin(&mut self, _cross_origin: DOMString) -> ErrorResult {
        Ok(())
    }

    pub fn UseMap(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("useMap")
    }

    pub fn SetUseMap(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, use_map: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("useMap", use_map)
    }

    pub fn IsMap(&self, abstract_self: &JSRef<HTMLImageElement>) -> bool {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        from_str::<bool>(element.get_string_attribute("hspace")).unwrap()
    }

    pub fn SetIsMap(&self, abstract_self: &mut JSRef<HTMLImageElement>, is_map: bool) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("isMap", is_map.to_str())
    }

    pub fn Width(&self, abstract_self: &JSRef<HTMLImageElement>) -> u32 {
        let node: &JSRef<Node> = NodeCast::from_ref(abstract_self);
        let rect = node.get_bounding_content_box();
        to_px(rect.size.width) as u32
    }

    pub fn SetWidth(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, width: u32) {
        let elem: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        elem.set_uint_attribute("width", width)
    }

    pub fn Height(&self, abstract_self: &JSRef<HTMLImageElement>) -> u32 {
        let node: &JSRef<Node> = NodeCast::from_ref(abstract_self);
        let rect = node.get_bounding_content_box();
        to_px(rect.size.height) as u32
    }

    pub fn SetHeight(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, height: u32) {
        let elem: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        elem.set_uint_attribute("height", height)
    }

    pub fn NaturalWidth(&self) -> u32 {
        0
    }

    pub fn NaturalHeight(&self) -> u32 {
        0
    }

    pub fn Complete(&self) -> bool {
        false
    }

    pub fn Name(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("name")
    }

    pub fn SetName(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, name: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("name", name)
    }

    pub fn Align(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("longdesc")
    }

    pub fn SetAlign(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, align: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("align", align)
    }

    pub fn Hspace(&self, abstract_self: &JSRef<HTMLImageElement>) -> u32 {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        from_str::<u32>(element.get_string_attribute("hspace")).unwrap()
    }

    pub fn SetHspace(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, hspace: u32) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_uint_attribute("hspace", hspace)
    }

    pub fn Vspace(&self, abstract_self: &JSRef<HTMLImageElement>) -> u32 {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        from_str::<u32>(element.get_string_attribute("vspace")).unwrap()
    }

    pub fn SetVspace(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, vspace: u32) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_uint_attribute("vspace", vspace)
    }

    pub fn LongDesc(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("longdesc")
    }

    pub fn SetLongDesc(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, longdesc: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("longdesc", longdesc)
    }

    pub fn Border(&self, abstract_self: &JSRef<HTMLImageElement>) -> DOMString {
        let element: &JSRef<Element> = ElementCast::from_ref(abstract_self);
        element.get_string_attribute("border")
    }

    pub fn SetBorder(&mut self, abstract_self: &mut JSRef<HTMLImageElement>, border: DOMString) {
        let element: &mut JSRef<Element> = ElementCast::from_mut_ref(abstract_self);
        element.set_string_attribute("border", border)
    }
}

impl<'a> VirtualMethods for JSRef<'a, HTMLImageElement> {
    fn super_type(&self) -> Option<~VirtualMethods:> {
        let htmlelement: &JSRef<HTMLElement> = HTMLElementCast::from_ref(self);
        Some(~htmlelement.clone() as ~VirtualMethods:)
    }

    fn after_set_attr(&mut self, name: DOMString, value: DOMString) {
        let roots = RootCollection::new();
        match self.super_type() {
            Some(ref mut s) => s.after_set_attr(name.clone(), value.clone()),
            _ => (),
        }

        if "src" == name {
            let window = window_from_node(self).root(&roots);
            let url = Some(window.get().get_url());
            self.get_mut().update_image(Some(value), url);
        }
    }

    fn before_remove_attr(&mut self, name: DOMString, value: DOMString) {
         match self.super_type() {
            Some(ref mut s) => s.before_remove_attr(name.clone(), value.clone()),
            _ => (),
        }

        if "src" == name {
            self.get_mut().update_image(None, None);
        }
    }
}