parser.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "genC.h"
#include "linear.h"
#include "ri.h"
#include "ri-util.h"
#include "parser_private.h"
#include "syntax.h"
#include "resources.h"
#include "database.h"
#include "misc.h"
#include "pipsdbm.h"

Include dependency graph for parser.c:

Go to the source code of this file.

Functions
void	reset_current_label_string ()
string	get_current_label_string ()
void	set_current_label_string (string ln)
bool	empty_current_label_string_p ()
static void	reset_parser_recursive_call ()
	Safety for recursive calls of parser required to process entries. More...
static void	set_parser_recursive_call ()
bool	ParserError (const char *f, const char *m)
void	BeginingOfParsing ()
	this function is called for each new file (FI: once?) FI: I do not understand how this works. More...
static bool	the_actual_parser (string module, string dbr_file)
	parse "module.dbr_file" More...
bool	hpfc_parser (const string module)
	parser for HPFC. More...
bool	parser (const string module)
void	init_parser_properties (void)

Variables
char *	CurrentFN = NULL
	Pre-parser for Fortran syntax idiosyncrasy. More...
cons *	FormalParameters = NIL
	the current function More...
const char *	CurrentPackage = NULL
	the name of the current package, i.e. More...
int	line_b_I
	Indicates where the current instruction (in fact statement) starts and ends in the input file and gives its label. More...
int	line_e_I
int	line_b_C
int	line_e_C
char	lab_I [6]
char	FormatValue [FORMATLENGTH]
	a string that will contain the value of the format in case of format statement More...
static bool	parser_recursive_call = false
bool	InParserError = false
	Parser error handling. More...

Function Documentation

BeginingOfParsing()

void BeginingOfParsing

(

void

)

this function is called for each new file (FI: once?) FI: I do not understand how this works.

It has an effect only once during a pips process lifetime. The error handling routine resets CurrentPackage to NULL, as it is when the pips process is started.

Should I:

A modify the error handling routine to reset CurrentPackage to TOP_LEVEL_MODULE_NAME?

B reset CurrentPackage to TOP_LEVEL_MODULE_NAME each time the parser is entered?

I choose A.

the current package is initialized

Definition at line 208 of file parser.c.

{
    static bool called = false;
 
    if (called)
        return;
 
    /* the current package is initialized */
    CurrentPackage = TOP_LEVEL_MODULE_NAME;
    called = true;
}

References CurrentPackage, and TOP_LEVEL_MODULE_NAME.

Referenced by the_actual_parser().

Here is the caller graph for this function:

empty_current_label_string_p()

bool empty_current_label_string_p

(

void

)

Definition at line 87 of file parser.c.

{
    bool empty_p = same_string_p(lab_I, "");
 
    return empty_p;
}

References lab_I, and same_string_p.

Referenced by MakeElseInst().

Here is the caller graph for this function:

get_current_label_string()

string get_current_label_string

(

void

)

Definition at line 76 of file parser.c.

{
    return lab_I;
}

References lab_I.

Referenced by MakeElseInst().

Here is the caller graph for this function:

hpfc_parser()

bool hpfc_parser

(

const string

module

)

parser for HPFC.

just a different input file not to touch the original source file. this parser should be selected/activated automatically.

Parameters

module

odule

Definition at line 286 of file parser.c.

{
    return the_actual_parser(module, DBR_HPFC_FILTERED_FILE);
}

References module, and the_actual_parser().

Here is the call graph for this function:

init_parser_properties()

void init_parser_properties

(

void

)

Definition at line 296 of file parser.c.

{
  init_parser_reader_properties();
}

References init_parser_reader_properties().

Referenced by the_actual_parser().

Here is the call graph for this function:

Here is the caller graph for this function:

parser()

bool parser

(

const string

module

)

Parameters

module

odule

Definition at line 291 of file parser.c.

{
    return the_actual_parser(module, DBR_SOURCE_FILE);
}

References module, and the_actual_parser().

Here is the call graph for this function:

ParserError()

bool ParserError	(	const char *	f,
		const char *	m
	)

Maybe a routine called by ParserError() may call ParserError() e.g. AbortOfProcedure() thru remove_ghost_variables()

