Create an uninitialized reference

Create an uninitialized named reference

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

Create an initialized reference

Create an initialized named reference

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

Get the contents of a reference

Set the contents of a reference

Modify the contents of reference

Freeze the contents of reference (only safe if the reference is not updated as long as the resulting value is alive)

Read the value of a reference without returning in the monad

WARNING: Don't use this function unless you really know what you are doing. It is almost always better to use unsafeFreezeRef instead.

veryUnsafeFreezeRef behaves predictably when doing code generation, but it can give strange results when running in IO, as explained here:

http://fun-discoveries.blogspot.se/2015/09/strictness-can-fix-non-termination.html

Create an uninitialized array

Create an uninitialized named array

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

Create an array and initialize it with a constant list

Create a named array and initialize it with a constant list

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

Get an element of an array

Set an element of an array

Copy the contents of an array to another array. The number of elements to copy must not be greater than the number of allocated elements in either array.

Freeze a mutable array to an immutable one. This involves copying the array to a newly allocated one.

Freeze a mutable array to an immutable one without making a copy. This is generally only safe if the the mutable array is not updated as long as the immutable array is alive.

Thaw an immutable array to a mutable one. This involves copying the array to a newly allocated one.

Thaw an immutable array to a mutable one without making a copy. This is generally only safe if the the mutable array is not updated as long as the immutable array is alive.

Conditional statement

Conditional statement that returns an expression

While loop

For loop

Break out from a loop

Assertion

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.

Open a file

Close a file

Check for end of file

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

Put a single value to a handle

Get a single value from a handle

Print to stdout. Accepts a variable number of arguments.

Create a null pointer

Create a named null pointer

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

Cast a pointer to an array

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

Create a pointer to a named 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.

Add an #include statement to the generated code

Add a global definition to the generated code

Can be used conveniently as follows:

{-# LANGUAGE QuasiQuotes #-}

import Language.Embedded.Imperative
import Language.C.Quote.C

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

Declare an external function

Declare an external procedure

Call a function

Call a procedure

Call a procedure and assign its result

Declare and call an external function

Declare and call an external procedure

Generate code into another translation unit

Get current time as number of seconds passed today

Value argument

Reference argument

Mutable array argument

Immutable array argument

Pointer argument

Abstract object argument

Constant string argument

Named constant argument

Modifier that takes the address of another argument

Modifier that dereferences another argument

Add an offset to another argument

Run a program in IO. Note that not all instructions are supported for running in IO. For example, calls to external C functions are not supported.

Like runIO but with explicit inputoutput connected to stdinstdout