Changeset 120165 in webkit

Timestamp:

Jun 12, 2012 11:50:19 PM (12 years ago)

Author:

kinuko@chromium.org

Message:

Unprefix Blob.webkitSlice
​https://bugs.webkit.org/show_bug.cgi?id=78111

Reviewed by Adam Barth.

Source/WebCore:

Add unprefixed Blob.slice and start showing a deprecation message when webkitSlice is called.

No new tests: existing tests that call webkitSlice() are converted to slice(). They should keep running.

• bindings/gobject/WebKitDOMCustom.cpp:

(webkit_dom_blob_slice): Removed.
(webkit_dom_blob_webkit_slice): Added.

• fileapi/Blob.cpp:

(WebCore::Blob::slice):
(WebCore):
(WebCore::Blob::webkitSlice):
(WebCore::Blob::sliceInternal): Added.

• fileapi/Blob.h:

(WebCore):
(Blob):

• fileapi/Blob.idl:

LayoutTests:

Converted existing tests that are calling Blob.webkitSlice() to call slice().

• fast/files/blob-slice-overflow.html:
• fast/files/blob-slice-test.html:
• fast/files/resources/read-blob-test-cases.js:

(testReadingSlicedFileBlob):
(testReadingSlicedTextBlob):
(testReadingSlicedArrayBufferBlob):
(testReadingSlicedHybridBlob):
(testReadingTripleSlicedHybridBlob):

• fast/filesystem/resources/file-writer-utils.js:

(verifyByteRangeIsZeroesHelper):

• http/tests/local/blob/script-tests/send-hybrid-blob.js:

(runHybridBlobTest):

• http/tests/local/blob/script-tests/send-sliced-data-blob.js:

(runSliceTest):

• http/tests/local/fileapi/script-tests/send-sliced-dragged-file.js:

(onStableFileDrop):
(onUnstableFileDrop):

• http/tests/local/formdata/resources/send-form-data-common.js:

(testSendingFormData):

• inspector/profiler/heap-snapshot-loader.html:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/fast/files/blob-slice-overflow.html (modified) (1 diff)
• LayoutTests/fast/files/blob-slice-test.html (modified) (1 diff)
• LayoutTests/fast/files/resources/read-blob-test-cases.js (modified) (5 diffs)
• LayoutTests/fast/filesystem/resources/file-writer-utils.js (modified) (2 diffs)
• LayoutTests/http/tests/local/blob/script-tests/send-hybrid-blob.js (modified) (1 diff)
• LayoutTests/http/tests/local/blob/script-tests/send-sliced-data-blob.js (modified) (1 diff)
• LayoutTests/http/tests/local/fileapi/script-tests/send-sliced-dragged-file.js (modified) (2 diffs)
• LayoutTests/http/tests/local/formdata/resources/send-form-data-common.js (modified) (1 diff)
• LayoutTests/inspector/profiler/heap-snapshot-loader.html (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/bindings/gobject/WebKitDOMCustom.cpp (modified) (2 diffs)
• Source/WebCore/bindings/gobject/WebKitDOMCustom.h (modified) (1 diff)
• Source/WebCore/fileapi/Blob.cpp (modified) (2 diffs)
• Source/WebCore/fileapi/Blob.h (modified) (3 diffs)
• Source/WebCore/fileapi/Blob.idl (modified) (1 diff)
• Source/WebCore/fileapi/File.h (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2012-06-11  Kinuko Yasuda  <kinuko@chromium.org>
+
+        Unprefix Blob.webkitSlice
+        https://bugs.webkit.org/show_bug.cgi?id=78111
+
+        Reviewed by Adam Barth.
+
+        Converted existing tests that are calling Blob.webkitSlice() to call slice().
+
+        * fast/files/blob-slice-overflow.html:
+        * fast/files/blob-slice-test.html:
+        * fast/files/resources/read-blob-test-cases.js:
+        (testReadingSlicedFileBlob):
+        (testReadingSlicedTextBlob):
+        (testReadingSlicedArrayBufferBlob):
+        (testReadingSlicedHybridBlob):
+        (testReadingTripleSlicedHybridBlob):
+        * fast/filesystem/resources/file-writer-utils.js:
+        (verifyByteRangeIsZeroesHelper):
+        * http/tests/local/blob/script-tests/send-hybrid-blob.js:
+        (runHybridBlobTest):
+        * http/tests/local/blob/script-tests/send-sliced-data-blob.js:
+        (runSliceTest):
+        * http/tests/local/fileapi/script-tests/send-sliced-dragged-file.js:
+        (onStableFileDrop):
+        (onUnstableFileDrop):
+        * http/tests/local/formdata/resources/send-form-data-common.js:
+        (testSendingFormData):
+        * inspector/profiler/heap-snapshot-loader.html:
+
 2012-06-12  Csaba Osztrogonác  <ossy@webkit.org>
 

trunk/LayoutTests/fast/files/blob-slice-overflow.html

@@ -15 +15 @@
 
 blob = new Blob([text]);
-slicedBlob = blob.webkitSlice(1999, 9223372036854775000);
+slicedBlob = blob.slice(1999, 9223372036854775000);
 
 document.getElementById('console').appendChild(document.createTextNode('Blob slice length: ' + slicedBlob.size));

trunk/LayoutTests/fast/files/blob-slice-test.html

@@ -47 +47 @@
     if (start == undefined && end == undefined) {
         message += "without parameters";
-        subBlob = blob.webkitSlice();
+        subBlob = blob.slice();
     } else if (end == undefined) {
         message += "from " + start;
-        subBlob = blob.webkitSlice(start);
+        subBlob = blob.slice(start);
     } else {
         message += "from " + start + " to " + end;
-        subBlob = blob.webkitSlice(start, end);
+        subBlob = blob.slice(start, end);
     }
     message += ": ";

trunk/LayoutTests/fast/files/resources/read-blob-test-cases.js

@@ -106 +106 @@
 {
     log("Test reading a blob containing sliced file");
-    var blob = buildBlob([testFiles['file2'].webkitSlice(1, 6)]);
+    var blob = buildBlob([testFiles['file2'].slice(1, 6)]);
     readBlobAsBinaryString(testFiles, blob);
 }
@@ -114 +114 @@
     log("Test reading a blob containing sliced text");
     var blob = buildBlob(['First'])
-    blob = blob.webkitSlice(1, 11);
+    blob = blob.slice(1, 11);
     readBlobAsBinaryString(testFiles, blob);
 }
@@ -123 +123 @@
     var array = new Uint8Array([0, 1, 2, 128, 129, 130, 253, 254, 255]);
     var blob = buildBlob([array])
-    blob = blob.webkitSlice(1, 11);
+    blob = blob.slice(1, 11);
     readBlobAsBinaryString(testFiles, blob);
 }