Get rid of partly declared variables...

Callers may already have pointers towards this function. The prettyprinter core dumps if entity_initial is destroyed. Maybe, I should clean the declarations field in code, as well as decls_text.

The error may occur before the current module entity is defined

GetChar() will reinitialize its own buffer when called

Because of the strange behavior of BeginingOfParsing

CurrentPackage = NULL;

Too bad for memory leak...

FI: let catch_error() take care of this in pipsmake since debug_on() was not activated in ParserError

debug_off();

Should never be executed

Definition at line 116 of file parser.c.

{
    entity mod = get_current_module_entity();
 
    /* Maybe a routine called by ParserError() may call ParserError()
     * e.g. AbortOfProcedure() thru remove_ghost_variables()
     */
    if(InParserError)
        return false;
 
    InParserError = true;
 
    uses_alternate_return(false);
    ResetReturnCodeVariable();
    SubstituteAlternateReturns("NO");
 
    syn_reset_lex();
 
    ResetBlockStack();
 
    /* Get rid of partly declared variables... */
    if(mod!=entity_undefined) {
        /* Callers may already have pointers towards this function.
         * The prettyprinter core dumps if entity_initial is
         * destroyed. Maybe, I should clean the declarations field
         * in code, as well as decls_text.
         */
        /*
        entity_type(mod) = type_undefined;
        entity_storage(mod) = storage_undefined;
        entity_initial(mod) = value_undefined;
        */
        value v = entity_initial(mod);
        code c = value_code(v);
        code_declarations(c) = NIL;
        code_decls_text(c) = string_undefined;
 
        CleanLocalEntities(mod);
    }
 
    /* The error may occur before the current module entity is defined */
    error_reset_current_module_entity();
    safe_fclose(syn_in, CurrentFN);
    free(CurrentFN);
    CurrentFN = NULL;
 
    /* GetChar() will reinitialize its own buffer when called */
 
    /* Because of the strange behavior of BeginingOfParsing*/
    /* CurrentPackage = NULL; */
    CurrentPackage = TOP_LEVEL_MODULE_NAME;
    /* Too bad for memory leak... */
    DynamicArea = entity_undefined;
    StaticArea = entity_undefined;
    HeapArea = entity_undefined;
    reset_common_size_map_on_error();
    parser_reset_all_reader_buffers();
    parser_reset_StmtHeap_buffer();
    reset_parser_recursive_call();
    soft_reset_alternate_returns();
    ResetChains();
    AbortEntries();
    AbortOfProcedure();
 
    InParserError = false;
 
    /* FI: let catch_error() take care of this in pipsmake since debug_on()
       was not activated in ParserError */
    /* debug_off(); */
    user_error(f,"Parser error between lines %d and %d\n%s\n",
               line_b_I,line_e_I,m);
 
    /* Should never be executed */
    return true;
}

References AbortEntries(), AbortOfProcedure(), CleanLocalEntities(), code_declarations, code_decls_text, CurrentFN, CurrentPackage, DynamicArea, entity_initial, entity_undefined, error_reset_current_module_entity(), f(), free(), get_current_module_entity(), HeapArea, InParserError, line_b_I, line_e_I, NIL, parser_reset_all_reader_buffers(), parser_reset_StmtHeap_buffer(), reset_common_size_map_on_error(), reset_parser_recursive_call(), ResetBlockStack(), ResetChains(), ResetReturnCodeVariable(), safe_fclose(), soft_reset_alternate_returns(), StaticArea, string_undefined, SubstituteAlternateReturns(), syn_in, syn_reset_lex(), TOP_LEVEL_MODULE_NAME, user_error, uses_alternate_return(), and value_code.

