diff options
Diffstat (limited to 'wsutil/report_message.h')
-rw-r--r-- | wsutil/report_message.h | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/wsutil/report_message.h b/wsutil/report_message.h new file mode 100644 index 0000000000..63cbc0d1b4 --- /dev/null +++ b/wsutil/report_message.h @@ -0,0 +1,86 @@ +/* report_message.h + * Declarations of routines for code that can run in GUI and command-line + * environments to use to report errors and warnings to the user (e.g., + * I/O errors, or problems with preference settings) if the message should + * be shown as a GUI error in a GUI environment. + * + * The application using libwsutil will register message-reporting + * routines, and the routines declared here will call the registered + * routines. That way, these routines can be called by code that + * doesn't itself know whether to pop up a dialog or print something + * to the standard error. + * + * 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. + */ + +#ifndef __REPORT_MESSAGE_H__ +#define __REPORT_MESSAGE_H__ + +#include "ws_symbol_export.h" + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* + * Initialize the report message routines + */ +WS_DLL_PUBLIC void init_report_message( + void (*vreport_failure)(const char *, va_list), + void (*vreport_warning)(const char *, va_list), + void (*report_open_failure)(const char *, int, gboolean), + void (*report_read_failure)(const char *, int), + void (*report_write_failure)(const char *, int)); + +/* + * Report a general error. + */ +WS_DLL_PUBLIC void report_failure(const char *msg_format, ...) G_GNUC_PRINTF(1, 2); + +/* + * Report a general warning. + */ +WS_DLL_PUBLIC void report_warning(const char *msg_format, ...) G_GNUC_PRINTF(1, 2); + +/* + * Report an error when trying to open a file. + * "err" is assumed to be an error code from Wiretap; positive values are + * UNIX-style errnos, so this can be used for open failures not from + * Wiretap as long as the failure code is just an errno. + */ +WS_DLL_PUBLIC void report_open_failure(const char *filename, int err, + gboolean for_writing); + +/* + * Report an error when trying to read a file. + * "err" is assumed to be a UNIX-style errno. + */ +WS_DLL_PUBLIC void report_read_failure(const char *filename, int err); + +/* + * Report an error when trying to write a file. + * "err" is assumed to be a UNIX-style errno. + */ +WS_DLL_PUBLIC void report_write_failure(const char *filename, int err); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* __REPORT_MESSAGE_H__ */ |