/usr/share/doc/libperl4caml-ocaml-doc/html/Perl.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="next" href="Pl_Data_Dumper.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Perl" rel="Chapter" href="Perl.html">
<link title="Pl_Data_Dumper" rel="Chapter" href="Pl_Data_Dumper.html">
<link title="Pl_Date_Calc" rel="Chapter" href="Pl_Date_Calc.html">
<link title="Pl_Date_Format" rel="Chapter" href="Pl_Date_Format.html">
<link title="Pl_Date_Parse" rel="Chapter" href="Pl_Date_Parse.html">
<link title="Pl_HTML_Element" rel="Chapter" href="Pl_HTML_Element.html">
<link title="Pl_HTML_Form" rel="Chapter" href="Pl_HTML_Form.html">
<link title="Pl_HTML_Parser" rel="Chapter" href="Pl_HTML_Parser.html">
<link title="Pl_HTML_TreeBuilder" rel="Chapter" href="Pl_HTML_TreeBuilder.html">
<link title="Pl_HTTP_Cookies" rel="Chapter" href="Pl_HTTP_Cookies.html">
<link title="Pl_HTTP_Headers" rel="Chapter" href="Pl_HTTP_Headers.html">
<link title="Pl_HTTP_Message" rel="Chapter" href="Pl_HTTP_Message.html">
<link title="Pl_HTTP_Request" rel="Chapter" href="Pl_HTTP_Request.html">
<link title="Pl_HTTP_Request_Common" rel="Chapter" href="Pl_HTTP_Request_Common.html">
<link title="Pl_HTTP_Response" rel="Chapter" href="Pl_HTTP_Response.html">
<link title="Pl_LWP_UserAgent" rel="Chapter" href="Pl_LWP_UserAgent.html">
<link title="Pl_Template" rel="Chapter" href="Pl_Template.html">
<link title="Pl_URI" rel="Chapter" href="Pl_URI.html">
<link title="Pl_WWW_Mechanize" rel="Chapter" href="Pl_WWW_Mechanize.html"><title>Perl</title>
</head>
<body>
<div class="navbar">&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="Pl_Data_Dumper.html">Next</a>
</div>
<center><h1>Module <a href="type_Perl.html">Perl</a></h1></center>
<br>
<pre><span class="keyword">module</span> Perl: <code class="code">sig</code> <a href="Perl.html">..</a> <code class="code">end</code></pre>Interface to Perl from OCaml.<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEsv"></a><code class="type"></code>sv </pre>
<div class="info">
Perl scalar value.<br>
</div>

<pre><span class="keyword">type</span> <a name="TYPEav"></a><code class="type"></code>av </pre>
<div class="info">
Perl array value.<br>
</div>

<pre><span class="keyword">type</span> <a name="TYPEhv"></a><code class="type"></code>hv </pre>
<div class="info">
Perl hash value.<br>
</div>

<pre><span class="keyword">exception</span> <a name="EXCEPTIONPerl_failure"></a>Perl_failure <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
<code class="code">die</code> in Perl code is translated automatically into this exception.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALint_of_sv"></a>int_of_sv : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> int</code></pre><div class="info">
Convert a Perl <code class="code">SV</code> into an integer. Note that OCaml <code class="code">int</code>s aren't
 large enough to store the full 32 (or 64) bits from a Perl integer,
 so you may get a silent overflow.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_of_int"></a>sv_of_int : <code class="type">int -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Convert an <code class="code">int</code> into a Perl <code class="code">SV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfloat_of_sv"></a>float_of_sv : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> float</code></pre><div class="info">
