darcs-2.5.2: a distributed, interactive, smart revision control system

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 (IdentifyRepo p)
- identifyDarcsRepository :: forall p. [DarcsFlag] -> String -> IO (Repository p)
- identifyRepositoryFor :: forall p. RepoPatch p => Repository p -> String -> IO (Repository p)
- data IdentifyRepo p
  - = BadRepository String
  - | NonRepository String
  - | GoodRepository (Repository p)
- findRepository :: [DarcsFlag] -> IO (Either String ())
- amInRepository :: [DarcsFlag] -> IO (Either String ())
- amNotInRepository :: [DarcsFlag] -> IO (Either String ())
- revertRepositoryChanges :: RepoPatch p => Repository p -> IO ()
- announceMergeConflicts :: String -> [DarcsFlag] -> FL Prim -> IO Bool
- setTentativePending :: forall p. RepoPatch p => Repository p -> FL Prim -> IO ()
- checkUnrecordedConflicts :: forall p. RepoPatch p => [DarcsFlag] -> FL (Named p) -> IO Bool
- withRecorded :: RepoPatch p => Repository p -> ((AbsolutePath -> IO a) -> IO a) -> (AbsolutePath -> IO a) -> IO a
- readRepo :: RepoPatch p => Repository p -> IO (PatchSet p)
- readTentativeRepo :: RepoPatch p => Repository p -> IO (PatchSet p)
- prefsUrl :: Repository p -> String
- makePatchLazy :: RepoPatch p => Repository p -> PatchInfoAnd p -> IO (PatchInfoAnd p)
- 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 (Repository p)
- tentativelyRemovePatches :: RepoPatch p => Repository p -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO (Repository p)
- tentativelyAddToPending :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL Prim -> IO ()
- tentativelyAddPatch_ :: RepoPatch p => UpdatePristine -> Repository p -> [DarcsFlag] -> PatchInfoAnd p -> IO (Repository p)
- tentativelyReplacePatches :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO (Repository p)
- finalizeRepositoryChanges :: RepoPatch p => Repository p -> IO ()
- unrevertUrl :: Repository p -> String
- applyToWorking :: Patchy p => Repository p1 -> [DarcsFlag] -> p -> IO (Repository p1)
- patchSetToPatches :: RepoPatch p => PatchSet p -> FL (Named p)
- createPristineDirectoryTree :: RepoPatch p => Repository p -> FilePath -> IO ()
- createPartialsPristineDirectoryTree :: (FilePathLike fp, RepoPatch p) => Repository p -> [fp] -> FilePath -> IO ()
- optimizeInventory :: RepoPatch p => Repository p -> IO ()
- cleanRepository :: RepoPatch p => Repository p -> IO ()
- getMarkedupFile :: RepoPatch p => Repository p -> PatchInfo -> FilePath -> IO MarkedUpFile
- data PatchSet p
- type SealedPatchSet p = Sealed (PatchSet 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 ()
- data UpdatePristine
  - = UpdatePristine
  - | DontUpdatePristine
- data MakeChanges
  - = MakeChanges
  - | DontMakeChanges
- applyToTentativePristine :: (Effect q, Patchy q) => Repository p -> q -> IO ()
- makeNewPending :: forall p. RepoPatch p => Repository p -> FL Prim -> IO ()

# Documentation

data Repository p

Constructors

Repo !String ![DarcsFlag] !RepoFormat !(RepoType p) |

Instances

Show (Repository p) |

data RepoType p

Constructors

DarcsRepository !Pristine Cache |

Instances

Show (RepoType p) |

data RIO p a

Repository IO monad. This monad-like datatype is responsible for sequencing IO actions that modify the tentative recorded state of the repository.

Instances

Monad (RIO p) | We have an instance of Monad so that IO actions that do not change the tentative recorded state are convenient in the IO monad.
Functor (RIO p) |

($-) :: ((forall p. RepoPatch p => Repository p -> IO a) -> IO a) -> (forall p. RepoPatch p => Repository p -> IO a) -> IO a

maybeIdentifyRepository :: [DarcsFlag] -> String -> IO (IdentifyRepo p)

Tries to identify the repository in a given directory

identifyDarcsRepository :: forall p. [DarcsFlag] -> String -> IO (Repository p)

identifyDarcsRepository identifies the repo at `url`. Warning: you have to know what kind of patches are found in that repo.

identifyRepositoryFor :: forall p. RepoPatch p => Repository p -> String -> IO (Repository p)

`identifyRepositoryFor repo url` identifies (and returns) the repo at `url`, but fails if it is not compatible for reading from and writing to.

data IdentifyRepo p

The status of a given directory: is it a darcs repository?

Constructors

BadRepository String | looks like a repository with some error
NonRepository String | safest guess
GoodRepository (Repository p) |

findRepository :: [DarcsFlag] -> IO (Either String ())

amInRepository :: [DarcsFlag] -> IO (Either String ())

amNotInRepository :: [DarcsFlag] -> IO (Either String ())

revertRepositoryChanges :: RepoPatch p => Repository p -> IO ()

announceMergeConflicts :: String -> [DarcsFlag] -> FL Prim -> IO Bool

setTentativePending :: forall p. RepoPatch p => Repository p -> FL Prim -> IO ()

setTentativePending is basically unsafe. It overwrites the pending state with a new one, not related to the repository state.

checkUnrecordedConflicts :: forall p. RepoPatch p => [DarcsFlag] -> FL (Named p) -> IO Bool

withRecorded :: RepoPatch p => Repository p -> ((AbsolutePath -> IO a) -> IO a) -> (AbsolutePath -> IO a) -> IO a

readRepo :: RepoPatch p => Repository p -> IO (PatchSet p)

readTentativeRepo :: RepoPatch p => Repository p -> IO (PatchSet p)

prefsUrl :: Repository p -> String

makePatchLazy :: RepoPatch p => Repository p -> PatchInfoAnd p -> IO (PatchInfoAnd p)

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 (Repository p)

tentativelyRemovePatches :: RepoPatch p => Repository p -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO (Repository p)

tentativelyAddToPending :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL Prim -> IO ()

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.

tentativelyAddPatch_ :: RepoPatch p => UpdatePristine -> Repository p -> [DarcsFlag] -> PatchInfoAnd p -> IO (Repository p)

tentativelyReplacePatches :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO (Repository p)

finalizeRepositoryChanges :: RepoPatch p => Repository p -> IO ()

unrevertUrl :: Repository p -> String

applyToWorking :: Patchy p => Repository p1 -> [DarcsFlag] -> p -> IO (Repository p1)

patchSetToPatches :: RepoPatch p => PatchSet p -> FL (Named p)

createPristineDirectoryTree :: RepoPatch p => Repository p -> FilePath -> IO ()

createPartialsPristineDirectoryTree :: (FilePathLike fp, RepoPatch p) => Repository p -> [fp] -> FilePath -> IO ()

optimizeInventory :: RepoPatch p => Repository p -> IO ()

Writes out a fresh copy of the inventory that minimizes the amount of inventory that need be downloaded when people pull from the repository.

Specifically, it breaks up the inventory on the most recent tag. This speeds up most commands when run remotely, both because a smaller file needs to be transfered (only the most recent inventory). It also gives a guarantee that all the patches prior to a given tag are included in that tag, so less commutation and history traversal is needed. This latter issue can become very important in large repositories.

cleanRepository :: RepoPatch p => Repository p -> IO ()

getMarkedupFile :: RepoPatch p => Repository p -> PatchInfo -> FilePath -> IO MarkedUpFile

data PatchSet p

type SealedPatchSet p = Sealed (PatchSet p)

setScriptsExecutable :: IO ()

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)

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 a

This the `RIO` equivalent of `liftIO`.

testTentative :: RepoPatch p => Repository p -> IO ()

testRecorded :: RepoPatch p => Repository p -> IO ()

data UpdatePristine

Constructors

UpdatePristine |
DontUpdatePristine |

Instances

Eq UpdatePristine |

data MakeChanges

Constructors

MakeChanges |
DontMakeChanges |

Instances

Eq MakeChanges |

applyToTentativePristine :: (Effect q, Patchy q) => Repository p -> q -> IO ()

makeNewPending :: forall p. RepoPatch p => Repository p -> FL Prim -> IO ()