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

#ifndef _MAIN_HH

    35

#define _MAIN_HH

    36

    37

    38

    39

/* Compiler options, specified at runtime on the command line */

    40

    41

typedef struct {

    42

   /* options specific to stage1_2 */

    43

	bool allow_void_datatype;      /* Allow declaration of functions returning VOID  */

    44

	bool allow_missing_var_in;     /* Allow definition and invocation of POUs with no input, output and in_out parameters! */

    45

	bool disable_implicit_en_eno;  /* Disable the generation of implicit EN and ENO parameters on functions and Function Blocks */

    46

	bool pre_parsing;              /* Support forward references (Run a pre-parsing phase before the defintive parsing phase that builds the AST) */

    47

	bool safe_extensions;          /* support SAFE_* datatypes defined in PLCOpen TC5 "Safety Software Technical Specification - Part 1" v1.0 */

    48

	bool full_token_loc;           /* error messages specify full token location */

    49

	bool conversion_functions;     /* Create a conversion function for derived datatype */

    50

	bool nested_comments;          /* Allow the use of nested comments. */

    51

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

    52

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

    53

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

    54

	const char *includedir;        /* Include directory, where included files will be searched for... */

    55

    56

   /* options specific to stage3 */

    57

	bool relaxed_datatype_model;   /* Use the relaxed datatype equivalence model, instead of the default strict equivalence model */

    58

} runtime_options_t;

    59

    60

extern runtime_options_t runtime_options;

    61

    62

    63

    64

    65

    66

    67

 /* Function used throughout the code --> used to report failed assertions (i.e. internal compiler errors)! */

    68

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

    69

    70

#define ERROR               error_exit(__FILE__,__LINE__)

    71

#define ERROR_MSG(msg, ...) error_exit(__FILE__,__LINE__, msg, ## __VA_ARGS__)

    72

    73

extern void error_exit(const char *file_name, int line_no, const char *errmsg = NULL, ...);

    74

    75

    76

    77

    78

 /* Get the definition of INT16_MAX, INT16_MIN, UINT64_MAX, INT64_MAX, INT64_MIN, ... */

    79

#ifndef __STDC_LIMIT_MACROS

    80

#define __STDC_LIMIT_MACROS /* required to have UINTxx_MAX defined when including stdint.h from C++ source code. */

    81

#endif

    82

#include <stdint.h>         

    83

#include <limits>

    84

    85

#ifndef   UINT64_MAX 

    86

  #define UINT64_MAX (std::numeric_limits< uint64_t >::max())

    87

#endif

    88

#ifndef    INT64_MAX 

    89

  #define  INT64_MAX (std::numeric_limits<  int64_t >::max())

    90

#endif

    91

#ifndef    INT64_MIN

    92

  #define  INT64_MIN (std::numeric_limits<  int64_t >::min()) 

    93

#endif

    94

    95

    96

    97

/* Determine, for the current platform, which datas types (float, double or long double) use 64 and 32 bits. */

    98

/* NOTE: We cant use sizeof() in pre-processor directives, so we have to do it another way... */

    99

/* CURIOSITY: We can use sizeof() and offsetof() inside static_assert() but:

   100

 *          - this only allows us to make assertions, and not #define new macros

   101

 *          - is only available in the C standard [ISO/IEC 9899:2011] and the C++ 0X draft standard [Becker 2008]. It is not available in C99.

   102

 *          https://www.securecoding.cert.org/confluence/display/seccode/DCL03-C.+Use+a+static+assertion+to+test+the+value+of+a+constant+expression

   103

 *         struct {int a, b, c, d} header_t;

   104

 *  e.g.:  static_assert(offsetof(struct header_t, c) == 8, "Compile time error message.");

   105

 */

   106

   107

#include <float.h>

   108

#if    (LDBL_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

   109

  #define real64_tX long_double /* so we can later use #if (real64_t == long_double) directives in the code! */

   110

  #define real64_t  long double /* NOTE: no underscore '_' between 'long' and 'double' */

   111

  #define REAL64_MAX  LDBL_MAX

   112

#elif  ( DBL_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

   113

  #define real64_tX double

   114

  #define real64_t  double

   115

  #define REAL64_MAX  DBL_MAX

   116

#elif  ( FLT_MANT_DIG == 53) /* NOTE: 64 bit IEC559 real has 53 bits for mantissa! */

   117

  #define real64_tX float

   118

  #define real64_t  float

   119

  #define REAL64_MAX  FLT_MAX

   120

#else 

   121

  #error Could not find a 64 bit floating point data type on this platform. Aborting...

   122

#endif

   123

   124

   125

#if    (LDBL_MANT_DIG == 24) /* NOTE: 32 bit IEC559 real has 24 bits for mantissa! */

   126

  #define real32_tX long_double /* so we can later use #if (real32_t == long_double) directives in the code! */

   127

  #define real32_t  long double /* NOTE: no underscore '_' between 'long' and 'double' */

   128

  #define REAL32_MAX  LDBL_MAX

   129

#elif  ( DBL_MANT_DIG == 24) /* NOTE: 32 bit IEC559 real has 24 bits for mantissa! */

   130

  #define real32_tX double

   131

  #define real32_t  double

   132

  #define REAL32_MAX  DBL_MAX

   133

#elif  ( FLT_MANT_DIG == 24) /* NOTE: 32 bit IEC559 real has 24 bits for mantissa! */

   134

  #define real32_tX float

   135

  #define real32_t  float

   136

  #define REAL32_MAX  FLT_MAX

   137

#else 

   138

  #error Could not find a 32 bit floating point data type on this platform. Aborting...

   139

#endif

   140

   141

   142

   143

#include <math.h>

   144

#ifndef INFINITY

   145

  #error Could not find the macro that defines the value for INFINITY in the current platform.

   146

#endif

   147

#ifndef NAN

   148

  #error Could not find the macro that defines the value for NAN in the current platform.

   149

#endif

   150

   151

   152

   153

/* get the printf format macros for printing variables of fixed data size

   154

 * e.g.  int64_t v; printf("value=%"PRId64" !!\n", v);

   155

 * e.g. uint64_t v; printf("value=%"PRIu64" !!\n", v);

   156

 * e.g. uint64_t v; printf("value=%"PRIx64" !!\n", v);  // hexadecimal format

   157

 */

   158

#ifndef __STDC_FORMAT_MACROS

   159

#define __STDC_FORMAT_MACROS

   160

#endif

   161

#include <inttypes.h>

   162

   163

   164

#endif // #ifndef _MAIN_HH