2010-09-09 Chris Rogers <crogers@google.com>
[WebKit-https.git] / WebCore / html / canvas / TypedArrayBase.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Copyright (c) 2010, 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 TypedArrayBase_h
28 #define TypedArrayBase_h
29
30 #include "ArrayBuffer.h"
31 #include "ArrayBufferView.h"
32
33 namespace WebCore {
34
35 template <typename T>
36 class TypedArrayBase : public ArrayBufferView {
37   public:
38     T* data() const { return static_cast<T*>(baseAddress()); }
39
40     void set(TypedArrayBase<T>* array, unsigned offset, ExceptionCode& ec)
41     {
42         setImpl(array, offset * sizeof(T), ec);
43     }
44
45     void setRange(const T* data, size_t dataLength, unsigned offset, ExceptionCode& ec)
46     {
47         setRangeImpl(reinterpret_cast<const char*>(data), dataLength * sizeof(T), offset * sizeof(T), ec);
48     }
49
50     void zeroRange(unsigned offset, size_t length, ExceptionCode& ec)
51     {
52         zeroRangeImpl(offset * sizeof(T), length * sizeof(T), ec);
53     }
54
55     // Overridden from ArrayBufferView. This must be public because of
56     // rules about inheritance of members in template classes, and
57     // because it is accessed via pointers to subclasses.
58     virtual unsigned length() const
59     {
60         return m_length;
61     }
62
63   protected:
64     TypedArrayBase(PassRefPtr<ArrayBuffer> buffer, unsigned byteOffset, unsigned length)
65         : ArrayBufferView(buffer, byteOffset)
66         , m_length(length)
67     {
68     }
69
70     template <class Subclass>
71     static PassRefPtr<Subclass> create(unsigned length)
72     {
73         RefPtr<ArrayBuffer> buffer = ArrayBuffer::create(length, sizeof(T));
74         if (!buffer.get())
75             return 0;
76         return create<Subclass>(buffer, 0, length);
77     }
78
79     template <class Subclass>
80     static PassRefPtr<Subclass> create(const T* array, unsigned length)
81     {
82         RefPtr<Subclass> a = create<Subclass>(length);
83         if (a)
84             for (unsigned i = 0; i < length; ++i)
85                 a->set(i, array[i]);
86         return a;
87     }
88
89     template <class Subclass>
90     static PassRefPtr<Subclass> create(PassRefPtr<ArrayBuffer> buffer,
91                                        unsigned byteOffset,
92                                        unsigned length)
93     {
94         RefPtr<ArrayBuffer> buf(buffer);
95         if (!verifySubRange<T>(buf, byteOffset, length))
96             return 0;
97
98         return adoptRef(new Subclass(buf, byteOffset, length));
99     }
100
101     template <class Subclass>
102     PassRefPtr<Subclass> sliceImpl(int start, int end) const
103     {
104         unsigned offset, length;
105         calculateOffsetAndLength(start, end, m_length, &offset, &length);
106         clampOffsetAndNumElements<T>(buffer(), m_byteOffset, &offset, &length);
107         return create<Subclass>(buffer(), offset, length);
108     }
109
110     // We do not want to have to access this via a virtual function in subclasses,
111     // which is why it is protected rather than private.
112     unsigned m_length;
113
114   private:
115     // Overridden from ArrayBufferView.
116     virtual unsigned byteLength() const
117     {
118         return m_length * sizeof(T);
119     }
120 };
121
122 } // namespace WebCore
123
124 #endif // TypedArrayBase_h