xref: /aosp_15_r20/bionic/libc/include/bits/bionic_multibyte_result.h (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1)
1 /*
2  * Copyright (C) 2023 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 bits/bionic_multibyte_result.h
33  * @brief Named values for the magic number return values of multibyte
34  * conversion APIs defined by C.
35  */
36 
37 #include <sys/cdefs.h>
38 
39 #include <stddef.h>
40 
41 __BEGIN_DECLS
42 
43 /**
44  * @brief The error values defined by C for multibyte conversion APIs.
45  *
46  * Refer to C23 7.30.1 Restartable multibyte/wide character conversion functions
47  * for more details.
48  */
49 enum : size_t {
50   /// @brief An encoding error occurred. The bytes read are not a valid unicode
51   /// character, nor are they a partially valid character.
52   BIONIC_MULTIBYTE_RESULT_ILLEGAL_SEQUENCE = -1UL,
53 #define BIONIC_MULTIBYTE_RESULT_ILLEGAL_SEQUENCE BIONIC_MULTIBYTE_RESULT_ILLEGAL_SEQUENCE
54 
55   /// @brief The bytes read may produce a valid unicode character, but the
56   /// sequence is incomplete. Future calls may complete the character.
57   BIONIC_MULTIBYTE_RESULT_INCOMPLETE_SEQUENCE = -2UL,
58 #define BIONIC_MULTIBYTE_RESULT_INCOMPLETE_SEQUENCE BIONIC_MULTIBYTE_RESULT_INCOMPLETE_SEQUENCE
59 
60   /// @brief The output of the call was the result of a previous successful
61   /// decoding. No new bytes were consumed.
62   ///
63   /// The common case for this return value is when mbrtoc16 returns the low
64   /// surrogate of a pair.
65   BIONIC_MULTIBYTE_RESULT_NO_BYTES_CONSUMED = -3UL,
66 #define BIONIC_MULTIBYTE_RESULT_NO_BYTES_CONSUMED BIONIC_MULTIBYTE_RESULT_NO_BYTES_CONSUMED
67 };
68 
69 __END_DECLS
70