perl.ml

   1 (* Interface to Perl from OCaml.
   2  * Copyright (C) 2003 Merjis Ltd.
   3  * $Id: perl.ml,v 1.5 2003-10-14 16:05:21 rich Exp $
   4  *)
   5
   6 type t
   7
   8 type sv
   9 type av
  10
  11 exception Perl_failure of string
  12
  13 external c_init : unit -> unit = "perl4caml_init"
  14 let init () =
  15   Callback.register_exception "perl4caml_perl_failure" (Perl_failure "");
  16   c_init ()                             (* Initialise C code. *)
  17
  18 external destroy : unit -> unit
  19   = "perl4caml_destroy"
  20
  21 external create : ?args:string array -> unit -> t
  22   = "perl4caml_create"
  23
  24 external set_context : t -> unit
  25   = "perl4caml_set_context"
  26
  27 external int_of_sv : sv -> int = "perl4caml_int_of_sv"
  28 external sv_of_int : int -> sv = "perl4caml_sv_of_int"
  29 external float_of_sv : sv -> int = "perl4caml_float_of_sv"
  30 external sv_of_float : int -> sv = "perl4caml_sv_of_float"
  31 external string_of_sv : sv -> string = "perl4caml_string_of_sv"
  32 external sv_of_string : string -> sv = "perl4caml_sv_of_string"
  33 external sv_is_true : sv -> bool = "perl4caml_sv_is_true"
  34 external sv_is_undef : sv -> bool = "perl4caml_sv_is_undef"
  35 external sv_undef : unit -> sv = "perl4caml_sv_undef"
  36 external sv_yes : unit -> sv = "perl4caml_sv_yes"
  37 external sv_no : unit -> sv = "perl4caml_sv_no"
  38
  39 let sv_true () = sv_of_int 1
  40 let sv_false () = sv_of_int 0
  41
  42 let bool_of_sv = sv_is_true
  43 let sv_of_bool b = if b then sv_true () else sv_false ()
  44
  45 type sv_t    = SVt_NULL
  46              | SVt_IV
  47              | SVt_NV
  48              | SVt_PV
  49              | SVt_RV
  50              | SVt_PVAV
  51              | SVt_PVHV
  52              | SVt_PVCV
  53              | SVt_PVGV
  54              | SVt_PVMG
  55
  56 external sv_type : sv -> sv_t = "perl4caml_sv_type"
  57
  58 let string_of_sv_t = function
  59     SVt_NULL  -> "SVt_NULL"
  60   | SVt_IV    -> "SVt_IV"
  61   | SVt_NV    -> "SVt_NV"
  62   | SVt_PV    -> "SVt_PV"
  63   | SVt_RV    -> "SVt_RV"
  64   | SVt_PVAV  -> "SVt_PVAV"
  65   | SVt_PVHV  -> "SVt_PVHV"
  66   | SVt_PVCV  -> "SVt_PVCV"
  67   | SVt_PVGV  -> "SVt_PVGV"
  68   | SVt_PVMG  -> "SVt_PVMG"
  69
  70 external deref : sv -> sv = "perl4caml_deref"
  71 external deref_array : sv -> av = "perl4caml_deref_array"
  72
  73 external av_empty : unit -> av = "perl4caml_av_empty"
  74 external av_of_sv_list : sv list -> av = "perl4caml_av_of_sv_list"
  75 external av_push : av -> sv -> unit = "perl4caml_av_push"
  76 external av_pop : av -> sv = "perl4caml_av_pop"
  77 external av_shift : av -> sv = "perl4caml_av_shift"
  78 external av_unshift : av -> sv -> unit = "perl4caml_av_unshift"
  79 external av_length : av -> int = "perl4caml_av_length"
  80 external av_set : av -> int -> sv -> unit = "perl4caml_av_set"
  81 external av_get : av -> int -> sv = "perl4caml_av_get"
  82 external av_clear : av -> unit = "perl4caml_av_clear"
  83 external av_undef : av -> unit = "perl4caml_av_undef"
  84 external av_extend : av -> int -> unit = "perl4caml_av_extend"
  85
  86 let av_map f av =
  87   let list = ref [] in
  88   for i = 0 to av_length av - 1 do
  89     list := f (av_get av i) :: !list
  90   done;
  91   List.rev !list
  92
  93 external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv"
  94 external get_av : ?create:bool -> string -> av = "perl4caml_get_av"
  95
  96 external call : ?sv:sv -> ?fn:string -> sv list -> sv
  97   = "perl4caml_call"
  98 external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list
  99   = "perl4caml_call_array"
 100 external call_void : ?sv:sv -> ?fn:string -> sv list -> unit
 101   = "perl4caml_call_void"
 102
 103 external eval : string -> sv
 104   = "perl4caml_eval"
 105
 106 external call_method : sv -> string -> sv list -> sv
 107   = "perl4caml_call_method"
 108 external call_method_array : sv -> string -> sv list -> sv list
 109   = "perl4caml_call_method_array"
 110 external call_method_void : sv -> string -> sv list -> unit
 111   = "perl4caml_call_method_void"
 112 external call_class_method : string -> string -> sv list -> sv
 113   = "perl4caml_call_class_method"
 114 external call_class_method_array : string -> string -> sv list -> sv list
 115   = "perl4caml_call_class_method_array"
 116 external call_class_method_void : string -> string -> sv list -> unit
 117   = "perl4caml_call_class_method_void"