Home | History | Annotate | Download | only in include
      1 /*
      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 extern void (*error_print_progname)(void) __INTRODUCED_IN(23);
     48 
     49 /**
     50  * [error_message_count(3)](http://man7.org/linux/man-pages/man3/error_message_count.3.html) is
     51  * a global count of the number of calls to error() and error_at_line().
     52  *
     53  * Available since API level 23.
     54  */
     55 extern unsigned int error_message_count __INTRODUCED_IN(23);
     56 
     57 /**
     58  * [error_one_per_line(3)](http://man7.org/linux/man-pages/man3/error_one_per_line.3.html) is
     59  * a global flag that if non-zero disables printing multiple errors with the same filename and
     60  * line number.
     61  *
     62  * Available since API level 23.
     63  */
     64 extern int error_one_per_line __INTRODUCED_IN(23);
     65 
     66 /**
     67  * [error(3)](http://man7.org/linux/man-pages/man3/error.3.html) formats the given printf()-like
     68  * error message, preceded by the program name. Calls exit if `__status` is non-zero, and appends
     69  * the result of strerror() if `__errno` is non-zero.
     70  *
     71  * Available since API level 23.
     72  */
     73 void error(int __status, int __errno, const char* __fmt, ...) __printflike(3, 4) __INTRODUCED_IN(23);
     74 
     75 /**
     76  * [error_at_line(3)](http://man7.org/linux/man-pages/man3/error_at_line.3.html) formats the given
     77  * printf()-like error message, preceded by the program name and the given filename and line number.
     78  * Calls exit if `__status` is non-zero, and appends the result of strerror() if `__errno` is
     79  * non-zero.
     80  *
     81  * Available since API level 23.
     82  */
     83 void error_at_line(int __status, int __errno, const char* __filename, unsigned int __line_number, const char* __fmt, ...) __printflike(5, 6) __INTRODUCED_IN(23);
     84 
     85 __END_DECLS
     86