Merge branch 'imports'

Author: adapap

Examples/imports.owpy

@@ -0,0 +1,5 @@
+#import "lib/child"
+
+Rule "Debug Import"
+    Actions
+        debug_func("Hello!")

Examples/lib/child.owpy

@@ -0,0 +1,5 @@
+#import 'lib2/child2.owpy'
+
+%debug_func(text)
+    Msg(Everyone, text)
+    nested(Lucio)

Examples/lib/lib2/child2.owpy

@@ -0,0 +1,2 @@
+%nested(hero_)
+    Set Hero(Event Player, hero_)

OWScript.py

@@ -1,4 +1,5 @@
 import argparse
+import os
 import re
 import sys
 import time
@@ -7,7 +8,7 @@
 from OWScript.Parser import Parser
 from OWScript.Transpiler import Transpiler
 
-def transpile(text, args):
+def transpile(text, path, args):
     """Transpiles an OWScript code into Overwatch Workshop rules."""
     start = time.time()
     Errors.TEXT = text
@@ -23,7 +24,7 @@ def transpile(text, args):
     tree = parser.script()
     if args.tree:
         print(tree.string())
-    transpiler = Transpiler(tree=tree)
+    transpiler = Transpiler(tree=tree, path=path)
     code = transpiler.run()
     if args.min:
         code = re.sub(r'[\s\n]*', '', code)
@@ -50,10 +51,15 @@ def transpile(text, args):
     parser.add_argument('--tokens', action='store_true', help='Debug: shows the tokens created by the lexer')
     parser.add_argument('--tree', action='store_true', help='Debug: visualizes the AST generated by the parser')
     args = parser.parse_args()
-    file_input = args.input[0] if args.input else sys.stdin
-    with open(file_input) as f:
-        text = f.read()
+    if args.input:
+        file_input = args.input[0]
+        path = os.path.abspath(file_input)
+        with open(path) as f:
+            text = f.read()
+    else:
+        text = sys.stdin.read()
+        path = os.getcwd()
     try:
-        transpile(text, args=args)
+        transpile(text, path=path, args=args)
     except Errors.OWSError as ex:
         print('Error:', ex)

OWScript/AST.py

@@ -94,6 +94,13 @@ def __init__(self, code):
     def __repr__(self):
         return '<Raw {}>'.format(len(self.code))
 
+class Import(AST):
+    def __init__(self, path):
+        self.path = path
+
+    def __repr__(self):
+        return '#import {}'.format(self.path)
+
 # Workshop Types
 class WorkshopType(AST):
     @classmethod

OWScript/Errors.py

@@ -16,6 +16,9 @@ class LexError(OWSError):
 class ParseError(OWSError):
     pass
 
+class ImportError(OWSError):
+    pass
+
 class SyntaxError(OWSError):
     pass
 

OWScript/Importer.py

@@ -0,0 +1,19 @@
+from . import Errors
+from .Lexer import Lexer
+from .Parser import Parser
+
+def import_file(path):
+    error_text = Errors.TEXT
+    with open(path) as f:
+        text = f.read()
+    try:
+        Errors.TEXT = text
+        lexer = Lexer(text=text)
+        tokens = lexer.lex()
+        parser = Parser(tokens=tokens)
+        tree = parser.script()
+        Errors.TEXT = error_text
+        return tree
+    except Exception as ex:
+        Errors.TEXT = error_text
+        raise ex

OWScript/Lexer.py

@@ -1,12 +1,8 @@
 import functools
 import re
 
-try:
-    from . import Errors
-    from .Tokens import Token, Tokens
-except ImportError:
-    import Errors
-    from Tokens import Token, Tokens
+from . import Errors
+from .Tokens import Token, Tokens
 
 class Lexer:
     IGNORE = ('WHITESPACE', 'SEMI', 'COMMENT', 'ANNOTATION')

OWScript/Parser.py

@@ -2,14 +2,10 @@
 from collections import deque
 from functools import partial
 
-try:
-    from . import Errors
-    from .AST import *
-    from .Tokens import ALIASES
-    from .Workshop import *
-except ImportError:
-    import Errors
-    from AST import *
+from . import Errors
+from .AST import *
+from .Tokens import ALIASES
+from .Workshop import *
 
 class Parser:
     def __init__(self, tokens):
