PA04 Initialization

++ Project 4 Files ++ Makefile for Project 4
2023-09-19 22:20:54 -07:00 · 2023-09-19 22:20:54 -07:00 · 6f74d5bb92
commit 6f74d5bb92
parent 82bf795c15
29 changed files with 445293 additions and 0 deletions
--- a/PA04-0927/CourseUtilities.h
+++ b/PA04-0927/CourseUtilities.h
@ -0,0 +1,108 @@
+#ifndef COURSE_UTILITIES_H
+#define COURSE_UTILITIES_H
+
+// header files
+#include <string.h>
+#include "StandardConstants.h"
+
+// data structure
+typedef struct CourseDataStruct
+   {
+    char courseName[ TINY_STR_LEN ];
+    int size;
+    bool available;
+   } CourseDataType;
+
+typedef struct CourseArrayStruct
+   {
+    CourseDataType *array;
+
+    int size, capacity;
+   } CourseArrayType;
+
+// function specifications/prototypes
+
+/*
+Name: addCourseWithData
+Process: adds course data struct to array and returns true,
+         returns false if array is full
+Function input/parameters: course data array (CourseArrayType *), 
+                           course name (const char *),
+                           course size (int), course availability (bool)
+Function output/parameters: updated course data array (CourseArrayType *) 
+Function output/returned: Boolean result of operation (bool)
+Device input/---: none
+Device output/---: none
+Dependencies: as needed, with copyString
+*/
+bool addCourseWithData( CourseArrayType *courseData, const char *courseName,
+                                      int courseSize, bool courseAvailability ); 
+
+/*
+Name: addCourseWithCourse
+Process: adds course data to array and returns true,
+         returns false if array is full
+Function input/parameters: source course data array (const CourseArrayType *)
+Function output/parameters: destination course data array (CourseArrayType *) 
+Function output/returned: Boolean result of operation (bool)
+Device input/---: none
+Device output/---: none
+Dependencies: addCourseWithData - one line of code
+*/
+void addCourseWithCourse( CourseArrayType *destCourse, 
+                                               const CourseDataType srcCourse );
+
+/*
+Name: clearCourseArray
+Process: frees CourseArrayType memory, along with array memory, returns NULL
+Function input/parameters: course array structure (CourseArrayType *)
+Function output/parameters: none
+Function output/returned: NULL (CourseArrayType *)
+Device input/---: none
+Device output/---: none
+Dependencies: free
+*/
+CourseArrayType *clearCourseArray( CourseArrayType *courseData );
+
+/*
+Name: createCourseArray
+Process: allocates CourseArrayType memory, along with array memory, 
+         returns pointer to new course
+Function input/parameters: initial capacity
+Function output/parameters: none
+Function output/returned: created course (CourseArrayType *)
+Device input/---: none
+Device output/---: none
+Dependencies: malloc, with keyword sizeof
+*/
+CourseArrayType *createCourseArray( int initCapacity );
+
+/*
+Name: deepCopyCourse
+Process: copies source course data into destination course
+Function input/parameters: source course data (const CourseDataType)
+Function output/parameters: destination course data (CourseDataType *)
+Function output/returned: none
+Device input/---: none
+Device output/---: none
+Dependencies: as needed, including strcpy
+*/
+void deepCopyCourse( CourseDataType *destCourse, 
+                                               const CourseDataType srcCourse );
+
+/*
+Name: setCourseDataString
+Process: course data into string, in format:
+         "Course Name: <course name>, Course Size: <course size>"
+Function input/parameters: course data (const CourseDataType)
+Function output/parameters: loaded c-style string (char *)
+Function output/returned: none
+Device input/---: none
+Device output/---: none
+Dependencies: sprintf
+*/
+void setCourseDataString( char *dataStr, const CourseDataType courseData );
+
+
+#endif   // COURSE_UTILITIES_H
+