sa2/scripts/progress.py

#!/usr/bin/env python3

import argparse
import json
import git
import os
import re

def read_non_matching_funcs(filepath, game):
    result = []
    with open(filepath, 'r') as f:
        data = f.read()
        lines = data.split("\n")
        for i in range(len(lines)):
            line = lines[i]
            if "NONMATCH" in line:
                if game == "sa1" and "sa2." in line:
                    continue

                if game == "sa2" and "sa1." in line:
                    continue

                # if "unused_"  in line.lower():
                #     continue
                matcher = r'(NONMATCH|ASM_FUNC)\(".*?",\s*\w+\s+(?:SA2_LABEL\()?(\w+).*\)'
                match = re.findall(matcher, line)
                if match:
                    result.append(match[0][1])
                else:
                    if i < len(lines) - 1:
                        line = lines[i + 1]
                        match = re.findall(r'\W*\w*\W*(\w*).*\)', line)
                        if match:
                            result.append(match[0])
    return result


def parse_map(matching, map_file):
    src = 0
    asm = 0
    src_data = 0
    data = 0
    game = map_file.replace(".map", "")
    non_matching = 0
    non_matching_funcs = []

    with open(map_file, 'r') as map:
        # Skip to the linker script section
        line = map.readline()
        while not line.startswith('Linker script and memory map'):
            line = map.readline()
        while not line.lower().startswith('rom'):
            line = map.readline()
            if not line:
                raise Exception('Reached end of map without rom keyword')

        prev_symbol = None
        prev_addr = 0
        for line in map:
            if line.startswith(' .'):
                arr = line.split()
                section = arr[0]
                size = int(arr[2], 16)
                filepath = arr[3]
                if (filepath.startswith('src')):
                    if matching:
                        c_path = filepath.replace(".o", ".c")
                        if os.path.exists(c_path):
                            non_matching_funcs += read_non_matching_funcs(c_path, game)
                if filepath.startswith('build'):
                    # build/*/(asm|data|sound|src|...)/*/
                    #  ^    ^   ^
                    #  0    1   2                      3  
                    dir = filepath.split("/")[2]
                else:
                    # (asm|data|sound|src|...)/*/
                    #  ^
                    #  0                       1               
                    dir = filepath.split('/')[0]

                if section == '.text':
                    if dir == 'src':
                        src += size
                    elif dir == 'asm':
                        if filepath.find("asm/src/") != -1 or filepath.find("asm/lib/") != -1:
                            src += size
                        else:
                            asm += size
                    elif dir == 'data':
                        # scripts
                        src_data += size
                    elif dir == '..':
                        # libc
                        src += size
                elif section == '.rodata':
                    if dir == 'src':
                        src_data += size
                    elif dir == 'data':
                        data += size

            elif line.startswith('  '):
                arr = line.split()
                if len(arr) == 2 and arr[1] != '':  # It is actually a symbol

                    if prev_symbol in non_matching_funcs:
                        # non_matching_funcs.remove(prev_symbol)
                        # Calculate the length for non matching function
                        non_matching += int(arr[0], 16) - prev_addr

                    prev_symbol = arr[1]
                    prev_addr = int(arr[0], 16)
            elif line.strip() == '':
                # End of linker script section
                break

    src -= non_matching
    asm += non_matching

    return (src, asm, src_data, data)


def main():
    parser = argparse.ArgumentParser()

    parser = argparse.ArgumentParser(description="Computes current progress throughout the whole project.")
    parser.add_argument("format", nargs="?", default="text", choices=["text", "csv", "shield-json"])
    parser.add_argument("-m", "--matching", dest='matching', action='store_true',
                        help="Output matching progress instead of decompilation progress")
    parser.add_argument("-f", "--file", dest='map_file', default="sa2.map")
    args = parser.parse_args()

    (src, asm, src_data, data) = parse_map(args.matching, args.map_file)

    total = src + asm
    data_total = src_data + data

    src_percent = 100 * src / total
    asm_percent = 100 * asm / total

    src_data_percent = 100 * src_data / data_total
    data_percent     = 100 * data / data_total


    if args.format == 'csv':
        version = 2
        git_object = git.Repo(search_parent_directories=True).head.object
        timestamp = str(git_object.committed_date)
        git_hash = git_object.hexsha

        csv_list = [str(version), timestamp, git_hash, str(src),
                    str(total), str(src_data), str(data_total)]

        print(','.join(csv_list))

    elif args.format == 'shield-json':
        # https://shields.io/endpoint
        print(json.dumps({
            "schemaVersion": 1,
            "label": "progress" if not args.matching else "matching",
            "message": f"{src_percent:.3g}%",
            "color": 'yellow' if src_percent < 100 else "green",
        }))

    elif args.format == 'text':
        adjective = "decompiled" if not args.matching else "matched"

        print("src:  {:>9} / {:>8} total bytes {:<10} {:>9.4f}%".format(src, total, adjective, round(src_percent, 4)))
        # print()
        print("data: {:>9} / {:>8} total bytes analysed   {:>9.4f}%".format(src_data, data_total, round(src_data_percent, 4)))

    else:
        print("Unknown format argument: " + args.format)


if __name__ == '__main__':
    main()