Convert a Perl <code class="code">SV</code> into a float.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_of_float"></a>sv_of_float : <code class="type">float -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Convert a <code class="code">float</code> into a Perl <code class="code">SV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALstring_of_sv"></a>string_of_sv : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> string</code></pre><div class="info">
Convert a Perl <code class="code">SV</code> into a string.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_of_string"></a>sv_of_string : <code class="type">string -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Convert a <code class="code">string</code> into a Perl <code class="code">SV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALbool_of_sv"></a>bool_of_sv : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> bool</code></pre><div class="info">
Convert an <code class="code">SV</code> into a boolean.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_of_bool"></a>sv_of_bool : <code class="type">bool -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Convert a boolean into an <code class="code">SV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_is_true"></a>sv_is_true : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> bool</code></pre><div class="info">
Return <code class="code">true</code> if the <code class="code">SV</code> is "true" (in the Perl sense of truth).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_is_undef"></a>sv_is_undef : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> bool</code></pre><div class="info">
Return <code class="code">true</code> if the <code class="code">SV</code> is undefined (is <code class="code">undef</code>).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_undef"></a>sv_undef : <code class="type">unit -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Returns <code class="code">undef</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_true"></a>sv_true : <code class="type">unit -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Returns an <code class="code">SV</code> which is true.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_false"></a>sv_false : <code class="type">unit -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Returns an <code class="code">SV</code> which is false.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_yes"></a>sv_yes : <code class="type">unit -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Returns Perl's internal <code class="code">PL_sv_yes</code>. (There are some unresolved issues
 with using this, so use <a href="Perl.html#VALsv_true"><code class="code">Perl.sv_true</code></a> instead).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsv_no"></a>sv_no : <code class="type">unit -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Returns Perl's internal <code class="code">PL_sv_no</code>. (There are some unresolved issues
 with using this, so use <a href="Perl.html#VALsv_false"><code class="code">Perl.sv_false</code></a> instead).<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEsv_t"></a><code class="type"></code>sv_t = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_NULL</span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_IV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Integer scalar.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_NV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Floating point scalar.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >String scalar.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_RV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Reference.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PVAV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Array.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PVHV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Hash.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PVCV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Code.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PVGV</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Glob (possibly a file handle).</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SVt_PVMG</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Blessed or magical scalar.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>


<pre><span class="keyword">val</span> <a name="VALsv_type"></a>sv_type : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEsv_t">sv_t</a></code></pre><div class="info">
Return the type of data contained in an <code class="code">SV</code>. Somewhat equivalent to
 calling Perl's <code class="code">ref</code> function.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALstring_of_sv_t"></a>string_of_sv_t : <code class="type"><a href="Perl.html#TYPEsv_t">sv_t</a> -> string</code></pre><div class="info">
Return a printable string for an <code class="code">sv_t</code> (<code class="code">SV</code> type).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALreftype"></a>reftype : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEsv_t">sv_t</a></code></pre><div class="info">
The parameter <code class="code">sv</code> must be a reference.  This convenience function
 works out what it is a reference to, either a scalar, array, hash,
 code or glob.  If the parameter is not a reference, or is a reference
 to an unknown type, then this will throw <code class="code">Invalid_argument</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALaddress_of_sv"></a>address_of_sv : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> Nativeint.t</code></pre><div class="info">
Returns the address of the SV.  Useful for debugging since
 Perl also prints out addresses on internal errors.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALaddress_of_av"></a>address_of_av : <code class="type"><a href="Perl.html#TYPEav">av</a> -> Nativeint.t</code></pre><div class="info">
Returns the address of the AV.  Useful for debugging since
 Perl also prints out addresses on internal errors.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALaddress_of_hv"></a>address_of_hv : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> Nativeint.t</code></pre><div class="info">
Returns the address of the HV.  Useful for debugging since
 Perl also prints out addresses on internal errors.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALscalarref"></a>scalarref : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Given a scalar, this returns a reference to the scalar. Note that
 because references are <code class="code">SV</code>s, this returns <code class="code">sv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALarrayref"></a>arrayref : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Given an array, this returns a reference to the array. Note that
 because references are <code class="code">SV</code>s, this returns <code class="code">sv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhashref"></a>hashref : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Given a hash, this returns a reference to the hash. Note that
 because references are <code class="code">SV</code>s, this returns <code class="code">sv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALderef"></a>deref : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
