Futhark.Pkg.Types

Types (and a few other simple definitions) for futhark-pkg.

Documentation

type PkgPath = Text

A package path is a unique identifier for a package, for example github.comuserfoo.

pkgPathFilePath :: PkgPath -> FilePath

Turn a package path (which always uses forward slashes) into a file path in the local file system (which might use different slashes).

newtype PkgRevDeps

The dependencies of a (revision of a) package is a mapping from package paths to minimum versions (and an optional hash pinning).

Constructors

PkgRevDeps (Map PkgPath (SemVer, Maybe Text))

Instances

Show PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> PkgRevDeps -> ShowS

show :: PkgRevDeps -> String

showList :: [PkgRevDeps] -> ShowS

Semigroup PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

(<>) :: PkgRevDeps -> PkgRevDeps -> PkgRevDeps

sconcat :: NonEmpty PkgRevDeps -> PkgRevDeps

stimes :: Integral b => b -> PkgRevDeps -> PkgRevDeps

Monoid PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

mempty :: PkgRevDeps

mappend :: PkgRevDeps -> PkgRevDeps -> PkgRevDeps

mconcat :: [PkgRevDeps] -> PkgRevDeps

prettySemVer :: SemVer -> Text

semver :: Text -> Either ParsingError SemVer

data SemVer

Constructors

SemVer

Fields

• _svMajor :: Word
• _svMinor :: Word
• _svPatch :: Word
• _svPreRel :: [VChunk]
• _svMeta :: [VChunk]

Instances

Eq SemVer

Defined in Data.Versions

Methods

(==) :: SemVer -> SemVer -> Bool

(/=) :: SemVer -> SemVer -> Bool

Ord SemVer

Defined in Data.Versions

Methods

compare :: SemVer -> SemVer -> Ordering

(<) :: SemVer -> SemVer -> Bool

(<=) :: SemVer -> SemVer -> Bool

(>) :: SemVer -> SemVer -> Bool

(>=) :: SemVer -> SemVer -> Bool

max :: SemVer -> SemVer -> SemVer

min :: SemVer -> SemVer -> SemVer

Show SemVer

Defined in Data.Versions

Methods

showsPrec :: Int -> SemVer -> ShowS

show :: SemVer -> String

showList :: [SemVer] -> ShowS

Generic SemVer

Defined in Data.Versions

Associated Types

type Rep SemVer :: Type -> Type

Methods

from :: SemVer -> Rep SemVer x

to :: Rep SemVer x -> SemVer

Semigroup SemVer

Defined in Data.Versions

Methods

(<>) :: SemVer -> SemVer -> SemVer

sconcat :: NonEmpty SemVer -> SemVer

stimes :: Integral b => b -> SemVer -> SemVer

Monoid SemVer

Defined in Data.Versions

Methods

mempty :: SemVer

mappend :: SemVer -> SemVer -> SemVer

mconcat :: [SemVer] -> SemVer

NFData SemVer

Defined in Data.Versions

Methods

rnf :: SemVer -> ()

Semantic SemVer

Defined in Data.Versions

Methods

major :: Traversal' SemVer Word

minor :: Traversal' SemVer Word

patch :: Traversal' SemVer Word

release :: Traversal' SemVer [VChunk]

meta :: Traversal' SemVer [VChunk]

semantic :: Traversal' SemVer SemVer

Hashable SemVer

Defined in Data.Versions

Methods

hashWithSalt :: Int -> SemVer -> Int

hash :: SemVer -> Int

type Rep SemVer

Defined in Data.Versions

