/*
 * Copyright (c) 2002 by Cliff Green. All rights reserved. Individual files
 * may be covered by other copyrights (as noted in the file itself).
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that this entire copyright notice is duplicated in all such
 * copies.
 *
 * This software is provided "as is" and without any expressed or implied
 * warranties, including, without limitation, the implied warranties of
 * merchantibility and fitness for any particular purpose.
*/
//----------------------------------------------------------------------
// Source file:   parse.h
// Written by:    Cliff Green, 2002
// Compiler:      Metrowerks CodeWarrior Pro 6, g++ 3.0.4
// History:
//   Modified:    Mar. 5, 2002
//   By:          Cliff Green
//   Comments:    Parsing function header file.
//----------------------------------------------------------------------
// This commentheader supports documentation tools such as Doc++ and
// Doxygen: http://www.doxygen.org/
//----------------------------------------------------------------------
/// Parsing function declaration.
/**
 *  Given a file name, the file is opened, each string token (word)
 *  is extraced, and a vector of Word objects returned. Note the
 *  typedef for the vector of Word objects.
 *
 *  Pre-condition for file name - parameter is a valid pointer to
 *  a nul-char terminated C string (array of characters).
 *
 *  Error conditions - if file cannot be opened, or if the file
 *  only contains non-alpha characters, an empty vector will be
 *  returned.
 *
 */

#ifndef PARSE_H
#define PARSE_H

#include "word.h"

WordVec parseFile (char const* fileName);

#endif // end of header file