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>

    71

#include <getopt.h>

    72

#include <string.h>

    73

#include <stdlib.h>

    74

#include <stdarg.h>

    75

#include <iostream>

    76

    77

    78

#include "config/config.h"

    79

#include "absyntax/absyntax.hh"

    80

#include "absyntax_utils/absyntax_utils.hh"

    81

#include "stage1_2/stage1_2.hh"

    82

#include "stage3/stage3.hh"

    83

#include "stage4/stage4.hh"

    84

#include "main.hh"

    85

    86

    87

#ifndef HGVERSION

    88

   #define HGVERSION ""

    89

#endif

    90

    91

    92

    93

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

    94

  va_list argptr;

    95

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

    96

    97

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

    98

  if (errmsg != NULL) {

    99

    fprintf(stderr, ": ");

   100

    vfprintf(stderr, errmsg, argptr);

   101

  } else {

   102

    fprintf(stderr, ".");

   103

  }

   104

  fprintf(stderr, "\n");

   105

  va_end(argptr);

   106

   107

  exit(EXIT_FAILURE);

   108

}

   109

   110

   111

static void printusage(const char *cmd) {

   112

  printf("\nsyntax: %s [<options>] [-O <output_options>] [-I <include_directory>] [-T <target_directory>] <input_file>\n", cmd);

   113

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

   114

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

   115

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

   116

  printf(" -p : allow use of forward references                (a non-standard extension?)\n");  

   117

  printf(" -l : use a relaxed datatype equivalence model       (a non-standard extension?)\n");  

   118

  printf(" -s : allow use of safe datatypes (SAFEBOOL, etc.)   (defined in PLCOpen Safety)\n"); // PLCopen TC5 "Safety Software Technical Specification - Part 1" v1.0

   119

  printf(" -r : allow use of references (REF_TO, REF, ^, NULL) (an IEC 61131-3 v3 feature)\n");

   120

  printf(" -R : allow use of REF_TO ANY datatypes              (a non-standard extension!)\n");

   121

  printf("        as well as REF_TO in ARRAYs and STRUCTs      (a non-standard extension!)\n");

   122

  printf(" -a : allow use of non-literals in array size limits (a non-standard extension!)\n");

   123

  printf(" -c : create conversion functions for enumerated data types\n");

   124

  printf(" -O : options for output (code generation) stage. Available options for %s are...\n", cmd);

   125

  stage4_print_options();

   126

  printf("\n");

   127

  printf("%s - Copyright (C) 2003-2014 \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

/* declare the global options variable */

   134

runtime_options_t runtime_options;

   135

   136

   137

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

   138

  symbol_c *tree_root, *ordered_tree_root;

   139

  char * builddir = NULL;

   140

  int optres, errflg = 0;

   141

  int path_len;

   142

   143

  /* Default values for the command line options... */

   144

  runtime_options.pre_parsing             = false; /* allow use of forward references (run pre-parsing phase before the definitive parsing phase that builds the AST) */

   145

  runtime_options.safe_extensions         = false; /* allow use of SAFExxx datatypes */

   146

  runtime_options.full_token_loc          = false; /* error messages specify full token location */

   147

  runtime_options.conversion_functions    = false; /* Create a conversion function for derived datatype */

   148

  runtime_options.nested_comments         = false; /* Allow the use of nested comments. */

   149

  runtime_options.ref_standard_extensions = false; /* Allow the use of REFerences (keywords REF_TO, REF, DREF, ^, NULL). */

   150

  runtime_options.ref_nonstand_extensions = false; /* Allow the use of non-standard extensions to REF_TO datatypes: REF_TO ANY, and REF_TO in struct elements! */

   151

  runtime_options.nonliteral_in_array_size= false; /* Allow the use of constant non-literals when specifying size of arrays (ARRAY [1..max] OF INT) */

   152

  runtime_options.includedir              = NULL;  /* Include directory, where included files will be searched for... */

   153

   154

  /* Default values for the command line options... */

   155

  runtime_options.relaxed_datatype_model    = false; /* by default use the strict datatype equivalence model */

   156

   157

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

   158

  /*   Parse command line options...        */

   159

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

   160

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

   161

    switch(optres) {

   162

    case 'h':

   163

      printusage(argv[0]);

   164

      return 0;

   165

    case 'v':

   166

      fprintf(stdout, "%s version %s\n" "changeset id: %s\n", PACKAGE_NAME, PACKAGE_VERSION, HGVERSION);      

   167

      return 0;

   168

    case 'l': runtime_options.relaxed_datatype_model   = true;  break;

   169

    case 'p': runtime_options.pre_parsing              = true;  break;

   170

    case 'f': runtime_options.full_token_loc           = true;  break;

   171

    case 's': runtime_options.safe_extensions          = true;  break;

   172

    case 'R': runtime_options.ref_standard_extensions  = true; /* use of REF_TO ANY implies activating support for REF extensions! */

   173

              runtime_options.ref_nonstand_extensions  = true;  break;

   174

    case 'r': runtime_options.ref_standard_extensions  = true;  break;

   175

    case 'a': runtime_options.nonliteral_in_array_size = true;  break;

   176

    case 'c': runtime_options.conversion_functions     = true;  break;

   177

    case 'n': runtime_options.nested_comments          = true;  break;

   178

    case 'I':

   179

      /* NOTE: To improve the usability under windows:

   180

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

   181

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

   182

       *       slash terminator.

   183

       */

   184

      path_len = strlen(optarg) - 1;

   185

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

   186

      runtime_options.includedir = optarg;

   187

      break;

   188

    case 'T':

   189

      /* NOTE: see note above */

   190

      path_len = strlen(optarg) - 1;

   191

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

   192

      builddir = optarg;

   193

      break;

   194

    case 'O':

   195

      if (stage4_parse_options(optarg) < 0) errflg++;

   196

      break;

   197

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

   198

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

   199

      errflg++;

   200

      break;

   201

    case '?':

   202

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

   203

      errflg++;

   204

      break;

   205

    default:

   206

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

   207

      errflg++;

   208

      break;

   209

    }

   210

  }

   211

   212

  if (optind == argc) {

   213

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

   214

    errflg++;

   215

  }

   216

   217

  if (optind > argc) {

   218

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

   219

    errflg++;

   220

  }

   221

   222

  if (errflg) {

   223

    printusage(argv[0]);

   224

    return EXIT_FAILURE;

   225

  }

   226

   227

   228

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

   229

  /*   Run the compiler...   */

   230

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

   231

  /* 1st Pass */

   232

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

   233

    return EXIT_FAILURE;

   234

   235

  /* 2nd Pass */

   236

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

   237

  absyntax_utils_init(tree_root);  

   238

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

   239

  //add_en_eno_param_decl_c::add_to(tree_root);

   240

   241

  /* Do semantic verification of code */

   242

  if (stage3(tree_root, &ordered_tree_root) < 0)

   243

    return EXIT_FAILURE;

   244

   245

  /* 3rd Pass */

   246

  if (stage4(ordered_tree_root, builddir) < 0)

   247

    return EXIT_FAILURE;

   248

   249

  /* 4th Pass */

   250

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

   251

  /* Currently implemented in the Makefile! */

   252

   253

  return 0;

   254

}

   255

   256