Added proper LGPL statements to all files.
[perl4caml.git] / perl_c.c
index 3214e34..7970a81 100644 (file)
--- a/perl_c.c
+++ b/perl_c.c
@@ -1,6 +1,22 @@
 /* Interface to Perl from OCaml.
- * Copyright (C) 2003 Merjis Ltd.
- * $Id: perl_c.c,v 1.14 2004-02-03 12:38:57 rich Exp $
+   Copyright (C) 2003 Merjis Ltd.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public
+   License as published by the Free Software Foundation; either
+   version 2 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this library; see the file COPYING.  If not, write to
+   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+   Boston, MA 02111-1307, USA.
+
+   $Id: perl_c.c,v 1.25 2008-03-01 13:02:21 rich Exp $
  */
 
 #include <stdio.h>
@@ -9,6 +25,8 @@
 #include <unistd.h>
 #include <alloca.h>
 
+#define CAML_NAME_SPACE 1
+
 #include <caml/alloc.h>
 #include <caml/callback.h>
 #include <caml/custom.h>
 #include <caml/memory.h>
 #include <caml/mlvalues.h>
 
-/* XXX This was required to avoid an error on my machine when loading the Perl
- * headers. Not clear why this is missing.
- */
-#define off64_t __off64_t
-
-/* XXX This is required by Perl >= 5.8.2. */
-#define __USE_GNU
-#include <crypt.h>
-
 #include <EXTERN.h>
 #include <perl.h>
 
@@ -66,6 +75,8 @@ static value Val_xv (SV *sv);
 #define Av_val(avv) ((AV *) Xv_val (avv))
 #define Val_hv(hv) (Val_xv ((SV *)(hv)))
 #define Hv_val(hvv) ((HV *) Xv_val (hvv))
+#define Val_he(he) (Val_voidptr ((he)))
+#define He_val(hev) (Voidptr_val (HE, (hev)))
 
 static void
 xs_init (pTHX)
@@ -81,13 +92,13 @@ perl4caml_init (value unit)
 {
   CAMLparam1 (unit);
   int argc = 4;
-  static char *argv[] = { "", "-w", "-e", "0" };
+  static char *argv[] = { "", "-w", "-e", "0", NULL };
 
-  PERL_SYS_INIT3 (NULL, NULL, NULL);
+  PERL_SYS_INIT (&argc, &argv);
   my_perl = perl_alloc ();
   perl_construct (my_perl);
   PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
-  perl_parse (my_perl, xs_init, argc, argv, NULL);
+  perl_parse (my_perl, xs_init, argc, argv, (char **) NULL);
   /*perl_run (my_perl);*/
 
   CAMLreturn (Val_unit);
@@ -114,7 +125,7 @@ perl4caml_float_of_sv (value svv)
   CAMLparam1 (svv);
   SV *sv = Sv_val (svv);
   CAMLlocal1 (f);
-  f = copy_double (SvNV (sv));
+  f = caml_copy_double (SvNV (sv));
   CAMLreturn (f);
 }
 
@@ -122,7 +133,7 @@ CAMLprim value
 perl4caml_sv_of_float (value fv)
 {
   CAMLparam1 (fv);
-  CAMLreturn (Val_sv (newSViv (Double_val (fv))));
+  CAMLreturn (Val_sv (newSVnv (Double_val (fv))));
 }
 
 CAMLprim value
@@ -134,8 +145,8 @@ perl4caml_string_of_sv (value svv)
   STRLEN len;
   CAMLlocal1 (strv);
   str = SvPV (sv, len);
-  /* XXX This won't work if the string contains NUL. */
-  strv = copy_string (str);
+  strv = caml_alloc_string (len);
+  memcpy (String_val (strv), str, len);
   CAMLreturn (strv);
 }
 
@@ -143,7 +154,7 @@ CAMLprim value
 perl4caml_sv_of_string (value strv)
 {
   CAMLparam1 (strv);
-  CAMLreturn (Val_sv (newSVpv (String_val (strv), string_length (strv))));
+  CAMLreturn (Val_sv (newSVpv (String_val (strv), caml_string_length (strv))));
 }
 
 CAMLprim value
