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

    /*

    84

     * Line number for the purposes of error checking.

    85

     * Annotated (inserted) by stage1_2

    86

     */

    87

    int first_line;

    88

    int first_column;

    89

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

    90

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

    91

    int last_line;

    92

    int last_column;

    93

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

    94

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

    95

    96

    97

    /*

    98

     * Annotations produced during stage 3

    99

     */

   100

    /*** Data type analysis ***/

   101

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

   102

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

   103

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

   104

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

   105

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

   106

     */

   107

    symbol_c *datatype;

   108

   109

    /*** constant folding ***/

   110

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

   111

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

   112

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

   113

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

   114

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

   115

     * operation assuming each type.

   116

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

   117

     * having more than one entry filled in!

   118

     */

   119

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

   120

                   cs_const_value, /* const value is valid */

   121

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

   122

                 } const_status_t;

   123

   124

    typedef struct {

   125

        const_status_t status;

   126

        real64_t       value; 

   127

    } const_value_real64_t;

   128

    const_value_real64_t *const_value_real64; /* when NULL --> UNDEFINED */

   129

   130

    typedef struct {

   131

        const_status_t status;

   132

        int64_t        value; 

   133

    } const_value_int64_t;

   134

    const_value_int64_t *const_value_int64; /* when NULL --> UNDEFINED */

   135

   136

    typedef struct {

   137

        const_status_t status;

   138

        uint64_t       value; 

   139

    } const_value_uint64_t;

   140

    const_value_uint64_t *const_value_uint64; /* when NULL --> UNDEFINED */

   141

   142

    typedef struct {

   143

        const_status_t status;

   144

        bool           value; 

   145

    } const_value_bool_t;

   146

    const_value_bool_t *const_value_bool; /* when NULL --> UNDEFINED */

   147

   148

   149

  public:

   150

    /* default constructor */

   151

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

   152

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

   153

            );

   154

   155

    /* default destructor */

   156

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

   157

    virtual ~symbol_c(void) {return;};

   158

   159

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

   160

};

   161

   162

   163

class token_c: public symbol_c {

   164

  public:

   165

    /* the value of the symbol. */

   166

    const char *value;

   167

   168

  public:

   169

    token_c(const char *value, 

   170

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

   171

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

   172

           );

   173

};

   174

   175

   176

 /* a list of symbols... */

   177

class list_c: public symbol_c {

   178

  public:

   179

    int n;

   180

    symbol_c **elements;

   181

   182

  public:

   183

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

   184

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

   185

          );

   186

   187

    list_c(symbol_c *elem, 

   188

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

   189

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

   190

          );

   191

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

   192

    virtual void add_element(symbol_c *elem);

   193

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

   194

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

   195

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

   196

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

   197

     /* remove element at position pos. */

   198

    virtual void remove_element(int pos = 0);

   199

};

   200

   201

   202

   203

   204

#define SYM_LIST(class_name_c, ...)											\

   205

class class_name_c:	public list_c {											\

   206

  public:														\

   207

    __VA_ARGS__														\

   208

  public:														\

   209

