1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *

     7

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

 *  This program is distributed in the hope that it will be useful,

    13

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

 * This code is made available on the understanding that it will not be

    22

 * used in safety-critical situations without a full and competent review.

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    30

 *

    31

 */

    32

    33

/*

    34

 * Determine the default initial value of a type declaration.

    35

 *

    36

 * This is part of the 4th stage that generates

    37

 * a c++ source program equivalent to the IL and ST

    38

 * code.

    39

 */

    40

/* Given a type definition declration, determine its default

    41

 * initial value. Note that types based on other types

    42

 * may have to iterate through each type it is based on

    43

 * to determine the initial value.

    44

 * E.g.

    45

 *  TYPE

    46

 *    A_t : INT := 10;

    47

 *    B_t : A_t := 20;

    48

 *    C_t : B_t;

    49

 *    D_t : C_t := 40;

    50

 *  END_TYPE

    51

 * Where the default initial value for C_t is 20!

    52

 */

    53

/* NOTE: The main program only needs one instance of

    54

 *       this class of object. This class

    55

 *       is therefore a singleton.

    56

 */

    57

    58

    59

#include "absyntax_utils.hh"

    60

    61

//#define DEBUG

    62

#ifdef DEBUG

    63

#define TRACE(classname) printf("\n____%s____\n",classname);

    64

#else

    65

#define TRACE(classname)

    66

#endif

    67

    68

    69

type_initial_value_c *type_initial_value_c::instance(void) {

    70

  if (_instance != NULL)

    71

    return _instance;

    72

    73

  _instance = new type_initial_value_c;

    74

    75

  null_literal = new ref_value_null_literal_c();

    76

  real_0       = new real_c("0");

    77

  integer_0    = new integer_c("0");

    78

  integer_1    = new integer_c("1");

    79

  bool_0       = new boolean_literal_c(new bool_type_name_c(),new boolean_false_c());

    80

  /* FIXME: Our current implementation only allows dates from 1970 onwards,

    81

   * but the standard defines the date 0001-01-01 as the default value

    82

   * for the DATE data type. Untill we fix our implementation, we use 1970-01-01

    83

   * as our default value!!

    84

   */

    85

//date_literal_0 =  new date_literal_c(integer_1, integer_1, integer_1);

    86

  date_literal_0    = new date_literal_c(new integer_c("1970"), integer_1, integer_1);

    87

  daytime_literal_0 = new daytime_c(integer_0, integer_0, real_0);

    88

  time_0       = new duration_c     (new time_type_name_c(), NULL, new interval_c(NULL, NULL, NULL, integer_0, NULL));  // T#0s

    89

  date_0       = new date_c         (new date_type_name_c(), date_literal_0);  //  D#0001-01-01

    90

  tod_0        = new time_of_day_c  (new  tod_type_name_c(), daytime_literal_0);  //  TOD#00:00:00

    91

  dt_0         = new date_and_time_c(new   dt_type_name_c(), date_literal_0, daytime_literal_0);  //  DT#0001-01-01-00:00:00

    92

  string_0     = new single_byte_character_string_c("''");

    93

  wstring_0    = new double_byte_character_string_c("\"\"");

    94

    95

  return _instance;

    96

}

    97

    98

type_initial_value_c::type_initial_value_c(void) {}

    99

   100

   101

   102

symbol_c *type_initial_value_c::get(symbol_c *type) {

   103

  TRACE("type_initial_value_c::get(): called ");

   104

  return (symbol_c *)type->accept(*type_initial_value_c::instance());

   105

}

   106

   107

   108

   109

   110

void *type_initial_value_c::handle_type_spec(symbol_c *base_type_name, symbol_c *type_spec_init) {

   111

  if (type_spec_init != NULL)

   112

     return type_spec_init;

   113

   /* no initial value specified, so we return

   114

   * the initial value of the type this type is based on...

   115

    */

   116

  return base_type_name->accept(*this);

   117

}

   118

   119

   141

  /* look up the type declaration... */

   142

  symbol_c *type_decl = type_symtable.find_value(type_name);

   143

  if (type_decl == type_symtable.end_value())

   144

    /* Type declaration not found!! */

   145

    /* NOTE: Variables declared out of function block 'data types',

   146

     *    for eg:  VAR  timer: TON; END_VAR

   147

     * do not have a default value, so (TON) will never be found in the

   148

     * type symbol table. This means we cannot simply consider this

   149

     * an error and abort, but must rather return a NULL.

   150

     */

   151

     return NULL;

   152

   153

  return type_decl->accept(*this);

   154

}

   155

   156

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

   157

