1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011, 2012, 2013 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/>. */
22 #include "data/attributes.h"
23 #include "data/casereader.h"
24 #include "data/dataset.h"
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/sys-file-reader.h"
30 #include "data/value-labels.h"
31 #include "data/variable.h"
32 #include "data/vector.h"
33 #include "language/command.h"
34 #include "language/data-io/file-handle.h"
35 #include "language/lexer/lexer.h"
36 #include "language/lexer/variable-parser.h"
37 #include "libpspp/array.h"
38 #include "libpspp/message.h"
39 #include "libpspp/misc.h"
40 #include "libpspp/string-array.h"
41 #include "output/tab.h"
43 #include "gl/minmax.h"
44 #include "gl/xalloc.h"
47 #define _(msgid) gettext (msgid)
49 /* Information to include in displaying a dictionary. */
52 DF_DICT_INDEX = 1 << 0,
54 DF_VALUE_LABELS = 1 << 2,
55 DF_VARIABLE_LABELS = 1 << 3,
56 DF_MISSING_VALUES = 1 << 4,
57 DF_AT_ATTRIBUTES = 1 << 5, /* Attributes whose names begin with @. */
58 DF_ATTRIBUTES = 1 << 6, /* All other attributes. */
63 static int describe_variable (const struct variable *v, struct tab_table *t,
64 int r, int pc, int flags);
66 /* SYSFILE INFO utility. */
68 cmd_sysfile_info (struct lexer *lexer, struct dataset *ds UNUSED)
70 struct file_handle *h;
73 struct casereader *reader;
74 struct sfm_read_info info;
77 lex_match_id (lexer, "FILE");
78 lex_match (lexer, T_EQUALS);
80 h = fh_parse (lexer, FH_REF_FILE, NULL);
84 reader = sfm_open_reader (h, NULL, &d, &info);
90 casereader_destroy (reader);
92 t = tab_create (2, 11 + (info.product_ext != NULL));
94 tab_vline (t, TAL_GAP, 1, 0, 8);
96 tab_text (t, 0, r, TAB_LEFT, _("File:"));
97 tab_text (t, 1, r++, TAB_LEFT, fh_get_file_name (h));
99 tab_text (t, 0, r, TAB_LEFT, _("Label:"));
101 const char *label = dict_get_label (d);
103 label = _("No label.");
104 tab_text (t, 1, r++, TAB_LEFT, label);
107 tab_text (t, 0, r, TAB_LEFT, _("Created:"));
108 tab_text_format (t, 1, r++, TAB_LEFT, "%s %s by %s",
109 info.creation_date, info.creation_time, info.product);
111 if (info.product_ext)
113 tab_text (t, 0, r, TAB_LEFT, _("Product:"));
114 tab_text (t, 1, r++, TAB_LEFT, info.product_ext);
117 tab_text (t, 0, r, TAB_LEFT, _("Integer Format:"));
118 tab_text (t, 1, r++, TAB_LEFT,
119 info.integer_format == INTEGER_MSB_FIRST ? _("Big Endian")
120 : info.integer_format == INTEGER_LSB_FIRST ? _("Little Endian")
123 tab_text (t, 0, r, TAB_LEFT, _("Real Format:"));
124 tab_text (t, 1, r++, TAB_LEFT,
125 info.float_format == FLOAT_IEEE_DOUBLE_LE ? _("IEEE 754 LE.")
126 : info.float_format == FLOAT_IEEE_DOUBLE_BE ? _("IEEE 754 BE.")
127 : info.float_format == FLOAT_VAX_D ? _("VAX D.")
128 : info.float_format == FLOAT_VAX_G ? _("VAX G.")
129 : info.float_format == FLOAT_Z_LONG ? _("IBM 390 Hex Long.")
132 tab_text (t, 0, r, TAB_LEFT, _("Variables:"));
133 tab_text_format (t, 1, r++, TAB_LEFT, "%zu", dict_get_var_cnt (d));
135 tab_text (t, 0, r, TAB_LEFT, _("Cases:"));
136 if (info.case_cnt == -1)
137 tab_text (t, 1, r, TAB_LEFT, _("Unknown"));
139 tab_text_format (t, 1, r, TAB_LEFT, "%ld", (long int) info.case_cnt);
142 tab_text (t, 0, r, TAB_LEFT, _("Type:"));
143 tab_text (t, 1, r++, TAB_LEFT, _("System File"));
145 tab_text (t, 0, r, TAB_LEFT, _("Weight:"));
147 struct variable *weight_var = dict_get_weight (d);
148 tab_text (t, 1, r++, TAB_LEFT,
150 ? var_get_name (weight_var) : _("Not weighted.")));
153 tab_text (t, 0, r, TAB_LEFT, _("Mode:"));
154 tab_text_format (t, 1, r++, TAB_LEFT,
155 _("Compression %s."), info.compressed ? _("on") : _("off"));
158 tab_text (t, 0, r, TAB_LEFT, _("Charset:"));
159 tab_text (t, 1, r++, TAB_LEFT, dict_get_encoding (d));
163 t = tab_create (4, 1 + 2 * dict_get_var_cnt (d));
164 tab_headers (t, 0, 0, 1, 0);
165 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
166 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE, _("Description"));
167 tab_text (t, 3, 0, TAB_LEFT | TAT_TITLE, _("Position"));
168 tab_hline (t, TAL_2, 0, 3, 1);
169 for (r = 1, i = 0; i < dict_get_var_cnt (d); i++)
170 r = describe_variable (dict_get_var (d, i), t, r, 3,
171 DF_ALL & ~DF_AT_ATTRIBUTES);
173 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, r);
174 tab_vline (t, TAL_1, 1, 0, r);
175 tab_vline (t, TAL_1, 3, 0, r);
177 tab_resize (t, -1, r);
183 sfm_read_info_destroy (&info);
187 /* DISPLAY utility. */
189 static void display_macros (void);
190 static void display_documents (const struct dictionary *dict);
191 static void display_variables (const struct variable **, size_t, int);
192 static void display_vectors (const struct dictionary *dict, int sorted);
193 static void display_data_file_attributes (struct attrset *, int flags);
196 cmd_display (struct lexer *lexer, struct dataset *ds)
198 /* Whether to sort the list of variables alphabetically. */
201 /* Variables to display. */
203 const struct variable **vl;
205 if (lex_match_id (lexer, "MACROS"))
207 else if (lex_match_id (lexer, "DOCUMENTS"))
208 display_documents (dataset_dict (ds));
209 else if (lex_match_id (lexer, "FILE"))
211 if (!lex_force_match_id (lexer, "LABEL"))
213 if (dict_get_label (dataset_dict (ds)) == NULL)
214 tab_output_text (TAB_LEFT,
215 _("The active dataset does not have a file label."));
217 tab_output_text_format (TAB_LEFT, _("File label: %s"),
218 dict_get_label (dataset_dict (ds)));
224 sorted = lex_match_id (lexer, "SORTED");
226 if (lex_match_id (lexer, "VECTORS"))
228 display_vectors (dataset_dict(ds), sorted);
231 else if (lex_match_id (lexer, "SCRATCH"))
233 dict_get_vars (dataset_dict (ds), &vl, &n, DC_ORDINARY);
243 static const struct subcommand subcommands[] =
245 {"@ATTRIBUTES", DF_ATTRIBUTES | DF_AT_ATTRIBUTES},
246 {"ATTRIBUTES", DF_ATTRIBUTES},
247 {"DICTIONARY", DF_ALL & ~DF_AT_ATTRIBUTES},
248 {"INDEX", DF_DICT_INDEX},
249 {"LABELS", DF_DICT_INDEX | DF_VARIABLE_LABELS},
252 DF_DICT_INDEX | DF_FORMATS | DF_MISSING_VALUES | DF_MISC},
255 const struct subcommand *sbc;
258 for (sbc = subcommands; sbc->name != NULL; sbc++)
259 if (lex_match_id (lexer, sbc->name))
265 lex_match (lexer, T_SLASH);
266 lex_match_id (lexer, "VARIABLES");
267 lex_match (lexer, T_EQUALS);
269 if (lex_token (lexer) != T_ENDCMD)
271 if (!parse_variables_const (lexer, dataset_dict (ds), &vl, &n,
279 dict_get_vars (dataset_dict (ds), &vl, &n, 0);
284 sort (vl, n, sizeof *vl,
286 ? compare_var_ptrs_by_name
287 : compare_var_ptrs_by_dict_index), NULL);
288 display_variables (vl, n, flags);
291 msg (SW, _("No variables to display."));
294 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES))
295 display_data_file_attributes (dict_get_attributes (dataset_dict (ds)),
303 display_macros (void)
305 tab_output_text (TAB_LEFT, _("Macros not supported."));
309 display_documents (const struct dictionary *dict)
311 const struct string_array *documents = dict_get_documents (dict);
313 if (string_array_is_empty (documents))
314 tab_output_text (TAB_LEFT, _("The active dataset dictionary does not "
315 "contain any documents."));
320 tab_output_text (TAB_LEFT | TAT_TITLE,
321 _("Documents in the active dataset:"));
322 for (i = 0; i < dict_get_document_line_cnt (dict); i++)
323 tab_output_text (TAB_LEFT | TAB_FIX, dict_get_document_line (dict, i));
328 display_variables (const struct variable **vl, size_t n, int flags)
331 int nc; /* Number of columns. */
332 int pc; /* `Position column' */
333 int r; /* Current row. */
336 /* One column for the name,
337 two columns for general description,
338 one column for dictionary index. */
340 if (flags & ~DF_DICT_INDEX)
343 if (flags & DF_DICT_INDEX)
346 t = tab_create (nc, n + 5);
347 tab_headers (t, 0, 0, 1, 0);
348 tab_hline (t, TAL_2, 0, nc - 1, 1);
349 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Variable"));
350 if (flags & ~DF_DICT_INDEX)
351 tab_joint_text (t, 1, 0, 2, 0, TAB_LEFT | TAT_TITLE,
352 (flags & ~(DF_DICT_INDEX | DF_VARIABLE_LABELS)
353 ? _("Description") : _("Label")));
354 if (flags & DF_DICT_INDEX)
355 tab_text (t, pc, 0, TAB_LEFT | TAT_TITLE, _("Position"));
358 for (i = 0; i < n; i++)
359 r = describe_variable (vl[i], t, r, pc, flags);
360 tab_hline (t, flags & ~DF_DICT_INDEX ? TAL_2 : TAL_1, 0, nc - 1, 1);
363 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, nc - 1, r - 1);
364 tab_vline (t, TAL_1, 1, 0, r - 1);
366 if (flags & ~DF_DICT_INDEX)
367 tab_vline (t, TAL_1, nc - 1, 0, r - 1);
368 tab_resize (t, -1, r);
373 is_at_name (const char *name)
375 return name[0] == '@' || (name[0] == '$' && name[1] == '@');
379 count_attributes (const struct attrset *set, int flags)
381 struct attrset_iterator i;
382 struct attribute *attr;
386 for (attr = attrset_first (set, &i); attr != NULL;
387 attr = attrset_next (set, &i))
388 if (flags & DF_AT_ATTRIBUTES || !is_at_name (attribute_get_name (attr)))
389 n_attrs += attribute_get_n_values (attr);
394 display_attributes (struct tab_table *t, const struct attrset *set, int flags,
397 struct attribute **attrs;
401 n_attrs = attrset_count (set);
402 attrs = attrset_sorted (set);
403 for (i = 0; i < n_attrs; i++)
405 const struct attribute *attr = attrs[i];
406 const char *name = attribute_get_name (attr);
410 if (!(flags & DF_AT_ATTRIBUTES) && is_at_name (name))
413 n_values = attribute_get_n_values (attr);
414 for (i = 0; i < n_values; i++)
417 tab_text_format (t, c, r, TAB_LEFT, "%s[%zu]", name, i + 1);
419 tab_text (t, c, r, TAB_LEFT, name);
420 tab_text (t, c + 1, r, TAB_LEFT, attribute_get_value (attr, i));
428 display_data_file_attributes (struct attrset *set, int flags)
433 n_attrs = count_attributes (set, flags);
437 t = tab_create (2, n_attrs + 1);
438 tab_headers (t, 0, 0, 1, 0);
439 tab_box (t, TAL_1, TAL_1, -1, TAL_1, 0, 0, tab_nc (t) - 1, tab_nr (t) - 1);
440 tab_hline (t, TAL_2, 0, 1, 1);
441 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Attribute"));
442 tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Value"));
443 display_attributes (t, set, flags, 0, 1);
444 tab_title (t, "Custom data file attributes.");
448 /* Puts a description of variable V into table T starting at row
449 R. The variable will be described in the format given by
450 FLAGS. Returns the next row available for use in the
453 describe_variable (const struct variable *v, struct tab_table *t, int r,
459 /* Make sure that enough rows are allocated. */
461 if (flags & ~(DF_DICT_INDEX | DF_VARIABLE_LABELS))
463 if (flags & DF_VALUE_LABELS)
464 need_rows += val_labs_count (var_get_value_labels (v));
465 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES))
467 n_attrs = count_attributes (var_get_attributes (v), flags);
468 need_rows += n_attrs;
470 if (r + need_rows > tab_nr (t))
472 int nr = MAX (r + need_rows, tab_nr (t) * 2);
473 tab_realloc (t, -1, nr);
476 /* Put the name, var label, and position into the first row. */
477 tab_text (t, 0, r, TAB_LEFT, var_get_name (v));
478 if (flags & DF_DICT_INDEX)
479 tab_text_format (t, pc, r, 0, "%zu", var_get_dict_index (v) + 1);
481 if (flags & DF_VARIABLE_LABELS && var_has_label (v))
483 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, var_get_label (v));
487 /* Print/write format, or print and write formats. */
488 if (flags & DF_FORMATS)
490 const struct fmt_spec *print = var_get_print_format (v);
491 const struct fmt_spec *write = var_get_write_format (v);
493 if (fmt_equal (print, write))
495 char str[FMT_STRING_LEN_MAX + 1];
496 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
497 _("Format: %s"), fmt_to_string (print, str));
502 char str[FMT_STRING_LEN_MAX + 1];
503 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
504 _("Print Format: %s"),
505 fmt_to_string (print, str));
507 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
508 _("Write Format: %s"),
509 fmt_to_string (write, str));
514 /* Measurement level, role, display width, alignment. */
517 enum var_role role = var_get_role (v);
519 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
521 measure_to_string (var_get_measure (v)));
524 if (role != ROLE_INPUT)
526 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
527 _("Role: %s"), var_role_to_string (role));
531 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
532 _("Display Alignment: %s"),
533 alignment_to_string (var_get_alignment (v)));
536 tab_joint_text_format (t, 1, r, 2, r, TAB_LEFT,
537 _("Display Width: %d"),
538 var_get_display_width (v));
542 /* Missing values if any. */
543 if (flags & DF_MISSING_VALUES && var_has_missing_values (v))
545 const struct missing_values *mv = var_get_missing_values (v);
551 cp = stpcpy (buf, _("Missing Values: "));
553 if (mv_has_range (mv))
556 mv_get_range (mv, &x, &y);
558 cp += sprintf (cp, "LOWEST THRU %g", y);
559 else if (y == HIGHEST)
560 cp += sprintf (cp, "%g THRU HIGHEST", x);
562 cp += sprintf (cp, "%g THRU %g", x, y);
565 for (i = 0; i < mv_n_values (mv); i++)
567 const union value *value = mv_get_value (mv, i);
569 cp += sprintf (cp, "; ");
570 if (var_is_numeric (v))
571 cp += sprintf (cp, "%g", value->f);
574 int width = var_get_width (v);
575 int mv_width = MIN (width, MV_MAX_STRING);
578 memcpy (cp, value_str (value, width), mv_width);
585 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, buf);
590 if (flags & DF_VALUE_LABELS && var_has_value_labels (v))
592 const struct val_labs *val_labs = var_get_value_labels (v);
593 size_t n_labels = val_labs_count (val_labs);
594 const struct val_lab **labels;
599 tab_text (t, 1, r, TAB_LEFT, _("Value"));
600 tab_text (t, 2, r, TAB_LEFT, _("Label"));
604 tab_hline (t, TAL_1, 1, 2, r);
606 labels = val_labs_sorted (val_labs);
607 for (i = 0; i < n_labels; i++)
609 const struct val_lab *vl = labels[i];
611 tab_value (t, 1, r, TAB_NONE, &vl->value, v, NULL);
612 tab_text (t, 2, r, TAB_LEFT, val_lab_get_escaped_label (vl));
617 tab_vline (t, TAL_1, 2, orig_r, r - 1);
620 if (flags & (DF_ATTRIBUTES | DF_AT_ATTRIBUTES) && n_attrs)
622 tab_joint_text (t, 1, r, 2, r, TAB_LEFT, "Custom attributes:");
625 display_attributes (t, var_get_attributes (v), flags, 1, r);
629 /* Draw a line below the last row of information on this variable. */
630 tab_hline (t, TAL_1, 0, tab_nc (t) - 1, r);
635 /* Display a list of vectors. If SORTED is nonzero then they are
636 sorted alphabetically. */
638 display_vectors (const struct dictionary *dict, int sorted)
640 const struct vector **vl;
647 nvec = dict_get_vector_cnt (dict);
650 msg (SW, _("No vectors defined."));
654 vl = xnmalloc (nvec, sizeof *vl);
656 for (i = 0; i < nvec; i++)
658 vl[i] = dict_get_vector (dict, i);
659 nrow += vector_get_var_cnt (vl[i]);
662 qsort (vl, nvec, sizeof *vl, compare_vector_ptrs_by_name);
664 t = tab_create (4, nrow + 1);
665 tab_headers (t, 0, 0, 1, 0);
666 tab_box (t, TAL_1, TAL_1, -1, -1, 0, 0, 3, nrow);
667 tab_box (t, -1, -1, -1, TAL_1, 0, 0, 3, nrow);
668 tab_hline (t, TAL_2, 0, 3, 1);
669 tab_text (t, 0, 0, TAT_TITLE | TAB_LEFT, _("Vector"));
670 tab_text (t, 1, 0, TAT_TITLE | TAB_LEFT, _("Position"));
671 tab_text (t, 2, 0, TAT_TITLE | TAB_LEFT, _("Variable"));
672 tab_text (t, 3, 0, TAT_TITLE | TAB_LEFT, _("Print Format"));
675 for (i = 0; i < nvec; i++)
677 const struct vector *vec = vl[i];
680 tab_joint_text (t, 0, row, 0, row + vector_get_var_cnt (vec) - 1,
681 TAB_LEFT, vector_get_name (vl[i]));
683 for (j = 0; j < vector_get_var_cnt (vec); j++)
685 struct variable *var = vector_get_var (vec, j);
686 char fmt_string[FMT_STRING_LEN_MAX + 1];
687 fmt_to_string (var_get_print_format (var), fmt_string);
689 tab_text_format (t, 1, row, TAB_RIGHT, "%zu", j + 1);
690 tab_text (t, 2, row, TAB_LEFT, var_get_name (var));
691 tab_text (t, 3, row, TAB_LEFT, fmt_string);
694 tab_hline (t, TAL_1, 0, 3, row);