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
|
/* vim: set ts=8 sw=8 noexpandtab: */
/* The `C' CSS Library.
* Copyright (C) 2008 Robert Staudinger
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
#ifndef CCSS_NODE_H
#define CCSS_NODE_H
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ccss/ccss-macros.h>
CCSS_BEGIN_DECLS
typedef struct ccss_node_ ccss_node_t;
/**
* ccss_node_is_a_f:
* @self: a #ccss_node_t.
* @type_name: name to match against, e.g. %div.
*
* Hook function to query whether a #ccss_node_t is of a certain type.
*
* Returns: %TRUE if matches.
**/
typedef bool (*ccss_node_is_a_f) (ccss_node_t *self,
char const *type_name);
/**
* ccss_node_get_container_f:
* @self: a #ccss_node_t.
*
* Hook function to query the container of a #ccss_node_t.
*
* Returns: newly allocated container node or %NULL.
**/
typedef ccss_node_t * (*ccss_node_get_container_f) (ccss_node_t const *self);
/**
* ccss_node_get_base_style_f:
* @self: a #ccss_node_t.
*
* Hook function to query the name of the style a #ccss_node_t derives from.
*
* Returns: base style or %NULL. The returned value must be valid until
* it is released.
**/
typedef ccss_node_t * (*ccss_node_get_base_style_f) (ccss_node_t const *self);
/**
* ccss_node_get_type_f:
* @self: a #ccss_node_t.
*
* Hook function to query the type name of a #ccss_node_t.
*
* Returns: node type name or %NULL. The returned value must be valid until
* the current stylesheet query returns.
**/
typedef const char * (*ccss_node_get_type_f) (ccss_node_t const *self);
/**
* ccss_node_get_instance_f:
* @self: a #ccss_node_t.
*
* Hook function to query for a unique numerical representation of a #ccss_node_t.
*
* Returns: unique numerical id or 0. If 0 is returned, node-based css style will not be considered.
**/
typedef ptrdiff_t (*ccss_node_get_instance_f) (ccss_node_t const *self);
/**
* ccss_node_get_id_f:
* @self: a #ccss_node_t.
*
* Hook function to query the ID of a #ccss_node_t.
*
* Returns: node ID or %NULL. The returned value must be valid until
* the current stylesheet query returns.
**/
typedef const char * (*ccss_node_get_id_f) (ccss_node_t const *self);
/**
* ccss_node_get_class_f:
* @self: a #ccss_node_t.
*
* Hook function to query the class name of a #ccss_node_t.
*
* Returns: node class name or %NULL. The returned value must be valid until
* the current stylesheet query returns.
**/
typedef const char * (*ccss_node_get_class_f) (ccss_node_t const *self);
/**
* ccss_node_get_pseudo_classes_f:
* @self: a #ccss_node_t.
*
* Hook function to query the pseudo-class name of a #ccss_node_t.
*
* Returns: node pseudo-classes or %NULL. The returned values must be valid
* until the current stylesheet query returns.
**/
typedef const char ** (*ccss_node_get_pseudo_classes_f) (ccss_node_t const *self);
/**
* ccss_node_get_attribute_f:
* @self: a #ccss_node_t.
* @name: attribute name.
*
* Hook function to query a #ccss_node_t's attributes.
*
* Returns: attribute value or %NULL. The returned value must be valid until
* the current stylesheet query returns.
**/
typedef char * (*ccss_node_get_attribute_f) (ccss_node_t const *self,
char const *name);
/**
* ccss_node_get_style_f:
* @self: a #ccss_node_t.
* @descriptor: handle to unload this style from the stylesheet later on.
*
* Hook function to query a #ccss_node_t's inline CSS style.
*
* See: ccss_stylesheet_unload().
*
* Returns: the node's CSS properties or %NULL.
**/
typedef const char * (*ccss_node_get_style_f) (ccss_node_t const *self,
unsigned int descriptor);
/**
* ccss_node_get_viewport_f:
* @self: a #ccss_node_t.
* @x: horizontal position.
* @y: vertical position.
* @width: width of viewport.
* @height: height of viewport.
*
* Hook function to determine the position of a node in the viewport.
*
* Returns: %TRUE if a valid viewport position has been assigned to the out parameters.
**/
typedef bool (*ccss_node_get_viewport_f) (ccss_node_t const *self,
double *x,
double *y,
double *width,
double *height);
/**
* ccss_node_release_f:
* @self: a #ccss_node_t.
*
* Hook function to deallocate a #ccss_node_t instance.
**/
typedef void (*ccss_node_release_f) (ccss_node_t *self);
/**
* ccss_node_class_t:
* @is_a: a #ccss_node_is_a_f.
* @get_container: a #ccss_node_get_container_f.
* @get_base_style: a #ccss_node_get_base_style_f.
* @get_instance: a #ccss_node_get_instance_f.
* @get_id: a #ccss_node_get_id_f.
* @get_type: a #ccss_node_get_type_f.
* @get_class: a #ccss_node_get_class_f.
* @get_pseudo_classes: a #ccss_node_get_pseudo_classes_f.
* @get_attribute: a #ccss_node_get_attribute_f.
* @get_style: a #ccss_node_get_style_f.
* @get_viewport: a #ccss_node_get_viewport_f.
* @release: a #ccss_node_release_f.
*
* Dispatch table a CCSS consumer has to fill so the selection engine can
* retrieve information about the document the document.
*
* The implemented dispatch table needs to be passed to #ccss_node_init.
**/
typedef struct {
ccss_node_is_a_f is_a;
ccss_node_get_container_f get_container;
ccss_node_get_base_style_f get_base_style;
ccss_node_get_instance_f get_instance;
ccss_node_get_id_f get_id;
ccss_node_get_type_f get_type;
ccss_node_get_class_f get_class;
ccss_node_get_pseudo_classes_f get_pseudo_classes;
ccss_node_get_attribute_f get_attribute;
ccss_node_get_style_f get_style;
ccss_node_get_viewport_f get_viewport;
ccss_node_release_f release;
/*< private >*/
void (*_padding_0) (void);
void (*_padding_1) (void);
void (*_padding_2) (void);
void (*_padding_3) (void);
void (*_padding_4) (void);
} ccss_node_class_t;
/**
* ccss_node_t:
*
* Stack-allocatable struct representing a document node. Used for querying the
* #ccss_stylesheet_t.
*
* <emphasis>Memory management:</emphasis> Unless specified otherwise, objects
* of this kind are under the responsibility of the libccss consumer.
**/
struct ccss_node_ {
/*< private >*/
CCSS_DEPRECATED (ccss_node_class_t const *node_class);
CCSS_DEPRECATED (ptrdiff_t instance);
CCSS_DEPRECATED (char const *id);
CCSS_DEPRECATED (char const *type_name);
CCSS_DEPRECATED (char const *css_class);
CCSS_DEPRECATED (char const **pseudo_classes);
CCSS_DEPRECATED (char const *inline_style);
};
void
ccss_node_init (ccss_node_t *self,
ccss_node_class_t *node_class);
CCSS_END_DECLS
#endif /* CCSS_NODE_H */
|
