Moved constants out of web_view.js and into a new file, web_view_constants.js,...

Moved constants out of web_view.js and into a new file, web_view_constants.js, so that the constants can be shared by multiple webview files.

Review URL: https://codereview.chromium.org/661743005

Cr-Commit-Position: refs/heads/master@{#300547}

extensions/renderer/dispatcher.cc

@@ -334,6 +334,7 @@ void Dispatcher::DidCreateScriptContext(
   // The API will be automatically set up when first used.
   if (context->GetAvailability("webViewInternal").is_available()) {
     module_system->Require("webView");
+    module_system->Require("webViewConstants");
     if (context->GetAvailability("webViewExperimentalInternal")
             .is_available()) {
       module_system->Require("webViewExperimental");
@@ -548,6 +549,8 @@ std::vector<std::pair<std::string, int> > Dispatcher::GetJsResources() {
   // Note: webView not webview so that this doesn't interfere with the
   // chrome.webview API bindings.
   resources.push_back(std::make_pair("webView", IDR_WEB_VIEW_JS));
+  resources.push_back(std::make_pair("webViewConstants",
+                                     IDR_WEB_VIEW_CONSTANTS_JS));
   resources.push_back(std::make_pair("webViewEvents", IDR_WEB_VIEW_EVENTS_JS));
   resources.push_back(
       std::make_pair("webViewExperimental", IDR_WEB_VIEW_EXPERIMENTAL_JS));

extensions/renderer/resources/extensions_renderer_resources.grd

@@ -35,6 +35,7 @@
       <include name="IDR_UNCAUGHT_EXCEPTION_HANDLER_JS" file="uncaught_exception_handler.js" type="BINDATA" />
       <include name="IDR_UNLOAD_EVENT_JS" file="unload_event.js" type="BINDATA" />
       <include name="IDR_UTILS_JS" file="utils.js" type="BINDATA" />
+      <include name="IDR_WEB_VIEW_CONSTANTS_JS" file="guest_view/web_view_constants.js" type="BINDATA" />
       <include name="IDR_WEB_VIEW_DENY_JS" file="guest_view/web_view_deny.js" type="BINDATA" />
       <include name="IDR_WEB_VIEW_EVENTS_JS" file="guest_view/web_view_events.js" type="BINDATA" />
       <include name="IDR_WEB_VIEW_EXPERIMENTAL_JS" file="guest_view/web_view_experimental.js" type="BINDATA" />

extensions/renderer/resources/guest_view/web_view.js

@@ -11,35 +11,18 @@ var GuestViewInternal =
     require('binding').Binding.create('guestViewInternal').generate();
 var guestViewInternalNatives = requireNative('guest_view_internal');
 var IdGenerator = requireNative('id_generator');
+var WebViewConstants = require('webViewConstants').WebViewConstants;
 var WebViewEvents = require('webViewEvents').WebViewEvents;
 var WebViewInternal = require('webViewInternal').WebViewInternal;
 
-// Attributes.
-var WEB_VIEW_ATTRIBUTE_ALLOWTRANSPARENCY = 'allowtransparency';
-var WEB_VIEW_ATTRIBUTE_AUTOSIZE = 'autosize';
-var WEB_VIEW_ATTRIBUTE_MAXHEIGHT = 'maxheight';
-var WEB_VIEW_ATTRIBUTE_MAXWIDTH = 'maxwidth';
-var WEB_VIEW_ATTRIBUTE_MINHEIGHT = 'minheight';
-var WEB_VIEW_ATTRIBUTE_MINWIDTH = 'minwidth';
-var WEB_VIEW_ATTRIBUTE_PARTITION = 'partition';
 var AUTO_SIZE_ATTRIBUTES = [
-  WEB_VIEW_ATTRIBUTE_AUTOSIZE,
-  WEB_VIEW_ATTRIBUTE_MAXHEIGHT,
-  WEB_VIEW_ATTRIBUTE_MAXWIDTH,
-  WEB_VIEW_ATTRIBUTE_MINHEIGHT,
-  WEB_VIEW_ATTRIBUTE_MINWIDTH
+  WebViewConstants.ATTRIBUTE_AUTOSIZE,
+  WebViewConstants.ATTRIBUTE_MAXHEIGHT,
+  WebViewConstants.ATTRIBUTE_MAXWIDTH,
+  WebViewConstants.ATTRIBUTE_MINHEIGHT,
+  WebViewConstants.ATTRIBUTE_MINWIDTH
 ];
 
-// Error messages.
-var ERROR_MSG_ALREADY_NAVIGATED =
-    'The object has already navigated, so its partition cannot be changed.';
-var ERROR_MSG_CANNOT_INJECT_SCRIPT = '<webview>: ' +
-    'Script cannot be injected into content until the page has loaded.';
-var ERROR_MSG_CONTENTWINDOW_NOT_AVAILABLE = '<webview>: ' +
-    'contentWindow is not available at this time. It will become available ' +
-    'when the page has finished loading.';
-var ERROR_MSG_INVALID_PARTITION_ATTRIBUTE = 'Invalid partition attribute.';
-
 // Represents the state of the storage partition.
 function Partition() {
   this.validPartitionId = true;
@@ -57,7 +40,7 @@ Partition.prototype.toAttribute = function() {
 Partition.prototype.fromAttribute = function(value, hasNavigated) {
   var result = {};
   if (hasNavigated) {
-    result.error = ERROR_MSG_ALREADY_NAVIGATED;
+    result.error = WebViewConstants.ERROR_MSG_ALREADY_NAVIGATED;
     return result;
   }
   if (!value) {
@@ -69,7 +52,7 @@ Partition.prototype.fromAttribute = function(value, hasNavigated) {
     value = value.substr(LEN);
     if (!value) {
       this.validPartitionId = false;
-      result.error = ERROR_MSG_INVALID_PARTITION_ATTRIBUTE;
+      result.error = WebViewConstants.ERROR_MSG_INVALID_PARTITION_ATTRIBUTE;
       return result;
     }
     this.persistStorage = true;
@@ -180,7 +163,7 @@ WebView.prototype.setupFocusPropagation = function() {
 // Validation helper function for executeScript() and insertCSS().
 WebView.prototype.validateExecuteCodeCall  = function() {
   if (!this.guestInstanceId) {
-    throw new Error(ERROR_MSG_CANNOT_INJECT_SCRIPT);
+    throw new Error(WebViewConstants.ERROR_MSG_CANNOT_INJECT_SCRIPT);
   }
 };
 
@@ -203,13 +186,14 @@ WebView.prototype.setupWebviewNodeProperties = function() {
   this.setupAutoSizeProperties();
 
   Object.defineProperty(this.webviewNode,
-                        WEB_VIEW_ATTRIBUTE_ALLOWTRANSPARENCY, {
+                        WebViewConstants.ATTRIBUTE_ALLOWTRANSPARENCY, {
     get: function() {
       return this.allowtransparency;
     }.bind(this),
     set: function(value) {
-      this.webviewNode.setAttribute(WEB_VIEW_ATTRIBUTE_ALLOWTRANSPARENCY,
-                                    value);
+      this.webviewNode.setAttribute(
+          WebViewConstants.ATTRIBUTE_ALLOWTRANSPARENCY,
+          value);
     }.bind(this),
     enumerable: true
   });
@@ -221,7 +205,8 @@ WebView.prototype.setupWebviewNodeProperties = function() {
       if (this.contentWindow) {
         return this.contentWindow;
       }
-      window.console.error(ERROR_MSG_CONTENTWINDOW_NOT_AVAILABLE);
+      window.console.error(
+          WebViewConstants.ERROR_MSG_CONTENTWINDOW_NOT_AVAILABLE);
     }.bind(this),
     // No setter.
     enumerable: true
@@ -302,7 +287,8 @@ WebView.prototype.handleWebviewAttributeMutation =
       return;
     }
     // Convert autosize attribute to boolean.
-    var autosize = this.webviewNode.hasAttribute(WEB_VIEW_ATTRIBUTE_AUTOSIZE);
+    var autosize = this.webviewNode.hasAttribute(
+        WebViewConstants.ATTRIBUTE_AUTOSIZE);
     GuestViewInternal.setAutoSize(this.guestInstanceId, {
       'enableAutoSize': autosize,
       'min': {
@@ -315,7 +301,7 @@ WebView.prototype.handleWebviewAttributeMutation =
       }
     });
     return;
-  } else if (name == WEB_VIEW_ATTRIBUTE_ALLOWTRANSPARENCY) {
+  } else if (name == WebViewConstants.ATTRIBUTE_ALLOWTRANSPARENCY) {
     // We treat null attribute (attribute removed) and the empty string as
     // one case.
     oldValue = oldValue || '';
@@ -419,17 +405,17 @@ WebView.prototype.onSizeChanged = function(webViewEvent) {
   // Check the current bounds to make sure we do not resize <webview>
   // outside of current constraints.
   var maxWidth;
-  if (node.hasAttribute(WEB_VIEW_ATTRIBUTE_MAXWIDTH) &&
-      node[WEB_VIEW_ATTRIBUTE_MAXWIDTH]) {
-    maxWidth = node[WEB_VIEW_ATTRIBUTE_MAXWIDTH];
+  if (node.hasAttribute(WebViewConstants.ATTRIBUTE_MAXWIDTH) &&
+      node[WebViewConstants.ATTRIBUTE_MAXWIDTH]) {
+    maxWidth = node[WebViewConstants.ATTRIBUTE_MAXWIDTH];
   } else {
     maxWidth = width;
   }
 
   var minWidth;
-  if (node.hasAttribute(WEB_VIEW_ATTRIBUTE_MINWIDTH) &&
-      node[WEB_VIEW_ATTRIBUTE_MINWIDTH]) {
-    minWidth = node[WEB_VIEW_ATTRIBUTE_MINWIDTH];
+  if (node.hasAttribute(WebViewConstants.ATTRIBUTE_MINWIDTH) &&
+      node[WebViewConstants.ATTRIBUTE_MINWIDTH]) {
+    minWidth = node[WebViewConstants.ATTRIBUTE_MINWIDTH];
   } else {
     minWidth = width;
   }
@@ -438,17 +424,17 @@ WebView.prototype.onSizeChanged = function(webViewEvent) {
   }
 
   var maxHeight;
-  if (node.hasAttribute(WEB_VIEW_ATTRIBUTE_MAXHEIGHT) &&
-      node[WEB_VIEW_ATTRIBUTE_MAXHEIGHT]) {
-    maxHeight = node[WEB_VIEW_ATTRIBUTE_MAXHEIGHT];
+  if (node.hasAttribute(WebViewConstants.ATTRIBUTE_MAXHEIGHT) &&
+      node[WebViewConstants.ATTRIBUTE_MAXHEIGHT]) {
+    maxHeight = node[WebViewConstants.ATTRIBUTE_MAXHEIGHT];
   } else {
     maxHeight = height;
   }
 
   var minHeight;
-  if (node.hasAttribute(WEB_VIEW_ATTRIBUTE_MINHEIGHT) &&
-      node[WEB_VIEW_ATTRIBUTE_MINHEIGHT]) {
-    minHeight = node[WEB_VIEW_ATTRIBUTE_MINHEIGHT];
+  if (node.hasAttribute(WebViewConstants.ATTRIBUTE_MINHEIGHT) &&
+      node[WebViewConstants.ATTRIBUTE_MINHEIGHT]) {
+    minHeight = node[WebViewConstants.ATTRIBUTE_MINHEIGHT];
   } else {
     minHeight = height;
   }
@@ -456,7 +442,7 @@ WebView.prototype.onSizeChanged = function(webViewEvent) {
     minHeight = maxHeight;
   }
 
-  if (!this.webviewNode.hasAttribute(WEB_VIEW_ATTRIBUTE_AUTOSIZE) ||
+  if (!this.webviewNode.hasAttribute(WebViewConstants.ATTRIBUTE_AUTOSIZE) ||
       (newWidth >= minWidth &&
        newWidth <= maxWidth &&
        newHeight >= minHeight &&
@@ -480,7 +466,7 @@ WebView.prototype.hasNavigated = function() {
 
 WebView.prototype.parseSrcAttribute = function(result) {
   if (!this.partition.validPartitionId) {
-    result.error = ERROR_MSG_INVALID_PARTITION_ATTRIBUTE;
+    result.error = WebViewConstants.ERROR_MSG_INVALID_PARTITION_ATTRIBUTE;
     return;
   }
   this.src = this.webviewNode.getAttribute('src');
@@ -516,8 +502,8 @@ WebView.prototype.createGuest = function() {
     return;
   }
   var storagePartitionId =
-      this.webviewNode.getAttribute(WEB_VIEW_ATTRIBUTE_PARTITION) ||
-      this.webviewNode[WEB_VIEW_ATTRIBUTE_PARTITION];
+      this.webviewNode.getAttribute(WebViewConstants.ATTRIBUTE_PARTITION) ||
+      this.webviewNode[WebViewConstants.ATTRIBUTE_PARTITION];
   var params = {
     'storagePartitionId': storagePartitionId
   };
@@ -595,7 +581,8 @@ WebView.prototype.onAttach = function(storagePartitionId) {
 WebView.prototype.buildAttachParams = function(isNewWindow) {
   var params = {
     'allowtransparency': this.allowtransparency || false,
-    'autosize': this.webviewNode.hasAttribute(WEB_VIEW_ATTRIBUTE_AUTOSIZE),
+    'autosize': this.webviewNode.hasAttribute(
+        WebViewConstants.ATTRIBUTE_AUTOSIZE),
     'instanceId': this.viewInstanceId,
     'maxheight': parseInt(this.maxheight || 0),
     'maxwidth': parseInt(this.maxwidth || 0),

extensions/renderer/resources/guest_view/web_view_constants.js

+// Copyright (c) 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// This module contains constants used in webview.
+
+// Container for the webview constants.
+var WebViewConstants = {
+  // Attributes.
+  ATTRIBUTE_ALLOWTRANSPARENCY: 'allowtransparency',
+  ATTRIBUTE_AUTOSIZE: 'autosize',
+  ATTRIBUTE_MAXHEIGHT: 'maxheight',
+  ATTRIBUTE_MAXWIDTH: 'maxwidth',
+  ATTRIBUTE_MINHEIGHT: 'minheight',
+  ATTRIBUTE_MINWIDTH: 'minwidth',
+  ATTRIBUTE_PARTITION: 'partition',
+
+  // Error messages.
+  ERROR_MSG_ALREADY_NAVIGATED:
+      'The object has already navigated, so its partition cannot be changed.',
+  ERROR_MSG_CANNOT_INJECT_SCRIPT: '<webview>: ' +
+      'Script cannot be injected into content until the page has loaded.',
+  ERROR_MSG_CONTENTWINDOW_NOT_AVAILABLE: '<webview>: ' +
+      'contentWindow is not available at this time. It will become available ' +
+      'when the page has finished loading.',
+  ERROR_MSG_INVALID_PARTITION_ATTRIBUTE: 'Invalid partition attribute.'
+};
+
+exports.WebViewConstants = WebViewConstants;