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

 *  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 "fill_candidate_datatypes.hh"

    40

#include "datatype_functions.hh"

    41

#include <typeinfo>

    42

#include <list>

    43

#include <string>

    44

#include <string.h>

    45

#include <strings.h>

    46

    47

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

    48

static int debug = 0;

    49

    50

fill_candidate_datatypes_c::fill_candidate_datatypes_c(symbol_c *ignore) {

    51

    52

}

    53

    54

fill_candidate_datatypes_c::~fill_candidate_datatypes_c(void) {

    55

}

    56

    57

symbol_c *fill_candidate_datatypes_c::widening_conversion(symbol_c *left_type, symbol_c *right_type, const struct widen_entry widen_table[]) {

    58

	int k;

    59

	/* find a widening table entry compatible */

    60

	for (k = 0; NULL != widen_table[k].left;  k++)

    61

		if ((typeid(*left_type) == typeid(*widen_table[k].left)) && (typeid(*right_type) == typeid(*widen_table[k].right)))

    62

			return widen_table[k].result;

    63

	return NULL;

    64

}

    65

    66

    67

    68

    69

/* returns true if compatible function/FB invocation, otherwise returns false */

    70

/* Assumes that the candidate_datatype lists of all the parameters being passed haved already been filled in */

    71

bool fill_candidate_datatypes_c::match_nonformal_call(symbol_c *f_call, symbol_c *f_decl) {

    72

	symbol_c *call_param_value,  *param_type;

    73

	identifier_c *param_name;

    74

	function_param_iterator_c       fp_iterator(f_decl);

    75

	function_call_param_iterator_c fcp_iterator(f_call);

    76

	int extensible_parameter_highest_index = -1;

    77

	unsigned int i;

    78

    79

	/* Iterating through the non-formal parameters of the function call */

    80

	while((call_param_value = fcp_iterator.next_nf()) != NULL) {

    81

		/* Iterate to the next parameter of the function being called.

    82

		 * Get the name of that parameter, and ignore if EN or ENO.

    83

		 */

    84

		do {

    85

			param_name = fp_iterator.next();

    86

			/* If there is no other parameter declared, then we are passing too many parameters... */

    87

			if(param_name == NULL) return false;

    88

		} while ((strcmp(param_name->value, "EN") == 0) || (strcmp(param_name->value, "ENO") == 0));

    89

    90

		/* Get the parameter type */

    91

		param_type = base_type(fp_iterator.param_type());

    92

    93

		/* check whether one of the candidate_data_types of the value being passed is the same as the param_type */

    98

		for(i = 0; i < call_param_value->candidate_datatypes.size(); i++) {

    99

			/* If found (correct data type being passed), then stop the search */

   100

			if(is_type_equal(param_type, call_param_value->candidate_datatypes[i])) break;

   101

		}

   102

		/* if we reached the end of the loop, and no compatible type found, then return false */

   103

		if (i >= call_param_value->candidate_datatypes.size()) return false;

   104

	}

   105

	/* call is compatible! */

   106

	return true;

   107

}

   108

   109

   110

   111

/* returns true if compatible function/FB invocation, otherwise returns false */

   112

/* Assumes that the candidate_datatype lists of all the parameters being passed haved already been filled in */

   113

