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

/* NOTE: the following file contains many rules used merely for detecting errors in

    62

 * the IEC source code being parsed.

    63

 * To remove all these rules, simply execute the command (first replace all '%' with '/'):

    64

 * $sed '\:%\* ERROR_CHECK_BEGIN \*%:,\:%\* ERROR_CHECK_END \*%: d' iec_bison.yy

    65

 *

    66

 * The above command had to be edited ('/' replaced by '%') so as not to include the C syntax that closes

    67

 * comments inside this comment!

    68

 * If you place the command in a shell script, be sure to remove the backslashes '\' before each asterisk '*' !!

    69

 */

    70

    71

    72

    73

    74

    75

%{

    76

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

    77

    78

    79

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

    80

int yylex(void);

    81

    82

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

    83

void yyerror (const char *error_msg);

    84

    85

/* produce a more verbose parsing error message */

    86

#define YYERROR_VERBOSE

    87

    88

/* Include debuging code.

    89

 * Printing of debug info must then be activated by setting

    90

 * the variable yydebug to 1.

    91

 */

    92

#define YYDEBUG 0

    93

    94

    95

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

    96

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

    97

    98

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

    99

#include "iec_bison.hh"

   100

   101

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

   102

#include "stage1_2_priv.hh"

   103

#include "create_enumtype_conversion_functions.hh"

   104

   105

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

   106

   107

/* an ugly hack!!

   108

 * We will probably not need it when we decide

   109

 *  to cut down the abstract syntax down to size.

   110

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

   111

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

   112

 *  we might just find out that we really do need

   113

 *  the abstract syntax tree to stay as it is

   114

 *  afterall!

   115

 */

   116

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

   117

 * execute the code <code>

   118

 */

   119

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

   120

  symbol_c *elem;					\

   121

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

   122

    elem = list->elements[i];				\

   123

    code;						\

   124

  }							\

   125

}

   126

   127

   128

   129

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

   130

 * creating a new object for the abstract syntax tree.

   131

 */

   132

#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

   133

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

   134

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

   135

   136

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

   137

# define YYLLOC_DEFAULT(Current, Rhs, N)                                \

   138

         do                                                                  \

   139

           if (N)                                                            \

   140

             {                                                               \

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

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

   148

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

   149

             }                                                               \

   150

           else                                                              \

   151

             {                                                               \

   152

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

   153

                 YYRHSLOC(Rhs, 0).last_line;                                 \

   154

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

   155

                 YYRHSLOC(Rhs, 0).last_column;                               \

   156

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

   157

                 YYRHSLOC(Rhs, 0).last_file;                                 \

   158

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

   159

                 YYRHSLOC(Rhs, 0).last_order;                                \

   160

             }                                                               \

   161

         while (0)

   162

   163

   164

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

   165

   166

   167

   168

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

   169

/* global variables...   */

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

 */

   179

   180

   181

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

   182

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

   183

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

   184

 *       option is to use global variables! yuck!

   185

 */

   186

   187

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

   188

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

   189

 * but disallows them in user code...

   190

 */

   191

extern bool allow_function_overloading;

   192

   193

/* A flag to tell the compiler whether to allow the declaration

   194

 * of extensible function (i.e. functions that may have a variable number of

   195

 * input parameters, such as AND(word#33, word#44, word#55, word#66).

   196

 * This is an extension to the standard syntax.

   197

 * See comments below for details why we support this!

   198

 */

   199

extern bool allow_extensible_function_parameters;

   200

   201

/* A global flag used to tell the parser whether to include the full variable location when printing out error messages... */

   202

extern bool full_token_loc;

   203

   204

/* A global flag used to tell the parser whether to generate conversion function for enumerated data types. */

   205

extern bool conversion_functions;

   206

   207

/* A global flag used to tell the parser whether to allow use of DREF and '^' operators (defined in IEC 61131-3 v3) */

   208

extern bool allow_ref_dereferencing;

   209

   210

/* A global flag used to tell the parser whether to allow use of REF_TO ANY datatypes (non-standard extension to IEC 61131-3 v3) */

   211

extern bool allow_ref_to_any;

   212

   213

/* A global flag used to tell the parser whether to allow use of REF_TO as a struct or array element (non-standard extension) */

   214

extern bool allow_ref_to_in_derived_datatypes;

   215

   216

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

   217

extern symbol_c *tree_root;

   218

   219

   220

   221

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

   222

/* forward declarations */

   223

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

   224

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

   225

   226

