Makefile

.DEFAULT_GOAL:=help

PREFIX ?= /usr
BINDIR ?= $(PREFIX)/bin
APPLICATIONSDIR ?= $(PREFIX)/share/applications
ICONSDIR ?= $(PREFIX)/share/icons/hicolor/512x512/apps/

BINARY_NAME := squiid
BINARY_PATH ?= target/release/$(BINARY_NAME)
DESKTOP_FILE_NAME := squiid.desktop
DESKTOP_FILE_PATH ?= packages/$(DESKTOP_FILE_NAME)
ICON_FILE_NAME := squiid512.png
ICON_FILE_DEST_NAME := squiid.png
ICON_FILE_PATH ?= branding/icons/$(ICON_FILE_NAME)

APPIMAGETOOL ?= appimagetool
ELEVATE ?= sudo
CARGO ?= cargo
EXECUTABLE_PERMISSION ?= -m755
NORMAL_PERMISSION ?= -m644

VERSION := $(shell awk -F ' = ' '$$1 ~ /version/ { gsub(/["]/, "", $$2); printf("%s",$$2) }' Cargo.toml)
export VERSION

.PHONY: help
help: ## Shows this help message
	@awk 'BEGIN { \
		# Set the field separator (FS) to ":.*##" \
		FS = ":.*##"; \
		# Print a usage message with a highlighted <target> placeholder \
		printf "Usage: make \033[36m<target>\033[0m\n" \
	} \
	/^[a-zA-Z_-]+:.*?##/ { \
		# If the line matches the pattern for a target and its description, \
		# print the target name and description in a formatted string \
		printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2 \
	} \
	/^##@/ { \
		# If the line matches the pattern for a section header, \
		# print it in bold font \
		printf "\n\033[1m%s\033[0m\n", substr($$0, 5) \
	}' $(MAKEFILE_LIST)

clean: ## Clean the build environment
	rm -rf package-build \
		net.imaginaryinfinity.Squiid* \
		generated-sources.json \
		.flatpak-builder \
		flatpak-cargo-generator.py \
		squiid*.orig.tar.gz \
		squiid*.dsc \
		squiid*.debian.tar.xz \
		squiid*_source.* \
		snap

require-cargo:
	@echo "Checking the programs required for the build are installed..."
	@$(CARGO) --version >/dev/null 2>&1 || (echo "ERROR: cargo is required."; exit 1)

test: ## Test each component of the project
	$(CARGO) test -p squiid-parser -p squiid-engine -p squiid

build: require-cargo ## Build the release version of the program for the system platform
	$(CARGO) build --release

build-musl: require-cargo ## Build the Linux MUSL version
	$(CARGO) build --release --target=x86_64-unknown-linux-musl

install: build ## Install Squiid to the system
	$(ELEVATE) install -D -v $(EXECUTABLE_PERMISSION) $(BINARY_PATH) $(DESTDIR)/$(BINDIR)/$(BINARY_NAME)
	$(ELEVATE) install -D -v $(NORMAL_PERMISSION) $(DESKTOP_FILE_PATH) $(DESTDIR)/$(APPLICATIONSDIR)/$(DESKTOP_FILE_NAME)
	$(ELEVATE) install -D -v $(NORMAL_PERMISSION) $(ICON_FILE_PATH) $(DESTDIR)$(ICONSDIR)/$(ICON_FILE_DEST_NAME)

uninstall: ## Uninstall the version of Squiid installed with the Makefile
	$(ELEVATE) rm $(DESTDIR)$(BINDIR)/$(BINARY_NAME)
	$(ELEVATE) rm $(DESTDIR)$(APPLICATIONSDIR)/$(DESKTOP_FILE_NAME)
	$(ELEVATE) rm $(DESTDIR)$(ICONSDIR)/$(ICON_FILE_DEST_NAME)

