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

    58

/* Only set the symbol's desired datatype to 'datatype' if that datatype is in the candidate_datatype list */

    59

static void set_datatype(symbol_c *datatype, symbol_c *symbol) {

    60

	symbol->datatype = NULL;   

    61

	if (search_in_datatype_list(datatype, symbol->candidate_datatypes) >= 0)

    62

		symbol->datatype = datatype;  

    63

}

    64

    65

    66

    67

    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

		 */

   109

		symbol_c *desired_datatype = base_type(fp_iterator.param_type());

   110

		if ((NULL != param_name) && (NULL == desired_datatype)) ERROR;

   111

		if ((NULL == param_name) && (NULL != desired_datatype)) ERROR;

   112

   113

		set_datatype(desired_datatype, call_param_value);

   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

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

   145

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

   146

   147

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

   148

		call_param_value = fcp_iterator.get_current_value();

   149

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

   150

		if (NULL == call_param_value) ERROR;

   151

   152

		/* Find the corresponding parameter in function declaration */

   153

		param_name = fp_iterator.search(call_param_name);

   154

   155

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

   156

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

   157

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

   158

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

   159

		 */

   160

		symbol_c *desired_datatype = base_type(fp_iterator.param_type());

   161

		if ((NULL != param_name) && (NULL == desired_datatype)) ERROR;

   162

		if ((NULL == param_name) && (NULL != desired_datatype)) ERROR;

   163

   164

		set_datatype(desired_datatype, call_param_value);

   165

		call_param_value->accept(*this);

   166

   167

		if (NULL != param_name) 

   168

			if (extensible_parameter_highest_index < fp_iterator.extensible_param_index())

   169

				extensible_parameter_highest_index = fp_iterator.extensible_param_index();

   170

	}

   171

	/* call is compatible! */

   172

   173

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

   174

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

   175

	 * of the function call itself!

   176

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

   177

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

   178

	 * output code.

   179

	 */

   180

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

   181

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

   182

}

   183

   184

   185

   186

/* a helper function... */

   187

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

   188

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

   189

	 *       in the code.

   190

	 */

   191

	if (symbol == NULL) return NULL;

   192

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

   193

}

   194

   195

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

   196

/* B 1.2 - Constants */

   197

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

   198

   199

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

   200

/* B 1.3 - Data types */

   201

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

   202

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

   203

/* B 1.3.3 - Derived data types */

   204

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

   205

/*  signed_integer DOTDOT signed_integer */

   206

// SYM_REF2(subrange_c, lower_limit, upper_limit)

   207

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

   208

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

   209

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

   210

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

   211

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

   212

	return NULL;

   213

}

   214

   215

   216

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

   217

/* B 1.4 - Variables */

   218

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

   219

   220

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

   221

/* B 1.4.1 - Directly Represented Variables */

   222

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

   223

   224

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

   225

/* B 1.4.2 - Multi-element variables */

   226

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

   227

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

   228

// SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   229

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

   230

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

   231

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

   232

	return NULL;

   233

}

   234

   235

   236

/* subscript_list ',' subscript */

   237

// SYM_LIST(subscript_list_c)

   238

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

   239

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

   240

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

   241

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

   242

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

   243

		}

   244

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

   245

	}

   246

	return NULL;  

   247

}

   248

   249

   250

   251

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

   252

/* B 1.5 Program organization units */

   253

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

   254

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

   255

/* B 1.5.1 Functions */

   256

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

   257

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

   258

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   259

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

   260

	prev_il_instruction = NULL;

   261

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

   262

	prev_il_instruction = NULL;

   263

	delete search_varfb_instance_type;

   264

	search_varfb_instance_type = NULL;

   265

	return NULL;

   266

}

   267

   268

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

   269

/* B 1.5.2 Function blocks */

   270

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

   271

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

   272

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   273

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

   274

	prev_il_instruction = NULL;

   275

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

   276

	prev_il_instruction = NULL;

   277

	delete search_varfb_instance_type;

   278

	search_varfb_instance_type = NULL;

   279

	return NULL;

   280

}

   281

   282

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

   283

/* B 1.5.3 Programs */

   284

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

   285

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

   286

	search_varfb_instance_type = new search_varfb_instance_type_c(symbol);

   287

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

   288

	prev_il_instruction = NULL;

   289

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

   290

	prev_il_instruction = NULL;

   291

	delete search_varfb_instance_type;

   292

	search_varfb_instance_type = NULL;

   293

	return NULL;

   294

}

   295

   296

   297

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

   298

/* B 1.7 Configuration elements */

   299

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

   300

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

   301

#if 0

   302

	// TODO !!!

   303

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

   304

#endif

   305

	return NULL;

   306

}

   307

   308

   309

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

   310

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

   311

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

   312

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

   313

/* B 2.1 Instructions and Operands */

   314

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

   315

