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 // IWYU pragma: private, include "upb/reflection/def.h"
29 
30 #ifndef UPB_REFLECTION_ENUM_DEF_H_
31 #define UPB_REFLECTION_ENUM_DEF_H_
32 
33 #include "upb/base/string_view.h"
34 #include "upb/reflection/common.h"
35 
36 // Must be last.
37 #include "upb/port/def.inc"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 bool upb_EnumDef_CheckNumber(const upb_EnumDef* e, int32_t num);
44 const upb_MessageDef* upb_EnumDef_ContainingType(const upb_EnumDef* e);
45 int32_t upb_EnumDef_Default(const upb_EnumDef* e);
46 const upb_FileDef* upb_EnumDef_File(const upb_EnumDef* e);
47 const upb_EnumValueDef* upb_EnumDef_FindValueByName(const upb_EnumDef* e,
48                                                     const char* name);
49 const upb_EnumValueDef* upb_EnumDef_FindValueByNameWithSize(
50     const upb_EnumDef* e, const char* name, size_t size);
51 const upb_EnumValueDef* upb_EnumDef_FindValueByNumber(const upb_EnumDef* e,
52                                                       int32_t num);
53 const char* upb_EnumDef_FullName(const upb_EnumDef* e);
54 bool upb_EnumDef_HasOptions(const upb_EnumDef* e);
55 bool upb_EnumDef_IsClosed(const upb_EnumDef* e);
56 
57 // Creates a mini descriptor string for an enum, returns true on success.
58 bool upb_EnumDef_MiniDescriptorEncode(const upb_EnumDef* e, upb_Arena* a,
59                                       upb_StringView* out);
60 
61 const char* upb_EnumDef_Name(const upb_EnumDef* e);
62 const UPB_DESC(EnumOptions) * upb_EnumDef_Options(const upb_EnumDef* e);
63 
64 upb_StringView upb_EnumDef_ReservedName(const upb_EnumDef* e, int i);
65 int upb_EnumDef_ReservedNameCount(const upb_EnumDef* e);
66 
67 const upb_EnumReservedRange* upb_EnumDef_ReservedRange(const upb_EnumDef* e,
68                                                        int i);
69 int upb_EnumDef_ReservedRangeCount(const upb_EnumDef* e);
70 
71 const upb_EnumValueDef* upb_EnumDef_Value(const upb_EnumDef* e, int i);
72 int upb_EnumDef_ValueCount(const upb_EnumDef* e);
73 
74 #ifdef __cplusplus
75 } /* extern "C" */
76 #endif
77 
78 #include "upb/port/undef.inc"
79 
80 #endif /* UPB_REFLECTION_ENUM_DEF_H_ */
81