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

    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

	identifier_c *extensible_parameter_name;

    75

	unsigned int i;

    76

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

    87

			if(param_name == NULL) {

    88

				return;

    89

			}

    90

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

    91

    92

		/* Get the parameter type */

    93

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

    94

		call_param_value->accept(*this);

    95

		if (extensible_parameter_highest_index < fp_iterator.extensible_param_index()) {

    96

			extensible_parameter_highest_index = fp_iterator.extensible_param_index();

    97

			extensible_parameter_name = param_name;

    98

		}

    99

	}

   100

    int extensible_param_count = -1;

   101

    if (extensible_parameter_highest_index >=0) /* if call to extensible function */

   102

      extensible_param_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   103

    function_invocation_c  *function_invocation  = dynamic_cast<function_invocation_c  *>(f_call);

   104

    if (function_invocation  != NULL) function_invocation->extensible_param_count = extensible_param_count;

   105

   106

}

   107

   108

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

   109

	symbol_c *call_param_value, *call_param_name, *param_type;

   110

	symbol_c *verify_duplicate_param;

   111

	identifier_c *param_name;

   112

	function_param_iterator_c       fp_iterator(f_decl);

   113

	function_call_param_iterator_c fcp_iterator(f_call);

   114

	int extensible_parameter_highest_index = -1;

   115

	identifier_c *extensible_parameter_name;

   116

	unsigned int i;

   117

   118

   119

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

   120

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

   121

   122

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

   123

		call_param_value = fcp_iterator.get_current_value();

   124

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

   125

		if (NULL == call_param_value) ERROR;

   126

   127

		/* Find the corresponding parameter in function declaration */

   128

		param_name = fp_iterator.search(call_param_name);

   129

   130

		/* Get the parameter type */

   131

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

   132

		call_param_name->accept(*this);

   133

	    /* the first parameter (il_def_variable) is correct */

   134

	    if (extensible_parameter_highest_index < fp_iterator.extensible_param_index()) {

   135

	      extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   136

	    }

   137

	}

   138

	/* The function call may not have any errors! */

   139

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

   140

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

   141

	 * of the function call itself!

   142

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

   143

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

   144

	 * output code.

   145

	 */

   146

	int extensible_param_count = -1;

   147

	if (extensible_parameter_highest_index >=0) /* if call to extensible function */

   148

		extensible_param_count = 1 + extensible_parameter_highest_index - fp_iterator.first_extensible_param_index();

   149

	function_invocation_c  *function_invocation  = dynamic_cast<function_invocation_c  *>(f_call);

   150

	if (function_invocation  != NULL) function_invocation->extensible_param_count = extensible_param_count;

   151

}

   152

   153

/* a helper function... */

   154

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

   155

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

   156

	 *       in the code.

   157

	 */

   158

	return NULL;

   159

}

   160

   161

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

   162

/* B 1.2 - Constants */

   163

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

   164

   165

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

   166

/* B 1.3 - Data types */

   167

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

   168

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

   169

/* B 1.3.3 - Derived data types */

   170

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

   171

/*  signed_integer DOTDOT signed_integer */

   172

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   173

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

   174

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

   175

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

   176

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

   177

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

   178

	return NULL;

   179

}

   180

   181

   182

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

   183

/* B 1.4 - Variables */

   184

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

   185

   186

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

   187

/* B 1.4.1 - Directly Represented Variables */

   188

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

   189

   190

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

   191

/* B 1.4.2 - Multi-element variables */

   192

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

   193

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

   194

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   195

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

   196

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

   197

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

   198

	return NULL;

   199

}

   200

   201

   202

/* subscript_list ',' subscript */

   203

// SYM_LIST(subscript_list_c)

   204

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

   205

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

   206

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

   207

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

   208

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

   209

		}

   210

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

   211

	}

   212

	return NULL;  

   213

}

   214

   215

   216

   217

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

   218

/* B 1.5 Program organization units */

   219

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

   220

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

   221

/* B 1.5.1 Functions */

   222

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

   223

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

   224

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   225

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

   226

	prev_il_instruction = NULL;

   227

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

   228

	prev_il_instruction = NULL;

   229

	delete search_varfb_instance_type;

   230

	search_varfb_instance_type = NULL;

   231

	return NULL;

   232

}

   233

   234

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

   235

/* B 1.5.2 Function blocks */

   236

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

   237

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

   238

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   239

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

   240

	prev_il_instruction = NULL;

   241

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

   242

	prev_il_instruction = NULL;

   243

	delete search_varfb_instance_type;

   244

	search_varfb_instance_type = NULL;

   245

	return NULL;

   246

}

   247

   248

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

   249

/* B 1.5.3 Programs */

   250

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

   251

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

   252

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   253

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

   254

	prev_il_instruction = NULL;

   255

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

   256

	prev_il_instruction = NULL;

   257

	delete search_varfb_instance_type;

   258

	search_varfb_instance_type = NULL;

   259

	return NULL;

   260

}

   261

   262

   263

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

   264

/* B 1.7 Configuration elements */

   265

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

   266

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

   267

#if 0

   268

	// TODO !!!

   269

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

   270

#endif

   271

	return NULL;

   272

}

   273

   274

   275

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

   276

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

   277

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

   278

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

   279

