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

     6

 *  Copyright (C) 20011-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) {                                                                         \

    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

    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;

    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

/* a helper function... */

    96

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

    97

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

    98

	 *       in the code.

    99

	 */

   100

	if (symbol == NULL) return NULL;

   101

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

   102

}

   103

   104

   105

   106

   116

/*

   117

typedef struct {

   118

  symbol_c *function_name,

   119

  symbol_c *nonformal_operand_list,

   120

  symbol_c *   formal_operand_list,

   121

   122

  std::vector <symbol_c *> &candidate_functions,  

   123

  symbol_c &*called_function_declaration,

   124

  int      &extensible_param_count

   125

} generic_function_call_t;

   126

*/

   127

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

   128

	symbol_c *param_value, *param_name;

   129

	function_call_param_iterator_c fcp_iterator(fcall);

   130

	bool function_invocation_error = false;

   131

	const char *POU_str = NULL;

   132

   133

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

   134

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

   135

	if (NULL == POU_str) ERROR;

   136

   137

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

   138

		ERROR;

   139

   140

	symbol_c *f_decl = fcall_data.called_function_declaration;

   141

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

   142

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

   143

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

   144

		ERROR;

   145

	}

   146

	if (NULL == f_decl) {

   147

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

   148

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

   149

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

   150

		f_decl = function_symtable.get_value(lower);

   151

	}

   152

   153

	if (NULL != fcall_data.formal_operand_list) {

   154

		fcall_data.formal_operand_list->accept(*this);

   155

		if (NULL != f_decl) {

   156

			function_param_iterator_c fp_iterator(f_decl);

   157

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

   158

				param_value = fcp_iterator.get_current_value();

   159

   160

				/* Check if there are duplicate parameter values */

   161

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

   162

					function_invocation_error = true;

   163

					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);

   164

					continue; /* jump to next parameter */

   165

				}

   166

   167

				/* Find the corresponding parameter in function declaration */

   168

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

   169

					function_invocation_error = true;

   170

					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);

   171

					continue; /* jump to next parameter */

   172

				} 

   173

   174

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

   175

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

   176

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

   177

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

   178

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

   179

				if          (function_call_param_iterator_c::assign_in  == call_param_dir) {

   180

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

   181

					    (function_param_iterator_c::direction_inout != param_dir)) {

   182

						function_invocation_error = true;

   183

						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);

   184

						continue; /* jump to next parameter */

   185

					}

   186

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

   187

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

   188

						function_invocation_error = true;

   189

						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);

   190

						continue; /* jump to next parameter */

   191

					}

   192

				} else ERROR;

   193

   194

				if (NULL == param_value->datatype) {

   195

					function_invocation_error = true;

   196

					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);

   197

					continue; /* jump to next parameter */

   198

				}

   199

			}

   200

		}

   201

	}

   202

	if (NULL != fcall_data.nonformal_operand_list) {

   203

		fcall_data.nonformal_operand_list->accept(*this);

   204

		if (f_decl)

   205

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

   206

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

   207

   208

				if (NULL == param_value->datatype) {

   209

					function_invocation_error = true;

   210

					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);

   211

				}

   212

			}

   213

	}

   214

   215

	if (NULL == fcall_data.called_function_declaration) {

   216

		function_invocation_error = true;

   217

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

   218

	}

   219

   220

	if (function_invocation_error) {

   221

		/* No compatible function exists */

   222

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

   223

	} 

   224

   225

	return;

   226

}

   227

   228

   229

   230

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

   231

	if (NULL == il_operand) {

   232

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

   233

		return;

   234

	}

   235

	il_operand->accept(*this);

   236

   237

	if (NULL == called_fb_declaration) {

   238

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

   239

		return;

   240

	}

   241

   242

	if (NULL == prev_il_instruction) {

   243

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

   244

		return;

   245

	}

   246

   247

	/* Find the corresponding parameter in function declaration */

   248

	function_param_iterator_c fp_iterator(called_fb_declaration);

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

		*        which will not work for an implicit FB call!

   256

		*/

   257

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

   258

		return;

   259

	}

   260

	if (NULL == prev_il_instruction->datatype) {

   261

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

   262

		return;

   263

	}

   264

   265

   266

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

   267

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

   268

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

   269

	 *       be printed out!

   270

	 */

   271

	if (NULL == il_operand->datatype) {

   272

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

   273

// 		if (NULL != fb_declaration) {

   274

			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);

   275

			return;

   276

