Preliminary Design Review Document - GEN v8 Team 93su523 - July 8, 1993


1 Overview

	This document describes the changes to be made to to CHGEN v7 to
incorporate the PGEN set and get field macros and the pr_add routine.
It also describes documentation updates and test plans for the merge.


2 Functional Requirements

	CHGEN v8 will retain the current v7 features (8 or 12 character
keys internally stored as 32-bit integers) and also gain the added features
of PGEN, the set field and get field macros and new pr_add routines.
For functional requirements of these two separate projects please see
the appropriate PDR document.


3 Impact Analysis

	Merging PGEN into CHGEN v7 will affect the following files:

gen_defines.c		714 lines to be merged
gen_pr_add.c		957 lines to be merged
gen_load_data.c		236 lines to be merged
gen_pr_delete.c		188 lines to be merged
gen_pr_dump.c		17 lines to be merged
gen_pr_free.c		40 lines to be merged
gen_pr_utils.c		23 lines to be merged

See "Planned Code Changes" for a more detailed description of what
needs to be done to these files.


4 Project Breakdown

	4.1 Environment setup					(6 hours)

		Base directory			(mike)
		SCCS directory			(mike)
		User directory/envt setup	(mike)
		Familiarization with tools	(all)

	4.2 PDR							(10 hours)

		Assess CHGEN v7 and PGEN code	(all)
		Assess current documentation	(all)
		Determine test plans		(all)
		Identify tasks and breakdown	(all)

	4.3 Test Plan				(justin/mike)	(10 hours)

	4.4 Code Merge				(all)		(25 hours)

	4.5 Testing				(justin)	(10 hours)

	4.6 Documentation changes		(mike/surekha)	(35 hours)

	4.6 Final Report			(all)		(10 hours)


5 Test Plan

	We are planning to merge the CHGEN v7 and PGEN test cases
to work with the new version.  We might also try to update the BDE
project to use as a test case (although this is supposed to be done
by the BDE team).


6 Planned Code Changes

	gen_defines.c:			(mike)

		define the pr_add macro
		add the get/set field macro definitions
		add the default key assignment flag
		change all these to work with the new v7 keys
		other miniscule changes

	gen_pr_add.c:			(mike)

		add the rr_data structure
		add the pr_link macro and associated functions
		add the pr_add macro and associated functions
		add the pr_gen_create function
		add the gen_pr_add_macros function
		add the pr_gen_key, pr_gen_pkey, pr_check_fkey,
			and pr_check_str macros
		change all these to work with the new v7 keys

	gen_pr_dump.c:         (justin)

		change default statement (only line changed by pgen)
		to allow differnt field types

	gen_pr_free.c:         (justin)

		add gen_pr_free_macros macro and change to work with    
		the new v7 keys

	gen_pr_utils.c:        (justin)

		add includes and conditional compiler directives 
		inserted by pgen

	gen_load_data.c:		(surekha)

		add the function gen_pr_parse()
		add the function encoding()

	gen_pr_delete.c:		(surekha)

		add the macro gen_pr_unlink_macros()


7 Documentation Changes

	The CHGEN User's Manual needs to be totally rewritten.  It is
in very poor shape.  Some of the items from the help files will be used
in this effort.  The help files may need to be rewritten as well.
The bug list/release notes will be updated.  All the IDraw files will
be updated as well.