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

    57

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[]) {

    58

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

    59

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

    60

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

    61

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

    62

			return true;

    63

		}

    64

	}

    65

	return false;

    66

}

    67

    68

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

    69

	symbol_c *call_param_value,  *param_type;

    70

	identifier_c *param_name;

    71

	function_param_iterator_c       fp_iterator(f_decl);

    72

	function_call_param_iterator_c fcp_iterator(f_call);

    73

	int extensible_parameter_highest_index = -1;

    74

	unsigned int i;

    75

    76

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

    77

    78

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

    79

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

    80

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

    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... */

    92

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

    93

    94

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

    98

		call_param_value->datatype = base_type(fp_iterator.param_type());

   101

		call_param_value->accept(*this);

   102

   107

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

   108

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

   109

	 * of the function call itself!

   110

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

   111

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

   112

	 * output code.

   113

	 */

   114

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

   115

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

   116

}

   117

   118

   119

   120

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

   121

	symbol_c *call_param_value, *call_param_name, *param_type;

   122

	symbol_c *verify_duplicate_param;

   123

	identifier_c *param_name;

   124

	function_param_iterator_c       fp_iterator(f_decl);

   125

	function_call_param_iterator_c fcp_iterator(f_call);

   126

	int extensible_parameter_highest_index = -1;

   127

	identifier_c *extensible_parameter_name;

   128

	unsigned int i;

   129

   130

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

   131

   132

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

   133

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

   134

   135

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

   136

		call_param_value = fcp_iterator.get_current_value();

   137

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

   138

		if (NULL == call_param_value) ERROR;

   139

   140

		/* Find the corresponding parameter in function declaration */

   141

		param_name = fp_iterator.search(call_param_name);

   142

   143

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

   148

		call_param_value->datatype = base_type(fp_iterator.param_type());

   152

		call_param_value->accept(*this);

   153

   157

	}

   158

	/* call is compatible! */

   159

   160

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

   161

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

   162

	 * of the function call itself!

   163

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

   164

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

   165

	 * output code.

   166

	 */

   167

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

   168

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

   169

}

   170

   171

   172

   173

/* a helper function... */

   174

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

   175

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

   176

	 *       in the code.

   177

	 */

   178

	if (symbol == NULL) return NULL;

   179

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

   180

}

   181

   182

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

   183

/* B 1.2 - Constants */

   184

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

   185

   186

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

   187

/* B 1.3 - Data types */

   188

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

   189

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

   190

/* B 1.3.3 - Derived data types */

   191

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

   192

/*  signed_integer DOTDOT signed_integer */

   193

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   194

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

   195

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

   196

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

   197

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

   198

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

   199

	return NULL;

   200

}

   201

   202

   203

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

   204

/* B 1.4 - Variables */

   205

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

   206

   207

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

   208

/* B 1.4.1 - Directly Represented Variables */

   209

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

   210

   211

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

   212

/* B 1.4.2 - Multi-element variables */

   213

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

   214

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

   215

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   216

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

   217

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

   218

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

   219

	return NULL;

   220

}

   221

   222

   223

/* subscript_list ',' subscript */

   224

// SYM_LIST(subscript_list_c)

   225

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

   226

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

   227

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

   228

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

   229

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

   230

		}

   231

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

   232

	}

   233

	return NULL;  

   234

}

   235

   236

   237

   238

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

   239

/* B 1.5 Program organization units */

   240

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

   241

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

   242

/* B 1.5.1 Functions */

   243

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

   244

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

   245

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   246

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

   247

	prev_il_instruction = NULL;

   248

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

   249

	prev_il_instruction = NULL;

   250

	delete search_varfb_instance_type;

   251

	search_varfb_instance_type = NULL;

   252

	return NULL;

   253

}

   254

   255

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

   256

/* B 1.5.2 Function blocks */

   257

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

   258

void *narrow_candidate_datatypes_c::visit(function_block_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 FB %s\n", ((token_c *)(symbol->fblock_name))->value);

   261

	prev_il_instruction = NULL;

   262

	symbol->fblock_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.3 Programs */

   271

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

   272

void *narrow_candidate_datatypes_c::visit(program_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 program %s\n", ((token_c *)(symbol->program_type_name))->value);

   275

	prev_il_instruction = NULL;

   276

	symbol->function_block_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

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

   285

/* B 1.7 Configuration elements */

   286

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

   287

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

   288

#if 0

   289

	// TODO !!!

   290

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

   291

#endif

   292

	return NULL;

   293

}

   294

   295

   296

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

   297

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

   298

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

   299

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

   300

/* B 2.1 Instructions and Operands */

   301

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

   302

// void *visit(instruction_list_c *symbol);

   303

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

   304

	il_operand = symbol->il_operand;

   305

	if (NULL != symbol->il_operand) {

   306

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

   307

	}

   308

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

   309

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

   310

	il_operand = NULL;

   311

	return NULL;

   312

}

   313

   314

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

   315

	return NULL;

   316

}

   317

   318

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

   319

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

   320

 *

   321

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

   322

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

   323

 */

   324

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

   325

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

   326

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

   327

