X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=perl.mli;h=64d7904eb633bcc410f796d19e289bca49931bb5;hb=95d760554441dac36fb77011c0c875490f873d68;hp=778de580a7d0165fc80b1c945e6041f6a0bb4995;hpb=7e4c9fd14a6ece5941cadec586daaf4ab8f02d39;p=perl4caml.git diff --git a/perl.mli b/perl.mli index 778de58..64d7904 100644 --- a/perl.mli +++ b/perl.mli @@ -1,8 +1,22 @@ -(** Interface to Perl from OCaml. - * - * Copyright (C) 2003 Merjis Ltd. - * - * $Id: perl.mli,v 1.12 2004-03-03 12:39:20 rich Exp $ +(** Interface to Perl from OCaml. *) +(* Copyright (C) 2003 Merjis Ltd. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this library; see the file COPYING. If not, write to + the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + + $Id: perl.mli,v 1.16 2008-03-01 13:02:21 rich Exp $ *) type sv @@ -60,10 +74,10 @@ type sv_t = SVt_NULL | SVt_NV (** Floating point scalar. *) | SVt_PV (** String scalar. *) | SVt_RV (** Reference. *) - | SVt_PVAV (** Array ref. *) - | SVt_PVHV (** Hash ref. *) - | SVt_PVCV (** Code ref. *) - | SVt_PVGV (** Glob. *) + | SVt_PVAV (** Array. *) + | SVt_PVHV (** Hash. *) + | SVt_PVCV (** Code. *) + | SVt_PVGV (** Glob (possibly a file handle). *) | SVt_PVMG (** Blessed or magical scalar. *) val sv_type : sv -> sv_t (** Return the type of data contained in an [SV]. Somewhat equivalent to @@ -72,6 +86,25 @@ val sv_type : sv -> sv_t val string_of_sv_t : sv_t -> string (** Return a printable string for an [sv_t] ([SV] type). *) +val reftype : sv -> sv_t +(** The parameter [sv] 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 [Invalid_argument]. *) + +val address_of_sv : sv -> Nativeint.t +(** Returns the address of the SV. Useful for debugging since + * Perl also prints out addresses on internal errors. + *) +val address_of_av : av -> Nativeint.t +(** Returns the address of the AV. Useful for debugging since + * Perl also prints out addresses on internal errors. + *) +val address_of_hv : hv -> Nativeint.t +(** Returns the address of the HV. Useful for debugging since + * Perl also prints out addresses on internal errors. + *) + val scalarref : sv -> sv (** Given a scalar, this returns a reference to the scalar. Note that * because references are [SV]s, this returns [sv]. @@ -128,7 +161,10 @@ val av_clear : av -> unit val av_undef : av -> unit (** Delete the [AV] (and all elements in it). Same as Perl [undef \@av]. *) val av_extend : av -> int -> unit -(** Extend the [AV] so it contains at least [n+1] elements. *) +(** Extend the [AV] so it contains at least [n+1] elements. Note that + * this apparently just changes the amount of allocated storage. The + * extra elements are not visible until you store something in them. + *) val av_map : (sv -> 'a) -> av -> 'a list (** Map a function over the elements in the [AV], return a list of the * results. *) @@ -151,16 +187,40 @@ val hv_clear : hv -> unit (** Remove all elements from the [HV]. Same as Perl [%av = ()]. *) val hv_undef : hv -> unit (** Delete the [HV] (and all elements in it). Same as Perl [undef %hv]. *) +val hv_of_assoc : (string * sv) list -> hv +(** Create an [HV] 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. + *) +val assoc_of_hv : hv -> (string * sv) list +(** Take an [HV] and return an assoc list. *) +val hv_keys : hv -> string list +(** Return all the keys of an [HV]. *) +val hv_values : hv -> sv list +(** Return all the values of an [HV]. *) + +(* The following are the low-level iteration interface to hashes, + * which you probably shouldn't use directly. Use {!hv_keys}, + * {!assoc_of_hv}, etc. instead. See [perlguts(3)] if you really + * want to use this interface. + *) +type he +val hv_iterinit : hv -> Int32.t +val hv_iternext : hv -> he +val hv_iterkey : he -> string +val hv_iterval : hv -> he -> sv +val hv_iternextsv : hv -> string * sv val get_sv : ?create:bool -> string -> sv -(** Return a scalar value by name. For example, if you have a symbol - * called [$a] in Perl, then [get_sv "a"] will return its value. - * - * If the symbol does not exist, this throws [Not_found]. - * - * If the optional [?create] argument is set to true and the symbol does - * not exist, then Perl will create the symbol (with value [undef]) and - * this function will return the [SV] for [undef]. + (** Return a scalar value by name. For example, if you have a symbol + * called [$a] in Perl, then [get_sv "a"] will return its value. + * + * If the symbol does not exist, this throws [Not_found]. + * + * If the optional [?create] argument is set to true and the symbol does + * not exist, then Perl will create the symbol (with value [undef]) and + * this function will return the [SV] for [undef]. *) val get_av : ?create:bool -> string -> av (** Same as {!Perl.get_sv} except will return and/or create [\@a]. *)