prism/c/node_8h_source.html

#ifndef PRISM_NODE_H

#define PRISM_NODE_H


#include "prism/defines.h"

#include "prism/parser.h"

#include "prism/util/pm_buffer.h"


#define PM_NODE_LIST_FOREACH(list, index, node) \

    for (size_t index = 0; index < (list)->size && ((node) = (list)->nodes[index]); index++)


void pm_node_list_append(pm_node_list_t *list, pm_node_t *node);


void pm_node_list_prepend(pm_node_list_t *list, pm_node_t *node);


void pm_node_list_concat(pm_node_list_t *list, pm_node_list_t *other);


void pm_node_list_free(pm_node_list_t *list);


PRISM_EXPORTED_FUNCTION void pm_node_destroy(pm_parser_t *parser, struct pm_node *node);


PRISM_EXPORTED_FUNCTION const char * pm_node_type_to_str(pm_node_type_t node_type);


PRISM_EXPORTED_FUNCTION void pm_visit_node(const pm_node_t *node, bool (*visitor)(const pm_node_t *node, void *data), void *data);


PRISM_EXPORTED_FUNCTION void pm_visit_child_nodes(const pm_node_t *node, bool (*visitor)(const pm_node_t *node, void *data), void *data);


#endif

pm_node_type_t
uint16_t pm_node_type_t
This is the type of node embedded in the node struct.
Definition ast.h:1034

defines.h
Macro definitions used throughout the prism library.

PRISM_EXPORTED_FUNCTION
#define PRISM_EXPORTED_FUNCTION
By default, we compile with -fvisibility=hidden.
Definition defines.h:50

pm_node_destroy
PRISM_EXPORTED_FUNCTION void pm_node_destroy(pm_parser_t *parser, struct pm_node *node)
Deallocate a node and all of its children.
Definition node.c:114

pm_visit_node
PRISM_EXPORTED_FUNCTION void pm_visit_node(const pm_node_t *node, bool(*visitor)(const pm_node_t *node, void *data), void *data)
Visit each of the nodes in this subtree using the given visitor callback.
Definition node.c:1534

pm_node_list_free
void pm_node_list_free(pm_node_list_t *list)
Free the internal memory associated with the given node list.
Definition node.c:88

pm_visit_child_nodes
PRISM_EXPORTED_FUNCTION void pm_visit_child_nodes(const pm_node_t *node, bool(*visitor)(const pm_node_t *node, void *data), void *data)
Visit the children of the given node with the given callback.
Definition node.c:1544

pm_node_list_prepend
void pm_node_list_prepend(pm_node_list_t *list, pm_node_t *node)
Prepend a new node onto the beginning of the node list.
Definition node.c:65

pm_node_type_to_str
PRISM_EXPORTED_FUNCTION const char * pm_node_type_to_str(pm_node_type_t node_type)
Returns a string representation of the given node type.
Definition node.c:1216

pm_node_list_concat
void pm_node_list_concat(pm_node_list_t *list, pm_node_list_t *other)
Concatenate the given node list onto the end of the other node list.
Definition node.c:77

pm_node_list_append
void pm_node_list_append(pm_node_list_t *list, pm_node_t *node)
Append a new node onto the end of the node list.
Definition node.c:55

parser.h
The parser used to parse Ruby source.

pm_buffer.h
A wrapper around a contiguous block of allocated memory.

pm_node_list
A list of nodes in the source, most often used for lists of children.
Definition ast.h:558

pm_node
This is the base structure that represents a node in the syntax tree.
Definition ast.h:1069

pm_parser
This struct represents the overall parser.
Definition parser.h:640