/* B 1.3.1 - Elementary Data Types */

   158

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

   159

void *type_initial_value_c::visit(time_type_name_c *symbol)         {return (void *)time_0;}

   160

void *type_initial_value_c::visit(bool_type_name_c *symbol)         {return (void *)bool_0;}

   161

void *type_initial_value_c::visit(sint_type_name_c *symbol)         {return (void *)integer_0;}

   162

void *type_initial_value_c::visit(int_type_name_c *symbol)          {return (void *)integer_0;}

   163

void *type_initial_value_c::visit(dint_type_name_c *symbol)         {return (void *)integer_0;}

   164

void *type_initial_value_c::visit(lint_type_name_c *symbol)         {return (void *)integer_0;}

   165

void *type_initial_value_c::visit(usint_type_name_c *symbol)        {return (void *)integer_0;}

   166

void *type_initial_value_c::visit(uint_type_name_c *symbol)         {return (void *)integer_0;}

   167

void *type_initial_value_c::visit(udint_type_name_c *symbol)        {return (void *)integer_0;}

   168

void *type_initial_value_c::visit(ulint_type_name_c *symbol)        {return (void *)integer_0;}

   169

void *type_initial_value_c::visit(real_type_name_c *symbol)         {return (void *)real_0;}

   170

void *type_initial_value_c::visit(lreal_type_name_c *symbol)        {return (void *)real_0;}

   171

void *type_initial_value_c::visit(date_type_name_c *symbol)         {return (void *)date_0;}

   172

void *type_initial_value_c::visit(tod_type_name_c *symbol)          {return (void *)tod_0;}

   173

void *type_initial_value_c::visit(dt_type_name_c *symbol)           {return (void *)dt_0;}

   174

void *type_initial_value_c::visit(byte_type_name_c *symbol)         {return (void *)integer_0;}

   175

void *type_initial_value_c::visit(word_type_name_c *symbol)         {return (void *)integer_0;}

   176

void *type_initial_value_c::visit(dword_type_name_c *symbol)        {return (void *)integer_0;}

   177

void *type_initial_value_c::visit(lword_type_name_c *symbol)        {return (void *)integer_0;}

   178

void *type_initial_value_c::visit(string_type_name_c *symbol)       {return (void *)string_0;}

   179

void *type_initial_value_c::visit(wstring_type_name_c *symbol)      {return (void *)wstring_0;}

   180

   181

void *type_initial_value_c::visit(safetime_type_name_c *symbol)     {return (void *)time_0;}

   182

void *type_initial_value_c::visit(safebool_type_name_c *symbol)     {return (void *)bool_0;}

   183

void *type_initial_value_c::visit(safesint_type_name_c *symbol)     {return (void *)integer_0;}

   184

void *type_initial_value_c::visit(safeint_type_name_c *symbol)      {return (void *)integer_0;}

   185

void *type_initial_value_c::visit(safedint_type_name_c *symbol)     {return (void *)integer_0;}

   186

void *type_initial_value_c::visit(safelint_type_name_c *symbol)     {return (void *)integer_0;}

   187

void *type_initial_value_c::visit(safeusint_type_name_c *symbol)    {return (void *)integer_0;}

   188

void *type_initial_value_c::visit(safeuint_type_name_c *symbol)     {return (void *)integer_0;}

   189

void *type_initial_value_c::visit(safeudint_type_name_c *symbol)    {return (void *)integer_0;}

   190

void *type_initial_value_c::visit(safeulint_type_name_c *symbol)    {return (void *)integer_0;}

   191

void *type_initial_value_c::visit(safereal_type_name_c *symbol)     {return (void *)real_0;}

   192

void *type_initial_value_c::visit(safelreal_type_name_c *symbol)    {return (void *)real_0;}

   193

void *type_initial_value_c::visit(safedate_type_name_c *symbol)     {return (void *)date_0;}

   194

void *type_initial_value_c::visit(safetod_type_name_c *symbol)      {return (void *)tod_0;}

   195

void *type_initial_value_c::visit(safedt_type_name_c *symbol)       {return (void *)dt_0;}

   196

void *type_initial_value_c::visit(safebyte_type_name_c *symbol)     {return (void *)integer_0;}

   197

