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

/* NOTE: The algorithm implemented here assumes that candidate datatype lists have already been filled!

    37

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

    38

 */

    39

    40

    41

/*

    42

 *  Choose, from the list of all the possible datatypes each expression may take, the single datatype that it will in fact take.

    43

 *  The resulting (chosen) datatype, will be stored in the symbol_c.datatype variable, leaving the candidate datatype list untouched!

    44

 * 

    45

 *  For rvalue expressions, this decision will be based on the datatype of the lvalue expression.

    46

 *  For lvalue expressions, the candidate datatype list should have a single entry.

    47

 * 

    48

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

    49

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

    50

 * 

    51

 *  In this class, the datatype of '0' will be set to the same datatype as the 'foo' variable.

    52

 *  If the intersection of the candidate datatype lists of the left and right side expressions is empty, 

    53

 *  then a datatype error has been found, and the datatype is either left at NULL, or set to a pointer of an invalid_type_name_c object!

    54

 */

    55

    56

#ifndef _NARROW_CANDIDATE_DATATYPES_HH

    57

#define _NARROW_CANDIDATE_DATATYPES_HH

    58

    59

    60

    61

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

    62

#include "datatype_functions.hh"

    63

    64

class narrow_candidate_datatypes_c: public iterator_visitor_c {

    65

    66

  private:

    67

    search_varfb_instance_type_c *search_varfb_instance_type;

    68

    symbol_c *il_operand;

    69

    il_instruction_c *fake_prev_il_instruction;

    70

    il_instruction_c   *current_il_instruction;

    71

    72

  protected:  

    73

    virtual void set_datatype_in_prev_il_instructions(symbol_c *datatype, il_instruction_c *symbol);

    74

    75

  private:

    76

    bool is_widening_compatible(const struct widen_entry widen_table[], symbol_c *left_type, symbol_c *right_type, symbol_c *result_type, bool *deprecated_status = NULL);

    77

    78

    void *narrow_spec_init           (symbol_c *symbol, symbol_c *type_decl, symbol_c *init_value);

    79

    void *narrow_type_decl           (symbol_c *symbol, symbol_c *type_name, symbol_c *spec_init);

    80

    void  narrow_function_invocation (symbol_c *f_call, generic_function_call_t fcall_data);

    81

    void  narrow_nonformal_call      (symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count = NULL);

    82

    void  narrow_formal_call         (symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count = NULL);

    83

    void *narrow_implicit_il_fb_call (symbol_c *symbol, const char *param_name, symbol_c *&called_fb_declaration);

    84

    void *narrow_S_and_R_operator    (symbol_c *symbol, const char *param_name, symbol_c * called_fb_declaration);

    85

    void *narrow_store_operator      (symbol_c *symbol);

    86

    void *narrow_conditional_operator(symbol_c *symbol);

    87

    void *narrow_binary_operator     (const struct widen_entry widen_table[], symbol_c *symbol,                                     bool *deprecated_operation = NULL);

    88

    void *narrow_binary_expression   (const struct widen_entry widen_table[], symbol_c *symbol, symbol_c *l_expr, symbol_c *r_expr, bool *deprecated_operation = NULL, bool allow_enums = false);

    89

    void *narrow_equality_comparison (const struct widen_entry widen_table[], symbol_c *symbol, symbol_c *l_expr, symbol_c *r_expr, bool *deprecated_operation = NULL);

    90

    void *narrow_var_declaration     (symbol_c *type);

    91

    92

    void *set_il_operand_datatype    (symbol_c *il_operand, symbol_c *datatype);

    93

    94

    95

    96

  public:

    97

    narrow_candidate_datatypes_c(symbol_c *ignore);

    98

    virtual ~narrow_candidate_datatypes_c(void);

    99

   100

    symbol_c *base_type(symbol_c *symbol);

   101

   102

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

   103

    /* B.1 - Common elements */

   104

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

   105

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

   106

    /* B 1.1 - Letters, digits and identifiers */

   107

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

   108

//  void *visit(                 identifier_c *symbol);

   109

    void *visit(derived_datatype_identifier_c *symbol);

   110

//  void *visit(         poutype_identifier_c *symbol);

   111

   112

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

   113

    /* B 1.3 - Data types */

   114

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

   115

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

   116

    /* B 1.3.1 - Elementary Data Types */

   117

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

   118

    void *visit(    time_type_name_c    *symbol); 

   119

