1

/*

     2

 * (c) 2003-2007 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

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

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

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

    14

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

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

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

    22

 *

    23

 */

    24

    25

/*

    26

 * Definition of the Abstract Syntax data structure components

    27

 */

    28

    29

    30

/*

    31

 * ABSYNTAX.DEF

    32

 *

    33

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

    34

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

    35

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

    36

 * the relavent code.

    37

 */

    38

    39

    40

/* EN/ENO */

    41

SYM_REF0(en_param_c)

    42

SYM_REF0(eno_param_c)

    43

    44

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

    45

/* 2.1.6 - Pragmas */

    46

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

    47

SYM_TOKEN(pragma_c)

    48

    49

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

    50

/* B 0 - Programming Model */

    51

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

    52

SYM_LIST(library_c)

    53

    54

    55

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

    56

/* B.1 - Common elements */

    57

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

    58

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

    59

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

    60

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

    61

SYM_TOKEN(identifier_c)

    62

    63

    64

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

    65

/* B 1.2 - Constants */

    66

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

    67

    68

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

    69

/* B 1.2.1 - Numeric Literals */

    70

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

    71

SYM_TOKEN(real_c)

    72

SYM_TOKEN(integer_c)

    73

SYM_TOKEN(binary_integer_c)

    74

SYM_TOKEN(octal_integer_c)

    75

SYM_TOKEN(hex_integer_c)

    76

    77

/* Note:

    78

 * We do not have signed_integer_c and signed_real_c classes.

    79

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

    80

 * preceded by a unary minus operator.

    81

 */

    82

/* Not required:

    83

SYM_TOKEN(signed_integer_c)

    84

SYM_TOKEN(signed_real_c)

    85

*/

    86

    87

SYM_REF1(neg_literal_c, exp)

    88

    89

SYM_REF2(numeric_literal_c, type, value)

    90

SYM_REF2(integer_literal_c, type, value)

    91

SYM_REF2(real_literal_c, type, value)

    92

SYM_REF2(bit_string_literal_c, type, value)

    93

SYM_REF2(boolean_literal_c, type, value)

    94

    95

/* helper class for boolean_literal_c */

    96

SYM_REF0(boolean_true_c)

    97

    98

/* helper class for boolean_literal_c */

    99

SYM_REF0(boolean_false_c)

   100

   101

   102

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

   103

/* B.1.2.2   Character Strings */

   104

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

   105

SYM_TOKEN(double_byte_character_string_c)

   106

SYM_TOKEN(single_byte_character_string_c)

   107

   108

   109

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

   110

/* B 1.2.3 - Time Literals */

   111

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

   112

   113

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

   114

/* B 1.2.3.1 - Duration */

   115

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

   116

SYM_REF0(neg_time_c)

   117

SYM_REF2(duration_c, neg, interval)

   118

SYM_TOKEN(fixed_point_c)

   119

SYM_REF2(days_c, days, hours)

   120

SYM_REF2(hours_c, hours, minutes)

   121

SYM_REF2(minutes_c, minutes, seconds)

   122

SYM_REF2(seconds_c, seconds, milliseconds)

   123

SYM_REF1(milliseconds_c, milliseconds)

   124

   125

   126

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

   127

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

   128

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

   129

SYM_REF1(time_of_day_c, daytime)

   130

SYM_REF3(daytime_c, day_hour, day_minute, day_second)

   131

SYM_REF1(date_c, date_literal)

   132

SYM_REF3(date_literal_c, year, month, day)

   133

SYM_REF2(date_and_time_c, date_literal, daytime)

   134

   135

   136

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

   137

/* B.1.3 - Data types */

   138

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

   139

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

   140

/* B 1.3.1 - Elementary Data Types */

   141

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

   142

SYM_REF0(time_type_name_c)

   143

SYM_REF0(bool_type_name_c)

   144

SYM_REF0(sint_type_name_c)

   145

SYM_REF0(int_type_name_c)

   146

SYM_REF0(dint_type_name_c)

   147

SYM_REF0(lint_type_name_c)

   148

SYM_REF0(usint_type_name_c)

   149

SYM_REF0(uint_type_name_c)

   150

SYM_REF0(udint_type_name_c)

   151

SYM_REF0(ulint_type_name_c)

   152

SYM_REF0(real_type_name_c)

   153

SYM_REF0(lreal_type_name_c)

   154

SYM_REF0(date_type_name_c)

   155

SYM_REF0(tod_type_name_c)

   156

SYM_REF0(dt_type_name_c)

   157

SYM_REF0(byte_type_name_c)

   158

SYM_REF0(word_type_name_c)

   159

SYM_REF0(dword_type_name_c)

   160

SYM_REF0(lword_type_name_c)

   161

SYM_REF0(string_type_name_c)

   162