flatpak: require-cargo clean ## Build the flatpak in package-build/
	@python3 --version >/dev/null 2>&1 || (echo "ERROR: python3 is required."; exit 1)
	@flatpak-builder --version >/dev/null 2>&1 || (echo "ERROR: flatpak-builder is required."; exit 1)
	@curl --version >/dev/null 2>&1 || (echo "ERROR: curl is required."; exit 1)
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)
	@jq --version >/dev/null 2>&1 || (echo "ERROR: jq is required."; exit 1)

	mkdir -p package-build

	curl https://raw.githubusercontent.com/flatpak/flatpak-builder-tools/master/cargo/flatpak-cargo-generator.py -Lo flatpak-cargo-generator.py

	python3 flatpak-cargo-generator.py ./Cargo.lock -o generated-sources.json

	@echo "Replacing VERSION with ${VERSION} in flatpak manifest"
	@envsubst '$${VERSION}' < packages/flatpak/net.imaginaryinfinity.Squiid.json > net.imaginaryinfinity.Squiid.json.tmp

	@echo "Substituting hash in flatpak manifest"
	URL=$$(cat net.imaginaryinfinity.Squiid.json.tmp | jq -r ".modules[].sources[0].url"); \
	export HASH=$$(curl -sL $$URL | sha256sum | cut -d ' ' -f1); \
	envsubst '$${HASH}' < net.imaginaryinfinity.Squiid.json.tmp > net.imaginaryinfinity.Squiid.json
	rm net.imaginaryinfinity.Squiid.json.tmp

	# flatpak-builder --install --user package-build net.imaginaryinfinity.Squiid.json

	# rm -f net.imaginaryinfinity.Squiid* generated-sources.json flatpak-cargo-generator.py

snap: clean ## Build the snap
	@snapcraft --version >/dev/null 2>&1 || (echo "ERROR: snapcraft is required."; exit 1)
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	mkdir -p snap/gui

	@echo "Replacing VERSION with ${VERSION} in snapcraft.yaml"
	@envsubst '$${VERSION}' < packages/snap/snapcraft.yaml > snap/snapcraft.yaml

	cp packages/snap/squiid.desktop snap/gui
	cp branding/icons/squiid512.png snap/gui/squiid.png

	snapcraft

	rm -rf snap

appimage: require-cargo clean build-musl ## Build the AppImage
	# Check for appimagetool
	@$(APPIMAGETOOL) --version > /dev/null 2>&1 || (echo "ERROR: appimagetool is required"; exit 1)
	# Check for curl
	@curl --version > /dev/null 2>&1 || (echo "ERROR: curl is required"; exit 1)
	# check for envsubst
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	# Make directory structure
	mkdir -p package-build/squiid.AppDir/usr/bin
	mkdir -p package-build/squiid.AppDir/usr/share/icons
	# Copy squiid binary
	cp target/x86_64-unknown-linux-musl/release/squiid package-build/squiid.AppDir/usr/bin/squiid
	# Copy AppRun
	cp packages/appimage/AppRun package-build/squiid.AppDir/AppRun
	# Make AppRun executable
	chmod +x package-build/squiid.AppDir/AppRun
	# Copy and format desktop file
	@envsubst '$${VERSION}' < packages/appimage/squiid.desktop > package-build/squiid.AppDir/squiid.desktop
	# Copy icon
	cp branding/icons/squiid512.png package-build/squiid.AppDir/squiid.png
	cp branding/icons/squiid512.png package-build/squiid.AppDir/usr/share/icons/squiid.png
	# Download and add kitty terminal to appimage
	curl -L https://github.com/kovidgoyal/kitty/releases/download/v0.38.1/kitty-0.38.1-x86_64.txz -o package-build/kitty.txz
	# Untar kitty
	tar -xf package-build/kitty.txz --directory package-build/squiid.AppDir/usr/
	# Make sure kitty is executable
	chmod +x package-build/squiid.AppDir/usr/bin/kitty
	# Copy kitty config
	cp packages/appimage/kitty.conf package-build/squiid.AppDir/kitty.conf
	# Remove unneeded kitty components
	rm package-build/squiid.AppDir/usr/bin/kitten
	rm -rf package-build/squiid.AppDir/usr/share/applications
	rm -rf package-build/squiid.AppDir/usr/share/doc
	rm -rf package-build/squiid.AppDir/usr/share/man
	rm -rf package-build/squiid.AppDir/usr/share/icons
	# Build appimage
	$(APPIMAGETOOL) package-build/squiid.AppDir package-build/Squiid_Calculator.AppImage

