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

 *

     5

 *  This program is free software: you can redistribute it and/or modify

     6

 *  it under the terms of the GNU General Public License as published by

     7

 *  the Free Software Foundation, either version 3 of the License, or

     8

 *  (at your option) any later version.

     9

 *

    10

 *  This program is distributed in the hope that it will be useful,

    11

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    12

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    13

 *  GNU General Public License for more details.

    14

 *

    15

 *  You should have received a copy of the GNU General Public License

    16

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    17

 *

    18

 *

    19

 * This code is made available on the understanding that it will not be

    20

 * used in safety-critical situations without a full and competent review.

    21

 */

    22

    23

/*

    24

 * An IEC 61131-3 compiler.

    25

 *

    26

 * Based on the

    27

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    28

 *

    29

 */

    30

    31

/*

    32

 * Declaration of the Abstract Syntax data structure components

    33

 */

    34

    35

/*

    36

 * ABSYNTAX.H

    37

 *

    38

 * This generates the parse tree structure used to bind the components

    39

 * identified by Bison in the correct syntax order. At the end of the

    40

 * Bison analysis the tree is walked in a sequential fashion generating

    41

 * the relavent code.

    42

 */

    43

    44

#ifndef _ABSYNTAX_HH

    45

#define _ABSYNTAX_HH

    46

    47

    48

#include <stdio.h> // required for NULL

    49

    50

/* Forward declaration of the visitor interface

    51

 * dclared in the visitor.hh file

    52

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

    53

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

    54

 * to the abstract syntax classes defined here.

    55

 */

    56

class visitor_c; // forward declaration

    57

    58

    59

class symbol_c; // forward declaration

    60

    61

    62

    63

/* The base class of all symbols */

    64

class symbol_c {

    65

    66

  public:

    67

    /*

    68

     * Line number for the purposes of error checking

    69

     */

    70

    int first_line;

    71

    int first_column;

    72

    int last_line;

    73

    int last_column;

    74

    75

  public:

    76

    /* default constructor */

    77

    symbol_c(void);

    78

    symbol_c(int fl     /* first_line   */, 

    79

             int fc     /* first_column */,

    80

             int ll = 0 /* last_line    */,

    81

             int lc = 0 /* last_column  */

    82

            );

    83

    84

    /* default destructor */

    85

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

    86

    virtual ~symbol_c(void) {return;};

    87

    88

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

    89

};

    90

    91

    92

class token_c: public symbol_c {

    93

  public:

    94

    /* the value of the symbol. */

    95

    const char *value;

    96

    97

  public:

    98

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

    99

};

   100

   101

   102

 /* a list of symbols... */

   103

class list_c: public symbol_c {

   104

  public:

   105

    int n;

   106

    symbol_c **elements;

   107

   108

  public:

   109

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

   110

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

   111

     /* insert a new element */

   112

    virtual void add_element(symbol_c *elem);

   113

};

   114

   115

   116

   117

   118

#define SYM_LIST(class_name_c)								\

   119

class class_name_c:	public list_c {							\

   120

  public:										\

   121

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

   122

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

   123

    virtual void *accept(visitor_c &visitor);						\

   124

};

   125

   126

   127

#define SYM_TOKEN(class_name_c)								\

   128

class class_name_c: 	public token_c {						\

   129

  public:										\

   130

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

   131

    virtual void *accept(visitor_c &visitor);						\

   132

};

   133

   134

   135

#define SYM_REF0(class_name_c)			\

   136

class class_name_c: public symbol_c {		\

   137

  public:					\

   138

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

   139

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

   140

    virtual void *accept(visitor_c &visitor);	\

   141

};

   142

   143

   144

#define SYM_REF1(class_name_c, ref1)			\

   145

class class_name_c: public symbol_c {			\

   146

  public:						\

   147

    symbol_c *ref1;					\

   148

  public:						\

   149

    class_name_c(symbol_c *ref1,			\

   150

		 int fl = 0, int fc = 0, 		\

   151

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

   152

    virtual void *accept(visitor_c &visitor);		\

   153

};

   154

   155

   156

#define SYM_REF2(class_name_c, ref1, ref2)		\

   157

class class_name_c: public symbol_c {			\

   158

  public:						\

   159

    symbol_c *ref1;					\

   160

    symbol_c *ref2;					\

   161

  public:						\

   162

    class_name_c(symbol_c *ref1,			\

   163

		 symbol_c *ref2 = NULL,			\

   164

		 int fl = 0, int fc = 0, 		\

   165

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

   166

    virtual void *accept(visitor_c &visitor);		\

   167

};

   168

   169

   170

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

   171

class class_name_c: public symbol_c {			\

   172

  public:						\

   173

    symbol_c *ref1;					\

   174

    symbol_c *ref2;					\

   175

    symbol_c *ref3;					\

   176

  public:						\

   177

    class_name_c(symbol_c *ref1,			\

   178

		 symbol_c *ref2,			\

   179

		 symbol_c *ref3,			\

   180

		 int fl = 0, int fc = 0, 		\

   181

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

   182

    virtual void *accept(visitor_c &visitor);		\

   183

};

   184

   185

   186

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

   187

class class_name_c: public symbol_c {			\

   188

  public:						\

   189

    symbol_c *ref1;					\

   190

    symbol_c *ref2;					\

   191

    symbol_c *ref3;					\

   192

    symbol_c *ref4;					\

   193

  public:						\

   194

    class_name_c(symbol_c *ref1,			\

   195

		 symbol_c *ref2,			\

   196

		 symbol_c *ref3,			\

   197

		 symbol_c *ref4 = NULL,			\

   198

		 int fl = 0, int fc = 0, 		\

   199

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

   200

    virtual void *accept(visitor_c &visitor);		\

   201

};

   202

   203

   204

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

   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

    symbol_c *ref5;							\

   212

  public:								\

   213

    class_name_c(symbol_c *ref1,					\

   214

		 symbol_c *ref2,					\

   215

		 symbol_c *ref3,					\

   216

		 symbol_c *ref4,					\

   217

		 symbol_c *ref5,					\

   218

		 int fl = 0, int fc = 0, 				\

   219

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

   220

    virtual void *accept(visitor_c &visitor);				\

   221

};

   222

   223

   224

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

   225

class class_name_c: public symbol_c {					\

   226

  public:								\

   227

    symbol_c *ref1;							\

   228

    symbol_c *ref2;							\

   229

    symbol_c *ref3;							\

   230

    symbol_c *ref4;							\

   231

    symbol_c *ref5;							\

   232

    symbol_c *ref6;							\

   233

  public:								\

   234

    class_name_c(symbol_c *ref1,					\

   235

		 symbol_c *ref2,					\

   236

		 symbol_c *ref3,					\

   237

		 symbol_c *ref4,					\

   238

		 symbol_c *ref5,					\

   239

		 symbol_c *ref6 = NULL,					\

   240

		 int fl = 0, int fc = 0, 				\

   241

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

   242

    virtual void *accept(visitor_c &visitor);				\

   243

};

   244

   245

   246

#include "absyntax.def"

   247

   248

   249

   250

#undef SYM_LIST

   251

#undef SYM_TOKEN

   252

#undef SYM_REF0

   253

#undef SYM_REF1

   254

#undef SYM_REF2

   255

#undef SYM_REF3

   256

#undef SYM_REF4

   257

#undef SYM_REF5

   258

#undef SYM_REF6

   259

   260

   261

   262

#endif /*  _ABSYNTAX_HH */