1

/*

     2

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

     3

 *

     4

 *  Copyright (C) 2003-2012  Mario de Sousa (msousa@fe.up.pt)

     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

/* Determine the characteristics of a specific data type

    33

 *  e.g., is it an enumeration, is it an array, is it ANY_INT, etc...

    34

 *

    35

 * The methods of this class may be passed either:

    36

 *  - a data type declaration symbol_c, 

    37

 *   OR

    38

 *  - the name of a data type (identifier_c)

    39

 *    In this case, we shall first serach for the basetype declaration using search_base_type_c, and then 

    40

 *    run the normal process.

    41

 */

    42

#include "absyntax_utils.hh"

    43

    44

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

    45

    46

    47

    48

    49

    50

    51

class get_datatype_info_c { 

    52

    53

    54

  private: // this is a purely static class. No need for constructors!

    55

     get_datatype_info_c(void) {};

    56

    ~get_datatype_info_c(void) {};

    57

    58

    // A helper method to get_datatype_info_c::is_type_equal()

    59

    // Assuming the relaxed datatype model, return whether the two array datatypes are equal/equivalent

    60

    static bool is_arraytype_equal_relaxed(symbol_c *first_type, symbol_c *second_type);

    61

    62

  public:

    63

    static symbol_c   *get_id    (symbol_c *datatype); /* get the identifier (name) of the datatype); returns NULL if anonymous datatype! Does not work for elementary datatypes!*/

    64

    static const char *get_id_str(symbol_c *datatype); /* get the identifier (name) of the datatype); returns NULL if anonymous datatype! */

    65

    66

    static symbol_c *get_struct_field_type_id      (symbol_c *struct_datatype, symbol_c *struct_fieldname); // returns datatype of a field in a structure

    67

    static symbol_c *get_array_storedtype_id       (symbol_c *type_symbol);    // returns the datatype of the variables stored in the array

    68

    static symbol_c *get_ref_to                    (symbol_c *type_symbol);    // Defined in IEC 61131-3 v3 (returns the type that is being referenced/pointed to)        

    69

    70

    /* Returns true if both datatypes are equivalent (not necessarily equal!).

    71

     * Two datatype models are supported: relaxed and strict (chosen from a command line option).

    72

     * WARNING: May return true even though the datatypes are not the same/identical!!!

    73

     *          In both of the models, this may occur when at least one of the datatypes is of a generic

    74

     *          datatype (Generic dataypes: ANY, ANY_INT, ANY_NUM, ...), 

    75

     *          or when two REF_TO datatypes both reference an equivalent datatype.

    76

     *          In only the relaxed datatype, it may also return true if two array datatypes

    77

     *          have the same subrange limits, and contain the same data. 

    78

     *          

    79

     * NOTE: Currently only the ANY generic datatype is implemented!

    80

     * NOTE: Currently stage1_2 only allows the use of the ANY keyword when in conjuntion with

    81

     *       the REF_TO keyword (i.e. REF_TO ANY).

    82

     */

    83

    static bool is_type_equal(symbol_c *first_type, symbol_c *second_type);

    84

    static bool is_type_valid(symbol_c *type);

    85

    86

    static bool is_ref_to                          (symbol_c *type_symbol);    // Defined in IEC 61131-3 v3

    87

    static bool is_sfc_initstep                    (symbol_c *type_symbol);

    88

    static bool is_sfc_step                        (symbol_c *type_symbol);

    89

    static bool is_function_block                  (symbol_c *type_symbol);

    90

    static bool is_subrange                        (symbol_c *type_symbol);

    91

    static bool is_enumerated                      (symbol_c *type_symbol);

    92

    static bool is_array                           (symbol_c *type_symbol);

    93

    static bool is_structure                       (symbol_c *type_symbol);

    94

    95

    static bool is_ANY_REAL_literal(symbol_c *type_symbol); /* Can't we do away with this?? */

    96

    static bool is_ANY_INT_literal (symbol_c *type_symbol); /* Can't we do away with this?? */

    97

    98

    static bool is_ANY_generic_type                (symbol_c *type_symbol);

    99

   100

    //static bool is_ANY_ELEMENTARY_generic_type   (symbol_c *type_symbol);

