From 257389129f92fe236d4abd3348e4e84255a592ef Mon Sep 17 00:00:00 2001
From: Gary Talent <gary@drinkingtea.net>
Date: Thu, 24 Aug 2023 00:04:24 -0500
Subject: [PATCH] [buildcore] Update buildcore

---
 deps/buildcore/base.mk                | 165 +++++++++++++-------------
 deps/buildcore/scripts/pybb.py        |  54 ++++++---
 deps/buildcore/scripts/setup-build.py |  37 ++++--
 3 files changed, 147 insertions(+), 109 deletions(-)

diff --git a/deps/buildcore/base.mk b/deps/buildcore/base.mk
index 42757508..e962ee14 100644
--- a/deps/buildcore/base.mk
+++ b/deps/buildcore/base.mk
@@ -9,89 +9,87 @@
 ifeq (${OS},Windows_NT)
 	SHELL := powershell.exe
 	.SHELLFLAGS := -NoProfile -Command
-	OS=windows
-	HOST_ENV=${OS}
+	BC_OS=windows
+	BC_HOST_ENV=${BC_OS}
 else
-	OS=$(shell uname | tr [:upper:] [:lower:])
-	HOST_ENV=${OS}-$(shell uname -m)
+	BC_OS=$(shell uname | tr [:upper:] [:lower:])
+	BC_HOST_ENV=${BC_OS}-$(shell uname -m)
 endif
 
-DEVENV=devenv$(shell pwd | sed 's/\//-/g')
-DEVENV_IMAGE=${PROJECT_NAME}-devenv
-ifneq ($(shell which docker 2> /dev/null),)
-	ifeq ($(shell docker inspect --format="{{.State.Status}}" ${DEVENV} 2>&1),running)
-		ENV_RUN=docker exec -i -t --user $(shell id -u ${USER}) ${DEVENV}
+ifdef BC_USE_DOCKER_DEVENV
+	ifneq ($(shell which docker 2> /dev/null),)
+		BC_DEVENV=devenv$(shell pwd | sed 's/\//-/g')
+		BC_DEVENV_IMAGE=${BC_PROJECT_NAME}-devenv
+		ifeq ($(shell docker inspect --format="{{.State.Status}}" ${BC_DEVENV} 2>&1),running)
+			BC_ENVRUN=docker exec -i -t --user $(shell id -u ${USER}) ${BC_DEVENV}
+		endif
 	endif
 endif
 
-ifneq ($(shell ${ENV_RUN} which python3 2> /dev/null),)
-	PYTHON3=python3
+ifneq ($(shell ${BC_ENVRUN} which python3 2> /dev/null),)
+	BC_PY3=${BC_ENVRUN} python3
 else
-	ifeq ($(shell ${ENV_RUN} python -c 'import sys; print(sys.version_info[0])'),3)
-		PYTHON3=python
+	ifeq ($(shell ${BC_ENVRUN} python -c 'import sys; print(sys.version_info[0])'),3)
+		BC_PY3=${BC_ENVRUN} python
+	else
+		echo 'Please install Python3'
+		exit 1
 	endif
 endif
 
-SCRIPTS=${BUILDCORE_PATH}/scripts
-SETUP_BUILD=${PYTHON3} ${SCRIPTS}/setup-build.py
-PYBB=${PYTHON3} ${SCRIPTS}/pybb.py
-CMAKE_BUILD=${PYBB} cmake-build
-GET_ENV=${PYBB} getenv
-CTEST=${PYBB} ctest-all
-RM_RF=${PYBB} rm
-HOST=$(shell ${PYBB} hostname)
-BUILDCORE_HOST_SPECIFIC_BUILDPATH=$(shell ${GET_ENV} BUILDCORE_HOST_SPECIFIC_BUILDPATH)
-ifneq (${BUILDCORE_HOST_SPECIFIC_BUILDPATH},)
-BUILD_PATH=build/${HOST}
-else
-BUILD_PATH=build
-endif
-ifdef USE_VCPKG
-	ifndef VCPKG_DIR_BASE
-		VCPKG_DIR_BASE=.vcpkg
+BC_SCRIPTS=${BUILDCORE_PATH}/scripts
+BC_SETUP_BUILD=${BC_PY3} ${BC_SCRIPTS}/setup-build.py
+BC_PYBB=${BC_PY3} ${BC_SCRIPTS}/pybb.py
+BC_CMAKE_BUILD=${BC_PYBB} cmake-build
+BC_GETENV=${BC_PYBB} getenv
+BC_CTEST=${BC_PYBB} ctest-all
+BC_RM_RF=${BC_PYBB} rm
+BC_CAT=${BC_PYBB} cat
+BC_BUILD_PATH=build
+ifdef BC_USE_VCPKG
+	ifndef BC_VCPKG_DIR_BASE
+		BC_VCPKG_DIR_BASE=.vcpkg
 	endif
