1

/*

     2

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

     3

 *

     4

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

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *  Copyright (C) 2012       Manuele Conti (manuele.conti@sirius-es.it)

     7

 *  Copyright (C) 2012       Matteo Facchinetti (matteo.facchinetti@sirius-es.it)

     8

 *

     9

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

    10

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

    11

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

    12

 *  (at your option) any later version.

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

 *

    22

 *

    23

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

    24

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

    25

 */

    26

    27

/*

    28

 * An IEC 61131-3 compiler.

    29

 *

    30

 * Based on the

    31

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

    32

 *

    33

 */

    34

    35

#include "stage3.hh"

    36

    37

#include "flow_control_analysis.hh"

    38

#include "fill_candidate_datatypes.hh"

    39

#include "narrow_candidate_datatypes.hh"

    40

#include "forced_narrow_candidate_datatypes.hh"

    41

#include "print_datatypes_error.hh"

    42

#include "lvalue_check.hh"

    43

#include "array_range_check.hh"

    44

#include "constant_folding.hh"

    45

#include "declaration_check.hh"

    46

#include "enum_declaration_check.hh"

    47

#include "remove_forward_dependencies.hh"

    48

    49

    50

    51

static int enum_declaration_check(symbol_c *tree_root){

    52

    enum_declaration_check_c enum_declaration_check(NULL);

    53

    tree_root->accept(enum_declaration_check);

    54

    return enum_declaration_check.get_error_count();

    55

}

    56

    57

    58

static int declaration_safety(symbol_c *tree_root){

    59

    declaration_check_c declaration_check(tree_root);

    60

    tree_root->accept(declaration_check);

    61

    return declaration_check.get_error_count();

    62

}

    63

    64

static int flow_control_analysis(symbol_c *tree_root){

    65

    flow_control_analysis_c flow_control_analysis(tree_root);

    66

    tree_root->accept(flow_control_analysis);

    67

    return 0;

    68

}

    69

    70

    71

/* Constant folding assumes that flow control analysis has been completed!

    72

 * so be sure to call flow_control_analysis() before calling this function!

    73

 */

    74

static int constant_folding(symbol_c *tree_root){

    75

    constant_folding_c constant_folding(tree_root);

    76

    tree_root->accept(constant_folding);

    77

    return constant_folding.get_error_count();

    78

}

    79

    80

    81

/* Type safety analysis assumes that 

    82

 *    - flow control analysis 

    83

 *    - constant folding (constant check)

    84

 * has already been completed, so be sure to call those semantic checkers

    85

 * before calling this function

    86

 */

    87

static int type_safety(symbol_c *tree_root){

    88

	fill_candidate_datatypes_c fill_candidate_datatypes(tree_root);

    89

	tree_root->accept(fill_candidate_datatypes);

    90

	narrow_candidate_datatypes_c narrow_candidate_datatypes(tree_root);

    91

	tree_root->accept(narrow_candidate_datatypes);

    92

	print_datatypes_error_c print_datatypes_error(tree_root);

    93

	tree_root->accept(print_datatypes_error);

    94

	forced_narrow_candidate_datatypes_c forced_narrow_candidate_datatypes(tree_root);

    95

	tree_root->accept(forced_narrow_candidate_datatypes);

    96

	return print_datatypes_error.get_error_count();

    97

}

    98

    99

   100

/* Left value checking assumes that data type analysis has already been completed,

   101

 * so be sure to call type_safety() before calling this function

   102

 */

   103

static int lvalue_check(symbol_c *tree_root){

   104

	lvalue_check_c lvalue_check(tree_root);

   105

	tree_root->accept(lvalue_check);

   106

	return lvalue_check.get_error_count();

   107

}

   108

   109

/* Array range check assumes that constant folding has been completed!

   110

 * so be sure to call constant_folding() before calling this function!

   111

 */

   112

static int array_range_check(symbol_c *tree_root){

   113

	array_range_check_c array_range_check(tree_root);

   114

	tree_root->accept(array_range_check);

   115

	return array_range_check.get_error_count();

   116

}

   117

   118

   119

   120

/* Removing forward dependencies only makes sense when stage1_2 is run with the pre-parsing option.

   121

 * This algorithm has no dependencies on other stage 3 algorithms.

   122

 * Typically this is run last, just to show that the remaining algorithms also do not depend on the fact that 

   123

 * the library_c (i.e. the source code) does not contain forward dependencies.

   124

 */

   125

static int remove_forward_dependencies(symbol_c *tree_root, symbol_c **ordered_tree_root) {

   126

	if (NULL != ordered_tree_root)    *ordered_tree_root = tree_root; // by default, consider tree_root already ordered

   127

	if (!runtime_options.pre_parsing)  return 0;                      // No re-ordering necessary, just return

   128

   129

	/* We need to re-order the elements in the library, to fix any forward references! */

   130

	remove_forward_dependencies_c remove_forward_dependencies;

   131

	symbol_c *new_tree_root = remove_forward_dependencies.create_new_tree(tree_root);

   132

	if (NULL ==     new_tree_root)   ERROR;

   133

	if (NULL != ordered_tree_root)   *ordered_tree_root = new_tree_root;

   134

	return remove_forward_dependencies.get_error_count();

   135

}

   136

   137

   138

int stage3(symbol_c *tree_root, symbol_c **ordered_tree_root) {

   139

	int error_count = 0;

   140

	error_count += enum_declaration_check(tree_root);

   141

	error_count += declaration_safety(tree_root);

   142

	error_count += flow_control_analysis(tree_root);

   143

	error_count += constant_folding(tree_root);

   144

	error_count += type_safety(tree_root);

   145

	error_count += lvalue_check(tree_root);

   146

	error_count += array_range_check(tree_root);

   147

	error_count += remove_forward_dependencies(tree_root, ordered_tree_root);

   148

   149

	if (error_count > 0) {

   150

		fprintf(stderr, "%d error(s) found. Bailing out!\n", error_count); 

   151

		return -1;

   152

	}

   153

	return 0;

   154

}