databuffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 The ClanLib 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 ClanLib 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 clan
34 {
37 
38  class DataBuffer_Impl;
39 
41  class DataBuffer
42  {
43  public:
45  DataBuffer();
46  DataBuffer(unsigned int size);
47  DataBuffer(const void *data, unsigned int size);
48  DataBuffer(const DataBuffer &data, unsigned int pos, unsigned int size);
49  ~DataBuffer();
50 
52  char *get_data();
53 
54  const char *get_data() const;
55 
56  template<typename Type>
57  Type *get_data() { return reinterpret_cast<Type*>(get_data()); }
58 
59  template<typename Type>
60  const Type *get_data() const { return reinterpret_cast<const Type*>(get_data()); }
61 
63  unsigned int get_size() const;
64 
66  unsigned int get_capacity() const;
67 
69  char &operator[](int i);
70  const char &operator[](int i) const;
71  char &operator[](unsigned int i);
72  const char &operator[](unsigned int i) const;
73 
75  bool is_null() const;
76 
77  DataBuffer &operator =(const DataBuffer &copy);
78 
80  void set_size(unsigned int size);
81 
83  void set_capacity(unsigned int capacity);
84 
85  private:
86  std::shared_ptr<DataBuffer_Impl> impl;
87  };
88 
90 }
DataBuffer & operator=(const DataBuffer &copy)
Definition: clanapp.h:35
bool is_null() const
Returns true if the buffer is 0 in size.
unsigned int get_capacity() const
Returns the capacity of the data buffer object.
char & operator[](int i)
Returns a char in the buffer.
const Type * get_data() const
Definition: databuffer.h:60
void set_size(unsigned int size)
Resize the buffer.
unsigned int get_size() const
Returns the size of the data.
void set_capacity(unsigned int capacity)
Preallocate enough memory.
DataBuffer()
Constructs a data buffer of 0 size.
char * get_data()
Returns a pointer to the data.
Type * get_data()
Definition: databuffer.h:57
General purpose data buffer.
Definition: databuffer.h:41