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

     6

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

     7

 *

     8

 *  This program is free software: you can redistribute it and/or modify

     9

 *  it under the terms of the GNU General Public License as published by

    10

 *  the Free Software Foundation, either version 3 of the License, or

    11

 *  (at your option) any later version.

    12

 *

    13

 *  This program is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    20

 *

    21

 *

    22

 * This code is made available on the understanding that it will not be

    23

 * used in safety-critical situations without a full and competent review.

    24

 */

    25

    26

/*

    27

 * An IEC 61131-3 compiler.

    28

 *

    29

 * Based on the

    30

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    31

 *

    32

 */

    33

    34

    35

/*

    36

 *  Fill candidate list of data types for all symbols

    37

 */

    38

    39

#include "print_datatypes_error.hh"

    40

#include "datatype_functions.hh"

    41

    42

#include <typeinfo>

    43

#include <list>

    44

#include <string>

    45

#include <string.h>

    46

#include <strings.h>

    47

    48

    49

    50

    51

    52

    53

#define FIRST_(symbol1, symbol2) (((symbol1)->first_order < (symbol2)->first_order)   ? (symbol1) : (symbol2))

    54

#define  LAST_(symbol1, symbol2) (((symbol1)->last_order  > (symbol2)->last_order)    ? (symbol1) : (symbol2))

    55

    56

#define STAGE3_ERROR(error_level, symbol1, symbol2, ...) {                                                                  \

    57

  if (current_display_error_level >= error_level) {                                                                         \

    58

    fprintf(stderr, "%s:%d-%d..%d-%d: error: ",                                                                             \

    59

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    60

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    61

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    62

    fprintf(stderr, "\n");                                                                                                  \

    63

    il_error = true;                                                                                                        \

    64

    error_found = true;                                                                                                     \

    65

  }                                                                                                                         \

    66

}  

    67

    68

    69

#define STAGE3_WARNING(symbol1, symbol2, ...) {                                                                             \

    70

    fprintf(stderr, "%s:%d-%d..%d-%d: warning: ",                                                                           \

    71

            FIRST_(symbol1,symbol2)->first_file, FIRST_(symbol1,symbol2)->first_line, FIRST_(symbol1,symbol2)->first_column,\

    72

                                                 LAST_(symbol1,symbol2) ->last_line,  LAST_(symbol1,symbol2) ->last_column);\

    73

    fprintf(stderr, __VA_ARGS__);                                                                                           \

    74

    fprintf(stderr, "\n");                                                                                                  \

    75

    warning_found = true;                                                                                                   \

    76

}  

    77

    78

    79

/* set to 1 to see debug info during execution */

    80

static int debug = 0;

    81

    82

print_datatypes_error_c::print_datatypes_error_c(symbol_c *ignore) {

    83

	error_found = false;

    84

	warning_found = false;

    85

	current_display_error_level = error_level_default;

    86

}

    87

    88

print_datatypes_error_c::~print_datatypes_error_c(void) {

    89

}

    90

    91

int print_datatypes_error_c::get_error_found() {

    92

	return error_found;

    93

}

    94

    95

    96

    97

    98

    99

/* Verify if the datatypes of all prev_il_instructions are valid and equal!  */

   100

static bool are_all_datatypes_of_prev_il_instructions_datatypes_equal(il_instruction_c *symbol) {

   101

	if (NULL == symbol) ERROR;

   102

	bool res;

   103

   104

	if (symbol->prev_il_instruction.size() > 0)

   105

		res = is_type_valid(symbol->prev_il_instruction[0]->datatype);

   106

   107

	for (unsigned int i = 1; i < symbol->prev_il_instruction.size(); i++)

   108

		res &= is_type_equal(symbol->prev_il_instruction[i-1]->datatype, symbol->prev_il_instruction[i]->datatype);

   109

   110

	return res;

   111

}

   112

   113

   114

   115

   116

/* a helper function... */

   117

symbol_c *print_datatypes_error_c::base_type(symbol_c *symbol) {

   118

	/* NOTE: symbol == NULL is valid. It will occur when, for e.g., an undefined/undeclared symbolic_variable is used

   119

	 *       in the code.

   120

	 */

   121

	if (symbol == NULL) return NULL;

   122

	return (symbol_c *)symbol->accept(search_base_type);

   123

}

   124

   125

   126

   127

