Safe Haskell	Safe-Inferred

Util.Git

Contents

OID
repo
blob
tree
commit
diff
refs
- symbolic refs
- HEAD ref
revwalk
dir
misc
errors

Description

Higher level wrapper around the hlibgit2 binding to libgit2.

Synopsis

initialize :: IO a -> IO a
data Blob
data Tree
type Repo = FilePath
type FileName = FilePath
type Ref = FilePath
init :: Repo -> IO Bool
write_blob :: Repo -> ByteString.ByteString -> IO Blob
read_blob :: Repo -> Blob -> IO ByteString.ByteString
data Modification
- = Remove FilePath
- | Add FilePath ByteString.ByteString
type ModifyDir = [(FileName, ModifyFile)]
data ModifyFile
- = ModifyFile (Maybe ByteString.ByteString)
- | ModifyDir ModifyDir
modifications_to_dir :: [Modification] -> ModifyDir
write_tree :: Repo -> Maybe Tree -> [(FileName, Maybe (Either Blob Tree))] -> IO Tree
modify_tree :: Repo -> Tree -> [Modification] -> IO Tree
read_tree :: Repo -> Tree -> IO [(FileName, Either Blob Tree)]
data CommitData = CommitData {
- commit_tree :: !Tree
- commit_parents :: ![Commit]
- commit_author :: !String
- commit_text :: !String
}
parse_commit :: String -> Maybe Commit
write_commit :: Repo -> Text -> Text -> [Commit] -> Tree -> String -> IO Commit
read_commit :: Repo -> Commit -> IO CommitData
diff_commits :: Repo -> Commit -> Commit -> IO [Modification]
diff_trees :: Repo -> Tree -> Tree -> IO [Modification]
write_ref :: Repo -> Commit -> Ref -> IO ()
read_ref :: Repo -> Ref -> IO (Maybe Commit)
read_refs :: RepoP -> IO [Ref]
read_ref_map :: Repo -> IO (Map Ref Commit)
write_symbolic_ref :: Repo -> Ref -> Ref -> IO ()
read_symbolic_ref :: Repo -> Ref -> IO (Maybe Ref)
update_head :: Repo -> Commit -> IO ()
read_head_commit :: Repo -> IO (Maybe Commit)
write_head :: Repo -> Ref -> IO ()
read_head :: Repo -> IO Ref
read_log :: Repo -> Ref -> IO [Commit]
read_log_from :: Repo -> Commit -> IO [Commit]
read_log_head :: Repo -> IO [Commit]
type Dir = Map FileName File
data File
- = File ByteString.ByteString
- | Dir Dir
make_dir :: [(FilePath, ByteString.ByteString)] -> Either String Dir
flatten_dir :: Dir -> [(FilePath, ByteString.ByteString)]
write_dir :: Repo -> Dir -> IO Tree
read_dir :: Repo -> Tree -> IO Dir
gc :: Repo -> IO ()
throw :: String -> IO a
newtype GitException = GitException String

Documentation

initialize :: IO a -> IO a Source #

The library has to be initialized before you call any functions.

OID

data Blob Source #

Instances

Instances details

Show Blob Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> Blob -> ShowS # show :: Blob -> String # showList :: [Blob] -> ShowS #
Eq Blob Source #
Instance details Defined in Util.Git Methods (==) :: Blob -> Blob -> Bool # (/=) :: Blob -> Blob -> Bool #
Ord Blob Source #
Instance details Defined in Util.Git Methods compare :: Blob -> Blob -> Ordering # (<) :: Blob -> Blob -> Bool # (<=) :: Blob -> Blob -> Bool # (>) :: Blob -> Blob -> Bool # (>=) :: Blob -> Blob -> Bool # max :: Blob -> Blob -> Blob # min :: Blob -> Blob -> Blob #
Pretty Blob Source #
Instance details Defined in Util.Git Methods pretty :: Blob -> Text Source # format :: Blob -> Doc Source # formatList :: [Blob] -> Doc Source #

data Tree Source #

Instances

Instances details

Show Tree Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> Tree -> ShowS # show :: Tree -> String # showList :: [Tree] -> ShowS #
Eq Tree Source #
Instance details Defined in Util.Git Methods (==) :: Tree -> Tree -> Bool # (/=) :: Tree -> Tree -> Bool #
Ord Tree Source #
Instance details Defined in Util.Git Methods compare :: Tree -> Tree -> Ordering # (<) :: Tree -> Tree -> Bool # (<=) :: Tree -> Tree -> Bool # (>) :: Tree -> Tree -> Bool # (>=) :: Tree -> Tree -> Bool # max :: Tree -> Tree -> Tree # min :: Tree -> Tree -> Tree #
Pretty Tree Source #
Instance details Defined in Util.Git Methods pretty :: Tree -> Text Source # format :: Tree -> Doc Source # formatList :: [Tree] -> Doc Source #

type Repo = FilePath Source #

type FileName = FilePath Source #

Repo-internal path.

type Ref = FilePath Source #

This has the initial refs/ stripped off.

repo

init :: Repo -> IO Bool Source #

True if it already existed.