@@ -158,7 +169,17 @@ CAMLprim value
 perl4caml_sv_undef (value unit)
 {
   CAMLparam1 (unit);
-  CAMLreturn (Val_sv (newSV (0)));
+  /*CAMLreturn (Val_sv (newSV (0)));*/
+  CAMLreturn (Val_sv (&PL_sv_undef));
+}
+
+CAMLprim value
+perl4caml_sv_is_undef (value svv)
+{
+  CAMLparam1 (svv);
+  SV *sv = Sv_val (svv);
+  CAMLreturn (!SvPOK (sv) && !SvIOK (sv) && SvTYPE (sv) == SVt_NULL
+             ? Val_true : Val_false);
 }
 
 CAMLprim value
@@ -175,25 +196,55 @@ perl4caml_sv_no (value unit)
   CAMLreturn (Val_sv (&PL_sv_no));
 }
 
+static int
+sv_type (SV *sv)
+{
+  switch (SvTYPE (sv))
+    {
+    case SVt_IV: return 1;
+    case SVt_NV: return 2;
+    case SVt_PV: return 3;
+    case SVt_RV: return 4;
+    case SVt_PVAV: return 5;
+    case SVt_PVHV: return 6;
+    case SVt_PVCV: return 7;
+    case SVt_PVGV: return 8;
+    case SVt_PVMG: return 9;
+    default: return 0;
+    }
+}
+
 CAMLprim value
 perl4caml_sv_type (value svv)
 {
   CAMLparam1 (svv);
   SV *sv = Sv_val (svv);
 
-  switch (SvTYPE (sv))
-    {
-    case SVt_IV: CAMLreturn (Val_int (1));
-    case SVt_NV: CAMLreturn (Val_int (2));
-    case SVt_PV: CAMLreturn (Val_int (3));
-    case SVt_RV: CAMLreturn (Val_int (4));
-    case SVt_PVAV: CAMLreturn (Val_int (5));
-    case SVt_PVHV: CAMLreturn (Val_int (6));
-    case SVt_PVCV: CAMLreturn (Val_int (7));
-    case SVt_PVGV: CAMLreturn (Val_int (8));
-    case SVt_PVMG: CAMLreturn (Val_int (9));
-    default: CAMLreturn (Val_int (0));
-    }
+  CAMLreturn (Val_int (sv_type (sv)));
+}
+
+CAMLprim value
+perl4caml_address_of_sv (value svv)
+{
+  CAMLparam1 (svv);
+  SV *sv = Sv_val (svv);
+  CAMLreturn (caml_copy_nativeint ((long) sv));
+}
+
+CAMLprim value
+perl4caml_address_of_av (value avv)
+{
+  CAMLparam1 (avv);
+  AV *av = Av_val (avv);
+  CAMLreturn (caml_copy_nativeint ((long) av));
+}
+
+CAMLprim value
+perl4caml_address_of_hv (value hvv)
+{
+  CAMLparam1 (hvv);
+  HV *hv = Hv_val (hvv);
+  CAMLreturn (caml_copy_nativeint ((long) hv));
 }
 
 CAMLprim value
@@ -227,14 +278,26 @@ perl4caml_hashref (value hvv)
 }
 
 CAMLprim value
+perl4caml_reftype (value svv)
+{
+  CAMLparam1 (svv);
+  SV *sv = Sv_val (svv);
+
+  if (!SvROK (sv))
+    caml_invalid_argument ("reftype: SV is not a reference");
+
+  CAMLreturn (Val_int (sv_type (SvRV (sv))));
+}
+
+CAMLprim value
 perl4caml_deref (value svv)
 {
   CAMLparam1 (svv);
   CAMLlocal1 (rsvv);
   SV *sv = Sv_val (svv);
 
-  if (SvTYPE (sv) != SVt_RV)
-    invalid_argument ("deref: SV is not a reference");
+  if (!SvROK (sv))
+    caml_invalid_argument ("deref: SV is not a reference");
   switch (SvTYPE (SvRV (sv))) {
   case SVt_IV:
   case SVt_NV:
@@ -243,9 +306,14 @@ perl4caml_deref (value svv)
   case SVt_PVMG:
     break;
   default:
-    invalid_argument ("deref: SV is not a reference to a scalar");
+    caml_invalid_argument ("deref: SV is not a reference to a scalar");
   }
-  rsvv = Val_sv (SvRV (sv));
+  sv = SvRV (sv);
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced SV.
+   */
+  sv = SvREFCNT_inc (sv);
+  rsvv = Val_sv (sv);
   CAMLreturn (rsvv);
 }
 
