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

    36

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

    37

#include "datatype_functions.hh"

    38

    39

class fill_candidate_datatypes_c: public iterator_visitor_c {

    40

    41

  private:

    42

    search_varfb_instance_type_c *search_varfb_instance_type;

    43

    search_base_type_c search_base_type;

    44

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

    45

     * by searching through the declarations of the variables currently

    46

     * in scope.

    47

     * This class does just that...

    48

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

    49

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

    50

     * This object instance will then later be called while the

    51

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

    52

     *

    53

     * Note that functions cannot contain calls to function blocks,

    54

     * so we do not create an object instance when handling

    55

     * a function declaration.

    56

     */

    57

    //     search_var_instance_decl_c *search_var_instance_decl;

    58

    59

    /* This variable was created to pass information from

    60

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

    61

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

    62

     */

    63

//     symbol_c *case_expression_type;

    64

    65

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

    66

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

    67

     * i.e. until the next LD.

    68

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

    69

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

    70

     * within parenthesis may not clear the error flag.

    71

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

    72

     * structure we are.

    73

     */

    74

//     int  il_parenthesis_level;

    75

//     bool error_found;

    76

    77

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

    78

    symbol_c *prev_il_instruction;

    79

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

    80

    symbol_c *il_operand_type;

    81

    symbol_c *il_operand;

    82

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

    83

    84

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

    85

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

    86

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

    87

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

    88

    void handle_function_call(symbol_c *fcall, generic_function_call_t fcall_data);

    89

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

    90

    91

    /* a helper function... */

    92

    symbol_c *base_type(symbol_c *symbol);    

    93

    94

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

    95

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

    98

    99

   100

  public:

   101

    fill_candidate_datatypes_c(symbol_c *ignore);

   102

    virtual ~fill_candidate_datatypes_c(void);

   103

   104

   105

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

   106

    /* B 1.2 - Constants */

   107

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

   108

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

   109

    /* B 1.2.1 - Numeric Literals */

   110

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

   113

    void *visit(real_c *symbol);

   114

    void *visit(integer_c *symbol);

   115

    void *visit(neg_real_c *symbol);

   116

    void *visit(neg_integer_c *symbol);

   117

    void *visit(binary_integer_c *symbol);

   118

    void *visit(octal_integer_c *symbol);

   119

    void *visit(hex_integer_c *symbol);

   120

    void *visit(integer_literal_c *symbol);

   121

    void *visit(real_literal_c *symbol);

   122

    void *visit(bit_string_literal_c *symbol);

   123

    void *visit(boolean_literal_c *symbol);

   124

    void *visit(boolean_true_c *symbol);

   125

    void *visit(boolean_false_c *symbol);

   126

   127

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

   128

    /* B.1.2.2   Character Strings */

   129

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

   130

    void *visit(double_byte_character_string_c *symbol);

   131

    void *visit(single_byte_character_string_c *symbol);

   132

   133

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

   134

    /* B 1.2.3 - Time Literals */

   135

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

   136

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

   137

    /* B 1.2.3.1 - Duration */

   138

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

   139

    void *visit(duration_c *symbol);

   140

   141

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

   142

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

   143

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

   144

    void *visit(time_of_day_c *symbol);

   145

    void *visit(date_c *symbol);

   146

    void *visit(date_and_time_c *symbol);

   147

   148

   149

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

   150

    /* B 1.3 - Data types */

   151

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

   152

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

   153

    /* B 1.3.3 - Derived data types */

   154

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

   155

    void *visit(subrange_c *symbol);

   156

//  void *visit(data_type_declaration_c *symbol);

   157

    void *visit(enumerated_value_c *symbol);

   158

   159

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

   160

    /* B 1.4 - Variables */

   161

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

   162

    void *visit(symbolic_variable_c *symbol);

   163

   164

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

   165

    /* B 1.4.1 - Directly Represented Variables */

   166

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

   167

    void *visit(direct_variable_c *symbol);

   168

   169

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

   170

    /* B 1.4.2 - Multi-element variables */

   171

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

   172

    void *visit(array_variable_c *symbol);

   173

    void *visit(structured_variable_c *symbol);

   174

   175

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

   176

    /* B 1.5 - Program organization units */

   177

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

   178

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

   179

    /* B 1.5.1 - Functions */

   180

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

   181

    void *visit(function_declaration_c *symbol);

   182

   183

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

   184

    /* B 1.5.2 - Function blocks */

   185

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

   186

    void *visit(function_block_declaration_c *symbol);

   187

   188

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

   189

    /* B 1.5.3 - Programs */

   190

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

   191

    void *visit(program_declaration_c *symbol);

   192

   193

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

   194

    /* B 1.7 Configuration elements */

   195

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

   196

    void *visit(configuration_declaration_c *symbol);

   197

   198

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

   199

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

   200

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

   201

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

   202

    /* B 2.1 Instructions and Operands */

   203

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

   204

    void *visit(instruction_list_c *symbol);

   205

    void *visit(il_instruction_c *symbol);

   206

    void *visit(il_simple_operation_c *symbol);

   207

    void *visit(il_function_call_c *symbol);

   208

