Objectively
Ultra-lightweight object oriented framework for GNU C.
Loading...
Searching...
No Matches
Data.h
Go to the documentation of this file.
1/*
2 * Objectively: Ultra-lightweight object oriented framework for GNU C.
3 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
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 *
18 * 2. Altered source versions must be plainly marked as such, and must not be
19 * misrepresented as being the original software.
20 *
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24#pragma once
25
26#include <Objectively/Object.h>
27
37typedef struct Data Data;
38typedef struct DataInterface DataInterface;
39
43typedef void (*DataDestructor)(ident mem);
44
50struct Data {
51
56
61 DataInterface *interface;
62
66 uint8_t *bytes;
67
72
76 size_t length;
77
82 size_t capacity;
83};
84
85
89struct DataInterface {
90
94 ObjectInterface objectInterface;
95
107 void (*appendBytes)(Data *self, const uint8_t *bytes, size_t length);
108
116 void (*appendData)(Data *self, const Data *data);
117
125 Data *(*data)(void);
126
136 Data *(*dataWithBytes)(const uint8_t *bytes, size_t length);
137
146 Data *(*dataWithCapacity)(size_t capacity);
147
157 Data *(*dataWithConstMemory)(const ident mem, size_t length);
158
167 Data *(*dataWithContentsOfFile)(const char *path);
168
178 Data *(*dataWithMemory)(ident mem, size_t length);
179
187 Data *(*init)(Data *self);
188
198 Data *(*initWithBytes)(Data *self, const uint8_t *bytes, size_t length);
199
208 Data *(*initWithCapacity)(Data *self, size_t capacity);
209
219 Data *(*initWithConstMemory)(Data *self, const ident mem, size_t length);
220
229 Data *(*initWithContentsOfFile)(Data *self, const char *path);
230
239 Data *(*initWithData)(Data *self, const Data *data);
240
250 Data *(*initWithMemory)(Data *self, ident mem, size_t length);
251
261 void (*setLength)(Data *self, size_t length);
262
271 bool (*writeToFile)(const Data *self, const char *path);
272
273};
274
OBJECTIVELY_EXPORT Class * _Data(void)
Definition Data.c:419
void(* DataDestructor)(ident mem)
Data may optionally reference destructor to be called on dealloc.
Definition Data.h:43
Object is the root Class of The Objectively Class hierarchy.
void * ident
The identity type, similar to Objective-C id.
Definition Types.h:49
#define OBJECTIVELY_EXPORT
Definition Types.h:36
The runtime representation of a Class.
Definition Class.h:95
Data buffers.
Definition Data.h:50
DataInterface * interface
The interface.
Definition Data.h:61
DataDestructor destroy
An optional destructor that, if set, is called on dealloc.
Definition Data.h:71
Object object
The superclass.
Definition Data.h:55
size_t length
The length of bytes.
Definition Data.h:76
uint8_t * bytes
The bytes.
Definition Data.h:66
Object is the root Class of The Objectively Class hierarchy.
Definition Object.h:46