summaryrefslogtreecommitdiff
path: root/src/html/html_select_element.c
blob: 7a5e84e70c5ec5fb35be5bc70f67049a6711bd21 (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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
/*
 * 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 <dom/html/html_option_element.h>
#include <dom/html/html_options_collection.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, void *ctx);

/**
 * 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,
		dom_string *namespace, dom_string *prefix,
		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_html_element_vtable;
	node->vtable = &_protect_vtable;

	return _dom_html_select_element_initialise(doc, namespace, prefix, *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,
		dom_string *namespace, dom_string *prefix,
		struct dom_html_select_element *ele)
{
	ele->form = NULL;

	return _dom_html_element_initialise(doc, &ele->base,
			doc->memoised[hds_SELECT],
			namespace, prefix);
}

/**
 * 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 */

static dom_exception _dom_html_select_element_make_collection(
		dom_html_select_element *ele,
		dom_html_options_collection **col)
{
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);

	assert(doc != NULL);

	return _dom_html_options_collection_create(doc,
			(dom_node_internal *) ele,
			is_option, ele, col);
}

/**
 * Get the type of selection control
 *
 * \param ele   The Select element
 * \param type  Pointer to location to receive type
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_get_type(
		dom_html_select_element *ele, dom_string **type)
{
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);
	dom_exception err;
	bool multiple;

	err = dom_html_select_element_get_multiple(ele, &multiple);
	if (err != DOM_NO_ERR)
		return err;

	if (multiple)
		*type = dom_string_ref(doc->memoised[hds_select_multiple]);
	else
		*type = dom_string_ref(doc->memoised[hds_select_one]);

	return DOM_NO_ERR;
}

/**
 * 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, int32_t *index)
{
	dom_exception err;
	uint32_t idx,len;
	dom_node *option;
	bool selected;
	dom_html_options_collection *col;

	err = _dom_html_select_element_make_collection(ele, &col);

	err = dom_html_options_collection_get_length(col, &len);
	if (err != DOM_NO_ERR) {
		dom_html_options_collection_unref(col);
		return err;
	}

	for (idx = 0; idx < len; idx++) {
		err = dom_html_options_collection_item(col,
				idx, &option);
		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			return err;
		}

		err = dom_html_option_element_get_selected(
				(dom_html_option_element *) option, &selected);

		dom_node_unref(option);

		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			return err;
		}

		if (selected) {
			*index = idx;
			dom_html_options_collection_unref(col);
			return DOM_NO_ERR;
		}
	}

	*index = -1;

	dom_html_options_collection_unref(col);
	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, int32_t index)
{
	dom_exception err;
	dom_node *option;
	dom_html_options_collection *col;

	err = _dom_html_select_element_make_collection(ele, &col);

	err = dom_html_options_collection_item(col,
			index, &option);
	if (err != DOM_NO_ERR) {
		dom_html_options_collection_unref(col);
		return err;
	}

	err = dom_html_option_element_set_selected(
			(dom_html_option_element *) option, true);

	dom_node_unref(option);

	dom_html_options_collection_unref(col);
	if (err != DOM_NO_ERR) {
		return err;
	}

	return DOM_NO_ERR;
}

/**
 * Get the value of this form control
 *
 * \param ele    The select element
 * \param value  Pointer to location to receive value
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_get_value(
		dom_html_select_element *ele, dom_string **value)
{
	dom_exception err;
	uint32_t idx, len;
	dom_node *option;
	bool selected;
	dom_html_options_collection *col;

	err = _dom_html_select_element_make_collection(ele, &col);
	if (err != DOM_NO_ERR)
		return err;

	err = dom_html_select_element_get_length(ele, &len);
	if (err != DOM_NO_ERR) {
		dom_html_options_collection_unref(col);
		return err;
	}

	for (idx = 0; idx < len; idx++) {
		err = dom_html_options_collection_item(col,
				idx, &option);
		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			return err;
		}

		err = dom_html_option_element_get_selected(
				(dom_html_option_element *) option, &selected);
		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			dom_node_unref(option);
			return err;
		}

		if (selected) {
			err = dom_html_option_element_get_value(
					(dom_html_option_element *) option,
					value);

			dom_html_options_collection_unref(col);
			dom_node_unref(option);

			return err;
		}
	}

	*value = NULL;
	dom_html_options_collection_unref(col);

	return DOM_NO_ERR;
}

/**
 * Set the value of this form control
 *
 * \param ele    The select element
 * \param value  New value
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_set_value(
		dom_html_select_element *ele, dom_string *value)
{
	dom_exception err;
	uint32_t idx, len;
	dom_node *option;
	bool selected;
	dom_html_options_collection *col;

	err = _dom_html_select_element_make_collection(ele, &col);
	if (err != DOM_NO_ERR)
		return err;

	err = dom_html_select_element_get_length(ele, &len);
	if (err != DOM_NO_ERR) {
		dom_html_options_collection_unref(col);
		return err;
	}

	for (idx = 0; idx < len; idx++) {
		err = dom_html_options_collection_item(col,
				idx, &option);
		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			return err;
		}

		err = dom_html_option_element_get_selected(
				(dom_html_option_element *) option, &selected);
		if (err != DOM_NO_ERR) {
			dom_html_options_collection_unref(col);
			dom_node_unref(option);
			return err;
		}

		if (selected) {
			err = dom_html_option_element_set_value(
					(dom_html_option_element *) option,
					value);

			dom_html_options_collection_unref(col);
			dom_node_unref(option);

			return err;
		}
	}

	dom_html_options_collection_unref(col);

	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, uint32_t *len)
{
	dom_exception err;
	dom_html_options_collection *col;
	
	err = _dom_html_select_element_make_collection(ele, &col);
	if (err != DOM_NO_ERR)
		return err;

	err = dom_html_options_collection_get_length(col, len);
	
	dom_html_options_collection_unref(col);
	
	return err;
}

/**
 * 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, uint32_t len)
{
	UNUSED(ele);
	UNUSED(len);

	return DOM_NOT_SUPPORTED_ERR;
}

/**
 * Get the form associated with a select
 *
 * \param select  The dom_html_select_element object
 * \param form    Pointer to location to receive form
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_get_form(
		dom_html_select_element *select, dom_html_form_element **form)
{
	*form = select->form;

	if (*form != NULL)
		dom_node_ref(*form);

	return DOM_NO_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)
{
	return _dom_html_select_element_make_collection(ele, col);
}

/**
 * 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);
}

/**
 * Get the name property
 *
 * \param ele   The select element
 * \param name  Pointer to location to receive name
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */ 
dom_exception dom_html_select_element_get_name(
		dom_html_select_element *ele, dom_string **name)
{
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);

	return dom_element_get_attribute(ele,
			doc->memoised[hds_name], name);
}

