Update plugin to the current plugin design.
authorjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Mon, 18 Dec 2006 16:23:46 +0000 (16:23 +0000)
committerjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Mon, 18 Dec 2006 16:23:46 +0000 (16:23 +0000)
Add Windows version info resource.

git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@20144 f5534014-38df-0310-8fa8-9805f1628bb7

plugins/mate/Makefile.am
plugins/mate/Makefile.common [new file with mode: 0644]
plugins/mate/Makefile.nmake
plugins/mate/mate_plugin.c [deleted file]
plugins/mate/moduleinfo.nmake [new file with mode: 0644]
plugins/mate/plugin.rc.in [new file with mode: 0644]

index 1c17f3992978023bde2f3df8d8af72b1b1b17cb7..e520888202d0687e31d7eb63057f037ff7c38379 100644 (file)
@@ -1,5 +1,5 @@
 # Makefile.am
-# Automake file for MATE Ethereal plugin
+# Automake file for MATE Wireshark plugin
 #
 # $Id$
 #
 
 INCLUDES = -I$(top_srcdir)
 
+include Makefile.common
+
 plugindir = @plugindir@
 
 plugin_LTLIBRARIES = mate.la
 
 mate_la_SOURCES = \
-       mate.h          \
-       mate_grammar.c  \
-       mate_grammar.h  \
-       mate_parser.c   \
-       mate_plugin.c   \
-       mate_runtime.c  \
-       mate_setup.c    \
-       mate_util.c     \
-       mate_util.h     \
+       plugin.c        \
        moduleinfo.h    \
-       packet-mate.c
+       $(DISSECTOR_SRC)        \
+       $(DISSECTOR_SUPPORT_SRC)        \
+       $(DISSECTOR_INCLUDES)
+
+#      mate.h          \
+#      mate_grammar.c  \
+#      mate_grammar.h  \
+#      mate_parser.c   \
+#      mate_runtime.c  \
+#      mate_setup.c    \
+#      mate_util.c     \
+#      mate_util.h     \
+#      moduleinfo.h    \
+#      packet-mate.c
 
 mate_la_LDFLAGS = -module -avoid-version
 mate_la_LIBADD = @PLUGIN_LIBS@
@@ -49,6 +56,69 @@ mate_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 = \
        mate \
        *~
@@ -67,9 +137,11 @@ MAINTAINERCLEANFILES = \
        plugin.c
 
 EXTRA_DIST = \
-       mate_grammar.lemon \
-       mate_parser.l \
-       Makefile.nmake
+       mate_grammar.lemon      \
+       mate_parser.l   \
+       Makefile.nmake  \
+       Makefile.common \
+       plugin.rc.in
 
 mate_parser.c : mate_parser.l
        $(LEX) -Pdf_ -omate_parser.c $(srcdir)/mate_parser.l
diff --git a/plugins/mate/Makefile.common b/plugins/mate/Makefile.common
new file mode 100644 (file)
index 0000000..97c68c0
--- /dev/null
@@ -0,0 +1,41 @@
+# Makefile.common for mate plugin
+#     Contains the stuff from Makefile.am and Makefile.nmake that is
+#     a) common to both files and
+#     b) portable between both files
+#
+# $Id: Makefile.common 18197 2006-05-21 05:12:17Z sahlberg $
+#
+# 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+# the name of the plugin
+PLUGIN_NAME = mate
+
+# the dissector sources (without any helpers)
+DISSECTOR_SRC = \
+       packet-mate.c
+
+# Dissector helpers.  They're included in the source files in this
+# directory, but they're not dissectors themselves, i.e. they're not
+# used to generate "register.c").
+DISSECTOR_SUPPORT_SRC =        \
+       mate_setup.c    \
+       mate_runtime.c  \
+       mate_util.c     \
+       mate_grammar.c  \
+       mate_parser.c   
index ec6090d4893beaa0477e6b4a2d33bf6478f72357..dff6d8032305f3eb4ea93dbb1150866b51b47ef4 100644 (file)
@@ -1,17 +1,19 @@
+# Makefile.nmake
+# nmake file for mate plugin
 #
 # $Id$
 #
 
 include ..\..\config.nmake