SYM_REF0(wstring_type_name_c)

   163

SYM_REF0(constant_int_type_name_c)

   164

SYM_REF0(constant_real_type_name_c)

   165

SYM_REF0(direct_variable_type_name_c)

   166

   167

   168

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

   169

/* B.1.3.2 - Generic data types */

   170

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

   171

   172

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

   173

/* B 1.3.3 - Derived data types */

   174

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

   175

/*  TYPE type_declaration_list END_TYPE */

   176

SYM_REF1(data_type_declaration_c, type_declaration_list)

   177

   178

/* helper symbol for data_type_declaration */

   179

SYM_LIST(type_declaration_list_c)

   180

   181

/*  simple_type_name ':' simple_spec_init */

   182

SYM_REF2(simple_type_declaration_c, simple_type_name, simple_spec_init)

   183

   184

   185

/* simple_specification ASSIGN constant */

   186

SYM_REF2(simple_spec_init_c, simple_specification, constant)

   187

   188

/*  subrange_type_name ':' subrange_spec_init */

   189

SYM_REF2(subrange_type_declaration_c, subrange_type_name, subrange_spec_init)

   190

   191

/* subrange_specification ASSIGN signed_integer */

   192

SYM_REF2(subrange_spec_init_c, subrange_specification, signed_integer)

   193

   194

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

   195

SYM_REF2(subrange_specification_c, integer_type_name, subrange)

   196

   197

/*  signed_integer DOTDOT signed_integer */

   198

SYM_REF2(subrange_c, lower_limit, upper_limit)

   199

   200

/*  enumerated_type_name ':' enumerated_spec_init */

   201

SYM_REF2(enumerated_type_declaration_c, enumerated_type_name, enumerated_spec_init)

   202

   203

/* enumerated_specification ASSIGN enumerated_value */

   204

SYM_REF2(enumerated_spec_init_c, enumerated_specification, enumerated_value)

   205

   206

/* helper symbol for enumerated_specification->enumerated_spec_init */

   207

/* enumerated_value_list ',' enumerated_value */

   208

SYM_LIST(enumerated_value_list_c)

   209

   210

/* enumerated_type_name '#' identifier */

   211

SYM_REF2(enumerated_value_c, type, value)

   212

   213

/*  identifier ':' array_spec_init */

   214

SYM_REF2(array_type_declaration_c, identifier, array_spec_init)

   215

   216

/* array_specification [ASSIGN array_initialization} */

   217

/* array_initialization may be NULL ! */

   218

SYM_REF2(array_spec_init_c, array_specification, array_initialization)

   219

   220

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

   221

SYM_REF2(array_specification_c, array_subrange_list, non_generic_type_name)

   222

   223

/* helper symbol for array_specification */

   224

/* array_subrange_list ',' subrange */

   225

SYM_LIST(array_subrange_list_c)

   226

   227

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

   228

/* helper symbol for array_initialization */

   229

/* array_initial_elements_list ',' array_initial_elements */

   230

SYM_LIST(array_initial_elements_list_c)

   231

   232

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

   233

/* array_initial_element may be NULL ! */

   234

SYM_REF2(array_initial_elements_c, integer, array_initial_element)

   235

   236

/*  structure_type_name ':' structure_specification */

   237

SYM_REF2(structure_type_declaration_c, structure_type_name, structure_specification)

   238

   239

/* structure_type_name ASSIGN structure_initialization */

   240

/* structure_initialization may be NULL ! */

   241

SYM_REF2(initialized_structure_c, structure_type_name, structure_initialization)

   242

   243

/* helper symbol for structure_declaration */

   244

/* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   245

/* structure_element_declaration_list structure_element_declaration ';' */

   246

SYM_LIST(structure_element_declaration_list_c)

   247

   248

/*  structure_element_name ':' *_spec_init */

   249

SYM_REF2(structure_element_declaration_c, structure_element_name, spec_init)

   250

   251

/* helper symbol for structure_initialization */

   252

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

   253

/* structure_element_initialization_list ',' structure_element_initialization */

   254

SYM_LIST(structure_element_initialization_list_c)

   255

   256

/*  structure_element_name ASSIGN value */

   257

SYM_REF2(structure_element_initialization_c, structure_element_name, value)

   258

   259

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   260