Referenced by AddVariableToCommon(), AnalyzeData(), CapitalizeStmt(), check_in_declarations(), CheckAndInitializeStmt(), CheckParenthesis(), ComputeAddresses(), DeclareExternalFunction(), DeclarePointer(), DeclareVariable(), EndOfProcedure(), EvalCall(), EvalSyntax(), expression_reference_number(), find_target_position(), fix_if_condition(), fix_storage(), FortranExpressionList(), IsCapKeyword(), LinkInstToCurrentBlock(), make_Fortran_constant_entity(), MakeAssignInst(), MakeAtom(), MakeCurrentFunction(), MakeDataValueSet(), MakeElseInst(), MakeEnddoInst(), MakeEndifInst(), MakeEntryCommon(), MakeEquivAtom(), MakeFormalParameter(), MakeFortranBinaryCall(), MakeFortranType(), MakeFortranUnaryCall(), MakeParameter(), MakeSimpleIoInst1(), MakeSimpleIoInst2(), MakeStatement(), MakeVariableStatic(), NeedKeyword(), NewStmt(), parser_add_a_macro(), PopBlock(), process_static_initialization(), process_value_list(), PushBlock(), ReadLine(), ReadStmt(), remove_ghost_variable_entities(), reset_common_size_map(), SafeSizeOfArray(), SaveChains(), SaveEntity(), store_initial_value(), SubstituteAlternateReturns(), TypeFunctionalEntity(), update_called_modules(), update_functional_type_result(), uses_alternate_return(), and ValueOfIthLowerBound().

Here is the call graph for this function:

reset_current_label_string()

void reset_current_label_string

(

void

)

Definition at line 71 of file parser.c.

{
    strcpy(lab_I, "");
}

References lab_I.

Referenced by LinkInstToCurrentBlock(), and MakeElseInst().

Here is the caller graph for this function:

reset_parser_recursive_call()

static void reset_parser_recursive_call ( )

static

Safety for recursive calls of parser required to process entries.

Definition at line 101 of file parser.c.

{
    parser_recursive_call = false;
}

References parser_recursive_call.

Referenced by ParserError(), and the_actual_parser().

Here is the caller graph for this function:

set_current_label_string()

void set_current_label_string

(

string

ln

)

Parameters

ln

n

Definition at line 81 of file parser.c.

{
    pips_assert("Label name is at most 5 characters long", strlen(ln)<=5);
    strcpy(lab_I, ln);
}

References lab_I, and pips_assert.

Referenced by MakeElseInst().

Here is the caller graph for this function:

set_parser_recursive_call()

static void set_parser_recursive_call ( )

static

Definition at line 106 of file parser.c.

{
    parser_recursive_call = false;
}

References parser_recursive_call.

Referenced by the_actual_parser().

Here is the caller graph for this function:

the_actual_parser()

static bool the_actual_parser ( string  module, string  dbr_file  )

static

parse "module.dbr_file"

set up parser properties

parser is initialized

scanner is initialized

yacc parser is called

Handle the special case for entries without looping forever

The requested parsed code may have been an entry code. Then it is not yet computed because the parsed code for the module was produced and only a file resource was produced for the entry code.

This debug_off() occurs too late since pipsdbm has been called before. Initially, the parser was designed to parse more than one subroutine/function/program at a time.

Definition at line 223 of file parser.c.

{
    string dir;
    debug_on("SYNTAX_DEBUG_LEVEL");
 
    /* set up parser properties */
    init_parser_properties();
    parser_init_macros_support();
 
    /* parser is initialized */
    BeginingOfParsing();
 
    /* scanner is initialized */
    ScanNewFile();
 
    pips_assert("CurrentFN is NULL", CurrentFN==NULL);
    dir = db_get_current_workspace_directory();
    CurrentFN =
        strdup(concatenate(dir, "/",
                           db_get_file_resource(dbr_file, module, true), 0));
    free(dir);
 
    /* yacc parser is called */
    syn_in = safe_fopen(CurrentFN, "r");
    syn_parse();
    safe_fclose(syn_in, CurrentFN);
    free(CurrentFN);
    CurrentFN = NULL;
 
    /* Handle the special case for entries without looping forever */
    if(!parser_recursive_call) {
        if(!EmptyEntryListsP()) {
            /* The requested parsed code may have been an entry code. Then it
             * is not yet computed because the parsed code for the module was
             * produced and only a file resource was produced for the entry code.
             */
            ResetEntries();
            if(!db_resource_p(DBR_PARSED_CODE, module)) {
                set_parser_recursive_call();
                the_actual_parser(module, dbr_file);
                reset_parser_recursive_call();
            }
        }
    }
    else {
        if(!EmptyEntryListsP()) {
            pips_internal_error("Unexpected entry handling in parser recursive call");
        }
    }
 
    /* This debug_off() occurs too late since pipsdbm has been called
     * before. Initially, the parser was designed to parse more than
     * one subroutine/function/program at a time.  */
    debug_off();
 
    return true;
}