blob

write_blob :: Repo -> ByteString.ByteString -> IO Blob Source #

read_blob :: Repo -> Blob -> IO ByteString.ByteString Source #

tree

data Modification Source #

Add fname Nothing means add a directory.

Constructors

Remove FilePath
Add FilePath ByteString.ByteString

Instances

Instances details

Show Modification Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> Modification -> ShowS # show :: Modification -> String # showList :: [Modification] -> ShowS #
Eq Modification Source #
Instance details Defined in Util.Git Methods (==) :: Modification -> Modification -> Bool # (/=) :: Modification -> Modification -> Bool #
Pretty Modification Source #
Instance details Defined in Util.Git Methods pretty :: Modification -> Text Source # format :: Modification -> Doc Source # formatList :: [Modification] -> Doc Source #

type ModifyDir = [(FileName, ModifyFile)] Source #

data ModifyFile Source #

Constructors

ModifyFile (Maybe ByteString.ByteString)
ModifyDir ModifyDir

Instances

Instances details

Show ModifyFile Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> ModifyFile -> ShowS # show :: ModifyFile -> String # showList :: [ModifyFile] -> ShowS #
Eq ModifyFile Source #
Instance details Defined in Util.Git Methods (==) :: ModifyFile -> ModifyFile -> Bool # (/=) :: ModifyFile -> ModifyFile -> Bool #

modifications_to_dir :: [Modification] -> ModifyDir Source #

write_tree :: Repo -> Maybe Tree -> [(FileName, Maybe (Either Blob Tree))] -> IO Tree Source #

modify_tree :: Repo -> Tree -> [Modification] -> IO Tree Source #

Apply a list of modifications to an existing tree.

read_tree :: Repo -> Tree -> IO [(FileName, Either Blob Tree)] Source #

commit

data CommitData Source #

Constructors

CommitData
Fields commit_tree :: !Tree commit_parents :: ![Commit] commit_author :: !String commit_text :: !String

Instances

Instances details

Show CommitData Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> CommitData -> ShowS # show :: CommitData -> String # showList :: [CommitData] -> ShowS #
Eq CommitData Source #
Instance details Defined in Util.Git Methods (==) :: CommitData -> CommitData -> Bool # (/=) :: CommitData -> CommitData -> Bool #

parse_commit :: String -> Maybe Commit Source #

write_commit :: Repo -> Text -> Text -> [Commit] -> Tree -> String -> IO Commit Source #

read_commit :: Repo -> Commit -> IO CommitData Source #

diff

diff_commits :: Repo -> Commit -> Commit -> IO [Modification] Source #

diff_trees :: Repo -> Tree -> Tree -> IO [Modification] Source #

Recursively diff two trees.

refs

write_ref :: Repo -> Commit -> Ref -> IO () Source #

read_ref :: Repo -> Ref -> IO (Maybe Commit) Source #

symbolic refs

read_refs :: RepoP -> IO [Ref] Source #

Read all the refs in the repo.

read_ref_map :: Repo -> IO (Map Ref Commit) Source #

Read all refs along with their commits.

write_symbolic_ref :: Repo -> Ref -> Ref -> IO () Source #

read_symbolic_ref :: Repo -> Ref -> IO (Maybe Ref) Source #

HEAD ref

update_head :: Repo -> Commit -> IO () Source #

Point HEAD to a commit.

read_head_commit :: Repo -> IO (Maybe Commit) Source #

write_head :: Repo -> Ref -> IO () Source #

read_head :: Repo -> IO Ref Source #

revwalk

read_log :: Repo -> Ref -> IO [Commit] Source #

Get commits in reverse chronological order from the given ref.

read_log_from :: Repo -> Commit -> IO [Commit] Source #

Read commits starting from the given commit.

read_log_head :: Repo -> IO [Commit] Source #

Get commits in reverse chronological order from the HEAD.

dir

type Dir = Map FileName File Source #

data File Source #

Constructors

File ByteString.ByteString
Dir Dir

Instances

Instances details

Show File Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> File -> ShowS # show :: File -> String # showList :: [File] -> ShowS #
Eq File Source #
Instance details Defined in Util.Git Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #

make_dir :: [(FilePath, ByteString.ByteString)] -> Either String Dir Source #

flatten_dir :: Dir -> [(FilePath, ByteString.ByteString)] Source #

write_dir :: Repo -> Dir -> IO Tree Source #

read_dir :: Repo -> Tree -> IO Dir Source #

misc

gc :: Repo -> IO () Source #

GC the repo. As far as I know, there's no way to do this with libgit2, so it invokes the standalone git command.

errors

throw :: String -> IO a Source #

newtype GitException Source #

Constructors

GitException String

Instances

Instances details

Exception.Exception GitException Source #
Instance details Defined in Util.Git Methods toException :: GitException -> Exception.SomeException # fromException :: Exception.SomeException -> Maybe GitException # displayException :: GitException -> String #
Show GitException Source #
Instance details Defined in Util.Git Methods showsPrec :: Int -> GitException -> ShowS # show :: GitException -> String # showList :: [GitException] -> ShowS #