Merge branch 'master' into dependabot/cargo/thiserror-2.0.11

Author: TheDan64

.github/workflows/test.yml

@@ -4,32 +4,31 @@ on: [push, pull_request]
 
 env:
   CARGO_TERM_COLOR: always
-  DOC_LLVM_FEATURE: llvm18-0
+  DOC_LLVM_FEATURE: llvm18-1
   DOC_LLVM_VERSION: "18.1"
   DOC_PATH: target/doc
 
 jobs:
-  typos:
-    name: Typos
+  lint:
+    name: Linting
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
       - name: Install Rust Stable
         uses: dtolnay/rust-toolchain@stable
       - name: Install typos
         uses: taiki-e/install-action@typos
-      - name: Run typos
+      - name: Check typos
         run: typos .
+      - name: Check code formatting
+        run: cargo fmt --check
   tests:
     name: "LLVM ${{ matrix.llvm-version[0] }}: ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         llvm-version:
-          - ["4.0", "4-0"]
-          - ["5.0", "5-0"]
-          - ["6.0", "6-0"]
-          - ["7.0", "7-0"]
-          - ["7.1", "7-0"]
           - ["8.0", "8-0"]
           - ["9.0", "9-0"]
           - ["10.0", "10-0"]
@@ -40,31 +39,24 @@ jobs:
           - ["15.0", "15-0"]
           - ["16.0", "16-0"]
           - ["17.0", "17-0"]
-          - ["18.1", "18-0"]
+          - ["18.1", "18-1"]
         include:
-          - os: ubuntu-20.04
-          # only use ubuntu-22.04 for llvm 16 and llvm 17
-          - 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@v4
+      - name: Install Dependencies
+        run: sudo apt update && sudo apt install -y libtinfo5
       - name: Install LLVM and Clang (LLVM >= 7.1)
         uses: KyleMayes/install-llvm-action@v2
-        if: ${{ matrix.llvm-version[0] > 7 }}
-        with:
-          version: ${{ matrix.llvm-version[0] }}
-      - name: Install LLVM and Clang (LLVM <= 7)
-        uses: KyleMayes/install-llvm-action@v1
-        if: ${{ matrix.llvm-version[0] <= 7 }}
         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: cargo clippy
+        run: cargo clippy --tests --features llvm${{ matrix.llvm-version[1] }} -- -D warnings
       - name: Build
         run: cargo build --release --features llvm${{ matrix.llvm-version[1] }} --verbose
       - name: Run tests
@@ -73,8 +65,8 @@ jobs:
         run: cargo build --example kaleidoscope --features llvm${{ matrix.llvm-version[1] }} --verbose
   doc:
     name: Documentation
-    runs-on: ubuntu-20.04
-    needs: [typos, tests]
+    runs-on: ubuntu-22.04
+    needs: [lint, tests]
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     steps:
       - uses: actions/checkout@v4

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "inkwell"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Daniel Kolsoi <[email protected]>"]
 description = "Inkwell aims to help you pen your own programming languages by safely wrapping llvm-sys."
 documentation = "https://thedan64.github.io/inkwell/"
@@ -13,33 +13,26 @@ edition = "2021"
 
 [features]
 default = ["target-all"]
+typed-pointers = []
 
 # Please update internal_macros::FEATURE_VERSIONS when adding a new LLVM version
