Implement DataCue for metadata cues
[WebKit-https.git] / Source / WebCore / bindings / js / JSTextTrackCueCustom.cpp
1 /*
2  * Copyright (C) 2011 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 #include "config.h"
27
28 #if ENABLE(VIDEO_TRACK)
29
30 #include "JSDataCue.h"
31 #include "JSTextTrackCue.h"
32 #include "JSTrackCustom.h"
33 #include "JSVTTCue.h"
34 #include "TextTrack.h"
35
36 using namespace JSC;
37
38 namespace WebCore {
39
40 bool JSTextTrackCueOwner::isReachableFromOpaqueRoots(JSC::Handle<JSC::Unknown> handle, void*, SlotVisitor& visitor)
41 {
42     JSTextTrackCue* jsTextTrackCue = jsCast<JSTextTrackCue*>(handle.get().asCell());
43     TextTrackCue& textTrackCue = jsTextTrackCue->impl();
44
45     // If the cue is firing event listeners, its wrapper is reachable because
46     // the wrapper is responsible for marking those event listeners.
47     if (textTrackCue.isFiringEventListeners())
48         return true;
49
50     // If the cue has no event listeners and has no custom properties, it is not reachable.
51     if (!textTrackCue.hasEventListeners() && !jsTextTrackCue->hasCustomProperties())
52         return false;
53
54     // If the cue is not associated with a track, it is not reachable.
55     if (!textTrackCue.track())
56         return false;
57
58     return visitor.containsOpaqueRoot(root(textTrackCue.track()));
59 }
60
61 JSValue toJS(ExecState* exec, JSDOMGlobalObject* globalObject, TextTrackCue* cue)
62 {
63     if (!cue)
64         return jsNull();
65
66     JSObject* wrapper = getCachedWrapper(currentWorld(exec), cue);
67
68     if (wrapper)
69         return wrapper;
70
71     // This switch will make more sense once we support DataCue
72     switch (cue->cueType()) {
73     case TextTrackCue::Data:
74         return CREATE_DOM_WRAPPER(exec, globalObject, DataCue, cue);
75     case TextTrackCue::WebVTT:
76     case TextTrackCue::Generic:
77         return CREATE_DOM_WRAPPER(exec, globalObject, VTTCue, cue);
78     default:
79         ASSERT_NOT_REACHED();
80         return jsNull();
81     }
82 }
83
84 void JSTextTrackCue::visitChildren(JSCell* cell, SlotVisitor& visitor)
85 {
86     JSTextTrackCue* jsTextTrackCue = jsCast<JSTextTrackCue*>(cell);
87     ASSERT_GC_OBJECT_INHERITS(jsTextTrackCue, info());
88     COMPILE_ASSERT(StructureFlags & OverridesVisitChildren, OverridesVisitChildrenWithoutSettingFlag);
89     ASSERT(jsTextTrackCue->structure()->typeInfo().overridesVisitChildren());
90     Base::visitChildren(jsTextTrackCue, visitor);
91
92     // Mark the cue's track root if it has one.
93     TextTrackCue& textTrackCue = jsTextTrackCue->impl();
94     if (TextTrack* textTrack = textTrackCue.track())
95         visitor.addOpaqueRoot(root(textTrack));
96     
97     textTrackCue.visitJSEventListeners(visitor);
98 }
99
100 } // namespace WebCore
101
102 #endif