1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
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.
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.
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
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>
52 #define _(msgid) gettext (msgid)
54 /* Constants for DISPLAY utility. */
66 static int describe_variable (struct variable *v, struct tab_table *t, int r, int as);
68 /* Sets the widths of all the columns and heights of all the rows in
69 table T for driver D. */
71 sysfile_info_dim (struct tab_table *t, struct outp_driver *d)
73 static const int max[] = {20, 5, 35, 3, 0};
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);
84 /* SYSFILE INFO utility. */
86 cmd_sysfile_info (struct lexer *lexer, struct dataset *ds UNUSED)
88 struct file_handle *h;
91 struct sfm_reader *reader;
92 struct sfm_read_info info;
96 lex_match_id (lexer, "FILE");
97 lex_match (lexer, '=');
99 h = fh_parse (lexer, FH_REF_FILE);
103 reader = sfm_open_reader (h, &d, &info);
106 sfm_close_reader (reader);
108 t = tab_create (2, 9, 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:"));
114 const char *label = dict_get_label (d);
116 label = _("No label.");
117 tab_text (t, 1, 1, TAB_LEFT, label);
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, _("Endian:"));
123 tab_text (t, 1, 3, TAB_LEFT, info.big_endian ? _("Big.") : _("Little."));
124 tab_text (t, 0, 4, TAB_LEFT, _("Variables:"));
125 tab_text (t, 1, 4, TAB_LEFT | TAT_PRINTF, "%d",
126 dict_get_var_cnt (d));
127 tab_text (t, 0, 5, TAB_LEFT, _("Cases:"));
128 tab_text (t, 1, 5, TAB_LEFT | TAT_PRINTF,
129 info.case_cnt == -1 ? _("Unknown") : "%d", info.case_cnt);
130 tab_text (t, 0, 6, TAB_LEFT, _("Type:"));
131 tab_text (t, 1, 6, TAB_LEFT, _("System File."));
132 tab_text (t, 0, 7, TAB_LEFT, _("Weight:"));
134 struct variable *weight_var = dict_get_weight (d);
135 tab_text (t, 1, 7, TAB_LEFT,
137 ? var_get_name (weight_var) : _("Not weighted.")));
139 tab_text (t, 0, 8, TAB_LEFT, _("Mode:"));
140 tab_text (t, 1, 8, TAB_LEFT | TAT_PRINTF,
141 _("Compression %s."), info.compressed ? _("on") : _("off"));
142 tab_dim (t, tab_natural_dimensions);
145 nr = 1 + 2 * dict_get_var_cnt (d);
147 t = tab_create (4, nr, 1);
148 tab_dim (t, sysfile_info_dim);
149 tab_headers (t, 0, 0, 1, 0);
150 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
151 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
152 tab_text (t, 3, 0, TAB_LEFT | TAT_TITLE, _("Position"));
153 tab_hline (t, TAL_2, 0, 3, 1);
154 for (r = 1, i = 0; i < dict_get_var_cnt (d); i++)
156 struct variable *v = dict_get_var (d, i);
157 const int nvl = val_labs_count (var_get_value_labels (v));
159 if (r + 10 + nvl > nr)
161 nr = MAX (nr * dict_get_var_cnt (d) / (i + 1), nr);
163 tab_realloc (t, 4, nr);
166 r = describe_variable (v, t, r, AS_DICTIONARY);
169 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, r);
170 tab_vline (t, TAL_1, 1, 0, r);
171 tab_vline (t, TAL_1, 3, 0, r);
173 tab_resize (t, -1, r);
174 tab_flags (t, SOMF_NO_TITLE);
179 return lex_end_of_command (lexer);
182 /* DISPLAY utility. */
184 static void display_macros (void);
185 static void display_documents (const struct dictionary *dict);
186 static void display_variables (struct variable **, size_t, int);
187 static void display_vectors (const struct dictionary *dict, int sorted);
190 cmd_display (struct lexer *lexer, struct dataset *ds)
192 /* Whether to sort the list of variables alphabetically. */
195 /* Variables to display. */
197 struct variable **vl;
199 if (lex_match_id (lexer, "MACROS"))
201 else if (lex_match_id (lexer, "DOCUMENTS"))
202 display_documents (dataset_dict (ds));
203 else if (lex_match_id (lexer, "FILE"))
206 if (!lex_force_match_id (lexer, "LABEL"))
208 if (dict_get_label (dataset_dict (ds)) == NULL)
209 tab_output_text (TAB_LEFT,
210 _("The active file does not have a file label."));
213 tab_output_text (TAB_LEFT | TAT_TITLE, _("File label:"));
214 tab_output_text (TAB_LEFT | TAB_FIX, dict_get_label (dataset_dict (ds)));
219 static const char *sbc[] =
220 {"NAMES", "INDEX", "VARIABLES", "LABELS",
221 "DICTIONARY", "SCRATCH", "VECTORS", NULL};
225 sorted = lex_match_id (lexer, "SORTED");
227 for (cp = sbc; *cp; cp++)
228 if (lex_token (lexer) == T_ID
229 && lex_id_match (ss_cstr (*cp), ss_cstr (lex_tokid (lexer))))
241 display_vectors (dataset_dict(ds), sorted);
245 lex_match (lexer, '/');
246 lex_match_id (lexer, "VARIABLES");
247 lex_match (lexer, '=');
249 if (lex_token (lexer) != '.')
251 if (!parse_variables (lexer, dataset_dict (ds), &vl, &n, PV_NONE))
259 dict_get_vars (dataset_dict (ds), &vl, &n, 0);
261 if (as == AS_SCRATCH)
264 for (i = 0, m = n; i < n; i++)
265 if (dict_class_from_id (var_get_name (vl[i])) != DC_SCRATCH)
276 msg (SW, _("No variables to display."));
281 sort (vl, n, sizeof *vl, compare_var_ptrs_by_name, NULL);
283 display_variables (vl, n, as);
288 return lex_end_of_command (lexer);
292 display_macros (void)
295 tab_output_text (TAB_LEFT, _("Macros not supported."));
299 display_documents (const struct dictionary *dict)
301 const char *documents = dict_get_documents (dict);
304 if (documents == NULL)
305 tab_output_text (TAB_LEFT, _("The active file dictionary does not "
306 "contain any documents."));
309 size_t n_lines = strlen (documents) / 80;
313 tab_output_text (TAB_LEFT | TAT_TITLE,
314 _("Documents in the active file:"));
317 for (i = 0; i < n_lines; i++)
321 memcpy (buf, &documents[i * 80], 80);
322 while ((isspace ((unsigned char) buf[len]) || buf[len] == 0)
326 tab_output_text (TAB_LEFT | TAB_FIX | TAT_NOWRAP, buf);
333 /* Sets the widths of all the columns and heights of all the rows in
334 table T for driver D. */
336 variables_dim (struct tab_table *t, struct outp_driver *d)
341 t->w[0] = tab_natural_width (t, d, 0);
342 if (_as == AS_DICTIONARY || _as == AS_VARIABLES || _as == AS_LABELS)
344 t->w[1] = MAX (tab_natural_width (t, d, 1), d->prop_em_width * 5);
345 t->w[2] = MAX (tab_natural_width (t, d, 2), d->prop_em_width * 35);
350 t->w[pc] = tab_natural_width (t, d, pc);
352 for (i = 0; i < t->nr; i++)
353 t->h[i] = tab_natural_height (t, d, i);
357 display_variables (struct variable **vl, size_t n, int as)
359 struct variable **vp = vl; /* Variable pointer. */
361 int nc; /* Number of columns. */
362 int nr; /* Number of rows. */
363 int pc; /* `Position column' */
364 int r; /* Current row. */
381 t = tab_create (nc, n + 5, 1);
382 tab_headers (t, 0, 0, 1, 0);
384 tab_hline (t, TAL_2, 0, nc - 1, 1);
385 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
386 pc = (as == AS_INDEX ? 1 : 3);
388 tab_text (t, pc, 0, TAB_LEFT | TAT_TITLE, _("Position"));
389 if (as == AS_DICTIONARY || as == AS_VARIABLES)
390 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
391 else if (as == AS_LABELS)
392 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Label"));
393 tab_dim (t, variables_dim);
395 for (i = r = 1; i <= n; i++)
403 if (as == AS_DICTIONARY || as == AS_VARIABLES)
405 int nvl = val_labs_count (var_get_value_labels (v));
407 if (r + 10 + nvl > nr)
409 nr = MAX (nr * n / (i + 1), nr);
411 tab_realloc (t, nc, nr);
414 r = describe_variable (v, t, r, as);
416 tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
419 const char *label = var_get_label (v);
420 tab_joint_text (t, 1, r, 2, r, TAB_LEFT,
421 label != NULL ? "(no label)" : label);
425 tab_text (t, pc, r, TAT_PRINTF, "%d",
426 (int) var_get_dict_index (v) + 1);
427 tab_hline (t, TAL_1, 0, nc - 1, r);
432 tab_hline (t, as == AS_NAMES ? TAL_1 : TAL_2, 0, nc - 1, 1);
435 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, nc - 1, r - 1);
436 tab_vline (t, TAL_1, 1, 0, r - 1);
439 tab_flags (t, SOMF_NO_TITLE);
440 if (as == AS_DICTIONARY || as == AS_VARIABLES || as == AS_LABELS)
441 tab_vline (t, TAL_1, 3, 0, r - 1);
442 tab_resize (t, -1, r);
443 tab_columns (t, TAB_COL_DOWN, 1);
447 /* Puts a description of variable V into table T starting at row R.
448 The variable will be described in the format AS. Returns the next
449 row available for use in the table. */
451 describe_variable (struct variable *v, struct tab_table *t, int r, int as)
453 const struct fmt_spec *print = var_get_print_format (v);
454 const struct fmt_spec *write = var_get_write_format (v);
456 /* Put the name, var label, and position into the first row. */
457 tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
458 tab_text (t, 3, r, TAT_PRINTF, "%d", (int) var_get_dict_index (v) + 1);
460 if (as == AS_DICTIONARY && var_has_label (v))
462 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, var_get_label (v));
466 /* Print/write format, or print and write formats. */
467 if (fmt_equal (print, write))
469 char str[FMT_STRING_LEN_MAX + 1];
470 tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF, _("Format: %s"),
471 fmt_to_string (print, str));
476 char str[FMT_STRING_LEN_MAX + 1];
477 tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF,
478 _("Print Format: %s"), fmt_to_string (print, str));
480 tab_joint_text (t, 1, r, 2, r, TAB_LEFT | TAT_PRINTF,
481 _("Write Format: %s"), fmt_to_string (write, str));
485 /* Missing values if any. */
486 if (var_has_missing_values (v))
490 struct missing_values mv;
493 cp = stpcpy (buf, _("Missing Values: "));
495 mv_copy (&mv, var_get_missing_values (v));
496 if (mv_has_range (&mv))
499 mv_pop_range (&mv, &x, &y);
501 cp += sprintf (cp, "LOWEST THRU %g", y);
502 else if (y == HIGHEST)
503 cp += sprintf (cp, "%g THRU HIGHEST", x);
505 cp += sprintf (cp, "%g THRU %g", x, y);
508 while (mv_has_value (&mv))
511 mv_pop_value (&mv, &value);
513 cp += sprintf (cp, "; ");
514 if (var_is_numeric (v))
515 cp += sprintf (cp, "%g", value.f);
519 memcpy (cp, value.s, var_get_width (v));
520 cp += var_get_width (v);
526 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, buf);
531 if (as == AS_DICTIONARY && var_has_value_labels (v))
533 const struct val_labs *val_labs = var_get_value_labels (v);
534 struct val_labs_iterator *i;
539 tab_text (t, 1, r, TAB_LEFT, _("Value"));
540 tab_text (t, 2, r, TAB_LEFT, _("Label"));
544 tab_hline (t, TAL_1, 1, 2, r);
545 for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
546 vl = val_labs_next (val_labs, &i))
550 if (var_is_alpha (v))
552 memcpy (buf, vl->value.s, var_get_width (v));
553 buf[var_get_width (v)] = 0;
556 sprintf (buf, "%g", vl->value.f);
558 tab_text (t, 1, r, TAB_NONE, buf);
559 tab_text (t, 2, r, TAB_LEFT, vl->label);
563 tab_vline (t, TAL_1, 2, orig_r, r - 1);
566 /* Draw a line below the last row of information on this variable. */
567 tab_hline (t, TAL_1, 0, 3, r);
572 /* Display a list of vectors. If SORTED is nonzero then they are
573 sorted alphabetically. */
575 display_vectors (const struct dictionary *dict, int sorted)
577 const struct vector **vl;
582 nvec = dict_get_vector_cnt (dict);
585 msg (SW, _("No vectors defined."));
589 vl = xnmalloc (nvec, sizeof *vl);
590 for (i = 0; i < nvec; i++)
591 vl[i] = dict_get_vector (dict, i);
593 qsort (vl, nvec, sizeof *vl, compare_vector_ptrs_by_name);
595 t = tab_create (1, nvec + 1, 0);
596 tab_headers (t, 0, 0, 1, 0);
597 tab_columns (t, TAB_COL_DOWN, 1);
598 tab_dim (t, tab_natural_dimensions);
599 tab_hline (t, TAL_1, 0, 0, 1);
600 tab_text (t, 0, 0, TAT_TITLE | TAB_LEFT, _("Vector"));
601 tab_flags (t, SOMF_NO_TITLE);
602 for (i = 0; i < nvec; i++)
603 tab_text (t, 0, i + 1, TAB_LEFT, vector_get_name (vl[i]));