[v2,5/5] cgit: add higher-level cgit crate

Message ID	514c744ba41cf48c4ffd85640b7ef0c5783cc77d.1723242556.git.steadmon@google.com (mailing list archive)
State	New, archived
Headers	show Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 48D9016CD06 for <git@vger.kernel.org>; Fri, 9 Aug 2024 22:41:29 +0000 (UTC) Date: Fri, 9 Aug 2024 15:41:17 -0700 In-Reply-To: <cover.1723242556.git.steadmon@google.com> Precedence: bulk Mime-Version: 1.0 References: <cover.1723054623.git.steadmon@google.com> <cover.1723242556.git.steadmon@google.com> Message-ID: <514c744ba41cf48c4ffd85640b7ef0c5783cc77d.1723242556.git.steadmon@google.com> Subject: [PATCH v2 5/5] cgit: add higher-level cgit crate From: Josh Steadmon <steadmon@google.com> To: git@vger.kernel.org Cc: calvinwan@google.com, spectral@google.com, emilyshaffer@google.com, emrass@google.com, rsbecker@nexbridge.com, gitster@pobox.com, mh@glandium.org, sandals@crustytoothpaste.net, Jason@zx2c4.com, dsimic@manjaro.org Content-Type: text/plain; charset="UTF-8"
Series	Introduce cgit-rs, a Rust wrapper around libgit.a \| expand [v2,0/5] Introduce cgit-rs, a Rust wrapper around libgit.a [v2,1/5] common-main: split init and exit code into new files [v2,2/5] cgit-sys: introduce Rust wrapper for libgit.a [v2,3/5] cgit-sys: add repo initialization and config access [v2,4/5] config: add git_configset_alloc() and git_configset_clear_and_free() [v2,5/5] cgit: add higher-level cgit crate

