work on docs
[pspp] / perl-module / PSPP.xs
index 400aeda7b12ce45ada26c7dc138d8b5bf0224f4a..077bf581f0031cfe27332efbbf54c2dbec6e04a3 100644 (file)
@@ -1,22 +1,21 @@
 /* PSPP - computes sample statistics.
-   Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014,
+   2020 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program 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
-   General Public License for more details.
+   This program 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
-
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
+#undef VERSION
 #include <config.h>
 
 /* The Gnulib "strftime" module defines my_strftime in <config.h> for use by
 #include "ppport.h"
 
 #include "minmax.h"
+#include <libpspp/hmap.h>
+#include <libpspp/hash-functions.h>
 #include <libpspp/message.h>
 #include <libpspp/version.h>
+#include <libpspp/i18n.h>
 #include <gl/xalloc.h>
 #include <data/dictionary.h>
 #include <data/case.h>
 #include <data/casereader.h>
+#include <data/casewriter.h>
 #include <data/variable.h>
 #include <data/attributes.h>
 #include <data/file-handle-def.h>
+#include <data/identifier.h>
+#include <data/settings.h>
 #include <data/sys-file-writer.h>
-#include <data/sys-file-reader.h>
 #include <data/value.h>
 #include <data/vardict.h>
 #include <data/value-labels.h>
@@ -56,7 +60,7 @@ typedef struct fmt_spec output_format ;
 
 
 /*  A thin wrapper around sfm_writer */
-struct sysfile_info
+struct syswriter_info
 {
   bool opened;
 
@@ -64,7 +68,7 @@ struct sysfile_info
   struct casewriter *writer;
 
   /* A pointer to the dictionary. Owned externally */
-  const struct dictionary *dict;
+  const struct pspp_dict *dict;
 
   /* The scalar containing the dictionary */
   SV *dict_sv;
@@ -74,35 +78,47 @@ struct sysfile_info
 /*  A thin wrapper around sfm_reader */
 struct sysreader_info
 {
-  struct sfm_read_info opts;
+  struct any_read_info opts;
 
   /* A pointer to the reader. The reader is owned by the struct */
   struct casereader *reader;
 
   /* A pointer to the dictionary. */
-  struct dictionary *dict;
+  struct pspp_dict *dict;
+};
+
+
+struct input_format {
+  struct hmap_node hmap_node;   /* In struct pspp_dict's input_formats map. */
+  const struct variable *var;
+  struct fmt_spec input_format;
 };
 
+/* A thin wrapper around struct dictionary.*/
+struct pspp_dict {
+  struct dictionary *dict;
+  struct hmap input_formats;   /* Contains struct input_format. */
+};
 
 
 /*  A message handler which writes messages to PSPP::errstr */
 static void
-message_handler (const struct msg *m)
+message_handler (const struct msg *m, void *aux)
 {
  SV *errstr = get_sv("PSPP::errstr", TRUE);
  sv_setpv (errstr, m->text);
 }
 
 static int
-sysfile_close (struct sysfile_info *sfi)
+sysfile_close (struct syswriter_info *swi)
 {
   int retval ;
-  if ( ! sfi->opened )
+  if ( ! swi->opened )
     return 0;
 
-  retval = casewriter_destroy (sfi->writer);
+  retval = casewriter_destroy (swi->writer);
   if (retval > 0 )
-    sfi->opened = false;
+    swi->opened = false;
 
   return retval;
 }
@@ -123,7 +139,7 @@ scalar_to_value (union value *val, SV *scalar, const struct variable *var)
        const char *p = SvPV (scalar, len);
        int width = var_get_width (var);
        value_set_missing (val, width);
-       memcpy (value_str_rw (val, width), p, len);
+       memcpy (val->s, p, len);
     }
 }
 
