plugins/include/regex.inc
author David Anderson <dvander@alliedmods.net>
Sun Apr 06 08:20:02 2008 +0000 (2008-04-06)
changeset 1970 316eff8d8164
parent 1952 b7aa2b626807
child 1987 0534b0a2ffda
permissions -rw-r--r--
added regex versioning to windows
ds@1952
     1
#if defined _regex_included
ds@1952
     2
  #endinput
ds@1952
     3
#endif
ds@1952
     4
#define _regex_included
ds@1952
     5
ds@1952
     6
/**
ds@1952
     7
 * @section 	Flags for compiling regex expressions.  These come directly from the 
ds@1952
     8
 * pcre library and can be used in MatchRegex and CompileRegex.
ds@1952
     9
 */
ds@1952
    10
#define PCRE_CASELESS           0x00000001 /* Ignore Case */
ds@1952
    11
#define PCRE_MULTILINE          0x00000002 /* Multilines (affects ^ and $ so that they match the start/end of a line rather than matching the start/end of the string). */
ds@1952
    12
#define PCRE_DOTALL             0x00000004 /* Single line (affects . so that it matches any character, even new line characters). */
ds@1952
    13
#define PCRE_EXTENDED           0x00000008 /* Pattern extension (ignore whitespace and # comments). */
ds@1952
    14
#define PCRE_UNGREEDY           0x00000200 /* Invert greediness of quantifiers */
ds@1952
    15
#define PCRE_UTF8               0x00000800 /* Use UTF-8 Chars */
ds@1952
    16
#define PCRE_NO_UTF8_CHECK      0x00002000 /* Do not check the pattern for UTF-8 validity (only relevant if PCRE_UTF8 is set) */
ds@1952
    17
ds@1952
    18
ds@1952
    19
/**
ds@1952
    20
 * Regex expression error codes.
ds@1952
    21
 */
ds@1952
    22
enum RegexError
ds@1952
    23
{
ds@1952
    24
	REGEX_ERROR_NONE = 0,				/* No error */
ds@1952
    25
	REGEX_ERROR_NOMATCH = -1,			/* No match was found */
ds@1952
    26
	REGEX_ERROR_NULL = -2,
ds@1952
    27
	REGEX_ERROR_BADOPTION = -3,
ds@1952
    28
	REGEX_ERROR_BADMAGIC = -4,
ds@1952
    29
	REGEX_ERROR_UNKNOWN_OPCODE = -5,
ds@1952
    30
	REGEX_ERROR_NOMEMORY = -6,
ds@1952
    31
	REGEX_ERROR_NOSUBSTRING = -7,
ds@1952
    32
	REGEX_ERROR_MATCHLIMIT = -8,
ds@1952
    33
	REGEX_ERROR_CALLOUT = -9,  			/* Never used by PCRE itself */
ds@1952
    34
	REGEX_ERROR_BADUTF8 = -10,
ds@1952
    35
	REGEX_ERROR_BADUTF8_OFFSET = -11,
ds@1952
    36
	REGEX_ERROR_PARTIAL = -12,
ds@1952
    37
	REGEX_ERROR_BADPARTIAL = -13,
ds@1952
    38
	REGEX_ERROR_INTERNAL = -14,
ds@1952
    39
	REGEX_ERROR_BADCOUNT = -15,
ds@1952
    40
	REGEX_ERROR_DFA_UITEM = -16,
ds@1952
    41
	REGEX_ERROR_DFA_UCOND = -17,
ds@1952
    42
	REGEX_ERROR_DFA_UMLIMIT = -18,
ds@1952
    43
	REGEX_ERROR_DFA_WSSIZE = -19,
ds@1952
    44
	REGEX_ERROR_DFA_RECURSE = -20,
ds@1952
    45
	REGEX_ERROR_RECURSIONLIMIT = -21,
ds@1952
    46
	REGEX_ERROR_NULLWSLIMIT = -22,  	/* No longer actually used */
ds@1952
    47
	REGEX_ERROR_BADNEWLINE = -23
ds@1952
    48
}
ds@1952
    49
ds@1952
    50
/**
ds@1952
    51
 * Precompile a regular expression.  Use this if you intend on using the 
ds@1952
    52
 * same expression multiple times.  Pass the regex handle returned here to
ds@1952
    53
 * MatchRegex to check for matches.
ds@1952
    54
 *
ds@1952
    55
 * @param pattern		The regular expression pattern.
ds@1952
    56
 * @param flags			General flags for the regular expression.
ds@1952
    57
 * @param error			Error message encountered, if applicable.
ds@1952
    58
 * @param maxLen		Maximum string length of the error buffer.
ds@1952
    59
 * @param errcode		Regex type error code encountered, if applicable.
ds@1952
    60
 * @return				Valid regex handle on success, INVALID_HANDLE on failure.
ds@1952
    61
 */
