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

 *  Narrow class select and store a data type from candidate data types list for all symbols

    37

 */

    38

    39

#include "narrow_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

    48

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

    49

static int debug = 0;

    50

    51

narrow_candidate_datatypes_c::narrow_candidate_datatypes_c(symbol_c *ignore) {

    52

}

    53

    54

narrow_candidate_datatypes_c::~narrow_candidate_datatypes_c(void) {

    55

}

    56

    68

bool narrow_candidate_datatypes_c::is_widening_compatible(symbol_c *left_type, symbol_c *right_type, symbol_c *result_type, const struct widen_entry widen_table[]) {

    69

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

    70

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

    71

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

    72

				&& (typeid(*result_type) == typeid(*widen_table[k].result))) {

    73

			return true;

    74

		}

    75

	}

    76

	return false;

    77

}

    78

    79

void narrow_candidate_datatypes_c::narrow_nonformal_call(symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count) {

    80

	symbol_c *call_param_value,  *param_type;

    81

	identifier_c *param_name;

    82

	function_param_iterator_c       fp_iterator(f_decl);

    83

	function_call_param_iterator_c fcp_iterator(f_call);

    84

	int extensible_parameter_highest_index = -1;

    85

	unsigned int i;

    86

    87

	if (NULL != ext_parm_count) *ext_parm_count = -1;

    88

    89

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

    90

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

    91

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

    92

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

    93

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

    94

		 */

    95

		do {

    96

			param_name = fp_iterator.next();

    97

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

    98

			/* This error should have been caught in fill_candidate_datatypes_c, but may occur here again when we handle FB invocations! 

    99

			 * In this case, we carry on analysing the code in order to be able to provide relevant error messages

   100

			 * for that code too!

   101

			 */

   102

			if(param_name == NULL) break;

   103

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

   104

   105

		/* Set the desired datatype for this parameter, and call it recursively. */

   106

		/* Note that if the call has more parameters than those declared in the function/FB declaration,

   107

		 * we may be setting this to NULL!

   108

		 */

   114

		call_param_value->accept(*this);

   115

   116

		if (NULL != param_name) 

   117

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   118

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   119

	}

   120

	/* In the case of a call to an extensible function, we store the highest index 

   121

	 * of the extensible parameters this particular call uses, in the symbol_c object

   122

	 * of the function call itself!

   123

	 * In calls to non-extensible functions, this value will be set to -1.

   124

	 * This information is later used in stage4 to correctly generate the

   125

	 * output code.

   126

	 */

   127

	if ((NULL != ext_parm_count) && (extensible_parameter_highest_index >=0) /* if call to extensible function */)

   128

		*ext_parm_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   129

}

   130

   131

   132

   133

void narrow_candidate_datatypes_c::narrow_formal_call(symbol_c *f_call, symbol_c *f_decl, int *ext_parm_count) {

   134

	symbol_c *call_param_value, *call_param_name, *param_type;

   135

	symbol_c *verify_duplicate_param;

   136

	identifier_c *param_name;

   137

	function_param_iterator_c       fp_iterator(f_decl);

   138

	function_call_param_iterator_c fcp_iterator(f_call);

   139

	int extensible_parameter_highest_index = -1;

   140

	identifier_c *extensible_parameter_name;

   141

	unsigned int i;

   142

   143

	if (NULL != ext_parm_count) *ext_parm_count = -1;

   144

   145

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

   146

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

   147

   148

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

   149

		call_param_value = fcp_iterator.get_current_value();

   150

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

   151

		if (NULL == call_param_value) ERROR;

   152

   153

		/* Find the corresponding parameter in function declaration */

   154

		param_name = fp_iterator.search(call_param_name);

   155

   156

		/* Set the desired datatype for this parameter, and call it recursively. */

   157

		/* NOTE: When handling a FB call, this narrow_formal_call() may be called to analyse

   158

		 *       an invalid FB call (call with parameters that do not exist on the FB declaration).

   159

		 *       For this reason, the param_name may come out as NULL!

   160

		 */

   166

		call_param_value->accept(*this);

   167

   168

		if (NULL != param_name) 

   169

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   170

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   171

	}

   172

	/* call is compatible! */

   173

   174

	/* In the case of a call to an extensible function, we store the highest index 

   175

	 * of the extensible parameters this particular call uses, in the symbol_c object

   176

	 * of the function call itself!

   177

	 * In calls to non-extensible functions, this value will be set to -1.

   178

	 * This information is later used in stage4 to correctly generate the

   179

	 * output code.

   180

	 */

   181

	if ((NULL != ext_parm_count) && (extensible_parameter_highest_index >=0) /* if call to extensible function */)

   182

		*ext_parm_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   183

}

   184

   185

   186

   187

