bomwriter.h

Go to the documentation of this file.

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

/*  */

#ifndef BOMWRITER_H
#define BOMWRITER_H

#include <unidefs.h>
#include <stdio.h>
#include <bom/libbom_exports.h>

#define BOM_writer_node_unset                   0
#define BOM_writer_node_selected                (1<<0)
#define BOM_writer_node_ancestor                (1<<1)
#define BOM_writer_node_descendant              (1<<2)
#define BOM_writer_node_leaf                    (1<<3)
#define BOM_writer_node_assy_geom               (1<<4)
#define BOM_writer_node_subselected             (1<<5)
#define BOM_writer_node_subancestor             (1<<6)
#define BOM_writer_node_subdescendant           (1<<7)

typedef char* (*BOM_writer_userfunc_t)(
    tag_t       bomline,        
    tag_t       parent,         
    void*       transform,      
    int         node_reason,    
    int         depth,          
    void*       userdata        
    );

typedef struct{
    long    struct_type;  
    void*   object;       
} BOM_writer_struct;

#define BOMWRITER_UA_TARGET                     "target:"
#define BOMWRITER_UA_PREF                       "pref:"
#define BOMWRITER_UA_ATTRMAP                    "attrmap:"
#define BOMWRITER_UA_KEY                        "key:"
#define BOMWRITER_UA_PROP                       "prop:"
#define BOMWRITER_UA_ATTR                       "attr:"
#define BOMWRITER_UA_LITERAL                    "literal:"
#define BOMWRITER_UA_PROPUID                    "propuid:"

typedef struct{
    BOM_writer_struct   struct_type;
    FILE*               filehandle;     
}  BOM_writer_output_file;

typedef struct{
    BOM_writer_struct   struct_type;
    char*               smstring;       
} BOM_writer_output_smstring;

typedef union{
    BOM_writer_struct           common;
    BOM_writer_output_file      file;
    BOM_writer_output_smstring  smstring;
} BOM_writer_output;

typedef char* (*BOM_writer_empty_ep_t)(  
    tag_t       bomline,        
    tag_t       parent,         
    void*       transform,      
    int         node_reason,    
    int         depth,          
    int         count,
    void*       userdata,       
    int*        prune
    );

typedef int (*BOM_writer_asktform_t)(
    tag_t     bomline,     
    int       depth,       
    void**    transform
    );

typedef int (*BOM_writer_combtform_t)(
    void*     transform1,
    void*     transform2,
    void**    result
    );

typedef int (*BOM_writer_freetform_t)(
    void*     transform
    );

typedef struct{
    BOM_writer_struct      struct_type;
    BOM_writer_empty_ep_t  enter_parent;          
    BOM_writer_userfunc_t  write_leaf;            
    BOM_writer_userfunc_t  leave_parent;          
    BOM_writer_asktform_t  ask_transform;         
    BOM_writer_combtform_t combine_transforms;    
    BOM_writer_freetform_t free_transform;        
    void*                  userdata;              
} BOM_writer_format_empty;

typedef enum BOM_writer_ajt_style_e{
    BOM_writer_ajt_file_url,        
    BOM_writer_ajt_file_unix,
    BOM_writer_ajt_file_nt,
    BOM_writer_ajt_file_native,
    BOM_writer_ajt_file_user,
    BOM_writer_ajt_file_uidtag,
    BOM_writer_ajt_file_webtag
}  BOM_writer_ajt_file_style;

typedef char* (*BOM_writer_ajtfilefunc_t)(
    tag_t       dataset,
    tag_t       imanfile,
    tag_t       line,
    void*       userdata
    );

#define BOMWRITER_AJT_ROOT_UA_TARGET BOMWRITER_UA_TARGET "Root"
#define BOMWRITER_AJT_NODE_UA_TARGET BOMWRITER_UA_TARGET "Node"

typedef struct{
    BOM_writer_struct         struct_type;
    logical                   supply_identity;      
    logical skip_fake_part;                          /* <I> [false] - if true, skip dummy parts for sub-assemblies*/
    //Jane <17-Jan-2008> Add asm_jt_file flag to the AJT format
    logical asm_jt_file;                           //[false] -- if false, only writer the leaf node files
                                                     // -- if true,writer files associated with both leaf nodes and assembly lines
    BOM_writer_userfunc_t     userfunc;             
    BOM_writer_ajtfilefunc_t  userfilefunc;         
    void*                     userdata;             
    BOM_writer_ajt_file_style file_attr_style;      
    char**                    user_attributes;      
    long                      fatal_minor_errors;   
} BOM_writer_format_ajt;

#define BOMWRITER_PLMXML_ROOT_UA_TARGET         BOMWRITER_UA_TARGET "Root"
#define BOMWRITER_PLMXML_PART_UA_TARGET         BOMWRITER_UA_TARGET "Part"
#define BOMWRITER_PLMXML_INSTANCE_UA_TARGET     BOMWRITER_UA_TARGET "Instance"
#define BOMWRITER_PLMXML_OCCURRENCE_UA_TARGET   BOMWRITER_UA_TARGET "Occurrence"

typedef enum TransformType_e
{
    TransformType_None,
    TransformType_Cumulative,
    TransformType_AbsOcc,
    TransformType_AbsOcc_Then_Cumulative
} BOM_writer_TransformType;
typedef struct{
    BOM_writer_struct   struct_type;
    char*               builder_name;           
    void*               builder_object;         
    void*               auto_doc;               
    char**              user_attributes;        
    logical             suppress_output;        
    long                fatal_minor_errors;     
    char*                       transfer_mode;
    BOM_writer_TransformType    transform_type; 
    char**              lang_codes;            
    int                 number_of_langs;       
    char*               perf_file;             
    int                 sequence_no;           
    char*               assembly_size;         
    char*               log_file;
} BOM_writer_format_plmxml;

typedef union BOM_writer_format_u               BOM_writer_format;

typedef struct{
    BOM_writer_struct   struct_type;
    BOM_writer_format*  subformat;
} BOM_writer_format_flatten;

union BOM_writer_format_u{
    BOM_writer_struct           common;
    BOM_writer_format_empty     empty;
    BOM_writer_format_ajt       ajt;
    BOM_writer_format_plmxml    plmxml;
    BOM_writer_format_flatten   flatten;
};

typedef struct{
    BOM_writer_struct   struct_type;
    logical             no_descendants;             
    int                 selected_count;             
    tag_t*              selected_lines;             
    logical             unload_lines;               
    logical             transient_unpack;           
    logical             emit_unselected_ancestors;  
    int                 unselected_ancestors_count; 
    tag_t*              unselected_ancestors;       
    int                 sub_count;                  
    tag_t*              sub_lines;                  
    int                 filter_by_level;            
    int                 bomset_max_lines;           
    logical             varuid;                     
    logical             revid;                      
    logical             grdvua;                     
} BOM_writer_traversal;

#include <bom/libbom_undef.h>
#endif