@@ -1,3 +1,6 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
2-- Module : $Header$
5-- Module : $Header$
3-- Copyright : (c) 2015 Adam C. Foltzer
6-- Copyright : (c) 2015 Adam C. Foltzer
@@ -17,18 +20,28 @@
17-- > panic :: String -> a
20-- > panic :: String -> a
18-- > panic msg = error panicMsg
21-- > panic msg = error panicMsg
19-- > where panicMsg =
22-- > where panicMsg =
20−-- > concat [ "[panic ", $(gitBranch), "@", $(gitHash), dirty, "] ", msg ]
23+-- > concat [ "[panic ", $(gitBranch), "@", $(gitHash)
24+-- > , " (", $(gitCommitDate), ")"
25+-- > , " (", $(gitCommitCount), " commits in HEAD)"
26+-- > , dirty, "] ", msg ]
21-- > dirty | $(gitDirty) = " (uncommitted files present)"
27-- > dirty | $(gitDirty) = " (uncommitted files present)"
22-- > | otherwise = ""
28-- > | otherwise = ""
24-- > main = panic "oh no!"
30-- > main = panic "oh no!"
26-- > % cabal exec runhaskell Example.hs
32-- > % cabal exec runhaskell Example.hs
27−-- > Example.hs: [panic master@4a0a592c37ad908889bd2a7a411923a903ed05a3 (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!
29−module Development.GitRev (gitHash, gitBranch, gitDirty) where
35+module Development.GitRev
31−import Control.Applicative
32import Control.Exception
45import Control.Exception
33import Control.Monad
46import Control.Monad
34import Data.Maybe
47import Data.Maybe
@@ -39,18 +52,21 @@ import System.Exit
39import System.FilePath
52import System.FilePath
40import System.Process
53import System.Process
42-- | Run git with the given arguments and no stdin, returning the
58-- | Run git with the given arguments and no stdin, returning the
43-- stdout output. If git isn't available or something goes wrong,
59-- stdout output. If git isn't available or something goes wrong,
44-- return the second argument.
60-- return the second argument.
45−runGit :: [String] -> String -> Q String
61+runGit :: [String] -> String -> IndexUsed -> Q String
46−runGit args def = do
62+runGit args def useIdx = do
47 let oops :: SomeException -> IO (ExitCode, String, String)
63 let oops :: SomeException -> IO (ExitCode, String, String)
48 oops _e = return (ExitFailure 1, def, "")
64 oops _e = return (ExitFailure 1, def, "")
49 gitFound <- runIO $ isJust <$> findExecutable "git"
65 gitFound <- runIO $ isJust <$> findExecutable "git"
50 if gitFound
66 if gitFound
52 -- a lot of bookkeeping to record the right dependencies
68 -- a lot of bookkeeping to record the right dependencies
53− pwd <- runIO getCurrentDirectory
69+ pwd <- runIO getDotGit
54 let hd = pwd </> ".git" </> "HEAD"
70 let hd = pwd </> ".git" </> "HEAD"
55 index = pwd </> ".git" </> "index"
71 index = pwd </> ".git" </> "index"
56 packedRefs = pwd </> ".git" </> "packed-refs"
72 packedRefs = pwd </> ".git" </> "packed-refs"
@@ -58,8 +74,7 @@ runGit args def = do
58 when hdExists $ do
74 when hdExists $ do
59 -- the HEAD file either contains the hash of a detached head
75 -- the HEAD file either contains the hash of a detached head
60 -- or a pointer to the file that contains the hash of the head
76 -- or a pointer to the file that contains the hash of the head
61− hdRef <- runIO $ readFile hd
77+ splitAt 5 `fmap` runIO (readFile hd) >>= \case
62− case splitAt 5 hdRef of
63 -- pointer to ref
78 -- pointer to ref
64 ("ref: ", relRef) -> do
79 ("ref: ", relRef) -> do
65 let ref = pwd </> ".git" </> relRef
80 let ref = pwd </> ".git" </> relRef
@@ -69,7 +84,7 @@ runGit args def = do
69 _hash -> addDependentFile hd
84 _hash -> addDependentFile hd
70 -- add the index if it exists to set the dirty flag
85 -- add the index if it exists to set the dirty flag
71 indexExists <- runIO $ doesFileExist index
86 indexExists <- runIO $ doesFileExist index
72− when indexExists $ addDependentFile index
87+ when (indexExists && useIdx == IdxUsed) $ addDependentFile index
73 -- if the refs have been packed, the info we're looking for
88 -- if the refs have been packed, the info we're looking for
74 -- might be in that file rather than the one-file-per-ref case
89 -- might be in that file rather than the one-file-per-ref case
75 -- handled above
90 -- handled above
@@ -82,24 +97,84 @@ runGit args def = do
82 ExitFailure _ -> return def
97 ExitFailure _ -> return def
83 else return def
98 else return def
100+-- | Determine where our @.git@ directory is, in case we're in a
102+getDotGit :: IO FilePath
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
112+ splitAt 8 `fmap` readFile dotGit >>= \case
113+ ("gitdir: ", relDir) -> do
114+ isRelDir <- doesDirectoryExist relDir
120+-- | Get the root directory of the Git repo.
121+getGitRoot :: IO FilePath
123+ pwd <- getCurrentDirectory
125+ readProcessWithExitCode "git" ["rev-parse", "--show-toplevel"] ""
127+ ExitSuccess -> return $ takeWhile (/= '\n') out
128+ ExitFailure _ -> return pwd -- later steps will fail, that's fine
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
85-- | Return the hash of the current git commit, or @UNKNOWN@ if not in
135-- | Return the hash of the current git commit, or @UNKNOWN@ if not in
86-- a git repository
136-- a git repository
87gitHash :: ExpQ
137gitHash :: ExpQ
89− stringE =<< runGit ["rev-parse", "HEAD"] "UNKNOWN"
139+ stringE =<< runGit ["rev-parse", "HEAD"] "UNKNOWN" IdxNotUsed
91-- | Return the branch (or tag) name of the current git commit, or @UNKNOWN@
141-- | Return the branch (or tag) name of the current git commit, or @UNKNOWN@
92-- if not in a git repository. For detached heads, this will just be
142-- if not in a git repository. For detached heads, this will just be
94gitBranch :: ExpQ
144gitBranch :: ExpQ
95gitBranch =
145gitBranch =
96− stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN"
146+ stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN" IdxNotUsed
148+-- | Return the long git description for the current git commit, or
149+-- @UNKNOWN@ if not in a git repository.
152+ stringE =<< runGit ["describe", "--long", "--always"] "UNKNOWN" IdxNotUsed
98-- | Return @True@ if there are non-committed files present in the
154-- | Return @True@ if there are non-committed files present in the
99-- repository
155-- repository
100gitDirty :: ExpQ
156gitDirty :: ExpQ
101gitDirty = do
157gitDirty = do
102− output <- runGit ["status", "--porcelain"] ""
158+ output <- runGit ["status", "--porcelain"] "" IdxUsed
103 case output of
159 case output of
104 "" -> conE falseName
160 "" -> conE falseName
105 _ -> conE trueName
161 _ -> conE trueName
163+-- | Return @True@ if there are non-commited changes to tracked files
164+-- present in the repository
165+gitDirtyTracked :: ExpQ
167+ output <- runGit ["status", "--porcelain","--untracked-files=no"] "" IdxUsed
169+ "" -> conE falseName
172+-- | Return the number of commits in the current head
173+gitCommitCount :: ExpQ
175+ stringE =<< runGit ["rev-list", "HEAD", "--count"] "UNKNOWN" IdxNotUsed
177+-- | Return the commit date of the current head
178+gitCommitDate :: ExpQ
180+ stringE =<< runGit ["log", "HEAD", "-1", "--format=%cd"] "UNKNOWN" IdxNotUsed