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


-- | Automatic disambiguation for extensible effects
--   
--   Please see the README on GitHub at
--   <a>https://github.com/re-xyr/cleff/tree/master/cleff-plugin#readme</a>
@package cleff-plugin
@version 0.1.0.0


module Cleff.Plugin.Internal

-- | <a>Plugin</a> is the compiler plugin data type. Try to avoid
--   constructing one of these directly, and just modify some fields of
--   <a>defaultPlugin</a> instead: this is to try and preserve source-code
--   compatibility when we add fields to this.
--   
--   Nonetheless, this API is preliminary and highly likely to change in
--   the future.
data Plugin

-- | A list of unique, unambiguous Haskell names in the format of
--   <tt>(packageName, moduleName, identifier)</tt>.
type Names = [(String, String, String)]

-- | Make a <tt>polysemy-plugin</tt>-style effect disambiguation plugin
--   that applies to all the "element-of" typeclasses passed in. Each of
--   the names passed in should have type <tt>k -&gt; [k] -&gt;
--   <a>Type</a></tt> where <tt>k</tt> can be either polymorphic or
--   monomorphic.
--   
--   Some examples include:
--   
--   <pre>
--   ("cleff", "Cleff.Internal.Rec", ":&gt;")
--   ("polysemy", "Polysemy.Internal.Union", "Member")
--   ("effectful", "Effectful.Internal.Effect", ":&gt;")
--   </pre>
--   
--   You can see the source code for notes on the implementation of the
--   plugin.
makePlugin :: Names -> Plugin
instance GHC.Classes.Eq Cleff.Plugin.Internal.OrdType
instance GHC.Classes.Ord Cleff.Plugin.Internal.OrdType
instance GHC.Show.Show Cleff.Plugin.Internal.FakedepWanted
instance GHC.Show.Show Cleff.Plugin.Internal.FakedepGiven


module Cleff.Plugin

-- | The GHC typechecker plugin that disambiguates trivial uses of
--   <tt>cleff</tt> effects. Refer to the README for more info.
plugin :: Plugin