PA05 Initialization
++ PA05 Project Files ++ Makefile for PA05
This commit is contained in:
parent
000ba2fb13
commit
108632e832
14 changed files with 3679 additions and 0 deletions
223
PA05-1004/ArrayDataEngine.h
Normal file
223
PA05-1004/ArrayDataEngine.h
Normal file
|
|
@ -0,0 +1,223 @@
|
|||
#ifndef ARRAY_DATA_ENGINE_H
|
||||
#define ARRAY_DATA_ENGINE_H
|
||||
|
||||
// header files
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <stdbool.h>
|
||||
#include <string.h>
|
||||
#include "StandardConstants.h"
|
||||
|
||||
// data structures
|
||||
typedef struct StateDataStruct
|
||||
{
|
||||
char name[ STD_STR_LEN ];
|
||||
|
||||
int population;
|
||||
|
||||
double growth;
|
||||
|
||||
char majority;
|
||||
} StateDataType;
|
||||
|
||||
typedef struct StateArrayStruct
|
||||
{
|
||||
StateDataType *array;
|
||||
|
||||
int size, capacity;
|
||||
} StateArrayType;
|
||||
|
||||
typedef enum { NOT_FOUND = -1, FOUND } FoundType;
|
||||
|
||||
// Function prototypes
|
||||
|
||||
/*
|
||||
Name: clearDataStructure
|
||||
Process: deallocates memory for the array data structure
|
||||
and encapsulated state data,
|
||||
returns NULL to calling function
|
||||
Function input/parameters: pointer to state data array (StateDataArray *)
|
||||
Function output/parameters: none
|
||||
Function output/returned: NULL
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: free
|
||||
*/
|
||||
StateArrayType *clearDataStructure( StateArrayType *arrayPtr );
|
||||
|
||||
/*
|
||||
Name: copyDataList
|
||||
Process: copies elements from one state data array to another
|
||||
resets array size as needed,
|
||||
also resets array capacity as needed if destination array type
|
||||
capacity is less than capacity of source array type
|
||||
Function input/parameters: source state data array type (StateArrayType *)
|
||||
Function output/parameters: pointer to destination state data array type
|
||||
(StateArrayType *)
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: privateCheckForResize, deepCopyData
|
||||
*/
|
||||
void copyDataList( StateArrayType *dest, const StateArrayType src );
|
||||
|
||||
/*
|
||||
Name: createDataStructure
|
||||
Process: dynamically creates instance of state array type
|
||||
along with dynamically allocating the state data array within it
|
||||
Function input/parameters: given initial capacity (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: pointer to state array type (StateArrayType *)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: malloc, sizeof (C keyword)
|
||||
*/
|
||||
StateArrayType *createDataStructure( int initialCapacity );
|
||||
|
||||
/*
|
||||
Name: deepCopyData
|
||||
Process: copies all members of a StateDataType item into another one
|
||||
Function input/parameters: state data type item (const StateDataType )
|
||||
Function output/parameters: pointer to state data item (StateDataType *)
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: privateCopyString
|
||||
*/
|
||||
void deepCopyData( StateDataType *dest, const StateDataType src );
|
||||
|
||||
/*
|
||||
Name: displayData
|
||||
Process: displays comma-delimited data items in array if array is not empty,
|
||||
otherwise displays "Data not found - Display aborted",
|
||||
allows for subtitle to be added to "Display Data - "
|
||||
Function input/parameters: state array type (const StateArrayType),
|
||||
subtitle (const char *)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/monitor: data displayed as specified
|
||||
Dependencies: printf, listIsEmpty
|
||||
*/
|
||||
void displayData( const StateArrayType stateData, const char *subTitle );
|
||||
|
||||
/*
|
||||
Name: getItemAtIndex
|
||||
Process: checks for index within bounds,
|
||||
acquires and returns the value as a parameter,
|
||||
and returns true,
|
||||
otherwise sets data in parameter to empty and returns false
|
||||
Function input/parameters: state array type (const StateArrayType),
|
||||
list index (int)
|
||||
Function output/parameters: value if found,
|
||||
otherwise, value set to empty (StateDataType *)
|
||||
Function output/returned: Boolean result of operation (bool)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: deepCopyData, setItemToEmpty
|
||||
*/
|
||||
bool getItemAtIndex( StateDataType *returnVal,
|
||||
const StateArrayType stateData, int listIndex );
|
||||
|
||||
/*
|
||||
Name: getListSize
|
||||
Process: provides the size of the list
|
||||
Function input/parameters: state array type (const StateArrayType)
|
||||
Function output/parameters: none
|
||||
Function output/returned: size of the list (int)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: none
|
||||
*/
|
||||
int getListSize( const StateArrayType stateData );
|
||||
|
||||
/*
|
||||
Name: insertItemAtIndex
|
||||
Process: checks for index in bounds, inserts item at index, returns true,
|
||||
resizes array as needed,
|
||||
if index not in bounds, returns false
|
||||
Function input/parameters: pointer to state array type (StateArrayType *),
|
||||
StateDataType item to insert (const StateDataType),
|
||||
index for insertion (int)
|
||||
Function output/parameters: updated pointer to state array type
|
||||
(StateArrayType *)
|
||||
Function output/returned: Boolean result of specified process (bool)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: checkForResize
|
||||
*/
|
||||
bool insertItemAtIndex( StateArrayType *stateData,
|
||||
StateDataType toBeInserted, int insertIndex );
|
||||
|
||||
/*
|
||||
Name: listIsEmpty
|
||||
Process: returns true if list is empty, false otherwise
|
||||
Function input/parameters: state array type (const StateArrayType)
|
||||
Function output/parameters: none
|
||||
Function output/returned: Boolean result of test as specified (bool)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: none
|
||||
*/
|
||||
bool listIsEmpty( const StateArrayType array );
|
||||
|
||||
/*
|
||||
Name: privateCheckForResize
|
||||
Process: checks if array needs to be resized,
|
||||
resizes (increases capacity of) array to double current capacity
|
||||
Function input/parameters: pointer to state array type (StateArrayType *)
|
||||
Function output/parameters: updated pointer
|
||||
to state array type (StateArrayType *)
|
||||
if resize has taken place,
|
||||
otherwise array type is unchanged
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: malloc, sizeof (C keyword), deepCopyData, free
|
||||
*/
|
||||
void privateCheckForResize( StateArrayType *stateData );
|
||||
|
||||
/*
|
||||
Name: privateCopyString
|
||||
Process: copies string character for character up to NULL_CHAR of source string
|
||||
Function input/parameters: source string to be copied (const char *)
|
||||
Function output/parameters: destination string (char *)
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: none
|
||||
*/
|
||||
void privateCopyString( char *dest, const char *src );
|
||||
|
||||
/*
|
||||
Name: removeItemAtIndex
|
||||
Process: removes from array at index, shifts data down as needed,
|
||||
returns true if found, false otherwise
|
||||
Function input/parameters: pointer to state array type (StateArrayType *),
|
||||
index to remove (int)
|
||||
Function output/parameters: pointer to updated state array type
|
||||
(StateArrayType *),
|
||||
pointer to removed item (StateDataType *)
|
||||
Function output/returned: Boolean result of removal operation (bool)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: none
|
||||
*/
|
||||
bool removeItemAtIndex( StateArrayType *stateData,
|
||||
StateDataType *removedItem, int removeIndex );
|
||||
|
||||
/*
|
||||
Name: setItemToEmpty
|
||||
Process: sets state data type struct to empty or default values,
|
||||
including empty string and majority 'x'
|
||||
Function input/parameters: pointer to state data value (StateDataType *)
|
||||
Function output/parameters: pointer to updated state data value
|
||||
(StateDataType *)
|
||||
Function output/returned: none
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: none
|
||||
*/
|
||||
void setItemToEmpty( StateDataType *data );
|
||||
|
||||
#endif // ARRAY_DATA_ENGINE_H
|
||||
590
PA05-1004/Console_IO_Utility.c
Normal file
590
PA05-1004/Console_IO_Utility.c
Normal file
|
|
@ -0,0 +1,590 @@
|
|||
// Header files included
|
||||
#include "Console_IO_Utility.h"
|
||||
|
||||
// Function Implementations
|
||||
|
||||
/*
|
||||
Name: clearLeadingCharacters
|
||||
Process: Clears all leading non-printable characters from the console stream
|
||||
Function input/parameters: allow space return (Boolean)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first printable character as integer
|
||||
Device input/keyboard: none
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar
|
||||
*/
|
||||
int clearLeadingCharacters( bool allowSpaceReturn )
|
||||
{
|
||||
// initialize data, set input character to getChar, set count to zero
|
||||
// function: getchar
|
||||
int intChar = getchar();
|
||||
int charCount = 0;
|
||||
|
||||
// loop while non-printable characters and space if not set
|
||||
// also limits looping to constant limit
|
||||
while( ( intChar < (int)SPACE
|
||||
|| ( !allowSpaceReturn && intChar == SPACE ) )
|
||||
&& charCount < MAX_STR_LEN )
|
||||
{
|
||||
// update character count
|
||||
charCount++;
|
||||
|
||||
// get new input character
|
||||
// function: getchar
|
||||
intChar = getchar();
|
||||
}
|
||||
|
||||
// return captured character
|
||||
return intChar;
|
||||
}
|
||||
|
||||
/*
|
||||
|
||||
Name: getChar
|
||||
Process: returns next character in stream,
|
||||
ignores all white space (including SPACE) prior to character
|
||||
Function input/parameters: flag to accept space (Boolean)
|
||||
Function output/parameters: none
|
||||
Function output/returned: one character (char) is returned to calling method
|
||||
Device input/keyboard: places one or more characters in stream
|
||||
Device output/monitor: none
|
||||
Dependencies: getCharFiltered
|
||||
*/
|
||||
char getChar()
|
||||
{
|
||||
// initialize variables, set space accept flag to false
|
||||
bool dontAcceptSpace = false;
|
||||
|
||||
// call filtered function with space accept flag
|
||||
// function: getCharFiltered
|
||||
return getCharFiltered( dontAcceptSpace );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: getCharFiltered
|
||||
Process: returns next character in stream,
|
||||
ignores non printable characters prior to input character
|
||||
but may accept space depending on flag
|
||||
Function input/parameters: flag to accept space (boolean)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first printable character or space (if configured)
|
||||
returned (char)
|
||||
Device input/keyboard: places one or more characters in stream
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar(), clearLeadingCharacters
|
||||
*/
|
||||
char getCharFiltered( bool acceptSpace )
|
||||
{
|
||||
//Initialize variables
|
||||
int inCharInt;
|
||||
|
||||
// clear leading characters, capture first usable character
|
||||
// function: clearLeadingCharacters
|
||||
inCharInt = clearLeadingCharacters( acceptSpace );
|
||||
|
||||
// check for input character set to end of file
|
||||
if( inCharInt == EOF )
|
||||
{
|
||||
// return character zero
|
||||
return '0';
|
||||
}
|
||||
|
||||
// return input character as character
|
||||
return (char)inCharInt;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: getInputString
|
||||
Process: acquires input string from keyboard, if clear white space flag set,
|
||||
ignores all white space, including space character
|
||||
Function input/parameters: clear white space control (Boolean)
|
||||
Function output/parameters: character array (char[])
|
||||
Function output/returned: none
|
||||
Device input/keyboard: user entry of a character stream
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar(), clearLeadingCharacters
|
||||
*/
|
||||
void getInputString( char inputArr[], bool clearWhiteSpace )
|
||||
{
|
||||
//Initialize Variables, set character count and index to zero
|
||||
int charCount = 0;
|
||||
int index = 0;
|
||||
int intChar;
|
||||
|
||||
// check for clear white space flag
|
||||
if( clearWhiteSpace )
|
||||
{
|
||||
// clear leading characters, set flag to ignore space
|
||||
// function: clearLeadingCharacters
|
||||
intChar = clearLeadingCharacters( !clearWhiteSpace );
|
||||
}
|
||||
|
||||
// otherwise, assume white space flag not set
|
||||
else
|
||||
{
|
||||
// get first character
|
||||
// function: getchar
|
||||
intChar = getChar();
|
||||
}
|
||||
|
||||
// loop until enter key found, limit loop to constant
|
||||
while( intChar != (int)NEWLINE_CHAR && charCount < MAX_STR_LEN )
|
||||
{
|
||||
// set current value to array element
|
||||
inputArr[ index ] = (char)intChar;
|
||||
|
||||
// increment string array index
|
||||
index++;
|
||||
|
||||
// add null character to end of string array
|
||||
inputArr[ index ] = NULL_CHAR;
|
||||
|
||||
// increment character count
|
||||
charCount++;
|
||||
|
||||
// get next character
|
||||
// function: getchar
|
||||
intChar = getchar();
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printCharacter
|
||||
Process: prints a single character
|
||||
Function input/parameters: character to be printed (char)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device input/keyboard: None
|
||||
Device output/monitor: character printed as specified
|
||||
Dependencies: printCharacters
|
||||
*/
|
||||
void printCharacter( char outputChar )
|
||||
{
|
||||
// initialize number of characters to one
|
||||
int numberOfChars = 1;
|
||||
|
||||
// print one character
|
||||
// function: printChars
|
||||
printCharacters( numberOfChars, outputChar );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printCharacters
|
||||
Process: prints given number of characters
|
||||
Function input/parameters: number of characters (int),
|
||||
character to be printed (char)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device input/keyboard: None
|
||||
Device output/monitor: Number of specified characters printed
|
||||
Dependencies: printf
|
||||
*/
|
||||
void printCharacters( int numChars, char outputChar )
|
||||
{
|
||||
// check for reminaing characters to print
|
||||
if( numChars > 0 )
|
||||
{
|
||||
// print one character
|
||||
// function: printf
|
||||
printf( "%c", outputChar );
|
||||
|
||||
// (recursive) print remaining characters
|
||||
// function: printChars
|
||||
printCharacters( numChars - 1, outputChar );
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printDouble
|
||||
Process: simple print double function
|
||||
Function input/parameters:
|
||||
outVal - the double value to be output (double)
|
||||
precision - the number of digits to the right of the decimal point (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one double value displayed
|
||||
Dependencies: printDoubleJustified
|
||||
*/
|
||||
void printDouble( double outVal, int precision )
|
||||
{
|
||||
// initialize variables, set block size to zero and justified to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// call justified function with specified parameters
|
||||
// function: printDoubleJustified
|
||||
printDoubleJustified( outVal, precision, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printDoubleJustified
|
||||
Process: the precision is set for the double value, then the pre-spaces
|
||||
and post-spaces are calculated for the requested justification,
|
||||
and then the pre-spaces are printed, the double value is printed,
|
||||
and then the post-spaces are printed
|
||||
Function input/parameters:
|
||||
outVal - the double value to be output (double)
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one double value displayed, justified, with precision
|
||||
Dependencies: formatDouble, printStringJustified
|
||||
*/
|
||||
void printDoubleJustified( double outVal, int precision,
|
||||
int blockSize, const char* justify )
|
||||
{
|
||||
// initialize variables, create temp string for configuration string
|
||||
char specStr[ MIN_STR_LEN ];
|
||||
|
||||
// initialize variables, create temporary output string
|
||||
char outStr[ MIN_STR_LEN ];
|
||||
|
||||
// set configuration string with precision value
|
||||
// function: sprintf
|
||||
sprintf( specStr, "%s0.%dlf", "%", precision );
|
||||
|
||||
// set output string
|
||||
// function: sprintf
|
||||
sprintf( outStr, specStr, outVal );
|
||||
|
||||
// print string justified
|
||||
// function: printStringJustified
|
||||
printStringJustified( outStr, blockSize, justify );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printEndline
|
||||
Process: prints single endline character to end a line or create vertical space
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one endline character output
|
||||
Dependencies: printf
|
||||
*/
|
||||
void printEndline()
|
||||
{
|
||||
// print one newline character
|
||||
// function: printf
|
||||
printf( "\n" );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printEndlines
|
||||
Process: prints the specified number of endline characters
|
||||
to end a line and/or create vertical space(s)
|
||||
Function input/parameters: number of endlines (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: endline characters output as specified
|
||||
Dependencies: printEndline
|
||||
*/
|
||||
void printEndlines( int numEndlines )
|
||||
{
|
||||
// check for number of end lines remaining
|
||||
if( numEndlines > 0 )
|
||||
{
|
||||
// print one endling
|
||||
// function: printEndline
|
||||
printEndline();
|
||||
|
||||
// (recursive) print remaining end lines
|
||||
printEndlines( numEndlines - 1 );
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printInteger
|
||||
Process: prints integer value
|
||||
Function input/parameters: outVal - the integer value to be output
|
||||
Output: None
|
||||
Device Input: None
|
||||
Device Output: Integer is displayed as specified
|
||||
Dependencies: printIntegerJustified
|
||||
*/
|
||||
void printInteger( int outVal )
|
||||
{
|
||||
// initialize variables, set block size to zero, justifification to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// print justified integer with specified parameters
|
||||
// function: printIntegerJustified
|
||||
printIntegerJustified( outVal, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printIntegerJustified
|
||||
Process: prints integer value with the specified justification
|
||||
within the specified blockSize
|
||||
Function input/parameters:
|
||||
outVal - the integer value to be output
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Output: None
|
||||
Device Input: None
|
||||
Device Output: Integer is displayed as specified
|
||||
Dependencies: sprintf, printStringJustified
|
||||
*/
|
||||
void printIntegerJustified( int outVal, int blockSize, const char *justify )
|
||||
{
|
||||
// initialize variables, create temporary output string
|
||||
char outStr[ MIN_STR_LEN ];
|
||||
|
||||
// convert integer to string
|
||||
// function: sprintf
|
||||
sprintf( outStr, "%d", outVal );
|
||||
|
||||
// print justified string
|
||||
// function: printStringJustified
|
||||
printStringJustified( outStr, blockSize, justify );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printLongInteger
|
||||
Process: prints long integer
|
||||
Function input/Parameters: outVal - the long integer value to be output
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device Input/keyboard: None
|
||||
Device Output/Monitor: integer is displayed as specified
|
||||
Dependencies: printLongIntJustified
|
||||
*/
|
||||
void printLongInteger( long outVal )
|
||||
{
|
||||
// initialize variables, set block size to zero, justification to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// print justified long integer with specified parameters
|
||||
// function: printLongIntegerJustified
|
||||
printLongIntegerJustified( outVal, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printLongIntegerJustified
|
||||
Process: prints long integer with the specified justification
|
||||
within the specified blockSize
|
||||
Function input/Parameters:
|
||||
outVal - the long integer value to be output
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device Input/keyboard: None
|
||||
Device Output/Monitor: integer is displayed as specified
|
||||
Dependencies: sprintf, printStringJustified
|
||||
*/
|
||||
void printLongIntegerJustified( long outVal,
|
||||
int blockSize, const char *justify )
|
||||
{
|
||||
// initialize variables, create temporary output string
|
||||
char outStr[ MIN_STR_LEN ];
|
||||
|
||||
// convert long integer to string
|
||||
// function: sprintf
|
||||
sprintf( outStr, "%ld", outVal );
|
||||
|
||||
// print justified string
|
||||
// function: printStringJustified
|
||||
printStringJustified( outStr, blockSize, justify );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printString
|
||||
Process: prints string
|
||||
Function input/parameters: outVal - the string value to be output
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Function input/keyboard: None
|
||||
Device output/monitor: string is displayed as specified
|
||||
Dependencies: printStringJustified
|
||||
*/
|
||||
void printString( const char *outStr )
|
||||
{
|
||||
// initialize variables, set block size to zero, justification to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// print justified string with specified parameters
|
||||
// function: printStringJustified
|
||||
printStringJustified( outStr, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: printStringJustified
|
||||
Process: prints string within specified block size
|
||||
and with specified justification
|
||||
Function input/parameters:
|
||||
outVal - the string value to be output
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Function input/keyboard: None
|
||||
Device output/monitor: string is displayed as specified
|
||||
Dependencies: strlen, strcmp, printCharacters, printf
|
||||
*/
|
||||
void printStringJustified ( const char *outStr,
|
||||
int blockSize, const char *justify )
|
||||
{
|
||||
// initialize variables, set pre-, post- spaces to zero
|
||||
int preSpaces = 0, postSpaces = 0, strLength;
|
||||
|
||||
// find length of string
|
||||
// function: strlen
|
||||
strLength = strlen( outStr );
|
||||
|
||||
// check justification for "LEFT"
|
||||
// function: strcmp
|
||||
if( strcmp( justify, "LEFT" ) == 0 )
|
||||
{
|
||||
// set post spaces for left justification
|
||||
postSpaces = blockSize - strLength;
|
||||
}
|
||||
|
||||
// otherwise, check justification for "RIGHT"
|
||||
// function: strcmp
|
||||
else if( strcmp( justify, "RIGHT" ) == 0 )
|
||||
{
|
||||
// set pre spaces for right justification
|
||||
preSpaces = blockSize - strLength;
|
||||
}
|
||||
|
||||
// Otherwise, assume "CENTER" justification
|
||||
else
|
||||
{
|
||||
// set pre spaces for centered
|
||||
preSpaces = blockSize / 2 - strLength / 2;
|
||||
|
||||
// set post spaces for centered
|
||||
postSpaces = blockSize - strLength - preSpaces;
|
||||
}
|
||||
|
||||
// print pre spaces
|
||||
// function: printChars
|
||||
printCharacters( preSpaces, SPACE );
|
||||
|
||||
// print string
|
||||
// function: printf
|
||||
printf( "%s", outStr );
|
||||
|
||||
// print post spaces
|
||||
// function: printChars
|
||||
printCharacters( postSpaces, SPACE );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: promptForCharacter
|
||||
Process: prompts user for character, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: one character (chars
|
||||
Device input/keyboard: user entry of a character
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, getChar
|
||||
*/
|
||||
char promptForCharacter( const char *promptString )
|
||||
{
|
||||
// initialize variables
|
||||
char outChar;
|
||||
|
||||
// print prompt string
|
||||
// function: printf
|
||||
printf( "%s", promptString );
|
||||
|
||||
// get character from stream
|
||||
// function: getChar
|
||||
outChar = (char)getChar();
|
||||
|
||||
// return captured character
|
||||
return outChar;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: promptForDouble
|
||||
Process: prompts user for double, then returns it
|
||||
Function input/parameters: test to prompt user (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: value (double)
|
||||
Device input/keyboard: user entry of an integer value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, scanf
|
||||
*/
|
||||
double promptForDouble( const char *promptString )
|
||||
{
|
||||
// initialize variables
|
||||
double outDouble;
|
||||
|
||||
// print prompt string
|
||||
// function: printf
|
||||
printf( "%s", promptString );
|
||||
|
||||
// get double value
|
||||
// function: scanf
|
||||
scanf( "%lf", &outDouble );
|
||||
|
||||
// return captured double
|
||||
return outDouble;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: promptForInteger
|
||||
Process: prompts user for integer, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: integer value (int)
|
||||
Device input/keyboard: user entry of a double value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, scanf
|
||||
*/
|
||||
int promptForInteger( const char *promptString )
|
||||
{
|
||||
// initialize variables
|
||||
int outInt;
|
||||
|
||||
// print prompt string
|
||||
// function: printf
|
||||
printf( "%s", promptString );
|
||||
|
||||
// input integer
|
||||
// function: scanf
|
||||
scanf( "%d", &outInt );
|
||||
|
||||
// return captured integer
|
||||
return outInt;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: promptForString
|
||||
Process: prompts user for string, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: input string from user(c-string)
|
||||
Function output/returned: none
|
||||
Device input/keyboard: user entry of a string value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, getInputString
|
||||
*/
|
||||
void promptForString( const char *promptString, char returnStr[] )
|
||||
{
|
||||
// initialize variables, don't allow white space capture
|
||||
bool dontClearWhitespace = false;
|
||||
|
||||
// pring prompt string
|
||||
// function: printf
|
||||
printf( "%s", promptString );
|
||||
|
||||
// get input string from user (returned via parameter)
|
||||
// function: getInputString
|
||||
getInputString( returnStr, dontClearWhitespace );
|
||||
}
|
||||
|
||||
|
||||
289
PA05-1004/Console_IO_Utility.h
Normal file
289
PA05-1004/Console_IO_Utility.h
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
// Preprocessor directive
|
||||
#ifndef CONSOLE_IO_UTILITY_H
|
||||
#define CONSOLE_IO_UTILITY_H
|
||||
|
||||
//Header Files
|
||||
#include <stdbool.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "StandardConstants.h"
|
||||
|
||||
//Global Constants
|
||||
|
||||
// none
|
||||
|
||||
//Function Prototypes
|
||||
|
||||
/*
|
||||
Name: clearLeadingCharacters
|
||||
Process: Clears all leading non-printable characters from the console stream
|
||||
Function input/parameters: allow space return (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first printable character as integer
|
||||
Device input/keyboard: none
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar
|
||||
*/
|
||||
int clearLeadingCharacters( bool allowSpaceReturn );
|
||||
|
||||
/*
|
||||
Name: getChar
|
||||
Process: returns next character in stream,
|
||||
ignores all white space (including SPACE) prior to character
|
||||
Function input/parameters: flag to accept space (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: one character (char) is returned to calling method
|
||||
Device input/keyboard: places one or more characters in stream
|
||||
Device output/monitor: none
|
||||
Dependencies:
|
||||
*/
|
||||
char getChar();
|
||||
|
||||
/*
|
||||
Name: getCharFiltered
|
||||
Process: returns next character in stream,
|
||||
ignores non printable characters prior to input character
|
||||
but may accept space depending on flag
|
||||
Function input/parameters: flag to accept space (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first printable character or space (if configured)
|
||||
returned (char)
|
||||
Device input/keyboard: places one or more characters in stream
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar(), clearLeadingCharacters
|
||||
*/
|
||||
char getCharFiltered( bool acceptSpace );
|
||||
|
||||
/*
|
||||
Name: getInputString
|
||||
Process: acquires input string from keyboard, if clear white space flag set,
|
||||
ignores all white space, including space character
|
||||
Function input/parameters: clear white space control (bool)
|
||||
Function output/parameters: character array (char[])
|
||||
Function output/returned: none
|
||||
Device input/keyboard: user entry of a character stream
|
||||
Device output/monitor: none
|
||||
Dependencies: getchar(), clearLeadingCharacters
|
||||
*/
|
||||
void getInputString(char inputArr[], bool clearWhiteSpace );
|
||||
|
||||
/*
|
||||
Name: printCharacter
|
||||
Process: prints a single character
|
||||
Function input/parameters: character to be printed (char)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device input/keyboard: None
|
||||
Device output/monitor: character printed as specified
|
||||
Dependencies: printCharacters
|
||||
*/
|
||||
void printCharacter( char outputChar );
|
||||
|
||||
/*
|
||||
Name: printCharacters
|
||||
Process: prints given number of characters
|
||||
Function input/parameters: number of characters (int),
|
||||
character to be printed (char)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device input/keyboard: None
|
||||
Device output/monitor: Number of specified characters printed
|
||||
Dependencies: printf
|
||||
*/
|
||||
void printCharacters( int numChars, char outputChar );
|
||||
|
||||
/*
|
||||
Name: printDouble
|
||||
Process: simple print double function
|
||||
Function input/parameters:
|
||||
outVal - the double value to be output (double)
|
||||
precision - the number of digits to the right of the decimal point (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one double value displayed
|
||||
Dependencies: printDoubleJustified
|
||||
*/
|
||||
void printDouble( double outVal, int precision );
|
||||
|
||||
/*
|
||||
Name: printDoubleJustified
|
||||
Process: the precision is set for the double value, then the pre-spaces
|
||||
and post-spaces are calculated for the requested justification,
|
||||
and then the pre-spaces are printed, the double value is printed,
|
||||
and then the post-spaces are printed
|
||||
Function input/parameters:
|
||||
outVal - the double value to be output (double)
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one double value displayed, justified, with precision
|
||||
Dependencies: formatDouble, printStringJustified
|
||||
*/
|
||||
void printDoubleJustified( double outVal, int precision,
|
||||
int blockSize, const char* justify );
|
||||
|
||||
/*
|
||||
Name: printEndline
|
||||
Process: prints single endline character to end a line or create vertical space
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: one endline character output
|
||||
Dependencies: printEndline
|
||||
*/
|
||||
void printEndline();
|
||||
|
||||
/*
|
||||
Name: printEndlines
|
||||
Process: prints the specified number of endline characters
|
||||
to end a line and/or create vertical space(s)
|
||||
Function input/parameters: number of endlines (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input: none
|
||||
Device output/monitor: endline characters output as specified
|
||||
Dependencies: printEndline
|
||||
*/
|
||||
void printEndlines( int numEndlines );
|
||||
|
||||
/*
|
||||
Name: printInteger
|
||||
Process: prints integer value
|
||||
Function input/parameters: outVal - the integer value to be output
|
||||
Function output/parameters: None
|
||||
Device Input: None
|
||||
Device Output: Integer is displayed as specified
|
||||
Dependencies: printIntegerJustified
|
||||
*/
|
||||
void printInteger( int outVal );
|
||||
|
||||
/*
|
||||
Name: printIntegerJustified
|
||||
Process: prints integer value with the specified justification
|
||||
within the specified blockSize
|
||||
Function input/parameters:
|
||||
outVal - the integer value to be output (int)
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: none
|
||||
Device Input: None
|
||||
Device Output: Integer is displayed as specified
|
||||
Dependencies: sprintf, printStringJustified
|
||||
*/
|
||||
void printIntegerJustified( int outVal, int blockSize, const char *justify );
|
||||
|
||||
/*
|
||||
Name: printLongInteger
|
||||
Process: prints long integer
|
||||
Function input/Parameters: outVal - the long integer value to be output
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device Input/keyboard: None
|
||||
Device Output/Monitor: integer is displayed as specified
|
||||
Dependencies: printLongIntJustified
|
||||
*/
|
||||
void printLongInteger( long outVal );
|
||||
|
||||
/*
|
||||
Name: printLongIntegerJustified
|
||||
Process: prints long integer with the specified justification
|
||||
within the specified blockSize
|
||||
Function Input/Parameters:
|
||||
outVal - the long integer value to be output (long int)
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Device Input/keyboard: None
|
||||
Device Output/Monitor: integer is displayed as specified
|
||||
Dependencies: sprintf, printStringJustified
|
||||
*/
|
||||
void printLongIntegerJustified( long outVal,
|
||||
int blockSize, const char *justify );
|
||||
|
||||
/*
|
||||
Name: printString
|
||||
Process: prints string
|
||||
Function input/parameters: outVal - the string value to be output
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Function input/keyboard: None
|
||||
Device output/monitor: string is displayed as specified
|
||||
Dependencies: printStringJustified
|
||||
*/
|
||||
void printString( const char *outStr );
|
||||
|
||||
/*
|
||||
Name: printStringJustified
|
||||
Process: prints string within specified block size
|
||||
and with specified justification
|
||||
Function input/parameters:
|
||||
outStr - the string value to be output (c-string)
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: None
|
||||
Function input/keyboard: None
|
||||
Device output/monitor: string is displayed as specified
|
||||
Dependencies: strlen, strcmp, printCharacters, printf
|
||||
*/
|
||||
void printStringJustified( const char *outStr,
|
||||
int blockSize, const char *justify );
|
||||
|
||||
/*
|
||||
Name: promptForCharacter
|
||||
Process: prompts user for character, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: one character (chars
|
||||
Device input/keyboard: user entry of a character
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, getChar
|
||||
*/
|
||||
char promptForCharacter( const char *promptString );
|
||||
|
||||
/*
|
||||
Name: promptForDouble
|
||||
Process: prompts user for double, then returns it
|
||||
Function input/parameters: test to prompt user (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: value (double)
|
||||
Device input/keyboard: user entry of an integer value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, scanf
|
||||
*/
|
||||
double promptForDouble( const char *promptString );
|
||||
|
||||
/*
|
||||
Name: promptForInteger
|
||||
Process: prompts user for integer, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: integer value (int)
|
||||
Device input/keyboard: user entry of a double value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, scanf
|
||||
*/
|
||||
int promptForInteger( const char *promptString );
|
||||
|
||||
/*
|
||||
Name: promptForString
|
||||
Process: prompts user for string, then returns it
|
||||
Function input/parameters: text to prompt user (c-string)
|
||||
Function output/parameters: input string captured (c-string)
|
||||
Function output/returned: none
|
||||
Device input/keyboard: user entry of a string value
|
||||
Device output/monitor: prompt string displayed
|
||||
Dependencies: printf, getInputString
|
||||
*/
|
||||
void promptForString( const char *promptString, char returnStr[] );
|
||||
|
||||
#endif // end CONSOLE_IO_UTILITY_H
|
||||
717
PA05-1004/File_Input_Utility.c
Normal file
717
PA05-1004/File_Input_Utility.c
Normal file
|
|
@ -0,0 +1,717 @@
|
|||
/*
|
||||
Formatted file input utility, function implementations
|
||||
|
||||
Copyright (c) 2021 by Michael E. Leverington
|
||||
|
||||
Code is free for use in whole or in part and may be modified for other
|
||||
non-commercial use as long as the above copyright statement is included.
|
||||
*/
|
||||
|
||||
// header files
|
||||
#include "File_Input_Utility.h"
|
||||
#include <stdlib.h> //////////////////////////test
|
||||
|
||||
// local global constants, used only in this file
|
||||
|
||||
// dummy file pointer for accessInputFilePointer
|
||||
const FILE *DUMMY_INPUT_FILE_PTR = NULL;
|
||||
|
||||
// dummy Boolean for accessEndOfInputFileFlag, accessOpenFlag
|
||||
const char DUMMY_INPUT_FLAG = false;
|
||||
|
||||
// control code for accessing file pointer, accessInputFilePointer
|
||||
const int GET_INPUT_FILE_PTR = 3003;
|
||||
|
||||
// control code for accessing flag value,
|
||||
// accessEndOfInputFileFlag, accessOpenFlag
|
||||
const int GET_INPUT_FLAG = 2002;
|
||||
|
||||
// control code for setting file pointer, accessInputFilePointer
|
||||
const int SET_INPUT_FILE_PTR = 4004;
|
||||
|
||||
// control code for setting flag value, accessEndOfInputFileFlag,
|
||||
// accessOpenFlag
|
||||
const int SET_INPUT_FLAG = 1001;
|
||||
|
||||
|
||||
/*
|
||||
Name: accessEndOfInputFileFlag
|
||||
process: allows accessing or modifying end of file flag state;
|
||||
note: flag is maintained (static) value initialized to false
|
||||
Function input/parameters: control code (int), flag state (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of flag state (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
bool accessEndOfInputFileFlag( int ctrlCode, bool setFlag )
|
||||
{
|
||||
// initialize end of file flag to false
|
||||
static bool endOfFileFlag = false;
|
||||
|
||||
// test for set flag
|
||||
if( ctrlCode == SET_INPUT_FLAG )
|
||||
{
|
||||
// set flag to given state
|
||||
endOfFileFlag = setFlag;
|
||||
}
|
||||
|
||||
// return flag state
|
||||
return endOfFileFlag;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: accessInputFilePointer
|
||||
process: allows setting or accessing file pointer;
|
||||
note: pointer is maintained (static) value initialized to NULL
|
||||
Function input/parameters: control code (int), file pointer (FILE *)
|
||||
DUMMY_INPUT_FILE_PTR used
|
||||
if not setting file pointer
|
||||
Function output/parameters: none
|
||||
Function output/returned: file pointer (FILE *)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
FILE *accessInputFilePointer( int ctrlCode, const FILE *filePtr )
|
||||
{
|
||||
// initialize file pointer to null
|
||||
static FILE *filePointer = NULL;
|
||||
|
||||
// check for set new pointer
|
||||
if( ctrlCode == SET_INPUT_FILE_PTR )
|
||||
{
|
||||
// set file pointer to parameter
|
||||
filePointer = (FILE *)filePtr;
|
||||
}
|
||||
|
||||
// return file pointer
|
||||
return filePointer;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: checkForEndOfInputFile
|
||||
process: checks to see if end of file flag has been encountered,
|
||||
returns true if EOF has been encountered, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of specified test (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: accessEndOfInputFileFlag
|
||||
*/
|
||||
bool checkForEndOfInputFile()
|
||||
{
|
||||
// return access to end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
return accessEndOfInputFileFlag( GET_INPUT_FLAG, DUMMY_INPUT_FLAG );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: checkForInputFileOpen
|
||||
process: checks to see if file is currently open
|
||||
returns true if file pointer not null, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of specified test (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: accessInputFilePointer
|
||||
*/
|
||||
bool checkForInputFileOpen()
|
||||
{
|
||||
// return access to end of file flag
|
||||
// function: accessInputFilePointer
|
||||
return accessInputFilePointer( GET_INPUT_FLAG,
|
||||
DUMMY_INPUT_FILE_PTR ) != NULL;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: clearLeadingWhiteSpace
|
||||
process: captures non printable characters,
|
||||
and space if flag set,
|
||||
returns first non white space value found as integer
|
||||
Function input/parameters: file pointer (FILE *), clear space flag (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first non WS character as integer
|
||||
Device input/file: value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: fgetc
|
||||
*/
|
||||
int clearLeadingWhiteSpace( FILE *filePtr, bool clearSpace )
|
||||
{
|
||||
// initialize character input value
|
||||
// function: fgetc
|
||||
int charInt = fgetc( filePtr );
|
||||
|
||||
while(
|
||||
// continue if not at end of file
|
||||
( charInt != EOF )
|
||||
|
||||
// AND
|
||||
// continue if character is non printable
|
||||
&& ( ( charInt < (int)SPACE || charInt > (int)HIGHEST_PRINTABLE_CHAR )
|
||||
|
||||
// OR
|
||||
// continue if clear space flag set and space is found
|
||||
|| ( clearSpace && charInt == SPACE ) )
|
||||
)
|
||||
{
|
||||
// capture next character
|
||||
// function: fgetc
|
||||
charInt = fgetc( filePtr );
|
||||
}
|
||||
|
||||
// return input value as character
|
||||
return (char)charInt;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: closeInputFile
|
||||
process: closes input file, returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input/file: file closed
|
||||
Device output/monitor: none
|
||||
Dependencies: accessInputFilePointer, fclose, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool closeInputFile()
|
||||
{
|
||||
// set local file pointer to working file pointer
|
||||
// function: accessInputFilePointer
|
||||
FILE *filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// check for valid file pointer
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// close file
|
||||
fclose( filePtr );
|
||||
|
||||
// set pointer to NULL
|
||||
// function: accessInputFilePointer
|
||||
accessInputFilePointer( SET_INPUT_FILE_PTR, NULL );
|
||||
|
||||
// set end of file flag to false
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, false );
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
|
||||
// return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: openInputFile
|
||||
process: opens input file, sets file pointer and unsets end of file flag,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: file name (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: file opened
|
||||
Device output/monitor: none
|
||||
Dependencies: fopen, accessInputFilePointer, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool openInputFile( const char *fileName )
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = NULL;
|
||||
char readOnlyCharacter[] = "r";
|
||||
|
||||
// check for file not open
|
||||
// function: checkForInputFileOpen
|
||||
if( !checkForInputFileOpen() )
|
||||
{
|
||||
// open file
|
||||
// function: fopen
|
||||
filePtr = fopen( fileName, readOnlyCharacter );
|
||||
|
||||
// check for success of file open
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// set pointer in access function
|
||||
// function: accessInputFilePointer
|
||||
accessInputFilePointer( SET_INPUT_FILE_PTR, filePtr );
|
||||
|
||||
// reset end of file flag, if needed
|
||||
// accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, false );
|
||||
|
||||
// return operation success
|
||||
return true;
|
||||
}
|
||||
}
|
||||
// end of file not previously opened block
|
||||
|
||||
// return operation failure
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readCharacterFromFile
|
||||
process: ignores leading unprintable characters, including space,
|
||||
captures first printable character
|
||||
Function input/parameters: allow space capture (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readCharacterFromFileConfigured
|
||||
*/
|
||||
char readCharacterFromFile()
|
||||
{
|
||||
// initialize parameter to not allow space
|
||||
bool noSpaceCapture = false;
|
||||
|
||||
// capture character, return
|
||||
// function: getCharFromFileConfigured
|
||||
return readCharacterFromFileConfigured( noSpaceCapture );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readCharacterFromFileConfigured
|
||||
process: ignores leading unprintable characters,
|
||||
captures first printable character,
|
||||
including space if allowed
|
||||
Function input/parameters: allow space capture (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, clearLeadingWhiteSpace,
|
||||
accessEndOfInputFileFlag
|
||||
*/
|
||||
char readCharacterFromFileConfigured( bool captureSpace )
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr;
|
||||
int intChar = ZERO_CHAR;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// set file pointer
|
||||
// function: accessInputFilePointer
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// get character
|
||||
// function: clearLeadingWhiteSpace
|
||||
intChar = clearLeadingWhiteSpace( filePtr, !captureSpace );
|
||||
|
||||
// check for end of file found
|
||||
if( intChar == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// set return value to zero
|
||||
intChar = ZERO_CHAR;
|
||||
}
|
||||
}
|
||||
|
||||
// return value as character
|
||||
return intChar;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readDoubleFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous double value
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: double value found if successful (double)
|
||||
Device input/file: double value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
double readDoubleFromFile()
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = NULL;
|
||||
int fscanfReturn = EOF;
|
||||
double doubleVal = ZERO_VALUE;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// set file pointer
|
||||
// function: accessInputFilePointer
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// get double value
|
||||
// function: fscanf
|
||||
fscanfReturn = fscanf( filePtr, "%lf", &doubleVal );
|
||||
|
||||
// check for end of file found
|
||||
if( fscanfReturn == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// set return value to zero
|
||||
doubleVal = ZERO_VALUE;
|
||||
}
|
||||
}
|
||||
|
||||
// return acquired value
|
||||
return doubleVal;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readIntegerFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous integer
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: integer found if successful, ZERO_VALUE otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
int readIntegerFromFile()
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = NULL;
|
||||
int fscanfReturn = EOF;
|
||||
int intVal = ZERO_VALUE;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// set file pointer
|
||||
// function: accessInputFilePointer
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// get integer value
|
||||
// function: fscanf
|
||||
fscanfReturn = fscanf( filePtr, "%d", &intVal );
|
||||
|
||||
// check for end of file found
|
||||
if( fscanfReturn == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// set return value to zero
|
||||
intVal = ZERO_VALUE;
|
||||
}
|
||||
}
|
||||
|
||||
// return acquired value
|
||||
return intVal;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readLongFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous long int
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: long integer found if successful,
|
||||
ZERO_VALUE otherwise
|
||||
Device input/file: long value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
long readLongFromFile()
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = NULL;
|
||||
int fscanfReturn = EOF;
|
||||
long longVal = ZERO_VALUE;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// set file pointer
|
||||
// function: accessInputFilePointer
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// get long value
|
||||
// function: fscanf
|
||||
fscanfReturn = fscanf( filePtr, "%ld", &longVal );
|
||||
|
||||
// check for end of file found
|
||||
if( fscanfReturn == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// set return value to zero
|
||||
longVal = ZERO_VALUE;
|
||||
}
|
||||
}
|
||||
|
||||
// return acquired value
|
||||
return longVal;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readRawCharFromFile
|
||||
process: captures first character in file stream including non-printable
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fgetc, accessEndOfInputFileFlag
|
||||
*/
|
||||
char readRawCharFromFile()
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = NULL;
|
||||
int intChar = (int)ZERO_CHAR;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// set file pointer
|
||||
// function: accessInputFilePointer
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// get character
|
||||
// function: fgetc
|
||||
intChar = fgetc( filePtr );
|
||||
|
||||
// check for end of file found
|
||||
if( intChar == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// set return value to zero
|
||||
intChar = (int)ZERO_CHAR;
|
||||
}
|
||||
}
|
||||
|
||||
// return acquired value
|
||||
return (char)intChar;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readStringConfiguredFromFile
|
||||
Process: captures string with options:
|
||||
- clear leading non printable (bool)
|
||||
- clear leading space character (bool)
|
||||
- adquires characters up to any non-printable (bool)
|
||||
- adquires characters up to any printable delimiter (char)
|
||||
- use constant NON_PRINTABLE if no delimiter
|
||||
- also stops capture when full (MAX_STR_LEN)
|
||||
Note: This function consumes the last character input,
|
||||
including the space, delimiter, or non-printable character
|
||||
Function input/parameters: see process above
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
clearLeadingWhiteSpace, fgetc, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool readStringConfiguredFromFile( bool clearLeadingNonPrintable,
|
||||
bool clearLeadingSpace,
|
||||
bool stopAtNonPrintable,
|
||||
char delimiter,
|
||||
char *capturedString )
|
||||
{
|
||||
// initialize variables
|
||||
int intChar = EOF, index = 0;
|
||||
FILE *filePtr = NULL;
|
||||
|
||||
// initialize output string
|
||||
capturedString[ index ] = NULL_CHAR;
|
||||
|
||||
// check for file open and data accessible
|
||||
// function: checkForInputFileOpen, checkForEndOfInputFile
|
||||
if( checkForInputFileOpen() && !checkForEndOfInputFile() )
|
||||
{
|
||||
// get file pointer
|
||||
// function: accessFilePtr
|
||||
filePtr = accessInputFilePointer( GET_INPUT_FILE_PTR,
|
||||
DUMMY_INPUT_FILE_PTR );
|
||||
|
||||
// check for clearing non printable
|
||||
if( clearLeadingNonPrintable )
|
||||
{
|
||||
// clear leading white space, with clear space character flag
|
||||
// function: clearLeadingWhiteSpace
|
||||
intChar = clearLeadingWhiteSpace( filePtr, clearLeadingSpace );
|
||||
}
|
||||
|
||||
// otherwise, assume non printable not cleared
|
||||
else
|
||||
{
|
||||
// get first character
|
||||
// function: fgetc
|
||||
intChar = fgetc( filePtr );
|
||||
|
||||
// check for clearing spaces
|
||||
if( clearLeadingSpace )
|
||||
{
|
||||
// loop while spaces found and end of file not found
|
||||
while( intChar != EOF && intChar == (int)SPACE )
|
||||
{
|
||||
// capture new character
|
||||
// function: fgetc
|
||||
intChar = fgetc( filePtr );
|
||||
}
|
||||
}
|
||||
} // end leading character clearing process
|
||||
|
||||
// check for end of file found
|
||||
if( intChar == EOF )
|
||||
{
|
||||
// set end of file flag
|
||||
// function: accessEndOfInputFileFlag
|
||||
accessEndOfInputFileFlag( SET_INPUT_FLAG, true );
|
||||
|
||||
// return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
// loop to capture input
|
||||
while(
|
||||
// continues if not at end of file and max string length not reached
|
||||
( intChar != EOF && index < MAX_STR_LEN - 1 )
|
||||
|
||||
// AND
|
||||
// continues if not printable flag set and characters are printable
|
||||
// OR not printable flag not set
|
||||
&& ( ( stopAtNonPrintable && intChar >= (int)SPACE )
|
||||
|| ( !stopAtNonPrintable ) )
|
||||
|
||||
// AND
|
||||
// continues if specified delimiter is not found
|
||||
&& ( intChar != (char)delimiter )
|
||||
)
|
||||
{
|
||||
// place character in array element
|
||||
capturedString[ index ] = (char)intChar;
|
||||
|
||||
// increment array index
|
||||
index++;
|
||||
|
||||
// set next element to null character / end of c-string
|
||||
capturedString[ index ] = NULL_CHAR;
|
||||
|
||||
// get next character as integer
|
||||
// function: fgetc
|
||||
intChar = fgetc( filePtr );
|
||||
}
|
||||
// end loop
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
// end of open file and accessible data block
|
||||
|
||||
return false; // temporary stub return
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readStringSegmentFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to first space,
|
||||
or end of line, or full string
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringSegmentFromFile( char *capturedString )
|
||||
{
|
||||
// initialize variables
|
||||
bool clearLeadingNonPrintable = true;
|
||||
bool clearLeadingSpace = true;
|
||||
bool stopAtNonPrintable = true;
|
||||
char delimiter = SPACE;
|
||||
|
||||
// call utility function, return
|
||||
return readStringConfiguredFromFile( clearLeadingNonPrintable,
|
||||
clearLeadingSpace,
|
||||
stopAtNonPrintable,
|
||||
delimiter,
|
||||
capturedString );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readStringToLineEndFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to end of current line
|
||||
or full string
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: string found if successful
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringToLineEndFromFile( char *capturedString )
|
||||
{
|
||||
// initialize variables
|
||||
bool clearLeadingNonPrintable = true;
|
||||
bool clearLeadingSpace = true;
|
||||
bool stopAtNonPrintable = true;
|
||||
char delimiter = NON_PRINTABLE;
|
||||
|
||||
// call utility function, return
|
||||
return readStringConfiguredFromFile( clearLeadingNonPrintable,
|
||||
clearLeadingSpace,
|
||||
stopAtNonPrintable,
|
||||
delimiter,
|
||||
capturedString );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: readStringToDelimiterFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to specified character
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: string found if successful
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringToDelimiterFromFile( char delimiter, char *capturedString )
|
||||
{
|
||||
// initialize variables
|
||||
bool clearLeadingNonPrintable = true;
|
||||
bool clearLeadingSpace = true;
|
||||
bool stopAtNonPrintable = true;
|
||||
|
||||
// call utility function, return
|
||||
return readStringConfiguredFromFile( clearLeadingNonPrintable,
|
||||
clearLeadingSpace,
|
||||
stopAtNonPrintable,
|
||||
delimiter,
|
||||
capturedString );
|
||||
}
|
||||
|
||||
|
||||
295
PA05-1004/File_Input_Utility.h
Normal file
295
PA05-1004/File_Input_Utility.h
Normal file
|
|
@ -0,0 +1,295 @@
|
|||
/*
|
||||
Formatted file input utility, function prototypes
|
||||
|
||||
Copyright (c) 2021 by Michael E. Leverington
|
||||
|
||||
Code is free for use in whole or in part and may be modified for other
|
||||
non-commercial use as long as the above copyright statement is included.
|
||||
*/
|
||||
/*
|
||||
Rev 0.0: 30 June 2021, Initial creation of file
|
||||
|
||||
UTILITY USAGE INSTRUCTIONS:
|
||||
|
||||
1) This utility contains functions that may be used for file input operations
|
||||
using the C programming language with text files.
|
||||
The utility must be linked with the program code with which
|
||||
it will be used.
|
||||
|
||||
2) Specifications for all the functions
|
||||
are provided in a standardized format below.
|
||||
|
||||
3) Use this code at your own risk. There is no guarantee of any performance,
|
||||
implied or otherwise, for any part of this code
|
||||
|
||||
END OF INSTRUCTIONS
|
||||
*/
|
||||
|
||||
// PreProcessor test
|
||||
#ifndef FILE_INPUT_UTILITY_H
|
||||
#define FILE_INPUT_UTILITY_H
|
||||
|
||||
// header files
|
||||
#include <stdbool.h>
|
||||
#include <stdio.h>
|
||||
#include "StandardConstants.h"
|
||||
|
||||
// constants shared with other files
|
||||
|
||||
// non printable flag, used in getStringConfigured
|
||||
static const char NON_PRINTABLE = (char)(127);
|
||||
|
||||
// constant used for zero character return
|
||||
static const char ZERO_CHAR = '0';
|
||||
|
||||
// constant used for zero int/double value return
|
||||
static const char ZERO_VALUE = 0;
|
||||
|
||||
// function prototypes
|
||||
|
||||
/*
|
||||
Name: accessEndOfInputFileFlag
|
||||
process: allows accessing or modifying end of file flag state;
|
||||
note: flag is maintained (static) value initialized to false
|
||||
Function input/parameters: control code (int), flag state (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of flag state (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
bool accessEndOfInputFileFlag( int ctrlCode, bool setFlag );
|
||||
|
||||
/*
|
||||
Name: accessInputFilePointer
|
||||
process: allows setting or accessing file pointer;
|
||||
note: pointer is maintained (static) value initialized to NULL
|
||||
Function input/parameters: control code (int), file pointer (FILE *)
|
||||
DUMMY_INPUT_FILE_PTR used
|
||||
if not setting file pointer
|
||||
Function output/parameters: none
|
||||
Function output/returned: file pointer (FILE *)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
FILE *accessInputFilePointer( int ctrlCode, const FILE *filePtr );
|
||||
|
||||
/*
|
||||
Name: checkForEndOfInputFile
|
||||
process: checks to see if end of file flag has been encountered,
|
||||
returns true if EOF has been encountered, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of specified test (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: accessEndOfInputFileFlag
|
||||
*/
|
||||
bool checkForEndOfInputFile();
|
||||
|
||||
/*
|
||||
Name: checkForInputFileOpen
|
||||
process: checks to see if file is currently open
|
||||
returns true if file pointer not null, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: result of specified test (bool)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: accessInputFilePointer
|
||||
*/
|
||||
bool checkForInputFileOpen();
|
||||
|
||||
/*
|
||||
Name: clearLeadingWhiteSpace
|
||||
process: captures non printable characters,
|
||||
and space if flag set,
|
||||
returns first non white space value found as integer
|
||||
Function input/parameters: file pointer (FILE *), clear space flag (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: first non WS character as integer
|
||||
Device input/file: value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: fgetc
|
||||
*/
|
||||
int clearLeadingWhiteSpace( FILE *filePtr, bool clearSpace );
|
||||
|
||||
/*
|
||||
Name: closeInputFile
|
||||
process: closes input file, returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: none
|
||||
Device input/file: file closed
|
||||
Device output/monitor: none
|
||||
Dependencies: accessInputFilePointer, fclose, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool closeInputFile();
|
||||
|
||||
/*
|
||||
Name: openInputFile
|
||||
process: opens input file, sets file pointer and unsets end of file flag,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: file name (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: file opened
|
||||
Device output/monitor: none
|
||||
Dependencies: fopen, accessInputFilePointer, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool openInputFile( const char *fileName );
|
||||
|
||||
/*
|
||||
Name: readCharacterFromFile
|
||||
process: ignores leading unprintable characters, including space,
|
||||
captures first printable character
|
||||
Function input/parameters: allow space capture (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readCharacterFromFileConfigured
|
||||
*/
|
||||
char readCharacterFromFile();
|
||||
|
||||
/*
|
||||
Name: readCharacterFromFileConfigured
|
||||
process: ignores leading unprintable characters,
|
||||
captures first printable character,
|
||||
including space if allowed
|
||||
Function input/parameters: allow space capture (bool)
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, clearLeadingWhiteSpace,
|
||||
accessEndOfInputFileFlag
|
||||
*/
|
||||
char readCharacterFromFileConfigured( bool captureSpace );
|
||||
|
||||
/*
|
||||
Name: readDoubleFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous double value
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: double value found if successful (double)
|
||||
Device input/file: double value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
double readDoubleFromFile();
|
||||
|
||||
/*
|
||||
Name: readIntegerFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous integer
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: integer found if successful, ZERO_VALUE otherwise
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
int readIntegerFromFile();
|
||||
|
||||
/*
|
||||
Name: readLongFromFile
|
||||
process: ignores leading unprintable characters,
|
||||
captures first contiguous long int
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: long integer found if successful,
|
||||
ZERO_VALUE otherwise
|
||||
Device input/file: long value captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fscanf, accessEndOfInputFileFlag
|
||||
*/
|
||||
long readLongFromFile();
|
||||
|
||||
/*
|
||||
Name: readRawCharFromFile
|
||||
process: captures first character in file stream including non-printable
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: character found if successful, ZERO_CHAR otherwise
|
||||
Device input/file: character captured from file
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
accessInputFilePointer, fgetc, accessEndOfInputFileFlag
|
||||
*/
|
||||
char readRawCharFromFile();
|
||||
|
||||
/*
|
||||
Name: readStringConfiguredFromFile
|
||||
Process: captures string with options:
|
||||
- clear leading non printable (bool)
|
||||
- clear leading space character (bool)
|
||||
- adquires characters up to any non-printable (bool)
|
||||
- adquires characters up to any printable delimiter (char)
|
||||
- use constant NON_PRINTABLE if no delimiter
|
||||
- also stops capture when full (MAX_STR_LEN)
|
||||
Note: This function consumes the last character input,
|
||||
including the space, delimiter, or non-printable character
|
||||
Function input/parameters: see process above
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: checkForInputFileOpen, checkForEndOfInputFile,
|
||||
clearLeadingWhiteSpace, fgetc, accessEndOfInputFileFlag
|
||||
*/
|
||||
bool readStringConfiguredFromFile( bool clearLeadingNonPrintable,
|
||||
bool clearLeadingSpace,
|
||||
bool stopAtNonPrintable,
|
||||
char delimiter,
|
||||
char *capturedString );
|
||||
|
||||
/*
|
||||
Name: readStringSegmentFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to first space,
|
||||
or end of line, or full string
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: success of operation (bool)
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringSegmentFromFile( char *capturedString );
|
||||
|
||||
/*
|
||||
Name: readStringToLineEndFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to end of current line
|
||||
or full string
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: string found if successful
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringToLineEndFromFile( char *capturedString );
|
||||
|
||||
/*
|
||||
Name: readStringToDelimiterFromFile
|
||||
process: ignores leading white space, including space character,
|
||||
captures series of characters up to specified character
|
||||
Function input/parameters: none
|
||||
Function output/parameters: captured string (char *), EMPTY_STRING otherwise
|
||||
Function output/returned: string found if successful
|
||||
Device input/file: character(s) captured from file as needed
|
||||
Device output/monitor: none
|
||||
Dependencies: readStringConfigured with appropriate parameters
|
||||
*/
|
||||
bool readStringToDelimiterFromFile( char delimiter, char *capturedString );
|
||||
|
||||
#endif // FILE_INPUT_UTILITY_H
|
||||
|
||||
511
PA05-1004/File_Output_Utility.c
Normal file
511
PA05-1004/File_Output_Utility.c
Normal file
|
|
@ -0,0 +1,511 @@
|
|||
/*
|
||||
Formatted file ouput utility, function implementations
|
||||
|
||||
Copyright (c) 2021 by Michael E. Leverington
|
||||
|
||||
Code is free for use in whole or in part and may be modified for other
|
||||
non-commercial use as long as the above copyright statement is included.
|
||||
*/
|
||||
|
||||
// header files
|
||||
#include "File_Output_Utility.h"
|
||||
|
||||
// local global constants, used only in this file
|
||||
|
||||
// dummy file pointer for accessInputFilePointer
|
||||
const FILE *DUMMY_OUTPUT_FILE_PTR = NULL;
|
||||
|
||||
// dummy Boolean for accessEndOfInputFileFlag, accessOpenFlag
|
||||
// const char DUMMY_OUTPUT_FLAG = false;
|
||||
|
||||
// control code for accessing file pointer, accessInputFilePointer
|
||||
const int GET_OUTPUT_FILE_PTR = 6006;
|
||||
|
||||
// control code for accessing flag value,
|
||||
// accessEndOfInputFileFlag, accessOpenFlag
|
||||
const int GET_OUTPUT_FLAG = 9009;
|
||||
|
||||
// control code for setting file pointer, accessInputFilePointer
|
||||
const int SET_OUTPUT_FILE_PTR = 8008;
|
||||
|
||||
// control code for setting flag value, accessEndOfInputFileFlag,
|
||||
// accessOpenFlag
|
||||
// const int SET_OUTPUT_FLAG = 1001;
|
||||
|
||||
/*
|
||||
Name: accessOutputFilePointer
|
||||
process: allows setting or accessing file pointer;
|
||||
note: pointer is maintained (static) value initialized to NULL
|
||||
Function input/parameters: control code (int), file pointer (FILE *)
|
||||
DUMMY_OUTPUT_FILE_PTR used
|
||||
if not setting file pointer
|
||||
Function output/parameters: none
|
||||
Function output/returned: file pointer (FILE *)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
FILE *accessOutputFilePointer( int ctrlCode, const FILE *filePtr )
|
||||
{
|
||||
static FILE *filePointer = NULL;
|
||||
|
||||
// check for set new pointer
|
||||
if( ctrlCode == SET_OUTPUT_FILE_PTR )
|
||||
{
|
||||
// set file pointer to parameter
|
||||
filePointer = (FILE *)filePtr;
|
||||
}
|
||||
|
||||
// return file pointer
|
||||
return filePointer;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: closeOutputFile
|
||||
Process: closes output file, returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: output file closed
|
||||
Dependencies: accessOutputFilePointer, fclose
|
||||
*/
|
||||
bool closeOutputFile()
|
||||
{
|
||||
// set local file pointer to working file pointer
|
||||
// function: accessOutputFilePointer
|
||||
FILE *filePtr = accessOutputFilePointer( GET_OUTPUT_FILE_PTR,
|
||||
DUMMY_OUTPUT_FILE_PTR );
|
||||
|
||||
// check for valid file pointer
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// add two more endlines to verify that the data is ended
|
||||
// and has at least one extra newline after the data
|
||||
// function: fprintf
|
||||
fprintf( filePtr, "\n\n" );
|
||||
|
||||
// flush all data to the device
|
||||
// function: fflush
|
||||
fflush( filePtr );
|
||||
|
||||
// close file
|
||||
// function: fclose
|
||||
fclose( filePtr );
|
||||
|
||||
// set pointer to NULL
|
||||
// function: accessOutputFilePointer
|
||||
accessOutputFilePointer( SET_OUTPUT_FILE_PTR, NULL );
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
|
||||
// return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: openOutputFile
|
||||
Process: opens input file, returns true if successful, false otherwise
|
||||
Function input/parameters: file name (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: output file opened
|
||||
Dependencies: accessOutputFilePointer, fopen
|
||||
*/
|
||||
bool openOutputFile( const char *fileName )
|
||||
{
|
||||
// initialize variables
|
||||
FILE *filePtr = accessOutputFilePointer( GET_OUTPUT_FILE_PTR,
|
||||
DUMMY_OUTPUT_FILE_PTR );
|
||||
char writeCharacter[] = "w";
|
||||
|
||||
// check for file not open
|
||||
if( filePtr == NULL )
|
||||
{
|
||||
// open file
|
||||
// function: fopen
|
||||
filePtr = fopen( fileName, writeCharacter );
|
||||
|
||||
// check for success of file open
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// set pointer in access function
|
||||
// function: accessInputFilePointer
|
||||
accessOutputFilePointer( SET_OUTPUT_FILE_PTR, filePtr );
|
||||
|
||||
// return operation success
|
||||
return true;
|
||||
}
|
||||
}
|
||||
// end of file not previously opened block
|
||||
|
||||
// return operation failure
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeCharacterToFile
|
||||
Process: writes individual character to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: character to output (char)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: character written to file
|
||||
Dependencies: accessOutputFilePointer, fprintf
|
||||
*/
|
||||
bool writeCharacterToFile( char outChar )
|
||||
{
|
||||
// initialize variables, set file pointer
|
||||
// function: accessOutputFilePointer
|
||||
FILE *filePtr = accessOutputFilePointer( GET_OUTPUT_FILE_PTR,
|
||||
DUMMY_OUTPUT_FILE_PTR );
|
||||
|
||||
// check for open file
|
||||
// function: checkForOutputFileOpen
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// write character
|
||||
// function: fprintf
|
||||
fprintf( filePtr, "%c", outChar );
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
|
||||
// return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeCharactersToFile
|
||||
Process: writes multiple characters to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: number of characters to output (int),
|
||||
character to output (char)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: multiple characters written to file
|
||||
Dependencies: writeCharacterToFile
|
||||
*/
|
||||
bool writeCharactersToFile( int numChars, char outChar )
|
||||
{
|
||||
// check for number of characters remaining,
|
||||
if( numChars > 0 )
|
||||
{
|
||||
// write character, check for success
|
||||
// function: writeChar
|
||||
if( writeCharacterToFile( outChar ) )
|
||||
{
|
||||
// continue recursion,
|
||||
// check for downstream success
|
||||
// function: writeChars
|
||||
return writeCharactersToFile( numChars - 1, outChar );
|
||||
}
|
||||
|
||||
// quit recursion
|
||||
// return unsuccessful operation - write operation failed
|
||||
return false;
|
||||
}
|
||||
|
||||
// return successful operation - all characters have been written
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeDoubleToFile
|
||||
Process: writes individual formatted double value to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: double value to output (double),
|
||||
number of digits to right of radix point
|
||||
(precision) (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: double written to file
|
||||
Dependencies: writeDoubleJustifiedToFile
|
||||
*/
|
||||
bool writeDoubleToFile( double outVal, int precision )
|
||||
{
|
||||
// initialize variables, set block size to zero and justified to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// call to justified function
|
||||
// function: writeDoubleJustifiedToFile
|
||||
return writeDoubleJustifiedToFile( outVal, precision,
|
||||
blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeDoubleToFileJustified
|
||||
Process: writes individual formatted double value to file justified,
|
||||
returns true if successful, false otherwise
|
||||
outVal - the double value to be output
|
||||
precision - number of digits to the right of the radix point
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: double written to file as specified
|
||||
Dependencies: sprintf, writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeDoubleJustifiedToFile( double outVal, int precision,
|
||||
int blockSize, const char *justified )
|
||||
{
|
||||
// initialize variables, create temp string for configuration string
|
||||
char specStr[ MIN_STR_LEN ];
|
||||
|
||||
// initialize variables, create temporary output string
|
||||
char outStr[ MIN_STR_LEN ];
|
||||
|
||||
// set configuration string with precision value
|
||||
// function: sprintf
|
||||
sprintf( specStr, "%s0.%dlf", "%", precision );
|
||||
|
||||
// set double to string
|
||||
// function: sprintf
|
||||
sprintf( outStr, specStr, outVal );
|
||||
|
||||
// write as string, return result
|
||||
// function: writeStringJustified
|
||||
return writeStringJustifiedToFile( outStr, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeEndlineToFile
|
||||
Process: writes newline ('\n') to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: newline written to file
|
||||
Dependencies: accessOutputFilePointer, fprintf
|
||||
*/
|
||||
bool writeEndlineToFile()
|
||||
{
|
||||
// get file pointer, initialize variable
|
||||
// function: accessOutputFilePointer
|
||||
FILE *filePtr = accessOutputFilePointer( GET_OUTPUT_FILE_PTR,
|
||||
DUMMY_OUTPUT_FILE_PTR );
|
||||
|
||||
// check for open file
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// print endline to file
|
||||
// function: fprintf
|
||||
fprintf( filePtr, "%c", NEWLINE_CHAR );
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
|
||||
// file not open, return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeEndlinesToFile
|
||||
Process: writes multiple carriage return ('\r')
|
||||
and newline ('\n') pairs to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: number of endline pairs to write (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: multiple newline characters written to file
|
||||
Dependencies: writeString
|
||||
*/
|
||||
bool writeEndlinesToFile( int numEndlines )
|
||||
{
|
||||
// check for number of characters remaining,
|
||||
if( numEndlines > 0 )
|
||||
{
|
||||
// write endline, check for success
|
||||
// function: writeEndlineTofile
|
||||
if( writeEndlineToFile() )
|
||||
{
|
||||
// continue recursion,
|
||||
// check for downstream success
|
||||
// function: writeEndlinesToFile
|
||||
return writeEndlinesToFile( numEndlines - 1 );
|
||||
}
|
||||
|
||||
// quit recursion
|
||||
// return unsuccessful operation - write operation failed
|
||||
return false;
|
||||
}
|
||||
|
||||
// return successful operation - all endlines have been written
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeIntegerToFile
|
||||
Process: writes individual integer to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: integer to output (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: integer written to file
|
||||
Dependencies: writeIntegerJustifiedToFile
|
||||
*/
|
||||
bool writeIntegerToFile( int outVal )
|
||||
{
|
||||
// initialize variables, set block size to zero and justified to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// call to justified function
|
||||
// function: writeDoubleJustifiedToFile
|
||||
return writeIntegerJustifiedToFile( outVal, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeIntegerJustifiedToFile
|
||||
Process: writes individual integer to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters:
|
||||
outVal - the integer value to be output
|
||||
precision - number of digits to the right of the radix point
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: integer written to file as specified
|
||||
Dependencies: sprintf, writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeIntegerJustifiedToFile( int outVal, int blockSize,
|
||||
const char *justified )
|
||||
{
|
||||
// initialize variables, create temporary output string
|
||||
char outStr[ MIN_STR_LEN ];
|
||||
|
||||
// set integer to string
|
||||
// function: sprintf
|
||||
sprintf( outStr, "%d", outVal );
|
||||
|
||||
// write as string, return result
|
||||
// function: writeStringJustified
|
||||
return writeStringJustifiedToFile( outStr, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeStringToFile
|
||||
Process: writes String value to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: double value to output (double),
|
||||
number of digits to right of radix point
|
||||
(precision) (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: String written to file
|
||||
Dependencies: writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeStringToFile( const char *outString )
|
||||
{
|
||||
// initialize variables, set block size to zero and justified to "LEFT"
|
||||
int blockSize = 0;
|
||||
char justified[] = "LEFT";
|
||||
|
||||
// call to justified function
|
||||
// function: writeStringJustifiedToFile
|
||||
return writeStringJustifiedToFile( outString, blockSize, justified );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: writeStringJustifiedToFile
|
||||
Process: write string to file within specified block size
|
||||
and with specified justification
|
||||
Function input/parameters:
|
||||
outVal - the string value to be output
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: success of output operation (bool)
|
||||
Function input/keyboard: None
|
||||
Device output/file: string written to file as specified
|
||||
Dependencies: strlen, strcmp, writeCharactersToFile, fprint
|
||||
*/
|
||||
bool writeStringJustifiedToFile( const char *outStr,
|
||||
int blockSize, const char *justify )
|
||||
{
|
||||
// initialize variables, set pre-, post- spaces to zero
|
||||
int preSpaces = 0, postSpaces = 0, strLength;
|
||||
|
||||
// get file pointer
|
||||
// function: accessFileOutputFilePointer
|
||||
FILE *filePtr = accessOutputFilePointer( GET_OUTPUT_FILE_PTR,
|
||||
DUMMY_OUTPUT_FILE_PTR );
|
||||
|
||||
if( filePtr != NULL )
|
||||
{
|
||||
// find length of string
|
||||
// function: strlen
|
||||
strLength = strlen( outStr );
|
||||
|
||||
// check justification for "LEFT"
|
||||
// function: strcmp
|
||||
if( strcmp( justify, "LEFT" ) == 0 )
|
||||
{
|
||||
// set post spaces for left justification
|
||||
postSpaces = blockSize - strLength;
|
||||
}
|
||||
|
||||
// otherwise, check justification for "RIGHT"
|
||||
// function: strcmp
|
||||
else if( strcmp( justify, "RIGHT" ) == 0 )
|
||||
{
|
||||
// set pre spaces for right justification
|
||||
preSpaces = blockSize - strLength;
|
||||
}
|
||||
|
||||
// Otherwise, assume "CENTER" justification
|
||||
else
|
||||
{
|
||||
// set pre spaces for centered
|
||||
preSpaces = blockSize / 2 - strLength / 2;
|
||||
|
||||
// set post spaces for centered
|
||||
postSpaces = blockSize - strLength - preSpaces;
|
||||
}
|
||||
|
||||
// print pre spaces, check for success
|
||||
// function: writeCharactersToFile
|
||||
writeCharactersToFile( preSpaces, SPACE );
|
||||
|
||||
// print string
|
||||
// function: fprintf
|
||||
fprintf( filePtr, "%s", outStr );
|
||||
|
||||
// print post spaces
|
||||
// function: printChars
|
||||
writeCharactersToFile( postSpaces, SPACE );
|
||||
|
||||
// return successful operation
|
||||
return true;
|
||||
}
|
||||
|
||||
// return failed operation
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
236
PA05-1004/File_Output_Utility.h
Normal file
236
PA05-1004/File_Output_Utility.h
Normal file
|
|
@ -0,0 +1,236 @@
|
|||
/*
|
||||
Formatted file output utility, function prototypes
|
||||
|
||||
Copyright (c) 2021 by Michael E. Leverington
|
||||
|
||||
Code is free for use in whole or in part and may be modified for other
|
||||
non-commercial use as long as the above copyright statement is included.
|
||||
*/
|
||||
/*
|
||||
Rev 0.0: 30 June 2021, Initial creation of file
|
||||
|
||||
UTILITY USAGE INSTRUCTIONS:
|
||||
|
||||
1) This utility contains functions that may be used for file input operations
|
||||
using the C programming language with text files.
|
||||
The utility must be linked with the program code with which
|
||||
it will be used.
|
||||
|
||||
2) Specifications for all the functions
|
||||
are provided in a standardized format below.
|
||||
|
||||
3) Use this code at your own risk. There is no guarantee of any performance,
|
||||
implied or otherwise, for any part of this code
|
||||
|
||||
END OF INSTRUCTIONS
|
||||
*/
|
||||
|
||||
// PreProcessor directives
|
||||
#ifndef FILE_OUTPUT_UTILITY_H
|
||||
#define FILE_OUTPUT_UTILITY_H
|
||||
|
||||
// header files
|
||||
#include <stdbool.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "StandardConstants.h"
|
||||
|
||||
// function prototypes
|
||||
|
||||
/*
|
||||
Name: accessOutputFilePointer
|
||||
process: allows setting or accessing file pointer;
|
||||
note: pointer is maintained (static) value initialized to NULL
|
||||
Function input/parameters: control code (int), file pointer (FILE *)
|
||||
DUMMY_OUTPUT_FILE_PTR used
|
||||
if not setting file pointer
|
||||
Function output/parameters: none
|
||||
Function output/returned: file pointer (FILE *)
|
||||
Device input/file: none
|
||||
Device output/monitor: none
|
||||
Dependencies: none
|
||||
*/
|
||||
FILE *accessOutputFilePointer( int ctrlCode, const FILE *filePtr );
|
||||
|
||||
/*
|
||||
Name: closeOutputFile
|
||||
Process: closes output file, returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: output file closed
|
||||
Dependencies: accessOutputFilePointer, fclose
|
||||
*/
|
||||
bool closeOutputFile();
|
||||
|
||||
/*
|
||||
Name: openOutputFile
|
||||
Process: opens input file, returns true if successful, false otherwise
|
||||
Function input/parameters: file name (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: output file opened
|
||||
Dependencies: accessOutputFilePointer, fopen
|
||||
*/
|
||||
bool openOutputFile( const char *fileName );
|
||||
|
||||
/*
|
||||
Name: writeCharacterToFile
|
||||
Process: writes individual character to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: character to output (char)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: character written to file
|
||||
Dependencies: accessOutputFilePointer, fprintf
|
||||
*/
|
||||
bool writeCharacterToFile( char outChar );
|
||||
|
||||
/*
|
||||
Name: writeCharactersToFile
|
||||
Process: writes multiple characters to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: number of characters to output (int),
|
||||
character to output (char)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: multiple characters written to file
|
||||
Dependencies: writeCharacterToFile
|
||||
*/
|
||||
bool writeCharactersToFile( int numChars, char outChar );
|
||||
|
||||
/*
|
||||
Name: writeDoubleToFile
|
||||
Process: writes individual formatted double value to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: double value to output (double),
|
||||
number of digits to right of radix point
|
||||
(precision) (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: double written to file
|
||||
Dependencies: writeDoubleJustifiedToFile
|
||||
*/
|
||||
bool writeDoubleToFile( double outVal, int precision );
|
||||
|
||||
/*
|
||||
Name: writeDoubleToFileJustified
|
||||
Process: writes individual formatted double value to file justified,
|
||||
returns true if successful, false otherwise
|
||||
outVal - the double value to be output
|
||||
precision - number of digits to the right of the radix point
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: double written to file as specified
|
||||
Dependencies: sprintf, writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeDoubleJustifiedToFile( double outVal, int precision,
|
||||
int blockSize, const char *justified );
|
||||
|
||||
/*
|
||||
Name: writeEndlineToFile
|
||||
Process: writes newline ('\n') to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: none
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: newline written to file
|
||||
Dependencies: accessOutputFilePointer, fprintf
|
||||
*/
|
||||
bool writeEndlineToFile();
|
||||
|
||||
/*
|
||||
Name: writeEndlinesToFile
|
||||
Process: writes multiple carriage return ('\r')
|
||||
and newline ('\n') pairs to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: number of endline pairs to write (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: multiple newline characters written to file
|
||||
Dependencies: writeString
|
||||
*/
|
||||
bool writeEndlinesToFile( int numEndlines );
|
||||
|
||||
/*
|
||||
Name: writeIntegerToFile
|
||||
Process: writes individual integer to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: integer to output (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: integer written to file
|
||||
Dependencies: writeIntegerJustifiedToFile
|
||||
*/
|
||||
bool writeIntegerToFile( int outVal );
|
||||
|
||||
/*
|
||||
Name: writeIntegerJustifiedToFile
|
||||
Process: writes individual integer to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters:
|
||||
outVal - the integer value to be output
|
||||
precision - number of digits to the right of the radix point
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: integer written to file as specified
|
||||
Dependencies: sprintf, writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeIntegerJustifiedToFile( int outVal, int blockSize,
|
||||
const char *justified );
|
||||
|
||||
/*
|
||||
Name: writeStringToFile
|
||||
Process: writes String value to file,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: double value to output (double),
|
||||
number of digits to right of radix point
|
||||
(precision) (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: operation success (bool)
|
||||
Device input/file: none
|
||||
Device output/file: String written to file
|
||||
Dependencies: writeStringJustifiedToFile
|
||||
*/
|
||||
bool writeStringToFile( const char *outString );
|
||||
|
||||
/*
|
||||
Name: writeStringJustifiedToFile
|
||||
Process: write string to file within specified block size
|
||||
and with specified justification
|
||||
Function input/parameters:
|
||||
outVal - the string value to be output
|
||||
blockSize - the width of the block within which
|
||||
to print the integer value (int)
|
||||
justify - "LEFT," "RIGHT," or "CENTER" justification
|
||||
in block (c-string)
|
||||
Function output/parameters: None
|
||||
Function output/returned: success of output operation (bool)
|
||||
Function input/keyboard: None
|
||||
Device output/file: string written to file as specified
|
||||
Dependencies: strlen, strcmp, writeCharactersToFile, fprint
|
||||
*/
|
||||
bool writeStringJustifiedToFile( const char *outStr,
|
||||
int blockSize, const char *justify );
|
||||
|
||||
|
||||
#endif // FILE_OUTPUT_UTILITY_H
|
||||
|
||||
139
PA05-1004/IteratorUtility.h
Normal file
139
PA05-1004/IteratorUtility.h
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
#ifndef ITERATOR_UTILITY_H
|
||||
#define ITERATOR_UTILITY_H
|
||||
|
||||
// header files
|
||||
#include "ArrayDataEngine.h"
|
||||
|
||||
typedef struct IteratorStruct
|
||||
{
|
||||
StateArrayType *iterData;
|
||||
|
||||
int currentIndex;
|
||||
} IteratorType;
|
||||
|
||||
// function prototypes
|
||||
|
||||
/*
|
||||
Name: clearIterator
|
||||
Process: clears the StateDataType sub-structure, and then the IteratorType
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *)
|
||||
Function output/parameters: none
|
||||
Function output/returned: NULL
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: clearDataStructure, free
|
||||
*/
|
||||
IteratorType *clearIterator( IteratorType *iterator );
|
||||
|
||||
/*
|
||||
Name: createIterator
|
||||
Process: initializes the IteratorType,
|
||||
and then the StateDataType sub-structure
|
||||
Function input/parameters: initial capacity (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: pointer to initialized IteratorType (IteratorType *)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: malloc, createDataStructure
|
||||
*/
|
||||
IteratorType *createIterator( int initialCapacity );
|
||||
|
||||
/*
|
||||
Name: getFirst
|
||||
Process: gets first value in iterator, returns true,
|
||||
returns false otherwise
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *)
|
||||
Function output/parameters: return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex
|
||||
*/
|
||||
bool getFirst( IteratorType *iterator, StateDataType *returned );
|
||||
|
||||
/*
|
||||
Name: getLast
|
||||
Process: gets last value in iterator, returns true,
|
||||
returns false otherwise
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *)
|
||||
Function output/parameters: return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex, getListSize
|
||||
*/
|
||||
bool getLast( IteratorType *iterator, StateDataType *returned );
|
||||
|
||||
/*
|
||||
Name: getNext
|
||||
Process: gets next value in iterator if available, returns true,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *)
|
||||
Function output/parameters: return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex, getListSize
|
||||
*/
|
||||
bool getNext( IteratorType *iterator, StateDataType *returned );
|
||||
|
||||
/*
|
||||
Name: getPrevious
|
||||
Process: gets previous value in iterator if available, returns true,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *)
|
||||
Function output/parameters: return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex
|
||||
*/
|
||||
bool getPrevious( IteratorType *iterator, StateDataType *returned );
|
||||
|
||||
/*
|
||||
Name: insertAfterCurrentIndex
|
||||
Process: inserts value immediately after currentIndex, if possible, returns true,
|
||||
otherwise, returns false
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *),
|
||||
value to be inserted (const StateDataType)
|
||||
Function output/parameters: none
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: insertItemAtIndex, getListSize
|
||||
*/
|
||||
bool insertAfterCurrentIndex( IteratorType *iterator,
|
||||
const StateDataType toBeInserted );
|
||||
|
||||
/*
|
||||
Name: insertAtCurrentIndex
|
||||
Process: inserts value at currentIndex, if possible, returns true
|
||||
otherwise, returns false
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *),
|
||||
value to be inserted (const StateDataType)
|
||||
Function output/parameters: none
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: insertItemAtIndex
|
||||
*/
|
||||
bool insertAtCurrentIndex( IteratorType *iterator,
|
||||
const StateDataType toBeInserted );
|
||||
|
||||
/*
|
||||
Name: removeAtCurrentIndex
|
||||
Process: removes value at current index if possible, returns true,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to IteratorType (IteratorType *),
|
||||
value to be remove (StateDataType *)
|
||||
Function output/parameters: pointer to updated IteratorType (IteratorType *),
|
||||
pointer to item removed (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: removeItemAtIndex, getListSize
|
||||
*/
|
||||
bool removeAtCurrentIndex( IteratorType *iterator, StateDataType *removedItem );
|
||||
|
||||
|
||||
#endif // ITERATOR_UTILITY_H
|
||||
43
PA05-1004/Makefile
Normal file
43
PA05-1004/Makefile
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
CC = gcc -Wall
|
||||
SOURCES = PA04_Main.c BasicUtilities.c RoomUtilities.c CourseUtilities.c Console_IO_Utility.c File_Input_Utility.c File_Output_Utility.c
|
||||
OBJECTS = PA04_Main.o BasicUtilities.o RoomUtilities.o CourseUtilities.o Console_IO_Utility.o File_Input_Utility.o File_Output_Utility.o
|
||||
|
||||
# Uses the template structure defined in the TypicalUtils folder
|
||||
|
||||
all: PA04_Main
|
||||
|
||||
PA04_Main: $(OBJECTS)
|
||||
$(CC) $(OBJECTS) -o PA04_Main
|
||||
|
||||
PA04_Main.o: PA04_Main.c
|
||||
$(CC) -c PA04_Main.c -o PA04_Main.o
|
||||
|
||||
BasicUtilities.o: BasicUtilities.c
|
||||
$(CC) -c BasicUtilities.c -o BasicUtilities.o
|
||||
|
||||
CourseUtilities.o: CourseUtilities.c
|
||||
$(CC) -c CourseUtilities.c -o CourseUtilities.o
|
||||
|
||||
RoomUtilities.o: RoomUtilities.c
|
||||
$(CC) -c RoomUtilities.c -o RoomUtilities.o
|
||||
|
||||
Console_IO_Utility.o: Console_IO_Utility.c
|
||||
$(CC) -c Console_IO_Utility.c -o Console_IO_Utility.o
|
||||
|
||||
File_Input_Utility.o: File_Input_Utility.c
|
||||
$(CC) -c File_Input_Utility.c -o File_Input_Utility.o
|
||||
|
||||
File_Output_Utility.o: File_Output_Utility.c
|
||||
$(CC) -c File_Output_Utility.c -o File_Output_Utility.o
|
||||
|
||||
clean:
|
||||
rm -f $(OBJECTS) PA03_Main PA03_Main.out
|
||||
|
||||
clean_objects:
|
||||
rm -f $(OBJECTS)
|
||||
|
||||
run:
|
||||
./PA04_Main
|
||||
|
||||
run_win:
|
||||
PA04_Main
|
||||
354
PA05-1004/PA05_Main.c
Normal file
354
PA05-1004/PA05_Main.c
Normal file
|
|
@ -0,0 +1,354 @@
|
|||
// header file
|
||||
#include "File_Input_Utility.h"
|
||||
#include "IteratorUtility.h"
|
||||
#include "StackUtility.h"
|
||||
#include "QueueUtility.h"
|
||||
|
||||
// local constants for program
|
||||
const int INITIAL_NUM_STATES = 10;
|
||||
|
||||
// function prototypes
|
||||
void showTitle();
|
||||
bool uploadStateData( StateArrayType *arrayType, const char *fileName );
|
||||
|
||||
int main()
|
||||
{
|
||||
// initialize function/program
|
||||
|
||||
// initialize variables
|
||||
StateArrayType *wkgArray;
|
||||
StateDataType tempData;
|
||||
IteratorType *iterator;
|
||||
StackType *stack;
|
||||
QueueType *queue;
|
||||
int index, testLimit, testStart = 0;
|
||||
|
||||
// show title
|
||||
// function: showTitle
|
||||
showTitle();
|
||||
|
||||
// set up data
|
||||
wkgArray = createDataStructure( INITIAL_NUM_STATES );
|
||||
iterator = createIterator( INITIAL_NUM_STATES );
|
||||
stack = createStack( INITIAL_NUM_STATES );
|
||||
queue = createQueue( INITIAL_NUM_STATES );
|
||||
|
||||
// Upload data
|
||||
if( uploadStateData( wkgArray, "StateData.csv" ) )
|
||||
{
|
||||
|
||||
// Testing for iterators
|
||||
printf( "\nIterator Test Bed ---------------------------------\n\n" );
|
||||
|
||||
printf( "Inserting at index zero\n" );
|
||||
|
||||
testStart = 25; testLimit = 35;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *wkgArray, index );
|
||||
|
||||
printf( "Inserting: %s\n", tempData.name );
|
||||
|
||||
insertAtCurrentIndex( iterator, wkgArray->array[ index ] );
|
||||
}
|
||||
|
||||
printf( "\nIterate across list, first to last\n" );
|
||||
|
||||
getFirst( iterator, &tempData );
|
||||
|
||||
printf( "First name: %s\n", tempData.name );
|
||||
|
||||
while( getNext( iterator, &tempData ) )
|
||||
{
|
||||
printf( "Next name: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
printf( "\nRemoving from end\n" );
|
||||
|
||||
getLast( iterator, &tempData );
|
||||
|
||||
testStart = 0; testLimit = 5;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
removeAtCurrentIndex( iterator, &tempData );
|
||||
|
||||
printf( "Removing: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
printf( "\nIterate across list, last to first\n" );
|
||||
|
||||
getLast( iterator, &tempData );
|
||||
|
||||
printf( "Last name: %s\n", tempData.name );
|
||||
|
||||
while( getPrevious( iterator, &tempData ) )
|
||||
{
|
||||
printf( "Prior name: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
printf( "\nIterate across list, first to last\n" );
|
||||
|
||||
getFirst( iterator, &tempData );
|
||||
|
||||
printf( "First name: %s\n", tempData.name );
|
||||
|
||||
while( getNext( iterator, &tempData ) )
|
||||
{
|
||||
printf( "Next name: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
// Testing for Stacks
|
||||
printf( "\nStack Test Bed ------------------------------------\n\n" );
|
||||
|
||||
printf( "Push items on stack:\n" );
|
||||
|
||||
testLimit = 10;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *wkgArray, index );
|
||||
|
||||
printf( "Pushing: %s\n", tempData.name );
|
||||
|
||||
pushStack( stack, tempData );
|
||||
}
|
||||
|
||||
printf( "\nCurrent stack: " );
|
||||
|
||||
testStart = 0;
|
||||
for( index = testStart; index < getListSize( *stack ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *stack, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Top\n" );
|
||||
|
||||
printf( "\nPop items from stack:\n" );
|
||||
|
||||
testLimit = 5;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
popStack( &tempData, stack );
|
||||
|
||||
printf( "Popping: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
printf( "\nCurrent stack: " );
|
||||
|
||||
for( index = testStart; index < getListSize( *stack ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *stack, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Top\n" );
|
||||
|
||||
printf( "\nPush more items on stack:\n" );
|
||||
|
||||
testStart = 10; testLimit = 15;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *wkgArray, index );
|
||||
|
||||
printf( "Pushing: %s\n", tempData.name );
|
||||
|
||||
pushStack( stack, wkgArray->array[ index ] );
|
||||
}
|
||||
|
||||
printf( "\nCurrent stack: " );
|
||||
|
||||
testStart = 0;
|
||||
for( index = testStart; index < getListSize( *stack ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *stack, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Top\n" );
|
||||
|
||||
printf( "\nPopping until empty:\n" );
|
||||
|
||||
while( popStack( &tempData, stack ) )
|
||||
{
|
||||
printf( "Popping: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
// Testing for Queues
|
||||
printf( "\nQueue Test Bed ------------------------------------\n\n" );
|
||||
|
||||
printf( "Enqueue items:\n" );
|
||||
|
||||
testStart = 0; testLimit = 10;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *wkgArray, index );
|
||||
|
||||
printf( "Enqueueing: %s\n", tempData.name );
|
||||
|
||||
enqueue( queue, tempData );
|
||||
}
|
||||
|
||||
printf( "\nCurrent queue: Rear -> " );
|
||||
|
||||
testStart = 0;
|
||||
for( index = testStart; index < getListSize( *queue ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *queue, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Front\n" );
|
||||
|
||||
printf( "\nDequeue items from queue:\n" );
|
||||
|
||||
testLimit = 5;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
dequeue( &tempData, queue );
|
||||
|
||||
printf( "Dequeueing: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
printf( "\nCurrent queue: Rear -> " );
|
||||
|
||||
for( index = testStart; index < getListSize( *queue ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *queue, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Front\n" );
|
||||
|
||||
printf( "\nEnqueue more items:\n" );
|
||||
|
||||
testStart = 10; testLimit = 15;
|
||||
for( index = testStart; index < testLimit; index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *wkgArray, index );
|
||||
|
||||
printf( "Enqueueing: %s\n", tempData.name );
|
||||
|
||||
enqueue( queue, tempData );
|
||||
}
|
||||
|
||||
printf( "\nCurrent queue: Rear -> " );
|
||||
|
||||
testStart = 0;
|
||||
for( index = testStart; index < getListSize( *queue ); index++ )
|
||||
{
|
||||
getItemAtIndex( &tempData, *queue, index );
|
||||
|
||||
printf( "%s | ", tempData.name );
|
||||
}
|
||||
|
||||
printf( " <- Front\n" );
|
||||
|
||||
printf( "\nDequeueing until empty:\n" );
|
||||
|
||||
while( dequeue( &tempData, queue ) )
|
||||
{
|
||||
printf( "Dequeueing: %s\n", tempData.name );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
else
|
||||
{
|
||||
printf( "\nFile not found - Program aborted\n" );
|
||||
}
|
||||
|
||||
|
||||
// end program
|
||||
|
||||
// report end program
|
||||
// function: printf
|
||||
printf( "\nProgram End\n" );
|
||||
|
||||
// deallocate memory
|
||||
wkgArray = clearDataStructure( wkgArray );
|
||||
|
||||
iterator = clearIterator( iterator );
|
||||
|
||||
stack = clearStack( stack );
|
||||
|
||||
queue = clearQueue( queue );
|
||||
|
||||
// return program success
|
||||
return 0;
|
||||
}
|
||||
|
||||
void showTitle()
|
||||
{
|
||||
printf( "\nData Structure Test Program\n" );
|
||||
printf( "===========================\n" );
|
||||
}
|
||||
|
||||
/*
|
||||
Name: uploadStateData
|
||||
Process: uploads data from given file to state data array,
|
||||
ignores first (title) line in .csv file,
|
||||
then captures comma-delimited state name, population, growth,
|
||||
and political majority data on each row,
|
||||
returns true if upload successful, false otherwise
|
||||
Function input/parameters: file name (const char *)
|
||||
Function output/parameters: updated array with uploaded values (StateDataType *)
|
||||
Function output/returned: Boolean result of upload operation
|
||||
Device input/HD: data uploaded from text file as specified
|
||||
Device output/---: none
|
||||
Dependencies: as needed
|
||||
*/
|
||||
bool uploadStateData( StateArrayType *arrayType, const char *fileName )
|
||||
{
|
||||
StateDataType inputItem;
|
||||
int index = 0;
|
||||
bool verboseFlag = false;
|
||||
|
||||
if( openInputFile( fileName ) )
|
||||
{
|
||||
// input top row, ignore
|
||||
readStringToLineEndFromFile( inputItem.name );
|
||||
|
||||
// input first data line, read prime
|
||||
readStringToDelimiterFromFile( COMMA, inputItem.name );
|
||||
|
||||
while( !checkForEndOfInputFile() )
|
||||
{
|
||||
// get population
|
||||
inputItem.population = readIntegerFromFile();
|
||||
readCharacterFromFile();
|
||||
|
||||
// get growth percentage
|
||||
inputItem.growth = readDoubleFromFile();
|
||||
readCharacterFromFile();
|
||||
|
||||
inputItem.majority = readCharacterFromFile();
|
||||
|
||||
if( verboseFlag )
|
||||
{
|
||||
printf( "[%3d] name: %s, pop: %d, grth: %7.6f, %c\n",
|
||||
index + 1, inputItem.name, inputItem.population,
|
||||
inputItem.growth, inputItem.majority );
|
||||
}
|
||||
|
||||
insertItemAtIndex( arrayType, inputItem, index );
|
||||
|
||||
index++;
|
||||
|
||||
// read re-prime
|
||||
readStringToDelimiterFromFile( COMMA, inputItem.name );
|
||||
}
|
||||
|
||||
closeInputFile();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
80
PA05-1004/QueueUtility.h
Normal file
80
PA05-1004/QueueUtility.h
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
#ifndef QUEUE_UTILITY_H
|
||||
#define QUEUE_UTILITY_H
|
||||
|
||||
// header files
|
||||
#include "ArrayDataEngine.h"
|
||||
|
||||
// data structures
|
||||
typedef StateArrayType QueueType;
|
||||
|
||||
// function prototypes
|
||||
|
||||
/*
|
||||
Name: clearQueue
|
||||
Process: clears QueueType, returns NULL
|
||||
Function input/parameters: pointer to queue type (QueueType *)
|
||||
Function output/parameters: none
|
||||
Function output/returned: NULL
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: clearDataStructure
|
||||
*/
|
||||
QueueType *clearQueue( QueueType *queue );
|
||||
|
||||
/*
|
||||
Name: createQueue
|
||||
Process: creates QueueType, initializes front index to zero,
|
||||
rear index to -1, returns pointer to data structure
|
||||
Function input/parameters: initial capacity (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: pointer to queue type (QueueType *)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: createDataStructure
|
||||
*/
|
||||
QueueType *createQueue( int initialCapacity );
|
||||
|
||||
/*
|
||||
Name: peekFront
|
||||
Process: captures value at front of queue
|
||||
returns true if successful and sets return value,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to queue type (QueueType *)
|
||||
Function output/parameters: pointer to return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex, getListSize
|
||||
*/
|
||||
bool peekFront( StateDataType *returnVal, const QueueType queue );
|
||||
|
||||
/*
|
||||
Name: dequeue
|
||||
Process: captures value at front of queue, removes and returns value,
|
||||
returns true if successful,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to queue type (QueueType *)
|
||||
Function output/parameters: pointer to return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: removeItemAtIndex, getListSize
|
||||
*/
|
||||
bool dequeue( StateDataType *returnVal, QueueType *queue );
|
||||
|
||||
/*
|
||||
Name: enqueue
|
||||
Process: sets value at rear of queue
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: pointer to queue type (QueueType *)
|
||||
Function output/parameters: value to be pushed (const StateDataType)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: insertItemAtIndex
|
||||
*/
|
||||
bool enqueue( QueueType *queue, const StateDataType toBePushed );
|
||||
|
||||
|
||||
|
||||
#endif // QUEUE_UTILITY_H
|
||||
78
PA05-1004/StackUtility.h
Normal file
78
PA05-1004/StackUtility.h
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
#ifndef STACK_UTILITY_H
|
||||
#define STACK_UTILITY_H
|
||||
|
||||
// header files
|
||||
#include "ArrayDataEngine.h"
|
||||
|
||||
// data structures
|
||||
typedef StateArrayType StackType;
|
||||
|
||||
// function prototypes
|
||||
|
||||
/*
|
||||
Name: clearStack
|
||||
Process: clears StackType, returns NULL
|
||||
Function input/parameters: pointer to stack type (StackType *)
|
||||
Function output/parameters: none
|
||||
Function output/returned: NULL
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: clearDataStructure
|
||||
*/
|
||||
StackType *clearStack( StackType *stackData );
|
||||
|
||||
/*
|
||||
Name: createStack
|
||||
Process: creates StackType, returns pointer to it
|
||||
Function input/parameters: initial capacity (int)
|
||||
Function output/parameters: none
|
||||
Function output/returned: pointer to stack type (StackType *)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: createDataStructure
|
||||
*/
|
||||
StackType *createStack( int initialCapacity );
|
||||
|
||||
/*
|
||||
Name: peekTop
|
||||
Process: captures value at top of stack, returns,
|
||||
returns true if successful,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to stack type (StackType *)
|
||||
Function output/parameters: pointer to return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation (bool)
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: getItemAtIndex, getListSize
|
||||
*/
|
||||
bool peekTop( StateDataType *returnVal, const StackType stackData );
|
||||
|
||||
/*
|
||||
Name: popStack
|
||||
Process: captures value at top of stack, removes and returns,
|
||||
returns true if successful,
|
||||
otherwise, sets return value to empty, returns false
|
||||
Function input/parameters: pointer to stack type (StackType *)
|
||||
Function output/parameters: pointer to return value (StateDataType *)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: removeItemAtIndex, getListSize
|
||||
*/
|
||||
bool popStack( StateDataType *returnVal, StackType *stackData );
|
||||
|
||||
/*
|
||||
Name: pushStack
|
||||
Process: sets value at top of stack,
|
||||
returns true if successful, false otherwise
|
||||
Function input/parameters: pointer to stack type (StackType *)
|
||||
Function output/parameters: value to be pushed (const StateDataType)
|
||||
Function output/returned: Boolean result of operation
|
||||
Device input/---: none
|
||||
Device output/---: none
|
||||
Dependencies: insertItemAtIndex, getListSize
|
||||
*/
|
||||
bool pushStack( StackType *stackData, const StateDataType toBePushed );
|
||||
|
||||
|
||||
#endif // STACK_UTILITY_H
|
||||
73
PA05-1004/StandardConstants.h
Normal file
73
PA05-1004/StandardConstants.h
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
// Preprocessor directives
|
||||
#ifndef STANDARD_CONSTANTS_H
|
||||
#define STANDARD_CONSTANTS_H
|
||||
|
||||
// Include Boolean
|
||||
#include <stdbool.h>
|
||||
|
||||
// global constants
|
||||
|
||||
// constant for end of c-string null character
|
||||
#define CARRIAGE_RETURN_CHAR '\r'
|
||||
|
||||
//constant for a COLON
|
||||
#define COLON ':'
|
||||
|
||||
//constant for a COMMA
|
||||
#define COMMA ','
|
||||
|
||||
//Constant to print a dash
|
||||
#define DASH '-'
|
||||
|
||||
// highest printable character
|
||||
#define HIGHEST_PRINTABLE_CHAR '~'
|
||||
|
||||
// constant for huge string length
|
||||
#define HUGE_STR_LEN 256
|
||||
|
||||
// lowest printable character
|
||||
#define LOWEST_PRINTABLE_CHAR ' '
|
||||
|
||||
// constant for small string length
|
||||
#define MIN_STR_LEN 32
|
||||
|
||||
// constant for maximum string length
|
||||
#define MAX_STR_LEN 128
|
||||
|
||||
// constant for end of c-string null character
|
||||
#define NEWLINE_CHAR '\n'
|
||||
|
||||
// first non-printable above ASCII
|
||||
#define DELETE_KEY 127
|
||||
|
||||
// constant for end of c-string null character
|
||||
#define NULL_CHAR '\0'
|
||||
|
||||
// columns found in grade sheet before grading columns
|
||||
#define NUM_BASE_COLS 5
|
||||
|
||||
// constant for number of grading frequency bins
|
||||
#define NUM_FREQUENCY_BINS 10
|
||||
|
||||
//Constant for printing a pipe
|
||||
#define PIPE '|'
|
||||
|
||||
//Constant for a period
|
||||
#define PERIOD '.'
|
||||
|
||||
//Constant for PRECISION, 2 digits
|
||||
#define PRECISION_2 2
|
||||
|
||||
//Constant for PRECISION, 4 digits
|
||||
#define PRECISION_4 4
|
||||
|
||||
// constant for space character
|
||||
#define SPACE ' '
|
||||
|
||||
// constant for standard string length
|
||||
#define STD_STR_LEN 64
|
||||
|
||||
// constant for smallest string length
|
||||
#define TINY_STR_LEN 16
|
||||
|
||||
#endif // STANDARD_CONSTANTS
|
||||
51
PA05-1004/StateData.csv
Normal file
51
PA05-1004/StateData.csv
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
State,Population,Growth,Majority
|
||||
North Carolina,10698973,0.0851,N
|
||||
Texas,30029572,0.1336,R
|
||||
Ohio,11756058,0.0222,N
|
||||
Arkansas,3045637,0.0315,R
|
||||
Mississippi,2940057,-0.002,R
|
||||
Tennessee,7051339,0.0804,R
|
||||
Missouri,6177957,0.0268,R
|
||||
Alabama,5074296,0.0482,R
|
||||
Arizona,7359197,0.104,N
|
||||
Massachusetts,6981974,0.0677,D
|
||||
Rhode Island,1093734,0.0405,D
|
||||
Maine,1385340,0.0248,D
|
||||
South Dakota,909824,0.0804,R
|
||||
West Virginia,1775156,-0.0333,R
|
||||
Delaware,1018396,0.0912,D
|
||||
Florida,22244823,0.1239,N
|
||||
New Jersey,9261699,0.0529,D
|
||||
Utah,3380800,0.1505,R
|
||||
Nebraska,1967923,0.068,R
|
||||
South Carolina,5282634,0.0945,R
|
||||
Wyoming,581381,0.0228,R
|
||||
Georgia,10912876,0.0938,N
|
||||
Oklahoma,4019800,0.052,R
|
||||
Colorado,5839926,0.1257,D
|
||||
Kentucky,4512310,0.0367,R
|
||||
Washington,7785786,0.1241,D
|
||||
Nevada,3177772,0.1268,N
|
||||
Michigan,10034113,0.0191,N
|
||||
Connecticut,3626205,0.0088,D
|
||||
Wisconsin,5892539,0.0348,N
|
||||
Louisiana,4590241,0.0266,R
|
||||
Hawaii,1440196,0.0644,D
|
||||
Virginia,8683619,0.072,D
|
||||
New Mexico,2113344,0.0274,D
|
||||
Oregon,4240137,0.0941,D
|
||||
North Dakota,779261,0.1331,R
|
||||
New Hampshire,1395231,0.0439,D
|
||||
Pennsylvania,12972008,0.023,N
|
||||
Kansas,2937150,0.0287,R
|
||||
Minnesota,5717184,0.0696,N
|
||||
Indiana,6833037,0.0441,R
|
||||
Idaho,1939033,0.1434,R
|
||||
Montana,1122867,0.0859,R
|
||||
Alaska,733583,0.0314,R
|
||||
Maryland,6164660,0.0645,D
|
||||
Vermont,647064,0.0268,D
|
||||
New York,19677151,0.0404,D
|
||||
California,39029342,0.0571,D
|
||||
Iowa,3200517,0.0447,R
|
||||
Illinois,12582032,-0.0014,D
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue