1

/*

     2

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

     3

 *

     4

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

     5

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

     6

 *

     7

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

     8

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

     9

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

    10

 *  (at your option) any later version.

    11

 *

    12

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

    13

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

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

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

    18

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

    19

 *

    20

 *

    21

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

    22

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

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

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

    30

 *

    31

 */

    32

    33

/*

    34

 * Stage 2

    35

 * =======

    36

 *

    37

 *  This file contains the syntax definition of the textual

    38

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

    39

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

    40

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

    41

 */

    42

    43

    44

    45

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

    61

    62

    63

    64

%{

    65

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

    66

    67

    68

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

    69

int yylex(void);

    70

    71

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

    72

void yyerror (const char *error_msg);

    73

    74

/* produce a more verbose parsing error message */

    75

#define YYERROR_VERBOSE

    76

    77

/* Include debuging code.

    78

 * Printing of debug info must then be activated by setting

    79

 * the variable yydebug to 1.

    80

 */

    81

#define YYDEBUG 0

    82

    83

    84

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

    85

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

    86

    87

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

    88

#include "iec.y.hh"

    89

    90

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

    91

#include "stage1_2_priv.hh"

    92

    93

    94

#include "../absyntax_utils/add_en_eno_param_decl.hh"	/* required for  add_en_eno_param_decl_c */

    95

    96

/* an ugly hack!!

    97

 * We will probably not need it when we decide

    98

 *  to cut down the abstract syntax down to size.

    99

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

   100

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

   101

 *  we might just find out that we really do need

   102

 *  the abstract syntax tree to stay as it is

   103

 *  afterall!

   104

 */

   105

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

   106

 * execute the code <code>

   107

 */

   108

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

   109

  symbol_c *elem;					\

   110

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

   111

    elem = list->elements[i];				\

   112

    code;						\

   113

  }							\

   114

}

   115

   116

   117

   118

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

   119

 * creating a new object for the abstract syntax tree.

   120

 */

   121

#define locloc(foo) foo.first_line, foo.first_column, foo.first_file, foo.first_order, foo.last_line, foo.last_column, foo.last_file, foo.last_order

   122

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

   123

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

   124

   125

/* Redefine the default action to take for each rule, so that the filenames are correctly processed... */

   126

# define YYLLOC_DEFAULT(Current, Rhs, N)                                \

   127

         do                                                                  \

   128

           if (N)                                                            \

   129

             {                                                               \

   130

               (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;         \

   131

               (Current).first_column = YYRHSLOC(Rhs, 1).first_column;       \

   132

               (Current).first_file   = YYRHSLOC(Rhs, 1).first_file;         \

   133

               (Current).first_order  = YYRHSLOC(Rhs, 1).first_order;        \

   134

               (Current).last_line    = YYRHSLOC(Rhs, N).last_line;          \

   135

               (Current).last_column  = YYRHSLOC(Rhs, N).last_column;        \

   136

               (Current).last_file    = YYRHSLOC(Rhs, 1).last_file;          \

   137

               (Current).last_order   = YYRHSLOC(Rhs, 1).last_order;         \

   138

             }                                                               \

   139

           else                                                              \

   140

             {                                                               \

   141

               (Current).first_line   = (Current).last_line   =              \

   142

                 YYRHSLOC(Rhs, 0).last_line;                                 \

   143

               (Current).first_column = (Current).last_column =              \

   144

                 YYRHSLOC(Rhs, 0).last_column;                               \

   145

               (Current).first_file   = (Current).last_file   =              \

   146

                 YYRHSLOC(Rhs, 0).last_file;                                 \

   147

               (Current).first_order  = (Current).last_order  =              \

   148

                 YYRHSLOC(Rhs, 0).last_order;                                \

   149

             }                                                               \

   150

         while (0)

   151

   152

   153

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

   154

#define ERROR error_exit(__FILE__,__LINE__)

   155

/* function defined in main.cc */

   156

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

   157

   158

   159

   160

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

   161

/* global variables...   */

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

 */

   171

   172

   173

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

   174

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

   175

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

   176

 *       option is to use global variables! yuck!

   177

 */

   178

   179

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

   180

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

   181

 * but disallows them in user code...

   182

 */

   183

extern bool allow_function_overloading;

   184

   185

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

   186

 * when printing out error messages...

   187

 */

   188

extern bool full_token_loc;

   189

   190

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

   191

 * by bison.

   192

 */

   193

extern symbol_c *tree_root;

   194

   195

   196

   197

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

   198

/* forward declarations */

   199

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

   200

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

   201

   202

/* Convert an il_operator_c into an identifier_c */

   203

symbol_c *il_operator_c_2_identifier_c(symbol_c *il_operator);

   204

   205

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

   206

/* ERROR_CHECK_BEGIN */

   207

bool is_current_syntax_token();

   208

/* ERROR_CHECK_END */

   209

   210

/* print an error message */

   211

void print_err_msg(int first_line,

   212

                   int first_column,

   213

                   const char *first_filename,

   214

                   long int first_order,

   215

                   int last_line,

   216

                   int last_column,

   217

                   const char *last_filename,

   218

                   long int last_order,

   219

                   const char *additional_error_msg);

   220

%}

   221

   222

   223

   224

   225

