ddc-core-salt-0.3.1.1: Disciplined Disciple Compiler C code generator.

Safe HaskellNone

DDC.Core.Salt.Name

Contents

Description

Names used in the Disciple Core Salt language profile.

Synopsis

Documentation

data Name Source

Names of things used in Disciple Core Salt.

Constructors

NameVar String

A type or value variable.

NameCon String

Constructor names.

NameObjTyCon

The abstract heap object type constructor.

NamePrimTyCon PrimTyCon

A primitive type constructor.

NamePrimOp PrimOp

A primitive operator.

NameLitVoid

The void literal.

NameLitBool Bool

A boolean literal.

NameLitNat Integer

A natural number literal.

NameLitInt Integer

An integer number literal.

NameLitTag Integer

A constructor tag literal.

NameLitWord Integer Int

A WordN# literal, of the given width.

Primitive Type Constructors

data PrimTyCon Source

Primitive type constructors.

Constructors

PrimTyConVoid

Void# the Void type has no values.

PrimTyConBool

Bool# unboxed booleans.

PrimTyConNat

Nat# natural numbers. Big enough to count every addressable byte in the store.

PrimTyConInt

Int# signed integers.

PrimTyConWord Int

WordN# machine words of the given width.

PrimTyConFloat Int

FloatN# floating point numbers of the given width.

PrimTyConTag

Tag# data constructor tags.

PrimTyConAddr

Addr# raw machine addresses. Unlike pointers below, a raw Addr# need not to refer to memory owned by the current process.

PrimTyConPtr

Ptr# should point to a well-formed object owned by the current process.

PrimTyConString

String# of UTF8 characters.

These are primitive until we can define our own unboxed types.

primTyConIsIntegral :: PrimTyCon -> BoolSource

Integral constructors are the ones that we can reasonably convert from integers of the same size.

These are Bool Int and Tag#.

primTyConIsFloating :: PrimTyCon -> BoolSource

Floating point constructors.

These are FloatN.

primTyConIsUnsigned :: PrimTyCon -> BoolSource

Unsigned integral constructors.

These are Bool Nat WordN Tag.

primTyConIsSigned :: PrimTyCon -> BoolSource

Signed integral constructors.

This is just Int.

primTyConWidth :: Platform -> PrimTyCon -> Maybe IntegerSource

Get the representation width of a primitive type constructor, in bits. This is how much space it takes up in an object payload.

Bools are representable with a single bit, but we unpack them into a whole word.

The abstract constructors Void and String have no width.

Primitive Operators

data PrimOp Source

Primitive operators implemented directly by the machine or runtime system.

Constructors

PrimArith PrimArith

Arithmetic, logic, comparison and bit-wise operators.

PrimCast PrimCast

Casting between numeric types.

PrimStore PrimStore

Raw store access.

PrimCall PrimCall

Special function calling conventions.

PrimControl PrimControl

Non-functional control flow.

data PrimArith Source

Primitive arithmetic, logic, and comparison opretors. We expect the backend/machine to be able to implement these directly.

For the Shift Right operator, the type that it is used at determines whether it is an arithmetic (with sign-extension) or logical (no sign-extension) shift.

Constructors

PrimArithNeg

Negation

PrimArithAdd

Addition

PrimArithSub

Subtraction

PrimArithMul

Multiplication

PrimArithDiv

Division

PrimArithRem

Remainder

PrimArithEq

Equality

PrimArithNeq

Negated Equality

PrimArithGt

Greater Than

PrimArithGe

Greater Than or Equal

PrimArithLt

Less Than

PrimArithLe

Less Than or Equal

PrimArithAnd

Boolean And

PrimArithOr

Boolean Or

PrimArithShl

Shift Left

PrimArithShr

Shift Right

PrimArithBAnd

Bit-wise And

PrimArithBOr

Bit-wise Or

PrimArithBXOr

Bit-wise eXclusive Or

data PrimCast Source

Primitive cast between two types.

The exact set of available casts is determined by the target platform. For example, you can only promote a Nat# to a Word32# on a 32-bit system. On a 64-bit system the Nat# type is 64-bits wide, so casting it to a Word32# would be a truncation.

Constructors

PrimCastPromote

Promote a value to one of similar or larger width, without loss of precision.

PrimCastTruncate

Truncate a value to a new width, possibly losing precision.

primCastPromoteIsValidSource

Arguments

:: Platform

Target platform.

-> PrimTyCon

Source type.

-> PrimTyCon

Destination type.

-> Bool 

Check for a valid promotion primop.

primCastTruncateIsValidSource

Arguments

:: Platform

Target platform.

-> PrimTyCon

Source type.

-> PrimTyCon

Destination type.

-> Bool 

Check for valid truncation primop.

data PrimStore Source

Raw access to the store.

Constructors

PrimStoreSize

Number of bytes needed to store a value of a primitive type.

PrimStoreSize2

Log2 of number of bytes need to store a value of a primitive type.

PrimStoreCreate

Create a heap of the given size. This must be called before alloc# below, and has global side effect. Calling it twice in the same program is undefined.

PrimStoreCheck

Check whether there are at least this many bytes still available on the heap.

PrimStoreRecover

Force a garbage collection to recover at least this many bytes.

PrimStoreAlloc

Allocate some space on the heap. There must be enough space available, else undefined.

PrimStoreRead

Read a value from the store at the given address and offset.

PrimStoreWrite

Write a value to the store at the given address and offset.

PrimStorePlusAddr

Add an offset in bytes to an address.

PrimStoreMinusAddr

Subtract an offset in bytes from an address.

PrimStorePeek

Read a value from a pointer plus the given offset.

PrimStorePoke

Write a value to a pointer plus the given offset.

PrimStorePlusPtr

Add an offset in bytes to a pointer.

PrimStoreMinusPtr

Subtract an offset in bytes from a pointer.

PrimStoreMakePtr

Convert an raw address to a pointer.

PrimStoreTakePtr

Convert a pointer to a raw address.

PrimStoreCastPtr

Cast between pointer types.

data PrimCall Source

Primitive ways of invoking a function, where control flow returns back to the caller.

Constructors

PrimCallTail Int

Tailcall a function

data PrimControl Source

Primitive non-returning control flow.

Constructors

PrimControlFail

Ungraceful failure -- just abort the program. This is called on internal errors in the runtime system. There is no further debugging info provided, so you'll need to look at the stack trace to debug it.

PrimControlReturn

Return from the enclosing function with the given value.

Name Parsing

readName :: String -> Maybe NameSource

Read the name of a variable, constructor or literal.

Name Sanitisation

sanitizeName :: String -> StringSource

Rewrite the symbols in a name to make it safe to export as an external symbol. For example, a names containing a & is prefixed with _sym_ and the & replzced by ZAn. Literal Zs in a symbolic name are doubled to ZZ.

sanitizeGlobal :: String -> StringSource

Like sanitizeGlobal but indicate that the name is going to be visible globally.

sanitizeLocal :: String -> StringSource

Like sanitizeName but at add an extra '_' prefix. This is used for function-local names so that they do not conflict with globally-visible ones.