1

/*

     2

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

     3

 *

     4

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

     5

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

     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

/* Verify whether the semantic rules of data type compatibility are being followed.

    34

 *

    35

 * For example:

    36

 */

    37

    38

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

    39

    40

class visit_expression_type_c: public search_constant_type_c {

    41

    42

  private:

    43

    search_varfb_instance_type_c *search_varfb_instance_type;

    44

    search_base_type_c search_base_type;

    45

    46

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

    47

     * by searching through the declarations of the variables currently

    48

     * in scope.

    49

     * This class does just that...

    50

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

    51

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

    52

     * This object instance will then later be called while the

    53

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

    54

     *

    55

     * Note that functions cannot contain calls to function blocks,

    56

     * so we do not create an object instance when handling

    57

     * a function declaration.

    58

     */

    59

//     search_var_instance_decl_c *search_var_instance_decl;

    60

    61

     /* This variable was created to pass information from

    62

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

    63

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

    64

      */

    65

      symbol_c *case_expression_type;

    66

    67

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

    68

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

    69

     * i.e. until the next LD.

    70

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

    71

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

    72

     * within parenthesis may not clear the error flag.

    73

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

    74

     * structure we are.

    75

     */

    76

    int  il_parenthesis_level;

    77

    bool il_error;

    78

    bool error_found;

    79

    80

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

    81

    symbol_c *il_default_variable_type;

    82

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

    83

    symbol_c *il_operand_type;

    84

    symbol_c *il_operand;

    85

    86

    87

  public:

    88

    visit_expression_type_c(symbol_c *ignore);

    89

    virtual ~visit_expression_type_c(void);

    90

    91

    bool get_error_found(void);

    92

    93

    typedef struct {

    94

      symbol_c *value;

    95

      symbol_c *type;

    96

    } value_and_type_t; 

    97

    98

    /* A helper function... */

    99

    bool is_ANY_ELEMENTARY_type         (symbol_c *type_symbol);

   100

    bool is_ANY_SAFEELEMENTARY_type     (symbol_c *type_symbol);

   101

    bool is_ANY_ELEMENTARY_compatible   (symbol_c *type_symbol);

   102

   103

    bool is_ANY_MAGNITUDE_type          (symbol_c *type_symbol);

   104

    bool is_ANY_SAFEMAGNITUDE_type      (symbol_c *type_symbol);

   105

    bool is_ANY_MAGNITUDE_compatible    (symbol_c *type_symbol);

   106

   107

    bool is_ANY_DATE_type               (symbol_c *type_symbol);

   108

    bool is_ANY_SAFEDATE_type           (symbol_c *type_symbol);

   109

    bool is_ANY_DATE_compatible         (symbol_c *type_symbol);

   110

   111

    bool is_ANY_STRING_type             (symbol_c *type_symbol);

   112

    bool is_ANY_SAFESTRING_type         (symbol_c *type_symbol);

   113

    bool is_ANY_STRING_compatible       (symbol_c *type_symbol);   

   114

   115

    bool is_ANY_INT_type                (symbol_c *type_symbol);

   116

    bool is_ANY_SAFEINT_type            (symbol_c *type_symbol);

   117

    bool is_ANY_INT_compatible          (symbol_c *type_symbol);

   118

   119

    bool is_ANY_REAL_type               (symbol_c *type_symbol);

   120

    bool is_ANY_SAFEREAL_type           (symbol_c *type_symbol);

   121

    bool is_ANY_REAL_compatible         (symbol_c *type_symbol);

   122

   123

    bool is_ANY_NUM_type                (symbol_c *type_symbol);

   124

    bool is_ANY_SAFENUM_type            (symbol_c *type_symbol);

   125

    bool is_ANY_NUM_compatible          (symbol_c *type_symbol);

   126

   127

    bool is_ANY_BIT_type                (symbol_c *type_symbol);

   128

    bool is_ANY_SAFEBIT_type            (symbol_c *type_symbol);

   129

    bool is_ANY_BIT_compatible          (symbol_c *type_symbol);

   130

   131

    bool is_BOOL_type                   (symbol_c *type_symbol);

   132

    bool is_SAFEBOOL_type               (symbol_c *type_symbol);

   133

    bool is_ANY_BOOL_compatible         (symbol_c *type_symbol);

   134

   135

    bool is_nonneg_literal_integer_type (symbol_c *type_symbol);

   136

    bool is_literal_integer_type        (symbol_c *type_symbol);

   137

    bool is_literal_real_type           (symbol_c *type_symbol);

   138

    bool is_literal_bool_type           (symbol_c *type_symbol);

   139

   140

    /* Determine the common data type between two data types.

   141

     * If no common data type found, return NULL.

   142

     *

   143

     * If data types are identical, return the first (any would do...).

   144

     * If any of the datat types is a literal, we confirm that 

   145

     *   the literal uses less bits than the fixed size data type.

   146

     *   e.g. BYTE and 1024 returns NULL

   147

     *        BYTE and 255  returns BYTE

   148

     *

   149

     * If two literals, then return the literal that requires more bits...

   150

     */

   151

