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, ST and SFC compiler.

    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

    30

 *  languages IL and ST, as well as the textual version of SFC.

    31

 *  The syntax parser, comprising the 2nd stage of the overall 

    32

 *  compiler, is generated by runing bison on this file.

    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

   137

/* NOTE: These variable are really parameters we would like the stage2__ function to pass

   138

 *       to the yyparse() function. However, the yyparse() function is created automatically

   139

 *       by bison, so we cannot add parameters to this function. The only other

   140

 *       option is to use global variables! yuck!

   141

 */

   142

   143

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

   144

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

   145

 * but disallows them in user code...

   146

 */

   147

extern bool allow_function_overloading;

   148

   149

/* A global flag used to tell the parser whether to include the full variable location

   150

 * when printing out error messages...

   151

 */

   152

extern bool full_token_loc;

   153

   154

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

   155

 * by bison.

   156

 */

   157

extern symbol_c *tree_root;

   158

   159

   160

   161

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

   162

/* forward declarations */

   163

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

   164

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

   165

   166

/* Convert an il_operator_c into an identifier_c */

   167

symbol_c *il_operator_c_2_identifier_c(symbol_c *il_operator);

   168

   169

/* return if current token is a syntax element */

   170

/* ERROR_CHECK_BEGIN */

   171

bool is_current_syntax_token();

   172

/* ERROR_CHECK_END */

   173

   174

/* print an error message */

   175

void print_err_msg(int first_line,

   176

                   int first_column,

   177

                   int last_line,

   178

                   int last_column,

   179

                   const char *additional_error_msg);

   180

%}

   181

   182

   183

   184

   185

// %glr-parser

   186

// %expect-rr 1

   187

   188

   189

   190

   191

%union {

   192

    symbol_c 	*leaf;

   193

    list_c	*list;

   194

    char 	*ID;	/* token value */

   195

}

   196

   197

/*

   198

 TODO: DO we need to define a destructor do free

   199

       memory when recovering from errors, or do the

   200

       class destructors already handle this?

   201

       Following is example on how to define

   202

       detructors, using the syntax:

   203

       %destructor { CODE } SYMBOLS

   204

%union

   205

      {

   206

        char *string;

   207

      }

   208

      %token <string> STRING

   209

      %type  <string> string

   210

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

   211

*/

   212

   213

   214

   215

   216

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

   217

/* Prelimenary helpful constructs... */

   218

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

   219

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

   220

 * after all includes have already been processed.

   221

 *

   222

 * Flex automatically returns the token with value 0

   223

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

   224

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

   225

 * to detect the very end of the input files.

   226

 */

   227

%token END_OF_INPUT 0

   228

   229

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

   230

/* USE 1:

   231

 * ======

   232

 * This token is currently also being used as the default

   233

 * initialisation value of the token_id member in

   234

 * the symbol_c base class.

   235

 *

   236

 * USE 2

   237

 * =====

   238

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

   239

 * mysterious reduce/reduce conflicts due to the fact

   240

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

   241

 * This means that bison cannot handle it without some

   242

 * caoxing from ourselves. We will then need this token

   243

 * to do the coaxing...

   244

 */

   245

%token BOGUS_TOKEN_ID

   246

   247

%type <leaf>	start

   248

   249

%type <leaf>	any_identifier

   250

   251

%token <ID>	prev_declared_variable_name_token

   252

%token <ID>	prev_declared_direct_variable_token

   253

%token <ID>	prev_declared_fb_name_token

   254

%type <leaf>	prev_declared_variable_name

   255

%type <leaf>	prev_declared_direct_variable

   256

%type <leaf>	prev_declared_fb_name

   257

   258

%token  <ID>	prev_declared_simple_type_name_token

   259

%token  <ID>	prev_declared_subrange_type_name_token

   260

%token  <ID>	prev_declared_enumerated_type_name_token

   261

%token  <ID>	prev_declared_array_type_name_token

   262

%token  <ID>	prev_declared_structure_type_name_token

   263

%token  <ID>	prev_declared_string_type_name_token

   264

   265