-llvm4-0 = ["llvm-sys-40"]
-llvm5-0 = ["llvm-sys-50"]
-llvm6-0 = ["llvm-sys-60"]
-llvm7-0 = ["llvm-sys-70"]
-llvm8-0 = ["llvm-sys-80"]
-llvm9-0 = ["llvm-sys-90"]
-llvm10-0 = ["llvm-sys-100"]
-llvm11-0 = ["llvm-sys-110"]
-llvm12-0 = ["llvm-sys-120"]
-llvm13-0 = ["llvm-sys-130"]
-llvm14-0 = ["llvm-sys-140"]
+llvm8-0 = ["llvm-sys-80", "typed-pointers"]
+llvm9-0 = ["llvm-sys-90", "typed-pointers"]
+llvm10-0 = ["llvm-sys-100", "typed-pointers"]
+llvm11-0 = ["llvm-sys-110", "typed-pointers"]
+llvm12-0 = ["llvm-sys-120", "typed-pointers"]
+llvm13-0 = ["llvm-sys-130", "typed-pointers"]
+llvm14-0 = ["llvm-sys-140", "typed-pointers"]
 llvm15-0 = ["llvm-sys-150"]
 llvm16-0 = ["llvm-sys-160"]
 llvm17-0 = ["llvm-sys-170"]
-llvm18-0 = ["llvm-sys-180"]
+llvm18-1 = ["llvm-sys-181"]
 
 # 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
 # cargo to try and download and compile them all. See
 # https://github.com/rust-lang/cargo/issues/3494
-llvm4-0-no-llvm-linking = ["llvm4-0", "llvm-sys-40/no-llvm-linking"]
-llvm5-0-no-llvm-linking = ["llvm5-0", "llvm-sys-50/no-llvm-linking"]
-llvm6-0-no-llvm-linking = ["llvm6-0", "llvm-sys-60/no-llvm-linking"]
-llvm7-0-no-llvm-linking = ["llvm7-0", "llvm-sys-70/no-llvm-linking"]
 llvm8-0-no-llvm-linking = ["llvm8-0", "llvm-sys-80/no-llvm-linking"]
 llvm9-0-no-llvm-linking = ["llvm9-0", "llvm-sys-90/no-llvm-linking"]
 llvm10-0-no-llvm-linking = ["llvm10-0", "llvm-sys-100/no-llvm-linking"]
@@ -50,7 +43,7 @@ llvm14-0-no-llvm-linking = ["llvm14-0", "llvm-sys-140/no-llvm-linking"]
 llvm15-0-no-llvm-linking = ["llvm15-0", "llvm-sys-150/no-llvm-linking"]
 llvm16-0-no-llvm-linking = ["llvm16-0", "llvm-sys-160/no-llvm-linking"]
 llvm17-0-no-llvm-linking = ["llvm17-0", "llvm-sys-170/no-llvm-linking"]
-llvm18-0-no-llvm-linking = ["llvm18-0", "llvm-sys-180/no-llvm-linking"]
+llvm18-1-no-llvm-linking = ["llvm18-1", "llvm-sys-181/no-llvm-linking"]
 
 # Linking preference.
 # If none of these are enabled, it defaults to force static linking.
@@ -62,7 +55,7 @@ llvm14-0-force-dynamic = ["llvm14-0", "llvm-sys-140/force-dynamic"]
 llvm15-0-force-dynamic = ["llvm15-0", "llvm-sys-150/force-dynamic"]
 llvm16-0-force-dynamic = ["llvm16-0", "llvm-sys-160/force-dynamic"]
 llvm17-0-force-dynamic = ["llvm17-0", "llvm-sys-170/force-dynamic"]
-llvm18-0-force-dynamic = ["llvm18-0", "llvm-sys-180/force-dynamic"]
+llvm18-1-force-dynamic = ["llvm18-1", "llvm-sys-181/force-dynamic"]
 
 # Prefer dynamic linking against LLVM libraries. See llvm-sys for more details
 llvm12-0-prefer-dynamic = ["llvm12-0", "llvm-sys-120/prefer-dynamic"]
@@ -71,7 +64,7 @@ llvm14-0-prefer-dynamic = ["llvm14-0", "llvm-sys-140/prefer-dynamic"]
 llvm15-0-prefer-dynamic = ["llvm15-0", "llvm-sys-150/prefer-dynamic"]
 llvm16-0-prefer-dynamic = ["llvm16-0", "llvm-sys-160/prefer-dynamic"]
 llvm17-0-prefer-dynamic = ["llvm17-0", "llvm-sys-170/prefer-dynamic"]
