Agda-2.6.0.1: A dependently typed functional programming language and proof assistant

Safe Haskell | None
Language | Haskell2010

Agda.Interaction.Library

Contents

- Exported for testing
- Orphan instances

Description

Library management.

Sample use:

        -- Get libraries as listed in .agda/libraries file.
        libs <- getInstalledLibraries Nothing

        -- Get the libraries (and immediate paths) relevant for projectRoot.
        -- This involves locating and processing the .agda-lib file for the project.
        (libNames, includePaths) <-  getDefaultLibraries projectRoot True

        -- Get include paths of depended-on libraries.
        resolvedPaths <- libraryIncludePaths Nothing libs libNames

        let allPaths = includePaths ++ resolvedPaths

Synopsis

- getDefaultLibraries :: FilePath -> Bool -> LibM ([LibName], [FilePath])
- getInstalledLibraries :: Maybe FilePath -> LibM [AgdaLibFile]
- libraryIncludePaths :: Maybe FilePath -> [AgdaLibFile] -> [LibName] -> LibM [FilePath]
- type LibName = String
- type LibM = ExceptT Doc (WriterT [LibWarning] IO)
- data LibWarning = LibWarning LibPositionInfo LibWarning'
- data LibPositionInfo = LibPositionInfo {
  - libFilePos :: Maybe FilePath
  - lineNumPos :: LineNumber
  - filePos :: FilePath
  }
- libraryWarningName :: LibWarning -> WarningName
- data VersionView = VersionView {
  - vvBase :: LibName
  - vvNumbers :: [Integer]
  }
- versionView :: LibName -> VersionView
- unVersionView :: VersionView -> LibName
- findLib' :: (a -> LibName) -> LibName -> [a] -> [a]

# Documentation

getDefaultLibraries Source #

Arguments

:: FilePath | Project root.
-> Bool | Use `defaults` if no `.agda-lib` file exists for this project?
-> LibM ([LibName], [FilePath]) | The returned `LibName`s are all non-empty strings.

Get dependencies and include paths for given project root:

Look for `.agda-lib` files according to `findAgdaLibFiles`. If none are found, use default dependencies (according to `defaults` file) and current directory (project root).

getInstalledLibraries Source #

Arguments

:: Maybe FilePath | Override the default `libraries` file?
-> LibM [AgdaLibFile] | Content of library files. (Might have empty `LibName`s.)

Parse the descriptions of the libraries Agda knows about.

Returns none if there is no `libraries` file.

libraryIncludePaths Source #

Arguments

:: Maybe FilePath | `libraries` file (error reporting only).
-> [AgdaLibFile] | Libraries Agda knows about.
-> [LibName] | (Non-empty) library names to be resolved to (lists of) pathes.
-> LibM [FilePath] | Resolved pathes (no duplicates). Contains "." if `[LibName]` does.

Get all include pathes for a list of libraries to use.

type LibName = String Source #

A symbolic library name.

type LibM = ExceptT Doc (WriterT [LibWarning] IO) Source #

Throws `Doc` exceptions, still collects `LibWarning`s.

data LibWarning Source #

Constructors

LibWarning LibPositionInfo LibWarning' |

Instances

Data LibWarning Source # |

Instance details

Defined in Agda.Interaction.Library

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LibWarning -> c LibWarning Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LibWarning Source #

toConstr :: LibWarning -> Constr Source #

dataTypeOf :: LibWarning -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LibWarning) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LibWarning) Source #

gmapT :: (forall b. Data b => b -> b) -> LibWarning -> LibWarning Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LibWarning -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LibWarning -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> LibWarning -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LibWarning -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LibWarning -> m LibWarning Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LibWarning -> m LibWarning Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LibWarning -> m LibWarning Source #

Show LibWarning Source # |
Instance details Defined in Agda.Interaction.Library Methods showsPrec :: Int -> LibWarning -> ShowS Source # show :: LibWarning -> String Source # showList :: [LibWarning] -> ShowS Source #
Pretty LibWarning Source # |
Instance details Defined in Agda.Interaction.Library Methods pretty :: LibWarning -> Doc Source # prettyPrec :: Int -> LibWarning -> Doc Source # prettyList :: [LibWarning] -> Doc Source #
EmbPrj LibWarning Source # |
Instance details Defined in Agda.TypeChecking.Serialise.Instances.Errors Methods icode :: LibWarning -> S Int32 Source # icod_ :: LibWarning -> S Int32 Source # value :: Int32 -> R LibWarning Source #

