include/shwild/shwild.h

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////////
 * File:    shwild/shwild.h
 *
 * Purpose: Root header file for the shwild library
 *
 * Created: 17th June 2005
 * Updated: 15th May 2006
 *
 * Home:    http://shwild.org/
 *
 * Copyright (c) 2005-2006, Matthew Wilson and Sean Kelly
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the names of Matthew Wilson and Sean Kelly nor the names of
 *   any contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * ////////////////////////////////////////////////////////////////////////// */


#ifndef SHWILD_INCL_SHWILD_H_SHWILD
#define SHWILD_INCL_SHWILD_H_SHWILD

/* /////////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef SHWILD_DOCUMENTATION_SKIP_SECTION
# define SHWILD_VER_SHWILD_H_SHWILD_MAJOR       1
# define SHWILD_VER_SHWILD_H_SHWILD_MINOR       1
# define SHWILD_VER_SHWILD_H_SHWILD_REVISION    1
# define SHWILD_VER_SHWILD_H_SHWILD_EDIT        5
#endif /* !SHWILD_DOCUMENTATION_SKIP_SECTION */

#ifndef SHWILD_DOCUMENTATION_SKIP_SECTION
# define SHWILD_VER_0_9_1       0x00090100
# define SHWILD_VER_0_9_2       0x00090200
#endif /* !SHWILD_DOCUMENTATION_SKIP_SECTION */

#define SHWILD_VER_MAJOR    0
#define SHWILD_VER_MINOR    9
#define SHWILD_VER_REVISION 2

#define SHWILD_VER  SHWILD_VER_0_9_2

/* /////////////////////////////////////////////////////////////////////////////
 * Includes
 */

#include <stddef.h>     /* for size_t */

/* /////////////////////////////////////////////////////////////////////////////
 * Documentation
 */

/* /////////////////////////////////////////////////////////////////////////////
 * Typedefs
 */

struct shwild_handle_t_;

typedef struct shwild_handle_t_ *shwild_handle_t;

struct shwild_slice_t
{
    size_t      len;    
    char const  *ptr;   
#ifdef __cplusplus
public:
    shwild_slice_t();
    shwild_slice_t(shwild_slice_t const &rhs);
    shwild_slice_t(size_t n, char const *s);
#endif /* __cplusplus */
};
#ifndef SHWILD_DOCUMENTATION_SKIP_SECTION
typedef struct shwild_slice_t   shwild_slice_t;
#endif /* !SHWILD_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////////
 * Constants and definitions
 */

#define SHWILD_F_SUPPRESS_RANGE_SUPPORT                             (0x0001)    
#define SHWILD_F_SUPPRESS_BACKSLASH_ESCAPE                          (0x0002)    
#define SHWILD_F_SUPPRESS_RANGE_CONTINUUM_SUPPORT                   (0x0004)    
#define SHWILD_F_SUPPRESS_RANGE_CONTINUUM_HIGHLOW_SUPPORT           (0x0008)    
#define SHWILD_F_SUPPRESS_RANGE_CONTINUUM_CROSSCASE_SUPPORT         (0x0010)    
#define SHWILD_F_SUPPRESS_RANGE_LITERAL_WILDCARD_SUPPORT            (0x0020)    
#define SHWILD_F_SUPPRESS_RANGE_LEADTRAIL_LITERAL_HYPHEN_SUPPORT    (0x0040)    
#define SHWILD_F_SUPPRESS_RANGE_NOT_SUPPORT                                                     (0x0400)    
#if 0
#define SHWILD_F_ALLOW_RANGE_LITERAL_BRACKET_SUPPORT                (0x0080)    
#define SHWILD_F_ALLOW_RANGE_QUANTIFICATION_SUPPORT                 (0x0100)    
#endif /* 0 */
#define SHWILD_F_IGNORE_CASE                                        (0x0200)    
#if 0
/* Not currently supported. */
#define SHWILD_F_FNM_PATHNAME_SEMANTICS                             (0x0800)    
#endif /* 0 */

#define SHWILD_RC_SUCCESS               (0)                             
#define SHWILD_RC_ERROR_BASE_           (-2000)
#define SHWILD_RC_ALLOC_ERROR           (SHWILD_RC_ERROR_BASE_ - 1)     
#define SHWILD_RC_PARSE_ERROR           (SHWILD_RC_ERROR_BASE_ - 2)     
/* /////////////////////////////////////////////////////////////////////////////
 * C API
 */

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

int shwild_match(char const *pattern, char const *string, unsigned flags);

int shwild_match_s(shwild_slice_t const *pattern, shwild_slice_t const *string, unsigned flags);

int shwild_compile_pattern(char const *pattern, unsigned flags, shwild_handle_t *phCompiledPattern);

int shwild_compile_pattern_s(shwild_slice_t const *pattern, unsigned flags, shwild_handle_t *phCompiledPattern);

int shwild_match_pattern(shwild_handle_t hCompiledPattern, char const *string);

int shwild_match_pattern_s(shwild_handle_t hCompiledPattern, shwild_slice_t const *string);

void shwild_destroy_pattern(shwild_handle_t hCompiledPattern);

#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */

/* /////////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(__cplusplus) && \
    !defined(SHWILD_DOCUMENTATION_SKIP_SECTION) && \
    !defined(SHWILD_NO_NAMESPACE)
# define SHWILD_NO_NAMESPACE
#endif /* __cplusplus, etc. */

#if !defined(SHWILD_NO_NAMESPACE)

namespace shwild
{
#endif /* !SHWILD_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////////
 * C++ functions
 */

#ifdef __cplusplus

typedef shwild_slice_t  slice_t;

inline int match(char const *pattern, char const *string, unsigned flags = 0)
{
    return shwild_match(pattern, string, flags);
}
inline int compile_pattern(char const *pattern, unsigned flags, shwild_handle_t *phCompiledPattern)
{
    return shwild_compile_pattern(pattern, flags, phCompiledPattern);
}
inline int match_pattern(shwild_handle_t hCompiledPattern, char const *string)
{
    return shwild_match_pattern(hCompiledPattern, string);
}
inline void destroy_pattern(shwild_handle_t hCompiledPattern)
{
    shwild_destroy_pattern(hCompiledPattern);
}

#endif /* __cplusplus */

/* /////////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(SHWILD_NO_NAMESPACE)
} /* namespace shwild */

#endif /* !SHWILD_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////////
 * Implementation
 */

#ifndef SHWILD_DOCUMENTATION_SKIP_SECTION

# ifdef __cplusplus
inline shwild_slice_t::shwild_slice_t()
    : len(0)
    , ptr(NULL)
{}
inline shwild_slice_t::shwild_slice_t(shwild_slice_t const &rhs)
    : len(rhs.len)
    , ptr(rhs.ptr)
{}
inline shwild_slice_t::shwild_slice_t(size_t n, char const *s)
    : len(n)
    , ptr(s)
{}
# endif /* __cplusplus */

#endif /* !SHWILD_DOCUMENTATION_SKIP_SECTION */

/* ////////////////////////////////////////////////////////////////////////// */

#endif /* !SHWILD_INCL_SHWILD_H_SHWILD */

/* ////////////////////////////////////////////////////////////////////////// */

shwild Library documentation © Matthew Wilson and Sean Kelly, 2004-2006