top.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 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_top
#define _H_top
 
/*  FILE: top.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
30-dec-05    abb      Begun
11-feb-07    abb      Move some common fns back to ncx/top.h
*/
 
#include <xmlstring.h>
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_xml_util
#include "xml_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
/* Header only */
 
typedef boolean (*top_handler_t) (ses_cb_t   *scb,
                                  xml_node_t *top);
 
 
 
 
typedef boolean
    (*top_val_handler_t) (ses_cb_t   *scb,
                          val_value_t *msgval);
 
 
typedef enum top_mode_t_ {
    TOP_MODE_NONE,     
    TOP_MODE_SERVER,   
    TOP_MODE_CLIENT    
} top_mode_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern void
    top_init (void);
 
 
extern void
    top_cleanup (void);
 
 
extern status_t
    top_register_node (const xmlChar *owner,
               const xmlChar *elname,
               top_handler_t handler,
                       top_mode_t topmode);
 
 
extern void
    top_unregister_node (const xmlChar *owner,
             const xmlChar *elname,
                         top_mode_t topmode);
 
 
extern top_handler_t
    top_find_handler (const xmlChar *owner,
              const xmlChar *elname,
                      top_mode_t topmode);
 
 
 
extern status_t
    top_register_val_node (const xmlChar *owner,
                           const xmlChar *elname,
                           top_val_handler_t handler,
                           top_mode_t topmode);
 
 
extern void
    top_unregister_val_node (const xmlChar *owner,
                             const xmlChar *elname,
                             top_mode_t topmode);
 
 
extern top_val_handler_t
    top_find_val_handler (const xmlChar *owner,
                          const xmlChar *elname,
                          top_mode_t topmode);
 
 
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_top */