Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Ggit.Structs.BlameHunk

Contents

Exported types
Methods

Description

Represents a blame hunk.

Synopsis

newtype BlameHunk = BlameHunk (ManagedPtr BlameHunk)
blameHunkGetFinalCommitId :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe OId)
blameHunkGetFinalSignature :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe Signature)
blameHunkGetFinalStartLineNumber :: (HasCallStack, MonadIO m) => BlameHunk -> m Word16
blameHunkGetLinesInHunk :: (HasCallStack, MonadIO m) => BlameHunk -> m Word16
blameHunkGetOrigCommitId :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe OId)
blameHunkGetOrigPath :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe Text)
blameHunkGetOrigSignature :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe Signature)
blameHunkGetOrigStartLineNumber :: (HasCallStack, MonadIO m) => BlameHunk -> m Word16
blameHunkIsBoundary :: (HasCallStack, MonadIO m) => BlameHunk -> m Bool
blameHunkRef :: (HasCallStack, MonadIO m) => BlameHunk -> m (Maybe BlameHunk)
blameHunkUnref :: (HasCallStack, MonadIO m) => BlameHunk -> m ()

Exported types

newtype BlameHunk Source #

Memory-managed wrapper type.

Constructors

BlameHunk (ManagedPtr BlameHunk)

Instances

Instances details

Eq BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk Methods (==) :: BlameHunk -> BlameHunk -> Bool # (/=) :: BlameHunk -> BlameHunk -> Bool #
GBoxed BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk
ManagedPtrNewtype BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk Methods toManagedPtr :: BlameHunk -> ManagedPtr BlameHunk #
TypedObject BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk Methods glibType :: IO GType #
HasParentTypes BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk
IsGValue (Maybe BlameHunk) Source #	Convert `BlameHunk` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Ggit.Structs.BlameHunk Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe BlameHunk -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe BlameHunk) #
type ParentTypes BlameHunk Source #
Instance details Defined in GI.Ggit.Structs.BlameHunk type ParentTypes BlameHunk = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

isBoundary, ref, unref.

Getters

getFinalCommitId, getFinalSignature, getFinalStartLineNumber, getLinesInHunk, getOrigCommitId, getOrigPath, getOrigSignature, getOrigStartLineNumber.

Setters

None.

getFinalCommitId

blameHunkGetFinalCommitId Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe OId)	Returns: a `OId` or `Nothing`.

Get the id of the commit where this hunk was last changed.

getFinalSignature

blameHunkGetFinalSignature Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe Signature)	Returns: a `Signature` or `Nothing`.

Get the signature of the final version of the hunk.

getFinalStartLineNumber

blameHunkGetFinalStartLineNumber Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m Word16	Returns: the final hunk line number.

Get the line number where the hunk begins in the final version of the file. Line numbers start at 1.

getLinesInHunk

blameHunkGetLinesInHunk Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m Word16	Returns: the number of lines in the hunk.

Get the number of lines in the hunk.

getOrigCommitId

blameHunkGetOrigCommitId Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe OId)	Returns: a `OId` or `Nothing`.

Get the id of the commit where the hunk was found. This is usually the same the final commit id, except when GGIT_BLAME_TRACK_COPIES_ANY_COMMIT was used.

getOrigPath

blameHunkGetOrigPath Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe Text)	Returns: the path or `Nothing`.

Get the path of the file where this hunk originated, as of the commit specified by ggit_blame_hunk_get_orig_commit_id.

getOrigSignature

blameHunkGetOrigSignature Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe Signature)	Returns: a `Signature` or `Nothing`.

Get the signature of the commit specified by ggit_blame_hunk_get_orig_commit_id.

getOrigStartLineNumber

blameHunkGetOrigStartLineNumber Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m Word16	Returns: the orig hunk line number.

Get the line number where the hunk begins in the file specified by ggit_blame_hunk_get_orig_path at the commit specified by ggit_blame_hunk_get_orig_commit_id. Line numbers start at 1.

isBoundary

blameHunkIsBoundary Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m Bool	Returns: whether the hunk is at a boundary commit.

Get whether the hunk has been tracked to a boundary commit (the root, or the commit specified in ggit_blame_options_set_oldest_commit).

ref

blameHunkRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m (Maybe BlameHunk)	Returns: a `BlameHunk` or `Nothing`.

Atomically increments the reference count of blameHunk by one. This function is MT-safe and may be called from any thread.

unref

blameHunkUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BlameHunk	`blameHunk`: a `BlameHunk`.
-> m ()

Atomically decrements the reference count of blameHunk by one. If the reference count drops to 0, blameHunk is freed.