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

 ****************************************************************

    35

 ****************************************************************

    36

 *********                                              *********

    37

 *********                                              *********

    38

 *********   O V E R A L L    A R C H I T E C T U R E   *********

    39

 *********                                              *********

    40

 *********                                              *********

    41

 ****************************************************************

    42

 ****************************************************************

    43

 ****************************************************************

    44

    45

 The compiler works in 4(+1) stages:

    46

 Stage 1   - Lexical analyser      - implemented with flex (iec.flex)

    47

 Stage 2   - Syntax parser         - implemented with bison (iec.y)

    48

 Stage 3   - Semantics analyser    - not yet implemented

    49

 Stage 4   - Code generator        - implemented in C++

    50

 Stage 4+1 - Binary code generator - gcc, javac, etc...

    51

    52

    53

 Data structures passed between stages, in global variables:

    54

 1->2   : tokens (int), and token values (char *)

    55

 2->1   : symbol tables (defined in symtable.hh)

    56

 2->3   : abstract syntax tree (tree of C++ classes, in absyntax.hh file)

    57

 3->4   : Same as 2->3

    58

 4->4+1 : file with program in c, java, etc...

    59

    60

    61

 The compiler works in several passes:

    62

 Pass 1: executes stages 1 and 2 simultaneously

    63

 Pass 2: executes stage 3

    64

 Pass 3: executes stage 4

    65

 Pass 4: executes stage 4+1

    66

*/

    67

    68

    69

    70

//#include <stdio.h>   // printf()

    71

#include <getopt.h>

    72

#include <string.h>

    73

#include <stdlib.h>  // EXIT_FAILURE

    74

#include "absyntax/absyntax.hh"  // symbol_c type

    75

    76

/* A macro for printing out internal parser errors... */

    77

#include <iostream> // required for std::cerr

    78

    79

#ifndef HGVERSION

    80

#define HGVERSION ""

    81

#endif

    82

    83

#include "main.hh"  // symbol_c type

    84

#include <stdarg.h> // required for va_start(), va_list

    85

    86

void error_exit(const char *file_name, int line_no, const char *errmsg, ...) {

    87

  va_list argptr;

    88

  va_start(argptr, errmsg); /* second argument is last fixed pamater of error_exit() */

    89

    90

  fprintf(stderr, "\nInternal compiler error in file %s at line %d", file_name, line_no);

    91

  if (errmsg != NULL) {

    92

    fprintf(stderr, ": ");

    93

    vfprintf(stderr, errmsg, argptr);

    94

  } else {

    95

    fprintf(stderr, ".");

    96

  }

    97

  fprintf(stderr, "\n");

    98

  va_end(argptr);

    99

   100

  exit(EXIT_FAILURE);

   101

}

   102

   103

   104

   105

#include "config/config.h"

   106

#include "stage1_2/stage1_2.hh"

   107

#include "absyntax_utils/absyntax_utils.hh"

   108

   109

int stage3(symbol_c *tree_root);

   110

int stage4(symbol_c *tree_root, const char *builddir);

   111

   112

   113

static void printusage(const char *cmd) {

   114

  printf("syntax: %s [-h] [-v] [-f] [-s] [-I <include_directory>] [-T <target_directory>] <input_file>\n", cmd);

   115

  printf("  h : show this help message\n");

   116

  printf("  v : print version number\n");  

   117

  printf("  f : display full token location on error messages\n");

   118

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

   119

      /* whether we are suporting safe extensions           */

   120

      /* as defined in PLCopen - Technical Committee 5      */

   121

      /* Safety Software Technical Specification,           */

   122

      /* Part 1: Concepts and Function Blocks,              */

   123

      /* Version 1.0 – Official Release                     */

   124

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

   125

  printf("  s : allow use of safe extensions\n");

   126

  printf("\n");

   127

  printf("%s - Copyright (C) 2003-2011 \n"

   128

         "This program comes with ABSOLUTELY NO WARRANTY!\n"

   129

         "This is free software licensed under GPL v3, and you are welcome to redistribute it under the conditions specified by this license.\n", PACKAGE_NAME);

   130

}

   131

   132

   133

   134