/*

   261

 * NOTE:

   262

 * (Summary: Contrary to what is expected, the

   263

 *           string_type_declaration_c is not used to store

   264

 *           simple string type declarations that do not include

   265

 *           size limits.

   266

 *           For e.g.:

   267

 *             str1_type: STRING := "hello!"

   268

 *           will be stored in a simple_type_declaration_c

   269

 *           instead of a string_type_declaration_c.

   270

 *           The following:

   271

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

   272

 *           will be stored in a sring_type_declaration_c

   273

 *

   274

 *           Read on for why this is done...

   275

 * End Summary)

   276

 *

   277

 * According to the spec, the valid construct

   278

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

   279

 * has two possible routes to type_declaration...

   280

 *

   281

 * Route 1:

   282

 * type_declaration: single_element_type_declaration

   283

 * single_element_type_declaration: simple_type_declaration

   284

 * simple_type_declaration: identifier ':' simple_spec_init

   285

 * simple_spec_init: simple_specification ASSIGN constant

   286

 * (shift:  identifier <- 'new_str_type')

   287

 * simple_specification: elementary_type_name

   288

 * elementary_type_name: STRING

   289

 * (shift: elementary_type_name <- STRING)

   290

 * (reduce: simple_specification <- elementary_type_name)

   291

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

   292

 * (reduce: simple_spec_init: simple_specification ASSIGN constant)

   293

 * (reduce: ...)

   294

 *

   295

 *

   296

 * Route 2:

   297

 * type_declaration: string_type_declaration

   298

 * string_type_declaration: identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init

   299

 * (shift:  identifier <- 'new_str_type')

   300

 * elementary_string_type_name: STRING

   301

 * (shift: elementary_string_type_name <- STRING)

   302

 * (shift: string_type_declaration_size <-  empty )

   303

 * string_type_declaration_init: ASSIGN character_string

   304

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

   305

 * (reduce: string_type_declaration_init <- ASSIGN character_string)

   306

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

   307

 * (reduce: type_declaration <- string_type_declaration)

   308

 *

   309

 *

   310

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

   311

 * the most sense. Unfortunately the construct 'simple_spec_init'

   312

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

   313

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

   314

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

   315

 * that the above declaration gets stored in a

   316

 * simple_type_declaration_c, and not in a string_type_declaration_c

   317

 * as would be expected!

   318

 */

   319

/*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   320

SYM_REF4(string_type_declaration_c,	string_type_name,

   321

					elementary_string_type_name,

   322

					string_type_declaration_size,

   323

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

   324

   325

   326

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

   327

/* B 1.4 - Variables */

   328

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

   329

SYM_REF1(symbolic_variable_c, var_name)

   330

   331

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

   332

/* B.1.4.1   Directly Represented Variables */

   333

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

   334

SYM_TOKEN(direct_variable_c)

   335

   336

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

   337

/* B.1.4.2   Multi-element Variables */

   338

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

   339

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

   340

SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   341

   342

/* subscript_list ',' subscript */

   343

SYM_LIST(subscript_list_c)

   344

   345

/*  record_variable '.' field_selector */

   346

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

   347

 *           may be accessed as fields of a structured variable!

   348

 *           Code handling a structured_variable_c must take

   349

 *           this into account!

   350

 */

   351

SYM_REF2(structured_variable_c, record_variable, field_selector)

   352

   353

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

   354

/* B 1.4.3 - Declaration & Initialisation */

   355

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

   356

SYM_REF0(constant_option_c)

   357

SYM_REF0(retain_option_c)

   358

SYM_REF0(non_retain_option_c)

   359

   360

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

   361

SYM_REF2(input_declarations_c, option, input_declaration_list)

   362

   363

/* helper symbol for input_declarations */

   364

SYM_LIST(input_declaration_list_c)

   365

   366

/* edge -> The F_EDGE or R_EDGE directive */

   367

SYM_REF2(edge_declaration_c, edge, var1_list)

   368

   369

SYM_REF0(en_param_declaration_c)

   370

   371

SYM_REF0(raising_edge_option_c)

   372

SYM_REF0(falling_edge_option_c)

   373

   374

/* spec_init is one of the following...

   375

 *    simple_spec_init_c *

   376

 *    subrange_spec_init_c *

   377

 *    enumerated_spec_init_c *

   378

 */

   379

SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   380

   381

/* | var1_list ',' variable_name */

   382

SYM_LIST(var1_list_c)

   383

   384

/* var1_list ':' array_spec_init */

   385

SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   386

   387

/*  var1_list ':' initialized_structure */

   388

SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   389

   390

/* fb_name_list ':' function_block_type_name ASSIGN structure_initialization */

   391

/* structure_initialization -> may be NULL ! */

   392

SYM_REF3(fb_name_decl_c, fb_name_list, function_block_type_name, structure_initialization)

   393

   394

/* fb_name_list ',' fb_name */

   395

SYM_LIST(fb_name_list_c)

   396

   397

/* VAR_OUTPUT [RETAIN | NON_RETAIN] var_init_decl_list END_VAR */

   398

/* option -> may be NULL ! */

   399

SYM_REF2(output_declarations_c, option, var_init_decl_list)

   400

   401

SYM_REF0(eno_param_declaration_c)

   402

   403

/*  VAR_IN_OUT var_declaration_list END_VAR */

   404

