1 /*
2  * Copyright (c) 2009-2021, Google LLC
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 are met:
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Google LLC nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef UPB_BASE_STATUS_H_
29 #define UPB_BASE_STATUS_H_
30 
31 #include <stdarg.h>
32 
33 // Must be last.
34 #include "upb/port/def.inc"
35 
36 #define _kUpb_Status_MaxMessage 127
37 
38 typedef struct {
39   bool ok;
40   char msg[_kUpb_Status_MaxMessage];  // Error message; NULL-terminated.
41 } upb_Status;
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 UPB_API const char* upb_Status_ErrorMessage(const upb_Status* status);
48 UPB_API bool upb_Status_IsOk(const upb_Status* status);
49 
50 // These are no-op if |status| is NULL.
51 UPB_API void upb_Status_Clear(upb_Status* status);
52 void upb_Status_SetErrorMessage(upb_Status* status, const char* msg);
53 void upb_Status_SetErrorFormat(upb_Status* status, const char* fmt, ...)
54     UPB_PRINTF(2, 3);
55 void upb_Status_VSetErrorFormat(upb_Status* status, const char* fmt,
56                                 va_list args) UPB_PRINTF(2, 0);
57 void upb_Status_VAppendErrorFormat(upb_Status* status, const char* fmt,
58                                    va_list args) UPB_PRINTF(2, 0);
59 
60 #ifdef __cplusplus
61 } /* extern "C" */
62 #endif
63 
64 #include "upb/port/undef.inc"
65 
66 #endif /* UPB_BASE_STATUS_H_ */
67