Skip to content

Add full documentation and update README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
google-labs-jules wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add full documentation and update README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59606e0
feat: Add comprehensive documentation and update README
google-labs-jules[bot] Dec 2, 2025
2a932d7
docs: Add comprehensive documentation and update README
google-labs-jules[bot] Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
617 changes: 407 additions & 210 deletions Compiler-Src/ast.h
View file
Open in desktop

Large diffs are not rendered by default.

142 changes: 120 additions & 22 deletions Compiler-Src/ast_printer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,120 @@
#include <stdio.h>
#include "ast_printer.h"
static void print_indent(int l){for(int i=0;i<l;i++)printf(" ");}
static void print_node(ASTNode* n, int l) {
if(!n)return; print_indent(l);
switch(n->type){
case VAR_DECL_NODE:{VarDeclNode*d=(VarDeclNode*)n;printf("VAR_DECL (Name: %s)\n",d->name);if(d->init_expr)print_node(d->init_expr,l+1);break;}
case BINARY_OP_NODE:{BinOpNode*o=(BinOpNode*)n;printf("BINARY_OP (Op: %d)\n",o->op);print_node(o->left,l+1);print_node(o->right,l+1);break;}
case UNARY_OP_NODE:{UnaryOpNode*o=(UnaryOpNode*)n;printf("UNARY_OP (Op: %d)\n",o->op);print_node(o->operand,l+1);break;}
case LITERAL_NODE:{LiteralNode*li=(LiteralNode*)n;if(li->literal_type==LIT_INT)printf("INT_LITERAL (Value: %d)\n",li->value.int_val);else if(li->literal_type==LIT_DUB)printf("DUB_LITERAL (Value: %f)\n",li->value.dub_val);else if(li->literal_type==LIT_BOOL)printf("BOOL_LITERAL (Value: %s)\n",li->value.bool_val?"true":"false");break;}
case IDENTIFIER_NODE:{IdentifierNode*i=(IdentifierNode*)n;printf("IDENTIFIER (Name: %s)\n",i->name);break;}
case IF_NODE:{IfNode*i=(IfNode*)n;printf("IF_STMT\n");print_indent(l+1);printf("CONDITION:\n");print_node(i->condition,l+2);print_indent(l+1);printf("IF_BODY:\n");print_node(i->if_body,l+2);if(i->else_body){print_indent(l+1);printf("ELSE_BODY:\n");print_node(i->else_body,l+2);}break;}
case FOR_NODE:{ForNode*f=(ForNode*)n;printf("FOR_STMT\n");print_indent(l+1);printf("INIT:\n");print_node(f->init,l+2);print_indent(l+1);printf("CONDITION:\n");print_node(f->condition,l+2);print_indent(l+1);printf("UPDATE:\n");print_node(f->update,l+2);print_indent(l+1);printf("BODY:\n");print_node(f->body,l+2);break;}
case RETURN_NODE:{ReturnNode*r=(ReturnNode*)n;printf("RETURN_STMT\n");if(r->return_expr)print_node(r->return_expr,l+1);break;}
case PRINT_NODE:{PrintNode*p=(PrintNode*)n;printf("PRINT_STMT (Value: \"%s\")\n",p->string_to_print);break;}
case CONTINUE_NODE:{printf("CONTINUE_STMT\n");break;}
case BREAK_NODE:{printf("BREAK_STMT\n");break;}
default:printf("Unknown Node Type: %d\n",n->type);break;
}
print_node(n->next,l);
}
void print_ast(ASTNode* ast_root){printf("\n--- Abstract Syntax Tree ---\n");print_node(ast_root,0);printf("--------------------------\n");}
#include <stdio.h>
#include "ast_printer.h"

/**
* @brief Prints spaces for indentation to visually represent tree depth.
*
* @param l The level of indentation.
*/
static void print_indent(int l) {
for (int i = 0; i < l; i++) printf(" ");
}

