This project is designed to serve as an introduction to the C
language. To complete it, you will have to use the C file
input/output library, do memory allocation, manipulate strings, and
coerce strings to
void pointers and vice versa. Although there is
conceptually a lot to learn to complete this project, the actual code
you need to write is short. For reference, the “official” solution
only adds 100 lines including comments.
philspel is a very simple and silly spelling checker. It
accepts a single command line argument, the name of a dictionary to
use. For example, to use philspel, all you would need to type into the terminal is:
$ ./philspel dictionary.txt
Of course, you can replace
dictionary.txt with whichever file you wish to use for your dictionary.
This dictionary consists of a list of valid words to use in
checking the input.
philspel processes standard input and
copies it to standard output. For each word (sequence of letters
unbroken by any non-letter character) in the input,
philspel looks for all of the following variations of the word in its dictionary:
If any of the three variations are found in the dictionary, the word is copied directly to
standard output. Otherwise, the word is copied to standard output,
with the string
" [sic]" (without the quotation marks
but with the spaces appended. All other input (e.g. whitespace) is copied to standard
git clone https://github.com/61c-student/sp20-proj1-<Your User Name>.git
cd sp20-proj1-<Your User Name>
This copies over a Makefile for the project and
several code files.
hashtable.h are the
code and header files which define a simple generic hashtable. The
hashtable.h file defines a interface through which other files interact with our
hashtable implementation. You will need to implement the methods in
hashtable.c, which shouldn’t be too hard since the hash table is fixed size (i.e. we will not resize/rehash based on the load factor).
philspel.h defines the functions in
philspel.c. You will need
to implement 4 functions in
stringEquals(void *s1, void *s2)
Also included is a sample dictionary, input, and output. Your output
should EXACTLY match ours, since we will be using automated
scripts to grade your program. Another useful dictionary for testing
is contained in
depending on the system. You can type
make test in your
project 1 directory to compile and test your program against a sample
set of inputs. You can also safely output all sorts of debugging
stderr, as this will be ignored by our scripts
and by the test routine provided in the Makefile.
Furthermore, you can initially assume that both the dictionary and the input won’t contain words longer than 60 characters. This gets you majority of the credit. However, for full credit, you should ensure that your program fully works if you get words which are longer than 60 characters.
You can assume that the dictionary is well formatted if it exists, so individual words separated by newlines. You can NOT assume anything about what comes in on standard input except for the length of “words” for 80% credit.
Tip: consider running your program under valgrind to detect
any memory errors. For example, use
valgrind -q ./philspel ... to
have valgrind print out any invalid memory accesses it detects
during the run. In C, it’s easy to write a program that appears to
work correctly for simple tests but will fail or crash with larger
inputs. Valgrind catches many of these hidden bugs that might otherwise appear only in the autograder.
Please submit using Gradescope to Project 1, using the GitHub submission option to ensure your files are in the right place.
REMEMBER: the grading will be done almost entirely by automated
scripts. We will be only using your
hashtable.c files when grading!
Your output must exactly match the specified format, which
makes correctness the primary goal of this project. In submitting the
autograder will give you the result of a basic sanity test but
will not give you your complete grade. Rather you are responsible
for developing any tests you need to make sure you meet the
requirements of the project. We deliberately did not include a
more comprehensive test. We want you to write your own tests!
You are to do this work individually. It is OK to assist your classmates with their project, but don’t copy code, and don’t go searching for previous solutions!
This is typically due to you having a lot of print statements which will cause the autograder to hang or run out of memory when it is executing. If you run into this, please remove/comment out your print statements and resubmit. If you continue to have this issue after you have confirmed that you have done that AND you have confirmed that you pass the sanity test locally, please make a post on piazza with a link to your submission. If you do not include a link, we will not be able to easily find your submission!