https://github.com/lethalbit/libalfheim
A portable and complete C++ library for object file parsing and manipulation
https://github.com/lethalbit/libalfheim
coff ecoff elf executable-formats os360 pe32 xcoff
Last synced: about 2 months ago
JSON representation
A portable and complete C++ library for object file parsing and manipulation
- Host: GitHub
- URL: https://github.com/lethalbit/libalfheim
- Owner: lethalbit
- License: bsd-3-clause
- Created: 2021-04-17T12:03:14.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-26T00:37:13.000Z (almost 3 years ago)
- Last Synced: 2025-03-22T12:23:47.453Z (2 months ago)
- Topics: coff, ecoff, elf, executable-formats, os360, pe32, xcoff
- Language: C++
- Homepage:
- Size: 60.5 KB
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# libalfheim
libalfheim is a C++ library designed to facilitate with the parsing and generation of various object files formats.
The sister library for parsing and generating debug info formats can be found at [lethalbit/libfortress](https://github.com/lethalbit/libfortress).
## Configuring and Building
The following steps describe how to build libalfheim, it should be consistent for both Linux and Windows, but Windows remains untested.
### Prerequisites
To build libalfheim, ensure you have the following build time dependencies:
* git
* meson
* ninja
* zlib >=1.2.12
* g++ >= 11 or clang++ >= 11
Optionally, when also building with binding support (which is the default) you also need:
* python >= 3.9
* pybind11 >= 2.7.0
### Configuring
You can build libalfheim with the default options, all of which can be found in [`meson_options.txt`](meson_options.txt). You can change these by specifying `-D=` at initial meson invocation time, or with `meson configure` in the build directory post initial configure.
To change the install prefix, which is `/usr/local` by default ensure to pass `--prefix ` when running meson for the first time.
In either case, simply running `meson build` from the root of the repository will be sufficient and place all of the build files in the `build` subdirectory.
### Building
Once you have configured libalfheim appropriately, to simply build and install simply run the following:
```
$ ninja -C build
$ ninja -C build install
```
This will build and install libalfheim into the default prefix which is `/usr/local`, to change that see the configuration steps above.
### Notes to Package Maintainers
If you are building libalfheim for inclusion in a distributions package system then ensure to set `DESTDIR` prior to running meson install.
There is also a `bugreport_url` configuration option that is set to this repositories issues tracker by default, it is recommended to change it to your distributions bug tracking page.
## License
libalfheim is licensed under the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) and can be found in [LICENSE](https://github.com/lethalbit/libalfheim/tree/main/LICENSE).