Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Codebase.Path

Contents

utilities
tests
conversions

Synopsis

data Path
data Path'
- = AbsolutePath' Absolute
- | RelativePath' Relative
class Pathy path where
- ascend :: path -> Maybe path
- descend :: path -> NameSegment -> path
- prefix :: path -> Relative -> path
- split :: path -> Maybe (Split path)
- unsplit :: Split path -> path
- toText :: path -> Text
class Pathy path => Namey path where
- nameFromSplit :: Split path -> Name
- toName :: path -> Maybe Name
newtype Absolute = Absolute {
- unabsolute :: Path
}
absPath_ :: Lens' Absolute Path
newtype Relative = Relative {
- unrelative :: Path
}
relPath_ :: Lens' Relative Path
class Resolve l r o where
- resolve :: l -> r -> o
pattern Current :: Relative
pattern Current' :: Path'
pattern Root :: Absolute
pattern Root' :: Path'
singleton :: NameSegment -> Path
isAbsolute :: Path' -> Bool
isRelative :: Path' -> Bool
parentOfName :: Name -> Split Path'
maybePrefix :: Path' -> Path' -> Maybe Path'
unprefix :: Relative -> Path' -> Path'
maybePrefixName :: Path' -> Name -> Maybe Name
prefixNameIfRel :: Path' -> Name -> Name
unprefixName :: Relative -> Name -> Maybe Name
type Split path = (path, NameSegment)
ancestors :: Absolute -> Seq Absolute
longestPathPrefix :: Absolute -> Absolute -> (Absolute, Relative, Relative)
isRoot :: Absolute -> Bool
absoluteToPath' :: Absolute -> Path'
fromList :: [NameSegment] -> Path
fromName :: Name -> Path
fromName' :: Name -> Path'
fromPath' :: Path' -> Path
unsafeParseText :: Text -> Path
unsafeParseText' :: Text -> Path'
toAbsoluteSplit :: Absolute -> Split Path' -> Split Absolute
toList :: Path -> [NameSegment]
splitFromName :: Name -> Split Path

Documentation

data Path Source #

A Path is an internal structure representing some namespace in the codebase.

Foo.Bar.baz becomes [Foo, Bar, "baz"].