/*

   128

typedef struct {

   129

  symbol_c *function_name,

   130

  symbol_c *nonformal_operand_list,

   131

  symbol_c *   formal_operand_list,

   132

   133

  std::vector <symbol_c *> &candidate_functions,  

   134

  symbol_c &*called_function_declaration,

   135

  int      &extensible_param_count

   136

} generic_function_call_t;

   137

*/

   138

void print_datatypes_error_c::handle_function_invocation(symbol_c *fcall, generic_function_call_t fcall_data) {

   139

	symbol_c *param_value, *param_name;

   140

	function_call_param_iterator_c fcp_iterator(fcall);

   141

	bool function_invocation_error = false;

   142

	const char *POU_str = NULL;

   143

   144

	if (generic_function_call_t::POU_FB       == fcall_data.POU_type)  POU_str = "FB";

   145

	if (generic_function_call_t::POU_function == fcall_data.POU_type)  POU_str = "function";

   146

	if (NULL == POU_str) ERROR;

   147

   148

	if ((NULL != fcall_data.formal_operand_list) && (NULL != fcall_data.nonformal_operand_list)) 

   149

		ERROR;

   150

   151

	symbol_c *f_decl = fcall_data.called_function_declaration;

   152

	if ((NULL == f_decl) && (generic_function_call_t::POU_FB ==fcall_data.POU_type)) {

   153

		/* Due to the way the syntax analysis is buit (i.e. stage 2), this should never occur. */

   154

		/* I.e., a FB invocation using an undefined FB variable is not possible in the current implementation of stage 2. */

   155

		ERROR;

   156

	}

   157

	if (NULL == f_decl) {

   158

		/* we now try to find any function declaration with the same name, just so we can provide some relevant error messages */

   159

		function_symtable_t::iterator lower = function_symtable.lower_bound(fcall_data.function_name);

   160

		if (lower == function_symtable.end()) ERROR;

   161

		f_decl = function_symtable.get_value(lower);

   162

	}

   163

   164

	if (NULL != fcall_data.formal_operand_list) {

   165

		fcall_data.formal_operand_list->accept(*this);

   166

		if (NULL != f_decl) {

   167

			function_param_iterator_c fp_iterator(f_decl);

   168

			while ((param_name = fcp_iterator.next_f()) != NULL) {

   169

				param_value = fcp_iterator.get_current_value();

   170

   171

				/* Check if there are duplicate parameter values */

   172

				if(fcp_iterator.search_f(param_name) != param_value) {

   173

					function_invocation_error = true;

   174

					STAGE3_ERROR(0, param_name, param_name, "Duplicate parameter '%s' when invoking %s '%s'", ((identifier_c *)param_name)->value, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   175

					continue; /* jump to next parameter */

   176

				}

   177

   178

				/* Find the corresponding parameter in function declaration */

   179

				if (NULL == fp_iterator.search(param_name)) {

   180

					function_invocation_error = true;

   181

					STAGE3_ERROR(0, param_name, param_name, "Invalid parameter '%s' when invoking %s '%s'", ((identifier_c *)param_name)->value, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   182

					continue; /* jump to next parameter */

   183

				} 

   184

   185

				/* check whether direction (IN, OUT, IN_OUT) and assignment types (:= , =>) are compatible !!! */

   186

				/* Obtaining the assignment direction:  := (assign_in) or => (assign_out) */

   187

				function_call_param_iterator_c::assign_direction_t call_param_dir = fcp_iterator.get_assign_direction();

   188

				/* Get the parameter direction: IN, OUT, IN_OUT */

   189

				function_param_iterator_c::param_direction_t param_dir = fp_iterator.param_direction();

   190

				if          (function_call_param_iterator_c::assign_in  == call_param_dir) {

   191

					if ((function_param_iterator_c::direction_in    != param_dir) &&

   192

					    (function_param_iterator_c::direction_inout != param_dir)) {

   193

						function_invocation_error = true;

   194

						STAGE3_ERROR(0, param_name, param_name, "Invalid assignment syntax ':=' used for parameter '%s', when invoking %s '%s'", ((identifier_c *)param_name)->value, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   195

						continue; /* jump to next parameter */

   196

					}

   197

				} else if   (function_call_param_iterator_c::assign_out == call_param_dir) {

   198

					if ((function_param_iterator_c::direction_out   != param_dir)) {

   199

						function_invocation_error = true;

   200

						STAGE3_ERROR(0, param_name, param_name, "Invalid assignment syntax '=>' used for parameter '%s', when invoking %s '%s'", ((identifier_c *)param_name)->value, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   201

						continue; /* jump to next parameter */

   202

					}

   203

				} else ERROR;

   204

   205

				if (NULL == param_value->datatype) {

   206

					function_invocation_error = true;

   207

					STAGE3_ERROR(0, param_value, param_value, "Data type incompatibility between parameter '%s' and value being passed, when invoking %s '%s'", ((identifier_c *)param_name)->value, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   208

					continue; /* jump to next parameter */

   209

				}

   210

			}

   211

		}

   212

	}

   213

	if (NULL != fcall_data.nonformal_operand_list) {

   214

		fcall_data.nonformal_operand_list->accept(*this);

   215

		if (f_decl)

   216

			for (int i = 1; (param_value = fcp_iterator.next_nf()) != NULL; i++) {

   217

		  		/* TODO: verify if it is lvalue when INOUT or OUTPUT parameters! */

   218

   263

					function_invocation_error = true;

   264

					STAGE3_ERROR(0, param_value, param_value, "Data type incompatibility for value passed in position %d when invoking %s '%s'", i, POU_str, ((identifier_c *)fcall_data.function_name)->value);

   265

				}

   266

			}

   267

	}

   268

   269

	if (NULL == fcall_data.called_function_declaration) {

   270

		function_invocation_error = true;

   271

		STAGE3_ERROR(0, fcall, fcall, "Unable to resolve which overloaded %s '%s' is being invoked.", POU_str, ((identifier_c *)fcall_data.function_name)->value);

   272

	}

   273

   274

	if (function_invocation_error) {

   275

		/* No compatible function exists */

   276

		STAGE3_ERROR(2, fcall, fcall, "Invalid parameters when invoking %s '%s'", POU_str, ((identifier_c *)fcall_data.function_name)->value);

   277

	} 

   278

   279

	return;

   280

}

   281

   282

   283

   284

void *print_datatypes_error_c::handle_implicit_il_fb_invocation(const char *param_name, symbol_c *il_operator, symbol_c *called_fb_declaration) {

   285

	if (NULL == il_operand) {

   286

		STAGE3_ERROR(0, il_operator, il_operator, "Missing operand for FB call operator '%s'.", param_name);

   287

		return NULL;

   288

	}

   289

	il_operand->accept(*this);

   290

   291

	if (NULL == called_fb_declaration) {

   292

		STAGE3_ERROR(0, il_operator, il_operand, "Invalid FB call: operand is not a FB instance.");

   293

		return NULL;

   294

	}

   295

   296

	if (fake_prev_il_instruction->prev_il_instruction.empty()) {

   297

		STAGE3_ERROR(0, il_operator, il_operand, "FB invocation operator '%s' must be preceded by a 'LD' (or equivalent) operator.", param_name);	

   298

		return NULL;

   299

	}

   300

   301

	/* Find the corresponding parameter in function declaration */

   302

	function_param_iterator_c fp_iterator(called_fb_declaration);

   303

	if (NULL == fp_iterator.search(param_name)) {

   304

		/* TODO: must also check whther it is an IN parameter!! */

   305

		/* NOTE: although all standard FBs have the implicit FB calls defined as input parameters

   306

		*        (i.e., for all standard FBs, CLK, PT, IN, CU, CD, S1, R1, etc... is always an input parameter)

   307

		*        if a non-standard (i.e. a FB not defined in the standard library) FB is being called, then

   308

		*        this (CLK, PT, IN, CU, ...) parameter may just have been defined as OUT or INOUT,

   309

		*        which will not work for an implicit FB call!

   310

		*/

   311

		STAGE3_ERROR(0, il_operator, il_operand, "FB called by '%s' operator does not have a parameter named '%s'", param_name, param_name);	

   312

		return NULL;

   313

	}

   314

	if (!are_all_datatypes_of_prev_il_instructions_datatypes_equal(fake_prev_il_instruction)) {

   315

		STAGE3_ERROR(0, il_operator, il_operand, "Data type incompatibility between parameter '%s' and value being passed.", param_name);

   316

		return NULL;

   317

	}

   318

   319

   320

	/* NOTE: The error_level currently being used for errors in variables/constants etc... is rather high.

   321

	 *       However, in the case of an implicit FB call, if the datatype of the operand == NULL, this may be

   322

	 *       the __only__ indication of an error! So we test it here again, to make sure thtis error will really

   323

	 *       be printed out!

   324

	 */

   325

	if (NULL == il_operand->datatype) {

   326

		/* Note: the case of (NULL == fb_declaration) was already caught above! */

   327

// 		if (NULL != fb_declaration) {

   328

			STAGE3_ERROR(0, il_operator, il_operator, "Invalid FB call: Datatype incompatibility between the FB's '%s' parameter and value being passed, or paramater '%s' is not a 'VAR_INPUT' parameter.", param_name, param_name);

   329

			return NULL;

   330

// 		}

   331

	}

   332

   333

	return NULL;

   334

}

   335

   336

   337

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

   338

/* B 1.2 - Constants */

   339

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

   340

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

   341

/* B 1.2.1 - Numeric Literals */

   342

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

   343

void *print_datatypes_error_c::visit(real_c *symbol) {

   344

	if (symbol->candidate_datatypes.size() == 0) {

   345

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_REAL data type.");

   346

	} else if (NULL == symbol->datatype) {

   347

		STAGE3_ERROR(4, symbol, symbol, "ANY_REAL data type not valid in this location.");

   348

	}

   349

	return NULL;

   350

}

   351

   352

void *print_datatypes_error_c::visit(integer_c *symbol) {

   353

	if (symbol->candidate_datatypes.size() == 0) {

   354

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_INT data type.");

   355

	} else if (NULL == symbol->datatype) {

   356

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   357

	}

   358

	return NULL;

   359

}

   360

   361

void *print_datatypes_error_c::visit(neg_real_c *symbol) {

   362

	if (symbol->candidate_datatypes.size() == 0) {

   363

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_REAL data type.");

   364

	} else if (NULL == symbol->datatype) {

   365

		STAGE3_ERROR(4, symbol, symbol, "ANY_REAL data type not valid in this location.");

   366

	}

   367

	return NULL;

   368

}

   369

   370

void *print_datatypes_error_c::visit(neg_integer_c *symbol) {

   371

	if (symbol->candidate_datatypes.size() == 0) {

   372

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_INT data type.");

   373

	} else if (NULL == symbol->datatype) {

   374

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   375

	}

   376

	return NULL;

   377

}

   378

   379

void *print_datatypes_error_c::visit(binary_integer_c *symbol) {

   380

	if (symbol->candidate_datatypes.size() == 0) {

   381

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_INT data type.");

   382

	} else if (NULL == symbol->datatype) {

   383

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   384

	}

   385

	return NULL;

   386

}

   387

   388

void *print_datatypes_error_c::visit(octal_integer_c *symbol) {

   389

	if (symbol->candidate_datatypes.size() == 0) {

   390

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_INT data type.");

   391

	} else if (NULL == symbol->datatype) {

   392

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   393

	}

   394

	return NULL;

   395

}

   396

   397

void *print_datatypes_error_c::visit(hex_integer_c *symbol) {

   398

	if (symbol->candidate_datatypes.size() == 0) {

   399

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for ANY_INT data type.");

   400

	} else if (NULL == symbol->datatype) {

   401

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   402

	}

   403

	return NULL;

   404

}

   405

   406

void *print_datatypes_error_c::visit(integer_literal_c *symbol) {

   407

	if (symbol->candidate_datatypes.size() == 0) {

   408

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for %s data type.", elementary_type_c::to_string(symbol->type));

   409

	} else if (NULL == symbol->datatype) {

   410

		STAGE3_ERROR(4, symbol, symbol, "ANY_INT data type not valid in this location.");

   411

	}

   412

	return NULL;

   413

}

   414

   415

void *print_datatypes_error_c::visit(real_literal_c *symbol) {

   416

	if (symbol->candidate_datatypes.size() == 0) {

   417

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for %s data type.", elementary_type_c::to_string(symbol->type));

   418

	} else if (NULL == symbol->datatype) {

   419

		STAGE3_ERROR(4, symbol, symbol, "ANY_REAL data type not valid in this location.");

   420

	}

   421

	return NULL;

   422

}

   423

   424

void *print_datatypes_error_c::visit(bit_string_literal_c *symbol) {

   425

	if (symbol->candidate_datatypes.size() == 0) {

   426

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for %s data type.", elementary_type_c::to_string(symbol->type));

   427

	} else if (NULL == symbol->datatype) {

   428

		STAGE3_ERROR(4, symbol, symbol, "ANY_BIT data type not valid in this location.");

   429

	}

   430

	return NULL;

   431

}

   432

   433

void *print_datatypes_error_c::visit(boolean_literal_c *symbol) {

   434

	if (symbol->candidate_datatypes.size() == 0) {

   435

		STAGE3_ERROR(0, symbol, symbol, "Value is not valid for %s data type.", elementary_type_c::to_string(symbol->type));

   436

	} else if (NULL == symbol->datatype) {

   437

		STAGE3_ERROR(4, symbol, symbol, "ANY_BOOL data type not valid in this location.");

   438

	}

   439

	return NULL;

   440

}

   441

   442

void *print_datatypes_error_c::visit(boolean_true_c *symbol) {

   443

	if (symbol->candidate_datatypes.size() == 0) {

   444

		STAGE3_ERROR(0, symbol, symbol, "Value is not valid for ANY_BOOL data type.");

   445

	} else if (NULL == symbol->datatype) {

   446

		STAGE3_ERROR(4, symbol, symbol, "ANY_BOOL data type not valid in this location.");

   447

	}

   448

	return NULL;

   449

}

   450

   451

void *print_datatypes_error_c::visit(boolean_false_c *symbol) {

   452

	if (symbol->candidate_datatypes.size() == 0) {

   453

		STAGE3_ERROR(0, symbol, symbol, "Value is not valid for ANY_BOOL data type.");

   454

	} else if (NULL == symbol->datatype) {

   455

		STAGE3_ERROR(4, symbol, symbol, "ANY_BOOL data type not valid in this location.");

   456

	}

   457

	return NULL;

   458

}

   459

   460

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

   461

/* B.1.2.2   Character Strings */

   462

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

   463

void *print_datatypes_error_c::visit(double_byte_character_string_c *symbol) {

   464

	if (symbol->candidate_datatypes.size() == 0) {

   465

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for WSTRING data type.");

   466

	} else if (NULL == symbol->datatype) {

   467

		STAGE3_ERROR(4, symbol, symbol, "WSTRING data type not valid in this location.");

   468

	}

   469

	return NULL;

   470

}

   471

   472

void *print_datatypes_error_c::visit(single_byte_character_string_c *symbol) {

   473

	if (symbol->candidate_datatypes.size() == 0) {

   474

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for STRING data type.");

   475

	} else if (NULL == symbol->datatype) {

   476

		STAGE3_ERROR(4, symbol, symbol, "STRING data type not valid in this location.");

   477

	}

   478

	return NULL;

   479

}

   480

   481

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

   482

/* B 1.2.3 - Time Literals */

   483

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

   484

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

   485

/* B 1.2.3.1 - Duration */

   486

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

   487

void *print_datatypes_error_c::visit(duration_c *symbol) {

   488

	if (symbol->candidate_datatypes.size() == 0) {

   489

		STAGE3_ERROR(0, symbol, symbol, "Invalid syntax for TIME data type.");

   490

	} else if (NULL == symbol->datatype) {

   491

		STAGE3_ERROR(4, symbol, symbol, "TIME data type not valid in this location.");

   492

	}

   493

	return NULL;

   494

}

   495

   496

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

   497

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

   498

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

   499

void *print_datatypes_error_c::visit(time_of_day_c *symbol) {

   500

	if (symbol->candidate_datatypes.size() == 0) {

   501

		STAGE3_ERROR(0, symbol, symbol, "Invalid syntax for TOD data type.");

   502

	} else if (NULL == symbol->datatype) {