Safe Haskell	None
Language	Haskell2010

Agda.Interaction.Library

Contents

Exported for testing

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

findProjectRoot :: FilePath -> LibM (Maybe FilePath)
getAgdaAppDir :: IO FilePath
getDefaultLibraries :: FilePath -> Bool -> LibM ([LibName], [FilePath])
getInstalledLibraries :: Maybe FilePath -> LibM [AgdaLibFile]
getTrustedExecutables :: LibM (Map ExeName FilePath)
libraryIncludePaths :: Maybe FilePath -> [AgdaLibFile] -> [LibName] -> LibM [FilePath]
getAgdaLibFiles' :: FilePath -> LibErrorIO [AgdaLibFile]
getPrimitiveLibDir :: IO FilePath
type LibName = String
data OptionsPragma = OptionsPragma {
- pragmaStrings :: [String]
- pragmaRange :: Range
}
data AgdaLibFile = AgdaLibFile {
- _libName :: LibName
- _libFile :: FilePath
- _libAbove :: !Int
- _libIncludes :: [FilePath]
- _libDepends :: [LibName]
- _libPragmas :: OptionsPragma
}
type ExeName = Text
type LibM = ExceptT Doc (WriterT [LibWarning] (StateT LibState IO))
mkLibM :: [AgdaLibFile] -> LibErrorIO a -> LibM a
data LibWarning = LibWarning (Maybe LibPositionInfo) LibWarning'
data LibPositionInfo = LibPositionInfo {
- libFilePos :: Maybe FilePath
- lineNumPos :: LineNumber
- filePos :: FilePath
}
libraryWarningName :: LibWarning -> WarningName
data ProjectConfig
- = ProjectConfig {
  - configRoot :: FilePath
  - configAgdaLibFiles :: [FilePath]
  - configAbove :: !Int
  }
- | DefaultProjectConfig
data VersionView = VersionView {
- vvBase :: LibName
- vvNumbers :: [Integer]
}
versionView :: LibName -> VersionView
unVersionView :: VersionView -> LibName
findLib' :: (a -> LibName) -> LibName -> [a] -> [a]

Documentation

findProjectRoot :: FilePath -> LibM (Maybe FilePath) Source #

Get project root

getAgdaAppDir :: IO FilePath Source #

Get the path to ~/.agda (system-specific). Can be overwritten by the AGDA_DIR environment variable.

(This is not to be confused with the directory for the data files that Agda needs (e.g. the primitive modules).)

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.

getTrustedExecutables Source #

Arguments

:: LibM (Map ExeName FilePath)

Content of executables files.

Return the trusted executables Agda knows about.

Returns none if there is no executables 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.

getAgdaLibFiles' :: FilePath -> LibErrorIO [AgdaLibFile] Source #

Get the contents of .agda-lib files in the given project root.

getPrimitiveLibDir :: IO FilePath Source #

Returns the absolute default lib dir. This directory is used to store the Primitive.agda file.

type LibName = String Source #

A symbolic library name.

data OptionsPragma Source #

The options from an OPTIONS pragma (or a .agda-lib file).

In the future it might be nice to switch to a more structured representation. Note that, currently, there is not a one-to-one correspondence between list elements and options.

Constructors

OptionsPragma
Fields pragmaStrings :: [String] The options. pragmaRange :: Range The range of the options in the pragma (not including things like an `OPTIONS` keyword).

Instances

Instances details

EmbPrj OptionsPragma Source #
Instance details Defined in Agda.TypeChecking.Serialise.Instances.Common Methods icode :: OptionsPragma -> S Int32 Source # icod_ :: OptionsPragma -> S Int32 Source # value :: Int32 -> R OptionsPragma Source #
Monoid OptionsPragma Source #
Instance details Defined in Agda.Interaction.Library.Base Methods mempty :: OptionsPragma # mappend :: OptionsPragma -> OptionsPragma -> OptionsPragma # mconcat :: [OptionsPragma] -> OptionsPragma #
Semigroup OptionsPragma Source #
Instance details Defined in Agda.Interaction.Library.Base Methods (<>) :: OptionsPragma -> OptionsPragma -> OptionsPragma # sconcat :: NonEmpty OptionsPragma -> OptionsPragma # stimes :: Integral b => b -> OptionsPragma -> OptionsPragma #
Show OptionsPragma Source #
Instance details Defined in Agda.Interaction.Library.Base Methods showsPrec :: Int -> OptionsPragma -> ShowS # show :: OptionsPragma -> String # showList :: [OptionsPragma] -> ShowS #
NFData OptionsPragma Source #	Ranges are not forced.
Instance details Defined in Agda.Interaction.Library.Base Methods rnf :: OptionsPragma -> () #

data AgdaLibFile Source #

Content of a .agda-lib file.

Constructors

AgdaLibFile

Fields

_libName :: LibName
The symbolic name of the library.
_libFile :: FilePath
Path to this .agda-lib file (not content of the file).
_libAbove :: !Int
How many directories above the Agda file is the .agda-lib file located?
_libIncludes :: [FilePath]
Roots where to look for the modules of the library.
_libDepends :: [LibName]
Dependencies.
_libPragmas :: OptionsPragma
Default pragma options for all files in the library.

Instances

Instances details

Generic AgdaLibFile Source #

Instance details

LibPositionInfo
Fields libFilePos :: Maybe FilePath Name of `libraries` file. lineNumPos :: LineNumber Line number in `libraries` file. filePos :: FilePath Library file.

ProjectConfig
Fields configRoot :: FilePath configAgdaLibFiles :: [FilePath] configAbove :: !Int How many directories above the Agda file is the `.agda-lib` file located?
DefaultProjectConfig

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.

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

Documentation

Instances

Instances

Instances

Instances

Instances

Exported for testing

Instances