bool fill_candidate_datatypes_c::match_formal_call(symbol_c *f_call, symbol_c *f_decl) {

   114

	symbol_c *call_param_value, *call_param_name, *param_type;

   115

	symbol_c *verify_duplicate_param;

   116

	identifier_c *param_name;

   117

	function_param_iterator_c       fp_iterator(f_decl);

   118

	function_call_param_iterator_c fcp_iterator(f_call);

   119

	int extensible_parameter_highest_index = -1;

   120

	identifier_c *extensible_parameter_name;

   121

	unsigned int i;

   122

   123

	/* Iterating through the formal parameters of the function call */

   124

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

   125

   126

		/* Obtaining the value being passed in the function call */

   127

		call_param_value = fcp_iterator.get_current_value();

   128

		/* the following should never occur. If it does, then we have a bug in our code... */

   129

		if (NULL == call_param_value) ERROR;

   130

   131

		/* Checking if there are duplicated parameter values */

   132

		verify_duplicate_param = fcp_iterator.search_f(call_param_name);

   133

		if(verify_duplicate_param != call_param_value)

   134

			return false;

   135

   136

		/* Obtaining the type of the value being passed in the function call */

   137

		std::vector <symbol_c *>&call_param_types = call_param_value->candidate_datatypes;

   138

   139

		/* Find the corresponding parameter in function declaration */

   140

		param_name = fp_iterator.search(call_param_name);

   141

		if(param_name == NULL) return false;

   142

		/* Get the parameter type */

   143

		param_type = base_type(fp_iterator.param_type());

   144

		/* check whether one of the candidate_data_types of the value being passed is the same as the param_type */

   149

		for (i = 0; i < call_param_types.size(); i++) {

   150

			/* If found (correct data type being passed), then stop the search */

   151

			if(is_type_equal(param_type, call_param_types[i])) break;

   152

		}

   153

		/* if we reached the end of the loop, and no compatible type found, then return false */

   154

		if (i >= call_param_types.size()) return false;

   155

   156

	}

   157

	/* call is compatible! */

   158

	return true;

   159

}

   160

   161

   162

   163

   256

/* a helper function... */

   257

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

   258

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

   259

	 *       in the code.

   260

	 */

   261

	if (symbol == NULL) return NULL;

   262

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

   263

}

   264

   265

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

   266

/* B 1.2 - Constants */

   267

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

   268

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

   269

