ds@1987: /**
ds@1987: * vim: set ts=4 :
ds@1987: * =============================================================================
ds@1987: * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
ds@1987: * =============================================================================
ds@1987: *
ds@1987: * This file is part of the SourceMod/SourcePawn SDK.
ds@1987: *
ds@1987: * This program is free software; you can redistribute it and/or modify it under
ds@1987: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1987: * Free Software Foundation.
ds@1987: *
ds@1987: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1987: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1987: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1987: * details.
ds@1987: *
ds@1987: * You should have received a copy of the GNU General Public License along with
ds@1987: * this program. If not, see .
ds@1987: *
ds@1987: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1987: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1987: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1987: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1987: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1987: * this exception to all derivative works. AlliedModders LLC defines further
ds@1987: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1987: * or .
ds@1987: *
ds@1987: * Version: $Id$
ds@1987: */
ds@1987:
pred@1842: #if defined _regex_included
pred@1842: #endinput
pred@1842: #endif
pred@1842: #define _regex_included
pred@1842:
pred@1842: /**
pred@1842: * @section Flags for compiling regex expressions. These come directly from the
pred@1842: * pcre library and can be used in MatchRegex and CompileRegex.
pred@1842: */
pred@1842: #define PCRE_CASELESS 0x00000001 /* Ignore Case */
pred@1842: #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). */
pred@1842: #define PCRE_DOTALL 0x00000004 /* Single line (affects . so that it matches any character, even new line characters). */
pred@1842: #define PCRE_EXTENDED 0x00000008 /* Pattern extension (ignore whitespace and # comments). */
pred@1842: #define PCRE_UNGREEDY 0x00000200 /* Invert greediness of quantifiers */
pred@1842: #define PCRE_UTF8 0x00000800 /* Use UTF-8 Chars */
pred@1842: #define PCRE_NO_UTF8_CHECK 0x00002000 /* Do not check the pattern for UTF-8 validity (only relevant if PCRE_UTF8 is set) */
pred@1842:
pred@1842:
pred@1842: /**
pred@1842: * Regex expression error codes.
pred@1842: */
pred@1842: enum RegexError
pred@1842: {
pred@1842: REGEX_ERROR_NONE = 0, /* No error */
pred@1842: REGEX_ERROR_NOMATCH = -1, /* No match was found */
pred@1842: REGEX_ERROR_NULL = -2,
pred@1842: REGEX_ERROR_BADOPTION = -3,
pred@1842: REGEX_ERROR_BADMAGIC = -4,
pred@1842: REGEX_ERROR_UNKNOWN_OPCODE = -5,
pred@1842: REGEX_ERROR_NOMEMORY = -6,
pred@1842: REGEX_ERROR_NOSUBSTRING = -7,
pred@1842: REGEX_ERROR_MATCHLIMIT = -8,
pred@1842: REGEX_ERROR_CALLOUT = -9, /* Never used by PCRE itself */
pred@1842: REGEX_ERROR_BADUTF8 = -10,
pred@1842: REGEX_ERROR_BADUTF8_OFFSET = -11,
pred@1842: REGEX_ERROR_PARTIAL = -12,
pred@1842: REGEX_ERROR_BADPARTIAL = -13,
pred@1842: REGEX_ERROR_INTERNAL = -14,
pred@1842: REGEX_ERROR_BADCOUNT = -15,
pred@1842: REGEX_ERROR_DFA_UITEM = -16,
pred@1842: REGEX_ERROR_DFA_UCOND = -17,
pred@1842: REGEX_ERROR_DFA_UMLIMIT = -18,
pred@1842: REGEX_ERROR_DFA_WSSIZE = -19,
pred@1842: REGEX_ERROR_DFA_RECURSE = -20,
pred@1842: REGEX_ERROR_RECURSIONLIMIT = -21,
pred@1842: REGEX_ERROR_NULLWSLIMIT = -22, /* No longer actually used */
pred@1842: REGEX_ERROR_BADNEWLINE = -23
pred@2018: };
pred@1842:
pred@1842: /**
pred@1842: * Precompile a regular expression. Use this if you intend on using the
pred@1842: * same expression multiple times. Pass the regex handle returned here to
pred@1842: * MatchRegex to check for matches.
pred@1842: *
pred@1842: * @param pattern The regular expression pattern.
pred@1842: * @param flags General flags for the regular expression.
pred@1842: * @param error Error message encountered, if applicable.
pred@1842: * @param maxLen Maximum string length of the error buffer.
pred@1842: * @param errcode Regex type error code encountered, if applicable.
pred@1842: * @return Valid regex handle on success, INVALID_HANDLE on failure.
pred@1842: */
pred@1842: native Handle:CompileRegex(const String:pattern[], flags = 0, String:error[]="", maxLen = 0, &RegexError:errcode = REGEX_ERROR_NONE);
pred@1842:
pred@1842: /**
pred@1842: * Matches a string against a pre-compiled regular expression pattern.
pred@1842: *
pred@1842: * @param str The string to check.
pred@1842: * @param regex Regex Handle from CompileRegex()
pred@1842: * @param ret Error code, if applicable.
pred@1842: * @return Number of substrings found or -1 on failure.
pred@1842: *
pred@1842: * @note Use the regex handle passed to this function to extract
pred@1842: * matches with GetRegexSubString().
pred@1842: */
pred@1842: native MatchRegex(Handle:regex, const String:str[], &RegexError:ret = REGEX_ERROR_NONE);
pred@1842:
pred@1842: /**
pred@1842: * Returns a matched substring from a regex handle.
pred@1842: * Substring ids start at 0 and end at substrings-1, where substrings is the number returned
pred@1842: * by MatchRegex
pred@1842: *
pred@1842: * @param regex The regex handle to extract data from.
pred@1842: * @param str_id The index of the expression to get - starts at 0, and ends at substrings - 1.
pred@1842: * @param buffer The buffer to set to the matching substring.
pred@1842: * @param maxLen The maximum string length of the buffer.
pred@1842: * @return True if a substring was found, False on fail/error
pred@1842: */
pred@1842: native bool:GetRegexSubString(Handle:regex, str_id, String:buffer[], maxlen);
pred@1842:
pred@1842: /**
pred@1842: * Matches a string against a regular expression pattern.
pred@1842: *
pred@1842: * @note If you intend on using the same regular expression pattern
pred@1842: * multiple times, consider using CompileRegex and MatchRegex
pred@1842: * instead of making this function reparse the expression each time.
pred@1842: *
pred@1842: * @param str The string to check.
pred@1842: * @param pattern The regular expression pattern.
pred@1842: * @param flags General flags for the regular expression.
pred@1842: * @param error Error message, if applicable.
pred@1842: * @param maxLen Maximum length of the error buffer.
pred@1842: * @return Number of substrings found or -1 on failure.
pred@1842: */
pred@1842: stock SimpleRegexMatch(const String:str[], const String:pattern[], flags = 0, String:error[]="", maxLen = 0)
pred@1842: {
pred@1842: new Handle:regex = CompileRegex(pattern, flags, error, maxLen);
pred@1842:
pred@1842: if (regex == INVALID_HANDLE)
pred@1842: {
pred@1842: return -1;
pred@1842: }
pred@1842:
pred@1842: new substrings = MatchRegex(regex, str);
pred@1842:
pred@1842: CloseHandle(regex);
pred@1842:
pred@1842: return substrings;
pred@1842: }
pred@1842:
pred@1842: /**
pred@1842: * @endsection
pred@1842: */
pred@1842:
pred@1842: /**
pred@1842: * Do not edit below this line!
pred@1842: */
pred@1842: public Extension:__ext_regex =
pred@1842: {
pred@1842: name = "Regex Extension",
pred@1842: file = "regex.ext",
pred@1842: #if defined AUTOLOAD_EXTENSIONS
pred@1842: autoload = 1,
pred@1842: #else
pred@1842: autoload = 0,
pred@1842: #endif
pred@1842: #if defined REQUIRE_EXTENSIONS
pred@1842: required = 1,
pred@1842: #else
pred@1842: required = 0,
pred@1842: #endif
pred@1842: };