summaryrefslogtreecommitdiff
path: root/src/html/html_options_collection.c
blob: 26926bf33920c34f76b70555b10a0073f7931836 (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
/*
 * 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 <libwapcaplet/libwapcaplet.h>

#include "html/html_options_collection.h"

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

/*-----------------------------------------------------------------------*/
/* Constructor and destructor */

/**
 * Create a dom_html_options_collection
 *
 * \param doc   The document
 * \param root  The root element of the collection
 * \param ic    The callback function used to determin whether certain node
 *              belongs to the collection
 * \param col   The result collection object
 * \return DOM_NO_ERR on success, appropriate dom_exception on failure.
 */
dom_exception _dom_html_options_collection_create(struct dom_html_document *doc,
		struct dom_node_internal *root,
		dom_callback_is_in_collection ic,
		void *ctx,
		struct dom_html_options_collection **col)
{
	*col = malloc(sizeof(dom_html_options_collection));
	if (*col == NULL)
		return DOM_NO_MEM_ERR;
	
	return _dom_html_options_collection_initialise(doc, *col, root,
						       ic, ctx);
}

/**
 * Intialiase a dom_html_options_collection
 *
 * \param doc   The document
 * \param col   The collection object to be initialised
 * \param root  The root element of the collection
 * \param ic    The callback function used to determin whether certain node
 *              belongs to the collection
 * \return DOM_NO_ERR on success.
 */
dom_exception _dom_html_options_collection_initialise(struct dom_html_document *doc,
		struct dom_html_options_collection *col,
		struct dom_node_internal *root,
		dom_callback_is_in_collection ic, void *ctx)
{
	return _dom_html_collection_initialise(doc, &col->base, root, ic, ctx);
}

/**
 * Finalise a dom_html_options_collection object
 *
 * \param col  The dom_html_options_collection object
 */
void _dom_html_options_collection_finalise(struct dom_html_options_collection *col)
{
	_dom_html_collection_finalise(&col->base);
}

/**
 * Destroy a dom_html_options_collection object
 * \param col  The dom_html_options_collection object
 */
void _dom_html_options_collection_destroy(struct dom_html_options_collection *col)
{
	_dom_html_options_collection_finalise(col);

	free(col);
}


/*-----------------------------------------------------------------------*/
/* Public API */

/**
 * Get the length of this dom_html_options_collection
 *
 * \param col  The dom_html_options_collection object
 * \param len  The returned length of this collection
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_options_collection_get_length(dom_html_options_collection *col,
		unsigned long *len)
{
	return dom_html_collection_get_length(&col->base, len);
}

/**
 * Set the length of this dom_html_options_collection
 *
 * \param col  The dom_html_options_collection object
 * \param len  The length of this collection to be set
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_options_collection_set_length(
		dom_html_options_collection *col, unsigned long len)
{
	UNUSED(col);
	UNUSED(len);

	/* TODO: how to deal with this */
	return DOM_NOT_SUPPORTED_ERR;
}

/**
 * Get the node with certain index
 *
 * \param col  The dom_html_options_collection object
 * \param index  The index number based on zero
 * \param node   The returned node object
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_options_collection_item(dom_html_options_collection *col,
		unsigned long index, struct dom_node **node)
{
	return dom_html_collection_item(&col->base, index, node);
}

/**
 * Get the node in the collection according name
 *
 * \param col   The collection
 * \param name  The name of target node
 * \param node  The returned node object
 * \return DOM_NO_ERR on success.
 */
dom_exception dom_html_options_collection_named_item(dom_html_options_collection *col,
		dom_string *name, struct dom_node **node)
{
	return dom_html_collection_named_item(&col->base, name, node);
}

/**
 * Claim a reference on this collection
 *
 * \pram col  The collection object
 */
void dom_html_options_collection_ref(dom_html_options_collection *col)
{
	if (col == NULL)
		return;
	
	col->base.refcnt ++;
}

/**
 * Relese a reference on this collection
 *
 * \pram col  The collection object
 */
void dom_html_options_collection_unref(dom_html_options_collection *col)
{
	if (col == NULL)
		return;
	
	if (col->base.refcnt > 0)
		col->base.refcnt --;
	
	if (col->base.refcnt == 0)
		_dom_html_options_collection_destroy(col);
}