Feldspar.Run.Frontend

Monad for running Feldspar programs

Documentation

data Run a

Monad for running Feldspar programs

Instances

Monad Run

Methods

(>>=) :: Run a -> (a -> Run b) -> Run b

(>>) :: Run a -> Run b -> Run b

return :: a -> Run a

fail :: String -> Run a

Functor Run

Methods

fmap :: (a -> b) -> Run a -> Run b

(<$) :: a -> Run b -> Run a

Applicative Run

Methods

pure :: a -> Run a

(<*>) :: Run (a -> b) -> Run a -> Run b

(*>) :: Run a -> Run b -> Run b

(<*) :: Run a -> Run b -> Run a

MonadComp Run

Methods

liftComp :: Comp a -> Run a

iff :: Data Bool -> Run () -> Run () -> Run ()

for :: (Integral n, PrimType n) => IxRange (Data n) -> (Data n -> Run ()) -> Run ()

while :: Run (Data Bool) -> Run () -> Run ()

MonadRun Run

Methods

liftRun :: Run a -> Run a

(~) * a () => PrintfType (Run a)

Methods

fprf :: Handle -> String -> [PrintfArg Data] -> Run a

class Monad m => MonadRun m where

Minimal complete definition

liftRun

Methods

liftRun :: m a -> Run a

Instances

MonadRun Comp

Methods

liftRun :: Comp a -> Run a

MonadRun Run

Methods

liftRun :: Run a -> Run a

Pointer operations

unsafeSwap :: IsPointer a => a -> a -> Run ()

Swap two pointers

This is generally an unsafe operation. E.g. it can be used to make a reference to a data structure escape the scope of the data.

The IsPointer class ensures that the operation is only possible for types that are represented as pointers in C.

unsafeSwapArr :: Arr a -> Arr a -> Run ()

Like unsafeSwap but for arrays. The why we cannot use unsafeSwap directly is that Arr cannot be made an instance of IsPointer.

File handling

fopen :: FilePath -> IOMode -> Run Handle

Open a file

fclose :: Handle -> Run ()

Close a file

feof :: Handle -> Run (Data Bool)

Check for end of file

class PrintfType r where

Minimal complete definition

fprf

Methods

fprf :: Handle -> String -> [PrintfArg Data] -> r

Instances

(~) * a () => PrintfType (Run a)

Methods

fprf :: Handle -> String -> [PrintfArg Data] -> Run a

(Formattable a, PrimType a, PrintfType r) => PrintfType (Data a -> r)

Methods

fprf :: Handle -> String -> [PrintfArg Data] -> Data a -> r

fprintf :: PrintfType r => Handle -> String -> r

Print to a handle. Accepts a variable number of arguments.

fput :: (Formattable a, PrimType a) => Handle -> String -> Data a -> String -> Run ()

Put a primitive value to a handle

fget :: (Formattable a, PrimType a) => Handle -> Run (Data a)

Get a primitive value from a handle

printf :: PrintfType r => String -> r

Print to stdout. Accepts a variable number of arguments.

C-specific commands

newPtr :: PrimType a => Run (Ptr a)

Create a null pointer

newNamedPtr

Arguments

:: PrimType a

=> String

Base name

-> Run (Ptr a)

Create a named null pointer

The provided base name may be appended with a unique identifier to avoid name collisions.

ptrToArr :: PrimType a => Ptr a -> Data Length -> Run (DArr a)

Cast a pointer to an array

newObject

Arguments

:: String

Object type

-> Bool

Pointed?

-> Run Object

Create a pointer to an abstract object. The only thing one can do with such objects is to pass them to callFun or callProc.

newNamedObject

Arguments

:: String

Base name

-> String

Object type

-> Bool

Pointed?

-> Run Object

Create a pointer to an abstract object. The only thing one can do with such objects is to pass them to callFun or callProc.

The provided base name may be appended with a unique identifier to avoid name collisions.

addInclude :: String -> Run ()

Add an #include statement to the generated code

addDefinition :: Definition -> Run ()

Add a global definition to the generated code

Can be used conveniently as follows:

{-# LANGUAGE QuasiQuotes #-}

import Feldspar.IO

prog = do
    ...
    addDefinition myCFunction
    ...
  where
    myCFunction = [cedecl|
      void my_C_function( ... )
      {
          // C code
          // goes here
      }
      |]

addExternFun

Arguments

:: PrimType res

=> String

Function name

-> proxy res

Proxy for expression and result type

-> [FunArg Data PrimType']

Arguments (only used to determine types)

-> Run ()

Declare an external function

addExternProc

Arguments

:: String

Procedure name

-> [FunArg Data PrimType']

Arguments (only used to determine types)

-> Run ()

Declare an external procedure

callFun

Arguments

:: PrimType a

=> String

Function name

-> [FunArg Data PrimType']

Arguments

-> Run (Data a)

Call a function

callProc

Arguments

:: String

Function name

-> [FunArg Data PrimType']

Arguments

-> Run ()

Call a procedure

callProcAssign

Arguments

:: Assignable obj

=> obj

Object to which the result should be assigned

-> String

Procedure name

-> [FunArg Data PrimType']

Arguments

-> Run ()

Call a procedure and assign its result

externFun

Arguments

:: PrimType res

=> String

Procedure name

-> [FunArg Data PrimType']

Arguments

-> Run (Data res)

Declare and call an external function

externProc

Arguments

:: String

Procedure name

-> [FunArg Data PrimType']

Arguments

-> Run ()

Declare and call an external procedure

inModule :: String -> Run () -> Run ()

Generate code into another translation unit

getTime :: Run (Data Double)

Get current time as number of seconds passed today

strArg :: String -> FunArg Data PrimType'

Constant string argument

valArg :: PrimType' a => Data a -> FunArg Data PrimType'

Value argument

refArg :: PrimType' (Internal a) => Ref a -> FunArg Data PrimType'

Reference argument

arrArg :: PrimType' (Internal a) => Arr a -> FunArg Data PrimType'

Mutable array argument

iarrArg :: PrimType' (Internal a) => IArr a -> FunArg Data PrimType'

Immutable array argument

objArg :: Object -> FunArg Data PrimType'

Abstract object argument

constArg

Arguments

:: String

Type

-> String

Named constant

-> FunArg Data PrimType'

Named constant argument

addr :: FunArg Data PrimType' -> FunArg Data PrimType'

Modifier that takes the address of another argument

deref :: FunArg Data PrimType' -> FunArg Data PrimType'

Modifier that dereferences another argument

module Language.Embedded.Imperative.Frontend.General