X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=perl.mli;h=831d69b18fd8984d283db4e9d26d79bc3691880a;hb=432e85196383810d7f6d4e695c758a8d17b96f2b;hp=2c60907e6318afc580b66bd32a0874889c8a26b5;hpb=1c369c3ba6b71d4524dfacd0ba3554e8a524ed57;p=perl4caml.git diff --git a/perl.mli b/perl.mli index 2c60907..831d69b 100644 --- a/perl.mli +++ b/perl.mli @@ -2,7 +2,7 @@ * * Copyright (C) 2003 Merjis Ltd. * - * $Id: perl.mli,v 1.4 2003-10-12 17:33:14 rich Exp $ + * $Id: perl.mli,v 1.10 2003-10-26 11:22:38 rich Exp $ *) type t @@ -11,26 +11,53 @@ type t 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 init : unit -> unit -(** Don't call this. Instead link your program with [perl_init.cmo] or - * [perl_init.cmx] which calls this for you. - *) +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}. +*) -external destroy : unit -> unit - = "perl4caml_destroy" -(** Destroy the current Perl interpreter, performing any necessary cleanup. - * You should call this at the end of your program, otherwise Perl won't - * properly clean up. +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}. *) -external create : ?args:string array -> unit -> t - = "perl4caml_create" +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). * @@ -46,8 +73,7 @@ external create : ?args:string array -> unit -> t * The newly created interpreter is set as the "current interpreter". *) -external set_context : t -> unit - = "perl4caml_set_context" +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. @@ -55,42 +81,42 @@ external set_context : t -> unit * Most users will never need to call this function. *) -external int_of_sv : sv -> int = "perl4caml_int_of_sv" +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, * so you may get a silent overflow. *) -external sv_of_int : int -> sv = "perl4caml_sv_of_int" +val sv_of_int : int -> sv (** Convert an [int] into a Perl [SV]. *) -external float_of_sv : sv -> int = "perl4caml_float_of_sv" +val float_of_sv : sv -> float (** Convert a Perl [SV] into a float. *) -external sv_of_float : int -> sv = "perl4caml_sv_of_float" +val sv_of_float : float -> sv (** Convert a [float] into a Perl [SV]. *) -external string_of_sv : sv -> string = "perl4caml_string_of_sv" +val string_of_sv : sv -> string (** Convert a Perl [SV] into a string. *) -external sv_of_string : string -> sv = "perl4caml_sv_of_string" +val sv_of_string : string -> sv (** Convert a [string] into a Perl [SV]. *) val bool_of_sv : sv -> bool (** Convert an [SV] into a boolean. *) val sv_of_bool : bool -> sv (** Convert a boolean into an [SV]. *) -external sv_is_true : sv -> bool = "perl4caml_sv_is_true" +val sv_is_true : sv -> bool (** Return [true] if the [SV] is "true" (in the Perl sense of truth). *) -external sv_is_undef : sv -> bool = "perl4caml_sv_is_undef" +val sv_is_undef : sv -> bool (** Return [true] if the [SV] is undefined (is [undef]). *) -external sv_undef : unit -> sv = "perl4caml_sv_undef" +val sv_undef : unit -> sv (** Returns [undef]. *) val sv_true : unit -> sv (** Returns an [SV] which is true. *) val sv_false : unit -> sv (** Returns an [SV] which is false. *) -external sv_yes : unit -> sv = "perl4caml_sv_yes" +val sv_yes : unit -> sv (** Returns Perl's internal [PL_sv_yes]. (There are some unresolved issues - * with using this, so use {!sv_true} instead). *) -external sv_no : unit -> sv = "perl4caml_sv_no" + * with using this, so use {!Perl.sv_true} instead). *) +val sv_no : unit -> sv (** Returns Perl's internal [PL_sv_no]. (There are some unresolved issues - * with using this, so use {!sv_false} instead). *) + * with using this, so use {!Perl.sv_false} instead). *) (* Actually there are many more types defined than this ... *) type sv_t = SVt_NULL @@ -103,30 +129,94 @@ type sv_t = SVt_NULL | SVt_PVCV (** Code ref. *) | SVt_PVGV (** Glob. *) | SVt_PVMG (** Blessed or magical scalar. *) -external sv_type : sv -> sv_t = "perl4caml_sv_type" +val sv_type : sv -> sv_t (** Return the type of data contained in an [SV]. Somewhat equivalent to * calling Perl's [ref] function. *) +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]. + *) -external deref : sv -> sv = "perl4caml_deref" +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 * [Invalid_arg]. *) -(* -external deref_array : sv -> av = "perl4caml_deref_array" +val deref_array : sv -> av (** The input is a reference to an array. This returns the underlying * array [AV]. If the input is not a reference to an array, throws * [Invalid_arg]. *) -external deref_hash : sv -> hv = "perl4caml_deref_hash" +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]. *) -*) -external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv" +val av_empty : unit -> av +(** Create an empty [AV] (array). *) +val av_of_sv_list : sv list -> av +(** Create an array from a list of [SVs]. *) +val av_push : av -> sv -> unit +(** Append the [SV] to the end of the array. Same as Perl + * [push \@av, $sv]. *) +val av_pop : av -> sv +(** Remove the [SV] at the end of the array and return it. Same as + * Perl [$sv = pop \@av]. *) +val av_shift : av -> sv +(** Remove the [SV] at the beginning of the array and return it. Same as + * Perl [$sv = shift \@av]. *) +val av_unshift : av -> sv -> unit +(** Prepend the [SV] to the start of the array. Same as Perl + * [unshift \@av, $sv]. *) +val av_length : av -> int +(** Return the length of the [AV]. *) +val av_set : av -> int -> sv -> unit +(** Replace the i'th element of the [AV] with [SV]. *) +val av_get : av -> int -> sv +(** Get the i'th element of the [AV]. *) +val av_clear : av -> unit +(** Remove all elements from the [AV]. Same as Perl [\@av = ()]. *) +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. *) +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 * called [$a] in Perl, then [get_sv "a"] will return its value. * @@ -136,19 +226,22 @@ external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv" * 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]. *) +val get_hv : ?create:bool -> string -> hv +(** Same as {!Perl.get_sv} except will return and/or create [%a]. *) -external call : ?sv:sv -> ?fn:string -> sv list -> sv - = "perl4caml_call" +val call : ?sv:sv -> ?fn:string -> sv list -> sv (** Call a Perl function in a scalar context, either by name (using the [?fn] * parameter) or by calling a string/CODEREF (using the [?sv] parameter). * - * Returns the Perl [SV] containing the result value. (See {!int_of_sv} etc.). + * Returns the Perl [SV] containing the result value. (See + * {!Perl.int_of_sv} etc.). * * If the Perl code calls [die] then this will throw [Perl_failure]. *) -external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list - = "perl4caml_call_array" +val call_array : ?sv:sv -> ?fn:string -> sv list -> sv list (** Call a Perl function in an array context, either by name (using the [?fn] * parameter) or by calling a string/CODEREF (using the [?sv] parameter). * @@ -157,8 +250,7 @@ external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list * If the Perl code calls [die] then this will throw [Perl_failure]. *) -external call_void : ?sv:sv -> ?fn:string -> sv list -> unit - = "perl4caml_call_void" +val call_void : ?sv:sv -> ?fn:string -> sv list -> unit (** Call a Perl function in a void context, either by name (using the [?fn] * parameter) or by calling a string/CODEREF (using the [?sv] parameter). * @@ -167,14 +259,12 @@ external call_void : ?sv:sv -> ?fn:string -> sv list -> unit * If the Perl code calls [die] then this will throw [Perl_failure]. *) -external eval : string -> sv - = "perl4caml_eval" +val eval : string -> sv (** This is exactly like the Perl [eval] command. It evaluates a piece of * Perl code (in scalar context) and returns the result (a Perl [SV]). *) -external call_method : sv -> string -> sv list -> sv - = "perl4caml_call_method" +val call_method : sv -> string -> sv list -> sv (** [call_method obj name [parameters]] calls the method [name] on the Perl * object [obj] with the given parameters, in a scalar context. Thus this * is equivalent to [$obj->name (parameters)]. @@ -184,17 +274,14 @@ external call_method : sv -> string -> sv list -> sv * If the method calls [die] then this will throw [Perl_failure]. *) -external call_method_array : sv -> string -> sv list -> sv list - = "perl4caml_call_method_array" +val call_method_array : sv -> string -> sv list -> sv list (** Like [call_method], but the method is called in an array context. *) -external call_method_void : sv -> string -> sv list -> unit - = "perl4caml_call_method_void" +val call_method_void : sv -> string -> sv list -> unit (** Like [call_method], but the method is called in a void context (results * are discarded). *) -external call_class_method : string -> string -> sv list -> sv - = "perl4caml_call_class_method" +val call_class_method : string -> string -> sv list -> sv (** [call_class_method classname name [parameters]] calls the static method * [name] in the Perl class [classname] with the given parameters, in a * scalar context. Thus this is equivalent to [$classname->name (parameters)]. @@ -204,10 +291,8 @@ external call_class_method : string -> string -> sv list -> sv * If the static method calls [die] then this will throw [Perl_failure]. *) -external call_class_method_array : string -> string -> sv list -> sv list - = "perl4caml_call_class_method_array" +val call_class_method_array : string -> string -> sv list -> sv list (** Like [call_class_method], but the method is called in an array context. *) -external call_class_method_void : string -> string -> sv list -> unit - = "perl4caml_call_class_method_void" +val call_class_method_void : string -> string -> sv list -> unit (** Like [call_class_method], but the method is called in a void context. *)