1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
|
import multiprocessing
import os
import platform
import re
import shutil
import subprocess
import sys
import tarfile
import time
import zipfile
from urllib.request import urlretrieve
import config
def ensure_path(path):
"""Make sure a directory exists for a new file at path."""
path = os.path.dirname(path)
if not os.path.isdir(path):
os.makedirs(path)
def download_sdl2_win32(env):
"""Download the MinGW or VC development distribution from libsdl.org"""
if env.File("$SDL2_ZIP_PATH").exists():
return
print(env.subst("Downloading $SDL2_ZIP_URL"))
ensure_path(env.subst("$SDL2_ZIP_PATH"))
url, dest = env.subst("$SDL2_ZIP_URL"), env.subst("$SDL2_ZIP_PATH")
# workaround for https://github.com/SCons/scons/issues/3136
subprocess.check_call([sys.executable, "urlretrieve.py", url, dest])
def unpack_sdl2_win32(env):
"""Unpack an SDL2 zip/tar file."""
if env.Dir("$SDL2_PATH").exists():
if not GetOption("silent"):
print(env.subst("SDL2 already exists at $SDL2_PATH"))
return
download_sdl2_win32(env)
print(env.subst("Extracting $SDL2_ZIP_FILE to $DEPENDANCY_DIR"))
if env.subst("$SDL2_ZIP_FILE").endswith(".zip"):
zf = zipfile.ZipFile(env.subst("$SDL2_ZIP_PATH"), "r")
else:
zf = tarfile.open(env.subst("$SDL2_ZIP_PATH"), "r|*")
zf.extractall(env.subst("$DEPENDANCY_DIR"))
zf.close()
def download_sdl2_darwin(env):
"""Download the Mac OS/X distribution from libsdl.org"""
if env.File("$SDL2_DMG_PATH").exists():
return
print(env.subst("Downloading $SDL2_DMG_URL"))
ensure_path(env.subst("$SDL2_DMG_PATH"))
urlretrieve(env.subst("$SDL2_DMG_URL"), env.subst("$SDL2_DMG_PATH"))
def unpack_sdl2_darwin(env):
"""Unpack an SDL2 dmg file."""
if env.Dir("$SDL2_PATH").exists():
print(env.subst("SDL2 already exists at $SDL2_PATH"))
return
download_sdl2_darwin(env)
print(env.subst("Extracting $SDL2_DMG_PATH to $DEPENDANCY_DIR"))
subprocess.check_call(["hdiutil", "attach", env.subst("$SDL2_DMG_PATH")])
shutil.copytree(
"/Volumes/SDL2/SDL2.framework",
env.subst("$SDL2_PATH"),
symlinks=True,
)
subprocess.check_call(["hdiutil", "detach", "/Volumes/SDL2", "-force"])
def samples_factory():
"""Return a list of samples builders."""
samples = []
installers = []
env_samples = env.Clone()
env_samples.Append(
CPPPATH=["$VARIANT/src"],
)
if sys.platform != "darwin":
env_samples.Append(
LIBS=["SDL2", "SDL2main"],
)
if env["TOOLSET"] == "mingw":
# These might need to be statically linked somewhere.
env_samples.Append(LINKFLAGS=["-static-libgcc", "-static-libstdc++"])
if using_msvc:
env_samples.Append(LINKFLAGS=["/SUBSYSTEM:CONSOLE"])
if sys.platform == "win32":
env_samples.Append(LIBS=["libtcod"])
else:
env_samples.Append(LIBS=["tcod"])
for name in os.listdir(env.subst("$LIBTCOD_ROOT_DIR/samples")):
if name == "build":
continue
path = os.path.join(env.subst("$LIBTCOD_ROOT_DIR/samples"), name)
path_variant = os.path.join(env.subst("$VARIANT/samples"), name)
if os.path.isdir(path):
target = name
source = Glob(os.path.join(path_variant, "*.c")) + Glob(
os.path.join(path_variant, "*.cpp")
)
elif name[-2:] == ".c" or name[-4:] == ".cpp":
target = name.rsplit(".")[0]
source = path_variant
else:
continue
target = os.path.join("$VARIANT", target)
samples.append(
env_samples.Program(
target=target,
source=source,
)
)
env.Depends(samples, [libtcod])
return samples
def filtered_glob(env, pattern, omit=[], ondisk=True, source=False, strings=False):
"""Like Glob, but can omit specific files from the results."""
return [f for f in env.Glob(pattern) if os.path.basename(f.path) not in omit]
def get_libtcod_version():
"""Return the latest version number from the CHANGELOG."""
with open(
os.path.join(LIBTCOD_ROOT_DIR, "src/libtcod/version.h"), "r"
) as changelog:
# Grab the TCOD_STRVERSION literal from libtcod_version.h
return re.match(
r'.*#define TCOD_STRVERSION "([^"]+)"', changelog.read(), re.DOTALL
).groups()[0]
try:
SetOption("num_jobs", os.cpu_count() or 1)
except AttributeError:
pass
LIBTCOD_ROOT_DIR = "../.."
vars = Variables()
pre_vars = Environment(variables=vars)
vars.Add("MODE", "Set build variant.", "DEBUG")
default_toolset = "msvc" if sys.platform == "win32" else "default"
vars.Add(
EnumVariable(
"TOOLSET",
"Force using this compiler. (Windows only)",
default_toolset,
("default", "msvc", "mingw"),
)
)
vars.Add("CCFLAGS", "Compiler flags", "")
vars.Add("CFLAGS", "C flags", "")
vars.Add("CXXFLAGS", "C++ flags", "")
vars.Add("LINKFLAGS", "Linker flags", "")
ARCH_OPTIONS = ("x86", "x86_64")
ARCH_DEFAULT = "x86" if platform.architecture()[0] == "32bit" else "x86_64"
if sys.platform == "darwin":
ARCH_OPTIONS += ("x86.x86_64", "arm64", "universal2")
ARCH_DEFAULT = "universal2"
vars.Add(
EnumVariable(
"ARCH",
"Set target architecture.",
ARCH_DEFAULT,
allowed_values=ARCH_OPTIONS,
)
)
# A dummy environment to check the current variables so far.
env_vars = Environment(variables=vars)
if env_vars["TOOLSET"] == "default":
default_tag = "$VERSION-$ARCH"
windows_toolset = "msvc"
else:
default_tag = "$VERSION-$ARCH-$TOOLSET"
windows_toolset = env_vars["TOOLSET"]
if env_vars["MODE"].upper() != "DEBUG_RELEASE":
default_tag += "-$MODE"
if sys.platform == "darwin":
default_tag += "-macos"
vars.Add("TAG", "Variant tag.", default_tag)
vars.Add(
"CPPDEFINES",
"Defined preprocessor values.",
"",
)
vars.Add("VERSION", "libtcod version.", get_libtcod_version())
vars.Add("DIST_NAME", "Name of the output zip file.", "$VARIANT")
if sys.platform == "win32":
DEPENDANCY_DIR = "./dependencies/$WINDOWS_TOOLSET"
elif sys.platform == "darwin":
DEPENDANCY_DIR = "./Frameworks"
else:
DEPENDANCY_DIR = "./dependencies"
vars.Add("DEPENDANCY_DIR", "Directory to cache SDL2.", DEPENDANCY_DIR)
if sys.platform == "darwin":
vars.Add("SDL2_VERSION", "SDL version to fetch. (Mac Only)", "2.0.14")
else:
vars.Add("SDL2_VERSION", "SDL version to fetch. (Windows)", "2.0.8")
vars.Add(
EnumVariable(
"SOURCE_FILES",
(
"Auto-detect which source files to compile, "
"or use libtcod_c.c and libtcod.cpp"
),
"auto",
allowed_values=("auto", "static"),
)
)
vars.Add("INSTALL_DIR", "Installation directory.", "/usr/local")
vars.Add(
BoolVariable(
key="LIBRARY_DEPRECATION",
help="Show deprecation warnings in library sources.",
default=False,
)
)
vars.Add(
BoolVariable(
key="NO_SDL",
help="Disable linking to SDL and any dependent functions.",
default=False,
)
)
if windows_toolset == "msvc":
sdl2_zip_file = "SDL2-devel-$SDL2_VERSION-VC.zip"
else:
sdl2_zip_file = "SDL2-devel-$SDL2_VERSION-mingw.tar.gz"
if sys.platform == "win32":
sdl2_path = "$DEPENDANCY_DIR/SDL2-$SDL2_VERSION"
elif sys.platform == "darwin":
sdl2_path = "$DEPENDANCY_DIR/SDL2.framework"
else:
sdl2_path = ""
TOOLSETS = {
"default": ["default"],
"msvc": ["msvc", "mslink"],
"mingw": ["mingw"],
}
env = Environment(
tools=TOOLSETS[env_vars["TOOLSET"].lower()] + ["tar", "zip"],
WINDOWS_TOOLSET=windows_toolset,
variables=vars,
ENV=os.environ,
LIBTCOD_ROOT_DIR=LIBTCOD_ROOT_DIR,
DEVELOP_DIR="$LIBTCOD_ROOT_DIR",
CPPPATH=["$VARIANT/src/vendor/zlib"],
LIBPATH=["$VARIANT"],
VARIANT="libtcod-$TAG",
DATE=time.strftime("%Y-%m-%d"),
DATETIME=time.strftime("%Y-%m-%d-%H%M%S"),
TARGET_ARCH=env_vars["ARCH"],
SDL2_PATH=sdl2_path,
SDL2_ZIP_FILE=sdl2_zip_file,
SDL2_ZIP_PATH="$DEPENDANCY_DIR/$SDL2_ZIP_FILE",
SDL2_ZIP_URL="https://www.libsdl.org/release/$SDL2_ZIP_FILE",
SDL2_DMG_FILE="SDL2-${SDL2_VERSION}.dmg",
SDL2_DMG_PATH="$DEPENDANCY_DIR/$SDL2_DMG_FILE",
SDL2_DMG_URL="https://www.libsdl.org/release/$SDL2_DMG_FILE",
)
env.AddMethod(filtered_glob, "FilteredGlob")
env["CCFLAGS"] = Split(env["CCFLAGS"])
env["CFLAGS"] = Split(env["CFLAGS"])
env["CXXFLAGS"] = Split(env["CXXFLAGS"])
env["LINKFLAGS"] = Split(env["LINKFLAGS"])
env["CPPDEFINES"] = Split(env["CPPDEFINES"])
# Prefer os.environ compilers.
env["CC"] = os.environ.get("CC", env["CC"])
env["CXX"] = os.environ.get("CXX", env["CXX"])
if sys.platform != "darwin":
# Removing the lib prefix on Mac causes a link failure.
env.Replace(LIBPREFIX="", SHLIBPREFIX="")
if env["ARCH"] == "universal2":
env["SDL_ARCH"] = ["x64", "arm64"]
env["SDL_MINGW_ARCH"] = ["x86_64", "arm64"]
if env["ARCH"] == "arm64":
env["SDL_ARCH"] = "arm64"
env["SDL_MINGW_ARCH"] = "arm64"
else:
env["SDL_ARCH"] = "x86" if env["ARCH"] == "x86" else "x64"
env["SDL_MINGW_ARCH"] = "i686" if env["SDL_ARCH"] == "x86" else "x86_64"
using_msvc = env["CC"] == "cl"
CONFIG_NAME = "%s_%s" % (env["MODE"].upper(), "MSVC" if using_msvc else "GCC")
env.Prepend(**getattr(config, CONFIG_NAME))
sdl_package = []
sdl_install = []
if using_msvc:
env.Prepend(CXXFLAGS=["-EHsc"])
if not using_msvc:
env.Prepend(CFLAGS=["-std=c99"], CXXFLAGS=["-std=c++17"])
if using_msvc:
env.Append(CPPDEFINES=["_CRT_SECURE_NO_WARNINGS"])
if env["NO_SDL"]:
# Skip collecting and setting up the SDL library.
env.Append(CPPDEFINES=["NO_SDL"])
elif sys.platform == "win32":
unpack_sdl2_win32(env)
env.Append(LIBS=["User32"])
if env["WINDOWS_TOOLSET"] == "msvc":
env.Append(CPPPATH=["$SDL2_PATH/include"], LIBPATH=["$SDL2_PATH/lib/$SDL_ARCH"])
sdl_install = env.Install("$DEVELOP_DIR", "$SDL2_PATH/lib/$SDL_ARCH/SDL2.dll")
sdl_package = env.Install("$VARIANT", "$SDL2_PATH/lib/$SDL_ARCH/SDL2.dll")
else:
# I couldn't get sdl2-config to run on Windows
# `sdl2-config --cflags --libs` is manually unpacked here
env.Append(
CPPPATH=["$SDL2_PATH/$SDL_MINGW_ARCH-w64-mingw32/include/SDL2"],
LIBPATH=["$SDL2_PATH/$SDL_MINGW_ARCH-w64-mingw32/lib"],
CCFLAGS=["-mwindows"],
LIBS=["mingw32", "SDL2main", "SDL2"],
)
sdl_install = env.Install(
"$DEVELOP_DIR", "$SDL2_PATH/$SDL_MINGW_ARCH-w64-mingw32/bin/SDL2.dll"
)
sdl_package = env.Install(
"$VARIANT", "$SDL2_PATH/$SDL_MINGW_ARCH-w64-mingw32/bin/SDL2.dll"
)
elif sys.platform == "darwin":
unpack_sdl2_darwin(env)
env.Append(CPPPATH=["$SDL2_PATH/Headers"])
sdl_install = env.Install("$DEVELOP_DIR", "$SDL2_PATH")
sdl_package = env.Install("$VARIANT", "$SDL2_PATH")
else:
env.ParseConfig("sdl2-config --cflags --libs")
env.Append(LIBS=["m"])
if sys.platform == "darwin":
OSX_FLAGS = []
if env["ARCH"] == "x86" or env["ARCH"] == "x86.x86_64":
OSX_FLAGS.extend(["-arch", "i386"])
if env["ARCH"] == "x86_64" or env["ARCH"] == "x86.x86_64":
OSX_FLAGS.extend(["-arch", "x86_64"])
if env["ARCH"] == "arm64":
OSX_FLAGS.extend(["-arch", "arm64"])
if env["ARCH"] == "universal2":
OSX_FLAGS.extend(["-arch", "x86_64"])
OSX_FLAGS.extend(["-arch", "arm64"])
env.Append(CCFLAGS=OSX_FLAGS, LINKFLAGS=OSX_FLAGS)
# Only '@loader_path/' is actually needed for the release archive.
env.Append(
LINKFLAGS=[
"-framework",
"ApplicationServices",
"-framework",
"SDL2",
"-F$SDL2_PATH/..",
"-rpath",
"@loader_path/",
"-rpath",
"@loader_path/../Frameworks",
"-rpath",
"/Library/Frameworks",
"-rpath",
"/System/Library/Frameworks",
]
)
if (sys.platform != "darwin" and sys.platform != "win32") or env["TOOLSET"] == "mingw":
arch_flags = ["-m32"] if env["ARCH"] == "x86" else ["-m64"]
env.Append(CCFLAGS=arch_flags, LINKFLAGS=arch_flags)
# Duplicate only on dist.
env.VariantDir(
"$VARIANT", "$LIBTCOD_ROOT_DIR", duplicate="dist" in COMMAND_LINE_TARGETS
)
env.VariantDir(
"$VARIANT/include",
"$LIBTCOD_ROOT_DIR/src",
duplicate="dist" in COMMAND_LINE_TARGETS,
)
env_libtcod = env.Clone()
env_libtcod.Append(
CPPPATH=["../../src/vendor", "../../src/vendor/utf8proc"],
)
if sys.platform != "darwin":
env_libtcod.Append(LIBS=["SDL2"])
# Which source files to compile into the main libtcod shared library.
libtcod_sources = {
# Compiles all source files under src/libtcod
"auto": {
"source": (
env.Glob("$VARIANT/src/libtcod/*.c")
+ env.Glob("$VARIANT/src/libtcod/*/*.c")
+ ([] if env["NO_SDL"] else env.Glob("$VARIANT/src/libtcod/*.cpp"))
+ ([] if env["NO_SDL"] else env.Glob("$VARIANT/src/libtcod/*/*.cpp"))
),
"vendor": (
env.Glob("$VARIANT/src/vendor/*.c")
+ ["$VARIANT/src/vendor/utf8proc/utf8proc.c"]
+ env.Glob("$VARIANT/src/vendor/zlib/*.c"),
),
},
# libtcod_c.c and libtcod.cpp are helper sources that include all other
# files needed to build libtcod.
"static": {
"source": ["$VARIANT/src/libtcod_c.c", "$VARIANT/src/libtcod.cpp"],
"vendor": (
# Bundle zlib sources.
env.Glob("$VARIANT/src/vendor/zlib/*.c")
# Bundle lodepng.
+ ["$VARIANT/src/vendor/lodepng.cpp"]
+ ["$VARIANT/src/vendor/utf8proc/utf8proc.c"]
),
},
}
env_vendored = env_libtcod.Clone()
env_vendored.Append(
CCFLAGS=["-w"], # Hide all warnings for vendored sources.
PDB=["$VARIANT/libtcod.pdb"],
)
vendors = env_vendored.SharedObject(
source=libtcod_sources[env["SOURCE_FILES"]]["vendor"],
)
env_libtcod_dll = env_libtcod.Clone()
env_libtcod_dll.Append(
CPPDEFINES=["LIBTCOD_EXPORTS"],
PDB=["$VARIANT/libtcod.pdb"],
)
if not using_msvc and not env["LIBRARY_DEPRECATION"]:
env_libtcod_dll.Append(
CCFLAGS=["-Wno-deprecated", "-Wno-deprecated-declarations"],
)
libtcod = env_libtcod_dll.SharedLibrary(
target="$VARIANT/libtcod",
source=libtcod_sources[env["SOURCE_FILES"]]["source"] + vendors,
)
if sys.platform == "darwin":
env_libtcod_dll.Append(LINKFLAGS=["-install_name", "@rpath/libtcod.dylib"])
lib_build = [libtcod]
lib_develop = env.Install("$DEVELOP_DIR", lib_build) + sdl_install
Alias("build_libtcod", lib_build)
Alias("develop_libtcod", lib_develop)
samples_builders = samples_factory()
samples_develop = env.Install("$DEVELOP_DIR", samples_builders)
Alias("build_samples", samples_builders)
Alias("develop_samples", lib_develop + samples_develop)
package_files = (
lib_build
+ samples_builders
+ sdl_package
+ env.Glob("$VARIANT/*.md")
+ env.Glob("$VARIANT/*.txt")
+ env.Glob("$VARIANT/*.png")
+ env.Glob("$VARIANT/data/**/*.*")
+ env.Glob("$VARIANT/doc/**/*.*")
+ env.Glob("$VARIANT/include/*.h*")
+ env.Glob("$VARIANT/include/libtcod/*.h*")
+ env.Glob("$VARIANT/include/libtcod/*/*.h*")
+ env.Glob("$VARIANT/python/*.py")
+ env.Glob("$VARIANT/python/**/*.py")
+ env.Glob("$VARIANT/python/**.pyproj")
+ env.Glob("$VARIANT/python/**.cfg")
+ env.Glob("$VARIANT/python/**.in")
+ env.Glob("$VARIANT/samples/*.c*")
+ env.Glob("$VARIANT/samples/**/*.c*")
+ env.Glob("$VARIANT/samples/**/*.h*")
+ env.Glob("$VARIANT/samples/**/*.png")
+ env.Glob("$VARIANT/samples/**/*.txt")
)
if sys.platform == "win32":
zip = env.Zip("${DIST_NAME}.zip", package_files)
else:
env.Append(TARFLAGS="-z --format=ustar")
zip = env.Tar("${DIST_NAME}.tar.gz", package_files)
Alias("dist", zip)
Alias("build", ["build_libtcod"])
Alias("develop", ["develop_libtcod"])
Alias("build_all", ["build_libtcod", "build_samples"])
Alias("develop_all", ["develop_libtcod", "develop_samples"])
Default(None)
Help(vars.GenerateHelpText(env))
|