enumerate.h File Reference

Contains functions for handling enumerations. More...

#include "defines.h"

Go to the source code of this file.

Functions
void	enumerate_add_item (vsignal *enum_sig, static_expr *value, func_unit *funit)
	Allocates, initializes and adds a new enumerated item to the given functional unit.
void	enumerate_end_list (func_unit *funit)
	Sets the last status of the last item in the enumerated list.
void	enumerate_resolve (funit_inst *inst)
	Resolves all enumerations within the given functional unit instance.
void	enumerate_dealloc (enum_item *ei)
	Deallocates all memory associated with the given enumeration.
void	enumerate_dealloc_list (func_unit *funit)
	Deallocates enumeration list from given functional unit.

---

Detailed Description

Contains functions for handling enumerations.

Author:

Trevor Williams (phase1geo@gmail.com)

Date:

8/29/2006

---

Function Documentation

void enumerate_add_item	(	vsignal *	enum_sig,
		static_expr *	value,
		func_unit *	funit
	)

Allocates, initializes and adds a new enumerated item to the given functional unit.

Parameters:

	enum_sig	Pointer to signal in database that represents an enumeration value
	value	Pointer to static expression that contains the value to be assigned to the signal during elaboration
	funit	Pointer to functional unit that this enumeration value will be added to

References func_unit_s::ei_head, func_unit_s::ei_tail, FALSE, enum_item_s::last, malloc_safe, enum_item_s::next, PROFILE, PROFILE_END, enum_item_s::sig, and enum_item_s::value.

Referenced by db_add_enum().

  { PROFILE(ENUMERATE_ADD_ITEM);

  enum_item* ei;  /* Pointer to newly allocated enumeration item */

  /* Allocate and initialize the enumeration item */
  ei = (enum_item*)malloc_safe( sizeof( enum_item ) );
  ei->sig   = enum_sig;
  ei->value = value;
  ei->last  = FALSE;
  ei->next  = NULL;

  /* Add it to the current functional unit's enumeration list */
  if( funit->ei_head == NULL ) {
    funit->ei_head = funit->ei_tail = ei;
  } else {
    funit->ei_tail->next = ei;
    funit->ei_tail       = ei;
  }

  PROFILE_END;

}

void enumerate_dealloc

(

enum_item *

ei

)

Deallocates all memory associated with the given enumeration.

Parameters:

ei

Pointer to enumeration to deallocate

References free_safe, PROFILE, PROFILE_END, static_expr_dealloc(), TRUE, and enum_item_s::value.

Referenced by enumerate_dealloc_list(), and struct_union_member_dealloc().

  { PROFILE(ENUMERATE_DEALLOC);

  if( ei != NULL ) {

    /* Deallocate static expression, if necessary */
    if( ei->value != NULL ) {
      static_expr_dealloc( ei->value, TRUE );
    }

    /* Deallocate ourself */
    free_safe( ei, sizeof( enum_item ) );

  }

  PROFILE_END;

}

void enumerate_dealloc_list

(

func_unit *

funit

)

Deallocates enumeration list from given functional unit.

Deallocates all memory associated with the enumeration list in the given functional unit

Parameters:

funit

Pointer to functional unit to remove enumeration list for

References func_unit_s::ei_head, func_unit_s::ei_tail, enumerate_dealloc(), enum_item_s::next, PROFILE, and PROFILE_END.

Referenced by funit_clean().

  { PROFILE(ENUMERATE_DEALLOC_LIST);

  enum_item* tmp;  /* Temporary pointer to current link in list */

  while( funit->ei_head != NULL ) {
    tmp  = funit->ei_head;
    funit->ei_head = tmp->next;
    enumerate_dealloc( tmp );
  }

  /* Set the tail pointer to NULL as well */
  funit->ei_tail = NULL;

  PROFILE_END;

}

void enumerate_end_list

(

func_unit *

funit

)

Sets the last status of the last item in the enumerated list.