%type  <leaf>	prev_declared_simple_type_name

   266

%type  <leaf>	prev_declared_subrange_type_name

   267

%type  <leaf>	prev_declared_enumerated_type_name

   268

%type  <leaf>	prev_declared_array_type_name

   269

%type  <leaf>	prev_declared_structure_type_name

   270

%type  <leaf>	prev_declared_string_type_name

   271

   272

%token <ID>	prev_declared_derived_function_name_token

   273

%token <ID>	prev_declared_derived_function_block_name_token

   274

%token <ID>	prev_declared_program_type_name_token

   275

%type  <leaf>	prev_declared_derived_function_name

   276

%type  <leaf>	prev_declared_derived_function_block_name

   277

%type  <leaf>	prev_declared_program_type_name

   278

   279

   280

   281

   282

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

   283

/* B XXX - Things that are missing from the standard, but should have been there! */

   284

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

   285

   286

   287

/* The pragmas... */

   288

%token <ID>	pragma_token

   289

%type <leaf>	pragma

   290

   291

   292

/* Where do these tokens belong?? They are missing from the standard! */

   293

/* NOTE: There are other tokens related to these 'EN' ENO', that are also 

   294

 * missing from the standard. However, their location in the annex B is 

   295

 * relatively obvious, so they have been inserted in what seems to us their 

   296

 * correct place in order to ease understanding of the parser...

   297

 */

   298

%token	EN

   299

%token	ENO

   300

%type <leaf>	en_identifier

   301

%type <leaf>	eno_identifier

   302

   303

   304

   305

   306

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

   307

/* B 0 - Programming Model */

   308

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

   309

%type <list>	library

   310

%type <leaf>	library_element_declaration

   311

   312

   313

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

   314

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

   315

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

   316

/* Done totally within flex...

   317

  letter

   318

  digit

   319

  octal_digit

   320

  hex_digit

   321

*/

   322

%token <ID>	identifier_token

   323

%type  <leaf>	identifier

   324

   325

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

   326

/* B 1.2 - Constants */

   327

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

   328

%type <leaf>	constant

   330

   331

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

   332

/* B 1.2.1 - Numeric Literals */

   333

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

   334

/* Done totally within flex...

   335

  bit

   336

*/

   337

%type  <leaf> numeric_literal

   338

%type  <leaf> integer_literal

   339

%type  <leaf> signed_integer

   340

%token <ID>   integer_token

   341

%type  <leaf> integer

   342

%token <ID>   binary_integer_token

   343

%type  <leaf> binary_integer

   344

%token <ID>   octal_integer_token

   345

%type  <leaf> octal_integer

   346

%token <ID>   hex_integer_token

   347

%type  <leaf> hex_integer

   348

%token <ID>   real_token

   349

%type  <leaf> real

   350

%type  <leaf> signed_real

   351

%type  <leaf> real_literal

   352

// %type  <leaf> exponent

   353

%type  <leaf> bit_string_literal

   354

%type  <leaf> boolean_literal

   355

   361

%token FALSE

   362

%token TRUE

   363

   364

   365

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

   366

/* B 1.2.2 - Character Strings */

   367

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

   368

%token <ID>   single_byte_character_string_token

   369

%token <ID>   double_byte_character_string_token

   370

   371

%type  <leaf> character_string

   372

%type  <leaf> single_byte_character_string

   373

%type  <leaf> double_byte_character_string

   374

   375

   376

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

   377

/* B 1.2.3 - Time Literals */

   378

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

   379

%type  <leaf> time_literal

   380

   381

   382

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

   383

/* B 1.2.3.1 - Duration */

   384

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

   385

%type  <leaf>	duration

   386

%type  <leaf>	interval

   387

%type  <leaf>	days

   388

%type  <leaf>	fixed_point

   389

%type  <leaf>	hours

   390

%type  <leaf>	minutes

   391

%type  <leaf>	seconds

   392

%type  <leaf>	milliseconds

   393

   394

%type  <leaf>	integer_d

   395

%type  <leaf>	integer_h

   396

