1

/*

     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

/*

    19

 *

    20

 * Based on the

    21

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

    22

 *

    23

 */

    24

    25

/*

    26

 * Stage 2

    27

 * =======

    28

 *

    29

 *  This file contains the syntax definition of the textual

    33

 */

    34

    35

    36

    37

    38

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

    39

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

    40

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

    41

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

    42

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

    43

/*******   The following syntax does not have any conflicts.    *******/

    44

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

    45

/*******   P L E A S E    K E E P    I T    T H A T    W A Y !  *******/

    46

/*******   ===================================================  *******/

    47

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

    48

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

    49

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

    50

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

    51

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

    52

    53

    54

    55

    56

%{

    57

#include <string.h>	/* required for strdup()  */

    58

    59

    60

/* declare the token parser generated by flex... */

    61

int yylex(void);

    62

    63

/* declare the error handler defined at the end of this file */

    64

void yyerror (const char *error_msg);

    65

    66

/* produce a more verbose parsing error message */

    67

#define YYERROR_VERBOSE

    68

    69

/* Include debuging code.

    70

 * Printing of debug info must then be activated by setting

    71

 * the variable yydebug to 1.

    72

 */

    73

#define YYDEBUG 0

    74

    75

    76

/* file with declaration of absyntax classes... */

    77

#include "../absyntax/absyntax.hh"

    78

    79

/* file with declaration of token constants. Generated by bison! */

    80

// #include "iec.y.hh"

    81

    82

/* The interface through which bison and flex interact. */

    83

#include "stage1_2_priv.hh"

    84

    85

    86

/* an ugly hack!!

    87

 * We will probably not need it when we decide

    88

 *  to cut down the abstract syntax down to size.

    89

 *  We keep it as it is until we get to write

    90

 *  stages 3 and 4 of the compiler. Who knows,

    91

 *  we might just find out that we really do need

    92

 *  the abstract syntax tree to stay as it is

    93

 *  afterall!

    94

 */

    95

/* for each element <elem> in list_c * <list>

    96

 * execute the code <code>

    97

 */

    98

#define FOR_EACH_ELEMENT(elem, list, code) {		\

    99

  symbol_c *elem;					\

   100

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

   101

    elem = list->elements[i];				\

   102

    code;						\

   103

  }							\

   104

}

   105

   106

   107

   108

/* Macros used to pass the line and column locations when

   109

 * creating a new object for the abstract syntax tree.

   110

 */

   111

#define locloc(foo) foo.first_line, foo.first_column, foo.last_line, foo.last_column

   112

#define   locf(foo) foo.first_line, foo.first_column

   113

#define   locl(foo) foo.last_line,  foo.last_column

   114

   115

   116

   117

/* A macro for printing out internal parser errors... */

   118

#define ERROR error_exit(__FILE__,__LINE__)

   119

/* function defined in main.cc */

   120

extern void error_exit(const char *file_name, int line_no);

   121

   122

   123

   124

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

   125

/* global variables...   */

   126

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

   127

/* NOTE: For some strange reason bison ver 2.3 is including these declarations

   128

 *       in the iec.y.hh file, which is in turn included by flex.

   129

 *       We cannot therefore define any variables over here, but merely declare 

   130

 *       their existance (otherwise we get errors when linking the code, since we

   131

 *       would get a new variable defined each time iec.y.hh is included!).

   132

 *       Even though the variables are declared 'extern' over here, they will in

   133

 *       fact be defined towards the end of this same file (i.e. in the prologue)

   134

 */

   135

   136

/* A global flag used to tell the parser if overloaded funtions should be allowed.

   137

 * The IEC 61131-3 standard allows overloaded funtions in the standard library,

   138

 * but disallows them in user code...

   139

 */

   140

extern bool allow_function_overloading;

   141

   142

/* A pointer to the root of the parsing tree that will be generated 

   143

 * by bison.

   144

 */

   145

extern symbol_c *tree_root;

   146

   147

   148

   149

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

   150

/* forward declarations */

   151

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

   152

/* The functions declared here are defined at the end of this file... */

   153

   154