The input is a reference to a scalar. This returns the underlying
 scalar <code class="code">SV</code>. If the input is not a reference to a scalar, throws
 <code class="code">Invalid_argument</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALderef_array"></a>deref_array : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEav">av</a></code></pre><div class="info">
The input is a reference to an array. This returns the underlying
 array <code class="code">AV</code>. If the input is not a reference to an array, throws
 <code class="code">Invalid_argument</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALderef_hash"></a>deref_hash : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> <a href="Perl.html#TYPEhv">hv</a></code></pre><div class="info">
The input is a reference to a hash. This returns the underlying
 hash <code class="code">HV</code>. If the input is not a reference to a hash, throws
 <code class="code">Invalid_argument</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_empty"></a>av_empty : <code class="type">unit -> <a href="Perl.html#TYPEav">av</a></code></pre><div class="info">
Create an empty <code class="code">AV</code> (array).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_of_sv_list"></a>av_of_sv_list : <code class="type"><a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEav">av</a></code></pre><div class="info">
Create an array from a list of <code class="code">SVs</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_push"></a>av_push : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a> -> unit</code></pre><div class="info">
Append the <code class="code">SV</code> to the end of the array. Same as Perl
 <code class="code">push @av, $sv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_pop"></a>av_pop : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Remove the <code class="code">SV</code> at the end of the array and return it. Same as
 Perl <code class="code">$sv = pop @av</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_shift"></a>av_shift : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Remove the <code class="code">SV</code> at the beginning of the array and return it. Same as
 Perl <code class="code">$sv = shift @av</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_unshift"></a>av_unshift : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a> -> unit</code></pre><div class="info">
Prepend the <code class="code">SV</code> to the start of the array. Same as Perl
 <code class="code">unshift @av, $sv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_length"></a>av_length : <code class="type"><a href="Perl.html#TYPEav">av</a> -> int</code></pre><div class="info">
Return the length of the <code class="code">AV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_set"></a>av_set : <code class="type"><a href="Perl.html#TYPEav">av</a> -> int -> <a href="Perl.html#TYPEsv">sv</a> -> unit</code></pre><div class="info">
Replace the i'th element of the <code class="code">AV</code> with <code class="code">SV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_get"></a>av_get : <code class="type"><a href="Perl.html#TYPEav">av</a> -> int -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Get the i'th element of the <code class="code">AV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_clear"></a>av_clear : <code class="type"><a href="Perl.html#TYPEav">av</a> -> unit</code></pre><div class="info">
Remove all elements from the <code class="code">AV</code>. Same as Perl <code class="code">@av = ()</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_undef"></a>av_undef : <code class="type"><a href="Perl.html#TYPEav">av</a> -> unit</code></pre><div class="info">
Delete the <code class="code">AV</code> (and all elements in it). Same as Perl <code class="code">undef @av</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_extend"></a>av_extend : <code class="type"><a href="Perl.html#TYPEav">av</a> -> int -> unit</code></pre><div class="info">
Extend the <code class="code">AV</code> so it contains at least <code class="code">n+1</code> elements.  Note that
 this apparently just changes the amount of allocated storage.  The
 extra elements are not visible until you store something in them.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_map"></a>av_map : <code class="type">(<a href="Perl.html#TYPEsv">sv</a> -> 'a) -> <a href="Perl.html#TYPEav">av</a> -> 'a list</code></pre><div class="info">
Map a function over the elements in the <code class="code">AV</code>, return a list of the
 results.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlist_of_av"></a>list_of_av : <code class="type"><a href="Perl.html#TYPEav">av</a> -> <a href="Perl.html#TYPEsv">sv</a> list</code></pre><div class="info">
