1be7636c3663d858bd7636aeccc19b706dfc6b8c
[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 #ifndef WebVTTElement_h
27 #define WebVTTElement_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "HTMLElement.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 public:
49     static Ref<WebVTTElement> create(const WebVTTNodeType, Document&);
50     PassRefPtr<HTMLElement> createEquivalentHTMLElement(Document&);
51
52     virtual RefPtr<Element> cloneElementWithoutAttributesAndChildren(Document&) override;
53
54     void setWebVTTNodeType(WebVTTNodeType type) { m_webVTTNodeType = static_cast<unsigned>(type); }
55     WebVTTNodeType webVTTNodeType() const { return static_cast<WebVTTNodeType>(m_webVTTNodeType); }
56
57     bool isPastNode() const { return m_isPastNode; }
58     void setIsPastNode(bool value) { m_isPastNode = value; }
59
60     AtomicString language() const { return m_language; }
61     void setLanguage(const AtomicString& value) { m_language = value; }
62
63     static const QualifiedName& voiceAttributeName()
64     {
65         DEPRECATED_DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "voice", nullAtom));
66         return voiceAttr;
67     }
68     
69     static const QualifiedName& langAttributeName()
70     {
71         DEPRECATED_DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "lang", nullAtom));
72         return voiceAttr;
73     }
74
75 private:
76     WebVTTElement(WebVTTNodeType, Document&);
77
78     virtual bool isWebVTTElement() const override { return true; }
79
80     unsigned m_isPastNode : 1;
81     unsigned m_webVTTNodeType : 4;
82     
83     AtomicString m_language;
84 };
85
86 } // namespace WebCore
87
88 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WebVTTElement)
89     static bool isType(const WebCore::Node& node) { return node.isWebVTTElement(); }
90 SPECIALIZE_TYPE_TRAITS_END()
91
92 #endif
93
94 #endif // WebVTTElement_h