    void *visit(    bool_type_name_c    *symbol); 

   120

    void *visit(    sint_type_name_c    *symbol); 

   121

    void *visit(    int_type_name_c     *symbol); 

   122

    void *visit(    dint_type_name_c    *symbol); 

   123

    void *visit(    lint_type_name_c    *symbol); 

   124

    void *visit(    usint_type_name_c   *symbol); 

   125

    void *visit(    uint_type_name_c    *symbol); 

   126

    void *visit(    udint_type_name_c   *symbol); 

   127

    void *visit(    ulint_type_name_c   *symbol); 

   128

    void *visit(    real_type_name_c    *symbol); 

   129

    void *visit(    lreal_type_name_c   *symbol); 

   130

    void *visit(    date_type_name_c    *symbol); 

   131

    void *visit(    tod_type_name_c     *symbol); 

   132

    void *visit(    dt_type_name_c      *symbol); 

   133

    void *visit(    byte_type_name_c    *symbol); 

   134

    void *visit(    word_type_name_c    *symbol); 

   135

    void *visit(    dword_type_name_c   *symbol); 

   136

    void *visit(    lword_type_name_c   *symbol); 

   137

    void *visit(    string_type_name_c  *symbol); 

   138

    void *visit(    wstring_type_name_c *symbol); 

   139

   140

    void *visit(safetime_type_name_c    *symbol); 

   141

    void *visit(safebool_type_name_c    *symbol); 

   142

    void *visit(safesint_type_name_c    *symbol); 

   143

    void *visit(safeint_type_name_c     *symbol); 

   144

    void *visit(safedint_type_name_c    *symbol); 

   145

    void *visit(safelint_type_name_c    *symbol); 

   146

    void *visit(safeusint_type_name_c   *symbol); 

   147

    void *visit(safeuint_type_name_c    *symbol); 

   148

    void *visit(safeudint_type_name_c   *symbol); 

   149

    void *visit(safeulint_type_name_c   *symbol); 

   150

    void *visit(safereal_type_name_c    *symbol); 

   151

    void *visit(safelreal_type_name_c   *symbol); 

   152

    void *visit(safedate_type_name_c    *symbol); 

   153

    void *visit(safetod_type_name_c     *symbol); 

   154

    void *visit(safedt_type_name_c      *symbol); 

   155

    void *visit(safebyte_type_name_c    *symbol); 

   156

    void *visit(safeword_type_name_c    *symbol); 

   157

    void *visit(safedword_type_name_c   *symbol); 

   158

    void *visit(safelword_type_name_c   *symbol); 

   159

    void *visit(safestring_type_name_c  *symbol); 

   160

    void *visit(safewstring_type_name_c *symbol); 

   161

   162

   163

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

   164

    /* B.1.3.2 - Generic data types */

   165

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

   166

   167

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

   168

    /* B 1.3.3 - Derived data types */

   169

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

   170

//  void *visit(data_type_declaration_c *symbol);   /* Not required. already handled by iterator_visitor_c base class */

   171

//  void *visit(type_declaration_list_c *symbol);   /* Not required. already handled by iterator_visitor_c base class */

   172

    void *visit(simple_type_declaration_c *symbol); /* Not required. already handled by iterator_visitor_c base class */

   173

    void *visit(simple_spec_init_c *symbol);

   174

    void *visit(subrange_type_declaration_c *symbol);

   175

    void *visit(subrange_spec_init_c *symbol);

   176

    void *visit(subrange_specification_c *symbol);

   177

    void *visit(subrange_c *symbol);

   178

    void *visit(enumerated_type_declaration_c *symbol);

   179

    void *visit(enumerated_spec_init_c *symbol);

   180

    void *visit(enumerated_value_list_c *symbol);

   181

//  void *visit(enumerated_value_c *symbol);        /* Not required */

   182

    void *visit(array_type_declaration_c *symbol);

   183

    void *visit(array_spec_init_c *symbol);

   184

//  void *visit(array_specification_c *symbol);

   185

//  void *visit(array_subrange_list_c *symbol);

   186

//  void *visit(array_initial_elements_list_c *symbol);

   187

//  void *visit(array_initial_elements_c *symbol);

   188

    void *visit(structure_type_declaration_c *symbol);

   189

    void *visit(initialized_structure_c *symbol);

   190

//  void *visit(structure_element_declaration_list_c *symbol);

   191

//  void *visit(structure_element_declaration_c *symbol);

