third_party/WebKit/Source/core/dom/custom/CustomElement.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer
  12  *    in the documentation and/or other materials provided with the
  13  *    distribution.
  14  * 3. Neither the name of Google Inc. nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this
  16  *    software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef CustomElement_h
  32 #define CustomElement_h
  33
  34 #include "core/CoreExport.h"
  35 #include "core/dom/custom/CustomElementDefinition.h"
  36 #include "wtf/Allocator.h"
  37 #include "wtf/HashMap.h"
  38 #include "wtf/Noncopyable.h"
  39 #include "wtf/PassRefPtr.h"
  40 #include "wtf/RefPtr.h"
  41 #include "wtf/Vector.h"
  42 #include "wtf/text/AtomicString.h"
  43
  44 namespace blink {
  45
  46 class CustomElementMicrotaskImportStep;
  47 class Document;
  48 class HTMLImportChild;
  49
  50 class CORE_EXPORT CustomElement {
  51     STATIC_ONLY(CustomElement);
  52 public:
  53     enum NameSet {
  54         EmbedderNames = 1 << 0,
  55         StandardNames = 1 << 1,
  56         AllNames = EmbedderNames | StandardNames
  57     };
  58     static bool isValidName(const AtomicString& name, NameSet validNames = AllNames);
  59     static void addEmbedderCustomElementName(const AtomicString& name);
  60
  61     // API to notify of document-level changes
  62     static CustomElementMicrotaskImportStep* didCreateImport(HTMLImportChild*);
  63     static void didFinishLoadingImport(Document& master);
  64
  65     // API for registration contexts
  66     static void define(Element*, PassRefPtrWillBeRawPtr<CustomElementDefinition>);
  67
  68     // API for Element to kick off changes
  69
  70     static void attributeDidChange(Element*, const AtomicString& name, const AtomicString& oldValue, const AtomicString& newValue);
  71     static void didAttach(Element*, const Document&);
  72     static void didDetach(Element*, const Document&);
  73     static void wasDestroyed(Element*);
  74
  75 private:
  76     static Vector<AtomicString>& embedderCustomElementNames();
  77 };
  78
  79 } // namespace blink
  80
  81 #endif // CustomElement_h