Home

Libraries

Author

Links

---

match.h

Go to the documentation of this file.

/* ***** 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 the SysToMath C Libraries package (LibStmC).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 1989-2006
 * 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 ***** */

/******************************************************************************
 *                       First Release 1989-03-15
 ******************************************************************************/


#ifndef STM_MATCH_H
#define STM_MATCH_H


/* Include header files and macro definitions. */
#include <stm/internal/_match.h>


#ifdef __cplusplus
extern "C"
{
#endif


StmAbstractType (StmRe)  /* Re */



StmAbstractType (StmReCtrl)  /* ReCtrl */


StmAbstractType (StmReMtc)  /* ReMtc */


StmAbstractType (StmQreMtc)  /* QreMtc */


StmDllSpec
StmReCtrl stmReCtrlCreate (FILE *debug, jmp_buf *penvbuf,
                           const char *xlatetab, const char *const *errtxt);


StmDllSpec
void stmReCtrlDestroy (StmReCtrl reCtrl);


StmDllSpec
stm_inline int stmReCtrlSetErrorEnv (StmReCtrl reCtrl, jmp_buf *penvbuf);


#define StmMtcErrors                                                           \
/*         Error number          Standard error text                        */ \
StmMtcErr (StmMtcErrOk,          "no error"),                                  \
StmMtcErr (StmMtcErrInval,       "invalid argument"),                          \
StmMtcErr (StmMtcErrNoMem,       "no more memory on heap"),                    \
StmMtcErr (StmMtcErrMblkBig,     "heap memory block too big"),                 \
StmMtcErr (StmMtcErrLong,        "syntax error: <reStr> too long"),            \
StmMtcErr (StmMtcErrPar,         "syntax error: ')' missing"),                 \
StmMtcErr (StmMtcErrSubRe,       "syntax error: '&'<reName>'&' expected"),     \
StmMtcErr (StmMtcErrQreActName,  "syntax error: ':'<actionNames>':' expected"),\
StmMtcErr (StmMtcErrShort,       "syntax error: <reStr> too short"),           \
StmMtcErr (StmMtcErrRange,       "syntax error in <range>"),                   \
StmMtcErr (StmMtcErrGroup,       "syntax error in <group>"),                   \
StmMtcErr (StmMtcErrGend,        "syntax error: ']' missing"),                 \
StmMtcErr (StmMtcErrInvalRe,     "syntax error: illegal <reStr>"),             \
StmMtcErr (StmMtcErrNoAction,    "syntax error: <qualifRe> action unnamed"),   \
StmMtcErr (StmMtcErrIllegal,     "syntax error: <char> must be masked by '%'"),\
StmMtcErr (StmMtcErrRecursion,   "syntax error: infinite recursion"),          \
StmMtcErr (StmMtcErrNoQre,       "syntax error: illegal empty <qualifRe>"),    \
StmMtcErr (StmMtcErrNoQreAct,    "<qualifRe> action not defined"),             \
StmMtcErr (StmMtcErrQreInit,     "<qualifRe> action initialization failed"),   \
StmMtcErr (StmMtcErrQreAction,   "<qualifRe> action failed"),                  \
StmMtcErr (StmMtcErrQreRollback, "<qualifRe> action rollback failed"),         \
StmMtcErr (StmMtcErrQreDeinit,   "<qualifRe> action deinitialization failed"), \
StmMtcErr (StmMtcErrNoReStr,     "<reStr> not defined"),                       \
StmMtcErr (StmMtcErrReInit,      "<reStr> action initialization failed"),      \
StmMtcErr (StmMtcErrReRollback,  "<reStr> action rollback failed"),            \
StmMtcErr (StmMtcErrReAction,    "<reStr> action failed"),                     \
StmMtcErr (StmMtcErrReDeinit,    "<reStr> action deinitialization failed"),    \


#define StmMtcErr(nr, txt)       nr


enum StmReCtrlErrnos
{
    StmMtcErrors
    StmMtcErrCount
};
#undef StmMtcErr


StmDllSpec
stm_inline int stmReCtrlGetErrno (StmReCtrl reCtrl);


StmDllSpec
const char *stmReCtrlGetErrorMsg (StmReCtrl reCtrl);


StmDllSpec
stm_inline const char *stmReCtrlGetDebugMsg (StmReCtrl reCtrl);


typedef struct
{
   StmBool init     : 1;  
   StmBool action   : 1;  
   StmBool rollback : 1;  
   StmBool deinit   : 1;  
}
StmMtcFctCmd;


enum StmMtcFctResult
{
    StmMtcFctError  = -1,  
    StmMtcFctOk     =  0,  
    StmMtcFctFail   =  1,  
    StmMtcFctReduce =  2   
};


StmDllSpec
int stmQreActDef (StmReCtrl reCtrl, const char *qreactname,
                  int (*qreFct) (StmMtcFctCmd cmd, StmQreMtc qreMtc));


StmDllSpec
stm_inline const char *stmReMtcReName (StmReMtc reMtc);


StmDllSpec
stm_inline StmBool stmReMtcReNested (StmReMtc reMtc);


StmDllSpec
stm_inline const char *stmReMtcReContextName (StmReMtc reMtc);


StmDllSpec
stm_inline const char *stmReMtcReStr (StmReMtc reMtc);


StmDllSpec
stm_inline int stmReMtcReStrLen (StmReMtc reMtc);


StmDllSpec
stm_inline void *stmReMtcEnv (StmReMtc reMtc);


StmDllSpec
stm_inline void *stmReMtcData (StmReMtc reMtc);


StmDllSpec
stm_inline void stmReMtcSetData (StmReMtc reMtc, void *data);


StmDllSpec
stm_inline const char *stmReMtcStr (StmReMtc reMtc);


StmDllSpec
stm_inline int stmReMtcLen (StmReMtc reMtc);


StmDllSpec
stm_inline int stmReMtcQreMtcCount (StmReMtc reMtc);


StmDllSpec
stm_inline StmQreMtc stmReMtcNthQreMtc (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline const char *stmReMtcNthQreMtcStr (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline int stmReMtcNthQreMtcLen (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline void *stmReMtcNthQreMtcData (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline int stmReMtcNthSimpleReMtcCount (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline StmReMtc stmReMtcNthMthSimpleReMtc (StmReMtc reMtc,
                                               unsigned nth, unsigned mth);


StmDllSpec
stm_inline const char *stmReMtcNthMthSimpleReMtcStr (StmReMtc reMtc,
                                                     unsigned nth,
                                                     unsigned mth);


StmDllSpec
stm_inline int stmReMtcNthMthSimpleReMtcLen (StmReMtc reMtc,
                                             unsigned nth, unsigned mth);


StmDllSpec
stm_inline void *stmReMtcNthMthSimpleReMtcData (StmReMtc reMtc,
                                                unsigned nth, unsigned mth);


StmDllSpec
stm_inline int stmReMtcMtermNr (StmReMtc reMtc);


StmDllSpec
stm_inline StmQreMtc stmReMtcSuperQreMtc (StmReMtc reMtc);


StmDllSpec
stm_inline void *stmReMtcSuperQreMtcData (StmReMtc reMtc);


StmDllSpec
stm_inline StmReMtc stmReMtcNthSuperReMtc (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline void *stmReMtcNthSuperReMtcData (StmReMtc reMtc, unsigned nth);


StmDllSpec
stm_inline int stmReMtcSimpleReMtcNr (StmReMtc reMtc);


StmDllSpec
stm_inline void *stmQreMtcEnv (StmQreMtc qreMtc);


StmDllSpec
stm_inline void *stmQreMtcData (StmQreMtc qreMtc);


StmDllSpec
stm_inline void stmQreMtcSetData (StmQreMtc qreMtc, void *data);


StmDllSpec
stm_inline const char *stmQreMtcStr (StmQreMtc qreMtc);


StmDllSpec
stm_inline int stmQreMtcLen (StmQreMtc qreMtc);


StmDllSpec
stm_inline int stmQreMtcSimpleReMtcCount (StmQreMtc qreMtc);


StmDllSpec
stm_inline StmReMtc stmQreMtcNthSimpleReMtc (StmQreMtc qreMtc, unsigned nth);


StmDllSpec
stm_inline const char *stmQreMtcNthSimpleReMtcStr (StmQreMtc qreMtc,
                                                   unsigned nth);


StmDllSpec
stm_inline int stmQreMtcNthSimpleReMtcLen (StmQreMtc qreMtc, unsigned nth);


StmDllSpec
stm_inline void *stmQreMtcNthSimpleReMtcData (StmQreMtc qreMtc,
                                              unsigned nth);


StmDllSpec
stm_inline StmReMtc stmQreMtcSuperReMtc (StmQreMtc qreMtc);


StmDllSpec
stm_inline void *stmQreMtcSuperReMtcData (StmQreMtc qreMtc);


StmDllSpec
stm_inline StmReMtc stmQreMtcNthSuperReMtc (StmQreMtc qreMtc, unsigned nth);


StmDllSpec
stm_inline void *stmQreMtcNthSuperReMtcData (StmQreMtc qreMtc, unsigned nth);


StmDllSpec
stm_inline int stmQreMtcQualifReNr (StmQreMtc qreMtc);


StmDllSpec
StmRe stmReCreate (volatile StmReCtrl reCtrl,
                   const char *reName, const char *reStr,
                   int (*reFct) (StmMtcFctCmd cmd, StmReMtc reMtc));


StmDllSpec
int stmReDestroy (StmRe re);


StmDllSpec
StmRe stmReGet (StmReCtrl reCtrl, const char *reName);


StmDllSpec
StmBool stmReTest (StmReCtrl reCtrl, const char *reName);


StmDllSpec
StmBool stmReMatch (StmRe re, const char *str, void *env, void *data);


StmDllSpec
StmBool stmReMatchSub (StmRe re,
                       const char *str, int len, void *env, void *data);


StmDllSpec
stm_inline int stmReGetErrno (StmRe re);


StmDllSpec
const char *stmReGetErrorMsg (StmRe re);


StmDllSpec
stm_inline const char *stmReGetDebugMsg (StmRe re);


StmDllSpec
stm_inline const char *stmReGetReStr (StmRe re);


#ifdef __cplusplus
}
#endif


/* Include inline implementation. */
#include <stm/internal/_match.h>


#endif

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).