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

    70

/* Forward declaration of the visitor interface

    71

 * declared in the visitor.hh file

    72

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

    73

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

    74

 * to the abstract syntax classes defined here.

    75

 */

    76

class visitor_c; // forward declaration

    77

    78

    79

class symbol_c; // forward declaration

    80

    81

    82

/* The base class of all symbols */

    83

class symbol_c {

    84

    85

  public:

    86

    /*

    87

     * Line number for the purposes of error checking

    88

     */

    89

    int first_line;

    90

    int first_column;

    91

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

    92

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

    93

    int last_line;

    94

    int last_column;

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

     */

   103

    symbol_c *datatype;

   104

   106

    int64_t  *const_value_integer;

   107

    uint64_t *const_value_uinteger;

   108

    bool     *const_value_bool;

   109

   110

   111

  public:

   112

    /* default constructor */

   113

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

   114

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

   115

            );

   116

   117

    /* default destructor */

   118

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

   119

    virtual ~symbol_c(void) {return;};

   120

   121

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

   122

};

   123

   124

   125

class token_c: public symbol_c {

   126

  public:

   127

    /* the value of the symbol. */

   128

    const char *value;

   129

   130

  public:

   131

    token_c(const char *value, 

   132

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

   133

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

   134

           );

   135

};

   136

   137

   138

 /* a list of symbols... */

   139

class list_c: public symbol_c {

   140

  public:

   141

    int n;

   142

    symbol_c **elements;

   143

   144

  public:

   145

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

   146

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

   147

          );

   148

   149

    list_c(symbol_c *elem, 

   150

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

   151

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

   152

          );

   153

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

   154

    virtual void add_element(symbol_c *elem);

   155

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

   156

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

   157

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

   158

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

   159

     /* remove element at position pos. */

   160

    virtual void remove_element(int pos = 0);

   161

};

   162

   163

   164

   165

   167

class class_name_c:	public list_c {											\

   168

  public:														\

   169

    __VA_ARGS__														\

   170

  public:														\

   171

    class_name_c(													\

   172

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

   173

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

   174

    class_name_c(symbol_c *elem, 											\

   175

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

   176

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

   177

    virtual void *accept(visitor_c &visitor);										\

   178

};

   179

   180

   182

class class_name_c: 	public token_c {										\

   183

  public:														\

   184

    __VA_ARGS__														\

   185

  public:														\

   186

    class_name_c(const char *value, 											\

   187

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

   188

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

   189

    virtual void *accept(visitor_c &visitor);										\

   190

};

   191

   192

   194

class class_name_c: public symbol_c {											\

   195

  public:														\

   196

    __VA_ARGS__														\

   197

  public:														\

   198

    class_name_c(		 											\

   199

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

   200

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

   201

    virtual void *accept(visitor_c &visitor);										\

   202

};

   203

   204

   205

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

   206

class class_name_c: public symbol_c {											\

   207

  public:														\

   208

    symbol_c *ref1;													\

   209

    __VA_ARGS__														\

   210

  public:														\

   211

    class_name_c(symbol_c *ref1,											\

   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

};

   216

   217

   218

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

   219

class class_name_c: public symbol_c {											\

   220

  public:														\

   221

    symbol_c *ref1;													\

   222

    symbol_c *ref2;													\

   223

    __VA_ARGS__														\

   224

  public:														\

   225

    class_name_c(symbol_c *ref1,											\

   226

		 symbol_c *ref2 = NULL,											\

   227

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

   228

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

   229

    virtual void *accept(visitor_c &visitor);										\

   230

};

   231

   232

   233

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

   234

class class_name_c: public symbol_c {											\

   235

  public:														\

   236

    symbol_c *ref1;													\

   237

    symbol_c *ref2;													\

   238

    symbol_c *ref3;													\

   239

    __VA_ARGS__														\

   240

  public:														\

   241

    class_name_c(symbol_c *ref1,											\

   242

		 symbol_c *ref2,											\

   243

		 symbol_c *ref3,											\

   244

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

   245

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

   246

    virtual void *accept(visitor_c &visitor);										\

   247

};

   248

   249

   250

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

   251

class class_name_c: public symbol_c {											\

   252

  public:														\

   253

    symbol_c *ref1;													\

   254

    symbol_c *ref2;													\

   255

    symbol_c *ref3;													\

   256

    symbol_c *ref4;													\

   257

    __VA_ARGS__														\

   258

  public:														\

   259

    class_name_c(symbol_c *ref1,											\

   260

		 symbol_c *ref2,											\

   261

		 symbol_c *ref3,											\

   262

		 symbol_c *ref4 = NULL,											\

   263

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

   264

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

   265

    virtual void *accept(visitor_c &visitor);										\

   266

};

   267

   268

   270

class class_name_c: public symbol_c {											\

   271

  public:														\

   272

    symbol_c *ref1;													\

   273

    symbol_c *ref2;													\

   274

    symbol_c *ref3;													\

   275

    symbol_c *ref4;													\

   276

    symbol_c *ref5;													\

   277

    __VA_ARGS__														\

   278

  public:														\

   279

    class_name_c(symbol_c *ref1,											\

   280

		 symbol_c *ref2,											\

   281

		 symbol_c *ref3,											\

   282

		 symbol_c *ref4,											\

   283

		 symbol_c *ref5,											\

   284

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

   285

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

   286

    virtual void *accept(visitor_c &visitor);										\

   287

};

   288

   289

   290

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

   291

class class_name_c: public symbol_c {											\

   292

  public:														\

   293

    symbol_c *ref1;													\

   294

    symbol_c *ref2;													\

   295

    symbol_c *ref3;													\

   296

    symbol_c *ref4;													\

   297

    symbol_c *ref5;													\

   298

    symbol_c *ref6;													\

   299

    __VA_ARGS__														\

   300

  public:														\

   301

    class_name_c(symbol_c *ref1,											\

   302

		 symbol_c *ref2,											\

   303

		 symbol_c *ref3,											\

   304

		 symbol_c *ref4,											\

   305

		 symbol_c *ref5,											\

   306

		 symbol_c *ref6 = NULL,											\

   307

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

   308

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

   309

    virtual void *accept(visitor_c &visitor);										\

   310

};

   311

   312

   313

#include "absyntax.def"

   314

   315

   316

   317

#undef SYM_LIST

   318

#undef SYM_TOKEN

   319

#undef SYM_REF0

   320

#undef SYM_REF1

   321

#undef SYM_REF2

   322

#undef SYM_REF3

   323

#undef SYM_REF4

   324

#undef SYM_REF5

   325

#undef SYM_REF6

   326

   327

#endif /*  _ABSYNTAX_HH */