Home | History | Annotate | Download | only in wtf
      1 /*
      2  * Copyright (C) 2009 Apple Inc. All rights reserved.
      3  * Copyright (C) 2013 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 ArrayBufferContents_h
     28 #define ArrayBufferContents_h
     29 
     30 #include "wtf/ArrayBufferDeallocationObserver.h"
     31 #include "wtf/Noncopyable.h"
     32 #include "wtf/PartitionAlloc.h"
     33 #include "wtf/WTFExport.h"
     34 
     35 namespace WTF {
     36 
     37 class WTF_EXPORT ArrayBufferContents {
     38     WTF_MAKE_NONCOPYABLE(ArrayBufferContents);
     39 public:
     40     enum InitializationPolicy {
     41         ZeroInitialize,
     42         DontInitialize
     43     };
     44 
     45     ArrayBufferContents();
     46     ArrayBufferContents(unsigned numElements, unsigned elementByteSize, ArrayBufferContents::InitializationPolicy);
     47 
     48     // Use with care. data must be allocated with allocateMemory.
     49     // ArrayBufferContents will take ownership of the data and free it (using freeMemorY)
     50     // upon destruction.
     51     ArrayBufferContents(void* data, unsigned sizeInBytes);
     52 
     53     ~ArrayBufferContents();
     54 
     55     void clear();
     56 
     57     void* data() const { return m_data; }
     58     unsigned sizeInBytes() const { return m_sizeInBytes; }
     59 
     60     bool hasDeallocationObserver() const { return !!m_deallocationObserver; }
     61     void setDeallocationObserver(ArrayBufferDeallocationObserver* observer) { m_deallocationObserver = observer; }
     62 
     63     void transfer(ArrayBufferContents& other);
     64     void copyTo(ArrayBufferContents& other);
     65 
     66     static void allocateMemory(size_t, InitializationPolicy, void*&);
     67     static void freeMemory(void*, size_t);
     68 
     69 private:
     70     void* m_data;
     71     unsigned m_sizeInBytes;
     72     ArrayBufferDeallocationObserver* m_deallocationObserver;
     73 };
     74 
     75 } // namespace WTF
     76 
     77 #endif // ArrayBufferContents_h
     78