| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Text.ProtocolBuffers.Identifiers
Description
This modules colelct utility routines related to the different
incarnations of identifiers in the code. The basic identifier is
always ASCII, but because of the self generated DescriptorProto
data structures it is stored in Utf8 tagged lazy bytestrings.
An identifier is a non-empty ASCII string made of [a-zA-Z0-9_]
where the first character is never in [0-9].
A field is a mangled identifer that is a valid Haskell name that
begins with lower case, and which may have a single quote at the
end if needed to avoid a reserved word. These may also start with
'_', though just a "_" is mangled to "_'".
A 'module' is a mangled identifier that is a valid Haskell name that begins with upper case. These never have a single quote. A leading '_' is replaced with a leading U'_ to make a valid identifier.
- unull :: Utf8 -> Bool
- toString :: Utf8 -> String
- fromString :: String -> Utf8
- newtype IName a = IName {
- iName :: a
- newtype DIName a = DIName {
- diName :: a
- newtype FIName a = FIName {
- fiName :: a
- newtype MName a = MName {
- mName :: a
- newtype FMName a = FMName {
- fmName :: a
- data PMName a = PMName [MName a] (MName a)
- newtype FName a = FName {
- fName :: a
- newtype FFName a = FFName {
- ffName :: a
- data PFName a = PFName [MName a] (FName a)
- class Monoid a => Dotted a where
- class Mangle a b where
- mangle :: a -> b
- joinPM :: Dotted a => PMName a -> FMName a
- joinPF :: Dotted a => PFName a -> FFName a
- difi :: Dotted a => DIName a -> FIName a
- splitDI :: Dotted a => DIName a -> [IName a]
- splitFI :: Dotted a => FIName a -> [IName a]
- splitFM :: Dotted a => FMName a -> [MName a]
- checkDIString :: String -> Either String (Bool, [IName String])
- checkDIUtf8 :: Utf8 -> Either String (Bool, [IName Utf8])
- promoteDI :: Dotted a => IName a -> DIName a
- promoteFI :: Dotted a => IName a -> FIName a
- promoteFM :: Dotted a => MName a -> FMName a
- promoteFF :: Dotted a => FName a -> FFName a
- dotFM :: Dotted a => FMName a -> FMName a -> FMName a
- dotFF :: Dotted a => FMName a -> FFName a -> FFName a
- fqAppend :: Dotted a => FIName a -> [IName a] -> FIName a
Documentation
fromString :: String -> Utf8 Source
Contains one identifier name
Fully qualified identifier: repeated (. then identifier)
Contains one module name, non-empty
Full Haskell module name: MNames separated by ., ending with a module
Parsed Haskell name ending with MName. Good contructor to use.
Contains one field name, non-empty
Full Haskell field name: MNames separated by ., ending with a field
Parsed Haskell name ending with FName. Good constructor to use.
class Monoid a => Dotted a where Source
This is used to abstract over Utf8 and String. The important
entry point is validDI.
The mangle transformation has instances for several combiantions
of input and output. These allow one to construct the Haskell types
of MNameFMNamePMName and FNameFFNamePFName out of the protobuf
types INameDINameFIName. Currently, all the Haskell instances
are for the String base type.
Instances
| Mangle (FIName Utf8) (PFName String) | |
| Mangle (FIName Utf8) (PMName String) | |
| Mangle (DIName Utf8) (PFName String) | |
| Mangle (DIName Utf8) (PMName String) | |
| Mangle (FName String) (MName String) | |
| Mangle (MName String) (FName String) | |
| Mangle (IName String) (FName String) | |
| Mangle (IName String) (MName String) | |
| Mangle (IName Utf8) (FName String) | |
| Mangle (IName Utf8) (MName String) |
checkDIString :: String -> Either String (Bool, [IName String]) Source
Right (True,_) means the input is a FIName.
Right (False,_) means the input is a DIName (without leading .)
This creates useful error messages for the user.