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

/* 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,

   159

                   int first_line,

   160

                   int first_column,

   161

                   int last_line,

   162

                   int last_column,

   163

                   const char *additional_error_msg);

   164

%}

   165

   166

   167

   168

   169

// %glr-parser

   170

// %expect-rr 1

   171

   172

   173

   174

   175

%union {

   176

    symbol_c 	*leaf;

   177

    list_c	*list;

   178

    char 	*ID;	/* token value */

   179

}

   180

   181

/*

   182

 TODO: DO we need to define a destructor do free

   183

       memory when recovering from errors, or do the

   184

       class destructors already handle this?

   185

       Following is example on how to define

   186

       detructors, using the syntax:

   187

       %destructor { CODE } SYMBOLS

   188

%union

   189

      {

   190

        char *string;

   191

      }

   192

      %token <string> STRING

   193

      %type  <string> string

   194

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

   195

*/

   196

   197

   198

   199

   200

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

   201

/* Prelimenary constructs... */

   202

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

   203

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

   204

 * after all includes have already been processed.

   205

 *

   206

 * Flex automatically returns the token with value 0

   207

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

   208

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

   209

 * to detect the very end of the input files.

   210

 */

   211

%token END_OF_INPUT 0

   212

   213

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

   214

/* USE 1:

   215

 * ======

   216

 * This token is currently also being used as the default

   217

 * initialisation value of the token_id member in

   218

 * the symbol_c base class.

   219

 *

   220

 * USE 2

   221

 * =====

   222

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

   223

 * mysterious reduce/reduce conflicts due to the fact

   224

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

   225

 * This means that bison cannot handle it without some

   226

 * caoxing from ourselves. We will then need this token

   227

 * to do the coaxing...

   228

 */

   229

%token BOGUS_TOKEN_ID

   230

   231

%type <leaf>	start

   232

   233

%type <leaf>	any_identifier

   234

   235

%token <ID>	prev_declared_variable_name_token

   236

%token <ID>	prev_declared_fb_name_token

   237

%type <leaf>	prev_declared_variable_name

   238

%type <leaf>	prev_declared_fb_name

   239

   240

%token  <ID>	prev_declared_simple_type_name_token

   241

%token  <ID>	prev_declared_subrange_type_name_token

   242

%token  <ID>	prev_declared_enumerated_type_name_token

   243

%token  <ID>	prev_declared_array_type_name_token

   244

%token  <ID>	prev_declared_structure_type_name_token

   245

%token  <ID>	prev_declared_string_type_name_token

   246

   247

%type  <leaf>	prev_declared_simple_type_name

   248

%type  <leaf>	prev_declared_subrange_type_name

   249

%type  <leaf>	prev_declared_enumerated_type_name

   250

%type  <leaf>	prev_declared_array_type_name

   251

%type  <leaf>	prev_declared_structure_type_name

   252

%type  <leaf>	prev_declared_string_type_name

   253

   254

%token <ID>	prev_declared_derived_function_name_token

   255

%token <ID>	prev_declared_derived_function_block_name_token

   256

%token <ID>	prev_declared_program_type_name_token

   257

%type  <leaf>	prev_declared_derived_function_name

   258

%type  <leaf>	prev_declared_derived_function_block_name

   259

%type  <leaf>	prev_declared_program_type_name

   260

   261

   262

   263

   264

/* The pragmas... */

   265

%token <ID>	pragma_token

   266

%type <leaf>	pragma

   267

   268

   269

/* Where do these tokens belong ?? */

   270

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

   271

%token	EN

   272

%token	ENO

   273

   274

   275

   276

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

   277

/* B 0 - Programming Model */

   278

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

   279

%type <list>	library

   280

%type <leaf>	library_element_declaration

   281

   282

   283

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

   284

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

   285

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

   286

/* Done totally within flex...

   287

  letter

   288

  digit

   289

  octal_digit

   290

  hex_digit

   291

*/

   292

%token <ID>	identifier_token

   293

%type  <leaf>	identifier

   294

   295

   296

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

   297

/* B 1.2 - Constants */

   298

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

   299

%type <leaf>	constant

   300

/* a helper symbol for expression */

   301

%type  <leaf> non_negative_constant

   302

   303

   304

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

   305

/* B 1.2.1 - Numeric Literals */

   306

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

   307

/* Done totally within flex...

   308

  bit

   309

*/

   310

%type  <leaf> numeric_literal

   311

/* helper symbol for non_negative_constant */

   312

%type  <leaf> non_negative_numeric_literal

   313

%type  <leaf> integer_literal

   314

%type  <leaf> signed_integer

   315

/* a helper symbol for non_negative_constant */

   316

%type  <leaf> non_negative_signed_integer

   317

%token <ID>   integer_token

   318

%type  <leaf> integer

   319

%token <ID>   binary_integer_token

   320

%type  <leaf> binary_integer

   321

%token <ID>   octal_integer_token

   322

%type  <leaf> octal_integer

   323

%token <ID>   hex_integer_token

   324

%type  <leaf> hex_integer

   325

%token <ID>   real_token

   326

%type  <leaf> real

   327

%type  <leaf> signed_real

   328

/* helper symbol for non_negative_real_literal */

   329

%type  <leaf> non_negative_signed_real

   330

%type  <leaf> real_literal

   331

/* helper symbol for non_negative_numeric_literal */

   332

%type  <leaf> non_negative_real_literal

   333

// %type  <leaf> exponent

   334

%type  <leaf> bit_string_literal

   335

%type  <leaf> boolean_literal

   336

   337

%token FALSE

   338

%token TRUE

   339

   340

   341

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

   342

/* B 1.2.2 - Character Strings */

   343

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

   344

%token <ID>   single_byte_character_string_token

   345