ds@1952
    62
native Handle:CompileRegex(const String:pattern[], flags = 0, String:error[]="", maxLen = 0, &RegexError:errcode = REGEX_ERROR_NONE);
ds@1952
    63
ds@1952
    64
/**
ds@1952
    65
 * Matches a string against a pre-compiled regular expression pattern.
ds@1952
    66
 *
ds@1952
    67
 * @param str			The string to check.
ds@1952
    68
 * @param regex			Regex Handle from CompileRegex()
ds@1952
    69
 * @param ret			Error code, if applicable.
ds@1952
    70
 * @return				Number of substrings found or -1 on failure.
ds@1952
    71
 *
ds@1952
    72
 * @note				Use the regex handle passed to this function to extract
ds@1952
    73
 *						matches with GetRegexSubString().
ds@1952
    74
 */
ds@1952
    75
native MatchRegex(Handle:regex, const String:str[], &RegexError:ret = REGEX_ERROR_NONE);
ds@1952
    76
ds@1952
    77
/**
ds@1952
    78
 * Returns a matched substring from a regex handle.
ds@1952
    79
 * Substring ids start at 0 and end at substrings-1, where substrings is the number returned 
ds@1952
    80
 * by MatchRegex
ds@1952
    81
 *
ds@1952
    82
 * @param regex			The regex handle to extract data from.
ds@1952
    83
 * @param str_id		The index of the expression to get - starts at 0, and ends at substrings - 1.
ds@1952
    84
 * @param buffer		The buffer to set to the matching substring.
ds@1952
    85
 * @param maxLen		The maximum string length of the buffer.
ds@1952
    86
 * @return				True if a substring was found, False on fail/error
ds@1952
    87
 */
ds@1952
    88
native bool:GetRegexSubString(Handle:regex, str_id, String:buffer[], maxlen);
ds@1952
    89
ds@1952
    90
/**
ds@1952
    91
 * Matches a string against a regular expression pattern.
ds@1952
    92
 *
ds@1952
    93
 * @note				If you intend on using the same regular expression pattern
ds@1952
    94
 *						multiple times, consider using CompileRegex and MatchRegex 
ds@1952
    95
 *						instead of making this function reparse the expression each time.
ds@1952
    96
 *
ds@1952
    97
 * @param str			The string to check.
ds@1952
    98
 * @param pattern		The regular expression pattern.
ds@1952
    99
 * @param flags			General flags for the regular expression.
ds@1952
   100
 * @param error			Error message, if applicable.
ds@1952
   101
 * @param maxLen		Maximum length of the error buffer.
ds@1952
   102
 * @return				Number of substrings found or -1 on failure.
ds@1952
   103
 */
ds@1952
   104
stock SimpleRegexMatch(const String:str[], const String:pattern[], flags = 0, String:error[]="", maxLen = 0)
ds@1952
   105
{
ds@1952
   106
	new Handle:regex = CompileRegex(pattern, flags, error, maxLen);
ds@1952
   107
	
ds@1952
   108
	if (regex == INVALID_HANDLE)
ds@1952
   109
	{
ds@1952
   110
		return -1;	
ds@1952
   111
	}
ds@1952
   112
	
ds@1952
   113
	new substrings = MatchRegex(regex, str);
ds@1952
   114
	
ds@1952
   115
	CloseHandle(regex);
ds@1952
   116
	
ds@1952
   117
	return substrings;	
ds@1952
   118
}
ds@1952
   119
ds@1952
   120
/**
ds@1952
   121
 * @endsection
ds@1952
   122
 */
ds@1952
   123
ds@1952
   124
/**
ds@1952
   125
 * Do not edit below this line!
ds@1952
   126
 */
ds@1952
   127
public Extension:__ext_regex = 
ds@1952
   128
{
ds@1952
   129
	name = "Regex Extension",
ds@1952
   130
	file = "regex.ext",
ds@1952
   131
#if defined AUTOLOAD_EXTENSIONS
ds@1952
   132
	autoload = 1,
ds@1952
   133
#else
ds@1952
   134
	autoload = 0,
ds@1952
   135
#endif
ds@1952
   136
#if defined REQUIRE_EXTENSIONS
ds@1952
   137
	required = 1,
ds@1952
   138
#else
ds@1952
   139
	required = 0,
ds@1952
   140
#endif
ds@1952
   141
};