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) {                                                                         \

    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

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

    70

static int debug = 0;

    71

    72

print_datatypes_error_c::print_datatypes_error_c(symbol_c *ignore) {

    73

	error_found = false;

    74

	current_display_error_level = error_level_default;

    75

}

    76

    77

print_datatypes_error_c::~print_datatypes_error_c(void) {

    78

}

    79

    80

int print_datatypes_error_c::get_error_found() {

    81

	return error_found;

    82

}

    83

    84

/* a helper function... */

    85

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

    86

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

    87

	 *       in the code.

    88

	 */

    89

	if (symbol == NULL) return NULL;

    90

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

    91

}

    92

    93

    94

    95

    96

/*

    97

typedef struct {

    98

  symbol_c *function_name,

    99

  symbol_c *nonformal_operand_list,

   100

  symbol_c *   formal_operand_list,

   101

   102

  std::vector <symbol_c *> &candidate_functions,  

   103

  symbol_c &*called_function_declaration,

   104

  int      &extensible_param_count

   105

} generic_function_call_t;

   106

*/

   107

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

   108

	symbol_c *param_value, *param_name;

   109

	function_call_param_iterator_c fcp_iterator(fcall);

   110

	bool function_invocation_error = false;

   111

	const char *POU_str = NULL;

   112

   113

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

   114

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

   115

	if (NULL == POU_str) ERROR;

   116

   117

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

   118

		ERROR;

   119

   120

	symbol_c *f_decl = fcall_data.called_function_declaration;

   121

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

   122

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

   123

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

   124

		ERROR;

   125

	}

   126

	if (NULL == f_decl) {

   127

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

   128

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

   129

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

   130

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

   131

		f_decl = function_symtable.get_value(lower);

   132

	}

   133

   134

	if (NULL != fcall_data.formal_operand_list) {

   135

		fcall_data.formal_operand_list->accept(*this);

   136

		if (NULL != f_decl) {

   137

			function_param_iterator_c fp_iterator(f_decl);

   138

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

   148

				param_value = fcp_iterator.get_current_value();

   149

				/* Find the corresponding parameter in function declaration */

   150

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

   151

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

   152

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

   153

					function_invocation_error = true;

   154

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

   155

				}

   156

			}

   157

		}

   158

	}

   159

	if (NULL != fcall_data.nonformal_operand_list) {

   160

		fcall_data.nonformal_operand_list->accept(*this);

   161

		if (f_decl)

   162

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

   163

				if (NULL == param_value->datatype) {

   164

					function_invocation_error = true;

   165

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

   166

				}

   167

			}

   168

	}

   169

   170

	if (function_invocation_error) {

   171

		/* No compatible function exists */

   172

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

   173

	} 

   174

   175

	return;

   176

}

   177

   205

   206

   207

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

   208

/* B 1.2 - Constants */

   209

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

   210

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

   211

/* B 1.2.1 - Numeric Literals */

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

	}

   219

	return NULL;

   220

}

   221

   222

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

   223

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

   224

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

   225

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

   226

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

   227

	}

   228

	return NULL;

   229

}

   230

   231

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

   232

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

   233

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

   234

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

   235

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

   236

	}

   237

	return NULL;

   238

}

   239

   240

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

   241

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

   242

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

   243

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

   244

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

   245

	}

   246

	return NULL;

   247

}

   248

   249

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

   250

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

   251

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

   252

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

   253

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

   254

	}

   255

	return NULL;

   256

}

   257

   258

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

   259

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

   260

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

   261

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

   262

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

   263

	}

   264

	return NULL;

   265

}

   266

   267

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

   268

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

   269

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

   270

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

   271

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

   272

	}

   273

	return NULL;

   274

}

   275

   276

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

   277

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

   278

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

   279

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

   280

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

   281

	}

   282

	return NULL;

   283

}

   284

   285

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

   286

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

   287

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

   288

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

   289

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

   290

	}

   291

	return NULL;

   292

}

   293

   294

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

   295

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

   296

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

   297

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

   298

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

   299

	}

   300

	return NULL;

   301

}

   302

   303

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

   304

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

   305

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

   306

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

   307

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

   308

	}

   309

	return NULL;

   310

}

   311

   312

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

   313

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

   314

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

   315

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

   316

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

   317

	}

   318

	return NULL;

   319

}

   320

   321

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

   322

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

   323

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

   324

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

   325

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

   326

	}

   327

	return NULL;

   328

}

   329

   330

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

   331

