Fix rustc and clippy warnings

.github/workflows/test.yml

@@ -5,7 +5,7 @@ on: [push, pull_request]
 env:
   CARGO_TERM_COLOR: always
   DOC_LLVM_FEATURE: llvm17-0
-  DOC_LLVM_VERSION: '17.0'
+  DOC_LLVM_VERSION: "17.0"
   DOC_PATH: target/doc
 
 jobs:
@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Rust Stable
-        run: rustup toolchain install stable
+        uses: dtolnay/rust-toolchain@stable
       - name: Install typos
-        run: cargo install typos-cli
+        uses: taiki-e/install-action@typos
       - name: Run typos
         run: typos .
   tests:
@@ -39,22 +39,24 @@ jobs:
           - ["15.0", "15-0"]
           - ["16.0", "16-0"]
           - ["17.0", "17-0"]
-        # only use ubuntu-22.04 for llvm 16 and higher
         include:
           - os: ubuntu-20.04
+          # only use ubuntu-22.04 for llvm 16 and higher
           - os: ubuntu-22.04
             llvm-version: ["16.0", "16-0"]
           - os: ubuntu-22.04
             llvm-version: ["17.0", "17-0"]
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install LLVM and Clang
         uses: KyleMayes/install-llvm-action@v1
         with:
           version: ${{ matrix.llvm-version[0] }}
       - name: llvm-config
         run: llvm-config --version --bindir --libdir
+      - name: Install Rust Stable
+        uses: dtolnay/rust-toolchain@stable
       - name: Build
         run: cargo build --release --features llvm${{ matrix.llvm-version[1] }} --verbose
       - name: Run tests
@@ -67,19 +69,19 @@ jobs:
     needs: [typos, tests]
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     steps:
-    - uses: actions/checkout@v3
-    - uses: KyleMayes/install-llvm-action@v1
-      with:
-        version: ${{ env.DOC_LLVM_VERSION }}
-    - name: Install Rust Nightly
-      run: rustup toolchain install nightly
-    - name: Build Documentation
-      run: cargo +nightly doc --features ${{ env.DOC_LLVM_FEATURE }},nightly --verbose
-    - name: Doc Index Page Redirection
-      run: echo '<meta http-equiv="refresh" content="1; url=inkwell/index.html">' > ${{ env.DOC_PATH }}/index.html
-    - name: Deploy Documentation
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ${{ env.DOC_PATH }}
-        force_orphan: true
+      - uses: actions/checkout@v4
+      - uses: KyleMayes/install-llvm-action@v1
+        with:
+          version: ${{ env.DOC_LLVM_VERSION }}
+      - name: Install Rust Nightly
+        uses: dtolnay/rust-toolchain@nightly
+      - name: Build Documentation
+        run: cargo +nightly doc --features ${{ env.DOC_LLVM_FEATURE }},nightly --verbose
+      - name: Doc Index Page Redirection
+        run: echo '<meta http-equiv="refresh" content="1; url=inkwell/index.html">' > ${{ env.DOC_PATH }}/index.html
+      - name: Deploy Documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ${{ env.DOC_PATH }}
+          force_orphan: true

Cargo.toml

@@ -13,6 +13,7 @@ edition = "2021"
 
 [features]
 default = ["target-all"]
+
 # Please update internal_macros::FEATURE_VERSIONS when adding a new LLVM version
 llvm4-0 = ["llvm-sys-40"]
 llvm5-0 = ["llvm-sys-50"]
@@ -29,6 +30,7 @@ llvm15-0 = ["llvm-sys-150"]
 llvm16-0 = ["llvm-sys-160"]
 llvm17-0 = ["llvm-sys-170"]
 llvm18-0 = ["llvm-sys-180"]
+
 # Don't link against LLVM libraries. This is useful if another dependency is
 # installing LLVM. See llvm-sys for more details. We can't enable a single
 # `no-llvm-linking` feature across the board of llvm versions, as it'll cause
@@ -133,9 +135,8 @@ experimental = ["static-alloc"]
 nightly = ["inkwell_internals/nightly"]
 
 [dependencies]
-either = "1.5"
 inkwell_internals = { path = "./internal_macros", version = "0.9.0" }
-libc = "0.2"
+
 llvm-sys-40 = { package = "llvm-sys", version = "40.4", optional = true }
 llvm-sys-50 = { package = "llvm-sys", version = "50.4", optional = true }
 llvm-sys-60 = { package = "llvm-sys", version = "60.6", optional = true }