%type  <leaf>	integer_m

   397

%type  <leaf>	integer_s

   398

%type  <leaf>	integer_ms

   399

%type  <leaf>	fixed_point_d

   400

%type  <leaf>	fixed_point_h

   401

%type  <leaf>	fixed_point_m

   402

%type  <leaf>	fixed_point_s

   403

%type  <leaf>	fixed_point_ms

   404

   405

%token <ID>	fixed_point_token

   406

%token <ID>	fixed_point_d_token

   407

%token <ID>	integer_d_token

   408

%token <ID>	fixed_point_h_token

   409

%token <ID>	integer_h_token

   410

%token <ID>	fixed_point_m_token

   411

%token <ID>	integer_m_token

   412

%token <ID>	fixed_point_s_token

   413

%token <ID>	integer_s_token

   414

%token <ID>	fixed_point_ms_token

   415

%token <ID>	integer_ms_token

   416

   418

%token T_SHARP

   419

   420

   421

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

   422

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

   423

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

   424

%type  <leaf>	time_of_day

   425

%type  <leaf>	daytime

   426

%type  <leaf>	day_hour

   427

%type  <leaf>	day_minute

   428

%type  <leaf>	day_second

   429

%type  <leaf>	date

   430

%type  <leaf>	date_literal

   431

%type  <leaf>	year

   432

%type  <leaf>	month

   433

%type  <leaf>	day

   434

%type  <leaf>	date_and_time

   435

   438

%token D_SHARP

   440

   441

   442

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

   443

/* B 1.3 - Data Types */

   444

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

   445

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

   446

// %type  <leaf> data_type_name

   447

%type  <leaf> non_generic_type_name

   448

   449

   450

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

   451

/* B 1.3.1 - Elementary Data Types */

   452

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

   453

/* NOTES:

   454

 *

   455

 *    - To make the definition of bit_string_literal more

   456

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

   457

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

   458

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

   459

 *      Note that the definition of bit_string_type_name

   460

 *      (according to the spec) includes the above elements

   461

 *      and an extra BOOL.

   462

 *      We could use an extra construct with the first four

   463

 *      elements to be used solely in the definition of

   464

 *      bit_string_literal, but with the objective of not

   465

 *      having to replicate the actions (if we ever need

   466

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

   467

 *      bit_string_type_name and the extra grouping), we

   468

 *      have re-defined bit_string_type_name as only including

   469

 *      the first four elements.

   470

 *      In order to have our parser implement the specification

   471

 *      correctly we have augmented every occurence of

   472

 *      bit_string_type_name in other rules with the BOOL

   473

 *      token. Since bit_string_type_name only appears in

   474

 *      the rule for elementary_type_name, this does not

   475

 *      seem to be a big concession to make!

   476

 *

   477

 *    - We have added a helper symbol to concentrate the

   478

 *      instantiation of STRING and WSTRING into a single

   479

 *      location (elementary_string_type_name).

   480

 *      These two elements show up in several other rules,

   481

 *      but we want to create the equivalent abstract syntax

   482

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

   483

 *      possible future changes easier to edit...

   484

 */

   485

%type  <leaf>	elementary_type_name

   486

%type  <leaf>	numeric_type_name

   487

%type  <leaf>	integer_type_name

   488

%type  <leaf>	signed_integer_type_name

   489

%type  <leaf>	unsigned_integer_type_name

   490

%type  <leaf>	real_type_name

   491

%type  <leaf>	date_type_name

   492

%type  <leaf>	bit_string_type_name

   493

/* helper symbol to concentrate the instantiation

   494

 * of STRING and WSTRING into a single location

   495

 */

   496

%type  <leaf>	elementary_string_type_name

   497

   498

%token BYTE

   499

%token WORD

   500

%token DWORD

   501

%token LWORD

   502

   503

%token LREAL

   504

%token REAL

   505

   506

%token SINT

   507

%token INT

   508

%token DINT

   509

%token LINT

   510

   511

%token USINT

   512

%token UINT

   513

%token UDINT

   514

%token ULINT

   515