/*
 * Revision Control Information
 *
 * $Source: /vol/opua/opua2/sis/sis-1.1/common/src/sis/node/RCS/node.h,v $
 * $Author: sis $
 * $Revision: 1.3 $
 * $Date: 1992/05/06 18:57:41 $
 *
 */
#ifndef NODE_H
#define NODE_H

/* ... belongs in network.h, but node and network reference each other ... */
typedef struct network_struct network_t;
typedef struct node_struct node_t;


typedef enum node_function_enum node_function_t;
enum node_function_enum {
    NODE_PI, NODE_PO, NODE_0, NODE_1, NODE_BUF, NODE_INV, 
    NODE_AND, NODE_OR, NODE_COMPLEX, NODE_UNDEFINED
};


typedef enum name_mode_enum name_mode_t;
enum name_mode_enum {
    LONG_NAME_MODE, SHORT_NAME_MODE
};


typedef enum node_type_enum node_type_t;
enum node_type_enum {
    PRIMARY_INPUT, PRIMARY_OUTPUT, INTERNAL, UNASSIGNED
};


typedef enum node_daemon_type_enum {
    DAEMON_ALLOC=0, DAEMON_FREE=1, DAEMON_INVALID=2, DAEMON_DUP=3
} node_daemon_type_t;


typedef enum input_phase_enum input_phase_t;
enum input_phase_enum {
    POS_UNATE, NEG_UNATE, BINATE, PHASE_UNKNOWN
};


typedef struct fanout_struct fanout_t;
struct fanout_struct {
    node_t *fanout;
    int pin;
};


typedef enum node_sim_enum node_sim_type_t;
enum node_sim_enum {
    NODE_SIM_SCC, NODE_SIM_SIMPCOMP, NODE_SIM_ESPRESSO,
    NODE_SIM_EXACT, NODE_SIM_EXACT_LITS, NODE_SIM_DCSIMP,
    NODE_SIM_NOCOMP, NODE_SIM_SNOCOMP
};


struct node_struct {
    char *name;			/* name of the output signal */
    char *short_name;		/* short name for interactive use */
    node_type_t type;		/* type of the node */

    int sis_id;			/* unique id (used to sort fanin) */

    unsigned fanin_changed:1;	/* flag to catch fanin generation errors */
    unsigned fanout_changed:1;	/* flag to catch fanout generation errors */
    unsigned is_dup_free:1;	/* node has no aliasing of its fanin */
    unsigned is_min_base:1;	/* node is minimum base */
    unsigned is_scc_minimal:1;	/* node is scc-minimal */

    int nin;			/* number of inputs */
    node_t **fanin;

    lsList fanout;		/* list of 'fanout_t' structures */
    lsHandle *fanin_fanout;	/* handles of our fanin's fanout_t structure */

    pset_family F;		/* on-set */
    pset_family D;		/* dc-set -- currently unused */
    pset_family R;		/* off-set */

    node_t *copy;		/* used by network_dup(), network_append() */

    network_t *network;		/* network this node belongs to */
    lsHandle net_handle;	/* handle inside of network nodelist */

    char *simulation;		/* reserved for simulation package */
    char *factored;		/* reserved for factoring package */
    char *delay;		/* reserved for delay package */
    char *map;			/* reserved for mapping package */
    char *simplify;		/* reserved for simplify package */
    char *bdd;			/* reserved for bdd package */
    char *pld;			/* reserved for pld package */
    char *ite;			/* reserved for pld package */
    char *buf;			/* reserved for buffer package */
    char *cspf;			/* reserved for cspf (simplify) package */
    char *bin;			/* reserved for binning (mapping) package */
    char *atpg;			/* reserved for atpg package */
    char *undef1;		/* undefined 1 */
};

typedef pset node_cube_t;
typedef int node_literal_t;

#define foreach_fanin(node, i, p)					\
    for(i = 0, node->fanin_changed = 0;					\
	node->fanin_changed ? node_error(4) :				\
	    i < (node)->nin && (p = node->fanin[i]); i++)

#define foreach_fanout(node, gen, p)					\
    for(node->fanout_changed = 0, gen = node_fanout_init_gen(node);	\
	node->fanout_changed ? (node_t *) node_error(5) :		\
	    (p = node_fanout_gen(gen, NIL(int))); ) 

#define foreach_fanout_pin(node, gen, p, pin)				\
    for(node->fanout_changed = 0, gen = node_fanout_init_gen(node);	\
	node->fanout_changed ? (node_t *) node_error(5) :		\
	    (p = node_fanout_gen(gen, &pin)); )