@@ -164 +164 @@
     var array = new Uint8Array([48, 49, 50]);
     var blob = buildBlob(['First', testFiles['file1'], 'Second', testFiles['file2'], testFiles['file3'], 'Third', array]);
-    var blob = blob.webkitSlice(7, 19);
+    var blob = blob.slice(7, 19);
     readBlobAsBinaryString(testFiles, blob);
 }
@@ -172 +172 @@
     log("Test reading a triple-sliced hybrid blob");
     var array = new Uint8Array([48, 49, 50]);
-    var items = ['First', testFiles['file1'].webkitSlice(1, 11), testFiles['empty-file'], 'Second', testFiles['file2'], testFiles['file3'], 'Third', array];
+    var items = ['First', testFiles['file1'].slice(1, 11), testFiles['empty-file'], 'Second', testFiles['file2'], testFiles['file3'], 'Third', array];
     var blob = buildBlob(items);
-    var blob = blob.webkitSlice(7, 19);
+    var blob = blob.slice(7, 19);
     var blob2 = buildBlob(items.concat(['Foo', blob, 'Bar']));
-    var blob2 = blob2.webkitSlice(12, 42);
+    var blob2 = blob2.slice(12, 42);
     readBlobAsBinaryString(testFiles, blob2);
 }

trunk/LayoutTests/fast/filesystem/resources/file-writer-utils.js

@@ -73 +73 @@
             onSuccess();
         };
-    fileReader.readAsBinaryString(file.webkitSlice(start, start + length));
+    fileReader.readAsBinaryString(file.slice(start, start + length));
 }
 
@@ -92 +92 @@
             onSuccess();
         };
-    fileReader.readAsText(file.webkitSlice(start, start + data.length));
+    fileReader.readAsText(file.slice(start, start + data.length));
 }
 

trunk/LayoutTests/http/tests/local/blob/script-tests/send-hybrid-blob.js

@@ -18 +18 @@
     var urlParameter = util.createUrlParameter(fileIndexOrStrings, opt_range);
     if (opt_range)
-        blob = blob.webkitSlice(opt_range.start, opt_range.start + opt_range.length);
+        blob = blob.slice(opt_range.start, opt_range.start + opt_range.length);
     util.uploadBlob(blob, urlParameter);
 }

