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

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

    81

    /* Data type of the expression/literal/etc. Filled in stage3 by narrow_candidate_datatypes_c 

    82

     * If set to NULL, it means it has not yet been evaluated.

    83

     * If it points to an object of type invalid_type_name_c, it means it is invalid.

    84

     * Otherwise, it points to an object of the apropriate data type (e.g. int_type_name_c, bool_type_name_c, ...)

    85

     */

    86

    symbol_c *datatype;    

    87

    88

    89

  public:

    90

    /* default constructor */

    91

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

    92

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

    93

            );

    94

    95

    /* default destructor */

    96

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

    97

    virtual ~symbol_c(void) {return;};

    98

    99

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

   100

};

   101

   102

   103

class token_c: public symbol_c {

   104

  public:

   105

    /* the value of the symbol. */

   106

    const char *value;

   107

   108

  public:

   109

    token_c(const char *value, 

   110

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

   111

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

   112

           );

   113

};

   114

   115

   116

 /* a list of symbols... */

   117

class list_c: public symbol_c {

   118

  public:

   119

    int n;

   120

    symbol_c **elements;

   121

   122

  public:

   123

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

   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

   127

    list_c(symbol_c *elem, 

   128

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

   129

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

   130

          );

   131

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

   132

    virtual void add_element(symbol_c *elem);

   133

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

   134

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

   135

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

   136

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

   137

     /* remove element at position pos. */

   138

    virtual void remove_element(int pos = 0);

   139

};

   140

   141

   142

   143

   144

#define SYM_LIST(class_name_c, ...)												\

   145

class class_name_c:	public list_c {											\

   146

  public:														\

   147

    __VA_ARGS__														\

   148

  public:														\

   149

    class_name_c(													\

   150

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

   151

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

   152

    class_name_c(symbol_c *elem, 											\

   153

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

   154

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

   155

    virtual void *accept(visitor_c &visitor);										\

   156

};

   157

   158

   159

#define SYM_TOKEN(class_name_c, ...)												\

   160

class class_name_c: 	public token_c {										\

   161

  public:														\

   162

    __VA_ARGS__														\

   163

  public:														\

   164

    class_name_c(const char *value, 											\

   165

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

   166

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

   167

    virtual void *accept(visitor_c &visitor);										\

   168

};

   169

   170

   171

#define SYM_REF0(class_name_c, ...)												\

   172

class class_name_c: public symbol_c {											\

   173

  public:														\

   174

    __VA_ARGS__														\

   175

  public:														\

   176

    class_name_c(		 											\

   177

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

   178

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

   179

    virtual void *accept(visitor_c &visitor);										\

   180

};

   181

   182

   183

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

   184

class class_name_c: public symbol_c {											\

   185

  public:														\

   186

    symbol_c *ref1;													\

   187

    __VA_ARGS__														\

   188

  public:														\

   189

    class_name_c(symbol_c *ref1,											\

   190

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

   191

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

   192

    virtual void *accept(visitor_c &visitor);										\

   193

};

   194

   195

   196

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

   197

class class_name_c: public symbol_c {											\

   198

  public:														\

   199

    symbol_c *ref1;													\

   200

    symbol_c *ref2;													\

   201

    __VA_ARGS__														\

   202

  public:														\

   203

    class_name_c(symbol_c *ref1,											\

   204

		 symbol_c *ref2 = NULL,											\

   205

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

   206

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

   207

    virtual void *accept(visitor_c &visitor);										\

   208

};

   209

   210

   211

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

   212

class class_name_c: public symbol_c {											\

   213

  public:														\

   214

    symbol_c *ref1;													\

   215

    symbol_c *ref2;													\

   216

    symbol_c *ref3;													\

   217

    __VA_ARGS__														\

   218

  public:														\

   219

    class_name_c(symbol_c *ref1,											\

   220

		 symbol_c *ref2,											\

   221

		 symbol_c *ref3,											\

   222

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

   223

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

   224

    virtual void *accept(visitor_c &visitor);										\

   225

};

   226

   227

   228

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

   229

class class_name_c: public symbol_c {											\

   230

  public:														\

   231

    symbol_c *ref1;													\

   232

    symbol_c *ref2;													\

   233

    symbol_c *ref3;													\

   234

    symbol_c *ref4;													\

   235

    __VA_ARGS__														\

   236

  public:														\

   237

    class_name_c(symbol_c *ref1,											\

   238

		 symbol_c *ref2,											\

   239

		 symbol_c *ref3,											\

   240

		 symbol_c *ref4 = NULL,											\

   241

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

   242

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

   243

    virtual void *accept(visitor_c &visitor);										\

   244

};

   245

   246

   247

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

   248

class class_name_c: public symbol_c {											\

   249

  public:														\

   250

    symbol_c *ref1;													\

   251

    symbol_c *ref2;													\

   252

    symbol_c *ref3;													\

   253

    symbol_c *ref4;													\

   254

    symbol_c *ref5;													\

   255

    __VA_ARGS__														\

   256

  public:														\

   257

    class_name_c(symbol_c *ref1,											\

   258

		 symbol_c *ref2,											\

   259

		 symbol_c *ref3,											\

   260

		 symbol_c *ref4,											\

   261

		 symbol_c *ref5,											\

   262

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

   263

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

   264

    virtual void *accept(visitor_c &visitor);										\

   265

};

   266

   267

   268

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

   269

class class_name_c: public symbol_c {											\

   270

  public:														\

   271

    symbol_c *ref1;													\

   272

    symbol_c *ref2;													\

   273

    symbol_c *ref3;													\

   274

    symbol_c *ref4;													\

   275

    symbol_c *ref5;													\

   276

    symbol_c *ref6;													\

   277

    __VA_ARGS__														\

   278

  public:														\

   279

    class_name_c(symbol_c *ref1,											\

   280

		 symbol_c *ref2,											\

   281

		 symbol_c *ref3,											\

   282

		 symbol_c *ref4,											\

   283

		 symbol_c *ref5,											\

   284

		 symbol_c *ref6 = NULL,											\

   285

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

   286

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

   287

    virtual void *accept(visitor_c &visitor);										\

   288

};

   289

   290

   291

#include "absyntax.def"

   292

   293

   294

   295

#undef SYM_LIST

   296

#undef SYM_TOKEN

   297

#undef SYM_REF0

   298

#undef SYM_REF1

   299

#undef SYM_REF2

   300

#undef SYM_REF3

   301

#undef SYM_REF4

   302

#undef SYM_REF5

   303

#undef SYM_REF6

   304

   305

   306

   307

#endif /*  _ABSYNTAX_HH */