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

    51

/* Forward declaration of the visitor interface

    52

 * dclared in the visitor.hh file

    53

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

    54

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

    55

 * to the abstract syntax classes defined here.

    56

 */

    57

class visitor_c; // forward declaration

    58

    59

    60

class symbol_c; // forward declaration

    61

    62

    63

    64

/* The base class of all symbols */

    65

class symbol_c {

    66

    67

  public:

    68

    /*

    69

     * Line number for the purposes of error checking

    70

     */

    71

    int first_line;

    72

    int first_column;

    73

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

    74

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

    75

    int last_line;

    76

    int last_column;

    77

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

    78

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

    79

    80

  public:

    81

    /* default constructor */

    82

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

    83

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

    84

            );

    85

    86

    /* default destructor */

    87

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

    88

    virtual ~symbol_c(void) {return;};

    89

    90

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

    91

};

    92

    93

    94

class token_c: public symbol_c {

    95

  public:

    96

    /* the value of the symbol. */

    97

    const char *value;

    98

    99

  public:

   100

    token_c(const char *value, 

   101

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

   102

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

   103

           );

   104

};

   105

   106

   107

 /* a list of symbols... */

   108

class list_c: public symbol_c {

   109

  public:

   110

    int n;

   111

    symbol_c **elements;

   112

   113

  public:

   114

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

   115

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

   116

          );

   117

   118

    list_c(symbol_c *elem, 

   119

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

   120

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

   121

          );

   122

     /* insert a new element */

   123

    virtual void add_element(symbol_c *elem);

   124

};

   125

   126

   127

   128

   129

#define SYM_LIST(class_name_c)												\

   130

class class_name_c:	public list_c {											\

   131

  public:														\

   132

    class_name_c(													\

   133

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

   134

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

   135

    class_name_c(symbol_c *elem, 											\

   136

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

   137

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

   138

    virtual void *accept(visitor_c &visitor);										\

   139

};

   140

   141

   142

#define SYM_TOKEN(class_name_c)												\

   143

class class_name_c: 	public token_c {										\

   144

  public:														\

   145

    class_name_c(const char *value, 											\

   146

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

   147

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

   148

    virtual void *accept(visitor_c &visitor);										\

   149

};

   150

   151

   152

#define SYM_REF0(class_name_c)												\

   153

class class_name_c: public symbol_c {											\

   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

    virtual void *accept(visitor_c &visitor);										\

   159

};

   160

   161

   162

#define SYM_REF1(class_name_c, ref1)											\

   163

class class_name_c: public symbol_c {											\

   164

  public:														\

   165

    symbol_c *ref1;													\

   166

  public:														\

   167

    class_name_c(symbol_c *ref1,											\

   168

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

   169

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

   170

    virtual void *accept(visitor_c &visitor);										\

   171

};

   172

   173

   174

#define SYM_REF2(class_name_c, ref1, ref2)										\

   175

class class_name_c: public symbol_c {											\

   176

  public:														\

   177

    symbol_c *ref1;													\

   178

    symbol_c *ref2;													\

   179

  public:														\

   180

    class_name_c(symbol_c *ref1,											\

   181

		 symbol_c *ref2 = NULL,											\

   182

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

   183

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

   184

    virtual void *accept(visitor_c &visitor);										\

   185

};

   186

   187

   188

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

   189

class class_name_c: public symbol_c {											\

   190

  public:														\

   191

    symbol_c *ref1;													\

   192

    symbol_c *ref2;													\

   193

    symbol_c *ref3;													\

   194

  public:														\

   195

    class_name_c(symbol_c *ref1,											\

   196

		 symbol_c *ref2,											\

   197

		 symbol_c *ref3,											\

   198

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

   199

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

   200

    virtual void *accept(visitor_c &visitor);										\

   201

};

   202

   203

   204

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

   205

class class_name_c: public symbol_c {											\

   206

  public:														\

   207

    symbol_c *ref1;													\

   208

    symbol_c *ref2;													\

   209

    symbol_c *ref3;													\

   210

    symbol_c *ref4;													\

   211

  public:														\

   212

    class_name_c(symbol_c *ref1,											\

   213

		 symbol_c *ref2,											\

   214

		 symbol_c *ref3,											\

   215

		 symbol_c *ref4 = NULL,											\

   216

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

   217

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

   218

    virtual void *accept(visitor_c &visitor);										\

   219

};

   220

   221

   222

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

   223

class class_name_c: public symbol_c {											\

   224

  public:														\

   225

    symbol_c *ref1;													\

   226

    symbol_c *ref2;													\

   227

    symbol_c *ref3;													\

   228

    symbol_c *ref4;													\

   229

    symbol_c *ref5;													\

   230

  public:														\

   231

    class_name_c(symbol_c *ref1,											\

   232

		 symbol_c *ref2,											\

   233

		 symbol_c *ref3,											\

   234

		 symbol_c *ref4,											\

   235

		 symbol_c *ref5,											\

   236

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

   237

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

   238

    virtual void *accept(visitor_c &visitor);										\

   239

};

   240

   241

   242

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

   243

class class_name_c: public symbol_c {											\

   244

  public:														\

   245

    symbol_c *ref1;													\

   246

    symbol_c *ref2;													\

   247

    symbol_c *ref3;													\

   248

    symbol_c *ref4;													\

   249

    symbol_c *ref5;													\

   250

    symbol_c *ref6;													\

   251

  public:														\

   252

    class_name_c(symbol_c *ref1,											\

   253

		 symbol_c *ref2,											\

   254

		 symbol_c *ref3,											\

   255

		 symbol_c *ref4,											\

   256

		 symbol_c *ref5,											\

   257

		 symbol_c *ref6 = NULL,											\

   258

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

   259

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

   260

    virtual void *accept(visitor_c &visitor);										\

   261

};

   262

   263

   264

#include "absyntax.def"

   265

   266

   267

   268

#undef SYM_LIST

   269

#undef SYM_TOKEN

   270

#undef SYM_REF0

   271

#undef SYM_REF1

   272

#undef SYM_REF2

   273

#undef SYM_REF3

   274

#undef SYM_REF4

   275

#undef SYM_REF5

   276

#undef SYM_REF6

   277

   278

   279

   280

#endif /*  _ABSYNTAX_HH */