windows-build: require-cargo clean ## Cross compile the Windows release
	# cross compile windows version
	$(CARGO) build --release --target=x86_64-pc-windows-gnu

ifndef skip_build
windows-installer: windows-build
endif
windows-installer: clean ## Build the Windows installer
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	# bundle assets
	mkdir -p package-build
	cp packages/windows/squiid.iss package-build/
	@envsubst '$${VERSION}' < packages/windows/squiid.iss > package-build/squiid.iss
	cp packages/windows/modpath.iss package-build/
	cp branding/squiidsquare.ico package-build/
	cp LICENSE package-build/LICENSE.txt
	cp target/x86_64-pc-windows-gnu/release/squiid.exe package-build

	# build the windows installer with an output directory of the current directory
	if [ "$(skip_build)" != "1" ]; then \
		@docker --version > /dev/null 2>&1 || (echo "ERROR: docker is required"; exit 1); \
		docker run --rm -i -v "$$PWD/package-build:/work" amake/innosetup squiid.iss /O.\\; \
	fi

# ANDROID
# TODO: fix android building
android-require: require-cargo
ifndef platform
	# check if platform= argument is defined
	@echo "ERROR: platform is not defined. please specify an android ndk version with platform=xx (for example, 33)"
	exit 1
endif
	# check if cargo ndk is installed
	@$(CARGO) ndk --version > /dev/null 2>&1 || (echo "ERROR: cargo-ndk is required. Install it with `cargo install cargo-ndk`"; exit 1)

android-armv8: export TARGET_CMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake
android-armv8: android-require ## Build the Android ARMv8 release
	@echo "Android armv8 building is currently broken"; exit 1
	RUST_LOG=debug $(CARGO) ndk --platform $(platform) --target arm64-v8a build --release

android-armv7: export TARGET_CMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake
android-armv7: ## Build the Android ARMv7 release
	$(CARGO) build --target armv7-linux-androideabi --release

android-x86_64: export TARGET_CMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake
android-x86_64: android-require ## Build the Android x86_64 release
	@echo "Android x86_64 building is currently broken"; exit 1
	$(CARGO) ndk --platform $(platform) --target x86_64 build --release

android: export TARGET_CMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake
android: android-armv8 android-armv7 android-x86_64 ## Build all android targets

aur-metadata: clean ## Build the AUR metadata files for deployment
	# check for makepkg
	@makepkg --version > /dev/null 2>&1 || (echo "ERROR: makepkg is required"; exit 1)
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	mkdir -p package-build/
	@envsubst '$${VERSION}' < packages/arch/PKGBUILD > package-build/PKGBUILD
	# retrieve sha512sum of source
	export SHA512SUM=$$(curl -sL $$(cd package-build; makepkg --printsrcinfo | grep -oP 'source = \K.*') | sha512sum | awk '{print $$1}'); \
	envsubst '$${SHA512SUM}' < package-build/PKGBUILD > package-build/PKGBUILD-new

	mv package-build/PKGBUILD-new package-build/PKGBUILD

	cd package-build; makepkg --printsrcinfo > .SRCINFO

arch-package: require-cargo aur-metadata ## Build an Arch package
	cd package-build; makepkg -s

