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
|
<?php
/** @file
* CSS selector parsing classes.
*
* This file contains the tools necessary for parsing CSS 3 selectors.
* In the future it may be expanded to handle all of CSS 3.
*
* The parser contained herein is has an event-based API. Implementors should
* begin by implementing the {@link EventHandler} interface. For an example
* of how this is done, see {@link EventHandler.php}.
*
* @author M Butcher <matt@aleph-null.tv>
* @license MIT
*/
namespace QueryPath\CSS;
/** @addtogroup querypath_css CSS Parsing
* QueryPath includes a CSS 3 Selector parser.
*
*
* Typically the parser is not accessed directly. Most developers will use it indirectly from
* qp(), htmlqp(), or one of the methods on a QueryPath object.
*
* This parser is modular and is not tied to QueryPath, so you can use it in your
* own (non-QueryPath) projects if you wish. To dive in, start with EventHandler, the
* event interface that works like a SAX API for CSS selectors. If you want to check out
* the details, check out the parser (QueryPath::CSS::Parser), scanner
* (QueryPath::CSS::Scanner), and token list (QueryPath::CSS::Token).
*/
/**
* An event handler for handling CSS 3 Selector parsing.
*
* This provides a standard interface for CSS 3 Selector event handling. As the
* parser parses a selector, it will fire events. Implementations of EventHandler
* can then handle the events.
*
* This library is inspired by the SAX2 API for parsing XML. Each component of a
* selector fires an event, passing the necessary data on to the event handler.
*
* @ingroup querypath_css
*/
interface EventHandler {
/** The is-exactly (=) operator. */
const isExactly = 0; // =
/** The contains-with-space operator (~=). */
const containsWithSpace = 1; // ~=
/** The contains-with-hyphen operator (!=). */
const containsWithHyphen = 2; // |=
/** The contains-in-string operator (*=). */
const containsInString = 3; // *=
/** The begins-with operator (^=). */
const beginsWith = 4; // ^=
/** The ends-with operator ($=). */
const endsWith = 5; // $=
/** The any-element operator (*). */
const anyElement = '*';
/**
* This event is fired when a CSS ID is encountered.
* An ID begins with an octothorp: #name.
*
* @param string $id
* The ID passed in.
*/
public function elementID($id); // #name
/**
* Handle an element name.
* Example: name
* @param string $name
* The name of the element.
*/
public function element($name); // name
/**
* Handle a namespaced element name.
* example: namespace|name
* @param string $name
* The tag name.
* @param string $namespace
* The namespace identifier (Not the URI)
*/
public function elementNS($name, $namespace = NULL);
/**
* Handle an any-element (*) operator.
* Example: *
*/
public function anyElement(); // *
/**
* Handle an any-element operator that is constrained to a namespace.
* Example: ns|*
* @param string $ns
* The namespace identifier (not the URI).
*/
public function anyElementInNS($ns); // ns|*
/**
* Handle a CSS class selector.
* Example: .name
* @param string $name
* The name of the class.
*/
public function elementClass($name); // .name
/**
* Handle an attribute selector.
* Example: [name=attr]
* Example: [name~=attr]
* @param string $name
* The attribute name.
* @param string $value
* The value of the attribute, if given.
* @param int $operation
* The operation to be used for matching. See {@link EventHandler}
* constants for a list of supported operations.
*/
public function attribute($name, $value = NULL, $operation = EventHandler::isExactly); // [name=attr]
/**
* Handle an attribute selector bound to a specific namespace.
* Example: [ns|name=attr]
* Example: [ns|name~=attr]
* @param string $name
* The attribute name.
* @param string $ns
* The namespace identifier (not the URI).
* @param string $value
* The value of the attribute, if given.
* @param int $operation
* The operation to be used for matching. See {@link EventHandler}
* constants for a list of supported operations.
*/
public function attributeNS($name, $ns, $value = NULL, $operation = EventHandler::isExactly);
/**
* Handle a pseudo-class.
* Example: :name(value)
* @param string $name
* The pseudo-class name.
* @param string $value
* The value, if one is found.
*/
public function pseudoClass($name, $value = NULL); //:name(value)
/**
* Handle a pseudo-element.
* Example: ::name
* @param string $name
* The pseudo-element name.
*/
public function pseudoElement($name); // ::name
/**
* Handle a direct descendant combinator.
* Example: >
*/
public function directDescendant(); // >
/**
* Handle a adjacent combinator.
* Example: +
*/
public function adjacent(); // +
/**
* Handle an another-selector combinator.
* Example: ,
*/
public function anotherSelector(); // ,
/**
* Handle a sibling combinator.
* Example: ~
*/
public function sibling(); // ~ combinator
/**
* Handle an any-descendant combinator.
* Example: ' '
*/
public function anyDescendant(); // ' ' (space) operator.
}
|
