-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Git operations in haskell -- -- An haskell implementation of git storage operations, allowing users to -- manipulate git repositories (read and write). -- -- This implementation is fully interoperable with the main C -- implementation. -- -- This is stricly only manipulating the git store (what's inside the -- .git directory), and doesn't do anything with the index or your -- working directory files. @package git @version 0.1 module Data.Git.Revision -- | A git revision. this can be many things: * a shorten ref * a ref * a -- named branch or tag followed by optional modifiers RevModifier -- that can represent: * parenting * type * date data Revision Revision :: String -> [RevModifier] -> Revision -- | A modifier to a revision, which is a function apply of a revision data RevModifier -- | parent accessor ^n and ^ RevModParent :: Int -> RevModifier -- | parent accessor ~n RevModParentFirstN :: Int -> RevModifier -- | @{type} accessor RevModAtType :: String -> RevModifier -- | @{date} accessor RevModAtDate :: String -> RevModifier -- | @{n} accessor RevModAtN :: Int -> RevModifier -- | Exception when a revision cannot be resolved to a reference data RevisionNotFound RevisionNotFound :: Revision -> RevisionNotFound fromString :: IsString a => String -> a instance Data.Data.Data Data.Git.Revision.RevisionNotFound instance GHC.Classes.Eq Data.Git.Revision.RevisionNotFound instance GHC.Show.Show Data.Git.Revision.RevisionNotFound instance Data.Data.Data Data.Git.Revision.Revision instance GHC.Classes.Eq Data.Git.Revision.Revision instance Data.Data.Data Data.Git.Revision.RevModifier instance GHC.Classes.Eq Data.Git.Revision.RevModifier instance GHC.Show.Show Data.Git.Revision.RevModifier instance GHC.Show.Show Data.Git.Revision.Revision instance Data.String.IsString Data.Git.Revision.Revision instance GHC.Base.Functor (Data.Git.Revision.Stream elem) instance GHC.Base.Applicative (Data.Git.Revision.Stream elem) instance GHC.Base.Alternative (Data.Git.Revision.Stream elem) instance GHC.Base.Monad (Data.Git.Revision.Stream elem) module Data.Git.Ref -- | represent a git reference (SHA1) data Ref -- | Invalid Reference exception raised when using something that is not a -- ref as a ref. data RefInvalid RefInvalid :: ByteString -> RefInvalid -- | Reference wasn't found data RefNotFound RefNotFound :: Ref -> RefNotFound isHex :: ByteString -> Bool isHexString :: String -> Bool -- | take a hexadecimal bytestring that represent a reference and turn into -- a ref fromHex :: ByteString -> Ref -- | take a hexadecimal string that represent a reference and turn into a -- ref fromHexString :: String -> Ref -- | transform a bytestring that represent a binary bytestring and returns -- a ref. fromBinary :: ByteString -> Ref -- | transform a bytestring that represent a binary bytestring and returns -- a ref. fromDigest :: Digest SHA1 -> Ref -- | turn a reference into a binary bytestring toBinary :: Ref -> ByteString -- | transform a ref into an hexadecimal bytestring toHex :: Ref -> ByteString -- | transform a ref into an hexadecimal string toHexString :: Ref -> String -- | returns the prefix (leading byte) of this reference refPrefix :: Ref -> Int -- | compare prefix cmpPrefix :: String -> Ref -> Ordering -- | returns the splitted format "prefix/suffix" for addressing the loose -- object database toFilePathParts :: Ref -> (String, String) -- | hash a bytestring into a reference hash :: ByteString -> Ref -- | hash a lazy bytestring into a reference hashLBS :: ByteString -> Ref instance GHC.Classes.Eq Data.Git.Ref.RefNotFound instance GHC.Show.Show Data.Git.Ref.RefNotFound instance Data.Data.Data Data.Git.Ref.RefInvalid instance GHC.Classes.Eq Data.Git.Ref.RefInvalid instance GHC.Show.Show Data.Git.Ref.RefInvalid instance GHC.Classes.Ord Data.Git.Ref.Ref instance GHC.Classes.Eq Data.Git.Ref.Ref instance GHC.Show.Show Data.Git.Ref.Ref instance GHC.Exception.Exception Data.Git.Ref.RefInvalid instance GHC.Exception.Exception Data.Git.Ref.RefNotFound -- | Manipulation of named references * reading packed-refs file * reading -- single headstagsremote file module Data.Git.Named -- | Represent a named specifier. data RefSpecTy RefHead :: RefSpecTy RefOrigHead :: RefSpecTy RefFetchHead :: RefSpecTy RefBranch :: RefName -> RefSpecTy RefTag :: RefName -> RefSpecTy RefRemote :: RefName -> RefSpecTy RefPatches :: String -> RefSpecTy RefStash :: RefSpecTy RefOther :: String -> RefSpecTy -- | content of a ref file. data RefContentTy RefDirect :: Ref -> RefContentTy RefLink :: RefSpecTy -> RefContentTy RefContentUnknown :: ByteString -> RefContentTy newtype RefName RefName :: String -> RefName [refNameRaw] :: RefName -> String readPackedRefs :: LocalPath -> ([(RefName, Ref)] -> a) -> IO (PackedRefs a) data PackedRefs a PackedRefs :: a -> a -> a -> PackedRefs a [packedRemotes] :: PackedRefs a -> a [packedBranchs] :: PackedRefs a -> a [packedTags] :: PackedRefs a -> a existsRefFile :: LocalPath -> RefSpecTy -> IO Bool writeRefFile :: LocalPath -> RefSpecTy -> RefContentTy -> IO () readRefFile :: LocalPath -> RefSpecTy -> IO RefContentTy looseHeadsList :: LocalPath -> IO [RefName] looseTagsList :: LocalPath -> IO [RefName] looseRemotesList :: LocalPath -> IO [RefName] instance GHC.Classes.Eq Data.Git.Named.RefContentTy instance GHC.Show.Show Data.Git.Named.RefContentTy instance GHC.Classes.Ord Data.Git.Named.RefSpecTy instance GHC.Classes.Eq Data.Git.Named.RefSpecTy instance GHC.Show.Show Data.Git.Named.RefSpecTy instance GHC.Classes.Ord Data.Git.Named.RefName instance GHC.Classes.Eq Data.Git.Named.RefName instance GHC.Show.Show Data.Git.Named.RefName instance Data.String.IsString Data.Git.Named.RefName module Data.Git.Delta -- | a delta is a source size, a destination size and a list of delta cmd data Delta Delta :: Word64 -> Word64 -> [DeltaCmd] -> Delta -- | possible commands in a delta data DeltaCmd DeltaCopy :: ByteString -> DeltaCmd DeltaSrc :: Word64 -> Word64 -> DeltaCmd -- | parse a delta. format is 2 variable sizes, followed by delta cmds. for -- each cmd: * if first byte MSB is set, we copy from source. * -- otherwise, we copy from delta. * extensions are not handled. deltaParse :: Parser Delta -- | read one delta from a lazy bytestring. deltaRead :: [ByteString] -> Maybe Delta -- | apply a delta on a lazy bytestring, returning a new bytestring. deltaApply :: ByteString -> Delta -> ByteString instance GHC.Classes.Eq Data.Git.Delta.Delta instance GHC.Show.Show Data.Git.Delta.Delta instance GHC.Classes.Eq Data.Git.Delta.DeltaCmd instance GHC.Show.Show Data.Git.Delta.DeltaCmd module Data.Git.Types -- | type of a git object. data ObjectType TypeTree :: ObjectType TypeBlob :: ObjectType TypeCommit :: ObjectType TypeTag :: ObjectType TypeDeltaOff :: ObjectType TypeDeltaRef :: ObjectType -- | Represent a root tree with zero to many tree entries. data Tree Tree :: [TreeEnt] -> Tree [treeGetEnts] :: Tree -> [TreeEnt] -- | Represent a commit object. data Commit Commit :: Ref -> [Ref] -> Person -> Person -> Maybe ByteString -> [CommitExtra] -> ByteString -> Commit [commitTreeish] :: Commit -> Ref [commitParents] :: Commit -> [Ref] [commitAuthor] :: Commit -> Person [commitCommitter] :: Commit -> Person [commitEncoding] :: Commit -> Maybe ByteString [commitExtras] :: Commit -> [CommitExtra] [commitMessage] :: Commit -> ByteString data CommitExtra CommitExtra :: ByteString -> ByteString -> CommitExtra [commitExtraKey] :: CommitExtra -> ByteString [commitExtraValue] :: CommitExtra -> ByteString -- | Represent a binary blob. data Blob Blob :: ByteString -> Blob [blobGetContent] :: Blob -> ByteString -- | Represent a signed tag. data Tag Tag :: Ref -> ObjectType -> ByteString -> Person -> ByteString -> Tag [tagRef] :: Tag -> Ref [tagObjectType] :: Tag -> ObjectType [tagBlob] :: Tag -> ByteString [tagName] :: Tag -> Person [tagS] :: Tag -> ByteString -- | an author or committer line has the format: name email time -- timezone FIXME: should be a string, but I don't know if the data is -- stored consistantly in one encoding (UTF8) data Person Person :: ByteString -> ByteString -> GitTime -> Person [personName] :: Person -> ByteString [personEmail] :: Person -> ByteString [personTime] :: Person -> GitTime -- | Entity name data EntName entName :: ByteString -> EntName type EntPath = [EntName] entPathAppend :: EntPath -> EntName -> EntPath newtype ModePerm ModePerm :: Word32 -> ModePerm -- | traditional unix permission for owner, group and permissions data FilePermissions FilePermissions :: {-# UNPACK #-} !Perm -> {-# UNPACK #-} !Perm -> {-# UNPACK #-} !Perm -> FilePermissions [getOwnerPerm] :: FilePermissions -> {-# UNPACK #-} !Perm [getGroupPerm] :: FilePermissions -> {-# UNPACK #-} !Perm [getOtherPerm] :: FilePermissions -> {-# UNPACK #-} !Perm -- | Git object file type data ObjectFileType FileTypeDirectory :: ObjectFileType FileTypeRegularFile :: ObjectFileType FileTypeSymbolicLink :: ObjectFileType FileTypeGitLink :: ObjectFileType getPermission :: ModePerm -> FilePermissions getFiletype :: ModePerm -> ObjectFileType -- | Git time is number of seconds since unix epoch in the UTC zone with -- the current timezone associated data GitTime GitTime :: Elapsed -> TimezoneOffset -> GitTime [gitTimeUTC] :: GitTime -> Elapsed [gitTimeTimezone] :: GitTime -> TimezoneOffset gitTime :: Integer -> Int -> GitTime gitTimeToLocal :: GitTime -> LocalTime Elapsed -- | Delta pointing to an offset. data DeltaOfs DeltaOfs :: Word64 -> Delta -> DeltaOfs -- | Delta pointing to a ref. data DeltaRef DeltaRef :: Ref -> Delta -> DeltaRef -- | represent one entry in the tree (permission,file or directory -- name,blob or tree ref) name should maybe a filepath, but not sure -- about the encoding. type TreeEnt = (ModePerm, EntName, Ref) instance GHC.Classes.Eq Data.Git.Types.DeltaRef instance GHC.Show.Show Data.Git.Types.DeltaRef instance GHC.Classes.Eq Data.Git.Types.DeltaOfs instance GHC.Show.Show Data.Git.Types.DeltaOfs instance GHC.Classes.Eq Data.Git.Types.Tag instance GHC.Show.Show Data.Git.Types.Tag instance GHC.Classes.Eq Data.Git.Types.Commit instance GHC.Show.Show Data.Git.Types.Commit instance GHC.Classes.Eq Data.Git.Types.CommitExtra instance GHC.Show.Show Data.Git.Types.CommitExtra instance GHC.Classes.Eq Data.Git.Types.Blob instance GHC.Show.Show Data.Git.Types.Blob instance GHC.Classes.Eq Data.Git.Types.Tree instance GHC.Show.Show Data.Git.Types.Tree instance GHC.Classes.Eq Data.Git.Types.Person instance GHC.Show.Show Data.Git.Types.Person instance GHC.Classes.Ord Data.Git.Types.EntName instance GHC.Classes.Eq Data.Git.Types.EntName instance GHC.Classes.Eq Data.Git.Types.FilePermissions instance GHC.Show.Show Data.Git.Types.FilePermissions instance GHC.Classes.Eq Data.Git.Types.ObjectFileType instance GHC.Show.Show Data.Git.Types.ObjectFileType instance GHC.Classes.Eq Data.Git.Types.ModePerm instance GHC.Show.Show Data.Git.Types.ModePerm instance GHC.Classes.Eq Data.Git.Types.GitTime instance Data.Data.Data Data.Git.Types.ObjectType instance GHC.Classes.Eq Data.Git.Types.ObjectType instance GHC.Show.Show Data.Git.Types.ObjectType instance Data.Hourglass.Time.Timeable Data.Git.Types.GitTime instance Data.Hourglass.Time.Time Data.Git.Types.GitTime instance GHC.Show.Show Data.Git.Types.GitTime instance GHC.Enum.Enum Data.Git.Types.ObjectType instance GHC.Show.Show Data.Git.Types.EntName instance Data.String.IsString Data.Git.Types.EntName instance Data.Byteable.Byteable Data.Git.Types.EntName instance GHC.Base.Monoid Data.Git.Types.Tree module Data.Git.Storage.Object -- | location of an object in the database data ObjectLocation NotFound :: ObjectLocation Loose :: Ref -> ObjectLocation Packed :: Ref -> Word64 -> ObjectLocation -- | type of a git object. data ObjectType TypeTree :: ObjectType TypeBlob :: ObjectType TypeCommit :: ObjectType TypeTag :: ObjectType TypeDeltaOff :: ObjectType TypeDeltaRef :: ObjectType type ObjectHeader = (ObjectType, Word64, Maybe ObjectPtr) type ObjectData = ByteString -- | Delta objects points to some others objects in the database either as -- offset in the pack or as a direct reference. data ObjectPtr PtrRef :: Ref -> ObjectPtr PtrOfs :: Word64 -> ObjectPtr -- | describe a git object, that could of 6 differents types: tree, blob, -- commit, tag and deltas (offset or ref). the deltas one are only -- available in packs. data Object ObjCommit :: Commit -> Object ObjTag :: Tag -> Object ObjBlob :: Blob -> Object ObjTree :: Tree -> Object ObjDeltaOfs :: DeltaOfs -> Object ObjDeltaRef :: DeltaRef -> Object -- | Raw objects infos have an header (type, size, ptr), the data and a -- pointers chains to parents for resolved objects. data ObjectInfo ObjectInfo :: ObjectHeader -> ObjectData -> [ObjectPtr] -> ObjectInfo [oiHeader] :: ObjectInfo -> ObjectHeader [oiData] :: ObjectInfo -> ObjectData [oiChains] :: ObjectInfo -> [ObjectPtr] class Objectable a getType :: Objectable a => a -> ObjectType getRaw :: Objectable a => a -> ByteString isDelta :: Objectable a => a -> Bool toObject :: Objectable a => a -> Object objectToType :: Object -> ObjectType objectTypeMarshall :: ObjectType -> String objectTypeUnmarshall :: ByteString -> ObjectType objectTypeIsDelta :: ObjectType -> Bool objectIsDelta :: Object -> Bool objectToTree :: Object -> Maybe Tree objectToCommit :: Object -> Maybe Commit objectToTag :: Object -> Maybe Tag objectToBlob :: Object -> Maybe Blob -- | parse a tree content treeParse :: Parser Tree -- | parse a commit content commitParse :: Parser Commit -- | parse a tag content tagParse :: Parser Tag -- | parse a blob content blobParse :: Parser Blob objectParseTree :: Parser Object objectParseCommit :: Parser Object objectParseTag :: Parser Object objectParseBlob :: Parser Object objectWriteHeader :: ObjectType -> Word64 -> ByteString objectWrite :: Object -> ByteString objectHash :: ObjectType -> Word64 -> ByteString -> Ref instance GHC.Classes.Eq Data.Git.Storage.Object.Object instance GHC.Show.Show Data.Git.Storage.Object.Object instance GHC.Classes.Eq Data.Git.Storage.Object.ObjectInfo instance GHC.Show.Show Data.Git.Storage.Object.ObjectInfo instance GHC.Classes.Eq Data.Git.Storage.Object.ObjectPtr instance GHC.Show.Show Data.Git.Storage.Object.ObjectPtr instance GHC.Classes.Eq Data.Git.Storage.Object.ObjectLocation instance GHC.Show.Show Data.Git.Storage.Object.ObjectLocation instance Data.Git.Storage.Object.Objectable Data.Git.Types.Blob instance Data.Git.Storage.Object.Objectable Data.Git.Types.Commit instance Data.Git.Storage.Object.Objectable Data.Git.Types.Tag instance Data.Git.Storage.Object.Objectable Data.Git.Types.Tree instance Data.Git.Storage.Object.Objectable Data.Git.Types.DeltaOfs instance Data.Git.Storage.Object.Objectable Data.Git.Types.DeltaRef module Data.Git.Storage.PackIndex -- | represent an packIndex header with the version and the fanout table data PackIndexHeader PackIndexHeader :: !Word32 -> !(Vector Word32) -> PackIndexHeader data PackIndex PackIndex :: Vector Ref -> Vector Word32 -> Vector Word32 -> Ref -> Ref -> PackIndex [packIndexSha1s] :: PackIndex -> Vector Ref [packIndexCRCs] :: PackIndex -> Vector Word32 [packIndexPackoffs] :: PackIndex -> Vector Word32 [packIndexPackChecksum] :: PackIndex -> Ref [packIndexChecksum] :: PackIndex -> Ref -- | open an index packIndexOpen :: LocalPath -> Ref -> IO FileReader -- | close an index packIndexClose :: FileReader -> IO () -- | variant of withFile on the index file and with a FileReader withPackIndex :: LocalPath -> Ref -> (FileReader -> IO a) -> IO a -- | enumerate every indexes file in the pack directory packIndexEnumerate :: LocalPath -> IO [Ref] -- | get the number of reference in this index with a specific prefix packIndexHeaderGetNbWithPrefix :: PackIndexHeader -> Int -> Word32 -- | return the reference offset in the packfile if found packIndexGetReferenceLocation :: PackIndexHeader -> FileReader -> Ref -> IO (Maybe Word64) -- | get all references that start by prefix. packIndexGetReferencesWithPrefix :: PackIndexHeader -> FileReader -> String -> IO [Ref] -- | read index header from an index filereader packIndexReadHeader :: FileReader -> IO PackIndexHeader -- | read all index packIndexRead :: LocalPath -> Ref -> IO (PackIndexHeader, (Vector Ref, Vector Word32, Vector Word32, [ByteString], Ref, Ref)) -- | get index header from an index reference packIndexGetHeader :: LocalPath -> Ref -> IO PackIndexHeader instance GHC.Classes.Eq Data.Git.Storage.PackIndex.PackIndexHeader instance GHC.Show.Show Data.Git.Storage.PackIndex.PackIndexHeader module Data.Git.Storage.Pack data PackedObjectInfo PackedObjectInfo :: ObjectType -> Word64 -> Word64 -> Word64 -> Maybe ObjectPtr -> PackedObjectInfo [poiType] :: PackedObjectInfo -> ObjectType [poiOffset] :: PackedObjectInfo -> Word64 [poiSize] :: PackedObjectInfo -> Word64 [poiActualSize] :: PackedObjectInfo -> Word64 [poiExtra] :: PackedObjectInfo -> Maybe ObjectPtr type PackedObjectRaw = (PackedObjectInfo, ByteString) -- | Enumerate the pack refs available in this repository. packEnumerate :: LocalPath -> IO [Ref] -- | open a pack packOpen :: LocalPath -> Ref -> IO FileReader -- | close a pack packClose :: FileReader -> IO () -- | return the number of entries in this pack packReadHeader :: LocalPath -> Ref -> IO Word32 -- | read an object at a specific position using a map function on the -- objectData packReadMapAtOffset :: FileReader -> Word64 -> (ByteString -> ByteString) -> IO (Maybe Object) -- | read an object at a specific position packReadAtOffset :: FileReader -> Word64 -> IO (Maybe Object) -- | read a raw representation at a specific position packReadRawAtOffset :: FileReader -> Word64 -> IO (PackedObjectRaw) -- | enumerate all objects in this pack and callback to f for reach raw -- objects packEnumerateObjects :: LocalPath -> Ref -> Int -> (PackedObjectRaw -> IO a) -> IO () packedObjectToObject :: (PackedObjectInfo, ByteString) -> Maybe Object packObjectFromRaw :: (ObjectType, Maybe ObjectPtr, ByteString) -> Maybe Object instance GHC.Classes.Eq Data.Git.Storage.Pack.PackedObjectInfo instance GHC.Show.Show Data.Git.Storage.Pack.PackedObjectInfo module Data.Git.Storage.Loose newtype Zipped Zipped :: ByteString -> Zipped [getZippedData] :: Zipped -> ByteString -- | unmarshall an object (with header) from a bytestring. looseUnmarshall :: ByteString -> Object -- | unmarshall an object as (header, data) tuple from a bytestring looseUnmarshallRaw :: ByteString -> (ObjectHeader, ObjectData) -- | unmarshall an object (with header) from a zipped stream. looseUnmarshallZipped :: Zipped -> Object -- | unmarshall an object as (header, data) tuple from a zipped stream looseUnmarshallZippedRaw :: Zipped -> (ObjectHeader, ObjectData) -- | marshall as lazy bytestring an object except deltas. looseMarshall :: Object -> ByteString -- | read a specific ref from a loose object and returns an object looseRead :: LocalPath -> Ref -> IO Object -- | read only the header of a loose object. looseReadHeader :: LocalPath -> Ref -> IO ObjectHeader -- | read a specific ref from a loose object and returns an header and -- data. looseReadRaw :: LocalPath -> Ref -> IO (ObjectHeader, ObjectData) -- | check if a specific ref exists as loose object looseExists :: LocalPath -> Ref -> IO Bool -- | create a new blob on a temporary location and on success move it to -- the object store with its digest name. looseWriteBlobFromFile :: LocalPath -> LocalPath -> IO Ref -- | write an object to disk as a loose reference. use -- looseWriteBlobFromFile for efficiently writing blobs when being -- commited from a file. looseWrite :: LocalPath -> Object -> IO Ref -- | enumarate all prefixes available in the object store. looseEnumeratePrefixes :: LocalPath -> IO [[Char]] -- | enumerate all references available with a specific prefix. looseEnumerateWithPrefixFilter :: LocalPath -> String -> (Ref -> Bool) -> IO [Ref] looseEnumerateWithPrefix :: LocalPath -> String -> IO [Ref] instance GHC.Classes.Eq Data.Git.Storage.Loose.Zipped instance GHC.Show.Show Data.Git.Storage.Loose.Zipped module Data.Git.Storage -- | represent a git repo, with possibly already opened filereaders for -- indexes and packs data Git packedNamed :: Git -> CachedPackedRef gitRepoPath :: Git -> LocalPath configs :: Git -> IORef [Config] -- | open a new git repository context openRepo :: LocalPath -> IO Git -- | close a git repository context, closing all remaining fileReaders. closeRepo :: Git -> IO () -- | execute a function f with a git context. withRepo :: LocalPath -> (Git -> IO c) -> IO c -- | execute a function on the current repository. -- -- check findRepo to see how the git repository is found. withCurrentRepo :: (Git -> IO a) -> IO a -- | Find the git repository from the current directory. -- -- If the environment variable GIT_DIR is set then it's used, otherwise -- iterate from current directory, up to 128 parents for a .git directory findRepoMaybe :: IO (Maybe LocalPath) -- | Find the git repository from the current directory. -- -- If the environment variable GIT_DIR is set then it's used, otherwise -- iterate from current directory, up to 128 parents for a .git directory findRepo :: IO LocalPath -- | basic checks to see if a specific path looks like a git repo. isRepo :: LocalPath -> IO Bool -- | initialize a new repository at a specific location. initRepo :: LocalPath -> IO () -- | read the repository's description getDescription :: Git -> IO (Maybe String) -- | set the repository's description setDescription :: Git -> String -> IO () iterateIndexes :: Git -> (b -> (Ref, PackIndexReader) -> IO (b, Bool)) -> b -> IO b -- | Get the object location of a specific reference findReference :: Git -> Ref -> IO ObjectLocation -- | get all the references that start by a specific prefix findReferencesWithPrefix :: Git -> String -> IO [Ref] -- | get an object from repository getObjectRaw :: Git -> Ref -> Bool -> IO (Maybe ObjectInfo) -- | get an object from repository getObjectRawAt :: Git -> ObjectLocation -> Bool -> IO (Maybe ObjectInfo) -- | get an object from repository using a ref. getObject :: Git -> Ref -> Bool -> IO (Maybe Object) -- | Just like getObject but will raise a RefNotFound exception if -- the reference cannot be found. getObject_ :: Git -> Ref -> Bool -> IO Object -- | get an object from repository using a location to reference it. getObjectAt :: Git -> ObjectLocation -> Bool -> IO (Maybe Object) -- | get an object type from repository getObjectType :: Git -> Ref -> IO (Maybe ObjectType) -- | set an object in the store and returns the new ref this is always -- going to create a loose object. setObject :: Git -> Object -> IO Ref module Data.Git.Repository -- | represent a git repo, with possibly already opened filereaders for -- indexes and packs data Git -- | Read the Config configGetAll :: Git -> IO [Config] -- | Get a configuration element from the config file, starting from the -- local repository config file, then the global config file. -- -- for example the equivalent to git config user.name is: -- -- 
--   configGet git "user" "name"
--
configGet :: Git -> String -> String -> IO (Maybe String) newtype Config Config :: [Section] -> Config data Section Section :: String -> [(String, String)] -> Section [sectionName] :: Section -> String [sectionKVs] :: Section -> [(String, String)] type HTree = [(ModePerm, EntName, HTreeEnt)] -- | hierarchy tree, either a reference to a blob (file) or a tree -- (directory). data HTreeEnt TreeDir :: Ref -> HTree -> HTreeEnt TreeFile :: Ref -> HTreeEnt newtype RefName RefName :: String -> RefName [refNameRaw] :: RefName -> String -- | get a specified commit getCommitMaybe :: Git -> Ref -> IO (Maybe Commit) -- | get a specified commit but raises an exception if doesn't exists or -- type is not appropriate getCommit :: Git -> Ref -> IO Commit -- | get a specified tree getTreeMaybe :: Git -> Ref -> IO (Maybe Tree) -- | get a specified tree but raise getTree :: Git -> Ref -> IO Tree -- | Rewrite a set of commits from a revision and returns the new ref. -- -- If during revision traversal (diving) there's a commit with zero or -- multiple parents then the traversal will stop regardless of the amount -- of parent requested. -- -- calling "rewrite f 2 (revisionOf d)" on the following tree: -- -- a <-- b <-- c <-- d -- -- result in the following tree after mapping with f: -- -- a <-- f(b) <-- f(c) <-- f(d) rewrite :: Git -> (Commit -> IO Commit) -> Revision -> Int -> IO Ref -- | build a hierarchy tree from a tree object buildHTree :: Git -> Tree -> IO HTree -- | resolve the ref (tree or blob) related to a path at a specific commit -- ref resolvePath :: Git -> Ref -> EntPath -> IO (Maybe Ref) -- | returns a tree from a ref that might be either a commit, a tree or a -- tag. resolveTreeish :: Git -> Ref -> IO (Maybe Tree) -- | try to resolve a string to a specific commit ref for example: HEAD, -- HEAD^, master~3, shortRef resolveRevision :: Git -> Revision -> IO (Maybe Ref) -- | initialize a new repository at a specific location. initRepo :: LocalPath -> IO () -- | basic checks to see if a specific path looks like a git repo. isRepo :: LocalPath -> IO Bool -- | Write a branch to point to a specific reference branchWrite :: Git -> RefName -> Ref -> IO () -- | Return the list of branches branchList :: Git -> IO (Set RefName) -- | Write a tag to point to a specific reference tagWrite :: Git -> RefName -> Ref -> IO () -- | Return the list of branches tagList :: Git -> IO (Set RefName) -- | Set head to point to either a reference or a branch name. headSet :: Git -> Either Ref RefName -> IO () -- | Get what the head is pointing to, or the reference otherwise headGet :: Git -> IO (Either Ref RefName) instance GHC.Classes.Eq Data.Git.Repository.InvalidType instance GHC.Show.Show Data.Git.Repository.InvalidType instance GHC.Exception.Exception Data.Git.Repository.InvalidType module Data.Git -- | represent a git reference (SHA1) data Ref newtype RefName RefName :: String -> RefName [refNameRaw] :: RefName -> String -- | Represent a commit object. data Commit Commit :: Ref -> [Ref] -> Person -> Person -> Maybe ByteString -> [CommitExtra] -> ByteString -> Commit [commitTreeish] :: Commit -> Ref [commitParents] :: Commit -> [Ref] [commitAuthor] :: Commit -> Person [commitCommitter] :: Commit -> Person [commitEncoding] :: Commit -> Maybe ByteString [commitExtras] :: Commit -> [CommitExtra] [commitMessage] :: Commit -> ByteString -- | an author or committer line has the format: name email time -- timezone FIXME: should be a string, but I don't know if the data is -- stored consistantly in one encoding (UTF8) data Person Person :: ByteString -> ByteString -> GitTime -> Person [personName] :: Person -> ByteString [personEmail] :: Person -> ByteString [personTime] :: Person -> GitTime data CommitExtra CommitExtra :: ByteString -> ByteString -> CommitExtra [commitExtraKey] :: CommitExtra -> ByteString [commitExtraValue] :: CommitExtra -> ByteString -- | Represent a root tree with zero to many tree entries. data Tree Tree :: [TreeEnt] -> Tree [treeGetEnts] :: Tree -> [TreeEnt] -- | Represent a binary blob. data Blob Blob :: ByteString -> Blob [blobGetContent] :: Blob -> ByteString -- | Represent a signed tag. data Tag Tag :: Ref -> ObjectType -> ByteString -> Person -> ByteString -> Tag [tagRef] :: Tag -> Ref [tagObjectType] :: Tag -> ObjectType [tagBlob] :: Tag -> ByteString [tagName] :: Tag -> Person [tagS] :: Tag -> ByteString -- | Git time is number of seconds since unix epoch in the UTC zone with -- the current timezone associated data GitTime newtype ModePerm ModePerm :: Word32 -> ModePerm -- | Entity name data EntName type EntPath = [EntName] entName :: ByteString -> EntName entPathAppend :: EntPath -> EntName -> EntPath -- | Git object file type data ObjectFileType FileTypeDirectory :: ObjectFileType FileTypeRegularFile :: ObjectFileType FileTypeSymbolicLink :: ObjectFileType FileTypeGitLink :: ObjectFileType -- | traditional unix permission for owner, group and permissions data FilePermissions FilePermissions :: {-# UNPACK #-} !Perm -> {-# UNPACK #-} !Perm -> {-# UNPACK #-} !Perm -> FilePermissions [getOwnerPerm] :: FilePermissions -> {-# UNPACK #-} !Perm [getGroupPerm] :: FilePermissions -> {-# UNPACK #-} !Perm [getOtherPerm] :: FilePermissions -> {-# UNPACK #-} !Perm getPermission :: ModePerm -> FilePermissions getFiletype :: ModePerm -> ObjectFileType -- | A git revision. this can be many things: * a shorten ref * a ref * a -- named branch or tag followed by optional modifiers RevModifier -- that can represent: * parenting * type * date data Revision -- | try to resolve a string to a specific commit ref for example: HEAD, -- HEAD^, master~3, shortRef resolveRevision :: Git -> Revision -> IO (Maybe Ref) -- | returns a tree from a ref that might be either a commit, a tree or a -- tag. resolveTreeish :: Git -> Ref -> IO (Maybe Tree) -- | resolve the ref (tree or blob) related to a path at a specific commit -- ref resolvePath :: Git -> Ref -> EntPath -> IO (Maybe Ref) -- | represent a git repo, with possibly already opened filereaders for -- indexes and packs data Git -- | execute a function on the current repository. -- -- check findRepo to see how the git repository is found. withCurrentRepo :: (Git -> IO a) -> IO a -- | execute a function f with a git context. withRepo :: LocalPath -> (Git -> IO c) -> IO c -- | Find the git repository from the current directory. -- -- If the environment variable GIT_DIR is set then it's used, otherwise -- iterate from current directory, up to 128 parents for a .git directory findRepo :: IO LocalPath -- | initialize a new repository at a specific location. initRepo :: LocalPath -> IO () -- | basic checks to see if a specific path looks like a git repo. isRepo :: LocalPath -> IO Bool -- | Rewrite a set of commits from a revision and returns the new ref. -- -- If during revision traversal (diving) there's a commit with zero or -- multiple parents then the traversal will stop regardless of the amount -- of parent requested. -- -- calling "rewrite f 2 (revisionOf d)" on the following tree: -- -- a <-- b <-- c <-- d -- -- result in the following tree after mapping with f: -- -- a <-- f(b) <-- f(c) <-- f(d) rewrite :: Git -> (Commit -> IO Commit) -> Revision -> Int -> IO Ref -- | get an object from repository using a ref. getObject :: Git -> Ref -> Bool -> IO (Maybe Object) -- | get a specified commit but raises an exception if doesn't exists or -- type is not appropriate getCommit :: Git -> Ref -> IO Commit -- | get a specified tree but raise getTree :: Git -> Ref -> IO Tree -- | set an object in the store and returns the new ref this is always -- going to create a loose object. setObject :: Git -> Object -> IO Ref toObject :: Objectable a => a -> Object type WorkTree = MVar TreeSt data EntType EntDirectory :: EntType EntFile :: EntType EntExecutable :: EntType -- | Create a new worktree workTreeNew :: IO WorkTree -- | Create a worktree from a tree reference. workTreeFrom :: Ref -> IO WorkTree -- | delete a path from a working tree -- -- if the path doesn't exist, no error is raised workTreeDelete :: Git -> WorkTree -> EntPath -> IO () -- | Set a file in this working tree to a specific ref. -- -- The ref should point to a valid blob or tree object, and it's safer to -- write the referenced tree or blob object first. workTreeSet :: Git -> WorkTree -> EntPath -> (EntType, Ref) -> IO () -- | Flush the worktree by creating all the necessary trees in the git -- store and return the root ref of the work tree. workTreeFlush :: Git -> WorkTree -> IO Ref -- | Write a branch to point to a specific reference branchWrite :: Git -> RefName -> Ref -> IO () -- | Return the list of branches branchList :: Git -> IO (Set RefName) -- | Write a tag to point to a specific reference tagWrite :: Git -> RefName -> Ref -> IO () -- | Return the list of branches tagList :: Git -> IO (Set RefName) -- | Set head to point to either a reference or a branch name. headSet :: Git -> Either Ref RefName -> IO () -- | Get what the head is pointing to, or the reference otherwise headGet :: Git -> IO (Either Ref RefName) -- | Simplifies the Git operation presents in this package. -- -- You can easily access to the usual Git general informations: -- -- -- -- This module also defines a convenient Monad to access the whole -- information from a Commit: see CommitAccessMonad and -- withCommit. -- -- You can also easily create a new commit: see CommitM and -- withNewCommit module Data.Git.Monad -- | Basic operations common between the different Monads defined in this -- package. class (Functor m, Applicative m, Monad m) => GitMonad m -- | the current Monad must allow access to the current Git getGit :: GitMonad m => m Git liftGit :: GitMonad m => IO a -> m a data GitM a withRepo :: LocalPath -> GitM a -> IO (Either String a) withCurrentRepo :: GitM a -> IO (Either String a) -- | this is a convenient class to allow a common interface for what user -- may need to optain a Ref from a given Resolvable object. -- -- each of this instances is a convenient implementation of what a user -- would have to do in order to resolve a branch, a tag or a String. -- -- 
--   resolve (Ref "2ad98b90...2ca") === Ref "2ad98b90...2ca"
--   resolve "master"
--   resolve "HEAD^^^"
--
class Resolvable rev resolve :: (Resolvable rev, GitMonad m) => rev -> m (Maybe Ref) branchList :: GitMonad git => git (Set RefName) branchWrite :: GitMonad git => RefName -> Ref -> git () tagList :: GitMonad git => git (Set RefName) tagWrite :: GitMonad git => RefName -> Ref -> git () headGet :: GitMonad git => git (Either Ref RefName) headResolv :: GitMonad git => git (Maybe Ref) headSet :: GitMonad git => Either Ref RefName -> git () getCommit :: (GitMonad git, Resolvable ref) => ref -> git (Maybe Commit) -- | ReadOnly operations on a given commit data CommitAccessM a -- | open a commit in the current GitMonad -- -- Read commit's info (Author, Committer, message...) or Commit's Tree. -- -- 
--   withCurrentRepo $
--      withCommit "master" $ do
--          -- print the commit's author information
--          author <- getAuthor
--          liftGit $ print author
--   
--          -- print the list of files|dirs in the root directory
--          l <- getDir []
--          liftGit $ print l
--
withCommit :: (Resolvable ref, GitMonad git) => ref -> CommitAccessM a -> git a getAuthor :: CommitAccessM Person getCommitter :: CommitAccessM Person getParents :: CommitAccessM [Ref] getExtras :: CommitAccessM [CommitExtra] getEncoding :: CommitAccessM (Maybe ByteString) getMessage :: CommitAccessM ByteString -- | get the content of the file at the given Path -- -- if the given Path is not a file or does not exist, the function -- returns Nothing. getFile :: EntPath -> CommitAccessM (Maybe ByteString) -- | list the element present in the Given Directory Path -- -- if the given Path is not a directory or does not exist, the function -- returns Nothing. getDir :: EntPath -> CommitAccessM (Maybe [EntName]) data CommitM a -- | create a new commit in the current GitMonad -- -- The commit is pre-filled with the following default values: -- -- -- -- You can update these values with the commit setters (setFile, -- setAuthor...) -- -- Example: -- -- 
--   withCurrentRepo $
--      (r, ()) <- withNewCommit person Nothing $ do
--          setMessage "inital commit"
--          setFile ["README.md"] "# My awesome project\n\nthis is a new project\n"
--      branchWrite "master" r
--
-- -- you can also continue the work on a same branch. In this case the -- commit's parent is already set to the Reference associated to the -- revision. You can, change the parents if you wish to erase, or -- replace, this value. -- -- 
--   withCurrentRepo $
--      readmeContent <- withCommit (Just "master") $ getFile ["README.md"]
--      (r, ()) <- withNewCommit person (Just "master") $ do
--          setMessage "update the README"
--          setFile ["README.md"] $ readmeContent <> "just add some more description\n"
--      branchWrite "master" r
--
withNewCommit :: (GitMonad git, Resolvable rev) => Person -> Maybe rev -> CommitM a -> git (Ref, a) -- | create or continue to work on a branch -- -- This is a convenient function to create or to linearily work on a -- branch. This function applies a first Collect of information on the -- parent commit (the actual branch's commit). Then it creates a new -- commit and update the branch to point to this commit. -- -- for example: -- -- 
--   withCurrentRepo $
--       withBranch person "master" True
--           (getAuthor)
--           (maybe (setMessage "initial commit on this branch")
--                  (author -> setMessage $ "continue the great work of " ++ show (personName author))
--           )
--
withBranch :: GitMonad git => Person -> RefName -> Bool -> (CommitAccessM a) -> (Maybe a -> CommitM b) -> git (Ref, b) -- | replace the Commit's Author setAuthor :: Person -> CommitM () -- | replace the Commit's Committer setCommitter :: Person -> CommitM () -- | replace the Commit's Parents setParents :: [Ref] -> CommitM () -- | replace the Commit's Extras setExtras :: [CommitExtra] -> CommitM () -- | replace the Commit's encoding setEncoding :: Maybe ByteString -> CommitM () -- | replace the Commit's message with the new given message. setMessage :: ByteString -> CommitM () -- | add a new file in in the Commit's Working Tree setFile :: EntPath -> ByteString -> CommitM () -- | delete a file from the Commit's Working Tree. deleteFile :: EntPath -> CommitM () -- | represent a git repo, with possibly already opened filereaders for -- indexes and packs data Git -- | represent a git reference (SHA1) data Ref newtype RefName RefName :: String -> RefName [refNameRaw] :: RefName -> String -- | Represent a commit object. data Commit Commit :: Ref -> [Ref] -> Person -> Person -> Maybe ByteString -> [CommitExtra] -> ByteString -> Commit [commitTreeish] :: Commit -> Ref [commitParents] :: Commit -> [Ref] [commitAuthor] :: Commit -> Person [commitCommitter] :: Commit -> Person [commitEncoding] :: Commit -> Maybe ByteString [commitExtras] :: Commit -> [CommitExtra] [commitMessage] :: Commit -> ByteString -- | an author or committer line has the format: name email time -- timezone FIXME: should be a string, but I don't know if the data is -- stored consistantly in one encoding (UTF8) data Person Person :: ByteString -> ByteString -> GitTime -> Person [personName] :: Person -> ByteString [personEmail] :: Person -> ByteString [personTime] :: Person -> GitTime instance Data.Git.Monad.Resolvable Data.Git.Ref.Ref instance Data.Git.Monad.Resolvable Data.Git.Revision.Revision instance Data.Git.Monad.Resolvable GHC.Base.String instance Data.Git.Monad.Resolvable Data.Git.Named.RefName instance GHC.Base.Functor Data.Git.Monad.GitM instance GHC.Base.Applicative Data.Git.Monad.GitM instance GHC.Base.Monad Data.Git.Monad.GitM instance Data.Git.Monad.GitMonad Data.Git.Monad.GitM instance GHC.Base.Functor Data.Git.Monad.CommitAccessM instance GHC.Base.Applicative Data.Git.Monad.CommitAccessM instance GHC.Base.Monad Data.Git.Monad.CommitAccessM instance Data.Git.Monad.GitMonad Data.Git.Monad.CommitAccessM instance GHC.Base.Functor Data.Git.Monad.CommitM instance GHC.Base.Applicative Data.Git.Monad.CommitM instance GHC.Base.Monad Data.Git.Monad.CommitM instance Data.Git.Monad.GitMonad Data.Git.Monad.CommitM -- | Basic Git diff methods. module Data.Git.Diff -- | represents a blob's content (i.e., the content of a file at a given -- reference). data BlobContent -- | Text file's lines FileContent :: [ByteString] -> BlobContent -- | Binary content BinaryContent :: ByteString -> BlobContent -- | This is a blob description at a given state (revision) data BlobState BlobState :: EntPath -> ModePerm -> Ref -> BlobContent -> BlobState [bsFilename] :: BlobState -> EntPath [bsMode] :: BlobState -> ModePerm [bsRef] :: BlobState -> Ref [bsContent] :: BlobState -> BlobContent -- | Represents a file state between two revisions A file (a blob) can be -- present in the first Tree's revision but not in the second one, then -- it has been deleted. If only in the second Tree's revision, then it -- has been created. If it is in the both, maybe it has been changed. data BlobStateDiff OnlyOld :: BlobState -> BlobStateDiff OnlyNew :: BlobState -> BlobStateDiff OldAndNew :: BlobState -> BlobState -> BlobStateDiff -- | generate a diff list between two revisions with a given diff helper. -- -- Useful to extract any kind of information from two different -- revisions. For example you can get the number of deleted files: -- -- 
--   getdiffwith f 0 head^ head git
--       where f (OnlyOld _) acc = acc+1
--             f _           acc = acc
--
-- -- Or save the list of new files: -- -- 
--   getdiffwith f [] head^ head git
--       where f (OnlyNew bs) acc = (bsFilename bs):acc
--             f _            acc = acc
--
getDiffWith :: (BlobStateDiff -> a -> a) -> a -> Ref -> Ref -> Git -> IO a -- | This is a proposed diff records for a given file. It contains useful -- information: * the filename (with its path in the root project) * a -- file diff (with the Data.Algorithm.Patience method) * the file's mode -- (i.e. the file priviledge) * the file's ref data GitDiff GitDiff :: EntPath -> GitFileContent -> GitFileMode -> GitFileRef -> GitDiff [hFileName] :: GitDiff -> EntPath [hFileContent] :: GitDiff -> GitFileContent [hFileMode] :: GitDiff -> GitFileMode [hFileRef] :: GitDiff -> GitFileRef data GitFileContent NewBinaryFile :: GitFileContent OldBinaryFile :: GitFileContent NewTextFile :: [TextLine] -> GitFileContent OldTextFile :: [TextLine] -> GitFileContent ModifiedBinaryFile :: GitFileContent ModifiedFile :: [FilteredDiff] -> GitFileContent UnModifiedFile :: GitFileContent data FilteredDiff NormalLine :: (Item TextLine) -> FilteredDiff Separator :: FilteredDiff data GitFileRef NewRef :: Ref -> GitFileRef OldRef :: Ref -> GitFileRef ModifiedRef :: Ref -> Ref -> GitFileRef UnModifiedRef :: Ref -> GitFileRef data GitFileMode NewMode :: ModePerm -> GitFileMode OldMode :: ModePerm -> GitFileMode ModifiedMode :: ModePerm -> ModePerm -> GitFileMode UnModifiedMode :: ModePerm -> GitFileMode data TextLine TextLine :: Integer -> ByteString -> TextLine [lineNumber] :: TextLine -> Integer [lineContent] :: TextLine -> ByteString -- | A default diff helper. It is an example about how you can write your -- own diff helper or you can use it if you want to get all of -- differences. defaultDiff :: Int -> BlobStateDiff -> [GitDiff] -> [GitDiff] -- | A default Diff getter which returns all diff information (Mode, -- Content and Binary) with a context of 5 lines. -- -- 
--   getDiff = getDiffWith (defaultDiff 5) []
--
getDiff :: Ref -> Ref -> Git -> IO [GitDiff] instance GHC.Show.Show Data.Git.Diff.BlobState instance GHC.Show.Show Data.Git.Diff.BlobContent instance GHC.Classes.Eq Data.Git.Diff.BlobState instance GHC.Classes.Eq Data.Git.Diff.TextLine instance GHC.Classes.Ord Data.Git.Diff.TextLine