    void *visit(il_expression_c *symbol);

   209

    void *visit(il_jump_operation_c *symbol);

   210

    void *visit(il_fb_call_c *symbol);

   211

    void *visit(il_formal_funct_call_c *symbol);

   212

//  void *visit(il_operand_list_c *symbol);

   213

    void *visit(simple_instr_list_c *symbol);

   214

    void *visit(il_simple_instruction_c*symbol);

   215

//  void *visit(il_param_list_c *symbol);

   216

//  void *visit(il_param_assignment_c *symbol);

   217

//  void *visit(il_param_out_assignment_c *symbol);

   218

   219

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

   220

    /* B 2.2 Operators */

   221

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

   222

    void *visit(LD_operator_c *symbol);

   223

    void *visit(LDN_operator_c *symbol);

   224

    void *visit(ST_operator_c *symbol);

   225

    void *visit(STN_operator_c *symbol);

   226

    void *visit(NOT_operator_c *symbol);

   227

    void *visit(S_operator_c *symbol);

   228

    void *visit(R_operator_c *symbol);

   229

    void *visit(S1_operator_c *symbol);

   230

    void *visit(R1_operator_c *symbol);

   231

    void *visit(CLK_operator_c *symbol);

   232

    void *visit(CU_operator_c *symbol);

   233

    void *visit(CD_operator_c *symbol);

   234

    void *visit(PV_operator_c *symbol);

   235

    void *visit(IN_operator_c *symbol);

   236

    void *visit(PT_operator_c *symbol);

   237

    void *visit(AND_operator_c *symbol);

   238

    void *visit(OR_operator_c *symbol);

   239

    void *visit(XOR_operator_c *symbol);

   240

    void *visit(ANDN_operator_c *symbol);

   241

    void *visit(ORN_operator_c *symbol);

   242

    void *visit(XORN_operator_c *symbol);

   243

    void *visit(ADD_operator_c *symbol);

   244

    void *visit(SUB_operator_c *symbol);

   245

    void *visit(MUL_operator_c *symbol);

   246

    void *visit(DIV_operator_c *symbol);

   247

    void *visit(MOD_operator_c *symbol);

   248

    void *visit(GT_operator_c *symbol);

   249

    void *visit(GE_operator_c *symbol);

   250

    void *visit(EQ_operator_c *symbol);

   251

    void *visit(LT_operator_c *symbol);

   252

    void *visit(LE_operator_c *symbol);

   253

    void *visit(NE_operator_c *symbol);

   254

    void *visit(CAL_operator_c *symbol);

   255

    void *visit(CALC_operator_c *symbol);

   256

    void *visit(CALCN_operator_c *symbol);

   257

    void *visit(RET_operator_c *symbol);

   258

    void *visit(RETC_operator_c *symbol);

   259

    void *visit(RETCN_operator_c *symbol);

   260

    void *visit(JMP_operator_c *symbol);

   261

    void *visit(JMPC_operator_c *symbol);

   262

    void *visit(JMPCN_operator_c *symbol);

   263

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

   264

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

   265

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

   266

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

   267

   268

   269

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

   270

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

   271

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

   272

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

   273

    /* B 3.1 - Expressions */

   274

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

   275

    void *visit(or_expression_c *symbol);

   276

    void *visit(xor_expression_c *symbol);

   277

    void *visit(and_expression_c *symbol);

   278

    void *visit(equ_expression_c *symbol);

   279

    void *visit(notequ_expression_c *symbol);

   280

    void *visit(lt_expression_c *symbol);

   281

    void *visit(gt_expression_c *symbol);

   282

    void *visit(le_expression_c *symbol);

   283

    void *visit(ge_expression_c *symbol);

   284

    void *visit(add_expression_c *symbol);

   285

    void *visit(sub_expression_c *symbol);

   286

    void *visit(mul_expression_c *symbol);

   287

    void *visit(div_expression_c *symbol);

   288

    void *visit(mod_expression_c *symbol);

   289

    void *visit(power_expression_c *symbol);

   290

    void *visit(neg_expression_c *symbol);

   291

    void *visit(not_expression_c *symbol);

   292

    void *visit(function_invocation_c *symbol);

   293

   294

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

   295

    /* B 3.2.1 Assignment Statements */

   296

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

   297

    void *visit(assignment_statement_c *symbol);

   298

   299

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

   300

    /* B 3.2.2 Subprogram Control Statements */

   301

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

   302

    void *visit(fb_invocation_c *symbol);

   303

   304

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

   305

    /* B 3.2.3 Selection Statements */

   306

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

   307

    void *visit(if_statement_c *symbol);

   308

    //     void *visit(elseif_statement_list_c *symbol);

   309

    void *visit(elseif_statement_c *symbol);

   310

    void *visit(case_statement_c *symbol);

   311

   312

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

   313

    /* B 3.2.4 Iteration Statements */

   314

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

   315

    void *visit(for_statement_c *symbol);

   316

    void *visit(while_statement_c *symbol);

   317

    void *visit(repeat_statement_c *symbol);

   318

   319

}; // fill_candidate_datatypes_c

   320

   321

   322

   323

   324

   325

   326

   327

   328

   329

   330