Cabal-2.0.1.0: A framework for packaging Haskell software

Safe Haskell | None
Language | Haskell2010

Distribution.Types.MungedPackageName

Synopsis

- data MungedPackageName
- unMungedPackageName :: MungedPackageName -> String
- mkMungedPackageName :: String -> MungedPackageName
- computeCompatPackageName :: PackageName -> Maybe UnqualComponentName -> MungedPackageName
- decodeCompatPackageName :: MungedPackageName -> (PackageName, Maybe UnqualComponentName)

# Documentation

data MungedPackageName #

A combination of a package and component name used in various legacy interfaces, chiefly bundled with a version as `MungedPackageId`. It's generally better to use a `UnitId` to opaquely refer to some compilation/packing unit, but that doesn't always work, e.g. where a "name" is needed, in which case this can be used as a fallback.

Use `mkMungedPackageName` and `unMungedPackageName` to convert from/to a `String`.

Since: 2.0.0.2

Instances

Eq MungedPackageName # |
Methods (==) :: MungedPackageName -> MungedPackageName -> Bool # (/=) :: MungedPackageName -> MungedPackageName -> Bool #
Data MungedPackageName # |

Methods

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

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

toConstr :: MungedPackageName -> Constr Source #

dataTypeOf :: MungedPackageName -> DataType Source #

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

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

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

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

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

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

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

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

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

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

Ord MungedPackageName # |

Methods

compare :: MungedPackageName -> MungedPackageName -> Ordering #

(<) :: MungedPackageName -> MungedPackageName -> Bool #

(<=) :: MungedPackageName -> MungedPackageName -> Bool #

(>) :: MungedPackageName -> MungedPackageName -> Bool #

(>=) :: MungedPackageName -> MungedPackageName -> Bool #

max :: MungedPackageName -> MungedPackageName -> MungedPackageName #

min :: MungedPackageName -> MungedPackageName -> MungedPackageName #

Read MungedPackageName # |
Methods readsPrec :: Int -> ReadS MungedPackageName Source # readList :: ReadS [MungedPackageName] Source # readPrec :: ReadPrec MungedPackageName Source # readListPrec :: ReadPrec [MungedPackageName] Source #
Show MungedPackageName # |
Methods showsPrec :: Int -> MungedPackageName -> ShowS Source # show :: MungedPackageName -> String Source # showList :: [MungedPackageName] -> ShowS Source #
IsString MungedPackageName # | `mkMungedPackageName` Since: 2.0.0.2
Methods fromString :: String -> MungedPackageName Source #
Generic MungedPackageName # |
Associated Types type Rep MungedPackageName :: * -> * Source # Methods from :: MungedPackageName -> Rep MungedPackageName x Source # to :: Rep MungedPackageName x -> MungedPackageName Source #
NFData MungedPackageName # |
Methods rnf :: MungedPackageName -> () Source #
Binary MungedPackageName # |
Methods put :: MungedPackageName -> Put Source # get :: Get MungedPackageName Source # putList :: [MungedPackageName] -> Put Source #
Text MungedPackageName # |
Methods disp :: MungedPackageName -> Doc # parse :: ReadP r MungedPackageName #
type Rep MungedPackageName # |
type Rep MungedPackageName = D1 * (MetaData "MungedPackageName" "Distribution.Types.MungedPackageName" "Cabal-2.0.1.0" True) (C1 * (MetaCons "MungedPackageName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ShortText)))

unMungedPackageName :: MungedPackageName -> String #

Convert `MungedPackageName` to `String`

mkMungedPackageName :: String -> MungedPackageName #

Construct a `MungedPackageName` from a `String`

`mkMungedPackageName` is the inverse to `unMungedPackageName`

Note: No validations are performed to ensure that the resulting `MungedPackageName` is valid

Since: 2.0.0.2

computeCompatPackageName :: PackageName -> Maybe UnqualComponentName -> MungedPackageName #

Computes the package name for a library. If this is the public library, it will just be the original package name; otherwise, it will be a munged package name recording the original package name as well as the name of the internal library.

A lot of tooling in the Haskell ecosystem assumes that if something is installed to the package database with the package name `foo`, then it actually is an entry for the (only public) library in package `foo`. With internal packages, this is not necessarily true: a public library as well as arbitrarily many internal libraries may come from the same package. To prevent tools from getting confused in this case, the package name of these internal libraries is munged so that they do not conflict the public library proper. A particular case where this matters is ghc-pkg: if we don't munge the package name, the inplace registration will OVERRIDE a different internal library.

We munge into a reserved namespace, "z-", and encode both the component name and the package name of an internal library using the following format:

compat-pkg-name ::= "z-" package-name "-z-" library-name

where package-name and library-name have "-" ( "z" + ) "-" segments encoded by adding an extra "z".

When we have the public library, the compat-pkg-name is just the package-name, no surprises there!

decodeCompatPackageName :: MungedPackageName -> (PackageName, Maybe UnqualComponentName) #