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(" -n : allow use of nested comments                   (an IEC 61131-3 v3 feature)\n");

   120

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

   121

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

   122

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

   123

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

   124

  printf(" -i : allow POUs with no in out and inout parameters (a non-standard extension!)\n");

   125

  printf(" -b : allow functions returning VOID                 (a non-standard extension!)\n");

   126

  printf(" -e : disable generation of implicit EN and ENO parameters.\n");

   127

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

   128

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

   129

  runtime_options.allow_missing_var_in    = false; /* disable: allow definition and invocation of POUs with no input, output and in_out parameters! */

   130

  stage4_print_options();

   131

  printf("\n");

   132

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

   133

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

   134

         "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);

   135

}

   136

   137

   138

/* declare the global options variable */

   139

runtime_options_t runtime_options;

   140

   141

   142

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

   143

  symbol_c *tree_root, *ordered_tree_root;

   144

  char * builddir = NULL;

   145

  int optres, errflg = 0;

   146

  int path_len;

   147

   148

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

   149

  runtime_options.allow_void_datatype     = false; /* disable: allow declaration of functions returning VOID  */

   150

  runtime_options.allow_missing_var_in    = false; /* disable: allow definition and invocation of POUs with no input, output and in_out parameters! */

   151

  runtime_options.disable_implicit_en_eno = false; /* disable: do not generate EN and ENO parameters */

   152

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

   153

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

   154

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

   155

  runtime_options.conversion_functions    = false; /* disable: create a conversion function for derived datatype */

   156

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

   157

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

   158

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

   159

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

   160

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

   161

   162

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

   163

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

   164

   165

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

   166

  /*   Parse command line options...        */

   167

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

   168

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

   169

    switch(optres) {

   170

    case 'h':

   171

      printusage(argv[0]);

   172

      return 0;

   173

    case 'v':

   174

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

   175

      return 0;

   176

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

   177

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

   178

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

   179

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

   180

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

   181

              runtime_options.ref_nonstand_extensions  = true;  break;

   182

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

   183

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

   184

    case 'b': runtime_options.allow_void_datatype      = true;  break;

   185

    case 'i': runtime_options.allow_missing_var_in     = true;  break;

   186

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

   187

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

   188

    case 'e': runtime_options.disable_implicit_en_eno  = true;  break;

   189

    case 'I':

   190

      /* NOTE: To improve the usability under windows:

   191

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

   192

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

   193

       *       slash terminator.

   194

       */

   195

      path_len = strlen(optarg) - 1;

   196

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

   197

      runtime_options.includedir = optarg;

   198

      break;

   199

    case 'T':

   200

      /* NOTE: see note above */

   201

      path_len = strlen(optarg) - 1;

   202

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

   203

      builddir = optarg;

   204

      break;

   205

    case 'O':

   206

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

   207

      break;

   208

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

   209

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

   210

      errflg++;

   211

      break;

   212

    case '?':

   213

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

   214

      errflg++;

   215

      break;

   216

    default:

   217

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

   218

      errflg++;

   219

      break;

   220

    }

   221

  }

   222

   223

  if (optind == argc) {

   224

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

   225

    errflg++;

   226

  }

   227

   228

  if (optind > argc) {

   229

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

   230

    errflg++;

   231

  }

   232

   233

  if (errflg) {

   234

    printusage(argv[0]);

   235

    return EXIT_FAILURE;

   236

  }

   237

   238

   239

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

   240

  /*   Run the compiler...   */

   241

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

   242

  /* 1st Pass */

   243

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

   244

    return EXIT_FAILURE;

   245

   246

  /* 2nd Pass */

   247

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

   248

  absyntax_utils_init(tree_root);  

   249

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

   250

  //add_en_eno_param_decl_c::add_to(tree_root);

   251

   252

  /* Do semantic verification of code */

   253

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

   254

    return EXIT_FAILURE;

   255

   256

  /* 3rd Pass */

   257

  if (stage4(ordered_tree_root, builddir) < 0)

   258

    return EXIT_FAILURE;

   259

   260

  /* 4th Pass */

   261

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

   262

  /* Currently implemented in the Makefile! */

   263

   264

  return 0;

   265

}

   266

   267