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