Sometimes Git can be a real pain.

Change-Id: Ib93575d9977162b468f171038915c1eb8a612660
Reviewed-on: https://code.wireshark.org/review/2831
Reviewed-by: Guy Harris <guy@alum.mit.edu>

1 files changed, 76 insertions, 0 deletions

diff --git a/epan/stat_groups.h b/epan/stat_groups.h
new file mode 100644
index 0000000000..a5a1ec8886
--- /dev/null
+++ b/epan/stat_groups.h
@@ -0,0 +1,76 @@
+/* stat_groups.h
+ * Definitions of groups for statistics
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+#ifndef __STAT_GROUPS_H__
+#define __STAT_GROUPS_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** @file
+ * Add a new menu item for a stat.
+ */
+
+/*
+ * XXX - defines stuff usable regardless of the GUI toolkit.  Right now,
+ * that's only the menu group, which is used by tap_param_dlg.h.
+ *
+ * XXX - stats should be able to register additional menu groups, although
+ * the question then would be "in what order should they appear in the menu?"
+ *
+ * NOTE: the enum below is parsed by epan/wslua/make-init-lua.pl in order
+ * to generate usable values for Lua scripts to use, so they can add to
+ * the menus in the GUI. The perl script's regex is such that the following
+ * prefixes must only appear once in this list:
+ * REGISTER_ANALYZE_GROUP_CONVERSATION
+ * REGISTER_STAT_GROUP_CONVERSATION
+ * REGISTER_STAT_GROUP_RESPONSE
+ * REGISTER_STAT_GROUP_ENDPOINT
+ * In other words, because there is a REGISTER_STAT_GROUP_RESPONSE_TIME, you cannot
+ * add a REGISTER_STAT_GROUP_RESPONSE nor a REGISTER_STAT_GROUP_RESPONSE_FOOBAR
+ * because they use the same "REGISTER_STAT_GROUP_RESPONSE" prefix.
+ * Also, do NOT change the names in the enum - you can add, but not remove.
+ * If you do, legacy scripts will break. (which is why the perl script regex isn't better)
+ */
+
+/** The group this stat should be registered in. */
+typedef enum {
+    REGISTER_ANALYZE_GROUP_UNSORTED,            /* unsorted analyze stuff */
+    REGISTER_ANALYZE_GROUP_CONVERSATION_FILTER, /* conversation filters */
+    REGISTER_STAT_GROUP_UNSORTED,               /* unsorted statistic function */
+    REGISTER_STAT_GROUP_GENERIC,                /* generic statistic function, not specific to a protocol */
+    REGISTER_STAT_GROUP_CONVERSATION_LIST,      /* member of the conversation list */
+    REGISTER_STAT_GROUP_ENDPOINT_LIST,          /* member of the endpoint list */
+    REGISTER_STAT_GROUP_RESPONSE_TIME,          /* member of the service response time list */
+    REGISTER_STAT_GROUP_TELEPHONY,              /* telephony specific */
+    REGISTER_STAT_GROUP_TELEPHONY_GSM,          /* GSM (and UMTS?) */
+    REGISTER_STAT_GROUP_TELEPHONY_LTE,          /* name says it all */
+    REGISTER_STAT_GROUP_TELEPHONY_SCTP,         /* name says it all */
+    REGISTER_TOOLS_GROUP_UNSORTED               /* unsorted tools */
+} register_stat_group_t;
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __STAT_GROUPS_H__ */