/* a helper function... */

   188

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

   189

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

   190

	 *       in the code.

   191

	 */

   192

	if (symbol == NULL) return NULL;

   193

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

   194

}

   195

   196

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

   197

/* B 1.2 - Constants */

   198

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

   199

   200

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

   201

/* B 1.3 - Data types */

   202

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

   203

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

   204

/* B 1.3.3 - Derived data types */

   205

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

   206

/*  signed_integer DOTDOT signed_integer */

   207

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   208

void *narrow_candidate_datatypes_c::visit(subrange_c *symbol) {

   209

	symbol->lower_limit->datatype = symbol->datatype;

   210

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

   211

	symbol->upper_limit->datatype = symbol->datatype;

   212

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

   213

	return NULL;

   214

}

   215

   216

   217

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

   218

/* B 1.4 - Variables */

   219

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

   220

   221

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

   222

/* B 1.4.1 - Directly Represented Variables */

   223

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

   224

   225

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

   226

/* B 1.4.2 - Multi-element variables */

   227

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

   228

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

   229

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   230

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

   231

	/* we need to check the data types of the expressions used for the subscripts... */

   232

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

   233

	return NULL;

   234

}

   235

   236

   237

/* subscript_list ',' subscript */

   238

// SYM_LIST(subscript_list_c)

   239

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

   240

	for (int i = 0; i < symbol->n; i++) {

   241

		for (unsigned int k = 0; k < symbol->elements[i]->candidate_datatypes.size(); k++) {

   242

			if (is_ANY_INT_type(symbol->elements[i]->candidate_datatypes[k]))

   243

				symbol->elements[i]->datatype = symbol->elements[i]->candidate_datatypes[k];

   244

		}

   245

		symbol->elements[i]->accept(*this);

   246

	}

   247

	return NULL;  

   248

}

   249

   250

   251

   252

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

   253

/* B 1.5 Program organization units */

   254

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

   255

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

   256

/* B 1.5.1 Functions */

   257

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

   258

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

   259

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   260

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

   261

	prev_il_instruction = NULL;

   262

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

   263

	prev_il_instruction = NULL;

   264

	delete search_varfb_instance_type;

   265

	search_varfb_instance_type = NULL;

   266

	return NULL;

   267

}

   268

   269

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

   270

/* B 1.5.2 Function blocks */

   271

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

   272

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

   273

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   274

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

   275

	prev_il_instruction = NULL;

   276

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

   277

	prev_il_instruction = NULL;

   278

	delete search_varfb_instance_type;

   279

	search_varfb_instance_type = NULL;

   280

	return NULL;

   281

}

   282

   283

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

   284

/* B 1.5.3 Programs */

   285

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

   286

void *narrow_candidate_datatypes_c::visit(program_declaration_c *symbol) {

   287

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   288

	if (debug) printf("Narrowing candidate data types list in body of program %s\n", ((token_c *)(symbol->program_type_name))->value);

   289

	prev_il_instruction = NULL;

   290

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

   291

	prev_il_instruction = NULL;

   292

	delete search_varfb_instance_type;

   293

	search_varfb_instance_type = NULL;

   294

	return NULL;

   295

}

   296

   297

   298

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

   299

/* B 1.7 Configuration elements */

   300

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

   301

void *narrow_candidate_datatypes_c::visit(configuration_declaration_c *symbol) {

   302

#if 0

   303

	// TODO !!!

   304

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

   305

#endif

   306

	return NULL;

   307

}

   308

   309

   310

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

   311

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

   312

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

   313

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

   314

/* B 2.1 Instructions and Operands */

   315

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

   316

// void *visit(instruction_list_c *symbol);

   317