// void *visit(instruction_list_c *symbol);

   316

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

   317

	il_operand = symbol->il_operand;

   318

	if (NULL != symbol->il_operand) {

   319

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

   320

	}

   321

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

   322

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

   323

	il_operand = NULL;

   324

	return NULL;

   325

}

   326

   327

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

   328

	return NULL;

   329

}

   330

   331

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

   332

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

   333

 *

   334

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

   335

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

   336

 */

   337

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

   338

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

   339

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

   340

/* MJS: TODO... */

   341

return NULL;

   342

}

   343

   344

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

   345

	return NULL;

   346

}

   347

   348

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

   349

	return NULL;

   350

}

   351

   352

   353

/*

   354

    void *visit(il_operand_list_c *symbol);

   355

    void *visit(simple_instr_list_c *symbol);

   356

    void *visit(il_param_list_c *symbol);

   357

    void *visit(il_param_assignment_c *symbol);

   358

    void *visit(il_param_out_assignment_c *symbol);

   359

 */

   360

   361

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

   362

/* B 2.2 Operators */

   363

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

   364

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

   365

	prev_il_instruction = symbol;

   366

	return NULL;

   367

}

   368

   369

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

   370

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

   371

		return NULL;

   372

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

   373

	il_operand->datatype = symbol->datatype;

   374

	il_operand->accept(*this);

   375

	prev_il_instruction = symbol;

   376

	return NULL;

   377

}

   378

   379

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

   380

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

   381

		return NULL;

   382

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

   383

	il_operand->datatype = symbol->datatype;

   384

	il_operand->accept(*this);

   385

	prev_il_instruction = symbol;

   386

	return NULL;

   387

}

   388

   389

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

   390

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

   391

		return NULL;

   392

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

   393

	il_operand->datatype = symbol->datatype;

   394

	il_operand->accept(*this);

   395

	prev_il_instruction = symbol;

   396

	return NULL;

   397

}

   398

   399

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

   400

	prev_il_instruction = symbol;

   401

	return NULL;

   402

}

   403

   404

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

   405

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

   406

		return NULL;

   407

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

   408

	il_operand->datatype = symbol->datatype;

   409

	il_operand->accept(*this);

   410

	prev_il_instruction = symbol;

   411

	return NULL;

   412

}

   413

   414

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

   415

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

   416

		return NULL;

   417

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

   418

	il_operand->datatype = symbol->datatype;

   419

	il_operand->accept(*this);

   420

	prev_il_instruction = symbol;

   421

	return NULL;

   422

}

   423

   424

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

   425

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

   426

		return NULL;

   427

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

   428

	il_operand->datatype = symbol->datatype;

   429

	il_operand->accept(*this);

   430

	prev_il_instruction = symbol;

   431

	return NULL;

   432

}

   433

   434

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

   435

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

   436

		return NULL;

   437

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

   438

	il_operand->datatype = symbol->datatype;

   439

	il_operand->accept(*this);

   440

	prev_il_instruction = symbol;

   441

	return NULL;

   442

}

   443

   444

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

   445

	prev_il_instruction = symbol;

   446

	return NULL;

   447

}

   448

   449

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

   450

	prev_il_instruction = symbol;

   451

	return NULL;

   452

}

   453

   454

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

   455

	prev_il_instruction = symbol;

   456

	return NULL;

   457

}

   458

   459

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

   460

	prev_il_instruction = symbol;

   461

	return NULL;

   462

}

   463

   464

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

   465

	prev_il_instruction = symbol;

   466

	return NULL;

   467

}

   468

   469

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

   470

	prev_il_instruction = symbol;

   471

	return NULL;

   472

}

   473

   474

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

   475

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

   476

		return NULL;

   477

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

   478

	il_operand->datatype = symbol->datatype;

   479

	il_operand->accept(*this);

   480

	prev_il_instruction = symbol;

   481

	return NULL;

   482

}

   483

   484

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

   485

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

   486

		return NULL;

   487

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

   488

	il_operand->datatype = symbol->datatype;

   489

	il_operand->accept(*this);

   490

	prev_il_instruction = symbol;

   491

	return NULL;

   492

}

   493

   494

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

   495

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

   496

		return NULL;

   497

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

   498

	il_operand->datatype = symbol->datatype;

   499

	il_operand->accept(*this);

   500

	prev_il_instruction = symbol;

   501

	return NULL;

   502

}

   503

   504

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

   505

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

   506

		return NULL;

   507

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

   508

	il_operand->datatype = symbol->datatype;

   509

	il_operand->accept(*this);

   510

	prev_il_instruction = symbol;

   511

	return NULL;

   512

}

   513

   514

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

   515

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

   516

		return NULL;

   517

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

   518

	il_operand->datatype = symbol->datatype;

   519

	il_operand->accept(*this);

   520

	prev_il_instruction = symbol;

   521

	return NULL;

   522

}

   523