Convert an <code class="code">AV</code> into a simple list of <code class="code">SV</code>s.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALav_of_string_list"></a>av_of_string_list : <code class="type">string list -> <a href="Perl.html#TYPEav">av</a></code></pre><div class="info">
Build an <code class="code">AV</code> from a list of strings.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_empty"></a>hv_empty : <code class="type">unit -> <a href="Perl.html#TYPEhv">hv</a></code></pre><div class="info">
Create an empty <code class="code">HV</code> (hash).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_set"></a>hv_set : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string -> <a href="Perl.html#TYPEsv">sv</a> -> unit</code></pre><div class="info">
Store the given <code class="code">SV</code> in the named key in the hash.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_get"></a>hv_get : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Return the <code class="code">SV</code> at the key in the hash. Throws <code class="code">Not_found</code> if no key.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_exists"></a>hv_exists : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string -> bool</code></pre><div class="info">
Return true if the hash contains the given key. Same as Perl <code class="code">exists</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_delete"></a>hv_delete : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string -> unit</code></pre><div class="info">
Delete the given key from the hash. Same as Perl <code class="code">delete</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_clear"></a>hv_clear : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> unit</code></pre><div class="info">
Remove all elements from the <code class="code">HV</code>. Same as Perl <code class="code">%av = ()</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_undef"></a>hv_undef : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> unit</code></pre><div class="info">
Delete the <code class="code">HV</code> (and all elements in it). Same as Perl <code class="code">undef %hv</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_of_assoc"></a>hv_of_assoc : <code class="type">(string * <a href="Perl.html#TYPEsv">sv</a>) list -> <a href="Perl.html#TYPEhv">hv</a></code></pre><div class="info">
Create an <code class="code">HV</code> directly from an assoc list.  Perl hashes cannot
 support multiple values attached to the same key, so if you try
 to provide an assoc list with multiple identical keys, the results
 will be undefined.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALassoc_of_hv"></a>assoc_of_hv : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> (string * <a href="Perl.html#TYPEsv">sv</a>) list</code></pre><div class="info">
Take an <code class="code">HV</code> and return an assoc list.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_keys"></a>hv_keys : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string list</code></pre><div class="info">
Return all the keys of an <code class="code">HV</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhv_values"></a>hv_values : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> <a href="Perl.html#TYPEsv">sv</a> list</code></pre><div class="info">
Return all the values of an <code class="code">HV</code>.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEhe"></a><code class="type"></code>he </pre>

<pre><span class="keyword">val</span> <a name="VALhv_iterinit"></a>hv_iterinit : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> Int32.t</code></pre><pre><span class="keyword">val</span> <a name="VALhv_iternext"></a>hv_iternext : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> <a href="Perl.html#TYPEhe">he</a></code></pre><pre><span class="keyword">val</span> <a name="VALhv_iterkey"></a>hv_iterkey : <code class="type"><a href="Perl.html#TYPEhe">he</a> -> string</code></pre><pre><span class="keyword">val</span> <a name="VALhv_iterval"></a>hv_iterval : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> <a href="Perl.html#TYPEhe">he</a> -> <a href="Perl.html#TYPEsv">sv</a></code></pre><pre><span class="keyword">val</span> <a name="VALhv_iternextsv"></a>hv_iternextsv : <code class="type"><a href="Perl.html#TYPEhv">hv</a> -> string * <a href="Perl.html#TYPEsv">sv</a></code></pre><pre><span class="keyword">val</span> <a name="VALget_sv"></a>get_sv : <code class="type">?create:bool -> string -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Return a scalar value by name. For example, if you have a symbol
 called <code class="code">$a</code> in Perl, then <code class="code">get_sv "a"</code> will return its value.
<p>

 If the symbol does not exist, this throws <code class="code">Not_found</code>.
<p>

 If the optional <code class="code">?create</code> argument is set to true and the symbol does
 not exist, then Perl will create the symbol (with value <code class="code">undef</code>) and
 this function will return the <code class="code">SV</code> for <code class="code">undef</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget_av"></a>get_av : <code class="type">?create:bool -> string -> <a href="Perl.html#TYPEav">av</a></code></pre><div class="info">
