Convert most other plugin dissectors to use the make-dissector-reg

scripts.

svn path=/trunk/; revision=17961

4 files changed, 157 insertions, 41 deletions

diff --git a/plugins/rlm/Makefile.am b/plugins/rlm/Makefile.am
index 87eb3e8e2f..2ef1e642e1 100644
--- a/plugins/rlm/Makefile.am
+++ b/plugins/rlm/Makefile.am
@@ -1,5 +1,5 @@
 # Makefile.am
-# Automake file for Cisco SS7 Redundant Link Management dissector
+# Automake file for Cisco SS7 Redundant Link Management plugin
 # Copyright 2004, Duncan Sargeant <dunc-ethereal@rcpt.to>
 #
 # $Id$
@@ -23,12 +23,18 @@
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #
 
-INCLUDES = -I$(top_srcdir)
+INCLUDES = -I$(top_srcdir) -I$(includedir)
+
+include Makefile.common
 
 plugindir = @plugindir@
 
 plugin_LTLIBRARIES = rlm.la
-rlm_la_SOURCES = packet-rlm.c moduleinfo.h
+rlm_la_SOURCES = \
+	plugin.c \
+	moduleinfo.h \
+	$(DISSECTOR_SRC) \
+	$(DISSECTOR_INCLUDES)
 rlm_la_LDFLAGS = -module -avoid-version
 rlm_la_LIBADD = @PLUGIN_LIBS@
 
@@ -37,6 +43,69 @@ rlm_la_LIBADD = @PLUGIN_LIBS@
 # add them here.
 LIBS =
 
+#
+# Build plugin.c, which contains the plugin version[] string, a
+# function plugin_register() that calls the register routines for all
+# protocols, and a function plugin_reg_handoff() that calls the handoff
+# registration routines for all protocols.
+#
+# We do this by scanning sources.  If that turns out to be too slow,
+# maybe we could just require every .o file to have an register routine
+# of a given name (packet-aarp.o -> proto_register_aarp, etc.).
+#
+# Formatting conventions:  The name of the proto_register_* routines an
+# proto_reg_handoff_* routines must start in column zero, or must be
+# preceded only by "void " starting in column zero, and must not be
+# inside #if.
+#
+# DISSECTOR_SRC is assumed to have all the files that need to be scanned.
+#
+# For some unknown reason, having a big "for" loop in the Makefile
+# to scan all the files doesn't work with some "make"s; they seem to
+# pass only the first few names in the list to the shell, for some
+# reason.
+#
+# Therefore, we have a script to generate the plugin.c file.
+# The shell script runs slowly, as multiple greps and seds are run
+# for each input file; this is especially slow on Windows.  Therefore,
+# if Python is present (as indicated by PYTHON being defined), we run
+# a faster Python script to do that work instead.
+#
+# The first argument is the directory in which the source files live.
+# The second argument is "plugin", to indicate that we should build
+# a plugin.c file for a plugin.
+# All subsequent arguments are the files to scan.
+#
+plugin.c: $(DISSECTOR_SRC) $(top_srcdir)/tools/make-dissector-reg \
+    $(top_srcdir)/tools/make-dissector-reg.py
+	@if test -n $(PYTHON); then \
+		echo Making plugin.c with python ; \
+		$(PYTHON) $(top_srcdir)/tools/make-dissector-reg.py $(srcdir) \
+		    plugin $(DISSECTOR_SRC) ; \
+	else \
+		echo Making plugin.c with shell script ; \
+		$(top_srcdir)/tools/make-dissector-reg $(srcdir) \
+		    $(plugin_src) plugin $(DISSECTOR_SRC) ; \
+	fi
+
+#
+# Currently plugin.c can be included in the distribution because
+# we always build all protocol dissectors. We used to have to check
+# whether or not to build the snmp dissector. If we again need to
+# variably build something, making plugin.c non-portable, uncomment
+# the dist-hook line below.
+#
+# Oh, yuk.  We don't want to include "plugin.c" in the distribution, as
+# its contents depend on the configuration, and therefore we want it
+# to be built when the first "make" is done; however, Automake insists
+# on putting *all* source into the distribution.
+#
+# We work around this by having a "dist-hook" rule that deletes
+# "plugin.c", so that "dist" won't pick it up.
+#
+#dist-hook:
+#	@rm -f $(distdir)/plugin.c
+
 CLEANFILES = \
 	rlm \
 	*~
@@ -45,4 +114,5 @@ MAINTAINERCLEANFILES = \
 	Makefile.in
 
 EXTRA_DIST = \
+	Makefile.common		\
 	Makefile.nmake
diff --git a/plugins/rlm/Makefile.common b/plugins/rlm/Makefile.common
new file mode 100644
index 0000000000..d1a26db3b9
--- /dev/null
+++ b/plugins/rlm/Makefile.common
@@ -0,0 +1,31 @@
+# Makefile.common for Cisco SS7 Redundant Link Management plugin
+#     Contains the stuff from Makefile.am and Makefile.nmake that is
+#     a) common to both files and
+#     b) portable between both files
+#
+# $Id$
+#
+# Ethereal - Network traffic analyzer
+# By Gerald Combs <gerald@ethereal.com>
+# 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+# the name of the plugin
+PLUGIN_NAME = rlm
+
+# the dissector sources (without any helpers)
+DISSECTOR_SRC = \
+	packet-rlm.c
diff --git a/plugins/rlm/Makefile.nmake b/plugins/rlm/Makefile.nmake
index 11357bc078..daf406dbdb 100644
--- a/plugins/rlm/Makefile.nmake
+++ b/plugins/rlm/Makefile.nmake
@@ -1,3 +1,5 @@
+# Makefile.nmake
+# nmake file for Cisco SS7 Redundant Link Management plugin
 #
 # $Id$
 #
