cfile.h

   1 /* cfile.h
   2  * capture_file definition & GUI-independent manipulation
   3  *
   4  * $Id: cfile.h,v 1.3 2003/08/29 04:03:45 guy Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __CFILE_H__
  26 #define __CFILE_H__
  27
  28 /* Current state of file. */
  29 typedef enum {
  30         FILE_CLOSED,            /* No file open */
  31         FILE_READ_IN_PROGRESS,  /* Reading a file we've opened */
  32         FILE_READ_ABORTED,      /* Read aborted by user */
  33         FILE_READ_DONE          /* Read completed */
  34 } file_state;
  35
  36 /* Character set for text search. */
  37 typedef enum {
  38         SCS_ASCII_AND_UNICODE,
  39         SCS_ASCII,
  40         SCS_UNICODE
  41         /* add EBCDIC when it's implemented */
  42 } search_charset_t;
  43
  44 typedef struct _capture_file {
  45   file_state   state;     /* Current state of capture file */
  46   int          filed;     /* File descriptor of capture file */
  47   gchar       *filename;  /* Name of capture file */
  48   gboolean     is_tempfile; /* Is capture file a temporary file? */
  49   gboolean     user_saved;/* If capture file is temporary, has it been saved by user yet? */
  50   long         f_len;     /* Length of capture file */
  51   guint16      cd_t;      /* File type of capture file */
  52   int          lnk_t;     /* Link-layer type with which to save capture */
  53   guint32      vers;      /* Version.  For tcpdump minor is appended to major */
  54   int          count;     /* Total number of frames */
  55   int          marked_count; /* Number of marked frames */
  56   gboolean     drops_known; /* TRUE if we know how many packets were dropped */
  57   guint32      drops;     /* Dropped packets */
  58   guint32      esec;      /* Elapsed seconds */
  59   guint32      eusec;     /* Elapsed microseconds */
  60   gboolean     has_snap;  /* TRUE if maximum capture packet length is known */
  61   int          snap;      /* Maximum captured packet length */
  62   long         progbar_quantum; /* Number of bytes read per progress bar update */
  63   long         progbar_nextstep; /* Next point at which to update progress bar */
  64   gchar       *iface;     /* Interface */
  65   gchar       *save_file; /* File that user saved capture to */
  66   int          save_file_fd; /* File descriptor for saved file */
  67   wtap        *wth;       /* Wiretap session */
  68   dfilter_t   *rfcode;    /* Compiled read filter program */
  69   gchar       *dfilter;   /* Display filter string */
  70   dfilter_t   *dfcode;    /* Compiled display filter program */
  71 #ifdef HAVE_LIBPCAP
  72   gchar       *cfilter;   /* Capture filter string */
  73 #endif
  74   gchar       *sfilter;   /* Search filter string */
  75   gboolean     sbackward; /* TRUE if search is backward, FALSE if forward */
  76   gboolean     hex;       /* TRUE is raw data search is being performed */
  77   gboolean     ascii;     /* TRUE is text search is being performed */
  78   search_charset_t scs_type; /* Character set for text search */
  79   gboolean     case_type; /* TRUE if case-insensitive text search */
  80   gboolean     decode_data; /* TRUE if searching protocol tree text */
  81   gboolean     summary_data; /* TRUE if searching Info column text */
  82   union wtap_pseudo_header pseudo_header;      /* Packet pseudo_header */
  83   guint8       pd[WTAP_MAX_PACKET_SIZE];  /* Packet data */
  84   GMemChunk   *plist_chunk; /* Memory chunk for frame_data structures */
  85   frame_data  *plist;     /* Packet list */
  86   frame_data  *plist_end; /* Last packet in list */
  87   frame_data  *first_displayed; /* First frame displayed */
  88   frame_data  *last_displayed;  /* Last frame displayed */
  89   column_info  cinfo;    /* Column formatting information */
  90   frame_data  *current_frame;  /* Frame data for current frame */
  91   epan_dissect_t *edt; /* Protocol dissection for currently selected packet */
  92   FILE        *print_fh;  /* File we're printing to */
  93   struct ph_stats_s* pstats; /* accumulated stats (reset on redisplay in GUI)*/
  94 } capture_file;
  95
  96 void init_cap_file(capture_file *);
  97
  98 #endif /* cfile.h */