/* Convert an il_operator_c into an identifier_c */

   231

   232

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

   233

/* ERROR_CHECK_BEGIN */

   234

bool is_current_syntax_token();

   235

/* ERROR_CHECK_END */

   236

   237

/* print an error message */

   238

void print_err_msg(int first_line,

   239

                   int first_column,

   240

                   const char *first_filename,

   241

                   long int first_order,

   242

                   int last_line,

   243

                   int last_column,

   244

                   const char *last_filename,

   245

                   long int last_order,

   246

                   const char *additional_error_msg);    

   247

%}

   248

   249

   250

   251

   252

// %glr-parser

   253

// %expect-rr 1

   254

   255

   256

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

   257

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

   258

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

   259

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

   260

 */

   261

%code requires {

   262

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

   263

 * the filename in which the token is expressed.

   264

 */

   265

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

   266

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

   267

 * declaring the typedef struct yyltype__local here would result in a 

   268

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

   269

 * declared twice.

   270

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

   271

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

   272

 */

   273

#if ! defined YYLTYPE && ! defined YYLTYPE_IS_DECLARED

   274

typedef struct YYLTYPE {

   275

    int         first_line;

   276

    int         first_column;

   277

    const char *first_file;

   278

    long int    first_order;

   279

    int         last_line;

   280

    int         last_column;

   281

    const char *last_file;

   282

    long int    last_order;

   283

} YYLTYPE;

   284

#define YYLTYPE_IS_DECLARED 1

   285

#define YYLTYPE_IS_TRIVIAL 0

   286

#endif

   287

   288

}

   289

   290

   291

   292

%union {

   293

    symbol_c 	*leaf;

   294

    list_c	*list;

   295

    char 	*ID;	/* token value */

   296

}

   297

   298

/*

   299

 TODO: DO we need to define a destructor do free

   300

       memory when recovering from errors, or do the

   301

       class destructors already handle this?

   302

       Following is example on how to define

   303

       detructors, using the syntax:

   304

       %destructor { CODE } SYMBOLS

   305

%union

   306

      {

   307

        char *string;

   308

      }

   309

      %token <string> STRING

   310

      %type  <string> string

   311

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

   312

*/

   313

   314

   315

   316

   317

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

   318

/* Prelimenary helpful constructs... */

   319

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

   320

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

   321

 * after all includes have already been processed.

   322

 *

   323

 * Flex automatically returns the token with value 0

   324

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

   325

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

   326

 * to detect the very end of the input files.

   327

 */

   328

%token END_OF_INPUT 0

   329

   330

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

   331

/* USE 1:

   332

 * ======

   333

 * This token is currently also being used as the default

   334

 * initialisation value of the token_id member in

   335

 * the symbol_c base class.

   336

 *

   337

 * USE 2

   338

 * =====

   339

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

   340

 * mysterious reduce/reduce conflicts due to the fact

   341

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

   342

 * This means that bison cannot handle it without some

   343

 * caoxing from ourselves. We will then need this token

   344

 * to do the coaxing...

   345

 */

   346

%token BOGUS_TOKEN_ID

   347

   348

%type <leaf>	start

   349

   350

%type <leaf>	any_identifier

   351

   352

%token <ID>	prev_declared_variable_name_token

   353

%token <ID>	prev_declared_direct_variable_token

   354

%token <ID>	prev_declared_fb_name_token

   355

%type <leaf>	prev_declared_variable_name

   356

%type <leaf>	prev_declared_direct_variable

   357

%type <leaf>	prev_declared_fb_name

   358

   359

%token  <ID>	prev_declared_simple_type_name_token

   360

%token  <ID>	prev_declared_subrange_type_name_token

   361

%token  <ID>	prev_declared_enumerated_type_name_token

   362

%token  <ID>	prev_declared_array_type_name_token

   363

%token  <ID>	prev_declared_structure_type_name_token

   364

%token  <ID>	prev_declared_string_type_name_token

   365

%token  <ID>	prev_declared_ref_type_name_token  /* defined in IEC 61131-3 v3 */

   366

   367

%type  <leaf>	prev_declared_simple_type_name

   368

%type  <leaf>	prev_declared_subrange_type_name

   369

%type  <leaf>	prev_declared_enumerated_type_name

   370

%type  <leaf>	prev_declared_array_type_name

   371

%type  <leaf>	prev_declared_structure_type_name

   372

%type  <leaf>	prev_declared_string_type_name

   373