@@ -105,11 +101,13 @@ def script(self):
         return node
 
     def stmt(self):
-        """stmt : (funcdef | ruledef | line)"""
+        """stmt : (funcdef | ruledef | importdef | line)"""
         if self.curvalue == '%':
             return self.funcdef()
         elif self.curtype in ('DISABLED', 'RULE'):
             return self.ruledef()
+        elif self.curtype == 'IMPORT':
+            return self.importdef()
         else:
             return self.line()
 
@@ -207,6 +205,16 @@ def block(self):
             node.children.append(line)
         return node
 
+    def importdef(self):
+        """importdef : #import STRING"""
+        self.eat('IMPORT')
+        path = self.curvalue.strip('\'').strip('"').replace('/', '\\').rstrip('.owpy')
+        pos = self.curpos
+        self.eat('STRING')
+        node = Import(path=path)
+        node._pos = pos
+        return node
+
     def line(self):
         """line : 
                 ( if_stmt

OWScript/Tokens.py

@@ -85,6 +85,7 @@ class Tokens:
     RBRACK : r'\]'
     STRING : r'("[^\\\r\n\f]*?"|\'[^\\\r\n\f]*?\')'
     F_STRING : r'(`[^\\\r\n\f]*?`)'
+    IMPORT : r'#IMPORT\b'
     IF : r'IF\b'
     ELIF : r'ELIF\b'
     ELSE : r'ELSE\b'

OWScript/Transpiler.py

@@ -1,14 +1,13 @@
+import os
 import re
 from collections import defaultdict
 from itertools import chain, count
 from string import capwords, ascii_uppercase as letters
 
-try:
-    from . import Errors
-    from .AST import *
-    from .Workshop import Workshop
-except ImportError:
-    from AST import *
+from . import Errors
+from . import Importer
+from .AST import *
+from .Workshop import Workshop
 
 def flatten(l):
     l = list(l)
@@ -82,8 +81,9 @@ def map_2pos(a, b):
     get_map: get_map
 
 class Transpiler:
-    def __init__(self, tree, indent_size=3):
+    def __init__(self, tree, path, indent_size=3):
         self.tree = tree
+        self.path = path
         self.indent_size = indent_size
         self.indent_level = 0
         # Reserved Global Indices
@@ -95,6 +95,7 @@ def __init__(self, tree, indent_size=3):
         self.player_varconst = iter(letters[1:])
         self.varconsts = {}
         self.curblock = []
+        self.imports = set()
 
     @property
     def tabs(self):
@@ -126,9 +127,48 @@ def resolve_skips(self):
         for skip, jump in zip(skips, skip_to[::-1]):
             self.curblock[skip] = self.curblock[skip].format(jump)
 
+    def resolve_import(self, node, scope):
+        # TODO - Resolves imports recursively
+        children = self.visit(node, scope).children
+        nodes = []
+        for child in children:
+            if type(child) == Import:
+                cur_path = self.path
+                self.path = os.path.join(os.path.dirname(self.path), os.path.dirname(node.path)) + '\\'
+                result = self.resolve_import(child, scope)
+                self.path = cur_path
+                nodes = result + nodes
+            else:
+                nodes.append(child)
+        return nodes
+
     def visitScript(self, node, scope):
         code = r'rule("Generated by https://github.com/adapap/OWScript") { Event { Ongoing - Global; } Actions { Set Global Variable At Index(A, 0, Round To Integer(Add(Distance Between(Nearest Walkable Position(Vector(-500.000, 0, 0)), Nearest Walkable Position(Vector(500, 0, 0))), Distance Between(Nearest Walkable Position(Vector(0, 0, -500.000)), Nearest Walkable Position(Vector(0, 0, 500)))), Down)); }}' + '\n'
-        return (code + ''.join(self.visit_children(node, scope))).rstrip('\n')
+        while len(node.children) > 0:
+            child = node.children[0]
+            if type(child) == Import:
+                node.children = self.resolve_import(child, scope) + node.children[1:]
+            else:
+                code += self.visit(child, scope)
+                node.children = node.children[1:]
+        return code.rstrip('\n')
+
+    def visitImport(self, node, scope):
+        file_dir = os.path.dirname(self.path)
+        path = os.path.join(file_dir, node.path) + '.owpy'
+        try:
+            assert os.path.exists(path)
+        except AssertionError:
+            raise Errors.ImportError('File {} could not be found'.format(node.path), pos=node._pos)
+        try:
+            assert path not in self.imports
+            self.imports.add(path)
+            result = Importer.import_file(path)
+        except AssertionError:
+            print('DEBUG - Skipping duplicate import {}'.format(path))
+        except Exception as ex:
+            raise Errors.ImportError('Failed to import \'{}\' due to the following error:\n{}'.format(node.path, ex), pos=node._pos)
+        return result
 
     def visitRule(self, node, scope):
         code = ''
@@ -527,7 +567,7 @@ def visitCall(self, node, scope):
         else:
             print('DEBUG - Call Origin:', type(parent))
         if not base_node:
-            raise Errors.NameError('Undefined function \'{}\''.format(base_name[5:]), pos=parent._pos)
+            raise Errors.NameError('Undefined function \'{}\''.format(func_name), pos=parent._pos)
         func = base_node if type(base_node) != Variable else base_node.value
         if type(func) == Function:
             # Assert arity

README.md

@@ -10,6 +10,7 @@ Setup
 - `-m | --min` Optional: minifies the output by stripping whitespace
 - `-s | --save [FILE]` Optional: saves to the target output file instead of stdout
 - `-c | --copy` Optional: copies code to clipboard (must have *pyperclip* installed: `pip install pyperclip`)
+- `--enable-imports` Optional: Enables the experimental import functionality.
 
 ## Syntax Highlighting
 In the `Syntax/` folder, you can find the raw Iro code which I used to generate a Sublime Text file with modifications. You can directly import the `OWScript.sublime-syntax` file by putting it in your ST3 `User` folder.
@@ -30,6 +31,7 @@ Documentation
 * [Functions](#functions)
 * [Loops](#loops)
 * [Attributes / Methods](#attributes--methods)
+* [Imports](#imports)
 
 **Data Types & Structures**
 * [Variables](#variables)
@@ -286,4 +288,39 @@ scores.append(123) // Method
 |Round|Round To Integer|
 |Sin|Sine From Degrees|
 |Sinr|Sine From Radians|
-|Torbjorn|Torbjörn|
+|Torbjorn|Torbjörn|
+
+## Imports
+OWScript allows bigger scripts and scripts that use common funcitonality to be broken up into modules and imported into a base file. All the "imported" files are directly copied into the base script to be transpiled to workshop code.
+
+To use this experimental feature, add the `--enable-imports` flag to the command and it will search your script for imports. This is recursive and allows for importing modules within modules. The modules you're importing **must** have the `.owpy` file ending to be properly imported or it will not be able to find the the module.
+
+You can import a file by using the `#import 'filename'`
+
+### Example
+File: `lib/functions.owpy`
+```
+%CreateEffect(pos, type, color)
+    Create Effect
+        Visible_To: Everyone
+        Type: type
+        Color: color
+        Position: pos
+        Radius: 1.5
+        Reevaluation: Visible To
+```
+
+File `src/setup.owpy`
+```
+Rule "Setup Effects"
+    Event
+        On Global
+    Actions
+        CreateEffect(<0,0,0>, Ring, Red)
+```
+
+File: `src/game.owpy`
+```
+#import 'lib/functions'
+#import 'src/setup'
+```

Syntax/OWScript.sublime-syntax

@@ -91,7 +91,7 @@ contexts:
     - match: '(@)'
       captures:
         0: keyword.operator.OWScript
-    - match: '(?i)(\s*\b(Event|Conditions|Actions|and|or|not|in|if|elif|else|for|while)\b)'
+    - match: '(?i)(\s*\b(Event|Conditions|Actions|and|or|not|in|if|elif|else|for|while|#import)\b)'
       captures:
         0: keyword.OWScript
     - match: '(\s*([_a-zA-Z][_a-zA-Z0-9]*))'