/* version_info.h
- * Declarations of outines to report version information for stuff used
- * by Wireshark
+ * Declarations of routines to report version information for Wireshark
+ * programs
*
* 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.
+ * SPDX-License-Identifier: GPL-2.0-or-later
*/
-#ifndef __VERSION_INFO_H__
-#define __VERSION_INFO_H__
+#ifndef __WS_VERSION_INFO_H__
+#define __WS_VERSION_INFO_H__
+
+#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*
- * Get various library compile-time versions and append them to
- * the specified GString.
+ * Initialize information about the program for various purposes, including
+ * reporting the version and build information for the program, putting
+ * that information into crash dumps if possible, and giving the program
+ * name and version information into capture files written by the program
+ * if possible.
+ *
+ * "appname" is a string that appears at the beginning of the information;
+ * it should include the application name, followed by "(Wireshark)" if
+ * the program isn't Wireshark.
+ *
+ * "prepend_compile_time_info" is called at the start to prepend any
+ * additional build information before the standard library information.
+ *
+ * "append_compile_time_info" is called at the end to append any additional
+ * build information after the standard library information. This is
+ * required in order to, for example, put Qt information at the
+ * end of the string, as we don't use Qt in TShark.
+ *
+ * "additional_info" is called at the end to append any additional
+ * run-time information; this is required in order to, for example,
+ * put the libcap information at the end of the string, as we currently
+ * don't use libcap in TShark.
+ */
+void ws_init_version_info(const char *appname,
+ void (*prepend_compile_time_info)(GString *),
+ void (*append_compile_time_info)(GString *),
+ void (*additional_run_time_info)(GString *));
+
+/*
+ * Get a string giving the application name, as provided to
+ * ws_init_version_info(), followed by a string giving the
+ * application version.
+ */
+const char *get_appname_and_version(void);
+
+/*
+ * Get various library compile-time versions, put them in a GString,
+ * and return the GString.
*
* "prepend_info" is called at the start to prepend any additional
- * information.
+ * information before the standard library information.
*
* "append_info" is called at the end to append any additional
+ * information after the standard library information. This is
+ * required in order to, for example, put Qt information at the
+ * end of the string, as we don't use Qt in TShark.
+ */
+GString *get_compiled_version_info(void (*prepend_info)(GString *),
+ void (*append_info)(GString *));
+
+/*
+ * Get various library run-time versions, and the OS version, put them in
+ * a GString, and return the GString.
+ *
+ * "additional_info" is called at the end to append any additional
* information; this is required in order to, for example, put the
- * Portaudio information at the end of the string, as we currently
- * don't use Portaudio in TShark.
+ * libcap information at the end of the string, as we currently
+ * don't use libcap in TShark.
*/
-void get_compiled_version_info(GString *str,
- void (*prepend_info)(GString *),
- void (*append_info)(GString *));
+GString *get_runtime_version_info(void (*additional_info)(GString *));
/*
- * Get various library run-time versions, and the OS version, and append
- * them to the specified GString.
+ * Return a version number string for Wireshark, including, for builds
+ * from a tree checked out from Wireshark's version control system,
+ * something identifying what version was checked out.
*/
-void get_runtime_version_info(GString *str,
- void (*additional_info)(GString *));
+const char *get_ws_vcs_version_info(void);
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+/*
+ * Return version number as integers.
+ */
+void get_ws_version_number(int *major, int *minor, int *micro);
/*
- * Editor modelines - http://www.wireshark.org/tools/modelines.html
- *
- * Local variables:
- * c-basic-offset: 4
- * tab-width: 8
- * indent-tabs-mode: nil
- * End:
- *
- * vi: set shiftwidth=4 tabstop=8 expandtab:
- * :indentSize=4:tabSize=8:noTabs=true:
+ * Show the program name and version number information on the standard
+ * output; this is used for command-line "show the version" options.
*/
+void show_version(void);
+
+/*
+ * Show the program name and version number information, a supplied
+ * description string, and a "See {URL} for more information" message.
+ * This is used for command-line "help" options.
+ */
+void show_help_header(const char *description);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
-#endif /* __VERSION_INFO_H__ */
+#endif /* __WS_VERSION_INFO_H__ */
git.samba.org / metze / wireshark / wip.git / blobdiff