/* B 1.2.1 - Numeric Literals */

   270

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

   271

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

   272

	int calc_size;

   273

   274

	calc_size = sizeoftype(symbol);

   275

	if (calc_size <= sizeoftype(&search_constant_type_c::real_type_name))

   276

		symbol->candidate_datatypes.push_back(&search_constant_type_c::real_type_name);

   277

	if (calc_size <= sizeoftype(&search_constant_type_c::lreal_type_name))

   278

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lreal_type_name);

   279

	if (debug) std::cout << "ANY_REAL [" << symbol->candidate_datatypes.size() << "]" << std::endl;

   280

	return NULL;

   281

}

   282

   283

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

   284

	int calc_size;

   285

   286

	calc_size = sizeoftype(symbol);

   287

	if (calc_size <= sizeoftype(&search_constant_type_c::bool_type_name))

   288

	        symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   289

	if (calc_size <= sizeoftype(&search_constant_type_c::byte_type_name))

   290

		symbol->candidate_datatypes.push_back(&search_constant_type_c::byte_type_name);

   291

	if (calc_size <= sizeoftype(&search_constant_type_c::word_type_name))

   292

		symbol->candidate_datatypes.push_back(&search_constant_type_c::word_type_name);

   293

	if (calc_size <= sizeoftype(&search_constant_type_c::dword_type_name))

   294

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dword_type_name);

   295

	if (calc_size <= sizeoftype(&search_constant_type_c::lword_type_name))

   296

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lword_type_name);

   297

   298

	if (calc_size < sizeoftype(&search_constant_type_c::sint_type_name))

   299

		symbol->candidate_datatypes.push_back(&search_constant_type_c::sint_type_name);

   300

	if (calc_size < sizeoftype(&search_constant_type_c::int_type_name))

   301

		symbol->candidate_datatypes.push_back(&search_constant_type_c::int_type_name);

   302

	if (calc_size < sizeoftype(&search_constant_type_c::dint_type_name))

   303

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dint_type_name);

   304

	if (calc_size < sizeoftype(&search_constant_type_c::lint_type_name))

   305

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lint_type_name);

   306

	if (calc_size <= sizeoftype(&search_constant_type_c::usint_type_name))

   307

		symbol->candidate_datatypes.push_back(&search_constant_type_c::usint_type_name);

   308

	if (calc_size <= sizeoftype(&search_constant_type_c::uint_type_name))

   309

		symbol->candidate_datatypes.push_back(&search_constant_type_c::uint_type_name);

   310

	if (calc_size <= sizeoftype(&search_constant_type_c::udint_type_name))

   311

		symbol->candidate_datatypes.push_back(&search_constant_type_c::udint_type_name);

   312

	if (calc_size <= sizeoftype(&search_constant_type_c::ulint_type_name))

   313

		symbol->candidate_datatypes.push_back(&search_constant_type_c::ulint_type_name);

   314

	if (debug) std::cout << "ANY_INT [" << symbol->candidate_datatypes.size()<< "]" << std::endl;

   315

	return NULL;

   316

}

   317

   318

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

   319

	if (sizeoftype(symbol) <= sizeoftype(&search_constant_type_c::real_type_name))

   320

		symbol->candidate_datatypes.push_back(&search_constant_type_c::real_type_name);

   321

	symbol->candidate_datatypes.push_back(&search_constant_type_c::lreal_type_name);

   322

	if (debug) std::cout << "neg ANY_REAL [" << symbol->candidate_datatypes.size() << "]" << std::endl;

   323

	return NULL;

   324

}

   325

   326

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

   327

	int calc_size;

   328

   329

	calc_size = sizeoftype(symbol);

   330

	if (calc_size <= sizeoftype(&search_constant_type_c::int_type_name))

   331

		symbol->candidate_datatypes.push_back(&search_constant_type_c::int_type_name);

   332

	if (calc_size <= sizeoftype(&search_constant_type_c::sint_type_name))

   333

		symbol->candidate_datatypes.push_back(&search_constant_type_c::sint_type_name);

   334

	if (calc_size <= sizeoftype(&search_constant_type_c::dint_type_name))

   335

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dint_type_name);

   336

	if (calc_size <= sizeoftype(&search_constant_type_c::lint_type_name))

   337

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lint_type_name);

   338

	if (debug) std::cout << "neg ANY_INT [" << symbol->candidate_datatypes.size() << "]" << std::endl;

   339

	return NULL;

   340

}

   341

   342

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

   343

	int calc_size;

   344

   345

	calc_size = sizeoftype(symbol);

   346

	if (calc_size <= sizeoftype(&search_constant_type_c::bool_type_name))

   347

	        symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   348

	if (calc_size <= sizeoftype(&search_constant_type_c::byte_type_name))

   349

		symbol->candidate_datatypes.push_back(&search_constant_type_c::byte_type_name);

   350

	if (calc_size <= sizeoftype(&search_constant_type_c::word_type_name))

   351

		symbol->candidate_datatypes.push_back(&search_constant_type_c::word_type_name);

   352

	if (calc_size <= sizeoftype(&search_constant_type_c::dword_type_name))

   353

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dword_type_name);

   354

	if (calc_size <= sizeoftype(&search_constant_type_c::lword_type_name))

   355

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lword_type_name);

   356

   357

	if (calc_size < sizeoftype(&search_constant_type_c::sint_type_name))

   358

		symbol->candidate_datatypes.push_back(&search_constant_type_c::sint_type_name);

   359

	if (calc_size < sizeoftype(&search_constant_type_c::int_type_name))

   360

		symbol->candidate_datatypes.push_back(&search_constant_type_c::int_type_name);

   361

	if (calc_size < sizeoftype(&search_constant_type_c::dint_type_name))

   362

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dint_type_name);

   363

	if (calc_size < sizeoftype(&search_constant_type_c::lint_type_name))

   364

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lint_type_name);

   365

	if (calc_size <= sizeoftype(&search_constant_type_c::usint_type_name))

   366

		symbol->candidate_datatypes.push_back(&search_constant_type_c::usint_type_name);

   367

	if (calc_size <= sizeoftype(&search_constant_type_c::uint_type_name))

   368

		symbol->candidate_datatypes.push_back(&search_constant_type_c::uint_type_name);

   369

	if (calc_size <= sizeoftype(&search_constant_type_c::udint_type_name))

   370

		symbol->candidate_datatypes.push_back(&search_constant_type_c::udint_type_name);

   371

	if (calc_size <= sizeoftype(&search_constant_type_c::ulint_type_name))

   372

		symbol->candidate_datatypes.push_back(&search_constant_type_c::ulint_type_name);

   373

	if (debug) std::cout << "ANY_INT [" << symbol->candidate_datatypes.size()<< "]" << std::endl;

   374

	return NULL;

   375

}

   376

   377

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

   378

	int calc_size;

   379

   380

	calc_size = sizeoftype(symbol);

   381

	if (calc_size <= sizeoftype(&search_constant_type_c::bool_type_name))

   382

	        symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   383

	if (calc_size <= sizeoftype(&search_constant_type_c::byte_type_name))

   384

		symbol->candidate_datatypes.push_back(&search_constant_type_c::byte_type_name);

   385

	if (calc_size <= sizeoftype(&search_constant_type_c::word_type_name))

   386

		symbol->candidate_datatypes.push_back(&search_constant_type_c::word_type_name);

   387

	if (calc_size <= sizeoftype(&search_constant_type_c::dword_type_name))

   388

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dword_type_name);

   389

	if (calc_size <= sizeoftype(&search_constant_type_c::lword_type_name))

   390

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lword_type_name);

   391

   392

	if (calc_size < sizeoftype(&search_constant_type_c::sint_type_name))

   393

		symbol->candidate_datatypes.push_back(&search_constant_type_c::sint_type_name);

   394

	if (calc_size < sizeoftype(&search_constant_type_c::int_type_name))

   395

		symbol->candidate_datatypes.push_back(&search_constant_type_c::int_type_name);

   396

	if (calc_size < sizeoftype(&search_constant_type_c::dint_type_name))

   397

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dint_type_name);

   398

	if (calc_size < sizeoftype(&search_constant_type_c::lint_type_name))

   399

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lint_type_name);

   400

	if (calc_size <= sizeoftype(&search_constant_type_c::usint_type_name))

   401

		symbol->candidate_datatypes.push_back(&search_constant_type_c::usint_type_name);

   402

	if (calc_size <= sizeoftype(&search_constant_type_c::uint_type_name))

   403

		symbol->candidate_datatypes.push_back(&search_constant_type_c::uint_type_name);

   404

	if (calc_size <= sizeoftype(&search_constant_type_c::udint_type_name))

   405

		symbol->candidate_datatypes.push_back(&search_constant_type_c::udint_type_name);

   406

	if (calc_size <= sizeoftype(&search_constant_type_c::ulint_type_name))

   407

		symbol->candidate_datatypes.push_back(&search_constant_type_c::ulint_type_name);

   408

	if (debug) std::cout << "ANY_INT [" << symbol->candidate_datatypes.size()<< "]" << std::endl;

   409

	return NULL;

   410

}

   411

   412

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

   413

	int calc_size;

   414

   415

	calc_size = sizeoftype(symbol);

   416

	if (calc_size <= sizeoftype(&search_constant_type_c::bool_type_name))

   417

	        symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   418

	if (calc_size <= sizeoftype(&search_constant_type_c::byte_type_name))

   419

		symbol->candidate_datatypes.push_back(&search_constant_type_c::byte_type_name);

   420

	if (calc_size <= sizeoftype(&search_constant_type_c::word_type_name))

   421

		symbol->candidate_datatypes.push_back(&search_constant_type_c::word_type_name);

   422

	if (calc_size <= sizeoftype(&search_constant_type_c::dword_type_name))

   423

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dword_type_name);

   424

	if (calc_size <= sizeoftype(&search_constant_type_c::lword_type_name))

   425

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lword_type_name);

   426

   427

	if (calc_size < sizeoftype(&search_constant_type_c::sint_type_name))

   428

		symbol->candidate_datatypes.push_back(&search_constant_type_c::sint_type_name);

   429

	if (calc_size < sizeoftype(&search_constant_type_c::int_type_name))

   430

		symbol->candidate_datatypes.push_back(&search_constant_type_c::int_type_name);

   431

	if (calc_size < sizeoftype(&search_constant_type_c::dint_type_name))

   432

		symbol->candidate_datatypes.push_back(&search_constant_type_c::dint_type_name);

   433

	if (calc_size < sizeoftype(&search_constant_type_c::lint_type_name))

   434

		symbol->candidate_datatypes.push_back(&search_constant_type_c::lint_type_name);

   435

	if (calc_size <= sizeoftype(&search_constant_type_c::usint_type_name))

   436

		symbol->candidate_datatypes.push_back(&search_constant_type_c::usint_type_name);

   437

	if (calc_size <= sizeoftype(&search_constant_type_c::uint_type_name))

   438

		symbol->candidate_datatypes.push_back(&search_constant_type_c::uint_type_name);

   439

	if (calc_size <= sizeoftype(&search_constant_type_c::udint_type_name))

   440

		symbol->candidate_datatypes.push_back(&search_constant_type_c::udint_type_name);

   441

	if (calc_size <= sizeoftype(&search_constant_type_c::ulint_type_name))

   442

		symbol->candidate_datatypes.push_back(&search_constant_type_c::ulint_type_name);

   443

	if (debug) std::cout << "ANY_INT [" << symbol->candidate_datatypes.size()<< "]" << std::endl;

   444

	return NULL;

   445

}

   446

   447

