~ubuntu-branches/ubuntu/karmic/ocamlnet/karmic

<pre><span class="keyword">module</span> Html: <code class="code">sig</code> <a href="Netencoding.Html.html">..</a> <code class="code">end</code></pre><hr width="100%">

<br>

Encodes characters that need protection by converting them to

entity references. E.g. <code class="code">"<"</code> is converted to <code class="code">"&lt;"</code>.

As the entities may be named, there is a dependency on the character

set.<br>

<br>

Legacy functions:<br>

<pre><span class="keyword">val</span> <a name="VALencode_from_latin1"></a>encode_from_latin1 : <code class="type">string -> string</code></pre><pre><span class="keyword">val</span> <a name="VALdecode_to_latin1"></a>decode_to_latin1 : <code class="type">string -> string</code></pre><br>

These functions have a more general interface and should be preferred

in new programs.<br>

<pre><span class="keyword">val</span> <a name="VALunsafe_chars_html4"></a>unsafe_chars_html4 : <code class="type">string</code></pre><div class="info">

The string contains '<', '>', '"', '&' and the control characters

0-8, 11-12, 14-31, 127.<br>

</div>

<pre><span class="keyword">val</span> <a name="VALencode"></a>encode : <code class="type">in_enc:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_enc:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?prefer_name:bool -> ?unsafe_chars:string -> unit -> string -> string</code></pre><div class="info">

The input string that is encoded as <code class="code">in_enc</code> is recoded to

<code class="code">out_enc</code>, and the following characters are encoded as HTML

entity (<code class="code">&name;</code> or <code class="code">&#num;</code>):<ul>

<li>The ASCII characters contained in <code class="code">unsafe_chars</code></li>

<li>The characters that cannot be represented in <code class="code">out_enc</code>. By

default (<code class="code">out_enc=`Enc_usascii</code>), only ASCII characters can be

represented, and thus all code points >= 128 are encoded as

HTML entities. If you pass <code class="code">out_enc=`Enc_utf8</code>, all characters

can be represented.</li>

</ul>

For example, the string <code class="code">"(a<b) & (c>d)"</code> is encoded as

<code class="code">"(a&lt;b) &amp; (c&gt;d)"</code>.

<p>

It is required that <code class="code">out_enc</code> is an ASCII-compatible encoding.

<p>

The option <code class="code">prefer_name</code> selects whether named entities (e.g. <code class="code">&lt;</code>)

or numeric entities (e.g. <code class="code">&#60;</code>) are prefered.

<p>

The efficiency of the function can be improved when the same encoding

is applied to several strings. Create a specialized encoding function

by passing all arguments up to the unit argument, and apply this

function several times. For example:

let my_enc = encode ~in_enc:`Enc_utf8 () in

let s1' = my_enc s1 in

let s2' = my_enc s2 in ...

</code></pre><br>

</div>

<pre><span class="keyword">type</span> <a name="TYPEentity_set"></a><code class="type"></code>entity_set = <code class="type">[ `Empty | `Html | `Xml ]</code> </pre>

100

<pre><span class="keyword">val</span> <a name="VALdecode"></a>decode : <code class="type">in_enc:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> out_enc:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?lookup:(string -> string) -><br> ?subst:(int -> string) -><br> ?entity_base:<a href="Netencoding.Html.html#TYPEentity_set">entity_set</a> -> unit -> string -> string</code></pre><div class="info">

101

The input string is recoded from <code class="code">in_enc</code> to <code class="code">out_enc</code>, and HTML

102

entities (<code class="code">&name;</code> or <code class="code">&#num;</code>) are resolved. The input encoding

103

<code class="code">in_enc</code> must be ASCII-compatible.

104

<p>

105

106

By default, the function knows all entities defined for HTML 4 (this

107

can be changed using <code class="code">entity_base</code>, see below). If other

108

entities occur, the function <code class="code">lookup</code> is called and the name of

109

the entity is passed as input string to the function. It is

110

expected that <code class="code">lookup</code> returns the value of the entity, and that this

111

value is already encoded as <code class="code">out_enc</code>.

112

By default, <code class="code">lookup</code> raises a <code class="code">Failure</code> exception.

113

<p>

114

115

If a character cannot be represented in the output encoding,

116

the function <code class="code">subst</code> is called. <code class="code">subst</code> must return a substitute

117

string for the character.

118

By default, <code class="code">subst</code> raises a <code class="code">Failure</code> exception.

119

<p>

120

121

The option <code class="code">entity_base</code> determines which set of entities are

122

considered as the known entities that can be decoded without

123

help by the <code class="code">lookup</code> function: <code class="code">`Html</code> selects all entities defined

124

for HTML 4, <code class="code">`Xml</code> selects only <code class="code">&lt;</code>, <code class="code">&gt;</code>, <code class="code">&amp;</code>, <code class="code">&quot;</code>,

125

and <code class="code">&apos;</code>,

126

and <code class="code">`Empty</code> selects the empty set (i.e. <code class="code">lookup</code> is always called).<br>

127

</div>

128

</body></html>

b'\\ No newline at end of file'

Older »