epan/column-info.h

   1 /* column-info.h
   2  * Definitions for column structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __COLUMN_INFO_H__
  26 #define __COLUMN_INFO_H__
  27
  28 #include <glib.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 /** @file
  35  * Column info.
  36  */
  37
  38 #define COL_MAX_LEN 256
  39 #define COL_MAX_INFO_LEN 4096
  40
  41 /** Column expression */
  42 typedef struct {
  43   const gchar **col_expr;     /**< Filter expression */
  44   gchar      **col_expr_val;  /**< Value for filter expression */
  45 } col_expr_t;
  46
  47 /** Column info */
  48 typedef struct _column_info {
  49   const struct epan_session *epan;
  50   gint                num_cols;             /**< Number of columns */
  51   gint               *col_fmt;              /**< Format of column */
  52   gboolean          **fmt_matx;             /**< Specifies which formats apply to a column */
  53   gint               *col_first;            /**< First column number with a given format */
  54   gint               *col_last;             /**< Last column number with a given format */
  55   gchar             **col_title;            /**< Column titles */
  56   gchar             **col_custom_field;     /**< Custom column field */
  57   gint               *col_custom_occurrence;/**< Custom column field occurrence */
  58   gint               *col_custom_field_id;  /**< Custom column field id */
  59   struct _dfilter_t **col_custom_dfilter;   /**< Compiled custom column field */
  60   const gchar       **col_data;             /**< Column data */
  61   gchar             **col_buf;              /**< Buffer into which to copy data for column */
  62   int                *col_fence;            /**< Stuff in column buffer before this index is immutable */
  63   col_expr_t          col_expr;             /**< Column expressions and values */
  64   gboolean            writable;             /**< writable or not @todo Are we still writing to the columns? */
  65 } column_info;
  66
  67 /**
  68  * All of the possible columns in summary listing.
  69  *
  70  * NOTE1: The entries MUST remain in this order, or else you need to reorder
  71  *        the slist[] and dlist[] arrays in column.c to match!
  72  *
  73  * NOTE2: Please add the COL_XYZ entry in the appropriate spot, such that the
  74  *        dlist[] array remains in alphabetical order!
  75  */
  76 enum {
  77   COL_8021Q_VLAN_ID,  /**< 0) 802.1Q vlan ID */
  78   COL_ABS_YMD_TIME,   /**< 1) Absolute date, as YYYY-MM-DD, and time */
  79   COL_ABS_YDOY_TIME,  /**< 2) Absolute date, as YYYY/DOY, and time */
  80   COL_ABS_TIME,       /**< 3) Absolute time */
  81   COL_CIRCUIT_ID,     /**< 4) Circuit ID */
  82   COL_DSTIDX,         /**< 5) !! DEPRECATED !! - Dst port idx - Cisco MDS-specific */
  83   COL_SRCIDX,         /**< 6) !! DEPRECATED !! - Src port idx - Cisco MDS-specific */
  84   COL_VSAN,           /**< 7) VSAN - Cisco MDS-specific */
  85   COL_CUMULATIVE_BYTES, /**< 8) Cumulative number of bytes */
  86   COL_CUSTOM,         /**< 9) Custom column (any filter name's contents) */
  87   COL_DCE_CALL,       /**< 10) DCE/RPC connection oriented call id OR datagram sequence number */
  88   COL_DCE_CTX,        /**< 11) !! DEPRECATED !! - DCE/RPC connection oriented context id */
  89   COL_DELTA_TIME,     /**< 12) Delta time */
  90   COL_DELTA_CONV_TIME,/**< 13) Delta time to last frame in conversation */
  91   COL_DELTA_TIME_DIS, /**< 14) Delta time displayed*/
  92   COL_RES_DST,        /**< 15) Resolved dest */
  93   COL_UNRES_DST,      /**< 16) Unresolved dest */
  94   COL_RES_DST_PORT,   /**< 17) Resolved dest port */
  95   COL_UNRES_DST_PORT, /**< 18) Unresolved dest port */
  96   COL_DEF_DST,        /**< 19) Destination address */
  97   COL_DEF_DST_PORT,   /**< 20) Destination port */
  98   COL_EXPERT,         /**< 21) Expert Info */
  99   COL_IF_DIR,         /**< 22) FW-1 monitor interface/direction */
 100   COL_OXID,           /**< 23) !! DEPRECATED !! - Fibre Channel OXID */
 101   COL_RXID,           /**< 24) !! DEPRECATED !! - Fibre Channel RXID */
 102   COL_FR_DLCI,        /**< 25) !! DEPRECATED !! - Frame Relay DLCI */
 103   COL_FREQ_CHAN,      /**< 26) IEEE 802.11 (and WiMax?) - Channel */
 104   COL_BSSGP_TLLI,     /**< 27) !! DEPRECATED !! - GPRS BSSGP IE TLLI */
 105   COL_HPUX_DEVID,     /**< 28) !! DEPRECATED !! - HP-UX Nettl Device ID */
 106   COL_HPUX_SUBSYS,    /**< 29) !! DEPRECATED !! - HP-UX Nettl Subsystem */
 107   COL_DEF_DL_DST,     /**< 30) Data link layer dest address */
 108   COL_DEF_DL_SRC,     /**< 31) Data link layer source address */
 109   COL_RES_DL_DST,     /**< 32) Resolved DL dest */
 110   COL_UNRES_DL_DST,   /**< 33) Unresolved DL dest */
 111   COL_RES_DL_SRC,     /**< 34) Resolved DL source */
 112   COL_UNRES_DL_SRC,   /**< 35) Unresolved DL source */
 113   COL_RSSI,           /**< 36) IEEE 802.11 - received signal strength */
 114   COL_TX_RATE,        /**< 37) IEEE 802.11 - TX rate in Mbps */
 115   COL_DSCP_VALUE,     /**< 38) IP DSCP Value */
 116   COL_INFO,           /**< 39) Description */
 117   COL_COS_VALUE,      /**< 40) !! DEPRECATED !! - L2 COS Value */
 118   COL_RES_NET_DST,    /**< 41) Resolved net dest */
 119   COL_UNRES_NET_DST,  /**< 42) Unresolved net dest */
 120   COL_RES_NET_SRC,    /**< 43) Resolved net source */
 121   COL_UNRES_NET_SRC,  /**< 44) Unresolved net source */
 122   COL_DEF_NET_DST,    /**< 45) Network layer dest address */
 123   COL_DEF_NET_SRC,    /**< 46) Network layer source address */
 124   COL_NUMBER,         /**< 47) Packet list item number */
 125   COL_PACKET_LENGTH,  /**< 48) Packet length in bytes */
 126   COL_PROTOCOL,       /**< 49) Protocol */
 127   COL_REL_TIME,       /**< 50) Relative time */
 128   COL_REL_CONV_TIME,  /**< 51) !! DEPRECATED !! - Relative time to beginning of conversation */
 129   COL_DEF_SRC,        /**< 52) Source address */
 130   COL_DEF_SRC_PORT,   /**< 53) Source port */
 131   COL_RES_SRC,        /**< 54) Resolved source */
 132   COL_UNRES_SRC,      /**< 55) Unresolved source */
 133   COL_RES_SRC_PORT,   /**< 56) Resolved source port */
 134   COL_UNRES_SRC_PORT, /**< 57) Unresolved source port */
 135   COL_TEI,            /**< 58) Q.921 TEI */
 136   COL_UTC_YMD_TIME,   /**< 59) UTC date, as YYYY-MM-DD, and time */
 137   COL_UTC_YDOY_TIME,  /**< 60) UTC date, as YYYY/DOY, and time */
 138   COL_UTC_TIME,       /**< 61) UTC time */
 139   COL_CLS_TIME,       /**< 62) Command line-specified time (default relative) */
 140   NUM_COL_FMTS        /**< 63) Should always be last */
 141 };
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif /* __cplusplus */
 146
 147 #endif /* __COLUMN_INFO_H__ */