Add perl functions to get the format of a variable
[pspp-builds.git] / perl-module / PSPP.xs
1 /* PSPP - computes sample statistics.
2    Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software
16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17    02110-1301, USA. */
18
19
20 #include "EXTERN.h"
21 #include "perl.h"
22 #include "XSUB.h"
23
24 #include <config.h>
25
26 #include "ppport.h"
27
28 #include "minmax.h"
29 #include <libpspp/message.h>
30 #include <libpspp/version.h>
31 #include <gl/xalloc.h>
32 #include <data/dictionary.h>
33 #include <data/case.h>
34 #include <data/casereader.h>
35 #include <data/variable.h>
36 #include <data/attributes.h>
37 #include <data/file-handle-def.h>
38 #include <data/sys-file-writer.h>
39 #include <data/sys-file-reader.h>
40 #include <data/value.h>
41 #include <data/vardict.h>
42 #include <data/value-labels.h>
43 #include <data/format.h>
44 #include <data/data-in.h>
45 #include <data/data-out.h>
46 #include <string.h>
47
48 typedef struct fmt_spec input_format ;
49 typedef struct fmt_spec output_format ;
50
51
52 /*  A thin wrapper around sfm_writer */
53 struct sysfile_info
54 {
55   bool opened;
56
57   /* A pointer to the writer. The writer is owned by the struct */
58   struct casewriter *writer;
59
60   /* A pointer to the dictionary. Owned externally */
61   const struct dictionary *dict;
62
63   /* The scalar containing the dictionary */
64   SV *dict_sv;
65 };
66
67
68 /*  A thin wrapper around sfm_reader */
69 struct sysreader_info
70 {
71   struct sfm_read_info opts;
72
73   /* A pointer to the reader. The reader is owned by the struct */
74   struct casereader *reader;
75
76   /* A pointer to the dictionary. */
77   struct dictionary *dict;
78 };
79
80
81
82 /*  A message handler which writes messages to PSPP::errstr */
83 static void
84 message_handler (const struct msg *m)
85 {
86  SV *errstr = get_sv("PSPP::errstr", TRUE);
87  sv_setpv (errstr, m->text);
88 }
89
90 static int
91 sysfile_close (struct sysfile_info *sfi)
92 {
93   int retval ;
94   if ( ! sfi->opened )
95     return 0;
96
97   retval = casewriter_destroy (sfi->writer);
98   if (retval > 0 )
99     sfi->opened = false;
100
101   return retval;
102 }
103
104 static void
105 scalar_to_value (union value *val, SV *scalar, const struct variable *var)
106 {
107   if ( var_is_numeric (var))
108     {
109         if ( SvNOK (scalar) || SvIOK (scalar) )
110            val->f = SvNV (scalar);
111         else
112            val->f = SYSMIS;
113     }
114   else
115     {
116         STRLEN len;
117         const char *p = SvPV (scalar, len);
118         int width = var_get_width (var);
119         value_set_missing (val, width);
120         memcpy (value_str_rw (val, width), p, len);
121     }
122 }
123
124
125 static SV *
126 value_to_scalar (const union value *val, const struct variable *var)
127 {
128   if ( var_is_numeric (var))
129     {
130       if ( var_is_value_missing (var, val, MV_SYSTEM))
131         return newSVpvn ("", 0);
132
133       return newSVnv (val->f);
134     }
135   else
136     {
137       int width = var_get_width (var);
138       return newSVpvn (value_str (val, width), width);
139     }
140 }
141
142
143 static void
144 var_set_input_format (struct variable *v, input_format ip_fmt)
145 {
146   struct fmt_spec *if_copy = malloc (sizeof (*if_copy));
147   memcpy (if_copy, &ip_fmt, sizeof (ip_fmt));
148   var_attach_aux (v, if_copy, var_dtor_free);
149 }
150
151 static void
152 make_value_from_scalar (union value *uv, SV *val, const struct variable *var)
153 {
154  value_init (uv, var_get_width (var));
155  scalar_to_value (uv, val, var);
156 }
157
158
159 MODULE = PSPP
160
161 MODULE = PSPP           PACKAGE = PSPP
162
163 void
164 onBoot (ver)
165  const char *ver
166 CODE:
167  assert (0 == strcmp (ver, bare_version));
168  i18n_init ();
169  msg_init (NULL, message_handler);
170  settings_init (0, 0);
171  fh_init ();
172
173 SV *
174 format_value (val, var)
175  SV *val
176  struct variable *var
177 CODE:
178  SV *ret;
179  const struct fmt_spec *fmt = var_get_print_format (var);
180  const struct dictionary *dict = var_get_vardict (var)->dict;
181  union value uv;
182  char *s;
183  make_value_from_scalar (&uv, val, var);
184  s = data_out (&uv, dict_get_encoding (dict), fmt);
185  value_destroy (&uv, var_get_width (var));
186  ret = newSVpv (s, fmt->w);
187  free (s);
188  RETVAL = ret;
189  OUTPUT:
190 RETVAL
191
192
193 int
194 value_is_missing (val, var)
195  SV *val
196  struct variable *var
197 CODE:
198  union value uv;
199  int ret;
200  make_value_from_scalar (&uv, val, var);
201  ret = var_is_value_missing (var, &uv, MV_ANY);
202  value_destroy (&uv, var_get_width (var));
203  RETVAL = ret;
204  OUTPUT:
205 RETVAL
206
207
208
209 MODULE = PSPP           PACKAGE = PSPP::Dict
210
211 struct dictionary *
212 pxs_dict_new()
213 CODE:
214  RETVAL = dict_create ();
215 OUTPUT:
216  RETVAL
217
218
219 void
220 DESTROY (dict)
221  struct dictionary *dict
222 CODE:
223  dict_destroy (dict);
224
225
226 int
227 get_var_cnt (dict)
228  struct dictionary *dict
229 CODE:
230  RETVAL = dict_get_var_cnt (dict);
231 OUTPUT:
232 RETVAL
233
234 void
235 set_label (dict, label)
236  struct dictionary *dict
237  char *label
238 CODE:
239  dict_set_label (dict, label);
240
241 void
242 set_documents (dict, docs)
243  struct dictionary *dict
244  char *docs
245 CODE:
246  dict_set_documents (dict, docs);
247
248
249 void
250 add_document (dict, doc)
251  struct dictionary *dict
252  char *doc
253 CODE:
254  dict_add_document_line (dict, doc);
255
256
257 void
258 clear_documents (dict)
259  struct dictionary *dict
260 CODE:
261  dict_clear_documents (dict);
262
263
264 void
265 set_weight (dict, var)
266  struct dictionary *dict
267  struct variable *var
268 CODE:
269  dict_set_weight (dict, var);
270
271
272 struct variable *
273 pxs_get_variable (dict, idx)
274  struct dictionary *dict
275  SV *idx
276 INIT:
277  SV *errstr = get_sv("PSPP::errstr", TRUE);
278  sv_setpv (errstr, "");
279  if ( SvIV (idx) >= dict_get_var_cnt (dict))
280   {
281     sv_setpv (errstr, "The dictionary doesn't have that many variables.");
282     XSRETURN_UNDEF;
283   }
284 CODE:
285  RETVAL = dict_get_var (dict, SvIV (idx));
286  OUTPUT:
287 RETVAL
288
289
290 struct variable *
291 pxs_get_var_by_name (dict, name)
292  struct dictionary *dict
293  const char *name
294 INIT:
295  SV *errstr = get_sv("PSPP::errstr", TRUE);
296  sv_setpv (errstr, "");
297 CODE:
298  struct variable *var = dict_lookup_var (dict, name);
299  if ( ! var )
300       sv_setpv (errstr, "No such variable.");
301  RETVAL = var;
302  OUTPUT:
303 RETVAL
304
305
306 MODULE = PSPP           PACKAGE = PSPP::Var
307
308
309 struct variable *
310 pxs_dict_create_var (dict, name, ip_fmt)
311  struct dictionary * dict
312  char *name
313  input_format ip_fmt
314 INIT:
315  SV *errstr = get_sv("PSPP::errstr", TRUE);
316  sv_setpv (errstr, "");
317  if ( ! var_is_plausible_name (name, false))
318   {
319     sv_setpv (errstr, "The variable name is not valid.");
320     XSRETURN_UNDEF;
321   }
322 CODE:
323  struct fmt_spec op_fmt;
324
325  struct variable *v;
326  op_fmt = fmt_for_output_from_input (&ip_fmt);
327  v = dict_create_var (dict, name,
328         fmt_is_string (op_fmt.type) ? op_fmt.w : 0);
329  if ( NULL == v )
330   {
331     sv_setpv (errstr, "The variable could not be created (probably already exists).");
332     XSRETURN_UNDEF;
333   }
334  var_set_both_formats (v, &op_fmt);
335  var_set_input_format (v, ip_fmt);
336  RETVAL = v;
337 OUTPUT:
338  RETVAL
339
340
341 int
342 set_missing_values (var, v1, ...)
343  struct variable *var;
344  SV *v1;
345 INIT:
346  int i;
347  union value val[3];
348
349  if ( items > 4 )
350   croak ("No more than 3 missing values are permitted");
351
352  for (i = 0; i < items - 1; ++i)
353    scalar_to_value (&val[i], ST(i+1), var);
354 CODE:
355  struct missing_values mv;
356  mv_init (&mv, var_get_width (var));
357  for (i = 0 ; i < items - 1; ++i )
358    mv_add_value (&mv, &val[i]);
359  var_set_missing_values (var, &mv);
360
361
362 void
363 set_label (var, label)
364  struct variable *var;
365  char *label
366 CODE:
367   var_set_label (var, label);
368
369
370 void
371 clear_value_labels (var)
372  struct variable *var;
373 CODE:
374  var_clear_value_labels (var);
375
376 SV *
377 get_write_format (var)
378  struct variable *var
379 CODE:
380  HV *fmthash = (HV *) sv_2mortal ((SV *) newHV());
381  const struct fmt_spec *fmt = var_get_write_format (var);
382
383  hv_store (fmthash, "fmt", 3, newSVnv (fmt->type), 0);
384  hv_store (fmthash, "decimals", 8, newSVnv (fmt->d), 0);
385  hv_store (fmthash, "width", 5, newSVnv (fmt->w), 0);
386
387  RETVAL = newRV ((SV *) fmthash);
388  OUTPUT:
389 RETVAL
390
391 SV *
392 get_print_format (var)
393  struct variable *var
394 CODE:
395  HV *fmthash = (HV *) sv_2mortal ((SV *) newHV());
396  const struct fmt_spec *fmt = var_get_print_format (var);
397
398  hv_store (fmthash, "fmt", 3, newSVnv (fmt->type), 0);
399  hv_store (fmthash, "decimals", 8, newSVnv (fmt->d), 0);
400  hv_store (fmthash, "width", 5, newSVnv (fmt->w), 0);
401
402  RETVAL = newRV ((SV *) fmthash);
403  OUTPUT:
404 RETVAL
405
406
407 void
408 pxs_set_write_format (var, fmt)
409  struct variable *var
410  output_format fmt
411 CODE:
412  var_set_write_format (var, &fmt);
413
414
415 void
416 pxs_set_print_format (var, fmt)
417  struct variable *var
418  output_format fmt
419 CODE:
420  var_set_print_format (var, &fmt);
421
422 void
423 pxs_set_output_format (var, fmt)
424  struct variable *var
425  output_format fmt
426 CODE:
427  var_set_both_formats (var, &fmt);
428
429
430 int
431 add_value_label (var, key, label)
432  struct variable *var
433  SV *key
434  char *label
435 INIT:
436  SV *errstr = get_sv("PSPP::errstr", TRUE);
437  sv_setpv (errstr, "");
438 CODE:
439  union value the_value;
440  int width = var_get_width (var);
441  int ok;
442
443  value_init (&the_value, width);
444  if ( var_is_numeric (var))
445  {
446   if ( ! looks_like_number (key))
447     {
448       sv_setpv (errstr, "Cannot add label with string key to a numeric variable");
449       value_destroy (&the_value, width);
450       XSRETURN_IV (0);
451     }
452   the_value.f = SvNV (key);
453  }
454  else
455  {
456   value_copy_str_rpad (&the_value, width, SvPV_nolen(key), ' ');
457  }
458  ok = var_add_value_label (var, &the_value, label);
459  value_destroy (&the_value, width);
460  if (!ok)
461  {
462    sv_setpv (errstr, "Something went wrong");
463    XSRETURN_IV (0);
464  }
465  XSRETURN_IV (1);
466
467
468 SV *
469 get_attributes (var)
470  struct variable *var
471 CODE:
472  HV *attrhash = (HV *) sv_2mortal ((SV *) newHV());
473
474  struct attrset *as = var_get_attributes (var);
475
476  if ( as )
477    {
478      struct attrset_iterator iter;
479      struct attribute *attr;
480
481      for (attr = attrset_first (as, &iter);
482           attr;
483           attr = attrset_next (as, &iter))
484        {
485          int i;
486          const char *name = attribute_get_name (attr);
487
488          AV *values = newAV ();
489
490          for (i = 0 ; i < attribute_get_n_values (attr); ++i )
491            {
492              const char *value = attribute_get_value (attr, i);
493              av_push (values, newSVpv (value, 0));
494            }
495
496          hv_store (attrhash, name, strlen (name),
497                    newRV_noinc ((SV*) values), 0);
498        }
499    }
500
501  RETVAL = newRV ((SV *) attrhash);
502  OUTPUT:
503 RETVAL
504
505
506 const char *
507 get_name (var)
508  struct variable * var
509 CODE:
510  RETVAL = var_get_name (var);
511  OUTPUT:
512 RETVAL
513
514
515 const char *
516 get_label (var)
517  struct variable * var
518 CODE:
519  RETVAL = var_get_label (var);
520  OUTPUT:
521 RETVAL
522
523
524 SV *
525 get_value_labels (var)
526  struct variable *var
527 CODE:
528  HV *labelhash = (HV *) sv_2mortal ((SV *) newHV());
529  const struct val_lab *vl;
530  struct val_labs_iterator *viter = NULL;
531  const struct val_labs *labels = var_get_value_labels (var);
532
533  if ( labels )
534    {
535      for (vl = val_labs_first (labels);
536           vl;
537           vl = val_labs_next (labels, vl))
538        {
539          SV *sv = value_to_scalar (&vl->value, var);
540          STRLEN len;
541          const char *s = SvPV (sv, len);
542          hv_store (labelhash, s, len, newSVpv (val_lab_get_label (vl), 0), 0);
543        }
544    }
545
546  RETVAL = newRV ((SV *) labelhash);
547  OUTPUT:
548 RETVAL
549
550
551
552 MODULE = PSPP           PACKAGE = PSPP::Sysfile
553
554
555 struct sysfile_info *
556 pxs_create_sysfile (name, dict_ref, opts_hr)
557  char *name
558  SV *dict_ref
559  SV *opts_hr
560 INIT:
561  SV *dict_sv = SvRV (dict_ref);
562  struct dictionary *dict = (void *) SvIV (dict_sv);
563  struct sfm_write_options opts;
564  if (!SvROK (opts_hr))
565   {
566     opts = sfm_writer_default_options ();
567   }
568  else
569   {
570     HV *opt_h = (HV *) SvRV (opts_hr);
571     SV** readonly = hv_fetch(opt_h, "readonly", 8, 0);
572     SV** compress = hv_fetch(opt_h, "compress", 8, 0);
573     SV** version = hv_fetch(opt_h, "version", 7, 0);
574
575     opts.create_writeable = readonly ? ! SvIV (*readonly) : true;
576     opts.compress = compress ? SvIV (*compress) : false;
577     opts.version = version ? SvIV (*version) : 3 ;
578   }
579 CODE:
580  struct file_handle *fh =
581   fh_create_file (NULL, name, fh_default_properties () );
582  struct sysfile_info *sfi = xmalloc (sizeof (*sfi));
583  sfi->writer = sfm_open_writer (fh, dict, opts);
584  sfi->dict = dict;
585  sfi->opened = true;
586  sfi->dict_sv = dict_sv;
587  SvREFCNT_inc (sfi->dict_sv);
588  
589  RETVAL = sfi;
590  OUTPUT:
591 RETVAL
592
593 int
594 close (sfi)
595  struct sysfile_info *sfi
596 CODE:
597  RETVAL = sysfile_close (sfi);
598 OUTPUT:
599  RETVAL
600
601 void
602 DESTROY (sfi)
603  struct sysfile_info *sfi
604 CODE:
605  sysfile_close (sfi);
606  SvREFCNT_dec (sfi->dict_sv);
607  free (sfi);
608
609 int
610 append_case (sfi, ccase)
611  struct sysfile_info *sfi
612  SV *ccase
613 INIT:
614  SV *errstr = get_sv("PSPP::errstr", TRUE);
615  sv_setpv (errstr, "");
616  if ( (!SvROK(ccase)))
617   {
618     XSRETURN_UNDEF;
619   }
620 CODE:
621  int i = 0;
622  AV *av_case = (AV*) SvRV (ccase);
623
624  const struct variable **vv;
625  size_t nv;
626  struct ccase *c;
627  SV *sv;
628
629  if ( av_len (av_case) >= dict_get_var_cnt (sfi->dict))
630    XSRETURN_UNDEF;
631
632  c =  case_create (dict_get_proto (sfi->dict));
633
634  dict_get_vars (sfi->dict, &vv, &nv, 1u << DC_ORDINARY | 1u << DC_SYSTEM);
635
636  for (sv = av_shift (av_case); SvOK (sv);  sv = av_shift (av_case))
637  {
638     const struct variable *v = vv[i++];
639     const struct fmt_spec *ifmt = var_get_aux (v);
640
641     /* If an input format has been set, then use it.
642        Otherwise just convert the raw value.
643     */
644     if ( ifmt )
645       {
646         struct substring ss = ss_cstr (SvPV_nolen (sv));
647         if ( ! data_in (ss, LEGACY_NATIVE, ifmt->type, 0, 0, 0,
648                         sfi->dict,
649                         case_data_rw (c, v),
650                         var_get_width (v)) )
651           {
652             RETVAL = 0;
653             goto finish;
654           }
655       }
656     else
657       {
658         scalar_to_value (case_data_rw (c, v), sv, v);
659       }
660  }
661
662  /* The remaining variables must be sysmis or blank string */
663  while (i < dict_get_var_cnt (sfi->dict))
664  {
665    const struct variable *v = vv[i++];
666    union value *val = case_data_rw (c, v);
667    value_set_missing (val, var_get_width (v));
668  }
669  RETVAL = casewriter_write (sfi->writer, c);
670  finish:
671  free (vv);
672 OUTPUT:
673  RETVAL
674
675
676 \f
677
678 MODULE = PSPP           PACKAGE = PSPP::Reader
679
680 struct sysreader_info *
681 pxs_open_sysfile (name)
682  char * name
683 CODE:
684  struct casereader *reader;
685  struct sysreader_info *sri = NULL;
686  struct file_handle *fh =
687          fh_create_file (NULL, name, fh_default_properties () );
688
689  sri = xmalloc (sizeof (*sri));
690  sri->reader = sfm_open_reader (fh, &sri->dict, &sri->opts);
691
692  if ( NULL == sri->reader)
693  {
694    free (sri);
695    sri = NULL;
696  }
697
698  RETVAL = sri;
699  OUTPUT:
700 RETVAL
701
702
703 struct dictionary *
704 pxs_get_dict (reader)
705  struct sysreader_info *reader;
706 CODE:
707  RETVAL = reader->dict;
708  OUTPUT:
709 RETVAL
710
711
712 void
713 get_next_case (sfr)
714  struct sysreader_info *sfr;
715 PPCODE:
716  struct ccase *c;
717
718  if (c = casereader_read (sfr->reader))
719  {
720   int v;
721
722   EXTEND (SP, dict_get_var_cnt (sfr->dict));
723   for (v = 0; v < dict_get_var_cnt (sfr->dict); ++v )
724     {
725       const struct variable *var = dict_get_var (sfr->dict, v);
726       const union value *val = case_data (c, var);
727
728       PUSHs (sv_2mortal (value_to_scalar (val, var)));
729     }
730
731   case_unref (c);
732  }