Graphics.Web.Processing.Mid.CustomVar

This module implements variables which may contain values from types different from the native types (Proc_* types).

To make a type available to custom variables, it needs to be instantiated in the CustomValue class, which is subclass of the VarLength class. These instances are derivables using the DeriveGeneric extension. Things you need are: enable the DeriveGeneric language extension, import GHC.Generics, derive a Generic instance of your type and then write the following instances (where Foo is any type of interest):

 instance VarLength Foo
 instance CustomValue Foo

Note that Foo must be made from other types that are instances of CustomValue. Also, note that instances of VarLength or CustomValue can not be recursive or sum types. An example:

 {-# LANGUAGE DeriveGeneric #-}

 import Graphics.Web.Processing.Mid
 import Graphics.Web.Processing.Mid.CustomVar
 import GHC.Generics

 data Point = Point Proc_Float Proc_Float
                deriving Generic

 instance VarLength Point
 instance CustomValue Point

Types instance of the CustomValue class can be contained by a special type of variables, called CustomVar (Custom Variable). Functions for custom variables are equal to the function for regular variables, except that they all end in C. For example, newVar is called newVarC for custom variables.

There are also arrays which may contain custom values. See CustomArrayVar.

The dependency of this module in several language extensions was the reason to make it separate from the rest of the mid interface where it belongs to. Somehow, it forces the user to use DeriveGeneric and import GHC.Generics to do something useful with it (more than use custom variables for tuples).

Documentation

data CustomVar a

Variable with custom values.

Instances

Generic (CustomVar a)

data CustomArrayVar a

Array variable of custom values.

customArraySize :: CustomArrayVar a -> Int

Size of the custom array.

class VarLength a where

Typeclass of values that can be stored in several native variables (Var).

Methods

varLength :: a -> Int

Calculate how many native variables are needed to store a value.

Instances

VarLength Proc_Text

VarLength Proc_Char

VarLength Proc_Image

VarLength Proc_Float

VarLength Proc_Int

VarLength Proc_Bool

(VarLength a, VarLength b) => VarLength (a, b)

(VarLength a, VarLength b, VarLength c) => VarLength (a, b, c)

class VarLength a => CustomValue a where

Typeclass of custom values, which can be stored in custom variables (CustomVar).

Methods

newVarC :: (Monad (m Preamble), ProcMonad m) => a -> m Preamble (CustomVar a)

Version of newVar for custom variables.

newArrayVarC :: (Monad (m Preamble), ProcMonad m) => [a] -> m Preamble (CustomArrayVar a)

Version of newArrayVar for custom variables.

readVarC :: (Monad (m c), ProcMonad m) => CustomVar a -> m c a

Version of readVar for custom variables.

writeVarC :: (Monad (m c), ProcMonad m) => CustomVar a -> a -> m c ()

Version of writeVar for custom variables.

ifC :: Proc_Bool -> a -> a -> a

Version of if_ for custom values.

Instances

CustomValue Proc_Text

CustomValue Proc_Char

CustomValue Proc_Image

CustomValue Proc_Float

CustomValue Proc_Int

CustomValue Proc_Bool

(CustomValue a, CustomValue b) => CustomValue (a, b)

(CustomValue a, CustomValue b, CustomValue c) => CustomValue (a, b, c)

readArrayVarC :: (ProcMonad m, Monad (m c), CustomValue a) => CustomArrayVar a -> Proc_Int -> m c a

Read a component of a custom array variable.

writeArrayVarC :: (ProcMonad m, Monad (m c), CustomValue a) => CustomArrayVar a -> Proc_Int -> a -> m c ()

Write a component of a custom array variable.