skdamico / dars Goto Github PK

************************************************************
***  DOCUMENTATION FOR CS4500 (Version 3) Assignment 6.1 *** 
************************************************************

****************************************
***    TEAM CONTACT INFORMATION      ***
****************************************

Allen Chen          - [email protected] 
Stefano D'Amico     - [email protected]
Dung Nguyen         - [email protected]
Rhistina Revilla    - [email protected]

Please feel free to contact any of the above email address(es). 

****************************************
***     FILES IN THIS DIRECTORY     ***
****************************************

This directory contains the following files and subdirectories:

    README                  - this file
    main.py                 - generates valid test expressions on input ADT
                              using the generated lexer and parser objects
    darslex.py              - contains the lexer. Essentially the list of
                              tokens and token definitions
    cs4500                  - high level script that calls main.py
                              followed by input and output arguments
    lex.py                  - Python module for PLY lexer
    yacc.py                 - Python module for PLY parser 

****************************************
***          ACKNOWLEDGEMENTS       ***
****************************************

Thank you to David M. Beazley (Dabeaz LLC), creator of PLY parser generator 
for Python. 

    PLY (Python Lex-Yacc)                   Version 3.4
    Copyright (C) 2001-2011,
    David M. Beazley (Dabeaz LLC)
    All rights reserved.

For more documentation on this parser generator:
    
    http://www.dabeaz.com/ply/ply.html

****************************************
***           REQUIREMENTS           ***
****************************************

CS4500 Version 3 (Assignment 6)  requires the use a CCIS Linux machine 
and Python 2.6+

****************************************
***            HOW TO USE            ***
****************************************

In order to run the program on a CCIS Linux machine, please use this format:

FORMAT
    ./cs4500 <input_file> <output_file>
EXAMPLE
    ./cs4500 ~/test_inputs/StackInt.txt ~/test_outputs/output.txt


****************************************
***     IMPORTANT NOTES TO GRADER    ***
***        BUGS AND PROBLEMS         ***
****************************************

This is the first submission of CS4500 Version 3 (for assignment 6)
The following problems exist and will be addressed in the next
assignment: 

    - Identifier evaluates to string rather than Scheme expressions
        This is due to ambigious grammar definitions. Will be addressed
        in future assignments.
    - Rewriting system is not robust


****************************************
***   CHANGE LOG FOR THIS VERSION    ***
****************************************

The following changes have taken place for this version of CS4500:

    - Added rewriting system for generating equations
    - Output reducible equations and their value (which is int for this assignment)
    - Basic equation validation