te.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef TE_h
#define TE_h

#include <tc/tc_startup.h>
#include <tccore/tctype.h>
#include <tccore/item.h>
#include <sa/tcfile.h>
#include <itk/libitk_exports.h>

#ifndef TE_MAXLINELEN
    #define TE_MAXLINELEN   256
#endif

#define TE_LW               "Latest Working"
#define TE_LOG_FILE         "te.log"
#define TE_CFG_FILE         "te.cfg"

/*
   Possible pack states
*/
#define TE_PACK         0
#define TE_UNPACK       1
#define TE_PACK_PREF    2

typedef enum
{
    TE_CONTINUE,
    TE_STOP,
    TE_SKIPCHILDREN,
    TE_GOBACK,
    TE_SKIP
} TE_decision;

typedef enum
{
    TE_LOG,
    TE_STDOUT,
    TE_LOGANDSTDOUT
} Output;

typedef enum
{
    TE_NODE_SELECTOR,
    TE_REG_HANDLER,
    TE_ROOT_ENTRY,
    TE_ROOT_EXIT,
    TE_AT_NODE,
    TE_FORWARD_ENTRY,
    TE_FORWARD_EXIT,
    TE_REVERSE_ENTRY,
    TE_REVERSE_EXIT
} HandlerTypes ;

#ifdef __cplusplus
extern "C"
{
#endif

typedef TE_decision ( *TE_handler_t  )  (
    char*,
    tag_t,
    int
    ) ;

extern ITK_API int TE_init_module();

extern ITK_API int TE_exit_module ( void );

extern ITK_API int TE_PS_initialize(
    const char*    itemid,  
    const char*    rev      
    );

extern ITK_API int TE_ui_set_logfile(
    const char*    fname    
    );

extern ITK_API int TE_ui_set_configfile(
    const char*    fname    
    );

extern ITK_API int TE_ui_set_validate_args() ;

extern ITK_API int TE_get_statistics(
    int*           warn_cnt,        
    int*           skipchild_cnt,   
    int*           skip_cnt,        
    int*           total_cnt        
    );

extern ITK_API int TE_ui_increment_warnings();

extern ITK_API int TE_PS_fill_tree ();

extern ITK_API int TE_PS_traverse_tree ();

extern ITK_API int TE_PS_fill_and_traverse_tree ();

extern ITK_API int TE_table_store_float(
    const char*    key,     
    float          sfloat   
    );

extern ITK_API int TE_table_get_float(
    const char*    key,     
    float*         afloat   
    );

extern ITK_API int TE_ui_print_message(
    int            output,  
    int            warn,    
    int            ifail,   
    const char*    msg      
    );

extern ITK_API int TE_get_preference_list(
    const char*    sym,         
    int*           nofound,     
    char***        stlist       
    );

extern ITK_API int TE_get_preference(
    const char*    sym,     
    char**         pref     
    );

extern ITK_API int TE_PS_ui_get_data(
    char           itemid[ITEM_id_size_c + 1],          
    char           itemrev[ITEM_id_size_c + 1],         
    char           logfile[IMF_filename_size_c + 1],    
    char           configfile[IMF_filename_size_c + 1]  
    );


extern ITK_API int TE_PS_ui_get_data2(
char           **itemid,           
char           **itemrev,          
char           **logfile,          
char           **configfile        
    );

extern ITK_API int TE_node_set_type(
    const char*    ntype    
    );

extern ITK_API int TE_parentnode_set_type(
    const char*    ntype    
    );

extern ITK_API int TE_node_get_data(
    int*           childnodes,              
    char           type[ITEM_desc_size_c]   
    );

extern ITK_API int TE_node_get_data2(
    int*           childnodes,              
    char           **type                   
    );

extern ITK_API int TE_parentnode_get_data(
    int*           childnodes,  
    char*          type,        
    tag_t*         tag,         
    int*           depth        
    );

extern ITK_API int TE_PS_set_config(
    const char*    viewtype,    
    const char*    variant,     
    const char*    revrule,     
    const char*    sub          
    );
extern ITK_API int TE_PS_set_config_with_pack(
    const char*    viewtype,    
    const char*    variant,     
    const char*    revrule,     
    const char*    alt,         
    int            packstate    
    );
extern ITK_API int TE_PS_get_config_params(
    char**         viewtype,    
    char**         variant,     
    char**         revrule,     
    char**         sub          
    );
extern ITK_API int TE_PS_get_config_params_with_pack(
    char**         viewtype,    
    char**         variant,     
    char**         revrule,     
    char**         alt,         
    int*           packstate    
    );
extern ITK_API int TE_register_node_handler(
    int            handlertype, 
    TE_handler_t   afun         
    );

extern ITK_API int TE_ui_get_logfile_pointer(
    FILE**         logfileptr   
    );

#ifdef __cplusplus
}
#endif

#include <itk/libitk_undef.h>

#endif