#define node_get_cube(f_, i_)						\
    ((f_)->F ? 								\
	((i_) >= 0 && (i_) < (f_)->F->count ? GETSET((f_)->F, (i_)) : 	\
	    (node_cube_t) node_error(0)) 				\
        : (node_cube_t) node_error(1))

#define node_get_literal(c_, j_) 					\
    ((c_) ? GETINPUT((c_), (j_)) : (node_literal_t) node_error(2))


extern name_mode_t name_mode;

EXTERN node_t *node_alloc ARGS((void));
EXTERN void node_free ARGS((node_t *));
EXTERN node_t *node_dup ARGS((node_t *));
EXTERN void node_register_daemon ARGS((enum node_daemon_type_enum, void (*)()));
EXTERN network_t *node_network ARGS((node_t *));

EXTERN node_t *node_and ARGS((node_t *, node_t *));
EXTERN node_t *node_or ARGS((node_t *, node_t *));
EXTERN node_t *node_not ARGS((node_t *));
EXTERN node_t *node_xor ARGS((node_t *, node_t *));
EXTERN node_t *node_xnor ARGS((node_t *, node_t *));
EXTERN node_t *node_div ARGS((node_t *, node_t *, node_t **));
EXTERN node_t *node_literal ARGS((node_t *, int));
EXTERN node_t *node_constant ARGS((int));
EXTERN node_t *node_cofactor ARGS((node_t *, node_t *));
EXTERN node_t *node_simplify ARGS((node_t *, node_t *, enum node_sim_enum));
EXTERN node_t *node_largest_cube_divisor ARGS((node_t *));
EXTERN void node_replace ARGS((node_t *, node_t *));

EXTERN int node_contains ARGS((node_t *, node_t *));
EXTERN int node_equal ARGS((node_t *, node_t *));
EXTERN int node_equal_by_name ARGS((node_t *, node_t *));

EXTERN char *node_name ARGS((node_t *));
EXTERN char *node_long_name ARGS((node_t *));
EXTERN int node_num_literal ARGS((node_t *));
EXTERN int node_num_cube ARGS((node_t *));
EXTERN int *node_literal_count ARGS((node_t *));
EXTERN int node_num_fanin ARGS((node_t *));
EXTERN int node_num_fanout ARGS((node_t *));
EXTERN node_t *node_get_fanin ARGS((node_t *, int));
EXTERN node_t *node_get_fanout ARGS((node_t *, int));
EXTERN int node_get_fanin_index ARGS((node_t *, node_t *));
/* extern int node_get_fanout_index(); */

EXTERN void node_scc ARGS((node_t *));
EXTERN void node_d1merge ARGS((node_t *));
EXTERN int node_substitute ARGS((node_t *, node_t *, int));
EXTERN int node_collapse ARGS((node_t *, node_t *));
EXTERN void node_algebraic_cofactor ARGS((node_t *,node_t *,node_t **,node_t **,node_t **));
EXTERN int node_invert ARGS((node_t *));
EXTERN node_function_t node_function ARGS((node_t *));
EXTERN node_type_t node_type ARGS((node_t *));
EXTERN input_phase_t node_input_phase ARGS((node_t *, node_t *));

EXTERN void node_print ARGS((FILE *, node_t *));
EXTERN void node_print_negative ARGS((FILE *, node_t *));
EXTERN void node_print_rhs ARGS((FILE *, node_t *));

EXTERN void node_lib_process ARGS((network_t *));

EXTERN void node_minimum_base ARGS((node_t *));
EXTERN void node_replace_internal ARGS((node_t *, node_t **, int, struct set_family *));
EXTERN int node_patch_fanin ARGS((node_t *, node_t *, node_t *));
EXTERN int node_patch_fanin_index ARGS((node_t *, int, node_t *));
EXTERN int node_compare_id ARGS((char **, char **));

EXTERN pset_family node_sf_adjust ARGS((node_t *, node_t **, int));
EXTERN node_t **nodevec_dup ARGS((node_t **, int));
EXTERN node_t *node_create ARGS((struct set_family *, node_t **, int));
EXTERN void cautious_define_cube_size ARGS((int));
EXTERN void define_cube_size ARGS((int));
EXTERN void undefine_cube_size ARGS((void));
EXTERN void node_assign_name ARGS((node_t *));
EXTERN void node_assign_short_name ARGS((node_t *));
EXTERN int node_is_madeup_name ARGS((char *, int *));
EXTERN void fanin_remove_fanout ARGS((node_t *));
EXTERN void fanin_add_fanout ARGS((node_t *));

					/* exported for use in macros	*/
EXTERN int node_error ARGS((int));
EXTERN node_t *node_fanout_gen ARGS((lsList, int *));
EXTERN lsGen node_fanout_init_gen ARGS((node_t *));

#endif