1

/*

     2

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

     3

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

     4

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

     5

 *

     6

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

     7

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

     8

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

     9

 *  (at your option) any later version.

    10

 *

    11

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

    12

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

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

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

    17

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

    18

 *

    19

 *

    20

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

    21

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

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

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

    29

 *

    30

 */

    31

    32

    33

/*

    34

 * Definition of the Abstract Syntax data structure components

    35

 */

    36

    37

    38

/*

    39

 * ABSYNTAX.DEF

    40

 *

    41

 * This generates the parse tree structure used to bind the components

    42

 * identified by Bison in the correct syntax order. At the end of the

    43

 * Bison analysis the tree is walked in a sequential fashion generating

    44

 * the relavent code.

    45

 */

    46

    47

    48

    49

    50

    51

    52

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

    53

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

    54

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

    55

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

    56

/*                                                               */

    57

/*      safe<xxxxxx> Symbols are defined in:                     */

    58

/*      PLCopen - Technical Committee 5                          */

    59

/*      Safety Software Technical Specification,                 */

    60

/*      Part 1: Concepts and Function Blocks,                    */

    61

/*      Version 1.0 – Official Release - 2006-01-31              */

    62

/*                                                               */

    63

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

    64

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

    65

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

    66

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

    67

    68

    69

    70

    71

    72

    73

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

    74

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

    75

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

    76

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

    77

/*                                                               */

    78

/*             Symbols defined in:                               */

    79

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

    80

/*                                                               */

    81

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

    82

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

    83

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

    84

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

    85

    86

/* Based on the                                    */

    87

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

    88

    89

    90

/* EN/ENO */

    91

/* NOTE we store 'EN' and 'ENO' tokens in an identifier_c

    92

 *      as they may be used as variables, and it is much easier 

    93

 *      to handle them (fewer special cases) if we do it that way...

    94

 */

    95

/*

    96

SYM_REF0(en_param_c)

    97

SYM_REF0(eno_param_c)

    98

*/

    99

   100

/* A class used to identify an entry (literal, variable, etc...) in the abstract syntax tree with an invalid data type */

   101

/* This is only used from stage3 onwards. Stages 1 and 2 will never create any instances of invalid_type_name_c */

   102

SYM_REF0(invalid_type_name_c)

   103

   104

   105

   106

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

   107

/* 2.1.6 - Pragmas  */

   108

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

   109

SYM_REF0(disable_code_generation_pragma_c)

   110

SYM_REF0(enable_code_generation_pragma_c)

   111

SYM_TOKEN(pragma_c)

   112

   113

   114

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

   115

/* B 0 - Programming Model */

   116

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

   117

SYM_LIST(library_c)

   118

   119

   120

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

   121

/* B.1 - Common elements */

   122

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

   123

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

   124

/* B 1.1 - Letters, digits and identifiers */

   125

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

   126

SYM_TOKEN(identifier_c)

   127

   128

   129

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

   130

/* B 1.2 - Constants */

   131

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

   132

   133

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

   134

/* B 1.2.1 - Numeric Literals */

   135

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

   136

SYM_TOKEN(real_c)

   137

SYM_TOKEN(integer_c)

   138

SYM_TOKEN(binary_integer_c)

   139

SYM_TOKEN(octal_integer_c)

   140

SYM_TOKEN(hex_integer_c)

   141

   142

/* Note:

   143

 * We do not have signed_integer_c and signed_real_c classes.

   144

 * These are stored in the parse tree as a integer_c or real_c

   145

 * preceded by a unary minus operator if they are inside an expression,

   146

 * or a neg_integer_c and neg_real_c when used outside an ST expression.

   147

 */

   148

/* Not required:

   149

SYM_TOKEN(signed_integer_c)

   150

SYM_TOKEN(signed_real_c)

   151

*/

   152

   153