Called after all enumerations have been parsed for this list.

Parameters:

funit

Pointer to functional unit to close out enumerated list

References func_unit_s::ei_tail, enum_item_s::last, PROFILE, PROFILE_END, and TRUE.

Referenced by db_end_enum_list().

  { PROFILE(ENUMERATE_END_LIST);

  /* Make sure that we aren't calling this function when there is no existing enumerated list */
  assert( funit->ei_tail != NULL );

  /* Set the last bit of the tail enumerated item */
  funit->ei_tail->last = TRUE;

  PROFILE_END;

}

void enumerate_resolve

(

funit_inst *

inst

)

Resolves all enumerations within the given functional unit instance.

Exceptions:

anonymous

Throw param_expr_eval

Resolves all enumerated values for their value for the given instance. This needs to be called during elaboration after all signals have been sized and parameters have been resolved.

Parameters:

inst

Pointer to functional unit instance to resolve all enumerated values

References func_unit_s::ei_head, static_expr_s::exp, FATAL, FATAL_WRAP, func_unit_s::filename, funit_inst_s::funit, vsuppl_u::is_signed, enum_item_s::last, vsignal_s::line, enum_item_s::next, static_expr_s::num, obf_file, param_expr_eval(), vsuppl_u::part, print_output(), PROFILE, PROFILE_END, enum_item_s::sig, vector_s::suppl, Throw, TRUE, vector_s::ul, user_msg, USER_MSG_LENGTH, vector_s::value, expression_s::value, enum_item_s::value, vsignal_s::value, vector_from_int(), vector_is_unknown(), vector_set_value_ulong(), vector_to_int(), and vector_s::width.

Referenced by funit_size_elements().

  { PROFILE(ENUMERATE_RESOLVE);

  enum_item* ei;                 /* Pointer to current enumeration item in the given functional unit */
  int        last_value = 0;     /* Value of last value for this enumeration */
  bool       first      = TRUE;  /* Specifies if the current enumeration is the first */
  bool       is_signed;          /* Contains original value of signedness of signal */

  assert( inst != NULL );

  ei = inst->funit->ei_head;
  while( ei != NULL ) {

    assert( ei->sig->value != NULL );

    /* Store signedness */
    is_signed = ei->sig->value->suppl.part.is_signed;

    /* If no value was assigned, we need to assign one now */
    if( ei->value == NULL ) {

      if( first ) {
        (void)vector_from_int( ei->sig->value, 0 );
      } else if( last_value == -1 ) {
        unsigned int rv;
        print_output( "Implicit enumerate assignment cannot follow an X or Z value", FATAL, __FILE__, __LINE__ );
        rv = snprintf( user_msg, USER_MSG_LENGTH, "File: %s, Line: %d", obf_file( inst->funit->filename ), ei->sig->line );
        assert( rv < USER_MSG_LENGTH );
        print_output( user_msg, FATAL_WRAP, __FILE__, __LINE__ );
        Throw 0;
      } else {
        (void)vector_from_int( ei->sig->value, (last_value + 1) );
      }

    /* Otherwise, reduce the static_expr value to a number and assign it */
    } else {

      if( ei->value->exp == NULL ) {
        (void)vector_from_int( ei->sig->value, ei->value->num );
      } else {
        param_expr_eval( ei->value->exp, inst );
        (void)vector_set_value_ulong( ei->sig->value, ei->value->exp->value->value.ul, ei->sig->value->width );
      }

    }

    /* Put back the original signedness */
    ei->sig->value->suppl.part.is_signed = is_signed;
        
    /* Set the first value to indicate if the next value is the first in the list */
    first = ei->last;

    /* Set last_value to that of this this signal value */
    if( !vector_is_unknown( ei->sig->value ) ) {
      last_value = vector_to_int( ei->sig->value );
    } else {
      last_value = -1;
    }

    ei = ei->next;

  }

  PROFILE_END;

}