-include <win32.mak>
+include moduleinfo.nmake
 
-############### no need to modify below this line #########
+include Makefile.common
 
 LEMON=..\..\tools\lemon
 
 CFLAGS=/DHAVE_CONFIG_H /I../.. /I../../wiretap $(GLIB_CFLAGS) /I$(LEMON)\
        /I$(PCAP_DIR)\include -D_U_="" $(LOCAL_CFLAGS)
-       
+
 .c.obj::
        $(CC) $(CFLAGS) -Fdmate.pdb -c $<
        
@@ -21,24 +23,76 @@ LDFLAGS = /NOLOGO /INCREMENTAL:no /MACHINE:I386 $(LOCAL_LDFLAGS)
 LINK_PLUGIN_WITH=..\..\epan\libwireshark.lib
 CFLAGS=/DHAVE_WIN32_LIBWIRESHARK_LIB /D_NEED_VAR_IMPORT_ $(CFLAGS)
 
-OBJECTS=packet-mate.obj\
-               mate_setup.obj\
-               mate_runtime.obj\
-               mate_util.obj\
-               mate_plugin.obj\
-               mate_grammar.obj\
-               mate_parser.obj
+DISSECTOR_OBJECTS = $(DISSECTOR_SRC:.c=.obj)
+
+DISSECTOR_SUPPORT_OBJECTS = $(DISSECTOR_SUPPORT_SRC:.c=.obj)
+
+OBJECTS = $(DISSECTOR_OBJECTS) $(DISSECTOR_SUPPORT_OBJECTS) plugin.obj
+
+RESOURCE=$(PLUGIN_NAME).res
 
-mate.dll mate.exp mate.lib : $(OBJECTS) $(LINK_PLUGIN_WITH)
-       link -dll /out:mate.dll $(LDFLAGS) $(OBJECTS) $(LINK_PLUGIN_WITH) \
-       $(GLIB_LIBS)
+all: $(PLUGIN_NAME).dll
+
+$(PLUGIN_NAME).rc : moduleinfo.nmake
+       sed -e s/@PLUGIN_NAME@/$(PLUGIN_NAME)/ \
+       -e s/@RC_MODULE_VERSION@/$(RC_MODULE_VERSION)/ \
+       -e s/@RC_VERSION@/$(RC_VERSION)/ \
+       -e s/@MODULE_VERSION@/$(MODULE_VERSION)/ \
+       -e s/@PACKAGE@/$(PACKAGE)/ \
+       -e s/@VERSION@/$(VERSION)/ \
+       < plugin.rc.in > $@
+
+$(PLUGIN_NAME).dll $(PLUGIN_NAME).exp $(PLUGIN_NAME).lib : $(OBJECTS) $(LINK_PLUGIN_WITH) $(RESOURCE)
+       link -dll /out:$(PLUGIN_NAME).dll $(LDFLAGS) $(OBJECTS) $(LINK_PLUGIN_WITH) \
+       $(GLIB_LIBS) $(RESOURCE)
+#
+# 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:
-       rm -f $(OBJECTS) mate.dll mate.exp mate.lib *.pdb
+       rm -f $(OBJECTS) $(PLUGIN_NAME).dll $(PLUGIN_NAME).exp \
+           $(RESOURCE) $(PLUGIN_NAME).rc $(PLUGIN_NAME).lib *.pdb
 
-#
 # We remove the generated files with "distclean" because one of them,
 # "mate_parser.c", needs different #includes for UN*X and Windows
 # (UN*X versions of Flex make it include <unistd.h>, but that's a
