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 (manuele.conti@sirius-es.it)

     6

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

     7

 *

     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

/* NOTE: The algorithm implemented here assumes that flow control analysis has already been completed!

    36

 *       BEFORE running this visitor, be sure to CALL the flow_control_analysis_c visitor!

    37

 */

    38

    39

    40

/*

    41

 *  Fill the candidate datatype list for all symbols that may legally 'have' a data type (e.g. variables, literals, function calls, expressions, etc.)

    42

 * 

    43

 *  The candidate datatype list will be filled with a list of all the data types that expression may legally take.

    44

 *  For example, the very simple literal '0' (as in foo := 0), may represent a:

    45

 *    BOOL, BYTE, WORD, DWORD, LWORD, USINT, SINT, UINT, INT, UDINT, DINT, ULINT, LINT (as well as the SAFE versions of these data tyes too!)

    46

 */

    47

    48

    49

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

    50

#include "datatype_functions.hh"

    51

    52

class fill_candidate_datatypes_c: public iterator_visitor_c {

    53

    54

  private:

    55

    search_varfb_instance_type_c *search_varfb_instance_type;

    56

    search_base_type_c search_base_type;

    57

    /* When calling a function block, we must first find it's type,

    58

     * by searching through the declarations of the variables currently

    59

     * in scope.

    60

     * This class does just that...

    61

     * A new object instance is instantiated whenever we start checking semantics

    62

     * for a function block type declaration, or a program declaration.

    63

     * This object instance will then later be called while the

    64

     * function block's or the program's body is being handled.

    65

     *

    66

     * Note that functions cannot contain calls to function blocks,

    67

     * so we do not create an object instance when handling

    68

     * a function declaration.

    69

     */

    70

    //     search_var_instance_decl_c *search_var_instance_decl;

    71

    72

    /* This variable was created to pass information from

    73

     * fill_candidate_datatypes_c::visit(case_statement_c *symbol) function to

    74

     * fill_candidate_datatypes_c::visit(case_list_c *symbol) function.

    75

     */

    76

//     symbol_c *case_expression_type;

    77

    78

    /* In IL code, once we find a type mismatch error, it is best to

    79

     * ignore any further errors until the end of the logical operation,

    80

     * i.e. until the next LD.

    81

     * However, we cannot clear the il_error flag on all LD operations,

    82

     * as these may also be used within parenthesis. LD operations

    83

     * within parenthesis may not clear the error flag.

    84

     * We therefore need a counter to know how deep inside a parenthesis

    85

     * structure we are.

    86

     */

    87

//     int  il_parenthesis_level;

    88

//     bool error_found;

    89

    90

    /* the current data type of the data stored in the IL stack, i.e. the default variable */

    91

    symbol_c *prev_il_instruction;

    92

    /* the current IL operand being analyzed - its symbol and its data type */

    93

    symbol_c *il_operand_type;

    94

    symbol_c *il_operand;

    95

    symbol_c *widening_conversion(symbol_c *left_type, symbol_c *right_type, const struct widen_entry widen_table[]);

    96

    97

    /* Match a function declaration with a function call through their parameters.*/

    98

    /* returns true if compatible function/FB invocation, otherwise returns false */

    99

    bool  match_nonformal_call(symbol_c *f_call, symbol_c *f_decl);

   100

    bool  match_formal_call   (symbol_c *f_call, symbol_c *f_decl, symbol_c **first_param_datatype = NULL);

   101

    void  handle_function_call(symbol_c *fcall, generic_function_call_t fcall_data);

   102

    void *handle_implicit_il_fb_call(symbol_c *il_instruction, const char *param_name, symbol_c *&called_fb_declaration);

   103

    void *handle_binary_expression(const struct widen_entry widen_table[], symbol_c *symbol, symbol_c *l_expr, symbol_c *r_expr);

   104

    void *handle_binary_operator  (const struct widen_entry widen_table[], symbol_c *symbol, symbol_c *l_expr, symbol_c *r_expr);

   105

    void *handle_conditional_il_flow_control_operator(symbol_c *symbol);

   106

   107

    /* a helper function... */

   108

    symbol_c *base_type(symbol_c *symbol);    

   109

   110

    /* add a data type to a candidate data type list, while guaranteeing no duplicate entries! */

   111

    /* Returns true if it really did add the datatype to the list, or false if it was already present in the list! */

   112

    bool add_datatype_to_candidate_list  (symbol_c *symbol, symbol_c *datatype);

   113

    bool add_2datatypes_to_candidate_list(symbol_c *symbol, symbol_c *datatype1, symbol_c *datatype2);

   115

   116

   117

  public:

   118