@@ -256,15 +324,20 @@ perl4caml_deref_array (value svv)
   CAMLlocal1 (ravv);
   SV *sv = Sv_val (svv);
 
-  if (SvTYPE (sv) != SVt_RV)
-    invalid_argument ("deref_array: SV is not a reference");
+  if (!SvROK (sv))
+    caml_invalid_argument ("deref_array: SV is not a reference");
   switch (SvTYPE (SvRV (sv))) {
   case SVt_PVAV:
     break;
   default:
-    invalid_argument ("deref_array: SV is not a reference to an array");
+    caml_invalid_argument ("deref_array: SV is not a reference to an array");
   }
-  ravv = Val_av ((AV *) SvRV (sv));
+  sv = SvRV (sv);
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced AV.
+   */
+  sv = SvREFCNT_inc (sv);
+  ravv = Val_av ((AV *) sv);
   CAMLreturn (ravv);
 }
 
@@ -275,15 +348,20 @@ perl4caml_deref_hash (value svv)
   CAMLlocal1 (rhvv);
   SV *sv = Sv_val (svv);
 
-  if (SvTYPE (sv) != SVt_RV)
-    invalid_argument ("deref_array: SV is not a reference");
+  if (!SvROK (sv))
+    caml_invalid_argument ("deref_hash: SV is not a reference");
   switch (SvTYPE (SvRV (sv))) {
   case SVt_PVHV:
     break;
   default:
-    invalid_argument ("deref_array: SV is not a reference to a hash");
+    caml_invalid_argument ("deref_hash: SV is not a reference to a hash");
   }
-  rhvv = Val_hv ((HV *) SvRV (sv));
+  sv = SvRV (sv);
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced HV.
+   */
+  sv = SvREFCNT_inc (sv);
+  rhvv = Val_hv ((HV *) sv);
   CAMLreturn (rhvv);
 }
 
@@ -343,6 +421,10 @@ perl4caml_av_pop (value avv)
   CAMLparam1 (avv);
   AV *av = Av_val (avv);
   SV *sv = av_pop (av);
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced AV.
+   */
+  sv = SvREFCNT_inc (sv);
   CAMLreturn (Val_sv (sv));
 }
 
@@ -365,6 +447,10 @@ perl4caml_av_shift (value avv)
   CAMLparam1 (avv);
   AV *av = Av_val (avv);
   SV *sv = av_shift (av);
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced AV.
+   */
+  sv = SvREFCNT_inc (sv);
   CAMLreturn (Val_sv (sv));
 }
 
@@ -394,7 +480,11 @@ perl4caml_av_get (value avv, value i)
   CAMLparam2 (avv, i);
   AV *av = Av_val (avv);
   SV **svp = av_fetch (av, Int_val (i), 0);
-  if (svp == 0) invalid_argument ("av_get: index out of bounds");
+  if (svp == 0) caml_invalid_argument ("av_get: index out of bounds");
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced AV.
+   */
+  *svp = SvREFCNT_inc (*svp);
   CAMLreturn (Val_sv (*svp));
 }
 
@@ -440,7 +530,7 @@ perl4caml_hv_set (value hvv, value key, value svv)
   HV *hv = Hv_val (hvv);
   SV *sv = Sv_val (svv);
   SvREFCNT_inc (sv);
-  if (hv_store (hv, String_val (key), string_length (key), sv, 0) == 0)
+  if (hv_store (hv, String_val (key), caml_string_length (key), sv, 0) == 0)
     SvREFCNT_dec (sv);
   CAMLreturn (Val_unit);
 }