%token <ID>   double_byte_character_string_token

   346

   347

%type  <leaf> character_string

   348

%type  <leaf> single_byte_character_string

   349

%type  <leaf> double_byte_character_string

   350

   351

   352

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

   353

/* B 1.2.3 - Time Literals */

   354

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

   355

%type  <leaf> time_literal

   356

   357

   358

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

   359

/* B 1.2.3.1 - Duration */

   360

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

   361

%type  <leaf>	duration

   362

%type  <leaf>	interval

   363

%type  <leaf>	days

   364

%type  <leaf>	fixed_point

   365

%type  <leaf>	hours

   366

%type  <leaf>	minutes

   367

%type  <leaf>	seconds

   368

%type  <leaf>	milliseconds

   369

   370

%type  <leaf>	integer_d

   371

%type  <leaf>	integer_h

   372

%type  <leaf>	integer_m

   373

%type  <leaf>	integer_s

   374

%type  <leaf>	integer_ms

   375

%type  <leaf>	fixed_point_d

   376

%type  <leaf>	fixed_point_h

   377

%type  <leaf>	fixed_point_m

   378

%type  <leaf>	fixed_point_s

   379

%type  <leaf>	fixed_point_ms

   380

   381

%token <ID>	fixed_point_token

   382

%token <ID>	fixed_point_d_token

   383

%token <ID>	integer_d_token

   384

%token <ID>	fixed_point_h_token

   385

%token <ID>	integer_h_token

   386

%token <ID>	fixed_point_m_token

   387

%token <ID>	integer_m_token

   388

%token <ID>	fixed_point_s_token

   389

%token <ID>	integer_s_token

   390

%token <ID>	fixed_point_ms_token

   391

%token <ID>	integer_ms_token

   392

   393

%token TIME

   394

%token T_SHARP

   395

   396

   397

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

   398

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

   399

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

   400

%type  <leaf>	time_of_day

   401

%type  <leaf>	daytime

   402

%type  <leaf>	day_hour

   403

%type  <leaf>	day_minute

   404

%type  <leaf>	day_second

   405

%type  <leaf>	date

   406

%type  <leaf>	date_literal

   407

%type  <leaf>	year

   408

%type  <leaf>	month

   409

%type  <leaf>	day

   410

%type  <leaf>	date_and_time

   411

   412

%token TIME_OF_DAY

   413

%token DATE

   414

%token D_SHARP

   415

%token DATE_AND_TIME

   416

   417

   418

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

   419

/* B 1.3 - Data Types */

   420

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

   421

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

   422

// %type  <leaf> data_type_name

   423

%type  <leaf> non_generic_type_name

   424

   425

   426

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

   427

/* B 1.3.1 - Elementary Data Types */

   428

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

   429

/* NOTES:

   430

 *

   431

 *    - To make the definition of bit_string_literal more

   432

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

   433

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

   434

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

   435

 *      Note that the definition of bit_string_type_name

   436

 *      (according to the spec) includes the above elements

   437

 *      and an extra BOOL.

   438

 *      We could use an extra construct with the first four

   439

 *      elements to be used solely in the definition of

   440

 *      bit_string_literal, but with the objective of not

   441

 *      having to replicate the actions (if we ever need

   442

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

   443

 *      bit_string_type_name and the extra grouping), we

   444

 *      have re-defined bit_string_type_name as only including

   445

 *      the first four elements.

   446

 *      In order to have our parser implement the specification

   447

 *      correctly we have augmented every occurence of

   448

 *      bit_string_type_name in other rules with the BOOL

   449

 *      token. Since bit_string_type_name only appears in

   450

 *      the rule for elementary_type_name, this does not

   451

 *      seem to be a big concession to make!

   452

 *

   453

 *    - We have added a helper symbol to concentrate the

   454

 *      instantiation of STRING and WSTRING into a single

   455

 *      location (elementary_string_type_name).

   456

 *      These two elements show up in several other rules,

   457

 *      but we want to create the equivalent abstract syntax

   458

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

   459

 *      possible future changes easier to edit...

   460

 */

   461

%type  <leaf>	elementary_type_name

   462

%type  <leaf>	numeric_type_name

   463

%type  <leaf>	integer_type_name

   464

%type  <leaf>	signed_integer_type_name

   465

%type  <leaf>	unsigned_integer_type_name

   466

%type  <leaf>	real_type_name

   467

%type  <leaf>	date_type_name

   468

%type  <leaf>	bit_string_type_name

   469

/* helper symbol to concentrate the instantiation

   470

 * of STRING and WSTRING into a single location

   471

 */

   472

%type  <leaf>	elementary_string_type_name

   473

   474

%token BYTE

   475

%token WORD

   476

%token DWORD

   477

%token LWORD

   478

   479

%token LREAL

   480

%token REAL

   481

   482

%token SINT

   483

%token INT

   484

%token DINT

   485

%token LINT

   486

   487

%token USINT

   488

%token UINT

   489

%token UDINT

   490

%token ULINT

   491

   492

%token WSTRING

   493

%token STRING

   494

%token BOOL

   495

   496

// %token TIME

   497

// %token DATE

   498

// %token DATE_AND_TIME

   499

%token DT

   500

// %token TIME_OF_DAY

   501

%token TOD

   502

   503

   504

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

   505

/* B 1.3.2 - Generic data types */

   506

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

   507

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

   508

// %type  <leaf>	generic_type_name

   509

   510

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

   511

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

   512

 */

   513

%token ANY

   514

%token ANY_DERIVED

   515

%token ANY_ELEMENTARY

   516

%token ANY_MAGNITUDE

   517

%token ANY_NUM

   518

%token ANY_REAL

   519

%token ANY_INT

   520

%token ANY_BIT