/* MJS: TODO... */

   328

return NULL;

   329

}

   330

   331

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

   332

	return NULL;

   333

}

   334

   335

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

   336

	return NULL;

   337

}

   338

   339

   340

/*

   341

    void *visit(il_operand_list_c *symbol);

   342

    void *visit(simple_instr_list_c *symbol);

   343

    void *visit(il_param_list_c *symbol);

   344

    void *visit(il_param_assignment_c *symbol);

   345

    void *visit(il_param_out_assignment_c *symbol);

   346

 */

   347

   348

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

   349

/* B 2.2 Operators */

   350

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

   351

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

   352

	prev_il_instruction = symbol;

   353

	return NULL;

   354

}

   355

   356

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

   357

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

   358

		return NULL;

   359

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

   360

	il_operand->datatype = symbol->datatype;

   361

	il_operand->accept(*this);

   362

	prev_il_instruction = symbol;

   363

	return NULL;

   364

}

   365

   366

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

   367

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

   368

		return NULL;

   369

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

   370

	il_operand->datatype = symbol->datatype;

   371

	il_operand->accept(*this);

   372

	prev_il_instruction = symbol;

   373

	return NULL;

   374

}

   375

   376

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

   377

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

   378

		return NULL;

   379

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

   380

	il_operand->datatype = symbol->datatype;

   381

	il_operand->accept(*this);

   382

	prev_il_instruction = symbol;

   383

	return NULL;

   384

}

   385

   386

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

   387

	prev_il_instruction = symbol;

   388

	return NULL;

   389

}

   390

   391

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

   392

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

   393

		return NULL;

   394

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

   395

	il_operand->datatype = symbol->datatype;

   396

	il_operand->accept(*this);

   397

	prev_il_instruction = symbol;

   398

	return NULL;

   399

}

   400

   401

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

   402

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

   403

		return NULL;

   404

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

   405

	il_operand->datatype = symbol->datatype;

   406

	il_operand->accept(*this);

   407

	prev_il_instruction = symbol;

   408

	return NULL;

   409

}

   410

   411

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

   412

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

   413

		return NULL;

   414

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

   415

	il_operand->datatype = symbol->datatype;

   416

	il_operand->accept(*this);

   417

	prev_il_instruction = symbol;

   418

	return NULL;

   419

}

   420

   421

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

   422

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

   423

		return NULL;

   424

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

   425

	il_operand->datatype = symbol->datatype;

   426

	il_operand->accept(*this);

   427

	prev_il_instruction = symbol;

   428

	return NULL;

   429

}

   430

   431

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

   432

	prev_il_instruction = symbol;

   433

	return NULL;

   434

}

   435

   436

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

   437

	prev_il_instruction = symbol;

   438

	return NULL;

   439

}

   440

   441

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

   442

	prev_il_instruction = symbol;

   443

	return NULL;

   444

}

   445

   446

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

   447

	prev_il_instruction = symbol;

   448

	return NULL;

   449

}

   450

   451

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

   452

	prev_il_instruction = symbol;

   453

	return NULL;

   454

}

   455

   456

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

   457

	prev_il_instruction = symbol;

   458

	return NULL;

   459

}

   460

   461

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

   462

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

   463

		return NULL;

   464

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

   465

	il_operand->datatype = symbol->datatype;

   466

	il_operand->accept(*this);

   467

	prev_il_instruction = symbol;

   468

	return NULL;

   469

}

   470

   471

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

   472

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

   473

		return NULL;

   474

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

   475

	il_operand->datatype = symbol->datatype;

   476

	il_operand->accept(*this);

   477

	prev_il_instruction = symbol;

   478

	return NULL;

   479

}

   480

   481

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

   482

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

   483

		return NULL;

   484

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

   485

	il_operand->datatype = symbol->datatype;

   486

	il_operand->accept(*this);

   487

	prev_il_instruction = symbol;

   488

	return NULL;

   489

}

   490

   491

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

   492

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

   493

		return NULL;

   494

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

   495

	il_operand->datatype = symbol->datatype;

   496

	il_operand->accept(*this);

   497

	prev_il_instruction = symbol;

   498

	return NULL;

   499

}

   500

   501

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

   502

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

   503

		return NULL;

   504

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

   505

	il_operand->datatype = symbol->datatype;

   506

	il_operand->accept(*this);

   507

	prev_il_instruction = symbol;

   508

	return NULL;

   509

}

   510

   511

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

   512

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

   513

		return NULL;

   514

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

   515

	il_operand->datatype = symbol->datatype;

   516

	il_operand->accept(*this);

   517

	prev_il_instruction = symbol;

   518

	return NULL;

   519

}

   520

   521

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

   522

	prev_il_instruction = symbol;

   523

	return NULL;

   524