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

    54

/* Forward declaration of the visitor interface

    55

 * declared in the visitor.hh file

    56

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

    57

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

    58

 * to the abstract syntax classes defined here.

    59

 */

    60

class visitor_c; // forward declaration

    61

    62

    63

class symbol_c; // forward declaration

    64

    65

    66

/* The base class of all symbols */

    67

class symbol_c {

    68

    69

  public:

    70

    /*

    71

     * Line number for the purposes of error checking

    72

     */

    73

    int first_line;

    74

    int first_column;

    75

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

    76

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

    77

    int last_line;

    78

    int last_column;

    79

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

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

     */

    87

    symbol_c *datatype;

    88

    89

    double   *const_value_real;

    90

    int64_t  *const_value_integer;

    91

    uint64_t *const_value_uinteger;

    92

    bool     *const_value_bool;

    93

    94

    95

  public:

    96

    /* default constructor */

    97

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

    98

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

    99

            );

   100

   101

    /* default destructor */

   102

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

   103

    virtual ~symbol_c(void) {return;};

   104

   105

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

   106

};

   107

   108

   109

class token_c: public symbol_c {

   110

  public:

   111

    /* the value of the symbol. */

   112

    const char *value;

   113

   114

  public:

   115

    token_c(const char *value, 

   116

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

   117

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

   118

           );

   119

};

   120

   121

   122

 /* a list of symbols... */

   123

class list_c: public symbol_c {

   124

  public:

   125

    int n;

   126

    symbol_c **elements;

   127

   128

  public:

   129

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

   130

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

   131

          );

   132

   133

    list_c(symbol_c *elem, 

   134

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

   135

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

   136

          );

   137

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

   138

    virtual void add_element(symbol_c *elem);

   139

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

   140

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

   141

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

   142

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

   143

     /* remove element at position pos. */

   144

    virtual void remove_element(int pos = 0);

   145

};

   146

   147

   148

   149

   150

#define SYM_LIST(class_name_c, ...)												\

   151

class class_name_c:	public list_c {											\

   152

  public:														\

   153

    __VA_ARGS__														\

   154

  public:														\

   155

    class_name_c(													\

   156

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

   157

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

   158

    class_name_c(symbol_c *elem, 											\

   159

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

   160

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

   161

    virtual void *accept(visitor_c &visitor);										\

   162

};

   163

   164

   165

#define SYM_TOKEN(class_name_c, ...)												\

   166

class class_name_c: 	public token_c {										\

   167

  public:														\

   168

    __VA_ARGS__														\

   169

  public:														\

   170

    class_name_c(const char *value, 											\

   171

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

   172

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

   173

    virtual void *accept(visitor_c &visitor);										\

   174

};

   175

   176

   177

#define SYM_REF0(class_name_c, ...)												\

   178

class class_name_c: public symbol_c {											\

   179

  public:														\

   180

    __VA_ARGS__														\

   181

  public:														\

   182

    class_name_c(		 											\

   183

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

   184

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

   185

    virtual void *accept(visitor_c &visitor);										\

   186

};

   187

   188

   189

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

   190

class class_name_c: public symbol_c {											\

   191

  public:														\

   192

    symbol_c *ref1;													\

   193

    __VA_ARGS__														\

   194

  public:														\

   195

    class_name_c(symbol_c *ref1,											\

   196

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

   197

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

   198

    virtual void *accept(visitor_c &visitor);										\

   199

};

   200

   201

   202

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

   203

class class_name_c: public symbol_c {											\

   204

  public:														\

   205

    symbol_c *ref1;													\

   206

    symbol_c *ref2;													\

   207

    __VA_ARGS__														\

   208

  public:														\

   209

    class_name_c(symbol_c *ref1,											\

   210

		 symbol_c *ref2 = NULL,											\

   211

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

   212

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

   213

    virtual void *accept(visitor_c &visitor);										\

   214

};

   215

   216

   217

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

   218

class class_name_c: public symbol_c {											\

   219

  public:														\

   220

    symbol_c *ref1;													\

   221

    symbol_c *ref2;													\

   222

    symbol_c *ref3;													\

   223

    __VA_ARGS__														\

   224

  public:														\

   225

    class_name_c(symbol_c *ref1,											\

   226

		 symbol_c *ref2,											\

   227

		 symbol_c *ref3,											\

   228

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

   229

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

   230

    virtual void *accept(visitor_c &visitor);										\

   231

};

   232

   233

   234

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

   235

class class_name_c: public symbol_c {											\

   236

  public:														\

   237

    symbol_c *ref1;													\

   238

    symbol_c *ref2;													\

   239

    symbol_c *ref3;													\

   240

    symbol_c *ref4;													\

   241

    __VA_ARGS__														\

   242

  public:														\

   243

    class_name_c(symbol_c *ref1,											\

   244

		 symbol_c *ref2,											\

   245

		 symbol_c *ref3,											\

   246

		 symbol_c *ref4 = NULL,											\

   247

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

   248

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

   249

    virtual void *accept(visitor_c &visitor);										\

   250

};

   251

   252

   253

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

   254

class class_name_c: public symbol_c {											\

   255

  public:														\

   256

    symbol_c *ref1;													\

   257

    symbol_c *ref2;													\

   258

    symbol_c *ref3;													\

   259

    symbol_c *ref4;													\

   260

    symbol_c *ref5;													\

   261

    __VA_ARGS__														\

   262

  public:														\

   263

    class_name_c(symbol_c *ref1,											\

   264

		 symbol_c *ref2,											\

   265

		 symbol_c *ref3,											\

   266

		 symbol_c *ref4,											\

   267

		 symbol_c *ref5,											\

   268

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

   269

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

   270

    virtual void *accept(visitor_c &visitor);										\

   271

};

   272

   273

   274

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

   275

class class_name_c: public symbol_c {											\

   276

  public:														\

   277

    symbol_c *ref1;													\

   278

    symbol_c *ref2;													\

   279

    symbol_c *ref3;													\

   280

    symbol_c *ref4;													\

   281

    symbol_c *ref5;													\

   282

    symbol_c *ref6;													\

   283

    __VA_ARGS__														\

   284

  public:														\

   285

    class_name_c(symbol_c *ref1,											\

   286

		 symbol_c *ref2,											\

   287

		 symbol_c *ref3,											\

   288

		 symbol_c *ref4,											\

   289

		 symbol_c *ref5,											\

   290

		 symbol_c *ref6 = NULL,											\

   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

};

   295

   296

   297

#include "absyntax.def"

   298

   299

   300

   301

#undef SYM_LIST

   302

#undef SYM_TOKEN

   303

#undef SYM_REF0

   304

#undef SYM_REF1

   305

#undef SYM_REF2

   306

#undef SYM_REF3

   307

#undef SYM_REF4

   308

#undef SYM_REF5

   309

#undef SYM_REF6

   310

   311

#endif /*  _ABSYNTAX_HH */