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

    89

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

    90

    91

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

    92

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

    94

		call_param_value->accept(*this);

    95

    96

		if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

    97

			extensible_parameter_highest_index = fp_iterator.extensible_param_index();

    98

	}

    99

	/* call is compatible! */

   100

   101

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

   102

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

   103

	 * of the function call itself!

   104

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

   105

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

   106

	 * output code.

   107

	 */

   108

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

   109

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

   110

}

   111

   112

   113

   114

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

   115

	symbol_c *call_param_value, *call_param_name, *param_type;

   116

	symbol_c *verify_duplicate_param;

   117

	identifier_c *param_name;

   118

	function_param_iterator_c       fp_iterator(f_decl);

   119

	function_call_param_iterator_c fcp_iterator(f_call);

   120

	int extensible_parameter_highest_index = -1;

   121

	identifier_c *extensible_parameter_name;

   122

	unsigned int i;

   123

   124

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

   125

   126

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

   127

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

   128

   129

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

   130

		call_param_value = fcp_iterator.get_current_value();

   131

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

   132

		if (NULL == call_param_value) ERROR;

   133

   134

		/* Find the corresponding parameter in function declaration */

   135

		param_name = fp_iterator.search(call_param_name);

   136

   137

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

   141

   142

		if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   143

			extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   144

	}

   145

	/* call is compatible! */

   146

   147

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

   148

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

   149

	 * of the function call itself!

   150

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

   151

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

   152

	 * output code.

   153

	 */

   154

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

   155

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

   156

}

   157

   158

   159

   160

/* a helper function... */

   161

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

   162

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

   163

	 *       in the code.

   164

	 */

   167

}

   168

   169

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

   170

/* B 1.2 - Constants */

   171

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

   172

   173

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

   174

/* B 1.3 - Data types */

   175

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

   176

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

   177

/* B 1.3.3 - Derived data types */

   178

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

   179

/*  signed_integer DOTDOT signed_integer */

   180

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   181

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

   182

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

   183

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

   184

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

   185

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

   186

	return NULL;

   187

}

   188

   189

   190

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

   191

/* B 1.4 - Variables */

   192

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

   193

   194

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

   195

/* B 1.4.1 - Directly Represented Variables */

   196

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

   197

   198

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

   199

/* B 1.4.2 - Multi-element variables */

   200

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

   201

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

   202

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   203

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

   204

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

   205

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

   206

	return NULL;

   207

}

   208

   209

   210

/* subscript_list ',' subscript */

   211

// SYM_LIST(subscript_list_c)

   212

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

   213

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

   214

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

   215

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

   216

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

   217

		}

   218

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

   219

	}

   220

	return NULL;  

   221

}

   222

   223

   224

   225

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

   226

/* B 1.5 Program organization units */

   227

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

   228

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

   229

/* B 1.5.1 Functions */

   230

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

   231

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

   232

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   233

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

   234

	prev_il_instruction = NULL;

   235

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

   236

	prev_il_instruction = NULL;

   237

	delete search_varfb_instance_type;

   238

	search_varfb_instance_type = NULL;

   239

	return NULL;

   240

}

   241

   242

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

   243

/* B 1.5.2 Function blocks */

   244

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

   245

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

   246

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   247

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

   248

	prev_il_instruction = NULL;

   249

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

   250

	prev_il_instruction = NULL;

   251

	delete search_varfb_instance_type;

   252

	search_varfb_instance_type = NULL;

   253

	return NULL;

   254

}

   255

   256

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

   257

/* B 1.5.3 Programs */

   258

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

   259

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

   260

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   261

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

   262

	prev_il_instruction = NULL;

   263

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

   264

	prev_il_instruction = NULL;

   265

	delete search_varfb_instance_type;

   266

	search_varfb_instance_type = NULL;

   267

	return NULL;

   268

}

   269

   270

   271

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

   272

/* B 1.7 Configuration elements */

   273

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

   274

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

   275

#if 0

   276

	// TODO !!!

   277

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

   278

#endif

   279

	return NULL;

   280

}

   281

   282

   283

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

   284

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

   285

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

   286

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

   287

/* B 2.1 Instructions and Operands */

   288

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

   289

// void *visit(instruction_list_c *symbol);

   290

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

   291

	il_operand = symbol->il_operand;

   292

	if (NULL != symbol->il_operand) {

   293

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

   294

	}

   295

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

   296

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

   297

	il_operand = NULL;

   298

	return NULL;

   299

}

   300

   301

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

   302

	return NULL;

   303

}

   304

   305

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

   306

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

   307

 *

   308

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

   309

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

   310

 */

   311

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

   312

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

   313

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

   314

/* MJS: TODO... */

   315

return NULL;

   316

}

   317

   318

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

   319

	return NULL;

   320

}

   321

   322

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

   323

	return NULL;

   324

}

   325

   326

   327

