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

/*

    34

 * VISITOR.CC

    35

 *

    36

 * Three base implementations of the visitor interface,

    37

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

    38

 *

    39

 * The null (class null_visitor_c) does nothing.

    40

 *

    41

 * The iterator (class iterator_visitor_c) iterates through

    42

 * every object in the syntax tree.

    43

 *

    44

 * The search class (class search_visitor_c) iterates through

    45

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

    46

 */

    47

    48

    49

    50

    51

    52

#include <unistd.h>

    53

    54

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

    55

#include "visitor.hh"

    56

    57

#include <iostream>

    58

    59

    60

/******************/

    61

/* visitor_c      */

    62

/******************/

    63

    64

visitor_c::~visitor_c(void) {return;}

    65

    66

    67

/******************/

    68

/* null_visitor_c */

    69

/******************/

    70

    71

null_visitor_c::~null_visitor_c(void) {return;}

    72

    73

#define SYM_LIST(class_name_c, ...)	\

    74

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    75

    76

#define SYM_TOKEN(class_name_c, ...)	\

    77

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    78

    79

#define SYM_REF0(class_name_c, ...)	\

    80

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    81

    82

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

    83

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    84

    85

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

    86

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    87

    88

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

    89

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    90

    91

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

    92

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    93

    94

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

    95

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    96

    97

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

    98

  void *null_visitor_c::visit(class_name_c *symbol) {return NULL;}

    99

   100

   101

#include "absyntax.def"

   102

   103

   104

   105

   106

#undef SYM_LIST

   107

#undef SYM_TOKEN

   108

#undef SYM_REF0

   109

#undef SYM_REF1

   110

#undef SYM_REF2

   111

#undef SYM_REF3

   112

#undef SYM_REF4

   113

#undef SYM_REF5

   114

#undef SYM_REF6

   115

   116

   117

   118

   119

   120

   121

   122

/*******************/

   123

/* fcall_visitor_c */

   124

/*******************/

   125

   126

//fcall_visitor_c::~fcall_visitor_c(void) {return;};

   127

   128

   129

// void fcall_visitor_c::fcall(symbol_c *symbol) {return;};

   130

   131

#define VISIT_METHOD {fcall(symbol); return NULL;}

   132

   133

#define SYM_LIST(class_name_c, ...)                                             void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   134

#define SYM_TOKEN(class_name_c, ...)                                            void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   135

#define SYM_REF0(class_name_c, ...)                                             void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   136

#define SYM_REF1(class_name_c, ref1, ...)                                       void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   137

#define SYM_REF2(class_name_c, ref1, ref2, ...)                                 void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   138

#define SYM_REF3(class_name_c, ref1, ref2, ref3, ...)                           void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   139

#define SYM_REF4(class_name_c, ref1, ref2, ref3, ref4, ...)                     void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   140

#define SYM_REF5(class_name_c, ref1, ref2, ref3, ref4, ref5, ...)               void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   141

#define SYM_REF6(class_name_c, ref1, ref2, ref3, ref4, ref5, ref6, ...)         void *fcall_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   142

   143

#include "../absyntax/absyntax.def"

   144

   145

#undef VISIT_METHOD

   146

   147

#undef SYM_LIST

   148

#undef SYM_TOKEN

   149

#undef SYM_REF0

   150

#undef SYM_REF1

   151

#undef SYM_REF2

   152

#undef SYM_REF3

   153

#undef SYM_REF4

   154

#undef SYM_REF5

   155

#undef SYM_REF6

   156

   157

   158

   159

   160

   161

   162

/**********************/

   163

/* iterator_visitor_c */

   164

/**********************/

   165

   166

iterator_visitor_c::~iterator_visitor_c(void) {return;}

   167

   168

   169

void *iterator_visitor_c::visit_list(list_c *list) {

   170

  for(int i = 0; i < list->n; i++) {

   171

    list->get_element(i)->accept(*this);

   172

  }

   173

  return NULL;

   174

}

   175

   176

   177

#define SYM_LIST(class_name_c, ...)	\

   178

  void *iterator_visitor_c::visit(class_name_c *symbol) {return visit_list(symbol);}

   179

   180

#define SYM_TOKEN(class_name_c, ...)	\

   181

  void *iterator_visitor_c::visit(class_name_c *symbol) {return NULL;}

   182

   183

#define SYM_REF0(class_name_c, ...)	\

   184

  void *iterator_visitor_c::visit(class_name_c *symbol) {return NULL;}

   185

   186

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

   187

void *iterator_visitor_c::visit(class_name_c *symbol) {	\

   188

  if (symbol->ref1!=NULL) symbol->ref1->accept(*this);	\

   189

  return NULL;						\

   190

}

   191

   192

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

   193

