Move VTT functionality from TextTrackCue.* to VTTCue.*

Source/core/html/track/TextTrackCue.h

 /*
  * Copyright (C) 2011 Google Inc.  All rights reserved.
  * Copyright (C) 2012, 2013 Apple Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
@@ skipping 21 matching lines @@
 #ifndef TextTrackCue_h
 #define TextTrackCue_h
 
 #include "core/events/EventTarget.h"
 #include "core/html/HTMLDivElement.h"
 #include "wtf/RefCounted.h"
 
 namespace WebCore {
 
 class Document;
-class DocumentFragment;
 class ExceptionState;
-class ExecutionContext;
-class TextTrack;
 class TextTrackCue;
 
 // ----------------------------
 
-class TextTrackCueBox FINAL : public HTMLDivElement {
+class TextTrackCueBox : public HTMLDivElement {
 public:
-    static PassRefPtr<TextTrackCueBox> create(Document& document, TextTrackCue* cue)
+    static const AtomicString& textTrackCueBoxShadowPseudoId()
     {
-        return adoptRef(new TextTrackCueBox(document, cue));
+        DEFINE_STATIC_LOCAL(const AtomicString, trackDisplayBoxShadowPseudoId, ("-webkit-media-text-track-display", AtomicString::ConstructFromLiteral));
+        return trackDisplayBoxShadowPseudoId;
     }
 
-    TextTrackCue* getCue() const;
-    void applyCSSProperties(const IntSize& videoSize);
-
-    static const AtomicString& textTrackCueBoxShadowPseudoId();
-
 protected:
-    TextTrackCueBox(Document&, TextTrackCue*);
-
-    virtual RenderObject* createRenderer(RenderStyle*) OVERRIDE;
-
-    TextTrackCue* m_cue;
+    TextTrackCueBox(Document&);
 };
 
 // ----------------------------
 
 class TextTrackCue : public RefCounted<TextTrackCue>, public EventTargetWithInlineData {
     REFCOUNTED_EVENT_TARGET(TextTrackCue);
 public:
     static const AtomicString& cueShadowPseudoId()
     {
         DEFINE_STATIC_LOCAL(const AtomicString, cue, ("cue", AtomicString::ConstructFromLiteral));
         return cue;
     }
 
-    virtual ~TextTrackCue();
+    virtual ~TextTrackCue() { }
 
     TextTrack* track() const;
     void setTrack(TextTrack*);
 
     const String& id() const { return m_id; }
     void setId(const String&);
 
     double startTime() const { return m_startTime; }
     void setStartTime(double, ExceptionState&);
 
     double endTime() const { return m_endTime; }
     void setEndTime(double, ExceptionState&);
 
     bool pauseOnExit() const { return m_pauseOnExit; }
     void setPauseOnExit(bool);
 
-    const String& vertical() const;
-    void setVertical(const String&, ExceptionState&);
-
-    bool snapToLines() const { return m_snapToLines; }
-    void setSnapToLines(bool);
-
-    int line() const { return m_linePosition; }
-    void setLine(int, ExceptionState&);
-
-    int position() const { return m_textPosition; }
-    void setPosition(int, ExceptionState&);
-
-    int size() const { return m_cueSize; }
-    void setSize(int, ExceptionState&);
-
-    const String& align() const;
-    void setAlign(const String&, ExceptionState&);
-
-    const String& text() const { return m_content; }
-    void setText(const String&);
-
-    void parseSettings(const String&);
-
     int cueIndex();
     void invalidateCueIndex();
 
-    PassRefPtr<DocumentFragment> getCueAsHTML();
-    PassRefPtr<DocumentFragment> createCueRenderingTree();
-
     using EventTarget::dispatchEvent;
     virtual bool dispatchEvent(PassRefPtr<Event>) OVERRIDE;
 
-    const String& regionId() const { return m_regionId; }
-    void setRegionId(const String&);
-    void notifyRegionWhenRemovingDisplayTree(bool);
-
     bool isActive();
     void setIsActive(bool);
 
-    bool hasDisplayTree() const { return m_displayTree; }
-    PassRefPtr<TextTrackCueBox> getDisplayTree(const IntSize& videoSize);
-    PassRefPtr<HTMLDivElement> element() const { return m_cueBackgroundBox; }
+    virtual bool hasDisplayTree() const { return false; }

[acolwell GONE FROM CHROMIUM, 2013/11/20 18:38:45]

Do we really need to make all these virtual? If we don't think they will be
needed by other formats then it seems like we should refactor the code so we
only need a few virtual methods.

[gasubic, 2013/11/21 03:07:38]

Eliminated three: hasDisplayTree, getDisplayTree, element. However, remaining
three (updateDisplayTree, removeDisplayTree,
notifyRegionWhenRemovingDisplayTree) require more work, and would be better done
in a separate CL.

+    virtual PassRefPtr<TextTrackCueBox> getDisplayTree(const IntSize& videoSize) { return 0; }
+    virtual PassRefPtr<HTMLDivElement> element() const { return 0; }
 
-    void updateDisplayTree(double);
-    void removeDisplayTree();
-    void markFutureAndPastNodes(ContainerNode*, double, double);
-
-    int calculateComputedLinePosition();
+    virtual void updateDisplayTree(double) { }
+    virtual void removeDisplayTree() { }
+    virtual void notifyRegionWhenRemovingDisplayTree(bool) { }
 
     virtual const AtomicString& interfaceName() const OVERRIDE;
-    virtual ExecutionContext* executionContext() const OVERRIDE;
-
-    std::pair<double, double> getCSSPosition() const;
-
-    CSSValueID getCSSAlignment() const;
-    int getCSSSize() const;
-    CSSValueID getCSSWritingDirection() const;
-    CSSValueID getCSSWritingMode() const;
-
-    enum WritingDirection {
-        Horizontal = 0,
-        VerticalGrowingLeft,
-        VerticalGrowingRight,
-        NumberOfWritingDirections
-    };
-    WritingDirection getWritingDirection() const { return m_writingDirection; }
-
-    enum CueAlignment {
-        Start = 0,
-        Middle,
-        End,
-        Left,
-        Right,
-        NumberOfAlignments
-    };
-    CueAlignment getAlignment() const { return m_cueAlignment; }
 
     DEFINE_ATTRIBUTE_EVENT_LISTENER(enter);
     DEFINE_ATTRIBUTE_EVENT_LISTENER(exit);
 
+    virtual bool isVTTCue() const { return false; }
+
 protected:
-    TextTrackCue(Document&, double start, double end, const String& content);
+    TextTrackCue(double start, double end);
+
+    void cueWillChange();
+    virtual void cueDidChange();
 
 private:
-    Document& document() const;
-
-    PassRefPtr<TextTrackCueBox> displayTreeInternal();
-
-    void createVTTNodeTree();
-    void copyVTTNodeToDOMTree(ContainerNode* VTTNode, ContainerNode* root);
-
-    std::pair<double, double> getPositionCoordinates() const;
-
-    void determineTextDirection();
-    void calculateDisplayParameters();
-
-    void cueWillChange();
-    void cueDidChange();
-
-    enum CueSetting {
-        None,
-        Vertical,
-        Line,
-        Position,
-        Size,
-        Align,
-        RegionId
-    };
-    CueSetting settingName(const String&);
-
     String m_id;
     double m_startTime;
     double m_endTime;
-    String m_content;
-    int m_linePosition;
-    int m_computedLinePosition;
-    int m_textPosition;
-    int m_cueSize;
     int m_cueIndex;
 
-    WritingDirection m_writingDirection;
-
-    CueAlignment m_cueAlignment;
-
-    RefPtr<DocumentFragment> m_webVTTNodeTree;
     TextTrack* m_track;
 
     bool m_isActive;
     bool m_pauseOnExit;
-    bool m_snapToLines;
-
-    RefPtr<HTMLDivElement> m_cueBackgroundBox;
-
-    bool m_displayTreeShouldChange;
-    RefPtr<TextTrackCueBox> m_displayTree;
-
-    CSSValueID m_displayDirection;
-
-    int m_displaySize;
-
-    std::pair<float, float> m_displayPosition;
-    String m_regionId;
-    bool m_notifyRegion;
 };
 
 } // namespace WebCore
 
 #endif