References BeginingOfParsing(), concatenate(), CurrentFN, db_get_current_workspace_directory(), db_get_file_resource, db_resource_p(), debug_off, debug_on, EmptyEntryListsP(), free(), init_parser_properties(), module, parser_init_macros_support(), parser_recursive_call, pips_assert, pips_internal_error, reset_parser_recursive_call(), ResetEntries(), safe_fclose(), safe_fopen(), ScanNewFile(), set_parser_recursive_call(), strdup(), syn_in, and syn_parse().

Referenced by hpfc_parser(), and parser().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CurrentFN

char* CurrentFN = NULL

Pre-parser for Fortran syntax idiosyncrasy.

parser.c

name of the current file

Definition at line 49 of file parser.c.

Referenced by check_first_statement(), dump_current_statement(), ParserError(), and the_actual_parser().

CurrentPackage

const char* CurrentPackage = NULL

the name of the current package, i.e.

TOP-LEVEL or a module name?

Definition at line 58 of file parser.c.

Referenced by BeginingOfParsing(), EndOfProcedure(), get_use_entities_list(), gfc2pips_add_to_callees(), InitAreas(), MakeCurrentFunction(), MakeLabel(), NameToFunctionalEntity(), ParserError(), and update_common_sizes().

FormalParameters

cons* FormalParameters = NIL

the current function

entity CurrentFunction; list of formal parameters of the current function

Definition at line 55 of file parser.c.

Referenced by EndOfProcedure(), and ScanFormalParameters().

FormatValue

char FormatValue[FORMATLENGTH]

a string that will contain the value of the format in case of format statement

Definition at line 95 of file parser.c.

InParserError

bool InParserError = false

Parser error handling.

Definition at line 113 of file parser.c.

Referenced by ParserError().

lab_I

char lab_I[6]

Definition at line 69 of file parser.c.

Referenced by empty_current_label_string_p(), EndOfProcedure(), GenerateReturn(), get_current_label_string(), LinkInstToCurrentBlock(), MakeEnddoInst(), ReadStmt(), reset_current_label_string(), and set_current_label_string().

line_b_C

int line_b_C

Definition at line 68 of file parser.c.

Referenced by check_first_statement(), and set_first_format_statement().

line_b_I

int line_b_I

Indicates where the current instruction (in fact statement) starts and ends in the input file and gives its label.

Temporary versions of these variables are used because of the pipeline existing between the reader and the actual parser. The names of the temporary variables are prefixed with "tmp_". The default and reset values of these variables and their temporary versions (declared in reader.c) must be consistent.

Definition at line 68 of file parser.c.

Referenced by add_alternate_return(), AddVariableToCommon(), check_first_statement(), DeclarePointer(), DeclareVariable(), dump_current_statement(), fix_if_condition(), implied_do_reference_number(), MakeReturn(), MakeWhileDoInst(), ParserError(), ReadStmt(), set_first_format_statement(), update_functional_type_with_actual_arguments(), and uses_alternate_return().

line_e_C

int line_e_C

Definition at line 68 of file parser.c.

line_e_I

int line_e_I

Definition at line 68 of file parser.c.

Referenced by add_alternate_return(), AddVariableToCommon(), DeclarePointer(), DeclareVariable(), fix_if_condition(), implied_do_reference_number(), MakeReturn(), MakeWhileDoInst(), ParserError(), update_functional_type_with_actual_arguments(), and uses_alternate_return().

parser_recursive_call

bool parser_recursive_call = false

static

Definition at line 98 of file parser.c.

Referenced by reset_parser_recursive_call(), set_parser_recursive_call(), and the_actual_parser().