Darcs.UI.SelectChanges

Working with changes

selectChanges :: forall p wX wY. (Patchy p, PatchInspect p, ShowPatch p, ApplyState p ~ Tree) => FL p wX wY -> PatchSelection p wX wY

Select patches from a FL.

data WhichChanges

When asking about patches, we either ask about them in oldest-first or newest first (with respect to the current ordering of the repository), and we either want an initial segment or a final segment of the poset of patches.

First: ask for an initial segment, first patches first (default for all pull-like commands)

FirstReversed: ask for an initial segment, last patches first (used to ask about dependencies in record, and for pull-like commands with the --reverse flag).

LastReversed: ask for a final segment, last patches first. (default for unpull-like commands, except for selecting *primitive* patches in rollback)

Last: ask for a final segment, first patches first. (used for selecting primitive patches in rollback, and for unpull-like commands with the --reverse flag

Constructors

Last

LastReversed

First

FirstReversed

Instances

Eq WhichChanges

Show WhichChanges

viewChanges :: (Patchy p, ShowPatch p, ApplyState p ~ Tree) => PatchSelectionOptions -> [Sealed2 p] -> IO ()

The equivalent of selectChanges for the darcs changes command

withSelectedPatchFromRepo :: forall p wR wU wT. (RepoPatch p, ApplyState p ~ Tree) => String -> Repository p wR wU wT -> PatchSelectionOptions -> (forall wA. (FL (PatchInfoAnd p) :> PatchInfoAnd p) wA wR -> IO ()) -> IO ()

The function for selecting a patch to amend record. Read at your own risks.

runSelection :: Patchy p => PatchSelection p wX wY -> PatchSelectionContext p -> IO ((FL p :> FL p) wX wY)

runs a PatchSelection action in the given PatchSelectionContext.

selectionContextPrim :: PrimPatch prim => WhichChanges -> String -> PatchSelectionOptions -> Maybe (Splitter prim) -> Maybe [FilePath] -> Maybe (Tree IO) -> PatchSelectionContext prim

A PatchSelectionContext for selecting Prim patches.

selectionContextGeneric :: (RepoPatch p, Invert q) => (forall wX wY. q wX wY -> Sealed2 (PatchInfoAnd p)) -> WhichChanges -> String -> PatchSelectionOptions -> Maybe [FilePath] -> PatchSelectionContext q

A generic PatchSelectionContext.

selectionContext :: RepoPatch p => WhichChanges -> String -> PatchSelectionOptions -> Maybe (Splitter (PatchInfoAnd p)) -> Maybe [FilePath] -> PatchSelectionContext (PatchInfoAnd p)

A PatchSelectionContext for selecting full patches (PatchInfoAnd patches)

data PatchSelectionContext p

A PatchSelectionContext contains all the static settings for selecting patches. See PatchSelectionM

printSummary :: forall p wX wY. ShowPatch p => p wX wY -> IO ()

Interactive selection utils

data PatchSelectionOptions

Constructors

PatchSelectionOptions

Fields

verbosity :: Verbosity

matchFlags :: [MatchFlag]

diffAlgorithm :: DiffAlgorithm

interactive :: Bool

selectDeps :: SelectDeps

summary :: Summary

withContext :: WithContext

type InteractiveSelectionM p wX wY a = StateT (InteractiveSelectionContext p wX wY) (PatchSelectionM p IO) a

data InteractiveSelectionContext p wX wY

The dynamic parameters for interactive selection of patches.

Constructors

ISC

Fields

total :: Int

total number of patches

current :: Int

number of already-seen patches

lps :: FZipper (LabelledPatch p) wX wY

the patches we offer

choices :: PatchChoices p wX wY

the user's choices

Navigating the patchset

currentPatch :: forall p wX wY. Patchy p => InteractiveSelectionM p wX wY (Maybe (Sealed2 (LabelledPatch p)))

Returns a Sealed2 version of the patch we are asking the user about.

skipMundane :: (Patchy p, ShowPatch p) => InteractiveSelectionM p wX wY ()

Skips patches we should not ask the user about

skipOne :: forall p wX wY. Patchy p => InteractiveSelectionM p wX wY ()

Focus the next patch.

backOne :: forall p wX wY. Patchy p => InteractiveSelectionM p wX wY ()

Focus the previous patch.

backAll :: forall p wX wY. Patchy p => InteractiveSelectionM p wX wY ()

showCur :: forall p wX wY. (Patchy p, ShowPatch p, ApplyState p ~ Tree) => InteractiveSelectionM p wX wY ()

Shows the current patch as it should be seen by the user.

Decisions

decide :: forall p wX wY wT wU. Patchy p => Bool -> LabelledPatch p wT wU -> InteractiveSelectionM p wX wY ()

decide True selects the current patch, and decide False deselects it.

decideWholeFile :: forall p wX wY. (Patchy p, PatchInspect p) => FilePath -> Bool -> InteractiveSelectionM p wX wY ()

like decide, but for all patches touching file

Prompts and queries

isSingleFile :: PatchInspect p => p wX wY -> Bool

currentFile :: forall p wX wY. (Patchy p, PatchInspect p) => InteractiveSelectionM p wX wY (Maybe FilePath)

returns Just f if the currentPatch only modifies f, Nothing otherwise.

promptUser :: forall p wX wY. (Patchy p, ShowPatch p) => Bool -> Char -> InteractiveSelectionM p wX wY Char

Asks the user about one patch, returns their answer.

prompt :: (Patchy p, ShowPatch p) => InteractiveSelectionM p wX wY String

The question to ask about one patch.

data KeyPress

The type of the answers to a "shall I [wiggle] that [foo]?" question They are found in a [[KeyPress]] bunch, each list representing a set of answers which belong together

Constructors

KeyPress

Fields

kp :: Char

kpHelp :: String

keysFor :: [[KeyPress]] -> [Char]

The keys used by a list of keyPress groups.

helpFor :: String -> [[KeyPress]] -> [[KeyPress]] -> String

Generates the help for a set of basic and advanced KeyPress groups.

askAboutDepends :: forall p wR wU wT wY. (RepoPatch p, ApplyState p ~ Tree) => Repository p wR wU wT -> FL (PrimOf p) wT wY -> PatchSelectionOptions -> [PatchInfo] -> IO [PatchInfo]