Implement VTTCue.region and sync the VTTRegion interface

third_party/WebKit/Source/core/html/track/vtt/VTTCue.cpp

 /*
  * Copyright (c) 2013, Opera Software ASA. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 26 matching lines @@
 #include "core/dom/DocumentFragment.h"
 #include "core/dom/NodeTraversal.h"
 #include "core/events/Event.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/html/HTMLDivElement.h"
 #include "core/html/track/TextTrack.h"
 #include "core/html/track/TextTrackCueList.h"
 #include "core/html/track/vtt/VTTElement.h"
 #include "core/html/track/vtt/VTTParser.h"
-#include "core/html/track/vtt/VTTRegionList.h"
+#include "core/html/track/vtt/VTTRegion.h"
 #include "core/html/track/vtt/VTTScanner.h"
 #include "core/layout/LayoutVTTCue.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/text/BidiResolver.h"
 #include "platform/text/TextRunIterator.h"
 #include "wtf/MathExtras.h"
 #include "wtf/text/StringBuilder.h"
 
 namespace blink {
 
@@ skipping 407 matching lines @@
   }
 }
 
 DocumentFragment* VTTCue::getCueAsHTML() {
   createVTTNodeTree();
   DocumentFragment* clonedFragment = DocumentFragment::create(document());
   copyVTTNodeToDOMTree(m_vttNodeTree.get(), clonedFragment);
   return clonedFragment;
 }
 
-void VTTCue::setRegionId(const String& regionId) {
-  if (m_regionId == regionId)
+void VTTCue::setRegion(VTTRegion* region) {
+  if (m_region == region)
     return;
-
   cueWillChange();
-  m_regionId = regionId;
+  m_region = region;
   cueDidChange();
 }
 
 float VTTCue::calculateComputedLinePosition() const {
   // http://dev.w3.org/html5/webvtt/#dfn-cue-computed-line
   // A WebVTT cue has a computed line whose value is that returned by the
   // following algorithm, which is defined in terms of the other aspects of
   // the cue:
 
   // 1. If the line is numeric, the WebVTT cue snap-to-lines flag of the
@@ skipping 314 matching lines @@
     // track.
     applyUserOverrideCSSProperties();
     return m_displayTree;
   }
 
   createVTTNodeTree();
 
   m_cueBackgroundBox->removeChildren();
   m_vttNodeTree->cloneChildNodes(m_cueBackgroundBox.get());
 
-  // TODO(foolip): The region identifier may be non-empty without there being
-  // a corresponding region, in which case this VTTCueBox will be added
-  // directly to the text track container in updateDisplay().
-  if (regionId().isEmpty()) {
+  if (!region()) {
     VTTDisplayParameters displayParameters = calculateDisplayParameters();
     m_displayTree->applyCSSProperties(displayParameters);
   } else {
     m_displayTree->setInlineStyleProperty(CSSPropertyPosition,
                                           CSSValueRelative);
   }
 
   // Apply user override settings for text tracks
   applyUserOverrideCSSProperties();
 
   m_displayTreeShouldChange = false;
 
   return m_displayTree;
 }
 
 void VTTCue::removeDisplayTree(RemovalNotification removalNotification) {
-  if (removalNotification == NotifyRegion && track()->regions()) {
+  if (region() && removalNotification == NotifyRegion) {
     // The region needs to be informed about the cue removal.
-    VTTRegion* region = track()->regions()->getRegionById(m_regionId);
-    if (region)
-      region->willRemoveVTTCueBox(m_displayTree.get());
+    region()->willRemoveVTTCueBox(m_displayTree);
   }
 
   if (m_displayTree)
     m_displayTree->remove(ASSERT_NO_EXCEPTION);
 }
 
 void VTTCue::updateDisplay(HTMLDivElement& container) {
   DCHECK(track() && track()->isRendered() && isActive());
 
   UseCounter::count(document(), UseCounter::VTTCueRender);
@@ skipping 10 matching lines @@
   if (textPositionIsAuto())
     UseCounter::count(document(), UseCounter::VTTCueRenderPositionNot50);
 
   if (m_cueSize != 100)
     UseCounter::count(document(), UseCounter::VTTCueRenderSizeNot100);
 
   if (m_cueAlignment != Middle)
     UseCounter::count(document(), UseCounter::VTTCueRenderAlignNotMiddle);
 
   VTTCueBox* displayBox = getDisplayTree();
-  VTTRegion* region = 0;
-  if (track()->regions())
-    region = track()->regions()->getRegionById(regionId());
-
-  if (!region) {
-    // If cue has an empty region identifier or there is no WebVTT region
-    // whose region identifier is identical to cue's region identifier, run
-    // the following substeps:
+  if (!region()) {
     if (displayBox->hasChildren() && !container.contains(displayBox)) {
       // Note: the display tree of a cue is removed when the active flag of the
       // cue is unset.
       container.appendChild(displayBox);
     }
   } else {
-    // Let region be the WebVTT region whose region identifier matches the
-    // region identifier of cue.
-    HTMLDivElement* regionNode = region->getDisplayTree(document());
+    HTMLDivElement* regionNode = region()->getDisplayTree(document());
 
     // Append the region to the viewport, if it was not already.
     if (!container.contains(regionNode))
       container.appendChild(regionNode);
 
-    region->appendVTTCueBox(displayBox);
+    region()->appendVTTCueBox(displayBox);
   }
 }
 
 VTTCue::CueSetting VTTCue::settingName(VTTScanner& input) const {
   CueSetting parsedSetting = None;
   if (input.scan("vertical"))
     parsedSetting = Vertical;
   else if (input.scan("line"))
     parsedSetting = Line;
   else if (input.scan("position"))
@@ skipping 24 matching lines @@
   //    PERCENT SIGN character (%), then fail.
   // 6. If the last character in input is not a U+0025 PERCENT SIGN character
   //    (%), then fail.
   // 7. Ignoring the trailing percent sign, interpret input as a real
   //    number. Let that number be the percentage.
   // 8. If percentage is outside the range 0..100, then fail.
   // 9. Return percentage.
   return input.scanPercentage(number) && !isInvalidPercentage(number);
 }
 
-void VTTCue::parseSettings(const String& inputString) {
+void VTTCue::parseSettings(const VTTRegionMap* regionMap,
+                           const String& inputString) {
   VTTScanner input(inputString);
 
   while (!input.isAtEnd()) {
     // The WebVTT cue settings part of a WebVTT cue consists of zero or more of
     // the following components, in any order, separated from each other by one
     // or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab)
     // characters.
     input.skipWhile<VTTParser::isValidSettingDelimiter>();
 
     if (input.isAtEnd())
@@ skipping 131 matching lines @@
         else if (input.scanRun(valueRun, leftKeyword()))
           m_cueAlignment = Left;
 
         // 5. If value is a case-sensitive match for the string "right",
         //    then let cue's WebVTT cue text alignment be right alignment.
         else if (input.scanRun(valueRun, rightKeyword()))
           m_cueAlignment = Right;
         break;
       }
       case RegionId:
-        m_regionId = input.extractString(valueRun);
+        if (regionMap)
+          m_region = regionMap->get(input.extractString(valueRun));
         break;
       case None:
         break;
     }
 
     // Make sure the entire run is consumed.
     input.skipRun(valueRun);
   }
-
-  // If cue's line position is not auto or cue's size is not 100 or cue's
-  // writing direction is not horizontal, but cue's region identifier is not
-  // the empty string, let cue's region identifier be the empty string.
-  if (m_regionId.isEmpty())
-    return;
-
-  if (!lineIsAuto() || m_cueSize != 100 || m_writingDirection != Horizontal)
-    m_regionId = emptyString;
 }
 
 void VTTCue::applyUserOverrideCSSProperties() {
   Settings* settings = document().settings();
   if (!settings)
     return;
 
   setInlineStylePropertyIfNotEmpty(*m_cueBackgroundBox,
                                    CSSPropertyBackgroundColor,
                                    settings->getTextTrackBackgroundColor());
@@ skipping 15 matching lines @@
   DCHECK(m_cueBackgroundBox);
   return m_cueBackgroundBox->getExecutionContext();
 }
 
 Document& VTTCue::document() const {
   DCHECK(m_cueBackgroundBox);
   return m_cueBackgroundBox->document();
 }
 
 DEFINE_TRACE(VTTCue) {
+  visitor->trace(m_region);
   visitor->trace(m_vttNodeTree);
   visitor->trace(m_cueBackgroundBox);
   visitor->trace(m_displayTree);
   TextTrackCue::trace(visitor);
 }
 
 }  // namespace blink