void *iterator_visitor_c::visit(class_name_c *symbol) {	\

   194

  if (symbol->ref1!=NULL) symbol->ref1->accept(*this);	\

   195

  if (symbol->ref2!=NULL) symbol->ref2->accept(*this);	\

   196

  return NULL;						\

   197

}

   198

   199

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

   200

void *iterator_visitor_c::visit(class_name_c *symbol) {			\

   201

  if (symbol->ref1) symbol->ref1->accept(*this);			\

   202

  if (symbol->ref2) symbol->ref2->accept(*this);			\

   203

  if (symbol->ref3) symbol->ref3->accept(*this);			\

   204

  return NULL;								\

   205

}

   206

   207

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

   208

void *iterator_visitor_c::visit(class_name_c *symbol) {			\

   209

  if (symbol->ref1) symbol->ref1->accept(*this);			\

   210

  if (symbol->ref2) symbol->ref2->accept(*this);			\

   211

  if (symbol->ref3) symbol->ref3->accept(*this);			\

   212

  if (symbol->ref4) symbol->ref4->accept(*this);			\

   213

  return NULL;								\

   214

}

   215

   216

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

   217

void *iterator_visitor_c::visit(class_name_c *symbol) {			\

   218

  if (symbol->ref1) symbol->ref1->accept(*this);			\

   219

  if (symbol->ref2) symbol->ref2->accept(*this);			\

   220

  if (symbol->ref3) symbol->ref3->accept(*this);			\

   221

  if (symbol->ref4) symbol->ref4->accept(*this);			\

   222

  if (symbol->ref5) symbol->ref5->accept(*this);			\

   223

  return NULL;								\

   224

}

   225

   226

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

   227

void *iterator_visitor_c::visit(class_name_c *symbol) {			\

   228

  if (symbol->ref1) symbol->ref1->accept(*this);			\

   229

  if (symbol->ref2) symbol->ref2->accept(*this);			\

   230

  if (symbol->ref3) symbol->ref3->accept(*this);			\

   231

  if (symbol->ref4) symbol->ref4->accept(*this);			\

   232

  if (symbol->ref5) symbol->ref5->accept(*this);			\

   233

  if (symbol->ref6) symbol->ref6->accept(*this);			\

   234

  return NULL;								\

   235

}

   236

   237

   238

   239

#include "absyntax.def"

   240

   241

   242

   243

#undef SYM_LIST

   244

#undef SYM_TOKEN

   245

#undef SYM_REF0

   246

#undef SYM_REF1

   247

#undef SYM_REF2

   248

#undef SYM_REF3

   249

#undef SYM_REF4

   250

#undef SYM_REF5

   251

#undef SYM_REF6

   252

   253

   254

   255

   256

   257

/****************************/

   258

/* fcall_iterator_visitor_c */

   259

/****************************/

   260

   261

fcall_iterator_visitor_c::~fcall_iterator_visitor_c(void) {return;};

   262

   263

void fcall_iterator_visitor_c::prefix_fcall(symbol_c *symbol) {return;};

   264

void fcall_iterator_visitor_c::suffix_fcall(symbol_c *symbol) {return;};

   265

   266

#define VISIT_METHOD {\

   267

  prefix_fcall(symbol);                \

   268

  iterator_visitor_c::visit(symbol);   \

   269

  suffix_fcall(symbol);                \

   270

  return NULL;                         \

   271

}

   272

   273

#define SYM_LIST(class_name_c, ...)                                             void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   274

#define SYM_TOKEN(class_name_c, ...)                                            void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   275

#define SYM_REF0(class_name_c, ...)                                             void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   276

#define SYM_REF1(class_name_c, ref1, ...)                                       void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   277

#define SYM_REF2(class_name_c, ref1, ref2, ...)                                 void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   278

#define SYM_REF3(class_name_c, ref1, ref2, ref3, ...)                           void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   279

#define SYM_REF4(class_name_c, ref1, ref2, ref3, ref4, ...)                     void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   280

#define SYM_REF5(class_name_c, ref1, ref2, ref3, ref4, ref5, ...)               void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   281

#define SYM_REF6(class_name_c, ref1, ref2, ref3, ref4, ref5, ref6, ...)         void *fcall_iterator_visitor_c::visit(class_name_c *symbol) VISIT_METHOD;

   282

   283

#include "../absyntax/absyntax.def"

   284

   285

#undef VISIT_METHOD

   286

   287

#undef SYM_LIST

   288

#undef SYM_TOKEN

   289

#undef SYM_REF0

   290

#undef SYM_REF1

   291

#undef SYM_REF2

   292

#undef SYM_REF3

   293

#undef SYM_REF4

   294

#undef SYM_REF5

   295

#undef SYM_REF6

   296

   297

   298

   299

   300

   301

   302

   303

   304

/********************/

   305

/* search_visitor_c */

   306

/********************/

   307

   308