/* NOTE: literal __values__ are stored directly in classes such as:

   154

 *          - real_c

   155

 *          - integer_c

   156

 *          - binary_integer_c

   157

 *          - etc...

   158

 *

   159

 *       However, for both the real_c and the integer_c, if they are preceded 

   160

 *       by a '-' negation sign, they are further encapsulated inside 

   161

 *       a neg_literal_c (i.e. the neg_literal_c will point to the 

   162

 *       real_c or integer_c with the value being negated.

   163

 *          neg_literal_c -> integer_literal_c

   164

 *                OR

   165

 *          neg_literal_c -> real_literal_c

   166

 *

   167

 *      In the semantic verification and code generation stages of the compiler,

   168

 *      the integer_c is treated as a basic (undefined) data type, since an integer

   169

 *      constant may be used as a BYTE, BOOLEAN, REAL, etc..., depending on the

   170

 *      context in which it is used.

   171

 *      However, an integer_c that is preceded by a '-' may not be used

   172

 *      as an ANY_BIT data type (BYTE, BOOLEAN, WORD, ...).

   173

 *      We must therefore be able to determine, holding a simple pointer

   174

 *      to an integer_c, if that integer_c value is preceded by a '-'.

   175

 *      However, since the neg_literal_c points to the integer_c, and not

   176

 *      vice-versa, we can't determine that.

   177

 *      There are 3 simple ways of working around this:

   178

 *        - change the order of the pointers: 

   179

 *              have the integer_c and real_c point to the neg_literal_c

   180

 *        - maintain the order of the pointers, and

   181

 *              add redundant info to the integer_c and real_c

   182

 *        - replace the neg_literal_c with two distinc classes

   183

 *              (neg_integer_c and neg_real_c), one for each

   184

 *              lietral type. This means that we can now treat

   185

 *              each of these classes as an unknown data type

   186

 *              just as we do with the integer_c and real_c.

   187

 *

   188

 *      The second option is simply ugly.

   189

 *      and the first has a serious drawback: when generating code it is

   190

 *      easier to encapsulate the real or integer values inside prefix

   191

 *      and postfix symbols (e.g. NEG(<value>) - with postfix ')' )

   192

 *      if we keep the pointer order as is.

   193

 *

   194

 *      For the above reasoning, we use the third option.

   195

 */  

   196

SYM_REF1(neg_real_c, exp)

   197

SYM_REF1(neg_integer_c, exp)

   198

   199

/* Not required:

   200

SYM_REF2(numeric_literal_c, type, value)

   201

*/

   202

SYM_REF2(integer_literal_c, type, value)

   203

SYM_REF2(real_literal_c, type, value)

   204

SYM_REF2(bit_string_literal_c, type, value)

   205

/* A typed or untyped boolean literal... */

   206

/* type may be NULL */

   207

SYM_REF2(boolean_literal_c, type, value)

   208

   209

/* helper class for boolean_literal_c */

   210

SYM_REF0(boolean_true_c)

   211

   212

/* helper class for boolean_literal_c */

   213

SYM_REF0(boolean_false_c)

   214

   215

   216

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

   217

/* B.1.2.2   Character Strings */

   218

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

   219

SYM_TOKEN(double_byte_character_string_c)

   220

SYM_TOKEN(single_byte_character_string_c)

   221

   222

   223

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

   224

/* B 1.2.3 - Time Literals */

   225

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

   226

   227

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

   228

/* B 1.2.3.1 - Duration */

   229

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

   230

SYM_REF0(neg_time_c)

   231

SYM_REF3(duration_c, type_name, neg, interval)

   232

SYM_TOKEN(fixed_point_c)

   233

SYM_REF2(days_c, days, hours)

   234

SYM_REF2(hours_c, hours, minutes)

   235

SYM_REF2(minutes_c, minutes, seconds)

   236

SYM_REF2(seconds_c, seconds, milliseconds)

   237

