1/*
2 * Copyright (c) 2015, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * 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 Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * 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 THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef UNICODE_DEF_H
30#define UNICODE_DEF_H
31
32#include "ue2common.h"
33
34#define MAX_UNICODE 0x10FFFF
35#define INVALID_UNICODE 0xffffffff /* unicode could never go above 2^31 */
36
37#define UTF_2CHAR_MIN (1U << 7)
38#define UTF_3CHAR_MIN (1U << 11)
39#define UTF_4CHAR_MIN (1U << 16)
40#define UTF_CONT_SHIFT 6
41#define UTF_CONT_BYTE_RANGE (1U << UTF_CONT_SHIFT)
42#define UTF_CONT_BYTE_HEADER ((u8)0x80) /* 10xx xxxx */
43#define UTF_TWO_BYTE_HEADER ((u8)0xc0) /* 110x xxxx */
44#define UTF_THREE_BYTE_HEADER ((u8)0xe0) /* 1110 xxxx */
45#define UTF_FOUR_BYTE_HEADER ((u8)0xf0) /* 1111 0xxx */
46
47#define UTF_CONT_BYTE_VALUE_MASK 0x3f
48
49#define UTF_CONT_MIN UTF_CONT_BYTE_HEADER
50#define UTF_CONT_MAX (UTF_TWO_BYTE_HEADER - 1)
51
52#define UTF_TWO_BYTE_MIN UTF_TWO_BYTE_HEADER
53#define UTF_TWO_BYTE_MAX (UTF_THREE_BYTE_HEADER - 1)
54
55#define UTF_THREE_BYTE_MIN UTF_THREE_BYTE_HEADER
56#define UTF_THREE_BYTE_MAX (UTF_FOUR_BYTE_HEADER - 1)
57
58#define UTF_FOUR_BYTE_MIN UTF_FOUR_BYTE_HEADER
59#define UTF_FOUR_BYTE_MAX ((u8)0xf4)
60
61#define UTF_CONT_CR CharReach(UTF_CONT_MIN, UTF_CONT_MAX)
62#define UTF_ASCII_CR CharReach(0, 127)
63#define UTF_START_CR CharReach(UTF_TWO_BYTE_MIN, UTF_FOUR_BYTE_MAX)
64#define UTF_TWO_START_CR CharReach(UTF_TWO_BYTE_MIN, UTF_TWO_BYTE_MAX)
65#define UTF_THREE_START_CR CharReach(UTF_THREE_BYTE_MIN, UTF_THREE_BYTE_MAX)
66#define UTF_FOUR_START_CR CharReach(UTF_FOUR_BYTE_MIN, UTF_FOUR_BYTE_MAX)
67
68#define UNICODE_SURROGATE_MIN 0xd800
69#define UNICODE_SURROGATE_MAX 0xdfff
70
71#ifdef __cplusplus
72
73namespace ue2 {
74typedef u32 unichar; /* represents a unicode code point */
75
76static UNUSED
77u8 makeContByte(u8 val) {
78 return UTF_CONT_BYTE_HEADER | (val & UTF_CONT_BYTE_VALUE_MASK);
79}
80
81} // namespace
82
83#endif // __cplusplus
84
85#endif
86