@@ -133,7 +149,7 @@ value_to_scalar (const union value *val, const struct variable *var)
 {
   if ( var_is_numeric (var))
     {
-      if ( var_is_value_missing (var, val, MV_SYSTEM))
+      if (var_is_value_missing (var, val) == MV_SYSTEM)
        return newSVpvn ("", 0);
 
       return newSVnv (val->f);
@@ -141,19 +157,11 @@ value_to_scalar (const union value *val, const struct variable *var)
   else
     {
       int width = var_get_width (var);
-      return newSVpvn (value_str (val, width), width);
+      return newSVpvn ((char *) val->s, width);
     }
 }
 
 
-static void
-var_set_input_format (struct variable *v, input_format ip_fmt)
-{
-  struct fmt_spec *if_copy = malloc (sizeof (*if_copy));
-  memcpy (if_copy, &ip_fmt, sizeof (ip_fmt));
-  var_attach_aux (v, if_copy, var_dtor_free);
-}
-
 static void
 make_value_from_scalar (union value *uv, SV *val, const struct variable *var)
 {
@@ -161,6 +169,28 @@ make_value_from_scalar (union value *uv, SV *val, const struct variable *var)
  scalar_to_value (uv, val, var);
 }
 
+static struct pspp_dict *
+create_pspp_dict (struct dictionary *dict)
+{
+  struct pspp_dict *pspp_dict = xmalloc (sizeof *pspp_dict);
+  pspp_dict->dict = dict;
+  hmap_init (&pspp_dict->input_formats);
+  return pspp_dict;
+}
+
+static const struct fmt_spec *
+find_input_format (const struct pspp_dict *dict, const struct variable *var)
+{
+  struct input_format *input_format;
+
+  HMAP_FOR_EACH_IN_BUCKET (input_format, struct input_format, hmap_node,
+                           hash_pointer (var, 0), &dict->input_formats)
+    if (input_format->var == var)
+      return &input_format->input_format;
+
+  return NULL;
+}
+
 
 MODULE = PSPP
 
@@ -178,8 +208,9 @@ CODE:
  assert (0 == strncmp (ver, bare_version, strlen (ver)));
 
  i18n_init ();
- msg_init (NULL, message_handler);
- settings_init (0, 0);
+const struct msg_handler mh = { .output_msg = message_handler };
+ msg_set_handler (&mh);
+ settings_init ();
  fh_init ();
 
 SV *
@@ -192,7 +223,7 @@ CODE:
  union value uv;
  char *s;
  make_value_from_scalar (&uv, val, var);
- s = data_out (&uv, var_get_encoding (var), fmt);
+ s = data_out (&uv, var_get_encoding (var), fmt, settings_get_fmt_settings ());
  value_destroy (&uv, var_get_width (var));
  ret = newSVpv (s, fmt->w);
  free (s);
@@ -209,7 +240,7 @@ CODE:
  union value uv;
  int ret;
  make_value_from_scalar (&uv, val, var);
- ret = var_is_value_missing (var, &uv, MV_ANY);
+ ret = var_is_value_missing (var, &uv) != 0;
  value_destroy (&uv, var_get_width (var));
  RETVAL = ret;
  OUTPUT:
@@ -219,94 +250,106 @@ RETVAL
 
 MODULE = PSPP          PACKAGE = PSPP::Dict
 
-struct dictionary *
+struct pspp_dict *
 pxs_dict_new()
 CODE:
- RETVAL = dict_create ();
+ RETVAL = create_pspp_dict (dict_create ("UTF-8"));
 OUTPUT:
  RETVAL
 
 
 void
 DESTROY (dict)
- struct dictionary *dict
+ struct pspp_dict *dict
 CODE:
- dict_destroy (dict);
+ if (dict != NULL)
+   {
+     struct input_format *input_format, *next_input_format;
 
+     HMAP_FOR_EACH_SAFE (input_format, next_input_format,
+                        struct input_format, hmap_node, &dict->input_formats)
+       {
+         hmap_delete (&dict->input_formats, &input_format->hmap_node);
+        free (input_format);
+       }
+     hmap_destroy (&dict->input_formats);
+     dict_unref (dict->dict);
+     free (dict);
+   }
 
 int
 get_var_cnt (dict)
- struct dictionary *dict
+ struct pspp_dict *dict
 CODE:
- RETVAL = dict_get_var_cnt (dict);
+ RETVAL = dict_get_n_vars (dict->dict);
 OUTPUT:
 RETVAL
 
 void
 set_label (dict, label)
- struct dictionary *dict
+ struct pspp_dict *dict
  char *label
 CODE:
- dict_set_label (dict, label);
+ dict_set_label (dict->dict, label);
 
 void
 set_documents (dict, docs)
- struct dictionary *dict
+ struct pspp_dict *dict
  char *docs
 CODE:
- dict_set_documents (dict, docs);
+ dict_set_documents_string (dict->dict, docs);
 
 
 void
 add_document (dict, doc)
- struct dictionary *dict
+ struct pspp_dict *dict
  char *doc
 CODE:
- dict_add_document_line (dict, doc);
+ dict_add_document_line (dict->dict, doc, false);
 
 
 void
 clear_documents (dict)
- struct dictionary *dict
+ struct pspp_dict *dict
 CODE:
- dict_clear_documents (dict);
+ dict_clear_documents (dict->dict);
 
 
 void
 set_weight (dict, var)
- struct dictionary *dict
+ struct pspp_dict *dict
  struct variable *var
 CODE:
- dict_set_weight (dict, var);
+ dict_set_weight (dict->dict, var);
 
 
 struct variable *
 pxs_get_variable (dict, idx)
- struct dictionary *dict
+ struct pspp_dict *dict
  SV *idx
 INIT:
  SV *errstr = get_sv("PSPP::errstr", TRUE);
  sv_setpv (errstr, "");
- if ( SvIV (idx) >= dict_get_var_cnt (dict))
+ if ( SvIV (idx) >= dict_get_n_vars (dict->dict))
   {
     sv_setpv (errstr, "The dictionary doesn't have that many variables.");
     XSRETURN_UNDEF;
   }
 CODE:
- RETVAL = dict_get_var (dict, SvIV (idx));
+ RETVAL = dict_get_var (dict->dict, SvIV (idx));
  OUTPUT:
 RETVAL
 
 
 struct variable *
 pxs_get_var_by_name (dict, name)
- struct dictionary *dict
+ struct pspp_dict *dict
  const char *name
 INIT:
  SV *errstr = get_sv("PSPP::errstr", TRUE);
  sv_setpv (errstr, "");
 CODE:
- struct variable *var = dict_lookup_var (dict, name);
+ struct variable *var = dict_lookup_var (dict->dict, name);
  if ( ! var )
       sv_setpv (errstr, "No such variable.");
  RETVAL = var;
@@ -319,23 +362,24 @@ MODULE = PSPP             PACKAGE = PSPP::Var
 
 struct variable *
 pxs_dict_create_var (dict, name, ip_fmt)
- struct dictionary * dict
+ struct pspp_dict * dict
  char *name
  input_format ip_fmt
 INIT:
  SV *errstr = get_sv("PSPP::errstr", TRUE);
  sv_setpv (errstr, "");
- if ( ! var_is_plausible_name (name, false))
+ if ( ! id_is_plausible (name, false))
   {
     sv_setpv (errstr, "The variable name is not valid.");
     XSRETURN_UNDEF;
   }
 CODE:
  struct fmt_spec op_fmt;
+ struct input_format *input_format;
 
  struct variable *v;
- op_fmt = fmt_for_output_from_input (&ip_fmt);
- v = dict_create_var (dict, name,
+ op_fmt = fmt_for_output_from_input (&ip_fmt, settings_get_fmt_settings ());
+ v = dict_create_var (dict->dict, name,
        fmt_is_string (op_fmt.type) ? op_fmt.w : 0);
  if ( NULL == v )
   {
@@ -343,7 +387,13 @@ CODE:
     XSRETURN_UNDEF;
   }
  var_set_both_formats (v, &op_fmt);
- var_set_input_format (v, ip_fmt);
+
+ input_format = xmalloc (sizeof *input_format);
+ input_format->var = v;
+ input_format->input_format = ip_fmt;
+ hmap_insert (&dict->input_formats, &input_format->hmap_node,
+              hash_pointer (v, 0));
+
  RETVAL = v;
 OUTPUT:
  RETVAL
@@ -361,12 +411,15 @@ INIT:
   croak ("No more than 3 missing values are permitted");
 
  for (i = 0; i < items - 1; ++i)
-   scalar_to_value (&val[i], ST(i+1), var);
+   make_value_from_scalar (&val[i], ST(i+1), var);
 CODE:
  struct missing_values mv;
  mv_init (&mv, var_get_width (var));
  for (i = 0 ; i < items - 1; ++i )
-   mv_add_value (&mv, &val[i]);
+   {
+     mv_add_value (&mv, &val[i]);
+     value_destroy (&val[i], var_get_width (var));
+   }
  var_set_missing_values (var, &mv);
 
 
@@ -538,7 +591,6 @@ get_value_labels (var)
 CODE:
  HV *labelhash = (HV *) sv_2mortal ((SV *) newHV());
  const struct val_lab *vl;
- struct val_labs_iterator *viter = NULL;
  const struct val_labs *labels = var_get_value_labels (var);
 
  if ( labels )
@@ -563,14 +615,13 @@ RETVAL
 MODULE = PSPP          PACKAGE = PSPP::Sysfile
 
 
-struct sysfile_info *
-pxs_create_sysfile (name, dict_ref, opts_hr)
+struct syswriter_info *
+pxs_create_sysfile (name, dict, opts_hr)
  char *name
- SV *dict_ref
+ struct pspp_dict *dict;
  SV *opts_hr
 INIT:
- SV *dict_sv = SvRV (dict_ref);
- struct dictionary *dict = (void *) SvIV (dict_sv);
+ SV *dict_sv = ST(1);
  struct sfm_write_options opts;
  if (!SvROK (opts_hr))
   {
@@ -584,43 +635,44 @@ INIT:
     SV** version = hv_fetch(opt_h, "version", 7, 0);
 
     opts.create_writeable = readonly ? ! SvIV (*readonly) : true;
-    opts.compress = compress ? SvIV (*compress) : false;
+    opts.compression = (compress && SvIV (*compress)
+                        ? ANY_COMP_SIMPLE
+                       : ANY_COMP_NONE);
     opts.version = version ? SvIV (*version) : 3 ;
   }
 CODE:
  struct file_handle *fh =
-  fh_create_file (NULL, name, fh_default_properties () );
- struct sysfile_info *sfi = xmalloc (sizeof (*sfi));
- dict_set_encoding (dict, "UTF-8");
- sfi->writer = sfm_open_writer (fh, dict, opts);
- sfi->dict = dict;
- sfi->opened = true;
- sfi->dict_sv = dict_sv;
- SvREFCNT_inc (sfi->dict_sv);
- RETVAL = sfi;
+   fh_create_file (NULL, name, "UTF-8", fh_default_properties () );
+ struct syswriter_info *swi = xmalloc (sizeof (*swi));
+ swi->writer = sfm_open_writer (fh, dict->dict, opts);
+ swi->dict = dict;
+ swi->opened = true;
+ swi->dict_sv = dict_sv;
+ SvREFCNT_inc (swi->dict_sv);
+
+ RETVAL = swi;
  OUTPUT:
 RETVAL
 
 int
-close (sfi)
- struct sysfile_info *sfi
+close (swi)
+ struct syswriter_info *swi
 CODE:
- RETVAL = sysfile_close (sfi);
+ RETVAL = sysfile_close (swi);
 OUTPUT:
  RETVAL
 
 void
-DESTROY (sfi)
- struct sysfile_info *sfi
+DESTROY (swi)
+ struct syswriter_info *swi
 CODE:
- sysfile_close (sfi);
- SvREFCNT_dec (sfi->dict_sv);
- free (sfi);
+ sysfile_close (swi);
+ SvREFCNT_dec (swi->dict_sv);
+ free (swi);
 
 int
-append_case (sfi, ccase)
- struct sysfile_info *sfi
+append_case (swi, ccase)
+ struct syswriter_info *swi
  SV *ccase
 INIT:
  SV *errstr = get_sv("PSPP::errstr", TRUE);
@@ -636,55 +688,57 @@ CODE:
  const struct variable **vv;
  size_t nv;
  struct ccase *c;
- SV *sv;
 
- if ( av_len (av_case) >= dict_get_var_cnt (sfi->dict))
+ if ( av_len (av_case) >= dict_get_n_vars (swi->dict->dict))
    XSRETURN_UNDEF;
 
- c =  case_create (dict_get_proto (sfi->dict));
+ c =  case_create (dict_get_proto (swi->dict->dict));
 
- dict_get_vars (sfi->dict, &vv, &nv, 1u << DC_ORDINARY | 1u << DC_SYSTEM);
+ dict_get_vars (swi->dict->dict, &vv, &nv,
+                1u << DC_ORDINARY | 1u << DC_SYSTEM);
 
- for (sv = av_shift (av_case); SvOK (sv);  sv = av_shift (av_case))
- {
+ for (SV *sv = av_shift (av_case); SvOK (sv);  sv = av_shift (av_case))
 {
     const struct variable *v = vv[i++];
-    const struct fmt_spec *ifmt = var_get_aux (v);
+    const struct fmt_spec *ifmt = find_input_format (swi->dict, v);
 
     /* If an input format has been set, then use it.
-       Otherwise just convert the raw value.
-    */
-    if ( ifmt )
+       Otherwise just convert the raw value.    */
+    if (ifmt)
       {
-       struct substring ss = ss_cstr (SvPV_nolen (sv));
-       char *error;
-       bool ok;
-
-       error = data_in (ss, LEGACY_NATIVE, ifmt->type,
-                        case_data_rw (c, v), var_get_width (v),
-                        dict_get_encoding (sfi->dict));
-        ok = error == NULL;
-        free (error);
-
-       if ( !ok )
-         {
-           RETVAL = 0;
-           goto finish;
-         }
+        struct substring ss = ss_cstr (SvPV_nolen (sv));
+        char *error = data_in (ss,
+                               SvUTF8(sv) ? UTF8: "iso-8859-1",
+                               ifmt->type,
+                               settings_get_fmt_settings (),
+                               case_data_rw (c, v),
+                               var_get_width (v),
+                               dict_get_encoding (swi->dict->dict));
+        if (error)
+          {
+            free (error);
+            RETVAL = 0;
+            SvREFCNT_dec_NN (sv);
+            case_unref (c);
+            goto finish;
+          }
       }
     else
       {
-       scalar_to_value (case_data_rw (c, v), sv, v);
+        scalar_to_value (case_data_rw (c, v), sv, v);
       }
- }
+    SvREFCNT_dec_NN (sv);
+  }
 
  /* The remaining variables must be sysmis or blank string */
- while (i < dict_get_var_cnt (sfi->dict))
+ while (i < dict_get_n_vars (swi->dict->dict))
  {
    const struct variable *v = vv[i++];
    union value *val = case_data_rw (c, v);
    value_set_missing (val, var_get_width (v));
  }
- RETVAL = casewriter_write (sfi->writer, c);
+ casewriter_write (swi->writer, c);
+ RETVAL = 1;
  finish:
  free (vv);
 OUTPUT:
@@ -699,26 +753,27 @@ struct sysreader_info *
 pxs_open_sysfile (name)
  char * name
 CODE:
- struct casereader *reader;
  struct sysreader_info *sri = NULL;
  struct file_handle *fh =
-        fh_create_file (NULL, name, fh_default_properties () );
+   fh_create_file (NULL, name, "UTF-8", fh_default_properties () );
+ struct dictionary *dict;
 
  sri = xmalloc (sizeof (*sri));
- sri->reader = sfm_open_reader (fh, &sri->dict, &sri->opts);
-
- if ( NULL == sri->reader)
- {
-   free (sri);
-   sri = NULL;
- }
+ sri->reader = any_reader_open_and_decode (fh, NULL, &dict, &sri->opts);
+ if (sri->reader)
+   sri->dict = create_pspp_dict (dict);
+ else
+   {
+     free (sri);
+     sri = NULL;
+   }
 
  RETVAL = sri;
  OUTPUT:
 RETVAL
 
 
-struct dictionary *
+struct pspp_dict *
 pxs_get_dict (reader)
  struct sysreader_info *reader;
 CODE:
@@ -726,6 +781,21 @@ CODE:
  OUTPUT:
 RETVAL
 
+SV *
+get_case_cnt (sfr)
+ struct sysreader_info *sfr;
+CODE:
+ SV *ret;
+ casenumber n = casereader_get_n_cases (sfr->reader);
+ if (n == CASENUMBER_MAX)
+  ret = &PL_sv_undef;
+ else
+  ret = newSViv (n);
+ RETVAL = ret;
+ OUTPUT:
+RETVAL
+
+
 
 void
 get_next_case (sfr)
@@ -733,14 +803,14 @@ get_next_case (sfr)
 PPCODE:
  struct ccase *c;
 
- if (c = casereader_read (sfr->reader))
+ if ((c = casereader_read (sfr->reader)) != NULL)
  {
   int v;
 
-  EXTEND (SP, dict_get_var_cnt (sfr->dict));
-  for (v = 0; v < dict_get_var_cnt (sfr->dict); ++v )
+  EXTEND (SP, dict_get_n_vars (sfr->dict->dict));
+  for (v = 0; v < dict_get_n_vars (sfr->dict->dict); ++v )
     {
-      const struct variable *var = dict_get_var (sfr->dict, v);
+      const struct variable *var = dict_get_var (sfr->dict->dict, v);
       const union value *val = case_data (c, var);
 
       PUSHs (sv_2mortal (value_to_scalar (val, var)));