// %glr-parser

   226

// %expect-rr 1

   227

   228

   229

/* The following definitions need to be inside a '%code requires' 

   230

 * so that they are also included in the header files. If this were not the case,

   231

 * YYLTYPE would be delcared as something in the iec.cc file, and another thing

   232

 * (actually the default value of YYLTYPE) in the iec.y.hh heder file.

   233

 */

   234

%code requires {

   235

/* define a new data type to store the locations, so we can also store

   236

 * the filename in which the token is expressed.

   237

 */

   238

/* NOTE: since this code will be placed in the iec.y.hh header file,

   239

 * as well as the iec.cc file that also includes the iec.y.hh header file,

   240

 * declaring the typedef struct yyltype__local here would result in a 

   241

 * compilation error when compiling iec.cc, as this struct would be

   242

 * declared twice.

   243

 * We therefore use the #if !defined YYLTYPE ...

   244

 * to make sure only the first declaration is parsed by the C++ compiler.

   245

 *

   246

 * At first glance it seems that what we really should do is delcare the

   247

 * YYLTYPE directly as an anonymous struct, thus:

   248

 * #define YYLTYPE struct{ ...}

   249

 * however, this also results in compilation errors.

   250

 *

   251

 * I (Mario) think this is kind of a hack. If you know how to

   252

 * do this re-declaration of YYLTYPE properly, please let me know!

   253

 */

   254

#if ! defined YYLTYPE && ! defined YYLTYPE_IS_DECLARED

   255

  typedef struct {

   256

    int         first_line;

   257

    int         first_column;

   258

    const char *first_file;

   259

    long int    first_order;

   260

    int         last_line;

   261

    int         last_column;

   262

    const char *last_file;

   263

    long int    last_order;

   264

  } yyltype__local;

   265

  #define YYLTYPE yyltype__local

   266

#endif

   267

}

   268

   269

   270

   271

%union {

   272

    symbol_c 	*leaf;

   273

    list_c	*list;

   274

    char 	*ID;	/* token value */

   275

}

   276

   277

/*

   278

 TODO: DO we need to define a destructor do free

   279

       memory when recovering from errors, or do the

   280

       class destructors already handle this?

   281

       Following is example on how to define

   282

       detructors, using the syntax:

   283

       %destructor { CODE } SYMBOLS

   284

%union

   285

      {

   286

        char *string;

   287

      }

   288

      %token <string> STRING

   289

      %type  <string> string

   290

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

   291

*/

   292

   293

   294

   295

   296

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

   297

/* Prelimenary helpful constructs... */

   298

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

   299

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

   300

 * after all includes have already been processed.

   301

 *

   302

 * Flex automatically returns the token with value 0

   303

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

   304

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

   305

 * to detect the very end of the input files.

   306

 */

   307

%token END_OF_INPUT 0

   308

   309

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

   310

/* USE 1:

   311

 * ======

   312

 * This token is currently also being used as the default

   313

 * initialisation value of the token_id member in

   314

 * the symbol_c base class.

   315

 *

   316

 * USE 2

   317

 * =====

   318

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

   319

 * mysterious reduce/reduce conflicts due to the fact

   320

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

   321

 * This means that bison cannot handle it without some

   322

 * caoxing from ourselves. We will then need this token

   323

 * to do the coaxing...

   324

 */

   325

%token BOGUS_TOKEN_ID

   326

   327

%type <leaf>	start

   328

   329

%type <leaf>	any_identifier

   330

   331

%token <ID>	prev_declared_variable_name_token

   332

%token <ID>	prev_declared_direct_variable_token

   333

%token <ID>	prev_declared_fb_name_token

   334

%type <leaf>	prev_declared_variable_name

   335

%type <leaf>	prev_declared_direct_variable

   336

%type <leaf>	prev_declared_fb_name

   337

   338

%token  <ID>	prev_declared_simple_type_name_token

   339

%token  <ID>	prev_declared_subrange_type_name_token

   340

%token  <ID>	prev_declared_enumerated_type_name_token

   341

%token  <ID>	prev_declared_array_type_name_token

   342

%token  <ID>	prev_declared_structure_type_name_token

   343

%token  <ID>	prev_declared_string_type_name_token

   344

   345

%type  <leaf>	prev_declared_simple_type_name

   346

%type  <leaf>	prev_declared_subrange_type_name

   347

%type  <leaf>	prev_declared_enumerated_type_name

   348

%type  <leaf>	prev_declared_array_type_name

   349

%type  <leaf>	prev_declared_structure_type_name

   350

%type  <leaf>	prev_declared_string_type_name

   351

   352

%token <ID>	prev_declared_derived_function_name_token

   353