-	ifndef VCPKG_VERSION
-		VCPKG_VERSION=2020.06
+	ifndef BC_VCPKG_VERSION
+		BC_VCPKG_VERSION=2023.08.09
 	endif
-	VCPKG_TOOLCHAIN=--toolchain=${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake
-endif
-ifeq ($(OS),darwin)
-	DEBUGGER=lldb --
-else
-	DEBUGGER=gdb --args
+	BC_VCPKG_TOOLCHAIN=--toolchain=${BC_VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake
 endif
+BC_DEBUGGER=${BC_PYBB} debug
 
-VCPKG_DIR=$(VCPKG_DIR_BASE)/$(VCPKG_VERSION)-$(HOST_ENV)
-CURRENT_BUILD=$(HOST_ENV)-$(shell ${ENV_RUN} ${PYBB} cat .current_build)
+BC_VCPKG_DIR=$(BC_VCPKG_DIR_BASE)/$(BC_VCPKG_VERSION)-$(BC_HOST_ENV)
+BC_CURRENT_BUILD=$(BC_HOST_ENV)-$(shell ${BC_ENVRUN} ${BC_CAT} .current_build)
 
 .PHONY: build
 build:
-	${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH}
+	${BC_ENVRUN} ${BC_CMAKE_BUILD} ${BC_BUILD_PATH}
 .PHONY: install
 install:
-	${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} install
+	${BC_ENVRUN} ${BC_CMAKE_BUILD} ${BC_BUILD_PATH} install
 .PHONY: clean
 clean:
-	${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} clean
+	${BC_ENVRUN} ${BC_CMAKE_BUILD} ${BC_BUILD_PATH} clean
 .PHONY: purge
 purge:
-	${ENV_RUN} ${RM_RF} .current_build
-	${ENV_RUN} ${RM_RF} ${BUILD_PATH}
-	${ENV_RUN} ${RM_RF} dist
+	${BC_ENVRUN} ${BC_RM_RF} .current_build
+	${BC_ENVRUN} ${BC_RM_RF} ${BC_BUILD_PATH}
+	${BC_ENVRUN} ${BC_RM_RF} dist
+	${BC_ENVRUN} ${BC_RM_RF} compile_commands.json
 .PHONY: test
 test: build
-	${ENV_RUN} mypy ${SCRIPTS}
-	${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} test
+	${BC_ENVRUN} mypy ${BC_SCRIPTS}
+	${BC_ENVRUN} ${BC_CMAKE_BUILD} ${BC_BUILD_PATH} test
 .PHONY: test-verbose
 test-verbose: build
-	${ENV_RUN} ${CTEST} ${BUILD_PATH} --output-on-failure
+	${BC_ENVRUN} ${BC_CTEST} ${BC_BUILD_PATH} --output-on-failure
 .PHONY: test-rerun-verbose
 test-rerun-verbose: build
-	${ENV_RUN} ${CTEST} ${BUILD_PATH} --rerun-failed --output-on-failure
+	${BC_ENVRUN} ${BC_CTEST} ${BC_BUILD_PATH} --rerun-failed --output-on-failure
 
+ifdef BC_USE_DOCKER_DEVENV
 .PHONY: devenv-image
 devenv-image:
-	docker build . -t ${DEVENV_IMAGE}
+	docker build . -t ${BC_DEVENV_IMAGE}
 .PHONY: devenv-create
 devenv-create:
 	docker run -d \
@@ -103,73 +101,74 @@ devenv-create:
 		-v $(shell pwd):/usr/src/project \
 		-v /dev/shm:/dev/shm \
 		--restart=always \
-		--name ${DEVENV} \
-		-t ${DEVENV_IMAGE} bash
+		--name ${BC_DEVENV} \
+		-t ${BC_DEVENV_IMAGE} bash
 .PHONY: devenv-destroy
 devenv-destroy:
-	docker rm -f ${DEVENV}
-ifdef ENV_RUN
+	docker rm -f ${BC_DEVENV}
+ifdef BC_ENVRUN
 .PHONY: devenv-shell
 devenv-shell:
-	${ENV_RUN} bash
+	${BC_ENVRUN} bash
+endif
 endif
 
-ifdef USE_VCPKG
+ifdef BC_USE_VCPKG
 
 .PHONY: vcpkg
-vcpkg: ${VCPKG_DIR} vcpkg-install
+vcpkg: ${BC_VCPKG_DIR} vcpkg-install
 
-${VCPKG_DIR}:
-	${ENV_RUN} ${RM_RF} ${VCPKG_DIR}
-	${ENV_RUN} mkdir -p ${VCPKG_DIR_BASE}
-	${ENV_RUN} git clone -b release --depth 1 --branch ${VCPKG_VERSION} https://github.com/microsoft/vcpkg.git ${VCPKG_DIR}
-ifneq (${OS},windows)
-	${ENV_RUN} ${VCPKG_DIR}/bootstrap-vcpkg.sh
+${BC_VCPKG_DIR}:
+	${BC_ENVRUN} ${BC_RM_RF} ${BC_VCPKG_DIR}
+	${BC_ENVRUN} mkdir -p ${BC_VCPKG_DIR_BASE}
+	${BC_ENVRUN} git clone -b release --depth 1 --branch ${BC_VCPKG_VERSION} https://github.com/microsoft/vcpkg.git ${BC_VCPKG_DIR}
+ifneq (${BC_OS},windows)
+	${BC_ENVRUN} ${BC_VCPKG_DIR}/bootstrap-vcpkg.sh
 else
-	${ENV_RUN} ${VCPKG_DIR}/bootstrap-vcpkg.bat
+	${BC_ENVRUN} ${BC_VCPKG_DIR}/bootstrap-vcpkg.bat
 endif
 
 .PHONY: vcpkg-install
 vcpkg-install:
-ifneq (${OS},windows)
-	${VCPKG_DIR}/vcpkg install ${VCPKG_PKGS}
+ifneq (${BC_OS},windows)
+	${BC_ENVRUN} ${BC_VCPKG_DIR}/vcpkg install ${BC_VCPKG_PKGS}
 else
-	${VCPKG_DIR}/vcpkg install --triplet x64-windows ${VCPKG_PKGS}
+	${BC_ENVRUN} ${BC_VCPKG_DIR}/vcpkg install --triplet x64-windows ${BC_VCPKG_PKGS}
 endif
 
-else ifdef USE_CONAN # USE_VCPKG ################################################
-
+else ifdef USE_CONAN # USE_CONAN ################################################
 .PHONY: setup-conan
 conan-config:
-	${ENV_RUN} conan profile new ${PROJECT_NAME} --detect --force
-ifeq ($(OS),linux)
-	${ENV_RUN} conan profile update settings.compiler.libcxx=libstdc++11 ${PROJECT_NAME}
+	${BC_ENVRUN} conan profile new ${BC_PROJECT_NAME} --detect --force
+ifeq ($(BC_OS),linux)
+	${BC_ENVRUN} conan profile update settings.compiler.libcxx=libstdc++11 ${BC_PROJECT_NAME}
 else
-	${ENV_RUN} conan profile update settings.compiler.cppstd=20 ${PROJECT_NAME}
-ifeq ($(OS),windows)
-	${ENV_RUN} conan profile update settings.compiler.runtime=static ${PROJECT_NAME}
+	${BC_ENVRUN} conan profile update settings.compiler.cppstd=20 ${BC_PROJECT_NAME}
+ifeq ($(BC_OS),windows)
+	${BC_ENVRUN} conan profile update settings.compiler.runtime=static ${BC_PROJECT_NAME}
 endif
 endif
+
 .PHONY: conan
 conan:
-	${ENV_RUN} ${PYBB} conan-install ${PROJECT_NAME}
-endif # USE_VCPKG ###############################################
+	${BC_ENVRUN} ${BC_PYBB} conan-install ${BC_PROJECT_NAME}
+endif # USE_CONAN ###############################################
 
-ifeq (${OS},darwin)
+ifeq (${BC_OS},darwin)
 .PHONY: configure-xcode
 configure-xcode:
-	${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_tool=xcode --current_build=0 --build_root=${BUILD_PATH}
+	${BC_ENVRUN} ${BC_SETUP_BUILD} ${BC_VCPKG_TOOLCHAIN} --build_tool=xcode --current_build=0 --build_root=${BC_BUILD_PATH}
 endif
 
 .PHONY: configure-release
 configure-release:
-	${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=release --build_root=${BUILD_PATH}
+	${BC_ENVRUN} ${BC_SETUP_BUILD} ${BC_VCPKG_TOOLCHAIN} --build_type=release --build_root=${BC_BUILD_PATH}
 
 .PHONY: configure-debug
 configure-debug:
-	${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=debug --build_root=${BUILD_PATH}
+	${BC_ENVRUN} ${BC_SETUP_BUILD} ${BC_VCPKG_TOOLCHAIN} --build_type=debug --build_root=${BC_BUILD_PATH}
 
 .PHONY: configure-asan
 configure-asan:
-	${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=asan --build_root=${BUILD_PATH}
+	${BC_ENVRUN} ${BC_SETUP_BUILD} ${BC_VCPKG_TOOLCHAIN} --build_type=asan --build_root=${BC_BUILD_PATH}
 
diff --git a/deps/buildcore/scripts/pybb.py b/deps/buildcore/scripts/pybb.py
index e7f18cae..a0a52c6d 100755
--- a/deps/buildcore/scripts/pybb.py
+++ b/deps/buildcore/scripts/pybb.py
@@ -19,19 +19,31 @@ import sys
 from typing import List, Optional
 
 
-def mkdir(path: str):
-    if not os.path.exists(path):
-        os.mkdir(path)
+def mkdir(path: str) -> int:
+    try:
+        if not os.path.exists(path):
+            os.mkdir(path)
+    except Exception:
+        return 1
+    return 0
 
 
 # this exists because Windows is utterly incapable of providing a proper rm -rf
 def rm(path: str):
-    if (os.path.exists(path) or os.path.islink(path)) and not os.path.isdir(path):
+    file_exists = os.path.exists(path)
+    is_link = os.path.islink(path)
+    is_dir = os.path.isdir(path)
+    if (file_exists or is_link) and not is_dir:
         os.remove(path)
     elif os.path.isdir(path):
         shutil.rmtree(path)
 
 
+def rm_multi(paths: List[str]):
+    for path in paths:
+        rm(path)
+
+
 def ctest_all() -> int:
     base_path = sys.argv[2]
     if not os.path.isdir(base_path):
@@ -70,16 +82,13 @@ def conan() -> int:
     err = 0
     try:
         mkdir(conan_dir)
-    except:
+    except Exception:
         return 1
     if err != 0:
         return err
     args = ['conan', 'install', '../', '--build=missing', '-pr', project_name]
     os.chdir(conan_dir)
-    err = subprocess.run(args).returncode
-    if err != 0:
-        return err
-    return 0
+    return subprocess.run(args).returncode
 
 
 def cat(paths: List[str]) -> int:
@@ -89,12 +98,21 @@ def cat(paths: List[str]) -> int:
                 data = f.read()
                 sys.stdout.write(data)
         except FileNotFoundError:
-            sys.stderr.write('cat: {}: no such file or directory\n'.format(path))
+            sys.stderr.write(f'cat: {path}: no such file or directory\n')
             return 1
     sys.stdout.write('\n')
     return 0
 
 
+def debug(paths: List[str]) -> int:
+    if shutil.which('gdb') is not None:
+        args = ['gdb', '--args']
+    elif shutil.which('lldb') is not None:
+        args = ['lldb', '--']
+    args.extend(paths)
+    return subprocess.run(args).returncode
+
+
 def get_env(var_name: str) -> int:
     if var_name not in os.environ:
         return 1
@@ -107,24 +125,26 @@ def hostname() -> int:
     return 0
 
 
+def clarg(idx: int) -> Optional[str]:
+    return sys.argv[idx] if len(sys.argv) > idx else None
+
+
 def main() -> int:
     err = 0
     if sys.argv[1] == 'mkdir':
-        try:
-            mkdir(sys.argv[2])
-        except:
-            err = 1
+        err = mkdir(sys.argv[2])
     elif sys.argv[1] == 'rm':
-        for i in range(2, len(sys.argv)):
-            rm(sys.argv[i])
+        rm_multi(sys.argv[2:])
     elif sys.argv[1] == 'conan-install':
         err = conan()
     elif sys.argv[1] == 'ctest-all':
         err = ctest_all()
     elif sys.argv[1] == 'cmake-build':
-        err = cmake_build(sys.argv[2], sys.argv[3] if len(sys.argv) > 3 else None)
+        err = cmake_build(sys.argv[2], clarg(3))
     elif sys.argv[1] == 'cat':
         err = cat(sys.argv[2:])
+    elif sys.argv[1] == 'debug':
+        err = debug(sys.argv[2:])
     elif sys.argv[1] == 'getenv':
         err = get_env(sys.argv[2])
     elif sys.argv[1] == 'hostname':
diff --git a/deps/buildcore/scripts/setup-build.py b/deps/buildcore/scripts/setup-build.py
index c218fe34..2f235fd6 100755
--- a/deps/buildcore/scripts/setup-build.py
+++ b/deps/buildcore/scripts/setup-build.py
@@ -19,15 +19,33 @@ from pybb import mkdir, rm
 
 os_name = os.uname().sysname.lower()
 
+
 def main() -> int:
     parser = argparse.ArgumentParser()
-    parser.add_argument('--target', help='Platform target',
-                        default='{:s}-{:s}'.format(os_name, platform.machine()))
-    parser.add_argument('--build_type', help='Build type (asan,debug,release)', default='release')
-    parser.add_argument('--build_tool', help='Build tool (default,xcode)', default='')
-    parser.add_argument('--build_root', help='Path to the root of build directories (must be in project dir)', default='build')
-    parser.add_argument('--toolchain', help='Path to CMake toolchain file', default='')
-    parser.add_argument('--current_build', help='Indicates whether or not to make this the active build', default=1)
+    parser.add_argument(
+            '--target',
+            help='Platform target',
+            default=f'{os_name}-{platform.machine()}')
+    parser.add_argument(
+            '--build_type',
+            help='Build type (asan,debug,release)',
+            default='release')
+    parser.add_argument(
+            '--build_tool',
+            help='Build tool (default,xcode)',
+            default='')
+    parser.add_argument(
+            '--build_root',
+            help='Path to the root build directory (must be in project dir)',
+            default='build')
+    parser.add_argument(
+            '--toolchain',
+            help='Path to CMake toolchain file',
+            default='')
+    parser.add_argument(
+            '--current_build',
+            help='Indicates whether or not to make this the active build',
+            default=1)
     args = parser.parse_args()
 
     if args.build_type == 'asan':
@@ -65,7 +83,7 @@ def main() -> int:
         return 1
 
     project_dir = os.getcwd()
-    build_dir = '{:s}/{:s}/{:s}'.format(project_dir, args.build_root, build_config)
+    build_dir = f'{project_dir}/{args.build_root}/{build_config}'
     rm(build_dir)
     cmake_cmd = [
         'cmake', '-S', project_dir, '-B', build_dir, build_tool,
@@ -91,7 +109,8 @@ def main() -> int:
 
     rm('compile_commands.json')
     if platform.system() != 'Windows':
-        os.symlink('{:s}/compile_commands.json'.format(build_dir), 'compile_commands.json')
+        os.symlink(f'{build_dir}/compile_commands.json',
+                   'compile_commands.json')
     return 0