Data.Emacs.Module.SymbolName

Documentation

data SymbolName

Instances

IsString SymbolName

Defined in Data.Emacs.Module.SymbolName.Internal

Methods

fromString :: String -> SymbolName

Show SymbolName

Defined in Data.Emacs.Module.SymbolName.Internal

Methods

showsPrec :: Int -> SymbolName -> ShowS

show :: SymbolName -> String

showList :: [SymbolName] -> ShowS

Eq SymbolName

Defined in Data.Emacs.Module.SymbolName.Internal

Methods

(==) :: SymbolName -> SymbolName -> Bool

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

Pretty SymbolName

Defined in Data.Emacs.Module.SymbolName.Internal

Methods

pretty :: SymbolName -> Doc ann

prettyList :: [SymbolName] -> Doc ann

mkSymbolName :: Text -> SymbolName

mkSymbolNameString :: String -> SymbolName

mkSymbolNameShortByteString :: ShortByteString -> SymbolName

mkSymbolNameUnsafe :: Addr# -> SymbolName

Should be applied to unboxed string literals like this

mkSymbolNameUnsafe "foo"#

Can be safely applied to non-literals (e.g. arbitrary pointers) if it's guaranteed that address points to a null-terminated strings. Otherwise behaviour is undefined.

The string literal must only contain ASCII symbols. This condition is required by the Emacs API and results in undefined behaviour if violated.

reifySymbol :: WithCallStack => Env -> SymbolName -> (RawValue 'Regular -> a) -> (RawValue 'Pinned -> a) -> IO a