cli.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_cli
#define _H_cli
 
/*  FILE: cli.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
21-oct-05    abb      Begun
09-feb-06    abb      Change from xmlTextReader to rpc_agt callback
                      API format
10-feb-07    abb      Split out common functions from agt_ps_parse.h
29-jul-08    abb      change to cli.h; remove all by CLI parsing;
                      conversion from NCX parmset to YANG object
07-feb-09    abb      Add cli_rawparm_t and cli_parse_raw
                      for bootstrap CLI support
 
*/
 
#include <xmlstring.h>
 
#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_status
#include "status.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
/* value only of full test values for the valonly parameter */
#define  VALONLY   TRUE
#define  FULLTEST  FALSE
 
 
/* plain or script values for the climode parameter */
#define  SCRIPTMODE    TRUE
#define  PLAINMODE     FALSE
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
/* Heading only */
 
typedef enum cli_mode_t_ {
    CLI_MODE_NONE,       
    CLI_MODE_PROGRAM,    
    CLI_MODE_COMMAND     
} cli_mode_t;
 
 
 
typedef struct cli_rawparm_t_ {
    dlq_hdr_t   qhdr;   
    const char *name;   
    char       *value;  
    boolean     hasvalue;  
    boolean     xsdlist;  
    ncx_list_t *ncx_list;  
    int32       count;  
} cli_rawparm_t;
 
 
typedef val_value_t *
    (*cli_xml_buffer_fn_t) (const xmlChar *xmlbuff,
                            obj_template_t *targetobj,
                            status_t *res);
 
 
 
typedef status_t
    (*cli_var_replace_fn_t) (runstack_context_t *rcxt,
                             val_value_t *val);
 
 
 
 
typedef struct cli_inline_parms_t_ {
    obj_template_t *obj;
 
    boolean valonly;
 
    boolean script;
 
    boolean autocomp;
 
    boolean rawxml;
 
    boolean hide_unknown_error;
 
    cli_mode_t  mode;
 
    cli_xml_buffer_fn_t cbfn;
 
    cli_var_replace_fn_t cbfn2;
 
} cli_inline_parms_t;
 
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
extern cli_rawparm_t *
    cli_new_rawparm (const xmlChar *name, boolean xsdlist);
 
 
extern cli_rawparm_t *
    cli_new_empty_rawparm (const xmlChar *name);
 
 
extern void
    cli_free_rawparm (cli_rawparm_t *parm);
 
 
extern void
    cli_clean_rawparmQ (dlq_hdr_t *parmQ);
 
 
extern cli_rawparm_t *
    cli_find_rawparm (const xmlChar *name,
              dlq_hdr_t *parmQ);
 
 
extern status_t
    cli_parse_raw (int argc,
           char *argv[],
           dlq_hdr_t *rawparmQ);
 
 
extern val_value_t *
    cli_parse (runstack_context_t *rcxt,
               int argc,
               char *argv[],
               obj_template_t *obj,
               boolean valonly,
               boolean script,
               boolean autocomp,
               cli_mode_t  mode,
               status_t  *status);
 
 
 
extern val_value_t *
    cli_parse_inline (runstack_context_t *rcxt,
                      int argc,
                      char *argv[],
                      obj_template_t *obj,
                      boolean valonly,
                      boolean script,
                      boolean autocomp,
                      boolean rawxml,
                      cli_mode_t  mode,
                      status_t  *status,
                      cli_xml_buffer_fn_t cbfn,
                      cli_var_replace_fn_t cbfn2);
 
 
 
extern val_value_t *
    cli_parse_inline2 (runstack_context_t *rcxt,
                       int argc,
                       char *argv[],
                       cli_inline_parms_t *parms,
                       status_t  *status);
 
 
 
 
extern status_t
    cli_parse_parm (runstack_context_t *rcxt,
                    val_value_t *val,
            obj_template_t *obj,
            const xmlChar *strval,
            boolean script);
 
 
extern status_t
    cli_parse_parm_ret (runstack_context_t *rcxt,
                        val_value_t *val,
                        obj_template_t *obj,
                        const xmlChar *strval,
                        boolean script,
                        val_value_t **retval);
 
 
extern status_t
    cli_parse_parm_binary (runstack_context_t *rcxt,
                           val_value_t *val,
                           obj_template_t *obj,
                           const xmlChar *strval,
                           boolean script,
                           val_value_t **retval);
 
 
extern status_t
    cli_parse_parm_ex (runstack_context_t *rcxt,
                       val_value_t *val,
               obj_template_t *obj,
               const xmlChar *strval,
               boolean script,
               ncx_bad_data_t  bad_data);
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_cli */