Added proper LGPL statements to all files.
[perl4caml.git] / perl_c.c
index 948de42..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.19 2004-12-11 15:40:09 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>
@@ -59,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)
@@ -115,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
@@ -127,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 = caml_copy_string (str);
+  strv = caml_alloc_string (len);
+  memcpy (String_val (strv), str, len);
   CAMLreturn (strv);
 }
 
@@ -178,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
@@ -230,6 +278,18 @@ 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);
@@ -248,7 +308,12 @@ perl4caml_deref (value svv)
   default:
     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);
 }
 
@@ -267,7 +332,12 @@ perl4caml_deref_array (value svv)
   default:
     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);
 }
 
@@ -286,7 +356,12 @@ perl4caml_deref_hash (value svv)
   default:
     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);
 }
 
@@ -346,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));
 }
 
@@ -368,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));
 }
 
@@ -398,6 +481,10 @@ perl4caml_av_get (value avv, value i)
   AV *av = Av_val (avv);
   SV **svp = av_fetch (av, Int_val (i), 0);
   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));
 }
 
@@ -455,6 +542,10 @@ perl4caml_hv_get (value hvv, value key)
   HV *hv = Hv_val (hvv);
   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));
 }
 
@@ -495,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);
@@ -505,6 +663,11 @@ perl4caml_get_sv (value optcreate, value name)
   sv = get_sv (String_val (name), create == Val_true ? TRUE : FALSE);
   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));
 }
 
@@ -519,6 +682,11 @@ perl4caml_get_av (value optcreate, value name)
   av = get_av (String_val (name), create == Val_true ? TRUE : FALSE);
   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));
 }
 
@@ -533,6 +701,11 @@ perl4caml_get_hv (value optcreate, value name)
   hv = get_hv (String_val (name), create == Val_true ? TRUE : FALSE);
   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));
 }
 
@@ -1061,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));
 }