Overview

Artifact ID:	ff8a5e77e327134ab7f33d9e6d708a96f2dd7a4830394039f0f6b506afadc086
Page Name:	Building from source
Date:	2024-08-20 23:49:26
Original User:	js
Mimetype:	text/x-markdown
Parent:	433c7a61b1d719952cccca340af5c3e353e03440a7afddde9b24928668fd3ff6 (diff)

Content

In order to build ObjFW from source, you first need to acquire the source code first. You can do so either by using one of the releases or you clone the repository to get the latest development state.

In most cases, you can use the generic instructions, but there are some more specific instructions for some operating systems further below.

Generic instructions

To build ObjFW from source and install it, just run the following commands:

./configure
make
make check
sudo make install

In case you checked out ObjFW from the repository, you need to run the following command first:

./autogen.sh

macOS and iOS

The generic instructions apply, but keep reading on for some macOS and iOS specifics.

Building as a .framework

When building for macOS or iOS, everything is built as a .framework by default if --disable-shared has not been specified to ./configure. The frameworks will end up in $PREFIX/Library/Frameworks.

To build for macOS, just follow the generic instructions above.

To build for iOS, follow the generic instructions above, but instead of ./configure do something like this:

clang="xcrun --sdk iphoneos clang"
export OBJC="$clang -arch arm64e -arch arm64"
export OBJCPP="$clang -arch arm64e -E"
export IPHONEOS_DEPLOYMENT_TARGET="10.0"
./configure --prefix=/usr/local/ios --host=arm64-apple-darwin

To build for the iOS simulator, follow the generic instructions above, but instead of ./configure use something like this:

clang="xcrun --sdk iphonesimulator clang"
export OBJC="$clang -arch $(uname -m)"
export IPHONEOS_DEPLOYMENT_TARGET="10.0"
./configure --prefix=/usr/local/iossim --host=$(uname -m)-apple-darwin

Using the macOS or iOS .framework in Xcode

To use the macOS framework in Xcode, you need to add the .frameworks to your project and add the following flags to Other C Flags:

-fconstant-string-class=OFConstantString -fno-constant-cfstrings

Windows

Windows is only officially supported when following these instructions, as there are many MinGW versions that behave slightly differently and often cause problems.

Getting MSYS2

The first thing to install is MSYS2 to provide a basic UNIX-like environment for Windows. Unfortunately, the binaries are not signed, so make sure you download it via HTTPS. However, packages you download and install via MSYS2 are cryptographically signed.

Setting up MSYS2

MSYS2 currently supports 7 different environments. All of them except for the one called just "MSYS" are supported, but which packages you need to install depends on the environment(s) you want to use. If you only want to target Windows 10 and newer, the CLANG64 and CLANG32 environments are the recommended ones.

For CLANG64, use:

pacman -Syu mingw-w64-clang-x86_64-clang \
            mingw-w64-clang-x86_64-fossil \
            mingw-w64-clang-x86_64-openssl

For CLANG32, use:

pacman -Syu mingw-w64-clang-i686-clang \
            mingw-w64-clang-i686-fossil \
            mingw-w64-clang-i686-openssl

For CLANGARM64, use (you need to use Fossil via another environment):

pacman -Syu mingw-w64-clang-aarch64-clang mingw-w64-clang-aarch64-openssl

For MINGW64, use:

pacman -Syu mingw-w64-x86_64-clang \
            mingw-w64-x86_64-fossil \
            mingw-w64-x86_64-openssl

For MINGW32, use:

pacman -Syu mingw-w64-i686-clang \
            mingw-w64-i686-fossil \
            mingw-w64-i686-openssl

For UCRT64, use:

pacman -Syu mingw-w64-ucrt-x86_64-clang \
            mingw-w64-ucrt-x86_64-fossil \
            mingw-w64-ucrt-x86_64-openssl

When using pacman to install the packages, pacman might tell you to close the window. If it does so, close the window, restart MSYS2 and execute the pacman command again.

There is nothing wrong with installing multiple environments, as MSYS2 has created shortcuts for each of them in your start menu. Just make sure to use the correct shortcut for the environment you want to use.

Finally, install a few more things that are common between all environments:

pacman -S autoconf automake make

Getting, building and installing ObjFW

Start the MSYS2 using the shortcut for the environment you want to use and check out ObjFW:

fossil clone https://objfw.nil.im

You can also download a release tarball if you want. Now cd to the newly checked out repository and build and install it:

./autogen.sh && ./configure && make -j16 install

If everything was successful, you can now build projects using ObjFW for Windows using the normal objfw-compile and friends.

Nintendo consoles

Download and install devkitPro.