@@ -450,8 +540,12 @@ perl4caml_hv_get (value hvv, value key)
 {
   CAMLparam2 (hvv, key);
   HV *hv = Hv_val (hvv);
-  SV **svp = hv_fetch (hv, String_val (key), string_length (key), 0);
-  if (svp == 0) raise_not_found ();
+  SV **svp = hv_fetch (hv, String_val (key), caml_string_length (key), 0);
+  if (svp == 0) caml_raise_not_found ();
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced SV.
+   */
+  SvREFCNT_inc (*svp);
   CAMLreturn (Val_sv (*svp));
 }
 
@@ -460,7 +554,7 @@ perl4caml_hv_exists (value hvv, value key)
 {
   CAMLparam2 (hvv, key);
   HV *hv = Hv_val (hvv);
-  bool r = hv_exists (hv, String_val (key), string_length (key));
+  bool r = hv_exists (hv, String_val (key), caml_string_length (key));
   CAMLreturn (r ? Val_true : Val_false);
 }
 
@@ -469,7 +563,7 @@ perl4caml_hv_delete (value hvv, value key)
 {
   CAMLparam2 (hvv, key);
   HV *hv = Hv_val (hvv);
-  hv_delete (hv, String_val (key), string_length (key), G_DISCARD);
+  hv_delete (hv, String_val (key), caml_string_length (key), G_DISCARD);
   CAMLreturn (Val_unit);
 }
 
@@ -492,6 +586,73 @@ perl4caml_hv_undef (value hvv)
 }
 
 CAMLprim value
+perl4caml_hv_iterinit (value hvv)
+{
+  CAMLparam1 (hvv);
+  HV *hv = Hv_val (hvv);
+  int i = hv_iterinit (hv);
+  CAMLreturn (caml_copy_int32 (i));
+}
+
+CAMLprim value
+perl4caml_hv_iternext (value hvv)
+{
+  CAMLparam1 (hvv);
+  CAMLlocal1 (hev);
+  HV *hv = Hv_val (hvv);
+  HE *he = hv_iternext (hv);
+  if (he == NULL) caml_raise_not_found ();
+  hev = Val_he (he);
+  CAMLreturn (hev);
+}
+
+CAMLprim value
+perl4caml_hv_iterkey (value hev)
+{
+  CAMLparam1 (hev);
+  CAMLlocal1 (strv);
+  HE *he = He_val (hev);
+  I32 len;
+  char *str = hv_iterkey (he, &len);
+  strv = caml_alloc_string (len);
+  memcpy (String_val (strv), str, len);
+  CAMLreturn (strv);
+}
+
+CAMLprim value
+perl4caml_hv_iterval (value hvv, value hev)
+{
+  CAMLparam2 (hvv, hev);
+  CAMLlocal1 (svv);
+  HV *hv = Hv_val (hvv);
+  HE *he = He_val (hev);
+  SV *sv = hv_iterval (hv, he);
+  SvREFCNT_inc (sv);
+  svv = Val_sv (sv);
+  CAMLreturn (svv);
+}
+
+CAMLprim value
+perl4caml_hv_iternextsv (value hvv)
+{
+  CAMLparam1 (hvv);
+  CAMLlocal3 (strv, svv, rv);
+  HV *hv = Hv_val (hvv);
+  char *str; I32 len;
+  SV *sv = hv_iternextsv (hv, &str, &len);
+  if (sv == NULL) caml_raise_not_found ();
+  SvREFCNT_inc (sv);
+  svv = Val_sv (sv);
+  strv = caml_alloc_string (len);
+  memcpy (String_val (strv), str, len);
+  /* Construct a tuple (strv, svv). */
+  rv = caml_alloc_tuple (2);
+  Field (rv, 0) = strv;
+  Field (rv, 1) = svv;
+  CAMLreturn (rv);
+}
+
+CAMLprim value
 perl4caml_get_sv (value optcreate, value name)
 {
   CAMLparam2 (optcreate, name);
@@ -500,7 +661,12 @@ perl4caml_get_sv (value optcreate, value name)
 
   create = unoption (optcreate, Val_false);
   sv = get_sv (String_val (name), create == Val_true ? TRUE : FALSE);
-  if (sv == NULL) raise_not_found ();
+  if (sv == NULL) caml_raise_not_found ();
+
+  /* Increment the reference count because we're creating another
+   * value pointing at the referenced SV.
+   */
+  SvREFCNT_inc (sv);
 
   CAMLreturn (Val_sv (sv));
 }