trunk/LayoutTests/http/tests/local/blob/script-tests/send-sliced-data-blob.js

@@ -8 +8 @@
     var range = {'start':0, 'length':-1};
     for (var i = 0; i < ranges.length; ++i) {
-        blob = blob.webkitSlice(ranges[i].start, ranges[i].start + ranges[i].length);
+        blob = blob.slice(ranges[i].start, ranges[i].start + ranges[i].length);
         range.start += ranges[i].start;
     }

trunk/LayoutTests/http/tests/local/fileapi/script-tests/send-sliced-dragged-file.js

@@ -57 +57 @@
 {
     // Slice the file.
-    subfile = file.webkitSlice(start, start + length, contentType);
+    subfile = file.slice(start, start + length, contentType);
     shouldEvaluateTo("subfile.size", computeExpectedLength(fileLength, start, length));
     shouldBe("subfile.type", (contentType != undefined && contentType != null) ? '"' + contentType + '"' : '""');
@@ -76 +76 @@
 {
     // Slice the file.
-    subfile = file.webkitSlice(start, start + length, contentType);
+    subfile = file.slice(start, start + length, contentType);
     shouldEvaluateTo("subfile.size", computeExpectedLength(fileLength, start, length));
     shouldBe("subfile.type", (contentType != undefined && contentType != null) ? '"' + contentType + '"' : '""');

trunk/LayoutTests/http/tests/local/formdata/resources/send-form-data-common.js

@@ -71 +71 @@
                     if (dataList[i]['start'] && dataList[i]['length']) {
                         fileSliced = true;
-                        file = file.webkitSlice(dataList[i]['start'], dataList[i]['start'] + dataList[i]['length']);
+                        file = file.slice(dataList[i]['start'], dataList[i]['start'] + dataList[i]['length']);
                     }
                     formDataList.push({'name': dataList[i]['name'], 'value': file, 'filename': dataList[i]['filename']});

trunk/LayoutTests/inspector/profiler/heap-snapshot-loader.html

@@ -90 +90 @@
                 name: "mock.heapsnapshot",
                 size: sourceStringified.length,
-                webkitSlice: function(begin, end) {
-                    return this;
-                }
+                slice: function(begin, end) { return this; },
+                webkitSlice: function(begin, end) { return this; }
             };
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-06-11  Kinuko Yasuda  <kinuko@chromium.org>
+
+        Unprefix Blob.webkitSlice
+        https://bugs.webkit.org/show_bug.cgi?id=78111
+
+        Reviewed by Adam Barth.
+
+        Add unprefixed Blob.slice and start showing a deprecation message when webkitSlice is called.
+
+        No new tests: existing tests that call webkitSlice() are converted to slice(). They should keep running.
+
+        * bindings/gobject/WebKitDOMCustom.cpp:
+        (webkit_dom_blob_slice): Removed.
+        (webkit_dom_blob_webkit_slice): Added.
+        * fileapi/Blob.cpp:
+        (WebCore::Blob::slice):
+        (WebCore):
+        (WebCore::Blob::webkitSlice):
+        (WebCore::Blob::sliceInternal): Added.
+        * fileapi/Blob.h:
+        (WebCore):
+        (Blob):
+        * fileapi/Blob.idl:
+
 2012-06-12  Sheriff Bot  <webkit.review.bot@gmail.com>
 

trunk/Source/WebCore/bindings/gobject/WebKitDOMCustom.cpp

@@ -45 +45 @@
 /* Compatibility */
 WebKitDOMBlob*
-webkit_dom_blob_slice(WebKitDOMBlob* self, gint64 start, gint64 end, const gchar* content_type)
+webkit_dom_blob_webkit_slice(WebKitDOMBlob* self, gint64 start, gint64 end, const gchar* content_type)
 {
-    return webkit_dom_blob_webkit_slice(self, start, end, content_type);
+    return webkit_dom_blob_slice(self, start, end, content_type);
 }
 
@@ -61 +61 @@
     g_warning("The onforminput functionality has been removed from the DOM spec, this function does nothing.");
 }
-
-

trunk/Source/WebCore/bindings/gobject/WebKitDOMCustom.h

@@ -30 +30 @@
 
 /* Compatibility */
