autotools: Rework the plugin Makefiles

The plugin.c generation in an autotools build comes in from an included
Makefile.am file. The various types of plugins need different parameters
for the generation script. Put the plugin.c production rule is a seperate
include file so each plugin type build can include its own variant.

Also amend the README.plugins file with regards to the new directory
structure and the fact that there are multiple types of plugins, not just
dissector plugins.

Change-Id: I3a815d0d767baa555356cf428861b18697401355
Signed-off-by: Jaap Keuter <jaap.keuter@xs4all.nl>
Reviewed-on: https://code.wireshark.org/review/25398
Tested-by: Petri Dish Buildbot
Reviewed-by: João Valverde <j@v6e.pt>
Reviewed-by: Michael Mann <mmann78@netscape.net>

18 files changed, 141 insertions, 47 deletions

diff --git a/plugins/Makefile.am.inc b/plugins/Makefile.am.inc
index 5a0326223a..3a560ee2c6 100644
--- a/plugins/Makefile.am.inc
+++ b/plugins/Makefile.am.inc
@@ -152,39 +152,6 @@ CPP_FILES = \
 	$(LEMON_GENERATED_CPP_FILES) \
 	$(NONGENERATED_CPP_FILES)
 
-#
-# 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.
-#
-# REGISTER_SRC_FILES 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 use a script to generate the register.c file.
-# 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: $(REGISTER_SRC_FILES) $(top_srcdir)/tools/make-plugin-reg.py
-	@echo Making plugin.c
-	@$(PYTHON) $(top_srcdir)/tools/make-plugin-reg.py $(srcdir) \
-		plugin $(REGISTER_SRC_FILES)
-
 checkapi:
 	$(PERL) $(top_srcdir)/tools/checkAPIs.pl -g abort -g termoutput -build \
 	-sourcedir=$(srcdir) \