/*

   328

    void *visit(il_operand_list_c *symbol);

   329

    void *visit(simple_instr_list_c *symbol);

   330

    void *visit(il_param_list_c *symbol);

   331

    void *visit(il_param_assignment_c *symbol);

   332

    void *visit(il_param_out_assignment_c *symbol);

   333

 */

   334

   335

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

   336

/* B 2.2 Operators */

   337

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

   338

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

   339

	prev_il_instruction = symbol;

   340

	return NULL;

   341

}

   342

   343

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

   344

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

   345

		return NULL;

   346

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

   347

	il_operand->datatype = symbol->datatype;

   348

	il_operand->accept(*this);

   349

	prev_il_instruction = symbol;

   350

	return NULL;

   351

}

   352

   353

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

   354

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

   355

		return NULL;

   356

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

   357

	il_operand->datatype = symbol->datatype;

   358

	il_operand->accept(*this);

   359

	prev_il_instruction = symbol;

   360

	return NULL;

   361

}

   362

   363

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

   364

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

   365

		return NULL;

   366

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

   367

	il_operand->datatype = symbol->datatype;

   368

	il_operand->accept(*this);

   369

	prev_il_instruction = symbol;

   370

	return NULL;

   371

}

   372

   373

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

   374

	prev_il_instruction = symbol;

   375

	return NULL;

   376

}

   377

   378

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

   379

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

   380

		return NULL;

   381

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

   382

	il_operand->datatype = symbol->datatype;

   383

	il_operand->accept(*this);

   384

	prev_il_instruction = symbol;

   385

	return NULL;

   386

}

   387

   388

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

   389

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

   390

		return NULL;

   391

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

   392

	il_operand->datatype = symbol->datatype;

   393

	il_operand->accept(*this);

   394

	prev_il_instruction = symbol;

   395

	return NULL;

   396

}

   397

   398

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

   399

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

   400

		return NULL;

   401

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

   402

	il_operand->datatype = symbol->datatype;

   403

	il_operand->accept(*this);

   404

	prev_il_instruction = symbol;

   405

	return NULL;

   406

}

   407

   408

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

   409

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

   410

		return NULL;

   411

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

   412

	il_operand->datatype = symbol->datatype;

   413

	il_operand->accept(*this);

   414

	prev_il_instruction = symbol;

   415

	return NULL;

   416

}

   417

   418

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

   419

	prev_il_instruction = symbol;

   420

	return NULL;

   421

}

   422

   423

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

   424

	prev_il_instruction = symbol;

   425

	return NULL;

   426

}

   427

   428

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

   429

	prev_il_instruction = symbol;

   430

	return NULL;

   431

}

   432

   433

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

   434

	prev_il_instruction = symbol;

   435

	return NULL;

   436

}

   437

   438

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

   439

	prev_il_instruction = symbol;

   440

	return NULL;

   441

}

   442

   443

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

   444

	prev_il_instruction = symbol;

   445

	return NULL;

   446

}

   447

   448

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

   449

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

   450

		return NULL;

   451

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

   452

	il_operand->datatype = symbol->datatype;

   453

	il_operand->accept(*this);

   454

	prev_il_instruction = symbol;

   455

	return NULL;

   456

}

   457

   458

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

   459

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

   460

		return NULL;

   461

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

   462

	il_operand->datatype = symbol->datatype;

   463

	il_operand->accept(*this);

   464

	prev_il_instruction = symbol;

   465

	return NULL;

   466

}

   467

   468

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

   469

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

   470

		return NULL;

   471

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

   472

	il_operand->datatype = symbol->datatype;

   473

	il_operand->accept(*this);

   474

	prev_il_instruction = symbol;

   475

	return NULL;

   476

}

   477

   478

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

   479

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

   480

		return NULL;

   481

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

   482

	il_operand->datatype = symbol->datatype;

   483

	il_operand->accept(*this);

   484

	prev_il_instruction = symbol;

   485

	return NULL;

   486

}

   487

   488

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

   489

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

   490

		return NULL;

   491

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

   492

	il_operand->datatype = symbol->datatype;

   493

	il_operand->accept(*this);

   494

	prev_il_instruction = symbol;

   495

	return NULL;

   496

}

   497

   498

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

   499

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

   500

		return NULL;

   501

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

   502

	il_operand->datatype = symbol->datatype;

   503

	il_operand->accept(*this);

   504

	prev_il_instruction = symbol;

   505

	return NULL;

   506

}

   507

   508

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

   509

	prev_il_instruction = symbol;

   510

	return NULL;

   511

}

   512

   513

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

   514

	prev_il_instruction = symbol;

   515

	return NULL;

   516

}

   517

   518

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

   519

	prev_il_instruction = symbol;

   520

	return NULL;

   521

}

   522

   523

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

   524

	prev_il_instruction = symbol;

   525

	return NULL;