SYM_REF1(milliseconds_c, milliseconds)

   238

   239

   240

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

   241

/* B 1.2.3.2 - Time of day and Date */

   242

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

   243

SYM_REF2(time_of_day_c, type_name, daytime)

   244

SYM_REF3(daytime_c, day_hour, day_minute, day_second)

   245

SYM_REF2(date_c, type_name, date_literal)

   246

SYM_REF3(date_literal_c, year, month, day)

   247

SYM_REF3(date_and_time_c, type_name, date_literal, daytime)

   248

   249

   250

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

   251

/* B.1.3 - Data types */

   252

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

   253

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

   254

/* B 1.3.1 - Elementary Data Types */

   255

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

   256

SYM_REF0(time_type_name_c)

   257

SYM_REF0(bool_type_name_c)

   258

SYM_REF0(sint_type_name_c)

   259

SYM_REF0(int_type_name_c)

   260

SYM_REF0(dint_type_name_c)

   261

SYM_REF0(lint_type_name_c)

   262

SYM_REF0(usint_type_name_c)

   263

SYM_REF0(uint_type_name_c)

   264

SYM_REF0(udint_type_name_c)

   265

SYM_REF0(ulint_type_name_c)

   266

SYM_REF0(real_type_name_c)

   267

SYM_REF0(lreal_type_name_c)

   268

SYM_REF0(date_type_name_c)

   269

SYM_REF0(tod_type_name_c)

   270

SYM_REF0(dt_type_name_c)

   271

SYM_REF0(byte_type_name_c)

   272

SYM_REF0(word_type_name_c)

   273

SYM_REF0(dword_type_name_c)

   274

SYM_REF0(lword_type_name_c)

   275

SYM_REF0(string_type_name_c)

   276

SYM_REF0(wstring_type_name_c)

   277

   278

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

   279

  /* Keywords defined in "Safety Software Technical Specification" */

   280

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

   281

   282

SYM_REF0(safetime_type_name_c)

   283

SYM_REF0(safebool_type_name_c)

   284

SYM_REF0(safesint_type_name_c)

   285

SYM_REF0(safeint_type_name_c)

   286

SYM_REF0(safedint_type_name_c)

   287

SYM_REF0(safelint_type_name_c)

   288

SYM_REF0(safeusint_type_name_c)

   289

SYM_REF0(safeuint_type_name_c)

   290

SYM_REF0(safeudint_type_name_c)

   291

SYM_REF0(safeulint_type_name_c)

   292

SYM_REF0(safereal_type_name_c)

   293

SYM_REF0(safelreal_type_name_c)

   294

SYM_REF0(safedate_type_name_c)

   295

SYM_REF0(safetod_type_name_c)

   296

SYM_REF0(safedt_type_name_c)

   297

SYM_REF0(safebyte_type_name_c)

   298

SYM_REF0(safeword_type_name_c)

   299

SYM_REF0(safedword_type_name_c)

   300

SYM_REF0(safelword_type_name_c)

   301

SYM_REF0(safestring_type_name_c)

   302

SYM_REF0(safewstring_type_name_c)

   303

   304

   305

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

   306

/* B.1.3.2 - Generic data types */

   307

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

   308

   309

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

   310

/* B 1.3.3 - Derived data types */

   311

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

   312

/*  TYPE type_declaration_list END_TYPE */

   313

SYM_REF1(data_type_declaration_c, type_declaration_list)

   314

   315

/* helper symbol for data_type_declaration */

   316

SYM_LIST(type_declaration_list_c)

   317

   318

/*  simple_type_name ':' simple_spec_init */

   319

SYM_REF2(simple_type_declaration_c, simple_type_name, simple_spec_init)

   320

   321

   322

/* simple_specification ASSIGN constant */

   323

SYM_REF2(simple_spec_init_c, simple_specification, constant)

   324

   325

/*  subrange_type_name ':' subrange_spec_init */

   326

