summaryrefslogtreecommitdiff
path: root/src/core/string.c
blob: 070af75859f12137f613e9d342a05b925a9bd85d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
 * This file is part of libdom.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2007 John-Mark Bell <jmb@netsurf-browser.org>
 */

#include <inttypes.h>
#include <string.h>

#include <dom/ctx.h>
#include <dom/core/string.h>

#include "core/document.h"
#include "utils/utils.h"

/**
 * A DOM string
 *
 * DOM strings store either a pointer to allocated data, a pointer
 * to constant data or an offset into a document buffer.
 *
 * They are reference counted so freeing is performed correctly.
 */
struct dom_string {
	enum { DOM_STRING_PTR,
	       DOM_STRING_CONST_PTR,
	       DOM_STRING_OFFSET
	} type;
	union {
		uint8_t *ptr;
		const uint8_t *cptr;
		struct {
			struct dom_document *doc;
			uint32_t off;
		} offset;
	} data;

	size_t len;

	uint32_t refcnt;
};

/**
 * Claim a reference on a DOM string
 *
 * \param ctx  The context in which the string resides
 * \param str  The string to claim a reference on
 */
void dom_string_ref(struct dom_ctx *ctx, struct dom_string *str)
{
	UNUSED(ctx);

	str->refcnt++;
}

/**
 * Release a reference on a DOM string
 *
 * \param ctx  The context in which the string resides
 * \param str  The string to release the reference from
 *
 * If the reference count reaches zero, any memory claimed by the
 * string will be released
 */
void dom_string_unref(struct dom_ctx *ctx, struct dom_string *str)
{
	if (--str->refcnt == 0) {
		if (str->type == DOM_STRING_PTR)
			ctx->alloc(str->data.ptr, 0, ctx->pw);

		ctx->alloc(str, 0, ctx->pw);
	}
}

/**
 * Create a DOM string from an offset into the document buffer
 *
 * \param ctx  The context in which the string resides
 * \param doc  The document in which the string resides
 * \param off  Offset from start of document buffer
 * \param len  Length, in bytes, of string
 * \param str  Pointer to location to receive pointer to new string
 * \return DOM_NO_ERR on success, DOM_NO_MEM_ERR on memory exhaustion
 *
 * The returned string will already be referenced, so there is no need
 * to explicitly reference it.
 */
dom_exception dom_string_create_from_off(struct dom_ctx *ctx,
		struct dom_document *doc, uint32_t off, size_t len,
		struct dom_string **str)
{
	struct dom_string *ret;

	ret = ctx->alloc(NULL, sizeof(struct dom_string), ctx->pw);
	if (ret == NULL)
		return DOM_NO_MEM_ERR;

	ret->type = DOM_STRING_OFFSET;
	ret->data.offset.doc = doc;
	ret->data.offset.off = off;
	ret->len = len;

	ret->refcnt = 1;

	*str = ret;

	return DOM_NO_ERR;
}

/**
 * Create a DOM string from a string of characters
 *
 * \param ctx  The context in which the string resides
 * \param ptr  Pointer to string of characters
 * \param len  Length, in bytes, of string of characters
 * \param str  Pointer to location to receive pointer to new string
 * \return DOM_NO_ERR on success, DOM_NO_MEM_ERR on memory exhaustion
 *
 * The returned string will already be referenced, so there is no need
 * to explicitly reference it.
 *
 * The string of characters passed in will be copied for use by the
 * returned DOM string.
 */
dom_exception dom_string_create_from_ptr(struct dom_ctx *ctx,
		const uint8_t *ptr, size_t len, struct dom_string **str)
{
	struct dom_string *ret;

	ret = ctx->alloc(NULL, sizeof(struct dom_string), ctx->pw);
	if (ret == NULL)
		return DOM_NO_MEM_ERR;

	ret->data.ptr = ctx->alloc(NULL, len, ctx->pw);
	if (ret->data.ptr == NULL) {
		ctx->alloc(ret, 0, ctx->pw);
		return DOM_NO_MEM_ERR;
	}

	ret->type = DOM_STRING_PTR;

	memcpy(ret->data.ptr, ptr, len);

	ret->len = len;

	ret->refcnt = 1;

	*str = ret;

	return DOM_NO_ERR;
}

/**
 * Create a DOM string from a constant string of characters
 *
 * \param ctx  The context in which the string resides
 * \param ptr  Pointer to string of characters
 * \param len  Length, in bytes, of string of characters
 * \param str  Pointer to location to receive pointer to new string
 * \return DOM_NO_ERR on success, DOM_NO_MEM_ERR on memory exhaustion
 *
 * The returned string will already be referenced, so there is no need
 * to explicitly reference it.
 *
 * The string of characters passed in will _not_ be copied for use by the
 * returned DOM string.
 */
dom_exception dom_string_create_from_const_ptr(struct dom_ctx *ctx,
		const uint8_t *ptr, size_t len, struct dom_string **str)
{
	struct dom_string *ret;

	ret = ctx->alloc(NULL, sizeof(struct dom_string), ctx->pw);
	if (ret == NULL)
		return DOM_NO_MEM_ERR;

	ret->data.cptr = ptr;

	ret->type = DOM_STRING_CONST_PTR;

	ret->len = len;

	ret->refcnt = 1;

	*str = ret;

	return DOM_NO_ERR;
}

/**
 * Get a pointer to the string of characters within a DOM string
 *
 * \param ctx   The context in which the string resides
 * \param str   Pointer to DOM string to retrieve pointer from
 * \param data  Pointer to location to receive data
 * \param len   Pointer to location to receive byte length of data
 * \return DOM_NO_ERR on success
 *
 * The caller must have previously claimed a reference on the DOM string.
 * The returned pointer must not be freed.
 */
dom_exception dom_string_get_data(struct dom_ctx *ctx,
		struct dom_string *str, const uint8_t **data, size_t *len)
{
	switch (str->type) {
	case DOM_STRING_PTR:
		*data = str->data.ptr;
		break;
	case DOM_STRING_CONST_PTR:
		*data = str->data.cptr;
		break;
	case DOM_STRING_OFFSET:
		*data = dom_document_get_base(ctx, str->data.offset.doc) +
				str->data.offset.off;
		break;
	}

	*len = str->len;

	return DOM_NO_ERR;
}