/**
* @brief Helper function to recursively print an AST node and its children.
*
* @param n The AST node to print.
* @param l The current indentation level.
*/
static void print_node(ASTNode* n, int l) {
if (!n) return;
print_indent(l);
switch (n->type) {
case VAR_DECL_NODE: {
VarDeclNode* d = (VarDeclNode*)n;
printf("VAR_DECL (Name: %s)\n", d->name);
if (d->init_expr) print_node(d->init_expr, l + 1);
break;
}
case BINARY_OP_NODE: {
BinOpNode* o = (BinOpNode*)n;
printf("BINARY_OP (Op: %d)\n", o->op);
print_node(o->left, l + 1);
print_node(o->right, l + 1);
break;
}
case UNARY_OP_NODE: {
UnaryOpNode* o = (UnaryOpNode*)n;
printf("UNARY_OP (Op: %d)\n", o->op);
print_node(o->operand, l + 1);
break;
}
case LITERAL_NODE: {
LiteralNode* li = (LiteralNode*)n;
if (li->literal_type == LIT_INT)
printf("INT_LITERAL (Value: %d)\n", li->value.int_val);
else if (li->literal_type == LIT_DUB)
printf("DUB_LITERAL (Value: %f)\n", li->value.dub_val);
else if (li->literal_type == LIT_BOOL)
printf("BOOL_LITERAL (Value: %s)\n", li->value.bool_val ? "true" : "false");
break;
}
case IDENTIFIER_NODE: {
IdentifierNode* i = (IdentifierNode*)n;
printf("IDENTIFIER (Name: %s)\n", i->name);
break;
}
case IF_NODE: {
IfNode* i = (IfNode*)n;
printf("IF_STMT\n");
print_indent(l + 1);
printf("CONDITION:\n");
print_node(i->condition, l + 2);
print_indent(l + 1);
printf("IF_BODY:\n");
print_node(i->if_body, l + 2);
if (i->else_body) {
print_indent(l + 1);
printf("ELSE_BODY:\n");
print_node(i->else_body, l + 2);
}
break;
}
case FOR_NODE: {
ForNode* f = (ForNode*)n;
printf("FOR_STMT\n");
print_indent(l + 1);
printf("INIT:\n");
print_node(f->init, l + 2);
print_indent(l + 1);
printf("CONDITION:\n");
print_node(f->condition, l + 2);
print_indent(l + 1);
printf("UPDATE:\n");
print_node(f->update, l + 2);
print_indent(l + 1);
printf("BODY:\n");
print_node(f->body, l + 2);
break;
}
case RETURN_NODE: {
ReturnNode* r = (ReturnNode*)n;
printf("RETURN_STMT\n");
if (r->return_expr) print_node(r->return_expr, l + 1);
break;
}
case PRINT_NODE: {
PrintNode* p = (PrintNode*)n;
printf("PRINT_STMT (Value: \"%s\")\n", p->string_to_print);
break;
}
case CONTINUE_NODE: {
printf("CONTINUE_STMT\n");
break;
}
case BREAK_NODE: {
printf("BREAK_STMT\n");
break;
}
default:
printf("Unknown Node Type: %d\n", n->type);
break;
}
print_node(n->next, l);
}

void print_ast(ASTNode* ast_root) {
printf("\n--- Abstract Syntax Tree ---\n");
print_node(ast_root, 0);
printf("--------------------------\n");
}
22 changes: 17 additions & 5 deletions Compiler-Src/ast_printer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
#ifndef AST_PRINTER_H
#define AST_PRINTER_H
#include "ast.h"
void print_ast(ASTNode* node);
#endif
#ifndef AST_PRINTER_H
#define AST_PRINTER_H

#include "ast.h"

/**
* @brief Prints the Abstract Syntax Tree (AST) recursively.
*
* This function traverses the AST starting from the given root node and prints
* a textual representation of the tree structure to standard output.
* It uses indentation to show the hierarchy of nodes.
*
* @param node The root node of the AST (or subtree) to print.
*/
void print_ast(ASTNode* node);

#endif
Loading