tidy up the reference macro, rename dereference function; [examples] tidy up the commentary about for loop macros

This commit is contained in:
Allen Webster
2021-09-13 17:21:12 -07:00
parent b83546a60a
commit feafba93f3
6 changed files with 111 additions and 112 deletions
@@ -73,7 +73,7 @@ int main(int argument_count, char **arguments)
Initialize(); Initialize();
for(MD_EachNode(ref, list->first_child)) for(MD_EachNode(ref, list->first_child))
{ {
MD_Node *root = MD_NodeFromReference(ref); MD_Node *root = MD_ResolveNodeFromReference(ref);
for(MD_EachNode(node, root->first_child)) for(MD_EachNode(node, root->first_child))
{ {
TopLevel(node); TopLevel(node);
+1 -1
View File
@@ -22,7 +22,7 @@ int main(int argument_count, char **arguments)
// NOTE(rjf): Print errors on every single node. // NOTE(rjf): Print errors on every single node.
for(MD_EachNode(ref, list->first_child)) for(MD_EachNode(ref, list->first_child))
{ {
MD_Node *root = MD_NodeFromReference(ref); MD_Node *root = MD_ResolveNodeFromReference(ref);
for(MD_EachNode(node, root->first_child)) for(MD_EachNode(node, root->first_child))
{ {
MD_PrintNodeMessageFmt(stderr, node, MD_MessageKind_Error, "This node has an error!"); MD_PrintNodeMessageFmt(stderr, node, MD_MessageKind_Error, "This node has an error!");
+16 -13
View File
@@ -73,20 +73,23 @@ int main(int argument_count, char **arguments)
} }
// print the verbose parse results // print the verbose parse results
// @notes The Metadesk library provides a few macros for iterating MD_Node // @notes The Metadesk library provides a macros for iterating chains of
// lists as shown here. The first parameter to the macro becomes an // MD_Node as shown here. The first parameter to the macro names an
// MD_Node pointer in the scope of the for loop that visits each node in // MD_Node pointer in the for loop that iterates through each node in the
// the list in order. The second parameter is a pointer to the first node // list. The second parameter is a pointer to the first node of the list.
// in the list. Generally we past the `first_child` of a list or parent // Generally we past the `first_child` of a list or parent MD_Node, but we
// MD_Node, but we don't always have to. // don't always have to.
// for (MD_EachNode(root_it, list->first_child))
// MD_EachNode is used to iterate a list of children.
// MD_EachNodeRef is used to iterate a list of references like the list
// of roots from the parses we have built. Underneath the surface this
// macro automatically resolves the reference at the beginning of each
// loop step.
for (MD_EachNodeRef(root, list->first_child))
{ {
// @notes The `list` we have been building does not contain a normal
// MD_Node chain like in the trees returned from the parser. Instead
// it contains a chain of 'reference' nodes, which can point to any
// metadesk node from a previous parse. So our `root_it` is iterating
// a list of reference nodes. Here we resolve the reference node to
// get the root of the parse tree.
MD_Node *root = MD_ResolveNodeFromReference(root_it);
for (MD_EachNode(node, root->first_child)) for (MD_EachNode(node, root->first_child))
{ {
// @notes The Metadesk library likes to use MD_String8List for // @notes The Metadesk library likes to use MD_String8List for
+1 -1
View File
@@ -2837,7 +2837,7 @@ MD_TagCountFromNode(MD_Node *node)
} }
MD_FUNCTION_IMPL MD_Node * MD_FUNCTION_IMPL MD_Node *
MD_NodeFromReference(MD_Node *node) MD_ResolveNodeFromReference(MD_Node *node)
{ {
MD_u64 safety = 100; MD_u64 safety = 100;
for(; safety > 0 && node->kind == MD_NodeKind_Reference; for(; safety > 0 && node->kind == MD_NodeKind_Reference;
+1 -5
View File
@@ -1087,17 +1087,13 @@ MD_FUNCTION MD_Node * MD_TagArgFromString(MD_Node *node, MD_String8 tag_string,
MD_FUNCTION MD_b32 MD_NodeHasTag(MD_Node *node, MD_String8 tag_string, MD_MatchFlags flags); MD_FUNCTION MD_b32 MD_NodeHasTag(MD_Node *node, MD_String8 tag_string, MD_MatchFlags flags);
MD_FUNCTION MD_i64 MD_ChildCountFromNode(MD_Node *node); MD_FUNCTION MD_i64 MD_ChildCountFromNode(MD_Node *node);
MD_FUNCTION MD_i64 MD_TagCountFromNode(MD_Node *node); MD_FUNCTION MD_i64 MD_TagCountFromNode(MD_Node *node);
MD_FUNCTION MD_Node * MD_NodeFromReference(MD_Node *node); MD_FUNCTION MD_Node * MD_ResolveNodeFromReference(MD_Node *node);
MD_FUNCTION MD_String8 MD_PrevCommentFromNode(MD_Node *node); MD_FUNCTION MD_String8 MD_PrevCommentFromNode(MD_Node *node);
MD_FUNCTION MD_String8 MD_NextCommentFromNode(MD_Node *node); MD_FUNCTION MD_String8 MD_NextCommentFromNode(MD_Node *node);
// NOTE(rjf): For-Loop Helpers // NOTE(rjf): For-Loop Helpers
#define MD_EachNode(it, first) MD_Node *it = (first); !MD_NodeIsNil(it); it = it->next #define MD_EachNode(it, first) MD_Node *it = (first); !MD_NodeIsNil(it); it = it->next
#define MD_EachNodeRef(it, first) \
MD_Node *it##_r = (first), *it = MD_NodeFromReference(it##_r); \
!MD_NodeIsNil(it##_r); \
it##_r = it##_r->next, it = MD_NodeFromReference(it##_r)
//~ Error/Warning Helpers //~ Error/Warning Helpers
+54 -54
View File
@@ -29,60 +29,60 @@ struct OperatorDescription{
// NOTE(mal): Based on https://en.wikipedia.org/wiki/Operators_in_C_and_C%2B%2B#Operator_precedence 2021-09-05 // NOTE(mal): Based on https://en.wikipedia.org/wiki/Operators_in_C_and_C%2B%2B#Operator_precedence 2021-09-05
// Precedences are flipped. The ones listed here are 20-x where x is the precedence on the wikipedia table // Precedences are flipped. The ones listed here are 20-x where x is the precedence on the wikipedia table
#define OPERATORS \ #define OPERATORS \
X(PostFixIncrement, "++", Postfix, 18) \ X(PostFixIncrement, "++", Postfix, 18) \
X(PostFixDecrement, "--", Postfix, 18) \ X(PostFixDecrement, "--", Postfix, 18) \
X(Call, "()", Postfix, 18) \ X(Call, "()", Postfix, 18) \
X(ArraySubscript, "[]", Binary, 18) \ X(ArraySubscript, "[]", Binary, 18) \
X(Member, ".", Binary, 18) \ X(Member, ".", Binary, 18) \
X(PointerMember, "->", Binary, 18) \ X(PointerMember, "->", Binary, 18) \
X(PreFixIncrement, "++", Prefix, 17) \ X(PreFixIncrement, "++", Prefix, 17) \
X(PreFixDecrement, "--", Prefix, 17) \ X(PreFixDecrement, "--", Prefix, 17) \
X(UnaryPlus, "+", Prefix, 17) \ X(UnaryPlus, "+", Prefix, 17) \
X(UnaryMinus, "-", Prefix, 17) \ X(UnaryMinus, "-", Prefix, 17) \
X(LogicalNot, "!", Prefix, 17) \ X(LogicalNot, "!", Prefix, 17) \
X(BitwiseNot, "~", Prefix, 17) \ X(BitwiseNot, "~", Prefix, 17) \
X(Dereference, "*", Prefix, 17) \ X(Dereference, "*", Prefix, 17) \
X(AddressOf, "&", Prefix, 17) \ X(AddressOf, "&", Prefix, 17) \
X(SizeOf, "sizeof", Prefix, 17) /* NOTE(mal); Just for fun*/ \ X(SizeOf, "sizeof", Prefix, 17) /* NOTE(mal); Just for fun*/ \
X(Multiplication, "*", Binary, 15) \ X(Multiplication, "*", Binary, 15) \
X(Division, "/", Binary, 15) \ X(Division, "/", Binary, 15) \
X(Modulo, "%", Binary, 15) \ X(Modulo, "%", Binary, 15) \
X(Addition, "+", Binary, 14) \ X(Addition, "+", Binary, 14) \
X(Subtraction, "-", Binary, 14) \ X(Subtraction, "-", Binary, 14) \
X(LeftShift, "<<", Binary, 13) \ X(LeftShift, "<<", Binary, 13) \
X(RightShift, ">>", Binary, 13) \ X(RightShift, ">>", Binary, 13) \
X(LessThan, "<", Binary, 11) \ X(LessThan, "<", Binary, 11) \
X(LessThanOrEqual, "<=", Binary, 11) \ X(LessThanOrEqual, "<=", Binary, 11) \
X(GreaterThan, ">", Binary, 11) \ X(GreaterThan, ">", Binary, 11) \
X(GreaterThanOrEqual, ">=", Binary, 11) \ X(GreaterThanOrEqual, ">=", Binary, 11) \
X(Equal, "==", Binary, 10) \ X(Equal, "==", Binary, 10) \
X(NotEqual, "!=", Binary, 10) \ X(NotEqual, "!=", Binary, 10) \
X(BitwiseAnd, "&", Binary, 9) \ X(BitwiseAnd, "&", Binary, 9) \
X(BitwiseXor, "^", Binary, 8) \ X(BitwiseXor, "^", Binary, 8) \
X(BitwiseOr, "|", Binary, 7) \ X(BitwiseOr, "|", Binary, 7) \
X(LogicalAnd, "&&", Binary, 6) \ X(LogicalAnd, "&&", Binary, 6) \
X(LogicalOr, "||", Binary, 5) \ X(LogicalOr, "||", Binary, 5) \
X(Assign, "=", BinaryRightAssociative, 4) \ X(Assign, "=", BinaryRightAssociative, 4) \
X(AssignAddition, "+=", BinaryRightAssociative, 4) \ X(AssignAddition, "+=", BinaryRightAssociative, 4) \
X(AssignSubtraction, "-=", BinaryRightAssociative, 4) \ X(AssignSubtraction, "-=", BinaryRightAssociative, 4) \
X(AssignMultiplication,"*=", BinaryRightAssociative, 4) \ X(AssignMultiplication,"*=", BinaryRightAssociative, 4) \
X(AssignDivision, "/=", BinaryRightAssociative, 4) \ X(AssignDivision, "/=", BinaryRightAssociative, 4) \
X(AssignModulo, "%=", BinaryRightAssociative, 4) \ X(AssignModulo, "%=", BinaryRightAssociative, 4) \
X(AssignLeftShift, "<<=", BinaryRightAssociative, 4) \ X(AssignLeftShift, "<<=", BinaryRightAssociative, 4) \
X(AssignRightShift, ">>=", BinaryRightAssociative, 4) \ X(AssignRightShift, ">>=", BinaryRightAssociative, 4) \
X(AssignBitwiseAnd, "&=", BinaryRightAssociative, 4) \ X(AssignBitwiseAnd, "&=", BinaryRightAssociative, 4) \
X(AssignBitwiseXor, "^=", BinaryRightAssociative, 4) \ X(AssignBitwiseXor, "^=", BinaryRightAssociative, 4) \
X(AssignBitwiseOr, "|=", BinaryRightAssociative, 4) \ X(AssignBitwiseOr, "|=", BinaryRightAssociative, 4) \
X(BracketSet, "[]", Prefix, 3) \ X(BracketSet, "[]", Prefix, 3) \
X(BraceSet, "{}", Prefix, 3) X(BraceSet, "{}", Prefix, 3)
// X(Cast "()", Prefix, 17) // X(Cast "()", Prefix, 17)
// X(Comma, ",", Binary, 3) // X(Comma, ",", Binary, 3)
#define X(name, token, kind, prec) Op_##name, #define X(name, token, kind, prec) Op_##name,
typedef enum{ typedef enum{
Op_Null, Op_Null,
OPERATORS OPERATORS
Op_COUNT Op_COUNT
} Op; } Op;
#undef X #undef X
@@ -175,7 +175,7 @@ static void parenthesize_exclude_outer(MD_Arena *arena, OperatorDescription *des
MD_S8ListPush(arena, l, MD_S8Lit("[...]")); MD_S8ListPush(arena, l, MD_S8Lit("[...]"));
} }
else if(node->md_node->flags & MD_NodeFlag_HasBraceLeft && else if(node->md_node->flags & MD_NodeFlag_HasBraceLeft &&
node->md_node->flags & MD_NodeFlag_HasBraceRight){ node->md_node->flags & MD_NodeFlag_HasBraceRight){
MD_S8ListPush(arena, l, MD_S8Lit("{...}")); MD_S8ListPush(arena, l, MD_S8Lit("{...}"));
} }
else{ else{
@@ -196,8 +196,8 @@ static MD_String8 parenthesize(MD_Arena *arena, OperatorDescription *descs, MD_E
int main(void){ int main(void){
OperatorDescription operator_array[Op_COUNT] = {0}; OperatorDescription operator_array[Op_COUNT] = {0};
#define X(name, token, kind_, prec) \ #define X(name, token, kind_, prec) \
operator_array[Op_##name].s = MD_S8Lit(token); \ operator_array[Op_##name].s = MD_S8Lit(token); \
operator_array[Op_##name].op = (MD_ExprOperator){ .op_id = Op_##name, .kind = MD_ExprOperatorKind_##kind_, .precedence = prec }; operator_array[Op_##name].op = (MD_ExprOperator){ .op_id = Op_##name, .kind = MD_ExprOperatorKind_##kind_, .precedence = prec };
OPERATORS OPERATORS
#undef X #undef X
@@ -336,7 +336,7 @@ int main(void){
for(MD_Message *message = expr_parse.errors.first; message; message = message->next){ for(MD_Message *message = expr_parse.errors.first; message; message = message->next){
if(message->node->offset != test.error_offset){ if(message->node->offset != test.error_offset){
printf("Example %d : \"%.*s\". Expected error on character %d; got character %ld instead\n", printf("Example %d : \"%.*s\". Expected error on character %d; got character %ld instead\n",
i_test, MD_S8VArg(q), test.error_offset, message->node->offset); i_test, MD_S8VArg(q), test.error_offset, (long)message->node->offset);
} }
} }
} }
@@ -352,7 +352,7 @@ int main(void){
for(MD_Message *message = parse.errors.first; message; message = message->next){ for(MD_Message *message = parse.errors.first; message; message = message->next){
if(message->node->offset != test.error_offset){ if(message->node->offset != test.error_offset){
printf("Example %d : \"%.*s\". Expected error on character %d; got character %ld instead\n", printf("Example %d : \"%.*s\". Expected error on character %d; got character %ld instead\n",
i_test, MD_S8VArg(q), test.error_offset, message->node->offset); i_test, MD_S8VArg(q), test.error_offset, (long)message->node->offset);
} }
} }
} }