1

/*

     2

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

     3

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

     4

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

     5

 *

     6

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

     7

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

     8

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

     9

 *  (at your option) any later version.

    10

 *

    11

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

    12

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

    13

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

 *  GNU General Public License for more details.

    15

 *

    16

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

    17

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

    18

 *

    19

 *

    20

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

    21

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

    22

 */

    23

    24

/*

    25

 * An IEC 61131-3 compiler.

    26

 *

    27

 * Based on the

    28

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

    29

 *

    30

 */

    31

    32

/*

    33

 * Declaration of the Abstract Syntax data structure components

    34

 */

    35

    36

/*

    37

 * ABSYNTAX.H

    38

 *

    39

 * This generates the parse tree structure used to bind the components

    40

 * identified by Bison in the correct syntax order. At the end of the

    41

 * Bison analysis the tree is walked in a sequential fashion generating

    42

 * the relavent code.

    43

 */

    44

    45

#ifndef _ABSYNTAX_HH

    46

#define _ABSYNTAX_HH

    47

    48

    49

#include <stdio.h> // required for NULL

    50

#include <vector>

    51

#include <string>

    52

#include <stdint.h>  // required for uint64_t, etc...

    53

#include "../main.hh" // required for uint8_t, real_64_t, ..., and the macros INT8_MAX, REAL32_MAX, ... */

    54

    55

    56

    57

    58

/* Forward declaration of the visitor interface

    59

 * declared in the visitor.hh file

    60

 * We cannot include the visitor.hh file, as it will

    61

 * include this same file first, as it too requires references

    62

 * to the abstract syntax classes defined here.

    63

 */

    64

class visitor_c; // forward declaration

    65

    66

    67

class symbol_c; // forward declaration

    68

    69

    70

    71

    72

    73

    74

    75

    76

    77

    78

    79

/* The base class of all symbols */

    80

class symbol_c {

    81

    82

  public:

    83

    /* WARNING: only use this method for debugging purposes!! */

    84

    virtual const char *absyntax_cname(void) {return "symbol_c";};

    85

    86

    /*

    87

     * Line number for the purposes of error checking.

    88

     * Annotated (inserted) by stage1_2

    89

     */

    90

    int first_line;

    91

    int first_column;

    92

    const char *first_file;  /* filename referenced by first line/column */

    93

    long int first_order;    /* relative order in which it is read by lexcial analyser */

    94

    int last_line;

    95

    int last_column;

    96

    const char *last_file;  /* filename referenced by last line/column */

    97

    long int last_order;    /* relative order in which it is read by lexcial analyser */

    98

    99

   100

    /*

   101

     * Annotations produced during stage 3

   102

     */

   103

    /*** Data type analysis ***/

   104

    std::vector <symbol_c *> candidate_datatypes; /* All possible data types the expression/literal/etc. may take. Filled in stage3 by fill_candidate_datatypes_c class */

   105

    /* Data type of the expression/literal/etc. Filled in stage3 by narrow_candidate_datatypes_c 

   106

     * If set to NULL, it means it has not yet been evaluated.

   107

     * If it points to an object of type invalid_type_name_c, it means it is invalid.

   108

     * Otherwise, it points to an object of the apropriate data type (e.g. int_type_name_c, bool_type_name_c, ...)

   109

     */

   110

    symbol_c *datatype;

   111

   112

    /*** constant folding ***/

   113

    /* During stage 3 (semantic analysis/checking) we will be doing constant folding.

   114

     * That algorithm will anotate the abstract syntax tree with the result of operations

   115

     * on literals (i.e. 44 + 55 will store the result 99).

   116

     * Since the same source code (e.g. 1 + 0) may actually be a BOOL or an ANY_INT,

   117

     * or an ANY_BIT, we need to handle all possibilities, and determine the result of the

   118

     * operation assuming each type.

   119

     * For this reason, we have one entry for each possible type, with some expressions

   120

     * having more than one entry filled in!

   121

     */

   122

    typedef enum { cs_undefined,   /* not defined/not yet evaluated --> const_value is not valid! */

   123

                   cs_non_const,   /* we have deternmined that expression is not a const value --> const_value is not valid! */

   124

                   cs_const_value, /* const value is valid */

   125

                   cs_overflow     /* result produced overflow or underflow --> const_value is not valid! */

   126

                 } const_status_t;

   127

   128

    typedef struct {const_status_t status;  real64_t  value; } const_value_real64_t;

   129

    typedef struct {const_status_t status;   int64_t  value; } const_value_int64_t;

   130