// SYM_REF2(integer_literal_c, type, value)

   448

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

   449

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

   450

	if (search_in_datatype_list(symbol->type, symbol->value->candidate_datatypes) >= 0)

   451

		symbol->candidate_datatypes.push_back(symbol->type);

   452

	if (debug) std::cout << "INT_LITERAL [" << symbol->candidate_datatypes.size() << "]\n";

   453

	return NULL;

   454

}

   455

   456

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

   457

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

   458

	if (search_in_datatype_list(symbol->type, symbol->value->candidate_datatypes) >= 0)

   459

		symbol->candidate_datatypes.push_back(symbol->type);

   460

	if (debug) std::cout << "REAL_LITERAL [" << symbol->candidate_datatypes.size() << "]\n";

   461

	return NULL;

   462

}

   463

   464

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

   465

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

   466

	if (search_in_datatype_list(symbol->type, symbol->value->candidate_datatypes) >= 0)

   467

		symbol->candidate_datatypes.push_back(symbol->type);

   468

	return NULL;

   469

}

   470

   471

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

   472

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

   473

 	if (search_in_datatype_list(symbol->type, symbol->value->candidate_datatypes) >= 0)

   474

		/* if an explicit datat type has been provided (e.g. SAFEBOOL#true), check whether

   475

		 * the possible datatypes of the value is consistent with the desired type.

   476

		 */

   477

		symbol->candidate_datatypes.push_back(symbol->type);

   478

	else {

   479

		/* Then only a literal TRUE or FALSE was given! */

   480

		/* In this case, symbol->type will be NULL!     */

   481

		symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   482

		symbol->candidate_datatypes.push_back(&search_constant_type_c::safebool_type_name);

   483

	}

   484

	return NULL;

   485

}

   486

   487

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

   488

	symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   489

	symbol->candidate_datatypes.push_back(&search_constant_type_c::safebool_type_name);

   490

	return NULL;

   491

}

   492

   493

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

   494

	symbol->candidate_datatypes.push_back(&search_constant_type_c::bool_type_name);

   495

	symbol->candidate_datatypes.push_back(&search_constant_type_c::safebool_type_name);

   496

	return NULL;

   497

}

   498

   499

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

   500

/* B.1.2.2   Character Strings */

   501

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

   502

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

   503

	symbol->candidate_datatypes.push_back(&search_constant_type_c::wstring_type_name);

   504

	return NULL;

   505

}

   506

   507

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

   508

	symbol->candidate_datatypes.push_back(&search_constant_type_c::string_type_name);

   509

	return NULL;

   510

}

   511

   512

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

   513

/* B 1.2.3 - Time Literals */

   514

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

   515

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

   516