%token <ID>	prev_declared_derived_function_block_name_token

   354

%token <ID>	prev_declared_program_type_name_token

   355

%type  <leaf>	prev_declared_derived_function_name

   356

%type  <leaf>	prev_declared_derived_function_block_name

   357

%type  <leaf>	prev_declared_program_type_name

   358

   359

   360

   361

   362

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

   363

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

   364

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

   365

   366

/* Pragmas that our compiler will accept.

   367

 * See the comment in iec.flex for why these pragmas exist. 

   368

 */

   369

%token          disable_code_generation_pragma_token

   370

%token          enable_code_generation_pragma_token

   371

%type <leaf>	disable_code_generation_pragma

   372

%type <leaf>	enable_code_generation_pragma

   373

   374

   375

/* All other pragmas that we do not support... */

   376

/* In most stage 4, the text inside the pragmas will simply be copied to the output file.

   377

 * This allows us to insert C code (if using stage 4 generating C code) 

   378

 * inside/interningled with the IEC 61131-3 code!

   379

 */

   380

%token <ID>	pragma_token

   381

%type <leaf>	pragma

   382

   383

/* The joining of all previous pragmas, i.e. any possible pragma */

   384

%type <leaf>	any_pragma

   385

   386

   387

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

   388

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

   389

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

   390

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

   391

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

   392

 *

   393

 * please read the comment above the definition of 'variable' in section B1.4 for details.

   394

 */

   395

%token	EN

   396

%token	ENO

   397

%type <leaf>	en_identifier

   398

%type <leaf>	eno_identifier

   399

   400

   401

   402

   403

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

   404

/* B 0 - Programming Model */

   405

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

   406

%type <list>	library

   407

%type <leaf>	library_element_declaration

   408

   409

   410

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

   411

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

   412

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

   413

/* Done totally within flex...

   414

  letter

   415

  digit

   416

  octal_digit

   417

  hex_digit

   418

*/

   419

%token <ID>	identifier_token

   420

%type  <leaf>	identifier

   421

   422

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

   423

/* B 1.2 - Constants */

   424

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

   425

%type <leaf>	constant

   426

%type <leaf>	non_negative_constant

   427

   428

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

   429

/* B 1.2.1 - Numeric Literals */

   430

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

   431

/* Done totally within flex...

   432

  bit

   433

*/

   434

%type  <leaf> numeric_literal

   435

%type  <leaf> integer_literal

   436

%type  <leaf> signed_integer

   437

%token <ID>   integer_token

   438

%type  <leaf> integer

   439

%token <ID>   binary_integer_token

   440

%type  <leaf> binary_integer

   441

%token <ID>   octal_integer_token

   442

%type  <leaf> octal_integer

   443

%token <ID>   hex_integer_token

   444

%type  <leaf> hex_integer

   445

%token <ID>   real_token

   446

%type  <leaf> real

   447

%type  <leaf> signed_real

   448

%type  <leaf> real_literal

   449

// %type  <leaf> exponent

   450

%type  <leaf> bit_string_literal

   451

%type  <leaf> boolean_literal

   452

   453

%token safeboolean_true_literal_token

   454

%token safeboolean_false_literal_token

   455

%token boolean_true_literal_token

   456

%token boolean_false_literal_token

   457

   458

%token FALSE

   459

%token TRUE

   460

   461

   462

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

   463

/* B 1.2.2 - Character Strings */

   464

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

   465

%token <ID>   single_byte_character_string_token

   466

%token <ID>   double_byte_character_string_token

   467

   468

%type  <leaf> character_string

   469

%type  <leaf> single_byte_character_string

   470

%type  <leaf> double_byte_character_string

   471

   472

   473

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

   474

/* B 1.2.3 - Time Literals */

   475

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

   476

%type  <leaf> time_literal

   477

   478

   479

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

   480

/* B 1.2.3.1 - Duration */

   481

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

   482

%type  <leaf>	duration

   483

%type  <leaf>	interval

   484

%type  <leaf>	days

   485

%type  <leaf>	fixed_point

   486

%type  <leaf>	hours

   487

%type  <leaf>	minutes

   488

%type  <leaf>	seconds

   489

%type  <leaf>	milliseconds

   490

   491

%type  <leaf>	integer_d

   492

%type  <leaf>	integer_h

   493

%type  <leaf>	integer_m

   494

%type  <leaf>	integer_s

   495

%type  <leaf>	integer_ms

   496

%type  <leaf>	fixed_point_d

   497

%type  <leaf>	fixed_point_h

   498

%type  <leaf>	fixed_point_m

   499

%type  <leaf>	fixed_point_s

   500

%type  <leaf>	fixed_point_ms

   501

   502

%token <ID>	fixed_point_token

   503

%token <ID>	fixed_point_d_token

   504

%token <ID>	integer_d_token

   505

%token <ID>	fixed_point_h_token

   506

%token <ID>	integer_h_token

   507