Move some command-line-oriented routines from wsutil to ui.

cmdarg_err() is for reporting errors for command-line programs and
command-line errors in GUI programs; it's not something for any of the
Wireshark libraries to use.

The various routines for parsing numerical command-line arguments are
not for general use, they're just for use when parsing arguments.

Change-Id: I100bd4a55ab8ee4497f41d9651b0c5670e6c1e7f
Reviewed-on: https://code.wireshark.org/review/31281
Petri-Dish: Guy Harris <guy@alum.mit.edu>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <guy@alum.mit.edu>

capinfos.c

@@ -59,7 +59,7 @@
 
 #include <wiretap/wtap.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/privileges.h>
 #include <cli_main.h>

capture_opts.c

@@ -24,8 +24,8 @@
 #include "capture_opts.h"
 #include "ringbuffer.h"
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/file_util.h>
 #include <wsutil/ws_pipe.h>
 

captype.c

@@ -28,7 +28,7 @@
 
 #include <wiretap/wtap.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/file_util.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/privileges.h>

debian/libwsutil0.symbols

@@ -7,9 +7,6 @@ libwsutil.so.0 libwsutil0 #MINVER#
  ascii_strdown_inplace@Base 1.10.0
  ascii_strup_inplace@Base 1.10.0
  bitswap_buf_inplace@Base 1.12.0~rc1
- cmdarg_err@Base 1.99.0
- cmdarg_err_cont@Base 1.99.0
- cmdarg_err_init@Base 1.99.0
  config_file_exists_with_entries@Base 2.9.0
  copy_file_binary_mode@Base 1.12.0~rc1
  copy_persconffile_profile@Base 1.12.0~rc1
@@ -69,9 +66,6 @@ libwsutil.so.0 libwsutil0 #MINVER#
  get_dirname@Base 1.12.0~rc1
  get_extcap_dir@Base 1.99.0
  get_global_profiles_dir@Base 1.12.0~rc1
- get_guint32@Base 2.3.0
- get_natural_int@Base 1.99.0
- get_nonzero_guint32@Base 2.3.0
  get_os_version_info@Base 1.99.0
  get_persconffile_path@Base 1.12.0~rc1
  get_persdatafile_dir@Base 1.12.0~rc1
@@ -79,8 +73,6 @@ libwsutil.so.0 libwsutil0 #MINVER#
  get_plugins_dir_with_version@Base 2.5.0
  get_plugins_pers_dir@Base 1.12.0~rc1
  get_plugins_pers_dir_with_version@Base 2.5.0
- get_positive_double@Base 2.9.0
- get_positive_int@Base 1.99.0
  get_profile_dir@Base 2.9.0
  get_profile_name@Base 1.12.0~rc1
  get_profiles_dir@Base 1.12.0~rc1

dumpcap.c

@@ -40,7 +40,7 @@
 #include <signal.h>
 #include <errno.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/strtoi.h>
 #include <cli_main.h>
 #include <version_info.h>
@@ -69,7 +69,7 @@
 #include <sys/un.h>
 #endif
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
 #include <wsutil/privileges.h>
 
 #include "sync_pipe.h"

editcap.c

@@ -62,8 +62,8 @@
 # include "wsutil/strptime.h"
 #endif
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/wsgcrypt.h>

extcap/androiddump.c

@@ -20,7 +20,7 @@
 #include <time.h>
 #include <wsutil/strtoi.h>
 #include <wsutil/filesystem.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/inet_addr.h>
 
 #include "ui/failure_message.h"

fuzz/CMakeLists.txt

