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

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

   123

    virtual void add_element(symbol_c *elem);

   124

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

   125

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

   126

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

   127

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

   128

};

   129

   130

   131

   132

   133

#define SYM_LIST(class_name_c, ...)												\

   134

class class_name_c:	public list_c {											\

   135

  public:														\

   136

    __VA_ARGS__														\

   137

  public:														\

   138

    class_name_c(													\

   139

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

   140

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

   141

    class_name_c(symbol_c *elem, 											\

   142

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

   143

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

   144

    virtual void *accept(visitor_c &visitor);										\

   145

};

   146

   147

   148

#define SYM_TOKEN(class_name_c, ...)												\

   149

class class_name_c: 	public token_c {										\

   150

  public:														\

   151

    __VA_ARGS__														\

   152

  public:														\

   153

    class_name_c(const char *value, 											\

   154

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

   155

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

   156

    virtual void *accept(visitor_c &visitor);										\

   157

};

   158

   159

   160

#define SYM_REF0(class_name_c, ...)												\

   161

class class_name_c: public symbol_c {											\

   162

  public:														\

   163

    __VA_ARGS__														\

   164

  public:														\

   165

    class_name_c(		 											\

   166

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

   167

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

   168

    virtual void *accept(visitor_c &visitor);										\

   169

};

   170

   171

   172

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

   173

class class_name_c: public symbol_c {											\

   174

  public:														\

   175

    symbol_c *ref1;													\

   176

    __VA_ARGS__														\

   177

  public:														\

   178

    class_name_c(symbol_c *ref1,											\

   179

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

   180

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

   181

    virtual void *accept(visitor_c &visitor);										\

   182

};

   183

   184

   185

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

   186

class class_name_c: public symbol_c {											\

   187

  public:														\

   188

    symbol_c *ref1;													\

   189

    symbol_c *ref2;													\

   190

    __VA_ARGS__														\

   191

  public:														\

   192

    class_name_c(symbol_c *ref1,											\

   193

		 symbol_c *ref2 = NULL,											\

   194

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

   195

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

   196

    virtual void *accept(visitor_c &visitor);										\

   197

};

   198

   199

   200

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

   201

class class_name_c: public symbol_c {											\

   202

  public:														\

   203

    symbol_c *ref1;													\

   204

    symbol_c *ref2;													\

   205

    symbol_c *ref3;													\

   206

    __VA_ARGS__														\

   207

  public:														\

   208

    class_name_c(symbol_c *ref1,											\

   209

		 symbol_c *ref2,											\

   210

		 symbol_c *ref3,											\

   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_REF4(class_name_c, ref1, ref2, ref3, ref4, ...)								\

   218

class class_name_c: public symbol_c {											\

   219

  public:														\

   220

    symbol_c *ref1;													\

   221

    symbol_c *ref2;													\

   222

    symbol_c *ref3;													\

   223

    symbol_c *ref4;													\

   224

    __VA_ARGS__														\

   225

  public:														\

   226

    class_name_c(symbol_c *ref1,											\

   227

		 symbol_c *ref2,											\

   228

		 symbol_c *ref3,											\

   229

		 symbol_c *ref4 = NULL,											\

   230

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

   231

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

   232

    virtual void *accept(visitor_c &visitor);										\

   233

};

   234

   235

   236

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

   237

class class_name_c: public symbol_c {											\

   238

  public:														\

   239

    symbol_c *ref1;													\

   240

    symbol_c *ref2;													\

   241

    symbol_c *ref3;													\

   242

    symbol_c *ref4;													\

   243

    symbol_c *ref5;													\

   244

    __VA_ARGS__														\

   245

  public:														\

   246

    class_name_c(symbol_c *ref1,											\

   247

		 symbol_c *ref2,											\

   248

		 symbol_c *ref3,											\

   249

		 symbol_c *ref4,											\

   250

		 symbol_c *ref5,											\

   251

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

   252

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

   253

    virtual void *accept(visitor_c &visitor);										\

   254

};

   255

   256

   257

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

   258

class class_name_c: public symbol_c {											\

   259

  public:														\

   260

    symbol_c *ref1;													\

   261

    symbol_c *ref2;													\

   262

    symbol_c *ref3;													\

   263

    symbol_c *ref4;													\

   264

    symbol_c *ref5;													\

   265

    symbol_c *ref6;													\

   266

    __VA_ARGS__														\

   267

  public:														\

   268

    class_name_c(symbol_c *ref1,											\

   269

		 symbol_c *ref2,											\

   270

		 symbol_c *ref3,											\

   271

		 symbol_c *ref4,											\

   272

		 symbol_c *ref5,											\

   273

		 symbol_c *ref6 = NULL,											\

   274

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

   275

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

   276

    virtual void *accept(visitor_c &visitor);										\

   277

};

   278

   279

   280

#include "absyntax.def"

   281

   282

   283

   284

#undef SYM_LIST

   285

#undef SYM_TOKEN

   286

#undef SYM_REF0

   287

#undef SYM_REF1

   288

#undef SYM_REF2

   289

#undef SYM_REF3

   290

#undef SYM_REF4

   291

#undef SYM_REF5

   292

#undef SYM_REF6

   293

   294

   295

   296

#endif /*  _ABSYNTAX_HH */