typ_userdef.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_typ_userdef
#define _H_typ_userdef
 
/*  FILE: typ_userdef.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
07-apr-18    abb      Begun
*/
 
// for XSD pattern: xmlRexexpPtr pattern
#include <xmlstring.h>
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_typ
#include "typ.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef status_t
    (*typ_validate_fn_t) (typ_def_t *typdef,
                          val_value_t *val,
                          void *cookie);
 
 
typedef status_t
    (*typ_canonical_fn_t) (typ_def_t *typdef,
                           val_value_t *val,
                           void *cookie);
 
 
typedef status_t
    (*typ_compare_fn_t) (const typ_def_t *typdef,
                         const val_value_t *val1,
                         const val_value_t *val2,
                         void *cookie,
                         int *retval);
 
 
typedef struct typ_userdef_t_ {
    typ_validate_fn_t  validate_fn;     
    typ_canonical_fn_t canonical_fn;    
    typ_compare_fn_t   compare_fn;      
    void              *cookie;          
} typ_userdef_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
extern status_t
    typ_userdef_register (const xmlChar *modname,
                          const xmlChar *typname,
                          typ_validate_fn_t validate_fn,
                          typ_canonical_fn_t canonical_fn,
                          typ_compare_fn_t compare_fn,
                          void *cookie);
 
 
extern void
    typ_userdef_clean_typdef (typ_def_t *typdef);
 
 
extern status_t
    typ_userdef_validate (val_value_t *val);
 
 
extern status_t
    typ_userdef_canonical (val_value_t *val);
 
 
extern status_t
    typ_userdef_compare (const val_value_t *val1,
                         const val_value_t *val2,
                         int32 *ret);
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_typ_userdef */