~ubuntu-branches/ubuntu/trusty/pxp/trusty

<pre>module Pxp_event: <code class="code">sig</code> <a href="Pxp_event.html">..</a> <code class="code">end</code></pre>Dealing with events (for pull parsing)

Example:

<pre></pre><code class="code"> let l = [ E_pinstr; E_start_tag; E_data; E_start_tag; E_end_tag;

<code class="code"> let l = [ E_pinstr; E_start_tag; E_data; E_start_tag; E_end_tag;

E_comment; E_end_tag; E_data ];;

let g = of_list l;;

g();;

g'();;                     (* returns None, end of subexpression *)

100

g();;                      (* returns Some E_data *)

101

100

g();;                      (* returns None *)

102

</code><pre></pre>

101

</code>

103

102

</div>

104

103

105

104

<h2>Filters</h2>

146

145

147

146

148

147

Example: Remove comments:

149

<pre></pre><code class="code"> pfilter (function E_comment _ -> false | _ -> true) g </code><pre></pre>

148

<code class="code"> pfilter (function E_comment _ -> false | _ -> true) g </code>

150

149

</div>

151

150

<pre>val unwrap_document : <code class="type"><a href="Pxp_event.html#TYPEpull_fn">pull_fn</a> -> (unit -> string * <a href="Pxp_dtd.dtd-c.html">Pxp_dtd.dtd</a>) * <a href="Pxp_event.html#TYPEpull_fn">pull_fn</a></code></pre><div class="info">

152

151

This filter removes the document wrapping from the stream

154

153

It is called like

155

154

156

155

157

<pre></pre><code class="code">         let (get_doc_details, next') = unwrap_document next

156

<code class="code">         let (get_doc_details, next') = unwrap_document next

158

157

let (version, dtd) = get_doc_details()

159

</code><pre></pre>

158

</code>

160

159

161

160

162

161

The returned <code class="code">filter</code> removes any <code class="code">E_start_doc</code>, <code class="code">E_end_doc</code>,

188

187

<h2>Printing event streams</h2>

189

188

<pre>type <code class="type"></code>dtd_style = <code class="type">[ `Ignore | `Include | `Reference ]</code> </pre>

190

189

191

<pre>val write_events : <code class="type">?default:string -> ?dtd_style:<a href="Pxp_event.html#TYPEdtd_style">dtd_style</a> -> ?minimization:[ `AllEmpty | `None ] -> Pxp_types.output_stream -> Pxp_types.encoding -> Pxp_types.rep_encoding -> (unit -> <a href="Pxp_types.html#TYPEevent">Pxp_types.event</a> option) -> unit</code></pre><div class="info">

190

<pre>val write_events : <code class="type">?default:string -> ?dtd_style:<a href="Pxp_event.html#TYPEdtd_style">dtd_style</a> -> ?minimization:[ `AllEmpty | `None ] -> <a href="Pxp_types.html#TYPEoutput_stream">Pxp_types.output_stream</a> -> <a href="Pxp_types.html#TYPEencoding">Pxp_types.encoding</a> -> <a href="Pxp_types.html#TYPErep_encoding">Pxp_types.rep_encoding</a> -> (unit -> <a href="Pxp_types.html#TYPEevent">Pxp_types.event</a> option) -> unit</code></pre><div class="info">

192

191

Writes the events to the <code class="code">output_stream</code>. The events must be encoded

193

192

as indicated by the <code class="code">rep_encoding</code> argument, but the output is written

194

193

as specified by the <code class="code">encoding</code> argument.

212

211

means that all empty elements are minimized (using the <code class="code"><name/></code>

213

212

form). <code class="code">`None</code> does not minimize at all and is the default.

214

213

</div>

215

<pre>val display_events : <code class="type">?dtd_style:<a href="Pxp_event.html#TYPEdtd_style">dtd_style</a> -> ?minimization:[ `AllEmpty | `None ] -> Pxp_types.output_stream -> Pxp_types.encoding -> Pxp_types.rep_encoding -> (unit -> <a href="Pxp_types.html#TYPEevent">Pxp_types.event</a> option) -> unit</code></pre><div class="info">

214

<pre>val display_events : <code class="type">?dtd_style:<a href="Pxp_event.html#TYPEdtd_style">dtd_style</a> -> ?minimization:[ `AllEmpty | `None ] -> <a href="Pxp_types.html#TYPEoutput_stream">Pxp_types.output_stream</a> -> <a href="Pxp_types.html#TYPEencoding">Pxp_types.encoding</a> -> <a href="Pxp_types.html#TYPErep_encoding">Pxp_types.rep_encoding</a> -> (unit -> <a href="Pxp_types.html#TYPEevent">Pxp_types.event</a> option) -> unit</code></pre><div class="info">

216

215

Writes the events to the <code class="code">output_stream</code>. The events must be encoded

217

216

as indicated by the <code class="code">rep_encoding</code> argument, but the output is written

218

217

as specified by the <code class="code">encoding</code> argument.

Older »