root/Source/wtf/Uint8Array.h

INCLUDED FROM

/*
 * Copyright (C) 2009 Apple Inc. All rights reserved.
 * Copyright (C) 2009 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:
 * 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
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``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 APPLE COMPUTER, INC. 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 Uint8Array_h
#define Uint8Array_h

#include "wtf/IntegralTypedArrayBase.h"

namespace WTF {

class ArrayBuffer;

class Uint8Array : public IntegralTypedArrayBase<unsigned char> {
public:
    static inline PassRefPtr<Uint8Array> create(unsigned length);
    static inline PassRefPtr<Uint8Array> create(const unsigned char* array, unsigned length);
    static inline PassRefPtr<Uint8Array> create(PassRefPtr<ArrayBuffer>, unsigned byteOffset, unsigned length);

    // Should only be used when it is known the entire array will be filled. Do
    // not return these results directly to JavaScript without filling first.
    static inline PassRefPtr<Uint8Array> createUninitialized(unsigned length);

    using TypedArrayBase<unsigned char>::set;
    using IntegralTypedArrayBase<unsigned char>::set;

    inline PassRefPtr<Uint8Array> subarray(int start) const;
    inline PassRefPtr<Uint8Array> subarray(int start, int end) const;

    virtual ViewType type() const OVERRIDE
    {
        return TypeUint8;
    }

protected:
    inline Uint8Array(PassRefPtr<ArrayBuffer>,
                           unsigned byteOffset,
                           unsigned length);
    // Make constructor visible to superclass.
    friend class TypedArrayBase<unsigned char>;
};

PassRefPtr<Uint8Array> Uint8Array::create(unsigned length)
{
    return TypedArrayBase<unsigned char>::create<Uint8Array>(length);
}

PassRefPtr<Uint8Array> Uint8Array::create(const unsigned char* array, unsigned length)
{
    return TypedArrayBase<unsigned char>::create<Uint8Array>(array, length);
}

PassRefPtr<Uint8Array> Uint8Array::create(PassRefPtr<ArrayBuffer> buffer, unsigned byteOffset, unsigned length)
{
    return TypedArrayBase<unsigned char>::create<Uint8Array>(buffer, byteOffset, length);
}

PassRefPtr<Uint8Array> Uint8Array::createUninitialized(unsigned length)
{
    return TypedArrayBase<unsigned char>::createUninitialized<Uint8Array>(length);
}

Uint8Array::Uint8Array(PassRefPtr<ArrayBuffer> buffer, unsigned byteOffset, unsigned length)
: IntegralTypedArrayBase<unsigned char>(buffer, byteOffset, length)
{
}

PassRefPtr<Uint8Array> Uint8Array::subarray(int start) const
{
    return subarray(start, length());
}

PassRefPtr<Uint8Array> Uint8Array::subarray(int start, int end) const
{
    return subarrayImpl<Uint8Array>(start, end);
}

} // namespace WTF

using WTF::Uint8Array;

#endif // Uint8Array_h