NB: This shouldn’t be exposed outside of this module (preferPath', Absolute, or Relative), but it’s currently used pretty widely. Such usage should be replaced when encountered.

Instances

Instances details

Monoid Path Source #
Instance details Defined in Unison.Codebase.Path Methods mempty :: Path # mappend :: Path -> Path -> Path # mconcat :: [Path] -> Path #
Semigroup Path Source #
Instance details Defined in Unison.Codebase.Path Methods (<>) :: Path -> Path -> Path # sconcat :: NonEmpty Path -> Path # stimes :: Integral b => b -> Path -> Path #
IsList Path Source #	Meant for use mostly in doc-tests where it's sometimes convenient to specify paths as lists.
Instance details Defined in Unison.Codebase.Path Associated Types type Item Path # Methods fromList :: [Item Path] -> Path # fromListN :: Int -> [Item Path] -> Path # toList :: Path -> [Item Path] #
Show Path Source #
Instance details Defined in Unison.Codebase.Path Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Eq Path Source #
Instance details Defined in Unison.Codebase.Path Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Ord Path Source #
Instance details Defined in Unison.Codebase.Path Methods compare :: Path -> Path -> Ordering # (<) :: Path -> Path -> Bool # (<=) :: Path -> Path -> Bool # (>) :: Path -> Path -> Bool # (>=) :: Path -> Path -> Bool # max :: Path -> Path -> Path # min :: Path -> Path -> Path #
Namey Path Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Path -> Name Source # toName :: Path -> Maybe Name Source #
Pathy Path Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Path -> Maybe Path Source # descend :: Path -> NameSegment -> Path Source # prefix :: Path -> Relative -> Path Source # split :: Path -> Maybe (Split Path) Source # unsplit :: Split Path -> Path Source # toText :: Path -> Text Source #
Resolve Absolute Path Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path -> Absolute Source #
Resolve Path Path Path Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Path -> Path -> Path Source #
Recursive Path (XNor NameSegment) Source #
Instance details Defined in Unison.Codebase.Path Methods cata :: Algebra (XNor NameSegment) a -> Path -> a # project :: Path -> XNor NameSegment Path # embed :: XNor NameSegment Path -> Path #
Resolve Absolute (Split Path) (Split Absolute) Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Split Path -> Split Absolute Source #
type Item Path Source #
Instance details Defined in Unison.Codebase.Path type Item Path = NameSegment

data Path' Source #

A namespace that may be either absolute or relative, This is the most general type that should be used.

Constructors

AbsolutePath' Absolute
RelativePath' Relative

Instances

Instances details

Show Path' Source #
Instance details Defined in Unison.Codebase.Path Methods showsPrec :: Int -> Path' -> ShowS # show :: Path' -> String # showList :: [Path'] -> ShowS #
Eq Path' Source #
Instance details Defined in Unison.Codebase.Path Methods (==) :: Path' -> Path' -> Bool # (/=) :: Path' -> Path' -> Bool #
Ord Path' Source #
Instance details Defined in Unison.Codebase.Path Methods compare :: Path' -> Path' -> Ordering # (<) :: Path' -> Path' -> Bool # (<=) :: Path' -> Path' -> Bool # (>) :: Path' -> Path' -> Bool # (>=) :: Path' -> Path' -> Bool # max :: Path' -> Path' -> Path' # min :: Path' -> Path' -> Path' #
Namey Path' Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Path' -> Name Source # toName :: Path' -> Maybe Name Source #
Pathy Path' Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Path' -> Maybe Path' Source # descend :: Path' -> NameSegment -> Path' Source # prefix :: Path' -> Relative -> Path' Source # split :: Path' -> Maybe (Split Path') Source # unsplit :: Split Path' -> Path' Source # toText :: Path' -> Text Source #
Resolve Absolute Path' Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path' -> Absolute Source #
Resolve Absolute Relative Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Path' Source #
Resolve Path' Path' Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Path' -> Path' -> Path' Source #

class Pathy path where Source #

Minimal complete definition

descend, prefix, split, toText

Methods

ascend :: path -> Maybe path Source #

descend :: path -> NameSegment -> path Source #

prefix :: path -> Relative -> path Source #

This always prefixes, since the second argument can never be absolute.

split :: path -> Maybe (Split path) Source #

unsplit :: Split path -> path Source #

toText :: path -> Text Source #

Instances

Instances details

Pathy Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Absolute -> Maybe Absolute Source # descend :: Absolute -> NameSegment -> Absolute Source # prefix :: Absolute -> Relative -> Absolute Source # split :: Absolute -> Maybe (Split Absolute) Source # unsplit :: Split Absolute -> Absolute Source # toText :: Absolute -> Text Source #
Pathy Path Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Path -> Maybe Path Source # descend :: Path -> NameSegment -> Path Source # prefix :: Path -> Relative -> Path Source # split :: Path -> Maybe (Split Path) Source # unsplit :: Split Path -> Path Source # toText :: Path -> Text Source #
Pathy Path' Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Path' -> Maybe Path' Source # descend :: Path' -> NameSegment -> Path' Source # prefix :: Path' -> Relative -> Path' Source # split :: Path' -> Maybe (Split Path') Source # unsplit :: Split Path' -> Path' Source # toText :: Path' -> Text Source #
Pathy Relative Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Relative -> Maybe Relative Source # descend :: Relative -> NameSegment -> Relative Source # prefix :: Relative -> Relative -> Relative Source # split :: Relative -> Maybe (Split Relative) Source # unsplit :: Split Relative -> Relative Source # toText :: Relative -> Text Source #
Pathy ProjectPath Source #
Instance details Defined in Unison.Codebase.ProjectPath Methods ascend :: ProjectPath -> Maybe ProjectPath Source # descend :: ProjectPath -> NameSegment -> ProjectPath Source # prefix :: ProjectPath -> Relative -> ProjectPath Source # split :: ProjectPath -> Maybe (Split ProjectPath) Source # unsplit :: Split ProjectPath -> ProjectPath Source # toText :: ProjectPath -> Text Source #
Pathy ProjectPathNames Source #
Instance details Defined in Unison.Codebase.ProjectPath Methods ascend :: ProjectPathNames -> Maybe ProjectPathNames Source # descend :: ProjectPathNames -> NameSegment -> ProjectPathNames Source # prefix :: ProjectPathNames -> Relative -> ProjectPathNames Source # split :: ProjectPathNames -> Maybe (Split ProjectPathNames) Source # unsplit :: Split ProjectPathNames -> ProjectPathNames Source # toText :: ProjectPathNames -> Text Source #

class Pathy path => Namey path where Source #

Minimal complete definition

nameFromSplit

Methods

nameFromSplit :: Split path -> Name Source #

toName :: path -> Maybe Name Source #

Convert a path' to a Name

Instances

Instances details

Namey Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Absolute -> Name Source # toName :: Absolute -> Maybe Name Source #
Namey Path Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Path -> Name Source # toName :: Path -> Maybe Name Source #
Namey Path' Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Path' -> Name Source # toName :: Path' -> Maybe Name Source #
Namey Relative Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Relative -> Name Source # toName :: Relative -> Maybe Name Source #

newtype Absolute Source #

An absolute from the current project root

Constructors

Absolute
Fields unabsolute :: Path

Instances

Instances details

Show Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods showsPrec :: Int -> Absolute -> ShowS # show :: Absolute -> String # showList :: [Absolute] -> ShowS #
Eq Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods (==) :: Absolute -> Absolute -> Bool # (/=) :: Absolute -> Absolute -> Bool #
Ord Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods compare :: Absolute -> Absolute -> Ordering # (<) :: Absolute -> Absolute -> Bool # (<=) :: Absolute -> Absolute -> Bool # (>) :: Absolute -> Absolute -> Bool # (>=) :: Absolute -> Absolute -> Bool # max :: Absolute -> Absolute -> Absolute # min :: Absolute -> Absolute -> Absolute #
Namey Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Absolute -> Name Source # toName :: Absolute -> Maybe Name Source #
Pathy Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Absolute -> Maybe Absolute Source # descend :: Absolute -> NameSegment -> Absolute Source # prefix :: Absolute -> Relative -> Absolute Source # split :: Absolute -> Maybe (Split Absolute) Source # unsplit :: Split Absolute -> Absolute Source # toText :: Absolute -> Text Source #
Resolve Absolute Path Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path -> Absolute Source #
Resolve Absolute Path' Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path' -> Absolute Source #
Resolve Absolute Relative Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Absolute Source #
Resolve Absolute Relative Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Path' Source #
Recursive Absolute (XNor NameSegment) Source #
Instance details Defined in Unison.Codebase.Path Methods cata :: Algebra (XNor NameSegment) a -> Absolute -> a # project :: Absolute -> XNor NameSegment Absolute # embed :: XNor NameSegment Absolute -> Absolute #
Resolve Absolute (Split Path) (Split Absolute) Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Split Path -> Split Absolute Source #

absPath_ :: Lens' Absolute Path Source #

newtype Relative Source #

A namespace path that doesn’t necessarily start from the root. Typically refers to a path from the current namespace.

Constructors

Relative
Fields unrelative :: Path

Instances

Instances details

Monoid Relative Source #
Instance details Defined in Unison.Codebase.Path Methods mempty :: Relative # mappend :: Relative -> Relative -> Relative # mconcat :: [Relative] -> Relative #
Semigroup Relative Source #
Instance details Defined in Unison.Codebase.Path Methods (<>) :: Relative -> Relative -> Relative # sconcat :: NonEmpty Relative -> Relative # stimes :: Integral b => b -> Relative -> Relative #
Show Relative Source #
Instance details Defined in Unison.Codebase.Path Methods showsPrec :: Int -> Relative -> ShowS # show :: Relative -> String # showList :: [Relative] -> ShowS #
Eq Relative Source #
Instance details Defined in Unison.Codebase.Path Methods (==) :: Relative -> Relative -> Bool # (/=) :: Relative -> Relative -> Bool #
Ord Relative Source #
Instance details Defined in Unison.Codebase.Path Methods compare :: Relative -> Relative -> Ordering # (<) :: Relative -> Relative -> Bool # (<=) :: Relative -> Relative -> Bool # (>) :: Relative -> Relative -> Bool # (>=) :: Relative -> Relative -> Bool # max :: Relative -> Relative -> Relative # min :: Relative -> Relative -> Relative #
Namey Relative Source #
Instance details Defined in Unison.Codebase.Path Methods nameFromSplit :: Split Relative -> Name Source # toName :: Relative -> Maybe Name Source #
Pathy Relative Source #
Instance details Defined in Unison.Codebase.Path Methods ascend :: Relative -> Maybe Relative Source # descend :: Relative -> NameSegment -> Relative Source # prefix :: Relative -> Relative -> Relative Source # split :: Relative -> Maybe (Split Relative) Source # unsplit :: Split Relative -> Relative Source # toText :: Relative -> Text Source #
Resolve Absolute Relative Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Absolute Source #
Resolve Absolute Relative Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Path' Source #
Resolve Relative Relative Relative Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Relative -> Relative -> Relative Source #

relPath_ :: Lens' Relative Path Source #

class Resolve l r o where Source #

Methods

resolve :: l -> r -> o Source #

Instances

Instances details

Resolve Absolute Path Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path -> Absolute Source #
Resolve Absolute Path' Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Path' -> Absolute Source #
Resolve Absolute Relative Absolute Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Absolute Source #
Resolve Absolute Relative Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Relative -> Path' Source #
Resolve Path Path Path Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Path -> Path -> Path Source #
Resolve Path' Path' Path' Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Path' -> Path' -> Path' Source #
Resolve Relative Relative Relative Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Relative -> Relative -> Relative Source #
Resolve Absolute (Split Path) (Split Absolute) Source #
Instance details Defined in Unison.Codebase.Path Methods resolve :: Absolute -> Split Path -> Split Absolute Source #

pattern Current :: Relative Source #

pattern Current' :: Path' Source #

pattern Root :: Absolute Source #

pattern Root' :: Path' Source #

singleton :: NameSegment -> Path Source #

isAbsolute :: Path' -> Bool Source #

isRelative :: Path' -> Bool Source #

parentOfName :: Name -> Split Path' Source #

maybePrefix :: Path' -> Path' -> Maybe Path' Source #

Returns Nothing if the second argument is absolute. A common pattern is fromMaybe path $ maybePrefix prefix path to use the unmodified path in that case.

unprefix :: Relative -> Path' -> Path' Source #

examples: unprefix foo.bar .blah == .blah (absolute paths left alone) unprefix foo.bar id == id (relative paths starting w/ nonmatching prefix left alone) unprefix foo.bar foo.bar.baz == baz (relative paths w/ common prefix get stripped)

maybePrefixName :: Path' -> Name -> Maybe Name Source #

Returns Nothing if the second argument is absolute. A common pattern is fromMaybe name $ maybePrefixName prefix name to use the unmodified path in that case.

prefixNameIfRel :: Path' -> Name -> Name Source #

unprefixName :: Relative -> Name -> Maybe Name Source #

Remove a path prefix from a name. Returns Nothing if there are no remaining segments to construct the name from.

>>> unprefixName (Relative $ fromList ["base", "List"]) (Name.unsafeFromText "base.List.map")
Just (Name Relative (NameSegment {toText = "map"} :| []))

type Split path = (path, NameSegment) Source #

ancestors :: Absolute -> Seq Absolute Source #

utilities

longestPathPrefix :: Absolute -> Absolute -> (Absolute, Relative, Relative) Source #

Finds the longest shared path prefix of two paths. Returns (shared prefix, path to first location from shared prefix, path to second location from shared prefix)

>>> longestPathPrefix ("a" :< "b" :< "x" :< Empty) ("a" :< "b" :< "c" :< Empty)
(a.b,x,c)

>>> longestPathPrefix Empty ("a" :< "b" :< "c" :< Empty)
(,,a.b.c)

tests

isRoot :: Absolute -> Bool Source #

conversions

absoluteToPath' :: Absolute -> Path' Source #

fromList :: [NameSegment] -> Path Source #

fromName :: Name -> Path Source #

fromName' :: Name -> Path' Source #

fromPath' :: Path' -> Path Source #

unsafeParseText :: Text -> Path Source #

unsafeParseText' :: Text -> Path' Source #

Construct a Path' from a text

>>> fromText' "a.b.c"
a.b.c

>>> fromText' ".a.b.c"
.a.b.c

>>> show $ fromText' ""
""

toAbsoluteSplit :: Absolute -> Split Path' -> Split Absolute Source #

toList :: Path -> [NameSegment] Source #

splitFromName :: Name -> Split Path Source #

>>> splitFromName "a.b.c"
(a.b,c)

>>> splitFromName "foo"
(,foo)