   192

    void *visit(structure_element_initialization_list_c *symbol);

   193

    void *visit(structure_element_initialization_c *symbol);

   194

//  void *visit(string_type_declaration_c *symbol);

   195

    void *visit(fb_spec_init_c *symbol);

   196

   197

    void *visit(ref_spec_c *symbol);      // Defined in IEC 61131-3 v3

   198

    void *visit(ref_spec_init_c *symbol); // Defined in IEC 61131-3 v3

   199

    void *visit(ref_type_decl_c *symbol); // Defined in IEC 61131-3 v3

   200

   201

   202

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

   203

    /* B 1.4 - Variables */

   204

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

   205

    void *visit(symbolic_variable_c *symbol);

   206

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

   207

    /* B 1.4.1 - Directly Represented Variables */

   208

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

   209

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

   210

    /* B 1.4.2 - Multi-element variables */

   211

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

   212

    void *visit(array_variable_c *symbol);

   213

    void *visit(subscript_list_c *symbol);

   214

    void *visit(structured_variable_c *symbol);

   215

   216

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

   217

    /* B 1.4.3 - Declaration & Initialisation */

   218

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

   219

    void *visit(var1_list_c                  *symbol);

   220

    void *visit(location_c                   *symbol);

   221

    void *visit(located_var_decl_c           *symbol);

   222

    void *visit(var1_init_decl_c             *symbol);

   223

    void *visit(array_var_init_decl_c        *symbol);

   224

    void *visit(structured_var_init_decl_c   *symbol);

   225

    void *visit(fb_name_decl_c               *symbol);

   226

    void *visit(array_var_declaration_c      *symbol);

   227

    void *visit(structured_var_declaration_c *symbol);

   228

    void *visit(external_declaration_c       *symbol);

   229

    void *visit(global_var_decl_c            *symbol);

   230

    void *visit(incompl_located_var_decl_c   *symbol);

   231

    //void *visit(single_byte_string_var_declaration_c *symbol);

   232

    //void *visit(double_byte_string_var_declaration_c *symbol);

   233

   234

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

   235

    /* B 1.5 - Program organization units */

   236

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

   237

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

   238

    /* B 1.5.1 - Functions */

   239

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

   240

    void *visit(function_declaration_c *symbol);

   241

   242

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

   243

    /* B 1.5.2 - Function blocks */

   244

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

   245

    void *visit(function_block_declaration_c *symbol);

   246

   247

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

   248

    /* B 1.5.3 - Programs */

   249

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

   250

    void *visit(program_declaration_c *symbol);

   251

   252

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

   253

    /* B 1.6 Sequential function chart elements */

   254

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

   255

    void *visit(transition_condition_c *symbol);

   256

    void *visit(action_qualifier_c     *symbol);

   257

   258

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

   259

    /* B 1.7 Configuration elements */

   260

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

   261

    void *visit(configuration_declaration_c   *symbol);

   262

    void *visit(resource_declaration_c        *symbol);

   263

    void *visit(single_resource_declaration_c *symbol);

   264

   265

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

   266

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

   267

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

   268

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

   269

    /* B 2.1 Instructions and Operands */

   270

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

   271

    void *visit(instruction_list_c *symbol);

   272

    void *visit(il_instruction_c *symbol);

   273

    void *visit(il_simple_operation_c *symbol);

   274

    void *visit(il_function_call_c *symbol);

   275

    void *visit(il_expression_c *symbol);

   276

    void *visit(il_jump_operation_c *symbol);

   277

    void *visit(il_fb_call_c *symbol);

   278

    void *visit(il_formal_funct_call_c *symbol);

   279

//  void *visit(il_operand_list_c *symbol);

   280

    void *visit(simple_instr_list_c *symbol);

   281

    void *visit(il_simple_instruction_c*symbol);

   282

//  void *visit(il_param_list_c *symbol);

   283

//  void *visit(il_param_assignment_c *symbol);

   284

//  void *visit(il_param_out_assignment_c *symbol);

   285

   286

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

   287

    /* B 2.2 Operators */

   288

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

   289

    void *visit(LD_operator_c *symbol);

   290

    void *visit(LDN_operator_c *symbol);

   291

    void *visit(ST_operator_c *symbol);

   292

    void *visit(STN_operator_c *symbol);

   293

    void *visit(NOT_operator_c *symbol);

   294

    void *visit(S_operator_c *symbol);

   295