   101

    static bool is_ANY_ELEMENTARY                  (symbol_c *type_symbol);

   102

    static bool is_ANY_SAFEELEMENTARY              (symbol_c *type_symbol);

   103

    static bool is_ANY_ELEMENTARY_compatible       (symbol_c *type_symbol);

   104

   105

    //static bool is_ANY_MAGNITUDE_generic_type    (symbol_c *type_symbol);

   106

    static bool is_ANY_MAGNITUDE                   (symbol_c *type_symbol);

   107

    static bool is_ANY_SAFEMAGNITUDE               (symbol_c *type_symbol);

   108

    static bool is_ANY_MAGNITUDE_compatible        (symbol_c *type_symbol);

   109

   110

    static bool is_ANY_signed_MAGNITUDE            (symbol_c *type_symbol);

   111

    static bool is_ANY_signed_SAFEMAGNITUDE        (symbol_c *type_symbol);

   112

    static bool is_ANY_signed_MAGNITUDE_compatible (symbol_c *type_symbol);

   113

   114

    //static bool is_ANY_NUM_generic_type          (symbol_c *type_symbol);

   115

    static bool is_ANY_NUM                         (symbol_c *type_symbol);

   116

    static bool is_ANY_SAFENUM                     (symbol_c *type_symbol);

   117

    static bool is_ANY_NUM_compatible              (symbol_c *type_symbol);

   118

   119

    static bool is_ANY_signed_NUM                  (symbol_c *type_symbol);

   120

    static bool is_ANY_signed_SAFENUM              (symbol_c *type_symbol);

   121

    static bool is_ANY_signed_NUM_compatible       (symbol_c *type_symbol);

   122

   123

    //static bool is_ANY_INT_generic_type          (symbol_c *type_symbol);

   124

    static bool is_ANY_INT                         (symbol_c *type_symbol);

   125

    static bool is_ANY_SAFEINT                     (symbol_c *type_symbol);

   126

    static bool is_ANY_INT_compatible              (symbol_c *type_symbol);

   127

   128

    static bool is_ANY_signed_INT                  (symbol_c *type_symbol);

   129

    static bool is_ANY_signed_SAFEINT              (symbol_c *type_symbol);

   130

    static bool is_ANY_signed_INT_compatible       (symbol_c *type_symbol);

   131

   132

    static bool is_ANY_unsigned_INT                (symbol_c *type_symbol);

   133

    static bool is_ANY_unsigned_SAFEINT            (symbol_c *type_symbol);

   134

    static bool is_ANY_unsigned_INT_compatible     (symbol_c *type_symbol);

   135

   136

    //static bool is_ANY_REAL_generic_type         (symbol_c *type_symbol);

   137

    static bool is_ANY_REAL                        (symbol_c *type_symbol);

   138

    static bool is_ANY_SAFEREAL                    (symbol_c *type_symbol);

   139

    static bool is_ANY_REAL_compatible             (symbol_c *type_symbol);

   140

   141

    static bool is_ANY_nBIT                        (symbol_c *type_symbol);

   142

    static bool is_ANY_SAFEnBIT                    (symbol_c *type_symbol);

   143

    static bool is_ANY_nBIT_compatible             (symbol_c *type_symbol);

   144

   145

    static bool is_BOOL                            (symbol_c *type_symbol);

   146

    static bool is_SAFEBOOL                        (symbol_c *type_symbol);

   147

    static bool is_BOOL_compatible                 (symbol_c *type_symbol);

   148

   149

    //static bool is_ANY_BIT_generic_type          (symbol_c *type_symbol);

   150

    static bool is_ANY_BIT                         (symbol_c *type_symbol);

   151

    static bool is_ANY_SAFEBIT                     (symbol_c *type_symbol);

   152

    static bool is_ANY_BIT_compatible              (symbol_c *type_symbol);

   153

   154

    //static bool is_ANY_DATE_generic_type         (symbol_c *type_symbol);

   155

    static bool is_ANY_DATE                        (symbol_c *type_symbol);

   156

    static bool is_ANY_SAFEDATE                    (symbol_c *type_symbol);

   157