    fill_candidate_datatypes_c(symbol_c *ignore);

   119

    virtual ~fill_candidate_datatypes_c(void);

   120

   121

   122

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

   123

    /* B 1.2 - Constants */

   124

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

   125

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

   126

    /* B 1.2.1 - Numeric Literals */

   127

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

   128

    void *handle_any_integer(symbol_c *symbol);

   129

    void *handle_any_real   (symbol_c *symbol);

   130

    void *handle_any_literal(symbol_c *symbol, symbol_c *symbol_value, symbol_c *symbol_type);

   131

   132

    void *visit(real_c *symbol);

   133

    void *visit(integer_c *symbol);

   134

    void *visit(neg_real_c *symbol);

   135

    void *visit(neg_integer_c *symbol);

   136

    void *visit(binary_integer_c *symbol);

   137

    void *visit(octal_integer_c *symbol);

   138

    void *visit(hex_integer_c *symbol);

   139

    void *visit(integer_literal_c *symbol);

   140

    void *visit(real_literal_c *symbol);

   141

    void *visit(bit_string_literal_c *symbol);

   142

    void *visit(boolean_literal_c *symbol);

   143

    void *visit(boolean_true_c *symbol);

   144

    void *visit(boolean_false_c *symbol);

   145

   146

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

   147

    /* B.1.2.2   Character Strings */

   148

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

   149

    void *visit(double_byte_character_string_c *symbol);

   150

    void *visit(single_byte_character_string_c *symbol);

   151

   152

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

   153

    /* B 1.2.3 - Time Literals */

   154

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

   155

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

   156

    /* B 1.2.3.1 - Duration */

   157

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

   158

    void *visit(duration_c *symbol);

   159

   160

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

   161

    /* B 1.2.3.2 - Time of day and Date */

   162

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

   163

    void *visit(time_of_day_c *symbol);

   164

    void *visit(date_c *symbol);

   165

    void *visit(date_and_time_c *symbol);

   166

   167

   168

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

   169

    /* B 1.3 - Data types */

   170

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

   171

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

   172

    /* B 1.3.3 - Derived data types */

   173

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

   174

    void *visit(simple_spec_init_c *symbol);

   175

    void *visit(subrange_c *symbol);

   176

//  void *visit(data_type_declaration_c *symbol);

   177

    void *visit(enumerated_value_c *symbol);

   178

   179

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

   180

    /* B 1.4 - Variables */

   181

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

   182

    void *visit(symbolic_variable_c *symbol);

   183

   184

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

   185

    /* B 1.4.1 - Directly Represented Variables */

   186

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

   187

    void *visit(direct_variable_c *symbol);

   188

   189

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

   190

    /* B 1.4.2 - Multi-element variables */

   191

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

   192

    void *visit(array_variable_c *symbol);

   193

    void *visit(structured_variable_c *symbol);

   194

   195

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

   196

    /* B 1.4.3 - Declaration & Initialisation */

   197

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

   198

    void *visit(var1_list_c *symbol);

   199

    void *visit(location_c *symbol);

   200

    void *visit(located_var_decl_c *symbol);

   201

   202

   203

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

   204

    /* B 1.5 - Program organization units */

   205

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

   206

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

   207

    /* B 1.5.1 - Functions */

   208

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

   209

    void *visit(function_declaration_c *symbol);

   210

   211

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

   212

    /* B 1.5.2 - Function blocks */

   213

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

   214

    void *visit(function_block_declaration_c *symbol);

   215

   216

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

   217

    /* B 1.5.3 - Programs */

   218

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

   219

    void *visit(program_declaration_c *symbol);

   220

   221

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

   222

    /* B 1.7 Configuration elements */

   223

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

   224

    void *visit(configuration_declaration_c *symbol);

   225

   226

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

   227

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

   228

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

   229

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

   230

    /* B 2.1 Instructions and Operands */

   231

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

   232

    void *visit(instruction_list_c *symbol);

   233

    void *visit(il_instruction_c *symbol);

   234

    void *visit(il_simple_operation_c *symbol);

   235

    void *visit(il_function_call_c *symbol);

   236

    void *visit(il_expression_c *symbol);

   237

    void *visit(il_jump_operation_c *symbol);

   238

    void *visit(il_fb_call_c *symbol);

   239

    void *visit(il_formal_funct_call_c *symbol);

   240

//  void *visit(il_operand_list_c *symbol);

   241

    void *visit(simple_instr_list_c *symbol);

   242

    void *visit(il_simple_instruction_c*symbol);

   243

//  void *visit(il_param_list_c *symbol);

   244

//  void *visit(il_param_assignment_c *symbol);