diff --git a/.gitignore b/.gitignore index 567cc9888f..7f2ee89b8a 100644 --- a/.gitignore +++ b/.gitignore @@ -248,4 +248,5 @@ Release/ /git.VC.db *.dSYM /contrib/buildsystems/out +/contrib/cgit-rs/target /contrib/cgit-rs/cgit-sys/target diff --git a/Makefile b/Makefile index db8af99f20..3a71d10fbe 100644 --- a/Makefile +++ b/Makefile @@ -3723,7 +3723,7 @@ clean: profile-clean coverage-clean cocciclean $(RM) $(htmldocs).tar.gz $(manpages).tar.gz $(MAKE) -C Documentation/ clean $(RM) Documentation/GIT-EXCLUDED-PROGRAMS - $(RM) -r contrib/cgit-rs/cgit-sys/target + $(RM) -r contrib/cgit-rs/target contrib/cgit-rs/cgit-sys/target ifndef NO_PERL $(RM) -r perl/build/ endif diff --git a/contrib/cgit-rs/Cargo.lock b/contrib/cgit-rs/Cargo.lock new file mode 100644 index 0000000000..991e775c34 --- /dev/null +++ b/contrib/cgit-rs/Cargo.lock @@ -0,0 +1,14 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "cgit" +version = "0.1.0" +dependencies = [ + "cgit-sys", +] + +[[package]] +name = "cgit-sys" +version = "0.1.0" diff --git a/contrib/cgit-rs/Cargo.toml b/contrib/cgit-rs/Cargo.toml new file mode 100644 index 0000000000..31f4d84522 --- /dev/null +++ b/contrib/cgit-rs/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "cgit" +version = "0.1.0" +edition = "2021" + +[lib] +path = "src/lib.rs" + +[dependencies] +cgit-sys = { version = "0.1.0", path = "cgit-sys" } diff --git a/contrib/cgit-rs/cgit-sys/public_symbol_export.c b/contrib/cgit-rs/cgit-sys/public_symbol_export.c index 62a91f76d0..adf8b21f11 100644 --- a/contrib/cgit-rs/cgit-sys/public_symbol_export.c +++ b/contrib/cgit-rs/cgit-sys/public_symbol_export.c @@ -33,6 +33,36 @@ int libgit_parse_maybe_bool(const char *val) return git_parse_maybe_bool(val); } +struct config_set *libgit_configset_alloc(void) +{ + return git_configset_alloc(); +} + +void libgit_configset_clear_and_free(struct config_set *cs) +{ + git_configset_clear_and_free(cs); +} + +void libgit_configset_init(struct config_set *cs) +{ + git_configset_init(cs); +} + +int libgit_configset_add_file(struct config_set *cs, const char *filename) +{ + return git_configset_add_file(cs, filename); +} + +int libgit_configset_get_int(struct config_set *cs, const char *key, int *dest) +{ + return git_configset_get_int(cs, key, dest); +} + +int libgit_configset_get_string(struct config_set *cs, const char *key, char **dest) +{ + return git_configset_get_string(cs, key, dest); +} + const char *libgit_user_agent(void) { return git_user_agent(); diff --git a/contrib/cgit-rs/cgit-sys/public_symbol_export.h b/contrib/cgit-rs/cgit-sys/public_symbol_export.h index 64332f30de..882c7932e8 100644 --- a/contrib/cgit-rs/cgit-sys/public_symbol_export.h +++ b/contrib/cgit-rs/cgit-sys/public_symbol_export.h @@ -9,6 +9,18 @@ void libgit_init_git(const char **argv); int libgit_parse_maybe_bool(const char *val); +struct config_set *libgit_configset_alloc(void); + +void libgit_configset_clear_and_free(struct config_set *cs); + +void libgit_configset_init(struct config_set *cs); + +int libgit_configset_add_file(struct config_set *cs, const char *filename); + +int libgit_configset_get_int(struct config_set *cs, const char *key, int *dest); + +int libgit_configset_get_string(struct config_set *cs, const char *key, char **dest); + const char *libgit_user_agent(void); const char *libgit_user_agent_sanitized(void); diff --git a/contrib/cgit-rs/cgit-sys/src/lib.rs b/contrib/cgit-rs/cgit-sys/src/lib.rs index 8c3ccc2859..d5072ea587 100644 --- a/contrib/cgit-rs/cgit-sys/src/lib.rs +++ b/contrib/cgit-rs/cgit-sys/src/lib.rs @@ -1,6 +1,15 @@ -use std::ffi::{c_char, c_int}; +use std::ffi::{c_char, c_int, c_void}; + +#[allow(non_camel_case_types)] +#[repr(C)] +pub struct config_set { + _data: [u8; 0], + _marker: core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>, +} extern "C" { + pub fn free(ptr: *mut c_void); + pub fn libgit_setup_git_directory() -> *const c_char; // From config.c @@ -15,6 +24,26 @@ extern "C" { // From version.c pub fn libgit_user_agent() -> *const c_char; pub fn libgit_user_agent_sanitized() -> *const c_char; + + pub fn libgit_configset_alloc() -> *mut config_set; + pub fn libgit_configset_clear_and_free(cs: *mut config_set); + + pub fn libgit_configset_init(cs: *mut config_set); + + pub fn libgit_configset_add_file(cs: *mut config_set, filename: *const c_char) -> c_int; + + pub fn libgit_configset_get_int( + cs: *mut config_set, + key: *const c_char, + int: *mut c_int, + ) -> c_int; + + pub fn libgit_configset_get_string( + cs: *mut config_set, + key: *const c_char, + dest: *mut *mut c_char, + ) -> c_int; + } #[cfg(test)] diff --git a/contrib/cgit-rs/src/lib.rs b/contrib/cgit-rs/src/lib.rs new file mode 100644 index 0000000000..74c83d161a --- /dev/null +++ b/contrib/cgit-rs/src/lib.rs @@ -0,0 +1,82 @@ +use std::ffi::{c_char, c_int, c_void, CStr, CString}; + +use cgit_sys::*; + +pub struct ConfigSet(*mut config_set); +impl ConfigSet { + pub fn new() -> Self { + unsafe { + let ptr = libgit_configset_alloc(); + libgit_configset_init(ptr); + ConfigSet(ptr) + } + } + + // NEEDSWORK: maybe replace &str with &Path + pub fn add_files(&mut self, files: &[&str]) { + for file in files { + let rs = CString::new(*file).expect("Couldn't convert to CString"); + unsafe { + libgit_configset_add_file(self.0, rs.as_ptr()); + } + } + } + + pub fn get_int(&mut self, key: &str) -> Option<c_int> { + let key = CString::new(key).expect("Couldn't convert to CString"); + let mut val: c_int = 0; + unsafe { + if libgit_configset_get_int(self.0, key.as_ptr(), &mut val as *mut c_int) != 0 { + return None; + } + } + + Some(val) + } + + pub fn get_str(&mut self, key: &str) -> Option<CString> { + let key = CString::new(key).expect("Couldn't convert to CString"); + let mut val: *mut c_char = std::ptr::null_mut(); + unsafe { + if libgit_configset_get_string(self.0, key.as_ptr(), &mut val as *mut *mut c_char) != 0 + { + return None; + } + let borrowed_str = CStr::from_ptr(val); + let owned_str = CString::from_vec_with_nul(borrowed_str.to_bytes_with_nul().to_vec()); + free(val as *mut c_void); // Free the xstrdup()ed pointer from the C side + Some(owned_str.unwrap()) + } + } +} + +impl Default for ConfigSet { + fn default() -> Self { + Self::new() + } +} + +impl Drop for ConfigSet { + fn drop(&mut self) { + unsafe { + libgit_configset_clear_and_free(self.0); + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn load_configs_via_configset() { + // NEEDSWORK: we need to supply a testdata config + let mut cs = ConfigSet::new(); + let mut path = std::env::home_dir().expect("cannot get home directory path"); + path.push(".gitconfig"); + let path: String = path.into_os_string().into_string().unwrap(); + cs.add_files(&["/etc/gitconfig", ".gitconfig", &path]); + assert_eq!(cs.get_int("trace2.eventNesting"), Some(5)); + assert_eq!(cs.get_str("no_such_config_item"), None); + } +}

[v2,5/5] cgit: add higher-level cgit crate

Commit Message

Comments

Patch