yang_sid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, 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_yang_sid
#define _H_yang_sid
 
#ifdef WITH_YANG_CBOR
 
/*  FILE: yang_sid.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
01-may-22    abb      Begun; moved from ncx.c
 
*/
 
#include "status_enum.h"
 
/*** assumes procdefs.h has been included ***/
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
/* Group definied in yang.h */
 
 
typedef enum yang_sid_status_t_ {
    YANG_SID_STAT_NONE,
 
    YANG_SID_STAT_EXTERNAL,
 
    YANG_SID_STAT_INTERNAL,
 
    YANG_SID_STAT_SKIP,
 
} yang_sid_status_t;
 
 
typedef yang_sid_status_t (*yang_sid_test_fn_t) (ncx_module_t *mod);
 
 
 
extern status_t
    yang_sid_set_module (ncx_module_t *mod,
                         ncx_yang_sid_mode_t yang_sid_mode);
 
 
 
extern status_t
    yang_sid_set_all_modules (ncx_yang_sid_mode_t yang_sid_mode,
                              boolean strict_mode,
                              yang_sid_test_fn_t test_fn);
 
 
extern void yang_sid_init (void);
 
 
extern void yang_sid_cleanup (void);
 
 
extern uint8
    yang_sid_num_bits (void);
 
 
/*
* @brief string for the ncx_sid_ns_t enumeration
*
* @param sidns SID namespace enumeration to convert to string
* @return string value for the enum or NULL if none
*/
extern const xmlChar *
    yang_sid_ns_str (ncx_sid_ns_t sidns);
 
 
extern const xmlChar *
    yang_sid_mode_str (ncx_yang_sid_mode_t sidmode);
 
 
#endif  // WITH_YANG_CBOR
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_yang_sid */