Source/WTF/wtf/Uint8Array.h

   1 /*
   2  * Copyright (C) 2009 Apple Inc. All rights reserved.
   3  * Copyright (C) 2009 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef Uint8Array_h
  28 #define Uint8Array_h
  29
  30 #include <wtf/IntegralTypedArrayBase.h>
  31
  32 namespace WTF {
  33
  34 class ArrayBuffer;
  35
  36 class Uint8Array : public IntegralTypedArrayBase<unsigned char> {
  37 public:
  38     static inline PassRefPtr<Uint8Array> create(unsigned length);
  39     static inline PassRefPtr<Uint8Array> create(const unsigned char* array, unsigned length);
  40     static inline PassRefPtr<Uint8Array> create(PassRefPtr<ArrayBuffer>, unsigned byteOffset, unsigned length);
  41
  42     // Should only be used when it is known the entire array will be filled. Do
  43     // not return these results directly to JavaScript without filling first.
  44     static inline PassRefPtr<Uint8Array> createUninitialized(unsigned length);
  45
  46     // Can’t use "using" here due to a bug in the RVCT compiler.
  47     bool set(TypedArrayBase<unsigned char>* array, unsigned offset) { return TypedArrayBase<unsigned char>::set(array, offset); }
  48     void set(unsigned index, double value) { IntegralTypedArrayBase<unsigned char>::set(index, value); }
  49
  50     inline PassRefPtr<Uint8Array> subarray(int start) const;
  51     inline PassRefPtr<Uint8Array> subarray(int start, int end) const;
  52
  53     virtual ViewType getType() const
  54     {
  55         return TypeUint8;
  56     }
  57
  58 protected:
  59     inline Uint8Array(PassRefPtr<ArrayBuffer>,
  60                            unsigned byteOffset,
  61                            unsigned length);
  62     // Make constructor visible to superclass.
  63     friend class TypedArrayBase<unsigned char>;
  64 };
  65
  66 PassRefPtr<Uint8Array> Uint8Array::create(unsigned length)
  67 {
  68     return TypedArrayBase<unsigned char>::create<Uint8Array>(length);
  69 }
  70
  71 PassRefPtr<Uint8Array> Uint8Array::create(const unsigned char* array, unsigned length)
  72 {
  73     return TypedArrayBase<unsigned char>::create<Uint8Array>(array, length);
  74 }
  75
  76 PassRefPtr<Uint8Array> Uint8Array::create(PassRefPtr<ArrayBuffer> buffer, unsigned byteOffset, unsigned length)
  77 {
  78     return TypedArrayBase<unsigned char>::create<Uint8Array>(buffer, byteOffset, length);
  79 }
  80
  81 PassRefPtr<Uint8Array> Uint8Array::createUninitialized(unsigned length)
  82 {
  83     return TypedArrayBase<unsigned char>::createUninitialized<Uint8Array>(length);
  84 }
  85
  86 Uint8Array::Uint8Array(PassRefPtr<ArrayBuffer> buffer, unsigned byteOffset, unsigned length)
  87 : IntegralTypedArrayBase<unsigned char>(buffer, byteOffset, length)
  88 {
  89 }
  90
  91 PassRefPtr<Uint8Array> Uint8Array::subarray(int start) const
  92 {
  93     return subarray(start, length());
  94 }
  95
  96 PassRefPtr<Uint8Array> Uint8Array::subarray(int start, int end) const
  97 {
  98     return subarrayImpl<Uint8Array>(start, end);
  99 }
 100
 101 } // namespace WTF
 102
 103 using WTF::Uint8Array;
 104
 105 #endif // Uint8Array_h