@@ -1,3 +1,6 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
3+
14-- |
25-- Module : $Header$
36-- Copyright : (c) 2015 Adam C. Foltzer
@@ -18,6 +21,7 @@
1821-- > panic msg = error panicMsg
1922-- > where panicMsg =
2023-- > concat [ "[panic ", $(gitBranch), "@", $(gitHash)
24+-- > , " (", $(gitCommitDate), ")"
2125-- > , " (", $(gitCommitCount), " commits in HEAD)"
2226-- > , dirty, "] ", msg ]
2327-- > dirty | $(gitDirty) = " (uncommitted files present)"
@@ -26,11 +30,18 @@
2630-- > main = panic "oh no!"
2731--
2832-- > % cabal exec runhaskell Example.hs
29−-- > Example.hs: [panic master@2702e69355c978805064543489c351b61ac6760b (6 commits in HEAD) (uncommitted files present)] oh no!
33+-- > Example.hs: [panic master@2ae047ba5e4a6f0f3e705a43615363ac006099c1 (Mon Jan 11 11:50:59 2016 -0800) (14 commits in HEAD) (uncommitted files present)] oh no!
3034
31−module Development.GitRev (gitHash, gitBranch, gitDirty, gitCommitCount, gitCommitDate) where
35+module Development.GitRev
36+ ( gitBranch
37+ , gitCommitCount
38+ , gitCommitDate
39+ , gitDescribe
40+ , gitDirty
41+ , gitDirtyTracked
42+ , gitHash
43+ ) where
3244
33−import Control.Applicative
3445import Control.Exception
3546import Control.Monad
3647import Data.Maybe
@@ -41,18 +52,21 @@ import System.Exit
4152import System.FilePath
4253import System.Process
4354
55+import Prelude ()
56+import Prelude.Compat
57+
4458-- | Run git with the given arguments and no stdin, returning the
4559-- stdout output. If git isn't available or something goes wrong,
4660-- return the second argument.
47−runGit :: [String] -> String -> Q String
48−runGit args def = do
61+runGit :: [String] -> String -> IndexUsed -> Q String
62+runGit args def useIdx = do
4963 let oops :: SomeException -> IO (ExitCode, String, String)
5064 oops _e = return (ExitFailure 1, def, "")
5165 gitFound <- runIO $ isJust <$> findExecutable "git"
5266 if gitFound
5367 then do
5468 -- a lot of bookkeeping to record the right dependencies
55− pwd <- runIO getCurrentDirectory
69+ pwd <- runIO getDotGit
5670 let hd = pwd </> ".git" </> "HEAD"
5771 index = pwd </> ".git" </> "index"
5872 packedRefs = pwd </> ".git" </> "packed-refs"
@@ -60,8 +74,7 @@ runGit args def = do
6074 when hdExists $ do
6175 -- the HEAD file either contains the hash of a detached head
6276 -- or a pointer to the file that contains the hash of the head
63− hdRef <- runIO $ readFile hd
64− case splitAt 5 hdRef of
77+ splitAt 5 `fmap` runIO (readFile hd) >>= \case
6578 -- pointer to ref
6679 ("ref: ", relRef) -> do
6780 let ref = pwd </> ".git" </> relRef
@@ -71,7 +84,7 @@ runGit args def = do
7184 _hash -> addDependentFile hd
7285 -- add the index if it exists to set the dirty flag
7386 indexExists <- runIO $ doesFileExist index
74− when indexExists $ addDependentFile index
87+ when (indexExists && useIdx == IdxUsed) $ addDependentFile index
7588 -- if the refs have been packed, the info we're looking for
7689 -- might be in that file rather than the one-file-per-ref case
7790 -- handled above
@@ -84,34 +97,84 @@ runGit args def = do
8497 ExitFailure _ -> return def
8598 else return def
8699
100+-- | Determine where our @.git@ directory is, in case we're in a
101+-- submodule.
102+getDotGit :: IO FilePath
103+getDotGit = do
104+ pwd <- getGitRoot
105+ let dotGit = pwd </> ".git"
106+ oops = return dotGit -- it's gonna fail, that's fine
107+ isDir <- doesDirectoryExist dotGit
108+ isFile <- doesFileExist dotGit
109+ if | isDir -> return dotGit
110+ | not isFile -> oops
111+ | isFile ->
112+ splitAt 8 `fmap` readFile dotGit >>= \case
113+ ("gitdir: ", relDir) -> do
114+ isRelDir <- doesDirectoryExist relDir
115+ if isRelDir
116+ then return relDir
117+ else oops
118+ _ -> oops
119+
120+-- | Get the root directory of the Git repo.
121+getGitRoot :: IO FilePath
122+getGitRoot = do
123+ pwd <- getCurrentDirectory
124+ (code, out, _) <-
125+ readProcessWithExitCode "git" ["rev-parse", "--show-toplevel"] ""
126+ case code of
127+ ExitSuccess -> return $ takeWhile (/= '\n') out
128+ ExitFailure _ -> return pwd -- later steps will fail, that's fine
129+
130+-- | Type to flag if the git index is used or not in a call to runGit
131+data IndexUsed = IdxUsed -- ^ The git index is used
132+ | IdxNotUsed -- ^ The git index is /not/ used
133+ deriving (Eq)
134+
87135-- | Return the hash of the current git commit, or @UNKNOWN@ if not in
88136-- a git repository
89137gitHash :: ExpQ
90138gitHash =
91− stringE =<< runGit ["rev-parse", "HEAD"] "UNKNOWN"
139+ stringE =<< runGit ["rev-parse", "HEAD"] "UNKNOWN" IdxNotUsed
92140
93141-- | Return the branch (or tag) name of the current git commit, or @UNKNOWN@
94142-- if not in a git repository. For detached heads, this will just be
95143-- "HEAD"
96144gitBranch :: ExpQ
97145gitBranch =
98− stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN"
146+ stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN" IdxNotUsed
147+
148+-- | Return the long git description for the current git commit, or
149+-- @UNKNOWN@ if not in a git repository.
150+gitDescribe :: ExpQ
151+gitDescribe =
152+ stringE =<< runGit ["describe", "--long", "--always"] "UNKNOWN" IdxNotUsed
99153
100154-- | Return @True@ if there are non-committed files present in the
101155-- repository
102156gitDirty :: ExpQ
103157gitDirty = do
104− output <- runGit ["status", "--porcelain"] ""
158+ output <- runGit ["status", "--porcelain"] "" IdxUsed
159+ case output of
160+ "" -> conE falseName
161+ _ -> conE trueName
162+
163+-- | Return @True@ if there are non-commited changes to tracked files
164+-- present in the repository
165+gitDirtyTracked :: ExpQ
166+gitDirtyTracked = do
167+ output <- runGit ["status", "--porcelain","--untracked-files=no"] "" IdxUsed
105168 case output of
106− "" -> conE $ mkName "Prelude.False"
107− _ -> conE $ mkName "Prelude.True"
169+ "" -> conE falseName
170+ _ -> conE trueName
108171
109172-- | Return the number of commits in the current head
110173gitCommitCount :: ExpQ
111174gitCommitCount =
112− stringE =<< runGit ["rev-list", "HEAD", "--count"] "UNKNOWN"
175+ stringE =<< runGit ["rev-list", "HEAD", "--count"] "UNKNOWN" IdxNotUsed
113176
114177-- | Return the commit date of the current head
115178gitCommitDate :: ExpQ
116179gitCommitDate =
117− stringE =<< runGit ["log", "HEAD", "-1", "--format=%cd"] "UNKNOWN"
180+ stringE =<< runGit ["log", "HEAD", "-1", "--format=%cd"] "UNKNOWN" IdxNotUsed