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

/*

    33

 * VISITOR.HH

    34

 *

    35

 *

    36

 * The asbract syntax tree is scaned several times

    37

 * during the whole compilation process. For e.g., stage 3 verifies

    38

 * semantics, and stage 4 produces output.

    39

 *

    40

 * Since the number of functions that need to scan through

    41

 * the abtract syntax tree may increase in time, (e.g. new

    42

 * output formats, new semantic checks, etc...) while the

    43

 * abstract syntax tree class structure is pretty stable

    44

 * (i.e. the ST and IL languages will not be changing much...),

    45

 * we use the 'visitor' design patern.

    46

 *

    47

 * It is not strictly necessary to use this pattern, but it does

    48

 * have the advantage of bringing together the functions

    49

 * that implement the same algorithm, each on a different

    50

 * class of object in the abstract syntax tree.

    51

 *

    52

 *

    53

 * This file contains the interface that each visitor class

    54

 * must implement in order to be able to visit the abstract

    55

 * syntax tree (class visitor_c)

    56

 *

    57

 * Three implementations of this interface are also provided,

    58

 * that may be later extended to execute a particular algorithm.

    59

 *

    60

 * The null (class null_visitor_c) does nothing.

    61

 *

    62

 * The iterator (class iterator_visitor_c) iterates through

    63

 * every object in the syntax tree.

    64

 *

    65

 * The search class (class search_visitor_c) iterates through

    66

 * every object, until one returns a value != NULL.

    67

 */

    68

    69

    70

#ifndef _VISITOR_HH

    71

#define _VISITOR_HH

    72

    73

    74

    75

    76

#include "absyntax.hh"

    77

    78

    79

    80

#define SYM_LIST(class_name_c)	\

    81

  virtual void *visit(class_name_c *symbol) = 0;

    82

    83

#define SYM_TOKEN(class_name_c)	\

    84

  virtual void *visit(class_name_c *symbol) = 0;

    85

    86

#define SYM_REF0(class_name_c)	\

    87

  virtual void *visit(class_name_c *symbol) = 0;

    88

    89

#define SYM_REF1(class_name_c, ref1)		\

    90

  virtual void *visit(class_name_c *symbol) = 0;

    91

    92

#define SYM_REF2(class_name_c, ref1, ref2)	\

    93

  virtual void *visit(class_name_c *symbol) = 0;

    94

    95

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

    96

  virtual void *visit(class_name_c *symbol) = 0;

    97

    98

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

    99

  virtual void *visit(class_name_c *symbol) = 0;

   100

   101

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

   102

  virtual void *visit(class_name_c *symbol) = 0;

   103

   104

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

   105

  virtual void *visit(class_name_c *symbol) = 0;

   106

   107

class visitor_c {

   108

  public:

   109

  #include "absyntax.def"

   110

   111

  virtual ~visitor_c(void);

   112

};

   113

   114

#undef SYM_LIST

   115

#undef SYM_TOKEN

   116

#undef SYM_REF0

   117

#undef SYM_REF1

   118

#undef SYM_REF2

   119

#undef SYM_REF3

   120

#undef SYM_REF4

   121

#undef SYM_REF5

   122

#undef SYM_REF6

   123

   124

   125

   126

   127

   128

   129

#define SYM_LIST(class_name_c)	\

   130

  virtual void *visit(class_name_c *symbol);

   131

   132

#define SYM_TOKEN(class_name_c)	\

   133

  virtual void *visit(class_name_c *symbol);

   134

   135

#define SYM_REF0(class_name_c)	\

   136

  virtual void *visit(class_name_c *symbol);

   137

   138

#define SYM_REF1(class_name_c, ref1)		\

   139

  virtual void *visit(class_name_c *symbol);

   140

   141

#define SYM_REF2(class_name_c, ref1, ref2)	\

   142

  virtual void *visit(class_name_c *symbol);

   143

   144

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

   145

  virtual void *visit(class_name_c *symbol);

   146

   147

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

   148

  virtual void *visit(class_name_c *symbol);

   149

   150

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

   151

  virtual void *visit(class_name_c *symbol);

   152

   153

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

   154

  virtual void *visit(class_name_c *symbol);

   155

   156

   157

   158

   159

   160

class null_visitor_c: public visitor_c {

   161

  public:

   162

  #include "absyntax.def"

   163

   164

  virtual ~null_visitor_c(void);

   165

};

   166

   167

   168

   169

class iterator_visitor_c: public visitor_c {

   170

  protected:

   171

  void *visit_list(list_c *list);

   172

   173

  public:

   174

  #include "absyntax.def"

   175

   176

  virtual ~iterator_visitor_c(void);

   177

};

   178

   179

   180

class search_visitor_c: public visitor_c {

   181

  protected:

   182

  void *visit_list(list_c *list);

   183

   184

  public:

   185

  #include "absyntax.def"

   186

   187

  virtual ~search_visitor_c(void);

   188

};

   189

   190

   191

#undef SYM_LIST

   192

#undef SYM_TOKEN

   193

#undef SYM_REF0

   194

#undef SYM_REF1

   195

#undef SYM_REF2

   196

#undef SYM_REF3

   197

#undef SYM_REF4

   198

#undef SYM_REF5

   199

#undef SYM_REF6

   200

   201

#endif /*  _VISITOR_HH */