ncx_feature.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_ncx_feature
#define _H_ncx_feature
 
/*  FILE: ncx_feature.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
17-feb-10    abb      Begun; split out from ncx.c
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_tk
#include "tk.h"
#endif
 
#ifndef _H_typ
#include "typ.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifndef _H_yang
#include "yang.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
 
#define SET_FEAT(F)     (F) |= NCX_FL_FEAT_SET
#define CLR_FEAT(F)     (F) &= ~NCX_FL_FEAT_SET
#define IS_FEAT_SET(F)  ((F) & NCX_FL_FEAT_SET)
 
 
#define SET_FEAT_ENA(F)  (F) |= NCX_FL_FEAT_ENABLED
#define CLR_FEAT_ENA(F)  (F) &= ~NCX_FL_FEAT_ENABLED
#define IS_FEAT_ENA(F)   ((F) & NCX_FL_FEAT_ENABLED)
 
 
#define SET_FEAT_XFER(F)  (F) |= NCX_FL_FEAT_XFER
#define CLR_FEAT_XFER(F)  (F) &= ~NCX_FL_FEAT_XFER
#define IS_FEAT_XFER(F)   ((F) & NCX_FL_FEAT_XFER)
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
 
extern void
    ncx_feature_init (void);
 
 
extern void
    ncx_feature_cleanup (void);
 
 
extern ncx_iffeature_t *
    ncx_new_iffeature (void);
 
 
extern void
    ncx_free_iffeature (ncx_iffeature_t *iff);
 
 
extern ncx_iff_ref_t *
    ncx_new_iff_ref (const xmlChar *prefix,
                     uint32 prefix_len,
                     const xmlChar *featname);
 
 
extern void
    ncx_free_iff_ref (ncx_iff_ref_t *iff_ref);
 
 
extern ncx_iff_ref_t *
    ncx_find_iff_ref (dlq_hdr_t *iff_refQ,
                      const xmlChar *prefix,
                      uint32 prefix_len,
                      const xmlChar *featname);
 
 
extern ncx_iffeature_t *
    ncx_clone_iffeature (ncx_iffeature_t *srciff);
 
 
extern void
    ncx_clean_iffeatureQ (dlq_hdr_t *iffeatureQ);
 
 
extern ncx_iffeature_t *
    ncx_find_iffeature (dlq_hdr_t *iffeatureQ,
            const xmlChar *prefix,
            const xmlChar *name,
            const xmlChar *modprefix);
 
 
extern ncx_feature_t *
    ncx_new_feature (void);
 
 
extern void
    ncx_free_feature (ncx_feature_t *feature);
 
 
extern ncx_feature_t *
    ncx_find_feature (ncx_module_t *mod,
              const xmlChar *name);
 
 
extern ncx_feature_t *
    ncx_find_feature_que (dlq_hdr_t *featureQ,
              const xmlChar *name);
 
 
extern ncx_feature_t *
    ncx_find_feature_all (ncx_module_t *mod,
                          const xmlChar *name);
 
 
extern void
    ncx_for_all_features (const ncx_module_t *mod,
              ncx_feature_cbfn_t  cbfn,
              void *cookie,
              boolean enabledonly);
 
 
extern uint32
    ncx_feature_count (const ncx_module_t *mod,
               boolean enabledonly);
 
 
extern boolean
    ncx_feature_enabled (ncx_feature_t *feature);
 
 
extern boolean
    ncx_feature_enabled_str (const xmlChar *modname,
                             const xmlChar *revision,
                             const xmlChar *name);
 
 
extern void
    ncx_set_feature_enable_default (boolean flag);
 
 
extern void
    ncx_set_feature_code_default (ncx_feature_code_t code);
 
 
extern status_t
    ncx_set_feature_code_entry (const xmlChar *featstr,
                                ncx_feature_code_t featcode);
 
 
extern status_t
    ncx_set_feature_enable_entry (const xmlChar *featstr,
                                  boolean flag);
 
 
extern status_t
    ncx_set_feature_enable (const xmlChar *modname,
                            const xmlChar *name,
                            boolean flag);
 
 
extern status_t
    ncx_set_feature_enable_ex (const xmlChar *modname,
                               const xmlChar *name,
                               boolean flag,
                               boolean force);
 
 
extern void
    ncx_set_feature_parms (ncx_feature_t *feature);
 
 
extern void
    ncx_set_features_for_mod (ncx_module_t *mod);
 
 
extern ncx_feature_t *
    ncx_first_feature_from_iff (ncx_iffeature_t *iff);
 
 
extern const xmlChar *
    ncx_get_feature_modname (ncx_feature_t *feat);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ncx_feature */