// 		}

   277

	}

   278

// 

   279

	return;

   280

}

   281

   282

   283

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

   284

/* B 1.2 - Constants */

   285

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

   286

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

   287

/* B 1.2.1 - Numeric Literals */

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

	}

   295

	return NULL;

   296

}

   297

   298

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

   299

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

   300

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

   301

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

   302

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

   303

	}

   304

	return NULL;

   305

}

   306

   307

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

   308

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

   309

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

   310

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

   311

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

   312

	}

   313

	return NULL;

   314

}

   315

   316

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

   317

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

   318

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

   319

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

   320

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

   321

	}

   322

	return NULL;

   323

}

   324

   325

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

   326

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

   327

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

   328

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

   329

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

   330

	}

   331

	return NULL;

   332

}

   333

   334

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

   335

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

   336

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

   337

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

   338

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

   339

	}

   340

	return NULL;

   341

}

   342

   343

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

   344

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

   345

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

   346

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

   347

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

   348

	}

   349

	return NULL;

   350

}

   351

   352

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

   353

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

   354

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for %s data type.", elementary_type_c::to_string(symbol->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(real_literal_c *symbol) {

   362

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

   363

		STAGE3_ERROR(0, symbol, symbol, "Numerical value exceeds range for %s data type.", elementary_type_c::to_string(symbol->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(bit_string_literal_c *symbol) {

   371

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

   372

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

   373

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

   374

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

   375

	}

   376

	return NULL;

   377

}

   378

   379

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

   380

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

   381

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

   382

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

   383

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

   384

	}

   385

	return NULL;

   386

}

   387

   388

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

   389

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

   390

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

   391

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

   392

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

   393

	}

   394

	return NULL;

   395

}

   396

   397

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

   398

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

   399

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

   400

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

   401

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

   402

	}

   403

	return NULL;

   404

}

   405

   406

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

   407

/* B.1.2.2   Character Strings */

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

	}

   415

	return NULL;

   416

}

   417

   418

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

   419

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

   420

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

   421

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

   422

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

   423

	}

   424

	return NULL;

   425

}

   426

   427

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

   428

/* B 1.2.3 - Time Literals */

   429

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

   430

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

   431

/* B 1.2.3.1 - Duration */

   432

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

   433

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

   434

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

   435

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

   436

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

   437

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

   438

	}

   439

	return NULL;

   440

}

   441

   442

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

   443

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

   444

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

   445

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

   446

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

   447

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

   448

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

   449

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

   450

	}

   451

	return NULL;

   452

}

   453

   454

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

   455

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

   456

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

   457

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

   458

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

   459

	}

   460

	return NULL;

   461

}

   462

   463

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

   464

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

   465

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

   466

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

   467

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

   468

	}

   469

	return NULL;

   470

}

   471

   472

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

   473

/* B 1.3 - Data types */

   474

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

   475

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

   476

/* B 1.3.3 - Derived data types */

   477

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

   478

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

   479

	// TODO !!!

   480

	/* for the moment we must return NULL so semantic analysis of remaining code is not interrupted! */

   481

	return NULL;

   482

}

   483

   484

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

   485

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

   486

		STAGE3_ERROR(0, symbol, symbol, "Ambiguous enumerate value or Variable not declared in this scope.");

   487

	return NULL;

   488

}

   489

   490

   491

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

   492

/* B 1.4 - Variables */

   493

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

   494

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

   495

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

   496

		STAGE3_ERROR(0, symbol, symbol, "Variable not declared in this scope.");

   497

	return NULL;

   498

}

   499

   500

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

   501

/* B 1.4.1 - Directly Represented Variables */

   502

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

   503

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

   504

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

   505

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