| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Darcs.Patch.Info
- data PatchInfo = PatchInfo {
- _piDate :: !ByteString
- _piName :: !ByteString
- _piAuthor :: !ByteString
- _piLog :: ![ByteString]
- isInverted :: !Bool
- patchinfo :: String -> String -> String -> [String] -> IO PatchInfo
- invertName :: PatchInfo -> PatchInfo
- rawPatchInfo :: String -> String -> String -> [String] -> Bool -> PatchInfo
- addJunk :: PatchInfo -> IO PatchInfo
- makePatchname :: PatchInfo -> SHA1
- makeFilename :: PatchInfo -> String
- readPatchInfo :: ParserM m => m PatchInfo
- justName :: PatchInfo -> String
- justAuthor :: PatchInfo -> String
- justLog :: PatchInfo -> String
- showPatchInfoUI :: PatchInfo -> Doc
- toXml :: PatchInfo -> Doc
- piDate :: PatchInfo -> CalendarTime
- setPiDate :: String -> PatchInfo -> PatchInfo
- piDateString :: PatchInfo -> String
- piDateBytestring :: PatchInfo -> ByteString
- piName :: PatchInfo -> String
- piRename :: PatchInfo -> String -> PatchInfo
- piAuthor :: PatchInfo -> String
- piTag :: PatchInfo -> Maybe String
- piLog :: PatchInfo -> [String]
- showPatchInfo :: PatchInfo -> Doc
- isTag :: PatchInfo -> Bool
- readPatchInfos :: ByteString -> [PatchInfo]
- escapeXML :: String -> Doc
Documentation
A PatchInfo value contains the metadata of a patch. The date, name, author and log fields are UTF-8 encoded text in darcs 2.4 and later, and just sequences of bytes (decoded with whatever is the locale when displayed) in earlier darcs.
The members with names that start with '_' are not supposed to be used directly in code that does not care how the patch info is stored.
Constructors
| PatchInfo | |
Fields
| |
patchinfo :: String -> String -> String -> [String] -> IO PatchInfo Source #
patchinfo date name author log constructs a new PatchInfo value
with the given details, automatically assigning an Ignore-this header
to guarantee the patch is unique. The function does not verify
the date string's sanity.
invertName :: PatchInfo -> PatchInfo Source #
addJunk :: PatchInfo -> IO PatchInfo Source #
addJunk adds a line that contains a random number to make the patch unique.
makePatchname :: PatchInfo -> SHA1 Source #
Hash on patch metadata (patch name, author, date, log, and "inverted" flag. Robust against context changes but does not garantee patch contents. Usually used as matcher or patch identifier (see Darcs.Patch.Match).
makeFilename :: PatchInfo -> String Source #
This makes darcs-1 (non-hashed repos) filenames, and is also generally used in both in hashed and non-hashed repo code for making patch "hashes".
The name consists of three segments:
- timestamp (ISO8601-compatible yyyymmmddHHMMSS, UTC)
- SHA1 hash of the author
- SHA1 hash of the patch name, author, date, log, and "inverted" flag.
readPatchInfo :: ParserM m => m PatchInfo Source #
Parser for PatchInfo as stored in patch bundles and inventory files,
for example:
[Document the foo interface John Doe <john.doe@example.com>**20110615084241 Ignore-this: 85b94f67d377c4ab671101266ef9c229 Nobody knows what a 'foo' is, so describe it. ]
See showPatchInfo for the inverse operation.
justName :: PatchInfo -> String Source #
Get the name, including an "UNDO: " prefix if the patch is inverted.
justAuthor :: PatchInfo -> String Source #
Returns the author of a patch.
showPatchInfoUI :: PatchInfo -> Doc Source #
piDate :: PatchInfo -> CalendarTime Source #
piDateString :: PatchInfo -> String Source #
piName :: PatchInfo -> String Source #
Returns the name of the patch. Unlike justName, it does not preprend
"UNDO: " to the name if the patch is inverted.
showPatchInfo :: PatchInfo -> Doc Source #
Patch is stored between square brackets.
[ <patch name> <patch author>*<patch date> <patch log (may be empty)> (indented one) <can have multiple lines in patch log,> <as long as they're preceded by a space> <and don't end with a square bracket.> ]
note that below I assume the name has no newline in it.
See readPatchInfo for the inverse operation.
readPatchInfos :: ByteString -> [PatchInfo] Source #