CMSC216 Project 1: C Programming

>> make help
Typical usage is:
  > make                        # build all programs
  > make clean                  # remove all compiled items
  > make zip                    # create a zip file for submission
  > make prob1                  # built targets associated with problem 1
  > make test                   # run all tests
  > make test-prob2             # run test for problem 2
  > make test-prob2 testnum=5   # run problem 2 test #5 only

>> make prob2                   # build problem 2 demo program
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_funcs.c

> make clean                    # remove all programs/binary object files
rm -f banlet_main banlet_demo test_banlet_funcs  *.o

>> make prob3                   # build problem 3 main program
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_main.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_funcs.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_font_standard.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o banlet_main banlet_main.o banlet_funcs.o banlet_font_standard.o

>> make clean                   # remove all programs/binary object files
rm -f banlet_main banlet_demo test_banlet_funcs  *.o

>> make                         # build all programs/objects for the assignment
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_main.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_funcs.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_font_standard.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o banlet_main banlet_main.o banlet_funcs.o banlet_font_standard.o
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o banlet_demo banlet_demo.c banlet_font_standard.o
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o test_banlet_funcs test_banlet_funcs.c banlet_funcs.o banlet_font_standard.o

>> make test                    # run tests for problem 1, compiles required code first
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_funcs.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_font_standard.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o test_banlet_funcs test_banlet_funcs.c banlet_funcs.o banlet_font_standard.o
./testy test_banlet1.org 
============================================================
== test_banlet1.org : Problem 1 String / Printing Functions in banlet_funcs.c
== Running 15 / 15 tests
1)  string_replace_char_1          : ok
2)  string_replace_char_2          : ok
3)  string_replace_char_3          : ok
4)  string_replace_char_4          : ok
5)  count_linebreaks_1             : ok
6)  count_linebreaks_2             : ok
7)  count_linebreaks_3             : ok
8)  find_linebreaks_1              : ok
9)  find_linebreaks_2              : ok
10) find_linebreaks_3              : ok
11) find_linebreaks_4              : ok
12) print_fontified_oneline_1      : ok
13) print_fontified_oneline_2      : ok
14) print_fontified_oneline_3      : ok
15) print_fontified_oneline_length : ok
============================================================
RESULTS: 15 / 15 tests passed

>> make test-prob3              # run tests for problem 2
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -c banlet_main.c
gcc -Wall -Wno-comment -Werror -g -Wno-unused-variable -o banlet_main banlet_main.o banlet_funcs.o banlet_font_standard.o
./testy test_banlet3.org 
============================================================
== test_banlet3.org : Problem 3 slurp_file() and banlet_main tests
== Running 15 / 15 tests
1)  banlet_main Hello World                         : ok
2)  banlet_main multiline                           : ok
...

>> make test                    # run tests for all problems
...

>> make test-prob2 testnum=5