-llvm18-0-prefer-dynamic = ["llvm18-0", "llvm-sys-180/prefer-dynamic"]
+llvm18-1-prefer-dynamic = ["llvm18-1", "llvm-sys-181/prefer-dynamic"]
 
 # Force static linking against LLVM libraries. See llvm-sys for more details
 llvm12-0-force-static = ["llvm12-0", "llvm-sys-120/force-static"]
@@ -80,7 +73,7 @@ llvm14-0-force-static = ["llvm14-0", "llvm-sys-140/force-static"]
 llvm15-0-force-static = ["llvm15-0", "llvm-sys-150/force-static"]
 llvm16-0-force-static = ["llvm16-0", "llvm-sys-160/force-static"]
 llvm17-0-force-static = ["llvm17-0", "llvm-sys-170/force-static"]
-llvm18-0-force-static = ["llvm18-0", "llvm-sys-180/force-static"]
+llvm18-1-force-static = ["llvm18-1", "llvm-sys-181/force-static"]
 
 # Prefer static linking against LLVM libraries. See llvm-sys for more details
 llvm12-0-prefer-static = ["llvm12-0", "llvm-sys-120/prefer-static"]
@@ -89,7 +82,7 @@ llvm14-0-prefer-static = ["llvm14-0", "llvm-sys-140/prefer-static"]
 llvm15-0-prefer-static = ["llvm15-0", "llvm-sys-150/prefer-static"]
 llvm16-0-prefer-static = ["llvm16-0", "llvm-sys-160/prefer-static"]
 llvm17-0-prefer-static = ["llvm17-0", "llvm-sys-170/prefer-static"]
-llvm18-0-prefer-static = ["llvm18-0", "llvm-sys-180/prefer-static"]
+llvm18-1-prefer-static = ["llvm18-1", "llvm-sys-181/prefer-static"]
 
 # Don't force linking to libffi on non-windows platforms. Without this feature
 # inkwell always links to libffi on non-windows platforms.
@@ -135,31 +128,29 @@ experimental = ["static-alloc"]
 nightly = ["inkwell_internals/nightly"]
 
 [dependencies]
-inkwell_internals = { path = "./internal_macros", version = "0.10.0" }
+inkwell_internals = { path = "./internal_macros", version = "0.11.0" }
 
-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 }
-llvm-sys-70 = { package = "llvm-sys", version = "70.4", optional = true }
 llvm-sys-80 = { package = "llvm-sys", version = "80.3", optional = true }
-llvm-sys-90 = { package = "llvm-sys", version = "90.2.1", optional = true }
-llvm-sys-100 = { package = "llvm-sys", version = "100.2.3", optional = true }
-llvm-sys-110 = { package = "llvm-sys", version = "110.0.3", optional = true }
-llvm-sys-120 = { package = "llvm-sys", version = "120.2.4", optional = true }
-llvm-sys-130 = { package = "llvm-sys", version = "130.0.4", optional = true }
-llvm-sys-140 = { package = "llvm-sys", version = "140.0.2", optional = true }
-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-90 = { package = "llvm-sys", version = "90.2.2", optional = true }
+llvm-sys-100 = { package = "llvm-sys", version = "100.2.4", optional = true }
+llvm-sys-110 = { package = "llvm-sys", version = "110.0.4", optional = true }
+llvm-sys-120 = { package = "llvm-sys", version = "120.3.2", optional = true }
+llvm-sys-130 = { package = "llvm-sys", version = "130.1.2", optional = true }
+llvm-sys-140 = { package = "llvm-sys", version = "140.1.3", optional = true }
+llvm-sys-150 = { package = "llvm-sys", version = "150.2.1", optional = true }
+llvm-sys-160 = { package = "llvm-sys", version = "160.2.1", optional = true }
 llvm-sys-170 = { package = "llvm-sys", version = "170.2.0", optional = true }
