op.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_op
#define _H_op
/*  FILE: op.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************

date             init     comment
----------------------------------------------------------------------
06-apr-05    abb      Begun.
*/

#include <xmlstring.h>

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/



/********************************************************************
*                                                                   *
*                                    T Y P E S                      *
*                                                                   *
*********************************************************************/

typedef enum op_method_t_ {
    OP_NO_METHOD,             
    OP_GET_CONFIG,            
    OP_EDIT_CONFIG,           
    OP_COPY_CONFIG,           
    OP_DELETE_CONFIG,         
    OP_LOCK,                  
    OP_UNLOCK,                
    OP_GET,                   
    OP_CLOSE_SESSION,         
    OP_KILL_SESSION,          
    OP_COMMIT,                
    OP_DISCARD_CHANGES,       
    OP_VALIDATE,              
    OP_CANCEL_COMMIT          
} YPACK op_method_t;


typedef enum op_srctyp_t_ {
    OP_SOURCE_NONE,          
    OP_SOURCE_CONFIG,        
    OP_SOURCE_INLINE,        
    OP_SOURCE_URL            
} YPACK op_srctyp_t;


typedef enum op_targtyp_t_ {
    OP_TARGET_NONE,      
    OP_TARGET_CONFIG,    
    OP_TARGET_URL        
} YPACK op_targtyp_t;


typedef enum op_defop_t_ {
    OP_DEFOP_NOT_SET,       
    OP_DEFOP_NONE,          
    OP_DEFOP_MERGE,         
    OP_DEFOP_REPLACE,       
    OP_DEFOP_NOT_USED       
} YPACK op_defop_t;


typedef enum op_filtertyp_t_ {
    OP_FILTER_NONE,           
    OP_FILTER_SUBTREE,        
    OP_FILTER_XPATH           
} YPACK op_filtertyp_t;


typedef enum op_editop_t_ {
    OP_EDITOP_NONE,              
    OP_EDITOP_MERGE,             
    OP_EDITOP_REPLACE,           
    OP_EDITOP_CREATE,            
    OP_EDITOP_DELETE,            
    OP_EDITOP_LOAD,              
    OP_EDITOP_COMMIT,            
    OP_EDITOP_REMOVE,            
    OP_EDITOP_DELETE_ALL,        
    OP_EDITOP_REMOVE_ALL         
} YPACK op_editop_t;


typedef enum op_insertop_t_ {
    OP_INSOP_NONE,               
    OP_INSOP_FIRST,              
    OP_INSOP_LAST,               
    OP_INSOP_BEFORE,             
    OP_INSOP_AFTER               
} YPACK op_insertop_t;


typedef enum op_t_ {
    OP_NONE,         
    OP_MERGE,        
    OP_REPLACE,      
    OP_CREATE,       
    OP_DELETE,       
    OP_LOAD,         
    OP_NOTIFY,       
    OP_READ          
} YPACK op_t;


typedef enum op_testop_t_ {
    OP_TESTOP_NONE,            
    OP_TESTOP_TESTTHENSET,     
    OP_TESTOP_SET,             
    OP_TESTOP_TESTONLY         
} YPACK op_testop_t;


typedef enum op_errop_t_ {
    OP_ERROP_NONE,          
    OP_ERROP_STOP,          
    OP_ERROP_CONTINUE,      
    OP_ERROP_ROLLBACK       
} YPACK op_errop_t;


typedef struct op_filter_t_ {
    op_filtertyp_t       op_filtyp;   
    struct val_value_t_ *op_filter;   
} YPACK op_filter_t;


/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/


extern const xmlChar *
    op_method_name (op_method_t op_id);


extern const xmlChar *
    op_editop_name (op_editop_t ed_id);


extern op_editop_t
    op_editop_id (const xmlChar *opstr);


extern const xmlChar *
    op_insertop_name (op_insertop_t ins_id);


extern op_insertop_t
    op_insertop_id (const xmlChar *opstr);


extern op_filtertyp_t
    op_filtertyp_id (const xmlChar *filstr);


extern const xmlChar *
    op_defop_name (op_defop_t def_id);


extern op_editop_t
    op_defop_id (const xmlChar *defstr);


extern const xmlChar *
    op_testop_name (op_testop_t test_id);


extern op_testop_t
    op_testop_enum (const xmlChar *teststr);


extern const xmlChar *
    op_errop_name (op_errop_t err_id);


extern op_errop_t
    op_errop_id (const xmlChar *errstr);


extern op_defop_t
    op_defop_id2 (const xmlChar *defstr);


extern boolean
    op_editop_is_delete (op_editop_t ed_id);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif            /* _H_op */