]> ruin.nu Git - proglang.git/blobdiff - documentation
updating documentation
[proglang.git] / documentation
index 2d64044dfa366fbddc9bf43e007d8845df8e48ea..f46afb702549b5b0a7a530b699a49ea20fb2c5d1 100644 (file)
 ####### 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]
-
-T+ e1 Eq e2:bool  <=  T+ e1:t  &  T+ e2:t
-
-If e1 and e2 are of the same type, then Eq or NEq return bool
-
-
-[Plus, Minus, Times, Div]
-
-T+ e1 Plus e2:int  <=  T+ e1:int  &  T+ e2:int
-
-The operators Plus/Minus/Times/Div return int if both operands are ints
-
-
-[Lt, ELt, Gt, EGt]
-
-T+ e1 Lt e2:bool  <=  T+ e1:int  &  T+ e2:int
-
-The operators Lt/ELt/Gt/EGt return bool if both operands are ints
-
-
-[Assignment]
-
-T+ i := e:t  <=  i:t E T  &  T+ e:t
-
-The assignemnt of e to i returns type t if both i and e have type t.
-
-
-[ENeg]
-
-T+ ENeg e:int  <=  T+ e:int
+./CompInt [-c] [file]
 
-ENeg e returns int if e is of type int
+-c : Compile [file], interprets if it isn't specified
 
-[ENot]
+if no arguments are specified then the file is interpreted
 
-T+ ENot e:bool  <=  e:bool
-
-ENot e returns bool if e is of type bool
-
-[EVar]
-
-T+ i:t <= i:t E T
-
-i has type t if i is defined in the context with type t.
-
-[EInt]
-
-T+ n:int
-
-n has type int
-
-[EBool]
-
-T+ b:bool
-
-b has type bool
-
-[EReadI]
-
-T+ n:int
-
-EReadI returns an int
-
-[EReadB]
-
-T+ b:bool
-
-EReadB returns a bool
-
-[EPost]
-
-T+ EPost i:int <= i:int E T
-
-EPost i is of type int if i is defined in T with type int.
-
-[SExp]
-
-T+ e   <=  T+ e:t
-
-[SBlock]
-
-T+ s;SBlock ss <= T+ s => T' , T'+ ss => T''
+Files:
+Interpret.hs: Handles the interpretation of a program
 
-the first statment s, in the block, is typechecked in the context T and returns the context T', the rest of the block is then recursively typeckecked in the context T' 
+Compile.hs: Compiles the program into a c program
 
+Typechecker.hs: Simple modification of the bnfc-generated Testsyntax which calls the type-checking functions.
 
-[SIf]
+Typecheck.hs: Contains the type-checking functions typeCheckExp, typeCheckVar and typeCheckStm and some utility functions, responsible for the entire type-checking process.
 
-T+ if e then s1 else s2  <=  T+ e:bool  &  T+ s1  &  T+ s2
+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.
 
-if e is of type bool and s1 and and s2 typechecks in the context T, then the same context is returned
 
+Additions which comes from the extension:
 
-[SWhile]
+typing rules
+++++++++++++
 
-T+ while e do s  <=  T+ e:bool  &  T+ s
+[EFunc]
 
-If e is of type bool and s typechecks in context T then the same context is returned
+(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 
 
+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
 
-[SDecl]
+[SReturn]
 
-T+ t i = e => T,i:t  <=  i!ET  &  e:t 
+T+ return e <= e:t & ret(t) in T
 
-if i and e are of the same type and i is not declared in the current scope then i is added with type t to the context.
+return typechecks if e returns the same type as the current context
 
-[SDeclD]
+[Func]
 
-T+ t i => T,i:t  <=  i!ET
+T+ t i (ds) ss <= T,novariables,ret(t),ds => T' & T'+ss & last(ss) => return:t
 
-if i is not declared in the current scope, then i is added to the context with type 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
 
-[SNoop]
+semantic rules
+++++++++++++
 
-T+ s
 
-SNoops does nothing so the same context is returned
+(v is used for values, e for expressions, s for statements, c is the context)
 
-[SPrint]
 
-T+ e <= T+ e:t
 
-if e has type t then SPrint returns the same context