src/third_party/WebKit/Source/core/html/track/TextTrackCueList.h

   1 /*
   2  * Copyright (C) 2011 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  * 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 #ifndef TextTrackCueList_h
  27 #define TextTrackCueList_h
  28
  29 #include "bindings/core/v8/ScriptWrappable.h"
  30 #include "core/html/track/TextTrackCue.h"
  31 #include "wtf/PassRefPtr.h"
  32 #include "wtf/RefCounted.h"
  33 #include "wtf/Vector.h"
  34
  35 namespace blink {
  36
  37 class TextTrackCueList final : public RefCountedWillBeGarbageCollected<TextTrackCueList>, public ScriptWrappable {
  38     DECLARE_EMPTY_DESTRUCTOR_WILL_BE_REMOVED(TextTrackCueList);
  39     DEFINE_WRAPPERTYPEINFO();
  40 public:
  41     static PassRefPtrWillBeRawPtr<TextTrackCueList> create()
  42     {
  43         return adoptRefWillBeNoop(new TextTrackCueList);
  44     }
  45
  46     unsigned long length() const;
  47     unsigned long getCueIndex(TextTrackCue*) const;
  48
  49     TextTrackCue* item(unsigned index) const;
  50     TextTrackCue* getCueById(const AtomicString&) const;
  51     TextTrackCueList* activeCues();
  52
  53     bool add(PassRefPtrWillBeRawPtr<TextTrackCue>);
  54     bool remove(TextTrackCue*);
  55     bool contains(TextTrackCue*) const;
  56
  57     bool updateCueIndex(TextTrackCue*);
  58
  59     void trace(Visitor*);
  60
  61 private:
  62     TextTrackCueList();
  63     bool add(PassRefPtrWillBeRawPtr<TextTrackCue>, size_t, size_t);
  64     void clear();
  65     void invalidateCueIndexes(size_t);
  66
  67     WillBeHeapVector<RefPtrWillBeMember<TextTrackCue>> m_list;
  68     RefPtrWillBeMember<TextTrackCueList> m_activeCues;
  69 };
  70
  71 } // namespace blink
  72
  73 #endif // TextTrackCueList_h