blob: d1c6f2ce6989f8c4b56dc8a54165fe9f5d96d0d0 [file] [log] [blame]
Andrea Falcone1c4977f2020-07-23 10:58:25 -04001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#pragma once
30
31/**
32 * @file error.h
33 * @brief GNU error reporting functions.
34 */
35
36#include <sys/cdefs.h>
37
38__BEGIN_DECLS
39
40/**
41 * [error_print_progname(3)](http://man7.org/linux/man-pages/man3/error_print_progname.3.html) is
42 * a function pointer that, if non-null, is called by error() instead of prefixing errors with the
43 * program name.
44 *
45 * Available since API level 23.
46 */
47
48#if __ANDROID_API__ >= 23
49extern void (*error_print_progname)(void) __INTRODUCED_IN(23);
50
51/**
52 * [error_message_count(3)](http://man7.org/linux/man-pages/man3/error_message_count.3.html) is
53 * a global count of the number of calls to error() and error_at_line().
54 *
55 * Available since API level 23.
56 */
57extern unsigned int error_message_count __INTRODUCED_IN(23);
58
59/**
60 * [error_one_per_line(3)](http://man7.org/linux/man-pages/man3/error_one_per_line.3.html) is
61 * a global flag that if non-zero disables printing multiple errors with the same filename and
62 * line number.
63 *
64 * Available since API level 23.
65 */
66extern int error_one_per_line __INTRODUCED_IN(23);
67
68/**
69 * [error(3)](http://man7.org/linux/man-pages/man3/error.3.html) formats the given printf()-like
70 * error message, preceded by the program name. Calls exit if `__status` is non-zero, and appends
71 * the result of strerror() if `__errno` is non-zero.
72 *
73 * Available since API level 23.
74 */
75void error(int __status, int __errno, const char* __fmt, ...) __printflike(3, 4) __INTRODUCED_IN(23);
76
77/**
78 * [error_at_line(3)](http://man7.org/linux/man-pages/man3/error_at_line.3.html) formats the given
79 * printf()-like error message, preceded by the program name and the given filename and line number.
80 * Calls exit if `__status` is non-zero, and appends the result of strerror() if `__errno` is
81 * non-zero.
82 *
83 * Available since API level 23.
84 */
85void error_at_line(int __status, int __errno, const char* __filename, unsigned int __line_number, const char* __fmt, ...) __printflike(5, 6) __INTRODUCED_IN(23);
86#endif /* __ANDROID_API__ >= 23 */
87
88
89__END_DECLS