Data.Git.Diff

Basic Git diff methods.

Basic features

data BlobContent

represents a blob's content (i.e., the content of a file at a given reference).

Constructors

FileContent [ByteString]

Text file's lines

BinaryContent ByteString

Binary content

Instances

Show BlobContent

Methods

showsPrec :: Int -> BlobContent -> ShowS

show :: BlobContent -> String

showList :: [BlobContent] -> ShowS

data BlobState hash

This is a blob description at a given state (revision)

Constructors

BlobState

Fields

• bsFilename :: EntPath
• bsMode :: ModePerm
• bsRef :: Ref hash
• bsContent :: BlobContent

Instances

Eq (BlobState hash)

Two BlobState are equal if they have the same filename, i.e.,

((BlobState x _ _ _) == (BlobState y _ _ _)) = (x == y)

Methods

(==) :: BlobState hash -> BlobState hash -> Bool

(/=) :: BlobState hash -> BlobState hash -> Bool

Show (BlobState hash)

Methods

showsPrec :: Int -> BlobState hash -> ShowS

show :: BlobState hash -> String

showList :: [BlobState hash] -> ShowS

data BlobStateDiff hash

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.

Constructors

OnlyOld (BlobState hash)

OnlyNew (BlobState hash)

OldAndNew (BlobState hash) (BlobState hash)

getDiffWith

Arguments

:: (Typeable hash, HashAlgorithm hash)

=> (BlobStateDiff hash -> a -> a)

diff helper (State -> accumulator -> accumulator)

-> a

accumulator

-> Ref hash

commit reference (the original state)

-> Ref hash

commit reference (the new state)

-> Git hash

repository

-> IO a

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

Default helpers

data GitDiff hash

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

Constructors

GitDiff

Fields

• hFileName :: EntPath
• hFileContent :: GitFileContent
• hFileMode :: GitFileMode
• hFileRef :: GitFileRef hash

data GitFileContent

Constructors

NewBinaryFile

OldBinaryFile

NewTextFile [TextLine]

OldTextFile [TextLine]

ModifiedBinaryFile

ModifiedFile [FilteredDiff]

UnModifiedFile

data FilteredDiff

Constructors

NormalLine (Item TextLine)

Separator

data GitFileRef hash

Constructors

NewRef (Ref hash)

OldRef (Ref hash)

ModifiedRef (Ref hash) (Ref hash)

UnModifiedRef (Ref hash)

data GitFileMode

Constructors

NewMode ModePerm

OldMode ModePerm

ModifiedMode ModePerm ModePerm

UnModifiedMode ModePerm

data TextLine

Constructors

TextLine

Fields

• lineNumber :: Integer
• lineContent :: ByteString

Instances

Eq TextLine

Methods

(==) :: TextLine -> TextLine -> Bool

(/=) :: TextLine -> TextLine -> Bool

Ord TextLine

Methods

compare :: TextLine -> TextLine -> Ordering

(<) :: TextLine -> TextLine -> Bool

(<=) :: TextLine -> TextLine -> Bool

(>) :: TextLine -> TextLine -> Bool

(>=) :: TextLine -> TextLine -> Bool

max :: TextLine -> TextLine -> TextLine

min :: TextLine -> TextLine -> TextLine

defaultDiff

Arguments

:: Int

Number of line for context

-> BlobStateDiff hash

-> [GitDiff hash]

Accumulator

-> [GitDiff hash]

Accumulator with a new content

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.

getDiff :: (Typeable hash, HashAlgorithm hash) => Ref hash -> Ref hash -> Git hash -> IO [GitDiff hash]

A default Diff getter which returns all diff information (Mode, Content and Binary) with a context of 5 lines.

getDiff = getDiffWith (defaultDiff 5) []