darcs-2.1.99.0: a distributed, interactive, smart revision control systemSource codeContentsIndex
Darcs.Repository.Internal
Synopsis
data Repository p = Repo !String ![DarcsFlag] !RepoFormat !(RepoType p)
data RepoType p = DarcsRepository !Pristine Cache
data RIO p a
($-) :: ((forall p. RepoPatch p => Repository p -> IO a) -> IO a) -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a
maybeIdentifyRepository :: [DarcsFlag] -> String -> IO (Either String (Repository p))
identifyDarcs1Repository :: [DarcsFlag] -> String -> IO (Repository Patch)
identifyRepositoryFor :: forall p. RepoPatch p => Repository p -> String -> IO (Repository p)
findRepository :: [DarcsFlag] -> IO (Either String ())
amInRepository :: [DarcsFlag] -> IO (Either String ())
amNotInRepository :: [DarcsFlag] -> IO (Either String ())
slurp_pending :: RepoPatch p => Repository p -> IO Slurpy
pristineFromWorking :: RepoPatch p => Repository p -> IO ()
revertRepositoryChanges :: RepoPatch p => Repository p -> IO ()
slurp_recorded :: RepoPatch p => Repository p -> IO Slurpy
slurp_recorded_and_unrecorded :: RepoPatch p => Repository p -> IO (Slurpy, Slurpy)
withRecorded :: RepoPatch p => Repository p -> ((AbsolutePath -> IO a) -> IO a) -> (AbsolutePath -> IO a) -> IO a
checkPristineAgainstSlurpy :: RepoPatch p => Repository p -> Slurpy -> IO Bool
get_unrecorded :: RepoPatch p => Repository p -> IO (FL Prim)
get_unrecorded_unsorted :: RepoPatch p => Repository p -> IO (FL Prim)
get_unrecorded_no_look_for_adds :: RepoPatch p => Repository p -> [FileName] -> IO (FL Prim)
get_unrecorded_in_files :: RepoPatch p => Repository p -> [FileName] -> IO (FL Prim)
read_repo :: RepoPatch p => Repository p -> IO (PatchSet p)
sync_repo :: Repository p -> IO ()
prefsUrl :: Repository p -> String
makePatchLazy :: RepoPatch p => Repository p -> PatchInfoAnd p -> IO (PatchInfoAnd p)
add_to_pending :: RepoPatch p => Repository p -> FL Prim -> IO ()
withRepoLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a
withRepoReadLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a
withRepository :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a
withRepositoryDirectory :: forall a. [DarcsFlag] -> String -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a
withGutsOf :: Repository p -> IO () -> IO ()
tentativelyAddPatch :: RepoPatch p => Repository p -> [DarcsFlag] -> PatchInfoAnd p -> IO ()
tentativelyRemovePatches :: RepoPatch p => Repository p -> [DarcsFlag] -> FL (Named p) -> IO ()
tentativelyAddToPending :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL Prim -> IO ()
tentativelyReplacePatches :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL (Named p) -> IO ()
tentativelyMergePatches :: RepoPatch p => Repository p -> String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> FL (PatchInfoAnd p) -> IO (Sealed (FL Prim))
considerMergeToWorking :: RepoPatch p => Repository p -> String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> FL (PatchInfoAnd p) -> IO (Sealed (FL Prim))
finalizeRepositoryChanges :: RepoPatch p => Repository p -> IO ()
unrevertUrl :: Repository p -> String
applyToWorking :: Patchy p => Repository p1 -> [DarcsFlag] -> p -> IO ()
patchSetToPatches :: RepoPatch p => RL (RL (PatchInfoAnd p)) -> FL (Named p)
createPristineDirectoryTree :: RepoPatch p => Repository p -> FilePath -> IO ()
createPartialsPristineDirectoryTree :: (FilePathLike fp, RepoPatch p) => Repository p -> [fp] -> FilePath -> IO ()
replacePristine :: Repository p -> FilePath -> IO ()
replacePristineFromSlurpy :: Repository p -> Slurpy -> IO ()
optimizeInventory :: RepoPatch p => Repository p -> IO ()
cleanRepository :: RepoPatch p => Repository p -> IO ()
getMarkedupFile :: RepoPatch p => Repository p -> PatchInfo -> FilePath -> IO MarkedUpFile
type PatchSet p = RL (RL (PatchInfoAnd p))
type SealedPatchSet p = Sealed (RL (RL (PatchInfoAnd p)))
setScriptsExecutable :: IO ()
getRepository :: RIO p (Repository p)
rIO :: IO a -> RIO p a
testTentative :: RepoPatch p => Repository p -> IO ()
testRecorded :: RepoPatch p => Repository p -> IO ()
Documentation
data Repository p Source
Constructors
Repo !String ![DarcsFlag] !RepoFormat !(RepoType p)
show/hide Instances
data RepoType p Source
Constructors
DarcsRepository !Pristine Cache
show/hide Instances
data RIO p a Source
Repository IO monad. This monad-like datatype is responsible for sequencing IO actions that modify the tentative recorded state of the repository.
show/hide Instances
($-) :: ((forall p. RepoPatch p => Repository p -> IO a) -> IO a) -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource
maybeIdentifyRepository :: [DarcsFlag] -> String -> IO (Either String (Repository p))Source
identifyDarcs1Repository :: [DarcsFlag] -> String -> IO (Repository Patch)Source
identifyRepositoryFor :: forall p. RepoPatch p => Repository p -> String -> IO (Repository p)Source
findRepository :: [DarcsFlag] -> IO (Either String ())Source
amInRepository :: [DarcsFlag] -> IO (Either String ())Source
amNotInRepository :: [DarcsFlag] -> IO (Either String ())Source
slurp_pending :: RepoPatch p => Repository p -> IO SlurpySource
pristineFromWorking :: RepoPatch p => Repository p -> IO ()Source
revertRepositoryChanges :: RepoPatch p => Repository p -> IO ()Source
slurp_recorded :: RepoPatch p => Repository p -> IO SlurpySource
slurp_recorded_and_unrecorded :: RepoPatch p => Repository p -> IO (Slurpy, Slurpy)Source
withRecorded :: RepoPatch p => Repository p -> ((AbsolutePath -> IO a) -> IO a) -> (AbsolutePath -> IO a) -> IO aSource
checkPristineAgainstSlurpy :: RepoPatch p => Repository p -> Slurpy -> IO BoolSource
get_unrecorded :: RepoPatch p => Repository p -> IO (FL Prim)Source
get_unrecorded_unsorted :: RepoPatch p => Repository p -> IO (FL Prim)Source
get_unrecorded_no_look_for_adds :: RepoPatch p => Repository p -> [FileName] -> IO (FL Prim)Source
get_unrecorded_in_files :: RepoPatch p => Repository p -> [FileName] -> IO (FL Prim)Source
Gets the unrecorded changes in the given paths in the current repository.
read_repo :: RepoPatch p => Repository p -> IO (PatchSet p)Source
sync_repo :: Repository p -> IO ()Source
prefsUrl :: Repository p -> StringSource
makePatchLazy :: RepoPatch p => Repository p -> PatchInfoAnd p -> IO (PatchInfoAnd p)Source
add_to_pending :: RepoPatch p => Repository p -> FL Prim -> IO ()Source
withRepoLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource
withRepoReadLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource
withRepository :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource
withRepositoryDirectory :: forall a. [DarcsFlag] -> String -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource
withGutsOf :: Repository p -> IO () -> IO ()Source
tentativelyAddPatch :: RepoPatch p => Repository p -> [DarcsFlag] -> PatchInfoAnd p -> IO ()Source
tentativelyRemovePatches :: RepoPatch p => Repository p -> [DarcsFlag] -> FL (Named p) -> IO ()Source
tentativelyAddToPending :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL Prim -> IO ()Source
This fuction is unsafe because it accepts a patch that works on the tentative pending and we don't currently track the state of the tentative pending.
tentativelyReplacePatches :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL (Named p) -> IO ()Source
tentativelyMergePatches :: RepoPatch p => Repository p -> String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> FL (PatchInfoAnd p) -> IO (Sealed (FL Prim))Source
considerMergeToWorking :: RepoPatch p => Repository p -> String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> FL (PatchInfoAnd p) -> IO (Sealed (FL Prim))Source
finalizeRepositoryChanges :: RepoPatch p => Repository p -> IO ()Source
unrevertUrl :: Repository p -> StringSource
applyToWorking :: Patchy p => Repository p1 -> [DarcsFlag] -> p -> IO ()Source
patchSetToPatches :: RepoPatch p => RL (RL (PatchInfoAnd p)) -> FL (Named p)Source
createPristineDirectoryTree :: RepoPatch p => Repository p -> FilePath -> IO ()Source
createPartialsPristineDirectoryTree :: (FilePathLike fp, RepoPatch p) => Repository p -> [fp] -> FilePath -> IO ()Source
replacePristine :: Repository p -> FilePath -> IO ()Source
replacePristineFromSlurpy :: Repository p -> Slurpy -> IO ()Source
optimizeInventory :: RepoPatch p => Repository p -> IO ()Source
cleanRepository :: RepoPatch p => Repository p -> IO ()Source
getMarkedupFile :: RepoPatch p => Repository p -> PatchInfo -> FilePath -> IO MarkedUpFileSource
type PatchSet p = RL (RL (PatchInfoAnd p))Source