SYM_REF1(input_output_declarations_c, var_declaration_list)

   405

   406

/* helper symbol for input_output_declarations */

   407

/* var_declaration_list var_declaration ';' */

   408

SYM_LIST(var_declaration_list_c)

   409

   410

/*  var1_list ':' array_specification */

   411

SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   412

   413

/*  var1_list ':' structure_type_name */

   414

SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   415

   416

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   417

/* option -> may be NULL ! */

   418

SYM_REF2(var_declarations_c, option, var_init_decl_list)

   419

   420

/*  VAR RETAIN var_init_decl_list END_VAR */

   421

SYM_REF1(retentive_var_declarations_c, var_init_decl_list)

   422

   423

/*  VAR [CONSTANT|RETAIN|NON_RETAIN] located_var_decl_list END_VAR */

   424

/* option -> may be NULL ! */

   425

SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   426

   427

/* helper symbol for located_var_declarations */

   428

/* located_var_decl_list located_var_decl ';' */

   429

SYM_LIST(located_var_decl_list_c)

   430

   431

/*  [variable_name] location ':' located_var_spec_init */

   432

/* variable_name -> may be NULL ! */

   433

SYM_REF3(located_var_decl_c, variable_name, location, located_var_spec_init)

   434

   435

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   436

/* option -> may be NULL ! */

   437

SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   438

   439

/* helper symbol for external_var_declarations */

   440

/*| external_declaration_list external_declaration';' */

   441

SYM_LIST(external_declaration_list_c)

   442

   443

/*  global_var_name ':' (simple_specification|subrange_specification|enumerated_specification|array_specification|prev_declared_structure_type_name|function_block_type_name */

   444

SYM_REF2(external_declaration_c, global_var_name, specification)

   445

   446

/*| VAR_GLOBAL [CONSTANT|RETAIN] global_var_decl_list END_VAR */

   447

/* option -> may be NULL ! */

   448

SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   449

   450

/* helper symbol for global_var_declarations */

   451

/*| global_var_decl_list global_var_decl ';' */

   452

SYM_LIST(global_var_decl_list_c)

   453

   454

/*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */

   455

/* type_specification ->may be NULL ! */

   456

SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   457

   458

/*| global_var_name location */

   459

SYM_REF2(global_var_spec_c, global_var_name, location)

   460

   461

/*  AT direct_variable */

   462

SYM_REF1(location_c, direct_variable)

   463

   464

/*| global_var_list ',' global_var_name */

   465

SYM_LIST(global_var_list_c)

   466

   467

/*  var1_list ':' single_byte_string_spec */

   468

SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   469

   470

/*  STRING ['[' integer ']'] [ASSIGN single_byte_character_string] */

   471

/* integer ->may be NULL ! */

   472

/* single_byte_character_string ->may be NULL ! */

   473

SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   474

   475

/*  var1_list ':' double_byte_string_spec */

   476

SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   477

   478

/*  WSTRING ['[' integer ']'] [ASSIGN double_byte_character_string] */

   479

/* integer ->may be NULL ! */

   480

/* double_byte_character_string ->may be NULL ! */

   481

SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   482

   483

/*| VAR [RETAIN|NON_RETAIN] incompl_located_var_decl_list END_VAR */

   484

/* option ->may be NULL ! */

   485

SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)

   486

   487

/* helper symbol for incompl_located_var_declarations */

   488

/*| incompl_located_var_decl_list incompl_located_var_decl ';' */

   489

SYM_LIST(incompl_located_var_decl_list_c)

   490

   491

/*  variable_name incompl_location ':' var_spec */

   492

SYM_REF3(incompl_located_var_decl_c, variable_name, incompl_location, var_spec)

   493

   494

/*  AT incompl_location_token */

   495

SYM_TOKEN(incompl_location_c)

   496

   497

/* intermediate helper symbol for:

   498

 *  - non_retentive_var_decls

   499

 *  - output_declarations

   500

 */

   501

SYM_LIST(var_init_decl_list_c)

   502

   503

   504

   505

   506

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

   507

/* B.1.5 - Program organization units */

   508

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

   509

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

   510

/* B 1.5.1 - Functions */

   511

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

   512

SYM_REF4(function_declaration_c, derived_function_name, type_name, var_declarations_list, function_body)

   513

   514

/* intermediate helper symbol for

   515

 * - function_declaration

   516

 * - function_block_declaration

   517

 * - program_declaration

   518

 */

   519

SYM_LIST(var_declarations_list_c)

   520

   521

/* option -> storage method, CONSTANT or <null> */

   522

SYM_REF2(function_var_decls_c, option, decl_list)

   523

   524

/* intermediate helper symbol for function_var_decls */

   525

SYM_LIST(var2_init_decl_list_c)