1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
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.
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.
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/>. */
23 #include "data/attributes.h"
24 #include "data/casereader.h"
25 #include "data/dataset.h"
26 #include "data/dictionary.h"
27 #include "data/file-handle-def.h"
28 #include "data/format.h"
29 #include "data/missing-values.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/array.h"
39 #include "libpspp/message.h"
40 #include "libpspp/misc.h"
41 #include "libpspp/string-array.h"
42 #include "output/tab.h"
44 #include "gl/minmax.h"
45 #include "gl/xalloc.h"
48 #define _(msgid) gettext (msgid)
50 /* Information to include in displaying a dictionary. */
53 DF_DICT_INDEX = 1 << 0,
55 DF_VALUE_LABELS = 1 << 2,
56 DF_VARIABLE_LABELS = 1 << 3,
57 DF_MISSING_VALUES = 1 << 4,
58 DF_AT_ATTRIBUTES = 1 << 5, /* Attributes whose names begin with @. */
59 DF_ATTRIBUTES = 1 << 6, /* All other attributes. */
64 static int describe_variable (const struct variable *v, struct tab_table *t,
65 int r, int pc, int flags);
67 /* SYSFILE INFO utility. */
69 cmd_sysfile_info (struct lexer *lexer, struct dataset *ds UNUSED)
71 struct file_handle *h;
74 struct casereader *reader;
75 struct sfm_read_info info;
78 lex_match_id (lexer, "FILE");
79 lex_match (lexer, T_EQUALS);
81 h = fh_parse (lexer, FH_REF_FILE, NULL);
85 reader = sfm_open_reader (h, NULL, &d, &info);
91 casereader_destroy (reader);
93 t = tab_create (2, 11 + (info.product_ext != NULL));
95 tab_vline (t, TAL_GAP, 1, 0, 8);
97 tab_text (t, 0, r, TAB_LEFT, _("File:"));
98 tab_text (t, 1, r++, TAB_LEFT, fh_get_file_name (h));
100 tab_text (t, 0, r, TAB_LEFT, _("Label:"));
102 const char *label = dict_get_label (d);
104 label = _("No label.");
105 tab_text (t, 1, r++, TAB_LEFT, label);
108 tab_text (t, 0, r, TAB_LEFT, _("Created:"));
109 tab_text_format (t, 1, r++, TAB_LEFT, "%s %s by %s",
110 info.creation_date, info.creation_time, info.product);
112 if (info.product_ext)
114 tab_text (t, 0, r, TAB_LEFT, _("Product:"));
115 tab_text (t, 1, r++, TAB_LEFT, info.product_ext);
118 tab_text (t, 0, r, TAB_LEFT, _("Integer Format:"));
119 tab_text (t, 1, r++, TAB_LEFT,
120 info.integer_format == INTEGER_MSB_FIRST ? _("Big Endian")
121 : info.integer_format == INTEGER_LSB_FIRST ? _("Little Endian")
124 tab_text (t, 0, r, TAB_LEFT, _("Real Format:"));
125 tab_text (t, 1, r++, TAB_LEFT,
126 info.float_format == FLOAT_IEEE_DOUBLE_LE ? _("IEEE 754 LE.")
127 : info.float_format == FLOAT_IEEE_DOUBLE_BE ? _("IEEE 754 BE.")
128 : info.float_format == FLOAT_VAX_D ? _("VAX D.")
129 : info.float_format == FLOAT_VAX_G ? _("VAX G.")
130 : info.float_format == FLOAT_Z_LONG ? _("IBM 390 Hex Long.")
133 tab_text (t, 0, r, TAB_LEFT, _("Variables:"));
134 tab_text_format (t, 1, r++, TAB_LEFT, "%zu", dict_get_var_cnt (d));
136 tab_text (t, 0, r, TAB_LEFT, _("Cases:"));
137 if (info.case_cnt == -1)
138 tab_text (t, 1, r, TAB_LEFT, _("Unknown"));
140 tab_text_format (t, 1, r, TAB_LEFT, "%ld", (long int) info.case_cnt);
143 tab_text (t, 0, r, TAB_LEFT, _("Type:"));
144 tab_text (t, 1, r++, TAB_LEFT, _("System File"));
146 tab_text (t, 0, r, TAB_LEFT, _("Weight:"));
148 struct variable *weight_var = dict_get_weight (d);
149 tab_text (t, 1, r++, TAB_LEFT,
151 ? var_get_name (weight_var) : _("Not weighted.")));
154 tab_text (t, 0, r, TAB_LEFT, _("Compression:"));
155 tab_text_format (t, 1, r++, TAB_LEFT,
156 info.compression == SFM_COMP_NONE ? _("None")
157 : info.compression == SFM_COMP_SIMPLE ? "SAV"
160 tab_text (t, 0, r, TAB_LEFT, _("Charset:"));
161 tab_text (t, 1, r++, TAB_LEFT, dict_get_encoding (d));
165 t = tab_create (4, 1 + 2 * dict_get_var_cnt (d));
166 tab_headers (t, 0, 0, 1, 0);
167 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
168 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
169 tab_text (t, 3, 0, TAB_LEFT | TAT_TITLE, _("Position"));
170 tab_hline (t, TAL_2, 0, 3, 1);
171 for (r = 1, i = 0; i < dict_get_var_cnt (d); i++)
172 r = describe_variable (dict_get_var (d, i), t, r, 3,
173 DF_ALL & ~DF_AT_ATTRIBUTES);
175 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, r);
176 tab_vline (t, TAL_1, 1, 0, r);
177 tab_vline (t, TAL_1, 3, 0, r);
179 tab_resize (t, -1, r);
185 sfm_read_info_destroy (&info);
189 /* DISPLAY utility. */
191 static void display_macros (void);
192 static void display_documents (const struct dictionary *dict);
193 static void display_variables (const struct variable **, size_t, int);
194 static void display_vectors (const struct dictionary *dict, int sorted);
195 static void display_data_file_attributes (struct attrset *, int flags);
198 cmd_display (struct lexer *lexer, struct dataset *ds)
200 /* Whether to sort the list of variables alphabetically. */
203 /* Variables to display. */
205 const struct variable **vl;
207 if (lex_match_id (lexer, "MACROS"))
209 else if (lex_match_id (lexer, "DOCUMENTS"))
210 display_documents (dataset_dict (ds));
211 else if (lex_match_id (lexer, "FILE"))
213 if (!lex_force_match_id (lexer, "LABEL"))
215 if (dict_get_label (dataset_dict (ds)) == NULL)
216 tab_output_text (TAB_LEFT,
217 _("The active dataset does not have a file label."));
219 tab_output_text_format (TAB_LEFT, _("File label: %s"),
220 dict_get_label (dataset_dict (ds)));
226 sorted = lex_match_id (lexer, "SORTED");
228 if (lex_match_id (lexer, "VECTORS"))
230 display_vectors (dataset_dict(ds), sorted);
233 else if (lex_match_id (lexer, "SCRATCH"))
235 dict_get_vars (dataset_dict (ds), &vl, &n, DC_ORDINARY);
245 static const struct subcommand subcommands[] =
247 {"@ATTRIBUTES", DF_ATTRIBUTES | DF_AT_ATTRIBUTES},
248 {"ATTRIBUTES", DF_ATTRIBUTES},
249 {"DICTIONARY", DF_ALL & ~DF_AT_ATTRIBUTES},
250 {"INDEX", DF_DICT_INDEX},
251 {"LABELS", DF_DICT_INDEX | DF_VARIABLE_LABELS},
254 DF_DICT_INDEX | DF_FORMATS | DF_MISSING_VALUES | DF_MISC},
257 const struct subcommand *sbc;
260 for (sbc = subcommands; sbc->name != NULL; sbc++)
261 if (lex_match_id (lexer, sbc->name))
267 lex_match (lexer, T_SLASH);
268 lex_match_id (lexer, "VARIABLES");
269 lex_match (lexer, T_EQUALS);
271 if (lex_token (lexer) != T_ENDCMD)
273 if (!parse_variables_const (lexer, dataset_dict (ds), &vl, &n,
281 dict_get_vars (dataset_dict (ds), &vl, &n, 0);
286 sort (vl, n, sizeof *vl,
288 ? compare_var_ptrs_by_name
289 : compare_var_ptrs_by_dict_index), NULL);
290 display_variables (vl, n, flags);
293 msg (SW, _("No variables to display."));
296 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES))
297 display_data_file_attributes (dict_get_attributes (dataset_dict (ds)),
305 display_macros (void)
307 tab_output_text (TAB_LEFT, _("Macros not supported."));
311 display_documents (const struct dictionary *dict)
313 const struct string_array *documents = dict_get_documents (dict);
315 if (string_array_is_empty (documents))
316 tab_output_text (TAB_LEFT, _("The active dataset dictionary does not "
317 "contain any documents."));
322 tab_output_text (TAB_LEFT | TAT_TITLE,
323 _("Documents in the active dataset:"));
324 for (i = 0; i < dict_get_document_line_cnt (dict); i++)
325 tab_output_text (TAB_LEFT | TAB_FIX, dict_get_document_line (dict, i));
330 display_variables (const struct variable **vl, size_t n, int flags)
333 int nc; /* Number of columns. */
334 int pc; /* `Position column' */
335 int r; /* Current row. */
338 /* One column for the name,
339 two columns for general description,
340 one column for dictionary index. */
342 if (flags & ~DF_DICT_INDEX)
345 if (flags & DF_DICT_INDEX)
348 t = tab_create (nc, n + 5);
349 tab_headers (t, 0, 0, 1, 0);
350 tab_hline (t, TAL_2, 0, nc - 1, 1);
351 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
352 if (flags & ~DF_DICT_INDEX)
353 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE,
354 (flags & ~(DF_DICT_INDEX | DF_VARIABLE_LABELS)
355 ? _("Description") : _("Label")));
356 if (flags & DF_DICT_INDEX)
357 tab_text (t, pc, 0, TAB_LEFT | TAT_TITLE, _("Position"));
360 for (i = 0; i < n; i++)
361 r = describe_variable (vl[i], t, r, pc, flags);
362 tab_hline (t, flags & ~DF_DICT_INDEX ? TAL_2 : TAL_1, 0, nc - 1, 1);
365 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, nc - 1, r - 1);
366 tab_vline (t, TAL_1, 1, 0, r - 1);
368 if (flags & ~DF_DICT_INDEX)
369 tab_vline (t, TAL_1, nc - 1, 0, r - 1);
370 tab_resize (t, -1, r);
375 is_at_name (const char *name)
377 return name[0] == '@' || (name[0] == '$' && name[1] == '@');
381 count_attributes (const struct attrset *set, int flags)
383 struct attrset_iterator i;
384 struct attribute *attr;
388 for (attr = attrset_first (set, &i); attr != NULL;
389 attr = attrset_next (set, &i))
390 if (flags & DF_AT_ATTRIBUTES || !is_at_name (attribute_get_name (attr)))
391 n_attrs += attribute_get_n_values (attr);
396 display_attributes (struct tab_table *t, const struct attrset *set, int flags,
399 struct attribute **attrs;
403 n_attrs = attrset_count (set);
404 attrs = attrset_sorted (set);
405 for (i = 0; i < n_attrs; i++)
407 const struct attribute *attr = attrs[i];
408 const char *name = attribute_get_name (attr);
412 if (!(flags & DF_AT_ATTRIBUTES) && is_at_name (name))
415 n_values = attribute_get_n_values (attr);
416 for (j = 0; j < n_values; j++)
419 tab_text_format (t, c, r, TAB_LEFT, "%s[%zu]", name, j + 1);
421 tab_text (t, c, r, TAB_LEFT, name);
422 tab_text (t, c + 1, r, TAB_LEFT, attribute_get_value (attr, j));
430 display_data_file_attributes (struct attrset *set, int flags)
435 n_attrs = count_attributes (set, flags);
439 t = tab_create (2, n_attrs + 1);
440 tab_headers (t, 0, 0, 1, 0);
441 tab_box (t, TAL_1, TAL_1, -1, TAL_1, 0, 0, tab_nc (t) - 1, tab_nr (t) - 1);
442 tab_hline (t, TAL_2, 0, 1, 1);
443 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Attribute"));
444 tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Value"));
445 display_attributes (t, set, flags, 0, 1);
446 tab_title (t, "Custom data file attributes.");
450 /* Puts a description of variable V into table T starting at row
451 R. The variable will be described in the format given by
452 FLAGS. Returns the next row available for use in the
455 describe_variable (const struct variable *v, struct tab_table *t, int r,
461 /* Make sure that enough rows are allocated. */
463 if (flags & ~(DF_DICT_INDEX | DF_VARIABLE_LABELS))
465 if (flags & DF_VALUE_LABELS)
466 need_rows += val_labs_count (var_get_value_labels (v));
467 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES))
469 n_attrs = count_attributes (var_get_attributes (v), flags);
470 need_rows += n_attrs;
472 if (r + need_rows > tab_nr (t))
474 int nr = MAX (r + need_rows, tab_nr (t) * 2);
475 tab_realloc (t, -1, nr);
478 /* Put the name, var label, and position into the first row. */
479 tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
480 if (flags & DF_DICT_INDEX)
481 tab_text_format (t, pc, r, 0, "%zu", var_get_dict_index (v) + 1);
483 if (flags & DF_VARIABLE_LABELS && var_has_label (v))
485 if (flags & ~(DF_DICT_INDEX | DF_VARIABLE_LABELS))
486 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
487 _("Label: %s"), var_get_label (v));
489 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, var_get_label (v));
493 /* Print/write format, or print and write formats. */
494 if (flags & DF_FORMATS)
496 const struct fmt_spec *print = var_get_print_format (v);
497 const struct fmt_spec *write = var_get_write_format (v);
499 if (fmt_equal (print, write))
501 char str[FMT_STRING_LEN_MAX + 1];
502 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
503 _("Format: %s"), fmt_to_string (print, str));
508 char str[FMT_STRING_LEN_MAX + 1];
509 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
510 _("Print Format: %s"),
511 fmt_to_string (print, str));
513 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
514 _("Write Format: %s"),
515 fmt_to_string (write, str));
520 /* Measurement level, role, display width, alignment. */
523 enum var_role role = var_get_role (v);
525 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
527 measure_to_string (var_get_measure (v)));
530 if (role != ROLE_INPUT)
532 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
533 _("Role: %s"), var_role_to_string (role));
537 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
538 _("Display Alignment: %s"),
539 alignment_to_string (var_get_alignment (v)));
542 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
543 _("Display Width: %d"),
544 var_get_display_width (v));
548 /* Missing values if any. */
549 if (flags & DF_MISSING_VALUES && var_has_missing_values (v))
551 const struct missing_values *mv = var_get_missing_values (v);
557 cp = stpcpy (buf, _("Missing Values: "));
559 if (mv_has_range (mv))
562 mv_get_range (mv, &x, &y);
564 cp += sprintf (cp, "LOWEST THRU %.*g", DBL_DIG + 1, y);
565 else if (y == HIGHEST)
566 cp += sprintf (cp, "%.*g THRU HIGHEST", DBL_DIG + 1, x);
568 cp += sprintf (cp, "%.*g THRU %.*g",
573 for (i = 0; i < mv_n_values (mv); i++)
575 const union value *value = mv_get_value (mv, i);
577 cp += sprintf (cp, "; ");
578 if (var_is_numeric (v))
579 cp += sprintf (cp, "%.*g", DBL_DIG + 1, value->f);
582 int width = var_get_width (v);
583 int mv_width = MIN (width, MV_MAX_STRING);
586 memcpy (cp, value_str (value, width), mv_width);
593 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, buf);
598 if (flags & DF_VALUE_LABELS && var_has_value_labels (v))
600 const struct val_labs *val_labs = var_get_value_labels (v);
601 size_t n_labels = val_labs_count (val_labs);
602 const struct val_lab **labels;
607 tab_text (t, 1, r, TAB_LEFT, _("Value"));
608 tab_text (t, 2, r, TAB_LEFT, _("Label"));
612 tab_hline (t, TAL_1, 1, 2, r);
614 labels = val_labs_sorted (val_labs);
615 for (i = 0; i < n_labels; i++)
617 const struct val_lab *vl = labels[i];
619 tab_value (t, 1, r, TAB_NONE, &vl->value, v, NULL);
620 tab_text (t, 2, r, TAB_LEFT, val_lab_get_escaped_label (vl));
625 tab_vline (t, TAL_1, 2, orig_r, r - 1);
628 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES) && n_attrs)
630 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, "Custom attributes:");
633 display_attributes (t, var_get_attributes (v), flags, 1, r);
637 /* Draw a line below the last row of information on this variable. */
638 tab_hline (t, TAL_1, 0, tab_nc (t) - 1, r);
643 /* Display a list of vectors. If SORTED is nonzero then they are
644 sorted alphabetically. */
646 display_vectors (const struct dictionary *dict, int sorted)
648 const struct vector **vl;
655 nvec = dict_get_vector_cnt (dict);
658 msg (SW, _("No vectors defined."));
662 vl = xnmalloc (nvec, sizeof *vl);
664 for (i = 0; i < nvec; i++)
666 vl[i] = dict_get_vector (dict, i);
667 nrow += vector_get_var_cnt (vl[i]);
670 qsort (vl, nvec, sizeof *vl, compare_vector_ptrs_by_name);
672 t = tab_create (4, nrow + 1);
673 tab_headers (t, 0, 0, 1, 0);
674 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, nrow);
675 tab_box (t, -1, -1, -1, TAL_1, 0, 0, 3, nrow);
676 tab_hline (t, TAL_2, 0, 3, 1);
677 tab_text (t, 0, 0, TAT_TITLE | TAB_LEFT, _("Vector"));
678 tab_text (t, 1, 0, TAT_TITLE | TAB_LEFT, _("Position"));
679 tab_text (t, 2, 0, TAT_TITLE | TAB_LEFT, _("Variable"));
680 tab_text (t, 3, 0, TAT_TITLE | TAB_LEFT, _("Print Format"));
683 for (i = 0; i < nvec; i++)
685 const struct vector *vec = vl[i];
688 tab_joint_text (t, 0, row, 0, row + vector_get_var_cnt (vec) - 1,
689 TAB_LEFT, vector_get_name (vl[i]));
691 for (j = 0; j < vector_get_var_cnt (vec); j++)
693 struct variable *var = vector_get_var (vec, j);
694 char fmt_string[FMT_STRING_LEN_MAX + 1];
695 fmt_to_string (var_get_print_format (var), fmt_string);
697 tab_text_format (t, 1, row, TAB_RIGHT, "%zu", j + 1);
698 tab_text (t, 2, row, TAB_LEFT, var_get_name (var));
699 tab_text (t, 3, row, TAB_LEFT, fmt_string);
702 tab_hline (t, TAL_1, 0, 3, row);