@@ -151,9 +152,13 @@ llvm-sys-150 = { package = "llvm-sys", version = "150.0.3", optional = true }
 llvm-sys-160 = { package = "llvm-sys", version = "160.1.0", optional = true }
 llvm-sys-170 = { package = "llvm-sys", version = "170.0.1", optional = true }
 llvm-sys-180 = { package = "llvm-sys", version = "180.0.0", optional = true }
+
+either = "1.5"
+libc = "0.2"
 once_cell = "1.16"
-static-alloc = { version = "0.2", optional = true }
 thiserror = "1.0.48"
+
+static-alloc = { version = "0.2", optional = true }
 serde = { version = "1.0", default-features = false, features = ["derive"], optional = true }
 
 [dev-dependencies]

examples/kaleidoscope/implementation_typed_pointers.rs

@@ -51,12 +51,10 @@ pub struct LexError {
 }
 
 impl LexError {
-    #[allow(unused)]
     pub fn new(msg: &'static str) -> LexError {
         LexError { error: msg, index: 0 }
     }
 
-    #[allow(unused)]
     pub fn with_index(msg: &'static str, index: usize) -> LexError {
         LexError { error: msg, index }
     }
@@ -884,7 +882,7 @@ impl<'a, 'ctx> Compiler<'a, 'ctx> {
             } => {
                 let mut old_bindings = Vec::new();
 
-                for &(ref var_name, ref initializer) in variables {
+                for (var_name, initializer) in variables {
                     let var_name = var_name.as_str();
 
                     let initial_val = match *initializer {

examples/kaleidoscope/main.rs

@@ -32,8 +32,7 @@ use inkwell::{
 use inkwell_internals::llvm_versions;
 
 mod implementation_typed_pointers;
-
-use crate::implementation_typed_pointers::*;
+pub use implementation_typed_pointers::*;
 
 // ======================================================================================
 // PROGRAM ==============================================================================

src/attributes.rs

@@ -369,14 +369,10 @@ impl AttributeLoc {
         match self {
             AttributeLoc::Return => 0,
             AttributeLoc::Param(index) => {
-                assert!(
-                    index <= u32::max_value() - 2,
-                    "Param index must be <= u32::max_value() - 2"
-                );
-
+                assert!(index <= u32::MAX - 2, "Param index must be <= u32::MAX - 2");
                 index + 1
             },
-            AttributeLoc::Function => u32::max_value(),
+            AttributeLoc::Function => u32::MAX,
         }
     }
 }

src/builder.rs

@@ -421,7 +421,7 @@ impl<'ctx> Builder<'ctx> {
     ///
     /// builder.position_at_end(basic_block);
     ///
-    /// let pi = f32_type.const_float(::std::f64::consts::PI);
+    /// let pi = f32_type.const_float(std::f64::consts::PI);
     ///
     /// builder.build_return(Some(&pi)).unwrap();
     ///
@@ -542,7 +542,7 @@ impl<'ctx> Builder<'ctx> {
     ///
     /// builder.position_at_end(basic_block);
     ///
-    /// let pi = f32_type.const_float(::std::f64::consts::PI);
+    /// let pi = f32_type.const_float(std::f64::consts::PI);
     ///
     /// builder.build_return(Some(&pi)).unwrap();
     ///
@@ -900,7 +900,7 @@ impl<'ctx> Builder<'ctx> {
     ///
     /// builder.position_at_end(basic_block);
     ///
-    /// let pi = f32_type.const_float(::std::f64::consts::PI);
+    /// let pi = f32_type.const_float(std::f64::consts::PI);
     ///
     /// builder.build_return(Some(&pi)).unwrap();
     ///
@@ -3390,7 +3390,7 @@ impl<'ctx> Builder<'ctx> {
             feature = "llvm17-0",
             feature = "llvm18-0"
         )))]
-        if ptr.get_type().get_element_type().to_basic_type_enum() != cmp.get_type() {
+        if ptr.get_type().get_element_type().as_basic_type_enum() != cmp.get_type() {
             return Err(BuilderError::PointeeTypeMismatch(
                 "The pointer does not point to an element of the value type.",
             ));

src/context.rs

@@ -21,10 +21,11 @@ use llvm_sys::core::{
     LLVMCreateStringAttribute, LLVMDoubleTypeInContext, LLVMFP128TypeInContext, LLVMFloatTypeInContext,
     LLVMGetGlobalContext, LLVMGetMDKindIDInContext, LLVMHalfTypeInContext, LLVMInsertBasicBlockInContext,
     LLVMInt16TypeInContext, LLVMInt1TypeInContext, LLVMInt32TypeInContext, LLVMInt64TypeInContext,
-    LLVMInt8TypeInContext, LLVMIntTypeInContext, LLVMMDNodeInContext, LLVMMDStringInContext,
-    LLVMModuleCreateWithNameInContext, LLVMPPCFP128TypeInContext, LLVMStructCreateNamed, LLVMStructTypeInContext,
-    LLVMVoidTypeInContext, LLVMX86FP80TypeInContext,
+    LLVMInt8TypeInContext, LLVMIntTypeInContext, LLVMModuleCreateWithNameInContext, LLVMPPCFP128TypeInContext,
+    LLVMStructCreateNamed, LLVMStructTypeInContext, LLVMVoidTypeInContext, LLVMX86FP80TypeInContext,
 };
+#[allow(deprecated)]
+use llvm_sys::core::{LLVMMDNodeInContext, LLVMMDStringInContext};
 use llvm_sys::ir_reader::LLVMParseIRInContext;
 use llvm_sys::prelude::{LLVMContextRef, LLVMDiagnosticInfoRef, LLVMTypeRef, LLVMValueRef};
 use llvm_sys::target::{LLVMIntPtrTypeForASInContext, LLVMIntPtrTypeInContext};
@@ -328,6 +329,7 @@ impl ContextImpl {
         }
     }
 
+    #[allow(deprecated)]
     fn metadata_node<'ctx>(&self, values: &[BasicMetadataValueEnum<'ctx>]) -> MetadataValue<'ctx> {
         let mut tuple_values: Vec<LLVMValueRef> = values.iter().map(|val| val.as_value_ref()).collect();
         unsafe {
@@ -339,6 +341,7 @@ impl ContextImpl {
         }
     }
 
+    #[allow(deprecated)]
     fn metadata_string<'ctx>(&self, string: &str) -> MetadataValue<'ctx> {
         let c_string = to_c_str(string);
 

src/debug_info.rs

@@ -167,6 +167,7 @@ impl<'ctx> DIScope<'ctx> {
 /// Specific scopes (i.e. `DILexicalBlock`) can be turned into a `DIScope` with the
 /// `AsDIScope::as_debug_info_scope` trait method.
 pub trait AsDIScope<'ctx> {
+    #[allow(clippy::wrong_self_convention)]
     fn as_debug_info_scope(self) -> DIScope<'ctx>;
 }
 

src/execution_engine.rs

@@ -406,7 +406,7 @@ impl<'ctx> ExecutionEngine<'ctx> {
         let cstring_args: Vec<_> = args.iter().map(|&arg| to_c_str(arg)).collect();
         let raw_args: Vec<*const _> = cstring_args.iter().map(|arg| arg.as_ptr()).collect();
 
-        let environment_variables = vec![]; // TODO: Support envp. Likely needs to be null terminated
+        let environment_variables = []; // TODO: Support envp. Likely needs to be null terminated
 
         LLVMRunFunctionAsMain(
             self.execution_engine_inner(),
@@ -475,7 +475,7 @@ impl Deref for ExecEngineInner<'_> {
     type Target = LLVMExecutionEngineRef;
 
     fn deref(&self) -> &Self::Target {
-        &*self.0
+        &self.0
     }
 }
 

src/lib.rs

@@ -9,6 +9,7 @@
 //! * Most functions which take a string slice as input may possibly panic in the unlikely event that a c style string cannot be created based on it. (IE if your slice already has a null byte in it)
 
 #![deny(missing_debug_implementations)]
+#![allow(clippy::missing_safety_doc, clippy::too_many_arguments, clippy::result_unit_err)]
 #![cfg_attr(feature = "nightly", feature(doc_cfg))]
 
 #[macro_use]
@@ -147,15 +148,9 @@ assert_unique_used_features! {
 ///
 /// # Remarks
 /// See also: https://llvm.org/doxygen/NVPTXBaseInfo_8h_source.html
-#[derive(Debug, PartialEq, Eq, Copy, Clone)]
+#[derive(Debug, PartialEq, Eq, Copy, Clone, Default)]
 pub struct AddressSpace(u32);
 
-impl Default for AddressSpace {
-    fn default() -> Self {
-        AddressSpace(0)
-    }
-}
-
 impl From<u16> for AddressSpace {
     fn from(val: u16) -> Self {
         AddressSpace(val as u32)

src/memory_buffer.rs

@@ -3,6 +3,7 @@ use llvm_sys::core::{
     LLVMCreateMemoryBufferWithMemoryRangeCopy, LLVMCreateMemoryBufferWithSTDIN, LLVMDisposeMemoryBuffer,
     LLVMGetBufferSize, LLVMGetBufferStart,
 };
+#[allow(deprecated)]
 use llvm_sys::object::LLVMCreateObjectFile;
 use llvm_sys::prelude::LLVMMemoryBufferRef;
 
@@ -123,6 +124,7 @@ impl MemoryBuffer {
     /// Convert this `MemoryBuffer` into an `ObjectFile`. LLVM does not currently
     /// provide any way to determine the cause of error if conversion fails.
     pub fn create_object_file(self) -> Result<ObjectFile, ()> {
+        #[allow(deprecated)]
         let object_file = unsafe { LLVMCreateObjectFile(self.memory_buffer) };
 
         forget(self);

src/module.rs

@@ -849,6 +849,7 @@ impl<'ctx> Module<'ctx> {
     }
 
     /// Prints the content of the `Module` to a `String`.
+    #[allow(clippy::inherent_to_string)]
     pub fn to_string(&self) -> String {
         self.print_to_string().to_string()
     }
@@ -1507,7 +1508,7 @@ impl<'ctx> Module<'ctx> {
                 machine.target_machine,
                 options.options_ref,
             );
-            if error == std::ptr::null_mut() {
+            if error.is_null() {
                 Ok(())
             } else {
                 let message = LLVMGetErrorMessage(error);

src/object_file.rs

@@ -1,3 +1,5 @@
+#![allow(deprecated)]
+
 use llvm_sys::object::{
     LLVMDisposeObjectFile, LLVMDisposeRelocationIterator, LLVMDisposeSectionIterator, LLVMDisposeSymbolIterator,
     LLVMGetRelocationOffset, LLVMGetRelocationSymbol, LLVMGetRelocationType, LLVMGetRelocationTypeName,

src/support/error_handling.rs

@@ -10,7 +10,7 @@ use llvm_sys::LLVMDiagnosticSeverity;
 // wrap the provided function input ptr into a &CStr somehow
 // TODOC: Can be used like this:
 // extern "C" fn print_before_exit(msg: *const i8) {
-//    let c_str = unsafe { ::std::ffi::CStr::from_ptr(msg) };
+//    let c_str = unsafe { std::ffi::CStr::from_ptr(msg) };
 //
 //    eprintln!("LLVM fatally errored: {:?}", c_str);
 // }
@@ -42,12 +42,11 @@ impl DiagnosticInfo {
     }
 
     pub(crate) fn severity_is_error(&self) -> bool {
-        unsafe {
-            match LLVMGetDiagInfoSeverity(self.diagnostic_info) {
-                LLVMDiagnosticSeverity::LLVMDSError => true,
-                _ => false,
-            }
-        }
+        self.severity() == LLVMDiagnosticSeverity::LLVMDSError
+    }
+
+    fn severity(&self) -> LLVMDiagnosticSeverity {
+        unsafe { LLVMGetDiagInfoSeverity(self.diagnostic_info) }
     }
 }
 

src/support/mod.rs

@@ -31,6 +31,7 @@ impl LLVMString {
     /// as much as possible to save memory since it is allocated by
     /// LLVM. It's essentially a `CString` with a custom LLVM
     /// deallocator
+    #[allow(clippy::inherent_to_string_shadow_display)]
     pub fn to_string(&self) -> String {
         (*self).to_string_lossy().into_owned()
     }
@@ -135,7 +136,7 @@ pub fn get_llvm_version() -> (u32, u32, u32) {
 
     unsafe { LLVMGetVersion(&mut major, &mut minor, &mut patch) };
 
-    return (major, minor, patch);
+    (major, minor, patch)
 }
 
 /// Possible errors that can occur when loading a library
@@ -186,7 +187,7 @@ pub fn search_for_address_of_symbol(symbol: &str) -> Option<usize> {
     if address.is_null() {
         return None;
     }
-    return Some(address as usize);
+    Some(address as usize)
 }
 
 #[test]
@@ -213,7 +214,7 @@ pub fn enable_llvm_pretty_stack_trace() {
 /// A) Finds a terminating null byte in the Rust string and can reference it directly like a C string.
 ///
 /// B) Finds no null byte and allocates a new C string based on the input Rust string.
-pub(crate) fn to_c_str<'s>(mut s: &'s str) -> Cow<'s, CStr> {
+pub(crate) fn to_c_str(mut s: &str) -> Cow<'_, CStr> {
     if s.is_empty() {
         s = "\0";
     }