var.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_var
#define _H_var
 
/*  FILE: var.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
23-aug-07    abb      Begun
09-mar-09    abb      Add more support for yangcli
*/
 
#include <xmlstring.h>
 
#ifndef _H_cli
#include "cli.h"
#endif
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_runstack
#include "runstack.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/* top or parm values for the istop parameter */
#define  ISTOP   TRUE
#define  ISPARM  FALSE
 
#define VAR_VAL(V)   (V)->val
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum var_type_t_ {
    VAR_TYP_NONE,    
    VAR_TYP_LOCAL,
 
    VAR_TYP_CONFIG,
 
    VAR_TYP_GLOBAL,
 
    VAR_TYP_SYSTEM,
 
    VAR_TYP_QUEUE
} var_type_t;
 
 
typedef struct ncx_var_t_ {
    dlq_hdr_t     hdr;    
    var_type_t    vartype;
 
    xmlns_id_t    nsid;     
    xmlChar      *name;
 
    val_value_t  *val;
} ncx_var_t;
 
 
typedef enum var_side_t_ {
    ISRIGHT,   
    ISLEFT     
} var_side_t;
 
 
typedef ncx_var_t *
    (*var_getvar_fn_t) (const xmlChar *varname,
                        uint32 varlen,
                        void *cookie,
                        status_t *res);
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern void
    var_free (ncx_var_t *var);
 
 
extern void
    var_clean_varQ (dlq_hdr_t *varQ);
 
 
extern void
    var_clean_type_from_varQ (dlq_hdr_t *varQ,
                              var_type_t vartype);
 
 
extern status_t
    var_set_str (runstack_context_t *rcxt,
                 const xmlChar *name,
         uint32 namelen,
         const val_value_t *value,
         var_type_t vartype);
 
 
extern status_t
    var_set (runstack_context_t *rcxt,
             const xmlChar *name,
         const val_value_t *value,
         var_type_t vartype);
 
 
extern status_t
    var_set_str_que (dlq_hdr_t  *varQ,
             const xmlChar *name,
             uint32 namelen,
             const val_value_t *value);
 
 
extern status_t
    var_set_que (dlq_hdr_t *varQ,
         const xmlChar *name,
         const val_value_t *value);
 
 
extern status_t
    var_set_move_que (dlq_hdr_t *varQ,
                      const xmlChar *name,
                      val_value_t *value);
 
 
extern status_t
    var_set_move_que_global (dlq_hdr_t *varQ,
                             const xmlChar *name,
                             val_value_t *value);
 
 
extern status_t
    var_set_move (runstack_context_t *rcxt,
                  const xmlChar *name,
          uint32 namelen,
          var_type_t vartype,
          val_value_t *value);
 
 
extern status_t
    var_set_sys (runstack_context_t *rcxt,
                 const xmlChar *name,
         const val_value_t *value);
 
 
extern status_t
    var_set_from_string (runstack_context_t *rcxt,
                         const xmlChar *name,
             const xmlChar *valstr,
             var_type_t vartype);
 
 
extern status_t
    var_unset (runstack_context_t *rcxt,
               const xmlChar *name,
           uint32 namelen,
           var_type_t vartype);
 
 
extern status_t
    var_unset_que (dlq_hdr_t *varQ,
           const xmlChar *name,
           uint32 namelen,
           xmlns_id_t  nsid);
 
 
extern val_value_t *
    var_get_str (runstack_context_t *rcxt,
                 const xmlChar *name,
         uint32 namelen,
         var_type_t vartype);
 
 
extern val_value_t *
    var_get (runstack_context_t *rcxt,
             const xmlChar *name,
         var_type_t vartype);
 
 
extern var_type_t
    var_get_type_str (runstack_context_t *rcxt,
                      const xmlChar *name,
              uint32 namelen,
              boolean globalonly);
 
 
extern var_type_t
    var_get_type (runstack_context_t *rcxt,
                  const xmlChar *name,
          boolean globalonly);
 
 
extern val_value_t *
    var_get_str_que (dlq_hdr_t *varQ,
             const xmlChar *name,
             uint32 namelen,
             xmlns_id_t nsid);
 
 
extern val_value_t *
    var_get_que (dlq_hdr_t *varQ,
         const xmlChar *name,
         xmlns_id_t nsid);
 
 
extern ncx_var_t *
    var_get_que_raw (dlq_hdr_t *varQ,
             xmlns_id_t  nsid,
             const xmlChar *name);
 
 
extern val_value_t *
    var_get_local (runstack_context_t *rcxt,
                   const xmlChar *name);
 
 
extern val_value_t *
    var_get_local_str (runstack_context_t *rcxt,
                       const xmlChar *name,
               uint32 namelen);
 
 
extern status_t
    var_check_ref (runstack_context_t *rcxt,
                   const xmlChar *line,
           var_side_t side,
           uint32   *len,
           var_type_t *vartype,
           const xmlChar **name,
           uint32 *namelen,
                   val_value_t **foundval);
 
 
extern val_value_t *
    var_get_script_val (runstack_context_t *rcxt,
                        obj_template_t *obj,
            val_value_t *val,
            const xmlChar *strval,
            boolean istop,
            status_t *res);
 
 
extern val_value_t *
    var_get_script_val_ex (runstack_context_t *rcxt,
                           obj_template_t *parentobj,
                           obj_template_t *obj,
                           val_value_t *val,
                           const xmlChar *strval,
                           boolean istop,
                           val_value_t *fillval,
                           status_t *res);
 
 
extern val_value_t *
    var_check_script_val (runstack_context_t *rcxt,
                          obj_template_t *obj,
                          const xmlChar *strval,
                          boolean istop,
                          boolean handleEscapedCharacters,
                          cli_xml_buffer_fn_t cbfn,
                          status_t *res);
 
 
extern void
    var_cvt_generic (dlq_hdr_t *varQ);
 
 
extern ncx_var_t *
    var_find (runstack_context_t *rcxt,
              const xmlChar *varname,
              xmlns_id_t nsid);
 
 
extern ncx_var_t *
    var_find_global (runstack_context_t *rcxt,
                     const xmlChar *varname,
                     uint32 namelen,
                     xmlns_id_t nsid);
 
 
extern ncx_var_t *
    var_get_first (runstack_context_t *rcxt,
                   boolean islocal);
 
 
extern ncx_var_t *
    var_get_next (ncx_var_t *curvar);
 
 
extern const xmlChar *
    var_get_name (const ncx_var_t *curvar);
 
 
extern var_type_t
    var_get_vartype (const ncx_var_t *curvar);
 
 
extern void
    var_init (void);
 
 
extern void
    var_set_getvar_cb (var_getvar_fn_t getcb,
                       void *cookie);
 
 
extern void *
    var_get_getvar_cb_cookie (void);
 
 
extern var_getvar_fn_t
    var_get_getvar_cb (void);
 
 
extern boolean
    var_string_is_var_expr (const xmlChar *varstring,
                            uint32 varlen,
                            boolean *plainvar);
 
 
extern status_t
    var_replace_subtree (runstack_context_t *rcxt,
                         val_value_t *val);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_var */