commit 629383e2e2a700c162b867568b8a18174663f6d8 Author: Gary Talent Date: Tue Aug 8 20:21:43 2023 -0500 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..31e6260 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +.cache +.clangd +.conanbuild +.current_build +.idea +CMakeLists.txt.user +Session.vim +build +cmake-build-debug +clion-build +compile_commands.json +dist +graph_info.json +tags diff --git a/.liccor.yml b/.liccor.yml new file mode 100644 index 0000000..29fe59b --- /dev/null +++ b/.liccor.yml @@ -0,0 +1,9 @@ +--- +source: +- src +copyright_notice: |- + Copyright 2022 - 2023 gary@drinkingtea.net + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..74174be --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,46 @@ +cmake_minimum_required(VERSION 3.19) +set(CMAKE_POLICY_DEFAULT_CMP0110 NEW) # requires CMake 3.19 + +project(CppProject) + +include(deps/buildcore/base.cmake) +list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules) + +set(CMAKE_POSITION_INDEPENDENT_CODE ON) +set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ${QTDIR}) + +if(NOT MSVC) + # enable warnings + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wsign-conversion") +endif() + +set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) + +if(APPLE) + set(CMAKE_MACOSX_RPATH OFF) + set(CMAKE_INSTALL_NAME_DIR "@executable_path/../Library/") + set(CPPPROJECT_DIST_BIN CppProject.app/Contents/MacOS) + set(CPPPROJECT_DIST_LIB CppProject.app/Contents/Library) + set(CPPPROJECT_DIST_MODULE CppProject.app/Contents/Plugins) + set(CPPPROJECT_DIST_RESOURCES CppProject.app/Contents/Resources) + set(CPPPROJECT_DIST_MAC_APP_CONTENTS CppProject.app/Contents) +else() + if(UNIX) + set(BUILD_SHARED_LIBS ON) + endif() + set(CMAKE_INSTALL_RPATH "$ORIGIN/../lib") + set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE) + set(CPPPROJECT_DIST_BIN bin) + set(CPPPROJECT_DIST_LIB lib) + set(CPPPROJECT_DIST_MODULE lib) + set(CPPPROJECT_DIST_RESOURCES share) +endif() + +if(QTDIR) + set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_RPATH} "${QTDIR}/lib") +endif() +set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE) + +add_subdirectory(src) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c4d3b59 --- /dev/null +++ b/Makefile @@ -0,0 +1,17 @@ +PROJECT_NAME=CppProject +BUILDCORE_PATH=deps/buildcore +VCPKG_PKGS= +include ${BUILDCORE_PATH}/base.mk + +ifeq ($(OS),darwin) + PROJECT_EXECUTABLE=./build/${CURRENT_BUILD}/${PROJECT_NAME}.app/Contents/MacOS/${PROJECT_NAME} +else + PROJECT_EXECUTABLE=./build/${CURRENT_BUILD}/bin/${PROJECT_NAME} +endif + +.PHONY: run +run: build + ${ENV_RUN} ${PROJECT_EXECUTABLE} +.PHONY: debug +debug: build + ${ENV_RUN} ${DEBUGGER} ${PROJECT_EXECUTABLE} diff --git a/README.md b/README.md new file mode 100644 index 0000000..2dd4d1d --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# CppProject + +This is a template for C++ projects. Replace the name 'CppProject' in the following files: + +* ./README.md (this file) +* ./Makefile +* ./CMakeLists.txt + +Also, update .liccor.yml with your copyright info. + +## Prerequisites + +* Install GCC, Clang, or Visual Studio with C++20 support +* Install Python 3 +* Install Ninja, Make, and CMake +* Consider also installing ccache for faster subsequent build times + +## Build + +Build options: release, debug, asan + + make purge configure-{release,debug} install + +## Run + + make run diff --git a/deps/buildcore/.gitignore b/deps/buildcore/.gitignore new file mode 100644 index 0000000..784af77 --- /dev/null +++ b/deps/buildcore/.gitignore @@ -0,0 +1,4 @@ +scripts/__pycache__ +CMakeLists.txt.user +Session.vim +graph_info.json diff --git a/deps/buildcore/LICENSE b/deps/buildcore/LICENSE new file mode 100644 index 0000000..14e2f77 --- /dev/null +++ b/deps/buildcore/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/deps/buildcore/base.cmake b/deps/buildcore/base.cmake new file mode 100644 index 0000000..bce3dd1 --- /dev/null +++ b/deps/buildcore/base.cmake @@ -0,0 +1,64 @@ + +set(QTDIR "" CACHE PATH "Path to Qt Libraries") + +set(BUILDCORE_TARGET "Native" CACHE STRING "The type of build to produce(Native/GBA)") + +list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake/modules) +include(GenerateExportHeader) +include(address_sanitizer) + +set(CMAKE_INSTALL_PREFIX "${CMAKE_SOURCE_DIR}/dist/${BUILDCORE_BUILD_CONFIG}") +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) +set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON) + +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_EXTENSIONS OFF) +# enable ccache +if(NOT DEFINED ENV{BUILDCORE_SUPPRESS_CCACHE}) + find_program(CCACHE_PROGRAM ccache) + if(CCACHE_PROGRAM) + set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}") + endif() +endif() + +if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_definitions(-DDEBUG) +else() + add_definitions(-DNDEBUG) + if(APPLE) + set(CMAKE_OSX_ARCHITECTURES arm64;x86_64) + endif() +endif() + +if(MSVC) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zc:preprocessor") +else() + # forces colored output when using ninja + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fdiagnostics-color") + # enable warnings + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wextra") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wcast-align") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wdouble-promotion") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wformat=2") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wmissing-field-initializers") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wnon-virtual-dtor") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-null-dereference") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wold-style-cast") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Woverloaded-virtual") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wpedantic") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wsign-compare") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wsign-conversion") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wconversion") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wunused") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wunused-variable") + # release build options + if (CMAKE_BUILD_TYPE STREQUAL "Release") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3") + endif() +endif() + +enable_testing() + diff --git a/deps/buildcore/base.mk b/deps/buildcore/base.mk new file mode 100644 index 0000000..f5bbd6a --- /dev/null +++ b/deps/buildcore/base.mk @@ -0,0 +1,168 @@ +# +# Copyright 2016 - 2023 gary@drinkingtea.net +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# + +ifeq (${OS},Windows_NT) + SHELL := powershell.exe + .SHELLFLAGS := -NoProfile -Command + OS=windows + HOST_ENV=${OS} +else + OS=$(shell uname | tr [:upper:] [:lower:]) + HOST_ENV=${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} + endif +endif + +ifneq ($(shell ${ENV_RUN} which python3 2> /dev/null),) + PYTHON3=python3 +else + ifeq ($(shell ${ENV_RUN} python -c 'import sys; print(sys.version_info[0])'),3) + PYTHON3=python + 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 + endif + ifndef VCPKG_VERSION + VCPKG_VERSION=2020.06 + endif + VCPKG_TOOLCHAIN=--toolchain=${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake +endif +ifeq ($(OS),darwin) + DEBUGGER=lldb -- +else + DEBUGGER=gdb --args +endif + +VCPKG_DIR=$(VCPKG_DIR_BASE)/$(VCPKG_VERSION)-$(HOST_ENV) +CURRENT_BUILD=$(HOST_ENV)-$(shell ${ENV_RUN} ${PYBB} cat .current_build) + +.PHONY: build +build: + ${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} +.PHONY: install +install: + ${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} install +.PHONY: clean +clean: + ${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} clean +.PHONY: purge +purge: + ${ENV_RUN} ${RM_RF} .current_build + ${ENV_RUN} ${RM_RF} ${BUILD_PATH} + ${ENV_RUN} ${RM_RF} dist + ${ENV_RUN} ${RM_RF} compile_commands.json +.PHONY: test +test: build + ${ENV_RUN} mypy ${SCRIPTS} + ${ENV_RUN} ${CMAKE_BUILD} ${BUILD_PATH} test +.PHONY: test-verbose +test-verbose: build + ${ENV_RUN} ${CTEST} ${BUILD_PATH} --output-on-failure +.PHONY: test-rerun-verbose +test-rerun-verbose: build + ${ENV_RUN} ${CTEST} ${BUILD_PATH} --rerun-failed --output-on-failure + +.PHONY: devenv-image +devenv-image: + docker build . -t ${DEVENV_IMAGE} +.PHONY: devenv-create +devenv-create: + docker run -d \ + -e LOCAL_USER_ID=$(shell id -u ${USER}) \ + -e DISPLAY=$(DISPLAY) \ + -e QT_AUTO_SCREEN_SCALE_FACTOR=1 \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -v /run/dbus/:/run/dbus/ \ + -v $(shell pwd):/usr/src/project \ + -v /dev/shm:/dev/shm \ + --restart=always \ + --name ${DEVENV} \ + -t ${DEVENV_IMAGE} bash +.PHONY: devenv-destroy +devenv-destroy: + docker rm -f ${DEVENV} +ifdef ENV_RUN +.PHONY: devenv-shell +devenv-shell: + ${ENV_RUN} bash +endif + +ifdef USE_VCPKG + +.PHONY: vcpkg +vcpkg: ${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 +else + ${ENV_RUN} ${VCPKG_DIR}/bootstrap-vcpkg.bat +endif + +.PHONY: vcpkg-install +vcpkg-install: +ifneq (${OS},windows) + ${VCPKG_DIR}/vcpkg install ${VCPKG_PKGS} +else + ${VCPKG_DIR}/vcpkg install --triplet x64-windows ${VCPKG_PKGS} +endif + +else ifdef USE_CONAN # USE_VCPKG ################################################ + +.PHONY: setup-conan +conan-config: + ${ENV_RUN} conan profile detect -f --name ${PROJECT_NAME} +.PHONY: conan +conan: + ${ENV_RUN} ${PYBB} conan-install ${PROJECT_NAME} +endif # USE_VCPKG ############################################### + +ifeq (${OS},darwin) +.PHONY: configure-xcode +configure-xcode: + ${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_tool=xcode --current_build=0 --build_root=${BUILD_PATH} +endif + +.PHONY: configure-release +configure-release: + ${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=release --build_root=${BUILD_PATH} + +.PHONY: configure-debug +configure-debug: + ${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=debug --build_root=${BUILD_PATH} + +.PHONY: configure-asan +configure-asan: + ${ENV_RUN} ${SETUP_BUILD} ${VCPKG_TOOLCHAIN} --build_type=asan --build_root=${BUILD_PATH} + diff --git a/deps/buildcore/cmake/modules/Mingw.cmake b/deps/buildcore/cmake/modules/Mingw.cmake new file mode 100644 index 0000000..12768c2 --- /dev/null +++ b/deps/buildcore/cmake/modules/Mingw.cmake @@ -0,0 +1,18 @@ +set(CMAKE_SYSTEM_NAME Windows) +set(TOOLCHAIN_PREFIX x86_64-w64-mingw32) + +# cross compilers to use for C and C++ +set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc) +set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++) +set(CMAKE_RC_COMPILER ${TOOLCHAIN_PREFIX}-windres) + +# target environment on the build host system +# set 1st to dir with the cross compiler's C/C++ headers/libs +set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX}) + +# modify default behavior of FIND_XXX() commands to +# search for headers/libs in the target environment and +# search for programs in the build host environment +set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) +set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) +set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) diff --git a/deps/buildcore/cmake/modules/address_sanitizer.cmake b/deps/buildcore/cmake/modules/address_sanitizer.cmake new file mode 100644 index 0000000..f1076b2 --- /dev/null +++ b/deps/buildcore/cmake/modules/address_sanitizer.cmake @@ -0,0 +1,52 @@ +# This file belongs Nick Overdijk, and is from https://github.com/NickNick/wubwubcmake +# The MIT License (MIT) +# +# Copyright (c) 2013 Nick Overdijk +# +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.option(USE_ASAN "Enable Address Sanitizer, if your compiler supports it" ON) + +option(USE_ASAN "Enable Address Sanitizer, if your compiler supports it" OFF) +if(USE_ASAN) + include(CheckCXXSourceCompiles) + # If the compiler understands -fsanitize=address, add it to the flags (gcc since 4.8 & clang since version 3.2) + set(CMAKE_REQUIRED_FLAGS_BAK "${CMAKE_REQUIRED_FLAGS}") + set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -fsanitize=address") + CHECK_CXX_SOURCE_COMPILES("int main() { return 0; }" FLAG_FSANA_SUPPORTED) + set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS_BAK}") + + if(FLAG_FSANA_SUPPORTED) + set(asan_flag "-fsanitize=address") + else(FLAG_FSANA_SUPPORTED) + # Alternatively, try if it understands -faddress-sanitizer (clang until version 3.2) + set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -faddress-sanitizer") + CHECK_CXX_SOURCE_COMPILES("int main() { return 0; }" FLAG_FASAN_SUPPORTED) + set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS_BAK}") + + if(FLAG_FASAN_SUPPORTED) + set(asan_flag "-faddress-sanitizer") + endif(FLAG_FASAN_SUPPORTED) + endif(FLAG_FSANA_SUPPORTED) + + if(FLAG_FSANA_SUPPORTED OR FLAG_FASAN_SUPPORTED) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${asan_flag}") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${asan_flag}") + set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} ${asan_flag}") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${asan_flag}") + endif() + +endif(USE_ASAN) diff --git a/deps/buildcore/scripts/pybb.py b/deps/buildcore/scripts/pybb.py new file mode 100755 index 0000000..f3d8a10 --- /dev/null +++ b/deps/buildcore/scripts/pybb.py @@ -0,0 +1,142 @@ +#! /usr/bin/env python3 + +# +# Copyright 2016 - 2023 gary@drinkingtea.net +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# + +# "Python Busy Box" - adds cross-platform equivalents to Unix commands that +# don't translate well to that other operating system + +import os +import platform +import shutil +import subprocess +import sys +from typing import List, Optional + + +def mkdir(path: str): + if not os.path.exists(path): + os.mkdir(path) + + +# 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): + os.remove(path) + elif os.path.isdir(path): + shutil.rmtree(path) + + +def ctest_all() -> int: + base_path = sys.argv[2] + if not os.path.isdir(base_path): + # no generated projects + return 0 + args = ['ctest'] + sys.argv[3:] + orig_dir = os.getcwd() + for d in os.listdir(base_path): + os.chdir(os.path.join(orig_dir, base_path, d)) + err = subprocess.run(args).returncode + if err != 0: + return err + return 0 + + +def cmake_build(base_path: str, target: Optional[str]) -> int: + if not os.path.isdir(base_path): + # nothing to build + return 0 + for d in os.listdir(base_path): + path = os.path.join(base_path, d) + if not os.path.isdir(path): + continue + args = ['cmake', '--build', path] + if target is not None: + args.extend(['--target', target]) + err = subprocess.run(args).returncode + if err != 0: + return err + return 0 + + +def conan() -> int: + project_name = sys.argv[2] + conan_dir = '.conanbuild' + err = 0 + try: + mkdir(conan_dir) + except: + 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 + + +def cat(paths: List[str]) -> int: + for path in paths: + try: + with open(path) as f: + data = f.read() + sys.stdout.write(data) + except FileNotFoundError: + sys.stderr.write('cat: {}: no such file or directory\n'.format(path)) + return 1 + sys.stdout.write('\n') + return 0 + + +def get_env(var_name: str) -> int: + if var_name not in os.environ: + return 1 + sys.stdout.write(os.environ[var_name]) + return 0 + + +def hostname() -> int: + sys.stdout.write(platform.node()) + return 0 + + +def main() -> int: + err = 0 + if sys.argv[1] == 'mkdir': + try: + mkdir(sys.argv[2]) + except: + err = 1 + elif sys.argv[1] == 'rm': + for i in range(2, len(sys.argv)): + rm(sys.argv[i]) + 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) + elif sys.argv[1] == 'cat': + err = cat(sys.argv[2:]) + elif sys.argv[1] == 'getenv': + err = get_env(sys.argv[2]) + elif sys.argv[1] == 'hostname': + err = hostname() + else: + sys.stderr.write('Command not found\n') + err = 1 + return err + + +if __name__ == '__main__': + try: + sys.exit(main()) + except KeyboardInterrupt: + sys.exit(1) diff --git a/deps/buildcore/scripts/setup-build.py b/deps/buildcore/scripts/setup-build.py new file mode 100755 index 0000000..281b303 --- /dev/null +++ b/deps/buildcore/scripts/setup-build.py @@ -0,0 +1,102 @@ +#! /usr/bin/env python3 + +# +# Copyright 2016 - 2023 gary@drinkingtea.net +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# + +import argparse +import os +import platform +import shutil +import subprocess +import sys + +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) + args = parser.parse_args() + + if args.build_type == 'asan': + build_type_arg = 'Debug' + sanitizer_status = 'ON' + elif args.build_type == 'debug': + build_type_arg = 'Debug' + sanitizer_status = 'OFF' + elif args.build_type == 'release': + build_type_arg = 'Release' + sanitizer_status = 'OFF' + else: + print('Error: Invalid build tool') + return 1 + + if args.build_tool == 'xcode': + build_config = '{:s}-{:s}'.format(args.target, args.build_tool) + else: + build_config = '{:s}-{:s}'.format(args.target, args.build_type) + + if 'QTDIR' in os.environ: + qt_path = '-DQTDIR={:s}'.format(os.environ['QTDIR']) + else: + qt_path = '' + + if args.build_tool == '' or args.build_tool == 'default': + if shutil.which('ninja') is None: + build_tool = '' + else: + build_tool = '-GNinja' + elif args.build_tool == 'xcode': + build_tool = '-GXcode' + else: + print('Error: Invalid build tool') + return 1 + + project_dir = os.getcwd() + build_dir = '{:s}/{:s}/{:s}'.format(project_dir, args.build_root, build_config) + rm(build_dir) + cmake_cmd = [ + 'cmake', '-S', project_dir, '-B', build_dir, build_tool, + '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON', + '-DCMAKE_TOOLCHAIN_FILE={:s}'.format(args.toolchain), + '-DCMAKE_BUILD_TYPE={:s}'.format(build_type_arg), + '-DUSE_ASAN={:s}'.format(sanitizer_status), + '-DBUILDCORE_BUILD_CONFIG={:s}'.format(build_config), + '-DBUILDCORE_TARGET={:s}'.format(args.target), + ] + if qt_path != '': + cmake_cmd.append(qt_path) + if platform.system() == 'Windows': + cmake_cmd.append('-A x64') + + subprocess.run(cmake_cmd) + + mkdir('dist') + if int(args.current_build) != 0: + cb = open('.current_build', 'w') + cb.write(args.build_type) + cb.close() + + rm('compile_commands.json') + if platform.system() != 'Windows': + os.symlink('{:s}/compile_commands.json'.format(build_dir), 'compile_commands.json') + return 0 + + +if __name__ == '__main__': + try: + sys.exit(main()) + except KeyboardInterrupt: + sys.exit(1) diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..afb1679 --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,13 @@ +add_executable( + CppProject + main.cpp +) + +install( + TARGETS + CppProject + DESTINATION + bin + BUNDLE DESTINATION . +) + diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..186b11e --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,14 @@ +/* + * Copyright 2022 - 2023 gary@drinkingtea.net + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#include + +int main(int, char**) { + printf("C++ project.\n"); + return 0; +}