void *narrow_candidate_datatypes_c::visit(il_simple_operation_c *symbol) {

   318

	il_operand = symbol->il_operand;

   319

	if (NULL != symbol->il_operand) {

   320

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

   321

	}

   322

	/* recursive call to see whether data types are compatible */

   323

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

   324

	il_operand = NULL;

   325

	return NULL;

   326

}

   327

   328

void *narrow_candidate_datatypes_c::visit(il_function_call_c *symbol) {

   329

	return NULL;

   330

}

   331

   332

/* MJS: Manuele, could you please not delete the following 2 lines of comments. They help me understand where this class is used

   333

 *     and when it is created by bison - syntax parse, and how it can show up in the abstract syntax tree.

   334

 *

   335

 *       Actually, it could be helpful if we could have all the similar comments already present in visit_expression_type_c

   336

 *       in the 3 new classes fill/narrow/print candidate datatype 

   337

 */

   338

/* | il_expr_operator '(' [il_operand] eol_list [simple_instr_list] ')' */

   339

// SYM_REF3(il_expression_c, il_expr_operator, il_operand, simple_instr_list);

   340

void *narrow_candidate_datatypes_c::visit(il_expression_c *symbol) {

   341

/* MJS: TODO... */

   342

return NULL;

   343

}

   344

   345

void *narrow_candidate_datatypes_c::visit(il_fb_call_c *symbol) {

   346

	return NULL;

   347

}

   348

   349

void *narrow_candidate_datatypes_c::visit(il_formal_funct_call_c *symbol) {

   350

	return NULL;

   351

}

   352

   353

   354

/*

   355

    void *visit(il_operand_list_c *symbol);

   356

    void *visit(simple_instr_list_c *symbol);

   357

    void *visit(il_param_list_c *symbol);

   358

    void *visit(il_param_assignment_c *symbol);

   359

    void *visit(il_param_out_assignment_c *symbol);

   360

 */

   361

   362

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

   363

/* B 2.2 Operators */

   364

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

   365

void *narrow_candidate_datatypes_c::visit(LD_operator_c *symbol) {

   366

	prev_il_instruction = symbol;

   367

	return NULL;

   368

}

   369

   370

void *narrow_candidate_datatypes_c::visit(LDN_operator_c *symbol) {

   371

	if (symbol->candidate_datatypes.size() != 1)

   372

		return NULL;

   373

	symbol->datatype = symbol->candidate_datatypes[0];

   374

	il_operand->datatype = symbol->datatype;

   375

	il_operand->accept(*this);

   376

	prev_il_instruction = symbol;

   377

	return NULL;

   378

}

   379

   380

void *narrow_candidate_datatypes_c::visit(ST_operator_c *symbol) {

   381

	if (symbol->candidate_datatypes.size() != 1)

   382

		return NULL;

   383

	symbol->datatype = symbol->candidate_datatypes[0];

   384

	il_operand->datatype = symbol->datatype;

   385

	il_operand->accept(*this);

   386

	prev_il_instruction = symbol;

   387

	return NULL;

   388

}

   389

   390

void *narrow_candidate_datatypes_c::visit(STN_operator_c *symbol) {

   391

	if (symbol->candidate_datatypes.size() != 1)

   392

		return NULL;

   393

	symbol->datatype = symbol->candidate_datatypes[0];

   394

	il_operand->datatype = symbol->datatype;

   395

	il_operand->accept(*this);

   396

	prev_il_instruction = symbol;

   397

	return NULL;

   398

}

   399

   400

void *narrow_candidate_datatypes_c::visit(NOT_operator_c *symbol) {

   401

	prev_il_instruction = symbol;

   402

	return NULL;

   403

}

   404

   405

void *narrow_candidate_datatypes_c::visit(S_operator_c *symbol) {

   406

	if (symbol->candidate_datatypes.size() != 1)

   407

		return NULL;

   408

	symbol->datatype = symbol->candidate_datatypes[0];

   409

	il_operand->datatype = symbol->datatype;

   410

	il_operand->accept(*this);

   411

	prev_il_instruction = symbol;

   412

	return NULL;

   413

}

   414

   415

void *narrow_candidate_datatypes_c::visit(R_operator_c *symbol) {

   416

	if (symbol->candidate_datatypes.size() != 1)

   417

		return NULL;

   418

	symbol->datatype = symbol->candidate_datatypes[0];

   419

	il_operand->datatype = symbol->datatype;

   420

	il_operand->accept(*this);

   421

	prev_il_instruction = symbol;

   422

	return NULL;

   423

}

   424

   425

