Added a score script

2026-06-19 01:16:26 -07:00 · 2020-07-13 16:18:46 -05:00
parent 3f31cb6192
commit 672145cfd8
2 changed files with 74 additions and 0 deletions
@@ -0,0 +1,73 @@
+import re
+from file_util import FileUtil
+
+SRC_DIRECTORY = './src'
+FUNCTION_REGEX = r'([/][*]([^*]|([*][^/]))*[*][/][\n]\s*)?(void|s64|s32|s16|s8|u64|u32|u16|u8|f32|f64)(\s|[*])*([0-9A-Za-z_]+)\s*[(][^)]*[)]\s*{'
+WIP_REGEX = r'#if(.|\n)*?(GLOBAL_ASM[(][^)]*[)])(.|\n)*?#else(.|\n)*?#endif'
+
+class ScoreFileMatch:
+    def __init__(self, comment, functionName):
+        self.comment = comment
+        self.functionName = functionName
+        self.isDocumented = (comment != None) and not functionName.startswith("func_")
+    
+class ScoreFile:
+    def __init__(self, filepath):
+        self.functions = []
+        self.numGlobalAsms = 0
+        self.path = filepath
+        self.read_file()
+        self.get_matches()
+        #print(self.path, len(self.functions), self.numGlobalAsms, self.get_number_of_documented_functions())
+    
+    def read_file(self):
+        with open(self.path, "r") as inFile:
+            self.text = inFile.read()
+            self.text = re.sub(WIP_REGEX, 'GLOBAL_ASM()', self.text)
+            
+    def get_matches(self):
+        matches = re.finditer(FUNCTION_REGEX, self.text, re.MULTILINE)
+        for matchNum, match in enumerate(matches, start=1):
+            groups = match.groups()
+            self.functions.append(ScoreFileMatch(groups[0], groups[5]))
+        self.numGlobalAsms = self.text.count("GLOBAL_ASM")
+        
+    def get_number_of_documented_functions(self):
+        count = 0
+        for func in self.functions:
+            if func.isDocumented:
+                count += 1
+        return count
+
+def main():
+    scoreFiles = []
+    srcFilenames = FileUtil.get_filenames_from_directory_recursive(SRC_DIRECTORY, extensions=('.c'))
+    totalNumberOfDecompiledFunctions = 0
+    totalNumberOfDocumentedFunctions = 0
+    totalNumberOfGlobalAsms = 0
+    for filename in srcFilenames:
+        scoreFile = ScoreFile(SRC_DIRECTORY + '/' + filename)
+        totalNumberOfDecompiledFunctions += len(scoreFile.functions)
+        totalNumberOfGlobalAsms += scoreFile.numGlobalAsms
+        totalNumberOfDocumentedFunctions += scoreFile.get_number_of_documented_functions()
+        scoreFiles.append(scoreFile)
+    totalNumberOfFunctions = totalNumberOfDecompiledFunctions + totalNumberOfGlobalAsms
+    
+    adventureOnePercentage = (totalNumberOfDecompiledFunctions / totalNumberOfFunctions) * 100
+    adventureTwoPercentage = (totalNumberOfDocumentedFunctions / totalNumberOfFunctions) * 100
+    
+    print('=========================================')
+    print(' ADVENTURE ONE (ASM -> C Decompilation)')
+    print(' ----------- {:5.2f}% Complete -----------'.format(adventureOnePercentage))
+    print(' # Decompiled functions: ' + str(totalNumberOfDecompiledFunctions))
+    print(' # GLOBAL_ASM remaining: ' + str(totalNumberOfGlobalAsms))
+    print('=========================================')
+    print(' ADVENTURE TWO (Cleanup & Documentation)')
+    print(' ----------- {:5.2f}% Complete -----------'.format(adventureTwoPercentage))
+    print(' # Documented functions:   ' + str(totalNumberOfDocumentedFunctions))
+    print(' # Undocumented remaining: ' + str(totalNumberOfFunctions - totalNumberOfDocumentedFunctions))
+    print('=========================================')
+   #print(totalNumberOfDecompiledFunctions, totalNumberOfGlobalAsms, totalNumberOfDocumentedFunctions)
+    
+
+main()