Rename AtomicString to AtomString
[WebKit-https.git] / Source / WebCore / html / track / WebVTTElement.h
1 /*
2  * Copyright (C) 2013 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(VIDEO_TRACK)
29
30 #include "HTMLElement.h"
31 #include <wtf/NeverDestroyed.h>
32
33 namespace WebCore {
34
35 enum WebVTTNodeType {
36     WebVTTNodeTypeNone = 0,
37     WebVTTNodeTypeClass,
38     WebVTTNodeTypeItalic,
39     WebVTTNodeTypeLanguage,
40     WebVTTNodeTypeBold,
41     WebVTTNodeTypeUnderline,
42     WebVTTNodeTypeRuby,
43     WebVTTNodeTypeRubyText,
44     WebVTTNodeTypeVoice
45 };
46
47 class WebVTTElement final : public Element {
48     WTF_MAKE_ISO_ALLOCATED(WebVTTElement);
49 public:
50     static Ref<WebVTTElement> create(const WebVTTNodeType, Document&);
51     Ref<HTMLElement> createEquivalentHTMLElement(Document&);
52
53     Ref<Element> cloneElementWithoutAttributesAndChildren(Document&) override;
54
55     void setWebVTTNodeType(WebVTTNodeType type) { m_webVTTNodeType = static_cast<unsigned>(type); }
56     WebVTTNodeType webVTTNodeType() const { return static_cast<WebVTTNodeType>(m_webVTTNodeType); }
57
58     bool isPastNode() const { return m_isPastNode; }
59     void setIsPastNode(bool value) { m_isPastNode = value; }
60
61     AtomString language() const { return m_language; }
62     void setLanguage(const AtomString& value) { m_language = value; }
63
64     static const QualifiedName& voiceAttributeName()
65     {
66         static NeverDestroyed<QualifiedName> voiceAttr(nullAtom(), "voice", nullAtom());
67         return voiceAttr;
68     }
69     
70     static const QualifiedName& langAttributeName()
71     {
72         static NeverDestroyed<QualifiedName> voiceAttr(nullAtom(), "lang", nullAtom());
73         return voiceAttr;
74     }
75
76 private:
77     WebVTTElement(WebVTTNodeType, Document&);
78
79     bool isWebVTTElement() const override { return true; }
80
81     unsigned m_isPastNode : 1;
82     unsigned m_webVTTNodeType : 4;
83     
84     AtomString m_language;
85 };
86
87 } // namespace WebCore
88
89 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WebVTTElement)
90     static bool isType(const WebCore::Node& node) { return node.isWebVTTElement(); }
91 SPECIALIZE_TYPE_TRAITS_END()
92
93 #endif // ENABLE(VIDEO_TRACK)