third_party/WebKit/Source/core/fileapi/Blob.h

/*
 * Copyright (C) 2010 Google 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.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef Blob_h
#define Blob_h

#include "bindings/core/v8/ArrayBufferOrArrayBufferViewOrBlobOrUSVString.h"
#include "bindings/core/v8/ScriptWrappable.h"
#include "core/CoreExport.h"
#include "core/dom/DOMArrayBuffer.h"
#include "core/dom/DOMArrayBufferView.h"
#include "core/html/URLRegistry.h"
#include "core/imagebitmap/ImageBitmapSource.h"
#include "platform/blob/BlobData.h"
#include "platform/heap/Handle.h"
#include "wtf/PassRefPtr.h"
#include "wtf/text/WTFString.h"

namespace blink {

class BlobPropertyBag;
class ExceptionState;
class ExecutionContext;
class ScriptState;

class CORE_EXPORT Blob : public GarbageCollectedFinalized<Blob>,
                         public ScriptWrappable,
                         public URLRegistrable,
                         public ImageBitmapSource {
  DEFINE_WRAPPERTYPEINFO();

 public:
  static Blob* create(ExecutionContext*, ExceptionState&) {
    return new Blob(BlobDataHandle::create());
  }

  static Blob* create(
      ExecutionContext*,
      const HeapVector<ArrayBufferOrArrayBufferViewOrBlobOrUSVString>&,
      const BlobPropertyBag&,
      ExceptionState&);

  static Blob* create(PassRefPtr<BlobDataHandle> blobDataHandle) {
    return new Blob(std::move(blobDataHandle));
  }

  static Blob* create(const unsigned char* data,
                      size_t bytes,
                      const String& contentType);

  ~Blob() override;

  virtual unsigned long long size() const { return m_blobDataHandle->size(); }
  virtual Blob* slice(long long start,
                      long long end,
                      const String& contentType,
                      ExceptionState&) const;

  // To allow ExceptionState to be passed in last, manually enumerate the
  // optional argument overloads.
  Blob* slice(ExceptionState& exceptionState) const {
    return slice(0, std::numeric_limits<long long>::max(), String(),
                 exceptionState);
  }
  Blob* slice(long long start, ExceptionState& exceptionState) const {
    return slice(start, std::numeric_limits<long long>::max(), String(),
                 exceptionState);
  }
  Blob* slice(long long start,
              long long end,
              ExceptionState& exceptionState) const {
    return slice(start, end, String(), exceptionState);
  }

  virtual void close(ScriptState*, ExceptionState&);

  String type() const { return m_blobDataHandle->type(); }
  String uuid() const { return m_blobDataHandle->uuid(); }
  PassRefPtr<BlobDataHandle> blobDataHandle() const { return m_blobDataHandle; }
  // True for all File instances, including the user-built ones.
  virtual bool isFile() const { return false; }
  // Only true for File instances that are backed by platform files.
  virtual bool hasBackingFile() const { return false; }
  bool isClosed() const { return m_isClosed; }

  // Used by the JavaScript Blob and File constructors.
  virtual void appendTo(BlobData&) const;

  // URLRegistrable to support PublicURLs.
  URLRegistry& registry() const final;

  // ImageBitmapSource implementation
  bool isBlob() const override { return true; }

  DEFINE_INLINE_TRACE() {}

 protected:
  explicit Blob(PassRefPtr<BlobDataHandle>);

  static void populateBlobData(
      BlobData*,
      const HeapVector<ArrayBufferOrArrayBufferViewOrBlobOrUSVString>& parts,
      bool normalizeLineEndingsToNative);
  static void clampSliceOffsets(long long size,
                                long long& start,
                                long long& end);

  // Called by the Blob and File constructors when processing the 'type'
  // option per the FileAPI standard. Returns "" if |type| contains any
  // character outside U+0020...U+007E, or |type| ASCII-lowercased otherwise.
  static String normalizeType(const String& type);

 private:
  Blob();

  RefPtr<BlobDataHandle> m_blobDataHandle;
  bool m_isClosed;
};

}  // namespace blink

#endif  // Blob_h