Merge pull request #1311 from well-typed/bolt12/bump-libclang

Bump libclang and compare its versions

Author: bolt12

cabal.project.base

@@ -4,4 +4,4 @@ index-state: 2025-09-16T04:55:58Z
 source-repository-package
     type: git
     location: https://github.com/well-typed/libclang
-    tag: 41f70874b0f803366144059c0ed0f65809e8c385
+    tag: b62972c5a4227f92ac7af7df60af52f9ead7bd35

flake.lock

@@ -109,6 +109,7 @@ library internal
     HsBindgen.Cache
     HsBindgen.Clang
     HsBindgen.Clang.BuiltinIncDir
+    HsBindgen.Clang.CompareVersions
     HsBindgen.Clang.ExtraClangArgs
     HsBindgen.Config.ClangArgs
     HsBindgen.Config.FixCandidate

hs-bindgen/hs-bindgen.cabal

@@ -13,6 +13,8 @@ import Clang.Args
 import HsBindgen.BindingSpec
 import HsBindgen.Cache
 import HsBindgen.Clang.BuiltinIncDir
+import HsBindgen.Clang.CompareVersions (CompareVersionsMsg,
+                                        compareClangVersions)
 import HsBindgen.Clang.ExtraClangArgs
 import HsBindgen.Config.ClangArgs (ClangArgsConfig)
 import HsBindgen.Config.ClangArgs qualified as ClangArgs
@@ -102,6 +104,7 @@ getClangArgs tracer config = do
       fst <$> ClangArgs.target config
     mBuiltinIncDir <- getBuiltinIncDir (contramap BootBuiltinIncDir tracer) $
       ClangArgs.builtinIncDir config
+    compareClangVersions (contramap BootCompareClangVersions tracer)
     either throwIO return
       . ClangArgs.getClangArgs
       . applyExtraClangArgs extraClangArgs
@@ -152,12 +155,13 @@ instance IsTrace Level BootStatusMsg where
 
 -- | Boot trace messages
 data BootMsg =
-    BootBackendConfig  BackendConfigMsg
-  | BootBindingSpec    BindingSpecMsg
-  | BootBuiltinIncDir  BuiltinIncDirMsg
-  | BootExtraClangArgs ExtraClangArgsMsg
-  | BootHashIncludeArg HashIncludeArgMsg
-  | BootStatus         BootStatusMsg
-  | BootCache          (SafeTrace CacheMsg)
+    BootBackendConfig        BackendConfigMsg
+  | BootBindingSpec          BindingSpecMsg
+  | BootBuiltinIncDir        BuiltinIncDirMsg
+  | BootExtraClangArgs       ExtraClangArgsMsg
+  | BootHashIncludeArg       HashIncludeArgMsg
+  | BootCompareClangVersions CompareVersionsMsg
+  | BootStatus               BootStatusMsg
+  | BootCache                (SafeTrace CacheMsg)
   deriving stock (Show, Generic)
   deriving anyclass (PrettyForTrace, IsTrace Level)

hs-bindgen/src-internal/HsBindgen/Boot.hs

@@ -0,0 +1,50 @@
+
+module HsBindgen.Clang.CompareVersions where
+
+import Text.SimplePrettyPrint ((<+>))
+import Text.SimplePrettyPrint qualified as PP
+
+import Clang.Version (clangVersionCompileTime, clang_getClangVersion)
+
+import HsBindgen.Imports
+import HsBindgen.Util.Tracer
+
+{-------------------------------------------------------------------------------
+  Trace messages
+-------------------------------------------------------------------------------}
+
+data CompareVersionsMsg =
+    CompileTimeAndRuntimeVersionMismatch Text Text
+  deriving stock (Show)
+
+instance PrettyForTrace CompareVersionsMsg where
+  prettyForTrace = \case
+    CompileTimeAndRuntimeVersionMismatch compileTimeVersion runtimeVersion ->
+      PP.hangs' "clang version mismatch:" 2 [
+          "clang compile time version:" <+> PP.textToCtxDoc compileTimeVersion
+        , "clang runtime version:     " <+> PP.textToCtxDoc runtimeVersion
+        ]
+
+instance IsTrace Level CompareVersionsMsg where
+  getDefaultLogLevel = \case
+    CompileTimeAndRuntimeVersionMismatch _ _ -> Warning
+
+  getSource  = const HsBindgen
+
+  getTraceId = const "compare-clang-versions"
+
+{-------------------------------------------------------------------------------
+  Comparison functions
+-------------------------------------------------------------------------------}
+
+-- | Get
+--
+-- @clang -print-file-name=include@ is called to get the builtin include
+-- directory.
+compareClangVersions :: Tracer CompareVersionsMsg -> IO ()
+compareClangVersions tracer = do
+  let compileTimeVersion = clangVersionCompileTime
+  runtimeVersion <- liftIO clang_getClangVersion
+  when (compileTimeVersion /= runtimeVersion) $
+    traceWith tracer (CompileTimeAndRuntimeVersionMismatch compileTimeVersion runtimeVersion)
+