ose_match.h

Go to the documentation of this file.

/*
Written by John MacCallum, The Center for New Music and Audio
Technologies, University of California, Berkeley.  Copyright (c)
2009, The Regents of the University of California (Regents).
Permission to use, copy, modify, distribute, and distribute
modified versions of this software and its documentation without
fee and without a signed licensing agreement, is hereby granted,
provided that the above copyright notice, this paragraph and the
following two paragraphs appear in all copies, modifications, and
distributions.
 
IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT,
INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE
AND ITS DOCUMENTATION, EVEN IF REGENTS HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
 
REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE. THE SOFTWARE AND ACCOMPANYING
DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS
IS". REGENTS HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*/
 
#ifndef OSE_MATCH_H
#define OSE_MATCH_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OSE_MATCH_BACKTRACK_LIMIT 100
 
#define OSE_MATCH_ENABLE_2STARS     1
 
#define OSE_MATCH_ENABLE_NSTARS     1
 
#define OSE_MATCH_ALLOW_STAR_IN_ADDRESS
 
#define OSE_MATCH_DESCENDANTS
 
/* The repetition operators, '#' and '##'.
 
   This was never defined anywhere -- not in a header, a Makefile, or the
   Xcode project -- while only 6 of the 19 sites in ose_match.c that handle
   '#' were inside the #ifdef. So the operator has been running in a
   half-compiled state: the gated half never built, the ungated half always
   did, and turning the option off did nothing. */
#define OSE_MATCH_REPETITION
 
enum ose_match_retval
{
    OSE_MATCH_NOMATCH = 0,
    OSE_MATCH_ADDRESS_COMPLETE,
    OSE_MATCH_PATTERN_COMPLETE,
    OSE_MATCH_BOTH_COMPLETE,
    OSE_MATCH_ERROR_UNMATCHED_LEFT_SQUARE_BRACKET,
    OSE_MATCH_ERROR_UNMATCHED_RIGHT_SQUARE_BRACKET,
    OSE_MATCH_ERROR_UNMATCHED_LEFT_CURLY_BRACE,
    OSE_MATCH_ERROR_UNMATCHED_RIGHT_CURLY_BRACE,
    OSE_MATCH_ERROR_PATTERN_NO_LEADING_SLASH,
    OSE_MATCH_ERROR_ADDRESS_NO_LEADING_SLASH,
    OSE_MATCH_ERROR_INVALID_CHARACTER_CLASS,
    OSE_MATCH_ERROR_BACKTRACK_LIMIT_EXCEEDED,
    OSE_MATCH_ERROR_INVALID_REPETITION
};
 
enum ose_match_retval ose_match_pattern(const char * const pattern,
                                        const char * const address,
                                        int32_t *pattern_offset,
                                        int32_t *address_offset);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OSE_MATCH_H */