System.Win32.Com.Dll

Support for sealing up Haskell code as an in-proc COM server.

The main function is createIComDll which packages up a list of ComponentInfo values specifying the Haskell implementation of COM objects. It returns a method table which you can then wrap up as a DLL by calling its COM-mandated entry points via.

Documentation

data ComponentInfo

The information an implementation of a Haskell COM component needs to supply in order to hook into the machinery provided by System.Win32.Com.Dll for interfacing to how COM does activation for in-proc components

To create one or more, you pass them into createIComDll..

Constructors

ComponentInfo

Fields

• newInstance :: ComponentFactory

  the object factory method.

• componentFinalise :: IO ()

  IO action to call when the

• componentName :: String

  the display name.

• componentProgID :: String

  the programmatic/VB ID string (versioned, if needed.)

• componentVProgID :: String

  and without version info.

• componentTLB :: Bool

  True if backed by a TLB.

• registerComponent :: ComponentInfo -> String -> Bool -> IO ()

  action to run when (un)registering this component.

• componentCLSID :: CLSID

  the CLSID; required, of course.

mkComponentInfo :: CLSID -> (String -> Bool -> IO ()) -> (String -> IO () -> IID (IUnknown ()) -> IO (IUnknown ())) -> ComponentInfo

The mkComponentInfo used to lessen the reliance on concrete representation of ComponentInfo.

withComponentName :: String -> ComponentInfo -> ComponentInfo

withComponentName nm ci returns a new ComponentInfo based on ci, but with its name set to nm.

withProgID :: String -> ComponentInfo -> ComponentInfo

withProgID p ci returns a new ComponentInfo based on ci, but with ProgID set to p.

withVerIndepProgID :: String -> ComponentInfo -> ComponentInfo

withVerProgID vp ci returns a new ComponentInfo based on ci, but with version-independent ProgID set to vp.

onRegister :: (ComponentInfo -> String -> Bool -> IO ()) -> ComponentInfo -> ComponentInfo

onRegister act ci returns a new ComponentInfo based on ci, but with the (un)registration action extended with act.

onFinalize :: IO () -> ComponentInfo -> ComponentInfo

onFinalize act ci returns a new ComponentInfo based on ci, but with the finalization action extended with act.

hasTypeLib :: ComponentInfo -> ComponentInfo

hasTypeLib ci returns a new ComponentInfo based on ci, but being type library backed.

createIComDll :: Ptr () -> [ComponentInfo] -> IO (VTable iid_comDllState ComDllState)

createIComDll hMod cis creates the method table for an inproc server supporting the components specified by cis. The method table would then be wrapped up by a Haskell DLL wrapper supporting the in-proc DLL entry points.

regAddEntry :: RegHive -> String -> Maybe String -> IO ()

regAddEntry hive path val is a convenient local wrapper to the Win32 API function RegAddEntry().

regRemoveEntry :: RegHive -> String -> String -> Bool -> IO ()

regRemoveEntry hive path val doRemove is a convenient local wrapper to the Win32 API function RegRemoveEntry().

data RegHive

Constructors

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Instances

Enum RegHive

Defined in System.Win32.Com.Dll

Methods

succ :: RegHive -> RegHive

pred :: RegHive -> RegHive

toEnum :: Int -> RegHive

fromEnum :: RegHive -> Int

enumFrom :: RegHive -> [RegHive]

enumFromThen :: RegHive -> RegHive -> [RegHive]

enumFromTo :: RegHive -> RegHive -> [RegHive]

enumFromThenTo :: RegHive -> RegHive -> RegHive -> [RegHive]

Eq RegHive

Defined in System.Win32.Com.Dll

Methods

(==) :: RegHive -> RegHive -> Bool

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

Ord RegHive

Defined in System.Win32.Com.Dll

Methods

compare :: RegHive -> RegHive -> Ordering

(<) :: RegHive -> RegHive -> Bool

(<=) :: RegHive -> RegHive -> Bool

(>) :: RegHive -> RegHive -> Bool

(>=) :: RegHive -> RegHive -> Bool

max :: RegHive -> RegHive -> RegHive

min :: RegHive -> RegHive -> RegHive

stdRegComponent :: ComponentInfo -> Bool -> String -> IO ()

stdUnRegComponent :: ComponentInfo -> Bool -> String -> IO ()

type ComponentFactory = String -> IO () -> IID (IUnknown ()) -> IO (IUnknown ())

(( path final iid -> IO obj)::ComponentFactory is the component-specific object factory method:

• path is the path to the DLL implementing the component (useful for TLB lookup etc.)
• final is finalization action for the object.
• iid is the IID to create object at.
• obj is the newly created object at interface iid.