Expose lower stack nodes via pop_until() function

This callback-based API allows the parser to easily visit each interior node
of the stack when searching for an error repair. It also is a better abstraction
over the stack's DAG implementation than having the public functions for
accessing entries and their successor entries.
This commit is contained in:
Max Brunsfeld 2016-03-07 16:03:23 -08:00
parent bc8df9f5c5
commit 4348eb89d4
9 changed files with 417 additions and 295 deletions

View file

@ -12,6 +12,12 @@
#define STARTING_TREE_CAPACITY 10
#define MAX_NODE_POOL_SIZE 50
#if __has_attribute(always_inline)
#define ALWAYS_INLINE __attribute__((always_inline))
#else
#define ALWAYS_INLINE
#endif
typedef struct StackNode StackNode;
typedef struct {
@ -20,19 +26,25 @@ typedef struct {
} StackLink;
struct StackNode {
StackEntry entry;
TSStateId state;
TSLength position;
StackLink successors[MAX_SUCCESSOR_COUNT];
short unsigned int successor_count;
short unsigned int ref_count;
};
typedef struct {
size_t goal_tree_count;
StackNode *node;
TreeArray trees;
bool is_shared;
size_t extra_count;
StackNode *node;
bool is_done;
} PopPath;
typedef struct {
int goal_tree_count;
bool found_error;
} StackPopSession;
typedef Array(StackNode *) StackNodeArray;
struct Stack {
@ -42,8 +54,92 @@ struct Stack {
StackNodeArray node_pool;
void *tree_selection_payload;
TreeSelectionFunction tree_selection_function;
StackNode *base_node;
};
static const char *COLORS[] = {
"red", "blue", "orange", "green", "purple",
};
/*
* Section: Manipulating nodes (Private)
*/
static void stack_node_retain(StackNode *self) {
if (!self)
return;
assert(self->ref_count != 0);
self->ref_count++;
}
static void stack_node_release(StackNode *self, StackNodeArray *pool) {
if (!self)
return;
assert(self->ref_count != 0);
self->ref_count--;
if (self->ref_count == 0) {
for (int i = 0; i < self->successor_count; i++) {
ts_tree_release(self->successors[i].tree);
stack_node_release(self->successors[i].node, pool);
}
if (pool->size >= MAX_NODE_POOL_SIZE)
ts_free(self);
else
array_push(pool, self);
}
}
static StackNode *stack_node_new(StackNode *next, TSTree *tree, TSStateId state,
TSLength position, StackNodeArray *pool) {
StackNode *node;
if (pool->size > 0)
node = array_pop(pool);
else if (!(node = ts_malloc(sizeof(StackNode))))
return NULL;
*node = (StackNode){
.ref_count = 1,
.successor_count = 0,
.successors = {},
.state = state,
.position = position,
};
if (next) {
ts_tree_retain(tree);
stack_node_retain(next);
node->successor_count = 1, node->successors[0] = (StackLink){ next, tree };
}
return node;
}
static void stack_node_add_successor(StackNode *self, TSTree *new_tree,
StackNode *new_node) {
for (int i = 0; i < self->successor_count; i++) {
StackLink successor = self->successors[i];
if (successor.tree == new_tree) {
if (successor.node == new_node)
return;
if (successor.node && new_node &&
successor.node->state == new_node->state) {
for (int j = 0; j < new_node->successor_count; j++) {
stack_node_add_successor(successor.node, new_node->successors[j].tree,
new_node->successors[j].node);
}
return;
}
}
}
stack_node_retain(new_node);
ts_tree_retain(new_tree);
self->successors[self->successor_count++] = (StackLink){
new_node, new_tree,
};
}
/*
* Section: Stack lifecycle
*/
@ -76,7 +172,13 @@ Stack *ts_stack_new() {
if (!array_grow(&self->node_pool, 20))
goto error;
array_push(&self->heads, NULL);
self->base_node =
stack_node_new(NULL, NULL, 0, ts_length_zero(), &self->node_pool);
stack_node_retain(self->base_node);
if (!self->base_node)
goto error;
array_push(&self->heads, self->base_node);
return self;
@ -100,92 +202,17 @@ error:
*/
TSStateId ts_stack_top_state(const Stack *self, int head_index) {
StackEntry *entry = ts_stack_head((Stack *)self, head_index);
return entry ? entry->state : 0;
return (*array_get(&self->heads, head_index))->state;
}
TSLength ts_stack_top_position(const Stack *self, int head_index) {
StackEntry *entry = ts_stack_head((Stack *)self, head_index);
return entry ? entry->position : ts_length_zero();
}
StackEntry *ts_stack_head(Stack *self, int head_index) {
StackNode *node = self->heads.contents[head_index];
return node ? &node->entry : NULL;
return (*array_get(&self->heads, head_index))->position;
}
int ts_stack_head_count(const Stack *self) {
return self->heads.size;
}
int ts_stack_entry_next_count(const StackEntry *entry) {
return ((const StackNode *)entry)->successor_count;
}
StackEntry *ts_stack_entry_next(const StackEntry *entry, int successor_index) {
return &((const StackNode *)entry)->successors[successor_index].node->entry;
}
/*
* Section: Manipulating nodes (Private)
*/
static void stack_node_retain(StackNode *self) {
if (!self)
return;
assert(self->ref_count != 0);
self->ref_count++;
}
static void stack_node_release(StackNode *self, StackNodeArray *pool) {
if (!self)
return;
assert(self->ref_count != 0);
self->ref_count--;
if (self->ref_count == 0) {
for (int i = 0; i < self->successor_count; i++) {
stack_node_release(self->successors[i].node, pool);
ts_tree_release(self->successors[i].tree);
}
if (pool->size >= MAX_NODE_POOL_SIZE)
ts_free(self);
else
array_push(pool, self);
}
}
static StackNode *stack_node_new(StackNode *next, TSTree *tree, TSStateId state,
StackNodeArray *pool) {
assert(tree->ref_count > 0);
StackNode *node;
if (pool->size == 0) {
node = ts_malloc(sizeof(StackNode));
if (!node)
return NULL;
} else {
node = array_pop(pool);
}
ts_tree_retain(tree);
stack_node_retain(next);
TSLength position = ts_tree_total_size(tree);
if (next)
position = ts_length_add(next->entry.position, position);
*node = (StackNode){
.ref_count = 1,
.successor_count = 1,
.successors = { { next, tree } },
.entry = {.state = state, .position = position },
};
return node;
}
static void ts_stack_slice__clear(StackSlice *slice) {
ts_tree_array_clear(&slice->trees);
array_delete(&slice->trees);
}
static void ts_stack__merge_slice(Stack *self, StackSlice *slice,
StackSlice *new_slice) {
bool should_update = false;
@ -207,39 +234,14 @@ static void ts_stack__merge_slice(Stack *self, StackSlice *slice,
}
if (should_update) {
ts_stack_slice__clear(slice);
ts_tree_array_delete(&slice->trees);
slice->trees = new_slice->trees;
slice->trees.size = new_slice->trees.size;
} else {
ts_stack_slice__clear(new_slice);
ts_tree_array_delete(&new_slice->trees);
}
}
static void stack_node__add_successor(StackNode *self, TSTree *new_tree,
StackNode *new_node) {
for (int i = 0; i < self->successor_count; i++) {
StackLink successor = self->successors[i];
if (successor.tree == new_tree) {
if (successor.node == new_node)
return;
if (successor.node && new_node &&
successor.node->entry.state == new_node->entry.state) {
for (int j = 0; j < new_node->successor_count; j++) {
stack_node__add_successor(successor.node, new_node->successors[j].tree,
new_node->successors[j].node);
}
return;
}
}
}
stack_node_retain(new_node);
ts_tree_retain(new_tree);
self->successors[self->successor_count++] = (StackLink){
new_node, new_tree,
};
}
/*
* Section: Mutating the stack (Private)
*/
@ -253,7 +255,7 @@ static int ts_stack__add_head(Stack *self, StackNode *node) {
}
}
static int ts_stack__find_head(Stack *self, StackNode *node) {
static int ts_stack__index_of_head(Stack *self, StackNode *node) {
for (size_t i = 0; i < self->heads.size; i++) {
if (self->heads.contents[i] == node)
return i;
@ -273,24 +275,22 @@ void ts_stack_remove_head(Stack *self, int head_index) {
StackPushResult ts_stack_push(Stack *self, int head_index, TSTree *tree,
TSStateId state) {
TSLength position = ts_tree_total_size(tree);
StackNode *current_head = *array_get(&self->heads, head_index);
if (current_head)
position = ts_length_add(current_head->entry.position, position);
TSLength position =
ts_length_add(current_head->position, ts_tree_total_size(tree));
for (int i = 0; i < head_index; i++) {
StackNode *prior_node = self->heads.contents[i];
StackEntry prior_entry = prior_node->entry;
if (prior_entry.state == state &&
ts_length_eq(prior_entry.position, position)) {
stack_node__add_successor(prior_node, tree, current_head);
if (prior_node->state == state &&
prior_node->position.chars == position.chars) {
stack_node_add_successor(prior_node, tree, current_head);
ts_stack_remove_head(self, head_index);
return StackPushMerged;
}
}
StackNode *new_head =
stack_node_new(current_head, tree, state, &self->node_pool);
stack_node_new(current_head, tree, state, position, &self->node_pool);
if (!new_head)
return StackPushFailed;
@ -304,46 +304,51 @@ int ts_stack_split(Stack *self, int head_index) {
return ts_stack__add_head(self, head);
}
StackPopResult ts_stack_pop(Stack *self, int head_index, int child_count,
bool count_extra) {
static inline ALWAYS_INLINE StackSliceArray stack__pop(
Stack *self, int head_index, StackIterateCallback callback, void *payload) {
array_clear(&self->slices);
array_clear(&self->pop_paths);
StackNode *initial_head = *array_get(&self->heads, head_index);
StackNode *previous_head = *array_get(&self->heads, head_index);
int capacity = (child_count == -1) ? STARTING_TREE_CAPACITY : child_count;
PopPath initial_path = {
.goal_tree_count = child_count, .node = previous_head, .is_shared = false,
PopPath pop_path = {
.node = initial_head, .trees = array_new(), .extra_count = 0, .is_done = false,
};
array_init(&initial_path.trees);
if (!array_grow(&initial_path.trees, capacity))
if (!array_grow(&pop_path.trees, STARTING_TREE_CAPACITY))
goto error;
if (!array_push(&self->pop_paths, pop_path))
goto error;
if (!array_push(&self->pop_paths, initial_path))
goto error;
/*
* Reduce along every possible path in parallel. Stop when the given number
* of child trees have been collected along every path.
*/
bool all_paths_done = false;
int status = StackPopSucceeded;
while (!all_paths_done) {
for (size_t depth = 0; !all_paths_done; depth++) {
all_paths_done = true;
for (size_t i = 0; i < self->pop_paths.size; i++) {
for (size_t i = 0, size = self->pop_paths.size; i < size; i++) {
PopPath *path = &self->pop_paths.contents[i];
StackNode *node = path->node;
if (!node || path->trees.size == path->goal_tree_count)
if (path->is_done)
continue;
StackNode *node = path->node;
size_t successor_count = node->successor_count;
switch (callback(payload, node->state, depth, path->extra_count)) {
case StackIteratePop:
path->is_done = true;
continue;
case StackIterateAbort:
successor_count = 0;
break;
default:
break;
}
if (!successor_count) {
ts_tree_array_delete(&path->trees);
array_erase(&self->pop_paths, i--);
size--;
continue;
}
all_paths_done = false;
/*
* If a node has more than one successor, create new paths for each of
* the additional successors.
*/
for (int j = 0; j < node->successor_count; j++) {
for (size_t j = 0; j < successor_count; j++) {
StackLink successor = node->successors[j];
PopPath *next_path;
@ -353,51 +358,36 @@ StackPopResult ts_stack_pop(Stack *self, int head_index, int child_count,
if (!array_push(&self->pop_paths, *path))
goto error;
next_path = array_back(&self->pop_paths);
next_path->is_shared = true;
next_path->trees.size--;
next_path->trees = ts_tree_array_copy(&next_path->trees);
}
if (next_path->is_shared) {
TreeArray trees = path->trees;
trees.size--;
next_path->trees = ts_tree_array_copy(&trees);
next_path->is_shared = false;
}
if (!count_extra && successor.tree->extra)
next_path->goal_tree_count++;
ts_tree_retain(successor.tree);
if (!array_push(&next_path->trees, successor.tree))
goto error;
next_path->node = successor.node;
if (!count_extra && node->entry.state == ts_parse_state_error) {
status = StackPopStoppedAtError;
next_path->goal_tree_count = next_path->trees.size;
}
if (!array_push(&next_path->trees, successor.tree))
goto error;
if (successor.tree->extra)
next_path->extra_count++;
ts_tree_retain(successor.tree);
}
}
}
for (size_t i = 0; i < self->pop_paths.size; i++) {
PopPath *path = &self->pop_paths.contents[i];
if (!path->is_done)
continue;
if (!path->is_shared)
array_reverse(&path->trees);
StackSlice slice = {
.trees = path->trees, .head_index = -1,
};
StackSlice slice = {.trees = path->trees, .head_index = -1 };
array_reverse(&slice.trees);
if (i == 0) {
stack_node_retain(path->node);
self->heads.contents[head_index] = path->node;
slice.head_index = head_index;
} else {
slice.head_index = ts_stack__find_head(self, path->node);
slice.head_index = ts_stack__index_of_head(self, path->node);
if (slice.head_index == -1) {
slice.head_index = ts_stack__add_head(self, path->node);
if (slice.head_index == -1)
if ((slice.head_index = ts_stack__add_head(self, path->node)) == -1)
goto error;
} else {
bool merged = false;
@ -418,12 +408,62 @@ StackPopResult ts_stack_pop(Stack *self, int head_index, int child_count,
goto error;
}
stack_node_release(previous_head, &self->node_pool);
return (StackPopResult){ .status = status, .slices = self->slices };
if (self->slices.size)
stack_node_release(initial_head, &self->node_pool);
return self->slices;
error:
array_delete(&initial_path.trees);
return (StackPopResult){StackPopFailed, self->slices};
for (size_t i = 0; i < self->pop_paths.size; i++)
array_delete(&self->pop_paths.contents[i].trees);
array_clear(&self->slices);
return self->slices;
}
static inline ALWAYS_INLINE StackIterateAction stack__pop_count_callback(
void *payload, TSStateId state, size_t depth, size_t extra_count) {
StackPopSession *pop_session = (StackPopSession *)payload;
if (pop_session->found_error)
return StackIterateAbort;
if (state == ts_parse_state_error && pop_session->goal_tree_count > 0) {
pop_session->found_error = true;
return StackIteratePop;
}
if ((int)(depth - extra_count) == pop_session->goal_tree_count)
return StackIteratePop;
if (state == 0 && depth > 0)
return StackIteratePop;
return StackIterateContinue;
}
StackPopResult ts_stack_pop_count(Stack *self, int head_index, int count) {
StackPopSession session = {
.goal_tree_count = count,
.found_error = false,
};
StackSliceArray slices =
stack__pop(self, head_index, stack__pop_count_callback, &session);
int status;
if (slices.size) {
if (session.found_error)
status = StackPopStoppedAtError;
else
status = StackPopSucceeded;
} else {
status = StackPopFailed;
}
return (StackPopResult){.status = status, .slices = slices };
}
StackPopResult ts_stack_pop_until(Stack *self, int head_index,
StackIterateCallback callback, void *payload) {
StackSliceArray slices = stack__pop(self, head_index, callback, payload);
return (StackPopResult){.status = StackPopSucceeded, .slices = slices };
}
void ts_stack_shrink(Stack *self, int head_index, int count) {
@ -440,10 +480,11 @@ void ts_stack_shrink(Stack *self, int head_index, int count) {
}
void ts_stack_clear(Stack *self) {
stack_node_retain(self->base_node);
for (size_t i = 0; i < self->heads.size; i++)
stack_node_release(self->heads.contents[i], &self->node_pool);
array_clear(&self->heads);
array_push(&self->heads, NULL);
array_push(&self->heads, self->base_node);
}
void ts_stack_set_tree_selection_callback(Stack *self, void *payload,
@ -457,7 +498,10 @@ void ts_stack_delete(Stack *self) {
array_delete(&self->slices);
if (self->pop_paths.contents)
array_delete(&self->pop_paths);
ts_stack_clear(self);
stack_node_release(self->base_node, &self->node_pool);
for (size_t i = 0; i < self->heads.size; i++)
stack_node_release(self->heads.contents[i], &self->node_pool);
array_clear(&self->heads);
if (self->node_pool.contents) {
for (size_t i = 0; i < self->node_pool.size; i++)
ts_free(self->node_pool.contents[i]);
@ -467,12 +511,6 @@ void ts_stack_delete(Stack *self) {
ts_free(self);
}
static const char *COLORS[] = {
"red", "blue", "orange", "green", "purple",
};
static size_t COLOR_COUNT = sizeof(COLORS) / sizeof(COLORS[0]);
size_t ts_stack__write_dot_graph(Stack *self, char *string, size_t n,
const char **symbol_names) {
char *cursor = string;
@ -486,7 +524,8 @@ size_t ts_stack__write_dot_graph(Stack *self, char *string, size_t n,
array_clear(&self->pop_paths);
for (size_t i = 0; i < self->heads.size; i++) {
StackNode *node = self->heads.contents[i];
const char *color = COLORS[i % COLOR_COUNT];
size_t color_count = sizeof(COLORS) / sizeof(COLORS[0]);
const char *color = COLORS[i % color_count];
cursor += snprintf(*s, n, "node_%p [color=%s];\n", node, color);
array_push(&self->pop_paths, ((PopPath){.node = node }));
}
@ -511,10 +550,10 @@ size_t ts_stack__write_dot_graph(Stack *self, char *string, size_t n,
all_paths_done = false;
cursor += snprintf(*s, n, "node_%p [label=", node);
if (node->entry.state == ts_parse_state_error)
if (node->state == ts_parse_state_error)
cursor += snprintf(*s, n, "\"?\"");
else
cursor += snprintf(*s, n, "%d", node->entry.state);
cursor += snprintf(*s, n, "%d", node->state);
cursor += snprintf(*s, n, "];\n");
for (int j = 0; j < node->successor_count; j++) {
@ -553,7 +592,6 @@ size_t ts_stack__write_dot_graph(Stack *self, char *string, size_t n,
}
}
cursor += snprintf(*s, n, "node_%p [label=0];\n", NULL);
cursor += snprintf(*s, n, "}\n");
array_delete(&visited_nodes);