diff --git a/plugins/codecs/Makefile.am.inc b/plugins/codecs/Makefile.am.inc
new file mode 100644
index 0000000000..14ac941b08
--- /dev/null
+++ b/plugins/codecs/Makefile.am.inc
@@ -0,0 +1,42 @@
+# Makefile.am.inc
+# Include file with common automake definitions for codec plugins
+#
+# Wireshark - Network traffic analyzer
+# By Gerald Combs <gerald@wireshark.org>
+# Copyright 1998 Gerald Combs
+#
+# SPDX-License-Identifier: GPL-2.0+
+#
+
+include $(top_srcdir)/plugins/Makefile.am.inc
+
+#
+# Build plugin.c, which contains the plugin_version[] and plugin_release[]
+# string, and a function plugin_register() that calls the register routines
+# for all codecs.
+#
+# 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 codec_register_* routines must
+# start in column zero, or must be preceded only by "void " starting in
+# column zero, and must not be inside #if.
+#
+# REGISTER_SRC_FILES 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 use a script to generate the register.c file.
+# The first argument is the directory in which the source files live.
+# The second argument is "plugin_codec", to indicate that we should build
+# a plugin.c file for a codec plugin.
+# All subsequent arguments are the files to scan.
+#
+plugin.c: $(REGISTER_SRC_FILES) $(top_srcdir)/tools/make-plugin-reg.py
+	@echo Making plugin.c
+	@$(PYTHON) $(top_srcdir)/tools/make-plugin-reg.py $(srcdir) \
+		plugin_codec $(REGISTER_SRC_FILES)
diff --git a/plugins/epan/Makefile.am.inc b/plugins/epan/Makefile.am.inc
new file mode 100644
index 0000000000..5c7f5256ec
--- /dev/null
+++ b/plugins/epan/Makefile.am.inc
@@ -0,0 +1,43 @@
+# Makefile.am.inc
+# Include file with common automake definitions for dissector plugins
+#
+# Wireshark - Network traffic analyzer
+# By Gerald Combs <gerald@wireshark.org>
+# Copyright 1998 Gerald Combs
+#
+# SPDX-License-Identifier: GPL-2.0+
+#
+
+include $(top_srcdir)/plugins/Makefile.am.inc
+
+#
+# Build plugin.c, which contains the plugin_version[] and plugin_release[]
+# string, and a function plugin_register() that calls the register 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 and
+# 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.
+#
+# REGISTER_SRC_FILES 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 use a script to generate the register.c file.
+# 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 dissector plugin.
+# All subsequent arguments are the files to scan.
+#
+plugin.c: $(REGISTER_SRC_FILES) $(top_srcdir)/tools/make-plugin-reg.py
+	@echo Making plugin.c
+	@$(PYTHON) $(top_srcdir)/tools/make-plugin-reg.py $(srcdir) \
+		plugin $(REGISTER_SRC_FILES)
diff --git a/plugins/epan/docsis/Makefile.am b/plugins/epan/docsis/Makefile.am
index 3137cbab87..33200bf47c 100644
--- a/plugins/epan/docsis/Makefile.am
+++ b/plugins/epan/docsis/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = docsis
diff --git a/plugins/epan/ethercat/Makefile.am b/plugins/epan/ethercat/Makefile.am
index e9cde19249..5a06af9ef9 100644
--- a/plugins/epan/ethercat/Makefile.am
+++ b/plugins/epan/ethercat/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = ethercat
diff --git a/plugins/epan/gryphon/Makefile.am b/plugins/epan/gryphon/Makefile.am
index 81495fdd7c..46fa7c1562 100644
--- a/plugins/epan/gryphon/Makefile.am
+++ b/plugins/epan/gryphon/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = gryphon
diff --git a/plugins/epan/irda/Makefile.am b/plugins/epan/irda/Makefile.am
index 1678d88874..77f891645f 100644
--- a/plugins/epan/irda/Makefile.am
+++ b/plugins/epan/irda/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = irda
diff --git a/plugins/epan/mate/Makefile.am b/plugins/epan/mate/Makefile.am
index bb1f576f74..786d4a5d65 100644
--- a/plugins/epan/mate/Makefile.am
+++ b/plugins/epan/mate/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = mate
diff --git a/plugins/epan/opcua/Makefile.am b/plugins/epan/opcua/Makefile.am
index 1023747325..d119418166 100644
--- a/plugins/epan/opcua/Makefile.am
+++ b/plugins/epan/opcua/Makefile.am
@@ -20,7 +20,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = opcua
diff --git a/plugins/epan/pluginifdemo/Makefile.am b/plugins/epan/pluginifdemo/Makefile.am
index aca6a56b94..bad9605bc9 100644
--- a/plugins/epan/pluginifdemo/Makefile.am
+++ b/plugins/epan/pluginifdemo/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = pluginifdemo
diff --git a/plugins/epan/profinet/Makefile.am b/plugins/epan/profinet/Makefile.am
index ce0888690c..0bb8b2fc9e 100644
--- a/plugins/epan/profinet/Makefile.am
+++ b/plugins/epan/profinet/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = profinet
diff --git a/plugins/epan/stats_tree/Makefile.am b/plugins/epan/stats_tree/Makefile.am
index 1b4c9326cf..ec4feb51f2 100644
--- a/plugins/epan/stats_tree/Makefile.am
+++ b/plugins/epan/stats_tree/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = stats_tree
diff --git a/plugins/epan/transum/Makefile.am b/plugins/epan/transum/Makefile.am
index 615255c66b..19bce627c9 100644
--- a/plugins/epan/transum/Makefile.am
+++ b/plugins/epan/transum/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = transum
diff --git a/plugins/epan/unistim/Makefile.am b/plugins/epan/unistim/Makefile.am
index 8c1ea042f1..c6051aa980 100644
--- a/plugins/epan/unistim/Makefile.am
+++ b/plugins/epan/unistim/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = unistim
diff --git a/plugins/epan/wimax/Makefile.am b/plugins/epan/wimax/Makefile.am
index 3074a525a5..0e37798377 100644
--- a/plugins/epan/wimax/Makefile.am
+++ b/plugins/epan/wimax/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = wimax
diff --git a/plugins/epan/wimaxasncp/Makefile.am b/plugins/epan/wimaxasncp/Makefile.am
index c2f122c3b0..4443b15883 100644
--- a/plugins/epan/wimaxasncp/Makefile.am
+++ b/plugins/epan/wimaxasncp/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = wimaxasncp
diff --git a/plugins/epan/wimaxmacphy/Makefile.am b/plugins/epan/wimaxmacphy/Makefile.am
index 3edb07567a..d69df68bac 100644
--- a/plugins/epan/wimaxmacphy/Makefile.am
+++ b/plugins/epan/wimaxmacphy/Makefile.am
@@ -19,7 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 include $(top_srcdir)/Makefile.am.inc
-include $(top_srcdir)/plugins/Makefile.am.inc
+include $(top_srcdir)/plugins/epan/Makefile.am.inc
 
 # the name of the plugin
 PLUGIN_NAME = wimaxmacphy
diff --git a/plugins/wiretap/Makefile.am.inc b/plugins/wiretap/Makefile.am.inc
new file mode 100644
index 0000000000..eab1328465
--- /dev/null
+++ b/plugins/wiretap/Makefile.am.inc
@@ -0,0 +1,42 @@
+# Makefile.am.inc
+# Include file with common automake definitions for wiretap plugins
+#
+# Wireshark - Network traffic analyzer
+# By Gerald Combs <gerald@wireshark.org>
+# Copyright 1998 Gerald Combs
+#
+# SPDX-License-Identifier: GPL-2.0+
+#
+
+include $(top_srcdir)/plugins/Makefile.am.inc
+
+#
+# Build plugin.c, which contains the plugin_version[] and plugin_release[]
+# string, and a function plugin_register() that calls the register routines
+# for all wiretap modules.
+#
+# 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 wtap_register_* routines must
+# start in column zero, or must be preceded only by "void " starting in
+# column zero, and must not be inside #if.
+#
+# REGISTER_SRC_FILES 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 use a script to generate the register.c file.
+# The first argument is the directory in which the source files live.
+# The second argument is "plugin_wtap", to indicate that we should build
+# a plugin.c file for a wiretap plugin.
+# All subsequent arguments are the files to scan.
+#
+plugin.c: $(REGISTER_SRC_FILES) $(top_srcdir)/tools/make-plugin-reg.py
+	@echo Making plugin.c
+	@$(PYTHON) $(top_srcdir)/tools/make-plugin-reg.py $(srcdir) \
+		plugin_wtap $(REGISTER_SRC_FILES)