%type  <leaf>	prev_declared_ref_type_name  /* defined in IEC 61131-3 v3 */

   374

   375

%token <ID>	prev_declared_derived_function_name_token

   376

%token <ID>	prev_declared_derived_function_block_name_token

   377

%token <ID>	prev_declared_program_type_name_token

   378

%type  <leaf>	prev_declared_derived_function_name

   379

%type  <leaf>	prev_declared_derived_function_block_name

   380

%type  <leaf>	prev_declared_program_type_name

   381

   382

   383

   384

   385

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

   386

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

   387

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

   388

   389

/* Pragmas that our compiler will accept.

   390

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

   391

 */

   392

%token          disable_code_generation_pragma_token

   393

%token          enable_code_generation_pragma_token

   394

%type <leaf>	disable_code_generation_pragma

   395

%type <leaf>	enable_code_generation_pragma

   396

   397

   398

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

   399

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

   400

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

   401

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

   402

 */

   403

%token <ID>	pragma_token

   404

%type <leaf>	pragma

   405

   406

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

   407

%type <leaf>	any_pragma

   408

   409

   410

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

   411

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

   412

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

   413

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

   414

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

   415

 *

   416

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

   417

 */

   418

%token	EN

   419

%token	ENO

   420

%type <leaf>	en_identifier

   421

%type <leaf>	eno_identifier

   422

   423

/* Keywords in IEC 61131-3 v3 */

   424

%token	REF

   425

%token	DREF

   426

%token	REF_TO

   427

%token	NULL_token  /* cannot use simply 'NULL', as it conflicts with the NULL keyword in C++ */

   428

   429

   430

   431

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

   432

/* B 0 - Programming Model */

   433

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

   434

%type <list>	library

   435

%type <leaf>	library_element_declaration

   436

   437

   438

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

   439

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

   440

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

   441

/* Done totally within flex...

   442

  letter

   443

  digit

   444

  octal_digit

   445

  hex_digit

   446

*/

   447

%token <ID>	identifier_token

   448

%type  <leaf>	identifier

   449

   450

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

   451

/* B 1.2 - Constants */

   452

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

   453

%type <leaf>	constant

   454

%type <leaf>	non_int_or_real_constant

   455

   456

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

   457

/* B 1.2.XX - Reference Literals */

   458

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

   459

/* NOTE: The following syntax was added by MJS in order to add support for the NULL keyword, defined in  IEC 61131-3 v3

   460

 *       In v3 expressions that reduce to a reference datatype (REF_TO) are handled explicitly in the syntax 

   461

 *       (e.g., any variable that is a of reference datatpe falls under the 'ref_name' rule), which means 

   462

 *       that we would need to keep track of which variables are declared as REF_TO. 

   463

 *       In order to reduce the changes to the current IEC 61131-3 v2 syntax, I have opted not to do this,

   464

 *       and simply let the ref_expressions (Ref_Assign, Ref_Compare) be interpreted as all other standard expressions 

   465

 *       in v2. However, ref_expressions allow the use of the 'NULL' constant, which is handled explicitly

   466

 *       in the ref_expressions syntax of v3.

   467

 *       To allow the use of the 'NULL' constant in this extended v2, I have opted to interpret this 'NULL' constant 

   468

 *       as a literal.

   469

 */

   470

%type  <leaf>	ref_value_null_literal  /* defined in IEC 61131-3 v3 - Basically the 'NULL' keyword! */

   471

   472

   473

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

   474

/* B 1.2.1 - Numeric Literals */

   475

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

   476

/* Done totally within flex...

   477

  bit

   478

*/

   479

%type  <leaf> numeric_literal

   480

%type  <leaf> integer_literal

   481

%type  <leaf> signed_integer

   482

%token <ID>   integer_token

   483

%type  <leaf> integer

   484

%token <ID>   binary_integer_token

   485

%type  <leaf> binary_integer

   486

%token <ID>   octal_integer_token

   487

%type  <leaf> octal_integer

   488

%token <ID>   hex_integer_token

   489

%type  <leaf> hex_integer

   490

%token <ID>   real_token

   491

%type  <leaf> real

   492

%type  <leaf> signed_real

   493

%type  <leaf> real_literal

   494

// %type  <leaf> exponent

   495

%type  <leaf> bit_string_literal

   496

%type  <leaf> boolean_literal

   497

   498

%token safeboolean_true_literal_token

   499

%token safeboolean_false_literal_token

   500

%token boolean_true_literal_token

   501

%token boolean_false_literal_token