    typedef struct {const_status_t status;  uint64_t  value; } const_value_uint64_t;

   131

    typedef struct {const_status_t status;      bool  value; } const_value_bool_t;

   132

   133

    typedef struct {

   134

      const_value_real64_t _real64; /* status is initialised to UNDEFINED */

   135

      const_value_int64_t   _int64; /* status is initialised to UNDEFINED */

   136

      const_value_uint64_t _uint64; /* status is initialised to UNDEFINED */

   137

      const_value_bool_t     _bool; /* status is initialised to UNDEFINED */

   138

    } const_value_t;

   139

    const_value_t const_value;

   140

   141

   142

  public:

   143

    /* default constructor */

   144

    symbol_c(int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   145

             int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   146

            );

   147

   148

    /* default destructor */

   149

    /* must be virtual so compiler does not complain... */ 

   150

    virtual ~symbol_c(void) {return;};

   151

   152

    virtual void *accept(visitor_c &visitor) {return NULL;};

   153

};

   154

   155

   156

class token_c: public symbol_c {

   157

  public:

   158

    /* WARNING: only use this method for debugging purposes!! */

   159

    virtual const char *absyntax_cname(void) {return "token_c";};

   160

   161

    /* the value of the symbol. */

   162

    const char *value;

   163

   164

  public:

   165

    token_c(const char *value, 

   166

            int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   167

            int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   168

           );

   169

};

   170

   171

   172

 /* a list of symbols... */

   173

class list_c: public symbol_c {

   174

  public:

   175

    /* WARNING: only use this method for debugging purposes!! */

   176

    virtual const char *absyntax_cname(void) {return "list_c";};

   177

   178

    int c,n; /* c: current capacity of list (malloc'd memory);  n: current number of elements in list */

   179

    symbol_c **elements;

   180

   181

  public:

   182

    list_c(int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   183

           int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   184

          );

   185

   186

    list_c(symbol_c *elem, 

   187

           int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0, /* order in which it is read by lexcial analyser */

   188

           int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0  /* order in which it is read by lexcial analyser */

   189

          );

   190

     /* append a new element to the end of the list */

   191

    virtual void add_element(symbol_c *elem);

   192

     /* insert a new element before position pos. */

   193

     /* To insert into the begining of list, call with pos=0  */

   194

     /* To insert into the end of list, call with pos=list->n */

   195

    virtual void insert_element(symbol_c *elem, int pos = 0);

   196

     /* remove element at position pos. */

   197

    virtual void remove_element(int pos = 0);

   198

};

   199

   200

   201

   202

   203

#define SYM_LIST(class_name_c, ...)											\

   204

class class_name_c:	public list_c {											\

   205

  public:														\

   206

    __VA_ARGS__														\

   207

  public:														\

   208

