src/language/dictionary/sys-file-info.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #include <config.h>
  21
  22 #include <ctype.h>
  23 #include <stdlib.h>
  24
  25 #include <data/dictionary.h>
  26 #include <data/file-handle-def.h>
  27 #include <data/format.h>
  28 #include <data/missing-values.h>
  29 #include <data/procedure.h>
  30 #include <data/sys-file-reader.h>
  31 #include <data/value-labels.h>
  32 #include <data/variable.h>
  33 #include <data/vector.h>
  34 #include <language/command.h>
  35 #include <language/data-io/file-handle.h>
  36 #include <language/lexer/lexer.h>
  37 #include <language/lexer/variable-parser.h>
  38 #include <libpspp/alloc.h>
  39 #include <libpspp/array.h>
  40 #include <libpspp/hash.h>
  41 #include <libpspp/magic.h>
  42 #include <libpspp/message.h>
  43 #include <libpspp/message.h>
  44 #include <libpspp/misc.h>
  45 #include <output/manager.h>
  46 #include <output/output.h>
  47 #include <output/table.h>
  48
  49 #include "minmax.h"
  50
  51 #include "gettext.h"
  52 #define _(msgid) gettext (msgid)
  53
  54 /* Constants for DISPLAY utility. */
  55 enum
  56   {
  57     AS_NAMES = 0,
  58     AS_INDEX,
  59     AS_VARIABLES,
  60     AS_LABELS,
  61     AS_DICTIONARY,
  62     AS_SCRATCH,
  63     AS_VECTOR
  64   };
  65
  66 static int describe_variable (struct variable *v, struct tab_table *t, int r, int as);
  67
  68 /* Sets the widths of all the columns and heights of all the rows in
  69    table T for driver D. */
  70 static void
  71 sysfile_info_dim (struct tab_table *t, struct outp_driver *d)
  72 {
  73   static const int max[] = {20, 5, 35, 3, 0};
  74   const int *p;
  75   int i;
  76
  77   for (p = max; *p; p++)
  78     t->w[p - max] = MIN (tab_natural_width (t, d, p - max),
  79                          *p * d->prop_em_width);
  80   for (i = 0; i < t->nr; i++)
  81     t->h[i] = tab_natural_height (t, d, i);
  82 }
  83
  84 /* SYSFILE INFO utility. */
  85 int
  86 cmd_sysfile_info (struct lexer *lexer, struct dataset *ds UNUSED)
  87 {
  88   struct file_handle *h;
  89   struct dictionary *d;
  90   struct tab_table *t;
  91   struct sfm_reader *reader;
  92   struct sfm_read_info info;
  93   int r, nr;
  94   int i;
  95
  96   lex_match_id (lexer, "FILE");
  97   lex_match (lexer, '=');
  98
  99   h = fh_parse (lexer, FH_REF_FILE);
 100   if (!h)
 101     return CMD_FAILURE;
 102
 103   reader = sfm_open_reader (h, &d, &info);
 104   if (!reader)
 105     return CMD_FAILURE;
 106   sfm_close_reader (reader);
 107
 108   t = tab_create (2, 10, 0);
 109   tab_vline (t, TAL_GAP, 1, 0, 8);
 110   tab_text (t, 0, 0, TAB_LEFT, _("File:"));
 111   tab_text (t, 1, 0, TAB_LEFT, fh_get_file_name (h));
 112   tab_text (t, 0, 1, TAB_LEFT, _("Label:"));
 113   {
 114     const char *label = dict_get_label (d);
 115     if (label == NULL)
 116       label = _("No label.");
 117     tab_text (t, 1, 1, TAB_LEFT, label);
 118   }
 119   tab_text (t, 0, 2, TAB_LEFT, _("Created:"));
 120   tab_text (t, 1, 2, TAB_LEFT | TAT_PRINTF, "%s %s by %s",
 121                 info.creation_date, info.creation_time, info.product);
 122   tab_text (t, 0, 3, TAB_LEFT, _("Integer Format:"));
 123   tab_text (t, 1, 3, TAB_LEFT,
 124             info.integer_format == INTEGER_MSB_FIRST ? _("Big Endian.")
 125             : info.integer_format == INTEGER_LSB_FIRST ? _("Little Endian.")
 126             : _("Unknown."));
 127   tab_text (t, 0, 4, TAB_LEFT, _("Real Format:"));
 128   tab_text (t, 1, 4, TAB_LEFT,
 129             info.float_format == FLOAT_IEEE_DOUBLE_LE ? _("IEEE 754 LE.")
 130             : info.float_format == FLOAT_IEEE_DOUBLE_BE ? _("IEEE 754 BE.")
 131             : info.float_format == FLOAT_VAX_D ? _("VAX D.")
 132             : info.float_format == FLOAT_VAX_G ? _("VAX G.")
 133             : info.float_format == FLOAT_Z_LONG ? _("IBM 390 Hex Long.")
 134             : _("Unknown."));
 135   tab_text (t, 0, 5, TAB_LEFT, _("Variables:"));
 136   tab_text (t, 1, 5, TAB_LEFT | TAT_PRINTF, "%d",
 137                 dict_get_var_cnt (d));
 138   tab_text (t, 0, 6, TAB_LEFT, _("Cases:"));
 139   tab_text (t, 1, 6, TAB_LEFT | TAT_PRINTF,
 140                 info.case_cnt == -1 ? _("Unknown") : "%d", info.case_cnt);
 141   tab_text (t, 0, 7, TAB_LEFT, _("Type:"));
 142   tab_text (t, 1, 7, TAB_LEFT, _("System File."));
 143   tab_text (t, 0, 8, TAB_LEFT, _("Weight:"));
 144   {
 145     struct variable *weight_var = dict_get_weight (d);
 146     tab_text (t, 1, 8, TAB_LEFT,
 147               (weight_var != NULL
 148                ? var_get_name (weight_var) : _("Not weighted.")));
 149   }
 150   tab_text (t, 0, 9, TAB_LEFT, _("Mode:"));
 151   tab_text (t, 1, 9, TAB_LEFT | TAT_PRINTF,
 152                 _("Compression %s."), info.compressed ? _("on") : _("off"));
 153   tab_dim (t, tab_natural_dimensions);
 154   tab_submit (t);
 155
 156   nr = 1 + 2 * dict_get_var_cnt (d);
 157
 158   t = tab_create (4, nr, 1);
 159   tab_dim (t, sysfile_info_dim);
 160   tab_headers (t, 0, 0, 1, 0);
 161   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
 162   tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
 163   tab_text (t, 3, 0, TAB_LEFT | TAT_TITLE, _("Position"));
 164   tab_hline (t, TAL_2, 0, 3, 1);
 165   for (r = 1, i = 0; i < dict_get_var_cnt (d); i++)
 166     {
 167       struct variable *v = dict_get_var (d, i);
 168       const int nvl = val_labs_count (var_get_value_labels (v));
 169
 170       if (r + 10 + nvl > nr)
 171         {
 172           nr = MAX (nr * dict_get_var_cnt (d) / (i + 1), nr);
 173           nr += 10 + nvl;
 174           tab_realloc (t, 4, nr);
 175         }
 176
 177       r = describe_variable (v, t, r, AS_DICTIONARY);
 178     }
 179
 180   tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, r);
 181   tab_vline (t, TAL_1, 1, 0, r);
 182   tab_vline (t, TAL_1, 3, 0, r);
 183
 184   tab_resize (t, -1, r);
 185   tab_flags (t, SOMF_NO_TITLE);
 186   tab_submit (t);
 187
 188   dict_destroy (d);
 189
 190   return lex_end_of_command (lexer);
 191 }
 192 \f
 193 /* DISPLAY utility. */
 194
 195 static void display_macros (void);
 196 static void display_documents (const struct dictionary *dict);
 197 static void display_variables (struct variable **, size_t, int);
 198 static void display_vectors (const struct dictionary *dict, int sorted);
 199
 200 int
 201 cmd_display (struct lexer *lexer, struct dataset *ds)
 202 {
 203   /* Whether to sort the list of variables alphabetically. */
 204   int sorted;
 205
 206   /* Variables to display. */
 207   size_t n;
 208   struct variable **vl;
 209
 210   if (lex_match_id (lexer, "MACROS"))
 211     display_macros ();
 212   else if (lex_match_id (lexer, "DOCUMENTS"))
 213     display_documents (dataset_dict (ds));
 214   else if (lex_match_id (lexer, "FILE"))
 215     {
 216       som_blank_line ();
 217       if (!lex_force_match_id (lexer, "LABEL"))
 218         return CMD_FAILURE;
 219       if (dict_get_label (dataset_dict (ds)) == NULL)
 220         tab_output_text (TAB_LEFT,
 221                          _("The active file does not have a file label."));
 222       else
 223         {
 224           tab_output_text (TAB_LEFT | TAT_TITLE, _("File label:"));
 225           tab_output_text (TAB_LEFT | TAB_FIX, dict_get_label (dataset_dict (ds)));
 226         }
 227     }
 228   else
 229     {
 230       static const char *sbc[] =
 231         {"NAMES", "INDEX", "VARIABLES", "LABELS",
 232          "DICTIONARY", "SCRATCH", "VECTORS", NULL};
 233       const char **cp;
 234       int as;
 235
 236       sorted = lex_match_id (lexer, "SORTED");
 237
 238       for (cp = sbc; *cp; cp++)
 239         if (lex_token (lexer) == T_ID
 240             && lex_id_match (ss_cstr (*cp), ss_cstr (lex_tokid (lexer))))
 241           {
 242             lex_get (lexer);
 243             break;
 244           }
 245       as = cp - sbc;
 246
 247       if (*cp == NULL)
 248         as = AS_NAMES;
 249
 250       if (as == AS_VECTOR)
 251         {
 252           display_vectors (dataset_dict(ds), sorted);
 253           return CMD_SUCCESS;
 254         }
 255
 256       lex_match (lexer, '/');
 257       lex_match_id (lexer, "VARIABLES");
 258       lex_match (lexer, '=');
 259
 260       if (lex_token (lexer) != '.')
 261         {
 262           if (!parse_variables (lexer, dataset_dict (ds), &vl, &n, PV_NONE))
 263             {
 264               free (vl);
 265               return CMD_FAILURE;
 266             }
 267           as = AS_DICTIONARY;
 268         }
 269       else
 270         dict_get_vars (dataset_dict (ds), &vl, &n, 0);
 271
 272       if (as == AS_SCRATCH)
 273         {
 274           size_t i, m;
 275           for (i = 0, m = n; i < n; i++)
 276             if (dict_class_from_id (var_get_name (vl[i])) != DC_SCRATCH)
 277               {
 278                 vl[i] = NULL;
 279                 m--;
 280               }
 281           as = AS_NAMES;
 282           n = m;
 283         }
 284
 285       if (n == 0)
 286         {
 287           msg (SW, _("No variables to display."));
 288           return CMD_FAILURE;
 289         }
 290
 291       if (sorted)
 292         sort (vl, n, sizeof *vl, compare_var_ptrs_by_name, NULL);
 293
 294       display_variables (vl, n, as);
 295
 296       free (vl);
 297     }
 298
 299   return lex_end_of_command (lexer);
 300 }
 301
 302 static void
 303 display_macros (void)
 304 {
 305   som_blank_line ();
 306   tab_output_text (TAB_LEFT, _("Macros not supported."));
 307 }
 308
 309 static void
 310 display_documents (const struct dictionary *dict)
 311 {
 312   const char *documents = dict_get_documents (dict);
 313
 314   som_blank_line ();
 315   if (documents == NULL)
 316     tab_output_text (TAB_LEFT, _("The active file dictionary does not "
 317                                  "contain any documents."));
 318   else
 319     {
 320       size_t n_lines = strlen (documents) / 80;
 321       char buf[81];
 322       size_t i;
 323
 324       tab_output_text (TAB_LEFT | TAT_TITLE,
 325                        _("Documents in the active file:"));
 326       som_blank_line ();
 327       buf[80] = 0;
 328       for (i = 0; i < n_lines; i++)
 329         {
 330           int len = 79;
 331
 332           memcpy (buf, &documents[i * 80], 80);
 333           while ((isspace ((unsigned char) buf[len]) || buf[len] == 0)
 334                  && len > 0)
 335             len--;
 336           buf[len + 1] = 0;
 337           tab_output_text (TAB_LEFT | TAB_FIX | TAT_NOWRAP, buf);
 338         }
 339     }
 340 }
 341
 342 static int _as;
 343
 344 /* Sets the widths of all the columns and heights of all the rows in
 345    table T for driver D. */
 346 static void
 347 variables_dim (struct tab_table *t, struct outp_driver *d)
 348 {
 349   int pc;
 350   int i;
 351
 352   t->w[0] = tab_natural_width (t, d, 0);
 353   if (_as == AS_DICTIONARY || _as == AS_VARIABLES || _as == AS_LABELS)
 354     {
 355       t->w[1] = MAX (tab_natural_width (t, d, 1), d->prop_em_width * 5);
 356       t->w[2] = MAX (tab_natural_width (t, d, 2), d->prop_em_width * 35);
 357       pc = 3;
 358     }
 359   else pc = 1;
 360   if (_as != AS_NAMES)
 361     t->w[pc] = tab_natural_width (t, d, pc);
 362
 363   for (i = 0; i < t->nr; i++)
 364     t->h[i] = tab_natural_height (t, d, i);
 365 }
 366
 367 static void
 368 display_variables (struct variable **vl, size_t n, int as)
 369 {
 370   struct variable **vp = vl;            /* Variable pointer. */
 371   struct tab_table *t;
 372   int nc;                       /* Number of columns. */
 373   int nr;                       /* Number of rows. */
 374   int pc;                       /* `Position column' */
 375   int r;                        /* Current row. */
 376   size_t i;
 377
 378   _as = as;
 379   switch (as)
 380     {
 381     case AS_INDEX:
 382       nc = 2;
 383       break;
 384     case AS_NAMES:
 385       nc = 1;
 386       break;
 387     default:
 388       nc = 4;
 389       break;
 390     }
 391
 392   t = tab_create (nc, n + 5, 1);
 393   tab_headers (t, 0, 0, 1, 0);
 394   nr = n + 5;
 395   tab_hline (t, TAL_2, 0, nc - 1, 1);
 396   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
 397   pc = (as == AS_INDEX ? 1 : 3);
 398   if (as != AS_NAMES)
 399     tab_text (t, pc, 0, TAB_LEFT | TAT_TITLE, _("Position"));
 400   if (as == AS_DICTIONARY || as == AS_VARIABLES)
 401     tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
 402   else if (as == AS_LABELS)
 403     tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Label"));
 404   tab_dim (t, variables_dim);
 405
 406   for (i = r = 1; i <= n; i++)
 407     {
 408       struct variable *v;
 409
 410       while (*vp == NULL)
 411         vp++;
 412       v = *vp++;
 413
 414       if (as == AS_DICTIONARY || as == AS_VARIABLES)
 415         {
 416           int nvl = val_labs_count (var_get_value_labels (v));
 417
 418           if (r + 10 + nvl > nr)
 419             {
 420               nr = MAX (nr * n / (i + 1), nr);
 421               nr += 10 + nvl;
 422               tab_realloc (t, nc, nr);
 423             }
 424
 425           r = describe_variable (v, t, r, as);
 426         } else {
 427           tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
 428           if (as == AS_LABELS)
 429             {
 430               const char *label = var_get_label (v);
 431               tab_joint_text (t, 1, r, 2, r, TAB_LEFT,
 432                               label != NULL ? "(no label)" : label);
 433             }
 434           if (as != AS_NAMES)
 435             {
 436               tab_text (t, pc, r, TAT_PRINTF, "%d",
 437                         (int) var_get_dict_index (v) + 1);
 438               tab_hline (t, TAL_1, 0, nc - 1, r);
 439             }
 440           r++;
 441         }
 442     }
 443   tab_hline (t, as == AS_NAMES ? TAL_1 : TAL_2, 0, nc - 1, 1);
 444   if (as != AS_NAMES)
 445     {
 446       tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, nc - 1, r - 1);
 447       tab_vline (t, TAL_1, 1, 0, r - 1);
 448     }
 449   else
 450     tab_flags (t, SOMF_NO_TITLE);
 451   if (as == AS_DICTIONARY || as == AS_VARIABLES || as == AS_LABELS)
 452     tab_vline (t, TAL_1, 3, 0, r - 1);
 453   tab_resize (t, -1, r);
 454   tab_columns (t, TAB_COL_DOWN, 1);
 455   tab_submit (t);
 456 }
 457 \f
 458 /* Puts a description of variable V into table T starting at row R.
 459    The variable will be described in the format AS.  Returns the next
 460    row available for use in the table. */
 461 static int
 462 describe_variable (struct variable *v, struct tab_table *t, int r, int as)
 463 {
 464   const struct fmt_spec *print = var_get_print_format (v);
 465   const struct fmt_spec *write = var_get_write_format (v);
 466
 467   /* Put the name, var label, and position into the first row. */
 468   tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
 469   tab_text (t, 3, r, TAT_PRINTF, "%d", (int) var_get_dict_index (v) + 1);
 470
 471   if (as == AS_DICTIONARY && var_has_label (v))
 472     {
 473       tab_joint_text (t, 1, r, 2, r, TAB_LEFT, var_get_label (v));
 474       r++;
 475     }
 476
 477   /* Print/write format, or print and write formats. */
 478   if (fmt_equal (print, write))
 479     {
 480       char str[FMT_STRING_LEN_MAX + 1];
 481       tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF, _("Format: %s"),
 482                       fmt_to_string (print, str));
 483       r++;
 484     }
 485   else
 486     {
 487       char str[FMT_STRING_LEN_MAX + 1];
 488       tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF,
 489                       _("Print Format: %s"), fmt_to_string (print, str));
 490       r++;
 491       tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF,
 492                       _("Write Format: %s"), fmt_to_string (write, str));
 493       r++;
 494     }
 495
 496   /* Missing values if any. */
 497   if (var_has_missing_values (v))
 498     {
 499       char buf[128];
 500       char *cp;
 501       struct missing_values mv;
 502       int cnt = 0;
 503
 504       cp = stpcpy (buf, _("Missing Values: "));
 505
 506       mv_copy (&mv, var_get_missing_values (v));
 507       if (mv_has_range (&mv))
 508         {
 509           double x, y;
 510           mv_pop_range (&mv, &x, &y);
 511           if (x == LOWEST)
 512             cp += sprintf (cp, "LOWEST THRU %g", y);
 513           else if (y == HIGHEST)
 514             cp += sprintf (cp, "%g THRU HIGHEST", x);
 515           else
 516             cp += sprintf (cp, "%g THRU %g", x, y);
 517           cnt++;
 518         }
 519       while (mv_has_value (&mv))
 520         {
 521           union value value;
 522           mv_pop_value (&mv, &value);
 523           if (cnt++ > 0)
 524             cp += sprintf (cp, "; ");
 525           if (var_is_numeric (v))
 526             cp += sprintf (cp, "%g", value.f);
 527           else
 528             {
 529               *cp++ = '"';
 530               memcpy (cp, value.s, var_get_width (v));
 531               cp += var_get_width (v);
 532               *cp++ = '"';
 533               *cp = '\0';
 534             }
 535         }
 536
 537       tab_joint_text (t, 1, r, 2, r, TAB_LEFT, buf);
 538       r++;
 539     }
 540
 541   /* Value labels. */
 542   if (as == AS_DICTIONARY && var_has_value_labels (v))
 543     {
 544       const struct val_labs *val_labs = var_get_value_labels (v);
 545       struct val_labs_iterator *i;
 546       struct val_lab *vl;
 547       int orig_r = r;
 548
 549 #if 0
 550       tab_text (t, 1, r, TAB_LEFT, _("Value"));
 551       tab_text (t, 2, r, TAB_LEFT, _("Label"));
 552       r++;
 553 #endif
 554
 555       tab_hline (t, TAL_1, 1, 2, r);
 556       for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
 557            vl = val_labs_next (val_labs, &i))
 558         {
 559           char buf[128];
 560
 561           if (var_is_alpha (v))
 562             {
 563               memcpy (buf, vl->value.s, var_get_width (v));
 564               buf[var_get_width (v)] = 0;
 565             }
 566           else
 567             sprintf (buf, "%g", vl->value.f);
 568
 569           tab_text (t, 1, r, TAB_NONE, buf);
 570           tab_text (t, 2, r, TAB_LEFT, vl->label);
 571           r++;
 572         }
 573
 574       tab_vline (t, TAL_1, 2, orig_r, r - 1);
 575     }
 576
 577   /* Draw a line below the last row of information on this variable. */
 578   tab_hline (t, TAL_1, 0, 3, r);
 579
 580   return r;
 581 }
 582
 583 /* Display a list of vectors.  If SORTED is nonzero then they are
 584    sorted alphabetically. */
 585 static void
 586 display_vectors (const struct dictionary *dict, int sorted)
 587 {
 588   const struct vector **vl;
 589   int i;
 590   struct tab_table *t;
 591   size_t nvec;
 592
 593   nvec = dict_get_vector_cnt (dict);
 594   if (nvec == 0)
 595     {
 596       msg (SW, _("No vectors defined."));
 597       return;
 598     }
 599
 600   vl = xnmalloc (nvec, sizeof *vl);
 601   for (i = 0; i < nvec; i++)
 602     vl[i] = dict_get_vector (dict, i);
 603   if (sorted)
 604     qsort (vl, nvec, sizeof *vl, compare_vector_ptrs_by_name);
 605
 606   t = tab_create (1, nvec + 1, 0);
 607   tab_headers (t, 0, 0, 1, 0);
 608   tab_columns (t, TAB_COL_DOWN, 1);
 609   tab_dim (t, tab_natural_dimensions);
 610   tab_hline (t, TAL_1, 0, 0, 1);
 611   tab_text (t, 0, 0, TAT_TITLE | TAB_LEFT, _("Vector"));
 612   tab_flags (t, SOMF_NO_TITLE);
 613   for (i = 0; i < nvec; i++)
 614     tab_text (t, 0, i + 1, TAB_LEFT, vector_get_name (vl[i]));
 615   tab_submit (t);
 616
 617   free (vl);
 618 }
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629