rpm-ostree/rust/cbindgen.toml

autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
language = "C"
header = "#pragma once\n#include <gio/gio.h>\ntypedef GError RORGError;\ntypedef GHashTable RORGHashTable;\ntypedef GPtrArray RORGPtrArray;"
trailer = """
G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORTreefile, ror_treefile_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORHistoryCtx, ror_history_ctx_free)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(RORHistoryEntry, ror_history_entry_clear)
"""

[export]
prefix = "ROR"
# Here we exclude functions belonging to the C side which we use on the Rust side and so
# doesn't make sense to re-export.
exclude = ["rpmostree_get_repodata_chksum_repr"]

[parse]
# We don't want cbindgen to parse libdnf-sys, since we're clients of the library, not
# providers. This should already be guaranteed by `parse_deps` being `false`, but include
# this here too to be explicit.
exclude = ["libdnf-sys"]
Use cbindgen If we're going to scale out our oxidation, let's follow the path of Firefox (and other projects) further and use cbindgen: https://github.com/eqrion/cbindgen It's actually nice that `cbindgen` is packaged today in Fedora, but I doubt it is elsewhere; we may end up needing to push that forward, or just vendor it via a `build.rs` script and Cargo. I chose to rename things to `ROR`/`ror_` since it's shorter. I am tempted a bit to rename our internal functions to just `ro_` to or so. Closes: #1516 Approved by: jlebon 2018-08-24 17:42:31 +03:00			`autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"`
			`language = "C"`
lockfile: Switch to writing it from Rust I wanted to modify the lockfile specification, but then remembered that it currently lives in two places right now: once on the Rust side where it's deserialized, and once more on the C side where it's serialized. If we could write the lockfile from the Rust side, then we wouldn't have to deal with the `GVariantBuild` and `json-glib` goop, and instead we could consistently use serde against the same struct for both serialization and deserialization. But there isn't an easy way to do this given that the state to be serialized is intrinsically linked to libdnf. So this patch takes the next step in our oxidation process by adding a minimal `libdnf_sys` module which allows us to call `libdnf` functions from Rust. This is not the prettiest code I've written, and there's definitely some polishing that could be done. But I think overall it's a move in the right general direction: as we oxidize more things, we'll at some point have to integrate more tightly with the C side in a bidirectional way, instead of the "one-way" approach we've been using so far. For this patch specifically, in exchange we get a unique source of truth for the lockfile spec, just like the treefile, and we drop a lot of C code in the process. Closes: #1867 Approved by: cgwalters 2019-07-10 16:36:45 +03:00			`header = "#pragma once\n#include <gio/gio.h>\ntypedef GError RORGError;\ntypedef GHashTable RORGHashTable;\ntypedef GPtrArray RORGPtrArray;"`
rust/bindgen: Add an autoptr cleanup for our struct I'm going to add a new user soon. This should probably be a best practice. Ideally...cbindgen would have a way to add some wrapper bits around any types it defines or something? Closes: #1559 Approved by: jlebon 2018-09-13 23:11:48 +03:00			`trailer = """`
			`G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORTreefile, ror_treefile_free)`
Add new `ex history` command This is the rpm-ostree equivalent of `dnf history`. As opposed to the history of the refspec (i.e. `ostree log`), this shows the history of the system, i.e. the refspecs the host deployed, checksums, versions, layered packages, etc... The amount of details remembered is similar to what shows up in `status`. There's definitely some further enhancements possible (e.g. printing package diffs, displaying rollbacks), though this seems in good enough shape as a first cut. Closes: #1489 Closes: #1813 Approved by: cgwalters 2019-04-25 18:18:33 +03:00			`G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORHistoryCtx, ror_history_ctx_free)`
			`G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(RORHistoryEntry, ror_history_entry_clear)`
rust/bindgen: Add an autoptr cleanup for our struct I'm going to add a new user soon. This should probably be a best practice. Ideally...cbindgen would have a way to add some wrapper bits around any types it defines or something? Closes: #1559 Approved by: jlebon 2018-09-13 23:11:48 +03:00			`"""`

Use cbindgen If we're going to scale out our oxidation, let's follow the path of Firefox (and other projects) further and use cbindgen: https://github.com/eqrion/cbindgen It's actually nice that `cbindgen` is packaged today in Fedora, but I doubt it is elsewhere; we may end up needing to push that forward, or just vendor it via a `build.rs` script and Cargo. I chose to rename things to `ROR`/`ror_` since it's shorter. I am tempted a bit to rename our internal functions to just `ro_` to or so. Closes: #1516 Approved by: jlebon 2018-08-24 17:42:31 +03:00			`[export]`
			`prefix = "ROR"`
rust: move libdnf-sys module to its own crate This is just a cleaner arrangement to make the separation more explicit. It also matches what most other wrapper crates do. One advantage of this is that we can tell cbindgen directly that we don't want it to ever export symbols from `libdnf-sys`. Related discussions in: https://github.com/coreos/rpm-ostree/pull/2047 2020-04-07 18:09:17 +03:00			`# Here we exclude functions belonging to the C side which we use on the Rust side and so`
			`# doesn't make sense to re-export.`
			`exclude = ["rpmostree_get_repodata_chksum_repr"]`

			`[parse]`
			`# We don't want cbindgen to parse libdnf-sys, since we're clients of the library, not`
			# providers. This should already be guaranteed by `parse_deps` being `false`, but include
			`# this here too to be explicit.`
			`exclude = ["libdnf-sys"]`