Kiwi Engine
VM for interpreter
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Data Structures | Enumerations | Functions
KEValue.h File Reference

Define KEValue data structure. More...

#include <Coconut/Coconut.h>
#include "KEForwarders.h"

Go to the source code of this file.

Data Structures

struct  KEValue
 

Enumerations

enum  KEValueType {
  KENilValue, KEBooleanValue, KESignedIntegerValue, KEUnsignedIntegerValue,
  KEFloatValue, KEStringValue, KEObjectValue
}
 

Functions

struct KEFrameKEFrameInValue (const struct KEValue *src)
 Get frame in value. More...
 
struct KEValue KEMakeFrameValue (struct KEFrame *src)
 Make the value which has the frame. More...
 
void KEUpdateFrameValue (struct KEValue *dst, struct KEFrame *src)
 Set the value to frame object. More...
 
struct KEArrayKEArrayInValue (const struct KEValue *src)
 Get array in value. More...
 
struct KEValue KEMakeArrayValue (struct KEArray *src)
 Make the value which has the array. More...
 
void KEUpdateArrayValue (struct KEValue *dst, struct KEArray *src)
 Set the value to array object. More...
 
struct KEDictionaryKEDictionaryInValue (const struct KEValue *src)
 Get dictionary in value. More...
 
struct KEValue KEMakeDictionaryValue (struct KEDictionary *src)
 Make the value which has the dictionary. More...
 
void KEUpdateDictionaryValue (struct KEValue *dst, struct KEDictionary *src)
 Set the value to dictionary object. More...
 
struct KEPathKEPathInValue (const struct KEValue *src)
 Get path in value. More...
 
struct KEValue KEMakePathValue (struct KEPath *src)
 Make the value which has the dictionary. More...
 
void KEUpdatePathValue (struct KEValue *dst, struct KEPath *src)
 Set the value to path object. More...
 
struct KEFunctionKEFunctionInValue (const struct KEValue *src)
 Get function in value. More...
 
struct KEValue KEMakeFunctionValue (struct KEFunction *src)
 Make the value which has the function. More...
 
void KEUpdateFunctionValue (struct KEValue *dst, struct KEFunction *src)
 Set the value to function object. More...
 
struct KEBuiltinFuncKEBuiltinFuncInValue (const struct KEValue *src)
 Get builtin-func in value. More...
 
struct KEValue KEMakeBuiltinFuncValue (struct KEBuiltinFunc *src)
 Make the value which has the builtin-func. More...
 
void KEUpdateBuiltinFuncValue (struct KEValue *dst, struct KEBuiltinFunc *src)
 Set the value to builtin-func object. More...
 
const char * KEStringOfValueType (struct KEValue *src)
 Get description of given type. More...
 
void KEDumpValue (struct CNText *outbuf, const struct KEValue *src)
 Dump context of the buffer. More...
 

Detailed Description

Define KEValue data structure.

Copyright
Copyright (C) 2013-2014 Steel Wheels Project

Enumeration Type Documentation

Type of value

Function Documentation

struct KEArray* KEArrayInValue ( const struct KEValue src)

Get array in value.

Return values
arrayPointer of the array in value
NULLThe value does not have array object
Parameters
srcSource value
struct KEBuiltinFunc* KEBuiltinFuncInValue ( const struct KEValue src)

Get builtin-func in value.

Return values
bfuncPointer of the buildin-func in value
NULLThe value does not have builtin-func object
Parameters
srcSource value
struct KEDictionary* KEDictionaryInValue ( const struct KEValue src)

Get dictionary in value.

Return values
framePointer of the dictionary in value
NULLThe value does not have dictionary object
Parameters
srcSource value
void KEDumpValue ( struct CNText *  outbuf,
const struct KEValue src 
)

Dump context of the buffer.

Parameters
outbufOutput buffer
srcSource value
struct KEFrame* KEFrameInValue ( const struct KEValue src)

Get frame in value.

Return values
framePointer of the frame in value
NULLThe value does not have frame object
Parameters
srcSource value
struct KEFunction* KEFunctionInValue ( const struct KEValue src)

Get function in value.

Return values
bfuncPointer of the function in value
NULLThe value does not have function object
Parameters
srcSource value
struct KEValue KEMakeArrayValue ( struct KEArray src)

Make the value which has the array.

Returns
Value with array
Parameters
srcSource array
struct KEValue KEMakeBuiltinFuncValue ( struct KEBuiltinFunc src)

Make the value which has the builtin-func.

Returns
Value with builtin-func
Parameters
srcSource builtin-func
struct KEValue KEMakeDictionaryValue ( struct KEDictionary src)

Make the value which has the dictionary.

Returns
Value with dictionary
Parameters
srcSource dictionary
struct KEValue KEMakeFrameValue ( struct KEFrame src)

Make the value which has the frame.

Returns
Value with frame
Parameters
srcSource frame
struct KEValue KEMakeFunctionValue ( struct KEFunction src)

Make the value which has the function.

Returns
Value with function
Parameters
srcSource function
struct KEValue KEMakePathValue ( struct KEPath src)

Make the value which has the dictionary.

Returns
Value with dictionary
Parameters
srcSource dictionary
struct KEPath* KEPathInValue ( const struct KEValue src)

Get path in value.

Return values
framePointer of the path in value
NULLThe value does not have path object
Parameters
srcSource value
const char* KEStringOfValueType ( struct KEValue src)

Get description of given type.

Returns
Description of source type
Parameters
srcSource type
void KEUpdateArrayValue ( struct KEValue dst,
struct KEArray src 
)

Set the value to array object.

Parameters
dstDestination value
srcSource array object
Note
This function assumes the destination value is already initialized
void KEUpdateBuiltinFuncValue ( struct KEValue dst,
struct KEBuiltinFunc src 
)

Set the value to builtin-func object.

Parameters
dstDestination value
srcSource builtin-func object
Note
This function assumes the destination value is already initialized
void KEUpdateDictionaryValue ( struct KEValue dst,
struct KEDictionary src 
)

Set the value to dictionary object.

Parameters
dstDestination value
srcSource dictionary object
Note
This function assumes the destination value is already initialized
void KEUpdateFrameValue ( struct KEValue dst,
struct KEFrame src 
)

Set the value to frame object.

Parameters
dstDestination value
srcSource frame object
Note
This function assumes the destination value is already initialized
void KEUpdateFunctionValue ( struct KEValue dst,
struct KEFunction src 
)

Set the value to function object.

Parameters
dstDestination value
srcSource function object
Note
This function assumes the destination value is already initialized
void KEUpdatePathValue ( struct KEValue dst,
struct KEPath src 
)

Set the value to path object.

Parameters
dstDestination value
srcSource path object
Note
This function assumes the destination value is already initialized