Source/core/dom/CustomElement.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 CustomElement_h
#define CustomElement_h

#include "core/dom/CustomElementDefinition.h"
#include "wtf/HashMap.h"
#include "wtf/Noncopyable.h"
#include "wtf/PassRefPtr.h"
#include "wtf/RefPtr.h"
#include "wtf/Vector.h"
#include "wtf/text/AtomicString.h"

namespace WebCore {

class Document;
class Element;

class CustomElement {
public:
    static bool isValidName(const AtomicString& name);
    static void allowTagName(const AtomicString& localName);

    // API for registration contexts
    static void define(Element*, PassRefPtr<CustomElementDefinition>);

    // API for wrapper creation, which uses a definition as a key
    static CustomElementDefinition* definitionFor(Element*);

    // API for Element to kick off changes

    static void didFinishParsingChildren(Element*);
    static void attributeDidChange(Element*, const AtomicString& name, const AtomicString& oldValue, const AtomicString& newValue);
    static void didEnterDocument(Element*, Document*);
    static void didLeaveDocument(Element*, Document*);
    static void wasDestroyed(Element*);

private:
    CustomElement();

    static Vector<AtomicString>& allowedCustomTagNames();

    // Maps resolved elements to their definitions

    class DefinitionMap {
        WTF_MAKE_NONCOPYABLE(DefinitionMap);
    public:
        DefinitionMap() { }
        ~DefinitionMap() { }

        void add(Element*, PassRefPtr<CustomElementDefinition>);
        void remove(Element* element) { m_definitions.remove(element); }
        CustomElementDefinition* get(Element* element) const { return m_definitions.get(element); }

    private:
        typedef HashMap<Element*, RefPtr<CustomElementDefinition> > ElementDefinitionHashMap;
        ElementDefinitionHashMap m_definitions;
    };
    static DefinitionMap& definitions();
};

}

#endif // CustomElement_h