@@ -27,6 +27,7 @@ set(FUZZ_UDP_PORT_DISSECTORS dns dhcp)
 set(FUZZ_MEDIA_TYPE_DISSECTORS json)
 
 set(fuzzshark_LIBS
+	ui
 	wiretap
 	epan
 	${VERSION_INFO_LIBS}

fuzz/fuzzshark.c

@@ -20,7 +20,7 @@
 
 #include <epan/epan.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/privileges.h>
 #include <wsutil/report_message.h>

mergecap.c

@@ -30,8 +30,8 @@
 #include <wsutil/wsgetopt.h>
 #endif
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/privileges.h>

randpkt.c

@@ -15,8 +15,8 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/file_util.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/privileges.h>

rawshark.c

@@ -46,13 +46,13 @@
 #include <glib.h>
 #include <epan/epan.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/plugins.h>
 #include <wsutil/privileges.h>
 #include <wsutil/report_message.h>
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
 
 #include "globals.h"
 #include <epan/packet.h>

reordercap.c

@@ -25,7 +25,7 @@
 #include "wsutil/wsgetopt.h"
 #endif
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/privileges.h>

sharkd.c

@@ -23,8 +23,8 @@
 #include <epan/exceptions.h>
 #include <epan/epan.h>
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/privileges.h>

tfshark.c

@@ -32,8 +32,8 @@
 #include <epan/exceptions.h>
 #include <epan/epan.h>
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/privileges.h>

tshark.c

@@ -45,8 +45,8 @@
 #include <epan/exceptions.h>
 #include <epan/epan.h>
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/file_util.h>
 #include <wsutil/privileges.h>

ui/CMakeLists.txt

@@ -11,6 +11,8 @@ set(NONGENERATED_UI_SRC
 	alert_box.c
 	capture.c
 	capture_ui_utils.c
+	clopts_common.c
+	cmdarg_err.c
 	commandline.c
 	console.c
 	decode_as_utils.c

ui/cli/tap-camelsrt.c

@@ -24,7 +24,7 @@
 #include "epan/timestats.h"
 #include "epan/stat_tap_ui.h"
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_camelsrt(void);
 

ui/cli/tap-diameter-avp.c

@@ -31,7 +31,7 @@
 #include <glib.h>
 
 #include <wsutil/strtoi.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 #include <epan/packet_info.h>
 #include <epan/tap.h>

ui/cli/tap-endpoints.c

@@ -18,7 +18,7 @@
 #include <epan/tap.h>
 #include <epan/stat_tap_ui.h>
 #include <epan/conversation_table.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <ui/cli/tshark-tap.h>
 
 typedef struct _endpoints_t {

ui/cli/tap-exportobject.c

@@ -18,7 +18,7 @@
 #include <string.h>
 
 #include <wsutil/file_util.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 #include <epan/packet_info.h>
 #include <epan/packet.h>

ui/cli/tap-hosts.c

@@ -21,7 +21,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/addr_resolv.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_hosts(void);
 

ui/cli/tap-httpstat.c

@@ -22,7 +22,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-http.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_httpstat(void);
 

ui/cli/tap-icmpstat.c

@@ -28,7 +28,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-icmp.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_icmpstat(void);
 

ui/cli/tap-icmpv6stat.c

@@ -29,7 +29,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-icmp.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_icmpv6stat(void);
 

ui/cli/tap-iousers.c

@@ -16,7 +16,7 @@
 #include <string.h>
 #include <epan/packet.h>
 #include <epan/timestamp.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <ui/cli/tshark-tap.h>
 
 typedef struct _io_users_t {

ui/cli/tap-protocolinfo.c

@@ -21,7 +21,7 @@
 #include <epan/tap.h>
 #include <epan/stat_tap_ui.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_protocolinfo(void);
 

ui/cli/tap-protohierstat.c

@@ -20,7 +20,7 @@
 #include <epan/tap.h>
 #include <epan/stat_tap_ui.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_protohierstat(void);
 

ui/cli/tap-rpcprogs.c

@@ -25,7 +25,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-rpc.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 #define MICROSECS_PER_SEC   1000000
 #define NANOSECS_PER_SEC    1000000000

ui/cli/tap-rtd.c

@@ -19,7 +19,7 @@
 #include <epan/rtd_table.h>
 #include <epan/timestamp.h>
 #include <epan/stat_tap_ui.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <ui/cli/tshark-tap.h>
 
 typedef struct _rtd_t {

ui/cli/tap-rtspstat.c

@@ -25,7 +25,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-rtsp.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_rtspstat(void);
 

ui/cli/tap-sctpchunkstat.c

@@ -24,7 +24,7 @@
 #include <epan/dissectors/packet-sctp.h>
 #include <epan/to_str.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_sctpstat(void);
 

ui/cli/tap-simple_stattable.c

@@ -16,7 +16,7 @@
 #include <epan/packet.h>
 #include <epan/timestamp.h>
 #include <epan/stat_tap_ui.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <ui/cli/tshark-tap.h>
 
 typedef struct _table_stat_t {

ui/cli/tap-sipstat.c

@@ -24,7 +24,7 @@
 #include <epan/value_string.h>
 #include <epan/dissectors/packet-sip.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_sipstat(void);
 

ui/cli/tap-smbsids.c

@@ -23,7 +23,7 @@
 #include <epan/value_string.h>
 #include <epan/dissectors/packet-smb.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_smbsids(void);
 

ui/cli/tap-srt.c

@@ -17,7 +17,7 @@
 #include <epan/srt_table.h>
 #include <epan/timestamp.h>
 #include <epan/stat_tap_ui.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <ui/cli/tshark-tap.h>
 
 #define NANOSECS_PER_SEC 1000000000

ui/cli/tap-sv.c

@@ -22,7 +22,7 @@
 #include <epan/stat_tap_ui.h>
 #include <epan/dissectors/packet-sv.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_sv(void);
 

ui/cli/tap-wspstat.c

@@ -27,7 +27,7 @@
 #include <epan/value_string.h>
 #include <epan/dissectors/packet-wsp.h>
 
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 void register_tap_listener_wspstat(void);
 

ui/clopts_common.c

@@ -14,9 +14,9 @@
 #include <errno.h>
 
 #include <wsutil/strtoi.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
-#include <wsutil/clopts_common.h>
+#include "clopts_common.h"
 
 int
 get_natural_int(const char *string, const char *name)

ui/clopts_common.h

@@ -8,32 +8,30 @@
  * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
-#ifndef __WSUTIL_CLOPTS_COMMON_H__
+#ifndef __UI_CLOPTS_COMMON_H__
-#define __WSUTIL_CLOPTS_COMMON_H__
+#define __UI_CLOPTS_COMMON_H__
-
-#include "ws_symbol_export.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
 
-WS_DLL_PUBLIC int
+extern int
 get_natural_int(const char *string, const char *name);
 
-WS_DLL_PUBLIC int
+extern int
 get_positive_int(const char *string, const char *name);
 
-WS_DLL_PUBLIC guint32
+extern guint32
 get_guint32(const char *string, const char *name);
 
-WS_DLL_PUBLIC guint32
+extern guint32
 get_nonzero_guint32(const char *string, const char *name);
 
-WS_DLL_PUBLIC double
+extern double
 get_positive_double(const char *string, const char *name);
 
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
 
-#endif /* __WSUTIL_CLOPTS_COMMON_H__ */
+#endif /* __UI_CLOPTS_COMMON_H__ */

ui/cmdarg_err.c

@@ -10,8 +10,7 @@
 
 #include "config.h"
 
-
+#include "cmdarg_err.h"
-#include <wsutil/cmdarg_err.h>
 
 static void (*print_err)(const char *, va_list ap);
 static void (*print_err_cont)(const char *, va_list ap);

ui/cmdarg_err.h

@@ -8,15 +8,13 @@
  * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
-#ifndef __WSUTIL_CMDARG_ERR_H__
+#ifndef __UI_CMDARG_ERR_H__
-#define __WSUTIL_CMDARG_ERR_H__
+#define __UI_CMDARG_ERR_H__
 
 #include <stdarg.h>
 
 #include <glib.h>
 
-#include "ws_symbol_export.h"
-
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
@@ -24,21 +22,21 @@ extern "C" {
 /*
  * Set the reporting functions for error messages.
  */
-WS_DLL_PUBLIC void
+extern void
 cmdarg_err_init(void (*err)(const char *, va_list),
                 void (*err_cont)(const char *, va_list));
 
 /*
  * Report an error in command-line arguments.
  */
-WS_DLL_PUBLIC void
+extern void
 cmdarg_err(const char *fmt, ...)
     G_GNUC_PRINTF(1, 2);
 
 /*
  * Report additional information for an error in command-line arguments.
  */
-WS_DLL_PUBLIC void
+extern void
 cmdarg_err_cont(const char *fmt, ...)
     G_GNUC_PRINTF(1, 2);
 
@@ -46,4 +44,4 @@ cmdarg_err_cont(const char *fmt, ...)
 }
 #endif /* __cplusplus */
 
-#endif /* __WSUTIL_CMDARG_ERR_H__ */
+#endif /* __UI_CMDARG_ERR_H__ */

ui/commandline.c

@@ -26,8 +26,8 @@
 
 #include <version_info.h>
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 
 #include <epan/ex-opt.h>

ui/decode_as_utils.c

@@ -23,7 +23,7 @@
 
 #include "wsutil/file_util.h"
 #include "wsutil/filesystem.h"
-#include "wsutil/cmdarg_err.h"
+#include "ui/cmdarg_err.h"
 #include "version_info.h"
 
 /* XXX - We might want to switch this to a UAT */

ui/dissect_opts.c

@@ -30,8 +30,8 @@
 #include <epan/dissectors/read_keytab_file.h>
 #endif
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/file_util.h>
 
 #include "ui/dissect_opts.h"

ui/failure_message.c

@@ -16,7 +16,7 @@
 
 #include <wiretap/wtap.h>
 #include <wsutil/filesystem.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 
 #include "ui/failure_message.h"
 

ui/qt/main.cpp

@@ -28,8 +28,8 @@
 #include "wsutil/wsgetopt.h"
 #endif
 
-#include <wsutil/clopts_common.h>
+#include <ui/clopts_common.h>
-#include <wsutil/cmdarg_err.h>
+#include <ui/cmdarg_err.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/privileges.h>
 #ifdef HAVE_PLUGINS

wsutil/CMakeLists.txt

@@ -20,8 +20,6 @@ set(WSUTIL_PUBLIC_HEADERS
 	bits_ctz.h
 	bitswap.h
 	buffer.h
-	clopts_common.h
-	cmdarg_err.h
 	color.h
 	copyright_info.h
 	cpu_info.h
@@ -80,8 +78,6 @@ set(WSUTIL_COMMON_FILES
 	base32.c
 	bitswap.c
 	buffer.c
-	clopts_common.c
-	cmdarg_err.c
 	copyright_info.c
 	crash_info.c
 	crc10.c