--- /dev/null
+/*
+
+ regexpr.h
+
+ Author: Tatu Ylonen <ylo@ngs.fi>
+
+ Copyright (c) 1991 Tatu Ylonen, Espoo, Finland
+
+ Permission to use, copy, modify, distribute, and sell this software
+ and its documentation is hereby granted without fee, provided that the
+ above copyright notice appears in all source code copies, the name of
+ Tatu Ylonen is not used to advertise products containing this software
+ or a derivation thereof, and all modified versions are clearly marked
+ as such.
+
+ This software is provided "as is" without express or implied warranty.
+
+ Created: Thu Sep 26 17:15:36 1991 ylo
+ Last modified: Fri Jan 3 12:05:45 1992 ylo
+
+ The SILC Regex API by Pekka Riikonen, under the same license as the original
+ code.
+
+*/
+
+/****h* silcutil/SILC Regular Expression Interface
+ *
+ * DESCRIPTION
+ *
+ * SILC regular expression interface provides Unix and POSIX compliant
+ * regular expression compilation and matching.
+ *
+ * EXAMPLE
+ *
+ * SilcRegexStruct reg;
+ *
+ * // Compile regular expression
+ * if (!silc_regex_compile(®, "foo[0-9]*", 0))
+ * error;
+ *
+ * // Match string against the compiled regex
+ * if (!silc_regex_match(®, "foo20", 0, NULL, 0))
+ * no_match;
+ *
+ * // Free the compiled regular expression
+ * silc_regex_free(®);
+ *
+ ***/
+
+#ifndef SILCREGEX_H
+#define SILCREGEX_H
+
+/****s* silcutil/SilcRegexAPI/SilcRegex
+ *
+ * NAME
+ *
+ * typedef struct { ... } *SilcRegex, SilcRegexStruct;
+ *
+ * DESCRIPTION
+ *
+ * The regular expression context. This context is given as argument
+ * to all silc_regex_* functions. It is usually statically allocated
+ * but can be dynamically allocated by silc_malloc.
+ *
+ ***/
+typedef struct SilcRegexObject {
+ char *buffer; /* compiled pattern */
+ int allocated; /* allocated size of compiled pattern */
+ int used; /* actual length of compiled pattern */
+ char *fastmap; /* fastmap[ch] is true if ch can start pattern */
+ char *translate; /* translation to apply during comp/match */
+ char fastmap_accurate; /* true if fastmap is valid */
+ char can_be_null; /* true if can match empty string */
+ char uses_registers; /* registers used and need to be initialized */
+ char anchor; /* anchor: 0=none 1=begline 2=begbuf */
+} *SilcRegex, SilcRegexStruct;
+
+/****s* silcutil/SilcRegexAPI/SilcRegexMatch
+ *
+ * NAME
+ *
+ * typedef struct { ... } *SilcRegexMatch, SilcRegexMatchStruct;
+ *
+ * DESCRIPTION
+ *
+ * The regular expression match context that provides information on the
+ * found match. It provides the start offset and end offset of the
+ * found match.
+ *
+ * SOURCE
+ */
+typedef struct SilcRegexMatchObject {
+ int start; /* Start offset of region */
+ int end; /* End offset of region */
+} *SilcRegexMatch, SilcRegexMatchStruct;
+/***/
+
+/****d* silcutil/SilcRegexAPI/SilcRegexFlags
+ *
+ * NAME
+ *
+ * typedef enum { ... } SilcRegexFlags;
+ *
+ * DESCRIPTION
+ *
+ * Regular expression feature flags.
+ *
+ * SOURCE
+ */
+typedef enum {
+ SILC_REGEX_FLAG_DEFAULT = 0,
+} SilcRegexFlags;
+/***/
+
+/****f* silcutil/SilcRegexAPI/silc_regex_compile
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_regex_compile(SilcRegex regexp, const char *regex,
+ * SilcRegexFlags flags);
+ *
+ * DESCRIPTION
+ *
+ * Compiles the regular expression string `regex'. The `regexp' is a
+ * pre-allocated regular expression context. The `flags' define
+ * various feature flags. This function must be called before the
+ * silc_regex_match can be used to find matches.
+ *
+ * Returns TRUE after the compilation is completed. Returns FALSE on
+ * error and sets silc_errno.
+ *
+ ***/
+SilcBool silc_regex_compile(SilcRegex regexp, const char *regex,
+ SilcRegexFlags flags);
+
+/****f* silcutil/SilcRegexAPI/silc_regex_compile
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_regex_match(SilcRegex regexp, const char *string,
+ * SilcUInt32 num_match, SilcRegexMatch match,
+ * SilcRegexFlags flags);
+ *
+ * DESCRIPTION
+ *
+ * Finds one or more matches from the `string' using the pre-compiled
+ * regular expression `regexp'. It must be compiled by calling the
+ * silc_regex_compile before calling this function. The `flags' defines
+ * various feature flags.
+ *
+ * If only one match is needed the `num_match' may be set to 0 and the
+ * `match' is set to NULL. If multiple matches (substrings) are needed the
+ * `num_match' defines the size of the `match' array, where each of the
+ * matches (with parenthesized regular expression) will be stored. The
+ * `match' provides information on where the match was found in `string',
+ * providing the start offset and end offset of the match. Unused entires
+ * in the array will have -1 as the offset values.
+ *
+ * Returns TRUE if the string matched the regular expression or FALSE
+ * if it did not match or error occurred. The silc_errno will indicate
+ * the error. The silc_errno is set to SILC_ERR_NOT_FOUND if the regular
+ * expression did not match.
+ *
+ * EXAMPLE
+ *
+ * // Find first match (check if string matches)
+ * if (!silc_regex_match(®, "foo20", 0, NULL, 0))
+ * no_match;
+ *
+ * // Find multiple matches, one by one
+ * SilcRegexMatchStruct match;
+ *
+ * while (silc_regex_match(®, string, 1, &match, 0)) {
+ * match_string = silc_memdup(string + match.start,
+ * match.end - match.start);
+ * string += match.end;
+ * }
+ *
+ * // Parse URI into its components, available in the match[] array
+ * SilcRegexStruct reg;
+ * SilcRegexMatchStruct match[7];
+ *
+ * silc_regex_compile(®, "^(([^:]+)://)?([^:/]+)(:([0-9]+))?(/.*)", 0);
+ * silc_regex_match(®, "http://example.com/page.html", 7, match, 0);
+ *
+ ***/
+SilcBool silc_regex_match(SilcRegex regexp, const char *string,
+ SilcUInt32 num_match, SilcRegexMatch match,
+ SilcRegexFlags flags);
+
+/****f* silcutil/SilcRegexAPI/silc_regex_free
+ *
+ * SYNOPSIS
+ *
+ * void silc_regex_free(SilcRegex regexp);
+ *
+ * DESCRIPTION
+ *
+ * Free's the compiled regular expression context `regexp'. This must
+ * be called even if `regexp' is statically allocated. If the
+ * silc_regex_compile has been called this function must be called.
+ *
+ ***/
+void silc_regex_free(SilcRegex regexp);
+
+#endif /* SILCREGEX_H */
projects / crypto.git / blobdiff