print.c

   1 /* print.c
   2  * Routines for printing packet analysis trees.
   3  *
   4  * $Id$
   5  *
   6  * Gilbert Ramirez <gram@alumni.rice.edu>
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <stdio.h>
  32 #include <string.h>
  33
  34 #include <epan/epan.h>
  35 #include <epan/epan_dissect.h>
  36 #include <epan/tvbuff.h>
  37 #include <epan/packet.h>
  38 #include <epan/emem.h>
  39
  40 #include "packet-range.h"
  41 #include "print.h"
  42 #include "ps.h"
  43 #include "version_info.h"
  44 #include <wsutil/file_util.h>
  45 #include <epan/charsets.h>
  46 #include <epan/dissectors/packet-data.h>
  47 #include <epan/dissectors/packet-frame.h>
  48
  49 #define PDML_VERSION "0"
  50 #define PSML_VERSION "0"
  51
  52 typedef struct {
  53         int                     level;
  54         print_stream_t          *stream;
  55         gboolean                success;
  56         GSList                  *src_list;
  57         print_dissections_e     print_dissections;
  58         gboolean                print_hex_for_data;
  59         char_enc                encoding;
  60         epan_dissect_t          *edt;
  61 } print_data;
  62
  63 typedef struct {
  64         int                     level;
  65         FILE                    *fh;
  66         GSList                  *src_list;
  67         epan_dissect_t          *edt;
  68 } write_pdml_data;
  69
  70 typedef struct {
  71     output_fields_t* fields;
  72         epan_dissect_t          *edt;
  73 } write_field_data_t;
  74
  75 struct _output_fields {
  76     gboolean print_header;
  77     gchar separator;
  78     GPtrArray* fields;
  79     GHashTable* field_indicies;
  80     const gchar** field_values;
  81     gchar quote;
  82 };
  83
  84 static const gchar* get_field_hex_value(GSList* src_list, field_info *fi);
  85 static void proto_tree_print_node(proto_node *node, gpointer data);
  86 static void proto_tree_write_node_pdml(proto_node *node, gpointer data);
  87 static const guint8 *get_field_data(GSList *src_list, field_info *fi);
  88 static void write_pdml_field_hex_value(write_pdml_data *pdata, field_info *fi);
  89 static gboolean print_hex_data_buffer(print_stream_t *stream, const guchar *cp,
  90     guint length, char_enc encoding);
  91 static void ps_clean_string(unsigned char *out, const unsigned char *in,
  92                         int outbuf_size);
  93 static void print_escaped_xml(FILE *fh, const char *unescaped_string);
  94
  95 static void print_pdml_geninfo(proto_tree *tree, FILE *fh);
  96
  97 static void proto_tree_get_node_field_values(proto_node *node, gpointer data);
  98
  99 static FILE *
 100 open_print_dest(int to_file, const char *dest)
 101 {
 102         FILE    *fh;
 103
 104         /* Open the file or command for output */
 105         if (to_file)
 106                 fh = ws_fopen(dest, "w");
 107         else
 108                 fh = popen(dest, "w");
 109
 110         return fh;
 111 }
 112
 113 static gboolean
 114 close_print_dest(int to_file, FILE *fh)
 115 {
 116         /* Close the file or command */
 117         if (to_file)
 118                 return (fclose(fh) == 0);
 119         else
 120                 return (pclose(fh) == 0);
 121 }
 122
 123 #define MAX_PS_LINE_LENGTH 256
 124
 125 gboolean
 126 proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
 127     print_stream_t *stream)
 128 {
 129         print_data data;
 130
 131         /* Create the output */
 132         data.level = 0;
 133         data.stream = stream;
 134         data.success = TRUE;
 135         data.src_list = edt->pi.data_src;
 136         data.encoding = edt->pi.fd->flags.encoding;
 137         data.print_dissections = print_args->print_dissections;
 138         /* If we're printing the entire packet in hex, don't
 139            print uninterpreted data fields in hex as well. */
 140         data.print_hex_for_data = !print_args->print_hex;
 141         data.edt = edt;
 142
 143         proto_tree_children_foreach(edt->tree, proto_tree_print_node, &data);
 144         return data.success;
 145 }
 146
 147 #define MAX_INDENT      160
 148
 149 /* Print a tree's data, and any child nodes. */
 150 static
 151 void proto_tree_print_node(proto_node *node, gpointer data)
 152 {
 153         field_info      *fi = PNODE_FINFO(node);
 154         print_data      *pdata = (print_data*) data;
 155         const guint8    *pd;
 156         gchar           label_str[ITEM_LABEL_LENGTH];
 157         gchar           *label_ptr;
 158
 159         g_assert(fi && "dissection with an invisible proto tree?");
 160
 161         /* Don't print invisible entries. */
 162         if (PROTO_ITEM_IS_HIDDEN(node))
 163                 return;
 164
 165         /* Give up if we've already gotten an error. */
 166         if (!pdata->success)
 167                 return;
 168
 169         /* was a free format label produced? */
 170         if (fi->rep) {
 171                 label_ptr = fi->rep->representation;
 172         }
 173         else { /* no, make a generic label */
 174                 label_ptr = label_str;
 175                 proto_item_fill_label(fi, label_str);
 176         }
 177
 178         if (PROTO_ITEM_IS_GENERATED(node)) {
 179                 label_ptr = g_strdup_printf("[%s]", label_ptr);
 180         }
 181
 182         if (!print_line(pdata->stream, pdata->level, label_ptr)) {
 183                 pdata->success = FALSE;
 184                 return;
 185         }
 186
 187         if (PROTO_ITEM_IS_GENERATED(node)) {
 188                 g_free(label_ptr);
 189         }
 190
 191         /* If it's uninterpreted data, dump it (unless our caller will
 192            be printing the entire packet in hex). */
 193         if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
 194                 /*
 195                  * Find the data for this field.
 196                  */
 197                 pd = get_field_data(pdata->src_list, fi);
 198                 if (pd) {
 199                         if (!print_hex_data_buffer(pdata->stream, pd,
 200                             fi->length, pdata->encoding)) {
 201                                 pdata->success = FALSE;
 202                                 return;
 203                         }
 204                 }
 205         }
 206
 207         /* If we're printing all levels, or if this node is one with a
 208            subtree and its subtree is expanded, recurse into the subtree,
 209            if it exists. */
 210         g_assert(fi->tree_type >= -1 && fi->tree_type < num_tree_types);
 211         if (pdata->print_dissections == print_dissections_expanded ||
 212             (pdata->print_dissections == print_dissections_as_displayed &&
 213                 fi->tree_type >= 0 && tree_is_expanded[fi->tree_type])) {
 214                 if (node->first_child != NULL) {
 215                         pdata->level++;
 216                         proto_tree_children_foreach(node,
 217                                 proto_tree_print_node, pdata);
 218                         pdata->level--;
 219                         if (!pdata->success)
 220                                 return;
 221                 }
 222         }
 223 }
 224
 225 void
 226 write_pdml_preamble(FILE *fh)
 227 {
 228         fputs("<?xml version=\"1.0\"?>\n", fh);
 229         fputs("<pdml version=\"" PDML_VERSION "\" ", fh);
 230         fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
 231 }
 232
 233 void
 234 proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh)
 235 {
 236         write_pdml_data data;
 237
 238         /* Create the output */
 239         data.level = 0;
 240         data.fh = fh;
 241         data.src_list = edt->pi.data_src;
 242         data.edt = edt;
 243
 244         /* We shouldn't be called with a NULL pointer here because we've
 245          * created a visible protocol tree */
 246         g_assert(data.src_list);
 247
 248         fprintf(fh, "<packet>\n");
 249
 250         /* Print a "geninfo" protocol as required by PDML */
 251         print_pdml_geninfo(edt->tree, fh);
 252
 253         proto_tree_children_foreach(edt->tree, proto_tree_write_node_pdml,
 254             &data);
 255
 256         fprintf(fh, "</packet>\n\n");
 257 }
 258
 259 /* Write out a tree's data, and any child nodes, as PDML */
 260 static void
 261 proto_tree_write_node_pdml(proto_node *node, gpointer data)
 262 {
 263         field_info      *fi = PNODE_FINFO(node);
 264         write_pdml_data *pdata = (write_pdml_data*) data;
 265         const gchar     *label_ptr;
 266         gchar           label_str[ITEM_LABEL_LENGTH];
 267         char            *dfilter_string;
 268         size_t          chop_len;
 269         int             i;
 270         gboolean wrap_in_fake_protocol;
 271
 272         g_assert(fi && "dissection with an invisible proto tree?");
 273
 274         /* Will wrap up top-level field items inside a fake protocol wrapper to
 275            preserve the PDML schema */
 276         wrap_in_fake_protocol =
 277             (((fi->hfinfo->type != FT_PROTOCOL) ||
 278              (fi->hfinfo->id == proto_data)) &&
 279             (pdata->level == 0));
 280
 281         /* Indent to the correct level */
 282         for (i = -1; i < pdata->level; i++) {
 283                 fputs("  ", pdata->fh);
 284         }
 285
 286         if (wrap_in_fake_protocol) {
 287                 /* Open fake protocol wrapper */
 288                 fputs("<proto name=\"fake-field-wrapper\">\n", pdata->fh);
 289
 290                 /* Indent to increased level before writint out field */
 291                 pdata->level++;
 292                 for (i = -1; i < pdata->level; i++) {
 293                         fputs("  ", pdata->fh);
 294                 }
 295         }
 296
 297         /* Text label. It's printed as a field with no name. */
 298         if (fi->hfinfo->id == hf_text_only) {
 299                 /* Get the text */
 300                 if (fi->rep) {
 301                         label_ptr = fi->rep->representation;
 302                 }
 303                 else {
 304                         label_ptr = "";
 305                 }
 306
 307                 /* Show empty name since it is a required field */
 308                 fputs("<field name=\"", pdata->fh);
 309                 fputs("\" show=\"", pdata->fh);
 310                 print_escaped_xml(pdata->fh, label_ptr);
 311
 312                 fprintf(pdata->fh, "\" size=\"%d", fi->length);
 313                 fprintf(pdata->fh, "\" pos=\"%d", fi->start);
 314
 315                 fputs("\" value=\"", pdata->fh);
 316                 write_pdml_field_hex_value(pdata, fi);
 317
 318                 if (node->first_child != NULL) {
 319                         fputs("\">\n", pdata->fh);
 320                 }
 321                 else {
 322                         fputs("\"/>\n", pdata->fh);
 323                 }
 324         }
 325
 326         /* Uninterpreted data, i.e., the "Data" protocol, is
 327          * printed as a field instead of a protocol. */
 328         else if (fi->hfinfo->id == proto_data) {
 329
 330                 /* Write out field with data */
 331                 fputs("<field name=\"data\" value=\"", pdata->fh);
 332                 write_pdml_field_hex_value(pdata, fi);
 333                 fputs("\"/>\n", pdata->fh);
 334         }
 335         /* Normal protocols and fields */
 336         else {
 337                 if (fi->hfinfo->type == FT_PROTOCOL) {
 338                         fputs("<proto name=\"", pdata->fh);
 339                 }
 340                 else {
 341                         fputs("<field name=\"", pdata->fh);
 342                 }
 343                 print_escaped_xml(pdata->fh, fi->hfinfo->abbrev);
 344
 345 #if 0
 346         /* PDML spec, see:
 347          * http://analyzer.polito.it/30alpha/docs/dissectors/PDMLSpec.htm
 348          *
 349          * the show fields contains things in 'human readable' format
 350          * showname: contains only the name of the field
 351          * show: contains only the data of the field
 352          * showdtl: contains additional details of the field data
 353          * showmap: contains mappings of the field data (e.g. the hostname to an IP address)
 354          *
 355          * XXX - the showname shouldn't contain the field data itself
 356          * (like it's contained in the fi->rep->representation).
 357          * Unfortunately, we don't have the field data representation for
 358          * all fields, so this isn't currently possible */
 359                 fputs("\" showname=\"", pdata->fh);
 360                 print_escaped_xml(pdata->fh, fi->hfinfo->name);
 361 #endif
 362
 363                 if (fi->rep) {
 364                         fputs("\" showname=\"", pdata->fh);
 365                         print_escaped_xml(pdata->fh, fi->rep->representation);
 366                 }
 367                 else {
 368                         label_ptr = label_str;
 369                         proto_item_fill_label(fi, label_str);
 370                         fputs("\" showname=\"", pdata->fh);
 371                         print_escaped_xml(pdata->fh, label_ptr);
 372                 }
 373
 374                 if (PROTO_ITEM_IS_HIDDEN(node))
 375                         fprintf(pdata->fh, "\" hide=\"yes");
 376
 377                 fprintf(pdata->fh, "\" size=\"%d", fi->length);
 378                 fprintf(pdata->fh, "\" pos=\"%d", fi->start);
 379 /*              fprintf(pdata->fh, "\" id=\"%d", fi->hfinfo->id);*/
 380
 381                 /* show, value, and unmaskedvalue attributes */
 382                 switch (fi->hfinfo->type)
 383                 {
 384                 case FT_PROTOCOL:
 385                         break;
 386                 case FT_NONE:
 387                         fputs("\" show=\"\" value=\"",  pdata->fh);
 388                         break;
 389                 default:
 390                         /* XXX - this is a hack until we can just call
 391                          * fvalue_to_string_repr() for *all* FT_* types. */
 392                         dfilter_string = proto_construct_match_selected_string(fi,
 393                             pdata->edt);
 394                         if (dfilter_string != NULL) {
 395                                 chop_len = strlen(fi->hfinfo->abbrev) + 4; /* for " == " */
 396
 397                                 /* XXX - Remove double-quotes. Again, once we
 398                                  * can call fvalue_to_string_repr(), we can
 399                                  * ask it not to produce the version for
 400                                  * display-filters, and thus, no
 401                                  * double-quotes. */
 402                                 if (dfilter_string[strlen(dfilter_string)-1] == '"') {
 403                                         dfilter_string[strlen(dfilter_string)-1] = '\0';
 404                                         chop_len++;
 405                                 }
 406
 407                                 fputs("\" show=\"", pdata->fh);
 408                                 print_escaped_xml(pdata->fh, &dfilter_string[chop_len]);
 409                         }
 410
 411                         /*
 412                          * XXX - should we omit "value" for any fields?
 413                          * What should we do for fields whose length is 0?
 414                          * They might come from a pseudo-header or from
 415                          * the capture header (e.g., time stamps), or
 416                          * they might be generated fields.
 417                          */
 418                         if (fi->length > 0) {
 419                                 fputs("\" value=\"", pdata->fh);
 420
 421                                 if (fi->hfinfo->bitmask!=0) {
 422                                         fprintf(pdata->fh, "%X", fvalue_get_uinteger(&fi->value));
 423                                         fputs("\" unmaskedvalue=\"", pdata->fh);
 424                                         write_pdml_field_hex_value(pdata, fi);
 425                                 }
 426                                 else {
 427                                         write_pdml_field_hex_value(pdata, fi);
 428                                 }
 429                         }
 430                 }
 431
 432                 if (node->first_child != NULL) {
 433                         fputs("\">\n", pdata->fh);
 434                 }
 435                 else if (fi->hfinfo->id == proto_data) {
 436                         fputs("\">\n", pdata->fh);
 437                 }
 438                 else {
 439                         fputs("\"/>\n", pdata->fh);
 440                 }
 441         }
 442
 443         /* We always print all levels for PDML. Recurse here. */
 444         if (node->first_child != NULL) {
 445                 pdata->level++;
 446                 proto_tree_children_foreach(node,
 447                                 proto_tree_write_node_pdml, pdata);
 448                 pdata->level--;
 449         }
 450
 451         /* Take back the extra level we added for fake wrapper protocol */
 452         if (wrap_in_fake_protocol) {
 453                 pdata->level--;
 454         }
 455
 456         if (node->first_child != NULL) {
 457                 /* Indent to correct level */
 458                 for (i = -1; i < pdata->level; i++) {
 459                         fputs("  ", pdata->fh);
 460                 }
 461                 /* Close off current element */
 462                 if (fi->hfinfo->id != proto_data) {   /* Data protocol uses simple tags */
 463                         if (fi->hfinfo->type == FT_PROTOCOL) {
 464                                 fputs("</proto>\n", pdata->fh);
 465                         }
 466                         else {
 467                                 fputs("</field>\n", pdata->fh);
 468                         }
 469                 }
 470         }
 471
 472         /* Close off fake wrapper protocol */
 473         if (wrap_in_fake_protocol) {
 474                 fputs("</proto>\n", pdata->fh);
 475         }
 476 }
 477
 478 /* Print info for a 'geninfo' pseudo-protocol. This is required by
 479  * the PDML spec. The information is contained in Wireshark's 'frame' protocol,
 480  * but we produce a 'geninfo' protocol in the PDML to conform to spec.
 481  * The 'frame' protocol follows the 'geninfo' protocol in the PDML. */
 482 static void
 483 print_pdml_geninfo(proto_tree *tree, FILE *fh)
 484 {
 485         guint32 num, len, caplen;
 486         nstime_t *timestamp;
 487         GPtrArray *finfo_array;
 488         field_info *frame_finfo;
 489
 490         /* Get frame protocol's finfo. */
 491         finfo_array = proto_find_finfo(tree, proto_frame);
 492         if (g_ptr_array_len(finfo_array) < 1) {
 493                 return;
 494         }
 495         frame_finfo = finfo_array->pdata[0];
 496         g_ptr_array_free(finfo_array, TRUE);
 497
 498         /* frame.number --> geninfo.num */
 499         finfo_array = proto_find_finfo(tree, hf_frame_number);
 500         if (g_ptr_array_len(finfo_array) < 1) {
 501                 return;
 502         }
 503         num = fvalue_get_uinteger(&((field_info*)finfo_array->pdata[0])->value);
 504         g_ptr_array_free(finfo_array, TRUE);
 505
 506         /* frame.frame_len --> geninfo.len */
 507         finfo_array = proto_find_finfo(tree, hf_frame_len);
 508         if (g_ptr_array_len(finfo_array) < 1) {
 509                 return;
 510         }
 511         len = fvalue_get_uinteger(&((field_info*)finfo_array->pdata[0])->value);
 512         g_ptr_array_free(finfo_array, TRUE);
 513
 514         /* frame.cap_len --> geninfo.caplen */
 515         finfo_array = proto_find_finfo(tree, hf_frame_capture_len);
 516         if (g_ptr_array_len(finfo_array) < 1) {
 517                 return;
 518         }
 519         caplen = fvalue_get_uinteger(&((field_info*)finfo_array->pdata[0])->value);
 520         g_ptr_array_free(finfo_array, TRUE);
 521
 522         /* frame.time --> geninfo.timestamp */
 523         finfo_array = proto_find_finfo(tree, hf_frame_arrival_time);
 524         if (g_ptr_array_len(finfo_array) < 1) {
 525                 return;
 526         }
 527         timestamp = fvalue_get(&((field_info*)finfo_array->pdata[0])->value);
 528         g_ptr_array_free(finfo_array, TRUE);
 529
 530         /* Print geninfo start */
 531         fprintf(fh,
 532 "  <proto name=\"geninfo\" pos=\"0\" showname=\"General information\" size=\"%u\">\n",
 533                 frame_finfo->length);
 534
 535         /* Print geninfo.num */
 536         fprintf(fh,
 537 "    <field name=\"num\" pos=\"0\" show=\"%u\" showname=\"Number\" value=\"%x\" size=\"%u\"/>\n",
 538                 num, num, frame_finfo->length);
 539
 540         /* Print geninfo.len */
 541         fprintf(fh,
 542 "    <field name=\"len\" pos=\"0\" show=\"%u\" showname=\"Frame Length\" value=\"%x\" size=\"%u\"/>\n",
 543                 len, len, frame_finfo->length);
 544
 545         /* Print geninfo.caplen */
 546         fprintf(fh,
 547 "    <field name=\"caplen\" pos=\"0\" show=\"%u\" showname=\"Captured Length\" value=\"%x\" size=\"%u\"/>\n",
 548                 caplen, caplen, frame_finfo->length);
 549
 550         /* Print geninfo.timestamp */
 551         fprintf(fh,
 552 "    <field name=\"timestamp\" pos=\"0\" show=\"%s\" showname=\"Captured Time\" value=\"%d.%09d\" size=\"%u\"/>\n",
 553                 abs_time_to_str(timestamp), (int) timestamp->secs, timestamp->nsecs, frame_finfo->length);
 554
 555         /* Print geninfo end */
 556         fprintf(fh,
 557 "  </proto>\n");
 558 }
 559
 560 void
 561 write_pdml_finale(FILE *fh)
 562 {
 563         fputs("</pdml>\n", fh);
 564 }
 565
 566 void
 567 write_psml_preamble(FILE *fh)
 568 {
 569         fputs("<?xml version=\"1.0\"?>\n", fh);
 570         fputs("<psml version=\"" PSML_VERSION "\" ", fh);
 571         fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
 572 }
 573
 574 void
 575 proto_tree_write_psml(epan_dissect_t *edt, FILE *fh)
 576 {
 577         gint    i;
 578
 579         /* if this is the first packet, we have to create the PSML structure output */
 580         if(edt->pi.fd->num == 1) {
 581             fprintf(fh, "<structure>\n");
 582
 583             for(i=0; i < edt->pi.cinfo->num_cols; i++) {
 584                 fprintf(fh, "<section>");
 585                 print_escaped_xml(fh, edt->pi.cinfo->col_title[i]);
 586                 fprintf(fh, "</section>\n");
 587             }
 588
 589             fprintf(fh, "</structure>\n\n");
 590         }
 591
 592         fprintf(fh, "<packet>\n");
 593
 594         for(i=0; i < edt->pi.cinfo->num_cols; i++) {
 595             fprintf(fh, "<section>");
 596             print_escaped_xml(fh, edt->pi.cinfo->col_data[i]);
 597             fprintf(fh, "</section>\n");
 598         }
 599
 600         fprintf(fh, "</packet>\n\n");
 601 }
 602
 603 void
 604 write_psml_finale(FILE *fh)
 605 {
 606         fputs("</psml>\n", fh);
 607 }
 608
 609 void
 610 write_csv_preamble(FILE *fh _U_)
 611 {
 612
 613 }
 614
 615 void
 616 proto_tree_write_csv(epan_dissect_t *edt, FILE *fh)
 617 {
 618         gint    i;
 619
 620         /* if this is the first packet, we have to write the CSV header */
 621         if(edt->pi.fd->num == 1) {
 622             for(i=0; i < edt->pi.cinfo->num_cols - 1; i++)
 623                 fprintf(fh, "\"%s\",", edt->pi.cinfo->col_title[i]);
 624
 625             fprintf(fh, "\"%s\"\n", edt->pi.cinfo->col_title[i]);
 626         }
 627
 628         for(i=0; i < edt->pi.cinfo->num_cols - 1; i++)
 629             fprintf(fh, "\"%s\",", edt->pi.cinfo->col_data[i]);
 630
 631         fprintf(fh, "\"%s\"\n", edt->pi.cinfo->col_data[i]);
 632 }
 633
 634 void
 635 write_csv_finale(FILE *fh _U_)
 636 {
 637
 638 }
 639
 640 void
 641 write_carrays_preamble(FILE *fh _U_)
 642 {
 643
 644 }
 645
 646 void
 647 proto_tree_write_carrays(const guint8 *pd, guint32 len, guint32 num, FILE *fh)
 648 {
 649         guint32 i = 0;
 650
 651         if (!len)
 652                 return;
 653
 654         fprintf(fh, "char pkt%u[] = {\n", num);
 655
 656         for (i = 0; i < len; i++) {
 657
 658                 fprintf(fh, "0x%02x", *(pd + i));
 659
 660                 if (i == (len - 1)) {
 661                         fprintf(fh, " };\n\n");
 662                         break;
 663                 }
 664
 665                 if (!((i + 1) % 8)) {
 666                         fprintf(fh, ", \n");
 667                 } else {
 668                         fprintf(fh, ", ");
 669                 }
 670         }
 671 }
 672
 673 void
 674 write_carrays_finale(FILE *fh _U_)
 675 {
 676
 677 }
 678
 679 /*
 680  * Find the data source for a specified field, and return a pointer
 681  * to the data in it. Returns NULL if the data is out of bounds.
 682  */
 683 static const guint8 *
 684 get_field_data(GSList *src_list, field_info *fi)
 685 {
 686         GSList *src_le;
 687         data_source *src;
 688         tvbuff_t *src_tvb;
 689         gint length, tvbuff_length;
 690
 691         for (src_le = src_list; src_le != NULL; src_le = src_le->next) {
 692                 src = src_le->data;
 693                 src_tvb = src->tvb;
 694                 if (fi->ds_tvb == src_tvb) {
 695                         /*
 696                          * Found it.
 697                          *
 698                          * XXX - a field can have a length that runs past
 699                          * the end of the tvbuff.  Ideally, that should
 700                          * be fixed when adding an item to the protocol
 701                          * tree, but checking the length when doing
 702                          * that could be expensive.  Until we fix that,
 703                          * we'll do the check here.
 704                          */
 705                         tvbuff_length = tvb_length_remaining(src_tvb,
 706                             fi->start);
 707                         if (tvbuff_length < 0) {
 708                                 return NULL;
 709                         }
 710                         length = fi->length;
 711                         if (length > tvbuff_length)
 712                                 length = tvbuff_length;
 713                         return tvb_get_ptr(src_tvb, fi->start, length);
 714                 }
 715         }
 716         g_assert_not_reached();
 717         return NULL;    /* not found */
 718 }
 719
 720 /* Print a string, escaping out certain characters that need to
 721  * escaped out for XML. */
 722 static void
 723 print_escaped_xml(FILE *fh, const char *unescaped_string)
 724 {
 725         const char *p;
 726
 727         for (p = unescaped_string; *p != '\0'; p++) {
 728                 switch (*p) {
 729                         case '&':
 730                                 fputs("&amp;", fh);
 731                                 break;
 732                         case '<':
 733                                 fputs("&lt;", fh);
 734                                 break;
 735                         case '>':
 736                                 fputs("&gt;", fh);
 737                                 break;
 738                         case '"':
 739                                 fputs("&quot;", fh);
 740                                 break;
 741                         case '\'':
 742                                 fputs("&apos;", fh);
 743                                 break;
 744                         default:
 745                                 fputc(*p, fh);
 746                 }
 747         }
 748 }
 749
 750 static void
 751 write_pdml_field_hex_value(write_pdml_data *pdata, field_info *fi)
 752 {
 753         int i;
 754         const guint8 *pd;
 755
 756         if (!fi->ds_tvb)
 757                 return;
 758
 759         if (fi->length > tvb_length_remaining(fi->ds_tvb, fi->start)) {
 760                 fprintf(pdata->fh, "field length invalid!");
 761                 return;
 762         }
 763
 764         /* Find the data for this field. */
 765         pd = get_field_data(pdata->src_list, fi);
 766
 767         if (pd) {
 768                 /* Print a simple hex dump */
 769                 for (i = 0 ; i < fi->length; i++) {
 770                         fprintf(pdata->fh, "%02x", pd[i]);
 771                 }
 772         }
 773 }
 774
 775 gboolean
 776 print_hex_data(print_stream_t *stream, epan_dissect_t *edt)
 777 {
 778         gboolean multiple_sources;
 779         GSList *src_le;
 780         data_source *src;
 781         tvbuff_t *tvb;
 782         const char *name;
 783         char *line;
 784         const guchar *cp;
 785         guint length;
 786
 787         /* We shouldn't be called with a NULL pointer here because we've
 788          * created a visible protocol tree */
 789         g_assert(edt->pi.data_src);
 790
 791         /*
 792          * Set "multiple_sources" iff this frame has more than one
 793          * data source; if it does, we need to print the name of
 794          * the data source before printing the data from the
 795          * data source.
 796          */
 797         multiple_sources = (edt->pi.data_src->next != NULL);
 798
 799         for (src_le = edt->pi.data_src; src_le != NULL;
 800             src_le = src_le->next) {
 801                 src = src_le->data;
 802                 tvb = src->tvb;
 803                 if (multiple_sources) {
 804                         name = get_data_source_name(src);
 805                         print_line(stream, 0, "");
 806                         line = g_strdup_printf("%s:", name);
 807                         print_line(stream, 0, line);
 808                         g_free(line);
 809                 }
 810                 length = tvb_length(tvb);
 811                 if (length == 0)
 812                     return TRUE;
 813                 cp = tvb_get_ptr(tvb, 0, length);
 814                 if (!print_hex_data_buffer(stream, cp, length,
 815                     edt->pi.fd->flags.encoding))
 816                         return FALSE;
 817         }
 818         return TRUE;
 819 }
 820
 821 /*
 822  * This routine is based on a routine created by Dan Lasley
 823  * <DLASLEY@PROMUS.com>.
 824  *
 825  * It was modified for Wireshark by Gilbert Ramirez and others.
 826  */
 827
 828 #define MAX_OFFSET_LEN  8       /* max length of hex offset of bytes */
 829 #define BYTES_PER_LINE  16      /* max byte values printed on a line */
 830 #define HEX_DUMP_LEN    (BYTES_PER_LINE*3)
 831                                 /* max number of characters hex dump takes -
 832                                    2 digits plus trailing blank */
 833 #define DATA_DUMP_LEN   (HEX_DUMP_LEN + 2 + BYTES_PER_LINE)
 834                                 /* number of characters those bytes take;
 835                                    3 characters per byte of hex dump,
 836                                    2 blanks separating hex from ASCII,
 837                                    1 character per byte of ASCII dump */
 838 #define MAX_LINE_LEN    (MAX_OFFSET_LEN + 2 + DATA_DUMP_LEN)
 839                                 /* number of characters per line;
 840                                    offset, 2 blanks separating offset
 841                                    from data dump, data dump */
 842
 843 static gboolean
 844 print_hex_data_buffer(print_stream_t *stream, const guchar *cp,
 845     guint length, char_enc encoding)
 846 {
 847         register unsigned int ad, i, j, k, l;
 848         guchar c;
 849         guchar line[MAX_LINE_LEN + 1];
 850         unsigned int use_digits;
 851         static guchar binhex[16] = {
 852                 '0', '1', '2', '3', '4', '5', '6', '7',
 853                 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
 854
 855         if (!print_line(stream, 0, ""))
 856                 return FALSE;
 857
 858         /*
 859          * How many of the leading digits of the offset will we supply?
 860          * We always supply at least 4 digits, but if the maximum offset
 861          * won't fit in 4 digits, we use as many digits as will be needed.
 862          */
 863         if (((length - 1) & 0xF0000000) != 0)
 864                 use_digits = 8; /* need all 8 digits */
 865         else if (((length - 1) & 0x0F000000) != 0)
 866                 use_digits = 7; /* need 7 digits */
 867         else if (((length - 1) & 0x00F00000) != 0)
 868                 use_digits = 6; /* need 6 digits */
 869         else if (((length - 1) & 0x000F0000) != 0)
 870                 use_digits = 5; /* need 5 digits */
 871         else
 872                 use_digits = 4; /* we'll supply 4 digits */
 873
 874         ad = 0;
 875         i = 0;
 876         j = 0;
 877         k = 0;
 878         while (i < length) {
 879                 if ((i & 15) == 0) {
 880                         /*
 881                          * Start of a new line.
 882                          */
 883                         j = 0;
 884                         k = 0;
 885                         l = use_digits;
 886                         do {
 887                                 l--;
 888                                 c = (ad >> (l*4)) & 0xF;
 889                                 line[j++] = binhex[c];
 890                         } while (l != 0);
 891                         line[j++] = ' ';
 892                         line[j++] = ' ';
 893                         memset(line+j, ' ', DATA_DUMP_LEN);
 894
 895                         /*
 896                          * Offset in line of ASCII dump.
 897                          */
 898                         k = j + HEX_DUMP_LEN + 2;
 899                 }
 900                 c = *cp++;
 901                 line[j++] = binhex[c>>4];
 902                 line[j++] = binhex[c&0xf];
 903                 j++;
 904                 if (encoding == CHAR_EBCDIC) {
 905                         c = EBCDIC_to_ASCII1(c);
 906                 }
 907                 line[k++] = c >= ' ' && c < 0x7f ? c : '.';
 908                 i++;
 909                 if ((i & 15) == 0 || i == length) {
 910                         /*
 911                          * We'll be starting a new line, or
 912                          * we're finished printing this buffer;
 913                          * dump out the line we've constructed,
 914                          * and advance the offset.
 915                          */
 916                         line[k] = '\0';
 917                         if (!print_line(stream, 0, line))
 918                                 return FALSE;
 919                         ad += 16;
 920                 }
 921         }
 922         return TRUE;
 923 }
 924
 925 static
 926 void ps_clean_string(unsigned char *out, const unsigned char *in,
 927                         int outbuf_size)
 928 {
 929         int rd, wr;
 930         char c;
 931
 932         for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
 933                 c = in[rd];
 934                 switch (c) {
 935                         case '(':
 936                         case ')':
 937                         case '\\':
 938                                 out[wr] = '\\';
 939                                 out[++wr] = c;
 940                                 break;
 941
 942                         default:
 943                                 out[wr] = c;
 944                                 break;
 945                 }
 946
 947                 if (c == 0) {
 948                         break;
 949                 }
 950         }
 951 }
 952
 953 /* Some formats need stuff at the beginning of the output */
 954 gboolean
 955 print_preamble(print_stream_t *self, gchar *filename)
 956 {
 957         return (self->ops->print_preamble)(self, filename);
 958 }
 959
 960 gboolean
 961 print_line(print_stream_t *self, int indent, const char *line)
 962 {
 963         return (self->ops->print_line)(self, indent, line);
 964 }
 965
 966 /* Insert bookmark */
 967 gboolean
 968 print_bookmark(print_stream_t *self, const gchar *name, const gchar *title)
 969 {
 970         return (self->ops->print_bookmark)(self, name, title);
 971 }
 972
 973 gboolean
 974 new_page(print_stream_t *self)
 975 {
 976         return (self->ops->new_page)(self);
 977 }
 978
 979 /* Some formats need stuff at the end of the output */
 980 gboolean
 981 print_finale(print_stream_t *self)
 982 {
 983         return (self->ops->print_finale)(self);
 984 }
 985
 986 gboolean
 987 destroy_print_stream(print_stream_t *self)
 988 {
 989         return (self->ops->destroy)(self);
 990 }
 991
 992 typedef struct {
 993         int to_file;
 994         FILE *fh;
 995 } output_text;
 996
 997 static gboolean
 998 print_preamble_text(print_stream_t *self _U_, gchar *filename _U_)
 999 {
1000         /* do nothing */
1001         return TRUE;    /* always succeeds */
1002 }
1003
1004 static gboolean
1005 print_line_text(print_stream_t *self, int indent, const char *line)
1006 {
1007         output_text *output = self->data;
1008         char space[MAX_INDENT+1];
1009         int i;
1010         int num_spaces;
1011
1012         /* Prepare the tabs for printing, depending on tree level */
1013         num_spaces = indent * 4;
1014         if (num_spaces > MAX_INDENT) {
1015                 num_spaces = MAX_INDENT;
1016         }
1017         for (i = 0; i < num_spaces; i++) {
1018                 space[i] = ' ';
1019         }
1020         /* The string is NUL-terminated */
1021         space[num_spaces] = '\0';
1022
1023         fputs(space, output->fh);
1024         fputs(line, output->fh);
1025         putc('\n', output->fh);
1026         return !ferror(output->fh);
1027 }
1028
1029 static gboolean
1030 print_bookmark_text(print_stream_t *self _U_, const gchar *name _U_,
1031     const gchar *title _U_)
1032 {
1033         /* do nothing */
1034         return TRUE;
1035 }
1036
1037 static gboolean
1038 new_page_text(print_stream_t *self)
1039 {
1040         output_text *output = self->data;
1041
1042         fputs("\f", output->fh);
1043         return !ferror(output->fh);
1044 }
1045
1046 static gboolean
1047 print_finale_text(print_stream_t *self _U_)
1048 {
1049         /* do nothing */
1050         return TRUE;    /* always succeeds */
1051 }
1052
1053 static gboolean
1054 destroy_text(print_stream_t *self)
1055 {
1056         output_text *output = self->data;
1057         gboolean ret;
1058
1059         ret = close_print_dest(output->to_file, output->fh);
1060         g_free(output);
1061         g_free(self);
1062         return ret;
1063 }
1064
1065 static const print_stream_ops_t print_text_ops = {
1066         print_preamble_text,
1067         print_line_text,
1068         print_bookmark_text,
1069         new_page_text,
1070         print_finale_text,
1071         destroy_text
1072 };
1073
1074 static print_stream_t *
1075 print_stream_text_alloc(int to_file, FILE *fh)
1076 {
1077         print_stream_t *stream;
1078         output_text *output;
1079
1080         output = g_malloc(sizeof *output);
1081         output->to_file = to_file;
1082         output->fh = fh;
1083         stream = g_malloc(sizeof (print_stream_t));
1084         stream->ops = &print_text_ops;
1085         stream->data = output;
1086
1087         return stream;
1088 }
1089
1090 print_stream_t *
1091 print_stream_text_new(int to_file, const char *dest)
1092 {
1093         FILE *fh;
1094
1095         fh = open_print_dest(to_file, dest);
1096         if (fh == NULL)
1097                 return NULL;
1098
1099         return print_stream_text_alloc(to_file, fh);
1100 }
1101
1102 print_stream_t *
1103 print_stream_text_stdio_new(FILE *fh)
1104 {
1105         return print_stream_text_alloc(TRUE, fh);
1106 }
1107
1108 typedef struct {
1109         int to_file;
1110         FILE *fh;
1111 } output_ps;
1112
1113 static gboolean
1114 print_preamble_ps(print_stream_t *self, gchar *filename)
1115 {
1116         output_ps *output = self->data;
1117         unsigned char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
1118
1119         print_ps_preamble(output->fh);
1120
1121         fputs("%% Set the font to 8 point\n", output->fh);
1122         fputs("/Courier findfont 8 scalefont setfont\n", output->fh);
1123         fputs("\n", output->fh);
1124         fputs("%% the page title\n", output->fh);
1125         ps_clean_string(psbuffer, filename, MAX_PS_LINE_LENGTH);
1126         fprintf(output->fh, "/ws_pagetitle (%s - Wireshark " VERSION "%s) def\n", psbuffer, wireshark_svnversion);
1127         fputs("\n", output->fh);
1128         return !ferror(output->fh);
1129 }
1130
1131 static gboolean
1132 print_line_ps(print_stream_t *self, int indent, const char *line)
1133 {
1134         output_ps *output = self->data;
1135         unsigned char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
1136
1137         ps_clean_string(psbuffer, line, MAX_PS_LINE_LENGTH);
1138         fprintf(output->fh, "%d (%s) putline\n", indent, psbuffer);
1139         return !ferror(output->fh);
1140 }
1141
1142 static gboolean
1143 print_bookmark_ps(print_stream_t *self, const gchar *name, const gchar *title)
1144 {
1145         output_ps *output = self->data;
1146         unsigned char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
1147
1148         /*
1149          * See the Adobe "pdfmark reference":
1150          *
1151          *      http://partners.adobe.com/asn/acrobat/docs/pdfmark.pdf
1152          *
1153          * The pdfmark stuff tells code that turns PostScript into PDF
1154          * things that it should do.
1155          *
1156          * The /OUT stuff creates a bookmark that goes to the
1157          * destination with "name" as the name and "title" as the title.
1158          *
1159          * The "/DEST" creates the destination.
1160          */
1161         ps_clean_string(psbuffer, title, MAX_PS_LINE_LENGTH);
1162         fprintf(output->fh, "[/Dest /%s /Title (%s)   /OUT pdfmark\n", name,
1163             psbuffer);
1164         fputs("[/View [/XYZ -4 currentpoint matrix currentmatrix matrix defaultmatrix\n",
1165             output->fh);
1166         fputs("matrix invertmatrix matrix concatmatrix transform exch pop 20 add null]\n",
1167             output->fh);
1168         fprintf(output->fh, "/Dest /%s /DEST pdfmark\n", name);
1169         return !ferror(output->fh);
1170 }
1171
1172 static gboolean
1173 new_page_ps(print_stream_t *self)
1174 {
1175         output_ps *output = self->data;
1176
1177         fputs("formfeed\n", output->fh);
1178         return !ferror(output->fh);
1179 }
1180
1181 static gboolean
1182 print_finale_ps(print_stream_t *self)
1183 {
1184         output_ps *output = self->data;
1185
1186         print_ps_finale(output->fh);
1187         return !ferror(output->fh);
1188 }
1189
1190 static gboolean
1191 destroy_ps(print_stream_t *self)
1192 {
1193         output_ps *output = self->data;
1194         gboolean ret;
1195
1196         ret = close_print_dest(output->to_file, output->fh);
1197         g_free(output);
1198         g_free(self);
1199         return ret;
1200 }
1201
1202 static const print_stream_ops_t print_ps_ops = {
1203         print_preamble_ps,
1204         print_line_ps,
1205         print_bookmark_ps,
1206         new_page_ps,
1207         print_finale_ps,
1208         destroy_ps
1209 };
1210
1211 static print_stream_t *
1212 print_stream_ps_alloc(int to_file, FILE *fh)
1213 {
1214         print_stream_t *stream;
1215         output_ps *output;
1216
1217         output = g_malloc(sizeof *output);
1218         output->to_file = to_file;
1219         output->fh = fh;
1220         stream = g_malloc(sizeof (print_stream_t));
1221         stream->ops = &print_ps_ops;
1222         stream->data = output;
1223
1224         return stream;
1225 }
1226
1227 print_stream_t *
1228 print_stream_ps_new(int to_file, const char *dest)
1229 {
1230         FILE *fh;
1231
1232         fh = open_print_dest(to_file, dest);
1233         if (fh == NULL)
1234                 return NULL;
1235
1236         return print_stream_ps_alloc(to_file, fh);
1237 }
1238
1239 print_stream_t *
1240 print_stream_ps_stdio_new(FILE *fh)
1241 {
1242         return print_stream_ps_alloc(TRUE, fh);
1243 }
1244
1245 output_fields_t* output_fields_new()
1246 {
1247     output_fields_t* fields = g_new(output_fields_t, 1);
1248     fields->print_header = FALSE;
1249     fields->separator = '\t';
1250     fields->fields = NULL; /*Do lazy initialisation */
1251     fields->field_indicies = NULL;
1252     fields->field_values = NULL;
1253     fields->quote='\0';
1254     return fields;
1255 }
1256
1257 gsize output_fields_num_fields(output_fields_t* fields)
1258 {
1259     g_assert(fields);
1260
1261     if(NULL == fields->fields) {
1262         return 0;
1263     } else {
1264         return fields->fields->len;
1265     }
1266 }
1267
1268 void output_fields_free(output_fields_t* fields)
1269 {
1270     g_assert(fields);
1271
1272     if(NULL != fields->field_indicies) {
1273         /* Keys are stored in fields->fields, values are
1274          * integers.
1275          */
1276         g_hash_table_destroy(fields->field_indicies);
1277     }
1278     if(NULL != fields->fields) {
1279         gsize i;
1280         for(i = 0; i < fields->fields->len; ++i) {
1281             gchar* field = g_ptr_array_index(fields->fields,i);
1282             g_free(field);
1283         }
1284         g_ptr_array_free(fields->fields, TRUE);
1285     }
1286
1287     g_free(fields);
1288 }
1289
1290 void output_fields_add(output_fields_t* fields, const gchar* field)
1291 {
1292     gchar* field_copy;
1293
1294     g_assert(fields);
1295     g_assert(field);
1296
1297
1298     if(NULL == fields->fields) {
1299         fields->fields = g_ptr_array_new();
1300     }
1301
1302     field_copy = g_strdup(field);
1303
1304     g_ptr_array_add(fields->fields, field_copy);
1305 }
1306
1307 gboolean output_fields_set_option(output_fields_t* info, gchar* option)
1308 {
1309     const gchar* option_name;
1310     const gchar* option_value;
1311
1312     g_assert(info);
1313     g_assert(option);
1314
1315     if('\0' == *option) {
1316         return FALSE; /* Is this guarded against by option parsing? */
1317     }
1318     option_name = strtok(option,"=");
1319     option_value = option + strlen(option_name) + 1;
1320     if(0 == strcmp(option_name, "header")) {
1321         switch(NULL == option_value ? '\0' : *option_value) {
1322         case 'n':
1323             info->print_header = FALSE;
1324             break;
1325         case 'y':
1326             info->print_header = TRUE;
1327             break;
1328         default:
1329             return FALSE;
1330         }
1331         return TRUE;
1332     }
1333
1334     if(0 == strcmp(option_name,"separator")) {
1335         switch(NULL == option_value ? '\0' : *option_value) {
1336         case '\0':
1337             return FALSE;
1338         case '/':
1339             switch(*++option_value) {
1340             case 't':
1341                 info->separator = '\t';
1342                 break;
1343             case 's':
1344                 info->separator = ' ';
1345                 break;
1346             default:
1347                 info->separator = '\\';
1348             }
1349             break;
1350         default:
1351             info->separator = *option_value;
1352             break;
1353         }
1354         return TRUE;
1355     }
1356
1357     if(0 == strcmp(option_name, "quote")) {
1358         switch(NULL == option_value ? '\0' : *option_value) {
1359         default: /* Fall through */
1360         case '\0':
1361             info->quote='\0';
1362             return FALSE;
1363         case 'd':
1364             info->quote='"';
1365             break;
1366         case 's':
1367             info->quote='\'';
1368             break;
1369         case 'n':
1370             info->quote='\0';
1371             break;
1372         }
1373         return TRUE;
1374     }
1375
1376     return FALSE;
1377 }
1378
1379 void output_fields_list_options(FILE *fh)
1380 {
1381     fprintf(fh, "TShark: The available options for field output \"E\" are:\n");
1382     fputs("header=y|n   Print field abbreviations as first line of output (def: N: no)\n", fh);
1383     fputs("separator=/t|/s|<character>   Set the separator to use; \"/t\" = tab,\n \"/s\" = space (def: /t: tab)\n", fh);
1384     fputs("quote=d|s|n   Print either d: double-quotes, s: single quotes or n: no quotes around field values (def: n: none)\n", fh);
1385 }
1386
1387
1388 void write_fields_preamble(output_fields_t* fields, FILE *fh)
1389 {
1390     gsize i;
1391
1392     g_assert(fields);
1393     g_assert(fh);
1394
1395     if(!fields->print_header) {
1396         return;
1397     }
1398
1399     for(i = 0; i < fields->fields->len; ++i) {
1400         const gchar* field = g_ptr_array_index(fields->fields,i);
1401         if(i != 0 ) {
1402             fputc(fields->separator, fh);
1403         }
1404         fputs(field, fh);
1405     }
1406     fputc('\n', fh);
1407 }
1408
1409 static void proto_tree_get_node_field_values(proto_node *node, gpointer data)
1410 {
1411     write_field_data_t *call_data;
1412     field_info *fi;
1413     gpointer field_index;
1414
1415     call_data = data;
1416     fi = PNODE_FINFO(node);
1417
1418     g_assert(fi && "dissection with an invisible proto tree?");
1419
1420     field_index = g_hash_table_lookup(call_data->fields->field_indicies, fi->hfinfo->abbrev);
1421     if(NULL != field_index) {
1422         const gchar* value;
1423
1424         value = get_node_field_value(fi, call_data->edt); /* ep_alloced string */
1425
1426         if(NULL != value && '\0' != *value) {
1427             guint actual_index;
1428             actual_index = GPOINTER_TO_UINT(field_index);
1429             /* Unwrap change made to disambiguiate zero / null */
1430             call_data->fields->field_values[actual_index - 1] = value;
1431         }
1432     }
1433
1434     /* Recurse here. */
1435     if (node->first_child != NULL) {
1436         proto_tree_children_foreach(node, proto_tree_get_node_field_values,
1437                                     call_data);
1438     }
1439 }
1440
1441 void proto_tree_write_fields(output_fields_t* fields, epan_dissect_t *edt, FILE *fh)
1442 {
1443     gsize i;
1444
1445     write_field_data_t data;
1446
1447     g_assert(fields);
1448     g_assert(edt);
1449     g_assert(fh);
1450
1451     data.fields = fields;
1452     data.edt = edt;
1453
1454     if(NULL == fields->field_indicies) {
1455         /* Prepare a lookup table from string abbreviation for field to its index. */
1456         fields->field_indicies = g_hash_table_new(g_str_hash, g_str_equal);
1457
1458         i = 0;
1459         while( i < fields->fields->len) {
1460             gchar* field = g_ptr_array_index(fields->fields, i);
1461              /* Store field indicies +1 so that zero is not a valid value,
1462               * and can be distinguished from NULL as a pointer.
1463               */
1464             ++i;
1465             g_hash_table_insert(fields->field_indicies, field, GUINT_TO_POINTER(i));
1466         }
1467     }
1468
1469     /* Buffer to store values for this packet */
1470     fields->field_values = ep_alloc_array0(const gchar*, fields->fields->len);
1471
1472     proto_tree_children_foreach(edt->tree, proto_tree_get_node_field_values,
1473                                 &data);
1474
1475     for(i = 0; i < fields->fields->len; ++i) {
1476         if(0 != i) {
1477             fputc(fields->separator, fh);
1478         }
1479         if(NULL != fields->field_values[i]) {
1480             if(fields->quote != '\0') {
1481                 fputc(fields->quote, fh);
1482             }
1483             fputs(fields->field_values[i], fh);
1484             if(fields->quote != '\0') {
1485                 fputc(fields->quote, fh);
1486             }
1487         }
1488     }
1489 }
1490
1491 void write_fields_finale(output_fields_t* fields _U_ , FILE *fh _U_)
1492 {
1493     /* Nothing to do */
1494 }
1495
1496 /* Returns an ep_alloced string or a static constant*/
1497 const gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt)
1498 {
1499     if (fi->hfinfo->id == hf_text_only) {
1500         /* Text label.
1501          * Get the text */
1502         if (fi->rep) {
1503             return fi->rep->representation;
1504         }
1505         else {
1506             return get_field_hex_value(edt->pi.data_src, fi);
1507         }
1508     }
1509     else if (fi->hfinfo->id == proto_data) {
1510         /* Uninterpreted data, i.e., the "Data" protocol, is
1511          * printed as a field instead of a protocol. */
1512         return get_field_hex_value(edt->pi.data_src, fi);
1513     }
1514     else {
1515         /* Normal protocols and fields */
1516         gchar      *dfilter_string;
1517         size_t      chop_len;
1518
1519         switch (fi->hfinfo->type)
1520         {
1521         case FT_PROTOCOL:
1522             /* Print out the full details for the protocol. */
1523             if (fi->rep) {
1524                 return fi->rep->representation;
1525             } else {
1526                 /* Just print out the protocol abbreviation */
1527                 return fi->hfinfo->abbrev;;
1528             }
1529         case FT_NONE:
1530             /* Return "1" so that the presence of a field of type
1531              * FT_NONE can be checked when using -T fields */
1532             return "1";
1533         default:
1534             /* XXX - this is a hack until we can just call
1535              * fvalue_to_string_repr() for *all* FT_* types. */
1536             dfilter_string = proto_construct_match_selected_string(fi,
1537                 edt);
1538             if (dfilter_string != NULL) {
1539                 chop_len = strlen(fi->hfinfo->abbrev) + 4; /* for " == " */
1540
1541                 /* XXX - Remove double-quotes. Again, once we
1542                  * can call fvalue_to_string_repr(), we can
1543                  * ask it not to produce the version for
1544                  * display-filters, and thus, no
1545                  * double-quotes. */
1546                 if (dfilter_string[strlen(dfilter_string)-1] == '"') {
1547                     dfilter_string[strlen(dfilter_string)-1] = '\0';
1548                     chop_len++;
1549                 }
1550
1551                 return &(dfilter_string[chop_len]);
1552             } else {
1553                 return get_field_hex_value(edt->pi.data_src, fi);
1554             }
1555         }
1556     }
1557 }
1558
1559 static const gchar*
1560 get_field_hex_value(GSList* src_list, field_info *fi)
1561 {
1562     const guint8 *pd;
1563
1564     if (!fi->ds_tvb)
1565         return NULL;
1566
1567     if (fi->length > tvb_length_remaining(fi->ds_tvb, fi->start)) {
1568         return "field length invalid!";
1569     }
1570
1571     /* Find the data for this field. */
1572     pd = get_field_data(src_list, fi);
1573
1574     if (pd) {
1575         int i;
1576         gchar* buffer;
1577         gchar* p;
1578         int len;
1579         const int chars_per_byte = 2;
1580
1581         len = chars_per_byte * fi->length;
1582         buffer = ep_alloc_array(gchar, len + 1);
1583         buffer[len] = '\0'; /* Ensure NULL termination in bad cases */
1584         p = buffer;
1585         /* Print a simple hex dump */
1586         for (i = 0 ; i < fi->length; i++) {
1587             g_snprintf(p, chars_per_byte+1, "%02x", pd[i]);
1588             p += chars_per_byte;
1589         }
1590         return buffer;
1591     } else {
1592         return NULL;
1593     }
1594 }