void *type_initial_value_c::visit(safeword_type_name_c *symbol)     {return (void *)integer_0;}

   198

void *type_initial_value_c::visit(safedword_type_name_c *symbol)    {return (void *)integer_0;}

   199

void *type_initial_value_c::visit(safelword_type_name_c *symbol)    {return (void *)integer_0;}

   200

void *type_initial_value_c::visit(safestring_type_name_c *symbol)   {return (void *)string_0;}

   201

void *type_initial_value_c::visit(safewstring_type_name_c *symbol)  {return (void *)wstring_0;}

   202

   203

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

   204

/* B 1.3.3 - Derived data types */

   205

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

   206

/*  simple_type_name ':' simple_spec_init */

   207

void *type_initial_value_c::visit(simple_type_declaration_c *symbol) {

   208

  return symbol->simple_spec_init->accept(*this);

   209

}

   210

/* simple_specification ASSIGN constant */

   211

void *type_initial_value_c::visit(simple_spec_init_c *symbol) {

   212

  return handle_type_spec(symbol->simple_specification, symbol->constant);

   213

}

   214

/*  subrange_type_name ':' subrange_spec_init */

   215

void *type_initial_value_c::visit(subrange_type_declaration_c *symbol) {

   216

  return symbol->subrange_spec_init->accept(*this);

   217

}

   218

/* subrange_specification ASSIGN signed_integer */

   219

void *type_initial_value_c::visit(subrange_spec_init_c *symbol) {

   220

  return handle_type_spec(symbol->subrange_specification, symbol->signed_integer);

   221

}

   222

/*  integer_type_name '(' subrange')' */

   223

void *type_initial_value_c::visit(subrange_specification_c *symbol) {

   224

 /* if no initial value explicitly given, then use the lowest value of the subrange */

   225

  if (symbol->subrange != NULL)

   226

    return symbol->subrange->accept(*this);

   227

  else

   228

    return symbol->integer_type_name->accept(*this);

   229

}

   230

/*  signed_integer DOTDOT signed_integer */

   231

void *type_initial_value_c::visit(subrange_c *symbol)	{return symbol->lower_limit;}

   232

/*  enumerated_type_name ':' enumerated_spec_init */

   233

void *type_initial_value_c::visit(enumerated_type_declaration_c *symbol) {

   234

  return symbol->enumerated_spec_init->accept(*this);

   235

}

   236

/* enumerated_specification ASSIGN enumerated_value */

   237

void *type_initial_value_c::visit(enumerated_spec_init_c *symbol) {

   238

  return handle_type_spec(symbol->enumerated_specification, symbol->enumerated_value);

   239

}

   240

/* helper symbol for enumerated_specification->enumerated_spec_init */

   241

/* enumerated_value_list ',' enumerated_value */

   242

void *type_initial_value_c::visit(enumerated_value_list_c *symbol) {

   243

  /* stage1_2 never creates an enumerated_value_list_c with no entries. If this occurs, then something must have changed! */

   244

  if (symbol->n <= 0) ERROR;

   245

 /* if no initial value explicitly given, then use the lowest value of the subrange */

   246

  return (void *)symbol->elements[0];

   247

}

   248

/* enumerated_type_name '#' identifier */

   249

// SYM_REF2(enumerated_value_c, type, value)

   250

void *type_initial_value_c::visit(enumerated_value_c *symbol)	{ERROR; return NULL;}

   251

/*  identifier ':' array_spec_init */

   252

void *type_initial_value_c::visit(array_type_declaration_c *symbol) {

   253

  return symbol->array_spec_init->accept(*this);

   254

}

   255

/* array_specification [ASSIGN array_initialization} */

   256

/* array_initialization may be NULL ! */

   257

void *type_initial_value_c::visit(array_spec_init_c *symbol) {

   258

  return handle_type_spec(symbol->array_specification, symbol->array_initialization);

   259

}

   260

/* ARRAY '[' array_subrange_list ']' OF non_generic_type_name */

   261

