pi3expr.h

mini http server,可以集成嵌入到程序中,实现简单的web功能

/*____________________________________________________________________________*\
 *

 Copyright (c) 1997-2003 John Roy, Holger Zimmermann. All rights reserved.

 These sources, libraries and applications are
 FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
 as long as the following conditions are adhered to.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer. 

 2. 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.

 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 AUTHORS OR ITS 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.

 *____________________________________________________________________________*|
 *
 * $Source: /cvsroot/pi3web/Pi3Web_200/Source/Pi3API/Pi3Expr.h,v $
 * $Date: 2003/05/13 18:42:11 $
 *
 Description:
\*____________________________________________________________________________*/
/* $HeaderTop:$ */

#ifndef PI3EXPR_H_
#define PI3EXPR_H_

#include "Pi3API.h"

/*____________________________________________________________________________*\
 *
 Typedefs:
\*____________________________________________________________________________*/
#if defined(PI3_INTERNAL)

/* --- Implementation sees the type of Pi3Expression --- */
typedef struct _Pi3Expression Pi3Expression;

#else

/* --- Externally Pi3Expression is opaque --- */
typedef int Pi3Expression;

#endif
typedef int (* FnPi3Write)( PIHTTP *, void *, char *, int );

/*____________________________________________________________________________*\
 *
 Name:
	Pi3Expression_new

 Synopsis:
	Pi3Expression *Pi3Expression_new( const char *pExpression,
		FnPi3Write *pParameters, Pi3String *pErrorDescription )

 Description:
	This function creates a new regular expression object using
	the expression in pExpression.

 Notes:
	pParameters is an optional pointer to an array of callback functions:
	<PRE>typedef int (* FnPi3Write)( PIHTTP *, void *, char *, int );</PRE>
	Each non-zero array element is filled by the implementation of the
	callback.
	Within regular expressions this data is referenced with keys like
	'$A'..'$z'.	For each key the callback function with the corresponding
	array position is invoked.

 Return Values:
	A reference to new Pi3Expression or NULL on error. If NULL is returned,
	an error description can be obtained from pErrorDescription.

 Errors:
	NULL will be returned on invalid pExpression or pErrorDescription.

 See Also:
\*____________________________________________________________________________*/
PUBLIC_PIAPI Pi3Expression *Pi3Expression_new( const char *pExpression,
	FnPi3Write *pParameters, Pi3String *pErrorDescription );

/*____________________________________________________________________________*\
 *
 Name:
	Pi3Expression_delete

 Synopsis:
	int Pi3Expression_delete( Pi3Expression *pExpression );

 Description:
	This function deletes the regexp object in pExpression.

 Notes:
 Return Values:
	PIAPI_COMPLETED on success, PIAPI_EINVAL on invalid pExpression

 Errors:
	PIAPI_EINVAL

 See Also:
\*____________________________________________________________________________*/
PUBLIC_PIAPI int Pi3Expression_delete( Pi3Expression *pExpr );

/*____________________________________________________________________________*\
 *
 Name:
	Pi3Expression_write

 Synopsis:
	int Pi3Expression_write( Pi3Expression *pExpression, PIHTTP *pPIHTTP,
		void *pData, char *pBuffer, int iBufferLength );

 Description:
	This function writes the result of pExpression in the context of pPIHTTP
	and pData into the buffer pBuffer of iBufferLength.

 Notes:
	The returned length can be used to re-allocate a sufficient buffer.
	The optional pData points to any user defined data. This element is handed
	over to the write callback function later and may contain context information.

 Return Values:
	The number of bytes of the interpreted regexp on success, PIAPI_EINVAL
	on parameter error, PIAPI_ERROR on write error.

 Errors:
	PIAPI_EINVAL
	PIAPI_ERROR

 See Also:
	Pi3Expression_new
\*____________________________________________________________________________*/
PUBLIC_PIAPI int Pi3Expression_write( Pi3Expression *pExpression,
	PIHTTP *pPIHTTP, void *pData, char *pBuffer, int iBufferLength );

#endif	/* PI3EXPR_H_ */