/* B 2.1 Instructions and Operands */

   280

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

   281

// void *visit(instruction_list_c *symbol);

   282

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

   283

	il_operand = symbol->il_operand;

   284

	if (NULL != symbol->il_operand) {

   285

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

   286

	}

   287

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

   288

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

   289

	il_operand = NULL;

   290

	return NULL;

   291

}

   292

   293

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

   294

	return NULL;

   295

}

   296

   297

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

   298

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

   299

 *

   300

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

   301

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

   302

 */

   303

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

   304

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

   305

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

   306

/* MJS: TODO... */

   307

return NULL;

   308

}

   309

   310

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

   311

	return NULL;

   312

}

   313

   314

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

   315

	return NULL;

   316

}

   317

   318

   319

/*

   320

    void *visit(il_operand_list_c *symbol);

   321

    void *visit(simple_instr_list_c *symbol);

   322

    void *visit(il_param_list_c *symbol);

   323

    void *visit(il_param_assignment_c *symbol);

   324

    void *visit(il_param_out_assignment_c *symbol);

   325

 */

   326

   327

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

   328

/* B 2.2 Operators */

   329

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

   330

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

   331

	prev_il_instruction = symbol;

   332

	return NULL;

   333

}

   334

   335

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

   336

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

   337

		return NULL;

   338

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

   339

	il_operand->datatype = symbol->datatype;

   340

	il_operand->accept(*this);

   341

	prev_il_instruction = symbol;

   342

	return NULL;

   343

}

   344

   345

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

   346

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

   347

		return NULL;

   348

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

   349

	il_operand->datatype = symbol->datatype;

   350

	il_operand->accept(*this);

   351

	prev_il_instruction = symbol;

   352

	return NULL;

   353

}

   354

   355

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

   356

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

   357

		return NULL;

   358

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

   359

	il_operand->datatype = symbol->datatype;

   360

	il_operand->accept(*this);

   361

	prev_il_instruction = symbol;

   362

	return NULL;

   363

}

   364

   365

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

   366

	prev_il_instruction = symbol;

   367

	return NULL;

   368

}

   369

   370

void *narrow_candidate_datatypes_c::visit(S_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(R_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(S1_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(R1_operator_c *symbol) {

   401

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

   402

		return NULL;

   403

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

   404

	il_operand->datatype = symbol->datatype;

   405

	il_operand->accept(*this);

   406

	prev_il_instruction = symbol;

   407

	return NULL;

   408

}

   409

   410

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

   411

	prev_il_instruction = symbol;

   412

	return NULL;

   413

}

   414

   415

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

   416

	prev_il_instruction = symbol;

   417

	return NULL;

   418

}

   419

   420

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

   421

	prev_il_instruction = symbol;

   422

	return NULL;

   423

}

   424

   425

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

   426

	prev_il_instruction = symbol;

   427

	return NULL;

   428

}

   429

   430

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

   431

	prev_il_instruction = symbol;

   432

	return NULL;

   433

}

   434

   435

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

   436

	prev_il_instruction = symbol;

   437

	return NULL;

   438

}

   439

   440

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

   441

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

   442

		return NULL;

   443

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

   444

	il_operand->datatype = symbol->datatype;

   445

	il_operand->accept(*this);

   446

	prev_il_instruction = symbol;

   447

	return NULL;

   448

}

   449

   450

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

   451

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

   452

		return NULL;

   453

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

   454

	il_operand->datatype = symbol->datatype;

   455

	il_operand->accept(*this);

   456

	prev_il_instruction = symbol;

   457

	return NULL;

   458

}

   459

   460

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

   461

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

   462

		return NULL;

   463

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

   464

	il_operand->datatype = symbol->datatype;

   465

	il_operand->accept(*this);

   466

	prev_il_instruction = symbol;

   467

	return NULL;

   468

}

   469

   470

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

   471

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

   472

		return NULL;

   473

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

   474

	il_operand->datatype = symbol->datatype;

   475

	il_operand->accept(*this);

   476

	prev_il_instruction = symbol;

   477

	return NULL;

   478

}

   479

   480

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

   481

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

   482

		return NULL;

   483

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

   484

	il_operand->datatype = symbol->datatype;

   485

	il_operand->accept(*this);

   486

	prev_il_instruction = symbol;

   487

	return NULL;

   488

}

   489

   490

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

   491

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

   492

		return NULL;

   493

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

   494

	il_operand->datatype = symbol->datatype;

   495

	il_operand->accept(*this);

   496

	prev_il_instruction = symbol;

   497

	return NULL;

   498

}

   499

   500

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

   501

	prev_il_instruction = symbol;

   502

	return NULL;

   503

}

   504

   505

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

   506

	prev_il_instruction = symbol;

   507

	return NULL;

   508

}

   509

   510

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

   511

	prev_il_instruction = symbol;

   512

	return NULL;

   513

}

   514

   515

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

   516

	prev_il_instruction = symbol;

   517

	return NULL;

   518

}

   519

   520

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

   521

	prev_il_instruction = symbol;

   522

	return NULL;

   523

}

   524

   525

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

   526

	prev_il_instruction = symbol;

   527

	return NULL;

   528

}

   529

   530

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