src/hrc/hrcHierarchy.c

Go to the documentation of this file.

#include "hrcInt.h"

static char rcsid[] UNUSED = "$Id: hrcHierarchy.c,v 1.4 2005/04/16 04:23:47 fabio Exp $";

/*---------------------------------------------------------------------------*/
/* Constant declarations                                                     */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Type declarations                                                         */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Stucture declarations                                                     */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Variable declarations                                                     */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Macro declarations                                                        */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Static function prototypes                                                */
/*---------------------------------------------------------------------------*/

static Hrc_Node_t * _HrcCreateHierarchyAux(Hrc_Manager_t *hmgr, Hrc_Model_t *model, char *instanceName, st_table *pathTable);
static int _HrcConnectParentChild(Hrc_Node_t *parent, Hrc_Node_t *child, Hrc_Subckt_t *subckt);

/*---------------------------------------------------------------------------*/
/* Definition of exported functions                                          */
/*---------------------------------------------------------------------------*/

Hrc_Node_t *
Hrc_ModelCreateHierarchy(
  Hrc_Manager_t *hmgr,
  Hrc_Model_t *model,
  char *instanceName)
{
  st_table *pathTable = st_init_table(st_ptrcmp,st_ptrhash);
  Hrc_Node_t *rootNode = _HrcCreateHierarchyAux(hmgr,model,instanceName,pathTable);
  st_free_table(pathTable);
  return rootNode;
}
    

/*---------------------------------------------------------------------------*/
/* Definition of internal functions                                          */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/* Definition of static functions                                            */
/*---------------------------------------------------------------------------*/
static Hrc_Node_t *
_HrcCreateHierarchyAux(
  Hrc_Manager_t *hmgr,
  Hrc_Model_t *model,
  char *instanceName,
  st_table *pathTable)
{
  Hrc_Node_t *rootNode, *childNode;
  Hrc_Model_t *modelToBeInstantiated;
  Hrc_Subckt_t *subckt;
  st_generator *gen;

  if (st_is_member(pathTable,(char *)model) == 1){
    error_append("Model ");
    error_append(Hrc_ModelReadName(model));
    error_append(" is defined by using itself.\n");
    return NIL(Hrc_Node_t);
  }
  rootNode = Hrc_NodeDup(Hrc_ModelReadMasterNode(model),instanceName);
  (void)st_insert(pathTable,model,NULL);

  Hrc_ModelForEachSubckt(model,gen,instanceName,subckt){
    modelToBeInstantiated = Hrc_SubcktReadModel(subckt);
    childNode = _HrcCreateHierarchyAux(hmgr,modelToBeInstantiated,Hrc_SubcktReadInstanceName(subckt),pathTable);
    if (childNode == NIL(Hrc_Node_t)){
      return NIL(Hrc_Node_t);
    }
    if (_HrcConnectParentChild(rootNode,childNode,subckt) == 0){
      return NIL(Hrc_Node_t);
    }
  }
  (void)st_delete(pathTable,&model,NULL);
  return rootNode;
}


static int
_HrcConnectParentChild(
  Hrc_Node_t *parent, 
  Hrc_Node_t *child,
  Hrc_Subckt_t *subckt)
{
  array_t *actualInputVars, *actualOutputVars;
  array_t *realActualInputVars, *realActualOutputVars;
  int i;
  Var_Variable_t *var, *realVar;

  /* actual inputs and outputs in the master hnode corresponsing to the parent */
  actualInputVars = Hrc_SubcktReadActualInputVars(subckt);
  actualOutputVars = Hrc_SubcktReadActualOutputVars(subckt);

  /* collect all the actual inputs in the parent */
  realActualInputVars = array_alloc(Var_Variable_t *,0);
  for (i=0; i < array_n(actualInputVars); i++){
    var = array_fetch(Var_Variable_t *,actualInputVars,i);
    realVar = Hrc_NodeFindVariableByName(parent,Var_VariableReadName(var)); 
    array_insert_last(Var_Variable_t *,realActualInputVars,realVar);
  }
  /* collect all the actual outputs in the parent */
  realActualOutputVars = array_alloc(Var_Variable_t *,0);
  for (i=0; i < array_n(actualOutputVars); i++){
    var = array_fetch(Var_Variable_t *,actualOutputVars,i);
    realVar = Hrc_NodeFindVariableByName(parent,Var_VariableReadName(var)); 
    array_insert_last(Var_Variable_t *,realActualOutputVars,realVar);
  }
  /* connects the parent and the child using an hrc function */
  if (Hrc_NodeAddChild(parent,child,realActualInputVars,realActualOutputVars) == 0){
     return 0;
  }
  return 1;
}