blender/tools/utils_ide/cmake_qtcreator_project.py

#!/usr/bin/env python3
# SPDX-FileCopyrightText: 2010-2022 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later

r"""
Example Linux usage:
 python ~/blender-git/blender/build_files/cmake/cmake_qtcreator_project.py --build-dir ~/blender-git/cmake

Example Win32 usage:
 c:\Python32\python.exe c:\blender_dev\blender\build_files\cmake\cmake_qtcreator_project.py --build-dir c:\blender_dev\cmake_build
"""

__all__ = (
    "main",
)

import argparse
import os
import sys

project_name_default = "Unknown"


def quote_define(define: str) -> str:
    if " " in define.strip():
        return '"%s"' % define
    else:
        return define


def create_qtc_project_main(name: str) -> None:
    from project_info import (
        SIMPLE_PROJECTFILE,
        SOURCE_DIR,
        # CMAKE_DIR,
        PROJECT_DIR,
        source_list,
        is_project_file,
        is_c_header,
        cmake_advanced_info,
        cmake_compiler_defines,
        project_name_get,
    )

    files = list(source_list(SOURCE_DIR, filename_check=is_project_file))
    files_rel = [os.path.relpath(f, start=PROJECT_DIR) for f in files]
    files_rel.sort()

    # --- qtcreator specific, simple format
    if SIMPLE_PROJECTFILE:
        # --- qtcreator specific, simple format
        PROJECT_NAME = name or project_name_default
        FILE_NAME = PROJECT_NAME.lower()
        with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f:
            f.write("\n".join(files_rel))

        with open(os.path.join(PROJECT_DIR, "%s.includes" % FILE_NAME), 'w') as f:
            f.write("\n".join(sorted(list(set(os.path.dirname(f)
                                              for f in files_rel if is_c_header(f))))))

        qtc_prj = os.path.join(PROJECT_DIR, "%s.creator" % FILE_NAME)
        with open(qtc_prj, 'w') as f:
            f.write("[General]\n")

        qtc_cfg = os.path.join(PROJECT_DIR, "%s.config" % FILE_NAME)
        if not os.path.exists(qtc_cfg):
            with open(qtc_cfg, 'w') as f:
                f.write("// ADD PREDEFINED MACROS HERE!\n")
    else:
        if (includes_and_defines := cmake_advanced_info()) is None:
            return
        includes, defines = includes_and_defines

        # for some reason it doesn't give all internal includes
        includes = list(
            set(includes) | {
                os.path.dirname(f)
                for f in files_rel if is_c_header(f)
            }
        )
        includes.sort()

        # be tricky, get the project name from CMake if we can!
        PROJECT_NAME = name or project_name_get() or project_name_default

        FILE_NAME = PROJECT_NAME.lower()
        with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f:
            f.write("\n".join(files_rel))

        with open(os.path.join(PROJECT_DIR, "%s.includes" % FILE_NAME), 'w', encoding='utf-8') as f:
            f.write("\n".join(sorted(includes)))

        qtc_prj = os.path.join(PROJECT_DIR, "%s.creator" % FILE_NAME)
        with open(qtc_prj, 'w') as f:
            f.write("[General]\n")

        qtc_cfg = os.path.join(PROJECT_DIR, "%s.config" % FILE_NAME)
        with open(qtc_cfg, 'w') as f:
            f.write("// ADD PREDEFINED MACROS TO %s_custom.config!\n" % FILE_NAME)

            qtc_custom_cfg = os.path.join(PROJECT_DIR, "%s_custom.config" % FILE_NAME)
            if os.path.exists(qtc_custom_cfg):
                with open(qtc_custom_cfg, 'r') as fc:
                    f.write(fc.read())
                    f.write("\n")

            defines_final = [("#define %s %s" % (item[0], quote_define(item[1]))) for item in defines]
            if os.name != "nt":
                defines_final.extend(cmake_compiler_defines() or [])
            f.write("\n".join(defines_final))

    print("Blender project file written to: %r" % qtc_prj)
    # --- end


def create_qtc_project_python(name: str) -> None:
    from project_info import (
        SOURCE_DIR,
        # CMAKE_DIR,
        PROJECT_DIR,
        source_list,
        is_py,
        project_name_get,
    )

    files = list(source_list(SOURCE_DIR, filename_check=is_py))
    files_rel = [os.path.relpath(f, start=PROJECT_DIR) for f in files]
    files_rel.sort()

    # --- qtcreator specific, simple format
    # be tricky, get the project name from git if we can!
    PROJECT_NAME = (name or project_name_get() or project_name_default) + "_Python"

    FILE_NAME = PROJECT_NAME.lower()
    with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f:
        f.write("\n".join(files_rel))

    qtc_prj = os.path.join(PROJECT_DIR, "%s.creator" % FILE_NAME)
    with open(qtc_prj, 'w') as f:
        f.write("[General]\n")

    qtc_cfg = os.path.join(PROJECT_DIR, "%s.config" % FILE_NAME)
    if not os.path.exists(qtc_cfg):
        with open(qtc_cfg, 'w') as f:
            f.write("// ADD PREDEFINED MACROS HERE!\n")

    print("Python project file written to:  %r" % qtc_prj)


def argparse_create() -> argparse.ArgumentParser:

    parser = argparse.ArgumentParser(
        description="This script generates Qt Creator project files for Blender",
    )

    parser.add_argument(
        "-n", "--name",
        dest="name",
        metavar='NAME', type=str,
        help="Override default project name (\"Blender\")",
        required=False,
    )

    parser.add_argument(
        "-b", "--build-dir",
        dest="build_dir",
        metavar='BUILD_DIR', type=str,
        help="Specify the build path (or fallback to the $PWD)",
        required=False,
    )

    return parser


def main() -> int:
    parser = argparse_create()
    args = parser.parse_args()
    name = args.name

    import project_info
    if not project_info.init(args.build_dir):
        return 1

    create_qtc_project_main(name)
    create_qtc_project_python(name)

    return 0


if __name__ == "__main__":
    sys.exit(main())