doc/html/GUPnPSearchCriteriaParser.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GUPnPSearchCriteriaParser</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GUPnP A/V Reference Manual">
   8 <link rel="up" href="ch01.html" title="GUPnP A/V">
   9 <link rel="prev" href="GUPnPCDSLastChangeParser.html" title="GUPnPCDSLastChangeParser">
  10 <link rel="next" href="GUPnPProtocolInfo.html" title="GUPnPProtocolInfo">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GUPnPCDSLastChangeParser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GUPnP A/V Reference Manual</th>
  21 <td><a accesskey="n" href="GUPnPProtocolInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GUPnPSearchCriteriaParser.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPSearchCriteriaParser.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPSearchCriteriaParser.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GUPnPSearchCriteriaParser.signals" class="shortcut">Signals</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GUPnPSearchCriteriaParser"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GUPnPSearchCriteriaParser.top_of_page"></a>GUPnPSearchCriteriaParser</span></h2>
  38 <p>GUPnPSearchCriteriaParser — A/V search criteria parser</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GUPnPSearchCriteriaParser.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GUPnPSearchCriteriaOp"></a><pre class="synopsis">                    <a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-struct" title="GUPnPSearchCriteriaParser">GUPnPSearchCriteriaParser</a>;
  45 enum                <a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaOp-enum" title="enum GUPnPSearchCriteriaOp">GUPnPSearchCriteriaOp</a>;
  46 <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="returnvalue">GUPnPSearchCriteriaParser</span></a> * <a class="link" href="GUPnPSearchCriteriaParser.html#gupnp-search-criteria-parser-new" title="gupnp_search_criteria_parser_new ()">gupnp_search_criteria_parser_new</a>
  47                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);
  48 <span class="returnvalue">gboolean</span>            <a class="link" href="GUPnPSearchCriteriaParser.html#gupnp-search-criteria-parser-parse-text" title="gupnp_search_criteria_parser_parse_text ()">gupnp_search_criteria_parser_parse_text</a>
  49                                                         (<em class="parameter"><code><a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser</code></em>,
  50                                                          <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
  51                                                          <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
  52 </pre>
  53 </div>
  54 <div class="refsect1">
  55 <a name="GUPnPSearchCriteriaParser.object-hierarchy"></a><h2>Object Hierarchy</h2>
  56 <pre class="synopsis">
  57   GObject
  58    +----GUPnPSearchCriteriaParser
  59 </pre>
  60 <pre class="synopsis">
  61   GEnum
  62    +----GUPnPSearchCriteriaOp
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="GUPnPSearchCriteriaParser.signals"></a><h2>Signals</h2>
  67 <pre class="synopsis">
  68   "<a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-begin-parens" title='The "begin-parens" signal'>begin-parens</a>"                                   : <code class="literal">Run Last</code>
  69   "<a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-conjunction" title='The "conjunction" signal'>conjunction</a>"                                    : <code class="literal">Run Last</code>
  70   "<a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-disjunction" title='The "disjunction" signal'>disjunction</a>"                                    : <code class="literal">Run Last</code>
  71   "<a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-end-parens" title='The "end-parens" signal'>end-parens</a>"                                     : <code class="literal">Run Last</code>
  72   "<a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaParser-expression" title='The "expression" signal'>expression</a>"                                     : <code class="literal">Run Last</code>
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="GUPnPSearchCriteriaParser.description"></a><h2>Description</h2>
  77 <p>
  78 <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> parses ContentDirectory search criteria
  79 strings.
  80 </p>
  81 <p>
  82 Note that no signals will be emitted if a wildcard is specified,
  83 and that the user is responsible for ensuring precedence of conjunction
  84 over disjunction.
  85 </p>
  86 </div>
  87 <div class="refsect1">
  88 <a name="GUPnPSearchCriteriaParser.details"></a><h2>Details</h2>
  89 <div class="refsect2">
  90 <a name="GUPnPSearchCriteriaParser-struct"></a><h3>GUPnPSearchCriteriaParser</h3>
  91 <pre class="programlisting">typedef struct _GUPnPSearchCriteriaParser GUPnPSearchCriteriaParser;</pre>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="GUPnPSearchCriteriaOp-enum"></a><h3>enum GUPnPSearchCriteriaOp</h3>
  96 <pre class="programlisting">typedef enum {
  97         /* G_TYPE_STRING */
  98         GUPNP_SEARCH_CRITERIA_OP_EQ               = G_TOKEN_LAST + 1,
  99         GUPNP_SEARCH_CRITERIA_OP_NEQ              = G_TOKEN_LAST + 2,
 100         GUPNP_SEARCH_CRITERIA_OP_LESS             = G_TOKEN_LAST + 3,
 101         GUPNP_SEARCH_CRITERIA_OP_LEQ              = G_TOKEN_LAST + 4,
 102         GUPNP_SEARCH_CRITERIA_OP_GREATER          = G_TOKEN_LAST + 5,
 103         GUPNP_SEARCH_CRITERIA_OP_GEQ              = G_TOKEN_LAST + 6,
 104         GUPNP_SEARCH_CRITERIA_OP_CONTAINS         = G_TOKEN_LAST + 7,
 105         GUPNP_SEARCH_CRITERIA_OP_DOES_NOT_CONTAIN = G_TOKEN_LAST + 8,
 106         GUPNP_SEARCH_CRITERIA_OP_DERIVED_FROM     = G_TOKEN_LAST + 9,
 107
 108         /* G_TYPE_BOOLEAN */
 109         GUPNP_SEARCH_CRITERIA_OP_EXISTS           = G_TOKEN_LAST + 10
 110 } GUPnPSearchCriteriaOp;
 111 </pre>
 112 <p>
 113 The possible operators in SearchCriteria strings.
 114 </p>
 115 <div class="variablelist"><table border="0">
 116 <col align="left" valign="top">
 117 <tbody>
 118 <tr>
 119 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-EQ:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_EQ</code></span></p></td>
 120 <td>'='
 121 </td>
 122 </tr>
 123 <tr>
 124 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-NEQ:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_NEQ</code></span></p></td>
 125 <td>'!='
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-LESS:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_LESS</code></span></p></td>
 130 <td>'&lt;'
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-LEQ:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_LEQ</code></span></p></td>
 135 <td>'&lt;='
 136 </td>
 137 </tr>
 138 <tr>
 139 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-GREATER:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_GREATER</code></span></p></td>
 140 <td>'&gt;'
 141 </td>
 142 </tr>
 143 <tr>
 144 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-GEQ:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_GEQ</code></span></p></td>
 145 <td>'&gt;='
 146 </td>
 147 </tr>
 148 <tr>
 149 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-CONTAINS:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_CONTAINS</code></span></p></td>
 150 <td>'contains'
 151 </td>
 152 </tr>
 153 <tr>
 154 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-DOES-NOT-CONTAIN:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_DOES_NOT_CONTAIN</code></span></p></td>
 155 <td>'doesNotContain'
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-DERIVED-FROM:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_DERIVED_FROM</code></span></p></td>
 160 <td>'derivedFrom'
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><a name="GUPNP-SEARCH-CRITERIA-OP-EXISTS:CAPS"></a><span class="term"><code class="literal">GUPNP_SEARCH_CRITERIA_OP_EXISTS</code></span></p></td>
 165 <td>'exists'
 166 </td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 <hr>
 172 <div class="refsect2">
 173 <a name="gupnp-search-criteria-parser-new"></a><h3>gupnp_search_criteria_parser_new ()</h3>
 174 <pre class="programlisting"><a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="returnvalue">GUPnPSearchCriteriaParser</span></a> * gupnp_search_criteria_parser_new
 175                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody><tr>
 179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 180 <td>A new <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> object.</td>
 181 </tr></tbody>
 182 </table></div>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="gupnp-search-criteria-parser-parse-text"></a><h3>gupnp_search_criteria_parser_parse_text ()</h3>
 187 <pre class="programlisting"><span class="returnvalue">gboolean</span>            gupnp_search_criteria_parser_parse_text
 188                                                         (<em class="parameter"><code><a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser</code></em>,
 189                                                          <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
 190                                                          <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 191 <p>
 192 Parses <em class="parameter"><code>text</code></em>, emitting the various defined signals on the way. If an
 193 error occured <em class="parameter"><code>error</code></em> will be set.
 194 </p>
 195 <div class="variablelist"><table border="0">
 196 <col align="left" valign="top">
 197 <tbody>
 198 <tr>
 199 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 200 <td>A <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a>
 201 </td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 205 <td>The search criteria string to be parsed</td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 209 <td>The location where to store the error information if any, or NULL</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 213 <td>TRUE on success.</td>
 214 </tr>
 215 </tbody>
 216 </table></div>
 217 </div>
 218 </div>
 219 <div class="refsect1">
 220 <a name="GUPnPSearchCriteriaParser.signal-details"></a><h2>Signal Details</h2>
 221 <div class="refsect2">
 222 <a name="GUPnPSearchCriteriaParser-begin-parens"></a><h3>The <code class="literal">"begin-parens"</code> signal</h3>
 223 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser,
 224                                                         <span class="type">gpointer</span>                   user_data)      : <code class="literal">Run Last</code></pre>
 225 <p>
 226 The ::begin_parens signal is emitted to mark the beginning of a
 227 parenthetical expression.
 228 </p>
 229 <div class="variablelist"><table border="0">
 230 <col align="left" valign="top">
 231 <tbody>
 232 <tr>
 233 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 234 <td>The <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> that received the signal</td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 238 <td>user data set when the signal handler was connected.</td>
 239 </tr>
 240 </tbody>
 241 </table></div>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="GUPnPSearchCriteriaParser-conjunction"></a><h3>The <code class="literal">"conjunction"</code> signal</h3>
 246 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser,
 247                                                         <span class="type">gpointer</span>                   user_data)      : <code class="literal">Run Last</code></pre>
 248 <p>
 249 The ::conjuction signal is emitted whenever a conjuction marker
 250 (and) is parsed.
 251 </p>
 252 <div class="variablelist"><table border="0">
 253 <col align="left" valign="top">
 254 <tbody>
 255 <tr>
 256 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 257 <td>The <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> that received the signal</td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 261 <td>user data set when the signal handler was connected.</td>
 262 </tr>
 263 </tbody>
 264 </table></div>
 265 </div>
 266 <hr>
 267 <div class="refsect2">
 268 <a name="GUPnPSearchCriteriaParser-disjunction"></a><h3>The <code class="literal">"disjunction"</code> signal</h3>
 269 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser,
 270                                                         <span class="type">gpointer</span>                   user_data)      : <code class="literal">Run Last</code></pre>
 271 <p>
 272 The ::disjuction signal is emitted whenever a disjuction marker
 273 (or&amp;rpar is parsed.
 274 </p>
 275 <div class="variablelist"><table border="0">
 276 <col align="left" valign="top">
 277 <tbody>
 278 <tr>
 279 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 280 <td>The <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> that received the signal</td>
 281 </tr>
 282 <tr>
 283 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 284 <td>user data set when the signal handler was connected.</td>
 285 </tr>
 286 </tbody>
 287 </table></div>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="GUPnPSearchCriteriaParser-end-parens"></a><h3>The <code class="literal">"end-parens"</code> signal</h3>
 292 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser,
 293                                                         <span class="type">gpointer</span>                   user_data)      : <code class="literal">Run Last</code></pre>
 294 <p>
 295 The ::end_parens signal is emitted to mark the end of a parenthetical
 296 expression.
 297 </p>
 298 <div class="variablelist"><table border="0">
 299 <col align="left" valign="top">
 300 <tbody>
 301 <tr>
 302 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 303 <td>The <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> that received the signal</td>
 304 </tr>
 305 <tr>
 306 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 307 <td>user data set when the signal handler was connected.</td>
 308 </tr>
 309 </tbody>
 310 </table></div>
 311 </div>
 312 <hr>
 313 <div class="refsect2">
 314 <a name="GUPnPSearchCriteriaParser-expression"></a><h3>The <code class="literal">"expression"</code> signal</h3>
 315 <pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> *parser,
 316                                                         <span class="type">gchar</span>                     *property,
 317                                                         <a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaOp"><span class="type">GUPnPSearchCriteriaOp</span></a>      op,
 318                                                         <span class="type">gchar</span>                     *value,
 319                                                         <span class="type">gpointer</span>                   error,
 320                                                         <span class="type">gpointer</span>                   user_data)      : <code class="literal">Run Last</code></pre>
 321 <p>
 322 The ::expression signal is emitted whenever an expression is parsed.
 323 Set <em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code> if an error occurred.
 324 </p>
 325 <div class="variablelist"><table border="0">
 326 <col align="left" valign="top">
 327 <tbody>
 328 <tr>
 329 <td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
 330 <td>The <a class="link" href="GUPnPSearchCriteriaParser.html" title="GUPnPSearchCriteriaParser"><span class="type">GUPnPSearchCriteriaParser</span></a> that received the signal</td>
 331 </tr>
 332 <tr>
 333 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 334 <td>The property</td>
 335 </tr>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
 338 <td>The operator as <a class="link" href="GUPnPSearchCriteriaParser.html#GUPnPSearchCriteriaOp"><span class="type">GUPnPSearchCriteriaOp</span></a>
 339 </td>
 340 </tr>
 341 <tr>
 342 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 343 <td>The value as string</td>
 344 </tr>
 345 <tr>
 346 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 347 <td>Place-holder for any possible errors from handler</td>
 348 </tr>
 349 <tr>
 350 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 351 <td>user data set when the signal handler was connected.</td>
 352 </tr>
 353 </tbody>
 354 </table></div>
 355 </div>
 356 </div>
 357 </div>
 358 <div class="footer">
 359 <hr>
 360           Generated by GTK-Doc V1.18</div>
 361 </body>
 362 </html>