updating documentation

[proglang.git] / documentation

diff --git a/documentation b/documentation
index 269e93139c744f83508a076206088f76e7634b81..f46afb702549b5b0a7a530b699a49ea20fb2c5d1 100644 (file)
--- a/documentation
+++ b/documentation
@@ -1,86 +1,55 @@
 ####### DOCUMENTATIATOIAITAT ION ########
 
+Usage:
 
-Files:
-Typechecker.hs: Simple modification of the bnfc-generated Testsyntax which calls the type-checking functions.
-
-Typecheck.hs: Contains the type-checking functions typeCheckExp, typeCheckVar and typeCheckStm and some utility functions, responsible for the entire type-checking process.
-
-Abssyntax.hs, Parsyntax.y, Lexsyntax.x,ErrM.hs,Printsyntax.hs,Skelsyntax.hs: The files generated by bnfc, only modification is the removal of the Bool type in Abssyntx.hs so haskell's internal type can be used.
-
-
-typing rules
-++++++++++++
-
-
-(t is little tau, T is large tau, E is 'in', and + is that other symbol)
-
-
-
-[Eq, Neq]
-
-e:bool  <=  e1:t  &  e2:t
-where e is e1 Eq e2.
-
-
-[Plus, Minus, Times, Div]
+./CompInt [-c] [file]
 
-e:int  <=  e1:int  &  e2:int
-where e is e1 Plus e2.
+-c : Compile [file], interprets if it isn't specified
 
+if no arguments are specified then the file is interpreted
 
-[Lt, ELt, Gt, EGt]
-
-e:bool  <=  e1:int  &  e2:int
-where e is e1 Lt e2.
-
-
-[Assignment]
-
-T+ i := e:t  <=  i:t E T  &  T+ e:t
-where the assignment is identifier i = expression e.
-
-
-[ExpT]
-
-u,e:t  <=  e:t  &  u:t
-where the expression is type u expression e.
-
-
-[ENeg]
-
-e:int  <=  e:int
+Files:
+Interpret.hs: Handles the interpretation of a program
 
+Compile.hs: Compiles the program into a c program
 
-[ENot]
+Typechecker.hs: Simple modification of the bnfc-generated Testsyntax which calls the type-checking functions.
 
-e:bool  <=  e:bool
+Typecheck.hs: Contains the type-checking functions typeCheckExp, typeCheckVar and typeCheckStm and some utility functions, responsible for the entire type-checking process.
 
+Abssyntax.hs, Parsyntax.y, Lexsyntax.x,ErrM.hs,Printsyntax.hs,Skelsyntax.hs: The files generated by bnfc, only modification is the removal of the Bool type in Abssyntx.hs so haskell's internal type can be used.
 
-[SExp, SBlock]
 
-S:NoType  <=  e:t
+Additions which comes from the extension:
 
+typing rules
+++++++++++++
 
-[SIf]
+[EFunc]
 
-T+ if e then s1 else s2  <=  T+ e:bool  &  T+ s1  &  T+ s2
+(t is used for types, T is the context, and + is used for in)
 
+T+ i (es) : t <= i(ts):t in T & T+ es:ts 
 
-[SWhile]
+The functioncall of i returns t if i is in the context with returntype t and the types of the argument expressions matches those in the parameter list
 
-T+ while e do s  <=  T+ e:bool  &  T+ s
+[SReturn]
 
+T+ return e <= e:t & ret(t) in T
 
-[SDecl]
+return typechecks if e returns the same type as the current context
 
-T+ i:t => T', i:t  <=  i!ET  &  e:t  &  u:t
+[Func]
 
-(Type u Ident i = Exp e)
+T+ t i (ds) ss <= T,novariables,ret(t),ds => T' & T'+ss & last(ss) => return:t
 
+the function i typechecks if the body typechecks in the context where all other variables has been removed and the return type and paramters has been added and that the last statement is a return with the right type
 
+semantic rules
+++++++++++++
 
 
+(v is used for values, e for expressions, s for statements, c is the context)