data LibPositionInfo Source #

Constructors

LibPositionInfo |

Fields

- libFilePos :: Maybe FilePath

  Name of `libraries` file

- lineNumPos :: LineNumber

  Line number in `libraries` file.

- filePos :: FilePath

  Library file

Instances

Data LibPositionInfo Source # |

Instance details

Defined in Agda.Interaction.Library

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LibPositionInfo -> c LibPositionInfo Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LibPositionInfo Source #

toConstr :: LibPositionInfo -> Constr Source #

dataTypeOf :: LibPositionInfo -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LibPositionInfo) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LibPositionInfo) Source #

gmapT :: (forall b. Data b => b -> b) -> LibPositionInfo -> LibPositionInfo Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LibPositionInfo -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LibPositionInfo -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> LibPositionInfo -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LibPositionInfo -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LibPositionInfo -> m LibPositionInfo Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LibPositionInfo -> m LibPositionInfo Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LibPositionInfo -> m LibPositionInfo Source #

Show LibPositionInfo Source # |
Instance details Defined in Agda.Interaction.Library Methods showsPrec :: Int -> LibPositionInfo -> ShowS Source # show :: LibPositionInfo -> String Source # showList :: [LibPositionInfo] -> ShowS Source #
EmbPrj LibPositionInfo Source # |
Instance details Defined in Agda.TypeChecking.Serialise.Instances.Errors Methods icode :: LibPositionInfo -> S Int32 Source # icod_ :: LibPositionInfo -> S Int32 Source # value :: Int32 -> R LibPositionInfo Source #

libraryWarningName :: LibWarning -> WarningName Source #

# Exported for testing

data VersionView Source #

Library names are structured into the base name and a suffix of version numbers, e.g. `mylib-1.2.3`. The version suffix is optional.

Constructors

VersionView |

Fields

- vvBase :: LibName

  Actual library name.

- vvNumbers :: [Integer]

  Major version, minor version, subminor version, etc., all non-negative. Note: a priori, there is no reason why the version numbers should be `Int`s.

Instances

Eq VersionView Source # |
Instance details Defined in Agda.Interaction.Library Methods (==) :: VersionView -> VersionView -> Bool Source # (/=) :: VersionView -> VersionView -> Bool Source #
Show VersionView Source # |
Instance details Defined in Agda.Interaction.Library Methods showsPrec :: Int -> VersionView -> ShowS Source # show :: VersionView -> String Source # showList :: [VersionView] -> ShowS Source #

versionView :: LibName -> VersionView Source #

Split a library name into basename and a list of version numbers.

    versionView "foo-1.2.3"    == VersionView "foo" [1, 2, 3]
    versionView "foo-01.002.3" == VersionView "foo" [1, 2, 3]

Note that because of leading zeros, `versionView` is not injective. (`unVersionView . versionView` would produce a normal form.)

unVersionView :: VersionView -> LibName Source #

Print a `VersionView`, inverse of `versionView` (modulo leading zeros).

findLib' :: (a -> LibName) -> LibName -> [a] -> [a] Source #

Generalized version of `findLib` for testing.

    findLib' id "a"   [ "a-1", "a-02", "a-2", "b" ] == [ "a-02", "a-2" ]

    findLib' id "a"   [ "a", "a-1", "a-01", "a-2", "b" ] == [ "a" ]
    findLib' id "a-1" [ "a", "a-1", "a-01", "a-2", "b" ] == [ "a-1", "a-01" ]
    findLib' id "a-2" [ "a", "a-1", "a-01", "a-2", "b" ] == [ "a-2" ]
    findLib' id "c"   [ "a", "a-1", "a-01", "a-2", "b" ] == []

# Orphan instances

Pretty LibWarning' Source # |
Instance details Methods pretty :: LibWarning' -> Doc Source # prettyPrec :: Int -> LibWarning' -> Doc Source # prettyList :: [LibWarning'] -> Doc Source #