SYM_REF2(subrange_type_declaration_c, subrange_type_name, subrange_spec_init)

   327

   328

/* subrange_specification ASSIGN signed_integer */

   329

SYM_REF2(subrange_spec_init_c, subrange_specification, signed_integer)

   330

   331

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

   332

SYM_REF2(subrange_specification_c, integer_type_name, subrange)

   333

   334

/*  signed_integer DOTDOT signed_integer */

   335

SYM_REF2(subrange_c, lower_limit, upper_limit)

   336

   337

/*  enumerated_type_name ':' enumerated_spec_init */

   338

SYM_REF2(enumerated_type_declaration_c, enumerated_type_name, enumerated_spec_init)

   339

   340

/* enumerated_specification ASSIGN enumerated_value */

   341

SYM_REF2(enumerated_spec_init_c, enumerated_specification, enumerated_value)

   342

   343

/* helper symbol for enumerated_specification->enumerated_spec_init */

   344

/* enumerated_value_list ',' enumerated_value */

   345

SYM_LIST(enumerated_value_list_c)

   346

   347

/* enumerated_type_name '#' identifier */

   348

SYM_REF2(enumerated_value_c, type, value)

   349

   350

/*  identifier ':' array_spec_init */

   351

SYM_REF2(array_type_declaration_c, identifier, array_spec_init)

   352

   353

/* array_specification [ASSIGN array_initialization} */

   354

/* array_initialization may be NULL ! */

   355

SYM_REF2(array_spec_init_c, array_specification, array_initialization)

   356

   357

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

   358

SYM_REF2(array_specification_c, array_subrange_list, non_generic_type_name)

   359

   360

/* helper symbol for array_specification */

   361

/* array_subrange_list ',' subrange */

   362

SYM_LIST(array_subrange_list_c)

   363

   364

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

   365

/* helper symbol for array_initialization */

   366

/* array_initial_elements_list ',' array_initial_elements */

   367

SYM_LIST(array_initial_elements_list_c)

   368

   369

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

   370

/* array_initial_element may be NULL ! */

   371

SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   372

   373

/*  structure_type_name ':' structure_specification */

   374

SYM_REF2(structure_type_declaration_c, structure_type_name, structure_specification)

   375

   376

/* structure_type_name ASSIGN structure_initialization */

   377

/* structure_initialization may be NULL ! */

   378

SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   379

   380

/* helper symbol for structure_declaration */

   381

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   382

/* structure_element_declaration_list structure_element_declaration ';' */

   383

SYM_LIST(structure_element_declaration_list_c)

   384

   385

/*  structure_element_name ':' *_spec_init */

   386

SYM_REF2(structure_element_declaration_c, structure_element_name, spec_init)

   387

   388

/* helper symbol for structure_initialization */

   389

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

   390

/* structure_element_initialization_list ',' structure_element_initialization */

   391

SYM_LIST(structure_element_initialization_list_c)

   392

   393

/*  structure_element_name ASSIGN value */

   394

SYM_REF2(structure_element_initialization_c, structure_element_name, value)

   395

   396

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   397