    symbol_c *common_type__(symbol_c *first_type, symbol_c *second_type);

   152

    /* Determine the common data type between two data types.

   153

     * Unlike the common_type__() function, we stop the compiler with an ERROR

   154

     *  if no common data type is found.

   155

     */

   156

    symbol_c *common_type(symbol_c *first_type, symbol_c *second_type);

   157

/* Return TRUE if the second (value) data type may be assigned to a variable of the first (variable) data type

   158

 * such as: 

   159

 *     var_type     value_type

   160

 *    BOOL           BYTE#7     -> returns false

   161

 *    INT            INT#7      -> returns true

   162

 *    INT            7          -> returns true

   163

 *    REAL           7.89       -> returns true

   164

 *    REAL           7          -> returns true

   165

 *    INT            7.89       -> returns false

   166

 *    SAFEBOOL       BOOL#1     -> returns false   !!!

   167

 *   etc...

   168

 *

   169

 * NOTE: It is assumed that the var_type is the data type of an lvalue

   170

 */

   171

    bool is_valid_assignment(symbol_c *var_type, symbol_c *value_type);

   172

   173

/* Return TRUE if there is a common data type, otherwise return FALSE

   174

 * i.e., return TRUE if both data types may be used simultaneously in an expression

   175

 * such as:

   176

 *    BOOL#0     AND BYTE#7  -> returns false

   177

 *    0          AND BYTE#7  -> returns true

   178

 *    INT#10     AND INT#7   -> returns true

   179

 *    INT#10     AND 7       -> returns true

   180

 *    REAL#34.3  AND 7.89    -> returns true

   181

 *    REAL#34.3  AND 7       -> returns true

   182

 *    INT#10     AND 7.89    -> returns false

   183

 *    SAFEBOOL#0 AND BOOL#1  -> returns true   !!!

   184

 *   etc...

   185

 */

   186

    bool is_compatible_type(symbol_c *first_type, symbol_c *second_type);

   187

   188

    void compute_input_operatores(symbol_c *symbol, const char *input_operator);

   189

    void check_formal_parameter(symbol_c *call_param_name, symbol_c *call_param_type, symbol_c *f_decl);

   190

   191

    /* check the semantics of a FB or Function non-formal call */

   192

    /* e.g. foo(1, 2, 3, 4);  */

   193

    void check_nonformal_call(symbol_c *f_call, symbol_c *f_decl, bool use_il_defvar = false);

   194

    /* check the semantics of a FB or Function formal call */

   195

    /* e.g. foo(IN1 := 1, OUT1 =>x, EN := true);  */

   196

    void check_formal_call(symbol_c *f_call, symbol_c *f_decl);

   197

   198

   199

    void *compute_standard_function_default(function_invocation_c *st_symbol, il_formal_funct_call_c *il_symbol);

   200

    void *compute_standard_function_il(il_function_call_c *symbol, symbol_c *param_data_type);

   201

   202

   203

    /* A helper function... */

   204

    typedef bool (visit_expression_type_c::*is_data_type_t)(symbol_c *type_symbol);  /* a pointer to a function! */

   205

//    symbol_c *compute_boolean_expression(symbol_c *left_exp, symbol_c *right_exp, is_data_type_t is_data_type);

   206

//    symbol_c *compute_numeric_expression(symbol_c *left_exp, symbol_c *right_exp, is_data_type_t is_data_type);

   207

//    symbol_c *compute_expression(symbol_c *left_exp, symbol_c *right_exp, is_data_type_t is_data_type);

   208

    symbol_c *compute_expression(symbol_c *left_type, symbol_c *right_type, is_data_type_t is_data_type,

   209

                                 symbol_c *left_expr=NULL, symbol_c *right_expr=NULL);

   210

   211

   212

    /* a helper function... */

   213

    symbol_c *base_type(symbol_c *symbol);

   214

   215

    /* a helper function... */

   216

    void *verify_null(symbol_c *symbol);

   222

   223

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

   224

    /* B 1.4 - Variables */

   225

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

   226

    void *visit(symbolic_variable_c *symbol);

   227

   228

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

   229

    /* B 1.4.1 - Directly Represented Variables */

   230

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

   231

    void *visit(direct_variable_c *symbol);

   232

   233

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

   234

    /* B 1.4.2 - Multi-element variables */

   235

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

   236

   237

    void *visit(array_variable_c *symbol);

   238

    void *visit(structured_variable_c *symbol);

   239

   240

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

   241

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

   242

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

   243

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

   244

    /* B 2.1 Instructions and Operands */

   245

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

   246

    // void *visit(instruction_list_c *symbol);

   247

    void *visit(il_simple_operation_c *symbol);

   248

    void *visit(il_function_call_c *symbol);

   249

    void *visit(il_expression_c *symbol);

   250

//     void *visit(il_jump_operation_c *symbol);

   251

    void *visit(il_fb_call_c *symbol);

   252

    void *visit(il_formal_funct_call_c *symbol);

   253

