Xrasher/engine/wscript

#! /usr/bin/env python
# encoding: utf-8
# mittorn, 2018

from waflib import Logs
from waflib.extras import pthread
import os
from copy import copy

top = '.'

EXECINFO_TEST = '''#include <execinfo.h>
int main(int argc, char **argv)
{
	backtrace(0, 0);
	backtrace_symbols(0, 0);
	return 0;
}
'''

def options(opt):
	grp = opt.add_option_group('Engine options')

	grp.add_option('--enable-fbdev', action = 'store_true', dest = 'FBDEV_SW', default = False,
		help = 'build fbdev-only software-only engine')

	grp.add_option('--disable-async-resolve', action = 'store_true', dest = 'NO_ASYNC_RESOLVE', default = False,
		help = 'disable multithreaded operations(asynchronous name resolution)')

	grp.add_option('--enable-custom-swap', action = 'store_true', dest = 'CUSTOM_SWAP', default = False,
		help = 'enable custom swap allocator. For devices with no swap support')

	grp.add_option('--enable-legacy-sdl', action = 'store_true', dest = 'SDL12', default = False,
		help = 'enable using SDL1.2 instead of SDL2(not recommended) [default: %(default)s]')

	grp.add_option('--enable-static-binary', action = 'store_true', dest = 'STATIC', default = False,
		help = 'build static binary(not recommended, --single-binary required) [default: %(default)s]')

	grp.add_option('--enable-engine-tests', action = 'store_true', dest = 'ENGINE_TESTS', default = False,
		help = 'embed tests into the engine, jump into them by -runtests command line switch [default: %(default)s]')

	grp.add_option('--enable-engine-fuzz', action = 'store_true', dest = 'ENGINE_FUZZ', default = False,
		help = 'add LLVM libFuzzer [default: %(default)s]' )

	grp.add_option('--enable-ffmpeg', action = 'store_true', dest = 'FFMPEG', default = False,
		help = '') # hidden option, does nothing

	opt.load('sdl2')

def find_sdl(conf):
	err_msg = '%s not available! If you want to build dedicated server, specify --dedicated'
	if conf.env.DEST_OS in ['nswitch', 'psvita']:
		err_msg = '%s not available!'

	conf.load('sdl2')
	if conf.options.SDL3:
		if not conf.env.HAVE_SDL3:
			conf.fatal(err_msg % 'SDL3')
		conf.env.XASH_SDL = 3
	else:
		if not conf.env.HAVE_SDL2:
			conf.fatal(err_msg % 'SDL2')
		conf.env.XASH_SDL = 2

def configure(conf):
	# Common dependencies, will be linked to both dedicated server and client
	if conf.env.DEST_OS == 'linux':
		conf.check_cc(lib='rt')
		if conf.env.MAGX:
			conf.define('XASH_CRASHHANDLER', 0)
	elif conf.env.DEST_OS == 'haiku':
		conf.env.LIB_HAIKU = ['network']
		conf.env.LIBPATH_HAIKU = ['/boot/system/lib']
	elif conf.env.DEST_OS == 'wasi':
		conf.options.NO_ASYNC_RESOLVE = True
		conf.env.CFLAGS += ['-mllvm', '-wasm-enable-sjlj']
	elif conf.env.DEST_OS == 'sunos':
		conf.check_cc(lib='socket')
	elif conf.env.DEST_OS == 'dos':
		conf.options.STATIC = True
		conf.options.NO_ASYNC_RESOLVE = True

	if conf.options.ENGINE_FUZZ:
		conf.env.append_unique('CFLAGS', '-fsanitize=fuzzer-no-link')
		conf.env.append_unique('LINKFLAGS', '-fsanitize=fuzzer')

	# Client-only dependencies
	if conf.env.CLIENT:
		if conf.env.DEST_OS in ['nswitch', 'psvita']:
			extra_libs = ['-lm']
			if conf.env.DEST_OS == 'psvita':
				extra_libs = ['-lstdc++', '-lm', '-lSceShaccCgExt', '-lSceShaccCg_stub', '-ltaihen_stub', '-lSceKernelDmacMgr_stub']

			conf.env.append_unique('CXXFLAGS', ['-Wl,--no-undefined'])
			conf.env.append_unique('CFLAGS', ['-Wl,--no-undefined'])

			conf.env.LDFLAGS += extra_libs
			find_sdl(conf)
			for lib in extra_libs: conf.env.LDFLAGS.remove(lib)

			if conf.env.DEST_OS == 'nswitch': # remove libstdc++ linking from SDL2, we link it later
				conf.env.LIB_SDL2.remove('stdc++')
		elif conf.env.DEST_OS == 'linux' and conf.options.FBDEV_SW:
			conf.check_cc(lib='asound')
		elif conf.options.SDL12: # TODO: move to sdl2.py
			conf.check_cfg(package='sdl', args='--cflags --libs', uselib_store='SDL2')
			conf.env.XASH_SDL = 12
			conf.env.HAVE_SDL2 = True
		else:
			find_sdl(conf)


	if conf.options.STATIC:
		conf.env.STATIC = True
		conf.define('XASH_NO_LIBDL', 1)

	if not conf.env.DEST_OS in ['win32', 'android'] and not conf.options.NO_ASYNC_RESOLVE:
		conf.check_pthreads(mode='c')

	if hasattr(conf.options, 'DLLEMU'):
		conf.define_cond('XASH_DLL_LOADER', conf.options.DLLEMU)

	conf.check_cc(fragment=EXECINFO_TEST, msg='Checking for glibc backtrace()', mandatory=False, define_name='HAVE_EXECINFO')

	conf.define('ENGINE_DLL', 1)
	conf.define_cond('XASH_ENGINE_TESTS', conf.options.ENGINE_TESTS)
	conf.define_cond('XASH_STATIC_LIBS', conf.env.STATIC_LINKING)
	conf.define_cond('XASH_CUSTOM_SWAP', conf.options.CUSTOM_SWAP)
	conf.define_cond('XASH_NO_ASYNC_NS_RESOLVE', conf.options.NO_ASYNC_RESOLVE)
	conf.define_cond('PSAPI_VERSION', conf.env.DEST_OS == 'win32') # will be defined as 1

	for refdll in conf.refdlls:
		refdll.register_define(conf)

