*
* Copyright (C) 2003 Merjis Ltd.
*
- * $Id: perl.mli,v 1.8 2003-10-16 13:41:06 rich Exp $
+ * $Id: perl.mli,v 1.11 2003-12-11 17:41:52 rich Exp $
*)
-type t
-(** Perl interpreter (abstract type). *)
-
type sv
(** Perl scalar value. *)
type av
(** Perl array value. *)
-(*
type hv
(** Perl hash value. *)
-*)
exception Perl_failure of string
(** [die] in Perl code is translated automatically into this exception. *)
-val current_interpreter : unit -> t
-(** The [Perl] module has a notion of the "current" interpreter. Throws
- * [Not_found] if there is no current interpreter.
- *
- * When a program starts up, if it has been linked with [perl_init.cmo]
- * (which is should be), an interpreter is created for you. Normally
- * this should be all you need to know about interpreters, unless you
- * want to be really good and call
- * [Perl.destroy (Perl.current_interpreter ())] at the end of your
- * program to do proper cleanup.
- *
- * You can also, under certain circumstances, create other interpreters,
- * although this is experiemental and definitely not recommended.
- *
- * If Perl was compiled with [-Dusemultiplicity] then you can create
- * mutliple interpreters at the same time and switch between them by
- * calling {!Perl.set_context}.
- *
- * Otherwise you may destroy the current interpreter and create another
- * one (provided that at no time you have two "live" interpreters),
- * by calling {!Perl.destroy} followed by {!Perl.create}.
-*)
-
-val destroy : t -> unit
-(** Destroy the Perl interpreter, performing any necessary cleanup.
- *
- * You should call [Perl.destroy (Perl.current_interpreter ())] at
- * the end of your program, otherwise Perl won't properly clean up
- * (running [END] blocks, destroying objects and the like).
- *
- * Note that a Perl interpreter is created for you by default when you
- * use perl4caml.
- *
- * The current interpreter can be found by calling
- * {!Perl.current_interpreter}.
- *)
-
-val create : ?args:string array -> unit -> t
-(** Create a new Perl interpreter. (Note that a Perl interpreter is created
- * for you by default so you don't need to call this).
- *
- * The optional [?args] parameter is the command line passed to the
- * interpreter, and controls things like whether warnings are enabled
- * ([-w]) and which file(s) are parsed. The first element in the
- * array is the executable name (you can just set this to [""]).
- *
- * Perl won't allow you to create multiple interpreters at the same time
- * unless Perl itself was compiled with [-Dusemultiplicity]. However you
- * can create, then destroy, then create another and so on.
- *
- * The newly created interpreter is set as the "current interpreter".
- *)
-
-val set_context : t -> unit
-(** IF Perl was compiled with [-Dusemultiplicity] and IF you are using
- * multiple interpreters at the same time, then you must call this to
- * set the implied "current" interpreter.
- *
- * Most users will never need to call this function.
- *)
-
val int_of_sv : sv -> int
(** Convert a Perl [SV] into an integer. Note that OCaml [int]s aren't
* large enough to store the full 32 (or 64) bits from a Perl integer,
*)
val sv_of_int : int -> sv
(** Convert an [int] into a Perl [SV]. *)
-val float_of_sv : sv -> int
+val float_of_sv : sv -> float
(** Convert a Perl [SV] into a float. *)
-val sv_of_float : int -> sv
+val sv_of_float : float -> sv
(** Convert a [float] into a Perl [SV]. *)
val string_of_sv : sv -> string
(** Convert a Perl [SV] into a string. *)
val string_of_sv_t : sv_t -> string
(** Return a printable string for an [sv_t] ([SV] type). *)
+val scalarref : sv -> sv
+(** Given a scalar, this returns a reference to the scalar. Note that
+ * because references are [SV]s, this returns [sv].
+ *)
+val arrayref : av -> sv
+(** Given an array, this returns a reference to the array. Note that
+ * because references are [SV]s, this returns [sv].
+ *)
+val hashref : hv -> sv
+(** Given a hash, this returns a reference to the hash. Note that
+ * because references are [SV]s, this returns [sv].
+ *)
+
val deref : sv -> sv
(** The input is a reference to a scalar. This returns the underlying
* scalar [SV]. If the input is not a reference to a scalar, throws
* array [AV]. If the input is not a reference to an array, throws
* [Invalid_arg].
*)
-(*
val deref_hash : sv -> hv
(** The input is a reference to a hash. This returns the underlying
* hash [HV]. If the input is not a reference to a hash, throws
* [Invalid_arg].
*)
-*)
val av_empty : unit -> av
(** Create an empty [AV] (array). *)
val av_map : (sv -> 'a) -> av -> 'a list
(** Map a function over the elements in the [AV], return a list of the
* results. *)
+val list_of_av : av -> sv list
+(** Convert an [AV] into a simple list of [SV]s. *)
+val av_of_string_list : string list -> av
+(** Build an [AV] from a list of strings. *)
+
+val hv_empty : unit -> hv
+(** Create an empty [HV] (hash). *)
+val hv_set : hv -> string -> sv -> unit
+(** Store the given [SV] in the named key in the hash. *)
+val hv_get : hv -> string -> sv
+(** Return the [SV] at the key in the hash. Throws [Not_found] if no key. *)
+val hv_exists : hv -> string -> bool
+(** Return true if the hash contains the given key. Same as Perl [exists]. *)
+val hv_delete : hv -> string -> unit
+(** Delete the given key from the hash. Same as Perl [delete]. *)
+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 get_sv : ?create:bool -> string -> sv
(** Return a scalar value by name. For example, if you have a symbol
*)
val get_av : ?create:bool -> string -> av
(** Same as {!Perl.get_sv} except will return and/or create [\@a]. *)
+val get_hv : ?create:bool -> string -> hv
+(** Same as {!Perl.get_sv} except will return and/or create [%a]. *)
val call : ?sv:sv -> ?fn:string -> sv list -> sv
(** Call a Perl function in a scalar context, either by name (using the [?fn]
git.annexia.org / perl4caml.git / blobdiff