ICU 57.1  57.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uregex.h
Go to the documentation of this file.
1 /*
2 **********************************************************************
3 * Copyright (C) 2004-2016, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
6 * file name: uregex.h
7 * encoding: US-ASCII
8 * indentation:4
9 *
10 * created on: 2004mar09
11 * created by: Andy Heninger
12 *
13 * ICU Regular Expressions, API for C
14 */
15 
23 #ifndef UREGEX_H
24 #define UREGEX_H
25 
26 #include "unicode/utext.h"
27 #include "unicode/utypes.h"
28 
29 #if !UCONFIG_NO_REGULAR_EXPRESSIONS
30 
31 #include "unicode/localpointer.h"
32 #include "unicode/parseerr.h"
33 
34 struct URegularExpression;
40 typedef struct URegularExpression URegularExpression;
41 
42 
47 typedef enum URegexpFlag{
48 
49 #ifndef U_HIDE_DRAFT_API
50 
53  UREGEX_CANON_EQ = 128,
54 #endif /* U_HIDE_DRAFT_API */
55 
56  UREGEX_CASE_INSENSITIVE = 2,
57 
59  UREGEX_COMMENTS = 4,
60 
63  UREGEX_DOTALL = 32,
64 
75  UREGEX_LITERAL = 16,
76 
81  UREGEX_MULTILINE = 8,
82 
88  UREGEX_UNIX_LINES = 1,
89 
97  UREGEX_UWORD = 256,
98 
106  UREGEX_ERROR_ON_UNKNOWN_ESCAPES = 512
107 
108 } URegexpFlag;
109 
132 U_STABLE URegularExpression * U_EXPORT2
133 uregex_open( const UChar *pattern,
134  int32_t patternLength,
135  uint32_t flags,
136  UParseError *pe,
137  UErrorCode *status);
138 
162 U_STABLE URegularExpression * U_EXPORT2
163 uregex_openUText(UText *pattern,
164  uint32_t flags,
165  UParseError *pe,
166  UErrorCode *status);
167 
191 #if !UCONFIG_NO_CONVERSION
192 U_STABLE URegularExpression * U_EXPORT2
193 uregex_openC( const char *pattern,
194  uint32_t flags,
195  UParseError *pe,
196  UErrorCode *status);
197 #endif
198 
199 
200 
208 U_STABLE void U_EXPORT2
209 uregex_close(URegularExpression *regexp);
210 
211 #if U_SHOW_CPLUSPLUS_API
212 
213 U_NAMESPACE_BEGIN
214 
224 U_DEFINE_LOCAL_OPEN_POINTER(LocalURegularExpressionPointer, URegularExpression, uregex_close);
225 
226 U_NAMESPACE_END
227 
228 #endif
229 
248 U_STABLE URegularExpression * U_EXPORT2
249 uregex_clone(const URegularExpression *regexp, UErrorCode *status);
250 
268 U_STABLE const UChar * U_EXPORT2
269 uregex_pattern(const URegularExpression *regexp,
270  int32_t *patLength,
271  UErrorCode *status);
272 
284 U_STABLE UText * U_EXPORT2
285 uregex_patternUText(const URegularExpression *regexp,
286  UErrorCode *status);
287 
296 U_STABLE int32_t U_EXPORT2
297 uregex_flags(const URegularExpression *regexp,
298  UErrorCode *status);
299 
300 
321 U_STABLE void U_EXPORT2
322 uregex_setText(URegularExpression *regexp,
323  const UChar *text,
324  int32_t textLength,
325  UErrorCode *status);
326 
327 
344 U_STABLE void U_EXPORT2
345 uregex_setUText(URegularExpression *regexp,
346  UText *text,
347  UErrorCode *status);
348 
369 U_STABLE const UChar * U_EXPORT2
370 uregex_getText(URegularExpression *regexp,
371  int32_t *textLength,
372  UErrorCode *status);
373 
390 U_STABLE UText * U_EXPORT2
391 uregex_getUText(URegularExpression *regexp,
392  UText *dest,
393  UErrorCode *status);
394 
420 U_STABLE void U_EXPORT2
421 uregex_refreshUText(URegularExpression *regexp,
422  UText *text,
423  UErrorCode *status);
424 
445 U_STABLE UBool U_EXPORT2
446 uregex_matches(URegularExpression *regexp,
447  int32_t startIndex,
448  UErrorCode *status);
449 
471 U_STABLE UBool U_EXPORT2
472 uregex_matches64(URegularExpression *regexp,
473  int64_t startIndex,
474  UErrorCode *status);
475 
499 U_STABLE UBool U_EXPORT2
500 uregex_lookingAt(URegularExpression *regexp,
501  int32_t startIndex,
502  UErrorCode *status);
503 
528 U_STABLE UBool U_EXPORT2
529 uregex_lookingAt64(URegularExpression *regexp,
530  int64_t startIndex,
531  UErrorCode *status);
532 
552 U_STABLE UBool U_EXPORT2
553 uregex_find(URegularExpression *regexp,
554  int32_t startIndex,
555  UErrorCode *status);
556 
577 U_STABLE UBool U_EXPORT2
578 uregex_find64(URegularExpression *regexp,
579  int64_t startIndex,
580  UErrorCode *status);
581 
595 U_STABLE UBool U_EXPORT2
596 uregex_findNext(URegularExpression *regexp,
597  UErrorCode *status);
598 
606 U_STABLE int32_t U_EXPORT2
607 uregex_groupCount(URegularExpression *regexp,
608  UErrorCode *status);
609 
626 U_STABLE int32_t U_EXPORT2
627 uregex_groupNumberFromName(URegularExpression *regexp,
628  const UChar *groupName,
629  int32_t nameLength,
630  UErrorCode *status);
631 
632 
650 U_STABLE int32_t U_EXPORT2
651 uregex_groupNumberFromCName(URegularExpression *regexp,
652  const char *groupName,
653  int32_t nameLength,
654  UErrorCode *status);
655 
672 U_STABLE int32_t U_EXPORT2
673 uregex_group(URegularExpression *regexp,
674  int32_t groupNum,
675  UChar *dest,
676  int32_t destCapacity,
677  UErrorCode *status);
678 
701 U_STABLE UText * U_EXPORT2
702 uregex_groupUText(URegularExpression *regexp,
703  int32_t groupNum,
704  UText *dest,
705  int64_t *groupLength,
706  UErrorCode *status);
707 
722 U_STABLE int32_t U_EXPORT2
723 uregex_start(URegularExpression *regexp,
724  int32_t groupNum,
725  UErrorCode *status);
726 
742 U_STABLE int64_t U_EXPORT2
743 uregex_start64(URegularExpression *regexp,
744  int32_t groupNum,
745  UErrorCode *status);
746 
760 U_STABLE int32_t U_EXPORT2
761 uregex_end(URegularExpression *regexp,
762  int32_t groupNum,
763  UErrorCode *status);
764 
779 U_STABLE int64_t U_EXPORT2
780 uregex_end64(URegularExpression *regexp,
781  int32_t groupNum,
782  UErrorCode *status);
783 
797 U_STABLE void U_EXPORT2
798 uregex_reset(URegularExpression *regexp,
799  int32_t index,
800  UErrorCode *status);
801 
816 U_STABLE void U_EXPORT2
817 uregex_reset64(URegularExpression *regexp,
818  int64_t index,
819  UErrorCode *status);
820 
841 U_STABLE void U_EXPORT2
842 uregex_setRegion(URegularExpression *regexp,
843  int32_t regionStart,
844  int32_t regionLimit,
845  UErrorCode *status);
846 
868 U_STABLE void U_EXPORT2
869 uregex_setRegion64(URegularExpression *regexp,
870  int64_t regionStart,
871  int64_t regionLimit,
872  UErrorCode *status);
873 
888 U_STABLE void U_EXPORT2
889 uregex_setRegionAndStart(URegularExpression *regexp,
890  int64_t regionStart,
891  int64_t regionLimit,
892  int64_t startIndex,
893  UErrorCode *status);
894 
904 U_STABLE int32_t U_EXPORT2
905 uregex_regionStart(const URegularExpression *regexp,
906  UErrorCode *status);
907 
918 U_STABLE int64_t U_EXPORT2
919 uregex_regionStart64(const URegularExpression *regexp,
920  UErrorCode *status);
921 
932 U_STABLE int32_t U_EXPORT2
933 uregex_regionEnd(const URegularExpression *regexp,
934  UErrorCode *status);
935 
947 U_STABLE int64_t U_EXPORT2
948 uregex_regionEnd64(const URegularExpression *regexp,
949  UErrorCode *status);
950 
961 U_STABLE UBool U_EXPORT2
962 uregex_hasTransparentBounds(const URegularExpression *regexp,
963  UErrorCode *status);
964 
965 
985 U_STABLE void U_EXPORT2
986 uregex_useTransparentBounds(URegularExpression *regexp,
987  UBool b,
988  UErrorCode *status);
989 
990 
1000 U_STABLE UBool U_EXPORT2
1001 uregex_hasAnchoringBounds(const URegularExpression *regexp,
1002  UErrorCode *status);
1003 
1004 
1018 U_STABLE void U_EXPORT2
1019 uregex_useAnchoringBounds(URegularExpression *regexp,
1020  UBool b,
1021  UErrorCode *status);
1022 
1033 U_STABLE UBool U_EXPORT2
1034 uregex_hitEnd(const URegularExpression *regexp,
1035  UErrorCode *status);
1036 
1048 U_STABLE UBool U_EXPORT2
1049 uregex_requireEnd(const URegularExpression *regexp,
1050  UErrorCode *status);
1051 
1052 
1053 
1054 
1055 
1080 U_STABLE int32_t U_EXPORT2
1081 uregex_replaceAll(URegularExpression *regexp,
1082  const UChar *replacementText,
1083  int32_t replacementLength,
1084  UChar *destBuf,
1085  int32_t destCapacity,
1086  UErrorCode *status);
1087 
1109 U_STABLE UText * U_EXPORT2
1110 uregex_replaceAllUText(URegularExpression *regexp,
1111  UText *replacement,
1112  UText *dest,
1113  UErrorCode *status);
1114 
1139 U_STABLE int32_t U_EXPORT2
1140 uregex_replaceFirst(URegularExpression *regexp,
1141  const UChar *replacementText,
1142  int32_t replacementLength,
1143  UChar *destBuf,
1144  int32_t destCapacity,
1145  UErrorCode *status);
1146 
1168 U_STABLE UText * U_EXPORT2
1169 uregex_replaceFirstUText(URegularExpression *regexp,
1170  UText *replacement,
1171  UText *dest,
1172  UErrorCode *status);
1173 
1220 U_STABLE int32_t U_EXPORT2
1221 uregex_appendReplacement(URegularExpression *regexp,
1222  const UChar *replacementText,
1223  int32_t replacementLength,
1224  UChar **destBuf,
1225  int32_t *destCapacity,
1226  UErrorCode *status);
1227 
1250 U_STABLE void U_EXPORT2
1251 uregex_appendReplacementUText(URegularExpression *regexp,
1252  UText *replacementText,
1253  UText *dest,
1254  UErrorCode *status);
1255 
1280 U_STABLE int32_t U_EXPORT2
1281 uregex_appendTail(URegularExpression *regexp,
1282  UChar **destBuf,
1283  int32_t *destCapacity,
1284  UErrorCode *status);
1285 
1304 U_STABLE UText * U_EXPORT2
1305 uregex_appendTailUText(URegularExpression *regexp,
1306  UText *dest,
1307  UErrorCode *status);
1308 
1360 U_STABLE int32_t U_EXPORT2
1361 uregex_split( URegularExpression *regexp,
1362  UChar *destBuf,
1363  int32_t destCapacity,
1364  int32_t *requiredCapacity,
1365  UChar *destFields[],
1366  int32_t destFieldsCapacity,
1367  UErrorCode *status);
1368 
1395 U_STABLE int32_t U_EXPORT2
1396 uregex_splitUText(URegularExpression *regexp,
1397  UText *destFields[],
1398  int32_t destFieldsCapacity,
1399  UErrorCode *status);
1400 
1423 U_STABLE void U_EXPORT2
1424 uregex_setTimeLimit(URegularExpression *regexp,
1425  int32_t limit,
1426  UErrorCode *status);
1427 
1437 U_STABLE int32_t U_EXPORT2
1438 uregex_getTimeLimit(const URegularExpression *regexp,
1439  UErrorCode *status);
1440 
1461 U_STABLE void U_EXPORT2
1462 uregex_setStackLimit(URegularExpression *regexp,
1463  int32_t limit,
1464  UErrorCode *status);
1465 
1473 U_STABLE int32_t U_EXPORT2
1474 uregex_getStackLimit(const URegularExpression *regexp,
1475  UErrorCode *status);
1476 
1477 
1496 U_CDECL_BEGIN
1497 typedef UBool U_CALLCONV URegexMatchCallback (
1498  const void *context,
1499  int32_t steps);
1500 U_CDECL_END
1501 
1516 U_STABLE void U_EXPORT2
1517 uregex_setMatchCallback(URegularExpression *regexp,
1518  URegexMatchCallback *callback,
1519  const void *context,
1520  UErrorCode *status);
1521 
1522 
1534 U_STABLE void U_EXPORT2
1535 uregex_getMatchCallback(const URegularExpression *regexp,
1536  URegexMatchCallback **callback,
1537  const void **context,
1538  UErrorCode *status);
1539 
1570 U_CDECL_BEGIN
1571 typedef UBool U_CALLCONV URegexFindProgressCallback (
1572  const void *context,
1573  int64_t matchIndex);
1574 U_CDECL_END
1575 
1576 
1588 U_STABLE void U_EXPORT2
1589 uregex_setFindProgressCallback(URegularExpression *regexp,
1590  URegexFindProgressCallback *callback,
1591  const void *context,
1592  UErrorCode *status);
1593 
1605 U_STABLE void U_EXPORT2
1606 uregex_getFindProgressCallback(const URegularExpression *regexp,
1607  URegexFindProgressCallback **callback,
1608  const void **context,
1609  UErrorCode *status);
1610 
1611 #endif /* !UCONFIG_NO_REGULAR_EXPRESSIONS */
1612 #endif /* UREGEX_H */
Generated on Wed Mar 16 2016 23:45:45 for ICU 57.1 by   doxygen 1.8.1.2