type Rep SemVer = D1 ('MetaData "SemVer" "Data.Versions" "versions-3.5.3-50c8623388aa42e0f827054c1ecdeac6ac77a2668b7c13806d207be2bd75e84b" 'False) (C1 ('MetaCons "SemVer" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_svMajor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: S1 ('MetaSel ('Just "_svMinor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)) :*: (S1 ('MetaSel ('Just "_svPatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: (S1 ('MetaSel ('Just "_svPreRel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [VChunk]) :*: S1 ('MetaSel ('Just "_svMeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [VChunk])))))

data VUnit

Constructors

Digits Word

Str Text

Instances

Eq VUnit

Defined in Data.Versions

Methods

(==) :: VUnit -> VUnit -> Bool

(/=) :: VUnit -> VUnit -> Bool

Ord VUnit

Defined in Data.Versions

Methods

compare :: VUnit -> VUnit -> Ordering

(<) :: VUnit -> VUnit -> Bool

(<=) :: VUnit -> VUnit -> Bool

(>) :: VUnit -> VUnit -> Bool

(>=) :: VUnit -> VUnit -> Bool

max :: VUnit -> VUnit -> VUnit

min :: VUnit -> VUnit -> VUnit

Read VUnit

Defined in Data.Versions

Methods

readsPrec :: Int -> ReadS VUnit

readList :: ReadS [VUnit]

readPrec :: ReadPrec VUnit

readListPrec :: ReadPrec [VUnit]

Show VUnit

Defined in Data.Versions

Methods

showsPrec :: Int -> VUnit -> ShowS

show :: VUnit -> String

showList :: [VUnit] -> ShowS

Generic VUnit

Defined in Data.Versions

Associated Types

type Rep VUnit :: Type -> Type

Methods

from :: VUnit -> Rep VUnit x

to :: Rep VUnit x -> VUnit

Semigroup VUnit

Defined in Data.Versions

Methods

(<>) :: VUnit -> VUnit -> VUnit

sconcat :: NonEmpty VUnit -> VUnit

stimes :: Integral b => b -> VUnit -> VUnit

Monoid VUnit

Defined in Data.Versions

Methods

mempty :: VUnit

mappend :: VUnit -> VUnit -> VUnit

mconcat :: [VUnit] -> VUnit

NFData VUnit

Defined in Data.Versions

Methods

rnf :: VUnit -> ()

Hashable VUnit

Defined in Data.Versions

Methods

hashWithSalt :: Int -> VUnit -> Int

hash :: VUnit -> Int

type Rep VUnit

Defined in Data.Versions

type Rep VUnit = D1 ('MetaData "VUnit" "Data.Versions" "versions-3.5.3-50c8623388aa42e0f827054c1ecdeac6ac77a2668b7c13806d207be2bd75e84b" 'False) (C1 ('MetaCons "Digits" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)) :+: C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Versions

commitVersion :: Text -> Text -> SemVer

commitVersion timestamp commit constructs a commit version.

isCommitVersion :: SemVer -> Maybe Text

Versions of the form (0,0,0)-timestamp+hash are treated specially, as a reference to the commit identified uniquely with hash (typically the Git commit ID). This function detects such versions.

parseVersion :: Text -> Either (ParseErrorBundle Text Void) SemVer

Unfortunately, Data.Versions has a buggy semver parser that collapses consecutive zeroes in the metadata field. So, we define our own parser here. It's a little simpler too, since we don't need full semver.

Package manifests

data PkgManifest

A structure corresponding to a futhark.pkg file, including comments. It is an invariant that duplicate required packages do not occcur (the parser will verify this).

Constructors

PkgManifest

Fields

• manifestPkgPath :: Commented (Maybe PkgPath)

  The name of the package.

• manifestRequire :: Commented [Either Comment Required]
• manifestEndComments :: [Comment]

Instances

Eq PkgManifest

Defined in Futhark.Pkg.Types

Methods

(==) :: PkgManifest -> PkgManifest -> Bool

(/=) :: PkgManifest -> PkgManifest -> Bool

Show PkgManifest

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> PkgManifest -> ShowS

show :: PkgManifest -> String

showList :: [PkgManifest] -> ShowS

newPkgManifest :: Maybe PkgPath -> PkgManifest

Possibly given a package path, construct an otherwise-empty manifest file.

pkgRevDeps :: PkgManifest -> PkgRevDeps

The required packages listed in a package manifest.

pkgDir :: PkgManifest -> Maybe FilePath

Where in the corresponding repository archive we can expect to find the package files.

addRequiredToManifest :: Required -> PkgManifest -> (PkgManifest, Maybe Required)

Add new required package to the package manifest. If the package was already present, return the old version.

removeRequiredFromManifest :: PkgPath -> PkgManifest -> Maybe (PkgManifest, Required)

Remove a required package from the manifest. Returns Nothing if the package was not found in the manifest, and otherwise the new manifest and the Required that was present.

prettyPkgManifest :: PkgManifest -> Text

Prettyprint a package manifest such that it can be written to a futhark.pkg file.

type Comment = Text

A line comment.

data Commented a

Wraps a value with an annotation of preceding line comments. This is important to our goal of being able to programmatically modify the futhark.pkg file while keeping comments intact.

Constructors

Commented

Fields

• comments :: [Comment]
• commented :: a

Instances

Functor Commented

Defined in Futhark.Pkg.Types

Methods

fmap :: (a -> b) -> Commented a -> Commented b

(<$) :: a -> Commented b -> Commented a

Foldable Commented

Defined in Futhark.Pkg.Types

Methods

fold :: Monoid m => Commented m -> m

foldMap :: Monoid m => (a -> m) -> Commented a -> m

foldMap' :: Monoid m => (a -> m) -> Commented a -> m

foldr :: (a -> b -> b) -> b -> Commented a -> b

foldr' :: (a -> b -> b) -> b -> Commented a -> b

foldl :: (b -> a -> b) -> b -> Commented a -> b

foldl' :: (b -> a -> b) -> b -> Commented a -> b

foldr1 :: (a -> a -> a) -> Commented a -> a

foldl1 :: (a -> a -> a) -> Commented a -> a

toList :: Commented a -> [a]

null :: Commented a -> Bool

length :: Commented a -> Int

elem :: Eq a => a -> Commented a -> Bool

maximum :: Ord a => Commented a -> a

minimum :: Ord a => Commented a -> a

sum :: Num a => Commented a -> a

product :: Num a => Commented a -> a

Traversable Commented

Defined in Futhark.Pkg.Types

Methods

traverse :: Applicative f => (a -> f b) -> Commented a -> f (Commented b)

sequenceA :: Applicative f => Commented (f a) -> f (Commented a)

mapM :: Monad m => (a -> m b) -> Commented a -> m (Commented b)

sequence :: Monad m => Commented (m a) -> m (Commented a)

Eq a => Eq (Commented a)

Defined in Futhark.Pkg.Types

Methods

(==) :: Commented a -> Commented a -> Bool

(/=) :: Commented a -> Commented a -> Bool

Show a => Show (Commented a)

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> Commented a -> ShowS

show :: Commented a -> String

showList :: [Commented a] -> ShowS

data Required

An entry in the required section of a futhark.pkg file.

Constructors

Required

Fields

• requiredPkg :: PkgPath

  Name of the required package.

• requiredPkgRev :: SemVer

  The minimum revision.

• requiredHash :: Maybe Text

  An optional hash indicating what this revision looked like the last time we saw it. Used for integrity checking.

Instances

Eq Required

Defined in Futhark.Pkg.Types

Methods

(==) :: Required -> Required -> Bool

(/=) :: Required -> Required -> Bool

Show Required

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> Required -> ShowS

show :: Required -> String

showList :: [Required] -> ShowS

futharkPkg :: FilePath

The name of the file containing the futhark-pkg manifest.

Parsing package manifests

parsePkgManifest :: FilePath -> Text -> Either (ParseErrorBundle Text Void) PkgManifest

parsePkgManifestFromFile :: FilePath -> IO PkgManifest

errorBundlePretty :: (Stream s, ShowErrorComponent e) => ParseErrorBundle s e -> String

Build list

newtype BuildList

A mapping from package paths to their chosen revisions. This is the result of the version solver.

Constructors

BuildList

Fields

• unBuildList :: Map PkgPath SemVer

Instances

Eq BuildList

Defined in Futhark.Pkg.Types

Methods

(==) :: BuildList -> BuildList -> Bool

(/=) :: BuildList -> BuildList -> Bool

Show BuildList

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> BuildList -> ShowS

show :: BuildList -> String

showList :: [BuildList] -> ShowS

prettyBuildList :: BuildList -> Text

Prettyprint a build list; one package per line and newline-terminated.