    class_name_c(													\

   209

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   210

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   211

    class_name_c(symbol_c *elem, 											\

   212

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   213

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   214

    virtual void *accept(visitor_c &visitor);										\

   215

    /* WARNING: only use this method for debugging purposes!! */							\

   216

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   217

};

   218

   219

   220

#define SYM_TOKEN(class_name_c, ...)											\

   221

class class_name_c: 	public token_c {										\

   222

  public:														\

   223

    __VA_ARGS__														\

   224

  public:														\

   225

    class_name_c(const char *value, 											\

   226

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   227

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   228

    virtual void *accept(visitor_c &visitor);										\

   229

    /* WARNING: only use this method for debugging purposes!! */							\

   230

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   231

};

   232

   233

   234

#define SYM_REF0(class_name_c, ...)											\

   235

class class_name_c: public symbol_c {											\

   236

  public:														\

   237

    __VA_ARGS__														\

   238

  public:														\

   239

    class_name_c(		 											\

   240

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   241

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   242

    virtual void *accept(visitor_c &visitor);										\

   243

    /* WARNING: only use this method for debugging purposes!! */							\

   244

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   245

};

   246

   247

   248

#define SYM_REF1(class_name_c, ref1, ...)										\

   249

class class_name_c: public symbol_c {											\

   250

  public:														\

   251

    symbol_c *ref1;													\

   252

    __VA_ARGS__														\

   253

  public:														\

   254

    class_name_c(symbol_c *ref1,											\

   255

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   256

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   257

    virtual void *accept(visitor_c &visitor);										\

   258

    /* WARNING: only use this method for debugging purposes!! */							\

   259

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   260

};

   261

   262

   263

#define SYM_REF2(class_name_c, ref1, ref2, ...)										\

   264

class class_name_c: public symbol_c {											\

   265

  public:														\

   266

    symbol_c *ref1;													\

   267

    symbol_c *ref2;													\

   268

    __VA_ARGS__														\

   269

  public:														\

   270

    class_name_c(symbol_c *ref1,											\

   271

		 symbol_c *ref2 = NULL,											\

   272

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   273

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   274

    virtual void *accept(visitor_c &visitor);										\

   275

    /* WARNING: only use this method for debugging purposes!! */							\

   276

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   277

};

   278

   279

   280

#define SYM_REF3(class_name_c, ref1, ref2, ref3, ...)									\

   281

class class_name_c: public symbol_c {											\

   282

  public:														\

   283

    symbol_c *ref1;													\

   284

    symbol_c *ref2;													\

   285

    symbol_c *ref3;													\

   286

    __VA_ARGS__														\

   287

  public:														\

   288

    class_name_c(symbol_c *ref1,											\

   289

		 symbol_c *ref2,											\

   290

		 symbol_c *ref3,											\

   291

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   292

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   293

    virtual void *accept(visitor_c &visitor);										\

   294

    /* WARNING: only use this method for debugging purposes!! */							\

   295

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   296

};

   297

   298

   299

#define SYM_REF4(class_name_c, ref1, ref2, ref3, ref4, ...)								\

   300

class class_name_c: public symbol_c {											\

   301

  public:														\

   302

    symbol_c *ref1;													\

   303

    symbol_c *ref2;													\

   304

    symbol_c *ref3;													\

   305

    symbol_c *ref4;													\

   306

    __VA_ARGS__														\

   307

  public:														\

   308

    class_name_c(symbol_c *ref1,											\

   309

		 symbol_c *ref2,											\

   310

		 symbol_c *ref3,											\

   311

		 symbol_c *ref4 = NULL,											\

   312

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   313

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   314

    virtual void *accept(visitor_c &visitor);										\

   315

    /* WARNING: only use this method for debugging purposes!! */							\

   316

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   317

};

   318

   319

   320

#define SYM_REF5(class_name_c, ref1, ref2, ref3, ref4, ref5, ...)							\

   321

class class_name_c: public symbol_c {											\

   322

  public:														\

   323

    symbol_c *ref1;													\

   324

    symbol_c *ref2;													\

   325

    symbol_c *ref3;													\

   326

    symbol_c *ref4;													\

   327

    symbol_c *ref5;													\

   328

    __VA_ARGS__														\

   329

  public:														\

   330

    class_name_c(symbol_c *ref1,											\

   331

		 symbol_c *ref2,											\

   332

		 symbol_c *ref3,											\

   333

		 symbol_c *ref4,											\

   334

		 symbol_c *ref5,											\

   335

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   336

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   337

    virtual void *accept(visitor_c &visitor);										\

   338

    /* WARNING: only use this method for debugging purposes!! */							\

   339

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   340

};

   341

   342

   343

#define SYM_REF6(class_name_c, ref1, ref2, ref3, ref4, ref5, ref6, ...)							\

   344

class class_name_c: public symbol_c {											\

   345

  public:														\

   346

    symbol_c *ref1;													\

   347

    symbol_c *ref2;													\

   348

    symbol_c *ref3;													\

   349

    symbol_c *ref4;													\

   350

    symbol_c *ref5;													\

   351

    symbol_c *ref6;													\

   352

    __VA_ARGS__														\

   353

  public:														\

   354

    class_name_c(symbol_c *ref1,											\

   355

		 symbol_c *ref2,											\

   356

		 symbol_c *ref3,											\

   357

		 symbol_c *ref4,											\

   358

		 symbol_c *ref5,											\

   359

		 symbol_c *ref6 = NULL,											\

   360

                 int fl = 0, int fc = 0, const char *ffile = NULL /* filename */, long int forder=0,			\

   361

                 int ll = 0, int lc = 0, const char *lfile = NULL /* filename */, long int lorder=0);			\

   362

    virtual void *accept(visitor_c &visitor);										\

   363

    /* WARNING: only use this method for debugging purposes!! */							\

   364

    virtual const char *absyntax_cname(void) {return #class_name_c;};							\

   365

};

   366

   367

   368

#include "absyntax.def"

   369

   370

   371

   372

#undef SYM_LIST

   373

#undef SYM_TOKEN

   374

#undef SYM_REF0

   375

#undef SYM_REF1

   376

#undef SYM_REF2

   377

#undef SYM_REF3

   378

#undef SYM_REF4

   379

#undef SYM_REF5

   380

#undef SYM_REF6

   381

   382

#endif /*  _ABSYNTAX_HH */