1 (* Interface to Perl from OCaml.
3 Copyright (C) 2003 Merjis Ltd.
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this library; see the file COPYING. If not, write to
17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
20 $Id: perl.ml,v 1.16 2008-03-01 13:02:21 rich Exp $
27 exception Perl_failure of string
29 (* Initialization. This must happen first, otherwise other parts of the
30 * program will segfault because of a missing interpreter.
32 external c_init : unit -> unit = "perl4caml_init"
34 Callback.register_exception "perl4caml_perl_failure" (Perl_failure "");
35 c_init (); (* Initialise C code. *)
38 external int_of_sv : sv -> int = "perl4caml_int_of_sv"
39 external sv_of_int : int -> sv = "perl4caml_sv_of_int"
40 external float_of_sv : sv -> float = "perl4caml_float_of_sv"
41 external sv_of_float : float -> sv = "perl4caml_sv_of_float"
42 external string_of_sv : sv -> string = "perl4caml_string_of_sv"
43 external sv_of_string : string -> sv = "perl4caml_sv_of_string"
44 external sv_is_true : sv -> bool = "perl4caml_sv_is_true"
45 external sv_undef : unit -> sv = "perl4caml_sv_undef"
46 external sv_is_undef : sv -> bool = "perl4caml_sv_is_undef"
47 external sv_yes : unit -> sv = "perl4caml_sv_yes"
48 external sv_no : unit -> sv = "perl4caml_sv_no"
50 let sv_true () = sv_of_int 1
51 let sv_false () = sv_of_int 0
53 let bool_of_sv = sv_is_true
54 let sv_of_bool b = if b then sv_true () else sv_false ()
67 external sv_type : sv -> sv_t = "perl4caml_sv_type"
69 let string_of_sv_t = function
70 SVt_NULL -> "SVt_NULL"
75 | SVt_PVAV -> "SVt_PVAV"
76 | SVt_PVHV -> "SVt_PVHV"
77 | SVt_PVCV -> "SVt_PVCV"
78 | SVt_PVGV -> "SVt_PVGV"
79 | SVt_PVMG -> "SVt_PVMG"
81 external reftype : sv -> sv_t = "perl4caml_reftype"
83 external address_of_sv : sv -> Nativeint.t = "perl4caml_address_of_sv"
84 external address_of_av : av -> Nativeint.t = "perl4caml_address_of_av"
85 external address_of_hv : hv -> Nativeint.t = "perl4caml_address_of_hv"
87 external scalarref : sv -> sv = "perl4caml_scalarref"
88 external arrayref : av -> sv = "perl4caml_arrayref"
89 external hashref : hv -> sv = "perl4caml_hashref"
91 external deref : sv -> sv = "perl4caml_deref"
92 external deref_array : sv -> av = "perl4caml_deref_array"
93 external deref_hash : sv -> hv = "perl4caml_deref_hash"
95 external av_empty : unit -> av = "perl4caml_av_empty"
96 external av_of_sv_list : sv list -> av = "perl4caml_av_of_sv_list"
97 external av_push : av -> sv -> unit = "perl4caml_av_push"
98 external av_pop : av -> sv = "perl4caml_av_pop"
99 external av_shift : av -> sv = "perl4caml_av_shift"
100 external av_unshift : av -> sv -> unit = "perl4caml_av_unshift"
101 external av_length : av -> int = "perl4caml_av_length"
102 external av_set : av -> int -> sv -> unit = "perl4caml_av_set"
103 external av_get : av -> int -> sv = "perl4caml_av_get"
104 external av_clear : av -> unit = "perl4caml_av_clear"
105 external av_undef : av -> unit = "perl4caml_av_undef"
106 external av_extend : av -> int -> unit = "perl4caml_av_extend"
110 for i = 0 to av_length av - 1 do
111 list := f (av_get av i) :: !list
117 for i = 0 to av_length av - 1 do
118 list := av_get av i :: !list
122 let av_of_string_list strs =
123 av_of_sv_list (List.map sv_of_string strs)
125 external hv_empty : unit -> hv = "perl4caml_hv_empty"
126 external hv_set : hv -> string -> sv -> unit = "perl4caml_hv_set"
127 external hv_get : hv -> string -> sv = "perl4caml_hv_get"
128 external hv_exists : hv -> string -> bool = "perl4caml_hv_exists"
129 external hv_delete : hv -> string -> unit = "perl4caml_hv_delete"
130 external hv_clear : hv -> unit = "perl4caml_hv_clear"
131 external hv_undef : hv -> unit = "perl4caml_hv_undef"
134 external hv_iterinit : hv -> Int32.t = "perl4caml_hv_iterinit"
135 external hv_iternext : hv -> he = "perl4caml_hv_iternext"
136 external hv_iterkey : he -> string = "perl4caml_hv_iterkey"
137 external hv_iterval : hv -> he -> sv = "perl4caml_hv_iterval"
138 external hv_iternextsv : hv -> string * sv = "perl4caml_hv_iternextsv"
141 let hv = hv_empty () in
142 List.iter (fun (k, v) -> hv_set hv k v) xs;
145 ignore (hv_iterinit hv);
146 (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
149 let k, v = hv_iternextsv hv in
156 ignore (hv_iterinit hv);
157 (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
160 let he = hv_iternext hv in
161 let k = hv_iterkey he in
168 ignore (hv_iterinit hv);
169 (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
172 let he = hv_iternext hv in
173 let v = hv_iterval hv he in
180 external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv"
181 external get_av : ?create:bool -> string -> av = "perl4caml_get_av"
182 external get_hv : ?create:bool -> string -> hv = "perl4caml_get_hv"
184 external call : ?sv:sv -> ?fn:string -> sv list -> sv
186 external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list
187 = "perl4caml_call_array"
188 external call_void : ?sv:sv -> ?fn:string -> sv list -> unit
189 = "perl4caml_call_void"
191 external eval : string -> sv
194 external call_method : sv -> string -> sv list -> sv
195 = "perl4caml_call_method"
196 external call_method_array : sv -> string -> sv list -> sv list
197 = "perl4caml_call_method_array"
198 external call_method_void : sv -> string -> sv list -> unit
199 = "perl4caml_call_method_void"
200 external call_class_method : string -> string -> sv list -> sv
201 = "perl4caml_call_class_method"
202 external call_class_method_array : string -> string -> sv list -> sv list
203 = "perl4caml_call_class_method_array"
204 external call_class_method_void : string -> string -> sv list -> unit
205 = "perl4caml_call_class_method_void"