databuffer.h
1 /*
2 ** UICore
3 ** Copyright (c) 1997-2015 The UICore Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries UICore may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 #pragma once
30 
31 #include <memory>
32 
33 namespace uicore
34 {
36  class DataBuffer
37  {
38  public:
40  static std::shared_ptr<DataBuffer> create(size_t size);
41  static std::shared_ptr<DataBuffer> create(const void *data, size_t size);
42 
44  virtual char *data() = 0;
45  virtual const char *data() const = 0;
46 
47  template<typename Type> Type *data() { return reinterpret_cast<Type*>(data()); }
48  template<typename Type> const Type *data() const { return reinterpret_cast<const Type*>(data()); }
49 
51  virtual size_t size() const = 0;
52 
54  virtual size_t capacity() const = 0;
55 
57  virtual void set_size(size_t size) = 0;
58 
60  virtual void set_capacity(size_t capacity) = 0;
61 
63  virtual std::shared_ptr<DataBuffer> copy(size_t pos, size_t size) = 0;
64  };
65 
66  typedef std::shared_ptr<DataBuffer> DataBufferPtr;
67 }
General purpose data buffer.
Definition: databuffer.h:36
static std::shared_ptr< DataBuffer > create(size_t size)
Constructs a data buffer.
virtual char * data()=0
Returns a pointer to the data.
Type * data()
Definition: databuffer.h:47
virtual void set_capacity(size_t capacity)=0
Preallocate enough memory.
virtual size_t size() const =0
Returns the size of the data.
std::shared_ptr< DataBuffer > DataBufferPtr
Definition: databuffer.h:66
virtual void set_size(size_t size)=0
Resize the buffer.
const Type * data() const
Definition: databuffer.h:48
Definition: Application/application.h:35
virtual size_t capacity() const =0
Returns the capacity of the data buffer object.
virtual std::shared_ptr< DataBuffer > copy(size_t pos, size_t size)=0
Copy buffer to a new buffer.