    void *visit(R_operator_c *symbol);

   296

    void *visit(S1_operator_c *symbol);

   297

    void *visit(R1_operator_c *symbol);

   298

    void *visit(CLK_operator_c *symbol);

   299

    void *visit(CU_operator_c *symbol);

   300

    void *visit(CD_operator_c *symbol);

   301

    void *visit(PV_operator_c *symbol);

   302

    void *visit(IN_operator_c *symbol);

   303

    void *visit(PT_operator_c *symbol);

   304

    void *visit(AND_operator_c *symbol);

   305

    void *visit(OR_operator_c *symbol);

   306

    void *visit(XOR_operator_c *symbol);

   307

    void *visit(ANDN_operator_c *symbol);

   308

    void *visit(ORN_operator_c *symbol);

   309

    void *visit(XORN_operator_c *symbol);

   310

    void *visit(ADD_operator_c *symbol);

   311

    void *visit(SUB_operator_c *symbol);

   312

    void *visit(MUL_operator_c *symbol);

   313

    void *visit(DIV_operator_c *symbol);

   314

    void *visit(MOD_operator_c *symbol);

   315

    void *visit(GT_operator_c *symbol);

   316

    void *visit(GE_operator_c *symbol);

   317

    void *visit(EQ_operator_c *symbol);

   318

    void *visit(LT_operator_c *symbol);

   319

    void *visit(LE_operator_c *symbol);

   320

    void *visit(NE_operator_c *symbol);

   321

    void *visit(CAL_operator_c *symbol);

   322

    void *visit(CALC_operator_c *symbol);

   323

    void *visit(CALCN_operator_c *symbol);

   324

    void *visit(RET_operator_c *symbol);

   325

    void *visit(RETC_operator_c *symbol);

   326

    void *visit(RETCN_operator_c *symbol);

   327

    void *visit(JMP_operator_c *symbol);

   328

    void *visit(JMPC_operator_c *symbol);

   329

    void *visit(JMPCN_operator_c *symbol);

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

    /* B 3.1 - Expressions */

   339

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

   340

    void *visit(   deref_operator_c   *symbol);

   341

    void *visit(   deref_expression_c *symbol);

   342

    void *visit(     ref_expression_c *symbol);

   343

    void *visit(      or_expression_c *symbol);

   344

    void *visit(     xor_expression_c *symbol);

   345

    void *visit(     and_expression_c *symbol);

   346

    void *visit(     equ_expression_c *symbol);

   347

    void *visit(  notequ_expression_c *symbol);

   348

    void *visit(      lt_expression_c *symbol);

   349

    void *visit(      gt_expression_c *symbol);

   350

    void *visit(      le_expression_c *symbol);

   351

    void *visit(      ge_expression_c *symbol);

   352

    void *visit(     add_expression_c *symbol);

   353

    void *visit(     sub_expression_c *symbol);

   354

    void *visit(     mul_expression_c *symbol);

   355

    void *visit(     div_expression_c *symbol);

   356

    void *visit(     mod_expression_c *symbol);

   357

    void *visit(   power_expression_c *symbol);

   358

    void *visit(     neg_expression_c *symbol);

   359

    void *visit(     not_expression_c *symbol);

   360

    void *visit(function_invocation_c *symbol);

   361

   362

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

   363

    /* B 3.2.1 Assignment Statements */

   364

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

   365

    void *visit(assignment_statement_c *symbol);

   366

   367

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

   368

    /* B 3.2.2 Subprogram Control Statements */

   369

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

   370

    void *visit(fb_invocation_c *symbol);

   371

   372

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

   373

    /* B 3.2.3 Selection Statements */

   374

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

   375

    void *visit(if_statement_c *symbol);

   376

    void *visit(elseif_statement_c *symbol);

   377

    void *visit(case_statement_c *symbol);

   378

    void *visit(case_element_list_c *symbol);

   379

    void *visit(case_element_c *symbol);

   380

    void *visit(case_list_c *symbol);

   381

   382

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

   383

    /* B 3.2.4 Iteration Statements */

   384

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

   385

    void *visit(for_statement_c *symbol);

   386

    void *visit(while_statement_c *symbol);

   387

    void *visit(repeat_statement_c *symbol);

   388

   389

}; // narrow_candidate_datatypes_c

   390

   391

   392

   393

   394

#endif // #ifndef _NARROW_CANDIDATE_DATATYPES_HH

   395

   396

   397