2 * Routines for printing packet analysis trees.
4 * $Id: print.c,v 1.31 2001/03/24 09:39:47 guy Exp $
6 * Gilbert Ramirez <gram@xiexie.org>
8 * Ethereal - Network traffic analyzer
9 * By Gerald Combs <gerald@zing.org>
10 * Copyright 1998 Gerald Combs
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version 2
16 * of the License, or (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
44 static void proto_tree_print_node_text(GNode *node, gpointer data);
45 static void proto_tree_print_node_ps(GNode *node, gpointer data);
46 static void ps_clean_string(unsigned char *out, const unsigned char *in,
48 static void print_hex_data_text(FILE *fh, register const u_char *cp,
49 register u_int length, char_enc encoding);
50 static void print_hex_data_ps(FILE *fh, register const u_char *cp,
51 register u_int length, char_enc encoding);
53 extern int proto_data; /* in packet-data.c */
60 gboolean print_all_levels;
61 gboolean print_hex_for_data;
65 FILE *open_print_dest(int to_file, const char *dest)
69 /* Open the file or command for output */
71 fh = fopen(dest, "w");
73 fh = popen(dest, "w");
78 void close_print_dest(int to_file, FILE *fh)
80 /* Close the file or command */
87 void print_preamble(FILE *fh, gint format)
89 if (format == PR_FMT_PS)
90 print_ps_preamble(fh);
93 void print_finale(FILE *fh, gint format)
95 if (format == PR_FMT_PS)
99 void proto_tree_print(gboolean print_one_packet, print_args_t *print_args,
100 GNode *protocol_tree, const u_char *pd, frame_data *fd, FILE *fh)
104 /* Create the output */
108 data.encoding = fd->flags.encoding;
109 data.print_all_levels = print_args->expand_all;
110 data.print_hex_for_data = !print_args->print_hex;
111 /* If we're printing the entire packet in hex, don't
112 print uninterpreted data fields in hex as well. */
114 if (print_args->format == PR_FMT_TEXT) {
115 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
116 proto_tree_print_node_text, &data);
118 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
119 proto_tree_print_node_ps, &data);
123 /* Print a tree's data, and any child nodes, in plain text */
125 void proto_tree_print_node_text(GNode *node, gpointer data)
127 field_info *fi = (field_info*) (node->data);
128 print_data *pdata = (print_data*) data;
132 gchar label_str[ITEM_LABEL_LENGTH];
135 /* Don't print invisible entries. */
139 /* was a free format label produced? */
140 if (fi->representation) {
141 label_ptr = fi->representation;
143 else { /* no, make a generic label */
144 label_ptr = label_str;
145 proto_item_fill_label(fi, label_str);
148 /* Prepare the tabs for printing, depending on tree level */
149 num_spaces = pdata->level * 4;
150 if (num_spaces > 40) {
153 for (i = 0; i < num_spaces; i++) {
156 /* The string is NUL-terminated */
157 space[num_spaces] = 0;
160 fprintf(pdata->fh, "%s%s\n", space, label_ptr);
162 /* If it's uninterpreted data, dump it (unless our caller will
163 be printing the entire packet in hex). */
164 if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data)
165 print_hex_data_text(pdata->fh, &pdata->pd[fi->start],
166 fi->length, pdata->encoding);
168 /* If we're printing all levels, or if this level is expanded,
169 recurse into the subtree, if it exists. */
170 if (pdata->print_all_levels || tree_is_expanded[fi->tree_type]) {
171 if (g_node_n_children(node) > 0) {
173 g_node_children_foreach(node, G_TRAVERSE_ALL,
174 proto_tree_print_node_text, pdata);
180 void print_hex_data(FILE *fh, gint format, frame_data *fd)
182 gboolean multiple_sources;
191 * Set "multiple_sources" iff this frame has more than one
192 * data source; if it does, we need to print the name of
193 * the data source before printing the data from the
196 multiple_sources = (fd->data_src->next != NULL);
198 for (src = fd->data_src; src != NULL; src = src->next) {
200 if (multiple_sources) {
201 name = tvb_get_name(tvb);
202 print_line(fh, format, "\n");
203 line = g_malloc(strlen(name) + 3); /* <name>:\n\0 */
206 print_line(fh, format, line);
208 print_line(fh, format, "\n");
210 length = tvb_length(tvb);
211 cp = tvb_get_ptr(tvb, 0, length);
212 if (format == PR_FMT_PS)
213 print_hex_data_ps(fh, cp, length, fd->flags.encoding);
215 print_hex_data_text(fh, cp, length, fd->flags.encoding);
219 /* This routine was created by Dan Lasley <DLASLEY@PROMUS.com>, and
220 only slightly modified for ethereal by Gilbert Ramirez. */
222 void print_hex_data_text(FILE *fh, register const u_char *cp,
223 register u_int length, char_enc encoding)
225 register int ad, i, j, k;
228 static u_char binhex[16] = {
229 '0', '1', '2', '3', '4', '5', '6', '7',
230 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
232 memset (line, ' ', sizeof line);
233 line[sizeof (line)-1] = 0;
234 for (ad=i=j=k=0; i<length; i++) {
236 line[j++] = binhex[c>>4];
237 line[j++] = binhex[c&0xf];
239 if (encoding == CHAR_EBCDIC) {
240 c = EBCDIC_to_ASCII1(c);
242 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
243 if ((i & 15) == 15) {
244 fprintf (fh, "\n%4x %s", ad, line);
245 /*if (i==15) printf (" %d", length);*/
246 memset (line, ' ', sizeof line);
247 line[sizeof (line)-1] = j = k = 0;
252 if (line[0] != ' ') fprintf (fh, "\n%4x %s", ad, line);
258 #define MAX_LINE_LENGTH 256
260 /* Print a node's data, and any child nodes, in PostScript */
262 void proto_tree_print_node_ps(GNode *node, gpointer data)
264 field_info *fi = (field_info*) (node->data);
265 print_data *pdata = (print_data*) data;
266 gchar label_str[ITEM_LABEL_LENGTH];
268 char psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
273 /* was a free format label produced? */
274 if (fi->representation) {
275 label_ptr = fi->representation;
277 else { /* no, make a generic label */
278 label_ptr = label_str;
279 proto_item_fill_label(fi, label_str);
283 ps_clean_string(psbuffer, label_ptr, MAX_LINE_LENGTH);
284 fprintf(pdata->fh, "%d (%s) putline\n", pdata->level, psbuffer);
286 /* If it's uninterpreted data, dump it (unless our caller will
287 be printing the entire packet in hex). */
288 if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
289 print_hex_data_ps(pdata->fh, &pdata->pd[fi->start], fi->length,
293 /* Recurse into the subtree, if it exists */
294 if (g_node_n_children(node) > 0) {
296 g_node_children_foreach(node, G_TRAVERSE_ALL,
297 proto_tree_print_node_ps, pdata);
303 void ps_clean_string(unsigned char *out, const unsigned char *in,
309 for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
331 void print_hex_data_ps(FILE *fh, register const u_char *cp,
332 register u_int length, char_enc encoding)
334 register int ad, i, j, k;
337 static u_char binhex[16] = {
338 '0', '1', '2', '3', '4', '5', '6', '7',
339 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
340 u_char psline[MAX_LINE_LENGTH];
343 memset (line, ' ', sizeof line);
344 line[sizeof (line)-1] = 0;
345 for (ad=i=j=k=0; i<length; i++) {
347 line[j++] = binhex[c>>4];
348 line[j++] = binhex[c&0xf];
350 if (encoding == CHAR_EBCDIC) {
351 c = EBCDIC_to_ASCII1(c);
353 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
354 if ((i & 15) == 15) {
355 ps_clean_string(psline, line, MAX_LINE_LENGTH);
356 fprintf (fh, "(%4x %s) hexdump\n", ad, psline);
357 memset (line, ' ', sizeof line);
358 line[sizeof (line)-1] = j = k = 0;
363 if (line[0] != ' ') {
364 ps_clean_string(psline, line, MAX_LINE_LENGTH);
365 fprintf (fh, "(%4x %s) hexdump\n", ad, psline);
371 void print_line(FILE *fh, gint format, char *line)
373 char psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
375 if (format == PR_FMT_PS) {
376 ps_clean_string(psbuffer, line, MAX_LINE_LENGTH);
377 fprintf(fh, "(%s) hexdump\n", psbuffer);