    static bool is_ANY_DATE_compatible             (symbol_c *type_symbol);

   158

   159

    static bool is_TIME                            (symbol_c *type_symbol);

   160

    static bool is_SAFETIME                        (symbol_c *type_symbol);

   161

    static bool is_TIME_compatible                 (symbol_c *type_symbol);

   162

   163

    //static bool is_ANY_STRING_generic_type       (symbol_c *type_symbol);

   164

    static bool is_ANY_STRING                      (symbol_c *type_symbol);

   165

    static bool is_ANY_SAFESTRING                  (symbol_c *type_symbol);

   166

    static bool is_ANY_STRING_compatible           (symbol_c *type_symbol);

   167

   168

    // A non-standard extension --> data type 'VOID' (used for functions that do not return any data)

   169

    static bool is_VOID                            (symbol_c *type_symbol);

   170

   171

   172

   173

  public:

   174

    /* object used to identify an entry in the abstract syntax tree with an invalid data type */

   175

    /* This is only used from stage3 onwards. Stages 1 and 2 will never create any instances of invalid_type_name_c */

   176

    static invalid_type_name_c     invalid_type_name;

   177

   178

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

   179

    /* B.1.3 - Data types */

   180

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

   181

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

   182

    /* B 1.3.1 - Elementary Data Types */

   183

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

   184

    static lreal_type_name_c        lreal_type_name;

   185

    static real_type_name_c         real_type_name;

   186

   187

    static lint_type_name_c         lint_type_name;

   188

    static dint_type_name_c         dint_type_name;

   189

    static int_type_name_c          int_type_name;

   190

    static sint_type_name_c         sint_type_name;

   191

   192

    static ulint_type_name_c        ulint_type_name;

   193

    static udint_type_name_c        udint_type_name;

   194

    static uint_type_name_c         uint_type_name;

   195

    static usint_type_name_c        usint_type_name;

   196

   197

    static lword_type_name_c        lword_type_name;

   198

    static dword_type_name_c        dword_type_name;

   199

    static word_type_name_c         word_type_name;

   200

    static byte_type_name_c         byte_type_name;

   201

    static bool_type_name_c         bool_type_name;

   202

   203

    static wstring_type_name_c      wstring_type_name;

   204

    static string_type_name_c       string_type_name;

   205

   206

    static dt_type_name_c           dt_type_name;

   207

    static date_type_name_c         date_type_name;

   208

    static tod_type_name_c          tod_type_name;

   209

    static time_type_name_c         time_type_name;

   210

   211

   212

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

   213

    /* Extensions to the base standard as defined in      */

   214

    /* "Safety Software Technical Specification,          */

   215

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

   216

    /*  Version 1.0 – Official Release"                   */

   217

    /* by PLCopen - Technical Committee 5 - 2006-01-31    */

   218

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

   219

    static safelreal_type_name_c    safelreal_type_name;

   220

    static safereal_type_name_c     safereal_type_name;

   221

   222

    static safelint_type_name_c     safelint_type_name;

   223

    static safedint_type_name_c     safedint_type_name;

   224

    static safeint_type_name_c      safeint_type_name;

   225

    static safesint_type_name_c     safesint_type_name;

   226

   227

    static safeulint_type_name_c    safeulint_type_name;

   228

    static safeudint_type_name_c    safeudint_type_name;

   229

    static safeuint_type_name_c     safeuint_type_name;

   230

    static safeusint_type_name_c    safeusint_type_name;

   231

   232

    static safelword_type_name_c    safelword_type_name;

   233

    static safedword_type_name_c    safedword_type_name;

   234

    static safeword_type_name_c     safeword_type_name;

   235

    static safebyte_type_name_c     safebyte_type_name;

   236

    static safebool_type_name_c     safebool_type_name;

   237

   238

    static safewstring_type_name_c  safewstring_type_name;

   239

    static safestring_type_name_c   safestring_type_name;

   240

   241

    static safedt_type_name_c       safedt_type_name;

   242

    static safedate_type_name_c     safedate_type_name;

   243

    static safetod_type_name_c      safetod_type_name;

   244

    static safetime_type_name_c     safetime_type_name;               

   245

};

   246