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) 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

/* Determine the value of an constant expression.

    34

 * A reference to the relevant type definition is returned.

    35

 *

    36

 * For example:

    37

 *       2 + 3       -> returns reference 

    38

 *       22.2 - 5    -> returns reference

    39

 *       etc...

    40

 */

    41

    42

#include <vector>

    43

#include "../absyntax_utils/absyntax_utils.hh"

    44

    45

    46

    47

/* For the moment we disable constant propagation algorithm as it is not yet complete, 

    48

 * and due to this is currently brocken and producing incorrect results!

    49

 */

    50

#define DO_CONSTANT_PROPAGATION__ 0

    51

    52

    53

    54

class constant_folding_c : public iterator_visitor_c {

    55

    search_varfb_instance_type_c *search_varfb_instance_type;

    56

    int error_count;

    57

    bool warning_found;

    58

    int current_display_error_level;

    59

    /* Pointer to the previous IL instruction, which contains the current cvalue of the data stored in the IL stack, i.e. the default variable, a.k.a. accumulator */

    60

    symbol_c *prev_il_instruction;

    61

    /* the current IL operand being analyzed */

    62

    symbol_c *il_operand;

    63

    64

  public:

    65

	constant_folding_c(symbol_c *symbol = NULL);

    66

	virtual ~constant_folding_c(void);

    67

	int get_error_count();

    68

	int handle_var_extern_global_pair(symbol_c *extern_var_name, symbol_c *extern_var_decl, symbol_c *global_var_name, symbol_c *global_var_decl);

    69

  private:

    70

	void *handle_var_list_decl(symbol_c *var_list, symbol_c *type_decl);

    71

  public:

    72

	#if 0

    73

	// not currently needed, so comment it out!...

    74

	/* utility functions for other stage3 algorithms to access the contant folded values */

    75

	/* written as static since we do not need to iteratively visit the symbols! */

    76

	// returns true if both symbols have the same value in all the cvalues

    77

	static bool is_equal_cvalue(symbol_c *symbol_1, symbol_c *symbol_2);

    78

	#endif

    79

    80

  private:

    81

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

    82

    /* B 1.2 - Constants */

    83

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

    84

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

    85

    /* B 1.2.1 - Numeric Literals */

    86

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

    87

    void *visit(real_c *symbol);

    88

    void *visit(integer_c *symbol);

    89

    void *visit(neg_real_c *symbol);

    90

    void *visit(neg_integer_c *symbol);

    91

    void *visit(binary_integer_c *symbol);

    92

    void *visit(octal_integer_c *symbol);

    93

    void *visit(hex_integer_c *symbol);

    94

    void *visit(integer_literal_c *symbol);

    95

    void *visit(real_literal_c *symbol);

    96

    void *visit(bit_string_literal_c *symbol);

    97

    void *visit(boolean_literal_c *symbol);

    98

    void *visit(boolean_true_c *symbol);

    99

    void *visit(boolean_false_c *symbol);

   100

   101

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

   102

    /* B 1.2.3.1 - Duration */

   103

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

   104

    void *visit(fixed_point_c *symbol);

   105

   106

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

   107

    /* B 1.4 - Variables */

   108

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

   109

    #if DO_CONSTANT_PROPAGATION__

   110

    void *visit(symbolic_variable_c *symbol);

   111

    #endif // DO_CONSTANT_PROPAGATION__

   112

    void *visit(symbolic_constant_c *symbol);

   113

   114

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

   115

    /* B 1.4.3 - Declaration & Initialisation */

   116

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

   117

    void *visit(    var1_init_decl_c         *symbol);

   118

    void *visit(     external_declaration_c  *symbol);

   119

   120

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

   121

    /* B.1.5 - Program organization units */

   122

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

   123

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

   124

    /* B 1.5.1 - Functions */

   125

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

   126

    void *visit(function_declaration_c *symbol);

   127

   128

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

   129

    /* B 1.5.2 - Function Blocks */

   130

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

   131

    void *visit(function_block_declaration_c *symbol);

   132

   133

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

   134

    /* B 1.5.3 - Programs */

   135

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

   136

    void *visit(program_declaration_c *symbol);

   137

   138

   139

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

   140

    /* B.2 - Language IL (Instruction List) */

   141

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

   142

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

   143

    /* B 2.1 Instructions and Operands */

   144

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

   145

    // void *visit(instruction_list_c *symbol); /* Not needed, since we inherit from iterator_visitor_c */

   146

    void *visit(il_instruction_c *symbol);

   147

    void *visit(il_simple_operation_c *symbol);

   148

    //void *visit(il_function_call_c *symbol);  /* TODO */

   149

    void *visit(il_expression_c *symbol);

   150

    void *visit(il_jump_operation_c *symbol);

   151

    void *visit(il_fb_call_c *symbol);

   152

    //void *visit(il_formal_funct_call_c *symbol);   /* TODO */

   153