homebrew: clean ## Format the homebrew metadata
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	mkdir -p package-build/
	@envsubst '$${VERSION}' < packages/homebrew/squiid.rb > package-build/squiid.rb
	# retrieve sha256sum of source
	export SHA256SUM=$$(curl -sL $$(awk -F '"' '/url/ {print $$2}' package-build/squiid.rb) | sha256sum | awk '{print $$1}'); \
	export BOTTLE=$$(curl -sL "https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/s/squiid.rb" | sed -n '/bottle do/, /end/p'); \
	envsubst '$${SHA256SUM} $${BOTTLE}' < package-build/squiid.rb > package-build/squiid.new

	mv package-build/squiid.new package-build/squiid.rb

	@echo "squiid.rb can be found in the package-build/ directory"
	@echo "Commit it to your branch of homebrew-core to update"

rpm: require-cargo clean ## Create the RPM spec file
	@envsubst --version >/dev/null 2>&1 || (echo "ERROR: envsubst is required."; exit 1)

	mkdir -p package-build

	@envsubst '$${VERSION}' < packages/fedora/squiid.spec > package-build/squiid.spec

winget: ## Create the winget metadata files
ifndef forkpath
	# check if forkpath= argument is defined
	@echo "ERROR: forkpath is not defined. please specify a path to your winget-pkgs fork with forkpath=xx"
	exit 1
endif
ifndef installerurl
	# check if installerurl= argument is defined
	@echo "ERROR: installerurl is not defined. please specify a url to the windows installer"
	exit 1
endif
	mkdir -p "$(forkpath)/manifests/i/ImaginaryInfinity/Squiid/${VERSION}/"
	export sha256=$$(curl -sL $${installerurl} | sha256sum | awk '{print $$1}'); \
	envsubst '$${VERSION} $${installerurl} $${sha256}' < packages/winget/ImaginaryInfinity.Squiid.installer.yaml > "$(forkpath)/manifests/i/ImaginaryInfinity/Squiid/${VERSION}/ImaginaryInfinity.Squiid.installer.yaml"
	@envsubst '$${VERSION}' < packages/winget/ImaginaryInfinity.Squiid.locale.en-US.yaml > "$(forkpath)/manifests/i/ImaginaryInfinity/Squiid/${VERSION}/ImaginaryInfinity.Squiid.locale.en-US.yaml"
	@envsubst '$${VERSION}' < packages/winget/ImaginaryInfinity.Squiid.yaml > "$(forkpath)/manifests/i/ImaginaryInfinity/Squiid/${VERSION}/ImaginaryInfinity.Squiid.yaml"
	cd "$(forkpath)"; \
	git add .; \
	git commit -m 'New version: Squiid version ${VERSION}'

define generate_rule
setup-deb-files-$(1): clean
	@git --version > /dev/null 2>&1 || (echo "ERROR: git is required"; exit 1)
	@tar --version > /dev/null 2>&1 || (echo "ERROR: debuild is required"; exit 1)
	@python3 --version > /dev/null 2>&1 || (echo "ERROR: python is required"; exit 1)

	mkdir -p package-build/

	# create archive for deb and extract it into package-build
	git archive --format=tar.gz -o squiid_${VERSION}-1.orig.tar.gz --prefix=squiid-${VERSION}-1/ $(2)
	tar -xzf squiid_${VERSION}-1.orig.tar.gz -C package-build/ --strip-components=1

	cp -r package-build/packages/debian/ package-build/
	python3 packages/debian/generate_changelog.py $(1) > package-build/debian/changelog
endef

RELEASES := bionic focal jammy
$(foreach release,$(RELEASES),$(eval $(call generate_rule,$(release),$(shell git rev-parse --abbrev-ref HEAD))))

deb: setup-deb-files-bionic ## Build a deb
	@debuild --version > /dev/null 2>&1 || (echo "ERROR: debuild is required"; exit 1)
	# sed -i 's/make build/make build-musl/' package-build/debian/rules
	cd package-build; dpkg-buildpackage -b -d -us -uc $(DEBUILD_OPTIONS)

ppa: setup-deb-files-bionic ## Create PPA changes file
	@debuild --version > /dev/null 2>&1 || (echo "ERROR: debuild is required"; exit 1)
	cd package-build; debuild -S -sa $(DEBUILD_OPTIONS)