    /*

   254

    void *visit(il_operand_list_c *symbol);

   255

    void *visit(simple_instr_list_c *symbol);

   256

    void *visit(il_param_list_c *symbol);

   257

    void *visit(il_param_assignment_c *symbol);

   258

    void *visit(il_param_out_assignment_c *symbol);

   259

    */

   260

   261

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

   262

    /* B 2.2 Operators */

   263

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

   264

    void *visit(LD_operator_c *symbol);

   265

    void *visit(LDN_operator_c *symbol);

   266

    void *visit(ST_operator_c *symbol);

   267

    void *visit(STN_operator_c *symbol);

   268

    void *visit(NOT_operator_c *symbol);

   269

    void *visit(S_operator_c *symbol);

   270

    void *visit(R_operator_c *symbol);

   271

    void *visit(S1_operator_c *symbol);

   272

    void *visit(R1_operator_c *symbol);

   273

    void *visit(CLK_operator_c *symbol);

   274

    void *visit(CU_operator_c *symbol);

   275

    void *visit(CD_operator_c *symbol);

   276

    void *visit(PV_operator_c *symbol);

   277

    void *visit(IN_operator_c *symbol);

   278

    void *visit(PT_operator_c *symbol);

   279

    void *visit(AND_operator_c *symbol);

   280

    void *visit(OR_operator_c *symbol);

   281

    void *visit(XOR_operator_c *symbol);

   282

    void *visit(ANDN_operator_c *symbol);

   283

    void *visit(ORN_operator_c *symbol);

   284

    void *visit(XORN_operator_c *symbol);

   285

    void *visit(ADD_operator_c *symbol);

   286

    void *visit(SUB_operator_c *symbol);

   287

    void *visit(MUL_operator_c *symbol);

   288

    void *visit(DIV_operator_c *symbol);

   289

    void *visit(MOD_operator_c *symbol);

   290

    void *visit(GT_operator_c *symbol);

   291

    void *visit(GE_operator_c *symbol);

   292

    void *visit(EQ_operator_c *symbol);

   293

    void *visit(LT_operator_c *symbol);

   294

    void *visit(LE_operator_c *symbol);

   295

    void *visit(NE_operator_c *symbol);

   296

    void *visit(CAL_operator_c *symbol);

   297

    void *visit(CALC_operator_c *symbol);

   298

    void *visit(CALCN_operator_c *symbol);

   299

    void *visit(RET_operator_c *symbol);

   300

    void *visit(RETC_operator_c *symbol);

   301

    void *visit(RETCN_operator_c *symbol);

   302

    void *visit(JMP_operator_c *symbol);

   303

    void *visit(JMPC_operator_c *symbol);

   304

    void *visit(JMPCN_operator_c *symbol);

   305

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

   306

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

   307

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

   308

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

   309

   310

   311

   312

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

   313

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

   314

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

   315

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

   316

    /* B 3.1 - Expressions */

   317

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

   318

    void *visit(or_expression_c *symbol);

   319

    void *visit(xor_expression_c *symbol);

   320

    void *visit(and_expression_c *symbol);

   321

    void *visit(equ_expression_c *symbol);

   322

    void *visit(notequ_expression_c *symbol);

   323

    void *visit(lt_expression_c *symbol);

   324

    void *visit(gt_expression_c *symbol);

   325

    void *visit(le_expression_c *symbol);

   326

    void *visit(ge_expression_c *symbol);    

   327

    void *visit(add_expression_c *symbol);

   328

    void *visit(sub_expression_c *symbol);

   329

    void *visit(mul_expression_c *symbol);

   330

    void *visit(div_expression_c *symbol);

   331

    void *visit(mod_expression_c *symbol);

   332

    void *visit(power_expression_c *symbol);

   333

    void *visit(neg_expression_c *symbol);

   334

    void *visit(not_expression_c *symbol);

   335

    void *visit(function_invocation_c *symbol);

   336

   337

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

   338

    /* B 3.2.1 Assignment Statements */

   339

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

   340

    void *visit(assignment_statement_c *symbol);

   341

   342

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

   343

    /* B 3.2.2 Subprogram Control Statements */

   344

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

   345

    void *visit(fb_invocation_c *symbol);

   346

   347

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

   348

    /* B 3.2.3 Selection Statements */

   349

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

   350

   351

    void *visit(if_statement_c *symbol);    

   352

//     void *visit(elseif_statement_list_c *symbol);

   353

    void *visit(elseif_statement_c *symbol);

   354

    void *visit(case_statement_c *symbol);

   355

//     void *visit(case_element_list_c *symbol);

   356

//     void *visit(case_element_c *symbol);   

   357

   void *visit(case_list_c *symbol);

   358

   359

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

   360

    /* B 3.2.4 Iteration Statements */

   361

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

   362

   363

    void *visit(for_statement_c *symbol);

   364

    void *visit(while_statement_c *symbol);

   365

    void *visit(repeat_statement_c *symbol);

   366

   367

   368

//TODO: delete this functions. Why are they needed?

   369

void *visit(program_declaration_c *symbol);

   370

void *visit(function_declaration_c *symbol);

   371

void *visit(function_block_declaration_c *symbol);

   372

   373

}; // visit_expression_type_c

   374