Add support for functions returning VOID (i.e. non-standard extension, allowing functions that do not return any data)
/*
* matiec - a compiler for the programming languages defined in IEC 61131-3
*
* Copyright (C) 2003-2011 Mario de Sousa (msousa@fe.up.pt)
* Copyright (C) 2007-2011 Laurent Bessard and Edouard Tisserant
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* This code is made available on the understanding that it will not be
* used in safety-critical situations without a full and competent review.
*/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/* Returns the data type of an il_operand.
*
* Note that the il_operand may be a variable, in which case
* we return the type of the variable instance.
* The il_operand may also be a constant, in which case
* we return the data type of that constant.
*
* The variable instance may be a member of a structured variable,
* or an element in an array, or any combination of the two.
*
* The class constructor must be given the search scope
* (function, function block or program within which
* the possible il_operand variable instance was declared).
*/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/* A new class to ouput the IL implicit variable to c++ code
* We use this class, inheriting from symbol_c, so it may be used
* as any other symbol_c object in the intermediate parse tree,
* more specifically, so it can be used as any other il operand.
* This makes the rest of the code much easier...
*
* Nevertheless, the basic visitor class visitor_c does not know
* how to visit this new il_default_variable_c class, so we have
* to extend that too.
* In reality extending the basic symbols doesn't quite work out
* as cleanly as desired (we need to use dynamic_cast in the
* accept method of the il_default_variable_c), but it is cleaner
* than the alternative...
*/
class il_default_variable_c;
/* This visitor class is not really required, we could place the
* visit() method directly in genertae_cc_il_c, but doing it in
* a seperate class makes the architecture more evident...
*/
class il_default_variable_visitor_c {
public:
virtual void *visit(il_default_variable_c *symbol) = 0;
virtual ~il_default_variable_visitor_c(void) {return;}
};
/* A class to print out to the resulting C++ code
* the IL implicit variable name.
*
* It includes a reference to its name,
* and the data type of the data currently stored
* in this C++ variable... This is required because the
* C++ variable is a union, and we must know which member
* of the union top reference!!
*
* Note that we also need to keep track of the data type of
* the value currently being stored in the IL implicit variable.
* This is required so we can process parenthesis,
*
* e.g. :
* LD var1
* AND (
* LD var2
* OR var3
* )
*
* Note that we only execute the 'AND (' operation when we come across
* the ')', i.e. once we have evaluated the result of the
* instructions inside the parenthesis.
* When we do execute the 'AND (' operation, we need to know the data type
* of the operand, which in this case is the result of the evaluation of the
* instruction list inside the parenthesis. We can only know this if we
* keep track of the data type currently stored in the IL implicit variable!
*
* We use the current_type inside the generate_c_il::default_variable_name variable
* to track this!
*/
class il_default_variable_c: public symbol_c {
public:
symbol_c *var_name; /* in principle, this should point to an indentifier_c */
public:
il_default_variable_c(const char *var_name_str, symbol_c *current_type);
virtual void *accept(visitor_c &visitor);
};
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
/***********************************************************************/
class generate_c_il_c: public generate_c_base_and_typeid_c, il_default_variable_visitor_c {
public:
typedef enum {
expression_vg,
assignment_vg,
complextype_base_vg,
complextype_base_assignment_vg,
complextype_suffix_vg,
fparam_output_vg
} variablegeneration_t;
private:
/* Label to which the current IL jump operation should jump to... */
/* This variable is used to pass data from the
* il_jump_operation_c visitor
* to the il jump operator visitors (i.e. JMP_operator_c,
* JMPC_operator_c, JMPCN_operator_c, ...)
*/
symbol_c *jump_label;
/* the data type of the IL implicit variable... */
#define IL_DEFVAR_T VAR_LEADER "IL_DEFVAR_T"
/* The name of the IL implicit variable... */
#define IL_DEFVAR VAR_LEADER "IL_DEFVAR"
/* The name of the variable used to pass the result of a
* parenthesised instruction list to the immediately preceding
* scope ...
*/
#define IL_DEFVAR_BACK VAR_LEADER "IL_DEFVAR_BACK"
il_default_variable_c implicit_variable_current; /* the current implicit variable, with the datatype resulting from the previous IL operation */
il_default_variable_c implicit_variable_result; /* the resulting implicit variable, with the datatype resulting from the current IL operation */
il_default_variable_c implicit_variable_result_back;
/* Operand to the IL operation currently being processed... */
/* These variables are used to pass data from the
* il_simple_operation_c and il_expression_c visitors
* to the il operator visitors (i.e. LD_operator_c,
* LDN_operator_c, ST_operator_c, STN_operator_c, ...)
*/
symbol_c *current_operand;
/* When calling a function block, we must first find it's type,
* by searching through the declarations of the variables currently
* in scope.
* This class does just that...
* A new class is instantiated whenever we begin generating the code
* for a function block type declaration, or a program declaration.
* This object instance will then later be called while the
* function block's or the program's body is being handled.
*
* Note that functions cannot contain calls to function blocks,
* so we do not create an object instance when handling
* a function declaration.
*/
search_fb_instance_decl_c *search_fb_instance_decl;
search_varfb_instance_type_c *search_varfb_instance_type;
search_var_instance_decl_c *search_var_instance_decl;
symbol_c* current_array_type;
symbol_c* current_param_type;
int fcall_number;
symbol_c *fbname;
variablegeneration_t wanted_variablegeneration;
public:
generate_c_il_c(stage4out_c *s4o_ptr, symbol_c *name, symbol_c *scope, const char *variable_prefix = NULL)
: generate_c_base_and_typeid_c(s4o_ptr),
implicit_variable_current (IL_DEFVAR, NULL),
implicit_variable_result (IL_DEFVAR, NULL),
implicit_variable_result_back(IL_DEFVAR_BACK, NULL)
{
search_fb_instance_decl = new search_fb_instance_decl_c (scope);
search_varfb_instance_type = new search_varfb_instance_type_c(scope);
search_var_instance_decl = new search_var_instance_decl_c (scope);
current_operand = NULL;
current_array_type = NULL;
current_param_type = NULL;
fcall_number = 0;
fbname = name;
wanted_variablegeneration = expression_vg;
this->set_variable_prefix(variable_prefix);
}
virtual ~generate_c_il_c(void) {
delete search_fb_instance_decl;
delete search_varfb_instance_type;
delete search_var_instance_decl;
}
void generate(instruction_list_c *il) {
il->accept(*this);
}
private:
/* Declare an implicit IL variable... */
void declare_implicit_variable(il_default_variable_c *implicit_var) {
s4o.print(s4o.indent_spaces);
s4o.print(IL_DEFVAR_T);
s4o.print(" ");
implicit_var->datatype = NULL;
implicit_var->accept(*this);
s4o.print(";\n");
}
public:
/* Declare the default variable, that will store the result of the IL operations */
void declare_implicit_variable(void) {
declare_implicit_variable(&this->implicit_variable_result);
}
/* Declare the backup to the default variable, that will store the result of the IL operations executed inside a parenthesis... */
void declare_implicit_variable_back(void) {
declare_implicit_variable(&this->implicit_variable_result_back);
}
void print_implicit_variable_back(void) {
this->implicit_variable_result_back.accept(*this);
}
private:
/* a small helper function */
symbol_c *default_literal_type(symbol_c *symbol) {
if (get_datatype_info_c::is_ANY_INT_literal(symbol)) {
return &get_datatype_info_c::lint_type_name;
}
else if (get_datatype_info_c::is_ANY_REAL_literal(symbol)) {
return &get_datatype_info_c::lreal_type_name;
}
return symbol;
}
/* A helper function... */
void *XXX_operator(symbol_c *lo, const char *op, symbol_c *ro) {
if ((NULL == lo) || (NULL == ro) || (NULL == op)) ERROR;
lo->accept(*this);
s4o.print(op);
ro->accept(*this);
return NULL;
}
/* A helper function... */
void *XXX_function(symbol_c *res, const char *func, symbol_c *lo, symbol_c *ro) {
if ((NULL == res) || (NULL == lo) || (NULL == ro)) ERROR;
if (NULL == func) ERROR;
res->accept(*this);
s4o.print(" = ");
s4o.print(func);
s4o.print("(");
lo->accept(*this);
s4o.print(", ");
ro->accept(*this);
s4o.print(")");
return NULL;
}
/* A helper function... used for implicit FB calls: S1, R1, CLK, CU, CD, PV, IN, and PT */
void *XXX_CAL_operator(const char *param_name, symbol_c *fb_name) {
if (wanted_variablegeneration != expression_vg) {
s4o.print(param_name);
return NULL;
}
if (NULL == fb_name) ERROR;
symbolic_variable_c *sv = dynamic_cast<symbolic_variable_c *>(fb_name);
if (NULL == sv) ERROR;
identifier_c *id = dynamic_cast<identifier_c *>(sv->var_name);
if (NULL == id) ERROR;
identifier_c param(param_name);
//SYM_REF3(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list)
il_assign_operator_c il_assign_operator(¶m);
il_param_assignment_c il_param_assignment(&il_assign_operator, &this->implicit_variable_current, NULL);
// SYM_LIST(il_param_list_c)
il_param_list_c il_param_list;
il_param_list.add_element(&il_param_assignment);
CAL_operator_c CAL_operator;
// SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list)
il_fb_call_c il_fb_call(&CAL_operator, id, NULL, &il_param_list);
il_fb_call.accept(*this);
return NULL;
}
/* A helper function... */
void *CMP_operator(symbol_c *operand, const char *operation) {
if (NULL == operand) ERROR;
if (NULL == operand->datatype) ERROR;
if (NULL == this->implicit_variable_current.datatype) ERROR;
this->implicit_variable_result.accept(*this);
s4o.print(" = ");
// print_compare_function is in generate_c_base_c, which is inherited by generate_c_il_c
print_compare_function(operation, operand->datatype, &(this->implicit_variable_current), operand);
return NULL;
}
/* A helper function... */
void C_modifier(void) {
if (!get_datatype_info_c::is_BOOL_compatible(implicit_variable_current.datatype)) ERROR;
s4o.print("if (");
this->implicit_variable_current.accept(*this);
s4o.print(") ");
}
/* A helper function... */
void CN_modifier(void) {
if (!get_datatype_info_c::is_BOOL_compatible(implicit_variable_current.datatype)) ERROR;
s4o.print("if (!");
this->implicit_variable_current.accept(*this);
s4o.print(") ");
}
void *print_getter(symbol_c *symbol) {
unsigned int vartype = search_var_instance_decl->get_vartype(symbol);
if (wanted_variablegeneration == fparam_output_vg) {
if (vartype == search_var_instance_decl_c::external_vt) {
if (!get_datatype_info_c::is_type_valid (symbol->datatype)) ERROR;
if ( get_datatype_info_c::is_function_block(symbol->datatype))
s4o.print(GET_EXTERNAL_FB_BY_REF);
else
s4o.print(GET_EXTERNAL_BY_REF);
}
else if (vartype == search_var_instance_decl_c::located_vt)
s4o.print(GET_LOCATED_BY_REF);
else
s4o.print(GET_VAR_BY_REF);
}
else {
if (vartype == search_var_instance_decl_c::external_vt) {
if (!get_datatype_info_c::is_type_valid (symbol->datatype)) ERROR;
if ( get_datatype_info_c::is_function_block(symbol->datatype))
s4o.print(GET_EXTERNAL_FB);
else
s4o.print(GET_EXTERNAL);
}
else if (vartype == search_var_instance_decl_c::located_vt)
s4o.print(GET_LOCATED);
else
s4o.print(GET_VAR);
}
s4o.print("(");
variablegeneration_t old_wanted_variablegeneration = wanted_variablegeneration;
wanted_variablegeneration = complextype_base_vg;
symbol->accept(*this);
s4o.print(",");
wanted_variablegeneration = complextype_suffix_vg;
symbol->accept(*this);
s4o.print(")");
wanted_variablegeneration = old_wanted_variablegeneration;
return NULL;
}
void *print_setter(symbol_c* symbol,
symbol_c* type,
symbol_c* value,
symbol_c* fb_symbol = NULL,
symbol_c* fb_value = NULL,
bool negative = false) {
bool type_is_complex = false;
if (fb_symbol == NULL) {
unsigned int vartype = search_var_instance_decl->get_vartype(symbol);
type_is_complex = analyse_variable_c::contains_complex_type(symbol);
if (vartype == search_var_instance_decl_c::external_vt) {
if (!get_datatype_info_c::is_type_valid (symbol->datatype)) ERROR;
if ( get_datatype_info_c::is_function_block(symbol->datatype))
s4o.print(SET_EXTERNAL_FB);
else
s4o.print(SET_EXTERNAL);
}
else if (vartype == search_var_instance_decl_c::located_vt)
s4o.print(SET_LOCATED);
else
s4o.print(SET_VAR);
}
else {
unsigned int vartype = search_var_instance_decl->get_vartype(fb_symbol);
if (vartype == search_var_instance_decl_c::external_vt)
s4o.print(SET_EXTERNAL_FB);
else
s4o.print(SET_VAR);
}
s4o.print("(");
if (fb_symbol != NULL) {
print_variable_prefix();
fb_symbol->accept(*this);
s4o.print(".,");
}
else if (type_is_complex)
wanted_variablegeneration = complextype_base_assignment_vg;
else
wanted_variablegeneration = assignment_vg;
symbol->accept(*this);
/*
s4o.print(",");
if (negative) {
if (get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype))
s4o.print("!");
else
s4o.print("~");
}
wanted_variablegeneration = expression_vg;
print_check_function(type, value, fb_value);
if (type_is_complex) {
s4o.print(",");
wanted_variablegeneration = complextype_suffix_vg;
symbol->accept(*this);
}
s4o.print(")");
wanted_variablegeneration = expression_vg;
return NULL;
*/
s4o.print(",");
if (type_is_complex) {
wanted_variablegeneration = complextype_suffix_vg;
symbol->accept(*this);
}
s4o.print(",");
if (negative) {
if (get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype))
s4o.print("!");
else
s4o.print("~");
}
wanted_variablegeneration = expression_vg;
print_check_function(type, value, fb_value);
s4o.print(")");
wanted_variablegeneration = expression_vg;
return NULL;
}
public:
void *visit(il_default_variable_c *symbol) {
symbol->var_name->accept(*this);
if (NULL != symbol->datatype) {
s4o.print(".");
symbol->datatype->accept(*this);
s4o.print("var");
} return NULL;
}
private:
/********************************/
/* B 1.3.3 - Derived data types */
/********************************/
/* signed_integer DOTDOT signed_integer */
void *visit(subrange_c *symbol) {
symbol->lower_limit->accept(*this);
return NULL;
}
/* ARRAY '[' array_subrange_list ']' OF non_generic_type_name */
void *visit(array_specification_c *symbol) {
symbol->non_generic_type_name->accept(*this);
return NULL;
}
/*********************/
/* B 1.4 - Variables */
/*********************/
void *visit(symbolic_variable_c *symbol) {
unsigned int vartype;
switch (wanted_variablegeneration) {
case complextype_base_assignment_vg:
case assignment_vg:
this->print_variable_prefix();
s4o.print(",");
symbol->var_name->accept(*this);
break;
case complextype_base_vg:
generate_c_base_c::visit(symbol);
break;
case complextype_suffix_vg:
break;
default:
if (this->is_variable_prefix_null()) {
vartype = search_var_instance_decl->get_vartype(symbol);
if (wanted_variablegeneration == fparam_output_vg) {
s4o.print("&(");
generate_c_base_c::visit(symbol);
s4o.print(")");
}
else {
generate_c_base_c::visit(symbol);
}
}
else
print_getter(symbol);
break;
}
return NULL;
}
/********************************************/
/* B.1.4.1 Directly Represented Variables */
/********************************************/
// direct_variable: direct_variable_token {$$ = new direct_variable_c($1);};
void *visit(direct_variable_c *symbol) {
TRACE("direct_variable_c");
/* Do not use print_token() as it will change everything into uppercase */
if (strlen(symbol->value) == 0) ERROR;
if (this->is_variable_prefix_null()) {
if (wanted_variablegeneration != fparam_output_vg)
s4o.print("*(");
}
else {
switch (wanted_variablegeneration) {
case expression_vg:
s4o.print(GET_LOCATED);
s4o.print("(");
break;
case fparam_output_vg:
s4o.print(GET_LOCATED_BY_REF);
s4o.print("(");
break;
default:
break;
}
}
this->print_variable_prefix();
s4o.printlocation(symbol->value + 1);
if ((this->is_variable_prefix_null() && wanted_variablegeneration != fparam_output_vg) ||
wanted_variablegeneration != assignment_vg)
s4o.print(")");
return NULL;
}
/*************************************/
/* B.1.4.2 Multi-element Variables */
/*************************************/
// SYM_REF2(structured_variable_c, record_variable, field_selector)
void *visit(structured_variable_c *symbol) {
TRACE("structured_variable_c");
bool type_is_complex = analyse_variable_c::is_complex_type(symbol->record_variable);
switch (wanted_variablegeneration) {
case complextype_base_vg:
case complextype_base_assignment_vg:
symbol->record_variable->accept(*this);
if (!type_is_complex) {
s4o.print(".");
symbol->field_selector->accept(*this);
}
break;
case complextype_suffix_vg:
symbol->record_variable->accept(*this);
if (type_is_complex) {
s4o.print(".");
symbol->field_selector->accept(*this);
}
break;
case assignment_vg:
symbol->record_variable->accept(*this);
s4o.print(".");
symbol->field_selector->accept(*this);
break;
default:
if (this->is_variable_prefix_null()) {
symbol->record_variable->accept(*this);
s4o.print(".");
symbol->field_selector->accept(*this);
}
else
print_getter(symbol);
break;
}
return NULL;
}
/* subscripted_variable '[' subscript_list ']' */
//SYM_REF2(array_variable_c, subscripted_variable, subscript_list)
void *visit(array_variable_c *symbol) {
switch (wanted_variablegeneration) {
case complextype_base_vg:
case complextype_base_assignment_vg:
symbol->subscripted_variable->accept(*this);
break;
case complextype_suffix_vg:
symbol->subscripted_variable->accept(*this);
current_array_type = search_varfb_instance_type->get_type_id(symbol->subscripted_variable);
if (current_array_type == NULL) ERROR;
s4o.print(".table");
symbol->subscript_list->accept(*this);
current_array_type = NULL;
break;
default:
if (this->is_variable_prefix_null()) {
symbol->subscripted_variable->accept(*this);
current_array_type = search_varfb_instance_type->get_type_id(symbol->subscripted_variable);
if (current_array_type == NULL) ERROR;
s4o.print(".table");
symbol->subscript_list->accept(*this);
current_array_type = NULL;
}
else
print_getter(symbol);
break;
}
return NULL;
}
/* subscript_list ',' subscript */
void *visit(subscript_list_c *symbol) {
array_dimension_iterator_c* array_dimension_iterator = new array_dimension_iterator_c(current_array_type);
for (int i = 0; i < symbol->n; i++) {
symbol_c* dimension = array_dimension_iterator->next();
if (dimension == NULL) ERROR;
s4o.print("[(");
symbol->elements[i]->accept(*this);
s4o.print(") - (");
dimension->accept(*this);
s4o.print(")]");
}
delete array_dimension_iterator;
return NULL;
}
/******************************************/
/* B 1.4.3 - Declaration & Initialisation */
/******************************************/
/* helper symbol for structure_initialization */
/* structure_element_initialization_list ',' structure_element_initialization */
void *visit(structure_element_initialization_list_c *symbol) {
generate_c_structure_initialization_c *structure_initialization = new generate_c_structure_initialization_c(&s4o);
structure_initialization->init_structure_default(this->current_param_type);
structure_initialization->init_structure_values(symbol);
delete structure_initialization;
return NULL;
}
/* helper symbol for array_initialization */
/* array_initial_elements_list ',' array_initial_elements */
void *visit(array_initial_elements_list_c *symbol) {
generate_c_array_initialization_c *array_initialization = new generate_c_array_initialization_c(&s4o);
array_initialization->init_array_size(this->current_param_type);
array_initialization->init_array_values(symbol);
delete array_initialization;
return NULL;
}
/****************************************/
/* B.2 - Language IL (Instruction List) */
/****************************************/
/***********************************/
/* B 2.1 Instructions and Operands */
/***********************************/
/*| instruction_list il_instruction */
void *visit(instruction_list_c *symbol) {
/* Declare the IL implicit variable, that will store the result of the IL operations... */
declare_implicit_variable();
/* Declare the backup to the IL implicit variable, that will store the result of the IL operations executed inside a parenthesis... */
declare_implicit_variable_back();
for(int i = 0; i < symbol->n; i++) {
print_line_directive(symbol->elements[i]);
s4o.print(s4o.indent_spaces);
symbol->elements[i]->accept(*this);
s4o.print(";\n");
}
return NULL;
}
/* | label ':' [il_incomplete_instruction] eol_list */
// SYM_REF2(il_instruction_c, label, il_instruction)
void *visit(il_instruction_c *symbol) {
/* all previous IL instructions should have the same datatype (checked in stage3), so we get the datatype from the first previous IL instruction we find */
implicit_variable_current.datatype = (symbol->prev_il_instruction.empty())? NULL : symbol->prev_il_instruction[0]->datatype;
implicit_variable_result .datatype = symbol->datatype;
if (NULL != symbol->label) {
symbol->label->accept(*this);
s4o.print(":\n");
s4o.print(s4o.indent_spaces);
}
if (NULL != symbol->il_instruction) {
symbol->il_instruction->accept(*this);
}
implicit_variable_result .datatype = NULL;
implicit_variable_current.datatype = NULL;
return NULL;
}
/* | il_simple_operator [il_operand] */
//SYM_REF2(il_simple_operation_c, il_simple_operator, il_operand)
void *visit(il_simple_operation_c *symbol) {
this->current_operand = symbol->il_operand;
symbol->il_simple_operator->accept(*this);
this->current_operand = NULL;
return NULL;
}
/* | function_name [il_operand_list] */
// SYM_REF2(il_function_call_c, function_name, il_operand_list)
void *visit(il_function_call_c *symbol) {
symbol_c* function_type_prefix = NULL;
symbol_c* function_name = NULL;
symbol_c* function_type_suffix = NULL;
DECLARE_PARAM_LIST()
function_call_param_iterator_c function_call_param_iterator(symbol);
function_declaration_c *f_decl = (function_declaration_c *)symbol->called_function_declaration;
if (f_decl == NULL) ERROR;
function_name = symbol->function_name;
/* loop through each function parameter, find the value we should pass
* to it, and then output the c equivalent...
*/
function_param_iterator_c fp_iterator(f_decl);
identifier_c *param_name;
/* flag to remember whether we have already used the value stored in the implicit variable to pass to the first parameter */
bool used_defvar = false;
/* flag to cirreclty handle calls to extensible standard functions (i.e. functions with variable number of input parameters) */
bool found_first_extensible_parameter = false;
for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {
if (fp_iterator.is_extensible_param() && (!found_first_extensible_parameter)) {
/* We are calling an extensible function. Before passing the extensible
* parameters, we must add a dummy paramater value to tell the called
* function how many extensible parameters we will be passing.
*
* Note that stage 3 has already determined the number of extensible
* paramters, and stored that info in the abstract syntax tree. We simply
* re-use that value.
*/
/* NOTE: we are not freeing the malloc'd memory. This is not really a bug.
* Since we are writing a compiler, which runs to termination quickly,
* we can consider this as just memory required for the compilation process
* that will be free'd when the program terminates.
*/
char *tmp = (char *)malloc(32); /* enough space for a call with 10^31 (larger than 2^64) input parameters! */
if (tmp == NULL) ERROR;
int res = snprintf(tmp, 32, "%d", symbol->extensible_param_count);
if ((res >= 32) || (res < 0)) ERROR;
identifier_c *param_value = new identifier_c(tmp);
uint_type_name_c *param_type = new uint_type_name_c();
identifier_c *param_name = new identifier_c("");
ADD_PARAM_LIST(param_name, param_value, param_type, function_param_iterator_c::direction_in)
found_first_extensible_parameter = true;
}
symbol_c *param_type = fp_iterator.param_type();
if (param_type == NULL) ERROR;
function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();
symbol_c *param_value = NULL;
/* Get the value from a foo(<param_name> = <param_value>) style call */
/* NOTE: Since the class il_function_call_c only references a non.formal function call,
* the following line of code is not required in this case. However, it doesn't
* harm to leave it in, as in the case of a non-formal syntax function call,
* it will always return NULL.
* We leave it in in case we later decide to merge this part of the code together
* with the function calling code in generate_c_st_c, which does require
* the following line...
*/
if (param_value == NULL)
param_value = function_call_param_iterator.search_f(param_name);
/* if it is the first parameter in a non-formal function call (which is the
* case being handled!), semantics specifies that we should
* get the value off the IL implicit variable!
*
* However, if the parameter is an implicitly defined EN or ENO parameter, we should not
* use the IL implicit variable as a source of data to pass to those parameters!
*/
if ((param_value == NULL) && (!used_defvar) && !fp_iterator.is_en_eno_param_implicit()) {
if (NULL == implicit_variable_current.datatype) ERROR;
param_value = &this->implicit_variable_current;
used_defvar = true;
}
/* Get the value from a foo(<param_value>) style call */
if ((param_value == NULL) && !fp_iterator.is_en_eno_param_implicit()) {
param_value = function_call_param_iterator.next_nf();
}
/* if no more parameter values in function call, and the current parameter
* of the function declaration is an extensible parameter, we
* have reached the end, and should simply jump out of the for loop.
*/
if ((param_value == NULL) && (fp_iterator.is_extensible_param())) {
break;
}
/* We do not yet support embedded IL lists, so we abort the compiler if we find one */
/* Note that in IL function calls the syntax does not allow embeded IL lists, so this check is not necessary here! */
/*
{simple_instr_list_c *instruction_list = dynamic_cast<simple_instr_list_c *>(param_value);
if (NULL != instruction_list) STAGE4_ERROR(param_value, param_value, "The compiler does not yet support formal invocations in IL that contain embedded IL lists. Aborting!");
}
*/
if ((param_value == NULL) && (param_direction == function_param_iterator_c::direction_in)) {
/* No value given for parameter, so we must use the default... */
/* First check whether default value specified in function declaration...*/
param_value = fp_iterator.default_value();
}
ADD_PARAM_LIST(param_name, param_value, param_type, fp_iterator.param_direction())
} /* for(...) */
if (function_call_param_iterator.next_nf() != NULL) ERROR;
bool has_output_params = false;
if (!this->is_variable_prefix_null()) {
PARAM_LIST_ITERATOR() {
if ((PARAM_DIRECTION == function_param_iterator_c::direction_out ||
PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&
PARAM_VALUE != NULL) {
has_output_params = true;
}
}
}
/* Check whether we are calling an overloaded function! */
/* (fdecl_mutiplicity > 1) => calling overloaded function */
int fdecl_mutiplicity = function_symtable.count(symbol->function_name);
if (fdecl_mutiplicity == 0) ERROR;
/* when function returns a void, we do not store the value in the default variable! */
if (!get_datatype_info_c::is_VOID(symbol->datatype)) {
this->implicit_variable_result.accept(*this);
s4o.print(" = ");
}
if (function_type_prefix != NULL) {
s4o.print("(");
default_literal_type(function_type_prefix)->accept(*this);
s4o.print(")");
}
if (function_type_suffix != NULL) {
function_type_suffix = default_literal_type(function_type_suffix);
}
if (has_output_params) {
fcall_number++;
s4o.print("__");
fbname->accept(*this);
s4o.print("_");
function_name->accept(*this);
if (fdecl_mutiplicity > 1) {
/* function being called is overloaded! */
s4o.print("__");
print_function_parameter_data_types_c overloaded_func_suf(&s4o);
f_decl->accept(overloaded_func_suf);
}
s4o.print(fcall_number);
}
else {
if (function_name != NULL) {
function_name->accept(*this);
if (fdecl_mutiplicity > 1) {
/* function being called is overloaded! */
s4o.print("__");
print_function_parameter_data_types_c overloaded_func_suf(&s4o);
f_decl->accept(overloaded_func_suf);
}
}
if (function_type_suffix != NULL)
function_type_suffix->accept(*this);
}
s4o.print("(");
s4o.indent_right();
s4o.print("\n"+s4o.indent_spaces);
int nb_param = 0;
PARAM_LIST_ITERATOR() {
symbol_c *param_value = PARAM_VALUE;
current_param_type = PARAM_TYPE;
switch (PARAM_DIRECTION) {
case function_param_iterator_c::direction_in:
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
if (param_value == NULL) {
/* If not, get the default value of this variable's type */
param_value = type_initial_value_c::get(current_param_type);
}
if (param_value == NULL) ERROR;
s4o.print("(");
if (get_datatype_info_c::is_ANY_INT_literal(current_param_type))
get_datatype_info_c::lint_type_name.accept(*this);
else if (get_datatype_info_c::is_ANY_REAL_literal(current_param_type))
get_datatype_info_c::lreal_type_name.accept(*this);
else
current_param_type->accept(*this);
s4o.print(")");
print_check_function(current_param_type, param_value);
nb_param++;
break;
case function_param_iterator_c::direction_out:
case function_param_iterator_c::direction_inout:
if (!has_output_params) {
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
if (param_value == NULL) {
s4o.print("NULL");
} else {
wanted_variablegeneration = fparam_output_vg;
param_value->accept(*this);
wanted_variablegeneration = expression_vg;
}
nb_param++;
}
break;
case function_param_iterator_c::direction_extref:
/* TODO! */
ERROR;
break;
} /* switch */
}
if (has_output_params) {
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
s4o.print(FB_FUNCTION_PARAM);
}
s4o.print(")");
s4o.indent_left();
CLEAR_PARAM_LIST()
return NULL;
}
/* | il_expr_operator '(' [il_operand] eol_list [simple_instr_list] ')' */
//SYM_REF4(il_expression_c, il_expr_operator, il_operand, simple_instr_list, unused)
void *visit(il_expression_c *symbol) {
LD_operator_c *tmp_LD_operator = NULL;
il_simple_operation_c *tmp_il_simple_operation = NULL;
il_simple_instruction_c *tmp_il_simple_instruction = NULL;
/* We will be recursevely interpreting an instruction list, so we store a backup of the implicit_variable_result/current.
* Notice that they will be overwriten while processing the parenthsized instruction list.
*/
il_default_variable_c old_implicit_variable_current = this->implicit_variable_current;
il_default_variable_c old_implicit_variable_result = this->implicit_variable_result;
/* Stage2 will insert an artificial (and equivalent) LD <il_operand> to the simple_instr_list if necessary. We can therefore ignore the 'il_operand' entry! */
//if (NULL != symbol->il_operand) { do nothing!! }
/* Now do the parenthesised instructions... */
/* NOTE: the following code line will overwrite the variables implicit_variable_current and implicit_variable_result */
symbol->simple_instr_list->accept(*this);
/* Now do the operation, using the previous result! */
/* NOTE: The result of the previous instruction list in the parenthesis will be stored
* in a variable named IL_DEFVAR_BACK. This is done in the visitor
* to instruction_list_c objects...
*/
this->implicit_variable_result_back.datatype = symbol->simple_instr_list->datatype;
this->current_operand = &(this->implicit_variable_result_back);
this->implicit_variable_current = old_implicit_variable_current;
this->implicit_variable_result = old_implicit_variable_result;
symbol->il_expr_operator->accept(*this);
this->current_operand = NULL;
this->implicit_variable_result_back.datatype = NULL;
return NULL;
}
/* il_jump_operator label */
// SYM_REF2(il_jump_operation_c, il_jump_operator, label)
void *visit(il_jump_operation_c *symbol) {
/* Pass the symbol->label to the il_jump_operation visitor using the jump_label parameter... */
this->jump_label = symbol->label;
symbol->il_jump_operator->accept(*this);
this->jump_label = NULL;
return NULL;
}
/* il_call_operator prev_declared_fb_name
* | il_call_operator prev_declared_fb_name '(' ')'
* | il_call_operator prev_declared_fb_name '(' eol_list ')'
* | il_call_operator prev_declared_fb_name '(' il_operand_list ')'
* | il_call_operator prev_declared_fb_name '(' eol_list il_param_list ')'
*/
// SYM_REF4(il_fb_call_c, il_call_operator, fb_name, il_operand_list, il_param_list)
void *visit(il_fb_call_c *symbol) {
symbol->il_call_operator->accept(*this);
s4o.print("{\n");
s4o.indent_right();
s4o.print(s4o.indent_spaces);
/* first figure out what is the name of the function block type of the function block being called... */
symbol_c *function_block_type_name = this->search_fb_instance_decl->get_type_name(symbol->fb_name);
/* should never occur. The function block instance MUST have been declared... */
if (function_block_type_name == NULL) ERROR;
/* Now find the declaration of the function block type being called... */
function_block_type_symtable_t::iterator iter = function_block_type_symtable.find(function_block_type_name);
if (iter == function_block_type_symtable.end()) ERROR; // The function block type being called MUST be in the symtable.
function_block_declaration_c *fb_decl = iter->second;
/* loop through each function block parameter, find the value we should pass
* to it, and then output the c equivalent...
*/
function_param_iterator_c fp_iterator(fb_decl);
identifier_c *param_name;
function_call_param_iterator_c function_call_param_iterator(symbol);
for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {
function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();
/* Get the value from a foo(<param_name> = <param_value>) style call */
symbol_c *param_value = function_call_param_iterator.search_f(param_name);
/* Get the value from a foo(<param_value>) style call */
/* When using the informal invocation style, user can not pass values to EN or ENO parameters if these
* were implicitly defined!
*/
if ((param_value == NULL) && !fp_iterator.is_en_eno_param_implicit())
param_value = function_call_param_iterator.next_nf();
/* We do not yet support embedded IL lists, so we abort the compiler if we find one */
{simple_instr_list_c *instruction_list = dynamic_cast<simple_instr_list_c *>(param_value);
if (NULL != instruction_list) STAGE4_ERROR(param_value, param_value, "The compiler does not yet support formal invocations in IL that contain embedded IL lists. Aborting!");
}
symbol_c *param_type = fp_iterator.param_type();
if (param_type == NULL) ERROR;
/* now output the value assignment */
if (param_value != NULL)
if ((param_direction == function_param_iterator_c::direction_in) ||
(param_direction == function_param_iterator_c::direction_inout)) {
if (this->is_variable_prefix_null()) {
symbol->fb_name->accept(*this);
s4o.print(".");
param_name->accept(*this);
s4o.print(" = ");
print_check_function(param_type, param_value);
}
else {
print_setter(param_name, param_type, param_value, symbol->fb_name);
}
s4o.print(";\n" + s4o.indent_spaces);
}
} /* for(...) */
/* now call the function... */
function_block_type_name->accept(*this);
s4o.print(FB_FUNCTION_SUFFIX);
s4o.print("(");
if (search_var_instance_decl->get_vartype(symbol->fb_name) != search_var_instance_decl_c::external_vt)
s4o.print("&");
print_variable_prefix();
symbol->fb_name->accept(*this);
s4o.print(")");
/* loop through each function parameter, find the variable to which
* we should atribute the value of all output or inoutput parameters.
*/
fp_iterator.reset();
function_call_param_iterator.reset();
for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {
function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();
/* Get the value from a foo(<param_name> = <param_value>) style call */
symbol_c *param_value = function_call_param_iterator.search_f(param_name);
/* Get the value from a foo(<param_value>) style call */
/* When using the informal invocation style, user can not pass values to EN or ENO parameters if these
* were implicitly defined!
*/
if ((param_value == NULL) && !fp_iterator.is_en_eno_param_implicit())
param_value = function_call_param_iterator.next_nf();
/* now output the value assignment */
if (param_value != NULL)
if ((param_direction == function_param_iterator_c::direction_out) ||
(param_direction == function_param_iterator_c::direction_inout)) {
symbol_c *param_type = search_varfb_instance_type->get_type_id(param_value);
s4o.print(";\n" + s4o.indent_spaces);
if (this->is_variable_prefix_null()) {
param_value->accept(*this);
s4o.print(" = ");
print_check_function(param_type, param_name, symbol->fb_name);
}
else {
print_setter(param_value, param_type, param_name, NULL, symbol->fb_name);
}
}
} /* for(...) */
s4o.print(";\n");
s4o.indent_left();
s4o.print(s4o.indent_spaces);
s4o.print("}");
return NULL;
}
/* | function_name '(' eol_list [il_param_list] ')' */
// SYM_REF2(il_formal_funct_call_c, function_name, il_param_list)
void *visit(il_formal_funct_call_c *symbol) {
symbol_c* function_type_prefix = NULL;
symbol_c* function_name = NULL;
symbol_c* function_type_suffix = NULL;
DECLARE_PARAM_LIST()
function_call_param_iterator_c function_call_param_iterator(symbol);
function_declaration_c *f_decl = (function_declaration_c *)symbol->called_function_declaration;
if (f_decl == NULL) ERROR;
function_name = symbol->function_name;
/* loop through each function parameter, find the value we should pass
* to it, and then output the c equivalent...
*/
function_param_iterator_c fp_iterator(f_decl);
identifier_c *param_name;
/* flag to cirreclty handle calls to extensible standard functions (i.e. functions with variable number of input parameters) */
bool found_first_extensible_parameter = false;
for(int i = 1; (param_name = fp_iterator.next()) != NULL; i++) {
if (fp_iterator.is_extensible_param() && (!found_first_extensible_parameter)) {
/* We are calling an extensible function. Before passing the extensible
* parameters, we must add a dummy paramater value to tell the called
* function how many extensible parameters we will be passing.
*
* Note that stage 3 has already determined the number of extensible
* paramters, and stored that info in the abstract syntax tree. We simply
* re-use that value.
*/
/* NOTE: we are not freeing the malloc'd memory. This is not really a bug.
* Since we are writing a compiler, which runs to termination quickly,
* we can consider this as just memory required for the compilation process
* that will be free'd when the program terminates.
*/
char *tmp = (char *)malloc(32); /* enough space for a call with 10^31 (larger than 2^64) input parameters! */
if (tmp == NULL) ERROR;
int res = snprintf(tmp, 32, "%d", symbol->extensible_param_count);
if ((res >= 32) || (res < 0)) ERROR;
identifier_c *param_value = new identifier_c(tmp);
uint_type_name_c *param_type = new uint_type_name_c();
identifier_c *param_name = new identifier_c("");
ADD_PARAM_LIST(param_name, param_value, param_type, function_param_iterator_c::direction_in)
found_first_extensible_parameter = true;
}
if (fp_iterator.is_extensible_param()) {
/* since we are handling an extensible parameter, we must add the index to the
* parameter name so we can go looking for the value passed to the correct
* extended parameter (e.g. IN1, IN2, IN3, IN4, ...)
*/
char *tmp = (char *)malloc(32); /* enough space for a call with 10^31 (larger than 2^64) input parameters! */
int res = snprintf(tmp, 32, "%d", fp_iterator.extensible_param_index());
if ((res >= 32) || (res < 0)) ERROR;
param_name = new identifier_c(strdup2(param_name->value, tmp));
if (param_name->value == NULL) ERROR;
}
symbol_c *param_type = fp_iterator.param_type();
if (param_type == NULL) ERROR;
function_param_iterator_c::param_direction_t param_direction = fp_iterator.param_direction();
symbol_c *param_value = NULL;
/* Get the value from a foo(<param_name> = <param_value>) style call */
if (param_value == NULL)
param_value = function_call_param_iterator.search_f(param_name);
/* Get the value from a foo(<param_value>) style call */
/* NOTE: the following line of code is not required in this case, but it doesn't
* harm to leave it in, as in the case of a formal syntax function call,
* it will always return NULL.
* We leave it in in case we later decide to merge this part of the code together
* with the function calling code in generate_c_st_c, which does require
* the following line...
*/
if ((param_value == NULL) && !fp_iterator.is_en_eno_param_implicit()) {
param_value = function_call_param_iterator.next_nf();
}
/* if no more parameter values in function call, and the current parameter
* of the function declaration is an extensible parameter, we
* have reached the end, and should simply jump out of the for loop.
*/
if ((param_value == NULL) && (fp_iterator.is_extensible_param())) {
break;
}
/* We do not yet support embedded IL lists, so we abort the compiler if we find one */
{simple_instr_list_c *instruction_list = dynamic_cast<simple_instr_list_c *>(param_value);
if (NULL != instruction_list) STAGE4_ERROR(param_value, param_value, "The compiler does not yet support formal invocations in IL that contain embedded IL lists. Aborting!");
}
if ((param_value == NULL) && (param_direction == function_param_iterator_c::direction_in)) {
/* No value given for parameter, so we must use the default... */
/* First check whether default value specified in function declaration...*/
param_value = fp_iterator.default_value();
}
ADD_PARAM_LIST(param_name, param_value, param_type, fp_iterator.param_direction())
}
if (function_call_param_iterator.next_nf() != NULL) ERROR;
bool has_output_params = false;
if (!this->is_variable_prefix_null()) {
PARAM_LIST_ITERATOR() {
if ((PARAM_DIRECTION == function_param_iterator_c::direction_out ||
PARAM_DIRECTION == function_param_iterator_c::direction_inout) &&
PARAM_VALUE != NULL) {
has_output_params = true;
}
}
}
/* Check whether we are calling an overloaded function! */
/* (fdecl_mutiplicity > 1) => calling overloaded function */
int fdecl_mutiplicity = function_symtable.count(symbol->function_name);
if (fdecl_mutiplicity == 0) ERROR;
if (fdecl_mutiplicity == 1)
/* function being called is NOT overloaded! */
f_decl = NULL;
/* when function returns a void, we do not store the value in the default variable! */
if (!get_datatype_info_c::is_VOID(symbol->datatype)) {
this->implicit_variable_result.accept(*this);
s4o.print(" = ");
}
if (function_type_prefix != NULL) {
s4o.print("(");
default_literal_type(function_type_prefix)->accept(*this);
s4o.print(")");
}
if (function_type_suffix != NULL) {
function_type_suffix = default_literal_type(function_type_suffix);
}
if (has_output_params) {
fcall_number++;
s4o.print("__");
fbname->accept(*this);
s4o.print("_");
function_name->accept(*this);
if (fdecl_mutiplicity > 1) {
/* function being called is overloaded! */
s4o.print("__");
print_function_parameter_data_types_c overloaded_func_suf(&s4o);
f_decl->accept(overloaded_func_suf);
}
s4o.print(fcall_number);
}
else {
if (function_name != NULL) {
function_name->accept(*this);
if (fdecl_mutiplicity > 1) {
/* function being called is overloaded! */
s4o.print("__");
print_function_parameter_data_types_c overloaded_func_suf(&s4o);
f_decl->accept(overloaded_func_suf);
}
}
if (function_type_suffix != NULL)
function_type_suffix->accept(*this);
}
s4o.print("(");
s4o.indent_right();
int nb_param = 0;
PARAM_LIST_ITERATOR() {
symbol_c *param_value = PARAM_VALUE;
current_param_type = PARAM_TYPE;
switch (PARAM_DIRECTION) {
case function_param_iterator_c::direction_in:
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
if (param_value == NULL) {
/* If not, get the default value of this variable's type */
param_value = type_initial_value_c::get(current_param_type);
}
if (param_value == NULL) ERROR;
s4o.print("(");
if (get_datatype_info_c::is_ANY_INT_literal(current_param_type))
get_datatype_info_c::lint_type_name.accept(*this);
else if (get_datatype_info_c::is_ANY_REAL_literal(current_param_type))
get_datatype_info_c::lreal_type_name.accept(*this);
else
current_param_type->accept(*this);
s4o.print(")");
print_check_function(current_param_type, param_value);
nb_param++;
break;
case function_param_iterator_c::direction_out:
case function_param_iterator_c::direction_inout:
if (!has_output_params) {
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
if (param_value == NULL) {
s4o.print("NULL");
} else {
wanted_variablegeneration = fparam_output_vg;
param_value->accept(*this);
wanted_variablegeneration = expression_vg;
}
}
break;
case function_param_iterator_c::direction_extref:
/* TODO! */
ERROR;
break;
} /* switch */
} /* for(...) */
if (has_output_params) {
if (nb_param > 0)
s4o.print(",\n"+s4o.indent_spaces);
s4o.print(FB_FUNCTION_PARAM);
}
// symbol->parameter_assignment->accept(*this);
s4o.print(")");
CLEAR_PARAM_LIST()
return NULL;
}
/* | il_operand_list ',' il_operand */
// SYM_LIST(il_operand_list_c)
void *visit(il_operand_list_c *symbol) {ERROR; return NULL;} // should never get called!
/* | simple_instr_list il_simple_instruction */
// SYM_LIST(simple_instr_list_c)
void *visit(simple_instr_list_c *symbol) {
/* A simple_instr_list_c is used to store a list of il operations being done within parenthesis...
*
* e.g.:
* LD var1
* AND ( var2
* OR var3
* OR var4
* )
*
* NOTE 1:
* This will be converted to C++ by defining a new scope
* with a new il implicit variable, and executing the il operands
* within this new scope.
* At the end of the scope the result, i.e. the value currently stored
* in the il implicit variable is copied to the variable used to take this
* value to the outside scope...
*
* The above example will result in the following C++ code:
* {__IL_DEFVAR_T __IL_DEFVAR_BACK;
* __IL_DEFVAR_T __IL_DEFVAR;
*
* __IL_DEFVAR.INTvar = var1;
* {
* __IL_DEFVAR_T __IL_DEFVAR;
*
* __IL_DEFVAR.INTvar = var2;
* __IL_DEFVAR.INTvar |= var3;
* __IL_DEFVAR.INTvar |= var4;
*
* __IL_DEFVAR_BACK = __IL_DEFVAR;
* }
* __IL_DEFVAR.INTvar &= __IL_DEFVAR_BACK.INTvar;
*
* }
*
* NOTE 2:
* If the intial value of the il implicit variable (in the above
* example 'var2') exists, then stage2 will insert an equivalent
* LD operation into the parenthesized instruction list. This means we do not
* need to do anything here to handle this special situation!
*/
/* Declare the IL implicit variable, that will store the result of the IL operations... */
s4o.print("{\n");
s4o.indent_right();
declare_implicit_variable();
print_list(symbol, s4o.indent_spaces, ";\n" + s4o.indent_spaces, ";\n");
/* copy the result in the IL implicit variable to the variable
* used to pass the data out to the scope enclosing the current scope!
*/
this->implicit_variable_result_back.datatype = symbol->datatype;
this->implicit_variable_result .datatype = symbol->datatype;
s4o.print("\n");
s4o.print(s4o.indent_spaces);
this->implicit_variable_result_back.accept(*this);
s4o.print(" = ");
this->implicit_variable_result.accept(*this);
s4o.print(";\n");
s4o.indent_left();
s4o.print(s4o.indent_spaces);
s4o.print("}\n");
s4o.print(s4o.indent_spaces);
return NULL;
}
// SYM_REF1(il_simple_instruction_c, il_simple_instruction, symbol_c *prev_il_instruction;)
void *visit(il_simple_instruction_c *symbol) {
/* all previous IL instructions should have the same datatype (checked in stage3), so we get the datatype from the first previous IL instruction we find */
implicit_variable_current.datatype = (symbol->prev_il_instruction.empty())? NULL : symbol->prev_il_instruction[0]->datatype;
implicit_variable_result .datatype = symbol->datatype;
symbol->il_simple_instruction->accept(*this);
implicit_variable_result .datatype = NULL;
implicit_variable_current.datatype = NULL;
return NULL;
}
/* | il_initial_param_list il_param_instruction */
// SYM_LIST(il_param_list_c)
void *visit(il_param_list_c *symbol) {ERROR; return NULL;} // should never get called!
/* il_assign_operator il_operand
* | il_assign_operator '(' eol_list simple_instr_list ')'
*/
// SYM_REF4(il_param_assignment_c, il_assign_operator, il_operand, simple_instr_list, unused)
void *visit(il_param_assignment_c *symbol) {ERROR; return NULL;} // should never get called!
/* il_assign_out_operator variable */
// SYM_REF2(il_param_out_assignment_c, il_assign_out_operator, variable);
void *visit(il_param_out_assignment_c *symbol) {ERROR; return NULL;} // should never get called!
/*******************/
/* B 2.2 Operators */
/*******************/
void *visit(LD_operator_c *symbol) {
if (wanted_variablegeneration != expression_vg) {
s4o.print("LD");
return NULL;
}
XXX_operator(&(this->implicit_variable_result), " = ", this->current_operand);
return NULL;
}
void *visit(LDN_operator_c *symbol) {
XXX_operator(&(this->implicit_variable_result), get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)?" = !":" = ~", this->current_operand);
return NULL;
}
void *visit(ST_operator_c *symbol) {
if (this->is_variable_prefix_null()) {
this->current_operand->accept(*this);
s4o.print(" = ");
print_check_function(this->current_operand->datatype, (symbol_c*)&(this->implicit_variable_current));
}
else {
print_setter(this->current_operand, this->current_operand->datatype, (symbol_c*)&(this->implicit_variable_current));
}
return NULL;
}
void *visit(STN_operator_c *symbol) {
if (this->is_variable_prefix_null()) {
this->current_operand->accept(*this);
s4o.print(" = ");
if (get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype))
s4o.print("!");
else
s4o.print("~");
this->implicit_variable_current.accept(*this);
}
else {
print_setter(this->current_operand, this->current_operand->datatype, (symbol_c*)&(this->implicit_variable_current), NULL, NULL, true);
}
return NULL;
}
void *visit(NOT_operator_c *symbol) {
/* NOTE: the standard allows syntax in which the NOT operator is followed by an optional <il_operand>
* NOT [<il_operand>]
* However, it does not define the semantic of the NOT operation when the <il_operand> is specified.
* We therefore consider it an error if an il_operand is specified!
* The error is caught in stage 3!
*/
if (NULL != this->current_operand) ERROR;
XXX_operator(&(this->implicit_variable_result), get_datatype_info_c::is_BOOL_compatible(symbol->datatype)?" = !":" = ~", &(this->implicit_variable_current));
return NULL;
}
void *visit(S_operator_c *symbol) {
/* This operator must implement one of two possible semantics:
* - FB call
* - Set all the bits of an ANY_BIT type variable to 1
*/
/* Check whether we must implement the FB call semantics... */
if (NULL != symbol->called_fb_declaration)
return XXX_CAL_operator( "S", this->current_operand);
/* Implement the bit setting semantics... */
if (wanted_variablegeneration != expression_vg) {
s4o.print("LD");
return NULL;
}
if ((NULL == this->current_operand) || (NULL == this->current_operand->datatype)) ERROR;
C_modifier();
this->current_operand->accept(*this);
s4o.print(" = __");
if (get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)) {
s4o.print("BOOL_LITERAL(TRUE)");
} else if (get_datatype_info_c::is_ANY_INT_compatible(this->current_operand->datatype)) {
this->current_operand->datatype->accept(*this);
s4o.print("_LITERAL(1)");
} else
ERROR;
return NULL;
}
void *visit(R_operator_c *symbol) {
/* This operator must implement one of two possible semantics:
* - FB call
* - Set all the bits of an ANY_BIT type variable to 0
*/
/* Check whether we must implement the FB call semantics... */
if (NULL != symbol->called_fb_declaration)
return XXX_CAL_operator( "R", this->current_operand);
/* Implement the bit setting semantics... */
if (wanted_variablegeneration != expression_vg) {
s4o.print("LD");
return NULL;
}
if ((NULL == this->current_operand) || (NULL == this->current_operand->datatype)) ERROR;
C_modifier();
this->current_operand->accept(*this);
s4o.print(" = __");
if (get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)) {
s4o.print("BOOL_LITERAL(FALSE)");
} else if (get_datatype_info_c::is_ANY_INT_compatible(this->current_operand->datatype)) {
this->current_operand->datatype->accept(*this);
s4o.print("_LITERAL(0)");
} else
ERROR;
/* the data type resulting from this operation is unchanged! */
return NULL;
}
void *visit( S1_operator_c *symbol) {return XXX_CAL_operator( "S1", this->current_operand);}
void *visit( R1_operator_c *symbol) {return XXX_CAL_operator( "R1", this->current_operand);}
void *visit(CLK_operator_c *symbol) {return XXX_CAL_operator("CLK", this->current_operand);}
void *visit( CU_operator_c *symbol) {return XXX_CAL_operator( "CU", this->current_operand);}
void *visit( CD_operator_c *symbol) {return XXX_CAL_operator( "CD", this->current_operand);}
void *visit( PV_operator_c *symbol) {return XXX_CAL_operator( "PV", this->current_operand);}
void *visit( IN_operator_c *symbol) {return XXX_CAL_operator( "IN", this->current_operand);}
void *visit( PT_operator_c *symbol) {return XXX_CAL_operator( "PT", this->current_operand);}
void *visit(AND_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
XXX_operator(&(this->implicit_variable_result), " &= ", this->current_operand);
return NULL;
}
void *visit(OR_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
XXX_operator(&(this->implicit_variable_result), " |= ", this->current_operand);
return NULL;
}
void *visit(XOR_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
// '^' is a bit by bit exclusive OR !! Also seems to work with boolean types!
XXX_operator(&(this->implicit_variable_result), " ^= ", this->current_operand);
return NULL;
}
void *visit(ANDN_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
XXX_operator(&(this->implicit_variable_result), get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)?" &= !":" &= ~", this->current_operand);
return NULL;
}
void *visit(ORN_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
XXX_operator(&(this->implicit_variable_result), get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)?" |= !":" |= ~", this->current_operand);
return NULL;
}
void *visit(XORN_operator_c *symbol) {
if (!get_datatype_info_c::is_ANY_BIT_compatible(symbol->datatype)) ERROR;
// bit by bit exclusive OR !! Also seems to work with boolean types!
XXX_operator(&(this->implicit_variable_result), get_datatype_info_c::is_BOOL_compatible(this->current_operand->datatype)?" ^= !":" ^= ~", this->current_operand);
return NULL;
}
void *visit(ADD_operator_c *symbol) {
if (get_datatype_info_c::is_TIME_compatible(symbol->datatype) || get_datatype_info_c::is_ANY_DATE_compatible (symbol->datatype))
XXX_function(&(this->implicit_variable_result), "__time_add", &(this->implicit_variable_current), this->current_operand);
else XXX_operator(&(this->implicit_variable_result), " += ", this->current_operand);
return NULL;
}
void *visit(SUB_operator_c *symbol) {
if (get_datatype_info_c::is_TIME_compatible(symbol->datatype) || get_datatype_info_c::is_ANY_DATE_compatible (symbol->datatype))
XXX_function(&(this->implicit_variable_result), "__time_sub", &(this->implicit_variable_current), this->current_operand);
else XXX_operator(&(this->implicit_variable_result), " -= ", this->current_operand);
return NULL;
}
void *visit(MUL_operator_c *symbol) {
if (get_datatype_info_c::is_TIME_compatible(symbol->datatype))
XXX_function(&(this->implicit_variable_result), "__time_mul", &(this->implicit_variable_current), this->current_operand);
else XXX_operator(&(this->implicit_variable_result), " *= ", this->current_operand);
return NULL;
}
void *visit(DIV_operator_c *symbol) {
if (get_datatype_info_c::is_TIME_compatible(symbol->datatype))
XXX_function(&(this->implicit_variable_result), "__time_div", &(this->implicit_variable_current), this->current_operand);
else XXX_operator(&(this->implicit_variable_result), " /= ", this->current_operand);
return NULL;
}
void *visit(MOD_operator_c *symbol) {XXX_operator(&(this->implicit_variable_result), " %= ", this->current_operand); return NULL;}
void *visit(GT_operator_c *symbol) {CMP_operator(this->current_operand, "GT"); return NULL;}
void *visit(GE_operator_c *symbol) {CMP_operator(this->current_operand, "GE"); return NULL;}
void *visit(EQ_operator_c *symbol) {CMP_operator(this->current_operand, "EQ"); return NULL;}
void *visit(LT_operator_c *symbol) {CMP_operator(this->current_operand, "LT"); return NULL;}
void *visit(LE_operator_c *symbol) {CMP_operator(this->current_operand, "LE"); return NULL;}
void *visit(NE_operator_c *symbol) {CMP_operator(this->current_operand, "NE"); return NULL;}
//SYM_REF0(CAL_operator_c)
// This method will be called from within the il_fb_call_c visitor method
void *visit(CAL_operator_c *symbol) {return NULL;}
//SYM_REF0(CALC_operator_c)
// This method will be called from within the il_fb_call_c visitor method
void *visit(CALC_operator_c *symbol) {C_modifier(); return NULL;}
//SYM_REF0(CALCN_operator_c)
// This method will be called from within the il_fb_call_c visitor method
void *visit(CALCN_operator_c *symbol) {CN_modifier(); return NULL;}
/* NOTE: The semantics of the RET operator requires us to return a value
* if the IL code is inside a function, but simply return no value if
* the IL code is inside a function block or program!
* Nevertheless, it is the generate_c_c class itself that
* introduces the 'reaturn <value>' into the c++ code at the end
* of every function. This class does not know whether the IL code
* is inside a function or a function block.
* We work around this by jumping to the end of the code,
* that will be marked by the END_LABEL label in the
* instruction_list_c visitor...
*/
// SYM_REF0(RET_operator_c)
void *visit(RET_operator_c *symbol) {
s4o.print("goto ");s4o.print(END_LABEL);
return NULL;
}
// SYM_REF0(RETC_operator_c)
void *visit(RETC_operator_c *symbol) {
C_modifier();
s4o.print("goto ");s4o.print(END_LABEL);
return NULL;
}
// SYM_REF0(RETCN_operator_c)
void *visit(RETCN_operator_c *symbol) {
CN_modifier();
s4o.print("goto ");s4o.print(END_LABEL);
return NULL;
}
//SYM_REF0(JMP_operator_c)
void *visit(JMP_operator_c *symbol) {
if (NULL == this->jump_label) ERROR;
s4o.print("goto ");
this->jump_label->accept(*this);
return NULL;
}
// SYM_REF0(JMPC_operator_c)
void *visit(JMPC_operator_c *symbol) {
if (NULL == this->jump_label) ERROR;
C_modifier();
s4o.print("goto ");
this->jump_label->accept(*this);
return NULL;
}
// SYM_REF0(JMPCN_operator_c)
void *visit(JMPCN_operator_c *symbol) {
if (NULL == this->jump_label) ERROR;
CN_modifier();
s4o.print("goto ");
this->jump_label->accept(*this);
return NULL;
}
#if 0
/*| [NOT] any_identifier SENDTO */
SYM_REF2(il_assign_out_operator_c, option, variable_name)
#endif
}; /* generate_c_il_c */
/* The implementation of the single visit() member function
* of il_default_variable_c.
* It can only come after the full declaration of
* generate_c_il_c. Since we define and declare
* generate_c_il_c simultaneously, it can only come
* after the definition...
*/
void *il_default_variable_c::accept(visitor_c &visitor) {
/* An ugly hack!! */
/* This is required because we need to over-ride the base
* accept(visitor_c &) method of the class symbol_c,
* so this method may be called through a symbol_c *
* reference!
*
* But, the visitor_c does not include a visitor to
* an il_default_variable_c, which means that we couldn't
* simply call visitor.visit(this);
*
* We therefore need to use the dynamic_cast hack!!
*
* Note too that we can't cast a visitor_c to a
* il_default_variable_visitor_c, since they are not related.
* Nor may the il_default_variable_visitor_c inherit from
* visitor_c, because then generate_c_il_c would contain
* two visitor_c base classes, one each through
* il_default_variable_visitor_c and generate_c_type_c
*
* We could use virtual inheritance of the visitor_c, but it
* would probably create more problems than it is worth!
*/
generate_c_il_c *v;
v = dynamic_cast<generate_c_il_c *>(&visitor);
if (v == NULL) ERROR;
return v->visit(this);
}
il_default_variable_c::il_default_variable_c(const char *var_name_str, symbol_c *current_type) {
if (NULL == var_name_str) ERROR;
/* Note: current_type may start off with NULL */
this->var_name = new identifier_c(var_name_str);
if (NULL == this->var_name) ERROR;
this->datatype = current_type;
}