/* Convert an il_operator_c into an identifier_c */

   155

symbol_c *il_operator_c_2_identifier_c(symbol_c *il_operator);

   156

   157

/* print an error message */

   158

void print_err_msg(const char *filename, int lineno, const char *additional_error_msg);

   159

   160

%}

   161

   162

   163

   164

   165

// %glr-parser

   166

// %expect-rr 1

   167

   168

   169

   170

   171

%union {

   172

    symbol_c 	*leaf;

   173

    list_c	*list;

   174

    char 	*ID;	/* token value */

   176

    struct {

   177

      symbol_c	*first;

   178

      symbol_c	*second;

   182

                                     il_simple_operator_clash_il_operand

   183

                             */

   184

}

   185

   186

/*

   187

 TODO: DO we need to define a destructor do free

   188

       memory when recovering from errors, or do the

   189

       class destructors already handle this?

   190

       Following is example on how to define

   191

       detructors, using the syntax:

   192

       %destructor { CODE } SYMBOLS

   193

%union

   194

      {

   195

        char *string;

   196

      }

   197

      %token <string> STRING

   198

      %type  <string> string

   199

      %destructor { free ($$); } STRING string

   200

*/

   201

   202

   203

   204

   205

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

   206

/* Prelimenary constructs... */

   207

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

   208

/* A token used to identify the very end of the input file

   209

 * after all includes have already been processed.

   210

 *

   211

 * Flex automatically returns the token with value 0

   212

 * at the end of the file. We therefore specify here

   213

 * a token with that exact same value here, so we can use it

   214

 * to detect the very end of the input files.

   215

 */

   216

%token END_OF_INPUT 0

   217

   218

/* A bogus token that, in principle, flex MUST NEVER generate */

   219

/* USE 1:

   220

 * ======

   221

 * This token is currently also being used as the default

   222

 * initialisation value of the token_id member in

   223

 * the symbol_c base class.

   224

 *

   225

 * USE 2

   226

 * =====

   227

 * This token may also be used in the future to remove

   228

 * mysterious reduce/reduce conflicts due to the fact

   229

 * that our grammar may not be LALR(1) but merely LR(1).

   230

 * This means that bison cannot handle it without some

   231

 * caoxing from ourselves. We will then need this token

   232

 * to do the coaxing...

   233

 */

   234

%token BOGUS_TOKEN_ID

   235

   236

   237

%type <leaf>	start

   238

   239

%type <leaf>	any_identifier

   240

   241

%token <ID>	prev_declared_variable_name_token

   242

%token <ID>	prev_declared_fb_name_token

   243

%type <leaf>	prev_declared_variable_name

   244

%type <leaf>	prev_declared_fb_name

   245

   246

%token  <ID>	prev_declared_simple_type_name_token

   247

%token  <ID>	prev_declared_subrange_type_name_token

   248

%token  <ID>	prev_declared_enumerated_type_name_token

   249

%token  <ID>	prev_declared_array_type_name_token

   250

%token  <ID>	prev_declared_structure_type_name_token

   251

%token  <ID>	prev_declared_string_type_name_token

   252

   253

%type  <leaf>	prev_declared_simple_type_name

   254

%type  <leaf>	prev_declared_subrange_type_name

   255

%type  <leaf>	prev_declared_enumerated_type_name

   256

%type  <leaf>	prev_declared_array_type_name

   257

%type  <leaf>	prev_declared_structure_type_name

   258

%type  <leaf>	prev_declared_string_type_name

   259

   260

%token <ID>	prev_declared_derived_function_name_token

   261

%token <ID>	prev_declared_derived_function_block_name_token

   262

%token <ID>	prev_declared_program_type_name_token

   263

%type  <leaf>	prev_declared_derived_function_name

   264

%type  <leaf>	prev_declared_derived_function_block_name

   265

%type  <leaf>	prev_declared_program_type_name

   266

   267

   268

   269

   270

/* The pragmas... */

   271

%token <ID>	pragma_token

   272

%type <leaf>	pragma

   273

   274

   275

/* Where do these tokens belong ?? */

   276

/* TODO: get the syntax parser to handle these tokens... */

   277

%token	EN

   278

%token	ENO

   279

   280

   281

   282

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

   283

/* B 0 - Programming Model */

   284

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

   285

%type <list>	library

   286

%type <leaf>	library_element_declaration

   287

   288

   289

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

   290

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

   291

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

   292

/* Done totally within flex...

   293

  letter

   294

  digit

   295

  octal_digit

   296

  hex_digit

   297

*/

   298

%token <ID>	identifier_token

   299

%type  <leaf>	identifier

   300

   301

   302

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

   303

/* B 1.2 - Constants */

   304

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

   305

%type <leaf>	constant

   306

/* a helper symbol for expression */

   307

%type  <leaf> non_negative_constant

   308

   309

   310

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

   311

/* B 1.2.1 - Numeric Literals */

   312

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

   313

/* Done totally within flex...

   314

  bit

   315

*/

   316

%type  <leaf> numeric_literal

   317

/* helper symbol for non_negative_constant */

   318

%type  <leaf> non_negative_numeric_literal

   319

%type  <leaf> integer_literal

   320

%type  <leaf> signed_integer

   321

/* a helper symbol for non_negative_constant */

   322

%type  <leaf> non_negative_signed_integer

   323

%token <ID>   integer_token

   324

%type  <leaf> integer

   325

%token <ID>   binary_integer_token

   326

%type  <leaf> binary_integer

   327

%token <ID>   octal_integer_token

   328

%type  <leaf> octal_integer

   329

%token <ID>   hex_integer_token

   330

%type  <leaf> hex_integer

   331

%token <ID>   real_token

   332

%type  <leaf> real

   333

%type  <leaf> signed_real

   334

/* helper symbol for non_negative_real_literal */

   335

%type  <leaf> non_negative_signed_real

   336

%type  <leaf> real_literal

   337

/* helper symbol for non_negative_numeric_literal */

   338

%type  <leaf> non_negative_real_literal

   339

// %type  <leaf> exponent

   340

%type  <leaf> bit_string_literal

   341

%type  <leaf> boolean_literal

   342

   343

%token FALSE

   344

%token TRUE

   345

   346

   347

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

   348

/* B 1.2.2 - Character Strings */

   349

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

   350

%token <ID>   single_byte_character_string_token

   351

%token <ID>   double_byte_character_string_token

   352

   353

%type  <leaf> character_string

   354

%type  <leaf> single_byte_character_string

   355

%type  <leaf> double_byte_character_string

   356

   357

   358

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

   359

/* B 1.2.3 - Time Literals */

   360

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

   361

%type  <leaf> time_literal

   362

   363

   364

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

   365

/* B 1.2.3.1 - Duration */

   366

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

   367

%type  <leaf>	duration

   368

%type  <leaf>	interval

   369

%type  <leaf>	days

   370

%type  <leaf>	fixed_point

   371

%type  <leaf>	hours

   372

%type  <leaf>	minutes

   373

%type  <leaf>	seconds

   374

%type  <leaf>	milliseconds

   375

   376

%type  <leaf>	integer_d

   377

%type  <leaf>	integer_h

   378

%type  <leaf>	integer_m

   379

%type  <leaf>	integer_s

   380

%type  <leaf>	integer_ms

   381

%type  <leaf>	fixed_point_d

   382

%type  <leaf>	fixed_point_h

   383

%type  <leaf>	fixed_point_m

   384

%type  <leaf>	fixed_point_s

   385

%type  <leaf>	fixed_point_ms

   386

   387

%token <ID>	fixed_point_token

   388

%token <ID>	fixed_point_d_token

   389

%token <ID>	integer_d_token

   390

%token <ID>	fixed_point_h_token

   391

%token <ID>	integer_h_token

   392

%token <ID>	fixed_point_m_token

   393

%token <ID>	integer_m_token

   394

%token <ID>	fixed_point_s_token

   395

%token <ID>	integer_s_token

   396

%token <ID>	fixed_point_ms_token

   397

%token <ID>	integer_ms_token

   398

   399

%token TIME

   400

%token T_SHARP

   401

   402

   403

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

   404

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

   405

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

   406

%type  <leaf>	time_of_day

   407

%type  <leaf>	daytime

   408

%type  <leaf>	day_hour

   409

%type  <leaf>	day_minute

   410

%type  <leaf>	day_second

   411

%type  <leaf>	date

   412

%type  <leaf>	date_literal

   413

%type  <leaf>	year

   414

%type  <leaf>	month

   415

%type  <leaf>	day

   416

%type  <leaf>	date_and_time

   417

   418

%token TIME_OF_DAY

   419

%token DATE

   420

%token D_SHARP

   421

%token DATE_AND_TIME

   422

   423

   424

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

   425

/* B 1.3 - Data Types */

   426

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

   427

/* Strangely, the following symbol does seem to be required! */

   428

// %type  <leaf> data_type_name

   429

%type  <leaf> non_generic_type_name

   430

   431

   432

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

   433

/* B 1.3.1 - Elementary Data Types */

   434

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

   435

/* NOTES:

   436

 *

   437

 *    - To make the definition of bit_string_literal more

   438

 *      concise, it is useful to use an extra non-terminal

   439

 *      symbol (i.e. a grouping or construct) that groups the

   440

 *      following elements (BYTE, WORD, DWORD, LWORD).

   441

 *      Note that the definition of bit_string_type_name

   442

 *      (according to the spec) includes the above elements

   443

 *      and an extra BOOL.

   444

 *      We could use an extra construct with the first four

   445

 *      elements to be used solely in the definition of

   446

 *      bit_string_literal, but with the objective of not

   447

 *      having to replicate the actions (if we ever need

   448

 *      to change them, they would need to be changed in both

   449

 *      bit_string_type_name and the extra grouping), we

   450

 *      have re-defined bit_string_type_name as only including

   451

 *      the first four elements.

   452

 *      In order to have our parser implement the specification

   453

 *      correctly we have augmented every occurence of

   454

 *      bit_string_type_name in other rules with the BOOL

   455

 *      token. Since bit_string_type_name only appears in

   456

 *      the rule for elementary_type_name, this does not

   457

 *      seem to be a big concession to make!

   458

 *

   459

 *    - We have added a helper symbol to concentrate the

   460

 *      instantiation of STRING and WSTRING into a single

   461

 *      location (elementary_string_type_name).

   462

 *      These two elements show up in several other rules,

   463

 *      but we want to create the equivalent abstract syntax

   464

 *      in a single location of this file, in order to make

   465

 *      possible future changes easier to edit...

   466

 */

   467

%type  <leaf>	elementary_type_name

   468

%type  <leaf>	numeric_type_name

   469

%type  <leaf>	integer_type_name

   470

%type  <leaf>	signed_integer_type_name

   471

%type  <leaf>	unsigned_integer_type_name

   472

%type  <leaf>	real_type_name

   473

%type  <leaf>	date_type_name

   474

%type  <leaf>	bit_string_type_name

   475

/* helper symbol to concentrate the instantiation

   476

 * of STRING and WSTRING into a single location

   477

 */

   478

%type  <leaf>	elementary_string_type_name

   479

   480

%token BYTE

   481

%token WORD

   482

%token DWORD

   483

%token LWORD

   484

   485

%token LREAL

   486

%token REAL

   487

   488

%token SINT

   489

%token INT

   490

%token DINT

   491

%token LINT

   492

   493

%token USINT

   494

%token UINT

   495

%token UDINT

   496

%token ULINT

   497

   498

%token WSTRING

   499

%token STRING

   500

%token BOOL

   501

   502

// %token TIME

   503

// %token DATE

   504

// %token DATE_AND_TIME

   505

%token DT

   506

// %token TIME_OF_DAY

   507

%token TOD

   508

   509

   510

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

   511

/* B 1.3.2 - Generic data types */

   512

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

   513

/* Strangely, the following symbol does seem to be required! */

   514

// %type  <leaf>	generic_type_name

   515

   516

/* The following tokens do not seem to be used either

   517

 * but we declare them so they become reserved words...

   518

 */

   519

%token ANY

   520