perl.ml

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