gecko-dev/modules/libjar/nsWildCard.h

102 lines
2.9 KiB
C
Raw Normal View History

2001-09-20 00:02:59 +00:00
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1999-09-09 04:54:56 +00:00
*
2001-09-20 00:02:59 +00:00
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
2001-09-20 00:02:59 +00:00
* the License at http://www.mozilla.org/NPL/
1999-09-09 04:54:56 +00:00
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
1999-09-09 04:54:56 +00:00
*
* The Original Code is mozilla.org code.
*
2001-09-20 00:02:59 +00:00
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
2001-09-20 00:02:59 +00:00
* Contributor(s):
*/
1999-09-09 04:54:56 +00:00
/*
* 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 nsWildCard_h__
#define nsWildCard_h__
1999-09-09 04:54:56 +00:00
#include "prtypes.h"
1999-09-09 04:54:56 +00:00
#include <ctype.h> /* isalnum */
#include <string.h> /* strlen */
/* --------------------------- Public routines ---------------------------- */
/*
* NS_WildCardValid takes a shell expression exp as input. It returns:
1999-09-09 04:54:56 +00:00
*
* 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
extern int NS_WildCardValid(char *expr);
1999-09-09 04:54:56 +00:00
/* return values for the search routines */
#define MATCH 0
#define NOMATCH 1
#define ABORTED -1
/*
* NS_WildCardMatch
1999-09-09 04:54:56 +00:00
*
* Takes a prevalidated shell expression exp, and a string str.
*
* Returns 0 on match and 1 on non-match.
*/
extern int NS_WildCardMatch(char *str, char *expr, PRBool case_insensitive);
1999-09-09 04:54:56 +00:00
/*
* Same as above, but validates the exp first. 0 on match, 1 on non-match,
* -1 on invalid exp.
*/
extern int NS_WildCardSearch(char *str, char *expr);
1999-09-09 04:54:56 +00:00
/*
* Same as above but uses case insensitive search.
1999-09-09 04:54:56 +00:00
*/
extern int NS_WildCardCaseSearch(char *str, char *expr);
1999-09-09 04:54:56 +00:00
#endif /* nsWildCard_h__ */