Added reftype operator.

[perl4caml.git] / perl.mli

diff --git a/perl.mli b/perl.mli
index f303d24..e16ada2 100644 (file)
--- a/perl.mli
+++ b/perl.mli
@@ -2,7 +2,7 @@
   *
   * Copyright (C) 2003 Merjis Ltd.
   *
-  * $Id: perl.mli,v 1.14 2005-01-29 12:22:49 rich Exp $
+  * $Id: perl.mli,v 1.15 2005-04-14 13:05:12 rich Exp $
   *)
 
 type sv
@@ -72,6 +72,12 @@ 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.