-llvm-sys-180 = { package = "llvm-sys", version = "181.2.0", optional = true }
+llvm-sys-181 = { package = "llvm-sys", version = "181.2.0", optional = true }
 
 either = "1.5"
 libc = "0.2"
 once_cell = "1.16"
 thiserror = "2.0.11"
 
 static-alloc = { version = "0.2", optional = true }
-serde = { version = "1.0", default-features = false, features = ["derive"], optional = true }
+serde = { version = "1.0", default-features = false, features = [
+    "derive",
+], optional = true }
 
 [dev-dependencies]
 regex = "1"

README.md

@@ -14,15 +14,15 @@ Inkwell aims to help you pen your own programming languages by safely wrapping l
 ## Requirements
 
 * Rust 1.56+ (Stable, Beta, or Nightly)
-* One of LLVM 4-18
+* One of LLVM 8-18
 
 ## Usage
 
 You'll need to point your Cargo.toml to use a single LLVM version feature flag corresponding to your LLVM version as such:
 
 ```toml
 [dependencies]
-inkwell = { version = "0.5.0", features = ["llvm18-0"] }
+inkwell = { version = "0.6.0", features = ["llvm18-1"] }
 ```
 
 Supported versions:

examples/kaleidoscope/implementation_typed_pointers.rs

@@ -11,8 +11,6 @@ use inkwell::types::BasicMetadataTypeEnum;
 use inkwell::values::{BasicMetadataValueEnum, BasicValueEnum, FloatValue, FunctionValue, PointerValue};
 use inkwell::FloatPredicate;
 
-use inkwell_internals::llvm_versions;
-
 use crate::Token::*;
 
 const ANONYMOUS_FUNCTION_NAME: &str = "anonymous";
@@ -856,12 +854,12 @@ impl<'a, 'ctx> Compiler<'a, 'ctx> {
         builder.build_alloca(self.context.f64_type(), name).unwrap()
     }
 
