updated docs, readme and cli

README.md

@@ -4,6 +4,17 @@ TZscript es un DSL para la creación de contratos inteligentes, tiene como objet
 
 Para saber como luce un contrato inteligente en TZscript,asi como las palabras claves de este lenguaje puede consultar la documentación en la carpeta doc del proyecto.
 
+## Lexing
+Para el lexer de este proyecto se utiliza la biblioteca `sly`
+## Parsing
+Para el parsing se desarrolló un parser SLR desde 0
+## Procesamiento del AST
+El AST generado por el parser es procesado utilizando el patrón Visitor.
+Entre las distintas operaciones que se realizan sobre el AST destacan:
+- Type Check (Realiza un checkeo de tipos sobre el AST)
+- Semantic Check (Realiza un checkeo de semántico sobre el AST)
+- Intermediate Representation (Genera una representación intermedia que se utiliza luego para generar Código Michelson)
+- Michelson Generator (A partir de la representación intermedia genera código Michelson)
 ## CLI:
 Se brinda una interfaz de consola para construir los ficheros `.tz` de michelson o para obtener una representacion de AST.
 

cli.py

@@ -14,27 +14,6 @@
 from visitors.michelson_generator_visitor import MichelsonGenerator
 import typer
 
-fibonacci = '''contract get_fib_n(n:int){
-        let last_fib_calculated: int = 0;
-        
-        entry get_fib(n: int){
-            let result: int = fib(n);
-            last_fib_calculated = result;
-        }
-
-        func fib(n: int) : int{
-            if (n <= 1) {
-                return n;
-            }
-            else {
-                let a: int = n - 1;
-                let b: int = n - 2;
-                return fib(a) + fib(b);
-            }
-        }
-        
-    }'''
-
 app = Typer()
 
 
@@ -181,23 +160,5 @@ def represent(file: str = Argument("", help="tzscript file to be parsed"),
     progress.update(1)
     print(f"\nGenerated {out_file}")
 
-
-@app.command()
-def build_run(file: str = Argument("", help="tzscript file to be parsed"),
-              out_file: str = Argument(None, help='michelson file to be generated and runned')):
-    """ generates the .tz michelson script from the tzscript file specified and executes it"""
-    build(file, out_file)
-    print("Executing file...")
-    # Run out_file
-    # TODO make the run script
-
-
-@app.command()
-def run(file: str = Argument(None, help='michelson file to be runned')):
-    print("Executing file...")
-    # Run out_file
-    # TODO make the run script
-
-
 if __name__ == "__main__":
     app()

docs/examples.md

@@ -1,6 +1,7 @@
 
 ## Contrato para guardar un valor positivo
-```
+
+```python
 contract store_value(admin: adress){
 
     var storage: nat = 0;
@@ -9,14 +10,26 @@ contract store_value(admin: adress){
         storage = new_value;
     } 
 
-    entry double_previous_value(){
-        storage = storage * 2;
-    }
 }
 ```
 
-## Contrato que calcula n-esimo termino de fibonacci
+## Contrato para sumar 2 numeros
+```python
+contract sum_2nums(n:int){
+    let x: int = 0;
+
+    entry sum(n:int){
+
+        let a: int = 2;
+        let b: int = 3;
+        x = a + b;
+    }
+
+}
 ```
+
+## Contrato que calcula n-esimo termino de fibonacci (no disponible su generación)
+```python
 contract get_fib_n(){
     let last_fib_calculated = 0;
 

docs/introduction.md

@@ -4,7 +4,7 @@
 ## Documentacion
 El núcleo de esta documentación es la Referencia del lenguaje organizada en cuatro partes (Declaraciones, Tipos, Instrucciones y Expresiones), sobre las que se encuentran artículos temáticos que explican los conceptos básicos del lenguaje y los detalles de su implementación.
 
-## Hello World
+## Variable modification
 ```
 contract store_value(value: int){
 

docs/reference.md

@@ -89,7 +89,11 @@ Se usa para representar cuando un valor puede ser de un tipo o None.
 optional[<type>]
 ```
 
+## Features Pendientes:
 
+Debido a restricciones de tiempo no se pudieron desarrollar satisfactoriamente los siguientes features:
 
-
-
+- Soporte a multiples `entry` en un mismo contract.
+- Soporte a `func`
+- Deploy en la blockchain de un contrato (actualmente se prueba en jupyter notebook con el kernel de michelson el codigo generado)
+- Soporte a Bucles `while`

test.tz

@@ -1,13 +1,13 @@
-parameter int %sum;
+parameter optional %sum;
 storage int;
 code {
 UNPAIR;
-PUSH int 2;
-PUSH int 3;
+PUSH nat 2;
+PUSH nat 3;
 DIG 1;
 DIG 1;
 ADD;
-DIG 0;
+DIG 1;
 DROP
 NIL operation;
 PAIR;

test.tzs

@@ -1,7 +1,9 @@
 contract sum_2nums(n:int){
+    calledBy 
     let x: int = 0;
 
-    entry sum(n:int){
+    entry sum(n:optional){
+
         let a: int = 2;
         let b: int = 3;
         x = a + b;

test.tzs.rep

@@ -1,29 +0,0 @@
-\__ProgramNode: contract node.idx(n : int) [<stat>; ... <stat>;]
-	\__AttrDeclarationNode: n : int
-		\__VarDeclarationNode: let last_fib_calculated = <expr> : int
-			\__ ConstantNumNode: 1
-		\__FuncDeclarationNode: def fib(n : int) : int
-				\__ElseNode: else [<stat>; ... <stat>;]
-					\__VarDeclarationNode: let a = <expr> : nat
-						\__ MinusNode
-							\__ VariableNode: n
-							\__ ConstantNumNode: 1
-					\__VarDeclarationNode: let b = <expr> : int
-						\__ MinusNode
-							\__ VariableNode: n
-							\__ ConstantNumNode: 2
-					\__ReturnStatementNode: return <expr>
-						\__ PlusNode
-							\__CallNode: fib(<expr>, ..., <expr>)
-								\__ VariableNode: a
-							\__CallNode: fib(<expr>, ..., <expr>)
-								\__ VariableNode: b
-		\__EntryDeclarationNode: Entry get_fib(n : int)
-			\__AttrDeclarationNode: n : int
-				\__VarDeclarationNode: let ad = <expr> : address
-					\__ ConstantStringNode: "tz1QV341nbgxbyzd8SYU7fJtNScaLVPMZkGC"
-				\__VarDeclarationNode: let result = <expr> : int
-					\__CallNode: fib(<expr>, ..., <expr>)
-						\__ VariableNode: n
-				\__VarCallNode: last_fib_calculated = <expr>
-					\__ VariableNode: result