Routines in Pseud_rtn.c

The file contains the following routines:


BUILD_NAMELIST: Routine to build a list of related names from an author name

/************************************************************************/
/*																		*/
/*    BUILD_NAMELIST - Build the list of names related to an author		*/
/*																		*/
/*    Calling Format:													*/
/*																		*/
/*		BUILD_NAMELIST (inpnam_ptr, namelist, nametype, coauthors,		*/
/*						srclist, birthdate, deathdate, prtfil_ptr);		*/
/*																		*/
/*    Where:															*/
/*																		*/
/*		inpnam_ptr  = Pointer to input author name						*/
/*		namelist    = Array of pointer to associated names				*/
/*      nametype    = Array of types for associated names				*/
/*			AUTHLIST_VAR = Variant name									*/
/*			AUTHLIST_FULL = Full author name							*/
/*			AUTHLIST_PSEUD = Pseudonym									*/
/*			AUTHLIST_JOINT = Joint Pseudonym							*/
/*			AUTHLIST_HOUSE = House Pseudonym							*/
/*		coauthors   = Array of pointer to coauthor names				*/
/*		srclist     = Array of pointer to name sources					*/
/*		birthdate   = Buffer to hold birth date in form CCYYMMDD		*/
/*		deathdate   = Buffer to hold death date in form CCYYMMDD		*/
/*		prtfil_ptr  = Pointer to diagnostics file						*/
/*																		*/
/*    Note that each of namelist, nametype, coauthors, and srclist		*/
/*    have AUTHLIST_NUM entries and will be set up to include the		*/
/*    input name as well as others.										*/
/*																		*/
/************************************************************************/

CHECK_NAME: Routine to check a name to see if it's in error

/************************************************************************/
/*																		*/
/*    CHECK_NAME - Check name to see if it needs correcting				*/
/*																		*/
/*    Calling Format:													*/
/*																		*/
/*		status = CHECK_NAME (name_ptr, newnam_ptr, prtfil_ptr);			*/
/*																		*/
/*    Where:															*/
/*																		*/
/*		status      = PSP_TRUE if name matched							*/
/*				    = PSP_FALSE otherwise								*/
/*		name_ptr	= Buffer containing old name						*/
/*		newnam_ptr  = Buffer to hold pointer to new name				*/
/*					= set to name_ptr if no new name					*/
/*		prtfil_ptr	= Pointer to diagnostics file handle				*/
/*																		*/
/*    This routine checks the names array to see if the name			*/
/*    needs to be corrected in the source file.							*/
/*																		*/
/************************************************************************/

FIND_NAME: Find subscript of first record for name

/************************************************************************/
/* */
/* FIND_NAME - Find subscript of first record for name */
/* */
/* Calling Format: */
/* */
/* name_sub = FIND_NAME (name_ptr, prtfil_ptr); */
/* */
/* Where: */
/* */
/* name_sub = Subscript of first record for specified name */
/* = -1 if no match found */
/* prtfil_ptr = Pointer to diagnostics file handle */
/* */
/* This routine checks the pseudonym arrays to find a match */
/* */
/************************************************************************/

FREE_PSEUD: Routine to free the PSEUD data structures

/************************************************************************/
/*					                                    				*/
/*    FREE_PSEUD - Free memory allocated to pseudonyms		  			*/
/*		                                    							*/
/*    Calling Format:                       							*/
/*									                                    */
/*	    FREE_PSEUD ();						                			*/
/*																		*/
/*    This routine simply checks the pseudonym structures, freeing		*/
/*	  up any allocated memory.                                 			*/
/*									                                    */
/************************************************************************/

GET_PSEUD: Routine to find a matching record in the PSEUD data structures

/************************************************************************/
/*																		*/
/*    GET_PSEUD - Get pseudonym record									*/
/*																		*/
/*    Calling Format:													*/
/*																		*/
/*		status = GET_PSEUD (name_ptr, reqtyp_ptr, type_ptr, descr_ptr,	*/
/*							secnam_ptr, dates_ptr, source_ptr,			*/
/*							prtfil_ptr);								*/
/*																		*/
/*    Where:															*/
/*																		*/
/*		status      = PSP_TRUE if name matched							*/
/*				    = PSP_FALSE otherwise								*/
/*		name_ptr	= Buffer containing name to match					*/
/*		reqtyp_ptr	= Type of record wanted								*/
/*		type_ptr	= Buffer to hold pointer to type					*/
/*					  (May be NULL if name not wanted)					*/
/*		descr_ptr   = Buffer to hold pointer to description				*/
/*					  (May be NULL if name not wanted)					*/
/*		secnam_ptr  = Buffer to hold pointer to secondary name			*/
/*					  (May be NULL if name not wanted)					*/
/*		dates_ptr	= Buffer to hold pointer to dates					*/
/*					  (May be NULL if dates not wanted)					*/
/*		source_ptr	= Buffer to hold pointer to source					*/
/*					  (May be NULL if source not wanted)				*/
/*		prtfil_ptr	= Pointer to diagnostics file handle				*/
/*																		*/
/*    This routine checks the pseudonym arrays to find a match			*/
/*																		*/
/************************************************************************/

TRANS_NAME: Routine to translate a name into the "standard" format

/************************************************************************/
/*																		*/
/*    TRANS_NAME - Translate name into sort name						*/
/*																		*/
/*    Calling Format:													*/
/*																		*/
/*		status = TRANS_NAME (name_ptr, srtnam_ptr, prtfil_ptr);			*/
/*																		*/
/*    Where:															*/
/*																		*/
/*		status      = PSP_TRUE if name matched							*/
/*				    = PSP_FALSE otherwise								*/
/*		name_ptr	= Buffer containing old name						*/
/*		srtnam_ptr  = Buffer to hold pointer to sorted name				*/
/*					= set to name_ptr if no sorted name					*/
/*		prtfil_ptr	= Pointer to diagnostics file handle				*/
/*																		*/
/*    This routine checks the name array to see if the name				*/
/*    needs to be translated when adding to STORY.IDX.					*/
/*																		*/
/************************************************************************/

VAL_PSEUD: Routine to validate the PSEUD data structures

/************************************************************************/
/*					                                    				*/
/*    VAL_PSEUD - Validate the pseudonym structures			  			*/
/*		                                    							*/
/*    Calling Format:                       							*/
/*									                                    */
/*	    VAL_PSEUD (prtfil_ptr);				                			*/
/*									                                    */
/*    Where:															*/
/*																		*/
/*		prtfil_ptr	= Pointer to diagnostics file handle				*/
/*									                                    */
/*    This routine validates the records in the pseudonym structures	*/
/*									                                    */
/************************************************************************/