src/data/sys-file-private.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2006, 2007 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 /* Infrastructure common to system file reader and writer.
  18
  19    Old versions of SPSS limited string variables to a width of
  20    255 bytes.  For backward compatibility with these older
  21    versions, the system file format represents a string longer
  22    than 255 bytes, called a "very long string", as a collection
  23    of strings no longer than 255 bytes each.  The strings
  24    concatenated to make a very long string are called its
  25    "segments"; for consistency, variables other than very long
  26    strings are considered to have a single segment.
  27
  28    The interfaces in this file primarily provide support for
  29    dealing with very long strings.  */
  30
  31 #ifndef DATA_SYS_FILE_PRIVATE_H
  32 #define DATA_SYS_FILE_PRIVATE_H 1
  33
  34 #include <stddef.h>
  35
  36 struct dictionary;
  37
  38 /* A variable in a system file. */
  39 struct sfm_var
  40   {
  41     int width;                  /* Value width (0=numeric, else string). */
  42     int case_index;             /* Index into case. */
  43
  44     /* The following members are interesting only for string
  45        variables (width != 0).  For numeric variables (width ==
  46        0) their values are always 0.
  47
  48        Note: width + padding is always a multiple of 8. */
  49     int offset;                 /* Offset within string variable in case. */
  50     int padding;                /* Number of padding bytes following data. */
  51   };
  52
  53 int sfm_dictionary_to_sfm_vars (const struct dictionary *,
  54                                 struct sfm_var **, size_t *);
  55
  56 int sfm_width_to_octs (int width);
  57 int sfm_width_to_segments (int width);
  58
  59 int sfm_segment_effective_offset (int width, int segment);
  60 int sfm_segment_alloc_width (int width, int segment);
  61
  62 #endif /* data/sys-file-private.h */