search_visitor_c::~search_visitor_c(void) {return;}

   309

   310

   311

void *search_visitor_c::visit_list(list_c *list) {

   312

  for(int i = 0; i < list->n; i++) {

   313

    void *res = list->get_element(i)->accept(*this);

   314

    if (res != NULL)

   315

      return res;

   316

  }

   317

  return NULL;

   318

}

   319

   320

   321

#define SYM_LIST(class_name_c, ...)	\

   322

  void *search_visitor_c::visit(class_name_c *symbol) {return visit_list(symbol);}

   323

   324

#define SYM_TOKEN(class_name_c, ...)	\

   325

  void *search_visitor_c::visit(class_name_c *symbol) {return NULL;}

   326

   327

#define SYM_REF0(class_name_c, ...)	\

   328

  void *search_visitor_c::visit(class_name_c *symbol) {return NULL;}

   329

   330

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

   331

void *search_visitor_c::visit(class_name_c *symbol) {		\

   332

  if (symbol->ref1) return symbol->ref1->accept(*this);		\

   333

  return NULL;							\

   334

}

   335

   336

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

   337

void *search_visitor_c::visit(class_name_c *symbol) {		\

   338

  void *res = NULL;						\

   339

  if (symbol->ref1) res =  symbol->ref1->accept(*this);		\

   340

  if (res != NULL)  return res;					\

   341

  if (symbol->ref2) return symbol->ref2->accept(*this);		\

   342

  return NULL;							\

   343

}

   344

   345

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

   346

void *search_visitor_c::visit(class_name_c *symbol) {		\

   347

  void *res = NULL;						\

   348

  if (symbol->ref1) res =  symbol->ref1->accept(*this);		\

   349

  if (res != NULL)  return res;					\

   350

  if (symbol->ref2) res =  symbol->ref2->accept(*this);		\

   351

  if (res != NULL)  return res;					\

   352

  if (symbol->ref3) return symbol->ref3->accept(*this);		\

   353

  return NULL;							\

   354

}

   355

   356

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

   357

void *search_visitor_c::visit(class_name_c *symbol) {		\

   358

  void *res = NULL;						\

   359

  if (symbol->ref1) res =  symbol->ref1->accept(*this);		\

   360

  if (res != NULL)  return res;					\

   361

  if (symbol->ref2) res =  symbol->ref2->accept(*this);		\

   362

  if (res != NULL)  return res;					\

   363

  if (symbol->ref3) res =  symbol->ref3->accept(*this);		\

   364

  if (res != NULL)  return res;					\

   365

  if (symbol->ref4) return symbol->ref4->accept(*this);		\

   366

  return NULL;							\

   367

}

   368

   369

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

   370

void *search_visitor_c::visit(class_name_c *symbol) {			\

   371

  void *res = NULL;							\

   372

  if (symbol->ref1) res =  symbol->ref1->accept(*this);			\

   373

  if (res != NULL)  return res;						\

   374

  if (symbol->ref2) res =  symbol->ref2->accept(*this);			\

   375

  if (res != NULL)  return res;						\

   376

  if (symbol->ref3) res =  symbol->ref3->accept(*this);			\

   377

  if (res != NULL)  return res;						\

   378

  if (symbol->ref4) res =  symbol->ref4->accept(*this);			\

   379

  if (res != NULL)  return res;						\

   380

  if (symbol->ref5) return symbol->ref5->accept(*this);			\

   381

  return NULL;								\

   382

}

   383

   384

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

   385

void *search_visitor_c::visit(class_name_c *symbol) {			\

   386

  void *res = NULL;							\

   387

  if (symbol->ref1) res =  symbol->ref1->accept(*this);			\

   388

  if (res != NULL)  return res;						\

   389

  if (symbol->ref2) res =  symbol->ref2->accept(*this);			\

   390

  if (res != NULL)  return res;						\

   391

  if (symbol->ref3) res =  symbol->ref3->accept(*this);			\

   392

  if (res != NULL)  return res;						\

   393

  if (symbol->ref4) res =  symbol->ref4->accept(*this);			\

   394

  if (res != NULL)  return res;						\

   395

  if (symbol->ref5) res =  symbol->ref5->accept(*this);			\

   396

  if (res != NULL)  return res;						\

   397

  if (symbol->ref6) return symbol->ref6->accept(*this);			\

   398

  return NULL;								\

   399

}

   400

   401

   402

   403

#include "absyntax.def"

   404

   405

   406

   407

#undef SYM_LIST

   408

#undef SYM_TOKEN

   409

#undef SYM_REF0

   410

#undef SYM_REF1

   411

#undef SYM_REF2

   412

#undef SYM_REF3

   413

#undef SYM_REF4

   414

#undef SYM_REF5

   415

#undef SYM_REF6

   416

   417

   418

   419

   420

   421

   422

   423

   424

   425

   426

   427