verilog_ast_common.h

Go to the documentation of this file.

#include "stdarg.h"
#include "stdlib.h"
#include "string.h"

#include "verilog_ast_mem.h"

#ifndef VERILOG_AST_COMMON_H
#define VERILOG_AST_COMMON_H


// --------------- Linked List ------------------------

typedef struct ast_list_element_t ast_list_element;

struct ast_list_element_t{
    ast_list_element * next;
    void             * data;
};


typedef struct ast_list_t {
    ast_list_element *  head;         
    ast_list_element *  tail;         
    ast_list_element *  walker;       
    unsigned int        items;        
    unsigned int        current_item; 
} ast_list;


ast_list * ast_list_new ();

void       ast_list_free(ast_list * list);

void       ast_list_append(ast_list * list, void * data);


void       ast_list_preappend(ast_list * list, void * data);

void *    ast_list_get(ast_list * list, unsigned int item);

void      ast_list_remove_at(ast_list * list, unsigned int i);

ast_list *    ast_list_concat(ast_list * head, ast_list * tail);


int ast_list_contains(
    ast_list * list,
    void * data
);


// ----------------------- Stack --------------------------------------

typedef struct ast_stack_element_t ast_stack_element;

struct ast_stack_element_t{
    ast_stack_element * next;
    void             * data;
};

typedef struct ast_stack_t{
    unsigned int          depth; 
    ast_stack_element   * items; 
} ast_stack;

ast_stack * ast_stack_new();

void ast_stack_free(ast_stack * stack);

void ast_stack_push(
    ast_stack * stack,
    void      * item
);

void * ast_stack_pop(
    ast_stack * stack
);

void * ast_stack_peek(
    ast_stack * stack
);

void * ast_stack_peek2(
    ast_stack * stack
);

// ----------------------- Hash Table ---------------------------------


typedef struct ast_hashtable_element_t{
    char * key; 
    void * data;    
} ast_hashtable_element;


typedef struct ast_hashtable_t{
    ast_list * elements; 
    unsigned int size;   
} ast_hashtable;

typedef enum ast_hashtable_result_e{
    HASH_SUCCESS        = 0,
    HASH_FAIL           = 1,
    HASH_KEY_COLLISION  = 2,
    HASH_KEY_NOT_FOUND  = 3
} ast_hashtable_result;

ast_hashtable * ast_hashtable_new();

void  ast_hashtable_free(
    ast_hashtable * table  
);

ast_hashtable_result ast_hashtable_insert(
    ast_hashtable * table, 
    char          * key,   
    void          * value  
);

ast_hashtable_result ast_hashtable_get(
    ast_hashtable * table, 
    char          * key,   
    void         ** value  
);

ast_hashtable_result ast_hashtable_delete(
    ast_hashtable * table, 
    char          * key    
);

ast_hashtable_result ast_hashtable_update(
    ast_hashtable * table, 
    char          * key,   
    void          * value  
);

#endif