Data.GI.CodeGen.ModulePath

Abstract representation for paths into modules.

Documentation

newtype ModulePath

A path to a module.

Constructors

ModulePath

Fields

• modulePathToList :: [Text]

Instances

Eq ModulePath

Methods

(==) :: ModulePath -> ModulePath -> Bool

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

Ord ModulePath

Methods

compare :: ModulePath -> ModulePath -> Ordering

(<) :: ModulePath -> ModulePath -> Bool

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

(>) :: ModulePath -> ModulePath -> Bool

(>=) :: ModulePath -> ModulePath -> Bool

max :: ModulePath -> ModulePath -> ModulePath

min :: ModulePath -> ModulePath -> ModulePath

Show ModulePath

Methods

showsPrec :: Int -> ModulePath -> ShowS

show :: ModulePath -> String

showList :: [ModulePath] -> ShowS

IsString ModulePath

Construct a ModulePath from a String.

Methods

fromString :: String -> ModulePath

Semigroup ModulePath

Methods

(<>) :: ModulePath -> ModulePath -> ModulePath

sconcat :: NonEmpty ModulePath -> ModulePath

stimes :: Integral b => b -> ModulePath -> ModulePath

Monoid ModulePath

Methods

mempty :: ModulePath

mappend :: ModulePath -> ModulePath -> ModulePath

mconcat :: [ModulePath] -> ModulePath

toModulePath :: Text -> ModulePath

Construct a path into the given GIR namespace. The given Text will be split along ".".

Examples

>>> dotModulePath (toModulePath "Foo")
"Foo"

>>> dotModulePath ("Foo" <> toModulePath "Bar.Baz")
"Foo.Bar.Baz"

>>> dotModulePath ("Foo" <> toModulePath "bar.baz")
"Foo.Bar.Baz"

(/.) :: ModulePath -> Text -> ModulePath

Append the given component to the given module path.

Examples

>>> dotModulePath ("Foo" /. "Bar")
"Foo.Bar"

dotModulePath :: ModulePath -> Text

Turn a module path into the corresponding dotted string. Note that the implementation ensures that the module names start with a capital letter.

Examples

>>> dotModulePath ("Foo" /. "Bar" /. "Baz")
"Foo.Bar.Baz"

>>> dotModulePath ("foo" /. "bar" /. "baz")
"Foo.Bar.Baz"