moved code chunks into functions + docs

- Documentation what the functions do to stay organized.

Author: sour-dani

gen.py

@@ -4,17 +4,38 @@
 def main():
     # TODO add logic for OnGameEvent so that the end result is "OnGameEvent_${1:name}(${2:table params})$0"
     # Change data management to dicts and json
-    with open("defs.txt", "r", encoding="utf-8") as defs_file:
-        defs_data = defs_file.readlines()
+    try:
+        with open("defs.txt", "r", encoding="utf-8") as defs_file:
+            defs_data = defs_file.readlines()
+    except IOError:
+        print("Unable to locate defs file")
+        quit()
 
+    functions = parse_defs(defs_data)
+    sorted_keys = sorted(list(functions.keys()))# Good for comparing diffs
+    function_registry = generate_snippet_format(sorted_keys, functions)
+
+    with open("squirrel.json", "w") as json_test:
+        dump(function_registry, json_test, indent=2)
+
+def parse_defs(defs_data: str) -> dict:
+    '''
+    ### Summary
+    Takes raw data from file and sorts it based on what line the entry was, in units of 4 lines.
+    ### Parameters
+    1. defs_data : str
+            - The raw data from the `defs.txt` file.
+    ### Returns
+    1. functions : dict
+            - All of the raw data parsed into a primitive dict that will be later reformated to the snippet formatting.
+    '''
     functions = {}
-    i = 0
+    quad_defs_entry = 0
     most_recent_function = ""
-
     for line in defs_data:
-        text = line[0:-1]
+        text = line[0:-1] # necessary because ".readlines() injects newlines"
 
-        match ["function", "signature", "description", "space"][i % 4]:
+        match ["function", "signature", "description", "space"][quad_defs_entry % 4]:
             case "function":
                 most_recent_function = text
                 functions[most_recent_function] = {
@@ -34,11 +55,23 @@ def main():
                         most_recent_function
                     ]["description"].replace('"', '\\"')
 
-        i += 1
+        quad_defs_entry += 1
+    return functions
 
-    sorted_keys = sorted(list(functions.keys()))
+def generate_snippet_format(sorted_keys: list[str], functions: dict) -> dict:
+    '''
+    ### Summary
+    Takes the sorted keys of the functions dict and formats where unset variables exist in the function body.  
+    ### Parameters
+    1. sorted_keys : list[str]
+            - A sorted list of the names of all of the functions.
+    2. functions : dict
+            - Primitive dictionary of all the functions that need to be formatted to include their unset variable syntax as added to the registry.
+    ### Returns
+    1. function_registry : dict
+            - Formatted dict of all functions as VSCode snippets with unset variable syntax included.
+    '''
     function_registry = {}
-
     for key in sorted_keys:
         prefix, body = "", ""
         base_signature = functions[key]["signature"]
@@ -48,13 +81,13 @@ def main():
             # We need to parse params
             params = base_signature[paren_index + 1 : -1].split(", ")
             body = prefix + "("
-            i = 1
+            quad_defs_entry = 1
             if params[0] != "":
                 for param in params:
-                    body += "${" + str(i) + ":" + param + "}"
-                    if i != len(params):
+                    body += "${" + str(quad_defs_entry) + ":" + param + "}"
+                    if quad_defs_entry != len(params):
                         body += ", "
-                    i += 1
+                    quad_defs_entry += 1
             body += ")$0"
         else:
             # This is a constant
@@ -70,9 +103,7 @@ def main():
             }
         }
         function_registry.update(function_entry)
-
-    with open("squirrel_.json", "w") as json_test:
-        dump(function_registry, json_test, indent=2)
+    return  function_registry
 
 if __name__ == "__main__":
     main()