>> ./banlet_main 'Hi there!'                                                # print a simple "fontified" message"
._. ._.    ._.   _                       ._.
| | | |(`)  | |_.| |__    ___ ._ __.  ___ | |
| |_| ||'|  | __|| '_ \  /'_`\| `__| /'_`\| |
|  _  || |  | |_ | | | ||  __/| |   |  __/|_|
|_| |_||_|   \__||_| |_| \___||_|    \___|(_)

>> ./banlet_main $'How do\nyou do?' --fontfile data/font_banner.txt         # print a multiline message in a different font
#     #                                
#     #  ####  #    #    #####   ####  
#     # #    # #    #    #    # #    # 
####### #    # #    #    #    # #    # 
#     # #    # # ## #    #    # #    # 
#     # #    # ##  ##    #    # #    # 
#     #  ####  #    #    #####   ####  
                                       
                                      #####  
#   #  ####  #    #    #####   ####  #     # 
 # #  #    # #    #    #    # #    #       # 
  #   #    # #    #    #    # #    #    ###  
  #   #    # #    #    #    # #    #    #    
  #   #    # #    #    #    # #    #         
  #    ####   ####     #####   ####     #    


>> cat data/asimov.txt                                                      # show contents of a text file
I do not fear computers. I fear the lack of them. -Asimov

>> banlet_main --fontfile data/font_mini.txt --textfile data/asimov.txt     # print file as banner text using a different font
___                       _                                       ___    _                                    _                                      
 |    _|     ._    _|_  _|_ _  _.._   _   ._ _ ._    _|_ _ ._ _    |   _|_ _  _.._  _|_|_  _   | _. _|      _|_  _|_|_  _ ._ _    __ /\  _o._ _      
_|_  (_|(_)  | |(_) |_   | (/_(_||   (_(_)| | ||_)|_| |_(/_| _>o  _|_   | (/_(_||    |_| |(/_  |(_|(_|<  (_) |    |_| |(/_| | |o    /--\_>|| | |(_)\/

// banlet_funcs.c: support functions for the banlet_main program.

#include "banlet.h"

void glyph_init(glyph_t *glyph, int codepoint);
// PROVIDED: Initializes a glyph to mostly X's except for its
// codepoint on the first line.

void string_replace_char(char *str, char old, char new);
// PROBLEM 1: Replace instances of character 'old' with 'new' in the
// string 'str'.  May use the strlen() library function to determine
// string length or directly look for a '\0' null termination
// character to end the string.
// 
// EXAMPLES:
// char s1[]="A A B B A"; string_replace_char(s1, 'A', 'X'); // s1 is "X X B B X"
// char s2[]="A A B B A"; string_replace_char(s2, 'B', 'Y'); // s2 is "A A Y Y A"
// char s3[]="A A B B A"; string_replace_char(s3, ' ', '-'); // s3 is "A-A-B-B-A"

int count_linebreaks(char *msg);
// PROBLEM 1: Counts the number of newline characters '\n' in the
// string 'msg'; return this number +1 as the end of lines will always
// be a line break. May use the strlen() library function to determine
// string length or directly look for a '\0' null termination
// character to end the string.
// 
// EXAMPLES:
// count_linebreaks("Hi")        ->  1
// count_linebreaks("Hi There")  ->  1
// count_linebreaks("Hi\nThere") ->  2
// count_linebreaks("O\nM\nG")   ->  3

int *find_linebreaks(char *msg, int *nbreaks);
// PROBLEM 1: Counts the linebreaks (newline '\n' chars and end of
// string) and returns an array of integers with the position for each
// linebreak in string 'msg'.  Uses the count_linebreaks()
// function. The 'nbreaks' parameter is an OUTPUT integer that should
// be set to the number of breaks in 'msg' using the C dereference
// operator (*).
//
// EXAMPLES:
// int nbreaks = -1;
// int *breaks = find_linebreaks("Hello\nWorld", &nbreaks);
// //            index in string: 012345 67890
// // nbreaks is now 2
// // breask is now [5, 11]

void print_fontified_oneline(char *msg, font_t *font, int length);
// PROBLEM 1: Prints string 'msg' using 'font'. Only prints characters
// 0 to 'length-1'.  Iterates over each row in font->height and then
// scans across the charactes in 'msg' printing each "row" of the
// character. On reaching index 'length', prints a newline and then
// scans across 'msg' again printing characters from the next row.
// Each msg[i] character is used to as the index into fonts->glyphs[]
// to access the "glyph" that will be printed.
//
// NOTE: This function does NOT handle embedded newline '\n'
// characters. It is intended to be called repeatedly on each line in
// multiline text with '\n' characters found using the
// 'find_linebreaks()' function.
//
// EXAMPLE:
//
// print_fontified_oneline("Hello!", &font_standard, 6);
// // Prints the following on standard output:
// ._. ._.      ,-,,-,       ._.
// | | | |  ___ | || |  ___  | |
// | |_| | /'_`\| || | / _ \ | |
// |  _  ||  __/| || || (_) ||_|
// |_| |_| \___||_||_| \___/ (_)

void print_fontified(char *msg, font_t *font);
// PROBLEM 1: Uses print_fontified_oneline() with find_linebreaks() to
// correctly print 'msg' with 'font' even if there are linebreaks in
// 'msg'.  Uses find_linebreaks() to find the end of each line in
// 'msg' and then iterates over lines printing each.  Uses pointer
// arithmetic to pass the starting position of each line into calls of
// print_fontified_oneline(). Frees memory allocated (such as through
// use of count_linebreaks()) before returning.
//
// EXAMPLE:
//   print_fontified("apple\nB@N@N@\nCarr0^", &font_standard);
// Shows the following on standard output:
//                      ,-,      
//   __ _ ,_ __. ,_ __. | |  ___ 
//  / _` || '_ \ | '_ \ | | /'_`\
// | (_| || |_) || |_) || ||  __/
//  \__,_|| .__/ | .__/ |_| \___|
//        |_|    |_|             
// ,____    ____  ._  ._.   ____  ._  ._.   ____  
// | == )  / __ \ | \ | |  / __ \ | \ | |  / __ \ 
// |  _ \ / / _` ||  \| | / / _` ||  \| | / / _` |
// | |_)|| | (_| || |\  || | (_| || |\  || | (_| |
// |____/ \ \__,.||_| \_| \ \__,.||_| \_| \ \__,.|
//         \____/          \____/          \____/ 
//   ____.                     ___   /\ 
//  / ___|  __ _ ._ __.._ __. / _ \ |/\|
// | |     / _` || `__|| `__|| | | |    
// | |___.| (_| || |   | |   | |_| |    
//  \____| \__,_||_|   |_|    \___/     

font_t *font_load(char *filename);
// PROBLEM 2: Loads a banner font from 'filename'.  The format of font
// files is documented more thoroughly in the project specification
// but is generally comprised of a first line that indicate the height
// of each glyph in the font followed by a sequence of each glyph
// starting with its codepoint (ASCII index) and a grid of characters
// in it. To make parsing easier, the ? character is used to represent
// blank spaces in glyph shapes.
//
// EXAMPLE:
// height: 4
// 42
// ???
// \|/
// /|\
// ???
// 43
// ???
// _|_
// ?|?
// ???
//
// The two characters above are the codepoint 42 '*' and codepoint 43
// '+' with the ? symbols eventually being replaced by spaces during
// loading.
//
// If 'filename' cannot be opened for reading, returns NULL.
//
// Memory allocation happens in two steps: (1) allocates memory for a
// font_t struct then (2) allocates memory for an array of glyph_t
// structs of length NUM_ASCII_GLYPHS (a constant defined in
// banlet.h). Sets the font->glyphs field to be the allocated array of
// glyphs.  Reads the font->height field from teh first line of the
// file.  Iterates over each element of the glyphs array and calls the
// glyph_init() function on it to populate it with default data.  Then
// proceeds to read glyphs from the file. Glyphs are read by reading
// the integer codepoint first which determins which element of the
// glyph array to read into.  Then a loop over the height of the font
// is used to read each row of the glyph into the
// glyph[codepoint]->data[row]; fscanf() with '%s' specifier is used
// for this.  Finally, the string_replace_char() function is used to
// replace all '?' characters with ' ' (space) characters in the glyph
// data. Sets the width of each glyph using the strlen() function on
// any balid row of the glyph data. The width of each glyph is set
// based on the length of one of its 0th row and the .is_set field is
// changed to 1 to indicate the glyph is present.
//
// Glyphs are read from 'filename' until an attempt to read a glyph's
// codepoint with fscanf() returns EOF (end of file). This causes the
// routine to return the allocated font_t data for use elsewhere.

void font_free(font_t *font);
// PROBLEM 2: Frees the memory associated with 'font'.  First frees
// the glyph array, then frees the font itself. Hint: this funciton
// should be 2 lines long.

char *slurp_file_two_pass(char *filename);
// PROBLEM 2: Read all characters from the file 'filename' into a
// dynamcally allocated array. Terminates the array with the '\0'
// character to form a valid C string and return that string. If the
// file cannot be opened, return NULL. 
// 
// Uses a "2-Pass" solution. Counts the characters in file via calls
// to fscanf() or fgetc(), then returns to beginning of the file with
// rewind(), allocates an appropriately sized block of memory, then
// reads all characters into it in a second pass.
// 
// CONSTRAINT: Does not use any functions that determine the size of a
// file a priori such as fstat() or fseek() or their kin.

char *slurp_file_one_pass(char *filename);
// OPTIONAL MAKEUP CREDIT: Like surp_file_two_pass() but uses a single
// I/O pass and dynamically expands memory to handle larger
// inputs. For full makeup credit, this approach must abide by the
// following additional conditions:
// - Does not use functions that determine the size of the file
// - Does not allocate/copy memory each loop iteration, only
//   "occasionally"
// - Does not use the realloc() function, only malloc()/free()
// - Has amortized linear time and linear space; the allocated array may
//   not be any larger than 2x the number of characters in it
// - Uses a memory allocation scheme similar to thos used with
//   dynamic arrays to meet the above requirement; see
//   https://en.wikipedia.org/wiki/Dynamic_array
// - Include comments describing your makeup credit approach
// - Is used in the main() function and/or elsewhere in place of the
//   other version

>> make test-prob1
./testy test_banlet_funcs.org 
============================================================
== test_banlet_funcs.org : Problem 1 First 5 Functions in banlet_funcs.c
== Running 15 / 15 tests
1)  string_replace_char_1     : FAIL -> results in file 'test-results/prob1-01-result.md'
2)  string_replace_char_2     : FAIL -> results in file 'test-results/prob1-02-result.md'
3)  string_replace_char_3     : FAIL -> results in file 'test-results/prob1-03-result.md'
4)  string_replace_char_4     : FAIL -> results in file 'test-results/prob1-04-result.md'
...
15) print_fontified_oneline_4 : FAIL -> results in file 'test-results/prob1-15-result.md'
============================================================
RESULTS: 0 / 15 tests passed

>> cat test-results/prob1-01-result.md
(TEST 1) string_replace_char_1 : FAIL
=====================================

COMMENTS
--------


PROGRAM: ./test_banlet_funcs string_replace_char_1
--------------------------------------------------
To run this individual test in GDB use the command:
  gdb --args ./test_banlet_funcs string_replace_char_1
but any input to the program must be typed within the debugger

FAILURE MESSAGES
----------------
- Output Differenes: Expected/Actual do not match, check Diff Sections for details

SIDE-BY-SIDE DIFF of Expected vs Actual
---------------------------------------
. lines match; | lines differ; < expected line missing; > extra line in actual

```sdiff
===EXPECT===                                    ===ACTUAL===
IF_TEST("string_replace_char_1") {            . IF_TEST("string_replace_char_1") { 
    // Tests replacing characters in a string .     // Tests replacing characters in a string
    char string[]="A A B B A";                .     char string[]="A A B B A";
    string_replace_char(string, 'A', 'X');    .     string_replace_char(string, 'A', 'X');
    printf("result: '%s'\n", string);         .     printf("result: '%s'\n", string);
}                                             . }
---OUTPUT---                                  . ---OUTPUT---
result: 'X X B B X'                           | result: 'A A B B A'

```

LINE-BY-LINE DIFF of Expected vs Actual
---------------------------------------
```
EXPECT   8) result: 'X X B B X'
ACTUAL   8) result: 'A A B B A'

```

VALGRIND REPORT
---------------
The program is run on under valgrind as
  stdbuf -i 0 -o 0 -e 0 valgrind --error-exitcode=13 --leak-check=full --show-leak-kinds=all --track-origins=yes ./test_banlet_funcs string_replace_char_1
which may be pasted onto a command line to run it.

```
==340236== Memcheck, a memory error detector
==340236== Copyright (C) 2002-2024, and GNU GPL'd, by Julian Seward et al.
==340236== Using Valgrind-3.25.1 and LibVEX; rerun with -h for copyright info
==340236== Command: ./test_banlet_funcs string_replace_char_1
==340236== 
==340236== 
==340236== HEAP SUMMARY:
==340236==     in use at exit: 0 bytes in 0 blocks
==340236==   total heap usage: 0 allocs, 0 frees, 0 bytes allocated
==340236== 
==340236== All heap blocks were freed -- no leaks are possible
==340236== 
==340236== For lists of detected and suppressed errors, rerun with: -s
==340236== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
```

SUMMARY
-------
Test FAILED for the following reasons
- Output Differenes: Expected/Actual do not match, check Diff Sections for details

void string_replace_char(char *str, char old, char new)

void print_fontified(char *msg, font_t *font);
// PROBLEM 2: Uses print_fontified_oneline() with find_linebreaks() to
// correctly print 'msg' with 'font' even if there are linebreaks in
// 'msg'.  Uses find_linebreaks() to find the end of each line in
// 'msg' and then iterates over lines printing each.  Uses pointer
// arithmetic to pass the starting position of each line into calls of
// print_fontified(). Frees memory allocated (such as through use of
// count_linebreaks()) before returning.
//
// EXAMPLE:
//   print_fontified("apple\nB@N@N@\nCarr0^", &font_standard);
// Shows the following on standard output:
//                      ,-,      
//   __ _ ,_ __. ,_ __. | |  ___ 
//  / _` || '_ \ | '_ \ | | /'_`\
// | (_| || |_) || |_) || ||  __/
//  \__,_|| .__/ | .__/ |_| \___|
//        |_|    |_|             
// ,____    ____  ._  ._.   ____  ._  ._.   ____  
// | == )  / __ \ | \ | |  / __ \ | \ | |  / __ \ 
// |  _ \ / / _` ||  \| | / / _` ||  \| | / / _` |
// | |_)|| | (_| || |\  || | (_| || |\  || | (_| |
// |____/ \ \__,.||_| \_| \ \__,.||_| \_| \ \__,.|
//         \____/          \____/          \____/ 
//   ____.                     ___   /\ 
//  / ___|  __ _ ._ __.._ __. / _ \ |/\|
// | |     / _` || `__|| `__|| | | |    
// | |___.| (_| || |   | |   | |_| |    
//  \____| \__,_||_|   |_|    \___/     

>> ./banlet_main $'Nice\nWork!'
._  ._.               
| \ | |(`)  ___.  ___ 
|  \| ||'| / __| /'_`\
| |\  || || (__ |  __/
|_| \_||_| \___| \___|
                      
_.        ._             ,_,   ._.
\ \      / /  ___  ._ __.| | __| |
 \ \ /\ / /  / _ \ | `__|| |/ /| |
  \ V  V /  | (_) || |   |   < |_|
   \_/\_/    \___/ |_|   |_|\_\(_)
                                  

font_t *font_load(char *filename);

char *slurp_file_two_pass(char *filename);
// PROBLEM 2: Read all characters from the file 'filename' into a
// dynamcally allocated array. Terminates the array with the '\0'
// character to form a valid C string and return that string. If the
// file cannot be opened, return NULL. 
// 
// Uses a "2-Pass" solution. Counts the characters in file via calls
// to fscanf() or fgetc(), then returns to beginning of the file with
// rewind(), allocates an appropriately sized block of memory, then
// reads all characters into it in a second pass.
// 
// CONSTRAINT: Does not use any functions that determine the size of a
// file a priori such as fstat() or fseek() or their kin.

int main(int argc, char *argv[])
//           ^^^         ^^^^
//       how many  array of strings

>> banlet_main 'Hello!'
>> banlet_main 'Hello!' --fontfile font.txt
>> banlet_main --fontfile font.txt 'Hello!' 
>> banlet_main --textfile text.txt
>> banlet_main --textfile text.txt --fontfile font.txt
>> banlet_main --fontfile font.txt --textfile text.txt

fun main(argc, argv[]):
  
  text = NULL
  font = default_font
  text_from_file = false
  
  for i=1 to argc-1:
    if argv[i] is "--fontfile":
      load argv[i+1] as a font
      error and exit if the font can't be loaded
      set font to the loaded font
      i = i+1

    else if argv[i] is "--textfile":
      load argv[i+1] as a string
      error and exit if the string can't be loaded
      set text to be the loaded string
      i = i+1

    else:
      set text to be argv[i]
  done

  check that the text is not NULL, error out if so
  display the text using font
  free any memory that was allocated
done

>> ./banlet_main ':-)'  
          __  
 _        \ \ 
(_)._____. | |
 _ |_____| | |
(_)        | |
          /_/ 
>> ./banlet_main --fontfile data/font_banner.txt  $'Great\nSuccess'  
 #####                             
#     # #####  ######   ##   ##### 
#       #    # #       #  #    #   
#  #### #    # #####  #    #   #   
#     # #####  #      ######   #   
#     # #   #  #      #    #   #   
 #####  #    # ###### #    #   #   
                                   
 #####                                            
#     # #    #  ####   ####  ######  ####   ####  
#       #    # #    # #    # #      #      #      
 #####  #    # #      #      #####   ####   ####  
      # #    # #      #      #           #      # 
#     # #    # #    # #    # #      #    # #    # 
 #####   ####   ####   ####  ######  ####   ####  
                                                  
>> ./banlet_main --textfile data/testing.txt --fontfile data/font_mini.txt
___                                                                                       
 |  _  __|_o._  _    _ _.._      ._ |    ._ ._      _   _|_|_  _   ._ ._ _  _ _ ._  _ _   
 | (/__> |_|| |(_|  (_(_|| |  (_)| ||\/  |_)| (_)\/(/_   |_| |(/_  |_)| (/__>(/_| |(_(/_  
                _|                   /   |                         |                      
     _                                                               
   _|_  |_     _  _   ._    _|_  _|_|_  _ o._   _.|_  _ _ ._  _ _    
(_) |   |_)|_|(_|_>o  | |(_) |_   |_| |(/_||   (_||_)_>(/_| |(_(/_o  
               _|  /                                                 
     _                _                
__  |_ _| _ _  _ ._  | \o o|  __|_._ _.
    |_(_|_>(_|(/_|   |_/| ||<_> |_| (_|
            _|           _|            

>> ./banlet_main --textfile data/testing.txt --fontfile data/font_alternate.txt
 _____             _    _                                                      _                                              _    _                                                                
|_   _|  ___  ___ | |_ (_) _ __    __ _     ___   __ _  _ __      ___   _ __  | | _   _    _ __   _ __   ___  __   __  ___   | |_ | |__    ___    _ __   _ __   ___  ___   ___  _ __    ___   ___   
  | |   / _ \/ __|| __|| || '_ \  / _` |   / __| / _` || '_ \    / _ \ | '_ \ | || | | |  | '_ \ | '__| / _ \ \ \ / / / _ \  | __|| '_ \  / _ \  | '_ \ | '__| / _ \/ __| / _ \| '_ \  / __| / _ \  
  | |  |  __/\__ \| |_ | || | | || (_| |  | (__ | (_| || | | |  | (_) || | | || || |_| |  | |_) || |   | (_) | \ V / |  __/  | |_ | | | ||  __/  | |_) || |   |  __/\__ \|  __/| | | || (__ |  __/  
  |_|   \___||___/ \__||_||_| |_| \__, |   \___| \__,_||_| |_|   \___/ |_| |_||_| \__, |  | .__/ |_|    \___/   \_/   \___|   \__||_| |_| \___|  | .__/ |_|    \___||___/ \___||_| |_| \___| \___|  
                                  |___/                                           |___/   |_|                                                    |_|                                                
         __    _                                            _      _    _            _                 _                                        
  ___   / _|  | |__   _   _   __ _  ___       _ __    ___  | |_   | |_ | |__    ___ (_) _ __     __ _ | |__   ___   ___  _ __    ___   ___      
 / _ \ | |_   | '_ \ | | | | / _` |/ __|     | '_ \  / _ \ | __|  | __|| '_ \  / _ \| || '__|   / _` || '_ \ / __| / _ \| '_ \  / __| / _ \     
| (_) ||  _|  | |_) || |_| || (_| |\__ \ _   | | | || (_) || |_   | |_ | | | ||  __/| || |     | (_| || |_) |\__ \|  __/| | | || (__ |  __/ _   
 \___/ |_|    |_.__/  \__,_| \__, ||___/( )  |_| |_| \___/  \__|   \__||_| |_| \___||_||_|      \__,_||_.__/ |___/ \___||_| |_| \___| \___|(_)  
                             |___/      |/                                                                                                      
         ._____.     _                           .____   _    _  _          _                
         | ____|  __| | ___   __ _   ___  _ __   |  _ \ (_)  (_)| | __ ___ | |_  _ __   __ _ 
 _____   | +== / _` |/ __| / _` | / _ \| '__|  | | | || |  | || |/ // __|| __|| '__| / _` |
|_____|  | |___ | (_| |\__ \| (_| ||  __/| |     | |_| || |  | ||   < \__ \| |_ | |   | (_| |
         |_____| \__,_||___/ \__, | \___||_|     |____/ |_| _/ ||_|\_\|___/ \__||_|    \__,_|
                             |___/                         |__/                              

                           _________________

                            WORK DISCLOSURE
                           _________________


(A) HUMAN COLLABORATORS
=======================

  Aside from the person submitting this assignment, the following people
  contributed ideas and discussion to the completion of this work
  INCLUDING course staff members. Write NONE if no collaborators were
  involved.
  - Person 1 <person1@email.com> helped understand Problem X and the
    meaning of...
  - Person 2 <person2@email.com> helped debug Code for Problem Y...
  - etc.


(B) RESOURCE UTILIZATION
========================

  The following resources such as websites, course notes, artificial
  intelligence tools (LLMs/ChatBots/etc.) were utilized in the
  completion of this work. Include course materials such as textbooks
  and lecture slides as well. (Write NONE if no resources were used
  [which would be hard to believe]).
  - Resource 1 is here <https://some.resource.org/useful_stuff.html> and
    provided help for Problem Z to understand...
  - Resource 2 is the book "C Code for Dummies" by Boo Kauthor with
    chapter 8 helping a lot with the malloc()/free() usage on Problem W
  - Resource 3 is here <https://airegurgitator.com> and provided AI
    refinements for the algorithm used on problem Q and also helped
    debug code for Problem N.
  - etc.


(C) ADHERENCE TO THE PRIME DIRECTIVE
====================================

  PRIME DIRECTIVE: Be able to explain your own work including assignment
  answers, program code, and exam solutions. The work you submit should
  be the product of your own effort and reflect your personal
  understanding. (See the course syllabus for more information.)

  I submit this work in accordance with the PRIME DIRECTIVE. I affirm
  that I can explain the code and answers within as I created them and
  they reflect my personal understanding.

  Signed,

  <REPLACE WITH SUBMITTER NAME>