/*

   398

 * NOTE:

   399

 * (Summary: Contrary to what is expected, the

   400

 *           string_type_declaration_c is not used to store

   401

 *           simple string type declarations that do not include

   402

 *           size limits.

   403

 *           For e.g.:

   404

 *             str1_type: STRING := "hello!"

   405

 *           will be stored in a simple_type_declaration_c

   406

 *           instead of a string_type_declaration_c.

   407

 *           The following:

   408

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

   409

 *           will be stored in a sring_type_declaration_c

   410

 *

   411

 *           Read on for why this is done...

   412

 * End Summary)

   413

 *

   414

 * According to the spec, the valid construct

   415

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

   416

 * has two possible routes to type_declaration...

   417

 *

   418

 * Route 1:

   419

 * type_declaration: single_element_type_declaration

   420

 * single_element_type_declaration: simple_type_declaration

   421

 * simple_type_declaration: identifier ':' simple_spec_init

   422

 * simple_spec_init: simple_specification ASSIGN constant

   423

 * (shift:  identifier <- 'new_str_type')

   424

 * simple_specification: elementary_type_name

   425

 * elementary_type_name: STRING

   426

 * (shift: elementary_type_name <- STRING)

   427

 * (reduce: simple_specification <- elementary_type_name)

   428

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

   429

 * (reduce: simple_spec_init: simple_specification ASSIGN constant)

   430

 * (reduce: ...)

   431

 *

   432

 *

   433

 * Route 2:

   434

 * type_declaration: string_type_declaration

   435

 * string_type_declaration: identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init

   436

 * (shift:  identifier <- 'new_str_type')

   437

 * elementary_string_type_name: STRING

   438

 * (shift: elementary_string_type_name <- STRING)

   439

 * (shift: string_type_declaration_size <-  empty )

   440

 * string_type_declaration_init: ASSIGN character_string

   441

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

   442

 * (reduce: string_type_declaration_init <- ASSIGN character_string)

   443

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

   444

 * (reduce: type_declaration <- string_type_declaration)

   445

 *

   446

 *

   447

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

   448

 * the most sense. Unfortunately the construct 'simple_spec_init'

   449

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

   450

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

   451

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

   452

 * that the above declaration gets stored in a

   453

 * simple_type_declaration_c, and not in a string_type_declaration_c

   454

 * as would be expected!

   455

 */

   456

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   457

SYM_REF4(string_type_declaration_c,	string_type_name,

   458

					elementary_string_type_name,

   459

					string_type_declaration_size,

   460

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

   461

   462

   463

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

   464

/* B 1.4 - Variables */

   465

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

   466

SYM_REF1(symbolic_variable_c, var_name)

   467

   468

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

   469

/* B.1.4.1   Directly Represented Variables */

   470

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

   471

SYM_TOKEN(direct_variable_c)

   472

   473

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

   474

/* B.1.4.2   Multi-element Variables */

   475

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

   476

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

   477

SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   478

   479

/* subscript_list ',' subscript */

   480

SYM_LIST(subscript_list_c)

   481

   482

/*  record_variable '.' field_selector */

   483

/*  WARNING: input and/or output variables of function blocks

   484

 *           may be accessed as fields of a structured variable!

   485

 *           Code handling a structured_variable_c must take

   486

 *           this into account!

   487

 */

   488

SYM_REF2(structured_variable_c, record_variable, field_selector)

   489

   490

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

   491

/* B 1.4.3 - Declaration & Initialisation */

   492

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

   493

SYM_REF0(constant_option_c)

   494

SYM_REF0(retain_option_c)

   495

SYM_REF0(non_retain_option_c)

   496

   497

/* option -> the RETAIN/NON_RETAIN/<NULL> directive... */

   498

/* NOTE: We need to implicitly define the EN and ENO function and FB parameters when the user

   499

 *       does not do it explicitly in the IEC 61131-3 source code. 

   500

 *       To be able to distinguish later on between implictly and explicitly defined

   501

 *       variables, we use the 'method' flag that allows us to remember

   502

 *       whether this declaration was in the original source code (method -> implicit_definition_c) 

   503

 *       or not (method -> explicit_definition_c).

   504

 */

   505

SYM_REF3(input_declarations_c, option, input_declaration_list, method)

   506

   507

/* helper symbol for input_declarations */

   508

SYM_LIST(input_declaration_list_c)

   509

   510

/* NOTE: The formal definition of the standard is erroneous, as it simply does not

   511

 *       consider the EN and ENO keywords!

   512

 *       The semantic description of the languages clearly states that these may be

   513

 *       used in several ways. One of them is to declare an EN input parameter, or

   514

 *       an ENO output parameter.