-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Bindings for C++ demangling routines
--   
--   Please see the README on Github at
--   <a>https://github.com/0xd34df00d/cppfilt#readme</a>
@package cppfilt
@version 0.1.0.0


-- | This module provides the type class (and a few implementations) for
--   values that can be efficiently converted to/from <a>CString</a>.
--   Instances for <a>String</a> and strict <a>ByteString</a> are provided,
--   and the use of <a>ByteString</a> is recommended if performance is a
--   concern.
module Data.CStringRepresentable

-- | Represents values that can be efficiently converted to and from
--   <a>CString</a>s.
class CStringRepresentable a

-- | Perform a function on the <a>CString</a> representation of the value.
toCString :: CStringRepresentable a => a -> (CString -> IO b) -> IO b

-- | Convert <a>CString</a> to a value of the type. The ownership is not
--   transferred.
fromCString :: CStringRepresentable a => CString -> IO a

-- | <a>String</a>s can be represented as <a>CString</a>s (albeit
--   conversions are inefficient).

-- | <a>ByteString</a>s can be represented as <a>CString</a>s.
instance Data.CStringRepresentable.CStringRepresentable GHC.Base.String
instance Data.CStringRepresentable.CStringRepresentable Data.ByteString.Internal.ByteString


-- | This module provides bindings to the platform C++ ABI demangling
--   routines (where the platform is currently limited to gcc). Any
--   string-like type implementing <a>CStringRepresentable</a> can be used,
--   though strict bytestrings are the most performant.
--   
--   This module provides the raw <a>IO</a>-living functions. Thin wrappers
--   pretending to be pure live in the <a>System.Demangle.Pure</a> module.
module System.Demangle

-- | Try to demangle a mangled C++ name.
demangle :: CStringRepresentable s => s -> IO (Maybe s)


-- | This module provides bindings to the platform C++ ABI demangling
--   routines (where the platform is currently limited to gcc). Any
--   string-like type implementing <a>CStringRepresentable</a> can be used,
--   though strict bytestrings are the most performant.
--   
--   This module provides the pure-ish functions which hide the intrinsic
--   <a>IO</a> nature of doing FFI calls behind <a>unsafePerformIO</a>.
--   Demangling is referentially transparent, though, so that should be
--   fine.
module System.Demangle.Pure

-- | Try to demangle a mangled C++ name.
demangle :: CStringRepresentable s => s -> Maybe s