void *type_initial_value_c::visit(array_specification_c *symbol)	{

   262

  //symbol_c *init_value = (symbol_c *)symbol->non_generic_type_name->accept(*this);

   263

   264

  /* Now build a array_initial_elements_list_c list, and populate it

   265

   * with 1 element of the array_initial_elements_c class

   266

   */

   267

  /* The array_initial_elements_c will contain a reference to the init_value,

   268

   * and another constant representing the number of elements in the array.

   269

   * In essence, we are building the equivilant of the following ST/IL code:

   270

   *    New_array_t : ARRAY [1..30, 51..60] of INT := [40(XXX)];

   271

   * from the user given code

   272

   *    New_array_t : ARRAY [1..30, 51..60] of INT;

   273

   * and replacing XXX with the default initial value of INT.

   274

   */

   275

  /* now we need to determine the number of elements in the array... */

   276

  /* Easier said than done, as the array may have a list of subranges, as in the

   277

   * example given above!!

   278

   */

   279

  /* TODO !!!!!*/

   280

  /* For now, just assume an array with 1 element.

   281

   * I (Mario) want to finish off this part of the code before getting boged down

   282

   * in something else...

   283

   */

   284

  // NOTE: We are leaking memory, as the integer will never get free'd!!

   285

  //integer_c *integer = new integer_c("1");

   286

  // NOTE: We are leaking memory, as the array_initial_elements will never get free'd!!

   287

  //array_initial_elements_c *array_initial_elements = new array_initial_elements_c(integer, init_value);

   288

  // NOTE: We are leaking memory, as the array_initial_elements_list will never get free'd!!

   289

  array_initial_elements_list_c *array_initial_elements_list  = new array_initial_elements_list_c();

   290

  //array_initial_elements_list->add_element(array_initial_elements);

   291

  return array_initial_elements_list;

   292

}

   293

/* helper symbol for array_specification */

   294

/* array_subrange_list ',' subrange */

   295

void *type_initial_value_c::visit(array_subrange_list_c *symbol)	{ERROR; return NULL;}

   296

/* array_initialization:  '[' array_initial_elements_list ']' */

   297

/* helper symbol for array_initialization */

   298

/* array_initial_elements_list ',' array_initial_elements */

   299

void *type_initial_value_c::visit(array_initial_elements_list_c *symbol)	{ERROR; return NULL;}

   300

/* integer '(' [array_initial_element] ')' */

   301

/* array_initial_element may be NULL ! */

   302

void *type_initial_value_c::visit(array_initial_elements_c *symbol)	{ERROR; return NULL;}

   303

   304

   305

   306

/* TODO: from this point forward... */

   307

   308

/*  structure_type_name ':' structure_specification */

   309

void *type_initial_value_c::visit(structure_type_declaration_c *symbol) {return NULL;}

   310

/* structure_type_name ASSIGN structure_initialization */

   311

/* structure_initialization may be NULL ! */

   312

void *type_initial_value_c::visit(initialized_structure_c *symbol)	{

   313

  return handle_type_spec(symbol->structure_type_name, symbol->structure_initialization);

   314

}

   315

/* helper symbol for structure_declaration */

   316

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   317

/* structure_element_declaration_list structure_element_declaration ';' */

   318

void *type_initial_value_c::visit(structure_element_declaration_list_c *symbol)	{

   319

  structure_element_initialization_list_c *structure_element_initialization_list = new structure_element_initialization_list_c();

   320

  return structure_element_initialization_list;

   321

}

   322

/*  structure_element_name ':' *_spec_init */

   323

void *type_initial_value_c::visit(structure_element_declaration_c *symbol)	{return NULL;}

   324

/* helper symbol for structure_initialization */

   325

/* structure_initialization: '(' structure_element_initialization_list ')' */

   326

/* structure_element_initialization_list ',' structure_element_initialization */

   327

void *type_initial_value_c::visit(structure_element_initialization_list_c *symbol)	{return NULL;}

   328

/*  structure_element_name ASSIGN value */

   329

void *type_initial_value_c::visit(structure_element_initialization_c *symbol)	{return NULL;}

   330

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   331

