2 * implementor's API for stats_tree
3 * 2005, Luis E. G. Ontanon
7 * Ethereal - Network traffic analyzer
8 * By Gerald Combs <gerald@ethereal.com>
9 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #ifndef __STATS_TREE_PRIV_H
27 #define __STATS_TREE_PRIV_H
29 #include "stats_tree.h"
32 #define NUM_BUF_SIZE 32
34 /* implementations should define this to contain its own node related data
35 * as well as some operations on it */
36 typedef struct _st_node_pres st_node_pres;
38 /* implementations should define this to contain its own dynamic tree related data
39 * as well as some operations on it */
40 typedef struct _tree_pres tree_pres;
42 /* implementations should define this to contain its own static tree related data
43 * as well as some operations on it */
44 typedef struct _tree_cfg_pres tree_cfg_pres;
47 typedef struct _stat_node stat_node;
48 typedef struct _stats_tree_cfg stats_tree_cfg;
50 typedef struct _range_pair {
59 /* the counter it keeps */
62 /* children nodes by name */
65 /* the owner of this node */
73 /* used to check if value is within range */
76 /* node presentation data */
81 /* the "class" from which it's derived */
90 /* used to lookup named parents:
91 * key: parent node name
96 /* used for quicker lookups of parent nodes */
100 * tree representation
101 * to be defined (if needed) by the implementations
105 /* every tree in nature has one */
109 struct _stats_tree_cfg {
116 /* dissector defined callbacks */
117 stat_tree_packet_cb packet;
118 stat_tree_init_cb init;
119 stat_tree_cleanup_cb cleanup;
122 * node presentation callbacks
125 /* last to be called at node creation */
126 void (*setup_node_pr)(stat_node*);
128 /* last to be called at node destruction */
129 void (*free_node_pr)(stat_node*);
131 /* to be called for every node in the tree */
132 void (*draw_node)(stat_node*);
133 void (*reset_node)(stat_node*);
136 * tree presentation callbacks
141 tree_pres* (*new_tree_pr)(stats_tree*);
142 void (*free_tree_pr)(stats_tree*);
143 void (*draw_tree)(stats_tree*);
144 void (*reset_tree)(stats_tree*);
147 /* guess what, this is it! */
148 extern void stats_tree_presentation(void (*registry_iterator)(gpointer,gpointer,gpointer),
149 void (*setup_node_pr)(stat_node*),
150 void (*free_node_pr)(stat_node*),
151 void (*draw_node)(stat_node*),
152 void (*reset_node)(stat_node*),
153 tree_pres* (*new_tree_pr)(stats_tree*),
154 void (*free_tree_pr)(stats_tree*),
155 void (*draw_tree)(stats_tree*),
156 void (*reset_tree)(stats_tree*),
159 extern stats_tree* stats_tree_new(stats_tree_cfg* cfg, tree_pres* pr, char* filter);
161 /* callback for taps */
162 extern int stats_tree_packet(void*, packet_info*, epan_dissect_t*, const void *);
164 /* callback for reset */
165 extern void stats_tree_reset(void* p_st);
167 /* callback for clear */
168 extern void stats_tree_reinit(void* p_st);
170 /* callback for destoy */
171 extern void stats_tree_free(stats_tree* st);
173 /* given an optarg splits the abbr part
174 and returns a newly allocated buffer containing it */
175 extern guint8* stats_tree_get_abbr(const guint8* optarg);
177 /* obtains a stats tree from the registry given its abbr */
178 extern stats_tree_cfg* stats_tree_get_cfg_by_abbr(guint8* abbr);
180 /* extracts node data as strings from a stat_node into
181 the buffers given by value, rate and precent
182 if NULL they are ignored */
183 extern void stats_tree_get_strs_from_node(const stat_node* node,
188 /* populates the given GString with a tree representation of a branch given by node,
189 using indent spaces as indentation */
190 extern void stats_tree_branch_to_str(const stat_node* node,
194 /* used to calcuate the size of the indentation and the longest string */
195 extern guint stats_tree_branch_max_namelen(const stat_node* node, guint indent);
197 /* a text representation of a node,
198 if buffer is NULL returns a newly allocated string */
199 extern guint8* stats_tree_node_to_str(const stat_node* node,
200 guint8* buffer, guint len);
202 #endif /* __STATS_TREE_PRIV_H */