src/data/scratch-writer.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU 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, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "scratch-writer.h"
  20
  21 #include <stdlib.h>
  22
  23 #include <data/case.h>
  24 #include <data/casereader.h>
  25 #include <data/casewriter-provider.h>
  26 #include <data/casewriter.h>
  27 #include <data/dictionary.h>
  28 #include <data/file-handle-def.h>
  29 #include <data/scratch-handle.h>
  30 #include <libpspp/compiler.h>
  31 #include <libpspp/taint.h>
  32
  33 #include "xalloc.h"
  34
  35 /* A scratch file writer. */
  36 struct scratch_writer
  37   {
  38     struct scratch_handle *handle;      /* Underlying scratch handle. */
  39     struct file_handle *fh;             /* Underlying file handle. */
  40     struct dict_compactor *compactor;   /* Compacts into handle->dictionary. */
  41     struct casewriter *subwriter;       /* Data output. */
  42   };
  43
  44 static struct casewriter_class scratch_writer_casewriter_class;
  45
  46 /* Opens FH, which must have referent type FH_REF_SCRATCH, and
  47    returns a scratch_writer for it, or a null pointer on
  48    failure.  Cases stored in the scratch_writer will be expected
  49    to be drawn from DICTIONARY. */
  50 struct casewriter *
  51 scratch_writer_open (struct file_handle *fh,
  52                      const struct dictionary *dictionary)
  53 {
  54   struct scratch_handle *sh;
  55   struct scratch_writer *writer;
  56   struct dictionary *scratch_dict;
  57   struct dict_compactor *compactor;
  58   struct casewriter *casewriter;
  59   size_t dict_value_cnt;
  60
  61   if (!fh_open (fh, FH_REF_SCRATCH, "scratch file", "we"))
  62     return NULL;
  63
  64   /* Destroy previous contents of handle. */
  65   sh = fh_get_scratch_handle (fh);
  66   if (sh != NULL)
  67     scratch_handle_destroy (sh);
  68
  69   /* Copy the dictionary and compact if needed. */
  70   scratch_dict = dict_clone (dictionary);
  71   if (dict_compacting_would_shrink (scratch_dict))
  72     {
  73       compactor = dict_make_compactor (scratch_dict);
  74       dict_compact_values (scratch_dict);
  75     }
  76   else
  77     compactor = NULL;
  78   dict_value_cnt = dict_get_next_value_idx (scratch_dict);
  79
  80   /* Create new contents. */
  81   sh = xmalloc (sizeof *sh);
  82   sh->dictionary = scratch_dict;
  83   sh->casereader = NULL;
  84
  85   /* Create writer. */
  86   writer = xmalloc (sizeof *writer);
  87   writer->handle = sh;
  88   writer->fh = fh;
  89   writer->compactor = compactor;
  90   writer->subwriter = autopaging_writer_create (dict_value_cnt);
  91
  92   fh_set_scratch_handle (fh, sh);
  93   casewriter = casewriter_create (dict_value_cnt,
  94                                   &scratch_writer_casewriter_class, writer);
  95   taint_propagate (casewriter_get_taint (writer->subwriter),
  96                    casewriter_get_taint (casewriter));
  97   return casewriter;
  98 }
  99
 100 /* Writes case C to WRITER. */
 101 static void
 102 scratch_writer_casewriter_write (struct casewriter *w UNUSED, void *writer_,
 103                                  struct ccase *c)
 104 {
 105   struct scratch_writer *writer = writer_;
 106   struct scratch_handle *handle = writer->handle;
 107   struct ccase tmp;
 108   if (writer->compactor)
 109     {
 110       case_create (&tmp, dict_get_next_value_idx (handle->dictionary));
 111       dict_compactor_compact (writer->compactor, &tmp, c);
 112       case_destroy (c);
 113     }
 114   else
 115     case_move (&tmp, c);
 116   casewriter_write (writer->subwriter, &tmp);
 117 }
 118
 119 /* Closes WRITER. */
 120 static void
 121 scratch_writer_casewriter_destroy (struct casewriter *w UNUSED, void *writer_)
 122 {
 123   struct scratch_writer *writer = writer_;
 124   struct casereader *reader = casewriter_make_reader (writer->subwriter);
 125   if (!casereader_error (reader))
 126     writer->handle->casereader = reader;
 127   fh_close (writer->fh, "scratch file", "we");
 128   free (writer);
 129 }
 130
 131 static struct casewriter_class scratch_writer_casewriter_class =
 132   {
 133     scratch_writer_casewriter_write,
 134     scratch_writer_casewriter_destroy,
 135     NULL,
 136   };