paczek/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Activity

Use pkg-config more extensively in build

Browse Source 
We now make use of `pkg-config` on Linux, BSD, and macOS systems to find
the headers and libs for the following dependencies, where we weren't
previously:

* `enet`
* `fmt` (on macOS only)
* `gloox`'s dependencies on macOS:
    * `gnutls`
    * `gmp`
    * `nettle`
* `libcurl`
* `libogg`
* `libsodium`
* `miniupnpc` (on macOS only)
* `openAL`
* `openGL`
* `vorbis`
* `zlib`

Please see revision (https://code.wildfiregames.com/D3611) for details.

NOTE: All those building on macOS will need to rebuild their libraries
(`build-osx-libs.sh --force-rebuild`)


Tested by: Langbart (macOS), Freagarach (Ubuntu 18.04), Jenkins CI
(Debian Buster)
Comments by: Stan, wraitii, Freagarach
Differential Revision: https://code.wildfiregames.com/D3611
This was SVN commit r25938.
This commit is contained in:
s0600204 2021-09-23 16:10:25 +00:00
parent 0e599a3176
commit 7382a4885b
4 changed files with 188 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

242
build/premake/extern_libs5.lua
View File

@ -39,6 +39,11 @@ end
pkgconfig = require "pkgconfig"
-- Configure pkgconfig for MacOSX systems
if os.istarget("macosx") then
pkgconfig.additional_pc_path = libraries_dir .. "pkgconfig/"
pkgconfig.static_link_libs = true
end
local function add_delayload(name, suffix, def)
@ -228,18 +233,21 @@ extern_lib_defs = {
},
enet = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("enet")
else
pkgconfig.add_includes("libenet")
end
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_lib_paths("enet")
add_default_links({
win_names = { "enet" },
})
else
pkgconfig.add_links("libenet")
end
add_default_links({
win_names = { "enet" },
unix_names = { "enet" },
})
end,
},
fcollada = {
@ -265,16 +273,18 @@ extern_lib_defs = {
},
fmt = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("fmt")
elseif os.istarget("macosx") then
pkgconfig.add_includes("fmt")
end
-- With Linux & BSD, we assume that fmt is installed in a standard location.
--
-- It would be nice to not assume, and to instead use pkgconfig: however that
-- It would be nice to not assume, and to instead use pkg-config: however that
-- requires fmt 5.3.0 or greater.
--
-- Unfortunately (at the time of writing) only 69 out of 95 (~72.6%) of distros
-- Unfortunately (at the time of writing) only 92 out of 114 (~80.7%) of distros
-- that provide a fmt package meet this, according to
-- https://repology.org/badge/vertical-allrepos/fmt.svg?minversion=5.3
--
@ -284,27 +294,23 @@ extern_lib_defs = {
-- Mint).
--
-- When fmt 5.3 (or better) becomes more widely used, then we can safely use the
-- following line:
-- pkgconfig.add_includes("fmt")
-- same line as we currently use for osx
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
add_default_lib_paths("fmt")
end
if os.istarget("windows") then
add_default_lib_paths("fmt")
add_default_links({
win_names = { "fmt" },
dbg_suffix = "d",
no_delayload = 1,
})
elseif os.istarget("macosx") then
-- See comment above as to why this is not also used on Linux or BSD.
pkgconfig.add_links("fmt")
else
add_default_links({
unix_names = { "fmt" },
})
-- See comment above as to why this is commented out.
-- pkgconfig.add_links("fmt")
end
end
},
@ -313,9 +319,7 @@ extern_lib_defs = {
if os.istarget("windows") then
add_default_include_paths("gloox")
else
-- Support GLOOX_CONFIG for overriding the default (pkg-config --cflags gloox)
-- i.e. on OSX where it gets set in update-workspaces.sh
pkgconfig.add_includes("gloox", os.getenv("GLOOX_CONFIG"))
pkgconfig.add_includes("gloox")
end
end,
link_settings = function()
@ -326,17 +330,12 @@ extern_lib_defs = {
no_delayload = 1,
})
else
pkgconfig.add_links("gloox", os.getenv("GLOOX_CONFIG"))
pkgconfig.add_links("gloox")
if os.istarget("macosx") then
-- Manually add gnutls dependencies, those are not present in gloox's pkg-config
add_default_lib_paths("nettle")
add_default_lib_paths("gmp")
add_default_links({
osx_names = { "nettle", "hogweed", "gmp" },
})
-- gloox depends on gnutls, but doesn't identify this via pkg-config
pkgconfig.add_links("gnutls")
end
end
end,
},
@ -373,9 +372,7 @@ extern_lib_defs = {
if os.istarget("windows") then
add_default_include_paths("icu")
else
-- Support ICU_CONFIG for overriding the default (pkg-config --cflags icu-i18n)
-- i.e. on OSX where it gets set in update-workspaces.sh
pkgconfig.add_includes("icu-i18n", os.getenv("ICU_CONFIG"), "--cppflags")
pkgconfig.add_includes("icu-i18n")
end
end,
link_settings = function()
@ -387,25 +384,27 @@ extern_lib_defs = {
no_delayload = 1,
})
else
pkgconfig.add_links("icu-i18n", os.getenv("ICU_CONFIG"), "--ldflags-searchpath --ldflags-libsonly --ldflags-system")
pkgconfig.add_links("icu-i18n")
end
end,
},
libcurl = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("libcurl")
else
pkgconfig.add_includes("libcurl")
end
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_lib_paths("libcurl")
else
pkgconfig.add_links("libcurl")
end
add_default_links({
win_names = { "libcurl" },
unix_names = { "curl" },
osx_names = { "curl", "z" },
osx_frameworks = { "Security" }
osx_frameworks = { "Security" }, -- Not supplied by curl's pkg-config
})
end,
},
@ -414,9 +413,7 @@ extern_lib_defs = {
if os.istarget("windows") then
add_default_include_paths("libpng")
else
-- Support LIBPNG_CONFIG for overriding the default (pkg-config --cflags libpng)
-- i.e. on OSX where it gets set in update-workspaces.sh
pkgconfig.add_includes("libpng", os.getenv("LIBPNG_CONFIG"))
pkgconfig.add_includes("libpng")
end
end,
link_settings = function()
@ -426,24 +423,27 @@ extern_lib_defs = {
win_names = { "libpng16" },
})
else
pkgconfig.add_links("libpng", os.getenv("LIBPNG_CONFIG"), "--ldflags")
pkgconfig.add_links("libpng")
end
end,
},
libsodium = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("libsodium")
else
pkgconfig.add_includes("libsodium")
end
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_lib_paths("libsodium")
add_default_links({
win_names = { "libsodium" },
})
else
pkgconfig.add_links("libsodium")
end
add_default_links({
win_names = { "libsodium" },
unix_names = { "sodium" },
})
end,
},
libxml2 = {
@ -451,14 +451,13 @@ extern_lib_defs = {
if os.istarget("windows") then
add_default_include_paths("libxml2")
else
-- Support XML2_CONFIG for overriding the default (pkg-config --cflags libxml-2.0)
-- i.e. on OSX where it gets set in update-workspaces.sh
pkgconfig.add_includes("libxml-2.0", os.getenv("XML2_CONFIG"))
end
if os.istarget("macosx") then
-- libxml2 needs _REENTRANT or __MT__ for thread support;
-- OS X doesn't get either set by default, so do it manually
defines { "_REENTRANT" }
pkgconfig.add_includes("libxml-2.0")
if os.istarget("macosx") then
-- libxml2 needs _REENTRANT or __MT__ for thread support;
-- OS X doesn't get either set by default, so do it manually
defines { "_REENTRANT" }
end
end
end,
link_settings = function()
@ -470,24 +469,48 @@ extern_lib_defs = {
links { "libxml2" }
filter { }
else
pkgconfig.add_links("libxml-2.0", os.getenv("XML2_CONFIG"))
pkgconfig.add_links("libxml-2.0")
end
end,
},
miniupnpc = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("miniupnpc")
elseif os.istarget("macosx") then
pkgconfig.add_includes("miniupnpc")
end
-- On Linux and BSD systems we assume miniupnpc is installed in a standard location.
--
-- Support for pkg-config was added in v2.1 of miniupnpc (May 2018). However, the
-- implementation was flawed - it provided the wrong path to the project's headers.
-- This was corrected in v2.2.1 (December 2020).
--
-- At the time of writing, of the 123 Linux and BSD package repositories tracked by
-- Repology that supply a version of miniupnpc:
-- * 88 (~71.54%) have >= v2.1, needed to locate libraries
-- * 50 (~40.65%) have >= v2.2.1, needed to (correctly) locate headers
--
-- Once more recent versions become more widespread, we can safely start to use
-- pkg-config to find miniupnpc on Linux and BSD systems.
-- https://repology.org/badge/vertical-allrepos/miniupnpc.svg?minversion=2.2.1
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_lib_paths("miniupnpc")
add_default_links({
win_names = { "miniupnpc" },
})
elseif os.istarget("macosx") then
pkgconfig.add_links("miniupnpc")
else
-- Once miniupnpc v2.1 or better becomes near-universal (see above comment),
-- we can use pkg-config for Linux and BSD.
add_default_links({
unix_names = { "miniupnpc" },
})
end
add_default_links({
win_names = { "miniupnpc" },
unix_names = { "miniupnpc" },
})
end,
},
nvtt = {
@ -513,44 +536,53 @@ extern_lib_defs = {
compile_settings = function()
if os.istarget("windows") then
add_default_include_paths("openal")
elseif not os.istarget("macosx") then
pkgconfig.add_includes("openal")
end
end,
link_settings = function()
if os.istarget("windows") then
add_default_lib_paths("openal")
add_default_links({
win_names = { "openal32" },
dbg_suffix = "",
no_delayload = 1, -- delayload seems to cause errors on startup
})
elseif os.istarget("macosx") then
add_default_links({
osx_frameworks = { "OpenAL" },
})
else
pkgconfig.add_links("openal")
end
add_default_links({
win_names = { "openal32" },
unix_names = { "openal" },
osx_frameworks = { "OpenAL" },
dbg_suffix = "",
no_delayload = 1, -- delayload seems to cause errors on startup
})
end,
},
opengl = {
compile_settings = function()
if os.istarget("windows") then
add_default_include_paths("opengl")
elseif _OPTIONS["gles"] then
pkgconfig.add_includes("glesv2")
elseif not os.istarget("macosx") then
pkgconfig.add_includes("gl")
end
end,
link_settings = function()
if os.istarget("windows") then
add_default_lib_paths("opengl")
end
if _OPTIONS["gles"] then
add_default_links({
unix_names = { "GLESv2" },
dbg_suffix = "",
})
else
add_default_links({
win_names = { "opengl32", "gdi32" },
unix_names = { "GL" },
osx_frameworks = { "OpenGL" },
dbg_suffix = "",
no_delayload = 1, -- delayload seems to cause errors on startup
})
elseif os.istarget("macosx") then
add_default_links({
osx_frameworks = { "OpenGL" },
})
elseif _OPTIONS["gles"] then
pkgconfig.add_links("glesv2")
else
pkgconfig.add_links("gl")
end
end,
},
@ -559,16 +591,14 @@ extern_lib_defs = {
if os.istarget("windows") then
includedirs { libraries_dir .. "sdl2/include/SDL" }
elseif not _OPTIONS["android"] then
-- Support SDL2_CONFIG for overriding the default (pkg-config sdl2)
-- i.e. on OSX where it gets set in update-workspaces.sh
pkgconfig.add_includes("sdl2", os.getenv("SDL2_CONFIG"))
pkgconfig.add_includes("sdl2")
end
end,
link_settings = function()
if os.istarget("windows") then
add_default_lib_paths("sdl2")
elseif not _OPTIONS["android"] then
pkgconfig.add_links("sdl2", os.getenv("SDL2_CONFIG"))
pkgconfig.add_links("sdl2")
end
end,
},
@ -636,31 +666,26 @@ extern_lib_defs = {
compile_settings = function()
if os.istarget("windows") then
add_default_include_paths("vorbis")
elseif os.istarget("macosx") then
add_default_include_paths("libogg")
add_default_include_paths("vorbis")
else
pkgconfig.add_includes("ogg")
pkgconfig.add_includes("vorbisfile")
end
end,
link_settings = function()
if os.istarget("windows") then
add_default_lib_paths("vorbis")
elseif os.istarget("macosx") then
add_default_lib_paths("libogg")
add_default_lib_paths("vorbis")
end
-- TODO: We need to force linking with these as currently
-- they need to be loaded explicitly on execution
if os.getversion().description == "OpenBSD" then
add_default_links({
unix_names = { "ogg",
"vorbis" },
win_names = { "libvorbisfile" },
})
elseif os.getversion().description == "OpenBSD" then
-- TODO: We need to force linking with these as currently
-- they need to be loaded explicitly on execution
add_default_links({
unix_names = { "ogg", "vorbis" },
})
else
pkgconfig.add_links("vorbisfile")
end
add_default_links({
win_names = { "libvorbisfile" },
unix_names = { "vorbisfile" },
osx_names = { "vorbis", "vorbisenc", "vorbisfile", "ogg" },
})
end,
},
wxwidgets = {
@ -698,19 +723,22 @@ extern_lib_defs = {
},
zlib = {
compile_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_include_paths("zlib")
else
pkgconfig.add_includes("zlib")
end
end,
link_settings = function()
if os.istarget("windows") or os.istarget("macosx") then
if os.istarget("windows") then
add_default_lib_paths("zlib")
add_default_links({
win_names = { "zlib1" },
no_delayload = 1,
})
else
pkgconfig.add_links("zlib")
end
add_default_links({
win_names = { "zlib1" },
unix_names = { "z" },
no_delayload = 1,
})
end,
},
}

14
build/premake/pkgconfig/pkgconfig.lua
View File

@ -1,5 +1,8 @@
local m = {}
m._VERSION = "1.1.0-dev"
m._VERSION = "1.1.1-dev"
m.additional_pc_path = nil
m.static_link_libs = false
local function os_capture(cmd)
return io.popen(cmd, 'r'):read('*a'):gsub("\n", " ")
@ -8,7 +11,8 @@ end
function m.add_includes(lib, alternative_cmd, alternative_flags)
local result
if not alternative_cmd then
result = os_capture("pkg-config --cflags "..lib)
local pc_path = m.additional_pc_path and "PKG_CONFIG_PATH="..m.additional_pc_path or ""
result = os_capture(pc_path.." pkg-config --cflags "..lib)
else
if not alternative_flags then
result = os_capture(alternative_cmd.." --cflags")
@ -42,9 +46,11 @@ end
function m.add_links(lib, alternative_cmd, alternative_flags)
local result
if not alternative_cmd then
result = os_capture("pkg-config --libs "..lib)
local pc_path = m.additional_pc_path and "PKG_CONFIG_PATH="..m.additional_pc_path or ""
local static = m.static_link_libs and " --static " or ""
result = os_capture(pc_path.." pkg-config --libs "..static..lib)
else
if not alternative_flags then
if not alternative_flags then
result = os_capture(alternative_cmd.." --libs")
else
result = os_capture(alternative_cmd.." "..alternative_flags)

7
build/workspaces/update-workspaces.sh
View File

@ -70,13 +70,8 @@ if [ "`uname -s`" = "Darwin" ]; then
# Set minimal SDK version
export MIN_OSX_VERSION=${MIN_OSX_VERSION:="10.12"}
# Set *_CONFIG variables on OS X, to override the path to e.g. sdl2-config
export GLOOX_CONFIG=${GLOOX_CONFIG:="$(pwd)/../../libraries/osx/gloox/bin/gloox-config"}
export ICU_CONFIG=${ICU_CONFIG:="$(pwd)/../../libraries/osx/icu/bin/icu-config"}
export LIBPNG_CONFIG=${PNG_CONFIG:="$(pwd)/../../libraries/osx/libpng/bin/libpng-config"}
export SDL2_CONFIG=${SDL2_CONFIG:="$(pwd)/../../libraries/osx/sdl2/bin/sdl2-config"}
# Provide path to wx-config on OS X (as wxwidgets doesn't support pkgconfig)
export WX_CONFIG=${WX_CONFIG:="$(pwd)/../../libraries/osx/wxwidgets/bin/wx-config"}
export XML2_CONFIG=${XML2_CONFIG:="$(pwd)/../../libraries/osx/libxml2/bin/xml2-config"}
fi
# Don't want to build bundled libs on OS X

47
libraries/osx/build-osx-libs.sh
View File

@ -133,6 +133,13 @@ done
cd "$(dirname $0)"
# Now in libraries/osx/ (where we assume this script resides)
# Create a location to create copies of dependencies' *.pc files, so they can be found by pkg-config
PC_PATH="$(pwd)/pkgconfig/"
if [[ "$force_rebuild" = "true" ]]; then
rm -rf $PC_PATH
fi
mkdir -p $PC_PATH
# --------------------------------------------------------------
echo -e "Building zlib..."
@ -161,7 +168,9 @@ then
./configure --prefix="$ZLIB_DIR" \
--static \
&& make ${JOBS} && make install) || die "zlib build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -218,7 +227,9 @@ then
--with-zlib="${ZLIB_DIR}" \
--enable-shared=no \
&& make ${JOBS} && make install) || die "libcurl build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -293,7 +304,9 @@ then
--with-zlib="${ZLIB_DIR}" \
--enable-shared=no \
&& make ${JOBS} && make install) || die "libxml2 build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -335,7 +348,9 @@ then
--enable-video-cocoa \
--enable-shared=no \
&& make $JOBS && make install) || die "SDL2 build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -475,7 +490,9 @@ then
--prefix=$INSTALL_DIR \
--enable-shared=no \
&& make ${JOBS} && make install) || die "libpng build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -483,6 +500,7 @@ fi
popd > /dev/null
# --------------------------------------------------------------
# Dependency of vorbis
echo -e "Building libogg..."
LIB_VERSION="${OGG_VERSION}"
@ -490,11 +508,7 @@ LIB_ARCHIVE="$LIB_VERSION.tar.gz"
LIB_DIRECTORY="$LIB_VERSION"
LIB_URL="http://downloads.xiph.org/releases/ogg/"
# Dependency of vorbis
# we can install them in the same directory for convenience
mkdir -p libogg
mkdir -p vorbis
pushd libogg > /dev/null
OGG_DIR="$(pwd)"
@ -512,7 +526,9 @@ then
--prefix=$OGG_DIR \
--enable-shared=no \
&& make ${JOBS} && make install) || die "libogg build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -527,6 +543,7 @@ LIB_ARCHIVE="$LIB_VERSION.tar.gz"
LIB_DIRECTORY="$LIB_VERSION"
LIB_URL="http://downloads.xiph.org/releases/vorbis/"
mkdir -p vorbis
pushd vorbis > /dev/null
if [[ "$force_rebuild" = "true" ]] || [[ ! -e .already-built ]] || [[ "$(<.already-built)" != "$LIB_VERSION" ]]
@ -546,7 +563,9 @@ then
--enable-shared=no \
--with-ogg="$OGG_DIR" \
&& make ${JOBS} && make install) || die "libvorbis build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -587,7 +606,9 @@ then
--disable-shared \
--with-pic \
&& make ${JOBS} && make install) || die "GMP build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -596,6 +617,7 @@ popd > /dev/null
# --------------------------------------------------------------
echo -e "Building Nettle..."
# Also builds hogweed
LIB_VERSION="${NETTLE_VERSION}"
LIB_ARCHIVE="$LIB_VERSION.tar.gz"
@ -632,7 +654,9 @@ then
--disable-openssl \
--disable-assembler \
&& make ${JOBS} && make install) || die "Nettle build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -688,7 +712,9 @@ then
--disable-tools \
--disable-nls \
&& make ${JOBS} LDFLAGS= install) || die "GnuTLS build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -733,7 +759,9 @@ then
--without-examples \
--disable-getaddrinfo \
&& make ${JOBS} && make install) || die "gloox build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -748,7 +776,7 @@ LIB_ARCHIVE="$LIB_VERSION-src.tgz"
LIB_DIRECTORY="icu"
LIB_URL="https://github.com/unicode-org/icu/releases/download/release-67-1/"
mkdir -p $LIB_DIRECTORY
mkdir -p icu
pushd icu > /dev/null
if [[ "$force_rebuild" = "true" ]] || [[ ! -e .already-built ]] || [[ "$(<.already-built)" != "$LIB_VERSION" ]]
@ -775,8 +803,10 @@ then
--enable-icuio \
--enable-tools \
&& make ${JOBS} && make install) || die "ICU build failed"
popd
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -810,7 +840,9 @@ then
--prefix=${INSTALL_DIR} \
--enable-shared=no \
&& make clean && make ${JOBS} && make install) || die "ENet build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -843,9 +875,11 @@ then
&& CFLAGS=$CFLAGS LDFLAGS=$LDFLAGS make ${JOBS} \
&& INSTALLPREFIX="$INSTALL_DIR" make install \
) || die "MiniUPnPc build failed"
popd
# TODO: how can we not build the dylibs?
rm -f lib/*.dylib
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -883,7 +917,9 @@ then
&& make check \
&& INSTALLPREFIX="$INSTALL_DIR" make install \
) || die "libsodium build failed"
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$LIB_VERSION" > .already-built
else
already_built
@ -925,6 +961,7 @@ then
popd
popd
cp -f lib/pkgconfig/* $PC_PATH
echo "$FMT_VERSION" > .already-built
else
already_built