/* Interface to Perl from OCaml.
* Copyright (C) 2003 Merjis Ltd.
- * $Id: perl_c.c,v 1.6 2003-10-15 16:51:12 rich Exp $
+ * $Id: perl_c.c,v 1.20 2005-01-28 23:09:32 rich Exp $
*/
#include <stdio.h>
#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/fail.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
-
#include <EXTERN.h>
#include <perl.h>
/* Perl requires the interpreter to be called literally 'my_perl'! */
static PerlInterpreter *my_perl;
-/* Wrap up an arbitrary void pointer in an opaque OCaml object. */
-static value Val_voidptr (void *ptr);
-
/* Get the concrete value from an optional field. */
static value unoption (value option, value deflt);
+/* Wrap up an arbitrary void pointer in an opaque OCaml object. */
+static value Val_voidptr (void *ptr);
+
/* Unwrap an arbitrary void pointer from an opaque OCaml object. */
#define Voidptr_val(type,rv) ((type *) Field ((rv), 0))
+#if PERL4CAML_REFCOUNTING_EXPERIMENTAL
+
+/* Unwrap a custom block. */
+#define Xv_val(rv) (*((void **)Data_custom_val(rv)))
+
+/* Wrap up an SV, AV or HV in a custom OCaml object which will decrement
+ * the reference count on finalization.
+ */
+static value Val_xv (SV *sv);
+
+#else
+
+#define Xv_val(rv) Voidptr_val (SV, (rv))
+#define Val_xv(sv) Val_voidptr ((sv))
+
+#endif
+
/* Hide Perl types in opaque OCaml objects. */
#define Val_perl(pl) (Val_voidptr ((pl)))
#define Perl_val(plv) (Voidptr_val (PerlInterpreter, (plv)))
-#define Val_sv(sv) (Val_voidptr ((sv)))
-#define Sv_val(svv) (Voidptr_val (SV, (svv)))
-#define Val_av(av) (Val_voidptr ((av)))
-#define Av_val(avv) (Voidptr_val (AV, (avv)))
-
-CAMLprim value
-perl4caml_init (value unit)
-{
- CAMLparam1 (unit);
- PERL_SYS_INIT3 (NULL, NULL, NULL);
- return Val_unit;
-}
-
-CAMLprim value
-perl4caml_current_interpreter (value unit)
-{
- CAMLparam1 (unit);
- if (my_perl == 0) raise_not_found ();
- return Val_perl (my_perl);
-}
+#define Val_sv(sv) (Val_xv ((sv)))
+#define Sv_val(svv) ((SV *) Xv_val (svv))
+#define Val_av(av) (Val_xv ((SV *)(av)))
+#define Av_val(avv) ((AV *) Xv_val (avv))
+#define Val_hv(hv) (Val_xv ((SV *)(hv)))
+#define Hv_val(hvv) ((HV *) Xv_val (hvv))
static void
xs_init (pTHX)
}
CAMLprim value
-perl4caml_create (value optargs, value unit)
+perl4caml_init (value unit)
{
- CAMLparam2 (optargs, unit);
- CAMLlocal1 (args);
- int argc, i;
- char **argv;
- static char *no_args[] = { "", "-w", "-e", "0" };
-
- /* Arguments given? */
- if (optargs == Val_int (0)) /* "None" */
- {
- argc = 4;
- argv = no_args;
- }
- else /* "Some args" where args is a string array. */
- {
- args = Field (optargs, 0);
- argc = Wosize_val (args);
- argv = alloca (argc * sizeof (char *));
- for (i = 0; i < argc; ++i) argv[i] = String_val (Field (args, i));
- }
+ CAMLparam1 (unit);
+ int argc = 4;
+ static char *argv[] = { "", "-w", "-e", "0", 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_perl (my_perl));
-}
-
-CAMLprim value
-perl4caml_destroy (value plv)
-{
- CAMLparam1 (plv);
- PerlInterpreter *pl = Perl_val (plv);
-
- perl_destruct (pl);
- perl_free (pl);
-
- /* Current interpreter? */
- if (my_perl == pl) my_perl = 0;
-
- CAMLreturn (Val_unit);
-}
-
-CAMLprim value
-perl4caml_set_context (value plv)
-{
- CAMLparam1 (plv);
- PerlInterpreter *pl = Perl_val (plv);
-
- PERL_SET_CONTEXT (pl);
- my_perl = pl;
-
CAMLreturn (Val_unit);
}
CAMLparam1 (svv);
SV *sv = Sv_val (svv);
CAMLlocal1 (f);
- f = copy_double (SvNV (sv));
+ f = caml_copy_double (SvNV (sv));
CAMLreturn (f);
}
CAMLlocal1 (strv);
str = SvPV (sv, len);
/* XXX This won't work if the string contains NUL. */
- strv = copy_string (str);
+ strv = caml_copy_string (str);
CAMLreturn (strv);
}
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
}
CAMLprim value
-perl4caml_sv_is_undef (value svv)
+perl4caml_sv_undef (value unit)
{
- CAMLparam1 (svv);
- SV *sv = Sv_val (svv);
- CAMLreturn (sv == &PL_sv_undef ? Val_true : Val_false);
+ CAMLparam1 (unit);
+ /*CAMLreturn (Val_sv (newSV (0)));*/
+ CAMLreturn (Val_sv (&PL_sv_undef));
}
CAMLprim value
-perl4caml_sv_undef (value unit)
+perl4caml_sv_is_undef (value svv)
{
- CAMLparam1 (unit);
- CAMLreturn (Val_sv (&PL_sv_undef));
+ CAMLparam1 (svv);
+ SV *sv = Sv_val (svv);
+ CAMLreturn (!SvPOK (sv) && !SvIOK (sv) && SvTYPE (sv) == SVt_NULL
+ ? Val_true : Val_false);
}
CAMLprim value
}
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
+perl4caml_scalarref (value svv)
+{
+ CAMLparam1 (svv);
+ CAMLlocal1 (rsvv);
+ SV *sv = Sv_val (svv);
+ rsvv = Val_sv (newRV_inc (sv));
+ CAMLreturn (rsvv);
+}
+
+CAMLprim value
+perl4caml_arrayref (value avv)
+{
+ CAMLparam1 (avv);
+ CAMLlocal1 (rsvv);
+ AV *av = Av_val (avv);
+ rsvv = Val_sv (newRV_inc ((SV *) av));
+ CAMLreturn (rsvv);
+}
+
+CAMLprim value
+perl4caml_hashref (value hvv)
+{
+ CAMLparam1 (hvv);
+ CAMLlocal1 (rsvv);
+ HV *hv = Hv_val (hvv);
+ rsvv = Val_sv (newRV_inc ((SV *) hv));
+ CAMLreturn (rsvv);
+}
+
+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:
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);
}
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);
}
CAMLprim value
+perl4caml_deref_hash (value svv)
+{
+ CAMLparam1 (svv);
+ CAMLlocal1 (rhvv);
+ SV *sv = Sv_val (svv);
+
+ if (!SvROK (sv))
+ caml_invalid_argument ("deref_hash: SV is not a reference");
+ switch (SvTYPE (SvRV (sv))) {
+ case SVt_PVHV:
+ break;
+ default:
+ caml_invalid_argument ("deref_hash: SV is not a reference to a hash");
+ }
+ 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);
+}
+
+CAMLprim value
perl4caml_av_empty (value unit)
{
CAMLparam1 (unit);
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));
}
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));
}
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));
}
}
CAMLprim value
+perl4caml_hv_empty (value unit)
+{
+ CAMLparam1 (unit);
+ HV *hv = newHV ();
+ CAMLreturn (Val_hv (hv));
+}
+
+CAMLprim value
+perl4caml_hv_set (value hvv, value key, value svv)
+{
+ CAMLparam3 (hvv, key, svv);
+ HV *hv = Hv_val (hvv);
+ SV *sv = Sv_val (svv);
+ SvREFCNT_inc (sv);
+ if (hv_store (hv, String_val (key), caml_string_length (key), sv, 0) == 0)
+ SvREFCNT_dec (sv);
+ CAMLreturn (Val_unit);
+}
+
+CAMLprim value
+perl4caml_hv_get (value hvv, value key)
+{
+ CAMLparam2 (hvv, 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));
+}
+
+CAMLprim value
+perl4caml_hv_exists (value hvv, value key)
+{
+ CAMLparam2 (hvv, key);
+ HV *hv = Hv_val (hvv);
+ bool r = hv_exists (hv, String_val (key), caml_string_length (key));
+ CAMLreturn (r ? Val_true : Val_false);
+}
+
+CAMLprim value
+perl4caml_hv_delete (value hvv, value key)
+{
+ CAMLparam2 (hvv, key);
+ HV *hv = Hv_val (hvv);
+ hv_delete (hv, String_val (key), caml_string_length (key), G_DISCARD);
+ CAMLreturn (Val_unit);
+}
+
+CAMLprim value
+perl4caml_hv_clear (value hvv)
+{
+ CAMLparam1 (hvv);
+ HV *hv = Hv_val (hvv);
+ hv_clear (hv);
+ CAMLreturn (Val_unit);
+}
+
+CAMLprim value
+perl4caml_hv_undef (value hvv)
+{
+ CAMLparam1 (hvv);
+ HV *hv = Hv_val (hvv);
+ hv_undef (hv);
+ CAMLreturn (Val_unit);
+}
+
+CAMLprim value
perl4caml_get_sv (value optcreate, value name)
{
CAMLparam2 (optcreate, 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));
}
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));
}
+CAMLprim value
+perl4caml_get_hv (value optcreate, value name)
+{
+ CAMLparam2 (optcreate, name);
+ CAMLlocal1 (create);
+ HV *hv;
+
+ create = unoption (optcreate, Val_false);
+ 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));
+}
+
static inline void
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);
}
}
*/
list = Val_int (0);
for (i = 0; i < count; ++i) {
- cons = alloc (2, 0);
+ SV *sv;
+
+ cons = caml_alloc (2, 0);
Field (cons, 1) = list;
list = cons;
- Field (cons, 0) = Val_sv (newSVsv (POPs));
+ sv = newSVsv (POPs);
+ Field (cons, 0) = Val_sv (sv);
}
/* Restore the stack. */
else if (optfnname != Val_int (0))
{
fnname = unoption (optfnname, Val_false);
- count = call_pv (String_val (fnname), G_EVAL|G_VOID);
+ count = call_pv (String_val (fnname), G_EVAL|G_VOID|G_DISCARD);
}
else
{
SPAGAIN;
- assert (count == 0); /* Pretty sure it should never be anything else. */
+ assert (count == 0);
/* Restore the stack. */
PUTBACK;
*/
list = Val_int (0);
for (i = 0; i < count; ++i) {
- cons = alloc (2, 0);
+ SV *sv;
+
+ cons = caml_alloc (2, 0);
Field (cons, 1) = list;
list = cons;
- Field (cons, 0) = Val_sv (newSVsv (POPs));
+ sv = newSVsv (POPs);
+ Field (cons, 0) = Val_sv (sv);
}
/* Restore the stack. */
PUTBACK;
- count = call_method (String_val (name), G_EVAL|G_VOID);
+ count = call_method (String_val (name), G_EVAL|G_VOID|G_DISCARD);
SPAGAIN;
- assert (count == 0); /* Pretty sure it should never be anything else. */
+ assert (count == 0);
/* Restore the stack. */
PUTBACK;
*/
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));
PUTBACK;
- count = call_method (String_val (name), G_EVAL|G_VOID);
+ count = call_method (String_val (name), G_EVAL|G_VOID|G_DISCARD);
SPAGAIN;
- assert (count == 0); /* Pretty sure it should never be anything else. */
+ assert (count == 0);
/* Restore the stack. */
PUTBACK;
static value
Val_voidptr (void *ptr)
{
- value rv = alloc (1, Abstract_tag); /* XXX Is this correct? */
+ CAMLparam0 ();
+ CAMLlocal1 (rv);
+ rv = caml_alloc (1, Abstract_tag);
Field(rv, 0) = (value) ptr;
- return rv;
+ CAMLreturn (rv);
}
+#if PERL4CAML_REFCOUNTING_EXPERIMENTAL
+
+static void
+xv_finalize (value v)
+{
+ /*fprintf (stderr, "about to decrement %p\n", Xv_val (v));*/
+ SvREFCNT_dec ((SV *) Xv_val (v));
+}
+
+static struct custom_operations xv_custom_operations = {
+ "xv_custom_operations",
+ xv_finalize,
+ custom_compare_default,
+ custom_hash_default,
+ custom_serialize_default,
+ custom_deserialize_default
+};
+
+static value
+Val_xv (SV *sv)
+{
+ CAMLparam0 ();
+ CAMLlocal1 (rv);
+ rv = caml_alloc_custom (&xv_custom_operations, sizeof (void *), 0, 1);
+ Xv_val (rv) = sv;
+ CAMLreturn (rv);
+}
+
+#endif /* PERL4CAML_REFCOUNTING_EXPERIMENTAL */
+
static value
unoption (value option, value deflt)
{