|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.AdBlock.AdBlockSearchTree</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.WebBrowser.AdBlock.AdBlockSearchTree</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the AdBlock search tree. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#AdBlockSearchTree">AdBlockSearchTree</a></td> |
|
25 <td>Class implementing the AdBlock search tree.</td> |
|
26 </tr> |
|
27 <tr> |
|
28 <td><a href="#AdBlockSearchTreeNode">AdBlockSearchTreeNode</a></td> |
|
29 <td>Class implementing the AdBlock search tree node.</td> |
|
30 </tr> |
|
31 </table> |
|
32 <h3>Functions</h3> |
|
33 |
|
34 <table> |
|
35 <tr><td>None</td></tr> |
|
36 </table> |
|
37 <hr /> |
|
38 <hr /> |
|
39 <a NAME="AdBlockSearchTree" ID="AdBlockSearchTree"></a> |
|
40 <h2>AdBlockSearchTree</h2> |
|
41 |
|
42 <p> |
|
43 Class implementing the AdBlock search tree. |
|
44 </p> |
|
45 <h3>Derived from</h3> |
|
46 None |
|
47 <h3>Class Attributes</h3> |
|
48 |
|
49 <table> |
|
50 <tr><td>None</td></tr> |
|
51 </table> |
|
52 <h3>Class Methods</h3> |
|
53 |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 |
|
59 <table> |
|
60 |
|
61 <tr> |
|
62 <td><a href="#AdBlockSearchTree.__init__">AdBlockSearchTree</a></td> |
|
63 <td>Constructor</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#AdBlockSearchTree.__deleteNode">__deleteNode</a></td> |
|
67 <td>Private method to delete a search tree node.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#AdBlockSearchTree.__prefixSearch">__prefixSearch</a></td> |
|
71 <td>Private method to perform a prefix search.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#AdBlockSearchTree.add">add</a></td> |
|
75 <td>Public method to add a rule to the search tree.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#AdBlockSearchTree.clear">clear</a></td> |
|
79 <td>Public method to clear the search tree.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#AdBlockSearchTree.find">find</a></td> |
|
83 <td>Public method to find a matching rule.</td> |
|
84 </tr> |
|
85 </table> |
|
86 <h3>Static Methods</h3> |
|
87 |
|
88 <table> |
|
89 <tr><td>None</td></tr> |
|
90 </table> |
|
91 |
|
92 <a NAME="AdBlockSearchTree.__init__" ID="AdBlockSearchTree.__init__"></a> |
|
93 <h4>AdBlockSearchTree (Constructor)</h4> |
|
94 <b>AdBlockSearchTree</b>(<i></i>) |
|
95 |
|
96 <p> |
|
97 Constructor |
|
98 </p> |
|
99 <a NAME="AdBlockSearchTree.__deleteNode" ID="AdBlockSearchTree.__deleteNode"></a> |
|
100 <h4>AdBlockSearchTree.__deleteNode</h4> |
|
101 <b>__deleteNode</b>(<i>node</i>) |
|
102 |
|
103 <p> |
|
104 Private method to delete a search tree node. |
|
105 </p> |
|
106 <dl> |
|
107 |
|
108 <dt><i>node</i> (AdBlockSearchTreeNode)</dt> |
|
109 <dd> |
|
110 reference to the node to be deleted |
|
111 </dd> |
|
112 </dl> |
|
113 <a NAME="AdBlockSearchTree.__prefixSearch" ID="AdBlockSearchTree.__prefixSearch"></a> |
|
114 <h4>AdBlockSearchTree.__prefixSearch</h4> |
|
115 <b>__prefixSearch</b>(<i>request, domain, urlString, string, length</i>) |
|
116 |
|
117 <p> |
|
118 Private method to perform a prefix search. |
|
119 </p> |
|
120 <dl> |
|
121 |
|
122 <dt><i>request</i> (QWebEngineUrlRequestInfo)</dt> |
|
123 <dd> |
|
124 URL request to be matched |
|
125 </dd> |
|
126 <dt><i>domain</i> (str)</dt> |
|
127 <dd> |
|
128 domain of the URL |
|
129 </dd> |
|
130 <dt><i>urlString</i> (str)</dt> |
|
131 <dd> |
|
132 requested URL as a lowercase string |
|
133 </dd> |
|
134 <dt><i>string</i> (str)</dt> |
|
135 <dd> |
|
136 prefix string to search for |
|
137 </dd> |
|
138 <dt><i>length</i> (int)</dt> |
|
139 <dd> |
|
140 length to be considered |
|
141 </dd> |
|
142 </dl> |
|
143 <dl> |
|
144 <dt>Return:</dt> |
|
145 <dd> |
|
146 reference to the matched rule |
|
147 </dd> |
|
148 </dl> |
|
149 <dl> |
|
150 <dt>Return Type:</dt> |
|
151 <dd> |
|
152 AdBlockRule |
|
153 </dd> |
|
154 </dl> |
|
155 <a NAME="AdBlockSearchTree.add" ID="AdBlockSearchTree.add"></a> |
|
156 <h4>AdBlockSearchTree.add</h4> |
|
157 <b>add</b>(<i>rule</i>) |
|
158 |
|
159 <p> |
|
160 Public method to add a rule to the search tree. |
|
161 </p> |
|
162 <dl> |
|
163 |
|
164 <dt><i>rule</i> (AdBlockRule)</dt> |
|
165 <dd> |
|
166 rule to be added |
|
167 </dd> |
|
168 </dl> |
|
169 <dl> |
|
170 <dt>Return:</dt> |
|
171 <dd> |
|
172 flag indicating a successful addition |
|
173 </dd> |
|
174 </dl> |
|
175 <dl> |
|
176 <dt>Return Type:</dt> |
|
177 <dd> |
|
178 bool |
|
179 </dd> |
|
180 </dl> |
|
181 <a NAME="AdBlockSearchTree.clear" ID="AdBlockSearchTree.clear"></a> |
|
182 <h4>AdBlockSearchTree.clear</h4> |
|
183 <b>clear</b>(<i></i>) |
|
184 |
|
185 <p> |
|
186 Public method to clear the search tree. |
|
187 </p> |
|
188 <a NAME="AdBlockSearchTree.find" ID="AdBlockSearchTree.find"></a> |
|
189 <h4>AdBlockSearchTree.find</h4> |
|
190 <b>find</b>(<i>request, domain, urlString</i>) |
|
191 |
|
192 <p> |
|
193 Public method to find a matching rule. |
|
194 </p> |
|
195 <dl> |
|
196 |
|
197 <dt><i>request</i> (QWebEngineUrlRequestInfo)</dt> |
|
198 <dd> |
|
199 URL request to be matched |
|
200 </dd> |
|
201 <dt><i>domain</i> (str)</dt> |
|
202 <dd> |
|
203 domain of the URL |
|
204 </dd> |
|
205 <dt><i>urlString</i> (str)</dt> |
|
206 <dd> |
|
207 requested URL as a lowercase string |
|
208 </dd> |
|
209 </dl> |
|
210 <dl> |
|
211 <dt>Return:</dt> |
|
212 <dd> |
|
213 reference to the matched rule |
|
214 </dd> |
|
215 </dl> |
|
216 <dl> |
|
217 <dt>Return Type:</dt> |
|
218 <dd> |
|
219 AdBlockRule |
|
220 </dd> |
|
221 </dl> |
|
222 <div align="right"><a href="#top">Up</a></div> |
|
223 <hr /> |
|
224 <hr /> |
|
225 <a NAME="AdBlockSearchTreeNode" ID="AdBlockSearchTreeNode"></a> |
|
226 <h2>AdBlockSearchTreeNode</h2> |
|
227 |
|
228 <p> |
|
229 Class implementing the AdBlock search tree node. |
|
230 </p> |
|
231 <h3>Derived from</h3> |
|
232 None |
|
233 <h3>Class Attributes</h3> |
|
234 |
|
235 <table> |
|
236 <tr><td>None</td></tr> |
|
237 </table> |
|
238 <h3>Class Methods</h3> |
|
239 |
|
240 <table> |
|
241 <tr><td>None</td></tr> |
|
242 </table> |
|
243 <h3>Methods</h3> |
|
244 |
|
245 <table> |
|
246 |
|
247 <tr> |
|
248 <td><a href="#AdBlockSearchTreeNode.__init__">AdBlockSearchTreeNode</a></td> |
|
249 <td>Constructor</td> |
|
250 </tr> |
|
251 </table> |
|
252 <h3>Static Methods</h3> |
|
253 |
|
254 <table> |
|
255 <tr><td>None</td></tr> |
|
256 </table> |
|
257 |
|
258 <a NAME="AdBlockSearchTreeNode.__init__" ID="AdBlockSearchTreeNode.__init__"></a> |
|
259 <h4>AdBlockSearchTreeNode (Constructor)</h4> |
|
260 <b>AdBlockSearchTreeNode</b>(<i></i>) |
|
261 |
|
262 <p> |
|
263 Constructor |
|
264 </p> |
|
265 <div align="right"><a href="#top">Up</a></div> |
|
266 <hr /> |
|
267 </body></html> |