D 2024-08-23T23:28:43.109
L ObjFW
N text/x-markdown
P 1576ea0b4156fac67e99df7c544e66ee129f90c2204eb7eaea42c4f04f0713f3
U js
W 4740
# What is  ObjFW?

ObjFW is a portable, lightweight framework for the Objective-C language. It enables you to write an application in Objective-C that will run on any [platform](/doc/trunk/PLATFORMS.md) supported by ObjFW without having to worry about differences between operating systems or various frameworks you would otherwise need if you want to be portable.

It supports all modern Objective-C features when using Clang, but is also compatible with GCC ≥ 4.6 to allow maximum portability.

ObjFW is intentionally incompatible with Foundation. This has two reasons:

* GNUstep already provides a reimplementation of Foundation, which is only compatible to a certain degree. This means that a developer still needs to care about differences between frameworks if they want to be portable. The idea behind ObjFW is that developers do not need to concern themselves with portability and making sure their code works with multiple frameworks: Instead, if it works with ObjFW on one platform, they can reasonably expect it to also work with ObjFW on another platform. ObjFW behaving differently on different operating systems (unless inevitable because it is a platform-specific part, like the Windows Registry) is considered a bug and will be fixed.
* Foundation predates a lot of modern Objective-C concepts. The most prominent one is exceptions, which are only used in Foundation as a replacement for `abort()`. This results in cumbersome error handling, especially in initializers, which in Foundation only return `nil` on error with no indication of what went wrong. It also means that the return of every `init` call needs to be checked against `nil`. But in the wild, nobody actually checks *each and every* return from `init` against `nil`, leading to bugs. ObjFW fixes this by making exceptions a first class citizen.

You can read more about the differences to Foundation [here](Differences to Foundation).

ObjFW also comes with its own lightweight and extremely fast Objective-C runtime, which in real world use cases was found to be significantly faster than both GNU's and Apple's runtime.

# Installation

You can either follow the [instructions](Installation) to install ObjFW or you can [build ObjFW from source](Building from source).

# Usage

To create your first, empty application, you can use `objfw-new`:

    objfw-new --app MyFirstApp

This creates a file `MyFirstApp.m`. The `-[applicationDidFinishLaunching:]` method is called as soon as ObjFW finished all initialization. Use this as the entry point to your own code. For example, you could add the following line there to create a "Hello World":

    [OFStdOut writeLine: @"Hello World!"];

You can compile your new app using `objfw-compile`:

    objfw-compile -o MyFirstApp MyFirstApp.m

`objfw-compile` is a tool that allows building applications and libraries using ObjFW without needing a full-blown build system. If you want to use your own build system, you can get the necessary flags from `objfw-config`.

# Documentation

You can find the documentation for released versions of ObjFW [here](/docs/).

In order to build the documentation yourself (necessary to have documentation for trunk / master), you need to have [Doxygen](https://www.doxygen.nl) installed. Once installed, you can build the documentation from the root directory of the repository:

    make docs

# License

ObjFW is released under the GNU Lesser General Public License version 3.0.

If this license does not work for you, contact me and we can find a solution.

# Bugs and feature requests

If you find any bugs or have feature requests, please [file a new bug](/tktnew) in the [bug tracker](/reportlist).

Alternatively, feel free to send a mail to js@nil.im!

# Support and community

If you have any questions about ObjFW or would like to talk to other ObjFW users, the following venues are available:

* The [forum](/forum)
* A [Matrix room](https://matrix.to/#/%23objfw:nil.im)
* A [Discord room](https://objfw.nil.im/discord), bridged to the Matrix room above
* A [Telegram room](https://t.me/objfw), bridged to the Matrix room above
* A [Slack room](https://objfw.nil.im/slack), bridged to the Matrix room above
* An IRC channel named `#objfw` on `irc.oftc.net`

Please don't hesitate to join any or all of those!

# Donating

If you want to donate to ObjFW, you can read about possible ways to do so [here](Donating).


# Thanks

* Thank you to [Jonathan Neuschäfer](https://github.com/neuschaefer) for reviewing the *entirety* (all 84k LoC at the time) of ObjFW's codebase in 2017!
* Thank you to [Hill Ma](https://github.com/mahiuchun) for donating an M1 Mac Mini to the project in 2022!
Z 5e49607bd6cc6ed6fefde03393044283