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


-- | Object-oriented programming with singleton methods
and duck typing.
--   
--   This package provides Object-oriented programming found in
--   dynamically-typed languages such as python or ruby.
--   
--   <tt>Object</tt> is implemented as <tt>Map</tt> from method keys to
--   values. Different keys can have different value types
@package dynamic-object
@version 0.1.0.0

module Data.Object.Dynamic.Types

-- | A basic object type that can contain values of different types.
newtype Object
Object :: (Map TypeRep Dynamic) -> Object
class Typeable a => KeyType a where type family ValType a :: *

-- | A Type synonym for a <a>Member</a> <a>Lens</a>.
type Member kt = Lens Object Object (Maybe (ValType kt)) (Maybe (ValType kt))

-- | an empty <a>Object</a> .
--   
--   <pre>
--   &gt;&gt;&gt; empty
--   Object []
--   </pre>
empty :: Object

-- | Given a key type, create a <a>Member</a> <a>Lens</a> labeled by the
--   key. Here's an example of creating a price tag for objects.
--   
--   <pre>
--   &gt;&gt;&gt; data Price = Price deriving (Show, Typeable)
--   
--   &gt;&gt;&gt; instance KeyType Price where type ValType Price = Integer
--   
--   &gt;&gt;&gt; let price :: Member Price; price = mkMember Price;
--   
--   &gt;&gt;&gt; let x = set price (Just 120) empty
--   
--   &gt;&gt;&gt; view price empty
--   Nothing
--   
--   &gt;&gt;&gt; view price x
--   Just 120
--   </pre>
mkMember :: (KeyType kt, Typeable (ValType kt)) => kt -> Member kt

-- | Create a <a>Member</a> <a>Lens</a> with a default value. Here's a
--   price tag for objects with default value.
--   
--   <pre>
--   &gt;&gt;&gt; data Price = Price deriving (Show, Typeable)
--   
--   &gt;&gt;&gt; instance KeyType Price where type ValType Price = Integer
--   
--   &gt;&gt;&gt; let price :: Member Price; price = mkMemberWithDef Price 10;
--   
--   &gt;&gt;&gt; let x = set price (Just 120) empty
--   
--   &gt;&gt;&gt; view price empty
--   Just 10
--   
--   &gt;&gt;&gt; view price x
--   Just 120
--   </pre>
mkMemberWithDef :: (KeyType kt, Typeable (ValType kt)) => kt -> ValType kt -> Member kt
instance Typeable Object
instance Show Object

module Data.Object.Dynamic

-- | A basic object type that can contain values of different types.
data Object

-- | an empty <a>Object</a> .
--   
--   <pre>
--   &gt;&gt;&gt; empty
--   Object []
--   </pre>
empty :: Object