1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *  Copyright (C) 2012  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

 * Some classes to help with debuging.

    34

 *

    35

 * These classes will print out the current state of a symbol or a portion of the Abstract Syntax Tree.

    36

 */

    37

    38

/* TODO: Use a class similar to stage4out_c so that we can have nice indentation when printing an AST

    39

 *       Create a template so that we can TRACE the execution of other visitor classes doing usefull work!

    40

 */

    41

    42

    43

    44

#include <unistd.h>

    45

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

    46

#include "absyntax_utils.hh"

    47

#include "../absyntax/visitor.hh"

    48

    49

    50

    51

    52

    53

    54

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

    55

/* Class to print a symbol       */

    56

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

    57

    58

    59

class print_symbol_c: public fcall_visitor_c { 

    60

  public:

    61

    static void print(symbol_c *symbol);

    62

    63

  protected:

    64

    void fcall(symbol_c *symbol);  

    65

    /* AST symbols with extra data have their own specialised methods for printing that data */

    66

    void *visit(il_instruction_c *symbol);

    67

    68

  private:

    69

    static print_symbol_c *singleton;

    70

    71

    void dump_symbol(symbol_c* symbol);

    72

};

    73

    74

    75

    76

    77

print_symbol_c *print_symbol_c::singleton = NULL;

    78

    79

    80

void print_symbol_c::print(symbol_c* symbol) {

    81

  if (NULL == singleton)   singleton = new print_symbol_c();

    82

  if (NULL == singleton)   ERROR;

    83

    84

  symbol->accept(*singleton);

    85

}

    86

    87

    88

    89

    90

    91

void print_symbol_c::fcall(symbol_c* symbol) {

    92

  dump_symbol(symbol);

    93

  fprintf(stderr, "\n");

    94

}

    95

    96

    97

void print_symbol_c::dump_symbol(symbol_c* symbol) {

    98

  fprintf(stderr, "(%03d:%03d..%03d:%03d) \t%s\t", symbol->first_line, symbol->first_column, symbol->last_line, symbol->last_column, symbol->absyntax_cname());

    99

   100

  fprintf(stderr, "  datatype=");

   101

  if (NULL == symbol->datatype)

   102

    fprintf(stderr, "NULL\t\t");

   103

  else {

   104

	  fprintf(stderr, "%s", symbol->datatype->absyntax_cname());

   105

  }

   106

  fprintf(stderr, "\t<-{");

   107

  if (symbol->candidate_datatypes.size() == 0) {

   108

    fprintf(stderr, "\t\t\t\t\t");

   109

  } else if (symbol->candidate_datatypes.size() <= 2) {

   110

    for (unsigned int i = 0; i < 2; i++)

   111

      if (i < symbol->candidate_datatypes.size())

   112

        fprintf(stderr, " %s,", symbol->candidate_datatypes[i]->absyntax_cname());

   113

      else

   114

        fprintf(stderr, "\t\t\t");

   115

  } else {

   116

    fprintf(stderr, "(%lu)\t\t\t\t\t", (unsigned long int)symbol->candidate_datatypes.size());

   117

  }

   118

  fprintf(stderr, "}\t");         

   119

   120

  /* print the const values... */

   121

  fprintf(stderr, " constv{f=%f, i=%"PRId64", u=%"PRIu64", b=%d}\t", symbol->const_value._real64.value, symbol->const_value._int64.value, symbol->const_value._uint64.value, symbol->const_value._bool.value?1:0);

   122

   123

}

   124

   125

   126

   127

void *print_symbol_c::visit(il_instruction_c *symbol) {

   128

   dump_symbol(symbol);

   129

   130

   /* NOTE: std::map.size() returns a size_type, whose type is dependent on compiler/platform. To be portable, we need to do an explicit type cast. */

   131

  fprintf(stderr, "  next_il_=%lu ", (unsigned long int)symbol->next_il_instruction.size());

   132

  fprintf(stderr, "  prev_il_=%lu ", (unsigned long int)symbol->prev_il_instruction.size());

   133

   134

  if (symbol->prev_il_instruction.size() == 0)

   135

    fprintf(stderr, "(----,");

   136

  else if (symbol->prev_il_instruction[0]->datatype == NULL)

   137

    fprintf(stderr, "(NULL,");

   138

  else if (!get_datatype_info_c::is_type_valid(symbol->prev_il_instruction[0]->datatype))

   139

    fprintf(stderr, "(****,");

   140

  else

   141

    fprintf(stderr, "(    ,");

   142

   143

  if (symbol->next_il_instruction.size() == 0)

   144

    fprintf(stderr, "----)");

   145

  else if (symbol->next_il_instruction[0]->datatype == NULL)

   146

    fprintf(stderr, "NULL)");

   147

  else if (!get_datatype_info_c::is_type_valid(symbol->next_il_instruction[0]->datatype))

   148

    fprintf(stderr, "****)");

   149

  else 

   150

    fprintf(stderr, "    )");

   151

   152

  fprintf(stderr, "\n");

   153

   154

  return NULL;

   155

};

   156

   157

   158

   159

   160

   161

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

   162

/* Class to print an AST         */

   163

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

   164

   165

class print_ast_c: public fcall_iterator_visitor_c { 

   166

  public:

   167

    static void print(symbol_c *symbol);

   168

    static void print(const char *str);

   169

   170

  protected:

   171

    void prefix_fcall(symbol_c *symbol);

   172

    void suffix_fcall(symbol_c *symbol);  

   173

   174

  private:

   175

    static print_ast_c *singleton;    

   176

};

   177

   178

   179

   180

   181

print_ast_c *print_ast_c::singleton = NULL;

   182

   183

   184

void print_ast_c::print(symbol_c* symbol) {

   185

  if (NULL == singleton)   singleton = new print_ast_c();

   186

  if (NULL == singleton)   ERROR;

   187

   188

  symbol->accept(*singleton);

   189

}

   190

   191

   192

void print_ast_c::print(const char *str) {

   193

  fprintf(stderr, "%s", str);

   194

}

   195

   196

   197

void print_ast_c::prefix_fcall(symbol_c* symbol) {print_symbol_c::print(symbol);}

   198

void print_ast_c::suffix_fcall(symbol_c* symbol) {}

   199

   200

   201

   202

   203

   204

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

   205

/* The DEBUG class               */

   206

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

   207

   208

   209

   210

   211

void debug_c::print(const char *str) {

   212

  fprintf(stderr, "%s", str);

   213

}

   214

   215

void debug_c::print(symbol_c *symbol) {

   216

  print_symbol_c::print(symbol);

   217

}

   218

   219

void debug_c::print_ast(symbol_c *symbol) {

   220

  print_ast_c::print(symbol);

   221

}

   222

   223

   224

   225

   226