Distribution.Types.ModuleRenaming · Cabal-syntax-3.16.0.0

datadata ModuleRenaming

Renaming applied to the modules provided by a package. The boolean indicates whether or not to also include all of the original names of modules. Thus, ModuleRenaming False [] is "don't expose any modules, and ModuleRenaming True [(Data.Bool, Bool)] is, "expose all modules, but also expose Data.Bool as Bool". If a renaming is omitted you get the DefaultRenaming.

(NB: This is a list not a map so that we can preserve order.)

Constructors

ModuleRenaming [(ModuleName, ModuleName)]
A module renaming/thinning; e.g., (A as B, C as C) brings B and C into scope.
DefaultRenaming
The default renaming, bringing all exported modules into scope.
HidingRenaming [ModuleName]
Hiding renaming, e.g., hiding (A, B), bringing all exported modules into scope except the hidden ones.

Instances12Eq, Data, Ord, Read, Show, Generic, …

Eq ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Data ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Ord ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Read ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Show ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Generic ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
NFData ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Binary ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Parsec ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Pretty ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
Structured ModuleRenamingDefined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming
type Rep ModuleRenaming = D1 ('MetaData "ModuleRenaming" "Distribution.Types.ModuleRenaming" "Cabal-syntax-3.16.0.0-c954" 'False) (C1 ('MetaCons "ModuleRenaming" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ModuleName, ModuleName)])) :+: (C1 ('MetaCons "DefaultRenaming" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HidingRenaming" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]))))Defined in Cabal-syntax-3.16.0.0 · Distribution.Types.ModuleRenaming

valueinterpModuleRenaming :: ModuleRenaming -> ModuleName -> Maybe ModuleName

#

Interpret a ModuleRenaming as a partial map from ModuleName to ModuleName. For efficiency, you should partially apply it with ModuleRenaming and then reuse it.

valuedefaultRenaming :: ModuleRenaming

#

The default renaming, if something is specified in build-depends only.

valueisDefaultRenaming :: ModuleRenaming -> Bool

#

Tests if its the default renaming; we can use a more compact syntax in IncludeRenaming in this case.