/**
 * Set the name property
 *
 * \param ele   The select element
 * \param name  New name
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */ 
dom_exception dom_html_select_element_set_name(
		dom_html_select_element *ele, dom_string *name)
{
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);

	return dom_element_set_attribute(ele,
			doc->memoised[hds_name], name);

}

/**
 * Get the size property
 *
 * \param ele   The select element
 * \param size  Pointer to location to receive size
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_get_size(
		dom_html_select_element *ele, int32_t *size)
{
	return dom_html_element_get_int32_t_property(&ele->base, "size",
			SLEN("size"), size);
}

/**
 * Set the size property
 *
 * \param ele   The select element
 * \param size  New size
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_set_size(
		dom_html_select_element *ele, int32_t size)
{
	return dom_html_element_set_int32_t_property(&ele->base, "size",
			SLEN("size"), size);
}

/**
 * Get the tabindex property
 *
 * \param ele        The select element
 * \param tab_index  Pointer to location to receive tab index
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_get_tab_index(
		dom_html_select_element *ele, int32_t *tab_index)
{
	return dom_html_element_get_int32_t_property(&ele->base, "tabindex",
			SLEN("tabindex"), tab_index);
}

/**
 * Set the tabindex property
 *
 * \param ele        The select element
 * \param tab_index  New tab index
 * \return DOM_NO_ERR on success, appropriate error otherwise.
 */
dom_exception dom_html_select_element_set_tab_index(
		dom_html_select_element *ele, int32_t tab_index)
{
	return dom_html_element_set_int32_t_property(&ele->base, "tabindex",
			SLEN("tabindex"), tab_index);
}


/* Functions */
dom_exception dom__html_select_element_add(dom_html_select_element *select,
		struct dom_html_element *ele, struct dom_html_element *before)
{

		return _dom_node_insert_before((dom_node_internal *)select,
				(dom_node_internal *)ele, (dom_node_internal *)before,
				(dom_node_internal **)&ele);
	

}

dom_exception dom_html_select_element_remove(dom_html_select_element *ele,
		int32_t index)
{
	dom_exception err;
	uint32_t len;
	dom_node *option;

	err = dom_html_select_element_get_length(ele, &len);
	if (err != DOM_NO_ERR)
		return err;

	/* Ensure index is in range */
	if (index < 0 || index >= (int32_t)len)
		return DOM_NO_ERR;
	dom_html_options_collection *col;

        err = _dom_html_select_element_make_collection(ele, &col);
        if (err != DOM_NO_ERR)
		return err;
	
	err = dom_html_options_collection_item(col,
			 index, &option);
	
	if (err != DOM_NO_ERR) {
		dom_html_options_collection_unref(col);
		return err;
	}
	return _dom_node_remove_child(((dom_node_internal *)option)->parent,
			(dom_node_internal *)option,
			(dom_node_internal **)&option);
}

/**
 * Blur this control
 *
 * \param ele  Element to blur
 * \return DOM_NO_ERR on success, appropriate dom_exception on failure.
 */
dom_exception dom_html_select_element_blur(struct dom_html_select_element *ele)
{
	struct dom_html_document *doc =
		(dom_html_document *) dom_node_get_owner(ele);
	bool success = false;
	assert(doc != NULL);

	/** \todo Is this event (a) default (b) bubbling and (c) cancelable? */
	return _dom_dispatch_generic_event((dom_document *) doc,
			(dom_event_target *) ele,
			doc->memoised[hds_blur], true,
			true, &success);
}

/**
 * Focus this control
 *
 * \param ele  Element to focus
 * \return DOM_NO_ERR on success, appropriate dom_exception on failure.
 */
dom_exception dom_html_select_element_focus(struct dom_html_select_element *ele)
{
	struct dom_html_document *doc =
		(dom_html_document *) dom_node_get_owner(ele);
	bool success = false;
	assert(doc != NULL);

	/** \todo Is this event (a) default (b) bubbling and (c) cancelable? */
	return _dom_dispatch_generic_event((dom_document *) doc,
			(dom_event_target *) ele,
			doc->memoised[hds_focus], true,
			true, &success);
}


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

/* Test whether certain node is an option node */
bool is_option(struct dom_node_internal *node, void *ctx)
{
	dom_html_select_element *ele = ctx;
	dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele);

	if (dom_string_isequal(node->name, doc->memoised[hds_OPTION]))
		return true;

	return false;
}

dom_exception _dom_html_select_element_set_form(
		dom_html_select_element *select, dom_html_form_element *form)
{
	select->form = form;

	return DOM_NO_ERR;
}