Merge pull request #454 from well-typed/standard-include-path

Use standard include directories by default

c-expr/test/Main.hs

@@ -114,12 +114,11 @@ main = do
       clangArgs =
         case platformOS hostPlatform of
           Windows -> clangArgs0
-              { Clang.clangStdInc = True
-              }
           Posix ->
             clangArgs0
               { Clang.clangTarget =
                   Just (Clang.Target_Linux_X86_64, Clang.TargetEnvDefault)
+              , Clang.clangStdInc = isNothing mbHsBindgenDir
               , Clang.clangSystemIncludePathDirs =
                   [ fromString (hsBindgenDir </> "musl-include/x86_64")
                   | hsBindgenDir <- maybeToList mbHsBindgenDir

hs-bindgen-libclang/src/HsBindgen/Clang/Args.hs

@@ -37,12 +37,12 @@ data ClangArgs = ClangArgs {
       -- | C standard
     , clangCStandard :: Maybe CStandard
 
-      -- | Enable both standard system @#include@ directories and builtin @#include@ directories (@False@ will pass @-nostdinc@)
-    , clangStdInc :: Bool
-
       -- | Enable GNU extensions when 'True'
     , clangEnableGnu :: Bool
 
+      -- | Enable both standard system @#include@ directories and builtin @#include@ directories (@False@ will pass @-nostdinc@)
+    , clangStdInc :: Bool
+
       -- | Directories in the system include search path
     , clangSystemIncludePathDirs :: [CIncludePathDir]
 
@@ -78,9 +78,9 @@ data CStandard =
 defaultClangArgs :: ClangArgs
 defaultClangArgs = ClangArgs {
       clangTarget                = Nothing
-    , clangStdInc                = False
     , clangCStandard             = Nothing
     , clangEnableGnu             = False
+    , clangStdInc                = True
     , clangSystemIncludePathDirs = []
     , clangQuoteIncludePathDirs  = []
     , clangOtherArgs             = []

hs-bindgen/app/HsBindgen/App/Cmdline.hs

@@ -182,7 +182,7 @@ parseClangArgs = do
     -- and uses record construction (i.a. to avoid bool or string/path blindness) instead of positional one.
     clangTarget <- optional parseTarget
     clangCStandard <- fmap Just parseCStandard
-    clangStdInc <- pure True -- TODO: allow specifying --no-stdinc
+    clangStdInc <- fmap not parseNoStdInc
     clangEnableGnu <-parseGnuOption
     clangSystemIncludePathDirs <- parseSystemIncludeDirOptions
     clangQuoteIncludePathDirs <- parseQuoteIncludeDirOptions
@@ -226,6 +226,12 @@ parseGnuOption = switch $ mconcat [
     , help "Enable GNU extensions"
     ]
 
+parseNoStdInc :: Parser Bool
+parseNoStdInc = switch $ mconcat [
+      long "no-stdinc"
+    , help "Disable standard include directories"
+    ]
+
 parseSystemIncludeDirOptions :: Parser [CIncludePathDir]
 parseSystemIncludeDirOptions = many . strOption $ mconcat [
       long "system-include-path"
@@ -255,7 +261,7 @@ parseOtherArgs = many . option (eitherReader readOtherArg) $ mconcat [
       | "-isystem" `List.isPrefixOf` s =
           Left "System include path must be set using hs-bindgen --system-include-path options"
       | s == "-nostdinc" =
-          Left "Option -nostdinc is always set"
+          Left "No standard includes option must be set using hs-bindgen --no-stdinc option"
       | s == "-std" || "-std=" `List.isPrefixOf` s =
           Left "C standard must be set using hs-bindgen --standard option"
       | s == "--target" || "--target=" `List.isPrefixOf` s =

hs-bindgen/hs-bindgen.cabal

@@ -61,7 +61,6 @@ library
 
   exposed-modules:
       HsBindgen.Lib
-      HsBindgen.TH
   exposed-modules:
       -- Exposed for the sake of tests
       -- TODO: We should reconsider the proper way to export these.

hs-bindgen/src/HsBindgen/Lib.hs

@@ -74,9 +74,12 @@ module HsBindgen.Lib (
   , contramap
   , PrettyLogMsg(..)
 
-  -- * All-in-one functions
-  , templateHaskell
+  -- * Preprocessor API
   , preprocessor
+
+  -- * Template Haskell API
+  , genBindings
+  , genBindings'
   ) where
 
 import Data.Set qualified as Set
@@ -269,43 +272,9 @@ genTests
       hsLineLength
 
 {-------------------------------------------------------------------------------
-  All in one
+  Preprocessor API
 -------------------------------------------------------------------------------}
 
-templateHaskell ::
-     Maybe [FilePath] -- ^ System include search path directories, if @Nothing@ default ones are used.
-  -> [FilePath]       -- ^ Quote include search path directories
-  -> FilePath         -- ^ Input header, as written in C @#include@
-  -> TH.Q [TH.Dec]
-templateHaskell sysIncPathDirs quoteIncPathDirs fp = do
-    headerIncludePath <- either fail return $ parseCHeaderIncludePath fp
-    src <- TH.runIO $ resolveHeader' args headerIncludePath
-    cheader <- TH.runIO $
-      withTranslationUnit nullTracer args src $
-        parseCHeader nullTracer SelectFromMainFile
-
-    -- record dependencies
-    -- TODO: https://github.com/well-typed/hs-bindgen/issues/422
-    TH.addDependentFile $ getSourcePath src
-
-    -- extensions checks.
-    -- Potential TODO: we could also check which enabled extension may interfere with the generated code. (e.g. Strict/Data)
-    enabledExts <- Set.fromList <$> TH.extsEnabled
-    let requiredExts = genExtensions headerIncludePath LowLevel.defaultTranslationOpts cheader
-    let missingExts = requiredExts `Set.difference` enabledExts
-    unless (null missingExts) $ do
-      TH.reportError $ "Missing LANGUAGE extensions: " ++ unwords (map show (toList missingExts))
-
-    -- generate TH declarations
-    genTH headerIncludePath LowLevel.defaultTranslationOpts cheader
-  where
-    args :: ClangArgs
-    args = defaultClangArgs {
-        clangStdInc                = isNothing sysIncPathDirs
-      , clangSystemIncludePathDirs = maybe [] (map CIncludePathDir) sysIncPathDirs
-      , clangQuoteIncludePathDirs  = CIncludePathDir <$> quoteIncPathDirs
-      }
-
 preprocessor ::
      [CIncludePathDir]  -- ^ System include search path directories
   -> [CIncludePathDir]  -- ^ Non-system include search path directories
@@ -338,3 +307,52 @@ preprocessor sysIncPathDirs quoteIncPathDirs headerIncludePath = do
     renderOpts = HsRenderOpts
       { hsLineLength = 120
       }
+
+{-------------------------------------------------------------------------------
+  Template Haskell API
+-------------------------------------------------------------------------------}
+
+-- | Generate bindings for the given C header
+--
+-- TODO: add TranslationOpts argument
+genBindings ::
+     FilePath -- ^ Input header, as written in C @#include@
+  -> ClangArgs
+  -> TH.Q [TH.Dec]
+genBindings fp args = do
+    headerIncludePath <- either fail return $ parseCHeaderIncludePath fp
+    src <- TH.runIO $ resolveHeader' args headerIncludePath
+    cheader <- TH.runIO $
+      withTranslationUnit nullTracer args src $
+        parseCHeader nullTracer SelectFromMainFile
+
+    -- record dependencies
+    -- TODO: https://github.com/well-typed/hs-bindgen/issues/422
+    TH.addDependentFile $ getSourcePath src
+
+    -- extensions checks.
+    -- Potential TODO: we could also check which enabled extension may interfere with the generated code. (e.g. Strict/Data)
+    enabledExts <- Set.fromList <$> TH.extsEnabled
+    let requiredExts = genExtensions headerIncludePath LowLevel.defaultTranslationOpts cheader
+    let missingExts = requiredExts `Set.difference` enabledExts
+    unless (null missingExts) $ do
+      TH.reportError $ "Missing LANGUAGE extensions: " ++ unwords (map show (toList missingExts))
+
+    -- generate TH declarations
+    genTH headerIncludePath LowLevel.defaultTranslationOpts cheader
+
+-- | Generate bindings for the given C header
+--
+-- This function uses default Clang arguments but allows you to add directories
+-- to the include search path.  Use 'genBindings' when more configuration is
+-- required.
+genBindings' ::
+     [FilePath] -- ^ Quote include search path directories
+  -> FilePath   -- ^ Input header, as written in C @#include@
+  -> TH.Q [TH.Dec]
+genBindings' quoteIncPathDirs fp = genBindings fp args
+  where
+    args :: ClangArgs
+    args = defaultClangArgs {
+        clangQuoteIncludePathDirs  = CIncludePathDir <$> quoteIncPathDirs
+      }

hs-bindgen/test-th/Test01.hs

@@ -21,4 +21,4 @@ import Language.Haskell.TH.Syntax.Compat (getPackageRoot)
 import Language.Haskell.TH.Syntax (getPackageRoot)
 #endif
 
-$(getPackageRoot >>= \dir -> templateHaskell Nothing [dir </> "examples"] "test-th-01.h")
+$(getPackageRoot >>= \dir -> genBindings' [dir </> "examples"] "test-th-01.h")