-    #[llvm_versions(..=14)]
+    #[cfg(feature = "typed-pointers")]
     pub fn build_load(&self, ptr: PointerValue<'ctx>, name: &str) -> BasicValueEnum<'ctx> {
         self.builder.build_load(ptr, name).unwrap()
     }
 
-    #[llvm_versions(15..)]
+    #[cfg(not(feature = "typed-pointers"))]
     pub fn build_load(&self, ptr: PointerValue<'ctx>, name: &str) -> BasicValueEnum<'ctx> {
         self.builder.build_load(self.context.f64_type(), ptr, name).unwrap()
     }

internal_macros/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 authors = ["Daniel Kolsoi <[email protected]>"]
 description = "Internal macro crate for inkwell"
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 name = "inkwell_internals"
 readme = "README.md"
 repository = "https://github.com/TheDan64/inkwell"
-version = "0.10.0"
+version = "0.11.0"
 
 [dependencies]
 proc-macro2 = "1.0"

internal_macros/src/cfg.rs

@@ -9,8 +9,8 @@ use syn::{Lit, RangeLimits};
 
 // This array should match the LLVM features in the top level Cargo manifest
 const FEATURE_VERSIONS: &[&str] = &[
-    "llvm4-0", "llvm5-0", "llvm6-0", "llvm7-0", "llvm8-0", "llvm9-0", "llvm10-0", "llvm11-0", "llvm12-0", "llvm13-0",
-    "llvm14-0", "llvm15-0", "llvm16-0", "llvm17-0", "llvm18-0",
+    "llvm8-0", "llvm9-0", "llvm10-0", "llvm11-0", "llvm12-0", "llvm13-0", "llvm14-0", "llvm15-0", "llvm16-0",
+    "llvm17-0", "llvm18-1",
 ];
 
 pub struct VersionRange {
@@ -111,11 +111,22 @@ struct Version {
     span: Span,
 }
 
+fn default_minor(major: u32) -> u32 {
+    if major >= 18 {
+        1
+    } else {
+        0
+    }
+}
+
 impl Parse for Version {
     fn parse(input: ParseStream) -> Result<Self> {
         let lit = input.parse::<Lit>()?;
         let (major, minor) = match &lit {
-            Lit::Int(int) => (int.base10_parse()?, 0),
+            Lit::Int(int) => {
+                let major = int.base10_parse()?;
+                (major, default_minor(major))
+            },
             Lit::Float(float) => {
                 let s = float.base10_digits();
                 let mut parts = s.split('.');
@@ -127,7 +138,7 @@ impl Parse for Version {
                 let minor = if let Some(minor) = parts.next() {
                     minor.parse().map_err(|e| syn::Error::new(float.span(), e))?
                 } else {
-                    0
+                    default_minor(major)
                 };
                 (major, minor)
             },

src/attributes.rs

@@ -73,6 +73,8 @@ impl PartialEq<Self> for Attribute {
         }
 
         if self.is_type() && other.is_type() {
+            // Seems to be some clippy bug here, but it's not clear why.
+            #[allow(clippy::unit_cmp)]
             return self.get_enum_kind_id() == other.get_enum_kind_id()
                 && self.get_type_value() == other.get_type_value();
         }

src/basic_block.rs

@@ -5,7 +5,7 @@ use llvm_sys::core::{
     LLVMGetBasicBlockTerminator, LLVMGetFirstInstruction, LLVMGetFirstUse, LLVMGetLastInstruction,
     LLVMGetNextBasicBlock, LLVMGetPreviousBasicBlock, LLVMGetTypeContext, LLVMIsABasicBlock, LLVMIsConstant,
     LLVMMoveBasicBlockAfter, LLVMMoveBasicBlockBefore, LLVMPrintTypeToString, LLVMPrintValueToString,
-    LLVMRemoveBasicBlockFromParent, LLVMReplaceAllUsesWith, LLVMTypeOf,
+    LLVMRemoveBasicBlockFromParent, LLVMReplaceAllUsesWith, LLVMSetValueName2, LLVMTypeOf,
 };
 use llvm_sys::prelude::{LLVMBasicBlockRef, LLVMValueRef};
 
@@ -288,9 +288,9 @@ impl<'ctx> BasicBlock<'ctx> {
     ///
     /// let void_type = context.void_type();
     /// let i32_type = context.i32_type();
-    /// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
+    /// #[cfg(feature = "typed-pointers")]
     /// let i32_ptr_type = i32_type.ptr_type(AddressSpace::default());
-    /// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
+    /// #[cfg(not(feature = "typed-pointers"))]
     /// let i32_ptr_type = context.ptr_type(AddressSpace::default());
     ///
     /// let fn_type = void_type.fn_type(&[i32_ptr_type.into()], false);
@@ -471,18 +471,13 @@ impl<'ctx> BasicBlock<'ctx> {
     pub fn set_name(&self, name: &str) {
         let c_string = to_c_str(name);
 
-        #[cfg(any(feature = "llvm4-0", feature = "llvm5-0", feature = "llvm6-0"))]
-        {
-            use llvm_sys::core::LLVMSetValueName;
-
-            unsafe { LLVMSetValueName(LLVMBasicBlockAsValue(self.basic_block), c_string.as_ptr()) };
-        }
-        #[cfg(not(any(feature = "llvm4-0", feature = "llvm5-0", feature = "llvm6-0")))]
-        {
-            use llvm_sys::core::LLVMSetValueName2;
-
-            unsafe { LLVMSetValueName2(LLVMBasicBlockAsValue(self.basic_block), c_string.as_ptr(), c_string.to_bytes().len()) };
-        }
+        unsafe {
+            LLVMSetValueName2(
+                LLVMBasicBlockAsValue(self.basic_block),
+                c_string.as_ptr(),
+                c_string.to_bytes().len(),
+            )
+        };
     }
 
     /// Replaces all uses of this basic block with another.