diff --git a/plugins/mate/mate_plugin.c b/plugins/mate/mate_plugin.c
deleted file mode 100644 (file)
index 6e6da42..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-/* mate_plugin.c
-* MATE -- Meta Analysis Tracing Engine
-*
-* Copyright 2004, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
-*
-* $Id$
-*
-* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-*/
-
-/* this file is used temporarily to buid MATE as a plugin */
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-#include <glib.h>
-
-#ifndef ENABLE_STATIC
-#include "moduleinfo.h"
-#include <gmodule.h>
-#endif
-
-/* these two are in packet-mate.c */
-void proto_register_mate(void);
-void proto_reg_handoff_mate(void);
-
-
-static gboolean initialized = FALSE;
-
-#ifndef ENABLE_STATIC
-G_MODULE_EXPORT const gchar version[] = VERSION;
-
-G_MODULE_EXPORT void plugin_register(void) {
-       
-       if (! initialized ) {
-               proto_register_mate();
-               initialized = 1;
-       }
-}
-
-G_MODULE_EXPORT void plugin_reg_handoff(void)
-{
-       proto_reg_handoff_mate();
-}
-#endif
diff --git a/plugins/mate/moduleinfo.nmake b/plugins/mate/moduleinfo.nmake
new file mode 100644 (file)
index 0000000..ece7136
--- /dev/null
@@ -0,0 +1,28 @@
+#
+# $Id: moduleinfo.nmake 20036 2006-12-04 23:12:04Z jake $
+#
+
+# The name
+PACKAGE=mate
+
+# The version
+MODULE_VERSION_MAJOR=1
+MODULE_VERSION_MINOR=0
+MODULE_VERSION_MICRO=0
+MODULE_VERSION_EXTRA=1
+
+#
+# The RC_VERSION should be comma-separated, not dot-separated, 
+# as per Graham Bloice's message in
+#
+#      http://www.ethereal.com/lists/ethereal-dev/200303/msg00283.html
+#
+# "The RC_VERSION variable in config.nmake should be comma separated. 
+# This allows the resources to be built correctly and the version
+# number to be correctly displayed in the explorer properties dialog
+# for the executables, and XP's tooltip, rather than 0.0.0.0."
+#
+
+MODULE_VERSION=$(MODULE_VERSION_MAJOR).$(MODULE_VERSION_MINOR).$(MODULE_VERSION_MICRO).$(MODULE_VERSION_EXTRA)
+RC_MODULE_VERSION=$(MODULE_VERSION_MAJOR),$(MODULE_VERSION_MINOR),$(MODULE_VERSION_MICRO),$(MODULE_VERSION_EXTRA)
+
diff --git a/plugins/mate/plugin.rc.in b/plugins/mate/plugin.rc.in
new file mode 100644 (file)
index 0000000..e394a4f
--- /dev/null
@@ -0,0 +1,33 @@
+#include "winver.h"
+
+VS_VERSION_INFO VERSIONINFO
+ FILEVERSION @RC_MODULE_VERSION@
+ PRODUCTVERSION @RC_VERSION@,0
+ FILEFLAGSMASK 0x0L
+#ifdef _DEBUG
+ FILEFLAGS VS_FF_PRERELEASE+VS_FF_SPECIALBUILD+VS_FF_DEBUG
+#else
+ FILEFLAGS VS_FF_PRERELEASE+VS_FF_SPECIALBUILD
+#endif
+ FILEOS VOS__WINDOWS32
+ FILETYPE VFT_DLL
+BEGIN
+    BLOCK "StringFileInfo"
+    BEGIN
+        BLOCK "040904b0"
+        BEGIN
+            VALUE "CompanyName", "The Wireshark developer community, http://www.wireshark.org/\0"
+            VALUE "FileDescription", "@PACKAGE@ dissector\0"
+            VALUE "FileVersion", "@MODULE_VERSION@\0"
+            VALUE "InternalName", "@PACKAGE@ @MODULE_VERSION@\0"
+            VALUE "LegalCopyright", "Copyright © 1998 Gerald Combs <gerald@wireshark.org>, Gilbert Ramirez <gram@alumni.rice.edu> and others\0"
+            VALUE "OriginalFilename", "@PLUGIN_NAME@.dll\0"
+            VALUE "ProductName", "Wireshark\0"
+            VALUE "ProductVersion", "@VERSION@\0"
+        END
+    END
+    BLOCK "VarFileInfo"
+    BEGIN
+        VALUE "Translation", 0x409, 1200
+    END
+END