viv-compiler 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

viv_compiler/utils/utils.py

@@ -1,5 +1,6 @@
 """Utility functions used by various components of the Viv DSL compiler."""
 
+import viv_compiler.config
 import viv_compiler.types
 from viv_compiler.types import ExpressionDiscriminator
 from typing import Any
@@ -14,55 +15,44 @@ def get_all_role_names(action_definition: viv_compiler.types.ActionDefinition) -
     Returns:
         A set containing the names of all roles associated with the given action definition.
     """
-    return {'hearer', 'this', 'default'} | set(action_definition['roles'])
+    return viv_compiler.config.SPECIAL_ROLE_NAMES | set(action_definition['roles'])
 
 
 def get_all_referenced_roles(
     ast_chunk: Any,
     ignore_role_unpackings: bool = False,
-    ignore: Any = None
 ) -> list[viv_compiler.types.RoleName]:
     """Return a list of all roles referenced in the given AST chunk.
 
     Args:
         ast_chunk: The full or partial AST to search for role references.
         ignore_role_unpackings: Whether to search for role references inside role unpackings.
-        ignore: Only used internally, via recursive calls to this function.
 
     Returns:
         A list containing the names of all roles referenced in the given AST chunk.
     """
-    ignore = ignore or ["this"]
-    roles_referenced_so_far = []
+    roles_referenced_so_far: list[viv_compiler.types.RoleName] = []
     if isinstance(ast_chunk, list):
         for element in ast_chunk:
             roles_referenced_so_far.extend(get_all_referenced_roles(
                 ast_chunk=element,
                 ignore_role_unpackings=ignore_role_unpackings,
-                ignore=ignore
             ))
     elif isinstance(ast_chunk, dict):
-        if ast_chunk.get('type') == ExpressionDiscriminator.ENTITY_REFERENCE:
-            referenced_role = ast_chunk['value']['anchor']
-            roles_referenced_so_far.append(referenced_role)
-        elif not ignore_role_unpackings and ast_chunk.get('type') == ExpressionDiscriminator.ROLE_UNPACKING:
-            referenced_role = ast_chunk['value']
-            roles_referenced_so_far.append(referenced_role)
-        else:
-            scoped_ignore = ignore
-            if ast_chunk.get('type') == ExpressionDiscriminator.LOOP:
-                scoped_ignore = [*ignore, ast_chunk['value']['variable']]
-                iterable = ast_chunk['value']['iterable']
-                if iterable.get('type') == ExpressionDiscriminator.ROLE_UNPACKING:
-                    if not ignore_role_unpackings:
-                        roles_referenced_so_far.append(iterable['value'])
-            for key, value in ast_chunk.items():
-                roles_referenced_so_far.extend(get_all_referenced_roles(
-                    ast_chunk=value,
-                    ignore_role_unpackings=ignore_role_unpackings,
-                    ignore=scoped_ignore
-                ))
-    return list(set(filter(lambda role: role not in ignore, roles_referenced_so_far)))
+        ast_chunk_type = ast_chunk.get('type')
+        if ast_chunk_type in (ExpressionDiscriminator.ENTITY_REFERENCE, ExpressionDiscriminator.SYMBOL_REFERENCE):
+            if not ast_chunk['value']['local']:
+                if ast_chunk['value']['anchor'] != viv_compiler.config.ACTION_SELF_REFERENCE_ROLE_NAME:
+                    roles_referenced_so_far.append(ast_chunk['value']['anchor'])
+        elif ast_chunk_type == ExpressionDiscriminator.ROLE_UNPACKING and not ignore_role_unpackings:
+            referenced_role_name = ast_chunk['value']
+            roles_referenced_so_far.append(referenced_role_name)
+        for value in ast_chunk.values():
+            roles_referenced_so_far.extend(get_all_referenced_roles(
+                ast_chunk=value,
+                ignore_role_unpackings=ignore_role_unpackings,
+            ))
+    return list(set(roles_referenced_so_far))
 
 
 def get_all_referenced_enum_names(ast_chunk: Any) -> list[viv_compiler.types.EnumName]:
@@ -77,9 +67,12 @@ def get_all_referenced_enum_names(ast_chunk: Any) -> list[viv_compiler.types.Enu
     Returns:
         A list containing the names of all the enums referenced in the given AST chunk.
     """
-    all_enum_expressions = get_all_expressions_of_type(expression_type="enum", ast_chunk=ast_chunk)
-    all_referenced_enum_names = [expression['name'] for expression in all_enum_expressions]
-    return all_referenced_enum_names
+    all_enum_expressions = get_all_expressions_of_type(
+        expression_type=ExpressionDiscriminator.ENUM,
+        ast_chunk=ast_chunk
+    )
+    all_referenced_enum_names = {expression['name'] for expression in all_enum_expressions}
+    return sorted(all_referenced_enum_names)
 
 
 def get_all_referenced_adapter_function_names(ast_chunk: Any) -> list[viv_compiler.types.AdapterFunctionName]:
