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

    int last_line;

    74

    int last_column;

    75

    76

  public:

    77

    /* default constructor */

    78

    symbol_c(void);

    79

    symbol_c(int fl     /* first_line   */, 

    80

             int fc     /* first_column */,

    81

             int ll = 0 /* last_line    */,

    82

             int lc = 0 /* last_column  */

    83

            );

    84

    85

    /* default destructor */

    86

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

    87

    virtual ~symbol_c(void) {return;};

    88

    89

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

    90

};

    91

    92

    93

class token_c: public symbol_c {

    94

  public:

    95

    /* the value of the symbol. */

    96

    const char *value;

    97

    98

  public:

    99

    token_c(const char *value, int fl = 0, int fc = 0, int ll = 0, int lc = 0);

   100

};

   101

   102

   103

 /* a list of symbols... */

   104

class list_c: public symbol_c {

   105

  public:

   106

    int n;

   107

    symbol_c **elements;

   108

   109

  public:

   110

    list_c(int fl = 0, int fc = 0, int ll = 0, int lc = 0);

   111

    list_c(symbol_c *elem, int fl = 0, int fc = 0, int ll = 0, int lc = 0);

   112

     /* insert a new element */

   113

    virtual void add_element(symbol_c *elem);

   114

};

   115

   116

   117

   118

   119

#define SYM_LIST(class_name_c)								\

   120

class class_name_c:	public list_c {							\

   121

  public:										\

   122

    class_name_c(int fl = 0, int fc = 0, int ll = 0, int lc = 0);			\

   123

    class_name_c(symbol_c *elem, int fl = 0, int fc = 0, int ll = 0, int lc = 0);	\

   124

    virtual void *accept(visitor_c &visitor);						\

   125

};

   126

   127

   128

#define SYM_TOKEN(class_name_c)								\

   129

class class_name_c: 	public token_c {						\

   130

  public:										\

   131

    class_name_c(const char *value, int fl = 0, int fc = 0, int ll = 0, int lc = 0);	\

   132

    virtual void *accept(visitor_c &visitor);						\

   133

};

   134

   135

   136

#define SYM_REF0(class_name_c)			\

   137

class class_name_c: public symbol_c {		\

   138

  public:					\

   139

    class_name_c(int fl = 0, int fc = 0, 	\

   140

		 int ll = 0, int lc = 0);	\

   141

    virtual void *accept(visitor_c &visitor);	\

   142

};

   143

   144

   145

#define SYM_REF1(class_name_c, ref1)			\

   146

class class_name_c: public symbol_c {			\

   147

  public:						\

   148

    symbol_c *ref1;					\

   149

  public:						\

   150

    class_name_c(symbol_c *ref1,			\

   151

		 int fl = 0, int fc = 0, 		\

   152

		 int ll = 0, int lc = 0);		\

   153

    virtual void *accept(visitor_c &visitor);		\

   154

};

   155

   156

   157

#define SYM_REF2(class_name_c, ref1, ref2)		\

   158

class class_name_c: public symbol_c {			\

   159

  public:						\

   160

    symbol_c *ref1;					\

   161

    symbol_c *ref2;					\

   162

  public:						\

   163

    class_name_c(symbol_c *ref1,			\

   164

		 symbol_c *ref2 = NULL,			\

   165

		 int fl = 0, int fc = 0, 		\

   166

		 int ll = 0, int lc = 0);		\

   167

    virtual void *accept(visitor_c &visitor);		\

   168

};

   169

   170

   171

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

   172

class class_name_c: public symbol_c {			\

   173

  public:						\

   174

    symbol_c *ref1;					\

   175

    symbol_c *ref2;					\

   176

    symbol_c *ref3;					\

   177

  public:						\

   178

    class_name_c(symbol_c *ref1,			\

   179

		 symbol_c *ref2,			\

   180

		 symbol_c *ref3,			\

   181

		 int fl = 0, int fc = 0, 		\

   182

		 int ll = 0, int lc = 0);		\

   183

    virtual void *accept(visitor_c &visitor);		\

   184

};

   185

   186

   187

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

   188

class class_name_c: public symbol_c {			\

   189

  public:						\

   190

    symbol_c *ref1;					\

   191

    symbol_c *ref2;					\

   192

    symbol_c *ref3;					\

   193

    symbol_c *ref4;					\

   194

  public:						\

   195

    class_name_c(symbol_c *ref1,			\

   196

		 symbol_c *ref2,			\

   197

		 symbol_c *ref3,			\

   198

		 symbol_c *ref4 = NULL,			\

   199

		 int fl = 0, int fc = 0, 		\

   200

		 int ll = 0, int lc = 0);		\

   201

    virtual void *accept(visitor_c &visitor);		\

   202

};

   203

   204

   205

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

   206

class class_name_c: public symbol_c {					\

   207

  public:								\

   208

    symbol_c *ref1;							\

   209

    symbol_c *ref2;							\

   210

    symbol_c *ref3;							\

   211

    symbol_c *ref4;							\

   212

    symbol_c *ref5;							\

   213

  public:								\

   214

    class_name_c(symbol_c *ref1,					\

   215

		 symbol_c *ref2,					\

   216

		 symbol_c *ref3,					\

   217

		 symbol_c *ref4,					\

   218

		 symbol_c *ref5,					\

   219

		 int fl = 0, int fc = 0, 				\

   220

		 int ll = 0, int lc = 0);				\

   221

    virtual void *accept(visitor_c &visitor);				\

   222

};

   223

   224

   225

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

   226

class class_name_c: public symbol_c {					\

   227

  public:								\

   228

    symbol_c *ref1;							\

   229

    symbol_c *ref2;							\

   230

    symbol_c *ref3;							\

   231

    symbol_c *ref4;							\

   232

    symbol_c *ref5;							\

   233

    symbol_c *ref6;							\

   234

  public:								\

   235

    class_name_c(symbol_c *ref1,					\

   236

		 symbol_c *ref2,					\

   237

		 symbol_c *ref3,					\

   238

		 symbol_c *ref4,					\

   239

		 symbol_c *ref5,					\

   240

		 symbol_c *ref6 = NULL,					\

   241

		 int fl = 0, int fc = 0, 				\

   242

		 int ll = 0, int lc = 0);				\

   243

    virtual void *accept(visitor_c &visitor);				\

   244

};

   245

   246

   247

#include "absyntax.def"

   248

   249

   250

   251

#undef SYM_LIST

   252

#undef SYM_TOKEN

   253

#undef SYM_REF0

   254

#undef SYM_REF1

   255

#undef SYM_REF2

   256

#undef SYM_REF3

   257

#undef SYM_REF4

   258

#undef SYM_REF5

   259

#undef SYM_REF6

   260

   261

   262

   263

#endif /*  _ABSYNTAX_HH */