summaryrefslogtreecommitdiff
path: root/src/html/html_select_element.c
blob: 6a05eddcfc81c4a150b7955bf1c313a236efc052 (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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
/*
 * This file is part of libdom.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2009 Bo Yang <struggleyb.nku@gmail.com>
 */

#include <assert.h>
#include <stdlib.h>

#include "html/html_document.h"
#include "html/html_select_element.h"

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

static struct dom_element_protected_vtable _protect_vtable = {
	{
		DOM_NODE_PROTECT_VTABLE_HTML_SELECT_ELEMENT
	},
	DOM_HTML_SELECT_ELEMENT_PROTECT_VTABLE
};

static bool is_option(struct dom_node_internal *node);

/**
 * Create a dom_html_select_element object
 *
 * \param doc  The document object
 * \param ele  The returned element object
 * \return DOM_NO_ERR on success, appropriate dom_exception on failure.
 */
dom_exception _dom_html_select_element_create(struct dom_html_document *doc,
		struct dom_html_select_element **ele)
{
	struct dom_node_internal *node;

	*ele = malloc(sizeof(dom_html_select_element));
	if (*ele == NULL)
		return DOM_NO_MEM_ERR;
	
	/* Set up vtables */
	node = (struct dom_node_internal *) *ele;
	node->base.vtable = &_dom_element_vtable;
	node->vtable = &_protect_vtable;

	return _dom_html_select_element_initialise(doc, *ele);
}

/**
 * Initialise a dom_html_select_element object
 *
 * \param doc  The document object
 * \param ele  The dom_html_select_element object
 * \return DOM_NO_ERR on success, appropriate dom_exception on failure.
 */
dom_exception _dom_html_select_element_initialise(struct dom_html_document *doc,
		struct dom_html_select_element *ele)
{
	dom_string *name = NULL;
	dom_exception err;

	err = dom_string_create((const uint8_t *) "SELECT", SLEN("SELECT"),
			&name);
	if (err != DOM_NO_ERR)
		return err;
	
	err = _dom_html_element_initialise(doc, &ele->base, name, NULL, NULL);
	dom_string_unref(name);

	ele->selected = -1;
	ele->options = NULL;

	return err;
}

/**
 * Finalise a dom_html_select_element object
 *
 * \param ele  The dom_html_select_element object
 */
void _dom_html_select_element_finalise(struct dom_html_select_element *ele)
{
	_dom_html_element_finalise(&ele->base);
}

/**
 * Destroy a dom_html_select_element object
 *
 * \param ele  The dom_html_select_element object
 */
void _dom_html_select_element_destroy(struct dom_html_select_element *ele)
{
	_dom_html_select_element_finalise(ele);
	free(ele);
}

/*------------------------------------------------------------------------*/
/* The protected virtual functions */

/* The virtual function used to parse attribute value, see src/core/element.c
 * for detail */
dom_exception _dom_html_select_element_parse_attribute(dom_element *ele,
		dom_string *name, dom_string *value,
		dom_string **parsed)
{
	UNUSED(ele);
	UNUSED(name);

	dom_string_ref(value);
	*parsed = value;

	return DOM_NO_ERR;
}

/* The virtual destroy function, see src/core/node.c for detail */
void _dom_virtual_html_select_element_destroy(dom_node_internal *node)
{
	_dom_html_select_element_destroy((struct dom_html_select_element *) node);
}

/* The virtual copy function, see src/core/node.c for detail */
dom_exception _dom_html_select_element_copy(dom_node_internal *old,
		dom_node_internal **copy)
{
	return _dom_html_element_copy(old, copy);
}

/*-----------------------------------------------------------------------*/
/* Public APIs */

/**
 * Get the ordinal index of the selected option
 *
 * \param ele    The element object
 * \param index  The returned index
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_get_selected_index(
		dom_html_select_element *ele, unsigned long *index)
{
	*index = ele->selected;

	return DOM_NO_ERR;
}

/**
 * Set the ordinal index of the selected option
 *
 * \param ele    The element object
 * \param index  The new index
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_set_selected_index(
		dom_html_select_element *ele, unsigned long index)
{
	ele->selected = index;

	return DOM_NO_ERR;
}

/**
 * Get the number of options in this select element
 *
 * \param ele  The element object
 * \param len  The returned len
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_get_length(
		dom_html_select_element *ele, unsigned long *len)
{
	dom_exception err;
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);
	assert(doc != NULL);

	if (ele->options == NULL) {
		err = _dom_html_options_collection_create(doc,
				(dom_node_internal *) ele,
				is_option, &ele->options);
		if (err != DOM_NO_ERR)
			return err;
	}

	return dom_html_options_collection_get_length(ele->options, len);
}

/**
 * Set the number of options in this select element
 *
 * \param ele  The element object
 * \param len  The new len
 * \return DOM_NOT_SUPPORTED_ERR.
 *
 * todo: how to deal with set the len of the children option objects?
 */
dom_exception dom_html_select_element_set_length(
		dom_html_select_element *ele, unsigned long len)
{
	UNUSED(ele);
	UNUSED(len);

	return DOM_NOT_SUPPORTED_ERR;
}

/**
 * The collection of OPTION elements of this element
 *
 * \param ele  The element object
 * \param col  THe returned collection object
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_get_options(
		dom_html_select_element *ele,
		struct dom_html_options_collection **col)
{
	dom_exception err;
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);
	assert(doc != NULL);

	if (ele->options == NULL) {
		err = _dom_html_options_collection_create(doc,
				(dom_node_internal *) ele,
				is_option, &ele->options);
		if (err != DOM_NO_ERR)
			return err;

		*col = ele->options;
		return DOM_NO_ERR;
	}

	dom_html_options_collection_ref(ele->options);
	*col = ele->options;

	return DOM_NO_ERR;
}

/**
 * Whether this element is disabled
 *
 * \param ele       The element object
 * \param disabled  The returned status
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_get_disabled(
		dom_html_select_element *ele, bool *disabled)
{
	return dom_html_element_get_bool_property(&ele->base,
			"disabled", SLEN("disabled"), disabled);
}

/**
 * Set the disabled status of this element
 *
 * \param ele       The element object
 * \param disabled  The disabled status
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_set_disabled(
		dom_html_select_element *ele, bool disabled)
{
	return dom_html_element_set_bool_property(&ele->base,
			"disabled", SLEN("disabled"), disabled);
}

/**
 * Whether this element can be multiple selected
 *
 * \param ele       The element object
 * \param multiple  The returned status
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_get_multiple(
		dom_html_select_element *ele, bool *multiple)
{
	return dom_html_element_get_bool_property(&ele->base,
			"multiple", SLEN("multiple"), multiple);
}

/**
 * Set whether this element can be multiple selected
 *
 * \param ele       The element object
 * \param multiple  The status
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_select_element_set_multiple(
		dom_html_select_element *ele, bool multiple)
{
	return dom_html_element_set_bool_property(&ele->base,
			"multiple", SLEN("multiple"), multiple);
}

dom_exception dom_html_select_element_get_size(
		dom_html_select_element *ele, unsigned long *size);
dom_exception dom_html_select_element_set_size(
		dom_html_select_element *ele, unsigned long size);
dom_exception dom_html_select_element_get_tab_index(
		dom_html_select_element *ele, unsigned long *tab_index);
dom_exception dom_html_select_element_set_tab_index(
		dom_html_select_element *ele, unsigned long tab_index);

/* Functions */
dom_exception dom_html_select_element_add(struct dom_html_element *ele,
		struct dom_html_element *before);
dom_exception dom_html_element_blur(struct dom_html_select_element *ele);
dom_exception dom_html_element_focus(struct dom_html_select_element *ele);


/*-----------------------------------------------------------------------*/
/* Helper functions */

/* Test whether certain node is an option node */
bool is_option(struct dom_node_internal *node)
{
	dom_string *name = NULL;
	bool ret = false;
	dom_exception err;

	err = dom_string_create((const uint8_t *) "OPTION", SLEN("OPTION"),
			&name);
	if (err != DOM_NO_ERR)
		return false;

	if (dom_string_isequal(name, node->name))
		ret = true;
	
	dom_string_unref(name);

	return ret;
}