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 COMPUTER, 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 COMPUTER, 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#if ENABLE(VIDEO_TRACK)
27
28#include "HTMLElement.h"
29
30namespace WebCore {
31
32enum WebVTTNodeType {
33    WebVTTNodeTypeNone = 0,
34    WebVTTNodeTypeClass,
35    WebVTTNodeTypeItalic,
36    WebVTTNodeTypeLanguage,
37    WebVTTNodeTypeBold,
38    WebVTTNodeTypeUnderline,
39    WebVTTNodeTypeRuby,
40    WebVTTNodeTypeRubyText,
41    WebVTTNodeTypeVoice
42};
43
44class WebVTTElement FINAL : public Element {
45public:
46    static PassRefPtr<WebVTTElement> create(const WebVTTNodeType, Document*);
47    static PassRefPtr<WebVTTElement> create(const QualifiedName&, Document*);
48    PassRefPtr<HTMLElement> createEquivalentHTMLElement(Document*);
49
50    virtual PassRefPtr<Element> cloneElementWithoutAttributesAndChildren() OVERRIDE;
51
52    void setWebVTTNodeType(WebVTTNodeType type) { m_webVTTNodeType = static_cast<unsigned>(type); }
53    WebVTTNodeType webVTTNodeType() const { return static_cast<WebVTTNodeType>(m_webVTTNodeType); }
54
55    bool isPastNode() const { return m_isPastNode; }
56    void setIsPastNode(bool value) { m_isPastNode = value; }
57
58    virtual bool isWebVTTElement() const OVERRIDE { return true; }
59    AtomicString language() const { return m_language; }
60    void setLanguage(AtomicString value) { m_language = value; }
61
62    static const QualifiedName& voiceAttributeName()
63    {
64        DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "voice", nullAtom));
65        return voiceAttr;
66    }
67
68    static const QualifiedName& langAttributeName()
69    {
70        DEFINE_STATIC_LOCAL(QualifiedName, voiceAttr, (nullAtom, "lang", nullAtom));
71        return voiceAttr;
72    }
73
74private:
75    WebVTTElement(const QualifiedName&, Document*);
76    WebVTTElement(WebVTTNodeType, Document*);
77
78    unsigned m_isPastNode : 1;
79    unsigned m_webVTTNodeType : 4;
80
81    AtomicString m_language;
82};
83
84inline WebVTTElement* toWebVTTElement(Node* node)
85{
86    ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isWebVTTElement());
87    return static_cast<WebVTTElement*>(node);
88}
89
90// This will catch anyone doing an unnecessary cast.
91void toWebVTTElement(const WebVTTElement*);
92
93
94} // namespace WebCore
95
96#endif
97