@@ -6,6 +8,8 @@ include ..\..\config.nmake
 
 ############### no need to modify below this line #########
 
+include Makefile.common
+
 CFLAGS=/DHAVE_CONFIG_H /I../.. /I../../wiretap $(GLIB_CFLAGS) \
 	/I$(PCAP_DIR)\include -D_U_="" $(LOCAL_CFLAGS)
 
@@ -15,12 +19,56 @@ LDFLAGS = /NOLOGO /INCREMENTAL:no /MACHINE:I386 $(LOCAL_LDFLAGS)
 LINK_PLUGIN_WITH=..\..\epan\libethereal.lib
 CFLAGS=/DHAVE_WIN32_LIBETHEREAL_LIB /D_NEED_VAR_IMPORT_ $(CFLAGS)
 
-OBJECTS=packet-rlm.obj 
+DISSECTOR_OBJECTS = $(DISSECTOR_SRC:.c=.obj)
+
+OBJECTS=$(DISSECTOR_OBJECTS) plugin.obj
 
-rlm.dll rlm.exp rlm.lib : $(OBJECTS) $(LINK_PLUGIN_WITH)
-	link -dll /out:rlm.dll $(LDFLAGS) $(OBJECTS) $(LINK_PLUGIN_WITH) \
+rlm.dll rlm.exp rlm.lib : $(OBJECTS) $(LINK_PLUGIN_WITH) 
+	link -dll /out:rlm.dll $(LDFLAGS) $(OBJECTS) $(LINK_PLUGIN_WITH)  \
 	$(GLIB_LIBS)
 
+#
+# Build plugin.c, which contains the plugin version[] string, a
+# function plugin_register() that calls the register routines for all
+# protocols, and a function plugin_reg_handoff() that calls the handoff
+# registration routines for all protocols.
+#
+# We do this by scanning sources.  If that turns out to be too slow,
+# maybe we could just require every .o file to have an register routine
+# of a given name (packet-aarp.o -> proto_register_aarp, etc.).
+#
+# Formatting conventions:  The name of the proto_register_* routines an
+# proto_reg_handoff_* routines must start in column zero, or must be
+# preceded only by "void " starting in column zero, and must not be
+# inside #if.
+#
+# DISSECTOR_SRC is assumed to have all the files that need to be scanned.
+#
+# For some unknown reason, having a big "for" loop in the Makefile
+# to scan all the files doesn't work with some "make"s; they seem to
+# pass only the first few names in the list to the shell, for some
+# reason.
+#
+# Therefore, we have a script to generate the plugin.c file.
+# The shell script runs slowly, as multiple greps and seds are run
+# for each input file; this is especially slow on Windows.  Therefore,
+# if Python is present (as indicated by PYTHON being defined), we run
+# a faster Python script to do that work instead.
+#
+# The first argument is the directory in which the source files live.
+# The second argument is "plugin", to indicate that we should build
+# a plugin.c file for a plugin.
+# All subsequent arguments are the files to scan.
+#
+plugin.c: $(DISSECTOR_SRC)
+!IFDEF PYTHON
+	@echo Making plugin.c (using python)
+	@$(PYTHON) ../../tools/make-dissector-reg.py . plugin $(DISSECTOR_SRC)
+!ELSE
+	@echo Making plugin.c (using sh)
+	@$(SH) ../../tools/make-dissector-reg . plugin $(DISSECTOR_SRC)
+!ENDIF
+
 !ENDIF
 
 clean:
diff --git a/plugins/rlm/packet-rlm.c b/plugins/rlm/packet-rlm.c
index 10f5a2d7b6..e813b4c626 100644
--- a/plugins/rlm/packet-rlm.c
+++ b/plugins/rlm/packet-rlm.c
@@ -55,18 +55,9 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include <gmodule.h>
+#include <glib.h>
 #include <epan/packet.h>
 
- /* Define version if we are not building ethereal statically */
-
-#include "moduleinfo.h"
-
-#ifndef ENABLE_STATIC
- G_MODULE_EXPORT const gchar version[] = VERSION;
-#endif
-
-
 /* Initialize the protocol and registered fields */
 static int proto_rlm = -1;
 
@@ -182,7 +173,7 @@ dissect_rlm(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 */
 
 void
-plugin_reg_handoff_rlm(void)
+proto_reg_handoff_rlm(void)
 {
 	heur_dissector_add("udp", dissect_rlm, proto_rlm);
 	heur_dissector_add("udp", dissect_udp_lapd, proto_get_id_by_filter_name("lapd"));
@@ -234,27 +225,3 @@ proto_register_rlm(void)
 	proto_register_field_array(proto_rlm, hf, array_length(hf));
 	proto_register_subtree_array(ett, array_length(ett));
 }
-
-#ifndef ENABLE_STATIC
-
-G_MODULE_EXPORT void
-plugin_register(void)
-{
-  /* register the new protocol, protocol fields, and subtrees */
-  if (proto_rlm == -1) { /* execute protocol initialization only once */
-    proto_register_rlm();
-  }
-}
-
-
-/* If this dissector uses sub-dissector registration add a registration routine.
-   This format is required because a script is used to find these routines and
-   create the code that calls these routines.
-*/
-G_MODULE_EXPORT void
-plugin_reg_handoff(void)
-{
-	plugin_reg_handoff_rlm();
-}
-
-#endif