1 /*	$NetBSD: ure.h,v 1.3 2021/08/14 16:14:57 christos Exp $	*/
2 
3 /* $OpenLDAP$ */
4 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5  *
6  * Copyright 1998-2021 The OpenLDAP Foundation.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted only as authorized by the OpenLDAP
11  * Public License.
12  *
13  * A copy of this license is available in file LICENSE in the
14  * top-level directory of the distribution or, alternatively, at
15  * <http://www.OpenLDAP.org/license.html>.
16  */
17 /* Copyright 1997, 1998, 1999 Computing Research Labs,
18  * New Mexico State University
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining a
21  * copy of this software and associated documentation files (the "Software"),
22  * to deal in the Software without restriction, including without limitation
23  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
24  * and/or sell copies of the Software, and to permit persons to whom the
25  * Software is furnished to do so, subject to the following conditions:
26  *
27  * The above copyright notice and this permission notice shall be included in
28  * all copies or substantial portions of the Software.
29  *
30  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
33  * THE COMPUTING RESEARCH LAB OR NEW MEXICO STATE UNIVERSITY BE LIABLE FOR ANY
34  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
35  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
36  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37  */
38 /* Id: ure.h,v 1.2 1999/09/21 15:47:44 mleisher Exp  */
39 
40 #ifndef _h_ure
41 #define _h_ure
42 
43 #include <sys/cdefs.h>
44 __RCSID("$NetBSD: ure.h,v 1.3 2021/08/14 16:14:57 christos Exp $");
45 
46 #include "portable.h"
47 
48 
49 #include <stdio.h>
50 
51 LDAP_BEGIN_DECL
52 
53 /*
54  * Set of character class flags.
55  */
56 #define _URE_NONSPACING  0x00000001
57 #define _URE_COMBINING   0x00000002
58 #define _URE_NUMDIGIT    0x00000004
59 #define _URE_NUMOTHER    0x00000008
60 #define _URE_SPACESEP    0x00000010
61 #define _URE_LINESEP     0x00000020
62 #define _URE_PARASEP     0x00000040
63 #define _URE_CNTRL       0x00000080
64 #define _URE_PUA         0x00000100
65 
66 #define _URE_UPPER       0x00000200
67 #define _URE_LOWER       0x00000400
68 #define _URE_TITLE       0x00000800
69 #define _URE_MODIFIER    0x00001000
70 #define _URE_OTHERLETTER 0x00002000
71 #define _URE_DASHPUNCT   0x00004000
72 #define _URE_OPENPUNCT   0x00008000
73 #define _URE_CLOSEPUNCT  0x00010000
74 #define _URE_OTHERPUNCT  0x00020000
75 #define _URE_MATHSYM     0x00040000
76 #define _URE_CURRENCYSYM 0x00080000
77 #define _URE_OTHERSYM    0x00100000
78 
79 #define _URE_LTR         0x00200000
80 #define _URE_RTL         0x00400000
81 
82 #define _URE_EURONUM     0x00800000
83 #define _URE_EURONUMSEP  0x01000000
84 #define _URE_EURONUMTERM 0x02000000
85 #define _URE_ARABNUM     0x04000000
86 #define _URE_COMMONSEP   0x08000000
87 
88 #define _URE_BLOCKSEP    0x10000000
89 #define _URE_SEGMENTSEP  0x20000000
90 
91 #define _URE_WHITESPACE  0x40000000
92 #define _URE_OTHERNEUT   0x80000000
93 
94 /*
95  * Error codes.
96  */
97 #define _URE_OK               0
98 #define _URE_UNEXPECTED_EOS   -1
99 #define _URE_CCLASS_OPEN      -2
100 #define _URE_UNBALANCED_GROUP -3
101 #define _URE_INVALID_PROPERTY -4
102 
103 /*
104  * Options that can be combined for searching.
105  */
106 #define URE_IGNORE_NONSPACING      0x01
107 #define URE_DOT_MATCHES_SEPARATORS 0x02
108 
109 typedef unsigned long ucs4_t;
110 typedef unsigned short ucs2_t;
111 
112 /*
113  * Opaque type for memory used when compiling expressions.
114  */
115 typedef struct _ure_buffer_t *ure_buffer_t;
116 
117 /*
118  * Opaque type for the minimal DFA used when matching.
119  */
120 typedef struct _ure_dfa_t *ure_dfa_t;
121 
122 /*************************************************************************
123  *
124  * API.
125  *
126  *************************************************************************/
127 
128 LDAP_LUNICODE_F (ure_buffer_t) ure_buffer_create LDAP_P((void));
129 
130 LDAP_LUNICODE_F (void) ure_buffer_free LDAP_P((ure_buffer_t buf));
131 
132 LDAP_LUNICODE_F (ure_dfa_t)
133 ure_compile LDAP_P((ucs2_t *re, unsigned long relen,
134 		    int casefold, ure_buffer_t buf));
135 
136 LDAP_LUNICODE_F (void) ure_dfa_free LDAP_P((ure_dfa_t dfa));
137 
138 LDAP_LUNICODE_F (void) ure_write_dfa LDAP_P((ure_dfa_t dfa, FILE *out));
139 
140 LDAP_LUNICODE_F (int)
141 ure_exec LDAP_P((ure_dfa_t dfa, int flags, ucs2_t *text,
142 		 unsigned long textlen, unsigned long *match_start,
143 		 unsigned long *match_end));
144 
145 /*************************************************************************
146  *
147  * Prototypes for stub functions used for URE.  These need to be rewritten to
148  * use the Unicode support available on the system.
149  *
150  *************************************************************************/
151 
152 LDAP_LUNICODE_F (ucs4_t) _ure_tolower LDAP_P((ucs4_t c));
153 
154 LDAP_LUNICODE_F (int)
155 _ure_matches_properties LDAP_P((unsigned long props, ucs4_t c));
156 
157 LDAP_END_DECL
158 
159 #endif /* _h_ure */
160