Table Module Implementation Specifications

Client Specifications

• Purpose
• Client Data Model
• Importing Information
• Table Configuration
• Public Data Types
• Public Functions

Implementation Data Model

Private Importing Information

Private Data Type Implementations

• HashList - HashList is a pointer to a HashListNode.

• HashListNode - A HashListNode is a struct with the following members:
  • char * key
  • Data data
  • HashList next

• HashTableStructure - A HashTableStructure is a struct with the following members:
  • char * cacheKey
  • HashList cacheTrailer
  • HashList cachePointer
  • int cacheHashVal
  • HashList hashLists[16]

Public Data Type Implementations

• Table - Table is typedefed as a pointer to a HashTableStructure.

Private Function Specifications

CATEGORY

• FUNCTION_SYNOPSIS
  FUNCTION_COMMENT

  Preconditions:
  FUNCTION_PRECONDITIONS

• FUNCTION_NAME
  Specification

  ALGORITHM_DESCRIPTION
  

Public Function Algorithms

• newTable
  Client Specification

  allocate a TableStructure with malloc
  set all of the hash lists of the TableStructure to null
  return the pointer to the TableStructure
  

• freeTable
  Client Specification

  parameter: Table tbl
  
  clear tbl
  cfree tbl
  

• isKey
  Client Specification

  parameter: Table tbl
  parameter: char * k
  
  FIXME
  

• dataFor
  Client Specification

  parameter: Table tbl
  parameter: char * k
  
  if tbl->cacheKey is null or tbl->cacheKey is not the same as k
      call isKey with parameters tbl and k
  if tbl->cachePointer is null
      terminate the program with a precondition violation error message
  return tbl->cachePointer->data
  

• add
  Client Specification

  parameter: Table tbl
  parameter: char * k
  parameter: Data dat
  
  if tbl->cacheKey is null or tbl->cacheKey is not the same as k
      call isKey with parameters tbl and k
  if tbl->cachePointer is not null
      terminate the program with a precondition violation error message
  get a new HashListNode with key k and data dat
  insert it at the beginning of tbl->hashList[cacheHashVal]
  

• remove
  Client Specification

  parameter: Table tbl
  parameter: char * k
  
  if tbl->cacheKey is null or tbl->cacheKey is not the same as k
      call isKey with parameters tbl and k
  if tbl->cachePointer is null
      terminate the program with a precondition violation error message
  if tbl->cacheTrailer is null
  else
      remove the HashListNode that is linked to tbl->cacheTrailer
  

• clear
  Client Specification

  parameter: Table tbl
  
  FIXME
  

• iteratorFor
  Client Specification See TableIterator Module Implementation Specifications