Foreign.R.Internal

Low-level bindings to core R datatypes and functions which depend on computing offsets of C struct field. We use hsc2hs for this purpose.

Documentation

newtype SEXP s (a :: SEXPTYPE)

The basic type of all R expressions, classified by the form of the expression, and the memory region in which it has been allocated.

Constructors

SEXP

Fields

• unSEXP :: Ptr (HExp s a)

Instances

Eq (SEXP s a)

Methods

(==) :: SEXP s a -> SEXP s a -> Bool

(/=) :: SEXP s a -> SEXP s a -> Bool

Ord (SEXP s a)

Methods

compare :: SEXP s a -> SEXP s a -> Ordering

(<) :: SEXP s a -> SEXP s a -> Bool

(<=) :: SEXP s a -> SEXP s a -> Bool

(>) :: SEXP s a -> SEXP s a -> Bool

(>=) :: SEXP s a -> SEXP s a -> Bool

max :: SEXP s a -> SEXP s a -> SEXP s a

min :: SEXP s a -> SEXP s a -> SEXP s a

Show (SEXP s a)

Methods

showsPrec :: Int -> SEXP s a -> ShowS

show :: SEXP s a -> String

showList :: [SEXP s a] -> ShowS

Storable (SEXP s a)

Methods

sizeOf :: SEXP s a -> Int

alignment :: SEXP s a -> Int

peekElemOff :: Ptr (SEXP s a) -> Int -> IO (SEXP s a)

pokeElemOff :: Ptr (SEXP s a) -> Int -> SEXP s a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (SEXP s a)

pokeByteOff :: Ptr b -> Int -> SEXP s a -> IO ()

peek :: Ptr (SEXP s a) -> IO (SEXP s a)

poke :: Ptr (SEXP s a) -> SEXP s a -> IO ()

NFData (SEXP s a)

Methods

rnf :: SEXP s a -> ()

PrintR (SEXP s a)

Methods

printR :: MonadR m => SEXP s a -> m ()

SingI SEXPTYPE a => Literal (SEXP s a) a

Methods

mkSEXPIO :: SEXP s a -> IO (SEXP V a)

fromSEXP :: SEXP s a -> SEXP s a

sexp :: SEXP0 -> SEXP s a

Add a type index to the pointer.

unsexp :: SEXP s a -> SEXP0

Remove the type index from the pointer.

somesexp :: SEXP0 -> SomeSEXP s

Like sexp but for SomeSEXP.

release :: t <= s => SEXP s a -> SEXP t a

Release object into another region. Releasing is safe so long as the target region is "smaller" than the source region, in the sense of '(Control.Memory.Region.<=)'.

unsafeRelease :: SEXP s a -> SEXP r a

data SomeSEXP s

A SEXP of unknown form.

Constructors

SomeSEXP !(SEXP s a)

Instances

Show (SomeSEXP s)

Methods

showsPrec :: Int -> SomeSEXP s -> ShowS

show :: SomeSEXP s -> String

showList :: [SomeSEXP s] -> ShowS

Storable (SomeSEXP s)

Methods

sizeOf :: SomeSEXP s -> Int

alignment :: SomeSEXP s -> Int

peekElemOff :: Ptr (SomeSEXP s) -> Int -> IO (SomeSEXP s)

pokeElemOff :: Ptr (SomeSEXP s) -> Int -> SomeSEXP s -> IO ()

peekByteOff :: Ptr b -> Int -> IO (SomeSEXP s)

pokeByteOff :: Ptr b -> Int -> SomeSEXP s -> IO ()

peek :: Ptr (SomeSEXP s) -> IO (SomeSEXP s)

poke :: Ptr (SomeSEXP s) -> SomeSEXP s -> IO ()

NFData (SomeSEXP s)

Methods

rnf :: SomeSEXP s -> ()

PrintR (SomeSEXP s)

Methods

printR :: MonadR m => SomeSEXP s -> m ()

Literal (SomeSEXP s) Any

Methods

mkSEXPIO :: SomeSEXP s -> IO (SEXP V Any)

fromSEXP :: SEXP s Any -> SomeSEXP s

unSomeSEXP :: SomeSEXP s -> (forall a. SEXP s a -> r) -> r

Deconstruct a SomeSEXP. Takes a continuation since otherwise the existentially quantified variable hidden inside SomeSEXP would escape.

cIntConv :: (Integral a, Integral b) => a -> b

cIntToEnum :: Enum a => CInt -> a

cUIntFromSingEnum :: SSEXPTYPE a -> CUInt

cIntFromEnum :: Enum a => a -> CInt

typeOf :: SEXP s a -> SEXPTYPE

Return the "type" tag (aka the form tag) of the given SEXP. This function is pure because the type of an object does not normally change over the lifetime of the object.

cTYPEOF :: SEXP0 -> IO CInt

setCar :: SEXP s a -> SEXP s b -> IO ()

Set CAR field of object, when object is viewed as a cons cell.

setCdr :: SEXP s a -> SEXP s b -> IO ()

Set CDR field of object, when object is viewed as a cons cell.

setTag :: SEXP s a -> SEXP s b -> IO ()