-WEBKIT_API WebKitDOMBlob* webkit_dom_blob_slice(WebKitDOMBlob* self, gint64 start, gint64 end, const gchar* content_type);
+WEBKIT_API WebKitDOMBlob* webkit_dom_blob_webkit_slice(WebKitDOMBlob* self, gint64 start, gint64 end, const gchar* content_type);
 WEBKIT_API void webkit_dom_html_form_element_dispatch_form_change(WebKitDOMHTMLFormElement* self);
 WEBKIT_API void webkit_dom_html_form_element_dispatch_form_input(WebKitDOMHTMLFormElement* self);

trunk/Source/WebCore/fileapi/Blob.cpp

@@ -34 +34 @@
 #include "BlobURL.h"
 #include "File.h"
+#include "HistogramSupport.h"
+#include "ScriptExecutionContext.h"
 #include "ThreadableBlobRegistry.h"
 
 namespace WebCore {
+
+namespace {
+
+// Used in histograms to see when we can actually deprecate the prefixed slice.
+enum SliceHistogramEnum {
+    SliceWithoutPrefix,
+    SliceWithPrefix,
+    SliceHistogramEnumMax,
+};
+
+} // namespace
 
 Blob::Blob()
@@ -74 +87 @@
 
 #if ENABLE(BLOB)
-PassRefPtr<Blob> Blob::webkitSlice(long long start, long long end, const String& contentType) const
+PassRefPtr<Blob> Blob::slice(long long start, long long end, const String& contentType) const
+{
+    HistogramSupport::histogramEnumeration("WebCore.Blob.slice", SliceWithoutPrefix, SliceHistogramEnumMax);
+    return sliceInternal(start, end, contentType);
+}
+
+PassRefPtr<Blob> Blob::webkitSlice(ScriptExecutionContext* context, long long start, long long end, const String& contentType) const
+{
+    String message("Blob.webkitSlice() is deprecated. Use Blob.slice() instead .");
+    context->addConsoleMessage(JSMessageSource, LogMessageType, WarningMessageLevel, message);
+
+    HistogramSupport::histogramEnumeration("WebCore.Blob.slice", SliceWithPrefix, SliceHistogramEnumMax);
+    return sliceInternal(start, end, contentType);
+}
+
+PassRefPtr<Blob> Blob::sliceInternal(long long start, long long end, const String& contentType) const
 {
     // When we slice a file for the first time, we obtain a snapshot of the file by capturing its current size and modification time.

trunk/Source/WebCore/fileapi/Blob.h

@@ -42 +42 @@
 namespace WebCore {
 
+class ScriptExecutionContext;
+
 class Blob : public RefCounted<Blob> {
 public:
@@ -69 +71 @@
 
 #if ENABLE(BLOB)
-    PassRefPtr<Blob> webkitSlice(long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const;
+    PassRefPtr<Blob> slice(long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const;
+
+    // Prefixed version is going to be deprecated. This internally calls sliceInternal() (as slice() does) after showing a deprecation message.
+    PassRefPtr<Blob> webkitSlice(ScriptExecutionContext*, long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const;
+
 #endif
 
@@ -78 +84 @@
     // For deserialization.
     Blob(const KURL& srcURL, const String& type, long long size);
+
+#if ENABLE(BLOB)
+    PassRefPtr<Blob> sliceInternal(long long start, long long end, const String& contentType) const;
+#endif
 
     // This is an internal URL referring to the blob data associated with this object. It serves

trunk/Source/WebCore/fileapi/Blob.idl

@@ -43 +43 @@
 #if !defined(LANGUAGE_OBJECTIVE_C)
 #if defined(ENABLE_BLOB) && ENABLE_BLOB
-        Blob webkitSlice(in [Optional] long long start, in [Optional] long long end, in [Optional, TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString contentType);
+        Blob slice(in [Optional] long long start, in [Optional] long long end, in [Optional, TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString contentType);
+#if !defined(LANGUAGE_GOBJECT) || !LANGUAGE_GOBJECT
+        // Prefixed version is going to be deprecated.
+        [CallWith=ScriptExecutionContext] Blob webkitSlice(in [Optional] long long start, in [Optional] long long end, in [Optional, TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString contentType);
+#endif
 #endif
 #endif

trunk/Source/WebCore/fileapi/File.h

@@ -57 +57 @@
     // If filesystem files live in the remote filesystem, the port might pass the valid metadata (whose length field is non-negative) and cache in the File object.
     //
-    // Otherwise calling size(), lastModifiedTime() and webkitSlice() will synchronously query the file metadata.
+    // Otherwise calling size(), lastModifiedTime() and slice() will synchronously query the file metadata.
     static PassRefPtr<File> createForFileSystemFile(const String& name, const FileMetadata& metadata)
     {