void *narrow_candidate_datatypes_c::visit(S1_operator_c *symbol) {

   426

	if (symbol->candidate_datatypes.size() != 1)

   427

		return NULL;

   428

	symbol->datatype = symbol->candidate_datatypes[0];

   429

	il_operand->datatype = symbol->datatype;

   430

	il_operand->accept(*this);

   431

	prev_il_instruction = symbol;

   432

	return NULL;

   433

}

   434

   435

void *narrow_candidate_datatypes_c::visit(R1_operator_c *symbol) {

   436

	if (symbol->candidate_datatypes.size() != 1)

   437

		return NULL;

   438

	symbol->datatype = symbol->candidate_datatypes[0];

   439

	il_operand->datatype = symbol->datatype;

   440

	il_operand->accept(*this);

   441

	prev_il_instruction = symbol;

   442

	return NULL;

   443

}

   444

   445

void *narrow_candidate_datatypes_c::visit(CLK_operator_c *symbol) {

   446

	prev_il_instruction = symbol;

   447

	return NULL;

   448

}

   449

   450

void *narrow_candidate_datatypes_c::visit(CU_operator_c *symbol) {

   451

	prev_il_instruction = symbol;

   452

	return NULL;

   453

}

   454

   455

void *narrow_candidate_datatypes_c::visit(CD_operator_c *symbol) {

   456

	prev_il_instruction = symbol;

   457

	return NULL;

   458

}

   459

   460

void *narrow_candidate_datatypes_c::visit(PV_operator_c *symbol) {

   461

	prev_il_instruction = symbol;

   462

	return NULL;

   463

}

   464

   465

void *narrow_candidate_datatypes_c::visit(IN_operator_c *symbol) {

   466

	prev_il_instruction = symbol;

   467

	return NULL;

   468

}

   469

   470

void *narrow_candidate_datatypes_c::visit(PT_operator_c *symbol) {

   471

	prev_il_instruction = symbol;

   472

	return NULL;

   473

}

   474

   475

void *narrow_candidate_datatypes_c::visit(AND_operator_c *symbol) {

   476

	if (symbol->candidate_datatypes.size() != 1)

   477

		return NULL;

   478

	symbol->datatype = symbol->candidate_datatypes[0];

   479

	il_operand->datatype = symbol->datatype;

   480

	il_operand->accept(*this);

   481

	prev_il_instruction = symbol;

   482

	return NULL;

   483

}

   484

   485

void *narrow_candidate_datatypes_c::visit(OR_operator_c *symbol) {

   486

	if (symbol->candidate_datatypes.size() != 1)

   487

		return NULL;

   488

	symbol->datatype = symbol->candidate_datatypes[0];

   489

	il_operand->datatype = symbol->datatype;

   490

	il_operand->accept(*this);

   491

	prev_il_instruction = symbol;

   492

	return NULL;

   493

}

   494

   495

void *narrow_candidate_datatypes_c::visit(XOR_operator_c *symbol) {

   496

	if (symbol->candidate_datatypes.size() != 1)

   497

		return NULL;

   498

	symbol->datatype = symbol->candidate_datatypes[0];

   499

	il_operand->datatype = symbol->datatype;

   500

	il_operand->accept(*this);

   501

	prev_il_instruction = symbol;

   502

	return NULL;

   503

}

   504

   505

void *narrow_candidate_datatypes_c::visit(ANDN_operator_c *symbol) {

   506

	if (symbol->candidate_datatypes.size() != 1)

   507

		return NULL;

   508

	symbol->datatype = symbol->candidate_datatypes[0];

   509

	il_operand->datatype = symbol->datatype;

   510

	il_operand->accept(*this);

   511

	prev_il_instruction = symbol;

   512

	return NULL;

   513

}

   514

   515

void *narrow_candidate_datatypes_c::visit(ORN_operator_c *symbol) {

   516

	if (symbol->candidate_datatypes.size() != 1)

   517

		return NULL;

   518

	symbol->datatype = symbol->candidate_datatypes[0];

   519

	il_operand->datatype = symbol->datatype;

   520

	il_operand->accept(*this);

   521

	prev_il_instruction = symbol;

   522

	return NULL;

   523