    class_name_c(													\

   210

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

   211

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

   212

    class_name_c(symbol_c *elem, 											\

   213

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

   214

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

   215

    virtual void *accept(visitor_c &visitor);										\

   216

};

   217

   218

   219

#define SYM_TOKEN(class_name_c, ...)											\

   220

class class_name_c: 	public token_c {										\

   221

  public:														\

   222

    __VA_ARGS__														\

   223

  public:														\

   224

    class_name_c(const char *value, 											\

   225

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

   226

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

   227

    virtual void *accept(visitor_c &visitor);										\

   228

};

   229

   230

   231

#define SYM_REF0(class_name_c, ...)											\

   232

class class_name_c: public symbol_c {											\

   233

  public:														\

   234

    __VA_ARGS__														\

   235

  public:														\

   236

    class_name_c(		 											\

   237

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

   238

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

   239

    virtual void *accept(visitor_c &visitor);										\

   240

};

   241

   242

   243

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

   244

class class_name_c: public symbol_c {											\

   245

  public:														\

   246

    symbol_c *ref1;													\

   247

    __VA_ARGS__														\

   248

  public:														\

   249

    class_name_c(symbol_c *ref1,											\

   250

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

   251

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

   252

    virtual void *accept(visitor_c &visitor);										\

   253

};

   254

   255

   256

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

   257

class class_name_c: public symbol_c {											\

   258

  public:														\

   259

    symbol_c *ref1;													\

   260

    symbol_c *ref2;													\

   261

    __VA_ARGS__														\

   262

  public:														\

   263

    class_name_c(symbol_c *ref1,											\

   264

		 symbol_c *ref2 = NULL,											\

   265

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

   266

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

   267

    virtual void *accept(visitor_c &visitor);										\

   268

};

   269

   270

   271

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

   272

class class_name_c: public symbol_c {											\

   273

  public:														\

   274

    symbol_c *ref1;													\

   275

    symbol_c *ref2;													\

   276

    symbol_c *ref3;													\

   277

    __VA_ARGS__														\

   278

  public:														\

   279

    class_name_c(symbol_c *ref1,											\

   280

		 symbol_c *ref2,											\

   281

		 symbol_c *ref3,											\

   282

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

   283

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

   284

    virtual void *accept(visitor_c &visitor);										\

   285

};

   286

   287

   288

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

   289

class class_name_c: public symbol_c {											\

   290

  public:														\

   291

    symbol_c *ref1;													\

   292

    symbol_c *ref2;													\

   293

    symbol_c *ref3;													\

   294

    symbol_c *ref4;													\

   295

    __VA_ARGS__														\

   296

  public:														\

   297

    class_name_c(symbol_c *ref1,											\

   298

		 symbol_c *ref2,											\

   299

		 symbol_c *ref3,											\

   300

		 symbol_c *ref4 = NULL,											\

   301

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

   302

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

   303

    virtual void *accept(visitor_c &visitor);										\

   304

};

   305

   306

   307

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

   308

class class_name_c: public symbol_c {											\

   309

  public:														\

   310

    symbol_c *ref1;													\

   311

    symbol_c *ref2;													\

   312

    symbol_c *ref3;													\

   313

    symbol_c *ref4;													\

   314

    symbol_c *ref5;													\

   315

    __VA_ARGS__														\

   316

  public:														\

   317

    class_name_c(symbol_c *ref1,											\

   318

		 symbol_c *ref2,											\

   319

		 symbol_c *ref3,											\

   320

		 symbol_c *ref4,											\

   321

		 symbol_c *ref5,											\

   322

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

   323

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

   324

    virtual void *accept(visitor_c &visitor);										\

   325

};

   326

   327

   328

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

   329

class class_name_c: public symbol_c {											\

   330

  public:														\

   331

    symbol_c *ref1;													\

   332

    symbol_c *ref2;													\

   333

    symbol_c *ref3;													\

   334

    symbol_c *ref4;													\

   335

    symbol_c *ref5;													\

   336

    symbol_c *ref6;													\

   337

    __VA_ARGS__														\

   338

  public:														\

   339

    class_name_c(symbol_c *ref1,											\

   340

		 symbol_c *ref2,											\

   341

		 symbol_c *ref3,											\

   342

		 symbol_c *ref4,											\

   343

		 symbol_c *ref5,											\

   344

		 symbol_c *ref6 = NULL,											\

   345

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

   346

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

   347

    virtual void *accept(visitor_c &visitor);										\

   348

};

   349

   350

   351

#include "absyntax.def"

   352

   353

   354

   355

#undef SYM_LIST

   356

#undef SYM_TOKEN

   357

#undef SYM_REF0

   358

#undef SYM_REF1

   359

#undef SYM_REF2

   360

#undef SYM_REF3

   361

#undef SYM_REF4

   362

#undef SYM_REF5

   363

#undef SYM_REF6

   364

   365

#endif /*  _ABSYNTAX_HH */