ccan/err: new err.h-replacing module.

[ccan] / ccan / err / err.h

diff --git a/ccan/err/err.h b/ccan/err/err.h
new file mode 100644 (file)
index 0000000..da9ea0c
--- /dev/null
+++ b/ccan/err/err.h
@@ -0,0 +1,69 @@
+#ifndef CCAN_ERR_H
+#define CCAN_ERR_H
+#include "config.h"
+
+#if HAVE_ERR_H
+#include <err.h>
+#else
+#include <ccan/compiler/compiler.h>
+
+/**
+ * err - exit(eval) with message based on format and errno.
+ * @eval: the exit code
+ * @fmt: the printf-style format string
+ *
+ * The format string is printed to stderr like so:
+ *     <executable name>: <format>: <strerror(errno)>\n
+ *
+ * Example:
+ *     char *p = strdup("hello");
+ *     if (!p)
+ *             err(1, "Failed to strdup 'hello'");
+ */
+void NORETURN err(int eval, const char *fmt, ...);
+
+/**
+ * errx - exit(eval) with message based on format.
+ * @eval: the exit code
+ * @fmt: the printf-style format string
+ *
+ * The format string is printed to stderr like so:
+ *     <executable name>: <format>\n
+ *
+ * Example:
+ *     if (argc != 1)
+ *             errx(1, "I don't expect any arguments");
+ */
+void NORETURN errx(int eval, const char *fmt, ...);
+
+/**
+ * warn - print a message to stderr based on format and errno.
+ * @eval: the exit code
+ * @fmt: the printf-style format string
+ *
+ * The format string is printed to stderr like so:
+ *     <executable name>: <format>: <strerror(errno)>\n
+ *
+ * Example:
+ *     char *p = strdup("hello");
+ *     if (!p)
+ *             warn("Failed to strdup 'hello'");
+ */
+void warn(const char *fmt, ...);
+
+/**
+ * warnx - print a message to stderr based on format.
+ * @eval: the exit code
+ * @fmt: the printf-style format string
+ *
+ * The format string is printed to stderr like so:
+ *     <executable name>: <format>\n
+ *
+ * Example:
+ *     if (argc != 1)
+ *             warnx("I don't expect any arguments (ignoring)");
+ */
+void warnx(const char *fmt, ...);
+#endif
+
+#endif /* CCAN_ERR_H */