    //void *visit(il_operand_list_c *symbol);  /* Not needed, since we inherit from iterator_visitor_c */

   154

    void *visit(simple_instr_list_c *symbol);

   155

    void *visit(il_simple_instruction_c *symbol);

   156

   157

   158

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

   159

    /* B 2.2 Operators */

   160

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

   161

    void *visit(   LD_operator_c *symbol);

   162

    void *visit(  LDN_operator_c *symbol);

   163

    void *visit(   ST_operator_c *symbol);

   164

    void *visit(  STN_operator_c *symbol);

   165

    void *visit(  NOT_operator_c *symbol);

   166

    void *visit(    S_operator_c *symbol);

   167

    void *visit(    R_operator_c *symbol);

   168

    void *visit(   S1_operator_c *symbol);

   169

    void *visit(   R1_operator_c *symbol);

   170

    void *visit(  CLK_operator_c *symbol);

   171

    void *visit(   CU_operator_c *symbol);

   172

    void *visit(   CD_operator_c *symbol);

   173

    void *visit(   PV_operator_c *symbol);

   174

    void *visit(   IN_operator_c *symbol);

   175

    void *visit(   PT_operator_c *symbol);

   176

    void *visit(  AND_operator_c *symbol);

   177

    void *visit(   OR_operator_c *symbol);

   178

    void *visit(  XOR_operator_c *symbol);

   179

    void *visit( ANDN_operator_c *symbol);

   180

    void *visit(  ORN_operator_c *symbol);

   181

    void *visit( XORN_operator_c *symbol);

   182

    void *visit(  ADD_operator_c *symbol);

   183

    void *visit(  SUB_operator_c *symbol);

   184

    void *visit(  MUL_operator_c *symbol);

   185

    void *visit(  DIV_operator_c *symbol);

   186

    void *visit(  MOD_operator_c *symbol);

   187

    void *visit(   GT_operator_c *symbol);

   188

    void *visit(   GE_operator_c *symbol);

   189

    void *visit(   EQ_operator_c *symbol);

   190

    void *visit(   LT_operator_c *symbol);

   191

    void *visit(   LE_operator_c *symbol);

   192

    void *visit(   NE_operator_c *symbol);

   193

    void *visit(  CAL_operator_c *symbol);

   194

    void *visit( CALC_operator_c *symbol);

   195

    void *visit(CALCN_operator_c *symbol);

   196

    void *visit(  RET_operator_c *symbol);

   197

    void *visit( RETC_operator_c *symbol);

   198

    void *visit(RETCN_operator_c *symbol);

   199

    void *visit(  JMP_operator_c *symbol);

   200

    void *visit( JMPC_operator_c *symbol);

   201

    void *visit(JMPCN_operator_c *symbol);

   202

    /* Symbol class handled together with function call checks */

   203

    // void *visit(il_assign_operator_c *symbol, variable_name);

   204

    /* Symbol class handled together with function call checks */

   205

    // void *visit(il_assign_operator_c *symbol, option, variable_name);

   206

   207

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

   208

    /* B.3 - Language ST (Structured Text) */

   209

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

   210

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

   211

    /* B 3.1 - Expressions */

   212

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

   213

    void *visit(    or_expression_c *symbol);

   214

    void *visit(   xor_expression_c *symbol);

   215

    void *visit(   and_expression_c *symbol);

   216

    void *visit(   equ_expression_c *symbol);

   217

    void *visit(notequ_expression_c *symbol);

   218

    void *visit(    lt_expression_c *symbol);

   219

    void *visit(    gt_expression_c *symbol);

   220

    void *visit(    le_expression_c *symbol);

   221

    void *visit(    ge_expression_c *symbol);

   222

    void *visit(   add_expression_c *symbol);

   223

    void *visit(   sub_expression_c *symbol);

   224

    void *visit(   mul_expression_c *symbol);

   225

    void *visit(   div_expression_c *symbol);

   226

    void *visit(   mod_expression_c *symbol);

   227

    void *visit( power_expression_c *symbol);

   228

    void *visit(   neg_expression_c *symbol);

   229

    void *visit(   not_expression_c *symbol);

   230

    //void *visit(function_invocation_c *symbol); /* TODO */

   231

   232

   233

    #if DO_CONSTANT_PROPAGATION__

   234

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

   235

    /* B 3.2.1 Assignment Statements */

   236

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

   237

    void *visit(assignment_statement_c *symbol);

   238

   239

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

   240

    /* B 3.2.3 Selection Statements */

   241

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

   242

    void *visit(if_statement_c *symbol);

   243

   244

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

   245

    /* B 3.2.4 Iteration Statements */

   246

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

   247

    void *visit(for_statement_c *symbol);

   248

    void *visit(while_statement_c *symbol);

   249

    void *visit(repeat_statement_c *symbol);

   250

    #endif // DO_CONSTANT_PROPAGATION__

   251

};

   252