Same as <a href="Perl.html#VALget_sv"><code class="code">Perl.get_sv</code></a> except will return and/or create <code class="code">@a</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget_hv"></a>get_hv : <code class="type">?create:bool -> string -> <a href="Perl.html#TYPEhv">hv</a></code></pre><div class="info">
Same as <a href="Perl.html#VALget_sv"><code class="code">Perl.get_sv</code></a> except will return and/or create <code class="code">%a</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall"></a>call : <code class="type">?sv:<a href="Perl.html#TYPEsv">sv</a> -> ?fn:string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
Call a Perl function in a scalar context, either by name (using the <code class="code">?fn</code>
 parameter) or by calling a string/CODEREF (using the <code class="code">?sv</code> parameter).
<p>

 Returns the Perl <code class="code">SV</code> containing the result value. (See
 <a href="Perl.html#VALint_of_sv"><code class="code">Perl.int_of_sv</code></a> etc.).
<p>

 If the Perl code calls <code class="code">die</code> then this will throw <code class="code">Perl_failure</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_array"></a>call_array : <code class="type">?sv:<a href="Perl.html#TYPEsv">sv</a> -> ?fn:string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a> list</code></pre><div class="info">
Call a Perl function in an array context, either by name (using the <code class="code">?fn</code>
 parameter) or by calling a string/CODEREF (using the <code class="code">?sv</code> parameter).
<p>

 Returns the list of results.
<p>

 If the Perl code calls <code class="code">die</code> then this will throw <code class="code">Perl_failure</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_void"></a>call_void : <code class="type">?sv:<a href="Perl.html#TYPEsv">sv</a> -> ?fn:string -> <a href="Perl.html#TYPEsv">sv</a> list -> unit</code></pre><div class="info">
Call a Perl function in a void context, either by name (using the <code class="code">?fn</code>
 parameter) or by calling a string/CODEREF (using the <code class="code">?sv</code> parameter).
<p>

 Any results are discarded.
<p>

 If the Perl code calls <code class="code">die</code> then this will throw <code class="code">Perl_failure</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALeval"></a>eval : <code class="type">string -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
This is exactly like the Perl <code class="code">eval</code> command. It evaluates a piece of
 Perl code (in scalar context) and returns the result (a Perl <code class="code">SV</code>).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_method"></a>call_method : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
<code class="code">call_method obj name [parameters]</code> calls the method <code class="code">name</code> on the Perl
 object <code class="code">obj</code> with the given parameters, in a scalar context. Thus this
 is equivalent to <code class="code">$obj-&gt;name (parameters)</code>.
<p>

 Returns the Perl <code class="code">SV</code> containing the result value.
<p>

 If the method calls <code class="code">die</code> then this will throw <code class="code">Perl_failure</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_method_array"></a>call_method_array : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a> list</code></pre><div class="info">
Like <code class="code">call_method</code>, but the method is called in an array context.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_method_void"></a>call_method_void : <code class="type"><a href="Perl.html#TYPEsv">sv</a> -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> unit</code></pre><div class="info">
Like <code class="code">call_method</code>, but the method is called in a void context (results
 are discarded).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_class_method"></a>call_class_method : <code class="type">string -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a></code></pre><div class="info">
<code class="code">call_class_method classname name [parameters]</code> calls the static method
 <code class="code">name</code> in the Perl class <code class="code">classname</code> with the given parameters, in a
 scalar context. Thus this is equivalent to <code class="code">$classname-&gt;name (parameters)</code>.
<p>

 Returns the Perl <code class="code">SV</code> containing the result value.
<p>

 If the static method calls <code class="code">die</code> then this will throw <code class="code">Perl_failure</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_class_method_array"></a>call_class_method_array : <code class="type">string -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> <a href="Perl.html#TYPEsv">sv</a> list</code></pre><div class="info">
Like <code class="code">call_class_method</code>, but the method is called in an array context.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcall_class_method_void"></a>call_class_method_void : <code class="type">string -> string -> <a href="Perl.html#TYPEsv">sv</a> list -> unit</code></pre><div class="info">
Like <code class="code">call_class_method</code>, but the method is called in a void context.<br>
</div>
</body></html>
libperl4caml-ocaml-doc 0.9.5-4 / usr / share / doc / libperl4caml-ocaml-doc / html / Perl.html