@@ -514,7 +680,12 @@ perl4caml_get_av (value optcreate, value name)
 
   create = unoption (optcreate, Val_false);
   av = get_av (String_val (name), create == Val_true ? TRUE : FALSE);
-  if (av == NULL) raise_not_found ();
+  if (av == NULL) caml_raise_not_found ();
+
+  /* Increment the reference count because we're creating another
+   * value pointing at the AV.
+   */
+  SvREFCNT_inc (av);
 
   CAMLreturn (Val_av (av));
 }
@@ -528,7 +699,12 @@ perl4caml_get_hv (value optcreate, value name)
 
   create = unoption (optcreate, Val_false);
   hv = get_hv (String_val (name), create == Val_true ? TRUE : FALSE);
-  if (hv == NULL) raise_not_found ();
+  if (hv == NULL) caml_raise_not_found ();
+
+  /* Increment the reference count because we're creating another
+   * value pointing at the HV.
+   */
+  SvREFCNT_inc (hv);
 
   CAMLreturn (Val_hv (hv));
 }
@@ -544,9 +720,9 @@ check_perl_failure ()
       STRLEN n_a;
       const char *err = SvPV (errsv, n_a);
 
-      errv = copy_string (err);
+      errv = caml_copy_string (err);
 
-      raise_with_arg (*caml_named_value ("perl4caml_perl_failure"), errv);
+      caml_raise_with_arg (*caml_named_value ("perl4caml_perl_failure"), errv);
     }
 }
 
@@ -663,7 +839,7 @@ perl4caml_call_array (value optsv, value optfnname, value arglist)
   for (i = 0; i < count; ++i) {
     SV *sv;
 
-    cons = alloc (2, 0);
+    cons = caml_alloc (2, 0);
     Field (cons, 1) = list;
     list = cons;
     sv = newSVsv (POPs);
@@ -840,7 +1016,7 @@ perl4caml_call_method_array (value ref, value name, value arglist)
   for (i = 0; i < count; ++i) {
     SV *sv;
 
-    cons = alloc (2, 0);
+    cons = caml_alloc (2, 0);
     Field (cons, 1) = list;
     list = cons;
     sv = newSVsv (POPs);
@@ -984,7 +1160,7 @@ perl4caml_call_class_method_array (value classname, value name, value arglist)
    */
   list = Val_int (0);
   for (i = 0; i < count; ++i) {
-    cons = alloc (2, 0);
+    cons = caml_alloc (2, 0);
     Field (cons, 1) = list;
     list = cons;
     Field (cons, 0) = Val_sv (newSVsv (POPs));
@@ -1048,7 +1224,7 @@ Val_voidptr (void *ptr)
 {
   CAMLparam0 ();
   CAMLlocal1 (rv);
-  rv = alloc (1, Abstract_tag);
+  rv = caml_alloc (1, Abstract_tag);
   Field(rv, 0) = (value) ptr;
   CAMLreturn (rv);
 }
@@ -1058,6 +1234,7 @@ Val_voidptr (void *ptr)
 static void
 xv_finalize (value v)
 {
+  /*fprintf (stderr, "about to decrement %p\n", Xv_val (v));*/
   SvREFCNT_dec ((SV *) Xv_val (v));
 }
 
@@ -1075,7 +1252,7 @@ Val_xv (SV *sv)
 {
   CAMLparam0 ();
   CAMLlocal1 (rv);
-  rv = alloc_custom (&xv_custom_operations, sizeof (void *), 0, 1);
+  rv = caml_alloc_custom (&xv_custom_operations, sizeof (void *), 0, 1);
   Xv_val (rv) = sv;
   CAMLreturn (rv);
 }