1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2012  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2012       Manuele Conti (conti.ma@alice.it)

     6

 *

     7

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

 *  This program is distributed in the hope that it will be useful,

    13

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

 * This code is made available on the understanding that it will not be

    22

 * used in safety-critical situations without a full and competent review.

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    30

 *

    31

 */

    32

    33

    34

/* Declaration sequence is a source code part needed to declare variables.

    35

 * There are some checks we need to do before start with other analysis:

    36

 *

    37

 *   - Check external option redefinition.

    38

 *   - Check external data type redefinition.

    39

 *   - Check initial values consistently with the data types of the variables/data types being declared.

    40

 *   - Check whether a function block uses a CONSTANT qualifier as described in 2.5.2.1.

    41

 *

    42

 */

    43

    44

    45

#include "declaration_check.hh"

    46

#include "datatype_functions.hh"

    47

    48

#define FIRST_(symbol1, symbol2) (((symbol1)->first_order < (symbol2)->first_order)   ? (symbol1) : (symbol2))

    49

#define  LAST_(symbol1, symbol2) (((symbol1)->last_order  > (symbol2)->last_order)    ? (symbol1) : (symbol2))

    50

    51

#define STAGE3_ERROR(error_level, symbol1, symbol2, ...) {                                                                  \

    52

  if (current_display_error_level >= error_level) {                                                                         \

    53

    fprintf(stderr, "%s:%d-%d..%d-%d: error: ",                                                                             \

    54

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    55

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    56

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    57

    fprintf(stderr, "\n");                                                                                                  \

    58

    error_count++;                                                                                                     \

    59

  }                                                                                                                         \

    60

}

    61

    62

    63

#define STAGE3_WARNING(symbol1, symbol2, ...) {                                                                             \

    64

    fprintf(stderr, "%s:%d-%d..%d-%d: warning: ",                                                                           \

    65

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    66

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    67

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    68

    fprintf(stderr, "\n");                                                                                                  \

    69

    warning_found = true;                                                                                                   \

    70

}

    71

    72

    73

declaration_check_c::declaration_check_c(symbol_c *ignore) {

    74

  current_display_error_level = 0;

    75

  current_pou_decl = NULL;

    76

  error_count = 0;

    77

}

    78

    79

declaration_check_c::~declaration_check_c(void) {

    80

    81

}

    82

    83

int declaration_check_c::get_error_count() {

    84

  return error_count;

    85

}

    86

    87

void declaration_check_c::check_global_decl(symbol_c *p_decl) {

    88

	symbol_c *var_name;

    89

    90

	search_var_instance_decl_c search_var_instance_glo_decl(current_pou_decl);

    91

	search_var_instance_decl_c search_var_instance_ext_decl(p_decl);

    92

	function_param_iterator_c fpi(p_decl);

    93

	while((var_name = fpi.next()) != NULL) {

    94

      if (fpi.param_direction() == function_param_iterator_c::direction_extref) {

    95

     	 /* found an external reference parameter. */

    96

     	symbol_c *glo_decl = search_var_instance_glo_decl.get_decl(var_name);

    97

        symbol_c *ext_decl = search_var_instance_ext_decl.get_decl(var_name);

    98

    	if (glo_decl == NULL) {

    99

    	  STAGE3_ERROR(0, ext_decl, ext_decl, "Declaration error an external doesn't mach with any global var.");

   100

    	  continue;

   101

    	}

   102

        if (search_var_instance_glo_decl.get_option(var_name) != search_var_instance_ext_decl.get_option(var_name))

   103

          STAGE3_ERROR(0, glo_decl, glo_decl, "Declaration error an external redefinition option.");

   104

   105

        /* TODO: Check redefinition data type.

   106

         *       We need a new class (like search_base_type class) to get type id by variable declaration.

   107

         *  symbol_c *glo_type = ????;

   108

         *  symbol_c *ext_type = fpi.param_type();

   109

	 */

   110

	/* For the moment, we will just use search_base_type_c instead... */

   111

        symbol_c *glo_type = search_base_type_c::get_basetype_decl(glo_decl);

   112

        symbol_c *ext_type = search_base_type_c::get_basetype_decl(ext_decl);

   113

        if (! get_datatype_info_c::is_type_equal(glo_type, ext_type))

   114

          STAGE3_ERROR(0, ext_decl, ext_decl, "Declaration error an external redefinition data type.");

   115

      }

   116

	}

   117

   118

}

   119

   120

   121

   122

/*****************************/

   123

/* B 1.5.2 - Function Blocks */

   124

/*****************************/

   125

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   126

// SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   127

void *declaration_check_c::visit(function_block_declaration_c *symbol) {

   128

  current_pou_decl = symbol;

   129

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   130

  if (NULL != symbol->var_declarations)

   131

    symbol->var_declarations->accept(*this);

   132

  return NULL;

   133

}

   134

   135

/******************************************/

   136

/* B 1.5.3 - Declaration & Initialisation */

   137

/******************************************/

   138

/*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   139

// SYM_REF3(program_declaration_c, program_type_name, var_declarations, function_block_body)

   140

void *declaration_check_c::visit(program_declaration_c *symbol) {

   141

  current_pou_decl = symbol;

   142

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   143

  if (NULL != symbol->var_declarations)

   144

    symbol->var_declarations->accept(*this);

   145

  return NULL;

   146

}

   147

   148

/********************************/

   149

/* B 1.7 Configuration elements */

   150

/********************************/

   151

/*

   152

 * CONFIGURATION configuration_name

   153

 *    optional_global_var_declarations

   154

 *    (resource_declaration_list | single_resource_declaration)

   155

 *    optional_access_declarations

   156

 *    optional_instance_specific_initializations

   157

 * END_CONFIGURATION

   158

 */

   159

//SYM_REF5(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations)

   160

void *declaration_check_c::visit(configuration_declaration_c *symbol) {

   161

  current_pou_decl = symbol;

   162

  /* check if any FB declared as a VAR has any incompatible VAR_EXTERNAL declarations */

   163

  if (NULL != symbol->resource_declarations)

   164

    symbol->resource_declarations->accept(*this);

   165

  return NULL;

   166

}

   167

   168

void *declaration_check_c::visit(program_configuration_c *symbol) {

   169

  symbol_c *p_decl = program_type_symtable.find_value(symbol->program_type_name);

   170

  if (p_decl == program_type_symtable.end_value())

   171

    p_decl = function_block_type_symtable.find_value(symbol->program_type_name);

   172

  /* stage1_2 guarantees that we are sure to find a declaration in FB or Program symtable. */

   173

  if (p_decl == function_block_type_symtable.end_value())

   174

    ERROR;

   175

  check_global_decl(p_decl);

   176

  return NULL;

   177

}

   178