args.h File Reference

sc_arg: An argument to a node's initialisation function. More...

Data Structures
struct	sc_arg
	Representation of an argument. Used by node init functions. More...

Enumerations
enum	sc_param_type { SC_PARAM_STR, SC_PARAM_INT, SC_PARAM_OBJ, SC_PARAM_DBL }
	Possible parameter types that can be used for arguments in a node's init function. More...

Functions
static struct sc_arg	SC_ARG_INT (const char *name, int64_t val)
static struct sc_arg	SC_ARG_STR (const char *name, const char *val)
static struct sc_arg	SC_ARG_OBJ (const char *name, struct sc_object *val)
static struct sc_arg	SC_ARG_DBL (const char *name, double val)

Detailed Description

sc_arg: An argument to a node's initialisation function.

Enumeration Type Documentation

enum sc_param_type

Possible parameter types that can be used for arguments in a node's init function.

Enumerator
SC_PARAM_STR	const char pointer (nul terminated)
SC_PARAM_INT	signed 64 bit int
SC_PARAM_OBJ	sc_object pointer
SC_PARAM_DBL	native double type

Function Documentation

static struct sc_arg SC_ARG_DBL ( const char *  name, double  val  )

static

Function to construct a sc_arg struct of type SC_PARAM_DBL

Parameters

name	Name of argument.
val	Value of argument.

Returns

The constructed sc_arg struct

static struct sc_arg SC_ARG_INT ( const char *  name, int64_t  val  )

static

Function to construct a sc_arg struct of type SC_PARAM_INT

Parameters

name	Name of argument.
val	Value of argument.

Returns

The constructed sc_arg struct

static struct sc_arg SC_ARG_OBJ ( const char *  name, struct sc_object *  val  )

static

Function to construct a sc_arg struct of type SC_PARAM_OBJ

Parameters

name	Name of argument.
val	Value of argument.

Returns

The constructed sc_arg struct

static struct sc_arg SC_ARG_STR ( const char *  name, const char *  val  )

static

Function to construct a sc_arg struct of type SC_PARAM_STR

Parameters

name	Name of argument.
val	Value of argument.

Returns

The constructed sc_arg struct