   245

//  void *visit(il_param_out_assignment_c *symbol);

   246

   247

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

   248

    /* B 2.2 Operators */

   249

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

   250

    void *visit(LD_operator_c *symbol);

   251

    void *visit(LDN_operator_c *symbol);

   252

    void *visit(ST_operator_c *symbol);

   253

    void *visit(STN_operator_c *symbol);

   254

    void *visit(NOT_operator_c *symbol);

   255

    void *visit(S_operator_c *symbol);

   256

    void *visit(R_operator_c *symbol);

   257

    void *visit(S1_operator_c *symbol);

   258

    void *visit(R1_operator_c *symbol);

   259

    void *visit(CLK_operator_c *symbol);

   260

    void *visit(CU_operator_c *symbol);

   261

    void *visit(CD_operator_c *symbol);

   262

    void *visit(PV_operator_c *symbol);

   263

    void *visit(IN_operator_c *symbol);

   264

    void *visit(PT_operator_c *symbol);

   265

    void *visit(AND_operator_c *symbol);

   266

    void *visit(OR_operator_c *symbol);

   267

    void *visit(XOR_operator_c *symbol);

   268

    void *visit(ANDN_operator_c *symbol);

   269

    void *visit(ORN_operator_c *symbol);

   270

    void *visit(XORN_operator_c *symbol);

   271

    void *visit(ADD_operator_c *symbol);

   272

    void *visit(SUB_operator_c *symbol);

   273

    void *visit(MUL_operator_c *symbol);

   274

    void *visit(DIV_operator_c *symbol);

   275

    void *visit(MOD_operator_c *symbol);

   276

    void *visit(GT_operator_c *symbol);

   277

    void *visit(GE_operator_c *symbol);

   278

    void *visit(EQ_operator_c *symbol);

   279

    void *visit(LT_operator_c *symbol);

   280

    void *visit(LE_operator_c *symbol);

   281

    void *visit(NE_operator_c *symbol);

   282

    void *visit(CAL_operator_c *symbol);

   283

    void *visit(CALC_operator_c *symbol);

   284

    void *visit(CALCN_operator_c *symbol);

   285

    void *visit(RET_operator_c *symbol);

   286

    void *visit(RETC_operator_c *symbol);

   287

    void *visit(RETCN_operator_c *symbol);

   288

    void *visit(JMP_operator_c *symbol);

   289

    void *visit(JMPC_operator_c *symbol);

   290

    void *visit(JMPCN_operator_c *symbol);

   291

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

   292

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

   293

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

   294

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

   295

   296

   297

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

   298

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

   299

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

   300

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

   301

    /* B 3.1 - Expressions */

   302

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

   303

    void *visit(or_expression_c *symbol);

   304

    void *visit(xor_expression_c *symbol);

   305

    void *visit(and_expression_c *symbol);

   306

    void *visit(equ_expression_c *symbol);

   307

    void *visit(notequ_expression_c *symbol);

   308

    void *visit(lt_expression_c *symbol);

   309

    void *visit(gt_expression_c *symbol);

   310

    void *visit(le_expression_c *symbol);

   311

    void *visit(ge_expression_c *symbol);

   312

    void *visit(add_expression_c *symbol);

   313

    void *visit(sub_expression_c *symbol);

   314

    void *visit(mul_expression_c *symbol);

   315

    void *visit(div_expression_c *symbol);

   316

    void *visit(mod_expression_c *symbol);

   317

    void *visit(power_expression_c *symbol);

   318

    void *visit(neg_expression_c *symbol);

   319

    void *visit(not_expression_c *symbol);

   320

    void *visit(function_invocation_c *symbol);

   321

   322

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

   323

    /* B 3.2.1 Assignment Statements */

   324

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

   325

    void *visit(assignment_statement_c *symbol);

   326

   327

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

   328

    /* B 3.2.2 Subprogram Control Statements */

   329

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

   330

    void *visit(fb_invocation_c *symbol);

   331

   332

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

   333

    /* B 3.2.3 Selection Statements */

   334

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

   335

    void *visit(if_statement_c *symbol);

   336

    //     void *visit(elseif_statement_list_c *symbol);

   337

    void *visit(elseif_statement_c *symbol);

   338

    void *visit(case_statement_c *symbol);

   339

   340

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

   341

    /* B 3.2.4 Iteration Statements */

   342

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

   343

    void *visit(for_statement_c *symbol);

   344

    void *visit(while_statement_c *symbol);

   345

    void *visit(repeat_statement_c *symbol);

   346

   347

}; // fill_candidate_datatypes_c

   348

   349

   350

   351

   352

   353

   354

   355

   356

   357

   358