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

Monoid PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

mempty :: PkgRevDeps

mappend :: PkgRevDeps -> PkgRevDeps -> PkgRevDeps

mconcat :: [PkgRevDeps] -> PkgRevDeps

Semigroup PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

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

sconcat :: NonEmpty PkgRevDeps -> PkgRevDeps

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

Show PkgRevDeps

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> PkgRevDeps -> ShowS

show :: PkgRevDeps -> String

showList :: [PkgRevDeps] -> ShowS

prettySemVer :: SemVer -> Text

Convert a SemVer back to its textual representation.

data SemVer

An (Ideal) version number that conforms to Semantic Versioning. This is a prescriptive parser, meaning it follows the SemVer standard.

Legal semvers are of the form: MAJOR.MINOR.PATCH-PREREL+META

Example: 1.2.3-r1+commithash

Extra Rules:

1. Pre-release versions have lower precedence than normal versions.
2. Build metadata does not affect version precedence.
3. PREREL and META strings may only contain ASCII alphanumerics and hyphens.

For more information, see http://semver.org

Constructors

SemVer

Fields

• _svMajor :: !Word
• _svMinor :: !Word
• _svPatch :: !Word
• _svPreRel :: ![VChunk]
• _svMeta :: !(Maybe Text)

Instances

Monoid SemVer

Defined in Data.Versions

Methods

mempty :: SemVer

mappend :: SemVer -> SemVer -> SemVer

mconcat :: [SemVer] -> SemVer

Semigroup SemVer

Defined in Data.Versions

Methods

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

sconcat :: NonEmpty SemVer -> SemVer

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

Generic SemVer

Defined in Data.Versions

Associated Types

type Rep SemVer :: Type -> Type

Methods

from :: SemVer -> Rep SemVer x

to :: Rep SemVer x -> SemVer

Show SemVer

Defined in Data.Versions

Methods

showsPrec :: Int -> SemVer -> ShowS

show :: SemVer -> String

showList :: [SemVer] -> ShowS

NFData SemVer

Defined in Data.Versions

Methods

rnf :: SemVer -> ()

Eq SemVer

Two SemVers are equal if all fields except metadata are equal.

Defined in Data.Versions

Methods

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

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

Ord SemVer

Build metadata does not affect version precedence.

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

Hashable SemVer

Defined in Data.Versions

Methods

hashWithSalt :: Int -> SemVer -> Int

hash :: SemVer -> Int

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 (Maybe Text)

semantic :: Traversal' SemVer SemVer

type Rep SemVer

Defined in Data.Versions

type Rep SemVer = D1 ('MetaData "SemVer" "Data.Versions" "versions-5.0.3-8498d1a709fd8caf9685005bee48558881753bc3f616ea63778466aac8b58cb9" 'False) (C1 ('MetaCons "SemVer" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_svMajor") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word) :*: S1 ('MetaSel ('Just "_svMinor") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word)) :*: (S1 ('MetaSel ('Just "_svPatch") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word) :*: (S1 ('MetaSel ('Just "_svPreRel") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [VChunk]) :*: S1 ('MetaSel ('Just "_svMeta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

data VUnit

A single unit of a Version. May be digits or a string of characters. Groups of these are called VChunks, and are the identifiers separated by periods in the source.

Constructors

Digits Word

Str Text

Instances

Monoid VUnit

Defined in Data.Versions

Methods

mempty :: VUnit

mappend :: VUnit -> VUnit -> VUnit

mconcat :: [VUnit] -> VUnit

Semigroup VUnit

Defined in Data.Versions

Methods

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

sconcat :: NonEmpty VUnit -> VUnit

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

Generic VUnit

Defined in Data.Versions

Associated Types

type Rep VUnit :: Type -> Type

Methods

from :: VUnit -> Rep VUnit x

to :: Rep VUnit x -> 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

NFData VUnit

Defined in Data.Versions

Methods

rnf :: VUnit -> ()

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

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-5.0.3-8498d1a709fd8caf9685005bee48558881753bc3f616ea63778466aac8b58cb9" '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

Show PkgManifest

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> PkgManifest -> ShowS

show :: PkgManifest -> String

showList :: [PkgManifest] -> ShowS

Eq PkgManifest

Defined in Futhark.Pkg.Types

Methods

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

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

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

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)

Functor Commented

Defined in Futhark.Pkg.Types

Methods

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

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

Show a => Show (Commented a)

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> Commented a -> ShowS

show :: Commented a -> String

showList :: [Commented a] -> ShowS

Eq a => Eq (Commented a)

Defined in Futhark.Pkg.Types

Methods

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

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

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

Show Required

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> Required -> ShowS

show :: Required -> String

showList :: [Required] -> ShowS

Eq Required

Defined in Futhark.Pkg.Types

Methods

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

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

futharkPkg :: FilePath

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

Parsing package manifests

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

Parse a pretty as a PkgManifest. The FilePath is used for any error messages.

parsePkgManifestFromFile :: FilePath -> IO PkgManifest

Read contents of file and pass it to parsePkgManifest.

errorBundlePretty

Arguments

:: (VisualStream s, TraversableStream s, ShowErrorComponent e)

=> ParseErrorBundle s e

Parse error bundle to display

-> String

Textual rendition of the bundle

Pretty-print a ParseErrorBundle. All ParseErrors in the bundle will be pretty-printed in order together with the corresponding offending lines by doing a single pass over the input stream. The rendered String always ends with a newline.

Since: megaparsec-7.0.0

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

Show BuildList

Defined in Futhark.Pkg.Types

Methods

showsPrec :: Int -> BuildList -> ShowS

show :: BuildList -> String

showList :: [BuildList] -> ShowS

Eq BuildList

Defined in Futhark.Pkg.Types

Methods

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

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

prettyBuildList :: BuildList -> Text

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