verilog_preprocessor.h

Go to the documentation of this file.

#include <assert.h>
#include <stdio.h>
#include <stdlib.h>

#include "verilog_ast.h"
#include "verilog_ast_common.h"

#ifndef VERILOG_PREPROCESSOR_H
#define VERILOG_PREPROCESSOR_H

// ----------------------- Default Net Type Directives ------------------

typedef struct verilog_default_net_type_t{
    unsigned int token_number;  
    unsigned int line_number;   
    ast_net_type type;          
} verilog_default_net_type;

verilog_default_net_type * verilog_new_default_net_type(
    unsigned int token_number,  
    unsigned int line_number,   
    ast_net_type type           
);

// ----------------------- Line Directives ------------------------------

typedef struct verilog_line_directive_t{
    unsigned int  line;  
    char *        file;  
    unsigned char level; 
} verilog_line_directive;

// ----------------------- Timescale Directives -------------------------

typedef struct verilog_timescale_directive_t{
    char * scale;       
    char * precision;   
} verilog_timescale_directive;

// ----------------------- resetall directives --------------------------

void verilog_preprocessor_resetall();

// ----------------------- Connected Drive Directives -------------------

void verilog_preprocessor_nounconnected_drive(
    ast_primitive_strength direction;
);

// ----------------------- Include Directives ---------------------------

typedef struct verilog_include_directive_t{
    char       * filename;      
    unsigned int lineNumber;    
    ast_boolean  file_found;    
} verilog_include_directive;

verilog_include_directive * verilog_preprocessor_include(
    char * filename,        //<! The file to include.
    unsigned int lineNumber 
);

// ----------------------- `define Directives ---------------------------

typedef struct verilog_macro_directive_t{
    unsigned int line;      
    char * macro_id;        
    char * macro_value;     
} verilog_macro_directive;

void verilog_preprocessor_macro_define(
    unsigned int line,  
    char * macro_name,  
    char * macro_text,  
    size_t text_len     
);
    
void verilog_preprocessor_macro_undefine(
    char * macro_name 
);

// ----------------------- Conditional Compilation Directives -----------

typedef struct verilog_preprocessor_conditional_context_t{
    char        * condition;           
    int           line_number;         
    ast_boolean   condition_passed;    
    ast_boolean   is_ndef;             
    ast_boolean   wait_for_endif;      
} verilog_preprocessor_conditional_context;

verilog_preprocessor_conditional_context * 
    verilog_preprocessor_new_conditional_context(
    char        * condition,          
    int           line_number         
);

void verilog_preprocessor_ifdef (
    char * macro_name,
    unsigned int lineno,    
    ast_boolean is_ndef     
);

void verilog_preprocessor_elseif(char * macro_name, unsigned int lineno);

void verilog_preprocessor_else  (unsigned int lineno);

void verilog_preprocessor_endif (unsigned int lineno);


// ----------------------- Preprocessor Context -------------------------

/*
@brief Stores all of the contextual information used by the pre-processor.
@details Stores things like:
- Macro names and evaluations.
- Default net types.
- In Cell Defines.
- IF/ELSE pre-processor directives.
- Timescale directives
*/
typedef struct verilog_preprocessor_context_t{
    ast_boolean     emit;           
    unsigned int    token_count;    
    ast_boolean     in_cell_define; 

    char *          scratch;        
    
    ast_stack     * current_file;   
    ast_hashtable * macrodefines;   
    ast_list      * includes;       
    ast_list      * net_types;      
    verilog_timescale_directive timescale; 
    ast_primitive_strength unconnected_drive_pull; 
    ast_stack     * ifdefs;         
    ast_list      * search_dirs;    
} verilog_preprocessor_context;


extern verilog_preprocessor_context * yy_preproc;


verilog_preprocessor_context * verilog_new_preprocessor_context();

void verilog_preprocessor_set_file(
    verilog_preprocessor_context * preproc,
    char * file
);

char * verilog_preprocessor_current_file(
    verilog_preprocessor_context * preproc
);

void verilog_free_preprocessor_context(
    verilog_preprocessor_context * tofree
);


void verilog_preproc_enter_cell_define();


void verilog_preproc_exit_cell_define();

void verilog_preproc_default_net(
    unsigned int token_number,  
    unsigned int line_number,   
    ast_net_type type           
);

#endif