/* B.1.2.2   Character Strings */

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

	}

   339

	return NULL;

   340

}

   341

   342

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

   343

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

   344

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

   345

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

   346

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

   347

	}

   348

	return NULL;

   349

}

   350

   351

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

   352

/* B 1.2.3 - Time Literals */

   353

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

   354

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

   355

/* B 1.2.3.1 - Duration */

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

	}

   363

	return NULL;

   364

}

   365

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

	}

   375

	return NULL;

   376

}

   377

   378

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

   379

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

   380

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

   381

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

   382

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

   383

	}

   384

	return NULL;

   385

}

   386

   387

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

   388

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

   389

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

   390

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

   391

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

   392

	}

   393

	return NULL;

   394

}

   395

   396

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

   397

/* B 1.3 - Data types */

   398

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

   399

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

   400

/* B 1.3.3 - Derived data types */

   401

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

   402

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

   403

	// TODO !!!

   404

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

   405

	return NULL;

   406

}

   407

   408

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

   409

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

   410

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

   411

	return NULL;

   412

}

   413

   414

   415

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

   416

/* B 1.4 - Variables */

   417

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

   418

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

   419

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

   420

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

   421

	return NULL;

   422

}

   423

   424

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

   425

/* B 1.4.1 - Directly Represented Variables */

   426

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

   427

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

   428

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

   429

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

   430

	return NULL;

   431

}

   432

   433

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

   434

/* B 1.4.2 - Multi-element variables */

   435

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

   436

/*  subscripted_variable '[' subscript_list ']' */

   437

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   438

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

   439

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

   440

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

   441

   442

	/* recursively call the subscript list to print any errors in the expressions used in the subscript...*/

   443

	symbol->subscript_list->accept(*this);

   444

	return NULL;

   445

}

   446

   447

/* subscript_list ',' subscript */

   448

// SYM_LIST(subscript_list_c)

   449

/* NOTE: we inherit from iterator visitor, so we do not need to implement this method... */

   450

#if 0

   451

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

   452

}

   453

#endif

   454

   455

   456

/*  record_variable '.' field_selector */

   457

/*  WARNING: input and/or output variables of function blocks

   458

 *           may be accessed as fields of a structured variable!

   459

 *           Code handling a structured_variable_c must take

   460

 *           this into account!

   461

 */

   462

// SYM_REF2(structured_variable_c, record_variable, field_selector)

   463

/* NOTE: We do not recursively determine the data types of each field_selector in fill_candidate_datatypes_c,

   464

 * so it does not make sense to recursively visit all the field_selectors to print out error messages. 

   465

 * Maybe in the future, if we find the need to print out more detailed error messages, we might do it that way. For now, we don't!

   466

 */

   467

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

   468

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

   470

	return NULL;

   471

}

   472

   473

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

   474

/* B 1.5 Program organization units */

   475

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

   476

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

   477

/* B 1.5.1 Functions */

   478

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

   479

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

   480

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   481

	/* We do not check for data type errors in variable declarations, Skip this for now... */

   482

// 	symbol->var_declarations_list->accept(*this);

   483

	if (debug) printf("Print error data types list in body of function %s\n", ((token_c *)(symbol->derived_function_name))->value);

   484

	il_parenthesis_level = 0;

   485

	il_error = false;

   486

	prev_il_instruction = NULL;

   487

	symbol->function_body->accept(*this);

   488

	prev_il_instruction = NULL;

   489

	delete search_varfb_instance_type;

   490

	search_varfb_instance_type = NULL;

   491

	return NULL;

   492

}

   493

   494

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

   495

/* B 1.5.2 Function blocks */

   496

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

   497

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

   498

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   499

	/* We do not check for data type errors in variable declarations, Skip this for now... */

   500

// 	symbol->var_declarations->accept(*this);

   501

	if (debug) printf("Print error data types list in body of FB %s\n", ((token_c *)(symbol->fblock_name))->value);

   502

	il_parenthesis_level = 0;

   503

	il_error = false;

   504

	prev_il_instruction = NULL;

   505

	symbol->fblock_body->accept(*this);

   506

	prev_il_instruction = NULL;

   507

	delete search_varfb_instance_type;

   508

	search_varfb_instance_type = NULL;

   509

	return NULL;

   510

}

   511

   512