/** BEGIN COPYRIGHT BLOCK
 * Copyright 2001 Sun Microsystems, Inc.
 * Portions copyright 1999, 2001-2003 Netscape Communications Corporation.
 * All rights reserved.
 * END COPYRIGHT BLOCK **/
/*
 * shexp.h: Defines and prototypes for shell exp. match routines
 * 
 *
 * This routine will match a string with a shell expression. The expressions
 * accepted are based loosely on the expressions accepted by zsh.
 * 
 * o * matches anything
 * o ? matches one character
 * o \ will escape a special character
 * o $ matches the end of the string
 * o [abc] matches one occurence of a, b, or c. The only character that needs
 *         to be escaped in this is ], all others are not special.
 * o [a-z] matches any character between a and z
 * o [^az] matches any character except a or z
 * o ~ followed by another shell expression will remove any pattern
 *     matching the shell expression from the match list
 * o (foo|bar) will match either the substring foo, or the substring bar.
 *             These can be shell expressions as well.
 * 
 * The public interface to these routines is documented below.
 * 
 * Rob McCool
 * 
 */

#ifndef SHEXP_H
#define SHEXP_H

/*
 * Requires that the macro MALLOC be set to a "safe" malloc that will 
 * exit if no memory is available. If not under MCC httpd, define MALLOC
 * to be the real malloc and play with fire, or make your own function.
 */

#include "../netsite.h"

#include <ctype.h>  /* isalnum */
#include <string.h> /* strlen */


/*
 * Wrappers for shexp/regexp
 *
 * Portions of code that explicitly want to have either shexp's
 * or regexp's should call those functions directly.
 *
 * Common code bases for multiple products should use the following
 * macros instead to use either shell or regular expressions,
 * depending on the flavor chosen for a given server.
 *
 */
#if defined(MCC_PROXY) && defined(USE_REGEX)

#include "base/regexp.h"

#define WILDPAT_VALID(exp)		regexp_valid(exp)
#define WILDPAT_MATCH(str, exp)		regexp_match(str, exp)
#define WILDPAT_CMP(str, exp)		regexp_cmp(str, exp)
#define WILDPAT_CASECMP(str, exp)	regexp_casecmp(str, exp)

#else	/* HTTP servers */

#define WILDPAT_VALID(exp)		shexp_valid(exp)
#define WILDPAT_MATCH(str, exp)		shexp_match(str, exp)
#define WILDPAT_CMP(str, exp)		shexp_cmp(str, exp)
#define WILDPAT_CASECMP(str, exp)	shexp_casecmp(str, exp)

#endif


/* --------------------------- Public routines ---------------------------- */

NSPR_BEGIN_EXTERN_C

/*
 * shexp_valid takes a shell expression exp as input. It returns:
 * 
 *  NON_SXP      if exp is a standard string
 *  INVALID_SXP  if exp is a shell expression, but invalid
 *  VALID_SXP    if exp is a valid shell expression
 */

#define NON_SXP -1
#define INVALID_SXP -2
#define VALID_SXP 1

/* and generic shexp/regexp versions */
#define NON_WILDPAT     NON_SXP
#define INVALID_WILDPAT INVALID_SXP
#define VALID_WILDPAT   VALID_SXP

/* and regexp versions */
#define NON_REGEXP      NON_SXP
#define INVALID_REGEXP  INVALID_SXP
#define VALID_REGEXP    VALID_SXP


NSAPI_PUBLIC int shexp_valid(char *exp);

/*
 * shexp_match 
 * 
 * Takes a prevalidated shell expression exp, and a string str.
 *
 * Returns 0 on match and 1 on non-match.
 */

NSAPI_PUBLIC int shexp_match(char *str, char *exp);


/*
 * shexp_cmp
 * 
 * Same as above, but validates the exp first. 0 on match, 1 on non-match,
 * -1 on invalid exp. shexp_casecmp does the same thing but is case 
 * insensitive.
 */

NSAPI_PUBLIC int shexp_cmp(char *str, char *exp);
NSAPI_PUBLIC int shexp_casecmp(char *str, char *exp);

NSPR_END_EXTERN_C

#endif