Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
Represents blame options.
Synopsis
- newtype BlameOptions = BlameOptions (ManagedPtr BlameOptions)
- noBlameOptions :: Maybe BlameOptions
- blameOptionsCopy :: (HasCallStack, MonadIO m) => BlameOptions -> m (Maybe BlameOptions)
- blameOptionsFree :: (HasCallStack, MonadIO m) => BlameOptions -> m ()
- blameOptionsGetMaximumLine :: (HasCallStack, MonadIO m) => BlameOptions -> m Word32
- blameOptionsGetMinimumLine :: (HasCallStack, MonadIO m) => BlameOptions -> m Word32
- blameOptionsGetMinimumMatchCharacters :: (HasCallStack, MonadIO m) => BlameOptions -> m Word16
- blameOptionsGetNewestCommit :: (HasCallStack, MonadIO m) => BlameOptions -> m (Maybe OId)
- blameOptionsGetOldestCommit :: (HasCallStack, MonadIO m) => BlameOptions -> m (Maybe OId)
- blameOptionsNew :: (HasCallStack, MonadIO m) => m BlameOptions
- blameOptionsSetMaximumLine :: (HasCallStack, MonadIO m) => BlameOptions -> Word32 -> m ()
- blameOptionsSetMinimumLine :: (HasCallStack, MonadIO m) => BlameOptions -> Word32 -> m ()
- blameOptionsSetMinimumMatchCharacters :: (HasCallStack, MonadIO m) => BlameOptions -> Word16 -> m ()
- blameOptionsSetNewestCommit :: (HasCallStack, MonadIO m) => BlameOptions -> Maybe OId -> m ()
- blameOptionsSetOldestCommit :: (HasCallStack, MonadIO m) => BlameOptions -> Maybe OId -> m ()
Exported types
newtype BlameOptions Source #
Memory-managed wrapper type.
Instances
BoxedObject BlameOptions Source # | |
Defined in GI.Ggit.Structs.BlameOptions boxedType :: BlameOptions -> IO GType # |
noBlameOptions :: Maybe BlameOptions Source #
A convenience alias for Nothing
:: Maybe
BlameOptions
.
Methods
copy
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m (Maybe BlameOptions) | Returns: a newly allocated |
Copies blameOptions
into a newly allocated BlameOptions
.
free
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m () |
Frees blameOptions
.
getMaximumLine
blameOptionsGetMaximumLine Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m Word32 | Returns: the last line to consider. |
Get the last line in the file to consider. The default is 1.
getMinimumLine
blameOptionsGetMinimumLine Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m Word32 | Returns: the first line to consider. |
Get the first line in the file to consider. The default is 1.
getMinimumMatchCharacters
blameOptionsGetMinimumMatchCharacters Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m Word16 | Returns: the minimum number of characters. |
Get the minimum number of characters that must be detected as moving/copying
within a file for it to associate those lines with a parent commit. This is
only used when any of the GGIT_BLAME_TRACK_COPIES_SAME_FILE
flag is
specified. The default value is 20.
getNewestCommit
blameOptionsGetNewestCommit Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m (Maybe OId) |
Get the id of the newest commit to consider in the blame. The default
value of Nothing
indicates to use HEAD.
getOldestCommit
blameOptionsGetOldestCommit Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> m (Maybe OId) |
Get the id of the oldest commit to consider in the blame. Teh default value
of Nothing
indicates to used HEAD.
new
:: (HasCallStack, MonadIO m) | |
=> m BlameOptions | Returns: a newly allocated |
Create a new, empty BlameOptions
.
setMaximumLine
blameOptionsSetMaximumLine Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> Word32 |
|
-> m () |
Set the last line in the file to consider. Lines start at 1.
setMinimumLine
blameOptionsSetMinimumLine Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> Word32 |
|
-> m () |
Set the first line in the file to consider. Lines start at 1.
setMinimumMatchCharacters
blameOptionsSetMinimumMatchCharacters Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> Word16 |
|
-> m () |
Set the minimum number of characters that must be detected as moving/copying
within a file for it to associate those lines with a parent commit. This is
only used when any of the GGIT_BLAME_TRACK_COPIES_
flags are specified. The
default value is 20.
setNewestCommit
blameOptionsSetNewestCommit Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> Maybe OId | |
-> m () |
Set the id of the newest commit to consider in the blame. Specify Nothing
to
set the default value which indicates to use HEAD.
setOldestCommit
blameOptionsSetOldestCommit Source #
:: (HasCallStack, MonadIO m) | |
=> BlameOptions |
|
-> Maybe OId |
|
-> m () |
Set the id of the oldest commit to consider in the blame. Specify Nothing
to
set the default value which indicates to consider the first commit without
a parent.