int main(int argc, char **argv) {

   135

  symbol_c *tree_root;

   136

  char * builddir = NULL;

   137

  stage1_2_options_t stage1_2_options = {false, false, NULL};

   138

  int optres, errflg = 0;

   139

  int path_len;

   140

/*

   141

  extern char *optarg;

   142

  extern int optind, optopt;

   143

*/

   144

   145

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

   146

  /*   Parse command line options...        */

   147

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

   148

  while ((optres = getopt(argc, argv, ":hvfsI:T:")) != -1) {

   149

    switch(optres) {

   150

    case 'h':

   151

      printusage(argv[0]);

   152

      return 0;

   153

    case 'v':

   154

      fprintf(stdout, "%s version %s\n"

   155

		      "changeset id: %s\n", PACKAGE_NAME, PACKAGE_VERSION, HGVERSION);      

   156

      return 0;        

   157

    case 'f':

   158

      stage1_2_options.full_token_loc = true;

   159

      break;

   160

    case 's':

   161

      stage1_2_options.safe_extensions = true;

   162

      break;

   163

    case 'I':

   164

      /* NOTE: To improve the usability under windows:

   165

       *       We delete last char's path if it ends with "\".

   166

       *       In this way compiler front-end accepts paths with or without

   167

       *       slash terminator.

   168

       */

   169

      path_len = strlen(optarg) - 1;

   170

      if (optarg[path_len] == '\\') optarg[path_len]= '\0';

   171

      stage1_2_options.includedir = optarg;

   172

      break;

   173

    case 'T':

   174

      /* NOTE: see note above */

   175

      path_len = strlen(optarg) - 1;

   176

      if (optarg[path_len] == '\\') optarg[path_len]= '\0';

   177

      builddir = optarg;

   178

      break;

   179

    case ':':       /* -I or -T without operand */

   180

      fprintf(stderr, "Option -%c requires an operand\n", optopt);

   181

      errflg++;

   182

      break;

   183

    case '?':

   184

      fprintf(stderr, "Unrecognized option: -%c\n", optopt);

   185

      errflg++;

   186

      break;

   187

    default:

   188

      fprintf(stderr, "Unknown error while parsing command line options.");

   189

      errflg++;

   190

      break;

   191

    }

   192

  }

   193

   194

  if (optind == argc) {

   195

    fprintf(stderr, "Missing input file\n");

   196

    errflg++;

   197

  }

   198

   199

  if (optind > argc) {

   200

    fprintf(stderr, "Too many input files\n");

   201

    errflg++;

   202

  }

   203

   204

  if (errflg) {

   205

      printf("\n");

   206

      printusage(argv[0]);

   207

      return EXIT_FAILURE;

   208

  }

   209

   210

   211

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

   212

  /*   Run the compiler...   */

   213

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

   214

  /* 1st Pass */

   215

  if (stage1_2(argv[optind], &tree_root, stage1_2_options) < 0)

   216

    return EXIT_FAILURE;

   217

   218

  /* 2nd Pass */

   219

    /* basically loads some symbol tables to speed up look ups later on */

   220

  absyntax_utils_init(tree_root);  

   221

    /* moved to bison, although it could perfectly well still be here instead of in bison code. */

   222

  //add_en_eno_param_decl_c::add_to(tree_root);

   223

   224

  /* Do semantic verification of code (data type and lvalue checking currently implemented) */

   225

  if (stage3(tree_root) < 0)

   226

    return EXIT_FAILURE;

   227

   228

   229

  /* 3rd Pass */

   230

  if (stage4(tree_root, builddir) < 0)

   231

    return EXIT_FAILURE;

   232

   233

  /* 4th Pass */

   234

  /* Call gcc, g++, or whatever... */

   235

  /* Currently implemented in the Makefile! */

   236

   237

  return 0;

   238

}

   239

   240