def build(bld):
	# public includes for renderers and utils use
	bld(name = 'engine_includes', export_includes = '. common common/imagelib', use = 'filesystem_includes')

	libs = ['engine_includes', 'public', 'dllemu', 'werror', 'backtrace']
	includes = ['server', 'client', 'client/vgui', 'common/soundlib']

	# basic build: dedicated only
	source = bld.path.ant_glob(['common/*.c', 'common/imagelib/*.c', 'common/soundlib/*.c', 'server/*.c'])

	# include platform-specific sources, this shall not fail if directory doesn't exist
	source += bld.path.ant_glob('platform/%s/*.c' % bld.env.DEST_OS)

	# Android _is_ Linux based, after all
	if bld.env.DEST_OS == 'android':
		source += bld.path.ant_glob('platform/linux/*.c')

	# include common POSIX conformant code
	if bld.env.DEST_OS not in ['win32', 'dos']:
		source += bld.path.ant_glob('platform/posix/*.c')

	# include sources for optional features
	if bld.get_define('XASH_CUSTOM_SWAP'):
		source += ['platform/misc/kmalloc.c', 'platform/misc/sbrk.c']

	if bld.get_define('XASH_STATIC_LIBS'):
		source += ['platform/misc/lib_static.c']

	if bld.env.DEST_OS == 'win32':
		libs += ['USER32', 'SHELL32', 'GDI32', 'ADVAPI32', 'DBGHELP', 'PSAPI', 'WS2_32']
	elif bld.env.DEST_OS == 'nswitch':
		libs += ['SOLDER']
		# HACK: link in the entirety of libstdc++ so that dynamic libs could use all of it without manual exporting
		# we can't do this right away because std::filesystem will complain about not having pathconf(),
		# which we have defined in sys_nswitch.c
		bld.env.LDFLAGS += ['-v', '-Wl,--whole-archive', '-lstdc++', '-Wl,--no-whole-archive', '-lm']
	elif bld.env.DEST_OS == 'psvita':
		libs += ['VRTLD']
		# HACK: link in the entirety of libstdc++ so that dynamic libs could use all of it without manual exporting
		# also link in all the funky dependencies that aren't in SDL2's LDFLAGS
		bld.env.LDFLAGS += ['-Wl,--whole-archive', '-lstdc++', '-lpthread', '-Wl,--no-whole-archive',
			'-lm', '-lSceShaccCgExt', '-lkubridge_stub', '-ltaihen_stub', '-lSceShaccCg_stub', '-lSceKernelModulemgr_stub', '-lSceSblSsMgr_stub', '-lSceVshBridge_stub', '-lSceKernelDmacMgr_stub',
		]
	else: # POSIX
		libs += ['M', 'RT', 'PTHREAD', 'ASOUND', 'HAIKU', 'MAGX', 'LOG', 'SOCKET']
		if not bld.env.STATIC:
			libs += ['DL']

	if bld.env.SERVER:
		# TODO: avoid possible name collision when client is built without launcher
		# but dedicated server is enabled. They're both called 'xash' in this case
		bld.program(
			source = copy(source),
			target = 'xash',
			use = copy(libs),
			includes = includes,
			defines = 'XASH_ENABLE_MAIN=1 XASH_DEDICATED=1',
			rpath = bld.env.DEFAULT_RPATH,
			install_path = bld.env.BINDIR,
		)

	if bld.env.CLIENT:
		defines = []
		if bld.env.XASH_SDL:
			libs += ['SDL3' if bld.env.HAVE_SDL3 else 'SDL2']
			source += bld.path.ant_glob(['platform/sdl/*.c'])
			defines += ['XASH_SDL=%d' % bld.env.XASH_SDL]

		# add client files
		if not bld.env.DEDICATED:
			source += bld.path.ant_glob('client/**/*.c')
			libs += ['bzip2', 'MultiEmulator', 'opus', 'opusfile', 'vorbis', 'vorbisfile']

		# Android port is linked differently
		if bld.env.DEST_OS == 'android':
			f = bld.shlib
			install_path = bld.env.LIBDIR
			defines += ['XASH_ENABLE_MAIN=1', 'XASH_SDLMAIN=1']
		elif not bld.env.LAUNCHER:
			f = bld.program
			install_path = bld.env.BINDIR
			defines += ['XASH_ENABLE_MAIN=1']
		else:
			f = bld.shlib
			install_path = bld.env.LIBDIR

		if bld.env.DEST_OS in ['nswitch', 'psvita']:
			install_path = None

		f(source = source,
			target = 'xash',
			includes = includes,
			features = 'cxx c',
			use = libs,
			defines = defines,
			install_path = install_path,
			special_install_path = bld.env.BINDIR,
			nacp = 'platform/nswitch/xash3d-fwgs.nacp',
			icon = 'platform/nswitch/icon.jpg',
			sce_sys = 'platform/psvita/sce_sys',
			title_id = 'XASH10000',
			app_name = 'xash3d-fwgs',
			rpath = bld.env.DEFAULT_RPATH,
		)