Module CPM.Main

Installs the application (i.e., binary) provided by a package. This is done by checking out the package into CPM's application packages cache (default: $HOME/.cpm/apppackages, see APPPACKAGE_PATH in .cpmrc configuration file) and then install this package.

Internal note: the installed package should not be cleaned or removed after the installation since its execution might refer (via the config module) to some data stored in the package.

checkCompiler :: Config -> Package -> IO ()

Checks the compiler compatibility.

installExecutable :: Config -> Package -> IO ([LogEntry],Either LogEntry ())

Installs the executable specified in the package in the bin directory of CPM (compare .cpmrc).

uninstall :: UninstallOptions -> Config -> IO ([LogEntry],Either LogEntry ())

uninstallPackageExecutable :: Config -> Package -> IO ([LogEntry],Either LogEntry ())

tryFindVersion :: String -> (Int,Int,Int,Maybe String) -> Repository -> IO ([LogEntry],Either LogEntry Package)

listCmd :: ListOptions -> Config -> IO ([LogEntry],Either LogEntry ())

Lists all (compiler-compatible if lall is false) packages in the given repository.

filterCompatPkgs :: Config -> [Package] -> Package

Returns the first package of a list of packages compatible to the current compiler (according to the given configuration). If there is no compatible package, returns the first one.

packageVersionAsTable :: Config -> [Package] -> ([Int],[[String]])

showVersionIfCompatible :: Config -> Package -> String

Shows the version of a package if it is compatible with the current compiler, otherwise shows the version in brackets.

cpmInfo :: String

Further infos:

solution complete, i.e., able to compute all solutions

searchCmd :: SearchOptions -> Config -> IO ([LogEntry],Either LogEntry ())

Search in all (compiler-compatible) packages in the given repository.

upgradeCmd :: UpgradeOptions -> Config -> IO ([LogEntry],Either LogEntry ())

upgrade command.

linkCmd :: LinkOptions -> Config -> IO ([LogEntry],Either LogEntry ())

link command.

addCmd :: AddOptions -> Config -> IO ([LogEntry],Either LogEntry ())

add command: Option --package: copy the given package to the repository index and package installation directory so that it is available as any other package. Option --dependency: add the package name as a dependency to the current package

useForce :: String

Further infos:

solution complete, i.e., able to compute all solutions

addDependencyCmd :: String -> Bool -> Config -> IO ([LogEntry],Either LogEntry ())

add --dependency command: add the given package as a new dependency to the current package.

docCmd :: DocOptions -> Config -> IO ([LogEntry],Either LogEntry ())

doc command: run curry doc on the modules provided as an argument or, if they are not given, on exported modules (if specified in the package), on the main executable (if specified in the package), or on all source modules of the package.

genPackageManual :: DocOptions -> Config -> Package -> String -> IO ([LogEntry],Either LogEntry ())

Generate manual according to documentation specification of package.

replaceSubString :: String -> String -> String -> String

Replace every occurrence of the first argument by the second argument in a string (third argument).

genDocForPrograms :: DocOptions -> Config -> String -> String -> Package -> IO ([LogEntry],Either LogEntry ())

Generate program documentation: run curry doc on the modules provided as an argument or, if they are not given, on exported modules (if specified in the package), on the main executable (if specified in the package), or on all source modules of the package.

testCmd :: TestOptions -> Config -> IO ([LogEntry],Either LogEntry ())

test command: run curry check on the modules provided as an argument or, if they are not provided, on the exported (if specified) or all source modules of the package.

curryModulesInDir :: String -> IO [String]

Get the names of all Curry modules contained in a directory. Modules in subdirectories are returned as hierarchical modules.

diffCmd :: DiffOptions -> Config -> IO ([LogEntry],Either LogEntry ())

compiler :: ExecOptions -> Config -> IO ([LogEntry],Either LogEntry ())

execCmd :: ExecOptions -> Config -> IO ([LogEntry],Either LogEntry ())

execWithPkgDir :: ExecOptions -> Config -> String -> IO ([LogEntry],Either LogEntry ())

execWithCurryPath :: ExecOptions -> Config -> String -> IO ([LogEntry],Either LogEntry ())

computePackageLoadPath :: Config -> String -> IO ([LogEntry],Either LogEntry String)

cleanPackage :: Config -> LogLevel -> IO ([LogEntry],Either LogEntry ())

newPackage :: NewOptions -> IO ([LogEntry],Either LogEntry ())

Creates a new package.

packageNotFoundFailure :: String -> IO ([LogEntry],Either LogEntry a)

Fail with a "package not found" message.

compatPackageNotFoundFailure :: Config -> String -> String -> IO ([LogEntry],Either LogEntry a)

Fail with a "compatible package not found" message and a comment

curryPathCacheFile :: String -> String

The name of the cache file in a package directory.

baseVersionCacheFile :: String -> String

The name of the cache file for the base version in a package directory.

saveBaseVersionToCache :: Config -> String -> IO ()

Saves baseVersion of config in local cache file in the given package dir.

loadBaseVersionFromCache :: String -> IO String

Loads baseVersion from local cache file in the given package dir.

saveCurryPathToCache :: Config -> String -> String -> IO ()

Saves package CURRYPATH in local cache file in the given package dir.

getCurryLoadPath :: Config -> String -> IO ([LogEntry],Either LogEntry String)

Gets CURRYPATH of the given package (either from the local cache file in the package dir or compute it).

loadCurryPathFromCache :: Config -> String -> IO ([LogEntry],Either LogEntry (Maybe String))

Restores package CURRYPATH from local cache file in the given package dir, if it is still up-to-date, i.e., it exists and is newer than the package specification.

cleanCurryPathCache :: String -> IO ([LogEntry],Either LogEntry ())

Cleans the local cache file for CURRYPATH. This might be necessary for upgrade/install/link commands.

Module CPM.Main

Summary of exported operations:

Exported datatypes:

Exported operations: