Safe Haskell	Safe-Inferred
Language	Haskell2010

Sketch.FRP.Copilot.Internals

Synopsis

getTriggerLimit :: TriggerLimit -> Behavior Bool
addTriggerLimit :: TriggerLimit -> Behavior Bool -> Behavior Bool
getUniqueId :: String -> GenSketch ctx UniqueId
uniqueName :: String -> UniqueId -> String
uniqueName' :: String -> UniqueId -> String
emptyFramework :: Context ctx => GenFramework ctx
mkCChunk :: [CLine] -> [CChunk]
defineTriggerAlias :: String -> GenFramework ctx -> GenSketch ctx (GenFramework ctx, String)
defineTriggerAlias' :: String -> String -> GenFramework ctx -> GenSketch ctx (GenFramework ctx, String)
data MkInputSource ctx t = InputSource {
- defineVar :: [CChunk]
- setupInput :: [CChunk]
- inputPinmode :: Map ctx PinMode
- readInput :: [CChunk]
- inputStream :: Stream t
}
mkInput :: MkInputSource ctx t -> GenSketch ctx (Behavior t)
evalSketch :: Context ctx => GenSketch ctx a -> (Maybe Spec, GenFramework ctx)
sketchSpec :: Context ctx => GenSketch ctx a -> Spec

Documentation

getTriggerLimit :: TriggerLimit -> Behavior Bool Source #

addTriggerLimit :: TriggerLimit -> Behavior Bool -> Behavior Bool Source #

getUniqueId :: String -> GenSketch ctx UniqueId Source #

Gets a unique id.

uniqueName :: String -> UniqueId -> String Source #

Generates a unique name.

uniqueName' :: String -> UniqueId -> String Source #

emptyFramework :: Context ctx => GenFramework ctx Source #

Use to create an empty framework.

It helps to specify the type of context to use:

(emptyFramework @Arduino) { ... }

mkCChunk :: [CLine] -> [CChunk] Source #

defineTriggerAlias :: String -> GenFramework ctx -> GenSketch ctx (GenFramework ctx, String) Source #

Copilot only supports calling a trigger with a given name once per Spec; the generated C code will fail to build if the same name is used in two triggers. This generates a unique alias that can be used in a trigger.

defineTriggerAlias' :: String -> String -> GenFramework ctx -> GenSketch ctx (GenFramework ctx, String) Source #

data MkInputSource ctx t Source #

Constructors

InputSource

Fields

defineVar :: [CChunk]
Added to the Framework's defines, this typically defines a C variable.
setupInput :: [CChunk]
How to set up the input, not including pin mode.
inputPinmode :: Map ctx PinMode
How pins are used by the input.
readInput :: [CChunk]
How to read a value from the input, this typically reads a value into a C variable.
inputStream :: Stream t
How to use Copilot's extern to access the input values.

mkInput :: MkInputSource ctx t -> GenSketch ctx (Behavior t) Source #

evalSketch :: Context ctx => GenSketch ctx a -> (Maybe Spec, GenFramework ctx) Source #

sketchSpec :: Context ctx => GenSketch ctx a -> Spec Source #

Extracts a copilot Spec from a Sketch.

This can be useful to intergrate with other libraries such as copilot-theorem.