Skip to content

var_table.h#

Variable table interface using Nst_MapObj.

Authors#

TheSilvered

Macros#

Nst_vt_get#

Synopsis:

#define Nst_vt_get(vt, name)

Description:

Alias of _Nst_vt_get that casts name to Nst_Obj *.

Nst_vt_set#

Synopsis:

#define Nst_vt_set(vt, name, val)

Description:

Alias of _Nst_vt_set that casts name and val to Nst_Obj *.

Structs#

Nst_VarTable#

Synopsis:

typedef struct _Nst_VarTable {
    Nst_MapObj *vars;
    Nst_MapObj *global_table;
} Nst_VarTable

Description:

Structure representing the Nest variable table

Fields:

  • vars: the map of local variables
  • global_table: the map of global variables

Functions#

Nst_vt_new#

Synopsis:

Nst_VarTable *Nst_vt_new(Nst_MapObj *global_table, Nst_StrObj *cwd,
                         Nst_SeqObj *args, bool no_default)

Description:

Creates a new var table on the heap.

Parameters:

  • global_table: the current global variable table, can be NULL
  • cwd: the current working directory, ignored when global_table is not NULL or no_default is true
  • args: the command line arguments, ignored when global_table is not NULL or no_default is true
  • no_default: whether to create predefined variables

Nst_vt_destroy#

Synopsis:

void Nst_vt_destroy(Nst_VarTable *vt)

Description:

Nst_VarTable destructor.

_Nst_vt_get#

Synopsis:

Nst_Obj *_Nst_vt_get(Nst_VarTable *vt, Nst_Obj *name)

Description:

Retrieves a value from a variable table.

Parameters:

  • vt: the variable table to get the value from
  • name: the name of the value to get

Returns:

The value associated with the key or Nst_null() if the key is not present in the table.

_Nst_vt_set#

Synopsis:

bool _Nst_vt_set(Nst_VarTable *vt, Nst_Obj *name, Nst_Obj *val)

Description:

Sets a value in a variable table.

Parameters:

  • vt: the variable table to set the value into
  • name: the name of the value to set
  • value: the value to associate to name

Returns:

true on success and false on failure. The error is set.

Nst_vt_from_func#

Synopsis:

Nst_VarTable *Nst_vt_from_func(Nst_FuncObj *f)

Description:

Creates a new variable table with the correct global table of the function.

Parameters:

  • f: the function where the global table is stored

Returns:

The new var table or NULL on failure. The error is set.