/*

   332

 * NOTE:

   333

 * (Summary: Contrary to what is expected, the

   334

 *           string_type_declaration_c is not used to store

   335

 *           simple string type declarations that do not include

   336

 *           size limits.

   337

 *           For e.g.:

   338

 *             str1_type: STRING := "hello!"

   339

 *           will be stored in a simple_type_declaration_c

   340

 *           instead of a string_type_declaration_c.

   341

 *           The following:

   342

 *             str2_type: STRING [64] := "hello!"

   343

 *           will be stored in a sring_type_declaration_c

   344

 *

   345

 *           Read on for why this is done...

   346

 * End Summary)

   347

 *

   348

 * According to the spec, the valid construct

   349

 * TYPE new_str_type : STRING := "hello!"; END_TYPE

   350

 * has two possible routes to type_declaration...

   351

 *

   352

 * Route 1:

   353

 * type_declaration: single_element_type_declaration

   354

 * single_element_type_declaration: simple_type_declaration

   355

 * simple_type_declaration: identifier ':' simple_spec_init

   356

 * simple_spec_init: simple_specification ASSIGN constant

   357

 * (shift:  identifier <- 'new_str_type')

   358

 * simple_specification: elementary_type_name

   359

 * elementary_type_name: STRING

   360

 * (shift: elementary_type_name <- STRING)

   361

 * (reduce: simple_specification <- elementary_type_name)

   362

 * (shift: constant <- "hello!")

   363

 * (reduce: simple_spec_init: simple_specification ASSIGN constant)

   364

 * (reduce: ...)

   365

 *

   366

 *

   367

 * Route 2:

   368

 * type_declaration: string_type_declaration

   369

 * string_type_declaration: identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init

   370

 * (shift:  identifier <- 'new_str_type')

   371

 * elementary_string_type_name: STRING

   372

 * (shift: elementary_string_type_name <- STRING)

   373

 * (shift: string_type_declaration_size <-  empty )

   374

 * string_type_declaration_init: ASSIGN character_string

   375

 * (shift: character_string <- "hello!")

   376

 * (reduce: string_type_declaration_init <- ASSIGN character_string)

   377

 * (reduce: string_type_declaration <- identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init )

   378

 * (reduce: type_declaration <- string_type_declaration)

   379

 *

   380

 *

   381

 * At first glance it seems that removing route 1 would make

   382

 * the most sense. Unfortunately the construct 'simple_spec_init'

   383

 * shows up multiple times in other rules, so changing this construct

   384

 * would also mean changing all the rules in which it appears.

   385

 * I (Mario) therefore chose to remove route 2 instead. This means

   386

 * that the above declaration gets stored in a

   387

 * simple_type_declaration_c, and not in a string_type_declaration_c

   388

 * as would be expected!

   389

 */

   390

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   391

// SYM_REF4(string_type_declaration_c,	string_type_name,

   392

// 					elementary_string_type_name,

   393

// 					string_type_declaration_size,

   394

// 					string_type_declaration_init) /* may be == NULL! */

   395

void *type_initial_value_c::visit(string_type_declaration_c *symbol)	{

   396

  return handle_type_spec(symbol->elementary_string_type_name, symbol->string_type_declaration_init);

   397

}

   398

   399

   400

/* REF_TO (non_generic_type_name | function_block_type_name) */

   401

void *type_initial_value_c::visit(ref_spec_c *symbol) {

   402

  return null_literal;

   403

}

   404

   405

   406

/* ref_spec [ ASSIGN ref_initialization ]; */

   407

/* NOTE: ref_initialization may be NULL!!  */

   408

void *type_initial_value_c::visit(ref_spec_init_c *symbol) {

   409

  return handle_type_spec(symbol->ref_spec, symbol->ref_initialization);

   410

}

   411

/* identifier ':' ref_spec_init */

   412

void *type_initial_value_c::visit(ref_type_decl_c *symbol) {

   413

  return symbol->ref_spec_init->accept(*this);

   414

}

   415

   416

   417

   418

   419

   420

   421

   422

   423

type_initial_value_c            *type_initial_value_c::_instance         = NULL;

   424

ref_value_null_literal_c        *type_initial_value_c::null_literal      = NULL;

   425

real_c                          *type_initial_value_c::real_0            = NULL;

   426

integer_c                       *type_initial_value_c::integer_0         = NULL;

   427

integer_c                       *type_initial_value_c::integer_1         = NULL;

   428

boolean_literal_c               *type_initial_value_c::bool_0            = NULL;

   429

date_literal_c                  *type_initial_value_c::date_literal_0    = NULL;

   430

daytime_c                       *type_initial_value_c::daytime_literal_0 = NULL;

   431

duration_c                      *type_initial_value_c::time_0            = NULL;

   432

date_c                          *type_initial_value_c::date_0            = NULL;

   433

time_of_day_c                   *type_initial_value_c::tod_0             = NULL;

   434

date_and_time_c                 *type_initial_value_c::dt_0              = NULL;

   435

single_byte_character_string_c  *type_initial_value_c::string_0          = NULL;

   436

double_byte_character_string_c  *type_initial_value_c::wstring_0         = NULL;