o3de/scripts/migration/physics_service_rename.py

#
# Copyright (c) Contributors to the Open 3D Engine Project.
# For complete copyright and license terms please see the LICENSE at the root of this distribution.
#
# SPDX-License-Identifier: Apache-2.0 OR MIT
#
#

import os
import re
from pathlib import Path

'''
Updates AZ_CRC to AZ_CRC_CE.
'''
def crc_update(line: str):
    return re.sub(r'(AZ_CRC\()(.*)(,[\s]*0x[0-9a-f]{8})',
                  r'AZ_CRC_CE(\2',
                  line)

'''
Renames services provided by PhysX components from PhysX...Service to Physics...Service.
The service names were originally chosen to make a distinction from the legacy physics
components, but the legacy components have been removed, and the new naming better reflects
the modular design and intent to support other potential physics Gems.
This function searches all folders below the O3DE root folder for .cpp, .h or .inl files, and
replaces any instances of the old naming convention.
'''
def rename_physics_services():
    renamed_services = {
        "\"PhysXCharacterControllerService\"": "\"PhysicsCharacterControllerService\"",
        "\"PhysXCharacterGameplayService\"": "\"PhysicsCharacterGameplayService\"",
        "\"PhysXColliderService\"": "\"PhysicsColliderService\"",
        "\"PhysXEditorService\"": "\"PhysicsEditorService\"",
        "\"PhysXHeightfieldColliderService\"": "\"PhysicsHeightfieldColliderService\"",
        "\"PhysXJointService\"": "\"PhysicsJointService\"",
        "\"PhysXRagdollService\"": "\"PhysicsRagdollService\"",
        "\"PhysXRigidBodyService\"": "\"PhysicsRigidBodyService\"",
        "\"PhysXStaticRigidBodyService\"": "\"PhysicsStaticRigidBodyService\"",
        "\"PhysXDynamicRigidBodyService\"": "\"PhysicsDynamicRigidBodyService\"",
        "\"PhysXService\"": "\"PhysicsService\"",
        "\"PhysXShapeColliderService\"": "\"PhysicsShapeColliderService\"",
        "\"PhysXTriggerService\"": "\"PhysicsTriggerService\""
    }

    o3de_root = Path(__file__).parents[2]
    for root, dirs, files in os.walk(o3de_root):
        for filename in files:
            extension = os.path.splitext(filename)[1]
            if extension in [".h", ".cpp", ".inl"]:
                full_path = os.path.join(root, filename)
                file = open(full_path)
                lines = file.readlines()
                file.close()
                lines_changed = False
                for line_index in range(len(lines)):
                    for old_service, new_service in renamed_services.items():
                        if old_service in lines[line_index]:
                            lines_changed = True
                            lines[line_index] = lines[line_index].replace(old_service, new_service)
                            lines[line_index] = crc_update(lines[line_index])
                if lines_changed:
                    file = open(full_path, 'w')
                    file.writelines(lines)
                    file.close()

if __name__ == "__main__":
    rename_physics_services()