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

    52

/* Forward declaration of the visitor interface

    53

 * dclared in the visitor.hh file

    54

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

    55

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

    56

 * to the abstract syntax classes defined here.

    57

 */

    58

class visitor_c; // forward declaration

    59

    60

    61

class symbol_c; // forward declaration

    62

    63

    64

    65

/* The base class of all symbols */

    66

class symbol_c {

    67

    68

  public:

    69

    /*

    70

     * Line number for the purposes of error checking

    71

     */

    72

    int first_line;

    73

    int first_column;

    74

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

    75

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

    76

    int last_line;

    77

    int last_column;

    78

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

    79

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

    80

    symbol_c * datatype;    /* data type of the expression/literal/etc. Filled in stage3 by narrow_candidate_datatypes_c */

    81

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

    82

    83

    84

  public:

    85

    /* default constructor */

    86

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

    87

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

    88

            );

    89

    90

    /* default destructor */

    91

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

    92

    virtual ~symbol_c(void) {return;};

    93

    94

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

    95

};

    96

    97

    98

class token_c: public symbol_c {

    99

  public:

   100

    /* the value of the symbol. */

   101

    const char *value;

   102

   103

  public:

   104

    token_c(const char *value, 

   105

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

   106

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

   107

           );

   108

};

   109

   110

   111

 /* a list of symbols... */

   112

class list_c: public symbol_c {

   113

  public:

   114

    int n;

   115

    symbol_c **elements;

   116

   117

  public:

   118

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

   119

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

   120

          );

   121

   122

    list_c(symbol_c *elem, 

   123

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

   124

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

   125

          );

   126

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

   127

    virtual void add_element(symbol_c *elem);

   128

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

   129

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

   130

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

   131

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

   132

     /* remove element at position pos. */

   133

    virtual void remove_element(int pos = 0);

   134

};

   135

   136

   137

   138

   139

#define SYM_LIST(class_name_c, ...)												\

   140

class class_name_c:	public list_c {											\

   141

  public:														\

   142

    __VA_ARGS__														\

   143

  public:														\

   144

    class_name_c(													\

   145

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

   146

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

   147

    class_name_c(symbol_c *elem, 											\

   148

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

   149

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

   150

    virtual void *accept(visitor_c &visitor);										\

   151

};

   152

   153

   154

#define SYM_TOKEN(class_name_c, ...)												\

   155

class class_name_c: 	public token_c {										\

   156

  public:														\

   157

    __VA_ARGS__														\

   158

  public:														\

   159

    class_name_c(const char *value, 											\

   160

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

   161

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

   162

    virtual void *accept(visitor_c &visitor);										\

   163

};

   164

   165

   166

#define SYM_REF0(class_name_c, ...)												\

   167

class class_name_c: public symbol_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

    virtual void *accept(visitor_c &visitor);										\

   175

};

   176

   177

   178

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

   179

class class_name_c: public symbol_c {											\

   180

  public:														\

   181

    symbol_c *ref1;													\

   182

    __VA_ARGS__														\

   183

  public:														\

   184

    class_name_c(symbol_c *ref1,											\

   185

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

   186

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

   187

    virtual void *accept(visitor_c &visitor);										\

   188

};

   189

   190

   191

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

   192

class class_name_c: public symbol_c {											\

   193

  public:														\

   194

    symbol_c *ref1;													\

   195

    symbol_c *ref2;													\

   196

    __VA_ARGS__														\

   197

  public:														\

   198

    class_name_c(symbol_c *ref1,											\

   199

		 symbol_c *ref2 = NULL,											\

   200

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

   201

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

   202

    virtual void *accept(visitor_c &visitor);										\

   203

};

   204

   205

   206

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

   207

class class_name_c: public symbol_c {											\

   208

  public:														\

   209

    symbol_c *ref1;													\

   210

    symbol_c *ref2;													\

   211

    symbol_c *ref3;													\

   212

    __VA_ARGS__														\

   213

  public:														\

   214

    class_name_c(symbol_c *ref1,											\

   215

		 symbol_c *ref2,											\

   216

		 symbol_c *ref3,											\

   217

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

   218

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

   219

    virtual void *accept(visitor_c &visitor);										\

   220

};

   221

   222

   223

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

   224

class class_name_c: public symbol_c {											\

   225

  public:														\

   226

    symbol_c *ref1;													\

   227

    symbol_c *ref2;													\

   228

    symbol_c *ref3;													\

   229

    symbol_c *ref4;													\

   230

    __VA_ARGS__														\

   231

  public:														\

   232

    class_name_c(symbol_c *ref1,											\

   233

		 symbol_c *ref2,											\

   234

		 symbol_c *ref3,											\

   235

		 symbol_c *ref4 = NULL,											\

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

   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

    __VA_ARGS__														\

   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

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

   258

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

   259

    virtual void *accept(visitor_c &visitor);										\

   260

};

   261

   262

   263

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

   264

class class_name_c: public symbol_c {											\

   265

  public:														\

   266

    symbol_c *ref1;													\

   267

    symbol_c *ref2;													\

   268

    symbol_c *ref3;													\

   269

    symbol_c *ref4;													\

   270

    symbol_c *ref5;													\

   271

    symbol_c *ref6;													\

   272

    __VA_ARGS__														\

   273

  public:														\

   274

    class_name_c(symbol_c *ref1,											\

   275

		 symbol_c *ref2,											\

   276

		 symbol_c *ref3,											\

   277

		 symbol_c *ref4,											\

   278

		 symbol_c *ref5,											\

   279

		 symbol_c *ref6 = NULL,											\

   280

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

   281

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

   282

    virtual void *accept(visitor_c &visitor);										\

   283

};

   284

   285

   286

#include "absyntax.def"

   287

   288

   289

   290

#undef SYM_LIST

   291

#undef SYM_TOKEN

   292

#undef SYM_REF0

   293

#undef SYM_REF1

   294

#undef SYM_REF2

   295

#undef SYM_REF3

   296

#undef SYM_REF4

   297

#undef SYM_REF5

   298

#undef SYM_REF6

   299

   300

   301

   302

#endif /*  _ABSYNTAX_HH */