gecko-dev/xpcom/io/nsWildCard.h
2009-05-13 20:22:54 -07:00

97 lines
3.3 KiB
C

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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 the License at
* http://www.mozilla.org/MPL/
*
* 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.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* nsWildCard.h: Defines and prototypes for shell exp. match routines
*
* See nsIZipReader.findEntries docs in nsIZipReader.idl for a description of
* the supported expression syntax.
*
* Note that the syntax documentation explicitly says the results of certain
* expressions are undefined. This is intentional to require less robustness
* in the code. Regular expression parsing is hard; the smaller the set of
* features and interactions this code must support, the easier it is to
* ensure it works.
*
*/
#ifndef nsWildCard_h__
#define nsWildCard_h__
#include "prtypes.h"
#include "nscore.h"
/* --------------------------- Public routines ---------------------------- */
/*
* NS_WildCardValid 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
NS_COM int NS_WildCardValid(const char *expr);
NS_COM int NS_WildCardValid(const PRUnichar *expr);
/* return values for the search routines */
#define MATCH 0
#define NOMATCH 1
#define ABORTED -1
/*
* NS_WildCardMatch
*
* Takes a prevalidated shell expression exp, and a string str.
*
* Returns 0 on match and 1 on non-match.
*/
NS_COM int NS_WildCardMatch(const char *str, const char *expr,
PRBool case_insensitive);
NS_COM int NS_WildCardMatch(const PRUnichar *str, const PRUnichar *expr,
PRBool case_insensitive);
#endif /* nsWildCard_h__ */