perl.ml

   1 (* Interface to Perl from OCaml.
   2  * Copyright (C) 2003 Merjis Ltd.
   3  * $Id: perl.ml,v 1.10 2003-10-26 12:57:11 rich Exp $
   4  *)
   5
   6 type t
   7
   8 type sv
   9 type av
  10 type hv
  11
  12 exception Perl_failure of string
  13
  14 external create : ?args:string array -> unit -> t
  15   = "perl4caml_create"
  16
  17 (* Initialization. This must happen first, otherwise other parts of the
  18  * program will segfault because of a missing interpreter.
  19  *)
  20 external c_init : unit -> unit = "perl4caml_init"
  21 let () =
  22   Callback.register_exception "perl4caml_perl_failure" (Perl_failure "");
  23   c_init ();                            (* Initialise C code. *)
  24   (* Create the default interpreter. *)
  25   create ~args:[| ""; "-w"; "-e"; "0" |] ();
  26   ()
  27
  28 external current_interpreter : unit -> t
  29   = "perl4caml_current_interpreter"
  30
  31 external destroy : t -> unit
  32   = "perl4caml_destroy"
  33
  34 external set_context : t -> unit
  35   = "perl4caml_set_context"
  36
  37 external int_of_sv : sv -> int = "perl4caml_int_of_sv"
  38 external sv_of_int : int -> sv = "perl4caml_sv_of_int"
  39 external float_of_sv : sv -> float = "perl4caml_float_of_sv"
  40 external sv_of_float : float -> sv = "perl4caml_sv_of_float"
  41 external string_of_sv : sv -> string = "perl4caml_string_of_sv"
  42 external sv_of_string : string -> sv = "perl4caml_sv_of_string"
  43 external sv_is_true : sv -> bool = "perl4caml_sv_is_true"
  44 external sv_undef : unit -> sv = "perl4caml_sv_undef"
  45 external sv_yes : unit -> sv = "perl4caml_sv_yes"
  46 external sv_no : unit -> sv = "perl4caml_sv_no"
  47
  48 let sv_true () = sv_of_int 1
  49 let sv_false () = sv_of_int 0
  50
  51 let bool_of_sv = sv_is_true
  52 let sv_of_bool b = if b then sv_true () else sv_false ()
  53
  54 type sv_t    = SVt_NULL
  55              | SVt_IV
  56              | SVt_NV
  57              | SVt_PV
  58              | SVt_RV
  59              | SVt_PVAV
  60              | SVt_PVHV
  61              | SVt_PVCV
  62              | SVt_PVGV
  63              | SVt_PVMG
  64
  65 external sv_type : sv -> sv_t = "perl4caml_sv_type"
  66 let sv_is_undef sv =
  67   SVt_NULL = sv_type sv
  68
  69 let string_of_sv_t = function
  70     SVt_NULL  -> "SVt_NULL"
  71   | SVt_IV    -> "SVt_IV"
  72   | SVt_NV    -> "SVt_NV"
  73   | SVt_PV    -> "SVt_PV"
  74   | SVt_RV    -> "SVt_RV"
  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"
  80
  81 external scalarref : sv -> sv = "perl4caml_scalarref"
  82 external arrayref : av -> sv = "perl4caml_arrayref"
  83 external hashref : hv -> sv = "perl4caml_hashref"
  84
  85 external deref : sv -> sv = "perl4caml_deref"
  86 external deref_array : sv -> av = "perl4caml_deref_array"
  87 external deref_hash : sv -> hv = "perl4caml_deref_hash"
  88
  89 external av_empty : unit -> av = "perl4caml_av_empty"
  90 external av_of_sv_list : sv list -> av = "perl4caml_av_of_sv_list"
  91 external av_push : av -> sv -> unit = "perl4caml_av_push"
  92 external av_pop : av -> sv = "perl4caml_av_pop"
  93 external av_shift : av -> sv = "perl4caml_av_shift"
  94 external av_unshift : av -> sv -> unit = "perl4caml_av_unshift"
  95 external av_length : av -> int = "perl4caml_av_length"
  96 external av_set : av -> int -> sv -> unit = "perl4caml_av_set"
  97 external av_get : av -> int -> sv = "perl4caml_av_get"
  98 external av_clear : av -> unit = "perl4caml_av_clear"
  99 external av_undef : av -> unit = "perl4caml_av_undef"
 100 external av_extend : av -> int -> unit = "perl4caml_av_extend"
 101
 102 let av_map f av =
 103   let list = ref [] in
 104   for i = 0 to av_length av - 1 do
 105     list := f (av_get av i) :: !list
 106   done;
 107   List.rev !list
 108
 109 let list_of_av av =
 110   let list = ref [] in
 111   for i = 0 to av_length av - 1 do
 112     list := av_get av i :: !list
 113   done;
 114   List.rev !list
 115
 116 let av_of_string_list strs =
 117   av_of_sv_list (List.map sv_of_string strs)
 118
 119 external hv_empty : unit -> hv = "perl4caml_hv_empty"
 120 external hv_set : hv -> string -> sv -> unit = "perl4caml_hv_set"
 121 external hv_get : hv -> string -> sv = "perl4caml_hv_get"
 122 external hv_exists : hv -> string -> bool = "perl4caml_hv_exists"
 123 external hv_delete : hv -> string -> unit = "perl4caml_hv_delete"
 124 external hv_clear : hv -> unit = "perl4caml_hv_clear"
 125 external hv_undef : hv -> unit = "perl4caml_hv_undef"
 126
 127 external get_sv : ?create:bool -> string -> sv = "perl4caml_get_sv"
 128 external get_av : ?create:bool -> string -> av = "perl4caml_get_av"
 129 external get_hv : ?create:bool -> string -> hv = "perl4caml_get_hv"
 130
 131 external call : ?sv:sv -> ?fn:string -> sv list -> sv
 132   = "perl4caml_call"
 133 external call_array : ?sv:sv -> ?fn:string -> sv list -> sv list
 134   = "perl4caml_call_array"
 135 external call_void : ?sv:sv -> ?fn:string -> sv list -> unit
 136   = "perl4caml_call_void"
 137
 138 external eval : string -> sv
 139   = "perl4caml_eval"
 140
 141 external call_method : sv -> string -> sv list -> sv
 142   = "perl4caml_call_method"
 143 external call_method_array : sv -> string -> sv list -> sv list
 144   = "perl4caml_call_method_array"
 145 external call_method_void : sv -> string -> sv list -> unit
 146   = "perl4caml_call_method_void"
 147 external call_class_method : string -> string -> sv list -> sv
 148   = "perl4caml_call_class_method"
 149 external call_class_method_array : string -> string -> sv list -> sv list
 150   = "perl4caml_call_class_method_array"
 151 external call_class_method_void : string -> string -> sv list -> unit
 152   = "perl4caml_call_class_method_void"