@@ -95,11 +88,78 @@ def get_all_referenced_adapter_function_names(ast_chunk: Any) -> list[viv_compil
         A list containing the names of all the adapter functions referenced in the given AST chunk.
     """
     all_adapter_function_references = get_all_expressions_of_type(
-        expression_type="adapterFunctionCall",
+        expression_type=ExpressionDiscriminator.ADAPTER_FUNCTION_CALL,
+        ast_chunk=ast_chunk
+    )
+    all_referenced_adapter_function_names = {expression['name'] for expression in all_adapter_function_references}
+    return sorted(all_referenced_adapter_function_names)
+
+
+def get_all_assigned_scratch_variable_names(ast_chunk: Any) -> list[viv_compiler.types.VariableName]:
+    """Return a list of the names of all scratch variables that are assigned anywhere in the given AST chunk.
+
+    Args:
+        ast_chunk: The full or partial AST to search for scratch variables being assigned.
+
+    Returns:
+        A list containing the names of all scratch variables that are assigned anywhere in the given AST chunk.
+    """
+    all_assigned_scratch_variable_names = set()
+    all_assignments = get_all_expressions_of_type(
+        expression_type=ExpressionDiscriminator.ASSIGNMENT,
+        ast_chunk=ast_chunk
+    )
+    for assignment in all_assignments:
+        # Move on if the effective prefix is not `@this.scratch.`
+        lhs = assignment['left']
+        if lhs['type'] != ExpressionDiscriminator.ENTITY_REFERENCE:
+            continue
+        if lhs['value']['local']:
+            continue
+        if lhs['value']['anchor'] != viv_compiler.config.SCRATCH_VARIABLE_REFERENCE_ANCHOR:
+            continue
+        if lhs['value']['path'][0] != viv_compiler.config.SCRATCH_VARIABLE_REFERENCE_PATH_PREFIX[0]:
+            continue
+        # Now determine if the LHS of the assignment is a bare scratch variable, i.e., an effective `@this.scratch.var`
+        head, *tail = lhs['value']['path'][1:]
+        if tail:
+            continue
+        if 'name' not in head:
+            # Move on if we somehow have a pointer or lookup after an effective `@this.scratch` (not idiomatic)
+            continue
+        all_assigned_scratch_variable_names.add(head['name'])
+    return sorted(all_assigned_scratch_variable_names)
+
+
+def get_all_referenced_scratch_variable_names(ast_chunk: Any) -> list[viv_compiler.types.VariableName]:
+    """Return a list of the names of all scratch variables that are referenced anywhere in the given AST chunk.
+
+    Args:
+        ast_chunk: The full or partial AST to search for scratch variables being referenced.
+
+    Returns:
+        A list containing the names of all scratch variables that are referenced anywhere in the given AST chunk.
+    """
+    all_referenced_scratch_variable_names = set()
+    all_entity_references = get_all_expressions_of_type(
+        expression_type=ExpressionDiscriminator.ENTITY_REFERENCE,
         ast_chunk=ast_chunk
     )
-    all_referenced_adapter_function_names = [expression['name'] for expression in all_adapter_function_references]
-    return all_referenced_adapter_function_names
+    for entity_reference in all_entity_references:
+        # Move on if the effective prefix is not `@this.scratch.`
+        if entity_reference['local']:
+            continue
+        if entity_reference['anchor'] != viv_compiler.config.SCRATCH_VARIABLE_REFERENCE_ANCHOR:
+            continue
+        if entity_reference['path'][0] != viv_compiler.config.SCRATCH_VARIABLE_REFERENCE_PATH_PREFIX[0]:
+            continue
+        # Now determine if the LHS of the assignment is a bare scratch variable, i.e., an effective `@this.scratch.var`
+        head, *_ = entity_reference['path'][1:]
+        if 'name' not in head:
+            # Move on if we somehow have a pointer or lookup after an effective `@this.scratch` (not idiomatic)
+            continue
+        all_referenced_scratch_variable_names.add(head['name'])
+    return sorted(all_referenced_scratch_variable_names)
 
 
 def get_all_expressions_of_type(expression_type: str, ast_chunk: Any) -> list[Any]:

{viv_compiler-0.1.1.dist-info → viv_compiler-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viv-compiler
-Version: 0.1.1
+Version: 0.1.2
 Summary: Compiler for the DSL of Viv, an action system for emergent narrative.
 Author-email: James Ryan <mail@jamesryan.ai>
 License: MIT License
@@ -45,7 +45,7 @@ Dynamic: license-file
 
 This package contains the reference compiler for the domain-specific language (DSL) at the heart of [Viv](https://github.com/james-owen-ryan/viv), an action system for emergent narrative.
 
-The Viv compiler accepts a *Viv source file* (`.viv`) and produces a *Viv content bundle* in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime.
+The Viv compiler accepts a **Viv source file** (`.viv`) and produces a **Viv content bundle** in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime with the same version number as the compiler.
 
 Once you've installed this package, you'll have access to the two compiler interfaces that are documented below:
 
@@ -65,17 +65,17 @@ Once you've installed this package, you'll have access to the two compiler inter
 
 ## Installation
 
-Install from PyPI:
+* Install from PyPI:
 
-```
-pip install viv-compiler
-```
+	```
+	pip install viv-compiler
+	```
 
-Smoke test to confirm your installation looks good:
+* Run a smoke test to confirm your installation looks good:
 
-```
-vivc --test
-```
+	```
+	vivc --test
+	```
 
 
 ## Command-Line Interface (CLI)
@@ -226,13 +226,13 @@ Once you've installed `viv-compiler`, the Viv compiler Python API can be invoked
 
 	```python
 	from pathlib import Path
-	from viv_compiler import compile_from_path
+	from viv_compiler import compile_from_path, VivCompileError
 	
 	try:
-	    content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
-	    print("Compilation succeeded:", content_bundle)
+		content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
+		print("Compilation succeeded:", content_bundle)
 	except VivCompileError as e:
-	    print("Compilation failed:", e)
+		print("Compilation failed:", e)
 	```
 
 

{viv_compiler-0.1.1.dist-info → viv_compiler-0.1.2.dist-info}/RECORD

@@ -1,33 +1,33 @@
 viv_compiler/__init__.py,sha256=qYCGYC46CCguVk7LybHbWlV1b4dPY7K0UOfrEF8k0E8,592
 viv_compiler/__main__.py,sha256=dyCH7r86O9Nw516E38Gm0gQjcSYDd57dhLGRBPoCi7s,60
+viv_compiler/_version.py,sha256=VZZTZ-YxtTb-5y0wP8QpegYjFIf2mRkpqDjOGa99DAM,88
 viv_compiler/api.py,sha256=8vr_WoLEzPSOMRNmovewE2f4b8_-r5xp5PdYc7S2rgc,2164
-viv_compiler/cli.py,sha256=BEMXRpOfPal7sri_fzY2zPdeE6QmxgITatfMZoh3HVM,8448
+viv_compiler/cli.py,sha256=RLyeQFKts85vLVcVy2dzcsG8U4efRhB_CBIotko50H8,8481
 viv_compiler/py.typed,sha256=qrkHrYJvGoZpU2BpVLNxJB44LlhqVSKyYOwD_L_1m3s,10
 viv_compiler/_samples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viv_compiler/_samples/smoke-test.viv,sha256=hBgnuOvO7A78iDZPTM6Z6xlkaLAA9zgmkuxPVwCLUGQ,152
 viv_compiler/backports/__init__.py,sha256=OozGI7C0wkn6Xjn19DPE_SSdSKX-gRiOQu8yooJ382E,25
 viv_compiler/backports/backports.py,sha256=NkZcknH0-iuZczNfGSlL-3yy9FpL9-Y9j_H65TQs_FA,243
 viv_compiler/config/__init__.py,sha256=A00lpnUKg-q3y_b-cN3jKF9urkGTGjb2Yz_gGc9WCLs,22
-viv_compiler/config/config.py,sha256=y8R2W2mctP6lbyB_aqIAmJINDIqAAXtzPJrA6lYv-bk,3981
+viv_compiler/config/config.py,sha256=mS9QHlpB1mw_PDADp7utOuaGE0a2cBEyzUPDHQXAjFI,3802
 viv_compiler/core/__init__.py,sha256=ZAU-F0_tXtRWRmw-anqCdZZDabN42nCrIfm_74RdBpE,123
-viv_compiler/core/core.py,sha256=bJzNpf6DM8F1ITn7vmCRxsCELnZ2FgY_23eCxULOGao,7828
+viv_compiler/core/core.py,sha256=mkaroUrEyN9MFucvB5GOS-8E5gKAApPdyRp8U0yfAjQ,7747
 viv_compiler/core/includes.py,sha256=Peth-YttHzbyTB9NXoyBKSDKBJ_NX6MEwOTGEUcHvIg,4879
-viv_compiler/core/metadata.py,sha256=QZToKtisN-ZYNckJsejMaGwXsMSR_TI11MbIuAl8_No,2894
+viv_compiler/core/metadata.py,sha256=8Oa3PtGDk94pBYr_f6CkqlebHvfYXxgtIluaoGGiluA,2988
 viv_compiler/core/postprocessing.py,sha256=fgogeBR4U92_dH-GBNDFrZqv9CuzCI1nlx7xHs3j6Iw,39073
-viv_compiler/core/validation.py,sha256=_fYvYxl2keAdF0KFx41c3JIl4EchrI9feVSM8VXj-fE,41000
-viv_compiler/core/visitor.py,sha256=ZF6h_Ebj8nujUbxDjNSxK-U2st_Bl6ZX3UFYeu5jBdE,47931
+viv_compiler/core/validation.py,sha256=EqTRDJ8TKSElDCTzDgKGDmlXHrdN_jzteF0_XYPfcRM,48380
+viv_compiler/core/visitor.py,sha256=tzJzk_t8qDqaWjioEqSraz8r4nl34KtDqx3KUmr9qek,48257
 viv_compiler/grammar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-viv_compiler/grammar/viv.peg,sha256=9xGvGl_TgNp0oX66um3Z2RQzG8MOJGBrDEiHoW6sP0I,11152
+viv_compiler/grammar/viv.peg,sha256=QTROPPHWj9h7kVD91ozZo-OHxzno0Q9PsIx1sHU9nx0,11161
 viv_compiler/types/__init__.py,sha256=FLwJ0wV_vdR95waeHfZ4YnUIvkK7v8RqR139lpnP1RE,102
-viv_compiler/types/content_public_schemas.py,sha256=WOHhgjIhoB-jiqHXDjqmnbY0V-QtxMQO9TBo_vOneo4,23422
-viv_compiler/types/dsl_public_schemas.py,sha256=Jzy3zxtjyrnorgD52Lb39t3GCMd-vSRGKYXdBkG2dQA,22556
+viv_compiler/types/content_public_schemas.py,sha256=mDM4iDQdBeqhN38r6wK58jXBzSej3pspkpNjPOiG8b8,23768
+viv_compiler/types/dsl_public_schemas.py,sha256=8J243Pball02p0CmAYey_ikFsSOXFWTxc0oqLdGQCwA,22566
 viv_compiler/types/internal_types.py,sha256=LOU4kT_tjxjU0CXqnqfluV-EBgX2KkhmUOa07B0i1xo,7816
 viv_compiler/utils/__init__.py,sha256=alIDGBnxWH4JvP-UW-7N99seBBi0r1GV1h8f1ERFBec,21
-viv_compiler/utils/_version.py,sha256=B40VyT6r1P2PNwgWWItzAYhh25_deCqUcl4EaXq0Beg,88
-viv_compiler/utils/utils.py,sha256=TwT9VKV1fXVFLToSXO-Cu046Gu2siA_Y7xGog_Zx9pA,7257
-viv_compiler-0.1.1.dist-info/licenses/LICENSE,sha256=_N1SL7eyeeqRS4HHgl_n85kuwUSw22qWP6IpQZ9F_M4,1066
-viv_compiler-0.1.1.dist-info/METADATA,sha256=MZmgisVHYAOH3B9lZTgkaZgienTQYfAWrRL_f5e_fTU,8427
-viv_compiler-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-viv_compiler-0.1.1.dist-info/entry_points.txt,sha256=YluMB1bLcPmnfaeAaMAtxXsKCkIEvyhb2dVgkVp55Ko,84
-viv_compiler-0.1.1.dist-info/top_level.txt,sha256=fd_4ocrOmLnp5oEnwxv2_Yt_JkluHdKD-Jr5eN__iaE,13
-viv_compiler-0.1.1.dist-info/RECORD,,
+viv_compiler/utils/utils.py,sha256=FWIFPFR8Xgub1nXc179qsvpfOW8JnGkpYywVf93PkSg,10070
+viv_compiler-0.1.2.dist-info/licenses/LICENSE,sha256=_N1SL7eyeeqRS4HHgl_n85kuwUSw22qWP6IpQZ9F_M4,1066
+viv_compiler-0.1.2.dist-info/METADATA,sha256=LjOlZXzAm-8-6IpgmL-hFE7xRpyDfE2w4oracAAshas,8500
+viv_compiler-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+viv_compiler-0.1.2.dist-info/entry_points.txt,sha256=YluMB1bLcPmnfaeAaMAtxXsKCkIEvyhb2dVgkVp55Ko,84
+viv_compiler-0.1.2.dist-info/top_level.txt,sha256=fd_4ocrOmLnp5oEnwxv2_Yt_JkluHdKD-Jr5eN__iaE,13
+viv_compiler-0.1.2.dist-info/RECORD,,