perl.ml

   1 (* Interface to Perl from OCaml.
   2  * Copyright (C) 2003 Merjis Ltd.
   3  * $Id: perl.ml,v 1.15 2005-04-14 13:05:12 rich Exp $
   4  *)
   5
   6 type sv
   7 type av
   8 type hv
   9
  10 exception Perl_failure of string
  11
  12 (* Initialization. This must happen first, otherwise other parts of the
  13  * program will segfault because of a missing interpreter.
  14  *)
  15 external c_init : unit -> unit = "perl4caml_init"
  16 let () =
  17   Callback.register_exception "perl4caml_perl_failure" (Perl_failure "");
  18   c_init ();                            (* Initialise C code. *)
  19   ()
  20
  21 external int_of_sv : sv -> int = "perl4caml_int_of_sv"
  22 external sv_of_int : int -> sv = "perl4caml_sv_of_int"
  23 external float_of_sv : sv -> float = "perl4caml_float_of_sv"
  24 external sv_of_float : float -> sv = "perl4caml_sv_of_float"
  25 external string_of_sv : sv -> string = "perl4caml_string_of_sv"
  26 external sv_of_string : string -> sv = "perl4caml_sv_of_string"
  27 external sv_is_true : sv -> bool = "perl4caml_sv_is_true"
  28 external sv_undef : unit -> sv = "perl4caml_sv_undef"
  29 external sv_is_undef : sv -> bool = "perl4caml_sv_is_undef"
  30 external sv_yes : unit -> sv = "perl4caml_sv_yes"
  31 external sv_no : unit -> sv = "perl4caml_sv_no"
  32
  33 let sv_true () = sv_of_int 1
  34 let sv_false () = sv_of_int 0
  35
  36 let bool_of_sv = sv_is_true
  37 let sv_of_bool b = if b then sv_true () else sv_false ()
  38
  39 type sv_t    = SVt_NULL
  40              | SVt_IV
  41              | SVt_NV
  42              | SVt_PV
  43              | SVt_RV
  44              | SVt_PVAV
  45              | SVt_PVHV
  46              | SVt_PVCV
  47              | SVt_PVGV
  48              | SVt_PVMG
  49
  50 external sv_type : sv -> sv_t = "perl4caml_sv_type"
  51
  52 let string_of_sv_t = function
  53     SVt_NULL  -> "SVt_NULL"
  54   | SVt_IV    -> "SVt_IV"
  55   | SVt_NV    -> "SVt_NV"
  56   | SVt_PV    -> "SVt_PV"
  57   | SVt_RV    -> "SVt_RV"
  58   | SVt_PVAV  -> "SVt_PVAV"
  59   | SVt_PVHV  -> "SVt_PVHV"
  60   | SVt_PVCV  -> "SVt_PVCV"
  61   | SVt_PVGV  -> "SVt_PVGV"
  62   | SVt_PVMG  -> "SVt_PVMG"
  63
  64 external reftype : sv -> sv_t = "perl4caml_reftype"
  65
  66 external address_of_sv : sv -> Nativeint.t = "perl4caml_address_of_sv"
  67 external address_of_av : av -> Nativeint.t = "perl4caml_address_of_av"
  68 external address_of_hv : hv -> Nativeint.t = "perl4caml_address_of_hv"
  69
  70 external scalarref : sv -> sv = "perl4caml_scalarref"
  71 external arrayref : av -> sv = "perl4caml_arrayref"
  72 external hashref : hv -> sv = "perl4caml_hashref"
  73
  74 external deref : sv -> sv = "perl4caml_deref"
  75 external deref_array : sv -> av = "perl4caml_deref_array"
  76 external deref_hash : sv -> hv = "perl4caml_deref_hash"
  77
  78 external av_empty : unit -> av = "perl4caml_av_empty"
  79 external av_of_sv_list : sv list -> av = "perl4caml_av_of_sv_list"
  80 external av_push : av -> sv -> unit = "perl4caml_av_push"
  81 external av_pop : av -> sv = "perl4caml_av_pop"
  82 external av_shift : av -> sv = "perl4caml_av_shift"
  83 external av_unshift : av -> sv -> unit = "perl4caml_av_unshift"
  84 external av_length : av -> int = "perl4caml_av_length"
  85 external av_set : av -> int -> sv -> unit = "perl4caml_av_set"
  86 external av_get : av -> int -> sv = "perl4caml_av_get"
  87 external av_clear : av -> unit = "perl4caml_av_clear"
  88 external av_undef : av -> unit = "perl4caml_av_undef"
  89 external av_extend : av -> int -> unit = "perl4caml_av_extend"
  90
  91 let av_map f av =
  92   let list = ref [] in
  93   for i = 0 to av_length av - 1 do
  94     list := f (av_get av i) :: !list
  95   done;
  96   List.rev !list
  97
  98 let list_of_av av =
  99   let list = ref [] in
 100   for i = 0 to av_length av - 1 do
 101     list := av_get av i :: !list
 102   done;
 103   List.rev !list
 104
 105 let av_of_string_list strs =
 106   av_of_sv_list (List.map sv_of_string strs)
 107
 108 external hv_empty : unit -> hv = "perl4caml_hv_empty"
 109 external hv_set : hv -> string -> sv -> unit = "perl4caml_hv_set"
 110 external hv_get : hv -> string -> sv = "perl4caml_hv_get"
 111 external hv_exists : hv -> string -> bool = "perl4caml_hv_exists"
 112 external hv_delete : hv -> string -> unit = "perl4caml_hv_delete"
 113 external hv_clear : hv -> unit = "perl4caml_hv_clear"
 114 external hv_undef : hv -> unit = "perl4caml_hv_undef"
 115
 116 type he
 117 external hv_iterinit : hv -> Int32.t = "perl4caml_hv_iterinit"
 118 external hv_iternext : hv -> he = "perl4caml_hv_iternext"
 119 external hv_iterkey : he -> string = "perl4caml_hv_iterkey"
 120 external hv_iterval : hv -> he -> sv = "perl4caml_hv_iterval"
 121 external hv_iternextsv : hv -> string * sv = "perl4caml_hv_iternextsv"
 122
 123 let hv_of_assoc xs =
 124   let hv = hv_empty () in
 125   List.iter (fun (k, v) -> hv_set hv k v) xs;
 126   hv
 127 let assoc_of_hv hv =
 128   ignore (hv_iterinit hv);
 129   (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
 130   let rec loop acc =
 131     try
 132       let k, v = hv_iternextsv hv in
 133       loop ((k, v) :: acc)
 134     with
 135         Not_found -> acc
 136   in
 137   loop []
 138 let hv_keys hv =
 139   ignore (hv_iterinit hv);
 140   (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
 141   let rec loop acc =
 142     try
 143       let he = hv_iternext hv in
 144       let k = hv_iterkey he in
 145       loop (k :: acc)
 146     with
 147         Not_found -> acc
 148   in
 149   loop []
 150 let hv_values hv =
 151   ignore (hv_iterinit hv);
 152   (* Someone please rewrite this to make it tail-rec! - Rich. XXX *)
 153   let rec loop acc =
 154     try
 155       let he = hv_iternext hv in
 156       let v = hv_iterval hv he in
 157       loop (v :: acc)
 158     with
 159         Not_found -> acc
 160   in
 161   loop []
 162
 163 external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv"
 164 external get_av : ?create:bool -> string -> av = "perl4caml_get_av"
 165 external get_hv : ?create:bool -> string -> hv = "perl4caml_get_hv"
 166
 167 external call : ?sv:sv -> ?fn:string -> sv list -> sv
 168   = "perl4caml_call"
 169 external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list
 170   = "perl4caml_call_array"
 171 external call_void : ?sv:sv -> ?fn:string -> sv list -> unit
 172   = "perl4caml_call_void"
 173
 174 external eval : string -> sv
 175   = "perl4caml_eval"
 176
 177 external call_method : sv -> string -> sv list -> sv
 178   = "perl4caml_call_method"
 179 external call_method_array : sv -> string -> sv list -> sv list
 180   = "perl4caml_call_method_array"
 181 external call_method_void : sv -> string -> sv list -> unit
 182   = "perl4caml_call_method_void"
 183 external call_class_method : string -> string -> sv list -> sv
 184   = "perl4caml_call_class_method"
 185 external call_class_method_array : string -> string -> sv list -> sv list
 186   = "perl4caml_call_class_method_array"
 187 external call_class_method_void : string -> string -> sv list -> unit
 188   = "perl4caml_call_class_method_void"