A PatchSet is in reverse order, plus has information about which tags are clean, meaning all patches applied prior to them are in the tag itself, so we can stop reading at that point. Just to clarify, the first patch in a PatchSet is the one most recently applied to the repo.

PatchSets have the property that if (info $ last $ head a) == (info $ last $ head b) then (tail a) and (tail b) are identical repositories

Questions:

Does this mean that in a patch set such as [[a b t1 c d e t2][f g t3] [h i]], t1, t2 and t3 are tags, and t2 and t3 are clean?

Can we have PatchSet with length at least 3? Florent

type SealedPatchSet p = Sealed (RL (RL (PatchInfoAnd p)))Source
setScriptsExecutable :: IO ()Source
Sets scripts in or below the current directory executable. A script is any file that starts with the bytes '#!'. This is used sometimes for --set-scripts-executable, but at other times --set-scripts-executable is handled by the hunk patch case of applyFL.
getRepository :: RIO p (Repository p)Source
Similar to the ask function of the MonadReader class. This allows actions in the RIO monad to get the current repository. FIXME: Don't export this. If we don't export this it makes it harder for arbitrary IO actions to access the repository and hence our code is easier to audit.
rIO :: IO a -> RIO p aSource
This the RIO equivalent of liftIO.
testTentative :: RepoPatch p => Repository p -> IO ()Source
testRecorded :: RepoPatch p => Repository p -> IO ()Source
Produced by Haddock version 2.4.2