Darcs.UI.Commands

Documentation

data CommandControl

Constructors

CommandData DarcsCommand

HiddenCommand DarcsCommand

GroupName String

data DarcsCommand

A DarcsCommand represents a command like add, record etc.

Constructors

DarcsCommand

Fields

• commandProgramName, commandName :: String
• commandHelp :: Doc
• commandDescription :: String
• commandExtraArgs :: Int
• commandExtraArgHelp :: [String]
• commandCommand :: (AbsolutePath, AbsolutePath) -> [DarcsFlag] -> [String] -> IO ()
• commandPrereq :: [DarcsFlag] -> IO (Either String ())
• commandCompleteArgs :: (AbsolutePath, AbsolutePath) -> [DarcsFlag] -> [String] -> IO [String]
• commandArgdefaults :: [DarcsFlag] -> AbsolutePath -> [String] -> IO [String]
• commandBasicOptions :: [DarcsOptDescr DarcsFlag]
• commandAdvancedOptions :: [DarcsOptDescr DarcsFlag]
• commandDefaults :: [DarcsFlag]
• commandCheckOptions :: [DarcsFlag] -> [String]

SuperCommand

Fields

• commandProgramName, commandName :: String
• commandHelp :: Doc
• commandDescription :: String
• commandPrereq :: [DarcsFlag] -> IO (Either String ())
• commandSubCommands :: [CommandControl]

commandAlias :: String -> Maybe DarcsCommand -> DarcsCommand -> DarcsCommand

commandStub :: String -> Doc -> String -> DarcsCommand -> DarcsCommand

commandOptions :: AbsolutePath -> DarcsCommand -> [OptDescr DarcsFlag]

commandAlloptions :: DarcsCommand -> ([DarcsOptDescr DarcsFlag], [DarcsOptDescr DarcsFlag])

withStdOpts :: DarcsOption (Maybe StdCmdAction -> Verbosity -> b) c -> DarcsOption (UseCache -> HooksConfig -> Bool -> Bool -> Bool -> a) b -> DarcsOption a c

disambiguateCommands :: [CommandControl] -> String -> [String] -> Either String (CommandArgs, [String])

data CommandArgs

Constructors

CommandOnly DarcsCommand

SuperCommandOnly DarcsCommand

SuperCommandSub DarcsCommand DarcsCommand

getSubcommands :: DarcsCommand -> [CommandControl]

extractCommands :: [CommandControl] -> [DarcsCommand]

extractAllCommands :: [CommandControl] -> [DarcsCommand]

normalCommand :: DarcsCommand -> CommandControl

hiddenCommand :: DarcsCommand -> CommandControl

commandGroup :: String -> CommandControl

superName :: Maybe DarcsCommand -> String

nodefaults :: [DarcsFlag] -> AbsolutePath -> [String] -> IO [String]

putInfo :: [DarcsFlag] -> Doc -> IO ()

putVerbose :: [DarcsFlag] -> Doc -> IO ()

putWarning :: [DarcsFlag] -> Doc -> IO ()

putVerboseWarning :: [DarcsFlag] -> Doc -> IO ()

putFinished :: [DarcsFlag] -> String -> IO ()

abortRun :: [DarcsFlag] -> Doc -> IO ()

setEnvDarcsPatches :: RepoPatch p => FL (PatchInfoAnd rt p) wX wY -> IO ()

Set the DARCS_PATCHES and DARCS_PATCHES_XML environment variables with info about the given patches, for use in post-hooks.

setEnvDarcsFiles :: PatchInspect p => p wX wY -> IO ()

Set the DARCS_FILES environment variable to the files touched by the given patch, one per line, for use in post-hooks.

defaultRepo :: [DarcsFlag] -> AbsolutePath -> [String] -> IO [String]

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

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

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

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