epan/column-utils.h

   1 /* column-utils.h
   2  * Definitions for column utility 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_UTILS_H__
  26 #define __COLUMN_UTILS_H__
  27
  28 #include <glib.h>
  29
  30 #include "column_info.h"
  31 #include "packet_info.h"
  32 #include <epan/epan.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif /* __cplusplus */
  37
  38 /** @file
  39  *  Helper routines for column utility structures and routines.
  40  */
  41
  42 /** Allocate all the data structures for constructing column data, given
  43  * the number of columns.
  44  *
  45  * Internal, don't use this in dissectors!
  46  */
  47 extern void     col_setup(column_info *cinfo, const gint num_cols);
  48
  49 /** Initialize the data structures for constructing column data.
  50  *
  51  * Internal, don't use this in dissectors!
  52  */
  53 extern void     col_init(column_info *cinfo);
  54
  55 /** Fill in all columns of the given packet which are based on values from frame_data.
  56  *
  57  * Internal, don't use this in dissectors!
  58  */
  59 extern void col_fill_in_frame_data(const frame_data *fd, column_info *cinfo, const gint col, gboolean const fill_col_exprs);
  60
  61 /** Fill in all columns of the given packet.
  62  *
  63  * Internal, don't use this in dissectors!
  64  */
  65 extern void     col_fill_in(packet_info *pinfo, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
  66
  67 /** Fill in columns if we got an error reading the packet.
  68  * We set most columns to "???", and set the Info column to an error
  69  * message.
  70  *
  71  * Internal, don't use this in dissectors!
  72  */
  73 extern void     col_fill_in_error(column_info *cinfo, frame_data *fdata, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
  74
  75 /* Utility routines used by packet*.c */
  76
  77 /** Are the columns writable?
  78  *
  79  * @param cinfo the current packet row
  80  * @return TRUE if it's writable, FALSE if not
  81  */
  82 extern gboolean col_get_writable(column_info *cinfo);
  83
  84 /** Set the columns writable.
  85  *
  86  * @param cinfo the current packet row
  87  * @param writable TRUE if it's writable, FALSE if not
  88  */
  89 extern void     col_set_writable(column_info *cinfo, const gboolean writable);
  90
  91 /**
  92  * Checks if the given column can be filled with data.
  93  *
  94  * @param cinfo the current packet row
  95  * @param col the column to use, e.g. COL_INFO
  96  *
  97  * @deprecated Not needed in new code the check is done in
  98  * in the column function calls.
  99  */
 100 extern gint     check_col(column_info *cinfo, const gint col);
 101
 102 /** Sets a fence for the current column content,
 103  * so this content won't be affected by further col_... function calls.
 104  *
 105  * This can be useful if a protocol is more than once in a single packet,
 106  * e.g. multiple HTTP calls in a single TCP packet.
 107  *
 108  * @param cinfo the current packet row
 109  * @param col the column to use, e.g. COL_INFO
 110  */
 111 extern void     col_set_fence(column_info *cinfo, const gint col);
 112
 113 /** Clears the text of a column element.
 114  *
 115  * @param cinfo the current packet row
 116  * @param col the column to use, e.g. COL_INFO
 117  */
 118 extern void     col_clear(column_info *cinfo, const gint col);
 119
 120 /** Set (replace) the text of a column element, the text won't be copied.
 121  *
 122  * Usually used to set const strings!
 123  *
 124  * @param cinfo the current packet row
 125  * @param col the column to use, e.g. COL_INFO
 126  * @param str the string to set
 127  */
 128 extern void     col_set_str(column_info *cinfo, const gint col, const gchar * str);
 129
 130 /** Add (replace) the text of a column element, the text will be copied.
 131  *
 132  * @param cinfo the current packet row
 133  * @param col the column to use, e.g. COL_INFO
 134  * @param str the string to add
 135  */
 136 extern void     col_add_str(column_info *cinfo, const gint col, const gchar *str);
 137
 138 /** Add (replace) the text of a column element, the text will be formatted and copied.
 139  *
 140  * Same function as col_add_str() but using a printf-like format string.
 141  *
 142  * @param cinfo the current packet row
 143  * @param col the column to use, e.g. COL_INFO
 144  * @param format the format string
 145  * @param ... the variable number of parameters
 146  */
 147 extern void     col_add_fstr(column_info *cinfo, const gint col, const gchar *format, ...)
 148     G_GNUC_PRINTF(3, 4);
 149
 150 /** For internal Wireshark use only.  Not to be called from dissectors. */
 151 void col_custom_set_edt(epan_dissect_t *edt, column_info *cinfo);
 152
 153 /** For internal Wireshark use only.  Not to be called from dissectors. */
 154 void col_custom_prime_edt(epan_dissect_t *edt, column_info *cinfo);
 155
 156 /** For internal Wireshark use only.  Not to be called from dissectors. */
 157 gboolean have_custom_cols(column_info *cinfo);
 158 /** For internal Wireshark use only.  Not to be called from dissectors. */
 159 gboolean col_has_time_fmt(column_info *cinfo, const gint col);
 160 /** For internal Wireshark use only.  Not to be called from dissectors. */
 161 gboolean col_based_on_frame_data(column_info *cinfo, const gint col);
 162
 163 /** Append the given text to a column element, the text will be copied.
 164  *
 165  * @param cinfo the current packet row
 166  * @param col the column to use, e.g. COL_INFO
 167  * @param str the string to append
 168  */
 169 extern void     col_append_str(column_info *cinfo, const gint col, const gchar *str);
 170
 171 /** Append the given text to a column element, the text will be formatted and copied.
 172  *
 173  * Same function as col_append_str() but using a printf-like format string.
 174  *
 175  * @param cinfo the current packet row
 176  * @param col the column to use, e.g. COL_INFO
 177  * @param format the format string
 178  * @param ... the variable number of parameters
 179  */
 180 extern void     col_append_fstr(column_info *cinfo, const gint col, const gchar *format, ...)
 181     G_GNUC_PRINTF(3, 4);
 182
 183 /** Prepend the given text to a column element, the text will be formatted and copied.
 184  *
 185  * @param cinfo the current packet row
 186  * @param col the column to use, e.g. COL_INFO
 187  * @param format the format string
 188  * @param ... the variable number of parameters
 189  */
 190 extern void     col_prepend_fstr(column_info *cinfo, const gint col, const gchar *format, ...)
 191     G_GNUC_PRINTF(3, 4);
 192
 193 /**Prepend the given text to a column element, the text will be formatted and copied.
 194  * This function is similar to col_prepend_fstr() but this function will
 195  * unconditionally set a fence to the end of the prepended data even if there
 196  * were no fence before.
 197  * The col_prepend_fstr() will only prepend the data before the fence IF
 198  * there is already a fence created. This function will create a fence in case
 199  * it does not yet exist.
 200  */
 201 extern void     col_prepend_fence_fstr(column_info *cinfo, const gint col, const gchar *format, ...)
 202     G_GNUC_PRINTF(3, 4);
 203
 204 /** Append the given text (prepended by a separator) to a column element.
 205  *
 206  * Much like col_append_str() but will prepend the given separator if the column isn't empty.
 207  *
 208  * @param cinfo the current packet row
 209  * @param col the column to use, e.g. COL_INFO
 210  * @param sep the separator string or NULL for default: ", "
 211  * @param str the string to append
 212  */
 213 extern void     col_append_sep_str(column_info *cinfo, const gint col, const gchar *sep,
 214                 const gchar *str);
 215
 216 /** Append the given text (prepended by a separator) to a column element.
 217  *
 218  * Much like col_append_fstr() but will prepend the given separator if the column isn't empty.
 219  *
 220  * @param cinfo the current packet row
 221  * @param col the column to use, e.g. COL_INFO
 222  * @param sep the separator string or NULL for default: ", "
 223  * @param format the format string
 224  * @param ... the variable number of parameters
 225  */
 226 extern void     col_append_sep_fstr(column_info *cinfo, const gint col, const gchar *sep,
 227                 const gchar *format, ...)
 228     G_GNUC_PRINTF(4, 5);
 229
 230 /** Set the given (relative) time to a column element.
 231  *
 232  * Used by multiple dissectors to set the time in the column
 233  * COL_DELTA_CONV_TIME
 234  *
 235  * @param cinfo         the current packet row
 236  * @param col           the column to use, e.g. COL_INFO
 237  * @param ts            the time to set in the column
 238  * @param fieldname     the fieldname to use for creating a filter (when
 239  *                        applying/preparing/copying as filter)
 240  */
 241 extern void     col_set_time(column_info *cinfo, const int col,
 242                         const nstime_t *ts, char *fieldname);
 243
 244 extern void set_fd_time(frame_data *fd, gchar *buf);
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif /* __cplusplus */
 249
 250 #endif /* __COLUMN_UTILS_H__ */