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 public:
  40     static PassRefPtrWillBeRawPtr<TextTrackCueList> create()
  41     {
  42         return adoptRefWillBeNoop(new TextTrackCueList);
  43     }
  44
  45     unsigned long length() const;
  46     unsigned long getCueIndex(TextTrackCue*) const;
  47
  48     TextTrackCue* item(unsigned index) const;
  49     TextTrackCue* getCueById(const AtomicString&) const;
  50     TextTrackCueList* activeCues();
  51
  52     bool add(PassRefPtrWillBeRawPtr<TextTrackCue>);
  53     bool remove(TextTrackCue*);
  54     bool contains(TextTrackCue*) const;
  55
  56     bool updateCueIndex(TextTrackCue*);
  57
  58     void trace(Visitor*);
  59
  60 private:
  61     TextTrackCueList();
  62     bool add(PassRefPtrWillBeRawPtr<TextTrackCue>, size_t, size_t);
  63     void clear();
  64     void invalidateCueIndexes(size_t);
  65
  66     WillBeHeapVector<RefPtrWillBeMember<TextTrackCue> > m_list;
  67     RefPtrWillBeMember<TextTrackCueList> m_activeCues;
  68 };
  69
  70 } // namespace blink
  71
  72 #endif