Set TAG field of object, when object is viewed as a cons cell.

Coercions have no runtime cost, but are completely unsafe. Use with caution, only when you know that a SEXP is of the target type. Casts are safer, but introduce a runtime type check. The difference between the two is akin to the difference between a C-style typecasts and C++-style dynamic_cast's.

unsafeCast :: SEXPTYPE -> SomeSEXP s -> SEXP s b

cast :: SSEXPTYPE a -> SomeSEXP s -> SEXP s a

Cast the type of a SEXP into another type. This function is partial: at runtime, an error is raised if the source form tag does not match the target form tag.

asTypeOf :: SomeSEXP s -> SEXP s a -> SEXP s a

Cast form of first argument to that of the second argument.

unsafeCoerce :: SEXP s a -> SEXP s b

Unsafe coercion from one form to another. This is unsafe, in the sense that using this function improperly could cause code to crash in unpredictable ways. Contrary to cast, it has no runtime cost since it does not introduce any dynamic check at runtime.

length :: IsVector a => SEXP s a -> IO Int

Length of the vector.

unsafeSEXPToVectorPtr :: SEXP s a -> Ptr ()

Extract the data pointer from a vector.

unsafeVectorPtrToSEXP :: Ptr a -> SomeSEXP s

Inverse of vectorPtr.

isRInteractive :: Ptr CInt

nilValue :: Ptr (SEXP G Nil)

Global nil value. Constant throughout the lifetime of the R instance.

unboundValue :: Ptr (SEXP G Symbol)

Unbound marker. Constant throughout the lifetime of the R instance.

missingArg :: Ptr (SEXP G Symbol)

Missing argument marker. Constant throughout the lifetime of the R instance.

baseEnv :: Ptr (SEXP G Env)

The base environment.

emptyEnv :: Ptr (SEXP G Env)

The empty environment.

globalEnv :: Ptr (SEXP G Env)

Global environment.

signalHandlers :: Ptr CInt

Signal handler switch

interruptsPending :: Ptr CInt

Flag that shows if computation should be interrupted.

data SEXPInfo

Info header for the SEXP data structure.

Constructors

SEXPInfo

Fields

• infoType :: SEXPTYPE

  Type of the SEXP.

• infoObj :: Bool

  Is this an object with a class attribute.

• infoNamed :: Int

  Control copying information.

• infoGp :: Int

  General purpose data.

• infoMark :: Bool

  Mark object as 'in use' in GC.

• infoDebug :: Bool

  Debug marker.

• infoTrace :: Bool

  Trace marker.

• infoSpare :: Bool

  Alignment (not in use).

• infoGcGen :: Int

  GC Generation.

• infoGcCls :: Int

  GC Class of node.

Instances

Show SEXPInfo

Methods

showsPrec :: Int -> SEXPInfo -> ShowS

show :: SEXPInfo -> String

showList :: [SEXPInfo] -> ShowS

peekInfo :: SEXP s a -> IO SEXPInfo

Extract the header from the given SEXP.

cOBJECT :: SEXP0 -> IO CInt

cNAMED :: SEXP0 -> IO CInt

cLEVELS :: SEXP0 -> IO CInt

cMARK :: SEXP0 -> IO CInt

cRDEBUG :: SEXP0 -> IO CInt

cRTRACE :: SEXP0 -> IO CInt

cRSTEP :: SEXP0 -> IO CInt

cGCGEN :: SEXP0 -> IO CInt

cGCCLS :: SEXP0 -> IO CInt

pokeInfo :: SEXP s a -> SEXPInfo -> IO ()

Write a new header.

cSET_TYPEOF :: SEXP0 -> CInt -> IO ()

cSET_OBJECT :: SEXP0 -> CInt -> IO ()

cSET_NAMED :: SEXP0 -> CInt -> IO ()

cSETLEVELS :: SEXP0 -> CInt -> IO ()

cSET_MARK :: SEXP0 -> CInt -> IO ()

cSET_RDEBUG :: SEXP0 -> CInt -> IO ()

cSET_RTRACE :: SEXP0 -> CInt -> IO ()

cSET_RSTEP :: SEXP0 -> CInt -> IO ()

cSET_GCGEN :: SEXP0 -> CInt -> IO ()

cSET_GCCLS :: SEXP0 -> CInt -> IO ()

mark :: Bool -> SEXP s a -> IO ()

Set the GC mark.

named :: Int -> SEXP s a -> IO ()

isS4 :: SEXP s ty -> Bool

Check if object is an S4 object.

This is a function call so it will be more precise than using typeOf.

getAttributes :: SEXP s a -> IO (SEXP s b)

Get the attribute list from the given object.

getAttribute

Arguments

:: SEXP s a

Value

-> SEXP s2 b

Attribute name

-> SEXP s c

Get attribute with the given name.

setAttributes :: SEXP s a -> SEXP s b -> IO ()

Set the attribute list.

cAttrib :: SEXP0 -> IO SEXP0

csetAttrib :: SEXP0 -> SEXP0 -> IO ()

cgetAttrib :: SEXP0 -> SEXP0 -> SEXP0

cisS4 :: SEXP0 -> Int