KWIC Index Project

• KWIC = KeyWord In Context

• Example:

  Input:

  	The C Programming Language
  	The Cat in the Hat
  

  Output:

  	C Programming Language, The
  	Cat in the Hat, The
  	Hat, The Cat in the
  	Language, The C Programming
  	Programming Language, The C
  	The C Programming Language
  	The Cat in the Hat
  	in the Hat, the Cat
  	the Hat, the Cat in
  

Software Structure

• Input

  File: Input.c - reads initial data

• Output

  File: Output.c - writes the results

• LineStorage

  File: LineStorage.c - stores the input lines in a suitable data structure for later access

• ShiftSort

  File: ShiftSort.c - creates rotated versions of input lines and sorts them

• WordTable

  File: WordTable.c - reports whether a word appears in a table of 'noise' words

Directory Organization of Code

kwic_ex1 (The project directory):

File "main.c"

Directory Input

Directory Output

Directory LineStorage

Directory ShiftSort

Directory WordTable

Directory include

the '.h' files for all modules

Directory sysDoc

text documents describing coding standards for the project, program organization, list of all files ...

Testing Setup

• Each module can (and must) be tested independently.

• There is a Makefile in each module's directory that will perform an automatic test of the module.

Example:

In directory LineStorage, type the command:

		make runtest

If the output from driver contains error reports, you have done something wrong!

Simplified Software Structure